2 menuconfig MTD_RAW_NAND
3 bool "Raw NAND Device Support"
6 config SYS_NAND_SELF_INIT
9 This option, if enabled, provides more flexible and linux-like
10 NAND initialization process.
12 config SPL_SYS_NAND_SELF_INIT
14 depends on !SPL_NAND_SIMPLE
16 This option, if enabled, provides more flexible and linux-like
17 NAND initialization process, in SPL.
19 config TPL_SYS_NAND_SELF_INIT
21 depends on TPL_NAND_SUPPORT
23 This option, if enabled, provides more flexible and linux-like
24 NAND initialization process, in SPL.
26 config SYS_NAND_DRIVER_ECC_LAYOUT
27 bool "Omit standard ECC layouts to save space"
29 Omit standard ECC layouts to save space. Select this if your driver
30 is known to provide its own ECC layout.
32 config SYS_NAND_USE_FLASH_BBT
33 bool "Enable BBT (Bad Block Table) support"
35 Enable the BBT (Bad Block Table) usage.
38 bool "Support Atmel NAND controller"
39 select SYS_NAND_SELF_INIT
40 imply SYS_NAND_USE_FLASH_BBT
42 Enable this driver for NAND flash platforms using an Atmel NAND
47 config ATMEL_NAND_HWECC
48 bool "Atmel Hardware ECC"
50 config ATMEL_NAND_HW_PMECC
51 bool "Atmel Programmable Multibit ECC (PMECC)"
52 select ATMEL_NAND_HWECC
54 The Programmable Multibit ECC (PMECC) controller is a programmable
55 binary BCH(Bose, Chaudhuri and Hocquenghem) encoder and decoder.
58 int "PMECC Correctable ECC Bits"
59 depends on ATMEL_NAND_HW_PMECC
62 Correctable ECC bits, can be 2, 4, 8, 12, and 24.
64 config PMECC_SECTOR_SIZE
65 int "PMECC Sector Size"
66 depends on ATMEL_NAND_HW_PMECC
69 Sector size, in bytes, can be 512 or 1024.
71 config SPL_GENERATE_ATMEL_PMECC_HEADER
72 bool "Atmel PMECC Header Generation"
73 select ATMEL_NAND_HWECC
74 select ATMEL_NAND_HW_PMECC
76 Generate Programmable Multibit ECC (PMECC) header for SPL image.
81 bool "Support Broadcom NAND controller"
82 depends on OF_CONTROL && DM && DM_MTD
83 select SYS_NAND_SELF_INIT
85 Enable the driver for NAND flash on platforms using a Broadcom NAND
88 config NAND_BRCMNAND_6368
89 bool "Support Broadcom NAND controller on bcm6368"
90 depends on NAND_BRCMNAND && ARCH_BMIPS
92 Enable support for broadcom nand driver on bcm6368.
94 config NAND_BRCMNAND_68360
95 bool "Support Broadcom NAND controller on bcm68360"
96 depends on NAND_BRCMNAND && ARCH_BCM68360
98 Enable support for broadcom nand driver on bcm68360.
100 config NAND_BRCMNAND_6838
101 bool "Support Broadcom NAND controller on bcm6838"
102 depends on NAND_BRCMNAND && ARCH_BMIPS && SOC_BMIPS_BCM6838
104 Enable support for broadcom nand driver on bcm6838.
106 config NAND_BRCMNAND_6858
107 bool "Support Broadcom NAND controller on bcm6858"
108 depends on NAND_BRCMNAND && ARCH_BCM6858
110 Enable support for broadcom nand driver on bcm6858.
112 config NAND_BRCMNAND_63158
113 bool "Support Broadcom NAND controller on bcm63158"
114 depends on NAND_BRCMNAND && ARCH_BCM63158
116 Enable support for broadcom nand driver on bcm63158.
119 bool "Support TI Davinci NAND controller"
120 select SYS_NAND_SELF_INIT if TARGET_DA850EVM
122 Enable this driver for NAND flash controllers available in TI Davinci
123 and Keystone2 platforms
125 config KEYSTONE_RBL_NAND
126 depends on ARCH_KEYSTONE
131 depends on NAND_DAVINCI && ARCH_DAVINCI && SPL_NAND_SUPPORT
135 select SYS_NAND_SELF_INIT
138 config NAND_DENALI_DT
139 bool "Support Denali NAND controller as a DT device"
141 depends on OF_CONTROL && DM_MTD
143 Enable the driver for NAND flash on platforms using a Denali NAND
144 controller as a DT device.
147 bool "Support Freescale Enhanced Local Bus Controller FCM NAND driver"
148 select TPL_SYS_NAND_SELF_INIT if TPL_NAND_SUPPORT
149 select SPL_SYS_NAND_SELF_INIT
150 select SYS_NAND_SELF_INIT
153 Enable the Freescale Enhanced Local Bus Controller FCM NAND driver.
156 bool "Support Freescale Integrated Flash Controller NAND driver"
157 select TPL_SYS_NAND_SELF_INIT if TPL_NAND_SUPPORT
158 select SPL_SYS_NAND_SELF_INIT
159 select SYS_NAND_SELF_INIT
162 Enable the Freescale Integrated Flash Controller NAND driver.
164 config NAND_LPC32XX_MLC
165 bool "Support LPC32XX_MLC controller"
166 select SYS_NAND_SELF_INIT
168 Enable the LPC32XX MLC NAND controller.
170 config NAND_LPC32XX_SLC
171 bool "Support LPC32XX_SLC controller"
173 Enable the LPC32XX SLC NAND controller.
175 config NAND_OMAP_GPMC
176 bool "Support OMAP GPMC NAND controller"
177 depends on ARCH_OMAP2PLUS
179 Enables omap_gpmc.c driver for OMAPx and AMxxxx platforms.
180 GPMC controller is used for parallel NAND flash devices, and can
181 do ECC calculation (not ECC error detection) for HAM1, BCH4, BCH8
182 and BCH16 ECC algorithms.
186 config NAND_OMAP_GPMC_PREFETCH
187 bool "Enable GPMC Prefetch"
190 On OMAP platforms that use the GPMC controller
191 (CONFIG_NAND_OMAP_GPMC_PREFETCH), this options enables the code that
192 uses the prefetch mode to speed up read operations.
195 bool "Enable ELM driver for OMAPxx and AMxx platforms."
198 ELM controller is used for ECC error detection (not ECC calculation)
199 of BCH4, BCH8 and BCH16 ECC algorithms.
200 Some legacy platforms like OMAP3xx do not have in-built ELM h/w engine,
201 thus such SoC platforms need to depend on software library for ECC error
202 detection. However ECC calculation on such plaforms would still be
203 done by GPMC controller.
207 default NAND_OMAP_ECCSCHEME_BCH8_CODE_HW
209 On OMAP platforms, this CONFIG specifies NAND ECC scheme.
210 It can take following values:
211 OMAP_ECC_HAM1_CODE_SW
212 1-bit Hamming code using software lib.
213 (for legacy devices only)
214 OMAP_ECC_HAM1_CODE_HW
215 1-bit Hamming code using GPMC hardware.
216 (for legacy devices only)
217 OMAP_ECC_BCH4_CODE_HW_DETECTION_SW
218 4-bit BCH code (unsupported)
219 OMAP_ECC_BCH4_CODE_HW
220 4-bit BCH code (unsupported)
221 OMAP_ECC_BCH8_CODE_HW_DETECTION_SW
223 - ecc calculation using GPMC hardware engine,
224 - error detection using software library.
225 - requires CONFIG_BCH to enable software BCH library
226 (For legacy device which do not have ELM h/w engine)
227 OMAP_ECC_BCH8_CODE_HW
229 - ecc calculation using GPMC hardware engine,
230 - error detection using ELM hardware engine.
231 OMAP_ECC_BCH16_CODE_HW
233 - ecc calculation using GPMC hardware engine,
234 - error detection using ELM hardware engine.
236 How to select ECC scheme on OMAP and AMxx platforms ?
237 -----------------------------------------------------
238 Though higher ECC schemes have more capability to detect and correct
239 bit-flips, but still selection of ECC scheme is dependent on following
240 - hardware engines present in SoC.
241 Some legacy OMAP SoC do not have ELM h/w engine thus such
242 SoC cannot support BCHx_HW ECC schemes.
243 - size of OOB/Spare region
244 With higher ECC schemes, more OOB/Spare area is required to
245 store ECC. So choice of ECC scheme is limited by NAND oobsize.
247 In general following expression can help:
248 NAND_OOBSIZE >= 2 + (NAND_PAGESIZE / 512) * ECC_BYTES
250 NAND_OOBSIZE = number of bytes available in
251 OOB/spare area per NAND page.
252 NAND_PAGESIZE = bytes in main-area of NAND page.
253 ECC_BYTES = number of ECC bytes generated to
254 protect 512 bytes of data, which is:
255 3 for HAM1_xx ecc schemes
256 7 for BCH4_xx ecc schemes
257 14 for BCH8_xx ecc schemes
258 26 for BCH16_xx ecc schemes
260 example to check for BCH16 on 2K page NAND
263 2 + (2048 / 512) * 26 = 106 > NAND_OOBSIZE
264 Thus BCH16 cannot be supported on 2K page NAND.
266 However, for 4K pagesize NAND
270 2 + (4096 / 512) * 26 = 210 < NAND_OOBSIZE
271 Thus BCH16 can be supported on 4K page NAND.
273 config NAND_OMAP_ECCSCHEME_HAM1_CODE_SW
274 bool "1-bit Hamming code using software lib"
276 config NAND_OMAP_ECCSCHEME_HAM1_CODE_HW
277 bool "1-bit Hamming code using GPMC hardware"
279 config NAND_OMAP_ECCSCHEME_BCH8_CODE_HW_DETECTION_SW
280 bool "8-bit BCH code with HW calculation SW error detection"
282 config NAND_OMAP_ECCSCHEME_BCH8_CODE_HW
283 bool "8-bit BCH code with HW calculation and error detection"
285 config NAND_OMAP_ECCSCHEME_BCH16_CODE_HW
286 bool "16-bit BCH code with HW calculation and error detection"
290 config NAND_OMAP_ECCSCHEME
292 default 1 if NAND_OMAP_ECCSCHEME_HAM1_CODE_SW
293 default 2 if NAND_OMAP_ECCSCHEME_HAM1_CODE_HW
294 default 5 if NAND_OMAP_ECCSCHEME_BCH8_CODE_HW_DETECTION_SW
295 default 6 if NAND_OMAP_ECCSCHEME_BCH8_CODE_HW
296 default 7 if NAND_OMAP_ECCSCHEME_BCH16_CODE_HW
298 This must be kept in sync with the enum in
299 include/linux/mtd/omap_gpmc.h
303 config NAND_VF610_NFC
304 bool "Support for Freescale NFC for VF610"
305 select SYS_NAND_SELF_INIT
306 select SYS_NAND_DRIVER_ECC_LAYOUT
309 Enables support for NAND Flash Controller on some Freescale
310 processors like the VF610, MCF54418 or Kinetis K70.
311 The driver supports a maximum 2k page size. The driver
312 currently does not support hardware ECC.
316 config NAND_VF610_NFC_DT
317 bool "Support Vybrid's vf610 NAND controller as a DT device"
318 depends on OF_CONTROL && DM_MTD
320 Enable the driver for Vybrid's vf610 NAND flash on platforms
324 prompt "Hardware ECC strength"
325 depends on NAND_VF610_NFC
326 default SYS_NAND_VF610_NFC_45_ECC_BYTES
328 Select the ECC strength used in the hardware BCH ECC block.
330 config SYS_NAND_VF610_NFC_45_ECC_BYTES
331 bool "24-error correction (45 ECC bytes)"
333 config SYS_NAND_VF610_NFC_60_ECC_BYTES
334 bool "32-error correction (60 ECC bytes)"
341 bool "Support for NAND on PXA3xx and Armada 370/XP/38x"
342 select SYS_NAND_SELF_INIT
348 This enables the driver for the NAND flash device found on
349 PXA3xx processors (NFCv1) and also on Armada 370/XP (NFCv2).
352 bool "Support for NAND on Allwinner SoCs"
354 depends on MACH_SUN4I || MACH_SUN5I || MACH_SUN7I || MACH_SUN8I
355 select SYS_NAND_SELF_INIT
356 select SYS_NAND_U_BOOT_LOCATIONS
357 select SPL_NAND_SUPPORT
358 select SPL_SYS_NAND_SELF_INIT
361 Enable support for NAND. This option enables the standard and
363 The SPL driver only supports reading from the NAND using DMA
368 config NAND_SUNXI_SPL_ECC_STRENGTH
369 int "Allwinner NAND SPL ECC Strength"
372 config NAND_SUNXI_SPL_ECC_SIZE
373 int "Allwinner NAND SPL ECC Step Size"
376 config NAND_SUNXI_SPL_USABLE_PAGE_SIZE
377 int "Allwinner NAND SPL Usable Page Size"
383 bool "Configure Arasan Nand"
384 select SYS_NAND_SELF_INIT
388 This enables Nand driver support for Arasan nand flash
389 controller. This uses the hardware ECC for read and
393 bool "MXC NAND support"
394 depends on CPU_ARM926EJS || CPU_ARM1136 || MX5
397 This enables the NAND driver for the NAND flash controller on the
398 i.MX27 / i.MX31 / i.MX5 processors.
401 bool "MXS NAND support"
402 depends on MX23 || MX28 || MX6 || MX7 || IMX8 || IMX8M
403 select SPL_SYS_NAND_SELF_INIT
404 select SYS_NAND_SELF_INIT
407 select APBH_DMA_BURST if ARCH_MX6 || ARCH_MX7 || ARCH_IMX8 || ARCH_IMX8M
408 select APBH_DMA_BURST8 if ARCH_MX6 || ARCH_MX7 || ARCH_IMX8 || ARCH_IMX8M
410 This enables NAND driver for the NAND flash controller on the
416 bool "Support MXS NAND controller as a DT device"
417 depends on OF_CONTROL && DM_MTD
419 Enable the driver for MXS NAND flash on platforms using
422 config NAND_MXS_USE_MINIMUM_ECC
423 bool "Use minimum ECC strength supported by the controller"
429 bool "Macronix raw NAND controller"
430 select SYS_NAND_SELF_INIT
432 This selects the Macronix raw NAND controller driver.
435 bool "Support for Zynq Nand controller"
436 select SPL_SYS_NAND_SELF_INIT
437 select SYS_NAND_SELF_INIT
441 This enables Nand driver support for Nand flash controller
444 config NAND_ZYNQ_USE_BOOTLOADER1_TIMINGS
445 bool "Enable use of 1st stage bootloader timing for NAND"
448 This flag prevent U-boot reconfigure NAND flash controller and reuse
449 the NAND timing from 1st stage bootloader.
452 bool "Support for OcteonTX NAND controller"
453 select SYS_NAND_SELF_INIT
456 This enables Nand flash controller hardware found on the OcteonTX
459 config NAND_OCTEONTX_HW_ECC
460 bool "Support Hardware ECC for OcteonTX NAND controller"
461 depends on NAND_OCTEONTX
464 This enables Hardware BCH engine found on the OcteonTX processors to
465 support ECC for NAND flash controller.
467 config NAND_STM32_FMC2
468 bool "Support for NAND controller on STM32MP SoCs"
469 depends on ARCH_STM32MP
470 select SYS_NAND_SELF_INIT
473 Enables support for NAND Flash chips on SoCs containing the FMC2
474 NAND controller. This controller is found on STM32MP SoCs.
475 The controller supports a maximum 8k page size and supports
476 a maximum 8-bit correction error per sector of 512 bytes.
479 bool "Support for NAND controller on Cortina-Access SoCs"
480 depends on CORTINA_PLATFORM
481 select SYS_NAND_SELF_INIT
485 Enables support for NAND Flash chips on Coartina-Access SoCs platform
486 This controller is found on Presidio/Venus SoCs.
487 The controller supports a maximum 8k page size and supports
488 a maximum 40-bit error correction per sector of 1024 bytes.
491 bool "Support for NAND controller on Rockchip SoCs"
492 depends on ARCH_ROCKCHIP
493 select SYS_NAND_SELF_INIT
497 Enables support for NAND Flash chips on Rockchip SoCs platform.
498 This controller is found on Rockchip SoCs.
499 There are four different versions of NAND FLASH Controllers,
501 NFC v600: RK2928, RK3066, RK3188
502 NFC v622: RK3036, RK3128
503 NFC v800: RK3308, RV1108
504 NFC v900: PX30, RK3326
507 bool "Support for NAND controller on Tegra SoCs"
508 depends on ARCH_TEGRA
509 select SYS_NAND_SELF_INIT
512 Enables support for NAND Flash chips on Tegra SoCs platforms.
514 comment "Generic NAND options"
516 config SYS_NAND_BLOCK_SIZE
517 hex "NAND chip eraseblock size"
518 depends on ARCH_SUNXI || SPL_NAND_SUPPORT || TPL_NAND_SUPPORT
519 depends on !NAND_MXS && !NAND_DENALI_DT && !NAND_LPC32XX_MLC && !NAND_FSL_IFC
521 Number of data bytes in one eraseblock for the NAND chip on the
522 board. This is the multiple of NAND_PAGE_SIZE and the number of
525 config SYS_NAND_ONFI_DETECTION
526 bool "Enable detection of ONFI compliant devices during probe"
528 Enables detection of ONFI compliant devices during probe.
529 And fetching device parameters flashed on device, by parsing
532 config SYS_NAND_PAGE_COUNT
533 hex "NAND chip page count"
534 depends on SPL_NAND_SUPPORT && (NAND_ATMEL || NAND_MXC || \
535 SPL_NAND_AM33XX_BCH || SPL_NAND_LOAD || SPL_NAND_SIMPLE)
537 Number of pages in the NAND chip.
539 config SYS_NAND_PAGE_SIZE
540 hex "NAND chip page size"
541 depends on ARCH_SUNXI || NAND_OMAP_GPMC || NAND_LPC32XX_SLC || \
542 SPL_NAND_SIMPLE || (NAND_MXC && SPL_NAND_SUPPORT) || \
543 (NAND_ATMEL && SPL_NAND_SUPPORT) || SPL_GENERATE_ATMEL_PMECC_HEADER
544 depends on !NAND_MXS && !NAND_DENALI_DT && !NAND_LPC32XX_MLC
546 Number of data bytes in one page for the NAND chip on the
547 board, not including the OOB area.
549 config SYS_NAND_OOBSIZE
550 hex "NAND chip OOB size"
551 depends on ARCH_SUNXI || NAND_OMAP_GPMC || NAND_LPC32XX_SLC || \
552 SPL_NAND_SIMPLE || (NAND_MXC && SPL_NAND_SUPPORT) || \
553 (NAND_ATMEL && SPL_NAND_SUPPORT) || SPL_GENERATE_ATMEL_PMECC_HEADER
554 depends on !NAND_MXS && !NAND_DENALI_DT && !NAND_LPC32XX_MLC
556 Number of bytes in the Out-Of-Band area for the NAND chip on
559 # Enhance depends when converting drivers to Kconfig which use this config
560 # option (mxc_nand, ndfc, omap_gpmc).
561 config SYS_NAND_BUSWIDTH_16BIT
562 bool "Use 16-bit NAND interface"
563 depends on NAND_VF610_NFC || NAND_OMAP_GPMC || NAND_MXC || ARCH_DAVINCI
565 Indicates that NAND device has 16-bit wide data-bus. In absence of this
566 config, bus-width of NAND device is assumed to be either 8-bit and later
567 determined by reading ONFI params.
568 Above config is useful when NAND device's bus-width information cannot
569 be determined from on-chip ONFI params, like in following scenarios:
570 - SPL boot does not support reading of ONFI parameters. This is done to
571 keep SPL code foot-print small.
572 - In current U-Boot flow using nand_init(), driver initialization
573 happens in board_nand_init() which is called before any device probe
574 (nand_scan_ident + nand_scan_tail), thus device's ONFI parameters are
575 not available while configuring controller. So a static CONFIG_NAND_xx
576 is needed to know the device's bus-width in advance.
580 config SYS_NAND_5_ADDR_CYCLE
581 bool "Wait 5 address cycles during NAND commands"
582 depends on SPL_NAND_AM33XX_BCH || SPL_NAND_SIMPLE || \
583 (SPL_NAND_SUPPORT && NAND_ATMEL)
586 Some controllers require waiting for 5 address cycles when issuing
587 some commands, on NAND chips larger than 128MiB.
590 prompt "NAND bad block marker/indicator position in the OOB"
591 depends on SPL_NAND_AM33XX_BCH || SPL_NAND_DENALI || SPL_NAND_SIMPLE || \
592 SPL_NAND_SUPPORT && (NAND_ATMEL || NAND_MXC)
593 default HAS_NAND_LARGE_BADBLOCK_POS
595 In the OOB, which position contains the badblock information.
597 config HAS_NAND_LARGE_BADBLOCK_POS
598 bool "Set the bad block marker/indicator to the 'large' position"
600 config HAS_NAND_SMALL_BADBLOCK_POS
601 bool "Set the bad block marker/indicator to the 'small' position"
605 config SYS_NAND_BAD_BLOCK_POS
607 default 0 if HAS_NAND_LARGE_BADBLOCK_POS
608 default 5 if HAS_NAND_SMALL_BADBLOCK_POS
610 config SYS_NAND_U_BOOT_LOCATIONS
611 bool "Define U-boot binaries locations in NAND"
613 Enable CONFIG_SYS_NAND_U_BOOT_OFFS though Kconfig.
614 This option should not be enabled when compiling U-boot for boards
615 defining CONFIG_SYS_NAND_U_BOOT_OFFS in their include/configs/<board>.h
618 config SYS_NAND_U_BOOT_OFFS
619 hex "Location in NAND to read U-Boot from"
620 default 0x800000 if NAND_SUNXI
621 depends on SYS_NAND_U_BOOT_LOCATIONS
623 Set the offset from the start of the nand where u-boot should be
626 config SYS_NAND_U_BOOT_OFFS_REDUND
627 hex "Location in NAND to read U-Boot from"
628 default SYS_NAND_U_BOOT_OFFS
629 depends on SYS_NAND_U_BOOT_LOCATIONS
631 Set the offset from the start of the nand where the redundant u-boot
632 should be loaded from.
634 config SPL_NAND_AM33XX_BCH
635 bool "Enables SPL-NAND driver which supports ELM based"
636 depends on NAND_OMAP_GPMC && !OMAP34XX
639 Hardware ECC correction. This is useful for platforms which have ELM
640 hardware engine and use NAND boot mode.
641 Some legacy platforms like OMAP3xx do not have in-built ELM h/w engine,
642 so those platforms should use CONFIG_SPL_NAND_SIMPLE for enabling
643 SPL-NAND driver with software ECC correction support.
645 config SPL_NAND_DENALI
646 bool "Support Denali NAND controller for SPL"
648 This is a small implementation of the Denali NAND controller
651 config NAND_DENALI_SPARE_AREA_SKIP_BYTES
652 int "Number of bytes skipped in OOB area"
653 depends on SPL_NAND_DENALI
656 This option specifies the number of bytes to skip from the beginning
657 of OOB area before last ECC sector data starts. This is potentially
658 used to preserve the bad block marker in the OOB area.
660 config SPL_NAND_SIMPLE
661 bool "Use simple SPL NAND driver"
662 depends on !SPL_NAND_AM33XX_BCH
664 Support for NAND boot using simple NAND drivers that
665 expose the cmd_ctrl() interface.