pflash_cfi02.c 24.8 KB
Newer Older
1 2
/*
 *  CFI parallel flash with AMD command set emulation
3
 *
4 5 6 7 8 9 10 11 12 13 14 15 16
 *  Copyright (c) 2005 Jocelyn Mayer
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
17
 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
 */

/*
 * For now, this code can emulate flashes of 1, 2 or 4 bytes width.
 * Supported commands/modes are:
 * - flash read
 * - flash write
 * - flash ID read
 * - sector erase
 * - chip erase
 * - unlock bypass command
 * - CFI queries
 *
 * It does not support flash interleaving.
 * It does not implement boot blocs with reduced size
 * It does not implement software data protection as found in many real chips
 * It does not implement erase suspend/resume commands
 * It does not implement multiple sectors erase
 */

P
Peter Maydell 已提交
38
#include "qemu/osdep.h"
39
#include "hw/hw.h"
P
Paolo Bonzini 已提交
40
#include "hw/block/flash.h"
41
#include "qapi/error.h"
42
#include "qemu/timer.h"
43
#include "sysemu/block-backend.h"
44
#include "exec/address-spaces.h"
45
#include "qemu/host-utils.h"
46
#include "hw/sysbus.h"
47 48 49

//#define PFLASH_DEBUG
#ifdef PFLASH_DEBUG
50 51
#define DPRINTF(fmt, ...)                                  \
do {                                                       \
A
Antony Pavlov 已提交
52
    fprintf(stderr, "PFLASH: " fmt , ## __VA_ARGS__);       \
53 54
} while (0)
#else
55
#define DPRINTF(fmt, ...) do { } while (0)
56 57
#endif

58 59
#define PFLASH_LAZY_ROMD_THRESHOLD 42

H
Hu Tao 已提交
60 61
#define CFI_PFLASH02(obj) OBJECT_CHECK(pflash_t, (obj), TYPE_CFI_PFLASH02)

A
Anthony Liguori 已提交
62
struct pflash_t {
H
Hu Tao 已提交
63 64 65 66
    /*< private >*/
    SysBusDevice parent_obj;
    /*< public >*/

67
    BlockBackend *blk;
68
    uint32_t sector_len;
P
Peter Crosthwaite 已提交
69
    uint32_t nb_blocs;
70
    uint32_t chip_len;
P
Peter Crosthwaite 已提交
71 72 73
    uint8_t mappings;
    uint8_t width;
    uint8_t be;
74 75 76 77 78
    int wcycle; /* if 0, the flash is read normally */
    int bypass;
    int ro;
    uint8_t cmd;
    uint8_t status;
P
Peter Crosthwaite 已提交
79 80 81 82 83 84 85
    /* FIXME: implement array device properties */
    uint16_t ident0;
    uint16_t ident1;
    uint16_t ident2;
    uint16_t ident3;
    uint16_t unlock_addr0;
    uint16_t unlock_addr1;
86 87 88
    uint8_t cfi_len;
    uint8_t cfi_table[0x52];
    QEMUTimer *timer;
89 90 91 92 93 94 95
    /* The device replicates the flash memory across its memory space.  Emulate
     * that by having a container (.mem) filled with an array of aliases
     * (.mem_mappings) pointing to the flash memory (.orig_mem).
     */
    MemoryRegion mem;
    MemoryRegion *mem_mappings;    /* array; one per mapping */
    MemoryRegion orig_mem;
96
    int rom_mode;
97
    int read_counter; /* used for lazy switch-back to rom mode */
P
Peter Crosthwaite 已提交
98
    char *name;
99 100 101
    void *storage;
};

102 103 104 105
/*
 * Set up replicated mappings of the same region.
 */
static void pflash_setup_mappings(pflash_t *pfl)
106
{
107
    unsigned i;
A
Avi Kivity 已提交
108
    hwaddr size = memory_region_size(&pfl->orig_mem);
109

110
    memory_region_init(&pfl->mem, OBJECT(pfl), "pflash", pfl->mappings * size);
111 112
    pfl->mem_mappings = g_new(MemoryRegion, pfl->mappings);
    for (i = 0; i < pfl->mappings; ++i) {
113 114
        memory_region_init_alias(&pfl->mem_mappings[i], OBJECT(pfl),
                                 "pflash-alias", &pfl->orig_mem, 0, size);
115 116 117
        memory_region_add_subregion(&pfl->mem, i * size, &pfl->mem_mappings[i]);
    }
}
118

119 120
static void pflash_register_memory(pflash_t *pfl, int rom_mode)
{
121
    memory_region_rom_device_set_romd(&pfl->orig_mem, rom_mode);
122
    pfl->rom_mode = rom_mode;
123 124
}

125 126
static void pflash_timer (void *opaque)
{
A
Anthony Liguori 已提交
127
    pflash_t *pfl = opaque;
128 129 130 131 132 133 134

    DPRINTF("%s: command %02x done\n", __func__, pfl->cmd);
    /* Reset flash */
    pfl->status ^= 0x80;
    if (pfl->bypass) {
        pfl->wcycle = 2;
    } else {
135
        pflash_register_memory(pfl, 1);
136 137 138 139 140
        pfl->wcycle = 0;
    }
    pfl->cmd = 0;
}

A
Avi Kivity 已提交
141
static uint32_t pflash_read (pflash_t *pfl, hwaddr offset,
B
Blue Swirl 已提交
142
                             int width, int be)
143
{
A
Avi Kivity 已提交
144
    hwaddr boff;
145 146 147
    uint32_t ret;
    uint8_t *p;

148
    DPRINTF("%s: offset " TARGET_FMT_plx "\n", __func__, offset);
149
    ret = -1;
150 151 152 153
    /* Lazy reset to ROMD mode after a certain amount of read accesses */
    if (!pfl->rom_mode && pfl->wcycle == 0 &&
        ++pfl->read_counter > PFLASH_LAZY_ROMD_THRESHOLD) {
        pflash_register_memory(pfl, 1);
P
pbrook 已提交
154
    }
155
    offset &= pfl->chip_len - 1;
156 157 158 159 160 161 162 163 164 165 166
    boff = offset & 0xFF;
    if (pfl->width == 2)
        boff = boff >> 1;
    else if (pfl->width == 4)
        boff = boff >> 2;
    switch (pfl->cmd) {
    default:
        /* This should never happen : reset state & treat it as a read*/
        DPRINTF("%s: unknown command state: %x\n", __func__, pfl->cmd);
        pfl->wcycle = 0;
        pfl->cmd = 0;
167
        /* fall through to the read code */
168 169 170 171 172 173 174 175 176 177 178 179
    case 0x80:
        /* We accept reads during second unlock sequence... */
    case 0x00:
    flash_read:
        /* Flash area read */
        p = pfl->storage;
        switch (width) {
        case 1:
            ret = p[offset];
//            DPRINTF("%s: data offset %08x %02x\n", __func__, offset, ret);
            break;
        case 2:
B
Blue Swirl 已提交
180 181 182 183 184 185 186
            if (be) {
                ret = p[offset] << 8;
                ret |= p[offset + 1];
            } else {
                ret = p[offset];
                ret |= p[offset + 1] << 8;
            }
187 188 189
//            DPRINTF("%s: data offset %08x %04x\n", __func__, offset, ret);
            break;
        case 4:
B
Blue Swirl 已提交
190 191 192 193 194 195 196 197 198 199 200
            if (be) {
                ret = p[offset] << 24;
                ret |= p[offset + 1] << 16;
                ret |= p[offset + 2] << 8;
                ret |= p[offset + 3];
            } else {
                ret = p[offset];
                ret |= p[offset + 1] << 8;
                ret |= p[offset + 2] << 16;
                ret |= p[offset + 3] << 24;
            }
201 202 203 204 205 206 207 208 209
//            DPRINTF("%s: data offset %08x %08x\n", __func__, offset, ret);
            break;
        }
        break;
    case 0x90:
        /* flash ID read */
        switch (boff) {
        case 0x00:
        case 0x01:
P
Peter Crosthwaite 已提交
210
            ret = boff & 0x01 ? pfl->ident1 : pfl->ident0;
211 212 213 214 215 216
            break;
        case 0x02:
            ret = 0x00; /* Pretend all sectors are unprotected */
            break;
        case 0x0E:
        case 0x0F:
P
Peter Crosthwaite 已提交
217 218
            ret = boff & 0x01 ? pfl->ident3 : pfl->ident2;
            if (ret == (uint8_t)-1) {
219
                goto flash_read;
P
Peter Crosthwaite 已提交
220
            }
221 222 223 224
            break;
        default:
            goto flash_read;
        }
225
        DPRINTF("%s: ID " TARGET_FMT_plx " %x\n", __func__, boff, ret);
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
        break;
    case 0xA0:
    case 0x10:
    case 0x30:
        /* Status register read */
        ret = pfl->status;
        DPRINTF("%s: status %x\n", __func__, ret);
        /* Toggle bit 6 */
        pfl->status ^= 0x40;
        break;
    case 0x98:
        /* CFI query mode */
        if (boff > pfl->cfi_len)
            ret = 0;
        else
            ret = pfl->cfi_table[boff];
        break;
    }

    return ret;
}

/* update flash content on disk */
A
Anthony Liguori 已提交
249
static void pflash_update(pflash_t *pfl, int offset,
250 251 252
                          int size)
{
    int offset_end;
253
    if (pfl->blk) {
254
        offset_end = offset + size;
255 256 257 258 259
        /* widen to sector boundaries */
        offset = QEMU_ALIGN_DOWN(offset, BDRV_SECTOR_SIZE);
        offset_end = QEMU_ALIGN_UP(offset_end, BDRV_SECTOR_SIZE);
        blk_pwrite(pfl->blk, offset, pfl->storage + offset,
                   offset_end - offset, 0);
260 261 262
    }
}

A
Avi Kivity 已提交
263
static void pflash_write (pflash_t *pfl, hwaddr offset,
B
Blue Swirl 已提交
264
                          uint32_t value, int width, int be)
265
{
A
Avi Kivity 已提交
266
    hwaddr boff;
267 268 269
    uint8_t *p;
    uint8_t cmd;

J
j_mayer 已提交
270 271 272 273 274 275 276 277
    cmd = value;
    if (pfl->cmd != 0xA0 && cmd == 0xF0) {
#if 0
        DPRINTF("%s: flash reset asked (%02x %02x)\n",
                __func__, pfl->cmd, cmd);
#endif
        goto reset_flash;
    }
278
    DPRINTF("%s: offset " TARGET_FMT_plx " %08x %d %d\n", __func__,
J
j_mayer 已提交
279
            offset, value, width, pfl->wcycle);
280
    offset &= pfl->chip_len - 1;
281

282
    DPRINTF("%s: offset " TARGET_FMT_plx " %08x %d\n", __func__,
283
            offset, value, width);
284 285 286 287 288 289 290
    boff = offset & (pfl->sector_len - 1);
    if (pfl->width == 2)
        boff = boff >> 1;
    else if (pfl->width == 4)
        boff = boff >> 2;
    switch (pfl->wcycle) {
    case 0:
291 292 293
        /* Set the device in I/O access mode if required */
        if (pfl->rom_mode)
            pflash_register_memory(pfl, 0);
294
        pfl->read_counter = 0;
295 296 297 298 299 300 301 302 303
        /* We're in read mode */
    check_unlock0:
        if (boff == 0x55 && cmd == 0x98) {
        enter_CFI_mode:
            /* Enter CFI query mode */
            pfl->wcycle = 7;
            pfl->cmd = 0x98;
            return;
        }
P
Peter Crosthwaite 已提交
304
        if (boff != pfl->unlock_addr0 || cmd != 0xAA) {
305
            DPRINTF("%s: unlock0 failed " TARGET_FMT_plx " %02x %04x\n",
P
Peter Crosthwaite 已提交
306
                    __func__, boff, cmd, pfl->unlock_addr0);
307 308 309 310 311 312 313
            goto reset_flash;
        }
        DPRINTF("%s: unlock sequence started\n", __func__);
        break;
    case 1:
        /* We started an unlock sequence */
    check_unlock1:
P
Peter Crosthwaite 已提交
314
        if (boff != pfl->unlock_addr1 || cmd != 0x55) {
315
            DPRINTF("%s: unlock1 failed " TARGET_FMT_plx " %02x\n", __func__,
316
                    boff, cmd);
317 318 319 320 321 322
            goto reset_flash;
        }
        DPRINTF("%s: unlock sequence done\n", __func__);
        break;
    case 2:
        /* We finished an unlock sequence */
P
Peter Crosthwaite 已提交
323
        if (!pfl->bypass && boff != pfl->unlock_addr0) {
324
            DPRINTF("%s: command failed " TARGET_FMT_plx " %02x\n", __func__,
325
                    boff, cmd);
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
            goto reset_flash;
        }
        switch (cmd) {
        case 0x20:
            pfl->bypass = 1;
            goto do_bypass;
        case 0x80:
        case 0x90:
        case 0xA0:
            pfl->cmd = cmd;
            DPRINTF("%s: starting command %02x\n", __func__, cmd);
            break;
        default:
            DPRINTF("%s: unknown command %02x\n", __func__, cmd);
            goto reset_flash;
        }
        break;
    case 3:
        switch (pfl->cmd) {
        case 0x80:
            /* We need another unlock sequence */
            goto check_unlock0;
        case 0xA0:
349
            DPRINTF("%s: write data offset " TARGET_FMT_plx " %08x %d\n",
350 351
                    __func__, offset, value, width);
            p = pfl->storage;
352 353 354
            if (!pfl->ro) {
                switch (width) {
                case 1:
B
Blue Swirl 已提交
355
                    p[offset] &= value;
356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
                    pflash_update(pfl, offset, 1);
                    break;
                case 2:
                    if (be) {
                        p[offset] &= value >> 8;
                        p[offset + 1] &= value;
                    } else {
                        p[offset] &= value;
                        p[offset + 1] &= value >> 8;
                    }
                    pflash_update(pfl, offset, 2);
                    break;
                case 4:
                    if (be) {
                        p[offset] &= value >> 24;
                        p[offset + 1] &= value >> 16;
                        p[offset + 2] &= value >> 8;
                        p[offset + 3] &= value;
                    } else {
                        p[offset] &= value;
                        p[offset + 1] &= value >> 8;
                        p[offset + 2] &= value >> 16;
                        p[offset + 3] &= value >> 24;
                    }
                    pflash_update(pfl, offset, 4);
                    break;
B
Blue Swirl 已提交
382
                }
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
            }
            pfl->status = 0x00 | ~(value & 0x80);
            /* Let's pretend write is immediate */
            if (pfl->bypass)
                goto do_bypass;
            goto reset_flash;
        case 0x90:
            if (pfl->bypass && cmd == 0x00) {
                /* Unlock bypass reset */
                goto reset_flash;
            }
            /* We can enter CFI query mode from autoselect mode */
            if (boff == 0x55 && cmd == 0x98)
                goto enter_CFI_mode;
            /* No break here */
        default:
            DPRINTF("%s: invalid write for command %02x\n",
                    __func__, pfl->cmd);
            goto reset_flash;
        }
    case 4:
        switch (pfl->cmd) {
        case 0xA0:
406
            /* Ignore writes while flash data write is occurring */
407 408 409 410 411 412 413 414 415 416 417 418 419 420
            /* As we suppose write is immediate, this should never happen */
            return;
        case 0x80:
            goto check_unlock1;
        default:
            /* Should never happen */
            DPRINTF("%s: invalid command state %02x (wc 4)\n",
                    __func__, pfl->cmd);
            goto reset_flash;
        }
        break;
    case 5:
        switch (cmd) {
        case 0x10:
P
Peter Crosthwaite 已提交
421
            if (boff != pfl->unlock_addr0) {
422
                DPRINTF("%s: chip erase: invalid address " TARGET_FMT_plx "\n",
423 424 425 426 427
                        __func__, offset);
                goto reset_flash;
            }
            /* Chip erase */
            DPRINTF("%s: start chip erase\n", __func__);
428 429 430 431
            if (!pfl->ro) {
                memset(pfl->storage, 0xFF, pfl->chip_len);
                pflash_update(pfl, 0, pfl->chip_len);
            }
432 433
            pfl->status = 0x00;
            /* Let's wait 5 seconds before chip erase is done */
434 435
            timer_mod(pfl->timer, qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) +
                      (NANOSECONDS_PER_SECOND * 5));
436 437 438 439 440
            break;
        case 0x30:
            /* Sector erase */
            p = pfl->storage;
            offset &= ~(pfl->sector_len - 1);
441
            DPRINTF("%s: start sector erase at " TARGET_FMT_plx "\n", __func__,
442
                    offset);
443 444 445 446
            if (!pfl->ro) {
                memset(p + offset, 0xFF, pfl->sector_len);
                pflash_update(pfl, offset, pfl->sector_len);
            }
447 448
            pfl->status = 0x00;
            /* Let's wait 1/2 second before sector erase is done */
449 450
            timer_mod(pfl->timer, qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) +
                      (NANOSECONDS_PER_SECOND / 2));
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
            break;
        default:
            DPRINTF("%s: invalid command %02x (wc 5)\n", __func__, cmd);
            goto reset_flash;
        }
        pfl->cmd = cmd;
        break;
    case 6:
        switch (pfl->cmd) {
        case 0x10:
            /* Ignore writes during chip erase */
            return;
        case 0x30:
            /* Ignore writes during sector erase */
            return;
        default:
            /* Should never happen */
            DPRINTF("%s: invalid command state %02x (wc 6)\n",
                    __func__, pfl->cmd);
            goto reset_flash;
        }
        break;
    case 7: /* Special value for CFI queries */
        DPRINTF("%s: invalid write in CFI query mode\n", __func__);
        goto reset_flash;
    default:
        /* Should never happen */
        DPRINTF("%s: invalid write state (wc 7)\n",  __func__);
        goto reset_flash;
    }
    pfl->wcycle++;

    return;

    /* Reset flash */
 reset_flash:
    pfl->bypass = 0;
    pfl->wcycle = 0;
    pfl->cmd = 0;
    return;

 do_bypass:
    pfl->wcycle = 2;
    pfl->cmd = 0;
}


A
Avi Kivity 已提交
498
static uint32_t pflash_readb_be(void *opaque, hwaddr addr)
B
Blue Swirl 已提交
499 500 501 502
{
    return pflash_read(opaque, addr, 1, 1);
}

A
Avi Kivity 已提交
503
static uint32_t pflash_readb_le(void *opaque, hwaddr addr)
B
Blue Swirl 已提交
504 505 506 507
{
    return pflash_read(opaque, addr, 1, 0);
}

A
Avi Kivity 已提交
508
static uint32_t pflash_readw_be(void *opaque, hwaddr addr)
B
Blue Swirl 已提交
509 510 511 512 513 514
{
    pflash_t *pfl = opaque;

    return pflash_read(pfl, addr, 2, 1);
}

A
Avi Kivity 已提交
515
static uint32_t pflash_readw_le(void *opaque, hwaddr addr)
B
Blue Swirl 已提交
516 517 518 519 520 521
{
    pflash_t *pfl = opaque;

    return pflash_read(pfl, addr, 2, 0);
}

A
Avi Kivity 已提交
522
static uint32_t pflash_readl_be(void *opaque, hwaddr addr)
523
{
B
Blue Swirl 已提交
524 525 526
    pflash_t *pfl = opaque;

    return pflash_read(pfl, addr, 4, 1);
527 528
}

A
Avi Kivity 已提交
529
static uint32_t pflash_readl_le(void *opaque, hwaddr addr)
530
{
A
Anthony Liguori 已提交
531
    pflash_t *pfl = opaque;
532

B
Blue Swirl 已提交
533 534 535
    return pflash_read(pfl, addr, 4, 0);
}

A
Avi Kivity 已提交
536
static void pflash_writeb_be(void *opaque, hwaddr addr,
B
Blue Swirl 已提交
537 538 539
                             uint32_t value)
{
    pflash_write(opaque, addr, value, 1, 1);
540 541
}

A
Avi Kivity 已提交
542
static void pflash_writeb_le(void *opaque, hwaddr addr,
B
Blue Swirl 已提交
543 544 545 546 547
                             uint32_t value)
{
    pflash_write(opaque, addr, value, 1, 0);
}

A
Avi Kivity 已提交
548
static void pflash_writew_be(void *opaque, hwaddr addr,
B
Blue Swirl 已提交
549
                             uint32_t value)
550
{
A
Anthony Liguori 已提交
551
    pflash_t *pfl = opaque;
552

B
Blue Swirl 已提交
553
    pflash_write(pfl, addr, value, 2, 1);
554 555
}

A
Avi Kivity 已提交
556
static void pflash_writew_le(void *opaque, hwaddr addr,
B
Blue Swirl 已提交
557
                             uint32_t value)
558
{
B
Blue Swirl 已提交
559 560 561
    pflash_t *pfl = opaque;

    pflash_write(pfl, addr, value, 2, 0);
562 563
}

A
Avi Kivity 已提交
564
static void pflash_writel_be(void *opaque, hwaddr addr,
B
Blue Swirl 已提交
565
                             uint32_t value)
566
{
A
Anthony Liguori 已提交
567
    pflash_t *pfl = opaque;
568

B
Blue Swirl 已提交
569
    pflash_write(pfl, addr, value, 4, 1);
570 571
}

A
Avi Kivity 已提交
572
static void pflash_writel_le(void *opaque, hwaddr addr,
B
Blue Swirl 已提交
573
                             uint32_t value)
574
{
A
Anthony Liguori 已提交
575
    pflash_t *pfl = opaque;
576

B
Blue Swirl 已提交
577
    pflash_write(pfl, addr, value, 4, 0);
578 579
}

580 581 582 583 584 585
static const MemoryRegionOps pflash_cfi02_ops_be = {
    .old_mmio = {
        .read = { pflash_readb_be, pflash_readw_be, pflash_readl_be, },
        .write = { pflash_writeb_be, pflash_writew_be, pflash_writel_be, },
    },
    .endianness = DEVICE_NATIVE_ENDIAN,
B
Blue Swirl 已提交
586 587
};

588 589 590 591 592 593
static const MemoryRegionOps pflash_cfi02_ops_le = {
    .old_mmio = {
        .read = { pflash_readb_le, pflash_readw_le, pflash_readl_le, },
        .write = { pflash_writeb_le, pflash_writew_le, pflash_writel_le, },
    },
    .endianness = DEVICE_NATIVE_ENDIAN,
594 595
};

596
static void pflash_cfi02_realize(DeviceState *dev, Error **errp)
597
{
H
Hu Tao 已提交
598
    pflash_t *pfl = CFI_PFLASH02(dev);
P
Peter Crosthwaite 已提交
599
    uint32_t chip_len;
600
    int ret;
601
    Error *local_err = NULL;
602

603 604 605 606 607 608 609 610 611 612 613 614 615
    if (pfl->sector_len == 0) {
        error_setg(errp, "attribute \"sector-length\" not specified or zero.");
        return;
    }
    if (pfl->nb_blocs == 0) {
        error_setg(errp, "attribute \"num-blocks\" not specified or zero.");
        return;
    }
    if (pfl->name == NULL) {
        error_setg(errp, "attribute \"name\" not specified.");
        return;
    }

P
Peter Crosthwaite 已提交
616
    chip_len = pfl->sector_len * pfl->nb_blocs;
617
    /* XXX: to be fixed */
J
j_mayer 已提交
618
#if 0
619 620 621
    if (total_len != (8 * 1024 * 1024) && total_len != (16 * 1024 * 1024) &&
        total_len != (32 * 1024 * 1024) && total_len != (64 * 1024 * 1024))
        return NULL;
J
j_mayer 已提交
622
#endif
P
Peter Crosthwaite 已提交
623

624
    memory_region_init_rom_device(&pfl->orig_mem, OBJECT(pfl), pfl->be ?
P
Peter Crosthwaite 已提交
625
                                  &pflash_cfi02_ops_be : &pflash_cfi02_ops_le,
626 627 628 629 630 631
                                  pfl, pfl->name, chip_len, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
        return;
    }

632
    pfl->storage = memory_region_get_ram_ptr(&pfl->orig_mem);
633
    pfl->chip_len = chip_len;
K
Kevin Wolf 已提交
634 635 636 637 638 639 640 641 642 643 644 645 646

    if (pfl->blk) {
        uint64_t perm;
        pfl->ro = blk_is_read_only(pfl->blk);
        perm = BLK_PERM_CONSISTENT_READ | (pfl->ro ? 0 : BLK_PERM_WRITE);
        ret = blk_set_perm(pfl->blk, perm, BLK_PERM_ALL, errp);
        if (ret < 0) {
            return;
        }
    } else {
        pfl->ro = 0;
    }

647
    if (pfl->blk) {
648
        /* read the initial flash content */
649
        ret = blk_pread(pfl->blk, 0, pfl->storage, chip_len);
650
        if (ret < 0) {
651 652 653
            vmstate_unregister_ram(&pfl->orig_mem, DEVICE(pfl));
            error_setg(errp, "failed to read the initial flash content");
            return;
654
        }
655
    }
656

657 658
    pflash_setup_mappings(pfl);
    pfl->rom_mode = 1;
659
    sysbus_init_mmio(SYS_BUS_DEVICE(dev), &pfl->mem);
660

661
    pfl->timer = timer_new_ns(QEMU_CLOCK_VIRTUAL, pflash_timer, pfl);
662 663 664 665 666 667 668 669 670 671 672 673
    pfl->wcycle = 0;
    pfl->cmd = 0;
    pfl->status = 0;
    /* Hardcoded CFI table (mostly from SG29 Spansion flash) */
    pfl->cfi_len = 0x52;
    /* Standard "QRY" string */
    pfl->cfi_table[0x10] = 'Q';
    pfl->cfi_table[0x11] = 'R';
    pfl->cfi_table[0x12] = 'Y';
    /* Command set (AMD/Fujitsu) */
    pfl->cfi_table[0x13] = 0x02;
    pfl->cfi_table[0x14] = 0x00;
E
edgar_igl 已提交
674 675
    /* Primary extended table address */
    pfl->cfi_table[0x15] = 0x31;
676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692
    pfl->cfi_table[0x16] = 0x00;
    /* Alternate command set (none) */
    pfl->cfi_table[0x17] = 0x00;
    pfl->cfi_table[0x18] = 0x00;
    /* Alternate extended table (none) */
    pfl->cfi_table[0x19] = 0x00;
    pfl->cfi_table[0x1A] = 0x00;
    /* Vcc min */
    pfl->cfi_table[0x1B] = 0x27;
    /* Vcc max */
    pfl->cfi_table[0x1C] = 0x36;
    /* Vpp min (no Vpp pin) */
    pfl->cfi_table[0x1D] = 0x00;
    /* Vpp max (no Vpp pin) */
    pfl->cfi_table[0x1E] = 0x00;
    /* Reserved */
    pfl->cfi_table[0x1F] = 0x07;
E
edgar_igl 已提交
693 694
    /* Timeout for min size buffer write (NA) */
    pfl->cfi_table[0x20] = 0x00;
695 696 697 698 699 700
    /* Typical timeout for block erase (512 ms) */
    pfl->cfi_table[0x21] = 0x09;
    /* Typical timeout for full chip erase (4096 ms) */
    pfl->cfi_table[0x22] = 0x0C;
    /* Reserved */
    pfl->cfi_table[0x23] = 0x01;
E
edgar_igl 已提交
701 702
    /* Max timeout for buffer write (NA) */
    pfl->cfi_table[0x24] = 0x00;
703 704 705 706 707
    /* Max timeout for block erase */
    pfl->cfi_table[0x25] = 0x0A;
    /* Max timeout for chip erase */
    pfl->cfi_table[0x26] = 0x0D;
    /* Device size */
E
edgar_igl 已提交
708
    pfl->cfi_table[0x27] = ctz32(chip_len);
709 710 711 712
    /* Flash device interface (8 & 16 bits) */
    pfl->cfi_table[0x28] = 0x02;
    pfl->cfi_table[0x29] = 0x00;
    /* Max number of bytes in multi-bytes write */
J
j_mayer 已提交
713 714 715
    /* XXX: disable buffered write as it's not supported */
    //    pfl->cfi_table[0x2A] = 0x05;
    pfl->cfi_table[0x2A] = 0x00;
716 717 718 719
    pfl->cfi_table[0x2B] = 0x00;
    /* Number of erase block regions (uniform) */
    pfl->cfi_table[0x2C] = 0x01;
    /* Erase block region 1 */
P
Peter Crosthwaite 已提交
720 721 722 723
    pfl->cfi_table[0x2D] = pfl->nb_blocs - 1;
    pfl->cfi_table[0x2E] = (pfl->nb_blocs - 1) >> 8;
    pfl->cfi_table[0x2F] = pfl->sector_len >> 8;
    pfl->cfi_table[0x30] = pfl->sector_len >> 16;
724

E
edgar_igl 已提交
725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741
    /* Extended */
    pfl->cfi_table[0x31] = 'P';
    pfl->cfi_table[0x32] = 'R';
    pfl->cfi_table[0x33] = 'I';

    pfl->cfi_table[0x34] = '1';
    pfl->cfi_table[0x35] = '0';

    pfl->cfi_table[0x36] = 0x00;
    pfl->cfi_table[0x37] = 0x00;
    pfl->cfi_table[0x38] = 0x00;
    pfl->cfi_table[0x39] = 0x00;

    pfl->cfi_table[0x3a] = 0x00;

    pfl->cfi_table[0x3b] = 0x00;
    pfl->cfi_table[0x3c] = 0x00;
P
Peter Crosthwaite 已提交
742 743 744
}

static Property pflash_cfi02_properties[] = {
745
    DEFINE_PROP_DRIVE("drive", struct pflash_t, blk),
P
Peter Crosthwaite 已提交
746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764
    DEFINE_PROP_UINT32("num-blocks", struct pflash_t, nb_blocs, 0),
    DEFINE_PROP_UINT32("sector-length", struct pflash_t, sector_len, 0),
    DEFINE_PROP_UINT8("width", struct pflash_t, width, 0),
    DEFINE_PROP_UINT8("mappings", struct pflash_t, mappings, 0),
    DEFINE_PROP_UINT8("big-endian", struct pflash_t, be, 0),
    DEFINE_PROP_UINT16("id0", struct pflash_t, ident0, 0),
    DEFINE_PROP_UINT16("id1", struct pflash_t, ident1, 0),
    DEFINE_PROP_UINT16("id2", struct pflash_t, ident2, 0),
    DEFINE_PROP_UINT16("id3", struct pflash_t, ident3, 0),
    DEFINE_PROP_UINT16("unlock-addr0", struct pflash_t, unlock_addr0, 0),
    DEFINE_PROP_UINT16("unlock-addr1", struct pflash_t, unlock_addr1, 0),
    DEFINE_PROP_STRING("name", struct pflash_t, name),
    DEFINE_PROP_END_OF_LIST(),
};

static void pflash_cfi02_class_init(ObjectClass *klass, void *data)
{
    DeviceClass *dc = DEVICE_CLASS(klass);

765
    dc->realize = pflash_cfi02_realize;
P
Peter Crosthwaite 已提交
766
    dc->props = pflash_cfi02_properties;
767
    set_bit(DEVICE_CATEGORY_STORAGE, dc->categories);
P
Peter Crosthwaite 已提交
768 769 770
}

static const TypeInfo pflash_cfi02_info = {
H
Hu Tao 已提交
771
    .name           = TYPE_CFI_PFLASH02,
P
Peter Crosthwaite 已提交
772 773 774 775 776 777 778 779 780 781 782 783 784 785 786
    .parent         = TYPE_SYS_BUS_DEVICE,
    .instance_size  = sizeof(struct pflash_t),
    .class_init     = pflash_cfi02_class_init,
};

static void pflash_cfi02_register_types(void)
{
    type_register_static(&pflash_cfi02_info);
}

type_init(pflash_cfi02_register_types)

pflash_t *pflash_cfi02_register(hwaddr base,
                                DeviceState *qdev, const char *name,
                                hwaddr size,
787
                                BlockBackend *blk, uint32_t sector_len,
P
Peter Crosthwaite 已提交
788 789 790 791 792 793
                                int nb_blocs, int nb_mappings, int width,
                                uint16_t id0, uint16_t id1,
                                uint16_t id2, uint16_t id3,
                                uint16_t unlock_addr0, uint16_t unlock_addr1,
                                int be)
{
H
Hu Tao 已提交
794
    DeviceState *dev = qdev_create(NULL, TYPE_CFI_PFLASH02);
P
Peter Crosthwaite 已提交
795

796 797
    if (blk) {
        qdev_prop_set_drive(dev, "drive", blk, &error_abort);
P
Peter Crosthwaite 已提交
798 799 800 801 802 803 804 805 806 807 808 809 810 811 812
    }
    qdev_prop_set_uint32(dev, "num-blocks", nb_blocs);
    qdev_prop_set_uint32(dev, "sector-length", sector_len);
    qdev_prop_set_uint8(dev, "width", width);
    qdev_prop_set_uint8(dev, "mappings", nb_mappings);
    qdev_prop_set_uint8(dev, "big-endian", !!be);
    qdev_prop_set_uint16(dev, "id0", id0);
    qdev_prop_set_uint16(dev, "id1", id1);
    qdev_prop_set_uint16(dev, "id2", id2);
    qdev_prop_set_uint16(dev, "id3", id3);
    qdev_prop_set_uint16(dev, "unlock-addr0", unlock_addr0);
    qdev_prop_set_uint16(dev, "unlock-addr1", unlock_addr1);
    qdev_prop_set_string(dev, "name", name);
    qdev_init_nofail(dev);

H
Hu Tao 已提交
813 814
    sysbus_mmio_map(SYS_BUS_DEVICE(dev), 0, base);
    return CFI_PFLASH02(dev);
815
}