xref: /openbmc/linux/drivers/mtd/Kconfig (revision 8cb5d748)
1menuconfig MTD
2	tristate "Memory Technology Device (MTD) support"
3	depends on GENERIC_IO
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_REDBOOT_PARTS
27	tristate "RedBoot partition table parsing"
28	---help---
29	  RedBoot is a ROM monitor and bootloader which deals with multiple
30	  'images' in flash devices by putting a table one of the erase
31	  blocks on the device, similar to a partition table, which gives
32	  the offsets, lengths and names of all the images stored in the
33	  flash.
34
35	  If you need code which can detect and parse this table, and register
36	  MTD 'partitions' corresponding to each image in the table, enable
37	  this option.
38
39	  You will still need the parsing functions to be called by the driver
40	  for your particular device. It won't happen automatically. The
41	  SA1100 map driver (CONFIG_MTD_SA1100) has an option for this, for
42	  example.
43
44if MTD_REDBOOT_PARTS
45
46config MTD_REDBOOT_DIRECTORY_BLOCK
47	int "Location of RedBoot partition table"
48	default "-1"
49	---help---
50	  This option is the Linux counterpart to the
51	  CYGNUM_REDBOOT_FIS_DIRECTORY_BLOCK RedBoot compile time
52	  option.
53
54	  The option specifies which Flash sectors holds the RedBoot
55	  partition table.  A zero or positive value gives an absolute
56	  erase block number. A negative value specifies a number of
57	  sectors before the end of the device.
58
59	  For example "2" means block number 2, "-1" means the last
60	  block and "-2" means the penultimate block.
61
62config MTD_REDBOOT_PARTS_UNALLOCATED
63	bool "Include unallocated flash regions"
64	help
65	  If you need to register each unallocated flash region as a MTD
66	  'partition', enable this option.
67
68config MTD_REDBOOT_PARTS_READONLY
69	bool "Force read-only for RedBoot system images"
70	help
71	  If you need to force read-only for 'RedBoot', 'RedBoot Config' and
72	  'FIS directory' images, enable this option.
73
74endif # MTD_REDBOOT_PARTS
75
76config MTD_CMDLINE_PARTS
77	tristate "Command line partition table parsing"
78	depends on MTD
79	---help---
80	  Allow generic configuration of the MTD partition tables via the kernel
81	  command line. Multiple flash resources are supported for hardware where
82	  different kinds of flash memory are available.
83
84	  You will still need the parsing functions to be called by the driver
85	  for your particular device. It won't happen automatically. The
86	  SA1100 map driver (CONFIG_MTD_SA1100) has an option for this, for
87	  example.
88
89	  The format for the command line is as follows:
90
91	  mtdparts=<mtddef>[;<mtddef]
92	  <mtddef>  := <mtd-id>:<partdef>[,<partdef>]
93	  <partdef> := <size>[@offset][<name>][ro]
94	  <mtd-id>  := unique id used in mapping driver/device
95	  <size>    := standard linux memsize OR "-" to denote all
96	  remaining space
97	  <name>    := (NAME)
98
99	  Due to the way Linux handles the command line, no spaces are
100	  allowed in the partition definition, including mtd id's and partition
101	  names.
102
103	  Examples:
104
105	  1 flash resource (mtd-id "sa1100"), with 1 single writable partition:
106	  mtdparts=sa1100:-
107
108	  Same flash, but 2 named partitions, the first one being read-only:
109	  mtdparts=sa1100:256k(ARMboot)ro,-(root)
110
111	  If unsure, say 'N'.
112
113config MTD_AFS_PARTS
114	tristate "ARM Firmware Suite partition parsing"
115	depends on (ARM || ARM64)
116	---help---
117	  The ARM Firmware Suite allows the user to divide flash devices into
118	  multiple 'images'. Each such image has a header containing its name
119	  and offset/size etc.
120
121	  If you need code which can detect and parse these tables, and
122	  register MTD 'partitions' corresponding to each image detected,
123	  enable this option.
124
125	  You will still need the parsing functions to be called by the driver
126	  for your particular device. It won't happen automatically. The
127	  'physmap' map driver (CONFIG_MTD_PHYSMAP) does this, for example.
128
129config MTD_OF_PARTS
130	tristate "OpenFirmware partitioning information support"
131	default y
132	depends on OF
133	help
134	  This provides a partition parsing function which derives
135	  the partition map from the children of the flash node,
136	  as described in Documentation/devicetree/bindings/mtd/partition.txt.
137
138config MTD_AR7_PARTS
139	tristate "TI AR7 partitioning support"
140	---help---
141	  TI AR7 partitioning support
142
143config MTD_BCM63XX_PARTS
144	tristate "BCM63XX CFE partitioning support"
145	depends on BCM63XX || BMIPS_GENERIC || COMPILE_TEST
146	select CRC32
147	help
148	  This provides partions parsing for BCM63xx devices with CFE
149	  bootloaders.
150
151config MTD_BCM47XX_PARTS
152	tristate "BCM47XX partitioning support"
153	depends on BCM47XX || ARCH_BCM_5301X
154	help
155	  This provides partitions parser for devices based on BCM47xx
156	  boards.
157
158menu "Partition parsers"
159source "drivers/mtd/parsers/Kconfig"
160endmenu
161
162comment "User Modules And Translation Layers"
163
164#
165# MTD block device support is select'ed if needed
166#
167config MTD_BLKDEVS
168	tristate
169
170config MTD_BLOCK
171	tristate "Caching block device access to MTD devices"
172	depends on BLOCK
173	select MTD_BLKDEVS
174	---help---
175	  Although most flash chips have an erase size too large to be useful
176	  as block devices, it is possible to use MTD devices which are based
177	  on RAM chips in this manner. This block device is a user of MTD
178	  devices performing that function.
179
180	  At the moment, it is also required for the Journalling Flash File
181	  System(s) to obtain a handle on the MTD device when it's mounted
182	  (although JFFS and JFFS2 don't actually use any of the functionality
183	  of the mtdblock device).
184
185	  Later, it may be extended to perform read/erase/modify/write cycles
186	  on flash chips to emulate a smaller block size. Needless to say,
187	  this is very unsafe, but could be useful for file systems which are
188	  almost never written to.
189
190	  You do not need this option for use with the DiskOnChip devices. For
191	  those, enable NFTL support (CONFIG_NFTL) instead.
192
193config MTD_BLOCK_RO
194	tristate "Readonly block device access to MTD devices"
195	depends on MTD_BLOCK!=y && BLOCK
196	select MTD_BLKDEVS
197	help
198	  This allows you to mount read-only file systems (such as cramfs)
199	  from an MTD device, without the overhead (and danger) of the caching
200	  driver.
201
202	  You do not need this option for use with the DiskOnChip devices. For
203	  those, enable NFTL support (CONFIG_NFTL) instead.
204
205config FTL
206	tristate "FTL (Flash Translation Layer) support"
207	depends on BLOCK
208	select MTD_BLKDEVS
209	---help---
210	  This provides support for the original Flash Translation Layer which
211	  is part of the PCMCIA specification. It uses a kind of pseudo-
212	  file system on a flash device to emulate a block device with
213	  512-byte sectors, on top of which you put a 'normal' file system.
214
215	  You may find that the algorithms used in this code are patented
216	  unless you live in the Free World where software patents aren't
217	  legal - in the USA you are only permitted to use this on PCMCIA
218	  hardware, although under the terms of the GPL you're obviously
219	  permitted to copy, modify and distribute the code as you wish. Just
220	  not use it.
221
222config NFTL
223	tristate "NFTL (NAND Flash Translation Layer) support"
224	depends on BLOCK
225	select MTD_BLKDEVS
226	---help---
227	  This provides support for the NAND Flash Translation Layer which is
228	  used on M-Systems' DiskOnChip devices. It uses a kind of pseudo-
229	  file system on a flash device to emulate a block device with
230	  512-byte sectors, on top of which you put a 'normal' file system.
231
232	  You may find that the algorithms used in this code are patented
233	  unless you live in the Free World where software patents aren't
234	  legal - in the USA you are only permitted to use this on DiskOnChip
235	  hardware, although under the terms of the GPL you're obviously
236	  permitted to copy, modify and distribute the code as you wish. Just
237	  not use it.
238
239config NFTL_RW
240	bool "Write support for NFTL"
241	depends on NFTL
242	help
243	  Support for writing to the NAND Flash Translation Layer, as used
244	  on the DiskOnChip.
245
246config INFTL
247	tristate "INFTL (Inverse NAND Flash Translation Layer) support"
248	depends on BLOCK
249	select MTD_BLKDEVS
250	---help---
251	  This provides support for the Inverse NAND Flash Translation
252	  Layer which is used on M-Systems' newer DiskOnChip devices. It
253	  uses a kind of pseudo-file system on a flash device to emulate
254	  a block device with 512-byte sectors, on top of which you put
255	  a 'normal' file system.
256
257	  You may find that the algorithms used in this code are patented
258	  unless you live in the Free World where software patents aren't
259	  legal - in the USA you are only permitted to use this on DiskOnChip
260	  hardware, although under the terms of the GPL you're obviously
261	  permitted to copy, modify and distribute the code as you wish. Just
262	  not use it.
263
264config RFD_FTL
265        tristate "Resident Flash Disk (Flash Translation Layer) support"
266	depends on BLOCK
267	select MTD_BLKDEVS
268	---help---
269	  This provides support for the flash translation layer known
270	  as the Resident Flash Disk (RFD), as used by the Embedded BIOS
271	  of General Software. There is a blurb at:
272
273		http://www.gensw.com/pages/prod/bios/rfd.htm
274
275config SSFDC
276	tristate "NAND SSFDC (SmartMedia) read only translation layer"
277	depends on BLOCK
278	select MTD_BLKDEVS
279	help
280	  This enables read only access to SmartMedia formatted NAND
281	  flash. You can mount it with FAT file system.
282
283
284config SM_FTL
285	tristate "SmartMedia/xD new translation layer"
286	depends on BLOCK
287	select MTD_BLKDEVS
288	select MTD_NAND_ECC
289	help
290	  This enables EXPERIMENTAL R/W support for SmartMedia/xD
291	  FTL (Flash translation layer).
292	  Write support is only lightly tested, therefore this driver
293	  isn't recommended to use with valuable data (anyway if you have
294	  valuable data, do backups regardless of software/hardware you
295	  use, because you never know what will eat your data...)
296	  If you only need R/O access, you can use older R/O driver
297	  (CONFIG_SSFDC)
298
299config MTD_OOPS
300	tristate "Log panic/oops to an MTD buffer"
301	help
302	  This enables panic and oops messages to be logged to a circular
303	  buffer in a flash partition where it can be read back at some
304	  later point.
305
306config MTD_SWAP
307	tristate "Swap on MTD device support"
308	depends on MTD && SWAP
309	select MTD_BLKDEVS
310	help
311	  Provides volatile block device driver on top of mtd partition
312          suitable for swapping.  The mapping of written blocks is not saved.
313	  The driver provides wear leveling by storing erase counter into the
314	  OOB.
315
316config MTD_PARTITIONED_MASTER
317	bool "Retain master device when partitioned"
318	default n
319	depends on MTD
320	help
321	  For historical reasons, by default, either a master is present or
322	  several partitions are present, but not both. The concern was that
323	  data listed in multiple partitions was dangerous; however, SCSI does
324	  this and it is frequently useful for applications. This config option
325	  leaves the master in even if the device is partitioned. It also makes
326	  the parent of the partition device be the master device, rather than
327	  what lies behind the master.
328
329source "drivers/mtd/chips/Kconfig"
330
331source "drivers/mtd/maps/Kconfig"
332
333source "drivers/mtd/devices/Kconfig"
334
335source "drivers/mtd/nand/Kconfig"
336
337source "drivers/mtd/onenand/Kconfig"
338
339source "drivers/mtd/lpddr/Kconfig"
340
341source "drivers/mtd/spi-nor/Kconfig"
342
343source "drivers/mtd/ubi/Kconfig"
344
345endif # MTD
346