2 * Flash NAND memory emulation. Based on "16M x 8 Bit NAND Flash
3 * Memory" datasheet for the KM29U128AT / K9F2808U0A chips from
6 * Copyright (c) 2006 Openedhand Ltd.
9 * This code is licensed under the GNU GPL v2.
17 /* FIXME: Pass block device as an argument. */
20 # define NAND_CMD_READ0 0x00
21 # define NAND_CMD_READ1 0x01
22 # define NAND_CMD_READ2 0x50
23 # define NAND_CMD_LPREAD2 0x30
24 # define NAND_CMD_NOSERIALREAD2 0x35
25 # define NAND_CMD_RANDOMREAD1 0x05
26 # define NAND_CMD_RANDOMREAD2 0xe0
27 # define NAND_CMD_READID 0x90
28 # define NAND_CMD_RESET 0xff
29 # define NAND_CMD_PAGEPROGRAM1 0x80
30 # define NAND_CMD_PAGEPROGRAM2 0x10
31 # define NAND_CMD_CACHEPROGRAM2 0x15
32 # define NAND_CMD_BLOCKERASE1 0x60
33 # define NAND_CMD_BLOCKERASE2 0xd0
34 # define NAND_CMD_READSTATUS 0x70
35 # define NAND_CMD_COPYBACKPRG1 0x85
37 # define NAND_IOSTATUS_ERROR (1 << 0)
38 # define NAND_IOSTATUS_PLANE0 (1 << 1)
39 # define NAND_IOSTATUS_PLANE1 (1 << 2)
40 # define NAND_IOSTATUS_PLANE2 (1 << 3)
41 # define NAND_IOSTATUS_PLANE3 (1 << 4)
42 # define NAND_IOSTATUS_BUSY (1 << 6)
43 # define NAND_IOSTATUS_UNPROTCT (1 << 7)
45 # define MAX_PAGE 0x800
48 struct NANDFlashState {
49 uint8_t manf_id, chip_id;
51 int page_shift, oob_shift, erase_shift, addr_shift;
53 BlockDriverState *bdrv;
56 int cle, ale, ce, wp, gnd;
58 uint8_t io[MAX_PAGE + MAX_OOB + 0x400];
67 void (*blk_write)(NANDFlashState *s);
68 void (*blk_erase)(NANDFlashState *s);
69 void (*blk_load)(NANDFlashState *s, uint32_t addr, int offset);
72 # define NAND_NO_AUTOINCR 0x00000001
73 # define NAND_BUSWIDTH_16 0x00000002
74 # define NAND_NO_PADDING 0x00000004
75 # define NAND_CACHEPRG 0x00000008
76 # define NAND_COPYBACK 0x00000010
77 # define NAND_IS_AND 0x00000020
78 # define NAND_4PAGE_ARRAY 0x00000040
79 # define NAND_NO_READRDY 0x00000100
80 # define NAND_SAMSUNG_LP (NAND_NO_PADDING | NAND_COPYBACK)
84 # define PAGE(addr) ((addr) >> ADDR_SHIFT)
85 # define PAGE_START(page) (PAGE(page) * (PAGE_SIZE + OOB_SIZE))
86 # define PAGE_MASK ((1 << ADDR_SHIFT) - 1)
87 # define OOB_SHIFT (PAGE_SHIFT - 5)
88 # define OOB_SIZE (1 << OOB_SHIFT)
89 # define SECTOR(addr) ((addr) >> (9 + ADDR_SHIFT - PAGE_SHIFT))
90 # define SECTOR_OFFSET(addr) ((addr) & ((511 >> PAGE_SHIFT) << 8))
92 # define PAGE_SIZE 256
94 # define PAGE_SECTORS 1
97 # define PAGE_SIZE 512
99 # define PAGE_SECTORS 1
100 # define ADDR_SHIFT 8
102 # define PAGE_SIZE 2048
103 # define PAGE_SHIFT 11
104 # define PAGE_SECTORS 4
105 # define ADDR_SHIFT 16
108 /* Information based on Linux drivers/mtd/nand/nand_ids.c */
109 static const struct {
115 } nand_flash_ids[0x100] = {
116 [0 ... 0xff] = { 0 },
118 [0x6e] = { 1, 8, 8, 4, 0 },
119 [0x64] = { 2, 8, 8, 4, 0 },
120 [0x6b] = { 4, 8, 9, 4, 0 },
121 [0xe8] = { 1, 8, 8, 4, 0 },
122 [0xec] = { 1, 8, 8, 4, 0 },
123 [0xea] = { 2, 8, 8, 4, 0 },
124 [0xd5] = { 4, 8, 9, 4, 0 },
125 [0xe3] = { 4, 8, 9, 4, 0 },
126 [0xe5] = { 4, 8, 9, 4, 0 },
127 [0xd6] = { 8, 8, 9, 4, 0 },
129 [0x39] = { 8, 8, 9, 4, 0 },
130 [0xe6] = { 8, 8, 9, 4, 0 },
131 [0x49] = { 8, 16, 9, 4, NAND_BUSWIDTH_16 },
132 [0x59] = { 8, 16, 9, 4, NAND_BUSWIDTH_16 },
134 [0x33] = { 16, 8, 9, 5, 0 },
135 [0x73] = { 16, 8, 9, 5, 0 },
136 [0x43] = { 16, 16, 9, 5, NAND_BUSWIDTH_16 },
137 [0x53] = { 16, 16, 9, 5, NAND_BUSWIDTH_16 },
139 [0x35] = { 32, 8, 9, 5, 0 },
140 [0x75] = { 32, 8, 9, 5, 0 },
141 [0x45] = { 32, 16, 9, 5, NAND_BUSWIDTH_16 },
142 [0x55] = { 32, 16, 9, 5, NAND_BUSWIDTH_16 },
144 [0x36] = { 64, 8, 9, 5, 0 },
145 [0x76] = { 64, 8, 9, 5, 0 },
146 [0x46] = { 64, 16, 9, 5, NAND_BUSWIDTH_16 },
147 [0x56] = { 64, 16, 9, 5, NAND_BUSWIDTH_16 },
149 [0x78] = { 128, 8, 9, 5, 0 },
150 [0x39] = { 128, 8, 9, 5, 0 },
151 [0x79] = { 128, 8, 9, 5, 0 },
152 [0x72] = { 128, 16, 9, 5, NAND_BUSWIDTH_16 },
153 [0x49] = { 128, 16, 9, 5, NAND_BUSWIDTH_16 },
154 [0x74] = { 128, 16, 9, 5, NAND_BUSWIDTH_16 },
155 [0x59] = { 128, 16, 9, 5, NAND_BUSWIDTH_16 },
157 [0x71] = { 256, 8, 9, 5, 0 },
160 * These are the new chips with large page size. The pagesize and the
161 * erasesize is determined from the extended id bytes
163 # define LP_OPTIONS (NAND_SAMSUNG_LP | NAND_NO_READRDY | NAND_NO_AUTOINCR)
164 # define LP_OPTIONS16 (LP_OPTIONS | NAND_BUSWIDTH_16)
167 [0xa2] = { 64, 8, 0, 0, LP_OPTIONS },
168 [0xf2] = { 64, 8, 0, 0, LP_OPTIONS },
169 [0xb2] = { 64, 16, 0, 0, LP_OPTIONS16 },
170 [0xc2] = { 64, 16, 0, 0, LP_OPTIONS16 },
173 [0xa1] = { 128, 8, 0, 0, LP_OPTIONS },
174 [0xf1] = { 128, 8, 0, 0, LP_OPTIONS },
175 [0xb1] = { 128, 16, 0, 0, LP_OPTIONS16 },
176 [0xc1] = { 128, 16, 0, 0, LP_OPTIONS16 },
179 [0xaa] = { 256, 8, 0, 0, LP_OPTIONS },
180 [0xda] = { 256, 8, 0, 0, LP_OPTIONS },
181 [0xba] = { 256, 16, 0, 0, LP_OPTIONS16 },
182 [0xca] = { 256, 16, 0, 0, LP_OPTIONS16 },
185 [0xac] = { 512, 8, 0, 0, LP_OPTIONS },
186 [0xdc] = { 512, 8, 0, 0, LP_OPTIONS },
187 [0xbc] = { 512, 16, 0, 0, LP_OPTIONS16 },
188 [0xcc] = { 512, 16, 0, 0, LP_OPTIONS16 },
191 [0xa3] = { 1024, 8, 0, 0, LP_OPTIONS },
192 [0xd3] = { 1024, 8, 0, 0, LP_OPTIONS },
193 [0xb3] = { 1024, 16, 0, 0, LP_OPTIONS16 },
194 [0xc3] = { 1024, 16, 0, 0, LP_OPTIONS16 },
197 [0xa5] = { 2048, 8, 0, 0, LP_OPTIONS },
198 [0xd5] = { 2048, 8, 0, 0, LP_OPTIONS },
199 [0xb5] = { 2048, 16, 0, 0, LP_OPTIONS16 },
200 [0xc5] = { 2048, 16, 0, 0, LP_OPTIONS16 },
203 static void nand_reset(NANDFlashState *s)
205 s->cmd = NAND_CMD_READ0;
210 s->status &= NAND_IOSTATUS_UNPROTCT;
213 static void nand_command(NANDFlashState *s)
221 case NAND_CMD_READID:
222 s->io[0] = s->manf_id;
223 s->io[1] = s->chip_id;
224 s->io[2] = 'Q'; /* Don't-care byte (often 0xa5) */
225 if (nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP)
226 s->io[3] = 0x15; /* Page Size, Block Size, Spare Size.. */
228 s->io[3] = 0xc0; /* Multi-plane */
233 case NAND_CMD_RANDOMREAD2:
234 case NAND_CMD_NOSERIALREAD2:
235 if (!(nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP))
237 offset = s->addr & ((1 << s->addr_shift) - 1);
238 s->blk_load(s, s->addr, offset);
240 s->iolen = (1 << s->page_shift) - offset;
242 s->iolen = (1 << s->page_shift) + (1 << s->oob_shift) - offset;
249 case NAND_CMD_PAGEPROGRAM1:
254 case NAND_CMD_PAGEPROGRAM2:
260 case NAND_CMD_BLOCKERASE1:
263 case NAND_CMD_BLOCKERASE2:
264 if (nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP)
274 case NAND_CMD_READSTATUS:
275 s->io[0] = s->status;
281 printf("%s: Unknown NAND command 0x%02x\n", __FUNCTION__, s->cmd);
285 static void nand_save(QEMUFile *f, void *opaque)
287 NANDFlashState *s = (NANDFlashState *) opaque;
288 qemu_put_byte(f, s->cle);
289 qemu_put_byte(f, s->ale);
290 qemu_put_byte(f, s->ce);
291 qemu_put_byte(f, s->wp);
292 qemu_put_byte(f, s->gnd);
293 qemu_put_buffer(f, s->io, sizeof(s->io));
294 qemu_put_be32(f, s->ioaddr - s->io);
295 qemu_put_be32(f, s->iolen);
297 qemu_put_be32s(f, &s->cmd);
298 qemu_put_be32s(f, &s->addr);
299 qemu_put_be32(f, s->addrlen);
300 qemu_put_be32(f, s->status);
301 qemu_put_be32(f, s->offset);
302 /* XXX: do we want to save s->storage too? */
305 static int nand_load(QEMUFile *f, void *opaque, int version_id)
307 NANDFlashState *s = (NANDFlashState *) opaque;
308 s->cle = qemu_get_byte(f);
309 s->ale = qemu_get_byte(f);
310 s->ce = qemu_get_byte(f);
311 s->wp = qemu_get_byte(f);
312 s->gnd = qemu_get_byte(f);
313 qemu_get_buffer(f, s->io, sizeof(s->io));
314 s->ioaddr = s->io + qemu_get_be32(f);
315 s->iolen = qemu_get_be32(f);
316 if (s->ioaddr >= s->io + sizeof(s->io) || s->ioaddr < s->io)
319 qemu_get_be32s(f, &s->cmd);
320 qemu_get_be32s(f, &s->addr);
321 s->addrlen = qemu_get_be32(f);
322 s->status = qemu_get_be32(f);
323 s->offset = qemu_get_be32(f);
328 * Chip inputs are CLE, ALE, CE, WP, GND and eight I/O pins. Chip
329 * outputs are R/B and eight I/O pins.
331 * CE, WP and R/B are active low.
333 void nand_setpins(NANDFlashState *s,
334 int cle, int ale, int ce, int wp, int gnd)
342 s->status |= NAND_IOSTATUS_UNPROTCT;
344 s->status &= ~NAND_IOSTATUS_UNPROTCT;
347 void nand_getpins(NANDFlashState *s, int *rb)
352 void nand_setio(NANDFlashState *s, uint8_t value)
354 if (!s->ce && s->cle) {
355 if (nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP) {
356 if (s->cmd == NAND_CMD_READ0 && value == NAND_CMD_LPREAD2)
358 if (value == NAND_CMD_RANDOMREAD1) {
359 s->addr &= ~((1 << s->addr_shift) - 1);
364 if (value == NAND_CMD_READ0)
366 else if (value == NAND_CMD_READ1) {
368 value = NAND_CMD_READ0;
370 else if (value == NAND_CMD_READ2) {
371 s->offset = 1 << s->page_shift;
372 value = NAND_CMD_READ0;
377 if (s->cmd == NAND_CMD_READSTATUS ||
378 s->cmd == NAND_CMD_PAGEPROGRAM2 ||
379 s->cmd == NAND_CMD_BLOCKERASE1 ||
380 s->cmd == NAND_CMD_BLOCKERASE2 ||
381 s->cmd == NAND_CMD_NOSERIALREAD2 ||
382 s->cmd == NAND_CMD_RANDOMREAD2 ||
383 s->cmd == NAND_CMD_RESET)
386 if (s->cmd != NAND_CMD_RANDOMREAD2) {
392 unsigned int shift = s->addrlen * 8;
393 unsigned int mask = ~(0xff << shift);
394 unsigned int v = value << shift;
396 s->addr = (s->addr & mask) | v;
399 if (s->addrlen == 1 && s->cmd == NAND_CMD_READID)
402 if (!(nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP) &&
404 s->cmd == NAND_CMD_READ0 ||
405 s->cmd == NAND_CMD_PAGEPROGRAM1))
407 if ((nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP) &&
409 s->cmd == NAND_CMD_READ0 ||
410 s->cmd == NAND_CMD_PAGEPROGRAM1))
414 if (!s->cle && !s->ale && s->cmd == NAND_CMD_PAGEPROGRAM1) {
415 if (s->iolen < (1 << s->page_shift) + (1 << s->oob_shift))
416 s->io[s->iolen ++] = value;
417 } else if (!s->cle && !s->ale && s->cmd == NAND_CMD_COPYBACKPRG1) {
418 if ((s->addr & ((1 << s->addr_shift) - 1)) <
419 (1 << s->page_shift) + (1 << s->oob_shift)) {
420 s->io[s->iolen + (s->addr & ((1 << s->addr_shift) - 1))] = value;
426 uint8_t nand_getio(NANDFlashState *s)
430 /* Allow sequential reading */
431 if (!s->iolen && s->cmd == NAND_CMD_READ0) {
432 offset = (s->addr & ((1 << s->addr_shift) - 1)) + s->offset;
435 s->blk_load(s, s->addr, offset);
437 s->iolen = (1 << s->page_shift) - offset;
439 s->iolen = (1 << s->page_shift) + (1 << s->oob_shift) - offset;
442 if (s->ce || s->iolen <= 0)
447 return *(s->ioaddr ++);
450 NANDFlashState *nand_init(int manf_id, int chip_id)
456 if (nand_flash_ids[chip_id].size == 0) {
457 hw_error("%s: Unsupported NAND chip ID.\n", __FUNCTION__);
460 s = (NANDFlashState *) qemu_mallocz(sizeof(NANDFlashState));
461 dinfo = drive_get(IF_MTD, 0, 0);
463 s->bdrv = dinfo->bdrv;
464 s->manf_id = manf_id;
465 s->chip_id = chip_id;
466 s->size = nand_flash_ids[s->chip_id].size << 20;
467 if (nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP) {
471 s->page_shift = nand_flash_ids[s->chip_id].page_shift;
472 s->erase_shift = nand_flash_ids[s->chip_id].erase_shift;
475 switch (1 << s->page_shift) {
486 hw_error("%s: Unsupported NAND block size.\n", __FUNCTION__);
489 pagesize = 1 << s->oob_shift;
491 if (s->bdrv && bdrv_getlength(s->bdrv) >=
492 (s->pages << s->page_shift) + (s->pages << s->oob_shift)) {
498 pagesize += 1 << s->page_shift;
500 s->storage = (uint8_t *) memset(qemu_malloc(s->pages * pagesize),
501 0xff, s->pages * pagesize);
502 /* Give s->ioaddr a sane value in case we save state before it
506 register_savevm("nand", -1, 0, nand_save, nand_load, s);
511 void nand_done(NANDFlashState *s)
515 bdrv_delete(s->bdrv);
518 if (!s->bdrv || s->mem_oob)
519 qemu_free(s->storage);
526 /* Program a single page */
527 static void glue(nand_blk_write_, PAGE_SIZE)(NANDFlashState *s)
529 uint32_t off, page, sector, soff;
530 uint8_t iobuf[(PAGE_SECTORS + 2) * 0x200];
531 if (PAGE(s->addr) >= s->pages)
535 memcpy(s->storage + PAGE_START(s->addr) + (s->addr & PAGE_MASK) +
536 s->offset, s->io, s->iolen);
537 } else if (s->mem_oob) {
538 sector = SECTOR(s->addr);
539 off = (s->addr & PAGE_MASK) + s->offset;
540 soff = SECTOR_OFFSET(s->addr);
541 if (bdrv_read(s->bdrv, sector, iobuf, PAGE_SECTORS) == -1) {
542 printf("%s: read error in sector %i\n", __FUNCTION__, sector);
546 memcpy(iobuf + (soff | off), s->io, MIN(s->iolen, PAGE_SIZE - off));
547 if (off + s->iolen > PAGE_SIZE) {
548 page = PAGE(s->addr);
549 memcpy(s->storage + (page << OOB_SHIFT), s->io + PAGE_SIZE - off,
550 MIN(OOB_SIZE, off + s->iolen - PAGE_SIZE));
553 if (bdrv_write(s->bdrv, sector, iobuf, PAGE_SECTORS) == -1)
554 printf("%s: write error in sector %i\n", __FUNCTION__, sector);
556 off = PAGE_START(s->addr) + (s->addr & PAGE_MASK) + s->offset;
559 if (bdrv_read(s->bdrv, sector, iobuf, PAGE_SECTORS + 2) == -1) {
560 printf("%s: read error in sector %i\n", __FUNCTION__, sector);
564 memcpy(iobuf + soff, s->io, s->iolen);
566 if (bdrv_write(s->bdrv, sector, iobuf, PAGE_SECTORS + 2) == -1)
567 printf("%s: write error in sector %i\n", __FUNCTION__, sector);
572 /* Erase a single block */
573 static void glue(nand_blk_erase_, PAGE_SIZE)(NANDFlashState *s)
575 uint32_t i, page, addr;
576 uint8_t iobuf[0x200] = { [0 ... 0x1ff] = 0xff, };
577 addr = s->addr & ~((1 << (ADDR_SHIFT + s->erase_shift)) - 1);
579 if (PAGE(addr) >= s->pages)
583 memset(s->storage + PAGE_START(addr),
584 0xff, (PAGE_SIZE + OOB_SIZE) << s->erase_shift);
585 } else if (s->mem_oob) {
586 memset(s->storage + (PAGE(addr) << OOB_SHIFT),
587 0xff, OOB_SIZE << s->erase_shift);
589 page = SECTOR(addr + (ADDR_SHIFT + s->erase_shift));
590 for (; i < page; i ++)
591 if (bdrv_write(s->bdrv, i, iobuf, 1) == -1)
592 printf("%s: write error in sector %i\n", __FUNCTION__, i);
594 addr = PAGE_START(addr);
596 if (bdrv_read(s->bdrv, page, iobuf, 1) == -1)
597 printf("%s: read error in sector %i\n", __FUNCTION__, page);
598 memset(iobuf + (addr & 0x1ff), 0xff, (~addr & 0x1ff) + 1);
599 if (bdrv_write(s->bdrv, page, iobuf, 1) == -1)
600 printf("%s: write error in sector %i\n", __FUNCTION__, page);
602 memset(iobuf, 0xff, 0x200);
603 i = (addr & ~0x1ff) + 0x200;
604 for (addr += ((PAGE_SIZE + OOB_SIZE) << s->erase_shift) - 0x200;
605 i < addr; i += 0x200)
606 if (bdrv_write(s->bdrv, i >> 9, iobuf, 1) == -1)
607 printf("%s: write error in sector %i\n", __FUNCTION__, i >> 9);
610 if (bdrv_read(s->bdrv, page, iobuf, 1) == -1)
611 printf("%s: read error in sector %i\n", __FUNCTION__, page);
612 memset(iobuf, 0xff, ((addr - 1) & 0x1ff) + 1);
613 if (bdrv_write(s->bdrv, page, iobuf, 1) == -1)
614 printf("%s: write error in sector %i\n", __FUNCTION__, page);
618 static void glue(nand_blk_load_, PAGE_SIZE)(NANDFlashState *s,
619 uint32_t addr, int offset)
621 if (PAGE(addr) >= s->pages)
626 if (bdrv_read(s->bdrv, SECTOR(addr), s->io, PAGE_SECTORS) == -1)
627 printf("%s: read error in sector %i\n",
628 __FUNCTION__, SECTOR(addr));
629 memcpy(s->io + SECTOR_OFFSET(s->addr) + PAGE_SIZE,
630 s->storage + (PAGE(s->addr) << OOB_SHIFT),
632 s->ioaddr = s->io + SECTOR_OFFSET(s->addr) + offset;
634 if (bdrv_read(s->bdrv, PAGE_START(addr) >> 9,
635 s->io, (PAGE_SECTORS + 2)) == -1)
636 printf("%s: read error in sector %i\n",
637 __FUNCTION__, PAGE_START(addr) >> 9);
638 s->ioaddr = s->io + (PAGE_START(addr) & 0x1ff) + offset;
641 memcpy(s->io, s->storage + PAGE_START(s->addr) +
642 offset, PAGE_SIZE + OOB_SIZE - offset);
647 static void glue(nand_init_, PAGE_SIZE)(NANDFlashState *s)
649 s->oob_shift = PAGE_SHIFT - 5;
650 s->pages = s->size >> PAGE_SHIFT;
651 s->addr_shift = ADDR_SHIFT;
653 s->blk_erase = glue(nand_blk_erase_, PAGE_SIZE);
654 s->blk_write = glue(nand_blk_write_, PAGE_SIZE);
655 s->blk_load = glue(nand_blk_load_, PAGE_SIZE);