Code Review / openocd.git / blob
? search:
summary | shortlog | log | commit | commitdiff | review | tree
history | raw | HEAD
flash/nor/tcl: Respect flash bank boundary in verify_bank
[openocd.git] / src / flash / nor / tcl.c
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, see <http://www.gnu.org/licenses/>. *
19 ***************************************************************************/
20 #ifdef HAVE_CONFIG_H
21 #include "config.h"
22 #endif
23 #include "imp.h"
24 #include <helper/time_support.h>
25 #include <target/image.h>
26
27 /**
28 * @file
29 * Implements Tcl commands used to access NOR flash facilities.
30 */
31
32 COMMAND_HELPER(flash_command_get_bank_maybe_probe, unsigned name_index,
33 struct flash_bank **bank, bool do_probe)
34 {
35 const char *name = CMD_ARGV[name_index];
36 int retval;
37 if (do_probe) {
38 retval = get_flash_bank_by_name(name, bank);
39 } else {
40 *bank = get_flash_bank_by_name_noprobe(name);
41 retval = ERROR_OK;
42 }
43
44 if (retval != ERROR_OK)
45 return retval;
46 if (*bank)
47 return ERROR_OK;
48
49 unsigned bank_num;
50 COMMAND_PARSE_NUMBER(uint, name, bank_num);
51
52 if (do_probe) {
53 return get_flash_bank_by_num(bank_num, bank);
54 } else {
55 *bank = get_flash_bank_by_num_noprobe(bank_num);
56 retval = (bank) ? ERROR_OK : ERROR_FAIL;
57 return retval;
58 }
59 }
60
61 COMMAND_HELPER(flash_command_get_bank, unsigned name_index,
62 struct flash_bank **bank)
63 {
64 return CALL_COMMAND_HANDLER(flash_command_get_bank_maybe_probe,
65 name_index, bank, true);
66 }
67
68 COMMAND_HANDLER(handle_flash_info_command)
69 {
70 struct flash_bank *p;
71 int j = 0;
72 int retval;
73 bool show_sectors = false;
74 bool prot_block_available;
75
76 if (CMD_ARGC < 1 || CMD_ARGC > 2)
77 return ERROR_COMMAND_SYNTAX_ERROR;
78
79 if (CMD_ARGC == 2) {
80 if (strcmp("sectors", CMD_ARGV[1]) == 0)
81 show_sectors = true;
82 else
83 return ERROR_COMMAND_SYNTAX_ERROR;
84 }
85
86 retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
87 if (retval != ERROR_OK)
88 return retval;
89
90 if (p != NULL) {
91 char buf[1024];
92 int num_blocks;
93 struct flash_sector *block_array;
94
95 /* attempt auto probe */
96 retval = p->driver->auto_probe(p);
97 if (retval != ERROR_OK)
98 return retval;
99
100 /* We must query the hardware to avoid printing stale information! */
101 retval = p->driver->protect_check(p);
102 if (retval != ERROR_OK)
103 return retval;
104
105 command_print(CMD_CTX,
106 "#%d : %s at 0x%8.8" PRIx32 ", size 0x%8.8" PRIx32
107 ", buswidth %i, chipwidth %i",
108 p->bank_number,
109 p->driver->name,
110 p->base,
111 p->size,
112 p->bus_width,
113 p->chip_width);
114
115 prot_block_available = p->num_prot_blocks && p->prot_blocks;
116 if (!show_sectors && prot_block_available) {
117 block_array = p->prot_blocks;
118 num_blocks = p->num_prot_blocks;
119 } else {
120 block_array = p->sectors;
121 num_blocks = p->num_sectors;
122 }
123
124 for (j = 0; j < num_blocks; j++) {
125 char *protect_state = "";
126
127 if (block_array[j].is_protected == 0)
128 protect_state = "not protected";
129 else if (block_array[j].is_protected == 1)
130 protect_state = "protected";
131 else if (!show_sectors || !prot_block_available)
132 protect_state = "protection state unknown";
133
134 command_print(CMD_CTX,
135 "\t#%3i: 0x%8.8" PRIx32 " (0x%" PRIx32 " %" PRIi32 "kB) %s",
136 j,
137 block_array[j].offset,
138 block_array[j].size,
139 block_array[j].size >> 10,
140 protect_state);
141 }
142
143 if (p->driver->info != NULL) {
144 retval = p->driver->info(p, buf, sizeof(buf));
145 if (retval == ERROR_OK)
146 command_print(CMD_CTX, "%s", buf);
147 else
148 LOG_ERROR("error retrieving flash info");
149 }
150 }
151
152 return retval;
153 }
154
155 COMMAND_HANDLER(handle_flash_probe_command)
156 {
157 struct flash_bank *p;
158 int retval;
159
160 if (CMD_ARGC != 1)
161 return ERROR_COMMAND_SYNTAX_ERROR;
162
163 retval = CALL_COMMAND_HANDLER(flash_command_get_bank_maybe_probe, 0, &p, false);
164 if (retval != ERROR_OK)
165 return retval;
166
167 if (p) {
168 retval = p->driver->probe(p);
169 if (retval == ERROR_OK)
170 command_print(CMD_CTX,
171 "flash '%s' found at 0x%8.8" PRIx32,
172 p->driver->name,
173 p->base);
174 } else {
175 command_print(CMD_CTX, "flash bank '#%s' is out of bounds", CMD_ARGV[0]);
176 retval = ERROR_FAIL;
177 }
178
179 return retval;
180 }
181
182 COMMAND_HANDLER(handle_flash_erase_check_command)
183 {
184 bool blank = true;
185 if (CMD_ARGC != 1)
186 return ERROR_COMMAND_SYNTAX_ERROR;
187
188 struct flash_bank *p;
189 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
190 if (ERROR_OK != retval)
191 return retval;
192
193 int j;
194 retval = p->driver->erase_check(p);
195 if (retval == ERROR_OK)
196 command_print(CMD_CTX, "successfully checked erase state");
197 else {
198 command_print(CMD_CTX,
199 "unknown error when checking erase state of flash bank #%s at 0x%8.8" PRIx32,
200 CMD_ARGV[0],
201 p->base);
202 }
203
204 for (j = 0; j < p->num_sectors; j++) {
205 char *erase_state;
206
207 if (p->sectors[j].is_erased == 0)
208 erase_state = "not erased";
209 else if (p->sectors[j].is_erased == 1)
210 continue;
211 else
212 erase_state = "erase state unknown";
213
214 blank = false;
215 command_print(CMD_CTX,
216 "\t#%3i: 0x%8.8" PRIx32 " (0x%" PRIx32 " %" PRIi32 "kB) %s",
217 j,
218 p->sectors[j].offset,
219 p->sectors[j].size,
220 p->sectors[j].size >> 10,
221 erase_state);
222 }
223
224 if (blank)
225 command_print(CMD_CTX, "\tBank is erased");
226 return retval;
227 }
228
229 COMMAND_HANDLER(handle_flash_erase_address_command)
230 {
231 struct flash_bank *p;
232 int retval = ERROR_OK;
233 uint32_t address;
234 uint32_t length;
235 bool do_pad = false;
236 bool do_unlock = false;
237 struct target *target = get_current_target(CMD_CTX);
238
239 while (CMD_ARGC >= 3) {
240 /* Optionally pad out the address range to block/sector
241 * boundaries. We can't know if there's data in that part
242 * of the flash; only do padding if we're told to.
243 */
244 if (strcmp("pad", CMD_ARGV[0]) == 0)
245 do_pad = true;
246 else if (strcmp("unlock", CMD_ARGV[0]) == 0)
247 do_unlock = true;
248 else
249 return ERROR_COMMAND_SYNTAX_ERROR;
250 CMD_ARGC--;
251 CMD_ARGV++;
252 }
253 if (CMD_ARGC != 2)
254 return ERROR_COMMAND_SYNTAX_ERROR;
255
256 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
257 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
258
259 if (length <= 0) {
260 command_print(CMD_CTX, "Length must be >0");
261 return ERROR_COMMAND_SYNTAX_ERROR;
262 }
263
264 retval = get_flash_bank_by_addr(target, address, true, &p);
265 if (retval != ERROR_OK)
266 return retval;
267
268 /* We can't know if we did a resume + halt, in which case we no longer know the erased state
269 **/
270 flash_set_dirty();
271
272 struct duration bench;
273 duration_start(&bench);
274
275 if (do_unlock)
276 retval = flash_unlock_address_range(target, address, length);
277
278 if (retval == ERROR_OK)
279 retval = flash_erase_address_range(target, do_pad, address, length);
280
281 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
282 command_print(CMD_CTX, "erased address 0x%8.8" PRIx32 " (length %" PRIi32 ")"
283 " in %fs (%0.3f KiB/s)", address, length,
284 duration_elapsed(&bench), duration_kbps(&bench, length));
285 }
286
287 return retval;
288 }
289
290 static int flash_check_sector_parameters(struct command_context *cmd_ctx,
291 uint32_t first, uint32_t last, uint32_t num_sectors)
292 {
293 if (!(first <= last)) {
294 command_print(cmd_ctx, "ERROR: "
295 "first sector must be <= last sector");
296 return ERROR_FAIL;
297 }
298
299 if (!(last <= (num_sectors - 1))) {
300 command_print(cmd_ctx, "ERROR: last sector must be <= %" PRIu32,
301 num_sectors - 1);
302 return ERROR_FAIL;
303 }
304
305 return ERROR_OK;
306 }
307
308 COMMAND_HANDLER(handle_flash_erase_command)
309 {
310 if (CMD_ARGC != 3)
311 return ERROR_COMMAND_SYNTAX_ERROR;
312
313 uint32_t first;
314 uint32_t last;
315
316 struct flash_bank *p;
317 int retval;
318
319 retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
320 if (retval != ERROR_OK)
321 return retval;
322
323 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], first);
324 if (strcmp(CMD_ARGV[2], "last") == 0)
325 last = p->num_sectors - 1;
326 else
327 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], last);
328
329 retval = flash_check_sector_parameters(CMD_CTX, first, last, p->num_sectors);
330 if (retval != ERROR_OK)
331 return retval;
332
333 struct duration bench;
334 duration_start(&bench);
335
336 retval = flash_driver_erase(p, first, last);
337
338 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
339 command_print(CMD_CTX, "erased sectors %" PRIu32 " "
340 "through %" PRIu32 " on flash bank %d "
341 "in %fs", first, last, p->bank_number, duration_elapsed(&bench));
342 }
343
344 return retval;
345 }
346
347 COMMAND_HANDLER(handle_flash_protect_command)
348 {
349 if (CMD_ARGC != 4)
350 return ERROR_COMMAND_SYNTAX_ERROR;
351
352 uint32_t first;
353 uint32_t last;
354
355 struct flash_bank *p;
356 int retval;
357 int num_blocks;
358
359 retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
360 if (retval != ERROR_OK)
361 return retval;
362
363 if (p->num_prot_blocks)
364 num_blocks = p->num_prot_blocks;
365 else
366 num_blocks = p->num_sectors;
367
368 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], first);
369 if (strcmp(CMD_ARGV[2], "last") == 0)
370 last = num_blocks - 1;
371 else
372 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], last);
373
374 bool set;
375 COMMAND_PARSE_ON_OFF(CMD_ARGV[3], set);
376
377 retval = flash_check_sector_parameters(CMD_CTX, first, last, num_blocks);
378 if (retval != ERROR_OK)
379 return retval;
380
381 retval = flash_driver_protect(p, set, first, last);
382 if (retval == ERROR_OK) {
383 command_print(CMD_CTX, "%s protection for sectors %" PRIu32
384 " through %" PRIu32 " on flash bank %d",
385 (set) ? "set" : "cleared", first, last, p->bank_number);
386 }
387
388 return retval;
389 }
390
391 COMMAND_HANDLER(handle_flash_write_image_command)
392 {
393 struct target *target = get_current_target(CMD_CTX);
394
395 struct image image;
396 uint32_t written;
397
398 int retval;
399
400 /* flash auto-erase is disabled by default*/
401 int auto_erase = 0;
402 bool auto_unlock = false;
403
404 while (CMD_ARGC) {
405 if (strcmp(CMD_ARGV[0], "erase") == 0) {
406 auto_erase = 1;
407 CMD_ARGV++;
408 CMD_ARGC--;
409 command_print(CMD_CTX, "auto erase enabled");
410 } else if (strcmp(CMD_ARGV[0], "unlock") == 0) {
411 auto_unlock = true;
412 CMD_ARGV++;
413 CMD_ARGC--;
414 command_print(CMD_CTX, "auto unlock enabled");
415 } else
416 break;
417 }
418
419 if (CMD_ARGC < 1)
420 return ERROR_COMMAND_SYNTAX_ERROR;
421
422 if (!target) {
423 LOG_ERROR("no target selected");
424 return ERROR_FAIL;
425 }
426
427 struct duration bench;
428 duration_start(&bench);
429
430 if (CMD_ARGC >= 2) {
431 image.base_address_set = 1;
432 COMMAND_PARSE_NUMBER(llong, CMD_ARGV[1], image.base_address);
433 } else {
434 image.base_address_set = 0;
435 image.base_address = 0x0;
436 }
437
438 image.start_address_set = 0;
439
440 retval = image_open(&image, CMD_ARGV[0], (CMD_ARGC == 3) ? CMD_ARGV[2] : NULL);
441 if (retval != ERROR_OK)
442 return retval;
443
444 retval = flash_write_unlock(target, &image, &written, auto_erase, auto_unlock);
445 if (retval != ERROR_OK) {
446 image_close(&image);
447 return retval;
448 }
449
450 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
451 command_print(CMD_CTX, "wrote %" PRIu32 " bytes from file %s "
452 "in %fs (%0.3f KiB/s)", written, CMD_ARGV[0],
453 duration_elapsed(&bench), duration_kbps(&bench, written));
454 }
455
456 image_close(&image);
457
458 return retval;
459 }
460
461 COMMAND_HANDLER(handle_flash_fill_command)
462 {
463 int err = ERROR_OK;
464 uint32_t address;
465 uint32_t pattern;
466 uint32_t count;
467 uint32_t wrote = 0;
468 uint32_t cur_size = 0;
469 uint32_t chunk_count;
470 struct target *target = get_current_target(CMD_CTX);
471 unsigned i;
472 uint32_t wordsize;
473 int retval = ERROR_OK;
474
475 static size_t const chunksize = 1024;
476 uint8_t *chunk = NULL, *readback = NULL;
477
478 if (CMD_ARGC != 3) {
479 retval = ERROR_COMMAND_SYNTAX_ERROR;
480 goto done;
481 }
482
483 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
484 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], pattern);
485 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], count);
486
487 chunk = malloc(chunksize);
488 if (chunk == NULL)
489 return ERROR_FAIL;
490
491 readback = malloc(chunksize);
492 if (readback == NULL) {
493 free(chunk);
494 return ERROR_FAIL;
495 }
496
497 if (count == 0)
498 goto done;
499
500 switch (CMD_NAME[4]) {
501 case 'w':
502 wordsize = 4;
503 break;
504 case 'h':
505 wordsize = 2;
506 break;
507 case 'b':
508 wordsize = 1;
509 break;
510 default:
511 retval = ERROR_COMMAND_SYNTAX_ERROR;
512 goto done;
513 }
514
515 chunk_count = MIN(count, (chunksize / wordsize));
516 switch (wordsize) {
517 case 4:
518 for (i = 0; i < chunk_count; i++)
519 target_buffer_set_u32(target, chunk + i * wordsize, pattern);
520 break;
521 case 2:
522 for (i = 0; i < chunk_count; i++)
523 target_buffer_set_u16(target, chunk + i * wordsize, pattern);
524 break;
525 case 1:
526 memset(chunk, pattern, chunk_count);
527 break;
528 default:
529 LOG_ERROR("BUG: can't happen");
530 exit(-1);
531 }
532
533 struct duration bench;
534 duration_start(&bench);
535
536 for (wrote = 0; wrote < (count*wordsize); wrote += cur_size) {
537 struct flash_bank *bank;
538
539 retval = get_flash_bank_by_addr(target, address, true, &bank);
540 if (retval != ERROR_OK)
541 goto done;
542
543 cur_size = MIN((count * wordsize - wrote), chunksize);
544 err = flash_driver_write(bank, chunk, address - bank->base + wrote, cur_size);
545 if (err != ERROR_OK) {
546 retval = err;
547 goto done;
548 }
549
550 err = flash_driver_read(bank, readback, address - bank->base + wrote, cur_size);
551 if (err != ERROR_OK) {
552 retval = err;
553 goto done;
554 }
555
556 for (i = 0; i < cur_size; i++) {
557 if (readback[i] != chunk[i]) {
558 LOG_ERROR(
559 "Verification error address 0x%08" PRIx32 ", read back 0x%02x, expected 0x%02x",
560 address + wrote + i,
561 readback[i],
562 chunk[i]);
563 retval = ERROR_FAIL;
564 goto done;
565 }
566 }
567 }
568
569 if ((retval == ERROR_OK) && (duration_measure(&bench) == ERROR_OK)) {
570 command_print(CMD_CTX, "wrote %" PRIu32 " bytes to 0x%8.8" PRIx32
571 " in %fs (%0.3f KiB/s)", wrote, address,
572 duration_elapsed(&bench), duration_kbps(&bench, wrote));
573 }
574
575 done:
576 free(readback);
577 free(chunk);
578
579 return retval;
580 }
581
582 COMMAND_HANDLER(handle_flash_write_bank_command)
583 {
584 uint32_t offset;
585 uint8_t *buffer;
586 struct fileio *fileio;
587
588 if (CMD_ARGC != 3)
589 return ERROR_COMMAND_SYNTAX_ERROR;
590
591 struct duration bench;
592 duration_start(&bench);
593
594 struct flash_bank *p;
595 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
596 if (ERROR_OK != retval)
597 return retval;
598
599 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset);
600
601 if (fileio_open(&fileio, CMD_ARGV[1], FILEIO_READ, FILEIO_BINARY) != ERROR_OK)
602 return ERROR_FAIL;
603
604 size_t filesize;
605 retval = fileio_size(fileio, &filesize);
606 if (retval != ERROR_OK) {
607 fileio_close(fileio);
608 return retval;
609 }
610
611 buffer = malloc(filesize);
612 if (buffer == NULL) {
613 fileio_close(fileio);
614 LOG_ERROR("Out of memory");
615 return ERROR_FAIL;
616 }
617 size_t buf_cnt;
618 if (fileio_read(fileio, filesize, buffer, &buf_cnt) != ERROR_OK) {
619 free(buffer);
620 fileio_close(fileio);
621 return ERROR_FAIL;
622 }
623
624 retval = flash_driver_write(p, buffer, offset, buf_cnt);
625
626 free(buffer);
627 buffer = NULL;
628
629 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
630 command_print(CMD_CTX, "wrote %zu bytes from file %s to flash bank %u"
631 " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)",
632 filesize, CMD_ARGV[1], p->bank_number, offset,
633 duration_elapsed(&bench), duration_kbps(&bench, filesize));
634 }
635
636 fileio_close(fileio);
637
638 return retval;
639 }
640
641 COMMAND_HANDLER(handle_flash_read_bank_command)
642 {
643 uint32_t offset;
644 uint8_t *buffer;
645 struct fileio *fileio;
646 uint32_t length;
647 size_t written;
648
649 if (CMD_ARGC != 4)
650 return ERROR_COMMAND_SYNTAX_ERROR;
651
652 struct duration bench;
653 duration_start(&bench);
654
655 struct flash_bank *p;
656 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
657 if (ERROR_OK != retval)
658 return retval;
659
660 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset);
661 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[3], length);
662
663 buffer = malloc(length);
664 if (buffer == NULL) {
665 LOG_ERROR("Out of memory");
666 return ERROR_FAIL;
667 }
668
669 retval = flash_driver_read(p, buffer, offset, length);
670 if (retval != ERROR_OK) {
671 LOG_ERROR("Read error");
672 free(buffer);
673 return retval;
674 }
675
676 retval = fileio_open(&fileio, CMD_ARGV[1], FILEIO_WRITE, FILEIO_BINARY);
677 if (retval != ERROR_OK) {
678 LOG_ERROR("Could not open file");
679 free(buffer);
680 return retval;
681 }
682
683 retval = fileio_write(fileio, length, buffer, &written);
684 fileio_close(fileio);
685 free(buffer);
686 if (retval != ERROR_OK) {
687 LOG_ERROR("Could not write file");
688 return ERROR_FAIL;
689 }
690
691 if (duration_measure(&bench) == ERROR_OK)
692 command_print(CMD_CTX, "wrote %zd bytes to file %s from flash bank %u"
693 " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)",
694 written, CMD_ARGV[1], p->bank_number, offset,
695 duration_elapsed(&bench), duration_kbps(&bench, written));
696
697 return retval;
698 }
699
700
701 COMMAND_HANDLER(handle_flash_verify_bank_command)
702 {
703 uint32_t offset;
704 uint8_t *buffer_file, *buffer_flash;
705 struct fileio *fileio;
706 size_t read_cnt;
707 size_t filesize;
708 size_t length;
709 int differ;
710
711 if (CMD_ARGC < 2 || CMD_ARGC > 3)
712 return ERROR_COMMAND_SYNTAX_ERROR;
713
714 struct duration bench;
715 duration_start(&bench);
716
717 struct flash_bank *p;
718 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
719 if (ERROR_OK != retval)
720 return retval;
721
722 offset = 0;
723
724 if (CMD_ARGC > 2)
725 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset);
726
727 if (offset > p->size) {
728 LOG_ERROR("Offset 0x%8.8" PRIx32 " is out of range of the flash bank",
729 offset);
730 return ERROR_COMMAND_ARGUMENT_INVALID;
731 }
732
733 retval = fileio_open(&fileio, CMD_ARGV[1], FILEIO_READ, FILEIO_BINARY);
734 if (retval != ERROR_OK) {
735 LOG_ERROR("Could not open file");
736 return retval;
737 }
738
739 retval = fileio_size(fileio, &filesize);
740 if (retval != ERROR_OK) {
741 fileio_close(fileio);
742 return retval;
743 }
744
745 length = MIN(filesize, p->size - offset);
746
747 if (!length) {
748 LOG_INFO("Nothing to compare with flash bank");
749 fileio_close(fileio);
750 return ERROR_OK;
751 }
752
753 if (length != filesize)
754 LOG_INFO("File content exceeds flash bank size. Only comparing the "
755 "first %zu bytes of the file", length);
756
757 buffer_file = malloc(length);
758 if (buffer_file == NULL) {
759 LOG_ERROR("Out of memory");
760 fileio_close(fileio);
761 return ERROR_FAIL;
762 }
763
764 retval = fileio_read(fileio, length, buffer_file, &read_cnt);
765 fileio_close(fileio);
766 if (retval != ERROR_OK) {
767 LOG_ERROR("File read failure");
768 free(buffer_file);
769 return retval;
770 }
771
772 if (read_cnt != length) {
773 LOG_ERROR("Short read");
774 free(buffer_file);
775 return ERROR_FAIL;
776 }
777
778 buffer_flash = malloc(length);
779 if (buffer_flash == NULL) {
780 LOG_ERROR("Out of memory");
781 free(buffer_file);
782 return ERROR_FAIL;
783 }
784
785 retval = flash_driver_read(p, buffer_flash, offset, length);
786 if (retval != ERROR_OK) {
787 LOG_ERROR("Flash read error");
788 free(buffer_flash);
789 free(buffer_file);
790 return retval;
791 }
792
793 if (duration_measure(&bench) == ERROR_OK)
794 command_print(CMD_CTX, "read %zd bytes from file %s and flash bank %u"
795 " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)",
796 length, CMD_ARGV[1], p->bank_number, offset,
797 duration_elapsed(&bench), duration_kbps(&bench, length));
798
799 differ = memcmp(buffer_file, buffer_flash, length);
800 command_print(CMD_CTX, "contents %s", differ ? "differ" : "match");
801 if (differ) {
802 uint32_t t;
803 int diffs = 0;
804 for (t = 0; t < length; t++) {
805 if (buffer_flash[t] == buffer_file[t])
806 continue;
807 command_print(CMD_CTX, "diff %d address 0x%08x. Was 0x%02x instead of 0x%02x",
808 diffs, t + offset, buffer_flash[t], buffer_file[t]);
809 if (diffs++ >= 127) {
810 command_print(CMD_CTX, "More than 128 errors, the rest are not printed.");
811 break;
812 }
813 keep_alive();
814 }
815 }
816 free(buffer_flash);
817 free(buffer_file);
818
819 return differ ? ERROR_FAIL : ERROR_OK;
820 }
821
822 void flash_set_dirty(void)
823 {
824 struct flash_bank *c;
825 int i;
826
827 /* set all flash to require erasing */
828 for (c = flash_bank_list(); c; c = c->next) {
829 for (i = 0; i < c->num_sectors; i++)
830 c->sectors[i].is_erased = 0;
831 }
832 }
833
834 COMMAND_HANDLER(handle_flash_padded_value_command)
835 {
836 if (CMD_ARGC != 2)
837 return ERROR_COMMAND_SYNTAX_ERROR;
838
839 struct flash_bank *p;
840 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
841 if (ERROR_OK != retval)
842 return retval;
843
844 COMMAND_PARSE_NUMBER(u8, CMD_ARGV[1], p->default_padded_value);
845
846 command_print(CMD_CTX, "Default padded value set to 0x%" PRIx8 " for flash bank %u", \
847 p->default_padded_value, p->bank_number);
848
849 return retval;
850 }
851
852 static const struct command_registration flash_exec_command_handlers[] = {
853 {
854 .name = "probe",
855 .handler = handle_flash_probe_command,
856 .mode = COMMAND_EXEC,
857 .usage = "bank_id",
858 .help = "Identify a flash bank.",
859 },
860 {
861 .name = "info",
862 .handler = handle_flash_info_command,
863 .mode = COMMAND_EXEC,
864 .usage = "bank_id ['sectors']",
865 .help = "Print information about a flash bank.",
866 },
867 {
868 .name = "erase_check",
869 .handler = handle_flash_erase_check_command,
870 .mode = COMMAND_EXEC,
871 .usage = "bank_id",
872 .help = "Check erase state of all blocks in a "
873 "flash bank.",
874 },
875 {
876 .name = "erase_sector",
877 .handler = handle_flash_erase_command,
878 .mode = COMMAND_EXEC,
879 .usage = "bank_id first_sector_num last_sector_num",
880 .help = "Erase a range of sectors in a flash bank.",
881 },
882 {
883 .name = "erase_address",
884 .handler = handle_flash_erase_address_command,
885 .mode = COMMAND_EXEC,
886 .usage = "['pad'] ['unlock'] address length",
887 .help = "Erase flash sectors starting at address and "
888 "continuing for length bytes. If 'pad' is specified, "
889 "data outside that range may also be erased: the start "
890 "address may be decreased, and length increased, so "
891 "that all of the first and last sectors are erased. "
892 "If 'unlock' is specified, then the flash is unprotected "
893 "before erasing.",
894
895 },
896 {
897 .name = "fillw",
898 .handler = handle_flash_fill_command,
899 .mode = COMMAND_EXEC,
900 .usage = "address value n",
901 .help = "Fill n words with 32-bit value, starting at "
902 "word address. (No autoerase.)",
903 },
904 {
905 .name = "fillh",
906 .handler = handle_flash_fill_command,
907 .mode = COMMAND_EXEC,
908 .usage = "address value n",
909 .help = "Fill n halfwords with 16-bit value, starting at "
910 "word address. (No autoerase.)",
911 },
912 {
913 .name = "fillb",
914 .handler = handle_flash_fill_command,
915 .mode = COMMAND_EXEC,
916 .usage = "address value n",
917 .help = "Fill n bytes with 8-bit value, starting at "
918 "word address. (No autoerase.)",
919 },
920 {
921 .name = "write_bank",
922 .handler = handle_flash_write_bank_command,
923 .mode = COMMAND_EXEC,
924 .usage = "bank_id filename offset",
925 .help = "Write binary data from file to flash bank, "
926 "starting at specified byte offset from the "
927 "beginning of the bank.",
928 },
929 {
930 .name = "write_image",
931 .handler = handle_flash_write_image_command,
932 .mode = COMMAND_EXEC,
933 .usage = "[erase] [unlock] filename [offset [file_type]]",
934 .help = "Write an image to flash. Optionally first unprotect "
935 "and/or erase the region to be used. Allow optional "
936 "offset from beginning of bank (defaults to zero)",
937 },
938 {
939 .name = "read_bank",
940 .handler = handle_flash_read_bank_command,
941 .mode = COMMAND_EXEC,
942 .usage = "bank_id filename offset length",
943 .help = "Read binary data from flash bank to file, "
944 "starting at specified byte offset from the "
945 "beginning of the bank.",
946 },
947 {
948 .name = "verify_bank",
949 .handler = handle_flash_verify_bank_command,
950 .mode = COMMAND_EXEC,
951 .usage = "bank_id filename [offset]",
952 .help = "Compare the contents of a file with the contents of the "
953 "flash bank. Allow optional offset from beginning of the bank "
954 "(defaults to zero).",
955 },
956 {
957 .name = "protect",
958 .handler = handle_flash_protect_command,
959 .mode = COMMAND_EXEC,
960 .usage = "bank_id first_block [last_block|'last'] "
961 "('on'|'off')",
962 .help = "Turn protection on or off for a range of protection "
963 "blocks or sectors in a given flash bank. "
964 "See 'flash info' output for a list of blocks.",
965 },
966 {
967 .name = "padded_value",
968 .handler = handle_flash_padded_value_command,
969 .mode = COMMAND_EXEC,
970 .usage = "bank_id value",
971 .help = "Set default flash padded value",
972 },
973 COMMAND_REGISTRATION_DONE
974 };
975
976 static int flash_init_drivers(struct command_context *cmd_ctx)
977 {
978 if (!flash_bank_list())
979 return ERROR_OK;
980
981 struct command *parent = command_find_in_context(cmd_ctx, "flash");
982 return register_commands(cmd_ctx, parent, flash_exec_command_handlers);
983 }
984
985 COMMAND_HANDLER(handle_flash_bank_command)
986 {
987 if (CMD_ARGC < 7) {
988 LOG_ERROR("usage: flash bank <name> <driver> "
989 "<base> <size> <chip_width> <bus_width> <target>");
990 return ERROR_COMMAND_SYNTAX_ERROR;
991 }
992 /* save bank name and advance arguments for compatibility */
993 const char *bank_name = *CMD_ARGV++;
994 CMD_ARGC--;
995
996 struct target *target = get_target(CMD_ARGV[5]);
997 if (target == NULL) {
998 LOG_ERROR("target '%s' not defined", CMD_ARGV[5]);
999 return ERROR_FAIL;
1000 }
1001
1002 const char *driver_name = CMD_ARGV[0];
1003 struct flash_driver *driver = flash_driver_find_by_name(driver_name);
1004 if (NULL == driver) {
1005 /* no matching flash driver found */
1006 LOG_ERROR("flash driver '%s' not found", driver_name);
1007 return ERROR_FAIL;
1008 }
1009
1010 /* check the flash bank name is unique */
1011 if (get_flash_bank_by_name_noprobe(bank_name) != NULL) {
1012 /* flash bank name already exists */
1013 LOG_ERROR("flash bank name '%s' already exists", bank_name);
1014 return ERROR_FAIL;
1015 }
1016
1017 /* register flash specific commands */
1018 if (NULL != driver->commands) {
1019 int retval = register_commands(CMD_CTX, NULL,
1020 driver->commands);
1021 if (ERROR_OK != retval) {
1022 LOG_ERROR("couldn't register '%s' commands",
1023 driver_name);
1024 return ERROR_FAIL;
1025 }
1026 }
1027
1028 struct flash_bank *c = malloc(sizeof(*c));
1029 c->name = strdup(bank_name);
1030 c->target = target;
1031 c->driver = driver;
1032 c->driver_priv = NULL;
1033 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], c->base);
1034 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], c->size);
1035 COMMAND_PARSE_NUMBER(int, CMD_ARGV[3], c->chip_width);
1036 COMMAND_PARSE_NUMBER(int, CMD_ARGV[4], c->bus_width);
1037 c->default_padded_value = c->erased_value = 0xff;
1038 c->num_sectors = 0;
1039 c->sectors = NULL;
1040 c->num_prot_blocks = 0;
1041 c->prot_blocks = NULL;
1042 c->next = NULL;
1043
1044 int retval;
1045 retval = CALL_COMMAND_HANDLER(driver->flash_bank_command, c);
1046 if (ERROR_OK != retval) {
1047 LOG_ERROR("'%s' driver rejected flash bank at 0x%8.8" PRIx32 "; usage: %s",
1048 driver_name, c->base, driver->usage);
1049 free(c);
1050 return retval;
1051 }
1052
1053 if (driver->usage == NULL)
1054 LOG_DEBUG("'%s' driver usage field missing", driver_name);
1055
1056 flash_bank_add(c);
1057
1058 return ERROR_OK;
1059 }
1060
1061 COMMAND_HANDLER(handle_flash_banks_command)
1062 {
1063 if (CMD_ARGC != 0)
1064 return ERROR_COMMAND_SYNTAX_ERROR;
1065
1066 unsigned n = 0;
1067 for (struct flash_bank *p = flash_bank_list(); p; p = p->next, n++) {
1068 LOG_USER("#%d : %s (%s) at 0x%8.8" PRIx32 ", size 0x%8.8" PRIx32 ", "
1069 "buswidth %u, chipwidth %u", p->bank_number,
1070 p->name, p->driver->name, p->base, p->size,
1071 p->bus_width, p->chip_width);
1072 }
1073 return ERROR_OK;
1074 }
1075
1076 static int jim_flash_list(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
1077 {
1078 if (argc != 1) {
1079 Jim_WrongNumArgs(interp, 1, argv,
1080 "no arguments to 'flash list' command");
1081 return JIM_ERR;
1082 }
1083
1084 Jim_Obj *list = Jim_NewListObj(interp, NULL, 0);
1085
1086 for (struct flash_bank *p = flash_bank_list(); p; p = p->next) {
1087 Jim_Obj *elem = Jim_NewListObj(interp, NULL, 0);
1088
1089 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "name", -1));
1090 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, p->driver->name, -1));
1091 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "base", -1));
1092 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->base));
1093 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "size", -1));
1094 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->size));
1095 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "bus_width", -1));
1096 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->bus_width));
1097 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "chip_width", -1));
1098 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->chip_width));
1099
1100 Jim_ListAppendElement(interp, list, elem);
1101 }
1102
1103 Jim_SetResult(interp, list);
1104
1105 return JIM_OK;
1106 }
1107
1108 COMMAND_HANDLER(handle_flash_init_command)
1109 {
1110 if (CMD_ARGC != 0)
1111 return ERROR_COMMAND_SYNTAX_ERROR;
1112
1113 static bool flash_initialized;
1114 if (flash_initialized) {
1115 LOG_INFO("'flash init' has already been called");
1116 return ERROR_OK;
1117 }
1118 flash_initialized = true;
1119
1120 LOG_DEBUG("Initializing flash devices...");
1121 return flash_init_drivers(CMD_CTX);
1122 }
1123
1124 static const struct command_registration flash_config_command_handlers[] = {
1125 {
1126 .name = "bank",
1127 .handler = handle_flash_bank_command,
1128 .mode = COMMAND_CONFIG,
1129 .usage = "bank_id driver_name base_address size_bytes "
1130 "chip_width_bytes bus_width_bytes target "
1131 "[driver_options ...]",
1132 .help = "Define a new bank with the given name, "
1133 "using the specified NOR flash driver.",
1134 },
1135 {
1136 .name = "init",
1137 .mode = COMMAND_CONFIG,
1138 .handler = handle_flash_init_command,
1139 .help = "Initialize flash devices.",
1140 },
1141 {
1142 .name = "banks",
1143 .mode = COMMAND_ANY,
1144 .handler = handle_flash_banks_command,
1145 .help = "Display table with information about flash banks.",
1146 },
1147 {
1148 .name = "list",
1149 .mode = COMMAND_ANY,
1150 .jim_handler = jim_flash_list,
1151 .help = "Returns a list of details about the flash banks.",
1152 },
1153 COMMAND_REGISTRATION_DONE
1154 };
1155 static const struct command_registration flash_command_handlers[] = {
1156 {
1157 .name = "flash",
1158 .mode = COMMAND_ANY,
1159 .help = "NOR flash command group",
1160 .chain = flash_config_command_handlers,
1161 },
1162 COMMAND_REGISTRATION_DONE
1163 };
1164
1165 int flash_register_commands(struct command_context *cmd_ctx)
1166 {
1167 return register_commands(cmd_ctx, NULL, flash_command_handlers);
1168 }
Open On-Chip Debugger

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)