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"
43 #include "exec-memory.h"
44 #include "host-utils.h"
46 #define PFLASH_BUG(fmt, ...) \
48 printf("PFLASH: Possible BUG - " fmt, ## __VA_ARGS__); \
52 /* #define PFLASH_DEBUG */
54 #define DPRINTF(fmt, ...) \
56 printf("PFLASH: " fmt , ## __VA_ARGS__); \
59 #define DPRINTF(fmt, ...) do { } while (0)
64 target_phys_addr_t base
;
65 target_phys_addr_t sector_len
;
66 target_phys_addr_t total_len
;
68 int wcycle
; /* if 0, the flash is read normally */
75 uint8_t cfi_table
[0x52];
76 target_phys_addr_t counter
;
77 unsigned int writeblock_size
;
83 static void pflash_timer (void *opaque
)
85 pflash_t
*pfl
= opaque
;
87 DPRINTF("%s: command %02x done\n", __func__
, pfl
->cmd
);
93 memory_region_rom_device_set_readable(&pfl
->mem
, true);
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
+ 2] << 16;
149 ret
|= p
[offset
+ 3] << 24;
151 DPRINTF("%s: data offset " TARGET_FMT_plx
" %08x\n",
152 __func__
, offset
, ret
);
155 DPRINTF("BUG in %s\n", __func__
);
159 case 0x20: /* Block erase */
160 case 0x50: /* Clear status register */
161 case 0x60: /* Block /un)lock */
162 case 0x70: /* Status Register */
163 case 0xe8: /* Write block */
164 /* Status register read */
166 DPRINTF("%s: status %x\n", __func__
, ret
);
171 ret
= pfl
->ident
[0] << 8 | pfl
->ident
[1];
172 DPRINTF("%s: Manufacturer Code %04x\n", __func__
, ret
);
175 ret
= pfl
->ident
[2] << 8 | pfl
->ident
[3];
176 DPRINTF("%s: Device ID Code %04x\n", __func__
, ret
);
179 DPRINTF("%s: Read Device Information boff=%x\n", __func__
, boff
);
184 case 0x98: /* Query mode */
185 if (boff
> pfl
->cfi_len
)
188 ret
= pfl
->cfi_table
[boff
];
191 /* This should never happen : reset state & treat it as a read */
192 DPRINTF("%s: unknown command state: %x\n", __func__
, pfl
->cmd
);
199 /* update flash content on disk */
200 static void pflash_update(pflash_t
*pfl
, int offset
,
205 offset_end
= offset
+ size
;
206 /* round to sectors */
207 offset
= offset
>> 9;
208 offset_end
= (offset_end
+ 511) >> 9;
209 bdrv_write(pfl
->bs
, offset
, pfl
->storage
+ (offset
<< 9),
210 offset_end
- offset
);
214 static inline void pflash_data_write(pflash_t
*pfl
, target_phys_addr_t offset
,
215 uint32_t value
, int width
, int be
)
217 uint8_t *p
= pfl
->storage
;
219 DPRINTF("%s: block write offset " TARGET_FMT_plx
220 " value %x counter " TARGET_FMT_plx
"\n",
221 __func__
, offset
, value
, pfl
->counter
);
228 p
[offset
] = value
>> 8;
229 p
[offset
+ 1] = value
;
232 p
[offset
+ 1] = value
>> 8;
237 p
[offset
] = value
>> 24;
238 p
[offset
+ 1] = value
>> 16;
239 p
[offset
+ 2] = value
>> 8;
240 p
[offset
+ 3] = value
;
243 p
[offset
+ 1] = value
>> 8;
244 p
[offset
+ 2] = value
>> 16;
245 p
[offset
+ 3] = value
>> 24;
252 static void pflash_write(pflash_t
*pfl
, target_phys_addr_t offset
,
253 uint32_t value
, int width
, int be
)
260 DPRINTF("%s: writing offset " TARGET_FMT_plx
" value %08x width %d wcycle 0x%x\n",
261 __func__
, offset
, value
, width
, pfl
->wcycle
);
264 /* Set the device in I/O access mode */
265 memory_region_rom_device_set_readable(&pfl
->mem
, false);
268 switch (pfl
->wcycle
) {
274 case 0x10: /* Single Byte Program */
275 case 0x40: /* Single Byte Program */
276 DPRINTF("%s: Single Byte Program\n", __func__
);
278 case 0x20: /* Block erase */
280 offset
&= ~(pfl
->sector_len
- 1);
282 DPRINTF("%s: block erase at " TARGET_FMT_plx
" bytes "
284 __func__
, offset
, pfl
->sector_len
);
287 memset(p
+ offset
, 0xff, pfl
->sector_len
);
288 pflash_update(pfl
, offset
, pfl
->sector_len
);
290 pfl
->status
|= 0x20; /* Block erase error */
292 pfl
->status
|= 0x80; /* Ready! */
294 case 0x50: /* Clear status bits */
295 DPRINTF("%s: Clear status bits\n", __func__
);
298 case 0x60: /* Block (un)lock */
299 DPRINTF("%s: Block unlock\n", __func__
);
301 case 0x70: /* Status Register */
302 DPRINTF("%s: Read status register\n", __func__
);
305 case 0x90: /* Read Device ID */
306 DPRINTF("%s: Read Device information\n", __func__
);
309 case 0x98: /* CFI query */
310 DPRINTF("%s: CFI query\n", __func__
);
312 case 0xe8: /* Write to buffer */
313 DPRINTF("%s: Write to buffer\n", __func__
);
314 pfl
->status
|= 0x80; /* Ready! */
316 case 0xff: /* Read array mode */
317 DPRINTF("%s: Read array mode\n", __func__
);
327 case 0x10: /* Single Byte Program */
328 case 0x40: /* Single Byte Program */
329 DPRINTF("%s: Single Byte Program\n", __func__
);
331 pflash_data_write(pfl
, offset
, value
, width
, be
);
332 pflash_update(pfl
, offset
, width
);
334 pfl
->status
|= 0x10; /* Programming error */
336 pfl
->status
|= 0x80; /* Ready! */
339 case 0x20: /* Block erase */
341 if (cmd
== 0xd0) { /* confirm */
344 } else if (cmd
== 0xff) { /* read array mode */
351 DPRINTF("%s: block write of %x bytes\n", __func__
, value
);
352 pfl
->counter
= value
;
359 } else if (cmd
== 0x01) {
362 } else if (cmd
== 0xff) {
365 DPRINTF("%s: Unknown (un)locking command\n", __func__
);
373 DPRINTF("%s: leaving query mode\n", __func__
);
382 case 0xe8: /* Block write */
384 pflash_data_write(pfl
, offset
, value
, width
, be
);
386 pfl
->status
|= 0x10; /* Programming error */
392 target_phys_addr_t mask
= pfl
->writeblock_size
- 1;
395 DPRINTF("%s: block write finished\n", __func__
);
398 /* Flush the entire write buffer onto backing storage. */
399 pflash_update(pfl
, offset
& mask
, pfl
->writeblock_size
);
401 pfl
->status
|= 0x10; /* Programming error */
411 case 3: /* Confirm mode */
413 case 0xe8: /* Block write */
418 DPRINTF("%s: unknown command for \"write block\"\n", __func__
);
419 PFLASH_BUG("Write block confirm");
428 /* Should never happen */
429 DPRINTF("%s: invalid write state\n", __func__
);
435 printf("%s: Unimplemented flash cmd sequence "
436 "(offset " TARGET_FMT_plx
", wcycle 0x%x cmd 0x%x value 0x%x)\n",
437 __func__
, offset
, pfl
->wcycle
, pfl
->cmd
, value
);
440 memory_region_rom_device_set_readable(&pfl
->mem
, true);
449 static uint32_t pflash_readb_be(void *opaque
, target_phys_addr_t addr
)
451 return pflash_read(opaque
, addr
, 1, 1);
454 static uint32_t pflash_readb_le(void *opaque
, target_phys_addr_t addr
)
456 return pflash_read(opaque
, addr
, 1, 0);
459 static uint32_t pflash_readw_be(void *opaque
, target_phys_addr_t addr
)
461 pflash_t
*pfl
= opaque
;
463 return pflash_read(pfl
, addr
, 2, 1);
466 static uint32_t pflash_readw_le(void *opaque
, target_phys_addr_t addr
)
468 pflash_t
*pfl
= opaque
;
470 return pflash_read(pfl
, addr
, 2, 0);
473 static uint32_t pflash_readl_be(void *opaque
, target_phys_addr_t addr
)
475 pflash_t
*pfl
= opaque
;
477 return pflash_read(pfl
, addr
, 4, 1);
480 static uint32_t pflash_readl_le(void *opaque
, target_phys_addr_t addr
)
482 pflash_t
*pfl
= opaque
;
484 return pflash_read(pfl
, addr
, 4, 0);
487 static void pflash_writeb_be(void *opaque
, target_phys_addr_t addr
,
490 pflash_write(opaque
, addr
, value
, 1, 1);
493 static void pflash_writeb_le(void *opaque
, target_phys_addr_t addr
,
496 pflash_write(opaque
, addr
, value
, 1, 0);
499 static void pflash_writew_be(void *opaque
, target_phys_addr_t addr
,
502 pflash_t
*pfl
= opaque
;
504 pflash_write(pfl
, addr
, value
, 2, 1);
507 static void pflash_writew_le(void *opaque
, target_phys_addr_t addr
,
510 pflash_t
*pfl
= opaque
;
512 pflash_write(pfl
, addr
, value
, 2, 0);
515 static void pflash_writel_be(void *opaque
, target_phys_addr_t addr
,
518 pflash_t
*pfl
= opaque
;
520 pflash_write(pfl
, addr
, value
, 4, 1);
523 static void pflash_writel_le(void *opaque
, target_phys_addr_t addr
,
526 pflash_t
*pfl
= opaque
;
528 pflash_write(pfl
, addr
, value
, 4, 0);
531 static const MemoryRegionOps pflash_cfi01_ops_be
= {
533 .read
= { pflash_readb_be
, pflash_readw_be
, pflash_readl_be
, },
534 .write
= { pflash_writeb_be
, pflash_writew_be
, pflash_writel_be
, },
536 .endianness
= DEVICE_NATIVE_ENDIAN
,
539 static const MemoryRegionOps pflash_cfi01_ops_le
= {
541 .read
= { pflash_readb_le
, pflash_readw_le
, pflash_readl_le
, },
542 .write
= { pflash_writeb_le
, pflash_writew_le
, pflash_writel_le
, },
544 .endianness
= DEVICE_NATIVE_ENDIAN
,
547 pflash_t
*pflash_cfi01_register(target_phys_addr_t base
,
548 DeviceState
*qdev
, const char *name
,
549 target_phys_addr_t size
,
550 BlockDriverState
*bs
, uint32_t sector_len
,
551 int nb_blocs
, int width
,
552 uint16_t id0
, uint16_t id1
,
553 uint16_t id2
, uint16_t id3
, int be
)
556 target_phys_addr_t total_len
;
559 total_len
= sector_len
* nb_blocs
;
561 /* XXX: to be fixed */
563 if (total_len
!= (8 * 1024 * 1024) && total_len
!= (16 * 1024 * 1024) &&
564 total_len
!= (32 * 1024 * 1024) && total_len
!= (64 * 1024 * 1024))
568 pfl
= g_malloc0(sizeof(pflash_t
));
570 memory_region_init_rom_device(
571 &pfl
->mem
, be
? &pflash_cfi01_ops_be
: &pflash_cfi01_ops_le
, pfl
,
573 vmstate_register_ram(&pfl
->mem
, qdev
);
574 pfl
->storage
= memory_region_get_ram_ptr(&pfl
->mem
);
575 memory_region_add_subregion(get_system_memory(), base
, &pfl
->mem
);
579 /* read the initial flash content */
580 ret
= bdrv_read(pfl
->bs
, 0, pfl
->storage
, total_len
>> 9);
582 memory_region_del_subregion(get_system_memory(), &pfl
->mem
);
583 vmstate_unregister_ram(&pfl
->mem
, qdev
);
584 memory_region_destroy(&pfl
->mem
);
588 bdrv_attach_dev_nofail(pfl
->bs
, pfl
);
592 pfl
->ro
= bdrv_is_read_only(pfl
->bs
);
597 pfl
->timer
= qemu_new_timer_ns(vm_clock
, pflash_timer
, pfl
);
599 pfl
->sector_len
= sector_len
;
600 pfl
->total_len
= total_len
;
609 /* Hardcoded CFI table */
611 /* Standard "QRY" string */
612 pfl
->cfi_table
[0x10] = 'Q';
613 pfl
->cfi_table
[0x11] = 'R';
614 pfl
->cfi_table
[0x12] = 'Y';
615 /* Command set (Intel) */
616 pfl
->cfi_table
[0x13] = 0x01;
617 pfl
->cfi_table
[0x14] = 0x00;
618 /* Primary extended table address (none) */
619 pfl
->cfi_table
[0x15] = 0x31;
620 pfl
->cfi_table
[0x16] = 0x00;
621 /* Alternate command set (none) */
622 pfl
->cfi_table
[0x17] = 0x00;
623 pfl
->cfi_table
[0x18] = 0x00;
624 /* Alternate extended table (none) */
625 pfl
->cfi_table
[0x19] = 0x00;
626 pfl
->cfi_table
[0x1A] = 0x00;
628 pfl
->cfi_table
[0x1B] = 0x45;
630 pfl
->cfi_table
[0x1C] = 0x55;
631 /* Vpp min (no Vpp pin) */
632 pfl
->cfi_table
[0x1D] = 0x00;
633 /* Vpp max (no Vpp pin) */
634 pfl
->cfi_table
[0x1E] = 0x00;
636 pfl
->cfi_table
[0x1F] = 0x07;
637 /* Timeout for min size buffer write */
638 pfl
->cfi_table
[0x20] = 0x07;
639 /* Typical timeout for block erase */
640 pfl
->cfi_table
[0x21] = 0x0a;
641 /* Typical timeout for full chip erase (4096 ms) */
642 pfl
->cfi_table
[0x22] = 0x00;
644 pfl
->cfi_table
[0x23] = 0x04;
645 /* Max timeout for buffer write */
646 pfl
->cfi_table
[0x24] = 0x04;
647 /* Max timeout for block erase */
648 pfl
->cfi_table
[0x25] = 0x04;
649 /* Max timeout for chip erase */
650 pfl
->cfi_table
[0x26] = 0x00;
652 pfl
->cfi_table
[0x27] = ctz32(total_len
); // + 1;
653 /* Flash device interface (8 & 16 bits) */
654 pfl
->cfi_table
[0x28] = 0x02;
655 pfl
->cfi_table
[0x29] = 0x00;
656 /* Max number of bytes in multi-bytes write */
658 pfl
->cfi_table
[0x2A] = 0x08;
660 pfl
->cfi_table
[0x2A] = 0x0B;
662 pfl
->writeblock_size
= 1 << pfl
->cfi_table
[0x2A];
664 pfl
->cfi_table
[0x2B] = 0x00;
665 /* Number of erase block regions (uniform) */
666 pfl
->cfi_table
[0x2C] = 0x01;
667 /* Erase block region 1 */
668 pfl
->cfi_table
[0x2D] = nb_blocs
- 1;
669 pfl
->cfi_table
[0x2E] = (nb_blocs
- 1) >> 8;
670 pfl
->cfi_table
[0x2F] = sector_len
>> 8;
671 pfl
->cfi_table
[0x30] = sector_len
>> 16;
674 pfl
->cfi_table
[0x31] = 'P';
675 pfl
->cfi_table
[0x32] = 'R';
676 pfl
->cfi_table
[0x33] = 'I';
678 pfl
->cfi_table
[0x34] = '1';
679 pfl
->cfi_table
[0x35] = '0';
681 pfl
->cfi_table
[0x36] = 0x00;
682 pfl
->cfi_table
[0x37] = 0x00;
683 pfl
->cfi_table
[0x38] = 0x00;
684 pfl
->cfi_table
[0x39] = 0x00;
686 pfl
->cfi_table
[0x3a] = 0x00;
688 pfl
->cfi_table
[0x3b] = 0x00;
689 pfl
->cfi_table
[0x3c] = 0x00;
691 pfl
->cfi_table
[0x3f] = 0x01; /* Number of protection fields */
696 MemoryRegion
*pflash_cfi01_get_memory(pflash_t
*fl
)