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
);
107 static void pflash_timer (void *opaque
)
109 pflash_t
*pfl
= opaque
;
111 DPRINTF("%s: command %02x done\n", __func__
, pfl
->cmd
);
117 pflash_register_memory(pfl
, 1);
123 static uint32_t pflash_read (pflash_t
*pfl
, target_phys_addr_t offset
,
126 target_phys_addr_t boff
;
130 DPRINTF("%s: offset " TARGET_FMT_plx
"\n", __func__
, offset
);
132 /* Lazy reset to ROMD mode after a certain amount of read accesses */
133 if (!pfl
->rom_mode
&& pfl
->wcycle
== 0 &&
134 ++pfl
->read_counter
> PFLASH_LAZY_ROMD_THRESHOLD
) {
135 pflash_register_memory(pfl
, 1);
137 offset
&= pfl
->chip_len
- 1;
138 boff
= offset
& 0xFF;
141 else if (pfl
->width
== 4)
145 /* This should never happen : reset state & treat it as a read*/
146 DPRINTF("%s: unknown command state: %x\n", __func__
, pfl
->cmd
);
150 /* We accept reads during second unlock sequence... */
153 /* Flash area read */
158 // DPRINTF("%s: data offset %08x %02x\n", __func__, offset, ret);
162 ret
= p
[offset
] << 8;
163 ret
|= p
[offset
+ 1];
166 ret
|= p
[offset
+ 1] << 8;
168 // DPRINTF("%s: data offset %08x %04x\n", __func__, offset, ret);
172 ret
= p
[offset
] << 24;
173 ret
|= p
[offset
+ 1] << 16;
174 ret
|= p
[offset
+ 2] << 8;
175 ret
|= p
[offset
+ 3];
178 ret
|= p
[offset
+ 1] << 8;
179 ret
|= p
[offset
+ 2] << 16;
180 ret
|= p
[offset
+ 3] << 24;
182 // DPRINTF("%s: data offset %08x %08x\n", __func__, offset, ret);
191 ret
= pfl
->ident
[boff
& 0x01];
194 ret
= 0x00; /* Pretend all sectors are unprotected */
198 if (pfl
->ident
[2 + (boff
& 0x01)] == (uint8_t)-1)
200 ret
= pfl
->ident
[2 + (boff
& 0x01)];
205 DPRINTF("%s: ID " TARGET_FMT_plx
" %x\n", __func__
, boff
, ret
);
210 /* Status register read */
212 DPRINTF("%s: status %x\n", __func__
, ret
);
218 if (boff
> pfl
->cfi_len
)
221 ret
= pfl
->cfi_table
[boff
];
228 /* update flash content on disk */
229 static void pflash_update(pflash_t
*pfl
, int offset
,
234 offset_end
= offset
+ size
;
235 /* round to sectors */
236 offset
= offset
>> 9;
237 offset_end
= (offset_end
+ 511) >> 9;
238 bdrv_write(pfl
->bs
, offset
, pfl
->storage
+ (offset
<< 9),
239 offset_end
- offset
);
243 static void pflash_write (pflash_t
*pfl
, target_phys_addr_t offset
,
244 uint32_t value
, int width
, int be
)
246 target_phys_addr_t boff
;
251 if (pfl
->cmd
!= 0xA0 && cmd
== 0xF0) {
253 DPRINTF("%s: flash reset asked (%02x %02x)\n",
254 __func__
, pfl
->cmd
, cmd
);
258 DPRINTF("%s: offset " TARGET_FMT_plx
" %08x %d %d\n", __func__
,
259 offset
, value
, width
, pfl
->wcycle
);
260 offset
&= pfl
->chip_len
- 1;
262 DPRINTF("%s: offset " TARGET_FMT_plx
" %08x %d\n", __func__
,
263 offset
, value
, width
);
264 boff
= offset
& (pfl
->sector_len
- 1);
267 else if (pfl
->width
== 4)
269 switch (pfl
->wcycle
) {
271 /* Set the device in I/O access mode if required */
273 pflash_register_memory(pfl
, 0);
274 pfl
->read_counter
= 0;
275 /* We're in read mode */
277 if (boff
== 0x55 && cmd
== 0x98) {
279 /* Enter CFI query mode */
284 if (boff
!= pfl
->unlock_addr
[0] || cmd
!= 0xAA) {
285 DPRINTF("%s: unlock0 failed " TARGET_FMT_plx
" %02x %04x\n",
286 __func__
, boff
, cmd
, pfl
->unlock_addr
[0]);
289 DPRINTF("%s: unlock sequence started\n", __func__
);
292 /* We started an unlock sequence */
294 if (boff
!= pfl
->unlock_addr
[1] || cmd
!= 0x55) {
295 DPRINTF("%s: unlock1 failed " TARGET_FMT_plx
" %02x\n", __func__
,
299 DPRINTF("%s: unlock sequence done\n", __func__
);
302 /* We finished an unlock sequence */
303 if (!pfl
->bypass
&& boff
!= pfl
->unlock_addr
[0]) {
304 DPRINTF("%s: command failed " TARGET_FMT_plx
" %02x\n", __func__
,
316 DPRINTF("%s: starting command %02x\n", __func__
, cmd
);
319 DPRINTF("%s: unknown command %02x\n", __func__
, cmd
);
326 /* We need another unlock sequence */
329 DPRINTF("%s: write data offset " TARGET_FMT_plx
" %08x %d\n",
330 __func__
, offset
, value
, width
);
335 pflash_update(pfl
, offset
, 1);
339 p
[offset
] &= value
>> 8;
340 p
[offset
+ 1] &= value
;
343 p
[offset
+ 1] &= value
>> 8;
345 pflash_update(pfl
, offset
, 2);
349 p
[offset
] &= value
>> 24;
350 p
[offset
+ 1] &= value
>> 16;
351 p
[offset
+ 2] &= value
>> 8;
352 p
[offset
+ 3] &= value
;
355 p
[offset
+ 1] &= value
>> 8;
356 p
[offset
+ 2] &= value
>> 16;
357 p
[offset
+ 3] &= value
>> 24;
359 pflash_update(pfl
, offset
, 4);
362 pfl
->status
= 0x00 | ~(value
& 0x80);
363 /* Let's pretend write is immediate */
368 if (pfl
->bypass
&& cmd
== 0x00) {
369 /* Unlock bypass reset */
372 /* We can enter CFI query mode from autoselect mode */
373 if (boff
== 0x55 && cmd
== 0x98)
377 DPRINTF("%s: invalid write for command %02x\n",
384 /* Ignore writes while flash data write is occurring */
385 /* As we suppose write is immediate, this should never happen */
390 /* Should never happen */
391 DPRINTF("%s: invalid command state %02x (wc 4)\n",
399 if (boff
!= pfl
->unlock_addr
[0]) {
400 DPRINTF("%s: chip erase: invalid address " TARGET_FMT_plx
"\n",
405 DPRINTF("%s: start chip erase\n", __func__
);
406 memset(pfl
->storage
, 0xFF, pfl
->chip_len
);
408 pflash_update(pfl
, 0, pfl
->chip_len
);
409 /* Let's wait 5 seconds before chip erase is done */
410 qemu_mod_timer(pfl
->timer
,
411 qemu_get_clock_ns(vm_clock
) + (get_ticks_per_sec() * 5));
416 offset
&= ~(pfl
->sector_len
- 1);
417 DPRINTF("%s: start sector erase at " TARGET_FMT_plx
"\n", __func__
,
419 memset(p
+ offset
, 0xFF, pfl
->sector_len
);
420 pflash_update(pfl
, offset
, pfl
->sector_len
);
422 /* Let's wait 1/2 second before sector erase is done */
423 qemu_mod_timer(pfl
->timer
,
424 qemu_get_clock_ns(vm_clock
) + (get_ticks_per_sec() / 2));
427 DPRINTF("%s: invalid command %02x (wc 5)\n", __func__
, cmd
);
435 /* Ignore writes during chip erase */
438 /* Ignore writes during sector erase */
441 /* Should never happen */
442 DPRINTF("%s: invalid command state %02x (wc 6)\n",
447 case 7: /* Special value for CFI queries */
448 DPRINTF("%s: invalid write in CFI query mode\n", __func__
);
451 /* Should never happen */
452 DPRINTF("%s: invalid write state (wc 7)\n", __func__
);
473 static uint32_t pflash_readb_be(void *opaque
, target_phys_addr_t addr
)
475 return pflash_read(opaque
, addr
, 1, 1);
478 static uint32_t pflash_readb_le(void *opaque
, target_phys_addr_t addr
)
480 return pflash_read(opaque
, addr
, 1, 0);
483 static uint32_t pflash_readw_be(void *opaque
, target_phys_addr_t addr
)
485 pflash_t
*pfl
= opaque
;
487 return pflash_read(pfl
, addr
, 2, 1);
490 static uint32_t pflash_readw_le(void *opaque
, target_phys_addr_t addr
)
492 pflash_t
*pfl
= opaque
;
494 return pflash_read(pfl
, addr
, 2, 0);
497 static uint32_t pflash_readl_be(void *opaque
, target_phys_addr_t addr
)
499 pflash_t
*pfl
= opaque
;
501 return pflash_read(pfl
, addr
, 4, 1);
504 static uint32_t pflash_readl_le(void *opaque
, target_phys_addr_t addr
)
506 pflash_t
*pfl
= opaque
;
508 return pflash_read(pfl
, addr
, 4, 0);
511 static void pflash_writeb_be(void *opaque
, target_phys_addr_t addr
,
514 pflash_write(opaque
, addr
, value
, 1, 1);
517 static void pflash_writeb_le(void *opaque
, target_phys_addr_t addr
,
520 pflash_write(opaque
, addr
, value
, 1, 0);
523 static void pflash_writew_be(void *opaque
, target_phys_addr_t addr
,
526 pflash_t
*pfl
= opaque
;
528 pflash_write(pfl
, addr
, value
, 2, 1);
531 static void pflash_writew_le(void *opaque
, target_phys_addr_t addr
,
534 pflash_t
*pfl
= opaque
;
536 pflash_write(pfl
, addr
, value
, 2, 0);
539 static void pflash_writel_be(void *opaque
, target_phys_addr_t addr
,
542 pflash_t
*pfl
= opaque
;
544 pflash_write(pfl
, addr
, value
, 4, 1);
547 static void pflash_writel_le(void *opaque
, target_phys_addr_t addr
,
550 pflash_t
*pfl
= opaque
;
552 pflash_write(pfl
, addr
, value
, 4, 0);
555 static const MemoryRegionOps pflash_cfi02_ops_be
= {
557 .read
= { pflash_readb_be
, pflash_readw_be
, pflash_readl_be
, },
558 .write
= { pflash_writeb_be
, pflash_writew_be
, pflash_writel_be
, },
560 .endianness
= DEVICE_NATIVE_ENDIAN
,
563 static const MemoryRegionOps pflash_cfi02_ops_le
= {
565 .read
= { pflash_readb_le
, pflash_readw_le
, pflash_readl_le
, },
566 .write
= { pflash_writeb_le
, pflash_writew_le
, pflash_writel_le
, },
568 .endianness
= DEVICE_NATIVE_ENDIAN
,
571 /* Count trailing zeroes of a 32 bits quantity */
572 static int ctz32 (uint32_t n
)
595 #if 0 /* This is not necessary as n is never 0 */
599 #if 0 /* This is not necessary as n is never 0 */
607 pflash_t
*pflash_cfi02_register(target_phys_addr_t base
,
608 DeviceState
*qdev
, const char *name
,
609 target_phys_addr_t size
,
610 BlockDriverState
*bs
, uint32_t sector_len
,
611 int nb_blocs
, int nb_mappings
, int width
,
612 uint16_t id0
, uint16_t id1
,
613 uint16_t id2
, uint16_t id3
,
614 uint16_t unlock_addr0
, uint16_t unlock_addr1
,
621 chip_len
= sector_len
* nb_blocs
;
622 /* XXX: to be fixed */
624 if (total_len
!= (8 * 1024 * 1024) && total_len
!= (16 * 1024 * 1024) &&
625 total_len
!= (32 * 1024 * 1024) && total_len
!= (64 * 1024 * 1024))
628 pfl
= g_malloc0(sizeof(pflash_t
));
629 memory_region_init_rom_device(
630 &pfl
->orig_mem
, be
? &pflash_cfi02_ops_be
: &pflash_cfi02_ops_le
, pfl
,
632 vmstate_register_ram(&pfl
->orig_mem
, qdev
);
633 pfl
->storage
= memory_region_get_ram_ptr(&pfl
->orig_mem
);
635 pfl
->chip_len
= chip_len
;
636 pfl
->mappings
= nb_mappings
;
639 /* read the initial flash content */
640 ret
= bdrv_read(pfl
->bs
, 0, pfl
->storage
, chip_len
>> 9);
645 bdrv_attach_dev_nofail(pfl
->bs
, pfl
);
647 pflash_setup_mappings(pfl
);
649 memory_region_add_subregion(get_system_memory(), pfl
->base
, &pfl
->mem
);
650 #if 0 /* XXX: there should be a bit to set up read-only,
651 * the same way the hardware does (with WP pin).
657 pfl
->timer
= qemu_new_timer_ns(vm_clock
, pflash_timer
, pfl
);
658 pfl
->sector_len
= sector_len
;
667 pfl
->unlock_addr
[0] = unlock_addr0
;
668 pfl
->unlock_addr
[1] = unlock_addr1
;
669 /* Hardcoded CFI table (mostly from SG29 Spansion flash) */
671 /* Standard "QRY" string */
672 pfl
->cfi_table
[0x10] = 'Q';
673 pfl
->cfi_table
[0x11] = 'R';
674 pfl
->cfi_table
[0x12] = 'Y';
675 /* Command set (AMD/Fujitsu) */
676 pfl
->cfi_table
[0x13] = 0x02;
677 pfl
->cfi_table
[0x14] = 0x00;
678 /* Primary extended table address */
679 pfl
->cfi_table
[0x15] = 0x31;
680 pfl
->cfi_table
[0x16] = 0x00;
681 /* Alternate command set (none) */
682 pfl
->cfi_table
[0x17] = 0x00;
683 pfl
->cfi_table
[0x18] = 0x00;
684 /* Alternate extended table (none) */
685 pfl
->cfi_table
[0x19] = 0x00;
686 pfl
->cfi_table
[0x1A] = 0x00;
688 pfl
->cfi_table
[0x1B] = 0x27;
690 pfl
->cfi_table
[0x1C] = 0x36;
691 /* Vpp min (no Vpp pin) */
692 pfl
->cfi_table
[0x1D] = 0x00;
693 /* Vpp max (no Vpp pin) */
694 pfl
->cfi_table
[0x1E] = 0x00;
696 pfl
->cfi_table
[0x1F] = 0x07;
697 /* Timeout for min size buffer write (NA) */
698 pfl
->cfi_table
[0x20] = 0x00;
699 /* Typical timeout for block erase (512 ms) */
700 pfl
->cfi_table
[0x21] = 0x09;
701 /* Typical timeout for full chip erase (4096 ms) */
702 pfl
->cfi_table
[0x22] = 0x0C;
704 pfl
->cfi_table
[0x23] = 0x01;
705 /* Max timeout for buffer write (NA) */
706 pfl
->cfi_table
[0x24] = 0x00;
707 /* Max timeout for block erase */
708 pfl
->cfi_table
[0x25] = 0x0A;
709 /* Max timeout for chip erase */
710 pfl
->cfi_table
[0x26] = 0x0D;
712 pfl
->cfi_table
[0x27] = ctz32(chip_len
);
713 /* Flash device interface (8 & 16 bits) */
714 pfl
->cfi_table
[0x28] = 0x02;
715 pfl
->cfi_table
[0x29] = 0x00;
716 /* Max number of bytes in multi-bytes write */
717 /* XXX: disable buffered write as it's not supported */
718 // pfl->cfi_table[0x2A] = 0x05;
719 pfl
->cfi_table
[0x2A] = 0x00;
720 pfl
->cfi_table
[0x2B] = 0x00;
721 /* Number of erase block regions (uniform) */
722 pfl
->cfi_table
[0x2C] = 0x01;
723 /* Erase block region 1 */
724 pfl
->cfi_table
[0x2D] = nb_blocs
- 1;
725 pfl
->cfi_table
[0x2E] = (nb_blocs
- 1) >> 8;
726 pfl
->cfi_table
[0x2F] = sector_len
>> 8;
727 pfl
->cfi_table
[0x30] = sector_len
>> 16;
730 pfl
->cfi_table
[0x31] = 'P';
731 pfl
->cfi_table
[0x32] = 'R';
732 pfl
->cfi_table
[0x33] = 'I';
734 pfl
->cfi_table
[0x34] = '1';
735 pfl
->cfi_table
[0x35] = '0';
737 pfl
->cfi_table
[0x36] = 0x00;
738 pfl
->cfi_table
[0x37] = 0x00;
739 pfl
->cfi_table
[0x38] = 0x00;
740 pfl
->cfi_table
[0x39] = 0x00;
742 pfl
->cfi_table
[0x3a] = 0x00;
744 pfl
->cfi_table
[0x3b] = 0x00;
745 pfl
->cfi_table
[0x3c] = 0x00;