git.sur5r.net Git - openocd/blob - src/flash/nor/tcl.c

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath <Dominic.Rath@gmx.de>              *
   3  *   Copyright (C) 2007,2008 Øyvind Harboe <oyvind.harboe@zylin.com>       *
   4  *   Copyright (C) 2008 by Spencer Oliver <spen@spen-soft.co.uk>           *
   5  *   Copyright (C) 2009 Zachary T Welch <zw@superlucidity.net>             *
   6  *                                                                         *
   7  *   This program is free software; you can redistribute it and/or modify  *
   8  *   it under the terms of the GNU General Public License as published by  *
   9  *   the Free Software Foundation; either version 2 of the License, or     *
  10  *   (at your option) any later version.                                   *
  11  *                                                                         *
  12  *   This program is distributed in the hope that it will be useful,       *
  13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  15  *   GNU General Public License for more details.                          *
  16  *                                                                         *
  17  *   You should have received a copy of the GNU General Public License     *
  18  *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  19  ***************************************************************************/
  20 #ifdef HAVE_CONFIG_H
  21 #include "config.h"
  22 #endif
  23 #include "imp.h"
  24 #include <helper/time_support.h>
  25 #include <target/image.h>
  26
  27 /**
  28  * @file
  29  * Implements Tcl commands used to access NOR flash facilities.
  30  */
  31
  32 COMMAND_HELPER(flash_command_get_bank_maybe_probe, unsigned name_index,
  33                struct flash_bank **bank, bool do_probe)
  34 {
  35         const char *name = CMD_ARGV[name_index];
  36         int retval;
  37         if (do_probe) {
  38                 retval = get_flash_bank_by_name(name, bank);
  39         } else {
  40                 *bank  = get_flash_bank_by_name_noprobe(name);
  41                 retval = ERROR_OK;
  42         }
  43
  44         if (retval != ERROR_OK)
  45                 return retval;
  46         if (*bank)
  47                 return ERROR_OK;
  48
  49         unsigned bank_num;
  50         COMMAND_PARSE_NUMBER(uint, name, bank_num);
  51
  52         if (do_probe) {
  53                 return get_flash_bank_by_num(bank_num, bank);
  54         } else {
  55                 *bank  = get_flash_bank_by_num_noprobe(bank_num);
  56                 retval = (bank) ? ERROR_OK : ERROR_FAIL;
  57                 return retval;
  58         }
  59 }
  60
  61 COMMAND_HELPER(flash_command_get_bank, unsigned name_index,
  62         struct flash_bank **bank)
  63 {
  64         return CALL_COMMAND_HANDLER(flash_command_get_bank_maybe_probe,
  65                                     name_index, bank, true);
  66 }
  67
  68 COMMAND_HANDLER(handle_flash_info_command)
  69 {
  70         struct flash_bank *p;
  71         int j = 0;
  72         int retval;
  73         bool show_sectors = false;
  74         bool prot_block_available;
  75
  76         if (CMD_ARGC < 1 || CMD_ARGC > 2)
  77                 return ERROR_COMMAND_SYNTAX_ERROR;
  78
  79         if (CMD_ARGC == 2) {
  80                 if (strcmp("sectors", CMD_ARGV[1]) == 0)
  81                         show_sectors = true;
  82                 else
  83                         return ERROR_COMMAND_SYNTAX_ERROR;
  84         }
  85
  86         retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
  87         if (retval != ERROR_OK)
  88                 return retval;
  89
  90         if (p != NULL) {
  91                 char buf[1024];
  92                 int num_blocks;
  93                 struct flash_sector *block_array;
  94
  95                 /* attempt auto probe */
  96                 retval = p->driver->auto_probe(p);
  97                 if (retval != ERROR_OK)
  98                         return retval;
  99
 100                 /* We must query the hardware to avoid printing stale information! */
 101                 retval = p->driver->protect_check(p);
 102                 if (retval != ERROR_OK)
 103                         return retval;
 104
 105                 command_print(CMD_CTX,
 106                         "#%d : %s at 0x%8.8" PRIx32 ", size 0x%8.8" PRIx32
 107                         ", buswidth %i, chipwidth %i",
 108                         p->bank_number,
 109                         p->driver->name,
 110                         p->base,
 111                         p->size,
 112                         p->bus_width,
 113                         p->chip_width);
 114
 115                 prot_block_available = p->num_prot_blocks && p->prot_blocks;
 116                 if (!show_sectors && prot_block_available) {
 117                         block_array = p->prot_blocks;
 118                         num_blocks = p->num_prot_blocks;
 119                 } else {
 120                         block_array = p->sectors;
 121                         num_blocks = p->num_sectors;
 122                 }
 123
 124                 for (j = 0; j < num_blocks; j++) {
 125                         char *protect_state = "";
 126
 127                         if (block_array[j].is_protected == 0)
 128                                 protect_state = "not protected";
 129                         else if (block_array[j].is_protected == 1)
 130                                 protect_state = "protected";
 131                         else if (!show_sectors || !prot_block_available)
 132                                 protect_state = "protection state unknown";
 133
 134                         command_print(CMD_CTX,
 135                                 "\t#%3i: 0x%8.8" PRIx32 " (0x%" PRIx32 " %" PRIi32 "kB) %s",
 136                                 j,
 137                                 block_array[j].offset,
 138                                 block_array[j].size,
 139                                 block_array[j].size >> 10,
 140                                 protect_state);
 141                 }
 142
 143                 if (p->driver->info != NULL) {
 144                         retval = p->driver->info(p, buf, sizeof(buf));
 145                         if (retval == ERROR_OK)
 146                                 command_print(CMD_CTX, "%s", buf);
 147                         else
 148                                 LOG_ERROR("error retrieving flash info");
 149                 }
 150         }
 151
 152         return retval;
 153 }
 154
 155 COMMAND_HANDLER(handle_flash_probe_command)
 156 {
 157         struct flash_bank *p;
 158         int retval;
 159
 160         if (CMD_ARGC != 1)
 161                 return ERROR_COMMAND_SYNTAX_ERROR;
 162
 163         retval = CALL_COMMAND_HANDLER(flash_command_get_bank_maybe_probe, 0, &p, false);
 164         if (retval != ERROR_OK)
 165                 return retval;
 166
 167         if (p) {
 168                 retval = p->driver->probe(p);
 169                 if (retval == ERROR_OK)
 170                         command_print(CMD_CTX,
 171                                 "flash '%s' found at 0x%8.8" PRIx32,
 172                                 p->driver->name,
 173                                 p->base);
 174         } else {
 175                 command_print(CMD_CTX, "flash bank '#%s' is out of bounds", CMD_ARGV[0]);
 176                 retval = ERROR_FAIL;
 177         }
 178
 179         return retval;
 180 }
 181
 182 COMMAND_HANDLER(handle_flash_erase_check_command)
 183 {
 184         bool blank = true;
 185         if (CMD_ARGC != 1)
 186                 return ERROR_COMMAND_SYNTAX_ERROR;
 187
 188         struct flash_bank *p;
 189         int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
 190         if (ERROR_OK != retval)
 191                 return retval;
 192
 193         int j;
 194         retval = p->driver->erase_check(p);
 195         if (retval == ERROR_OK)
 196                 command_print(CMD_CTX, "successfully checked erase state");
 197         else {
 198                 command_print(CMD_CTX,
 199                         "unknown error when checking erase state of flash bank #%s at 0x%8.8" PRIx32,
 200                         CMD_ARGV[0],
 201                         p->base);
 202         }
 203
 204         for (j = 0; j < p->num_sectors; j++) {
 205                 char *erase_state;
 206
 207                 if (p->sectors[j].is_erased == 0)
 208                         erase_state = "not erased";
 209                 else if (p->sectors[j].is_erased == 1)
 210                         continue;
 211                 else
 212                         erase_state = "erase state unknown";
 213
 214                 blank = false;
 215                 command_print(CMD_CTX,
 216                         "\t#%3i: 0x%8.8" PRIx32 " (0x%" PRIx32 " %" PRIi32 "kB) %s",
 217                         j,
 218                         p->sectors[j].offset,
 219                         p->sectors[j].size,
 220                         p->sectors[j].size >> 10,
 221                         erase_state);
 222         }
 223
 224         if (blank)
 225                 command_print(CMD_CTX, "\tBank is erased");
 226         return retval;
 227 }
 228
 229 COMMAND_HANDLER(handle_flash_erase_address_command)
 230 {
 231         struct flash_bank *p;
 232         int retval = ERROR_OK;
 233         uint32_t address;
 234         uint32_t length;
 235         bool do_pad = false;
 236         bool do_unlock = false;
 237         struct target *target = get_current_target(CMD_CTX);
 238
 239         while (CMD_ARGC >= 3) {
 240                 /* Optionally pad out the address range to block/sector
 241                  * boundaries.  We can't know if there's data in that part
 242                  * of the flash; only do padding if we're told to.
 243                  */
 244                 if (strcmp("pad", CMD_ARGV[0]) == 0)
 245                         do_pad = true;
 246                 else if (strcmp("unlock", CMD_ARGV[0]) == 0)
 247                         do_unlock = true;
 248                 else
 249                         return ERROR_COMMAND_SYNTAX_ERROR;
 250                 CMD_ARGC--;
 251                 CMD_ARGV++;
 252         }
 253         if (CMD_ARGC != 2)
 254                 return ERROR_COMMAND_SYNTAX_ERROR;
 255
 256         COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
 257         COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
 258
 259         if (length <= 0) {
 260                 command_print(CMD_CTX, "Length must be >0");
 261                 return ERROR_COMMAND_SYNTAX_ERROR;
 262         }
 263
 264         retval = get_flash_bank_by_addr(target, address, true, &p);
 265         if (retval != ERROR_OK)
 266                 return retval;
 267
 268         /* We can't know if we did a resume + halt, in which case we no longer know the erased state
 269          **/
 270         flash_set_dirty();
 271
 272         struct duration bench;
 273         duration_start(&bench);
 274
 275         if (do_unlock)
 276                 retval = flash_unlock_address_range(target, address, length);
 277
 278         if (retval == ERROR_OK)
 279                 retval = flash_erase_address_range(target, do_pad, address, length);
 280
 281         if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
 282                 command_print(CMD_CTX, "erased address 0x%8.8" PRIx32 " (length %" PRIi32 ")"
 283                         " in %fs (%0.3f KiB/s)", address, length,
 284                         duration_elapsed(&bench), duration_kbps(&bench, length));
 285         }
 286
 287         return retval;
 288 }
 289
 290 static int flash_check_sector_parameters(struct command_context *cmd_ctx,
 291         uint32_t first, uint32_t last, uint32_t num_sectors)
 292 {
 293         if (!(first <= last)) {
 294                 command_print(cmd_ctx, "ERROR: "
 295                         "first sector must be <= last sector");
 296                 return ERROR_FAIL;
 297         }
 298
 299         if (!(last <= (num_sectors - 1))) {
 300                 command_print(cmd_ctx, "ERROR: last sector must be <= %" PRIu32,
 301                         num_sectors - 1);
 302                 return ERROR_FAIL;
 303         }
 304
 305         return ERROR_OK;
 306 }
 307
 308 COMMAND_HANDLER(handle_flash_erase_command)
 309 {
 310         if (CMD_ARGC != 3)
 311                 return ERROR_COMMAND_SYNTAX_ERROR;
 312
 313         uint32_t first;
 314         uint32_t last;
 315
 316         struct flash_bank *p;
 317         int retval;
 318
 319         retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
 320         if (retval != ERROR_OK)
 321                 return retval;
 322
 323         COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], first);
 324         if (strcmp(CMD_ARGV[2], "last") == 0)
 325                 last = p->num_sectors - 1;
 326         else
 327                 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], last);
 328
 329         retval = flash_check_sector_parameters(CMD_CTX, first, last, p->num_sectors);
 330         if (retval != ERROR_OK)
 331                 return retval;
 332
 333         struct duration bench;
 334         duration_start(&bench);
 335
 336         retval = flash_driver_erase(p, first, last);
 337
 338         if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
 339                 command_print(CMD_CTX, "erased sectors %" PRIu32 " "
 340                         "through %" PRIu32 " on flash bank %d "
 341                         "in %fs", first, last, p->bank_number, duration_elapsed(&bench));
 342         }
 343
 344         return retval;
 345 }
 346
 347 COMMAND_HANDLER(handle_flash_protect_command)
 348 {
 349         if (CMD_ARGC != 4)
 350                 return ERROR_COMMAND_SYNTAX_ERROR;
 351
 352         uint32_t first;
 353         uint32_t last;
 354
 355         struct flash_bank *p;
 356         int retval;
 357         int num_blocks;
 358
 359         retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
 360         if (retval != ERROR_OK)
 361                 return retval;
 362
 363         if (p->num_prot_blocks)
 364                 num_blocks = p->num_prot_blocks;
 365         else
 366                 num_blocks = p->num_sectors;
 367
 368         COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], first);
 369         if (strcmp(CMD_ARGV[2], "last") == 0)
 370                 last = num_blocks - 1;
 371         else
 372                 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], last);
 373
 374         bool set;
 375         COMMAND_PARSE_ON_OFF(CMD_ARGV[3], set);
 376
 377         retval = flash_check_sector_parameters(CMD_CTX, first, last, num_blocks);
 378         if (retval != ERROR_OK)
 379                 return retval;
 380
 381         retval = flash_driver_protect(p, set, first, last);
 382         if (retval == ERROR_OK) {
 383                 command_print(CMD_CTX, "%s protection for sectors %" PRIu32
 384                         " through %" PRIu32 " on flash bank %d",
 385                         (set) ? "set" : "cleared", first, last, p->bank_number);
 386         }
 387
 388         return retval;
 389 }
 390
 391 COMMAND_HANDLER(handle_flash_write_image_command)
 392 {
 393         struct target *target = get_current_target(CMD_CTX);
 394
 395         struct image image;
 396         uint32_t written;
 397
 398         int retval;
 399
 400         /* flash auto-erase is disabled by default*/
 401         int auto_erase = 0;
 402         bool auto_unlock = false;
 403
 404         while (CMD_ARGC) {
 405                 if (strcmp(CMD_ARGV[0], "erase") == 0) {
 406                         auto_erase = 1;
 407                         CMD_ARGV++;
 408                         CMD_ARGC--;
 409                         command_print(CMD_CTX, "auto erase enabled");
 410                 } else if (strcmp(CMD_ARGV[0], "unlock") == 0) {
 411                         auto_unlock = true;
 412                         CMD_ARGV++;
 413                         CMD_ARGC--;
 414                         command_print(CMD_CTX, "auto unlock enabled");
 415                 } else
 416                         break;
 417         }
 418
 419         if (CMD_ARGC < 1)
 420                 return ERROR_COMMAND_SYNTAX_ERROR;
 421
 422         if (!target) {
 423                 LOG_ERROR("no target selected");
 424                 return ERROR_FAIL;
 425         }
 426
 427         struct duration bench;
 428         duration_start(&bench);
 429
 430         if (CMD_ARGC >= 2) {
 431                 image.base_address_set = 1;
 432                 COMMAND_PARSE_NUMBER(llong, CMD_ARGV[1], image.base_address);
 433         } else {
 434                 image.base_address_set = 0;
 435                 image.base_address = 0x0;
 436         }
 437
 438         image.start_address_set = 0;
 439
 440         retval = image_open(&image, CMD_ARGV[0], (CMD_ARGC == 3) ? CMD_ARGV[2] : NULL);
 441         if (retval != ERROR_OK)
 442                 return retval;
 443
 444         retval = flash_write_unlock(target, &image, &written, auto_erase, auto_unlock);
 445         if (retval != ERROR_OK) {
 446                 image_close(&image);
 447                 return retval;
 448         }
 449
 450         if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
 451                 command_print(CMD_CTX, "wrote %" PRIu32 " bytes from file %s "
 452                         "in %fs (%0.3f KiB/s)", written, CMD_ARGV[0],
 453                         duration_elapsed(&bench), duration_kbps(&bench, written));
 454         }
 455
 456         image_close(&image);
 457
 458         return retval;
 459 }
 460
 461 COMMAND_HANDLER(handle_flash_fill_command)
 462 {
 463         int err = ERROR_OK;
 464         uint32_t address;
 465         uint32_t pattern;
 466         uint32_t count;
 467         uint32_t wrote = 0;
 468         uint32_t cur_size = 0;
 469         uint32_t chunk_count;
 470         struct target *target = get_current_target(CMD_CTX);
 471         unsigned i;
 472         uint32_t wordsize;
 473         int retval = ERROR_OK;
 474
 475         static size_t const chunksize = 1024;
 476         uint8_t *chunk = NULL, *readback = NULL;
 477
 478         if (CMD_ARGC != 3) {
 479                 retval = ERROR_COMMAND_SYNTAX_ERROR;
 480                 goto done;
 481         }
 482
 483         COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
 484         COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], pattern);
 485         COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], count);
 486
 487         chunk = malloc(chunksize);
 488         if (chunk == NULL)
 489                 return ERROR_FAIL;
 490
 491         readback = malloc(chunksize);
 492         if (readback == NULL) {
 493                 free(chunk);
 494                 return ERROR_FAIL;
 495         }
 496
 497         if (count == 0)
 498                 goto done;
 499
 500         switch (CMD_NAME[4]) {
 501                 case 'w':
 502                         wordsize = 4;
 503                         break;
 504                 case 'h':
 505                         wordsize = 2;
 506                         break;
 507                 case 'b':
 508                         wordsize = 1;
 509                         break;
 510                 default:
 511                         retval = ERROR_COMMAND_SYNTAX_ERROR;
 512                         goto done;
 513         }
 514
 515         chunk_count = MIN(count, (chunksize / wordsize));
 516         switch (wordsize) {
 517                 case 4:
 518                         for (i = 0; i < chunk_count; i++)
 519                                 target_buffer_set_u32(target, chunk + i * wordsize, pattern);
 520                         break;
 521                 case 2:
 522                         for (i = 0; i < chunk_count; i++)
 523                                 target_buffer_set_u16(target, chunk + i * wordsize, pattern);
 524                         break;
 525                 case 1:
 526                         memset(chunk, pattern, chunk_count);
 527                         break;
 528                 default:
 529                         LOG_ERROR("BUG: can't happen");
 530                         exit(-1);
 531         }
 532
 533         struct duration bench;
 534         duration_start(&bench);
 535
 536         for (wrote = 0; wrote < (count*wordsize); wrote += cur_size) {
 537                 struct flash_bank *bank;
 538
 539                 retval = get_flash_bank_by_addr(target, address, true, &bank);
 540                 if (retval != ERROR_OK)
 541                         goto done;
 542
 543                 cur_size = MIN((count * wordsize - wrote), chunksize);
 544                 err = flash_driver_write(bank, chunk, address - bank->base + wrote, cur_size);
 545                 if (err != ERROR_OK) {
 546                         retval = err;
 547                         goto done;
 548                 }
 549
 550                 err = flash_driver_read(bank, readback, address - bank->base + wrote, cur_size);
 551                 if (err != ERROR_OK) {
 552                         retval = err;
 553                         goto done;
 554                 }
 555
 556                 for (i = 0; i < cur_size; i++) {
 557                         if (readback[i] != chunk[i]) {
 558                                 LOG_ERROR(
 559                                         "Verification error address 0x%08" PRIx32 ", read back 0x%02x, expected 0x%02x",
 560                                         address + wrote + i,
 561                                         readback[i],
 562                                         chunk[i]);
 563                                 retval = ERROR_FAIL;
 564                                 goto done;
 565                         }
 566                 }
 567         }
 568
 569         if ((retval == ERROR_OK) && (duration_measure(&bench) == ERROR_OK)) {
 570                 command_print(CMD_CTX, "wrote %" PRIu32 " bytes to 0x%8.8" PRIx32
 571                         " in %fs (%0.3f KiB/s)", wrote, address,
 572                         duration_elapsed(&bench), duration_kbps(&bench, wrote));
 573         }
 574
 575 done:
 576         free(readback);
 577         free(chunk);
 578
 579         return retval;
 580 }
 581
 582 COMMAND_HANDLER(handle_flash_write_bank_command)
 583 {
 584         uint32_t offset;
 585         uint8_t *buffer;
 586         struct fileio *fileio;
 587
 588         if (CMD_ARGC < 2 || CMD_ARGC > 3)
 589                 return ERROR_COMMAND_SYNTAX_ERROR;
 590
 591         struct duration bench;
 592         duration_start(&bench);
 593
 594         struct flash_bank *p;
 595         int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
 596         if (ERROR_OK != retval)
 597                 return retval;
 598
 599         offset = 0;
 600
 601         if (CMD_ARGC > 2)
 602                 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset);
 603
 604         if (offset > p->size) {
 605                 LOG_ERROR("Offset 0x%8.8" PRIx32 " is out of range of the flash bank",
 606                         offset);
 607                 return ERROR_COMMAND_ARGUMENT_INVALID;
 608         }
 609
 610         if (fileio_open(&fileio, CMD_ARGV[1], FILEIO_READ, FILEIO_BINARY) != ERROR_OK)
 611                 return ERROR_FAIL;
 612
 613         size_t filesize;
 614         retval = fileio_size(fileio, &filesize);
 615         if (retval != ERROR_OK) {
 616                 fileio_close(fileio);
 617                 return retval;
 618         }
 619
 620         buffer = malloc(filesize);
 621         if (buffer == NULL) {
 622                 fileio_close(fileio);
 623                 LOG_ERROR("Out of memory");
 624                 return ERROR_FAIL;
 625         }
 626         size_t buf_cnt;
 627         if (fileio_read(fileio, filesize, buffer, &buf_cnt) != ERROR_OK) {
 628                 free(buffer);
 629                 fileio_close(fileio);
 630                 return ERROR_FAIL;
 631         }
 632
 633         retval = flash_driver_write(p, buffer, offset, buf_cnt);
 634
 635         free(buffer);
 636         buffer = NULL;
 637
 638         if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
 639                 command_print(CMD_CTX, "wrote %zu bytes from file %s to flash bank %u"
 640                         " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)",
 641                         filesize, CMD_ARGV[1], p->bank_number, offset,
 642                         duration_elapsed(&bench), duration_kbps(&bench, filesize));
 643         }
 644
 645         fileio_close(fileio);
 646
 647         return retval;
 648 }
 649
 650 COMMAND_HANDLER(handle_flash_read_bank_command)
 651 {
 652         uint32_t offset;
 653         uint8_t *buffer;
 654         struct fileio *fileio;
 655         uint32_t length;
 656         size_t written;
 657
 658         if (CMD_ARGC != 4)
 659                 return ERROR_COMMAND_SYNTAX_ERROR;
 660
 661         struct duration bench;
 662         duration_start(&bench);
 663
 664         struct flash_bank *p;
 665         int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
 666         if (ERROR_OK != retval)
 667                 return retval;
 668
 669         COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset);
 670         COMMAND_PARSE_NUMBER(u32, CMD_ARGV[3], length);
 671
 672         buffer = malloc(length);
 673         if (buffer == NULL) {
 674                 LOG_ERROR("Out of memory");
 675                 return ERROR_FAIL;
 676         }
 677
 678         retval = flash_driver_read(p, buffer, offset, length);
 679         if (retval != ERROR_OK) {
 680                 LOG_ERROR("Read error");
 681                 free(buffer);
 682                 return retval;
 683         }
 684
 685         retval = fileio_open(&fileio, CMD_ARGV[1], FILEIO_WRITE, FILEIO_BINARY);
 686         if (retval != ERROR_OK) {
 687                 LOG_ERROR("Could not open file");
 688                 free(buffer);
 689                 return retval;
 690         }
 691
 692         retval = fileio_write(fileio, length, buffer, &written);
 693         fileio_close(fileio);
 694         free(buffer);
 695         if (retval != ERROR_OK) {
 696                 LOG_ERROR("Could not write file");
 697                 return ERROR_FAIL;
 698         }
 699
 700         if (duration_measure(&bench) == ERROR_OK)
 701                 command_print(CMD_CTX, "wrote %zd bytes to file %s from flash bank %u"
 702                         " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)",
 703                         written, CMD_ARGV[1], p->bank_number, offset,
 704                         duration_elapsed(&bench), duration_kbps(&bench, written));
 705
 706         return retval;
 707 }
 708
 709
 710 COMMAND_HANDLER(handle_flash_verify_bank_command)
 711 {
 712         uint32_t offset;
 713         uint8_t *buffer_file, *buffer_flash;
 714         struct fileio *fileio;
 715         size_t read_cnt;
 716         size_t filesize;
 717         size_t length;
 718         int differ;
 719
 720         if (CMD_ARGC < 2 || CMD_ARGC > 3)
 721                 return ERROR_COMMAND_SYNTAX_ERROR;
 722
 723         struct duration bench;
 724         duration_start(&bench);
 725
 726         struct flash_bank *p;
 727         int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
 728         if (ERROR_OK != retval)
 729                 return retval;
 730
 731         offset = 0;
 732
 733         if (CMD_ARGC > 2)
 734                 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset);
 735
 736         if (offset > p->size) {
 737                 LOG_ERROR("Offset 0x%8.8" PRIx32 " is out of range of the flash bank",
 738                         offset);
 739                 return ERROR_COMMAND_ARGUMENT_INVALID;
 740         }
 741
 742         retval = fileio_open(&fileio, CMD_ARGV[1], FILEIO_READ, FILEIO_BINARY);
 743         if (retval != ERROR_OK) {
 744                 LOG_ERROR("Could not open file");
 745                 return retval;
 746         }
 747
 748         retval = fileio_size(fileio, &filesize);
 749         if (retval != ERROR_OK) {
 750                 fileio_close(fileio);
 751                 return retval;
 752         }
 753
 754         length = MIN(filesize, p->size - offset);
 755
 756         if (!length) {
 757                 LOG_INFO("Nothing to compare with flash bank");
 758                 fileio_close(fileio);
 759                 return ERROR_OK;
 760         }
 761
 762         if (length != filesize)
 763                 LOG_INFO("File content exceeds flash bank size. Only comparing the "
 764                         "first %zu bytes of the file", length);
 765
 766         buffer_file = malloc(length);
 767         if (buffer_file == NULL) {
 768                 LOG_ERROR("Out of memory");
 769                 fileio_close(fileio);
 770                 return ERROR_FAIL;
 771         }
 772
 773         retval = fileio_read(fileio, length, buffer_file, &read_cnt);
 774         fileio_close(fileio);
 775         if (retval != ERROR_OK) {
 776                 LOG_ERROR("File read failure");
 777                 free(buffer_file);
 778                 return retval;
 779         }
 780
 781         if (read_cnt != length) {
 782                 LOG_ERROR("Short read");
 783                 free(buffer_file);
 784                 return ERROR_FAIL;
 785         }
 786
 787         buffer_flash = malloc(length);
 788         if (buffer_flash == NULL) {
 789                 LOG_ERROR("Out of memory");
 790                 free(buffer_file);
 791                 return ERROR_FAIL;
 792         }
 793
 794         retval = flash_driver_read(p, buffer_flash, offset, length);
 795         if (retval != ERROR_OK) {
 796                 LOG_ERROR("Flash read error");
 797                 free(buffer_flash);
 798                 free(buffer_file);
 799                 return retval;
 800         }
 801
 802         if (duration_measure(&bench) == ERROR_OK)
 803                 command_print(CMD_CTX, "read %zd bytes from file %s and flash bank %u"
 804                         " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)",
 805                         length, CMD_ARGV[1], p->bank_number, offset,
 806                         duration_elapsed(&bench), duration_kbps(&bench, length));
 807
 808         differ = memcmp(buffer_file, buffer_flash, length);
 809         command_print(CMD_CTX, "contents %s", differ ? "differ" : "match");
 810         if (differ) {
 811                 uint32_t t;
 812                 int diffs = 0;
 813                 for (t = 0; t < length; t++) {
 814                         if (buffer_flash[t] == buffer_file[t])
 815                                 continue;
 816                         command_print(CMD_CTX, "diff %d address 0x%08x. Was 0x%02x instead of 0x%02x",
 817                                         diffs, t + offset, buffer_flash[t], buffer_file[t]);
 818                         if (diffs++ >= 127) {
 819                                 command_print(CMD_CTX, "More than 128 errors, the rest are not printed.");
 820                                 break;
 821                         }
 822                         keep_alive();
 823                 }
 824         }
 825         free(buffer_flash);
 826         free(buffer_file);
 827
 828         return differ ? ERROR_FAIL : ERROR_OK;
 829 }
 830
 831 void flash_set_dirty(void)
 832 {
 833         struct flash_bank *c;
 834         int i;
 835
 836         /* set all flash to require erasing */
 837         for (c = flash_bank_list(); c; c = c->next) {
 838                 for (i = 0; i < c->num_sectors; i++)
 839                         c->sectors[i].is_erased = 0;
 840         }
 841 }
 842
 843 COMMAND_HANDLER(handle_flash_padded_value_command)
 844 {
 845         if (CMD_ARGC != 2)
 846                 return ERROR_COMMAND_SYNTAX_ERROR;
 847
 848         struct flash_bank *p;
 849         int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
 850         if (ERROR_OK != retval)
 851                 return retval;
 852
 853         COMMAND_PARSE_NUMBER(u8, CMD_ARGV[1], p->default_padded_value);
 854
 855         command_print(CMD_CTX, "Default padded value set to 0x%" PRIx8 " for flash bank %u", \
 856                         p->default_padded_value, p->bank_number);
 857
 858         return retval;
 859 }
 860
 861 static const struct command_registration flash_exec_command_handlers[] = {
 862         {
 863                 .name = "probe",
 864                 .handler = handle_flash_probe_command,
 865                 .mode = COMMAND_EXEC,
 866                 .usage = "bank_id",
 867                 .help = "Identify a flash bank.",
 868         },
 869         {
 870                 .name = "info",
 871                 .handler = handle_flash_info_command,
 872                 .mode = COMMAND_EXEC,
 873                 .usage = "bank_id ['sectors']",
 874                 .help = "Print information about a flash bank.",
 875         },
 876         {
 877                 .name = "erase_check",
 878                 .handler = handle_flash_erase_check_command,
 879                 .mode = COMMAND_EXEC,
 880                 .usage = "bank_id",
 881                 .help = "Check erase state of all blocks in a "
 882                         "flash bank.",
 883         },
 884         {
 885                 .name = "erase_sector",
 886                 .handler = handle_flash_erase_command,
 887                 .mode = COMMAND_EXEC,
 888                 .usage = "bank_id first_sector_num last_sector_num",
 889                 .help = "Erase a range of sectors in a flash bank.",
 890         },
 891         {
 892                 .name = "erase_address",
 893                 .handler = handle_flash_erase_address_command,
 894                 .mode = COMMAND_EXEC,
 895                 .usage = "['pad'] ['unlock'] address length",
 896                 .help = "Erase flash sectors starting at address and "
 897                         "continuing for length bytes.  If 'pad' is specified, "
 898                         "data outside that range may also be erased: the start "
 899                         "address may be decreased, and length increased, so "
 900                         "that all of the first and last sectors are erased. "
 901                         "If 'unlock' is specified, then the flash is unprotected "
 902                         "before erasing.",
 903
 904         },
 905         {
 906                 .name = "fillw",
 907                 .handler = handle_flash_fill_command,
 908                 .mode = COMMAND_EXEC,
 909                 .usage = "address value n",
 910                 .help = "Fill n words with 32-bit value, starting at "
 911                         "word address.  (No autoerase.)",
 912         },
 913         {
 914                 .name = "fillh",
 915                 .handler = handle_flash_fill_command,
 916                 .mode = COMMAND_EXEC,
 917                 .usage = "address value n",
 918                 .help = "Fill n halfwords with 16-bit value, starting at "
 919                         "word address.  (No autoerase.)",
 920         },
 921         {
 922                 .name = "fillb",
 923                 .handler = handle_flash_fill_command,
 924                 .mode = COMMAND_EXEC,
 925                 .usage = "address value n",
 926                 .help = "Fill n bytes with 8-bit value, starting at "
 927                         "word address.  (No autoerase.)",
 928         },
 929         {
 930                 .name = "write_bank",
 931                 .handler = handle_flash_write_bank_command,
 932                 .mode = COMMAND_EXEC,
 933                 .usage = "bank_id filename [offset]",
 934                 .help = "Write binary data from file to flash bank. Allow optional "
 935                         "offset from beginning of the bank (defaults to zero).",
 936         },
 937         {
 938                 .name = "write_image",
 939                 .handler = handle_flash_write_image_command,
 940                 .mode = COMMAND_EXEC,
 941                 .usage = "[erase] [unlock] filename [offset [file_type]]",
 942                 .help = "Write an image to flash.  Optionally first unprotect "
 943                         "and/or erase the region to be used.  Allow optional "
 944                         "offset from beginning of bank (defaults to zero)",
 945         },
 946         {
 947                 .name = "read_bank",
 948                 .handler = handle_flash_read_bank_command,
 949                 .mode = COMMAND_EXEC,
 950                 .usage = "bank_id filename offset length",
 951                 .help = "Read binary data from flash bank to file, "
 952                         "starting at specified byte offset from the "
 953                         "beginning of the bank.",
 954         },
 955         {
 956                 .name = "verify_bank",
 957                 .handler = handle_flash_verify_bank_command,
 958                 .mode = COMMAND_EXEC,
 959                 .usage = "bank_id filename [offset]",
 960                 .help = "Compare the contents of a file with the contents of the "
 961                         "flash bank. Allow optional offset from beginning of the bank "
 962                         "(defaults to zero).",
 963         },
 964         {
 965                 .name = "protect",
 966                 .handler = handle_flash_protect_command,
 967                 .mode = COMMAND_EXEC,
 968                 .usage = "bank_id first_block [last_block|'last'] "
 969                         "('on'|'off')",
 970                 .help = "Turn protection on or off for a range of protection "
 971                         "blocks or sectors in a given flash bank. "
 972                         "See 'flash info' output for a list of blocks.",
 973         },
 974         {
 975                 .name = "padded_value",
 976                 .handler = handle_flash_padded_value_command,
 977                 .mode = COMMAND_EXEC,
 978                 .usage = "bank_id value",
 979                 .help = "Set default flash padded value",
 980         },
 981         COMMAND_REGISTRATION_DONE
 982 };
 983
 984 static int flash_init_drivers(struct command_context *cmd_ctx)
 985 {
 986         if (!flash_bank_list())
 987                 return ERROR_OK;
 988
 989         struct command *parent = command_find_in_context(cmd_ctx, "flash");
 990         return register_commands(cmd_ctx, parent, flash_exec_command_handlers);
 991 }
 992
 993 COMMAND_HANDLER(handle_flash_bank_command)
 994 {
 995         if (CMD_ARGC < 7) {
 996                 LOG_ERROR("usage: flash bank <name> <driver> "
 997                         "<base> <size> <chip_width> <bus_width> <target>");
 998                 return ERROR_COMMAND_SYNTAX_ERROR;
 999         }
1000         /* save bank name and advance arguments for compatibility */
1001         const char *bank_name = *CMD_ARGV++;
1002         CMD_ARGC--;
1003
1004         struct target *target = get_target(CMD_ARGV[5]);
1005         if (target == NULL) {
1006                 LOG_ERROR("target '%s' not defined", CMD_ARGV[5]);
1007                 return ERROR_FAIL;
1008         }
1009
1010         const char *driver_name = CMD_ARGV[0];
1011         struct flash_driver *driver = flash_driver_find_by_name(driver_name);
1012         if (NULL == driver) {
1013                 /* no matching flash driver found */
1014                 LOG_ERROR("flash driver '%s' not found", driver_name);
1015                 return ERROR_FAIL;
1016         }
1017
1018         /* check the flash bank name is unique */
1019         if (get_flash_bank_by_name_noprobe(bank_name) != NULL) {
1020                 /* flash bank name already exists  */
1021                 LOG_ERROR("flash bank name '%s' already exists", bank_name);
1022                 return ERROR_FAIL;
1023         }
1024
1025         /* register flash specific commands */
1026         if (NULL != driver->commands) {
1027                 int retval = register_commands(CMD_CTX, NULL,
1028                                 driver->commands);
1029                 if (ERROR_OK != retval) {
1030                         LOG_ERROR("couldn't register '%s' commands",
1031                                 driver_name);
1032                         return ERROR_FAIL;
1033                 }
1034         }
1035
1036         struct flash_bank *c = malloc(sizeof(*c));
1037         c->name = strdup(bank_name);
1038         c->target = target;
1039         c->driver = driver;
1040         c->driver_priv = NULL;
1041         COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], c->base);
1042         COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], c->size);
1043         COMMAND_PARSE_NUMBER(int, CMD_ARGV[3], c->chip_width);
1044         COMMAND_PARSE_NUMBER(int, CMD_ARGV[4], c->bus_width);
1045         c->default_padded_value = c->erased_value = 0xff;
1046         c->num_sectors = 0;
1047         c->sectors = NULL;
1048         c->num_prot_blocks = 0;
1049         c->prot_blocks = NULL;
1050         c->next = NULL;
1051
1052         int retval;
1053         retval = CALL_COMMAND_HANDLER(driver->flash_bank_command, c);
1054         if (ERROR_OK != retval) {
1055                 LOG_ERROR("'%s' driver rejected flash bank at 0x%8.8" PRIx32 "; usage: %s",
1056                         driver_name, c->base, driver->usage);
1057                 free(c);
1058                 return retval;
1059         }
1060
1061         if (driver->usage == NULL)
1062                 LOG_DEBUG("'%s' driver usage field missing", driver_name);
1063
1064         flash_bank_add(c);
1065
1066         return ERROR_OK;
1067 }
1068
1069 COMMAND_HANDLER(handle_flash_banks_command)
1070 {
1071         if (CMD_ARGC != 0)
1072                 return ERROR_COMMAND_SYNTAX_ERROR;
1073
1074         unsigned n = 0;
1075         for (struct flash_bank *p = flash_bank_list(); p; p = p->next, n++) {
1076                 LOG_USER("#%d : %s (%s) at 0x%8.8" PRIx32 ", size 0x%8.8" PRIx32 ", "
1077                         "buswidth %u, chipwidth %u", p->bank_number,
1078                         p->name, p->driver->name, p->base, p->size,
1079                         p->bus_width, p->chip_width);
1080         }
1081         return ERROR_OK;
1082 }
1083
1084 static int jim_flash_list(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
1085 {
1086         if (argc != 1) {
1087                 Jim_WrongNumArgs(interp, 1, argv,
1088                         "no arguments to 'flash list' command");
1089                 return JIM_ERR;
1090         }
1091
1092         Jim_Obj *list = Jim_NewListObj(interp, NULL, 0);
1093
1094         for (struct flash_bank *p = flash_bank_list(); p; p = p->next) {
1095                 Jim_Obj *elem = Jim_NewListObj(interp, NULL, 0);
1096
1097                 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "name", -1));
1098                 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, p->driver->name, -1));
1099                 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "base", -1));
1100                 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->base));
1101                 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "size", -1));
1102                 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->size));
1103                 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "bus_width", -1));
1104                 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->bus_width));
1105                 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "chip_width", -1));
1106                 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->chip_width));
1107
1108                 Jim_ListAppendElement(interp, list, elem);
1109         }
1110
1111         Jim_SetResult(interp, list);
1112
1113         return JIM_OK;
1114 }
1115
1116 COMMAND_HANDLER(handle_flash_init_command)
1117 {
1118         if (CMD_ARGC != 0)
1119                 return ERROR_COMMAND_SYNTAX_ERROR;
1120
1121         static bool flash_initialized;
1122         if (flash_initialized) {
1123                 LOG_INFO("'flash init' has already been called");
1124                 return ERROR_OK;
1125         }
1126         flash_initialized = true;
1127
1128         LOG_DEBUG("Initializing flash devices...");
1129         return flash_init_drivers(CMD_CTX);
1130 }
1131
1132 static const struct command_registration flash_config_command_handlers[] = {
1133         {
1134                 .name = "bank",
1135                 .handler = handle_flash_bank_command,
1136                 .mode = COMMAND_CONFIG,
1137                 .usage = "bank_id driver_name base_address size_bytes "
1138                         "chip_width_bytes bus_width_bytes target "
1139                         "[driver_options ...]",
1140                 .help = "Define a new bank with the given name, "
1141                         "using the specified NOR flash driver.",
1142         },
1143         {
1144                 .name = "init",
1145                 .mode = COMMAND_CONFIG,
1146                 .handler = handle_flash_init_command,
1147                 .help = "Initialize flash devices.",
1148         },
1149         {
1150                 .name = "banks",
1151                 .mode = COMMAND_ANY,
1152                 .handler = handle_flash_banks_command,
1153                 .help = "Display table with information about flash banks.",
1154         },
1155         {
1156                 .name = "list",
1157                 .mode = COMMAND_ANY,
1158                 .jim_handler = jim_flash_list,
1159                 .help = "Returns a list of details about the flash banks.",
1160         },
1161         COMMAND_REGISTRATION_DONE
1162 };
1163 static const struct command_registration flash_command_handlers[] = {
1164         {
1165                 .name = "flash",
1166                 .mode = COMMAND_ANY,
1167                 .help = "NOR flash command group",
1168                 .chain = flash_config_command_handlers,
1169         },
1170         COMMAND_REGISTRATION_DONE
1171 };
1172
1173 int flash_register_commands(struct command_context *cmd_ctx)
1174 {
1175         return register_commands(cmd_ctx, NULL, flash_command_handlers);
1176 }