Statistics
| Branch: | Revision:

root / hw / nand.c @ dc638fad

History | View | Annotate | Download (19.4 kB)

1 3e3d5815 balrog
/*
2 3e3d5815 balrog
 * Flash NAND memory emulation.  Based on "16M x 8 Bit NAND Flash
3 3e3d5815 balrog
 * Memory" datasheet for the KM29U128AT / K9F2808U0A chips from
4 3e3d5815 balrog
 * Samsung Electronic.
5 3e3d5815 balrog
 *
6 3e3d5815 balrog
 * Copyright (c) 2006 Openedhand Ltd.
7 3e3d5815 balrog
 * Written by Andrzej Zaborowski <balrog@zabor.org>
8 3e3d5815 balrog
 *
9 3e3d5815 balrog
 * This code is licensed under the GNU GPL v2.
10 3e3d5815 balrog
 */
11 3e3d5815 balrog
12 3e3d5815 balrog
#ifndef NAND_IO
13 3e3d5815 balrog
14 87ecb68b pbrook
# include "hw.h"
15 87ecb68b pbrook
# include "flash.h"
16 666daa68 Markus Armbruster
# include "blockdev.h"
17 87ecb68b pbrook
/* FIXME: Pass block device as an argument.  */
18 3e3d5815 balrog
19 3e3d5815 balrog
# define NAND_CMD_READ0                0x00
20 3e3d5815 balrog
# define NAND_CMD_READ1                0x01
21 3e3d5815 balrog
# define NAND_CMD_READ2                0x50
22 3e3d5815 balrog
# define NAND_CMD_LPREAD2        0x30
23 3e3d5815 balrog
# define NAND_CMD_NOSERIALREAD2        0x35
24 3e3d5815 balrog
# define NAND_CMD_RANDOMREAD1        0x05
25 3e3d5815 balrog
# define NAND_CMD_RANDOMREAD2        0xe0
26 3e3d5815 balrog
# define NAND_CMD_READID        0x90
27 3e3d5815 balrog
# define NAND_CMD_RESET                0xff
28 3e3d5815 balrog
# define NAND_CMD_PAGEPROGRAM1        0x80
29 3e3d5815 balrog
# define NAND_CMD_PAGEPROGRAM2        0x10
30 3e3d5815 balrog
# define NAND_CMD_CACHEPROGRAM2        0x15
31 3e3d5815 balrog
# define NAND_CMD_BLOCKERASE1        0x60
32 3e3d5815 balrog
# define NAND_CMD_BLOCKERASE2        0xd0
33 3e3d5815 balrog
# define NAND_CMD_READSTATUS        0x70
34 3e3d5815 balrog
# define NAND_CMD_COPYBACKPRG1        0x85
35 3e3d5815 balrog
36 3e3d5815 balrog
# define NAND_IOSTATUS_ERROR        (1 << 0)
37 3e3d5815 balrog
# define NAND_IOSTATUS_PLANE0        (1 << 1)
38 3e3d5815 balrog
# define NAND_IOSTATUS_PLANE1        (1 << 2)
39 3e3d5815 balrog
# define NAND_IOSTATUS_PLANE2        (1 << 3)
40 3e3d5815 balrog
# define NAND_IOSTATUS_PLANE3        (1 << 4)
41 3e3d5815 balrog
# define NAND_IOSTATUS_BUSY        (1 << 6)
42 3e3d5815 balrog
# define NAND_IOSTATUS_UNPROTCT        (1 << 7)
43 3e3d5815 balrog
44 3e3d5815 balrog
# define MAX_PAGE                0x800
45 3e3d5815 balrog
# define MAX_OOB                0x40
46 3e3d5815 balrog
47 bc24a225 Paul Brook
struct NANDFlashState {
48 3e3d5815 balrog
    uint8_t manf_id, chip_id;
49 3e3d5815 balrog
    int size, pages;
50 3e3d5815 balrog
    int page_shift, oob_shift, erase_shift, addr_shift;
51 3e3d5815 balrog
    uint8_t *storage;
52 3e3d5815 balrog
    BlockDriverState *bdrv;
53 3e3d5815 balrog
    int mem_oob;
54 3e3d5815 balrog
55 51db57f7 Juan Quintela
    uint8_t cle, ale, ce, wp, gnd;
56 3e3d5815 balrog
57 3e3d5815 balrog
    uint8_t io[MAX_PAGE + MAX_OOB + 0x400];
58 3e3d5815 balrog
    uint8_t *ioaddr;
59 3e3d5815 balrog
    int iolen;
60 3e3d5815 balrog
61 3e3d5815 balrog
    uint32_t cmd, addr;
62 3e3d5815 balrog
    int addrlen;
63 3e3d5815 balrog
    int status;
64 3e3d5815 balrog
    int offset;
65 3e3d5815 balrog
66 bc24a225 Paul Brook
    void (*blk_write)(NANDFlashState *s);
67 bc24a225 Paul Brook
    void (*blk_erase)(NANDFlashState *s);
68 bc24a225 Paul Brook
    void (*blk_load)(NANDFlashState *s, uint32_t addr, int offset);
69 7b9a3d86 Juan Quintela
70 7b9a3d86 Juan Quintela
    uint32_t ioaddr_vmstate;
71 3e3d5815 balrog
};
72 3e3d5815 balrog
73 3e3d5815 balrog
# define NAND_NO_AUTOINCR        0x00000001
74 3e3d5815 balrog
# define NAND_BUSWIDTH_16        0x00000002
75 3e3d5815 balrog
# define NAND_NO_PADDING        0x00000004
76 3e3d5815 balrog
# define NAND_CACHEPRG                0x00000008
77 3e3d5815 balrog
# define NAND_COPYBACK                0x00000010
78 3e3d5815 balrog
# define NAND_IS_AND                0x00000020
79 3e3d5815 balrog
# define NAND_4PAGE_ARRAY        0x00000040
80 3e3d5815 balrog
# define NAND_NO_READRDY        0x00000100
81 3e3d5815 balrog
# define NAND_SAMSUNG_LP        (NAND_NO_PADDING | NAND_COPYBACK)
82 3e3d5815 balrog
83 3e3d5815 balrog
# define NAND_IO
84 3e3d5815 balrog
85 3e3d5815 balrog
# define PAGE(addr)                ((addr) >> ADDR_SHIFT)
86 3e3d5815 balrog
# define PAGE_START(page)        (PAGE(page) * (PAGE_SIZE + OOB_SIZE))
87 3e3d5815 balrog
# define PAGE_MASK                ((1 << ADDR_SHIFT) - 1)
88 3e3d5815 balrog
# define OOB_SHIFT                (PAGE_SHIFT - 5)
89 3e3d5815 balrog
# define OOB_SIZE                (1 << OOB_SHIFT)
90 3e3d5815 balrog
# define SECTOR(addr)                ((addr) >> (9 + ADDR_SHIFT - PAGE_SHIFT))
91 3e3d5815 balrog
# define SECTOR_OFFSET(addr)        ((addr) & ((511 >> PAGE_SHIFT) << 8))
92 3e3d5815 balrog
93 3e3d5815 balrog
# define PAGE_SIZE                256
94 3e3d5815 balrog
# define PAGE_SHIFT                8
95 3e3d5815 balrog
# define PAGE_SECTORS                1
96 3e3d5815 balrog
# define ADDR_SHIFT                8
97 3e3d5815 balrog
# include "nand.c"
98 3e3d5815 balrog
# define PAGE_SIZE                512
99 3e3d5815 balrog
# define PAGE_SHIFT                9
100 3e3d5815 balrog
# define PAGE_SECTORS                1
101 3e3d5815 balrog
# define ADDR_SHIFT                8
102 3e3d5815 balrog
# include "nand.c"
103 3e3d5815 balrog
# define PAGE_SIZE                2048
104 3e3d5815 balrog
# define PAGE_SHIFT                11
105 3e3d5815 balrog
# define PAGE_SECTORS                4
106 3e3d5815 balrog
# define ADDR_SHIFT                16
107 3e3d5815 balrog
# include "nand.c"
108 3e3d5815 balrog
109 3e3d5815 balrog
/* Information based on Linux drivers/mtd/nand/nand_ids.c */
110 bc24a225 Paul Brook
static const struct {
111 3e3d5815 balrog
    int size;
112 3e3d5815 balrog
    int width;
113 3e3d5815 balrog
    int page_shift;
114 3e3d5815 balrog
    int erase_shift;
115 3e3d5815 balrog
    uint32_t options;
116 3e3d5815 balrog
} nand_flash_ids[0x100] = {
117 3e3d5815 balrog
    [0 ... 0xff] = { 0 },
118 3e3d5815 balrog
119 3e3d5815 balrog
    [0x6e] = { 1,        8,        8, 4, 0 },
120 3e3d5815 balrog
    [0x64] = { 2,        8,        8, 4, 0 },
121 3e3d5815 balrog
    [0x6b] = { 4,        8,        9, 4, 0 },
122 3e3d5815 balrog
    [0xe8] = { 1,        8,        8, 4, 0 },
123 3e3d5815 balrog
    [0xec] = { 1,        8,        8, 4, 0 },
124 3e3d5815 balrog
    [0xea] = { 2,        8,        8, 4, 0 },
125 3e3d5815 balrog
    [0xd5] = { 4,        8,        9, 4, 0 },
126 3e3d5815 balrog
    [0xe3] = { 4,        8,        9, 4, 0 },
127 3e3d5815 balrog
    [0xe5] = { 4,        8,        9, 4, 0 },
128 3e3d5815 balrog
    [0xd6] = { 8,        8,        9, 4, 0 },
129 3e3d5815 balrog
130 3e3d5815 balrog
    [0x39] = { 8,        8,        9, 4, 0 },
131 3e3d5815 balrog
    [0xe6] = { 8,        8,        9, 4, 0 },
132 3e3d5815 balrog
    [0x49] = { 8,        16,        9, 4, NAND_BUSWIDTH_16 },
133 3e3d5815 balrog
    [0x59] = { 8,        16,        9, 4, NAND_BUSWIDTH_16 },
134 3e3d5815 balrog
135 3e3d5815 balrog
    [0x33] = { 16,        8,        9, 5, 0 },
136 3e3d5815 balrog
    [0x73] = { 16,        8,        9, 5, 0 },
137 3e3d5815 balrog
    [0x43] = { 16,        16,        9, 5, NAND_BUSWIDTH_16 },
138 3e3d5815 balrog
    [0x53] = { 16,        16,        9, 5, NAND_BUSWIDTH_16 },
139 3e3d5815 balrog
140 3e3d5815 balrog
    [0x35] = { 32,        8,        9, 5, 0 },
141 3e3d5815 balrog
    [0x75] = { 32,        8,        9, 5, 0 },
142 3e3d5815 balrog
    [0x45] = { 32,        16,        9, 5, NAND_BUSWIDTH_16 },
143 3e3d5815 balrog
    [0x55] = { 32,        16,        9, 5, NAND_BUSWIDTH_16 },
144 3e3d5815 balrog
145 3e3d5815 balrog
    [0x36] = { 64,        8,        9, 5, 0 },
146 3e3d5815 balrog
    [0x76] = { 64,        8,        9, 5, 0 },
147 3e3d5815 balrog
    [0x46] = { 64,        16,        9, 5, NAND_BUSWIDTH_16 },
148 3e3d5815 balrog
    [0x56] = { 64,        16,        9, 5, NAND_BUSWIDTH_16 },
149 3e3d5815 balrog
150 3e3d5815 balrog
    [0x78] = { 128,        8,        9, 5, 0 },
151 3e3d5815 balrog
    [0x39] = { 128,        8,        9, 5, 0 },
152 3e3d5815 balrog
    [0x79] = { 128,        8,        9, 5, 0 },
153 3e3d5815 balrog
    [0x72] = { 128,        16,        9, 5, NAND_BUSWIDTH_16 },
154 3e3d5815 balrog
    [0x49] = { 128,        16,        9, 5, NAND_BUSWIDTH_16 },
155 3e3d5815 balrog
    [0x74] = { 128,        16,        9, 5, NAND_BUSWIDTH_16 },
156 3e3d5815 balrog
    [0x59] = { 128,        16,        9, 5, NAND_BUSWIDTH_16 },
157 3e3d5815 balrog
158 3e3d5815 balrog
    [0x71] = { 256,        8,        9, 5, 0 },
159 3e3d5815 balrog
160 3e3d5815 balrog
    /*
161 3e3d5815 balrog
     * These are the new chips with large page size. The pagesize and the
162 3e3d5815 balrog
     * erasesize is determined from the extended id bytes
163 3e3d5815 balrog
     */
164 3e3d5815 balrog
# define LP_OPTIONS        (NAND_SAMSUNG_LP | NAND_NO_READRDY | NAND_NO_AUTOINCR)
165 3e3d5815 balrog
# define LP_OPTIONS16        (LP_OPTIONS | NAND_BUSWIDTH_16)
166 3e3d5815 balrog
167 3e3d5815 balrog
    /* 512 Megabit */
168 3e3d5815 balrog
    [0xa2] = { 64,        8,        0, 0, LP_OPTIONS },
169 3e3d5815 balrog
    [0xf2] = { 64,        8,        0, 0, LP_OPTIONS },
170 3e3d5815 balrog
    [0xb2] = { 64,        16,        0, 0, LP_OPTIONS16 },
171 3e3d5815 balrog
    [0xc2] = { 64,        16,        0, 0, LP_OPTIONS16 },
172 3e3d5815 balrog
173 3e3d5815 balrog
    /* 1 Gigabit */
174 3e3d5815 balrog
    [0xa1] = { 128,        8,        0, 0, LP_OPTIONS },
175 3e3d5815 balrog
    [0xf1] = { 128,        8,        0, 0, LP_OPTIONS },
176 3e3d5815 balrog
    [0xb1] = { 128,        16,        0, 0, LP_OPTIONS16 },
177 3e3d5815 balrog
    [0xc1] = { 128,        16,        0, 0, LP_OPTIONS16 },
178 3e3d5815 balrog
179 3e3d5815 balrog
    /* 2 Gigabit */
180 3e3d5815 balrog
    [0xaa] = { 256,        8,        0, 0, LP_OPTIONS },
181 3e3d5815 balrog
    [0xda] = { 256,        8,        0, 0, LP_OPTIONS },
182 3e3d5815 balrog
    [0xba] = { 256,        16,        0, 0, LP_OPTIONS16 },
183 3e3d5815 balrog
    [0xca] = { 256,        16,        0, 0, LP_OPTIONS16 },
184 3e3d5815 balrog
185 3e3d5815 balrog
    /* 4 Gigabit */
186 3e3d5815 balrog
    [0xac] = { 512,        8,        0, 0, LP_OPTIONS },
187 3e3d5815 balrog
    [0xdc] = { 512,        8,        0, 0, LP_OPTIONS },
188 3e3d5815 balrog
    [0xbc] = { 512,        16,        0, 0, LP_OPTIONS16 },
189 3e3d5815 balrog
    [0xcc] = { 512,        16,        0, 0, LP_OPTIONS16 },
190 3e3d5815 balrog
191 3e3d5815 balrog
    /* 8 Gigabit */
192 3e3d5815 balrog
    [0xa3] = { 1024,        8,        0, 0, LP_OPTIONS },
193 3e3d5815 balrog
    [0xd3] = { 1024,        8,        0, 0, LP_OPTIONS },
194 3e3d5815 balrog
    [0xb3] = { 1024,        16,        0, 0, LP_OPTIONS16 },
195 3e3d5815 balrog
    [0xc3] = { 1024,        16,        0, 0, LP_OPTIONS16 },
196 3e3d5815 balrog
197 3e3d5815 balrog
    /* 16 Gigabit */
198 3e3d5815 balrog
    [0xa5] = { 2048,        8,        0, 0, LP_OPTIONS },
199 3e3d5815 balrog
    [0xd5] = { 2048,        8,        0, 0, LP_OPTIONS },
200 3e3d5815 balrog
    [0xb5] = { 2048,        16,        0, 0, LP_OPTIONS16 },
201 3e3d5815 balrog
    [0xc5] = { 2048,        16,        0, 0, LP_OPTIONS16 },
202 3e3d5815 balrog
};
203 3e3d5815 balrog
204 bc24a225 Paul Brook
static void nand_reset(NANDFlashState *s)
205 3e3d5815 balrog
{
206 3e3d5815 balrog
    s->cmd = NAND_CMD_READ0;
207 3e3d5815 balrog
    s->addr = 0;
208 3e3d5815 balrog
    s->addrlen = 0;
209 3e3d5815 balrog
    s->iolen = 0;
210 3e3d5815 balrog
    s->offset = 0;
211 3e3d5815 balrog
    s->status &= NAND_IOSTATUS_UNPROTCT;
212 3e3d5815 balrog
}
213 3e3d5815 balrog
214 bc24a225 Paul Brook
static void nand_command(NANDFlashState *s)
215 3e3d5815 balrog
{
216 fccd2613 Edgar E. Iglesias
    unsigned int offset;
217 3e3d5815 balrog
    switch (s->cmd) {
218 3e3d5815 balrog
    case NAND_CMD_READ0:
219 3e3d5815 balrog
        s->iolen = 0;
220 3e3d5815 balrog
        break;
221 3e3d5815 balrog
222 3e3d5815 balrog
    case NAND_CMD_READID:
223 3e3d5815 balrog
        s->io[0] = s->manf_id;
224 3e3d5815 balrog
        s->io[1] = s->chip_id;
225 3e3d5815 balrog
        s->io[2] = 'Q';                /* Don't-care byte (often 0xa5) */
226 3e3d5815 balrog
        if (nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP)
227 3e3d5815 balrog
            s->io[3] = 0x15;        /* Page Size, Block Size, Spare Size.. */
228 3e3d5815 balrog
        else
229 3e3d5815 balrog
            s->io[3] = 0xc0;        /* Multi-plane */
230 3e3d5815 balrog
        s->ioaddr = s->io;
231 3e3d5815 balrog
        s->iolen = 4;
232 3e3d5815 balrog
        break;
233 3e3d5815 balrog
234 3e3d5815 balrog
    case NAND_CMD_RANDOMREAD2:
235 3e3d5815 balrog
    case NAND_CMD_NOSERIALREAD2:
236 3e3d5815 balrog
        if (!(nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP))
237 3e3d5815 balrog
            break;
238 fccd2613 Edgar E. Iglesias
        offset = s->addr & ((1 << s->addr_shift) - 1);
239 fccd2613 Edgar E. Iglesias
        s->blk_load(s, s->addr, offset);
240 fccd2613 Edgar E. Iglesias
        if (s->gnd)
241 fccd2613 Edgar E. Iglesias
            s->iolen = (1 << s->page_shift) - offset;
242 fccd2613 Edgar E. Iglesias
        else
243 fccd2613 Edgar E. Iglesias
            s->iolen = (1 << s->page_shift) + (1 << s->oob_shift) - offset;
244 3e3d5815 balrog
        break;
245 3e3d5815 balrog
246 3e3d5815 balrog
    case NAND_CMD_RESET:
247 3e3d5815 balrog
        nand_reset(s);
248 3e3d5815 balrog
        break;
249 3e3d5815 balrog
250 3e3d5815 balrog
    case NAND_CMD_PAGEPROGRAM1:
251 3e3d5815 balrog
        s->ioaddr = s->io;
252 3e3d5815 balrog
        s->iolen = 0;
253 3e3d5815 balrog
        break;
254 3e3d5815 balrog
255 3e3d5815 balrog
    case NAND_CMD_PAGEPROGRAM2:
256 3e3d5815 balrog
        if (s->wp) {
257 3e3d5815 balrog
            s->blk_write(s);
258 3e3d5815 balrog
        }
259 3e3d5815 balrog
        break;
260 3e3d5815 balrog
261 3e3d5815 balrog
    case NAND_CMD_BLOCKERASE1:
262 3e3d5815 balrog
        break;
263 3e3d5815 balrog
264 3e3d5815 balrog
    case NAND_CMD_BLOCKERASE2:
265 3e3d5815 balrog
        if (nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP)
266 3e3d5815 balrog
            s->addr <<= 16;
267 3e3d5815 balrog
        else
268 3e3d5815 balrog
            s->addr <<= 8;
269 3e3d5815 balrog
270 3e3d5815 balrog
        if (s->wp) {
271 3e3d5815 balrog
            s->blk_erase(s);
272 3e3d5815 balrog
        }
273 3e3d5815 balrog
        break;
274 3e3d5815 balrog
275 3e3d5815 balrog
    case NAND_CMD_READSTATUS:
276 3e3d5815 balrog
        s->io[0] = s->status;
277 3e3d5815 balrog
        s->ioaddr = s->io;
278 3e3d5815 balrog
        s->iolen = 1;
279 3e3d5815 balrog
        break;
280 3e3d5815 balrog
281 3e3d5815 balrog
    default:
282 3e3d5815 balrog
        printf("%s: Unknown NAND command 0x%02x\n", __FUNCTION__, s->cmd);
283 3e3d5815 balrog
    }
284 3e3d5815 balrog
}
285 3e3d5815 balrog
286 7b9a3d86 Juan Quintela
static void nand_pre_save(void *opaque)
287 aa941b94 balrog
{
288 7b9a3d86 Juan Quintela
    NANDFlashState *s = opaque;
289 7b9a3d86 Juan Quintela
290 7b9a3d86 Juan Quintela
    s->ioaddr_vmstate = s->ioaddr - s->io;
291 aa941b94 balrog
}
292 aa941b94 balrog
293 7b9a3d86 Juan Quintela
static int nand_post_load(void *opaque, int version_id)
294 aa941b94 balrog
{
295 7b9a3d86 Juan Quintela
    NANDFlashState *s = opaque;
296 7b9a3d86 Juan Quintela
297 7b9a3d86 Juan Quintela
    if (s->ioaddr_vmstate > sizeof(s->io)) {
298 aa941b94 balrog
        return -EINVAL;
299 7b9a3d86 Juan Quintela
    }
300 7b9a3d86 Juan Quintela
    s->ioaddr = s->io + s->ioaddr_vmstate;
301 aa941b94 balrog
302 aa941b94 balrog
    return 0;
303 aa941b94 balrog
}
304 aa941b94 balrog
305 7b9a3d86 Juan Quintela
static const VMStateDescription vmstate_nand = {
306 7b9a3d86 Juan Quintela
    .name = "nand",
307 7b9a3d86 Juan Quintela
    .version_id = 0,
308 7b9a3d86 Juan Quintela
    .minimum_version_id = 0,
309 7b9a3d86 Juan Quintela
    .minimum_version_id_old = 0,
310 7b9a3d86 Juan Quintela
    .pre_save = nand_pre_save,
311 7b9a3d86 Juan Quintela
    .post_load = nand_post_load,
312 7b9a3d86 Juan Quintela
    .fields      = (VMStateField[]) {
313 7b9a3d86 Juan Quintela
        VMSTATE_UINT8(cle, NANDFlashState),
314 7b9a3d86 Juan Quintela
        VMSTATE_UINT8(ale, NANDFlashState),
315 7b9a3d86 Juan Quintela
        VMSTATE_UINT8(ce, NANDFlashState),
316 7b9a3d86 Juan Quintela
        VMSTATE_UINT8(wp, NANDFlashState),
317 7b9a3d86 Juan Quintela
        VMSTATE_UINT8(gnd, NANDFlashState),
318 7b9a3d86 Juan Quintela
        VMSTATE_BUFFER(io, NANDFlashState),
319 7b9a3d86 Juan Quintela
        VMSTATE_UINT32(ioaddr_vmstate, NANDFlashState),
320 7b9a3d86 Juan Quintela
        VMSTATE_INT32(iolen, NANDFlashState),
321 7b9a3d86 Juan Quintela
        VMSTATE_UINT32(cmd, NANDFlashState),
322 7b9a3d86 Juan Quintela
        VMSTATE_UINT32(addr, NANDFlashState),
323 7b9a3d86 Juan Quintela
        VMSTATE_INT32(addrlen, NANDFlashState),
324 7b9a3d86 Juan Quintela
        VMSTATE_INT32(status, NANDFlashState),
325 7b9a3d86 Juan Quintela
        VMSTATE_INT32(offset, NANDFlashState),
326 7b9a3d86 Juan Quintela
        /* XXX: do we want to save s->storage too? */
327 7b9a3d86 Juan Quintela
        VMSTATE_END_OF_LIST()
328 7b9a3d86 Juan Quintela
    }
329 7b9a3d86 Juan Quintela
};
330 7b9a3d86 Juan Quintela
331 3e3d5815 balrog
/*
332 3e3d5815 balrog
 * Chip inputs are CLE, ALE, CE, WP, GND and eight I/O pins.  Chip
333 3e3d5815 balrog
 * outputs are R/B and eight I/O pins.
334 3e3d5815 balrog
 *
335 3e3d5815 balrog
 * CE, WP and R/B are active low.
336 3e3d5815 balrog
 */
337 51db57f7 Juan Quintela
void nand_setpins(NANDFlashState *s, uint8_t cle, uint8_t ale,
338 51db57f7 Juan Quintela
                  uint8_t ce, uint8_t wp, uint8_t gnd)
339 3e3d5815 balrog
{
340 3e3d5815 balrog
    s->cle = cle;
341 3e3d5815 balrog
    s->ale = ale;
342 3e3d5815 balrog
    s->ce = ce;
343 3e3d5815 balrog
    s->wp = wp;
344 3e3d5815 balrog
    s->gnd = gnd;
345 3e3d5815 balrog
    if (wp)
346 3e3d5815 balrog
        s->status |= NAND_IOSTATUS_UNPROTCT;
347 3e3d5815 balrog
    else
348 3e3d5815 balrog
        s->status &= ~NAND_IOSTATUS_UNPROTCT;
349 3e3d5815 balrog
}
350 3e3d5815 balrog
351 bc24a225 Paul Brook
void nand_getpins(NANDFlashState *s, int *rb)
352 3e3d5815 balrog
{
353 3e3d5815 balrog
    *rb = 1;
354 3e3d5815 balrog
}
355 3e3d5815 balrog
356 bc24a225 Paul Brook
void nand_setio(NANDFlashState *s, uint8_t value)
357 3e3d5815 balrog
{
358 3e3d5815 balrog
    if (!s->ce && s->cle) {
359 3e3d5815 balrog
        if (nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP) {
360 3e3d5815 balrog
            if (s->cmd == NAND_CMD_READ0 && value == NAND_CMD_LPREAD2)
361 3e3d5815 balrog
                return;
362 3e3d5815 balrog
            if (value == NAND_CMD_RANDOMREAD1) {
363 3e3d5815 balrog
                s->addr &= ~((1 << s->addr_shift) - 1);
364 3e3d5815 balrog
                s->addrlen = 0;
365 3e3d5815 balrog
                return;
366 3e3d5815 balrog
            }
367 3e3d5815 balrog
        }
368 3e3d5815 balrog
        if (value == NAND_CMD_READ0)
369 3e3d5815 balrog
            s->offset = 0;
370 3e3d5815 balrog
        else if (value == NAND_CMD_READ1) {
371 3e3d5815 balrog
            s->offset = 0x100;
372 3e3d5815 balrog
            value = NAND_CMD_READ0;
373 3e3d5815 balrog
        }
374 3e3d5815 balrog
        else if (value == NAND_CMD_READ2) {
375 3e3d5815 balrog
            s->offset = 1 << s->page_shift;
376 3e3d5815 balrog
            value = NAND_CMD_READ0;
377 3e3d5815 balrog
        }
378 3e3d5815 balrog
379 3e3d5815 balrog
        s->cmd = value;
380 3e3d5815 balrog
381 3e3d5815 balrog
        if (s->cmd == NAND_CMD_READSTATUS ||
382 3e3d5815 balrog
                s->cmd == NAND_CMD_PAGEPROGRAM2 ||
383 3e3d5815 balrog
                s->cmd == NAND_CMD_BLOCKERASE1 ||
384 3e3d5815 balrog
                s->cmd == NAND_CMD_BLOCKERASE2 ||
385 3e3d5815 balrog
                s->cmd == NAND_CMD_NOSERIALREAD2 ||
386 3e3d5815 balrog
                s->cmd == NAND_CMD_RANDOMREAD2 ||
387 3e3d5815 balrog
                s->cmd == NAND_CMD_RESET)
388 3e3d5815 balrog
            nand_command(s);
389 3e3d5815 balrog
390 3e3d5815 balrog
        if (s->cmd != NAND_CMD_RANDOMREAD2) {
391 3e3d5815 balrog
            s->addrlen = 0;
392 3e3d5815 balrog
        }
393 3e3d5815 balrog
    }
394 3e3d5815 balrog
395 3e3d5815 balrog
    if (s->ale) {
396 fccd2613 Edgar E. Iglesias
        unsigned int shift = s->addrlen * 8;
397 fccd2613 Edgar E. Iglesias
        unsigned int mask = ~(0xff << shift);
398 fccd2613 Edgar E. Iglesias
        unsigned int v = value << shift;
399 fccd2613 Edgar E. Iglesias
400 fccd2613 Edgar E. Iglesias
        s->addr = (s->addr & mask) | v;
401 3e3d5815 balrog
        s->addrlen ++;
402 3e3d5815 balrog
403 3e3d5815 balrog
        if (s->addrlen == 1 && s->cmd == NAND_CMD_READID)
404 3e3d5815 balrog
            nand_command(s);
405 3e3d5815 balrog
406 3e3d5815 balrog
        if (!(nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP) &&
407 3e3d5815 balrog
                s->addrlen == 3 && (
408 3e3d5815 balrog
                    s->cmd == NAND_CMD_READ0 ||
409 3e3d5815 balrog
                    s->cmd == NAND_CMD_PAGEPROGRAM1))
410 3e3d5815 balrog
            nand_command(s);
411 3e3d5815 balrog
        if ((nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP) &&
412 3e3d5815 balrog
               s->addrlen == 4 && (
413 3e3d5815 balrog
                    s->cmd == NAND_CMD_READ0 ||
414 3e3d5815 balrog
                    s->cmd == NAND_CMD_PAGEPROGRAM1))
415 3e3d5815 balrog
            nand_command(s);
416 3e3d5815 balrog
    }
417 3e3d5815 balrog
418 3e3d5815 balrog
    if (!s->cle && !s->ale && s->cmd == NAND_CMD_PAGEPROGRAM1) {
419 3e3d5815 balrog
        if (s->iolen < (1 << s->page_shift) + (1 << s->oob_shift))
420 3e3d5815 balrog
            s->io[s->iolen ++] = value;
421 3e3d5815 balrog
    } else if (!s->cle && !s->ale && s->cmd == NAND_CMD_COPYBACKPRG1) {
422 3e3d5815 balrog
        if ((s->addr & ((1 << s->addr_shift) - 1)) <
423 3e3d5815 balrog
                (1 << s->page_shift) + (1 << s->oob_shift)) {
424 3e3d5815 balrog
            s->io[s->iolen + (s->addr & ((1 << s->addr_shift) - 1))] = value;
425 3e3d5815 balrog
            s->addr ++;
426 3e3d5815 balrog
        }
427 3e3d5815 balrog
    }
428 3e3d5815 balrog
}
429 3e3d5815 balrog
430 bc24a225 Paul Brook
uint8_t nand_getio(NANDFlashState *s)
431 3e3d5815 balrog
{
432 3e3d5815 balrog
    int offset;
433 5fafdf24 ths
434 3e3d5815 balrog
    /* Allow sequential reading */
435 3e3d5815 balrog
    if (!s->iolen && s->cmd == NAND_CMD_READ0) {
436 3e3d5815 balrog
        offset = (s->addr & ((1 << s->addr_shift) - 1)) + s->offset;
437 3e3d5815 balrog
        s->offset = 0;
438 3e3d5815 balrog
439 3e3d5815 balrog
        s->blk_load(s, s->addr, offset);
440 3e3d5815 balrog
        if (s->gnd)
441 3e3d5815 balrog
            s->iolen = (1 << s->page_shift) - offset;
442 3e3d5815 balrog
        else
443 3e3d5815 balrog
            s->iolen = (1 << s->page_shift) + (1 << s->oob_shift) - offset;
444 3e3d5815 balrog
    }
445 3e3d5815 balrog
446 3e3d5815 balrog
    if (s->ce || s->iolen <= 0)
447 3e3d5815 balrog
        return 0;
448 3e3d5815 balrog
449 3e3d5815 balrog
    s->iolen --;
450 fccd2613 Edgar E. Iglesias
    s->addr++;
451 3e3d5815 balrog
    return *(s->ioaddr ++);
452 3e3d5815 balrog
}
453 3e3d5815 balrog
454 bc24a225 Paul Brook
NANDFlashState *nand_init(int manf_id, int chip_id)
455 3e3d5815 balrog
{
456 3e3d5815 balrog
    int pagesize;
457 bc24a225 Paul Brook
    NANDFlashState *s;
458 751c6a17 Gerd Hoffmann
    DriveInfo *dinfo;
459 3e3d5815 balrog
460 3e3d5815 balrog
    if (nand_flash_ids[chip_id].size == 0) {
461 2ac71179 Paul Brook
        hw_error("%s: Unsupported NAND chip ID.\n", __FUNCTION__);
462 3e3d5815 balrog
    }
463 3e3d5815 balrog
464 bc24a225 Paul Brook
    s = (NANDFlashState *) qemu_mallocz(sizeof(NANDFlashState));
465 751c6a17 Gerd Hoffmann
    dinfo = drive_get(IF_MTD, 0, 0);
466 751c6a17 Gerd Hoffmann
    if (dinfo)
467 751c6a17 Gerd Hoffmann
        s->bdrv = dinfo->bdrv;
468 3e3d5815 balrog
    s->manf_id = manf_id;
469 3e3d5815 balrog
    s->chip_id = chip_id;
470 3e3d5815 balrog
    s->size = nand_flash_ids[s->chip_id].size << 20;
471 3e3d5815 balrog
    if (nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP) {
472 3e3d5815 balrog
        s->page_shift = 11;
473 3e3d5815 balrog
        s->erase_shift = 6;
474 3e3d5815 balrog
    } else {
475 3e3d5815 balrog
        s->page_shift = nand_flash_ids[s->chip_id].page_shift;
476 3e3d5815 balrog
        s->erase_shift = nand_flash_ids[s->chip_id].erase_shift;
477 3e3d5815 balrog
    }
478 3e3d5815 balrog
479 3e3d5815 balrog
    switch (1 << s->page_shift) {
480 3e3d5815 balrog
    case 256:
481 3e3d5815 balrog
        nand_init_256(s);
482 3e3d5815 balrog
        break;
483 3e3d5815 balrog
    case 512:
484 3e3d5815 balrog
        nand_init_512(s);
485 3e3d5815 balrog
        break;
486 3e3d5815 balrog
    case 2048:
487 3e3d5815 balrog
        nand_init_2048(s);
488 3e3d5815 balrog
        break;
489 3e3d5815 balrog
    default:
490 2ac71179 Paul Brook
        hw_error("%s: Unsupported NAND block size.\n", __FUNCTION__);
491 3e3d5815 balrog
    }
492 3e3d5815 balrog
493 3e3d5815 balrog
    pagesize = 1 << s->oob_shift;
494 3e3d5815 balrog
    s->mem_oob = 1;
495 3e3d5815 balrog
    if (s->bdrv && bdrv_getlength(s->bdrv) >=
496 3e3d5815 balrog
                    (s->pages << s->page_shift) + (s->pages << s->oob_shift)) {
497 3e3d5815 balrog
        pagesize = 0;
498 3e3d5815 balrog
        s->mem_oob = 0;
499 3e3d5815 balrog
    }
500 3e3d5815 balrog
501 3e3d5815 balrog
    if (!s->bdrv)
502 3e3d5815 balrog
        pagesize += 1 << s->page_shift;
503 3e3d5815 balrog
    if (pagesize)
504 3e3d5815 balrog
        s->storage = (uint8_t *) memset(qemu_malloc(s->pages * pagesize),
505 3e3d5815 balrog
                        0xff, s->pages * pagesize);
506 48927926 pbrook
    /* Give s->ioaddr a sane value in case we save state before it
507 48927926 pbrook
       is used.  */
508 48927926 pbrook
    s->ioaddr = s->io;
509 aa941b94 balrog
510 7b9a3d86 Juan Quintela
    vmstate_register(NULL, -1, &vmstate_nand, s);
511 aa941b94 balrog
512 3e3d5815 balrog
    return s;
513 3e3d5815 balrog
}
514 3e3d5815 balrog
515 bc24a225 Paul Brook
void nand_done(NANDFlashState *s)
516 3e3d5815 balrog
{
517 3e3d5815 balrog
    if (s->bdrv) {
518 3e3d5815 balrog
        bdrv_close(s->bdrv);
519 3e3d5815 balrog
        bdrv_delete(s->bdrv);
520 3e3d5815 balrog
    }
521 3e3d5815 balrog
522 3e3d5815 balrog
    if (!s->bdrv || s->mem_oob)
523 5f6eab3f Jean-Christophe DUBOIS
        qemu_free(s->storage);
524 3e3d5815 balrog
525 5f6eab3f Jean-Christophe DUBOIS
    qemu_free(s);
526 3e3d5815 balrog
}
527 3e3d5815 balrog
528 3e3d5815 balrog
#else
529 3e3d5815 balrog
530 3e3d5815 balrog
/* Program a single page */
531 bc24a225 Paul Brook
static void glue(nand_blk_write_, PAGE_SIZE)(NANDFlashState *s)
532 3e3d5815 balrog
{
533 3e3d5815 balrog
    uint32_t off, page, sector, soff;
534 3e3d5815 balrog
    uint8_t iobuf[(PAGE_SECTORS + 2) * 0x200];
535 3e3d5815 balrog
    if (PAGE(s->addr) >= s->pages)
536 3e3d5815 balrog
        return;
537 3e3d5815 balrog
538 3e3d5815 balrog
    if (!s->bdrv) {
539 3e3d5815 balrog
        memcpy(s->storage + PAGE_START(s->addr) + (s->addr & PAGE_MASK) +
540 3e3d5815 balrog
                        s->offset, s->io, s->iolen);
541 3e3d5815 balrog
    } else if (s->mem_oob) {
542 3e3d5815 balrog
        sector = SECTOR(s->addr);
543 3e3d5815 balrog
        off = (s->addr & PAGE_MASK) + s->offset;
544 3e3d5815 balrog
        soff = SECTOR_OFFSET(s->addr);
545 3e3d5815 balrog
        if (bdrv_read(s->bdrv, sector, iobuf, PAGE_SECTORS) == -1) {
546 3e3d5815 balrog
            printf("%s: read error in sector %i\n", __FUNCTION__, sector);
547 3e3d5815 balrog
            return;
548 3e3d5815 balrog
        }
549 3e3d5815 balrog
550 3e3d5815 balrog
        memcpy(iobuf + (soff | off), s->io, MIN(s->iolen, PAGE_SIZE - off));
551 3e3d5815 balrog
        if (off + s->iolen > PAGE_SIZE) {
552 3e3d5815 balrog
            page = PAGE(s->addr);
553 3e3d5815 balrog
            memcpy(s->storage + (page << OOB_SHIFT), s->io + PAGE_SIZE - off,
554 3e3d5815 balrog
                            MIN(OOB_SIZE, off + s->iolen - PAGE_SIZE));
555 3e3d5815 balrog
        }
556 3e3d5815 balrog
557 3e3d5815 balrog
        if (bdrv_write(s->bdrv, sector, iobuf, PAGE_SECTORS) == -1)
558 3e3d5815 balrog
            printf("%s: write error in sector %i\n", __FUNCTION__, sector);
559 3e3d5815 balrog
    } else {
560 3e3d5815 balrog
        off = PAGE_START(s->addr) + (s->addr & PAGE_MASK) + s->offset;
561 3e3d5815 balrog
        sector = off >> 9;
562 3e3d5815 balrog
        soff = off & 0x1ff;
563 3e3d5815 balrog
        if (bdrv_read(s->bdrv, sector, iobuf, PAGE_SECTORS + 2) == -1) {
564 3e3d5815 balrog
            printf("%s: read error in sector %i\n", __FUNCTION__, sector);
565 3e3d5815 balrog
            return;
566 3e3d5815 balrog
        }
567 3e3d5815 balrog
568 3e3d5815 balrog
        memcpy(iobuf + soff, s->io, s->iolen);
569 3e3d5815 balrog
570 3e3d5815 balrog
        if (bdrv_write(s->bdrv, sector, iobuf, PAGE_SECTORS + 2) == -1)
571 3e3d5815 balrog
            printf("%s: write error in sector %i\n", __FUNCTION__, sector);
572 3e3d5815 balrog
    }
573 3e3d5815 balrog
    s->offset = 0;
574 3e3d5815 balrog
}
575 3e3d5815 balrog
576 3e3d5815 balrog
/* Erase a single block */
577 bc24a225 Paul Brook
static void glue(nand_blk_erase_, PAGE_SIZE)(NANDFlashState *s)
578 3e3d5815 balrog
{
579 3e3d5815 balrog
    uint32_t i, page, addr;
580 3e3d5815 balrog
    uint8_t iobuf[0x200] = { [0 ... 0x1ff] = 0xff, };
581 3e3d5815 balrog
    addr = s->addr & ~((1 << (ADDR_SHIFT + s->erase_shift)) - 1);
582 3e3d5815 balrog
583 3e3d5815 balrog
    if (PAGE(addr) >= s->pages)
584 3e3d5815 balrog
        return;
585 3e3d5815 balrog
586 3e3d5815 balrog
    if (!s->bdrv) {
587 3e3d5815 balrog
        memset(s->storage + PAGE_START(addr),
588 3e3d5815 balrog
                        0xff, (PAGE_SIZE + OOB_SIZE) << s->erase_shift);
589 3e3d5815 balrog
    } else if (s->mem_oob) {
590 3e3d5815 balrog
        memset(s->storage + (PAGE(addr) << OOB_SHIFT),
591 3e3d5815 balrog
                        0xff, OOB_SIZE << s->erase_shift);
592 3e3d5815 balrog
        i = SECTOR(addr);
593 3e3d5815 balrog
        page = SECTOR(addr + (ADDR_SHIFT + s->erase_shift));
594 3e3d5815 balrog
        for (; i < page; i ++)
595 3e3d5815 balrog
            if (bdrv_write(s->bdrv, i, iobuf, 1) == -1)
596 3e3d5815 balrog
                printf("%s: write error in sector %i\n", __FUNCTION__, i);
597 3e3d5815 balrog
    } else {
598 3e3d5815 balrog
        addr = PAGE_START(addr);
599 3e3d5815 balrog
        page = addr >> 9;
600 3e3d5815 balrog
        if (bdrv_read(s->bdrv, page, iobuf, 1) == -1)
601 3e3d5815 balrog
            printf("%s: read error in sector %i\n", __FUNCTION__, page);
602 3e3d5815 balrog
        memset(iobuf + (addr & 0x1ff), 0xff, (~addr & 0x1ff) + 1);
603 3e3d5815 balrog
        if (bdrv_write(s->bdrv, page, iobuf, 1) == -1)
604 3e3d5815 balrog
            printf("%s: write error in sector %i\n", __FUNCTION__, page);
605 3e3d5815 balrog
606 3e3d5815 balrog
        memset(iobuf, 0xff, 0x200);
607 3e3d5815 balrog
        i = (addr & ~0x1ff) + 0x200;
608 3e3d5815 balrog
        for (addr += ((PAGE_SIZE + OOB_SIZE) << s->erase_shift) - 0x200;
609 3e3d5815 balrog
                        i < addr; i += 0x200)
610 3e3d5815 balrog
            if (bdrv_write(s->bdrv, i >> 9, iobuf, 1) == -1)
611 3e3d5815 balrog
                printf("%s: write error in sector %i\n", __FUNCTION__, i >> 9);
612 3e3d5815 balrog
613 3e3d5815 balrog
        page = i >> 9;
614 3e3d5815 balrog
        if (bdrv_read(s->bdrv, page, iobuf, 1) == -1)
615 3e3d5815 balrog
            printf("%s: read error in sector %i\n", __FUNCTION__, page);
616 a07dec22 balrog
        memset(iobuf, 0xff, ((addr - 1) & 0x1ff) + 1);
617 3e3d5815 balrog
        if (bdrv_write(s->bdrv, page, iobuf, 1) == -1)
618 3e3d5815 balrog
            printf("%s: write error in sector %i\n", __FUNCTION__, page);
619 3e3d5815 balrog
    }
620 3e3d5815 balrog
}
621 3e3d5815 balrog
622 bc24a225 Paul Brook
static void glue(nand_blk_load_, PAGE_SIZE)(NANDFlashState *s,
623 3e3d5815 balrog
                uint32_t addr, int offset)
624 3e3d5815 balrog
{
625 3e3d5815 balrog
    if (PAGE(addr) >= s->pages)
626 3e3d5815 balrog
        return;
627 3e3d5815 balrog
628 3e3d5815 balrog
    if (s->bdrv) {
629 3e3d5815 balrog
        if (s->mem_oob) {
630 3e3d5815 balrog
            if (bdrv_read(s->bdrv, SECTOR(addr), s->io, PAGE_SECTORS) == -1)
631 3e3d5815 balrog
                printf("%s: read error in sector %i\n",
632 3e3d5815 balrog
                                __FUNCTION__, SECTOR(addr));
633 3e3d5815 balrog
            memcpy(s->io + SECTOR_OFFSET(s->addr) + PAGE_SIZE,
634 3e3d5815 balrog
                            s->storage + (PAGE(s->addr) << OOB_SHIFT),
635 3e3d5815 balrog
                            OOB_SIZE);
636 3e3d5815 balrog
            s->ioaddr = s->io + SECTOR_OFFSET(s->addr) + offset;
637 3e3d5815 balrog
        } else {
638 3e3d5815 balrog
            if (bdrv_read(s->bdrv, PAGE_START(addr) >> 9,
639 3e3d5815 balrog
                                    s->io, (PAGE_SECTORS + 2)) == -1)
640 3e3d5815 balrog
                printf("%s: read error in sector %i\n",
641 3e3d5815 balrog
                                __FUNCTION__, PAGE_START(addr) >> 9);
642 3e3d5815 balrog
            s->ioaddr = s->io + (PAGE_START(addr) & 0x1ff) + offset;
643 3e3d5815 balrog
        }
644 3e3d5815 balrog
    } else {
645 3e3d5815 balrog
        memcpy(s->io, s->storage + PAGE_START(s->addr) +
646 3e3d5815 balrog
                        offset, PAGE_SIZE + OOB_SIZE - offset);
647 3e3d5815 balrog
        s->ioaddr = s->io;
648 3e3d5815 balrog
    }
649 3e3d5815 balrog
}
650 3e3d5815 balrog
651 bc24a225 Paul Brook
static void glue(nand_init_, PAGE_SIZE)(NANDFlashState *s)
652 3e3d5815 balrog
{
653 3e3d5815 balrog
    s->oob_shift = PAGE_SHIFT - 5;
654 3e3d5815 balrog
    s->pages = s->size >> PAGE_SHIFT;
655 3e3d5815 balrog
    s->addr_shift = ADDR_SHIFT;
656 3e3d5815 balrog
657 3e3d5815 balrog
    s->blk_erase = glue(nand_blk_erase_, PAGE_SIZE);
658 3e3d5815 balrog
    s->blk_write = glue(nand_blk_write_, PAGE_SIZE);
659 3e3d5815 balrog
    s->blk_load = glue(nand_blk_load_, PAGE_SIZE);
660 3e3d5815 balrog
}
661 3e3d5815 balrog
662 3e3d5815 balrog
# undef PAGE_SIZE
663 3e3d5815 balrog
# undef PAGE_SHIFT
664 3e3d5815 balrog
# undef PAGE_SECTORS
665 3e3d5815 balrog
# undef ADDR_SHIFT
666 3e3d5815 balrog
#endif        /* NAND_IO */