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 "qemu/host-utils.h"
45 #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 CFI_PFLASH02(obj) OBJECT_CHECK(pflash_t, (obj), TYPE_CFI_PFLASH02)
64 SysBusDevice parent_obj
;
74 int wcycle
; /* if 0, the flash is read normally */
79 /* FIXME: implement array device properties */
84 uint16_t unlock_addr0
;
85 uint16_t unlock_addr1
;
86 uint8_t cfi_table
[0x52];
88 /* The device replicates the flash memory across its memory space. Emulate
89 * that by having a container (.mem) filled with an array of aliases
90 * (.mem_mappings) pointing to the flash memory (.orig_mem).
93 MemoryRegion
*mem_mappings
; /* array; one per mapping */
94 MemoryRegion orig_mem
;
96 int read_counter
; /* used for lazy switch-back to rom mode */
102 * Set up replicated mappings of the same region.
104 static void pflash_setup_mappings(pflash_t
*pfl
)
107 hwaddr size
= memory_region_size(&pfl
->orig_mem
);
109 memory_region_init(&pfl
->mem
, OBJECT(pfl
), "pflash", pfl
->mappings
* size
);
110 pfl
->mem_mappings
= g_new(MemoryRegion
, pfl
->mappings
);
111 for (i
= 0; i
< pfl
->mappings
; ++i
) {
112 memory_region_init_alias(&pfl
->mem_mappings
[i
], OBJECT(pfl
),
113 "pflash-alias", &pfl
->orig_mem
, 0, size
);
114 memory_region_add_subregion(&pfl
->mem
, i
* size
, &pfl
->mem_mappings
[i
]);
118 static void pflash_register_memory(pflash_t
*pfl
, int rom_mode
)
120 memory_region_rom_device_set_romd(&pfl
->orig_mem
, rom_mode
);
121 pfl
->rom_mode
= rom_mode
;
124 static void pflash_timer (void *opaque
)
126 pflash_t
*pfl
= opaque
;
128 trace_pflash_timer_expired(pfl
->cmd
);
134 pflash_register_memory(pfl
, 1);
140 static uint32_t pflash_read (pflash_t
*pfl
, hwaddr offset
,
148 trace_pflash_read(offset
, pfl
->cmd
, width
, pfl
->wcycle
);
149 /* Lazy reset to ROMD mode after a certain amount of read accesses */
150 if (!pfl
->rom_mode
&& pfl
->wcycle
== 0 &&
151 ++pfl
->read_counter
> PFLASH_LAZY_ROMD_THRESHOLD
) {
152 pflash_register_memory(pfl
, 1);
154 offset
&= pfl
->chip_len
- 1;
155 boff
= offset
& 0xFF;
158 else if (pfl
->width
== 4)
162 /* This should never happen : reset state & treat it as a read*/
163 DPRINTF("%s: unknown command state: %x\n", __func__
, pfl
->cmd
);
166 /* fall through to the read code */
168 /* We accept reads during second unlock sequence... */
171 /* Flash area read */
176 trace_pflash_data_read8(offset
, ret
);
180 ret
= p
[offset
] << 8;
181 ret
|= p
[offset
+ 1];
184 ret
|= p
[offset
+ 1] << 8;
186 trace_pflash_data_read16(offset
, ret
);
190 ret
= p
[offset
] << 24;
191 ret
|= p
[offset
+ 1] << 16;
192 ret
|= p
[offset
+ 2] << 8;
193 ret
|= p
[offset
+ 3];
196 ret
|= p
[offset
+ 1] << 8;
197 ret
|= p
[offset
+ 2] << 16;
198 ret
|= p
[offset
+ 3] << 24;
200 trace_pflash_data_read32(offset
, ret
);
209 ret
= boff
& 0x01 ? pfl
->ident1
: pfl
->ident0
;
212 ret
= 0x00; /* Pretend all sectors are unprotected */
216 ret
= boff
& 0x01 ? pfl
->ident3
: pfl
->ident2
;
217 if (ret
== (uint8_t)-1) {
224 DPRINTF("%s: ID " TARGET_FMT_plx
" %x\n", __func__
, boff
, ret
);
229 /* Status register read */
231 DPRINTF("%s: status %x\n", __func__
, ret
);
237 if (boff
< sizeof(pfl
->cfi_table
)) {
238 ret
= pfl
->cfi_table
[boff
];
248 /* update flash content on disk */
249 static void pflash_update(pflash_t
*pfl
, int offset
,
254 offset_end
= offset
+ size
;
255 /* widen to sector boundaries */
256 offset
= QEMU_ALIGN_DOWN(offset
, BDRV_SECTOR_SIZE
);
257 offset_end
= QEMU_ALIGN_UP(offset_end
, BDRV_SECTOR_SIZE
);
258 blk_pwrite(pfl
->blk
, offset
, pfl
->storage
+ offset
,
259 offset_end
- offset
, 0);
263 static void pflash_write (pflash_t
*pfl
, hwaddr offset
,
264 uint32_t value
, int width
, int be
)
271 if (pfl
->cmd
!= 0xA0 && cmd
== 0xF0) {
273 DPRINTF("%s: flash reset asked (%02x %02x)\n",
274 __func__
, pfl
->cmd
, cmd
);
278 trace_pflash_write(offset
, value
, width
, pfl
->wcycle
);
279 offset
&= pfl
->chip_len
- 1;
281 DPRINTF("%s: offset " TARGET_FMT_plx
" %08x %d\n", __func__
,
282 offset
, value
, width
);
283 boff
= offset
& (pfl
->sector_len
- 1);
286 else if (pfl
->width
== 4)
288 switch (pfl
->wcycle
) {
290 /* Set the device in I/O access mode if required */
292 pflash_register_memory(pfl
, 0);
293 pfl
->read_counter
= 0;
294 /* We're in read mode */
296 if (boff
== 0x55 && cmd
== 0x98) {
298 /* Enter CFI query mode */
303 if (boff
!= pfl
->unlock_addr0
|| cmd
!= 0xAA) {
304 DPRINTF("%s: unlock0 failed " TARGET_FMT_plx
" %02x %04x\n",
305 __func__
, boff
, cmd
, pfl
->unlock_addr0
);
308 DPRINTF("%s: unlock sequence started\n", __func__
);
311 /* We started an unlock sequence */
313 if (boff
!= pfl
->unlock_addr1
|| cmd
!= 0x55) {
314 DPRINTF("%s: unlock1 failed " TARGET_FMT_plx
" %02x\n", __func__
,
318 DPRINTF("%s: unlock sequence done\n", __func__
);
321 /* We finished an unlock sequence */
322 if (!pfl
->bypass
&& boff
!= pfl
->unlock_addr0
) {
323 DPRINTF("%s: command failed " TARGET_FMT_plx
" %02x\n", __func__
,
335 DPRINTF("%s: starting command %02x\n", __func__
, cmd
);
338 DPRINTF("%s: unknown command %02x\n", __func__
, cmd
);
345 /* We need another unlock sequence */
348 trace_pflash_data_write(offset
, value
, width
, 0);
354 pflash_update(pfl
, offset
, 1);
358 p
[offset
] &= value
>> 8;
359 p
[offset
+ 1] &= value
;
362 p
[offset
+ 1] &= value
>> 8;
364 pflash_update(pfl
, offset
, 2);
368 p
[offset
] &= value
>> 24;
369 p
[offset
+ 1] &= value
>> 16;
370 p
[offset
+ 2] &= value
>> 8;
371 p
[offset
+ 3] &= value
;
374 p
[offset
+ 1] &= value
>> 8;
375 p
[offset
+ 2] &= value
>> 16;
376 p
[offset
+ 3] &= value
>> 24;
378 pflash_update(pfl
, offset
, 4);
382 pfl
->status
= 0x00 | ~(value
& 0x80);
383 /* Let's pretend write is immediate */
388 if (pfl
->bypass
&& cmd
== 0x00) {
389 /* Unlock bypass reset */
392 /* We can enter CFI query mode from autoselect mode */
393 if (boff
== 0x55 && cmd
== 0x98)
397 DPRINTF("%s: invalid write for command %02x\n",
404 /* Ignore writes while flash data write is occurring */
405 /* As we suppose write is immediate, this should never happen */
410 /* Should never happen */
411 DPRINTF("%s: invalid command state %02x (wc 4)\n",
419 if (boff
!= pfl
->unlock_addr0
) {
420 DPRINTF("%s: chip erase: invalid address " TARGET_FMT_plx
"\n",
425 DPRINTF("%s: start chip erase\n", __func__
);
427 memset(pfl
->storage
, 0xFF, pfl
->chip_len
);
428 pflash_update(pfl
, 0, pfl
->chip_len
);
431 /* Let's wait 5 seconds before chip erase is done */
432 timer_mod(pfl
->timer
, qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
) +
433 (NANOSECONDS_PER_SECOND
* 5));
438 offset
&= ~(pfl
->sector_len
- 1);
439 DPRINTF("%s: start sector erase at " TARGET_FMT_plx
"\n", __func__
,
442 memset(p
+ offset
, 0xFF, pfl
->sector_len
);
443 pflash_update(pfl
, offset
, pfl
->sector_len
);
446 /* Let's wait 1/2 second before sector erase is done */
447 timer_mod(pfl
->timer
, qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
) +
448 (NANOSECONDS_PER_SECOND
/ 2));
451 DPRINTF("%s: invalid command %02x (wc 5)\n", __func__
, cmd
);
459 /* Ignore writes during chip erase */
462 /* Ignore writes during sector erase */
465 /* Should never happen */
466 DPRINTF("%s: invalid command state %02x (wc 6)\n",
471 case 7: /* Special value for CFI queries */
472 DPRINTF("%s: invalid write in CFI query mode\n", __func__
);
475 /* Should never happen */
476 DPRINTF("%s: invalid write state (wc 7)\n", __func__
);
485 trace_pflash_reset();
496 static uint64_t pflash_be_readfn(void *opaque
, hwaddr addr
, unsigned size
)
498 return pflash_read(opaque
, addr
, size
, 1);
501 static void pflash_be_writefn(void *opaque
, hwaddr addr
,
502 uint64_t value
, unsigned size
)
504 pflash_write(opaque
, addr
, value
, size
, 1);
507 static uint64_t pflash_le_readfn(void *opaque
, hwaddr addr
, unsigned size
)
509 return pflash_read(opaque
, addr
, size
, 0);
512 static void pflash_le_writefn(void *opaque
, hwaddr addr
,
513 uint64_t value
, unsigned size
)
515 pflash_write(opaque
, addr
, value
, size
, 0);
518 static const MemoryRegionOps pflash_cfi02_ops_be
= {
519 .read
= pflash_be_readfn
,
520 .write
= pflash_be_writefn
,
521 .valid
.min_access_size
= 1,
522 .valid
.max_access_size
= 4,
523 .endianness
= DEVICE_NATIVE_ENDIAN
,
526 static const MemoryRegionOps pflash_cfi02_ops_le
= {
527 .read
= pflash_le_readfn
,
528 .write
= pflash_le_writefn
,
529 .valid
.min_access_size
= 1,
530 .valid
.max_access_size
= 4,
531 .endianness
= DEVICE_NATIVE_ENDIAN
,
534 static void pflash_cfi02_realize(DeviceState
*dev
, Error
**errp
)
536 pflash_t
*pfl
= CFI_PFLASH02(dev
);
539 Error
*local_err
= NULL
;
541 if (pfl
->sector_len
== 0) {
542 error_setg(errp
, "attribute \"sector-length\" not specified or zero.");
545 if (pfl
->nb_blocs
== 0) {
546 error_setg(errp
, "attribute \"num-blocks\" not specified or zero.");
549 if (pfl
->name
== NULL
) {
550 error_setg(errp
, "attribute \"name\" not specified.");
554 chip_len
= pfl
->sector_len
* pfl
->nb_blocs
;
555 /* XXX: to be fixed */
557 if (total_len
!= (8 * 1024 * 1024) && total_len
!= (16 * 1024 * 1024) &&
558 total_len
!= (32 * 1024 * 1024) && total_len
!= (64 * 1024 * 1024))
562 memory_region_init_rom_device(&pfl
->orig_mem
, OBJECT(pfl
), pfl
->be
?
563 &pflash_cfi02_ops_be
: &pflash_cfi02_ops_le
,
564 pfl
, pfl
->name
, chip_len
, &local_err
);
566 error_propagate(errp
, local_err
);
570 pfl
->storage
= memory_region_get_ram_ptr(&pfl
->orig_mem
);
571 pfl
->chip_len
= chip_len
;
575 pfl
->ro
= blk_is_read_only(pfl
->blk
);
576 perm
= BLK_PERM_CONSISTENT_READ
| (pfl
->ro
? 0 : BLK_PERM_WRITE
);
577 ret
= blk_set_perm(pfl
->blk
, perm
, BLK_PERM_ALL
, errp
);
586 /* read the initial flash content */
587 ret
= blk_pread(pfl
->blk
, 0, pfl
->storage
, chip_len
);
589 vmstate_unregister_ram(&pfl
->orig_mem
, DEVICE(pfl
));
590 error_setg(errp
, "failed to read the initial flash content");
595 pflash_setup_mappings(pfl
);
597 sysbus_init_mmio(SYS_BUS_DEVICE(dev
), &pfl
->mem
);
599 pfl
->timer
= timer_new_ns(QEMU_CLOCK_VIRTUAL
, pflash_timer
, pfl
);
603 /* Hardcoded CFI table (mostly from SG29 Spansion flash) */
604 /* Standard "QRY" string */
605 pfl
->cfi_table
[0x10] = 'Q';
606 pfl
->cfi_table
[0x11] = 'R';
607 pfl
->cfi_table
[0x12] = 'Y';
608 /* Command set (AMD/Fujitsu) */
609 pfl
->cfi_table
[0x13] = 0x02;
610 pfl
->cfi_table
[0x14] = 0x00;
611 /* Primary extended table address */
612 pfl
->cfi_table
[0x15] = 0x31;
613 pfl
->cfi_table
[0x16] = 0x00;
614 /* Alternate command set (none) */
615 pfl
->cfi_table
[0x17] = 0x00;
616 pfl
->cfi_table
[0x18] = 0x00;
617 /* Alternate extended table (none) */
618 pfl
->cfi_table
[0x19] = 0x00;
619 pfl
->cfi_table
[0x1A] = 0x00;
621 pfl
->cfi_table
[0x1B] = 0x27;
623 pfl
->cfi_table
[0x1C] = 0x36;
624 /* Vpp min (no Vpp pin) */
625 pfl
->cfi_table
[0x1D] = 0x00;
626 /* Vpp max (no Vpp pin) */
627 pfl
->cfi_table
[0x1E] = 0x00;
629 pfl
->cfi_table
[0x1F] = 0x07;
630 /* Timeout for min size buffer write (NA) */
631 pfl
->cfi_table
[0x20] = 0x00;
632 /* Typical timeout for block erase (512 ms) */
633 pfl
->cfi_table
[0x21] = 0x09;
634 /* Typical timeout for full chip erase (4096 ms) */
635 pfl
->cfi_table
[0x22] = 0x0C;
637 pfl
->cfi_table
[0x23] = 0x01;
638 /* Max timeout for buffer write (NA) */
639 pfl
->cfi_table
[0x24] = 0x00;
640 /* Max timeout for block erase */
641 pfl
->cfi_table
[0x25] = 0x0A;
642 /* Max timeout for chip erase */
643 pfl
->cfi_table
[0x26] = 0x0D;
645 pfl
->cfi_table
[0x27] = ctz32(chip_len
);
646 /* Flash device interface (8 & 16 bits) */
647 pfl
->cfi_table
[0x28] = 0x02;
648 pfl
->cfi_table
[0x29] = 0x00;
649 /* Max number of bytes in multi-bytes write */
650 /* XXX: disable buffered write as it's not supported */
651 // pfl->cfi_table[0x2A] = 0x05;
652 pfl
->cfi_table
[0x2A] = 0x00;
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;
681 static Property pflash_cfi02_properties
[] = {
682 DEFINE_PROP_DRIVE("drive", struct pflash_t
, blk
),
683 DEFINE_PROP_UINT32("num-blocks", struct pflash_t
, nb_blocs
, 0),
684 DEFINE_PROP_UINT32("sector-length", struct pflash_t
, sector_len
, 0),
685 DEFINE_PROP_UINT8("width", struct pflash_t
, width
, 0),
686 DEFINE_PROP_UINT8("mappings", struct pflash_t
, mappings
, 0),
687 DEFINE_PROP_UINT8("big-endian", struct pflash_t
, be
, 0),
688 DEFINE_PROP_UINT16("id0", struct pflash_t
, ident0
, 0),
689 DEFINE_PROP_UINT16("id1", struct pflash_t
, ident1
, 0),
690 DEFINE_PROP_UINT16("id2", struct pflash_t
, ident2
, 0),
691 DEFINE_PROP_UINT16("id3", struct pflash_t
, ident3
, 0),
692 DEFINE_PROP_UINT16("unlock-addr0", struct pflash_t
, unlock_addr0
, 0),
693 DEFINE_PROP_UINT16("unlock-addr1", struct pflash_t
, unlock_addr1
, 0),
694 DEFINE_PROP_STRING("name", struct pflash_t
, name
),
695 DEFINE_PROP_END_OF_LIST(),
698 static void pflash_cfi02_class_init(ObjectClass
*klass
, void *data
)
700 DeviceClass
*dc
= DEVICE_CLASS(klass
);
702 dc
->realize
= pflash_cfi02_realize
;
703 dc
->props
= pflash_cfi02_properties
;
704 set_bit(DEVICE_CATEGORY_STORAGE
, dc
->categories
);
707 static const TypeInfo pflash_cfi02_info
= {
708 .name
= TYPE_CFI_PFLASH02
,
709 .parent
= TYPE_SYS_BUS_DEVICE
,
710 .instance_size
= sizeof(struct pflash_t
),
711 .class_init
= pflash_cfi02_class_init
,
714 static void pflash_cfi02_register_types(void)
716 type_register_static(&pflash_cfi02_info
);
719 type_init(pflash_cfi02_register_types
)
721 pflash_t
*pflash_cfi02_register(hwaddr base
,
722 DeviceState
*qdev
, const char *name
,
724 BlockBackend
*blk
, uint32_t sector_len
,
725 int nb_blocs
, int nb_mappings
, int width
,
726 uint16_t id0
, uint16_t id1
,
727 uint16_t id2
, uint16_t id3
,
728 uint16_t unlock_addr0
, uint16_t unlock_addr1
,
731 DeviceState
*dev
= qdev_create(NULL
, TYPE_CFI_PFLASH02
);
734 qdev_prop_set_drive(dev
, "drive", blk
, &error_abort
);
736 qdev_prop_set_uint32(dev
, "num-blocks", nb_blocs
);
737 qdev_prop_set_uint32(dev
, "sector-length", sector_len
);
738 qdev_prop_set_uint8(dev
, "width", width
);
739 qdev_prop_set_uint8(dev
, "mappings", nb_mappings
);
740 qdev_prop_set_uint8(dev
, "big-endian", !!be
);
741 qdev_prop_set_uint16(dev
, "id0", id0
);
742 qdev_prop_set_uint16(dev
, "id1", id1
);
743 qdev_prop_set_uint16(dev
, "id2", id2
);
744 qdev_prop_set_uint16(dev
, "id3", id3
);
745 qdev_prop_set_uint16(dev
, "unlock-addr0", unlock_addr0
);
746 qdev_prop_set_uint16(dev
, "unlock-addr1", unlock_addr1
);
747 qdev_prop_set_string(dev
, "name", name
);
748 qdev_init_nofail(dev
);
750 sysbus_mmio_map(SYS_BUS_DEVICE(dev
), 0, base
);
751 return CFI_PFLASH02(dev
);