[linux-block.git] / fs / pstore / Kconfig

# SPDX-License-Identifier: GPL-2.0-only
config PSTORE
	tristate "Persistent store support"
	select CRYPTO if PSTORE_COMPRESS
	default n
	help
	   This option enables generic access to platform level
	   persistent storage via "pstore" filesystem that can
	   be mounted as /dev/pstore.  Only useful if you have
	   a platform level driver that registers with pstore to
	   provide the data, so you probably should just go say "Y"
	   (or "M") to a platform specific persistent store driver
	   (e.g. ACPI_APEI on X86) which will select this for you.
	   If you don't have a platform persistent store driver,
	   say N.

config PSTORE_DEFAULT_KMSG_BYTES
	int "Default kernel log storage space" if EXPERT
	depends on PSTORE
	default "10240"
	help
	  Defines default size of pstore kernel log storage.
	  Can be enlarged if needed, not recommended to shrink it.

config PSTORE_DEFLATE_COMPRESS
	tristate "DEFLATE (ZLIB) compression"
	default y
	depends on PSTORE
	select CRYPTO_DEFLATE
	help
	  This option enables DEFLATE (also known as ZLIB) compression
	  algorithm support.

config PSTORE_LZO_COMPRESS
	tristate "LZO compression"
	depends on PSTORE
	select CRYPTO_LZO
	help
	  This option enables LZO compression algorithm support.

config PSTORE_LZ4_COMPRESS
	tristate "LZ4 compression"
	depends on PSTORE
	select CRYPTO_LZ4
	help
	  This option enables LZ4 compression algorithm support.

config PSTORE_LZ4HC_COMPRESS
	tristate "LZ4HC compression"
	depends on PSTORE
	select CRYPTO_LZ4HC
	help
	  This option enables LZ4HC (high compression) mode algorithm.

config PSTORE_842_COMPRESS
	bool "842 compression"
	depends on PSTORE
	select CRYPTO_842
	help
	  This option enables 842 compression algorithm support.

config PSTORE_ZSTD_COMPRESS
	bool "zstd compression"
	depends on PSTORE
	select CRYPTO_ZSTD
	help
	  This option enables zstd compression algorithm support.

config PSTORE_COMPRESS
	def_bool y
	depends on PSTORE
	depends on PSTORE_DEFLATE_COMPRESS || PSTORE_LZO_COMPRESS ||	\
		   PSTORE_LZ4_COMPRESS || PSTORE_LZ4HC_COMPRESS ||	\
		   PSTORE_842_COMPRESS || PSTORE_ZSTD_COMPRESS

choice
	prompt "Default pstore compression algorithm"
	depends on PSTORE_COMPRESS
	help
	  This option chooses the default active compression algorithm.
	  This change be changed at boot with "pstore.compress=..." on
	  the kernel command line.

	  Currently, pstore has support for 6 compression algorithms:
	  deflate, lzo, lz4, lz4hc, 842 and zstd.

	  The default compression algorithm is deflate.

	config PSTORE_DEFLATE_COMPRESS_DEFAULT
		bool "deflate" if PSTORE_DEFLATE_COMPRESS

	config PSTORE_LZO_COMPRESS_DEFAULT
		bool "lzo" if PSTORE_LZO_COMPRESS

	config PSTORE_LZ4_COMPRESS_DEFAULT
		bool "lz4" if PSTORE_LZ4_COMPRESS

	config PSTORE_LZ4HC_COMPRESS_DEFAULT
		bool "lz4hc" if PSTORE_LZ4HC_COMPRESS

	config PSTORE_842_COMPRESS_DEFAULT
		bool "842" if PSTORE_842_COMPRESS

	config PSTORE_ZSTD_COMPRESS_DEFAULT
		bool "zstd" if PSTORE_ZSTD_COMPRESS

endchoice

config PSTORE_COMPRESS_DEFAULT
	string
	depends on PSTORE_COMPRESS
	default "deflate" if PSTORE_DEFLATE_COMPRESS_DEFAULT
	default "lzo" if PSTORE_LZO_COMPRESS_DEFAULT
	default "lz4" if PSTORE_LZ4_COMPRESS_DEFAULT
	default "lz4hc" if PSTORE_LZ4HC_COMPRESS_DEFAULT
	default "842" if PSTORE_842_COMPRESS_DEFAULT
	default "zstd" if PSTORE_ZSTD_COMPRESS_DEFAULT

config PSTORE_CONSOLE
	bool "Log kernel console messages"
	depends on PSTORE
	help
	  When the option is enabled, pstore will log all kernel
	  messages, even if no oops or panic happened.

config PSTORE_PMSG
	bool "Log user space messages"
	depends on PSTORE
	help
	  When the option is enabled, pstore will export a character
	  interface /dev/pmsg0 to log user space messages. On reboot
	  data can be retrieved from /sys/fs/pstore/pmsg-ramoops-[ID].

	  If unsure, say N.

config PSTORE_FTRACE
	bool "Persistent function tracer"
	depends on PSTORE
	depends on FUNCTION_TRACER
	depends on DEBUG_FS
	help
	  With this option kernel traces function calls into a persistent
	  ram buffer that can be decoded and dumped after reboot through
	  pstore filesystem. It can be used to determine what function
	  was last called before a reset or panic.

	  If unsure, say N.

config PSTORE_RAM
	tristate "Log panic/oops to a RAM buffer"
	depends on PSTORE
	depends on HAS_IOMEM
	select REED_SOLOMON
	select REED_SOLOMON_ENC8
	select REED_SOLOMON_DEC8
	help
	  This enables panic and oops messages to be logged to a circular
	  buffer in RAM where it can be read back at some later point.

	  Note that for historical reasons, the module will be named
	  "ramoops.ko".

	  For more information, see Documentation/admin-guide/ramoops.rst.

config PSTORE_ZONE
	tristate
	depends on PSTORE
	help
	  The common layer for pstore/blk (and pstore/ram in the future)
	  to manage storage in zones.

config PSTORE_BLK
	tristate "Log panic/oops to a block device"
	depends on PSTORE
	depends on BLOCK
	select PSTORE_ZONE
	default n
	help
	  This enables panic and oops message to be logged to a block dev
	  where it can be read back at some later point.

	  For more information, see Documentation/admin-guide/pstore-blk.rst

	  If unsure, say N.

config PSTORE_BLK_BLKDEV
	string "block device identifier"
	depends on PSTORE_BLK
	default ""
	help
	  Which block device should be used for pstore/blk.

	  It accepts the following variants:
	  1) <hex_major><hex_minor> device number in hexadecimal representation,
	     with no leading 0x, for example b302.
	  2) /dev/<disk_name> represents the device name of disk
	  3) /dev/<disk_name><decimal> represents the device name and number
	     of partition - device number of disk plus the partition number
	  4) /dev/<disk_name>p<decimal> - same as the above, this form is
	     used when disk name of partitioned disk ends with a digit.
	  5) PARTUUID=00112233-4455-6677-8899-AABBCCDDEEFF representing the
	     unique id of a partition if the partition table provides it.
	     The UUID may be either an EFI/GPT UUID, or refer to an MSDOS
	     partition using the format SSSSSSSS-PP, where SSSSSSSS is a zero-
	     filled hex representation of the 32-bit "NT disk signature", and PP
	     is a zero-filled hex representation of the 1-based partition number.
	  6) PARTUUID=<UUID>/PARTNROFF=<int> to select a partition in relation
	     to a partition with a known unique id.
	  7) <major>:<minor> major and minor number of the device separated by
	     a colon.

	  NOTE that, both Kconfig and module parameters can configure
	  pstore/blk, but module parameters have priority over Kconfig.

config PSTORE_BLK_KMSG_SIZE
	int "Size in Kbytes of kmsg dump log to store"
	depends on PSTORE_BLK
	default 64
	help
	  This just sets size of kmsg dump (oops, panic, etc) log for
	  pstore/blk. The size is in KB and must be a multiple of 4.

	  NOTE that, both Kconfig and module parameters can configure
	  pstore/blk, but module parameters have priority over Kconfig.

config PSTORE_BLK_MAX_REASON
	int "Maximum kmsg dump reason to store"
	depends on PSTORE_BLK
	default 2
	help
	  The maximum reason for kmsg dumps to store. The default is
	  2 (KMSG_DUMP_OOPS), see include/linux/kmsg_dump.h's
	  enum kmsg_dump_reason for more details.

	  NOTE that, both Kconfig and module parameters can configure
	  pstore/blk, but module parameters have priority over Kconfig.

config PSTORE_BLK_PMSG_SIZE
	int "Size in Kbytes of pmsg to store"
	depends on PSTORE_BLK
	depends on PSTORE_PMSG
	default 64
	help
	  This just sets size of pmsg (pmsg_size) for pstore/blk. The size is
	  in KB and must be a multiple of 4.

	  NOTE that, both Kconfig and module parameters can configure
	  pstore/blk, but module parameters have priority over Kconfig.

config PSTORE_BLK_CONSOLE_SIZE
	int "Size in Kbytes of console log to store"
	depends on PSTORE_BLK
	depends on PSTORE_CONSOLE
	default 64
	help
	  This just sets size of console log (console_size) to store via
	  pstore/blk. The size is in KB and must be a multiple of 4.

	  NOTE that, both Kconfig and module parameters can configure
	  pstore/blk, but module parameters have priority over Kconfig.

config PSTORE_BLK_FTRACE_SIZE
	int "Size in Kbytes of ftrace log to store"
	depends on PSTORE_BLK
	depends on PSTORE_FTRACE
	default 64
	help
	  This just sets size of ftrace log (ftrace_size) for pstore/blk. The
	  size is in KB and must be a multiple of 4.

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