common/cmd_sf.c

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