2 * CFI parallel flash with Intel command set emulation
4 * Copyright (c) 2006 Thorsten Zitterell
5 * Copyright (c) 2005 Jocelyn Mayer
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
22 * For now, this code can emulate flashes of 1, 2 or 4 bytes width.
23 * Supported commands/modes are:
30 * It does not support timings
31 * It does not support flash interleaving
32 * It does not implement software data protection as found in many real chips
33 * It does not implement erase suspend/resume commands
34 * It does not implement multiple sectors erase
36 * It does not implement much more ...
42 #include "qemu-timer.h"
44 #define PFLASH_BUG(fmt, ...) \
46 printf("PFLASH: Possible BUG - " fmt, ## __VA_ARGS__); \
50 /* #define PFLASH_DEBUG */
52 #define DPRINTF(fmt, ...) \
54 printf("PFLASH: " fmt , ## __VA_ARGS__); \
57 #define DPRINTF(fmt, ...) do { } while (0)
62 target_phys_addr_t base
;
63 target_phys_addr_t sector_len
;
64 target_phys_addr_t total_len
;
66 int wcycle
; /* if 0, the flash is read normally */
73 uint8_t cfi_table
[0x52];
74 target_phys_addr_t counter
;
75 unsigned int writeblock_size
;
82 static void pflash_timer (void *opaque
)
84 pflash_t
*pfl
= opaque
;
86 DPRINTF("%s: command %02x done\n", __func__
, pfl
->cmd
);
92 cpu_register_physical_memory(pfl
->base
, pfl
->total_len
,
93 pfl
->off
| IO_MEM_ROMD
| pfl
->fl_mem
);
99 static uint32_t pflash_read (pflash_t
*pfl
, target_phys_addr_t offset
,
102 target_phys_addr_t boff
;
107 boff
= offset
& 0xFF; /* why this here ?? */
111 else if (pfl
->width
== 4)
115 DPRINTF("%s: reading offset " TARGET_FMT_plx
" under cmd %02x width %d\n",
116 __func__
, offset
, pfl
->cmd
, width
);
120 /* Flash area read */
125 DPRINTF("%s: data offset " TARGET_FMT_plx
" %02x\n",
126 __func__
, offset
, ret
);
130 ret
= p
[offset
] << 8;
131 ret
|= p
[offset
+ 1];
134 ret
|= p
[offset
+ 1] << 8;
136 DPRINTF("%s: data offset " TARGET_FMT_plx
" %04x\n",
137 __func__
, offset
, ret
);
141 ret
= p
[offset
] << 24;
142 ret
|= p
[offset
+ 1] << 16;
143 ret
|= p
[offset
+ 2] << 8;
144 ret
|= p
[offset
+ 3];
147 ret
|= p
[offset
+ 1] << 8;
148 ret
|= p
[offset
+ 1] << 8;
149 ret
|= p
[offset
+ 2] << 16;
150 ret
|= p
[offset
+ 3] << 24;
152 DPRINTF("%s: data offset " TARGET_FMT_plx
" %08x\n",
153 __func__
, offset
, ret
);
156 DPRINTF("BUG in %s\n", __func__
);
160 case 0x20: /* Block erase */
161 case 0x50: /* Clear status register */
162 case 0x60: /* Block /un)lock */
163 case 0x70: /* Status Register */
164 case 0xe8: /* Write block */
165 /* Status register read */
167 DPRINTF("%s: status %x\n", __func__
, ret
);
172 ret
= pfl
->ident
[0] << 8 | pfl
->ident
[1];
173 DPRINTF("%s: Manufacturer Code %04x\n", __func__
, ret
);
176 ret
= pfl
->ident
[2] << 8 | pfl
->ident
[3];
177 DPRINTF("%s: Device ID Code %04x\n", __func__
, ret
);
180 DPRINTF("%s: Read Device Information boff=%x\n", __func__
, boff
);
185 case 0x98: /* Query mode */
186 if (boff
> pfl
->cfi_len
)
189 ret
= pfl
->cfi_table
[boff
];
192 /* This should never happen : reset state & treat it as a read */
193 DPRINTF("%s: unknown command state: %x\n", __func__
, pfl
->cmd
);
200 /* update flash content on disk */
201 static void pflash_update(pflash_t
*pfl
, int offset
,
206 offset_end
= offset
+ size
;
207 /* round to sectors */
208 offset
= offset
>> 9;
209 offset_end
= (offset_end
+ 511) >> 9;
210 bdrv_write(pfl
->bs
, offset
, pfl
->storage
+ (offset
<< 9),
211 offset_end
- offset
);
215 static inline void pflash_data_write(pflash_t
*pfl
, target_phys_addr_t offset
,
216 uint32_t value
, int width
, int be
)
218 uint8_t *p
= pfl
->storage
;
220 DPRINTF("%s: block write offset " TARGET_FMT_plx
221 " value %x counter " TARGET_FMT_plx
"\n",
222 __func__
, offset
, value
, pfl
->counter
);
229 p
[offset
] = value
>> 8;
230 p
[offset
+ 1] = value
;
233 p
[offset
+ 1] = value
>> 8;
238 p
[offset
] = value
>> 24;
239 p
[offset
+ 1] = value
>> 16;
240 p
[offset
+ 2] = value
>> 8;
241 p
[offset
+ 3] = value
;
244 p
[offset
+ 1] = value
>> 8;
245 p
[offset
+ 2] = value
>> 16;
246 p
[offset
+ 3] = value
>> 24;
253 static void pflash_write(pflash_t
*pfl
, target_phys_addr_t offset
,
254 uint32_t value
, int width
, int be
)
261 DPRINTF("%s: writing offset " TARGET_FMT_plx
" value %08x width %d wcycle 0x%x\n",
262 __func__
, offset
, value
, width
, pfl
->wcycle
);
265 /* Set the device in I/O access mode */
266 cpu_register_physical_memory(pfl
->base
, pfl
->total_len
, pfl
->fl_mem
);
269 switch (pfl
->wcycle
) {
275 case 0x10: /* Single Byte Program */
276 case 0x40: /* Single Byte Program */
277 DPRINTF("%s: Single Byte Program\n", __func__
);
279 case 0x20: /* Block erase */
281 offset
&= ~(pfl
->sector_len
- 1);
283 DPRINTF("%s: block erase at " TARGET_FMT_plx
" bytes "
285 __func__
, offset
, pfl
->sector_len
);
287 memset(p
+ offset
, 0xff, pfl
->sector_len
);
288 pflash_update(pfl
, offset
, pfl
->sector_len
);
289 pfl
->status
|= 0x80; /* Ready! */
291 case 0x50: /* Clear status bits */
292 DPRINTF("%s: Clear status bits\n", __func__
);
295 case 0x60: /* Block (un)lock */
296 DPRINTF("%s: Block unlock\n", __func__
);
298 case 0x70: /* Status Register */
299 DPRINTF("%s: Read status register\n", __func__
);
302 case 0x90: /* Read Device ID */
303 DPRINTF("%s: Read Device information\n", __func__
);
306 case 0x98: /* CFI query */
307 DPRINTF("%s: CFI query\n", __func__
);
309 case 0xe8: /* Write to buffer */
310 DPRINTF("%s: Write to buffer\n", __func__
);
311 pfl
->status
|= 0x80; /* Ready! */
313 case 0xff: /* Read array mode */
314 DPRINTF("%s: Read array mode\n", __func__
);
324 case 0x10: /* Single Byte Program */
325 case 0x40: /* Single Byte Program */
326 DPRINTF("%s: Single Byte Program\n", __func__
);
327 pflash_data_write(pfl
, offset
, value
, width
, be
);
328 pflash_update(pfl
, offset
, width
);
329 pfl
->status
|= 0x80; /* Ready! */
332 case 0x20: /* Block erase */
334 if (cmd
== 0xd0) { /* confirm */
337 } else if (cmd
== 0xff) { /* read array mode */
344 DPRINTF("%s: block write of %x bytes\n", __func__
, value
);
345 pfl
->counter
= value
;
352 } else if (cmd
== 0x01) {
355 } else if (cmd
== 0xff) {
358 DPRINTF("%s: Unknown (un)locking command\n", __func__
);
366 DPRINTF("%s: leaving query mode\n", __func__
);
375 case 0xe8: /* Block write */
376 pflash_data_write(pfl
, offset
, value
, width
, be
);
381 target_phys_addr_t mask
= pfl
->writeblock_size
- 1;
384 DPRINTF("%s: block write finished\n", __func__
);
386 /* Flush the entire write buffer onto backing storage. */
387 pflash_update(pfl
, offset
& mask
, pfl
->writeblock_size
);
396 case 3: /* Confirm mode */
398 case 0xe8: /* Block write */
403 DPRINTF("%s: unknown command for \"write block\"\n", __func__
);
404 PFLASH_BUG("Write block confirm");
413 /* Should never happen */
414 DPRINTF("%s: invalid write state\n", __func__
);
420 printf("%s: Unimplemented flash cmd sequence "
421 "(offset " TARGET_FMT_plx
", wcycle 0x%x cmd 0x%x value 0x%x)\n",
422 __func__
, offset
, pfl
->wcycle
, pfl
->cmd
, value
);
425 cpu_register_physical_memory(pfl
->base
, pfl
->total_len
,
426 pfl
->off
| IO_MEM_ROMD
| pfl
->fl_mem
);
435 static uint32_t pflash_readb_be(void *opaque
, target_phys_addr_t addr
)
437 return pflash_read(opaque
, addr
, 1, 1);
440 static uint32_t pflash_readb_le(void *opaque
, target_phys_addr_t addr
)
442 return pflash_read(opaque
, addr
, 1, 0);
445 static uint32_t pflash_readw_be(void *opaque
, target_phys_addr_t addr
)
447 pflash_t
*pfl
= opaque
;
449 return pflash_read(pfl
, addr
, 2, 1);
452 static uint32_t pflash_readw_le(void *opaque
, target_phys_addr_t addr
)
454 pflash_t
*pfl
= opaque
;
456 return pflash_read(pfl
, addr
, 2, 0);
459 static uint32_t pflash_readl_be(void *opaque
, target_phys_addr_t addr
)
461 pflash_t
*pfl
= opaque
;
463 return pflash_read(pfl
, addr
, 4, 1);
466 static uint32_t pflash_readl_le(void *opaque
, target_phys_addr_t addr
)
468 pflash_t
*pfl
= opaque
;
470 return pflash_read(pfl
, addr
, 4, 0);
473 static void pflash_writeb_be(void *opaque
, target_phys_addr_t addr
,
476 pflash_write(opaque
, addr
, value
, 1, 1);
479 static void pflash_writeb_le(void *opaque
, target_phys_addr_t addr
,
482 pflash_write(opaque
, addr
, value
, 1, 0);
485 static void pflash_writew_be(void *opaque
, target_phys_addr_t addr
,
488 pflash_t
*pfl
= opaque
;
490 pflash_write(pfl
, addr
, value
, 2, 1);
493 static void pflash_writew_le(void *opaque
, target_phys_addr_t addr
,
496 pflash_t
*pfl
= opaque
;
498 pflash_write(pfl
, addr
, value
, 2, 0);
501 static void pflash_writel_be(void *opaque
, target_phys_addr_t addr
,
504 pflash_t
*pfl
= opaque
;
506 pflash_write(pfl
, addr
, value
, 4, 1);
509 static void pflash_writel_le(void *opaque
, target_phys_addr_t addr
,
512 pflash_t
*pfl
= opaque
;
514 pflash_write(pfl
, addr
, value
, 4, 0);
517 static CPUWriteMemoryFunc
* const pflash_write_ops_be
[] = {
523 static CPUReadMemoryFunc
* const pflash_read_ops_be
[] = {
529 static CPUWriteMemoryFunc
* const pflash_write_ops_le
[] = {
535 static CPUReadMemoryFunc
* const pflash_read_ops_le
[] = {
541 /* Count trailing zeroes of a 32 bits quantity */
542 static int ctz32 (uint32_t n
)
565 #if 0 /* This is not necessary as n is never 0 */
569 #if 0 /* This is not necessary as n is never 0 */
577 pflash_t
*pflash_cfi01_register(target_phys_addr_t base
, ram_addr_t off
,
578 BlockDriverState
*bs
, uint32_t sector_len
,
579 int nb_blocs
, int width
,
580 uint16_t id0
, uint16_t id1
,
581 uint16_t id2
, uint16_t id3
,
585 target_phys_addr_t total_len
;
588 total_len
= sector_len
* nb_blocs
;
590 /* XXX: to be fixed */
592 if (total_len
!= (8 * 1024 * 1024) && total_len
!= (16 * 1024 * 1024) &&
593 total_len
!= (32 * 1024 * 1024) && total_len
!= (64 * 1024 * 1024))
597 pfl
= g_malloc0(sizeof(pflash_t
));
599 /* FIXME: Allocate ram ourselves. */
600 pfl
->storage
= qemu_get_ram_ptr(off
);
602 pfl
->fl_mem
= cpu_register_io_memory(pflash_read_ops_be
,
603 pflash_write_ops_be
, pfl
,
604 DEVICE_NATIVE_ENDIAN
);
606 pfl
->fl_mem
= cpu_register_io_memory(pflash_read_ops_le
,
607 pflash_write_ops_le
, pfl
,
608 DEVICE_NATIVE_ENDIAN
);
611 cpu_register_physical_memory(base
, total_len
,
612 off
| pfl
->fl_mem
| IO_MEM_ROMD
);
616 /* read the initial flash content */
617 ret
= bdrv_read(pfl
->bs
, 0, pfl
->storage
, total_len
>> 9);
619 cpu_unregister_io_memory(pfl
->fl_mem
);
624 #if 0 /* XXX: there should be a bit to set up read-only,
625 * the same way the hardware does (with WP pin).
631 pfl
->timer
= qemu_new_timer_ns(vm_clock
, pflash_timer
, pfl
);
633 pfl
->sector_len
= sector_len
;
634 pfl
->total_len
= total_len
;
643 /* Hardcoded CFI table */
645 /* Standard "QRY" string */
646 pfl
->cfi_table
[0x10] = 'Q';
647 pfl
->cfi_table
[0x11] = 'R';
648 pfl
->cfi_table
[0x12] = 'Y';
649 /* Command set (Intel) */
650 pfl
->cfi_table
[0x13] = 0x01;
651 pfl
->cfi_table
[0x14] = 0x00;
652 /* Primary extended table address (none) */
653 pfl
->cfi_table
[0x15] = 0x31;
654 pfl
->cfi_table
[0x16] = 0x00;
655 /* Alternate command set (none) */
656 pfl
->cfi_table
[0x17] = 0x00;
657 pfl
->cfi_table
[0x18] = 0x00;
658 /* Alternate extended table (none) */
659 pfl
->cfi_table
[0x19] = 0x00;
660 pfl
->cfi_table
[0x1A] = 0x00;
662 pfl
->cfi_table
[0x1B] = 0x45;
664 pfl
->cfi_table
[0x1C] = 0x55;
665 /* Vpp min (no Vpp pin) */
666 pfl
->cfi_table
[0x1D] = 0x00;
667 /* Vpp max (no Vpp pin) */
668 pfl
->cfi_table
[0x1E] = 0x00;
670 pfl
->cfi_table
[0x1F] = 0x07;
671 /* Timeout for min size buffer write */
672 pfl
->cfi_table
[0x20] = 0x07;
673 /* Typical timeout for block erase */
674 pfl
->cfi_table
[0x21] = 0x0a;
675 /* Typical timeout for full chip erase (4096 ms) */
676 pfl
->cfi_table
[0x22] = 0x00;
678 pfl
->cfi_table
[0x23] = 0x04;
679 /* Max timeout for buffer write */
680 pfl
->cfi_table
[0x24] = 0x04;
681 /* Max timeout for block erase */
682 pfl
->cfi_table
[0x25] = 0x04;
683 /* Max timeout for chip erase */
684 pfl
->cfi_table
[0x26] = 0x00;
686 pfl
->cfi_table
[0x27] = ctz32(total_len
); // + 1;
687 /* Flash device interface (8 & 16 bits) */
688 pfl
->cfi_table
[0x28] = 0x02;
689 pfl
->cfi_table
[0x29] = 0x00;
690 /* Max number of bytes in multi-bytes write */
692 pfl
->cfi_table
[0x2A] = 0x08;
694 pfl
->cfi_table
[0x2A] = 0x0B;
696 pfl
->writeblock_size
= 1 << pfl
->cfi_table
[0x2A];
698 pfl
->cfi_table
[0x2B] = 0x00;
699 /* Number of erase block regions (uniform) */
700 pfl
->cfi_table
[0x2C] = 0x01;
701 /* Erase block region 1 */
702 pfl
->cfi_table
[0x2D] = nb_blocs
- 1;
703 pfl
->cfi_table
[0x2E] = (nb_blocs
- 1) >> 8;
704 pfl
->cfi_table
[0x2F] = sector_len
>> 8;
705 pfl
->cfi_table
[0x30] = sector_len
>> 16;
708 pfl
->cfi_table
[0x31] = 'P';
709 pfl
->cfi_table
[0x32] = 'R';
710 pfl
->cfi_table
[0x33] = 'I';
712 pfl
->cfi_table
[0x34] = '1';
713 pfl
->cfi_table
[0x35] = '1';
715 pfl
->cfi_table
[0x36] = 0x00;
716 pfl
->cfi_table
[0x37] = 0x00;
717 pfl
->cfi_table
[0x38] = 0x00;
718 pfl
->cfi_table
[0x39] = 0x00;
720 pfl
->cfi_table
[0x3a] = 0x00;
722 pfl
->cfi_table
[0x3b] = 0x00;
723 pfl
->cfi_table
[0x3c] = 0x00;