1 /***************************************************************************
2 * Copyright (C) 2007,2008 Øyvind Harboe *
3 * oyvind.harboe@zylin.com *
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. *
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. *
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 ***************************************************************************/
26 #include "replacements.h"
35 #include "binarybuffer.h"
36 #include "../target/embeddedice.h"
39 int ecosflash_register_commands(struct command_context_s *cmd_ctx);
40 int ecosflash_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank);
41 int ecosflash_erase(struct flash_bank_s *bank, int first, int last);
42 int ecosflash_protect(struct flash_bank_s *bank, int set, int first, int last);
43 int ecosflash_write(struct flash_bank_s *bank, u8 *buffer, u32 offset, u32 count);
44 int ecosflash_probe(struct flash_bank_s *bank);
45 int ecosflash_protect_check(struct flash_bank_s *bank);
46 int ecosflash_info(struct flash_bank_s *bank, char *buf, int buf_size);
48 u32 ecosflash_get_flash_status(flash_bank_t *bank);
49 void ecosflash_set_flash_mode(flash_bank_t *bank,int mode);
50 u32 ecosflash_wait_status_busy(flash_bank_t *bank, u32 waitbits, int timeout);
51 int ecosflash_handle_gpnvm_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
53 flash_driver_t ecosflash_flash =
56 .register_commands = ecosflash_register_commands,
57 .flash_bank_command = ecosflash_flash_bank_command,
58 .erase = ecosflash_erase,
59 .protect = ecosflash_protect,
60 .write = ecosflash_write,
61 .probe = ecosflash_probe,
62 .auto_probe = ecosflash_probe,
63 .erase_check = default_flash_blank_check,
64 .protect_check = ecosflash_protect_check,
65 .info = ecosflash_info
68 typedef struct ecosflash_flash_bank_s
70 struct target_s *target;
71 working_area_t *write_algorithm;
72 working_area_t *erase_check_algorithm;
75 } ecosflash_flash_bank_t;
77 static const int sectorSize=0x10000;
80 flash_errmsg(int err);
83 #define FLASH_ERR_OK 0x00 /* No error - operation complete */
84 #define FLASH_ERR_INVALID 0x01 /* Invalid FLASH address */
85 #define FLASH_ERR_ERASE 0x02 /* Error trying to erase */
86 #define FLASH_ERR_LOCK 0x03 /* Error trying to lock/unlock */
87 #define FLASH_ERR_PROGRAM 0x04 /* Error trying to program */
88 #define FLASH_ERR_PROTOCOL 0x05 /* Generic error */
89 #define FLASH_ERR_PROTECT 0x06 /* Device/region is write-protected */
90 #define FLASH_ERR_NOT_INIT 0x07 /* FLASH info not yet initialized */
91 #define FLASH_ERR_HWR 0x08 /* Hardware (configuration?) problem */
92 #define FLASH_ERR_ERASE_SUSPEND 0x09 /* Device is in erase suspend mode */
93 #define FLASH_ERR_PROGRAM_SUSPEND 0x0a /* Device is in in program suspend mode */
94 #define FLASH_ERR_DRV_VERIFY 0x0b /* Driver failed to verify data */
95 #define FLASH_ERR_DRV_TIMEOUT 0x0c /* Driver timed out waiting for device */
96 #define FLASH_ERR_DRV_WRONG_PART 0x0d /* Driver does not support device */
97 #define FLASH_ERR_LOW_VOLTAGE 0x0e /* Not enough juice to complete job */
100 flash_errmsg(int err)
104 return "No error - operation complete";
105 case FLASH_ERR_ERASE_SUSPEND:
106 return "Device is in erase suspend state";
107 case FLASH_ERR_PROGRAM_SUSPEND:
108 return "Device is in program suspend state";
109 case FLASH_ERR_INVALID:
110 return "Invalid FLASH address";
111 case FLASH_ERR_ERASE:
112 return "Error trying to erase";
114 return "Error trying to lock/unlock";
115 case FLASH_ERR_PROGRAM:
116 return "Error trying to program";
117 case FLASH_ERR_PROTOCOL:
118 return "Generic error";
119 case FLASH_ERR_PROTECT:
120 return "Device/region is write-protected";
121 case FLASH_ERR_NOT_INIT:
122 return "FLASH sub-system not initialized";
123 case FLASH_ERR_DRV_VERIFY:
124 return "Data verify failed after operation";
125 case FLASH_ERR_DRV_TIMEOUT:
126 return "Driver timed out waiting for device";
127 case FLASH_ERR_DRV_WRONG_PART:
128 return "Driver does not support device";
129 case FLASH_ERR_LOW_VOLTAGE:
130 return "Device reports low voltage";
132 return "Unknown error";
137 /* flash bank ecosflash <base> <size> <chip_width> <bus_width> <target#> <driverPath>
139 int ecosflash_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank)
141 ecosflash_flash_bank_t *info;
145 LOG_WARNING("incomplete flash_bank ecosflash configuration");
146 return ERROR_FLASH_BANK_INVALID;
149 info = malloc(sizeof(ecosflash_flash_bank_t));
152 LOG_ERROR("no memory for flash bank info");
155 bank->driver_priv = info;
156 info->driverPath=strdup(args[6]);
158 /* eCos flash sector sizes are not exposed to OpenOCD, use 0x10000 as
159 * a way to improve impeadance matach between OpenOCD and eCos flash
164 bank->num_sectors=bank->size/sectorSize;
165 bank->sectors = malloc(sizeof(flash_sector_t) * bank->num_sectors);
166 for (i = 0; i < bank->num_sectors; i++)
168 bank->sectors[i].offset = offset;
169 bank->sectors[i].size = sectorSize;
170 offset += bank->sectors[i].size;
171 bank->sectors[i].is_erased = -1;
172 bank->sectors[i].is_protected = 0;
175 info->target = get_target_by_num(strtoul(args[5], NULL, 0));
176 if (info->target == NULL)
178 LOG_ERROR("no target '%i' configured", (int)strtoul(args[5], NULL, 0));
184 int loadDriver(ecosflash_flash_bank_t *info)
190 image.base_address_set = 0;
191 image.start_address_set = 0;
192 target_t *target=info->target;
195 if ((retval=image_open(&image, info->driverPath, NULL)) != ERROR_OK)
200 info->start_address=image.start_address;
204 for (i = 0; i < image.num_sections; i++)
206 void *buffer = malloc(image.sections[i].size);
208 if ((retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt)) != ERROR_OK)
214 target_write_buffer(target, image.sections[i].base_address, buf_cnt, buffer);
215 image_size += buf_cnt;
216 LOG_DEBUG("%u byte written at address 0x%8.8x", buf_cnt, image.sections[i].base_address);
226 static int const OFFSET_ERASE=0x0;
227 static int const OFFSET_ERASE_SIZE=0x8;
228 static int const OFFSET_FLASH=0xc;
229 static int const OFFSET_FLASH_SIZE=0x8;
230 static int const OFFSET_GET_WORKAREA=0x18;
231 static int const OFFSET_GET_WORKAREA_SIZE=0x4;
233 int runCode(ecosflash_flash_bank_t *info,
234 u32 codeStart, u32 codeStop, u32 r0, u32 r1, u32 r2,
239 target_t *target=info->target;
241 reg_param_t reg_params[3];
242 armv4_5_algorithm_t armv4_5_info;
243 armv4_5_info.common_magic = ARMV4_5_COMMON_MAGIC;
244 armv4_5_info.core_mode = ARMV4_5_MODE_SVC;
245 armv4_5_info.core_state = ARMV4_5_STATE_ARM;
247 init_reg_param(®_params[0], "r0", 32, PARAM_IN_OUT);
248 init_reg_param(®_params[1], "r1", 32, PARAM_OUT);
249 init_reg_param(®_params[2], "r2", 32, PARAM_OUT);
251 buf_set_u32(reg_params[0].value, 0, 32, r0);
252 buf_set_u32(reg_params[1].value, 0, 32, r1);
253 buf_set_u32(reg_params[2].value, 0, 32, r2);
256 if ((retval = target->type->run_algorithm(target, 0, NULL, 3, reg_params,
259 &armv4_5_info)) != ERROR_OK)
261 LOG_ERROR("error executing eCos flash algorithm");
265 *result=buf_get_u32(reg_params[0].value, 0, 32);
267 destroy_reg_param(®_params[0]);
268 destroy_reg_param(®_params[1]);
269 destroy_reg_param(®_params[2]);
274 int eCosBoard_erase(ecosflash_flash_bank_t *info, u32 address, u32 len)
277 int timeout = (len / 20480 + 1) * 1000; /*asume 20 KB/s*/
279 retval=loadDriver(info);
280 if (retval!=ERROR_OK)
285 info->start_address+OFFSET_ERASE,
286 info->start_address+OFFSET_ERASE+OFFSET_ERASE_SIZE,
293 if (retval!=ERROR_OK)
298 LOG_ERROR("Flash erase failed with %d (%s)\n", flashErr, flash_errmsg(flashErr));
305 int eCosBoard_flash(ecosflash_flash_bank_t *info, void *data, u32 address, u32 len)
307 target_t *target=info->target;
308 const int chunk=8192;
310 int timeout = (chunk / 20480 + 1) * 1000; /*asume 20 KB/s + 1 second*/
312 retval=loadDriver(info);
313 if (retval!=ERROR_OK)
318 info->start_address+OFFSET_GET_WORKAREA,
319 info->start_address+OFFSET_GET_WORKAREA+OFFSET_GET_WORKAREA_SIZE,
325 if (retval!=ERROR_OK)
330 for (i=0; i<len; i+=chunk)
339 retval=target_write_buffer(target, buffer, t, ((u8 *)data)+i);
340 if (retval != ERROR_OK)
345 info->start_address+OFFSET_FLASH,
346 info->start_address+OFFSET_FLASH+OFFSET_FLASH_SIZE,
352 if (retval != ERROR_OK)
357 LOG_ERROR("Flash prog failed with %d (%s)\n", flashErr, flash_errmsg(flashErr));
364 int ecosflash_probe(struct flash_bank_s *bank)
369 int ecosflash_register_commands(struct command_context_s *cmd_ctx)
371 register_command(cmd_ctx, NULL, "ecosflash", NULL, COMMAND_ANY, NULL);
377 static void command(flash_bank_t *bank, u8 cmd, u8 *cmd_buf)
379 ecosflash_flash_bank_t *info = bank->driver_priv;
382 if (info->target->endianness == TARGET_LITTLE_ENDIAN)
384 for (i = bank->bus_width; i > 0; i--)
386 *cmd_buf++ = (i & (bank->chip_width - 1)) ? 0x0 : cmd;
391 for (i = 1; i <= bank->bus_width; i++)
393 *cmd_buf++ = (i & (bank->chip_width - 1)) ? 0x0 : cmd;
399 u32 ecosflash_address(struct flash_bank_s *bank, u32 address)
402 switch(bank->bus_width)
405 retval = address & 0xfffffffc;
407 retval = address & 0xfffffffe;
412 return retval + bank->base;
415 int ecosflash_erase(struct flash_bank_s *bank, int first, int last)
417 struct flash_bank_s *c=bank;
418 ecosflash_flash_bank_t *info = bank->driver_priv;
419 return eCosBoard_erase(info, c->base+first*sectorSize, sectorSize*(last-first+1));
422 int ecosflash_protect(struct flash_bank_s *bank, int set, int first, int last)
427 int ecosflash_write(struct flash_bank_s *bank, u8 *buffer, u32 offset, u32 count)
429 ecosflash_flash_bank_t *info = bank->driver_priv;
430 struct flash_bank_s *c=bank;
431 return eCosBoard_flash(info, buffer, c->base+offset, count);
434 int ecosflash_protect_check(struct flash_bank_s *bank)
439 int ecosflash_info(struct flash_bank_s *bank, char *buf, int buf_size)
441 ecosflash_flash_bank_t *info = bank->driver_priv;
442 snprintf(buf, buf_size, "eCos flash driver: %s", info->driverPath);
446 u32 ecosflash_get_flash_status(flash_bank_t *bank)
451 void ecosflash_set_flash_mode(flash_bank_t *bank,int mode)
456 u32 ecosflash_wait_status_busy(flash_bank_t *bank, u32 waitbits, int timeout)
461 int ecosflash_handle_gpnvm_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)