• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# SPDX-License-Identifier: GPL-2.0-only
2config PSTORE
3	tristate "Persistent store support"
4	select CRYPTO if PSTORE_COMPRESS
5	default n
6	help
7	   This option enables generic access to platform level
8	   persistent storage via "pstore" filesystem that can
9	   be mounted as /dev/pstore.  Only useful if you have
10	   a platform level driver that registers with pstore to
11	   provide the data, so you probably should just go say "Y"
12	   (or "M") to a platform specific persistent store driver
13	   (e.g. ACPI_APEI on X86) which will select this for you.
14	   If you don't have a platform persistent store driver,
15	   say N.
16
17config PSTORE_DEFLATE_COMPRESS
18	tristate "DEFLATE (ZLIB) compression"
19	default y
20	depends on PSTORE
21	select CRYPTO_DEFLATE
22	help
23	  This option enables DEFLATE (also known as ZLIB) compression
24	  algorithm support.
25
26config PSTORE_LZO_COMPRESS
27	tristate "LZO compression"
28	depends on PSTORE
29	select CRYPTO_LZO
30	help
31	  This option enables LZO compression algorithm support.
32
33config PSTORE_LZ4_COMPRESS
34	tristate "LZ4 compression"
35	depends on PSTORE
36	select CRYPTO_LZ4
37	help
38	  This option enables LZ4 compression algorithm support.
39
40config PSTORE_LZ4HC_COMPRESS
41	tristate "LZ4HC compression"
42	depends on PSTORE
43	select CRYPTO_LZ4HC
44	help
45	  This option enables LZ4HC (high compression) mode algorithm.
46
47config PSTORE_842_COMPRESS
48	bool "842 compression"
49	depends on PSTORE
50	select CRYPTO_842
51	help
52	  This option enables 842 compression algorithm support.
53
54config PSTORE_ZSTD_COMPRESS
55	bool "zstd compression"
56	depends on PSTORE
57	select CRYPTO_ZSTD
58	help
59	  This option enables zstd compression algorithm support.
60
61config PSTORE_COMPRESS
62	def_bool y
63	depends on PSTORE
64	depends on PSTORE_DEFLATE_COMPRESS || PSTORE_LZO_COMPRESS ||	\
65		   PSTORE_LZ4_COMPRESS || PSTORE_LZ4HC_COMPRESS ||	\
66		   PSTORE_842_COMPRESS || PSTORE_ZSTD_COMPRESS
67
68choice
69	prompt "Default pstore compression algorithm"
70	depends on PSTORE_COMPRESS
71	help
72	  This option chooses the default active compression algorithm.
73	  This change be changed at boot with "pstore.compress=..." on
74	  the kernel command line.
75
76	  Currently, pstore has support for 6 compression algorithms:
77	  deflate, lzo, lz4, lz4hc, 842 and zstd.
78
79	  The default compression algorithm is deflate.
80
81	config PSTORE_DEFLATE_COMPRESS_DEFAULT
82		bool "deflate" if PSTORE_DEFLATE_COMPRESS
83
84	config PSTORE_LZO_COMPRESS_DEFAULT
85		bool "lzo" if PSTORE_LZO_COMPRESS
86
87	config PSTORE_LZ4_COMPRESS_DEFAULT
88		bool "lz4" if PSTORE_LZ4_COMPRESS
89
90	config PSTORE_LZ4HC_COMPRESS_DEFAULT
91		bool "lz4hc" if PSTORE_LZ4HC_COMPRESS
92
93	config PSTORE_842_COMPRESS_DEFAULT
94		bool "842" if PSTORE_842_COMPRESS
95
96	config PSTORE_ZSTD_COMPRESS_DEFAULT
97		bool "zstd" if PSTORE_ZSTD_COMPRESS
98
99endchoice
100
101config PSTORE_COMPRESS_DEFAULT
102	string
103	depends on PSTORE_COMPRESS
104	default "deflate" if PSTORE_DEFLATE_COMPRESS_DEFAULT
105	default "lzo" if PSTORE_LZO_COMPRESS_DEFAULT
106	default "lz4" if PSTORE_LZ4_COMPRESS_DEFAULT
107	default "lz4hc" if PSTORE_LZ4HC_COMPRESS_DEFAULT
108	default "842" if PSTORE_842_COMPRESS_DEFAULT
109	default "zstd" if PSTORE_ZSTD_COMPRESS_DEFAULT
110
111config PSTORE_CONSOLE
112	bool "Log kernel console messages"
113	depends on PSTORE
114	help
115	  When the option is enabled, pstore will log all kernel
116	  messages, even if no oops or panic happened.
117
118config PSTORE_PMSG
119	bool "Log user space messages"
120	depends on PSTORE
121	help
122	  When the option is enabled, pstore will export a character
123	  interface /dev/pmsg0 to log user space messages. On reboot
124	  data can be retrieved from /sys/fs/pstore/pmsg-ramoops-[ID].
125
126	  If unsure, say N.
127
128config PSTORE_FTRACE
129	bool "Persistent function tracer"
130	depends on PSTORE
131	depends on FUNCTION_TRACER
132	depends on DEBUG_FS
133	help
134	  With this option kernel traces function calls into a persistent
135	  ram buffer that can be decoded and dumped after reboot through
136	  pstore filesystem. It can be used to determine what function
137	  was last called before a reset or panic.
138
139	  If unsure, say N.
140
141config PSTORE_BLACKBOX
142	bool "Store customised fault log"
143	depends on PSTORE
144	depends on BLACKBOX
145	help
146	  Enable storing the customised fault log for BlackBox.
147
148	  With the option enabled, pstore will store the customised kernel
149	  fault log for BlackBox when oops or panic happened.
150
151	  If unsure, say N.
152
153config PSTORE_RAM
154	tristate "Log panic/oops to a RAM buffer"
155	depends on PSTORE
156	depends on HAS_IOMEM
157	select REED_SOLOMON
158	select REED_SOLOMON_ENC8
159	select REED_SOLOMON_DEC8
160	help
161	  This enables panic and oops messages to be logged to a circular
162	  buffer in RAM where it can be read back at some later point.
163
164	  Note that for historical reasons, the module will be named
165	  "ramoops.ko".
166
167	  For more information, see Documentation/admin-guide/ramoops.rst.
168
169config PSTORE_ZONE
170	tristate
171	depends on PSTORE
172	help
173	  The common layer for pstore/blk (and pstore/ram in the future)
174	  to manage storage in zones.
175
176config PSTORE_BLK
177	tristate "Log panic/oops to a block device"
178	depends on PSTORE
179	depends on BLOCK
180	depends on BLACKBOX_USE_PSTORE_BLK_DEBUG || BROKEN
181	select PSTORE_ZONE
182	default n
183	help
184	  This enables panic and oops message to be logged to a block dev
185	  where it can be read back at some later point.
186
187	  For more information, see Documentation/admin-guide/pstore-blk.rst
188
189	  If unsure, say N.
190
191config PSTORE_BLK_BLKDEV
192	string "block device identifier"
193	depends on PSTORE_BLK
194	default ""
195	help
196	  Which block device should be used for pstore/blk.
197
198	  It accepts the following variants:
199	  1) <hex_major><hex_minor> device number in hexadecimal representation,
200	     with no leading 0x, for example b302.
201	  2) /dev/<disk_name> represents the device name of disk
202	  3) /dev/<disk_name><decimal> represents the device name and number
203	     of partition - device number of disk plus the partition number
204	  4) /dev/<disk_name>p<decimal> - same as the above, this form is
205	     used when disk name of partitioned disk ends with a digit.
206	  5) PARTUUID=00112233-4455-6677-8899-AABBCCDDEEFF representing the
207	     unique id of a partition if the partition table provides it.
208	     The UUID may be either an EFI/GPT UUID, or refer to an MSDOS
209	     partition using the format SSSSSSSS-PP, where SSSSSSSS is a zero-
210	     filled hex representation of the 32-bit "NT disk signature", and PP
211	     is a zero-filled hex representation of the 1-based partition number.
212	  6) PARTUUID=<UUID>/PARTNROFF=<int> to select a partition in relation
213	     to a partition with a known unique id.
214	  7) <major>:<minor> major and minor number of the device separated by
215	     a colon.
216
217	  NOTE that, both Kconfig and module parameters can configure
218	  pstore/blk, but module parameters have priority over Kconfig.
219
220config PSTORE_BLK_KMSG_SIZE
221	int "Size in Kbytes of kmsg dump log to store"
222	depends on PSTORE_BLK
223	default 64
224	help
225	  This just sets size of kmsg dump (oops, panic, etc) log for
226	  pstore/blk. The size is in KB and must be a multiple of 4.
227
228	  NOTE that, both Kconfig and module parameters can configure
229	  pstore/blk, but module parameters have priority over Kconfig.
230
231config PSTORE_BLK_MAX_REASON
232	int "Maximum kmsg dump reason to store"
233	depends on PSTORE_BLK
234	default 2
235	help
236	  The maximum reason for kmsg dumps to store. The default is
237	  2 (KMSG_DUMP_OOPS), see include/linux/kmsg_dump.h's
238	  enum kmsg_dump_reason for more details.
239
240	  NOTE that, both Kconfig and module parameters can configure
241	  pstore/blk, but module parameters have priority over Kconfig.
242
243config PSTORE_BLK_PMSG_SIZE
244	int "Size in Kbytes of pmsg to store"
245	depends on PSTORE_BLK
246	depends on PSTORE_PMSG
247	default 64
248	help
249	  This just sets size of pmsg (pmsg_size) for pstore/blk. The size is
250	  in KB and must be a multiple of 4.
251
252	  NOTE that, both Kconfig and module parameters can configure
253	  pstore/blk, but module parameters have priority over Kconfig.
254
255config PSTORE_BLK_CONSOLE_SIZE
256	int "Size in Kbytes of console log to store"
257	depends on PSTORE_BLK
258	depends on PSTORE_CONSOLE
259	default 64
260	help
261	  This just sets size of console log (console_size) to store via
262	  pstore/blk. The size is in KB and must be a multiple of 4.
263
264	  NOTE that, both Kconfig and module parameters can configure
265	  pstore/blk, but module parameters have priority over Kconfig.
266
267config PSTORE_BLK_FTRACE_SIZE
268	int "Size in Kbytes of ftrace log to store"
269	depends on PSTORE_BLK
270	depends on PSTORE_FTRACE
271	default 64
272	help
273	  This just sets size of ftrace log (ftrace_size) for pstore/blk. The
274	  size is in KB and must be a multiple of 4.
275
276	  NOTE that, both Kconfig and module parameters can configure
277	  pstore/blk, but module parameters have priority over Kconfig.
278
279config PSTORE_BLK_BLACKBOX_SIZE
280	int "Size in Kbytes of fault log for BlackBox to store"
281	depends on PSTORE_BLK
282	depends on PSTORE_BLACKBOX
283	default 64
284	help
285	  This just sets size of fault log (blackbox_size) for pstore/blk.
286	  The size is in KB and must be a multiple of 4.
287
288	  NOTE that, both Kconfig and module parameters can configure
289	  pstore/blk, but module parameters have priority over Kconfig.
290
291config PSTORE_BLACKBOX_STACK_SIZE
292	int "Default stack size for BlackBox" if EXPERT
293	depends on PSTORE
294	depends on PSTORE_BLACKBOX
295	default 1024
296	help
297	  Defines default size of pstore stack size for blackbox.
298	  Can be enlarged if needed. not recommended to shrink it.
299