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"
45 #define PFLASH_BUG(fmt, ...) \
47 printf("PFLASH: Possible BUG - " fmt, ## __VA_ARGS__); \
51 /* #define PFLASH_DEBUG */
53 #define DPRINTF(fmt, ...) \
55 printf("PFLASH: " fmt , ## __VA_ARGS__); \
58 #define DPRINTF(fmt, ...) do { } while (0)
63 target_phys_addr_t base
;
64 target_phys_addr_t sector_len
;
65 target_phys_addr_t total_len
;
67 int wcycle
; /* if 0, the flash is read normally */
74 uint8_t cfi_table
[0x52];
75 target_phys_addr_t counter
;
76 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 memory_region_rom_device_set_readable(&pfl
->mem
, true);
98 static uint32_t pflash_read (pflash_t
*pfl
, target_phys_addr_t offset
,
101 target_phys_addr_t boff
;
106 boff
= offset
& 0xFF; /* why this here ?? */
110 else if (pfl
->width
== 4)
114 DPRINTF("%s: reading offset " TARGET_FMT_plx
" under cmd %02x width %d\n",
115 __func__
, offset
, pfl
->cmd
, width
);
119 /* Flash area read */
124 DPRINTF("%s: data offset " TARGET_FMT_plx
" %02x\n",
125 __func__
, offset
, ret
);
129 ret
= p
[offset
] << 8;
130 ret
|= p
[offset
+ 1];
133 ret
|= p
[offset
+ 1] << 8;
135 DPRINTF("%s: data offset " TARGET_FMT_plx
" %04x\n",
136 __func__
, offset
, ret
);
140 ret
= p
[offset
] << 24;
141 ret
|= p
[offset
+ 1] << 16;
142 ret
|= p
[offset
+ 2] << 8;
143 ret
|= p
[offset
+ 3];
146 ret
|= p
[offset
+ 1] << 8;
147 ret
|= p
[offset
+ 2] << 16;
148 ret
|= p
[offset
+ 3] << 24;
150 DPRINTF("%s: data offset " TARGET_FMT_plx
" %08x\n",
151 __func__
, offset
, ret
);
154 DPRINTF("BUG in %s\n", __func__
);
158 case 0x20: /* Block erase */
159 case 0x50: /* Clear status register */
160 case 0x60: /* Block /un)lock */
161 case 0x70: /* Status Register */
162 case 0xe8: /* Write block */
163 /* Status register read */
165 DPRINTF("%s: status %x\n", __func__
, ret
);
170 ret
= pfl
->ident
[0] << 8 | pfl
->ident
[1];
171 DPRINTF("%s: Manufacturer Code %04x\n", __func__
, ret
);
174 ret
= pfl
->ident
[2] << 8 | pfl
->ident
[3];
175 DPRINTF("%s: Device ID Code %04x\n", __func__
, ret
);
178 DPRINTF("%s: Read Device Information boff=%x\n", __func__
, boff
);
183 case 0x98: /* Query mode */
184 if (boff
> pfl
->cfi_len
)
187 ret
= pfl
->cfi_table
[boff
];
190 /* This should never happen : reset state & treat it as a read */
191 DPRINTF("%s: unknown command state: %x\n", __func__
, pfl
->cmd
);
198 /* update flash content on disk */
199 static void pflash_update(pflash_t
*pfl
, int offset
,
204 offset_end
= offset
+ size
;
205 /* round to sectors */
206 offset
= offset
>> 9;
207 offset_end
= (offset_end
+ 511) >> 9;
208 bdrv_write(pfl
->bs
, offset
, pfl
->storage
+ (offset
<< 9),
209 offset_end
- offset
);
213 static inline void pflash_data_write(pflash_t
*pfl
, target_phys_addr_t offset
,
214 uint32_t value
, int width
, int be
)
216 uint8_t *p
= pfl
->storage
;
218 DPRINTF("%s: block write offset " TARGET_FMT_plx
219 " value %x counter " TARGET_FMT_plx
"\n",
220 __func__
, offset
, value
, pfl
->counter
);
227 p
[offset
] = value
>> 8;
228 p
[offset
+ 1] = value
;
231 p
[offset
+ 1] = value
>> 8;
236 p
[offset
] = value
>> 24;
237 p
[offset
+ 1] = value
>> 16;
238 p
[offset
+ 2] = value
>> 8;
239 p
[offset
+ 3] = value
;
242 p
[offset
+ 1] = value
>> 8;
243 p
[offset
+ 2] = value
>> 16;
244 p
[offset
+ 3] = value
>> 24;
251 static void pflash_write(pflash_t
*pfl
, target_phys_addr_t offset
,
252 uint32_t value
, int width
, int be
)
259 DPRINTF("%s: writing offset " TARGET_FMT_plx
" value %08x width %d wcycle 0x%x\n",
260 __func__
, offset
, value
, width
, pfl
->wcycle
);
263 /* Set the device in I/O access mode */
264 memory_region_rom_device_set_readable(&pfl
->mem
, false);
267 switch (pfl
->wcycle
) {
273 case 0x10: /* Single Byte Program */
274 case 0x40: /* Single Byte Program */
275 DPRINTF("%s: Single Byte Program\n", __func__
);
277 case 0x20: /* Block erase */
279 offset
&= ~(pfl
->sector_len
- 1);
281 DPRINTF("%s: block erase at " TARGET_FMT_plx
" bytes "
283 __func__
, offset
, pfl
->sector_len
);
286 memset(p
+ offset
, 0xff, pfl
->sector_len
);
287 pflash_update(pfl
, offset
, pfl
->sector_len
);
289 pfl
->status
|= 0x20; /* Block erase error */
291 pfl
->status
|= 0x80; /* Ready! */
293 case 0x50: /* Clear status bits */
294 DPRINTF("%s: Clear status bits\n", __func__
);
297 case 0x60: /* Block (un)lock */
298 DPRINTF("%s: Block unlock\n", __func__
);
300 case 0x70: /* Status Register */
301 DPRINTF("%s: Read status register\n", __func__
);
304 case 0x90: /* Read Device ID */
305 DPRINTF("%s: Read Device information\n", __func__
);
308 case 0x98: /* CFI query */
309 DPRINTF("%s: CFI query\n", __func__
);
311 case 0xe8: /* Write to buffer */
312 DPRINTF("%s: Write to buffer\n", __func__
);
313 pfl
->status
|= 0x80; /* Ready! */
315 case 0xff: /* Read array mode */
316 DPRINTF("%s: Read array mode\n", __func__
);
326 case 0x10: /* Single Byte Program */
327 case 0x40: /* Single Byte Program */
328 DPRINTF("%s: Single Byte Program\n", __func__
);
330 pflash_data_write(pfl
, offset
, value
, width
, be
);
331 pflash_update(pfl
, offset
, width
);
333 pfl
->status
|= 0x10; /* Programming error */
335 pfl
->status
|= 0x80; /* Ready! */
338 case 0x20: /* Block erase */
340 if (cmd
== 0xd0) { /* confirm */
343 } else if (cmd
== 0xff) { /* read array mode */
350 DPRINTF("%s: block write of %x bytes\n", __func__
, value
);
351 pfl
->counter
= value
;
358 } else if (cmd
== 0x01) {
361 } else if (cmd
== 0xff) {
364 DPRINTF("%s: Unknown (un)locking command\n", __func__
);
372 DPRINTF("%s: leaving query mode\n", __func__
);
381 case 0xe8: /* Block write */
383 pflash_data_write(pfl
, offset
, value
, width
, be
);
385 pfl
->status
|= 0x10; /* Programming error */
391 target_phys_addr_t mask
= pfl
->writeblock_size
- 1;
394 DPRINTF("%s: block write finished\n", __func__
);
397 /* Flush the entire write buffer onto backing storage. */
398 pflash_update(pfl
, offset
& mask
, pfl
->writeblock_size
);
400 pfl
->status
|= 0x10; /* Programming error */
410 case 3: /* Confirm mode */
412 case 0xe8: /* Block write */
417 DPRINTF("%s: unknown command for \"write block\"\n", __func__
);
418 PFLASH_BUG("Write block confirm");
427 /* Should never happen */
428 DPRINTF("%s: invalid write state\n", __func__
);
434 printf("%s: Unimplemented flash cmd sequence "
435 "(offset " TARGET_FMT_plx
", wcycle 0x%x cmd 0x%x value 0x%x)\n",
436 __func__
, offset
, pfl
->wcycle
, pfl
->cmd
, value
);
439 memory_region_rom_device_set_readable(&pfl
->mem
, true);
448 static uint32_t pflash_readb_be(void *opaque
, target_phys_addr_t addr
)
450 return pflash_read(opaque
, addr
, 1, 1);
453 static uint32_t pflash_readb_le(void *opaque
, target_phys_addr_t addr
)
455 return pflash_read(opaque
, addr
, 1, 0);
458 static uint32_t pflash_readw_be(void *opaque
, target_phys_addr_t addr
)
460 pflash_t
*pfl
= opaque
;
462 return pflash_read(pfl
, addr
, 2, 1);
465 static uint32_t pflash_readw_le(void *opaque
, target_phys_addr_t addr
)
467 pflash_t
*pfl
= opaque
;
469 return pflash_read(pfl
, addr
, 2, 0);
472 static uint32_t pflash_readl_be(void *opaque
, target_phys_addr_t addr
)
474 pflash_t
*pfl
= opaque
;
476 return pflash_read(pfl
, addr
, 4, 1);
479 static uint32_t pflash_readl_le(void *opaque
, target_phys_addr_t addr
)
481 pflash_t
*pfl
= opaque
;
483 return pflash_read(pfl
, addr
, 4, 0);
486 static void pflash_writeb_be(void *opaque
, target_phys_addr_t addr
,
489 pflash_write(opaque
, addr
, value
, 1, 1);
492 static void pflash_writeb_le(void *opaque
, target_phys_addr_t addr
,
495 pflash_write(opaque
, addr
, value
, 1, 0);
498 static void pflash_writew_be(void *opaque
, target_phys_addr_t addr
,
501 pflash_t
*pfl
= opaque
;
503 pflash_write(pfl
, addr
, value
, 2, 1);
506 static void pflash_writew_le(void *opaque
, target_phys_addr_t addr
,
509 pflash_t
*pfl
= opaque
;
511 pflash_write(pfl
, addr
, value
, 2, 0);
514 static void pflash_writel_be(void *opaque
, target_phys_addr_t addr
,
517 pflash_t
*pfl
= opaque
;
519 pflash_write(pfl
, addr
, value
, 4, 1);
522 static void pflash_writel_le(void *opaque
, target_phys_addr_t addr
,
525 pflash_t
*pfl
= opaque
;
527 pflash_write(pfl
, addr
, value
, 4, 0);
530 static const MemoryRegionOps pflash_cfi01_ops_be
= {
532 .read
= { pflash_readb_be
, pflash_readw_be
, pflash_readl_be
, },
533 .write
= { pflash_writeb_be
, pflash_writew_be
, pflash_writel_be
, },
535 .endianness
= DEVICE_NATIVE_ENDIAN
,
538 static const MemoryRegionOps pflash_cfi01_ops_le
= {
540 .read
= { pflash_readb_le
, pflash_readw_le
, pflash_readl_le
, },
541 .write
= { pflash_writeb_le
, pflash_writew_le
, pflash_writel_le
, },
543 .endianness
= DEVICE_NATIVE_ENDIAN
,
546 /* Count trailing zeroes of a 32 bits quantity */
547 static int ctz32 (uint32_t n
)
570 #if 0 /* This is not necessary as n is never 0 */
574 #if 0 /* This is not necessary as n is never 0 */
582 pflash_t
*pflash_cfi01_register(target_phys_addr_t base
,
583 DeviceState
*qdev
, const char *name
,
584 target_phys_addr_t size
,
585 BlockDriverState
*bs
, uint32_t sector_len
,
586 int nb_blocs
, int width
,
587 uint16_t id0
, uint16_t id1
,
588 uint16_t id2
, uint16_t id3
, int be
)
591 target_phys_addr_t total_len
;
594 total_len
= sector_len
* nb_blocs
;
596 /* XXX: to be fixed */
598 if (total_len
!= (8 * 1024 * 1024) && total_len
!= (16 * 1024 * 1024) &&
599 total_len
!= (32 * 1024 * 1024) && total_len
!= (64 * 1024 * 1024))
603 pfl
= g_malloc0(sizeof(pflash_t
));
605 memory_region_init_rom_device(
606 &pfl
->mem
, be
? &pflash_cfi01_ops_be
: &pflash_cfi01_ops_le
, pfl
,
608 vmstate_register_ram(&pfl
->mem
, qdev
);
609 pfl
->storage
= memory_region_get_ram_ptr(&pfl
->mem
);
610 memory_region_add_subregion(get_system_memory(), base
, &pfl
->mem
);
614 /* read the initial flash content */
615 ret
= bdrv_read(pfl
->bs
, 0, pfl
->storage
, total_len
>> 9);
617 memory_region_del_subregion(get_system_memory(), &pfl
->mem
);
618 vmstate_unregister_ram(&pfl
->mem
, qdev
);
619 memory_region_destroy(&pfl
->mem
);
623 bdrv_attach_dev_nofail(pfl
->bs
, pfl
);
627 pfl
->ro
= bdrv_is_read_only(pfl
->bs
);
632 pfl
->timer
= qemu_new_timer_ns(vm_clock
, pflash_timer
, pfl
);
634 pfl
->sector_len
= sector_len
;
635 pfl
->total_len
= total_len
;
644 /* Hardcoded CFI table */
646 /* Standard "QRY" string */
647 pfl
->cfi_table
[0x10] = 'Q';
648 pfl
->cfi_table
[0x11] = 'R';
649 pfl
->cfi_table
[0x12] = 'Y';
650 /* Command set (Intel) */
651 pfl
->cfi_table
[0x13] = 0x01;
652 pfl
->cfi_table
[0x14] = 0x00;
653 /* Primary extended table address (none) */
654 pfl
->cfi_table
[0x15] = 0x31;
655 pfl
->cfi_table
[0x16] = 0x00;
656 /* Alternate command set (none) */
657 pfl
->cfi_table
[0x17] = 0x00;
658 pfl
->cfi_table
[0x18] = 0x00;
659 /* Alternate extended table (none) */
660 pfl
->cfi_table
[0x19] = 0x00;
661 pfl
->cfi_table
[0x1A] = 0x00;
663 pfl
->cfi_table
[0x1B] = 0x45;
665 pfl
->cfi_table
[0x1C] = 0x55;
666 /* Vpp min (no Vpp pin) */
667 pfl
->cfi_table
[0x1D] = 0x00;
668 /* Vpp max (no Vpp pin) */
669 pfl
->cfi_table
[0x1E] = 0x00;
671 pfl
->cfi_table
[0x1F] = 0x07;
672 /* Timeout for min size buffer write */
673 pfl
->cfi_table
[0x20] = 0x07;
674 /* Typical timeout for block erase */
675 pfl
->cfi_table
[0x21] = 0x0a;
676 /* Typical timeout for full chip erase (4096 ms) */
677 pfl
->cfi_table
[0x22] = 0x00;
679 pfl
->cfi_table
[0x23] = 0x04;
680 /* Max timeout for buffer write */
681 pfl
->cfi_table
[0x24] = 0x04;
682 /* Max timeout for block erase */
683 pfl
->cfi_table
[0x25] = 0x04;
684 /* Max timeout for chip erase */
685 pfl
->cfi_table
[0x26] = 0x00;
687 pfl
->cfi_table
[0x27] = ctz32(total_len
); // + 1;
688 /* Flash device interface (8 & 16 bits) */
689 pfl
->cfi_table
[0x28] = 0x02;
690 pfl
->cfi_table
[0x29] = 0x00;
691 /* Max number of bytes in multi-bytes write */
693 pfl
->cfi_table
[0x2A] = 0x08;
695 pfl
->cfi_table
[0x2A] = 0x0B;
697 pfl
->writeblock_size
= 1 << pfl
->cfi_table
[0x2A];
699 pfl
->cfi_table
[0x2B] = 0x00;
700 /* Number of erase block regions (uniform) */
701 pfl
->cfi_table
[0x2C] = 0x01;
702 /* Erase block region 1 */
703 pfl
->cfi_table
[0x2D] = nb_blocs
- 1;
704 pfl
->cfi_table
[0x2E] = (nb_blocs
- 1) >> 8;
705 pfl
->cfi_table
[0x2F] = sector_len
>> 8;
706 pfl
->cfi_table
[0x30] = sector_len
>> 16;
709 pfl
->cfi_table
[0x31] = 'P';
710 pfl
->cfi_table
[0x32] = 'R';
711 pfl
->cfi_table
[0x33] = 'I';
713 pfl
->cfi_table
[0x34] = '1';
714 pfl
->cfi_table
[0x35] = '1';
716 pfl
->cfi_table
[0x36] = 0x00;
717 pfl
->cfi_table
[0x37] = 0x00;
718 pfl
->cfi_table
[0x38] = 0x00;
719 pfl
->cfi_table
[0x39] = 0x00;
721 pfl
->cfi_table
[0x3a] = 0x00;
723 pfl
->cfi_table
[0x3b] = 0x00;
724 pfl
->cfi_table
[0x3c] = 0x00;
729 MemoryRegion
*pflash_cfi01_get_memory(pflash_t
*fl
)