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
)
93 struct flash_sector
*block_array
;
95 /* attempt auto probe */
96 retval
= p
->driver
->auto_probe(p
);
97 if (retval
!= ERROR_OK
)
100 /* If the driver does not implement protection, we show the default
101 * state of is_protected array - usually protection state unknown */
102 if (!p
->driver
->protect_check
) {
103 retval
= ERROR_FLASH_OPER_UNSUPPORTED
;
105 /* We must query the hardware to avoid printing stale information! */
106 retval
= p
->driver
->protect_check(p
);
107 if (retval
!= ERROR_OK
&& retval
!= ERROR_FLASH_OPER_UNSUPPORTED
)
110 if (retval
== ERROR_FLASH_OPER_UNSUPPORTED
)
111 LOG_INFO("Flash protection check is not implemented.");
114 "#%u : %s at " TARGET_ADDR_FMT
", size 0x%8.8" PRIx32
115 ", buswidth %u, chipwidth %u",
123 prot_block_available
= p
->num_prot_blocks
&& p
->prot_blocks
;
124 if (!show_sectors
&& prot_block_available
) {
125 block_array
= p
->prot_blocks
;
126 num_blocks
= p
->num_prot_blocks
;
128 block_array
= p
->sectors
;
129 num_blocks
= p
->num_sectors
;
132 for (j
= 0; j
< num_blocks
; j
++) {
133 char *protect_state
= "";
135 if (block_array
[j
].is_protected
== 0)
136 protect_state
= "not protected";
137 else if (block_array
[j
].is_protected
== 1)
138 protect_state
= "protected";
139 else if (!show_sectors
|| !prot_block_available
)
140 protect_state
= "protection state unknown";
143 "\t#%3i: 0x%8.8" PRIx32
" (0x%" PRIx32
" %" PRIu32
"kB) %s",
145 block_array
[j
].offset
,
147 block_array
[j
].size
>> 10,
151 if (p
->driver
->info
) {
152 /* Let the flash driver print extra custom info */
153 retval
= p
->driver
->info(p
, CMD
);
154 command_print_sameline(CMD
, "\n");
155 if (retval
!= ERROR_OK
)
156 LOG_ERROR("error retrieving flash info");
163 COMMAND_HANDLER(handle_flash_probe_command
)
165 struct flash_bank
*p
;
169 return ERROR_COMMAND_SYNTAX_ERROR
;
171 retval
= CALL_COMMAND_HANDLER(flash_command_get_bank_maybe_probe
, 0, &p
, false);
172 if (retval
!= ERROR_OK
)
176 retval
= p
->driver
->probe(p
);
177 if (retval
== ERROR_OK
)
179 "flash '%s' found at " TARGET_ADDR_FMT
,
183 command_print(CMD
, "flash bank '#%s' is out of bounds", CMD_ARGV
[0]);
190 COMMAND_HANDLER(handle_flash_erase_check_command
)
194 return ERROR_COMMAND_SYNTAX_ERROR
;
196 struct flash_bank
*p
;
197 int retval
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &p
);
198 if (retval
!= ERROR_OK
)
201 retval
= p
->driver
->erase_check(p
);
202 if (retval
== ERROR_OK
)
203 command_print(CMD
, "successfully checked erase state");
206 "unknown error when checking erase state of flash bank #%s at "
212 for (unsigned int j
= 0; j
< p
->num_sectors
; j
++) {
215 if (p
->sectors
[j
].is_erased
== 0)
216 erase_state
= "not erased";
217 else if (p
->sectors
[j
].is_erased
== 1)
220 erase_state
= "erase state unknown";
224 "\t#%3i: 0x%8.8" PRIx32
" (0x%" PRIx32
" %" PRIu32
"kB) %s",
226 p
->sectors
[j
].offset
,
228 p
->sectors
[j
].size
>> 10,
233 command_print(CMD
, "\tBank is erased");
237 COMMAND_HANDLER(handle_flash_erase_address_command
)
239 struct flash_bank
*p
;
240 int retval
= ERROR_OK
;
241 target_addr_t address
;
244 bool do_unlock
= false;
245 struct target
*target
= get_current_target(CMD_CTX
);
247 while (CMD_ARGC
>= 3) {
248 /* Optionally pad out the address range to block/sector
249 * boundaries. We can't know if there's data in that part
250 * of the flash; only do padding if we're told to.
252 if (strcmp("pad", CMD_ARGV
[0]) == 0)
254 else if (strcmp("unlock", CMD_ARGV
[0]) == 0)
257 return ERROR_COMMAND_SYNTAX_ERROR
;
262 return ERROR_COMMAND_SYNTAX_ERROR
;
264 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], address
);
265 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], length
);
268 command_print(CMD
, "Length must be >0");
269 return ERROR_COMMAND_SYNTAX_ERROR
;
272 retval
= get_flash_bank_by_addr(target
, address
, true, &p
);
273 if (retval
!= ERROR_OK
)
276 /* We can't know if we did a resume + halt, in which case we no longer know the erased state
280 struct duration bench
;
281 duration_start(&bench
);
284 retval
= flash_unlock_address_range(target
, address
, length
);
286 if (retval
== ERROR_OK
)
287 retval
= flash_erase_address_range(target
, do_pad
, address
, length
);
289 if ((retval
== ERROR_OK
) && (duration_measure(&bench
) == ERROR_OK
)) {
290 command_print(CMD
, "erased address " TARGET_ADDR_FMT
" (length %" PRIu32
")"
291 " in %fs (%0.3f KiB/s)", address
, length
,
292 duration_elapsed(&bench
), duration_kbps(&bench
, length
));
298 COMMAND_HANDLER(handle_flash_erase_command
)
301 return ERROR_COMMAND_SYNTAX_ERROR
;
306 struct flash_bank
*p
;
309 retval
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &p
);
310 if (retval
!= ERROR_OK
)
313 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], first
);
314 if (strcmp(CMD_ARGV
[2], "last") == 0)
315 last
= p
->num_sectors
- 1;
317 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], last
);
319 if (!(first
<= last
)) {
320 command_print(CMD
, "ERROR: "
321 "first sector must be <= last");
325 if (!(last
<= (p
->num_sectors
- 1))) {
326 command_print(CMD
, "ERROR: "
327 "last sector must be <= %u",
332 struct duration bench
;
333 duration_start(&bench
);
335 retval
= flash_driver_erase(p
, first
, last
);
337 if ((retval
== ERROR_OK
) && (duration_measure(&bench
) == ERROR_OK
)) {
338 command_print(CMD
, "erased sectors %" PRIu32
" "
339 "through %" PRIu32
" on flash bank %u "
340 "in %fs", first
, last
, p
->bank_number
, duration_elapsed(&bench
));
346 COMMAND_HANDLER(handle_flash_protect_command
)
349 return ERROR_COMMAND_SYNTAX_ERROR
;
354 struct flash_bank
*p
;
358 retval
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &p
);
359 if (retval
!= ERROR_OK
)
362 if (p
->num_prot_blocks
)
363 num_blocks
= p
->num_prot_blocks
;
365 num_blocks
= p
->num_sectors
;
367 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], first
);
368 if (strcmp(CMD_ARGV
[2], "last") == 0)
369 last
= num_blocks
- 1;
371 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], last
);
374 COMMAND_PARSE_ON_OFF(CMD_ARGV
[3], set
);
376 if (!(first
<= last
)) {
377 command_print(CMD
, "ERROR: "
378 "first %s must be <= last",
379 (p
->num_prot_blocks
) ? "block" : "sector");
383 if (!(last
<= (uint32_t)(num_blocks
- 1))) {
384 command_print(CMD
, "ERROR: "
385 "last %s must be <= %d",
386 (p
->num_prot_blocks
) ? "block" : "sector",
391 retval
= flash_driver_protect(p
, set
, first
, last
);
392 if (retval
== ERROR_OK
) {
393 command_print(CMD
, "%s protection for %s %" PRIu32
394 " through %" PRIu32
" on flash bank %d",
395 (set
) ? "set" : "cleared",
396 (p
->num_prot_blocks
) ? "blocks" : "sectors",
397 first
, last
, p
->bank_number
);
403 COMMAND_HANDLER(handle_flash_write_image_command
)
405 struct target
*target
= get_current_target(CMD_CTX
);
412 /* flash auto-erase is disabled by default*/
414 bool auto_unlock
= false;
417 if (strcmp(CMD_ARGV
[0], "erase") == 0) {
421 command_print(CMD
, "auto erase enabled");
422 } else if (strcmp(CMD_ARGV
[0], "unlock") == 0) {
426 command_print(CMD
, "auto unlock enabled");
432 return ERROR_COMMAND_SYNTAX_ERROR
;
435 LOG_ERROR("no target selected");
439 struct duration bench
;
440 duration_start(&bench
);
443 image
.base_address_set
= true;
444 COMMAND_PARSE_NUMBER(llong
, CMD_ARGV
[1], image
.base_address
);
446 image
.base_address_set
= false;
447 image
.base_address
= 0x0;
450 image
.start_address_set
= false;
452 retval
= image_open(&image
, CMD_ARGV
[0], (CMD_ARGC
== 3) ? CMD_ARGV
[2] : NULL
);
453 if (retval
!= ERROR_OK
)
456 retval
= flash_write_unlock_verify(target
, &image
, &written
, auto_erase
,
457 auto_unlock
, true, false);
458 if (retval
!= ERROR_OK
) {
463 if ((retval
== ERROR_OK
) && (duration_measure(&bench
) == ERROR_OK
)) {
464 command_print(CMD
, "wrote %" PRIu32
" bytes from file %s "
465 "in %fs (%0.3f KiB/s)", written
, CMD_ARGV
[0],
466 duration_elapsed(&bench
), duration_kbps(&bench
, written
));
474 COMMAND_HANDLER(handle_flash_verify_image_command
)
476 struct target
*target
= get_current_target(CMD_CTX
);
484 return ERROR_COMMAND_SYNTAX_ERROR
;
487 LOG_ERROR("no target selected");
491 struct duration bench
;
492 duration_start(&bench
);
495 image
.base_address_set
= 1;
496 COMMAND_PARSE_NUMBER(llong
, CMD_ARGV
[1], image
.base_address
);
498 image
.base_address_set
= 0;
499 image
.base_address
= 0x0;
502 image
.start_address_set
= 0;
504 retval
= image_open(&image
, CMD_ARGV
[0], (CMD_ARGC
== 3) ? CMD_ARGV
[2] : NULL
);
505 if (retval
!= ERROR_OK
)
508 retval
= flash_write_unlock_verify(target
, &image
, &verified
, false,
510 if (retval
!= ERROR_OK
) {
515 if ((retval
== ERROR_OK
) && (duration_measure(&bench
) == ERROR_OK
)) {
516 command_print(CMD
, "verified %" PRIu32
" bytes from file %s "
517 "in %fs (%0.3f KiB/s)", verified
, CMD_ARGV
[0],
518 duration_elapsed(&bench
), duration_kbps(&bench
, verified
));
526 COMMAND_HANDLER(handle_flash_fill_command
)
528 target_addr_t address
;
531 struct target
*target
= get_current_target(CMD_CTX
);
537 return ERROR_COMMAND_SYNTAX_ERROR
;
539 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], address
);
540 COMMAND_PARSE_NUMBER(u64
, CMD_ARGV
[1], pattern
);
541 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], count
);
543 struct flash_bank
*bank
;
544 retval
= get_flash_bank_by_addr(target
, address
, true, &bank
);
545 if (retval
!= ERROR_OK
)
548 switch (CMD_NAME
[4]) {
562 return ERROR_COMMAND_SYNTAX_ERROR
;
565 if ((wordsize
< sizeof(pattern
)) && (pattern
>> (8 * wordsize
) != 0)) {
566 command_print(CMD
, "Fill pattern 0x%" PRIx64
" does not fit within %" PRIu32
"-byte word", pattern
, wordsize
);
573 if (address
+ count
* wordsize
> bank
->base
+ bank
->size
) {
574 LOG_ERROR("Cannot cross flash bank borders");
578 uint32_t size_bytes
= count
* wordsize
;
579 target_addr_t aligned_start
= flash_write_align_start(bank
, address
);
580 target_addr_t end_addr
= address
+ size_bytes
- 1;
581 target_addr_t aligned_end
= flash_write_align_end(bank
, end_addr
);
582 uint32_t aligned_size
= aligned_end
+ 1 - aligned_start
;
583 uint32_t padding_at_start
= address
- aligned_start
;
584 uint32_t padding_at_end
= aligned_end
- end_addr
;
586 uint8_t *buffer
= malloc(aligned_size
);
590 if (padding_at_start
) {
591 memset(buffer
, bank
->default_padded_value
, padding_at_start
);
592 LOG_WARNING("Start address " TARGET_ADDR_FMT
593 " breaks the required alignment of flash bank %s",
594 address
, bank
->name
);
595 LOG_WARNING("Padding %" PRIu32
" bytes from " TARGET_ADDR_FMT
,
596 padding_at_start
, aligned_start
);
599 uint8_t *ptr
= buffer
+ padding_at_start
;
603 for (i
= 0; i
< count
; i
++, ptr
+= wordsize
)
604 target_buffer_set_u64(target
, ptr
, pattern
);
607 for (i
= 0; i
< count
; i
++, ptr
+= wordsize
)
608 target_buffer_set_u32(target
, ptr
, pattern
);
611 for (i
= 0; i
< count
; i
++, ptr
+= wordsize
)
612 target_buffer_set_u16(target
, ptr
, pattern
);
615 memset(ptr
, pattern
, count
);
619 LOG_ERROR("BUG: can't happen");
623 if (padding_at_end
) {
624 memset(ptr
, bank
->default_padded_value
, padding_at_end
);
625 LOG_INFO("Padding at " TARGET_ADDR_FMT
" with %" PRIu32
626 " bytes (bank write end alignment)",
627 end_addr
+ 1, padding_at_end
);
630 struct duration bench
;
631 duration_start(&bench
);
633 retval
= flash_driver_write(bank
, buffer
, aligned_start
- bank
->base
, aligned_size
);
634 if (retval
!= ERROR_OK
)
637 retval
= flash_driver_read(bank
, buffer
, address
- bank
->base
, size_bytes
);
638 if (retval
!= ERROR_OK
)
641 for (i
= 0, ptr
= buffer
; i
< count
; i
++) {
642 uint64_t readback
= 0;
646 readback
= target_buffer_get_u64(target
, ptr
);
649 readback
= target_buffer_get_u32(target
, ptr
);
652 readback
= target_buffer_get_u16(target
, ptr
);
658 if (readback
!= pattern
) {
660 "Verification error address " TARGET_ADDR_FMT
661 ", read back 0x%02" PRIx64
", expected 0x%02" PRIx64
,
662 address
+ i
* wordsize
, readback
, pattern
);
669 if ((retval
== ERROR_OK
) && (duration_measure(&bench
) == ERROR_OK
)) {
670 command_print(CMD
, "wrote %" PRIu32
" bytes to " TARGET_ADDR_FMT
671 " in %fs (%0.3f KiB/s)", size_bytes
, address
,
672 duration_elapsed(&bench
), duration_kbps(&bench
, size_bytes
));
681 COMMAND_HANDLER(handle_flash_md_command
)
685 if (CMD_ARGC
< 1 || CMD_ARGC
> 2)
686 return ERROR_COMMAND_SYNTAX_ERROR
;
688 target_addr_t address
;
689 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], address
);
693 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], count
);
695 unsigned int wordsize
;
696 switch (CMD_NAME
[2]) {
707 return ERROR_COMMAND_SYNTAX_ERROR
;
713 struct target
*target
= get_current_target(CMD_CTX
);
714 struct flash_bank
*bank
;
715 retval
= get_flash_bank_by_addr(target
, address
, true, &bank
);
716 if (retval
!= ERROR_OK
)
719 uint32_t offset
= address
- bank
->base
;
720 uint32_t sizebytes
= count
* wordsize
;
721 if (offset
+ sizebytes
> bank
->size
) {
722 command_print(CMD
, "Cannot cross flash bank borders");
726 uint8_t *buffer
= calloc(count
, wordsize
);
728 command_print(CMD
, "No memory for flash read buffer");
732 retval
= flash_driver_read(bank
, buffer
, offset
, sizebytes
);
733 if (retval
== ERROR_OK
)
734 target_handle_md_output(CMD
, target
, address
, wordsize
, count
, buffer
);
742 COMMAND_HANDLER(handle_flash_write_bank_command
)
747 struct fileio
*fileio
;
749 if (CMD_ARGC
< 2 || CMD_ARGC
> 3)
750 return ERROR_COMMAND_SYNTAX_ERROR
;
752 struct duration bench
;
753 duration_start(&bench
);
755 struct flash_bank
*bank
;
756 int retval
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &bank
);
757 if (retval
!= ERROR_OK
)
763 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], offset
);
765 if (offset
> bank
->size
) {
766 LOG_ERROR("Offset 0x%8.8" PRIx32
" is out of range of the flash bank",
768 return ERROR_COMMAND_ARGUMENT_INVALID
;
771 if (fileio_open(&fileio
, CMD_ARGV
[1], FILEIO_READ
, FILEIO_BINARY
) != ERROR_OK
)
775 retval
= fileio_size(fileio
, &filesize
);
776 if (retval
!= ERROR_OK
) {
777 fileio_close(fileio
);
781 length
= MIN(filesize
, bank
->size
- offset
);
784 LOG_INFO("Nothing to write to flash bank");
785 fileio_close(fileio
);
789 if (length
!= filesize
)
790 LOG_INFO("File content exceeds flash bank size. Only writing the "
791 "first %zu bytes of the file", length
);
793 target_addr_t start_addr
= bank
->base
+ offset
;
794 target_addr_t aligned_start
= flash_write_align_start(bank
, start_addr
);
795 target_addr_t end_addr
= start_addr
+ length
- 1;
796 target_addr_t aligned_end
= flash_write_align_end(bank
, end_addr
);
797 uint32_t aligned_size
= aligned_end
+ 1 - aligned_start
;
798 uint32_t padding_at_start
= start_addr
- aligned_start
;
799 uint32_t padding_at_end
= aligned_end
- end_addr
;
801 buffer
= malloc(aligned_size
);
803 fileio_close(fileio
);
804 LOG_ERROR("Out of memory");
808 if (padding_at_start
) {
809 memset(buffer
, bank
->default_padded_value
, padding_at_start
);
810 LOG_WARNING("Start offset 0x%08" PRIx32
811 " breaks the required alignment of flash bank %s",
813 LOG_WARNING("Padding %" PRIu32
" bytes from " TARGET_ADDR_FMT
,
814 padding_at_start
, aligned_start
);
817 uint8_t *ptr
= buffer
+ padding_at_start
;
819 if (fileio_read(fileio
, length
, ptr
, &buf_cnt
) != ERROR_OK
) {
821 fileio_close(fileio
);
825 if (buf_cnt
!= length
) {
826 LOG_ERROR("Short read");
833 if (padding_at_end
) {
834 memset(ptr
, bank
->default_padded_value
, padding_at_end
);
835 LOG_INFO("Padding at " TARGET_ADDR_FMT
" with %" PRIu32
836 " bytes (bank write end alignment)",
837 end_addr
+ 1, padding_at_end
);
840 retval
= flash_driver_write(bank
, buffer
, aligned_start
- bank
->base
, aligned_size
);
844 if ((retval
== ERROR_OK
) && (duration_measure(&bench
) == ERROR_OK
)) {
845 command_print(CMD
, "wrote %zu bytes from file %s to flash bank %u"
846 " at offset 0x%8.8" PRIx32
" in %fs (%0.3f KiB/s)",
847 length
, CMD_ARGV
[1], bank
->bank_number
, offset
,
848 duration_elapsed(&bench
), duration_kbps(&bench
, length
));
851 fileio_close(fileio
);
856 COMMAND_HANDLER(handle_flash_read_bank_command
)
860 struct fileio
*fileio
;
864 if (CMD_ARGC
< 2 || CMD_ARGC
> 4)
865 return ERROR_COMMAND_SYNTAX_ERROR
;
867 struct duration bench
;
868 duration_start(&bench
);
870 struct flash_bank
*p
;
871 int retval
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &p
);
873 if (retval
!= ERROR_OK
)
879 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], offset
);
881 if (offset
> p
->size
) {
882 LOG_ERROR("Offset 0x%8.8" PRIx32
" is out of range of the flash bank",
884 return ERROR_COMMAND_ARGUMENT_INVALID
;
887 length
= p
->size
- offset
;
890 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[3], length
);
892 if (offset
+ length
> p
->size
) {
893 LOG_ERROR("Length of %" PRIu32
" bytes with offset 0x%8.8" PRIx32
894 " is out of range of the flash bank", length
, offset
);
895 return ERROR_COMMAND_ARGUMENT_INVALID
;
898 buffer
= malloc(length
);
900 LOG_ERROR("Out of memory");
904 retval
= flash_driver_read(p
, buffer
, offset
, length
);
905 if (retval
!= ERROR_OK
) {
906 LOG_ERROR("Read error");
911 retval
= fileio_open(&fileio
, CMD_ARGV
[1], FILEIO_WRITE
, FILEIO_BINARY
);
912 if (retval
!= ERROR_OK
) {
913 LOG_ERROR("Could not open file");
918 retval
= fileio_write(fileio
, length
, buffer
, &written
);
919 fileio_close(fileio
);
921 if (retval
!= ERROR_OK
) {
922 LOG_ERROR("Could not write file");
926 if (duration_measure(&bench
) == ERROR_OK
)
927 command_print(CMD
, "wrote %zd bytes to file %s from flash bank %u"
928 " at offset 0x%8.8" PRIx32
" in %fs (%0.3f KiB/s)",
929 written
, CMD_ARGV
[1], p
->bank_number
, offset
,
930 duration_elapsed(&bench
), duration_kbps(&bench
, written
));
936 COMMAND_HANDLER(handle_flash_verify_bank_command
)
939 uint8_t *buffer_file
, *buffer_flash
;
940 struct fileio
*fileio
;
946 if (CMD_ARGC
< 2 || CMD_ARGC
> 3)
947 return ERROR_COMMAND_SYNTAX_ERROR
;
949 struct duration bench
;
950 duration_start(&bench
);
952 struct flash_bank
*p
;
953 int retval
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &p
);
954 if (retval
!= ERROR_OK
)
960 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], offset
);
962 if (offset
> p
->size
) {
963 LOG_ERROR("Offset 0x%8.8" PRIx32
" is out of range of the flash bank",
965 return ERROR_COMMAND_ARGUMENT_INVALID
;
968 retval
= fileio_open(&fileio
, CMD_ARGV
[1], FILEIO_READ
, FILEIO_BINARY
);
969 if (retval
!= ERROR_OK
) {
970 LOG_ERROR("Could not open file");
974 retval
= fileio_size(fileio
, &filesize
);
975 if (retval
!= ERROR_OK
) {
976 fileio_close(fileio
);
980 length
= MIN(filesize
, p
->size
- offset
);
983 LOG_INFO("Nothing to compare with flash bank");
984 fileio_close(fileio
);
988 if (length
!= filesize
)
989 LOG_INFO("File content exceeds flash bank size. Only comparing the "
990 "first %zu bytes of the file", length
);
992 buffer_file
= malloc(length
);
994 LOG_ERROR("Out of memory");
995 fileio_close(fileio
);
999 retval
= fileio_read(fileio
, length
, buffer_file
, &read_cnt
);
1000 fileio_close(fileio
);
1001 if (retval
!= ERROR_OK
) {
1002 LOG_ERROR("File read failure");
1007 if (read_cnt
!= length
) {
1008 LOG_ERROR("Short read");
1013 buffer_flash
= malloc(length
);
1014 if (!buffer_flash
) {
1015 LOG_ERROR("Out of memory");
1020 retval
= flash_driver_read(p
, buffer_flash
, offset
, length
);
1021 if (retval
!= ERROR_OK
) {
1022 LOG_ERROR("Flash read error");
1028 if (duration_measure(&bench
) == ERROR_OK
)
1029 command_print(CMD
, "read %zd bytes from file %s and flash bank %u"
1030 " at offset 0x%8.8" PRIx32
" in %fs (%0.3f KiB/s)",
1031 length
, CMD_ARGV
[1], p
->bank_number
, offset
,
1032 duration_elapsed(&bench
), duration_kbps(&bench
, length
));
1034 differ
= memcmp(buffer_file
, buffer_flash
, length
);
1035 command_print(CMD
, "contents %s", differ
? "differ" : "match");
1039 for (t
= 0; t
< length
; t
++) {
1040 if (buffer_flash
[t
] == buffer_file
[t
])
1042 command_print(CMD
, "diff %d address 0x%08" PRIx32
". Was 0x%02x instead of 0x%02x",
1043 diffs
, t
+ offset
, buffer_flash
[t
], buffer_file
[t
]);
1044 if (diffs
++ >= 127) {
1045 command_print(CMD
, "More than 128 errors, the rest are not printed.");
1054 return differ
? ERROR_FAIL
: ERROR_OK
;
1057 void flash_set_dirty(void)
1059 struct flash_bank
*c
;
1061 /* set all flash to require erasing */
1062 for (c
= flash_bank_list(); c
; c
= c
->next
) {
1063 for (unsigned int i
= 0; i
< c
->num_sectors
; i
++)
1064 c
->sectors
[i
].is_erased
= 0;
1068 COMMAND_HANDLER(handle_flash_padded_value_command
)
1071 return ERROR_COMMAND_SYNTAX_ERROR
;
1073 struct flash_bank
*p
;
1074 int retval
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &p
);
1075 if (retval
!= ERROR_OK
)
1078 COMMAND_PARSE_NUMBER(u8
, CMD_ARGV
[1], p
->default_padded_value
);
1080 command_print(CMD
, "Default padded value set to 0x%" PRIx8
" for flash bank %u",
1081 p
->default_padded_value
, p
->bank_number
);
1086 static const struct command_registration flash_exec_command_handlers
[] = {
1089 .handler
= handle_flash_probe_command
,
1090 .mode
= COMMAND_EXEC
,
1092 .help
= "Identify a flash bank.",
1096 .handler
= handle_flash_info_command
,
1097 .mode
= COMMAND_EXEC
,
1098 .usage
= "bank_id ['sectors']",
1099 .help
= "Print information about a flash bank.",
1102 .name
= "erase_check",
1103 .handler
= handle_flash_erase_check_command
,
1104 .mode
= COMMAND_EXEC
,
1106 .help
= "Check erase state of all blocks in a "
1110 .name
= "erase_sector",
1111 .handler
= handle_flash_erase_command
,
1112 .mode
= COMMAND_EXEC
,
1113 .usage
= "bank_id first_sector_num (last_sector_num|'last')",
1114 .help
= "Erase a range of sectors in a flash bank.",
1117 .name
= "erase_address",
1118 .handler
= handle_flash_erase_address_command
,
1119 .mode
= COMMAND_EXEC
,
1120 .usage
= "['pad'] ['unlock'] address length",
1121 .help
= "Erase flash sectors starting at address and "
1122 "continuing for length bytes. If 'pad' is specified, "
1123 "data outside that range may also be erased: the start "
1124 "address may be decreased, and length increased, so "
1125 "that all of the first and last sectors are erased. "
1126 "If 'unlock' is specified, then the flash is unprotected "
1132 .handler
= handle_flash_fill_command
,
1133 .mode
= COMMAND_EXEC
,
1134 .usage
= "address value n",
1135 .help
= "Fill n double-words with 64-bit value, starting at "
1136 "word address. (No autoerase.)",
1140 .handler
= handle_flash_fill_command
,
1141 .mode
= COMMAND_EXEC
,
1142 .usage
= "address value n",
1143 .help
= "Fill n words with 32-bit value, starting at "
1144 "word address. (No autoerase.)",
1148 .handler
= handle_flash_fill_command
,
1149 .mode
= COMMAND_EXEC
,
1150 .usage
= "address value n",
1151 .help
= "Fill n halfwords with 16-bit value, starting at "
1152 "word address. (No autoerase.)",
1156 .handler
= handle_flash_fill_command
,
1157 .mode
= COMMAND_EXEC
,
1158 .usage
= "address value n",
1159 .help
= "Fill n bytes with 8-bit value, starting at "
1160 "word address. (No autoerase.)",
1164 .handler
= handle_flash_md_command
,
1165 .mode
= COMMAND_EXEC
,
1166 .usage
= "address [count]",
1167 .help
= "Display bytes from flash.",
1171 .handler
= handle_flash_md_command
,
1172 .mode
= COMMAND_EXEC
,
1173 .usage
= "address [count]",
1174 .help
= "Display half-words from flash.",
1178 .handler
= handle_flash_md_command
,
1179 .mode
= COMMAND_EXEC
,
1180 .usage
= "address [count]",
1181 .help
= "Display words from flash.",
1184 .name
= "write_bank",
1185 .handler
= handle_flash_write_bank_command
,
1186 .mode
= COMMAND_EXEC
,
1187 .usage
= "bank_id filename [offset]",
1188 .help
= "Write binary data from file to flash bank. Allow optional "
1189 "offset from beginning of the bank (defaults to zero).",
1192 .name
= "write_image",
1193 .handler
= handle_flash_write_image_command
,
1194 .mode
= COMMAND_EXEC
,
1195 .usage
= "[erase] [unlock] filename [offset [file_type]]",
1196 .help
= "Write an image to flash. Optionally first unprotect "
1197 "and/or erase the region to be used. Allow optional "
1198 "offset from beginning of bank (defaults to zero)",
1201 .name
= "verify_image",
1202 .handler
= handle_flash_verify_image_command
,
1203 .mode
= COMMAND_EXEC
,
1204 .usage
= "filename [offset [file_type]]",
1205 .help
= "Verify an image against flash. Allow optional "
1206 "offset from beginning of bank (defaults to zero)",
1209 .name
= "read_bank",
1210 .handler
= handle_flash_read_bank_command
,
1211 .mode
= COMMAND_EXEC
,
1212 .usage
= "bank_id filename [offset [length]]",
1213 .help
= "Read binary data from flash bank to file. Allow optional "
1214 "offset from beginning of the bank (defaults to zero).",
1217 .name
= "verify_bank",
1218 .handler
= handle_flash_verify_bank_command
,
1219 .mode
= COMMAND_EXEC
,
1220 .usage
= "bank_id filename [offset]",
1221 .help
= "Compare the contents of a file with the contents of the "
1222 "flash bank. Allow optional offset from beginning of the bank "
1223 "(defaults to zero).",
1227 .handler
= handle_flash_protect_command
,
1228 .mode
= COMMAND_EXEC
,
1229 .usage
= "bank_id first_block [last_block|'last'] "
1231 .help
= "Turn protection on or off for a range of protection "
1232 "blocks or sectors in a given flash bank. "
1233 "See 'flash info' output for a list of blocks.",
1236 .name
= "padded_value",
1237 .handler
= handle_flash_padded_value_command
,
1238 .mode
= COMMAND_EXEC
,
1239 .usage
= "bank_id value",
1240 .help
= "Set default flash padded value",
1242 COMMAND_REGISTRATION_DONE
1245 static int flash_init_drivers(struct command_context
*cmd_ctx
)
1247 if (!flash_bank_list())
1250 return register_commands(cmd_ctx
, "flash", flash_exec_command_handlers
);
1253 COMMAND_HANDLER(handle_flash_bank_command
)
1256 LOG_ERROR("usage: flash bank <name> <driver> "
1257 "<base> <size> <chip_width> <bus_width> <target>");
1258 return ERROR_COMMAND_SYNTAX_ERROR
;
1260 /* save bank name and advance arguments for compatibility */
1261 const char *bank_name
= *CMD_ARGV
++;
1264 struct target
*target
= get_target(CMD_ARGV
[5]);
1266 LOG_ERROR("target '%s' not defined", CMD_ARGV
[5]);
1270 const char *driver_name
= CMD_ARGV
[0];
1271 const struct flash_driver
*driver
= flash_driver_find_by_name(driver_name
);
1273 /* no matching flash driver found */
1274 LOG_ERROR("flash driver '%s' not found", driver_name
);
1278 /* check the flash bank name is unique */
1279 if (get_flash_bank_by_name_noprobe(bank_name
)) {
1280 /* flash bank name already exists */
1281 LOG_ERROR("flash bank name '%s' already exists", bank_name
);
1285 /* register flash specific commands */
1286 if (driver
->commands
) {
1287 int retval
= register_commands(CMD_CTX
, NULL
, driver
->commands
);
1288 if (retval
!= ERROR_OK
) {
1289 LOG_ERROR("couldn't register '%s' commands",
1295 struct flash_bank
*c
= calloc(1, sizeof(*c
));
1296 c
->name
= strdup(bank_name
);
1299 COMMAND_PARSE_NUMBER(target_addr
, CMD_ARGV
[1], c
->base
);
1300 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], c
->size
);
1301 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[3], c
->chip_width
);
1302 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[4], c
->bus_width
);
1303 c
->default_padded_value
= c
->erased_value
= 0xff;
1304 c
->minimal_write_gap
= FLASH_WRITE_GAP_SECTOR
;
1307 retval
= CALL_COMMAND_HANDLER(driver
->flash_bank_command
, c
);
1308 if (retval
!= ERROR_OK
) {
1309 LOG_ERROR("'%s' driver rejected flash bank at " TARGET_ADDR_FMT
1310 "; usage: %s", driver_name
, c
->base
, driver
->usage
);
1316 LOG_DEBUG("'%s' driver usage field missing", driver_name
);
1323 COMMAND_HANDLER(handle_flash_banks_command
)
1326 return ERROR_COMMAND_SYNTAX_ERROR
;
1329 for (struct flash_bank
*p
= flash_bank_list(); p
; p
= p
->next
, n
++) {
1330 command_print(CMD
, "#%d : %s (%s) at " TARGET_ADDR_FMT
", size 0x%8.8" PRIx32
", "
1331 "buswidth %u, chipwidth %u", p
->bank_number
,
1332 p
->name
, p
->driver
->name
, p
->base
, p
->size
,
1333 p
->bus_width
, p
->chip_width
);
1338 static int jim_flash_list(Jim_Interp
*interp
, int argc
, Jim_Obj
* const *argv
)
1341 Jim_WrongNumArgs(interp
, 1, argv
,
1342 "no arguments to 'flash list' command");
1346 Jim_Obj
*list
= Jim_NewListObj(interp
, NULL
, 0);
1348 for (struct flash_bank
*p
= flash_bank_list(); p
; p
= p
->next
) {
1349 Jim_Obj
*elem
= Jim_NewListObj(interp
, NULL
, 0);
1351 Jim_ListAppendElement(interp
, elem
, Jim_NewStringObj(interp
, "name", -1));
1352 Jim_ListAppendElement(interp
, elem
, Jim_NewStringObj(interp
, p
->name
, -1));
1353 Jim_ListAppendElement(interp
, elem
, Jim_NewStringObj(interp
, "driver", -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
));
1363 Jim_ListAppendElement(interp
, elem
, Jim_NewStringObj(interp
, "target", -1));
1364 Jim_ListAppendElement(interp
, elem
, Jim_NewStringObj(interp
, target_name(p
->target
), -1));
1366 Jim_ListAppendElement(interp
, list
, elem
);
1369 Jim_SetResult(interp
, list
);
1374 COMMAND_HANDLER(handle_flash_init_command
)
1377 return ERROR_COMMAND_SYNTAX_ERROR
;
1379 static bool flash_initialized
;
1380 if (flash_initialized
) {
1381 LOG_INFO("'flash init' has already been called");
1384 flash_initialized
= true;
1386 LOG_DEBUG("Initializing flash devices...");
1387 return flash_init_drivers(CMD_CTX
);
1390 static const struct command_registration flash_config_command_handlers
[] = {
1393 .handler
= handle_flash_bank_command
,
1394 .mode
= COMMAND_CONFIG
,
1395 .usage
= "bank_id driver_name base_address size_bytes "
1396 "chip_width_bytes bus_width_bytes target "
1397 "[driver_options ...]",
1398 .help
= "Define a new bank with the given name, "
1399 "using the specified NOR flash driver.",
1403 .mode
= COMMAND_CONFIG
,
1404 .handler
= handle_flash_init_command
,
1405 .help
= "Initialize flash devices.",
1410 .mode
= COMMAND_ANY
,
1411 .handler
= handle_flash_banks_command
,
1412 .help
= "Display table with information about flash banks.",
1417 .mode
= COMMAND_ANY
,
1418 .jim_handler
= jim_flash_list
,
1419 .help
= "Returns a list of details about the flash banks.",
1421 COMMAND_REGISTRATION_DONE
1423 static const struct command_registration flash_command_handlers
[] = {
1426 .mode
= COMMAND_ANY
,
1427 .help
= "NOR flash command group",
1428 .chain
= flash_config_command_handlers
,
1431 COMMAND_REGISTRATION_DONE
1434 int flash_register_commands(struct command_context
*cmd_ctx
)
1436 return register_commands(cmd_ctx
, NULL
, flash_command_handlers
);