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"
43 #include "host-utils.h"
45 //#define PFLASH_DEBUG
47 #define DPRINTF(fmt, ...) \
49 printf("PFLASH: " fmt , ## __VA_ARGS__); \
52 #define DPRINTF(fmt, ...) do { } while (0)
55 #define PFLASH_LAZY_ROMD_THRESHOLD 42
64 int wcycle; /* if 0, the flash is read normally */
70 uint16_t unlock_addr[2];
72 uint8_t cfi_table[0x52];
74 /* The device replicates the flash memory across its memory space. Emulate
75 * that by having a container (.mem) filled with an array of aliases
76 * (.mem_mappings) pointing to the flash memory (.orig_mem).
79 MemoryRegion *mem_mappings; /* array; one per mapping */
80 MemoryRegion orig_mem;
82 int read_counter; /* used for lazy switch-back to rom mode */
87 * Set up replicated mappings of the same region.
89 static void pflash_setup_mappings(pflash_t *pfl)
92 hwaddr size = memory_region_size(&pfl->orig_mem);
94 memory_region_init(&pfl->mem, "pflash", pfl->mappings * size);
95 pfl->mem_mappings = g_new(MemoryRegion, pfl->mappings);
96 for (i = 0; i < pfl->mappings; ++i) {
97 memory_region_init_alias(&pfl->mem_mappings[i], "pflash-alias",
98 &pfl->orig_mem, 0, size);
99 memory_region_add_subregion(&pfl->mem, i * size, &pfl->mem_mappings[i]);
103 static void pflash_register_memory(pflash_t *pfl, int rom_mode)
105 memory_region_rom_device_set_readable(&pfl->orig_mem, rom_mode);
106 pfl->rom_mode = rom_mode;
109 static void pflash_timer (void *opaque)
111 pflash_t *pfl = opaque;
113 DPRINTF("%s: command %02x done\n", __func__, pfl->cmd);
119 pflash_register_memory(pfl, 1);
125 static uint32_t pflash_read (pflash_t *pfl, hwaddr offset,
132 DPRINTF("%s: offset " TARGET_FMT_plx "\n", __func__, offset);
134 /* Lazy reset to ROMD mode after a certain amount of read accesses */
135 if (!pfl->rom_mode && pfl->wcycle == 0 &&
136 ++pfl->read_counter > PFLASH_LAZY_ROMD_THRESHOLD) {
137 pflash_register_memory(pfl, 1);
139 offset &= pfl->chip_len - 1;
140 boff = offset & 0xFF;
143 else if (pfl->width == 4)
147 /* This should never happen : reset state & treat it as a read*/
148 DPRINTF("%s: unknown command state: %x\n", __func__, pfl->cmd);
152 /* We accept reads during second unlock sequence... */
155 /* Flash area read */
160 // DPRINTF("%s: data offset %08x %02x\n", __func__, offset, ret);
164 ret = p[offset] << 8;
165 ret |= p[offset + 1];
168 ret |= p[offset + 1] << 8;
170 // DPRINTF("%s: data offset %08x %04x\n", __func__, offset, ret);
174 ret = p[offset] << 24;
175 ret |= p[offset + 1] << 16;
176 ret |= p[offset + 2] << 8;
177 ret |= p[offset + 3];
180 ret |= p[offset + 1] << 8;
181 ret |= p[offset + 2] << 16;
182 ret |= p[offset + 3] << 24;
184 // DPRINTF("%s: data offset %08x %08x\n", __func__, offset, ret);
193 ret = pfl->ident[boff & 0x01];
196 ret = 0x00; /* Pretend all sectors are unprotected */
200 if (pfl->ident[2 + (boff & 0x01)] == (uint8_t)-1)
202 ret = pfl->ident[2 + (boff & 0x01)];
207 DPRINTF("%s: ID " TARGET_FMT_plx " %x\n", __func__, boff, ret);
212 /* Status register read */
214 DPRINTF("%s: status %x\n", __func__, ret);
220 if (boff > pfl->cfi_len)
223 ret = pfl->cfi_table[boff];
230 /* update flash content on disk */
231 static void pflash_update(pflash_t *pfl, int offset,
236 offset_end = offset + size;
237 /* round to sectors */
238 offset = offset >> 9;
239 offset_end = (offset_end + 511) >> 9;
240 bdrv_write(pfl->bs, offset, pfl->storage + (offset << 9),
241 offset_end - offset);
245 static void pflash_write (pflash_t *pfl, hwaddr offset,
246 uint32_t value, int width, int be)
253 if (pfl->cmd != 0xA0 && cmd == 0xF0) {
255 DPRINTF("%s: flash reset asked (%02x %02x)\n",
256 __func__, pfl->cmd, cmd);
260 DPRINTF("%s: offset " TARGET_FMT_plx " %08x %d %d\n", __func__,
261 offset, value, width, pfl->wcycle);
262 offset &= pfl->chip_len - 1;
264 DPRINTF("%s: offset " TARGET_FMT_plx " %08x %d\n", __func__,
265 offset, value, width);
266 boff = offset & (pfl->sector_len - 1);
269 else if (pfl->width == 4)
271 switch (pfl->wcycle) {
273 /* Set the device in I/O access mode if required */
275 pflash_register_memory(pfl, 0);
276 pfl->read_counter = 0;
277 /* We're in read mode */
279 if (boff == 0x55 && cmd == 0x98) {
281 /* Enter CFI query mode */
286 if (boff != pfl->unlock_addr[0] || cmd != 0xAA) {
287 DPRINTF("%s: unlock0 failed " TARGET_FMT_plx " %02x %04x\n",
288 __func__, boff, cmd, pfl->unlock_addr[0]);
291 DPRINTF("%s: unlock sequence started\n", __func__);
294 /* We started an unlock sequence */
296 if (boff != pfl->unlock_addr[1] || cmd != 0x55) {
297 DPRINTF("%s: unlock1 failed " TARGET_FMT_plx " %02x\n", __func__,
301 DPRINTF("%s: unlock sequence done\n", __func__);
304 /* We finished an unlock sequence */
305 if (!pfl->bypass && boff != pfl->unlock_addr[0]) {
306 DPRINTF("%s: command failed " TARGET_FMT_plx " %02x\n", __func__,
318 DPRINTF("%s: starting command %02x\n", __func__, cmd);
321 DPRINTF("%s: unknown command %02x\n", __func__, cmd);
328 /* We need another unlock sequence */
331 DPRINTF("%s: write data offset " TARGET_FMT_plx " %08x %d\n",
332 __func__, offset, value, width);
338 pflash_update(pfl, offset, 1);
342 p[offset] &= value >> 8;
343 p[offset + 1] &= value;
346 p[offset + 1] &= value >> 8;
348 pflash_update(pfl, offset, 2);
352 p[offset] &= value >> 24;
353 p[offset + 1] &= value >> 16;
354 p[offset + 2] &= value >> 8;
355 p[offset + 3] &= value;
358 p[offset + 1] &= value >> 8;
359 p[offset + 2] &= value >> 16;
360 p[offset + 3] &= value >> 24;
362 pflash_update(pfl, offset, 4);
366 pfl->status = 0x00 | ~(value & 0x80);
367 /* Let's pretend write is immediate */
372 if (pfl->bypass && cmd == 0x00) {
373 /* Unlock bypass reset */
376 /* We can enter CFI query mode from autoselect mode */
377 if (boff == 0x55 && cmd == 0x98)
381 DPRINTF("%s: invalid write for command %02x\n",
388 /* Ignore writes while flash data write is occurring */
389 /* As we suppose write is immediate, this should never happen */
394 /* Should never happen */
395 DPRINTF("%s: invalid command state %02x (wc 4)\n",
403 if (boff != pfl->unlock_addr[0]) {
404 DPRINTF("%s: chip erase: invalid address " TARGET_FMT_plx "\n",
409 DPRINTF("%s: start chip erase\n", __func__);
411 memset(pfl->storage, 0xFF, pfl->chip_len);
412 pflash_update(pfl, 0, pfl->chip_len);
415 /* Let's wait 5 seconds before chip erase is done */
416 qemu_mod_timer(pfl->timer,
417 qemu_get_clock_ns(vm_clock) + (get_ticks_per_sec() * 5));
422 offset &= ~(pfl->sector_len - 1);
423 DPRINTF("%s: start sector erase at " TARGET_FMT_plx "\n", __func__,
426 memset(p + offset, 0xFF, pfl->sector_len);
427 pflash_update(pfl, offset, pfl->sector_len);
430 /* Let's wait 1/2 second before sector erase is done */
431 qemu_mod_timer(pfl->timer,
432 qemu_get_clock_ns(vm_clock) + (get_ticks_per_sec() / 2));
435 DPRINTF("%s: invalid command %02x (wc 5)\n", __func__, cmd);
443 /* Ignore writes during chip erase */
446 /* Ignore writes during sector erase */
449 /* Should never happen */
450 DPRINTF("%s: invalid command state %02x (wc 6)\n",
455 case 7: /* Special value for CFI queries */
456 DPRINTF("%s: invalid write in CFI query mode\n", __func__);
459 /* Should never happen */
460 DPRINTF("%s: invalid write state (wc 7)\n", __func__);
480 static uint32_t pflash_readb_be(void *opaque, hwaddr addr)
482 return pflash_read(opaque, addr, 1, 1);
485 static uint32_t pflash_readb_le(void *opaque, hwaddr addr)
487 return pflash_read(opaque, addr, 1, 0);
490 static uint32_t pflash_readw_be(void *opaque, hwaddr addr)
492 pflash_t *pfl = opaque;
494 return pflash_read(pfl, addr, 2, 1);
497 static uint32_t pflash_readw_le(void *opaque, hwaddr addr)
499 pflash_t *pfl = opaque;
501 return pflash_read(pfl, addr, 2, 0);
504 static uint32_t pflash_readl_be(void *opaque, hwaddr addr)
506 pflash_t *pfl = opaque;
508 return pflash_read(pfl, addr, 4, 1);
511 static uint32_t pflash_readl_le(void *opaque, hwaddr addr)
513 pflash_t *pfl = opaque;
515 return pflash_read(pfl, addr, 4, 0);
518 static void pflash_writeb_be(void *opaque, hwaddr addr,
521 pflash_write(opaque, addr, value, 1, 1);
524 static void pflash_writeb_le(void *opaque, hwaddr addr,
527 pflash_write(opaque, addr, value, 1, 0);
530 static void pflash_writew_be(void *opaque, hwaddr addr,
533 pflash_t *pfl = opaque;
535 pflash_write(pfl, addr, value, 2, 1);
538 static void pflash_writew_le(void *opaque, hwaddr addr,
541 pflash_t *pfl = opaque;
543 pflash_write(pfl, addr, value, 2, 0);
546 static void pflash_writel_be(void *opaque, hwaddr addr,
549 pflash_t *pfl = opaque;
551 pflash_write(pfl, addr, value, 4, 1);
554 static void pflash_writel_le(void *opaque, hwaddr 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 pflash_t *pflash_cfi02_register(hwaddr base,
579 DeviceState *qdev, const char *name,
581 BlockDriverState *bs, uint32_t sector_len,
582 int nb_blocs, int nb_mappings, int width,
583 uint16_t id0, uint16_t id1,
584 uint16_t id2, uint16_t id3,
585 uint16_t unlock_addr0, uint16_t unlock_addr1,
592 chip_len = sector_len * nb_blocs;
593 /* XXX: to be fixed */
595 if (total_len != (8 * 1024 * 1024) && total_len != (16 * 1024 * 1024) &&
596 total_len != (32 * 1024 * 1024) && total_len != (64 * 1024 * 1024))
599 pfl = g_malloc0(sizeof(pflash_t));
600 memory_region_init_rom_device(
601 &pfl->orig_mem, be ? &pflash_cfi02_ops_be : &pflash_cfi02_ops_le, pfl,
603 vmstate_register_ram(&pfl->orig_mem, qdev);
604 pfl->storage = memory_region_get_ram_ptr(&pfl->orig_mem);
606 pfl->chip_len = chip_len;
607 pfl->mappings = nb_mappings;
610 /* read the initial flash content */
611 ret = bdrv_read(pfl->bs, 0, pfl->storage, chip_len >> 9);
616 bdrv_attach_dev_nofail(pfl->bs, pfl);
619 pflash_setup_mappings(pfl);
621 memory_region_add_subregion(get_system_memory(), pfl->base, &pfl->mem);
624 pfl->ro = bdrv_is_read_only(pfl->bs);
629 pfl->timer = qemu_new_timer_ns(vm_clock, pflash_timer, pfl);
630 pfl->sector_len = sector_len;
639 pfl->unlock_addr[0] = unlock_addr0;
640 pfl->unlock_addr[1] = unlock_addr1;
641 /* Hardcoded CFI table (mostly from SG29 Spansion flash) */
643 /* Standard "QRY" string */
644 pfl->cfi_table[0x10] = 'Q';
645 pfl->cfi_table[0x11] = 'R';
646 pfl->cfi_table[0x12] = 'Y';
647 /* Command set (AMD/Fujitsu) */
648 pfl->cfi_table[0x13] = 0x02;
649 pfl->cfi_table[0x14] = 0x00;
650 /* Primary extended table address */
651 pfl->cfi_table[0x15] = 0x31;
652 pfl->cfi_table[0x16] = 0x00;
653 /* Alternate command set (none) */
654 pfl->cfi_table[0x17] = 0x00;
655 pfl->cfi_table[0x18] = 0x00;
656 /* Alternate extended table (none) */
657 pfl->cfi_table[0x19] = 0x00;
658 pfl->cfi_table[0x1A] = 0x00;
660 pfl->cfi_table[0x1B] = 0x27;
662 pfl->cfi_table[0x1C] = 0x36;
663 /* Vpp min (no Vpp pin) */
664 pfl->cfi_table[0x1D] = 0x00;
665 /* Vpp max (no Vpp pin) */
666 pfl->cfi_table[0x1E] = 0x00;
668 pfl->cfi_table[0x1F] = 0x07;
669 /* Timeout for min size buffer write (NA) */
670 pfl->cfi_table[0x20] = 0x00;
671 /* Typical timeout for block erase (512 ms) */
672 pfl->cfi_table[0x21] = 0x09;
673 /* Typical timeout for full chip erase (4096 ms) */
674 pfl->cfi_table[0x22] = 0x0C;
676 pfl->cfi_table[0x23] = 0x01;
677 /* Max timeout for buffer write (NA) */
678 pfl->cfi_table[0x24] = 0x00;
679 /* Max timeout for block erase */
680 pfl->cfi_table[0x25] = 0x0A;
681 /* Max timeout for chip erase */
682 pfl->cfi_table[0x26] = 0x0D;
684 pfl->cfi_table[0x27] = ctz32(chip_len);
685 /* Flash device interface (8 & 16 bits) */
686 pfl->cfi_table[0x28] = 0x02;
687 pfl->cfi_table[0x29] = 0x00;
688 /* Max number of bytes in multi-bytes write */
689 /* XXX: disable buffered write as it's not supported */
690 // pfl->cfi_table[0x2A] = 0x05;
691 pfl->cfi_table[0x2A] = 0x00;
692 pfl->cfi_table[0x2B] = 0x00;
693 /* Number of erase block regions (uniform) */
694 pfl->cfi_table[0x2C] = 0x01;
695 /* Erase block region 1 */
696 pfl->cfi_table[0x2D] = nb_blocs - 1;
697 pfl->cfi_table[0x2E] = (nb_blocs - 1) >> 8;
698 pfl->cfi_table[0x2F] = sector_len >> 8;
699 pfl->cfi_table[0x30] = sector_len >> 16;
702 pfl->cfi_table[0x31] = 'P';
703 pfl->cfi_table[0x32] = 'R';
704 pfl->cfi_table[0x33] = 'I';
706 pfl->cfi_table[0x34] = '1';
707 pfl->cfi_table[0x35] = '0';
709 pfl->cfi_table[0x36] = 0x00;
710 pfl->cfi_table[0x37] = 0x00;
711 pfl->cfi_table[0x38] = 0x00;
712 pfl->cfi_table[0x39] = 0x00;
714 pfl->cfi_table[0x3a] = 0x00;
716 pfl->cfi_table[0x3b] = 0x00;
717 pfl->cfi_table[0x3c] = 0x00;