]>
git.ipfire.org Git - thirdparty/u-boot.git/blob - cmd/sf.c
1 // SPDX-License-Identifier: GPL-2.0+
3 * Command for accessing SPI flash.
5 * Copyright (C) 2008 Atmel Corporation
14 #include <spi_flash.h>
15 #include <jffs2/jffs2.h>
16 #include <linux/mtd/mtd.h>
19 #include <dm/device-internal.h>
21 static struct spi_flash
*flash
;
24 * This function computes the length argument for the erase command.
25 * The length on which the command is to operate can be given in two forms:
26 * 1. <cmd> offset len - operate on <'offset', 'len')
27 * 2. <cmd> offset +len - operate on <'offset', 'round_up(len)')
28 * If the second form is used and the length doesn't fall on the
29 * sector boundary, than it will be adjusted to the next sector boundary.
30 * If it isn't in the flash, the function will fail (return -1).
32 * arg: length specification (i.e. both command arguments)
34 * len: computed length for operation
37 * -1: failure (bad format, bad address).
39 static int sf_parse_len_arg(char *arg
, ulong
*len
)
42 char round_up_len
; /* indicates if the "+length" form used */
51 len_arg
= simple_strtoul(arg
, &ep
, 16);
52 if (ep
== arg
|| *ep
!= '\0')
55 if (round_up_len
&& flash
->sector_size
> 0)
56 *len
= ROUND(len_arg
, flash
->sector_size
);
64 * This function takes a byte length and a delta unit of time to compute the
65 * approximate bytes per second
67 * @param len amount of bytes currently processed
68 * @param start_ms start time of processing in ms
69 * @return bytes per second if OK, 0 on error
71 static ulong
bytes_per_second(unsigned int len
, ulong start_ms
)
73 /* less accurate but avoids overflow */
74 if (len
>= ((unsigned int) -1) / 1024)
75 return len
/ (max(get_timer(start_ms
) / 1024, 1UL));
77 return 1024 * len
/ max(get_timer(start_ms
), 1UL);
80 static int do_spi_flash_probe(int argc
, char * const argv
[])
82 unsigned int bus
= CONFIG_SF_DEFAULT_BUS
;
83 unsigned int cs
= CONFIG_SF_DEFAULT_CS
;
84 unsigned int speed
= CONFIG_SF_DEFAULT_SPEED
;
85 unsigned int mode
= CONFIG_SF_DEFAULT_MODE
;
87 #ifdef CONFIG_DM_SPI_FLASH
88 struct udevice
*new, *bus_dev
;
90 /* In DM mode defaults will be taken from DT */
93 struct spi_flash
*new;
97 cs
= simple_strtoul(argv
[1], &endp
, 0);
98 if (*argv
[1] == 0 || (*endp
!= 0 && *endp
!= ':'))
105 cs
= simple_strtoul(endp
+ 1, &endp
, 0);
112 speed
= simple_strtoul(argv
[2], &endp
, 0);
113 if (*argv
[2] == 0 || *endp
!= 0)
117 mode
= simple_strtoul(argv
[3], &endp
, 16);
118 if (*argv
[3] == 0 || *endp
!= 0)
122 #ifdef CONFIG_DM_SPI_FLASH
123 /* Remove the old device, otherwise probe will just be a nop */
124 ret
= spi_find_bus_and_cs(bus
, cs
, &bus_dev
, &new);
126 device_remove(new, DM_REMOVE_NORMAL
);
129 ret
= spi_flash_probe_bus_cs(bus
, cs
, speed
, mode
, &new);
131 printf("Failed to initialize SPI flash at %u:%u (error %d)\n",
136 flash
= dev_get_uclass_priv(new);
139 spi_flash_free(flash
);
141 new = spi_flash_probe(bus
, cs
, speed
, mode
);
145 printf("Failed to initialize SPI flash at %u:%u\n", bus
, cs
);
156 * Write a block of data to SPI flash, first checking if it is different from
157 * what is already there.
159 * If the data being written is the same, then *skipped is incremented by len.
161 * @param flash flash context pointer
162 * @param offset flash offset to write
163 * @param len number of bytes to write
164 * @param buf buffer to write from
165 * @param cmp_buf read buffer to use to compare data
166 * @param skipped Count of skipped data (incremented by this function)
167 * @return NULL if OK, else a string containing the stage which failed
169 static const char *spi_flash_update_block(struct spi_flash
*flash
, u32 offset
,
170 size_t len
, const char *buf
, char *cmp_buf
, size_t *skipped
)
172 char *ptr
= (char *)buf
;
174 debug("offset=%#x, sector_size=%#x, len=%#zx\n",
175 offset
, flash
->sector_size
, len
);
176 /* Read the entire sector so to allow for rewriting */
177 if (spi_flash_read(flash
, offset
, flash
->sector_size
, cmp_buf
))
179 /* Compare only what is meaningful (len) */
180 if (memcmp(cmp_buf
, buf
, len
) == 0) {
181 debug("Skip region %x size %zx: no change\n",
186 /* Erase the entire sector */
187 if (spi_flash_erase(flash
, offset
, flash
->sector_size
))
189 /* If it's a partial sector, copy the data into the temp-buffer */
190 if (len
!= flash
->sector_size
) {
191 memcpy(cmp_buf
, buf
, len
);
194 /* Write one complete sector */
195 if (spi_flash_write(flash
, offset
, flash
->sector_size
, ptr
))
202 * Update an area of SPI flash by erasing and writing any blocks which need
203 * to change. Existing blocks with the correct data are left unchanged.
205 * @param flash flash context pointer
206 * @param offset flash offset to write
207 * @param len number of bytes to write
208 * @param buf buffer to write from
209 * @return 0 if ok, 1 on error
211 static int spi_flash_update(struct spi_flash
*flash
, u32 offset
,
212 size_t len
, const char *buf
)
214 const char *err_oper
= NULL
;
216 const char *end
= buf
+ len
;
217 size_t todo
; /* number of bytes to do in this pass */
218 size_t skipped
= 0; /* statistics */
219 const ulong start_time
= get_timer(0);
221 const char *start_buf
= buf
;
224 if (end
- buf
>= 200)
225 scale
= (end
- buf
) / 100;
226 cmp_buf
= memalign(ARCH_DMA_MINALIGN
, flash
->sector_size
);
228 ulong last_update
= get_timer(0);
230 for (; buf
< end
&& !err_oper
; buf
+= todo
, offset
+= todo
) {
231 todo
= min_t(size_t, end
- buf
, flash
->sector_size
);
232 if (get_timer(last_update
) > 100) {
233 printf(" \rUpdating, %zu%% %lu B/s",
234 100 - (end
- buf
) / scale
,
235 bytes_per_second(buf
- start_buf
,
237 last_update
= get_timer(0);
239 err_oper
= spi_flash_update_block(flash
, offset
, todo
,
240 buf
, cmp_buf
, &skipped
);
248 printf("SPI flash failed in %s step\n", err_oper
);
252 delta
= get_timer(start_time
);
253 printf("%zu bytes written, %zu bytes skipped", len
- skipped
,
255 printf(" in %ld.%lds, speed %ld B/s\n",
256 delta
/ 1000, delta
% 1000, bytes_per_second(len
, start_time
));
261 static int do_spi_flash_read_write(int argc
, char * const argv
[])
268 loff_t offset
, len
, maxsize
;
273 addr
= simple_strtoul(argv
[1], &endp
, 16);
274 if (*argv
[1] == 0 || *endp
!= 0)
277 if (mtd_arg_off_size(argc
- 2, &argv
[2], &dev
, &offset
, &len
,
278 &maxsize
, MTD_DEV_TYPE_NOR
, flash
->size
))
281 /* Consistency checking */
282 if (offset
+ len
> flash
->size
) {
283 printf("ERROR: attempting %s past flash size (%#x)\n",
284 argv
[0], flash
->size
);
288 buf
= map_physmem(addr
, len
, MAP_WRBACK
);
290 puts("Failed to map physical memory\n");
294 if (strcmp(argv
[0], "update") == 0) {
295 ret
= spi_flash_update(flash
, offset
, len
, buf
);
296 } else if (strncmp(argv
[0], "read", 4) == 0 ||
297 strncmp(argv
[0], "write", 5) == 0) {
300 read
= strncmp(argv
[0], "read", 4) == 0;
302 ret
= spi_flash_read(flash
, offset
, len
, buf
);
304 ret
= spi_flash_write(flash
, offset
, len
, buf
);
306 printf("SF: %zu bytes @ %#x %s: ", (size_t)len
, (u32
)offset
,
307 read
? "Read" : "Written");
309 printf("ERROR %d\n", ret
);
314 unmap_physmem(buf
, len
);
316 return ret
== 0 ? 0 : 1;
319 static int do_spi_flash_erase(int argc
, char * const argv
[])
323 loff_t offset
, len
, maxsize
;
329 if (mtd_arg_off(argv
[1], &dev
, &offset
, &len
, &maxsize
,
330 MTD_DEV_TYPE_NOR
, flash
->size
))
333 ret
= sf_parse_len_arg(argv
[2], &size
);
337 /* Consistency checking */
338 if (offset
+ size
> flash
->size
) {
339 printf("ERROR: attempting %s past flash size (%#x)\n",
340 argv
[0], flash
->size
);
344 ret
= spi_flash_erase(flash
, offset
, size
);
345 printf("SF: %zu bytes @ %#x Erased: %s\n", (size_t)size
, (u32
)offset
,
346 ret
? "ERROR" : "OK");
348 return ret
== 0 ? 0 : 1;
351 static int do_spi_protect(int argc
, char * const argv
[])
360 if (!str2off(argv
[2], &start
)) {
361 puts("start sector is not a valid number\n");
365 if (!str2off(argv
[3], &len
)) {
366 puts("len is not a valid number\n");
370 if (strcmp(argv
[1], "lock") == 0)
372 else if (strcmp(argv
[1], "unlock") == 0)
375 return -1; /* Unknown parameter */
377 ret
= spi_flash_protect(flash
, start
, len
, prot
);
379 return ret
== 0 ? 0 : 1;
382 #ifdef CONFIG_CMD_SF_TEST
392 static char *stage_name
[STAGE_COUNT
] = {
403 unsigned time_ms
[STAGE_COUNT
];
406 static void show_time(struct test_info
*test
, int stage
)
408 uint64_t speed
; /* KiB/s */
409 int bps
; /* Bits per second */
411 speed
= (long long)test
->bytes
* 1000;
412 if (test
->time_ms
[stage
])
413 do_div(speed
, test
->time_ms
[stage
] * 1024);
416 printf("%d %s: %d ticks, %d KiB/s %d.%03d Mbps\n", stage
,
417 stage_name
[stage
], test
->time_ms
[stage
],
418 (int)speed
, bps
/ 1000, bps
% 1000);
421 static void spi_test_next_stage(struct test_info
*test
)
423 test
->time_ms
[test
->stage
] = get_timer(test
->base_ms
);
424 show_time(test
, test
->stage
);
425 test
->base_ms
= get_timer(0);
430 * Run a test on the SPI flash
432 * @param flash SPI flash to use
433 * @param buf Source buffer for data to write
434 * @param len Size of data to read/write
435 * @param offset Offset within flash to check
436 * @param vbuf Verification buffer
437 * @return 0 if ok, -1 on error
439 static int spi_flash_test(struct spi_flash
*flash
, uint8_t *buf
, ulong len
,
440 ulong offset
, uint8_t *vbuf
)
442 struct test_info test
;
445 printf("SPI flash test:\n");
446 memset(&test
, '\0', sizeof(test
));
447 test
.base_ms
= get_timer(0);
449 if (spi_flash_erase(flash
, offset
, len
)) {
450 printf("Erase failed\n");
453 spi_test_next_stage(&test
);
455 if (spi_flash_read(flash
, offset
, len
, vbuf
)) {
456 printf("Check read failed\n");
459 for (i
= 0; i
< len
; i
++) {
460 if (vbuf
[i
] != 0xff) {
461 printf("Check failed at %d\n", i
);
462 print_buffer(i
, vbuf
+ i
, 1,
463 min_t(uint
, len
- i
, 0x40), 0);
467 spi_test_next_stage(&test
);
469 if (spi_flash_write(flash
, offset
, len
, buf
)) {
470 printf("Write failed\n");
473 memset(vbuf
, '\0', len
);
474 spi_test_next_stage(&test
);
476 if (spi_flash_read(flash
, offset
, len
, vbuf
)) {
477 printf("Read failed\n");
480 spi_test_next_stage(&test
);
482 for (i
= 0; i
< len
; i
++) {
483 if (buf
[i
] != vbuf
[i
]) {
484 printf("Verify failed at %d, good data:\n", i
);
485 print_buffer(i
, buf
+ i
, 1,
486 min_t(uint
, len
- i
, 0x40), 0);
487 printf("Bad data:\n");
488 print_buffer(i
, vbuf
+ i
, 1,
489 min_t(uint
, len
- i
, 0x40), 0);
493 printf("Test passed\n");
494 for (i
= 0; i
< STAGE_COUNT
; i
++)
500 static int do_spi_flash_test(int argc
, char * const argv
[])
502 unsigned long offset
;
511 offset
= simple_strtoul(argv
[1], &endp
, 16);
512 if (*argv
[1] == 0 || *endp
!= 0)
514 len
= simple_strtoul(argv
[2], &endp
, 16);
515 if (*argv
[2] == 0 || *endp
!= 0)
518 vbuf
= memalign(ARCH_DMA_MINALIGN
, len
);
520 printf("Cannot allocate memory (%lu bytes)\n", len
);
523 buf
= memalign(ARCH_DMA_MINALIGN
, len
);
526 printf("Cannot allocate memory (%lu bytes)\n", len
);
530 from
= map_sysmem(CONFIG_SYS_TEXT_BASE
, 0);
531 memcpy(buf
, from
, len
);
532 ret
= spi_flash_test(flash
, buf
, len
, offset
, vbuf
);
536 printf("Test failed\n");
542 #endif /* CONFIG_CMD_SF_TEST */
544 static int do_spi_flash(cmd_tbl_t
*cmdtp
, int flag
, int argc
,
550 /* need at least two arguments */
558 if (strcmp(cmd
, "probe") == 0) {
559 ret
= do_spi_flash_probe(argc
, argv
);
563 /* The remaining commands require a selected device */
565 puts("No SPI flash selected. Please run `sf probe'\n");
569 if (strcmp(cmd
, "read") == 0 || strcmp(cmd
, "write") == 0 ||
570 strcmp(cmd
, "update") == 0)
571 ret
= do_spi_flash_read_write(argc
, argv
);
572 else if (strcmp(cmd
, "erase") == 0)
573 ret
= do_spi_flash_erase(argc
, argv
);
574 else if (strcmp(cmd
, "protect") == 0)
575 ret
= do_spi_protect(argc
, argv
);
576 #ifdef CONFIG_CMD_SF_TEST
577 else if (!strcmp(cmd
, "test"))
578 ret
= do_spi_flash_test(argc
, argv
);
588 return CMD_RET_USAGE
;
591 #ifdef CONFIG_CMD_SF_TEST
592 #define SF_TEST_HELP "\nsf test offset len " \
593 "- run a very basic destructive test"
599 sf
, 5, 1, do_spi_flash
,
600 "SPI flash sub-system",
601 "probe [[bus:]cs] [hz] [mode] - init flash device on given SPI bus\n"
603 "sf read addr offset|partition len - read `len' bytes starting at\n"
604 " `offset' or from start of mtd\n"
605 " `partition'to memory at `addr'\n"
606 "sf write addr offset|partition len - write `len' bytes from memory\n"
607 " at `addr' to flash at `offset'\n"
608 " or to start of mtd `partition'\n"
609 "sf erase offset|partition [+]len - erase `len' bytes from `offset'\n"
610 " or from start of mtd `partition'\n"
611 " `+len' round up `len' to block size\n"
612 "sf update addr offset|partition len - erase and write `len' bytes from memory\n"
613 " at `addr' to flash at `offset'\n"
614 " or to start of mtd `partition'\n"
615 "sf protect lock/unlock sector len - protect/unprotect 'len' bytes starting\n"
616 " at address 'sector'\n"