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