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
59 target_phys_addr_t base
;
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 target_phys_addr_t 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
, target_phys_addr_t offset
,
128 target_phys_addr_t boff
;
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
, target_phys_addr_t offset
,
246 uint32_t value
, int width
, int be
)
248 target_phys_addr_t boff
;
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__
);
481 static uint32_t pflash_readb_be(void *opaque
, target_phys_addr_t addr
)
483 return pflash_read(opaque
, addr
, 1, 1);
486 static uint32_t pflash_readb_le(void *opaque
, target_phys_addr_t addr
)
488 return pflash_read(opaque
, addr
, 1, 0);
491 static uint32_t pflash_readw_be(void *opaque
, target_phys_addr_t addr
)
493 pflash_t
*pfl
= opaque
;
495 return pflash_read(pfl
, addr
, 2, 1);
498 static uint32_t pflash_readw_le(void *opaque
, target_phys_addr_t addr
)
500 pflash_t
*pfl
= opaque
;
502 return pflash_read(pfl
, addr
, 2, 0);
505 static uint32_t pflash_readl_be(void *opaque
, target_phys_addr_t addr
)
507 pflash_t
*pfl
= opaque
;
509 return pflash_read(pfl
, addr
, 4, 1);
512 static uint32_t pflash_readl_le(void *opaque
, target_phys_addr_t addr
)
514 pflash_t
*pfl
= opaque
;
516 return pflash_read(pfl
, addr
, 4, 0);
519 static void pflash_writeb_be(void *opaque
, target_phys_addr_t addr
,
522 pflash_write(opaque
, addr
, value
, 1, 1);
525 static void pflash_writeb_le(void *opaque
, target_phys_addr_t addr
,
528 pflash_write(opaque
, addr
, value
, 1, 0);
531 static void pflash_writew_be(void *opaque
, target_phys_addr_t addr
,
534 pflash_t
*pfl
= opaque
;
536 pflash_write(pfl
, addr
, value
, 2, 1);
539 static void pflash_writew_le(void *opaque
, target_phys_addr_t addr
,
542 pflash_t
*pfl
= opaque
;
544 pflash_write(pfl
, addr
, value
, 2, 0);
547 static void pflash_writel_be(void *opaque
, target_phys_addr_t addr
,
550 pflash_t
*pfl
= opaque
;
552 pflash_write(pfl
, addr
, value
, 4, 1);
555 static void pflash_writel_le(void *opaque
, target_phys_addr_t addr
,
558 pflash_t
*pfl
= opaque
;
560 pflash_write(pfl
, addr
, value
, 4, 0);
563 static const MemoryRegionOps pflash_cfi02_ops_be
= {
565 .read
= { pflash_readb_be
, pflash_readw_be
, pflash_readl_be
, },
566 .write
= { pflash_writeb_be
, pflash_writew_be
, pflash_writel_be
, },
568 .endianness
= DEVICE_NATIVE_ENDIAN
,
571 static const MemoryRegionOps pflash_cfi02_ops_le
= {
573 .read
= { pflash_readb_le
, pflash_readw_le
, pflash_readl_le
, },
574 .write
= { pflash_writeb_le
, pflash_writew_le
, pflash_writel_le
, },
576 .endianness
= DEVICE_NATIVE_ENDIAN
,
579 pflash_t
*pflash_cfi02_register(target_phys_addr_t base
,
580 DeviceState
*qdev
, const char *name
,
581 target_phys_addr_t size
,
582 BlockDriverState
*bs
, uint32_t sector_len
,
583 int nb_blocs
, int nb_mappings
, int width
,
584 uint16_t id0
, uint16_t id1
,
585 uint16_t id2
, uint16_t id3
,
586 uint16_t unlock_addr0
, uint16_t unlock_addr1
,
593 chip_len
= sector_len
* nb_blocs
;
594 /* XXX: to be fixed */
596 if (total_len
!= (8 * 1024 * 1024) && total_len
!= (16 * 1024 * 1024) &&
597 total_len
!= (32 * 1024 * 1024) && total_len
!= (64 * 1024 * 1024))
600 pfl
= g_malloc0(sizeof(pflash_t
));
601 memory_region_init_rom_device(
602 &pfl
->orig_mem
, be
? &pflash_cfi02_ops_be
: &pflash_cfi02_ops_le
, pfl
,
604 vmstate_register_ram(&pfl
->orig_mem
, qdev
);
605 pfl
->storage
= memory_region_get_ram_ptr(&pfl
->orig_mem
);
607 pfl
->chip_len
= chip_len
;
608 pfl
->mappings
= nb_mappings
;
611 /* read the initial flash content */
612 ret
= bdrv_read(pfl
->bs
, 0, pfl
->storage
, chip_len
>> 9);
617 bdrv_attach_dev_nofail(pfl
->bs
, pfl
);
620 pflash_setup_mappings(pfl
);
622 memory_region_add_subregion(get_system_memory(), pfl
->base
, &pfl
->mem
);
625 pfl
->ro
= bdrv_is_read_only(pfl
->bs
);
630 pfl
->timer
= qemu_new_timer_ns(vm_clock
, pflash_timer
, pfl
);
631 pfl
->sector_len
= sector_len
;
640 pfl
->unlock_addr
[0] = unlock_addr0
;
641 pfl
->unlock_addr
[1] = unlock_addr1
;
642 /* Hardcoded CFI table (mostly from SG29 Spansion flash) */
644 /* Standard "QRY" string */
645 pfl
->cfi_table
[0x10] = 'Q';
646 pfl
->cfi_table
[0x11] = 'R';
647 pfl
->cfi_table
[0x12] = 'Y';
648 /* Command set (AMD/Fujitsu) */
649 pfl
->cfi_table
[0x13] = 0x02;
650 pfl
->cfi_table
[0x14] = 0x00;
651 /* Primary extended table address */
652 pfl
->cfi_table
[0x15] = 0x31;
653 pfl
->cfi_table
[0x16] = 0x00;
654 /* Alternate command set (none) */
655 pfl
->cfi_table
[0x17] = 0x00;
656 pfl
->cfi_table
[0x18] = 0x00;
657 /* Alternate extended table (none) */
658 pfl
->cfi_table
[0x19] = 0x00;
659 pfl
->cfi_table
[0x1A] = 0x00;
661 pfl
->cfi_table
[0x1B] = 0x27;
663 pfl
->cfi_table
[0x1C] = 0x36;
664 /* Vpp min (no Vpp pin) */
665 pfl
->cfi_table
[0x1D] = 0x00;
666 /* Vpp max (no Vpp pin) */
667 pfl
->cfi_table
[0x1E] = 0x00;
669 pfl
->cfi_table
[0x1F] = 0x07;
670 /* Timeout for min size buffer write (NA) */
671 pfl
->cfi_table
[0x20] = 0x00;
672 /* Typical timeout for block erase (512 ms) */
673 pfl
->cfi_table
[0x21] = 0x09;
674 /* Typical timeout for full chip erase (4096 ms) */
675 pfl
->cfi_table
[0x22] = 0x0C;
677 pfl
->cfi_table
[0x23] = 0x01;
678 /* Max timeout for buffer write (NA) */
679 pfl
->cfi_table
[0x24] = 0x00;
680 /* Max timeout for block erase */
681 pfl
->cfi_table
[0x25] = 0x0A;
682 /* Max timeout for chip erase */
683 pfl
->cfi_table
[0x26] = 0x0D;
685 pfl
->cfi_table
[0x27] = ctz32(chip_len
);
686 /* Flash device interface (8 & 16 bits) */
687 pfl
->cfi_table
[0x28] = 0x02;
688 pfl
->cfi_table
[0x29] = 0x00;
689 /* Max number of bytes in multi-bytes write */
690 /* XXX: disable buffered write as it's not supported */
691 // pfl->cfi_table[0x2A] = 0x05;
692 pfl
->cfi_table
[0x2A] = 0x00;
693 pfl
->cfi_table
[0x2B] = 0x00;
694 /* Number of erase block regions (uniform) */
695 pfl
->cfi_table
[0x2C] = 0x01;
696 /* Erase block region 1 */
697 pfl
->cfi_table
[0x2D] = nb_blocs
- 1;
698 pfl
->cfi_table
[0x2E] = (nb_blocs
- 1) >> 8;
699 pfl
->cfi_table
[0x2F] = sector_len
>> 8;
700 pfl
->cfi_table
[0x30] = sector_len
>> 16;
703 pfl
->cfi_table
[0x31] = 'P';
704 pfl
->cfi_table
[0x32] = 'R';
705 pfl
->cfi_table
[0x33] = 'I';
707 pfl
->cfi_table
[0x34] = '1';
708 pfl
->cfi_table
[0x35] = '0';
710 pfl
->cfi_table
[0x36] = 0x00;
711 pfl
->cfi_table
[0x37] = 0x00;
712 pfl
->cfi_table
[0x38] = 0x00;
713 pfl
->cfi_table
[0x39] = 0x00;
715 pfl
->cfi_table
[0x3a] = 0x00;
717 pfl
->cfi_table
[0x3b] = 0x00;
718 pfl
->cfi_table
[0x3c] = 0x00;