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