2 * Copyright (C) 2009-2012 Semihalf
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/kernel.h>
33 #include <sys/socket.h>
34 #include <sys/malloc.h>
35 #include <sys/module.h>
38 #include <sys/mutex.h>
39 #include <sys/callout.h>
40 #include <sys/sysctl.h>
42 #include <dev/nand/nand.h>
43 #include <dev/nand/nandbus.h>
44 #include <dev/nand/nand_ecc_pos.h>
47 #include "nandbus_if.h"
48 #include <machine/stdarg.h>
50 #define NAND_RESET_DELAY 1000 /* tRST */
51 #define NAND_ERASE_DELAY 3000 /* tBERS */
52 #define NAND_PROG_DELAY 700 /* tPROG */
53 #define NAND_READ_DELAY 50 /* tR */
55 #define BIT0(x) ((x) & 0x1)
56 #define BIT1(x) (BIT0(x >> 1))
57 #define BIT2(x) (BIT0(x >> 2))
58 #define BIT3(x) (BIT0(x >> 3))
59 #define BIT4(x) (BIT0(x >> 4))
60 #define BIT5(x) (BIT0(x >> 5))
61 #define BIT6(x) (BIT0(x >> 6))
62 #define BIT7(x) (BIT0(x >> 7))
64 #define SOFTECC_SIZE 256
65 #define SOFTECC_BYTES 3
67 int nand_debug_flag = 0;
68 SYSCTL_INT(_debug, OID_AUTO, nand_debug, CTLFLAG_RWTUN, &nand_debug_flag, 0,
69 "NAND subsystem debug flag");
71 MALLOC_DEFINE(M_NAND, "NAND", "NAND dynamic data");
73 static void calculate_ecc(const uint8_t *, uint8_t *);
74 static int correct_ecc(uint8_t *, uint8_t *, uint8_t *);
77 nand_debug(int level, const char *fmt, ...)
81 if (!(nand_debug_flag & level))
90 nand_init(struct nand_softc *nand, device_t dev, int ecc_mode,
91 int ecc_bytes, int ecc_size, uint16_t *eccposition, char *cdev_name)
94 nand->ecc.eccmode = ecc_mode;
95 nand->chip_cdev_name = cdev_name;
97 if (ecc_mode == NAND_ECC_SOFT) {
98 nand->ecc.eccbytes = SOFTECC_BYTES;
99 nand->ecc.eccsize = SOFTECC_SIZE;
100 } else if (ecc_mode != NAND_ECC_NONE) {
101 nand->ecc.eccbytes = ecc_bytes;
102 nand->ecc.eccsize = ecc_size;
104 nand->ecc.eccpositions = eccposition;
109 nand_onfi_set_params(struct nand_chip *chip, struct onfi_chip_params *params)
111 struct chip_geom *cg;
113 cg = &chip->chip_geom;
115 init_chip_geom(cg, params->luns, params->blocks_per_lun,
116 params->pages_per_block, params->bytes_per_page,
117 params->spare_bytes_per_page);
118 chip->t_bers = params->t_bers;
119 chip->t_prog = params->t_prog;
120 chip->t_r = params->t_r;
121 chip->t_ccs = params->t_ccs;
123 if (params->features & ONFI_FEAT_16BIT)
124 chip->flags |= NAND_16_BIT;
128 nand_set_params(struct nand_chip *chip, struct nand_params *params)
130 struct chip_geom *cg;
131 uint32_t blocks_per_chip;
133 cg = &chip->chip_geom;
134 blocks_per_chip = (params->chip_size << 20) /
135 (params->page_size * params->pages_per_block);
137 init_chip_geom(cg, 1, blocks_per_chip,
138 params->pages_per_block, params->page_size,
141 chip->t_bers = NAND_ERASE_DELAY;
142 chip->t_prog = NAND_PROG_DELAY;
143 chip->t_r = NAND_READ_DELAY;
146 if (params->flags & NAND_16_BIT)
147 chip->flags |= NAND_16_BIT;
151 nand_init_stat(struct nand_chip *chip)
153 struct block_stat *blk_stat;
154 struct page_stat *pg_stat;
155 struct chip_geom *cg;
158 cg = &chip->chip_geom;
159 blks = cg->blks_per_lun * cg->luns;
160 blk_stat = malloc(sizeof(struct block_stat) * blks, M_NAND,
165 pgs = blks * cg->pgs_per_blk;
166 pg_stat = malloc(sizeof(struct page_stat) * pgs, M_NAND,
169 free(blk_stat, M_NAND);
173 chip->blk_stat = blk_stat;
174 chip->pg_stat = pg_stat;
180 nand_destroy_stat(struct nand_chip *chip)
183 free(chip->pg_stat, M_NAND);
184 free(chip->blk_stat, M_NAND);
188 init_chip_geom(struct chip_geom *cg, uint32_t luns, uint32_t blks_per_lun,
189 uint32_t pgs_per_blk, uint32_t pg_size, uint32_t oob_size)
197 cg->blks_per_lun = blks_per_lun;
198 cg->blks_per_chip = blks_per_lun * luns;
199 cg->pgs_per_blk = pgs_per_blk;
201 cg->page_size = pg_size;
202 cg->oob_size = oob_size;
203 cg->block_size = cg->page_size * cg->pgs_per_blk;
204 cg->chip_size = cg->block_size * cg->blks_per_chip;
206 shift = fls(cg->pgs_per_blk - 1);
207 cg->pg_mask = (1 << shift) - 1;
208 cg->blk_shift = shift;
210 if (cg->blks_per_lun > 0) {
211 shift = fls(cg->blks_per_lun - 1);
212 cg->blk_mask = ((1 << shift) - 1) << cg->blk_shift;
218 cg->lun_shift = shift + cg->blk_shift;
219 shift = fls(cg->luns - 1);
220 cg->lun_mask = ((1 << shift) - 1) << cg->lun_shift;
222 nand_debug(NDBG_NAND, "Masks: lun 0x%x blk 0x%x page 0x%x\n"
223 "Shifts: lun %d blk %d",
224 cg->lun_mask, cg->blk_mask, cg->pg_mask,
225 cg->lun_shift, cg->blk_shift);
231 nand_row_to_blkpg(struct chip_geom *cg, uint32_t row, uint32_t *lun,
232 uint32_t *blk, uint32_t *pg)
235 if (!cg || !lun || !blk || !pg)
238 if (row & ~(cg->lun_mask | cg->blk_mask | cg->pg_mask)) {
239 nand_debug(NDBG_NAND,"Address out of bounds\n");
243 *lun = (row & cg->lun_mask) >> cg->lun_shift;
244 *blk = (row & cg->blk_mask) >> cg->blk_shift;
245 *pg = (row & cg->pg_mask);
247 nand_debug(NDBG_NAND,"address %x-%x-%x\n", *lun, *blk, *pg);
252 int page_to_row(struct chip_geom *cg, uint32_t page, uint32_t *row)
254 uint32_t lun, block, pg_in_blk;
259 block = page / cg->pgs_per_blk;
260 pg_in_blk = page % cg->pgs_per_blk;
262 lun = block / cg->blks_per_lun;
263 block = block % cg->blks_per_lun;
265 *row = (lun << cg->lun_shift) & cg->lun_mask;
266 *row |= ((block << cg->blk_shift) & cg->blk_mask);
267 *row |= (pg_in_blk & cg->pg_mask);
273 nand_check_page_boundary(struct nand_chip *chip, uint32_t page)
275 struct chip_geom* cg;
277 cg = &chip->chip_geom;
278 if (page >= (cg->pgs_per_blk * cg->blks_per_lun * cg->luns)) {
279 nand_debug(NDBG_GEN,"%s: page number too big %#x\n",
288 nand_get_chip_param(struct nand_chip *chip, struct chip_param_io *param)
290 struct chip_geom *cg;
292 cg = &chip->chip_geom;
293 param->page_size = cg->page_size;
294 param->oob_size = cg->oob_size;
296 param->blocks = cg->blks_per_lun * cg->luns;
297 param->pages_per_block = cg->pgs_per_blk;
301 default_software_ecc_positions(struct nand_chip *chip)
303 /* If positions have been set already, use them. */
304 if (chip->nand->ecc.eccpositions)
305 return (chip->nand->ecc.eccpositions);
308 * XXX Note that the following logic isn't really sufficient, especially
309 * in the ONFI case where the number of ECC bytes can be dictated by
310 * values in the parameters page, and that could lead to needing more
311 * byte positions than exist within the tables of software-ecc defaults.
313 if (chip->chip_geom.oob_size >= 128)
314 return (default_software_ecc_positions_128);
315 if (chip->chip_geom.oob_size >= 64)
316 return (default_software_ecc_positions_64);
317 else if (chip->chip_geom.oob_size >= 16)
318 return (default_software_ecc_positions_16);
324 calculate_ecc(const uint8_t *buf, uint8_t *ecc)
331 for (i = 0; i < 256; i++) {
333 ecc[0] ^= (BIT0(byte) ^ BIT2(byte) ^ BIT4(byte) ^
335 ecc[0] ^= (BIT1(byte) ^ BIT3(byte) ^ BIT5(byte) ^
337 ecc[0] ^= (BIT0(byte) ^ BIT1(byte) ^ BIT4(byte) ^
339 ecc[0] ^= (BIT2(byte) ^ BIT3(byte) ^ BIT6(byte) ^
341 ecc[0] ^= (BIT0(byte) ^ BIT1(byte) ^ BIT2(byte) ^
343 ecc[0] ^= (BIT4(byte) ^ BIT5(byte) ^ BIT6(byte) ^
346 p8 = BIT0(byte) ^ BIT1(byte) ^ BIT2(byte) ^
347 BIT3(byte) ^ BIT4(byte) ^ BIT5(byte) ^ BIT6(byte) ^
351 ecc[2] ^= (0x1 << BIT0(i));
352 ecc[2] ^= (0x4 << BIT1(i));
353 ecc[2] ^= (0x10 << BIT2(i));
354 ecc[2] ^= (0x40 << BIT3(i));
356 ecc[1] ^= (0x1 << BIT4(i));
357 ecc[1] ^= (0x4 << BIT5(i));
358 ecc[1] ^= (0x10 << BIT6(i));
359 ecc[1] ^= (0x40 << BIT7(i));
369 correct_ecc(uint8_t *buf, uint8_t *calc_ecc, uint8_t *read_ecc)
371 uint8_t ecc0, ecc1, ecc2, onesnum, bit, byte;
374 ecc0 = calc_ecc[0] ^ read_ecc[0];
375 ecc1 = calc_ecc[1] ^ read_ecc[1];
376 ecc2 = calc_ecc[2] ^ read_ecc[2];
378 if (!ecc0 && !ecc1 && !ecc2)
381 addr = BIT3(ecc0) | (BIT5(ecc0) << 1) | (BIT7(ecc0) << 2);
382 addr |= (BIT1(ecc2) << 3) | (BIT3(ecc2) << 4) |
383 (BIT5(ecc2) << 5) | (BIT7(ecc2) << 6);
384 addr |= (BIT1(ecc1) << 7) | (BIT3(ecc1) << 8) |
385 (BIT5(ecc1) << 9) | (BIT7(ecc1) << 10);
388 while (ecc0 || ecc1 || ecc2) {
402 /* Correctable error */
405 buf[byte] ^= (1 << bit);
406 return (ECC_CORRECTABLE);
407 } else if (onesnum == 1) {
409 return (ECC_ERROR_ECC);
411 /* Uncorrectable error */
412 return (ECC_UNCORRECTABLE);
419 nand_softecc_get(device_t dev, uint8_t *buf, int pagesize, uint8_t *ecc)
421 int steps = pagesize / SOFTECC_SIZE;
424 for (; i < (steps * SOFTECC_BYTES);
425 i += SOFTECC_BYTES, j += SOFTECC_SIZE) {
426 calculate_ecc(&buf[j], &ecc[i]);
433 nand_softecc_correct(device_t dev, uint8_t *buf, int pagesize,
434 uint8_t *readecc, uint8_t *calcecc)
436 int steps = pagesize / SOFTECC_SIZE;
437 int i = 0, j = 0, ret = 0;
439 for (i = 0; i < (steps * SOFTECC_BYTES);
440 i += SOFTECC_BYTES, j += SOFTECC_SIZE) {
441 ret += correct_ecc(&buf[j], &calcecc[i], &readecc[i]);
450 offset_to_page(struct chip_geom *cg, uint32_t offset)
453 return (offset / cg->page_size);
457 nand_read_pages(struct nand_chip *chip, uint32_t offset, void *buf,
460 struct chip_geom *cg;
461 struct nand_ecc_data *eccd;
462 struct page_stat *pg_stat;
466 uint16_t *eccpos = NULL;
467 uint32_t page, num, steps = 0;
468 int i, retval = 0, needwrite;
470 nand_debug(NDBG_NAND,"%p read page %x[%x]", chip, offset, len);
471 cg = &chip->chip_geom;
472 eccd = &chip->nand->ecc;
473 page = offset_to_page(cg, offset);
474 num = len / cg->page_size;
476 if (eccd->eccmode != NAND_ECC_NONE) {
477 steps = cg->page_size / eccd->eccsize;
478 eccpos = default_software_ecc_positions(chip);
479 oob = malloc(cg->oob_size, M_NAND, M_WAITOK);
482 nandbus = device_get_parent(chip->dev);
483 NANDBUS_LOCK(nandbus);
484 NANDBUS_SELECT_CS(device_get_parent(chip->dev), chip->num);
486 ptr = (uint8_t *)buf;
488 pg_stat = &(chip->pg_stat[page]);
490 if (NAND_READ_PAGE(chip->dev, page, ptr, cg->page_size, 0)) {
495 if (eccd->eccmode != NAND_ECC_NONE) {
496 if (NAND_GET_ECC(chip->dev, ptr, eccd->ecccalculated,
501 nand_debug(NDBG_ECC,"%s: ECC calculated:",
503 if (nand_debug_flag & NDBG_ECC)
504 for (i = 0; i < (eccd->eccbytes * steps); i++)
505 printf("%x ", eccd->ecccalculated[i]);
507 nand_debug(NDBG_ECC,"\n");
509 if (NAND_READ_OOB(chip->dev, page, oob, cg->oob_size,
514 for (i = 0; i < (eccd->eccbytes * steps); i++)
515 eccd->eccread[i] = ((uint8_t *)oob)[eccpos[i]];
517 nand_debug(NDBG_ECC,"%s: ECC read:", __func__);
518 if (nand_debug_flag & NDBG_ECC)
519 for (i = 0; i < (eccd->eccbytes * steps); i++)
520 printf("%x ", eccd->eccread[i]);
521 nand_debug(NDBG_ECC,"\n");
523 retval = NAND_CORRECT_ECC(chip->dev, ptr, eccd->eccread,
524 eccd->ecccalculated);
526 nand_debug(NDBG_ECC, "NAND_CORRECT_ECC() returned %d",
530 pg_stat->ecc_stat.ecc_succeded++;
531 else if (retval > 0) {
532 pg_stat->ecc_stat.ecc_corrected += retval;
533 retval = ECC_CORRECTABLE;
535 pg_stat->ecc_stat.ecc_failed++;
540 pg_stat->page_read++;
542 ptr += cg->page_size;
545 NANDBUS_UNLOCK(nandbus);
554 nand_read_pages_raw(struct nand_chip *chip, uint32_t offset, void *buf,
557 struct chip_geom *cg;
560 uint32_t page, num, end, begin = 0, begin_off;
563 cg = &chip->chip_geom;
564 page = offset_to_page(cg, offset);
565 begin_off = offset - page * cg->page_size;
567 begin = cg->page_size - begin_off;
570 num = len / cg->page_size;
571 end = len % cg->page_size;
573 nandbus = device_get_parent(chip->dev);
574 NANDBUS_LOCK(nandbus);
575 NANDBUS_SELECT_CS(device_get_parent(chip->dev), chip->num);
577 ptr = (uint8_t *)buf;
579 if (NAND_READ_PAGE(chip->dev, page, ptr, begin, begin_off)) {
580 NANDBUS_UNLOCK(nandbus);
589 if (NAND_READ_PAGE(chip->dev, page, ptr, cg->page_size, 0)) {
590 NANDBUS_UNLOCK(nandbus);
595 ptr += cg->page_size;
599 if (NAND_READ_PAGE(chip->dev, page, ptr, end, 0)) {
600 NANDBUS_UNLOCK(nandbus);
604 NANDBUS_UNLOCK(nandbus);
611 nand_prog_pages(struct nand_chip *chip, uint32_t offset, uint8_t *buf,
614 struct chip_geom *cg;
615 struct page_stat *pg_stat;
616 struct nand_ecc_data *eccd;
620 uint16_t *eccpos = NULL;
621 int steps = 0, i, needwrite, err = 0;
623 nand_debug(NDBG_NAND,"%p prog page %x[%x]", chip, offset, len);
625 eccd = &chip->nand->ecc;
626 cg = &chip->chip_geom;
627 page = offset_to_page(cg, offset);
628 num = len / cg->page_size;
630 if (eccd->eccmode != NAND_ECC_NONE) {
631 steps = cg->page_size / eccd->eccsize;
632 oob = malloc(cg->oob_size, M_NAND, M_WAITOK);
633 eccpos = default_software_ecc_positions(chip);
636 nandbus = device_get_parent(chip->dev);
637 NANDBUS_LOCK(nandbus);
638 NANDBUS_SELECT_CS(device_get_parent(chip->dev), chip->num);
641 if (NAND_PROGRAM_PAGE(chip->dev, page, buf, cg->page_size, 0)) {
646 if (eccd->eccmode != NAND_ECC_NONE) {
647 if (NAND_GET_ECC(chip->dev, buf, &eccd->ecccalculated,
652 nand_debug(NDBG_ECC,"ECC calculated:");
653 if (nand_debug_flag & NDBG_ECC)
654 for (i = 0; i < (eccd->eccbytes * steps); i++)
655 printf("%x ", eccd->ecccalculated[i]);
657 nand_debug(NDBG_ECC,"\n");
660 if (NAND_READ_OOB(chip->dev, page, oob, cg->oob_size,
666 for (i = 0; i < (eccd->eccbytes * steps); i++)
667 oob[eccpos[i]] = eccd->ecccalculated[i];
669 if (NAND_PROGRAM_OOB(chip->dev, page, oob,
677 pg_stat = &(chip->pg_stat[page]);
678 pg_stat->page_written++;
681 buf += cg->page_size;
684 NANDBUS_UNLOCK(nandbus);
693 nand_prog_pages_raw(struct nand_chip *chip, uint32_t offset, void *buf,
696 struct chip_geom *cg;
699 uint32_t page, num, end, begin = 0, begin_off;
702 cg = &chip->chip_geom;
703 page = offset_to_page(cg, offset);
704 begin_off = offset - page * cg->page_size;
706 begin = cg->page_size - begin_off;
709 num = len / cg->page_size;
710 end = len % cg->page_size;
712 nandbus = device_get_parent(chip->dev);
713 NANDBUS_LOCK(nandbus);
714 NANDBUS_SELECT_CS(device_get_parent(chip->dev), chip->num);
716 ptr = (uint8_t *)buf;
718 if (NAND_PROGRAM_PAGE(chip->dev, page, ptr, begin, begin_off)) {
719 NANDBUS_UNLOCK(nandbus);
728 if (NAND_PROGRAM_PAGE(chip->dev, page, ptr, cg->page_size, 0)) {
729 NANDBUS_UNLOCK(nandbus);
734 ptr += cg->page_size;
738 retval = NAND_PROGRAM_PAGE(chip->dev, page, ptr, end, 0);
740 NANDBUS_UNLOCK(nandbus);
746 nand_read_oob(struct nand_chip *chip, uint32_t page, void *buf,
752 nandbus = device_get_parent(chip->dev);
753 NANDBUS_LOCK(nandbus);
754 NANDBUS_SELECT_CS(device_get_parent(chip->dev), chip->num);
756 retval = NAND_READ_OOB(chip->dev, page, buf, len, 0);
758 NANDBUS_UNLOCK(nandbus);
765 nand_prog_oob(struct nand_chip *chip, uint32_t page, void *buf,
771 nandbus = device_get_parent(chip->dev);
772 NANDBUS_LOCK(nandbus);
773 NANDBUS_SELECT_CS(device_get_parent(chip->dev), chip->num);
775 retval = NAND_PROGRAM_OOB(chip->dev, page, buf, len, 0);
777 NANDBUS_UNLOCK(nandbus);
783 nand_erase_blocks(struct nand_chip *chip, off_t offset, size_t len)
786 struct chip_geom *cg;
787 uint32_t block, num_blocks;
790 cg = &chip->chip_geom;
791 if ((offset % cg->block_size) || (len % cg->block_size))
794 block = offset / cg->block_size;
795 num_blocks = len / cg->block_size;
796 nand_debug(NDBG_NAND,"%p erase blocks %d[%d]", chip, block, num_blocks);
798 nandbus = device_get_parent(chip->dev);
799 NANDBUS_LOCK(nandbus);
800 NANDBUS_SELECT_CS(device_get_parent(chip->dev), chip->num);
802 while (num_blocks--) {
803 if (!nand_check_bad_block(chip, block)) {
804 if (NAND_ERASE_BLOCK(chip->dev, block)) {
805 nand_debug(NDBG_NAND,"%p erase blocks %d error",
807 nand_mark_bad_block(chip, block);
816 NANDBUS_UNLOCK(nandbus);
819 nand_update_bbt(chip);
824 MODULE_VERSION(nand, 1);