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 /* We must query the hardware to avoid printing stale information! */
102 retval = p->driver->protect_check(p);
103 if (retval != ERROR_OK)
106 command_print(CMD_CTX,
107 "#%d : %s at 0x%8.8" PRIx32 ", size 0x%8.8" PRIx32
108 ", buswidth %i, chipwidth %i",
116 prot_block_available = p->num_prot_blocks && p->prot_blocks;
117 if (!show_sectors && prot_block_available) {
118 block_array = p->prot_blocks;
119 num_blocks = p->num_prot_blocks;
121 block_array = p->sectors;
122 num_blocks = p->num_sectors;
125 for (j = 0; j < num_blocks; j++) {
126 char *protect_state = "";
128 if (block_array[j].is_protected == 0)
129 protect_state = "not protected";
130 else if (block_array[j].is_protected == 1)
131 protect_state = "protected";
132 else if (!show_sectors || !prot_block_available)
133 protect_state = "protection state unknown";
135 command_print(CMD_CTX,
136 "\t#%3i: 0x%8.8" PRIx32 " (0x%" PRIx32 " %" PRIi32 "kB) %s",
138 block_array[j].offset,
140 block_array[j].size >> 10,
144 if (p->driver->info != NULL) {
145 retval = p->driver->info(p, buf, sizeof(buf));
146 if (retval == ERROR_OK)
147 command_print(CMD_CTX, "%s", buf);
149 LOG_ERROR("error retrieving flash info");
156 COMMAND_HANDLER(handle_flash_probe_command)
158 struct flash_bank *p;
162 return ERROR_COMMAND_SYNTAX_ERROR;
164 retval = CALL_COMMAND_HANDLER(flash_command_get_bank_maybe_probe, 0, &p, false);
165 if (retval != ERROR_OK)
169 retval = p->driver->probe(p);
170 if (retval == ERROR_OK)
171 command_print(CMD_CTX,
172 "flash '%s' found at 0x%8.8" PRIx32,
176 command_print(CMD_CTX, "flash bank '#%s' is out of bounds", CMD_ARGV[0]);
183 COMMAND_HANDLER(handle_flash_erase_check_command)
187 return ERROR_COMMAND_SYNTAX_ERROR;
189 struct flash_bank *p;
190 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
191 if (ERROR_OK != retval)
195 retval = p->driver->erase_check(p);
196 if (retval == ERROR_OK)
197 command_print(CMD_CTX, "successfully checked erase state");
199 command_print(CMD_CTX,
200 "unknown error when checking erase state of flash bank #%s at 0x%8.8" PRIx32,
205 for (j = 0; j < p->num_sectors; j++) {
208 if (p->sectors[j].is_erased == 0)
209 erase_state = "not erased";
210 else if (p->sectors[j].is_erased == 1)
213 erase_state = "erase state unknown";
216 command_print(CMD_CTX,
217 "\t#%3i: 0x%8.8" PRIx32 " (0x%" PRIx32 " %" PRIi32 "kB) %s",
219 p->sectors[j].offset,
221 p->sectors[j].size >> 10,
226 command_print(CMD_CTX, "\tBank is erased");
230 COMMAND_HANDLER(handle_flash_erase_address_command)
232 struct flash_bank *p;
233 int retval = ERROR_OK;
237 bool do_unlock = false;
238 struct target *target = get_current_target(CMD_CTX);
240 while (CMD_ARGC >= 3) {
241 /* Optionally pad out the address range to block/sector
242 * boundaries. We can't know if there's data in that part
243 * of the flash; only do padding if we're told to.
245 if (strcmp("pad", CMD_ARGV[0]) == 0)
247 else if (strcmp("unlock", CMD_ARGV[0]) == 0)
250 return ERROR_COMMAND_SYNTAX_ERROR;
255 return ERROR_COMMAND_SYNTAX_ERROR;
257 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
258 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
261 command_print(CMD_CTX, "Length must be >0");
262 return ERROR_COMMAND_SYNTAX_ERROR;
265 retval = get_flash_bank_by_addr(target, address, true, &p);
266 if (retval != ERROR_OK)
269 /* We can't know if we did a resume + halt, in which case we no longer know the erased state
273 struct duration bench;
274 duration_start(&bench);
277 retval = flash_unlock_address_range(target, address, length);
279 if (retval == ERROR_OK)
280 retval = flash_erase_address_range(target, do_pad, address, length);
282 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
283 command_print(CMD_CTX, "erased address 0x%8.8" PRIx32 " (length %" PRIi32 ")"
284 " in %fs (%0.3f KiB/s)", address, length,
285 duration_elapsed(&bench), duration_kbps(&bench, length));
291 COMMAND_HANDLER(handle_flash_erase_command)
294 return ERROR_COMMAND_SYNTAX_ERROR;
299 struct flash_bank *p;
302 retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
303 if (retval != ERROR_OK)
306 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], first);
307 if (strcmp(CMD_ARGV[2], "last") == 0)
308 last = p->num_sectors - 1;
310 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], last);
312 if (!(first <= last)) {
313 command_print(CMD_CTX, "ERROR: "
314 "first sector must be <= last");
318 if (!(last <= (uint32_t)(p->num_sectors - 1))) {
319 command_print(CMD_CTX, "ERROR: "
320 "last sector must be <= %" PRIu32,
325 struct duration bench;
326 duration_start(&bench);
328 retval = flash_driver_erase(p, first, last);
330 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
331 command_print(CMD_CTX, "erased sectors %" PRIu32 " "
332 "through %" PRIu32 " on flash bank %d "
333 "in %fs", first, last, p->bank_number, duration_elapsed(&bench));
339 COMMAND_HANDLER(handle_flash_protect_command)
342 return ERROR_COMMAND_SYNTAX_ERROR;
347 struct flash_bank *p;
351 retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
352 if (retval != ERROR_OK)
355 if (p->num_prot_blocks)
356 num_blocks = p->num_prot_blocks;
358 num_blocks = p->num_sectors;
360 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], first);
361 if (strcmp(CMD_ARGV[2], "last") == 0)
362 last = num_blocks - 1;
364 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], last);
367 COMMAND_PARSE_ON_OFF(CMD_ARGV[3], set);
369 if (!(first <= last)) {
370 command_print(CMD_CTX, "ERROR: "
371 "first %s must be <= last",
372 (p->num_prot_blocks) ? "block" : "sector");
376 if (!(last <= (uint32_t)(num_blocks - 1))) {
377 command_print(CMD_CTX, "ERROR: "
378 "last %s must be <= %" PRIu32,
379 (p->num_prot_blocks) ? "block" : "sector",
384 retval = flash_driver_protect(p, set, first, last);
385 if (retval == ERROR_OK) {
386 command_print(CMD_CTX, "%s protection for %s %" PRIu32
387 " through %" PRIu32 " on flash bank %d",
388 (set) ? "set" : "cleared",
389 (p->num_prot_blocks) ? "blocks" : "sectors",
390 first, last, p->bank_number);
396 COMMAND_HANDLER(handle_flash_write_image_command)
398 struct target *target = get_current_target(CMD_CTX);
405 /* flash auto-erase is disabled by default*/
407 bool auto_unlock = false;
410 if (strcmp(CMD_ARGV[0], "erase") == 0) {
414 command_print(CMD_CTX, "auto erase enabled");
415 } else if (strcmp(CMD_ARGV[0], "unlock") == 0) {
419 command_print(CMD_CTX, "auto unlock enabled");
425 return ERROR_COMMAND_SYNTAX_ERROR;
428 LOG_ERROR("no target selected");
432 struct duration bench;
433 duration_start(&bench);
436 image.base_address_set = 1;
437 COMMAND_PARSE_NUMBER(llong, CMD_ARGV[1], image.base_address);
439 image.base_address_set = 0;
440 image.base_address = 0x0;
443 image.start_address_set = 0;
445 retval = image_open(&image, CMD_ARGV[0], (CMD_ARGC == 3) ? CMD_ARGV[2] : NULL);
446 if (retval != ERROR_OK)
449 retval = flash_write_unlock(target, &image, &written, auto_erase, auto_unlock);
450 if (retval != ERROR_OK) {
455 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
456 command_print(CMD_CTX, "wrote %" PRIu32 " bytes from file %s "
457 "in %fs (%0.3f KiB/s)", written, CMD_ARGV[0],
458 duration_elapsed(&bench), duration_kbps(&bench, written));
466 COMMAND_HANDLER(handle_flash_fill_command)
468 target_addr_t address;
471 struct target *target = get_current_target(CMD_CTX);
477 return ERROR_COMMAND_SYNTAX_ERROR;
480 COMMAND_PARSE_NUMBER(u64, CMD_ARGV[0], address);
482 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);
487 struct flash_bank *bank;
488 retval = get_flash_bank_by_addr(target, address, true, &bank);
489 if (retval != ERROR_OK)
492 switch (CMD_NAME[4]) {
503 return ERROR_COMMAND_SYNTAX_ERROR;
509 if (address + count * wordsize > bank->base + bank->size) {
510 LOG_ERROR("Cannot cross flash bank borders");
514 uint32_t size_bytes = count * wordsize;
515 target_addr_t aligned_start = flash_write_align_start(bank, address);
516 target_addr_t end_addr = address + size_bytes - 1;
517 target_addr_t aligned_end = flash_write_align_end(bank, end_addr);
518 uint32_t aligned_size = aligned_end + 1 - aligned_start;
519 uint32_t padding_at_start = address - aligned_start;
520 uint32_t padding_at_end = aligned_end - end_addr;
522 uint8_t *buffer = malloc(aligned_size);
526 if (padding_at_start) {
527 memset(buffer, bank->default_padded_value, padding_at_start);
528 LOG_WARNING("Start address " TARGET_ADDR_FMT
529 " breaks the required alignment of flash bank %s",
530 address, bank->name);
531 LOG_WARNING("Padding %" PRId32 " bytes from " TARGET_ADDR_FMT,
532 padding_at_start, aligned_start);
535 uint8_t *ptr = buffer + padding_at_start;
539 for (i = 0; i < count; i++, ptr += wordsize)
540 target_buffer_set_u32(target, ptr, pattern);
543 for (i = 0; i < count; i++, ptr += wordsize)
544 target_buffer_set_u16(target, ptr, pattern);
547 memset(ptr, pattern, count);
551 LOG_ERROR("BUG: can't happen");
555 if (padding_at_end) {
556 memset(ptr, bank->default_padded_value, padding_at_end);
557 LOG_INFO("Padding at " TARGET_ADDR_FMT " with %" PRId32
558 " bytes (bank write end alignment)",
559 end_addr + 1, padding_at_end);
562 struct duration bench;
563 duration_start(&bench);
565 retval = flash_driver_write(bank, buffer, aligned_start - bank->base, aligned_size);
566 if (retval != ERROR_OK)
569 retval = flash_driver_read(bank, buffer, address - bank->base, size_bytes);
570 if (retval != ERROR_OK)
573 for (i = 0, ptr = buffer; i < count; i++) {
574 uint32_t readback = 0;
578 readback = target_buffer_get_u32(target, ptr);
581 readback = target_buffer_get_u16(target, ptr);
587 if (readback != pattern) {
589 "Verification error address " TARGET_ADDR_FMT
590 ", read back 0x%02" PRIx32 ", expected 0x%02" PRIx32,
591 address + i * wordsize, readback, pattern);
598 if ((retval == ERROR_OK) && (duration_measure(&bench) == ERROR_OK)) {
599 command_print(CMD_CTX, "wrote %" PRIu32 " bytes to " TARGET_ADDR_FMT
600 " in %fs (%0.3f KiB/s)", size_bytes, address,
601 duration_elapsed(&bench), duration_kbps(&bench, size_bytes));
610 COMMAND_HANDLER(handle_flash_write_bank_command)
615 struct fileio *fileio;
617 if (CMD_ARGC < 2 || CMD_ARGC > 3)
618 return ERROR_COMMAND_SYNTAX_ERROR;
620 struct duration bench;
621 duration_start(&bench);
623 struct flash_bank *bank;
624 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
625 if (ERROR_OK != retval)
631 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset);
633 if (offset > bank->size) {
634 LOG_ERROR("Offset 0x%8.8" PRIx32 " is out of range of the flash bank",
636 return ERROR_COMMAND_ARGUMENT_INVALID;
639 if (fileio_open(&fileio, CMD_ARGV[1], FILEIO_READ, FILEIO_BINARY) != ERROR_OK)
643 retval = fileio_size(fileio, &filesize);
644 if (retval != ERROR_OK) {
645 fileio_close(fileio);
649 length = MIN(filesize, bank->size - offset);
652 LOG_INFO("Nothing to write to flash bank");
653 fileio_close(fileio);
657 if (length != filesize)
658 LOG_INFO("File content exceeds flash bank size. Only writing the "
659 "first %zu bytes of the file", length);
661 target_addr_t start_addr = bank->base + offset;
662 target_addr_t aligned_start = flash_write_align_start(bank, start_addr);
663 target_addr_t end_addr = start_addr + length - 1;
664 target_addr_t aligned_end = flash_write_align_end(bank, end_addr);
665 uint32_t aligned_size = aligned_end + 1 - aligned_start;
666 uint32_t padding_at_start = start_addr - aligned_start;
667 uint32_t padding_at_end = aligned_end - end_addr;
669 buffer = malloc(aligned_size);
670 if (buffer == NULL) {
671 fileio_close(fileio);
672 LOG_ERROR("Out of memory");
676 if (padding_at_start) {
677 memset(buffer, bank->default_padded_value, padding_at_start);
678 LOG_WARNING("Start offset 0x%08" PRIx32
679 " breaks the required alignment of flash bank %s",
681 LOG_WARNING("Padding %" PRId32 " bytes from " TARGET_ADDR_FMT,
682 padding_at_start, aligned_start);
685 uint8_t *ptr = buffer + padding_at_start;
687 if (fileio_read(fileio, length, ptr, &buf_cnt) != ERROR_OK) {
689 fileio_close(fileio);
693 if (buf_cnt != length) {
694 LOG_ERROR("Short read");
701 if (padding_at_end) {
702 memset(ptr, bank->default_padded_value, padding_at_end);
703 LOG_INFO("Padding at " TARGET_ADDR_FMT " with %" PRId32
704 " bytes (bank write end alignment)",
705 end_addr + 1, padding_at_end);
708 retval = flash_driver_write(bank, buffer, aligned_start - bank->base, aligned_size);
712 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
713 command_print(CMD_CTX, "wrote %zu bytes from file %s to flash bank %u"
714 " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)",
715 length, CMD_ARGV[1], bank->bank_number, offset,
716 duration_elapsed(&bench), duration_kbps(&bench, length));
719 fileio_close(fileio);
724 COMMAND_HANDLER(handle_flash_read_bank_command)
728 struct fileio *fileio;
732 if (CMD_ARGC < 2 || CMD_ARGC > 4)
733 return ERROR_COMMAND_SYNTAX_ERROR;
735 struct duration bench;
736 duration_start(&bench);
738 struct flash_bank *p;
739 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
741 if (ERROR_OK != retval)
747 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset);
749 if (offset > p->size) {
750 LOG_ERROR("Offset 0x%8.8" PRIx32 " is out of range of the flash bank",
752 return ERROR_COMMAND_ARGUMENT_INVALID;
755 length = p->size - offset;
758 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[3], length);
760 if (offset + length > p->size) {
761 LOG_ERROR("Length of %" PRIu32 " bytes with offset 0x%8.8" PRIx32
762 " is out of range of the flash bank", length, offset);
763 return ERROR_COMMAND_ARGUMENT_INVALID;
766 buffer = malloc(length);
767 if (buffer == NULL) {
768 LOG_ERROR("Out of memory");
772 retval = flash_driver_read(p, buffer, offset, length);
773 if (retval != ERROR_OK) {
774 LOG_ERROR("Read error");
779 retval = fileio_open(&fileio, CMD_ARGV[1], FILEIO_WRITE, FILEIO_BINARY);
780 if (retval != ERROR_OK) {
781 LOG_ERROR("Could not open file");
786 retval = fileio_write(fileio, length, buffer, &written);
787 fileio_close(fileio);
789 if (retval != ERROR_OK) {
790 LOG_ERROR("Could not write file");
794 if (duration_measure(&bench) == ERROR_OK)
795 command_print(CMD_CTX, "wrote %zd bytes to file %s from flash bank %u"
796 " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)",
797 written, CMD_ARGV[1], p->bank_number, offset,
798 duration_elapsed(&bench), duration_kbps(&bench, written));
804 COMMAND_HANDLER(handle_flash_verify_bank_command)
807 uint8_t *buffer_file, *buffer_flash;
808 struct fileio *fileio;
814 if (CMD_ARGC < 2 || CMD_ARGC > 3)
815 return ERROR_COMMAND_SYNTAX_ERROR;
817 struct duration bench;
818 duration_start(&bench);
820 struct flash_bank *p;
821 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
822 if (ERROR_OK != retval)
828 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset);
830 if (offset > p->size) {
831 LOG_ERROR("Offset 0x%8.8" PRIx32 " is out of range of the flash bank",
833 return ERROR_COMMAND_ARGUMENT_INVALID;
836 retval = fileio_open(&fileio, CMD_ARGV[1], FILEIO_READ, FILEIO_BINARY);
837 if (retval != ERROR_OK) {
838 LOG_ERROR("Could not open file");
842 retval = fileio_size(fileio, &filesize);
843 if (retval != ERROR_OK) {
844 fileio_close(fileio);
848 length = MIN(filesize, p->size - offset);
851 LOG_INFO("Nothing to compare with flash bank");
852 fileio_close(fileio);
856 if (length != filesize)
857 LOG_INFO("File content exceeds flash bank size. Only comparing the "
858 "first %zu bytes of the file", length);
860 buffer_file = malloc(length);
861 if (buffer_file == NULL) {
862 LOG_ERROR("Out of memory");
863 fileio_close(fileio);
867 retval = fileio_read(fileio, length, buffer_file, &read_cnt);
868 fileio_close(fileio);
869 if (retval != ERROR_OK) {
870 LOG_ERROR("File read failure");
875 if (read_cnt != length) {
876 LOG_ERROR("Short read");
881 buffer_flash = malloc(length);
882 if (buffer_flash == NULL) {
883 LOG_ERROR("Out of memory");
888 retval = flash_driver_read(p, buffer_flash, offset, length);
889 if (retval != ERROR_OK) {
890 LOG_ERROR("Flash read error");
896 if (duration_measure(&bench) == ERROR_OK)
897 command_print(CMD_CTX, "read %zd bytes from file %s and flash bank %u"
898 " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)",
899 length, CMD_ARGV[1], p->bank_number, offset,
900 duration_elapsed(&bench), duration_kbps(&bench, length));
902 differ = memcmp(buffer_file, buffer_flash, length);
903 command_print(CMD_CTX, "contents %s", differ ? "differ" : "match");
907 for (t = 0; t < length; t++) {
908 if (buffer_flash[t] == buffer_file[t])
910 command_print(CMD_CTX, "diff %d address 0x%08x. Was 0x%02x instead of 0x%02x",
911 diffs, t + offset, buffer_flash[t], buffer_file[t]);
912 if (diffs++ >= 127) {
913 command_print(CMD_CTX, "More than 128 errors, the rest are not printed.");
922 return differ ? ERROR_FAIL : ERROR_OK;
925 void flash_set_dirty(void)
927 struct flash_bank *c;
930 /* set all flash to require erasing */
931 for (c = flash_bank_list(); c; c = c->next) {
932 for (i = 0; i < c->num_sectors; i++)
933 c->sectors[i].is_erased = 0;
937 COMMAND_HANDLER(handle_flash_padded_value_command)
940 return ERROR_COMMAND_SYNTAX_ERROR;
942 struct flash_bank *p;
943 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
944 if (ERROR_OK != retval)
947 COMMAND_PARSE_NUMBER(u8, CMD_ARGV[1], p->default_padded_value);
949 command_print(CMD_CTX, "Default padded value set to 0x%" PRIx8 " for flash bank %u", \
950 p->default_padded_value, p->bank_number);
955 static const struct command_registration flash_exec_command_handlers[] = {
958 .handler = handle_flash_probe_command,
959 .mode = COMMAND_EXEC,
961 .help = "Identify a flash bank.",
965 .handler = handle_flash_info_command,
966 .mode = COMMAND_EXEC,
967 .usage = "bank_id ['sectors']",
968 .help = "Print information about a flash bank.",
971 .name = "erase_check",
972 .handler = handle_flash_erase_check_command,
973 .mode = COMMAND_EXEC,
975 .help = "Check erase state of all blocks in a "
979 .name = "erase_sector",
980 .handler = handle_flash_erase_command,
981 .mode = COMMAND_EXEC,
982 .usage = "bank_id first_sector_num last_sector_num",
983 .help = "Erase a range of sectors in a flash bank.",
986 .name = "erase_address",
987 .handler = handle_flash_erase_address_command,
988 .mode = COMMAND_EXEC,
989 .usage = "['pad'] ['unlock'] address length",
990 .help = "Erase flash sectors starting at address and "
991 "continuing for length bytes. If 'pad' is specified, "
992 "data outside that range may also be erased: the start "
993 "address may be decreased, and length increased, so "
994 "that all of the first and last sectors are erased. "
995 "If 'unlock' is specified, then the flash is unprotected "
1001 .handler = handle_flash_fill_command,
1002 .mode = COMMAND_EXEC,
1003 .usage = "address value n",
1004 .help = "Fill n words with 32-bit value, starting at "
1005 "word address. (No autoerase.)",
1009 .handler = handle_flash_fill_command,
1010 .mode = COMMAND_EXEC,
1011 .usage = "address value n",
1012 .help = "Fill n halfwords with 16-bit value, starting at "
1013 "word address. (No autoerase.)",
1017 .handler = handle_flash_fill_command,
1018 .mode = COMMAND_EXEC,
1019 .usage = "address value n",
1020 .help = "Fill n bytes with 8-bit value, starting at "
1021 "word address. (No autoerase.)",
1024 .name = "write_bank",
1025 .handler = handle_flash_write_bank_command,
1026 .mode = COMMAND_EXEC,
1027 .usage = "bank_id filename [offset]",
1028 .help = "Write binary data from file to flash bank. Allow optional "
1029 "offset from beginning of the bank (defaults to zero).",
1032 .name = "write_image",
1033 .handler = handle_flash_write_image_command,
1034 .mode = COMMAND_EXEC,
1035 .usage = "[erase] [unlock] filename [offset [file_type]]",
1036 .help = "Write an image to flash. Optionally first unprotect "
1037 "and/or erase the region to be used. Allow optional "
1038 "offset from beginning of bank (defaults to zero)",
1041 .name = "read_bank",
1042 .handler = handle_flash_read_bank_command,
1043 .mode = COMMAND_EXEC,
1044 .usage = "bank_id filename [offset [length]]",
1045 .help = "Read binary data from flash bank to file. Allow optional "
1046 "offset from beginning of the bank (defaults to zero).",
1049 .name = "verify_bank",
1050 .handler = handle_flash_verify_bank_command,
1051 .mode = COMMAND_EXEC,
1052 .usage = "bank_id filename [offset]",
1053 .help = "Compare the contents of a file with the contents of the "
1054 "flash bank. Allow optional offset from beginning of the bank "
1055 "(defaults to zero).",
1059 .handler = handle_flash_protect_command,
1060 .mode = COMMAND_EXEC,
1061 .usage = "bank_id first_block [last_block|'last'] "
1063 .help = "Turn protection on or off for a range of protection "
1064 "blocks or sectors in a given flash bank. "
1065 "See 'flash info' output for a list of blocks.",
1068 .name = "padded_value",
1069 .handler = handle_flash_padded_value_command,
1070 .mode = COMMAND_EXEC,
1071 .usage = "bank_id value",
1072 .help = "Set default flash padded value",
1074 COMMAND_REGISTRATION_DONE
1077 static int flash_init_drivers(struct command_context *cmd_ctx)
1079 if (!flash_bank_list())
1082 struct command *parent = command_find_in_context(cmd_ctx, "flash");
1083 return register_commands(cmd_ctx, parent, flash_exec_command_handlers);
1086 COMMAND_HANDLER(handle_flash_bank_command)
1089 LOG_ERROR("usage: flash bank <name> <driver> "
1090 "<base> <size> <chip_width> <bus_width> <target>");
1091 return ERROR_COMMAND_SYNTAX_ERROR;
1093 /* save bank name and advance arguments for compatibility */
1094 const char *bank_name = *CMD_ARGV++;
1097 struct target *target = get_target(CMD_ARGV[5]);
1098 if (target == NULL) {
1099 LOG_ERROR("target '%s' not defined", CMD_ARGV[5]);
1103 const char *driver_name = CMD_ARGV[0];
1104 struct flash_driver *driver = flash_driver_find_by_name(driver_name);
1105 if (NULL == driver) {
1106 /* no matching flash driver found */
1107 LOG_ERROR("flash driver '%s' not found", driver_name);
1111 /* check the flash bank name is unique */
1112 if (get_flash_bank_by_name_noprobe(bank_name) != NULL) {
1113 /* flash bank name already exists */
1114 LOG_ERROR("flash bank name '%s' already exists", bank_name);
1118 /* register flash specific commands */
1119 if (NULL != driver->commands) {
1120 int retval = register_commands(CMD_CTX, NULL,
1122 if (ERROR_OK != retval) {
1123 LOG_ERROR("couldn't register '%s' commands",
1129 struct flash_bank *c = calloc(1, sizeof(*c));
1130 c->name = strdup(bank_name);
1133 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], c->base);
1134 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], c->size);
1135 COMMAND_PARSE_NUMBER(int, CMD_ARGV[3], c->chip_width);
1136 COMMAND_PARSE_NUMBER(int, CMD_ARGV[4], c->bus_width);
1137 c->default_padded_value = c->erased_value = 0xff;
1138 c->minimal_write_gap = FLASH_WRITE_GAP_SECTOR;
1141 retval = CALL_COMMAND_HANDLER(driver->flash_bank_command, c);
1142 if (ERROR_OK != retval) {
1143 LOG_ERROR("'%s' driver rejected flash bank at 0x%8.8" PRIx32 "; usage: %s",
1144 driver_name, c->base, driver->usage);
1149 if (driver->usage == NULL)
1150 LOG_DEBUG("'%s' driver usage field missing", driver_name);
1157 COMMAND_HANDLER(handle_flash_banks_command)
1160 return ERROR_COMMAND_SYNTAX_ERROR;
1163 for (struct flash_bank *p = flash_bank_list(); p; p = p->next, n++) {
1164 LOG_USER("#%d : %s (%s) at 0x%8.8" PRIx32 ", size 0x%8.8" PRIx32 ", "
1165 "buswidth %u, chipwidth %u", p->bank_number,
1166 p->name, p->driver->name, p->base, p->size,
1167 p->bus_width, p->chip_width);
1172 static int jim_flash_list(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
1175 Jim_WrongNumArgs(interp, 1, argv,
1176 "no arguments to 'flash list' command");
1180 Jim_Obj *list = Jim_NewListObj(interp, NULL, 0);
1182 for (struct flash_bank *p = flash_bank_list(); p; p = p->next) {
1183 Jim_Obj *elem = Jim_NewListObj(interp, NULL, 0);
1185 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "name", -1));
1186 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, p->driver->name, -1));
1187 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "base", -1));
1188 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->base));
1189 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "size", -1));
1190 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->size));
1191 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "bus_width", -1));
1192 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->bus_width));
1193 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "chip_width", -1));
1194 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->chip_width));
1196 Jim_ListAppendElement(interp, list, elem);
1199 Jim_SetResult(interp, list);
1204 COMMAND_HANDLER(handle_flash_init_command)
1207 return ERROR_COMMAND_SYNTAX_ERROR;
1209 static bool flash_initialized;
1210 if (flash_initialized) {
1211 LOG_INFO("'flash init' has already been called");
1214 flash_initialized = true;
1216 LOG_DEBUG("Initializing flash devices...");
1217 return flash_init_drivers(CMD_CTX);
1220 static const struct command_registration flash_config_command_handlers[] = {
1223 .handler = handle_flash_bank_command,
1224 .mode = COMMAND_CONFIG,
1225 .usage = "bank_id driver_name base_address size_bytes "
1226 "chip_width_bytes bus_width_bytes target "
1227 "[driver_options ...]",
1228 .help = "Define a new bank with the given name, "
1229 "using the specified NOR flash driver.",
1233 .mode = COMMAND_CONFIG,
1234 .handler = handle_flash_init_command,
1235 .help = "Initialize flash devices.",
1239 .mode = COMMAND_ANY,
1240 .handler = handle_flash_banks_command,
1241 .help = "Display table with information about flash banks.",
1245 .mode = COMMAND_ANY,
1246 .jim_handler = jim_flash_list,
1247 .help = "Returns a list of details about the flash banks.",
1249 COMMAND_REGISTRATION_DONE
1251 static const struct command_registration flash_command_handlers[] = {
1254 .mode = COMMAND_ANY,
1255 .help = "NOR flash command group",
1256 .chain = flash_config_command_handlers,
1258 COMMAND_REGISTRATION_DONE
1261 int flash_register_commands(struct command_context *cmd_ctx)
1263 return register_commands(cmd_ctx, NULL, flash_command_handlers);