1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * Copyright © 2000-2010 David Woodhouse <dwmw2@infradead.org>
4 * Steven J. Hill <sjhill@realitydiluted.com>
5 * Thomas Gleixner <tglx@linutronix.de>
8 * Contains standard defines and IDs for NAND flash devices
13 #ifndef __LINUX_MTD_RAWNAND_H
14 #define __LINUX_MTD_RAWNAND_H
16 #include <linux/mtd/mtd.h>
17 #include <linux/mtd/flashchip.h>
18 #include <linux/mtd/bbm.h>
19 #include <linux/mtd/jedec.h>
20 #include <linux/mtd/nand.h>
21 #include <linux/mtd/onfi.h>
22 #include <linux/mutex.h>
24 #include <linux/types.h>
28 /* The maximum number of NAND chips in an array */
29 #define NAND_MAX_CHIPS 8
32 * Constants for hardware specific CLE/ALE/NCE function
34 * These are bits which can be or'ed to set/clear multiple
37 /* Select the chip by setting nCE to low */
39 /* Select the command latch by setting CLE to high */
41 /* Select the address latch by setting ALE to high */
44 #define NAND_CTRL_CLE (NAND_NCE | NAND_CLE)
45 #define NAND_CTRL_ALE (NAND_NCE | NAND_ALE)
46 #define NAND_CTRL_CHANGE 0x80
49 * Standard NAND flash commands
51 #define NAND_CMD_READ0 0
52 #define NAND_CMD_READ1 1
53 #define NAND_CMD_RNDOUT 5
54 #define NAND_CMD_PAGEPROG 0x10
55 #define NAND_CMD_READOOB 0x50
56 #define NAND_CMD_ERASE1 0x60
57 #define NAND_CMD_STATUS 0x70
58 #define NAND_CMD_SEQIN 0x80
59 #define NAND_CMD_RNDIN 0x85
60 #define NAND_CMD_READID 0x90
61 #define NAND_CMD_ERASE2 0xd0
62 #define NAND_CMD_PARAM 0xec
63 #define NAND_CMD_GET_FEATURES 0xee
64 #define NAND_CMD_SET_FEATURES 0xef
65 #define NAND_CMD_RESET 0xff
67 /* Extended commands for large page devices */
68 #define NAND_CMD_READSTART 0x30
69 #define NAND_CMD_RNDOUTSTART 0xE0
70 #define NAND_CMD_CACHEDPROG 0x15
72 #define NAND_CMD_NONE -1
75 #define NAND_STATUS_FAIL 0x01
76 #define NAND_STATUS_FAIL_N1 0x02
77 #define NAND_STATUS_TRUE_READY 0x20
78 #define NAND_STATUS_READY 0x40
79 #define NAND_STATUS_WP 0x80
81 #define NAND_DATA_IFACE_CHECK_ONLY -1
84 * Constants for ECC_MODES
96 * Constants for Hardware ECC
98 /* Reset Hardware ECC for read */
99 #define NAND_ECC_READ 0
100 /* Reset Hardware ECC for write */
101 #define NAND_ECC_WRITE 1
102 /* Enable Hardware ECC before syndrome is read back from flash */
103 #define NAND_ECC_READSYN 2
106 * Enable generic NAND 'page erased' check. This check is only done when
107 * ecc.correct() returns -EBADMSG.
108 * Set this flag if your implementation does not fix bitflips in erased
109 * pages and you want to rely on the default implementation.
111 #define NAND_ECC_GENERIC_ERASED_CHECK BIT(0)
112 #define NAND_ECC_MAXIMIZE BIT(1)
115 * Option constants for bizarre disfunctionality and real
119 /* Buswidth is 16 bit */
120 #define NAND_BUSWIDTH_16 BIT(1)
123 * When using software implementation of Hamming, we can specify which byte
124 * ordering should be used.
126 #define NAND_ECC_SOFT_HAMMING_SM_ORDER BIT(2)
128 /* Chip has cache program function */
129 #define NAND_CACHEPRG BIT(3)
130 /* Options valid for Samsung large page devices */
131 #define NAND_SAMSUNG_LP_OPTIONS NAND_CACHEPRG
134 * Chip requires ready check on read (for auto-incremented sequential read).
135 * True only for small page devices; large page devices do not support
138 #define NAND_NEED_READRDY BIT(8)
140 /* Chip does not allow subpage writes */
141 #define NAND_NO_SUBPAGE_WRITE BIT(9)
143 /* Device is one of 'new' xD cards that expose fake nand command set */
144 #define NAND_BROKEN_XD BIT(10)
146 /* Device behaves just like nand, but is readonly */
147 #define NAND_ROM BIT(11)
149 /* Device supports subpage reads */
150 #define NAND_SUBPAGE_READ BIT(12)
151 /* Macros to identify the above */
152 #define NAND_HAS_SUBPAGE_READ(chip) ((chip->options & NAND_SUBPAGE_READ))
155 * Some MLC NANDs need data scrambling to limit bitflips caused by repeated
158 #define NAND_NEED_SCRAMBLING BIT(13)
160 /* Device needs 3rd row address cycle */
161 #define NAND_ROW_ADDR_3 BIT(14)
163 /* Non chip related options */
164 /* This option skips the bbt scan during initialization. */
165 #define NAND_SKIP_BBTSCAN BIT(16)
166 /* Chip may not exist, so silence any errors in scan */
167 #define NAND_SCAN_SILENT_NODEV BIT(18)
170 * Autodetect nand buswidth with readid/onfi.
171 * This suppose the driver will configure the hardware in 8 bits mode
172 * when calling nand_scan_ident, and update its configuration
173 * before calling nand_scan_tail.
175 #define NAND_BUSWIDTH_AUTO BIT(19)
178 * This option could be defined by controller drivers to protect against
179 * kmap'ed, vmalloc'ed highmem buffers being passed from upper layers
181 #define NAND_USES_DMA BIT(20)
184 * In case your controller is implementing ->legacy.cmd_ctrl() and is relying
185 * on the default ->cmdfunc() implementation, you may want to let the core
186 * handle the tCCS delay which is required when a column change (RNDIN or
187 * RNDOUT) is requested.
188 * If your controller already takes care of this delay, you don't need to set
191 #define NAND_WAIT_TCCS BIT(21)
194 * Whether the NAND chip is a boot medium. Drivers might use this information
195 * to select ECC algorithms supported by the boot ROM or similar restrictions.
197 #define NAND_IS_BOOT_MEDIUM BIT(22)
200 * Do not try to tweak the timings at runtime. This is needed when the
201 * controller initializes the timings on itself or when it relies on
202 * configuration done by the bootloader.
204 #define NAND_KEEP_TIMINGS BIT(23)
207 * There are different places where the manufacturer stores the factory bad
210 * Position within the block: Each of these pages needs to be checked for a
211 * bad block marking pattern.
213 #define NAND_BBM_FIRSTPAGE BIT(24)
214 #define NAND_BBM_SECONDPAGE BIT(25)
215 #define NAND_BBM_LASTPAGE BIT(26)
218 * Some controllers with pipelined ECC engines override the BBM marker with
219 * data or ECC bytes, thus making bad block detection through bad block marker
220 * impossible. Let's flag those chips so the core knows it shouldn't check the
221 * BBM and consider all blocks good.
223 #define NAND_NO_BBM_QUIRK BIT(27)
225 /* Cell info constants */
226 #define NAND_CI_CHIPNR_MSK 0x03
227 #define NAND_CI_CELLTYPE_MSK 0x0C
228 #define NAND_CI_CELLTYPE_SHIFT 2
230 /* Position within the OOB data of the page */
231 #define NAND_BBM_POS_SMALL 5
232 #define NAND_BBM_POS_LARGE 0
235 * struct nand_parameters - NAND generic parameters from the parameter page
237 * @supports_set_get_features: The NAND chip supports setting/getting features
238 * @set_feature_list: Bitmap of features that can be set
239 * @get_feature_list: Bitmap of features that can be get
240 * @onfi: ONFI specific parameters
242 struct nand_parameters {
243 /* Generic parameters */
245 bool supports_set_get_features;
246 DECLARE_BITMAP(set_feature_list, ONFI_FEATURE_NUMBER);
247 DECLARE_BITMAP(get_feature_list, ONFI_FEATURE_NUMBER);
249 /* ONFI parameters */
250 struct onfi_params *onfi;
253 /* The maximum expected count of bytes in the NAND ID sequence */
254 #define NAND_MAX_ID_LEN 8
257 * struct nand_id - NAND id structure
258 * @data: buffer containing the id bytes.
262 u8 data[NAND_MAX_ID_LEN];
267 * struct nand_ecc_step_info - ECC step information of ECC engine
268 * @stepsize: data bytes per ECC step
269 * @strengths: array of supported strengths
270 * @nstrengths: number of supported strengths
272 struct nand_ecc_step_info {
274 const int *strengths;
279 * struct nand_ecc_caps - capability of ECC engine
280 * @stepinfos: array of ECC step information
281 * @nstepinfos: number of ECC step information
282 * @calc_ecc_bytes: driver's hook to calculate ECC bytes per step
284 struct nand_ecc_caps {
285 const struct nand_ecc_step_info *stepinfos;
287 int (*calc_ecc_bytes)(int step_size, int strength);
290 /* a shorthand to generate struct nand_ecc_caps with only one ECC stepsize */
291 #define NAND_ECC_CAPS_SINGLE(__name, __calc, __step, ...) \
292 static const int __name##_strengths[] = { __VA_ARGS__ }; \
293 static const struct nand_ecc_step_info __name##_stepinfo = { \
294 .stepsize = __step, \
295 .strengths = __name##_strengths, \
296 .nstrengths = ARRAY_SIZE(__name##_strengths), \
298 static const struct nand_ecc_caps __name = { \
299 .stepinfos = &__name##_stepinfo, \
301 .calc_ecc_bytes = __calc, \
305 * struct nand_ecc_ctrl - Control structure for ECC
306 * @engine_type: ECC engine type
307 * @placement: OOB bytes placement
308 * @algo: ECC algorithm
309 * @steps: number of ECC steps per page
310 * @size: data bytes per ECC step
311 * @bytes: ECC bytes per step
312 * @strength: max number of correctible bits per ECC step
313 * @total: total number of ECC bytes per page
314 * @prepad: padding information for syndrome based ECC generators
315 * @postpad: padding information for syndrome based ECC generators
316 * @options: ECC specific options (see NAND_ECC_XXX flags defined above)
317 * @priv: pointer to private ECC control data
318 * @calc_buf: buffer for calculated ECC, size is oobsize.
319 * @code_buf: buffer for ECC read from flash, size is oobsize.
320 * @hwctl: function to control hardware ECC generator. Must only
321 * be provided if an hardware ECC is available
322 * @calculate: function for ECC calculation or readback from ECC hardware
323 * @correct: function for ECC correction, matching to ECC generator (sw/hw).
324 * Should return a positive number representing the number of
325 * corrected bitflips, -EBADMSG if the number of bitflips exceed
326 * ECC strength, or any other error code if the error is not
327 * directly related to correction.
328 * If -EBADMSG is returned the input buffers should be left
330 * @read_page_raw: function to read a raw page without ECC. This function
331 * should hide the specific layout used by the ECC
332 * controller and always return contiguous in-band and
333 * out-of-band data even if they're not stored
334 * contiguously on the NAND chip (e.g.
335 * NAND_ECC_PLACEMENT_INTERLEAVED interleaves in-band and
337 * @write_page_raw: function to write a raw page without ECC. This function
338 * should hide the specific layout used by the ECC
339 * controller and consider the passed data as contiguous
340 * in-band and out-of-band data. ECC controller is
341 * responsible for doing the appropriate transformations
342 * to adapt to its specific layout (e.g.
343 * NAND_ECC_PLACEMENT_INTERLEAVED interleaves in-band and
345 * @read_page: function to read a page according to the ECC generator
346 * requirements; returns maximum number of bitflips corrected in
347 * any single ECC step, -EIO hw error
348 * @read_subpage: function to read parts of the page covered by ECC;
349 * returns same as read_page()
350 * @write_subpage: function to write parts of the page covered by ECC.
351 * @write_page: function to write a page according to the ECC generator
353 * @write_oob_raw: function to write chip OOB data without ECC
354 * @read_oob_raw: function to read chip OOB data without ECC
355 * @read_oob: function to read chip OOB data
356 * @write_oob: function to write chip OOB data
358 struct nand_ecc_ctrl {
359 enum nand_ecc_engine_type engine_type;
360 enum nand_ecc_placement placement;
361 enum nand_ecc_algo algo;
369 unsigned int options;
373 void (*hwctl)(struct nand_chip *chip, int mode);
374 int (*calculate)(struct nand_chip *chip, const uint8_t *dat,
376 int (*correct)(struct nand_chip *chip, uint8_t *dat, uint8_t *read_ecc,
378 int (*read_page_raw)(struct nand_chip *chip, uint8_t *buf,
379 int oob_required, int page);
380 int (*write_page_raw)(struct nand_chip *chip, const uint8_t *buf,
381 int oob_required, int page);
382 int (*read_page)(struct nand_chip *chip, uint8_t *buf,
383 int oob_required, int page);
384 int (*read_subpage)(struct nand_chip *chip, uint32_t offs,
385 uint32_t len, uint8_t *buf, int page);
386 int (*write_subpage)(struct nand_chip *chip, uint32_t offset,
387 uint32_t data_len, const uint8_t *data_buf,
388 int oob_required, int page);
389 int (*write_page)(struct nand_chip *chip, const uint8_t *buf,
390 int oob_required, int page);
391 int (*write_oob_raw)(struct nand_chip *chip, int page);
392 int (*read_oob_raw)(struct nand_chip *chip, int page);
393 int (*read_oob)(struct nand_chip *chip, int page);
394 int (*write_oob)(struct nand_chip *chip, int page);
398 * struct nand_sdr_timings - SDR NAND chip timings
400 * This struct defines the timing requirements of a SDR NAND chip.
401 * These information can be found in every NAND datasheets and the timings
402 * meaning are described in the ONFI specifications:
403 * www.onfi.org/~/media/ONFI/specs/onfi_3_1_spec.pdf (chapter 4.15 Timing
406 * All these timings are expressed in picoseconds.
408 * @tBERS_max: Block erase time
409 * @tCCS_min: Change column setup time
410 * @tPROG_max: Page program time
411 * @tR_max: Page read time
412 * @tALH_min: ALE hold time
413 * @tADL_min: ALE to data loading time
414 * @tALS_min: ALE setup time
415 * @tAR_min: ALE to RE# delay
416 * @tCEA_max: CE# access time
417 * @tCEH_min: CE# high hold time
418 * @tCH_min: CE# hold time
419 * @tCHZ_max: CE# high to output hi-Z
420 * @tCLH_min: CLE hold time
421 * @tCLR_min: CLE to RE# delay
422 * @tCLS_min: CLE setup time
423 * @tCOH_min: CE# high to output hold
424 * @tCS_min: CE# setup time
425 * @tDH_min: Data hold time
426 * @tDS_min: Data setup time
427 * @tFEAT_max: Busy time for Set Features and Get Features
428 * @tIR_min: Output hi-Z to RE# low
429 * @tITC_max: Interface and Timing Mode Change time
430 * @tRC_min: RE# cycle time
431 * @tREA_max: RE# access time
432 * @tREH_min: RE# high hold time
433 * @tRHOH_min: RE# high to output hold
434 * @tRHW_min: RE# high to WE# low
435 * @tRHZ_max: RE# high to output hi-Z
436 * @tRLOH_min: RE# low to output hold
437 * @tRP_min: RE# pulse width
438 * @tRR_min: Ready to RE# low (data only)
439 * @tRST_max: Device reset time, measured from the falling edge of R/B# to the
440 * rising edge of R/B#.
441 * @tWB_max: WE# high to SR[6] low
442 * @tWC_min: WE# cycle time
443 * @tWH_min: WE# high hold time
444 * @tWHR_min: WE# high to RE# low
445 * @tWP_min: WE# pulse width
446 * @tWW_min: WP# transition to WE# low
448 struct nand_sdr_timings {
490 * enum nand_interface_type - NAND interface type
491 * @NAND_SDR_IFACE: Single Data Rate interface
493 enum nand_interface_type {
498 * struct nand_interface_config - NAND interface timing
499 * @type: type of the timing
500 * @timings: The timing information
501 * @timings.mode: Timing mode as defined in the specification
502 * @timings.sdr: Use it when @type is %NAND_SDR_IFACE.
504 struct nand_interface_config {
505 enum nand_interface_type type;
506 struct nand_timings {
509 struct nand_sdr_timings sdr;
515 * nand_get_sdr_timings - get SDR timing from data interface
516 * @conf: The data interface
518 static inline const struct nand_sdr_timings *
519 nand_get_sdr_timings(const struct nand_interface_config *conf)
521 if (conf->type != NAND_SDR_IFACE)
522 return ERR_PTR(-EINVAL);
524 return &conf->timings.sdr;
528 * struct nand_op_cmd_instr - Definition of a command instruction
529 * @opcode: the command to issue in one cycle
531 struct nand_op_cmd_instr {
536 * struct nand_op_addr_instr - Definition of an address instruction
537 * @naddrs: length of the @addrs array
538 * @addrs: array containing the address cycles to issue
540 struct nand_op_addr_instr {
546 * struct nand_op_data_instr - Definition of a data instruction
547 * @len: number of data bytes to move
548 * @buf: buffer to fill
549 * @buf.in: buffer to fill when reading from the NAND chip
550 * @buf.out: buffer to read from when writing to the NAND chip
551 * @force_8bit: force 8-bit access
553 * Please note that "in" and "out" are inverted from the ONFI specification
554 * and are from the controller perspective, so a "in" is a read from the NAND
555 * chip while a "out" is a write to the NAND chip.
557 struct nand_op_data_instr {
567 * struct nand_op_waitrdy_instr - Definition of a wait ready instruction
568 * @timeout_ms: maximum delay while waiting for the ready/busy pin in ms
570 struct nand_op_waitrdy_instr {
571 unsigned int timeout_ms;
575 * enum nand_op_instr_type - Definition of all instruction types
576 * @NAND_OP_CMD_INSTR: command instruction
577 * @NAND_OP_ADDR_INSTR: address instruction
578 * @NAND_OP_DATA_IN_INSTR: data in instruction
579 * @NAND_OP_DATA_OUT_INSTR: data out instruction
580 * @NAND_OP_WAITRDY_INSTR: wait ready instruction
582 enum nand_op_instr_type {
585 NAND_OP_DATA_IN_INSTR,
586 NAND_OP_DATA_OUT_INSTR,
587 NAND_OP_WAITRDY_INSTR,
591 * struct nand_op_instr - Instruction object
592 * @type: the instruction type
593 * @ctx: extra data associated to the instruction. You'll have to use the
594 * appropriate element depending on @type
595 * @ctx.cmd: use it if @type is %NAND_OP_CMD_INSTR
596 * @ctx.addr: use it if @type is %NAND_OP_ADDR_INSTR
597 * @ctx.data: use it if @type is %NAND_OP_DATA_IN_INSTR
598 * or %NAND_OP_DATA_OUT_INSTR
599 * @ctx.waitrdy: use it if @type is %NAND_OP_WAITRDY_INSTR
600 * @delay_ns: delay the controller should apply after the instruction has been
601 * issued on the bus. Most modern controllers have internal timings
602 * control logic, and in this case, the controller driver can ignore
605 struct nand_op_instr {
606 enum nand_op_instr_type type;
608 struct nand_op_cmd_instr cmd;
609 struct nand_op_addr_instr addr;
610 struct nand_op_data_instr data;
611 struct nand_op_waitrdy_instr waitrdy;
613 unsigned int delay_ns;
617 * Special handling must be done for the WAITRDY timeout parameter as it usually
618 * is either tPROG (after a prog), tR (before a read), tRST (during a reset) or
619 * tBERS (during an erase) which all of them are u64 values that cannot be
620 * divided by usual kernel macros and must be handled with the special
621 * DIV_ROUND_UP_ULL() macro.
623 * Cast to type of dividend is needed here to guarantee that the result won't
624 * be an unsigned long long when the dividend is an unsigned long (or smaller),
625 * which is what the compiler does when it sees ternary operator with 2
626 * different return types (picks the largest type to make sure there's no
629 #define __DIVIDE(dividend, divisor) ({ \
630 (__typeof__(dividend))(sizeof(dividend) <= sizeof(unsigned long) ? \
631 DIV_ROUND_UP(dividend, divisor) : \
632 DIV_ROUND_UP_ULL(dividend, divisor)); \
634 #define PSEC_TO_NSEC(x) __DIVIDE(x, 1000)
635 #define PSEC_TO_MSEC(x) __DIVIDE(x, 1000000000)
637 #define NAND_OP_CMD(id, ns) \
639 .type = NAND_OP_CMD_INSTR, \
640 .ctx.cmd.opcode = id, \
644 #define NAND_OP_ADDR(ncycles, cycles, ns) \
646 .type = NAND_OP_ADDR_INSTR, \
654 #define NAND_OP_DATA_IN(l, b, ns) \
656 .type = NAND_OP_DATA_IN_INSTR, \
660 .force_8bit = false, \
665 #define NAND_OP_DATA_OUT(l, b, ns) \
667 .type = NAND_OP_DATA_OUT_INSTR, \
671 .force_8bit = false, \
676 #define NAND_OP_8BIT_DATA_IN(l, b, ns) \
678 .type = NAND_OP_DATA_IN_INSTR, \
682 .force_8bit = true, \
687 #define NAND_OP_8BIT_DATA_OUT(l, b, ns) \
689 .type = NAND_OP_DATA_OUT_INSTR, \
693 .force_8bit = true, \
698 #define NAND_OP_WAIT_RDY(tout_ms, ns) \
700 .type = NAND_OP_WAITRDY_INSTR, \
701 .ctx.waitrdy.timeout_ms = tout_ms, \
706 * struct nand_subop - a sub operation
707 * @cs: the CS line to select for this NAND sub-operation
708 * @instrs: array of instructions
709 * @ninstrs: length of the @instrs array
710 * @first_instr_start_off: offset to start from for the first instruction
711 * of the sub-operation
712 * @last_instr_end_off: offset to end at (excluded) for the last instruction
713 * of the sub-operation
715 * Both @first_instr_start_off and @last_instr_end_off only apply to data or
716 * address instructions.
718 * When an operation cannot be handled as is by the NAND controller, it will
719 * be split by the parser into sub-operations which will be passed to the
724 const struct nand_op_instr *instrs;
725 unsigned int ninstrs;
726 unsigned int first_instr_start_off;
727 unsigned int last_instr_end_off;
730 unsigned int nand_subop_get_addr_start_off(const struct nand_subop *subop,
732 unsigned int nand_subop_get_num_addr_cyc(const struct nand_subop *subop,
734 unsigned int nand_subop_get_data_start_off(const struct nand_subop *subop,
736 unsigned int nand_subop_get_data_len(const struct nand_subop *subop,
740 * struct nand_op_parser_addr_constraints - Constraints for address instructions
741 * @maxcycles: maximum number of address cycles the controller can issue in a
744 struct nand_op_parser_addr_constraints {
745 unsigned int maxcycles;
749 * struct nand_op_parser_data_constraints - Constraints for data instructions
750 * @maxlen: maximum data length that the controller can handle in a single step
752 struct nand_op_parser_data_constraints {
757 * struct nand_op_parser_pattern_elem - One element of a pattern
758 * @type: the instructuction type
759 * @optional: whether this element of the pattern is optional or mandatory
760 * @ctx: address or data constraint
761 * @ctx.addr: address constraint (number of cycles)
762 * @ctx.data: data constraint (data length)
764 struct nand_op_parser_pattern_elem {
765 enum nand_op_instr_type type;
768 struct nand_op_parser_addr_constraints addr;
769 struct nand_op_parser_data_constraints data;
773 #define NAND_OP_PARSER_PAT_CMD_ELEM(_opt) \
775 .type = NAND_OP_CMD_INSTR, \
779 #define NAND_OP_PARSER_PAT_ADDR_ELEM(_opt, _maxcycles) \
781 .type = NAND_OP_ADDR_INSTR, \
783 .ctx.addr.maxcycles = _maxcycles, \
786 #define NAND_OP_PARSER_PAT_DATA_IN_ELEM(_opt, _maxlen) \
788 .type = NAND_OP_DATA_IN_INSTR, \
790 .ctx.data.maxlen = _maxlen, \
793 #define NAND_OP_PARSER_PAT_DATA_OUT_ELEM(_opt, _maxlen) \
795 .type = NAND_OP_DATA_OUT_INSTR, \
797 .ctx.data.maxlen = _maxlen, \
800 #define NAND_OP_PARSER_PAT_WAITRDY_ELEM(_opt) \
802 .type = NAND_OP_WAITRDY_INSTR, \
807 * struct nand_op_parser_pattern - NAND sub-operation pattern descriptor
808 * @elems: array of pattern elements
809 * @nelems: number of pattern elements in @elems array
810 * @exec: the function that will issue a sub-operation
812 * A pattern is a list of elements, each element reprensenting one instruction
813 * with its constraints. The pattern itself is used by the core to match NAND
814 * chip operation with NAND controller operations.
815 * Once a match between a NAND controller operation pattern and a NAND chip
816 * operation (or a sub-set of a NAND operation) is found, the pattern ->exec()
817 * hook is called so that the controller driver can issue the operation on the
820 * Controller drivers should declare as many patterns as they support and pass
821 * this list of patterns (created with the help of the following macro) to
822 * the nand_op_parser_exec_op() helper.
824 struct nand_op_parser_pattern {
825 const struct nand_op_parser_pattern_elem *elems;
827 int (*exec)(struct nand_chip *chip, const struct nand_subop *subop);
830 #define NAND_OP_PARSER_PATTERN(_exec, ...) \
833 .elems = (const struct nand_op_parser_pattern_elem[]) { __VA_ARGS__ }, \
834 .nelems = sizeof((struct nand_op_parser_pattern_elem[]) { __VA_ARGS__ }) / \
835 sizeof(struct nand_op_parser_pattern_elem), \
839 * struct nand_op_parser - NAND controller operation parser descriptor
840 * @patterns: array of supported patterns
841 * @npatterns: length of the @patterns array
843 * The parser descriptor is just an array of supported patterns which will be
844 * iterated by nand_op_parser_exec_op() everytime it tries to execute an
845 * NAND operation (or tries to determine if a specific operation is supported).
847 * It is worth mentioning that patterns will be tested in their declaration
848 * order, and the first match will be taken, so it's important to order patterns
849 * appropriately so that simple/inefficient patterns are placed at the end of
850 * the list. Usually, this is where you put single instruction patterns.
852 struct nand_op_parser {
853 const struct nand_op_parser_pattern *patterns;
854 unsigned int npatterns;
857 #define NAND_OP_PARSER(...) \
859 .patterns = (const struct nand_op_parser_pattern[]) { __VA_ARGS__ }, \
860 .npatterns = sizeof((struct nand_op_parser_pattern[]) { __VA_ARGS__ }) / \
861 sizeof(struct nand_op_parser_pattern), \
865 * struct nand_operation - NAND operation descriptor
866 * @cs: the CS line to select for this NAND operation
867 * @instrs: array of instructions to execute
868 * @ninstrs: length of the @instrs array
870 * The actual operation structure that will be passed to chip->exec_op().
872 struct nand_operation {
874 const struct nand_op_instr *instrs;
875 unsigned int ninstrs;
878 #define NAND_OPERATION(_cs, _instrs) \
882 .ninstrs = ARRAY_SIZE(_instrs), \
885 int nand_op_parser_exec_op(struct nand_chip *chip,
886 const struct nand_op_parser *parser,
887 const struct nand_operation *op, bool check_only);
889 static inline void nand_op_trace(const char *prefix,
890 const struct nand_op_instr *instr)
892 #if IS_ENABLED(CONFIG_DYNAMIC_DEBUG) || defined(DEBUG)
893 switch (instr->type) {
894 case NAND_OP_CMD_INSTR:
895 pr_debug("%sCMD [0x%02x]\n", prefix,
896 instr->ctx.cmd.opcode);
898 case NAND_OP_ADDR_INSTR:
899 pr_debug("%sADDR [%d cyc: %*ph]\n", prefix,
900 instr->ctx.addr.naddrs,
901 instr->ctx.addr.naddrs < 64 ?
902 instr->ctx.addr.naddrs : 64,
903 instr->ctx.addr.addrs);
905 case NAND_OP_DATA_IN_INSTR:
906 pr_debug("%sDATA_IN [%d B%s]\n", prefix,
908 instr->ctx.data.force_8bit ?
909 ", force 8-bit" : "");
911 case NAND_OP_DATA_OUT_INSTR:
912 pr_debug("%sDATA_OUT [%d B%s]\n", prefix,
914 instr->ctx.data.force_8bit ?
915 ", force 8-bit" : "");
917 case NAND_OP_WAITRDY_INSTR:
918 pr_debug("%sWAITRDY [max %d ms]\n", prefix,
919 instr->ctx.waitrdy.timeout_ms);
926 * struct nand_controller_ops - Controller operations
928 * @attach_chip: this method is called after the NAND detection phase after
929 * flash ID and MTD fields such as erase size, page size and OOB
930 * size have been set up. ECC requirements are available if
931 * provided by the NAND chip or device tree. Typically used to
932 * choose the appropriate ECC configuration and allocate
933 * associated resources.
934 * This hook is optional.
935 * @detach_chip: free all resources allocated/claimed in
936 * nand_controller_ops->attach_chip().
937 * This hook is optional.
938 * @exec_op: controller specific method to execute NAND operations.
939 * This method replaces chip->legacy.cmdfunc(),
940 * chip->legacy.{read,write}_{buf,byte,word}(),
941 * chip->legacy.dev_ready() and chip->legacy.waifunc().
942 * @setup_interface: setup the data interface and timing. If chipnr is set to
943 * %NAND_DATA_IFACE_CHECK_ONLY this means the configuration
944 * should not be applied but only checked.
945 * This hook is optional.
947 struct nand_controller_ops {
948 int (*attach_chip)(struct nand_chip *chip);
949 void (*detach_chip)(struct nand_chip *chip);
950 int (*exec_op)(struct nand_chip *chip,
951 const struct nand_operation *op,
953 int (*setup_interface)(struct nand_chip *chip, int chipnr,
954 const struct nand_interface_config *conf);
958 * struct nand_controller - Structure used to describe a NAND controller
960 * @lock: lock used to serialize accesses to the NAND controller
961 * @ops: NAND controller operations.
963 struct nand_controller {
965 const struct nand_controller_ops *ops;
968 static inline void nand_controller_init(struct nand_controller *nfc)
970 mutex_init(&nfc->lock);
974 * struct nand_legacy - NAND chip legacy fields/hooks
975 * @IO_ADDR_R: address to read the 8 I/O lines of the flash device
976 * @IO_ADDR_W: address to write the 8 I/O lines of the flash device
977 * @select_chip: select/deselect a specific target/die
978 * @read_byte: read one byte from the chip
979 * @write_byte: write a single byte to the chip on the low 8 I/O lines
980 * @write_buf: write data from the buffer to the chip
981 * @read_buf: read data from the chip into the buffer
982 * @cmd_ctrl: hardware specific function for controlling ALE/CLE/nCE. Also used
983 * to write command and address
984 * @cmdfunc: hardware specific function for writing commands to the chip.
985 * @dev_ready: hardware specific function for accessing device ready/busy line.
986 * If set to NULL no access to ready/busy is available and the
987 * ready/busy information is read from the chip status register.
988 * @waitfunc: hardware specific function for wait on ready.
989 * @block_bad: check if a block is bad, using OOB markers
990 * @block_markbad: mark a block bad
991 * @set_features: set the NAND chip features
992 * @get_features: get the NAND chip features
993 * @chip_delay: chip dependent delay for transferring data from array to read
995 * @dummy_controller: dummy controller implementation for drivers that can
996 * only control a single chip
998 * If you look at this structure you're already wrong. These fields/hooks are
1001 struct nand_legacy {
1002 void __iomem *IO_ADDR_R;
1003 void __iomem *IO_ADDR_W;
1004 void (*select_chip)(struct nand_chip *chip, int cs);
1005 u8 (*read_byte)(struct nand_chip *chip);
1006 void (*write_byte)(struct nand_chip *chip, u8 byte);
1007 void (*write_buf)(struct nand_chip *chip, const u8 *buf, int len);
1008 void (*read_buf)(struct nand_chip *chip, u8 *buf, int len);
1009 void (*cmd_ctrl)(struct nand_chip *chip, int dat, unsigned int ctrl);
1010 void (*cmdfunc)(struct nand_chip *chip, unsigned command, int column,
1012 int (*dev_ready)(struct nand_chip *chip);
1013 int (*waitfunc)(struct nand_chip *chip);
1014 int (*block_bad)(struct nand_chip *chip, loff_t ofs);
1015 int (*block_markbad)(struct nand_chip *chip, loff_t ofs);
1016 int (*set_features)(struct nand_chip *chip, int feature_addr,
1017 u8 *subfeature_para);
1018 int (*get_features)(struct nand_chip *chip, int feature_addr,
1019 u8 *subfeature_para);
1021 struct nand_controller dummy_controller;
1025 * struct nand_chip_ops - NAND chip operations
1026 * @suspend: Suspend operation
1027 * @resume: Resume operation
1028 * @lock_area: Lock operation
1029 * @unlock_area: Unlock operation
1030 * @setup_read_retry: Set the read-retry mode (mostly needed for MLC NANDs)
1031 * @choose_interface_config: Choose the best interface configuration
1033 struct nand_chip_ops {
1034 int (*suspend)(struct nand_chip *chip);
1035 void (*resume)(struct nand_chip *chip);
1036 int (*lock_area)(struct nand_chip *chip, loff_t ofs, uint64_t len);
1037 int (*unlock_area)(struct nand_chip *chip, loff_t ofs, uint64_t len);
1038 int (*setup_read_retry)(struct nand_chip *chip, int retry_mode);
1039 int (*choose_interface_config)(struct nand_chip *chip,
1040 struct nand_interface_config *iface);
1044 * struct nand_manufacturer - NAND manufacturer structure
1045 * @desc: The manufacturer description
1046 * @priv: Private information for the manufacturer driver
1048 struct nand_manufacturer {
1049 const struct nand_manufacturer_desc *desc;
1054 * struct nand_chip - NAND Private Flash Chip Data
1055 * @base: Inherit from the generic NAND device
1056 * @id: Holds NAND ID
1057 * @parameters: Holds generic parameters under an easily readable form
1058 * @manufacturer: Manufacturer information
1059 * @ops: NAND chip operations
1060 * @legacy: All legacy fields/hooks. If you develop a new driver, don't even try
1061 * to use any of these fields/hooks, and if you're modifying an
1062 * existing driver that is using those fields/hooks, you should
1063 * consider reworking the driver and avoid using them.
1064 * @options: Various chip options. They can partly be set to inform nand_scan
1065 * about special functionality. See the defines for further
1067 * @current_interface_config: The currently used NAND interface configuration
1068 * @best_interface_config: The best NAND interface configuration which fits both
1069 * the NAND chip and NAND controller constraints. If
1070 * unset, the default reset interface configuration must
1072 * @bbt_erase_shift: Number of address bits in a bbt entry
1073 * @bbt_options: Bad block table specific options. All options used here must
1074 * come from bbm.h. By default, these options will be copied to
1075 * the appropriate nand_bbt_descr's.
1076 * @badblockpos: Bad block marker position in the oob area
1077 * @badblockbits: Minimum number of set bits in a good block's bad block marker
1078 * position; i.e., BBM = 11110111b is good when badblockbits = 7
1079 * @bbt_td: Bad block table descriptor for flash lookup
1080 * @bbt_md: Bad block table mirror descriptor
1081 * @badblock_pattern: Bad block scan pattern used for initial bad block scan
1082 * @bbt: Bad block table pointer
1083 * @page_shift: Number of address bits in a page (column address bits)
1084 * @phys_erase_shift: Number of address bits in a physical eraseblock
1085 * @chip_shift: Number of address bits in one chip
1086 * @pagemask: Page number mask = number of (pages / chip) - 1
1087 * @subpagesize: Holds the subpagesize
1088 * @data_buf: Buffer for data, size is (page size + oobsize)
1089 * @oob_poi: pointer on the OOB area covered by data_buf
1090 * @pagecache: Structure containing page cache related fields
1091 * @pagecache.bitflips: Number of bitflips of the cached page
1092 * @pagecache.page: Page number currently in the cache. -1 means no page is
1094 * @buf_align: Minimum buffer alignment required by a platform
1095 * @lock: Lock protecting the suspended field. Also used to serialize accesses
1096 * to the NAND device
1097 * @suspended: Set to 1 when the device is suspended, 0 when it's not
1098 * @cur_cs: Currently selected target. -1 means no target selected, otherwise we
1099 * should always have cur_cs >= 0 && cur_cs < nanddev_ntargets().
1100 * NAND Controller drivers should not modify this value, but they're
1101 * allowed to read it.
1102 * @read_retries: The number of read retry modes supported
1103 * @controller: The hardware controller structure which is shared among multiple
1104 * independent devices
1105 * @ecc: The ECC controller structure
1106 * @priv: Chip private data
1109 struct nand_device base;
1111 struct nand_parameters parameters;
1112 struct nand_manufacturer manufacturer;
1113 struct nand_chip_ops ops;
1114 struct nand_legacy legacy;
1115 unsigned int options;
1117 /* Data interface */
1118 const struct nand_interface_config *current_interface_config;
1119 struct nand_interface_config *best_interface_config;
1121 /* Bad block information */
1122 unsigned int bbt_erase_shift;
1123 unsigned int bbt_options;
1124 unsigned int badblockpos;
1125 unsigned int badblockbits;
1126 struct nand_bbt_descr *bbt_td;
1127 struct nand_bbt_descr *bbt_md;
1128 struct nand_bbt_descr *badblock_pattern;
1131 /* Device internal layout */
1132 unsigned int page_shift;
1133 unsigned int phys_erase_shift;
1134 unsigned int chip_shift;
1135 unsigned int pagemask;
1136 unsigned int subpagesize;
1142 unsigned int bitflips;
1145 unsigned long buf_align;
1149 unsigned int suspended : 1;
1154 struct nand_controller *controller;
1155 struct nand_ecc_ctrl ecc;
1159 extern const struct mtd_ooblayout_ops nand_ooblayout_sp_ops;
1160 extern const struct mtd_ooblayout_ops nand_ooblayout_lp_ops;
1162 static inline struct nand_chip *mtd_to_nand(struct mtd_info *mtd)
1164 return container_of(mtd, struct nand_chip, base.mtd);
1167 static inline struct mtd_info *nand_to_mtd(struct nand_chip *chip)
1169 return &chip->base.mtd;
1172 static inline void *nand_get_controller_data(struct nand_chip *chip)
1177 static inline void nand_set_controller_data(struct nand_chip *chip, void *priv)
1182 static inline void nand_set_manufacturer_data(struct nand_chip *chip,
1185 chip->manufacturer.priv = priv;
1188 static inline void *nand_get_manufacturer_data(struct nand_chip *chip)
1190 return chip->manufacturer.priv;
1193 static inline void nand_set_flash_node(struct nand_chip *chip,
1194 struct device_node *np)
1196 mtd_set_of_node(nand_to_mtd(chip), np);
1199 static inline struct device_node *nand_get_flash_node(struct nand_chip *chip)
1201 return mtd_get_of_node(nand_to_mtd(chip));
1205 * nand_get_interface_config - Retrieve the current interface configuration
1207 * @chip: The NAND chip
1209 static inline const struct nand_interface_config *
1210 nand_get_interface_config(struct nand_chip *chip)
1212 return chip->current_interface_config;
1216 * A helper for defining older NAND chips where the second ID byte fully
1217 * defined the chip, including the geometry (chip size, eraseblock size, page
1218 * size). All these chips have 512 bytes NAND page size.
1220 #define LEGACY_ID_NAND(nm, devid, chipsz, erasesz, opts) \
1221 { .name = (nm), {{ .dev_id = (devid) }}, .pagesize = 512, \
1222 .chipsize = (chipsz), .erasesize = (erasesz), .options = (opts) }
1225 * A helper for defining newer chips which report their page size and
1226 * eraseblock size via the extended ID bytes.
1228 * The real difference between LEGACY_ID_NAND and EXTENDED_ID_NAND is that with
1229 * EXTENDED_ID_NAND, manufacturers overloaded the same device ID so that the
1230 * device ID now only represented a particular total chip size (and voltage,
1231 * buswidth), and the page size, eraseblock size, and OOB size could vary while
1232 * using the same device ID.
1234 #define EXTENDED_ID_NAND(nm, devid, chipsz, opts) \
1235 { .name = (nm), {{ .dev_id = (devid) }}, .chipsize = (chipsz), \
1238 #define NAND_ECC_INFO(_strength, _step) \
1239 { .strength_ds = (_strength), .step_ds = (_step) }
1240 #define NAND_ECC_STRENGTH(type) ((type)->ecc.strength_ds)
1241 #define NAND_ECC_STEP(type) ((type)->ecc.step_ds)
1244 * struct nand_flash_dev - NAND Flash Device ID Structure
1245 * @name: a human-readable name of the NAND chip
1246 * @dev_id: the device ID (the second byte of the full chip ID array)
1247 * @mfr_id: manufacturer ID part of the full chip ID array (refers the same
1248 * memory address as ``id[0]``)
1249 * @dev_id: device ID part of the full chip ID array (refers the same memory
1250 * address as ``id[1]``)
1251 * @id: full device ID array
1252 * @pagesize: size of the NAND page in bytes; if 0, then the real page size (as
1253 * well as the eraseblock size) is determined from the extended NAND
1255 * @chipsize: total chip size in MiB
1256 * @erasesize: eraseblock size in bytes (determined from the extended ID if 0)
1257 * @options: stores various chip bit options
1258 * @id_len: The valid length of the @id.
1259 * @oobsize: OOB size
1260 * @ecc: ECC correctability and step information from the datasheet.
1261 * @ecc.strength_ds: The ECC correctability from the datasheet, same as the
1262 * @ecc_strength_ds in nand_chip{}.
1263 * @ecc.step_ds: The ECC step required by the @ecc.strength_ds, same as the
1264 * @ecc_step_ds in nand_chip{}, also from the datasheet.
1265 * For example, the "4bit ECC for each 512Byte" can be set with
1266 * NAND_ECC_INFO(4, 512).
1268 struct nand_flash_dev {
1275 uint8_t id[NAND_MAX_ID_LEN];
1277 unsigned int pagesize;
1278 unsigned int chipsize;
1279 unsigned int erasesize;
1280 unsigned int options;
1284 uint16_t strength_ds;
1289 int nand_create_bbt(struct nand_chip *chip);
1292 * Check if it is a SLC nand.
1293 * The !nand_is_slc() can be used to check the MLC/TLC nand chips.
1294 * We do not distinguish the MLC and TLC now.
1296 static inline bool nand_is_slc(struct nand_chip *chip)
1298 WARN(nanddev_bits_per_cell(&chip->base) == 0,
1299 "chip->bits_per_cell is used uninitialized\n");
1300 return nanddev_bits_per_cell(&chip->base) == 1;
1304 * Check if the opcode's address should be sent only on the lower 8 bits
1305 * @command: opcode to check
1307 static inline int nand_opcode_8bits(unsigned int command)
1310 case NAND_CMD_READID:
1311 case NAND_CMD_PARAM:
1312 case NAND_CMD_GET_FEATURES:
1313 case NAND_CMD_SET_FEATURES:
1321 int nand_check_erased_ecc_chunk(void *data, int datalen,
1322 void *ecc, int ecclen,
1323 void *extraoob, int extraooblen,
1326 int nand_ecc_choose_conf(struct nand_chip *chip,
1327 const struct nand_ecc_caps *caps, int oobavail);
1329 /* Default write_oob implementation */
1330 int nand_write_oob_std(struct nand_chip *chip, int page);
1332 /* Default read_oob implementation */
1333 int nand_read_oob_std(struct nand_chip *chip, int page);
1335 /* Stub used by drivers that do not support GET/SET FEATURES operations */
1336 int nand_get_set_features_notsupp(struct nand_chip *chip, int addr,
1337 u8 *subfeature_param);
1339 /* read_page_raw implementations */
1340 int nand_read_page_raw(struct nand_chip *chip, uint8_t *buf, int oob_required,
1342 int nand_monolithic_read_page_raw(struct nand_chip *chip, uint8_t *buf,
1343 int oob_required, int page);
1345 /* write_page_raw implementations */
1346 int nand_write_page_raw(struct nand_chip *chip, const uint8_t *buf,
1347 int oob_required, int page);
1348 int nand_monolithic_write_page_raw(struct nand_chip *chip, const uint8_t *buf,
1349 int oob_required, int page);
1351 /* Reset and initialize a NAND device */
1352 int nand_reset(struct nand_chip *chip, int chipnr);
1354 /* NAND operation helpers */
1355 int nand_reset_op(struct nand_chip *chip);
1356 int nand_readid_op(struct nand_chip *chip, u8 addr, void *buf,
1358 int nand_status_op(struct nand_chip *chip, u8 *status);
1359 int nand_erase_op(struct nand_chip *chip, unsigned int eraseblock);
1360 int nand_read_page_op(struct nand_chip *chip, unsigned int page,
1361 unsigned int offset_in_page, void *buf, unsigned int len);
1362 int nand_change_read_column_op(struct nand_chip *chip,
1363 unsigned int offset_in_page, void *buf,
1364 unsigned int len, bool force_8bit);
1365 int nand_read_oob_op(struct nand_chip *chip, unsigned int page,
1366 unsigned int offset_in_page, void *buf, unsigned int len);
1367 int nand_prog_page_begin_op(struct nand_chip *chip, unsigned int page,
1368 unsigned int offset_in_page, const void *buf,
1370 int nand_prog_page_end_op(struct nand_chip *chip);
1371 int nand_prog_page_op(struct nand_chip *chip, unsigned int page,
1372 unsigned int offset_in_page, const void *buf,
1374 int nand_change_write_column_op(struct nand_chip *chip,
1375 unsigned int offset_in_page, const void *buf,
1376 unsigned int len, bool force_8bit);
1377 int nand_read_data_op(struct nand_chip *chip, void *buf, unsigned int len,
1378 bool force_8bit, bool check_only);
1379 int nand_write_data_op(struct nand_chip *chip, const void *buf,
1380 unsigned int len, bool force_8bit);
1382 /* Scan and identify a NAND device */
1383 int nand_scan_with_ids(struct nand_chip *chip, unsigned int max_chips,
1384 struct nand_flash_dev *ids);
1386 static inline int nand_scan(struct nand_chip *chip, unsigned int max_chips)
1388 return nand_scan_with_ids(chip, max_chips, NULL);
1391 /* Internal helper for board drivers which need to override command function */
1392 void nand_wait_ready(struct nand_chip *chip);
1395 * Free resources held by the NAND device, must be called on error after a
1396 * sucessful nand_scan().
1398 void nand_cleanup(struct nand_chip *chip);
1401 * External helper for controller drivers that have to implement the WAITRDY
1402 * instruction and have no physical pin to check it.
1404 int nand_soft_waitrdy(struct nand_chip *chip, unsigned long timeout_ms);
1406 int nand_gpio_waitrdy(struct nand_chip *chip, struct gpio_desc *gpiod,
1407 unsigned long timeout_ms);
1409 /* Select/deselect a NAND target. */
1410 void nand_select_target(struct nand_chip *chip, unsigned int cs);
1411 void nand_deselect_target(struct nand_chip *chip);
1414 void nand_extract_bits(u8 *dst, unsigned int dst_off, const u8 *src,
1415 unsigned int src_off, unsigned int nbits);
1418 * nand_get_data_buf() - Get the internal page buffer
1419 * @chip: NAND chip object
1421 * Returns the pre-allocated page buffer after invalidating the cache. This
1422 * function should be used by drivers that do not want to allocate their own
1423 * bounce buffer and still need such a buffer for specific operations (most
1424 * commonly when reading OOB data only).
1426 * Be careful to never call this function in the write/write_oob path, because
1427 * the core may have placed the data to be written out in this buffer.
1429 * Return: pointer to the page cache buffer
1431 static inline void *nand_get_data_buf(struct nand_chip *chip)
1433 chip->pagecache.page = -1;
1435 return chip->data_buf;
1438 #endif /* __LINUX_MTD_RAWNAND_H */