Blame view

usr/Kconfig 7.75 KB
b24413180   Greg Kroah-Hartman   License cleanup: ...
1
  # SPDX-License-Identifier: GPL-2.0
dbec48663   Sam Ravnborg   kconfig: move ini...
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
  #
  # Configuration for initramfs
  #
  
  config INITRAMFS_SOURCE
  	string "Initramfs source file(s)"
  	default ""
  	help
  	  This can be either a single cpio archive with a .cpio suffix or a
  	  space-separated list of directories and files for building the
  	  initramfs image.  A cpio archive should contain a filesystem archive
  	  to be used as an initramfs image.  Directories should contain a
  	  filesystem layout to be included in the initramfs image.  Files
  	  should contain entries according to the format described by the
  	  "usr/gen_init_cpio" program in the kernel tree.
  
  	  When multiple directories and files are specified then the
  	  initramfs image will be the aggregate of all of them.
ec4b78a0e   Mauro Carvalho Chehab   docs: early-users...
20
  	  See <file:Documentation/driver-api/early-userspace/early_userspace_support.rst> for more details.
dbec48663   Sam Ravnborg   kconfig: move ini...
21
22
  
  	  If you are not sure, leave it blank.
cff75e0b6   Daniel Thompson   initramfs: provid...
23
24
25
26
27
28
29
30
31
  config INITRAMFS_FORCE
  	bool "Ignore the initramfs passed by the bootloader"
  	depends on CMDLINE_EXTEND || CMDLINE_FORCE
  	help
  	  This option causes the kernel to ignore the initramfs image
  	  (or initrd image) passed to it by the bootloader. This is
  	  analogous to CMDLINE_FORCE, which is found on some architectures,
  	  and is useful if you cannot or don't want to change the image
  	  your bootloader passes to the kernel.
dbec48663   Sam Ravnborg   kconfig: move ini...
32
33
34
35
36
  config INITRAMFS_ROOT_UID
  	int "User ID to map to 0 (user root)"
  	depends on INITRAMFS_SOURCE!=""
  	default "0"
  	help
595a22ace   Rob Landley   scripts/gen_initr...
37
38
  	  If INITRAMFS_SOURCE points to a directory, files owned by this UID
  	  (-1 = current user) will be owned by root in the resulting image.
dbec48663   Sam Ravnborg   kconfig: move ini...
39
40
41
42
43
44
45
46
  
  	  If you are not sure, leave it set to "0".
  
  config INITRAMFS_ROOT_GID
  	int "Group ID to map to 0 (group root)"
  	depends on INITRAMFS_SOURCE!=""
  	default "0"
  	help
595a22ace   Rob Landley   scripts/gen_initr...
47
48
  	  If INITRAMFS_SOURCE points to a directory, files owned by this GID
  	  (-1 = current group) will be owned by root in the resulting image.
dbec48663   Sam Ravnborg   kconfig: move ini...
49
50
  
  	  If you are not sure, leave it set to "0".
fb9a4ca98   H. Peter Anvin   bzip2/lzma: move ...
51
52
  
  config RD_GZIP
f2e8954b0   Rob Landley   ramfs: clarify he...
53
  	bool "Support initial ramdisk/ramfs compressed using gzip"
ec72c666f   Andi Kleen   usr/Kconfig: make...
54
  	default y
fb9a4ca98   H. Peter Anvin   bzip2/lzma: move ...
55
56
57
58
59
60
  	select DECOMPRESS_GZIP
  	help
  	  Support loading of a gzip encoded initial ramdisk or cpio buffer.
  	  If unsure, say Y.
  
  config RD_BZIP2
f2e8954b0   Rob Landley   ramfs: clarify he...
61
  	bool "Support initial ramdisk/ramfs compressed using bzip2"
ec72c666f   Andi Kleen   usr/Kconfig: make...
62
  	default y
fb9a4ca98   H. Peter Anvin   bzip2/lzma: move ...
63
64
65
66
67
68
  	select DECOMPRESS_BZIP2
  	help
  	  Support loading of a bzip2 encoded initial ramdisk or cpio buffer
  	  If unsure, say N.
  
  config RD_LZMA
f2e8954b0   Rob Landley   ramfs: clarify he...
69
  	bool "Support initial ramdisk/ramfs compressed using LZMA"
ec72c666f   Andi Kleen   usr/Kconfig: make...
70
  	default y
fb9a4ca98   H. Peter Anvin   bzip2/lzma: move ...
71
72
  	select DECOMPRESS_LZMA
  	help
55d1d26f2   H. Peter Anvin   bzip2/lzma: consi...
73
  	  Support loading of a LZMA encoded initial ramdisk or cpio buffer
fb9a4ca98   H. Peter Anvin   bzip2/lzma: move ...
74
  	  If unsure, say N.
ab76f3d77   Alain Knaff   bzip2/lzma: make ...
75

3ebe12439   Lasse Collin   decompressors: ad...
76
  config RD_XZ
f2e8954b0   Rob Landley   ramfs: clarify he...
77
  	bool "Support initial ramdisk/ramfs compressed using XZ"
ec72c666f   Andi Kleen   usr/Kconfig: make...
78
  	default y
3ebe12439   Lasse Collin   decompressors: ad...
79
80
81
82
  	select DECOMPRESS_XZ
  	help
  	  Support loading of a XZ encoded initial ramdisk or cpio buffer.
  	  If unsure, say N.
cacb246f8   Albin Tonnerre   Add LZO compressi...
83
  config RD_LZO
f2e8954b0   Rob Landley   ramfs: clarify he...
84
  	bool "Support initial ramdisk/ramfs compressed using LZO"
ec72c666f   Andi Kleen   usr/Kconfig: make...
85
  	default y
cacb246f8   Albin Tonnerre   Add LZO compressi...
86
87
88
89
  	select DECOMPRESS_LZO
  	help
  	  Support loading of a LZO encoded initial ramdisk or cpio buffer
  	  If unsure, say N.
e76e1fdfa   Kyungsik Lee   lib: add support ...
90
  config RD_LZ4
f2e8954b0   Rob Landley   ramfs: clarify he...
91
  	bool "Support initial ramdisk/ramfs compressed using LZ4"
ec72c666f   Andi Kleen   usr/Kconfig: make...
92
  	default y
e76e1fdfa   Kyungsik Lee   lib: add support ...
93
94
95
96
  	select DECOMPRESS_LZ4
  	help
  	  Support loading of a LZ4 encoded initial ramdisk or cpio buffer
  	  If unsure, say N.
35e669e1a   Francisco Blas Izquierdo Riera (klondike)   initramfs: select...
97

a30d8a39f   Nick Terrell   usr: Add support ...
98
99
100
101
102
103
104
105
  config RD_ZSTD
  	bool "Support initial ramdisk/ramfs compressed using ZSTD"
  	default y
  	depends on BLK_DEV_INITRD
  	select DECOMPRESS_ZSTD
  	help
  	  Support loading of a ZSTD encoded initial ramdisk or cpio buffer.
  	  If unsure, say N.
db2aa7fd1   Francisco Blas Izquierdo Riera (klondike)   initramfs: allow ...
106
107
  choice
  	prompt "Built-in initramfs compression mode"
d4e9056da   Masahiro Yamada   initramfs: do not...
108
  	depends on INITRAMFS_SOURCE != ""
db2aa7fd1   Francisco Blas Izquierdo Riera (klondike)   initramfs: allow ...
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
  	help
  	  This option allows you to decide by which algorithm the builtin
  	  initramfs will be compressed.  Several compression algorithms are
  	  available, which differ in efficiency, compression and
  	  decompression speed.  Compression speed is only relevant
  	  when building a kernel.  Decompression speed is relevant at
  	  each boot. Also the memory usage during decompression may become
  	  relevant on memory constrained systems. This is usually based on the
  	  dictionary size of the algorithm with algorithms like XZ and LZMA
  	  featuring large dictionary sizes.
  
  	  High compression options are mostly useful for users who are
  	  low on RAM, since it reduces the memory consumption during
  	  boot.
  
  	  Keep in mind that your build system needs to provide the appropriate
  	  compression tool to compress the generated initram cpio file for
  	  embedding.
  
  	  If in doubt, select 'None'
db2aa7fd1   Francisco Blas Izquierdo Riera (klondike)   initramfs: allow ...
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
  config INITRAMFS_COMPRESSION_GZIP
  	bool "Gzip"
  	depends on RD_GZIP
  	help
  	  Use the old and well tested gzip compression algorithm. Gzip provides
  	  a good balance between compression ratio and decompression speed and
  	  has a reasonable compression speed. It is also more likely to be
  	  supported by your build system as the gzip tool is present by default
  	  on most distros.
  
  config INITRAMFS_COMPRESSION_BZIP2
  	bool "Bzip2"
  	depends on RD_BZIP2
  	help
  	  It's compression ratio and speed is intermediate. Decompression speed
  	  is slowest among the choices. The initramfs size is about 10% smaller
  	  with bzip2, in comparison to gzip. Bzip2 uses a large amount of
  	  memory. For modern kernels you will need at least 8MB RAM or more for
  	  booting.
  
  	  If you choose this, keep in mind that you need to have the bzip2 tool
  	  available to be able to compress the initram.
  
  config INITRAMFS_COMPRESSION_LZMA
  	bool "LZMA"
  	depends on RD_LZMA
  	help
  	  This algorithm's compression ratio is best but has a large dictionary
  	  size which might cause issues in memory constrained systems.
  	  Decompression speed is between the other choices. Compression is
  	  slowest. The initramfs size is about 33% smaller with LZMA in
  	  comparison to gzip.
  
  	  If you choose this, keep in mind that you may need to install the xz
  	  or lzma tools to be able to compress the initram.
  
  config INITRAMFS_COMPRESSION_XZ
  	bool "XZ"
  	depends on RD_XZ
  	help
  	  XZ uses the LZMA2 algorithm and has a large dictionary which may cause
  	  problems on memory constrained systems. The initramfs size is about
  	  30% smaller with XZ in comparison to gzip. Decompression speed is
  	  better than that of bzip2 but worse than gzip and LZO. Compression is
  	  slow.
  
  	  If you choose this, keep in mind that you may need to install the xz
  	  tool to be able to compress the initram.
  
  config INITRAMFS_COMPRESSION_LZO
  	bool "LZO"
  	depends on RD_LZO
  	help
  	  It's compression ratio is the second poorest amongst the choices. The
  	  kernel size is about 10% bigger than gzip. Despite that, it's
  	  decompression speed is the second fastest and it's compression speed
  	  is quite fast too.
  
  	  If you choose this, keep in mind that you may need to install the lzop
  	  tool to be able to compress the initram.
  
  config INITRAMFS_COMPRESSION_LZ4
  	bool "LZ4"
  	depends on RD_LZ4
  	help
  	  It's compression ratio is the poorest amongst the choices. The kernel
  	  size is about 15% bigger than gzip; however its decompression speed
  	  is the fastest.
  
  	  If you choose this, keep in mind that most distros don't provide lz4
  	  by default which could cause a build failure.
a30d8a39f   Nick Terrell   usr: Add support ...
200
201
202
203
204
205
206
207
208
209
  config INITRAMFS_COMPRESSION_ZSTD
  	bool "ZSTD"
  	depends on RD_ZSTD
  	help
  	  ZSTD is a compression algorithm targeting intermediate compression
  	  with fast decompression speed. It will compress better than GZIP and
  	  decompress around the same speed as LZO, but slower than LZ4.
  
  	  If you choose this, keep in mind that you may need to install the zstd
  	  tool to be able to compress the initram.
785d74ec3   Eugeniy Paltsev   initramfs: restor...
210
211
212
213
214
215
216
217
218
219
  config INITRAMFS_COMPRESSION_NONE
  	bool "None"
  	help
  	  Do not compress the built-in initramfs at all. This may sound wasteful
  	  in space, but, you should be aware that the built-in initramfs will be
  	  compressed at a later stage anyways along with the rest of the kernel,
  	  on those architectures that support this. However, not compressing the
  	  initramfs may lead to slightly higher memory consumption during a
  	  short time at boot, while both the cpio image and the unpacked
  	  filesystem image will be present in memory simultaneously
db2aa7fd1   Francisco Blas Izquierdo Riera (klondike)   initramfs: allow ...
220
  endchoice