1 # SPDX-License-Identifier: GPL-2.0 <<
2 # 1 #
3 # Configuration for initramfs 2 # Configuration for initramfs
4 # 3 #
5 4
6 config INITRAMFS_SOURCE 5 config INITRAMFS_SOURCE
7 string "Initramfs source file(s)" 6 string "Initramfs source file(s)"
8 default "" 7 default ""
9 help 8 help
10 This can be either a single cpio arc 9 This can be either a single cpio archive with a .cpio suffix or a
11 space-separated list of directories 10 space-separated list of directories and files for building the
12 initramfs image. A cpio archive sho 11 initramfs image. A cpio archive should contain a filesystem archive
13 to be used as an initramfs image. D 12 to be used as an initramfs image. Directories should contain a
14 filesystem layout to be included in 13 filesystem layout to be included in the initramfs image. Files
15 should contain entries according to 14 should contain entries according to the format described by the
16 "usr/gen_init_cpio" program in the k 15 "usr/gen_init_cpio" program in the kernel tree.
17 16
18 When multiple directories and files 17 When multiple directories and files are specified then the
19 initramfs image will be the aggregat 18 initramfs image will be the aggregate of all of them.
20 19
21 See <file:Documentation/driver-api/e !! 20 See <file:Documentation/early-userspace/README> for more details.
22 21
23 If you are not sure, leave it blank. 22 If you are not sure, leave it blank.
24 23
25 config INITRAMFS_FORCE 24 config INITRAMFS_FORCE
26 bool "Ignore the initramfs passed by t 25 bool "Ignore the initramfs passed by the bootloader"
27 depends on CMDLINE_EXTEND || CMDLINE_F 26 depends on CMDLINE_EXTEND || CMDLINE_FORCE
28 help 27 help
29 This option causes the kernel to ign 28 This option causes the kernel to ignore the initramfs image
30 (or initrd image) passed to it by th 29 (or initrd image) passed to it by the bootloader. This is
31 analogous to CMDLINE_FORCE, which is 30 analogous to CMDLINE_FORCE, which is found on some architectures,
32 and is useful if you cannot or don't 31 and is useful if you cannot or don't want to change the image
33 your bootloader passes to the kernel 32 your bootloader passes to the kernel.
34 33
35 config INITRAMFS_ROOT_UID 34 config INITRAMFS_ROOT_UID
36 int "User ID to map to 0 (user root)" 35 int "User ID to map to 0 (user root)"
37 depends on INITRAMFS_SOURCE!="" 36 depends on INITRAMFS_SOURCE!=""
38 default "0" 37 default "0"
39 help 38 help
40 If INITRAMFS_SOURCE points to a dire 39 If INITRAMFS_SOURCE points to a directory, files owned by this UID
41 (-1 = current user) will be owned by 40 (-1 = current user) will be owned by root in the resulting image.
42 41
43 If you are not sure, leave it set to 42 If you are not sure, leave it set to "0".
44 43
45 config INITRAMFS_ROOT_GID 44 config INITRAMFS_ROOT_GID
46 int "Group ID to map to 0 (group root) 45 int "Group ID to map to 0 (group root)"
47 depends on INITRAMFS_SOURCE!="" 46 depends on INITRAMFS_SOURCE!=""
48 default "0" 47 default "0"
49 help 48 help
50 If INITRAMFS_SOURCE points to a dire 49 If INITRAMFS_SOURCE points to a directory, files owned by this GID
51 (-1 = current group) will be owned b 50 (-1 = current group) will be owned by root in the resulting image.
52 51
53 If you are not sure, leave it set to 52 If you are not sure, leave it set to "0".
54 53
55 config RD_GZIP 54 config RD_GZIP
56 bool "Support initial ramdisk/ramfs co 55 bool "Support initial ramdisk/ramfs compressed using gzip"
>> 56 depends on BLK_DEV_INITRD
57 default y 57 default y
58 select DECOMPRESS_GZIP 58 select DECOMPRESS_GZIP
59 help 59 help
60 Support loading of a gzip encoded in 60 Support loading of a gzip encoded initial ramdisk or cpio buffer.
61 If unsure, say Y. 61 If unsure, say Y.
62 62
63 config RD_BZIP2 63 config RD_BZIP2
64 bool "Support initial ramdisk/ramfs co 64 bool "Support initial ramdisk/ramfs compressed using bzip2"
65 default y 65 default y
>> 66 depends on BLK_DEV_INITRD
66 select DECOMPRESS_BZIP2 67 select DECOMPRESS_BZIP2
67 help 68 help
68 Support loading of a bzip2 encoded i 69 Support loading of a bzip2 encoded initial ramdisk or cpio buffer
69 If unsure, say N. 70 If unsure, say N.
70 71
71 config RD_LZMA 72 config RD_LZMA
72 bool "Support initial ramdisk/ramfs co 73 bool "Support initial ramdisk/ramfs compressed using LZMA"
73 default y 74 default y
>> 75 depends on BLK_DEV_INITRD
74 select DECOMPRESS_LZMA 76 select DECOMPRESS_LZMA
75 help 77 help
76 Support loading of a LZMA encoded in 78 Support loading of a LZMA encoded initial ramdisk or cpio buffer
77 If unsure, say N. 79 If unsure, say N.
78 80
79 config RD_XZ 81 config RD_XZ
80 bool "Support initial ramdisk/ramfs co 82 bool "Support initial ramdisk/ramfs compressed using XZ"
>> 83 depends on BLK_DEV_INITRD
81 default y 84 default y
82 select DECOMPRESS_XZ 85 select DECOMPRESS_XZ
83 help 86 help
84 Support loading of a XZ encoded init 87 Support loading of a XZ encoded initial ramdisk or cpio buffer.
85 If unsure, say N. 88 If unsure, say N.
86 89
87 config RD_LZO 90 config RD_LZO
88 bool "Support initial ramdisk/ramfs co 91 bool "Support initial ramdisk/ramfs compressed using LZO"
89 default y 92 default y
>> 93 depends on BLK_DEV_INITRD
90 select DECOMPRESS_LZO 94 select DECOMPRESS_LZO
91 help 95 help
92 Support loading of a LZO encoded ini 96 Support loading of a LZO encoded initial ramdisk or cpio buffer
93 If unsure, say N. 97 If unsure, say N.
94 98
95 config RD_LZ4 99 config RD_LZ4
96 bool "Support initial ramdisk/ramfs co 100 bool "Support initial ramdisk/ramfs compressed using LZ4"
97 default y 101 default y
>> 102 depends on BLK_DEV_INITRD
98 select DECOMPRESS_LZ4 103 select DECOMPRESS_LZ4
99 help 104 help
100 Support loading of a LZ4 encoded ini 105 Support loading of a LZ4 encoded initial ramdisk or cpio buffer
101 If unsure, say N. 106 If unsure, say N.
102 107
103 config RD_ZSTD <<
104 bool "Support initial ramdisk/ramfs co <<
105 default y <<
106 select DECOMPRESS_ZSTD <<
107 help <<
108 Support loading of a ZSTD encoded in <<
109 If unsure, say N. <<
110 <<
111 choice 108 choice
112 prompt "Built-in initramfs compression 109 prompt "Built-in initramfs compression mode"
113 depends on INITRAMFS_SOURCE != "" !! 110 depends on INITRAMFS_SOURCE!=""
>> 111 optional
114 help 112 help
115 This option allows you to decide by 113 This option allows you to decide by which algorithm the builtin
116 initramfs will be compressed. Sever 114 initramfs will be compressed. Several compression algorithms are
117 available, which differ in efficienc 115 available, which differ in efficiency, compression and
118 decompression speed. Compression sp 116 decompression speed. Compression speed is only relevant
119 when building a kernel. Decompressi 117 when building a kernel. Decompression speed is relevant at
120 each boot. Also the memory usage dur 118 each boot. Also the memory usage during decompression may become
121 relevant on memory constrained syste 119 relevant on memory constrained systems. This is usually based on the
122 dictionary size of the algorithm wit 120 dictionary size of the algorithm with algorithms like XZ and LZMA
123 featuring large dictionary sizes. 121 featuring large dictionary sizes.
124 122
125 High compression options are mostly 123 High compression options are mostly useful for users who are
126 low on RAM, since it reduces the mem 124 low on RAM, since it reduces the memory consumption during
127 boot. 125 boot.
128 126
129 Keep in mind that your build system 127 Keep in mind that your build system needs to provide the appropriate
130 compression tool to compress the gen 128 compression tool to compress the generated initram cpio file for
131 embedding. 129 embedding.
132 130
133 If in doubt, select 'None' 131 If in doubt, select 'None'
134 132
>> 133 config INITRAMFS_COMPRESSION_NONE
>> 134 bool "None"
>> 135 help
>> 136 Do not compress the built-in initramfs at all. This may sound wasteful
>> 137 in space, but, you should be aware that the built-in initramfs will be
>> 138 compressed at a later stage anyways along with the rest of the kernel,
>> 139 on those architectures that support this. However, not compressing the
>> 140 initramfs may lead to slightly higher memory consumption during a
>> 141 short time at boot, while both the cpio image and the unpacked
>> 142 filesystem image will be present in memory simultaneously
>> 143
135 config INITRAMFS_COMPRESSION_GZIP 144 config INITRAMFS_COMPRESSION_GZIP
136 bool "Gzip" 145 bool "Gzip"
137 depends on RD_GZIP 146 depends on RD_GZIP
138 help 147 help
139 Use the old and well tested gzip com 148 Use the old and well tested gzip compression algorithm. Gzip provides
140 a good balance between compression r 149 a good balance between compression ratio and decompression speed and
141 has a reasonable compression speed. 150 has a reasonable compression speed. It is also more likely to be
142 supported by your build system as th 151 supported by your build system as the gzip tool is present by default
143 on most distros. 152 on most distros.
144 153
145 config INITRAMFS_COMPRESSION_BZIP2 154 config INITRAMFS_COMPRESSION_BZIP2
146 bool "Bzip2" 155 bool "Bzip2"
147 depends on RD_BZIP2 156 depends on RD_BZIP2
148 help 157 help
149 It's compression ratio and speed is 158 It's compression ratio and speed is intermediate. Decompression speed
150 is slowest among the choices. The in 159 is slowest among the choices. The initramfs size is about 10% smaller
151 with bzip2, in comparison to gzip. B 160 with bzip2, in comparison to gzip. Bzip2 uses a large amount of
152 memory. For modern kernels you will 161 memory. For modern kernels you will need at least 8MB RAM or more for
153 booting. 162 booting.
154 163
155 If you choose this, keep in mind tha 164 If you choose this, keep in mind that you need to have the bzip2 tool
156 available to be able to compress the 165 available to be able to compress the initram.
157 166
158 config INITRAMFS_COMPRESSION_LZMA 167 config INITRAMFS_COMPRESSION_LZMA
159 bool "LZMA" 168 bool "LZMA"
160 depends on RD_LZMA 169 depends on RD_LZMA
161 help 170 help
162 This algorithm's compression ratio i 171 This algorithm's compression ratio is best but has a large dictionary
163 size which might cause issues in mem 172 size which might cause issues in memory constrained systems.
164 Decompression speed is between the o 173 Decompression speed is between the other choices. Compression is
165 slowest. The initramfs size is about 174 slowest. The initramfs size is about 33% smaller with LZMA in
166 comparison to gzip. 175 comparison to gzip.
167 176
168 If you choose this, keep in mind tha 177 If you choose this, keep in mind that you may need to install the xz
169 or lzma tools to be able to compress 178 or lzma tools to be able to compress the initram.
170 179
171 config INITRAMFS_COMPRESSION_XZ 180 config INITRAMFS_COMPRESSION_XZ
172 bool "XZ" 181 bool "XZ"
173 depends on RD_XZ 182 depends on RD_XZ
174 help 183 help
175 XZ uses the LZMA2 algorithm and has 184 XZ uses the LZMA2 algorithm and has a large dictionary which may cause
176 problems on memory constrained syste 185 problems on memory constrained systems. The initramfs size is about
177 30% smaller with XZ in comparison to 186 30% smaller with XZ in comparison to gzip. Decompression speed is
178 better than that of bzip2 but worse 187 better than that of bzip2 but worse than gzip and LZO. Compression is
179 slow. 188 slow.
180 189
181 If you choose this, keep in mind tha 190 If you choose this, keep in mind that you may need to install the xz
182 tool to be able to compress the init 191 tool to be able to compress the initram.
183 192
184 config INITRAMFS_COMPRESSION_LZO 193 config INITRAMFS_COMPRESSION_LZO
185 bool "LZO" 194 bool "LZO"
186 depends on RD_LZO 195 depends on RD_LZO
187 help 196 help
188 Its compression ratio is the second !! 197 It's compression ratio is the second poorest amongst the choices. The
189 kernel size is about 10% bigger than !! 198 kernel size is about 10% bigger than gzip. Despite that, it's
190 decompression speed is the second fa !! 199 decompression speed is the second fastest and it's compression speed
191 is quite fast too. 200 is quite fast too.
192 201
193 If you choose this, keep in mind tha 202 If you choose this, keep in mind that you may need to install the lzop
194 tool to be able to compress the init 203 tool to be able to compress the initram.
195 204
196 config INITRAMFS_COMPRESSION_LZ4 205 config INITRAMFS_COMPRESSION_LZ4
197 bool "LZ4" 206 bool "LZ4"
198 depends on RD_LZ4 207 depends on RD_LZ4
199 help 208 help
200 It's compression ratio is the poores 209 It's compression ratio is the poorest amongst the choices. The kernel
201 size is about 15% bigger than gzip; 210 size is about 15% bigger than gzip; however its decompression speed
202 is the fastest. 211 is the fastest.
203 212
204 If you choose this, keep in mind tha 213 If you choose this, keep in mind that most distros don't provide lz4
205 by default which could cause a build 214 by default which could cause a build failure.
206 215
207 config INITRAMFS_COMPRESSION_ZSTD <<
208 bool "ZSTD" <<
209 depends on RD_ZSTD <<
210 help <<
211 ZSTD is a compression algorithm targ <<
212 with fast decompression speed. It wi <<
213 decompress around the same speed as <<
214 <<
215 If you choose this, keep in mind tha <<
216 tool to be able to compress the init <<
217 <<
218 config INITRAMFS_COMPRESSION_NONE <<
219 bool "None" <<
220 help <<
221 Do not compress the built-in initram <<
222 in space, but, you should be aware t <<
223 compressed at a later stage anyways <<
224 on those architectures that support <<
225 initramfs may lead to slightly highe <<
226 short time at boot, while both the c <<
227 filesystem image will be present in <<
228 <<
229 endchoice 216 endchoice
>> 217
>> 218 config INITRAMFS_COMPRESSION
>> 219 depends on INITRAMFS_SOURCE!=""
>> 220 string
>> 221 default "" if INITRAMFS_COMPRESSION_NONE
>> 222 default ".gz" if INITRAMFS_COMPRESSION_GZIP
>> 223 default ".bz2" if INITRAMFS_COMPRESSION_BZIP2
>> 224 default ".lzma" if INITRAMFS_COMPRESSION_LZMA
>> 225 default ".xz" if INITRAMFS_COMPRESSION_XZ
>> 226 default ".lzo" if INITRAMFS_COMPRESSION_LZO
>> 227 default ".lz4" if INITRAMFS_COMPRESSION_LZ4
>> 228 default ".gz" if RD_GZIP
>> 229 default ".lz4" if RD_LZ4
>> 230 default ".lzo" if RD_LZO
>> 231 default ".xz" if RD_XZ
>> 232 default ".lzma" if RD_LZMA
>> 233 default ".bz2" if RD_BZIP2
>> 234 default ""
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.