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