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 ***************************************************************************/
25 #include <target/embeddedice.h>
26 #include <target/algorithm.h>
27 #include <target/image.h>
31 static uint32_t ecosflash_get_flash_status(struct flash_bank
*bank
);
32 static void ecosflash_set_flash_mode(struct flash_bank
*bank
,int mode
);
33 static uint32_t ecosflash_wait_status_busy(struct flash_bank
*bank
, uint32_t waitbits
, int timeout
);
34 static int ecosflash_handle_gpnvm_command(struct command_context
*cmd_ctx
, char *cmd
, char **args
, int argc
);
37 struct ecosflash_flash_bank
39 struct target
*target
;
40 struct working_area
*write_algorithm
;
41 struct working_area
*erase_check_algorithm
;
43 uint32_t start_address
;
46 static const int sectorSize
= 0x10000;
49 flash_errmsg(int err
);
52 #define FLASH_ERR_OK 0x00 /* No error - operation complete */
53 #define FLASH_ERR_INVALID 0x01 /* Invalid FLASH address */
54 #define FLASH_ERR_ERASE 0x02 /* Error trying to erase */
55 #define FLASH_ERR_LOCK 0x03 /* Error trying to lock/unlock */
56 #define FLASH_ERR_PROGRAM 0x04 /* Error trying to program */
57 #define FLASH_ERR_PROTOCOL 0x05 /* Generic error */
58 #define FLASH_ERR_PROTECT 0x06 /* Device/region is write-protected */
59 #define FLASH_ERR_NOT_INIT 0x07 /* FLASH info not yet initialized */
60 #define FLASH_ERR_HWR 0x08 /* Hardware (configuration?) problem */
61 #define FLASH_ERR_ERASE_SUSPEND 0x09 /* Device is in erase suspend mode */
62 #define FLASH_ERR_PROGRAM_SUSPEND 0x0a /* Device is in in program suspend mode */
63 #define FLASH_ERR_DRV_VERIFY 0x0b /* Driver failed to verify data */
64 #define FLASH_ERR_DRV_TIMEOUT 0x0c /* Driver timed out waiting for device */
65 #define FLASH_ERR_DRV_WRONG_PART 0x0d /* Driver does not support device */
66 #define FLASH_ERR_LOW_VOLTAGE 0x0e /* Not enough juice to complete job */
73 return "No error - operation complete";
74 case FLASH_ERR_ERASE_SUSPEND
:
75 return "Device is in erase suspend state";
76 case FLASH_ERR_PROGRAM_SUSPEND
:
77 return "Device is in program suspend state";
78 case FLASH_ERR_INVALID
:
79 return "Invalid FLASH address";
81 return "Error trying to erase";
83 return "Error trying to lock/unlock";
84 case FLASH_ERR_PROGRAM
:
85 return "Error trying to program";
86 case FLASH_ERR_PROTOCOL
:
87 return "Generic error";
88 case FLASH_ERR_PROTECT
:
89 return "Device/region is write-protected";
90 case FLASH_ERR_NOT_INIT
:
91 return "FLASH sub-system not initialized";
92 case FLASH_ERR_DRV_VERIFY
:
93 return "Data verify failed after operation";
94 case FLASH_ERR_DRV_TIMEOUT
:
95 return "Driver timed out waiting for device";
96 case FLASH_ERR_DRV_WRONG_PART
:
97 return "Driver does not support device";
98 case FLASH_ERR_LOW_VOLTAGE
:
99 return "Device reports low voltage";
101 return "Unknown error";
106 /* flash bank ecosflash <base> <size> <chip_width> <bus_width> <target#> <driverPath>
108 FLASH_BANK_COMMAND_HANDLER(ecosflash_flash_bank_command
)
110 struct ecosflash_flash_bank
*info
;
114 LOG_WARNING("incomplete flash_bank ecosflash configuration");
115 return ERROR_FLASH_BANK_INVALID
;
118 info
= malloc(sizeof(struct ecosflash_flash_bank
));
121 LOG_ERROR("no memory for flash bank info");
124 bank
->driver_priv
= info
;
125 info
->driverPath
= strdup(CMD_ARGV
[6]);
127 /* eCos flash sector sizes are not exposed to OpenOCD, use 0x10000 as
128 * a way to improve impedance match between OpenOCD and eCos flash
133 bank
->num_sectors
= bank
->size
/sectorSize
;
134 bank
->sectors
= malloc(sizeof(struct flash_sector
) * bank
->num_sectors
);
135 for (i
= 0; i
< bank
->num_sectors
; i
++)
137 bank
->sectors
[i
].offset
= offset
;
138 bank
->sectors
[i
].size
= sectorSize
;
139 offset
+= bank
->sectors
[i
].size
;
140 bank
->sectors
[i
].is_erased
= -1;
141 bank
->sectors
[i
].is_protected
= 0;
144 info
->target
= get_target(CMD_ARGV
[5]);
145 if (info
->target
== NULL
)
147 LOG_ERROR("target '%s' not defined", CMD_ARGV
[5]);
153 static int loadDriver(struct ecosflash_flash_bank
*info
)
159 image
.base_address_set
= 0;
160 image
.start_address_set
= 0;
161 struct target
*target
= info
->target
;
164 if ((retval
= image_open(&image
, info
->driverPath
, NULL
)) != ERROR_OK
)
169 info
->start_address
= image
.start_address
;
173 for (i
= 0; i
< image
.num_sections
; i
++)
175 void *buffer
= malloc(image
.sections
[i
].size
);
177 if ((retval
= image_read_section(&image
, i
, 0x0, image
.sections
[i
].size
, buffer
, &buf_cnt
)) != ERROR_OK
)
183 target_write_buffer(target
, image
.sections
[i
].base_address
, buf_cnt
, buffer
);
184 image_size
+= buf_cnt
;
185 LOG_DEBUG("%zu bytes written at address 0x%8.8" PRIx32
"",
186 buf_cnt
, image
.sections
[i
].base_address
);
196 static int const OFFSET_ERASE
= 0x0;
197 static int const OFFSET_ERASE_SIZE
= 0x8;
198 static int const OFFSET_FLASH
= 0xc;
199 static int const OFFSET_FLASH_SIZE
= 0x8;
200 static int const OFFSET_GET_WORKAREA
= 0x18;
201 static int const OFFSET_GET_WORKAREA_SIZE
= 0x4;
203 static int runCode(struct ecosflash_flash_bank
*info
,
204 uint32_t codeStart
, uint32_t codeStop
, uint32_t r0
, uint32_t r1
, uint32_t r2
,
209 struct target
*target
= info
->target
;
211 struct reg_param reg_params
[3];
212 struct arm_algorithm armv4_5_info
;
213 armv4_5_info
.common_magic
= ARM_COMMON_MAGIC
;
214 armv4_5_info
.core_mode
= ARM_MODE_SVC
;
215 armv4_5_info
.core_state
= ARM_STATE_ARM
;
217 init_reg_param(®_params
[0], "r0", 32, PARAM_IN_OUT
);
218 init_reg_param(®_params
[1], "r1", 32, PARAM_OUT
);
219 init_reg_param(®_params
[2], "r2", 32, PARAM_OUT
);
221 buf_set_u32(reg_params
[0].value
, 0, 32, r0
);
222 buf_set_u32(reg_params
[1].value
, 0, 32, r1
);
223 buf_set_u32(reg_params
[2].value
, 0, 32, r2
);
226 if ((retval
= target_run_algorithm(target
, 0, NULL
, 3, reg_params
,
229 &armv4_5_info
)) != ERROR_OK
)
231 LOG_ERROR("error executing eCos flash algorithm");
235 *result
= buf_get_u32(reg_params
[0].value
, 0, 32);
237 destroy_reg_param(®_params
[0]);
238 destroy_reg_param(®_params
[1]);
239 destroy_reg_param(®_params
[2]);
244 static int eCosBoard_erase(struct ecosflash_flash_bank
*info
, uint32_t address
, uint32_t len
)
247 int timeout
= (len
/ 20480 + 1) * 1000; /*asume 20 KB/s*/
249 retval
= loadDriver(info
);
250 if (retval
!= ERROR_OK
)
254 retval
= runCode(info
,
255 info
->start_address
+ OFFSET_ERASE
,
256 info
->start_address
+ OFFSET_ERASE
+ OFFSET_ERASE_SIZE
,
263 if (retval
!= ERROR_OK
)
268 LOG_ERROR("Flash erase failed with %d (%s)\n", (int)flashErr
, flash_errmsg(flashErr
));
275 static int eCosBoard_flash(struct ecosflash_flash_bank
*info
, void *data
, uint32_t address
, uint32_t len
)
277 struct target
*target
= info
->target
;
278 const int chunk
= 8192;
279 int retval
= ERROR_OK
;
280 int timeout
= (chunk
/ 20480 + 1) * 1000; /*asume 20 KB/s + 1 second*/
282 retval
= loadDriver(info
);
283 if (retval
!= ERROR_OK
)
287 retval
= runCode(info
,
288 info
->start_address
+ OFFSET_GET_WORKAREA
,
289 info
->start_address
+ OFFSET_GET_WORKAREA
+ OFFSET_GET_WORKAREA_SIZE
,
295 if (retval
!= ERROR_OK
)
300 for (i
= 0; i
< len
; i
+= chunk
)
309 retval
= target_write_buffer(target
, buffer
, t
, ((uint8_t *)data
) + i
);
310 if (retval
!= ERROR_OK
)
314 retval
= runCode(info
,
315 info
->start_address
+ OFFSET_FLASH
,
316 info
->start_address
+ OFFSET_FLASH
+ OFFSET_FLASH_SIZE
,
322 if (retval
!= ERROR_OK
)
327 LOG_ERROR("Flash prog failed with %d (%s)\n", (int)flashErr
, flash_errmsg(flashErr
));
334 static int ecosflash_probe(struct flash_bank
*bank
)
340 static void command(struct flash_bank
*bank
, uint8_t cmd
, uint8_t *cmd_buf
)
342 struct ecosflash_flash_bank
*info
= bank
->driver_priv
;
345 if (info
->target
->endianness
== TARGET_LITTLE_ENDIAN
)
347 for (i
= bank
->bus_width
; i
> 0; i
--)
349 *cmd_buf
++ = (i
& (bank
->chip_width
- 1)) ? 0x0 : cmd
;
354 for (i
= 1; i
<= bank
->bus_width
; i
++)
356 *cmd_buf
++ = (i
& (bank
->chip_width
- 1)) ? 0x0 : cmd
;
363 static uint32_t ecosflash_address(struct flash_bank
*bank
, uint32_t address
)
366 switch (bank
->bus_width
)
369 retval
= address
& 0xfffffffc;
371 retval
= address
& 0xfffffffe;
376 return retval
+ bank
->base
;
380 static int ecosflash_erase(struct flash_bank
*bank
, int first
, int last
)
382 struct flash_bank
*c
= bank
;
383 struct ecosflash_flash_bank
*info
= bank
->driver_priv
;
384 return eCosBoard_erase(info
, c
->base
+ first
*sectorSize
, sectorSize
*(last
-first
+ 1));
387 static int ecosflash_protect(struct flash_bank
*bank
, int set
, int first
, int last
)
392 static int ecosflash_write(struct flash_bank
*bank
, uint8_t *buffer
, uint32_t offset
, uint32_t count
)
394 struct ecosflash_flash_bank
*info
= bank
->driver_priv
;
395 struct flash_bank
*c
= bank
;
396 return eCosBoard_flash(info
, buffer
, c
->base
+ offset
, count
);
399 static int ecosflash_protect_check(struct flash_bank
*bank
)
404 static int ecosflash_info(struct flash_bank
*bank
, char *buf
, int buf_size
)
406 struct ecosflash_flash_bank
*info
= bank
->driver_priv
;
407 snprintf(buf
, buf_size
, "eCos flash driver: %s", info
->driverPath
);
412 static uint32_t ecosflash_get_flash_status(struct flash_bank
*bank
)
417 static void ecosflash_set_flash_mode(struct flash_bank
*bank
,int mode
)
422 static uint32_t ecosflash_wait_status_busy(struct flash_bank
*bank
, uint32_t waitbits
, int timeout
)
427 static int ecosflash_handle_gpnvm_command(struct command_context
*cmd_ctx
, char *cmd
, char **args
, int argc
)
433 struct flash_driver ecosflash_flash
= {
435 .flash_bank_command
= ecosflash_flash_bank_command
,
436 .erase
= ecosflash_erase
,
437 .protect
= ecosflash_protect
,
438 .write
= ecosflash_write
,
439 .probe
= ecosflash_probe
,
440 .auto_probe
= ecosflash_probe
,
441 .erase_check
= default_flash_blank_check
,
442 .protect_check
= ecosflash_protect_check
,
443 .info
= ecosflash_info