Statistics
| Branch: | Revision:

root / hw / pflash_cfi01.c @ e9cbbcac

History | View | Annotate | Download (17.4 kB)

1
/*
2
 *  CFI parallel flash with Intel command set emulation
3
 *
4
 *  Copyright (c) 2006 Thorsten Zitterell
5
 *  Copyright (c) 2005 Jocelyn Mayer
6
 *
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.
11
 *
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.
16
 *
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/>.
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
 * - CFI queries
29
 *
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
35
 *
36
 * It does not implement much more ...
37
 */
38

    
39
#include "hw.h"
40
#include "flash.h"
41
#include "block.h"
42
#include "qemu-timer.h"
43

    
44
#define PFLASH_BUG(fmt, ...) \
45
do { \
46
    printf("PFLASH: Possible BUG - " fmt, ## __VA_ARGS__); \
47
    exit(1); \
48
} while(0)
49

    
50
/* #define PFLASH_DEBUG */
51
#ifdef PFLASH_DEBUG
52
#define DPRINTF(fmt, ...)                          \
53
do {                                               \
54
    printf("PFLASH: " fmt , ## __VA_ARGS__);       \
55
} while (0)
56
#else
57
#define DPRINTF(fmt, ...) do { } while (0)
58
#endif
59

    
60
struct pflash_t {
61
    BlockDriverState *bs;
62
    target_phys_addr_t base;
63
    target_phys_addr_t sector_len;
64
    target_phys_addr_t total_len;
65
    int width;
66
    int wcycle; /* if 0, the flash is read normally */
67
    int bypass;
68
    int ro;
69
    uint8_t cmd;
70
    uint8_t status;
71
    uint16_t ident[4];
72
    uint8_t cfi_len;
73
    uint8_t cfi_table[0x52];
74
    target_phys_addr_t counter;
75
    QEMUTimer *timer;
76
    ram_addr_t off;
77
    int fl_mem;
78
    void *storage;
79
};
80

    
81
static void pflash_timer (void *opaque)
82
{
83
    pflash_t *pfl = opaque;
84

    
85
    DPRINTF("%s: command %02x done\n", __func__, pfl->cmd);
86
    /* Reset flash */
87
    pfl->status ^= 0x80;
88
    if (pfl->bypass) {
89
        pfl->wcycle = 2;
90
    } else {
91
        cpu_register_physical_memory(pfl->base, pfl->total_len,
92
                        pfl->off | IO_MEM_ROMD | pfl->fl_mem);
93
        pfl->wcycle = 0;
94
    }
95
    pfl->cmd = 0;
96
}
97

    
98
static uint32_t pflash_read (pflash_t *pfl, target_phys_addr_t offset,
99
                             int width)
100
{
101
    target_phys_addr_t boff;
102
    uint32_t ret;
103
    uint8_t *p;
104

    
105
    ret = -1;
106
    boff = offset & 0xFF; /* why this here ?? */
107

    
108
    if (pfl->width == 2)
109
        boff = boff >> 1;
110
    else if (pfl->width == 4)
111
        boff = boff >> 2;
112

    
113
#if 0
114
    DPRINTF("%s: reading offset " TARGET_FMT_plx " under cmd %02x width %d\n",
115
            __func__, offset, pfl->cmd, width);
116
#endif
117
    switch (pfl->cmd) {
118
    case 0x00:
119
        /* Flash area read */
120
        p = pfl->storage;
121
        switch (width) {
122
        case 1:
123
            ret = p[offset];
124
            DPRINTF("%s: data offset " TARGET_FMT_plx " %02x\n",
125
                    __func__, offset, ret);
126
            break;
127
        case 2:
128
#if defined(TARGET_WORDS_BIGENDIAN)
129
            ret = p[offset] << 8;
130
            ret |= p[offset + 1];
131
#else
132
            ret = p[offset];
133
            ret |= p[offset + 1] << 8;
134
#endif
135
            DPRINTF("%s: data offset " TARGET_FMT_plx " %04x\n",
136
                    __func__, offset, ret);
137
            break;
138
        case 4:
139
#if defined(TARGET_WORDS_BIGENDIAN)
140
            ret = p[offset] << 24;
141
            ret |= p[offset + 1] << 16;
142
            ret |= p[offset + 2] << 8;
143
            ret |= p[offset + 3];
144
#else
145
            ret = p[offset];
146
            ret |= p[offset + 1] << 8;
147
            ret |= p[offset + 1] << 8;
148
            ret |= p[offset + 2] << 16;
149
            ret |= p[offset + 3] << 24;
150
#endif
151
            DPRINTF("%s: data offset " TARGET_FMT_plx " %08x\n",
152
                    __func__, offset, ret);
153
            break;
154
        default:
155
            DPRINTF("BUG in %s\n", __func__);
156
        }
157

    
158
        break;
159
    case 0x20: /* Block erase */
160
    case 0x50: /* Clear status register */
161
    case 0x60: /* Block /un)lock */
162
    case 0x70: /* Status Register */
163
    case 0xe8: /* Write block */
164
        /* Status register read */
165
        ret = pfl->status;
166
        DPRINTF("%s: status %x\n", __func__, ret);
167
        break;
168
    case 0x98: /* Query mode */
169
        if (boff > pfl->cfi_len)
170
            ret = 0;
171
        else
172
            ret = pfl->cfi_table[boff];
173
        break;
174
    default:
175
        /* This should never happen : reset state & treat it as a read */
176
        DPRINTF("%s: unknown command state: %x\n", __func__, pfl->cmd);
177
        pfl->wcycle = 0;
178
        pfl->cmd = 0;
179
    }
180
    return ret;
181
}
182

    
183
/* update flash content on disk */
184
static void pflash_update(pflash_t *pfl, int offset,
185
                          int size)
186
{
187
    int offset_end;
188
    if (pfl->bs) {
189
        offset_end = offset + size;
190
        /* round to sectors */
191
        offset = offset >> 9;
192
        offset_end = (offset_end + 511) >> 9;
193
        bdrv_write(pfl->bs, offset, pfl->storage + (offset << 9),
194
                   offset_end - offset);
195
    }
196
}
197

    
198
static inline void pflash_data_write(pflash_t *pfl, target_phys_addr_t offset,
199
                          uint32_t value, int width)
200
{
201
    uint8_t *p = pfl->storage;
202

    
203
    DPRINTF("%s: block write offset " TARGET_FMT_plx
204
            " value %x counter " TARGET_FMT_plx "\n",
205
            __func__, offset, value, pfl->counter);
206
    switch (width) {
207
    case 1:
208
        p[offset] = value;
209
        pflash_update(pfl, offset, 1);
210
        break;
211
    case 2:
212
#if defined(TARGET_WORDS_BIGENDIAN)
213
        p[offset] = value >> 8;
214
        p[offset + 1] = value;
215
#else
216
        p[offset] = value;
217
        p[offset + 1] = value >> 8;
218
#endif
219
        pflash_update(pfl, offset, 2);
220
        break;
221
    case 4:
222
#if defined(TARGET_WORDS_BIGENDIAN)
223
        p[offset] = value >> 24;
224
        p[offset + 1] = value >> 16;
225
        p[offset + 2] = value >> 8;
226
        p[offset + 3] = value;
227
#else
228
        p[offset] = value;
229
        p[offset + 1] = value >> 8;
230
        p[offset + 2] = value >> 16;
231
        p[offset + 3] = value >> 24;
232
#endif
233
        pflash_update(pfl, offset, 4);
234
        break;
235
    }
236

    
237
}
238

    
239
static void pflash_write(pflash_t *pfl, target_phys_addr_t offset,
240
                         uint32_t value, int width)
241
{
242
    uint8_t *p;
243
    uint8_t cmd;
244

    
245
    cmd = value;
246

    
247
    DPRINTF("%s: writing offset " TARGET_FMT_plx " value %08x width %d wcycle 0x%x\n",
248
            __func__, offset, value, width, pfl->wcycle);
249

    
250
    if (!pfl->wcycle) {
251
        /* Set the device in I/O access mode */
252
        cpu_register_physical_memory(pfl->base, pfl->total_len, pfl->fl_mem);
253
    }
254

    
255
    switch (pfl->wcycle) {
256
    case 0:
257
        /* read mode */
258
        switch (cmd) {
259
        case 0x00: /* ??? */
260
            goto reset_flash;
261
        case 0x10: /* Single Byte Program */
262
        case 0x40: /* Single Byte Program */
263
            DPRINTF("%s: Single Byte Program\n", __func__);
264
            break;
265
        case 0x20: /* Block erase */
266
            p = pfl->storage;
267
            offset &= ~(pfl->sector_len - 1);
268

    
269
            DPRINTF("%s: block erase at " TARGET_FMT_plx " bytes "
270
                    TARGET_FMT_plx "\n",
271
                    __func__, offset, pfl->sector_len);
272

    
273
            memset(p + offset, 0xff, pfl->sector_len);
274
            pflash_update(pfl, offset, pfl->sector_len);
275
            pfl->status |= 0x80; /* Ready! */
276
            break;
277
        case 0x50: /* Clear status bits */
278
            DPRINTF("%s: Clear status bits\n", __func__);
279
            pfl->status = 0x0;
280
            goto reset_flash;
281
        case 0x60: /* Block (un)lock */
282
            DPRINTF("%s: Block unlock\n", __func__);
283
            break;
284
        case 0x70: /* Status Register */
285
            DPRINTF("%s: Read status register\n", __func__);
286
            pfl->cmd = cmd;
287
            return;
288
        case 0x98: /* CFI query */
289
            DPRINTF("%s: CFI query\n", __func__);
290
            break;
291
        case 0xe8: /* Write to buffer */
292
            DPRINTF("%s: Write to buffer\n", __func__);
293
            pfl->status |= 0x80; /* Ready! */
294
            break;
295
        case 0xff: /* Read array mode */
296
            DPRINTF("%s: Read array mode\n", __func__);
297
            goto reset_flash;
298
        default:
299
            goto error_flash;
300
        }
301
        pfl->wcycle++;
302
        pfl->cmd = cmd;
303
        return;
304
    case 1:
305
        switch (pfl->cmd) {
306
        case 0x10: /* Single Byte Program */
307
        case 0x40: /* Single Byte Program */
308
            DPRINTF("%s: Single Byte Program\n", __func__);
309
            pflash_data_write(pfl, offset, value, width);
310
            pfl->status |= 0x80; /* Ready! */
311
            pfl->wcycle = 0;
312
        break;
313
        case 0x20: /* Block erase */
314
        case 0x28:
315
            if (cmd == 0xd0) { /* confirm */
316
                pfl->wcycle = 0;
317
                pfl->status |= 0x80;
318
            } else if (cmd == 0xff) { /* read array mode */
319
                goto reset_flash;
320
            } else
321
                goto error_flash;
322

    
323
            break;
324
        case 0xe8:
325
            DPRINTF("%s: block write of %x bytes\n", __func__, value);
326
            pfl->counter = value;
327
            pfl->wcycle++;
328
            break;
329
        case 0x60:
330
            if (cmd == 0xd0) {
331
                pfl->wcycle = 0;
332
                pfl->status |= 0x80;
333
            } else if (cmd == 0x01) {
334
                pfl->wcycle = 0;
335
                pfl->status |= 0x80;
336
            } else if (cmd == 0xff) {
337
                goto reset_flash;
338
            } else {
339
                DPRINTF("%s: Unknown (un)locking command\n", __func__);
340
                goto reset_flash;
341
            }
342
            break;
343
        case 0x98:
344
            if (cmd == 0xff) {
345
                goto reset_flash;
346
            } else {
347
                DPRINTF("%s: leaving query mode\n", __func__);
348
            }
349
            break;
350
        default:
351
            goto error_flash;
352
        }
353
        return;
354
    case 2:
355
        switch (pfl->cmd) {
356
        case 0xe8: /* Block write */
357
            pflash_data_write(pfl, offset, value, width);
358

    
359
            pfl->status |= 0x80;
360

    
361
            if (!pfl->counter) {
362
                DPRINTF("%s: block write finished\n", __func__);
363
                pfl->wcycle++;
364
            }
365

    
366
            pfl->counter--;
367
            break;
368
        default:
369
            goto error_flash;
370
        }
371
        return;
372
    case 3: /* Confirm mode */
373
        switch (pfl->cmd) {
374
        case 0xe8: /* Block write */
375
            if (cmd == 0xd0) {
376
                pfl->wcycle = 0;
377
                pfl->status |= 0x80;
378
            } else {
379
                DPRINTF("%s: unknown command for \"write block\"\n", __func__);
380
                PFLASH_BUG("Write block confirm");
381
                goto reset_flash;
382
            }
383
            break;
384
        default:
385
            goto error_flash;
386
        }
387
        return;
388
    default:
389
        /* Should never happen */
390
        DPRINTF("%s: invalid write state\n",  __func__);
391
        goto reset_flash;
392
    }
393
    return;
394

    
395
 error_flash:
396
    printf("%s: Unimplemented flash cmd sequence "
397
           "(offset " TARGET_FMT_plx ", wcycle 0x%x cmd 0x%x value 0x%x)\n",
398
           __func__, offset, pfl->wcycle, pfl->cmd, value);
399

    
400
 reset_flash:
401
    cpu_register_physical_memory(pfl->base, pfl->total_len,
402
                    pfl->off | IO_MEM_ROMD | pfl->fl_mem);
403

    
404
    pfl->bypass = 0;
405
    pfl->wcycle = 0;
406
    pfl->cmd = 0;
407
    return;
408
}
409

    
410

    
411
static uint32_t pflash_readb (void *opaque, target_phys_addr_t addr)
412
{
413
    return pflash_read(opaque, addr, 1);
414
}
415

    
416
static uint32_t pflash_readw (void *opaque, target_phys_addr_t addr)
417
{
418
    pflash_t *pfl = opaque;
419

    
420
    return pflash_read(pfl, addr, 2);
421
}
422

    
423
static uint32_t pflash_readl (void *opaque, target_phys_addr_t addr)
424
{
425
    pflash_t *pfl = opaque;
426

    
427
    return pflash_read(pfl, addr, 4);
428
}
429

    
430
static void pflash_writeb (void *opaque, target_phys_addr_t addr,
431
                           uint32_t value)
432
{
433
    pflash_write(opaque, addr, value, 1);
434
}
435

    
436
static void pflash_writew (void *opaque, target_phys_addr_t addr,
437
                           uint32_t value)
438
{
439
    pflash_t *pfl = opaque;
440

    
441
    pflash_write(pfl, addr, value, 2);
442
}
443

    
444
static void pflash_writel (void *opaque, target_phys_addr_t addr,
445
                           uint32_t value)
446
{
447
    pflash_t *pfl = opaque;
448

    
449
    pflash_write(pfl, addr, value, 4);
450
}
451

    
452
static CPUWriteMemoryFunc * const pflash_write_ops[] = {
453
    &pflash_writeb,
454
    &pflash_writew,
455
    &pflash_writel,
456
};
457

    
458
static CPUReadMemoryFunc * const pflash_read_ops[] = {
459
    &pflash_readb,
460
    &pflash_readw,
461
    &pflash_readl,
462
};
463

    
464
/* Count trailing zeroes of a 32 bits quantity */
465
static int ctz32 (uint32_t n)
466
{
467
    int ret;
468

    
469
    ret = 0;
470
    if (!(n & 0xFFFF)) {
471
        ret += 16;
472
        n = n >> 16;
473
    }
474
    if (!(n & 0xFF)) {
475
        ret += 8;
476
        n = n >> 8;
477
    }
478
    if (!(n & 0xF)) {
479
        ret += 4;
480
        n = n >> 4;
481
    }
482
    if (!(n & 0x3)) {
483
        ret += 2;
484
        n = n >> 2;
485
    }
486
    if (!(n & 0x1)) {
487
        ret++;
488
        n = n >> 1;
489
    }
490
#if 0 /* This is not necessary as n is never 0 */
491
    if (!n)
492
        ret++;
493
#endif
494

    
495
    return ret;
496
}
497

    
498
pflash_t *pflash_cfi01_register(target_phys_addr_t base, ram_addr_t off,
499
                                BlockDriverState *bs, uint32_t sector_len,
500
                                int nb_blocs, int width,
501
                                uint16_t id0, uint16_t id1,
502
                                uint16_t id2, uint16_t id3)
503
{
504
    pflash_t *pfl;
505
    target_phys_addr_t total_len;
506
    int ret;
507

    
508
    total_len = sector_len * nb_blocs;
509

    
510
    /* XXX: to be fixed */
511
#if 0
512
    if (total_len != (8 * 1024 * 1024) && total_len != (16 * 1024 * 1024) &&
513
        total_len != (32 * 1024 * 1024) && total_len != (64 * 1024 * 1024))
514
        return NULL;
515
#endif
516

    
517
    pfl = qemu_mallocz(sizeof(pflash_t));
518

    
519
    /* FIXME: Allocate ram ourselves.  */
520
    pfl->storage = qemu_get_ram_ptr(off);
521
    pfl->fl_mem = cpu_register_io_memory(
522
                    pflash_read_ops, pflash_write_ops, pfl);
523
    pfl->off = off;
524
    cpu_register_physical_memory(base, total_len,
525
                    off | pfl->fl_mem | IO_MEM_ROMD);
526

    
527
    pfl->bs = bs;
528
    if (pfl->bs) {
529
        /* read the initial flash content */
530
        ret = bdrv_read(pfl->bs, 0, pfl->storage, total_len >> 9);
531
        if (ret < 0) {
532
            cpu_unregister_io_memory(pfl->fl_mem);
533
            qemu_free(pfl);
534
            return NULL;
535
        }
536
    }
537
#if 0 /* XXX: there should be a bit to set up read-only,
538
       *      the same way the hardware does (with WP pin).
539
       */
540
    pfl->ro = 1;
541
#else
542
    pfl->ro = 0;
543
#endif
544
    pfl->timer = qemu_new_timer(vm_clock, pflash_timer, pfl);
545
    pfl->base = base;
546
    pfl->sector_len = sector_len;
547
    pfl->total_len = total_len;
548
    pfl->width = width;
549
    pfl->wcycle = 0;
550
    pfl->cmd = 0;
551
    pfl->status = 0;
552
    pfl->ident[0] = id0;
553
    pfl->ident[1] = id1;
554
    pfl->ident[2] = id2;
555
    pfl->ident[3] = id3;
556
    /* Hardcoded CFI table */
557
    pfl->cfi_len = 0x52;
558
    /* Standard "QRY" string */
559
    pfl->cfi_table[0x10] = 'Q';
560
    pfl->cfi_table[0x11] = 'R';
561
    pfl->cfi_table[0x12] = 'Y';
562
    /* Command set (Intel) */
563
    pfl->cfi_table[0x13] = 0x01;
564
    pfl->cfi_table[0x14] = 0x00;
565
    /* Primary extended table address (none) */
566
    pfl->cfi_table[0x15] = 0x31;
567
    pfl->cfi_table[0x16] = 0x00;
568
    /* Alternate command set (none) */
569
    pfl->cfi_table[0x17] = 0x00;
570
    pfl->cfi_table[0x18] = 0x00;
571
    /* Alternate extended table (none) */
572
    pfl->cfi_table[0x19] = 0x00;
573
    pfl->cfi_table[0x1A] = 0x00;
574
    /* Vcc min */
575
    pfl->cfi_table[0x1B] = 0x45;
576
    /* Vcc max */
577
    pfl->cfi_table[0x1C] = 0x55;
578
    /* Vpp min (no Vpp pin) */
579
    pfl->cfi_table[0x1D] = 0x00;
580
    /* Vpp max (no Vpp pin) */
581
    pfl->cfi_table[0x1E] = 0x00;
582
    /* Reserved */
583
    pfl->cfi_table[0x1F] = 0x07;
584
    /* Timeout for min size buffer write */
585
    pfl->cfi_table[0x20] = 0x07;
586
    /* Typical timeout for block erase */
587
    pfl->cfi_table[0x21] = 0x0a;
588
    /* Typical timeout for full chip erase (4096 ms) */
589
    pfl->cfi_table[0x22] = 0x00;
590
    /* Reserved */
591
    pfl->cfi_table[0x23] = 0x04;
592
    /* Max timeout for buffer write */
593
    pfl->cfi_table[0x24] = 0x04;
594
    /* Max timeout for block erase */
595
    pfl->cfi_table[0x25] = 0x04;
596
    /* Max timeout for chip erase */
597
    pfl->cfi_table[0x26] = 0x00;
598
    /* Device size */
599
    pfl->cfi_table[0x27] = ctz32(total_len); // + 1;
600
    /* Flash device interface (8 & 16 bits) */
601
    pfl->cfi_table[0x28] = 0x02;
602
    pfl->cfi_table[0x29] = 0x00;
603
    /* Max number of bytes in multi-bytes write */
604
    if (width == 1) {
605
        pfl->cfi_table[0x2A] = 0x08;
606
    } else {
607
        pfl->cfi_table[0x2A] = 0x0B;
608
    }
609
    pfl->cfi_table[0x2B] = 0x00;
610
    /* Number of erase block regions (uniform) */
611
    pfl->cfi_table[0x2C] = 0x01;
612
    /* Erase block region 1 */
613
    pfl->cfi_table[0x2D] = nb_blocs - 1;
614
    pfl->cfi_table[0x2E] = (nb_blocs - 1) >> 8;
615
    pfl->cfi_table[0x2F] = sector_len >> 8;
616
    pfl->cfi_table[0x30] = sector_len >> 16;
617

    
618
    /* Extended */
619
    pfl->cfi_table[0x31] = 'P';
620
    pfl->cfi_table[0x32] = 'R';
621
    pfl->cfi_table[0x33] = 'I';
622

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

    
626
    pfl->cfi_table[0x36] = 0x00;
627
    pfl->cfi_table[0x37] = 0x00;
628
    pfl->cfi_table[0x38] = 0x00;
629
    pfl->cfi_table[0x39] = 0x00;
630

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

    
633
    pfl->cfi_table[0x3b] = 0x00;
634
    pfl->cfi_table[0x3c] = 0x00;
635

    
636
    return pfl;
637
}