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.
29 config SYS_NAND_DRIVER_ECC_LAYOUT
30 bool "Omit standard ECC layouts to save space"
32 Omit standard ECC layouts to save space. Select this if your driver
33 is known to provide its own ECC layout.
35 config SYS_NAND_USE_FLASH_BBT
36 bool "Enable BBT (Bad Block Table) support"
38 Enable the BBT (Bad Block Table) usage.
41 bool "Support Atmel NAND controller"
42 select SYS_NAND_SELF_INIT
43 imply SYS_NAND_USE_FLASH_BBT
45 Enable this driver for NAND flash platforms using an Atmel NAND
50 config ATMEL_NAND_HWECC
51 bool "Atmel Hardware ECC"
53 config ATMEL_NAND_HW_PMECC
54 bool "Atmel Programmable Multibit ECC (PMECC)"
55 select ATMEL_NAND_HWECC
57 The Programmable Multibit ECC (PMECC) controller is a programmable
58 binary BCH(Bose, Chaudhuri and Hocquenghem) encoder and decoder.
61 int "PMECC Correctable ECC Bits"
62 depends on ATMEL_NAND_HW_PMECC
65 Correctable ECC bits, can be 2, 4, 8, 12, and 24.
67 config PMECC_SECTOR_SIZE
68 int "PMECC Sector Size"
69 depends on ATMEL_NAND_HW_PMECC
72 Sector size, in bytes, can be 512 or 1024.
74 config SPL_GENERATE_ATMEL_PMECC_HEADER
75 bool "Atmel PMECC Header Generation"
77 select ATMEL_NAND_HWECC
78 select ATMEL_NAND_HW_PMECC
80 Generate Programmable Multibit ECC (PMECC) header for SPL image.
85 bool "Support Broadcom NAND controller"
86 depends on OF_CONTROL && DM && DM_MTD
87 select SYS_NAND_SELF_INIT
89 Enable the driver for NAND flash on platforms using a Broadcom NAND
92 config NAND_BRCMNAND_6368
93 bool "Support Broadcom NAND controller on bcm6368"
94 depends on NAND_BRCMNAND && ARCH_BMIPS
96 Enable support for broadcom nand driver on bcm6368.
98 config NAND_BRCMNAND_6753
99 bool "Support Broadcom NAND controller on bcm6753"
100 depends on NAND_BRCMNAND && ARCH_BCM6753
102 Enable support for broadcom nand driver on bcm6753.
104 config NAND_BRCMNAND_68360
105 bool "Support Broadcom NAND controller on bcm68360"
106 depends on NAND_BRCMNAND && ARCH_BCM68360
108 Enable support for broadcom nand driver on bcm68360.
110 config NAND_BRCMNAND_6838
111 bool "Support Broadcom NAND controller on bcm6838"
112 depends on NAND_BRCMNAND && ARCH_BMIPS && SOC_BMIPS_BCM6838
114 Enable support for broadcom nand driver on bcm6838.
116 config NAND_BRCMNAND_6858
117 bool "Support Broadcom NAND controller on bcm6858"
118 depends on NAND_BRCMNAND && ARCH_BCM6858
120 Enable support for broadcom nand driver on bcm6858.
122 config NAND_BRCMNAND_63158
123 bool "Support Broadcom NAND controller on bcm63158"
124 depends on NAND_BRCMNAND && ARCH_BCM63158
126 Enable support for broadcom nand driver on bcm63158.
129 bool "Support TI Davinci NAND controller"
130 select SYS_NAND_SELF_INIT if TARGET_DA850EVM
132 Enable this driver for NAND flash controllers available in TI Davinci
133 and Keystone2 platforms
135 config KEYSTONE_RBL_NAND
136 depends on ARCH_KEYSTONE
141 depends on NAND_DAVINCI && ARCH_DAVINCI && SPL_NAND_SUPPORT
145 select SYS_NAND_SELF_INIT
148 config NAND_DENALI_DT
149 bool "Support Denali NAND controller as a DT device"
151 depends on OF_CONTROL && DM_MTD
153 Enable the driver for NAND flash on platforms using a Denali NAND
154 controller as a DT device.
157 bool "Support Freescale Enhanced Local Bus Controller FCM NAND driver"
158 select TPL_SYS_NAND_SELF_INIT if TPL_NAND_SUPPORT
159 select SPL_SYS_NAND_SELF_INIT
160 select SYS_NAND_SELF_INIT
163 Enable the Freescale Enhanced Local Bus Controller FCM NAND driver.
165 config NAND_FSL_ELBC_DT
166 bool "Support Freescale Enhanced Local Bus Controller FCM NAND driver (DT mode)"
167 depends on NAND_FSL_ELBC
170 bool "Support Freescale Integrated Flash Controller NAND driver"
171 select TPL_SYS_NAND_SELF_INIT if TPL_NAND_SUPPORT
172 select TPL_NAND_INIT if TPL && !TPL_FRAMEWORK
173 select SPL_SYS_NAND_SELF_INIT
174 select SYS_NAND_SELF_INIT
177 Enable the Freescale Integrated Flash Controller NAND driver.
179 config NAND_LPC32XX_MLC
180 bool "Support LPC32XX_MLC controller"
181 select SYS_NAND_SELF_INIT
183 Enable the LPC32XX MLC NAND controller.
185 config NAND_LPC32XX_SLC
186 bool "Support LPC32XX_SLC controller"
188 Enable the LPC32XX SLC NAND controller.
190 config NAND_OMAP_GPMC
191 bool "Support OMAP GPMC NAND controller"
192 depends on ARCH_OMAP2PLUS
194 Enables omap_gpmc.c driver for OMAPx and AMxxxx platforms.
195 GPMC controller is used for parallel NAND flash devices, and can
196 do ECC calculation (not ECC error detection) for HAM1, BCH4, BCH8
197 and BCH16 ECC algorithms.
201 config NAND_OMAP_GPMC_PREFETCH
202 bool "Enable GPMC Prefetch"
205 On OMAP platforms that use the GPMC controller
206 (CONFIG_NAND_OMAP_GPMC_PREFETCH), this options enables the code that
207 uses the prefetch mode to speed up read operations.
210 bool "Enable ELM driver for OMAPxx and AMxx platforms."
213 ELM controller is used for ECC error detection (not ECC calculation)
214 of BCH4, BCH8 and BCH16 ECC algorithms.
215 Some legacy platforms like OMAP3xx do not have in-built ELM h/w engine,
216 thus such SoC platforms need to depend on software library for ECC error
217 detection. However ECC calculation on such plaforms would still be
218 done by GPMC controller.
222 default NAND_OMAP_ECCSCHEME_BCH8_CODE_HW
224 On OMAP platforms, this CONFIG specifies NAND ECC scheme.
225 It can take following values:
226 OMAP_ECC_HAM1_CODE_SW
227 1-bit Hamming code using software lib.
228 (for legacy devices only)
229 OMAP_ECC_HAM1_CODE_HW
230 1-bit Hamming code using GPMC hardware.
231 (for legacy devices only)
232 OMAP_ECC_BCH4_CODE_HW_DETECTION_SW
233 4-bit BCH code (unsupported)
234 OMAP_ECC_BCH4_CODE_HW
235 4-bit BCH code (unsupported)
236 OMAP_ECC_BCH8_CODE_HW_DETECTION_SW
238 - ecc calculation using GPMC hardware engine,
239 - error detection using software library.
240 - requires CONFIG_BCH to enable software BCH library
241 (For legacy device which do not have ELM h/w engine)
242 OMAP_ECC_BCH8_CODE_HW
244 - ecc calculation using GPMC hardware engine,
245 - error detection using ELM hardware engine.
246 OMAP_ECC_BCH16_CODE_HW
248 - ecc calculation using GPMC hardware engine,
249 - error detection using ELM hardware engine.
251 How to select ECC scheme on OMAP and AMxx platforms ?
252 -----------------------------------------------------
253 Though higher ECC schemes have more capability to detect and correct
254 bit-flips, but still selection of ECC scheme is dependent on following
255 - hardware engines present in SoC.
256 Some legacy OMAP SoC do not have ELM h/w engine thus such
257 SoC cannot support BCHx_HW ECC schemes.
258 - size of OOB/Spare region
259 With higher ECC schemes, more OOB/Spare area is required to
260 store ECC. So choice of ECC scheme is limited by NAND oobsize.
262 In general following expression can help:
263 NAND_OOBSIZE >= 2 + (NAND_PAGESIZE / 512) * ECC_BYTES
265 NAND_OOBSIZE = number of bytes available in
266 OOB/spare area per NAND page.
267 NAND_PAGESIZE = bytes in main-area of NAND page.
268 ECC_BYTES = number of ECC bytes generated to
269 protect 512 bytes of data, which is:
270 3 for HAM1_xx ecc schemes
271 7 for BCH4_xx ecc schemes
272 14 for BCH8_xx ecc schemes
273 26 for BCH16_xx ecc schemes
275 example to check for BCH16 on 2K page NAND
278 2 + (2048 / 512) * 26 = 106 > NAND_OOBSIZE
279 Thus BCH16 cannot be supported on 2K page NAND.
281 However, for 4K pagesize NAND
285 2 + (4096 / 512) * 26 = 210 < NAND_OOBSIZE
286 Thus BCH16 can be supported on 4K page NAND.
288 config NAND_OMAP_ECCSCHEME_HAM1_CODE_SW
289 bool "1-bit Hamming code using software lib"
291 config NAND_OMAP_ECCSCHEME_HAM1_CODE_HW
292 bool "1-bit Hamming code using GPMC hardware"
294 config NAND_OMAP_ECCSCHEME_BCH8_CODE_HW_DETECTION_SW
295 bool "8-bit BCH code with HW calculation SW error detection"
297 config NAND_OMAP_ECCSCHEME_BCH8_CODE_HW
298 bool "8-bit BCH code with HW calculation and error detection"
300 config NAND_OMAP_ECCSCHEME_BCH16_CODE_HW
301 bool "16-bit BCH code with HW calculation and error detection"
305 config NAND_OMAP_ECCSCHEME
307 default 1 if NAND_OMAP_ECCSCHEME_HAM1_CODE_SW
308 default 2 if NAND_OMAP_ECCSCHEME_HAM1_CODE_HW
309 default 5 if NAND_OMAP_ECCSCHEME_BCH8_CODE_HW_DETECTION_SW
310 default 6 if NAND_OMAP_ECCSCHEME_BCH8_CODE_HW
311 default 7 if NAND_OMAP_ECCSCHEME_BCH16_CODE_HW
313 This must be kept in sync with the enum in
314 include/linux/mtd/omap_gpmc.h
318 config NAND_VF610_NFC
319 bool "Support for Freescale NFC for VF610"
320 select SYS_NAND_SELF_INIT
321 select SYS_NAND_DRIVER_ECC_LAYOUT
324 Enables support for NAND Flash Controller on some Freescale
325 processors like the VF610, MCF54418 or Kinetis K70.
326 The driver supports a maximum 2k page size. The driver
327 currently does not support hardware ECC.
331 config NAND_VF610_NFC_DT
332 bool "Support Vybrid's vf610 NAND controller as a DT device"
333 depends on OF_CONTROL && DM_MTD
335 Enable the driver for Vybrid's vf610 NAND flash on platforms
339 prompt "Hardware ECC strength"
340 depends on NAND_VF610_NFC
341 default SYS_NAND_VF610_NFC_45_ECC_BYTES
343 Select the ECC strength used in the hardware BCH ECC block.
345 config SYS_NAND_VF610_NFC_45_ECC_BYTES
346 bool "24-error correction (45 ECC bytes)"
348 config SYS_NAND_VF610_NFC_60_ECC_BYTES
349 bool "32-error correction (60 ECC bytes)"
356 bool "Support for NAND on PXA3xx and Armada 370/XP/38x"
357 select SYS_NAND_SELF_INIT
363 This enables the driver for the NAND flash device found on
364 PXA3xx processors (NFCv1) and also on Armada 370/XP (NFCv2).
367 bool "Support for NAND on Allwinner SoCs"
369 depends on MACH_SUN4I || MACH_SUN5I || MACH_SUN7I || MACH_SUN8I
370 select SYS_NAND_SELF_INIT
371 select SYS_NAND_U_BOOT_LOCATIONS
372 select SPL_NAND_SUPPORT
373 select SPL_SYS_NAND_SELF_INIT
376 Enable support for NAND. This option enables the standard and
378 The SPL driver only supports reading from the NAND using DMA
383 config NAND_SUNXI_SPL_ECC_STRENGTH
384 int "Allwinner NAND SPL ECC Strength"
387 config NAND_SUNXI_SPL_ECC_SIZE
388 int "Allwinner NAND SPL ECC Step Size"
391 config NAND_SUNXI_SPL_USABLE_PAGE_SIZE
392 int "Allwinner NAND SPL Usable Page Size"
398 bool "Configure Arasan Nand"
399 select SYS_NAND_SELF_INIT
403 This enables Nand driver support for Arasan nand flash
404 controller. This uses the hardware ECC for read and
408 bool "MXC NAND support"
409 depends on CPU_ARM926EJS || CPU_ARM1136 || MX5
412 This enables the NAND driver for the NAND flash controller on the
413 i.MX27 / i.MX31 / i.MX5 processors.
416 bool "MXS NAND support"
417 depends on MX23 || MX28 || MX6 || MX7 || IMX8 || IMX8M
418 select SPL_SYS_NAND_SELF_INIT
419 select SYS_NAND_SELF_INIT
422 select APBH_DMA_BURST if ARCH_MX6 || ARCH_MX7 || ARCH_IMX8 || ARCH_IMX8M
423 select APBH_DMA_BURST8 if ARCH_MX6 || ARCH_MX7 || ARCH_IMX8 || ARCH_IMX8M
425 This enables NAND driver for the NAND flash controller on the
431 bool "Support MXS NAND controller as a DT device"
432 depends on OF_CONTROL && DM_MTD
434 Enable the driver for MXS NAND flash on platforms using
437 config NAND_MXS_USE_MINIMUM_ECC
438 bool "Use minimum ECC strength supported by the controller"
444 bool "Macronix raw NAND controller"
445 select SYS_NAND_SELF_INIT
447 This selects the Macronix raw NAND controller driver.
450 bool "Support for Zynq Nand controller"
451 select SPL_SYS_NAND_SELF_INIT
452 select SYS_NAND_SELF_INIT
456 This enables Nand driver support for Nand flash controller
459 config NAND_ZYNQ_USE_BOOTLOADER1_TIMINGS
460 bool "Enable use of 1st stage bootloader timing for NAND"
463 This flag prevent U-boot reconfigure NAND flash controller and reuse
464 the NAND timing from 1st stage bootloader.
467 bool "Support for OcteonTX NAND controller"
468 select SYS_NAND_SELF_INIT
471 This enables Nand flash controller hardware found on the OcteonTX
474 config NAND_OCTEONTX_HW_ECC
475 bool "Support Hardware ECC for OcteonTX NAND controller"
476 depends on NAND_OCTEONTX
479 This enables Hardware BCH engine found on the OcteonTX processors to
480 support ECC for NAND flash controller.
482 config NAND_STM32_FMC2
483 bool "Support for NAND controller on STM32MP SoCs"
484 depends on ARCH_STM32MP
485 select SYS_NAND_SELF_INIT
488 Enables support for NAND Flash chips on SoCs containing the FMC2
489 NAND controller. This controller is found on STM32MP SoCs.
490 The controller supports a maximum 8k page size and supports
491 a maximum 8-bit correction error per sector of 512 bytes.
494 bool "Support for NAND controller on Cortina-Access SoCs"
495 depends on CORTINA_PLATFORM
496 select SYS_NAND_SELF_INIT
500 Enables support for NAND Flash chips on Coartina-Access SoCs platform
501 This controller is found on Presidio/Venus SoCs.
502 The controller supports a maximum 8k page size and supports
503 a maximum 40-bit error correction per sector of 1024 bytes.
506 bool "Support for NAND controller on Rockchip SoCs"
507 depends on ARCH_ROCKCHIP
508 select SYS_NAND_SELF_INIT
512 Enables support for NAND Flash chips on Rockchip SoCs platform.
513 This controller is found on Rockchip SoCs.
514 There are four different versions of NAND FLASH Controllers,
516 NFC v600: RK2928, RK3066, RK3188
517 NFC v622: RK3036, RK3128
518 NFC v800: RK3308, RV1108
519 NFC v900: PX30, RK3326
522 bool "Support for NAND controller on Tegra SoCs"
523 depends on ARCH_TEGRA
524 select SYS_NAND_SELF_INIT
527 Enables support for NAND Flash chips on Tegra SoCs platforms.
530 bool "Support for MediaTek MT7621 NAND flash controller"
531 depends on SOC_MT7621
532 select SYS_NAND_SELF_INIT
533 select SPL_SYS_NAND_SELF_INIT
536 This enables NAND driver for the NAND flash controller on MediaTek
538 The controller supports 4~12 bits correction per 512 bytes with a
539 maximum 4KB page size.
541 comment "Generic NAND options"
543 config SYS_NAND_BLOCK_SIZE
544 hex "NAND chip eraseblock size"
545 depends on ARCH_SUNXI || SPL_NAND_SUPPORT || TPL_NAND_SUPPORT
546 depends on !NAND_MXS && !NAND_DENALI_DT && !NAND_LPC32XX_MLC && \
547 !NAND_FSL_IFC && !NAND_MT7621
549 Number of data bytes in one eraseblock for the NAND chip on the
550 board. This is the multiple of NAND_PAGE_SIZE and the number of
553 config SYS_NAND_ONFI_DETECTION
554 bool "Enable detection of ONFI compliant devices during probe"
556 Enables detection of ONFI compliant devices during probe.
557 And fetching device parameters flashed on device, by parsing
560 config SYS_NAND_PAGE_COUNT
561 hex "NAND chip page count"
562 depends on SPL_NAND_SUPPORT && (NAND_ATMEL || NAND_MXC || \
563 SPL_NAND_AM33XX_BCH || SPL_NAND_LOAD || SPL_NAND_SIMPLE)
565 Number of pages in the NAND chip.
567 config SYS_NAND_PAGE_SIZE
568 hex "NAND chip page size"
569 depends on ARCH_SUNXI || NAND_OMAP_GPMC || NAND_LPC32XX_SLC || \
570 SPL_NAND_SIMPLE || (NAND_MXC && SPL_NAND_SUPPORT) || \
571 (NAND_ATMEL && SPL_NAND_SUPPORT) || SPL_GENERATE_ATMEL_PMECC_HEADER
572 depends on !NAND_MXS && !NAND_DENALI_DT && !NAND_LPC32XX_MLC && !NAND_MT7621
574 Number of data bytes in one page for the NAND chip on the
575 board, not including the OOB area.
577 config SYS_NAND_OOBSIZE
578 hex "NAND chip OOB size"
579 depends on ARCH_SUNXI || NAND_OMAP_GPMC || NAND_LPC32XX_SLC || \
580 SPL_NAND_SIMPLE || (NAND_MXC && SPL_NAND_SUPPORT) || \
581 (NAND_ATMEL && SPL_NAND_SUPPORT) || SPL_GENERATE_ATMEL_PMECC_HEADER
582 depends on !NAND_MXS && !NAND_DENALI_DT && !NAND_LPC32XX_MLC
584 Number of bytes in the Out-Of-Band area for the NAND chip on
587 # Enhance depends when converting drivers to Kconfig which use this config
588 # option (mxc_nand, ndfc, omap_gpmc).
589 config SYS_NAND_BUSWIDTH_16BIT
590 bool "Use 16-bit NAND interface"
591 depends on NAND_VF610_NFC || NAND_OMAP_GPMC || NAND_MXC || ARCH_DAVINCI
593 Indicates that NAND device has 16-bit wide data-bus. In absence of this
594 config, bus-width of NAND device is assumed to be either 8-bit and later
595 determined by reading ONFI params.
596 Above config is useful when NAND device's bus-width information cannot
597 be determined from on-chip ONFI params, like in following scenarios:
598 - SPL boot does not support reading of ONFI parameters. This is done to
599 keep SPL code foot-print small.
600 - In current U-Boot flow using nand_init(), driver initialization
601 happens in board_nand_init() which is called before any device probe
602 (nand_scan_ident + nand_scan_tail), thus device's ONFI parameters are
603 not available while configuring controller. So a static CONFIG_NAND_xx
604 is needed to know the device's bus-width in advance.
608 config SYS_NAND_5_ADDR_CYCLE
609 bool "Wait 5 address cycles during NAND commands"
610 depends on SPL_NAND_AM33XX_BCH || SPL_NAND_SIMPLE || \
611 (SPL_NAND_SUPPORT && NAND_ATMEL)
614 Some controllers require waiting for 5 address cycles when issuing
615 some commands, on NAND chips larger than 128MiB.
618 prompt "NAND bad block marker/indicator position in the OOB"
619 depends on SPL_NAND_AM33XX_BCH || SPL_NAND_DENALI || SPL_NAND_SIMPLE || \
620 SPL_NAND_SUPPORT && (NAND_ATMEL || NAND_MXC)
621 default HAS_NAND_LARGE_BADBLOCK_POS
623 In the OOB, which position contains the badblock information.
625 config HAS_NAND_LARGE_BADBLOCK_POS
626 bool "Set the bad block marker/indicator to the 'large' position"
628 config HAS_NAND_SMALL_BADBLOCK_POS
629 bool "Set the bad block marker/indicator to the 'small' position"
633 config SYS_NAND_BAD_BLOCK_POS
635 default 0 if HAS_NAND_LARGE_BADBLOCK_POS
636 default 5 if HAS_NAND_SMALL_BADBLOCK_POS
638 config SYS_NAND_U_BOOT_LOCATIONS
639 bool "Define U-boot binaries locations in NAND"
641 Enable CONFIG_SYS_NAND_U_BOOT_OFFS though Kconfig.
642 This option should not be enabled when compiling U-boot for boards
643 defining CONFIG_SYS_NAND_U_BOOT_OFFS in their include/configs/<board>.h
646 config SYS_NAND_U_BOOT_OFFS
647 hex "Location in NAND to read U-Boot from"
648 default 0x800000 if NAND_SUNXI
649 depends on SYS_NAND_U_BOOT_LOCATIONS
651 Set the offset from the start of the nand where u-boot should be
654 config SYS_NAND_U_BOOT_OFFS_REDUND
655 hex "Location in NAND to read U-Boot from"
656 default SYS_NAND_U_BOOT_OFFS
657 depends on SYS_NAND_U_BOOT_LOCATIONS
659 Set the offset from the start of the nand where the redundant u-boot
660 should be loaded from.
662 config SPL_NAND_AM33XX_BCH
663 bool "Enables SPL-NAND driver which supports ELM based"
664 depends on SPL_NAND_SUPPORT && NAND_OMAP_GPMC && !OMAP34XX
667 Hardware ECC correction. This is useful for platforms which have ELM
668 hardware engine and use NAND boot mode.
669 Some legacy platforms like OMAP3xx do not have in-built ELM h/w engine,
670 so those platforms should use CONFIG_SPL_NAND_SIMPLE for enabling
671 SPL-NAND driver with software ECC correction support.
673 config SPL_NAND_DENALI
674 bool "Support Denali NAND controller for SPL"
675 depends on SPL_NAND_SUPPORT
677 This is a small implementation of the Denali NAND controller
680 config NAND_DENALI_SPARE_AREA_SKIP_BYTES
681 int "Number of bytes skipped in OOB area"
682 depends on SPL_NAND_DENALI
685 This option specifies the number of bytes to skip from the beginning
686 of OOB area before last ECC sector data starts. This is potentially
687 used to preserve the bad block marker in the OOB area.
689 config SPL_NAND_SIMPLE
690 bool "Use simple SPL NAND driver"
691 depends on !SPL_NAND_AM33XX_BCH && SPL_NAND_SUPPORT
693 Support for NAND boot using simple NAND drivers that
694 expose the cmd_ctrl() interface.