hw/pflash_cfi02.c

   1 /*
   2  *  CFI parallel flash with AMD command set emulation
   3  *
   4  *  Copyright (c) 2005 Jocelyn Mayer
   5  *
   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.
  10  *
  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.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 /*
  22  * For now, this code can emulate flashes of 1, 2 or 4 bytes width.
  23  * Supported commands/modes are:
  24  * - flash read
  25  * - flash write
  26  * - flash ID read
  27  * - sector erase
  28  * - chip erase
  29  * - unlock bypass command
  30  * - CFI queries
  31  *
  32  * It does not support flash interleaving.
  33  * It does not implement boot blocs with reduced size
  34  * It does not implement software data protection as found in many real chips
  35  * It does not implement erase suspend/resume commands
  36  * It does not implement multiple sectors erase
  37  */
  38
  39 #include "vl.h"
  40
  41 //#define PFLASH_DEBUG
  42 #ifdef PFLASH_DEBUG
  43 #define DPRINTF(fmt, args...)                      \
  44 do {                                               \
  45         printf("PFLASH: " fmt , ##args);           \
  46 } while (0)
  47 #else
  48 #define DPRINTF(fmt, args...) do { } while (0)
  49 #endif
  50
  51 struct pflash_t {
  52     BlockDriverState *bs;
  53     target_ulong base;
  54     target_ulong sector_len;
  55     target_ulong total_len;
  56     int width;
  57     int wcycle; /* if 0, the flash is read normally */
  58     int bypass;
  59     int ro;
  60     uint8_t cmd;
  61     uint8_t status;
  62     uint16_t ident[4];
  63     uint8_t cfi_len;
  64     uint8_t cfi_table[0x52];
  65     QEMUTimer *timer;
  66     ram_addr_t off;
  67     int fl_mem;
  68     void *storage;
  69 };
  70
  71 static void pflash_timer (void *opaque)
  72 {
  73     pflash_t *pfl = opaque;
  74
  75     DPRINTF("%s: command %02x done\n", __func__, pfl->cmd);
  76     /* Reset flash */
  77     pfl->status ^= 0x80;
  78     if (pfl->bypass) {
  79         pfl->wcycle = 2;
  80     } else {
  81         cpu_register_physical_memory(pfl->base, pfl->total_len,
  82                                      pfl->off | IO_MEM_ROMD | pfl->fl_mem);
  83         pfl->wcycle = 0;
  84     }
  85     pfl->cmd = 0;
  86 }
  87
  88 static uint32_t pflash_read (pflash_t *pfl, target_ulong offset, int width)
  89 {
  90     target_ulong boff;
  91     uint32_t ret;
  92     uint8_t *p;
  93
  94     DPRINTF("%s: offset " TARGET_FMT_lx "\n", __func__, offset);
  95     ret = -1;
  96     offset -= pfl->base;
  97     boff = offset & 0xFF;
  98     if (pfl->width == 2)
  99         boff = boff >> 1;
 100     else if (pfl->width == 4)
 101         boff = boff >> 2;
 102     switch (pfl->cmd) {
 103     default:
 104         /* This should never happen : reset state & treat it as a read*/
 105         DPRINTF("%s: unknown command state: %x\n", __func__, pfl->cmd);
 106         pfl->wcycle = 0;
 107         pfl->cmd = 0;
 108     case 0x80:
 109         /* We accept reads during second unlock sequence... */
 110     case 0x00:
 111     flash_read:
 112         /* Flash area read */
 113         p = pfl->storage;
 114         switch (width) {
 115         case 1:
 116             ret = p[offset];
 117 //            DPRINTF("%s: data offset %08x %02x\n", __func__, offset, ret);
 118             break;
 119         case 2:
 120 #if defined(TARGET_WORDS_BIGENDIAN)
 121             ret = p[offset] << 8;
 122             ret |= p[offset + 1];
 123 #else
 124             ret = p[offset];
 125             ret |= p[offset + 1] << 8;
 126 #endif
 127 //            DPRINTF("%s: data offset %08x %04x\n", __func__, offset, ret);
 128             break;
 129         case 4:
 130 #if defined(TARGET_WORDS_BIGENDIAN)
 131             ret = p[offset] << 24;
 132             ret |= p[offset + 1] << 16;
 133             ret |= p[offset + 2] << 8;
 134             ret |= p[offset + 3];
 135 #else
 136             ret = p[offset];
 137             ret |= p[offset + 1] << 8;
 138             ret |= p[offset + 2] << 16;
 139             ret |= p[offset + 3] << 24;
 140 #endif
 141 //            DPRINTF("%s: data offset %08x %08x\n", __func__, offset, ret);
 142             break;
 143         }
 144         break;
 145     case 0x90:
 146         /* flash ID read */
 147         switch (boff) {
 148         case 0x00:
 149         case 0x01:
 150             ret = pfl->ident[boff & 0x01];
 151             break;
 152         case 0x02:
 153             ret = 0x00; /* Pretend all sectors are unprotected */
 154             break;
 155         case 0x0E:
 156         case 0x0F:
 157             if (pfl->ident[2 + (boff & 0x01)] == (uint8_t)-1)
 158                 goto flash_read;
 159             ret = pfl->ident[2 + (boff & 0x01)];
 160             break;
 161         default:
 162             goto flash_read;
 163         }
 164         DPRINTF("%s: ID " TARGET_FMT_ld " %x\n", __func__, boff, ret);
 165         break;
 166     case 0xA0:
 167     case 0x10:
 168     case 0x30:
 169         /* Status register read */
 170         ret = pfl->status;
 171         DPRINTF("%s: status %x\n", __func__, ret);
 172         /* Toggle bit 6 */
 173         pfl->status ^= 0x40;
 174         break;
 175     case 0x98:
 176         /* CFI query mode */
 177         if (boff > pfl->cfi_len)
 178             ret = 0;
 179         else
 180             ret = pfl->cfi_table[boff];
 181         break;
 182     }
 183
 184     return ret;
 185 }
 186
 187 /* update flash content on disk */
 188 static void pflash_update(pflash_t *pfl, int offset,
 189                           int size)
 190 {
 191     int offset_end;
 192     if (pfl->bs) {
 193         offset_end = offset + size;
 194         /* round to sectors */
 195         offset = offset >> 9;
 196         offset_end = (offset_end + 511) >> 9;
 197         bdrv_write(pfl->bs, offset, pfl->storage + (offset << 9),
 198                    offset_end - offset);
 199     }
 200 }
 201
 202 static void pflash_write (pflash_t *pfl, target_ulong offset, uint32_t value,
 203                           int width)
 204 {
 205     target_ulong boff;
 206     uint8_t *p;
 207     uint8_t cmd;
 208
 209     /* WARNING: when the memory area is in ROMD mode, the offset is a
 210        ram offset, not a physical address */
 211     if (pfl->wcycle == 0)
 212         offset -= (target_ulong)(long)pfl->storage;
 213     else
 214         offset -= pfl->base;
 215
 216     cmd = value;
 217     DPRINTF("%s: offset " TARGET_FMT_lx " %08x %d\n", __func__,
 218             offset, value, width);
 219     if (pfl->cmd != 0xA0 && cmd == 0xF0) {
 220         DPRINTF("%s: flash reset asked (%02x %02x)\n",
 221                 __func__, pfl->cmd, cmd);
 222         goto reset_flash;
 223     }
 224     /* Set the device in I/O access mode */
 225     cpu_register_physical_memory(pfl->base, pfl->total_len, pfl->fl_mem);
 226     boff = offset & (pfl->sector_len - 1);
 227     if (pfl->width == 2)
 228         boff = boff >> 1;
 229     else if (pfl->width == 4)
 230         boff = boff >> 2;
 231     switch (pfl->wcycle) {
 232     case 0:
 233         /* We're in read mode */
 234     check_unlock0:
 235         if (boff == 0x55 && cmd == 0x98) {
 236         enter_CFI_mode:
 237             /* Enter CFI query mode */
 238             pfl->wcycle = 7;
 239             pfl->cmd = 0x98;
 240             return;
 241         }
 242         if (boff != 0x555 || cmd != 0xAA) {
 243             DPRINTF("%s: unlock0 failed " TARGET_FMT_lx " %02x %04x\n",
 244                     __func__, boff, cmd, 0x555);
 245             goto reset_flash;
 246         }
 247         DPRINTF("%s: unlock sequence started\n", __func__);
 248         break;
 249     case 1:
 250         /* We started an unlock sequence */
 251     check_unlock1:
 252         if (boff != 0x2AA || cmd != 0x55) {
 253             DPRINTF("%s: unlock1 failed " TARGET_FMT_lx " %02x\n", __func__,
 254                     boff, cmd);
 255             goto reset_flash;
 256         }
 257         DPRINTF("%s: unlock sequence done\n", __func__);
 258         break;
 259     case 2:
 260         /* We finished an unlock sequence */
 261         if (!pfl->bypass && boff != 0x555) {
 262             DPRINTF("%s: command failed " TARGET_FMT_lx " %02x\n", __func__,
 263                     boff, cmd);
 264             goto reset_flash;
 265         }
 266         switch (cmd) {
 267         case 0x20:
 268             pfl->bypass = 1;
 269             goto do_bypass;
 270         case 0x80:
 271         case 0x90:
 272         case 0xA0:
 273             pfl->cmd = cmd;
 274             DPRINTF("%s: starting command %02x\n", __func__, cmd);
 275             break;
 276         default:
 277             DPRINTF("%s: unknown command %02x\n", __func__, cmd);
 278             goto reset_flash;
 279         }
 280         break;
 281     case 3:
 282         switch (pfl->cmd) {
 283         case 0x80:
 284             /* We need another unlock sequence */
 285             goto check_unlock0;
 286         case 0xA0:
 287             DPRINTF("%s: write data offset " TARGET_FMT_lx " %08x %d\n",
 288                     __func__, offset, value, width);
 289             p = pfl->storage;
 290             switch (width) {
 291             case 1:
 292                 p[offset] &= value;
 293                 pflash_update(pfl, offset, 1);
 294                 break;
 295             case 2:
 296 #if defined(TARGET_WORDS_BIGENDIAN)
 297                 p[offset] &= value >> 8;
 298                 p[offset + 1] &= value;
 299 #else
 300                 p[offset] &= value;
 301                 p[offset + 1] &= value >> 8;
 302 #endif
 303                 pflash_update(pfl, offset, 2);
 304                 break;
 305             case 4:
 306 #if defined(TARGET_WORDS_BIGENDIAN)
 307                 p[offset] &= value >> 24;
 308                 p[offset + 1] &= value >> 16;
 309                 p[offset + 2] &= value >> 8;
 310                 p[offset + 3] &= value;
 311 #else
 312                 p[offset] &= value;
 313                 p[offset + 1] &= value >> 8;
 314                 p[offset + 2] &= value >> 16;
 315                 p[offset + 3] &= value >> 24;
 316 #endif
 317                 pflash_update(pfl, offset, 4);
 318                 break;
 319             }
 320             pfl->status = 0x00 | ~(value & 0x80);
 321             /* Let's pretend write is immediate */
 322             if (pfl->bypass)
 323                 goto do_bypass;
 324             goto reset_flash;
 325         case 0x90:
 326             if (pfl->bypass && cmd == 0x00) {
 327                 /* Unlock bypass reset */
 328                 goto reset_flash;
 329             }
 330             /* We can enter CFI query mode from autoselect mode */
 331             if (boff == 0x55 && cmd == 0x98)
 332                 goto enter_CFI_mode;
 333             /* No break here */
 334         default:
 335             DPRINTF("%s: invalid write for command %02x\n",
 336                     __func__, pfl->cmd);
 337             goto reset_flash;
 338         }
 339     case 4:
 340         switch (pfl->cmd) {
 341         case 0xA0:
 342             /* Ignore writes while flash data write is occuring */
 343             /* As we suppose write is immediate, this should never happen */
 344             return;
 345         case 0x80:
 346             goto check_unlock1;
 347         default:
 348             /* Should never happen */
 349             DPRINTF("%s: invalid command state %02x (wc 4)\n",
 350                     __func__, pfl->cmd);
 351             goto reset_flash;
 352         }
 353         break;
 354     case 5:
 355         switch (cmd) {
 356         case 0x10:
 357             if (boff != 0x555) {
 358                 DPRINTF("%s: chip erase: invalid address " TARGET_FMT_lx "\n",
 359                         __func__, offset);
 360                 goto reset_flash;
 361             }
 362             /* Chip erase */
 363             DPRINTF("%s: start chip erase\n", __func__);
 364             memset(pfl->storage, 0xFF, pfl->total_len);
 365             pfl->status = 0x00;
 366             pflash_update(pfl, 0, pfl->total_len);
 367             /* Let's wait 5 seconds before chip erase is done */
 368             qemu_mod_timer(pfl->timer,
 369                            qemu_get_clock(vm_clock) + (ticks_per_sec * 5));
 370             break;
 371         case 0x30:
 372             /* Sector erase */
 373             p = pfl->storage;
 374             offset &= ~(pfl->sector_len - 1);
 375             DPRINTF("%s: start sector erase at " TARGET_FMT_lx "\n", __func__,
 376                     offset);
 377             memset(p + offset, 0xFF, pfl->sector_len);
 378             pflash_update(pfl, offset, pfl->sector_len);
 379             pfl->status = 0x00;
 380             /* Let's wait 1/2 second before sector erase is done */
 381             qemu_mod_timer(pfl->timer,
 382                            qemu_get_clock(vm_clock) + (ticks_per_sec / 2));
 383             break;
 384         default:
 385             DPRINTF("%s: invalid command %02x (wc 5)\n", __func__, cmd);
 386             goto reset_flash;
 387         }
 388         pfl->cmd = cmd;
 389         break;
 390     case 6:
 391         switch (pfl->cmd) {
 392         case 0x10:
 393             /* Ignore writes during chip erase */
 394             return;
 395         case 0x30:
 396             /* Ignore writes during sector erase */
 397             return;
 398         default:
 399             /* Should never happen */
 400             DPRINTF("%s: invalid command state %02x (wc 6)\n",
 401                     __func__, pfl->cmd);
 402             goto reset_flash;
 403         }
 404         break;
 405     case 7: /* Special value for CFI queries */
 406         DPRINTF("%s: invalid write in CFI query mode\n", __func__);
 407         goto reset_flash;
 408     default:
 409         /* Should never happen */
 410         DPRINTF("%s: invalid write state (wc 7)\n",  __func__);
 411         goto reset_flash;
 412     }
 413     pfl->wcycle++;
 414
 415     return;
 416
 417     /* Reset flash */
 418  reset_flash:
 419     if (pfl->wcycle != 0) {
 420         cpu_register_physical_memory(pfl->base, pfl->total_len,
 421                                      pfl->off | IO_MEM_ROMD | pfl->fl_mem);
 422     }
 423     pfl->bypass = 0;
 424     pfl->wcycle = 0;
 425     pfl->cmd = 0;
 426     return;
 427
 428  do_bypass:
 429     pfl->wcycle = 2;
 430     pfl->cmd = 0;
 431     return;
 432 }
 433
 434
 435 static uint32_t pflash_readb (void *opaque, target_phys_addr_t addr)
 436 {
 437     return pflash_read(opaque, addr, 1);
 438 }
 439
 440 static uint32_t pflash_readw (void *opaque, target_phys_addr_t addr)
 441 {
 442     pflash_t *pfl = opaque;
 443
 444     return pflash_read(pfl, addr, 2);
 445 }
 446
 447 static uint32_t pflash_readl (void *opaque, target_phys_addr_t addr)
 448 {
 449     pflash_t *pfl = opaque;
 450
 451     return pflash_read(pfl, addr, 4);
 452 }
 453
 454 static void pflash_writeb (void *opaque, target_phys_addr_t addr,
 455                            uint32_t value)
 456 {
 457     pflash_write(opaque, addr, value, 1);
 458 }
 459
 460 static void pflash_writew (void *opaque, target_phys_addr_t addr,
 461                            uint32_t value)
 462 {
 463     pflash_t *pfl = opaque;
 464
 465     pflash_write(pfl, addr, value, 2);
 466 }
 467
 468 static void pflash_writel (void *opaque, target_phys_addr_t addr,
 469                            uint32_t value)
 470 {
 471     pflash_t *pfl = opaque;
 472
 473     pflash_write(pfl, addr, value, 4);
 474 }
 475
 476 static CPUWriteMemoryFunc *pflash_write_ops[] = {
 477     &pflash_writeb,
 478     &pflash_writew,
 479     &pflash_writel,
 480 };
 481
 482 static CPUReadMemoryFunc *pflash_read_ops[] = {
 483     &pflash_readb,
 484     &pflash_readw,
 485     &pflash_readl,
 486 };
 487
 488 /* Count trailing zeroes of a 32 bits quantity */
 489 static int ctz32 (uint32_t n)
 490 {
 491     int ret;
 492
 493     ret = 0;
 494     if (!(n & 0xFFFF)) {
 495         ret += 16;
 496         n = n >> 16;
 497     }
 498     if (!(n & 0xFF)) {
 499         ret += 8;
 500         n = n >> 8;
 501     }
 502     if (!(n & 0xF)) {
 503         ret += 4;
 504         n = n >> 4;
 505     }
 506     if (!(n & 0x3)) {
 507         ret += 2;
 508         n = n >> 2;
 509     }
 510     if (!(n & 0x1)) {
 511         ret++;
 512         n = n >> 1;
 513     }
 514 #if 0 /* This is not necessary as n is never 0 */
 515     if (!n)
 516         ret++;
 517 #endif
 518
 519     return ret;
 520 }
 521
 522 pflash_t *pflash_register (target_ulong base, ram_addr_t off,
 523                            BlockDriverState *bs,
 524                            target_ulong sector_len, int nb_blocs, int width,
 525                            uint16_t id0, uint16_t id1,
 526                            uint16_t id2, uint16_t id3)
 527 {
 528     pflash_t *pfl;
 529     target_long total_len;
 530
 531     total_len = sector_len * nb_blocs;
 532     /* XXX: to be fixed */
 533     if (total_len != (8 * 1024 * 1024) && total_len != (16 * 1024 * 1024) &&
 534         total_len != (32 * 1024 * 1024) && total_len != (64 * 1024 * 1024))
 535         return NULL;
 536     pfl = qemu_mallocz(sizeof(pflash_t));
 537     if (pfl == NULL)
 538         return NULL;
 539     pfl->storage = phys_ram_base + off;
 540     pfl->fl_mem = cpu_register_io_memory(0, pflash_read_ops, pflash_write_ops, pfl);
 541     pfl->off = off;
 542     cpu_register_physical_memory(base, total_len,
 543                                  off | pfl->fl_mem | IO_MEM_ROMD);
 544     pfl->bs = bs;
 545     if (pfl->bs) {
 546         /* read the initial flash content */
 547         bdrv_read(pfl->bs, 0, pfl->storage, total_len >> 9);
 548     }
 549 #if 0 /* XXX: there should be a bit to set up read-only,
 550        *      the same way the hardware does (with WP pin).
 551        */
 552     pfl->ro = 1;
 553 #else
 554     pfl->ro = 0;
 555 #endif
 556     pfl->timer = qemu_new_timer(vm_clock, pflash_timer, pfl);
 557     pfl->base = base;
 558     pfl->sector_len = sector_len;
 559     pfl->total_len = total_len;
 560     pfl->width = width;
 561     pfl->wcycle = 0;
 562     pfl->cmd = 0;
 563     pfl->status = 0;
 564     pfl->ident[0] = id0;
 565     pfl->ident[1] = id1;
 566     pfl->ident[2] = id2;
 567     pfl->ident[3] = id3;
 568     /* Hardcoded CFI table (mostly from SG29 Spansion flash) */
 569     pfl->cfi_len = 0x52;
 570     /* Standard "QRY" string */
 571     pfl->cfi_table[0x10] = 'Q';
 572     pfl->cfi_table[0x11] = 'R';
 573     pfl->cfi_table[0x12] = 'Y';
 574     /* Command set (AMD/Fujitsu) */
 575     pfl->cfi_table[0x13] = 0x02;
 576     pfl->cfi_table[0x14] = 0x00;
 577     /* Primary extended table address (none) */
 578     pfl->cfi_table[0x15] = 0x00;
 579     pfl->cfi_table[0x16] = 0x00;
 580     /* Alternate command set (none) */
 581     pfl->cfi_table[0x17] = 0x00;
 582     pfl->cfi_table[0x18] = 0x00;
 583     /* Alternate extended table (none) */
 584     pfl->cfi_table[0x19] = 0x00;
 585     pfl->cfi_table[0x1A] = 0x00;
 586     /* Vcc min */
 587     pfl->cfi_table[0x1B] = 0x27;
 588     /* Vcc max */
 589     pfl->cfi_table[0x1C] = 0x36;
 590     /* Vpp min (no Vpp pin) */
 591     pfl->cfi_table[0x1D] = 0x00;
 592     /* Vpp max (no Vpp pin) */
 593     pfl->cfi_table[0x1E] = 0x00;
 594     /* Reserved */
 595     pfl->cfi_table[0x1F] = 0x07;
 596     /* Timeout for min size buffer write (16 µs) */
 597     pfl->cfi_table[0x20] = 0x04;
 598     /* Typical timeout for block erase (512 ms) */
 599     pfl->cfi_table[0x21] = 0x09;
 600     /* Typical timeout for full chip erase (4096 ms) */
 601     pfl->cfi_table[0x22] = 0x0C;
 602     /* Reserved */
 603     pfl->cfi_table[0x23] = 0x01;
 604     /* Max timeout for buffer write */
 605     pfl->cfi_table[0x24] = 0x04;
 606     /* Max timeout for block erase */
 607     pfl->cfi_table[0x25] = 0x0A;
 608     /* Max timeout for chip erase */
 609     pfl->cfi_table[0x26] = 0x0D;
 610     /* Device size */
 611     pfl->cfi_table[0x27] = ctz32(total_len) + 1;
 612     /* Flash device interface (8 & 16 bits) */
 613     pfl->cfi_table[0x28] = 0x02;
 614     pfl->cfi_table[0x29] = 0x00;
 615     /* Max number of bytes in multi-bytes write */
 616     pfl->cfi_table[0x2A] = 0x05;
 617     pfl->cfi_table[0x2B] = 0x00;
 618     /* Number of erase block regions (uniform) */
 619     pfl->cfi_table[0x2C] = 0x01;
 620     /* Erase block region 1 */
 621     pfl->cfi_table[0x2D] = nb_blocs - 1;
 622     pfl->cfi_table[0x2E] = (nb_blocs - 1) >> 8;
 623     pfl->cfi_table[0x2F] = sector_len >> 8;
 624     pfl->cfi_table[0x30] = sector_len >> 16;
 625
 626     return pfl;
 627 }