[mirror_ubuntu-jammy-kernel.git] / fs / cramfs / Kconfig

config CRAMFS
	tristate "Compressed ROM file system support (cramfs)"
	select ZLIB_INFLATE
	help
	  Saying Y here includes support for CramFs (Compressed ROM File
	  System).  CramFs is designed to be a simple, small, and compressed
	  file system for ROM based embedded systems.  CramFs is read-only,
	  limited to 256MB file systems (with 16MB files), and doesn't support
	  16/32 bits uid/gid, hard links and timestamps.

	  See <file:Documentation/filesystems/cramfs.txt> and
	  <file:fs/cramfs/README> for further information.

	  To compile this as a module, choose M here: the module will be called
	  cramfs.  Note that the root file system (the one containing the
	  directory /) cannot be compiled as a module.

	  This filesystem is limited in capabilities and performance on
	  purpose to remain small and low on RAM usage. It is most suitable
	  for small embedded systems. If you have ample RAM to spare, you may
	  consider a more capable compressed filesystem such as SquashFS
	  which is much better in terms of performance and features.

	  If unsure, say N.

config CRAMFS_BLOCKDEV
	bool "Support CramFs image over a regular block device" if EXPERT
	depends on CRAMFS && BLOCK
	default y
	help
	  This option allows the CramFs driver to load data from a regular
	  block device such a disk partition or a ramdisk.

config CRAMFS_MTD
	bool "Support CramFs image directly mapped in physical memory"
	depends on CRAMFS && MTD
	depends on CRAMFS=m || MTD=y
	default y if !CRAMFS_BLOCKDEV
	help
	  This option allows the CramFs driver to load data directly from
	  a linear adressed memory range (usually non volatile memory
	  like flash) instead of going through the block device layer.
	  This saves some memory since no intermediate buffering is
	  necessary.

	  The location of the CramFs image is determined by a
	  MTD device capable of direct memory mapping e.g. from
	  the 'physmap' map driver or a resulting MTD partition.
	  For example, this would mount the cramfs image stored in
	  the MTD partition named "xip_fs" on the /mnt mountpoint:

	  mount -t cramfs mtd:xip_fs /mnt

	  If unsure, say N.
Commit	Line	Data
2a22783b	1	config CRAMFS
8d59598c	2	tristate "Compressed ROM file system support (cramfs)"
2a22783b AD	3	select ZLIB_INFLATE
	4	help
	5	Saying Y here includes support for CramFs (Compressed ROM File
	6	System). CramFs is designed to be a simple, small, and compressed
	7	file system for ROM based embedded systems. CramFs is read-only,
	8	limited to 256MB file systems (with 16MB files), and doesn't support
	9	16/32 bits uid/gid, hard links and timestamps.
	10
	11	See <file:Documentation/filesystems/cramfs.txt> and
	12	<file:fs/cramfs/README> for further information.
	13
	14	To compile this as a module, choose M here: the module will be called
	15	cramfs. Note that the root file system (the one containing the
	16	directory /) cannot be compiled as a module.
	17
8d59598c NP	18	This filesystem is limited in capabilities and performance on
	19	purpose to remain small and low on RAM usage. It is most suitable
	20	for small embedded systems. If you have ample RAM to spare, you may
	21	consider a more capable compressed filesystem such as SquashFS
	22	which is much better in terms of performance and features.
54886a71	23
2a22783b	24	If unsure, say N.
99c18ce5 NP	25
	26	config CRAMFS_BLOCKDEV
	27	bool "Support CramFs image over a regular block device" if EXPERT
	28	depends on CRAMFS && BLOCK
	29	default y
	30	help
	31	This option allows the CramFs driver to load data from a regular
	32	block device such a disk partition or a ramdisk.
	33
	34	config CRAMFS_MTD
	35	bool "Support CramFs image directly mapped in physical memory"
	36	depends on CRAMFS && MTD
b9f5fb18	37	depends on CRAMFS=m \|\| MTD=y
99c18ce5 NP	38	default y if !CRAMFS_BLOCKDEV
	39	help
	40	This option allows the CramFs driver to load data directly from
	41	a linear adressed memory range (usually non volatile memory
	42	like flash) instead of going through the block device layer.
	43	This saves some memory since no intermediate buffering is
	44	necessary.
	45
	46	The location of the CramFs image is determined by a
	47	MTD device capable of direct memory mapping e.g. from
	48	the 'physmap' map driver or a resulting MTD partition.
	49	For example, this would mount the cramfs image stored in
	50	the MTD partition named "xip_fs" on the /mnt mountpoint:
	51
	52	mount -t cramfs mtd:xip_fs /mnt
	53
	54	If unsure, say N.