1 /* 2 * Command for accessing SPI flash. 3 * 4 * Copyright (C) 2008 Atmel Corporation 5 * 6 * SPDX-License-Identifier: GPL-2.0+ 7 */ 8 9 #include <common.h> 10 #include <div64.h> 11 #include <dm.h> 12 #include <malloc.h> 13 #include <mapmem.h> 14 #include <spi.h> 15 #include <spi_flash.h> 16 #include <jffs2/jffs2.h> 17 #include <linux/mtd/mtd.h> 18 19 #include <asm/io.h> 20 #include <dm/device-internal.h> 21 22 static struct spi_flash *flash; 23 24 /* 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). 32 * Input: 33 * arg: length specification (i.e. both command arguments) 34 * Output: 35 * len: computed length for operation 36 * Return: 37 * 1: success 38 * -1: failure (bad format, bad address). 39 */ 40 static int sf_parse_len_arg(char *arg, ulong *len) 41 { 42 char *ep; 43 char round_up_len; /* indicates if the "+length" form used */ 44 ulong len_arg; 45 46 round_up_len = 0; 47 if (*arg == '+') { 48 round_up_len = 1; 49 ++arg; 50 } 51 52 len_arg = simple_strtoul(arg, &ep, 16); 53 if (ep == arg || *ep != '\0') 54 return -1; 55 56 if (round_up_len && flash->sector_size > 0) 57 *len = ROUND(len_arg, flash->sector_size); 58 else 59 *len = len_arg; 60 61 return 1; 62 } 63 64 /** 65 * This function takes a byte length and a delta unit of time to compute the 66 * approximate bytes per second 67 * 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 71 */ 72 static ulong bytes_per_second(unsigned int len, ulong start_ms) 73 { 74 /* less accurate but avoids overflow */ 75 if (len >= ((unsigned int) -1) / 1024) 76 return len / (max(get_timer(start_ms) / 1024, 1UL)); 77 else 78 return 1024 * len / max(get_timer(start_ms), 1UL); 79 } 80 81 static int do_spi_flash_probe(int argc, char * const argv[]) 82 { 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; 87 char *endp; 88 #ifdef CONFIG_DM_SPI_FLASH 89 struct udevice *new, *bus_dev; 90 int ret; 91 /* In DM mode defaults will be taken from DT */ 92 speed = 0, mode = 0; 93 #else 94 struct spi_flash *new; 95 #endif 96 97 if (argc >= 2) { 98 cs = simple_strtoul(argv[1], &endp, 0); 99 if (*argv[1] == 0 || (*endp != 0 && *endp != ':')) 100 return -1; 101 if (*endp == ':') { 102 if (endp[1] == 0) 103 return -1; 104 105 bus = cs; 106 cs = simple_strtoul(endp + 1, &endp, 0); 107 if (*endp != 0) 108 return -1; 109 } 110 } 111 112 if (argc >= 3) { 113 speed = simple_strtoul(argv[2], &endp, 0); 114 if (*argv[2] == 0 || *endp != 0) 115 return -1; 116 } 117 if (argc >= 4) { 118 mode = simple_strtoul(argv[3], &endp, 16); 119 if (*argv[3] == 0 || *endp != 0) 120 return -1; 121 } 122 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); 126 if (!ret) { 127 device_remove(new); 128 device_unbind(new); 129 } 130 flash = NULL; 131 ret = spi_flash_probe_bus_cs(bus, cs, speed, mode, &new); 132 if (ret) { 133 printf("Failed to initialize SPI flash at %u:%u (error %d)\n", 134 bus, cs, ret); 135 return 1; 136 } 137 138 flash = dev_get_uclass_priv(new); 139 #else 140 if (flash) 141 spi_flash_free(flash); 142 143 new = spi_flash_probe(bus, cs, speed, mode); 144 flash = new; 145 146 if (!new) { 147 printf("Failed to initialize SPI flash at %u:%u\n", bus, cs); 148 return 1; 149 } 150 151 flash = new; 152 #endif 153 154 return 0; 155 } 156 157 /** 158 * Write a block of data to SPI flash, first checking if it is different from 159 * what is already there. 160 * 161 * If the data being written is the same, then *skipped is incremented by len. 162 * 163 * @param flash flash context pointer 164 * @param offset flash offset to write 165 * @param len number of bytes to write 166 * @param buf buffer to write from 167 * @param cmp_buf read buffer to use to compare data 168 * @param skipped Count of skipped data (incremented by this function) 169 * @return NULL if OK, else a string containing the stage which failed 170 */ 171 static const char *spi_flash_update_block(struct spi_flash *flash, u32 offset, 172 size_t len, const char *buf, char *cmp_buf, size_t *skipped) 173 { 174 char *ptr = (char *)buf; 175 176 debug("offset=%#x, sector_size=%#x, len=%#zx\n", 177 offset, flash->sector_size, len); 178 /* Read the entire sector so to allow for rewriting */ 179 if (spi_flash_read(flash, offset, flash->sector_size, cmp_buf)) 180 return "read"; 181 /* Compare only what is meaningful (len) */ 182 if (memcmp(cmp_buf, buf, len) == 0) { 183 debug("Skip region %x size %zx: no change\n", 184 offset, len); 185 *skipped += len; 186 return NULL; 187 } 188 /* Erase the entire sector */ 189 if (spi_flash_erase(flash, offset, flash->sector_size)) 190 return "erase"; 191 /* If it's a partial sector, copy the data into the temp-buffer */ 192 if (len != flash->sector_size) { 193 memcpy(cmp_buf, buf, len); 194 ptr = cmp_buf; 195 } 196 /* Write one complete sector */ 197 if (spi_flash_write(flash, offset, flash->sector_size, ptr)) 198 return "write"; 199 200 return NULL; 201 } 202 203 /** 204 * Update an area of SPI flash by erasing and writing any blocks which need 205 * to change. Existing blocks with the correct data are left unchanged. 206 * 207 * @param flash flash context pointer 208 * @param offset flash offset to write 209 * @param len number of bytes to write 210 * @param buf buffer to write from 211 * @return 0 if ok, 1 on error 212 */ 213 static int spi_flash_update(struct spi_flash *flash, u32 offset, 214 size_t len, const char *buf) 215 { 216 const char *err_oper = NULL; 217 char *cmp_buf; 218 const char *end = buf + len; 219 size_t todo; /* number of bytes to do in this pass */ 220 size_t skipped = 0; /* statistics */ 221 const ulong start_time = get_timer(0); 222 size_t scale = 1; 223 const char *start_buf = buf; 224 ulong delta; 225 226 if (end - buf >= 200) 227 scale = (end - buf) / 100; 228 cmp_buf = memalign(ARCH_DMA_MINALIGN, flash->sector_size); 229 if (cmp_buf) { 230 ulong last_update = get_timer(0); 231 232 for (; buf < end && !err_oper; buf += todo, offset += todo) { 233 todo = min_t(size_t, end - buf, flash->sector_size); 234 if (get_timer(last_update) > 100) { 235 printf(" \rUpdating, %zu%% %lu B/s", 236 100 - (end - buf) / scale, 237 bytes_per_second(buf - start_buf, 238 start_time)); 239 last_update = get_timer(0); 240 } 241 err_oper = spi_flash_update_block(flash, offset, todo, 242 buf, cmp_buf, &skipped); 243 } 244 } else { 245 err_oper = "malloc"; 246 } 247 free(cmp_buf); 248 putc('\r'); 249 if (err_oper) { 250 printf("SPI flash failed in %s step\n", err_oper); 251 return 1; 252 } 253 254 delta = get_timer(start_time); 255 printf("%zu bytes written, %zu bytes skipped", len - skipped, 256 skipped); 257 printf(" in %ld.%lds, speed %ld B/s\n", 258 delta / 1000, delta % 1000, bytes_per_second(len, start_time)); 259 260 return 0; 261 } 262 263 static int do_spi_flash_read_write(int argc, char * const argv[]) 264 { 265 unsigned long addr; 266 void *buf; 267 char *endp; 268 int ret = 1; 269 int dev = 0; 270 loff_t offset, len, maxsize; 271 272 if (argc < 3) 273 return -1; 274 275 addr = simple_strtoul(argv[1], &endp, 16); 276 if (*argv[1] == 0 || *endp != 0) 277 return -1; 278 279 if (mtd_arg_off_size(argc - 2, &argv[2], &dev, &offset, &len, 280 &maxsize, MTD_DEV_TYPE_NOR, flash->size)) 281 return -1; 282 283 /* Consistency checking */ 284 if (offset + len > flash->size) { 285 printf("ERROR: attempting %s past flash size (%#x)\n", 286 argv[0], flash->size); 287 return 1; 288 } 289 290 buf = map_physmem(addr, len, MAP_WRBACK); 291 if (!buf) { 292 puts("Failed to map physical memory\n"); 293 return 1; 294 } 295 296 if (strcmp(argv[0], "update") == 0) { 297 ret = spi_flash_update(flash, offset, len, buf); 298 } else if (strncmp(argv[0], "read", 4) == 0 || 299 strncmp(argv[0], "write", 5) == 0) { 300 int read; 301 302 read = strncmp(argv[0], "read", 4) == 0; 303 if (read) 304 ret = spi_flash_read(flash, offset, len, buf); 305 else 306 ret = spi_flash_write(flash, offset, len, buf); 307 308 printf("SF: %zu bytes @ %#x %s: ", (size_t)len, (u32)offset, 309 read ? "Read" : "Written"); 310 if (ret) 311 printf("ERROR %d\n", ret); 312 else 313 printf("OK\n"); 314 } 315 316 unmap_physmem(buf, len); 317 318 return ret == 0 ? 0 : 1; 319 } 320 321 static int do_spi_flash_erase(int argc, char * const argv[]) 322 { 323 int ret; 324 int dev = 0; 325 loff_t offset, len, maxsize; 326 ulong size; 327 328 if (argc < 3) 329 return -1; 330 331 if (mtd_arg_off(argv[1], &dev, &offset, &len, &maxsize, 332 MTD_DEV_TYPE_NOR, flash->size)) 333 return -1; 334 335 ret = sf_parse_len_arg(argv[2], &size); 336 if (ret != 1) 337 return -1; 338 339 /* Consistency checking */ 340 if (offset + size > flash->size) { 341 printf("ERROR: attempting %s past flash size (%#x)\n", 342 argv[0], flash->size); 343 return 1; 344 } 345 346 ret = spi_flash_erase(flash, offset, size); 347 printf("SF: %zu bytes @ %#x Erased: %s\n", (size_t)size, (u32)offset, 348 ret ? "ERROR" : "OK"); 349 350 return ret == 0 ? 0 : 1; 351 } 352 353 static int do_spi_protect(int argc, char * const argv[]) 354 { 355 int ret = 0; 356 loff_t start, len; 357 bool prot = false; 358 359 if (argc != 4) 360 return -1; 361 362 if (!str2off(argv[2], &start)) { 363 puts("start sector is not a valid number\n"); 364 return 1; 365 } 366 367 if (!str2off(argv[3], &len)) { 368 puts("len is not a valid number\n"); 369 return 1; 370 } 371 372 if (strcmp(argv[1], "lock") == 0) 373 prot = true; 374 else if (strcmp(argv[1], "unlock") == 0) 375 prot = false; 376 else 377 return -1; /* Unknown parameter */ 378 379 ret = spi_flash_protect(flash, start, len, prot); 380 381 return ret == 0 ? 0 : 1; 382 } 383 384 #ifdef CONFIG_CMD_SF_TEST 385 enum { 386 STAGE_ERASE, 387 STAGE_CHECK, 388 STAGE_WRITE, 389 STAGE_READ, 390 391 STAGE_COUNT, 392 }; 393 394 static char *stage_name[STAGE_COUNT] = { 395 "erase", 396 "check", 397 "write", 398 "read", 399 }; 400 401 struct test_info { 402 int stage; 403 int bytes; 404 unsigned base_ms; 405 unsigned time_ms[STAGE_COUNT]; 406 }; 407 408 static void show_time(struct test_info *test, int stage) 409 { 410 uint64_t speed; /* KiB/s */ 411 int bps; /* Bits per second */ 412 413 speed = (long long)test->bytes * 1000; 414 if (test->time_ms[stage]) 415 do_div(speed, test->time_ms[stage] * 1024); 416 bps = speed * 8; 417 418 printf("%d %s: %d ticks, %d KiB/s %d.%03d Mbps\n", stage, 419 stage_name[stage], test->time_ms[stage], 420 (int)speed, bps / 1000, bps % 1000); 421 } 422 423 static void spi_test_next_stage(struct test_info *test) 424 { 425 test->time_ms[test->stage] = get_timer(test->base_ms); 426 show_time(test, test->stage); 427 test->base_ms = get_timer(0); 428 test->stage++; 429 } 430 431 /** 432 * Run a test on the SPI flash 433 * 434 * @param flash SPI flash to use 435 * @param buf Source buffer for data to write 436 * @param len Size of data to read/write 437 * @param offset Offset within flash to check 438 * @param vbuf Verification buffer 439 * @return 0 if ok, -1 on error 440 */ 441 static int spi_flash_test(struct spi_flash *flash, uint8_t *buf, ulong len, 442 ulong offset, uint8_t *vbuf) 443 { 444 struct test_info test; 445 int i; 446 447 printf("SPI flash test:\n"); 448 memset(&test, '\0', sizeof(test)); 449 test.base_ms = get_timer(0); 450 test.bytes = len; 451 if (spi_flash_erase(flash, offset, len)) { 452 printf("Erase failed\n"); 453 return -1; 454 } 455 spi_test_next_stage(&test); 456 457 if (spi_flash_read(flash, offset, len, vbuf)) { 458 printf("Check read failed\n"); 459 return -1; 460 } 461 for (i = 0; i < len; i++) { 462 if (vbuf[i] != 0xff) { 463 printf("Check failed at %d\n", i); 464 print_buffer(i, vbuf + i, 1, 465 min_t(uint, len - i, 0x40), 0); 466 return -1; 467 } 468 } 469 spi_test_next_stage(&test); 470 471 if (spi_flash_write(flash, offset, len, buf)) { 472 printf("Write failed\n"); 473 return -1; 474 } 475 memset(vbuf, '\0', len); 476 spi_test_next_stage(&test); 477 478 if (spi_flash_read(flash, offset, len, vbuf)) { 479 printf("Read failed\n"); 480 return -1; 481 } 482 spi_test_next_stage(&test); 483 484 for (i = 0; i < len; i++) { 485 if (buf[i] != vbuf[i]) { 486 printf("Verify failed at %d, good data:\n", i); 487 print_buffer(i, buf + i, 1, 488 min_t(uint, len - i, 0x40), 0); 489 printf("Bad data:\n"); 490 print_buffer(i, vbuf + i, 1, 491 min_t(uint, len - i, 0x40), 0); 492 return -1; 493 } 494 } 495 printf("Test passed\n"); 496 for (i = 0; i < STAGE_COUNT; i++) 497 show_time(&test, i); 498 499 return 0; 500 } 501 502 static int do_spi_flash_test(int argc, char * const argv[]) 503 { 504 unsigned long offset; 505 unsigned long len; 506 uint8_t *buf, *from; 507 char *endp; 508 uint8_t *vbuf; 509 int ret; 510 511 if (argc < 3) 512 return -1; 513 offset = simple_strtoul(argv[1], &endp, 16); 514 if (*argv[1] == 0 || *endp != 0) 515 return -1; 516 len = simple_strtoul(argv[2], &endp, 16); 517 if (*argv[2] == 0 || *endp != 0) 518 return -1; 519 520 vbuf = memalign(ARCH_DMA_MINALIGN, len); 521 if (!vbuf) { 522 printf("Cannot allocate memory (%lu bytes)\n", len); 523 return 1; 524 } 525 buf = memalign(ARCH_DMA_MINALIGN, len); 526 if (!buf) { 527 free(vbuf); 528 printf("Cannot allocate memory (%lu bytes)\n", len); 529 return 1; 530 } 531 532 from = map_sysmem(CONFIG_SYS_TEXT_BASE, 0); 533 memcpy(buf, from, len); 534 ret = spi_flash_test(flash, buf, len, offset, vbuf); 535 free(vbuf); 536 free(buf); 537 if (ret) { 538 printf("Test failed\n"); 539 return 1; 540 } 541 542 return 0; 543 } 544 #endif /* CONFIG_CMD_SF_TEST */ 545 546 static int do_spi_flash(cmd_tbl_t *cmdtp, int flag, int argc, 547 char * const argv[]) 548 { 549 const char *cmd; 550 int ret; 551 552 /* need at least two arguments */ 553 if (argc < 2) 554 goto usage; 555 556 cmd = argv[1]; 557 --argc; 558 ++argv; 559 560 if (strcmp(cmd, "probe") == 0) { 561 ret = do_spi_flash_probe(argc, argv); 562 goto done; 563 } 564 565 /* The remaining commands require a selected device */ 566 if (!flash) { 567 puts("No SPI flash selected. Please run `sf probe'\n"); 568 return 1; 569 } 570 571 if (strcmp(cmd, "read") == 0 || strcmp(cmd, "write") == 0 || 572 strcmp(cmd, "update") == 0) 573 ret = do_spi_flash_read_write(argc, argv); 574 else if (strcmp(cmd, "erase") == 0) 575 ret = do_spi_flash_erase(argc, argv); 576 else if (strcmp(cmd, "protect") == 0) 577 ret = do_spi_protect(argc, argv); 578 #ifdef CONFIG_CMD_SF_TEST 579 else if (!strcmp(cmd, "test")) 580 ret = do_spi_flash_test(argc, argv); 581 #endif 582 else 583 ret = -1; 584 585 done: 586 if (ret != -1) 587 return ret; 588 589 usage: 590 return CMD_RET_USAGE; 591 } 592 593 #ifdef CONFIG_CMD_SF_TEST 594 #define SF_TEST_HELP "\nsf test offset len " \ 595 "- run a very basic destructive test" 596 #else 597 #define SF_TEST_HELP 598 #endif 599 600 U_BOOT_CMD( 601 sf, 5, 1, do_spi_flash, 602 "SPI flash sub-system", 603 "probe [[bus:]cs] [hz] [mode] - init flash device on given SPI bus\n" 604 " and chip select\n" 605 "sf read addr offset|partition len - read `len' bytes starting at\n" 606 " `offset' or from start of mtd\n" 607 " `partition'to memory at `addr'\n" 608 "sf write addr offset|partition len - write `len' bytes from memory\n" 609 " at `addr' to flash at `offset'\n" 610 " or to start of mtd `partition'\n" 611 "sf erase offset|partition [+]len - erase `len' bytes from `offset'\n" 612 " or from start of mtd `partition'\n" 613 " `+len' round up `len' to block size\n" 614 "sf update addr offset|partition len - erase and write `len' bytes from memory\n" 615 " at `addr' to flash at `offset'\n" 616 " or to start of mtd `partition'\n" 617 "sf protect lock/unlock sector len - protect/unprotect 'len' bytes starting\n" 618 " at address 'sector'\n" 619 SF_TEST_HELP 620 ); 621