src/flash/aduc702x.c

   1 /***************************************************************************
   2  *   Copyright (C) 2008 by Kevin McGuire                                   *
   3  *   Copyright (C) 2008 by Marcel Wijlaars                                 *
   4  *   Copyright (C) 2009 by Michael Ashton                                  *
   5  *                                                                         *
   6  *   This program is free software; you can redistribute it and/or modify  *
   7  *   it under the terms of the GNU General Public License as published by  *
   8  *   the Free Software Foundation; either version 2 of the License, or     *
   9  *   (at your option) any later version.                                   *
  10  *                                                                         *
  11  *   This program is distributed in the hope that it will be useful,       *
  12  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  14  *   GNU General Public License for more details.                          *
  15  *                                                                         *
  16  *   You should have received a copy of the GNU General Public License     *
  17  *   along with this program; if not, write to the                         *
  18  *   Free Software Foundation, Inc.,                                       *
  19  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  20  ***************************************************************************/
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include "config.h"
  24 #endif
  25
  26 #include "flash.h"
  27 #include "armv4_5.h"
  28 #include "binarybuffer.h"
  29 #include "time_support.h"
  30
  31
  32 static int aduc702x_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank);
  33 static int aduc702x_register_commands(struct command_context_s *cmd_ctx);
  34 static int aduc702x_erase(struct flash_bank_s *bank, int first, int last);
  35 static int aduc702x_protect(struct flash_bank_s *bank, int set, int first, int last);
  36 static int aduc702x_write(struct flash_bank_s *bank, uint8_t *buffer, uint32_t offset, uint32_t count);
  37 static int aduc702x_write_single(struct flash_bank_s *bank, uint8_t *buffer, uint32_t offset, uint32_t count);
  38 static int aduc702x_write_block(struct flash_bank_s *bank, uint8_t *buffer, uint32_t offset, uint32_t count);
  39 static int aduc702x_probe(struct flash_bank_s *bank);
  40 static int aduc702x_info(struct flash_bank_s *bank, char *buf, int buf_size);
  41 static int aduc702x_protect_check(struct flash_bank_s *bank);
  42 static int aduc702x_build_sector_list(struct flash_bank_s *bank);
  43 static int aduc702x_check_flash_completion(target_t* target, unsigned int timeout_ms);
  44 static int aduc702x_set_write_enable(target_t *target, int enable);
  45
  46 #define ADUC702x_FLASH                          0xfffff800
  47 #define ADUC702x_FLASH_FEESTA           (0*4)
  48 #define ADUC702x_FLASH_FEEMOD           (1*4)
  49 #define ADUC702x_FLASH_FEECON           (2*4)
  50 #define ADUC702x_FLASH_FEEDAT           (3*4)
  51 #define ADUC702x_FLASH_FEEADR           (4*4)
  52 #define ADUC702x_FLASH_FEESIGN          (5*4)
  53 #define ADUC702x_FLASH_FEEPRO           (6*4)
  54 #define ADUC702x_FLASH_FEEHIDE          (7*4)
  55
  56 typedef struct {
  57         uint32_t feesta;
  58         uint32_t feemod;
  59         uint32_t feecon;
  60         uint32_t feedat;
  61         uint32_t feeadr;
  62         uint32_t feesign;
  63         uint32_t feepro;
  64         uint32_t feehide;
  65 } ADUC702x_FLASH_MMIO;
  66
  67 typedef struct
  68 {
  69         working_area_t *write_algorithm;
  70 } aduc702x_flash_bank_t;
  71
  72 flash_driver_t aduc702x_flash =
  73 {
  74         .name = "aduc702x",
  75         .register_commands = aduc702x_register_commands,
  76         .flash_bank_command = aduc702x_flash_bank_command,
  77         .erase = aduc702x_erase,
  78         .protect = aduc702x_protect,
  79         .write = aduc702x_write,
  80         .probe = aduc702x_probe,
  81         .auto_probe = aduc702x_probe,
  82         .erase_check = default_flash_blank_check,
  83         .protect_check = aduc702x_protect_check,
  84         .info = aduc702x_info
  85 };
  86
  87 static int aduc702x_register_commands(struct command_context_s *cmd_ctx)
  88 {
  89         return ERROR_OK;
  90 }
  91
  92 /* flash bank aduc702x 0 0 0 0 <target#>
  93  * The ADC7019-28 devices all have the same flash layout */
  94 static int aduc702x_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank)
  95 {
  96         aduc702x_flash_bank_t *nbank;
  97
  98         nbank = malloc(sizeof(aduc702x_flash_bank_t));
  99
 100         bank->base = 0x80000;
 101         bank->size = 0xF800; // top 4k not accessible
 102         bank->driver_priv = nbank;
 103
 104         aduc702x_build_sector_list(bank);
 105
 106         return ERROR_OK;
 107 }
 108
 109 static int aduc702x_build_sector_list(struct flash_bank_s *bank)
 110 {
 111         //aduc7026_flash_bank_t *aduc7026_info = bank->driver_priv;
 112
 113         int i = 0;
 114         uint32_t offset = 0;
 115
 116         // sector size is 512
 117         bank->num_sectors = bank->size / 512;
 118         bank->sectors = malloc(sizeof(flash_sector_t) * bank->num_sectors);
 119         for (i = 0; i < bank->num_sectors; ++i)
 120         {
 121                 bank->sectors[i].offset = offset;
 122                 bank->sectors[i].size = 512;
 123                 offset += bank->sectors[i].size;
 124                 bank->sectors[i].is_erased = -1;
 125                 bank->sectors[i].is_protected = 0;
 126         }
 127
 128         return ERROR_OK;
 129 }
 130
 131 static int aduc702x_protect_check(struct flash_bank_s *bank)
 132 {
 133         printf("aduc702x_protect_check not implemented yet.\n");
 134         return ERROR_OK;
 135 }
 136
 137 static int aduc702x_erase(struct flash_bank_s *bank, int first, int last)
 138 {
 139         //int res;
 140         int x;
 141         int count;
 142         //uint32_t v;
 143         target_t *target = bank->target;
 144
 145         aduc702x_set_write_enable(target, 1);
 146
 147         /* mass erase */
 148         if (((first | last) == 0) || ((first == 0) && (last >= bank->num_sectors))) {
 149                 LOG_DEBUG("performing mass erase.\n");
 150                 target_write_u16(target, ADUC702x_FLASH + ADUC702x_FLASH_FEEDAT, 0x3cff);
 151                 target_write_u16(target, ADUC702x_FLASH + ADUC702x_FLASH_FEEADR, 0xffc3);
 152                 target_write_u8(target, ADUC702x_FLASH + ADUC702x_FLASH_FEECON, 0x06);
 153
 154                 if (aduc702x_check_flash_completion(target, 3500) != ERROR_OK)
 155                 {
 156                         LOG_ERROR("mass erase failed\n");
 157                         aduc702x_set_write_enable(target, 0);
 158                         return ERROR_FLASH_OPERATION_FAILED;
 159                 }
 160
 161                 LOG_DEBUG("mass erase successful.\n");
 162                 return ERROR_OK;
 163         } else {
 164                 unsigned long adr;
 165
 166                 count = last - first + 1;
 167                 for (x = 0; x < count; ++x)
 168                 {
 169                         adr = bank->base + ((first + x) * 512);
 170
 171                         target_write_u16(target, ADUC702x_FLASH + ADUC702x_FLASH_FEEADR, adr);
 172                         target_write_u8(target, ADUC702x_FLASH + ADUC702x_FLASH_FEECON, 0x05);
 173
 174                         if (aduc702x_check_flash_completion(target, 50) != ERROR_OK)
 175                         {
 176                                 LOG_ERROR("failed to erase sector at address 0x%08lX\n", adr);
 177                                 aduc702x_set_write_enable(target, 0);
 178                                 return ERROR_FLASH_SECTOR_NOT_ERASED;
 179                         }
 180
 181                         LOG_DEBUG("erased sector at address 0x%08lX\n", adr);
 182                 }
 183         }
 184
 185         aduc702x_set_write_enable(target, 0);
 186
 187         return ERROR_OK;
 188 }
 189
 190 static int aduc702x_protect(struct flash_bank_s *bank, int set, int first, int last)
 191 {
 192         printf("aduc702x_protect not implemented yet.\n");
 193         return ERROR_FLASH_OPERATION_FAILED;
 194 }
 195
 196 /* If this fn returns ERROR_TARGET_RESOURCE_NOT_AVAILABLE, then the caller can fall
 197  * back to another mechanism that does not require onboard RAM
 198  *
 199  * Caller should not check for other return values specifically
 200  */
 201 static int aduc702x_write_block(struct flash_bank_s *bank, uint8_t *buffer, uint32_t offset, uint32_t count)
 202 {
 203         aduc702x_flash_bank_t *aduc702x_info = bank->driver_priv;
 204         target_t *target = bank->target;
 205         uint32_t buffer_size = 7000;
 206         working_area_t *source;
 207         uint32_t address = bank->base + offset;
 208         reg_param_t reg_params[6];
 209         armv4_5_algorithm_t armv4_5_info;
 210         int retval = ERROR_OK;
 211
 212         if (((count%2)!=0)||((offset%2)!=0))
 213         {
 214                 LOG_ERROR("write block must be multiple of two bytes in offset & length");
 215                 return ERROR_FAIL;
 216         }
 217
 218         /* parameters:
 219
 220         r0 - address of source data (absolute)
 221         r1 - number of halfwords to be copied
 222         r2 - start address in flash (offset from beginning of flash memory)
 223         r3 - exit code
 224         r4 - base address of flash controller (0xFFFFF800)
 225
 226         registers:
 227
 228         r5 - scratch
 229         r6 - set to 2, used to write flash command
 230
 231         */
 232         uint32_t aduc702x_flash_write_code[] = {
 233         //<_start>:
 234                 0xe3a05008,     // mov  r5, #8  ; 0x8
 235                 0xe5845004,     // str  r5, [r4, #4]
 236                 0xe3a06002,     // mov  r6, #2  ; 0x2
 237         //<next>:
 238                 0xe1c421b0,     // strh r2, [r4, #16]
 239                 0xe0d050b2,     // ldrh r5, [r0], #2
 240                 0xe1c450bc,     // strh r5, [r4, #12]
 241                 0xe5c46008,     // strb r6, [r4, #8]
 242         //<wait_complete>:
 243                 0xe1d430b0,     // ldrh r3, [r4]
 244                 0xe3130004,     // tst  r3, #4  ; 0x4
 245                 0x1afffffc,     // bne  1001c <wait_complete>
 246                 0xe2822002,     // add  r2, r2, #2      ; 0x2
 247                 0xe2511001,     // subs r1, r1, #1      ; 0x1
 248                 0x0a000001,     // beq  1003c <done>
 249                 0xe3130001,     // tst  r3, #1  ; 0x1
 250                 0x1afffff3,     // bne  1000c <next>
 251         //<done>:
 252                 0xeafffffe      // b    1003c <done>
 253         };
 254
 255         /* flash write code */
 256         if (target_alloc_working_area(target, sizeof(aduc702x_flash_write_code),
 257                 &aduc702x_info->write_algorithm) != ERROR_OK)
 258         {
 259                 LOG_WARNING("no working area available, can't do block memory writes");
 260                 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
 261         };
 262
 263         retval=target_write_buffer(target, aduc702x_info->write_algorithm->address,
 264                 sizeof(aduc702x_flash_write_code), (uint8_t*)aduc702x_flash_write_code);
 265         if (retval!=ERROR_OK)
 266         {
 267                 return retval;
 268         }
 269
 270         /* memory buffer */
 271         while (target_alloc_working_area(target, buffer_size, &source) != ERROR_OK)
 272         {
 273                 buffer_size /= 2;
 274                 if (buffer_size <= 256)
 275                 {
 276                         /* if we already allocated the writing code, but failed to get a buffer, free the algorithm */
 277                         if (aduc702x_info->write_algorithm)
 278                                 target_free_working_area(target, aduc702x_info->write_algorithm);
 279
 280                         LOG_WARNING("no large enough working area available, can't do block memory writes");
 281                         return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
 282                 }
 283         }
 284
 285         armv4_5_info.common_magic = ARMV4_5_COMMON_MAGIC;
 286         armv4_5_info.core_mode = ARMV4_5_MODE_SVC;
 287         armv4_5_info.core_state = ARMV4_5_STATE_ARM;
 288
 289         init_reg_param(&reg_params[0], "r0", 32, PARAM_OUT);
 290         init_reg_param(&reg_params[1], "r1", 32, PARAM_OUT);
 291         init_reg_param(&reg_params[2], "r2", 32, PARAM_OUT);
 292         init_reg_param(&reg_params[3], "r3", 32, PARAM_IN);
 293         init_reg_param(&reg_params[4], "r4", 32, PARAM_OUT);
 294
 295         while (count > 0)
 296         {
 297                 uint32_t thisrun_count = (count > buffer_size) ? buffer_size : count;
 298
 299                 retval=target_write_buffer(target, source->address, thisrun_count, buffer);
 300                 if (retval!=ERROR_OK)
 301                 {
 302                         break;
 303                 }
 304
 305                 buf_set_u32(reg_params[0].value, 0, 32, source->address);
 306                 buf_set_u32(reg_params[1].value, 0, 32, thisrun_count/2);
 307                 buf_set_u32(reg_params[2].value, 0, 32, address);
 308                 buf_set_u32(reg_params[4].value, 0, 32, 0xFFFFF800);
 309
 310                 if ((retval = target_run_algorithm(target, 0, NULL, 5,
 311                         reg_params, aduc702x_info->write_algorithm->address,
 312                         aduc702x_info->write_algorithm->address + sizeof(aduc702x_flash_write_code) - 4,
 313                         10000, &armv4_5_info)) != ERROR_OK)
 314                 {
 315                         LOG_ERROR("error executing aduc702x flash write algorithm");
 316                         break;
 317                 }
 318
 319                 if ((buf_get_u32(reg_params[3].value, 0, 32) & 1) != 1)
 320                 {
 321                         /* FIX!!!! what does this mean??? replace w/sensible error message */
 322                         LOG_ERROR("aduc702x detected error writing flash");
 323                         retval = ERROR_FAIL;
 324                         break;
 325                 }
 326
 327                 buffer += thisrun_count;
 328                 address += thisrun_count;
 329                 count -= thisrun_count;
 330         }
 331
 332         target_free_working_area(target, source);
 333         target_free_working_area(target, aduc702x_info->write_algorithm);
 334
 335         destroy_reg_param(&reg_params[0]);
 336         destroy_reg_param(&reg_params[1]);
 337         destroy_reg_param(&reg_params[2]);
 338         destroy_reg_param(&reg_params[3]);
 339         destroy_reg_param(&reg_params[4]);
 340
 341         return retval;
 342 }
 343
 344 /* All-JTAG, single-access method.  Very slow.  Used only if there is no
 345  * working area available. */
 346 static int aduc702x_write_single(struct flash_bank_s *bank, uint8_t *buffer, uint32_t offset, uint32_t count)
 347 {
 348         uint32_t x;
 349         uint8_t b;
 350         target_t *target = bank->target;
 351
 352         aduc702x_set_write_enable(target, 1);
 353
 354         for (x = 0; x < count; x += 2) {
 355                 // FEEADR = address
 356                 target_write_u16(target, ADUC702x_FLASH + ADUC702x_FLASH_FEEADR, offset + x);
 357
 358                 // set up data
 359                 if ((x + 1) == count)
 360                 {
 361                         // last byte
 362                         target_read_u8(target, offset + x + 1, &b);
 363                 }
 364                 else
 365                         b = buffer[x + 1];
 366
 367                 target_write_u16(target, ADUC702x_FLASH + ADUC702x_FLASH_FEEDAT, buffer[x] | (b << 8));
 368
 369                 // do single-write command
 370                 target_write_u8(target, ADUC702x_FLASH + ADUC702x_FLASH_FEECON, 0x02);
 371
 372                 if (aduc702x_check_flash_completion(target, 1) != ERROR_OK)
 373                 {
 374                         LOG_ERROR("single write failed for address 0x%08lX\n", (unsigned long)(offset + x));
 375                         aduc702x_set_write_enable(target, 0);
 376                         return ERROR_FLASH_OPERATION_FAILED;
 377                 }
 378
 379         }
 380         LOG_DEBUG("wrote %d bytes at address 0x%08lX\n", (int)count, (unsigned long)(offset + x));
 381
 382         aduc702x_set_write_enable(target, 0);
 383
 384         return ERROR_OK;
 385 }
 386
 387 int aduc702x_write(struct flash_bank_s *bank, uint8_t *buffer, uint32_t offset, uint32_t count)
 388 {
 389         int retval;
 390
 391         /* try using a block write */
 392         if ((retval = aduc702x_write_block(bank, buffer, offset, count)) != ERROR_OK)
 393         {
 394                 if (retval == ERROR_TARGET_RESOURCE_NOT_AVAILABLE)
 395                 {
 396                         /* if block write failed (no sufficient working area),
 397                          * use normal (slow) JTAG method */
 398                         LOG_WARNING("couldn't use block writes, falling back to single memory accesses");
 399
 400                         if ((retval = aduc702x_write_single(bank, buffer, offset, count)) != ERROR_OK)
 401                         {
 402                                 LOG_ERROR("slow write failed");
 403                                 return ERROR_FLASH_OPERATION_FAILED;
 404                         }
 405                 }
 406         }
 407
 408         return retval;
 409 }
 410
 411 static int aduc702x_probe(struct flash_bank_s *bank)
 412 {
 413         return ERROR_OK;
 414 }
 415
 416 static int aduc702x_info(struct flash_bank_s *bank, char *buf, int buf_size)
 417 {
 418         snprintf(buf, buf_size, "aduc702x flash driver info");
 419         return ERROR_OK;
 420 }
 421
 422 /* sets FEEMOD bit 3
 423  * enable = 1 enables writes & erases, 0 disables them */
 424 static int aduc702x_set_write_enable(target_t *target, int enable)
 425 {
 426         // don't bother to preserve int enable bit here
 427         target_write_u16(target, ADUC702x_FLASH + ADUC702x_FLASH_FEEMOD, enable ? 8 : 0);
 428
 429         return ERROR_OK;
 430 }
 431
 432 /* wait up to timeout_ms for controller to not be busy,
 433  * then check whether the command passed or failed.
 434  *
 435  * this function sleeps 1ms between checks (after the first one),
 436  * so in some cases may slow things down without a usleep after the first read */
 437 static int aduc702x_check_flash_completion(target_t* target, unsigned int timeout_ms)
 438 {
 439         uint8_t v = 4;
 440
 441         long long endtime = timeval_ms() + timeout_ms;
 442         while (1) {
 443                 target_read_u8(target, ADUC702x_FLASH + ADUC702x_FLASH_FEESTA, &v);
 444                 if ((v & 4) == 0) break;
 445                 alive_sleep(1);
 446                 if (timeval_ms() >= endtime) break;
 447         }
 448
 449         if (v & 2) return ERROR_FAIL;
 450         // if a command is ignored, both the success and fail bits may be 0
 451         else if ((v & 3) == 0) return ERROR_FAIL;
 452         else return ERROR_OK;
 453 }
 454