1 /***************************************************************************
2 * Copyright (C) 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"
36 #include "binarybuffer.h"
37 #include "../target/embeddedice.h"
42 int ecosflash_register_commands(struct command_context_s *cmd_ctx);
43 int ecosflash_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank);
44 int ecosflash_erase(struct flash_bank_s *bank, int first, int last);
45 int ecosflash_protect(struct flash_bank_s *bank, int set, int first, int last);
46 int ecosflash_write(struct flash_bank_s *bank, u8 *buffer, u32 offset, u32 count);
47 int ecosflash_probe(struct flash_bank_s *bank);
48 int ecosflash_erase_check(struct flash_bank_s *bank);
49 int ecosflash_protect_check(struct flash_bank_s *bank);
50 int ecosflash_info(struct flash_bank_s *bank, char *buf, int buf_size);
52 u32 ecosflash_get_flash_status(flash_bank_t *bank);
53 void ecosflash_set_flash_mode(flash_bank_t *bank,int mode);
54 u32 ecosflash_wait_status_busy(flash_bank_t *bank, u32 waitbits, int timeout);
55 int ecosflash_handle_gpnvm_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
57 flash_driver_t ecosflash_flash =
60 .register_commands = ecosflash_register_commands,
61 .flash_bank_command = ecosflash_flash_bank_command,
62 .erase = ecosflash_erase,
63 .protect = ecosflash_protect,
64 .write = ecosflash_write,
65 .probe = ecosflash_probe,
66 .auto_probe = ecosflash_probe,
67 .erase_check = ecosflash_erase_check,
68 .protect_check = ecosflash_protect_check,
69 .info = ecosflash_info
72 typedef struct ecosflash_flash_bank_s
74 struct target_s *target;
75 working_area_t *write_algorithm;
76 working_area_t *erase_check_algorithm;
79 } ecosflash_flash_bank_t;
81 static const int sectorSize=0x10000;
84 flash_errmsg(int err);
87 #define FLASH_ERR_OK 0x00 /* No error - operation complete */
88 #define FLASH_ERR_INVALID 0x01 /* Invalid FLASH address */
89 #define FLASH_ERR_ERASE 0x02 /* Error trying to erase */
90 #define FLASH_ERR_LOCK 0x03 /* Error trying to lock/unlock */
91 #define FLASH_ERR_PROGRAM 0x04 /* Error trying to program */
92 #define FLASH_ERR_PROTOCOL 0x05 /* Generic error */
93 #define FLASH_ERR_PROTECT 0x06 /* Device/region is write-protected */
94 #define FLASH_ERR_NOT_INIT 0x07 /* FLASH info not yet initialized */
95 #define FLASH_ERR_HWR 0x08 /* Hardware (configuration?) problem */
96 #define FLASH_ERR_ERASE_SUSPEND 0x09 /* Device is in erase suspend mode */
97 #define FLASH_ERR_PROGRAM_SUSPEND 0x0a /* Device is in in program suspend mode */
98 #define FLASH_ERR_DRV_VERIFY 0x0b /* Driver failed to verify data */
99 #define FLASH_ERR_DRV_TIMEOUT 0x0c /* Driver timed out waiting for device */
100 #define FLASH_ERR_DRV_WRONG_PART 0x0d /* Driver does not support device */
101 #define FLASH_ERR_LOW_VOLTAGE 0x0e /* Not enough juice to complete job */
105 flash_errmsg(int err)
109 return "No error - operation complete";
110 case FLASH_ERR_ERASE_SUSPEND:
111 return "Device is in erase suspend state";
112 case FLASH_ERR_PROGRAM_SUSPEND:
113 return "Device is in program suspend state";
114 case FLASH_ERR_INVALID:
115 return "Invalid FLASH address";
116 case FLASH_ERR_ERASE:
117 return "Error trying to erase";
119 return "Error trying to lock/unlock";
120 case FLASH_ERR_PROGRAM:
121 return "Error trying to program";
122 case FLASH_ERR_PROTOCOL:
123 return "Generic error";
124 case FLASH_ERR_PROTECT:
125 return "Device/region is write-protected";
126 case FLASH_ERR_NOT_INIT:
127 return "FLASH sub-system not initialized";
128 case FLASH_ERR_DRV_VERIFY:
129 return "Data verify failed after operation";
130 case FLASH_ERR_DRV_TIMEOUT:
131 return "Driver timed out waiting for device";
132 case FLASH_ERR_DRV_WRONG_PART:
133 return "Driver does not support device";
134 case FLASH_ERR_LOW_VOLTAGE:
135 return "Device reports low voltage";
137 return "Unknown error";
142 /* flash bank ecosflash <base> <size> <chip_width> <bus_width> <target#> <driverPath>
144 int ecosflash_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank)
146 ecosflash_flash_bank_t *info;
150 WARNING("incomplete flash_bank ecosflash configuration");
151 return ERROR_FLASH_BANK_INVALID;
154 info = malloc(sizeof(ecosflash_flash_bank_t));
157 ERROR("no memory for flash bank info");
160 bank->driver_priv = info;
161 info->driverPath=strdup(args[6]);
163 /* eCos flash sector sizes are not exposed to OpenOCD, use 0x10000 as
164 * a way to improve impeadance matach between OpenOCD and eCos flash
169 bank->num_sectors=bank->size/sectorSize;
170 bank->sectors = malloc(sizeof(flash_sector_t) * bank->num_sectors);
171 for (i = 0; i < bank->num_sectors; i++)
173 bank->sectors[i].offset = offset;
174 bank->sectors[i].size = sectorSize;
175 offset += bank->sectors[i].size;
176 bank->sectors[i].is_erased = -1;
177 bank->sectors[i].is_protected = 0;
180 info->target = get_target_by_num(strtoul(args[5], NULL, 0));
181 if (info->target == NULL)
183 ERROR("no target '%i' configured", (int)strtoul(args[5], NULL, 0));
190 int loadDriver(ecosflash_flash_bank_t *info)
196 image.base_address_set = 0;
197 image.start_address_set = 0;
198 target_t *target=info->target;
200 if (image_open(&image, info->driverPath, NULL) != ERROR_OK)
202 return ERROR_FLASH_BANK_INVALID;
205 info->start_address=image.start_address;
209 for (i = 0; i < image.num_sections; i++)
211 void *buffer = malloc(image.sections[i].size);
213 if ((retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt)) != ERROR_OK)
215 ERROR("image_read_section failed with error code: %i", retval);
218 return ERROR_FLASH_BANK_INVALID;
220 target_write_buffer(target, image.sections[i].base_address, buf_cnt, buffer);
221 image_size += buf_cnt;
222 DEBUG("%u byte written at address 0x%8.8x", buf_cnt, image.sections[i].base_address);
233 static int const OFFSET_ERASE=0x0;
234 static int const OFFSET_ERASE_SIZE=0x8;
235 static int const OFFSET_FLASH=0xc;
236 static int const OFFSET_FLASH_SIZE=0x8;
237 static int const OFFSET_GET_WORKAREA=0x18;
238 static int const OFFSET_GET_WORKAREA_SIZE=0x4;
241 int runCode(ecosflash_flash_bank_t *info,
242 u32 codeStart, u32 codeStop, u32 r0, u32 r1, u32 r2,
247 target_t *target=info->target;
249 reg_param_t reg_params[3];
250 armv4_5_algorithm_t armv4_5_info;
251 armv4_5_info.common_magic = ARMV4_5_COMMON_MAGIC;
252 armv4_5_info.core_mode = ARMV4_5_MODE_SVC;
253 armv4_5_info.core_state = ARMV4_5_STATE_ARM;
255 init_reg_param(®_params[0], "r0", 32, PARAM_IN_OUT);
256 init_reg_param(®_params[1], "r1", 32, PARAM_OUT);
257 init_reg_param(®_params[2], "r2", 32, PARAM_OUT);
259 buf_set_u32(reg_params[0].value, 0, 32, r0);
260 buf_set_u32(reg_params[1].value, 0, 32, r1);
261 buf_set_u32(reg_params[2].value, 0, 32, r2);
264 if ((retval = target->type->run_algorithm(target, 0, NULL, 3, reg_params,
267 &armv4_5_info)) != ERROR_OK)
269 ERROR("error executing eCos flash algorithm");
273 *result=buf_get_u32(reg_params[0].value, 0, 32);
275 destroy_reg_param(®_params[0]);
276 destroy_reg_param(®_params[1]);
277 destroy_reg_param(®_params[2]);
282 int eCosBoard_erase(ecosflash_flash_bank_t *info, u32 address, u32 len)
285 int timeout = (len / 20480 + 1) * 1000; /*asume 20 KB/s*/
287 retval=loadDriver(info);
288 if (retval!=ERROR_OK)
293 info->start_address+OFFSET_ERASE,
294 info->start_address+OFFSET_ERASE+OFFSET_ERASE_SIZE,
301 if (retval!=ERROR_OK)
306 ERROR("Flash erase failed with %d (%s)\n", flashErr, flash_errmsg(flashErr));
307 return ERROR_JTAG_DEVICE_ERROR;
313 int eCosBoard_flash(ecosflash_flash_bank_t *info, void *data, u32 address, u32 len)
315 target_t *target=info->target;
316 const int chunk=8192;
318 int timeout = (chunk / 20480 + 1) * 1000; /*asume 20 KB/s + 1 second*/
320 retval=loadDriver(info);
321 if (retval!=ERROR_OK)
326 info->start_address+OFFSET_GET_WORKAREA,
327 info->start_address+OFFSET_GET_WORKAREA+OFFSET_GET_WORKAREA_SIZE,
333 if (retval!=ERROR_OK)
338 for (i=0; i<len; i+=chunk)
347 retval=target_write_buffer(target, buffer, t, ((u8 *)data)+i);
348 if (retval != ERROR_OK)
353 info->start_address+OFFSET_FLASH,
354 info->start_address+OFFSET_FLASH+OFFSET_FLASH_SIZE,
360 if (retval != ERROR_OK)
365 ERROR("Flash prog failed with %d (%s)\n", flashErr, flash_errmsg(flashErr));
366 return ERROR_JTAG_DEVICE_ERROR;
373 int ecosflash_probe(struct flash_bank_s *bank)
379 int ecosflash_register_commands(struct command_context_s *cmd_ctx)
381 register_command(cmd_ctx, NULL, "ecosflash", NULL, COMMAND_ANY, NULL);
387 static void command(flash_bank_t *bank, u8 cmd, u8 *cmd_buf)
389 ecosflash_flash_bank_t *info = bank->driver_priv;
392 if (info->target->endianness == TARGET_LITTLE_ENDIAN)
394 for (i = bank->bus_width; i > 0; i--)
396 *cmd_buf++ = (i & (bank->chip_width - 1)) ? 0x0 : cmd;
401 for (i = 1; i <= bank->bus_width; i++)
403 *cmd_buf++ = (i & (bank->chip_width - 1)) ? 0x0 : cmd;
409 u32 ecosflash_address(struct flash_bank_s *bank, u32 address)
412 switch(bank->bus_width)
415 retval = address & 0xfffffffc;
417 retval = address & 0xfffffffe;
422 return retval + bank->base;
426 int ecosflash_erase(struct flash_bank_s *bank, int first, int last)
428 struct flash_bank_s *c=bank;
429 ecosflash_flash_bank_t *info = bank->driver_priv;
430 return eCosBoard_erase(info, c->base+first*sectorSize, sectorSize*(last-first+1));
433 int ecosflash_protect(struct flash_bank_s *bank, int set, int first, int last)
439 int ecosflash_write(struct flash_bank_s *bank, u8 *buffer, u32 offset, u32 count)
441 ecosflash_flash_bank_t *info = bank->driver_priv;
442 struct flash_bank_s *c=bank;
443 return eCosBoard_flash(info, buffer, c->base+offset, count);
447 int ecosflash_erase_check(struct flash_bank_s *bank)
452 int ecosflash_protect_check(struct flash_bank_s *bank)
457 int ecosflash_info(struct flash_bank_s *bank, char *buf, int buf_size)
459 ecosflash_flash_bank_t *info = bank->driver_priv;
460 snprintf(buf, buf_size, "eCos flash driver: %s", info->driverPath);
465 u32 ecosflash_get_flash_status(flash_bank_t *bank)
470 void ecosflash_set_flash_mode(flash_bank_t *bank,int mode)
475 u32 ecosflash_wait_status_busy(flash_bank_t *bank, u32 waitbits, int timeout)
480 int ecosflash_handle_gpnvm_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)