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 ...
41 #include "block/block.h"
42 #include "qemu/timer.h"
43 #include "exec/address-spaces.h"
44 #include "qemu/host-utils.h"
47 #define PFLASH_BUG(fmt, ...) \
49 fprintf(stderr, "PFLASH: Possible BUG - " fmt, ## __VA_ARGS__); \
53 /* #define PFLASH_DEBUG */
55 #define DPRINTF(fmt, ...) \
57 fprintf(stderr, "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__,
191 case 0x98: /* Query mode */
192 if (boff > pfl->cfi_len)
195 ret = pfl->cfi_table[boff];
198 /* This should never happen : reset state & treat it as a read */
199 DPRINTF("%s: unknown command state: %x\n", __func__, pfl->cmd);
206 /* update flash content on disk */
207 static void pflash_update(pflash_t *pfl, int offset,
212 offset_end = offset + size;
213 /* round to sectors */
214 offset = offset >> 9;
215 offset_end = (offset_end + 511) >> 9;
216 bdrv_write(pfl->bs, offset, pfl->storage + (offset << 9),
217 offset_end - offset);
221 static inline void pflash_data_write(pflash_t *pfl, hwaddr offset,
222 uint32_t value, int width, int be)
224 uint8_t *p = pfl->storage;
226 DPRINTF("%s: block write offset " TARGET_FMT_plx
227 " value %x counter " TARGET_FMT_plx "\n",
228 __func__, offset, value, pfl->counter);
235 p[offset] = value >> 8;
236 p[offset + 1] = value;
239 p[offset + 1] = value >> 8;
244 p[offset] = value >> 24;
245 p[offset + 1] = value >> 16;
246 p[offset + 2] = value >> 8;
247 p[offset + 3] = value;
250 p[offset + 1] = value >> 8;
251 p[offset + 2] = value >> 16;
252 p[offset + 3] = value >> 24;
259 static void pflash_write(pflash_t *pfl, hwaddr offset,
260 uint32_t value, int width, int be)
267 DPRINTF("%s: writing offset " TARGET_FMT_plx " value %08x width %d wcycle 0x%x\n",
268 __func__, offset, value, width, pfl->wcycle);
271 /* Set the device in I/O access mode */
272 memory_region_rom_device_set_readable(&pfl->mem, false);
275 switch (pfl->wcycle) {
281 case 0x10: /* Single Byte Program */
282 case 0x40: /* Single Byte Program */
283 DPRINTF("%s: Single Byte Program\n", __func__);
285 case 0x20: /* Block erase */
287 offset &= ~(pfl->sector_len - 1);
289 DPRINTF("%s: block erase at " TARGET_FMT_plx " bytes %x\n",
290 __func__, offset, (unsigned)pfl->sector_len);
293 memset(p + offset, 0xff, pfl->sector_len);
294 pflash_update(pfl, offset, pfl->sector_len);
296 pfl->status |= 0x20; /* Block erase error */
298 pfl->status |= 0x80; /* Ready! */
300 case 0x50: /* Clear status bits */
301 DPRINTF("%s: Clear status bits\n", __func__);
304 case 0x60: /* Block (un)lock */
305 DPRINTF("%s: Block unlock\n", __func__);
307 case 0x70: /* Status Register */
308 DPRINTF("%s: Read status register\n", __func__);
311 case 0x90: /* Read Device ID */
312 DPRINTF("%s: Read Device information\n", __func__);
315 case 0x98: /* CFI query */
316 DPRINTF("%s: CFI query\n", __func__);
318 case 0xe8: /* Write to buffer */
319 DPRINTF("%s: Write to buffer\n", __func__);
320 pfl->status |= 0x80; /* Ready! */
322 case 0xf0: /* Probe for AMD flash */
323 DPRINTF("%s: Probe for AMD flash\n", __func__);
325 case 0xff: /* Read array mode */
326 DPRINTF("%s: Read array mode\n", __func__);
336 case 0x10: /* Single Byte Program */
337 case 0x40: /* Single Byte Program */
338 DPRINTF("%s: Single Byte Program\n", __func__);
340 pflash_data_write(pfl, offset, value, width, be);
341 pflash_update(pfl, offset, width);
343 pfl->status |= 0x10; /* Programming error */
345 pfl->status |= 0x80; /* Ready! */
348 case 0x20: /* Block erase */
350 if (cmd == 0xd0) { /* confirm */
353 } else if (cmd == 0xff) { /* read array mode */
360 DPRINTF("%s: block write of %x bytes\n", __func__, value);
361 pfl->counter = value;
368 } else if (cmd == 0x01) {
371 } else if (cmd == 0xff) {
374 DPRINTF("%s: Unknown (un)locking command\n", __func__);
382 DPRINTF("%s: leaving query mode\n", __func__);
391 case 0xe8: /* Block write */
393 pflash_data_write(pfl, offset, value, width, be);
395 pfl->status |= 0x10; /* Programming error */
401 hwaddr mask = pfl->writeblock_size - 1;
404 DPRINTF("%s: block write finished\n", __func__);
407 /* Flush the entire write buffer onto backing storage. */
408 pflash_update(pfl, offset & mask, pfl->writeblock_size);
410 pfl->status |= 0x10; /* Programming error */
420 case 3: /* Confirm mode */
422 case 0xe8: /* Block write */
427 DPRINTF("%s: unknown command for \"write block\"\n", __func__);
428 PFLASH_BUG("Write block confirm");
437 /* Should never happen */
438 DPRINTF("%s: invalid write state\n", __func__);
444 qemu_log_mask(LOG_UNIMP, "%s: Unimplemented flash cmd sequence "
445 "(offset " TARGET_FMT_plx ", wcycle 0x%x cmd 0x%x value 0x%x)"
446 "\n", __func__, offset, pfl->wcycle, pfl->cmd, value);
449 memory_region_rom_device_set_readable(&pfl->mem, true);
457 static uint32_t pflash_readb_be(void *opaque, hwaddr addr)
459 return pflash_read(opaque, addr, 1, 1);
462 static uint32_t pflash_readb_le(void *opaque, hwaddr addr)
464 return pflash_read(opaque, addr, 1, 0);
467 static uint32_t pflash_readw_be(void *opaque, hwaddr addr)
469 pflash_t *pfl = opaque;
471 return pflash_read(pfl, addr, 2, 1);
474 static uint32_t pflash_readw_le(void *opaque, hwaddr addr)
476 pflash_t *pfl = opaque;
478 return pflash_read(pfl, addr, 2, 0);
481 static uint32_t pflash_readl_be(void *opaque, hwaddr addr)
483 pflash_t *pfl = opaque;
485 return pflash_read(pfl, addr, 4, 1);
488 static uint32_t pflash_readl_le(void *opaque, hwaddr addr)
490 pflash_t *pfl = opaque;
492 return pflash_read(pfl, addr, 4, 0);
495 static void pflash_writeb_be(void *opaque, hwaddr addr,
498 pflash_write(opaque, addr, value, 1, 1);
501 static void pflash_writeb_le(void *opaque, hwaddr addr,
504 pflash_write(opaque, addr, value, 1, 0);
507 static void pflash_writew_be(void *opaque, hwaddr addr,
510 pflash_t *pfl = opaque;
512 pflash_write(pfl, addr, value, 2, 1);
515 static void pflash_writew_le(void *opaque, hwaddr addr,
518 pflash_t *pfl = opaque;
520 pflash_write(pfl, addr, value, 2, 0);
523 static void pflash_writel_be(void *opaque, hwaddr addr,
526 pflash_t *pfl = opaque;
528 pflash_write(pfl, addr, value, 4, 1);
531 static void pflash_writel_le(void *opaque, hwaddr addr,
534 pflash_t *pfl = opaque;
536 pflash_write(pfl, addr, value, 4, 0);
539 static const MemoryRegionOps pflash_cfi01_ops_be = {
541 .read = { pflash_readb_be, pflash_readw_be, pflash_readl_be, },
542 .write = { pflash_writeb_be, pflash_writew_be, pflash_writel_be, },
544 .endianness = DEVICE_NATIVE_ENDIAN,
547 static const MemoryRegionOps pflash_cfi01_ops_le = {
549 .read = { pflash_readb_le, pflash_readw_le, pflash_readl_le, },
550 .write = { pflash_writeb_le, pflash_writew_le, pflash_writel_le, },
552 .endianness = DEVICE_NATIVE_ENDIAN,
555 static int pflash_cfi01_init(SysBusDevice *dev)
557 pflash_t *pfl = FROM_SYSBUS(typeof(*pfl), dev);
561 total_len = pfl->sector_len * pfl->nb_blocs;
563 /* XXX: to be fixed */
565 if (total_len != (8 * 1024 * 1024) && total_len != (16 * 1024 * 1024) &&
566 total_len != (32 * 1024 * 1024) && total_len != (64 * 1024 * 1024))
570 memory_region_init_rom_device(
571 &pfl->mem, pfl->be ? &pflash_cfi01_ops_be : &pflash_cfi01_ops_le, pfl,
572 pfl->name, total_len);
573 vmstate_register_ram(&pfl->mem, DEVICE(pfl));
574 pfl->storage = memory_region_get_ram_ptr(&pfl->mem);
575 sysbus_init_mmio(dev, &pfl->mem);
578 /* read the initial flash content */
579 ret = bdrv_read(pfl->bs, 0, pfl->storage, total_len >> 9);
582 vmstate_unregister_ram(&pfl->mem, DEVICE(pfl));
583 memory_region_destroy(&pfl->mem);
589 pfl->ro = bdrv_is_read_only(pfl->bs);
594 pfl->timer = qemu_new_timer_ns(vm_clock, pflash_timer, pfl);
598 /* Hardcoded CFI table */
600 /* Standard "QRY" string */
601 pfl->cfi_table[0x10] = 'Q';
602 pfl->cfi_table[0x11] = 'R';
603 pfl->cfi_table[0x12] = 'Y';
604 /* Command set (Intel) */
605 pfl->cfi_table[0x13] = 0x01;
606 pfl->cfi_table[0x14] = 0x00;
607 /* Primary extended table address (none) */
608 pfl->cfi_table[0x15] = 0x31;
609 pfl->cfi_table[0x16] = 0x00;
610 /* Alternate command set (none) */
611 pfl->cfi_table[0x17] = 0x00;
612 pfl->cfi_table[0x18] = 0x00;
613 /* Alternate extended table (none) */
614 pfl->cfi_table[0x19] = 0x00;
615 pfl->cfi_table[0x1A] = 0x00;
617 pfl->cfi_table[0x1B] = 0x45;
619 pfl->cfi_table[0x1C] = 0x55;
620 /* Vpp min (no Vpp pin) */
621 pfl->cfi_table[0x1D] = 0x00;
622 /* Vpp max (no Vpp pin) */
623 pfl->cfi_table[0x1E] = 0x00;
625 pfl->cfi_table[0x1F] = 0x07;
626 /* Timeout for min size buffer write */
627 pfl->cfi_table[0x20] = 0x07;
628 /* Typical timeout for block erase */
629 pfl->cfi_table[0x21] = 0x0a;
630 /* Typical timeout for full chip erase (4096 ms) */
631 pfl->cfi_table[0x22] = 0x00;
633 pfl->cfi_table[0x23] = 0x04;
634 /* Max timeout for buffer write */
635 pfl->cfi_table[0x24] = 0x04;
636 /* Max timeout for block erase */
637 pfl->cfi_table[0x25] = 0x04;
638 /* Max timeout for chip erase */
639 pfl->cfi_table[0x26] = 0x00;
641 pfl->cfi_table[0x27] = ctz32(total_len); // + 1;
642 /* Flash device interface (8 & 16 bits) */
643 pfl->cfi_table[0x28] = 0x02;
644 pfl->cfi_table[0x29] = 0x00;
645 /* Max number of bytes in multi-bytes write */
646 if (pfl->width == 1) {
647 pfl->cfi_table[0x2A] = 0x08;
649 pfl->cfi_table[0x2A] = 0x0B;
651 pfl->writeblock_size = 1 << pfl->cfi_table[0x2A];
653 pfl->cfi_table[0x2B] = 0x00;
654 /* Number of erase block regions (uniform) */
655 pfl->cfi_table[0x2C] = 0x01;
656 /* Erase block region 1 */
657 pfl->cfi_table[0x2D] = pfl->nb_blocs - 1;
658 pfl->cfi_table[0x2E] = (pfl->nb_blocs - 1) >> 8;
659 pfl->cfi_table[0x2F] = pfl->sector_len >> 8;
660 pfl->cfi_table[0x30] = pfl->sector_len >> 16;
663 pfl->cfi_table[0x31] = 'P';
664 pfl->cfi_table[0x32] = 'R';
665 pfl->cfi_table[0x33] = 'I';
667 pfl->cfi_table[0x34] = '1';
668 pfl->cfi_table[0x35] = '0';
670 pfl->cfi_table[0x36] = 0x00;
671 pfl->cfi_table[0x37] = 0x00;
672 pfl->cfi_table[0x38] = 0x00;
673 pfl->cfi_table[0x39] = 0x00;
675 pfl->cfi_table[0x3a] = 0x00;
677 pfl->cfi_table[0x3b] = 0x00;
678 pfl->cfi_table[0x3c] = 0x00;
680 pfl->cfi_table[0x3f] = 0x01; /* Number of protection fields */
685 static Property pflash_cfi01_properties[] = {
686 DEFINE_PROP_DRIVE("drive", struct pflash_t, bs),
687 DEFINE_PROP_UINT32("num-blocks", struct pflash_t, nb_blocs, 0),
688 DEFINE_PROP_UINT64("sector-length", struct pflash_t, sector_len, 0),
689 DEFINE_PROP_UINT8("width", struct pflash_t, width, 0),
690 DEFINE_PROP_UINT8("big-endian", struct pflash_t, be, 0),
691 DEFINE_PROP_UINT16("id0", struct pflash_t, ident0, 0),
692 DEFINE_PROP_UINT16("id1", struct pflash_t, ident1, 0),
693 DEFINE_PROP_UINT16("id2", struct pflash_t, ident2, 0),
694 DEFINE_PROP_UINT16("id3", struct pflash_t, ident3, 0),
695 DEFINE_PROP_STRING("name", struct pflash_t, name),
696 DEFINE_PROP_END_OF_LIST(),
699 static void pflash_cfi01_class_init(ObjectClass *klass, void *data)
701 DeviceClass *dc = DEVICE_CLASS(klass);
702 SysBusDeviceClass *k = SYS_BUS_DEVICE_CLASS(klass);
704 k->init = pflash_cfi01_init;
705 dc->props = pflash_cfi01_properties;
709 static const TypeInfo pflash_cfi01_info = {
710 .name = "cfi.pflash01",
711 .parent = TYPE_SYS_BUS_DEVICE,
712 .instance_size = sizeof(struct pflash_t),
713 .class_init = pflash_cfi01_class_init,
716 static void pflash_cfi01_register_types(void)
718 type_register_static(&pflash_cfi01_info);
721 type_init(pflash_cfi01_register_types)
723 pflash_t *pflash_cfi01_register(hwaddr base,
724 DeviceState *qdev, const char *name,
726 BlockDriverState *bs,
727 uint32_t sector_len, int nb_blocs, int width,
728 uint16_t id0, uint16_t id1,
729 uint16_t id2, uint16_t id3, int be)
731 DeviceState *dev = qdev_create(NULL, "cfi.pflash01");
732 SysBusDevice *busdev = sysbus_from_qdev(dev);
733 pflash_t *pfl = (pflash_t *)object_dynamic_cast(OBJECT(dev),
736 if (bs && qdev_prop_set_drive(dev, "drive", bs)) {
739 qdev_prop_set_uint32(dev, "num-blocks", nb_blocs);
740 qdev_prop_set_uint64(dev, "sector-length", sector_len);
741 qdev_prop_set_uint8(dev, "width", width);
742 qdev_prop_set_uint8(dev, "big-endian", !!be);
743 qdev_prop_set_uint16(dev, "id0", id0);
744 qdev_prop_set_uint16(dev, "id1", id1);
745 qdev_prop_set_uint16(dev, "id2", id2);
746 qdev_prop_set_uint16(dev, "id3", id3);
747 qdev_prop_set_string(dev, "name", name);
748 qdev_init_nofail(dev);
750 sysbus_mmio_map(busdev, 0, base);
754 MemoryRegion *pflash_cfi01_get_memory(pflash_t *fl)