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 static int ecosflash_register_commands(struct command_context_s *cmd_ctx);
40 static int ecosflash_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank);
41 static int ecosflash_erase(struct flash_bank_s *bank, int first, int last);
42 static int ecosflash_protect(struct flash_bank_s *bank, int set, int first, int last);
43 static int ecosflash_write(struct flash_bank_s *bank, u8 *buffer, u32 offset, u32 count);
44 static int ecosflash_probe(struct flash_bank_s *bank);
45 static int ecosflash_protect_check(struct flash_bank_s *bank);
46 static int ecosflash_info(struct flash_bank_s *bank, char *buf, int buf_size);
49 static u32 ecosflash_get_flash_status(flash_bank_t *bank);
50 static void ecosflash_set_flash_mode(flash_bank_t *bank,int mode);
51 static u32 ecosflash_wait_status_busy(flash_bank_t *bank, u32 waitbits, int timeout);
52 static int ecosflash_handle_gpnvm_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
55 flash_driver_t ecosflash_flash =
58 .register_commands = ecosflash_register_commands,
59 .flash_bank_command = ecosflash_flash_bank_command,
60 .erase = ecosflash_erase,
61 .protect = ecosflash_protect,
62 .write = ecosflash_write,
63 .probe = ecosflash_probe,
64 .auto_probe = ecosflash_probe,
65 .erase_check = default_flash_blank_check,
66 .protect_check = ecosflash_protect_check,
67 .info = ecosflash_info
70 typedef struct ecosflash_flash_bank_s
72 struct target_s *target;
73 working_area_t *write_algorithm;
74 working_area_t *erase_check_algorithm;
77 } ecosflash_flash_bank_t;
79 static const int sectorSize=0x10000;
82 flash_errmsg(int err);
85 #define FLASH_ERR_OK 0x00 /* No error - operation complete */
86 #define FLASH_ERR_INVALID 0x01 /* Invalid FLASH address */
87 #define FLASH_ERR_ERASE 0x02 /* Error trying to erase */
88 #define FLASH_ERR_LOCK 0x03 /* Error trying to lock/unlock */
89 #define FLASH_ERR_PROGRAM 0x04 /* Error trying to program */
90 #define FLASH_ERR_PROTOCOL 0x05 /* Generic error */
91 #define FLASH_ERR_PROTECT 0x06 /* Device/region is write-protected */
92 #define FLASH_ERR_NOT_INIT 0x07 /* FLASH info not yet initialized */
93 #define FLASH_ERR_HWR 0x08 /* Hardware (configuration?) problem */
94 #define FLASH_ERR_ERASE_SUSPEND 0x09 /* Device is in erase suspend mode */
95 #define FLASH_ERR_PROGRAM_SUSPEND 0x0a /* Device is in in program suspend mode */
96 #define FLASH_ERR_DRV_VERIFY 0x0b /* Driver failed to verify data */
97 #define FLASH_ERR_DRV_TIMEOUT 0x0c /* Driver timed out waiting for device */
98 #define FLASH_ERR_DRV_WRONG_PART 0x0d /* Driver does not support device */
99 #define FLASH_ERR_LOW_VOLTAGE 0x0e /* Not enough juice to complete job */
102 flash_errmsg(int err)
106 return "No error - operation complete";
107 case FLASH_ERR_ERASE_SUSPEND:
108 return "Device is in erase suspend state";
109 case FLASH_ERR_PROGRAM_SUSPEND:
110 return "Device is in program suspend state";
111 case FLASH_ERR_INVALID:
112 return "Invalid FLASH address";
113 case FLASH_ERR_ERASE:
114 return "Error trying to erase";
116 return "Error trying to lock/unlock";
117 case FLASH_ERR_PROGRAM:
118 return "Error trying to program";
119 case FLASH_ERR_PROTOCOL:
120 return "Generic error";
121 case FLASH_ERR_PROTECT:
122 return "Device/region is write-protected";
123 case FLASH_ERR_NOT_INIT:
124 return "FLASH sub-system not initialized";
125 case FLASH_ERR_DRV_VERIFY:
126 return "Data verify failed after operation";
127 case FLASH_ERR_DRV_TIMEOUT:
128 return "Driver timed out waiting for device";
129 case FLASH_ERR_DRV_WRONG_PART:
130 return "Driver does not support device";
131 case FLASH_ERR_LOW_VOLTAGE:
132 return "Device reports low voltage";
134 return "Unknown error";
139 /* flash bank ecosflash <base> <size> <chip_width> <bus_width> <target#> <driverPath>
141 static int ecosflash_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank)
143 ecosflash_flash_bank_t *info;
147 LOG_WARNING("incomplete flash_bank ecosflash configuration");
148 return ERROR_FLASH_BANK_INVALID;
151 info = malloc(sizeof(ecosflash_flash_bank_t));
154 LOG_ERROR("no memory for flash bank info");
157 bank->driver_priv = info;
158 info->driverPath=strdup(args[6]);
160 /* eCos flash sector sizes are not exposed to OpenOCD, use 0x10000 as
161 * a way to improve impeadance matach between OpenOCD and eCos flash
166 bank->num_sectors=bank->size/sectorSize;
167 bank->sectors = malloc(sizeof(flash_sector_t) * bank->num_sectors);
168 for (i = 0; i < bank->num_sectors; i++)
170 bank->sectors[i].offset = offset;
171 bank->sectors[i].size = sectorSize;
172 offset += bank->sectors[i].size;
173 bank->sectors[i].is_erased = -1;
174 bank->sectors[i].is_protected = 0;
177 info->target = get_target_by_num(strtoul(args[5], NULL, 0));
178 if (info->target == NULL)
180 LOG_ERROR("no target '%i' configured", (int)strtoul(args[5], NULL, 0));
186 static int loadDriver(ecosflash_flash_bank_t *info)
192 image.base_address_set = 0;
193 image.start_address_set = 0;
194 target_t *target=info->target;
197 if ((retval=image_open(&image, info->driverPath, NULL)) != ERROR_OK)
202 info->start_address=image.start_address;
206 for (i = 0; i < image.num_sections; i++)
208 void *buffer = malloc(image.sections[i].size);
210 if ((retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt)) != ERROR_OK)
216 target_write_buffer(target, image.sections[i].base_address, buf_cnt, buffer);
217 image_size += buf_cnt;
218 LOG_DEBUG("%u byte written at address 0x%8.8x", buf_cnt, image.sections[i].base_address);
228 static int const OFFSET_ERASE=0x0;
229 static int const OFFSET_ERASE_SIZE=0x8;
230 static int const OFFSET_FLASH=0xc;
231 static int const OFFSET_FLASH_SIZE=0x8;
232 static int const OFFSET_GET_WORKAREA=0x18;
233 static int const OFFSET_GET_WORKAREA_SIZE=0x4;
235 static int runCode(ecosflash_flash_bank_t *info,
236 u32 codeStart, u32 codeStop, u32 r0, u32 r1, u32 r2,
241 target_t *target=info->target;
243 reg_param_t reg_params[3];
244 armv4_5_algorithm_t armv4_5_info;
245 armv4_5_info.common_magic = ARMV4_5_COMMON_MAGIC;
246 armv4_5_info.core_mode = ARMV4_5_MODE_SVC;
247 armv4_5_info.core_state = ARMV4_5_STATE_ARM;
249 init_reg_param(®_params[0], "r0", 32, PARAM_IN_OUT);
250 init_reg_param(®_params[1], "r1", 32, PARAM_OUT);
251 init_reg_param(®_params[2], "r2", 32, PARAM_OUT);
253 buf_set_u32(reg_params[0].value, 0, 32, r0);
254 buf_set_u32(reg_params[1].value, 0, 32, r1);
255 buf_set_u32(reg_params[2].value, 0, 32, r2);
258 if ((retval = target->type->run_algorithm(target, 0, NULL, 3, reg_params,
261 &armv4_5_info)) != ERROR_OK)
263 LOG_ERROR("error executing eCos flash algorithm");
267 *result=buf_get_u32(reg_params[0].value, 0, 32);
269 destroy_reg_param(®_params[0]);
270 destroy_reg_param(®_params[1]);
271 destroy_reg_param(®_params[2]);
276 static int eCosBoard_erase(ecosflash_flash_bank_t *info, u32 address, u32 len)
279 int timeout = (len / 20480 + 1) * 1000; /*asume 20 KB/s*/
281 retval=loadDriver(info);
282 if (retval!=ERROR_OK)
287 info->start_address+OFFSET_ERASE,
288 info->start_address+OFFSET_ERASE+OFFSET_ERASE_SIZE,
295 if (retval!=ERROR_OK)
300 LOG_ERROR("Flash erase failed with %d (%s)\n", flashErr, flash_errmsg(flashErr));
307 static int eCosBoard_flash(ecosflash_flash_bank_t *info, void *data, u32 address, u32 len)
309 target_t *target=info->target;
310 const int chunk=8192;
312 int timeout = (chunk / 20480 + 1) * 1000; /*asume 20 KB/s + 1 second*/
314 retval=loadDriver(info);
315 if (retval!=ERROR_OK)
320 info->start_address+OFFSET_GET_WORKAREA,
321 info->start_address+OFFSET_GET_WORKAREA+OFFSET_GET_WORKAREA_SIZE,
327 if (retval!=ERROR_OK)
332 for (i=0; i<len; i+=chunk)
341 retval=target_write_buffer(target, buffer, t, ((u8 *)data)+i);
342 if (retval != ERROR_OK)
347 info->start_address+OFFSET_FLASH,
348 info->start_address+OFFSET_FLASH+OFFSET_FLASH_SIZE,
354 if (retval != ERROR_OK)
359 LOG_ERROR("Flash prog failed with %d (%s)\n", flashErr, flash_errmsg(flashErr));
366 static int ecosflash_probe(struct flash_bank_s *bank)
371 static int ecosflash_register_commands(struct command_context_s *cmd_ctx)
373 register_command(cmd_ctx, NULL, "ecosflash", NULL, COMMAND_ANY, NULL);
379 static void command(flash_bank_t *bank, u8 cmd, u8 *cmd_buf)
381 ecosflash_flash_bank_t *info = bank->driver_priv;
384 if (info->target->endianness == TARGET_LITTLE_ENDIAN)
386 for (i = bank->bus_width; i > 0; i--)
388 *cmd_buf++ = (i & (bank->chip_width - 1)) ? 0x0 : cmd;
393 for (i = 1; i <= bank->bus_width; i++)
395 *cmd_buf++ = (i & (bank->chip_width - 1)) ? 0x0 : cmd;
402 static u32 ecosflash_address(struct flash_bank_s *bank, u32 address)
405 switch(bank->bus_width)
408 retval = address & 0xfffffffc;
410 retval = address & 0xfffffffe;
415 return retval + bank->base;
419 static int ecosflash_erase(struct flash_bank_s *bank, int first, int last)
421 struct flash_bank_s *c=bank;
422 ecosflash_flash_bank_t *info = bank->driver_priv;
423 return eCosBoard_erase(info, c->base+first*sectorSize, sectorSize*(last-first+1));
426 static int ecosflash_protect(struct flash_bank_s *bank, int set, int first, int last)
431 static int ecosflash_write(struct flash_bank_s *bank, u8 *buffer, u32 offset, u32 count)
433 ecosflash_flash_bank_t *info = bank->driver_priv;
434 struct flash_bank_s *c=bank;
435 return eCosBoard_flash(info, buffer, c->base+offset, count);
438 static int ecosflash_protect_check(struct flash_bank_s *bank)
443 static int ecosflash_info(struct flash_bank_s *bank, char *buf, int buf_size)
445 ecosflash_flash_bank_t *info = bank->driver_priv;
446 snprintf(buf, buf_size, "eCos flash driver: %s", info->driverPath);
451 static u32 ecosflash_get_flash_status(flash_bank_t *bank)
456 static void ecosflash_set_flash_mode(flash_bank_t *bank,int mode)
461 static u32 ecosflash_wait_status_busy(flash_bank_t *bank, u32 waitbits, int timeout)
466 static int ecosflash_handle_gpnvm_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)