Merge tag 'mmc-2020-10-14' of https://gitlab.denx.de/u-boot/custodians/u-boot-mmc
[platform/kernel/u-boot.git] / drivers / mtd / nand / raw / Kconfig
1
2 menuconfig MTD_RAW_NAND
3         bool "Raw NAND Device Support"
4 if MTD_RAW_NAND
5
6 config SYS_NAND_SELF_INIT
7         bool
8         help
9           This option, if enabled, provides more flexible and linux-like
10           NAND initialization process.
11
12 config SYS_NAND_DRIVER_ECC_LAYOUT
13         bool
14         help
15           Omit standard ECC layouts to safe space. Select this if your driver
16           is known to provide its own ECC layout.
17
18 config SYS_NAND_USE_FLASH_BBT
19         bool "Enable BBT (Bad Block Table) support"
20         help
21           Enable the BBT (Bad Block Table) usage.
22
23 config NAND_ATMEL
24         bool "Support Atmel NAND controller"
25         imply SYS_NAND_USE_FLASH_BBT
26         help
27           Enable this driver for NAND flash platforms using an Atmel NAND
28           controller.
29
30 if NAND_ATMEL
31
32 config ATMEL_NAND_HWECC
33         bool "Atmel Hardware ECC"
34         default n
35
36 config ATMEL_NAND_HW_PMECC
37         bool "Atmel Programmable Multibit ECC (PMECC)"
38         select ATMEL_NAND_HWECC
39         default n
40         help
41           The Programmable Multibit ECC (PMECC) controller is a programmable
42           binary BCH(Bose, Chaudhuri and Hocquenghem) encoder and decoder.
43
44 config PMECC_CAP
45         int "PMECC Correctable ECC Bits"
46         depends on ATMEL_NAND_HW_PMECC
47         default 2
48         help
49           Correctable ECC bits, can be 2, 4, 8, 12, and 24.
50
51 config PMECC_SECTOR_SIZE
52         int "PMECC Sector Size"
53         depends on ATMEL_NAND_HW_PMECC
54         default 512
55         help
56           Sector size, in bytes, can be 512 or 1024.
57
58 config SPL_GENERATE_ATMEL_PMECC_HEADER
59         bool "Atmel PMECC Header Generation"
60         select ATMEL_NAND_HWECC
61         select ATMEL_NAND_HW_PMECC
62         default n
63         help
64           Generate Programmable Multibit ECC (PMECC) header for SPL image.
65
66 endif
67
68 config NAND_BRCMNAND
69         bool "Support Broadcom NAND controller"
70         depends on OF_CONTROL && DM && DM_MTD
71         help
72           Enable the driver for NAND flash on platforms using a Broadcom NAND
73           controller.
74
75 config NAND_BRCMNAND_6368
76         bool "Support Broadcom NAND controller on bcm6368"
77         depends on NAND_BRCMNAND && ARCH_BMIPS
78         help
79           Enable support for broadcom nand driver on bcm6368.
80
81 config NAND_BRCMNAND_68360
82        bool "Support Broadcom NAND controller on bcm68360"
83        depends on NAND_BRCMNAND && ARCH_BCM68360
84        help
85          Enable support for broadcom nand driver on bcm68360.
86
87 config NAND_BRCMNAND_6838
88        bool "Support Broadcom NAND controller on bcm6838"
89        depends on NAND_BRCMNAND && ARCH_BMIPS && SOC_BMIPS_BCM6838
90        help
91          Enable support for broadcom nand driver on bcm6838.
92
93 config NAND_BRCMNAND_6858
94        bool "Support Broadcom NAND controller on bcm6858"
95        depends on NAND_BRCMNAND && ARCH_BCM6858
96        help
97          Enable support for broadcom nand driver on bcm6858.
98
99 config NAND_BRCMNAND_63158
100        bool "Support Broadcom NAND controller on bcm63158"
101        depends on NAND_BRCMNAND && ARCH_BCM63158
102        help
103          Enable support for broadcom nand driver on bcm63158.
104
105 config NAND_DAVINCI
106         bool "Support TI Davinci NAND controller"
107         help
108           Enable this driver for NAND flash controllers available in TI Davinci
109           and Keystone2 platforms
110
111 config NAND_DENALI
112         bool
113         select SYS_NAND_SELF_INIT
114         imply CMD_NAND
115
116 config NAND_DENALI_DT
117         bool "Support Denali NAND controller as a DT device"
118         select NAND_DENALI
119         depends on OF_CONTROL && DM_MTD
120         help
121           Enable the driver for NAND flash on platforms using a Denali NAND
122           controller as a DT device.
123
124 config NAND_LPC32XX_SLC
125         bool "Support LPC32XX_SLC controller"
126         help
127           Enable the LPC32XX SLC NAND controller.
128
129 config NAND_OMAP_GPMC
130         bool "Support OMAP GPMC NAND controller"
131         depends on ARCH_OMAP2PLUS
132         help
133           Enables omap_gpmc.c driver for OMAPx and AMxxxx platforms.
134           GPMC controller is used for parallel NAND flash devices, and can
135           do ECC calculation (not ECC error detection) for HAM1, BCH4, BCH8
136           and BCH16 ECC algorithms.
137
138 config NAND_OMAP_GPMC_PREFETCH
139         bool "Enable GPMC Prefetch"
140         depends on NAND_OMAP_GPMC
141         default y
142         help
143           On OMAP platforms that use the GPMC controller
144           (CONFIG_NAND_OMAP_GPMC_PREFETCH), this options enables the code that
145           uses the prefetch mode to speed up read operations.
146
147 config NAND_OMAP_ELM
148         bool "Enable ELM driver for OMAPxx and AMxx platforms."
149         depends on NAND_OMAP_GPMC && !OMAP34XX
150         help
151           ELM controller is used for ECC error detection (not ECC calculation)
152           of BCH4, BCH8 and BCH16 ECC algorithms.
153           Some legacy platforms like OMAP3xx do not have in-built ELM h/w engine,
154           thus such SoC platforms need to depend on software library for ECC error
155           detection. However ECC calculation on such plaforms would still be
156           done by GPMC controller.
157
158 config NAND_VF610_NFC
159         bool "Support for Freescale NFC for VF610"
160         select SYS_NAND_SELF_INIT
161         select SYS_NAND_DRIVER_ECC_LAYOUT
162         imply CMD_NAND
163         help
164           Enables support for NAND Flash Controller on some Freescale
165           processors like the VF610, MCF54418 or Kinetis K70.
166           The driver supports a maximum 2k page size. The driver
167           currently does not support hardware ECC.
168
169 if NAND_VF610_NFC
170
171 config NAND_VF610_NFC_DT
172         bool "Support Vybrid's vf610 NAND controller as a DT device"
173         depends on OF_CONTROL && DM_MTD
174         help
175           Enable the driver for Vybrid's vf610 NAND flash on platforms
176           using device tree.
177
178 choice
179         prompt "Hardware ECC strength"
180         depends on NAND_VF610_NFC
181         default SYS_NAND_VF610_NFC_45_ECC_BYTES
182         help
183           Select the ECC strength used in the hardware BCH ECC block.
184
185 config SYS_NAND_VF610_NFC_45_ECC_BYTES
186         bool "24-error correction (45 ECC bytes)"
187
188 config SYS_NAND_VF610_NFC_60_ECC_BYTES
189         bool "32-error correction (60 ECC bytes)"
190
191 endchoice
192
193 endif
194
195 config NAND_PXA3XX
196         bool "Support for NAND on PXA3xx and Armada 370/XP/38x"
197         select SYS_NAND_SELF_INIT
198         imply CMD_NAND
199         help
200           This enables the driver for the NAND flash device found on
201           PXA3xx processors (NFCv1) and also on Armada 370/XP (NFCv2).
202
203 config NAND_SUNXI
204         bool "Support for NAND on Allwinner SoCs"
205         default ARCH_SUNXI
206         depends on MACH_SUN4I || MACH_SUN5I || MACH_SUN7I || MACH_SUN8I
207         select SYS_NAND_SELF_INIT
208         select SYS_NAND_U_BOOT_LOCATIONS
209         select SPL_NAND_SUPPORT
210         imply CMD_NAND
211         ---help---
212         Enable support for NAND. This option enables the standard and
213         SPL drivers.
214         The SPL driver only supports reading from the NAND using DMA
215         transfers.
216
217 if NAND_SUNXI
218
219 config NAND_SUNXI_SPL_ECC_STRENGTH
220         int "Allwinner NAND SPL ECC Strength"
221         default 64
222
223 config NAND_SUNXI_SPL_ECC_SIZE
224         int "Allwinner NAND SPL ECC Step Size"
225         default 1024
226
227 config NAND_SUNXI_SPL_USABLE_PAGE_SIZE
228         int "Allwinner NAND SPL Usable Page Size"
229         default 1024
230
231 endif
232
233 config NAND_ARASAN
234         bool "Configure Arasan Nand"
235         select SYS_NAND_SELF_INIT
236         depends on DM_MTD
237         imply CMD_NAND
238         help
239           This enables Nand driver support for Arasan nand flash
240           controller. This uses the hardware ECC for read and
241           write operations.
242
243 config NAND_MXC
244         bool "MXC NAND support"
245         depends on CPU_ARM926EJS || CPU_ARM1136 || MX5
246         imply CMD_NAND
247         help
248           This enables the NAND driver for the NAND flash controller on the
249           i.MX27 / i.MX31 / i.MX5 rocessors.
250
251 config NAND_MXS
252         bool "MXS NAND support"
253         depends on MX23 || MX28 || MX6 || MX7 || IMX8 || IMX8M
254         select SYS_NAND_SELF_INIT
255         imply CMD_NAND
256         select APBH_DMA
257         select APBH_DMA_BURST if ARCH_MX6 || ARCH_MX7 || ARCH_IMX8 || ARCH_IMX8M
258         select APBH_DMA_BURST8 if ARCH_MX6 || ARCH_MX7 || ARCH_IMX8 || ARCH_IMX8M
259         help
260           This enables NAND driver for the NAND flash controller on the
261           MXS processors.
262
263 if NAND_MXS
264
265 config NAND_MXS_DT
266         bool "Support MXS NAND controller as a DT device"
267         depends on OF_CONTROL && DM_MTD
268         help
269           Enable the driver for MXS NAND flash on platforms using
270           device tree.
271
272 config NAND_MXS_USE_MINIMUM_ECC
273         bool "Use minimum ECC strength supported by the controller"
274         default false
275
276 endif
277
278 config NAND_ZYNQ
279         bool "Support for Zynq Nand controller"
280         select SYS_NAND_SELF_INIT
281         select DM_MTD
282         imply CMD_NAND
283         help
284           This enables Nand driver support for Nand flash controller
285           found on Zynq SoC.
286
287 config NAND_ZYNQ_USE_BOOTLOADER1_TIMINGS
288         bool "Enable use of 1st stage bootloader timing for NAND"
289         depends on NAND_ZYNQ
290         help
291           This flag prevent U-boot reconfigure NAND flash controller and reuse
292           the NAND timing from 1st stage bootloader.
293
294 config NAND_OCTEONTX
295         bool "Support for OcteonTX NAND controller"
296         select SYS_NAND_SELF_INIT
297         imply CMD_NAND
298         help
299          This enables Nand flash controller hardware found on the OcteonTX
300          processors.
301
302 config NAND_OCTEONTX_HW_ECC
303         bool "Support Hardware ECC for OcteonTX NAND controller"
304         depends on NAND_OCTEONTX
305         default y
306         help
307          This enables Hardware BCH engine found on the OcteonTX processors to
308          support ECC for NAND flash controller.
309
310 config NAND_STM32_FMC2
311         bool "Support for NAND controller on STM32MP SoCs"
312         depends on ARCH_STM32MP
313         select SYS_NAND_SELF_INIT
314         imply CMD_NAND
315         help
316           Enables support for NAND Flash chips on SoCs containing the FMC2
317           NAND controller. This controller is found on STM32MP SoCs.
318           The controller supports a maximum 8k page size and supports
319           a maximum 8-bit correction error per sector of 512 bytes.
320
321 comment "Generic NAND options"
322
323 config SYS_NAND_BLOCK_SIZE
324         hex "NAND chip eraseblock size"
325         depends on ARCH_SUNXI
326         help
327           Number of data bytes in one eraseblock for the NAND chip on the
328           board. This is the multiple of NAND_PAGE_SIZE and the number of
329           pages.
330
331 config SYS_NAND_PAGE_SIZE
332         hex "NAND chip page size"
333         depends on ARCH_SUNXI
334         help
335           Number of data bytes in one page for the NAND chip on the
336           board, not including the OOB area.
337
338 config SYS_NAND_OOBSIZE
339         hex "NAND chip OOB size"
340         depends on ARCH_SUNXI
341         help
342           Number of bytes in the Out-Of-Band area for the NAND chip on
343           the board.
344
345 # Enhance depends when converting drivers to Kconfig which use this config
346 # option (mxc_nand, ndfc, omap_gpmc).
347 config SYS_NAND_BUSWIDTH_16BIT
348         bool "Use 16-bit NAND interface"
349         depends on NAND_VF610_NFC || NAND_OMAP_GPMC || NAND_MXC || ARCH_DAVINCI
350         help
351           Indicates that NAND device has 16-bit wide data-bus. In absence of this
352           config, bus-width of NAND device is assumed to be either 8-bit and later
353           determined by reading ONFI params.
354           Above config is useful when NAND device's bus-width information cannot
355           be determined from on-chip ONFI params, like in following scenarios:
356           - SPL boot does not support reading of ONFI parameters. This is done to
357             keep SPL code foot-print small.
358           - In current U-Boot flow using nand_init(), driver initialization
359             happens in board_nand_init() which is called before any device probe
360             (nand_scan_ident + nand_scan_tail), thus device's ONFI parameters are
361             not available while configuring controller. So a static CONFIG_NAND_xx
362             is needed to know the device's bus-width in advance.
363
364 config SYS_NAND_MAX_CHIPS
365         int "NAND max chips"
366         default 1
367         depends on NAND_ARASAN
368         help
369           The maximum number of NAND chips per device to be supported.
370
371 if SPL
372
373 config SYS_NAND_U_BOOT_LOCATIONS
374         bool "Define U-boot binaries locations in NAND"
375         help
376         Enable CONFIG_SYS_NAND_U_BOOT_OFFS though Kconfig.
377         This option should not be enabled when compiling U-boot for boards
378         defining CONFIG_SYS_NAND_U_BOOT_OFFS in their include/configs/<board>.h
379         file.
380
381 config SYS_NAND_U_BOOT_OFFS
382         hex "Location in NAND to read U-Boot from"
383         default 0x800000 if NAND_SUNXI
384         depends on SYS_NAND_U_BOOT_LOCATIONS
385         help
386         Set the offset from the start of the nand where u-boot should be
387         loaded from.
388
389 config SYS_NAND_U_BOOT_OFFS_REDUND
390         hex "Location in NAND to read U-Boot from"
391         default SYS_NAND_U_BOOT_OFFS
392         depends on SYS_NAND_U_BOOT_LOCATIONS
393         help
394         Set the offset from the start of the nand where the redundant u-boot
395         should be loaded from.
396
397 config SPL_NAND_AM33XX_BCH
398         bool "Enables SPL-NAND driver which supports ELM based"
399         depends on NAND_OMAP_GPMC && !OMAP34XX
400         default y
401         help
402           Hardware ECC correction. This is useful for platforms which have ELM
403           hardware engine and use NAND boot mode.
404           Some legacy platforms like OMAP3xx do not have in-built ELM h/w engine,
405           so those platforms should use CONFIG_SPL_NAND_SIMPLE for enabling
406           SPL-NAND driver with software ECC correction support.
407
408 config SPL_NAND_DENALI
409         bool "Support Denali NAND controller for SPL"
410         help
411           This is a small implementation of the Denali NAND controller
412           for use on SPL.
413
414 config NAND_DENALI_SPARE_AREA_SKIP_BYTES
415         int "Number of bytes skipped in OOB area"
416         depends on SPL_NAND_DENALI
417         range 0 63
418         help
419           This option specifies the number of bytes to skip from the beginning
420           of OOB area before last ECC sector data starts.  This is potentially
421           used to preserve the bad block marker in the OOB area.
422
423 config SPL_NAND_SIMPLE
424         bool "Use simple SPL NAND driver"
425         depends on !SPL_NAND_AM33XX_BCH
426         help
427           Support for NAND boot using simple NAND drivers that
428           expose the cmd_ctrl() interface.
429 endif
430
431 endif   # if NAND