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.");
114 command_print(CMD_CTX,
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";
143 command_print(CMD_CTX,
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_CTX, "%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)
179 command_print(CMD_CTX,
180 "flash '%s' found at " TARGET_ADDR_FMT,
184 command_print(CMD_CTX, "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_CTX, "successfully checked erase state");
207 command_print(CMD_CTX,
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";
225 command_print(CMD_CTX,
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_CTX, "\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_CTX, "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_CTX, "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_CTX, "ERROR: "
324 "first sector must be <= last");
328 if (!(last <= (uint32_t)(p->num_sectors - 1))) {
329 command_print(CMD_CTX, "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_CTX, "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_CTX, "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_CTX, "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_CTX, "%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_CTX, "auto erase enabled");
425 } else if (strcmp(CMD_ARGV[0], "unlock") == 0) {
429 command_print(CMD_CTX, "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_CTX, "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(u32, 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]) {
509 return ERROR_COMMAND_SYNTAX_ERROR;
515 if (address + count * wordsize > bank->base + bank->size) {
516 LOG_ERROR("Cannot cross flash bank borders");
520 uint32_t size_bytes = count * wordsize;
521 target_addr_t aligned_start = flash_write_align_start(bank, address);
522 target_addr_t end_addr = address + size_bytes - 1;
523 target_addr_t aligned_end = flash_write_align_end(bank, end_addr);
524 uint32_t aligned_size = aligned_end + 1 - aligned_start;
525 uint32_t padding_at_start = address - aligned_start;
526 uint32_t padding_at_end = aligned_end - end_addr;
528 uint8_t *buffer = malloc(aligned_size);
532 if (padding_at_start) {
533 memset(buffer, bank->default_padded_value, padding_at_start);
534 LOG_WARNING("Start address " TARGET_ADDR_FMT
535 " breaks the required alignment of flash bank %s",
536 address, bank->name);
537 LOG_WARNING("Padding %" PRId32 " bytes from " TARGET_ADDR_FMT,
538 padding_at_start, aligned_start);
541 uint8_t *ptr = buffer + padding_at_start;
545 for (i = 0; i < count; i++, ptr += wordsize)
546 target_buffer_set_u32(target, ptr, pattern);
549 for (i = 0; i < count; i++, ptr += wordsize)
550 target_buffer_set_u16(target, ptr, pattern);
553 memset(ptr, pattern, count);
557 LOG_ERROR("BUG: can't happen");
561 if (padding_at_end) {
562 memset(ptr, bank->default_padded_value, padding_at_end);
563 LOG_INFO("Padding at " TARGET_ADDR_FMT " with %" PRId32
564 " bytes (bank write end alignment)",
565 end_addr + 1, padding_at_end);
568 struct duration bench;
569 duration_start(&bench);
571 retval = flash_driver_write(bank, buffer, aligned_start - bank->base, aligned_size);
572 if (retval != ERROR_OK)
575 retval = flash_driver_read(bank, buffer, address - bank->base, size_bytes);
576 if (retval != ERROR_OK)
579 for (i = 0, ptr = buffer; i < count; i++) {
580 uint32_t readback = 0;
584 readback = target_buffer_get_u32(target, ptr);
587 readback = target_buffer_get_u16(target, ptr);
593 if (readback != pattern) {
595 "Verification error address " TARGET_ADDR_FMT
596 ", read back 0x%02" PRIx32 ", expected 0x%02" PRIx32,
597 address + i * wordsize, readback, pattern);
604 if ((retval == ERROR_OK) && (duration_measure(&bench) == ERROR_OK)) {
605 command_print(CMD_CTX, "wrote %" PRIu32 " bytes to " TARGET_ADDR_FMT
606 " in %fs (%0.3f KiB/s)", size_bytes, address,
607 duration_elapsed(&bench), duration_kbps(&bench, size_bytes));
616 COMMAND_HANDLER(handle_flash_write_bank_command)
621 struct fileio *fileio;
623 if (CMD_ARGC < 2 || CMD_ARGC > 3)
624 return ERROR_COMMAND_SYNTAX_ERROR;
626 struct duration bench;
627 duration_start(&bench);
629 struct flash_bank *bank;
630 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
631 if (ERROR_OK != retval)
637 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset);
639 if (offset > bank->size) {
640 LOG_ERROR("Offset 0x%8.8" PRIx32 " is out of range of the flash bank",
642 return ERROR_COMMAND_ARGUMENT_INVALID;
645 if (fileio_open(&fileio, CMD_ARGV[1], FILEIO_READ, FILEIO_BINARY) != ERROR_OK)
649 retval = fileio_size(fileio, &filesize);
650 if (retval != ERROR_OK) {
651 fileio_close(fileio);
655 length = MIN(filesize, bank->size - offset);
658 LOG_INFO("Nothing to write to flash bank");
659 fileio_close(fileio);
663 if (length != filesize)
664 LOG_INFO("File content exceeds flash bank size. Only writing the "
665 "first %zu bytes of the file", length);
667 target_addr_t start_addr = bank->base + offset;
668 target_addr_t aligned_start = flash_write_align_start(bank, start_addr);
669 target_addr_t end_addr = start_addr + length - 1;
670 target_addr_t aligned_end = flash_write_align_end(bank, end_addr);
671 uint32_t aligned_size = aligned_end + 1 - aligned_start;
672 uint32_t padding_at_start = start_addr - aligned_start;
673 uint32_t padding_at_end = aligned_end - end_addr;
675 buffer = malloc(aligned_size);
676 if (buffer == NULL) {
677 fileio_close(fileio);
678 LOG_ERROR("Out of memory");
682 if (padding_at_start) {
683 memset(buffer, bank->default_padded_value, padding_at_start);
684 LOG_WARNING("Start offset 0x%08" PRIx32
685 " breaks the required alignment of flash bank %s",
687 LOG_WARNING("Padding %" PRId32 " bytes from " TARGET_ADDR_FMT,
688 padding_at_start, aligned_start);
691 uint8_t *ptr = buffer + padding_at_start;
693 if (fileio_read(fileio, length, ptr, &buf_cnt) != ERROR_OK) {
695 fileio_close(fileio);
699 if (buf_cnt != length) {
700 LOG_ERROR("Short read");
707 if (padding_at_end) {
708 memset(ptr, bank->default_padded_value, padding_at_end);
709 LOG_INFO("Padding at " TARGET_ADDR_FMT " with %" PRId32
710 " bytes (bank write end alignment)",
711 end_addr + 1, padding_at_end);
714 retval = flash_driver_write(bank, buffer, aligned_start - bank->base, aligned_size);
718 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
719 command_print(CMD_CTX, "wrote %zu bytes from file %s to flash bank %u"
720 " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)",
721 length, CMD_ARGV[1], bank->bank_number, offset,
722 duration_elapsed(&bench), duration_kbps(&bench, length));
725 fileio_close(fileio);
730 COMMAND_HANDLER(handle_flash_read_bank_command)
734 struct fileio *fileio;
738 if (CMD_ARGC < 2 || CMD_ARGC > 4)
739 return ERROR_COMMAND_SYNTAX_ERROR;
741 struct duration bench;
742 duration_start(&bench);
744 struct flash_bank *p;
745 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
747 if (ERROR_OK != retval)
753 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset);
755 if (offset > p->size) {
756 LOG_ERROR("Offset 0x%8.8" PRIx32 " is out of range of the flash bank",
758 return ERROR_COMMAND_ARGUMENT_INVALID;
761 length = p->size - offset;
764 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[3], length);
766 if (offset + length > p->size) {
767 LOG_ERROR("Length of %" PRIu32 " bytes with offset 0x%8.8" PRIx32
768 " is out of range of the flash bank", length, offset);
769 return ERROR_COMMAND_ARGUMENT_INVALID;
772 buffer = malloc(length);
773 if (buffer == NULL) {
774 LOG_ERROR("Out of memory");
778 retval = flash_driver_read(p, buffer, offset, length);
779 if (retval != ERROR_OK) {
780 LOG_ERROR("Read error");
785 retval = fileio_open(&fileio, CMD_ARGV[1], FILEIO_WRITE, FILEIO_BINARY);
786 if (retval != ERROR_OK) {
787 LOG_ERROR("Could not open file");
792 retval = fileio_write(fileio, length, buffer, &written);
793 fileio_close(fileio);
795 if (retval != ERROR_OK) {
796 LOG_ERROR("Could not write file");
800 if (duration_measure(&bench) == ERROR_OK)
801 command_print(CMD_CTX, "wrote %zd bytes to file %s from flash bank %u"
802 " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)",
803 written, CMD_ARGV[1], p->bank_number, offset,
804 duration_elapsed(&bench), duration_kbps(&bench, written));
810 COMMAND_HANDLER(handle_flash_verify_bank_command)
813 uint8_t *buffer_file, *buffer_flash;
814 struct fileio *fileio;
820 if (CMD_ARGC < 2 || CMD_ARGC > 3)
821 return ERROR_COMMAND_SYNTAX_ERROR;
823 struct duration bench;
824 duration_start(&bench);
826 struct flash_bank *p;
827 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
828 if (ERROR_OK != retval)
834 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset);
836 if (offset > p->size) {
837 LOG_ERROR("Offset 0x%8.8" PRIx32 " is out of range of the flash bank",
839 return ERROR_COMMAND_ARGUMENT_INVALID;
842 retval = fileio_open(&fileio, CMD_ARGV[1], FILEIO_READ, FILEIO_BINARY);
843 if (retval != ERROR_OK) {
844 LOG_ERROR("Could not open file");
848 retval = fileio_size(fileio, &filesize);
849 if (retval != ERROR_OK) {
850 fileio_close(fileio);
854 length = MIN(filesize, p->size - offset);
857 LOG_INFO("Nothing to compare with flash bank");
858 fileio_close(fileio);
862 if (length != filesize)
863 LOG_INFO("File content exceeds flash bank size. Only comparing the "
864 "first %zu bytes of the file", length);
866 buffer_file = malloc(length);
867 if (buffer_file == NULL) {
868 LOG_ERROR("Out of memory");
869 fileio_close(fileio);
873 retval = fileio_read(fileio, length, buffer_file, &read_cnt);
874 fileio_close(fileio);
875 if (retval != ERROR_OK) {
876 LOG_ERROR("File read failure");
881 if (read_cnt != length) {
882 LOG_ERROR("Short read");
887 buffer_flash = malloc(length);
888 if (buffer_flash == NULL) {
889 LOG_ERROR("Out of memory");
894 retval = flash_driver_read(p, buffer_flash, offset, length);
895 if (retval != ERROR_OK) {
896 LOG_ERROR("Flash read error");
902 if (duration_measure(&bench) == ERROR_OK)
903 command_print(CMD_CTX, "read %zd bytes from file %s and flash bank %u"
904 " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)",
905 length, CMD_ARGV[1], p->bank_number, offset,
906 duration_elapsed(&bench), duration_kbps(&bench, length));
908 differ = memcmp(buffer_file, buffer_flash, length);
909 command_print(CMD_CTX, "contents %s", differ ? "differ" : "match");
913 for (t = 0; t < length; t++) {
914 if (buffer_flash[t] == buffer_file[t])
916 command_print(CMD_CTX, "diff %d address 0x%08x. Was 0x%02x instead of 0x%02x",
917 diffs, t + offset, buffer_flash[t], buffer_file[t]);
918 if (diffs++ >= 127) {
919 command_print(CMD_CTX, "More than 128 errors, the rest are not printed.");
928 return differ ? ERROR_FAIL : ERROR_OK;
931 void flash_set_dirty(void)
933 struct flash_bank *c;
936 /* set all flash to require erasing */
937 for (c = flash_bank_list(); c; c = c->next) {
938 for (i = 0; i < c->num_sectors; i++)
939 c->sectors[i].is_erased = 0;
943 COMMAND_HANDLER(handle_flash_padded_value_command)
946 return ERROR_COMMAND_SYNTAX_ERROR;
948 struct flash_bank *p;
949 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
950 if (ERROR_OK != retval)
953 COMMAND_PARSE_NUMBER(u8, CMD_ARGV[1], p->default_padded_value);
955 command_print(CMD_CTX, "Default padded value set to 0x%" PRIx8 " for flash bank %u", \
956 p->default_padded_value, p->bank_number);
961 static const struct command_registration flash_exec_command_handlers[] = {
964 .handler = handle_flash_probe_command,
965 .mode = COMMAND_EXEC,
967 .help = "Identify a flash bank.",
971 .handler = handle_flash_info_command,
972 .mode = COMMAND_EXEC,
973 .usage = "bank_id ['sectors']",
974 .help = "Print information about a flash bank.",
977 .name = "erase_check",
978 .handler = handle_flash_erase_check_command,
979 .mode = COMMAND_EXEC,
981 .help = "Check erase state of all blocks in a "
985 .name = "erase_sector",
986 .handler = handle_flash_erase_command,
987 .mode = COMMAND_EXEC,
988 .usage = "bank_id first_sector_num last_sector_num",
989 .help = "Erase a range of sectors in a flash bank.",
992 .name = "erase_address",
993 .handler = handle_flash_erase_address_command,
994 .mode = COMMAND_EXEC,
995 .usage = "['pad'] ['unlock'] address length",
996 .help = "Erase flash sectors starting at address and "
997 "continuing for length bytes. If 'pad' is specified, "
998 "data outside that range may also be erased: the start "
999 "address may be decreased, and length increased, so "
1000 "that all of the first and last sectors are erased. "
1001 "If 'unlock' is specified, then the flash is unprotected "
1007 .handler = handle_flash_fill_command,
1008 .mode = COMMAND_EXEC,
1009 .usage = "address value n",
1010 .help = "Fill n words with 32-bit value, starting at "
1011 "word address. (No autoerase.)",
1015 .handler = handle_flash_fill_command,
1016 .mode = COMMAND_EXEC,
1017 .usage = "address value n",
1018 .help = "Fill n halfwords with 16-bit value, starting at "
1019 "word address. (No autoerase.)",
1023 .handler = handle_flash_fill_command,
1024 .mode = COMMAND_EXEC,
1025 .usage = "address value n",
1026 .help = "Fill n bytes with 8-bit value, starting at "
1027 "word address. (No autoerase.)",
1030 .name = "write_bank",
1031 .handler = handle_flash_write_bank_command,
1032 .mode = COMMAND_EXEC,
1033 .usage = "bank_id filename [offset]",
1034 .help = "Write binary data from file to flash bank. Allow optional "
1035 "offset from beginning of the bank (defaults to zero).",
1038 .name = "write_image",
1039 .handler = handle_flash_write_image_command,
1040 .mode = COMMAND_EXEC,
1041 .usage = "[erase] [unlock] filename [offset [file_type]]",
1042 .help = "Write an image to flash. Optionally first unprotect "
1043 "and/or erase the region to be used. Allow optional "
1044 "offset from beginning of bank (defaults to zero)",
1047 .name = "read_bank",
1048 .handler = handle_flash_read_bank_command,
1049 .mode = COMMAND_EXEC,
1050 .usage = "bank_id filename [offset [length]]",
1051 .help = "Read binary data from flash bank to file. Allow optional "
1052 "offset from beginning of the bank (defaults to zero).",
1055 .name = "verify_bank",
1056 .handler = handle_flash_verify_bank_command,
1057 .mode = COMMAND_EXEC,
1058 .usage = "bank_id filename [offset]",
1059 .help = "Compare the contents of a file with the contents of the "
1060 "flash bank. Allow optional offset from beginning of the bank "
1061 "(defaults to zero).",
1065 .handler = handle_flash_protect_command,
1066 .mode = COMMAND_EXEC,
1067 .usage = "bank_id first_block [last_block|'last'] "
1069 .help = "Turn protection on or off for a range of protection "
1070 "blocks or sectors in a given flash bank. "
1071 "See 'flash info' output for a list of blocks.",
1074 .name = "padded_value",
1075 .handler = handle_flash_padded_value_command,
1076 .mode = COMMAND_EXEC,
1077 .usage = "bank_id value",
1078 .help = "Set default flash padded value",
1080 COMMAND_REGISTRATION_DONE
1083 static int flash_init_drivers(struct command_context *cmd_ctx)
1085 if (!flash_bank_list())
1088 struct command *parent = command_find_in_context(cmd_ctx, "flash");
1089 return register_commands(cmd_ctx, parent, flash_exec_command_handlers);
1092 COMMAND_HANDLER(handle_flash_bank_command)
1095 LOG_ERROR("usage: flash bank <name> <driver> "
1096 "<base> <size> <chip_width> <bus_width> <target>");
1097 return ERROR_COMMAND_SYNTAX_ERROR;
1099 /* save bank name and advance arguments for compatibility */
1100 const char *bank_name = *CMD_ARGV++;
1103 struct target *target = get_target(CMD_ARGV[5]);
1104 if (target == NULL) {
1105 LOG_ERROR("target '%s' not defined", CMD_ARGV[5]);
1109 const char *driver_name = CMD_ARGV[0];
1110 struct flash_driver *driver = flash_driver_find_by_name(driver_name);
1111 if (NULL == driver) {
1112 /* no matching flash driver found */
1113 LOG_ERROR("flash driver '%s' not found", driver_name);
1117 /* check the flash bank name is unique */
1118 if (get_flash_bank_by_name_noprobe(bank_name) != NULL) {
1119 /* flash bank name already exists */
1120 LOG_ERROR("flash bank name '%s' already exists", bank_name);
1124 /* register flash specific commands */
1125 if (NULL != driver->commands) {
1126 int retval = register_commands(CMD_CTX, NULL,
1128 if (ERROR_OK != retval) {
1129 LOG_ERROR("couldn't register '%s' commands",
1135 struct flash_bank *c = calloc(1, sizeof(*c));
1136 c->name = strdup(bank_name);
1139 COMMAND_PARSE_NUMBER(target_addr, CMD_ARGV[1], c->base);
1140 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], c->size);
1141 COMMAND_PARSE_NUMBER(int, CMD_ARGV[3], c->chip_width);
1142 COMMAND_PARSE_NUMBER(int, CMD_ARGV[4], c->bus_width);
1143 c->default_padded_value = c->erased_value = 0xff;
1144 c->minimal_write_gap = FLASH_WRITE_GAP_SECTOR;
1147 retval = CALL_COMMAND_HANDLER(driver->flash_bank_command, c);
1148 if (ERROR_OK != retval) {
1149 LOG_ERROR("'%s' driver rejected flash bank at " TARGET_ADDR_FMT
1150 "; usage: %s", driver_name, c->base, driver->usage);
1155 if (driver->usage == NULL)
1156 LOG_DEBUG("'%s' driver usage field missing", driver_name);
1163 COMMAND_HANDLER(handle_flash_banks_command)
1166 return ERROR_COMMAND_SYNTAX_ERROR;
1169 for (struct flash_bank *p = flash_bank_list(); p; p = p->next, n++) {
1170 LOG_USER("#%d : %s (%s) at " TARGET_ADDR_FMT ", size 0x%8.8" PRIx32 ", "
1171 "buswidth %u, chipwidth %u", p->bank_number,
1172 p->name, p->driver->name, p->base, p->size,
1173 p->bus_width, p->chip_width);
1178 static int jim_flash_list(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
1181 Jim_WrongNumArgs(interp, 1, argv,
1182 "no arguments to 'flash list' command");
1186 Jim_Obj *list = Jim_NewListObj(interp, NULL, 0);
1188 for (struct flash_bank *p = flash_bank_list(); p; p = p->next) {
1189 Jim_Obj *elem = Jim_NewListObj(interp, NULL, 0);
1191 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "name", -1));
1192 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, p->driver->name, -1));
1193 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "base", -1));
1194 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->base));
1195 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "size", -1));
1196 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->size));
1197 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "bus_width", -1));
1198 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->bus_width));
1199 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "chip_width", -1));
1200 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->chip_width));
1202 Jim_ListAppendElement(interp, list, elem);
1205 Jim_SetResult(interp, list);
1210 COMMAND_HANDLER(handle_flash_init_command)
1213 return ERROR_COMMAND_SYNTAX_ERROR;
1215 static bool flash_initialized;
1216 if (flash_initialized) {
1217 LOG_INFO("'flash init' has already been called");
1220 flash_initialized = true;
1222 LOG_DEBUG("Initializing flash devices...");
1223 return flash_init_drivers(CMD_CTX);
1226 static const struct command_registration flash_config_command_handlers[] = {
1229 .handler = handle_flash_bank_command,
1230 .mode = COMMAND_CONFIG,
1231 .usage = "bank_id driver_name base_address size_bytes "
1232 "chip_width_bytes bus_width_bytes target "
1233 "[driver_options ...]",
1234 .help = "Define a new bank with the given name, "
1235 "using the specified NOR flash driver.",
1239 .mode = COMMAND_CONFIG,
1240 .handler = handle_flash_init_command,
1241 .help = "Initialize flash devices.",
1245 .mode = COMMAND_ANY,
1246 .handler = handle_flash_banks_command,
1247 .help = "Display table with information about flash banks.",
1251 .mode = COMMAND_ANY,
1252 .jim_handler = jim_flash_list,
1253 .help = "Returns a list of details about the flash banks.",
1255 COMMAND_REGISTRATION_DONE
1257 static const struct command_registration flash_command_handlers[] = {
1260 .mode = COMMAND_ANY,
1261 .help = "NOR flash command group",
1262 .chain = flash_config_command_handlers,
1264 COMMAND_REGISTRATION_DONE
1267 int flash_register_commands(struct command_context *cmd_ctx)
1269 return register_commands(cmd_ctx, NULL, flash_command_handlers);