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 * Copyright (C) 2017-2018 Tomas Vanek <vanekt@fbl.cz> *
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. *
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. *
18 * You should have received a copy of the GNU General Public License *
19 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
20 ***************************************************************************/
25 #include <helper/time_support.h>
26 #include <target/image.h>
30 * Implements Tcl commands used to access NOR flash facilities.
33 COMMAND_HELPER(flash_command_get_bank_maybe_probe, unsigned name_index,
34 struct flash_bank **bank, bool do_probe)
36 const char *name = CMD_ARGV[name_index];
39 retval = get_flash_bank_by_name(name, bank);
41 *bank = get_flash_bank_by_name_noprobe(name);
45 if (retval != ERROR_OK)
51 COMMAND_PARSE_NUMBER(uint, name, bank_num);
54 return get_flash_bank_by_num(bank_num, bank);
56 *bank = get_flash_bank_by_num_noprobe(bank_num);
57 retval = (bank) ? ERROR_OK : ERROR_FAIL;
62 COMMAND_HELPER(flash_command_get_bank, unsigned name_index,
63 struct flash_bank **bank)
65 return CALL_COMMAND_HANDLER(flash_command_get_bank_maybe_probe,
66 name_index, bank, true);
69 COMMAND_HANDLER(handle_flash_info_command)
74 bool show_sectors = false;
75 bool prot_block_available;
77 if (CMD_ARGC < 1 || CMD_ARGC > 2)
78 return ERROR_COMMAND_SYNTAX_ERROR;
81 if (strcmp("sectors", CMD_ARGV[1]) == 0)
84 return ERROR_COMMAND_SYNTAX_ERROR;
87 retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
88 if (retval != ERROR_OK)
94 struct flash_sector *block_array;
96 /* attempt auto probe */
97 retval = p->driver->auto_probe(p);
98 if (retval != ERROR_OK)
101 /* If the driver does not implement protection, we show the default
102 * state of is_protected array - usually protection state unknown */
103 if (p->driver->protect_check == NULL) {
104 retval = ERROR_FLASH_OPER_UNSUPPORTED;
106 /* We must query the hardware to avoid printing stale information! */
107 retval = p->driver->protect_check(p);
108 if (retval != ERROR_OK && retval != ERROR_FLASH_OPER_UNSUPPORTED)
111 if (retval == ERROR_FLASH_OPER_UNSUPPORTED)
112 LOG_WARNING("Flash protection check is not implemented.");
115 "#%d : %s at " TARGET_ADDR_FMT ", size 0x%8.8" PRIx32
116 ", buswidth %i, chipwidth %i",
124 prot_block_available = p->num_prot_blocks && p->prot_blocks;
125 if (!show_sectors && prot_block_available) {
126 block_array = p->prot_blocks;
127 num_blocks = p->num_prot_blocks;
129 block_array = p->sectors;
130 num_blocks = p->num_sectors;
133 for (j = 0; j < num_blocks; j++) {
134 char *protect_state = "";
136 if (block_array[j].is_protected == 0)
137 protect_state = "not protected";
138 else if (block_array[j].is_protected == 1)
139 protect_state = "protected";
140 else if (!show_sectors || !prot_block_available)
141 protect_state = "protection state unknown";
144 "\t#%3i: 0x%8.8" PRIx32 " (0x%" PRIx32 " %" PRIi32 "kB) %s",
146 block_array[j].offset,
148 block_array[j].size >> 10,
152 if (p->driver->info != NULL) {
153 retval = p->driver->info(p, buf, sizeof(buf));
154 if (retval == ERROR_OK)
155 command_print(CMD, "%s", buf);
157 LOG_ERROR("error retrieving flash info");
164 COMMAND_HANDLER(handle_flash_probe_command)
166 struct flash_bank *p;
170 return ERROR_COMMAND_SYNTAX_ERROR;
172 retval = CALL_COMMAND_HANDLER(flash_command_get_bank_maybe_probe, 0, &p, false);
173 if (retval != ERROR_OK)
177 retval = p->driver->probe(p);
178 if (retval == ERROR_OK)
180 "flash '%s' found at " TARGET_ADDR_FMT,
184 command_print(CMD, "flash bank '#%s' is out of bounds", CMD_ARGV[0]);
191 COMMAND_HANDLER(handle_flash_erase_check_command)
195 return ERROR_COMMAND_SYNTAX_ERROR;
197 struct flash_bank *p;
198 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
199 if (ERROR_OK != retval)
203 retval = p->driver->erase_check(p);
204 if (retval == ERROR_OK)
205 command_print(CMD, "successfully checked erase state");
208 "unknown error when checking erase state of flash bank #%s at "
214 for (j = 0; j < p->num_sectors; j++) {
217 if (p->sectors[j].is_erased == 0)
218 erase_state = "not erased";
219 else if (p->sectors[j].is_erased == 1)
222 erase_state = "erase state unknown";
226 "\t#%3i: 0x%8.8" PRIx32 " (0x%" PRIx32 " %" PRIi32 "kB) %s",
228 p->sectors[j].offset,
230 p->sectors[j].size >> 10,
235 command_print(CMD, "\tBank is erased");
239 COMMAND_HANDLER(handle_flash_erase_address_command)
241 struct flash_bank *p;
242 int retval = ERROR_OK;
243 target_addr_t address;
246 bool do_unlock = false;
247 struct target *target = get_current_target(CMD_CTX);
249 while (CMD_ARGC >= 3) {
250 /* Optionally pad out the address range to block/sector
251 * boundaries. We can't know if there's data in that part
252 * of the flash; only do padding if we're told to.
254 if (strcmp("pad", CMD_ARGV[0]) == 0)
256 else if (strcmp("unlock", CMD_ARGV[0]) == 0)
259 return ERROR_COMMAND_SYNTAX_ERROR;
264 return ERROR_COMMAND_SYNTAX_ERROR;
266 COMMAND_PARSE_ADDRESS(CMD_ARGV[0], address);
267 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
270 command_print(CMD, "Length must be >0");
271 return ERROR_COMMAND_SYNTAX_ERROR;
274 retval = get_flash_bank_by_addr(target, address, true, &p);
275 if (retval != ERROR_OK)
278 /* We can't know if we did a resume + halt, in which case we no longer know the erased state
282 struct duration bench;
283 duration_start(&bench);
286 retval = flash_unlock_address_range(target, address, length);
288 if (retval == ERROR_OK)
289 retval = flash_erase_address_range(target, do_pad, address, length);
291 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
292 command_print(CMD, "erased address " TARGET_ADDR_FMT " (length %"
294 " in %fs (%0.3f KiB/s)", address, length,
295 duration_elapsed(&bench), duration_kbps(&bench, length));
301 COMMAND_HANDLER(handle_flash_erase_command)
304 return ERROR_COMMAND_SYNTAX_ERROR;
309 struct flash_bank *p;
312 retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
313 if (retval != ERROR_OK)
316 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], first);
317 if (strcmp(CMD_ARGV[2], "last") == 0)
318 last = p->num_sectors - 1;
320 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], last);
322 if (!(first <= last)) {
323 command_print(CMD, "ERROR: "
324 "first sector must be <= last");
328 if (!(last <= (uint32_t)(p->num_sectors - 1))) {
329 command_print(CMD, "ERROR: "
330 "last sector must be <= %" PRIu32,
335 struct duration bench;
336 duration_start(&bench);
338 retval = flash_driver_erase(p, first, last);
340 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
341 command_print(CMD, "erased sectors %" PRIu32 " "
342 "through %" PRIu32 " on flash bank %d "
343 "in %fs", first, last, p->bank_number, duration_elapsed(&bench));
349 COMMAND_HANDLER(handle_flash_protect_command)
352 return ERROR_COMMAND_SYNTAX_ERROR;
357 struct flash_bank *p;
361 retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
362 if (retval != ERROR_OK)
365 if (p->num_prot_blocks)
366 num_blocks = p->num_prot_blocks;
368 num_blocks = p->num_sectors;
370 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], first);
371 if (strcmp(CMD_ARGV[2], "last") == 0)
372 last = num_blocks - 1;
374 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], last);
377 COMMAND_PARSE_ON_OFF(CMD_ARGV[3], set);
379 if (!(first <= last)) {
380 command_print(CMD, "ERROR: "
381 "first %s must be <= last",
382 (p->num_prot_blocks) ? "block" : "sector");
386 if (!(last <= (uint32_t)(num_blocks - 1))) {
387 command_print(CMD, "ERROR: "
388 "last %s must be <= %" PRIu32,
389 (p->num_prot_blocks) ? "block" : "sector",
394 retval = flash_driver_protect(p, set, first, last);
395 if (retval == ERROR_OK) {
396 command_print(CMD, "%s protection for %s %" PRIu32
397 " through %" PRIu32 " on flash bank %d",
398 (set) ? "set" : "cleared",
399 (p->num_prot_blocks) ? "blocks" : "sectors",
400 first, last, p->bank_number);
406 COMMAND_HANDLER(handle_flash_write_image_command)
408 struct target *target = get_current_target(CMD_CTX);
415 /* flash auto-erase is disabled by default*/
417 bool auto_unlock = false;
420 if (strcmp(CMD_ARGV[0], "erase") == 0) {
424 command_print(CMD, "auto erase enabled");
425 } else if (strcmp(CMD_ARGV[0], "unlock") == 0) {
429 command_print(CMD, "auto unlock enabled");
435 return ERROR_COMMAND_SYNTAX_ERROR;
438 LOG_ERROR("no target selected");
442 struct duration bench;
443 duration_start(&bench);
446 image.base_address_set = 1;
447 COMMAND_PARSE_NUMBER(llong, CMD_ARGV[1], image.base_address);
449 image.base_address_set = 0;
450 image.base_address = 0x0;
453 image.start_address_set = 0;
455 retval = image_open(&image, CMD_ARGV[0], (CMD_ARGC == 3) ? CMD_ARGV[2] : NULL);
456 if (retval != ERROR_OK)
459 retval = flash_write_unlock(target, &image, &written, auto_erase, auto_unlock);
460 if (retval != ERROR_OK) {
465 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
466 command_print(CMD, "wrote %" PRIu32 " bytes from file %s "
467 "in %fs (%0.3f KiB/s)", written, CMD_ARGV[0],
468 duration_elapsed(&bench), duration_kbps(&bench, written));
476 COMMAND_HANDLER(handle_flash_fill_command)
478 target_addr_t address;
481 struct target *target = get_current_target(CMD_CTX);
487 return ERROR_COMMAND_SYNTAX_ERROR;
489 COMMAND_PARSE_ADDRESS(CMD_ARGV[0], address);
490 COMMAND_PARSE_NUMBER(u64, CMD_ARGV[1], pattern);
491 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], count);
493 struct flash_bank *bank;
494 retval = get_flash_bank_by_addr(target, address, true, &bank);
495 if (retval != ERROR_OK)
498 switch (CMD_NAME[4]) {
512 return ERROR_COMMAND_SYNTAX_ERROR;
518 if (address + count * wordsize > bank->base + bank->size) {
519 LOG_ERROR("Cannot cross flash bank borders");
523 uint32_t size_bytes = count * wordsize;
524 target_addr_t aligned_start = flash_write_align_start(bank, address);
525 target_addr_t end_addr = address + size_bytes - 1;
526 target_addr_t aligned_end = flash_write_align_end(bank, end_addr);
527 uint32_t aligned_size = aligned_end + 1 - aligned_start;
528 uint32_t padding_at_start = address - aligned_start;
529 uint32_t padding_at_end = aligned_end - end_addr;
531 uint8_t *buffer = malloc(aligned_size);
535 if (padding_at_start) {
536 memset(buffer, bank->default_padded_value, padding_at_start);
537 LOG_WARNING("Start address " TARGET_ADDR_FMT
538 " breaks the required alignment of flash bank %s",
539 address, bank->name);
540 LOG_WARNING("Padding %" PRId32 " bytes from " TARGET_ADDR_FMT,
541 padding_at_start, aligned_start);
544 uint8_t *ptr = buffer + padding_at_start;
548 for (i = 0; i < count; i++, ptr += wordsize)
549 target_buffer_set_u64(target, ptr, pattern);
552 for (i = 0; i < count; i++, ptr += wordsize)
553 target_buffer_set_u32(target, ptr, pattern);
556 for (i = 0; i < count; i++, ptr += wordsize)
557 target_buffer_set_u16(target, ptr, pattern);
560 memset(ptr, pattern, count);
564 LOG_ERROR("BUG: can't happen");
568 if (padding_at_end) {
569 memset(ptr, bank->default_padded_value, padding_at_end);
570 LOG_INFO("Padding at " TARGET_ADDR_FMT " with %" PRId32
571 " bytes (bank write end alignment)",
572 end_addr + 1, padding_at_end);
575 struct duration bench;
576 duration_start(&bench);
578 retval = flash_driver_write(bank, buffer, aligned_start - bank->base, aligned_size);
579 if (retval != ERROR_OK)
582 retval = flash_driver_read(bank, buffer, address - bank->base, size_bytes);
583 if (retval != ERROR_OK)
586 for (i = 0, ptr = buffer; i < count; i++) {
587 uint64_t readback = 0;
591 readback = target_buffer_get_u64(target, ptr);
594 readback = target_buffer_get_u32(target, ptr);
597 readback = target_buffer_get_u16(target, ptr);
603 if (readback != pattern) {
605 "Verification error address " TARGET_ADDR_FMT
606 ", read back 0x%02" PRIx64 ", expected 0x%02" PRIx64,
607 address + i * wordsize, readback, pattern);
614 if ((retval == ERROR_OK) && (duration_measure(&bench) == ERROR_OK)) {
615 command_print(CMD, "wrote %" PRIu32 " bytes to " TARGET_ADDR_FMT
616 " in %fs (%0.3f KiB/s)", size_bytes, address,
617 duration_elapsed(&bench), duration_kbps(&bench, size_bytes));
626 COMMAND_HANDLER(handle_flash_write_bank_command)
631 struct fileio *fileio;
633 if (CMD_ARGC < 2 || CMD_ARGC > 3)
634 return ERROR_COMMAND_SYNTAX_ERROR;
636 struct duration bench;
637 duration_start(&bench);
639 struct flash_bank *bank;
640 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
641 if (ERROR_OK != retval)
647 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset);
649 if (offset > bank->size) {
650 LOG_ERROR("Offset 0x%8.8" PRIx32 " is out of range of the flash bank",
652 return ERROR_COMMAND_ARGUMENT_INVALID;
655 if (fileio_open(&fileio, CMD_ARGV[1], FILEIO_READ, FILEIO_BINARY) != ERROR_OK)
659 retval = fileio_size(fileio, &filesize);
660 if (retval != ERROR_OK) {
661 fileio_close(fileio);
665 length = MIN(filesize, bank->size - offset);
668 LOG_INFO("Nothing to write to flash bank");
669 fileio_close(fileio);
673 if (length != filesize)
674 LOG_INFO("File content exceeds flash bank size. Only writing the "
675 "first %zu bytes of the file", length);
677 target_addr_t start_addr = bank->base + offset;
678 target_addr_t aligned_start = flash_write_align_start(bank, start_addr);
679 target_addr_t end_addr = start_addr + length - 1;
680 target_addr_t aligned_end = flash_write_align_end(bank, end_addr);
681 uint32_t aligned_size = aligned_end + 1 - aligned_start;
682 uint32_t padding_at_start = start_addr - aligned_start;
683 uint32_t padding_at_end = aligned_end - end_addr;
685 buffer = malloc(aligned_size);
686 if (buffer == NULL) {
687 fileio_close(fileio);
688 LOG_ERROR("Out of memory");
692 if (padding_at_start) {
693 memset(buffer, bank->default_padded_value, padding_at_start);
694 LOG_WARNING("Start offset 0x%08" PRIx32
695 " breaks the required alignment of flash bank %s",
697 LOG_WARNING("Padding %" PRId32 " bytes from " TARGET_ADDR_FMT,
698 padding_at_start, aligned_start);
701 uint8_t *ptr = buffer + padding_at_start;
703 if (fileio_read(fileio, length, ptr, &buf_cnt) != ERROR_OK) {
705 fileio_close(fileio);
709 if (buf_cnt != length) {
710 LOG_ERROR("Short read");
717 if (padding_at_end) {
718 memset(ptr, bank->default_padded_value, padding_at_end);
719 LOG_INFO("Padding at " TARGET_ADDR_FMT " with %" PRId32
720 " bytes (bank write end alignment)",
721 end_addr + 1, padding_at_end);
724 retval = flash_driver_write(bank, buffer, aligned_start - bank->base, aligned_size);
728 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
729 command_print(CMD, "wrote %zu bytes from file %s to flash bank %u"
730 " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)",
731 length, CMD_ARGV[1], bank->bank_number, offset,
732 duration_elapsed(&bench), duration_kbps(&bench, length));
735 fileio_close(fileio);
740 COMMAND_HANDLER(handle_flash_read_bank_command)
744 struct fileio *fileio;
748 if (CMD_ARGC < 2 || CMD_ARGC > 4)
749 return ERROR_COMMAND_SYNTAX_ERROR;
751 struct duration bench;
752 duration_start(&bench);
754 struct flash_bank *p;
755 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
757 if (ERROR_OK != retval)
763 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset);
765 if (offset > p->size) {
766 LOG_ERROR("Offset 0x%8.8" PRIx32 " is out of range of the flash bank",
768 return ERROR_COMMAND_ARGUMENT_INVALID;
771 length = p->size - offset;
774 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[3], length);
776 if (offset + length > p->size) {
777 LOG_ERROR("Length of %" PRIu32 " bytes with offset 0x%8.8" PRIx32
778 " is out of range of the flash bank", length, offset);
779 return ERROR_COMMAND_ARGUMENT_INVALID;
782 buffer = malloc(length);
783 if (buffer == NULL) {
784 LOG_ERROR("Out of memory");
788 retval = flash_driver_read(p, buffer, offset, length);
789 if (retval != ERROR_OK) {
790 LOG_ERROR("Read error");
795 retval = fileio_open(&fileio, CMD_ARGV[1], FILEIO_WRITE, FILEIO_BINARY);
796 if (retval != ERROR_OK) {
797 LOG_ERROR("Could not open file");
802 retval = fileio_write(fileio, length, buffer, &written);
803 fileio_close(fileio);
805 if (retval != ERROR_OK) {
806 LOG_ERROR("Could not write file");
810 if (duration_measure(&bench) == ERROR_OK)
811 command_print(CMD, "wrote %zd bytes to file %s from flash bank %u"
812 " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)",
813 written, CMD_ARGV[1], p->bank_number, offset,
814 duration_elapsed(&bench), duration_kbps(&bench, written));
820 COMMAND_HANDLER(handle_flash_verify_bank_command)
823 uint8_t *buffer_file, *buffer_flash;
824 struct fileio *fileio;
830 if (CMD_ARGC < 2 || CMD_ARGC > 3)
831 return ERROR_COMMAND_SYNTAX_ERROR;
833 struct duration bench;
834 duration_start(&bench);
836 struct flash_bank *p;
837 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
838 if (ERROR_OK != retval)
844 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset);
846 if (offset > p->size) {
847 LOG_ERROR("Offset 0x%8.8" PRIx32 " is out of range of the flash bank",
849 return ERROR_COMMAND_ARGUMENT_INVALID;
852 retval = fileio_open(&fileio, CMD_ARGV[1], FILEIO_READ, FILEIO_BINARY);
853 if (retval != ERROR_OK) {
854 LOG_ERROR("Could not open file");
858 retval = fileio_size(fileio, &filesize);
859 if (retval != ERROR_OK) {
860 fileio_close(fileio);
864 length = MIN(filesize, p->size - offset);
867 LOG_INFO("Nothing to compare with flash bank");
868 fileio_close(fileio);
872 if (length != filesize)
873 LOG_INFO("File content exceeds flash bank size. Only comparing the "
874 "first %zu bytes of the file", length);
876 buffer_file = malloc(length);
877 if (buffer_file == NULL) {
878 LOG_ERROR("Out of memory");
879 fileio_close(fileio);
883 retval = fileio_read(fileio, length, buffer_file, &read_cnt);
884 fileio_close(fileio);
885 if (retval != ERROR_OK) {
886 LOG_ERROR("File read failure");
891 if (read_cnt != length) {
892 LOG_ERROR("Short read");
897 buffer_flash = malloc(length);
898 if (buffer_flash == NULL) {
899 LOG_ERROR("Out of memory");
904 retval = flash_driver_read(p, buffer_flash, offset, length);
905 if (retval != ERROR_OK) {
906 LOG_ERROR("Flash read error");
912 if (duration_measure(&bench) == ERROR_OK)
913 command_print(CMD, "read %zd bytes from file %s and flash bank %u"
914 " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)",
915 length, CMD_ARGV[1], p->bank_number, offset,
916 duration_elapsed(&bench), duration_kbps(&bench, length));
918 differ = memcmp(buffer_file, buffer_flash, length);
919 command_print(CMD, "contents %s", differ ? "differ" : "match");
923 for (t = 0; t < length; t++) {
924 if (buffer_flash[t] == buffer_file[t])
926 command_print(CMD, "diff %d address 0x%08x. Was 0x%02x instead of 0x%02x",
927 diffs, t + offset, buffer_flash[t], buffer_file[t]);
928 if (diffs++ >= 127) {
929 command_print(CMD, "More than 128 errors, the rest are not printed.");
938 return differ ? ERROR_FAIL : ERROR_OK;
941 void flash_set_dirty(void)
943 struct flash_bank *c;
946 /* set all flash to require erasing */
947 for (c = flash_bank_list(); c; c = c->next) {
948 for (i = 0; i < c->num_sectors; i++)
949 c->sectors[i].is_erased = 0;
953 COMMAND_HANDLER(handle_flash_padded_value_command)
956 return ERROR_COMMAND_SYNTAX_ERROR;
958 struct flash_bank *p;
959 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
960 if (ERROR_OK != retval)
963 COMMAND_PARSE_NUMBER(u8, CMD_ARGV[1], p->default_padded_value);
965 command_print(CMD, "Default padded value set to 0x%" PRIx8 " for flash bank %u", \
966 p->default_padded_value, p->bank_number);
971 static const struct command_registration flash_exec_command_handlers[] = {
974 .handler = handle_flash_probe_command,
975 .mode = COMMAND_EXEC,
977 .help = "Identify a flash bank.",
981 .handler = handle_flash_info_command,
982 .mode = COMMAND_EXEC,
983 .usage = "bank_id ['sectors']",
984 .help = "Print information about a flash bank.",
987 .name = "erase_check",
988 .handler = handle_flash_erase_check_command,
989 .mode = COMMAND_EXEC,
991 .help = "Check erase state of all blocks in a "
995 .name = "erase_sector",
996 .handler = handle_flash_erase_command,
997 .mode = COMMAND_EXEC,
998 .usage = "bank_id first_sector_num (last_sector_num|'last')",
999 .help = "Erase a range of sectors in a flash bank.",
1002 .name = "erase_address",
1003 .handler = handle_flash_erase_address_command,
1004 .mode = COMMAND_EXEC,
1005 .usage = "['pad'] ['unlock'] address length",
1006 .help = "Erase flash sectors starting at address and "
1007 "continuing for length bytes. If 'pad' is specified, "
1008 "data outside that range may also be erased: the start "
1009 "address may be decreased, and length increased, so "
1010 "that all of the first and last sectors are erased. "
1011 "If 'unlock' is specified, then the flash is unprotected "
1017 .handler = handle_flash_fill_command,
1018 .mode = COMMAND_EXEC,
1019 .usage = "address value n",
1020 .help = "Fill n double-words with 64-bit value, starting at "
1021 "word address. (No autoerase.)",
1025 .handler = handle_flash_fill_command,
1026 .mode = COMMAND_EXEC,
1027 .usage = "address value n",
1028 .help = "Fill n words with 32-bit value, starting at "
1029 "word address. (No autoerase.)",
1033 .handler = handle_flash_fill_command,
1034 .mode = COMMAND_EXEC,
1035 .usage = "address value n",
1036 .help = "Fill n halfwords with 16-bit value, starting at "
1037 "word address. (No autoerase.)",
1041 .handler = handle_flash_fill_command,
1042 .mode = COMMAND_EXEC,
1043 .usage = "address value n",
1044 .help = "Fill n bytes with 8-bit value, starting at "
1045 "word address. (No autoerase.)",
1048 .name = "write_bank",
1049 .handler = handle_flash_write_bank_command,
1050 .mode = COMMAND_EXEC,
1051 .usage = "bank_id filename [offset]",
1052 .help = "Write binary data from file to flash bank. Allow optional "
1053 "offset from beginning of the bank (defaults to zero).",
1056 .name = "write_image",
1057 .handler = handle_flash_write_image_command,
1058 .mode = COMMAND_EXEC,
1059 .usage = "[erase] [unlock] filename [offset [file_type]]",
1060 .help = "Write an image to flash. Optionally first unprotect "
1061 "and/or erase the region to be used. Allow optional "
1062 "offset from beginning of bank (defaults to zero)",
1065 .name = "read_bank",
1066 .handler = handle_flash_read_bank_command,
1067 .mode = COMMAND_EXEC,
1068 .usage = "bank_id filename [offset [length]]",
1069 .help = "Read binary data from flash bank to file. Allow optional "
1070 "offset from beginning of the bank (defaults to zero).",
1073 .name = "verify_bank",
1074 .handler = handle_flash_verify_bank_command,
1075 .mode = COMMAND_EXEC,
1076 .usage = "bank_id filename [offset]",
1077 .help = "Compare the contents of a file with the contents of the "
1078 "flash bank. Allow optional offset from beginning of the bank "
1079 "(defaults to zero).",
1083 .handler = handle_flash_protect_command,
1084 .mode = COMMAND_EXEC,
1085 .usage = "bank_id first_block [last_block|'last'] "
1087 .help = "Turn protection on or off for a range of protection "
1088 "blocks or sectors in a given flash bank. "
1089 "See 'flash info' output for a list of blocks.",
1092 .name = "padded_value",
1093 .handler = handle_flash_padded_value_command,
1094 .mode = COMMAND_EXEC,
1095 .usage = "bank_id value",
1096 .help = "Set default flash padded value",
1098 COMMAND_REGISTRATION_DONE
1101 static int flash_init_drivers(struct command_context *cmd_ctx)
1103 if (!flash_bank_list())
1106 struct command *parent = command_find_in_context(cmd_ctx, "flash");
1107 return register_commands(cmd_ctx, parent, flash_exec_command_handlers);
1110 COMMAND_HANDLER(handle_flash_bank_command)
1113 LOG_ERROR("usage: flash bank <name> <driver> "
1114 "<base> <size> <chip_width> <bus_width> <target>");
1115 return ERROR_COMMAND_SYNTAX_ERROR;
1117 /* save bank name and advance arguments for compatibility */
1118 const char *bank_name = *CMD_ARGV++;
1121 struct target *target = get_target(CMD_ARGV[5]);
1122 if (target == NULL) {
1123 LOG_ERROR("target '%s' not defined", CMD_ARGV[5]);
1127 const char *driver_name = CMD_ARGV[0];
1128 const struct flash_driver *driver = flash_driver_find_by_name(driver_name);
1129 if (NULL == driver) {
1130 /* no matching flash driver found */
1131 LOG_ERROR("flash driver '%s' not found", driver_name);
1135 /* check the flash bank name is unique */
1136 if (get_flash_bank_by_name_noprobe(bank_name) != NULL) {
1137 /* flash bank name already exists */
1138 LOG_ERROR("flash bank name '%s' already exists", bank_name);
1142 /* register flash specific commands */
1143 if (NULL != driver->commands) {
1144 int retval = register_commands(CMD_CTX, NULL,
1146 if (ERROR_OK != retval) {
1147 LOG_ERROR("couldn't register '%s' commands",
1153 struct flash_bank *c = calloc(1, sizeof(*c));
1154 c->name = strdup(bank_name);
1157 COMMAND_PARSE_NUMBER(target_addr, CMD_ARGV[1], c->base);
1158 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], c->size);
1159 COMMAND_PARSE_NUMBER(int, CMD_ARGV[3], c->chip_width);
1160 COMMAND_PARSE_NUMBER(int, CMD_ARGV[4], c->bus_width);
1161 c->default_padded_value = c->erased_value = 0xff;
1162 c->minimal_write_gap = FLASH_WRITE_GAP_SECTOR;
1165 retval = CALL_COMMAND_HANDLER(driver->flash_bank_command, c);
1166 if (ERROR_OK != retval) {
1167 LOG_ERROR("'%s' driver rejected flash bank at " TARGET_ADDR_FMT
1168 "; usage: %s", driver_name, c->base, driver->usage);
1173 if (driver->usage == NULL)
1174 LOG_DEBUG("'%s' driver usage field missing", driver_name);
1181 COMMAND_HANDLER(handle_flash_banks_command)
1184 return ERROR_COMMAND_SYNTAX_ERROR;
1187 for (struct flash_bank *p = flash_bank_list(); p; p = p->next, n++) {
1188 command_print(CMD, "#%d : %s (%s) at " TARGET_ADDR_FMT ", size 0x%8.8" PRIx32 ", "
1189 "buswidth %u, chipwidth %u", p->bank_number,
1190 p->name, p->driver->name, p->base, p->size,
1191 p->bus_width, p->chip_width);
1196 static int jim_flash_list(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
1199 Jim_WrongNumArgs(interp, 1, argv,
1200 "no arguments to 'flash list' command");
1204 Jim_Obj *list = Jim_NewListObj(interp, NULL, 0);
1206 for (struct flash_bank *p = flash_bank_list(); p; p = p->next) {
1207 Jim_Obj *elem = Jim_NewListObj(interp, NULL, 0);
1209 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "name", -1));
1210 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, p->driver->name, -1));
1211 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "base", -1));
1212 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->base));
1213 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "size", -1));
1214 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->size));
1215 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "bus_width", -1));
1216 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->bus_width));
1217 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "chip_width", -1));
1218 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->chip_width));
1220 Jim_ListAppendElement(interp, list, elem);
1223 Jim_SetResult(interp, list);
1228 COMMAND_HANDLER(handle_flash_init_command)
1231 return ERROR_COMMAND_SYNTAX_ERROR;
1233 static bool flash_initialized;
1234 if (flash_initialized) {
1235 LOG_INFO("'flash init' has already been called");
1238 flash_initialized = true;
1240 LOG_DEBUG("Initializing flash devices...");
1241 return flash_init_drivers(CMD_CTX);
1244 static const struct command_registration flash_config_command_handlers[] = {
1247 .handler = handle_flash_bank_command,
1248 .mode = COMMAND_CONFIG,
1249 .usage = "bank_id driver_name base_address size_bytes "
1250 "chip_width_bytes bus_width_bytes target "
1251 "[driver_options ...]",
1252 .help = "Define a new bank with the given name, "
1253 "using the specified NOR flash driver.",
1257 .mode = COMMAND_CONFIG,
1258 .handler = handle_flash_init_command,
1259 .help = "Initialize flash devices.",
1264 .mode = COMMAND_ANY,
1265 .handler = handle_flash_banks_command,
1266 .help = "Display table with information about flash banks.",
1271 .mode = COMMAND_ANY,
1272 .jim_handler = jim_flash_list,
1273 .help = "Returns a list of details about the flash banks.",
1275 COMMAND_REGISTRATION_DONE
1277 static const struct command_registration flash_command_handlers[] = {
1280 .mode = COMMAND_ANY,
1281 .help = "NOR flash command group",
1282 .chain = flash_config_command_handlers,
1285 COMMAND_REGISTRATION_DONE
1288 int flash_register_commands(struct command_context *cmd_ctx)
1290 return register_commands(cmd_ctx, NULL, flash_command_handlers);