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);
336 pflash_update(pfl, offset, 1);
340 p[offset] &= value >> 8;
341 p[offset + 1] &= value;
344 p[offset + 1] &= value >> 8;
346 pflash_update(pfl, offset, 2);
350 p[offset] &= value >> 24;
351 p[offset + 1] &= value >> 16;
352 p[offset + 2] &= value >> 8;
353 p[offset + 3] &= value;
356 p[offset + 1] &= value >> 8;
357 p[offset + 2] &= value >> 16;
358 p[offset + 3] &= value >> 24;
360 pflash_update(pfl, offset, 4);
363 pfl->status = 0x00 | ~(value & 0x80);
364 /* Let's pretend write is immediate */
369 if (pfl->bypass && cmd == 0x00) {
370 /* Unlock bypass reset */
373 /* We can enter CFI query mode from autoselect mode */
374 if (boff == 0x55 && cmd == 0x98)
378 DPRINTF("%s: invalid write for command %02x\n",
385 /* Ignore writes while flash data write is occurring */
386 /* As we suppose write is immediate, this should never happen */
391 /* Should never happen */
392 DPRINTF("%s: invalid command state %02x (wc 4)\n",
400 if (boff != pfl->unlock_addr[0]) {
401 DPRINTF("%s: chip erase: invalid address " TARGET_FMT_plx "\n",
406 DPRINTF("%s: start chip erase\n", __func__);
407 memset(pfl->storage, 0xFF, pfl->chip_len);
409 pflash_update(pfl, 0, pfl->chip_len);
410 /* Let's wait 5 seconds before chip erase is done */
411 qemu_mod_timer(pfl->timer,
412 qemu_get_clock_ns(vm_clock) + (get_ticks_per_sec() * 5));
417 offset &= ~(pfl->sector_len - 1);
418 DPRINTF("%s: start sector erase at " TARGET_FMT_plx "\n", __func__,
420 memset(p + offset, 0xFF, pfl->sector_len);
421 pflash_update(pfl, offset, pfl->sector_len);
423 /* Let's wait 1/2 second before sector erase is done */
424 qemu_mod_timer(pfl->timer,
425 qemu_get_clock_ns(vm_clock) + (get_ticks_per_sec() / 2));
428 DPRINTF("%s: invalid command %02x (wc 5)\n", __func__, cmd);
436 /* Ignore writes during chip erase */
439 /* Ignore writes during sector erase */
442 /* Should never happen */
443 DPRINTF("%s: invalid command state %02x (wc 6)\n",
448 case 7: /* Special value for CFI queries */
449 DPRINTF("%s: invalid write in CFI query mode\n", __func__);
452 /* Should never happen */
453 DPRINTF("%s: invalid write state (wc 7)\n", __func__);
474 static uint32_t pflash_readb_be(void *opaque, target_phys_addr_t addr)
476 return pflash_read(opaque, addr, 1, 1);
479 static uint32_t pflash_readb_le(void *opaque, target_phys_addr_t addr)
481 return pflash_read(opaque, addr, 1, 0);
484 static uint32_t pflash_readw_be(void *opaque, target_phys_addr_t addr)
486 pflash_t *pfl = opaque;
488 return pflash_read(pfl, addr, 2, 1);
491 static uint32_t pflash_readw_le(void *opaque, target_phys_addr_t addr)
493 pflash_t *pfl = opaque;
495 return pflash_read(pfl, addr, 2, 0);
498 static uint32_t pflash_readl_be(void *opaque, target_phys_addr_t addr)
500 pflash_t *pfl = opaque;
502 return pflash_read(pfl, addr, 4, 1);
505 static uint32_t pflash_readl_le(void *opaque, target_phys_addr_t addr)
507 pflash_t *pfl = opaque;
509 return pflash_read(pfl, addr, 4, 0);
512 static void pflash_writeb_be(void *opaque, target_phys_addr_t addr,
515 pflash_write(opaque, addr, value, 1, 1);
518 static void pflash_writeb_le(void *opaque, target_phys_addr_t addr,
521 pflash_write(opaque, addr, value, 1, 0);
524 static void pflash_writew_be(void *opaque, target_phys_addr_t addr,
527 pflash_t *pfl = opaque;
529 pflash_write(pfl, addr, value, 2, 1);
532 static void pflash_writew_le(void *opaque, target_phys_addr_t addr,
535 pflash_t *pfl = opaque;
537 pflash_write(pfl, addr, value, 2, 0);
540 static void pflash_writel_be(void *opaque, target_phys_addr_t addr,
543 pflash_t *pfl = opaque;
545 pflash_write(pfl, addr, value, 4, 1);
548 static void pflash_writel_le(void *opaque, target_phys_addr_t addr,
551 pflash_t *pfl = opaque;
553 pflash_write(pfl, addr, value, 4, 0);
556 static const MemoryRegionOps pflash_cfi02_ops_be = {
558 .read = { pflash_readb_be, pflash_readw_be, pflash_readl_be, },
559 .write = { pflash_writeb_be, pflash_writew_be, pflash_writel_be, },
561 .endianness = DEVICE_NATIVE_ENDIAN,
564 static const MemoryRegionOps pflash_cfi02_ops_le = {
566 .read = { pflash_readb_le, pflash_readw_le, pflash_readl_le, },
567 .write = { pflash_writeb_le, pflash_writew_le, pflash_writel_le, },
569 .endianness = DEVICE_NATIVE_ENDIAN,
572 /* Count trailing zeroes of a 32 bits quantity */
573 static int ctz32 (uint32_t n)
596 #if 0 /* This is not necessary as n is never 0 */
600 #if 0 /* This is not necessary as n is never 0 */
608 pflash_t *pflash_cfi02_register(target_phys_addr_t base,
609 DeviceState *qdev, const char *name,
610 target_phys_addr_t size,
611 BlockDriverState *bs, uint32_t sector_len,
612 int nb_blocs, int nb_mappings, int width,
613 uint16_t id0, uint16_t id1,
614 uint16_t id2, uint16_t id3,
615 uint16_t unlock_addr0, uint16_t unlock_addr1,
622 chip_len = sector_len * nb_blocs;
623 /* XXX: to be fixed */
625 if (total_len != (8 * 1024 * 1024) && total_len != (16 * 1024 * 1024) &&
626 total_len != (32 * 1024 * 1024) && total_len != (64 * 1024 * 1024))
629 pfl = g_malloc0(sizeof(pflash_t));
630 memory_region_init_rom_device(
631 &pfl->orig_mem, be ? &pflash_cfi02_ops_be : &pflash_cfi02_ops_le, pfl,
633 vmstate_register_ram(&pfl->orig_mem, qdev);
634 pfl->storage = memory_region_get_ram_ptr(&pfl->orig_mem);
636 pfl->chip_len = chip_len;
637 pfl->mappings = nb_mappings;
640 /* read the initial flash content */
641 ret = bdrv_read(pfl->bs, 0, pfl->storage, chip_len >> 9);
646 bdrv_attach_dev_nofail(pfl->bs, pfl);
648 pflash_setup_mappings(pfl);
650 memory_region_add_subregion(get_system_memory(), pfl->base, &pfl->mem);
651 #if 0 /* XXX: there should be a bit to set up read-only,
652 * the same way the hardware does (with WP pin).
658 pfl->timer = qemu_new_timer_ns(vm_clock, pflash_timer, pfl);
659 pfl->sector_len = sector_len;
668 pfl->unlock_addr[0] = unlock_addr0;
669 pfl->unlock_addr[1] = unlock_addr1;
670 /* Hardcoded CFI table (mostly from SG29 Spansion flash) */
672 /* Standard "QRY" string */
673 pfl->cfi_table[0x10] = 'Q';
674 pfl->cfi_table[0x11] = 'R';
675 pfl->cfi_table[0x12] = 'Y';
676 /* Command set (AMD/Fujitsu) */
677 pfl->cfi_table[0x13] = 0x02;
678 pfl->cfi_table[0x14] = 0x00;
679 /* Primary extended table address */
680 pfl->cfi_table[0x15] = 0x31;
681 pfl->cfi_table[0x16] = 0x00;
682 /* Alternate command set (none) */
683 pfl->cfi_table[0x17] = 0x00;
684 pfl->cfi_table[0x18] = 0x00;
685 /* Alternate extended table (none) */
686 pfl->cfi_table[0x19] = 0x00;
687 pfl->cfi_table[0x1A] = 0x00;
689 pfl->cfi_table[0x1B] = 0x27;
691 pfl->cfi_table[0x1C] = 0x36;
692 /* Vpp min (no Vpp pin) */
693 pfl->cfi_table[0x1D] = 0x00;
694 /* Vpp max (no Vpp pin) */
695 pfl->cfi_table[0x1E] = 0x00;
697 pfl->cfi_table[0x1F] = 0x07;
698 /* Timeout for min size buffer write (NA) */
699 pfl->cfi_table[0x20] = 0x00;
700 /* Typical timeout for block erase (512 ms) */
701 pfl->cfi_table[0x21] = 0x09;
702 /* Typical timeout for full chip erase (4096 ms) */
703 pfl->cfi_table[0x22] = 0x0C;
705 pfl->cfi_table[0x23] = 0x01;
706 /* Max timeout for buffer write (NA) */
707 pfl->cfi_table[0x24] = 0x00;
708 /* Max timeout for block erase */
709 pfl->cfi_table[0x25] = 0x0A;
710 /* Max timeout for chip erase */
711 pfl->cfi_table[0x26] = 0x0D;
713 pfl->cfi_table[0x27] = ctz32(chip_len);
714 /* Flash device interface (8 & 16 bits) */
715 pfl->cfi_table[0x28] = 0x02;
716 pfl->cfi_table[0x29] = 0x00;
717 /* Max number of bytes in multi-bytes write */
718 /* XXX: disable buffered write as it's not supported */
719 // pfl->cfi_table[0x2A] = 0x05;
720 pfl->cfi_table[0x2A] = 0x00;
721 pfl->cfi_table[0x2B] = 0x00;
722 /* Number of erase block regions (uniform) */
723 pfl->cfi_table[0x2C] = 0x01;
724 /* Erase block region 1 */
725 pfl->cfi_table[0x2D] = nb_blocs - 1;
726 pfl->cfi_table[0x2E] = (nb_blocs - 1) >> 8;
727 pfl->cfi_table[0x2F] = sector_len >> 8;
728 pfl->cfi_table[0x30] = sector_len >> 16;
731 pfl->cfi_table[0x31] = 'P';
732 pfl->cfi_table[0x32] = 'R';
733 pfl->cfi_table[0x33] = 'I';
735 pfl->cfi_table[0x34] = '1';
736 pfl->cfi_table[0x35] = '0';
738 pfl->cfi_table[0x36] = 0x00;
739 pfl->cfi_table[0x37] = 0x00;
740 pfl->cfi_table[0x38] = 0x00;
741 pfl->cfi_table[0x39] = 0x00;
743 pfl->cfi_table[0x3a] = 0x00;
745 pfl->cfi_table[0x3b] = 0x00;
746 pfl->cfi_table[0x3c] = 0x00;