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 static 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_INFO("Flash protection check is not implemented.");
115 "#%u : %s at " TARGET_ADDR_FMT
", size 0x%8.8" PRIx32
116 ", buswidth %u, chipwidth %u",
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
" %" PRIu32
"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
)
202 retval
= p
->driver
->erase_check(p
);
203 if (retval
== ERROR_OK
)
204 command_print(CMD
, "successfully checked erase state");
207 "unknown error when checking erase state of flash bank #%s at "
213 for (unsigned int j
= 0; j
< p
->num_sectors
; j
++) {
216 if (p
->sectors
[j
].is_erased
== 0)
217 erase_state
= "not erased";
218 else if (p
->sectors
[j
].is_erased
== 1)
221 erase_state
= "erase state unknown";
225 "\t#%3i: 0x%8.8" PRIx32
" (0x%" PRIx32
" %" PRIu32
"kB) %s",
227 p
->sectors
[j
].offset
,
229 p
->sectors
[j
].size
>> 10,
234 command_print(CMD
, "\tBank is erased");
238 COMMAND_HANDLER(handle_flash_erase_address_command
)
240 struct flash_bank
*p
;
241 int retval
= ERROR_OK
;
242 target_addr_t address
;
245 bool do_unlock
= false;
246 struct target
*target
= get_current_target(CMD_CTX
);
248 while (CMD_ARGC
>= 3) {
249 /* Optionally pad out the address range to block/sector
250 * boundaries. We can't know if there's data in that part
251 * of the flash; only do padding if we're told to.
253 if (strcmp("pad", CMD_ARGV
[0]) == 0)
255 else if (strcmp("unlock", CMD_ARGV
[0]) == 0)
258 return ERROR_COMMAND_SYNTAX_ERROR
;
263 return ERROR_COMMAND_SYNTAX_ERROR
;
265 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], address
);
266 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], length
);
269 command_print(CMD
, "Length must be >0");
270 return ERROR_COMMAND_SYNTAX_ERROR
;
273 retval
= get_flash_bank_by_addr(target
, address
, true, &p
);
274 if (retval
!= ERROR_OK
)
277 /* We can't know if we did a resume + halt, in which case we no longer know the erased state
281 struct duration bench
;
282 duration_start(&bench
);
285 retval
= flash_unlock_address_range(target
, address
, length
);
287 if (retval
== ERROR_OK
)
288 retval
= flash_erase_address_range(target
, do_pad
, address
, length
);
290 if ((ERROR_OK
== retval
) && (duration_measure(&bench
) == ERROR_OK
)) {
291 command_print(CMD
, "erased address " TARGET_ADDR_FMT
" (length %" PRIu32
")"
292 " in %fs (%0.3f KiB/s)", address
, length
,
293 duration_elapsed(&bench
), duration_kbps(&bench
, length
));
299 COMMAND_HANDLER(handle_flash_erase_command
)
302 return ERROR_COMMAND_SYNTAX_ERROR
;
307 struct flash_bank
*p
;
310 retval
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &p
);
311 if (retval
!= ERROR_OK
)
314 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], first
);
315 if (strcmp(CMD_ARGV
[2], "last") == 0)
316 last
= p
->num_sectors
- 1;
318 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], last
);
320 if (!(first
<= last
)) {
321 command_print(CMD
, "ERROR: "
322 "first sector must be <= last");
326 if (!(last
<= (p
->num_sectors
- 1))) {
327 command_print(CMD
, "ERROR: "
328 "last sector must be <= %u",
333 struct duration bench
;
334 duration_start(&bench
);
336 retval
= flash_driver_erase(p
, first
, last
);
338 if ((ERROR_OK
== retval
) && (duration_measure(&bench
) == ERROR_OK
)) {
339 command_print(CMD
, "erased sectors %" PRIu32
" "
340 "through %" PRIu32
" on flash bank %u "
341 "in %fs", first
, last
, p
->bank_number
, duration_elapsed(&bench
));
347 COMMAND_HANDLER(handle_flash_protect_command
)
350 return ERROR_COMMAND_SYNTAX_ERROR
;
355 struct flash_bank
*p
;
359 retval
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &p
);
360 if (retval
!= ERROR_OK
)
363 if (p
->num_prot_blocks
)
364 num_blocks
= p
->num_prot_blocks
;
366 num_blocks
= p
->num_sectors
;
368 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], first
);
369 if (strcmp(CMD_ARGV
[2], "last") == 0)
370 last
= num_blocks
- 1;
372 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], last
);
375 COMMAND_PARSE_ON_OFF(CMD_ARGV
[3], set
);
377 if (!(first
<= last
)) {
378 command_print(CMD
, "ERROR: "
379 "first %s must be <= last",
380 (p
->num_prot_blocks
) ? "block" : "sector");
384 if (!(last
<= (uint32_t)(num_blocks
- 1))) {
385 command_print(CMD
, "ERROR: "
386 "last %s must be <= %d",
387 (p
->num_prot_blocks
) ? "block" : "sector",
392 retval
= flash_driver_protect(p
, set
, first
, last
);
393 if (retval
== ERROR_OK
) {
394 command_print(CMD
, "%s protection for %s %" PRIu32
395 " through %" PRIu32
" on flash bank %d",
396 (set
) ? "set" : "cleared",
397 (p
->num_prot_blocks
) ? "blocks" : "sectors",
398 first
, last
, p
->bank_number
);
404 COMMAND_HANDLER(handle_flash_write_image_command
)
406 struct target
*target
= get_current_target(CMD_CTX
);
413 /* flash auto-erase is disabled by default*/
415 bool auto_unlock
= false;
418 if (strcmp(CMD_ARGV
[0], "erase") == 0) {
422 command_print(CMD
, "auto erase enabled");
423 } else if (strcmp(CMD_ARGV
[0], "unlock") == 0) {
427 command_print(CMD
, "auto unlock enabled");
433 return ERROR_COMMAND_SYNTAX_ERROR
;
436 LOG_ERROR("no target selected");
440 struct duration bench
;
441 duration_start(&bench
);
444 image
.base_address_set
= true;
445 COMMAND_PARSE_NUMBER(llong
, CMD_ARGV
[1], image
.base_address
);
447 image
.base_address_set
= false;
448 image
.base_address
= 0x0;
451 image
.start_address_set
= false;
453 retval
= image_open(&image
, CMD_ARGV
[0], (CMD_ARGC
== 3) ? CMD_ARGV
[2] : NULL
);
454 if (retval
!= ERROR_OK
)
457 retval
= flash_write_unlock_verify(target
, &image
, &written
, auto_erase
,
458 auto_unlock
, true, false);
459 if (retval
!= ERROR_OK
) {
464 if ((ERROR_OK
== retval
) && (duration_measure(&bench
) == ERROR_OK
)) {
465 command_print(CMD
, "wrote %" PRIu32
" bytes from file %s "
466 "in %fs (%0.3f KiB/s)", written
, CMD_ARGV
[0],
467 duration_elapsed(&bench
), duration_kbps(&bench
, written
));
475 COMMAND_HANDLER(handle_flash_verify_image_command
)
477 struct target
*target
= get_current_target(CMD_CTX
);
485 return ERROR_COMMAND_SYNTAX_ERROR
;
488 LOG_ERROR("no target selected");
492 struct duration bench
;
493 duration_start(&bench
);
496 image
.base_address_set
= 1;
497 COMMAND_PARSE_NUMBER(llong
, CMD_ARGV
[1], image
.base_address
);
499 image
.base_address_set
= 0;
500 image
.base_address
= 0x0;
503 image
.start_address_set
= 0;
505 retval
= image_open(&image
, CMD_ARGV
[0], (CMD_ARGC
== 3) ? CMD_ARGV
[2] : NULL
);
506 if (retval
!= ERROR_OK
)
509 retval
= flash_write_unlock_verify(target
, &image
, &verified
, false,
511 if (retval
!= ERROR_OK
) {
516 if ((ERROR_OK
== retval
) && (duration_measure(&bench
) == ERROR_OK
)) {
517 command_print(CMD
, "verified %" PRIu32
" bytes from file %s "
518 "in %fs (%0.3f KiB/s)", verified
, CMD_ARGV
[0],
519 duration_elapsed(&bench
), duration_kbps(&bench
, verified
));
527 COMMAND_HANDLER(handle_flash_fill_command
)
529 target_addr_t address
;
532 struct target
*target
= get_current_target(CMD_CTX
);
538 return ERROR_COMMAND_SYNTAX_ERROR
;
540 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], address
);
541 COMMAND_PARSE_NUMBER(u64
, CMD_ARGV
[1], pattern
);
542 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], count
);
544 struct flash_bank
*bank
;
545 retval
= get_flash_bank_by_addr(target
, address
, true, &bank
);
546 if (retval
!= ERROR_OK
)
549 switch (CMD_NAME
[4]) {
563 return ERROR_COMMAND_SYNTAX_ERROR
;
566 if ((wordsize
< sizeof(pattern
)) && (pattern
>> (8 * wordsize
) != 0)) {
567 command_print(CMD
, "Fill pattern 0x%" PRIx64
" does not fit within %" PRIu32
"-byte word", pattern
, wordsize
);
574 if (address
+ count
* wordsize
> bank
->base
+ bank
->size
) {
575 LOG_ERROR("Cannot cross flash bank borders");
579 uint32_t size_bytes
= count
* wordsize
;
580 target_addr_t aligned_start
= flash_write_align_start(bank
, address
);
581 target_addr_t end_addr
= address
+ size_bytes
- 1;
582 target_addr_t aligned_end
= flash_write_align_end(bank
, end_addr
);
583 uint32_t aligned_size
= aligned_end
+ 1 - aligned_start
;
584 uint32_t padding_at_start
= address
- aligned_start
;
585 uint32_t padding_at_end
= aligned_end
- end_addr
;
587 uint8_t *buffer
= malloc(aligned_size
);
591 if (padding_at_start
) {
592 memset(buffer
, bank
->default_padded_value
, padding_at_start
);
593 LOG_WARNING("Start address " TARGET_ADDR_FMT
594 " breaks the required alignment of flash bank %s",
595 address
, bank
->name
);
596 LOG_WARNING("Padding %" PRIu32
" bytes from " TARGET_ADDR_FMT
,
597 padding_at_start
, aligned_start
);
600 uint8_t *ptr
= buffer
+ padding_at_start
;
604 for (i
= 0; i
< count
; i
++, ptr
+= wordsize
)
605 target_buffer_set_u64(target
, ptr
, pattern
);
608 for (i
= 0; i
< count
; i
++, ptr
+= wordsize
)
609 target_buffer_set_u32(target
, ptr
, pattern
);
612 for (i
= 0; i
< count
; i
++, ptr
+= wordsize
)
613 target_buffer_set_u16(target
, ptr
, pattern
);
616 memset(ptr
, pattern
, count
);
620 LOG_ERROR("BUG: can't happen");
624 if (padding_at_end
) {
625 memset(ptr
, bank
->default_padded_value
, padding_at_end
);
626 LOG_INFO("Padding at " TARGET_ADDR_FMT
" with %" PRIu32
627 " bytes (bank write end alignment)",
628 end_addr
+ 1, padding_at_end
);
631 struct duration bench
;
632 duration_start(&bench
);
634 retval
= flash_driver_write(bank
, buffer
, aligned_start
- bank
->base
, aligned_size
);
635 if (retval
!= ERROR_OK
)
638 retval
= flash_driver_read(bank
, buffer
, address
- bank
->base
, size_bytes
);
639 if (retval
!= ERROR_OK
)
642 for (i
= 0, ptr
= buffer
; i
< count
; i
++) {
643 uint64_t readback
= 0;
647 readback
= target_buffer_get_u64(target
, ptr
);
650 readback
= target_buffer_get_u32(target
, ptr
);
653 readback
= target_buffer_get_u16(target
, ptr
);
659 if (readback
!= pattern
) {
661 "Verification error address " TARGET_ADDR_FMT
662 ", read back 0x%02" PRIx64
", expected 0x%02" PRIx64
,
663 address
+ i
* wordsize
, readback
, pattern
);
670 if ((retval
== ERROR_OK
) && (duration_measure(&bench
) == ERROR_OK
)) {
671 command_print(CMD
, "wrote %" PRIu32
" bytes to " TARGET_ADDR_FMT
672 " in %fs (%0.3f KiB/s)", size_bytes
, address
,
673 duration_elapsed(&bench
), duration_kbps(&bench
, size_bytes
));
682 COMMAND_HANDLER(handle_flash_md_command
)
686 if (CMD_ARGC
< 1 || CMD_ARGC
> 2)
687 return ERROR_COMMAND_SYNTAX_ERROR
;
689 target_addr_t address
;
690 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], address
);
694 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], count
);
696 unsigned int wordsize
;
697 switch (CMD_NAME
[2]) {
708 return ERROR_COMMAND_SYNTAX_ERROR
;
714 struct target
*target
= get_current_target(CMD_CTX
);
715 struct flash_bank
*bank
;
716 retval
= get_flash_bank_by_addr(target
, address
, true, &bank
);
717 if (retval
!= ERROR_OK
)
720 uint32_t offset
= address
- bank
->base
;
721 uint32_t sizebytes
= count
* wordsize
;
722 if (offset
+ sizebytes
> bank
->size
) {
723 command_print(CMD
, "Cannot cross flash bank borders");
727 uint8_t *buffer
= calloc(count
, wordsize
);
728 if (buffer
== NULL
) {
729 command_print(CMD
, "No memory for flash read buffer");
733 retval
= flash_driver_read(bank
, buffer
, offset
, sizebytes
);
734 if (retval
== ERROR_OK
)
735 target_handle_md_output(CMD
, target
, address
, wordsize
, count
, buffer
);
743 COMMAND_HANDLER(handle_flash_write_bank_command
)
748 struct fileio
*fileio
;
750 if (CMD_ARGC
< 2 || CMD_ARGC
> 3)
751 return ERROR_COMMAND_SYNTAX_ERROR
;
753 struct duration bench
;
754 duration_start(&bench
);
756 struct flash_bank
*bank
;
757 int retval
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &bank
);
758 if (ERROR_OK
!= retval
)
764 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], offset
);
766 if (offset
> bank
->size
) {
767 LOG_ERROR("Offset 0x%8.8" PRIx32
" is out of range of the flash bank",
769 return ERROR_COMMAND_ARGUMENT_INVALID
;
772 if (fileio_open(&fileio
, CMD_ARGV
[1], FILEIO_READ
, FILEIO_BINARY
) != ERROR_OK
)
776 retval
= fileio_size(fileio
, &filesize
);
777 if (retval
!= ERROR_OK
) {
778 fileio_close(fileio
);
782 length
= MIN(filesize
, bank
->size
- offset
);
785 LOG_INFO("Nothing to write to flash bank");
786 fileio_close(fileio
);
790 if (length
!= filesize
)
791 LOG_INFO("File content exceeds flash bank size. Only writing the "
792 "first %zu bytes of the file", length
);
794 target_addr_t start_addr
= bank
->base
+ offset
;
795 target_addr_t aligned_start
= flash_write_align_start(bank
, start_addr
);
796 target_addr_t end_addr
= start_addr
+ length
- 1;
797 target_addr_t aligned_end
= flash_write_align_end(bank
, end_addr
);
798 uint32_t aligned_size
= aligned_end
+ 1 - aligned_start
;
799 uint32_t padding_at_start
= start_addr
- aligned_start
;
800 uint32_t padding_at_end
= aligned_end
- end_addr
;
802 buffer
= malloc(aligned_size
);
803 if (buffer
== NULL
) {
804 fileio_close(fileio
);
805 LOG_ERROR("Out of memory");
809 if (padding_at_start
) {
810 memset(buffer
, bank
->default_padded_value
, padding_at_start
);
811 LOG_WARNING("Start offset 0x%08" PRIx32
812 " breaks the required alignment of flash bank %s",
814 LOG_WARNING("Padding %" PRIu32
" bytes from " TARGET_ADDR_FMT
,
815 padding_at_start
, aligned_start
);
818 uint8_t *ptr
= buffer
+ padding_at_start
;
820 if (fileio_read(fileio
, length
, ptr
, &buf_cnt
) != ERROR_OK
) {
822 fileio_close(fileio
);
826 if (buf_cnt
!= length
) {
827 LOG_ERROR("Short read");
834 if (padding_at_end
) {
835 memset(ptr
, bank
->default_padded_value
, padding_at_end
);
836 LOG_INFO("Padding at " TARGET_ADDR_FMT
" with %" PRIu32
837 " bytes (bank write end alignment)",
838 end_addr
+ 1, padding_at_end
);
841 retval
= flash_driver_write(bank
, buffer
, aligned_start
- bank
->base
, aligned_size
);
845 if ((ERROR_OK
== retval
) && (duration_measure(&bench
) == ERROR_OK
)) {
846 command_print(CMD
, "wrote %zu bytes from file %s to flash bank %u"
847 " at offset 0x%8.8" PRIx32
" in %fs (%0.3f KiB/s)",
848 length
, CMD_ARGV
[1], bank
->bank_number
, offset
,
849 duration_elapsed(&bench
), duration_kbps(&bench
, length
));
852 fileio_close(fileio
);
857 COMMAND_HANDLER(handle_flash_read_bank_command
)
861 struct fileio
*fileio
;
865 if (CMD_ARGC
< 2 || CMD_ARGC
> 4)
866 return ERROR_COMMAND_SYNTAX_ERROR
;
868 struct duration bench
;
869 duration_start(&bench
);
871 struct flash_bank
*p
;
872 int retval
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &p
);
874 if (ERROR_OK
!= retval
)
880 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], offset
);
882 if (offset
> p
->size
) {
883 LOG_ERROR("Offset 0x%8.8" PRIx32
" is out of range of the flash bank",
885 return ERROR_COMMAND_ARGUMENT_INVALID
;
888 length
= p
->size
- offset
;
891 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[3], length
);
893 if (offset
+ length
> p
->size
) {
894 LOG_ERROR("Length of %" PRIu32
" bytes with offset 0x%8.8" PRIx32
895 " is out of range of the flash bank", length
, offset
);
896 return ERROR_COMMAND_ARGUMENT_INVALID
;
899 buffer
= malloc(length
);
900 if (buffer
== NULL
) {
901 LOG_ERROR("Out of memory");
905 retval
= flash_driver_read(p
, buffer
, offset
, length
);
906 if (retval
!= ERROR_OK
) {
907 LOG_ERROR("Read error");
912 retval
= fileio_open(&fileio
, CMD_ARGV
[1], FILEIO_WRITE
, FILEIO_BINARY
);
913 if (retval
!= ERROR_OK
) {
914 LOG_ERROR("Could not open file");
919 retval
= fileio_write(fileio
, length
, buffer
, &written
);
920 fileio_close(fileio
);
922 if (retval
!= ERROR_OK
) {
923 LOG_ERROR("Could not write file");
927 if (duration_measure(&bench
) == ERROR_OK
)
928 command_print(CMD
, "wrote %zd bytes to file %s from flash bank %u"
929 " at offset 0x%8.8" PRIx32
" in %fs (%0.3f KiB/s)",
930 written
, CMD_ARGV
[1], p
->bank_number
, offset
,
931 duration_elapsed(&bench
), duration_kbps(&bench
, written
));
937 COMMAND_HANDLER(handle_flash_verify_bank_command
)
940 uint8_t *buffer_file
, *buffer_flash
;
941 struct fileio
*fileio
;
947 if (CMD_ARGC
< 2 || CMD_ARGC
> 3)
948 return ERROR_COMMAND_SYNTAX_ERROR
;
950 struct duration bench
;
951 duration_start(&bench
);
953 struct flash_bank
*p
;
954 int retval
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &p
);
955 if (ERROR_OK
!= retval
)
961 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], offset
);
963 if (offset
> p
->size
) {
964 LOG_ERROR("Offset 0x%8.8" PRIx32
" is out of range of the flash bank",
966 return ERROR_COMMAND_ARGUMENT_INVALID
;
969 retval
= fileio_open(&fileio
, CMD_ARGV
[1], FILEIO_READ
, FILEIO_BINARY
);
970 if (retval
!= ERROR_OK
) {
971 LOG_ERROR("Could not open file");
975 retval
= fileio_size(fileio
, &filesize
);
976 if (retval
!= ERROR_OK
) {
977 fileio_close(fileio
);
981 length
= MIN(filesize
, p
->size
- offset
);
984 LOG_INFO("Nothing to compare with flash bank");
985 fileio_close(fileio
);
989 if (length
!= filesize
)
990 LOG_INFO("File content exceeds flash bank size. Only comparing the "
991 "first %zu bytes of the file", length
);
993 buffer_file
= malloc(length
);
994 if (buffer_file
== NULL
) {
995 LOG_ERROR("Out of memory");
996 fileio_close(fileio
);
1000 retval
= fileio_read(fileio
, length
, buffer_file
, &read_cnt
);
1001 fileio_close(fileio
);
1002 if (retval
!= ERROR_OK
) {
1003 LOG_ERROR("File read failure");
1008 if (read_cnt
!= length
) {
1009 LOG_ERROR("Short read");
1014 buffer_flash
= malloc(length
);
1015 if (buffer_flash
== NULL
) {
1016 LOG_ERROR("Out of memory");
1021 retval
= flash_driver_read(p
, buffer_flash
, offset
, length
);
1022 if (retval
!= ERROR_OK
) {
1023 LOG_ERROR("Flash read error");
1029 if (duration_measure(&bench
) == ERROR_OK
)
1030 command_print(CMD
, "read %zd bytes from file %s and flash bank %u"
1031 " at offset 0x%8.8" PRIx32
" in %fs (%0.3f KiB/s)",
1032 length
, CMD_ARGV
[1], p
->bank_number
, offset
,
1033 duration_elapsed(&bench
), duration_kbps(&bench
, length
));
1035 differ
= memcmp(buffer_file
, buffer_flash
, length
);
1036 command_print(CMD
, "contents %s", differ
? "differ" : "match");
1040 for (t
= 0; t
< length
; t
++) {
1041 if (buffer_flash
[t
] == buffer_file
[t
])
1043 command_print(CMD
, "diff %d address 0x%08" PRIx32
". Was 0x%02x instead of 0x%02x",
1044 diffs
, t
+ offset
, buffer_flash
[t
], buffer_file
[t
]);
1045 if (diffs
++ >= 127) {
1046 command_print(CMD
, "More than 128 errors, the rest are not printed.");
1055 return differ
? ERROR_FAIL
: ERROR_OK
;
1058 void flash_set_dirty(void)
1060 struct flash_bank
*c
;
1062 /* set all flash to require erasing */
1063 for (c
= flash_bank_list(); c
; c
= c
->next
) {
1064 for (unsigned int i
= 0; i
< c
->num_sectors
; i
++)
1065 c
->sectors
[i
].is_erased
= 0;
1069 COMMAND_HANDLER(handle_flash_padded_value_command
)
1072 return ERROR_COMMAND_SYNTAX_ERROR
;
1074 struct flash_bank
*p
;
1075 int retval
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &p
);
1076 if (ERROR_OK
!= retval
)
1079 COMMAND_PARSE_NUMBER(u8
, CMD_ARGV
[1], p
->default_padded_value
);
1081 command_print(CMD
, "Default padded value set to 0x%" PRIx8
" for flash bank %u",
1082 p
->default_padded_value
, p
->bank_number
);
1087 static const struct command_registration flash_exec_command_handlers
[] = {
1090 .handler
= handle_flash_probe_command
,
1091 .mode
= COMMAND_EXEC
,
1093 .help
= "Identify a flash bank.",
1097 .handler
= handle_flash_info_command
,
1098 .mode
= COMMAND_EXEC
,
1099 .usage
= "bank_id ['sectors']",
1100 .help
= "Print information about a flash bank.",
1103 .name
= "erase_check",
1104 .handler
= handle_flash_erase_check_command
,
1105 .mode
= COMMAND_EXEC
,
1107 .help
= "Check erase state of all blocks in a "
1111 .name
= "erase_sector",
1112 .handler
= handle_flash_erase_command
,
1113 .mode
= COMMAND_EXEC
,
1114 .usage
= "bank_id first_sector_num (last_sector_num|'last')",
1115 .help
= "Erase a range of sectors in a flash bank.",
1118 .name
= "erase_address",
1119 .handler
= handle_flash_erase_address_command
,
1120 .mode
= COMMAND_EXEC
,
1121 .usage
= "['pad'] ['unlock'] address length",
1122 .help
= "Erase flash sectors starting at address and "
1123 "continuing for length bytes. If 'pad' is specified, "
1124 "data outside that range may also be erased: the start "
1125 "address may be decreased, and length increased, so "
1126 "that all of the first and last sectors are erased. "
1127 "If 'unlock' is specified, then the flash is unprotected "
1133 .handler
= handle_flash_fill_command
,
1134 .mode
= COMMAND_EXEC
,
1135 .usage
= "address value n",
1136 .help
= "Fill n double-words with 64-bit value, starting at "
1137 "word address. (No autoerase.)",
1141 .handler
= handle_flash_fill_command
,
1142 .mode
= COMMAND_EXEC
,
1143 .usage
= "address value n",
1144 .help
= "Fill n words with 32-bit value, starting at "
1145 "word address. (No autoerase.)",
1149 .handler
= handle_flash_fill_command
,
1150 .mode
= COMMAND_EXEC
,
1151 .usage
= "address value n",
1152 .help
= "Fill n halfwords with 16-bit value, starting at "
1153 "word address. (No autoerase.)",
1157 .handler
= handle_flash_fill_command
,
1158 .mode
= COMMAND_EXEC
,
1159 .usage
= "address value n",
1160 .help
= "Fill n bytes with 8-bit value, starting at "
1161 "word address. (No autoerase.)",
1165 .handler
= handle_flash_md_command
,
1166 .mode
= COMMAND_EXEC
,
1167 .usage
= "address [count]",
1168 .help
= "Display bytes from flash.",
1172 .handler
= handle_flash_md_command
,
1173 .mode
= COMMAND_EXEC
,
1174 .usage
= "address [count]",
1175 .help
= "Display half-words from flash.",
1179 .handler
= handle_flash_md_command
,
1180 .mode
= COMMAND_EXEC
,
1181 .usage
= "address [count]",
1182 .help
= "Display words from flash.",
1185 .name
= "write_bank",
1186 .handler
= handle_flash_write_bank_command
,
1187 .mode
= COMMAND_EXEC
,
1188 .usage
= "bank_id filename [offset]",
1189 .help
= "Write binary data from file to flash bank. Allow optional "
1190 "offset from beginning of the bank (defaults to zero).",
1193 .name
= "write_image",
1194 .handler
= handle_flash_write_image_command
,
1195 .mode
= COMMAND_EXEC
,
1196 .usage
= "[erase] [unlock] filename [offset [file_type]]",
1197 .help
= "Write an image to flash. Optionally first unprotect "
1198 "and/or erase the region to be used. Allow optional "
1199 "offset from beginning of bank (defaults to zero)",
1202 .name
= "verify_image",
1203 .handler
= handle_flash_verify_image_command
,
1204 .mode
= COMMAND_EXEC
,
1205 .usage
= "filename [offset [file_type]]",
1206 .help
= "Verify an image against flash. Allow optional "
1207 "offset from beginning of bank (defaults to zero)",
1210 .name
= "read_bank",
1211 .handler
= handle_flash_read_bank_command
,
1212 .mode
= COMMAND_EXEC
,
1213 .usage
= "bank_id filename [offset [length]]",
1214 .help
= "Read binary data from flash bank to file. Allow optional "
1215 "offset from beginning of the bank (defaults to zero).",
1218 .name
= "verify_bank",
1219 .handler
= handle_flash_verify_bank_command
,
1220 .mode
= COMMAND_EXEC
,
1221 .usage
= "bank_id filename [offset]",
1222 .help
= "Compare the contents of a file with the contents of the "
1223 "flash bank. Allow optional offset from beginning of the bank "
1224 "(defaults to zero).",
1228 .handler
= handle_flash_protect_command
,
1229 .mode
= COMMAND_EXEC
,
1230 .usage
= "bank_id first_block [last_block|'last'] "
1232 .help
= "Turn protection on or off for a range of protection "
1233 "blocks or sectors in a given flash bank. "
1234 "See 'flash info' output for a list of blocks.",
1237 .name
= "padded_value",
1238 .handler
= handle_flash_padded_value_command
,
1239 .mode
= COMMAND_EXEC
,
1240 .usage
= "bank_id value",
1241 .help
= "Set default flash padded value",
1243 COMMAND_REGISTRATION_DONE
1246 static int flash_init_drivers(struct command_context
*cmd_ctx
)
1248 if (!flash_bank_list())
1251 return register_commands(cmd_ctx
, "flash", flash_exec_command_handlers
);
1254 COMMAND_HANDLER(handle_flash_bank_command
)
1257 LOG_ERROR("usage: flash bank <name> <driver> "
1258 "<base> <size> <chip_width> <bus_width> <target>");
1259 return ERROR_COMMAND_SYNTAX_ERROR
;
1261 /* save bank name and advance arguments for compatibility */
1262 const char *bank_name
= *CMD_ARGV
++;
1265 struct target
*target
= get_target(CMD_ARGV
[5]);
1266 if (target
== NULL
) {
1267 LOG_ERROR("target '%s' not defined", CMD_ARGV
[5]);
1271 const char *driver_name
= CMD_ARGV
[0];
1272 const struct flash_driver
*driver
= flash_driver_find_by_name(driver_name
);
1273 if (NULL
== driver
) {
1274 /* no matching flash driver found */
1275 LOG_ERROR("flash driver '%s' not found", driver_name
);
1279 /* check the flash bank name is unique */
1280 if (get_flash_bank_by_name_noprobe(bank_name
) != NULL
) {
1281 /* flash bank name already exists */
1282 LOG_ERROR("flash bank name '%s' already exists", bank_name
);
1286 /* register flash specific commands */
1287 if (NULL
!= driver
->commands
) {
1288 int retval
= register_commands(CMD_CTX
, NULL
,
1290 if (ERROR_OK
!= retval
) {
1291 LOG_ERROR("couldn't register '%s' commands",
1297 struct flash_bank
*c
= calloc(1, sizeof(*c
));
1298 c
->name
= strdup(bank_name
);
1301 COMMAND_PARSE_NUMBER(target_addr
, CMD_ARGV
[1], c
->base
);
1302 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], c
->size
);
1303 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[3], c
->chip_width
);
1304 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[4], c
->bus_width
);
1305 c
->default_padded_value
= c
->erased_value
= 0xff;
1306 c
->minimal_write_gap
= FLASH_WRITE_GAP_SECTOR
;
1309 retval
= CALL_COMMAND_HANDLER(driver
->flash_bank_command
, c
);
1310 if (ERROR_OK
!= retval
) {
1311 LOG_ERROR("'%s' driver rejected flash bank at " TARGET_ADDR_FMT
1312 "; usage: %s", driver_name
, c
->base
, driver
->usage
);
1317 if (driver
->usage
== NULL
)
1318 LOG_DEBUG("'%s' driver usage field missing", driver_name
);
1325 COMMAND_HANDLER(handle_flash_banks_command
)
1328 return ERROR_COMMAND_SYNTAX_ERROR
;
1331 for (struct flash_bank
*p
= flash_bank_list(); p
; p
= p
->next
, n
++) {
1332 command_print(CMD
, "#%d : %s (%s) at " TARGET_ADDR_FMT
", size 0x%8.8" PRIx32
", "
1333 "buswidth %u, chipwidth %u", p
->bank_number
,
1334 p
->name
, p
->driver
->name
, p
->base
, p
->size
,
1335 p
->bus_width
, p
->chip_width
);
1340 static int jim_flash_list(Jim_Interp
*interp
, int argc
, Jim_Obj
* const *argv
)
1343 Jim_WrongNumArgs(interp
, 1, argv
,
1344 "no arguments to 'flash list' command");
1348 Jim_Obj
*list
= Jim_NewListObj(interp
, NULL
, 0);
1350 for (struct flash_bank
*p
= flash_bank_list(); p
; p
= p
->next
) {
1351 Jim_Obj
*elem
= Jim_NewListObj(interp
, NULL
, 0);
1353 Jim_ListAppendElement(interp
, elem
, Jim_NewStringObj(interp
, "name", -1));
1354 Jim_ListAppendElement(interp
, elem
, Jim_NewStringObj(interp
, p
->driver
->name
, -1));
1355 Jim_ListAppendElement(interp
, elem
, Jim_NewStringObj(interp
, "base", -1));
1356 Jim_ListAppendElement(interp
, elem
, Jim_NewIntObj(interp
, p
->base
));
1357 Jim_ListAppendElement(interp
, elem
, Jim_NewStringObj(interp
, "size", -1));
1358 Jim_ListAppendElement(interp
, elem
, Jim_NewIntObj(interp
, p
->size
));
1359 Jim_ListAppendElement(interp
, elem
, Jim_NewStringObj(interp
, "bus_width", -1));
1360 Jim_ListAppendElement(interp
, elem
, Jim_NewIntObj(interp
, p
->bus_width
));
1361 Jim_ListAppendElement(interp
, elem
, Jim_NewStringObj(interp
, "chip_width", -1));
1362 Jim_ListAppendElement(interp
, elem
, Jim_NewIntObj(interp
, p
->chip_width
));
1364 Jim_ListAppendElement(interp
, list
, elem
);
1367 Jim_SetResult(interp
, list
);
1372 COMMAND_HANDLER(handle_flash_init_command
)
1375 return ERROR_COMMAND_SYNTAX_ERROR
;
1377 static bool flash_initialized
;
1378 if (flash_initialized
) {
1379 LOG_INFO("'flash init' has already been called");
1382 flash_initialized
= true;
1384 LOG_DEBUG("Initializing flash devices...");
1385 return flash_init_drivers(CMD_CTX
);
1388 static const struct command_registration flash_config_command_handlers
[] = {
1391 .handler
= handle_flash_bank_command
,
1392 .mode
= COMMAND_CONFIG
,
1393 .usage
= "bank_id driver_name base_address size_bytes "
1394 "chip_width_bytes bus_width_bytes target "
1395 "[driver_options ...]",
1396 .help
= "Define a new bank with the given name, "
1397 "using the specified NOR flash driver.",
1401 .mode
= COMMAND_CONFIG
,
1402 .handler
= handle_flash_init_command
,
1403 .help
= "Initialize flash devices.",
1408 .mode
= COMMAND_ANY
,
1409 .handler
= handle_flash_banks_command
,
1410 .help
= "Display table with information about flash banks.",
1415 .mode
= COMMAND_ANY
,
1416 .jim_handler
= jim_flash_list
,
1417 .help
= "Returns a list of details about the flash banks.",
1419 COMMAND_REGISTRATION_DONE
1421 static const struct command_registration flash_command_handlers
[] = {
1424 .mode
= COMMAND_ANY
,
1425 .help
= "NOR flash command group",
1426 .chain
= flash_config_command_handlers
,
1429 COMMAND_REGISTRATION_DONE
1432 int flash_register_commands(struct command_context
*cmd_ctx
)
1434 return register_commands(cmd_ctx
, NULL
, flash_command_handlers
);