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