1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) 2000 Steven J. Hill (sjhill@realitydiluted.com)
4 * 2002-2006 Thomas Gleixner (tglx@linutronix.de)
7 * David Woodhouse for adding multichip support
9 * Aleph One Ltd. and Toby Churchill Ltd. for supporting the
10 * rework for 2K page size chips
12 * This file contains all legacy helpers/code that should be removed
16 #include <linux/delay.h>
18 #include <linux/nmi.h>
20 #include "internals.h"
23 * nand_read_byte - [DEFAULT] read one byte from the chip
24 * @chip: NAND chip object
26 * Default read function for 8bit buswidth
28 static uint8_t nand_read_byte(struct nand_chip
*chip
)
30 return readb(chip
->legacy
.IO_ADDR_R
);
34 * nand_read_byte16 - [DEFAULT] read one byte endianness aware from the chip
35 * @chip: NAND chip object
37 * Default read function for 16bit buswidth with endianness conversion.
40 static uint8_t nand_read_byte16(struct nand_chip
*chip
)
42 return (uint8_t) cpu_to_le16(readw(chip
->legacy
.IO_ADDR_R
));
46 * nand_select_chip - [DEFAULT] control CE line
47 * @chip: NAND chip object
48 * @chipnr: chipnumber to select, -1 for deselect
50 * Default select function for 1 chip devices.
52 static void nand_select_chip(struct nand_chip
*chip
, int chipnr
)
56 chip
->legacy
.cmd_ctrl(chip
, NAND_CMD_NONE
,
57 0 | NAND_CTRL_CHANGE
);
68 * nand_write_byte - [DEFAULT] write single byte to chip
69 * @chip: NAND chip object
70 * @byte: value to write
72 * Default function to write a byte to I/O[7:0]
74 static void nand_write_byte(struct nand_chip
*chip
, uint8_t byte
)
76 chip
->legacy
.write_buf(chip
, &byte
, 1);
80 * nand_write_byte16 - [DEFAULT] write single byte to a chip with width 16
81 * @chip: NAND chip object
82 * @byte: value to write
84 * Default function to write a byte to I/O[7:0] on a 16-bit wide chip.
86 static void nand_write_byte16(struct nand_chip
*chip
, uint8_t byte
)
91 * It's not entirely clear what should happen to I/O[15:8] when writing
92 * a byte. The ONFi spec (Revision 3.1; 2012-09-19, Section 2.16) reads:
94 * When the host supports a 16-bit bus width, only data is
95 * transferred at the 16-bit width. All address and command line
96 * transfers shall use only the lower 8-bits of the data bus. During
97 * command transfers, the host may place any value on the upper
98 * 8-bits of the data bus. During address transfers, the host shall
99 * set the upper 8-bits of the data bus to 00h.
101 * One user of the write_byte callback is nand_set_features. The
102 * four parameters are specified to be written to I/O[7:0], but this is
103 * neither an address nor a command transfer. Let's assume a 0 on the
104 * upper I/O lines is OK.
106 chip
->legacy
.write_buf(chip
, (uint8_t *)&word
, 2);
110 * nand_write_buf - [DEFAULT] write buffer to chip
111 * @chip: NAND chip object
113 * @len: number of bytes to write
115 * Default write function for 8bit buswidth.
117 static void nand_write_buf(struct nand_chip
*chip
, const uint8_t *buf
, int len
)
119 iowrite8_rep(chip
->legacy
.IO_ADDR_W
, buf
, len
);
123 * nand_read_buf - [DEFAULT] read chip data into buffer
124 * @chip: NAND chip object
125 * @buf: buffer to store date
126 * @len: number of bytes to read
128 * Default read function for 8bit buswidth.
130 static void nand_read_buf(struct nand_chip
*chip
, uint8_t *buf
, int len
)
132 ioread8_rep(chip
->legacy
.IO_ADDR_R
, buf
, len
);
136 * nand_write_buf16 - [DEFAULT] write buffer to chip
137 * @chip: NAND chip object
139 * @len: number of bytes to write
141 * Default write function for 16bit buswidth.
143 static void nand_write_buf16(struct nand_chip
*chip
, const uint8_t *buf
,
146 u16
*p
= (u16
*) buf
;
148 iowrite16_rep(chip
->legacy
.IO_ADDR_W
, p
, len
>> 1);
152 * nand_read_buf16 - [DEFAULT] read chip data into buffer
153 * @chip: NAND chip object
154 * @buf: buffer to store date
155 * @len: number of bytes to read
157 * Default read function for 16bit buswidth.
159 static void nand_read_buf16(struct nand_chip
*chip
, uint8_t *buf
, int len
)
161 u16
*p
= (u16
*) buf
;
163 ioread16_rep(chip
->legacy
.IO_ADDR_R
, p
, len
>> 1);
167 * panic_nand_wait_ready - [GENERIC] Wait for the ready pin after commands.
168 * @chip: NAND chip object
171 * Helper function for nand_wait_ready used when needing to wait in interrupt
174 static void panic_nand_wait_ready(struct nand_chip
*chip
, unsigned long timeo
)
178 /* Wait for the device to get ready */
179 for (i
= 0; i
< timeo
; i
++) {
180 if (chip
->legacy
.dev_ready(chip
))
182 touch_softlockup_watchdog();
188 * nand_wait_ready - [GENERIC] Wait for the ready pin after commands.
189 * @chip: NAND chip object
191 * Wait for the ready pin after a command, and warn if a timeout occurs.
193 void nand_wait_ready(struct nand_chip
*chip
)
195 struct mtd_info
*mtd
= nand_to_mtd(chip
);
196 unsigned long timeo
= 400;
198 if (mtd
->oops_panic_write
)
199 return panic_nand_wait_ready(chip
, timeo
);
201 /* Wait until command is processed or timeout occurs */
202 timeo
= jiffies
+ msecs_to_jiffies(timeo
);
204 if (chip
->legacy
.dev_ready(chip
))
207 } while (time_before(jiffies
, timeo
));
209 if (!chip
->legacy
.dev_ready(chip
))
210 pr_warn_ratelimited("timeout while waiting for chip to become ready\n");
212 EXPORT_SYMBOL_GPL(nand_wait_ready
);
215 * nand_wait_status_ready - [GENERIC] Wait for the ready status after commands.
216 * @chip: NAND chip object
217 * @timeo: Timeout in ms
219 * Wait for status ready (i.e. command done) or timeout.
221 static void nand_wait_status_ready(struct nand_chip
*chip
, unsigned long timeo
)
225 timeo
= jiffies
+ msecs_to_jiffies(timeo
);
229 ret
= nand_read_data_op(chip
, &status
, sizeof(status
), true,
234 if (status
& NAND_STATUS_READY
)
236 touch_softlockup_watchdog();
237 } while (time_before(jiffies
, timeo
));
241 * nand_command - [DEFAULT] Send command to NAND device
242 * @chip: NAND chip object
243 * @command: the command to be sent
244 * @column: the column address for this command, -1 if none
245 * @page_addr: the page address for this command, -1 if none
247 * Send command to NAND device. This function is used for small page devices
248 * (512 Bytes per page).
250 static void nand_command(struct nand_chip
*chip
, unsigned int command
,
251 int column
, int page_addr
)
253 struct mtd_info
*mtd
= nand_to_mtd(chip
);
254 int ctrl
= NAND_CTRL_CLE
| NAND_CTRL_CHANGE
;
256 /* Write out the command to the device */
257 if (command
== NAND_CMD_SEQIN
) {
260 if (column
>= mtd
->writesize
) {
262 column
-= mtd
->writesize
;
263 readcmd
= NAND_CMD_READOOB
;
264 } else if (column
< 256) {
265 /* First 256 bytes --> READ0 */
266 readcmd
= NAND_CMD_READ0
;
269 readcmd
= NAND_CMD_READ1
;
271 chip
->legacy
.cmd_ctrl(chip
, readcmd
, ctrl
);
272 ctrl
&= ~NAND_CTRL_CHANGE
;
274 if (command
!= NAND_CMD_NONE
)
275 chip
->legacy
.cmd_ctrl(chip
, command
, ctrl
);
277 /* Address cycle, when necessary */
278 ctrl
= NAND_CTRL_ALE
| NAND_CTRL_CHANGE
;
279 /* Serially input address */
281 /* Adjust columns for 16 bit buswidth */
282 if (chip
->options
& NAND_BUSWIDTH_16
&&
283 !nand_opcode_8bits(command
))
285 chip
->legacy
.cmd_ctrl(chip
, column
, ctrl
);
286 ctrl
&= ~NAND_CTRL_CHANGE
;
288 if (page_addr
!= -1) {
289 chip
->legacy
.cmd_ctrl(chip
, page_addr
, ctrl
);
290 ctrl
&= ~NAND_CTRL_CHANGE
;
291 chip
->legacy
.cmd_ctrl(chip
, page_addr
>> 8, ctrl
);
292 if (chip
->options
& NAND_ROW_ADDR_3
)
293 chip
->legacy
.cmd_ctrl(chip
, page_addr
>> 16, ctrl
);
295 chip
->legacy
.cmd_ctrl(chip
, NAND_CMD_NONE
,
296 NAND_NCE
| NAND_CTRL_CHANGE
);
299 * Program and erase have their own busy handlers status and sequential
305 case NAND_CMD_PAGEPROG
:
306 case NAND_CMD_ERASE1
:
307 case NAND_CMD_ERASE2
:
309 case NAND_CMD_STATUS
:
310 case NAND_CMD_READID
:
311 case NAND_CMD_SET_FEATURES
:
315 if (chip
->legacy
.dev_ready
)
317 udelay(chip
->legacy
.chip_delay
);
318 chip
->legacy
.cmd_ctrl(chip
, NAND_CMD_STATUS
,
319 NAND_CTRL_CLE
| NAND_CTRL_CHANGE
);
320 chip
->legacy
.cmd_ctrl(chip
, NAND_CMD_NONE
,
321 NAND_NCE
| NAND_CTRL_CHANGE
);
322 /* EZ-NAND can take upto 250ms as per ONFi v4.0 */
323 nand_wait_status_ready(chip
, 250);
326 /* This applies to read commands */
329 * READ0 is sometimes used to exit GET STATUS mode. When this
330 * is the case no address cycles are requested, and we can use
331 * this information to detect that we should not wait for the
332 * device to be ready.
334 if (column
== -1 && page_addr
== -1)
339 * If we don't have access to the busy pin, we apply the given
342 if (!chip
->legacy
.dev_ready
) {
343 udelay(chip
->legacy
.chip_delay
);
348 * Apply this short delay always to ensure that we do wait tWB in
349 * any case on any machine.
353 nand_wait_ready(chip
);
356 static void nand_ccs_delay(struct nand_chip
*chip
)
358 const struct nand_sdr_timings
*sdr
=
359 nand_get_sdr_timings(nand_get_interface_config(chip
));
362 * The controller already takes care of waiting for tCCS when the RNDIN
363 * or RNDOUT command is sent, return directly.
365 if (!(chip
->options
& NAND_WAIT_TCCS
))
369 * Wait tCCS_min if it is correctly defined, otherwise wait 500ns
370 * (which should be safe for all NANDs).
372 if (nand_controller_can_setup_interface(chip
))
373 ndelay(sdr
->tCCS_min
/ 1000);
379 * nand_command_lp - [DEFAULT] Send command to NAND large page device
380 * @chip: NAND chip object
381 * @command: the command to be sent
382 * @column: the column address for this command, -1 if none
383 * @page_addr: the page address for this command, -1 if none
385 * Send command to NAND device. This is the version for the new large page
386 * devices. We don't have the separate regions as we have in the small page
387 * devices. We must emulate NAND_CMD_READOOB to keep the code compatible.
389 static void nand_command_lp(struct nand_chip
*chip
, unsigned int command
,
390 int column
, int page_addr
)
392 struct mtd_info
*mtd
= nand_to_mtd(chip
);
394 /* Emulate NAND_CMD_READOOB */
395 if (command
== NAND_CMD_READOOB
) {
396 column
+= mtd
->writesize
;
397 command
= NAND_CMD_READ0
;
400 /* Command latch cycle */
401 if (command
!= NAND_CMD_NONE
)
402 chip
->legacy
.cmd_ctrl(chip
, command
,
403 NAND_NCE
| NAND_CLE
| NAND_CTRL_CHANGE
);
405 if (column
!= -1 || page_addr
!= -1) {
406 int ctrl
= NAND_CTRL_CHANGE
| NAND_NCE
| NAND_ALE
;
408 /* Serially input address */
410 /* Adjust columns for 16 bit buswidth */
411 if (chip
->options
& NAND_BUSWIDTH_16
&&
412 !nand_opcode_8bits(command
))
414 chip
->legacy
.cmd_ctrl(chip
, column
, ctrl
);
415 ctrl
&= ~NAND_CTRL_CHANGE
;
417 /* Only output a single addr cycle for 8bits opcodes. */
418 if (!nand_opcode_8bits(command
))
419 chip
->legacy
.cmd_ctrl(chip
, column
>> 8, ctrl
);
421 if (page_addr
!= -1) {
422 chip
->legacy
.cmd_ctrl(chip
, page_addr
, ctrl
);
423 chip
->legacy
.cmd_ctrl(chip
, page_addr
>> 8,
424 NAND_NCE
| NAND_ALE
);
425 if (chip
->options
& NAND_ROW_ADDR_3
)
426 chip
->legacy
.cmd_ctrl(chip
, page_addr
>> 16,
427 NAND_NCE
| NAND_ALE
);
430 chip
->legacy
.cmd_ctrl(chip
, NAND_CMD_NONE
,
431 NAND_NCE
| NAND_CTRL_CHANGE
);
434 * Program and erase have their own busy handlers status, sequential
435 * in and status need no delay.
440 case NAND_CMD_CACHEDPROG
:
441 case NAND_CMD_PAGEPROG
:
442 case NAND_CMD_ERASE1
:
443 case NAND_CMD_ERASE2
:
445 case NAND_CMD_STATUS
:
446 case NAND_CMD_READID
:
447 case NAND_CMD_SET_FEATURES
:
451 nand_ccs_delay(chip
);
455 if (chip
->legacy
.dev_ready
)
457 udelay(chip
->legacy
.chip_delay
);
458 chip
->legacy
.cmd_ctrl(chip
, NAND_CMD_STATUS
,
459 NAND_NCE
| NAND_CLE
| NAND_CTRL_CHANGE
);
460 chip
->legacy
.cmd_ctrl(chip
, NAND_CMD_NONE
,
461 NAND_NCE
| NAND_CTRL_CHANGE
);
462 /* EZ-NAND can take upto 250ms as per ONFi v4.0 */
463 nand_wait_status_ready(chip
, 250);
466 case NAND_CMD_RNDOUT
:
467 /* No ready / busy check necessary */
468 chip
->legacy
.cmd_ctrl(chip
, NAND_CMD_RNDOUTSTART
,
469 NAND_NCE
| NAND_CLE
| NAND_CTRL_CHANGE
);
470 chip
->legacy
.cmd_ctrl(chip
, NAND_CMD_NONE
,
471 NAND_NCE
| NAND_CTRL_CHANGE
);
473 nand_ccs_delay(chip
);
478 * READ0 is sometimes used to exit GET STATUS mode. When this
479 * is the case no address cycles are requested, and we can use
480 * this information to detect that READSTART should not be
483 if (column
== -1 && page_addr
== -1)
486 chip
->legacy
.cmd_ctrl(chip
, NAND_CMD_READSTART
,
487 NAND_NCE
| NAND_CLE
| NAND_CTRL_CHANGE
);
488 chip
->legacy
.cmd_ctrl(chip
, NAND_CMD_NONE
,
489 NAND_NCE
| NAND_CTRL_CHANGE
);
490 fallthrough
; /* This applies to read commands */
493 * If we don't have access to the busy pin, we apply the given
496 if (!chip
->legacy
.dev_ready
) {
497 udelay(chip
->legacy
.chip_delay
);
503 * Apply this short delay always to ensure that we do wait tWB in
504 * any case on any machine.
508 nand_wait_ready(chip
);
512 * nand_get_set_features_notsupp - set/get features stub returning -ENOTSUPP
513 * @chip: nand chip info structure
514 * @addr: feature address.
515 * @subfeature_param: the subfeature parameters, a four bytes array.
517 * Should be used by NAND controller drivers that do not support the SET/GET
518 * FEATURES operations.
520 int nand_get_set_features_notsupp(struct nand_chip
*chip
, int addr
,
521 u8
*subfeature_param
)
525 EXPORT_SYMBOL(nand_get_set_features_notsupp
);
528 * nand_wait - [DEFAULT] wait until the command is done
529 * @chip: NAND chip structure
531 * Wait for command done. This applies to erase and program only.
533 static int nand_wait(struct nand_chip
*chip
)
535 struct mtd_info
*mtd
= nand_to_mtd(chip
);
536 unsigned long timeo
= 400;
541 * Apply this short delay always to ensure that we do wait tWB in any
542 * case on any machine.
546 ret
= nand_status_op(chip
, NULL
);
550 if (mtd
->oops_panic_write
) {
551 panic_nand_wait(chip
, timeo
);
553 timeo
= jiffies
+ msecs_to_jiffies(timeo
);
555 if (chip
->legacy
.dev_ready
) {
556 if (chip
->legacy
.dev_ready(chip
))
559 ret
= nand_read_data_op(chip
, &status
,
560 sizeof(status
), true,
565 if (status
& NAND_STATUS_READY
)
569 } while (time_before(jiffies
, timeo
));
572 ret
= nand_read_data_op(chip
, &status
, sizeof(status
), true, false);
576 /* This can happen if in case of timeout or buggy dev_ready */
577 WARN_ON(!(status
& NAND_STATUS_READY
));
581 void nand_legacy_set_defaults(struct nand_chip
*chip
)
583 unsigned int busw
= chip
->options
& NAND_BUSWIDTH_16
;
585 if (nand_has_exec_op(chip
))
588 /* check for proper chip_delay setup, set 20us if not */
589 if (!chip
->legacy
.chip_delay
)
590 chip
->legacy
.chip_delay
= 20;
592 /* check, if a user supplied command function given */
593 if (!chip
->legacy
.cmdfunc
)
594 chip
->legacy
.cmdfunc
= nand_command
;
596 /* check, if a user supplied wait function given */
597 if (chip
->legacy
.waitfunc
== NULL
)
598 chip
->legacy
.waitfunc
= nand_wait
;
600 if (!chip
->legacy
.select_chip
)
601 chip
->legacy
.select_chip
= nand_select_chip
;
603 /* If called twice, pointers that depend on busw may need to be reset */
604 if (!chip
->legacy
.read_byte
|| chip
->legacy
.read_byte
== nand_read_byte
)
605 chip
->legacy
.read_byte
= busw
? nand_read_byte16
: nand_read_byte
;
606 if (!chip
->legacy
.write_buf
|| chip
->legacy
.write_buf
== nand_write_buf
)
607 chip
->legacy
.write_buf
= busw
? nand_write_buf16
: nand_write_buf
;
608 if (!chip
->legacy
.write_byte
|| chip
->legacy
.write_byte
== nand_write_byte
)
609 chip
->legacy
.write_byte
= busw
? nand_write_byte16
: nand_write_byte
;
610 if (!chip
->legacy
.read_buf
|| chip
->legacy
.read_buf
== nand_read_buf
)
611 chip
->legacy
.read_buf
= busw
? nand_read_buf16
: nand_read_buf
;
614 void nand_legacy_adjust_cmdfunc(struct nand_chip
*chip
)
616 struct mtd_info
*mtd
= nand_to_mtd(chip
);
618 /* Do not replace user supplied command function! */
619 if (mtd
->writesize
> 512 && chip
->legacy
.cmdfunc
== nand_command
)
620 chip
->legacy
.cmdfunc
= nand_command_lp
;
623 int nand_legacy_check_hooks(struct nand_chip
*chip
)
626 * ->legacy.cmdfunc() is legacy and will only be used if ->exec_op() is
629 if (nand_has_exec_op(chip
))
633 * Default functions assigned for ->legacy.cmdfunc() and
634 * ->legacy.select_chip() both expect ->legacy.cmd_ctrl() to be
637 if ((!chip
->legacy
.cmdfunc
|| !chip
->legacy
.select_chip
) &&
638 !chip
->legacy
.cmd_ctrl
) {
639 pr_err("->legacy.cmd_ctrl() should be provided\n");