2 * Command for accessing SPI flash.
4 * Copyright (C) 2008 Atmel Corporation
6 * SPDX-License-Identifier: GPL-2.0+
13 #include <spi_flash.h>
17 static struct spi_flash *flash;
21 * This function computes the length argument for the erase command.
22 * The length on which the command is to operate can be given in two forms:
23 * 1. <cmd> offset len - operate on <'offset', 'len')
24 * 2. <cmd> offset +len - operate on <'offset', 'round_up(len)')
25 * If the second form is used and the length doesn't fall on the
26 * sector boundary, than it will be adjusted to the next sector boundary.
27 * If it isn't in the flash, the function will fail (return -1).
29 * arg: length specification (i.e. both command arguments)
31 * len: computed length for operation
34 * -1: failure (bad format, bad address).
36 static int sf_parse_len_arg(char *arg, ulong *len)
39 char round_up_len; /* indicates if the "+length" form used */
48 len_arg = simple_strtoul(arg, &ep, 16);
49 if (ep == arg || *ep != '\0')
52 if (round_up_len && flash->sector_size > 0)
53 *len = ROUND(len_arg, flash->sector_size);
61 * This function takes a byte length and a delta unit of time to compute the
62 * approximate bytes per second
64 * @param len amount of bytes currently processed
65 * @param start_ms start time of processing in ms
66 * @return bytes per second if OK, 0 on error
68 static ulong bytes_per_second(unsigned int len, ulong start_ms)
70 /* less accurate but avoids overflow */
71 if (len >= ((unsigned int) -1) / 1024)
72 return len / (max(get_timer(start_ms) / 1024, 1));
74 return 1024 * len / max(get_timer(start_ms), 1);
77 static int do_spi_flash_probe(int argc, char * const argv[])
79 unsigned int bus = CONFIG_SF_DEFAULT_BUS;
80 unsigned int cs = CONFIG_SF_DEFAULT_CS;
81 unsigned int speed = CONFIG_SF_DEFAULT_SPEED;
82 unsigned int mode = CONFIG_SF_DEFAULT_MODE;
84 struct spi_flash *new;
87 cs = simple_strtoul(argv[1], &endp, 0);
88 if (*argv[1] == 0 || (*endp != 0 && *endp != ':'))
95 cs = simple_strtoul(endp + 1, &endp, 0);
102 speed = simple_strtoul(argv[2], &endp, 0);
103 if (*argv[2] == 0 || *endp != 0)
107 mode = simple_strtoul(argv[3], &endp, 16);
108 if (*argv[3] == 0 || *endp != 0)
112 new = spi_flash_probe(bus, cs, speed, mode);
114 printf("Failed to initialize SPI flash at %u:%u\n", bus, cs);
119 spi_flash_free(flash);
126 * Write a block of data to SPI flash, first checking if it is different from
127 * what is already there.
129 * If the data being written is the same, then *skipped is incremented by len.
131 * @param flash flash context pointer
132 * @param offset flash offset to write
133 * @param len number of bytes to write
134 * @param buf buffer to write from
135 * @param cmp_buf read buffer to use to compare data
136 * @param skipped Count of skipped data (incremented by this function)
137 * @return NULL if OK, else a string containing the stage which failed
139 static const char *spi_flash_update_block(struct spi_flash *flash, u32 offset,
140 size_t len, const char *buf, char *cmp_buf, size_t *skipped)
142 debug("offset=%#x, sector_size=%#x, len=%#zx\n",
143 offset, flash->sector_size, len);
144 /* Read the entire sector so to allow for rewriting */
145 if (spi_flash_read(flash, offset, flash->sector_size, cmp_buf))
147 /* Compare only what is meaningful (len) */
148 if (memcmp(cmp_buf, buf, len) == 0) {
149 debug("Skip region %x size %zx: no change\n",
154 /* Erase the entire sector */
155 if (spi_flash_erase(flash, offset, flash->sector_size))
157 /* Write the initial part of the block from the source */
158 if (spi_flash_write(flash, offset, len, buf))
160 /* If it's a partial sector, rewrite the existing part */
161 if (len != flash->sector_size) {
162 /* Rewrite the original data to the end of the sector */
163 if (spi_flash_write(flash, offset + len,
164 flash->sector_size - len, &cmp_buf[len]))
172 * Update an area of SPI flash by erasing and writing any blocks which need
173 * to change. Existing blocks with the correct data are left unchanged.
175 * @param flash flash context pointer
176 * @param offset flash offset to write
177 * @param len number of bytes to write
178 * @param buf buffer to write from
179 * @return 0 if ok, 1 on error
181 static int spi_flash_update(struct spi_flash *flash, u32 offset,
182 size_t len, const char *buf)
184 const char *err_oper = NULL;
186 const char *end = buf + len;
187 size_t todo; /* number of bytes to do in this pass */
188 size_t skipped = 0; /* statistics */
189 const ulong start_time = get_timer(0);
191 const char *start_buf = buf;
194 if (end - buf >= 200)
195 scale = (end - buf) / 100;
196 cmp_buf = malloc(flash->sector_size);
198 ulong last_update = get_timer(0);
200 for (; buf < end && !err_oper; buf += todo, offset += todo) {
201 todo = min(end - buf, flash->sector_size);
202 if (get_timer(last_update) > 100) {
203 printf(" \rUpdating, %zu%% %lu B/s",
204 100 - (end - buf) / scale,
205 bytes_per_second(buf - start_buf,
207 last_update = get_timer(0);
209 err_oper = spi_flash_update_block(flash, offset, todo,
210 buf, cmp_buf, &skipped);
218 printf("SPI flash failed in %s step\n", err_oper);
222 delta = get_timer(start_time);
223 printf("%zu bytes written, %zu bytes skipped", len - skipped,
225 printf(" in %ld.%lds, speed %ld B/s\n",
226 delta / 1000, delta % 1000, bytes_per_second(len, start_time));
231 static int do_spi_flash_read_write(int argc, char * const argv[])
234 unsigned long offset;
243 addr = simple_strtoul(argv[1], &endp, 16);
244 if (*argv[1] == 0 || *endp != 0)
246 offset = simple_strtoul(argv[2], &endp, 16);
247 if (*argv[2] == 0 || *endp != 0)
249 len = simple_strtoul(argv[3], &endp, 16);
250 if (*argv[3] == 0 || *endp != 0)
253 /* Consistency checking */
254 if (offset + len > flash->size) {
255 printf("ERROR: attempting %s past flash size (%#x)\n",
256 argv[0], flash->size);
260 buf = map_physmem(addr, len, MAP_WRBACK);
262 puts("Failed to map physical memory\n");
266 if (strcmp(argv[0], "update") == 0) {
267 ret = spi_flash_update(flash, offset, len, buf);
268 } else if (strncmp(argv[0], "read", 4) == 0 ||
269 strncmp(argv[0], "write", 5) == 0) {
272 read = strncmp(argv[0], "read", 4) == 0;
274 ret = spi_flash_read(flash, offset, len, buf);
276 ret = spi_flash_write(flash, offset, len, buf);
278 printf("SF: %zu bytes @ %#x %s: %s\n", (size_t)len, (u32)offset,
279 read ? "Read" : "Written", ret ? "ERROR" : "OK");
282 unmap_physmem(buf, len);
284 return ret == 0 ? 0 : 1;
287 static int do_spi_flash_erase(int argc, char * const argv[])
289 unsigned long offset;
297 offset = simple_strtoul(argv[1], &endp, 16);
298 if (*argv[1] == 0 || *endp != 0)
301 ret = sf_parse_len_arg(argv[2], &len);
305 /* Consistency checking */
306 if (offset + len > flash->size) {
307 printf("ERROR: attempting %s past flash size (%#x)\n",
308 argv[0], flash->size);
312 ret = spi_flash_erase(flash, offset, len);
313 printf("SF: %zu bytes @ %#x Erased: %s\n", (size_t)len, (u32)offset,
314 ret ? "ERROR" : "OK");
316 return ret == 0 ? 0 : 1;
319 #ifdef CONFIG_CMD_SF_TEST
329 static char *stage_name[STAGE_COUNT] = {
340 unsigned time_ms[STAGE_COUNT];
343 static void show_time(struct test_info *test, int stage)
345 uint64_t speed; /* KiB/s */
346 int bps; /* Bits per second */
348 speed = (long long)test->bytes * 1000;
349 if (test->time_ms[stage])
350 do_div(speed, test->time_ms[stage] * 1024);
353 printf("%d %s: %d ticks, %d KiB/s %d.%03d Mbps\n", stage,
354 stage_name[stage], test->time_ms[stage],
355 (int)speed, bps / 1000, bps % 1000);
358 static void spi_test_next_stage(struct test_info *test)
360 test->time_ms[test->stage] = get_timer(test->base_ms);
361 show_time(test, test->stage);
362 test->base_ms = get_timer(0);
367 * Run a test on the SPI flash
369 * @param flash SPI flash to use
370 * @param buf Source buffer for data to write
371 * @param len Size of data to read/write
372 * @param offset Offset within flash to check
373 * @param vbuf Verification buffer
374 * @return 0 if ok, -1 on error
376 static int spi_flash_test(struct spi_flash *flash, uint8_t *buf, ulong len,
377 ulong offset, uint8_t *vbuf)
379 struct test_info test;
382 printf("SPI flash test:\n");
383 memset(&test, '\0', sizeof(test));
384 test.base_ms = get_timer(0);
386 if (spi_flash_erase(flash, offset, len)) {
387 printf("Erase failed\n");
390 spi_test_next_stage(&test);
392 if (spi_flash_read(flash, offset, len, vbuf)) {
393 printf("Check read failed\n");
396 for (i = 0; i < len; i++) {
397 if (vbuf[i] != 0xff) {
398 printf("Check failed at %d\n", i);
399 print_buffer(i, vbuf + i, 1, min(len - i, 0x40), 0);
403 spi_test_next_stage(&test);
405 if (spi_flash_write(flash, offset, len, buf)) {
406 printf("Write failed\n");
409 memset(vbuf, '\0', len);
410 spi_test_next_stage(&test);
412 if (spi_flash_read(flash, offset, len, vbuf)) {
413 printf("Read failed\n");
416 spi_test_next_stage(&test);
418 for (i = 0; i < len; i++) {
419 if (buf[i] != vbuf[i]) {
420 printf("Verify failed at %d, good data:\n", i);
421 print_buffer(i, buf + i, 1, min(len - i, 0x40), 0);
422 printf("Bad data:\n");
423 print_buffer(i, vbuf + i, 1, min(len - i, 0x40), 0);
427 printf("Test passed\n");
428 for (i = 0; i < STAGE_COUNT; i++)
434 static int do_spi_flash_test(int argc, char * const argv[])
436 unsigned long offset;
445 offset = simple_strtoul(argv[1], &endp, 16);
446 if (*argv[1] == 0 || *endp != 0)
448 len = simple_strtoul(argv[2], &endp, 16);
449 if (*argv[2] == 0 || *endp != 0)
454 printf("Cannot allocate memory (%lu bytes)\n", len);
460 printf("Cannot allocate memory (%lu bytes)\n", len);
464 from = map_sysmem(CONFIG_SYS_TEXT_BASE, 0);
465 memcpy(buf, from, len);
466 ret = spi_flash_test(flash, buf, len, offset, vbuf);
470 printf("Test failed\n");
476 #endif /* CONFIG_CMD_SF_TEST */
478 static int do_spi_flash(cmd_tbl_t *cmdtp, int flag, int argc,
484 /* need at least two arguments */
492 if (strcmp(cmd, "probe") == 0) {
493 ret = do_spi_flash_probe(argc, argv);
497 /* The remaining commands require a selected device */
499 puts("No SPI flash selected. Please run `sf probe'\n");
503 if (strcmp(cmd, "read") == 0 || strcmp(cmd, "write") == 0 ||
504 strcmp(cmd, "update") == 0)
505 ret = do_spi_flash_read_write(argc, argv);
506 else if (strcmp(cmd, "erase") == 0)
507 ret = do_spi_flash_erase(argc, argv);
508 #ifdef CONFIG_CMD_SF_TEST
509 else if (!strcmp(cmd, "test"))
510 ret = do_spi_flash_test(argc, argv);
520 return CMD_RET_USAGE;
523 #ifdef CONFIG_CMD_SF_TEST
524 #define SF_TEST_HELP "\nsf test offset len " \
525 "- run a very basic destructive test"
531 sf, 5, 1, do_spi_flash,
532 "SPI flash sub-system",
533 "probe [[bus:]cs] [hz] [mode] - init flash device on given SPI bus\n"
535 "sf read addr offset len - read `len' bytes starting at\n"
536 " `offset' to memory at `addr'\n"
537 "sf write addr offset len - write `len' bytes from memory\n"
538 " at `addr' to flash at `offset'\n"
539 "sf erase offset [+]len - erase `len' bytes from `offset'\n"
540 " `+len' round up `len' to block size\n"
541 "sf update addr offset len - erase and write `len' bytes from memory\n"
542 " at `addr' to flash at `offset'"