GNU Linux-libre 4.14.313-gnu1
[releases.git] / include / linux / mtd / rawnand.h
1 /*
2  *  Copyright © 2000-2010 David Woodhouse <dwmw2@infradead.org>
3  *                        Steven J. Hill <sjhill@realitydiluted.com>
4  *                        Thomas Gleixner <tglx@linutronix.de>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation.
9  *
10  * Info:
11  *      Contains standard defines and IDs for NAND flash devices
12  *
13  * Changelog:
14  *      See git changelog.
15  */
16 #ifndef __LINUX_MTD_RAWNAND_H
17 #define __LINUX_MTD_RAWNAND_H
18
19 #include <linux/wait.h>
20 #include <linux/spinlock.h>
21 #include <linux/mtd/mtd.h>
22 #include <linux/mtd/flashchip.h>
23 #include <linux/mtd/bbm.h>
24
25 struct nand_chip;
26 struct mtd_info;
27 struct nand_flash_dev;
28 struct device_node;
29
30 /* Scan and identify a NAND device */
31 int nand_scan(struct mtd_info *mtd, int max_chips);
32 /*
33  * Separate phases of nand_scan(), allowing board driver to intervene
34  * and override command or ECC setup according to flash type.
35  */
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);
39
40 /* Unregister the MTD device and free resources held by the NAND device */
41 void nand_release(struct nand_chip *chip);
42
43 /* Internal helper for board drivers which need to override command function */
44 void nand_wait_ready(struct mtd_info *mtd);
45
46 /* The maximum number of NAND chips in an array */
47 #define NAND_MAX_CHIPS          8
48
49 /*
50  * Constants for hardware specific CLE/ALE/NCE function
51  *
52  * These are bits which can be or'ed to set/clear multiple
53  * bits in one go.
54  */
55 /* Select the chip by setting nCE to low */
56 #define NAND_NCE                0x01
57 /* Select the command latch by setting CLE to high */
58 #define NAND_CLE                0x02
59 /* Select the address latch by setting ALE to high */
60 #define NAND_ALE                0x04
61
62 #define NAND_CTRL_CLE           (NAND_NCE | NAND_CLE)
63 #define NAND_CTRL_ALE           (NAND_NCE | NAND_ALE)
64 #define NAND_CTRL_CHANGE        0x80
65
66 /*
67  * Standard NAND flash commands
68  */
69 #define NAND_CMD_READ0          0
70 #define NAND_CMD_READ1          1
71 #define NAND_CMD_RNDOUT         5
72 #define NAND_CMD_PAGEPROG       0x10
73 #define NAND_CMD_READOOB        0x50
74 #define NAND_CMD_ERASE1         0x60
75 #define NAND_CMD_STATUS         0x70
76 #define NAND_CMD_SEQIN          0x80
77 #define NAND_CMD_RNDIN          0x85
78 #define NAND_CMD_READID         0x90
79 #define NAND_CMD_ERASE2         0xd0
80 #define NAND_CMD_PARAM          0xec
81 #define NAND_CMD_GET_FEATURES   0xee
82 #define NAND_CMD_SET_FEATURES   0xef
83 #define NAND_CMD_RESET          0xff
84
85 /* Extended commands for large page devices */
86 #define NAND_CMD_READSTART      0x30
87 #define NAND_CMD_RNDOUTSTART    0xE0
88 #define NAND_CMD_CACHEDPROG     0x15
89
90 #define NAND_CMD_NONE           -1
91
92 /* Status bits */
93 #define NAND_STATUS_FAIL        0x01
94 #define NAND_STATUS_FAIL_N1     0x02
95 #define NAND_STATUS_TRUE_READY  0x20
96 #define NAND_STATUS_READY       0x40
97 #define NAND_STATUS_WP          0x80
98
99 #define NAND_DATA_IFACE_CHECK_ONLY      -1
100
101 /*
102  * Constants for ECC_MODES
103  */
104 typedef enum {
105         NAND_ECC_NONE,
106         NAND_ECC_SOFT,
107         NAND_ECC_HW,
108         NAND_ECC_HW_SYNDROME,
109         NAND_ECC_HW_OOB_FIRST,
110         NAND_ECC_ON_DIE,
111 } nand_ecc_modes_t;
112
113 enum nand_ecc_algo {
114         NAND_ECC_UNKNOWN,
115         NAND_ECC_HAMMING,
116         NAND_ECC_BCH,
117 };
118
119 /*
120  * Constants for Hardware ECC
121  */
122 /* Reset Hardware ECC for read */
123 #define NAND_ECC_READ           0
124 /* Reset Hardware ECC for write */
125 #define NAND_ECC_WRITE          1
126 /* Enable Hardware ECC before syndrome is read back from flash */
127 #define NAND_ECC_READSYN        2
128
129 /*
130  * Enable generic NAND 'page erased' check. This check is only done when
131  * ecc.correct() returns -EBADMSG.
132  * Set this flag if your implementation does not fix bitflips in erased
133  * pages and you want to rely on the default implementation.
134  */
135 #define NAND_ECC_GENERIC_ERASED_CHECK   BIT(0)
136 #define NAND_ECC_MAXIMIZE               BIT(1)
137 /*
138  * If your controller already sends the required NAND commands when
139  * reading or writing a page, then the framework is not supposed to
140  * send READ0 and SEQIN/PAGEPROG respectively.
141  */
142 #define NAND_ECC_CUSTOM_PAGE_ACCESS     BIT(2)
143
144 /* Bit mask for flags passed to do_nand_read_ecc */
145 #define NAND_GET_DEVICE         0x80
146
147
148 /*
149  * Option constants for bizarre disfunctionality and real
150  * features.
151  */
152 /* Buswidth is 16 bit */
153 #define NAND_BUSWIDTH_16        0x00000002
154 /* Chip has cache program function */
155 #define NAND_CACHEPRG           0x00000008
156 /*
157  * Chip requires ready check on read (for auto-incremented sequential read).
158  * True only for small page devices; large page devices do not support
159  * autoincrement.
160  */
161 #define NAND_NEED_READRDY       0x00000100
162
163 /* Chip does not allow subpage writes */
164 #define NAND_NO_SUBPAGE_WRITE   0x00000200
165
166 /* Device is one of 'new' xD cards that expose fake nand command set */
167 #define NAND_BROKEN_XD          0x00000400
168
169 /* Device behaves just like nand, but is readonly */
170 #define NAND_ROM                0x00000800
171
172 /* Device supports subpage reads */
173 #define NAND_SUBPAGE_READ       0x00001000
174
175 /*
176  * Some MLC NANDs need data scrambling to limit bitflips caused by repeated
177  * patterns.
178  */
179 #define NAND_NEED_SCRAMBLING    0x00002000
180
181 /* Options valid for Samsung large page devices */
182 #define NAND_SAMSUNG_LP_OPTIONS NAND_CACHEPRG
183
184 /* Macros to identify the above */
185 #define NAND_HAS_CACHEPROG(chip) ((chip->options & NAND_CACHEPRG))
186 #define NAND_HAS_SUBPAGE_READ(chip) ((chip->options & NAND_SUBPAGE_READ))
187 #define NAND_HAS_SUBPAGE_WRITE(chip) !((chip)->options & NAND_NO_SUBPAGE_WRITE)
188
189 /* Non chip related options */
190 /* This option skips the bbt scan during initialization. */
191 #define NAND_SKIP_BBTSCAN       0x00010000
192 /*
193  * This option is defined if the board driver allocates its own buffers
194  * (e.g. because it needs them DMA-coherent).
195  */
196 #define NAND_OWN_BUFFERS        0x00020000
197 /* Chip may not exist, so silence any errors in scan */
198 #define NAND_SCAN_SILENT_NODEV  0x00040000
199 /*
200  * Autodetect nand buswidth with readid/onfi.
201  * This suppose the driver will configure the hardware in 8 bits mode
202  * when calling nand_scan_ident, and update its configuration
203  * before calling nand_scan_tail.
204  */
205 #define NAND_BUSWIDTH_AUTO      0x00080000
206 /*
207  * This option could be defined by controller drivers to protect against
208  * kmap'ed, vmalloc'ed highmem buffers being passed from upper layers
209  */
210 #define NAND_USE_BOUNCE_BUFFER  0x00100000
211
212 /*
213  * In case your controller is implementing ->cmd_ctrl() and is relying on the
214  * default ->cmdfunc() implementation, you may want to let the core handle the
215  * tCCS delay which is required when a column change (RNDIN or RNDOUT) is
216  * requested.
217  * If your controller already takes care of this delay, you don't need to set
218  * this flag.
219  */
220 #define NAND_WAIT_TCCS          0x00200000
221
222 /* Options set by nand scan */
223 /* Nand scan has allocated controller struct */
224 #define NAND_CONTROLLER_ALLOC   0x80000000
225
226 /* Cell info constants */
227 #define NAND_CI_CHIPNR_MSK      0x03
228 #define NAND_CI_CELLTYPE_MSK    0x0C
229 #define NAND_CI_CELLTYPE_SHIFT  2
230
231 /* ONFI features */
232 #define ONFI_FEATURE_16_BIT_BUS         (1 << 0)
233 #define ONFI_FEATURE_EXT_PARAM_PAGE     (1 << 7)
234
235 /* ONFI timing mode, used in both asynchronous and synchronous mode */
236 #define ONFI_TIMING_MODE_0              (1 << 0)
237 #define ONFI_TIMING_MODE_1              (1 << 1)
238 #define ONFI_TIMING_MODE_2              (1 << 2)
239 #define ONFI_TIMING_MODE_3              (1 << 3)
240 #define ONFI_TIMING_MODE_4              (1 << 4)
241 #define ONFI_TIMING_MODE_5              (1 << 5)
242 #define ONFI_TIMING_MODE_UNKNOWN        (1 << 6)
243
244 /* ONFI feature address */
245 #define ONFI_FEATURE_ADDR_TIMING_MODE   0x1
246
247 /* Vendor-specific feature address (Micron) */
248 #define ONFI_FEATURE_ADDR_READ_RETRY    0x89
249 #define ONFI_FEATURE_ON_DIE_ECC         0x90
250 #define   ONFI_FEATURE_ON_DIE_ECC_EN    BIT(3)
251
252 /* ONFI subfeature parameters length */
253 #define ONFI_SUBFEATURE_PARAM_LEN       4
254
255 /* ONFI optional commands SET/GET FEATURES supported? */
256 #define ONFI_OPT_CMD_SET_GET_FEATURES   (1 << 2)
257
258 struct nand_onfi_params {
259         /* rev info and features block */
260         /* 'O' 'N' 'F' 'I'  */
261         u8 sig[4];
262         __le16 revision;
263         __le16 features;
264         __le16 opt_cmd;
265         u8 reserved0[2];
266         __le16 ext_param_page_length; /* since ONFI 2.1 */
267         u8 num_of_param_pages;        /* since ONFI 2.1 */
268         u8 reserved1[17];
269
270         /* manufacturer information block */
271         char manufacturer[12];
272         char model[20];
273         u8 jedec_id;
274         __le16 date_code;
275         u8 reserved2[13];
276
277         /* memory organization block */
278         __le32 byte_per_page;
279         __le16 spare_bytes_per_page;
280         __le32 data_bytes_per_ppage;
281         __le16 spare_bytes_per_ppage;
282         __le32 pages_per_block;
283         __le32 blocks_per_lun;
284         u8 lun_count;
285         u8 addr_cycles;
286         u8 bits_per_cell;
287         __le16 bb_per_lun;
288         __le16 block_endurance;
289         u8 guaranteed_good_blocks;
290         __le16 guaranteed_block_endurance;
291         u8 programs_per_page;
292         u8 ppage_attr;
293         u8 ecc_bits;
294         u8 interleaved_bits;
295         u8 interleaved_ops;
296         u8 reserved3[13];
297
298         /* electrical parameter block */
299         u8 io_pin_capacitance_max;
300         __le16 async_timing_mode;
301         __le16 program_cache_timing_mode;
302         __le16 t_prog;
303         __le16 t_bers;
304         __le16 t_r;
305         __le16 t_ccs;
306         __le16 src_sync_timing_mode;
307         u8 src_ssync_features;
308         __le16 clk_pin_capacitance_typ;
309         __le16 io_pin_capacitance_typ;
310         __le16 input_pin_capacitance_typ;
311         u8 input_pin_capacitance_max;
312         u8 driver_strength_support;
313         __le16 t_int_r;
314         __le16 t_adl;
315         u8 reserved4[8];
316
317         /* vendor */
318         __le16 vendor_revision;
319         u8 vendor[88];
320
321         __le16 crc;
322 } __packed;
323
324 #define ONFI_CRC_BASE   0x4F4E
325
326 /* Extended ECC information Block Definition (since ONFI 2.1) */
327 struct onfi_ext_ecc_info {
328         u8 ecc_bits;
329         u8 codeword_size;
330         __le16 bb_per_lun;
331         __le16 block_endurance;
332         u8 reserved[2];
333 } __packed;
334
335 #define ONFI_SECTION_TYPE_0     0       /* Unused section. */
336 #define ONFI_SECTION_TYPE_1     1       /* for additional sections. */
337 #define ONFI_SECTION_TYPE_2     2       /* for ECC information. */
338 struct onfi_ext_section {
339         u8 type;
340         u8 length;
341 } __packed;
342
343 #define ONFI_EXT_SECTION_MAX 8
344
345 /* Extended Parameter Page Definition (since ONFI 2.1) */
346 struct onfi_ext_param_page {
347         __le16 crc;
348         u8 sig[4];             /* 'E' 'P' 'P' 'S' */
349         u8 reserved0[10];
350         struct onfi_ext_section sections[ONFI_EXT_SECTION_MAX];
351
352         /*
353          * The actual size of the Extended Parameter Page is in
354          * @ext_param_page_length of nand_onfi_params{}.
355          * The following are the variable length sections.
356          * So we do not add any fields below. Please see the ONFI spec.
357          */
358 } __packed;
359
360 struct jedec_ecc_info {
361         u8 ecc_bits;
362         u8 codeword_size;
363         __le16 bb_per_lun;
364         __le16 block_endurance;
365         u8 reserved[2];
366 } __packed;
367
368 /* JEDEC features */
369 #define JEDEC_FEATURE_16_BIT_BUS        (1 << 0)
370
371 struct nand_jedec_params {
372         /* rev info and features block */
373         /* 'J' 'E' 'S' 'D'  */
374         u8 sig[4];
375         __le16 revision;
376         __le16 features;
377         u8 opt_cmd[3];
378         __le16 sec_cmd;
379         u8 num_of_param_pages;
380         u8 reserved0[18];
381
382         /* manufacturer information block */
383         char manufacturer[12];
384         char model[20];
385         u8 jedec_id[6];
386         u8 reserved1[10];
387
388         /* memory organization block */
389         __le32 byte_per_page;
390         __le16 spare_bytes_per_page;
391         u8 reserved2[6];
392         __le32 pages_per_block;
393         __le32 blocks_per_lun;
394         u8 lun_count;
395         u8 addr_cycles;
396         u8 bits_per_cell;
397         u8 programs_per_page;
398         u8 multi_plane_addr;
399         u8 multi_plane_op_attr;
400         u8 reserved3[38];
401
402         /* electrical parameter block */
403         __le16 async_sdr_speed_grade;
404         __le16 toggle_ddr_speed_grade;
405         __le16 sync_ddr_speed_grade;
406         u8 async_sdr_features;
407         u8 toggle_ddr_features;
408         u8 sync_ddr_features;
409         __le16 t_prog;
410         __le16 t_bers;
411         __le16 t_r;
412         __le16 t_r_multi_plane;
413         __le16 t_ccs;
414         __le16 io_pin_capacitance_typ;
415         __le16 input_pin_capacitance_typ;
416         __le16 clk_pin_capacitance_typ;
417         u8 driver_strength_support;
418         __le16 t_adl;
419         u8 reserved4[36];
420
421         /* ECC and endurance block */
422         u8 guaranteed_good_blocks;
423         __le16 guaranteed_block_endurance;
424         struct jedec_ecc_info ecc_info[4];
425         u8 reserved5[29];
426
427         /* reserved */
428         u8 reserved6[148];
429
430         /* vendor */
431         __le16 vendor_rev_num;
432         u8 reserved7[88];
433
434         /* CRC for Parameter Page */
435         __le16 crc;
436 } __packed;
437
438 /* The maximum expected count of bytes in the NAND ID sequence */
439 #define NAND_MAX_ID_LEN 8
440
441 /**
442  * struct nand_id - NAND id structure
443  * @data: buffer containing the id bytes.
444  * @len: ID length.
445  */
446 struct nand_id {
447         u8 data[NAND_MAX_ID_LEN];
448         int len;
449 };
450
451 /**
452  * struct nand_hw_control - Control structure for hardware controller (e.g ECC generator) shared among independent devices
453  * @lock:               protection lock
454  * @active:             the mtd device which holds the controller currently
455  * @wq:                 wait queue to sleep on if a NAND operation is in
456  *                      progress used instead of the per chip wait queue
457  *                      when a hw controller is available.
458  */
459 struct nand_hw_control {
460         spinlock_t lock;
461         struct nand_chip *active;
462         wait_queue_head_t wq;
463 };
464
465 static inline void nand_hw_control_init(struct nand_hw_control *nfc)
466 {
467         nfc->active = NULL;
468         spin_lock_init(&nfc->lock);
469         init_waitqueue_head(&nfc->wq);
470 }
471
472 /**
473  * struct nand_ecc_step_info - ECC step information of ECC engine
474  * @stepsize: data bytes per ECC step
475  * @strengths: array of supported strengths
476  * @nstrengths: number of supported strengths
477  */
478 struct nand_ecc_step_info {
479         int stepsize;
480         const int *strengths;
481         int nstrengths;
482 };
483
484 /**
485  * struct nand_ecc_caps - capability of ECC engine
486  * @stepinfos: array of ECC step information
487  * @nstepinfos: number of ECC step information
488  * @calc_ecc_bytes: driver's hook to calculate ECC bytes per step
489  */
490 struct nand_ecc_caps {
491         const struct nand_ecc_step_info *stepinfos;
492         int nstepinfos;
493         int (*calc_ecc_bytes)(int step_size, int strength);
494 };
495
496 /* a shorthand to generate struct nand_ecc_caps with only one ECC stepsize */
497 #define NAND_ECC_CAPS_SINGLE(__name, __calc, __step, ...)       \
498 static const int __name##_strengths[] = { __VA_ARGS__ };        \
499 static const struct nand_ecc_step_info __name##_stepinfo = {    \
500         .stepsize = __step,                                     \
501         .strengths = __name##_strengths,                        \
502         .nstrengths = ARRAY_SIZE(__name##_strengths),           \
503 };                                                              \
504 static const struct nand_ecc_caps __name = {                    \
505         .stepinfos = &__name##_stepinfo,                        \
506         .nstepinfos = 1,                                        \
507         .calc_ecc_bytes = __calc,                               \
508 }
509
510 /**
511  * struct nand_ecc_ctrl - Control structure for ECC
512  * @mode:       ECC mode
513  * @algo:       ECC algorithm
514  * @steps:      number of ECC steps per page
515  * @size:       data bytes per ECC step
516  * @bytes:      ECC bytes per step
517  * @strength:   max number of correctible bits per ECC step
518  * @total:      total number of ECC bytes per page
519  * @prepad:     padding information for syndrome based ECC generators
520  * @postpad:    padding information for syndrome based ECC generators
521  * @options:    ECC specific options (see NAND_ECC_XXX flags defined above)
522  * @priv:       pointer to private ECC control data
523  * @hwctl:      function to control hardware ECC generator. Must only
524  *              be provided if an hardware ECC is available
525  * @calculate:  function for ECC calculation or readback from ECC hardware
526  * @correct:    function for ECC correction, matching to ECC generator (sw/hw).
527  *              Should return a positive number representing the number of
528  *              corrected bitflips, -EBADMSG if the number of bitflips exceed
529  *              ECC strength, or any other error code if the error is not
530  *              directly related to correction.
531  *              If -EBADMSG is returned the input buffers should be left
532  *              untouched.
533  * @read_page_raw:      function to read a raw page without ECC. This function
534  *                      should hide the specific layout used by the ECC
535  *                      controller and always return contiguous in-band and
536  *                      out-of-band data even if they're not stored
537  *                      contiguously on the NAND chip (e.g.
538  *                      NAND_ECC_HW_SYNDROME interleaves in-band and
539  *                      out-of-band data).
540  * @write_page_raw:     function to write a raw page without ECC. This function
541  *                      should hide the specific layout used by the ECC
542  *                      controller and consider the passed data as contiguous
543  *                      in-band and out-of-band data. ECC controller is
544  *                      responsible for doing the appropriate transformations
545  *                      to adapt to its specific layout (e.g.
546  *                      NAND_ECC_HW_SYNDROME interleaves in-band and
547  *                      out-of-band data).
548  * @read_page:  function to read a page according to the ECC generator
549  *              requirements; returns maximum number of bitflips corrected in
550  *              any single ECC step, -EIO hw error
551  * @read_subpage:       function to read parts of the page covered by ECC;
552  *                      returns same as read_page()
553  * @write_subpage:      function to write parts of the page covered by ECC.
554  * @write_page: function to write a page according to the ECC generator
555  *              requirements.
556  * @write_oob_raw:      function to write chip OOB data without ECC
557  * @read_oob_raw:       function to read chip OOB data without ECC
558  * @read_oob:   function to read chip OOB data
559  * @write_oob:  function to write chip OOB data
560  */
561 struct nand_ecc_ctrl {
562         nand_ecc_modes_t mode;
563         enum nand_ecc_algo algo;
564         int steps;
565         int size;
566         int bytes;
567         int total;
568         int strength;
569         int prepad;
570         int postpad;
571         unsigned int options;
572         void *priv;
573         void (*hwctl)(struct mtd_info *mtd, int mode);
574         int (*calculate)(struct mtd_info *mtd, const uint8_t *dat,
575                         uint8_t *ecc_code);
576         int (*correct)(struct mtd_info *mtd, uint8_t *dat, uint8_t *read_ecc,
577                         uint8_t *calc_ecc);
578         int (*read_page_raw)(struct mtd_info *mtd, struct nand_chip *chip,
579                         uint8_t *buf, int oob_required, int page);
580         int (*write_page_raw)(struct mtd_info *mtd, struct nand_chip *chip,
581                         const uint8_t *buf, int oob_required, int page);
582         int (*read_page)(struct mtd_info *mtd, struct nand_chip *chip,
583                         uint8_t *buf, int oob_required, int page);
584         int (*read_subpage)(struct mtd_info *mtd, struct nand_chip *chip,
585                         uint32_t offs, uint32_t len, uint8_t *buf, int page);
586         int (*write_subpage)(struct mtd_info *mtd, struct nand_chip *chip,
587                         uint32_t offset, uint32_t data_len,
588                         const uint8_t *data_buf, int oob_required, int page);
589         int (*write_page)(struct mtd_info *mtd, struct nand_chip *chip,
590                         const uint8_t *buf, int oob_required, int page);
591         int (*write_oob_raw)(struct mtd_info *mtd, struct nand_chip *chip,
592                         int page);
593         int (*read_oob_raw)(struct mtd_info *mtd, struct nand_chip *chip,
594                         int page);
595         int (*read_oob)(struct mtd_info *mtd, struct nand_chip *chip, int page);
596         int (*write_oob)(struct mtd_info *mtd, struct nand_chip *chip,
597                         int page);
598 };
599
600 static inline int nand_standard_page_accessors(struct nand_ecc_ctrl *ecc)
601 {
602         return !(ecc->options & NAND_ECC_CUSTOM_PAGE_ACCESS);
603 }
604
605 /**
606  * struct nand_buffers - buffer structure for read/write
607  * @ecccalc:    buffer pointer for calculated ECC, size is oobsize.
608  * @ecccode:    buffer pointer for ECC read from flash, size is oobsize.
609  * @databuf:    buffer pointer for data, size is (page size + oobsize).
610  *
611  * Do not change the order of buffers. databuf and oobrbuf must be in
612  * consecutive order.
613  */
614 struct nand_buffers {
615         uint8_t *ecccalc;
616         uint8_t *ecccode;
617         uint8_t *databuf;
618 };
619
620 /**
621  * struct nand_sdr_timings - SDR NAND chip timings
622  *
623  * This struct defines the timing requirements of a SDR NAND chip.
624  * These information can be found in every NAND datasheets and the timings
625  * meaning are described in the ONFI specifications:
626  * www.onfi.org/~/media/ONFI/specs/onfi_3_1_spec.pdf (chapter 4.15 Timing
627  * Parameters)
628  *
629  * All these timings are expressed in picoseconds.
630  *
631  * @tBERS_max: Block erase time
632  * @tCCS_min: Change column setup time
633  * @tPROG_max: Page program time
634  * @tR_max: Page read time
635  * @tALH_min: ALE hold time
636  * @tADL_min: ALE to data loading time
637  * @tALS_min: ALE setup time
638  * @tAR_min: ALE to RE# delay
639  * @tCEA_max: CE# access time
640  * @tCEH_min: CE# high hold time
641  * @tCH_min:  CE# hold time
642  * @tCHZ_max: CE# high to output hi-Z
643  * @tCLH_min: CLE hold time
644  * @tCLR_min: CLE to RE# delay
645  * @tCLS_min: CLE setup time
646  * @tCOH_min: CE# high to output hold
647  * @tCS_min: CE# setup time
648  * @tDH_min: Data hold time
649  * @tDS_min: Data setup time
650  * @tFEAT_max: Busy time for Set Features and Get Features
651  * @tIR_min: Output hi-Z to RE# low
652  * @tITC_max: Interface and Timing Mode Change time
653  * @tRC_min: RE# cycle time
654  * @tREA_max: RE# access time
655  * @tREH_min: RE# high hold time
656  * @tRHOH_min: RE# high to output hold
657  * @tRHW_min: RE# high to WE# low
658  * @tRHZ_max: RE# high to output hi-Z
659  * @tRLOH_min: RE# low to output hold
660  * @tRP_min: RE# pulse width
661  * @tRR_min: Ready to RE# low (data only)
662  * @tRST_max: Device reset time, measured from the falling edge of R/B# to the
663  *            rising edge of R/B#.
664  * @tWB_max: WE# high to SR[6] low
665  * @tWC_min: WE# cycle time
666  * @tWH_min: WE# high hold time
667  * @tWHR_min: WE# high to RE# low
668  * @tWP_min: WE# pulse width
669  * @tWW_min: WP# transition to WE# low
670  */
671 struct nand_sdr_timings {
672         u64 tBERS_max;
673         u32 tCCS_min;
674         u64 tPROG_max;
675         u64 tR_max;
676         u32 tALH_min;
677         u32 tADL_min;
678         u32 tALS_min;
679         u32 tAR_min;
680         u32 tCEA_max;
681         u32 tCEH_min;
682         u32 tCH_min;
683         u32 tCHZ_max;
684         u32 tCLH_min;
685         u32 tCLR_min;
686         u32 tCLS_min;
687         u32 tCOH_min;
688         u32 tCS_min;
689         u32 tDH_min;
690         u32 tDS_min;
691         u32 tFEAT_max;
692         u32 tIR_min;
693         u32 tITC_max;
694         u32 tRC_min;
695         u32 tREA_max;
696         u32 tREH_min;
697         u32 tRHOH_min;
698         u32 tRHW_min;
699         u32 tRHZ_max;
700         u32 tRLOH_min;
701         u32 tRP_min;
702         u32 tRR_min;
703         u64 tRST_max;
704         u32 tWB_max;
705         u32 tWC_min;
706         u32 tWH_min;
707         u32 tWHR_min;
708         u32 tWP_min;
709         u32 tWW_min;
710 };
711
712 /**
713  * enum nand_data_interface_type - NAND interface timing type
714  * @NAND_SDR_IFACE:     Single Data Rate interface
715  */
716 enum nand_data_interface_type {
717         NAND_SDR_IFACE,
718 };
719
720 /**
721  * struct nand_data_interface - NAND interface timing
722  * @type:       type of the timing
723  * @timings:    The timing, type according to @type
724  */
725 struct nand_data_interface {
726         enum nand_data_interface_type type;
727         union {
728                 struct nand_sdr_timings sdr;
729         } timings;
730 };
731
732 /**
733  * nand_get_sdr_timings - get SDR timing from data interface
734  * @conf:       The data interface
735  */
736 static inline const struct nand_sdr_timings *
737 nand_get_sdr_timings(const struct nand_data_interface *conf)
738 {
739         if (conf->type != NAND_SDR_IFACE)
740                 return ERR_PTR(-EINVAL);
741
742         return &conf->timings.sdr;
743 }
744
745 /**
746  * struct nand_manufacturer_ops - NAND Manufacturer operations
747  * @detect: detect the NAND memory organization and capabilities
748  * @init: initialize all vendor specific fields (like the ->read_retry()
749  *        implementation) if any.
750  * @cleanup: the ->init() function may have allocated resources, ->cleanup()
751  *           is here to let vendor specific code release those resources.
752  */
753 struct nand_manufacturer_ops {
754         void (*detect)(struct nand_chip *chip);
755         int (*init)(struct nand_chip *chip);
756         void (*cleanup)(struct nand_chip *chip);
757 };
758
759 /**
760  * struct nand_chip - NAND Private Flash Chip Data
761  * @mtd:                MTD device registered to the MTD framework
762  * @IO_ADDR_R:          [BOARDSPECIFIC] address to read the 8 I/O lines of the
763  *                      flash device
764  * @IO_ADDR_W:          [BOARDSPECIFIC] address to write the 8 I/O lines of the
765  *                      flash device.
766  * @read_byte:          [REPLACEABLE] read one byte from the chip
767  * @read_word:          [REPLACEABLE] read one word from the chip
768  * @write_byte:         [REPLACEABLE] write a single byte to the chip on the
769  *                      low 8 I/O lines
770  * @write_buf:          [REPLACEABLE] write data from the buffer to the chip
771  * @read_buf:           [REPLACEABLE] read data from the chip into the buffer
772  * @select_chip:        [REPLACEABLE] select chip nr
773  * @block_bad:          [REPLACEABLE] check if a block is bad, using OOB markers
774  * @block_markbad:      [REPLACEABLE] mark a block bad
775  * @cmd_ctrl:           [BOARDSPECIFIC] hardwarespecific function for controlling
776  *                      ALE/CLE/nCE. Also used to write command and address
777  * @dev_ready:          [BOARDSPECIFIC] hardwarespecific function for accessing
778  *                      device ready/busy line. If set to NULL no access to
779  *                      ready/busy is available and the ready/busy information
780  *                      is read from the chip status register.
781  * @cmdfunc:            [REPLACEABLE] hardwarespecific function for writing
782  *                      commands to the chip.
783  * @waitfunc:           [REPLACEABLE] hardwarespecific function for wait on
784  *                      ready.
785  * @setup_read_retry:   [FLASHSPECIFIC] flash (vendor) specific function for
786  *                      setting the read-retry mode. Mostly needed for MLC NAND.
787  * @ecc:                [BOARDSPECIFIC] ECC control structure
788  * @buffers:            buffer structure for read/write
789  * @buf_align:          minimum buffer alignment required by a platform
790  * @hwcontrol:          platform-specific hardware control structure
791  * @erase:              [REPLACEABLE] erase function
792  * @scan_bbt:           [REPLACEABLE] function to scan bad block table
793  * @chip_delay:         [BOARDSPECIFIC] chip dependent delay for transferring
794  *                      data from array to read regs (tR).
795  * @state:              [INTERN] the current state of the NAND device
796  * @oob_poi:            "poison value buffer," used for laying out OOB data
797  *                      before writing
798  * @page_shift:         [INTERN] number of address bits in a page (column
799  *                      address bits).
800  * @phys_erase_shift:   [INTERN] number of address bits in a physical eraseblock
801  * @bbt_erase_shift:    [INTERN] number of address bits in a bbt entry
802  * @chip_shift:         [INTERN] number of address bits in one chip
803  * @options:            [BOARDSPECIFIC] various chip options. They can partly
804  *                      be set to inform nand_scan about special functionality.
805  *                      See the defines for further explanation.
806  * @bbt_options:        [INTERN] bad block specific options. All options used
807  *                      here must come from bbm.h. By default, these options
808  *                      will be copied to the appropriate nand_bbt_descr's.
809  * @badblockpos:        [INTERN] position of the bad block marker in the oob
810  *                      area.
811  * @badblockbits:       [INTERN] minimum number of set bits in a good block's
812  *                      bad block marker position; i.e., BBM == 11110111b is
813  *                      not bad when badblockbits == 7
814  * @bits_per_cell:      [INTERN] number of bits per cell. i.e., 1 means SLC.
815  * @ecc_strength_ds:    [INTERN] ECC correctability from the datasheet.
816  *                      Minimum amount of bit errors per @ecc_step_ds guaranteed
817  *                      to be correctable. If unknown, set to zero.
818  * @ecc_step_ds:        [INTERN] ECC step required by the @ecc_strength_ds,
819  *                      also from the datasheet. It is the recommended ECC step
820  *                      size, if known; if unknown, set to zero.
821  * @onfi_timing_mode_default: [INTERN] default ONFI timing mode. This field is
822  *                            set to the actually used ONFI mode if the chip is
823  *                            ONFI compliant or deduced from the datasheet if
824  *                            the NAND chip is not ONFI compliant.
825  * @numchips:           [INTERN] number of physical chips
826  * @chipsize:           [INTERN] the size of one chip for multichip arrays
827  * @pagemask:           [INTERN] page number mask = number of (pages / chip) - 1
828  * @pagebuf:            [INTERN] holds the pagenumber which is currently in
829  *                      data_buf.
830  * @pagebuf_bitflips:   [INTERN] holds the bitflip count for the page which is
831  *                      currently in data_buf.
832  * @subpagesize:        [INTERN] holds the subpagesize
833  * @id:                 [INTERN] holds NAND ID
834  * @onfi_version:       [INTERN] holds the chip ONFI version (BCD encoded),
835  *                      non 0 if ONFI supported.
836  * @jedec_version:      [INTERN] holds the chip JEDEC version (BCD encoded),
837  *                      non 0 if JEDEC supported.
838  * @onfi_params:        [INTERN] holds the ONFI page parameter when ONFI is
839  *                      supported, 0 otherwise.
840  * @jedec_params:       [INTERN] holds the JEDEC parameter page when JEDEC is
841  *                      supported, 0 otherwise.
842  * @max_bb_per_die:     [INTERN] the max number of bad blocks each die of a
843  *                      this nand device will encounter their life times.
844  * @blocks_per_die:     [INTERN] The number of PEBs in a die
845  * @data_interface:     [INTERN] NAND interface timing information
846  * @read_retries:       [INTERN] the number of read retry modes supported
847  * @onfi_set_features:  [REPLACEABLE] set the features for ONFI nand
848  * @onfi_get_features:  [REPLACEABLE] get the features for ONFI nand
849  * @setup_data_interface: [OPTIONAL] setup the data interface and timing. If
850  *                        chipnr is set to %NAND_DATA_IFACE_CHECK_ONLY this
851  *                        means the configuration should not be applied but
852  *                        only checked.
853  * @bbt:                [INTERN] bad block table pointer
854  * @bbt_td:             [REPLACEABLE] bad block table descriptor for flash
855  *                      lookup.
856  * @bbt_md:             [REPLACEABLE] bad block table mirror descriptor
857  * @badblock_pattern:   [REPLACEABLE] bad block scan pattern used for initial
858  *                      bad block scan.
859  * @controller:         [REPLACEABLE] a pointer to a hardware controller
860  *                      structure which is shared among multiple independent
861  *                      devices.
862  * @priv:               [OPTIONAL] pointer to private chip data
863  * @manufacturer:       [INTERN] Contains manufacturer information
864  */
865
866 struct nand_chip {
867         struct mtd_info mtd;
868         void __iomem *IO_ADDR_R;
869         void __iomem *IO_ADDR_W;
870
871         uint8_t (*read_byte)(struct mtd_info *mtd);
872         u16 (*read_word)(struct mtd_info *mtd);
873         void (*write_byte)(struct mtd_info *mtd, uint8_t byte);
874         void (*write_buf)(struct mtd_info *mtd, const uint8_t *buf, int len);
875         void (*read_buf)(struct mtd_info *mtd, uint8_t *buf, int len);
876         void (*select_chip)(struct mtd_info *mtd, int chip);
877         int (*block_bad)(struct mtd_info *mtd, loff_t ofs);
878         int (*block_markbad)(struct mtd_info *mtd, loff_t ofs);
879         void (*cmd_ctrl)(struct mtd_info *mtd, int dat, unsigned int ctrl);
880         int (*dev_ready)(struct mtd_info *mtd);
881         void (*cmdfunc)(struct mtd_info *mtd, unsigned command, int column,
882                         int page_addr);
883         int(*waitfunc)(struct mtd_info *mtd, struct nand_chip *this);
884         int (*erase)(struct mtd_info *mtd, int page);
885         int (*scan_bbt)(struct mtd_info *mtd);
886         int (*onfi_set_features)(struct mtd_info *mtd, struct nand_chip *chip,
887                         int feature_addr, uint8_t *subfeature_para);
888         int (*onfi_get_features)(struct mtd_info *mtd, struct nand_chip *chip,
889                         int feature_addr, uint8_t *subfeature_para);
890         int (*setup_read_retry)(struct mtd_info *mtd, int retry_mode);
891         int (*setup_data_interface)(struct mtd_info *mtd, int chipnr,
892                                     const struct nand_data_interface *conf);
893
894
895         int chip_delay;
896         unsigned int options;
897         unsigned int bbt_options;
898
899         int page_shift;
900         int phys_erase_shift;
901         int bbt_erase_shift;
902         int chip_shift;
903         int numchips;
904         uint64_t chipsize;
905         int pagemask;
906         int pagebuf;
907         unsigned int pagebuf_bitflips;
908         int subpagesize;
909         uint8_t bits_per_cell;
910         uint16_t ecc_strength_ds;
911         uint16_t ecc_step_ds;
912         int onfi_timing_mode_default;
913         int badblockpos;
914         int badblockbits;
915
916         struct nand_id id;
917         int onfi_version;
918         int jedec_version;
919         union {
920                 struct nand_onfi_params onfi_params;
921                 struct nand_jedec_params jedec_params;
922         };
923         u16 max_bb_per_die;
924         u32 blocks_per_die;
925
926         struct nand_data_interface *data_interface;
927
928         int read_retries;
929
930         flstate_t state;
931
932         uint8_t *oob_poi;
933         struct nand_hw_control *controller;
934
935         struct nand_ecc_ctrl ecc;
936         struct nand_buffers *buffers;
937         unsigned long buf_align;
938         struct nand_hw_control hwcontrol;
939
940         uint8_t *bbt;
941         struct nand_bbt_descr *bbt_td;
942         struct nand_bbt_descr *bbt_md;
943
944         struct nand_bbt_descr *badblock_pattern;
945
946         void *priv;
947
948         struct {
949                 const struct nand_manufacturer *desc;
950                 void *priv;
951         } manufacturer;
952 };
953
954 extern const struct mtd_ooblayout_ops nand_ooblayout_sp_ops;
955 extern const struct mtd_ooblayout_ops nand_ooblayout_lp_ops;
956
957 static inline void nand_set_flash_node(struct nand_chip *chip,
958                                        struct device_node *np)
959 {
960         mtd_set_of_node(&chip->mtd, np);
961 }
962
963 static inline struct device_node *nand_get_flash_node(struct nand_chip *chip)
964 {
965         return mtd_get_of_node(&chip->mtd);
966 }
967
968 static inline struct nand_chip *mtd_to_nand(struct mtd_info *mtd)
969 {
970         return container_of(mtd, struct nand_chip, mtd);
971 }
972
973 static inline struct mtd_info *nand_to_mtd(struct nand_chip *chip)
974 {
975         return &chip->mtd;
976 }
977
978 static inline void *nand_get_controller_data(struct nand_chip *chip)
979 {
980         return chip->priv;
981 }
982
983 static inline void nand_set_controller_data(struct nand_chip *chip, void *priv)
984 {
985         chip->priv = priv;
986 }
987
988 static inline void nand_set_manufacturer_data(struct nand_chip *chip,
989                                               void *priv)
990 {
991         chip->manufacturer.priv = priv;
992 }
993
994 static inline void *nand_get_manufacturer_data(struct nand_chip *chip)
995 {
996         return chip->manufacturer.priv;
997 }
998
999 /*
1000  * NAND Flash Manufacturer ID Codes
1001  */
1002 #define NAND_MFR_TOSHIBA        0x98
1003 #define NAND_MFR_ESMT           0xc8
1004 #define NAND_MFR_SAMSUNG        0xec
1005 #define NAND_MFR_FUJITSU        0x04
1006 #define NAND_MFR_NATIONAL       0x8f
1007 #define NAND_MFR_RENESAS        0x07
1008 #define NAND_MFR_STMICRO        0x20
1009 #define NAND_MFR_HYNIX          0xad
1010 #define NAND_MFR_MICRON         0x2c
1011 #define NAND_MFR_AMD            0x01
1012 #define NAND_MFR_MACRONIX       0xc2
1013 #define NAND_MFR_EON            0x92
1014 #define NAND_MFR_SANDISK        0x45
1015 #define NAND_MFR_INTEL          0x89
1016 #define NAND_MFR_ATO            0x9b
1017 #define NAND_MFR_WINBOND        0xef
1018
1019
1020 /*
1021  * A helper for defining older NAND chips where the second ID byte fully
1022  * defined the chip, including the geometry (chip size, eraseblock size, page
1023  * size). All these chips have 512 bytes NAND page size.
1024  */
1025 #define LEGACY_ID_NAND(nm, devid, chipsz, erasesz, opts)          \
1026         { .name = (nm), {{ .dev_id = (devid) }}, .pagesize = 512, \
1027           .chipsize = (chipsz), .erasesize = (erasesz), .options = (opts) }
1028
1029 /*
1030  * A helper for defining newer chips which report their page size and
1031  * eraseblock size via the extended ID bytes.
1032  *
1033  * The real difference between LEGACY_ID_NAND and EXTENDED_ID_NAND is that with
1034  * EXTENDED_ID_NAND, manufacturers overloaded the same device ID so that the
1035  * device ID now only represented a particular total chip size (and voltage,
1036  * buswidth), and the page size, eraseblock size, and OOB size could vary while
1037  * using the same device ID.
1038  */
1039 #define EXTENDED_ID_NAND(nm, devid, chipsz, opts)                      \
1040         { .name = (nm), {{ .dev_id = (devid) }}, .chipsize = (chipsz), \
1041           .options = (opts) }
1042
1043 #define NAND_ECC_INFO(_strength, _step) \
1044                         { .strength_ds = (_strength), .step_ds = (_step) }
1045 #define NAND_ECC_STRENGTH(type)         ((type)->ecc.strength_ds)
1046 #define NAND_ECC_STEP(type)             ((type)->ecc.step_ds)
1047
1048 /**
1049  * struct nand_flash_dev - NAND Flash Device ID Structure
1050  * @name: a human-readable name of the NAND chip
1051  * @dev_id: the device ID (the second byte of the full chip ID array)
1052  * @mfr_id: manufecturer ID part of the full chip ID array (refers the same
1053  *          memory address as @id[0])
1054  * @dev_id: device ID part of the full chip ID array (refers the same memory
1055  *          address as @id[1])
1056  * @id: full device ID array
1057  * @pagesize: size of the NAND page in bytes; if 0, then the real page size (as
1058  *            well as the eraseblock size) is determined from the extended NAND
1059  *            chip ID array)
1060  * @chipsize: total chip size in MiB
1061  * @erasesize: eraseblock size in bytes (determined from the extended ID if 0)
1062  * @options: stores various chip bit options
1063  * @id_len: The valid length of the @id.
1064  * @oobsize: OOB size
1065  * @ecc: ECC correctability and step information from the datasheet.
1066  * @ecc.strength_ds: The ECC correctability from the datasheet, same as the
1067  *                   @ecc_strength_ds in nand_chip{}.
1068  * @ecc.step_ds: The ECC step required by the @ecc.strength_ds, same as the
1069  *               @ecc_step_ds in nand_chip{}, also from the datasheet.
1070  *               For example, the "4bit ECC for each 512Byte" can be set with
1071  *               NAND_ECC_INFO(4, 512).
1072  * @onfi_timing_mode_default: the default ONFI timing mode entered after a NAND
1073  *                            reset. Should be deduced from timings described
1074  *                            in the datasheet.
1075  *
1076  */
1077 struct nand_flash_dev {
1078         char *name;
1079         union {
1080                 struct {
1081                         uint8_t mfr_id;
1082                         uint8_t dev_id;
1083                 };
1084                 uint8_t id[NAND_MAX_ID_LEN];
1085         };
1086         unsigned int pagesize;
1087         unsigned int chipsize;
1088         unsigned int erasesize;
1089         unsigned int options;
1090         uint16_t id_len;
1091         uint16_t oobsize;
1092         struct {
1093                 uint16_t strength_ds;
1094                 uint16_t step_ds;
1095         } ecc;
1096         int onfi_timing_mode_default;
1097 };
1098
1099 /**
1100  * struct nand_manufacturer - NAND Flash Manufacturer structure
1101  * @name:       Manufacturer name
1102  * @id:         manufacturer ID code of device.
1103  * @ops:        manufacturer operations
1104 */
1105 struct nand_manufacturer {
1106         int id;
1107         char *name;
1108         const struct nand_manufacturer_ops *ops;
1109 };
1110
1111 const struct nand_manufacturer *nand_get_manufacturer(u8 id);
1112
1113 static inline const char *
1114 nand_manufacturer_name(const struct nand_manufacturer *manufacturer)
1115 {
1116         return manufacturer ? manufacturer->name : "Unknown";
1117 }
1118
1119 extern struct nand_flash_dev nand_flash_ids[];
1120
1121 extern const struct nand_manufacturer_ops toshiba_nand_manuf_ops;
1122 extern const struct nand_manufacturer_ops samsung_nand_manuf_ops;
1123 extern const struct nand_manufacturer_ops hynix_nand_manuf_ops;
1124 extern const struct nand_manufacturer_ops micron_nand_manuf_ops;
1125 extern const struct nand_manufacturer_ops amd_nand_manuf_ops;
1126 extern const struct nand_manufacturer_ops macronix_nand_manuf_ops;
1127
1128 int nand_default_bbt(struct mtd_info *mtd);
1129 int nand_markbad_bbt(struct mtd_info *mtd, loff_t offs);
1130 int nand_isreserved_bbt(struct mtd_info *mtd, loff_t offs);
1131 int nand_isbad_bbt(struct mtd_info *mtd, loff_t offs, int allowbbt);
1132 int nand_erase_nand(struct mtd_info *mtd, struct erase_info *instr,
1133                     int allowbbt);
1134 int nand_do_read(struct mtd_info *mtd, loff_t from, size_t len,
1135                  size_t *retlen, uint8_t *buf);
1136
1137 /**
1138  * struct platform_nand_chip - chip level device structure
1139  * @nr_chips:           max. number of chips to scan for
1140  * @chip_offset:        chip number offset
1141  * @nr_partitions:      number of partitions pointed to by partitions (or zero)
1142  * @partitions:         mtd partition list
1143  * @chip_delay:         R/B delay value in us
1144  * @options:            Option flags, e.g. 16bit buswidth
1145  * @bbt_options:        BBT option flags, e.g. NAND_BBT_USE_FLASH
1146  * @part_probe_types:   NULL-terminated array of probe types
1147  */
1148 struct platform_nand_chip {
1149         int nr_chips;
1150         int chip_offset;
1151         int nr_partitions;
1152         struct mtd_partition *partitions;
1153         int chip_delay;
1154         unsigned int options;
1155         unsigned int bbt_options;
1156         const char **part_probe_types;
1157 };
1158
1159 /* Keep gcc happy */
1160 struct platform_device;
1161
1162 /**
1163  * struct platform_nand_ctrl - controller level device structure
1164  * @probe:              platform specific function to probe/setup hardware
1165  * @remove:             platform specific function to remove/teardown hardware
1166  * @hwcontrol:          platform specific hardware control structure
1167  * @dev_ready:          platform specific function to read ready/busy pin
1168  * @select_chip:        platform specific chip select function
1169  * @cmd_ctrl:           platform specific function for controlling
1170  *                      ALE/CLE/nCE. Also used to write command and address
1171  * @write_buf:          platform specific function for write buffer
1172  * @read_buf:           platform specific function for read buffer
1173  * @read_byte:          platform specific function to read one byte from chip
1174  * @priv:               private data to transport driver specific settings
1175  *
1176  * All fields are optional and depend on the hardware driver requirements
1177  */
1178 struct platform_nand_ctrl {
1179         int (*probe)(struct platform_device *pdev);
1180         void (*remove)(struct platform_device *pdev);
1181         void (*hwcontrol)(struct mtd_info *mtd, int cmd);
1182         int (*dev_ready)(struct mtd_info *mtd);
1183         void (*select_chip)(struct mtd_info *mtd, int chip);
1184         void (*cmd_ctrl)(struct mtd_info *mtd, int dat, unsigned int ctrl);
1185         void (*write_buf)(struct mtd_info *mtd, const uint8_t *buf, int len);
1186         void (*read_buf)(struct mtd_info *mtd, uint8_t *buf, int len);
1187         unsigned char (*read_byte)(struct mtd_info *mtd);
1188         void *priv;
1189 };
1190
1191 /**
1192  * struct platform_nand_data - container structure for platform-specific data
1193  * @chip:               chip level chip structure
1194  * @ctrl:               controller level device structure
1195  */
1196 struct platform_nand_data {
1197         struct platform_nand_chip chip;
1198         struct platform_nand_ctrl ctrl;
1199 };
1200
1201 /* return the supported features. */
1202 static inline int onfi_feature(struct nand_chip *chip)
1203 {
1204         return chip->onfi_version ? le16_to_cpu(chip->onfi_params.features) : 0;
1205 }
1206
1207 /* return the supported asynchronous timing mode. */
1208 static inline int onfi_get_async_timing_mode(struct nand_chip *chip)
1209 {
1210         if (!chip->onfi_version)
1211                 return ONFI_TIMING_MODE_UNKNOWN;
1212         return le16_to_cpu(chip->onfi_params.async_timing_mode);
1213 }
1214
1215 /* return the supported synchronous timing mode. */
1216 static inline int onfi_get_sync_timing_mode(struct nand_chip *chip)
1217 {
1218         if (!chip->onfi_version)
1219                 return ONFI_TIMING_MODE_UNKNOWN;
1220         return le16_to_cpu(chip->onfi_params.src_sync_timing_mode);
1221 }
1222
1223 int onfi_init_data_interface(struct nand_chip *chip,
1224                              struct nand_data_interface *iface,
1225                              enum nand_data_interface_type type,
1226                              int timing_mode);
1227
1228 /*
1229  * Check if it is a SLC nand.
1230  * The !nand_is_slc() can be used to check the MLC/TLC nand chips.
1231  * We do not distinguish the MLC and TLC now.
1232  */
1233 static inline bool nand_is_slc(struct nand_chip *chip)
1234 {
1235         WARN(chip->bits_per_cell == 0,
1236              "chip->bits_per_cell is used uninitialized\n");
1237         return chip->bits_per_cell == 1;
1238 }
1239
1240 /**
1241  * Check if the opcode's address should be sent only on the lower 8 bits
1242  * @command: opcode to check
1243  */
1244 static inline int nand_opcode_8bits(unsigned int command)
1245 {
1246         switch (command) {
1247         case NAND_CMD_READID:
1248         case NAND_CMD_PARAM:
1249         case NAND_CMD_GET_FEATURES:
1250         case NAND_CMD_SET_FEATURES:
1251                 return 1;
1252         default:
1253                 break;
1254         }
1255         return 0;
1256 }
1257
1258 /* return the supported JEDEC features. */
1259 static inline int jedec_feature(struct nand_chip *chip)
1260 {
1261         return chip->jedec_version ? le16_to_cpu(chip->jedec_params.features)
1262                 : 0;
1263 }
1264
1265 /* get timing characteristics from ONFI timing mode. */
1266 const struct nand_sdr_timings *onfi_async_timing_mode_to_sdr_timings(int mode);
1267 /* get data interface from ONFI timing mode 0, used after reset. */
1268 const struct nand_data_interface *nand_get_default_data_interface(void);
1269
1270 int nand_check_erased_ecc_chunk(void *data, int datalen,
1271                                 void *ecc, int ecclen,
1272                                 void *extraoob, int extraooblen,
1273                                 int threshold);
1274
1275 int nand_check_ecc_caps(struct nand_chip *chip,
1276                         const struct nand_ecc_caps *caps, int oobavail);
1277
1278 int nand_match_ecc_req(struct nand_chip *chip,
1279                        const struct nand_ecc_caps *caps,  int oobavail);
1280
1281 int nand_maximize_ecc(struct nand_chip *chip,
1282                       const struct nand_ecc_caps *caps, int oobavail);
1283
1284 /* Default write_oob implementation */
1285 int nand_write_oob_std(struct mtd_info *mtd, struct nand_chip *chip, int page);
1286
1287 /* Default write_oob syndrome implementation */
1288 int nand_write_oob_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
1289                             int page);
1290
1291 /* Default read_oob implementation */
1292 int nand_read_oob_std(struct mtd_info *mtd, struct nand_chip *chip, int page);
1293
1294 /* Default read_oob syndrome implementation */
1295 int nand_read_oob_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
1296                            int page);
1297
1298 /* Stub used by drivers that do not support GET/SET FEATURES operations */
1299 int nand_onfi_get_set_features_notsupp(struct mtd_info *mtd,
1300                                        struct nand_chip *chip, int addr,
1301                                        u8 *subfeature_param);
1302
1303 /* Default read_page_raw implementation */
1304 int nand_read_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
1305                        uint8_t *buf, int oob_required, int page);
1306
1307 /* Default write_page_raw implementation */
1308 int nand_write_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
1309                         const uint8_t *buf, int oob_required, int page);
1310
1311 /* Reset and initialize a NAND device */
1312 int nand_reset(struct nand_chip *chip, int chipnr);
1313
1314 /* Free resources held by the NAND device */
1315 void nand_cleanup(struct nand_chip *chip);
1316
1317 /* Default extended ID decoding function */
1318 void nand_decode_ext_id(struct nand_chip *chip);
1319 #endif /* __LINUX_MTD_RAWNAND_H */