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

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   LPC1700 support Copyright (C) 2009 by Audrius Urmanavicius            *
   6  *   didele.deze@gmail.com                                                 *
   7  *   LPC11Uxx support Copyright (C) 2012 by Jared Boone, ShareBrained      *
   8  *   Technology, jared@sharebrained.com                                    *
   9  *                                                                         *
  10  *   This program is free software; you can redistribute it and/or modify  *
  11  *   it under the terms of the GNU General Public License as published by  *
  12  *   the Free Software Foundation; either version 2 of the License, or     *
  13  *   (at your option) any later version.                                   *
  14  *                                                                         *
  15  *   This program is distributed in the hope that it will be useful,       *
  16  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  17  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  18  *   GNU General Public License for more details.                          *
  19  *                                                                         *
  20  *   You should have received a copy of the GNU General Public License     *
  21  *   along with this program; if not, write to the                         *
  22  *   Free Software Foundation, Inc.,                                       *
  23  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  24  ***************************************************************************/
  25
  26 #ifdef HAVE_CONFIG_H
  27 #include "config.h"
  28 #endif
  29
  30 #include "imp.h"
  31 #include <helper/binarybuffer.h>
  32 #include <target/algorithm.h>
  33 #include <target/arm_opcodes.h>
  34 #include <target/armv7m.h>
  35
  36 /**
  37  * @file
  38  * flash programming support for NXP LPC11Uxx, LPC17xx and LPC2xxx devices.
  39  *
  40  * @todo Provide a way to update CCLK after declaring the flash bank. The value which is correct after chip reset will
  41  * rarely still work right after the clocks switch to use the PLL (e.g. 4MHz --> 100 MHz).
  42  */
  43 /*
  44  * currently supported devices:
  45  * variant 1 (lpc2000_v1):
  46  * - 2104 | 5 | 6
  47  * - 2114 | 9
  48  * - 2124 | 9
  49  * - 2194
  50  * - 2212 | 4
  51  * - 2292 | 4
  52  *
  53  * variant 2 (lpc2000_v2):
  54  * - 213x
  55  * - 214x
  56  * - 2101 | 2 | 3
  57  * - 2364 | 6 | 8
  58  * - 2378
  59  *
  60  * lpc1700:
  61  * - 175x
  62  * - 176x (tested with LPC1768)
  63  *
  64  * lpc11u:
  65  * - 11Uxx (tested with LPC11U14)
  66  */
  67
  68 typedef enum {
  69         lpc2000_v1,
  70         lpc2000_v2,
  71         lpc1700,
  72         lpc11u,
  73 } lpc2000_variant;
  74
  75 struct lpc2000_flash_bank {
  76         lpc2000_variant variant;
  77         uint32_t cclk;
  78         int cmd51_dst_boundary;
  79         int cmd51_can_256b;
  80         int cmd51_can_8192b;
  81         int calc_checksum;
  82         uint32_t cmd51_max_buffer;
  83         int checksum_vector;
  84 };
  85
  86 enum lpc2000_status_codes {
  87         LPC2000_CMD_SUCCESS = 0,
  88         LPC2000_INVALID_COMMAND = 1,
  89         LPC2000_SRC_ADDR_ERROR = 2,
  90         LPC2000_DST_ADDR_ERROR = 3,
  91         LPC2000_SRC_ADDR_NOT_MAPPED = 4,
  92         LPC2000_DST_ADDR_NOT_MAPPED = 5,
  93         LPC2000_COUNT_ERROR = 6,
  94         LPC2000_INVALID_SECTOR = 7,
  95         LPC2000_SECTOR_NOT_BLANK = 8,
  96         LPC2000_SECTOR_NOT_PREPARED = 9,
  97         LPC2000_COMPARE_ERROR = 10,
  98         LPC2000_BUSY = 11,
  99         LPC2000_PARAM_ERROR = 12,
 100         LPC2000_ADDR_ERROR = 13,
 101         LPC2000_ADDR_NOT_MAPPED = 14,
 102         LPC2000_CMD_NOT_LOCKED = 15,
 103         LPC2000_INVALID_CODE = 16,
 104         LPC2000_INVALID_BAUD_RATE = 17,
 105         LPC2000_INVALID_STOP_BIT = 18,
 106         LPC2000_CRP_ENABLED = 19
 107 };
 108
 109 static int lpc2000_build_sector_list(struct flash_bank *bank)
 110 {
 111         struct lpc2000_flash_bank *lpc2000_info = bank->driver_priv;
 112         uint32_t offset = 0;
 113
 114         /* default to a 4096 write buffer */
 115         lpc2000_info->cmd51_max_buffer = 4096;
 116
 117         if (lpc2000_info->variant == lpc2000_v1) {
 118                 /* variant 1 has different layout for 128kb and 256kb flashes */
 119                 if (bank->size == 128 * 1024) {
 120                         bank->num_sectors = 16;
 121                         bank->sectors = malloc(sizeof(struct flash_sector) * 16);
 122                         for (int i = 0; i < 16; i++) {
 123                                 bank->sectors[i].offset = offset;
 124                                 bank->sectors[i].size = 8 * 1024;
 125                                 offset += bank->sectors[i].size;
 126                                 bank->sectors[i].is_erased = -1;
 127                                 bank->sectors[i].is_protected = 1;
 128                         }
 129                 } else if (bank->size == 256 * 1024) {
 130                         bank->num_sectors = 18;
 131                         bank->sectors = malloc(sizeof(struct flash_sector) * 18);
 132
 133                         for (int i = 0; i < 8; i++) {
 134                                 bank->sectors[i].offset = offset;
 135                                 bank->sectors[i].size = 8 * 1024;
 136                                 offset += bank->sectors[i].size;
 137                                 bank->sectors[i].is_erased = -1;
 138                                 bank->sectors[i].is_protected = 1;
 139                         }
 140                         for (int i = 8; i < 10; i++) {
 141                                 bank->sectors[i].offset = offset;
 142                                 bank->sectors[i].size = 64 * 1024;
 143                                 offset += bank->sectors[i].size;
 144                                 bank->sectors[i].is_erased = -1;
 145                                 bank->sectors[i].is_protected = 1;
 146                         }
 147                         for (int i = 10; i < 18; i++) {
 148                                 bank->sectors[i].offset = offset;
 149                                 bank->sectors[i].size = 8 * 1024;
 150                                 offset += bank->sectors[i].size;
 151                                 bank->sectors[i].is_erased = -1;
 152                                 bank->sectors[i].is_protected = 1;
 153                         }
 154                 } else {
 155                         LOG_ERROR("BUG: unknown bank->size encountered");
 156                         exit(-1);
 157                 }
 158         } else if (lpc2000_info->variant == lpc2000_v2) {
 159                 /* variant 2 has a uniform layout, only number of sectors differs */
 160                 switch (bank->size) {
 161                         case 4 * 1024:
 162                                 lpc2000_info->cmd51_max_buffer = 1024;
 163                                 bank->num_sectors = 1;
 164                                 break;
 165                         case 8 * 1024:
 166                                 lpc2000_info->cmd51_max_buffer = 1024;
 167                                 bank->num_sectors = 2;
 168                                 break;
 169                         case 16 * 1024:
 170                                 bank->num_sectors = 4;
 171                                 break;
 172                         case 32 * 1024:
 173                                 bank->num_sectors = 8;
 174                                 break;
 175                         case 64 * 1024:
 176                                 bank->num_sectors = 9;
 177                                 break;
 178                         case 128 * 1024:
 179                                 bank->num_sectors = 11;
 180                                 break;
 181                         case 256 * 1024:
 182                                 bank->num_sectors = 15;
 183                                 break;
 184                         case 500 * 1024:
 185                                 bank->num_sectors = 27;
 186                                 break;
 187                         case 512 * 1024:
 188                         case 504 * 1024:
 189                                 bank->num_sectors = 28;
 190                                 break;
 191                         default:
 192                                 LOG_ERROR("BUG: unknown bank->size encountered");
 193                                 exit(-1);
 194                                 break;
 195                 }
 196
 197                 bank->sectors = malloc(sizeof(struct flash_sector) * bank->num_sectors);
 198
 199                 for (int i = 0; i < bank->num_sectors; i++) {
 200                         if (i < 8) {
 201                                 bank->sectors[i].offset = offset;
 202                                 bank->sectors[i].size = 4 * 1024;
 203                                 offset += bank->sectors[i].size;
 204                                 bank->sectors[i].is_erased = -1;
 205                                 bank->sectors[i].is_protected = 1;
 206                         } else if (i < 22) {
 207                                 bank->sectors[i].offset = offset;
 208                                 bank->sectors[i].size = 32 * 1024;
 209                                 offset += bank->sectors[i].size;
 210                                 bank->sectors[i].is_erased = -1;
 211                                 bank->sectors[i].is_protected = 1;
 212                         } else if (i < 28) {
 213                                 bank->sectors[i].offset = offset;
 214                                 bank->sectors[i].size = 4 * 1024;
 215                                 offset += bank->sectors[i].size;
 216                                 bank->sectors[i].is_erased = -1;
 217                                 bank->sectors[i].is_protected = 1;
 218                         }
 219                 }
 220         } else if (lpc2000_info->variant == lpc1700) {
 221                 switch (bank->size) {
 222                         case 32 * 1024:
 223                                 bank->num_sectors = 8;
 224                                 break;
 225                         case 64 * 1024:
 226                                 bank->num_sectors = 16;
 227                                 break;
 228                         case 128 * 1024:
 229                                 bank->num_sectors = 18;
 230                         break;
 231                         case 256 * 1024:
 232                                 bank->num_sectors = 22;
 233                                 break;
 234                         case 512 * 1024:
 235                                 bank->num_sectors = 30;
 236                                 break;
 237                         default:
 238                                 LOG_ERROR("BUG: unknown bank->size encountered");
 239                                 exit(-1);
 240                 }
 241
 242                 bank->sectors = malloc(sizeof(struct flash_sector) * bank->num_sectors);
 243
 244                 for (int i = 0; i < bank->num_sectors; i++) {
 245                         bank->sectors[i].offset = offset;
 246                         /* sectors 0-15 are 4kB-sized, 16 and above are 32kB-sized for LPC17xx devices */
 247                         bank->sectors[i].size = (i < 16) ? 4 * 1024 : 32 * 1024;
 248                         offset += bank->sectors[i].size;
 249                         bank->sectors[i].is_erased = -1;
 250                         bank->sectors[i].is_protected = 1;
 251                 }
 252         } else if (lpc2000_info->variant == lpc11u) {
 253                 lpc2000_info->cmd51_max_buffer = 1024;
 254
 255                 switch (bank->size) {
 256                         case 16 * 1024:
 257                                 bank->num_sectors = 4;
 258                                 break;
 259                         case 24 * 1024:
 260                                 bank->num_sectors = 6;
 261                                 break;
 262                         case 32 * 1024:
 263                                 bank->num_sectors = 8;
 264                                 break;
 265                         default:
 266                                 LOG_ERROR("BUG: unknown bank->size encountered");
 267                                 exit(-1);
 268                 }
 269
 270                 bank->sectors = malloc(sizeof(struct flash_sector) * bank->num_sectors);
 271
 272                 for (int i = 0; i < bank->num_sectors; i++) {
 273                         bank->sectors[i].offset = offset;
 274                         /* All sectors are 4kB-sized */
 275                         bank->sectors[i].size = 4 * 1024;
 276                         offset += bank->sectors[i].size;
 277                         bank->sectors[i].is_erased = -1;
 278                         bank->sectors[i].is_protected = 1;
 279                 }
 280         } else {
 281                 LOG_ERROR("BUG: unknown lpc2000_info->variant encountered");
 282                 exit(-1);
 283         }
 284
 285         return ERROR_OK;
 286 }
 287
 288 /* this function allocates and initializes working area used for IAP algorithm
 289  * uses 180 bytes working area
 290  * 0x0 to 0x7: jump gate (BX to thumb state, b -2 to wait)
 291  * 0x8 to 0x1f: command parameter table (1+5 words)
 292  * 0x20 to 0x33: command result table (1+4 words)
 293  * 0x34 to 0xb3: stack (only 128b needed)
 294  */
 295
 296 static int lpc2000_iap_working_area_init(struct flash_bank *bank, struct working_area **iap_working_area)
 297 {
 298         struct target *target = bank->target;
 299
 300         if (target_alloc_working_area(target, 180, iap_working_area) != ERROR_OK) {
 301                 LOG_ERROR("no working area specified, can't write LPC2000 internal flash");
 302                 return ERROR_FLASH_OPERATION_FAILED;
 303         }
 304
 305         struct lpc2000_flash_bank *lpc2000_info = bank->driver_priv;
 306         uint8_t jump_gate[8];
 307
 308         /* write IAP code to working area */
 309         switch (lpc2000_info->variant) {
 310                 case lpc11u:
 311                 case lpc1700:
 312                         target_buffer_set_u32(target, jump_gate, ARMV4_5_T_BX(12));
 313                         target_buffer_set_u32(target, jump_gate + 4, ARMV5_T_BKPT(0));
 314                         break;
 315                 case lpc2000_v1:
 316                 case lpc2000_v2:
 317                         target_buffer_set_u32(target, jump_gate, ARMV4_5_BX(12));
 318                         target_buffer_set_u32(target, jump_gate + 4, ARMV4_5_B(0xfffffe, 0));
 319                         break;
 320                 default:
 321                         LOG_ERROR("BUG: unknown lpc2000_info->variant encountered");
 322                         exit(-1);
 323         }
 324
 325         int retval = target_write_memory(target, (*iap_working_area)->address, 4, 2, jump_gate);
 326         if (retval != ERROR_OK)
 327                 LOG_ERROR("Write memory at address 0x%8.8" PRIx32 " failed (check work_area definition)",
 328                                 (*iap_working_area)->address);
 329
 330         return retval;
 331 }
 332
 333 /* call LPC1700/LPC2000 IAP function */
 334
 335 static int lpc2000_iap_call(struct flash_bank *bank, struct working_area *iap_working_area, int code,
 336                 uint32_t param_table[5], uint32_t result_table[4])
 337 {
 338         struct lpc2000_flash_bank *lpc2000_info = bank->driver_priv;
 339
 340         struct arm_algorithm arm_algo;  /* for LPC2000 */
 341         struct armv7m_algorithm armv7m_info;    /* for LPC1700 */
 342         uint32_t iap_entry_point = 0;   /* to make compiler happier */
 343
 344         switch (lpc2000_info->variant) {
 345                 case lpc11u:
 346                 case lpc1700:
 347                         armv7m_info.common_magic = ARMV7M_COMMON_MAGIC;
 348                         armv7m_info.core_mode = ARMV7M_MODE_ANY;
 349                         iap_entry_point = 0x1fff1ff1;
 350                         break;
 351                 case lpc2000_v1:
 352                 case lpc2000_v2:
 353                         arm_algo.common_magic = ARM_COMMON_MAGIC;
 354                         arm_algo.core_mode = ARM_MODE_SVC;
 355                         arm_algo.core_state = ARM_STATE_ARM;
 356                         iap_entry_point = 0x7ffffff1;
 357                         break;
 358                 default:
 359                         LOG_ERROR("BUG: unknown lpc2000->variant encountered");
 360                         exit(-1);
 361         }
 362
 363         struct target *target = bank->target;
 364         struct mem_param mem_params[2];
 365
 366         /* command parameter table */
 367         init_mem_param(&mem_params[0], iap_working_area->address + 8, 6 * 4, PARAM_OUT);
 368         target_buffer_set_u32(target, mem_params[0].value, code);
 369         target_buffer_set_u32(target, mem_params[0].value + 0x04, param_table[0]);
 370         target_buffer_set_u32(target, mem_params[0].value + 0x08, param_table[1]);
 371         target_buffer_set_u32(target, mem_params[0].value + 0x0c, param_table[2]);
 372         target_buffer_set_u32(target, mem_params[0].value + 0x10, param_table[3]);
 373         target_buffer_set_u32(target, mem_params[0].value + 0x14, param_table[4]);
 374
 375         struct reg_param reg_params[5];
 376
 377         init_reg_param(&reg_params[0], "r0", 32, PARAM_OUT);
 378         buf_set_u32(reg_params[0].value, 0, 32, iap_working_area->address + 0x08);
 379
 380         /* command result table */
 381         init_mem_param(&mem_params[1], iap_working_area->address + 0x20, 5 * 4, PARAM_IN);
 382
 383         init_reg_param(&reg_params[1], "r1", 32, PARAM_OUT);
 384         buf_set_u32(reg_params[1].value, 0, 32, iap_working_area->address + 0x20);
 385
 386         /* IAP entry point */
 387         init_reg_param(&reg_params[2], "r12", 32, PARAM_OUT);
 388         buf_set_u32(reg_params[2].value, 0, 32, iap_entry_point);
 389
 390         switch (lpc2000_info->variant) {
 391                 case lpc11u:
 392                 case lpc1700:
 393                         /* IAP stack */
 394                         init_reg_param(&reg_params[3], "sp", 32, PARAM_OUT);
 395                         buf_set_u32(reg_params[3].value, 0, 32, iap_working_area->address + 0xb4);
 396
 397                         /* return address */
 398                         init_reg_param(&reg_params[4], "lr", 32, PARAM_OUT);
 399                         buf_set_u32(reg_params[4].value, 0, 32, (iap_working_area->address + 0x04) | 1);
 400                         /* bit0 of LR = 1 to return in Thumb mode */
 401
 402                         target_run_algorithm(target, 2, mem_params, 5, reg_params, iap_working_area->address, 0, 10000,
 403                                         &armv7m_info);
 404                         break;
 405                 case lpc2000_v1:
 406                 case lpc2000_v2:
 407                         /* IAP stack */
 408                         init_reg_param(&reg_params[3], "sp_svc", 32, PARAM_OUT);
 409                         buf_set_u32(reg_params[3].value, 0, 32, iap_working_area->address + 0xb4);
 410
 411                         /* return address */
 412                         init_reg_param(&reg_params[4], "lr_svc", 32, PARAM_OUT);
 413                         buf_set_u32(reg_params[4].value, 0, 32, iap_working_area->address + 0x04);
 414
 415                         target_run_algorithm(target, 2, mem_params, 5, reg_params, iap_working_area->address,
 416                                         iap_working_area->address + 0x4, 10000, &arm_algo);
 417                         break;
 418                 default:
 419                         LOG_ERROR("BUG: unknown lpc2000->variant encountered");
 420                         exit(-1);
 421         }
 422
 423         int status_code = target_buffer_get_u32(target, mem_params[1].value);
 424         result_table[0] = target_buffer_get_u32(target, mem_params[1].value + 0x04);
 425         result_table[1] = target_buffer_get_u32(target, mem_params[1].value + 0x08);
 426         result_table[2] = target_buffer_get_u32(target, mem_params[1].value + 0x0c);
 427         result_table[3] = target_buffer_get_u32(target, mem_params[1].value + 0x10);
 428
 429         LOG_DEBUG("IAP command = %i (0x%8.8" PRIx32 ", 0x%8.8" PRIx32 ", 0x%8.8" PRIx32 ", 0x%8.8" PRIx32 ", 0x%8.8" PRIx32
 430                         ") completed with result = %8.8" PRIx32,
 431                         code, param_table[0], param_table[1], param_table[2], param_table[3], param_table[4], status_code);
 432
 433         destroy_mem_param(&mem_params[0]);
 434         destroy_mem_param(&mem_params[1]);
 435
 436         destroy_reg_param(&reg_params[0]);
 437         destroy_reg_param(&reg_params[1]);
 438         destroy_reg_param(&reg_params[2]);
 439         destroy_reg_param(&reg_params[3]);
 440         destroy_reg_param(&reg_params[4]);
 441
 442         return status_code;
 443 }
 444
 445 static int lpc2000_iap_blank_check(struct flash_bank *bank, int first, int last)
 446 {
 447         if ((first < 0) || (last >= bank->num_sectors))
 448                 return ERROR_FLASH_SECTOR_INVALID;
 449
 450         uint32_t param_table[5] = {0};
 451         uint32_t result_table[4];
 452         struct working_area *iap_working_area;
 453
 454         int retval = lpc2000_iap_working_area_init(bank, &iap_working_area);
 455
 456         if (retval != ERROR_OK)
 457                 return retval;
 458
 459         for (int i = first; i <= last && retval == ERROR_OK; i++) {
 460                 /* check single sector */
 461                 param_table[0] = param_table[1] = i;
 462                 int status_code = lpc2000_iap_call(bank, iap_working_area, 53, param_table, result_table);
 463
 464                 switch (status_code) {
 465                         case ERROR_FLASH_OPERATION_FAILED:
 466                                 retval = ERROR_FLASH_OPERATION_FAILED;
 467                                 break;
 468                         case LPC2000_CMD_SUCCESS:
 469                                 bank->sectors[i].is_erased = 1;
 470                                 break;
 471                         case LPC2000_SECTOR_NOT_BLANK:
 472                                 bank->sectors[i].is_erased = 0;
 473                                 break;
 474                         case LPC2000_INVALID_SECTOR:
 475                                 bank->sectors[i].is_erased = 0;
 476                                 break;
 477                         case LPC2000_BUSY:
 478                                 retval = ERROR_FLASH_BUSY;
 479                                 break;
 480                         default:
 481                                 LOG_ERROR("BUG: unknown LPC2000 status code %i", status_code);
 482                                 exit(-1);
 483                 }
 484         }
 485
 486         struct target *target = bank->target;
 487         target_free_working_area(target, iap_working_area);
 488
 489         return retval;
 490 }
 491
 492 /*
 493  * flash bank lpc2000 <base> <size> 0 0 <target#> <lpc_variant> <cclk> [calc_checksum]
 494  */
 495 FLASH_BANK_COMMAND_HANDLER(lpc2000_flash_bank_command)
 496 {
 497         if (CMD_ARGC < 8)
 498                 return ERROR_COMMAND_SYNTAX_ERROR;
 499
 500         struct lpc2000_flash_bank *lpc2000_info = malloc(sizeof(struct lpc2000_flash_bank));
 501         bank->driver_priv = lpc2000_info;
 502
 503         if (strcmp(CMD_ARGV[6], "lpc2000_v1") == 0) {
 504                 lpc2000_info->variant = lpc2000_v1;
 505                 lpc2000_info->cmd51_dst_boundary = 512;
 506                 lpc2000_info->cmd51_can_256b = 0;
 507                 lpc2000_info->cmd51_can_8192b = 1;
 508                 lpc2000_info->checksum_vector = 5;
 509         } else if (strcmp(CMD_ARGV[6], "lpc2000_v2") == 0) {
 510                 lpc2000_info->variant = lpc2000_v2;
 511                 lpc2000_info->cmd51_dst_boundary = 256;
 512                 lpc2000_info->cmd51_can_256b = 1;
 513                 lpc2000_info->cmd51_can_8192b = 0;
 514                 lpc2000_info->checksum_vector = 5;
 515         } else if (strcmp(CMD_ARGV[6], "lpc1700") == 0) {
 516                 lpc2000_info->variant = lpc1700;
 517                 lpc2000_info->cmd51_dst_boundary = 256;
 518                 lpc2000_info->cmd51_can_256b = 1;
 519                 lpc2000_info->cmd51_can_8192b = 0;
 520                 lpc2000_info->checksum_vector = 7;
 521         } else if (strcmp(CMD_ARGV[6], "lpc11u") == 0) {
 522                 lpc2000_info->variant = lpc11u;
 523                 lpc2000_info->cmd51_dst_boundary = 256;
 524                 lpc2000_info->cmd51_can_256b = 1;
 525                 lpc2000_info->cmd51_can_8192b = 0;
 526                 lpc2000_info->checksum_vector = 7;
 527         } else {
 528                 LOG_ERROR("unknown LPC2000 variant: %s", CMD_ARGV[6]);
 529                 free(lpc2000_info);
 530                 return ERROR_FLASH_BANK_INVALID;
 531         }
 532
 533         COMMAND_PARSE_NUMBER(u32, CMD_ARGV[7], lpc2000_info->cclk);
 534         lpc2000_info->calc_checksum = 0;
 535         lpc2000_build_sector_list(bank);
 536
 537         if (CMD_ARGC >= 9) {
 538                 if (strcmp(CMD_ARGV[8], "calc_checksum") == 0)
 539                         lpc2000_info->calc_checksum = 1;
 540         }
 541
 542         return ERROR_OK;
 543 }
 544
 545 static int lpc2000_erase(struct flash_bank *bank, int first, int last)
 546 {
 547         if (bank->target->state != TARGET_HALTED) {
 548                 LOG_ERROR("Target not halted");
 549                 return ERROR_TARGET_NOT_HALTED;
 550         }
 551
 552         struct lpc2000_flash_bank *lpc2000_info = bank->driver_priv;
 553         uint32_t param_table[5] = {0};
 554
 555         param_table[0] = first;
 556         param_table[1] = last;
 557         param_table[2] = lpc2000_info->cclk;
 558
 559         uint32_t result_table[4];
 560         struct working_area *iap_working_area;
 561
 562         int retval = lpc2000_iap_working_area_init(bank, &iap_working_area);
 563
 564         if (retval != ERROR_OK)
 565                 return retval;
 566
 567         /* Prepare sectors */
 568         int status_code = lpc2000_iap_call(bank, iap_working_area, 50, param_table, result_table);
 569         switch (status_code) {
 570                 case ERROR_FLASH_OPERATION_FAILED:
 571                         retval = ERROR_FLASH_OPERATION_FAILED;
 572                         break;
 573                 case LPC2000_CMD_SUCCESS:
 574                         break;
 575                 case LPC2000_INVALID_SECTOR:
 576                         retval = ERROR_FLASH_SECTOR_INVALID;
 577                         break;
 578                 default:
 579                         LOG_WARNING("lpc2000 prepare sectors returned %i", status_code);
 580                         retval = ERROR_FLASH_OPERATION_FAILED;
 581                         break;
 582         }
 583
 584         if (retval == ERROR_OK) {
 585                 /* Erase sectors */
 586                 status_code = lpc2000_iap_call(bank, iap_working_area, 52, param_table, result_table);
 587                 switch (status_code) {
 588                         case ERROR_FLASH_OPERATION_FAILED:
 589                                 retval = ERROR_FLASH_OPERATION_FAILED;
 590                                 break;
 591                         case LPC2000_CMD_SUCCESS:
 592                                 break;
 593                         case LPC2000_INVALID_SECTOR:
 594                                 retval = ERROR_FLASH_SECTOR_INVALID;
 595                                 break;
 596                         default:
 597                                 LOG_WARNING("lpc2000 erase sectors returned %i", status_code);
 598                                 retval = ERROR_FLASH_OPERATION_FAILED;
 599                                 break;
 600                 }
 601         }
 602
 603         struct target *target = bank->target;
 604         target_free_working_area(target, iap_working_area);
 605
 606         return retval;
 607 }
 608
 609 static int lpc2000_protect(struct flash_bank *bank, int set, int first, int last)
 610 {
 611         /* can't protect/unprotect on the lpc2000 */
 612         return ERROR_OK;
 613 }
 614
 615 static int lpc2000_write(struct flash_bank *bank, uint8_t *buffer, uint32_t offset, uint32_t count)
 616 {
 617         struct target *target = bank->target;
 618
 619         if (bank->target->state != TARGET_HALTED) {
 620                 LOG_ERROR("Target not halted");
 621                 return ERROR_TARGET_NOT_HALTED;
 622         }
 623
 624         if (offset + count > bank->size)
 625                 return ERROR_FLASH_DST_OUT_OF_BANK;
 626
 627         struct lpc2000_flash_bank *lpc2000_info = bank->driver_priv;
 628
 629         uint32_t dst_min_alignment = lpc2000_info->cmd51_dst_boundary;
 630
 631         if (offset % dst_min_alignment) {
 632                 LOG_WARNING("offset 0x%" PRIx32 " breaks required alignment 0x%" PRIx32, offset, dst_min_alignment);
 633                 return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
 634         }
 635
 636         int first_sector = 0;
 637         int last_sector = 0;
 638
 639         for (int i = 0; i < bank->num_sectors; i++) {
 640                 if (offset >= bank->sectors[i].offset)
 641                         first_sector = i;
 642                 if (offset + DIV_ROUND_UP(count, dst_min_alignment) * dst_min_alignment > bank->sectors[i].offset)
 643                         last_sector = i;
 644         }
 645
 646         LOG_DEBUG("first_sector: %i, last_sector: %i", first_sector, last_sector);
 647
 648         /* check if exception vectors should be flashed */
 649         if ((offset == 0) && (count >= 0x20) && lpc2000_info->calc_checksum) {
 650                 uint32_t checksum = 0;
 651                 for (int i = 0; i < 8; i++) {
 652                         LOG_DEBUG("Vector 0x%2.2x: 0x%8.8" PRIx32, i * 4, buf_get_u32(buffer + (i * 4), 0, 32));
 653                         if (i != lpc2000_info->checksum_vector)
 654                                 checksum += buf_get_u32(buffer + (i * 4), 0, 32);
 655                 }
 656                 checksum = 0 - checksum;
 657                 LOG_DEBUG("checksum: 0x%8.8" PRIx32, checksum);
 658
 659                 uint32_t original_value = buf_get_u32(buffer + (lpc2000_info->checksum_vector * 4), 0, 32);
 660                 if (original_value != checksum) {
 661                         LOG_WARNING("Verification will fail since checksum in image (0x%8.8" PRIx32 ") to be written to flash is "
 662                                         "different from calculated vector checksum (0x%8.8" PRIx32 ").", original_value, checksum);
 663                         LOG_WARNING("To remove this warning modify build tools on developer PC to inject correct LPC vector "
 664                                         "checksum.");
 665                 }
 666
 667                 buf_set_u32(buffer + (lpc2000_info->checksum_vector * 4), 0, 32, checksum);
 668         }
 669
 670         struct working_area *iap_working_area;
 671
 672         int retval = lpc2000_iap_working_area_init(bank, &iap_working_area);
 673
 674         if (retval != ERROR_OK)
 675                 return retval;
 676
 677         struct working_area *download_area;
 678
 679         /* allocate a working area */
 680         if (target_alloc_working_area(target, lpc2000_info->cmd51_max_buffer, &download_area) != ERROR_OK) {
 681                 LOG_ERROR("no working area specified, can't write LPC2000 internal flash");
 682                 target_free_working_area(target, iap_working_area);
 683                 return ERROR_FLASH_OPERATION_FAILED;
 684         }
 685
 686         uint32_t bytes_remaining = count;
 687         uint32_t bytes_written = 0;
 688         uint32_t param_table[5] = {0};
 689         uint32_t result_table[4];
 690
 691         while (bytes_remaining > 0) {
 692                 uint32_t thisrun_bytes;
 693                 if (bytes_remaining >= lpc2000_info->cmd51_max_buffer)
 694                         thisrun_bytes = lpc2000_info->cmd51_max_buffer;
 695                 else if (bytes_remaining >= 1024)
 696                         thisrun_bytes = 1024;
 697                 else if ((bytes_remaining >= 512) || (!lpc2000_info->cmd51_can_256b))
 698                         thisrun_bytes = 512;
 699                 else
 700                         thisrun_bytes = 256;
 701
 702                 /* Prepare sectors */
 703                 param_table[0] = first_sector;
 704                 param_table[1] = last_sector;
 705                 int status_code = lpc2000_iap_call(bank, iap_working_area, 50, param_table, result_table);
 706                 switch (status_code) {
 707                         case ERROR_FLASH_OPERATION_FAILED:
 708                                 retval = ERROR_FLASH_OPERATION_FAILED;
 709                                 break;
 710                         case LPC2000_CMD_SUCCESS:
 711                                 break;
 712                         case LPC2000_INVALID_SECTOR:
 713                                 retval = ERROR_FLASH_SECTOR_INVALID;
 714                                 break;
 715                         default:
 716                                 LOG_WARNING("lpc2000 prepare sectors returned %i", status_code);
 717                                 retval = ERROR_FLASH_OPERATION_FAILED;
 718                                 break;
 719                 }
 720
 721                 /* Exit if error occured */
 722                 if (retval != ERROR_OK)
 723                         break;
 724
 725                 if (bytes_remaining >= thisrun_bytes) {
 726                         retval = target_write_buffer(bank->target, download_area->address, thisrun_bytes, buffer + bytes_written);
 727                         if (retval != ERROR_OK) {
 728                                 retval = ERROR_FLASH_OPERATION_FAILED;
 729                                 break;
 730                         }
 731                 } else {
 732                         uint8_t *last_buffer = malloc(thisrun_bytes);
 733                         memcpy(last_buffer, buffer + bytes_written, bytes_remaining);
 734                         memset(last_buffer + bytes_remaining, 0xff, thisrun_bytes - bytes_remaining);
 735                         target_write_buffer(bank->target, download_area->address, thisrun_bytes, last_buffer);
 736                         free(last_buffer);
 737                 }
 738
 739                 LOG_DEBUG("writing 0x%" PRIx32 " bytes to address 0x%" PRIx32, thisrun_bytes,
 740                                 bank->base + offset + bytes_written);
 741
 742                 /* Write data */
 743                 param_table[0] = bank->base + offset + bytes_written;
 744                 param_table[1] = download_area->address;
 745                 param_table[2] = thisrun_bytes;
 746                 param_table[3] = lpc2000_info->cclk;
 747                 status_code = lpc2000_iap_call(bank, iap_working_area, 51, param_table, result_table);
 748                 switch (status_code) {
 749                         case ERROR_FLASH_OPERATION_FAILED:
 750                                 retval = ERROR_FLASH_OPERATION_FAILED;
 751                                 break;
 752                         case LPC2000_CMD_SUCCESS:
 753                                 break;
 754                         case LPC2000_INVALID_SECTOR:
 755                                 retval = ERROR_FLASH_SECTOR_INVALID;
 756                                 break;
 757                         default:
 758                                 LOG_WARNING("lpc2000 returned %i", status_code);
 759                                 retval = ERROR_FLASH_OPERATION_FAILED;
 760                                 break;
 761                 }
 762
 763                 /* Exit if error occured */
 764                 if (retval != ERROR_OK)
 765                         break;
 766
 767                 if (bytes_remaining > thisrun_bytes)
 768                         bytes_remaining -= thisrun_bytes;
 769                 else
 770                         bytes_remaining = 0;
 771                 bytes_written += thisrun_bytes;
 772         }
 773
 774         target_free_working_area(target, iap_working_area);
 775         target_free_working_area(target, download_area);
 776
 777         return retval;
 778 }
 779
 780 static int lpc2000_probe(struct flash_bank *bank)
 781 {
 782         /* we can't probe on an lpc2000 if this is an lpc2xxx, it has the configured flash */
 783         return ERROR_OK;
 784 }
 785
 786 static int lpc2000_erase_check(struct flash_bank *bank)
 787 {
 788         if (bank->target->state != TARGET_HALTED) {
 789                 LOG_ERROR("Target not halted");
 790                 return ERROR_TARGET_NOT_HALTED;
 791         }
 792
 793         return lpc2000_iap_blank_check(bank, 0, bank->num_sectors - 1);
 794 }
 795
 796 static int lpc2000_protect_check(struct flash_bank *bank)
 797 {
 798         /* sectors are always protected */
 799         return ERROR_OK;
 800 }
 801
 802 static int get_lpc2000_info(struct flash_bank *bank, char *buf, int buf_size)
 803 {
 804         struct lpc2000_flash_bank *lpc2000_info = bank->driver_priv;
 805
 806         snprintf(buf, buf_size, "lpc2000 flash driver variant: %i, clk: %" PRIi32 "kHz", lpc2000_info->variant,
 807                         lpc2000_info->cclk);
 808
 809         return ERROR_OK;
 810 }
 811
 812 COMMAND_HANDLER(lpc2000_handle_part_id_command)
 813 {
 814         if (CMD_ARGC < 1)
 815                 return ERROR_COMMAND_SYNTAX_ERROR;
 816
 817         struct flash_bank *bank;
 818         int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
 819         if (ERROR_OK != retval)
 820                 return retval;
 821
 822         if (bank->target->state != TARGET_HALTED) {
 823                 LOG_ERROR("Target not halted");
 824                 return ERROR_TARGET_NOT_HALTED;
 825         }
 826
 827         uint32_t param_table[5] = {0};
 828         uint32_t result_table[4];
 829         struct working_area *iap_working_area;
 830
 831         retval = lpc2000_iap_working_area_init(bank, &iap_working_area);
 832
 833         if (retval != ERROR_OK)
 834                 return retval;
 835
 836         int status_code = lpc2000_iap_call(bank, iap_working_area, 54, param_table, result_table);
 837         if (status_code != 0x0) {
 838                 if (status_code == ERROR_FLASH_OPERATION_FAILED) {
 839                         command_print(CMD_CTX, "no sufficient working area specified, can't access LPC2000 IAP interface");
 840                 } else
 841                         command_print(CMD_CTX, "lpc2000 IAP returned status code %i", status_code);
 842         } else
 843                 command_print(CMD_CTX, "lpc2000 part id: 0x%8.8" PRIx32, result_table[0]);
 844
 845         return retval;
 846 }
 847
 848 static const struct command_registration lpc2000_exec_command_handlers[] = {
 849         {
 850                 .name = "part_id",
 851                 .handler = lpc2000_handle_part_id_command,
 852                 .mode = COMMAND_EXEC,
 853                 .help = "print part id of lpc2000 flash bank <num>",
 854                 .usage = "<bank>",
 855         },
 856         COMMAND_REGISTRATION_DONE
 857 };
 858 static const struct command_registration lpc2000_command_handlers[] = {
 859         {
 860                 .name = "lpc2000",
 861                 .mode = COMMAND_ANY,
 862                 .help = "lpc2000 flash command group",
 863                 .usage = "",
 864                 .chain = lpc2000_exec_command_handlers,
 865         },
 866         COMMAND_REGISTRATION_DONE
 867 };
 868
 869 struct flash_driver lpc2000_flash = {
 870         .name = "lpc2000",
 871         .commands = lpc2000_command_handlers,
 872         .flash_bank_command = lpc2000_flash_bank_command,
 873         .erase = lpc2000_erase,
 874         .protect = lpc2000_protect,
 875         .write = lpc2000_write,
 876         .read = default_flash_read,
 877         .probe = lpc2000_probe,
 878         .auto_probe = lpc2000_probe,
 879         .erase_check = lpc2000_erase_check,
 880         .protect_check = lpc2000_protect_check,
 881         .info = get_lpc2000_info,
 882 };