cmd/sf.c

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