blob: 35804c7e8794b6c4407543e53d858140b0f6e066 [file] [log] [blame]
balrog3e3d5812007-04-30 02:09:25 +00001/*
2 * Flash NAND memory emulation. Based on "16M x 8 Bit NAND Flash
3 * Memory" datasheet for the KM29U128AT / K9F2808U0A chips from
4 * Samsung Electronic.
5 *
6 * Copyright (c) 2006 Openedhand Ltd.
7 * Written by Andrzej Zaborowski <balrog@zabor.org>
8 *
Juha Riihimäkid5f2fd52011-07-29 16:35:20 +01009 * Support for additional features based on "MT29F2G16ABCWP 2Gx16"
10 * datasheet from Micron Technology and "NAND02G-B2C" datasheet
11 * from ST Microelectronics.
12 *
balrog3e3d5812007-04-30 02:09:25 +000013 * This code is licensed under the GNU GPL v2.
14 */
15
16#ifndef NAND_IO
17
pbrook87ecb682007-11-17 17:14:51 +000018# include "hw.h"
19# include "flash.h"
Markus Armbruster666daa62010-06-02 18:48:27 +020020# include "blockdev.h"
balrog3e3d5812007-04-30 02:09:25 +000021
22# define NAND_CMD_READ0 0x00
23# define NAND_CMD_READ1 0x01
24# define NAND_CMD_READ2 0x50
25# define NAND_CMD_LPREAD2 0x30
26# define NAND_CMD_NOSERIALREAD2 0x35
27# define NAND_CMD_RANDOMREAD1 0x05
28# define NAND_CMD_RANDOMREAD2 0xe0
29# define NAND_CMD_READID 0x90
30# define NAND_CMD_RESET 0xff
31# define NAND_CMD_PAGEPROGRAM1 0x80
32# define NAND_CMD_PAGEPROGRAM2 0x10
33# define NAND_CMD_CACHEPROGRAM2 0x15
34# define NAND_CMD_BLOCKERASE1 0x60
35# define NAND_CMD_BLOCKERASE2 0xd0
36# define NAND_CMD_READSTATUS 0x70
37# define NAND_CMD_COPYBACKPRG1 0x85
38
39# define NAND_IOSTATUS_ERROR (1 << 0)
40# define NAND_IOSTATUS_PLANE0 (1 << 1)
41# define NAND_IOSTATUS_PLANE1 (1 << 2)
42# define NAND_IOSTATUS_PLANE2 (1 << 3)
43# define NAND_IOSTATUS_PLANE3 (1 << 4)
44# define NAND_IOSTATUS_BUSY (1 << 6)
45# define NAND_IOSTATUS_UNPROTCT (1 << 7)
46
47# define MAX_PAGE 0x800
48# define MAX_OOB 0x40
49
Paul Brookbc24a222009-05-10 01:44:56 +010050struct NANDFlashState {
balrog3e3d5812007-04-30 02:09:25 +000051 uint8_t manf_id, chip_id;
Juha Riihimäki48197df2011-07-29 16:35:21 +010052 uint8_t buswidth; /* in BYTES */
balrog3e3d5812007-04-30 02:09:25 +000053 int size, pages;
54 int page_shift, oob_shift, erase_shift, addr_shift;
55 uint8_t *storage;
56 BlockDriverState *bdrv;
57 int mem_oob;
58
Juan Quintela51db57f2010-12-03 01:39:22 +010059 uint8_t cle, ale, ce, wp, gnd;
balrog3e3d5812007-04-30 02:09:25 +000060
61 uint8_t io[MAX_PAGE + MAX_OOB + 0x400];
62 uint8_t *ioaddr;
63 int iolen;
64
Juha Riihimäkid5f2fd52011-07-29 16:35:20 +010065 uint32_t cmd;
66 uint64_t addr;
balrog3e3d5812007-04-30 02:09:25 +000067 int addrlen;
68 int status;
69 int offset;
70
Paul Brookbc24a222009-05-10 01:44:56 +010071 void (*blk_write)(NANDFlashState *s);
72 void (*blk_erase)(NANDFlashState *s);
Juha Riihimäkid5f2fd52011-07-29 16:35:20 +010073 void (*blk_load)(NANDFlashState *s, uint64_t addr, int offset);
Juan Quintela7b9a3d82010-12-03 01:50:10 +010074
75 uint32_t ioaddr_vmstate;
balrog3e3d5812007-04-30 02:09:25 +000076};
77
Peter Maydell89f640b2011-07-29 16:35:23 +010078static void mem_and(uint8_t *dest, const uint8_t *src, size_t n)
79{
80 /* Like memcpy() but we logical-AND the data into the destination */
81 int i;
82 for (i = 0; i < n; i++) {
83 dest[i] &= src[i];
84 }
85}
86
balrog3e3d5812007-04-30 02:09:25 +000087# define NAND_NO_AUTOINCR 0x00000001
88# define NAND_BUSWIDTH_16 0x00000002
89# define NAND_NO_PADDING 0x00000004
90# define NAND_CACHEPRG 0x00000008
91# define NAND_COPYBACK 0x00000010
92# define NAND_IS_AND 0x00000020
93# define NAND_4PAGE_ARRAY 0x00000040
94# define NAND_NO_READRDY 0x00000100
95# define NAND_SAMSUNG_LP (NAND_NO_PADDING | NAND_COPYBACK)
96
97# define NAND_IO
98
99# define PAGE(addr) ((addr) >> ADDR_SHIFT)
100# define PAGE_START(page) (PAGE(page) * (PAGE_SIZE + OOB_SIZE))
101# define PAGE_MASK ((1 << ADDR_SHIFT) - 1)
102# define OOB_SHIFT (PAGE_SHIFT - 5)
103# define OOB_SIZE (1 << OOB_SHIFT)
104# define SECTOR(addr) ((addr) >> (9 + ADDR_SHIFT - PAGE_SHIFT))
105# define SECTOR_OFFSET(addr) ((addr) & ((511 >> PAGE_SHIFT) << 8))
106
107# define PAGE_SIZE 256
108# define PAGE_SHIFT 8
109# define PAGE_SECTORS 1
110# define ADDR_SHIFT 8
111# include "nand.c"
112# define PAGE_SIZE 512
113# define PAGE_SHIFT 9
114# define PAGE_SECTORS 1
115# define ADDR_SHIFT 8
116# include "nand.c"
117# define PAGE_SIZE 2048
118# define PAGE_SHIFT 11
119# define PAGE_SECTORS 4
120# define ADDR_SHIFT 16
121# include "nand.c"
122
123/* Information based on Linux drivers/mtd/nand/nand_ids.c */
Paul Brookbc24a222009-05-10 01:44:56 +0100124static const struct {
balrog3e3d5812007-04-30 02:09:25 +0000125 int size;
126 int width;
127 int page_shift;
128 int erase_shift;
129 uint32_t options;
130} nand_flash_ids[0x100] = {
131 [0 ... 0xff] = { 0 },
132
133 [0x6e] = { 1, 8, 8, 4, 0 },
134 [0x64] = { 2, 8, 8, 4, 0 },
135 [0x6b] = { 4, 8, 9, 4, 0 },
136 [0xe8] = { 1, 8, 8, 4, 0 },
137 [0xec] = { 1, 8, 8, 4, 0 },
138 [0xea] = { 2, 8, 8, 4, 0 },
139 [0xd5] = { 4, 8, 9, 4, 0 },
140 [0xe3] = { 4, 8, 9, 4, 0 },
141 [0xe5] = { 4, 8, 9, 4, 0 },
142 [0xd6] = { 8, 8, 9, 4, 0 },
143
144 [0x39] = { 8, 8, 9, 4, 0 },
145 [0xe6] = { 8, 8, 9, 4, 0 },
146 [0x49] = { 8, 16, 9, 4, NAND_BUSWIDTH_16 },
147 [0x59] = { 8, 16, 9, 4, NAND_BUSWIDTH_16 },
148
149 [0x33] = { 16, 8, 9, 5, 0 },
150 [0x73] = { 16, 8, 9, 5, 0 },
151 [0x43] = { 16, 16, 9, 5, NAND_BUSWIDTH_16 },
152 [0x53] = { 16, 16, 9, 5, NAND_BUSWIDTH_16 },
153
154 [0x35] = { 32, 8, 9, 5, 0 },
155 [0x75] = { 32, 8, 9, 5, 0 },
156 [0x45] = { 32, 16, 9, 5, NAND_BUSWIDTH_16 },
157 [0x55] = { 32, 16, 9, 5, NAND_BUSWIDTH_16 },
158
159 [0x36] = { 64, 8, 9, 5, 0 },
160 [0x76] = { 64, 8, 9, 5, 0 },
161 [0x46] = { 64, 16, 9, 5, NAND_BUSWIDTH_16 },
162 [0x56] = { 64, 16, 9, 5, NAND_BUSWIDTH_16 },
163
164 [0x78] = { 128, 8, 9, 5, 0 },
165 [0x39] = { 128, 8, 9, 5, 0 },
166 [0x79] = { 128, 8, 9, 5, 0 },
167 [0x72] = { 128, 16, 9, 5, NAND_BUSWIDTH_16 },
168 [0x49] = { 128, 16, 9, 5, NAND_BUSWIDTH_16 },
169 [0x74] = { 128, 16, 9, 5, NAND_BUSWIDTH_16 },
170 [0x59] = { 128, 16, 9, 5, NAND_BUSWIDTH_16 },
171
172 [0x71] = { 256, 8, 9, 5, 0 },
173
174 /*
175 * These are the new chips with large page size. The pagesize and the
176 * erasesize is determined from the extended id bytes
177 */
178# define LP_OPTIONS (NAND_SAMSUNG_LP | NAND_NO_READRDY | NAND_NO_AUTOINCR)
179# define LP_OPTIONS16 (LP_OPTIONS | NAND_BUSWIDTH_16)
180
181 /* 512 Megabit */
182 [0xa2] = { 64, 8, 0, 0, LP_OPTIONS },
183 [0xf2] = { 64, 8, 0, 0, LP_OPTIONS },
184 [0xb2] = { 64, 16, 0, 0, LP_OPTIONS16 },
185 [0xc2] = { 64, 16, 0, 0, LP_OPTIONS16 },
186
187 /* 1 Gigabit */
188 [0xa1] = { 128, 8, 0, 0, LP_OPTIONS },
189 [0xf1] = { 128, 8, 0, 0, LP_OPTIONS },
190 [0xb1] = { 128, 16, 0, 0, LP_OPTIONS16 },
191 [0xc1] = { 128, 16, 0, 0, LP_OPTIONS16 },
192
193 /* 2 Gigabit */
194 [0xaa] = { 256, 8, 0, 0, LP_OPTIONS },
195 [0xda] = { 256, 8, 0, 0, LP_OPTIONS },
196 [0xba] = { 256, 16, 0, 0, LP_OPTIONS16 },
197 [0xca] = { 256, 16, 0, 0, LP_OPTIONS16 },
198
199 /* 4 Gigabit */
200 [0xac] = { 512, 8, 0, 0, LP_OPTIONS },
201 [0xdc] = { 512, 8, 0, 0, LP_OPTIONS },
202 [0xbc] = { 512, 16, 0, 0, LP_OPTIONS16 },
203 [0xcc] = { 512, 16, 0, 0, LP_OPTIONS16 },
204
205 /* 8 Gigabit */
206 [0xa3] = { 1024, 8, 0, 0, LP_OPTIONS },
207 [0xd3] = { 1024, 8, 0, 0, LP_OPTIONS },
208 [0xb3] = { 1024, 16, 0, 0, LP_OPTIONS16 },
209 [0xc3] = { 1024, 16, 0, 0, LP_OPTIONS16 },
210
211 /* 16 Gigabit */
212 [0xa5] = { 2048, 8, 0, 0, LP_OPTIONS },
213 [0xd5] = { 2048, 8, 0, 0, LP_OPTIONS },
214 [0xb5] = { 2048, 16, 0, 0, LP_OPTIONS16 },
215 [0xc5] = { 2048, 16, 0, 0, LP_OPTIONS16 },
216};
217
Paul Brookbc24a222009-05-10 01:44:56 +0100218static void nand_reset(NANDFlashState *s)
balrog3e3d5812007-04-30 02:09:25 +0000219{
220 s->cmd = NAND_CMD_READ0;
221 s->addr = 0;
222 s->addrlen = 0;
223 s->iolen = 0;
224 s->offset = 0;
225 s->status &= NAND_IOSTATUS_UNPROTCT;
226}
227
Juha Riihimäki48197df2011-07-29 16:35:21 +0100228static inline void nand_pushio_byte(NANDFlashState *s, uint8_t value)
229{
230 s->ioaddr[s->iolen++] = value;
231 for (value = s->buswidth; --value;) {
232 s->ioaddr[s->iolen++] = 0;
233 }
234}
235
Paul Brookbc24a222009-05-10 01:44:56 +0100236static void nand_command(NANDFlashState *s)
balrog3e3d5812007-04-30 02:09:25 +0000237{
Edgar E. Iglesiasfccd2612010-01-12 14:48:19 +0100238 unsigned int offset;
balrog3e3d5812007-04-30 02:09:25 +0000239 switch (s->cmd) {
240 case NAND_CMD_READ0:
241 s->iolen = 0;
242 break;
243
244 case NAND_CMD_READID:
balrog3e3d5812007-04-30 02:09:25 +0000245 s->ioaddr = s->io;
Juha Riihimäki48197df2011-07-29 16:35:21 +0100246 s->iolen = 0;
247 nand_pushio_byte(s, s->manf_id);
248 nand_pushio_byte(s, s->chip_id);
249 nand_pushio_byte(s, 'Q'); /* Don't-care byte (often 0xa5) */
250 if (nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP) {
251 /* Page Size, Block Size, Spare Size; bit 6 indicates
252 * 8 vs 16 bit width NAND.
253 */
254 nand_pushio_byte(s, (s->buswidth == 2) ? 0x55 : 0x15);
255 } else {
256 nand_pushio_byte(s, 0xc0); /* Multi-plane */
257 }
balrog3e3d5812007-04-30 02:09:25 +0000258 break;
259
260 case NAND_CMD_RANDOMREAD2:
261 case NAND_CMD_NOSERIALREAD2:
262 if (!(nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP))
263 break;
Edgar E. Iglesiasfccd2612010-01-12 14:48:19 +0100264 offset = s->addr & ((1 << s->addr_shift) - 1);
265 s->blk_load(s, s->addr, offset);
266 if (s->gnd)
267 s->iolen = (1 << s->page_shift) - offset;
268 else
269 s->iolen = (1 << s->page_shift) + (1 << s->oob_shift) - offset;
balrog3e3d5812007-04-30 02:09:25 +0000270 break;
271
272 case NAND_CMD_RESET:
273 nand_reset(s);
274 break;
275
276 case NAND_CMD_PAGEPROGRAM1:
277 s->ioaddr = s->io;
278 s->iolen = 0;
279 break;
280
281 case NAND_CMD_PAGEPROGRAM2:
282 if (s->wp) {
283 s->blk_write(s);
284 }
285 break;
286
287 case NAND_CMD_BLOCKERASE1:
288 break;
289
290 case NAND_CMD_BLOCKERASE2:
291 if (nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP)
292 s->addr <<= 16;
293 else
294 s->addr <<= 8;
295
296 if (s->wp) {
297 s->blk_erase(s);
298 }
299 break;
300
301 case NAND_CMD_READSTATUS:
balrog3e3d5812007-04-30 02:09:25 +0000302 s->ioaddr = s->io;
Juha Riihimäki48197df2011-07-29 16:35:21 +0100303 s->iolen = 0;
304 nand_pushio_byte(s, s->status);
balrog3e3d5812007-04-30 02:09:25 +0000305 break;
306
307 default:
308 printf("%s: Unknown NAND command 0x%02x\n", __FUNCTION__, s->cmd);
309 }
310}
311
Juan Quintela7b9a3d82010-12-03 01:50:10 +0100312static void nand_pre_save(void *opaque)
balrogaa941b92007-05-24 18:50:09 +0000313{
Juan Quintela7b9a3d82010-12-03 01:50:10 +0100314 NANDFlashState *s = opaque;
balrogaa941b92007-05-24 18:50:09 +0000315
Juan Quintela7b9a3d82010-12-03 01:50:10 +0100316 s->ioaddr_vmstate = s->ioaddr - s->io;
balrogaa941b92007-05-24 18:50:09 +0000317}
318
Juan Quintela7b9a3d82010-12-03 01:50:10 +0100319static int nand_post_load(void *opaque, int version_id)
balrogaa941b92007-05-24 18:50:09 +0000320{
Juan Quintela7b9a3d82010-12-03 01:50:10 +0100321 NANDFlashState *s = opaque;
balrogaa941b92007-05-24 18:50:09 +0000322
Juan Quintela7b9a3d82010-12-03 01:50:10 +0100323 if (s->ioaddr_vmstate > sizeof(s->io)) {
324 return -EINVAL;
325 }
326 s->ioaddr = s->io + s->ioaddr_vmstate;
327
balrogaa941b92007-05-24 18:50:09 +0000328 return 0;
329}
330
Juan Quintela7b9a3d82010-12-03 01:50:10 +0100331static const VMStateDescription vmstate_nand = {
332 .name = "nand",
Andrzej Zaborowskiac2466c2011-07-30 06:01:37 +0200333 .version_id = 1,
334 .minimum_version_id = 1,
335 .minimum_version_id_old = 1,
Juan Quintela7b9a3d82010-12-03 01:50:10 +0100336 .pre_save = nand_pre_save,
337 .post_load = nand_post_load,
338 .fields = (VMStateField[]) {
339 VMSTATE_UINT8(cle, NANDFlashState),
340 VMSTATE_UINT8(ale, NANDFlashState),
341 VMSTATE_UINT8(ce, NANDFlashState),
342 VMSTATE_UINT8(wp, NANDFlashState),
343 VMSTATE_UINT8(gnd, NANDFlashState),
344 VMSTATE_BUFFER(io, NANDFlashState),
345 VMSTATE_UINT32(ioaddr_vmstate, NANDFlashState),
346 VMSTATE_INT32(iolen, NANDFlashState),
347 VMSTATE_UINT32(cmd, NANDFlashState),
Juha Riihimäkid5f2fd52011-07-29 16:35:20 +0100348 VMSTATE_UINT64(addr, NANDFlashState),
Juan Quintela7b9a3d82010-12-03 01:50:10 +0100349 VMSTATE_INT32(addrlen, NANDFlashState),
350 VMSTATE_INT32(status, NANDFlashState),
351 VMSTATE_INT32(offset, NANDFlashState),
352 /* XXX: do we want to save s->storage too? */
353 VMSTATE_END_OF_LIST()
354 }
355};
356
balrog3e3d5812007-04-30 02:09:25 +0000357/*
358 * Chip inputs are CLE, ALE, CE, WP, GND and eight I/O pins. Chip
359 * outputs are R/B and eight I/O pins.
360 *
361 * CE, WP and R/B are active low.
362 */
Juan Quintela51db57f2010-12-03 01:39:22 +0100363void nand_setpins(NANDFlashState *s, uint8_t cle, uint8_t ale,
364 uint8_t ce, uint8_t wp, uint8_t gnd)
balrog3e3d5812007-04-30 02:09:25 +0000365{
366 s->cle = cle;
367 s->ale = ale;
368 s->ce = ce;
369 s->wp = wp;
370 s->gnd = gnd;
371 if (wp)
372 s->status |= NAND_IOSTATUS_UNPROTCT;
373 else
374 s->status &= ~NAND_IOSTATUS_UNPROTCT;
375}
376
Paul Brookbc24a222009-05-10 01:44:56 +0100377void nand_getpins(NANDFlashState *s, int *rb)
balrog3e3d5812007-04-30 02:09:25 +0000378{
379 *rb = 1;
380}
381
Juha Riihimäki48197df2011-07-29 16:35:21 +0100382void nand_setio(NANDFlashState *s, uint32_t value)
balrog3e3d5812007-04-30 02:09:25 +0000383{
Juha Riihimäki48197df2011-07-29 16:35:21 +0100384 int i;
385
balrog3e3d5812007-04-30 02:09:25 +0000386 if (!s->ce && s->cle) {
387 if (nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP) {
388 if (s->cmd == NAND_CMD_READ0 && value == NAND_CMD_LPREAD2)
389 return;
390 if (value == NAND_CMD_RANDOMREAD1) {
391 s->addr &= ~((1 << s->addr_shift) - 1);
392 s->addrlen = 0;
393 return;
394 }
395 }
396 if (value == NAND_CMD_READ0)
397 s->offset = 0;
398 else if (value == NAND_CMD_READ1) {
399 s->offset = 0x100;
400 value = NAND_CMD_READ0;
401 }
402 else if (value == NAND_CMD_READ2) {
403 s->offset = 1 << s->page_shift;
404 value = NAND_CMD_READ0;
405 }
406
407 s->cmd = value;
408
409 if (s->cmd == NAND_CMD_READSTATUS ||
410 s->cmd == NAND_CMD_PAGEPROGRAM2 ||
411 s->cmd == NAND_CMD_BLOCKERASE1 ||
412 s->cmd == NAND_CMD_BLOCKERASE2 ||
413 s->cmd == NAND_CMD_NOSERIALREAD2 ||
414 s->cmd == NAND_CMD_RANDOMREAD2 ||
415 s->cmd == NAND_CMD_RESET)
416 nand_command(s);
417
418 if (s->cmd != NAND_CMD_RANDOMREAD2) {
419 s->addrlen = 0;
balrog3e3d5812007-04-30 02:09:25 +0000420 }
421 }
422
423 if (s->ale) {
Edgar E. Iglesiasfccd2612010-01-12 14:48:19 +0100424 unsigned int shift = s->addrlen * 8;
425 unsigned int mask = ~(0xff << shift);
426 unsigned int v = value << shift;
427
428 s->addr = (s->addr & mask) | v;
balrog3e3d5812007-04-30 02:09:25 +0000429 s->addrlen ++;
430
Juha Riihimäki48197df2011-07-29 16:35:21 +0100431 switch (s->addrlen) {
432 case 1:
433 if (s->cmd == NAND_CMD_READID) {
434 nand_command(s);
435 }
436 break;
437 case 2: /* fix cache address as a byte address */
438 s->addr <<= (s->buswidth - 1);
439 break;
440 case 3:
441 if (!(nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP) &&
442 (s->cmd == NAND_CMD_READ0 ||
443 s->cmd == NAND_CMD_PAGEPROGRAM1)) {
444 nand_command(s);
445 }
446 break;
447 case 4:
448 if ((nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP) &&
449 nand_flash_ids[s->chip_id].size < 256 && /* 1Gb or less */
450 (s->cmd == NAND_CMD_READ0 ||
451 s->cmd == NAND_CMD_PAGEPROGRAM1)) {
452 nand_command(s);
453 }
454 break;
455 case 5:
456 if ((nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP) &&
457 nand_flash_ids[s->chip_id].size >= 256 && /* 2Gb or more */
458 (s->cmd == NAND_CMD_READ0 ||
459 s->cmd == NAND_CMD_PAGEPROGRAM1)) {
460 nand_command(s);
461 }
462 break;
463 default:
464 break;
465 }
balrog3e3d5812007-04-30 02:09:25 +0000466 }
467
468 if (!s->cle && !s->ale && s->cmd == NAND_CMD_PAGEPROGRAM1) {
Juha Riihimäki48197df2011-07-29 16:35:21 +0100469 if (s->iolen < (1 << s->page_shift) + (1 << s->oob_shift)) {
470 for (i = s->buswidth; i--; value >>= 8) {
471 s->io[s->iolen ++] = (uint8_t) (value & 0xff);
472 }
473 }
balrog3e3d5812007-04-30 02:09:25 +0000474 } else if (!s->cle && !s->ale && s->cmd == NAND_CMD_COPYBACKPRG1) {
475 if ((s->addr & ((1 << s->addr_shift) - 1)) <
476 (1 << s->page_shift) + (1 << s->oob_shift)) {
Juha Riihimäki48197df2011-07-29 16:35:21 +0100477 for (i = s->buswidth; i--; s->addr++, value >>= 8) {
478 s->io[s->iolen + (s->addr & ((1 << s->addr_shift) - 1))] =
479 (uint8_t) (value & 0xff);
480 }
balrog3e3d5812007-04-30 02:09:25 +0000481 }
482 }
483}
484
Juha Riihimäki48197df2011-07-29 16:35:21 +0100485uint32_t nand_getio(NANDFlashState *s)
balrog3e3d5812007-04-30 02:09:25 +0000486{
487 int offset;
Juha Riihimäki48197df2011-07-29 16:35:21 +0100488 uint32_t x = 0;
ths5fafdf22007-09-16 21:08:06 +0000489
balrog3e3d5812007-04-30 02:09:25 +0000490 /* Allow sequential reading */
491 if (!s->iolen && s->cmd == NAND_CMD_READ0) {
Juha Riihimäkid5f2fd52011-07-29 16:35:20 +0100492 offset = (int) (s->addr & ((1 << s->addr_shift) - 1)) + s->offset;
balrog3e3d5812007-04-30 02:09:25 +0000493 s->offset = 0;
494
495 s->blk_load(s, s->addr, offset);
496 if (s->gnd)
497 s->iolen = (1 << s->page_shift) - offset;
498 else
499 s->iolen = (1 << s->page_shift) + (1 << s->oob_shift) - offset;
500 }
501
502 if (s->ce || s->iolen <= 0)
503 return 0;
504
Juha Riihimäki48197df2011-07-29 16:35:21 +0100505 for (offset = s->buswidth; offset--;) {
506 x |= s->ioaddr[offset] << (offset << 3);
507 }
Juha Riihimäkid72245f2011-07-29 16:35:22 +0100508 /* after receiving READ STATUS command all subsequent reads will
509 * return the status register value until another command is issued
510 */
511 if (s->cmd != NAND_CMD_READSTATUS) {
512 s->addr += s->buswidth;
513 s->ioaddr += s->buswidth;
514 s->iolen -= s->buswidth;
515 }
Juha Riihimäki48197df2011-07-29 16:35:21 +0100516 return x;
517}
518
519uint32_t nand_getbuswidth(NANDFlashState *s)
520{
521 return s->buswidth << 3;
balrog3e3d5812007-04-30 02:09:25 +0000522}
523
Peter Maydell522f2532011-07-29 16:35:19 +0100524NANDFlashState *nand_init(BlockDriverState *bdrv, int manf_id, int chip_id)
balrog3e3d5812007-04-30 02:09:25 +0000525{
526 int pagesize;
Paul Brookbc24a222009-05-10 01:44:56 +0100527 NANDFlashState *s;
balrog3e3d5812007-04-30 02:09:25 +0000528
529 if (nand_flash_ids[chip_id].size == 0) {
Paul Brook2ac71172009-05-08 02:35:15 +0100530 hw_error("%s: Unsupported NAND chip ID.\n", __FUNCTION__);
balrog3e3d5812007-04-30 02:09:25 +0000531 }
532
Paul Brookbc24a222009-05-10 01:44:56 +0100533 s = (NANDFlashState *) qemu_mallocz(sizeof(NANDFlashState));
Peter Maydell522f2532011-07-29 16:35:19 +0100534 s->bdrv = bdrv;
balrog3e3d5812007-04-30 02:09:25 +0000535 s->manf_id = manf_id;
536 s->chip_id = chip_id;
Juha Riihimäki48197df2011-07-29 16:35:21 +0100537 s->buswidth = nand_flash_ids[s->chip_id].width >> 3;
balrog3e3d5812007-04-30 02:09:25 +0000538 s->size = nand_flash_ids[s->chip_id].size << 20;
539 if (nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP) {
540 s->page_shift = 11;
541 s->erase_shift = 6;
542 } else {
543 s->page_shift = nand_flash_ids[s->chip_id].page_shift;
544 s->erase_shift = nand_flash_ids[s->chip_id].erase_shift;
545 }
546
547 switch (1 << s->page_shift) {
548 case 256:
549 nand_init_256(s);
550 break;
551 case 512:
552 nand_init_512(s);
553 break;
554 case 2048:
555 nand_init_2048(s);
556 break;
557 default:
Paul Brook2ac71172009-05-08 02:35:15 +0100558 hw_error("%s: Unsupported NAND block size.\n", __FUNCTION__);
balrog3e3d5812007-04-30 02:09:25 +0000559 }
560
561 pagesize = 1 << s->oob_shift;
562 s->mem_oob = 1;
563 if (s->bdrv && bdrv_getlength(s->bdrv) >=
564 (s->pages << s->page_shift) + (s->pages << s->oob_shift)) {
565 pagesize = 0;
566 s->mem_oob = 0;
567 }
568
569 if (!s->bdrv)
570 pagesize += 1 << s->page_shift;
571 if (pagesize)
572 s->storage = (uint8_t *) memset(qemu_malloc(s->pages * pagesize),
573 0xff, s->pages * pagesize);
pbrook48927922009-01-20 04:15:47 +0000574 /* Give s->ioaddr a sane value in case we save state before it
575 is used. */
576 s->ioaddr = s->io;
balrogaa941b92007-05-24 18:50:09 +0000577
Juan Quintela7b9a3d82010-12-03 01:50:10 +0100578 vmstate_register(NULL, -1, &vmstate_nand, s);
balrogaa941b92007-05-24 18:50:09 +0000579
balrog3e3d5812007-04-30 02:09:25 +0000580 return s;
581}
582
Paul Brookbc24a222009-05-10 01:44:56 +0100583void nand_done(NANDFlashState *s)
balrog3e3d5812007-04-30 02:09:25 +0000584{
585 if (s->bdrv) {
586 bdrv_close(s->bdrv);
587 bdrv_delete(s->bdrv);
588 }
589
590 if (!s->bdrv || s->mem_oob)
Jean-Christophe DUBOIS5f6eab32009-11-15 19:18:15 +0100591 qemu_free(s->storage);
balrog3e3d5812007-04-30 02:09:25 +0000592
Jean-Christophe DUBOIS5f6eab32009-11-15 19:18:15 +0100593 qemu_free(s);
balrog3e3d5812007-04-30 02:09:25 +0000594}
595
596#else
597
598/* Program a single page */
Paul Brookbc24a222009-05-10 01:44:56 +0100599static void glue(nand_blk_write_, PAGE_SIZE)(NANDFlashState *s)
balrog3e3d5812007-04-30 02:09:25 +0000600{
Juha Riihimäkid5f2fd52011-07-29 16:35:20 +0100601 uint64_t off, page, sector, soff;
balrog3e3d5812007-04-30 02:09:25 +0000602 uint8_t iobuf[(PAGE_SECTORS + 2) * 0x200];
603 if (PAGE(s->addr) >= s->pages)
604 return;
605
606 if (!s->bdrv) {
Peter Maydell89f640b2011-07-29 16:35:23 +0100607 mem_and(s->storage + PAGE_START(s->addr) + (s->addr & PAGE_MASK) +
balrog3e3d5812007-04-30 02:09:25 +0000608 s->offset, s->io, s->iolen);
609 } else if (s->mem_oob) {
610 sector = SECTOR(s->addr);
611 off = (s->addr & PAGE_MASK) + s->offset;
612 soff = SECTOR_OFFSET(s->addr);
613 if (bdrv_read(s->bdrv, sector, iobuf, PAGE_SECTORS) == -1) {
Juha Riihimäkid5f2fd52011-07-29 16:35:20 +0100614 printf("%s: read error in sector %" PRIu64 "\n", __func__, sector);
balrog3e3d5812007-04-30 02:09:25 +0000615 return;
616 }
617
Peter Maydell89f640b2011-07-29 16:35:23 +0100618 mem_and(iobuf + (soff | off), s->io, MIN(s->iolen, PAGE_SIZE - off));
balrog3e3d5812007-04-30 02:09:25 +0000619 if (off + s->iolen > PAGE_SIZE) {
620 page = PAGE(s->addr);
Peter Maydell89f640b2011-07-29 16:35:23 +0100621 mem_and(s->storage + (page << OOB_SHIFT), s->io + PAGE_SIZE - off,
balrog3e3d5812007-04-30 02:09:25 +0000622 MIN(OOB_SIZE, off + s->iolen - PAGE_SIZE));
623 }
624
625 if (bdrv_write(s->bdrv, sector, iobuf, PAGE_SECTORS) == -1)
Juha Riihimäkid5f2fd52011-07-29 16:35:20 +0100626 printf("%s: write error in sector %" PRIu64 "\n", __func__, sector);
balrog3e3d5812007-04-30 02:09:25 +0000627 } else {
628 off = PAGE_START(s->addr) + (s->addr & PAGE_MASK) + s->offset;
629 sector = off >> 9;
630 soff = off & 0x1ff;
631 if (bdrv_read(s->bdrv, sector, iobuf, PAGE_SECTORS + 2) == -1) {
Juha Riihimäkid5f2fd52011-07-29 16:35:20 +0100632 printf("%s: read error in sector %" PRIu64 "\n", __func__, sector);
balrog3e3d5812007-04-30 02:09:25 +0000633 return;
634 }
635
Peter Maydell89f640b2011-07-29 16:35:23 +0100636 mem_and(iobuf + soff, s->io, s->iolen);
balrog3e3d5812007-04-30 02:09:25 +0000637
638 if (bdrv_write(s->bdrv, sector, iobuf, PAGE_SECTORS + 2) == -1)
Juha Riihimäkid5f2fd52011-07-29 16:35:20 +0100639 printf("%s: write error in sector %" PRIu64 "\n", __func__, sector);
balrog3e3d5812007-04-30 02:09:25 +0000640 }
641 s->offset = 0;
642}
643
644/* Erase a single block */
Paul Brookbc24a222009-05-10 01:44:56 +0100645static void glue(nand_blk_erase_, PAGE_SIZE)(NANDFlashState *s)
balrog3e3d5812007-04-30 02:09:25 +0000646{
Juha Riihimäkid5f2fd52011-07-29 16:35:20 +0100647 uint64_t i, page, addr;
balrog3e3d5812007-04-30 02:09:25 +0000648 uint8_t iobuf[0x200] = { [0 ... 0x1ff] = 0xff, };
649 addr = s->addr & ~((1 << (ADDR_SHIFT + s->erase_shift)) - 1);
650
651 if (PAGE(addr) >= s->pages)
652 return;
653
654 if (!s->bdrv) {
655 memset(s->storage + PAGE_START(addr),
656 0xff, (PAGE_SIZE + OOB_SIZE) << s->erase_shift);
657 } else if (s->mem_oob) {
658 memset(s->storage + (PAGE(addr) << OOB_SHIFT),
659 0xff, OOB_SIZE << s->erase_shift);
660 i = SECTOR(addr);
661 page = SECTOR(addr + (ADDR_SHIFT + s->erase_shift));
662 for (; i < page; i ++)
663 if (bdrv_write(s->bdrv, i, iobuf, 1) == -1)
Juha Riihimäkid5f2fd52011-07-29 16:35:20 +0100664 printf("%s: write error in sector %" PRIu64 "\n", __func__, i);
balrog3e3d5812007-04-30 02:09:25 +0000665 } else {
666 addr = PAGE_START(addr);
667 page = addr >> 9;
668 if (bdrv_read(s->bdrv, page, iobuf, 1) == -1)
Juha Riihimäkid5f2fd52011-07-29 16:35:20 +0100669 printf("%s: read error in sector %" PRIu64 "\n", __func__, page);
balrog3e3d5812007-04-30 02:09:25 +0000670 memset(iobuf + (addr & 0x1ff), 0xff, (~addr & 0x1ff) + 1);
671 if (bdrv_write(s->bdrv, page, iobuf, 1) == -1)
Juha Riihimäkid5f2fd52011-07-29 16:35:20 +0100672 printf("%s: write error in sector %" PRIu64 "\n", __func__, page);
balrog3e3d5812007-04-30 02:09:25 +0000673
674 memset(iobuf, 0xff, 0x200);
675 i = (addr & ~0x1ff) + 0x200;
676 for (addr += ((PAGE_SIZE + OOB_SIZE) << s->erase_shift) - 0x200;
677 i < addr; i += 0x200)
678 if (bdrv_write(s->bdrv, i >> 9, iobuf, 1) == -1)
Juha Riihimäkid5f2fd52011-07-29 16:35:20 +0100679 printf("%s: write error in sector %" PRIu64 "\n",
680 __func__, i >> 9);
balrog3e3d5812007-04-30 02:09:25 +0000681
682 page = i >> 9;
683 if (bdrv_read(s->bdrv, page, iobuf, 1) == -1)
Juha Riihimäkid5f2fd52011-07-29 16:35:20 +0100684 printf("%s: read error in sector %" PRIu64 "\n", __func__, page);
balroga07dec22007-05-12 09:19:36 +0000685 memset(iobuf, 0xff, ((addr - 1) & 0x1ff) + 1);
balrog3e3d5812007-04-30 02:09:25 +0000686 if (bdrv_write(s->bdrv, page, iobuf, 1) == -1)
Juha Riihimäkid5f2fd52011-07-29 16:35:20 +0100687 printf("%s: write error in sector %" PRIu64 "\n", __func__, page);
balrog3e3d5812007-04-30 02:09:25 +0000688 }
689}
690
Paul Brookbc24a222009-05-10 01:44:56 +0100691static void glue(nand_blk_load_, PAGE_SIZE)(NANDFlashState *s,
Juha Riihimäkid5f2fd52011-07-29 16:35:20 +0100692 uint64_t addr, int offset)
balrog3e3d5812007-04-30 02:09:25 +0000693{
694 if (PAGE(addr) >= s->pages)
695 return;
696
697 if (s->bdrv) {
698 if (s->mem_oob) {
699 if (bdrv_read(s->bdrv, SECTOR(addr), s->io, PAGE_SECTORS) == -1)
Juha Riihimäkid5f2fd52011-07-29 16:35:20 +0100700 printf("%s: read error in sector %" PRIu64 "\n",
701 __func__, SECTOR(addr));
balrog3e3d5812007-04-30 02:09:25 +0000702 memcpy(s->io + SECTOR_OFFSET(s->addr) + PAGE_SIZE,
703 s->storage + (PAGE(s->addr) << OOB_SHIFT),
704 OOB_SIZE);
705 s->ioaddr = s->io + SECTOR_OFFSET(s->addr) + offset;
706 } else {
707 if (bdrv_read(s->bdrv, PAGE_START(addr) >> 9,
708 s->io, (PAGE_SECTORS + 2)) == -1)
Juha Riihimäkid5f2fd52011-07-29 16:35:20 +0100709 printf("%s: read error in sector %" PRIu64 "\n",
710 __func__, PAGE_START(addr) >> 9);
balrog3e3d5812007-04-30 02:09:25 +0000711 s->ioaddr = s->io + (PAGE_START(addr) & 0x1ff) + offset;
712 }
713 } else {
714 memcpy(s->io, s->storage + PAGE_START(s->addr) +
715 offset, PAGE_SIZE + OOB_SIZE - offset);
716 s->ioaddr = s->io;
717 }
balrog3e3d5812007-04-30 02:09:25 +0000718}
719
Paul Brookbc24a222009-05-10 01:44:56 +0100720static void glue(nand_init_, PAGE_SIZE)(NANDFlashState *s)
balrog3e3d5812007-04-30 02:09:25 +0000721{
722 s->oob_shift = PAGE_SHIFT - 5;
723 s->pages = s->size >> PAGE_SHIFT;
724 s->addr_shift = ADDR_SHIFT;
725
726 s->blk_erase = glue(nand_blk_erase_, PAGE_SIZE);
727 s->blk_write = glue(nand_blk_write_, PAGE_SIZE);
728 s->blk_load = glue(nand_blk_load_, PAGE_SIZE);
729}
730
731# undef PAGE_SIZE
732# undef PAGE_SHIFT
733# undef PAGE_SECTORS
734# undef ADDR_SHIFT
735#endif /* NAND_IO */