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"
42 #include "exec-memory.h"
44 //#define PFLASH_DEBUG
46 #define DPRINTF(fmt, ...) \
48 printf("PFLASH: " fmt , ## __VA_ARGS__); \
51 #define DPRINTF(fmt, ...) do { } while (0)
54 #define PFLASH_LAZY_ROMD_THRESHOLD 42
58 target_phys_addr_t base;
63 int wcycle; /* if 0, the flash is read normally */
69 uint16_t unlock_addr[2];
71 uint8_t cfi_table[0x52];
73 /* The device replicates the flash memory across its memory space. Emulate
74 * that by having a container (.mem) filled with an array of aliases
75 * (.mem_mappings) pointing to the flash memory (.orig_mem).
78 MemoryRegion *mem_mappings; /* array; one per mapping */
79 MemoryRegion orig_mem;
81 int read_counter; /* used for lazy switch-back to rom mode */
86 * Set up replicated mappings of the same region.
88 static void pflash_setup_mappings(pflash_t *pfl)
91 target_phys_addr_t size = memory_region_size(&pfl->orig_mem);
93 memory_region_init(&pfl->mem, "pflash", pfl->mappings * size);
94 pfl->mem_mappings = g_new(MemoryRegion, pfl->mappings);
95 for (i = 0; i < pfl->mappings; ++i) {
96 memory_region_init_alias(&pfl->mem_mappings[i], "pflash-alias",
97 &pfl->orig_mem, 0, size);
98 memory_region_add_subregion(&pfl->mem, i * size, &pfl->mem_mappings[i]);
102 static void pflash_register_memory(pflash_t *pfl, int rom_mode)
104 memory_region_rom_device_set_readable(&pfl->orig_mem, rom_mode);
105 pfl->rom_mode = rom_mode;
108 static void pflash_timer (void *opaque)
110 pflash_t *pfl = opaque;
112 DPRINTF("%s: command %02x done\n", __func__, pfl->cmd);
118 pflash_register_memory(pfl, 1);
124 static uint32_t pflash_read (pflash_t *pfl, target_phys_addr_t offset,
127 target_phys_addr_t boff;
131 DPRINTF("%s: offset " TARGET_FMT_plx "\n", __func__, offset);
133 /* Lazy reset to ROMD mode after a certain amount of read accesses */
134 if (!pfl->rom_mode && pfl->wcycle == 0 &&
135 ++pfl->read_counter > PFLASH_LAZY_ROMD_THRESHOLD) {
136 pflash_register_memory(pfl, 1);
138 offset &= pfl->chip_len - 1;
139 boff = offset & 0xFF;
142 else if (pfl->width == 4)
146 /* This should never happen : reset state & treat it as a read*/
147 DPRINTF("%s: unknown command state: %x\n", __func__, pfl->cmd);
151 /* We accept reads during second unlock sequence... */
154 /* Flash area read */
159 // DPRINTF("%s: data offset %08x %02x\n", __func__, offset, ret);
163 ret = p[offset] << 8;
164 ret |= p[offset + 1];
167 ret |= p[offset + 1] << 8;
169 // DPRINTF("%s: data offset %08x %04x\n", __func__, offset, ret);
173 ret = p[offset] << 24;
174 ret |= p[offset + 1] << 16;
175 ret |= p[offset + 2] << 8;
176 ret |= p[offset + 3];
179 ret |= p[offset + 1] << 8;
180 ret |= p[offset + 2] << 16;
181 ret |= p[offset + 3] << 24;
183 // DPRINTF("%s: data offset %08x %08x\n", __func__, offset, ret);
192 ret = pfl->ident[boff & 0x01];
195 ret = 0x00; /* Pretend all sectors are unprotected */
199 if (pfl->ident[2 + (boff & 0x01)] == (uint8_t)-1)
201 ret = pfl->ident[2 + (boff & 0x01)];
206 DPRINTF("%s: ID " TARGET_FMT_plx " %x\n", __func__, boff, ret);
211 /* Status register read */
213 DPRINTF("%s: status %x\n", __func__, ret);
219 if (boff > pfl->cfi_len)
222 ret = pfl->cfi_table[boff];
229 /* update flash content on disk */
230 static void pflash_update(pflash_t *pfl, int offset,
235 offset_end = offset + size;
236 /* round to sectors */
237 offset = offset >> 9;
238 offset_end = (offset_end + 511) >> 9;
239 bdrv_write(pfl->bs, offset, pfl->storage + (offset << 9),
240 offset_end - offset);
244 static void pflash_write (pflash_t *pfl, target_phys_addr_t offset,
245 uint32_t value, int width, int be)
247 target_phys_addr_t boff;
252 if (pfl->cmd != 0xA0 && cmd == 0xF0) {
254 DPRINTF("%s: flash reset asked (%02x %02x)\n",
255 __func__, pfl->cmd, cmd);
259 DPRINTF("%s: offset " TARGET_FMT_plx " %08x %d %d\n", __func__,
260 offset, value, width, pfl->wcycle);
261 offset &= pfl->chip_len - 1;
263 DPRINTF("%s: offset " TARGET_FMT_plx " %08x %d\n", __func__,
264 offset, value, width);
265 boff = offset & (pfl->sector_len - 1);
268 else if (pfl->width == 4)
270 switch (pfl->wcycle) {
272 /* Set the device in I/O access mode if required */
274 pflash_register_memory(pfl, 0);
275 pfl->read_counter = 0;
276 /* We're in read mode */
278 if (boff == 0x55 && cmd == 0x98) {
280 /* Enter CFI query mode */
285 if (boff != pfl->unlock_addr[0] || cmd != 0xAA) {
286 DPRINTF("%s: unlock0 failed " TARGET_FMT_plx " %02x %04x\n",
287 __func__, boff, cmd, pfl->unlock_addr[0]);
290 DPRINTF("%s: unlock sequence started\n", __func__);
293 /* We started an unlock sequence */
295 if (boff != pfl->unlock_addr[1] || cmd != 0x55) {
296 DPRINTF("%s: unlock1 failed " TARGET_FMT_plx " %02x\n", __func__,
300 DPRINTF("%s: unlock sequence done\n", __func__);
303 /* We finished an unlock sequence */
304 if (!pfl->bypass && boff != pfl->unlock_addr[0]) {
305 DPRINTF("%s: command failed " TARGET_FMT_plx " %02x\n", __func__,
317 DPRINTF("%s: starting command %02x\n", __func__, cmd);
320 DPRINTF("%s: unknown command %02x\n", __func__, cmd);
327 /* We need another unlock sequence */
330 DPRINTF("%s: write data offset " TARGET_FMT_plx " %08x %d\n",
331 __func__, offset, value, width);
337 pflash_update(pfl, offset, 1);
341 p[offset] &= value >> 8;
342 p[offset + 1] &= value;
345 p[offset + 1] &= value >> 8;
347 pflash_update(pfl, offset, 2);
351 p[offset] &= value >> 24;
352 p[offset + 1] &= value >> 16;
353 p[offset + 2] &= value >> 8;
354 p[offset + 3] &= value;
357 p[offset + 1] &= value >> 8;
358 p[offset + 2] &= value >> 16;
359 p[offset + 3] &= value >> 24;
361 pflash_update(pfl, offset, 4);
365 pfl->status = 0x00 | ~(value & 0x80);
366 /* Let's pretend write is immediate */
371 if (pfl->bypass && cmd == 0x00) {
372 /* Unlock bypass reset */
375 /* We can enter CFI query mode from autoselect mode */
376 if (boff == 0x55 && cmd == 0x98)
380 DPRINTF("%s: invalid write for command %02x\n",
387 /* Ignore writes while flash data write is occurring */
388 /* As we suppose write is immediate, this should never happen */
393 /* Should never happen */
394 DPRINTF("%s: invalid command state %02x (wc 4)\n",
402 if (boff != pfl->unlock_addr[0]) {
403 DPRINTF("%s: chip erase: invalid address " TARGET_FMT_plx "\n",
408 DPRINTF("%s: start chip erase\n", __func__);
410 memset(pfl->storage, 0xFF, pfl->chip_len);
411 pflash_update(pfl, 0, pfl->chip_len);
414 /* Let's wait 5 seconds before chip erase is done */
415 qemu_mod_timer(pfl->timer,
416 qemu_get_clock_ns(vm_clock) + (get_ticks_per_sec() * 5));
421 offset &= ~(pfl->sector_len - 1);
422 DPRINTF("%s: start sector erase at " TARGET_FMT_plx "\n", __func__,
425 memset(p + offset, 0xFF, pfl->sector_len);
426 pflash_update(pfl, offset, pfl->sector_len);
429 /* Let's wait 1/2 second before sector erase is done */
430 qemu_mod_timer(pfl->timer,
431 qemu_get_clock_ns(vm_clock) + (get_ticks_per_sec() / 2));
434 DPRINTF("%s: invalid command %02x (wc 5)\n", __func__, cmd);
442 /* Ignore writes during chip erase */
445 /* Ignore writes during sector erase */
448 /* Should never happen */
449 DPRINTF("%s: invalid command state %02x (wc 6)\n",
454 case 7: /* Special value for CFI queries */
455 DPRINTF("%s: invalid write in CFI query mode\n", __func__);
458 /* Should never happen */
459 DPRINTF("%s: invalid write state (wc 7)\n", __func__);
480 static uint32_t pflash_readb_be(void *opaque, target_phys_addr_t addr)
482 return pflash_read(opaque, addr, 1, 1);
485 static uint32_t pflash_readb_le(void *opaque, target_phys_addr_t addr)
487 return pflash_read(opaque, addr, 1, 0);
490 static uint32_t pflash_readw_be(void *opaque, target_phys_addr_t addr)
492 pflash_t *pfl = opaque;
494 return pflash_read(pfl, addr, 2, 1);
497 static uint32_t pflash_readw_le(void *opaque, target_phys_addr_t addr)
499 pflash_t *pfl = opaque;
501 return pflash_read(pfl, addr, 2, 0);
504 static uint32_t pflash_readl_be(void *opaque, target_phys_addr_t addr)
506 pflash_t *pfl = opaque;
508 return pflash_read(pfl, addr, 4, 1);
511 static uint32_t pflash_readl_le(void *opaque, target_phys_addr_t addr)
513 pflash_t *pfl = opaque;
515 return pflash_read(pfl, addr, 4, 0);
518 static void pflash_writeb_be(void *opaque, target_phys_addr_t addr,
521 pflash_write(opaque, addr, value, 1, 1);
524 static void pflash_writeb_le(void *opaque, target_phys_addr_t addr,
527 pflash_write(opaque, addr, value, 1, 0);
530 static void pflash_writew_be(void *opaque, target_phys_addr_t addr,
533 pflash_t *pfl = opaque;
535 pflash_write(pfl, addr, value, 2, 1);
538 static void pflash_writew_le(void *opaque, target_phys_addr_t addr,
541 pflash_t *pfl = opaque;
543 pflash_write(pfl, addr, value, 2, 0);
546 static void pflash_writel_be(void *opaque, target_phys_addr_t addr,
549 pflash_t *pfl = opaque;
551 pflash_write(pfl, addr, value, 4, 1);
554 static void pflash_writel_le(void *opaque, target_phys_addr_t addr,
557 pflash_t *pfl = opaque;
559 pflash_write(pfl, addr, value, 4, 0);
562 static const MemoryRegionOps pflash_cfi02_ops_be = {
564 .read = { pflash_readb_be, pflash_readw_be, pflash_readl_be, },
565 .write = { pflash_writeb_be, pflash_writew_be, pflash_writel_be, },
567 .endianness = DEVICE_NATIVE_ENDIAN,
570 static const MemoryRegionOps pflash_cfi02_ops_le = {
572 .read = { pflash_readb_le, pflash_readw_le, pflash_readl_le, },
573 .write = { pflash_writeb_le, pflash_writew_le, pflash_writel_le, },
575 .endianness = DEVICE_NATIVE_ENDIAN,
578 /* Count trailing zeroes of a 32 bits quantity */
579 static int ctz32 (uint32_t n)
602 #if 0 /* This is not necessary as n is never 0 */
606 #if 0 /* This is not necessary as n is never 0 */
614 pflash_t *pflash_cfi02_register(target_phys_addr_t base,
615 DeviceState *qdev, const char *name,
616 target_phys_addr_t size,
617 BlockDriverState *bs, uint32_t sector_len,
618 int nb_blocs, int nb_mappings, int width,
619 uint16_t id0, uint16_t id1,
620 uint16_t id2, uint16_t id3,
621 uint16_t unlock_addr0, uint16_t unlock_addr1,
628 chip_len = sector_len * nb_blocs;
629 /* XXX: to be fixed */
631 if (total_len != (8 * 1024 * 1024) && total_len != (16 * 1024 * 1024) &&
632 total_len != (32 * 1024 * 1024) && total_len != (64 * 1024 * 1024))
635 pfl = g_malloc0(sizeof(pflash_t));
636 memory_region_init_rom_device(
637 &pfl->orig_mem, be ? &pflash_cfi02_ops_be : &pflash_cfi02_ops_le, pfl,
639 vmstate_register_ram(&pfl->orig_mem, qdev);
640 pfl->storage = memory_region_get_ram_ptr(&pfl->orig_mem);
642 pfl->chip_len = chip_len;
643 pfl->mappings = nb_mappings;
646 /* read the initial flash content */
647 ret = bdrv_read(pfl->bs, 0, pfl->storage, chip_len >> 9);
652 bdrv_attach_dev_nofail(pfl->bs, pfl);
655 pflash_setup_mappings(pfl);
657 memory_region_add_subregion(get_system_memory(), pfl->base, &pfl->mem);
660 pfl->ro = bdrv_is_read_only(pfl->bs);
665 pfl->timer = qemu_new_timer_ns(vm_clock, pflash_timer, pfl);
666 pfl->sector_len = sector_len;
675 pfl->unlock_addr[0] = unlock_addr0;
676 pfl->unlock_addr[1] = unlock_addr1;
677 /* Hardcoded CFI table (mostly from SG29 Spansion flash) */
679 /* Standard "QRY" string */
680 pfl->cfi_table[0x10] = 'Q';
681 pfl->cfi_table[0x11] = 'R';
682 pfl->cfi_table[0x12] = 'Y';
683 /* Command set (AMD/Fujitsu) */
684 pfl->cfi_table[0x13] = 0x02;
685 pfl->cfi_table[0x14] = 0x00;
686 /* Primary extended table address */
687 pfl->cfi_table[0x15] = 0x31;
688 pfl->cfi_table[0x16] = 0x00;
689 /* Alternate command set (none) */
690 pfl->cfi_table[0x17] = 0x00;
691 pfl->cfi_table[0x18] = 0x00;
692 /* Alternate extended table (none) */
693 pfl->cfi_table[0x19] = 0x00;
694 pfl->cfi_table[0x1A] = 0x00;
696 pfl->cfi_table[0x1B] = 0x27;
698 pfl->cfi_table[0x1C] = 0x36;
699 /* Vpp min (no Vpp pin) */
700 pfl->cfi_table[0x1D] = 0x00;
701 /* Vpp max (no Vpp pin) */
702 pfl->cfi_table[0x1E] = 0x00;
704 pfl->cfi_table[0x1F] = 0x07;
705 /* Timeout for min size buffer write (NA) */
706 pfl->cfi_table[0x20] = 0x00;
707 /* Typical timeout for block erase (512 ms) */
708 pfl->cfi_table[0x21] = 0x09;
709 /* Typical timeout for full chip erase (4096 ms) */
710 pfl->cfi_table[0x22] = 0x0C;
712 pfl->cfi_table[0x23] = 0x01;
713 /* Max timeout for buffer write (NA) */
714 pfl->cfi_table[0x24] = 0x00;
715 /* Max timeout for block erase */
716 pfl->cfi_table[0x25] = 0x0A;
717 /* Max timeout for chip erase */
718 pfl->cfi_table[0x26] = 0x0D;
720 pfl->cfi_table[0x27] = ctz32(chip_len);
721 /* Flash device interface (8 & 16 bits) */
722 pfl->cfi_table[0x28] = 0x02;
723 pfl->cfi_table[0x29] = 0x00;
724 /* Max number of bytes in multi-bytes write */
725 /* XXX: disable buffered write as it's not supported */
726 // pfl->cfi_table[0x2A] = 0x05;
727 pfl->cfi_table[0x2A] = 0x00;
728 pfl->cfi_table[0x2B] = 0x00;
729 /* Number of erase block regions (uniform) */
730 pfl->cfi_table[0x2C] = 0x01;
731 /* Erase block region 1 */
732 pfl->cfi_table[0x2D] = nb_blocs - 1;
733 pfl->cfi_table[0x2E] = (nb_blocs - 1) >> 8;
734 pfl->cfi_table[0x2F] = sector_len >> 8;
735 pfl->cfi_table[0x30] = sector_len >> 16;
738 pfl->cfi_table[0x31] = 'P';
739 pfl->cfi_table[0x32] = 'R';
740 pfl->cfi_table[0x33] = 'I';
742 pfl->cfi_table[0x34] = '1';
743 pfl->cfi_table[0x35] = '0';
745 pfl->cfi_table[0x36] = 0x00;
746 pfl->cfi_table[0x37] = 0x00;
747 pfl->cfi_table[0x38] = 0x00;
748 pfl->cfi_table[0x39] = 0x00;
750 pfl->cfi_table[0x3a] = 0x00;
752 pfl->cfi_table[0x3b] = 0x00;
753 pfl->cfi_table[0x3c] = 0x00;