1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
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 ***************************************************************************/
27 #include "binarybuffer.h"
30 /* flash programming support for Philips LPC2xxx devices
31 * currently supported devices:
32 * variant 1 (lpc2000_v1):
40 * variant 2 (lpc2000_v2):
48 static int lpc2000_register_commands(struct command_context_s
*cmd_ctx
);
49 static int lpc2000_flash_bank_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
, struct flash_bank_s
*bank
);
50 static int lpc2000_erase(struct flash_bank_s
*bank
, int first
, int last
);
51 static int lpc2000_protect(struct flash_bank_s
*bank
, int set
, int first
, int last
);
52 static int lpc2000_write(struct flash_bank_s
*bank
, uint8_t *buffer
, u32 offset
, u32 count
);
53 static int lpc2000_probe(struct flash_bank_s
*bank
);
54 static int lpc2000_erase_check(struct flash_bank_s
*bank
);
55 static int lpc2000_protect_check(struct flash_bank_s
*bank
);
56 static int lpc2000_info(struct flash_bank_s
*bank
, char *buf
, int buf_size
);
58 static int lpc2000_handle_part_id_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
60 flash_driver_t lpc2000_flash
=
63 .register_commands
= lpc2000_register_commands
,
64 .flash_bank_command
= lpc2000_flash_bank_command
,
65 .erase
= lpc2000_erase
,
66 .protect
= lpc2000_protect
,
67 .write
= lpc2000_write
,
68 .probe
= lpc2000_probe
,
69 .auto_probe
= lpc2000_probe
,
70 .erase_check
= lpc2000_erase_check
,
71 .protect_check
= lpc2000_protect_check
,
75 static int lpc2000_register_commands(struct command_context_s
*cmd_ctx
)
77 command_t
*lpc2000_cmd
= register_command(cmd_ctx
, NULL
, "lpc2000", NULL
, COMMAND_ANY
, NULL
);
79 register_command(cmd_ctx
, lpc2000_cmd
, "part_id", lpc2000_handle_part_id_command
, COMMAND_EXEC
,
80 "print part id of lpc2000 flash bank <num>");
85 static int lpc2000_build_sector_list(struct flash_bank_s
*bank
)
87 lpc2000_flash_bank_t
*lpc2000_info
= bank
->driver_priv
;
89 /* default to a 4096 write buffer */
90 lpc2000_info
->cmd51_max_buffer
= 4096;
92 if (lpc2000_info
->variant
== 1)
97 /* variant 1 has different layout for 128kb and 256kb flashes */
98 if (bank
->size
== 128 * 1024)
100 bank
->num_sectors
= 16;
101 bank
->sectors
= malloc(sizeof(flash_sector_t
) * 16);
102 for (i
= 0; i
< 16; i
++)
104 bank
->sectors
[i
].offset
= offset
;
105 bank
->sectors
[i
].size
= 8 * 1024;
106 offset
+= bank
->sectors
[i
].size
;
107 bank
->sectors
[i
].is_erased
= -1;
108 bank
->sectors
[i
].is_protected
= 1;
111 else if (bank
->size
== 256 * 1024)
113 bank
->num_sectors
= 18;
114 bank
->sectors
= malloc(sizeof(flash_sector_t
) * 18);
116 for (i
= 0; i
< 8; i
++)
118 bank
->sectors
[i
].offset
= offset
;
119 bank
->sectors
[i
].size
= 8 * 1024;
120 offset
+= bank
->sectors
[i
].size
;
121 bank
->sectors
[i
].is_erased
= -1;
122 bank
->sectors
[i
].is_protected
= 1;
124 for (i
= 8; i
< 10; i
++)
126 bank
->sectors
[i
].offset
= offset
;
127 bank
->sectors
[i
].size
= 64 * 1024;
128 offset
+= bank
->sectors
[i
].size
;
129 bank
->sectors
[i
].is_erased
= -1;
130 bank
->sectors
[i
].is_protected
= 1;
132 for (i
= 10; i
< 18; i
++)
134 bank
->sectors
[i
].offset
= offset
;
135 bank
->sectors
[i
].size
= 8 * 1024;
136 offset
+= bank
->sectors
[i
].size
;
137 bank
->sectors
[i
].is_erased
= -1;
138 bank
->sectors
[i
].is_protected
= 1;
143 LOG_ERROR("BUG: unknown bank->size encountered");
147 else if (lpc2000_info
->variant
== 2)
153 /* variant 2 has a uniform layout, only number of sectors differs */
157 lpc2000_info
->cmd51_max_buffer
= 1024;
161 lpc2000_info
->cmd51_max_buffer
= 1024;
184 LOG_ERROR("BUG: unknown bank->size encountered");
189 bank
->num_sectors
= num_sectors
;
190 bank
->sectors
= malloc(sizeof(flash_sector_t
) * num_sectors
);
192 for (i
= 0; i
< num_sectors
; i
++)
194 if ((i
>= 0) && (i
< 8))
196 bank
->sectors
[i
].offset
= offset
;
197 bank
->sectors
[i
].size
= 4 * 1024;
198 offset
+= bank
->sectors
[i
].size
;
199 bank
->sectors
[i
].is_erased
= -1;
200 bank
->sectors
[i
].is_protected
= 1;
202 if ((i
>= 8) && (i
< 22))
204 bank
->sectors
[i
].offset
= offset
;
205 bank
->sectors
[i
].size
= 32 * 1024;
206 offset
+= bank
->sectors
[i
].size
;
207 bank
->sectors
[i
].is_erased
= -1;
208 bank
->sectors
[i
].is_protected
= 1;
210 if ((i
>= 22) && (i
< 27))
212 bank
->sectors
[i
].offset
= offset
;
213 bank
->sectors
[i
].size
= 4 * 1024;
214 offset
+= bank
->sectors
[i
].size
;
215 bank
->sectors
[i
].is_erased
= -1;
216 bank
->sectors
[i
].is_protected
= 1;
222 LOG_ERROR("BUG: unknown lpc2000_info->variant encountered");
229 /* call LPC2000 IAP function
230 * uses 172 bytes working area
231 * 0x0 to 0x7: jump gate (BX to thumb state, b -2 to wait)
232 * 0x8 to 0x1f: command parameter table
233 * 0x20 to 0x2b: command result table
234 * 0x2c to 0xac: stack (only 128b needed)
236 static int lpc2000_iap_call(flash_bank_t
*bank
, int code
, u32 param_table
[5], u32 result_table
[2])
239 lpc2000_flash_bank_t
*lpc2000_info
= bank
->driver_priv
;
240 target_t
*target
= bank
->target
;
241 mem_param_t mem_params
[2];
242 reg_param_t reg_params
[5];
243 armv4_5_algorithm_t armv4_5_info
;
246 /* regrab previously allocated working_area, or allocate a new one */
247 if (!lpc2000_info
->iap_working_area
)
249 uint8_t jump_gate
[8];
251 /* make sure we have a working area */
252 if (target_alloc_working_area(target
, 172, &lpc2000_info
->iap_working_area
) != ERROR_OK
)
254 LOG_ERROR("no working area specified, can't write LPC2000 internal flash");
255 return ERROR_FLASH_OPERATION_FAILED
;
258 /* write IAP code to working area */
259 target_buffer_set_u32(target
, jump_gate
, ARMV4_5_BX(12));
260 target_buffer_set_u32(target
, jump_gate
+ 4, ARMV4_5_B(0xfffffe, 0));
261 if((retval
= target_write_memory(target
, lpc2000_info
->iap_working_area
->address
, 4, 2, jump_gate
)) != ERROR_OK
)
267 armv4_5_info
.common_magic
= ARMV4_5_COMMON_MAGIC
;
268 armv4_5_info
.core_mode
= ARMV4_5_MODE_SVC
;
269 armv4_5_info
.core_state
= ARMV4_5_STATE_ARM
;
271 /* command parameter table */
272 init_mem_param(&mem_params
[0], lpc2000_info
->iap_working_area
->address
+ 8, 4 * 6, PARAM_OUT
);
273 target_buffer_set_u32(target
, mem_params
[0].value
, code
);
274 target_buffer_set_u32(target
, mem_params
[0].value
+ 0x4, param_table
[0]);
275 target_buffer_set_u32(target
, mem_params
[0].value
+ 0x8, param_table
[1]);
276 target_buffer_set_u32(target
, mem_params
[0].value
+ 0xc, param_table
[2]);
277 target_buffer_set_u32(target
, mem_params
[0].value
+ 0x10, param_table
[3]);
278 target_buffer_set_u32(target
, mem_params
[0].value
+ 0x14, param_table
[4]);
280 init_reg_param(®_params
[0], "r0", 32, PARAM_OUT
);
281 buf_set_u32(reg_params
[0].value
, 0, 32, lpc2000_info
->iap_working_area
->address
+ 0x8);
283 /* command result table */
284 init_mem_param(&mem_params
[1], lpc2000_info
->iap_working_area
->address
+ 0x20, 4 * 3, PARAM_IN
);
286 init_reg_param(®_params
[1], "r1", 32, PARAM_OUT
);
287 buf_set_u32(reg_params
[1].value
, 0, 32, lpc2000_info
->iap_working_area
->address
+ 0x20);
289 /* IAP entry point */
290 init_reg_param(®_params
[2], "r12", 32, PARAM_OUT
);
291 buf_set_u32(reg_params
[2].value
, 0, 32, 0x7ffffff1);
294 init_reg_param(®_params
[3], "r13_svc", 32, PARAM_OUT
);
295 buf_set_u32(reg_params
[3].value
, 0, 32, lpc2000_info
->iap_working_area
->address
+ 0xac);
298 init_reg_param(®_params
[4], "lr_svc", 32, PARAM_OUT
);
299 buf_set_u32(reg_params
[4].value
, 0, 32, lpc2000_info
->iap_working_area
->address
+ 0x4);
301 target_run_algorithm(target
, 2, mem_params
, 5, reg_params
, lpc2000_info
->iap_working_area
->address
, lpc2000_info
->iap_working_area
->address
+ 0x4, 10000, &armv4_5_info
);
303 status_code
= buf_get_u32(mem_params
[1].value
, 0, 32);
304 result_table
[0] = target_buffer_get_u32(target
, mem_params
[1].value
);
305 result_table
[1] = target_buffer_get_u32(target
, mem_params
[1].value
+ 4);
307 destroy_mem_param(&mem_params
[0]);
308 destroy_mem_param(&mem_params
[1]);
310 destroy_reg_param(®_params
[0]);
311 destroy_reg_param(®_params
[1]);
312 destroy_reg_param(®_params
[2]);
313 destroy_reg_param(®_params
[3]);
314 destroy_reg_param(®_params
[4]);
319 static int lpc2000_iap_blank_check(struct flash_bank_s
*bank
, int first
, int last
)
326 if ((first
< 0) || (last
>= bank
->num_sectors
))
327 return ERROR_FLASH_SECTOR_INVALID
;
329 for (i
= first
; i
<= last
; i
++)
331 /* check single sector */
332 param_table
[0] = param_table
[1] = i
;
333 status_code
= lpc2000_iap_call(bank
, 53, param_table
, result_table
);
337 case ERROR_FLASH_OPERATION_FAILED
:
338 return ERROR_FLASH_OPERATION_FAILED
;
339 case LPC2000_CMD_SUCCESS
:
340 bank
->sectors
[i
].is_erased
= 1;
342 case LPC2000_SECTOR_NOT_BLANK
:
343 bank
->sectors
[i
].is_erased
= 0;
345 case LPC2000_INVALID_SECTOR
:
346 bank
->sectors
[i
].is_erased
= 0;
349 return ERROR_FLASH_BUSY
;
352 LOG_ERROR("BUG: unknown LPC2000 status code");
360 /* flash bank lpc2000 <base> <size> 0 0 <target#> <lpc_variant> <cclk> [calc_checksum]
362 static int lpc2000_flash_bank_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
, struct flash_bank_s
*bank
)
364 lpc2000_flash_bank_t
*lpc2000_info
;
368 LOG_WARNING("incomplete flash_bank lpc2000 configuration");
369 return ERROR_FLASH_BANK_INVALID
;
372 lpc2000_info
= malloc(sizeof(lpc2000_flash_bank_t
));
373 bank
->driver_priv
= lpc2000_info
;
375 if (strcmp(args
[6], "lpc2000_v1") == 0)
377 lpc2000_info
->variant
= 1;
378 lpc2000_info
->cmd51_dst_boundary
= 512;
379 lpc2000_info
->cmd51_can_256b
= 0;
380 lpc2000_info
->cmd51_can_8192b
= 1;
382 else if (strcmp(args
[6], "lpc2000_v2") == 0)
384 lpc2000_info
->variant
= 2;
385 lpc2000_info
->cmd51_dst_boundary
= 256;
386 lpc2000_info
->cmd51_can_256b
= 1;
387 lpc2000_info
->cmd51_can_8192b
= 0;
391 LOG_ERROR("unknown LPC2000 variant");
393 return ERROR_FLASH_BANK_INVALID
;
396 lpc2000_info
->iap_working_area
= NULL
;
397 lpc2000_info
->cclk
= strtoul(args
[7], NULL
, 0);
398 lpc2000_info
->calc_checksum
= 0;
399 lpc2000_build_sector_list(bank
);
403 if (strcmp(args
[8], "calc_checksum") == 0)
404 lpc2000_info
->calc_checksum
= 1;
410 static int lpc2000_erase(struct flash_bank_s
*bank
, int first
, int last
)
412 lpc2000_flash_bank_t
*lpc2000_info
= bank
->driver_priv
;
417 if (bank
->target
->state
!= TARGET_HALTED
)
419 LOG_ERROR("Target not halted");
420 return ERROR_TARGET_NOT_HALTED
;
423 param_table
[0] = first
;
424 param_table
[1] = last
;
425 param_table
[2] = lpc2000_info
->cclk
;
427 /* Prepare sectors */
428 status_code
= lpc2000_iap_call(bank
, 50, param_table
, result_table
);
431 case ERROR_FLASH_OPERATION_FAILED
:
432 return ERROR_FLASH_OPERATION_FAILED
;
433 case LPC2000_CMD_SUCCESS
:
435 case LPC2000_INVALID_SECTOR
:
436 return ERROR_FLASH_SECTOR_INVALID
;
439 LOG_WARNING("lpc2000 prepare sectors returned %i", status_code
);
440 return ERROR_FLASH_OPERATION_FAILED
;
444 status_code
= lpc2000_iap_call(bank
, 52, param_table
, result_table
);
447 case ERROR_FLASH_OPERATION_FAILED
:
448 return ERROR_FLASH_OPERATION_FAILED
;
449 case LPC2000_CMD_SUCCESS
:
451 case LPC2000_INVALID_SECTOR
:
452 return ERROR_FLASH_SECTOR_INVALID
;
455 LOG_WARNING("lpc2000 erase sectors returned %i", status_code
);
456 return ERROR_FLASH_OPERATION_FAILED
;
462 static int lpc2000_protect(struct flash_bank_s
*bank
, int set
, int first
, int last
)
464 /* can't protect/unprotect on the lpc2000 */
468 static int lpc2000_write(struct flash_bank_s
*bank
, uint8_t *buffer
, u32 offset
, u32 count
)
470 lpc2000_flash_bank_t
*lpc2000_info
= bank
->driver_priv
;
471 target_t
*target
= bank
->target
;
472 u32 dst_min_alignment
;
473 u32 bytes_remaining
= count
;
474 u32 bytes_written
= 0;
475 int first_sector
= 0;
481 working_area_t
*download_area
;
482 int retval
= ERROR_OK
;
484 if (bank
->target
->state
!= TARGET_HALTED
)
486 LOG_ERROR("Target not halted");
487 return ERROR_TARGET_NOT_HALTED
;
490 if (offset
+ count
> bank
->size
)
491 return ERROR_FLASH_DST_OUT_OF_BANK
;
493 if (lpc2000_info
->cmd51_can_256b
)
494 dst_min_alignment
= 256;
496 dst_min_alignment
= 512;
498 if (offset
% dst_min_alignment
)
500 LOG_WARNING("offset 0x%x breaks required alignment 0x%x", offset
, dst_min_alignment
);
501 return ERROR_FLASH_DST_BREAKS_ALIGNMENT
;
504 for (i
= 0; i
< bank
->num_sectors
; i
++)
506 if (offset
>= bank
->sectors
[i
].offset
)
508 if (offset
+ CEIL(count
, dst_min_alignment
) * dst_min_alignment
> bank
->sectors
[i
].offset
)
512 LOG_DEBUG("first_sector: %i, last_sector: %i", first_sector
, last_sector
);
514 /* check if exception vectors should be flashed */
515 if ((offset
== 0) && (count
>= 0x20) && lpc2000_info
->calc_checksum
)
519 for (i
= 0; i
< 8; i
++)
521 LOG_DEBUG("0x%2.2x: 0x%8.8x", i
* 4, buf_get_u32(buffer
+ (i
* 4), 0, 32));
523 checksum
+= buf_get_u32(buffer
+ (i
* 4), 0, 32);
525 checksum
= 0 - checksum
;
526 LOG_DEBUG("checksum: 0x%8.8x", checksum
);
528 u32 original_value
=buf_get_u32(buffer
+ (5 * 4), 0, 32);
529 if (original_value
!=checksum
)
531 LOG_WARNING("Verification will fail since checksum in image(0x%8.8x) written to flash was different from calculated vector checksum(0x%8.8x).",
532 original_value
, checksum
);
533 LOG_WARNING("To remove this warning modify build tools on developer PC to inject correct LPC vector checksum.");
536 buf_set_u32(buffer
+ 0x14, 0, 32, checksum
);
539 /* allocate a working area */
540 if (target_alloc_working_area(target
, lpc2000_info
->cmd51_max_buffer
, &download_area
) != ERROR_OK
)
542 LOG_ERROR("no working area specified, can't write LPC2000 internal flash");
543 return ERROR_FLASH_OPERATION_FAILED
;
546 while (bytes_remaining
> 0)
549 if (bytes_remaining
>= lpc2000_info
->cmd51_max_buffer
)
550 thisrun_bytes
= lpc2000_info
->cmd51_max_buffer
;
551 else if (bytes_remaining
>= 1024)
552 thisrun_bytes
= 1024;
553 else if ((bytes_remaining
>= 512) || (!lpc2000_info
->cmd51_can_256b
))
558 /* Prepare sectors */
559 param_table
[0] = first_sector
;
560 param_table
[1] = last_sector
;
561 status_code
= lpc2000_iap_call(bank
, 50, param_table
, result_table
);
564 case ERROR_FLASH_OPERATION_FAILED
:
565 retval
= ERROR_FLASH_OPERATION_FAILED
;
567 case LPC2000_CMD_SUCCESS
:
569 case LPC2000_INVALID_SECTOR
:
570 retval
= ERROR_FLASH_SECTOR_INVALID
;
573 LOG_WARNING("lpc2000 prepare sectors returned %i", status_code
);
574 retval
= ERROR_FLASH_OPERATION_FAILED
;
578 /* Exit if error occured */
579 if (retval
!= ERROR_OK
)
582 if (bytes_remaining
>= thisrun_bytes
)
584 if ((retval
= target_write_buffer(bank
->target
, download_area
->address
, thisrun_bytes
, buffer
+ bytes_written
)) != ERROR_OK
)
586 retval
= ERROR_FLASH_OPERATION_FAILED
;
592 uint8_t *last_buffer
= malloc(thisrun_bytes
);
594 memcpy(last_buffer
, buffer
+ bytes_written
, bytes_remaining
);
595 for (i
= bytes_remaining
; i
< thisrun_bytes
; i
++)
596 last_buffer
[i
] = 0xff;
597 target_write_buffer(bank
->target
, download_area
->address
, thisrun_bytes
, last_buffer
);
601 LOG_DEBUG("writing 0x%x bytes to address 0x%x", thisrun_bytes
, bank
->base
+ offset
+ bytes_written
);
604 param_table
[0] = bank
->base
+ offset
+ bytes_written
;
605 param_table
[1] = download_area
->address
;
606 param_table
[2] = thisrun_bytes
;
607 param_table
[3] = lpc2000_info
->cclk
;
608 status_code
= lpc2000_iap_call(bank
, 51, param_table
, result_table
);
611 case ERROR_FLASH_OPERATION_FAILED
:
612 retval
= ERROR_FLASH_OPERATION_FAILED
;
614 case LPC2000_CMD_SUCCESS
:
616 case LPC2000_INVALID_SECTOR
:
617 retval
= ERROR_FLASH_SECTOR_INVALID
;
620 LOG_WARNING("lpc2000 returned %i", status_code
);
621 retval
= ERROR_FLASH_OPERATION_FAILED
;
625 /* Exit if error occured */
626 if (retval
!= ERROR_OK
)
629 if (bytes_remaining
> thisrun_bytes
)
630 bytes_remaining
-= thisrun_bytes
;
633 bytes_written
+= thisrun_bytes
;
636 target_free_working_area(target
, download_area
);
641 static int lpc2000_probe(struct flash_bank_s
*bank
)
643 /* we can't probe on an lpc2000
644 * if this is an lpc2xxx, it has the configured flash
649 static int lpc2000_erase_check(struct flash_bank_s
*bank
)
651 if (bank
->target
->state
!= TARGET_HALTED
)
653 LOG_ERROR("Target not halted");
654 return ERROR_TARGET_NOT_HALTED
;
657 return lpc2000_iap_blank_check(bank
, 0, bank
->num_sectors
- 1);
660 static int lpc2000_protect_check(struct flash_bank_s
*bank
)
662 /* sectors are always protected */
666 static int lpc2000_info(struct flash_bank_s
*bank
, char *buf
, int buf_size
)
668 lpc2000_flash_bank_t
*lpc2000_info
= bank
->driver_priv
;
670 snprintf(buf
, buf_size
, "lpc2000 flash driver variant: %i, clk: %i", lpc2000_info
->variant
, lpc2000_info
->cclk
);
675 static int lpc2000_handle_part_id_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
684 return ERROR_COMMAND_SYNTAX_ERROR
;
687 bank
= get_flash_bank_by_num(strtoul(args
[0], NULL
, 0));
690 command_print(cmd_ctx
, "flash bank '#%s' is out of bounds", args
[0]);
694 if (bank
->target
->state
!= TARGET_HALTED
)
696 LOG_ERROR("Target not halted");
697 return ERROR_TARGET_NOT_HALTED
;
700 if ((status_code
= lpc2000_iap_call(bank
, 54, param_table
, result_table
)) != 0x0)
702 if (status_code
== ERROR_FLASH_OPERATION_FAILED
)
704 command_print(cmd_ctx
, "no sufficient working area specified, can't access LPC2000 IAP interface");
707 command_print(cmd_ctx
, "lpc2000 IAP returned status code %i", status_code
);
711 command_print(cmd_ctx
, "lpc2000 part id: 0x%8.8x", result_table
[0]);