?  search:
summary | log | graphiclog1 | graphiclog2 | refs | edit | fork

cf6fa080377bbb2f727d984ab35c2a175335e242
[openocd.git] / src / flash / nor / tcl.c
blobcf6fa080377bbb2f727d984ab35c2a175335e242
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath <Dominic.Rath@gmx.de> *
3 * Copyright (C) 2007,2008 Øyvind Harboe <oyvind.harboe@zylin.com> *
4 * Copyright (C) 2008 by Spencer Oliver <spen@spen-soft.co.uk> *
5 * Copyright (C) 2009 Zachary T Welch <zw@superlucidity.net> *
6 * *
7 * This program is free software; you can redistribute it and/or modify *
8 * it under the terms of the GNU General Public License as published by *
9 * the Free Software Foundation; either version 2 of the License, or *
10 * (at your option) any later version. *
11 * *
12 * This program is distributed in the hope that it will be useful, *
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
15 * GNU General Public License for more details. *
16 * *
17 * You should have received a copy of the GNU General Public License *
18 * along with this program; if not, write to the *
19 * Free Software Foundation, Inc., *
20 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
21 ***************************************************************************/
22 #ifdef HAVE_CONFIG_H
23 #include "config.h"
24 #endif
25 #include "imp.h"
26 #include <helper/time_support.h>
27 #include <target/image.h>
28
29 /**
30 * @file
31 * Implements Tcl commands used to access NOR flash facilities.
32 */
33
34 COMMAND_HELPER(flash_command_get_bank, unsigned name_index,
35 struct flash_bank **bank)
36 {
37 const char *name = CMD_ARGV[name_index];
38 int retval = get_flash_bank_by_name(name, bank);
39 if (retval != ERROR_OK)
40 return retval;
41 if (*bank)
42 return ERROR_OK;
43
44 unsigned bank_num;
45 COMMAND_PARSE_NUMBER(uint, name, bank_num);
46
47 return get_flash_bank_by_num(bank_num, bank);
48 }
49
50 COMMAND_HANDLER(handle_flash_info_command)
51 {
52 struct flash_bank *p;
53 int j = 0;
54 int retval;
55
56 if (CMD_ARGC != 1)
57 return ERROR_COMMAND_SYNTAX_ERROR;
58
59 retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
60 if (retval != ERROR_OK)
61 return retval;
62
63 if (p != NULL) {
64 char buf[1024];
65
66 /* attempt auto probe */
67 retval = p->driver->auto_probe(p);
68 if (retval != ERROR_OK)
69 return retval;
70
71 /* We must query the hardware to avoid printing stale information! */
72 retval = p->driver->protect_check(p);
73 if (retval != ERROR_OK)
74 return retval;
75
76 command_print(CMD_CTX,
77 "#%" PRIu32 " : %s at 0x%8.8" PRIx32 ", size 0x%8.8" PRIx32
78 ", buswidth %i, chipwidth %i",
79 p->bank_number,
80 p->driver->name,
81 p->base,
82 p->size,
83 p->bus_width,
84 p->chip_width);
85 for (j = 0; j < p->num_sectors; j++) {
86 char *protect_state;
87
88 if (p->sectors[j].is_protected == 0)
89 protect_state = "not protected";
90 else if (p->sectors[j].is_protected == 1)
91 protect_state = "protected";
92 else
93 protect_state = "protection state unknown";
94
95 command_print(CMD_CTX,
96 "\t#%3i: 0x%8.8" PRIx32 " (0x%" PRIx32 " %" PRIi32 "kB) %s",
97 j,
98 p->sectors[j].offset,
99 p->sectors[j].size,
100 p->sectors[j].size >> 10,
101 protect_state);
102 }
103
104 *buf = '\0'; /* initialize buffer, otherwise it migh contain garbage if driver
105 *function fails */
106 retval = p->driver->info(p, buf, sizeof(buf));
107 command_print(CMD_CTX, "%s", buf);
108 if (retval != ERROR_OK)
109 LOG_ERROR("error retrieving flash info");
110 }
111
112 return retval;
113 }
114
115 COMMAND_HANDLER(handle_flash_probe_command)
116 {
117 struct flash_bank *p;
118 int retval;
119
120 if (CMD_ARGC != 1)
121 return ERROR_COMMAND_SYNTAX_ERROR;
122
123 retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
124 if (retval != ERROR_OK)
125 return retval;
126
127 if (p) {
128 retval = p->driver->probe(p);
129 if (retval == ERROR_OK)
130 command_print(CMD_CTX,
131 "flash '%s' found at 0x%8.8" PRIx32,
132 p->driver->name,
133 p->base);
134 } else {
135 command_print(CMD_CTX, "flash bank '#%s' is out of bounds", CMD_ARGV[0]);
136 retval = ERROR_FAIL;
137 }
138
139 return retval;
140 }
141
142 COMMAND_HANDLER(handle_flash_erase_check_command)
143 {
144 if (CMD_ARGC != 1)
145 return ERROR_COMMAND_SYNTAX_ERROR;
146
147 struct flash_bank *p;
148 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
149 if (ERROR_OK != retval)
150 return retval;
151
152 int j;
153 retval = p->driver->erase_check(p);
154 if (retval == ERROR_OK)
155 command_print(CMD_CTX, "successfully checked erase state");
156 else {
157 command_print(CMD_CTX,
158 "unknown error when checking erase state of flash bank #%s at 0x%8.8" PRIx32,
159 CMD_ARGV[0],
160 p->base);
161 }
162
163 for (j = 0; j < p->num_sectors; j++) {
164 char *erase_state;
165
166 if (p->sectors[j].is_erased == 0)
167 erase_state = "not erased";
168 else if (p->sectors[j].is_erased == 1)
169 erase_state = "erased";
170 else
171 erase_state = "erase state unknown";
172
173 command_print(CMD_CTX,
174 "\t#%3i: 0x%8.8" PRIx32 " (0x%" PRIx32 " %" PRIi32 "kB) %s",
175 j,
176 p->sectors[j].offset,
177 p->sectors[j].size,
178 p->sectors[j].size >> 10,
179 erase_state);
180 }
181
182 return retval;
183 }
184
185 COMMAND_HANDLER(handle_flash_erase_address_command)
186 {
187 struct flash_bank *p;
188 int retval = ERROR_OK;
189 uint32_t address;
190 uint32_t length;
191 bool do_pad = false;
192 bool do_unlock = false;
193 struct target *target = get_current_target(CMD_CTX);
194
195 while (CMD_ARGC >= 3) {
196 /* Optionally pad out the address range to block/sector
197 * boundaries. We can't know if there's data in that part
198 * of the flash; only do padding if we're told to.
199 */
200 if (strcmp("pad", CMD_ARGV[0]) == 0)
201 do_pad = true;
202 else if (strcmp("unlock", CMD_ARGV[0]) == 0)
203 do_unlock = true;
204 else
205 return ERROR_COMMAND_SYNTAX_ERROR;
206 CMD_ARGC--;
207 CMD_ARGV++;
208 }
209 if (CMD_ARGC != 2)
210 return ERROR_COMMAND_SYNTAX_ERROR;
211
212 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
213 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
214
215 if (length <= 0) {
216 command_print(CMD_CTX, "Length must be >0");
217 return ERROR_COMMAND_SYNTAX_ERROR;
218 }
219
220 retval = get_flash_bank_by_addr(target, address, true, &p);
221 if (retval != ERROR_OK)
222 return retval;
223
224 /* We can't know if we did a resume + halt, in which case we no longer know the erased state
225 **/
226 flash_set_dirty();
227
228 struct duration bench;
229 duration_start(&bench);
230
231 if (do_unlock)
232 retval = flash_unlock_address_range(target, address, length);
233
234 if (retval == ERROR_OK)
235 retval = flash_erase_address_range(target, do_pad, address, length);
236
237 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
238 command_print(CMD_CTX, "erased address 0x%8.8x (length %i)"
239 " in %fs (%0.3f KiB/s)", address, length,
240 duration_elapsed(&bench), duration_kbps(&bench, length));
241 }
242
243 return retval;
244 }
245
246 static int flash_check_sector_parameters(struct command_context *cmd_ctx,
247 uint32_t first, uint32_t last, uint32_t num_sectors)
248 {
249 if (!(first <= last)) {
250 command_print(cmd_ctx, "ERROR: "
251 "first sector must be <= last sector");
252 return ERROR_FAIL;
253 }
254
255 if (!(last <= (num_sectors - 1))) {
256 command_print(cmd_ctx, "ERROR: last sector must be <= %d",
257 (int) num_sectors - 1);
258 return ERROR_FAIL;
259 }
260
261 return ERROR_OK;
262 }
263
264 COMMAND_HANDLER(handle_flash_erase_command)
265 {
266 if (CMD_ARGC != 3)
267 return ERROR_COMMAND_SYNTAX_ERROR;
268
269 uint32_t first;
270 uint32_t last;
271
272 struct flash_bank *p;
273 int retval;
274
275 retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
276 if (retval != ERROR_OK)
277 return retval;
278
279 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], first);
280 if (strcmp(CMD_ARGV[2], "last") == 0)
281 last = p->num_sectors - 1;
282 else
283 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], last);
284
285 retval = flash_check_sector_parameters(CMD_CTX, first, last, p->num_sectors);
286 if (retval != ERROR_OK)
287 return retval;
288
289 struct duration bench;
290 duration_start(&bench);
291
292 retval = flash_driver_erase(p, first, last);
293
294 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
295 command_print(CMD_CTX, "erased sectors %" PRIu32 " "
296 "through %" PRIu32 " on flash bank %" PRIu32 " "
297 "in %fs", first, last, p->bank_number, duration_elapsed(&bench));
298 }
299
300 return ERROR_OK;
301 }
302
303 COMMAND_HANDLER(handle_flash_protect_command)
304 {
305 if (CMD_ARGC != 4)
306 return ERROR_COMMAND_SYNTAX_ERROR;
307
308 uint32_t first;
309 uint32_t last;
310
311 struct flash_bank *p;
312 int retval;
313
314 retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
315 if (retval != ERROR_OK)
316 return retval;
317
318 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], first);
319 if (strcmp(CMD_ARGV[2], "last") == 0)
320 last = p->num_sectors - 1;
321 else
322 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], last);
323
324 bool set;
325 COMMAND_PARSE_ON_OFF(CMD_ARGV[3], set);
326
327 retval = flash_check_sector_parameters(CMD_CTX, first, last, p->num_sectors);
328 if (retval != ERROR_OK)
329 return retval;
330
331 retval = flash_driver_protect(p, set, first, last);
332 if (retval == ERROR_OK) {
333 command_print(CMD_CTX, "%s protection for sectors %i "
334 "through %i on flash bank %" PRIu32 "",
335 (set) ? "set" : "cleared", (int) first,
336 (int) last, p->bank_number);
337 }
338
339 return retval;
340 }
341
342 COMMAND_HANDLER(handle_flash_write_image_command)
343 {
344 struct target *target = get_current_target(CMD_CTX);
345
346 struct image image;
347 uint32_t written;
348
349 int retval;
350
351 if (CMD_ARGC < 1)
352 return ERROR_COMMAND_SYNTAX_ERROR;
353
354 /* flash auto-erase is disabled by default*/
355 int auto_erase = 0;
356 bool auto_unlock = false;
357
358 for (;; ) {
359 if (strcmp(CMD_ARGV[0], "erase") == 0) {
360 auto_erase = 1;
361 CMD_ARGV++;
362 CMD_ARGC--;
363 command_print(CMD_CTX, "auto erase enabled");
364 } else if (strcmp(CMD_ARGV[0], "unlock") == 0) {
365 auto_unlock = true;
366 CMD_ARGV++;
367 CMD_ARGC--;
368 command_print(CMD_CTX, "auto unlock enabled");
369 } else
370 break;
371 }
372
373 if (CMD_ARGC < 1)
374 return ERROR_COMMAND_SYNTAX_ERROR;
375
376 if (!target) {
377 LOG_ERROR("no target selected");
378 return ERROR_FAIL;
379 }
380
381 struct duration bench;
382 duration_start(&bench);
383
384 if (CMD_ARGC >= 2) {
385 image.base_address_set = 1;
386 COMMAND_PARSE_NUMBER(llong, CMD_ARGV[1], image.base_address);
387 } else {
388 image.base_address_set = 0;
389 image.base_address = 0x0;
390 }
391
392 image.start_address_set = 0;
393
394 retval = image_open(&image, CMD_ARGV[0], (CMD_ARGC == 3) ? CMD_ARGV[2] : NULL);
395 if (retval != ERROR_OK)
396 return retval;
397
398 retval = flash_write_unlock(target, &image, &written, auto_erase, auto_unlock);
399 if (retval != ERROR_OK) {
400 image_close(&image);
401 return retval;
402 }
403
404 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
405 command_print(CMD_CTX, "wrote %" PRIu32 " bytes from file %s "
406 "in %fs (%0.3f KiB/s)", written, CMD_ARGV[0],
407 duration_elapsed(&bench), duration_kbps(&bench, written));
408 }
409
410 image_close(&image);
411
412 return retval;
413 }
414
415 COMMAND_HANDLER(handle_flash_fill_command)
416 {
417 int err = ERROR_OK;
418 uint32_t address;
419 uint32_t pattern;
420 uint32_t count;
421 uint32_t wrote = 0;
422 uint32_t cur_size = 0;
423 uint32_t chunk_count;
424 struct target *target = get_current_target(CMD_CTX);
425 unsigned i;
426 uint32_t wordsize;
427 int retval = ERROR_OK;
428
429 static size_t const chunksize = 1024;
430 uint8_t *chunk = NULL, *readback = NULL;
431
432 if (CMD_ARGC != 3) {
433 retval = ERROR_COMMAND_SYNTAX_ERROR;
434 goto done;
435 }
436
437 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
438 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], pattern);
439 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], count);
440
441 chunk = malloc(chunksize);
442 if (chunk == NULL)
443 return ERROR_FAIL;
444
445 readback = malloc(chunksize);
446 if (readback == NULL) {
447 free(chunk);
448 return ERROR_FAIL;
449 }
450
451 if (count == 0)
452 goto done;
453
454 switch (CMD_NAME[4]) {
455 case 'w':
456 wordsize = 4;
457 break;
458 case 'h':
459 wordsize = 2;
460 break;
461 case 'b':
462 wordsize = 1;
463 break;
464 default:
465 retval = ERROR_COMMAND_SYNTAX_ERROR;
466 goto done;
467 }
468
469 chunk_count = MIN(count, (chunksize / wordsize));
470 switch (wordsize) {
471 case 4:
472 for (i = 0; i < chunk_count; i++)
473 target_buffer_set_u32(target, chunk + i * wordsize, pattern);
474 break;
475 case 2:
476 for (i = 0; i < chunk_count; i++)
477 target_buffer_set_u16(target, chunk + i * wordsize, pattern);
478 break;
479 case 1:
480 memset(chunk, pattern, chunk_count);
481 break;
482 default:
483 LOG_ERROR("BUG: can't happen");
484 exit(-1);
485 }
486
487 struct duration bench;
488 duration_start(&bench);
489
490 for (wrote = 0; wrote < (count*wordsize); wrote += cur_size) {
491 struct flash_bank *bank;
492
493 retval = get_flash_bank_by_addr(target, address, true, &bank);
494 if (retval != ERROR_OK)
495 goto done;
496
497 cur_size = MIN((count * wordsize - wrote), chunksize);
498 err = flash_driver_write(bank, chunk, address - bank->base + wrote, cur_size);
499 if (err != ERROR_OK) {
500 retval = err;
501 goto done;
502 }
503
504 err = flash_driver_read(bank, readback, address - bank->base + wrote, cur_size);
505 if (err != ERROR_OK) {
506 retval = err;
507 goto done;
508 }
509
510 for (i = 0; i < cur_size; i++) {
511 if (readback[i] != chunk[i]) {
512 LOG_ERROR(
513 "Verification error address 0x%08" PRIx32 ", read back 0x%02x, expected 0x%02x",
514 address + wrote + i,
515 readback[i],
516 chunk[i]);
517 retval = ERROR_FAIL;
518 goto done;
519 }
520 }
521 }
522
523 if ((retval == ERROR_OK) && (duration_measure(&bench) == ERROR_OK)) {
524 command_print(CMD_CTX, "wrote %" PRIu32 " bytes to 0x%8.8" PRIx32
525 " in %fs (%0.3f KiB/s)", wrote, address,
526 duration_elapsed(&bench), duration_kbps(&bench, wrote));
527 }
528
529 done:
530 free(readback);
531 free(chunk);
532
533 return retval;
534 }
535
536 COMMAND_HANDLER(handle_flash_write_bank_command)
537 {
538 uint32_t offset;
539 uint8_t *buffer;
540 struct fileio fileio;
541
542 if (CMD_ARGC != 3)
543 return ERROR_COMMAND_SYNTAX_ERROR;
544
545 struct duration bench;
546 duration_start(&bench);
547
548 struct flash_bank *p;
549 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
550 if (ERROR_OK != retval)
551 return retval;
552
553 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset);
554
555 if (fileio_open(&fileio, CMD_ARGV[1], FILEIO_READ, FILEIO_BINARY) != ERROR_OK)
556 return ERROR_OK;
557
558 int filesize;
559 retval = fileio_size(&fileio, &filesize);
560 if (retval != ERROR_OK) {
561 fileio_close(&fileio);
562 return retval;
563 }
564
565 buffer = malloc(filesize);
566 if (buffer == NULL) {
567 fileio_close(&fileio);
568 LOG_ERROR("Out of memory");
569 return ERROR_FAIL;
570 }
571 size_t buf_cnt;
572 if (fileio_read(&fileio, filesize, buffer, &buf_cnt) != ERROR_OK) {
573 free(buffer);
574 fileio_close(&fileio);
575 return ERROR_OK;
576 }
577
578 retval = flash_driver_write(p, buffer, offset, buf_cnt);
579
580 free(buffer);
581 buffer = NULL;
582
583 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
584 command_print(CMD_CTX, "wrote %ld bytes from file %s to flash bank %u"
585 " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)",
586 (long)filesize, CMD_ARGV[1], p->bank_number, offset,
587 duration_elapsed(&bench), duration_kbps(&bench, filesize));
588 }
589
590 fileio_close(&fileio);
591
592 return retval;
593 }
594
595 void flash_set_dirty(void)
596 {
597 struct flash_bank *c;
598 int i;
599
600 /* set all flash to require erasing */
601 for (c = flash_bank_list(); c; c = c->next) {
602 for (i = 0; i < c->num_sectors; i++)
603 c->sectors[i].is_erased = 0;
604 }
605 }
606
607 static const struct command_registration flash_exec_command_handlers[] = {
608 {
609 .name = "probe",
610 .handler = handle_flash_probe_command,
611 .mode = COMMAND_EXEC,
612 .usage = "bank_id",
613 .help = "Identify a flash bank.",
614 },
615 {
616 .name = "info",
617 .handler = handle_flash_info_command,
618 .mode = COMMAND_EXEC,
619 .usage = "bank_id",
620 .help = "Print information about a flash bank.",
621 },
622 {
623 .name = "erase_check",
624 .handler = handle_flash_erase_check_command,
625 .mode = COMMAND_EXEC,
626 .usage = "bank_id",
627 .help = "Check erase state of all blocks in a "
628 "flash bank.",
629 },
630 {
631 .name = "erase_sector",
632 .handler = handle_flash_erase_command,
633 .mode = COMMAND_EXEC,
634 .usage = "bank_id first_sector_num last_sector_num",
635 .help = "Erase a range of sectors in a flash bank.",
636 },
637 {
638 .name = "erase_address",
639 .handler = handle_flash_erase_address_command,
640 .mode = COMMAND_EXEC,
641 .usage = "['pad'] ['unlock'] address length",
642 .help = "Erase flash sectors starting at address and "
643 "continuing for length bytes. If 'pad' is specified, "
644 "data outside that range may also be erased: the start "
645 "address may be decreased, and length increased, so "
646 "that all of the first and last sectors are erased. "
647 "If 'unlock' is specified, then the flash is unprotected "
648 "before erasing.",
649
650 },
651 {
652 .name = "fillw",
653 .handler = handle_flash_fill_command,
654 .mode = COMMAND_EXEC,
655 .usage = "address value n",
656 .help = "Fill n words with 32-bit value, starting at "
657 "word address. (No autoerase.)",
658 },
659 {
660 .name = "fillh",
661 .handler = handle_flash_fill_command,
662 .mode = COMMAND_EXEC,
663 .usage = "address value n",
664 .help = "Fill n halfwords with 16-bit value, starting at "
665 "word address. (No autoerase.)",
666 },
667 {
668 .name = "fillb",
669 .handler = handle_flash_fill_command,
670 .mode = COMMAND_EXEC,
671 .usage = "address value n",
672 .help = "Fill n bytes with 8-bit value, starting at "
673 "word address. (No autoerase.)",
674 },
675 {
676 .name = "write_bank",
677 .handler = handle_flash_write_bank_command,
678 .mode = COMMAND_EXEC,
679 .usage = "bank_id filename offset",
680 .help = "Write binary data from file to flash bank, "
681 "starting at specified byte offset from the "
682 "beginning of the bank.",
683 },
684 {
685 .name = "write_image",
686 .handler = handle_flash_write_image_command,
687 .mode = COMMAND_EXEC,
688 .usage = "[erase] [unlock] filename [offset [file_type]]",
689 .help = "Write an image to flash. Optionally first unprotect "
690 "and/or erase the region to be used. Allow optional "
691 "offset from beginning of bank (defaults to zero)",
692 },
693 {
694 .name = "protect",
695 .handler = handle_flash_protect_command,
696 .mode = COMMAND_EXEC,
697 .usage = "bank_id first_sector [last_sector|'last'] "
698 "('on'|'off')",
699 .help = "Turn protection on or off for a range of sectors "
700 "in a given flash bank.",
701 },
702 COMMAND_REGISTRATION_DONE
703 };
704
705 static int flash_init_drivers(struct command_context *cmd_ctx)
706 {
707 if (!flash_bank_list())
708 return ERROR_OK;
709
710 struct command *parent = command_find_in_context(cmd_ctx, "flash");
711 return register_commands(cmd_ctx, parent, flash_exec_command_handlers);
712 }
713
714
715 COMMAND_HANDLER(handle_flash_bank_command)
716 {
717 if (CMD_ARGC < 7) {
718 LOG_ERROR("usage: flash bank <name> <driver> "
719 "<base> <size> <chip_width> <bus_width> <target>");
720 return ERROR_COMMAND_SYNTAX_ERROR;
721 }
722 /* save bank name and advance arguments for compatibility */
723 const char *bank_name = *CMD_ARGV++;
724 CMD_ARGC--;
725
726 struct target *target = get_target(CMD_ARGV[5]);
727 if (target == NULL) {
728 LOG_ERROR("target '%s' not defined", CMD_ARGV[5]);
729 return ERROR_FAIL;
730 }
731
732 const char *driver_name = CMD_ARGV[0];
733 struct flash_driver *driver = flash_driver_find_by_name(driver_name);
734 if (NULL == driver) {
735 /* no matching flash driver found */
736 LOG_ERROR("flash driver '%s' not found", driver_name);
737 return ERROR_FAIL;
738 }
739
740 /* check the flash bank name is unique */
741 if (get_flash_bank_by_name_noprobe(bank_name) != NULL) {
742 /* flash bank name already exists */
743 LOG_ERROR("flash bank name '%s' already exists", bank_name);
744 return ERROR_FAIL;
745 }
746
747 /* register flash specific commands */
748 if (NULL != driver->commands) {
749 int retval = register_commands(CMD_CTX, NULL,
750 driver->commands);
751 if (ERROR_OK != retval) {
752 LOG_ERROR("couldn't register '%s' commands",
753 driver_name);
754 return ERROR_FAIL;
755 }
756 }
757
758 struct flash_bank *c = malloc(sizeof(*c));
759 c->name = strdup(bank_name);
760 c->target = target;
761 c->driver = driver;
762 c->driver_priv = NULL;
763 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], c->base);
764 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], c->size);
765 COMMAND_PARSE_NUMBER(int, CMD_ARGV[3], c->chip_width);
766 COMMAND_PARSE_NUMBER(int, CMD_ARGV[4], c->bus_width);
767 c->num_sectors = 0;
768 c->sectors = NULL;
769 c->next = NULL;
770
771 int retval;
772 retval = CALL_COMMAND_HANDLER(driver->flash_bank_command, c);
773 if (ERROR_OK != retval) {
774 LOG_ERROR("'%s' driver rejected flash bank at 0x%8.8" PRIx32 "Usage %s",
775 driver_name, c->base, driver->usage);
776 free(c);
777 return retval;
778 }
779
780 if (driver->usage == NULL)
781 LOG_DEBUG("'%s' driver usage field missing", driver_name);
782
783 flash_bank_add(c);
784
785 return ERROR_OK;
786 }
787
788 COMMAND_HANDLER(handle_flash_banks_command)
789 {
790 if (CMD_ARGC != 0)
791 return ERROR_COMMAND_SYNTAX_ERROR;
792
793 unsigned n = 0;
794 for (struct flash_bank *p = flash_bank_list(); p; p = p->next, n++) {
795 LOG_USER("#%" PRIu32 " : %s (%s) at 0x%8.8" PRIx32 ", size 0x%8.8" PRIx32 ", "
796 "buswidth %u, chipwidth %u", p->bank_number,
797 p->name, p->driver->name, p->base, p->size,
798 p->bus_width, p->chip_width);
799 }
800 return ERROR_OK;
801 }
802
803 static int jim_flash_list(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
804 {
805 if (argc != 1) {
806 Jim_WrongNumArgs(interp, 1, argv,
807 "no arguments to 'flash list' command");
808 return JIM_ERR;
809 }
810
811 Jim_Obj *list = Jim_NewListObj(interp, NULL, 0);
812
813 for (struct flash_bank *p = flash_bank_list(); p; p = p->next) {
814 Jim_Obj *elem = Jim_NewListObj(interp, NULL, 0);
815
816 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "name", -1));
817 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, p->driver->name, -1));
818 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "base", -1));
819 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->base));
820 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "size", -1));
821 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->size));
822 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "bus_width", -1));
823 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->bus_width));
824 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "chip_width", -1));
825 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->chip_width));
826
827 Jim_ListAppendElement(interp, list, elem);
828 }
829
830 Jim_SetResult(interp, list);
831
832 return JIM_OK;
833 }
834
835 COMMAND_HANDLER(handle_flash_init_command)
836 {
837 if (CMD_ARGC != 0)
838 return ERROR_COMMAND_SYNTAX_ERROR;
839
840 static bool flash_initialized;
841 if (flash_initialized) {
842 LOG_INFO("'flash init' has already been called");
843 return ERROR_OK;
844 }
845 flash_initialized = true;
846
847 LOG_DEBUG("Initializing flash devices...");
848 return flash_init_drivers(CMD_CTX);
849 }
850
851 static const struct command_registration flash_config_command_handlers[] = {
852 {
853 .name = "bank",
854 .handler = handle_flash_bank_command,
855 .mode = COMMAND_CONFIG,
856 .usage = "bank_id driver_name base_address size_bytes "
857 "chip_width_bytes bus_width_bytes target "
858 "[driver_options ...]",
859 .help = "Define a new bank with the given name, "
860 "using the specified NOR flash driver.",
861 },
862 {
863 .name = "init",
864 .mode = COMMAND_CONFIG,
865 .handler = handle_flash_init_command,
866 .help = "Initialize flash devices.",
867 },
868 {
869 .name = "banks",
870 .mode = COMMAND_ANY,
871 .handler = handle_flash_banks_command,
872 .help = "Display table with information about flash banks.",
873 },
874 {
875 .name = "list",
876 .mode = COMMAND_ANY,
877 .jim_handler = jim_flash_list,
878 .help = "Returns a list of details about the flash banks.",
879 },
880 COMMAND_REGISTRATION_DONE
881 };
882 static const struct command_registration flash_command_handlers[] = {
883 {
884 .name = "flash",
885 .mode = COMMAND_ANY,
886 .help = "NOR flash command group",
887 .chain = flash_config_command_handlers,
888 },
889 COMMAND_REGISTRATION_DONE
890 };
891
892 int flash_register_commands(struct command_context *cmd_ctx)
893 {
894 return register_commands(cmd_ctx, NULL, flash_command_handlers);
895 }
Official OpenOCD Mirror