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> *
7 * This program is free software; you can redistribute it and/or modify *
8 * it under the terms of the GNU General Public License as published by *
9 * the Free Software Foundation; either version 2 of the License, or *
10 * (at your option) any later version. *
12 * This program is distributed in the hope that it will be useful, *
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
15 * GNU General Public License for more details. *
17 * You should have received a copy of the GNU General Public License *
18 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
19 ***************************************************************************/
24 #include <helper/time_support.h>
25 #include <target/image.h>
29 * Implements Tcl commands used to access NOR flash facilities.
32 COMMAND_HELPER(flash_command_get_bank_maybe_probe
, unsigned name_index
,
33 struct flash_bank
**bank
, bool do_probe
)
35 const char *name
= CMD_ARGV
[name_index
];
38 retval
= get_flash_bank_by_name(name
, bank
);
40 *bank
= get_flash_bank_by_name_noprobe(name
);
44 if (retval
!= ERROR_OK
)
50 COMMAND_PARSE_NUMBER(uint
, name
, bank_num
);
53 return get_flash_bank_by_num(bank_num
, bank
);
55 *bank
= get_flash_bank_by_num_noprobe(bank_num
);
56 retval
= (bank
) ? ERROR_OK
: ERROR_FAIL
;
61 COMMAND_HELPER(flash_command_get_bank
, unsigned name_index
,
62 struct flash_bank
**bank
)
64 return CALL_COMMAND_HANDLER(flash_command_get_bank_maybe_probe
,
65 name_index
, bank
, true);
68 COMMAND_HANDLER(handle_flash_info_command
)
73 bool show_sectors
= false;
74 bool prot_block_available
;
76 if (CMD_ARGC
< 1 || CMD_ARGC
> 2)
77 return ERROR_COMMAND_SYNTAX_ERROR
;
80 if (strcmp("sectors", CMD_ARGV
[1]) == 0)
83 return ERROR_COMMAND_SYNTAX_ERROR
;
86 retval
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &p
);
87 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 /* We must query the hardware to avoid printing stale information! */
101 retval
= p
->driver
->protect_check(p
);
102 if (retval
!= ERROR_OK
)
105 command_print(CMD_CTX
,
106 "#%d : %s at 0x%8.8" PRIx32
", size 0x%8.8" PRIx32
107 ", buswidth %i, chipwidth %i",
115 prot_block_available
= p
->num_prot_blocks
&& p
->prot_blocks
;
116 if (!show_sectors
&& prot_block_available
) {
117 block_array
= p
->prot_blocks
;
118 num_blocks
= p
->num_prot_blocks
;
120 block_array
= p
->sectors
;
121 num_blocks
= p
->num_sectors
;
124 for (j
= 0; j
< num_blocks
; j
++) {
125 char *protect_state
= "";
127 if (block_array
[j
].is_protected
== 0)
128 protect_state
= "not protected";
129 else if (block_array
[j
].is_protected
== 1)
130 protect_state
= "protected";
131 else if (!show_sectors
|| !prot_block_available
)
132 protect_state
= "protection state unknown";
134 command_print(CMD_CTX
,
135 "\t#%3i: 0x%8.8" PRIx32
" (0x%" PRIx32
" %" PRIi32
"kB) %s",
137 block_array
[j
].offset
,
139 block_array
[j
].size
>> 10,
143 if (p
->driver
->info
!= NULL
) {
144 retval
= p
->driver
->info(p
, buf
, sizeof(buf
));
145 if (retval
== ERROR_OK
)
146 command_print(CMD_CTX
, "%s", buf
);
148 LOG_ERROR("error retrieving flash info");
155 COMMAND_HANDLER(handle_flash_probe_command
)
157 struct flash_bank
*p
;
161 return ERROR_COMMAND_SYNTAX_ERROR
;
163 retval
= CALL_COMMAND_HANDLER(flash_command_get_bank_maybe_probe
, 0, &p
, false);
164 if (retval
!= ERROR_OK
)
168 retval
= p
->driver
->probe(p
);
169 if (retval
== ERROR_OK
)
170 command_print(CMD_CTX
,
171 "flash '%s' found at 0x%8.8" PRIx32
,
175 command_print(CMD_CTX
, "flash bank '#%s' is out of bounds", CMD_ARGV
[0]);
182 COMMAND_HANDLER(handle_flash_erase_check_command
)
186 return ERROR_COMMAND_SYNTAX_ERROR
;
188 struct flash_bank
*p
;
189 int retval
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &p
);
190 if (ERROR_OK
!= retval
)
194 retval
= p
->driver
->erase_check(p
);
195 if (retval
== ERROR_OK
)
196 command_print(CMD_CTX
, "successfully checked erase state");
198 command_print(CMD_CTX
,
199 "unknown error when checking erase state of flash bank #%s at 0x%8.8" PRIx32
,
204 for (j
= 0; j
< p
->num_sectors
; j
++) {
207 if (p
->sectors
[j
].is_erased
== 0)
208 erase_state
= "not erased";
209 else if (p
->sectors
[j
].is_erased
== 1)
212 erase_state
= "erase state unknown";
215 command_print(CMD_CTX
,
216 "\t#%3i: 0x%8.8" PRIx32
" (0x%" PRIx32
" %" PRIi32
"kB) %s",
218 p
->sectors
[j
].offset
,
220 p
->sectors
[j
].size
>> 10,
225 command_print(CMD_CTX
, "\tBank is erased");
229 COMMAND_HANDLER(handle_flash_erase_address_command
)
231 struct flash_bank
*p
;
232 int retval
= ERROR_OK
;
236 bool do_unlock
= false;
237 struct target
*target
= get_current_target(CMD_CTX
);
239 while (CMD_ARGC
>= 3) {
240 /* Optionally pad out the address range to block/sector
241 * boundaries. We can't know if there's data in that part
242 * of the flash; only do padding if we're told to.
244 if (strcmp("pad", CMD_ARGV
[0]) == 0)
246 else if (strcmp("unlock", CMD_ARGV
[0]) == 0)
249 return ERROR_COMMAND_SYNTAX_ERROR
;
254 return ERROR_COMMAND_SYNTAX_ERROR
;
256 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[0], address
);
257 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], length
);
260 command_print(CMD_CTX
, "Length must be >0");
261 return ERROR_COMMAND_SYNTAX_ERROR
;
264 retval
= get_flash_bank_by_addr(target
, address
, true, &p
);
265 if (retval
!= ERROR_OK
)
268 /* We can't know if we did a resume + halt, in which case we no longer know the erased state
272 struct duration bench
;
273 duration_start(&bench
);
276 retval
= flash_unlock_address_range(target
, address
, length
);
278 if (retval
== ERROR_OK
)
279 retval
= flash_erase_address_range(target
, do_pad
, address
, length
);
281 if ((ERROR_OK
== retval
) && (duration_measure(&bench
) == ERROR_OK
)) {
282 command_print(CMD_CTX
, "erased address 0x%8.8" PRIx32
" (length %" PRIi32
")"
283 " in %fs (%0.3f KiB/s)", address
, length
,
284 duration_elapsed(&bench
), duration_kbps(&bench
, length
));
290 static int flash_check_sector_parameters(struct command_context
*cmd_ctx
,
291 uint32_t first
, uint32_t last
, uint32_t num_sectors
)
293 if (!(first
<= last
)) {
294 command_print(cmd_ctx
, "ERROR: "
295 "first sector must be <= last sector");
299 if (!(last
<= (num_sectors
- 1))) {
300 command_print(cmd_ctx
, "ERROR: last sector must be <= %" PRIu32
,
308 COMMAND_HANDLER(handle_flash_erase_command
)
311 return ERROR_COMMAND_SYNTAX_ERROR
;
316 struct flash_bank
*p
;
319 retval
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &p
);
320 if (retval
!= ERROR_OK
)
323 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], first
);
324 if (strcmp(CMD_ARGV
[2], "last") == 0)
325 last
= p
->num_sectors
- 1;
327 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], last
);
329 retval
= flash_check_sector_parameters(CMD_CTX
, first
, last
, p
->num_sectors
);
330 if (retval
!= ERROR_OK
)
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_CTX
, "erased sectors %" PRIu32
" "
340 "through %" PRIu32
" on flash bank %d "
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 retval
= flash_check_sector_parameters(CMD_CTX
, first
, last
, num_blocks
);
378 if (retval
!= ERROR_OK
)
381 retval
= flash_driver_protect(p
, set
, first
, last
);
382 if (retval
== ERROR_OK
) {
383 command_print(CMD_CTX
, "%s protection for sectors %" PRIu32
384 " through %" PRIu32
" on flash bank %d",
385 (set
) ? "set" : "cleared", first
, last
, p
->bank_number
);
391 COMMAND_HANDLER(handle_flash_write_image_command
)
393 struct target
*target
= get_current_target(CMD_CTX
);
400 /* flash auto-erase is disabled by default*/
402 bool auto_unlock
= false;
405 if (strcmp(CMD_ARGV
[0], "erase") == 0) {
409 command_print(CMD_CTX
, "auto erase enabled");
410 } else if (strcmp(CMD_ARGV
[0], "unlock") == 0) {
414 command_print(CMD_CTX
, "auto unlock enabled");
420 return ERROR_COMMAND_SYNTAX_ERROR
;
423 LOG_ERROR("no target selected");
427 struct duration bench
;
428 duration_start(&bench
);
431 image
.base_address_set
= 1;
432 COMMAND_PARSE_NUMBER(llong
, CMD_ARGV
[1], image
.base_address
);
434 image
.base_address_set
= 0;
435 image
.base_address
= 0x0;
438 image
.start_address_set
= 0;
440 retval
= image_open(&image
, CMD_ARGV
[0], (CMD_ARGC
== 3) ? CMD_ARGV
[2] : NULL
);
441 if (retval
!= ERROR_OK
)
444 retval
= flash_write_unlock(target
, &image
, &written
, auto_erase
, auto_unlock
);
445 if (retval
!= ERROR_OK
) {
450 if ((ERROR_OK
== retval
) && (duration_measure(&bench
) == ERROR_OK
)) {
451 command_print(CMD_CTX
, "wrote %" PRIu32
" bytes from file %s "
452 "in %fs (%0.3f KiB/s)", written
, CMD_ARGV
[0],
453 duration_elapsed(&bench
), duration_kbps(&bench
, written
));
461 COMMAND_HANDLER(handle_flash_fill_command
)
468 uint32_t cur_size
= 0;
469 uint32_t chunk_count
;
470 struct target
*target
= get_current_target(CMD_CTX
);
473 int retval
= ERROR_OK
;
475 static size_t const chunksize
= 1024;
476 uint8_t *chunk
= NULL
, *readback
= NULL
;
479 retval
= ERROR_COMMAND_SYNTAX_ERROR
;
483 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[0], address
);
484 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], pattern
);
485 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], count
);
487 chunk
= malloc(chunksize
);
491 readback
= malloc(chunksize
);
492 if (readback
== NULL
) {
500 switch (CMD_NAME
[4]) {
511 retval
= ERROR_COMMAND_SYNTAX_ERROR
;
515 chunk_count
= MIN(count
, (chunksize
/ wordsize
));
518 for (i
= 0; i
< chunk_count
; i
++)
519 target_buffer_set_u32(target
, chunk
+ i
* wordsize
, pattern
);
522 for (i
= 0; i
< chunk_count
; i
++)
523 target_buffer_set_u16(target
, chunk
+ i
* wordsize
, pattern
);
526 memset(chunk
, pattern
, chunk_count
);
529 LOG_ERROR("BUG: can't happen");
533 struct duration bench
;
534 duration_start(&bench
);
536 for (wrote
= 0; wrote
< (count
*wordsize
); wrote
+= cur_size
) {
537 struct flash_bank
*bank
;
539 retval
= get_flash_bank_by_addr(target
, address
, true, &bank
);
540 if (retval
!= ERROR_OK
)
543 cur_size
= MIN((count
* wordsize
- wrote
), chunksize
);
544 err
= flash_driver_write(bank
, chunk
, address
- bank
->base
+ wrote
, cur_size
);
545 if (err
!= ERROR_OK
) {
550 err
= flash_driver_read(bank
, readback
, address
- bank
->base
+ wrote
, cur_size
);
551 if (err
!= ERROR_OK
) {
556 for (i
= 0; i
< cur_size
; i
++) {
557 if (readback
[i
] != chunk
[i
]) {
559 "Verification error address 0x%08" PRIx32
", read back 0x%02x, expected 0x%02x",
569 if ((retval
== ERROR_OK
) && (duration_measure(&bench
) == ERROR_OK
)) {
570 command_print(CMD_CTX
, "wrote %" PRIu32
" bytes to 0x%8.8" PRIx32
571 " in %fs (%0.3f KiB/s)", wrote
, address
,
572 duration_elapsed(&bench
), duration_kbps(&bench
, wrote
));
582 COMMAND_HANDLER(handle_flash_write_bank_command
)
587 struct fileio
*fileio
;
589 if (CMD_ARGC
< 2 || CMD_ARGC
> 3)
590 return ERROR_COMMAND_SYNTAX_ERROR
;
592 struct duration bench
;
593 duration_start(&bench
);
595 struct flash_bank
*p
;
596 int retval
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &p
);
597 if (ERROR_OK
!= retval
)
603 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], offset
);
605 if (offset
> p
->size
) {
606 LOG_ERROR("Offset 0x%8.8" PRIx32
" is out of range of the flash bank",
608 return ERROR_COMMAND_ARGUMENT_INVALID
;
611 if (fileio_open(&fileio
, CMD_ARGV
[1], FILEIO_READ
, FILEIO_BINARY
) != ERROR_OK
)
615 retval
= fileio_size(fileio
, &filesize
);
616 if (retval
!= ERROR_OK
) {
617 fileio_close(fileio
);
621 length
= MIN(filesize
, p
->size
- offset
);
624 LOG_INFO("Nothing to write to flash bank");
625 fileio_close(fileio
);
629 if (length
!= filesize
)
630 LOG_INFO("File content exceeds flash bank size. Only writing the "
631 "first %zu bytes of the file", length
);
633 buffer
= malloc(length
);
634 if (buffer
== NULL
) {
635 fileio_close(fileio
);
636 LOG_ERROR("Out of memory");
640 if (fileio_read(fileio
, length
, buffer
, &buf_cnt
) != ERROR_OK
) {
642 fileio_close(fileio
);
646 if (buf_cnt
!= length
) {
647 LOG_ERROR("Short read");
652 retval
= flash_driver_write(p
, buffer
, offset
, length
);
657 if ((ERROR_OK
== retval
) && (duration_measure(&bench
) == ERROR_OK
)) {
658 command_print(CMD_CTX
, "wrote %zu bytes from file %s to flash bank %u"
659 " at offset 0x%8.8" PRIx32
" in %fs (%0.3f KiB/s)",
660 length
, CMD_ARGV
[1], p
->bank_number
, offset
,
661 duration_elapsed(&bench
), duration_kbps(&bench
, length
));
664 fileio_close(fileio
);
669 COMMAND_HANDLER(handle_flash_read_bank_command
)
673 struct fileio
*fileio
;
678 return ERROR_COMMAND_SYNTAX_ERROR
;
680 struct duration bench
;
681 duration_start(&bench
);
683 struct flash_bank
*p
;
684 int retval
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &p
);
685 if (ERROR_OK
!= retval
)
688 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], offset
);
689 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[3], length
);
691 buffer
= malloc(length
);
692 if (buffer
== NULL
) {
693 LOG_ERROR("Out of memory");
697 retval
= flash_driver_read(p
, buffer
, offset
, length
);
698 if (retval
!= ERROR_OK
) {
699 LOG_ERROR("Read error");
704 retval
= fileio_open(&fileio
, CMD_ARGV
[1], FILEIO_WRITE
, FILEIO_BINARY
);
705 if (retval
!= ERROR_OK
) {
706 LOG_ERROR("Could not open file");
711 retval
= fileio_write(fileio
, length
, buffer
, &written
);
712 fileio_close(fileio
);
714 if (retval
!= ERROR_OK
) {
715 LOG_ERROR("Could not write file");
719 if (duration_measure(&bench
) == ERROR_OK
)
720 command_print(CMD_CTX
, "wrote %zd bytes to file %s from flash bank %u"
721 " at offset 0x%8.8" PRIx32
" in %fs (%0.3f KiB/s)",
722 written
, CMD_ARGV
[1], p
->bank_number
, offset
,
723 duration_elapsed(&bench
), duration_kbps(&bench
, written
));
729 COMMAND_HANDLER(handle_flash_verify_bank_command
)
732 uint8_t *buffer_file
, *buffer_flash
;
733 struct fileio
*fileio
;
739 if (CMD_ARGC
< 2 || CMD_ARGC
> 3)
740 return ERROR_COMMAND_SYNTAX_ERROR
;
742 struct duration bench
;
743 duration_start(&bench
);
745 struct flash_bank
*p
;
746 int retval
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &p
);
747 if (ERROR_OK
!= retval
)
753 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], offset
);
755 if (offset
> p
->size
) {
756 LOG_ERROR("Offset 0x%8.8" PRIx32
" is out of range of the flash bank",
758 return ERROR_COMMAND_ARGUMENT_INVALID
;
761 retval
= fileio_open(&fileio
, CMD_ARGV
[1], FILEIO_READ
, FILEIO_BINARY
);
762 if (retval
!= ERROR_OK
) {
763 LOG_ERROR("Could not open file");
767 retval
= fileio_size(fileio
, &filesize
);
768 if (retval
!= ERROR_OK
) {
769 fileio_close(fileio
);
773 length
= MIN(filesize
, p
->size
- offset
);
776 LOG_INFO("Nothing to compare with flash bank");
777 fileio_close(fileio
);
781 if (length
!= filesize
)
782 LOG_INFO("File content exceeds flash bank size. Only comparing the "
783 "first %zu bytes of the file", length
);
785 buffer_file
= malloc(length
);
786 if (buffer_file
== NULL
) {
787 LOG_ERROR("Out of memory");
788 fileio_close(fileio
);
792 retval
= fileio_read(fileio
, length
, buffer_file
, &read_cnt
);
793 fileio_close(fileio
);
794 if (retval
!= ERROR_OK
) {
795 LOG_ERROR("File read failure");
800 if (read_cnt
!= length
) {
801 LOG_ERROR("Short read");
806 buffer_flash
= malloc(length
);
807 if (buffer_flash
== NULL
) {
808 LOG_ERROR("Out of memory");
813 retval
= flash_driver_read(p
, buffer_flash
, offset
, length
);
814 if (retval
!= ERROR_OK
) {
815 LOG_ERROR("Flash read error");
821 if (duration_measure(&bench
) == ERROR_OK
)
822 command_print(CMD_CTX
, "read %zd bytes from file %s and flash bank %u"
823 " at offset 0x%8.8" PRIx32
" in %fs (%0.3f KiB/s)",
824 length
, CMD_ARGV
[1], p
->bank_number
, offset
,
825 duration_elapsed(&bench
), duration_kbps(&bench
, length
));
827 differ
= memcmp(buffer_file
, buffer_flash
, length
);
828 command_print(CMD_CTX
, "contents %s", differ
? "differ" : "match");
832 for (t
= 0; t
< length
; t
++) {
833 if (buffer_flash
[t
] == buffer_file
[t
])
835 command_print(CMD_CTX
, "diff %d address 0x%08x. Was 0x%02x instead of 0x%02x",
836 diffs
, t
+ offset
, buffer_flash
[t
], buffer_file
[t
]);
837 if (diffs
++ >= 127) {
838 command_print(CMD_CTX
, "More than 128 errors, the rest are not printed.");
847 return differ
? ERROR_FAIL
: ERROR_OK
;
850 void flash_set_dirty(void)
852 struct flash_bank
*c
;
855 /* set all flash to require erasing */
856 for (c
= flash_bank_list(); c
; c
= c
->next
) {
857 for (i
= 0; i
< c
->num_sectors
; i
++)
858 c
->sectors
[i
].is_erased
= 0;
862 COMMAND_HANDLER(handle_flash_padded_value_command
)
865 return ERROR_COMMAND_SYNTAX_ERROR
;
867 struct flash_bank
*p
;
868 int retval
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &p
);
869 if (ERROR_OK
!= retval
)
872 COMMAND_PARSE_NUMBER(u8
, CMD_ARGV
[1], p
->default_padded_value
);
874 command_print(CMD_CTX
, "Default padded value set to 0x%" PRIx8
" for flash bank %u", \
875 p
->default_padded_value
, p
->bank_number
);
880 static const struct command_registration flash_exec_command_handlers
[] = {
883 .handler
= handle_flash_probe_command
,
884 .mode
= COMMAND_EXEC
,
886 .help
= "Identify a flash bank.",
890 .handler
= handle_flash_info_command
,
891 .mode
= COMMAND_EXEC
,
892 .usage
= "bank_id ['sectors']",
893 .help
= "Print information about a flash bank.",
896 .name
= "erase_check",
897 .handler
= handle_flash_erase_check_command
,
898 .mode
= COMMAND_EXEC
,
900 .help
= "Check erase state of all blocks in a "
904 .name
= "erase_sector",
905 .handler
= handle_flash_erase_command
,
906 .mode
= COMMAND_EXEC
,
907 .usage
= "bank_id first_sector_num last_sector_num",
908 .help
= "Erase a range of sectors in a flash bank.",
911 .name
= "erase_address",
912 .handler
= handle_flash_erase_address_command
,
913 .mode
= COMMAND_EXEC
,
914 .usage
= "['pad'] ['unlock'] address length",
915 .help
= "Erase flash sectors starting at address and "
916 "continuing for length bytes. If 'pad' is specified, "
917 "data outside that range may also be erased: the start "
918 "address may be decreased, and length increased, so "
919 "that all of the first and last sectors are erased. "
920 "If 'unlock' is specified, then the flash is unprotected "
926 .handler
= handle_flash_fill_command
,
927 .mode
= COMMAND_EXEC
,
928 .usage
= "address value n",
929 .help
= "Fill n words with 32-bit value, starting at "
930 "word address. (No autoerase.)",
934 .handler
= handle_flash_fill_command
,
935 .mode
= COMMAND_EXEC
,
936 .usage
= "address value n",
937 .help
= "Fill n halfwords with 16-bit value, starting at "
938 "word address. (No autoerase.)",
942 .handler
= handle_flash_fill_command
,
943 .mode
= COMMAND_EXEC
,
944 .usage
= "address value n",
945 .help
= "Fill n bytes with 8-bit value, starting at "
946 "word address. (No autoerase.)",
949 .name
= "write_bank",
950 .handler
= handle_flash_write_bank_command
,
951 .mode
= COMMAND_EXEC
,
952 .usage
= "bank_id filename [offset]",
953 .help
= "Write binary data from file to flash bank. Allow optional "
954 "offset from beginning of the bank (defaults to zero).",
957 .name
= "write_image",
958 .handler
= handle_flash_write_image_command
,
959 .mode
= COMMAND_EXEC
,
960 .usage
= "[erase] [unlock] filename [offset [file_type]]",
961 .help
= "Write an image to flash. Optionally first unprotect "
962 "and/or erase the region to be used. Allow optional "
963 "offset from beginning of bank (defaults to zero)",
967 .handler
= handle_flash_read_bank_command
,
968 .mode
= COMMAND_EXEC
,
969 .usage
= "bank_id filename offset length",
970 .help
= "Read binary data from flash bank to file, "
971 "starting at specified byte offset from the "
972 "beginning of the bank.",
975 .name
= "verify_bank",
976 .handler
= handle_flash_verify_bank_command
,
977 .mode
= COMMAND_EXEC
,
978 .usage
= "bank_id filename [offset]",
979 .help
= "Compare the contents of a file with the contents of the "
980 "flash bank. Allow optional offset from beginning of the bank "
981 "(defaults to zero).",
985 .handler
= handle_flash_protect_command
,
986 .mode
= COMMAND_EXEC
,
987 .usage
= "bank_id first_block [last_block|'last'] "
989 .help
= "Turn protection on or off for a range of protection "
990 "blocks or sectors in a given flash bank. "
991 "See 'flash info' output for a list of blocks.",
994 .name
= "padded_value",
995 .handler
= handle_flash_padded_value_command
,
996 .mode
= COMMAND_EXEC
,
997 .usage
= "bank_id value",
998 .help
= "Set default flash padded value",
1000 COMMAND_REGISTRATION_DONE
1003 static int flash_init_drivers(struct command_context
*cmd_ctx
)
1005 if (!flash_bank_list())
1008 struct command
*parent
= command_find_in_context(cmd_ctx
, "flash");
1009 return register_commands(cmd_ctx
, parent
, flash_exec_command_handlers
);
1012 COMMAND_HANDLER(handle_flash_bank_command
)
1015 LOG_ERROR("usage: flash bank <name> <driver> "
1016 "<base> <size> <chip_width> <bus_width> <target>");
1017 return ERROR_COMMAND_SYNTAX_ERROR
;
1019 /* save bank name and advance arguments for compatibility */
1020 const char *bank_name
= *CMD_ARGV
++;
1023 struct target
*target
= get_target(CMD_ARGV
[5]);
1024 if (target
== NULL
) {
1025 LOG_ERROR("target '%s' not defined", CMD_ARGV
[5]);
1029 const char *driver_name
= CMD_ARGV
[0];
1030 struct flash_driver
*driver
= flash_driver_find_by_name(driver_name
);
1031 if (NULL
== driver
) {
1032 /* no matching flash driver found */
1033 LOG_ERROR("flash driver '%s' not found", driver_name
);
1037 /* check the flash bank name is unique */
1038 if (get_flash_bank_by_name_noprobe(bank_name
) != NULL
) {
1039 /* flash bank name already exists */
1040 LOG_ERROR("flash bank name '%s' already exists", bank_name
);
1044 /* register flash specific commands */
1045 if (NULL
!= driver
->commands
) {
1046 int retval
= register_commands(CMD_CTX
, NULL
,
1048 if (ERROR_OK
!= retval
) {
1049 LOG_ERROR("couldn't register '%s' commands",
1055 struct flash_bank
*c
= malloc(sizeof(*c
));
1056 c
->name
= strdup(bank_name
);
1059 c
->driver_priv
= NULL
;
1060 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], c
->base
);
1061 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], c
->size
);
1062 COMMAND_PARSE_NUMBER(int, CMD_ARGV
[3], c
->chip_width
);
1063 COMMAND_PARSE_NUMBER(int, CMD_ARGV
[4], c
->bus_width
);
1064 c
->default_padded_value
= c
->erased_value
= 0xff;
1067 c
->num_prot_blocks
= 0;
1068 c
->prot_blocks
= NULL
;
1072 retval
= CALL_COMMAND_HANDLER(driver
->flash_bank_command
, c
);
1073 if (ERROR_OK
!= retval
) {
1074 LOG_ERROR("'%s' driver rejected flash bank at 0x%8.8" PRIx32
"; usage: %s",
1075 driver_name
, c
->base
, driver
->usage
);
1080 if (driver
->usage
== NULL
)
1081 LOG_DEBUG("'%s' driver usage field missing", driver_name
);
1088 COMMAND_HANDLER(handle_flash_banks_command
)
1091 return ERROR_COMMAND_SYNTAX_ERROR
;
1094 for (struct flash_bank
*p
= flash_bank_list(); p
; p
= p
->next
, n
++) {
1095 LOG_USER("#%d : %s (%s) at 0x%8.8" PRIx32
", size 0x%8.8" PRIx32
", "
1096 "buswidth %u, chipwidth %u", p
->bank_number
,
1097 p
->name
, p
->driver
->name
, p
->base
, p
->size
,
1098 p
->bus_width
, p
->chip_width
);
1103 static int jim_flash_list(Jim_Interp
*interp
, int argc
, Jim_Obj
* const *argv
)
1106 Jim_WrongNumArgs(interp
, 1, argv
,
1107 "no arguments to 'flash list' command");
1111 Jim_Obj
*list
= Jim_NewListObj(interp
, NULL
, 0);
1113 for (struct flash_bank
*p
= flash_bank_list(); p
; p
= p
->next
) {
1114 Jim_Obj
*elem
= Jim_NewListObj(interp
, NULL
, 0);
1116 Jim_ListAppendElement(interp
, elem
, Jim_NewStringObj(interp
, "name", -1));
1117 Jim_ListAppendElement(interp
, elem
, Jim_NewStringObj(interp
, p
->driver
->name
, -1));
1118 Jim_ListAppendElement(interp
, elem
, Jim_NewStringObj(interp
, "base", -1));
1119 Jim_ListAppendElement(interp
, elem
, Jim_NewIntObj(interp
, p
->base
));
1120 Jim_ListAppendElement(interp
, elem
, Jim_NewStringObj(interp
, "size", -1));
1121 Jim_ListAppendElement(interp
, elem
, Jim_NewIntObj(interp
, p
->size
));
1122 Jim_ListAppendElement(interp
, elem
, Jim_NewStringObj(interp
, "bus_width", -1));
1123 Jim_ListAppendElement(interp
, elem
, Jim_NewIntObj(interp
, p
->bus_width
));
1124 Jim_ListAppendElement(interp
, elem
, Jim_NewStringObj(interp
, "chip_width", -1));
1125 Jim_ListAppendElement(interp
, elem
, Jim_NewIntObj(interp
, p
->chip_width
));
1127 Jim_ListAppendElement(interp
, list
, elem
);
1130 Jim_SetResult(interp
, list
);
1135 COMMAND_HANDLER(handle_flash_init_command
)
1138 return ERROR_COMMAND_SYNTAX_ERROR
;
1140 static bool flash_initialized
;
1141 if (flash_initialized
) {
1142 LOG_INFO("'flash init' has already been called");
1145 flash_initialized
= true;
1147 LOG_DEBUG("Initializing flash devices...");
1148 return flash_init_drivers(CMD_CTX
);
1151 static const struct command_registration flash_config_command_handlers
[] = {
1154 .handler
= handle_flash_bank_command
,
1155 .mode
= COMMAND_CONFIG
,
1156 .usage
= "bank_id driver_name base_address size_bytes "
1157 "chip_width_bytes bus_width_bytes target "
1158 "[driver_options ...]",
1159 .help
= "Define a new bank with the given name, "
1160 "using the specified NOR flash driver.",
1164 .mode
= COMMAND_CONFIG
,
1165 .handler
= handle_flash_init_command
,
1166 .help
= "Initialize flash devices.",
1170 .mode
= COMMAND_ANY
,
1171 .handler
= handle_flash_banks_command
,
1172 .help
= "Display table with information about flash banks.",
1176 .mode
= COMMAND_ANY
,
1177 .jim_handler
= jim_flash_list
,
1178 .help
= "Returns a list of details about the flash banks.",
1180 COMMAND_REGISTRATION_DONE
1182 static const struct command_registration flash_command_handlers
[] = {
1185 .mode
= COMMAND_ANY
,
1186 .help
= "NOR flash command group",
1187 .chain
= flash_config_command_handlers
,
1189 COMMAND_REGISTRATION_DONE
1192 int flash_register_commands(struct command_context
*cmd_ctx
)
1194 return register_commands(cmd_ctx
, NULL
, flash_command_handlers
);