]> git.proxmox.com Git - mirror_qemu.git/blame - hw/block/nand.c
migration: Move the VMStateDescription typedef to typedefs.h
[mirror_qemu.git] / hw / block / nand.c
CommitLineData
3e3d5815
AZ
1/*
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 *
d5f2fd58
JR
9 * Support for additional features based on "MT29F2G16ABCWP 2Gx16"
10 * datasheet from Micron Technology and "NAND02G-B2C" datasheet
11 * from ST Microelectronics.
12 *
3e3d5815 13 * This code is licensed under the GNU GPL v2.
6b620ca3
PB
14 *
15 * Contributions after 2012-01-13 are licensed under the terms of the
16 * GNU GPL, version 2 or (at your option) any later version.
3e3d5815
AZ
17 */
18
19#ifndef NAND_IO
20
74c0e474
PM
21#include "qemu/osdep.h"
22#include "hw/hw.h"
23#include "hw/block/flash.h"
4be74634 24#include "sysemu/block-backend.h"
7426aa72 25#include "hw/qdev.h"
da34e65c 26#include "qapi/error.h"
1de7afc9 27#include "qemu/error-report.h"
0b8fa32f 28#include "qemu/module.h"
3e3d5815
AZ
29
30# define NAND_CMD_READ0 0x00
31# define NAND_CMD_READ1 0x01
32# define NAND_CMD_READ2 0x50
33# define NAND_CMD_LPREAD2 0x30
34# define NAND_CMD_NOSERIALREAD2 0x35
35# define NAND_CMD_RANDOMREAD1 0x05
36# define NAND_CMD_RANDOMREAD2 0xe0
37# define NAND_CMD_READID 0x90
38# define NAND_CMD_RESET 0xff
39# define NAND_CMD_PAGEPROGRAM1 0x80
40# define NAND_CMD_PAGEPROGRAM2 0x10
41# define NAND_CMD_CACHEPROGRAM2 0x15
42# define NAND_CMD_BLOCKERASE1 0x60
43# define NAND_CMD_BLOCKERASE2 0xd0
44# define NAND_CMD_READSTATUS 0x70
45# define NAND_CMD_COPYBACKPRG1 0x85
46
47# define NAND_IOSTATUS_ERROR (1 << 0)
48# define NAND_IOSTATUS_PLANE0 (1 << 1)
49# define NAND_IOSTATUS_PLANE1 (1 << 2)
50# define NAND_IOSTATUS_PLANE2 (1 << 3)
51# define NAND_IOSTATUS_PLANE3 (1 << 4)
0bc472a9 52# define NAND_IOSTATUS_READY (1 << 6)
3e3d5815
AZ
53# define NAND_IOSTATUS_UNPROTCT (1 << 7)
54
55# define MAX_PAGE 0x800
56# define MAX_OOB 0x40
57
d4220389 58typedef struct NANDFlashState NANDFlashState;
bc24a225 59struct NANDFlashState {
7426aa72
PC
60 DeviceState parent_obj;
61
3e3d5815 62 uint8_t manf_id, chip_id;
48197dfa 63 uint8_t buswidth; /* in BYTES */
3e3d5815
AZ
64 int size, pages;
65 int page_shift, oob_shift, erase_shift, addr_shift;
66 uint8_t *storage;
4be74634 67 BlockBackend *blk;
3e3d5815
AZ
68 int mem_oob;
69
51db57f7 70 uint8_t cle, ale, ce, wp, gnd;
3e3d5815
AZ
71
72 uint8_t io[MAX_PAGE + MAX_OOB + 0x400];
73 uint8_t *ioaddr;
74 int iolen;
75
d5f2fd58
JR
76 uint32_t cmd;
77 uint64_t addr;
3e3d5815
AZ
78 int addrlen;
79 int status;
80 int offset;
81
bc24a225
PB
82 void (*blk_write)(NANDFlashState *s);
83 void (*blk_erase)(NANDFlashState *s);
d5f2fd58 84 void (*blk_load)(NANDFlashState *s, uint64_t addr, int offset);
7b9a3d86
JQ
85
86 uint32_t ioaddr_vmstate;
3e3d5815
AZ
87};
88
e12078cc
PC
89#define TYPE_NAND "nand"
90
91#define NAND(obj) \
92 OBJECT_CHECK(NANDFlashState, (obj), TYPE_NAND)
93
89f640bc
PM
94static void mem_and(uint8_t *dest, const uint8_t *src, size_t n)
95{
96 /* Like memcpy() but we logical-AND the data into the destination */
97 int i;
98 for (i = 0; i < n; i++) {
99 dest[i] &= src[i];
100 }
101}
102
3e3d5815
AZ
103# define NAND_NO_AUTOINCR 0x00000001
104# define NAND_BUSWIDTH_16 0x00000002
105# define NAND_NO_PADDING 0x00000004
106# define NAND_CACHEPRG 0x00000008
107# define NAND_COPYBACK 0x00000010
108# define NAND_IS_AND 0x00000020
109# define NAND_4PAGE_ARRAY 0x00000040
110# define NAND_NO_READRDY 0x00000100
111# define NAND_SAMSUNG_LP (NAND_NO_PADDING | NAND_COPYBACK)
112
113# define NAND_IO
114
115# define PAGE(addr) ((addr) >> ADDR_SHIFT)
116# define PAGE_START(page) (PAGE(page) * (PAGE_SIZE + OOB_SIZE))
117# define PAGE_MASK ((1 << ADDR_SHIFT) - 1)
118# define OOB_SHIFT (PAGE_SHIFT - 5)
119# define OOB_SIZE (1 << OOB_SHIFT)
120# define SECTOR(addr) ((addr) >> (9 + ADDR_SHIFT - PAGE_SHIFT))
121# define SECTOR_OFFSET(addr) ((addr) & ((511 >> PAGE_SHIFT) << 8))
122
123# define PAGE_SIZE 256
124# define PAGE_SHIFT 8
125# define PAGE_SECTORS 1
126# define ADDR_SHIFT 8
127# include "nand.c"
128# define PAGE_SIZE 512
129# define PAGE_SHIFT 9
130# define PAGE_SECTORS 1
131# define ADDR_SHIFT 8
132# include "nand.c"
133# define PAGE_SIZE 2048
134# define PAGE_SHIFT 11
135# define PAGE_SECTORS 4
136# define ADDR_SHIFT 16
137# include "nand.c"
138
139/* Information based on Linux drivers/mtd/nand/nand_ids.c */
bc24a225 140static const struct {
3e3d5815
AZ
141 int size;
142 int width;
143 int page_shift;
144 int erase_shift;
145 uint32_t options;
146} nand_flash_ids[0x100] = {
147 [0 ... 0xff] = { 0 },
148
149 [0x6e] = { 1, 8, 8, 4, 0 },
150 [0x64] = { 2, 8, 8, 4, 0 },
151 [0x6b] = { 4, 8, 9, 4, 0 },
152 [0xe8] = { 1, 8, 8, 4, 0 },
153 [0xec] = { 1, 8, 8, 4, 0 },
154 [0xea] = { 2, 8, 8, 4, 0 },
155 [0xd5] = { 4, 8, 9, 4, 0 },
156 [0xe3] = { 4, 8, 9, 4, 0 },
157 [0xe5] = { 4, 8, 9, 4, 0 },
158 [0xd6] = { 8, 8, 9, 4, 0 },
159
160 [0x39] = { 8, 8, 9, 4, 0 },
161 [0xe6] = { 8, 8, 9, 4, 0 },
162 [0x49] = { 8, 16, 9, 4, NAND_BUSWIDTH_16 },
163 [0x59] = { 8, 16, 9, 4, NAND_BUSWIDTH_16 },
164
165 [0x33] = { 16, 8, 9, 5, 0 },
166 [0x73] = { 16, 8, 9, 5, 0 },
167 [0x43] = { 16, 16, 9, 5, NAND_BUSWIDTH_16 },
168 [0x53] = { 16, 16, 9, 5, NAND_BUSWIDTH_16 },
169
170 [0x35] = { 32, 8, 9, 5, 0 },
171 [0x75] = { 32, 8, 9, 5, 0 },
172 [0x45] = { 32, 16, 9, 5, NAND_BUSWIDTH_16 },
173 [0x55] = { 32, 16, 9, 5, NAND_BUSWIDTH_16 },
174
175 [0x36] = { 64, 8, 9, 5, 0 },
176 [0x76] = { 64, 8, 9, 5, 0 },
177 [0x46] = { 64, 16, 9, 5, NAND_BUSWIDTH_16 },
178 [0x56] = { 64, 16, 9, 5, NAND_BUSWIDTH_16 },
179
180 [0x78] = { 128, 8, 9, 5, 0 },
181 [0x39] = { 128, 8, 9, 5, 0 },
182 [0x79] = { 128, 8, 9, 5, 0 },
183 [0x72] = { 128, 16, 9, 5, NAND_BUSWIDTH_16 },
184 [0x49] = { 128, 16, 9, 5, NAND_BUSWIDTH_16 },
185 [0x74] = { 128, 16, 9, 5, NAND_BUSWIDTH_16 },
186 [0x59] = { 128, 16, 9, 5, NAND_BUSWIDTH_16 },
187
188 [0x71] = { 256, 8, 9, 5, 0 },
189
190 /*
191 * These are the new chips with large page size. The pagesize and the
192 * erasesize is determined from the extended id bytes
193 */
194# define LP_OPTIONS (NAND_SAMSUNG_LP | NAND_NO_READRDY | NAND_NO_AUTOINCR)
195# define LP_OPTIONS16 (LP_OPTIONS | NAND_BUSWIDTH_16)
196
197 /* 512 Megabit */
198 [0xa2] = { 64, 8, 0, 0, LP_OPTIONS },
199 [0xf2] = { 64, 8, 0, 0, LP_OPTIONS },
200 [0xb2] = { 64, 16, 0, 0, LP_OPTIONS16 },
201 [0xc2] = { 64, 16, 0, 0, LP_OPTIONS16 },
202
203 /* 1 Gigabit */
204 [0xa1] = { 128, 8, 0, 0, LP_OPTIONS },
205 [0xf1] = { 128, 8, 0, 0, LP_OPTIONS },
206 [0xb1] = { 128, 16, 0, 0, LP_OPTIONS16 },
207 [0xc1] = { 128, 16, 0, 0, LP_OPTIONS16 },
208
209 /* 2 Gigabit */
210 [0xaa] = { 256, 8, 0, 0, LP_OPTIONS },
211 [0xda] = { 256, 8, 0, 0, LP_OPTIONS },
212 [0xba] = { 256, 16, 0, 0, LP_OPTIONS16 },
213 [0xca] = { 256, 16, 0, 0, LP_OPTIONS16 },
214
215 /* 4 Gigabit */
216 [0xac] = { 512, 8, 0, 0, LP_OPTIONS },
217 [0xdc] = { 512, 8, 0, 0, LP_OPTIONS },
218 [0xbc] = { 512, 16, 0, 0, LP_OPTIONS16 },
219 [0xcc] = { 512, 16, 0, 0, LP_OPTIONS16 },
220
221 /* 8 Gigabit */
222 [0xa3] = { 1024, 8, 0, 0, LP_OPTIONS },
223 [0xd3] = { 1024, 8, 0, 0, LP_OPTIONS },
224 [0xb3] = { 1024, 16, 0, 0, LP_OPTIONS16 },
225 [0xc3] = { 1024, 16, 0, 0, LP_OPTIONS16 },
226
227 /* 16 Gigabit */
228 [0xa5] = { 2048, 8, 0, 0, LP_OPTIONS },
229 [0xd5] = { 2048, 8, 0, 0, LP_OPTIONS },
230 [0xb5] = { 2048, 16, 0, 0, LP_OPTIONS16 },
231 [0xc5] = { 2048, 16, 0, 0, LP_OPTIONS16 },
232};
233
d4220389 234static void nand_reset(DeviceState *dev)
3e3d5815 235{
e12078cc 236 NANDFlashState *s = NAND(dev);
3e3d5815
AZ
237 s->cmd = NAND_CMD_READ0;
238 s->addr = 0;
239 s->addrlen = 0;
240 s->iolen = 0;
241 s->offset = 0;
242 s->status &= NAND_IOSTATUS_UNPROTCT;
0bc472a9 243 s->status |= NAND_IOSTATUS_READY;
3e3d5815
AZ
244}
245
48197dfa
JR
246static inline void nand_pushio_byte(NANDFlashState *s, uint8_t value)
247{
248 s->ioaddr[s->iolen++] = value;
249 for (value = s->buswidth; --value;) {
250 s->ioaddr[s->iolen++] = 0;
251 }
252}
253
bc24a225 254static void nand_command(NANDFlashState *s)
3e3d5815 255{
fccd2613 256 unsigned int offset;
3e3d5815
AZ
257 switch (s->cmd) {
258 case NAND_CMD_READ0:
259 s->iolen = 0;
260 break;
261
262 case NAND_CMD_READID:
3e3d5815 263 s->ioaddr = s->io;
48197dfa
JR
264 s->iolen = 0;
265 nand_pushio_byte(s, s->manf_id);
266 nand_pushio_byte(s, s->chip_id);
267 nand_pushio_byte(s, 'Q'); /* Don't-care byte (often 0xa5) */
268 if (nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP) {
269 /* Page Size, Block Size, Spare Size; bit 6 indicates
270 * 8 vs 16 bit width NAND.
271 */
272 nand_pushio_byte(s, (s->buswidth == 2) ? 0x55 : 0x15);
273 } else {
274 nand_pushio_byte(s, 0xc0); /* Multi-plane */
275 }
3e3d5815
AZ
276 break;
277
278 case NAND_CMD_RANDOMREAD2:
279 case NAND_CMD_NOSERIALREAD2:
280 if (!(nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP))
281 break;
fccd2613
EI
282 offset = s->addr & ((1 << s->addr_shift) - 1);
283 s->blk_load(s, s->addr, offset);
284 if (s->gnd)
285 s->iolen = (1 << s->page_shift) - offset;
286 else
287 s->iolen = (1 << s->page_shift) + (1 << s->oob_shift) - offset;
3e3d5815
AZ
288 break;
289
290 case NAND_CMD_RESET:
e12078cc 291 nand_reset(DEVICE(s));
3e3d5815
AZ
292 break;
293
294 case NAND_CMD_PAGEPROGRAM1:
295 s->ioaddr = s->io;
296 s->iolen = 0;
297 break;
298
299 case NAND_CMD_PAGEPROGRAM2:
300 if (s->wp) {
301 s->blk_write(s);
302 }
303 break;
304
305 case NAND_CMD_BLOCKERASE1:
306 break;
307
308 case NAND_CMD_BLOCKERASE2:
32aea752 309 s->addr &= (1ull << s->addrlen * 8) - 1;
1984745e
PC
310 s->addr <<= nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP ?
311 16 : 8;
3e3d5815
AZ
312
313 if (s->wp) {
314 s->blk_erase(s);
315 }
316 break;
317
318 case NAND_CMD_READSTATUS:
3e3d5815 319 s->ioaddr = s->io;
48197dfa
JR
320 s->iolen = 0;
321 nand_pushio_byte(s, s->status);
3e3d5815
AZ
322 break;
323
324 default:
a89f364a 325 printf("%s: Unknown NAND command 0x%02x\n", __func__, s->cmd);
3e3d5815
AZ
326 }
327}
328
44b1ff31 329static int nand_pre_save(void *opaque)
aa941b94 330{
e12078cc 331 NANDFlashState *s = NAND(opaque);
7b9a3d86
JQ
332
333 s->ioaddr_vmstate = s->ioaddr - s->io;
44b1ff31
DDAG
334
335 return 0;
aa941b94
AZ
336}
337
7b9a3d86 338static int nand_post_load(void *opaque, int version_id)
aa941b94 339{
e12078cc 340 NANDFlashState *s = NAND(opaque);
7b9a3d86
JQ
341
342 if (s->ioaddr_vmstate > sizeof(s->io)) {
aa941b94 343 return -EINVAL;
7b9a3d86
JQ
344 }
345 s->ioaddr = s->io + s->ioaddr_vmstate;
aa941b94 346
aa941b94
AZ
347 return 0;
348}
349
7b9a3d86
JQ
350static const VMStateDescription vmstate_nand = {
351 .name = "nand",
ac2466cd
AZ
352 .version_id = 1,
353 .minimum_version_id = 1,
7b9a3d86
JQ
354 .pre_save = nand_pre_save,
355 .post_load = nand_post_load,
8f1e884b 356 .fields = (VMStateField[]) {
7b9a3d86
JQ
357 VMSTATE_UINT8(cle, NANDFlashState),
358 VMSTATE_UINT8(ale, NANDFlashState),
359 VMSTATE_UINT8(ce, NANDFlashState),
360 VMSTATE_UINT8(wp, NANDFlashState),
361 VMSTATE_UINT8(gnd, NANDFlashState),
362 VMSTATE_BUFFER(io, NANDFlashState),
363 VMSTATE_UINT32(ioaddr_vmstate, NANDFlashState),
364 VMSTATE_INT32(iolen, NANDFlashState),
365 VMSTATE_UINT32(cmd, NANDFlashState),
d5f2fd58 366 VMSTATE_UINT64(addr, NANDFlashState),
7b9a3d86
JQ
367 VMSTATE_INT32(addrlen, NANDFlashState),
368 VMSTATE_INT32(status, NANDFlashState),
369 VMSTATE_INT32(offset, NANDFlashState),
370 /* XXX: do we want to save s->storage too? */
371 VMSTATE_END_OF_LIST()
372 }
373};
374
d47a5d9b 375static void nand_realize(DeviceState *dev, Error **errp)
d4220389
JR
376{
377 int pagesize;
e12078cc 378 NANDFlashState *s = NAND(dev);
a17c17a2
KW
379 int ret;
380
d4220389
JR
381
382 s->buswidth = nand_flash_ids[s->chip_id].width >> 3;
383 s->size = nand_flash_ids[s->chip_id].size << 20;
384 if (nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP) {
385 s->page_shift = 11;
386 s->erase_shift = 6;
387 } else {
388 s->page_shift = nand_flash_ids[s->chip_id].page_shift;
389 s->erase_shift = nand_flash_ids[s->chip_id].erase_shift;
390 }
391
392 switch (1 << s->page_shift) {
393 case 256:
394 nand_init_256(s);
395 break;
396 case 512:
397 nand_init_512(s);
398 break;
399 case 2048:
400 nand_init_2048(s);
401 break;
402 default:
eec5eb42 403 error_setg(errp, "Unsupported NAND block size %#x",
d47a5d9b
PC
404 1 << s->page_shift);
405 return;
d4220389
JR
406 }
407
408 pagesize = 1 << s->oob_shift;
409 s->mem_oob = 1;
4be74634
MA
410 if (s->blk) {
411 if (blk_is_read_only(s->blk)) {
d47a5d9b
PC
412 error_setg(errp, "Can't use a read-only drive");
413 return;
3fc3abf7 414 }
a17c17a2
KW
415 ret = blk_set_perm(s->blk, BLK_PERM_CONSISTENT_READ | BLK_PERM_WRITE,
416 BLK_PERM_ALL, errp);
417 if (ret < 0) {
418 return;
419 }
4be74634 420 if (blk_getlength(s->blk) >=
3fc3abf7
JR
421 (s->pages << s->page_shift) + (s->pages << s->oob_shift)) {
422 pagesize = 0;
423 s->mem_oob = 0;
424 }
425 } else {
d4220389
JR
426 pagesize += 1 << s->page_shift;
427 }
428 if (pagesize) {
7267c094 429 s->storage = (uint8_t *) memset(g_malloc(s->pages * pagesize),
d4220389
JR
430 0xff, s->pages * pagesize);
431 }
432 /* Give s->ioaddr a sane value in case we save state before it is used. */
433 s->ioaddr = s->io;
d4220389
JR
434}
435
999e12bb
AL
436static Property nand_properties[] = {
437 DEFINE_PROP_UINT8("manufacturer_id", NANDFlashState, manf_id, 0),
438 DEFINE_PROP_UINT8("chip_id", NANDFlashState, chip_id, 0),
4be74634 439 DEFINE_PROP_DRIVE("drive", NANDFlashState, blk),
999e12bb
AL
440 DEFINE_PROP_END_OF_LIST(),
441};
442
443static void nand_class_init(ObjectClass *klass, void *data)
444{
39bffca2 445 DeviceClass *dc = DEVICE_CLASS(klass);
999e12bb 446
d47a5d9b 447 dc->realize = nand_realize;
39bffca2
AL
448 dc->reset = nand_reset;
449 dc->vmsd = &vmstate_nand;
450 dc->props = nand_properties;
999e12bb
AL
451}
452
8c43a6f0 453static const TypeInfo nand_info = {
e12078cc 454 .name = TYPE_NAND,
7426aa72 455 .parent = TYPE_DEVICE,
39bffca2
AL
456 .instance_size = sizeof(NANDFlashState),
457 .class_init = nand_class_init,
d4220389
JR
458};
459
83f7d43a 460static void nand_register_types(void)
d4220389 461{
39bffca2 462 type_register_static(&nand_info);
d4220389
JR
463}
464
3e3d5815
AZ
465/*
466 * Chip inputs are CLE, ALE, CE, WP, GND and eight I/O pins. Chip
467 * outputs are R/B and eight I/O pins.
468 *
469 * CE, WP and R/B are active low.
470 */
d4220389 471void nand_setpins(DeviceState *dev, uint8_t cle, uint8_t ale,
51db57f7 472 uint8_t ce, uint8_t wp, uint8_t gnd)
3e3d5815 473{
e12078cc
PC
474 NANDFlashState *s = NAND(dev);
475
3e3d5815
AZ
476 s->cle = cle;
477 s->ale = ale;
478 s->ce = ce;
479 s->wp = wp;
480 s->gnd = gnd;
1984745e 481 if (wp) {
3e3d5815 482 s->status |= NAND_IOSTATUS_UNPROTCT;
1984745e 483 } else {
3e3d5815 484 s->status &= ~NAND_IOSTATUS_UNPROTCT;
1984745e 485 }
3e3d5815
AZ
486}
487
d4220389 488void nand_getpins(DeviceState *dev, int *rb)
3e3d5815
AZ
489{
490 *rb = 1;
491}
492
d4220389 493void nand_setio(DeviceState *dev, uint32_t value)
3e3d5815 494{
48197dfa 495 int i;
e12078cc
PC
496 NANDFlashState *s = NAND(dev);
497
3e3d5815
AZ
498 if (!s->ce && s->cle) {
499 if (nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP) {
500 if (s->cmd == NAND_CMD_READ0 && value == NAND_CMD_LPREAD2)
501 return;
502 if (value == NAND_CMD_RANDOMREAD1) {
503 s->addr &= ~((1 << s->addr_shift) - 1);
504 s->addrlen = 0;
505 return;
506 }
507 }
1984745e 508 if (value == NAND_CMD_READ0) {
3e3d5815 509 s->offset = 0;
1984745e 510 } else if (value == NAND_CMD_READ1) {
3e3d5815
AZ
511 s->offset = 0x100;
512 value = NAND_CMD_READ0;
1984745e 513 } else if (value == NAND_CMD_READ2) {
3e3d5815
AZ
514 s->offset = 1 << s->page_shift;
515 value = NAND_CMD_READ0;
516 }
517
518 s->cmd = value;
519
520 if (s->cmd == NAND_CMD_READSTATUS ||
521 s->cmd == NAND_CMD_PAGEPROGRAM2 ||
522 s->cmd == NAND_CMD_BLOCKERASE1 ||
523 s->cmd == NAND_CMD_BLOCKERASE2 ||
524 s->cmd == NAND_CMD_NOSERIALREAD2 ||
525 s->cmd == NAND_CMD_RANDOMREAD2 ||
1984745e 526 s->cmd == NAND_CMD_RESET) {
3e3d5815 527 nand_command(s);
1984745e 528 }
3e3d5815
AZ
529
530 if (s->cmd != NAND_CMD_RANDOMREAD2) {
531 s->addrlen = 0;
3e3d5815
AZ
532 }
533 }
534
535 if (s->ale) {
fccd2613 536 unsigned int shift = s->addrlen * 8;
a184e74f
RV
537 uint64_t mask = ~(0xffull << shift);
538 uint64_t v = (uint64_t)value << shift;
fccd2613
EI
539
540 s->addr = (s->addr & mask) | v;
3e3d5815
AZ
541 s->addrlen ++;
542
48197dfa
JR
543 switch (s->addrlen) {
544 case 1:
545 if (s->cmd == NAND_CMD_READID) {
546 nand_command(s);
547 }
548 break;
549 case 2: /* fix cache address as a byte address */
550 s->addr <<= (s->buswidth - 1);
551 break;
552 case 3:
553 if (!(nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP) &&
554 (s->cmd == NAND_CMD_READ0 ||
555 s->cmd == NAND_CMD_PAGEPROGRAM1)) {
556 nand_command(s);
557 }
558 break;
559 case 4:
560 if ((nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP) &&
561 nand_flash_ids[s->chip_id].size < 256 && /* 1Gb or less */
562 (s->cmd == NAND_CMD_READ0 ||
563 s->cmd == NAND_CMD_PAGEPROGRAM1)) {
564 nand_command(s);
565 }
566 break;
567 case 5:
568 if ((nand_flash_ids[s->chip_id].options & NAND_SAMSUNG_LP) &&
569 nand_flash_ids[s->chip_id].size >= 256 && /* 2Gb or more */
570 (s->cmd == NAND_CMD_READ0 ||
571 s->cmd == NAND_CMD_PAGEPROGRAM1)) {
572 nand_command(s);
573 }
574 break;
575 default:
576 break;
577 }
3e3d5815
AZ
578 }
579
580 if (!s->cle && !s->ale && s->cmd == NAND_CMD_PAGEPROGRAM1) {
48197dfa
JR
581 if (s->iolen < (1 << s->page_shift) + (1 << s->oob_shift)) {
582 for (i = s->buswidth; i--; value >>= 8) {
583 s->io[s->iolen ++] = (uint8_t) (value & 0xff);
584 }
585 }
3e3d5815
AZ
586 } else if (!s->cle && !s->ale && s->cmd == NAND_CMD_COPYBACKPRG1) {
587 if ((s->addr & ((1 << s->addr_shift) - 1)) <
588 (1 << s->page_shift) + (1 << s->oob_shift)) {
48197dfa
JR
589 for (i = s->buswidth; i--; s->addr++, value >>= 8) {
590 s->io[s->iolen + (s->addr & ((1 << s->addr_shift) - 1))] =
591 (uint8_t) (value & 0xff);
592 }
3e3d5815
AZ
593 }
594 }
595}
596
d4220389 597uint32_t nand_getio(DeviceState *dev)
3e3d5815
AZ
598{
599 int offset;
48197dfa 600 uint32_t x = 0;
e12078cc 601 NANDFlashState *s = NAND(dev);
5fafdf24 602
3e3d5815
AZ
603 /* Allow sequential reading */
604 if (!s->iolen && s->cmd == NAND_CMD_READ0) {
d5f2fd58 605 offset = (int) (s->addr & ((1 << s->addr_shift) - 1)) + s->offset;
3e3d5815
AZ
606 s->offset = 0;
607
608 s->blk_load(s, s->addr, offset);
609 if (s->gnd)
610 s->iolen = (1 << s->page_shift) - offset;
611 else
612 s->iolen = (1 << s->page_shift) + (1 << s->oob_shift) - offset;
613 }
614
1984745e 615 if (s->ce || s->iolen <= 0) {
3e3d5815 616 return 0;
1984745e 617 }
3e3d5815 618
48197dfa
JR
619 for (offset = s->buswidth; offset--;) {
620 x |= s->ioaddr[offset] << (offset << 3);
621 }
d72245fb
JR
622 /* after receiving READ STATUS command all subsequent reads will
623 * return the status register value until another command is issued
624 */
625 if (s->cmd != NAND_CMD_READSTATUS) {
626 s->addr += s->buswidth;
627 s->ioaddr += s->buswidth;
628 s->iolen -= s->buswidth;
629 }
48197dfa
JR
630 return x;
631}
632
d4220389 633uint32_t nand_getbuswidth(DeviceState *dev)
48197dfa 634{
d4220389 635 NANDFlashState *s = (NANDFlashState *) dev;
48197dfa 636 return s->buswidth << 3;
3e3d5815
AZ
637}
638
4be74634 639DeviceState *nand_init(BlockBackend *blk, int manf_id, int chip_id)
3e3d5815 640{
d4220389 641 DeviceState *dev;
3e3d5815
AZ
642
643 if (nand_flash_ids[chip_id].size == 0) {
a89f364a 644 hw_error("%s: Unsupported NAND chip ID.\n", __func__);
3e3d5815 645 }
6749695e 646 dev = DEVICE(object_new(TYPE_NAND));
d4220389
JR
647 qdev_prop_set_uint8(dev, "manufacturer_id", manf_id);
648 qdev_prop_set_uint8(dev, "chip_id", chip_id);
4be74634 649 if (blk) {
6231a6da 650 qdev_prop_set_drive(dev, "drive", blk, &error_fatal);
3e3d5815
AZ
651 }
652
d4220389
JR
653 qdev_init_nofail(dev);
654 return dev;
3e3d5815
AZ
655}
656
83f7d43a 657type_init(nand_register_types)
3e3d5815
AZ
658
659#else
660
661/* Program a single page */
bc24a225 662static void glue(nand_blk_write_, PAGE_SIZE)(NANDFlashState *s)
3e3d5815 663{
d5f2fd58 664 uint64_t off, page, sector, soff;
3e3d5815
AZ
665 uint8_t iobuf[(PAGE_SECTORS + 2) * 0x200];
666 if (PAGE(s->addr) >= s->pages)
667 return;
668
4be74634 669 if (!s->blk) {
89f640bc 670 mem_and(s->storage + PAGE_START(s->addr) + (s->addr & PAGE_MASK) +
3e3d5815
AZ
671 s->offset, s->io, s->iolen);
672 } else if (s->mem_oob) {
673 sector = SECTOR(s->addr);
674 off = (s->addr & PAGE_MASK) + s->offset;
675 soff = SECTOR_OFFSET(s->addr);
9fc0d361
EB
676 if (blk_pread(s->blk, sector << BDRV_SECTOR_BITS, iobuf,
677 PAGE_SECTORS << BDRV_SECTOR_BITS) < 0) {
d5f2fd58 678 printf("%s: read error in sector %" PRIu64 "\n", __func__, sector);
3e3d5815
AZ
679 return;
680 }
681
89f640bc 682 mem_and(iobuf + (soff | off), s->io, MIN(s->iolen, PAGE_SIZE - off));
3e3d5815
AZ
683 if (off + s->iolen > PAGE_SIZE) {
684 page = PAGE(s->addr);
89f640bc 685 mem_and(s->storage + (page << OOB_SHIFT), s->io + PAGE_SIZE - off,
3e3d5815
AZ
686 MIN(OOB_SIZE, off + s->iolen - PAGE_SIZE));
687 }
688
9fc0d361
EB
689 if (blk_pwrite(s->blk, sector << BDRV_SECTOR_BITS, iobuf,
690 PAGE_SECTORS << BDRV_SECTOR_BITS, 0) < 0) {
d5f2fd58 691 printf("%s: write error in sector %" PRIu64 "\n", __func__, sector);
7a608f56 692 }
3e3d5815
AZ
693 } else {
694 off = PAGE_START(s->addr) + (s->addr & PAGE_MASK) + s->offset;
695 sector = off >> 9;
696 soff = off & 0x1ff;
9fc0d361
EB
697 if (blk_pread(s->blk, sector << BDRV_SECTOR_BITS, iobuf,
698 (PAGE_SECTORS + 2) << BDRV_SECTOR_BITS) < 0) {
d5f2fd58 699 printf("%s: read error in sector %" PRIu64 "\n", __func__, sector);
3e3d5815
AZ
700 return;
701 }
702
89f640bc 703 mem_and(iobuf + soff, s->io, s->iolen);
3e3d5815 704
9fc0d361
EB
705 if (blk_pwrite(s->blk, sector << BDRV_SECTOR_BITS, iobuf,
706 (PAGE_SECTORS + 2) << BDRV_SECTOR_BITS, 0) < 0) {
d5f2fd58 707 printf("%s: write error in sector %" PRIu64 "\n", __func__, sector);
7a608f56 708 }
3e3d5815
AZ
709 }
710 s->offset = 0;
711}
712
713/* Erase a single block */
bc24a225 714static void glue(nand_blk_erase_, PAGE_SIZE)(NANDFlashState *s)
3e3d5815 715{
d5f2fd58 716 uint64_t i, page, addr;
3e3d5815
AZ
717 uint8_t iobuf[0x200] = { [0 ... 0x1ff] = 0xff, };
718 addr = s->addr & ~((1 << (ADDR_SHIFT + s->erase_shift)) - 1);
719
1984745e 720 if (PAGE(addr) >= s->pages) {
3e3d5815 721 return;
1984745e 722 }
3e3d5815 723
4be74634 724 if (!s->blk) {
3e3d5815
AZ
725 memset(s->storage + PAGE_START(addr),
726 0xff, (PAGE_SIZE + OOB_SIZE) << s->erase_shift);
727 } else if (s->mem_oob) {
728 memset(s->storage + (PAGE(addr) << OOB_SHIFT),
729 0xff, OOB_SIZE << s->erase_shift);
730 i = SECTOR(addr);
8e37ca6d 731 page = SECTOR(addr + (1 << (ADDR_SHIFT + s->erase_shift)));
3e3d5815 732 for (; i < page; i ++)
9fc0d361
EB
733 if (blk_pwrite(s->blk, i << BDRV_SECTOR_BITS, iobuf,
734 BDRV_SECTOR_SIZE, 0) < 0) {
d5f2fd58 735 printf("%s: write error in sector %" PRIu64 "\n", __func__, i);
7a608f56 736 }
3e3d5815
AZ
737 } else {
738 addr = PAGE_START(addr);
739 page = addr >> 9;
9fc0d361
EB
740 if (blk_pread(s->blk, page << BDRV_SECTOR_BITS, iobuf,
741 BDRV_SECTOR_SIZE) < 0) {
d5f2fd58 742 printf("%s: read error in sector %" PRIu64 "\n", __func__, page);
7a608f56 743 }
3e3d5815 744 memset(iobuf + (addr & 0x1ff), 0xff, (~addr & 0x1ff) + 1);
9fc0d361
EB
745 if (blk_pwrite(s->blk, page << BDRV_SECTOR_BITS, iobuf,
746 BDRV_SECTOR_SIZE, 0) < 0) {
d5f2fd58 747 printf("%s: write error in sector %" PRIu64 "\n", __func__, page);
7a608f56 748 }
3e3d5815
AZ
749
750 memset(iobuf, 0xff, 0x200);
751 i = (addr & ~0x1ff) + 0x200;
752 for (addr += ((PAGE_SIZE + OOB_SIZE) << s->erase_shift) - 0x200;
1984745e 753 i < addr; i += 0x200) {
9fc0d361 754 if (blk_pwrite(s->blk, i, iobuf, BDRV_SECTOR_SIZE, 0) < 0) {
d5f2fd58
JR
755 printf("%s: write error in sector %" PRIu64 "\n",
756 __func__, i >> 9);
7a608f56 757 }
1984745e 758 }
3e3d5815
AZ
759
760 page = i >> 9;
9fc0d361
EB
761 if (blk_pread(s->blk, page << BDRV_SECTOR_BITS, iobuf,
762 BDRV_SECTOR_SIZE) < 0) {
d5f2fd58 763 printf("%s: read error in sector %" PRIu64 "\n", __func__, page);
7a608f56 764 }
a07dec22 765 memset(iobuf, 0xff, ((addr - 1) & 0x1ff) + 1);
9fc0d361
EB
766 if (blk_pwrite(s->blk, page << BDRV_SECTOR_BITS, iobuf,
767 BDRV_SECTOR_SIZE, 0) < 0) {
d5f2fd58 768 printf("%s: write error in sector %" PRIu64 "\n", __func__, page);
7a608f56 769 }
3e3d5815
AZ
770 }
771}
772
bc24a225 773static void glue(nand_blk_load_, PAGE_SIZE)(NANDFlashState *s,
d5f2fd58 774 uint64_t addr, int offset)
3e3d5815 775{
1984745e 776 if (PAGE(addr) >= s->pages) {
3e3d5815 777 return;
1984745e 778 }
3e3d5815 779
4be74634 780 if (s->blk) {
3e3d5815 781 if (s->mem_oob) {
9fc0d361
EB
782 if (blk_pread(s->blk, SECTOR(addr) << BDRV_SECTOR_BITS, s->io,
783 PAGE_SECTORS << BDRV_SECTOR_BITS) < 0) {
d5f2fd58
JR
784 printf("%s: read error in sector %" PRIu64 "\n",
785 __func__, SECTOR(addr));
7a608f56 786 }
3e3d5815
AZ
787 memcpy(s->io + SECTOR_OFFSET(s->addr) + PAGE_SIZE,
788 s->storage + (PAGE(s->addr) << OOB_SHIFT),
789 OOB_SIZE);
790 s->ioaddr = s->io + SECTOR_OFFSET(s->addr) + offset;
791 } else {
9fc0d361
EB
792 if (blk_pread(s->blk, PAGE_START(addr), s->io,
793 (PAGE_SECTORS + 2) << BDRV_SECTOR_BITS) < 0) {
d5f2fd58
JR
794 printf("%s: read error in sector %" PRIu64 "\n",
795 __func__, PAGE_START(addr) >> 9);
7a608f56 796 }
3e3d5815
AZ
797 s->ioaddr = s->io + (PAGE_START(addr) & 0x1ff) + offset;
798 }
799 } else {
800 memcpy(s->io, s->storage + PAGE_START(s->addr) +
801 offset, PAGE_SIZE + OOB_SIZE - offset);
802 s->ioaddr = s->io;
803 }
3e3d5815
AZ
804}
805
bc24a225 806static void glue(nand_init_, PAGE_SIZE)(NANDFlashState *s)
3e3d5815
AZ
807{
808 s->oob_shift = PAGE_SHIFT - 5;
809 s->pages = s->size >> PAGE_SHIFT;
810 s->addr_shift = ADDR_SHIFT;
811
812 s->blk_erase = glue(nand_blk_erase_, PAGE_SIZE);
813 s->blk_write = glue(nand_blk_write_, PAGE_SIZE);
814 s->blk_load = glue(nand_blk_load_, PAGE_SIZE);
815}
816
817# undef PAGE_SIZE
818# undef PAGE_SHIFT
819# undef PAGE_SECTORS
820# undef ADDR_SHIFT
821#endif /* NAND_IO */