blob: bb9994b8626c60db56fc07b11ace26eb23a4e345 [file] [log] [blame]
Miquel Raynal1f1ae152018-08-16 17:30:07 +02001
Miquel Raynald0935362019-10-03 19:50:03 +02002menuconfig MTD_RAW_NAND
Miquel Raynal8115c452018-08-16 17:30:08 +02003 bool "Raw NAND Device Support"
Miquel Raynald0935362019-10-03 19:50:03 +02004if MTD_RAW_NAND
Miquel Raynal1f1ae152018-08-16 17:30:07 +02005
6config SYS_NAND_SELF_INIT
7 bool
8 help
9 This option, if enabled, provides more flexible and linux-like
10 NAND initialization process.
11
Tom Rini98372452021-12-12 22:12:36 -050012config SPL_SYS_NAND_SELF_INIT
13 bool
14 depends on !SPL_NAND_SIMPLE
15 help
16 This option, if enabled, provides more flexible and linux-like
17 NAND initialization process, in SPL.
18
19config TPL_SYS_NAND_SELF_INIT
20 bool
21 depends on TPL_NAND_SUPPORT
22 help
23 This option, if enabled, provides more flexible and linux-like
24 NAND initialization process, in SPL.
25
Tom Rini1a9f23d2022-05-26 14:31:57 -040026config TPL_NAND_INIT
27 bool
28
Roger Quadros685c4282022-12-20 12:22:00 +020029config SPL_NAND_INIT
30 bool
31
Tom Riniac164de2022-10-28 20:27:04 -040032config SYS_MAX_NAND_DEVICE
33 int "Maximum number of NAND devices to support"
34 default 1
35
Stefan Agnerbd186142018-12-06 14:57:09 +010036config SYS_NAND_DRIVER_ECC_LAYOUT
Tom Rinid03e14e2021-12-11 14:55:54 -050037 bool "Omit standard ECC layouts to save space"
Stefan Agnerbd186142018-12-06 14:57:09 +010038 help
Tom Rinid03e14e2021-12-11 14:55:54 -050039 Omit standard ECC layouts to save space. Select this if your driver
Stefan Agnerbd186142018-12-06 14:57:09 +010040 is known to provide its own ECC layout.
41
Stefan Roese23b37f92019-08-22 12:28:04 +020042config SYS_NAND_USE_FLASH_BBT
43 bool "Enable BBT (Bad Block Table) support"
44 help
45 Enable the BBT (Bad Block Table) usage.
46
Tom Rini2b2696a2022-11-12 17:36:48 -050047config SYS_NAND_NO_SUBPAGE_WRITE
48 bool "Disable subpage write support"
49 depends on NAND_ARASAN || NAND_DAVINCI || NAND_KIRKWOOD
50
Balamanikandan Gunasundarfe33c7d2022-10-25 16:21:01 +053051config DM_NAND_ATMEL
52 bool "Support Atmel NAND controller with DM support"
53 select SYS_NAND_SELF_INIT
54 imply SYS_NAND_USE_FLASH_BBT
55 help
56 Enable this driver for NAND flash platforms using an Atmel NAND
57 controller.
58
Miquel Raynal1f1ae152018-08-16 17:30:07 +020059config NAND_ATMEL
60 bool "Support Atmel NAND controller"
Tom Rini98372452021-12-12 22:12:36 -050061 select SYS_NAND_SELF_INIT
Miquel Raynal1f1ae152018-08-16 17:30:07 +020062 imply SYS_NAND_USE_FLASH_BBT
63 help
64 Enable this driver for NAND flash platforms using an Atmel NAND
65 controller.
66
Derald D. Woods7830fc52018-12-15 01:36:46 -060067if NAND_ATMEL
68
69config ATMEL_NAND_HWECC
70 bool "Atmel Hardware ECC"
Derald D. Woods7830fc52018-12-15 01:36:46 -060071
72config ATMEL_NAND_HW_PMECC
73 bool "Atmel Programmable Multibit ECC (PMECC)"
74 select ATMEL_NAND_HWECC
Derald D. Woods7830fc52018-12-15 01:36:46 -060075 help
76 The Programmable Multibit ECC (PMECC) controller is a programmable
77 binary BCH(Bose, Chaudhuri and Hocquenghem) encoder and decoder.
78
79config PMECC_CAP
80 int "PMECC Correctable ECC Bits"
81 depends on ATMEL_NAND_HW_PMECC
82 default 2
83 help
84 Correctable ECC bits, can be 2, 4, 8, 12, and 24.
85
86config PMECC_SECTOR_SIZE
87 int "PMECC Sector Size"
88 depends on ATMEL_NAND_HW_PMECC
89 default 512
90 help
91 Sector size, in bytes, can be 512 or 1024.
92
93config SPL_GENERATE_ATMEL_PMECC_HEADER
94 bool "Atmel PMECC Header Generation"
Tom Rini0a83cc22022-06-10 23:03:09 -040095 depends on SPL
Derald D. Woods7830fc52018-12-15 01:36:46 -060096 select ATMEL_NAND_HWECC
97 select ATMEL_NAND_HW_PMECC
Derald D. Woods7830fc52018-12-15 01:36:46 -060098 help
99 Generate Programmable Multibit ECC (PMECC) header for SPL image.
100
Tom Rini70aa87d2022-11-12 17:36:42 -0500101choice
102 prompt "NAND bus width (bits)"
103 default SYS_NAND_DBW_8
104
105config SYS_NAND_DBW_8
106 bool "NAND bus width is 8 bits"
107
108config SYS_NAND_DBW_16
109 bool "NAND bus width is 16 bits"
110
111endchoice
112
Derald D. Woods7830fc52018-12-15 01:36:46 -0600113endif
114
Philippe Reynes5aa6cfb2019-03-15 15:14:36 +0100115config NAND_BRCMNAND
116 bool "Support Broadcom NAND controller"
Miquel Raynala903be42019-10-03 19:50:04 +0200117 depends on OF_CONTROL && DM && DM_MTD
Tom Rini98372452021-12-12 22:12:36 -0500118 select SYS_NAND_SELF_INIT
Philippe Reynes5aa6cfb2019-03-15 15:14:36 +0100119 help
120 Enable the driver for NAND flash on platforms using a Broadcom NAND
121 controller.
122
Álvaro Fernández Rojasd9f9bfc2019-08-28 19:12:15 +0200123config NAND_BRCMNAND_6368
124 bool "Support Broadcom NAND controller on bcm6368"
125 depends on NAND_BRCMNAND && ARCH_BMIPS
126 help
127 Enable support for broadcom nand driver on bcm6368.
128
Philippe Reynese175c322022-02-11 19:18:36 +0100129config NAND_BRCMNAND_6753
130 bool "Support Broadcom NAND controller on bcm6753"
William Zhang38921822022-08-22 11:49:08 -0700131 depends on NAND_BRCMNAND && BCM6855
Philippe Reynese175c322022-02-11 19:18:36 +0100132 help
133 Enable support for broadcom nand driver on bcm6753.
134
Philippe Reynes74ead742020-01-07 20:14:13 +0100135config NAND_BRCMNAND_68360
136 bool "Support Broadcom NAND controller on bcm68360"
William Zhangdf0b5bb2022-08-22 11:31:43 -0700137 depends on NAND_BRCMNAND && BCM6856
Philippe Reynes74ead742020-01-07 20:14:13 +0100138 help
139 Enable support for broadcom nand driver on bcm68360.
140
Philippe Reynes5aa6cfb2019-03-15 15:14:36 +0100141config NAND_BRCMNAND_6838
142 bool "Support Broadcom NAND controller on bcm6838"
143 depends on NAND_BRCMNAND && ARCH_BMIPS && SOC_BMIPS_BCM6838
144 help
145 Enable support for broadcom nand driver on bcm6838.
146
147config NAND_BRCMNAND_6858
148 bool "Support Broadcom NAND controller on bcm6858"
William Zhang6b45fa62022-08-22 11:39:45 -0700149 depends on NAND_BRCMNAND && BCM6858
Philippe Reynes5aa6cfb2019-03-15 15:14:36 +0100150 help
151 Enable support for broadcom nand driver on bcm6858.
152
153config NAND_BRCMNAND_63158
154 bool "Support Broadcom NAND controller on bcm63158"
William Zhang35a3ec1b2022-08-22 11:19:46 -0700155 depends on NAND_BRCMNAND && BCM63158
Philippe Reynes5aa6cfb2019-03-15 15:14:36 +0100156 help
157 Enable support for broadcom nand driver on bcm63158.
158
Linus Walleij2306c332023-03-08 22:42:31 +0100159config NAND_BRCMNAND_IPROC
160 bool "Support Broadcom NAND controller on the iproc family"
161 depends on NAND_BRCMNAND
162 help
163 Enable support for broadcom nand driver on the Broadcom
164 iproc family such as Northstar (BCM5301x, BCM4708...)
165
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200166config NAND_DAVINCI
167 bool "Support TI Davinci NAND controller"
Tom Rini98372452021-12-12 22:12:36 -0500168 select SYS_NAND_SELF_INIT if TARGET_DA850EVM
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200169 help
170 Enable this driver for NAND flash controllers available in TI Davinci
171 and Keystone2 platforms
172
Tom Rinid1286e12022-11-12 17:36:45 -0500173choice
174 prompt "Type of ECC used on NAND"
175 default SYS_NAND_4BIT_HW_ECC_OOBFIRST
176 depends on NAND_DAVINCI
177
178config SYS_NAND_HW_ECC
179 bool "Use 1-bit HW ECC"
180
Tom Rini7f750f82022-10-28 20:27:11 -0400181config SYS_NAND_4BIT_HW_ECC_OOBFIRST
182 bool "Use 4-bit HW ECC with OOB at the front"
Tom Rinid1286e12022-11-12 17:36:45 -0500183
184config SYS_NAND_SOFT_ECC
185 bool "Use software ECC"
186
187endchoice
Tom Rini7f750f82022-10-28 20:27:11 -0400188
Tom Rini33adefd2022-11-12 17:36:49 -0500189choice
190 prompt "NAND page size"
191 depends on NAND_DAVINCI
192 default SYS_NAND_PAGE_2K
193
194config SYS_NAND_PAGE_2K
195 bool "Page size is 2K"
196
197config SYS_NAND_PAGE_4K
198 bool "Page size is 4K"
199
200endchoice
201
Tom Rinidada0e32021-09-12 20:32:24 -0400202config KEYSTONE_RBL_NAND
203 depends on ARCH_KEYSTONE
204 def_bool y
205
Tom Rinifae1dab2021-09-22 14:50:29 -0400206config SPL_NAND_LOAD
207 def_bool y
208 depends on NAND_DAVINCI && ARCH_DAVINCI && SPL_NAND_SUPPORT
209
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200210config NAND_DENALI
211 bool
212 select SYS_NAND_SELF_INIT
213 imply CMD_NAND
214
215config NAND_DENALI_DT
216 bool "Support Denali NAND controller as a DT device"
217 select NAND_DENALI
Lokanathan, Raaj791edf72022-12-11 23:37:42 +0800218 select SPL_SYS_NAND_SELF_INIT
Masahiro Yamada8fc53822020-01-30 22:07:59 +0900219 depends on OF_CONTROL && DM_MTD
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200220 help
221 Enable the driver for NAND flash on platforms using a Denali NAND
222 controller as a DT device.
223
Tom Rinia73788c2021-09-22 14:50:37 -0400224config NAND_FSL_ELBC
225 bool "Support Freescale Enhanced Local Bus Controller FCM NAND driver"
Tom Rini98372452021-12-12 22:12:36 -0500226 select TPL_SYS_NAND_SELF_INIT if TPL_NAND_SUPPORT
227 select SPL_SYS_NAND_SELF_INIT
228 select SYS_NAND_SELF_INIT
Tom Rinia73788c2021-09-22 14:50:37 -0400229 depends on FSL_ELBC
230 help
231 Enable the Freescale Enhanced Local Bus Controller FCM NAND driver.
232
Pali Rohárbb834db2022-04-04 18:17:19 +0200233config NAND_FSL_ELBC_DT
234 bool "Support Freescale Enhanced Local Bus Controller FCM NAND driver (DT mode)"
235 depends on NAND_FSL_ELBC
236
Tom Rinia73788c2021-09-22 14:50:37 -0400237config NAND_FSL_IFC
238 bool "Support Freescale Integrated Flash Controller NAND driver"
Tom Rini98372452021-12-12 22:12:36 -0500239 select TPL_SYS_NAND_SELF_INIT if TPL_NAND_SUPPORT
Tom Rini1a9f23d2022-05-26 14:31:57 -0400240 select TPL_NAND_INIT if TPL && !TPL_FRAMEWORK
Tom Rini98372452021-12-12 22:12:36 -0500241 select SPL_SYS_NAND_SELF_INIT
242 select SYS_NAND_SELF_INIT
Tom Rini05b419e2021-12-11 14:55:49 -0500243 select FSL_IFC
Tom Rinia73788c2021-09-22 14:50:37 -0400244 help
245 Enable the Freescale Integrated Flash Controller NAND driver.
246
Tom Rinib91baf62022-11-19 18:45:29 -0500247config NAND_KIRKWOOD
248 bool "Support for Kirkwood NAND controller"
249 depends on ARCH_KIRKWOOD
250 default y
251
252config NAND_ECC_BCH
253 bool
254
255config NAND_KMETER1
256 bool "Support KMETER1 NAND controller"
257 depends on VENDOR_KM
258 select NAND_ECC_BCH
259
Tom Rini08204272021-09-22 14:50:28 -0400260config NAND_LPC32XX_MLC
261 bool "Support LPC32XX_MLC controller"
Tom Rini98372452021-12-12 22:12:36 -0500262 select SYS_NAND_SELF_INIT
Tom Rini08204272021-09-22 14:50:28 -0400263 help
264 Enable the LPC32XX MLC NAND controller.
265
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200266config NAND_LPC32XX_SLC
267 bool "Support LPC32XX_SLC controller"
268 help
269 Enable the LPC32XX SLC NAND controller.
270
271config NAND_OMAP_GPMC
272 bool "Support OMAP GPMC NAND controller"
Roger Quadros0bde4972022-10-11 14:50:00 +0300273 depends on ARCH_OMAP2PLUS || ARCH_KEYSTONE || ARCH_K3
Roger Quadros80cf6372022-12-20 12:21:59 +0200274 select SYS_NAND_SELF_INIT if ARCH_K3
Roger Quadros685c4282022-12-20 12:22:00 +0200275 select SPL_NAND_INIT if ARCH_K3
276 select SPL_SYS_NAND_SELF_INIT if ARCH_K3
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200277 help
278 Enables omap_gpmc.c driver for OMAPx and AMxxxx platforms.
279 GPMC controller is used for parallel NAND flash devices, and can
280 do ECC calculation (not ECC error detection) for HAM1, BCH4, BCH8
281 and BCH16 ECC algorithms.
282
Tom Rinif6d26d82021-09-22 14:50:39 -0400283if NAND_OMAP_GPMC
284
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200285config NAND_OMAP_GPMC_PREFETCH
286 bool "Enable GPMC Prefetch"
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200287 default y
288 help
289 On OMAP platforms that use the GPMC controller
290 (CONFIG_NAND_OMAP_GPMC_PREFETCH), this options enables the code that
291 uses the prefetch mode to speed up read operations.
292
293config NAND_OMAP_ELM
294 bool "Enable ELM driver for OMAPxx and AMxx platforms."
Tom Rinif6d26d82021-09-22 14:50:39 -0400295 depends on !OMAP34XX
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200296 help
297 ELM controller is used for ECC error detection (not ECC calculation)
298 of BCH4, BCH8 and BCH16 ECC algorithms.
299 Some legacy platforms like OMAP3xx do not have in-built ELM h/w engine,
300 thus such SoC platforms need to depend on software library for ECC error
301 detection. However ECC calculation on such plaforms would still be
302 done by GPMC controller.
303
Tom Rinif6d26d82021-09-22 14:50:39 -0400304choice
305 prompt "ECC scheme"
306 default NAND_OMAP_ECCSCHEME_BCH8_CODE_HW
307 help
308 On OMAP platforms, this CONFIG specifies NAND ECC scheme.
309 It can take following values:
310 OMAP_ECC_HAM1_CODE_SW
311 1-bit Hamming code using software lib.
312 (for legacy devices only)
313 OMAP_ECC_HAM1_CODE_HW
314 1-bit Hamming code using GPMC hardware.
315 (for legacy devices only)
316 OMAP_ECC_BCH4_CODE_HW_DETECTION_SW
317 4-bit BCH code (unsupported)
318 OMAP_ECC_BCH4_CODE_HW
319 4-bit BCH code (unsupported)
320 OMAP_ECC_BCH8_CODE_HW_DETECTION_SW
321 8-bit BCH code with
322 - ecc calculation using GPMC hardware engine,
323 - error detection using software library.
324 - requires CONFIG_BCH to enable software BCH library
325 (For legacy device which do not have ELM h/w engine)
326 OMAP_ECC_BCH8_CODE_HW
327 8-bit BCH code with
328 - ecc calculation using GPMC hardware engine,
329 - error detection using ELM hardware engine.
330 OMAP_ECC_BCH16_CODE_HW
331 16-bit BCH code with
332 - ecc calculation using GPMC hardware engine,
333 - error detection using ELM hardware engine.
334
335 How to select ECC scheme on OMAP and AMxx platforms ?
336 -----------------------------------------------------
337 Though higher ECC schemes have more capability to detect and correct
338 bit-flips, but still selection of ECC scheme is dependent on following
339 - hardware engines present in SoC.
340 Some legacy OMAP SoC do not have ELM h/w engine thus such
341 SoC cannot support BCHx_HW ECC schemes.
342 - size of OOB/Spare region
343 With higher ECC schemes, more OOB/Spare area is required to
344 store ECC. So choice of ECC scheme is limited by NAND oobsize.
345
346 In general following expression can help:
347 NAND_OOBSIZE >= 2 + (NAND_PAGESIZE / 512) * ECC_BYTES
348 where
349 NAND_OOBSIZE = number of bytes available in
350 OOB/spare area per NAND page.
351 NAND_PAGESIZE = bytes in main-area of NAND page.
352 ECC_BYTES = number of ECC bytes generated to
353 protect 512 bytes of data, which is:
354 3 for HAM1_xx ecc schemes
355 7 for BCH4_xx ecc schemes
356 14 for BCH8_xx ecc schemes
357 26 for BCH16_xx ecc schemes
358
359 example to check for BCH16 on 2K page NAND
360 NAND_PAGESIZE = 2048
361 NAND_OOBSIZE = 64
362 2 + (2048 / 512) * 26 = 106 > NAND_OOBSIZE
363 Thus BCH16 cannot be supported on 2K page NAND.
364
365 However, for 4K pagesize NAND
366 NAND_PAGESIZE = 4096
367 NAND_OOBSIZE = 224
368 ECC_BYTES = 26
369 2 + (4096 / 512) * 26 = 210 < NAND_OOBSIZE
370 Thus BCH16 can be supported on 4K page NAND.
371
372config NAND_OMAP_ECCSCHEME_HAM1_CODE_SW
373 bool "1-bit Hamming code using software lib"
374
375config NAND_OMAP_ECCSCHEME_HAM1_CODE_HW
376 bool "1-bit Hamming code using GPMC hardware"
377
378config NAND_OMAP_ECCSCHEME_BCH8_CODE_HW_DETECTION_SW
379 bool "8-bit BCH code with HW calculation SW error detection"
380
381config NAND_OMAP_ECCSCHEME_BCH8_CODE_HW
382 bool "8-bit BCH code with HW calculation and error detection"
383
384config NAND_OMAP_ECCSCHEME_BCH16_CODE_HW
385 bool "16-bit BCH code with HW calculation and error detection"
386
387endchoice
388
389config NAND_OMAP_ECCSCHEME
390 int
391 default 1 if NAND_OMAP_ECCSCHEME_HAM1_CODE_SW
392 default 2 if NAND_OMAP_ECCSCHEME_HAM1_CODE_HW
393 default 5 if NAND_OMAP_ECCSCHEME_BCH8_CODE_HW_DETECTION_SW
394 default 6 if NAND_OMAP_ECCSCHEME_BCH8_CODE_HW
395 default 7 if NAND_OMAP_ECCSCHEME_BCH16_CODE_HW
396 help
397 This must be kept in sync with the enum in
398 include/linux/mtd/omap_gpmc.h
399
400endif
401
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200402config NAND_VF610_NFC
403 bool "Support for Freescale NFC for VF610"
404 select SYS_NAND_SELF_INIT
Stefan Agnerbd186142018-12-06 14:57:09 +0100405 select SYS_NAND_DRIVER_ECC_LAYOUT
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200406 imply CMD_NAND
407 help
408 Enables support for NAND Flash Controller on some Freescale
409 processors like the VF610, MCF54418 or Kinetis K70.
410 The driver supports a maximum 2k page size. The driver
411 currently does not support hardware ECC.
412
Lukasz Majewskif006cb32018-12-03 10:24:50 +0100413if NAND_VF610_NFC
414
415config NAND_VF610_NFC_DT
416 bool "Support Vybrid's vf610 NAND controller as a DT device"
Miquel Raynala903be42019-10-03 19:50:04 +0200417 depends on OF_CONTROL && DM_MTD
Lukasz Majewskif006cb32018-12-03 10:24:50 +0100418 help
419 Enable the driver for Vybrid's vf610 NAND flash on platforms
420 using device tree.
421
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200422choice
423 prompt "Hardware ECC strength"
424 depends on NAND_VF610_NFC
425 default SYS_NAND_VF610_NFC_45_ECC_BYTES
426 help
427 Select the ECC strength used in the hardware BCH ECC block.
428
429config SYS_NAND_VF610_NFC_45_ECC_BYTES
430 bool "24-error correction (45 ECC bytes)"
431
432config SYS_NAND_VF610_NFC_60_ECC_BYTES
433 bool "32-error correction (60 ECC bytes)"
434
435endchoice
436
Lukasz Majewskif006cb32018-12-03 10:24:50 +0100437endif
438
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200439config NAND_PXA3XX
440 bool "Support for NAND on PXA3xx and Armada 370/XP/38x"
441 select SYS_NAND_SELF_INIT
Shmuel Hazan759349e2020-10-29 08:52:18 +0200442 select DM_MTD
Shmuel Hazan58983222020-10-29 08:52:20 +0200443 select REGMAP
444 select SYSCON
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200445 imply CMD_NAND
446 help
447 This enables the driver for the NAND flash device found on
448 PXA3xx processors (NFCv1) and also on Armada 370/XP (NFCv2).
449
Sean Anderson326422b2023-11-04 16:37:52 -0400450config NAND_SANDBOX
451 bool "Support for NAND in sandbox"
452 depends on SANDBOX
453 select SYS_NAND_SELF_INIT
Sean Anderson765dc6a2023-11-04 16:37:53 -0400454 select SPL_SYS_NAND_SELF_INIT
455 select SPL_NAND_INIT
Sean Anderson326422b2023-11-04 16:37:52 -0400456 select SYS_NAND_SOFT_ECC
457 select BCH
458 select NAND_ECC_BCH
459 imply CMD_NAND
460 help
461 Enable a dummy NAND driver for sandbox. It simulates any number of
462 arbitrary NAND chips with a RAM buffer. It will also inject errors to
463 test ECC. At the moment, only 8-bit busses and single-chip devices are
464 supported.
465
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200466config NAND_SUNXI
467 bool "Support for NAND on Allwinner SoCs"
468 default ARCH_SUNXI
469 depends on MACH_SUN4I || MACH_SUN5I || MACH_SUN7I || MACH_SUN8I
470 select SYS_NAND_SELF_INIT
471 select SYS_NAND_U_BOOT_LOCATIONS
472 select SPL_NAND_SUPPORT
Tom Rini98372452021-12-12 22:12:36 -0500473 select SPL_SYS_NAND_SELF_INIT
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200474 imply CMD_NAND
475 ---help---
476 Enable support for NAND. This option enables the standard and
477 SPL drivers.
478 The SPL driver only supports reading from the NAND using DMA
479 transfers.
480
481if NAND_SUNXI
482
483config NAND_SUNXI_SPL_ECC_STRENGTH
484 int "Allwinner NAND SPL ECC Strength"
485 default 64
486
487config NAND_SUNXI_SPL_ECC_SIZE
488 int "Allwinner NAND SPL ECC Step Size"
489 default 1024
490
491config NAND_SUNXI_SPL_USABLE_PAGE_SIZE
492 int "Allwinner NAND SPL Usable Page Size"
493 default 1024
494
495endif
496
497config NAND_ARASAN
498 bool "Configure Arasan Nand"
499 select SYS_NAND_SELF_INIT
Michal Simekc5587832020-08-19 09:59:52 +0200500 depends on DM_MTD
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200501 imply CMD_NAND
502 help
503 This enables Nand driver support for Arasan nand flash
504 controller. This uses the hardware ECC for read and
505 write operations.
506
507config NAND_MXC
508 bool "MXC NAND support"
509 depends on CPU_ARM926EJS || CPU_ARM1136 || MX5
510 imply CMD_NAND
511 help
512 This enables the NAND driver for the NAND flash controller on the
Haolin Lie8df55b2021-07-18 10:13:39 +0800513 i.MX27 / i.MX31 / i.MX5 processors.
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200514
Tom Rini1ba2a002022-11-12 17:36:50 -0500515config SYS_NAND_SIZE
516 int "Size of NAND in kilobytes"
517 depends on NAND_MXC && SPL_NAND_SUPPORT
518 default 268435456
519
Tom Rini17e67002022-12-02 16:42:37 -0500520config MXC_NAND_HWECC
521 bool "Hardware ECC support in MXC NAND"
522 depends on NAND_MXC
523
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200524config NAND_MXS
525 bool "MXS NAND support"
Peng Fan128abf42020-05-04 22:09:00 +0800526 depends on MX23 || MX28 || MX6 || MX7 || IMX8 || IMX8M
Tom Rini98372452021-12-12 22:12:36 -0500527 select SPL_SYS_NAND_SELF_INIT
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200528 select SYS_NAND_SELF_INIT
529 imply CMD_NAND
530 select APBH_DMA
Peng Fan128abf42020-05-04 22:09:00 +0800531 select APBH_DMA_BURST if ARCH_MX6 || ARCH_MX7 || ARCH_IMX8 || ARCH_IMX8M
532 select APBH_DMA_BURST8 if ARCH_MX6 || ARCH_MX7 || ARCH_IMX8 || ARCH_IMX8M
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200533 help
534 This enables NAND driver for the NAND flash controller on the
535 MXS processors.
536
537if NAND_MXS
538
539config NAND_MXS_DT
540 bool "Support MXS NAND controller as a DT device"
Miquel Raynala903be42019-10-03 19:50:04 +0200541 depends on OF_CONTROL && DM_MTD
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200542 help
543 Enable the driver for MXS NAND flash on platforms using
544 device tree.
545
546config NAND_MXS_USE_MINIMUM_ECC
547 bool "Use minimum ECC strength supported by the controller"
548 default false
549
550endif
551
Zhengxun Li01551712021-09-14 13:43:51 +0800552config NAND_MXIC
553 bool "Macronix raw NAND controller"
554 select SYS_NAND_SELF_INIT
555 help
556 This selects the Macronix raw NAND controller driver.
557
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200558config NAND_ZYNQ
559 bool "Support for Zynq Nand controller"
Tom Rini98372452021-12-12 22:12:36 -0500560 select SPL_SYS_NAND_SELF_INIT
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200561 select SYS_NAND_SELF_INIT
Ashok Reddy Somabb8448a2019-12-27 04:47:12 -0700562 select DM_MTD
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200563 imply CMD_NAND
564 help
565 This enables Nand driver support for Nand flash controller
566 found on Zynq SoC.
567
568config NAND_ZYNQ_USE_BOOTLOADER1_TIMINGS
569 bool "Enable use of 1st stage bootloader timing for NAND"
570 depends on NAND_ZYNQ
571 help
Michal Simek50fa1182023-05-17 09:17:16 +0200572 This flag prevent U-Boot reconfigure NAND flash controller and reuse
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200573 the NAND timing from 1st stage bootloader.
574
Suneel Garapati9de7d2b2020-08-26 14:37:22 +0200575config NAND_OCTEONTX
576 bool "Support for OcteonTX NAND controller"
577 select SYS_NAND_SELF_INIT
578 imply CMD_NAND
579 help
580 This enables Nand flash controller hardware found on the OcteonTX
581 processors.
582
583config NAND_OCTEONTX_HW_ECC
584 bool "Support Hardware ECC for OcteonTX NAND controller"
585 depends on NAND_OCTEONTX
586 default y
587 help
588 This enables Hardware BCH engine found on the OcteonTX processors to
589 support ECC for NAND flash controller.
590
Christophe Kerelloda141682019-04-05 11:41:50 +0200591config NAND_STM32_FMC2
592 bool "Support for NAND controller on STM32MP SoCs"
593 depends on ARCH_STM32MP
594 select SYS_NAND_SELF_INIT
595 imply CMD_NAND
596 help
597 Enables support for NAND Flash chips on SoCs containing the FMC2
598 NAND controller. This controller is found on STM32MP SoCs.
599 The controller supports a maximum 8k page size and supports
600 a maximum 8-bit correction error per sector of 512 bytes.
601
Kate Liu41ccd2e2020-12-11 13:46:12 -0800602config CORTINA_NAND
603 bool "Support for NAND controller on Cortina-Access SoCs"
604 depends on CORTINA_PLATFORM
605 select SYS_NAND_SELF_INIT
606 select DM_MTD
607 imply CMD_NAND
608 help
609 Enables support for NAND Flash chips on Coartina-Access SoCs platform
610 This controller is found on Presidio/Venus SoCs.
611 The controller supports a maximum 8k page size and supports
612 a maximum 40-bit error correction per sector of 1024 bytes.
613
Yifeng Zhao9e9021e2021-06-07 16:40:29 +0800614config ROCKCHIP_NAND
615 bool "Support for NAND controller on Rockchip SoCs"
616 depends on ARCH_ROCKCHIP
617 select SYS_NAND_SELF_INIT
618 select DM_MTD
619 imply CMD_NAND
620 help
621 Enables support for NAND Flash chips on Rockchip SoCs platform.
622 This controller is found on Rockchip SoCs.
623 There are four different versions of NAND FLASH Controllers,
624 including:
625 NFC v600: RK2928, RK3066, RK3188
626 NFC v622: RK3036, RK3128
627 NFC v800: RK3308, RV1108
628 NFC v900: PX30, RK3326
629
Johan Jonker904e0f02023-10-18 16:00:27 +0200630config ROCKCHIP_NAND_SKIP_BBTSCAN
631 bool "Skip the automatic BBT scan with Rockchip NAND controllers"
632 depends on ROCKCHIP_NAND
Johan Jonker904e0f02023-10-18 16:00:27 +0200633 help
634 Skip the automatic BBT scan with the NAND_SKIP_BBTSCAN
635 option when data content is not in MTD format or
636 must remain unchanged.
637
Tom Rini8f37ac42021-12-12 22:12:35 -0500638config TEGRA_NAND
639 bool "Support for NAND controller on Tegra SoCs"
640 depends on ARCH_TEGRA
641 select SYS_NAND_SELF_INIT
642 imply CMD_NAND
643 help
644 Enables support for NAND Flash chips on Tegra SoCs platforms.
645
developer10a61df2022-05-20 11:23:47 +0800646config NAND_MT7621
647 bool "Support for MediaTek MT7621 NAND flash controller"
648 depends on SOC_MT7621
649 select SYS_NAND_SELF_INIT
650 select SPL_SYS_NAND_SELF_INIT
651 imply CMD_NAND
652 help
653 This enables NAND driver for the NAND flash controller on MediaTek
654 MT7621 platform.
655 The controller supports 4~12 bits correction per 512 bytes with a
656 maximum 4KB page size.
657
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200658comment "Generic NAND options"
659
660config SYS_NAND_BLOCK_SIZE
661 hex "NAND chip eraseblock size"
Pali Rohár5c5cf602023-01-10 22:55:21 +0100662 depends on ARCH_SUNXI || SPL_NAND_SUPPORT || TPL_NAND_SUPPORT || \
663 MVEBU_SPL_BOOT_DEVICE_NAND
developer10a61df2022-05-20 11:23:47 +0800664 depends on !NAND_MXS && !NAND_DENALI_DT && !NAND_LPC32XX_MLC && \
665 !NAND_FSL_IFC && !NAND_MT7621
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200666 help
667 Number of data bytes in one eraseblock for the NAND chip on the
668 board. This is the multiple of NAND_PAGE_SIZE and the number of
669 pages.
670
Tom Rinifdae0072021-09-22 14:50:34 -0400671config SYS_NAND_ONFI_DETECTION
672 bool "Enable detection of ONFI compliant devices during probe"
673 help
674 Enables detection of ONFI compliant devices during probe.
675 And fetching device parameters flashed on device, by parsing
676 ONFI parameter page.
677
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200678config SYS_NAND_PAGE_SIZE
679 hex "NAND chip page size"
Tom Rinifae1dab2021-09-22 14:50:29 -0400680 depends on ARCH_SUNXI || NAND_OMAP_GPMC || NAND_LPC32XX_SLC || \
681 SPL_NAND_SIMPLE || (NAND_MXC && SPL_NAND_SUPPORT) || \
Pali Rohár5c5cf602023-01-10 22:55:21 +0100682 MVEBU_SPL_BOOT_DEVICE_NAND || \
Sean Anderson765dc6a2023-11-04 16:37:53 -0400683 (NAND_ATMEL && SPL_NAND_SUPPORT) || \
684 SPL_GENERATE_ATMEL_PMECC_HEADER || NAND_SANDBOX
developer10a61df2022-05-20 11:23:47 +0800685 depends on !NAND_MXS && !NAND_DENALI_DT && !NAND_LPC32XX_MLC && !NAND_MT7621
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200686 help
687 Number of data bytes in one page for the NAND chip on the
688 board, not including the OOB area.
689
690config SYS_NAND_OOBSIZE
691 hex "NAND chip OOB size"
Tom Rinifae1dab2021-09-22 14:50:29 -0400692 depends on ARCH_SUNXI || NAND_OMAP_GPMC || NAND_LPC32XX_SLC || \
693 SPL_NAND_SIMPLE || (NAND_MXC && SPL_NAND_SUPPORT) || \
694 (NAND_ATMEL && SPL_NAND_SUPPORT) || SPL_GENERATE_ATMEL_PMECC_HEADER
Tom Rinid24700f2021-10-30 23:03:56 -0400695 depends on !NAND_MXS && !NAND_DENALI_DT && !NAND_LPC32XX_MLC
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200696 help
697 Number of bytes in the Out-Of-Band area for the NAND chip on
698 the board.
699
700# Enhance depends when converting drivers to Kconfig which use this config
701# option (mxc_nand, ndfc, omap_gpmc).
702config SYS_NAND_BUSWIDTH_16BIT
703 bool "Use 16-bit NAND interface"
704 depends on NAND_VF610_NFC || NAND_OMAP_GPMC || NAND_MXC || ARCH_DAVINCI
705 help
706 Indicates that NAND device has 16-bit wide data-bus. In absence of this
707 config, bus-width of NAND device is assumed to be either 8-bit and later
708 determined by reading ONFI params.
709 Above config is useful when NAND device's bus-width information cannot
710 be determined from on-chip ONFI params, like in following scenarios:
711 - SPL boot does not support reading of ONFI parameters. This is done to
712 keep SPL code foot-print small.
713 - In current U-Boot flow using nand_init(), driver initialization
714 happens in board_nand_init() which is called before any device probe
715 (nand_scan_ident + nand_scan_tail), thus device's ONFI parameters are
716 not available while configuring controller. So a static CONFIG_NAND_xx
717 is needed to know the device's bus-width in advance.
718
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200719if SPL
720
Tom Rini8e6d9c72021-09-22 14:50:33 -0400721config SYS_NAND_5_ADDR_CYCLE
722 bool "Wait 5 address cycles during NAND commands"
723 depends on SPL_NAND_AM33XX_BCH || SPL_NAND_SIMPLE || \
724 (SPL_NAND_SUPPORT && NAND_ATMEL)
725 default y
726 help
727 Some controllers require waiting for 5 address cycles when issuing
728 some commands, on NAND chips larger than 128MiB.
729
Tom Rinia2fbd4a2021-09-22 14:50:32 -0400730choice
Tom Rinifdae0072021-09-22 14:50:34 -0400731 prompt "NAND bad block marker/indicator position in the OOB"
Tom Rinia2fbd4a2021-09-22 14:50:32 -0400732 depends on SPL_NAND_AM33XX_BCH || SPL_NAND_DENALI || SPL_NAND_SIMPLE || \
733 SPL_NAND_SUPPORT && (NAND_ATMEL || NAND_MXC)
734 default HAS_NAND_LARGE_BADBLOCK_POS
735 help
736 In the OOB, which position contains the badblock information.
737
738config HAS_NAND_LARGE_BADBLOCK_POS
739 bool "Set the bad block marker/indicator to the 'large' position"
740
741config HAS_NAND_SMALL_BADBLOCK_POS
742 bool "Set the bad block marker/indicator to the 'small' position"
743
744endchoice
745
746config SYS_NAND_BAD_BLOCK_POS
747 int
748 default 0 if HAS_NAND_LARGE_BADBLOCK_POS
749 default 5 if HAS_NAND_SMALL_BADBLOCK_POS
750
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200751config SYS_NAND_U_BOOT_LOCATIONS
Michal Simek50fa1182023-05-17 09:17:16 +0200752 bool "Define U-Boot binaries locations in NAND"
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200753 help
754 Enable CONFIG_SYS_NAND_U_BOOT_OFFS though Kconfig.
Michal Simek50fa1182023-05-17 09:17:16 +0200755 This option should not be enabled when compiling U-Boot for boards
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200756 defining CONFIG_SYS_NAND_U_BOOT_OFFS in their include/configs/<board>.h
757 file.
758
759config SYS_NAND_U_BOOT_OFFS
760 hex "Location in NAND to read U-Boot from"
761 default 0x800000 if NAND_SUNXI
762 depends on SYS_NAND_U_BOOT_LOCATIONS
763 help
764 Set the offset from the start of the nand where u-boot should be
765 loaded from.
766
767config SYS_NAND_U_BOOT_OFFS_REDUND
768 hex "Location in NAND to read U-Boot from"
769 default SYS_NAND_U_BOOT_OFFS
770 depends on SYS_NAND_U_BOOT_LOCATIONS
771 help
772 Set the offset from the start of the nand where the redundant u-boot
773 should be loaded from.
774
775config SPL_NAND_AM33XX_BCH
776 bool "Enables SPL-NAND driver which supports ELM based"
Tom Rini0a83cc22022-06-10 23:03:09 -0400777 depends on SPL_NAND_SUPPORT && NAND_OMAP_GPMC && !OMAP34XX
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200778 default y
779 help
780 Hardware ECC correction. This is useful for platforms which have ELM
781 hardware engine and use NAND boot mode.
782 Some legacy platforms like OMAP3xx do not have in-built ELM h/w engine,
783 so those platforms should use CONFIG_SPL_NAND_SIMPLE for enabling
784 SPL-NAND driver with software ECC correction support.
785
786config SPL_NAND_DENALI
787 bool "Support Denali NAND controller for SPL"
Tom Rini0a83cc22022-06-10 23:03:09 -0400788 depends on SPL_NAND_SUPPORT
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200789 help
790 This is a small implementation of the Denali NAND controller
791 for use on SPL.
792
Masahiro Yamada64648cb2020-04-17 16:51:42 +0900793config NAND_DENALI_SPARE_AREA_SKIP_BYTES
794 int "Number of bytes skipped in OOB area"
795 depends on SPL_NAND_DENALI
796 range 0 63
797 help
798 This option specifies the number of bytes to skip from the beginning
799 of OOB area before last ECC sector data starts. This is potentially
800 used to preserve the bad block marker in the OOB area.
801
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200802config SPL_NAND_SIMPLE
803 bool "Use simple SPL NAND driver"
Tom Rini0a83cc22022-06-10 23:03:09 -0400804 depends on !SPL_NAND_AM33XX_BCH && SPL_NAND_SUPPORT
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200805 help
806 Support for NAND boot using simple NAND drivers that
807 expose the cmd_ctrl() interface.
Tom Rini4251f7d2022-11-12 17:36:44 -0500808
809config SYS_NAND_HW_ECC_OOBFIRST
810 bool "In SPL, read the OOB first and then the data from NAND"
811 depends on SPL_NAND_SIMPLE
812
Miquel Raynal1f1ae152018-08-16 17:30:07 +0200813endif
814
815endif # if NAND