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         u32 start_offset = offset % flash->sector_size;
 183         u32 read_offset = offset - start_offset;
 184
 185         debug("offset=%#x+%#x, sector_size=%#x, len=%#zx\n",
 186               read_offset, start_offset, flash->sector_size, len);
 187         /* Read the entire sector so to allow for rewriting */
 188         if (spi_flash_read(flash, read_offset, flash->sector_size, cmp_buf))
 189                 return "read";
 190         /* Compare only what is meaningful (len) */
 191         if (memcmp(cmp_buf + start_offset, buf, len) == 0) {
 192                 debug("Skip region %x+%x size %zx: no change\n",
 193                       start_offset, read_offset, len);
 194                 *skipped += len;
 195                 return NULL;
 196         }
 197         /* Erase the entire sector */
 198         if (spi_flash_erase(flash, offset, flash->sector_size))
 199                 return "erase";
 200         /* If it's a partial sector, copy the data into the temp-buffer */
 201         if (len != flash->sector_size) {
 202                 memcpy(cmp_buf + start_offset, buf, len);
 203                 ptr = cmp_buf;
 204         }
 205         /* Write one complete sector */
 206         if (spi_flash_write(flash, offset, flash->sector_size, ptr))
 207                 return "write";
 208
 209         return NULL;
 210 }
 211
 212 /**
 213  * Update an area of SPI flash by erasing and writing any blocks which need
 214  * to change. Existing blocks with the correct data are left unchanged.
 215  *
 216  * @param flash         flash context pointer
 217  * @param offset        flash offset to write
 218  * @param len           number of bytes to write
 219  * @param buf           buffer to write from
 220  * Return: 0 if ok, 1 on error
 221  */
 222 static int spi_flash_update(struct spi_flash *flash, u32 offset,
 223                 size_t len, const char *buf)
 224 {
 225         const char *err_oper = NULL;
 226         char *cmp_buf;
 227         const char *end = buf + len;
 228         size_t todo;            /* number of bytes to do in this pass */
 229         size_t skipped = 0;     /* statistics */
 230         const ulong start_time = get_timer(0);
 231         size_t scale = 1;
 232         const char *start_buf = buf;
 233         ulong delta;
 234
 235         if (end - buf >= 200)
 236                 scale = (end - buf) / 100;
 237         cmp_buf = memalign(ARCH_DMA_MINALIGN, flash->sector_size);
 238         if (cmp_buf) {
 239                 ulong last_update = get_timer(0);
 240
 241                 for (; buf < end && !err_oper; buf += todo, offset += todo) {
 242                         todo = min_t(size_t, end - buf, flash->sector_size);
 243                         todo = min_t(size_t, end - buf,
 244                                      flash->sector_size - (offset % flash->sector_size));
 245                         if (get_timer(last_update) > 100) {
 246                                 printf("   \rUpdating, %zu%% %lu B/s",
 247                                        100 - (end - buf) / scale,
 248                                         bytes_per_second(buf - start_buf,
 249                                                          start_time));
 250                                 last_update = get_timer(0);
 251                         }
 252                         err_oper = spi_flash_update_block(flash, offset, todo,
 253                                         buf, cmp_buf, &skipped);
 254                 }
 255         } else {
 256                 err_oper = "malloc";
 257         }
 258         free(cmp_buf);
 259         putc('\r');
 260         if (err_oper) {
 261                 printf("SPI flash failed in %s step\n", err_oper);
 262                 return 1;
 263         }
 264
 265         delta = get_timer(start_time);
 266         printf("%zu bytes written, %zu bytes skipped", len - skipped,
 267                skipped);
 268         printf(" in %ld.%lds, speed %ld B/s\n",
 269                delta / 1000, delta % 1000, bytes_per_second(len, start_time));
 270
 271         return 0;
 272 }
 273
 274 static int do_spi_flash_read_write(int argc, char *const argv[])
 275 {
 276         unsigned long addr;
 277         void *buf;
 278         char *endp;
 279         int ret = 1;
 280         int dev = 0;
 281         loff_t offset, len, maxsize;
 282
 283         if (argc < 3)
 284                 return CMD_RET_USAGE;
 285
 286         addr = hextoul(argv[1], &endp);
 287         if (*argv[1] == 0 || *endp != 0)
 288                 return CMD_RET_USAGE;
 289
 290         if (mtd_arg_off_size(argc - 2, &argv[2], &dev, &offset, &len,
 291                              &maxsize, MTD_DEV_TYPE_NOR, flash->size))
 292                 return CMD_RET_FAILURE;
 293
 294         /* Consistency checking */
 295         if (offset + len > flash->size) {
 296                 printf("ERROR: attempting %s past flash size (%#x)\n",
 297                        argv[0], flash->size);
 298                 return CMD_RET_FAILURE;
 299         }
 300
 301         if (strncmp(argv[0], "read", 4) != 0 && flash->flash_is_unlocked &&
 302             !flash->flash_is_unlocked(flash, offset, len)) {
 303                 printf("ERROR: flash area is locked\n");
 304                 return CMD_RET_FAILURE;
 305         }
 306
 307         buf = map_physmem(addr, len, MAP_WRBACK);
 308         if (!buf && addr) {
 309                 puts("Failed to map physical memory\n");
 310                 return CMD_RET_FAILURE;
 311         }
 312
 313         if (strcmp(argv[0], "update") == 0) {
 314                 ret = spi_flash_update(flash, offset, len, buf);
 315         } else if (strncmp(argv[0], "read", 4) == 0 ||
 316                         strncmp(argv[0], "write", 5) == 0) {
 317                 int read;
 318
 319                 read = strncmp(argv[0], "read", 4) == 0;
 320                 if (read)
 321                         ret = spi_flash_read(flash, offset, len, buf);
 322                 else
 323                         ret = spi_flash_write(flash, offset, len, buf);
 324
 325                 printf("SF: %zu bytes @ %#x %s: ", (size_t)len, (u32)offset,
 326                        read ? "Read" : "Written");
 327                 if (ret)
 328                         printf("ERROR %d\n", ret);
 329                 else
 330                         printf("OK\n");
 331         }
 332
 333         unmap_physmem(buf, len);
 334
 335         return ret ? CMD_RET_FAILURE : CMD_RET_SUCCESS;
 336 }
 337
 338 static int do_spi_flash_erase(int argc, char *const argv[])
 339 {
 340         int ret;
 341         int dev = 0;
 342         loff_t offset, len, maxsize;
 343         ulong size;
 344
 345         if (argc < 3)
 346                 return CMD_RET_USAGE;
 347
 348         if (mtd_arg_off(argv[1], &dev, &offset, &len, &maxsize,
 349                         MTD_DEV_TYPE_NOR, flash->size))
 350                 return CMD_RET_FAILURE;
 351
 352         ret = sf_parse_len_arg(argv[2], &size);
 353         if (ret != 1)
 354                 return CMD_RET_USAGE;
 355
 356         /* Consistency checking */
 357         if (offset + size > flash->size) {
 358                 printf("ERROR: attempting %s past flash size (%#x)\n",
 359                        argv[0], flash->size);
 360                 return CMD_RET_FAILURE;
 361         }
 362
 363         if (flash->flash_is_unlocked &&
 364             !flash->flash_is_unlocked(flash, offset, len)) {
 365                 printf("ERROR: flash area is locked\n");
 366                 return CMD_RET_FAILURE;
 367         }
 368
 369         ret = spi_flash_erase(flash, offset, size);
 370         printf("SF: %zu bytes @ %#x Erased: ", (size_t)size, (u32)offset);
 371         if (ret)
 372                 printf("ERROR %d\n", ret);
 373         else
 374                 printf("OK\n");
 375
 376         return ret ? CMD_RET_FAILURE : CMD_RET_SUCCESS;
 377 }
 378
 379 static int do_spi_protect(int argc, char *const argv[])
 380 {
 381         int ret = 0;
 382         loff_t start, len;
 383         bool prot = false;
 384
 385         if (argc != 4)
 386                 return -1;
 387
 388         if (!str2off(argv[2], &start)) {
 389                 puts("start sector is not a valid number\n");
 390                 return 1;
 391         }
 392
 393         if (!str2off(argv[3], &len)) {
 394                 puts("len is not a valid number\n");
 395                 return 1;
 396         }
 397
 398         if (strcmp(argv[1], "lock") == 0)
 399                 prot = true;
 400         else if (strcmp(argv[1], "unlock") == 0)
 401                 prot = false;
 402         else
 403                 return -1;  /* Unknown parameter */
 404
 405         ret = spi_flash_protect(flash, start, len, prot);
 406
 407         return ret == 0 ? 0 : 1;
 408 }
 409
 410 enum {
 411         STAGE_ERASE,
 412         STAGE_CHECK,
 413         STAGE_WRITE,
 414         STAGE_READ,
 415
 416         STAGE_COUNT,
 417 };
 418
 419 static const char *stage_name[STAGE_COUNT] = {
 420         "erase",
 421         "check",
 422         "write",
 423         "read",
 424 };
 425
 426 struct test_info {
 427         int stage;
 428         int bytes;
 429         unsigned base_ms;
 430         unsigned time_ms[STAGE_COUNT];
 431 };
 432
 433 static void show_time(struct test_info *test, int stage)
 434 {
 435         uint64_t speed; /* KiB/s */
 436         int bps;        /* Bits per second */
 437
 438         speed = (long long)test->bytes * 1000;
 439         if (test->time_ms[stage])
 440                 do_div(speed, test->time_ms[stage] * 1024);
 441         bps = speed * 8;
 442
 443         printf("%d %s: %u ticks, %d KiB/s %d.%03d Mbps\n", stage,
 444                stage_name[stage], test->time_ms[stage],
 445                (int)speed, bps / 1000, bps % 1000);
 446 }
 447
 448 static void spi_test_next_stage(struct test_info *test)
 449 {
 450         test->time_ms[test->stage] = get_timer(test->base_ms);
 451         show_time(test, test->stage);
 452         test->base_ms = get_timer(0);
 453         test->stage++;
 454 }
 455
 456 /**
 457  * Run a test on the SPI flash
 458  *
 459  * @param flash         SPI flash to use
 460  * @param buf           Source buffer for data to write
 461  * @param len           Size of data to read/write
 462  * @param offset        Offset within flash to check
 463  * @param vbuf          Verification buffer
 464  * Return: 0 if ok, -1 on error
 465  */
 466 static int spi_flash_test(struct spi_flash *flash, uint8_t *buf, ulong len,
 467                            ulong offset, uint8_t *vbuf)
 468 {
 469         struct test_info test;
 470         int err, i;
 471
 472         printf("SPI flash test:\n");
 473         memset(&test, '\0', sizeof(test));
 474         test.base_ms = get_timer(0);
 475         test.bytes = len;
 476         err = spi_flash_erase(flash, offset, len);
 477         if (err) {
 478                 printf("Erase failed (err = %d)\n", err);
 479                 return -1;
 480         }
 481         spi_test_next_stage(&test);
 482
 483         err = spi_flash_read(flash, offset, len, vbuf);
 484         if (err) {
 485                 printf("Check read failed (err = %d)\n", err);
 486                 return -1;
 487         }
 488         for (i = 0; i < len; i++) {
 489                 if (vbuf[i] != 0xff) {
 490                         printf("Check failed at %d\n", i);
 491                         print_buffer(i, vbuf + i, 1,
 492                                      min_t(uint, len - i, 0x40), 0);
 493                         return -1;
 494                 }
 495         }
 496         spi_test_next_stage(&test);
 497
 498         err = spi_flash_write(flash, offset, len, buf);
 499         if (err) {
 500                 printf("Write failed (err = %d)\n", err);
 501                 return -1;
 502         }
 503         memset(vbuf, '\0', len);
 504         spi_test_next_stage(&test);
 505
 506         err = spi_flash_read(flash, offset, len, vbuf);
 507         if (err) {
 508                 printf("Read failed (ret = %d)\n", err);
 509                 return -1;
 510         }
 511         spi_test_next_stage(&test);
 512
 513         for (i = 0; i < len; i++) {
 514                 if (buf[i] != vbuf[i]) {
 515                         printf("Verify failed at %d, good data:\n", i);
 516                         print_buffer(i, buf + i, 1,
 517                                      min_t(uint, len - i, 0x40), 0);
 518                         printf("Bad data:\n");
 519                         print_buffer(i, vbuf + i, 1,
 520                                      min_t(uint, len - i, 0x40), 0);
 521                         return -1;
 522                 }
 523         }
 524         printf("Test passed\n");
 525         for (i = 0; i < STAGE_COUNT; i++)
 526                 show_time(&test, i);
 527
 528         return 0;
 529 }
 530
 531 static int do_spi_flash_test(int argc, char *const argv[])
 532 {
 533         unsigned long offset;
 534         unsigned long len;
 535         uint8_t *buf, *from;
 536         char *endp;
 537         uint8_t *vbuf;
 538         int ret;
 539
 540         if (argc < 3)
 541                 return -1;
 542         offset = hextoul(argv[1], &endp);
 543         if (*argv[1] == 0 || *endp != 0)
 544                 return -1;
 545         len = hextoul(argv[2], &endp);
 546         if (*argv[2] == 0 || *endp != 0)
 547                 return -1;
 548
 549         vbuf = memalign(ARCH_DMA_MINALIGN, len);
 550         if (!vbuf) {
 551                 printf("Cannot allocate memory (%lu bytes)\n", len);
 552                 return 1;
 553         }
 554         buf = memalign(ARCH_DMA_MINALIGN, len);
 555         if (!buf) {
 556                 free(vbuf);
 557                 printf("Cannot allocate memory (%lu bytes)\n", len);
 558                 return 1;
 559         }
 560
 561         from = map_sysmem(CONFIG_TEXT_BASE, 0);
 562         memcpy(buf, from, len);
 563         ret = spi_flash_test(flash, buf, len, offset, vbuf);
 564         free(vbuf);
 565         free(buf);
 566         if (ret) {
 567                 printf("Test failed\n");
 568                 return 1;
 569         }
 570
 571         return 0;
 572 }
 573
 574 static int do_spi_flash(struct cmd_tbl *cmdtp, int flag, int argc,
 575                         char *const argv[])
 576 {
 577         const char *cmd;
 578         int ret;
 579
 580         /* need at least two arguments */
 581         if (argc < 2)
 582                 return CMD_RET_USAGE;
 583
 584         cmd = argv[1];
 585         --argc;
 586         ++argv;
 587
 588         if (strcmp(cmd, "probe") == 0)
 589                 return do_spi_flash_probe(argc, argv);
 590
 591         /* The remaining commands require a selected device */
 592         if (!flash) {
 593                 puts("No SPI flash selected. Please run `sf probe'\n");
 594                 return CMD_RET_FAILURE;
 595         }
 596
 597         if (strcmp(cmd, "read") == 0 || strcmp(cmd, "write") == 0 ||
 598             strcmp(cmd, "update") == 0)
 599                 ret = do_spi_flash_read_write(argc, argv);
 600         else if (strcmp(cmd, "erase") == 0)
 601                 ret = do_spi_flash_erase(argc, argv);
 602         else if (strcmp(cmd, "protect") == 0)
 603                 ret = do_spi_protect(argc, argv);
 604         else if (IS_ENABLED(CONFIG_CMD_SF_TEST) && !strcmp(cmd, "test"))
 605                 ret = do_spi_flash_test(argc, argv);
 606         else
 607                 ret = CMD_RET_USAGE;
 608
 609         return ret;
 610 }
 611
 612 #ifdef CONFIG_SYS_LONGHELP
 613 static const char long_help[] =
 614         "probe [[bus:]cs] [hz] [mode]   - init flash device on given SPI bus\n"
 615         "                                 and chip select\n"
 616         "sf read addr offset|partition len      - read `len' bytes starting at\n"
 617         "                                         `offset' or from start of mtd\n"
 618         "                                         `partition'to memory at `addr'\n"
 619         "sf write addr offset|partition len     - write `len' bytes from memory\n"
 620         "                                         at `addr' to flash at `offset'\n"
 621         "                                         or to start of mtd `partition'\n"
 622         "sf erase offset|partition [+]len       - erase `len' bytes from `offset'\n"
 623         "                                         or from start of mtd `partition'\n"
 624         "                                        `+len' round up `len' to block size\n"
 625         "sf update addr offset|partition len    - erase and write `len' bytes from memory\n"
 626         "                                         at `addr' to flash at `offset'\n"
 627         "                                         or to start of mtd `partition'\n"
 628         "sf protect lock/unlock sector len      - protect/unprotect 'len' bytes starting\n"
 629         "                                         at address 'sector'"
 630 #ifdef CONFIG_CMD_SF_TEST
 631         "\nsf test offset len           - run a very basic destructive test"
 632 #endif
 633 #endif /* CONFIG_SYS_LONGHELP */
 634         ;
 635
 636 U_BOOT_CMD(
 637         sf,     5,      1,      do_spi_flash,
 638         "SPI flash sub-system", long_help
 639 );