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
;
490 COMMAND_PARSE_NUMBER(u64
, CMD_ARGV
[0], address
);
492 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[0], address
);
494 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], pattern
);
495 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], count
);
497 struct flash_bank
*bank
;
498 retval
= get_flash_bank_by_addr(target
, address
, true, &bank
);
499 if (retval
!= ERROR_OK
)
502 switch (CMD_NAME
[4]) {
513 return ERROR_COMMAND_SYNTAX_ERROR
;
519 if (address
+ count
* wordsize
> bank
->base
+ bank
->size
) {
520 LOG_ERROR("Cannot cross flash bank borders");
524 uint32_t size_bytes
= count
* wordsize
;
525 target_addr_t aligned_start
= flash_write_align_start(bank
, address
);
526 target_addr_t end_addr
= address
+ size_bytes
- 1;
527 target_addr_t aligned_end
= flash_write_align_end(bank
, end_addr
);
528 uint32_t aligned_size
= aligned_end
+ 1 - aligned_start
;
529 uint32_t padding_at_start
= address
- aligned_start
;
530 uint32_t padding_at_end
= aligned_end
- end_addr
;
532 uint8_t *buffer
= malloc(aligned_size
);
536 if (padding_at_start
) {
537 memset(buffer
, bank
->default_padded_value
, padding_at_start
);
538 LOG_WARNING("Start address " TARGET_ADDR_FMT
539 " breaks the required alignment of flash bank %s",
540 address
, bank
->name
);
541 LOG_WARNING("Padding %" PRId32
" bytes from " TARGET_ADDR_FMT
,
542 padding_at_start
, aligned_start
);
545 uint8_t *ptr
= buffer
+ padding_at_start
;
549 for (i
= 0; i
< count
; i
++, ptr
+= wordsize
)
550 target_buffer_set_u32(target
, ptr
, pattern
);
553 for (i
= 0; i
< count
; i
++, ptr
+= wordsize
)
554 target_buffer_set_u16(target
, ptr
, pattern
);
557 memset(ptr
, pattern
, count
);
561 LOG_ERROR("BUG: can't happen");
565 if (padding_at_end
) {
566 memset(ptr
, bank
->default_padded_value
, padding_at_end
);
567 LOG_INFO("Padding at " TARGET_ADDR_FMT
" with %" PRId32
568 " bytes (bank write end alignment)",
569 end_addr
+ 1, padding_at_end
);
572 struct duration bench
;
573 duration_start(&bench
);
575 retval
= flash_driver_write(bank
, buffer
, aligned_start
- bank
->base
, aligned_size
);
576 if (retval
!= ERROR_OK
)
579 retval
= flash_driver_read(bank
, buffer
, address
- bank
->base
, size_bytes
);
580 if (retval
!= ERROR_OK
)
583 for (i
= 0, ptr
= buffer
; i
< count
; i
++) {
584 uint32_t readback
= 0;
588 readback
= target_buffer_get_u32(target
, ptr
);
591 readback
= target_buffer_get_u16(target
, ptr
);
597 if (readback
!= pattern
) {
599 "Verification error address " TARGET_ADDR_FMT
600 ", read back 0x%02" PRIx32
", expected 0x%02" PRIx32
,
601 address
+ i
* wordsize
, readback
, pattern
);
608 if ((retval
== ERROR_OK
) && (duration_measure(&bench
) == ERROR_OK
)) {
609 command_print(CMD_CTX
, "wrote %" PRIu32
" bytes to " TARGET_ADDR_FMT
610 " in %fs (%0.3f KiB/s)", size_bytes
, address
,
611 duration_elapsed(&bench
), duration_kbps(&bench
, size_bytes
));
620 COMMAND_HANDLER(handle_flash_write_bank_command
)
625 struct fileio
*fileio
;
627 if (CMD_ARGC
< 2 || CMD_ARGC
> 3)
628 return ERROR_COMMAND_SYNTAX_ERROR
;
630 struct duration bench
;
631 duration_start(&bench
);
633 struct flash_bank
*bank
;
634 int retval
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &bank
);
635 if (ERROR_OK
!= retval
)
641 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], offset
);
643 if (offset
> bank
->size
) {
644 LOG_ERROR("Offset 0x%8.8" PRIx32
" is out of range of the flash bank",
646 return ERROR_COMMAND_ARGUMENT_INVALID
;
649 if (fileio_open(&fileio
, CMD_ARGV
[1], FILEIO_READ
, FILEIO_BINARY
) != ERROR_OK
)
653 retval
= fileio_size(fileio
, &filesize
);
654 if (retval
!= ERROR_OK
) {
655 fileio_close(fileio
);
659 length
= MIN(filesize
, bank
->size
- offset
);
662 LOG_INFO("Nothing to write to flash bank");
663 fileio_close(fileio
);
667 if (length
!= filesize
)
668 LOG_INFO("File content exceeds flash bank size. Only writing the "
669 "first %zu bytes of the file", length
);
671 target_addr_t start_addr
= bank
->base
+ offset
;
672 target_addr_t aligned_start
= flash_write_align_start(bank
, start_addr
);
673 target_addr_t end_addr
= start_addr
+ length
- 1;
674 target_addr_t aligned_end
= flash_write_align_end(bank
, end_addr
);
675 uint32_t aligned_size
= aligned_end
+ 1 - aligned_start
;
676 uint32_t padding_at_start
= start_addr
- aligned_start
;
677 uint32_t padding_at_end
= aligned_end
- end_addr
;
679 buffer
= malloc(aligned_size
);
680 if (buffer
== NULL
) {
681 fileio_close(fileio
);
682 LOG_ERROR("Out of memory");
686 if (padding_at_start
) {
687 memset(buffer
, bank
->default_padded_value
, padding_at_start
);
688 LOG_WARNING("Start offset 0x%08" PRIx32
689 " breaks the required alignment of flash bank %s",
691 LOG_WARNING("Padding %" PRId32
" bytes from " TARGET_ADDR_FMT
,
692 padding_at_start
, aligned_start
);
695 uint8_t *ptr
= buffer
+ padding_at_start
;
697 if (fileio_read(fileio
, length
, ptr
, &buf_cnt
) != ERROR_OK
) {
699 fileio_close(fileio
);
703 if (buf_cnt
!= length
) {
704 LOG_ERROR("Short read");
711 if (padding_at_end
) {
712 memset(ptr
, bank
->default_padded_value
, padding_at_end
);
713 LOG_INFO("Padding at " TARGET_ADDR_FMT
" with %" PRId32
714 " bytes (bank write end alignment)",
715 end_addr
+ 1, padding_at_end
);
718 retval
= flash_driver_write(bank
, buffer
, aligned_start
- bank
->base
, aligned_size
);
722 if ((ERROR_OK
== retval
) && (duration_measure(&bench
) == ERROR_OK
)) {
723 command_print(CMD_CTX
, "wrote %zu bytes from file %s to flash bank %u"
724 " at offset 0x%8.8" PRIx32
" in %fs (%0.3f KiB/s)",
725 length
, CMD_ARGV
[1], bank
->bank_number
, offset
,
726 duration_elapsed(&bench
), duration_kbps(&bench
, length
));
729 fileio_close(fileio
);
734 COMMAND_HANDLER(handle_flash_read_bank_command
)
738 struct fileio
*fileio
;
742 if (CMD_ARGC
< 2 || CMD_ARGC
> 4)
743 return ERROR_COMMAND_SYNTAX_ERROR
;
745 struct duration bench
;
746 duration_start(&bench
);
748 struct flash_bank
*p
;
749 int retval
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &p
);
751 if (ERROR_OK
!= retval
)
757 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], offset
);
759 if (offset
> p
->size
) {
760 LOG_ERROR("Offset 0x%8.8" PRIx32
" is out of range of the flash bank",
762 return ERROR_COMMAND_ARGUMENT_INVALID
;
765 length
= p
->size
- offset
;
768 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[3], length
);
770 if (offset
+ length
> p
->size
) {
771 LOG_ERROR("Length of %" PRIu32
" bytes with offset 0x%8.8" PRIx32
772 " is out of range of the flash bank", length
, offset
);
773 return ERROR_COMMAND_ARGUMENT_INVALID
;
776 buffer
= malloc(length
);
777 if (buffer
== NULL
) {
778 LOG_ERROR("Out of memory");
782 retval
= flash_driver_read(p
, buffer
, offset
, length
);
783 if (retval
!= ERROR_OK
) {
784 LOG_ERROR("Read error");
789 retval
= fileio_open(&fileio
, CMD_ARGV
[1], FILEIO_WRITE
, FILEIO_BINARY
);
790 if (retval
!= ERROR_OK
) {
791 LOG_ERROR("Could not open file");
796 retval
= fileio_write(fileio
, length
, buffer
, &written
);
797 fileio_close(fileio
);
799 if (retval
!= ERROR_OK
) {
800 LOG_ERROR("Could not write file");
804 if (duration_measure(&bench
) == ERROR_OK
)
805 command_print(CMD_CTX
, "wrote %zd bytes to file %s from flash bank %u"
806 " at offset 0x%8.8" PRIx32
" in %fs (%0.3f KiB/s)",
807 written
, CMD_ARGV
[1], p
->bank_number
, offset
,
808 duration_elapsed(&bench
), duration_kbps(&bench
, written
));
814 COMMAND_HANDLER(handle_flash_verify_bank_command
)
817 uint8_t *buffer_file
, *buffer_flash
;
818 struct fileio
*fileio
;
824 if (CMD_ARGC
< 2 || CMD_ARGC
> 3)
825 return ERROR_COMMAND_SYNTAX_ERROR
;
827 struct duration bench
;
828 duration_start(&bench
);
830 struct flash_bank
*p
;
831 int retval
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &p
);
832 if (ERROR_OK
!= retval
)
838 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], offset
);
840 if (offset
> p
->size
) {
841 LOG_ERROR("Offset 0x%8.8" PRIx32
" is out of range of the flash bank",
843 return ERROR_COMMAND_ARGUMENT_INVALID
;
846 retval
= fileio_open(&fileio
, CMD_ARGV
[1], FILEIO_READ
, FILEIO_BINARY
);
847 if (retval
!= ERROR_OK
) {
848 LOG_ERROR("Could not open file");
852 retval
= fileio_size(fileio
, &filesize
);
853 if (retval
!= ERROR_OK
) {
854 fileio_close(fileio
);
858 length
= MIN(filesize
, p
->size
- offset
);
861 LOG_INFO("Nothing to compare with flash bank");
862 fileio_close(fileio
);
866 if (length
!= filesize
)
867 LOG_INFO("File content exceeds flash bank size. Only comparing the "
868 "first %zu bytes of the file", length
);
870 buffer_file
= malloc(length
);
871 if (buffer_file
== NULL
) {
872 LOG_ERROR("Out of memory");
873 fileio_close(fileio
);
877 retval
= fileio_read(fileio
, length
, buffer_file
, &read_cnt
);
878 fileio_close(fileio
);
879 if (retval
!= ERROR_OK
) {
880 LOG_ERROR("File read failure");
885 if (read_cnt
!= length
) {
886 LOG_ERROR("Short read");
891 buffer_flash
= malloc(length
);
892 if (buffer_flash
== NULL
) {
893 LOG_ERROR("Out of memory");
898 retval
= flash_driver_read(p
, buffer_flash
, offset
, length
);
899 if (retval
!= ERROR_OK
) {
900 LOG_ERROR("Flash read error");
906 if (duration_measure(&bench
) == ERROR_OK
)
907 command_print(CMD_CTX
, "read %zd bytes from file %s and flash bank %u"
908 " at offset 0x%8.8" PRIx32
" in %fs (%0.3f KiB/s)",
909 length
, CMD_ARGV
[1], p
->bank_number
, offset
,
910 duration_elapsed(&bench
), duration_kbps(&bench
, length
));
912 differ
= memcmp(buffer_file
, buffer_flash
, length
);
913 command_print(CMD_CTX
, "contents %s", differ
? "differ" : "match");
917 for (t
= 0; t
< length
; t
++) {
918 if (buffer_flash
[t
] == buffer_file
[t
])
920 command_print(CMD_CTX
, "diff %d address 0x%08x. Was 0x%02x instead of 0x%02x",
921 diffs
, t
+ offset
, buffer_flash
[t
], buffer_file
[t
]);
922 if (diffs
++ >= 127) {
923 command_print(CMD_CTX
, "More than 128 errors, the rest are not printed.");
932 return differ
? ERROR_FAIL
: ERROR_OK
;
935 void flash_set_dirty(void)
937 struct flash_bank
*c
;
940 /* set all flash to require erasing */
941 for (c
= flash_bank_list(); c
; c
= c
->next
) {
942 for (i
= 0; i
< c
->num_sectors
; i
++)
943 c
->sectors
[i
].is_erased
= 0;
947 COMMAND_HANDLER(handle_flash_padded_value_command
)
950 return ERROR_COMMAND_SYNTAX_ERROR
;
952 struct flash_bank
*p
;
953 int retval
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &p
);
954 if (ERROR_OK
!= retval
)
957 COMMAND_PARSE_NUMBER(u8
, CMD_ARGV
[1], p
->default_padded_value
);
959 command_print(CMD_CTX
, "Default padded value set to 0x%" PRIx8
" for flash bank %u", \
960 p
->default_padded_value
, p
->bank_number
);
965 static const struct command_registration flash_exec_command_handlers
[] = {
968 .handler
= handle_flash_probe_command
,
969 .mode
= COMMAND_EXEC
,
971 .help
= "Identify a flash bank.",
975 .handler
= handle_flash_info_command
,
976 .mode
= COMMAND_EXEC
,
977 .usage
= "bank_id ['sectors']",
978 .help
= "Print information about a flash bank.",
981 .name
= "erase_check",
982 .handler
= handle_flash_erase_check_command
,
983 .mode
= COMMAND_EXEC
,
985 .help
= "Check erase state of all blocks in a "
989 .name
= "erase_sector",
990 .handler
= handle_flash_erase_command
,
991 .mode
= COMMAND_EXEC
,
992 .usage
= "bank_id first_sector_num last_sector_num",
993 .help
= "Erase a range of sectors in a flash bank.",
996 .name
= "erase_address",
997 .handler
= handle_flash_erase_address_command
,
998 .mode
= COMMAND_EXEC
,
999 .usage
= "['pad'] ['unlock'] address length",
1000 .help
= "Erase flash sectors starting at address and "
1001 "continuing for length bytes. If 'pad' is specified, "
1002 "data outside that range may also be erased: the start "
1003 "address may be decreased, and length increased, so "
1004 "that all of the first and last sectors are erased. "
1005 "If 'unlock' is specified, then the flash is unprotected "
1011 .handler
= handle_flash_fill_command
,
1012 .mode
= COMMAND_EXEC
,
1013 .usage
= "address value n",
1014 .help
= "Fill n words with 32-bit value, starting at "
1015 "word address. (No autoerase.)",
1019 .handler
= handle_flash_fill_command
,
1020 .mode
= COMMAND_EXEC
,
1021 .usage
= "address value n",
1022 .help
= "Fill n halfwords with 16-bit value, starting at "
1023 "word address. (No autoerase.)",
1027 .handler
= handle_flash_fill_command
,
1028 .mode
= COMMAND_EXEC
,
1029 .usage
= "address value n",
1030 .help
= "Fill n bytes with 8-bit value, starting at "
1031 "word address. (No autoerase.)",
1034 .name
= "write_bank",
1035 .handler
= handle_flash_write_bank_command
,
1036 .mode
= COMMAND_EXEC
,
1037 .usage
= "bank_id filename [offset]",
1038 .help
= "Write binary data from file to flash bank. Allow optional "
1039 "offset from beginning of the bank (defaults to zero).",
1042 .name
= "write_image",
1043 .handler
= handle_flash_write_image_command
,
1044 .mode
= COMMAND_EXEC
,
1045 .usage
= "[erase] [unlock] filename [offset [file_type]]",
1046 .help
= "Write an image to flash. Optionally first unprotect "
1047 "and/or erase the region to be used. Allow optional "
1048 "offset from beginning of bank (defaults to zero)",
1051 .name
= "read_bank",
1052 .handler
= handle_flash_read_bank_command
,
1053 .mode
= COMMAND_EXEC
,
1054 .usage
= "bank_id filename [offset [length]]",
1055 .help
= "Read binary data from flash bank to file. Allow optional "
1056 "offset from beginning of the bank (defaults to zero).",
1059 .name
= "verify_bank",
1060 .handler
= handle_flash_verify_bank_command
,
1061 .mode
= COMMAND_EXEC
,
1062 .usage
= "bank_id filename [offset]",
1063 .help
= "Compare the contents of a file with the contents of the "
1064 "flash bank. Allow optional offset from beginning of the bank "
1065 "(defaults to zero).",
1069 .handler
= handle_flash_protect_command
,
1070 .mode
= COMMAND_EXEC
,
1071 .usage
= "bank_id first_block [last_block|'last'] "
1073 .help
= "Turn protection on or off for a range of protection "
1074 "blocks or sectors in a given flash bank. "
1075 "See 'flash info' output for a list of blocks.",
1078 .name
= "padded_value",
1079 .handler
= handle_flash_padded_value_command
,
1080 .mode
= COMMAND_EXEC
,
1081 .usage
= "bank_id value",
1082 .help
= "Set default flash padded value",
1084 COMMAND_REGISTRATION_DONE
1087 static int flash_init_drivers(struct command_context
*cmd_ctx
)
1089 if (!flash_bank_list())
1092 struct command
*parent
= command_find_in_context(cmd_ctx
, "flash");
1093 return register_commands(cmd_ctx
, parent
, flash_exec_command_handlers
);
1096 COMMAND_HANDLER(handle_flash_bank_command
)
1099 LOG_ERROR("usage: flash bank <name> <driver> "
1100 "<base> <size> <chip_width> <bus_width> <target>");
1101 return ERROR_COMMAND_SYNTAX_ERROR
;
1103 /* save bank name and advance arguments for compatibility */
1104 const char *bank_name
= *CMD_ARGV
++;
1107 struct target
*target
= get_target(CMD_ARGV
[5]);
1108 if (target
== NULL
) {
1109 LOG_ERROR("target '%s' not defined", CMD_ARGV
[5]);
1113 const char *driver_name
= CMD_ARGV
[0];
1114 struct flash_driver
*driver
= flash_driver_find_by_name(driver_name
);
1115 if (NULL
== driver
) {
1116 /* no matching flash driver found */
1117 LOG_ERROR("flash driver '%s' not found", driver_name
);
1121 /* check the flash bank name is unique */
1122 if (get_flash_bank_by_name_noprobe(bank_name
) != NULL
) {
1123 /* flash bank name already exists */
1124 LOG_ERROR("flash bank name '%s' already exists", bank_name
);
1128 /* register flash specific commands */
1129 if (NULL
!= driver
->commands
) {
1130 int retval
= register_commands(CMD_CTX
, NULL
,
1132 if (ERROR_OK
!= retval
) {
1133 LOG_ERROR("couldn't register '%s' commands",
1139 struct flash_bank
*c
= calloc(1, sizeof(*c
));
1140 c
->name
= strdup(bank_name
);
1143 COMMAND_PARSE_NUMBER(target_addr
, CMD_ARGV
[1], c
->base
);
1144 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], c
->size
);
1145 COMMAND_PARSE_NUMBER(int, CMD_ARGV
[3], c
->chip_width
);
1146 COMMAND_PARSE_NUMBER(int, CMD_ARGV
[4], c
->bus_width
);
1147 c
->default_padded_value
= c
->erased_value
= 0xff;
1148 c
->minimal_write_gap
= FLASH_WRITE_GAP_SECTOR
;
1151 retval
= CALL_COMMAND_HANDLER(driver
->flash_bank_command
, c
);
1152 if (ERROR_OK
!= retval
) {
1153 LOG_ERROR("'%s' driver rejected flash bank at " TARGET_ADDR_FMT
1154 "; usage: %s", driver_name
, c
->base
, driver
->usage
);
1159 if (driver
->usage
== NULL
)
1160 LOG_DEBUG("'%s' driver usage field missing", driver_name
);
1167 COMMAND_HANDLER(handle_flash_banks_command
)
1170 return ERROR_COMMAND_SYNTAX_ERROR
;
1173 for (struct flash_bank
*p
= flash_bank_list(); p
; p
= p
->next
, n
++) {
1174 LOG_USER("#%d : %s (%s) at " TARGET_ADDR_FMT
", size 0x%8.8" PRIx32
", "
1175 "buswidth %u, chipwidth %u", p
->bank_number
,
1176 p
->name
, p
->driver
->name
, p
->base
, p
->size
,
1177 p
->bus_width
, p
->chip_width
);
1182 static int jim_flash_list(Jim_Interp
*interp
, int argc
, Jim_Obj
* const *argv
)
1185 Jim_WrongNumArgs(interp
, 1, argv
,
1186 "no arguments to 'flash list' command");
1190 Jim_Obj
*list
= Jim_NewListObj(interp
, NULL
, 0);
1192 for (struct flash_bank
*p
= flash_bank_list(); p
; p
= p
->next
) {
1193 Jim_Obj
*elem
= Jim_NewListObj(interp
, NULL
, 0);
1195 Jim_ListAppendElement(interp
, elem
, Jim_NewStringObj(interp
, "name", -1));
1196 Jim_ListAppendElement(interp
, elem
, Jim_NewStringObj(interp
, p
->driver
->name
, -1));
1197 Jim_ListAppendElement(interp
, elem
, Jim_NewStringObj(interp
, "base", -1));
1198 Jim_ListAppendElement(interp
, elem
, Jim_NewIntObj(interp
, p
->base
));
1199 Jim_ListAppendElement(interp
, elem
, Jim_NewStringObj(interp
, "size", -1));
1200 Jim_ListAppendElement(interp
, elem
, Jim_NewIntObj(interp
, p
->size
));
1201 Jim_ListAppendElement(interp
, elem
, Jim_NewStringObj(interp
, "bus_width", -1));
1202 Jim_ListAppendElement(interp
, elem
, Jim_NewIntObj(interp
, p
->bus_width
));
1203 Jim_ListAppendElement(interp
, elem
, Jim_NewStringObj(interp
, "chip_width", -1));
1204 Jim_ListAppendElement(interp
, elem
, Jim_NewIntObj(interp
, p
->chip_width
));
1206 Jim_ListAppendElement(interp
, list
, elem
);
1209 Jim_SetResult(interp
, list
);
1214 COMMAND_HANDLER(handle_flash_init_command
)
1217 return ERROR_COMMAND_SYNTAX_ERROR
;
1219 static bool flash_initialized
;
1220 if (flash_initialized
) {
1221 LOG_INFO("'flash init' has already been called");
1224 flash_initialized
= true;
1226 LOG_DEBUG("Initializing flash devices...");
1227 return flash_init_drivers(CMD_CTX
);
1230 static const struct command_registration flash_config_command_handlers
[] = {
1233 .handler
= handle_flash_bank_command
,
1234 .mode
= COMMAND_CONFIG
,
1235 .usage
= "bank_id driver_name base_address size_bytes "
1236 "chip_width_bytes bus_width_bytes target "
1237 "[driver_options ...]",
1238 .help
= "Define a new bank with the given name, "
1239 "using the specified NOR flash driver.",
1243 .mode
= COMMAND_CONFIG
,
1244 .handler
= handle_flash_init_command
,
1245 .help
= "Initialize flash devices.",
1249 .mode
= COMMAND_ANY
,
1250 .handler
= handle_flash_banks_command
,
1251 .help
= "Display table with information about flash banks.",
1255 .mode
= COMMAND_ANY
,
1256 .jim_handler
= jim_flash_list
,
1257 .help
= "Returns a list of details about the flash banks.",
1259 COMMAND_REGISTRATION_DONE
1261 static const struct command_registration flash_command_handlers
[] = {
1264 .mode
= COMMAND_ANY
,
1265 .help
= "NOR flash command group",
1266 .chain
= flash_config_command_handlers
,
1268 COMMAND_REGISTRATION_DONE
1271 int flash_register_commands(struct command_context
*cmd_ctx
)
1273 return register_commands(cmd_ctx
, NULL
, flash_command_handlers
);