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);
149 * Write a block of data to SPI flash, first checking if it is different from
150 * what is already there.
152 * If the data being written is the same, then *skipped is incremented by len.
154 * @param flash flash context pointer
155 * @param offset flash offset to write
156 * @param len number of bytes to write
157 * @param buf buffer to write from
158 * @param cmp_buf read buffer to use to compare data
159 * @param skipped Count of skipped data (incremented by this function)
160 * @return NULL if OK, else a string containing the stage which failed
162 static const char *spi_flash_update_block(struct spi_flash *flash, u32 offset,
163 size_t len, const char *buf, char *cmp_buf, size_t *skipped)
165 char *ptr = (char *)buf;
167 debug("offset=%#x, sector_size=%#x, len=%#zx\n",
168 offset, flash->sector_size, len);
169 /* Read the entire sector so to allow for rewriting */
170 if (spi_flash_read(flash, offset, flash->sector_size, cmp_buf))
172 /* Compare only what is meaningful (len) */
173 if (memcmp(cmp_buf, buf, len) == 0) {
174 debug("Skip region %x size %zx: no change\n",
179 /* Erase the entire sector */
180 if (spi_flash_erase(flash, offset, flash->sector_size))
182 /* If it's a partial sector, copy the data into the temp-buffer */
183 if (len != flash->sector_size) {
184 memcpy(cmp_buf, buf, len);
187 /* Write one complete sector */
188 if (spi_flash_write(flash, offset, flash->sector_size, ptr))
195 * Update an area of SPI flash by erasing and writing any blocks which need
196 * to change. Existing blocks with the correct data are left unchanged.
198 * @param flash flash context pointer
199 * @param offset flash offset to write
200 * @param len number of bytes to write
201 * @param buf buffer to write from
202 * @return 0 if ok, 1 on error
204 static int spi_flash_update(struct spi_flash *flash, u32 offset,
205 size_t len, const char *buf)
207 const char *err_oper = NULL;
209 const char *end = buf + len;
210 size_t todo; /* number of bytes to do in this pass */
211 size_t skipped = 0; /* statistics */
212 const ulong start_time = get_timer(0);
214 const char *start_buf = buf;
217 if (end - buf >= 200)
218 scale = (end - buf) / 100;
219 cmp_buf = malloc(flash->sector_size);
221 ulong last_update = get_timer(0);
223 for (; buf < end && !err_oper; buf += todo, offset += todo) {
224 todo = min_t(size_t, end - buf, flash->sector_size);
225 if (get_timer(last_update) > 100) {
226 printf(" \rUpdating, %zu%% %lu B/s",
227 100 - (end - buf) / scale,
228 bytes_per_second(buf - start_buf,
230 last_update = get_timer(0);
232 err_oper = spi_flash_update_block(flash, offset, todo,
233 buf, cmp_buf, &skipped);
241 printf("SPI flash failed in %s step\n", err_oper);
245 delta = get_timer(start_time);
246 printf("%zu bytes written, %zu bytes skipped", len - skipped,
248 printf(" in %ld.%lds, speed %ld B/s\n",
249 delta / 1000, delta % 1000, bytes_per_second(len, start_time));
254 static int do_spi_flash_read_write(int argc, char * const argv[])
257 unsigned long offset;
266 addr = simple_strtoul(argv[1], &endp, 16);
267 if (*argv[1] == 0 || *endp != 0)
269 offset = simple_strtoul(argv[2], &endp, 16);
270 if (*argv[2] == 0 || *endp != 0)
272 len = simple_strtoul(argv[3], &endp, 16);
273 if (*argv[3] == 0 || *endp != 0)
276 /* Consistency checking */
277 if (offset + len > flash->size) {
278 printf("ERROR: attempting %s past flash size (%#x)\n",
279 argv[0], flash->size);
283 buf = map_physmem(addr, len, MAP_WRBACK);
285 puts("Failed to map physical memory\n");
289 if (strcmp(argv[0], "update") == 0) {
290 ret = spi_flash_update(flash, offset, len, buf);
291 } else if (strncmp(argv[0], "read", 4) == 0 ||
292 strncmp(argv[0], "write", 5) == 0) {
295 read = strncmp(argv[0], "read", 4) == 0;
297 ret = spi_flash_read(flash, offset, len, buf);
299 ret = spi_flash_write(flash, offset, len, buf);
301 printf("SF: %zu bytes @ %#x %s: %s\n", (size_t)len, (u32)offset,
302 read ? "Read" : "Written", ret ? "ERROR" : "OK");
305 unmap_physmem(buf, len);
307 return ret == 0 ? 0 : 1;
310 static int do_spi_flash_erase(int argc, char * const argv[])
312 unsigned long offset;
320 offset = simple_strtoul(argv[1], &endp, 16);
321 if (*argv[1] == 0 || *endp != 0)
324 ret = sf_parse_len_arg(argv[2], &len);
328 /* Consistency checking */
329 if (offset + len > flash->size) {
330 printf("ERROR: attempting %s past flash size (%#x)\n",
331 argv[0], flash->size);
335 ret = spi_flash_erase(flash, offset, len);
336 printf("SF: %zu bytes @ %#x Erased: %s\n", (size_t)len, (u32)offset,
337 ret ? "ERROR" : "OK");
339 return ret == 0 ? 0 : 1;
342 #ifdef CONFIG_CMD_SF_TEST
352 static char *stage_name[STAGE_COUNT] = {
363 unsigned time_ms[STAGE_COUNT];
366 static void show_time(struct test_info *test, int stage)
368 uint64_t speed; /* KiB/s */
369 int bps; /* Bits per second */
371 speed = (long long)test->bytes * 1000;
372 if (test->time_ms[stage])
373 do_div(speed, test->time_ms[stage] * 1024);
376 printf("%d %s: %d ticks, %d KiB/s %d.%03d Mbps\n", stage,
377 stage_name[stage], test->time_ms[stage],
378 (int)speed, bps / 1000, bps % 1000);
381 static void spi_test_next_stage(struct test_info *test)
383 test->time_ms[test->stage] = get_timer(test->base_ms);
384 show_time(test, test->stage);
385 test->base_ms = get_timer(0);
390 * Run a test on the SPI flash
392 * @param flash SPI flash to use
393 * @param buf Source buffer for data to write
394 * @param len Size of data to read/write
395 * @param offset Offset within flash to check
396 * @param vbuf Verification buffer
397 * @return 0 if ok, -1 on error
399 static int spi_flash_test(struct spi_flash *flash, uint8_t *buf, ulong len,
400 ulong offset, uint8_t *vbuf)
402 struct test_info test;
405 printf("SPI flash test:\n");
406 memset(&test, '\0', sizeof(test));
407 test.base_ms = get_timer(0);
409 if (spi_flash_erase(flash, offset, len)) {
410 printf("Erase failed\n");
413 spi_test_next_stage(&test);
415 if (spi_flash_read(flash, offset, len, vbuf)) {
416 printf("Check read failed\n");
419 for (i = 0; i < len; i++) {
420 if (vbuf[i] != 0xff) {
421 printf("Check failed at %d\n", i);
422 print_buffer(i, vbuf + i, 1,
423 min_t(uint, len - i, 0x40), 0);
427 spi_test_next_stage(&test);
429 if (spi_flash_write(flash, offset, len, buf)) {
430 printf("Write failed\n");
433 memset(vbuf, '\0', len);
434 spi_test_next_stage(&test);
436 if (spi_flash_read(flash, offset, len, vbuf)) {
437 printf("Read failed\n");
440 spi_test_next_stage(&test);
442 for (i = 0; i < len; i++) {
443 if (buf[i] != vbuf[i]) {
444 printf("Verify failed at %d, good data:\n", i);
445 print_buffer(i, buf + i, 1,
446 min_t(uint, len - i, 0x40), 0);
447 printf("Bad data:\n");
448 print_buffer(i, vbuf + i, 1,
449 min_t(uint, len - i, 0x40), 0);
453 printf("Test passed\n");
454 for (i = 0; i < STAGE_COUNT; i++)
460 static int do_spi_flash_test(int argc, char * const argv[])
462 unsigned long offset;
471 offset = simple_strtoul(argv[1], &endp, 16);
472 if (*argv[1] == 0 || *endp != 0)
474 len = simple_strtoul(argv[2], &endp, 16);
475 if (*argv[2] == 0 || *endp != 0)
480 printf("Cannot allocate memory (%lu bytes)\n", len);
486 printf("Cannot allocate memory (%lu bytes)\n", len);
490 from = map_sysmem(CONFIG_SYS_TEXT_BASE, 0);
491 memcpy(buf, from, len);
492 ret = spi_flash_test(flash, buf, len, offset, vbuf);
496 printf("Test failed\n");
502 #endif /* CONFIG_CMD_SF_TEST */
504 static int do_spi_flash(cmd_tbl_t *cmdtp, int flag, int argc,
510 /* need at least two arguments */
518 if (strcmp(cmd, "probe") == 0) {
519 ret = do_spi_flash_probe(argc, argv);
523 /* The remaining commands require a selected device */
525 puts("No SPI flash selected. Please run `sf probe'\n");
529 if (strcmp(cmd, "read") == 0 || strcmp(cmd, "write") == 0 ||
530 strcmp(cmd, "update") == 0)
531 ret = do_spi_flash_read_write(argc, argv);
532 else if (strcmp(cmd, "erase") == 0)
533 ret = do_spi_flash_erase(argc, argv);
534 #ifdef CONFIG_CMD_SF_TEST
535 else if (!strcmp(cmd, "test"))
536 ret = do_spi_flash_test(argc, argv);
546 return CMD_RET_USAGE;
549 #ifdef CONFIG_CMD_SF_TEST
550 #define SF_TEST_HELP "\nsf test offset len " \
551 "- run a very basic destructive test"
557 sf, 5, 1, do_spi_flash,
558 "SPI flash sub-system",
559 "probe [[bus:]cs] [hz] [mode] - init flash device on given SPI bus\n"
561 "sf read addr offset len - read `len' bytes starting at\n"
562 " `offset' to memory at `addr'\n"
563 "sf write addr offset len - write `len' bytes from memory\n"
564 " at `addr' to flash at `offset'\n"
565 "sf erase offset [+]len - erase `len' bytes from `offset'\n"
566 " `+len' round up `len' to block size\n"
567 "sf update addr offset len - erase and write `len' bytes from memory\n"
568 " at `addr' to flash at `offset'"