]>
git.ipfire.org Git - people/ms/u-boot.git/blob - cmd/sf.c
2 * Command for accessing SPI flash.
4 * Copyright (C) 2008 Atmel Corporation
6 * SPDX-License-Identifier: GPL-2.0+
15 #include <spi_flash.h>
16 #include <jffs2/jffs2.h>
17 #include <linux/mtd/mtd.h>
20 #include <dm/device-internal.h>
22 static struct spi_flash
*flash
;
25 * This function computes the length argument for the erase command.
26 * The length on which the command is to operate can be given in two forms:
27 * 1. <cmd> offset len - operate on <'offset', 'len')
28 * 2. <cmd> offset +len - operate on <'offset', 'round_up(len)')
29 * If the second form is used and the length doesn't fall on the
30 * sector boundary, than it will be adjusted to the next sector boundary.
31 * If it isn't in the flash, the function will fail (return -1).
33 * arg: length specification (i.e. both command arguments)
35 * len: computed length for operation
38 * -1: failure (bad format, bad address).
40 static int sf_parse_len_arg(char *arg
, ulong
*len
)
43 char round_up_len
; /* indicates if the "+length" form used */
52 len_arg
= simple_strtoul(arg
, &ep
, 16);
53 if (ep
== arg
|| *ep
!= '\0')
56 if (round_up_len
&& flash
->sector_size
> 0)
57 *len
= ROUND(len_arg
, flash
->sector_size
);
65 * This function takes a byte length and a delta unit of time to compute the
66 * approximate bytes per second
68 * @param len amount of bytes currently processed
69 * @param start_ms start time of processing in ms
70 * @return bytes per second if OK, 0 on error
72 static ulong
bytes_per_second(unsigned int len
, ulong start_ms
)
74 /* less accurate but avoids overflow */
75 if (len
>= ((unsigned int) -1) / 1024)
76 return len
/ (max(get_timer(start_ms
) / 1024, 1UL));
78 return 1024 * len
/ max(get_timer(start_ms
), 1UL);
81 static int do_spi_flash_probe(int argc
, char * const argv
[])
83 unsigned int bus
= CONFIG_SF_DEFAULT_BUS
;
84 unsigned int cs
= CONFIG_SF_DEFAULT_CS
;
85 unsigned int speed
= CONFIG_SF_DEFAULT_SPEED
;
86 unsigned int mode
= CONFIG_SF_DEFAULT_MODE
;
88 #ifdef CONFIG_DM_SPI_FLASH
89 struct udevice
*new, *bus_dev
;
91 /* In DM mode defaults will be taken from DT */
94 struct spi_flash
*new;
98 cs
= simple_strtoul(argv
[1], &endp
, 0);
99 if (*argv
[1] == 0 || (*endp
!= 0 && *endp
!= ':'))
106 cs
= simple_strtoul(endp
+ 1, &endp
, 0);
113 speed
= simple_strtoul(argv
[2], &endp
, 0);
114 if (*argv
[2] == 0 || *endp
!= 0)
118 mode
= simple_strtoul(argv
[3], &endp
, 16);
119 if (*argv
[3] == 0 || *endp
!= 0)
123 #ifdef CONFIG_DM_SPI_FLASH
124 /* Remove the old device, otherwise probe will just be a nop */
125 ret
= spi_find_bus_and_cs(bus
, cs
, &bus_dev
, &new);
127 device_remove(new, DM_REMOVE_NORMAL
);
130 ret
= spi_flash_probe_bus_cs(bus
, cs
, speed
, mode
, &new);
132 printf("Failed to initialize SPI flash at %u:%u (error %d)\n",
137 flash
= dev_get_uclass_priv(new);
140 spi_flash_free(flash
);
142 new = spi_flash_probe(bus
, cs
, speed
, mode
);
146 printf("Failed to initialize SPI flash at %u:%u\n", bus
, cs
);
157 * Write a block of data to SPI flash, first checking if it is different from
158 * what is already there.
160 * If the data being written is the same, then *skipped is incremented by len.
162 * @param flash flash context pointer
163 * @param offset flash offset to write
164 * @param len number of bytes to write
165 * @param buf buffer to write from
166 * @param cmp_buf read buffer to use to compare data
167 * @param skipped Count of skipped data (incremented by this function)
168 * @return NULL if OK, else a string containing the stage which failed
170 static const char *spi_flash_update_block(struct spi_flash
*flash
, u32 offset
,
171 size_t len
, const char *buf
, char *cmp_buf
, size_t *skipped
)
173 char *ptr
= (char *)buf
;
175 debug("offset=%#x, sector_size=%#x, len=%#zx\n",
176 offset
, flash
->sector_size
, len
);
177 /* Read the entire sector so to allow for rewriting */
178 if (spi_flash_read(flash
, offset
, flash
->sector_size
, cmp_buf
))
180 /* Compare only what is meaningful (len) */
181 if (memcmp(cmp_buf
, buf
, len
) == 0) {
182 debug("Skip region %x size %zx: no change\n",
187 /* Erase the entire sector */
188 if (spi_flash_erase(flash
, offset
, flash
->sector_size
))
190 /* If it's a partial sector, copy the data into the temp-buffer */
191 if (len
!= flash
->sector_size
) {
192 memcpy(cmp_buf
, buf
, len
);
195 /* Write one complete sector */
196 if (spi_flash_write(flash
, offset
, flash
->sector_size
, ptr
))
203 * Update an area of SPI flash by erasing and writing any blocks which need
204 * to change. Existing blocks with the correct data are left unchanged.
206 * @param flash flash context pointer
207 * @param offset flash offset to write
208 * @param len number of bytes to write
209 * @param buf buffer to write from
210 * @return 0 if ok, 1 on error
212 static int spi_flash_update(struct spi_flash
*flash
, u32 offset
,
213 size_t len
, const char *buf
)
215 const char *err_oper
= NULL
;
217 const char *end
= buf
+ len
;
218 size_t todo
; /* number of bytes to do in this pass */
219 size_t skipped
= 0; /* statistics */
220 const ulong start_time
= get_timer(0);
222 const char *start_buf
= buf
;
225 if (end
- buf
>= 200)
226 scale
= (end
- buf
) / 100;
227 cmp_buf
= memalign(ARCH_DMA_MINALIGN
, flash
->sector_size
);
229 ulong last_update
= get_timer(0);
231 for (; buf
< end
&& !err_oper
; buf
+= todo
, offset
+= todo
) {
232 todo
= min_t(size_t, end
- buf
, flash
->sector_size
);
233 if (get_timer(last_update
) > 100) {
234 printf(" \rUpdating, %zu%% %lu B/s",
235 100 - (end
- buf
) / scale
,
236 bytes_per_second(buf
- start_buf
,
238 last_update
= get_timer(0);
240 err_oper
= spi_flash_update_block(flash
, offset
, todo
,
241 buf
, cmp_buf
, &skipped
);
249 printf("SPI flash failed in %s step\n", err_oper
);
253 delta
= get_timer(start_time
);
254 printf("%zu bytes written, %zu bytes skipped", len
- skipped
,
256 printf(" in %ld.%lds, speed %ld B/s\n",
257 delta
/ 1000, delta
% 1000, bytes_per_second(len
, start_time
));
262 static int do_spi_flash_read_write(int argc
, char * const argv
[])
269 loff_t offset
, len
, maxsize
;
274 addr
= simple_strtoul(argv
[1], &endp
, 16);
275 if (*argv
[1] == 0 || *endp
!= 0)
278 if (mtd_arg_off_size(argc
- 2, &argv
[2], &dev
, &offset
, &len
,
279 &maxsize
, MTD_DEV_TYPE_NOR
, flash
->size
))
282 /* Consistency checking */
283 if (offset
+ len
> flash
->size
) {
284 printf("ERROR: attempting %s past flash size (%#x)\n",
285 argv
[0], flash
->size
);
289 buf
= map_physmem(addr
, len
, MAP_WRBACK
);
291 puts("Failed to map physical memory\n");
295 if (strcmp(argv
[0], "update") == 0) {
296 ret
= spi_flash_update(flash
, offset
, len
, buf
);
297 } else if (strncmp(argv
[0], "read", 4) == 0 ||
298 strncmp(argv
[0], "write", 5) == 0) {
301 read
= strncmp(argv
[0], "read", 4) == 0;
303 ret
= spi_flash_read(flash
, offset
, len
, buf
);
305 ret
= spi_flash_write(flash
, offset
, len
, buf
);
307 printf("SF: %zu bytes @ %#x %s: ", (size_t)len
, (u32
)offset
,
308 read
? "Read" : "Written");
310 printf("ERROR %d\n", ret
);
315 unmap_physmem(buf
, len
);
317 return ret
== 0 ? 0 : 1;
320 static int do_spi_flash_erase(int argc
, char * const argv
[])
324 loff_t offset
, len
, maxsize
;
330 if (mtd_arg_off(argv
[1], &dev
, &offset
, &len
, &maxsize
,
331 MTD_DEV_TYPE_NOR
, flash
->size
))
334 ret
= sf_parse_len_arg(argv
[2], &size
);
338 /* Consistency checking */
339 if (offset
+ size
> flash
->size
) {
340 printf("ERROR: attempting %s past flash size (%#x)\n",
341 argv
[0], flash
->size
);
345 ret
= spi_flash_erase(flash
, offset
, size
);
346 printf("SF: %zu bytes @ %#x Erased: %s\n", (size_t)size
, (u32
)offset
,
347 ret
? "ERROR" : "OK");
349 return ret
== 0 ? 0 : 1;
352 static int do_spi_protect(int argc
, char * const argv
[])
361 if (!str2off(argv
[2], &start
)) {
362 puts("start sector is not a valid number\n");
366 if (!str2off(argv
[3], &len
)) {
367 puts("len is not a valid number\n");
371 if (strcmp(argv
[1], "lock") == 0)
373 else if (strcmp(argv
[1], "unlock") == 0)
376 return -1; /* Unknown parameter */
378 ret
= spi_flash_protect(flash
, start
, len
, prot
);
380 return ret
== 0 ? 0 : 1;
383 #ifdef CONFIG_CMD_SF_TEST
393 static char *stage_name
[STAGE_COUNT
] = {
404 unsigned time_ms
[STAGE_COUNT
];
407 static void show_time(struct test_info
*test
, int stage
)
409 uint64_t speed
; /* KiB/s */
410 int bps
; /* Bits per second */
412 speed
= (long long)test
->bytes
* 1000;
413 if (test
->time_ms
[stage
])
414 do_div(speed
, test
->time_ms
[stage
] * 1024);
417 printf("%d %s: %d ticks, %d KiB/s %d.%03d Mbps\n", stage
,
418 stage_name
[stage
], test
->time_ms
[stage
],
419 (int)speed
, bps
/ 1000, bps
% 1000);
422 static void spi_test_next_stage(struct test_info
*test
)
424 test
->time_ms
[test
->stage
] = get_timer(test
->base_ms
);
425 show_time(test
, test
->stage
);
426 test
->base_ms
= get_timer(0);
431 * Run a test on the SPI flash
433 * @param flash SPI flash to use
434 * @param buf Source buffer for data to write
435 * @param len Size of data to read/write
436 * @param offset Offset within flash to check
437 * @param vbuf Verification buffer
438 * @return 0 if ok, -1 on error
440 static int spi_flash_test(struct spi_flash
*flash
, uint8_t *buf
, ulong len
,
441 ulong offset
, uint8_t *vbuf
)
443 struct test_info test
;
446 printf("SPI flash test:\n");
447 memset(&test
, '\0', sizeof(test
));
448 test
.base_ms
= get_timer(0);
450 if (spi_flash_erase(flash
, offset
, len
)) {
451 printf("Erase failed\n");
454 spi_test_next_stage(&test
);
456 if (spi_flash_read(flash
, offset
, len
, vbuf
)) {
457 printf("Check read failed\n");
460 for (i
= 0; i
< len
; i
++) {
461 if (vbuf
[i
] != 0xff) {
462 printf("Check failed at %d\n", i
);
463 print_buffer(i
, vbuf
+ i
, 1,
464 min_t(uint
, len
- i
, 0x40), 0);
468 spi_test_next_stage(&test
);
470 if (spi_flash_write(flash
, offset
, len
, buf
)) {
471 printf("Write failed\n");
474 memset(vbuf
, '\0', len
);
475 spi_test_next_stage(&test
);
477 if (spi_flash_read(flash
, offset
, len
, vbuf
)) {
478 printf("Read failed\n");
481 spi_test_next_stage(&test
);
483 for (i
= 0; i
< len
; i
++) {
484 if (buf
[i
] != vbuf
[i
]) {
485 printf("Verify failed at %d, good data:\n", i
);
486 print_buffer(i
, buf
+ i
, 1,
487 min_t(uint
, len
- i
, 0x40), 0);
488 printf("Bad data:\n");
489 print_buffer(i
, vbuf
+ i
, 1,
490 min_t(uint
, len
- i
, 0x40), 0);
494 printf("Test passed\n");
495 for (i
= 0; i
< STAGE_COUNT
; i
++)
501 static int do_spi_flash_test(int argc
, char * const argv
[])
503 unsigned long offset
;
512 offset
= simple_strtoul(argv
[1], &endp
, 16);
513 if (*argv
[1] == 0 || *endp
!= 0)
515 len
= simple_strtoul(argv
[2], &endp
, 16);
516 if (*argv
[2] == 0 || *endp
!= 0)
519 vbuf
= memalign(ARCH_DMA_MINALIGN
, len
);
521 printf("Cannot allocate memory (%lu bytes)\n", len
);
524 buf
= memalign(ARCH_DMA_MINALIGN
, len
);
527 printf("Cannot allocate memory (%lu bytes)\n", len
);
531 from
= map_sysmem(CONFIG_SYS_TEXT_BASE
, 0);
532 memcpy(buf
, from
, len
);
533 ret
= spi_flash_test(flash
, buf
, len
, offset
, vbuf
);
537 printf("Test failed\n");
543 #endif /* CONFIG_CMD_SF_TEST */
545 static int do_spi_flash(cmd_tbl_t
*cmdtp
, int flag
, int argc
,
551 /* need at least two arguments */
559 if (strcmp(cmd
, "probe") == 0) {
560 ret
= do_spi_flash_probe(argc
, argv
);
564 /* The remaining commands require a selected device */
566 puts("No SPI flash selected. Please run `sf probe'\n");
570 if (strcmp(cmd
, "read") == 0 || strcmp(cmd
, "write") == 0 ||
571 strcmp(cmd
, "update") == 0)
572 ret
= do_spi_flash_read_write(argc
, argv
);
573 else if (strcmp(cmd
, "erase") == 0)
574 ret
= do_spi_flash_erase(argc
, argv
);
575 else if (strcmp(cmd
, "protect") == 0)
576 ret
= do_spi_protect(argc
, argv
);
577 #ifdef CONFIG_CMD_SF_TEST
578 else if (!strcmp(cmd
, "test"))
579 ret
= do_spi_flash_test(argc
, argv
);
589 return CMD_RET_USAGE
;
592 #ifdef CONFIG_CMD_SF_TEST
593 #define SF_TEST_HELP "\nsf test offset len " \
594 "- run a very basic destructive test"
600 sf
, 5, 1, do_spi_flash
,
601 "SPI flash sub-system",
602 "probe [[bus:]cs] [hz] [mode] - init flash device on given SPI bus\n"
604 "sf read addr offset|partition len - read `len' bytes starting at\n"
605 " `offset' or from start of mtd\n"
606 " `partition'to memory at `addr'\n"
607 "sf write addr offset|partition len - write `len' bytes from memory\n"
608 " at `addr' to flash at `offset'\n"
609 " or to start of mtd `partition'\n"
610 "sf erase offset|partition [+]len - erase `len' bytes from `offset'\n"
611 " or from start of mtd `partition'\n"
612 " `+len' round up `len' to block size\n"
613 "sf update addr offset|partition len - erase and write `len' bytes from memory\n"
614 " at `addr' to flash at `offset'\n"
615 " or to start of mtd `partition'\n"
616 "sf protect lock/unlock sector len - protect/unprotect 'len' bytes starting\n"
617 " at address 'sector'\n"