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"
43 //#define PFLASH_DEBUG
45 #define DPRINTF(fmt, ...) \
47 printf("PFLASH: " fmt , ## __VA_ARGS__); \
50 #define DPRINTF(fmt, ...) do { } while (0)
55 target_phys_addr_t base
;
60 int wcycle
; /* if 0, the flash is read normally */
66 uint16_t unlock_addr
[2];
68 uint8_t cfi_table
[0x52];
76 static void pflash_register_memory(pflash_t
*pfl
, int rom_mode
)
78 unsigned long phys_offset
= pfl
->fl_mem
;
82 phys_offset
|= pfl
->off
| IO_MEM_ROMD
;
83 pfl
->rom_mode
= rom_mode
;
85 for (i
= 0; i
< pfl
->mappings
; i
++)
86 cpu_register_physical_memory(pfl
->base
+ i
* pfl
->chip_len
,
87 pfl
->chip_len
, phys_offset
);
90 static void pflash_timer (void *opaque
)
92 pflash_t
*pfl
= opaque
;
94 DPRINTF("%s: command %02x done\n", __func__
, pfl
->cmd
);
100 pflash_register_memory(pfl
, 1);
106 static uint32_t pflash_read (pflash_t
*pfl
, uint32_t offset
, int width
)
112 DPRINTF("%s: offset " TARGET_FMT_lx
"\n", __func__
, offset
);
115 /* Lazy reset of to ROMD mode */
116 if (pfl
->wcycle
== 0)
117 pflash_register_memory(pfl
, 1);
119 offset
&= pfl
->chip_len
- 1;
120 boff
= offset
& 0xFF;
123 else if (pfl
->width
== 4)
127 /* This should never happen : reset state & treat it as a read*/
128 DPRINTF("%s: unknown command state: %x\n", __func__
, pfl
->cmd
);
132 /* We accept reads during second unlock sequence... */
135 /* Flash area read */
140 // DPRINTF("%s: data offset %08x %02x\n", __func__, offset, ret);
143 #if defined(TARGET_WORDS_BIGENDIAN)
144 ret
= p
[offset
] << 8;
145 ret
|= p
[offset
+ 1];
148 ret
|= p
[offset
+ 1] << 8;
150 // DPRINTF("%s: data offset %08x %04x\n", __func__, offset, ret);
153 #if defined(TARGET_WORDS_BIGENDIAN)
154 ret
= p
[offset
] << 24;
155 ret
|= p
[offset
+ 1] << 16;
156 ret
|= p
[offset
+ 2] << 8;
157 ret
|= p
[offset
+ 3];
160 ret
|= p
[offset
+ 1] << 8;
161 ret
|= p
[offset
+ 2] << 16;
162 ret
|= p
[offset
+ 3] << 24;
164 // DPRINTF("%s: data offset %08x %08x\n", __func__, offset, ret);
173 ret
= pfl
->ident
[boff
& 0x01];
176 ret
= 0x00; /* Pretend all sectors are unprotected */
180 if (pfl
->ident
[2 + (boff
& 0x01)] == (uint8_t)-1)
182 ret
= pfl
->ident
[2 + (boff
& 0x01)];
187 DPRINTF("%s: ID " TARGET_FMT_ld
" %x\n", __func__
, boff
, ret
);
192 /* Status register read */
194 DPRINTF("%s: status %x\n", __func__
, ret
);
200 if (boff
> pfl
->cfi_len
)
203 ret
= pfl
->cfi_table
[boff
];
210 /* update flash content on disk */
211 static void pflash_update(pflash_t
*pfl
, int offset
,
216 offset_end
= offset
+ size
;
217 /* round to sectors */
218 offset
= offset
>> 9;
219 offset_end
= (offset_end
+ 511) >> 9;
220 bdrv_write(pfl
->bs
, offset
, pfl
->storage
+ (offset
<< 9),
221 offset_end
- offset
);
225 static void pflash_write (pflash_t
*pfl
, uint32_t offset
, uint32_t value
,
233 if (pfl
->cmd
!= 0xA0 && cmd
== 0xF0) {
235 DPRINTF("%s: flash reset asked (%02x %02x)\n",
236 __func__
, pfl
->cmd
, cmd
);
240 DPRINTF("%s: offset " TARGET_FMT_lx
" %08x %d %d\n", __func__
,
241 offset
, value
, width
, pfl
->wcycle
);
242 offset
&= pfl
->chip_len
- 1;
244 DPRINTF("%s: offset " TARGET_FMT_lx
" %08x %d\n", __func__
,
245 offset
, value
, width
);
246 boff
= offset
& (pfl
->sector_len
- 1);
249 else if (pfl
->width
== 4)
251 switch (pfl
->wcycle
) {
253 /* Set the device in I/O access mode if required */
255 pflash_register_memory(pfl
, 0);
256 /* We're in read mode */
258 if (boff
== 0x55 && cmd
== 0x98) {
260 /* Enter CFI query mode */
265 if (boff
!= pfl
->unlock_addr
[0] || cmd
!= 0xAA) {
266 DPRINTF("%s: unlock0 failed " TARGET_FMT_lx
" %02x %04x\n",
267 __func__
, boff
, cmd
, pfl
->unlock_addr
[0]);
270 DPRINTF("%s: unlock sequence started\n", __func__
);
273 /* We started an unlock sequence */
275 if (boff
!= pfl
->unlock_addr
[1] || cmd
!= 0x55) {
276 DPRINTF("%s: unlock1 failed " TARGET_FMT_lx
" %02x\n", __func__
,
280 DPRINTF("%s: unlock sequence done\n", __func__
);
283 /* We finished an unlock sequence */
284 if (!pfl
->bypass
&& boff
!= pfl
->unlock_addr
[0]) {
285 DPRINTF("%s: command failed " TARGET_FMT_lx
" %02x\n", __func__
,
297 DPRINTF("%s: starting command %02x\n", __func__
, cmd
);
300 DPRINTF("%s: unknown command %02x\n", __func__
, cmd
);
307 /* We need another unlock sequence */
310 DPRINTF("%s: write data offset " TARGET_FMT_lx
" %08x %d\n",
311 __func__
, offset
, value
, width
);
316 pflash_update(pfl
, offset
, 1);
319 #if defined(TARGET_WORDS_BIGENDIAN)
320 p
[offset
] &= value
>> 8;
321 p
[offset
+ 1] &= value
;
324 p
[offset
+ 1] &= value
>> 8;
326 pflash_update(pfl
, offset
, 2);
329 #if defined(TARGET_WORDS_BIGENDIAN)
330 p
[offset
] &= value
>> 24;
331 p
[offset
+ 1] &= value
>> 16;
332 p
[offset
+ 2] &= value
>> 8;
333 p
[offset
+ 3] &= value
;
336 p
[offset
+ 1] &= value
>> 8;
337 p
[offset
+ 2] &= value
>> 16;
338 p
[offset
+ 3] &= value
>> 24;
340 pflash_update(pfl
, offset
, 4);
343 pfl
->status
= 0x00 | ~(value
& 0x80);
344 /* Let's pretend write is immediate */
349 if (pfl
->bypass
&& cmd
== 0x00) {
350 /* Unlock bypass reset */
353 /* We can enter CFI query mode from autoselect mode */
354 if (boff
== 0x55 && cmd
== 0x98)
358 DPRINTF("%s: invalid write for command %02x\n",
365 /* Ignore writes while flash data write is occuring */
366 /* As we suppose write is immediate, this should never happen */
371 /* Should never happen */
372 DPRINTF("%s: invalid command state %02x (wc 4)\n",
380 if (boff
!= pfl
->unlock_addr
[0]) {
381 DPRINTF("%s: chip erase: invalid address " TARGET_FMT_lx
"\n",
386 DPRINTF("%s: start chip erase\n", __func__
);
387 memset(pfl
->storage
, 0xFF, pfl
->chip_len
);
389 pflash_update(pfl
, 0, pfl
->chip_len
);
390 /* Let's wait 5 seconds before chip erase is done */
391 qemu_mod_timer(pfl
->timer
,
392 qemu_get_clock(vm_clock
) + (ticks_per_sec
* 5));
397 offset
&= ~(pfl
->sector_len
- 1);
398 DPRINTF("%s: start sector erase at " TARGET_FMT_lx
"\n", __func__
,
400 memset(p
+ offset
, 0xFF, pfl
->sector_len
);
401 pflash_update(pfl
, offset
, pfl
->sector_len
);
403 /* Let's wait 1/2 second before sector erase is done */
404 qemu_mod_timer(pfl
->timer
,
405 qemu_get_clock(vm_clock
) + (ticks_per_sec
/ 2));
408 DPRINTF("%s: invalid command %02x (wc 5)\n", __func__
, cmd
);
416 /* Ignore writes during chip erase */
419 /* Ignore writes during sector erase */
422 /* Should never happen */
423 DPRINTF("%s: invalid command state %02x (wc 6)\n",
428 case 7: /* Special value for CFI queries */
429 DPRINTF("%s: invalid write in CFI query mode\n", __func__
);
432 /* Should never happen */
433 DPRINTF("%s: invalid write state (wc 7)\n", __func__
);
454 static uint32_t pflash_readb (void *opaque
, target_phys_addr_t addr
)
456 return pflash_read(opaque
, addr
, 1);
459 static uint32_t pflash_readw (void *opaque
, target_phys_addr_t addr
)
461 pflash_t
*pfl
= opaque
;
463 return pflash_read(pfl
, addr
, 2);
466 static uint32_t pflash_readl (void *opaque
, target_phys_addr_t addr
)
468 pflash_t
*pfl
= opaque
;
470 return pflash_read(pfl
, addr
, 4);
473 static void pflash_writeb (void *opaque
, target_phys_addr_t addr
,
476 pflash_write(opaque
, addr
, value
, 1);
479 static void pflash_writew (void *opaque
, target_phys_addr_t addr
,
482 pflash_t
*pfl
= opaque
;
484 pflash_write(pfl
, addr
, value
, 2);
487 static void pflash_writel (void *opaque
, target_phys_addr_t addr
,
490 pflash_t
*pfl
= opaque
;
492 pflash_write(pfl
, addr
, value
, 4);
495 static CPUWriteMemoryFunc
* const pflash_write_ops
[] = {
501 static CPUReadMemoryFunc
* const pflash_read_ops
[] = {
507 /* Count trailing zeroes of a 32 bits quantity */
508 static int ctz32 (uint32_t n
)
533 #if 0 /* This is not necessary as n is never 0 */
541 pflash_t
*pflash_cfi02_register(target_phys_addr_t base
, ram_addr_t off
,
542 BlockDriverState
*bs
, uint32_t sector_len
,
543 int nb_blocs
, int nb_mappings
, int width
,
544 uint16_t id0
, uint16_t id1
,
545 uint16_t id2
, uint16_t id3
,
546 uint16_t unlock_addr0
, uint16_t unlock_addr1
)
551 chip_len
= sector_len
* nb_blocs
;
552 /* XXX: to be fixed */
554 if (total_len
!= (8 * 1024 * 1024) && total_len
!= (16 * 1024 * 1024) &&
555 total_len
!= (32 * 1024 * 1024) && total_len
!= (64 * 1024 * 1024))
558 pfl
= qemu_mallocz(sizeof(pflash_t
));
559 /* FIXME: Allocate ram ourselves. */
560 pfl
->storage
= qemu_get_ram_ptr(off
);
561 pfl
->fl_mem
= cpu_register_io_memory(pflash_read_ops
, pflash_write_ops
,
565 pfl
->chip_len
= chip_len
;
566 pfl
->mappings
= nb_mappings
;
567 pflash_register_memory(pfl
, 1);
570 /* read the initial flash content */
571 bdrv_read(pfl
->bs
, 0, pfl
->storage
, chip_len
>> 9);
573 #if 0 /* XXX: there should be a bit to set up read-only,
574 * the same way the hardware does (with WP pin).
580 pfl
->timer
= qemu_new_timer(vm_clock
, pflash_timer
, pfl
);
581 pfl
->sector_len
= sector_len
;
590 pfl
->unlock_addr
[0] = unlock_addr0
;
591 pfl
->unlock_addr
[1] = unlock_addr1
;
592 /* Hardcoded CFI table (mostly from SG29 Spansion flash) */
594 /* Standard "QRY" string */
595 pfl
->cfi_table
[0x10] = 'Q';
596 pfl
->cfi_table
[0x11] = 'R';
597 pfl
->cfi_table
[0x12] = 'Y';
598 /* Command set (AMD/Fujitsu) */
599 pfl
->cfi_table
[0x13] = 0x02;
600 pfl
->cfi_table
[0x14] = 0x00;
601 /* Primary extended table address */
602 pfl
->cfi_table
[0x15] = 0x31;
603 pfl
->cfi_table
[0x16] = 0x00;
604 /* Alternate command set (none) */
605 pfl
->cfi_table
[0x17] = 0x00;
606 pfl
->cfi_table
[0x18] = 0x00;
607 /* Alternate extended table (none) */
608 pfl
->cfi_table
[0x19] = 0x00;
609 pfl
->cfi_table
[0x1A] = 0x00;
611 pfl
->cfi_table
[0x1B] = 0x27;
613 pfl
->cfi_table
[0x1C] = 0x36;
614 /* Vpp min (no Vpp pin) */
615 pfl
->cfi_table
[0x1D] = 0x00;
616 /* Vpp max (no Vpp pin) */
617 pfl
->cfi_table
[0x1E] = 0x00;
619 pfl
->cfi_table
[0x1F] = 0x07;
620 /* Timeout for min size buffer write (NA) */
621 pfl
->cfi_table
[0x20] = 0x00;
622 /* Typical timeout for block erase (512 ms) */
623 pfl
->cfi_table
[0x21] = 0x09;
624 /* Typical timeout for full chip erase (4096 ms) */
625 pfl
->cfi_table
[0x22] = 0x0C;
627 pfl
->cfi_table
[0x23] = 0x01;
628 /* Max timeout for buffer write (NA) */
629 pfl
->cfi_table
[0x24] = 0x00;
630 /* Max timeout for block erase */
631 pfl
->cfi_table
[0x25] = 0x0A;
632 /* Max timeout for chip erase */
633 pfl
->cfi_table
[0x26] = 0x0D;
635 pfl
->cfi_table
[0x27] = ctz32(chip_len
);
636 /* Flash device interface (8 & 16 bits) */
637 pfl
->cfi_table
[0x28] = 0x02;
638 pfl
->cfi_table
[0x29] = 0x00;
639 /* Max number of bytes in multi-bytes write */
640 /* XXX: disable buffered write as it's not supported */
641 // pfl->cfi_table[0x2A] = 0x05;
642 pfl
->cfi_table
[0x2A] = 0x00;
643 pfl
->cfi_table
[0x2B] = 0x00;
644 /* Number of erase block regions (uniform) */
645 pfl
->cfi_table
[0x2C] = 0x01;
646 /* Erase block region 1 */
647 pfl
->cfi_table
[0x2D] = nb_blocs
- 1;
648 pfl
->cfi_table
[0x2E] = (nb_blocs
- 1) >> 8;
649 pfl
->cfi_table
[0x2F] = sector_len
>> 8;
650 pfl
->cfi_table
[0x30] = sector_len
>> 16;
653 pfl
->cfi_table
[0x31] = 'P';
654 pfl
->cfi_table
[0x32] = 'R';
655 pfl
->cfi_table
[0x33] = 'I';
657 pfl
->cfi_table
[0x34] = '1';
658 pfl
->cfi_table
[0x35] = '0';
660 pfl
->cfi_table
[0x36] = 0x00;
661 pfl
->cfi_table
[0x37] = 0x00;
662 pfl
->cfi_table
[0x38] = 0x00;
663 pfl
->cfi_table
[0x39] = 0x00;
665 pfl
->cfi_table
[0x3a] = 0x00;
667 pfl
->cfi_table
[0x3b] = 0x00;
668 pfl
->cfi_table
[0x3c] = 0x00;