add const keyword to some APIs
[openocd.git] / src / flash / nand.c
1 /***************************************************************************
2 * Copyright (C) 2007 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Partially based on drivers/mtd/nand_ids.c from Linux. *
6 * Copyright (C) 2002 Thomas Gleixner <tglx@linutronix.de> *
7 * *
8 * This program is free software; you can redistribute it and/or modify *
9 * it under the terms of the GNU General Public License as published by *
10 * the Free Software Foundation; either version 2 of the License, or *
11 * (at your option) any later version. *
12 * *
13 * This program is distributed in the hope that it will be useful, *
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16 * GNU General Public License for more details. *
17 * *
18 * You should have received a copy of the GNU General Public License *
19 * along with this program; if not, write to the *
20 * Free Software Foundation, Inc., *
21 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
22 ***************************************************************************/
23 #ifdef HAVE_CONFIG_H
24 #include "config.h"
25 #endif
26
27 #include "nand.h"
28 #include "time_support.h"
29 #include "fileio.h"
30
31 static int nand_read_page(struct nand_device_s *device, uint32_t page, uint8_t *data, uint32_t data_size, uint8_t *oob, uint32_t oob_size);
32 //static int nand_read_plain(struct nand_device_s *device, uint32_t address, uint8_t *data, uint32_t data_size);
33
34 static int nand_write_page(struct nand_device_s *device, uint32_t page, uint8_t *data, uint32_t data_size, uint8_t *oob, uint32_t oob_size);
35
36 /* NAND flash controller
37 */
38 extern nand_flash_controller_t davinci_nand_controller;
39 extern nand_flash_controller_t lpc3180_nand_controller;
40 extern nand_flash_controller_t orion_nand_controller;
41 extern nand_flash_controller_t s3c2410_nand_controller;
42 extern nand_flash_controller_t s3c2412_nand_controller;
43 extern nand_flash_controller_t s3c2440_nand_controller;
44 extern nand_flash_controller_t s3c2443_nand_controller;
45 extern nand_flash_controller_t imx31_nand_flash_controller;
46
47 /* extern nand_flash_controller_t boundary_scan_nand_controller; */
48
49 static nand_flash_controller_t *nand_flash_controllers[] =
50 {
51 &davinci_nand_controller,
52 &lpc3180_nand_controller,
53 &orion_nand_controller,
54 &s3c2410_nand_controller,
55 &s3c2412_nand_controller,
56 &s3c2440_nand_controller,
57 &s3c2443_nand_controller,
58 &imx31_nand_flash_controller,
59 /* &boundary_scan_nand_controller, */
60 NULL
61 };
62
63 /* configured NAND devices and NAND Flash command handler */
64 static nand_device_t *nand_devices = NULL;
65 static command_t *nand_cmd;
66
67 /* Chip ID list
68 *
69 * Name, ID code, pagesize, chipsize in MegaByte, eraseblock size,
70 * options
71 *
72 * Pagesize; 0, 256, 512
73 * 0 get this information from the extended chip ID
74 * 256 256 Byte page size
75 * 512 512 Byte page size
76 */
77 static nand_info_t nand_flash_ids[] =
78 {
79 /* start "museum" IDs */
80 {"NAND 1MiB 5V 8-bit", 0x6e, 256, 1, 0x1000, 0},
81 {"NAND 2MiB 5V 8-bit", 0x64, 256, 2, 0x1000, 0},
82 {"NAND 4MiB 5V 8-bit", 0x6b, 512, 4, 0x2000, 0},
83 {"NAND 1MiB 3,3V 8-bit", 0xe8, 256, 1, 0x1000, 0},
84 {"NAND 1MiB 3,3V 8-bit", 0xec, 256, 1, 0x1000, 0},
85 {"NAND 2MiB 3,3V 8-bit", 0xea, 256, 2, 0x1000, 0},
86 {"NAND 4MiB 3,3V 8-bit", 0xd5, 512, 4, 0x2000, 0},
87 {"NAND 4MiB 3,3V 8-bit", 0xe3, 512, 4, 0x2000, 0},
88 {"NAND 4MiB 3,3V 8-bit", 0xe5, 512, 4, 0x2000, 0},
89 {"NAND 8MiB 3,3V 8-bit", 0xd6, 512, 8, 0x2000, 0},
90
91 {"NAND 8MiB 1,8V 8-bit", 0x39, 512, 8, 0x2000, 0},
92 {"NAND 8MiB 3,3V 8-bit", 0xe6, 512, 8, 0x2000, 0},
93 {"NAND 8MiB 1,8V 16-bit", 0x49, 512, 8, 0x2000, NAND_BUSWIDTH_16},
94 {"NAND 8MiB 3,3V 16-bit", 0x59, 512, 8, 0x2000, NAND_BUSWIDTH_16},
95 /* end "museum" IDs */
96
97 {"NAND 16MiB 1,8V 8-bit", 0x33, 512, 16, 0x4000, 0},
98 {"NAND 16MiB 3,3V 8-bit", 0x73, 512, 16, 0x4000, 0},
99 {"NAND 16MiB 1,8V 16-bit", 0x43, 512, 16, 0x4000, NAND_BUSWIDTH_16},
100 {"NAND 16MiB 3,3V 16-bit", 0x53, 512, 16, 0x4000, NAND_BUSWIDTH_16},
101
102 {"NAND 32MiB 1,8V 8-bit", 0x35, 512, 32, 0x4000, 0},
103 {"NAND 32MiB 3,3V 8-bit", 0x75, 512, 32, 0x4000, 0},
104 {"NAND 32MiB 1,8V 16-bit", 0x45, 512, 32, 0x4000, NAND_BUSWIDTH_16},
105 {"NAND 32MiB 3,3V 16-bit", 0x55, 512, 32, 0x4000, NAND_BUSWIDTH_16},
106
107 {"NAND 64MiB 1,8V 8-bit", 0x36, 512, 64, 0x4000, 0},
108 {"NAND 64MiB 3,3V 8-bit", 0x76, 512, 64, 0x4000, 0},
109 {"NAND 64MiB 1,8V 16-bit", 0x46, 512, 64, 0x4000, NAND_BUSWIDTH_16},
110 {"NAND 64MiB 3,3V 16-bit", 0x56, 512, 64, 0x4000, NAND_BUSWIDTH_16},
111
112 {"NAND 128MiB 1,8V 8-bit", 0x78, 512, 128, 0x4000, 0},
113 {"NAND 128MiB 1,8V 8-bit", 0x39, 512, 128, 0x4000, 0},
114 {"NAND 128MiB 3,3V 8-bit", 0x79, 512, 128, 0x4000, 0},
115 {"NAND 128MiB 1,8V 16-bit", 0x72, 512, 128, 0x4000, NAND_BUSWIDTH_16},
116 {"NAND 128MiB 1,8V 16-bit", 0x49, 512, 128, 0x4000, NAND_BUSWIDTH_16},
117 {"NAND 128MiB 3,3V 16-bit", 0x74, 512, 128, 0x4000, NAND_BUSWIDTH_16},
118 {"NAND 128MiB 3,3V 16-bit", 0x59, 512, 128, 0x4000, NAND_BUSWIDTH_16},
119
120 {"NAND 256MiB 3,3V 8-bit", 0x71, 512, 256, 0x4000, 0},
121
122 {"NAND 64MiB 1,8V 8-bit", 0xA2, 0, 64, 0, LP_OPTIONS},
123 {"NAND 64MiB 3,3V 8-bit", 0xF2, 0, 64, 0, LP_OPTIONS},
124 {"NAND 64MiB 1,8V 16-bit", 0xB2, 0, 64, 0, LP_OPTIONS16},
125 {"NAND 64MiB 3,3V 16-bit", 0xC2, 0, 64, 0, LP_OPTIONS16},
126
127 {"NAND 128MiB 1,8V 8-bit", 0xA1, 0, 128, 0, LP_OPTIONS},
128 {"NAND 128MiB 3,3V 8-bit", 0xF1, 0, 128, 0, LP_OPTIONS},
129 {"NAND 128MiB 1,8V 16-bit", 0xB1, 0, 128, 0, LP_OPTIONS16},
130 {"NAND 128MiB 3,3V 16-bit", 0xC1, 0, 128, 0, LP_OPTIONS16},
131
132 {"NAND 256MiB 1,8V 8-bit", 0xAA, 0, 256, 0, LP_OPTIONS},
133 {"NAND 256MiB 3,3V 8-bit", 0xDA, 0, 256, 0, LP_OPTIONS},
134 {"NAND 256MiB 1,8V 16-bit", 0xBA, 0, 256, 0, LP_OPTIONS16},
135 {"NAND 256MiB 3,3V 16-bit", 0xCA, 0, 256, 0, LP_OPTIONS16},
136
137 {"NAND 512MiB 1,8V 8-bit", 0xAC, 0, 512, 0, LP_OPTIONS},
138 {"NAND 512MiB 3,3V 8-bit", 0xDC, 0, 512, 0, LP_OPTIONS},
139 {"NAND 512MiB 1,8V 16-bit", 0xBC, 0, 512, 0, LP_OPTIONS16},
140 {"NAND 512MiB 3,3V 16-bit", 0xCC, 0, 512, 0, LP_OPTIONS16},
141
142 {"NAND 1GiB 1,8V 8-bit", 0xA3, 0, 1024, 0, LP_OPTIONS},
143 {"NAND 1GiB 3,3V 8-bit", 0xD3, 0, 1024, 0, LP_OPTIONS},
144 {"NAND 1GiB 1,8V 16-bit", 0xB3, 0, 1024, 0, LP_OPTIONS16},
145 {"NAND 1GiB 3,3V 16-bit", 0xC3, 0, 1024, 0, LP_OPTIONS16},
146
147 {"NAND 2GiB 1,8V 8-bit", 0xA5, 0, 2048, 0, LP_OPTIONS},
148 {"NAND 2GiB 3,3V 8-bit", 0xD5, 0, 2048, 0, LP_OPTIONS},
149 {"NAND 2GiB 1,8V 16-bit", 0xB5, 0, 2048, 0, LP_OPTIONS16},
150 {"NAND 2GiB 3,3V 16-bit", 0xC5, 0, 2048, 0, LP_OPTIONS16},
151
152 {NULL, 0, 0, 0, 0, 0 }
153 };
154
155 /* Manufacturer ID list
156 */
157 static nand_manufacturer_t nand_manuf_ids[] =
158 {
159 {0x0, "unknown"},
160 {NAND_MFR_TOSHIBA, "Toshiba"},
161 {NAND_MFR_SAMSUNG, "Samsung"},
162 {NAND_MFR_FUJITSU, "Fujitsu"},
163 {NAND_MFR_NATIONAL, "National"},
164 {NAND_MFR_RENESAS, "Renesas"},
165 {NAND_MFR_STMICRO, "ST Micro"},
166 {NAND_MFR_HYNIX, "Hynix"},
167 {NAND_MFR_MICRON, "Micron"},
168 {0x0, NULL},
169 };
170
171 /*
172 * Define default oob placement schemes for large and small page devices
173 */
174
175 #if 0
176 static nand_ecclayout_t nand_oob_8 = {
177 .eccbytes = 3,
178 .eccpos = {0, 1, 2},
179 .oobfree = {
180 {.offset = 3,
181 .length = 2},
182 {.offset = 6,
183 .length = 2}}
184 };
185 #endif
186
187 static nand_ecclayout_t nand_oob_16 = {
188 .eccbytes = 6,
189 .eccpos = {0, 1, 2, 3, 6, 7},
190 .oobfree = {
191 {.offset = 8,
192 . length = 8}}
193 };
194
195 static nand_ecclayout_t nand_oob_64 = {
196 .eccbytes = 24,
197 .eccpos = {
198 40, 41, 42, 43, 44, 45, 46, 47,
199 48, 49, 50, 51, 52, 53, 54, 55,
200 56, 57, 58, 59, 60, 61, 62, 63},
201 .oobfree = {
202 {.offset = 2,
203 .length = 38}}
204 };
205
206 /* nand device <nand_controller> [controller options]
207 */
208 static int handle_nand_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
209 {
210 int i;
211 int retval;
212
213 if (argc < 1)
214 {
215 LOG_WARNING("incomplete flash device nand configuration");
216 return ERROR_FLASH_BANK_INVALID;
217 }
218
219 for (i = 0; nand_flash_controllers[i]; i++)
220 {
221 nand_device_t *p, *c;
222
223 if (strcmp(args[0], nand_flash_controllers[i]->name) == 0)
224 {
225 /* register flash specific commands */
226 if ((retval = nand_flash_controllers[i]->register_commands(cmd_ctx)) != ERROR_OK)
227 {
228 LOG_ERROR("couldn't register '%s' commands", args[0]);
229 return retval;
230 }
231
232 c = malloc(sizeof(nand_device_t));
233
234 c->controller = nand_flash_controllers[i];
235 c->controller_priv = NULL;
236 c->manufacturer = NULL;
237 c->device = NULL;
238 c->bus_width = 0;
239 c->address_cycles = 0;
240 c->page_size = 0;
241 c->use_raw = 0;
242 c->next = NULL;
243
244 if ((retval = nand_flash_controllers[i]->nand_device_command(cmd_ctx, cmd, args, argc, c)) != ERROR_OK)
245 {
246 LOG_ERROR("'%s' driver rejected nand flash", c->controller->name);
247 free(c);
248 return ERROR_OK;
249 }
250
251 /* put NAND device in linked list */
252 if (nand_devices)
253 {
254 /* find last flash device */
255 for (p = nand_devices; p && p->next; p = p->next);
256 if (p)
257 p->next = c;
258 }
259 else
260 {
261 nand_devices = c;
262 }
263
264 return ERROR_OK;
265 }
266 }
267
268 /* no valid NAND controller was found (i.e. the configuration option,
269 * didn't match one of the compiled-in controllers)
270 */
271 LOG_ERROR("No valid NAND flash controller found (%s)", args[0]);
272 LOG_ERROR("compiled-in NAND flash controllers:");
273 for (i = 0; nand_flash_controllers[i]; i++)
274 {
275 LOG_ERROR("%i: %s", i, nand_flash_controllers[i]->name);
276 }
277
278 return ERROR_OK;
279 }
280
281 int nand_register_commands(struct command_context_s *cmd_ctx)
282 {
283 nand_cmd = register_command(cmd_ctx, NULL, "nand", NULL, COMMAND_ANY, "NAND specific commands");
284
285 register_command(cmd_ctx, nand_cmd, "device", handle_nand_device_command, COMMAND_CONFIG, NULL);
286
287 return ERROR_OK;
288 }
289
290 nand_device_t *get_nand_device_by_num(int num)
291 {
292 nand_device_t *p;
293 int i = 0;
294
295 for (p = nand_devices; p; p = p->next)
296 {
297 if (i++ == num)
298 {
299 return p;
300 }
301 }
302
303 return NULL;
304 }
305
306 int nand_command_get_device_by_num(struct command_context_s *cmd_ctx,
307 const char *str, nand_device_t **device)
308 {
309 unsigned num;
310 COMMAND_PARSE_NUMBER(uint, str, num);
311 *device = get_nand_device_by_num(num);
312 if (!*device) {
313 command_print(cmd_ctx, "NAND flash device '#%s' is out of bounds", str);
314 return ERROR_INVALID_ARGUMENTS;
315 }
316 return ERROR_OK;
317 }
318
319 static int nand_build_bbt(struct nand_device_s *device, int first, int last)
320 {
321 uint32_t page = 0x0;
322 int i;
323 uint8_t oob[6];
324
325 if ((first < 0) || (first >= device->num_blocks))
326 first = 0;
327
328 if ((last >= device->num_blocks) || (last == -1))
329 last = device->num_blocks - 1;
330
331 for (i = first; i < last; i++)
332 {
333 nand_read_page(device, page, NULL, 0, oob, 6);
334
335 if (((device->device->options & NAND_BUSWIDTH_16) && ((oob[0] & oob[1]) != 0xff))
336 || (((device->page_size == 512) && (oob[5] != 0xff)) ||
337 ((device->page_size == 2048) && (oob[0] != 0xff))))
338 {
339 LOG_WARNING("bad block: %i", i);
340 device->blocks[i].is_bad = 1;
341 }
342 else
343 {
344 device->blocks[i].is_bad = 0;
345 }
346
347 page += (device->erase_size / device->page_size);
348 }
349
350 return ERROR_OK;
351 }
352
353 int nand_read_status(struct nand_device_s *device, uint8_t *status)
354 {
355 if (!device->device)
356 return ERROR_NAND_DEVICE_NOT_PROBED;
357
358 /* Send read status command */
359 device->controller->command(device, NAND_CMD_STATUS);
360
361 alive_sleep(1);
362
363 /* read status */
364 if (device->device->options & NAND_BUSWIDTH_16)
365 {
366 uint16_t data;
367 device->controller->read_data(device, &data);
368 *status = data & 0xff;
369 }
370 else
371 {
372 device->controller->read_data(device, status);
373 }
374
375 return ERROR_OK;
376 }
377
378 static int nand_poll_ready(struct nand_device_s *device, int timeout)
379 {
380 uint8_t status;
381
382 device->controller->command(device, NAND_CMD_STATUS);
383 do {
384 if (device->device->options & NAND_BUSWIDTH_16) {
385 uint16_t data;
386 device->controller->read_data(device, &data);
387 status = data & 0xff;
388 } else {
389 device->controller->read_data(device, &status);
390 }
391 if (status & NAND_STATUS_READY)
392 break;
393 alive_sleep(1);
394 } while (timeout--);
395
396 return (status & NAND_STATUS_READY) != 0;
397 }
398
399 int nand_probe(struct nand_device_s *device)
400 {
401 uint8_t manufacturer_id, device_id;
402 uint8_t id_buff[6];
403 int retval;
404 int i;
405
406 /* clear device data */
407 device->device = NULL;
408 device->manufacturer = NULL;
409
410 /* clear device parameters */
411 device->bus_width = 0;
412 device->address_cycles = 0;
413 device->page_size = 0;
414 device->erase_size = 0;
415
416 /* initialize controller (device parameters are zero, use controller default) */
417 if ((retval = device->controller->init(device) != ERROR_OK))
418 {
419 switch (retval)
420 {
421 case ERROR_NAND_OPERATION_FAILED:
422 LOG_DEBUG("controller initialization failed");
423 return ERROR_NAND_OPERATION_FAILED;
424 case ERROR_NAND_OPERATION_NOT_SUPPORTED:
425 LOG_ERROR("BUG: controller reported that it doesn't support default parameters");
426 return ERROR_NAND_OPERATION_FAILED;
427 default:
428 LOG_ERROR("BUG: unknown controller initialization failure");
429 return ERROR_NAND_OPERATION_FAILED;
430 }
431 }
432
433 device->controller->command(device, NAND_CMD_RESET);
434 device->controller->reset(device);
435
436 device->controller->command(device, NAND_CMD_READID);
437 device->controller->address(device, 0x0);
438
439 if (device->bus_width == 8)
440 {
441 device->controller->read_data(device, &manufacturer_id);
442 device->controller->read_data(device, &device_id);
443 }
444 else
445 {
446 uint16_t data_buf;
447 device->controller->read_data(device, &data_buf);
448 manufacturer_id = data_buf & 0xff;
449 device->controller->read_data(device, &data_buf);
450 device_id = data_buf & 0xff;
451 }
452
453 for (i = 0; nand_flash_ids[i].name; i++)
454 {
455 if (nand_flash_ids[i].id == device_id)
456 {
457 device->device = &nand_flash_ids[i];
458 break;
459 }
460 }
461
462 for (i = 0; nand_manuf_ids[i].name; i++)
463 {
464 if (nand_manuf_ids[i].id == manufacturer_id)
465 {
466 device->manufacturer = &nand_manuf_ids[i];
467 break;
468 }
469 }
470
471 if (!device->manufacturer)
472 {
473 device->manufacturer = &nand_manuf_ids[0];
474 device->manufacturer->id = manufacturer_id;
475 }
476
477 if (!device->device)
478 {
479 LOG_ERROR("unknown NAND flash device found, manufacturer id: 0x%2.2x device id: 0x%2.2x",
480 manufacturer_id, device_id);
481 return ERROR_NAND_OPERATION_FAILED;
482 }
483
484 LOG_DEBUG("found %s (%s)", device->device->name, device->manufacturer->name);
485
486 /* initialize device parameters */
487
488 /* bus width */
489 if (device->device->options & NAND_BUSWIDTH_16)
490 device->bus_width = 16;
491 else
492 device->bus_width = 8;
493
494 /* Do we need extended device probe information? */
495 if (device->device->page_size == 0 ||
496 device->device->erase_size == 0)
497 {
498 if (device->bus_width == 8)
499 {
500 device->controller->read_data(device, id_buff + 3);
501 device->controller->read_data(device, id_buff + 4);
502 device->controller->read_data(device, id_buff + 5);
503 }
504 else
505 {
506 uint16_t data_buf;
507
508 device->controller->read_data(device, &data_buf);
509 id_buff[3] = data_buf;
510
511 device->controller->read_data(device, &data_buf);
512 id_buff[4] = data_buf;
513
514 device->controller->read_data(device, &data_buf);
515 id_buff[5] = data_buf >> 8;
516 }
517 }
518
519 /* page size */
520 if (device->device->page_size == 0)
521 {
522 device->page_size = 1 << (10 + (id_buff[4] & 3));
523 }
524 else if (device->device->page_size == 256)
525 {
526 LOG_ERROR("NAND flashes with 256 byte pagesize are not supported");
527 return ERROR_NAND_OPERATION_FAILED;
528 }
529 else
530 {
531 device->page_size = device->device->page_size;
532 }
533
534 /* number of address cycles */
535 if (device->page_size <= 512)
536 {
537 /* small page devices */
538 if (device->device->chip_size <= 32)
539 device->address_cycles = 3;
540 else if (device->device->chip_size <= 8*1024)
541 device->address_cycles = 4;
542 else
543 {
544 LOG_ERROR("BUG: small page NAND device with more than 8 GiB encountered");
545 device->address_cycles = 5;
546 }
547 }
548 else
549 {
550 /* large page devices */
551 if (device->device->chip_size <= 128)
552 device->address_cycles = 4;
553 else if (device->device->chip_size <= 32*1024)
554 device->address_cycles = 5;
555 else
556 {
557 LOG_ERROR("BUG: large page NAND device with more than 32 GiB encountered");
558 device->address_cycles = 6;
559 }
560 }
561
562 /* erase size */
563 if (device->device->erase_size == 0)
564 {
565 switch ((id_buff[4] >> 4) & 3) {
566 case 0:
567 device->erase_size = 64 << 10;
568 break;
569 case 1:
570 device->erase_size = 128 << 10;
571 break;
572 case 2:
573 device->erase_size = 256 << 10;
574 break;
575 case 3:
576 device->erase_size =512 << 10;
577 break;
578 }
579 }
580 else
581 {
582 device->erase_size = device->device->erase_size;
583 }
584
585 /* initialize controller, but leave parameters at the controllers default */
586 if ((retval = device->controller->init(device) != ERROR_OK))
587 {
588 switch (retval)
589 {
590 case ERROR_NAND_OPERATION_FAILED:
591 LOG_DEBUG("controller initialization failed");
592 return ERROR_NAND_OPERATION_FAILED;
593 case ERROR_NAND_OPERATION_NOT_SUPPORTED:
594 LOG_ERROR("controller doesn't support requested parameters (buswidth: %i, address cycles: %i, page size: %i)",
595 device->bus_width, device->address_cycles, device->page_size);
596 return ERROR_NAND_OPERATION_FAILED;
597 default:
598 LOG_ERROR("BUG: unknown controller initialization failure");
599 return ERROR_NAND_OPERATION_FAILED;
600 }
601 }
602
603 device->num_blocks = (device->device->chip_size * 1024) / (device->erase_size / 1024);
604 device->blocks = malloc(sizeof(nand_block_t) * device->num_blocks);
605
606 for (i = 0; i < device->num_blocks; i++)
607 {
608 device->blocks[i].size = device->erase_size;
609 device->blocks[i].offset = i * device->erase_size;
610 device->blocks[i].is_erased = -1;
611 device->blocks[i].is_bad = -1;
612 }
613
614 return ERROR_OK;
615 }
616
617 static int nand_erase(struct nand_device_s *device, int first_block, int last_block)
618 {
619 int i;
620 uint32_t page;
621 uint8_t status;
622 int retval;
623
624 if (!device->device)
625 return ERROR_NAND_DEVICE_NOT_PROBED;
626
627 if ((first_block < 0) || (last_block > device->num_blocks))
628 return ERROR_INVALID_ARGUMENTS;
629
630 /* make sure we know if a block is bad before erasing it */
631 for (i = first_block; i <= last_block; i++)
632 {
633 if (device->blocks[i].is_bad == -1)
634 {
635 nand_build_bbt(device, i, last_block);
636 break;
637 }
638 }
639
640 for (i = first_block; i <= last_block; i++)
641 {
642 /* Send erase setup command */
643 device->controller->command(device, NAND_CMD_ERASE1);
644
645 page = i * (device->erase_size / device->page_size);
646
647 /* Send page address */
648 if (device->page_size <= 512)
649 {
650 /* row */
651 device->controller->address(device, page & 0xff);
652 device->controller->address(device, (page >> 8) & 0xff);
653
654 /* 3rd cycle only on devices with more than 32 MiB */
655 if (device->address_cycles >= 4)
656 device->controller->address(device, (page >> 16) & 0xff);
657
658 /* 4th cycle only on devices with more than 8 GiB */
659 if (device->address_cycles >= 5)
660 device->controller->address(device, (page >> 24) & 0xff);
661 }
662 else
663 {
664 /* row */
665 device->controller->address(device, page & 0xff);
666 device->controller->address(device, (page >> 8) & 0xff);
667
668 /* 3rd cycle only on devices with more than 128 MiB */
669 if (device->address_cycles >= 5)
670 device->controller->address(device, (page >> 16) & 0xff);
671 }
672
673 /* Send erase confirm command */
674 device->controller->command(device, NAND_CMD_ERASE2);
675
676 retval = device->controller->nand_ready ?
677 device->controller->nand_ready(device, 1000) :
678 nand_poll_ready(device, 1000);
679 if (!retval) {
680 LOG_ERROR("timeout waiting for NAND flash block erase to complete");
681 return ERROR_NAND_OPERATION_TIMEOUT;
682 }
683
684 if ((retval = nand_read_status(device, &status)) != ERROR_OK)
685 {
686 LOG_ERROR("couldn't read status");
687 return ERROR_NAND_OPERATION_FAILED;
688 }
689
690 if (status & 0x1)
691 {
692 LOG_ERROR("didn't erase %sblock %d; status: 0x%2.2x",
693 (device->blocks[i].is_bad == 1)
694 ? "bad " : "",
695 i, status);
696 /* continue; other blocks might still be erasable */
697 }
698
699 device->blocks[i].is_erased = 1;
700 }
701
702 return ERROR_OK;
703 }
704
705 #if 0
706 static int nand_read_plain(struct nand_device_s *device, uint32_t address, uint8_t *data, uint32_t data_size)
707 {
708 uint8_t *page;
709
710 if (!device->device)
711 return ERROR_NAND_DEVICE_NOT_PROBED;
712
713 if (address % device->page_size)
714 {
715 LOG_ERROR("reads need to be page aligned");
716 return ERROR_NAND_OPERATION_FAILED;
717 }
718
719 page = malloc(device->page_size);
720
721 while (data_size > 0)
722 {
723 uint32_t thisrun_size = (data_size > device->page_size) ? device->page_size : data_size;
724 uint32_t page_address;
725
726
727 page_address = address / device->page_size;
728
729 nand_read_page(device, page_address, page, device->page_size, NULL, 0);
730
731 memcpy(data, page, thisrun_size);
732
733 address += thisrun_size;
734 data += thisrun_size;
735 data_size -= thisrun_size;
736 }
737
738 free(page);
739
740 return ERROR_OK;
741 }
742
743 static int nand_write_plain(struct nand_device_s *device, uint32_t address, uint8_t *data, uint32_t data_size)
744 {
745 uint8_t *page;
746
747 if (!device->device)
748 return ERROR_NAND_DEVICE_NOT_PROBED;
749
750 if (address % device->page_size)
751 {
752 LOG_ERROR("writes need to be page aligned");
753 return ERROR_NAND_OPERATION_FAILED;
754 }
755
756 page = malloc(device->page_size);
757
758 while (data_size > 0)
759 {
760 uint32_t thisrun_size = (data_size > device->page_size) ? device->page_size : data_size;
761 uint32_t page_address;
762
763 memset(page, 0xff, device->page_size);
764 memcpy(page, data, thisrun_size);
765
766 page_address = address / device->page_size;
767
768 nand_write_page(device, page_address, page, device->page_size, NULL, 0);
769
770 address += thisrun_size;
771 data += thisrun_size;
772 data_size -= thisrun_size;
773 }
774
775 free(page);
776
777 return ERROR_OK;
778 }
779 #endif
780
781 int nand_write_page(struct nand_device_s *device, uint32_t page, uint8_t *data, uint32_t data_size, uint8_t *oob, uint32_t oob_size)
782 {
783 uint32_t block;
784
785 if (!device->device)
786 return ERROR_NAND_DEVICE_NOT_PROBED;
787
788 block = page / (device->erase_size / device->page_size);
789 if (device->blocks[block].is_erased == 1)
790 device->blocks[block].is_erased = 0;
791
792 if (device->use_raw || device->controller->write_page == NULL)
793 return nand_write_page_raw(device, page, data, data_size, oob, oob_size);
794 else
795 return device->controller->write_page(device, page, data, data_size, oob, oob_size);
796 }
797
798 static int nand_read_page(struct nand_device_s *device, uint32_t page, uint8_t *data, uint32_t data_size, uint8_t *oob, uint32_t oob_size)
799 {
800 if (!device->device)
801 return ERROR_NAND_DEVICE_NOT_PROBED;
802
803 if (device->use_raw || device->controller->read_page == NULL)
804 return nand_read_page_raw(device, page, data, data_size, oob, oob_size);
805 else
806 return device->controller->read_page(device, page, data, data_size, oob, oob_size);
807 }
808
809 int nand_read_page_raw(struct nand_device_s *device, uint32_t page, uint8_t *data, uint32_t data_size, uint8_t *oob, uint32_t oob_size)
810 {
811 uint32_t i;
812
813 if (!device->device)
814 return ERROR_NAND_DEVICE_NOT_PROBED;
815
816 if (device->page_size <= 512)
817 {
818 /* small page device */
819 if (data)
820 device->controller->command(device, NAND_CMD_READ0);
821 else
822 device->controller->command(device, NAND_CMD_READOOB);
823
824 /* column (always 0, we start at the beginning of a page/OOB area) */
825 device->controller->address(device, 0x0);
826
827 /* row */
828 device->controller->address(device, page & 0xff);
829 device->controller->address(device, (page >> 8) & 0xff);
830
831 /* 4th cycle only on devices with more than 32 MiB */
832 if (device->address_cycles >= 4)
833 device->controller->address(device, (page >> 16) & 0xff);
834
835 /* 5th cycle only on devices with more than 8 GiB */
836 if (device->address_cycles >= 5)
837 device->controller->address(device, (page >> 24) & 0xff);
838 }
839 else
840 {
841 /* large page device */
842 device->controller->command(device, NAND_CMD_READ0);
843
844 /* column (0 when we start at the beginning of a page,
845 * or 2048 for the beginning of OOB area)
846 */
847 device->controller->address(device, 0x0);
848 if (data)
849 device->controller->address(device, 0x0);
850 else
851 device->controller->address(device, 0x8);
852
853 /* row */
854 device->controller->address(device, page & 0xff);
855 device->controller->address(device, (page >> 8) & 0xff);
856
857 /* 5th cycle only on devices with more than 128 MiB */
858 if (device->address_cycles >= 5)
859 device->controller->address(device, (page >> 16) & 0xff);
860
861 /* large page devices need a start command */
862 device->controller->command(device, NAND_CMD_READSTART);
863 }
864
865 if (device->controller->nand_ready) {
866 if (!device->controller->nand_ready(device, 100))
867 return ERROR_NAND_OPERATION_TIMEOUT;
868 } else {
869 alive_sleep(1);
870 }
871
872 if (data)
873 {
874 if (device->controller->read_block_data != NULL)
875 (device->controller->read_block_data)(device, data, data_size);
876 else
877 {
878 for (i = 0; i < data_size;)
879 {
880 if (device->device->options & NAND_BUSWIDTH_16)
881 {
882 device->controller->read_data(device, data);
883 data += 2;
884 i += 2;
885 }
886 else
887 {
888 device->controller->read_data(device, data);
889 data += 1;
890 i += 1;
891 }
892 }
893 }
894 }
895
896 if (oob)
897 {
898 if (device->controller->read_block_data != NULL)
899 (device->controller->read_block_data)(device, oob, oob_size);
900 else
901 {
902 for (i = 0; i < oob_size;)
903 {
904 if (device->device->options & NAND_BUSWIDTH_16)
905 {
906 device->controller->read_data(device, oob);
907 oob += 2;
908 i += 2;
909 }
910 else
911 {
912 device->controller->read_data(device, oob);
913 oob += 1;
914 i += 1;
915 }
916 }
917 }
918 }
919
920 return ERROR_OK;
921 }
922
923 int nand_write_page_raw(struct nand_device_s *device, uint32_t page, uint8_t *data, uint32_t data_size, uint8_t *oob, uint32_t oob_size)
924 {
925 uint32_t i;
926 int retval;
927 uint8_t status;
928
929 if (!device->device)
930 return ERROR_NAND_DEVICE_NOT_PROBED;
931
932 device->controller->command(device, NAND_CMD_SEQIN);
933
934 if (device->page_size <= 512)
935 {
936 /* column (always 0, we start at the beginning of a page/OOB area) */
937 device->controller->address(device, 0x0);
938
939 /* row */
940 device->controller->address(device, page & 0xff);
941 device->controller->address(device, (page >> 8) & 0xff);
942
943 /* 4th cycle only on devices with more than 32 MiB */
944 if (device->address_cycles >= 4)
945 device->controller->address(device, (page >> 16) & 0xff);
946
947 /* 5th cycle only on devices with more than 8 GiB */
948 if (device->address_cycles >= 5)
949 device->controller->address(device, (page >> 24) & 0xff);
950 }
951 else
952 {
953 /* column (0 when we start at the beginning of a page,
954 * or 2048 for the beginning of OOB area)
955 */
956 device->controller->address(device, 0x0);
957 if (data)
958 device->controller->address(device, 0x0);
959 else
960 device->controller->address(device, 0x8);
961
962 /* row */
963 device->controller->address(device, page & 0xff);
964 device->controller->address(device, (page >> 8) & 0xff);
965
966 /* 5th cycle only on devices with more than 128 MiB */
967 if (device->address_cycles >= 5)
968 device->controller->address(device, (page >> 16) & 0xff);
969 }
970
971 if (data)
972 {
973 if (device->controller->write_block_data != NULL)
974 (device->controller->write_block_data)(device, data, data_size);
975 else
976 {
977 for (i = 0; i < data_size;)
978 {
979 if (device->device->options & NAND_BUSWIDTH_16)
980 {
981 uint16_t data_buf = le_to_h_u16(data);
982 device->controller->write_data(device, data_buf);
983 data += 2;
984 i += 2;
985 }
986 else
987 {
988 device->controller->write_data(device, *data);
989 data += 1;
990 i += 1;
991 }
992 }
993 }
994 }
995
996 if (oob)
997 {
998 if (device->controller->write_block_data != NULL)
999 (device->controller->write_block_data)(device, oob, oob_size);
1000 else
1001 {
1002 for (i = 0; i < oob_size;)
1003 {
1004 if (device->device->options & NAND_BUSWIDTH_16)
1005 {
1006 uint16_t oob_buf = le_to_h_u16(data);
1007 device->controller->write_data(device, oob_buf);
1008 oob += 2;
1009 i += 2;
1010 }
1011 else
1012 {
1013 device->controller->write_data(device, *oob);
1014 oob += 1;
1015 i += 1;
1016 }
1017 }
1018 }
1019 }
1020
1021 device->controller->command(device, NAND_CMD_PAGEPROG);
1022
1023 retval = device->controller->nand_ready ?
1024 device->controller->nand_ready(device, 100) :
1025 nand_poll_ready(device, 100);
1026 if (!retval)
1027 return ERROR_NAND_OPERATION_TIMEOUT;
1028
1029 if ((retval = nand_read_status(device, &status)) != ERROR_OK)
1030 {
1031 LOG_ERROR("couldn't read status");
1032 return ERROR_NAND_OPERATION_FAILED;
1033 }
1034
1035 if (status & NAND_STATUS_FAIL)
1036 {
1037 LOG_ERROR("write operation didn't pass, status: 0x%2.2x", status);
1038 return ERROR_NAND_OPERATION_FAILED;
1039 }
1040
1041 return ERROR_OK;
1042 }
1043
1044 int handle_nand_list_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1045 {
1046 nand_device_t *p;
1047 int i;
1048
1049 if (!nand_devices)
1050 {
1051 command_print(cmd_ctx, "no NAND flash devices configured");
1052 return ERROR_OK;
1053 }
1054
1055 for (p = nand_devices, i = 0; p; p = p->next, i++)
1056 {
1057 if (p->device)
1058 command_print(cmd_ctx, "#%i: %s (%s) "
1059 "pagesize: %i, buswidth: %i,\n\t"
1060 "blocksize: %i, blocks: %i",
1061 i, p->device->name, p->manufacturer->name,
1062 p->page_size, p->bus_width,
1063 p->erase_size, p->num_blocks);
1064 else
1065 command_print(cmd_ctx, "#%i: not probed", i);
1066 }
1067
1068 return ERROR_OK;
1069 }
1070
1071 static int handle_nand_info_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1072 {
1073 int i = 0;
1074 int j = 0;
1075 int first = -1;
1076 int last = -1;
1077
1078 nand_device_t *p;
1079 int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
1080 if (ERROR_OK != retval)
1081 return retval;
1082
1083 switch (argc) {
1084 default:
1085 return ERROR_COMMAND_SYNTAX_ERROR;
1086 case 1:
1087 first = 0;
1088 last = INT32_MAX;
1089 break;
1090 case 2:
1091 COMMAND_PARSE_NUMBER(int, args[1], i);
1092 first = last = i;
1093 i = 0;
1094 break;
1095 case 3:
1096 COMMAND_PARSE_NUMBER(int, args[1], first);
1097 COMMAND_PARSE_NUMBER(int, args[2], last);
1098 break;
1099 }
1100
1101 if (NULL == p->device)
1102 {
1103 command_print(cmd_ctx, "#%s: not probed", args[0]);
1104 return ERROR_OK;
1105 }
1106
1107 if (first >= p->num_blocks)
1108 first = p->num_blocks - 1;
1109
1110 if (last >= p->num_blocks)
1111 last = p->num_blocks - 1;
1112
1113 command_print(cmd_ctx, "#%i: %s (%s) pagesize: %i, buswidth: %i, erasesize: %i",
1114 i++, p->device->name, p->manufacturer->name, p->page_size, p->bus_width, p->erase_size);
1115
1116 for (j = first; j <= last; j++)
1117 {
1118 char *erase_state, *bad_state;
1119
1120 if (p->blocks[j].is_erased == 0)
1121 erase_state = "not erased";
1122 else if (p->blocks[j].is_erased == 1)
1123 erase_state = "erased";
1124 else
1125 erase_state = "erase state unknown";
1126
1127 if (p->blocks[j].is_bad == 0)
1128 bad_state = "";
1129 else if (p->blocks[j].is_bad == 1)
1130 bad_state = " (marked bad)";
1131 else
1132 bad_state = " (block condition unknown)";
1133
1134 command_print(cmd_ctx,
1135 "\t#%i: 0x%8.8" PRIx32 " (%" PRId32 "kB) %s%s",
1136 j,
1137 p->blocks[j].offset,
1138 p->blocks[j].size / 1024,
1139 erase_state,
1140 bad_state);
1141 }
1142
1143 return ERROR_OK;
1144 }
1145
1146 static int handle_nand_probe_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1147 {
1148 if (argc != 1)
1149 {
1150 return ERROR_COMMAND_SYNTAX_ERROR;
1151 }
1152
1153 nand_device_t *p;
1154 int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
1155 if (ERROR_OK != retval)
1156 return retval;
1157
1158 if ((retval = nand_probe(p)) == ERROR_OK)
1159 {
1160 command_print(cmd_ctx, "NAND flash device '%s' found", p->device->name);
1161 }
1162 else if (retval == ERROR_NAND_OPERATION_FAILED)
1163 {
1164 command_print(cmd_ctx, "probing failed for NAND flash device");
1165 }
1166 else
1167 {
1168 command_print(cmd_ctx, "unknown error when probing NAND flash device");
1169 }
1170
1171 return ERROR_OK;
1172 }
1173
1174 static int handle_nand_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1175 {
1176 if (argc != 1 && argc != 3)
1177 {
1178 return ERROR_COMMAND_SYNTAX_ERROR;
1179
1180 }
1181
1182 nand_device_t *p;
1183 int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
1184 if (ERROR_OK != retval)
1185 return retval;
1186
1187 unsigned long offset;
1188 unsigned long length;
1189
1190 /* erase specified part of the chip; or else everything */
1191 if (argc == 3) {
1192 unsigned long size = p->erase_size * p->num_blocks;
1193
1194 COMMAND_PARSE_NUMBER(ulong, args[1], offset);
1195 if ((offset % p->erase_size) != 0 || offset >= size)
1196 return ERROR_INVALID_ARGUMENTS;
1197
1198 COMMAND_PARSE_NUMBER(ulong, args[2], length);
1199 if ((length == 0) || (length % p->erase_size) != 0
1200 || (length + offset) > size)
1201 return ERROR_INVALID_ARGUMENTS;
1202
1203 offset /= p->erase_size;
1204 length /= p->erase_size;
1205 } else {
1206 offset = 0;
1207 length = p->num_blocks;
1208 }
1209
1210 retval = nand_erase(p, offset, offset + length - 1);
1211 if (retval == ERROR_OK)
1212 {
1213 command_print(cmd_ctx, "erased blocks %lu to %lu "
1214 "on NAND flash device #%s '%s'",
1215 offset, offset + length,
1216 args[0], p->device->name);
1217 }
1218 else if (retval == ERROR_NAND_OPERATION_FAILED)
1219 {
1220 command_print(cmd_ctx, "erase failed");
1221 }
1222 else
1223 {
1224 command_print(cmd_ctx, "unknown error when erasing NAND flash device");
1225 }
1226
1227 return ERROR_OK;
1228 }
1229
1230 int handle_nand_check_bad_blocks_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1231 {
1232 int first = -1;
1233 int last = -1;
1234
1235 if ((argc < 1) || (argc > 3) || (argc == 2))
1236 {
1237 return ERROR_COMMAND_SYNTAX_ERROR;
1238
1239 }
1240
1241 nand_device_t *p;
1242 int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
1243 if (ERROR_OK != retval)
1244 return retval;
1245
1246 if (argc == 3)
1247 {
1248 unsigned long offset;
1249 unsigned long length;
1250
1251 COMMAND_PARSE_NUMBER(ulong, args[1], offset);
1252 if (offset % p->erase_size)
1253 return ERROR_INVALID_ARGUMENTS;
1254 offset /= p->erase_size;
1255
1256 COMMAND_PARSE_NUMBER(ulong, args[2], length);
1257 if (length % p->erase_size)
1258 return ERROR_INVALID_ARGUMENTS;
1259
1260 length -= 1;
1261 length /= p->erase_size;
1262
1263 first = offset;
1264 last = offset + length;
1265 }
1266
1267 retval = nand_build_bbt(p, first, last);
1268 if (retval == ERROR_OK)
1269 {
1270 command_print(cmd_ctx, "checked NAND flash device for bad blocks, "
1271 "use \"nand info\" command to list blocks");
1272 }
1273 else if (retval == ERROR_NAND_OPERATION_FAILED)
1274 {
1275 command_print(cmd_ctx, "error when checking for bad blocks on "
1276 "NAND flash device");
1277 }
1278 else
1279 {
1280 command_print(cmd_ctx, "unknown error when checking for bad "
1281 "blocks on NAND flash device");
1282 }
1283
1284 return ERROR_OK;
1285 }
1286
1287 static int handle_nand_write_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1288 {
1289 uint32_t offset;
1290 uint32_t binary_size;
1291 uint32_t buf_cnt;
1292 enum oob_formats oob_format = NAND_OOB_NONE;
1293
1294 fileio_t fileio;
1295
1296
1297 if (argc < 3)
1298 {
1299 return ERROR_COMMAND_SYNTAX_ERROR;
1300 }
1301
1302 nand_device_t *p;
1303 int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
1304 if (ERROR_OK != retval)
1305 return retval;
1306
1307 uint8_t *page = NULL;
1308 uint32_t page_size = 0;
1309 uint8_t *oob = NULL;
1310 uint32_t oob_size = 0;
1311 const int *eccpos = NULL;
1312
1313 COMMAND_PARSE_NUMBER(u32, args[2], offset);
1314
1315 if (argc > 3)
1316 {
1317 int i;
1318 for (i = 3; i < argc; i++)
1319 {
1320 if (!strcmp(args[i], "oob_raw"))
1321 oob_format |= NAND_OOB_RAW;
1322 else if (!strcmp(args[i], "oob_only"))
1323 oob_format |= NAND_OOB_RAW | NAND_OOB_ONLY;
1324 else if (!strcmp(args[i], "oob_softecc"))
1325 oob_format |= NAND_OOB_SW_ECC;
1326 else if (!strcmp(args[i], "oob_softecc_kw"))
1327 oob_format |= NAND_OOB_SW_ECC_KW;
1328 else
1329 {
1330 command_print(cmd_ctx, "unknown option: %s", args[i]);
1331 return ERROR_COMMAND_SYNTAX_ERROR;
1332 }
1333 }
1334 }
1335
1336 struct duration bench;
1337 duration_start(&bench);
1338
1339 if (fileio_open(&fileio, args[1], FILEIO_READ, FILEIO_BINARY) != ERROR_OK)
1340 {
1341 return ERROR_OK;
1342 }
1343
1344 buf_cnt = binary_size = fileio.size;
1345
1346 if (!(oob_format & NAND_OOB_ONLY))
1347 {
1348 page_size = p->page_size;
1349 page = malloc(p->page_size);
1350 }
1351
1352 if (oob_format & (NAND_OOB_RAW | NAND_OOB_SW_ECC | NAND_OOB_SW_ECC_KW))
1353 {
1354 if (p->page_size == 512) {
1355 oob_size = 16;
1356 eccpos = nand_oob_16.eccpos;
1357 } else if (p->page_size == 2048) {
1358 oob_size = 64;
1359 eccpos = nand_oob_64.eccpos;
1360 }
1361 oob = malloc(oob_size);
1362 }
1363
1364 if (offset % p->page_size)
1365 {
1366 command_print(cmd_ctx, "only page size aligned offsets and sizes are supported");
1367 fileio_close(&fileio);
1368 free(oob);
1369 free(page);
1370 return ERROR_OK;
1371 }
1372
1373 while (buf_cnt > 0)
1374 {
1375 uint32_t size_read;
1376
1377 if (NULL != page)
1378 {
1379 fileio_read(&fileio, page_size, page, &size_read);
1380 buf_cnt -= size_read;
1381 if (size_read < page_size)
1382 {
1383 memset(page + size_read, 0xff, page_size - size_read);
1384 }
1385 }
1386
1387 if (oob_format & NAND_OOB_SW_ECC)
1388 {
1389 uint32_t i, j;
1390 uint8_t ecc[3];
1391 memset(oob, 0xff, oob_size);
1392 for (i = 0, j = 0; i < page_size; i += 256) {
1393 nand_calculate_ecc(p, page + i, ecc);
1394 oob[eccpos[j++]] = ecc[0];
1395 oob[eccpos[j++]] = ecc[1];
1396 oob[eccpos[j++]] = ecc[2];
1397 }
1398 } else if (oob_format & NAND_OOB_SW_ECC_KW)
1399 {
1400 /*
1401 * In this case eccpos is not used as
1402 * the ECC data is always stored contigously
1403 * at the end of the OOB area. It consists
1404 * of 10 bytes per 512-byte data block.
1405 */
1406 uint32_t i;
1407 uint8_t *ecc = oob + oob_size - page_size/512 * 10;
1408 memset(oob, 0xff, oob_size);
1409 for (i = 0; i < page_size; i += 512) {
1410 nand_calculate_ecc_kw(p, page + i, ecc);
1411 ecc += 10;
1412 }
1413 }
1414 else if (NULL != oob)
1415 {
1416 fileio_read(&fileio, oob_size, oob, &size_read);
1417 buf_cnt -= size_read;
1418 if (size_read < oob_size)
1419 {
1420 memset(oob + size_read, 0xff, oob_size - size_read);
1421 }
1422 }
1423
1424 if (nand_write_page(p, offset / p->page_size, page, page_size, oob, oob_size) != ERROR_OK)
1425 {
1426 command_print(cmd_ctx, "failed writing file %s to NAND flash %s at offset 0x%8.8" PRIx32 "",
1427 args[1], args[0], offset);
1428
1429 fileio_close(&fileio);
1430 free(oob);
1431 free(page);
1432
1433 return ERROR_OK;
1434 }
1435 offset += page_size;
1436 }
1437
1438 fileio_close(&fileio);
1439 free(oob);
1440 free(page);
1441 oob = NULL;
1442 page = NULL;
1443 if (duration_measure(&bench) == ERROR_OK)
1444 {
1445 command_print(cmd_ctx, "wrote file %s to NAND flash %s "
1446 "up to offset 0x%8.8" PRIx32 " in %fs (%0.3f kb/s)",
1447 args[1], args[0], offset, duration_elapsed(&bench),
1448 duration_kbps(&bench, fileio.size));
1449 }
1450
1451 return ERROR_OK;
1452 }
1453
1454 static int handle_nand_dump_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1455 {
1456 if (argc < 4)
1457 {
1458 return ERROR_COMMAND_SYNTAX_ERROR;
1459 }
1460
1461 nand_device_t *p;
1462 int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
1463 if (ERROR_OK != retval)
1464 return retval;
1465
1466 if (NULL == p->device)
1467 {
1468 command_print(cmd_ctx, "#%s: not probed", args[0]);
1469 return ERROR_OK;
1470 }
1471
1472 fileio_t fileio;
1473
1474 uint8_t *page = NULL;
1475 uint32_t page_size = 0;
1476 uint8_t *oob = NULL;
1477 uint32_t oob_size = 0;
1478 uint32_t address;
1479 COMMAND_PARSE_NUMBER(u32, args[2], address);
1480 uint32_t size;
1481 COMMAND_PARSE_NUMBER(u32, args[3], size);
1482 uint32_t bytes_done = 0;
1483 enum oob_formats oob_format = NAND_OOB_NONE;
1484
1485 if (argc > 4)
1486 {
1487 int i;
1488 for (i = 4; i < argc; i++)
1489 {
1490 if (!strcmp(args[i], "oob_raw"))
1491 oob_format |= NAND_OOB_RAW;
1492 else if (!strcmp(args[i], "oob_only"))
1493 oob_format |= NAND_OOB_RAW | NAND_OOB_ONLY;
1494 else
1495 command_print(cmd_ctx, "unknown option: '%s'", args[i]);
1496 }
1497 }
1498
1499 if ((address % p->page_size) || (size % p->page_size))
1500 {
1501 command_print(cmd_ctx, "only page size aligned addresses and sizes are supported");
1502 return ERROR_OK;
1503 }
1504
1505 if (!(oob_format & NAND_OOB_ONLY))
1506 {
1507 page_size = p->page_size;
1508 page = malloc(p->page_size);
1509 }
1510
1511 if (oob_format & NAND_OOB_RAW)
1512 {
1513 if (p->page_size == 512)
1514 oob_size = 16;
1515 else if (p->page_size == 2048)
1516 oob_size = 64;
1517 oob = malloc(oob_size);
1518 }
1519
1520 if (fileio_open(&fileio, args[1], FILEIO_WRITE, FILEIO_BINARY) != ERROR_OK)
1521 {
1522 return ERROR_OK;
1523 }
1524
1525 struct duration bench;
1526 duration_start(&bench);
1527
1528 while (size > 0)
1529 {
1530 uint32_t size_written;
1531 if ((retval = nand_read_page(p, address / p->page_size, page, page_size, oob, oob_size)) != ERROR_OK)
1532 {
1533 command_print(cmd_ctx, "reading NAND flash page failed");
1534 free(page);
1535 free(oob);
1536 fileio_close(&fileio);
1537 return ERROR_OK;
1538 }
1539
1540 if (NULL != page)
1541 {
1542 fileio_write(&fileio, page_size, page, &size_written);
1543 bytes_done += page_size;
1544 }
1545
1546 if (NULL != oob)
1547 {
1548 fileio_write(&fileio, oob_size, oob, &size_written);
1549 bytes_done += oob_size;
1550 }
1551
1552 size -= p->page_size;
1553 address += p->page_size;
1554 }
1555
1556 free(page);
1557 page = NULL;
1558 free(oob);
1559 oob = NULL;
1560 fileio_close(&fileio);
1561
1562 if (duration_measure(&bench) == ERROR_OK)
1563 {
1564 command_print(cmd_ctx, "dumped %lld byte in %fs (%0.3f kb/s)",
1565 fileio.size, duration_elapsed(&bench),
1566 duration_kbps(&bench, fileio.size));
1567 }
1568
1569 return ERROR_OK;
1570 }
1571
1572 static int handle_nand_raw_access_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1573 {
1574 if ((argc < 1) || (argc > 2))
1575 {
1576 return ERROR_COMMAND_SYNTAX_ERROR;
1577 }
1578
1579 nand_device_t *p;
1580 int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
1581 if (ERROR_OK != retval)
1582 return retval;
1583
1584 if (NULL == p->device)
1585 {
1586 command_print(cmd_ctx, "#%s: not probed", args[0]);
1587 return ERROR_OK;
1588 }
1589
1590 if (argc == 2)
1591 {
1592 if (strcmp("enable", args[1]) == 0)
1593 p->use_raw = 1;
1594 else if (strcmp("disable", args[1]) == 0)
1595 p->use_raw = 0;
1596 else
1597 return ERROR_COMMAND_SYNTAX_ERROR;
1598 }
1599
1600 const char *msg = p->use_raw ? "enabled" : "disabled";
1601 command_print(cmd_ctx, "raw access is %s", msg);
1602
1603 return ERROR_OK;
1604 }
1605
1606 int nand_init(struct command_context_s *cmd_ctx)
1607 {
1608 if (!nand_devices)
1609 return ERROR_OK;
1610
1611 register_command(cmd_ctx, nand_cmd, "list",
1612 handle_nand_list_command, COMMAND_EXEC,
1613 "list configured NAND flash devices");
1614 register_command(cmd_ctx, nand_cmd, "info",
1615 handle_nand_info_command, COMMAND_EXEC,
1616 "print info about NAND flash device <num>");
1617 register_command(cmd_ctx, nand_cmd, "probe",
1618 handle_nand_probe_command, COMMAND_EXEC,
1619 "identify NAND flash device <num>");
1620
1621 register_command(cmd_ctx, nand_cmd, "check_bad_blocks",
1622 handle_nand_check_bad_blocks_command, COMMAND_EXEC,
1623 "check NAND flash device <num> for bad blocks [<offset> <length>]");
1624 register_command(cmd_ctx, nand_cmd, "erase",
1625 handle_nand_erase_command, COMMAND_EXEC,
1626 "erase blocks on NAND flash device <num> [<offset> <length>]");
1627 register_command(cmd_ctx, nand_cmd, "dump",
1628 handle_nand_dump_command, COMMAND_EXEC,
1629 "dump from NAND flash device <num> <filename> "
1630 "<offset> <length> [oob_raw | oob_only]");
1631 register_command(cmd_ctx, nand_cmd, "write",
1632 handle_nand_write_command, COMMAND_EXEC,
1633 "write to NAND flash device <num> <filename> <offset> "
1634 "[oob_raw | oob_only | oob_softecc | oob_softecc_kw]");
1635
1636 register_command(cmd_ctx, nand_cmd, "raw_access",
1637 handle_nand_raw_access_command, COMMAND_EXEC,
1638 "raw access to NAND flash device <num> ['enable'|'disable']");
1639
1640 return ERROR_OK;
1641 }