2 * CFI parallel flash with Intel command set emulation
4 * Copyright (c) 2006 Thorsten Zitterell
5 * Copyright (c) 2005 Jocelyn Mayer
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
22 * For now, this code can emulate flashes of 1, 2 or 4 bytes width.
23 * Supported commands/modes are:
30 * It does not support timings
31 * It does not support flash interleaving
32 * It does not implement software data protection as found in many real chips
33 * It does not implement erase suspend/resume commands
34 * It does not implement multiple sectors erase
36 * It does not implement much more ...
42 #include "qemu-timer.h"
43 #include "exec-memory.h"
44 #include "host-utils.h"
47 #define PFLASH_BUG(fmt, ...) \
49 printf("PFLASH: Possible BUG - " fmt, ## __VA_ARGS__); \
53 /* #define PFLASH_DEBUG */
55 #define DPRINTF(fmt, ...) \
57 printf("PFLASH: " fmt , ## __VA_ARGS__); \
60 #define DPRINTF(fmt, ...) do { } while (0)
70 int wcycle; /* if 0, the flash is read normally */
80 uint8_t cfi_table[0x52];
82 unsigned int writeblock_size;
89 static void pflash_timer (void *opaque)
91 pflash_t *pfl = opaque;
93 DPRINTF("%s: command %02x done\n", __func__, pfl->cmd);
99 memory_region_rom_device_set_readable(&pfl->mem, true);
105 static uint32_t pflash_read (pflash_t *pfl, hwaddr offset,
113 boff = offset & 0xFF; /* why this here ?? */
117 else if (pfl->width == 4)
121 DPRINTF("%s: reading offset " TARGET_FMT_plx " under cmd %02x width %d\n",
122 __func__, offset, pfl->cmd, width);
126 /* Flash area read */
131 DPRINTF("%s: data offset " TARGET_FMT_plx " %02x\n",
132 __func__, offset, ret);
136 ret = p[offset] << 8;
137 ret |= p[offset + 1];
140 ret |= p[offset + 1] << 8;
142 DPRINTF("%s: data offset " TARGET_FMT_plx " %04x\n",
143 __func__, offset, ret);
147 ret = p[offset] << 24;
148 ret |= p[offset + 1] << 16;
149 ret |= p[offset + 2] << 8;
150 ret |= p[offset + 3];
153 ret |= p[offset + 1] << 8;
154 ret |= p[offset + 2] << 16;
155 ret |= p[offset + 3] << 24;
157 DPRINTF("%s: data offset " TARGET_FMT_plx " %08x\n",
158 __func__, offset, ret);
161 DPRINTF("BUG in %s\n", __func__);
165 case 0x20: /* Block erase */
166 case 0x50: /* Clear status register */
167 case 0x60: /* Block /un)lock */
168 case 0x70: /* Status Register */
169 case 0xe8: /* Write block */
170 /* Status register read */
172 DPRINTF("%s: status %x\n", __func__, ret);
177 ret = pfl->ident0 << 8 | pfl->ident1;
178 DPRINTF("%s: Manufacturer Code %04x\n", __func__, ret);
181 ret = pfl->ident2 << 8 | pfl->ident3;
182 DPRINTF("%s: Device ID Code %04x\n", __func__, ret);
185 DPRINTF("%s: Read Device Information boff=%x\n", __func__, boff);
190 case 0x98: /* Query mode */
191 if (boff > pfl->cfi_len)
194 ret = pfl->cfi_table[boff];
197 /* This should never happen : reset state & treat it as a read */
198 DPRINTF("%s: unknown command state: %x\n", __func__, pfl->cmd);
205 /* update flash content on disk */
206 static void pflash_update(pflash_t *pfl, int offset,
211 offset_end = offset + size;
212 /* round to sectors */
213 offset = offset >> 9;
214 offset_end = (offset_end + 511) >> 9;
215 bdrv_write(pfl->bs, offset, pfl->storage + (offset << 9),
216 offset_end - offset);
220 static inline void pflash_data_write(pflash_t *pfl, hwaddr offset,
221 uint32_t value, int width, int be)
223 uint8_t *p = pfl->storage;
225 DPRINTF("%s: block write offset " TARGET_FMT_plx
226 " value %x counter " TARGET_FMT_plx "\n",
227 __func__, offset, value, pfl->counter);
234 p[offset] = value >> 8;
235 p[offset + 1] = value;
238 p[offset + 1] = value >> 8;
243 p[offset] = value >> 24;
244 p[offset + 1] = value >> 16;
245 p[offset + 2] = value >> 8;
246 p[offset + 3] = value;
249 p[offset + 1] = value >> 8;
250 p[offset + 2] = value >> 16;
251 p[offset + 3] = value >> 24;
258 static void pflash_write(pflash_t *pfl, hwaddr offset,
259 uint32_t value, int width, int be)
266 DPRINTF("%s: writing offset " TARGET_FMT_plx " value %08x width %d wcycle 0x%x\n",
267 __func__, offset, value, width, pfl->wcycle);
270 /* Set the device in I/O access mode */
271 memory_region_rom_device_set_readable(&pfl->mem, false);
274 switch (pfl->wcycle) {
280 case 0x10: /* Single Byte Program */
281 case 0x40: /* Single Byte Program */
282 DPRINTF("%s: Single Byte Program\n", __func__);
284 case 0x20: /* Block erase */
286 offset &= ~(pfl->sector_len - 1);
288 DPRINTF("%s: block erase at " TARGET_FMT_plx " bytes %x\n",
289 __func__, offset, (unsigned)pfl->sector_len);
292 memset(p + offset, 0xff, pfl->sector_len);
293 pflash_update(pfl, offset, pfl->sector_len);
295 pfl->status |= 0x20; /* Block erase error */
297 pfl->status |= 0x80; /* Ready! */
299 case 0x50: /* Clear status bits */
300 DPRINTF("%s: Clear status bits\n", __func__);
303 case 0x60: /* Block (un)lock */
304 DPRINTF("%s: Block unlock\n", __func__);
306 case 0x70: /* Status Register */
307 DPRINTF("%s: Read status register\n", __func__);
310 case 0x90: /* Read Device ID */
311 DPRINTF("%s: Read Device information\n", __func__);
314 case 0x98: /* CFI query */
315 DPRINTF("%s: CFI query\n", __func__);
317 case 0xe8: /* Write to buffer */
318 DPRINTF("%s: Write to buffer\n", __func__);
319 pfl->status |= 0x80; /* Ready! */
321 case 0xff: /* Read array mode */
322 DPRINTF("%s: Read array mode\n", __func__);
332 case 0x10: /* Single Byte Program */
333 case 0x40: /* Single Byte Program */
334 DPRINTF("%s: Single Byte Program\n", __func__);
336 pflash_data_write(pfl, offset, value, width, be);
337 pflash_update(pfl, offset, width);
339 pfl->status |= 0x10; /* Programming error */
341 pfl->status |= 0x80; /* Ready! */
344 case 0x20: /* Block erase */
346 if (cmd == 0xd0) { /* confirm */
349 } else if (cmd == 0xff) { /* read array mode */
356 DPRINTF("%s: block write of %x bytes\n", __func__, value);
357 pfl->counter = value;
364 } else if (cmd == 0x01) {
367 } else if (cmd == 0xff) {
370 DPRINTF("%s: Unknown (un)locking command\n", __func__);
378 DPRINTF("%s: leaving query mode\n", __func__);
387 case 0xe8: /* Block write */
389 pflash_data_write(pfl, offset, value, width, be);
391 pfl->status |= 0x10; /* Programming error */
397 hwaddr mask = pfl->writeblock_size - 1;
400 DPRINTF("%s: block write finished\n", __func__);
403 /* Flush the entire write buffer onto backing storage. */
404 pflash_update(pfl, offset & mask, pfl->writeblock_size);
406 pfl->status |= 0x10; /* Programming error */
416 case 3: /* Confirm mode */
418 case 0xe8: /* Block write */
423 DPRINTF("%s: unknown command for \"write block\"\n", __func__);
424 PFLASH_BUG("Write block confirm");
433 /* Should never happen */
434 DPRINTF("%s: invalid write state\n", __func__);
440 printf("%s: Unimplemented flash cmd sequence "
441 "(offset " TARGET_FMT_plx ", wcycle 0x%x cmd 0x%x value 0x%x)\n",
442 __func__, offset, pfl->wcycle, pfl->cmd, value);
445 memory_region_rom_device_set_readable(&pfl->mem, true);
453 static uint32_t pflash_readb_be(void *opaque, hwaddr addr)
455 return pflash_read(opaque, addr, 1, 1);
458 static uint32_t pflash_readb_le(void *opaque, hwaddr addr)
460 return pflash_read(opaque, addr, 1, 0);
463 static uint32_t pflash_readw_be(void *opaque, hwaddr addr)
465 pflash_t *pfl = opaque;
467 return pflash_read(pfl, addr, 2, 1);
470 static uint32_t pflash_readw_le(void *opaque, hwaddr addr)
472 pflash_t *pfl = opaque;
474 return pflash_read(pfl, addr, 2, 0);
477 static uint32_t pflash_readl_be(void *opaque, hwaddr addr)
479 pflash_t *pfl = opaque;
481 return pflash_read(pfl, addr, 4, 1);
484 static uint32_t pflash_readl_le(void *opaque, hwaddr addr)
486 pflash_t *pfl = opaque;
488 return pflash_read(pfl, addr, 4, 0);
491 static void pflash_writeb_be(void *opaque, hwaddr addr,
494 pflash_write(opaque, addr, value, 1, 1);
497 static void pflash_writeb_le(void *opaque, hwaddr addr,
500 pflash_write(opaque, addr, value, 1, 0);
503 static void pflash_writew_be(void *opaque, hwaddr addr,
506 pflash_t *pfl = opaque;
508 pflash_write(pfl, addr, value, 2, 1);
511 static void pflash_writew_le(void *opaque, hwaddr addr,
514 pflash_t *pfl = opaque;
516 pflash_write(pfl, addr, value, 2, 0);
519 static void pflash_writel_be(void *opaque, hwaddr addr,
522 pflash_t *pfl = opaque;
524 pflash_write(pfl, addr, value, 4, 1);
527 static void pflash_writel_le(void *opaque, hwaddr addr,
530 pflash_t *pfl = opaque;
532 pflash_write(pfl, addr, value, 4, 0);
535 static const MemoryRegionOps pflash_cfi01_ops_be = {
537 .read = { pflash_readb_be, pflash_readw_be, pflash_readl_be, },
538 .write = { pflash_writeb_be, pflash_writew_be, pflash_writel_be, },
540 .endianness = DEVICE_NATIVE_ENDIAN,
543 static const MemoryRegionOps pflash_cfi01_ops_le = {
545 .read = { pflash_readb_le, pflash_readw_le, pflash_readl_le, },
546 .write = { pflash_writeb_le, pflash_writew_le, pflash_writel_le, },
548 .endianness = DEVICE_NATIVE_ENDIAN,
551 static int pflash_cfi01_init(SysBusDevice *dev)
553 pflash_t *pfl = FROM_SYSBUS(typeof(*pfl), dev);
557 total_len = pfl->sector_len * pfl->nb_blocs;
559 /* XXX: to be fixed */
561 if (total_len != (8 * 1024 * 1024) && total_len != (16 * 1024 * 1024) &&
562 total_len != (32 * 1024 * 1024) && total_len != (64 * 1024 * 1024))
566 memory_region_init_rom_device(
567 &pfl->mem, pfl->be ? &pflash_cfi01_ops_be : &pflash_cfi01_ops_le, pfl,
568 pfl->name, total_len);
569 vmstate_register_ram(&pfl->mem, DEVICE(pfl));
570 pfl->storage = memory_region_get_ram_ptr(&pfl->mem);
571 sysbus_init_mmio(dev, &pfl->mem);
574 /* read the initial flash content */
575 ret = bdrv_read(pfl->bs, 0, pfl->storage, total_len >> 9);
578 vmstate_unregister_ram(&pfl->mem, DEVICE(pfl));
579 memory_region_destroy(&pfl->mem);
585 pfl->ro = bdrv_is_read_only(pfl->bs);
590 pfl->timer = qemu_new_timer_ns(vm_clock, pflash_timer, pfl);
594 /* Hardcoded CFI table */
596 /* Standard "QRY" string */
597 pfl->cfi_table[0x10] = 'Q';
598 pfl->cfi_table[0x11] = 'R';
599 pfl->cfi_table[0x12] = 'Y';
600 /* Command set (Intel) */
601 pfl->cfi_table[0x13] = 0x01;
602 pfl->cfi_table[0x14] = 0x00;
603 /* Primary extended table address (none) */
604 pfl->cfi_table[0x15] = 0x31;
605 pfl->cfi_table[0x16] = 0x00;
606 /* Alternate command set (none) */
607 pfl->cfi_table[0x17] = 0x00;
608 pfl->cfi_table[0x18] = 0x00;
609 /* Alternate extended table (none) */
610 pfl->cfi_table[0x19] = 0x00;
611 pfl->cfi_table[0x1A] = 0x00;
613 pfl->cfi_table[0x1B] = 0x45;
615 pfl->cfi_table[0x1C] = 0x55;
616 /* Vpp min (no Vpp pin) */
617 pfl->cfi_table[0x1D] = 0x00;
618 /* Vpp max (no Vpp pin) */
619 pfl->cfi_table[0x1E] = 0x00;
621 pfl->cfi_table[0x1F] = 0x07;
622 /* Timeout for min size buffer write */
623 pfl->cfi_table[0x20] = 0x07;
624 /* Typical timeout for block erase */
625 pfl->cfi_table[0x21] = 0x0a;
626 /* Typical timeout for full chip erase (4096 ms) */
627 pfl->cfi_table[0x22] = 0x00;
629 pfl->cfi_table[0x23] = 0x04;
630 /* Max timeout for buffer write */
631 pfl->cfi_table[0x24] = 0x04;
632 /* Max timeout for block erase */
633 pfl->cfi_table[0x25] = 0x04;
634 /* Max timeout for chip erase */
635 pfl->cfi_table[0x26] = 0x00;
637 pfl->cfi_table[0x27] = ctz32(total_len); // + 1;
638 /* Flash device interface (8 & 16 bits) */
639 pfl->cfi_table[0x28] = 0x02;
640 pfl->cfi_table[0x29] = 0x00;
641 /* Max number of bytes in multi-bytes write */
642 if (pfl->width == 1) {
643 pfl->cfi_table[0x2A] = 0x08;
645 pfl->cfi_table[0x2A] = 0x0B;
647 pfl->writeblock_size = 1 << pfl->cfi_table[0x2A];
649 pfl->cfi_table[0x2B] = 0x00;
650 /* Number of erase block regions (uniform) */
651 pfl->cfi_table[0x2C] = 0x01;
652 /* Erase block region 1 */
653 pfl->cfi_table[0x2D] = pfl->nb_blocs - 1;
654 pfl->cfi_table[0x2E] = (pfl->nb_blocs - 1) >> 8;
655 pfl->cfi_table[0x2F] = pfl->sector_len >> 8;
656 pfl->cfi_table[0x30] = pfl->sector_len >> 16;
659 pfl->cfi_table[0x31] = 'P';
660 pfl->cfi_table[0x32] = 'R';
661 pfl->cfi_table[0x33] = 'I';
663 pfl->cfi_table[0x34] = '1';
664 pfl->cfi_table[0x35] = '0';
666 pfl->cfi_table[0x36] = 0x00;
667 pfl->cfi_table[0x37] = 0x00;
668 pfl->cfi_table[0x38] = 0x00;
669 pfl->cfi_table[0x39] = 0x00;
671 pfl->cfi_table[0x3a] = 0x00;
673 pfl->cfi_table[0x3b] = 0x00;
674 pfl->cfi_table[0x3c] = 0x00;
676 pfl->cfi_table[0x3f] = 0x01; /* Number of protection fields */
681 static Property pflash_cfi01_properties[] = {
682 DEFINE_PROP_DRIVE("drive", struct pflash_t, bs),
683 DEFINE_PROP_UINT32("num-blocks", struct pflash_t, nb_blocs, 0),
684 DEFINE_PROP_UINT64("sector-length", struct pflash_t, sector_len, 0),
685 DEFINE_PROP_UINT8("width", struct pflash_t, width, 0),
686 DEFINE_PROP_UINT8("big-endian", struct pflash_t, be, 0),
687 DEFINE_PROP_UINT16("id0", struct pflash_t, ident0, 0),
688 DEFINE_PROP_UINT16("id1", struct pflash_t, ident1, 0),
689 DEFINE_PROP_UINT16("id2", struct pflash_t, ident2, 0),
690 DEFINE_PROP_UINT16("id3", struct pflash_t, ident3, 0),
691 DEFINE_PROP_STRING("name", struct pflash_t, name),
692 DEFINE_PROP_END_OF_LIST(),
695 static void pflash_cfi01_class_init(ObjectClass *klass, void *data)
697 DeviceClass *dc = DEVICE_CLASS(klass);
698 SysBusDeviceClass *k = SYS_BUS_DEVICE_CLASS(klass);
700 k->init = pflash_cfi01_init;
701 dc->props = pflash_cfi01_properties;
705 static const TypeInfo pflash_cfi01_info = {
706 .name = "cfi.pflash01",
707 .parent = TYPE_SYS_BUS_DEVICE,
708 .instance_size = sizeof(struct pflash_t),
709 .class_init = pflash_cfi01_class_init,
712 static void pflash_cfi01_register_types(void)
714 type_register_static(&pflash_cfi01_info);
717 type_init(pflash_cfi01_register_types)
719 pflash_t *pflash_cfi01_register(hwaddr base,
720 DeviceState *qdev, const char *name,
722 BlockDriverState *bs,
723 uint32_t sector_len, int nb_blocs, int width,
724 uint16_t id0, uint16_t id1,
725 uint16_t id2, uint16_t id3, int be)
727 DeviceState *dev = qdev_create(NULL, "cfi.pflash01");
728 SysBusDevice *busdev = sysbus_from_qdev(dev);
729 pflash_t *pfl = (pflash_t *)object_dynamic_cast(OBJECT(dev),
732 if (bs && qdev_prop_set_drive(dev, "drive", bs)) {
735 qdev_prop_set_uint32(dev, "num-blocks", nb_blocs);
736 qdev_prop_set_uint64(dev, "sector-length", sector_len);
737 qdev_prop_set_uint8(dev, "width", width);
738 qdev_prop_set_uint8(dev, "big-endian", !!be);
739 qdev_prop_set_uint16(dev, "id0", id0);
740 qdev_prop_set_uint16(dev, "id1", id1);
741 qdev_prop_set_uint16(dev, "id2", id2);
742 qdev_prop_set_uint16(dev, "id3", id3);
743 qdev_prop_set_string(dev, "name", name);
744 qdev_init_nofail(dev);
746 sysbus_mmio_map(busdev, 0, base);
750 MemoryRegion *pflash_cfi01_get_memory(pflash_t *fl)