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
40 #include "qemu/timer.h"
41 #include "block/block.h"
42 #include "exec/address-spaces.h"
43 #include "qemu/host-utils.h"
44 #include "hw/sysbus.h"
46 //#define PFLASH_DEBUG
48 #define DPRINTF(fmt, ...) \
50 fprintf(stderr "PFLASH: " fmt , ## __VA_ARGS__); \
53 #define DPRINTF(fmt, ...) do { } while (0)
56 #define PFLASH_LAZY_ROMD_THRESHOLD 42
67 int wcycle
; /* if 0, the flash is read normally */
72 /* FIXME: implement array device properties */
77 uint16_t unlock_addr0
;
78 uint16_t unlock_addr1
;
80 uint8_t cfi_table
[0x52];
82 /* The device replicates the flash memory across its memory space. Emulate
83 * that by having a container (.mem) filled with an array of aliases
84 * (.mem_mappings) pointing to the flash memory (.orig_mem).
87 MemoryRegion
*mem_mappings
; /* array; one per mapping */
88 MemoryRegion orig_mem
;
90 int read_counter
; /* used for lazy switch-back to rom mode */
96 * Set up replicated mappings of the same region.
98 static void pflash_setup_mappings(pflash_t
*pfl
)
101 hwaddr size
= memory_region_size(&pfl
->orig_mem
);
103 memory_region_init(&pfl
->mem
, "pflash", pfl
->mappings
* size
);
104 pfl
->mem_mappings
= g_new(MemoryRegion
, pfl
->mappings
);
105 for (i
= 0; i
< pfl
->mappings
; ++i
) {
106 memory_region_init_alias(&pfl
->mem_mappings
[i
], "pflash-alias",
107 &pfl
->orig_mem
, 0, size
);
108 memory_region_add_subregion(&pfl
->mem
, i
* size
, &pfl
->mem_mappings
[i
]);
112 static void pflash_register_memory(pflash_t
*pfl
, int rom_mode
)
114 memory_region_rom_device_set_readable(&pfl
->orig_mem
, rom_mode
);
115 pfl
->rom_mode
= rom_mode
;
118 static void pflash_timer (void *opaque
)
120 pflash_t
*pfl
= opaque
;
122 DPRINTF("%s: command %02x done\n", __func__
, pfl
->cmd
);
128 pflash_register_memory(pfl
, 1);
134 static uint32_t pflash_read (pflash_t
*pfl
, hwaddr offset
,
141 DPRINTF("%s: offset " TARGET_FMT_plx
"\n", __func__
, offset
);
143 /* Lazy reset to ROMD mode after a certain amount of read accesses */
144 if (!pfl
->rom_mode
&& pfl
->wcycle
== 0 &&
145 ++pfl
->read_counter
> PFLASH_LAZY_ROMD_THRESHOLD
) {
146 pflash_register_memory(pfl
, 1);
148 offset
&= pfl
->chip_len
- 1;
149 boff
= offset
& 0xFF;
152 else if (pfl
->width
== 4)
156 /* This should never happen : reset state & treat it as a read*/
157 DPRINTF("%s: unknown command state: %x\n", __func__
, pfl
->cmd
);
160 /* fall through to the read code */
162 /* We accept reads during second unlock sequence... */
165 /* Flash area read */
170 // DPRINTF("%s: data offset %08x %02x\n", __func__, offset, ret);
174 ret
= p
[offset
] << 8;
175 ret
|= p
[offset
+ 1];
178 ret
|= p
[offset
+ 1] << 8;
180 // DPRINTF("%s: data offset %08x %04x\n", __func__, offset, ret);
184 ret
= p
[offset
] << 24;
185 ret
|= p
[offset
+ 1] << 16;
186 ret
|= p
[offset
+ 2] << 8;
187 ret
|= p
[offset
+ 3];
190 ret
|= p
[offset
+ 1] << 8;
191 ret
|= p
[offset
+ 2] << 16;
192 ret
|= p
[offset
+ 3] << 24;
194 // DPRINTF("%s: data offset %08x %08x\n", __func__, offset, ret);
203 ret
= boff
& 0x01 ? pfl
->ident1
: pfl
->ident0
;
206 ret
= 0x00; /* Pretend all sectors are unprotected */
210 ret
= boff
& 0x01 ? pfl
->ident3
: pfl
->ident2
;
211 if (ret
== (uint8_t)-1) {
218 DPRINTF("%s: ID " TARGET_FMT_plx
" %x\n", __func__
, boff
, ret
);
223 /* Status register read */
225 DPRINTF("%s: status %x\n", __func__
, ret
);
231 if (boff
> pfl
->cfi_len
)
234 ret
= pfl
->cfi_table
[boff
];
241 /* update flash content on disk */
242 static void pflash_update(pflash_t
*pfl
, int offset
,
247 offset_end
= offset
+ size
;
248 /* round to sectors */
249 offset
= offset
>> 9;
250 offset_end
= (offset_end
+ 511) >> 9;
251 bdrv_write(pfl
->bs
, offset
, pfl
->storage
+ (offset
<< 9),
252 offset_end
- offset
);
256 static void pflash_write (pflash_t
*pfl
, hwaddr offset
,
257 uint32_t value
, int width
, int be
)
264 if (pfl
->cmd
!= 0xA0 && cmd
== 0xF0) {
266 DPRINTF("%s: flash reset asked (%02x %02x)\n",
267 __func__
, pfl
->cmd
, cmd
);
271 DPRINTF("%s: offset " TARGET_FMT_plx
" %08x %d %d\n", __func__
,
272 offset
, value
, width
, pfl
->wcycle
);
273 offset
&= pfl
->chip_len
- 1;
275 DPRINTF("%s: offset " TARGET_FMT_plx
" %08x %d\n", __func__
,
276 offset
, value
, width
);
277 boff
= offset
& (pfl
->sector_len
- 1);
280 else if (pfl
->width
== 4)
282 switch (pfl
->wcycle
) {
284 /* Set the device in I/O access mode if required */
286 pflash_register_memory(pfl
, 0);
287 pfl
->read_counter
= 0;
288 /* We're in read mode */
290 if (boff
== 0x55 && cmd
== 0x98) {
292 /* Enter CFI query mode */
297 if (boff
!= pfl
->unlock_addr0
|| cmd
!= 0xAA) {
298 DPRINTF("%s: unlock0 failed " TARGET_FMT_plx
" %02x %04x\n",
299 __func__
, boff
, cmd
, pfl
->unlock_addr0
);
302 DPRINTF("%s: unlock sequence started\n", __func__
);
305 /* We started an unlock sequence */
307 if (boff
!= pfl
->unlock_addr1
|| cmd
!= 0x55) {
308 DPRINTF("%s: unlock1 failed " TARGET_FMT_plx
" %02x\n", __func__
,
312 DPRINTF("%s: unlock sequence done\n", __func__
);
315 /* We finished an unlock sequence */
316 if (!pfl
->bypass
&& boff
!= pfl
->unlock_addr0
) {
317 DPRINTF("%s: command failed " TARGET_FMT_plx
" %02x\n", __func__
,
329 DPRINTF("%s: starting command %02x\n", __func__
, cmd
);
332 DPRINTF("%s: unknown command %02x\n", __func__
, cmd
);
339 /* We need another unlock sequence */
342 DPRINTF("%s: write data offset " TARGET_FMT_plx
" %08x %d\n",
343 __func__
, offset
, value
, width
);
349 pflash_update(pfl
, offset
, 1);
353 p
[offset
] &= value
>> 8;
354 p
[offset
+ 1] &= value
;
357 p
[offset
+ 1] &= value
>> 8;
359 pflash_update(pfl
, offset
, 2);
363 p
[offset
] &= value
>> 24;
364 p
[offset
+ 1] &= value
>> 16;
365 p
[offset
+ 2] &= value
>> 8;
366 p
[offset
+ 3] &= value
;
369 p
[offset
+ 1] &= value
>> 8;
370 p
[offset
+ 2] &= value
>> 16;
371 p
[offset
+ 3] &= value
>> 24;
373 pflash_update(pfl
, offset
, 4);
377 pfl
->status
= 0x00 | ~(value
& 0x80);
378 /* Let's pretend write is immediate */
383 if (pfl
->bypass
&& cmd
== 0x00) {
384 /* Unlock bypass reset */
387 /* We can enter CFI query mode from autoselect mode */
388 if (boff
== 0x55 && cmd
== 0x98)
392 DPRINTF("%s: invalid write for command %02x\n",
399 /* Ignore writes while flash data write is occurring */
400 /* As we suppose write is immediate, this should never happen */
405 /* Should never happen */
406 DPRINTF("%s: invalid command state %02x (wc 4)\n",
414 if (boff
!= pfl
->unlock_addr0
) {
415 DPRINTF("%s: chip erase: invalid address " TARGET_FMT_plx
"\n",
420 DPRINTF("%s: start chip erase\n", __func__
);
422 memset(pfl
->storage
, 0xFF, pfl
->chip_len
);
423 pflash_update(pfl
, 0, pfl
->chip_len
);
426 /* Let's wait 5 seconds before chip erase is done */
427 qemu_mod_timer(pfl
->timer
,
428 qemu_get_clock_ns(vm_clock
) + (get_ticks_per_sec() * 5));
433 offset
&= ~(pfl
->sector_len
- 1);
434 DPRINTF("%s: start sector erase at " TARGET_FMT_plx
"\n", __func__
,
437 memset(p
+ offset
, 0xFF, pfl
->sector_len
);
438 pflash_update(pfl
, offset
, pfl
->sector_len
);
441 /* Let's wait 1/2 second before sector erase is done */
442 qemu_mod_timer(pfl
->timer
,
443 qemu_get_clock_ns(vm_clock
) + (get_ticks_per_sec() / 2));
446 DPRINTF("%s: invalid command %02x (wc 5)\n", __func__
, cmd
);
454 /* Ignore writes during chip erase */
457 /* Ignore writes during sector erase */
460 /* Should never happen */
461 DPRINTF("%s: invalid command state %02x (wc 6)\n",
466 case 7: /* Special value for CFI queries */
467 DPRINTF("%s: invalid write in CFI query mode\n", __func__
);
470 /* Should never happen */
471 DPRINTF("%s: invalid write state (wc 7)\n", __func__
);
491 static uint32_t pflash_readb_be(void *opaque
, hwaddr addr
)
493 return pflash_read(opaque
, addr
, 1, 1);
496 static uint32_t pflash_readb_le(void *opaque
, hwaddr addr
)
498 return pflash_read(opaque
, addr
, 1, 0);
501 static uint32_t pflash_readw_be(void *opaque
, hwaddr addr
)
503 pflash_t
*pfl
= opaque
;
505 return pflash_read(pfl
, addr
, 2, 1);
508 static uint32_t pflash_readw_le(void *opaque
, hwaddr addr
)
510 pflash_t
*pfl
= opaque
;
512 return pflash_read(pfl
, addr
, 2, 0);
515 static uint32_t pflash_readl_be(void *opaque
, hwaddr addr
)
517 pflash_t
*pfl
= opaque
;
519 return pflash_read(pfl
, addr
, 4, 1);
522 static uint32_t pflash_readl_le(void *opaque
, hwaddr addr
)
524 pflash_t
*pfl
= opaque
;
526 return pflash_read(pfl
, addr
, 4, 0);
529 static void pflash_writeb_be(void *opaque
, hwaddr addr
,
532 pflash_write(opaque
, addr
, value
, 1, 1);
535 static void pflash_writeb_le(void *opaque
, hwaddr addr
,
538 pflash_write(opaque
, addr
, value
, 1, 0);
541 static void pflash_writew_be(void *opaque
, hwaddr addr
,
544 pflash_t
*pfl
= opaque
;
546 pflash_write(pfl
, addr
, value
, 2, 1);
549 static void pflash_writew_le(void *opaque
, hwaddr addr
,
552 pflash_t
*pfl
= opaque
;
554 pflash_write(pfl
, addr
, value
, 2, 0);
557 static void pflash_writel_be(void *opaque
, hwaddr addr
,
560 pflash_t
*pfl
= opaque
;
562 pflash_write(pfl
, addr
, value
, 4, 1);
565 static void pflash_writel_le(void *opaque
, hwaddr addr
,
568 pflash_t
*pfl
= opaque
;
570 pflash_write(pfl
, addr
, value
, 4, 0);
573 static const MemoryRegionOps pflash_cfi02_ops_be
= {
575 .read
= { pflash_readb_be
, pflash_readw_be
, pflash_readl_be
, },
576 .write
= { pflash_writeb_be
, pflash_writew_be
, pflash_writel_be
, },
578 .endianness
= DEVICE_NATIVE_ENDIAN
,
581 static const MemoryRegionOps pflash_cfi02_ops_le
= {
583 .read
= { pflash_readb_le
, pflash_readw_le
, pflash_readl_le
, },
584 .write
= { pflash_writeb_le
, pflash_writew_le
, pflash_writel_le
, },
586 .endianness
= DEVICE_NATIVE_ENDIAN
,
589 static int pflash_cfi02_init(SysBusDevice
*dev
)
591 pflash_t
*pfl
= FROM_SYSBUS(typeof(*pfl
), dev
);
595 chip_len
= pfl
->sector_len
* pfl
->nb_blocs
;
596 /* XXX: to be fixed */
598 if (total_len
!= (8 * 1024 * 1024) && total_len
!= (16 * 1024 * 1024) &&
599 total_len
!= (32 * 1024 * 1024) && total_len
!= (64 * 1024 * 1024))
603 memory_region_init_rom_device(&pfl
->orig_mem
, pfl
->be
?
604 &pflash_cfi02_ops_be
: &pflash_cfi02_ops_le
,
605 pfl
, pfl
->name
, chip_len
);
606 vmstate_register_ram(&pfl
->orig_mem
, DEVICE(pfl
));
607 pfl
->storage
= memory_region_get_ram_ptr(&pfl
->orig_mem
);
608 pfl
->chip_len
= chip_len
;
610 /* read the initial flash content */
611 ret
= bdrv_read(pfl
->bs
, 0, pfl
->storage
, chip_len
>> 9);
618 pflash_setup_mappings(pfl
);
620 sysbus_init_mmio(dev
, &pfl
->mem
);
623 pfl
->ro
= bdrv_is_read_only(pfl
->bs
);
628 pfl
->timer
= qemu_new_timer_ns(vm_clock
, pflash_timer
, pfl
);
632 /* Hardcoded CFI table (mostly from SG29 Spansion flash) */
634 /* Standard "QRY" string */
635 pfl
->cfi_table
[0x10] = 'Q';
636 pfl
->cfi_table
[0x11] = 'R';
637 pfl
->cfi_table
[0x12] = 'Y';
638 /* Command set (AMD/Fujitsu) */
639 pfl
->cfi_table
[0x13] = 0x02;
640 pfl
->cfi_table
[0x14] = 0x00;
641 /* Primary extended table address */
642 pfl
->cfi_table
[0x15] = 0x31;
643 pfl
->cfi_table
[0x16] = 0x00;
644 /* Alternate command set (none) */
645 pfl
->cfi_table
[0x17] = 0x00;
646 pfl
->cfi_table
[0x18] = 0x00;
647 /* Alternate extended table (none) */
648 pfl
->cfi_table
[0x19] = 0x00;
649 pfl
->cfi_table
[0x1A] = 0x00;
651 pfl
->cfi_table
[0x1B] = 0x27;
653 pfl
->cfi_table
[0x1C] = 0x36;
654 /* Vpp min (no Vpp pin) */
655 pfl
->cfi_table
[0x1D] = 0x00;
656 /* Vpp max (no Vpp pin) */
657 pfl
->cfi_table
[0x1E] = 0x00;
659 pfl
->cfi_table
[0x1F] = 0x07;
660 /* Timeout for min size buffer write (NA) */
661 pfl
->cfi_table
[0x20] = 0x00;
662 /* Typical timeout for block erase (512 ms) */
663 pfl
->cfi_table
[0x21] = 0x09;
664 /* Typical timeout for full chip erase (4096 ms) */
665 pfl
->cfi_table
[0x22] = 0x0C;
667 pfl
->cfi_table
[0x23] = 0x01;
668 /* Max timeout for buffer write (NA) */
669 pfl
->cfi_table
[0x24] = 0x00;
670 /* Max timeout for block erase */
671 pfl
->cfi_table
[0x25] = 0x0A;
672 /* Max timeout for chip erase */
673 pfl
->cfi_table
[0x26] = 0x0D;
675 pfl
->cfi_table
[0x27] = ctz32(chip_len
);
676 /* Flash device interface (8 & 16 bits) */
677 pfl
->cfi_table
[0x28] = 0x02;
678 pfl
->cfi_table
[0x29] = 0x00;
679 /* Max number of bytes in multi-bytes write */
680 /* XXX: disable buffered write as it's not supported */
681 // pfl->cfi_table[0x2A] = 0x05;
682 pfl
->cfi_table
[0x2A] = 0x00;
683 pfl
->cfi_table
[0x2B] = 0x00;
684 /* Number of erase block regions (uniform) */
685 pfl
->cfi_table
[0x2C] = 0x01;
686 /* Erase block region 1 */
687 pfl
->cfi_table
[0x2D] = pfl
->nb_blocs
- 1;
688 pfl
->cfi_table
[0x2E] = (pfl
->nb_blocs
- 1) >> 8;
689 pfl
->cfi_table
[0x2F] = pfl
->sector_len
>> 8;
690 pfl
->cfi_table
[0x30] = pfl
->sector_len
>> 16;
693 pfl
->cfi_table
[0x31] = 'P';
694 pfl
->cfi_table
[0x32] = 'R';
695 pfl
->cfi_table
[0x33] = 'I';
697 pfl
->cfi_table
[0x34] = '1';
698 pfl
->cfi_table
[0x35] = '0';
700 pfl
->cfi_table
[0x36] = 0x00;
701 pfl
->cfi_table
[0x37] = 0x00;
702 pfl
->cfi_table
[0x38] = 0x00;
703 pfl
->cfi_table
[0x39] = 0x00;
705 pfl
->cfi_table
[0x3a] = 0x00;
707 pfl
->cfi_table
[0x3b] = 0x00;
708 pfl
->cfi_table
[0x3c] = 0x00;
713 static Property pflash_cfi02_properties
[] = {
714 DEFINE_PROP_DRIVE("drive", struct pflash_t
, bs
),
715 DEFINE_PROP_UINT32("num-blocks", struct pflash_t
, nb_blocs
, 0),
716 DEFINE_PROP_UINT32("sector-length", struct pflash_t
, sector_len
, 0),
717 DEFINE_PROP_UINT8("width", struct pflash_t
, width
, 0),
718 DEFINE_PROP_UINT8("mappings", struct pflash_t
, mappings
, 0),
719 DEFINE_PROP_UINT8("big-endian", struct pflash_t
, be
, 0),
720 DEFINE_PROP_UINT16("id0", struct pflash_t
, ident0
, 0),
721 DEFINE_PROP_UINT16("id1", struct pflash_t
, ident1
, 0),
722 DEFINE_PROP_UINT16("id2", struct pflash_t
, ident2
, 0),
723 DEFINE_PROP_UINT16("id3", struct pflash_t
, ident3
, 0),
724 DEFINE_PROP_UINT16("unlock-addr0", struct pflash_t
, unlock_addr0
, 0),
725 DEFINE_PROP_UINT16("unlock-addr1", struct pflash_t
, unlock_addr1
, 0),
726 DEFINE_PROP_STRING("name", struct pflash_t
, name
),
727 DEFINE_PROP_END_OF_LIST(),
730 static void pflash_cfi02_class_init(ObjectClass
*klass
, void *data
)
732 DeviceClass
*dc
= DEVICE_CLASS(klass
);
733 SysBusDeviceClass
*k
= SYS_BUS_DEVICE_CLASS(klass
);
735 k
->init
= pflash_cfi02_init
;
736 dc
->props
= pflash_cfi02_properties
;
739 static const TypeInfo pflash_cfi02_info
= {
740 .name
= "cfi.pflash02",
741 .parent
= TYPE_SYS_BUS_DEVICE
,
742 .instance_size
= sizeof(struct pflash_t
),
743 .class_init
= pflash_cfi02_class_init
,
746 static void pflash_cfi02_register_types(void)
748 type_register_static(&pflash_cfi02_info
);
751 type_init(pflash_cfi02_register_types
)
753 pflash_t
*pflash_cfi02_register(hwaddr base
,
754 DeviceState
*qdev
, const char *name
,
756 BlockDriverState
*bs
, uint32_t sector_len
,
757 int nb_blocs
, int nb_mappings
, int width
,
758 uint16_t id0
, uint16_t id1
,
759 uint16_t id2
, uint16_t id3
,
760 uint16_t unlock_addr0
, uint16_t unlock_addr1
,
763 DeviceState
*dev
= qdev_create(NULL
, "cfi.pflash02");
764 SysBusDevice
*busdev
= SYS_BUS_DEVICE(dev
);
765 pflash_t
*pfl
= (pflash_t
*)object_dynamic_cast(OBJECT(dev
),
768 if (bs
&& qdev_prop_set_drive(dev
, "drive", bs
)) {
771 qdev_prop_set_uint32(dev
, "num-blocks", nb_blocs
);
772 qdev_prop_set_uint32(dev
, "sector-length", sector_len
);
773 qdev_prop_set_uint8(dev
, "width", width
);
774 qdev_prop_set_uint8(dev
, "mappings", nb_mappings
);
775 qdev_prop_set_uint8(dev
, "big-endian", !!be
);
776 qdev_prop_set_uint16(dev
, "id0", id0
);
777 qdev_prop_set_uint16(dev
, "id1", id1
);
778 qdev_prop_set_uint16(dev
, "id2", id2
);
779 qdev_prop_set_uint16(dev
, "id3", id3
);
780 qdev_prop_set_uint16(dev
, "unlock-addr0", unlock_addr0
);
781 qdev_prop_set_uint16(dev
, "unlock-addr1", unlock_addr1
);
782 qdev_prop_set_string(dev
, "name", name
);
783 qdev_init_nofail(dev
);
785 sysbus_mmio_map(busdev
, 0, base
);