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 ...
40 #include "hw/block/flash.h"
41 #include "block/block.h"
42 #include "qemu/timer.h"
43 #include "qemu/bitops.h"
44 #include "exec/address-spaces.h"
45 #include "qemu/host-utils.h"
46 #include "hw/sysbus.h"
48 #define PFLASH_BUG(fmt, ...) \
50 fprintf(stderr, "PFLASH: Possible BUG - " fmt, ## __VA_ARGS__); \
54 /* #define PFLASH_DEBUG */
56 #define DPRINTF(fmt, ...) \
58 fprintf(stderr, "PFLASH: " fmt , ## __VA_ARGS__); \
61 #define DPRINTF(fmt, ...) do { } while (0)
64 #define TYPE_CFI_PFLASH01 "cfi.pflash01"
65 #define CFI_PFLASH01(obj) OBJECT_CHECK(pflash_t, (obj), TYPE_CFI_PFLASH01)
69 SysBusDevice parent_obj;
76 uint8_t device_width; /* If 0, device width not specified. */
78 uint8_t wcycle; /* if 0, the flash is read normally */
87 uint8_t cfi_table[0x52];
89 unsigned int writeblock_size;
96 static const VMStateDescription vmstate_pflash = {
97 .name = "pflash_cfi01",
99 .minimum_version_id = 1,
100 .fields = (VMStateField[]) {
101 VMSTATE_UINT8(wcycle, pflash_t),
102 VMSTATE_UINT8(cmd, pflash_t),
103 VMSTATE_UINT8(status, pflash_t),
104 VMSTATE_UINT64(counter, pflash_t),
105 VMSTATE_END_OF_LIST()
109 static void pflash_timer (void *opaque)
111 pflash_t *pfl = opaque;
113 DPRINTF("%s: command %02x done\n", __func__, pfl->cmd);
116 memory_region_rom_device_set_romd(&pfl->mem, true);
121 static uint32_t pflash_read (pflash_t *pfl, hwaddr offset,
129 boff = offset & 0xFF; /* why this here ?? */
131 if (pfl->bank_width == 2) {
133 } else if (pfl->bank_width == 4) {
138 DPRINTF("%s: reading offset " TARGET_FMT_plx " under cmd %02x width %d\n",
139 __func__, offset, pfl->cmd, width);
143 /* This should never happen : reset state & treat it as a read */
144 DPRINTF("%s: unknown command state: %x\n", __func__, pfl->cmd);
147 /* fall through to read code */
149 /* Flash area read */
154 DPRINTF("%s: data offset " TARGET_FMT_plx " %02x\n",
155 __func__, offset, ret);
159 ret = p[offset] << 8;
160 ret |= p[offset + 1];
163 ret |= p[offset + 1] << 8;
165 DPRINTF("%s: data offset " TARGET_FMT_plx " %04x\n",
166 __func__, offset, ret);
170 ret = p[offset] << 24;
171 ret |= p[offset + 1] << 16;
172 ret |= p[offset + 2] << 8;
173 ret |= p[offset + 3];
176 ret |= p[offset + 1] << 8;
177 ret |= p[offset + 2] << 16;
178 ret |= p[offset + 3] << 24;
180 DPRINTF("%s: data offset " TARGET_FMT_plx " %08x\n",
181 __func__, offset, ret);
184 DPRINTF("BUG in %s\n", __func__);
188 case 0x10: /* Single byte program */
189 case 0x20: /* Block erase */
190 case 0x28: /* Block erase */
191 case 0x40: /* single byte program */
192 case 0x50: /* Clear status register */
193 case 0x60: /* Block /un)lock */
194 case 0x70: /* Status Register */
195 case 0xe8: /* Write block */
196 /* Status register read */
199 ret |= pfl->status << 16;
201 DPRINTF("%s: status %x\n", __func__, ret);
206 ret = pfl->ident0 << 8 | pfl->ident1;
207 DPRINTF("%s: Manufacturer Code %04x\n", __func__, ret);
210 ret = pfl->ident2 << 8 | pfl->ident3;
211 DPRINTF("%s: Device ID Code %04x\n", __func__, ret);
214 DPRINTF("%s: Read Device Information boff=%x\n", __func__,
220 case 0x98: /* Query mode */
221 if (boff > pfl->cfi_len)
224 ret = pfl->cfi_table[boff];
230 /* update flash content on disk */
231 static void pflash_update(pflash_t *pfl, int offset,
236 offset_end = offset + size;
237 /* round to sectors */
238 offset = offset >> 9;
239 offset_end = (offset_end + 511) >> 9;
240 bdrv_write(pfl->bs, offset, pfl->storage + (offset << 9),
241 offset_end - offset);
245 static inline void pflash_data_write(pflash_t *pfl, hwaddr offset,
246 uint32_t value, int width, int be)
248 uint8_t *p = pfl->storage;
250 DPRINTF("%s: block write offset " TARGET_FMT_plx
251 " value %x counter %016" PRIx64 "\n",
252 __func__, offset, value, pfl->counter);
259 p[offset] = value >> 8;
260 p[offset + 1] = value;
263 p[offset + 1] = value >> 8;
268 p[offset] = value >> 24;
269 p[offset + 1] = value >> 16;
270 p[offset + 2] = value >> 8;
271 p[offset + 3] = value;
274 p[offset + 1] = value >> 8;
275 p[offset + 2] = value >> 16;
276 p[offset + 3] = value >> 24;
283 static void pflash_write(pflash_t *pfl, hwaddr offset,
284 uint32_t value, int width, int be)
291 DPRINTF("%s: writing offset " TARGET_FMT_plx " value %08x width %d wcycle 0x%x\n",
292 __func__, offset, value, width, pfl->wcycle);
295 /* Set the device in I/O access mode */
296 memory_region_rom_device_set_romd(&pfl->mem, false);
299 switch (pfl->wcycle) {
305 case 0x10: /* Single Byte Program */
306 case 0x40: /* Single Byte Program */
307 DPRINTF("%s: Single Byte Program\n", __func__);
309 case 0x20: /* Block erase */
311 offset &= ~(pfl->sector_len - 1);
313 DPRINTF("%s: block erase at " TARGET_FMT_plx " bytes %x\n",
314 __func__, offset, (unsigned)pfl->sector_len);
317 memset(p + offset, 0xff, pfl->sector_len);
318 pflash_update(pfl, offset, pfl->sector_len);
320 pfl->status |= 0x20; /* Block erase error */
322 pfl->status |= 0x80; /* Ready! */
324 case 0x50: /* Clear status bits */
325 DPRINTF("%s: Clear status bits\n", __func__);
328 case 0x60: /* Block (un)lock */
329 DPRINTF("%s: Block unlock\n", __func__);
331 case 0x70: /* Status Register */
332 DPRINTF("%s: Read status register\n", __func__);
335 case 0x90: /* Read Device ID */
336 DPRINTF("%s: Read Device information\n", __func__);
339 case 0x98: /* CFI query */
340 DPRINTF("%s: CFI query\n", __func__);
342 case 0xe8: /* Write to buffer */
343 DPRINTF("%s: Write to buffer\n", __func__);
344 pfl->status |= 0x80; /* Ready! */
346 case 0xf0: /* Probe for AMD flash */
347 DPRINTF("%s: Probe for AMD flash\n", __func__);
349 case 0xff: /* Read array mode */
350 DPRINTF("%s: Read array mode\n", __func__);
360 case 0x10: /* Single Byte Program */
361 case 0x40: /* Single Byte Program */
362 DPRINTF("%s: Single Byte Program\n", __func__);
364 pflash_data_write(pfl, offset, value, width, be);
365 pflash_update(pfl, offset, width);
367 pfl->status |= 0x10; /* Programming error */
369 pfl->status |= 0x80; /* Ready! */
372 case 0x20: /* Block erase */
374 if (cmd == 0xd0) { /* confirm */
377 } else if (cmd == 0xff) { /* read array mode */
384 /* Mask writeblock size based on device width, or bank width if
385 * device width not specified.
387 if (pfl->device_width) {
388 value = extract32(value, 0, pfl->device_width * 8);
390 value = extract32(value, 0, pfl->bank_width * 8);
392 DPRINTF("%s: block write of %x bytes\n", __func__, value);
393 pfl->counter = value;
400 } else if (cmd == 0x01) {
403 } else if (cmd == 0xff) {
406 DPRINTF("%s: Unknown (un)locking command\n", __func__);
414 DPRINTF("%s: leaving query mode\n", __func__);
423 case 0xe8: /* Block write */
425 pflash_data_write(pfl, offset, value, width, be);
427 pfl->status |= 0x10; /* Programming error */
433 hwaddr mask = pfl->writeblock_size - 1;
436 DPRINTF("%s: block write finished\n", __func__);
439 /* Flush the entire write buffer onto backing storage. */
440 pflash_update(pfl, offset & mask, pfl->writeblock_size);
442 pfl->status |= 0x10; /* Programming error */
452 case 3: /* Confirm mode */
454 case 0xe8: /* Block write */
459 DPRINTF("%s: unknown command for \"write block\"\n", __func__);
460 PFLASH_BUG("Write block confirm");
469 /* Should never happen */
470 DPRINTF("%s: invalid write state\n", __func__);
476 qemu_log_mask(LOG_UNIMP, "%s: Unimplemented flash cmd sequence "
477 "(offset " TARGET_FMT_plx ", wcycle 0x%x cmd 0x%x value 0x%x)"
478 "\n", __func__, offset, pfl->wcycle, pfl->cmd, value);
481 memory_region_rom_device_set_romd(&pfl->mem, true);
488 static uint32_t pflash_readb_be(void *opaque, hwaddr addr)
490 return pflash_read(opaque, addr, 1, 1);
493 static uint32_t pflash_readb_le(void *opaque, hwaddr addr)
495 return pflash_read(opaque, addr, 1, 0);
498 static uint32_t pflash_readw_be(void *opaque, hwaddr addr)
500 pflash_t *pfl = opaque;
502 return pflash_read(pfl, addr, 2, 1);
505 static uint32_t pflash_readw_le(void *opaque, hwaddr addr)
507 pflash_t *pfl = opaque;
509 return pflash_read(pfl, addr, 2, 0);
512 static uint32_t pflash_readl_be(void *opaque, hwaddr addr)
514 pflash_t *pfl = opaque;
516 return pflash_read(pfl, addr, 4, 1);
519 static uint32_t pflash_readl_le(void *opaque, hwaddr addr)
521 pflash_t *pfl = opaque;
523 return pflash_read(pfl, addr, 4, 0);
526 static void pflash_writeb_be(void *opaque, hwaddr addr,
529 pflash_write(opaque, addr, value, 1, 1);
532 static void pflash_writeb_le(void *opaque, hwaddr addr,
535 pflash_write(opaque, addr, value, 1, 0);
538 static void pflash_writew_be(void *opaque, hwaddr addr,
541 pflash_t *pfl = opaque;
543 pflash_write(pfl, addr, value, 2, 1);
546 static void pflash_writew_le(void *opaque, hwaddr addr,
549 pflash_t *pfl = opaque;
551 pflash_write(pfl, addr, value, 2, 0);
554 static void pflash_writel_be(void *opaque, hwaddr addr,
557 pflash_t *pfl = opaque;
559 pflash_write(pfl, addr, value, 4, 1);
562 static void pflash_writel_le(void *opaque, hwaddr addr,
565 pflash_t *pfl = opaque;
567 pflash_write(pfl, addr, value, 4, 0);
570 static const MemoryRegionOps pflash_cfi01_ops_be = {
572 .read = { pflash_readb_be, pflash_readw_be, pflash_readl_be, },
573 .write = { pflash_writeb_be, pflash_writew_be, pflash_writel_be, },
575 .endianness = DEVICE_NATIVE_ENDIAN,
578 static const MemoryRegionOps pflash_cfi01_ops_le = {
580 .read = { pflash_readb_le, pflash_readw_le, pflash_readl_le, },
581 .write = { pflash_writeb_le, pflash_writew_le, pflash_writel_le, },
583 .endianness = DEVICE_NATIVE_ENDIAN,
586 static void pflash_cfi01_realize(DeviceState *dev, Error **errp)
588 pflash_t *pfl = CFI_PFLASH01(dev);
592 total_len = pfl->sector_len * pfl->nb_blocs;
594 /* XXX: to be fixed */
596 if (total_len != (8 * 1024 * 1024) && total_len != (16 * 1024 * 1024) &&
597 total_len != (32 * 1024 * 1024) && total_len != (64 * 1024 * 1024))
601 memory_region_init_rom_device(
602 &pfl->mem, OBJECT(dev),
603 pfl->be ? &pflash_cfi01_ops_be : &pflash_cfi01_ops_le, pfl,
604 pfl->name, total_len);
605 vmstate_register_ram(&pfl->mem, DEVICE(pfl));
606 pfl->storage = memory_region_get_ram_ptr(&pfl->mem);
607 sysbus_init_mmio(SYS_BUS_DEVICE(dev), &pfl->mem);
610 /* read the initial flash content */
611 ret = bdrv_read(pfl->bs, 0, pfl->storage, total_len >> 9);
614 vmstate_unregister_ram(&pfl->mem, DEVICE(pfl));
615 memory_region_destroy(&pfl->mem);
616 error_setg(errp, "failed to read the initial flash content");
622 pfl->ro = bdrv_is_read_only(pfl->bs);
627 pfl->timer = timer_new_ns(QEMU_CLOCK_VIRTUAL, pflash_timer, pfl);
631 /* Hardcoded CFI table */
633 /* Standard "QRY" string */
634 pfl->cfi_table[0x10] = 'Q';
635 pfl->cfi_table[0x11] = 'R';
636 pfl->cfi_table[0x12] = 'Y';
637 /* Command set (Intel) */
638 pfl->cfi_table[0x13] = 0x01;
639 pfl->cfi_table[0x14] = 0x00;
640 /* Primary extended table address (none) */
641 pfl->cfi_table[0x15] = 0x31;
642 pfl->cfi_table[0x16] = 0x00;
643 /* Alternate command set (none) */
644 pfl->cfi_table[0x17] = 0x00;
645 pfl->cfi_table[0x18] = 0x00;
646 /* Alternate extended table (none) */
647 pfl->cfi_table[0x19] = 0x00;
648 pfl->cfi_table[0x1A] = 0x00;
650 pfl->cfi_table[0x1B] = 0x45;
652 pfl->cfi_table[0x1C] = 0x55;
653 /* Vpp min (no Vpp pin) */
654 pfl->cfi_table[0x1D] = 0x00;
655 /* Vpp max (no Vpp pin) */
656 pfl->cfi_table[0x1E] = 0x00;
658 pfl->cfi_table[0x1F] = 0x07;
659 /* Timeout for min size buffer write */
660 pfl->cfi_table[0x20] = 0x07;
661 /* Typical timeout for block erase */
662 pfl->cfi_table[0x21] = 0x0a;
663 /* Typical timeout for full chip erase (4096 ms) */
664 pfl->cfi_table[0x22] = 0x00;
666 pfl->cfi_table[0x23] = 0x04;
667 /* Max timeout for buffer write */
668 pfl->cfi_table[0x24] = 0x04;
669 /* Max timeout for block erase */
670 pfl->cfi_table[0x25] = 0x04;
671 /* Max timeout for chip erase */
672 pfl->cfi_table[0x26] = 0x00;
674 pfl->cfi_table[0x27] = ctz32(total_len); // + 1;
675 /* Flash device interface (8 & 16 bits) */
676 pfl->cfi_table[0x28] = 0x02;
677 pfl->cfi_table[0x29] = 0x00;
678 /* Max number of bytes in multi-bytes write */
679 if (pfl->bank_width == 1) {
680 pfl->cfi_table[0x2A] = 0x08;
682 pfl->cfi_table[0x2A] = 0x0B;
684 pfl->writeblock_size = 1 << pfl->cfi_table[0x2A];
686 pfl->cfi_table[0x2B] = 0x00;
687 /* Number of erase block regions (uniform) */
688 pfl->cfi_table[0x2C] = 0x01;
689 /* Erase block region 1 */
690 pfl->cfi_table[0x2D] = pfl->nb_blocs - 1;
691 pfl->cfi_table[0x2E] = (pfl->nb_blocs - 1) >> 8;
692 pfl->cfi_table[0x2F] = pfl->sector_len >> 8;
693 pfl->cfi_table[0x30] = pfl->sector_len >> 16;
696 pfl->cfi_table[0x31] = 'P';
697 pfl->cfi_table[0x32] = 'R';
698 pfl->cfi_table[0x33] = 'I';
700 pfl->cfi_table[0x34] = '1';
701 pfl->cfi_table[0x35] = '0';
703 pfl->cfi_table[0x36] = 0x00;
704 pfl->cfi_table[0x37] = 0x00;
705 pfl->cfi_table[0x38] = 0x00;
706 pfl->cfi_table[0x39] = 0x00;
708 pfl->cfi_table[0x3a] = 0x00;
710 pfl->cfi_table[0x3b] = 0x00;
711 pfl->cfi_table[0x3c] = 0x00;
713 pfl->cfi_table[0x3f] = 0x01; /* Number of protection fields */
716 static Property pflash_cfi01_properties[] = {
717 DEFINE_PROP_DRIVE("drive", struct pflash_t, bs),
718 DEFINE_PROP_UINT32("num-blocks", struct pflash_t, nb_blocs, 0),
719 DEFINE_PROP_UINT64("sector-length", struct pflash_t, sector_len, 0),
720 DEFINE_PROP_UINT8("width", struct pflash_t, bank_width, 0),
721 DEFINE_PROP_UINT8("device-width", struct pflash_t, device_width, 0),
722 DEFINE_PROP_UINT8("big-endian", struct pflash_t, be, 0),
723 DEFINE_PROP_UINT16("id0", struct pflash_t, ident0, 0),
724 DEFINE_PROP_UINT16("id1", struct pflash_t, ident1, 0),
725 DEFINE_PROP_UINT16("id2", struct pflash_t, ident2, 0),
726 DEFINE_PROP_UINT16("id3", struct pflash_t, ident3, 0),
727 DEFINE_PROP_STRING("name", struct pflash_t, name),
728 DEFINE_PROP_END_OF_LIST(),
731 static void pflash_cfi01_class_init(ObjectClass *klass, void *data)
733 DeviceClass *dc = DEVICE_CLASS(klass);
735 dc->realize = pflash_cfi01_realize;
736 dc->props = pflash_cfi01_properties;
737 dc->vmsd = &vmstate_pflash;
738 set_bit(DEVICE_CATEGORY_STORAGE, dc->categories);
742 static const TypeInfo pflash_cfi01_info = {
743 .name = TYPE_CFI_PFLASH01,
744 .parent = TYPE_SYS_BUS_DEVICE,
745 .instance_size = sizeof(struct pflash_t),
746 .class_init = pflash_cfi01_class_init,
749 static void pflash_cfi01_register_types(void)
751 type_register_static(&pflash_cfi01_info);
754 type_init(pflash_cfi01_register_types)
756 pflash_t *pflash_cfi01_register(hwaddr base,
757 DeviceState *qdev, const char *name,
759 BlockDriverState *bs,
760 uint32_t sector_len, int nb_blocs,
761 int bank_width, uint16_t id0, uint16_t id1,
762 uint16_t id2, uint16_t id3, int be)
764 DeviceState *dev = qdev_create(NULL, TYPE_CFI_PFLASH01);
766 if (bs && qdev_prop_set_drive(dev, "drive", bs)) {
769 qdev_prop_set_uint32(dev, "num-blocks", nb_blocs);
770 qdev_prop_set_uint64(dev, "sector-length", sector_len);
771 qdev_prop_set_uint8(dev, "width", bank_width);
772 qdev_prop_set_uint8(dev, "big-endian", !!be);
773 qdev_prop_set_uint16(dev, "id0", id0);
774 qdev_prop_set_uint16(dev, "id1", id1);
775 qdev_prop_set_uint16(dev, "id2", id2);
776 qdev_prop_set_uint16(dev, "id3", id3);
777 qdev_prop_set_string(dev, "name", name);
778 qdev_init_nofail(dev);
780 sysbus_mmio_map(SYS_BUS_DEVICE(dev), 0, base);
781 return CFI_PFLASH01(dev);
784 MemoryRegion *pflash_cfi01_get_memory(pflash_t *fl)