]>
git.ipfire.org Git - people/ms/u-boot.git/blob - common/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>
18 #include <dm/device-internal.h>
20 static struct spi_flash
*flash
;
23 * This function computes the length argument for the erase command.
24 * The length on which the command is to operate can be given in two forms:
25 * 1. <cmd> offset len - operate on <'offset', 'len')
26 * 2. <cmd> offset +len - operate on <'offset', 'round_up(len)')
27 * If the second form is used and the length doesn't fall on the
28 * sector boundary, than it will be adjusted to the next sector boundary.
29 * If it isn't in the flash, the function will fail (return -1).
31 * arg: length specification (i.e. both command arguments)
33 * len: computed length for operation
36 * -1: failure (bad format, bad address).
38 static int sf_parse_len_arg(char *arg
, ulong
*len
)
41 char round_up_len
; /* indicates if the "+length" form used */
50 len_arg
= simple_strtoul(arg
, &ep
, 16);
51 if (ep
== arg
|| *ep
!= '\0')
54 if (round_up_len
&& flash
->sector_size
> 0)
55 *len
= ROUND(len_arg
, flash
->sector_size
);
63 * This function takes a byte length and a delta unit of time to compute the
64 * approximate bytes per second
66 * @param len amount of bytes currently processed
67 * @param start_ms start time of processing in ms
68 * @return bytes per second if OK, 0 on error
70 static ulong
bytes_per_second(unsigned int len
, ulong start_ms
)
72 /* less accurate but avoids overflow */
73 if (len
>= ((unsigned int) -1) / 1024)
74 return len
/ (max(get_timer(start_ms
) / 1024, 1UL));
76 return 1024 * len
/ max(get_timer(start_ms
), 1UL);
79 static int do_spi_flash_probe(int argc
, char * const argv
[])
81 unsigned int bus
= CONFIG_SF_DEFAULT_BUS
;
82 unsigned int cs
= CONFIG_SF_DEFAULT_CS
;
83 unsigned int speed
= CONFIG_SF_DEFAULT_SPEED
;
84 unsigned int mode
= CONFIG_SF_DEFAULT_MODE
;
86 #ifdef CONFIG_DM_SPI_FLASH
87 struct udevice
*new, *bus_dev
;
90 struct spi_flash
*new;
94 cs
= simple_strtoul(argv
[1], &endp
, 0);
95 if (*argv
[1] == 0 || (*endp
!= 0 && *endp
!= ':'))
102 cs
= simple_strtoul(endp
+ 1, &endp
, 0);
109 speed
= simple_strtoul(argv
[2], &endp
, 0);
110 if (*argv
[2] == 0 || *endp
!= 0)
114 mode
= simple_strtoul(argv
[3], &endp
, 16);
115 if (*argv
[3] == 0 || *endp
!= 0)
119 #ifdef CONFIG_DM_SPI_FLASH
120 /* Remove the old device, otherwise probe will just be a nop */
121 ret
= spi_find_bus_and_cs(bus
, cs
, &bus_dev
, &new);
127 ret
= spi_flash_probe_bus_cs(bus
, cs
, speed
, mode
, &new);
129 printf("Failed to initialize SPI flash at %u:%u (error %d)\n",
134 flash
= dev_get_uclass_priv(new);
136 new = spi_flash_probe(bus
, cs
, speed
, mode
);
138 printf("Failed to initialize SPI flash at %u:%u\n", bus
, cs
);
143 spi_flash_free(flash
);
151 * Write a block of data to SPI flash, first checking if it is different from
152 * what is already there.
154 * If the data being written is the same, then *skipped is incremented by len.
156 * @param flash flash context pointer
157 * @param offset flash offset to write
158 * @param len number of bytes to write
159 * @param buf buffer to write from
160 * @param cmp_buf read buffer to use to compare data
161 * @param skipped Count of skipped data (incremented by this function)
162 * @return NULL if OK, else a string containing the stage which failed
164 static const char *spi_flash_update_block(struct spi_flash
*flash
, u32 offset
,
165 size_t len
, const char *buf
, char *cmp_buf
, size_t *skipped
)
167 char *ptr
= (char *)buf
;
169 debug("offset=%#x, sector_size=%#x, len=%#zx\n",
170 offset
, flash
->sector_size
, len
);
171 /* Read the entire sector so to allow for rewriting */
172 if (spi_flash_read(flash
, offset
, flash
->sector_size
, cmp_buf
))
174 /* Compare only what is meaningful (len) */
175 if (memcmp(cmp_buf
, buf
, len
) == 0) {
176 debug("Skip region %x size %zx: no change\n",
181 /* Erase the entire sector */
182 if (spi_flash_erase(flash
, offset
, flash
->sector_size
))
184 /* If it's a partial sector, copy the data into the temp-buffer */
185 if (len
!= flash
->sector_size
) {
186 memcpy(cmp_buf
, buf
, len
);
189 /* Write one complete sector */
190 if (spi_flash_write(flash
, offset
, flash
->sector_size
, ptr
))
197 * Update an area of SPI flash by erasing and writing any blocks which need
198 * to change. Existing blocks with the correct data are left unchanged.
200 * @param flash flash context pointer
201 * @param offset flash offset to write
202 * @param len number of bytes to write
203 * @param buf buffer to write from
204 * @return 0 if ok, 1 on error
206 static int spi_flash_update(struct spi_flash
*flash
, u32 offset
,
207 size_t len
, const char *buf
)
209 const char *err_oper
= NULL
;
211 const char *end
= buf
+ len
;
212 size_t todo
; /* number of bytes to do in this pass */
213 size_t skipped
= 0; /* statistics */
214 const ulong start_time
= get_timer(0);
216 const char *start_buf
= buf
;
219 if (end
- buf
>= 200)
220 scale
= (end
- buf
) / 100;
221 cmp_buf
= malloc(flash
->sector_size
);
223 ulong last_update
= get_timer(0);
225 for (; buf
< end
&& !err_oper
; buf
+= todo
, offset
+= todo
) {
226 todo
= min_t(size_t, end
- buf
, flash
->sector_size
);
227 if (get_timer(last_update
) > 100) {
228 printf(" \rUpdating, %zu%% %lu B/s",
229 100 - (end
- buf
) / scale
,
230 bytes_per_second(buf
- start_buf
,
232 last_update
= get_timer(0);
234 err_oper
= spi_flash_update_block(flash
, offset
, todo
,
235 buf
, cmp_buf
, &skipped
);
243 printf("SPI flash failed in %s step\n", err_oper
);
247 delta
= get_timer(start_time
);
248 printf("%zu bytes written, %zu bytes skipped", len
- skipped
,
250 printf(" in %ld.%lds, speed %ld B/s\n",
251 delta
/ 1000, delta
% 1000, bytes_per_second(len
, start_time
));
256 static int do_spi_flash_read_write(int argc
, char * const argv
[])
259 unsigned long offset
;
268 addr
= simple_strtoul(argv
[1], &endp
, 16);
269 if (*argv
[1] == 0 || *endp
!= 0)
271 offset
= simple_strtoul(argv
[2], &endp
, 16);
272 if (*argv
[2] == 0 || *endp
!= 0)
274 len
= simple_strtoul(argv
[3], &endp
, 16);
275 if (*argv
[3] == 0 || *endp
!= 0)
278 /* Consistency checking */
279 if (offset
+ len
> flash
->size
) {
280 printf("ERROR: attempting %s past flash size (%#x)\n",
281 argv
[0], flash
->size
);
285 buf
= map_physmem(addr
, len
, MAP_WRBACK
);
287 puts("Failed to map physical memory\n");
291 if (strcmp(argv
[0], "update") == 0) {
292 ret
= spi_flash_update(flash
, offset
, len
, buf
);
293 } else if (strncmp(argv
[0], "read", 4) == 0 ||
294 strncmp(argv
[0], "write", 5) == 0) {
297 read
= strncmp(argv
[0], "read", 4) == 0;
299 ret
= spi_flash_read(flash
, offset
, len
, buf
);
301 ret
= spi_flash_write(flash
, offset
, len
, buf
);
303 printf("SF: %zu bytes @ %#x %s: %s\n", (size_t)len
, (u32
)offset
,
304 read
? "Read" : "Written", ret
? "ERROR" : "OK");
307 unmap_physmem(buf
, len
);
309 return ret
== 0 ? 0 : 1;
312 static int do_spi_flash_erase(int argc
, char * const argv
[])
314 unsigned long offset
;
322 offset
= simple_strtoul(argv
[1], &endp
, 16);
323 if (*argv
[1] == 0 || *endp
!= 0)
326 ret
= sf_parse_len_arg(argv
[2], &len
);
330 /* Consistency checking */
331 if (offset
+ len
> flash
->size
) {
332 printf("ERROR: attempting %s past flash size (%#x)\n",
333 argv
[0], flash
->size
);
337 ret
= spi_flash_erase(flash
, offset
, len
);
338 printf("SF: %zu bytes @ %#x Erased: %s\n", (size_t)len
, (u32
)offset
,
339 ret
? "ERROR" : "OK");
341 return ret
== 0 ? 0 : 1;
344 #ifdef CONFIG_CMD_SF_TEST
354 static char *stage_name
[STAGE_COUNT
] = {
365 unsigned time_ms
[STAGE_COUNT
];
368 static void show_time(struct test_info
*test
, int stage
)
370 uint64_t speed
; /* KiB/s */
371 int bps
; /* Bits per second */
373 speed
= (long long)test
->bytes
* 1000;
374 if (test
->time_ms
[stage
])
375 do_div(speed
, test
->time_ms
[stage
] * 1024);
378 printf("%d %s: %d ticks, %d KiB/s %d.%03d Mbps\n", stage
,
379 stage_name
[stage
], test
->time_ms
[stage
],
380 (int)speed
, bps
/ 1000, bps
% 1000);
383 static void spi_test_next_stage(struct test_info
*test
)
385 test
->time_ms
[test
->stage
] = get_timer(test
->base_ms
);
386 show_time(test
, test
->stage
);
387 test
->base_ms
= get_timer(0);
392 * Run a test on the SPI flash
394 * @param flash SPI flash to use
395 * @param buf Source buffer for data to write
396 * @param len Size of data to read/write
397 * @param offset Offset within flash to check
398 * @param vbuf Verification buffer
399 * @return 0 if ok, -1 on error
401 static int spi_flash_test(struct spi_flash
*flash
, uint8_t *buf
, ulong len
,
402 ulong offset
, uint8_t *vbuf
)
404 struct test_info test
;
407 printf("SPI flash test:\n");
408 memset(&test
, '\0', sizeof(test
));
409 test
.base_ms
= get_timer(0);
411 if (spi_flash_erase(flash
, offset
, len
)) {
412 printf("Erase failed\n");
415 spi_test_next_stage(&test
);
417 if (spi_flash_read(flash
, offset
, len
, vbuf
)) {
418 printf("Check read failed\n");
421 for (i
= 0; i
< len
; i
++) {
422 if (vbuf
[i
] != 0xff) {
423 printf("Check failed at %d\n", i
);
424 print_buffer(i
, vbuf
+ i
, 1,
425 min_t(uint
, len
- i
, 0x40), 0);
429 spi_test_next_stage(&test
);
431 if (spi_flash_write(flash
, offset
, len
, buf
)) {
432 printf("Write failed\n");
435 memset(vbuf
, '\0', len
);
436 spi_test_next_stage(&test
);
438 if (spi_flash_read(flash
, offset
, len
, vbuf
)) {
439 printf("Read failed\n");
442 spi_test_next_stage(&test
);
444 for (i
= 0; i
< len
; i
++) {
445 if (buf
[i
] != vbuf
[i
]) {
446 printf("Verify failed at %d, good data:\n", i
);
447 print_buffer(i
, buf
+ i
, 1,
448 min_t(uint
, len
- i
, 0x40), 0);
449 printf("Bad data:\n");
450 print_buffer(i
, vbuf
+ i
, 1,
451 min_t(uint
, len
- i
, 0x40), 0);
455 printf("Test passed\n");
456 for (i
= 0; i
< STAGE_COUNT
; i
++)
462 static int do_spi_flash_test(int argc
, char * const argv
[])
464 unsigned long offset
;
473 offset
= simple_strtoul(argv
[1], &endp
, 16);
474 if (*argv
[1] == 0 || *endp
!= 0)
476 len
= simple_strtoul(argv
[2], &endp
, 16);
477 if (*argv
[2] == 0 || *endp
!= 0)
482 printf("Cannot allocate memory (%lu bytes)\n", len
);
488 printf("Cannot allocate memory (%lu bytes)\n", len
);
492 from
= map_sysmem(CONFIG_SYS_TEXT_BASE
, 0);
493 memcpy(buf
, from
, len
);
494 ret
= spi_flash_test(flash
, buf
, len
, offset
, vbuf
);
498 printf("Test failed\n");
504 #endif /* CONFIG_CMD_SF_TEST */
506 static int do_spi_flash(cmd_tbl_t
*cmdtp
, int flag
, int argc
,
512 /* need at least two arguments */
520 if (strcmp(cmd
, "probe") == 0) {
521 ret
= do_spi_flash_probe(argc
, argv
);
525 /* The remaining commands require a selected device */
527 puts("No SPI flash selected. Please run `sf probe'\n");
531 if (strcmp(cmd
, "read") == 0 || strcmp(cmd
, "write") == 0 ||
532 strcmp(cmd
, "update") == 0)
533 ret
= do_spi_flash_read_write(argc
, argv
);
534 else if (strcmp(cmd
, "erase") == 0)
535 ret
= do_spi_flash_erase(argc
, argv
);
536 #ifdef CONFIG_CMD_SF_TEST
537 else if (!strcmp(cmd
, "test"))
538 ret
= do_spi_flash_test(argc
, argv
);
548 return CMD_RET_USAGE
;
551 #ifdef CONFIG_CMD_SF_TEST
552 #define SF_TEST_HELP "\nsf test offset len " \
553 "- run a very basic destructive test"
559 sf
, 5, 1, do_spi_flash
,
560 "SPI flash sub-system",
561 "probe [[bus:]cs] [hz] [mode] - init flash device on given SPI bus\n"
563 "sf read addr offset len - read `len' bytes starting at\n"
564 " `offset' to memory at `addr'\n"
565 "sf write addr offset len - write `len' bytes from memory\n"
566 " at `addr' to flash at `offset'\n"
567 "sf erase offset [+]len - erase `len' bytes from `offset'\n"
568 " `+len' round up `len' to block size\n"
569 "sf update addr offset len - erase and write `len' bytes from memory\n"
570 " at `addr' to flash at `offset'"