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