2 * linux/include/linux/mtd/nand.h
4 * Copyright © 2000-2010 David Woodhouse <dwmw2@infradead.org>
5 * Steven J. Hill <sjhill@realitydiluted.com>
6 * Thomas Gleixner <tglx@linutronix.de>
8 * SPDX-License-Identifier: GPL-2.0+
11 * Contains standard defines and IDs for NAND flash devices
16 #ifndef __LINUX_MTD_NAND_H
17 #define __LINUX_MTD_NAND_H
21 #include <linux/compat.h>
22 #include <linux/mtd/mtd.h>
23 #include <linux/mtd/flashchip.h>
24 #include <linux/mtd/bbm.h>
27 struct nand_flash_dev
;
30 /* Scan and identify a NAND device */
31 int nand_scan(struct mtd_info
*mtd
, int max_chips
);
33 * Separate phases of nand_scan(), allowing board driver to intervene
34 * and override command or ECC setup according to flash type.
36 int nand_scan_ident(struct mtd_info
*mtd
, int max_chips
,
37 struct nand_flash_dev
*table
);
38 int nand_scan_tail(struct mtd_info
*mtd
);
40 /* Free resources held by the NAND device */
41 void nand_release(struct mtd_info
*mtd
);
43 /* Internal helper for board drivers which need to override command function */
44 void nand_wait_ready(struct mtd_info
*mtd
);
47 * This constant declares the max. oobsize / page, which
48 * is supported now. If you add a chip with bigger oobsize/page
49 * adjust this accordingly.
51 #define NAND_MAX_OOBSIZE 1664
52 #define NAND_MAX_PAGESIZE 16384
55 * Constants for hardware specific CLE/ALE/NCE function
57 * These are bits which can be or'ed to set/clear multiple
60 /* Select the chip by setting nCE to low */
62 /* Select the command latch by setting CLE to high */
64 /* Select the address latch by setting ALE to high */
67 #define NAND_CTRL_CLE (NAND_NCE | NAND_CLE)
68 #define NAND_CTRL_ALE (NAND_NCE | NAND_ALE)
69 #define NAND_CTRL_CHANGE 0x80
72 * Standard NAND flash commands
74 #define NAND_CMD_READ0 0
75 #define NAND_CMD_READ1 1
76 #define NAND_CMD_RNDOUT 5
77 #define NAND_CMD_PAGEPROG 0x10
78 #define NAND_CMD_READOOB 0x50
79 #define NAND_CMD_ERASE1 0x60
80 #define NAND_CMD_STATUS 0x70
81 #define NAND_CMD_SEQIN 0x80
82 #define NAND_CMD_RNDIN 0x85
83 #define NAND_CMD_READID 0x90
84 #define NAND_CMD_ERASE2 0xd0
85 #define NAND_CMD_PARAM 0xec
86 #define NAND_CMD_GET_FEATURES 0xee
87 #define NAND_CMD_SET_FEATURES 0xef
88 #define NAND_CMD_RESET 0xff
90 #define NAND_CMD_LOCK 0x2a
91 #define NAND_CMD_UNLOCK1 0x23
92 #define NAND_CMD_UNLOCK2 0x24
94 /* Extended commands for large page devices */
95 #define NAND_CMD_READSTART 0x30
96 #define NAND_CMD_RNDOUTSTART 0xE0
97 #define NAND_CMD_CACHEDPROG 0x15
99 /* Extended commands for AG-AND device */
101 * Note: the command for NAND_CMD_DEPLETE1 is really 0x00 but
102 * there is no way to distinguish that from NAND_CMD_READ0
103 * until the remaining sequence of commands has been completed
104 * so add a high order bit and mask it off in the command.
106 #define NAND_CMD_DEPLETE1 0x100
107 #define NAND_CMD_DEPLETE2 0x38
108 #define NAND_CMD_STATUS_MULTI 0x71
109 #define NAND_CMD_STATUS_ERROR 0x72
110 /* multi-bank error status (banks 0-3) */
111 #define NAND_CMD_STATUS_ERROR0 0x73
112 #define NAND_CMD_STATUS_ERROR1 0x74
113 #define NAND_CMD_STATUS_ERROR2 0x75
114 #define NAND_CMD_STATUS_ERROR3 0x76
115 #define NAND_CMD_STATUS_RESET 0x7f
116 #define NAND_CMD_STATUS_CLEAR 0xff
118 #define NAND_CMD_NONE -1
121 #define NAND_STATUS_FAIL 0x01
122 #define NAND_STATUS_FAIL_N1 0x02
123 #define NAND_STATUS_TRUE_READY 0x20
124 #define NAND_STATUS_READY 0x40
125 #define NAND_STATUS_WP 0x80
128 * Constants for ECC_MODES
134 NAND_ECC_HW_SYNDROME
,
135 NAND_ECC_HW_OOB_FIRST
,
140 * Constants for Hardware ECC
142 /* Reset Hardware ECC for read */
143 #define NAND_ECC_READ 0
144 /* Reset Hardware ECC for write */
145 #define NAND_ECC_WRITE 1
146 /* Enable Hardware ECC before syndrome is read back from flash */
147 #define NAND_ECC_READSYN 2
150 * Enable generic NAND 'page erased' check. This check is only done when
151 * ecc.correct() returns -EBADMSG.
152 * Set this flag if your implementation does not fix bitflips in erased
153 * pages and you want to rely on the default implementation.
155 #define NAND_ECC_GENERIC_ERASED_CHECK BIT(0)
156 #define NAND_ECC_MAXIMIZE BIT(1)
158 /* Bit mask for flags passed to do_nand_read_ecc */
159 #define NAND_GET_DEVICE 0x80
163 * Option constants for bizarre disfunctionality and real
166 /* Buswidth is 16 bit */
167 #define NAND_BUSWIDTH_16 0x00000002
168 /* Device supports partial programming without padding */
169 #define NAND_NO_PADDING 0x00000004
170 /* Chip has cache program function */
171 #define NAND_CACHEPRG 0x00000008
172 /* Chip has copy back function */
173 #define NAND_COPYBACK 0x00000010
175 * Chip requires ready check on read (for auto-incremented sequential read).
176 * True only for small page devices; large page devices do not support
179 #define NAND_NEED_READRDY 0x00000100
181 /* Chip does not allow subpage writes */
182 #define NAND_NO_SUBPAGE_WRITE 0x00000200
184 /* Device is one of 'new' xD cards that expose fake nand command set */
185 #define NAND_BROKEN_XD 0x00000400
187 /* Device behaves just like nand, but is readonly */
188 #define NAND_ROM 0x00000800
190 /* Device supports subpage reads */
191 #define NAND_SUBPAGE_READ 0x00001000
194 * Some MLC NANDs need data scrambling to limit bitflips caused by repeated
197 #define NAND_NEED_SCRAMBLING 0x00002000
199 /* Options valid for Samsung large page devices */
200 #define NAND_SAMSUNG_LP_OPTIONS NAND_CACHEPRG
202 /* Macros to identify the above */
203 #define NAND_HAS_CACHEPROG(chip) ((chip->options & NAND_CACHEPRG))
204 #define NAND_HAS_SUBPAGE_READ(chip) ((chip->options & NAND_SUBPAGE_READ))
206 /* Non chip related options */
207 /* This option skips the bbt scan during initialization. */
208 #define NAND_SKIP_BBTSCAN 0x00010000
210 * This option is defined if the board driver allocates its own buffers
211 * (e.g. because it needs them DMA-coherent).
213 #define NAND_OWN_BUFFERS 0x00020000
214 /* Chip may not exist, so silence any errors in scan */
215 #define NAND_SCAN_SILENT_NODEV 0x00040000
217 * Autodetect nand buswidth with readid/onfi.
218 * This suppose the driver will configure the hardware in 8 bits mode
219 * when calling nand_scan_ident, and update its configuration
220 * before calling nand_scan_tail.
222 #define NAND_BUSWIDTH_AUTO 0x00080000
224 * This option could be defined by controller drivers to protect against
225 * kmap'ed, vmalloc'ed highmem buffers being passed from upper layers
227 #define NAND_USE_BOUNCE_BUFFER 0x00100000
229 /* Options set by nand scan */
230 /* bbt has already been read */
231 #define NAND_BBT_SCANNED 0x40000000
232 /* Nand scan has allocated controller struct */
233 #define NAND_CONTROLLER_ALLOC 0x80000000
235 /* Cell info constants */
236 #define NAND_CI_CHIPNR_MSK 0x03
237 #define NAND_CI_CELLTYPE_MSK 0x0C
238 #define NAND_CI_CELLTYPE_SHIFT 2
244 #define ONFI_FEATURE_16_BIT_BUS (1 << 0)
245 #define ONFI_FEATURE_EXT_PARAM_PAGE (1 << 7)
247 /* ONFI timing mode, used in both asynchronous and synchronous mode */
248 #define ONFI_TIMING_MODE_0 (1 << 0)
249 #define ONFI_TIMING_MODE_1 (1 << 1)
250 #define ONFI_TIMING_MODE_2 (1 << 2)
251 #define ONFI_TIMING_MODE_3 (1 << 3)
252 #define ONFI_TIMING_MODE_4 (1 << 4)
253 #define ONFI_TIMING_MODE_5 (1 << 5)
254 #define ONFI_TIMING_MODE_UNKNOWN (1 << 6)
256 /* ONFI feature address */
257 #define ONFI_FEATURE_ADDR_TIMING_MODE 0x1
259 /* Vendor-specific feature address (Micron) */
260 #define ONFI_FEATURE_ADDR_READ_RETRY 0x89
262 /* ONFI subfeature parameters length */
263 #define ONFI_SUBFEATURE_PARAM_LEN 4
265 /* ONFI optional commands SET/GET FEATURES supported? */
266 #define ONFI_OPT_CMD_SET_GET_FEATURES (1 << 2)
268 struct nand_onfi_params
{
269 /* rev info and features block */
270 /* 'O' 'N' 'F' 'I' */
276 __le16 ext_param_page_length
; /* since ONFI 2.1 */
277 u8 num_of_param_pages
; /* since ONFI 2.1 */
280 /* manufacturer information block */
281 char manufacturer
[12];
287 /* memory organization block */
288 __le32 byte_per_page
;
289 __le16 spare_bytes_per_page
;
290 __le32 data_bytes_per_ppage
;
291 __le16 spare_bytes_per_ppage
;
292 __le32 pages_per_block
;
293 __le32 blocks_per_lun
;
298 __le16 block_endurance
;
299 u8 guaranteed_good_blocks
;
300 __le16 guaranteed_block_endurance
;
301 u8 programs_per_page
;
308 /* electrical parameter block */
309 u8 io_pin_capacitance_max
;
310 __le16 async_timing_mode
;
311 __le16 program_cache_timing_mode
;
316 __le16 src_sync_timing_mode
;
317 u8 src_ssync_features
;
318 __le16 clk_pin_capacitance_typ
;
319 __le16 io_pin_capacitance_typ
;
320 __le16 input_pin_capacitance_typ
;
321 u8 input_pin_capacitance_max
;
322 u8 driver_strength_support
;
328 __le16 vendor_revision
;
334 #define ONFI_CRC_BASE 0x4F4E
336 /* Extended ECC information Block Definition (since ONFI 2.1) */
337 struct onfi_ext_ecc_info
{
341 __le16 block_endurance
;
345 #define ONFI_SECTION_TYPE_0 0 /* Unused section. */
346 #define ONFI_SECTION_TYPE_1 1 /* for additional sections. */
347 #define ONFI_SECTION_TYPE_2 2 /* for ECC information. */
348 struct onfi_ext_section
{
353 #define ONFI_EXT_SECTION_MAX 8
355 /* Extended Parameter Page Definition (since ONFI 2.1) */
356 struct onfi_ext_param_page
{
358 u8 sig
[4]; /* 'E' 'P' 'P' 'S' */
360 struct onfi_ext_section sections
[ONFI_EXT_SECTION_MAX
];
363 * The actual size of the Extended Parameter Page is in
364 * @ext_param_page_length of nand_onfi_params{}.
365 * The following are the variable length sections.
366 * So we do not add any fields below. Please see the ONFI spec.
370 struct nand_onfi_vendor_micron
{
375 u8 dq_imped_num_settings
;
376 u8 dq_imped_feat_addr
;
377 u8 rb_pulldown_strength
;
378 u8 rb_pulldown_strength_feat_addr
;
379 u8 rb_pulldown_strength_num_settings
;
382 u8 otp_data_prot_addr
;
385 u8 read_retry_options
;
390 struct jedec_ecc_info
{
394 __le16 block_endurance
;
399 #define JEDEC_FEATURE_16_BIT_BUS (1 << 0)
401 struct nand_jedec_params
{
402 /* rev info and features block */
403 /* 'J' 'E' 'S' 'D' */
409 u8 num_of_param_pages
;
412 /* manufacturer information block */
413 char manufacturer
[12];
418 /* memory organization block */
419 __le32 byte_per_page
;
420 __le16 spare_bytes_per_page
;
422 __le32 pages_per_block
;
423 __le32 blocks_per_lun
;
427 u8 programs_per_page
;
429 u8 multi_plane_op_attr
;
432 /* electrical parameter block */
433 __le16 async_sdr_speed_grade
;
434 __le16 toggle_ddr_speed_grade
;
435 __le16 sync_ddr_speed_grade
;
436 u8 async_sdr_features
;
437 u8 toggle_ddr_features
;
438 u8 sync_ddr_features
;
442 __le16 t_r_multi_plane
;
444 __le16 io_pin_capacitance_typ
;
445 __le16 input_pin_capacitance_typ
;
446 __le16 clk_pin_capacitance_typ
;
447 u8 driver_strength_support
;
451 /* ECC and endurance block */
452 u8 guaranteed_good_blocks
;
453 __le16 guaranteed_block_endurance
;
454 struct jedec_ecc_info ecc_info
[4];
461 __le16 vendor_rev_num
;
464 /* CRC for Parameter Page */
469 * struct nand_hw_control - Control structure for hardware controller (e.g ECC generator) shared among independent devices
470 * @lock: protection lock
471 * @active: the mtd device which holds the controller currently
472 * @wq: wait queue to sleep on if a NAND operation is in
473 * progress used instead of the per chip wait queue
474 * when a hw controller is available.
476 struct nand_hw_control
{
478 struct nand_chip
*active
;
482 * struct nand_ecc_ctrl - Control structure for ECC
484 * @steps: number of ECC steps per page
485 * @size: data bytes per ECC step
486 * @bytes: ECC bytes per step
487 * @strength: max number of correctible bits per ECC step
488 * @total: total number of ECC bytes per page
489 * @prepad: padding information for syndrome based ECC generators
490 * @postpad: padding information for syndrome based ECC generators
491 * @options: ECC specific options (see NAND_ECC_XXX flags defined above)
492 * @layout: ECC layout control struct pointer
493 * @priv: pointer to private ECC control data
494 * @hwctl: function to control hardware ECC generator. Must only
495 * be provided if an hardware ECC is available
496 * @calculate: function for ECC calculation or readback from ECC hardware
497 * @correct: function for ECC correction, matching to ECC generator (sw/hw).
498 * Should return a positive number representing the number of
499 * corrected bitflips, -EBADMSG if the number of bitflips exceed
500 * ECC strength, or any other error code if the error is not
501 * directly related to correction.
502 * If -EBADMSG is returned the input buffers should be left
504 * @read_page_raw: function to read a raw page without ECC. This function
505 * should hide the specific layout used by the ECC
506 * controller and always return contiguous in-band and
507 * out-of-band data even if they're not stored
508 * contiguously on the NAND chip (e.g.
509 * NAND_ECC_HW_SYNDROME interleaves in-band and
511 * @write_page_raw: function to write a raw page without ECC. This function
512 * should hide the specific layout used by the ECC
513 * controller and consider the passed data as contiguous
514 * in-band and out-of-band data. ECC controller is
515 * responsible for doing the appropriate transformations
516 * to adapt to its specific layout (e.g.
517 * NAND_ECC_HW_SYNDROME interleaves in-band and
519 * @read_page: function to read a page according to the ECC generator
520 * requirements; returns maximum number of bitflips corrected in
521 * any single ECC step, 0 if bitflips uncorrectable, -EIO hw error
522 * @read_subpage: function to read parts of the page covered by ECC;
523 * returns same as read_page()
524 * @write_subpage: function to write parts of the page covered by ECC.
525 * @write_page: function to write a page according to the ECC generator
527 * @write_oob_raw: function to write chip OOB data without ECC
528 * @read_oob_raw: function to read chip OOB data without ECC
529 * @read_oob: function to read chip OOB data
530 * @write_oob: function to write chip OOB data
532 struct nand_ecc_ctrl
{
533 nand_ecc_modes_t mode
;
541 unsigned int options
;
542 struct nand_ecclayout
*layout
;
544 void (*hwctl
)(struct mtd_info
*mtd
, int mode
);
545 int (*calculate
)(struct mtd_info
*mtd
, const uint8_t *dat
,
547 int (*correct
)(struct mtd_info
*mtd
, uint8_t *dat
, uint8_t *read_ecc
,
549 int (*read_page_raw
)(struct mtd_info
*mtd
, struct nand_chip
*chip
,
550 uint8_t *buf
, int oob_required
, int page
);
551 int (*write_page_raw
)(struct mtd_info
*mtd
, struct nand_chip
*chip
,
552 const uint8_t *buf
, int oob_required
, int page
);
553 int (*read_page
)(struct mtd_info
*mtd
, struct nand_chip
*chip
,
554 uint8_t *buf
, int oob_required
, int page
);
555 int (*read_subpage
)(struct mtd_info
*mtd
, struct nand_chip
*chip
,
556 uint32_t offs
, uint32_t len
, uint8_t *buf
, int page
);
557 int (*write_subpage
)(struct mtd_info
*mtd
, struct nand_chip
*chip
,
558 uint32_t offset
, uint32_t data_len
,
559 const uint8_t *data_buf
, int oob_required
, int page
);
560 int (*write_page
)(struct mtd_info
*mtd
, struct nand_chip
*chip
,
561 const uint8_t *buf
, int oob_required
, int page
);
562 int (*write_oob_raw
)(struct mtd_info
*mtd
, struct nand_chip
*chip
,
564 int (*read_oob_raw
)(struct mtd_info
*mtd
, struct nand_chip
*chip
,
566 int (*read_oob
)(struct mtd_info
*mtd
, struct nand_chip
*chip
, int page
);
567 int (*write_oob
)(struct mtd_info
*mtd
, struct nand_chip
*chip
,
572 * struct nand_buffers - buffer structure for read/write
573 * @ecccalc: buffer pointer for calculated ECC, size is oobsize.
574 * @ecccode: buffer pointer for ECC read from flash, size is oobsize.
575 * @databuf: buffer pointer for data, size is (page size + oobsize).
577 * Do not change the order of buffers. databuf and oobrbuf must be in
580 struct nand_buffers
{
581 uint8_t ecccalc
[ALIGN(NAND_MAX_OOBSIZE
, ARCH_DMA_MINALIGN
)];
582 uint8_t ecccode
[ALIGN(NAND_MAX_OOBSIZE
, ARCH_DMA_MINALIGN
)];
583 uint8_t databuf
[ALIGN(NAND_MAX_PAGESIZE
+ NAND_MAX_OOBSIZE
,
588 * struct nand_sdr_timings - SDR NAND chip timings
590 * This struct defines the timing requirements of a SDR NAND chip.
591 * These information can be found in every NAND datasheets and the timings
592 * meaning are described in the ONFI specifications:
593 * www.onfi.org/~/media/ONFI/specs/onfi_3_1_spec.pdf (chapter 4.15 Timing
596 * All these timings are expressed in picoseconds.
598 * @tBERS_max: Block erase time
599 * @tCCS_min: Change column setup time
600 * @tPROG_max: Page program time
601 * @tR_max: Page read time
602 * @tALH_min: ALE hold time
603 * @tADL_min: ALE to data loading time
604 * @tALS_min: ALE setup time
605 * @tAR_min: ALE to RE# delay
606 * @tCEA_max: CE# access time
607 * @tCEH_min: CE# high hold time
608 * @tCH_min: CE# hold time
609 * @tCHZ_max: CE# high to output hi-Z
610 * @tCLH_min: CLE hold time
611 * @tCLR_min: CLE to RE# delay
612 * @tCLS_min: CLE setup time
613 * @tCOH_min: CE# high to output hold
614 * @tCS_min: CE# setup time
615 * @tDH_min: Data hold time
616 * @tDS_min: Data setup time
617 * @tFEAT_max: Busy time for Set Features and Get Features
618 * @tIR_min: Output hi-Z to RE# low
619 * @tITC_max: Interface and Timing Mode Change time
620 * @tRC_min: RE# cycle time
621 * @tREA_max: RE# access time
622 * @tREH_min: RE# high hold time
623 * @tRHOH_min: RE# high to output hold
624 * @tRHW_min: RE# high to WE# low
625 * @tRHZ_max: RE# high to output hi-Z
626 * @tRLOH_min: RE# low to output hold
627 * @tRP_min: RE# pulse width
628 * @tRR_min: Ready to RE# low (data only)
629 * @tRST_max: Device reset time, measured from the falling edge of R/B# to the
630 * rising edge of R/B#.
631 * @tWB_max: WE# high to SR[6] low
632 * @tWC_min: WE# cycle time
633 * @tWH_min: WE# high hold time
634 * @tWHR_min: WE# high to RE# low
635 * @tWP_min: WE# pulse width
636 * @tWW_min: WP# transition to WE# low
638 struct nand_sdr_timings
{
680 * enum nand_data_interface_type - NAND interface timing type
681 * @NAND_SDR_IFACE: Single Data Rate interface
683 enum nand_data_interface_type
{
688 * struct nand_data_interface - NAND interface timing
689 * @type: type of the timing
690 * @timings: The timing, type according to @type
692 struct nand_data_interface
{
693 enum nand_data_interface_type type
;
695 struct nand_sdr_timings sdr
;
700 * nand_get_sdr_timings - get SDR timing from data interface
701 * @conf: The data interface
703 static inline const struct nand_sdr_timings
*
704 nand_get_sdr_timings(const struct nand_data_interface
*conf
)
706 if (conf
->type
!= NAND_SDR_IFACE
)
707 return ERR_PTR(-EINVAL
);
709 return &conf
->timings
.sdr
;
713 * struct nand_chip - NAND Private Flash Chip Data
714 * @mtd: MTD device registered to the MTD framework
715 * @IO_ADDR_R: [BOARDSPECIFIC] address to read the 8 I/O lines of the
717 * @IO_ADDR_W: [BOARDSPECIFIC] address to write the 8 I/O lines of the
719 * @flash_node: [BOARDSPECIFIC] device node describing this instance
720 * @read_byte: [REPLACEABLE] read one byte from the chip
721 * @read_word: [REPLACEABLE] read one word from the chip
722 * @write_byte: [REPLACEABLE] write a single byte to the chip on the
724 * @write_buf: [REPLACEABLE] write data from the buffer to the chip
725 * @read_buf: [REPLACEABLE] read data from the chip into the buffer
726 * @select_chip: [REPLACEABLE] select chip nr
727 * @block_bad: [REPLACEABLE] check if a block is bad, using OOB markers
728 * @block_markbad: [REPLACEABLE] mark a block bad
729 * @cmd_ctrl: [BOARDSPECIFIC] hardwarespecific function for controlling
730 * ALE/CLE/nCE. Also used to write command and address
731 * @dev_ready: [BOARDSPECIFIC] hardwarespecific function for accessing
732 * device ready/busy line. If set to NULL no access to
733 * ready/busy is available and the ready/busy information
734 * is read from the chip status register.
735 * @cmdfunc: [REPLACEABLE] hardwarespecific function for writing
736 * commands to the chip.
737 * @waitfunc: [REPLACEABLE] hardwarespecific function for wait on
739 * @setup_read_retry: [FLASHSPECIFIC] flash (vendor) specific function for
740 * setting the read-retry mode. Mostly needed for MLC NAND.
741 * @ecc: [BOARDSPECIFIC] ECC control structure
742 * @buffers: buffer structure for read/write
743 * @hwcontrol: platform-specific hardware control structure
744 * @erase: [REPLACEABLE] erase function
745 * @scan_bbt: [REPLACEABLE] function to scan bad block table
746 * @chip_delay: [BOARDSPECIFIC] chip dependent delay for transferring
747 * data from array to read regs (tR).
748 * @state: [INTERN] the current state of the NAND device
749 * @oob_poi: "poison value buffer," used for laying out OOB data
751 * @page_shift: [INTERN] number of address bits in a page (column
753 * @phys_erase_shift: [INTERN] number of address bits in a physical eraseblock
754 * @bbt_erase_shift: [INTERN] number of address bits in a bbt entry
755 * @chip_shift: [INTERN] number of address bits in one chip
756 * @options: [BOARDSPECIFIC] various chip options. They can partly
757 * be set to inform nand_scan about special functionality.
758 * See the defines for further explanation.
759 * @bbt_options: [INTERN] bad block specific options. All options used
760 * here must come from bbm.h. By default, these options
761 * will be copied to the appropriate nand_bbt_descr's.
762 * @badblockpos: [INTERN] position of the bad block marker in the oob
764 * @badblockbits: [INTERN] minimum number of set bits in a good block's
765 * bad block marker position; i.e., BBM == 11110111b is
766 * not bad when badblockbits == 7
767 * @bits_per_cell: [INTERN] number of bits per cell. i.e., 1 means SLC.
768 * @ecc_strength_ds: [INTERN] ECC correctability from the datasheet.
769 * Minimum amount of bit errors per @ecc_step_ds guaranteed
770 * to be correctable. If unknown, set to zero.
771 * @ecc_step_ds: [INTERN] ECC step required by the @ecc_strength_ds,
772 * also from the datasheet. It is the recommended ECC step
773 * size, if known; if unknown, set to zero.
774 * @onfi_timing_mode_default: [INTERN] default ONFI timing mode. This field is
775 * set to the actually used ONFI mode if the chip is
776 * ONFI compliant or deduced from the datasheet if
777 * the NAND chip is not ONFI compliant.
778 * @numchips: [INTERN] number of physical chips
779 * @chipsize: [INTERN] the size of one chip for multichip arrays
780 * @pagemask: [INTERN] page number mask = number of (pages / chip) - 1
781 * @pagebuf: [INTERN] holds the pagenumber which is currently in
783 * @pagebuf_bitflips: [INTERN] holds the bitflip count for the page which is
784 * currently in data_buf.
785 * @subpagesize: [INTERN] holds the subpagesize
786 * @onfi_version: [INTERN] holds the chip ONFI version (BCD encoded),
787 * non 0 if ONFI supported.
788 * @jedec_version: [INTERN] holds the chip JEDEC version (BCD encoded),
789 * non 0 if JEDEC supported.
790 * @onfi_params: [INTERN] holds the ONFI page parameter when ONFI is
791 * supported, 0 otherwise.
792 * @jedec_params: [INTERN] holds the JEDEC parameter page when JEDEC is
793 * supported, 0 otherwise.
794 * @read_retries: [INTERN] the number of read retry modes supported
795 * @onfi_set_features: [REPLACEABLE] set the features for ONFI nand
796 * @onfi_get_features: [REPLACEABLE] get the features for ONFI nand
797 * @setup_data_interface: [OPTIONAL] setup the data interface and timing
798 * @bbt: [INTERN] bad block table pointer
799 * @bbt_td: [REPLACEABLE] bad block table descriptor for flash
801 * @bbt_md: [REPLACEABLE] bad block table mirror descriptor
802 * @badblock_pattern: [REPLACEABLE] bad block scan pattern used for initial
804 * @controller: [REPLACEABLE] a pointer to a hardware controller
805 * structure which is shared among multiple independent
807 * @priv: [OPTIONAL] pointer to private chip data
808 * @errstat: [OPTIONAL] hardware specific function to perform
809 * additional error status checks (determine if errors are
811 * @write_page: [REPLACEABLE] High-level page write function
816 void __iomem
*IO_ADDR_R
;
817 void __iomem
*IO_ADDR_W
;
821 uint8_t (*read_byte
)(struct mtd_info
*mtd
);
822 u16 (*read_word
)(struct mtd_info
*mtd
);
823 void (*write_byte
)(struct mtd_info
*mtd
, uint8_t byte
);
824 void (*write_buf
)(struct mtd_info
*mtd
, const uint8_t *buf
, int len
);
825 void (*read_buf
)(struct mtd_info
*mtd
, uint8_t *buf
, int len
);
826 void (*select_chip
)(struct mtd_info
*mtd
, int chip
);
827 int (*block_bad
)(struct mtd_info
*mtd
, loff_t ofs
);
828 int (*block_markbad
)(struct mtd_info
*mtd
, loff_t ofs
);
829 void (*cmd_ctrl
)(struct mtd_info
*mtd
, int dat
, unsigned int ctrl
);
830 int (*dev_ready
)(struct mtd_info
*mtd
);
831 void (*cmdfunc
)(struct mtd_info
*mtd
, unsigned command
, int column
,
833 int(*waitfunc
)(struct mtd_info
*mtd
, struct nand_chip
*this);
834 int (*erase
)(struct mtd_info
*mtd
, int page
);
835 int (*scan_bbt
)(struct mtd_info
*mtd
);
836 int (*errstat
)(struct mtd_info
*mtd
, struct nand_chip
*this, int state
,
837 int status
, int page
);
838 int (*write_page
)(struct mtd_info
*mtd
, struct nand_chip
*chip
,
839 uint32_t offset
, int data_len
, const uint8_t *buf
,
840 int oob_required
, int page
, int cached
, int raw
);
841 int (*onfi_set_features
)(struct mtd_info
*mtd
, struct nand_chip
*chip
,
842 int feature_addr
, uint8_t *subfeature_para
);
843 int (*onfi_get_features
)(struct mtd_info
*mtd
, struct nand_chip
*chip
,
844 int feature_addr
, uint8_t *subfeature_para
);
845 int (*setup_read_retry
)(struct mtd_info
*mtd
, int retry_mode
);
846 int (*setup_data_interface
)(struct mtd_info
*mtd
,
847 const struct nand_data_interface
*conf
,
852 unsigned int options
;
853 unsigned int bbt_options
;
856 int phys_erase_shift
;
863 unsigned int pagebuf_bitflips
;
865 uint8_t bits_per_cell
;
866 uint16_t ecc_strength_ds
;
867 uint16_t ecc_step_ds
;
868 int onfi_timing_mode_default
;
874 struct nand_onfi_params onfi_params
;
875 struct nand_jedec_params jedec_params
;
877 struct nand_data_interface
*data_interface
;
884 struct nand_hw_control
*controller
;
885 struct nand_ecclayout
*ecclayout
;
887 struct nand_ecc_ctrl ecc
;
888 struct nand_buffers
*buffers
;
889 struct nand_hw_control hwcontrol
;
892 struct nand_bbt_descr
*bbt_td
;
893 struct nand_bbt_descr
*bbt_md
;
895 struct nand_bbt_descr
*badblock_pattern
;
900 static inline struct nand_chip
*mtd_to_nand(struct mtd_info
*mtd
)
902 return container_of(mtd
, struct nand_chip
, mtd
);
905 static inline struct mtd_info
*nand_to_mtd(struct nand_chip
*chip
)
910 static inline void *nand_get_controller_data(struct nand_chip
*chip
)
915 static inline void nand_set_controller_data(struct nand_chip
*chip
, void *priv
)
921 * NAND Flash Manufacturer ID Codes
923 #define NAND_MFR_TOSHIBA 0x98
924 #define NAND_MFR_SAMSUNG 0xec
925 #define NAND_MFR_FUJITSU 0x04
926 #define NAND_MFR_NATIONAL 0x8f
927 #define NAND_MFR_RENESAS 0x07
928 #define NAND_MFR_STMICRO 0x20
929 #define NAND_MFR_HYNIX 0xad
930 #define NAND_MFR_MICRON 0x2c
931 #define NAND_MFR_AMD 0x01
932 #define NAND_MFR_MACRONIX 0xc2
933 #define NAND_MFR_EON 0x92
934 #define NAND_MFR_SANDISK 0x45
935 #define NAND_MFR_INTEL 0x89
936 #define NAND_MFR_ATO 0x9b
938 /* The maximum expected count of bytes in the NAND ID sequence */
939 #define NAND_MAX_ID_LEN 8
942 * A helper for defining older NAND chips where the second ID byte fully
943 * defined the chip, including the geometry (chip size, eraseblock size, page
944 * size). All these chips have 512 bytes NAND page size.
946 #define LEGACY_ID_NAND(nm, devid, chipsz, erasesz, opts) \
947 { .name = (nm), {{ .dev_id = (devid) }}, .pagesize = 512, \
948 .chipsize = (chipsz), .erasesize = (erasesz), .options = (opts) }
951 * A helper for defining newer chips which report their page size and
952 * eraseblock size via the extended ID bytes.
954 * The real difference between LEGACY_ID_NAND and EXTENDED_ID_NAND is that with
955 * EXTENDED_ID_NAND, manufacturers overloaded the same device ID so that the
956 * device ID now only represented a particular total chip size (and voltage,
957 * buswidth), and the page size, eraseblock size, and OOB size could vary while
958 * using the same device ID.
960 #define EXTENDED_ID_NAND(nm, devid, chipsz, opts) \
961 { .name = (nm), {{ .dev_id = (devid) }}, .chipsize = (chipsz), \
964 #define NAND_ECC_INFO(_strength, _step) \
965 { .strength_ds = (_strength), .step_ds = (_step) }
966 #define NAND_ECC_STRENGTH(type) ((type)->ecc.strength_ds)
967 #define NAND_ECC_STEP(type) ((type)->ecc.step_ds)
970 * struct nand_flash_dev - NAND Flash Device ID Structure
971 * @name: a human-readable name of the NAND chip
972 * @dev_id: the device ID (the second byte of the full chip ID array)
973 * @mfr_id: manufecturer ID part of the full chip ID array (refers the same
974 * memory address as @id[0])
975 * @dev_id: device ID part of the full chip ID array (refers the same memory
977 * @id: full device ID array
978 * @pagesize: size of the NAND page in bytes; if 0, then the real page size (as
979 * well as the eraseblock size) is determined from the extended NAND
981 * @chipsize: total chip size in MiB
982 * @erasesize: eraseblock size in bytes (determined from the extended ID if 0)
983 * @options: stores various chip bit options
984 * @id_len: The valid length of the @id.
986 * @ecc: ECC correctability and step information from the datasheet.
987 * @ecc.strength_ds: The ECC correctability from the datasheet, same as the
988 * @ecc_strength_ds in nand_chip{}.
989 * @ecc.step_ds: The ECC step required by the @ecc.strength_ds, same as the
990 * @ecc_step_ds in nand_chip{}, also from the datasheet.
991 * For example, the "4bit ECC for each 512Byte" can be set with
992 * NAND_ECC_INFO(4, 512).
993 * @onfi_timing_mode_default: the default ONFI timing mode entered after a NAND
994 * reset. Should be deduced from timings described
998 struct nand_flash_dev
{
1005 uint8_t id
[NAND_MAX_ID_LEN
];
1007 unsigned int pagesize
;
1008 unsigned int chipsize
;
1009 unsigned int erasesize
;
1010 unsigned int options
;
1014 uint16_t strength_ds
;
1017 int onfi_timing_mode_default
;
1021 * struct nand_manufacturers - NAND Flash Manufacturer ID Structure
1022 * @name: Manufacturer name
1023 * @id: manufacturer ID code of device.
1025 struct nand_manufacturers
{
1030 extern struct nand_flash_dev nand_flash_ids
[];
1031 extern struct nand_manufacturers nand_manuf_ids
[];
1033 int nand_default_bbt(struct mtd_info
*mtd
);
1034 int nand_markbad_bbt(struct mtd_info
*mtd
, loff_t offs
);
1035 int nand_isreserved_bbt(struct mtd_info
*mtd
, loff_t offs
);
1036 int nand_isbad_bbt(struct mtd_info
*mtd
, loff_t offs
, int allowbbt
);
1037 int nand_erase_nand(struct mtd_info
*mtd
, struct erase_info
*instr
,
1039 int nand_do_read(struct mtd_info
*mtd
, loff_t from
, size_t len
,
1040 size_t *retlen
, uint8_t *buf
);
1043 * Constants for oob configuration
1045 #define NAND_SMALL_BADBLOCK_POS 5
1046 #define NAND_LARGE_BADBLOCK_POS 0
1049 * struct platform_nand_chip - chip level device structure
1050 * @nr_chips: max. number of chips to scan for
1051 * @chip_offset: chip number offset
1052 * @nr_partitions: number of partitions pointed to by partitions (or zero)
1053 * @partitions: mtd partition list
1054 * @chip_delay: R/B delay value in us
1055 * @options: Option flags, e.g. 16bit buswidth
1056 * @bbt_options: BBT option flags, e.g. NAND_BBT_USE_FLASH
1057 * @part_probe_types: NULL-terminated array of probe types
1059 struct platform_nand_chip
{
1063 struct mtd_partition
*partitions
;
1065 unsigned int options
;
1066 unsigned int bbt_options
;
1067 const char **part_probe_types
;
1070 /* Keep gcc happy */
1071 struct platform_device
;
1074 * struct platform_nand_ctrl - controller level device structure
1075 * @probe: platform specific function to probe/setup hardware
1076 * @remove: platform specific function to remove/teardown hardware
1077 * @hwcontrol: platform specific hardware control structure
1078 * @dev_ready: platform specific function to read ready/busy pin
1079 * @select_chip: platform specific chip select function
1080 * @cmd_ctrl: platform specific function for controlling
1081 * ALE/CLE/nCE. Also used to write command and address
1082 * @write_buf: platform specific function for write buffer
1083 * @read_buf: platform specific function for read buffer
1084 * @read_byte: platform specific function to read one byte from chip
1085 * @priv: private data to transport driver specific settings
1087 * All fields are optional and depend on the hardware driver requirements
1089 struct platform_nand_ctrl
{
1090 int (*probe
)(struct platform_device
*pdev
);
1091 void (*remove
)(struct platform_device
*pdev
);
1092 void (*hwcontrol
)(struct mtd_info
*mtd
, int cmd
);
1093 int (*dev_ready
)(struct mtd_info
*mtd
);
1094 void (*select_chip
)(struct mtd_info
*mtd
, int chip
);
1095 void (*cmd_ctrl
)(struct mtd_info
*mtd
, int dat
, unsigned int ctrl
);
1096 void (*write_buf
)(struct mtd_info
*mtd
, const uint8_t *buf
, int len
);
1097 void (*read_buf
)(struct mtd_info
*mtd
, uint8_t *buf
, int len
);
1098 unsigned char (*read_byte
)(struct mtd_info
*mtd
);
1103 * struct platform_nand_data - container structure for platform-specific data
1104 * @chip: chip level chip structure
1105 * @ctrl: controller level device structure
1107 struct platform_nand_data
{
1108 struct platform_nand_chip chip
;
1109 struct platform_nand_ctrl ctrl
;
1112 #ifdef CONFIG_SYS_NAND_ONFI_DETECTION
1113 /* return the supported features. */
1114 static inline int onfi_feature(struct nand_chip
*chip
)
1116 return chip
->onfi_version
? le16_to_cpu(chip
->onfi_params
.features
) : 0;
1119 /* return the supported asynchronous timing mode. */
1120 static inline int onfi_get_async_timing_mode(struct nand_chip
*chip
)
1122 if (!chip
->onfi_version
)
1123 return ONFI_TIMING_MODE_UNKNOWN
;
1124 return le16_to_cpu(chip
->onfi_params
.async_timing_mode
);
1127 /* return the supported synchronous timing mode. */
1128 static inline int onfi_get_sync_timing_mode(struct nand_chip
*chip
)
1130 if (!chip
->onfi_version
)
1131 return ONFI_TIMING_MODE_UNKNOWN
;
1132 return le16_to_cpu(chip
->onfi_params
.src_sync_timing_mode
);
1135 static inline int onfi_feature(struct nand_chip
*chip
)
1140 static inline int onfi_get_async_timing_mode(struct nand_chip
*chip
)
1142 return ONFI_TIMING_MODE_UNKNOWN
;
1145 static inline int onfi_get_sync_timing_mode(struct nand_chip
*chip
)
1147 return ONFI_TIMING_MODE_UNKNOWN
;
1151 int onfi_init_data_interface(struct nand_chip
*chip
,
1152 struct nand_data_interface
*iface
,
1153 enum nand_data_interface_type type
,
1157 * Check if it is a SLC nand.
1158 * The !nand_is_slc() can be used to check the MLC/TLC nand chips.
1159 * We do not distinguish the MLC and TLC now.
1161 static inline bool nand_is_slc(struct nand_chip
*chip
)
1163 return chip
->bits_per_cell
== 1;
1167 * Check if the opcode's address should be sent only on the lower 8 bits
1168 * @command: opcode to check
1170 static inline int nand_opcode_8bits(unsigned int command
)
1173 case NAND_CMD_READID
:
1174 case NAND_CMD_PARAM
:
1175 case NAND_CMD_GET_FEATURES
:
1176 case NAND_CMD_SET_FEATURES
:
1184 /* return the supported JEDEC features. */
1185 static inline int jedec_feature(struct nand_chip
*chip
)
1187 return chip
->jedec_version
? le16_to_cpu(chip
->jedec_params
.features
)
1191 /* Standard NAND functions from nand_base.c */
1192 void nand_write_buf(struct mtd_info
*mtd
, const uint8_t *buf
, int len
);
1193 void nand_write_buf16(struct mtd_info
*mtd
, const uint8_t *buf
, int len
);
1194 void nand_read_buf(struct mtd_info
*mtd
, uint8_t *buf
, int len
);
1195 void nand_read_buf16(struct mtd_info
*mtd
, uint8_t *buf
, int len
);
1196 uint8_t nand_read_byte(struct mtd_info
*mtd
);
1198 /* get timing characteristics from ONFI timing mode. */
1199 const struct nand_sdr_timings
*onfi_async_timing_mode_to_sdr_timings(int mode
);
1200 /* get data interface from ONFI timing mode 0, used after reset. */
1201 const struct nand_data_interface
*nand_get_default_data_interface(void);
1203 int nand_check_erased_ecc_chunk(void *data
, int datalen
,
1204 void *ecc
, int ecclen
,
1205 void *extraoob
, int extraooblen
,
1208 /* Reset and initialize a NAND device */
1209 int nand_reset(struct nand_chip
*chip
, int chipnr
);
1211 #endif /* __LINUX_MTD_NAND_H */