git.gag.com Git - fw/openocd/blob - src/flash/nor/lpc2900.c

   1 /***************************************************************************
   2  *   Copyright (C) 2009 by                                                 *
   3  *   Rolf Meeser <rolfm_9dq@yahoo.de>                                      *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20
  21 #ifdef HAVE_CONFIG_H
  22 #include "config.h"
  23 #endif
  24
  25
  26 #include "imp.h"
  27 #include <helper/binarybuffer.h>
  28 #include <target/algorithm.h>
  29 #include <target/arm.h>
  30 #include <target/image.h>
  31
  32
  33 /* 1024 bytes */
  34 #define KiB                 1024
  35
  36 /* Some flash constants */
  37 #define FLASH_PAGE_SIZE     512     /* bytes */
  38 #define FLASH_ERASE_TIME    100000  /* microseconds */
  39 #define FLASH_PROGRAM_TIME  1000    /* microseconds */
  40
  41 /* Chip ID / Feature Registers */
  42 #define CHIPID          0xE0000000  /* Chip ID */
  43 #define FEAT0           0xE0000100  /* Chip feature 0 */
  44 #define FEAT1           0xE0000104  /* Chip feature 1 */
  45 #define FEAT2           0xE0000108  /* Chip feature 2 (contains flash size indicator) */
  46 #define FEAT3           0xE000010C  /* Chip feature 3 */
  47
  48 #define EXPECTED_CHIPID 0x209CE02B  /* Chip ID of all LPC2900 devices */
  49
  50 /* Flash/EEPROM Control Registers */
  51 #define FCTR            0x20200000  /* Flash control */
  52 #define FPTR            0x20200008  /* Flash program-time */
  53 #define FTCTR           0x2020000C  /* Flash test control */
  54 #define FBWST           0x20200010  /* Flash bridge wait-state */
  55 #define FCRA            0x2020001C  /* Flash clock divider */
  56 #define FMSSTART        0x20200020  /* Flash Built-In Selft Test start address */
  57 #define FMSSTOP         0x20200024  /* Flash Built-In Selft Test stop address */
  58 #define FMS16           0x20200028  /* Flash 16-bit signature */
  59 #define FMSW0           0x2020002C  /* Flash 128-bit signature Word 0 */
  60 #define FMSW1           0x20200030  /* Flash 128-bit signature Word 1 */
  61 #define FMSW2           0x20200034  /* Flash 128-bit signature Word 2 */
  62 #define FMSW3           0x20200038  /* Flash 128-bit signature Word 3 */
  63
  64 #define EECMD           0x20200080  /* EEPROM command */
  65 #define EEADDR          0x20200084  /* EEPROM address */
  66 #define EEWDATA         0x20200088  /* EEPROM write data */
  67 #define EERDATA         0x2020008C  /* EEPROM read data */
  68 #define EEWSTATE        0x20200090  /* EEPROM wait state */
  69 #define EECLKDIV        0x20200094  /* EEPROM clock divider */
  70 #define EEPWRDWN        0x20200098  /* EEPROM power-down/start */
  71 #define EEMSSTART       0x2020009C  /* EEPROM BIST start address */
  72 #define EEMSSTOP        0x202000A0  /* EEPROM BIST stop address */
  73 #define EEMSSIG         0x202000A4  /* EEPROM 24-bit BIST signature */
  74
  75 #define INT_CLR_ENABLE  0x20200FD8  /* Flash/EEPROM interrupt clear enable */
  76 #define INT_SET_ENABLE  0x20200FDC  /* Flash/EEPROM interrupt set enable */
  77 #define INT_STATUS      0x20200FE0  /* Flash/EEPROM interrupt status */
  78 #define INT_ENABLE      0x20200FE4  /* Flash/EEPROM interrupt enable */
  79 #define INT_CLR_STATUS  0x20200FE8  /* Flash/EEPROM interrupt clear status */
  80 #define INT_SET_STATUS  0x20200FEC  /* Flash/EEPROM interrupt set status */
  81
  82 /* Interrupt sources */
  83 #define INTSRC_END_OF_PROG    (1 << 28)
  84 #define INTSRC_END_OF_BIST    (1 << 27)
  85 #define INTSRC_END_OF_RDWR    (1 << 26)
  86 #define INTSRC_END_OF_MISR    (1 << 2)
  87 #define INTSRC_END_OF_BURN    (1 << 1)
  88 #define INTSRC_END_OF_ERASE   (1 << 0)
  89
  90
  91 /* FCTR bits */
  92 #define FCTR_FS_LOADREQ       (1 << 15)
  93 #define FCTR_FS_CACHECLR      (1 << 14)
  94 #define FCTR_FS_CACHEBYP      (1 << 13)
  95 #define FCTR_FS_PROGREQ       (1 << 12)
  96 #define FCTR_FS_RLS           (1 << 11)
  97 #define FCTR_FS_PDL           (1 << 10)
  98 #define FCTR_FS_PD            (1 << 9)
  99 #define FCTR_FS_WPB           (1 << 7)
 100 #define FCTR_FS_ISS           (1 << 6)
 101 #define FCTR_FS_RLD           (1 << 5)
 102 #define FCTR_FS_DCR           (1 << 4)
 103 #define FCTR_FS_WEB           (1 << 2)
 104 #define FCTR_FS_WRE           (1 << 1)
 105 #define FCTR_FS_CS            (1 << 0)
 106 /* FPTR bits */
 107 #define FPTR_EN_T             (1 << 15)
 108 /* FTCTR bits */
 109 #define FTCTR_FS_BYPASS_R     (1 << 29)
 110 #define FTCTR_FS_BYPASS_W     (1 << 28)
 111 /* FMSSTOP bits */
 112 #define FMSSTOP_MISR_START    (1 << 17)
 113 /* EEMSSTOP bits */
 114 #define EEMSSTOP_STRTBIST     (1 << 31)
 115
 116 /* Index sector */
 117 #define ISS_CUSTOMER_START1   (0x830)
 118 #define ISS_CUSTOMER_END1     (0xA00)
 119 #define ISS_CUSTOMER_SIZE1    (ISS_CUSTOMER_END1 - ISS_CUSTOMER_START1)
 120 #define ISS_CUSTOMER_NWORDS1  (ISS_CUSTOMER_SIZE1 / 4)
 121 #define ISS_CUSTOMER_START2   (0xA40)
 122 #define ISS_CUSTOMER_END2     (0xC00)
 123 #define ISS_CUSTOMER_SIZE2    (ISS_CUSTOMER_END2 - ISS_CUSTOMER_START2)
 124 #define ISS_CUSTOMER_NWORDS2  (ISS_CUSTOMER_SIZE2 / 4)
 125 #define ISS_CUSTOMER_SIZE     (ISS_CUSTOMER_SIZE1 + ISS_CUSTOMER_SIZE2)
 126
 127
 128
 129 /**
 130  * Private data for \c lpc2900 flash driver.
 131  */
 132 struct lpc2900_flash_bank
 133 {
 134         /**
 135          * This flag is set when the device has been successfully probed.
 136          */
 137         bool is_probed;
 138
 139         /**
 140          * Holds the value read from CHIPID register.
 141          * The driver will not load if the chipid doesn't match the expected
 142          * value of 0x209CE02B of the LPC2900 family. A probe will only be done
 143          * if the chipid does not yet contain the expected value.
 144          */
 145         uint32_t chipid;
 146
 147         /**
 148          * String holding device name.
 149          * This string is set by the probe function to the type number of the
 150          * device. It takes the form "LPC29xx".
 151          */
 152         char * target_name;
 153
 154         /**
 155          * System clock frequency.
 156          * Holds the clock frequency in Hz, as passed by the configuration file
 157          * to the <tt>flash bank</tt> command.
 158          */
 159         uint32_t clk_sys_fmc;
 160
 161         /**
 162          * Flag to indicate that dangerous operations are possible.
 163          * This flag can be set by passing the correct password to the
 164          * <tt>lpc2900 password</tt> command. If set, other dangerous commands,
 165          * which operate on the index sector, can be executed.
 166          */
 167         uint32_t risky;
 168
 169         /**
 170          * Maximum contiguous block of internal SRAM (bytes).
 171          * Autodetected by the driver. Not the total amount of SRAM, only the
 172          * the largest \em contiguous block!
 173          */
 174         uint32_t max_ram_block;
 175
 176 };
 177
 178
 179 static uint32_t lpc2900_wait_status(struct flash_bank *bank, uint32_t mask, int timeout);
 180 static void lpc2900_setup(struct flash_bank *bank);
 181 static uint32_t lpc2900_is_ready(struct flash_bank *bank);
 182 static uint32_t lpc2900_read_security_status(struct flash_bank *bank);
 183 static uint32_t lpc2900_run_bist128(struct flash_bank *bank,
 184                                     uint32_t addr_from, uint32_t addr_to,
 185                                     uint32_t (*signature)[4] );
 186 static uint32_t lpc2900_address2sector(struct flash_bank *bank, uint32_t offset);
 187 static uint32_t lpc2900_calc_tr(uint32_t clock_var, uint32_t time_var);
 188
 189
 190 /***********************  Helper functions  **************************/
 191
 192
 193 /**
 194  * Wait for an event in mask to occur in INT_STATUS.
 195  *
 196  * Return when an event occurs, or after a timeout.
 197  *
 198  * @param[in] bank Pointer to the flash bank descriptor
 199  * @param[in] mask Mask to be used for INT_STATUS
 200  * @param[in] timeout Timeout in ms
 201  */
 202 static uint32_t lpc2900_wait_status( struct flash_bank *bank,
 203                                      uint32_t mask,
 204                                      int timeout )
 205 {
 206         uint32_t int_status;
 207         struct target *target = bank->target;
 208
 209
 210         do
 211         {
 212                 alive_sleep(1);
 213                 timeout--;
 214                 target_read_u32(target, INT_STATUS, &int_status);
 215         }
 216         while( ((int_status & mask) == 0) && (timeout != 0) );
 217
 218         if (timeout == 0)
 219         {
 220                 LOG_DEBUG("Timeout!");
 221                 return ERROR_FLASH_OPERATION_FAILED;
 222         }
 223
 224         return ERROR_OK;
 225 }
 226
 227
 228
 229 /**
 230  * Set up the flash for erase/program operations.
 231  *
 232  * Enable the flash, and set the correct CRA clock of 66 kHz.
 233  *
 234  * @param bank Pointer to the flash bank descriptor
 235  */
 236 static void lpc2900_setup( struct flash_bank *bank )
 237 {
 238         uint32_t fcra;
 239         struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
 240
 241
 242         /* Power up the flash block */
 243         target_write_u32( bank->target, FCTR, FCTR_FS_WEB | FCTR_FS_CS );
 244
 245
 246         fcra = (lpc2900_info->clk_sys_fmc / (3 * 66000)) - 1;
 247         target_write_u32( bank->target, FCRA, fcra );
 248 }
 249
 250
 251
 252 /**
 253  * Check if device is ready.
 254  *
 255  * Check if device is ready for flash operation:
 256  * Must have been successfully probed.
 257  * Must be halted.
 258  */
 259 static uint32_t lpc2900_is_ready( struct flash_bank *bank )
 260 {
 261         struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
 262
 263         if( !lpc2900_info->is_probed )
 264         {
 265                 return ERROR_FLASH_BANK_NOT_PROBED;
 266         }
 267
 268         if( bank->target->state != TARGET_HALTED )
 269         {
 270                 LOG_ERROR( "Target not halted" );
 271                 return ERROR_TARGET_NOT_HALTED;
 272         }
 273
 274         return ERROR_OK;
 275 }
 276
 277
 278 /**
 279  * Read the status of sector security from the index sector.
 280  *
 281  * @param bank Pointer to the flash bank descriptor
 282  */
 283 static uint32_t lpc2900_read_security_status( struct flash_bank *bank )
 284 {
 285         uint32_t status;
 286         if( (status = lpc2900_is_ready( bank )) != ERROR_OK )
 287         {
 288                 return status;
 289         }
 290
 291         struct target *target = bank->target;
 292
 293         /* Enable ISS access */
 294         target_write_u32(target, FCTR, FCTR_FS_CS | FCTR_FS_WEB | FCTR_FS_ISS);
 295
 296         /* Read the relevant block of memory from the ISS sector */
 297         uint32_t iss_secured_field[ 0x230/16 ][ 4 ];
 298         target_read_memory(target, bank->base + 0xC00, 4, 0x230/4,
 299                                    (uint8_t *)iss_secured_field);
 300
 301         /* Disable ISS access */
 302         target_write_u32(target, FCTR, FCTR_FS_CS | FCTR_FS_WEB);
 303
 304         /* Check status of each sector. Note that the sector numbering in the LPC2900
 305          * is different from the logical sector numbers used in OpenOCD!
 306          * Refer to the user manual for details.
 307          *
 308          * All zeros (16x 0x00) are treated as a secured sector (is_protected = 1)
 309          * All ones (16x 0xFF) are treated as a non-secured sector (is_protected = 0)
 310          * Anything else is undefined (is_protected = -1). This is treated as
 311          * a protected sector!
 312          */
 313         int sector;
 314         int index_t;
 315         for( sector = 0; sector < bank->num_sectors; sector++ )
 316         {
 317                 /* Convert logical sector number to physical sector number */
 318                 if( sector <= 4 )
 319                 {
 320                         index_t = sector + 11;
 321                 }
 322                 else if( sector <= 7 )
 323                 {
 324                         index_t = sector + 27;
 325                 }
 326                 else
 327                 {
 328                         index_t = sector - 8;
 329                 }
 330
 331                 bank->sectors[sector].is_protected = -1;
 332
 333                 if (
 334                     (iss_secured_field[index_t][0] == 0x00000000) &&
 335                     (iss_secured_field[index_t][1] == 0x00000000) &&
 336                     (iss_secured_field[index_t][2] == 0x00000000) &&
 337                     (iss_secured_field[index_t][3] == 0x00000000) )
 338                 {
 339                         bank->sectors[sector].is_protected = 1;
 340                 }
 341
 342                 if (
 343                     (iss_secured_field[index_t][0] == 0xFFFFFFFF) &&
 344                     (iss_secured_field[index_t][1] == 0xFFFFFFFF) &&
 345                     (iss_secured_field[index_t][2] == 0xFFFFFFFF) &&
 346                     (iss_secured_field[index_t][3] == 0xFFFFFFFF) )
 347                 {
 348                         bank->sectors[sector].is_protected = 0;
 349                 }
 350         }
 351
 352         return ERROR_OK;
 353 }
 354
 355
 356 /**
 357  * Use BIST to calculate a 128-bit hash value over a range of flash.
 358  *
 359  * @param bank Pointer to the flash bank descriptor
 360  * @param addr_from
 361  * @param addr_to
 362  * @param signature
 363  */
 364 static uint32_t lpc2900_run_bist128(struct flash_bank *bank,
 365                                     uint32_t addr_from,
 366                                     uint32_t addr_to,
 367                                     uint32_t (*signature)[4] )
 368 {
 369         struct target *target = bank->target;
 370
 371         /* Clear END_OF_MISR interrupt status */
 372         target_write_u32( target, INT_CLR_STATUS, INTSRC_END_OF_MISR );
 373
 374         /* Start address */
 375         target_write_u32( target, FMSSTART, addr_from >> 4);
 376         /* End address, and issue start command */
 377         target_write_u32( target, FMSSTOP, (addr_to >> 4) | FMSSTOP_MISR_START );
 378
 379         /* Poll for end of operation. Calculate a reasonable timeout. */
 380         if( lpc2900_wait_status( bank, INTSRC_END_OF_MISR, 1000 ) != ERROR_OK )
 381         {
 382                 return ERROR_FLASH_OPERATION_FAILED;
 383         }
 384
 385         /* Return the signature */
 386         target_read_memory( target, FMSW0, 4, 4, (uint8_t *)signature );
 387
 388         return ERROR_OK;
 389 }
 390
 391
 392 /**
 393  * Return sector number for given address.
 394  *
 395  * Return the (logical) sector number for a given relative address.
 396  * No sanity check is done. It assumed that the address is valid.
 397  *
 398  * @param bank Pointer to the flash bank descriptor
 399  * @param offset Offset address relative to bank start
 400  */
 401 static uint32_t lpc2900_address2sector( struct flash_bank *bank,
 402                                         uint32_t offset )
 403 {
 404         uint32_t address = bank->base + offset;
 405
 406
 407         /* Run through all sectors of this bank */
 408         int sector;
 409         for( sector = 0; sector < bank->num_sectors; sector++ )
 410         {
 411                 /* Return immediately if address is within the current sector */
 412                 if( address < (bank->sectors[sector].offset + bank->sectors[sector].size) )
 413                 {
 414                         return sector;
 415                 }
 416         }
 417
 418         /* We should never come here. If we do, return an arbitrary sector number. */
 419         return 0;
 420 }
 421
 422
 423
 424
 425 /**
 426  * Write one page to the index sector.
 427  *
 428  * @param bank Pointer to the flash bank descriptor
 429  * @param pagenum Page number (0...7)
 430  * @param page Page array (FLASH_PAGE_SIZE bytes)
 431  */
 432 static int lpc2900_write_index_page( struct flash_bank *bank,
 433                                      int pagenum,
 434                                      uint8_t (*page)[FLASH_PAGE_SIZE] )
 435 {
 436         /* Only pages 4...7 are user writable */
 437         if ((pagenum < 4) || (pagenum > 7))
 438         {
 439                 LOG_ERROR("Refuse to burn index sector page %d", pagenum);
 440                 return ERROR_COMMAND_ARGUMENT_INVALID;
 441         }
 442
 443         /* Get target, and check if it's halted */
 444         struct target *target = bank->target;
 445         if( target->state != TARGET_HALTED )
 446         {
 447                 LOG_ERROR( "Target not halted" );
 448                 return ERROR_TARGET_NOT_HALTED;
 449         }
 450
 451         /* Private info */
 452         struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
 453
 454         /* Enable flash block and set the correct CRA clock of 66 kHz */
 455         lpc2900_setup( bank );
 456
 457         /* Un-protect the index sector */
 458         target_write_u32( target, bank->base, 0 );
 459         target_write_u32( target, FCTR,
 460                           FCTR_FS_LOADREQ | FCTR_FS_WPB | FCTR_FS_ISS |
 461                           FCTR_FS_WEB | FCTR_FS_WRE | FCTR_FS_CS );
 462
 463         /* Set latch load mode */
 464         target_write_u32( target, FCTR,
 465                           FCTR_FS_ISS | FCTR_FS_WEB | FCTR_FS_WRE | FCTR_FS_CS );
 466
 467         /* Write whole page to flash data latches */
 468         if( target_write_memory( target,
 469                                  bank->base + pagenum * FLASH_PAGE_SIZE,
 470                                  4, FLASH_PAGE_SIZE / 4, (uint8_t *)page) != ERROR_OK )
 471         {
 472                 LOG_ERROR("Index sector write failed @ page %d", pagenum);
 473                 target_write_u32( target, FCTR, FCTR_FS_CS | FCTR_FS_WEB );
 474
 475                 return ERROR_FLASH_OPERATION_FAILED;
 476         }
 477
 478         /* Clear END_OF_BURN interrupt status */
 479         target_write_u32( target, INT_CLR_STATUS, INTSRC_END_OF_BURN );
 480
 481         /* Set the program/erase time to FLASH_PROGRAM_TIME */
 482         target_write_u32(target, FPTR,
 483                          FPTR_EN_T | lpc2900_calc_tr( lpc2900_info->clk_sys_fmc,
 484                                                       FLASH_PROGRAM_TIME ));
 485
 486         /* Trigger flash write */
 487         target_write_u32( target, FCTR,
 488                           FCTR_FS_PROGREQ | FCTR_FS_ISS |
 489                           FCTR_FS_WPB | FCTR_FS_WRE | FCTR_FS_CS );
 490
 491         /* Wait for the end of the write operation. If it's not over after one
 492          * second, something went dreadfully wrong... :-(
 493          */
 494         if (lpc2900_wait_status(bank, INTSRC_END_OF_BURN, 1000) != ERROR_OK)
 495         {
 496                 LOG_ERROR("Index sector write failed @ page %d", pagenum);
 497                 target_write_u32(target, FCTR, FCTR_FS_CS | FCTR_FS_WEB);
 498
 499                 return ERROR_FLASH_OPERATION_FAILED;
 500         }
 501
 502         target_write_u32( target, FCTR, FCTR_FS_CS | FCTR_FS_WEB );
 503
 504         return ERROR_OK;
 505 }
 506
 507
 508
 509 /**
 510  * Calculate FPTR.TR register value for desired program/erase time.
 511  *
 512  * @param clock System clock in Hz
 513  * @param time Program/erase time in µs
 514  */
 515 static uint32_t lpc2900_calc_tr( uint32_t clock_var, uint32_t time_var )
 516 {
 517         /*           ((time[µs]/1e6) * f[Hz]) + 511
 518          * FPTR.TR = -------------------------------
 519          *                         512
 520          */
 521
 522         uint32_t tr_val = (uint32_t)((((time_var / 1e6) * clock_var) + 511.0) / 512.0);
 523
 524         return tr_val;
 525 }
 526
 527
 528 /***********************  Private flash commands  **************************/
 529
 530
 531 /**
 532  * Command to determine the signature of the whole flash.
 533  *
 534  * Uses the Built-In-Self-Test (BIST) to generate a 128-bit hash value
 535  * of the flash content.
 536  */
 537 COMMAND_HANDLER(lpc2900_handle_signature_command)
 538 {
 539         uint32_t status;
 540         uint32_t signature[4];
 541
 542
 543         if( CMD_ARGC < 1 )
 544         {
 545                 return ERROR_COMMAND_SYNTAX_ERROR;
 546         }
 547
 548         struct flash_bank *bank;
 549         int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
 550         if (ERROR_OK != retval)
 551                 return retval;
 552
 553         if( bank->target->state != TARGET_HALTED )
 554         {
 555                 LOG_ERROR( "Target not halted" );
 556                 return ERROR_TARGET_NOT_HALTED;
 557         }
 558
 559         /* Run BIST over whole flash range */
 560         if( (status = lpc2900_run_bist128( bank,
 561                                            bank->base,
 562                                            bank->base + (bank->size - 1),
 563                                            &signature)
 564                                          ) != ERROR_OK )
 565         {
 566                 return status;
 567         }
 568
 569         command_print( CMD_CTX, "signature: 0x%8.8" PRIx32
 570                                           ":0x%8.8" PRIx32
 571                                           ":0x%8.8" PRIx32
 572                                           ":0x%8.8" PRIx32,
 573                       signature[3], signature[2], signature[1], signature[0] );
 574
 575         return ERROR_OK;
 576 }
 577
 578
 579
 580 /**
 581  * Store customer info in file.
 582  *
 583  * Read customer info from index sector, and store that block of data into
 584  * a disk file. The format is binary.
 585  */
 586 COMMAND_HANDLER(lpc2900_handle_read_custom_command)
 587 {
 588         if( CMD_ARGC < 2 )
 589         {
 590                 return ERROR_COMMAND_SYNTAX_ERROR;
 591         }
 592
 593         struct flash_bank *bank;
 594         int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
 595         if (ERROR_OK != retval)
 596                 return retval;
 597
 598         struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
 599         lpc2900_info->risky = 0;
 600
 601         /* Get target, and check if it's halted */
 602         struct target *target = bank->target;
 603         if( target->state != TARGET_HALTED )
 604         {
 605                 LOG_ERROR( "Target not halted" );
 606                 return ERROR_TARGET_NOT_HALTED;
 607         }
 608
 609         /* Storage for customer info. Read in two parts */
 610         uint32_t customer[ ISS_CUSTOMER_NWORDS1 + ISS_CUSTOMER_NWORDS2 ];
 611
 612         /* Enable access to index sector */
 613         target_write_u32( target, FCTR, FCTR_FS_CS | FCTR_FS_WEB | FCTR_FS_ISS );
 614
 615         /* Read two parts */
 616         target_read_memory( target, bank->base+ISS_CUSTOMER_START1, 4,
 617                                     ISS_CUSTOMER_NWORDS1,
 618                                     (uint8_t *)&customer[0] );
 619         target_read_memory( target, bank->base+ISS_CUSTOMER_START2, 4,
 620                                     ISS_CUSTOMER_NWORDS2,
 621                                     (uint8_t *)&customer[ISS_CUSTOMER_NWORDS1] );
 622
 623         /* Deactivate access to index sector */
 624         target_write_u32( target, FCTR, FCTR_FS_CS | FCTR_FS_WEB );
 625
 626         /* Try and open the file */
 627         struct fileio fileio;
 628         const char *filename = CMD_ARGV[1];
 629         int ret = fileio_open( &fileio, filename, FILEIO_WRITE, FILEIO_BINARY );
 630         if( ret != ERROR_OK )
 631         {
 632                 LOG_WARNING( "Could not open file %s", filename );
 633                 return ret;
 634         }
 635
 636         size_t nwritten;
 637         ret = fileio_write( &fileio, sizeof(customer),
 638                         (const uint8_t *)customer, &nwritten );
 639         if( ret != ERROR_OK )
 640         {
 641                 LOG_ERROR( "Write operation to file %s failed", filename );
 642                 fileio_close( &fileio );
 643                 return ret;
 644         }
 645
 646         fileio_close( &fileio );
 647
 648         return ERROR_OK;
 649 }
 650
 651
 652
 653
 654 /**
 655  * Enter password to enable potentially dangerous options.
 656  */
 657 COMMAND_HANDLER(lpc2900_handle_password_command)
 658 {
 659         if (CMD_ARGC < 2)
 660         {
 661                 return ERROR_COMMAND_SYNTAX_ERROR;
 662         }
 663
 664         struct flash_bank *bank;
 665         int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
 666         if (ERROR_OK != retval)
 667                 return retval;
 668
 669         struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
 670
 671 #define ISS_PASSWORD "I_know_what_I_am_doing"
 672
 673         lpc2900_info->risky = !strcmp( CMD_ARGV[1], ISS_PASSWORD );
 674
 675         if( !lpc2900_info->risky )
 676         {
 677                 command_print(CMD_CTX, "Wrong password (use '%s')", ISS_PASSWORD);
 678                 return ERROR_COMMAND_ARGUMENT_INVALID;
 679         }
 680
 681         command_print(CMD_CTX,
 682                   "Potentially dangerous operation allowed in next command!");
 683
 684         return ERROR_OK;
 685 }
 686
 687
 688
 689 /**
 690  * Write customer info from file to the index sector.
 691  */
 692 COMMAND_HANDLER(lpc2900_handle_write_custom_command)
 693 {
 694         if (CMD_ARGC < 2)
 695         {
 696                 return ERROR_COMMAND_SYNTAX_ERROR;
 697         }
 698
 699         struct flash_bank *bank;
 700         int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
 701         if (ERROR_OK != retval)
 702                 return retval;
 703
 704         struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
 705
 706         /* Check if command execution is allowed. */
 707         if( !lpc2900_info->risky )
 708         {
 709                 command_print( CMD_CTX, "Command execution not allowed!" );
 710                 return ERROR_COMMAND_ARGUMENT_INVALID;
 711         }
 712         lpc2900_info->risky = 0;
 713
 714         /* Get target, and check if it's halted */
 715         struct target *target = bank->target;
 716         if (target->state != TARGET_HALTED)
 717         {
 718                 LOG_ERROR("Target not halted");
 719                 return ERROR_TARGET_NOT_HALTED;
 720         }
 721
 722         /* The image will always start at offset 0 */
 723         struct image image;
 724         image.base_address_set = 1;
 725         image.base_address = 0;
 726         image.start_address_set = 0;
 727
 728         const char *filename = CMD_ARGV[1];
 729         const char *type = (CMD_ARGC >= 3) ? CMD_ARGV[2] : NULL;
 730         retval = image_open(&image, filename, type);
 731         if (retval != ERROR_OK)
 732         {
 733                 return retval;
 734         }
 735
 736         /* Do a sanity check: The image must be exactly the size of the customer
 737            programmable area. Any other size is rejected. */
 738         if( image.num_sections != 1 )
 739         {
 740                 LOG_ERROR("Only one section allowed in image file.");
 741                 return ERROR_COMMAND_SYNTAX_ERROR;
 742         }
 743         if( (image.sections[0].base_address != 0) ||
 744         (image.sections[0].size != ISS_CUSTOMER_SIZE) )
 745         {
 746                 LOG_ERROR("Incorrect image file size. Expected %d, "
 747                         "got %" PRIu32,
 748                    ISS_CUSTOMER_SIZE, image.sections[0].size);
 749                 return ERROR_COMMAND_SYNTAX_ERROR;
 750         }
 751
 752         /* Well boys, I reckon this is it... */
 753
 754         /* Customer info is split into two blocks in pages 4 and 5. */
 755         uint8_t page[FLASH_PAGE_SIZE];
 756
 757         /* Page 4 */
 758         uint32_t offset = ISS_CUSTOMER_START1 % FLASH_PAGE_SIZE;
 759         memset( page, 0xff, FLASH_PAGE_SIZE );
 760         size_t size_read;
 761         retval = image_read_section( &image, 0, 0,
 762                                      ISS_CUSTOMER_SIZE1, &page[offset], &size_read);
 763         if( retval != ERROR_OK )
 764         {
 765                 LOG_ERROR("couldn't read from file '%s'", filename);
 766                 image_close(&image);
 767                 return retval;
 768         }
 769         if( (retval = lpc2900_write_index_page( bank, 4, &page )) != ERROR_OK )
 770         {
 771                 image_close(&image);
 772                 return retval;
 773         }
 774
 775         /* Page 5 */
 776         offset = ISS_CUSTOMER_START2 % FLASH_PAGE_SIZE;
 777         memset( page, 0xff, FLASH_PAGE_SIZE );
 778         retval = image_read_section( &image, 0, ISS_CUSTOMER_SIZE1,
 779                                      ISS_CUSTOMER_SIZE2, &page[offset], &size_read);
 780         if( retval != ERROR_OK )
 781         {
 782                 LOG_ERROR("couldn't read from file '%s'", filename);
 783                 image_close(&image);
 784                 return retval;
 785         }
 786         if( (retval = lpc2900_write_index_page( bank, 5, &page )) != ERROR_OK )
 787         {
 788                 image_close(&image);
 789                 return retval;
 790         }
 791
 792         image_close(&image);
 793
 794         return ERROR_OK;
 795 }
 796
 797
 798
 799 /**
 800  * Activate 'sector security' for a range of sectors.
 801  */
 802 COMMAND_HANDLER(lpc2900_handle_secure_sector_command)
 803 {
 804         if (CMD_ARGC < 3)
 805         {
 806                 return ERROR_COMMAND_SYNTAX_ERROR;
 807         }
 808
 809         /* Get the bank descriptor */
 810         struct flash_bank *bank;
 811         int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
 812         if (ERROR_OK != retval)
 813                 return retval;
 814
 815         struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
 816
 817         /* Check if command execution is allowed. */
 818         if( !lpc2900_info->risky )
 819         {
 820                 command_print( CMD_CTX, "Command execution not allowed! "
 821                 "(use 'password' command first)");
 822                 return ERROR_COMMAND_ARGUMENT_INVALID;
 823         }
 824         lpc2900_info->risky = 0;
 825
 826         /* Read sector range, and do a sanity check. */
 827         int first, last;
 828         COMMAND_PARSE_NUMBER(int, CMD_ARGV[1], first);
 829         COMMAND_PARSE_NUMBER(int, CMD_ARGV[2], last);
 830         if( (first >= bank->num_sectors) ||
 831             (last >= bank->num_sectors) ||
 832             (first > last) )
 833         {
 834                 command_print( CMD_CTX, "Illegal sector range" );
 835                 return ERROR_COMMAND_ARGUMENT_INVALID;
 836         }
 837
 838         uint8_t page[FLASH_PAGE_SIZE];
 839         int sector;
 840
 841         /* Sectors in page 6 */
 842         if( (first <= 4) || (last >= 8) )
 843         {
 844                 memset( &page, 0xff, FLASH_PAGE_SIZE );
 845                 for( sector = first; sector <= last; sector++ )
 846                 {
 847                         if( sector <= 4 )
 848                         {
 849                                 memset( &page[0xB0 + 16*sector], 0, 16 );
 850                         }
 851                         else if( sector >= 8 )
 852                         {
 853                                 memset( &page[0x00 + 16*(sector - 8)], 0, 16 );
 854                         }
 855                 }
 856
 857                 if( (retval = lpc2900_write_index_page( bank, 6, &page )) != ERROR_OK )
 858                 {
 859                         LOG_ERROR("failed to update index sector page 6");
 860                         return retval;
 861                 }
 862         }
 863
 864         /* Sectors in page 7 */
 865         if( (first <= 7) && (last >= 5) )
 866         {
 867                 memset( &page, 0xff, FLASH_PAGE_SIZE );
 868                 for( sector = first; sector <= last; sector++ )
 869                 {
 870                         if( (sector >= 5) && (sector <= 7) )
 871                         {
 872                                 memset( &page[0x00 + 16*(sector - 5)], 0, 16 );
 873                         }
 874                 }
 875
 876                 if( (retval = lpc2900_write_index_page( bank, 7, &page )) != ERROR_OK )
 877                 {
 878                         LOG_ERROR("failed to update index sector page 7");
 879                         return retval;
 880                 }
 881         }
 882
 883         command_print( CMD_CTX,
 884                 "Sectors security will become effective after next power cycle");
 885
 886         /* Update the sector security status */
 887         if ( lpc2900_read_security_status(bank) != ERROR_OK )
 888         {
 889                 LOG_ERROR( "Cannot determine sector security status" );
 890                 return ERROR_FLASH_OPERATION_FAILED;
 891         }
 892
 893         return ERROR_OK;
 894 }
 895
 896
 897
 898 /**
 899  * Activate JTAG protection.
 900  */
 901 COMMAND_HANDLER(lpc2900_handle_secure_jtag_command)
 902 {
 903         if (CMD_ARGC < 1)
 904         {
 905                 return ERROR_COMMAND_SYNTAX_ERROR;
 906         }
 907
 908         /* Get the bank descriptor */
 909         struct flash_bank *bank;
 910         int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
 911         if (ERROR_OK != retval)
 912                 return retval;
 913
 914         struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
 915
 916         /* Check if command execution is allowed. */
 917         if( !lpc2900_info->risky )
 918         {
 919                 command_print( CMD_CTX, "Command execution not allowed! "
 920                                         "(use 'password' command first)");
 921                 return ERROR_COMMAND_ARGUMENT_INVALID;
 922         }
 923         lpc2900_info->risky = 0;
 924
 925         /* Prepare page */
 926         uint8_t page[FLASH_PAGE_SIZE];
 927         memset( &page, 0xff, FLASH_PAGE_SIZE );
 928
 929
 930         /* Insert "soft" protection word */
 931         page[0x30 + 15] = 0x7F;
 932         page[0x30 + 11] = 0x7F;
 933         page[0x30 +  7] = 0x7F;
 934         page[0x30 +  3] = 0x7F;
 935
 936         /* Write to page 5 */
 937         if( (retval = lpc2900_write_index_page( bank, 5, &page ))
 938                         != ERROR_OK )
 939         {
 940                 LOG_ERROR("failed to update index sector page 5");
 941                 return retval;
 942         }
 943
 944         LOG_INFO("JTAG security set. Good bye!");
 945
 946         return ERROR_OK;
 947 }
 948
 949
 950
 951 /***********************  Flash interface functions  **************************/
 952
 953 static const struct command_registration lpc2900_exec_command_handlers[] = {
 954         {
 955                 .name = "signature",
 956                 .usage = "<bank>",
 957                 .handler = lpc2900_handle_signature_command,
 958                 .mode = COMMAND_EXEC,
 959                 .help = "Calculate and display signature of flash bank.",
 960         },
 961         {
 962                 .name = "read_custom",
 963                 .handler = lpc2900_handle_read_custom_command,
 964                 .mode = COMMAND_EXEC,
 965                 .usage = "bank_id filename",
 966                 .help = "Copies 912 bytes of customer information "
 967                         "from index sector into file.",
 968         },
 969         {
 970                 .name = "password",
 971                 .handler = lpc2900_handle_password_command,
 972                 .mode = COMMAND_EXEC,
 973                 .usage = "bank_id password",
 974                 .help = "Enter fixed password to enable 'dangerous' options.",
 975         },
 976         {
 977                 .name = "write_custom",
 978                 .handler = lpc2900_handle_write_custom_command,
 979                 .mode = COMMAND_EXEC,
 980                 .usage = "bank_id filename ('bin'|'ihex'|'elf'|'s19')",
 981                 .help = "Copies 912 bytes of customer info from file "
 982                         "to index sector.",
 983         },
 984         {
 985                 .name = "secure_sector",
 986                 .handler = lpc2900_handle_secure_sector_command,
 987                 .mode = COMMAND_EXEC,
 988                 .usage = "bank_id first_sector last_sector",
 989                 .help = "Activate sector security for a range of sectors.  "
 990                         "It will be effective after a power cycle.",
 991         },
 992         {
 993                 .name = "secure_jtag",
 994                 .handler = lpc2900_handle_secure_jtag_command,
 995                 .mode = COMMAND_EXEC,
 996                 .usage = "bank_id",
 997                 .help = "Disable the JTAG port.  "
 998                         "It will be effective after a power cycle.",
 999         },
1000         COMMAND_REGISTRATION_DONE
1001 };
1002 static const struct command_registration lpc2900_command_handlers[] = {
1003         {
1004                 .name = "lpc2900",
1005                 .mode = COMMAND_ANY,
1006                 .help = "LPC2900 flash command group",
1007                 .usage = "",
1008                 .chain = lpc2900_exec_command_handlers,
1009         },
1010         COMMAND_REGISTRATION_DONE
1011 };
1012
1013 /// Evaluate flash bank command.
1014 FLASH_BANK_COMMAND_HANDLER(lpc2900_flash_bank_command)
1015 {
1016         struct lpc2900_flash_bank *lpc2900_info;
1017
1018         if (CMD_ARGC < 6)
1019         {
1020                 return ERROR_COMMAND_SYNTAX_ERROR;
1021         }
1022
1023         lpc2900_info = malloc(sizeof(struct lpc2900_flash_bank));
1024         bank->driver_priv = lpc2900_info;
1025
1026         /* Get flash clock.
1027          * Reject it if we can't meet the requirements for program time
1028          * (if clock too slow), or for erase time (clock too fast).
1029          */
1030         uint32_t clk_sys_fmc;
1031         COMMAND_PARSE_NUMBER(u32, CMD_ARGV[6], clk_sys_fmc);
1032         lpc2900_info->clk_sys_fmc = clk_sys_fmc * 1000;
1033
1034         uint32_t clock_limit;
1035         /* Check program time limit */
1036         clock_limit = 512000000l / FLASH_PROGRAM_TIME;
1037         if (lpc2900_info->clk_sys_fmc < clock_limit)
1038         {
1039                 LOG_WARNING("flash clock must be at least %" PRIu32 " kHz",
1040                     (clock_limit / 1000));
1041                 return ERROR_FLASH_BANK_INVALID;
1042         }
1043
1044         /* Check erase time limit */
1045         clock_limit = (uint32_t)((32767.0 * 512.0 * 1e6) / FLASH_ERASE_TIME);
1046         if (lpc2900_info->clk_sys_fmc > clock_limit)
1047         {
1048                 LOG_WARNING("flash clock must be a maximum of %" PRIu32" kHz",
1049                     (clock_limit / 1000));
1050                 return ERROR_FLASH_BANK_INVALID;
1051         }
1052
1053         /* Chip ID will be obtained by probing the device later */
1054         lpc2900_info->chipid = 0;
1055         lpc2900_info->is_probed = false;
1056
1057         return ERROR_OK;
1058 }
1059
1060
1061 /**
1062  * Erase sector(s).
1063  *
1064  * @param bank Pointer to the flash bank descriptor
1065  * @param first First sector to be erased
1066  * @param last Last sector (including) to be erased
1067  */
1068 static int lpc2900_erase(struct flash_bank *bank, int first, int last)
1069 {
1070         uint32_t status;
1071         int sector;
1072         int last_unsecured_sector;
1073         struct target *target = bank->target;
1074         struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
1075
1076
1077         status = lpc2900_is_ready(bank);
1078         if (status != ERROR_OK)
1079         {
1080                 return status;
1081         }
1082
1083         /* Sanity check on sector range */
1084         if ((first < 0) || (last < first) || (last >= bank->num_sectors))
1085         {
1086                 LOG_INFO("Bad sector range");
1087                 return ERROR_FLASH_SECTOR_INVALID;
1088         }
1089
1090         /* Update the info about secured sectors */
1091         lpc2900_read_security_status( bank );
1092
1093         /* The selected sector range might include secured sectors. An attempt
1094          * to erase such a sector will cause the erase to fail also for unsecured
1095          * sectors. It is necessary to determine the last unsecured sector now,
1096          * because we have to treat the last relevant sector in the list in
1097          * a special way.
1098          */
1099         last_unsecured_sector = -1;
1100         for (sector = first; sector <= last; sector++)
1101         {
1102                 if ( !bank->sectors[sector].is_protected )
1103                 {
1104                         last_unsecured_sector = sector;
1105                 }
1106         }
1107
1108         /* Exit now, in case of the rare constellation where all sectors in range
1109          * are secured. This is regarded a success, since erasing/programming of
1110          * secured sectors shall be handled transparently.
1111          */
1112         if ( last_unsecured_sector == -1 )
1113         {
1114                 return ERROR_OK;
1115         }
1116
1117         /* Enable flash block and set the correct CRA clock of 66 kHz */
1118         lpc2900_setup(bank);
1119
1120         /* Clear END_OF_ERASE interrupt status */
1121         target_write_u32(target, INT_CLR_STATUS, INTSRC_END_OF_ERASE);
1122
1123         /* Set the program/erase timer to FLASH_ERASE_TIME */
1124         target_write_u32(target, FPTR,
1125                          FPTR_EN_T | lpc2900_calc_tr( lpc2900_info->clk_sys_fmc,
1126                                                       FLASH_ERASE_TIME ));
1127
1128         /* Sectors are marked for erasure, then erased all together */
1129         for (sector = first; sector <= last_unsecured_sector; sector++)
1130         {
1131                 /* Only mark sectors that aren't secured. Any attempt to erase a group
1132                  * of sectors will fail if any single one of them is secured!
1133                  */
1134                 if ( !bank->sectors[sector].is_protected )
1135                 {
1136                         /* Unprotect the sector */
1137                         target_write_u32(target, bank->sectors[sector].offset, 0);
1138                         target_write_u32(target, FCTR,
1139                                          FCTR_FS_LOADREQ | FCTR_FS_WPB |
1140                                          FCTR_FS_WEB | FCTR_FS_WRE | FCTR_FS_CS);
1141
1142                         /* Mark the sector for erasure. The last sector in the list
1143                            triggers the erasure. */
1144                         target_write_u32(target, bank->sectors[sector].offset, 0);
1145                         if ( sector == last_unsecured_sector )
1146                         {
1147                                 target_write_u32(target, FCTR,
1148                                                  FCTR_FS_PROGREQ | FCTR_FS_WPB | FCTR_FS_CS);
1149                         }
1150                         else
1151                         {
1152                                 target_write_u32(target, FCTR,
1153                                                  FCTR_FS_LOADREQ | FCTR_FS_WPB |
1154                                                  FCTR_FS_WEB | FCTR_FS_CS);
1155                         }
1156                 }
1157         }
1158
1159         /* Wait for the end of the erase operation. If it's not over after two seconds,
1160          * something went dreadfully wrong... :-(
1161          */
1162         if( lpc2900_wait_status(bank, INTSRC_END_OF_ERASE, 2000) != ERROR_OK )
1163         {
1164                 return ERROR_FLASH_OPERATION_FAILED;
1165         }
1166
1167         /* Normal flash operating mode */
1168         target_write_u32(target, FCTR, FCTR_FS_CS | FCTR_FS_WEB);
1169
1170         return ERROR_OK;
1171 }
1172
1173
1174
1175 static int lpc2900_protect(struct flash_bank *bank, int set, int first, int last)
1176 {
1177         /* This command is not supported.
1178      * "Protection" in LPC2900 terms is handled transparently. Sectors will
1179      * automatically be unprotected as needed.
1180      * Instead we use the concept of sector security. A secured sector is shown
1181      * as "protected" in OpenOCD. Sector security is a permanent feature, and
1182      * cannot be disabled once activated.
1183      */
1184
1185         return ERROR_OK;
1186 }
1187
1188
1189 /**
1190  * Write data to flash.
1191  *
1192  * @param bank Pointer to the flash bank descriptor
1193  * @param buffer Buffer with data
1194  * @param offset Start address (relative to bank start)
1195  * @param count Number of bytes to be programmed
1196  */
1197 static int lpc2900_write(struct flash_bank *bank, uint8_t *buffer,
1198                          uint32_t offset, uint32_t count)
1199 {
1200         uint8_t page[FLASH_PAGE_SIZE];
1201         uint32_t status;
1202         uint32_t num_bytes;
1203         struct target *target = bank->target;
1204         struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
1205         int sector;
1206         int retval;
1207
1208         static const uint32_t write_target_code[] = {
1209                 /* Set auto latch mode: FCTR=CS|WRE|WEB */
1210                 0xe3a0a007,   /* loop       mov r10, #0x007 */
1211                 0xe583a000,   /*            str r10,[r3,#0] */
1212
1213                 /* Load complete page into latches */
1214                 0xe3a06020,   /*            mov r6,#(512/16) */
1215                 0xe8b00f00,   /* next       ldmia r0!,{r8-r11} */
1216                 0xe8a10f00,   /*            stmia r1!,{r8-r11} */
1217                 0xe2566001,   /*            subs r6,#1 */
1218                 0x1afffffb,   /*            bne next */
1219
1220                 /* Clear END_OF_BURN interrupt status */
1221                 0xe3a0a002,   /*            mov r10,#(1 << 1) */
1222                 0xe583afe8,   /*            str r10,[r3,#0xfe8] */
1223
1224                 /* Set the erase time to FLASH_PROGRAM_TIME */
1225                 0xe5834008,   /*            str r4,[r3,#8] */
1226
1227                 /* Trigger flash write
1228                         FCTR = CS | WRE | WPB | PROGREQ */
1229                 0xe3a0a083,   /*            mov r10,#0x83 */
1230                 0xe38aaa01,   /*            orr r10,#0x1000 */
1231                 0xe583a000,   /*            str r10,[r3,#0] */
1232
1233                 /* Wait for end of burn */
1234                 0xe593afe0,   /* wait       ldr r10,[r3,#0xfe0] */
1235                 0xe21aa002,   /*            ands r10,#(1 << 1) */
1236                 0x0afffffc,   /*            beq wait */
1237
1238                 /* End? */
1239                 0xe2522001,   /*            subs r2,#1 */
1240                 0x1affffed,   /*            bne loop */
1241
1242                 0xeafffffe    /* done       b done */
1243         };
1244
1245
1246         status = lpc2900_is_ready(bank);
1247         if (status != ERROR_OK)
1248         {
1249                 return status;
1250         }
1251
1252         /* Enable flash block and set the correct CRA clock of 66 kHz */
1253         lpc2900_setup(bank);
1254
1255         /* Update the info about secured sectors */
1256         lpc2900_read_security_status( bank );
1257
1258         /* Unprotect all involved sectors */
1259         for (sector = 0; sector < bank->num_sectors; sector++)
1260         {
1261                 /* Start address in or before this sector? */
1262                 /* End address in or behind this sector? */
1263                 if ( ((bank->base + offset) <
1264                           (bank->sectors[sector].offset + bank->sectors[sector].size)) &&
1265                      ((bank->base + (offset + count - 1)) >= bank->sectors[sector].offset) )
1266                 {
1267                         /* This sector is involved and needs to be unprotected.
1268                                 * Don't do it for secured sectors.
1269                                 */
1270                         if ( !bank->sectors[sector].is_protected )
1271                         {
1272                                 target_write_u32(target, bank->sectors[sector].offset, 0);
1273                                 target_write_u32(target, FCTR,
1274                                                  FCTR_FS_LOADREQ | FCTR_FS_WPB |
1275                                                  FCTR_FS_WEB | FCTR_FS_WRE | FCTR_FS_CS);
1276                         }
1277                 }
1278         }
1279
1280         /* Set the program/erase time to FLASH_PROGRAM_TIME */
1281         uint32_t prog_time = FPTR_EN_T | lpc2900_calc_tr( lpc2900_info->clk_sys_fmc,
1282                                                           FLASH_PROGRAM_TIME );
1283
1284         /* If there is a working area of reasonable size, use it to program via
1285            a target algorithm. If not, fall back to host programming. */
1286
1287         /* We need some room for target code. */
1288         uint32_t target_code_size = sizeof(write_target_code);
1289
1290         /* Try working area allocation. Start with a large buffer, and try with
1291            reduced size if that fails. */
1292         struct working_area *warea;
1293         uint32_t buffer_size = lpc2900_info->max_ram_block - 1 * KiB;
1294         while( (retval = target_alloc_working_area_try(target,
1295                                                    buffer_size + target_code_size,
1296                                                    &warea)) != ERROR_OK )
1297         {
1298                 /* Try a smaller buffer now, and stop if it's too small. */
1299                 buffer_size -= 1 * KiB;
1300                 if (buffer_size < 2 * KiB)
1301                 {
1302                         LOG_INFO( "no (large enough) working area"
1303                                   ", falling back to host mode" );
1304                         warea = NULL;
1305                         break;
1306                 }
1307         };
1308
1309         if( warea )
1310         {
1311                 struct reg_param reg_params[5];
1312                 struct arm_algorithm armv4_5_info;
1313
1314                 /* We can use target mode. Download the algorithm. */
1315                 retval = target_write_buffer( target,
1316                                               (warea->address)+buffer_size,
1317                                               target_code_size,
1318                                               (uint8_t *)write_target_code);
1319                 if (retval != ERROR_OK)
1320                 {
1321                         LOG_ERROR("Unable to write block write code to target");
1322                         target_free_all_working_areas(target);
1323                         return ERROR_FLASH_OPERATION_FAILED;
1324                 }
1325
1326                 init_reg_param(&reg_params[0], "r0", 32, PARAM_OUT);
1327                 init_reg_param(&reg_params[1], "r1", 32, PARAM_OUT);
1328                 init_reg_param(&reg_params[2], "r2", 32, PARAM_OUT);
1329                 init_reg_param(&reg_params[3], "r3", 32, PARAM_OUT);
1330                 init_reg_param(&reg_params[4], "r4", 32, PARAM_OUT);
1331
1332                 /* Write to flash in large blocks */
1333                 while ( count != 0 )
1334                 {
1335                         uint32_t this_npages;
1336                         uint8_t *this_buffer;
1337                         int start_sector = lpc2900_address2sector( bank, offset );
1338
1339                         /* First page / last page / rest */
1340                         if( offset % FLASH_PAGE_SIZE )
1341                         {
1342                                 /* Block doesn't start on page boundary.
1343                                    Burn first partial page separately. */
1344                                 memset( &page, 0xff, sizeof(page) );
1345                                 memcpy( &page[offset % FLASH_PAGE_SIZE],
1346                                         buffer,
1347                                         FLASH_PAGE_SIZE - (offset % FLASH_PAGE_SIZE) );
1348                                 this_npages = 1;
1349                                 this_buffer = &page[0];
1350                                 count = count + (offset % FLASH_PAGE_SIZE);
1351                                 offset = offset - (offset % FLASH_PAGE_SIZE);
1352                         }
1353                         else if( count < FLASH_PAGE_SIZE )
1354                         {
1355                                 /* Download last incomplete page separately. */
1356                                 memset( &page, 0xff, sizeof(page) );
1357                                 memcpy( &page, buffer, count );
1358                                 this_npages = 1;
1359                                 this_buffer = &page[0];
1360                                 count = FLASH_PAGE_SIZE;
1361                         }
1362                         else
1363                         {
1364                                 /* Download as many full pages as possible */
1365                                 this_npages = (count < buffer_size) ?
1366                                                count / FLASH_PAGE_SIZE :
1367                                                buffer_size / FLASH_PAGE_SIZE;
1368                                 this_buffer = buffer;
1369
1370                                 /* Make sure we stop at the next secured sector */
1371                                 sector = start_sector + 1;
1372                                 while( sector < bank->num_sectors )
1373                                 {
1374                                         /* Secured? */
1375                                         if( bank->sectors[sector].is_protected )
1376                                         {
1377                                                 /* Is that next sector within the current block? */
1378                                                 if( (bank->sectors[sector].offset - bank->base) <
1379                                                         (offset + (this_npages * FLASH_PAGE_SIZE)) )
1380                                                 {
1381                                                         /* Yes! Split the block */
1382                                                         this_npages =
1383                                                           (bank->sectors[sector].offset - bank->base - offset)
1384                                                               / FLASH_PAGE_SIZE;
1385                                                         break;
1386                                                 }
1387                                         }
1388
1389                                         sector++;
1390                                 }
1391                         }
1392
1393                         /* Skip the current sector if it is secured */
1394                         if (bank->sectors[start_sector].is_protected)
1395                         {
1396                                 LOG_DEBUG("Skip secured sector %d",
1397                                                 start_sector);
1398
1399                                 /* Stop if this is the last sector */
1400                                 if (start_sector == bank->num_sectors - 1)
1401                                 {
1402                                         break;
1403                                 }
1404
1405                                 /* Skip */
1406                                 uint32_t nskip = bank->sectors[start_sector].size -
1407                                                  (offset % bank->sectors[start_sector].size);
1408                                 offset += nskip;
1409                                 buffer += nskip;
1410                                 count = (count >= nskip) ? (count - nskip) : 0;
1411                                 continue;
1412                         }
1413
1414                         /* Execute buffer download */
1415                         if ((retval = target_write_buffer(target,
1416                                                           warea->address,
1417                                                           this_npages * FLASH_PAGE_SIZE,
1418                                                           this_buffer)) != ERROR_OK)
1419                         {
1420                                 LOG_ERROR("Unable to write data to target");
1421                                 target_free_all_working_areas(target);
1422                                 return ERROR_FLASH_OPERATION_FAILED;
1423                         }
1424
1425                         /* Prepare registers */
1426                         buf_set_u32(reg_params[0].value, 0, 32, warea->address);
1427                         buf_set_u32(reg_params[1].value, 0, 32, offset);
1428                         buf_set_u32(reg_params[2].value, 0, 32, this_npages);
1429                         buf_set_u32(reg_params[3].value, 0, 32, FCTR);
1430                         buf_set_u32(reg_params[4].value, 0, 32, FPTR_EN_T | prog_time);
1431
1432                         /* Execute algorithm, assume breakpoint for last instruction */
1433                         armv4_5_info.common_magic = ARM_COMMON_MAGIC;
1434                         armv4_5_info.core_mode = ARM_MODE_SVC;
1435                         armv4_5_info.core_state = ARM_STATE_ARM;
1436
1437                         retval = target_run_algorithm(target, 0, NULL, 5, reg_params,
1438                                 (warea->address) + buffer_size,
1439                                 (warea->address) + buffer_size + target_code_size - 4,
1440                                 10000, /* 10s should be enough for max. 16 KiB of data */
1441                                 &armv4_5_info);
1442
1443                         if (retval != ERROR_OK)
1444                         {
1445                                 LOG_ERROR("Execution of flash algorithm failed.");
1446                                 target_free_all_working_areas(target);
1447                                 retval = ERROR_FLASH_OPERATION_FAILED;
1448                                 break;
1449                         }
1450
1451                         count -= this_npages * FLASH_PAGE_SIZE;
1452                         buffer += this_npages * FLASH_PAGE_SIZE;
1453                         offset += this_npages * FLASH_PAGE_SIZE;
1454                 }
1455
1456                 /* Free all resources */
1457                 destroy_reg_param(&reg_params[0]);
1458                 destroy_reg_param(&reg_params[1]);
1459                 destroy_reg_param(&reg_params[2]);
1460                 destroy_reg_param(&reg_params[3]);
1461                 destroy_reg_param(&reg_params[4]);
1462                 target_free_all_working_areas(target);
1463         }
1464         else
1465         {
1466                 /* Write to flash memory page-wise */
1467                 while ( count != 0 )
1468                 {
1469                         /* How many bytes do we copy this time? */
1470                         num_bytes = (count >= FLASH_PAGE_SIZE) ?
1471                                     FLASH_PAGE_SIZE - (offset % FLASH_PAGE_SIZE) :
1472                                     count;
1473
1474                         /* Don't do anything with it if the page is in a secured sector. */
1475                         if ( !bank->sectors[lpc2900_address2sector(bank, offset)].is_protected )
1476                         {
1477                                 /* Set latch load mode */
1478                                 target_write_u32(target, FCTR,
1479                                                  FCTR_FS_CS | FCTR_FS_WRE | FCTR_FS_WEB);
1480
1481                                 /* Always clear the buffer (a little overhead, but who cares) */
1482                                 memset(page, 0xFF, FLASH_PAGE_SIZE);
1483
1484                                 /* Copy them to the buffer */
1485                                 memcpy( &page[offset % FLASH_PAGE_SIZE],
1486                                         &buffer[offset % FLASH_PAGE_SIZE],
1487                                         num_bytes );
1488
1489                                 /* Write whole page to flash data latches */
1490                                 if (target_write_memory(
1491                                                  target,
1492                                                  bank->base + (offset - (offset % FLASH_PAGE_SIZE)),
1493                                                  4, FLASH_PAGE_SIZE / 4, page) != ERROR_OK)
1494                                 {
1495                                         LOG_ERROR("Write failed @ 0x%8.8" PRIx32, offset);
1496                                         target_write_u32(target, FCTR, FCTR_FS_CS | FCTR_FS_WEB);
1497
1498                                         return ERROR_FLASH_OPERATION_FAILED;
1499                                 }
1500
1501                                 /* Clear END_OF_BURN interrupt status */
1502                                 target_write_u32(target, INT_CLR_STATUS, INTSRC_END_OF_BURN);
1503
1504                                 /* Set the programming time */
1505                                 target_write_u32(target, FPTR, FPTR_EN_T | prog_time);
1506
1507                                 /* Trigger flash write */
1508                                 target_write_u32(target, FCTR,
1509                                     FCTR_FS_CS | FCTR_FS_WRE | FCTR_FS_WPB | FCTR_FS_PROGREQ);
1510
1511                                 /* Wait for the end of the write operation. If it's not over
1512                                  * after one second, something went dreadfully wrong... :-(
1513                                  */
1514                                 if (lpc2900_wait_status(bank, INTSRC_END_OF_BURN, 1000) != ERROR_OK)
1515                                 {
1516                                         LOG_ERROR("Write failed @ 0x%8.8" PRIx32, offset);
1517                                         target_write_u32(target, FCTR, FCTR_FS_CS | FCTR_FS_WEB);
1518
1519                                         return ERROR_FLASH_OPERATION_FAILED;
1520                                 }
1521                         }
1522
1523                         /* Update pointers and counters */
1524                         offset += num_bytes;
1525                         buffer += num_bytes;
1526                         count -= num_bytes;
1527                 }
1528
1529                 retval = ERROR_OK;
1530         }
1531
1532         /* Normal flash operating mode */
1533         target_write_u32(target, FCTR, FCTR_FS_CS | FCTR_FS_WEB);
1534
1535         return retval;
1536 }
1537
1538
1539 /**
1540  * Try and identify the device.
1541  *
1542  * Determine type number and its memory layout.
1543  *
1544  * @param bank Pointer to the flash bank descriptor
1545  */
1546 static int lpc2900_probe(struct flash_bank *bank)
1547 {
1548         struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
1549         struct target *target = bank->target;
1550         int i = 0;
1551         uint32_t offset;
1552
1553
1554         if (target->state != TARGET_HALTED)
1555         {
1556                 LOG_ERROR("Target not halted");
1557                 return ERROR_TARGET_NOT_HALTED;
1558         }
1559
1560         /* We want to do this only once. */
1561         if (lpc2900_info->is_probed)
1562         {
1563                 return ERROR_OK;
1564         }
1565
1566         /* Probing starts with reading the CHIPID register. We will continue only
1567          * if this identifies as an LPC2900 device.
1568          */
1569         target_read_u32(target, CHIPID, &lpc2900_info->chipid);
1570
1571         if (lpc2900_info->chipid != EXPECTED_CHIPID)
1572         {
1573                 LOG_WARNING("Device is not an LPC29xx");
1574                 return ERROR_FLASH_OPERATION_FAILED;
1575         }
1576
1577         /* It's an LPC29xx device. Now read the feature register FEAT0...FEAT3. */
1578         uint32_t feat0, feat1, feat2, feat3;
1579         target_read_u32(target, FEAT0, &feat0);
1580         target_read_u32(target, FEAT1, &feat1);
1581         target_read_u32(target, FEAT2, &feat2);
1582         target_read_u32(target, FEAT3, &feat3);
1583
1584         /* Base address */
1585         bank->base = 0x20000000;
1586
1587         /* Determine flash layout from FEAT2 register */
1588         uint32_t num_64k_sectors = (feat2 >> 16) & 0xFF;
1589         uint32_t num_8k_sectors = (feat2 >> 0) & 0xFF;
1590         bank->num_sectors = num_64k_sectors + num_8k_sectors;
1591         bank->size = KiB * (64 * num_64k_sectors + 8 * num_8k_sectors);
1592
1593         /* Determine maximum contiguous RAM block */
1594         lpc2900_info->max_ram_block = 16 * KiB;
1595         if( (feat1 & 0x30) == 0x30 )
1596         {
1597                 lpc2900_info->max_ram_block = 32 * KiB;
1598                 if( (feat1 & 0x0C) == 0x0C )
1599                 {
1600                         lpc2900_info->max_ram_block = 48 * KiB;
1601                 }
1602         }
1603
1604         /* Determine package code and ITCM size */
1605         uint32_t package_code = feat0 & 0x0F;
1606         uint32_t itcm_code = (feat1 >> 16) & 0x1F;
1607
1608         /* Determine the exact type number. */
1609         uint32_t found = 1;
1610         if ( (package_code == 4) && (itcm_code == 5) )
1611         {
1612                 /* Old LPC2917 or LPC2919 (non-/01 devices) */
1613                 lpc2900_info->target_name = (bank->size == 768*KiB) ? "LPC2919" : "LPC2917";
1614         }
1615         else
1616         {
1617                 if ( package_code == 2 )
1618                 {
1619                         /* 100-pin package */
1620                         if ( bank->size == 128*KiB )
1621                         {
1622                                 lpc2900_info->target_name = "LPC2921";
1623                         }
1624                         else if ( bank->size == 256*KiB )
1625                         {
1626                                 lpc2900_info->target_name = "LPC2923";
1627                         }
1628                         else if ( bank->size == 512*KiB )
1629                         {
1630                                 lpc2900_info->target_name = "LPC2925";
1631                         }
1632                         else
1633                         {
1634                                 found = 0;
1635                         }
1636                 }
1637                 else if ( package_code == 4 )
1638                 {
1639                         /* 144-pin package */
1640                         if ( (bank->size == 256*KiB) && (feat3 == 0xFFFFFFE9) )
1641                         {
1642                                 lpc2900_info->target_name = "LPC2926";
1643                         }
1644                         else if ( (bank->size == 512*KiB) && (feat3 == 0xFFFFFCF0) )
1645                         {
1646                                 lpc2900_info->target_name = "LPC2917/01";
1647                         }
1648                         else if ( (bank->size == 512*KiB) && (feat3 == 0xFFFFFFF1) )
1649                         {
1650                                 lpc2900_info->target_name = "LPC2927";
1651                         }
1652                         else if ( (bank->size == 768*KiB) && (feat3 == 0xFFFFFCF8) )
1653                         {
1654                                 lpc2900_info->target_name = "LPC2919/01";
1655                         }
1656                         else if ( (bank->size == 768*KiB) && (feat3 == 0xFFFFFFF9) )
1657                         {
1658                                 lpc2900_info->target_name = "LPC2929";
1659                         }
1660                         else
1661                         {
1662                                 found = 0;
1663                         }
1664                 }
1665                 else if ( package_code == 5 )
1666                 {
1667                         /* 208-pin package */
1668                         lpc2900_info->target_name = (bank->size == 0) ? "LPC2930" : "LPC2939";
1669                 }
1670                 else
1671                 {
1672                         found = 0;
1673                 }
1674         }
1675
1676         if ( !found )
1677         {
1678                 LOG_WARNING("Unknown LPC29xx derivative"
1679                             " (FEATx="
1680                             "%08" PRIx32 ":%08" PRIx32 ":%08" PRIx32 ":%08" PRIx32 ")",
1681                                         feat0, feat1, feat2, feat3
1682                                         );
1683                 return ERROR_FLASH_OPERATION_FAILED;
1684         }
1685
1686         /* Show detected device */
1687         LOG_INFO("Flash bank %d"
1688                  ": Device %s, %" PRIu32
1689                  " KiB in %d sectors",
1690                  bank->bank_number,
1691                  lpc2900_info->target_name, bank->size / KiB,
1692                  bank->num_sectors);
1693
1694         /* Flashless devices cannot be handled */
1695         if ( bank->num_sectors == 0 )
1696         {
1697                 LOG_WARNING("Flashless device cannot be handled");
1698                 return ERROR_FLASH_OPERATION_FAILED;
1699         }
1700
1701         /* Sector layout.
1702          * These are logical sector numbers. When doing real flash operations,
1703          * the logical flash number are translated into the physical flash numbers
1704          * of the device.
1705          */
1706         bank->sectors = malloc(sizeof(struct flash_sector) * bank->num_sectors);
1707
1708         offset = 0;
1709         for (i = 0; i < bank->num_sectors; i++)
1710         {
1711                 bank->sectors[i].offset = offset;
1712                 bank->sectors[i].is_erased = -1;
1713                 bank->sectors[i].is_protected = -1;
1714
1715                 if ( i <= 7 )
1716                 {
1717                         bank->sectors[i].size = 8 * KiB;
1718                 }
1719                 else if ( i <= 18 )
1720                 {
1721                         bank->sectors[i].size = 64 * KiB;
1722                 }
1723                 else
1724                 {
1725                         /* We shouldn't come here. But there might be a new part out there
1726                          * that has more than 19 sectors. Politely ask for a fix then.
1727                          */
1728                         bank->sectors[i].size = 0;
1729                         LOG_ERROR("Never heard about sector %d", i);
1730                 }
1731
1732                 offset += bank->sectors[i].size;
1733         }
1734
1735         lpc2900_info->is_probed = true;
1736
1737         /* Read sector security status */
1738         if ( lpc2900_read_security_status(bank) != ERROR_OK )
1739         {
1740                 LOG_ERROR("Cannot determine sector security status");
1741                 return ERROR_FLASH_OPERATION_FAILED;
1742         }
1743
1744         return ERROR_OK;
1745 }
1746
1747
1748 /**
1749  * Run a blank check for each sector.
1750  *
1751  * For speed reasons, the device isn't read word by word.
1752  * A hash value is calculated by the hardware ("BIST") for each sector.
1753  * This value is then compared against the known hash of an empty sector.
1754  *
1755  * @param bank Pointer to the flash bank descriptor
1756  */
1757 static int lpc2900_erase_check(struct flash_bank *bank)
1758 {
1759         uint32_t status = lpc2900_is_ready(bank);
1760         if (status != ERROR_OK)
1761         {
1762                 LOG_INFO("Processor not halted/not probed");
1763                 return status;
1764         }
1765
1766         /* Use the BIST (Built-In Selft Test) to generate a signature of each flash
1767          * sector. Compare against the expected signature of an empty sector.
1768          */
1769         int sector;
1770         for ( sector = 0; sector < bank->num_sectors; sector++ )
1771         {
1772                 uint32_t signature[4];
1773                 if ( (status = lpc2900_run_bist128( bank,
1774                                                     bank->sectors[sector].offset,
1775                                                     bank->sectors[sector].offset +
1776                                                        (bank->sectors[sector].size - 1),
1777                                                     &signature)) != ERROR_OK )
1778                 {
1779                         return status;
1780                 }
1781
1782                 /* The expected signatures for an empty sector are different
1783                  * for 8 KiB and 64 KiB sectors.
1784                  */
1785                 if ( bank->sectors[sector].size == 8*KiB )
1786                 {
1787                         bank->sectors[sector].is_erased =
1788                             (signature[3] == 0x01ABAAAA) &&
1789                             (signature[2] == 0xAAAAAAAA) &&
1790                             (signature[1] == 0xAAAAAAAA) &&
1791                             (signature[0] == 0xAAA00AAA);
1792                 }
1793                 if ( bank->sectors[sector].size == 64*KiB )
1794                 {
1795                         bank->sectors[sector].is_erased =
1796                             (signature[3] == 0x11801222) &&
1797                             (signature[2] == 0xB88844FF) &&
1798                             (signature[1] == 0x11A22008) &&
1799                             (signature[0] == 0x2B1BFE44);
1800                 }
1801         }
1802
1803         return ERROR_OK;
1804 }
1805
1806
1807 /**
1808  * Get protection (sector security) status.
1809  *
1810  * Determine the status of "sector security" for each sector.
1811  * A secured sector is one that can never be erased/programmed again.
1812  *
1813  * @param bank Pointer to the flash bank descriptor
1814  */
1815 static int lpc2900_protect_check(struct flash_bank *bank)
1816 {
1817         return lpc2900_read_security_status(bank);
1818 }
1819
1820
1821 /**
1822  * Print info about the driver (not the device).
1823  *
1824  * @param bank Pointer to the flash bank descriptor
1825  * @param buf Buffer to take the string
1826  * @param buf_size Maximum number of characters that the buffer can take
1827  */
1828 static int lpc2900_info(struct flash_bank *bank, char *buf, int buf_size)
1829 {
1830         snprintf(buf, buf_size, "lpc2900 flash driver");
1831
1832         return ERROR_OK;
1833 }
1834
1835
1836 struct flash_driver lpc2900_flash =
1837 {
1838         .name               = "lpc2900",
1839         .commands           = lpc2900_command_handlers,
1840         .flash_bank_command = lpc2900_flash_bank_command,
1841         .erase              = lpc2900_erase,
1842         .protect            = lpc2900_protect,
1843         .write              = lpc2900_write,
1844         .read               = default_flash_read,
1845         .probe              = lpc2900_probe,
1846         .auto_probe         = lpc2900_probe,
1847         .erase_check        = lpc2900_erase_check,
1848         .protect_check      = lpc2900_protect_check,
1849         .info               = lpc2900_info
1850 };