summaryrefslogtreecommitdiff
path: root/docs/howtos/grub_cbfs.html
blob: b82a12a943540d37a892ea9fb22474a011ed1a9a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
<!DOCTYPE html>
<html>
<head>
	<meta charset="utf-8">
	<meta name="viewport" content="width=device-width, initial-scale=1">

	<style type="text/css">
		body {
			background:#fff;
			color:#000;
			font-family:sans-serif;
			font-size:1em;
		}
		div.important {
			background-color:#ccc;
		}
	</style>

	<title>Libreboot documentation: GRUB menu</title>
</head>

<body>
	<header>
		<h1 id="pagetop">How to change your default GRUB menu</h1>
		<aside>Or <a href="../index.html">back to main index</a></aside>
	</header>

	<p>
		Libreboot on X60/T60/macbook21 uses the GRUB2 payload, which means that the grub.cfg (which is where your GRUB menu comes from) is inside the ROM along with
		GRUB itself, executed by libreboot directly in the SPI flash chip. In context, this means that installing distributions and managing them is handled slightly differently
		compared to traditional BIOS systems.
	</p>

	<p>
		A libreboot (or coreboot) ROM is not simply &quot;flat&quot;; there is an actual filesystem inside called CBFS (coreboot filesystem). A utility called 'cbfstool' 
		allows you to change the contents of the ROM. In this case, libreboot is configured such that the grub.cfg exists directly inside CBFS instead of 
		inside the grub.elf payload's 'memdisk' (which is itself stored in CBFS).
	</p>

	<p>
		Here is an excellent writeup about CBFS (coreboot filesystem): <a href="http://lennartb.home.xs4all.nl/coreboot/col5.html" target="_blank">http://lennartb.home.xs4all.nl/coreboot/col5.html</a>.
	</p>

<hr/>

	<p>
	Download libreboot_src.tar.gz or libreboot_bin.tar.gz from <a href="http://libreboot.org/" target="_blank">http://libreboot.org/</a>
	<br/><b>If you downloaded libreboot from git, refer to <a href="../index.html#build_meta">../index.html#build_meta</a> before continuing.</b>
	</p>

	<p>
		First, <a href="../index.html#build_dependencies">install the build dependencies</a>.
	</p>

	<p>
		If you are working with libreboot_src, then you can run <b><i>make</i></b> command in libreboot_src/coreboot/util/cbfstool to build the <b><i>cbfstool</i></b> and <b><i>rmodtool</i></b>
		executable.
	</p>
	<p>
		Alternatively if you are working with libreboot_bin, then you can run <b><i>./builddeps-cbfstool</i></b> command inside libreboot_bin/; a <b><i>cbfstool</i></b> and <b><i>rmodtool</i></b>
		executable will appear under libreboot_bin/
	</p>

	<p>
		You can work directly with one of the ROM's already included in libreboot_bin.tar.gz. For the purpose of this tutorial it is assumed
		that your ROM is named 'libreboot_usqwerty.rom' so please make sure to adapt.
	</p>

	<p>
		If you want to re-use the ROM that you currently have flashed (and running) then see <a href="../index.html#build_flashrom">../index.html#build_flashrom</a>
		and then run:<br/>
		<b>$ sudo ./flashrom -p internal -r libreboot_usqwerty.rom</b><br/>
		Notice that this is using <b>&quot;-r&quot;</b> (read) instead of <b>&quot;-w&quot;</b> (write). This will create a dump (copy) of your current firmware and name it <b>libreboot_usqwerty.rom</b>. You need to take ownership of the file. For example:<br/>
		<b>$ sudo chown yourusername:yourusername libreboot_usqwerty.rom</b><br/>
		<b># chown yourusername:yourusername libreboot_usqwerty.rom</b>
	</p>

	<p>
		If you currently have flashed a ROM image from an older version, it is recommended to update first: basically, modify one of the latest ROM's
		and then flash it.
	</p>

	<p>
		Display contents of ROM:<br/>
		<b>$ ./cbfstool libreboot_usqwerty.rom print</b>
	</p>

	<p>
		The libreboot_usqwerty.rom file contains your grub.cfg, along with a copy called grubtest.cfg. 
		You should extract, modify and re-insert the copy first. grub.cfg will load first, but it has a menu entry for switching to the copy (grubtest.cfg).
		This reduces your chance of making a mistake that could make your machine unbootable (or very hard to boot).
	</p>

	<p>
		Extract grub.cfg from the ROM:<br/>
		<b>$ ./cbfstool libreboot_usqwerty.rom extract -n grubtest.cfg -f grubtest.cfg</b>
	</p>

	<p>
		Now you have a grubtest.cfg in cbfstool directory. Edit it however you wish.
	</p>

	<div class="important">

		<h2>Example modification (Trisquel GNU/Linux, can also be adapted, or copied, for other apt-get distros)</h2>

			<p>
				Look at the 3 lines under the menu entry 'Load Operating System'; these are all you need to change.
			</p>

			<p>
				As an example, on my test system in /boot/grub/grub.cfg I see for the main menu entry:
				<b>linux	/boot/vmlinuz-3.15.1-gnu.nonpae root=UUID=3a008e14-4871-497b-95e5-fb180f277951 ro   crashkernel=384M-2G:64M,2G-:128M quiet splash $vt_handoff</b>
				<b>initrd	/boot/initrd.img-3.15.1-gnu.nonpae</b>
			</p>

			<p>
				crashkernel=384M-2G:64M,2G-:128M and $vt_handoff can be safely ignored.
			</p>

			<p>
				I use this to get my partition layout:<br/>
				$ <b>lsblk</b>
			</p>

			<p>
				In my case, I have no /boot partition, instead /boot is on the same partition as / on sda1. Yours might be different.
				In GRUB terms, sda means ahci0. 1 means msdos1, or gpt1, depending on whether I am using MBR or GPT partitioning.
				Thus, /dev/sda1 is GRUB is (ahci0,msdos1) or (ahci0,gpt1). In my case, I use MBR partitioning so it's (ahci0,msdos1).
				'msdos' is GRUB's name simply because this partitioning type is traditionally used by MS-DOS. It doesn't mean you have a 
				proprietary OS.
			</p>

			<p>
				Trisquel doesn't keep the filenames of kernels consistent, instead it keeps old kernels and new kernel updates are provided
				with the version in the filename. This can make GRUB payload a bit tricky. Fortunately, there are symlinks /vmlinuz and /initrd.img
				so if your /boot and / are on the same partition, you can set GRUB to boot from that. These are also updated automatically when
				installing kernel updates from your distributions apt-get repositories.
				NOte: when using jxself.org/linux-libre kernels, these are not updated at all and you have to update them manually.
			</p>

			<p>
				For the GRUB payload's grub.cfg (in 'Load Operating System' menu entry), we therefore have (in this example):<br/>
				<b>set root='ahci0,msdos1'</b><br/>
				<b>linux /vmlinuz root=UUID=3a008e14-4871-497b-95e5-fb180f277951 ro quiet splash</b><br/>
				<b>initrd /initrd.img</b>
			</p>

			<p>
				Optionally, you can convert the UUID to it's real device name, for example /dev/sda1 in this case.
				sdX naming isn't very reliable, though, which is why UUID is used for most distributions.
			</p>

			<p>
				Alternatively, if your /boot is on a separate partition then you cannot rely on the /vmlinuz and /initrd.img symlinks.
				Instead, go into /boot and create your own symlinks (update them manually when you install a new kernel update).<br/>
				$ <b>sudo -s</b><br/>
				# <b>cd /boot/</b><br/>
				# <b>rm -rf vmlinuz initrd.img</b><br/>
				# <b>ln -s <u>kernel</u> ksym</b><br/>
				# <b>ln -s <u>initrd</u> isym</b><br/>
				# <b>exit</b>
			</p>

			<p>
				Replace the underlined <b>kernel</b> and <b>initrd</b> filenames above with the actual filenames, of course.
			</p>

			<p>
				Then your grub.cfg menu entry (for payload) becomes like that, for example if / was on sda2 and /boot was on sda1:<br/>
				<b>set root='ahci0,msdos1'</b><br/>
				<b>linux /ksym root=/dev/sda2 ro quiet splash</b><br/>
				<b>initrd /isym</b>
			</p>

			<p>
				There are lots of possible variations so please try to adapt.
			</p>

		<h2>Parabola GNU/Linux-libre</h2>

			<p>
				You can basically adapt the above. Note however that Parabola does not keep old kernels still installed, and the file names 
				are always consistent, so you don't need to boot from symlinks, you can just use the real thing directly.
			</p>

	</div>

	<p>
		Now you have your modified grub.cfg. (right?)
	</p>

	<p>
		Delete the grubtest.cfg that remained inside the ROM:<br/>
		<b>$ ./cbfstool libreboot_usqwerty.rom remove -n grubtest.cfg</b>
	</p>

	<p>
		Display ROM contents and now you see grubtest.cfg no longer exists there:<br/>
		<b>$ ./cbfstool libreboot_usqwerty.rom print</b>
	</p>

	<p>
		Add the modified version that you just made:<br/>
		<b>$ ./cbfstool libreboot_usqwerty.rom add -n grubtest.cfg -f grubtest.cfg -t raw</b>
	</p>

	<p>
		Now display ROM contents again and see that it exists again:<br/>
		<b>$ ./cbfstool libreboot_usqwerty.rom print</b>
	</p>

	<p>
		Now you have a modified ROM. Refer back to <a href="../index.html#flashrom">../index.html#flashrom</a> for information
		on how to flash it.
	</p>

	<p>
		Choose (in GRUB) the menu entry that switches to grubtest.cfg. If it works, then your config is safe and you can continue below.
	</p>

	<p>
		Rename (just reduce confusion):<br/>
		$ <b>mv grubtest.cfg grub.cfg</b>
	</p>

	<p>
		Delete the grub.cfg that remained inside the ROM:<br/>
		<b>$ ./cbfstool libreboot_usqwerty.rom remove -n grub.cfg</b>
	</p>

	<p>
		Display ROM contents and now you see grub.cfg no longer exists there:<br/>
		<b>$ ./cbfstool libreboot_usqwerty.rom print</b>
	</p>

	<p>
		Add the modified version that you just made:<br/>
		<b>$ ./cbfstool libreboot_usqwerty.rom add -n grub.cfg -f grub.cfg -t raw</b>
	</p>

	<p>
		Now display ROM contents again and see that it exists again:<br/>
		<b>$ ./cbfstool libreboot_usqwerty.rom print</b>
	</p>

	<p>
		Now you have a modified ROM. Refer back to <a href="../index.html#flashrom">../index.html#flashrom</a> for information
		on how to flash it.
	</p>

	<p>
		If all went well, GRUB should now boot your system the way you intended.
	</p>

	<p>
		<b>Anecdotally, a user reported that segmentation faults occur with cbfstool when using this procedure depending on the size of the grub.cfg being re-insterted. In his case, a minimum size of 857 bytes was required. This could (at the time of this release) be a bug in cbfstool that should be investigated with the coreboot community. If cbfstool segfaults, then keep this in mind. 'strace' (or gdb? clang?) could be used for debugging. This was in libreboot 5th release (based on coreboot from late 2013). Not sure if the issue perists in the 6th release (based on coreboot from June 1st, 2014 at the time of writing); I have never personally encountered the bug. strace (from that user) is here: <a href="cbfstool_libreboot5_strace">cbfstool_libreboot5_strace</a>. The issue has been reported by a few users, so does not happen all the time: this bug (if it still exists) could (should) be reproduced.</b>
	</p>

<hr/>

	<p>
		Copyright &copy; 2014 Francis Rowe &lt;info@gluglug.org.uk&gt;<br/>
		This document is released under the Creative Commons Attribution-ShareAlike 4.0 International Public License and all future versions.
		A copy of the license can be found at <a href="../license.txt">../license.txt</a>.
	</p>

	<p>
		This document is distributed in the hope that it will be useful,
		but WITHOUT ANY WARRANTY; without even the implied warranty of
		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See <a href="../license.txt">../license.txt</a> for more information.
	</p>

</body>
</html>