1 // SPDX-License-Identifier: GPL-2.0+
3 * Command for accessing SPI flash.
5 * Copyright (C) 2008 Atmel Corporation
17 #include <spi_flash.h>
18 #include <asm/cache.h>
19 #include <jffs2/jffs2.h>
20 #include <linux/mtd/mtd.h>
23 #include <dm/device-internal.h>
25 #include "legacy-mtd-utils.h"
27 static struct spi_flash *flash;
30 * This function computes the length argument for the erase command.
31 * The length on which the command is to operate can be given in two forms:
32 * 1. <cmd> offset len - operate on <'offset', 'len')
33 * 2. <cmd> offset +len - operate on <'offset', 'round_up(len)')
34 * If the second form is used and the length doesn't fall on the
35 * sector boundary, than it will be adjusted to the next sector boundary.
36 * If it isn't in the flash, the function will fail (return -1).
38 * arg: length specification (i.e. both command arguments)
40 * len: computed length for operation
43 * -1: failure (bad format, bad address).
45 static int sf_parse_len_arg(char *arg, ulong *len)
48 char round_up_len; /* indicates if the "+length" form used */
57 len_arg = simple_strtoul(arg, &ep, 16);
58 if (ep == arg || *ep != '\0')
61 if (round_up_len && flash->sector_size > 0)
62 *len = ROUND(len_arg, flash->sector_size);
70 * This function takes a byte length and a delta unit of time to compute the
71 * approximate bytes per second
73 * @param len amount of bytes currently processed
74 * @param start_ms start time of processing in ms
75 * @return bytes per second if OK, 0 on error
77 static ulong bytes_per_second(unsigned int len, ulong start_ms)
79 /* less accurate but avoids overflow */
80 if (len >= ((unsigned int) -1) / 1024)
81 return len / (max(get_timer(start_ms) / 1024, 1UL));
83 return 1024 * len / max(get_timer(start_ms), 1UL);
86 static int do_spi_flash_probe(int argc, char *const argv[])
88 unsigned int bus = CONFIG_SF_DEFAULT_BUS;
89 unsigned int cs = CONFIG_SF_DEFAULT_CS;
90 /* In DM mode, defaults speed and mode will be taken from DT */
91 unsigned int speed = CONFIG_SF_DEFAULT_SPEED;
92 unsigned int mode = CONFIG_SF_DEFAULT_MODE;
94 #ifdef CONFIG_DM_SPI_FLASH
95 struct udevice *new, *bus_dev;
98 struct spi_flash *new;
102 cs = simple_strtoul(argv[1], &endp, 0);
103 if (*argv[1] == 0 || (*endp != 0 && *endp != ':'))
110 cs = simple_strtoul(endp + 1, &endp, 0);
117 speed = simple_strtoul(argv[2], &endp, 0);
118 if (*argv[2] == 0 || *endp != 0)
122 mode = simple_strtoul(argv[3], &endp, 16);
123 if (*argv[3] == 0 || *endp != 0)
127 #ifdef CONFIG_DM_SPI_FLASH
128 /* Remove the old device, otherwise probe will just be a nop */
129 ret = spi_find_bus_and_cs(bus, cs, &bus_dev, &new);
131 device_remove(new, DM_REMOVE_NORMAL);
134 ret = spi_flash_probe_bus_cs(bus, cs, speed, mode, &new);
136 printf("Failed to initialize SPI flash at %u:%u (error %d)\n",
141 flash = dev_get_uclass_priv(new);
144 spi_flash_free(flash);
146 new = spi_flash_probe(bus, cs, speed, mode);
150 printf("Failed to initialize SPI flash at %u:%u\n", bus, cs);
161 * Write a block of data to SPI flash, first checking if it is different from
162 * what is already there.
164 * If the data being written is the same, then *skipped is incremented by len.
166 * @param flash flash context pointer
167 * @param offset flash offset to write
168 * @param len number of bytes to write
169 * @param buf buffer to write from
170 * @param cmp_buf read buffer to use to compare data
171 * @param skipped Count of skipped data (incremented by this function)
172 * @return NULL if OK, else a string containing the stage which failed
174 static const char *spi_flash_update_block(struct spi_flash *flash, u32 offset,
175 size_t len, const char *buf, char *cmp_buf, size_t *skipped)
177 char *ptr = (char *)buf;
179 debug("offset=%#x, sector_size=%#x, len=%#zx\n",
180 offset, flash->sector_size, len);
181 /* Read the entire sector so to allow for rewriting */
182 if (spi_flash_read(flash, offset, flash->sector_size, cmp_buf))
184 /* Compare only what is meaningful (len) */
185 if (memcmp(cmp_buf, buf, len) == 0) {
186 debug("Skip region %x size %zx: no change\n",
191 /* Erase the entire sector */
192 if (spi_flash_erase(flash, offset, flash->sector_size))
194 /* If it's a partial sector, copy the data into the temp-buffer */
195 if (len != flash->sector_size) {
196 memcpy(cmp_buf, buf, len);
199 /* Write one complete sector */
200 if (spi_flash_write(flash, offset, flash->sector_size, ptr))
207 * Update an area of SPI flash by erasing and writing any blocks which need
208 * to change. Existing blocks with the correct data are left unchanged.
210 * @param flash flash context pointer
211 * @param offset flash offset to write
212 * @param len number of bytes to write
213 * @param buf buffer to write from
214 * @return 0 if ok, 1 on error
216 static int spi_flash_update(struct spi_flash *flash, u32 offset,
217 size_t len, const char *buf)
219 const char *err_oper = NULL;
221 const char *end = buf + len;
222 size_t todo; /* number of bytes to do in this pass */
223 size_t skipped = 0; /* statistics */
224 const ulong start_time = get_timer(0);
226 const char *start_buf = buf;
229 if (end - buf >= 200)
230 scale = (end - buf) / 100;
231 cmp_buf = memalign(ARCH_DMA_MINALIGN, flash->sector_size);
233 ulong last_update = get_timer(0);
235 for (; buf < end && !err_oper; buf += todo, offset += todo) {
236 todo = min_t(size_t, end - buf, flash->sector_size);
237 if (get_timer(last_update) > 100) {
238 printf(" \rUpdating, %zu%% %lu B/s",
239 100 - (end - buf) / scale,
240 bytes_per_second(buf - start_buf,
242 last_update = get_timer(0);
244 err_oper = spi_flash_update_block(flash, offset, todo,
245 buf, cmp_buf, &skipped);
253 printf("SPI flash failed in %s step\n", err_oper);
257 delta = get_timer(start_time);
258 printf("%zu bytes written, %zu bytes skipped", len - skipped,
260 printf(" in %ld.%lds, speed %ld B/s\n",
261 delta / 1000, delta % 1000, bytes_per_second(len, start_time));
266 static int do_spi_flash_read_write(int argc, char *const argv[])
273 loff_t offset, len, maxsize;
278 addr = simple_strtoul(argv[1], &endp, 16);
279 if (*argv[1] == 0 || *endp != 0)
282 if (mtd_arg_off_size(argc - 2, &argv[2], &dev, &offset, &len,
283 &maxsize, MTD_DEV_TYPE_NOR, flash->size))
286 /* Consistency checking */
287 if (offset + len > flash->size) {
288 printf("ERROR: attempting %s past flash size (%#x)\n",
289 argv[0], flash->size);
293 buf = map_physmem(addr, len, MAP_WRBACK);
295 puts("Failed to map physical memory\n");
299 if (strcmp(argv[0], "update") == 0) {
300 ret = spi_flash_update(flash, offset, len, buf);
301 } else if (strncmp(argv[0], "read", 4) == 0 ||
302 strncmp(argv[0], "write", 5) == 0) {
305 read = strncmp(argv[0], "read", 4) == 0;
307 ret = spi_flash_read(flash, offset, len, buf);
309 ret = spi_flash_write(flash, offset, len, buf);
311 printf("SF: %zu bytes @ %#x %s: ", (size_t)len, (u32)offset,
312 read ? "Read" : "Written");
314 printf("ERROR %d\n", ret);
319 unmap_physmem(buf, len);
321 return ret == 0 ? 0 : 1;
324 static int do_spi_flash_erase(int argc, char *const argv[])
328 loff_t offset, len, maxsize;
334 if (mtd_arg_off(argv[1], &dev, &offset, &len, &maxsize,
335 MTD_DEV_TYPE_NOR, flash->size))
338 ret = sf_parse_len_arg(argv[2], &size);
342 /* Consistency checking */
343 if (offset + size > flash->size) {
344 printf("ERROR: attempting %s past flash size (%#x)\n",
345 argv[0], flash->size);
349 ret = spi_flash_erase(flash, offset, size);
350 printf("SF: %zu bytes @ %#x Erased: %s\n", (size_t)size, (u32)offset,
351 ret ? "ERROR" : "OK");
353 return ret == 0 ? 0 : 1;
356 static int do_spi_protect(int argc, char *const argv[])
365 if (!str2off(argv[2], &start)) {
366 puts("start sector is not a valid number\n");
370 if (!str2off(argv[3], &len)) {
371 puts("len is not a valid number\n");
375 if (strcmp(argv[1], "lock") == 0)
377 else if (strcmp(argv[1], "unlock") == 0)
380 return -1; /* Unknown parameter */
382 ret = spi_flash_protect(flash, start, len, prot);
384 return ret == 0 ? 0 : 1;
387 #ifdef CONFIG_CMD_SF_TEST
397 static char *stage_name[STAGE_COUNT] = {
408 unsigned time_ms[STAGE_COUNT];
411 static void show_time(struct test_info *test, int stage)
413 uint64_t speed; /* KiB/s */
414 int bps; /* Bits per second */
416 speed = (long long)test->bytes * 1000;
417 if (test->time_ms[stage])
418 do_div(speed, test->time_ms[stage] * 1024);
421 printf("%d %s: %u ticks, %d KiB/s %d.%03d Mbps\n", stage,
422 stage_name[stage], test->time_ms[stage],
423 (int)speed, bps / 1000, bps % 1000);
426 static void spi_test_next_stage(struct test_info *test)
428 test->time_ms[test->stage] = get_timer(test->base_ms);
429 show_time(test, test->stage);
430 test->base_ms = get_timer(0);
435 * Run a test on the SPI flash
437 * @param flash SPI flash to use
438 * @param buf Source buffer for data to write
439 * @param len Size of data to read/write
440 * @param offset Offset within flash to check
441 * @param vbuf Verification buffer
442 * @return 0 if ok, -1 on error
444 static int spi_flash_test(struct spi_flash *flash, uint8_t *buf, ulong len,
445 ulong offset, uint8_t *vbuf)
447 struct test_info test;
450 printf("SPI flash test:\n");
451 memset(&test, '\0', sizeof(test));
452 test.base_ms = get_timer(0);
454 if (spi_flash_erase(flash, offset, len)) {
455 printf("Erase failed\n");
458 spi_test_next_stage(&test);
460 if (spi_flash_read(flash, offset, len, vbuf)) {
461 printf("Check read failed\n");
464 for (i = 0; i < len; i++) {
465 if (vbuf[i] != 0xff) {
466 printf("Check failed at %d\n", i);
467 print_buffer(i, vbuf + i, 1,
468 min_t(uint, len - i, 0x40), 0);
472 spi_test_next_stage(&test);
474 if (spi_flash_write(flash, offset, len, buf)) {
475 printf("Write failed\n");
478 memset(vbuf, '\0', len);
479 spi_test_next_stage(&test);
481 if (spi_flash_read(flash, offset, len, vbuf)) {
482 printf("Read failed\n");
485 spi_test_next_stage(&test);
487 for (i = 0; i < len; i++) {
488 if (buf[i] != vbuf[i]) {
489 printf("Verify failed at %d, good data:\n", i);
490 print_buffer(i, buf + i, 1,
491 min_t(uint, len - i, 0x40), 0);
492 printf("Bad data:\n");
493 print_buffer(i, vbuf + i, 1,
494 min_t(uint, len - i, 0x40), 0);
498 printf("Test passed\n");
499 for (i = 0; i < STAGE_COUNT; i++)
505 static int do_spi_flash_test(int argc, char *const argv[])
507 unsigned long offset;
516 offset = simple_strtoul(argv[1], &endp, 16);
517 if (*argv[1] == 0 || *endp != 0)
519 len = simple_strtoul(argv[2], &endp, 16);
520 if (*argv[2] == 0 || *endp != 0)
523 vbuf = memalign(ARCH_DMA_MINALIGN, len);
525 printf("Cannot allocate memory (%lu bytes)\n", len);
528 buf = memalign(ARCH_DMA_MINALIGN, len);
531 printf("Cannot allocate memory (%lu bytes)\n", len);
535 from = map_sysmem(CONFIG_SYS_TEXT_BASE, 0);
536 memcpy(buf, from, len);
537 ret = spi_flash_test(flash, buf, len, offset, vbuf);
541 printf("Test failed\n");
547 #endif /* CONFIG_CMD_SF_TEST */
549 static int do_spi_flash(struct cmd_tbl *cmdtp, int flag, int argc,
555 /* need at least two arguments */
563 if (strcmp(cmd, "probe") == 0) {
564 ret = do_spi_flash_probe(argc, argv);
568 /* The remaining commands require a selected device */
570 puts("No SPI flash selected. Please run `sf probe'\n");
574 if (strcmp(cmd, "read") == 0 || strcmp(cmd, "write") == 0 ||
575 strcmp(cmd, "update") == 0)
576 ret = do_spi_flash_read_write(argc, argv);
577 else if (strcmp(cmd, "erase") == 0)
578 ret = do_spi_flash_erase(argc, argv);
579 else if (strcmp(cmd, "protect") == 0)
580 ret = do_spi_protect(argc, argv);
581 #ifdef CONFIG_CMD_SF_TEST
582 else if (!strcmp(cmd, "test"))
583 ret = do_spi_flash_test(argc, argv);
593 return CMD_RET_USAGE;
596 #ifdef CONFIG_CMD_SF_TEST
597 #define SF_TEST_HELP "\nsf test offset len " \
598 "- run a very basic destructive test"
604 sf, 5, 1, do_spi_flash,
605 "SPI flash sub-system",
606 "probe [[bus:]cs] [hz] [mode] - init flash device on given SPI bus\n"
608 "sf read addr offset|partition len - read `len' bytes starting at\n"
609 " `offset' or from start of mtd\n"
610 " `partition'to memory at `addr'\n"
611 "sf write addr offset|partition len - write `len' bytes from memory\n"
612 " at `addr' to flash at `offset'\n"
613 " or to start of mtd `partition'\n"
614 "sf erase offset|partition [+]len - erase `len' bytes from `offset'\n"
615 " or from start of mtd `partition'\n"
616 " `+len' round up `len' to block size\n"
617 "sf update addr offset|partition len - erase and write `len' bytes from memory\n"
618 " at `addr' to flash at `offset'\n"
619 " or to start of mtd `partition'\n"
620 "sf protect lock/unlock sector len - protect/unprotect 'len' bytes starting\n"
621 " at address 'sector'\n"