hw/block/m25p80.c

   1 /*
   2  * ST M25P80 emulator. Emulate all SPI flash devices based on the m25p80 command
   3  * set. Known devices table current as of Jun/2012 and taken from linux.
   4  * See drivers/mtd/devices/m25p80.c.
   5  *
   6  * Copyright (C) 2011 Edgar E. Iglesias <[email protected]>
   7  * Copyright (C) 2012 Peter A. G. Crosthwaite <[email protected]>
   8  * Copyright (C) 2012 PetaLogix
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public License as
  12  * published by the Free Software Foundation; either version 2 or
  13  * (at your option) a later version of the License.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, see <http://www.gnu.org/licenses/>.
  22  */
  23
  24 #include "qemu/osdep.h"
  25 #include "hw/hw.h"
  26 #include "sysemu/block-backend.h"
  27 #include "sysemu/blockdev.h"
  28 #include "hw/ssi/ssi.h"
  29 #include "qemu/bitops.h"
  30
  31 #ifndef M25P80_ERR_DEBUG
  32 #define M25P80_ERR_DEBUG 0
  33 #endif
  34
  35 #define DB_PRINT_L(level, ...) do { \
  36     if (M25P80_ERR_DEBUG > (level)) { \
  37         fprintf(stderr,  ": %s: ", __func__); \
  38         fprintf(stderr, ## __VA_ARGS__); \
  39     } \
  40 } while (0);
  41
  42 /* Fields for FlashPartInfo->flags */
  43
  44 /* erase capabilities */
  45 #define ER_4K 1
  46 #define ER_32K 2
  47 /* set to allow the page program command to write 0s back to 1. Useful for
  48  * modelling EEPROM with SPI flash command set
  49  */
  50 #define WR_1 0x100
  51
  52 /* 16 MiB max in 3 byte address mode */
  53 #define MAX_3BYTES_SIZE 0x1000000
  54
  55 typedef struct FlashPartInfo {
  56     const char *part_name;
  57     /* jedec code. (jedec >> 16) & 0xff is the 1st byte, >> 8 the 2nd etc */
  58     uint32_t jedec;
  59     /* extended jedec code */
  60     uint16_t ext_jedec;
  61     /* there is confusion between manufacturers as to what a sector is. In this
  62      * device model, a "sector" is the size that is erased by the ERASE_SECTOR
  63      * command (opcode 0xd8).
  64      */
  65     uint32_t sector_size;
  66     uint32_t n_sectors;
  67     uint32_t page_size;
  68     uint16_t flags;
  69 } FlashPartInfo;
  70
  71 /* adapted from linux */
  72
  73 #define INFO(_part_name, _jedec, _ext_jedec, _sector_size, _n_sectors, _flags)\
  74     .part_name = (_part_name),\
  75     .jedec = (_jedec),\
  76     .ext_jedec = (_ext_jedec),\
  77     .sector_size = (_sector_size),\
  78     .n_sectors = (_n_sectors),\
  79     .page_size = 256,\
  80     .flags = (_flags),\
  81
  82 #define JEDEC_NUMONYX 0x20
  83 #define JEDEC_WINBOND 0xEF
  84 #define JEDEC_SPANSION 0x01
  85
  86 /* Numonyx (Micron) Configuration register macros */
  87 #define VCFG_DUMMY 0x1
  88 #define VCFG_WRAP_SEQUENTIAL 0x2
  89 #define NVCFG_XIP_MODE_DISABLED (7 << 9)
  90 #define NVCFG_XIP_MODE_MASK (7 << 9)
  91 #define VCFG_XIP_MODE_ENABLED (1 << 3)
  92 #define CFG_DUMMY_CLK_LEN 4
  93 #define NVCFG_DUMMY_CLK_POS 12
  94 #define VCFG_DUMMY_CLK_POS 4
  95 #define EVCFG_OUT_DRIVER_STRENGHT_DEF 7
  96 #define EVCFG_VPP_ACCELERATOR (1 << 3)
  97 #define EVCFG_RESET_HOLD_ENABLED (1 << 4)
  98 #define NVCFG_DUAL_IO_MASK (1 << 2)
  99 #define EVCFG_DUAL_IO_ENABLED (1 << 6)
 100 #define NVCFG_QUAD_IO_MASK (1 << 3)
 101 #define EVCFG_QUAD_IO_ENABLED (1 << 7)
 102 #define NVCFG_4BYTE_ADDR_MASK (1 << 0)
 103 #define NVCFG_LOWER_SEGMENT_MASK (1 << 1)
 104 #define CFG_UPPER_128MB_SEG_ENABLED 0x3
 105
 106 static const FlashPartInfo known_devices[] = {
 107     /* Atmel -- some are (confusingly) marketed as "DataFlash" */
 108     { INFO("at25fs010",   0x1f6601,      0,  32 << 10,   4, ER_4K) },
 109     { INFO("at25fs040",   0x1f6604,      0,  64 << 10,   8, ER_4K) },
 110
 111     { INFO("at25df041a",  0x1f4401,      0,  64 << 10,   8, ER_4K) },
 112     { INFO("at25df321a",  0x1f4701,      0,  64 << 10,  64, ER_4K) },
 113     { INFO("at25df641",   0x1f4800,      0,  64 << 10, 128, ER_4K) },
 114
 115     { INFO("at26f004",    0x1f0400,      0,  64 << 10,   8, ER_4K) },
 116     { INFO("at26df081a",  0x1f4501,      0,  64 << 10,  16, ER_4K) },
 117     { INFO("at26df161a",  0x1f4601,      0,  64 << 10,  32, ER_4K) },
 118     { INFO("at26df321",   0x1f4700,      0,  64 << 10,  64, ER_4K) },
 119
 120     { INFO("at45db081d",  0x1f2500,      0,  64 << 10,  16, ER_4K) },
 121
 122     /* EON -- en25xxx */
 123     { INFO("en25f32",     0x1c3116,      0,  64 << 10,  64, ER_4K) },
 124     { INFO("en25p32",     0x1c2016,      0,  64 << 10,  64, 0) },
 125     { INFO("en25q32b",    0x1c3016,      0,  64 << 10,  64, 0) },
 126     { INFO("en25p64",     0x1c2017,      0,  64 << 10, 128, 0) },
 127     { INFO("en25q64",     0x1c3017,      0,  64 << 10, 128, ER_4K) },
 128
 129     /* GigaDevice */
 130     { INFO("gd25q32",     0xc84016,      0,  64 << 10,  64, ER_4K) },
 131     { INFO("gd25q64",     0xc84017,      0,  64 << 10, 128, ER_4K) },
 132
 133     /* Intel/Numonyx -- xxxs33b */
 134     { INFO("160s33b",     0x898911,      0,  64 << 10,  32, 0) },
 135     { INFO("320s33b",     0x898912,      0,  64 << 10,  64, 0) },
 136     { INFO("640s33b",     0x898913,      0,  64 << 10, 128, 0) },
 137     { INFO("n25q064",     0x20ba17,      0,  64 << 10, 128, 0) },
 138
 139     /* Macronix */
 140     { INFO("mx25l2005a",  0xc22012,      0,  64 << 10,   4, ER_4K) },
 141     { INFO("mx25l4005a",  0xc22013,      0,  64 << 10,   8, ER_4K) },
 142     { INFO("mx25l8005",   0xc22014,      0,  64 << 10,  16, 0) },
 143     { INFO("mx25l1606e",  0xc22015,      0,  64 << 10,  32, ER_4K) },
 144     { INFO("mx25l3205d",  0xc22016,      0,  64 << 10,  64, 0) },
 145     { INFO("mx25l6405d",  0xc22017,      0,  64 << 10, 128, 0) },
 146     { INFO("mx25l12805d", 0xc22018,      0,  64 << 10, 256, 0) },
 147     { INFO("mx25l12855e", 0xc22618,      0,  64 << 10, 256, 0) },
 148     { INFO("mx25l25635e", 0xc22019,      0,  64 << 10, 512, 0) },
 149     { INFO("mx25l25655e", 0xc22619,      0,  64 << 10, 512, 0) },
 150
 151     /* Micron */
 152     { INFO("n25q032a11",  0x20bb16,      0,  64 << 10,  64, ER_4K) },
 153     { INFO("n25q032a13",  0x20ba16,      0,  64 << 10,  64, ER_4K) },
 154     { INFO("n25q064a11",  0x20bb17,      0,  64 << 10, 128, ER_4K) },
 155     { INFO("n25q064a13",  0x20ba17,      0,  64 << 10, 128, ER_4K) },
 156     { INFO("n25q128a11",  0x20bb18,      0,  64 << 10, 256, ER_4K) },
 157     { INFO("n25q128a13",  0x20ba18,      0,  64 << 10, 256, ER_4K) },
 158     { INFO("n25q256a11",  0x20bb19,      0,  64 << 10, 512, ER_4K) },
 159     { INFO("n25q256a13",  0x20ba19,      0,  64 << 10, 512, ER_4K) },
 160
 161     /* Spansion -- single (large) sector size only, at least
 162      * for the chips listed here (without boot sectors).
 163      */
 164     { INFO("s25sl032p",   0x010215, 0x4d00,  64 << 10,  64, ER_4K) },
 165     { INFO("s25sl064p",   0x010216, 0x4d00,  64 << 10, 128, ER_4K) },
 166     { INFO("s25fl256s0",  0x010219, 0x4d00, 256 << 10, 128, 0) },
 167     { INFO("s25fl256s1",  0x010219, 0x4d01,  64 << 10, 512, 0) },
 168     { INFO("s25fl512s",   0x010220, 0x4d00, 256 << 10, 256, 0) },
 169     { INFO("s70fl01gs",   0x010221, 0x4d00, 256 << 10, 256, 0) },
 170     { INFO("s25sl12800",  0x012018, 0x0300, 256 << 10,  64, 0) },
 171     { INFO("s25sl12801",  0x012018, 0x0301,  64 << 10, 256, 0) },
 172     { INFO("s25fl129p0",  0x012018, 0x4d00, 256 << 10,  64, 0) },
 173     { INFO("s25fl129p1",  0x012018, 0x4d01,  64 << 10, 256, 0) },
 174     { INFO("s25sl004a",   0x010212,      0,  64 << 10,   8, 0) },
 175     { INFO("s25sl008a",   0x010213,      0,  64 << 10,  16, 0) },
 176     { INFO("s25sl016a",   0x010214,      0,  64 << 10,  32, 0) },
 177     { INFO("s25sl032a",   0x010215,      0,  64 << 10,  64, 0) },
 178     { INFO("s25sl064a",   0x010216,      0,  64 << 10, 128, 0) },
 179     { INFO("s25fl016k",   0xef4015,      0,  64 << 10,  32, ER_4K | ER_32K) },
 180     { INFO("s25fl064k",   0xef4017,      0,  64 << 10, 128, ER_4K | ER_32K) },
 181
 182     /* SST -- large erase sizes are "overlays", "sectors" are 4<< 10 */
 183     { INFO("sst25vf040b", 0xbf258d,      0,  64 << 10,   8, ER_4K) },
 184     { INFO("sst25vf080b", 0xbf258e,      0,  64 << 10,  16, ER_4K) },
 185     { INFO("sst25vf016b", 0xbf2541,      0,  64 << 10,  32, ER_4K) },
 186     { INFO("sst25vf032b", 0xbf254a,      0,  64 << 10,  64, ER_4K) },
 187     { INFO("sst25wf512",  0xbf2501,      0,  64 << 10,   1, ER_4K) },
 188     { INFO("sst25wf010",  0xbf2502,      0,  64 << 10,   2, ER_4K) },
 189     { INFO("sst25wf020",  0xbf2503,      0,  64 << 10,   4, ER_4K) },
 190     { INFO("sst25wf040",  0xbf2504,      0,  64 << 10,   8, ER_4K) },
 191     { INFO("sst25wf080",  0xbf2505,      0,  64 << 10,  16, ER_4K) },
 192
 193     /* ST Microelectronics -- newer production may have feature updates */
 194     { INFO("m25p05",      0x202010,      0,  32 << 10,   2, 0) },
 195     { INFO("m25p10",      0x202011,      0,  32 << 10,   4, 0) },
 196     { INFO("m25p20",      0x202012,      0,  64 << 10,   4, 0) },
 197     { INFO("m25p40",      0x202013,      0,  64 << 10,   8, 0) },
 198     { INFO("m25p80",      0x202014,      0,  64 << 10,  16, 0) },
 199     { INFO("m25p16",      0x202015,      0,  64 << 10,  32, 0) },
 200     { INFO("m25p32",      0x202016,      0,  64 << 10,  64, 0) },
 201     { INFO("m25p64",      0x202017,      0,  64 << 10, 128, 0) },
 202     { INFO("m25p128",     0x202018,      0, 256 << 10,  64, 0) },
 203     { INFO("n25q032",     0x20ba16,      0,  64 << 10,  64, 0) },
 204
 205     { INFO("m45pe10",     0x204011,      0,  64 << 10,   2, 0) },
 206     { INFO("m45pe80",     0x204014,      0,  64 << 10,  16, 0) },
 207     { INFO("m45pe16",     0x204015,      0,  64 << 10,  32, 0) },
 208
 209     { INFO("m25pe20",     0x208012,      0,  64 << 10,   4, 0) },
 210     { INFO("m25pe80",     0x208014,      0,  64 << 10,  16, 0) },
 211     { INFO("m25pe16",     0x208015,      0,  64 << 10,  32, ER_4K) },
 212
 213     { INFO("m25px32",     0x207116,      0,  64 << 10,  64, ER_4K) },
 214     { INFO("m25px32-s0",  0x207316,      0,  64 << 10,  64, ER_4K) },
 215     { INFO("m25px32-s1",  0x206316,      0,  64 << 10,  64, ER_4K) },
 216     { INFO("m25px64",     0x207117,      0,  64 << 10, 128, 0) },
 217
 218     /* Winbond -- w25x "blocks" are 64k, "sectors" are 4KiB */
 219     { INFO("w25x10",      0xef3011,      0,  64 << 10,   2, ER_4K) },
 220     { INFO("w25x20",      0xef3012,      0,  64 << 10,   4, ER_4K) },
 221     { INFO("w25x40",      0xef3013,      0,  64 << 10,   8, ER_4K) },
 222     { INFO("w25x80",      0xef3014,      0,  64 << 10,  16, ER_4K) },
 223     { INFO("w25x16",      0xef3015,      0,  64 << 10,  32, ER_4K) },
 224     { INFO("w25x32",      0xef3016,      0,  64 << 10,  64, ER_4K) },
 225     { INFO("w25q32",      0xef4016,      0,  64 << 10,  64, ER_4K) },
 226     { INFO("w25q32dw",    0xef6016,      0,  64 << 10,  64, ER_4K) },
 227     { INFO("w25x64",      0xef3017,      0,  64 << 10, 128, ER_4K) },
 228     { INFO("w25q64",      0xef4017,      0,  64 << 10, 128, ER_4K) },
 229     { INFO("w25q80",      0xef5014,      0,  64 << 10,  16, ER_4K) },
 230     { INFO("w25q80bl",    0xef4014,      0,  64 << 10,  16, ER_4K) },
 231     { INFO("w25q256",     0xef4019,      0,  64 << 10, 512, ER_4K) },
 232
 233     /* Numonyx -- n25q128 */
 234     { INFO("n25q128",      0x20ba18,      0,  64 << 10, 256, 0) },
 235 };
 236
 237 typedef enum {
 238     NOP = 0,
 239     WRSR = 0x1,
 240     WRDI = 0x4,
 241     RDSR = 0x5,
 242     WREN = 0x6,
 243     JEDEC_READ = 0x9f,
 244     BULK_ERASE = 0xc7,
 245
 246     READ = 0x03,
 247     READ4 = 0x13,
 248     FAST_READ = 0x0b,
 249     FAST_READ4 = 0x0c,
 250     DOR = 0x3b,
 251     DOR4 = 0x3c,
 252     QOR = 0x6b,
 253     QOR4 = 0x6c,
 254     DIOR = 0xbb,
 255     DIOR4 = 0xbc,
 256     QIOR = 0xeb,
 257     QIOR4 = 0xec,
 258
 259     PP = 0x02,
 260     PP4 = 0x12,
 261     DPP = 0xa2,
 262     QPP = 0x32,
 263
 264     ERASE_4K = 0x20,
 265     ERASE4_4K = 0x21,
 266     ERASE_32K = 0x52,
 267     ERASE_SECTOR = 0xd8,
 268     ERASE4_SECTOR = 0xdc,
 269
 270     EN_4BYTE_ADDR = 0xB7,
 271     EX_4BYTE_ADDR = 0xE9,
 272
 273     EXTEND_ADDR_READ = 0xC8,
 274     EXTEND_ADDR_WRITE = 0xC5,
 275
 276     RESET_ENABLE = 0x66,
 277     RESET_MEMORY = 0x99,
 278
 279     RNVCR = 0xB5,
 280     WNVCR = 0xB1,
 281
 282     RVCR = 0x85,
 283     WVCR = 0x81,
 284
 285     REVCR = 0x65,
 286     WEVCR = 0x61,
 287 } FlashCMD;
 288
 289 typedef enum {
 290     STATE_IDLE,
 291     STATE_PAGE_PROGRAM,
 292     STATE_READ,
 293     STATE_COLLECTING_DATA,
 294     STATE_READING_DATA,
 295 } CMDState;
 296
 297 typedef struct Flash {
 298     SSISlave parent_obj;
 299
 300     BlockBackend *blk;
 301
 302     uint8_t *storage;
 303     uint32_t size;
 304     int page_size;
 305
 306     uint8_t state;
 307     uint8_t data[16];
 308     uint32_t len;
 309     uint32_t pos;
 310     uint8_t needed_bytes;
 311     uint8_t cmd_in_progress;
 312     uint64_t cur_addr;
 313     uint32_t nonvolatile_cfg;
 314     uint32_t volatile_cfg;
 315     uint32_t enh_volatile_cfg;
 316     bool write_enable;
 317     bool four_bytes_address_mode;
 318     bool reset_enable;
 319     uint8_t ear;
 320
 321     int64_t dirty_page;
 322
 323     const FlashPartInfo *pi;
 324
 325 } Flash;
 326
 327 typedef struct M25P80Class {
 328     SSISlaveClass parent_class;
 329     FlashPartInfo *pi;
 330 } M25P80Class;
 331
 332 #define TYPE_M25P80 "m25p80-generic"
 333 #define M25P80(obj) \
 334      OBJECT_CHECK(Flash, (obj), TYPE_M25P80)
 335 #define M25P80_CLASS(klass) \
 336      OBJECT_CLASS_CHECK(M25P80Class, (klass), TYPE_M25P80)
 337 #define M25P80_GET_CLASS(obj) \
 338      OBJECT_GET_CLASS(M25P80Class, (obj), TYPE_M25P80)
 339
 340 static void blk_sync_complete(void *opaque, int ret)
 341 {
 342     /* do nothing. Masters do not directly interact with the backing store,
 343      * only the working copy so no mutexing required.
 344      */
 345 }
 346
 347 static void flash_sync_page(Flash *s, int page)
 348 {
 349     int blk_sector, nb_sectors;
 350     QEMUIOVector iov;
 351
 352     if (!s->blk || blk_is_read_only(s->blk)) {
 353         return;
 354     }
 355
 356     blk_sector = (page * s->pi->page_size) / BDRV_SECTOR_SIZE;
 357     nb_sectors = DIV_ROUND_UP(s->pi->page_size, BDRV_SECTOR_SIZE);
 358     qemu_iovec_init(&iov, 1);
 359     qemu_iovec_add(&iov, s->storage + blk_sector * BDRV_SECTOR_SIZE,
 360                    nb_sectors * BDRV_SECTOR_SIZE);
 361     blk_aio_writev(s->blk, blk_sector, &iov, nb_sectors, blk_sync_complete,
 362                    NULL);
 363 }
 364
 365 static inline void flash_sync_area(Flash *s, int64_t off, int64_t len)
 366 {
 367     int64_t start, end, nb_sectors;
 368     QEMUIOVector iov;
 369
 370     if (!s->blk || blk_is_read_only(s->blk)) {
 371         return;
 372     }
 373
 374     assert(!(len % BDRV_SECTOR_SIZE));
 375     start = off / BDRV_SECTOR_SIZE;
 376     end = (off + len) / BDRV_SECTOR_SIZE;
 377     nb_sectors = end - start;
 378     qemu_iovec_init(&iov, 1);
 379     qemu_iovec_add(&iov, s->storage + (start * BDRV_SECTOR_SIZE),
 380                                         nb_sectors * BDRV_SECTOR_SIZE);
 381     blk_aio_writev(s->blk, start, &iov, nb_sectors, blk_sync_complete, NULL);
 382 }
 383
 384 static void flash_erase(Flash *s, int offset, FlashCMD cmd)
 385 {
 386     uint32_t len;
 387     uint8_t capa_to_assert = 0;
 388
 389     switch (cmd) {
 390     case ERASE_4K:
 391     case ERASE4_4K:
 392         len = 4 << 10;
 393         capa_to_assert = ER_4K;
 394         break;
 395     case ERASE_32K:
 396         len = 32 << 10;
 397         capa_to_assert = ER_32K;
 398         break;
 399     case ERASE_SECTOR:
 400     case ERASE4_SECTOR:
 401         len = s->pi->sector_size;
 402         break;
 403     case BULK_ERASE:
 404         len = s->size;
 405         break;
 406     default:
 407         abort();
 408     }
 409
 410     DB_PRINT_L(0, "offset = %#x, len = %d\n", offset, len);
 411     if ((s->pi->flags & capa_to_assert) != capa_to_assert) {
 412         qemu_log_mask(LOG_GUEST_ERROR, "M25P80: %d erase size not supported by"
 413                       " device\n", len);
 414     }
 415
 416     if (!s->write_enable) {
 417         qemu_log_mask(LOG_GUEST_ERROR, "M25P80: erase with write protect!\n");
 418         return;
 419     }
 420     memset(s->storage + offset, 0xff, len);
 421     flash_sync_area(s, offset, len);
 422 }
 423
 424 static inline void flash_sync_dirty(Flash *s, int64_t newpage)
 425 {
 426     if (s->dirty_page >= 0 && s->dirty_page != newpage) {
 427         flash_sync_page(s, s->dirty_page);
 428         s->dirty_page = newpage;
 429     }
 430 }
 431
 432 static inline
 433 void flash_write8(Flash *s, uint64_t addr, uint8_t data)
 434 {
 435     int64_t page = addr / s->pi->page_size;
 436     uint8_t prev = s->storage[s->cur_addr];
 437
 438     if (!s->write_enable) {
 439         qemu_log_mask(LOG_GUEST_ERROR, "M25P80: write with write protect!\n");
 440     }
 441
 442     if ((prev ^ data) & data) {
 443         DB_PRINT_L(1, "programming zero to one! addr=%" PRIx64 "  %" PRIx8
 444                    " -> %" PRIx8 "\n", addr, prev, data);
 445     }
 446
 447     if (s->pi->flags & WR_1) {
 448         s->storage[s->cur_addr] = data;
 449     } else {
 450         s->storage[s->cur_addr] &= data;
 451     }
 452
 453     flash_sync_dirty(s, page);
 454     s->dirty_page = page;
 455 }
 456
 457 static inline int get_addr_length(Flash *s)
 458 {
 459    switch (s->cmd_in_progress) {
 460    case PP4:
 461    case READ4:
 462    case QIOR4:
 463    case ERASE4_4K:
 464    case ERASE4_SECTOR:
 465    case FAST_READ4:
 466    case DOR4:
 467    case QOR4:
 468    case DIOR4:
 469        return 4;
 470    default:
 471        return s->four_bytes_address_mode ? 4 : 3;
 472    }
 473 }
 474
 475 static void complete_collecting_data(Flash *s)
 476 {
 477     int i;
 478
 479     s->cur_addr = 0;
 480
 481     for (i = 0; i < get_addr_length(s); ++i) {
 482         s->cur_addr <<= 8;
 483         s->cur_addr |= s->data[i];
 484     }
 485
 486     if (get_addr_length(s) == 3) {
 487         s->cur_addr += (s->ear & 0x3) * MAX_3BYTES_SIZE;
 488     }
 489
 490     s->state = STATE_IDLE;
 491
 492     switch (s->cmd_in_progress) {
 493     case DPP:
 494     case QPP:
 495     case PP:
 496     case PP4:
 497         s->state = STATE_PAGE_PROGRAM;
 498         break;
 499     case READ:
 500     case READ4:
 501     case FAST_READ:
 502     case FAST_READ4:
 503     case DOR:
 504     case DOR4:
 505     case QOR:
 506     case QOR4:
 507     case DIOR:
 508     case DIOR4:
 509     case QIOR:
 510     case QIOR4:
 511         s->state = STATE_READ;
 512         break;
 513     case ERASE_4K:
 514     case ERASE4_4K:
 515     case ERASE_32K:
 516     case ERASE_SECTOR:
 517     case ERASE4_SECTOR:
 518         flash_erase(s, s->cur_addr, s->cmd_in_progress);
 519         break;
 520     case WRSR:
 521         if (s->write_enable) {
 522             s->write_enable = false;
 523         }
 524         break;
 525     case EXTEND_ADDR_WRITE:
 526         s->ear = s->data[0];
 527         break;
 528     case WNVCR:
 529         s->nonvolatile_cfg = s->data[0] | (s->data[1] << 8);
 530         break;
 531     case WVCR:
 532         s->volatile_cfg = s->data[0];
 533         break;
 534     case WEVCR:
 535         s->enh_volatile_cfg = s->data[0];
 536         break;
 537     default:
 538         break;
 539     }
 540 }
 541
 542 static void reset_memory(Flash *s)
 543 {
 544     s->cmd_in_progress = NOP;
 545     s->cur_addr = 0;
 546     s->ear = 0;
 547     s->four_bytes_address_mode = false;
 548     s->len = 0;
 549     s->needed_bytes = 0;
 550     s->pos = 0;
 551     s->state = STATE_IDLE;
 552     s->write_enable = false;
 553     s->reset_enable = false;
 554
 555     if (((s->pi->jedec >> 16) & 0xFF) == JEDEC_NUMONYX) {
 556         s->volatile_cfg = 0;
 557         s->volatile_cfg |= VCFG_DUMMY;
 558         s->volatile_cfg |= VCFG_WRAP_SEQUENTIAL;
 559         if ((s->nonvolatile_cfg & NVCFG_XIP_MODE_MASK)
 560                                 != NVCFG_XIP_MODE_DISABLED) {
 561             s->volatile_cfg |= VCFG_XIP_MODE_ENABLED;
 562         }
 563         s->volatile_cfg |= deposit32(s->volatile_cfg,
 564                             VCFG_DUMMY_CLK_POS,
 565                             CFG_DUMMY_CLK_LEN,
 566                             extract32(s->nonvolatile_cfg,
 567                                         NVCFG_DUMMY_CLK_POS,
 568                                         CFG_DUMMY_CLK_LEN)
 569                             );
 570
 571         s->enh_volatile_cfg = 0;
 572         s->enh_volatile_cfg |= EVCFG_OUT_DRIVER_STRENGHT_DEF;
 573         s->enh_volatile_cfg |= EVCFG_VPP_ACCELERATOR;
 574         s->enh_volatile_cfg |= EVCFG_RESET_HOLD_ENABLED;
 575         if (s->nonvolatile_cfg & NVCFG_DUAL_IO_MASK) {
 576             s->enh_volatile_cfg |= EVCFG_DUAL_IO_ENABLED;
 577         }
 578         if (s->nonvolatile_cfg & NVCFG_QUAD_IO_MASK) {
 579             s->enh_volatile_cfg |= EVCFG_QUAD_IO_ENABLED;
 580         }
 581         if (!(s->nonvolatile_cfg & NVCFG_4BYTE_ADDR_MASK)) {
 582             s->four_bytes_address_mode = true;
 583         }
 584         if (!(s->nonvolatile_cfg & NVCFG_LOWER_SEGMENT_MASK)) {
 585             s->ear = CFG_UPPER_128MB_SEG_ENABLED;
 586         }
 587     }
 588
 589     DB_PRINT_L(0, "Reset done.\n");
 590 }
 591
 592 static void decode_new_cmd(Flash *s, uint32_t value)
 593 {
 594     s->cmd_in_progress = value;
 595     DB_PRINT_L(0, "decoded new command:%x\n", value);
 596
 597     if (value != RESET_MEMORY) {
 598         s->reset_enable = false;
 599     }
 600
 601     switch (value) {
 602
 603     case ERASE_4K:
 604     case ERASE4_4K:
 605     case ERASE_32K:
 606     case ERASE_SECTOR:
 607     case ERASE4_SECTOR:
 608     case READ:
 609     case READ4:
 610     case DPP:
 611     case QPP:
 612     case PP:
 613     case PP4:
 614         s->needed_bytes = get_addr_length(s);
 615         s->pos = 0;
 616         s->len = 0;
 617         s->state = STATE_COLLECTING_DATA;
 618         break;
 619
 620     case FAST_READ:
 621     case FAST_READ4:
 622     case DOR:
 623     case DOR4:
 624     case QOR:
 625     case QOR4:
 626         s->needed_bytes = get_addr_length(s);
 627         if (((s->pi->jedec >> 16) & 0xFF) == JEDEC_NUMONYX) {
 628             /* Dummy cycles modeled with bytes writes instead of bits */
 629             s->needed_bytes += extract32(s->volatile_cfg, 4, 4);
 630         }
 631         s->pos = 0;
 632         s->len = 0;
 633         s->state = STATE_COLLECTING_DATA;
 634         break;
 635
 636     case DIOR:
 637     case DIOR4:
 638         switch ((s->pi->jedec >> 16) & 0xFF) {
 639         case JEDEC_WINBOND:
 640         case JEDEC_SPANSION:
 641             s->needed_bytes = 4;
 642             break;
 643         default:
 644             s->needed_bytes = get_addr_length(s);
 645             /* Dummy cycles modeled with bytes writes instead of bits */
 646             s->needed_bytes += extract32(s->volatile_cfg, 4, 4);
 647         }
 648         s->pos = 0;
 649         s->len = 0;
 650         s->state = STATE_COLLECTING_DATA;
 651         break;
 652
 653     case QIOR:
 654     case QIOR4:
 655         switch ((s->pi->jedec >> 16) & 0xFF) {
 656         case JEDEC_WINBOND:
 657         case JEDEC_SPANSION:
 658             s->needed_bytes = 6;
 659             break;
 660         default:
 661             s->needed_bytes = get_addr_length(s);
 662             /* Dummy cycles modeled with bytes writes instead of bits */
 663             s->needed_bytes += extract32(s->volatile_cfg, 4, 4);
 664         }
 665         s->pos = 0;
 666         s->len = 0;
 667         s->state = STATE_COLLECTING_DATA;
 668         break;
 669
 670     case WRSR:
 671         if (s->write_enable) {
 672             s->needed_bytes = 1;
 673             s->pos = 0;
 674             s->len = 0;
 675             s->state = STATE_COLLECTING_DATA;
 676         }
 677         break;
 678
 679     case WRDI:
 680         s->write_enable = false;
 681         break;
 682     case WREN:
 683         s->write_enable = true;
 684         break;
 685
 686     case RDSR:
 687         s->data[0] = (!!s->write_enable) << 1;
 688         s->pos = 0;
 689         s->len = 1;
 690         s->state = STATE_READING_DATA;
 691         break;
 692
 693     case JEDEC_READ:
 694         DB_PRINT_L(0, "populated jedec code\n");
 695         s->data[0] = (s->pi->jedec >> 16) & 0xff;
 696         s->data[1] = (s->pi->jedec >> 8) & 0xff;
 697         s->data[2] = s->pi->jedec & 0xff;
 698         if (s->pi->ext_jedec) {
 699             s->data[3] = (s->pi->ext_jedec >> 8) & 0xff;
 700             s->data[4] = s->pi->ext_jedec & 0xff;
 701             s->len = 5;
 702         } else {
 703             s->len = 3;
 704         }
 705         s->pos = 0;
 706         s->state = STATE_READING_DATA;
 707         break;
 708
 709     case BULK_ERASE:
 710         if (s->write_enable) {
 711             DB_PRINT_L(0, "chip erase\n");
 712             flash_erase(s, 0, BULK_ERASE);
 713         } else {
 714             qemu_log_mask(LOG_GUEST_ERROR, "M25P80: chip erase with write "
 715                           "protect!\n");
 716         }
 717         break;
 718     case NOP:
 719         break;
 720     case EN_4BYTE_ADDR:
 721         s->four_bytes_address_mode = true;
 722         break;
 723     case EX_4BYTE_ADDR:
 724         s->four_bytes_address_mode = false;
 725         break;
 726     case EXTEND_ADDR_READ:
 727         s->data[0] = s->ear;
 728         s->pos = 0;
 729         s->len = 1;
 730         s->state = STATE_READING_DATA;
 731         break;
 732     case EXTEND_ADDR_WRITE:
 733         if (s->write_enable) {
 734             s->needed_bytes = 1;
 735             s->pos = 0;
 736             s->len = 0;
 737             s->state = STATE_COLLECTING_DATA;
 738         }
 739         break;
 740     case RNVCR:
 741         s->data[0] = s->nonvolatile_cfg & 0xFF;
 742         s->data[1] = (s->nonvolatile_cfg >> 8) & 0xFF;
 743         s->pos = 0;
 744         s->len = 2;
 745         s->state = STATE_READING_DATA;
 746         break;
 747     case WNVCR:
 748         if (s->write_enable) {
 749             s->needed_bytes = 2;
 750             s->pos = 0;
 751             s->len = 0;
 752             s->state = STATE_COLLECTING_DATA;
 753         }
 754         break;
 755     case RVCR:
 756         s->data[0] = s->volatile_cfg & 0xFF;
 757         s->pos = 0;
 758         s->len = 1;
 759         s->state = STATE_READING_DATA;
 760         break;
 761     case WVCR:
 762         if (s->write_enable) {
 763             s->needed_bytes = 1;
 764             s->pos = 0;
 765             s->len = 0;
 766             s->state = STATE_COLLECTING_DATA;
 767         }
 768         break;
 769     case REVCR:
 770         s->data[0] = s->enh_volatile_cfg & 0xFF;
 771         s->pos = 0;
 772         s->len = 1;
 773         s->state = STATE_READING_DATA;
 774         break;
 775     case WEVCR:
 776         if (s->write_enable) {
 777             s->needed_bytes = 1;
 778             s->pos = 0;
 779             s->len = 0;
 780             s->state = STATE_COLLECTING_DATA;
 781         }
 782         break;
 783     case RESET_ENABLE:
 784         s->reset_enable = true;
 785         break;
 786     case RESET_MEMORY:
 787         if (s->reset_enable) {
 788             reset_memory(s);
 789         }
 790         break;
 791     default:
 792         qemu_log_mask(LOG_GUEST_ERROR, "M25P80: Unknown cmd %x\n", value);
 793         break;
 794     }
 795 }
 796
 797 static int m25p80_cs(SSISlave *ss, bool select)
 798 {
 799     Flash *s = M25P80(ss);
 800
 801     if (select) {
 802         s->len = 0;
 803         s->pos = 0;
 804         s->state = STATE_IDLE;
 805         flash_sync_dirty(s, -1);
 806     }
 807
 808     DB_PRINT_L(0, "%sselect\n", select ? "de" : "");
 809
 810     return 0;
 811 }
 812
 813 static uint32_t m25p80_transfer8(SSISlave *ss, uint32_t tx)
 814 {
 815     Flash *s = M25P80(ss);
 816     uint32_t r = 0;
 817
 818     switch (s->state) {
 819
 820     case STATE_PAGE_PROGRAM:
 821         DB_PRINT_L(1, "page program cur_addr=%#" PRIx64 " data=%" PRIx8 "\n",
 822                    s->cur_addr, (uint8_t)tx);
 823         flash_write8(s, s->cur_addr, (uint8_t)tx);
 824         s->cur_addr++;
 825         break;
 826
 827     case STATE_READ:
 828         r = s->storage[s->cur_addr];
 829         DB_PRINT_L(1, "READ 0x%" PRIx64 "=%" PRIx8 "\n", s->cur_addr,
 830                    (uint8_t)r);
 831         s->cur_addr = (s->cur_addr + 1) % s->size;
 832         break;
 833
 834     case STATE_COLLECTING_DATA:
 835         s->data[s->len] = (uint8_t)tx;
 836         s->len++;
 837
 838         if (s->len == s->needed_bytes) {
 839             complete_collecting_data(s);
 840         }
 841         break;
 842
 843     case STATE_READING_DATA:
 844         r = s->data[s->pos];
 845         s->pos++;
 846         if (s->pos == s->len) {
 847             s->pos = 0;
 848             s->state = STATE_IDLE;
 849         }
 850         break;
 851
 852     default:
 853     case STATE_IDLE:
 854         decode_new_cmd(s, (uint8_t)tx);
 855         break;
 856     }
 857
 858     return r;
 859 }
 860
 861 static int m25p80_init(SSISlave *ss)
 862 {
 863     DriveInfo *dinfo;
 864     Flash *s = M25P80(ss);
 865     M25P80Class *mc = M25P80_GET_CLASS(s);
 866
 867     s->pi = mc->pi;
 868
 869     s->size = s->pi->sector_size * s->pi->n_sectors;
 870     s->dirty_page = -1;
 871
 872     /* FIXME use a qdev drive property instead of drive_get_next() */
 873     dinfo = drive_get_next(IF_MTD);
 874
 875     if (dinfo) {
 876         DB_PRINT_L(0, "Binding to IF_MTD drive\n");
 877         s->blk = blk_by_legacy_dinfo(dinfo);
 878         blk_attach_dev_nofail(s->blk, s);
 879
 880         s->storage = blk_blockalign(s->blk, s->size);
 881
 882         /* FIXME: Move to late init */
 883         if (blk_read(s->blk, 0, s->storage,
 884                      DIV_ROUND_UP(s->size, BDRV_SECTOR_SIZE))) {
 885             fprintf(stderr, "Failed to initialize SPI flash!\n");
 886             return 1;
 887         }
 888     } else {
 889         DB_PRINT_L(0, "No BDRV - binding to RAM\n");
 890         s->storage = blk_blockalign(NULL, s->size);
 891         memset(s->storage, 0xFF, s->size);
 892     }
 893
 894     return 0;
 895 }
 896
 897 static void m25p80_reset(DeviceState *d)
 898 {
 899     Flash *s = M25P80(d);
 900
 901     reset_memory(s);
 902 }
 903
 904 static void m25p80_pre_save(void *opaque)
 905 {
 906     flash_sync_dirty((Flash *)opaque, -1);
 907 }
 908
 909 static Property m25p80_properties[] = {
 910     DEFINE_PROP_UINT32("nonvolatile-cfg", Flash, nonvolatile_cfg, 0x8FFF),
 911     DEFINE_PROP_END_OF_LIST(),
 912 };
 913
 914 static const VMStateDescription vmstate_m25p80 = {
 915     .name = "xilinx_spi",
 916     .version_id = 2,
 917     .minimum_version_id = 1,
 918     .pre_save = m25p80_pre_save,
 919     .fields = (VMStateField[]) {
 920         VMSTATE_UINT8(state, Flash),
 921         VMSTATE_UINT8_ARRAY(data, Flash, 16),
 922         VMSTATE_UINT32(len, Flash),
 923         VMSTATE_UINT32(pos, Flash),
 924         VMSTATE_UINT8(needed_bytes, Flash),
 925         VMSTATE_UINT8(cmd_in_progress, Flash),
 926         VMSTATE_UINT64(cur_addr, Flash),
 927         VMSTATE_BOOL(write_enable, Flash),
 928         VMSTATE_BOOL_V(reset_enable, Flash, 2),
 929         VMSTATE_UINT8_V(ear, Flash, 2),
 930         VMSTATE_BOOL_V(four_bytes_address_mode, Flash, 2),
 931         VMSTATE_UINT32_V(nonvolatile_cfg, Flash, 2),
 932         VMSTATE_UINT32_V(volatile_cfg, Flash, 2),
 933         VMSTATE_UINT32_V(enh_volatile_cfg, Flash, 2),
 934         VMSTATE_END_OF_LIST()
 935     }
 936 };
 937
 938 static void m25p80_class_init(ObjectClass *klass, void *data)
 939 {
 940     DeviceClass *dc = DEVICE_CLASS(klass);
 941     SSISlaveClass *k = SSI_SLAVE_CLASS(klass);
 942     M25P80Class *mc = M25P80_CLASS(klass);
 943
 944     k->init = m25p80_init;
 945     k->transfer = m25p80_transfer8;
 946     k->set_cs = m25p80_cs;
 947     k->cs_polarity = SSI_CS_LOW;
 948     dc->vmsd = &vmstate_m25p80;
 949     dc->props = m25p80_properties;
 950     dc->reset = m25p80_reset;
 951     mc->pi = data;
 952 }
 953
 954 static const TypeInfo m25p80_info = {
 955     .name           = TYPE_M25P80,
 956     .parent         = TYPE_SSI_SLAVE,
 957     .instance_size  = sizeof(Flash),
 958     .class_size     = sizeof(M25P80Class),
 959     .abstract       = true,
 960 };
 961
 962 static void m25p80_register_types(void)
 963 {
 964     int i;
 965
 966     type_register_static(&m25p80_info);
 967     for (i = 0; i < ARRAY_SIZE(known_devices); ++i) {
 968         TypeInfo ti = {
 969             .name       = known_devices[i].part_name,
 970             .parent     = TYPE_M25P80,
 971             .class_init = m25p80_class_init,
 972             .class_data = (void *)&known_devices[i],
 973         };
 974         type_register(&ti);
 975     }
 976 }
 977
 978 type_init(m25p80_register_types)