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"
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
);
161 /* We accept reads during second unlock sequence... */
164 /* Flash area read */
169 // DPRINTF("%s: data offset %08x %02x\n", __func__, offset, ret);
173 ret
= p
[offset
] << 8;
174 ret
|= p
[offset
+ 1];
177 ret
|= p
[offset
+ 1] << 8;
179 // DPRINTF("%s: data offset %08x %04x\n", __func__, offset, ret);
183 ret
= p
[offset
] << 24;
184 ret
|= p
[offset
+ 1] << 16;
185 ret
|= p
[offset
+ 2] << 8;
186 ret
|= p
[offset
+ 3];
189 ret
|= p
[offset
+ 1] << 8;
190 ret
|= p
[offset
+ 2] << 16;
191 ret
|= p
[offset
+ 3] << 24;
193 // DPRINTF("%s: data offset %08x %08x\n", __func__, offset, ret);
202 ret
= boff
& 0x01 ? pfl
->ident1
: pfl
->ident0
;
205 ret
= 0x00; /* Pretend all sectors are unprotected */
209 ret
= boff
& 0x01 ? pfl
->ident3
: pfl
->ident2
;
210 if (ret
== (uint8_t)-1) {
217 DPRINTF("%s: ID " TARGET_FMT_plx
" %x\n", __func__
, boff
, ret
);
222 /* Status register read */
224 DPRINTF("%s: status %x\n", __func__
, ret
);
230 if (boff
> pfl
->cfi_len
)
233 ret
= pfl
->cfi_table
[boff
];
240 /* update flash content on disk */
241 static void pflash_update(pflash_t
*pfl
, int offset
,
246 offset_end
= offset
+ size
;
247 /* round to sectors */
248 offset
= offset
>> 9;
249 offset_end
= (offset_end
+ 511) >> 9;
250 bdrv_write(pfl
->bs
, offset
, pfl
->storage
+ (offset
<< 9),
251 offset_end
- offset
);
255 static void pflash_write (pflash_t
*pfl
, hwaddr offset
,
256 uint32_t value
, int width
, int be
)
263 if (pfl
->cmd
!= 0xA0 && cmd
== 0xF0) {
265 DPRINTF("%s: flash reset asked (%02x %02x)\n",
266 __func__
, pfl
->cmd
, cmd
);
270 DPRINTF("%s: offset " TARGET_FMT_plx
" %08x %d %d\n", __func__
,
271 offset
, value
, width
, pfl
->wcycle
);
272 offset
&= pfl
->chip_len
- 1;
274 DPRINTF("%s: offset " TARGET_FMT_plx
" %08x %d\n", __func__
,
275 offset
, value
, width
);
276 boff
= offset
& (pfl
->sector_len
- 1);
279 else if (pfl
->width
== 4)
281 switch (pfl
->wcycle
) {
283 /* Set the device in I/O access mode if required */
285 pflash_register_memory(pfl
, 0);
286 pfl
->read_counter
= 0;
287 /* We're in read mode */
289 if (boff
== 0x55 && cmd
== 0x98) {
291 /* Enter CFI query mode */
296 if (boff
!= pfl
->unlock_addr0
|| cmd
!= 0xAA) {
297 DPRINTF("%s: unlock0 failed " TARGET_FMT_plx
" %02x %04x\n",
298 __func__
, boff
, cmd
, pfl
->unlock_addr0
);
301 DPRINTF("%s: unlock sequence started\n", __func__
);
304 /* We started an unlock sequence */
306 if (boff
!= pfl
->unlock_addr1
|| cmd
!= 0x55) {
307 DPRINTF("%s: unlock1 failed " TARGET_FMT_plx
" %02x\n", __func__
,
311 DPRINTF("%s: unlock sequence done\n", __func__
);
314 /* We finished an unlock sequence */
315 if (!pfl
->bypass
&& boff
!= pfl
->unlock_addr0
) {
316 DPRINTF("%s: command failed " TARGET_FMT_plx
" %02x\n", __func__
,
328 DPRINTF("%s: starting command %02x\n", __func__
, cmd
);
331 DPRINTF("%s: unknown command %02x\n", __func__
, cmd
);
338 /* We need another unlock sequence */
341 DPRINTF("%s: write data offset " TARGET_FMT_plx
" %08x %d\n",
342 __func__
, offset
, value
, width
);
348 pflash_update(pfl
, offset
, 1);
352 p
[offset
] &= value
>> 8;
353 p
[offset
+ 1] &= value
;
356 p
[offset
+ 1] &= value
>> 8;
358 pflash_update(pfl
, offset
, 2);
362 p
[offset
] &= value
>> 24;
363 p
[offset
+ 1] &= value
>> 16;
364 p
[offset
+ 2] &= value
>> 8;
365 p
[offset
+ 3] &= value
;
368 p
[offset
+ 1] &= value
>> 8;
369 p
[offset
+ 2] &= value
>> 16;
370 p
[offset
+ 3] &= value
>> 24;
372 pflash_update(pfl
, offset
, 4);
376 pfl
->status
= 0x00 | ~(value
& 0x80);
377 /* Let's pretend write is immediate */
382 if (pfl
->bypass
&& cmd
== 0x00) {
383 /* Unlock bypass reset */
386 /* We can enter CFI query mode from autoselect mode */
387 if (boff
== 0x55 && cmd
== 0x98)
391 DPRINTF("%s: invalid write for command %02x\n",
398 /* Ignore writes while flash data write is occurring */
399 /* As we suppose write is immediate, this should never happen */
404 /* Should never happen */
405 DPRINTF("%s: invalid command state %02x (wc 4)\n",
413 if (boff
!= pfl
->unlock_addr0
) {
414 DPRINTF("%s: chip erase: invalid address " TARGET_FMT_plx
"\n",
419 DPRINTF("%s: start chip erase\n", __func__
);
421 memset(pfl
->storage
, 0xFF, pfl
->chip_len
);
422 pflash_update(pfl
, 0, pfl
->chip_len
);
425 /* Let's wait 5 seconds before chip erase is done */
426 qemu_mod_timer(pfl
->timer
,
427 qemu_get_clock_ns(vm_clock
) + (get_ticks_per_sec() * 5));
432 offset
&= ~(pfl
->sector_len
- 1);
433 DPRINTF("%s: start sector erase at " TARGET_FMT_plx
"\n", __func__
,
436 memset(p
+ offset
, 0xFF, pfl
->sector_len
);
437 pflash_update(pfl
, offset
, pfl
->sector_len
);
440 /* Let's wait 1/2 second before sector erase is done */
441 qemu_mod_timer(pfl
->timer
,
442 qemu_get_clock_ns(vm_clock
) + (get_ticks_per_sec() / 2));
445 DPRINTF("%s: invalid command %02x (wc 5)\n", __func__
, cmd
);
453 /* Ignore writes during chip erase */
456 /* Ignore writes during sector erase */
459 /* Should never happen */
460 DPRINTF("%s: invalid command state %02x (wc 6)\n",
465 case 7: /* Special value for CFI queries */
466 DPRINTF("%s: invalid write in CFI query mode\n", __func__
);
469 /* Should never happen */
470 DPRINTF("%s: invalid write state (wc 7)\n", __func__
);
490 static uint32_t pflash_readb_be(void *opaque
, hwaddr addr
)
492 return pflash_read(opaque
, addr
, 1, 1);
495 static uint32_t pflash_readb_le(void *opaque
, hwaddr addr
)
497 return pflash_read(opaque
, addr
, 1, 0);
500 static uint32_t pflash_readw_be(void *opaque
, hwaddr addr
)
502 pflash_t
*pfl
= opaque
;
504 return pflash_read(pfl
, addr
, 2, 1);
507 static uint32_t pflash_readw_le(void *opaque
, hwaddr addr
)
509 pflash_t
*pfl
= opaque
;
511 return pflash_read(pfl
, addr
, 2, 0);
514 static uint32_t pflash_readl_be(void *opaque
, hwaddr addr
)
516 pflash_t
*pfl
= opaque
;
518 return pflash_read(pfl
, addr
, 4, 1);
521 static uint32_t pflash_readl_le(void *opaque
, hwaddr addr
)
523 pflash_t
*pfl
= opaque
;
525 return pflash_read(pfl
, addr
, 4, 0);
528 static void pflash_writeb_be(void *opaque
, hwaddr addr
,
531 pflash_write(opaque
, addr
, value
, 1, 1);
534 static void pflash_writeb_le(void *opaque
, hwaddr addr
,
537 pflash_write(opaque
, addr
, value
, 1, 0);
540 static void pflash_writew_be(void *opaque
, hwaddr addr
,
543 pflash_t
*pfl
= opaque
;
545 pflash_write(pfl
, addr
, value
, 2, 1);
548 static void pflash_writew_le(void *opaque
, hwaddr addr
,
551 pflash_t
*pfl
= opaque
;
553 pflash_write(pfl
, addr
, value
, 2, 0);
556 static void pflash_writel_be(void *opaque
, hwaddr addr
,
559 pflash_t
*pfl
= opaque
;
561 pflash_write(pfl
, addr
, value
, 4, 1);
564 static void pflash_writel_le(void *opaque
, hwaddr addr
,
567 pflash_t
*pfl
= opaque
;
569 pflash_write(pfl
, addr
, value
, 4, 0);
572 static const MemoryRegionOps pflash_cfi02_ops_be
= {
574 .read
= { pflash_readb_be
, pflash_readw_be
, pflash_readl_be
, },
575 .write
= { pflash_writeb_be
, pflash_writew_be
, pflash_writel_be
, },
577 .endianness
= DEVICE_NATIVE_ENDIAN
,
580 static const MemoryRegionOps pflash_cfi02_ops_le
= {
582 .read
= { pflash_readb_le
, pflash_readw_le
, pflash_readl_le
, },
583 .write
= { pflash_writeb_le
, pflash_writew_le
, pflash_writel_le
, },
585 .endianness
= DEVICE_NATIVE_ENDIAN
,
588 static int pflash_cfi02_init(SysBusDevice
*dev
)
590 pflash_t
*pfl
= FROM_SYSBUS(typeof(*pfl
), dev
);
594 chip_len
= pfl
->sector_len
* pfl
->nb_blocs
;
595 /* XXX: to be fixed */
597 if (total_len
!= (8 * 1024 * 1024) && total_len
!= (16 * 1024 * 1024) &&
598 total_len
!= (32 * 1024 * 1024) && total_len
!= (64 * 1024 * 1024))
602 memory_region_init_rom_device(&pfl
->orig_mem
, pfl
->be
?
603 &pflash_cfi02_ops_be
: &pflash_cfi02_ops_le
,
604 pfl
, pfl
->name
, chip_len
);
605 vmstate_register_ram(&pfl
->orig_mem
, DEVICE(pfl
));
606 pfl
->storage
= memory_region_get_ram_ptr(&pfl
->orig_mem
);
607 pfl
->chip_len
= chip_len
;
609 /* read the initial flash content */
610 ret
= bdrv_read(pfl
->bs
, 0, pfl
->storage
, chip_len
>> 9);
617 pflash_setup_mappings(pfl
);
619 sysbus_init_mmio(dev
, &pfl
->mem
);
622 pfl
->ro
= bdrv_is_read_only(pfl
->bs
);
627 pfl
->timer
= qemu_new_timer_ns(vm_clock
, pflash_timer
, pfl
);
631 /* Hardcoded CFI table (mostly from SG29 Spansion flash) */
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 (AMD/Fujitsu) */
638 pfl
->cfi_table
[0x13] = 0x02;
639 pfl
->cfi_table
[0x14] = 0x00;
640 /* Primary extended table address */
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] = 0x27;
652 pfl
->cfi_table
[0x1C] = 0x36;
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 (NA) */
660 pfl
->cfi_table
[0x20] = 0x00;
661 /* Typical timeout for block erase (512 ms) */
662 pfl
->cfi_table
[0x21] = 0x09;
663 /* Typical timeout for full chip erase (4096 ms) */
664 pfl
->cfi_table
[0x22] = 0x0C;
666 pfl
->cfi_table
[0x23] = 0x01;
667 /* Max timeout for buffer write (NA) */
668 pfl
->cfi_table
[0x24] = 0x00;
669 /* Max timeout for block erase */
670 pfl
->cfi_table
[0x25] = 0x0A;
671 /* Max timeout for chip erase */
672 pfl
->cfi_table
[0x26] = 0x0D;
674 pfl
->cfi_table
[0x27] = ctz32(chip_len
);
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 /* XXX: disable buffered write as it's not supported */
680 // pfl->cfi_table[0x2A] = 0x05;
681 pfl
->cfi_table
[0x2A] = 0x00;
682 pfl
->cfi_table
[0x2B] = 0x00;
683 /* Number of erase block regions (uniform) */
684 pfl
->cfi_table
[0x2C] = 0x01;
685 /* Erase block region 1 */
686 pfl
->cfi_table
[0x2D] = pfl
->nb_blocs
- 1;
687 pfl
->cfi_table
[0x2E] = (pfl
->nb_blocs
- 1) >> 8;
688 pfl
->cfi_table
[0x2F] = pfl
->sector_len
>> 8;
689 pfl
->cfi_table
[0x30] = pfl
->sector_len
>> 16;
692 pfl
->cfi_table
[0x31] = 'P';
693 pfl
->cfi_table
[0x32] = 'R';
694 pfl
->cfi_table
[0x33] = 'I';
696 pfl
->cfi_table
[0x34] = '1';
697 pfl
->cfi_table
[0x35] = '0';
699 pfl
->cfi_table
[0x36] = 0x00;
700 pfl
->cfi_table
[0x37] = 0x00;
701 pfl
->cfi_table
[0x38] = 0x00;
702 pfl
->cfi_table
[0x39] = 0x00;
704 pfl
->cfi_table
[0x3a] = 0x00;
706 pfl
->cfi_table
[0x3b] = 0x00;
707 pfl
->cfi_table
[0x3c] = 0x00;
712 static Property pflash_cfi02_properties
[] = {
713 DEFINE_PROP_DRIVE("drive", struct pflash_t
, bs
),
714 DEFINE_PROP_UINT32("num-blocks", struct pflash_t
, nb_blocs
, 0),
715 DEFINE_PROP_UINT32("sector-length", struct pflash_t
, sector_len
, 0),
716 DEFINE_PROP_UINT8("width", struct pflash_t
, width
, 0),
717 DEFINE_PROP_UINT8("mappings", struct pflash_t
, mappings
, 0),
718 DEFINE_PROP_UINT8("big-endian", struct pflash_t
, be
, 0),
719 DEFINE_PROP_UINT16("id0", struct pflash_t
, ident0
, 0),
720 DEFINE_PROP_UINT16("id1", struct pflash_t
, ident1
, 0),
721 DEFINE_PROP_UINT16("id2", struct pflash_t
, ident2
, 0),
722 DEFINE_PROP_UINT16("id3", struct pflash_t
, ident3
, 0),
723 DEFINE_PROP_UINT16("unlock-addr0", struct pflash_t
, unlock_addr0
, 0),
724 DEFINE_PROP_UINT16("unlock-addr1", struct pflash_t
, unlock_addr1
, 0),
725 DEFINE_PROP_STRING("name", struct pflash_t
, name
),
726 DEFINE_PROP_END_OF_LIST(),
729 static void pflash_cfi02_class_init(ObjectClass
*klass
, void *data
)
731 DeviceClass
*dc
= DEVICE_CLASS(klass
);
732 SysBusDeviceClass
*k
= SYS_BUS_DEVICE_CLASS(klass
);
734 k
->init
= pflash_cfi02_init
;
735 dc
->props
= pflash_cfi02_properties
;
738 static const TypeInfo pflash_cfi02_info
= {
739 .name
= "cfi.pflash02",
740 .parent
= TYPE_SYS_BUS_DEVICE
,
741 .instance_size
= sizeof(struct pflash_t
),
742 .class_init
= pflash_cfi02_class_init
,
745 static void pflash_cfi02_register_types(void)
747 type_register_static(&pflash_cfi02_info
);
750 type_init(pflash_cfi02_register_types
)
752 pflash_t
*pflash_cfi02_register(hwaddr base
,
753 DeviceState
*qdev
, const char *name
,
755 BlockDriverState
*bs
, uint32_t sector_len
,
756 int nb_blocs
, int nb_mappings
, int width
,
757 uint16_t id0
, uint16_t id1
,
758 uint16_t id2
, uint16_t id3
,
759 uint16_t unlock_addr0
, uint16_t unlock_addr1
,
762 DeviceState
*dev
= qdev_create(NULL
, "cfi.pflash02");
763 SysBusDevice
*busdev
= sysbus_from_qdev(dev
);
764 pflash_t
*pfl
= (pflash_t
*)object_dynamic_cast(OBJECT(dev
),
767 if (bs
&& qdev_prop_set_drive(dev
, "drive", bs
)) {
770 qdev_prop_set_uint32(dev
, "num-blocks", nb_blocs
);
771 qdev_prop_set_uint32(dev
, "sector-length", sector_len
);
772 qdev_prop_set_uint8(dev
, "width", width
);
773 qdev_prop_set_uint8(dev
, "mappings", nb_mappings
);
774 qdev_prop_set_uint8(dev
, "big-endian", !!be
);
775 qdev_prop_set_uint16(dev
, "id0", id0
);
776 qdev_prop_set_uint16(dev
, "id1", id1
);
777 qdev_prop_set_uint16(dev
, "id2", id2
);
778 qdev_prop_set_uint16(dev
, "id3", id3
);
779 qdev_prop_set_uint16(dev
, "unlock-addr0", unlock_addr0
);
780 qdev_prop_set_uint16(dev
, "unlock-addr1", unlock_addr1
);
781 qdev_prop_set_string(dev
, "name", name
);
782 qdev_init_nofail(dev
);
784 sysbus_mmio_map(busdev
, 0, base
);