- updated docs for ft2232_vid_pid command
[openocd.git] / src / flash / nand.c
blob4d355cf18b55365923bd52b2d67526f0eccbacae
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
27 #include "replacements.h"
28 #include "log.h"
30 #include <stdlib.h>
31 #include <string.h>
32 #include <inttypes.h>
34 #include <errno.h>
36 #include "nand.h"
37 #include "flash.h"
38 #include "time_support.h"
39 #include "fileio.h"
40 #include "image.h"
42 int nand_register_commands(struct command_context_s *cmd_ctx);
43 int handle_nand_list_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
44 int handle_nand_probe_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
45 int handle_nand_check_bad_blocks_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
46 int handle_nand_info_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
47 int handle_nand_copy_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
48 int handle_nand_write_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
49 int handle_nand_dump_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
50 int handle_nand_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
52 int handle_nand_raw_access_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
54 int nand_read_page_raw(struct nand_device_s *device, u32 page, u8 *data, u32 data_size, u8 *oob, u32 oob_size);
55 int nand_read_page(struct nand_device_s *device, u32 page, u8 *data, u32 data_size, u8 *oob, u32 oob_size);
56 int nand_read_plain(struct nand_device_s *device, u32 address, u8 *data, u32 data_size);
58 int nand_write_page_raw(struct nand_device_s *device, u32 page, u8 *data, u32 data_size, u8 *oob, u32 oob_size);
59 int nand_write_page(struct nand_device_s *device, u32 page, u8 *data, u32 data_size, u8 *oob, u32 oob_size);
61 /* NAND flash controller
63 extern nand_flash_controller_t lpc3180_nand_controller;
64 extern nand_flash_controller_t s3c2410_nand_controller;
65 extern nand_flash_controller_t s3c2412_nand_controller;
66 extern nand_flash_controller_t s3c2440_nand_controller;
67 extern nand_flash_controller_t s3c2443_nand_controller;
69 /* extern nand_flash_controller_t boundary_scan_nand_controller; */
71 nand_flash_controller_t *nand_flash_controllers[] =
73 &lpc3180_nand_controller,
74 &s3c2410_nand_controller,
75 &s3c2412_nand_controller,
76 &s3c2440_nand_controller,
77 &s3c2443_nand_controller,
78 /* &boundary_scan_nand_controller, */
79 NULL
82 /* configured NAND devices and NAND Flash command handler */
83 nand_device_t *nand_devices = NULL;
84 static command_t *nand_cmd;
86 /* Chip ID list
88 * Name, ID code, pagesize, chipsize in MegaByte, eraseblock size,
89 * options
91 * Pagesize; 0, 256, 512
92 * 0 get this information from the extended chip ID
93 * 256 256 Byte page size
94 * 512 512 Byte page size
96 nand_info_t nand_flash_ids[] =
98 {"NAND 1MiB 5V 8-bit", 0x6e, 256, 1, 0x1000, 0},
99 {"NAND 2MiB 5V 8-bit", 0x64, 256, 2, 0x1000, 0},
100 {"NAND 4MiB 5V 8-bit", 0x6b, 512, 4, 0x2000, 0},
101 {"NAND 1MiB 3,3V 8-bit", 0xe8, 256, 1, 0x1000, 0},
102 {"NAND 1MiB 3,3V 8-bit", 0xec, 256, 1, 0x1000, 0},
103 {"NAND 2MiB 3,3V 8-bit", 0xea, 256, 2, 0x1000, 0},
104 {"NAND 4MiB 3,3V 8-bit", 0xd5, 512, 4, 0x2000, 0},
105 {"NAND 4MiB 3,3V 8-bit", 0xe3, 512, 4, 0x2000, 0},
106 {"NAND 4MiB 3,3V 8-bit", 0xe5, 512, 4, 0x2000, 0},
107 {"NAND 8MiB 3,3V 8-bit", 0xd6, 512, 8, 0x2000, 0},
109 {"NAND 8MiB 1,8V 8-bit", 0x39, 512, 8, 0x2000, 0},
110 {"NAND 8MiB 3,3V 8-bit", 0xe6, 512, 8, 0x2000, 0},
111 {"NAND 8MiB 1,8V 16-bit", 0x49, 512, 8, 0x2000, NAND_BUSWIDTH_16},
112 {"NAND 8MiB 3,3V 16-bit", 0x59, 512, 8, 0x2000, NAND_BUSWIDTH_16},
114 {"NAND 16MiB 1,8V 8-bit", 0x33, 512, 16, 0x4000, 0},
115 {"NAND 16MiB 3,3V 8-bit", 0x73, 512, 16, 0x4000, 0},
116 {"NAND 16MiB 1,8V 16-bit", 0x43, 512, 16, 0x4000, NAND_BUSWIDTH_16},
117 {"NAND 16MiB 3,3V 16-bit", 0x53, 512, 16, 0x4000, NAND_BUSWIDTH_16},
119 {"NAND 32MiB 1,8V 8-bit", 0x35, 512, 32, 0x4000, 0},
120 {"NAND 32MiB 3,3V 8-bit", 0x75, 512, 32, 0x4000, 0},
121 {"NAND 32MiB 1,8V 16-bit", 0x45, 512, 32, 0x4000, NAND_BUSWIDTH_16},
122 {"NAND 32MiB 3,3V 16-bit", 0x55, 512, 32, 0x4000, NAND_BUSWIDTH_16},
124 {"NAND 64MiB 1,8V 8-bit", 0x36, 512, 64, 0x4000, 0},
125 {"NAND 64MiB 3,3V 8-bit", 0x76, 512, 64, 0x4000, 0},
126 {"NAND 64MiB 1,8V 16-bit", 0x46, 512, 64, 0x4000, NAND_BUSWIDTH_16},
127 {"NAND 64MiB 3,3V 16-bit", 0x56, 512, 64, 0x4000, NAND_BUSWIDTH_16},
129 {"NAND 128MiB 1,8V 8-bit", 0x78, 512, 128, 0x4000, 0},
130 {"NAND 128MiB 1,8V 8-bit", 0x39, 512, 128, 0x4000, 0},
131 {"NAND 128MiB 3,3V 8-bit", 0x79, 512, 128, 0x4000, 0},
132 {"NAND 128MiB 1,8V 16-bit", 0x72, 512, 128, 0x4000, NAND_BUSWIDTH_16},
133 {"NAND 128MiB 1,8V 16-bit", 0x49, 512, 128, 0x4000, NAND_BUSWIDTH_16},
134 {"NAND 128MiB 3,3V 16-bit", 0x74, 512, 128, 0x4000, NAND_BUSWIDTH_16},
135 {"NAND 128MiB 3,3V 16-bit", 0x59, 512, 128, 0x4000, NAND_BUSWIDTH_16},
137 {"NAND 256MiB 3,3V 8-bit", 0x71, 512, 256, 0x4000, 0},
139 {"NAND 64MiB 1,8V 8-bit", 0xA2, 0, 64, 0, LP_OPTIONS},
140 {"NAND 64MiB 3,3V 8-bit", 0xF2, 0, 64, 0, LP_OPTIONS},
141 {"NAND 64MiB 1,8V 16-bit", 0xB2, 0, 64, 0, LP_OPTIONS16},
142 {"NAND 64MiB 3,3V 16-bit", 0xC2, 0, 64, 0, LP_OPTIONS16},
144 {"NAND 128MiB 1,8V 8-bit", 0xA1, 0, 128, 0, LP_OPTIONS},
145 {"NAND 128MiB 3,3V 8-bit", 0xF1, 0, 128, 0, LP_OPTIONS},
146 {"NAND 128MiB 1,8V 16-bit", 0xB1, 0, 128, 0, LP_OPTIONS16},
147 {"NAND 128MiB 3,3V 16-bit", 0xC1, 0, 128, 0, LP_OPTIONS16},
149 {"NAND 256MiB 1,8V 8-bit", 0xAA, 0, 256, 0, LP_OPTIONS},
150 {"NAND 256MiB 3,3V 8-bit", 0xDA, 0, 256, 0, LP_OPTIONS},
151 {"NAND 256MiB 1,8V 16-bit", 0xBA, 0, 256, 0, LP_OPTIONS16},
152 {"NAND 256MiB 3,3V 16-bit", 0xCA, 0, 256, 0, LP_OPTIONS16},
154 {"NAND 512MiB 1,8V 8-bit", 0xAC, 0, 512, 0, LP_OPTIONS},
155 {"NAND 512MiB 3,3V 8-bit", 0xDC, 0, 512, 0, LP_OPTIONS},
156 {"NAND 512MiB 1,8V 16-bit", 0xBC, 0, 512, 0, LP_OPTIONS16},
157 {"NAND 512MiB 3,3V 16-bit", 0xCC, 0, 512, 0, LP_OPTIONS16},
159 {"NAND 1GiB 1,8V 8-bit", 0xA3, 0, 1024, 0, LP_OPTIONS},
160 {"NAND 1GiB 3,3V 8-bit", 0xD3, 0, 1024, 0, LP_OPTIONS},
161 {"NAND 1GiB 1,8V 16-bit", 0xB3, 0, 1024, 0, LP_OPTIONS16},
162 {"NAND 1GiB 3,3V 16-bit", 0xC3, 0, 1024, 0, LP_OPTIONS16},
164 {"NAND 2GiB 1,8V 8-bit", 0xA5, 0, 2048, 0, LP_OPTIONS},
165 {"NAND 2GiB 3,3V 8-bit", 0xD5, 0, 2048, 0, LP_OPTIONS},
166 {"NAND 2GiB 1,8V 16-bit", 0xB5, 0, 2048, 0, LP_OPTIONS16},
167 {"NAND 2GiB 3,3V 16-bit", 0xC5, 0, 2048, 0, LP_OPTIONS16},
169 {NULL, 0,}
172 /* Manufacturer ID list
174 nand_manufacturer_t nand_manuf_ids[] =
176 {0x0, "unknown"},
177 {NAND_MFR_TOSHIBA, "Toshiba"},
178 {NAND_MFR_SAMSUNG, "Samsung"},
179 {NAND_MFR_FUJITSU, "Fujitsu"},
180 {NAND_MFR_NATIONAL, "National"},
181 {NAND_MFR_RENESAS, "Renesas"},
182 {NAND_MFR_STMICRO, "ST Micro"},
183 {NAND_MFR_HYNIX, "Hynix"},
184 {0x0, NULL},
187 /* nand device <nand_controller> [controller options]
189 int handle_nand_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
191 int i;
192 int retval;
194 if (argc < 1)
196 LOG_WARNING("incomplete flash device nand configuration");
197 return ERROR_FLASH_BANK_INVALID;
200 for (i = 0; nand_flash_controllers[i]; i++)
202 nand_device_t *p, *c;
204 if (strcmp(args[0], nand_flash_controllers[i]->name) == 0)
206 /* register flash specific commands */
207 if (nand_flash_controllers[i]->register_commands(cmd_ctx) != ERROR_OK)
209 LOG_ERROR("couldn't register '%s' commands", args[0]);
210 exit(-1);
213 c = malloc(sizeof(nand_device_t));
215 c->controller = nand_flash_controllers[i];
216 c->controller_priv = NULL;
217 c->manufacturer = NULL;
218 c->device = NULL;
219 c->bus_width = 0;
220 c->address_cycles = 0;
221 c->page_size = 0;
222 c->use_raw = 0;
223 c->next = NULL;
225 if ((retval = nand_flash_controllers[i]->nand_device_command(cmd_ctx, cmd, args, argc, c)) != ERROR_OK)
227 LOG_ERROR("'%s' driver rejected nand flash", c->controller->name);
228 free(c);
229 return ERROR_OK;
232 /* put NAND device in linked list */
233 if (nand_devices)
235 /* find last flash device */
236 for (p = nand_devices; p && p->next; p = p->next);
237 if (p)
238 p->next = c;
240 else
242 nand_devices = c;
245 return ERROR_OK;
249 /* no valid NAND controller was found (i.e. the configuration option,
250 * didn't match one of the compiled-in controllers)
252 LOG_ERROR("No valid NAND flash controller found (%s)", args[0]);
253 LOG_ERROR("compiled-in NAND flash controllers:");
254 for (i = 0; nand_flash_controllers[i]; i++)
256 LOG_ERROR("%i: %s", i, nand_flash_controllers[i]->name);
259 return ERROR_OK;
262 int nand_register_commands(struct command_context_s *cmd_ctx)
264 nand_cmd = register_command(cmd_ctx, NULL, "nand", NULL, COMMAND_ANY, "NAND specific commands");
266 register_command(cmd_ctx, nand_cmd, "device", handle_nand_device_command, COMMAND_CONFIG, NULL);
268 return ERROR_OK;
271 int nand_init(struct command_context_s *cmd_ctx)
273 if (nand_devices)
275 register_command(cmd_ctx, nand_cmd, "list", handle_nand_list_command, COMMAND_EXEC,
276 "list configured NAND flash devices");
277 register_command(cmd_ctx, nand_cmd, "info", handle_nand_info_command, COMMAND_EXEC,
278 "print info about NAND flash device <num>");
279 register_command(cmd_ctx, nand_cmd, "probe", handle_nand_probe_command, COMMAND_EXEC,
280 "identify NAND flash device <num>");
281 register_command(cmd_ctx, nand_cmd, "check_bad_blocks", handle_nand_check_bad_blocks_command, COMMAND_EXEC,
282 "check NAND flash device <num> for bad blocks [<first> <last>]");
283 register_command(cmd_ctx, nand_cmd, "erase", handle_nand_erase_command, COMMAND_EXEC,
284 "erase blocks on NAND flash device <num> <first> <last>");
285 register_command(cmd_ctx, nand_cmd, "copy", handle_nand_copy_command, COMMAND_EXEC,
286 "copy from NAND flash device <num> <offset> <length> <ram-address>");
287 register_command(cmd_ctx, nand_cmd, "dump", handle_nand_dump_command, COMMAND_EXEC,
288 "dump from NAND flash device <num> <filename> <offset> <size> [options]");
289 register_command(cmd_ctx, nand_cmd, "write", handle_nand_write_command, COMMAND_EXEC,
290 "write to NAND flash device <num> <filename> <offset> [options]");
291 register_command(cmd_ctx, nand_cmd, "raw_access", handle_nand_raw_access_command, COMMAND_EXEC,
292 "raw access to NAND flash device <num> ['enable'|'disable']");
295 return ERROR_OK;
298 nand_device_t *get_nand_device_by_num(int num)
300 nand_device_t *p;
301 int i = 0;
303 for (p = nand_devices; p; p = p->next)
305 if (i++ == num)
307 return p;
311 return NULL;
314 int nand_build_bbt(struct nand_device_s *device, int first, int last)
316 u32 page = 0x0;
317 int i;
318 u8 *oob;
320 oob = malloc(6);
322 if ((first < 0) || (first >= device->num_blocks))
323 first = 0;
325 if ((last >= device->num_blocks) || (last == -1))
326 last = device->num_blocks - 1;
328 for (i = first; i < last; i++)
330 nand_read_page(device, page, NULL, 0, oob, 6);
332 if (((device->device->options & NAND_BUSWIDTH_16) && ((oob[0] & oob[1]) != 0xff))
333 || (((device->page_size == 512) && (oob[5] != 0xff)) ||
334 ((device->page_size == 2048) && (oob[0] != 0xff))))
336 LOG_WARNING("invalid block: %i", i);
337 device->blocks[i].is_bad = 1;
339 else
341 device->blocks[i].is_bad = 0;
344 page += (device->erase_size / device->page_size);
347 return ERROR_OK;
350 int nand_read_status(struct nand_device_s *device, u8 *status)
352 if (!device->device)
353 return ERROR_NAND_DEVICE_NOT_PROBED;
355 /* Send read status command */
356 device->controller->command(device, NAND_CMD_STATUS);
358 usleep(1000);
360 /* read status */
361 if (device->device->options & NAND_BUSWIDTH_16)
363 u16 data;
364 device->controller->read_data(device, &data);
365 *status = data & 0xff;
367 else
369 device->controller->read_data(device, status);
372 return ERROR_OK;
375 int nand_probe(struct nand_device_s *device)
377 u8 manufacturer_id, device_id;
378 u8 id_buff[5];
379 int retval;
380 int i;
382 /* clear device data */
383 device->device = NULL;
384 device->manufacturer = NULL;
386 /* clear device parameters */
387 device->bus_width = 0;
388 device->address_cycles = 0;
389 device->page_size = 0;
390 device->erase_size = 0;
392 /* initialize controller (device parameters are zero, use controller default) */
393 if ((retval = device->controller->init(device) != ERROR_OK))
395 switch (retval)
397 case ERROR_NAND_OPERATION_FAILED:
398 LOG_DEBUG("controller initialization failed");
399 return ERROR_NAND_OPERATION_FAILED;
400 case ERROR_NAND_OPERATION_NOT_SUPPORTED:
401 LOG_ERROR("BUG: controller reported that it doesn't support default parameters");
402 return ERROR_NAND_OPERATION_FAILED;
403 default:
404 LOG_ERROR("BUG: unknown controller initialization failure");
405 return ERROR_NAND_OPERATION_FAILED;
409 device->controller->command(device, NAND_CMD_RESET);
410 device->controller->reset(device);
412 device->controller->command(device, NAND_CMD_READID);
413 device->controller->address(device, 0x0);
415 if (device->bus_width == 8)
417 device->controller->read_data(device, &manufacturer_id);
418 device->controller->read_data(device, &device_id);
420 else
422 u16 data_buf;
423 device->controller->read_data(device, &data_buf);
424 manufacturer_id = data_buf & 0xff;
425 device->controller->read_data(device, &data_buf);
426 device_id = data_buf & 0xff;
429 for (i = 0; nand_flash_ids[i].name; i++)
431 if (nand_flash_ids[i].id == device_id)
433 device->device = &nand_flash_ids[i];
434 break;
438 for (i = 0; nand_manuf_ids[i].name; i++)
440 if (nand_manuf_ids[i].id == manufacturer_id)
442 device->manufacturer = &nand_manuf_ids[i];
443 break;
447 if (!device->manufacturer)
449 device->manufacturer = &nand_manuf_ids[0];
450 device->manufacturer->id = manufacturer_id;
453 if (!device->device)
455 LOG_ERROR("unknown NAND flash device found, manufacturer id: 0x%2.2x device id: 0x%2.2x",
456 manufacturer_id, device_id);
457 return ERROR_NAND_OPERATION_FAILED;
460 LOG_DEBUG("found %s (%s)", device->device->name, device->manufacturer->name);
462 /* initialize device parameters */
464 /* bus width */
465 if (device->device->options & NAND_BUSWIDTH_16)
466 device->bus_width = 16;
467 else
468 device->bus_width = 8;
470 /* Do we need extended device probe information? */
471 if (device->device->page_size == 0 ||
472 device->device->erase_size == 0)
474 if (device->bus_width == 8)
476 device->controller->read_data(device, id_buff+3);
477 device->controller->read_data(device, id_buff+4);
478 device->controller->read_data(device, id_buff+5);
480 else
482 u16 data_buf;
484 device->controller->read_data(device, &data_buf);
485 id_buff[3] = data_buf;
487 device->controller->read_data(device, &data_buf);
488 id_buff[4] = data_buf;
490 device->controller->read_data(device, &data_buf);
491 id_buff[5] = data_buf >> 8;
495 /* page size */
496 if (device->device->page_size == 0)
498 device->page_size = 1 << (10 + (id_buff[4] & 3));
500 else if (device->device->page_size == 256)
502 LOG_ERROR("NAND flashes with 256 byte pagesize are not supported");
503 return ERROR_NAND_OPERATION_FAILED;
505 else
507 device->page_size = device->device->page_size;
510 /* number of address cycles */
511 if (device->page_size <= 512)
513 /* small page devices */
514 if (device->device->chip_size <= 32)
515 device->address_cycles = 3;
516 else if (device->device->chip_size <= 8*1024)
517 device->address_cycles = 4;
518 else
520 LOG_ERROR("BUG: small page NAND device with more than 8 GiB encountered");
521 device->address_cycles = 5;
524 else
526 /* large page devices */
527 if (device->device->chip_size <= 128)
528 device->address_cycles = 4;
529 else if (device->device->chip_size <= 32*1024)
530 device->address_cycles = 5;
531 else
533 LOG_ERROR("BUG: small page NAND device with more than 32 GiB encountered");
534 device->address_cycles = 6;
538 /* erase size */
539 if (device->device->erase_size == 0)
541 switch ((id_buff[4] >> 4) & 3) {
542 case 0:
543 device->erase_size = 64 << 10;
544 break;
545 case 1:
546 device->erase_size = 128 << 10;
547 break;
548 case 2:
549 device->erase_size = 256 << 10;
550 break;
551 case 3:
552 device->erase_size =512 << 10;
553 break;
556 else
558 device->erase_size = device->device->erase_size;
561 /* initialize controller, but leave parameters at the controllers default */
562 if ((retval = device->controller->init(device) != ERROR_OK))
564 switch (retval)
566 case ERROR_NAND_OPERATION_FAILED:
567 LOG_DEBUG("controller initialization failed");
568 return ERROR_NAND_OPERATION_FAILED;
569 case ERROR_NAND_OPERATION_NOT_SUPPORTED:
570 LOG_ERROR("controller doesn't support requested parameters (buswidth: %i, address cycles: %i, page size: %i)",
571 device->bus_width, device->address_cycles, device->page_size);
572 return ERROR_NAND_OPERATION_FAILED;
573 default:
574 LOG_ERROR("BUG: unknown controller initialization failure");
575 return ERROR_NAND_OPERATION_FAILED;
579 device->num_blocks = (device->device->chip_size * 1024) / (device->erase_size / 1024);
580 device->blocks = malloc(sizeof(nand_block_t) * device->num_blocks);
582 for (i = 0; i < device->num_blocks; i++)
584 device->blocks[i].size = device->erase_size;
585 device->blocks[i].offset = i * device->erase_size;
586 device->blocks[i].is_erased = -1;
587 device->blocks[i].is_bad = -1;
590 return ERROR_OK;
593 int nand_erase(struct nand_device_s *device, int first_block, int last_block)
595 int i;
596 u32 page;
597 u8 status;
598 int retval;
600 if (!device->device)
601 return ERROR_NAND_DEVICE_NOT_PROBED;
603 if ((first_block < 0) || (last_block > device->num_blocks))
604 return ERROR_INVALID_ARGUMENTS;
606 /* make sure we know if a block is bad before erasing it */
607 for (i = first_block; i <= last_block; i++)
609 if (device->blocks[i].is_bad == -1)
611 nand_build_bbt(device, i, last_block);
612 break;
616 for (i = first_block; i <= last_block; i++)
618 /* Send erase setup command */
619 device->controller->command(device, NAND_CMD_ERASE1);
621 page = i * (device->erase_size / device->page_size);
623 /* Send page address */
624 if (device->page_size <= 512)
626 /* row */
627 device->controller->address(device, page & 0xff);
628 device->controller->address(device, (page >> 8) & 0xff);
630 /* 3rd cycle only on devices with more than 32 MiB */
631 if (device->address_cycles >= 4)
632 device->controller->address(device, (page >> 16) & 0xff);
634 /* 4th cycle only on devices with more than 8 GiB */
635 if (device->address_cycles >= 5)
636 device->controller->address(device, (page >> 24) & 0xff);
638 else
640 /* row */
641 device->controller->address(device, page & 0xff);
642 device->controller->address(device, (page >> 8) & 0xff);
644 /* 3rd cycle only on devices with more than 128 MiB */
645 if (device->address_cycles >= 5)
646 device->controller->address(device, (page >> 16) & 0xff);
649 /* Send erase confirm command */
650 device->controller->command(device, NAND_CMD_ERASE2);
652 if (!device->controller->nand_ready(device, 1000))
654 LOG_ERROR("timeout waiting for NAND flash block erase to complete");
655 return ERROR_NAND_OPERATION_TIMEOUT;
658 if ((retval = nand_read_status(device, &status)) != ERROR_OK)
660 LOG_ERROR("couldn't read status");
661 return ERROR_NAND_OPERATION_FAILED;
664 if (status & 0x1)
666 LOG_ERROR("erase operation didn't pass, status: 0x%2.2x", status);
667 return ERROR_NAND_OPERATION_FAILED;
671 return ERROR_OK;
674 int nand_read_plain(struct nand_device_s *device, u32 address, u8 *data, u32 data_size)
676 u8 *page;
678 if (!device->device)
679 return ERROR_NAND_DEVICE_NOT_PROBED;
681 if (address % device->page_size)
683 LOG_ERROR("reads need to be page aligned");
684 return ERROR_NAND_OPERATION_FAILED;
687 page = malloc(device->page_size);
689 while (data_size > 0 )
691 u32 thisrun_size = (data_size > device->page_size) ? device->page_size : data_size;
692 u32 page_address;
695 page_address = address / device->page_size;
697 nand_read_page(device, page_address, page, device->page_size, NULL, 0);
699 memcpy(data, page, thisrun_size);
701 address += thisrun_size;
702 data += thisrun_size;
703 data_size -= thisrun_size;
706 free(page);
708 return ERROR_OK;
711 int nand_write_plain(struct nand_device_s *device, u32 address, u8 *data, u32 data_size)
713 u8 *page;
715 if (!device->device)
716 return ERROR_NAND_DEVICE_NOT_PROBED;
718 if (address % device->page_size)
720 LOG_ERROR("writes need to be page aligned");
721 return ERROR_NAND_OPERATION_FAILED;
724 page = malloc(device->page_size);
726 while (data_size > 0 )
728 u32 thisrun_size = (data_size > device->page_size) ? device->page_size : data_size;
729 u32 page_address;
731 memset(page, 0xff, device->page_size);
732 memcpy(page, data, thisrun_size);
734 page_address = address / device->page_size;
736 nand_write_page(device, page_address, page, device->page_size, NULL, 0);
738 address += thisrun_size;
739 data += thisrun_size;
740 data_size -= thisrun_size;
743 free(page);
745 return ERROR_OK;
748 int nand_write_page(struct nand_device_s *device, u32 page, u8 *data, u32 data_size, u8 *oob, u32 oob_size)
750 if (!device->device)
751 return ERROR_NAND_DEVICE_NOT_PROBED;
753 if (device->use_raw || device->controller->write_page == NULL)
754 return nand_write_page_raw(device, page, data, data_size, oob, oob_size);
755 else
756 return device->controller->write_page(device, page, data, data_size, oob, oob_size);
759 int nand_read_page(struct nand_device_s *device, u32 page, u8 *data, u32 data_size, u8 *oob, u32 oob_size)
761 if (!device->device)
762 return ERROR_NAND_DEVICE_NOT_PROBED;
764 if (device->use_raw || device->controller->read_page == NULL)
765 return nand_read_page_raw(device, page, data, data_size, oob, oob_size);
766 else
767 return device->controller->read_page(device, page, data, data_size, oob, oob_size);
770 int nand_read_page_raw(struct nand_device_s *device, u32 page, u8 *data, u32 data_size, u8 *oob, u32 oob_size)
772 int i;
774 if (!device->device)
775 return ERROR_NAND_DEVICE_NOT_PROBED;
777 if (device->page_size <= 512)
779 /* small page device */
780 if (data)
781 device->controller->command(device, NAND_CMD_READ0);
782 else
783 device->controller->command(device, NAND_CMD_READOOB);
785 /* column (always 0, we start at the beginning of a page/OOB area) */
786 device->controller->address(device, 0x0);
788 /* row */
789 device->controller->address(device, page & 0xff);
790 device->controller->address(device, (page >> 8) & 0xff);
792 /* 4th cycle only on devices with more than 32 MiB */
793 if (device->address_cycles >= 4)
794 device->controller->address(device, (page >> 16) & 0xff);
796 /* 5th cycle only on devices with more than 8 GiB */
797 if (device->address_cycles >= 5)
798 device->controller->address(device, (page >> 24) & 0xff);
800 else
802 /* large page device */
803 device->controller->command(device, NAND_CMD_READ0);
805 /* column (0 when we start at the beginning of a page,
806 * or 2048 for the beginning of OOB area)
808 device->controller->address(device, 0x0);
809 device->controller->address(device, 0x8);
811 /* row */
812 device->controller->address(device, page & 0xff);
813 device->controller->address(device, (page >> 8) & 0xff);
815 /* 5th cycle only on devices with more than 128 MiB */
816 if (device->address_cycles >= 5)
817 device->controller->address(device, (page >> 16) & 0xff);
819 /* large page devices need a start command */
820 device->controller->command(device, NAND_CMD_READSTART);
823 if (!device->controller->nand_ready(device, 100))
824 return ERROR_NAND_OPERATION_TIMEOUT;
826 if (data)
828 if (device->controller->read_block_data != NULL)
829 (device->controller->read_block_data)(device, data, data_size);
830 else
832 for (i = 0; i < data_size;)
834 if (device->device->options & NAND_BUSWIDTH_16)
836 device->controller->read_data(device, data);
837 data += 2;
838 i += 2;
840 else
842 device->controller->read_data(device, data);
843 data += 1;
844 i += 1;
850 if (oob)
852 if (device->controller->read_block_data != NULL)
853 (device->controller->read_block_data)(device, oob, oob_size);
854 else
856 for (i = 0; i < oob_size;)
858 if (device->device->options & NAND_BUSWIDTH_16)
860 device->controller->read_data(device, oob);
861 oob += 2;
862 i += 2;
864 else
866 device->controller->read_data(device, oob);
867 oob += 1;
868 i += 1;
874 return ERROR_OK;
877 int nand_write_page_raw(struct nand_device_s *device, u32 page, u8 *data, u32 data_size, u8 *oob, u32 oob_size)
879 int i;
880 int retval;
881 u8 status;
883 if (!device->device)
884 return ERROR_NAND_DEVICE_NOT_PROBED;
886 device->controller->command(device, NAND_CMD_SEQIN);
888 if (device->page_size <= 512)
890 /* column (always 0, we start at the beginning of a page/OOB area) */
891 device->controller->address(device, 0x0);
893 /* row */
894 device->controller->address(device, page & 0xff);
895 device->controller->address(device, (page >> 8) & 0xff);
897 /* 4th cycle only on devices with more than 32 MiB */
898 if (device->address_cycles >= 4)
899 device->controller->address(device, (page >> 16) & 0xff);
901 /* 5th cycle only on devices with more than 8 GiB */
902 if (device->address_cycles >= 5)
903 device->controller->address(device, (page >> 24) & 0xff);
905 else
907 /* column (0 when we start at the beginning of a page,
908 * or 2048 for the beginning of OOB area)
910 device->controller->address(device, 0x0);
911 device->controller->address(device, 0x8);
913 /* row */
914 device->controller->address(device, page & 0xff);
915 device->controller->address(device, (page >> 8) & 0xff);
917 /* 5th cycle only on devices with more than 128 MiB */
918 if (device->address_cycles >= 5)
919 device->controller->address(device, (page >> 16) & 0xff);
922 if (data)
924 if (device->controller->write_block_data != NULL)
925 (device->controller->write_block_data)(device, data, data_size);
926 else
928 for (i = 0; i < data_size;)
930 if (device->device->options & NAND_BUSWIDTH_16)
932 u16 data_buf = le_to_h_u16(data);
933 device->controller->write_data(device, data_buf);
934 data += 2;
935 i += 2;
937 else
939 device->controller->write_data(device, *data);
940 data += 1;
941 i += 1;
947 if (oob)
949 if (device->controller->write_block_data != NULL)
950 (device->controller->write_block_data)(device, oob, oob_size);
951 else
953 for (i = 0; i < oob_size;)
955 if (device->device->options & NAND_BUSWIDTH_16)
957 u16 oob_buf = le_to_h_u16(data);
958 device->controller->write_data(device, oob_buf);
959 oob += 2;
960 i += 2;
962 else
964 device->controller->write_data(device, *oob);
965 oob += 1;
966 i += 1;
972 device->controller->command(device, NAND_CMD_PAGEPROG);
974 if (!device->controller->nand_ready(device, 100))
975 return ERROR_NAND_OPERATION_TIMEOUT;
977 if ((retval = nand_read_status(device, &status)) != ERROR_OK)
979 LOG_ERROR("couldn't read status");
980 return ERROR_NAND_OPERATION_FAILED;
983 if (status & NAND_STATUS_FAIL)
985 LOG_ERROR("write operation didn't pass, status: 0x%2.2x", status);
986 return ERROR_NAND_OPERATION_FAILED;
989 return ERROR_OK;
992 int handle_nand_list_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
994 nand_device_t *p;
995 int i = 0;
997 if (!nand_devices)
999 command_print(cmd_ctx, "no NAND flash devices configured");
1000 return ERROR_OK;
1003 for (p = nand_devices; p; p = p->next)
1005 if (p->device)
1006 command_print(cmd_ctx, "#%i: %s (%s) pagesize: %i, buswidth: %i, erasesize: %i",
1007 i++, p->device->name, p->manufacturer->name, p->page_size, p->bus_width, p->erase_size);
1008 else
1009 command_print(cmd_ctx, "#%i: not probed");
1012 return ERROR_OK;
1015 int handle_nand_info_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1017 nand_device_t *p;
1018 int i = 0;
1019 int j = 0;
1020 int first = -1;
1021 int last = -1;
1023 if ((argc < 1) || (argc > 3))
1025 return ERROR_COMMAND_SYNTAX_ERROR;
1029 if (argc == 2)
1031 first = last = strtoul(args[1], NULL, 0);
1033 else if (argc == 3)
1035 first = strtoul(args[1], NULL, 0);
1036 last = strtoul(args[2], NULL, 0);
1039 p = get_nand_device_by_num(strtoul(args[0], NULL, 0));
1040 if (p)
1042 if (p->device)
1044 if (first >= p->num_blocks)
1045 first = p->num_blocks - 1;
1047 if (last >= p->num_blocks)
1048 last = p->num_blocks - 1;
1050 command_print(cmd_ctx, "#%i: %s (%s) pagesize: %i, buswidth: %i, erasesize: %i",
1051 i++, p->device->name, p->manufacturer->name, p->page_size, p->bus_width, p->erase_size);
1053 for (j = first; j <= last; j++)
1055 char *erase_state, *bad_state;
1057 if (p->blocks[j].is_erased == 0)
1058 erase_state = "not erased";
1059 else if (p->blocks[j].is_erased == 1)
1060 erase_state = "erased";
1061 else
1062 erase_state = "erase state unknown";
1064 if (p->blocks[j].is_bad == 0)
1065 bad_state = "";
1066 else if (p->blocks[j].is_bad == 1)
1067 bad_state = " (marked bad)";
1068 else
1069 bad_state = " (block condition unknown)";
1071 command_print(cmd_ctx, "\t#%i: 0x%8.8x (0x%xkB) %s%s",
1072 j, p->blocks[j].offset, p->blocks[j].size / 1024,
1073 erase_state, bad_state);
1076 else
1078 command_print(cmd_ctx, "#%i: not probed");
1082 return ERROR_OK;
1085 int handle_nand_probe_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1087 nand_device_t *p;
1088 int retval;
1090 if (argc != 1)
1092 return ERROR_COMMAND_SYNTAX_ERROR;
1095 p = get_nand_device_by_num(strtoul(args[0], NULL, 0));
1096 if (p)
1098 if ((retval = nand_probe(p)) == ERROR_OK)
1100 command_print(cmd_ctx, "NAND flash device '%s' found", p->device->name);
1102 else if (retval == ERROR_NAND_OPERATION_FAILED)
1104 command_print(cmd_ctx, "probing failed for NAND flash device");
1106 else
1108 command_print(cmd_ctx, "unknown error when probing NAND flash device");
1111 else
1113 command_print(cmd_ctx, "NAND flash device '#%s' is out of bounds", args[0]);
1116 return ERROR_OK;
1119 int handle_nand_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1121 nand_device_t *p;
1122 int retval;
1124 if (argc != 3)
1126 return ERROR_COMMAND_SYNTAX_ERROR;
1130 p = get_nand_device_by_num(strtoul(args[0], NULL, 0));
1131 if (p)
1133 int first = strtoul(args[1], NULL, 0);
1134 int last = strtoul(args[2], NULL, 0);
1136 if ((retval = nand_erase(p, first, last)) == ERROR_OK)
1138 command_print(cmd_ctx, "successfully erased blocks %i to %i on NAND flash device '%s'", first, last, p->device->name);
1140 else if (retval == ERROR_NAND_OPERATION_FAILED)
1142 command_print(cmd_ctx, "erase failed");
1144 else
1146 command_print(cmd_ctx, "unknown error when erasing NAND flash device");
1149 else
1151 command_print(cmd_ctx, "NAND flash device '#%s' is out of bounds", args[0]);
1154 return ERROR_OK;
1157 int handle_nand_check_bad_blocks_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1159 nand_device_t *p;
1160 int retval;
1161 int first = -1;
1162 int last = -1;
1164 if ((argc < 1) || (argc > 3) || (argc == 2))
1166 return ERROR_COMMAND_SYNTAX_ERROR;
1170 if (argc == 3)
1172 first = strtoul(args[1], NULL, 0);
1173 last = strtoul(args[2], NULL, 0);
1176 p = get_nand_device_by_num(strtoul(args[0], NULL, 0));
1177 if (p)
1179 if ((retval = nand_build_bbt(p, first, last)) == ERROR_OK)
1181 command_print(cmd_ctx, "checked NAND flash device for bad blocks, use \"nand info\" command to list blocks", p->device->name);
1183 else if (retval == ERROR_NAND_OPERATION_FAILED)
1185 command_print(cmd_ctx, "error when checking for bad blocks on NAND flash device");
1187 else
1189 command_print(cmd_ctx, "unknown error when checking for bad blocks on NAND flash device");
1192 else
1194 command_print(cmd_ctx, "NAND flash device '#%s' is out of bounds", args[0]);
1197 return ERROR_OK;
1200 int handle_nand_copy_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1202 nand_device_t *p;
1204 if (argc != 4)
1206 return ERROR_COMMAND_SYNTAX_ERROR;
1210 p = get_nand_device_by_num(strtoul(args[0], NULL, 0));
1211 if (p)
1215 else
1217 command_print(cmd_ctx, "NAND flash device '#%s' is out of bounds", args[0]);
1220 return ERROR_OK;
1223 int handle_nand_write_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1225 u32 offset;
1226 u32 binary_size;
1227 u32 buf_cnt;
1228 enum oob_formats oob_format = NAND_OOB_NONE;
1230 fileio_t fileio;
1232 duration_t duration;
1233 char *duration_text;
1235 nand_device_t *p;
1237 if (argc < 3)
1239 return ERROR_COMMAND_SYNTAX_ERROR;
1243 p = get_nand_device_by_num(strtoul(args[0], NULL, 0));
1244 if (p)
1246 u8 *page = NULL;
1247 u32 page_size = 0;
1248 u8 *oob = NULL;
1249 u32 oob_size = 0;
1251 duration_start_measure(&duration);
1252 offset = strtoul(args[2], NULL, 0);
1254 if (argc > 3)
1256 int i;
1257 for (i = 3; i < argc; i++)
1259 if (!strcmp(args[i], "oob_raw"))
1260 oob_format |= NAND_OOB_RAW;
1261 else if (!strcmp(args[i], "oob_only"))
1262 oob_format |= NAND_OOB_RAW | NAND_OOB_ONLY;
1263 else
1265 command_print(cmd_ctx, "unknown option: %s", args[i]);
1270 if (fileio_open(&fileio, args[1], FILEIO_READ, FILEIO_BINARY) != ERROR_OK)
1272 return ERROR_OK;
1275 buf_cnt = binary_size = fileio.size;
1277 if (!(oob_format & NAND_OOB_ONLY))
1279 page_size = p->page_size;
1280 page = malloc(p->page_size);
1283 if (oob_format & NAND_OOB_RAW)
1285 if (p->page_size == 512)
1286 oob_size = 16;
1287 else if (p->page_size == 2048)
1288 oob_size = 64;
1289 oob = malloc(oob_size);
1292 if (offset % p->page_size)
1294 command_print(cmd_ctx, "only page size aligned offsets and sizes are supported");
1295 return ERROR_OK;
1298 while (buf_cnt > 0)
1300 u32 size_read;
1302 if (page)
1304 fileio_read(&fileio, page_size, page, &size_read);
1305 buf_cnt -= size_read;
1306 if (size_read < page_size)
1308 memset(page + size_read, 0xff, page_size - size_read);
1312 if (oob)
1314 fileio_read(&fileio, oob_size, oob, &size_read);
1315 buf_cnt -= size_read;
1316 if (size_read < oob_size)
1318 memset(oob + size_read, 0xff, oob_size - size_read);
1322 if (nand_write_page(p, offset / p->page_size, page, page_size, oob, oob_size) != ERROR_OK)
1324 command_print(cmd_ctx, "failed writing file %s to NAND flash %s at offset 0x%8.8x",
1325 args[1], args[0], offset);
1326 return ERROR_OK;
1328 offset += page_size;
1331 fileio_close(&fileio);
1333 duration_stop_measure(&duration, &duration_text);
1334 command_print(cmd_ctx, "wrote file %s to NAND flash %s at offset 0x%8.8x in %s",
1335 args[1], args[0], offset, duration_text);
1336 free(duration_text);
1338 else
1340 command_print(cmd_ctx, "NAND flash device '#%s' is out of bounds", args[0]);
1343 return ERROR_OK;
1346 int handle_nand_dump_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1348 nand_device_t *p;
1350 if (argc < 4)
1352 return ERROR_COMMAND_SYNTAX_ERROR;
1355 p = get_nand_device_by_num(strtoul(args[0], NULL, 0));
1356 if (p)
1358 if (p->device)
1360 fileio_t fileio;
1361 duration_t duration;
1362 char *duration_text;
1363 int retval;
1365 u8 *page = NULL;
1366 u32 page_size = 0;
1367 u8 *oob = NULL;
1368 u32 oob_size = 0;
1369 u32 address = strtoul(args[2], NULL, 0);
1370 u32 size = strtoul(args[3], NULL, 0);
1371 u32 bytes_done = 0;
1372 enum oob_formats oob_format = NAND_OOB_NONE;
1374 if (argc > 4)
1376 int i;
1377 for (i = 4; i < argc; i++)
1379 if (!strcmp(args[i], "oob_raw"))
1380 oob_format |= NAND_OOB_RAW;
1381 else if (!strcmp(args[i], "oob_only"))
1382 oob_format |= NAND_OOB_RAW | NAND_OOB_ONLY;
1383 else
1384 command_print(cmd_ctx, "unknown option: '%s'", args[i]);
1388 if ((address % p->page_size) || (size % p->page_size))
1390 command_print(cmd_ctx, "only page size aligned addresses and sizes are supported");
1391 return ERROR_OK;
1394 if (!(oob_format & NAND_OOB_ONLY))
1396 page_size = p->page_size;
1397 page = malloc(p->page_size);
1400 if (oob_format & NAND_OOB_RAW)
1402 if (p->page_size == 512)
1403 oob_size = 16;
1404 else if (p->page_size == 2048)
1405 oob_size = 64;
1406 oob = malloc(oob_size);
1409 if (fileio_open(&fileio, args[1], FILEIO_WRITE, FILEIO_BINARY) != ERROR_OK)
1411 return ERROR_OK;
1414 duration_start_measure(&duration);
1416 while (size > 0)
1418 u32 size_written;
1419 if ((retval = nand_read_page(p, address / p->page_size, page, page_size, oob, oob_size)) != ERROR_OK)
1421 command_print(cmd_ctx, "reading NAND flash page failed");
1422 return ERROR_OK;
1425 if (page)
1427 fileio_write(&fileio, page_size, page, &size_written);
1428 bytes_done += page_size;
1431 if (oob)
1433 fileio_write(&fileio, oob_size, oob, &size_written);
1434 bytes_done += oob_size;
1437 size -= p->page_size;
1438 address += p->page_size;
1441 if (page)
1442 free(page);
1444 if (oob)
1445 free(oob);
1447 fileio_close(&fileio);
1449 duration_stop_measure(&duration, &duration_text);
1450 command_print(cmd_ctx, "dumped %"PRIi64" byte in %s", fileio.size, duration_text);
1451 free(duration_text);
1453 else
1455 command_print(cmd_ctx, "#%i: not probed");
1458 else
1460 command_print(cmd_ctx, "NAND flash device '#%s' is out of bounds", args[0]);
1463 return ERROR_OK;
1466 int handle_nand_raw_access_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1468 nand_device_t *p;
1470 if ((argc < 1) || (argc > 2))
1472 return ERROR_COMMAND_SYNTAX_ERROR;
1475 p = get_nand_device_by_num(strtoul(args[0], NULL, 0));
1476 if (p)
1478 if (p->device)
1480 if (argc == 2)
1482 if (strcmp("enable", args[1]) == 0)
1484 p->use_raw = 1;
1486 else if (strcmp("disable", args[1]) == 0)
1488 p->use_raw = 0;
1490 else
1492 return ERROR_COMMAND_SYNTAX_ERROR;
1496 command_print(cmd_ctx, "raw access is %s", (p->use_raw) ? "enabled" : "disabled");
1498 else
1500 command_print(cmd_ctx, "#%i: not probed");
1503 else
1505 command_print(cmd_ctx, "NAND flash device '#%s' is out of bounds", args[0]);
1508 return ERROR_OK;