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 <flash.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         buf = map_physmem(addr, len, MAP_WRBACK);
 298         if (!buf && addr) {
 299                 puts("Failed to map physical memory\n");
 300                 return 1;
 301         }
 302
 303         if (strcmp(argv[0], "update") == 0) {
 304                 ret = spi_flash_update(flash, offset, len, buf);
 305         } else if (strncmp(argv[0], "read", 4) == 0 ||
 306                         strncmp(argv[0], "write", 5) == 0) {
 307                 int read;
 308
 309                 read = strncmp(argv[0], "read", 4) == 0;
 310                 if (read)
 311                         ret = spi_flash_read(flash, offset, len, buf);
 312                 else
 313                         ret = spi_flash_write(flash, offset, len, buf);
 314
 315                 printf("SF: %zu bytes @ %#x %s: ", (size_t)len, (u32)offset,
 316                        read ? "Read" : "Written");
 317                 if (ret)
 318                         printf("ERROR %d\n", ret);
 319                 else
 320                         printf("OK\n");
 321         }
 322
 323         unmap_physmem(buf, len);
 324
 325         return ret == 0 ? 0 : 1;
 326 }
 327
 328 static int do_spi_flash_erase(int argc, char *const argv[])
 329 {
 330         int ret;
 331         int dev = 0;
 332         loff_t offset, len, maxsize;
 333         ulong size;
 334
 335         if (argc < 3)
 336                 return -1;
 337
 338         if (mtd_arg_off(argv[1], &dev, &offset, &len, &maxsize,
 339                         MTD_DEV_TYPE_NOR, flash->size))
 340                 return -1;
 341
 342         ret = sf_parse_len_arg(argv[2], &size);
 343         if (ret != 1)
 344                 return -1;
 345
 346         /* Consistency checking */
 347         if (offset + size > flash->size) {
 348                 printf("ERROR: attempting %s past flash size (%#x)\n",
 349                        argv[0], flash->size);
 350                 return 1;
 351         }
 352
 353         ret = spi_flash_erase(flash, offset, size);
 354         printf("SF: %zu bytes @ %#x Erased: ", (size_t)size, (u32)offset);
 355         if (ret)
 356                 printf("ERROR %d\n", ret);
 357         else
 358                 printf("OK\n");
 359
 360         return ret == 0 ? 0 : 1;
 361 }
 362
 363 static int do_spi_protect(int argc, char *const argv[])
 364 {
 365         int ret = 0;
 366         loff_t start, len;
 367         bool prot = false;
 368
 369         if (argc != 4)
 370                 return -1;
 371
 372         if (!str2off(argv[2], &start)) {
 373                 puts("start sector is not a valid number\n");
 374                 return 1;
 375         }
 376
 377         if (!str2off(argv[3], &len)) {
 378                 puts("len is not a valid number\n");
 379                 return 1;
 380         }
 381
 382         if (strcmp(argv[1], "lock") == 0)
 383                 prot = true;
 384         else if (strcmp(argv[1], "unlock") == 0)
 385                 prot = false;
 386         else
 387                 return -1;  /* Unknown parameter */
 388
 389         ret = spi_flash_protect(flash, start, len, prot);
 390
 391         return ret == 0 ? 0 : 1;
 392 }
 393
 394 enum {
 395         STAGE_ERASE,
 396         STAGE_CHECK,
 397         STAGE_WRITE,
 398         STAGE_READ,
 399
 400         STAGE_COUNT,
 401 };
 402
 403 static const char *stage_name[STAGE_COUNT] = {
 404         "erase",
 405         "check",
 406         "write",
 407         "read",
 408 };
 409
 410 struct test_info {
 411         int stage;
 412         int bytes;
 413         unsigned base_ms;
 414         unsigned time_ms[STAGE_COUNT];
 415 };
 416
 417 static void show_time(struct test_info *test, int stage)
 418 {
 419         uint64_t speed; /* KiB/s */
 420         int bps;        /* Bits per second */
 421
 422         speed = (long long)test->bytes * 1000;
 423         if (test->time_ms[stage])
 424                 do_div(speed, test->time_ms[stage] * 1024);
 425         bps = speed * 8;
 426
 427         printf("%d %s: %u ticks, %d KiB/s %d.%03d Mbps\n", stage,
 428                stage_name[stage], test->time_ms[stage],
 429                (int)speed, bps / 1000, bps % 1000);
 430 }
 431
 432 static void spi_test_next_stage(struct test_info *test)
 433 {
 434         test->time_ms[test->stage] = get_timer(test->base_ms);
 435         show_time(test, test->stage);
 436         test->base_ms = get_timer(0);
 437         test->stage++;
 438 }
 439
 440 /**
 441  * Run a test on the SPI flash
 442  *
 443  * @param flash         SPI flash to use
 444  * @param buf           Source buffer for data to write
 445  * @param len           Size of data to read/write
 446  * @param offset        Offset within flash to check
 447  * @param vbuf          Verification buffer
 448  * Return: 0 if ok, -1 on error
 449  */
 450 static int spi_flash_test(struct spi_flash *flash, uint8_t *buf, ulong len,
 451                            ulong offset, uint8_t *vbuf)
 452 {
 453         struct test_info test;
 454         int err, i;
 455
 456         printf("SPI flash test:\n");
 457         memset(&test, '\0', sizeof(test));
 458         test.base_ms = get_timer(0);
 459         test.bytes = len;
 460         err = spi_flash_erase(flash, offset, len);
 461         if (err) {
 462                 printf("Erase failed (err = %d)\n", err);
 463                 return -1;
 464         }
 465         spi_test_next_stage(&test);
 466
 467         err = spi_flash_read(flash, offset, len, vbuf);
 468         if (err) {
 469                 printf("Check read failed (err = %d)\n", err);
 470                 return -1;
 471         }
 472         for (i = 0; i < len; i++) {
 473                 if (vbuf[i] != 0xff) {
 474                         printf("Check failed at %d\n", i);
 475                         print_buffer(i, vbuf + i, 1,
 476                                      min_t(uint, len - i, 0x40), 0);
 477                         return -1;
 478                 }
 479         }
 480         spi_test_next_stage(&test);
 481
 482         err = spi_flash_write(flash, offset, len, buf);
 483         if (err) {
 484                 printf("Write failed (err = %d)\n", err);
 485                 return -1;
 486         }
 487         memset(vbuf, '\0', len);
 488         spi_test_next_stage(&test);
 489
 490         err = spi_flash_read(flash, offset, len, vbuf);
 491         if (err) {
 492                 printf("Read failed (ret = %d)\n", err);
 493                 return -1;
 494         }
 495         spi_test_next_stage(&test);
 496
 497         for (i = 0; i < len; i++) {
 498                 if (buf[i] != vbuf[i]) {
 499                         printf("Verify failed at %d, good data:\n", i);
 500                         print_buffer(i, buf + i, 1,
 501                                      min_t(uint, len - i, 0x40), 0);
 502                         printf("Bad data:\n");
 503                         print_buffer(i, vbuf + i, 1,
 504                                      min_t(uint, len - i, 0x40), 0);
 505                         return -1;
 506                 }
 507         }
 508         printf("Test passed\n");
 509         for (i = 0; i < STAGE_COUNT; i++)
 510                 show_time(&test, i);
 511
 512         return 0;
 513 }
 514
 515 static int do_spi_flash_test(int argc, char *const argv[])
 516 {
 517         unsigned long offset;
 518         unsigned long len;
 519         uint8_t *buf, *from;
 520         char *endp;
 521         uint8_t *vbuf;
 522         int ret;
 523
 524         if (argc < 3)
 525                 return -1;
 526         offset = hextoul(argv[1], &endp);
 527         if (*argv[1] == 0 || *endp != 0)
 528                 return -1;
 529         len = hextoul(argv[2], &endp);
 530         if (*argv[2] == 0 || *endp != 0)
 531                 return -1;
 532
 533         vbuf = memalign(ARCH_DMA_MINALIGN, len);
 534         if (!vbuf) {
 535                 printf("Cannot allocate memory (%lu bytes)\n", len);
 536                 return 1;
 537         }
 538         buf = memalign(ARCH_DMA_MINALIGN, len);
 539         if (!buf) {
 540                 free(vbuf);
 541                 printf("Cannot allocate memory (%lu bytes)\n", len);
 542                 return 1;
 543         }
 544
 545         from = map_sysmem(CONFIG_SYS_TEXT_BASE, 0);
 546         memcpy(buf, from, len);
 547         ret = spi_flash_test(flash, buf, len, offset, vbuf);
 548         free(vbuf);
 549         free(buf);
 550         if (ret) {
 551                 printf("Test failed\n");
 552                 return 1;
 553         }
 554
 555         return 0;
 556 }
 557
 558 static int do_spi_flash(struct cmd_tbl *cmdtp, int flag, int argc,
 559                         char *const argv[])
 560 {
 561         const char *cmd;
 562         int ret;
 563
 564         /* need at least two arguments */
 565         if (argc < 2)
 566                 goto usage;
 567
 568         cmd = argv[1];
 569         --argc;
 570         ++argv;
 571
 572         if (strcmp(cmd, "probe") == 0) {
 573                 ret = do_spi_flash_probe(argc, argv);
 574                 goto done;
 575         }
 576
 577         /* The remaining commands require a selected device */
 578         if (!flash) {
 579                 puts("No SPI flash selected. Please run `sf probe'\n");
 580                 return 1;
 581         }
 582
 583         if (strcmp(cmd, "read") == 0 || strcmp(cmd, "write") == 0 ||
 584             strcmp(cmd, "update") == 0)
 585                 ret = do_spi_flash_read_write(argc, argv);
 586         else if (strcmp(cmd, "erase") == 0)
 587                 ret = do_spi_flash_erase(argc, argv);
 588         else if (strcmp(cmd, "protect") == 0)
 589                 ret = do_spi_protect(argc, argv);
 590         else if (IS_ENABLED(CONFIG_CMD_SF_TEST) && !strcmp(cmd, "test"))
 591                 ret = do_spi_flash_test(argc, argv);
 592         else
 593                 ret = -1;
 594
 595 done:
 596         if (ret != -1)
 597                 return ret;
 598
 599 usage:
 600         return CMD_RET_USAGE;
 601 }
 602
 603 #ifdef CONFIG_SYS_LONGHELP
 604 static const char long_help[] =
 605         "probe [[bus:]cs] [hz] [mode]   - init flash device on given SPI bus\n"
 606         "                                 and chip select\n"
 607         "sf read addr offset|partition len      - read `len' bytes starting at\n"
 608         "                                         `offset' or from start of mtd\n"
 609         "                                         `partition'to memory at `addr'\n"
 610         "sf write addr offset|partition len     - write `len' bytes from memory\n"
 611         "                                         at `addr' to flash at `offset'\n"
 612         "                                         or to start of mtd `partition'\n"
 613         "sf erase offset|partition [+]len       - erase `len' bytes from `offset'\n"
 614         "                                         or from start of mtd `partition'\n"
 615         "                                        `+len' round up `len' to block size\n"
 616         "sf update addr offset|partition len    - erase and write `len' bytes from memory\n"
 617         "                                         at `addr' to flash at `offset'\n"
 618         "                                         or to start of mtd `partition'\n"
 619         "sf protect lock/unlock sector len      - protect/unprotect 'len' bytes starting\n"
 620         "                                         at address 'sector'"
 621 #ifdef CONFIG_CMD_SF_TEST
 622         "\nsf test offset len           - run a very basic destructive test"
 623 #endif
 624 #endif /* CONFIG_SYS_LONGHELP */
 625         ;
 626
 627 U_BOOT_CMD(
 628         sf,     5,      1,      do_spi_flash,
 629         "SPI flash sub-system", long_help
 630 );