xref: /linux-6.15/drivers/mtd/Kconfig (revision 5a4a335a)
1menuconfig MTD
2	tristate "Memory Technology Device (MTD) support"
3	imply NVMEM
4	help
5	  Memory Technology Devices are flash, RAM and similar chips, often
6	  used for solid state file systems on embedded devices. This option
7	  will provide the generic support for MTD drivers to register
8	  themselves with the kernel and for potential users of MTD devices
9	  to enumerate the devices which are present and obtain a handle on
10	  them. It will also allow you to select individual drivers for
11	  particular hardware and users of MTD devices. If unsure, say N.
12
13if MTD
14
15config MTD_TESTS
16	tristate "MTD tests support (DANGEROUS)"
17	depends on m
18	help
19	  This option includes various MTD tests into compilation. The tests
20	  should normally be compiled as kernel modules. The modules perform
21	  various checks and verifications when loaded.
22
23	  WARNING: some of the tests will ERASE entire MTD device which they
24	  test. Do not use these tests unless you really know what you do.
25
26config MTD_CMDLINE_PARTS
27	tristate "Command line partition table parsing"
28	depends on MTD
29	help
30	  Allow generic configuration of the MTD partition tables via the kernel
31	  command line. Multiple flash resources are supported for hardware where
32	  different kinds of flash memory are available.
33
34	  You will still need the parsing functions to be called by the driver
35	  for your particular device. It won't happen automatically. The
36	  SA1100 map driver (CONFIG_MTD_SA1100) has an option for this, for
37	  example.
38
39	  The format for the command line is as follows:
40
41	  mtdparts=<mtddef>[;<mtddef]
42	  <mtddef>  := <mtd-id>:<partdef>[,<partdef>]
43	  <partdef> := <size>[@offset][<name>][ro]
44	  <mtd-id>  := unique id used in mapping driver/device
45	  <size>    := standard linux memsize OR "-" to denote all
46	  remaining space
47	  <name>    := (NAME)
48
49	  Due to the way Linux handles the command line, no spaces are
50	  allowed in the partition definition, including mtd id's and partition
51	  names.
52
53	  Examples:
54
55	  1 flash resource (mtd-id "sa1100"), with 1 single writable partition:
56	  mtdparts=sa1100:-
57
58	  Same flash, but 2 named partitions, the first one being read-only:
59	  mtdparts=sa1100:256k(ARMboot)ro,-(root)
60
61	  If unsure, say 'N'.
62
63config MTD_OF_PARTS
64	tristate "OpenFirmware partitioning information support"
65	default y
66	depends on OF
67	help
68	  This provides a partition parsing function which derives
69	  the partition map from the children of the flash node,
70	  as described in Documentation/devicetree/bindings/mtd/partition.txt.
71
72config MTD_BCM63XX_PARTS
73	tristate "BCM63XX CFE partitioning support"
74	depends on BCM63XX || BMIPS_GENERIC || COMPILE_TEST
75	select CRC32
76	select MTD_PARSER_IMAGETAG
77	help
78	  This provides partition parsing for BCM63xx devices with CFE
79	  bootloaders.
80
81config MTD_BCM47XX_PARTS
82	tristate "BCM47XX partitioning support"
83	depends on BCM47XX || ARCH_BCM_5301X
84	help
85	  This provides partitions parser for devices based on BCM47xx
86	  boards.
87
88menu "Partition parsers"
89source "drivers/mtd/parsers/Kconfig"
90endmenu
91
92comment "User Modules And Translation Layers"
93
94#
95# MTD block device support is select'ed if needed
96#
97config MTD_BLKDEVS
98	tristate
99
100config MTD_BLOCK
101	tristate "Caching block device access to MTD devices"
102	depends on BLOCK
103	select MTD_BLKDEVS
104	help
105	  Although most flash chips have an erase size too large to be useful
106	  as block devices, it is possible to use MTD devices which are based
107	  on RAM chips in this manner. This block device is a user of MTD
108	  devices performing that function.
109
110	  At the moment, it is also required for the Journalling Flash File
111	  System(s) to obtain a handle on the MTD device when it's mounted
112	  (although JFFS and JFFS2 don't actually use any of the functionality
113	  of the mtdblock device).
114
115	  Later, it may be extended to perform read/erase/modify/write cycles
116	  on flash chips to emulate a smaller block size. Needless to say,
117	  this is very unsafe, but could be useful for file systems which are
118	  almost never written to.
119
120	  You do not need this option for use with the DiskOnChip devices. For
121	  those, enable NFTL support (CONFIG_NFTL) instead.
122
123config MTD_BLOCK_RO
124	tristate "Readonly block device access to MTD devices"
125	depends on MTD_BLOCK!=y && BLOCK
126	select MTD_BLKDEVS
127	help
128	  This allows you to mount read-only file systems (such as cramfs)
129	  from an MTD device, without the overhead (and danger) of the caching
130	  driver.
131
132	  You do not need this option for use with the DiskOnChip devices. For
133	  those, enable NFTL support (CONFIG_NFTL) instead.
134
135config FTL
136	tristate "FTL (Flash Translation Layer) support"
137	depends on BLOCK
138	select MTD_BLKDEVS
139	help
140	  This provides support for the original Flash Translation Layer which
141	  is part of the PCMCIA specification. It uses a kind of pseudo-
142	  file system on a flash device to emulate a block device with
143	  512-byte sectors, on top of which you put a 'normal' file system.
144
145	  You may find that the algorithms used in this code are patented
146	  unless you live in the Free World where software patents aren't
147	  legal - in the USA you are only permitted to use this on PCMCIA
148	  hardware, although under the terms of the GPL you're obviously
149	  permitted to copy, modify and distribute the code as you wish. Just
150	  not use it.
151
152config NFTL
153	tristate "NFTL (NAND Flash Translation Layer) support"
154	depends on BLOCK
155	select MTD_BLKDEVS
156	help
157	  This provides support for the NAND Flash Translation Layer which is
158	  used on M-Systems' DiskOnChip devices. It uses a kind of pseudo-
159	  file system on a flash device to emulate a block device with
160	  512-byte sectors, on top of which you put a 'normal' file system.
161
162	  You may find that the algorithms used in this code are patented
163	  unless you live in the Free World where software patents aren't
164	  legal - in the USA you are only permitted to use this on DiskOnChip
165	  hardware, although under the terms of the GPL you're obviously
166	  permitted to copy, modify and distribute the code as you wish. Just
167	  not use it.
168
169config NFTL_RW
170	bool "Write support for NFTL"
171	depends on NFTL
172	help
173	  Support for writing to the NAND Flash Translation Layer, as used
174	  on the DiskOnChip.
175
176config INFTL
177	tristate "INFTL (Inverse NAND Flash Translation Layer) support"
178	depends on BLOCK
179	select MTD_BLKDEVS
180	help
181	  This provides support for the Inverse NAND Flash Translation
182	  Layer which is used on M-Systems' newer DiskOnChip devices. It
183	  uses a kind of pseudo-file system on a flash device to emulate
184	  a block device with 512-byte sectors, on top of which you put
185	  a 'normal' file system.
186
187	  You may find that the algorithms used in this code are patented
188	  unless you live in the Free World where software patents aren't
189	  legal - in the USA you are only permitted to use this on DiskOnChip
190	  hardware, although under the terms of the GPL you're obviously
191	  permitted to copy, modify and distribute the code as you wish. Just
192	  not use it.
193
194config RFD_FTL
195	tristate "Resident Flash Disk (Flash Translation Layer) support"
196	depends on BLOCK
197	select MTD_BLKDEVS
198	help
199	  This provides support for the flash translation layer known
200	  as the Resident Flash Disk (RFD), as used by the Embedded BIOS
201	  of General Software. There is a blurb at:
202
203		http://www.gensw.com/pages/prod/bios/rfd.htm
204
205config SSFDC
206	tristate "NAND SSFDC (SmartMedia) read only translation layer"
207	depends on BLOCK
208	select MTD_BLKDEVS
209	help
210	  This enables read only access to SmartMedia formatted NAND
211	  flash. You can mount it with FAT file system.
212
213config SM_FTL
214	tristate "SmartMedia/xD new translation layer"
215	depends on BLOCK
216	select MTD_BLKDEVS
217	select MTD_NAND_ECC_SW_HAMMING
218	help
219	  This enables EXPERIMENTAL R/W support for SmartMedia/xD
220	  FTL (Flash translation layer).
221	  Write support is only lightly tested, therefore this driver
222	  isn't recommended to use with valuable data (anyway if you have
223	  valuable data, do backups regardless of software/hardware you
224	  use, because you never know what will eat your data...)
225	  If you only need R/O access, you can use older R/O driver
226	  (CONFIG_SSFDC)
227
228config MTD_OOPS
229	tristate "Log panic/oops to an MTD buffer"
230	help
231	  This enables panic and oops messages to be logged to a circular
232	  buffer in a flash partition where it can be read back at some
233	  later point.
234
235config MTD_SWAP
236	tristate "Swap on MTD device support"
237	depends on MTD && SWAP
238	select MTD_BLKDEVS
239	help
240	  Provides volatile block device driver on top of mtd partition
241	  suitable for swapping.  The mapping of written blocks is not saved.
242	  The driver provides wear leveling by storing erase counter into the
243	  OOB.
244
245config MTD_PARTITIONED_MASTER
246	bool "Retain master device when partitioned"
247	default n
248	depends on MTD
249	help
250	  For historical reasons, by default, either a master is present or
251	  several partitions are present, but not both. The concern was that
252	  data listed in multiple partitions was dangerous; however, SCSI does
253	  this and it is frequently useful for applications. This config option
254	  leaves the master in even if the device is partitioned. It also makes
255	  the parent of the partition device be the master device, rather than
256	  what lies behind the master.
257
258source "drivers/mtd/chips/Kconfig"
259
260source "drivers/mtd/maps/Kconfig"
261
262source "drivers/mtd/devices/Kconfig"
263
264source "drivers/mtd/nand/Kconfig"
265
266source "drivers/mtd/lpddr/Kconfig"
267
268source "drivers/mtd/spi-nor/Kconfig"
269
270source "drivers/mtd/ubi/Kconfig"
271
272source "drivers/mtd/hyperbus/Kconfig"
273
274endif # MTD
275