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