2 * CFI parallel flash with AMD command set emulation
4 * Copyright (c) 2005 Jocelyn Mayer
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
21 * For now, this code can emulate flashes of 1, 2 or 4 bytes width.
22 * Supported commands/modes are:
28 * - unlock bypass command
31 * It does not support flash interleaving.
32 * It does not implement boot blocs with reduced size
33 * It does not implement software data protection as found in many real chips
34 * It does not implement erase suspend/resume commands
35 * It does not implement multiple sectors erase
38 #include "qemu/osdep.h"
40 #include "hw/block/flash.h"
41 #include "qapi/error.h"
42 #include "qemu/timer.h"
43 #include "sysemu/block-backend.h"
44 #include "exec/address-spaces.h"
45 #include "qemu/host-utils.h"
46 #include "hw/sysbus.h"
48 //#define PFLASH_DEBUG
50 #define DPRINTF(fmt, ...) \
52 fprintf(stderr, "PFLASH: " fmt , ## __VA_ARGS__); \
55 #define DPRINTF(fmt, ...) do { } while (0)
58 #define PFLASH_LAZY_ROMD_THRESHOLD 42
60 #define TYPE_CFI_PFLASH02 "cfi.pflash02"
61 #define CFI_PFLASH02(obj) OBJECT_CHECK(pflash_t, (obj), TYPE_CFI_PFLASH02)
65 SysBusDevice parent_obj
;
75 int wcycle
; /* if 0, the flash is read normally */
80 /* FIXME: implement array device properties */
85 uint16_t unlock_addr0
;
86 uint16_t unlock_addr1
;
88 uint8_t cfi_table
[0x52];
90 /* The device replicates the flash memory across its memory space. Emulate
91 * that by having a container (.mem) filled with an array of aliases
92 * (.mem_mappings) pointing to the flash memory (.orig_mem).
95 MemoryRegion
*mem_mappings
; /* array; one per mapping */
96 MemoryRegion orig_mem
;
98 int read_counter
; /* used for lazy switch-back to rom mode */
104 * Set up replicated mappings of the same region.
106 static void pflash_setup_mappings(pflash_t
*pfl
)
109 hwaddr size
= memory_region_size(&pfl
->orig_mem
);
111 memory_region_init(&pfl
->mem
, OBJECT(pfl
), "pflash", pfl
->mappings
* size
);
112 pfl
->mem_mappings
= g_new(MemoryRegion
, pfl
->mappings
);
113 for (i
= 0; i
< pfl
->mappings
; ++i
) {
114 memory_region_init_alias(&pfl
->mem_mappings
[i
], OBJECT(pfl
),
115 "pflash-alias", &pfl
->orig_mem
, 0, size
);
116 memory_region_add_subregion(&pfl
->mem
, i
* size
, &pfl
->mem_mappings
[i
]);
120 static void pflash_register_memory(pflash_t
*pfl
, int rom_mode
)
122 memory_region_rom_device_set_romd(&pfl
->orig_mem
, rom_mode
);
123 pfl
->rom_mode
= rom_mode
;
126 static void pflash_timer (void *opaque
)
128 pflash_t
*pfl
= opaque
;
130 DPRINTF("%s: command %02x done\n", __func__
, pfl
->cmd
);
136 pflash_register_memory(pfl
, 1);
142 static uint32_t pflash_read (pflash_t
*pfl
, hwaddr offset
,
149 DPRINTF("%s: offset " TARGET_FMT_plx
"\n", __func__
, offset
);
151 /* Lazy reset to ROMD mode after a certain amount of read accesses */
152 if (!pfl
->rom_mode
&& pfl
->wcycle
== 0 &&
153 ++pfl
->read_counter
> PFLASH_LAZY_ROMD_THRESHOLD
) {
154 pflash_register_memory(pfl
, 1);
156 offset
&= pfl
->chip_len
- 1;
157 boff
= offset
& 0xFF;
160 else if (pfl
->width
== 4)
164 /* This should never happen : reset state & treat it as a read*/
165 DPRINTF("%s: unknown command state: %x\n", __func__
, pfl
->cmd
);
168 /* fall through to the read code */
170 /* We accept reads during second unlock sequence... */
173 /* Flash area read */
178 // DPRINTF("%s: data offset %08x %02x\n", __func__, offset, ret);
182 ret
= p
[offset
] << 8;
183 ret
|= p
[offset
+ 1];
186 ret
|= p
[offset
+ 1] << 8;
188 // DPRINTF("%s: data offset %08x %04x\n", __func__, offset, ret);
192 ret
= p
[offset
] << 24;
193 ret
|= p
[offset
+ 1] << 16;
194 ret
|= p
[offset
+ 2] << 8;
195 ret
|= p
[offset
+ 3];
198 ret
|= p
[offset
+ 1] << 8;
199 ret
|= p
[offset
+ 2] << 16;
200 ret
|= p
[offset
+ 3] << 24;
202 // DPRINTF("%s: data offset %08x %08x\n", __func__, offset, ret);
211 ret
= boff
& 0x01 ? pfl
->ident1
: pfl
->ident0
;
214 ret
= 0x00; /* Pretend all sectors are unprotected */
218 ret
= boff
& 0x01 ? pfl
->ident3
: pfl
->ident2
;
219 if (ret
== (uint8_t)-1) {
226 DPRINTF("%s: ID " TARGET_FMT_plx
" %x\n", __func__
, boff
, ret
);
231 /* Status register read */
233 DPRINTF("%s: status %x\n", __func__
, ret
);
239 if (boff
> pfl
->cfi_len
)
242 ret
= pfl
->cfi_table
[boff
];
249 /* update flash content on disk */
250 static void pflash_update(pflash_t
*pfl
, int offset
,
255 offset_end
= offset
+ size
;
256 /* widen to sector boundaries */
257 offset
= QEMU_ALIGN_DOWN(offset
, BDRV_SECTOR_SIZE
);
258 offset_end
= QEMU_ALIGN_UP(offset_end
, BDRV_SECTOR_SIZE
);
259 blk_pwrite(pfl
->blk
, offset
, pfl
->storage
+ offset
,
260 offset_end
- offset
, 0);
264 static void pflash_write (pflash_t
*pfl
, hwaddr offset
,
265 uint32_t value
, int width
, int be
)
272 if (pfl
->cmd
!= 0xA0 && cmd
== 0xF0) {
274 DPRINTF("%s: flash reset asked (%02x %02x)\n",
275 __func__
, pfl
->cmd
, cmd
);
279 DPRINTF("%s: offset " TARGET_FMT_plx
" %08x %d %d\n", __func__
,
280 offset
, value
, width
, pfl
->wcycle
);
281 offset
&= pfl
->chip_len
- 1;
283 DPRINTF("%s: offset " TARGET_FMT_plx
" %08x %d\n", __func__
,
284 offset
, value
, width
);
285 boff
= offset
& (pfl
->sector_len
- 1);
288 else if (pfl
->width
== 4)
290 switch (pfl
->wcycle
) {
292 /* Set the device in I/O access mode if required */
294 pflash_register_memory(pfl
, 0);
295 pfl
->read_counter
= 0;
296 /* We're in read mode */
298 if (boff
== 0x55 && cmd
== 0x98) {
300 /* Enter CFI query mode */
305 if (boff
!= pfl
->unlock_addr0
|| cmd
!= 0xAA) {
306 DPRINTF("%s: unlock0 failed " TARGET_FMT_plx
" %02x %04x\n",
307 __func__
, boff
, cmd
, pfl
->unlock_addr0
);
310 DPRINTF("%s: unlock sequence started\n", __func__
);
313 /* We started an unlock sequence */
315 if (boff
!= pfl
->unlock_addr1
|| cmd
!= 0x55) {
316 DPRINTF("%s: unlock1 failed " TARGET_FMT_plx
" %02x\n", __func__
,
320 DPRINTF("%s: unlock sequence done\n", __func__
);
323 /* We finished an unlock sequence */
324 if (!pfl
->bypass
&& boff
!= pfl
->unlock_addr0
) {
325 DPRINTF("%s: command failed " TARGET_FMT_plx
" %02x\n", __func__
,
337 DPRINTF("%s: starting command %02x\n", __func__
, cmd
);
340 DPRINTF("%s: unknown command %02x\n", __func__
, cmd
);
347 /* We need another unlock sequence */
350 DPRINTF("%s: write data offset " TARGET_FMT_plx
" %08x %d\n",
351 __func__
, offset
, value
, width
);
357 pflash_update(pfl
, offset
, 1);
361 p
[offset
] &= value
>> 8;
362 p
[offset
+ 1] &= value
;
365 p
[offset
+ 1] &= value
>> 8;
367 pflash_update(pfl
, offset
, 2);
371 p
[offset
] &= value
>> 24;
372 p
[offset
+ 1] &= value
>> 16;
373 p
[offset
+ 2] &= value
>> 8;
374 p
[offset
+ 3] &= value
;
377 p
[offset
+ 1] &= value
>> 8;
378 p
[offset
+ 2] &= value
>> 16;
379 p
[offset
+ 3] &= value
>> 24;
381 pflash_update(pfl
, offset
, 4);
385 pfl
->status
= 0x00 | ~(value
& 0x80);
386 /* Let's pretend write is immediate */
391 if (pfl
->bypass
&& cmd
== 0x00) {
392 /* Unlock bypass reset */
395 /* We can enter CFI query mode from autoselect mode */
396 if (boff
== 0x55 && cmd
== 0x98)
400 DPRINTF("%s: invalid write for command %02x\n",
407 /* Ignore writes while flash data write is occurring */
408 /* As we suppose write is immediate, this should never happen */
413 /* Should never happen */
414 DPRINTF("%s: invalid command state %02x (wc 4)\n",
422 if (boff
!= pfl
->unlock_addr0
) {
423 DPRINTF("%s: chip erase: invalid address " TARGET_FMT_plx
"\n",
428 DPRINTF("%s: start chip erase\n", __func__
);
430 memset(pfl
->storage
, 0xFF, pfl
->chip_len
);
431 pflash_update(pfl
, 0, pfl
->chip_len
);
434 /* Let's wait 5 seconds before chip erase is done */
435 timer_mod(pfl
->timer
, qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
) +
436 (NANOSECONDS_PER_SECOND
* 5));
441 offset
&= ~(pfl
->sector_len
- 1);
442 DPRINTF("%s: start sector erase at " TARGET_FMT_plx
"\n", __func__
,
445 memset(p
+ offset
, 0xFF, pfl
->sector_len
);
446 pflash_update(pfl
, offset
, pfl
->sector_len
);
449 /* Let's wait 1/2 second before sector erase is done */
450 timer_mod(pfl
->timer
, qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
) +
451 (NANOSECONDS_PER_SECOND
/ 2));
454 DPRINTF("%s: invalid command %02x (wc 5)\n", __func__
, cmd
);
462 /* Ignore writes during chip erase */
465 /* Ignore writes during sector erase */
468 /* Should never happen */
469 DPRINTF("%s: invalid command state %02x (wc 6)\n",
474 case 7: /* Special value for CFI queries */
475 DPRINTF("%s: invalid write in CFI query mode\n", __func__
);
478 /* Should never happen */
479 DPRINTF("%s: invalid write state (wc 7)\n", __func__
);
499 static uint32_t pflash_readb_be(void *opaque
, hwaddr addr
)
501 return pflash_read(opaque
, addr
, 1, 1);
504 static uint32_t pflash_readb_le(void *opaque
, hwaddr addr
)
506 return pflash_read(opaque
, addr
, 1, 0);
509 static uint32_t pflash_readw_be(void *opaque
, hwaddr addr
)
511 pflash_t
*pfl
= opaque
;
513 return pflash_read(pfl
, addr
, 2, 1);
516 static uint32_t pflash_readw_le(void *opaque
, hwaddr addr
)
518 pflash_t
*pfl
= opaque
;
520 return pflash_read(pfl
, addr
, 2, 0);
523 static uint32_t pflash_readl_be(void *opaque
, hwaddr addr
)
525 pflash_t
*pfl
= opaque
;
527 return pflash_read(pfl
, addr
, 4, 1);
530 static uint32_t pflash_readl_le(void *opaque
, hwaddr addr
)
532 pflash_t
*pfl
= opaque
;
534 return pflash_read(pfl
, addr
, 4, 0);
537 static void pflash_writeb_be(void *opaque
, hwaddr addr
,
540 pflash_write(opaque
, addr
, value
, 1, 1);
543 static void pflash_writeb_le(void *opaque
, hwaddr addr
,
546 pflash_write(opaque
, addr
, value
, 1, 0);
549 static void pflash_writew_be(void *opaque
, hwaddr addr
,
552 pflash_t
*pfl
= opaque
;
554 pflash_write(pfl
, addr
, value
, 2, 1);
557 static void pflash_writew_le(void *opaque
, hwaddr addr
,
560 pflash_t
*pfl
= opaque
;
562 pflash_write(pfl
, addr
, value
, 2, 0);
565 static void pflash_writel_be(void *opaque
, hwaddr addr
,
568 pflash_t
*pfl
= opaque
;
570 pflash_write(pfl
, addr
, value
, 4, 1);
573 static void pflash_writel_le(void *opaque
, hwaddr addr
,
576 pflash_t
*pfl
= opaque
;
578 pflash_write(pfl
, addr
, value
, 4, 0);
581 static const MemoryRegionOps pflash_cfi02_ops_be
= {
583 .read
= { pflash_readb_be
, pflash_readw_be
, pflash_readl_be
, },
584 .write
= { pflash_writeb_be
, pflash_writew_be
, pflash_writel_be
, },
586 .endianness
= DEVICE_NATIVE_ENDIAN
,
589 static const MemoryRegionOps pflash_cfi02_ops_le
= {
591 .read
= { pflash_readb_le
, pflash_readw_le
, pflash_readl_le
, },
592 .write
= { pflash_writeb_le
, pflash_writew_le
, pflash_writel_le
, },
594 .endianness
= DEVICE_NATIVE_ENDIAN
,
597 static void pflash_cfi02_realize(DeviceState
*dev
, Error
**errp
)
599 pflash_t
*pfl
= CFI_PFLASH02(dev
);
602 Error
*local_err
= NULL
;
604 chip_len
= pfl
->sector_len
* pfl
->nb_blocs
;
605 /* XXX: to be fixed */
607 if (total_len
!= (8 * 1024 * 1024) && total_len
!= (16 * 1024 * 1024) &&
608 total_len
!= (32 * 1024 * 1024) && total_len
!= (64 * 1024 * 1024))
612 memory_region_init_rom_device(&pfl
->orig_mem
, OBJECT(pfl
), pfl
->be
?
613 &pflash_cfi02_ops_be
: &pflash_cfi02_ops_le
,
614 pfl
, pfl
->name
, chip_len
, &local_err
);
616 error_propagate(errp
, local_err
);
620 vmstate_register_ram(&pfl
->orig_mem
, DEVICE(pfl
));
621 pfl
->storage
= memory_region_get_ram_ptr(&pfl
->orig_mem
);
622 pfl
->chip_len
= chip_len
;
624 /* read the initial flash content */
625 ret
= blk_pread(pfl
->blk
, 0, pfl
->storage
, chip_len
);
627 vmstate_unregister_ram(&pfl
->orig_mem
, DEVICE(pfl
));
628 error_setg(errp
, "failed to read the initial flash content");
633 pflash_setup_mappings(pfl
);
635 sysbus_init_mmio(SYS_BUS_DEVICE(dev
), &pfl
->mem
);
638 pfl
->ro
= blk_is_read_only(pfl
->blk
);
643 pfl
->timer
= timer_new_ns(QEMU_CLOCK_VIRTUAL
, pflash_timer
, pfl
);
647 /* Hardcoded CFI table (mostly from SG29 Spansion flash) */
649 /* Standard "QRY" string */
650 pfl
->cfi_table
[0x10] = 'Q';
651 pfl
->cfi_table
[0x11] = 'R';
652 pfl
->cfi_table
[0x12] = 'Y';
653 /* Command set (AMD/Fujitsu) */
654 pfl
->cfi_table
[0x13] = 0x02;
655 pfl
->cfi_table
[0x14] = 0x00;
656 /* Primary extended table address */
657 pfl
->cfi_table
[0x15] = 0x31;
658 pfl
->cfi_table
[0x16] = 0x00;
659 /* Alternate command set (none) */
660 pfl
->cfi_table
[0x17] = 0x00;
661 pfl
->cfi_table
[0x18] = 0x00;
662 /* Alternate extended table (none) */
663 pfl
->cfi_table
[0x19] = 0x00;
664 pfl
->cfi_table
[0x1A] = 0x00;
666 pfl
->cfi_table
[0x1B] = 0x27;
668 pfl
->cfi_table
[0x1C] = 0x36;
669 /* Vpp min (no Vpp pin) */
670 pfl
->cfi_table
[0x1D] = 0x00;
671 /* Vpp max (no Vpp pin) */
672 pfl
->cfi_table
[0x1E] = 0x00;
674 pfl
->cfi_table
[0x1F] = 0x07;
675 /* Timeout for min size buffer write (NA) */
676 pfl
->cfi_table
[0x20] = 0x00;
677 /* Typical timeout for block erase (512 ms) */
678 pfl
->cfi_table
[0x21] = 0x09;
679 /* Typical timeout for full chip erase (4096 ms) */
680 pfl
->cfi_table
[0x22] = 0x0C;
682 pfl
->cfi_table
[0x23] = 0x01;
683 /* Max timeout for buffer write (NA) */
684 pfl
->cfi_table
[0x24] = 0x00;
685 /* Max timeout for block erase */
686 pfl
->cfi_table
[0x25] = 0x0A;
687 /* Max timeout for chip erase */
688 pfl
->cfi_table
[0x26] = 0x0D;
690 pfl
->cfi_table
[0x27] = ctz32(chip_len
);
691 /* Flash device interface (8 & 16 bits) */
692 pfl
->cfi_table
[0x28] = 0x02;
693 pfl
->cfi_table
[0x29] = 0x00;
694 /* Max number of bytes in multi-bytes write */
695 /* XXX: disable buffered write as it's not supported */
696 // pfl->cfi_table[0x2A] = 0x05;
697 pfl
->cfi_table
[0x2A] = 0x00;
698 pfl
->cfi_table
[0x2B] = 0x00;
699 /* Number of erase block regions (uniform) */
700 pfl
->cfi_table
[0x2C] = 0x01;
701 /* Erase block region 1 */
702 pfl
->cfi_table
[0x2D] = pfl
->nb_blocs
- 1;
703 pfl
->cfi_table
[0x2E] = (pfl
->nb_blocs
- 1) >> 8;
704 pfl
->cfi_table
[0x2F] = pfl
->sector_len
>> 8;
705 pfl
->cfi_table
[0x30] = pfl
->sector_len
>> 16;
708 pfl
->cfi_table
[0x31] = 'P';
709 pfl
->cfi_table
[0x32] = 'R';
710 pfl
->cfi_table
[0x33] = 'I';
712 pfl
->cfi_table
[0x34] = '1';
713 pfl
->cfi_table
[0x35] = '0';
715 pfl
->cfi_table
[0x36] = 0x00;
716 pfl
->cfi_table
[0x37] = 0x00;
717 pfl
->cfi_table
[0x38] = 0x00;
718 pfl
->cfi_table
[0x39] = 0x00;
720 pfl
->cfi_table
[0x3a] = 0x00;
722 pfl
->cfi_table
[0x3b] = 0x00;
723 pfl
->cfi_table
[0x3c] = 0x00;
726 static Property pflash_cfi02_properties
[] = {
727 DEFINE_PROP_DRIVE("drive", struct pflash_t
, blk
),
728 DEFINE_PROP_UINT32("num-blocks", struct pflash_t
, nb_blocs
, 0),
729 DEFINE_PROP_UINT32("sector-length", struct pflash_t
, sector_len
, 0),
730 DEFINE_PROP_UINT8("width", struct pflash_t
, width
, 0),
731 DEFINE_PROP_UINT8("mappings", struct pflash_t
, mappings
, 0),
732 DEFINE_PROP_UINT8("big-endian", struct pflash_t
, be
, 0),
733 DEFINE_PROP_UINT16("id0", struct pflash_t
, ident0
, 0),
734 DEFINE_PROP_UINT16("id1", struct pflash_t
, ident1
, 0),
735 DEFINE_PROP_UINT16("id2", struct pflash_t
, ident2
, 0),
736 DEFINE_PROP_UINT16("id3", struct pflash_t
, ident3
, 0),
737 DEFINE_PROP_UINT16("unlock-addr0", struct pflash_t
, unlock_addr0
, 0),
738 DEFINE_PROP_UINT16("unlock-addr1", struct pflash_t
, unlock_addr1
, 0),
739 DEFINE_PROP_STRING("name", struct pflash_t
, name
),
740 DEFINE_PROP_END_OF_LIST(),
743 static void pflash_cfi02_class_init(ObjectClass
*klass
, void *data
)
745 DeviceClass
*dc
= DEVICE_CLASS(klass
);
747 dc
->realize
= pflash_cfi02_realize
;
748 dc
->props
= pflash_cfi02_properties
;
749 set_bit(DEVICE_CATEGORY_STORAGE
, dc
->categories
);
752 static const TypeInfo pflash_cfi02_info
= {
753 .name
= TYPE_CFI_PFLASH02
,
754 .parent
= TYPE_SYS_BUS_DEVICE
,
755 .instance_size
= sizeof(struct pflash_t
),
756 .class_init
= pflash_cfi02_class_init
,
759 static void pflash_cfi02_register_types(void)
761 type_register_static(&pflash_cfi02_info
);
764 type_init(pflash_cfi02_register_types
)
766 pflash_t
*pflash_cfi02_register(hwaddr base
,
767 DeviceState
*qdev
, const char *name
,
769 BlockBackend
*blk
, uint32_t sector_len
,
770 int nb_blocs
, int nb_mappings
, int width
,
771 uint16_t id0
, uint16_t id1
,
772 uint16_t id2
, uint16_t id3
,
773 uint16_t unlock_addr0
, uint16_t unlock_addr1
,
776 DeviceState
*dev
= qdev_create(NULL
, TYPE_CFI_PFLASH02
);
779 qdev_prop_set_drive(dev
, "drive", blk
, &error_abort
);
781 qdev_prop_set_uint32(dev
, "num-blocks", nb_blocs
);
782 qdev_prop_set_uint32(dev
, "sector-length", sector_len
);
783 qdev_prop_set_uint8(dev
, "width", width
);
784 qdev_prop_set_uint8(dev
, "mappings", nb_mappings
);
785 qdev_prop_set_uint8(dev
, "big-endian", !!be
);
786 qdev_prop_set_uint16(dev
, "id0", id0
);
787 qdev_prop_set_uint16(dev
, "id1", id1
);
788 qdev_prop_set_uint16(dev
, "id2", id2
);
789 qdev_prop_set_uint16(dev
, "id3", id3
);
790 qdev_prop_set_uint16(dev
, "unlock-addr0", unlock_addr0
);
791 qdev_prop_set_uint16(dev
, "unlock-addr1", unlock_addr1
);
792 qdev_prop_set_string(dev
, "name", name
);
793 qdev_init_nofail(dev
);
795 sysbus_mmio_map(SYS_BUS_DEVICE(dev
), 0, base
);
796 return CFI_PFLASH02(dev
);