1 /***************************************************************************
\r
2 * Copyright (C) 2005 by Dominic Rath *
\r
3 * Dominic.Rath@gmx.de *
\r
5 * This program is free software; you can redistribute it and/or modify *
\r
6 * it under the terms of the GNU General Public License as published by *
\r
7 * the Free Software Foundation; either version 2 of the License, or *
\r
8 * (at your option) any later version. *
\r
10 * This program is distributed in the hope that it will be useful, *
\r
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
\r
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
\r
13 * GNU General Public License for more details. *
\r
15 * You should have received a copy of the GNU General Public License *
\r
16 * along with this program; if not, write to the *
\r
17 * Free Software Foundation, Inc., *
\r
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
\r
19 ***************************************************************************/
\r
20 #ifdef HAVE_CONFIG_H
\r
24 #include "lpc2000.h"
\r
29 #include "armv4_5.h"
\r
30 #include "algorithm.h"
\r
31 #include "binarybuffer.h"
\r
36 /* flash programming support for Philips LPC2xxx devices
\r
37 * currently supported devices:
\r
38 * variant 1 (lpc2000_v1):
\r
46 * variant 2 (lpc2000_v2):
\r
54 int lpc2000_register_commands(struct command_context_s *cmd_ctx);
\r
55 int lpc2000_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank);
\r
56 int lpc2000_erase(struct flash_bank_s *bank, int first, int last);
\r
57 int lpc2000_protect(struct flash_bank_s *bank, int set, int first, int last);
\r
58 int lpc2000_write(struct flash_bank_s *bank, u8 *buffer, u32 offset, u32 count);
\r
59 int lpc2000_probe(struct flash_bank_s *bank);
\r
60 int lpc2000_erase_check(struct flash_bank_s *bank);
\r
61 int lpc2000_protect_check(struct flash_bank_s *bank);
\r
62 int lpc2000_info(struct flash_bank_s *bank, char *buf, int buf_size);
\r
64 int lpc2000_handle_part_id_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
\r
66 flash_driver_t lpc2000_flash =
\r
69 .register_commands = lpc2000_register_commands,
\r
70 .flash_bank_command = lpc2000_flash_bank_command,
\r
71 .erase = lpc2000_erase,
\r
72 .protect = lpc2000_protect,
\r
73 .write = lpc2000_write,
\r
74 .probe = lpc2000_probe,
\r
75 .auto_probe = lpc2000_probe,
\r
76 .erase_check = lpc2000_erase_check,
\r
77 .protect_check = lpc2000_protect_check,
\r
78 .info = lpc2000_info
\r
81 int lpc2000_register_commands(struct command_context_s *cmd_ctx)
\r
83 command_t *lpc2000_cmd = register_command(cmd_ctx, NULL, "lpc2000", NULL, COMMAND_ANY, NULL);
\r
85 register_command(cmd_ctx, lpc2000_cmd, "part_id", lpc2000_handle_part_id_command, COMMAND_EXEC,
\r
86 "print part id of lpc2000 flash bank <num>");
\r
91 int lpc2000_build_sector_list(struct flash_bank_s *bank)
\r
93 lpc2000_flash_bank_t *lpc2000_info = bank->driver_priv;
\r
95 /* default to a 4096 write buffer */
\r
96 lpc2000_info->cmd51_max_buffer = 4096;
\r
98 if (lpc2000_info->variant == 1)
\r
103 /* variant 1 has different layout for 128kb and 256kb flashes */
\r
104 if (bank->size == 128 * 1024)
\r
106 bank->num_sectors = 16;
\r
107 bank->sectors = malloc(sizeof(flash_sector_t) * 16);
\r
108 for (i = 0; i < 16; i++)
\r
110 bank->sectors[i].offset = offset;
\r
111 bank->sectors[i].size = 8 * 1024;
\r
112 offset += bank->sectors[i].size;
\r
113 bank->sectors[i].is_erased = -1;
\r
114 bank->sectors[i].is_protected = 1;
\r
117 else if (bank->size == 256 * 1024)
\r
119 bank->num_sectors = 18;
\r
120 bank->sectors = malloc(sizeof(flash_sector_t) * 18);
\r
122 for (i = 0; i < 8; i++)
\r
124 bank->sectors[i].offset = offset;
\r
125 bank->sectors[i].size = 8 * 1024;
\r
126 offset += bank->sectors[i].size;
\r
127 bank->sectors[i].is_erased = -1;
\r
128 bank->sectors[i].is_protected = 1;
\r
130 for (i = 8; i < 10; i++)
\r
132 bank->sectors[i].offset = offset;
\r
133 bank->sectors[i].size = 64 * 1024;
\r
134 offset += bank->sectors[i].size;
\r
135 bank->sectors[i].is_erased = -1;
\r
136 bank->sectors[i].is_protected = 1;
\r
138 for (i = 10; i < 18; i++)
\r
140 bank->sectors[i].offset = offset;
\r
141 bank->sectors[i].size = 8 * 1024;
\r
142 offset += bank->sectors[i].size;
\r
143 bank->sectors[i].is_erased = -1;
\r
144 bank->sectors[i].is_protected = 1;
\r
149 ERROR("BUG: unknown bank->size encountered");
\r
153 else if (lpc2000_info->variant == 2)
\r
159 /* variant 2 has a uniform layout, only number of sectors differs */
\r
160 switch (bank->size)
\r
163 lpc2000_info->cmd51_max_buffer = 1024;
\r
167 lpc2000_info->cmd51_max_buffer = 1024;
\r
190 ERROR("BUG: unknown bank->size encountered");
\r
195 bank->num_sectors = num_sectors;
\r
196 bank->sectors = malloc(sizeof(flash_sector_t) * num_sectors);
\r
198 for (i = 0; i < num_sectors; i++)
\r
200 if ((i >= 0) && (i < 8))
\r
202 bank->sectors[i].offset = offset;
\r
203 bank->sectors[i].size = 4 * 1024;
\r
204 offset += bank->sectors[i].size;
\r
205 bank->sectors[i].is_erased = -1;
\r
206 bank->sectors[i].is_protected = 1;
\r
208 if ((i >= 8) && (i < 22))
\r
210 bank->sectors[i].offset = offset;
\r
211 bank->sectors[i].size = 32 * 1024;
\r
212 offset += bank->sectors[i].size;
\r
213 bank->sectors[i].is_erased = -1;
\r
214 bank->sectors[i].is_protected = 1;
\r
216 if ((i >= 22) && (i < 27))
\r
218 bank->sectors[i].offset = offset;
\r
219 bank->sectors[i].size = 4 * 1024;
\r
220 offset += bank->sectors[i].size;
\r
221 bank->sectors[i].is_erased = -1;
\r
222 bank->sectors[i].is_protected = 1;
\r
228 ERROR("BUG: unknown lpc2000_info->variant encountered");
\r
235 /* call LPC2000 IAP function
\r
236 * uses 172 bytes working area
\r
237 * 0x0 to 0x7: jump gate (BX to thumb state, b -2 to wait)
\r
238 * 0x8 to 0x1f: command parameter table
\r
239 * 0x20 to 0x2b: command result table
\r
240 * 0x2c to 0xac: stack (only 128b needed)
\r
242 int lpc2000_iap_call(flash_bank_t *bank, int code, u32 param_table[5], u32 result_table[2])
\r
244 lpc2000_flash_bank_t *lpc2000_info = bank->driver_priv;
\r
245 target_t *target = bank->target;
\r
246 mem_param_t mem_params[2];
\r
247 reg_param_t reg_params[5];
\r
248 armv4_5_algorithm_t armv4_5_info;
\r
251 /* regrab previously allocated working_area, or allocate a new one */
\r
252 if (!lpc2000_info->iap_working_area)
\r
256 /* make sure we have a working area */
\r
257 if (target_alloc_working_area(target, 172, &lpc2000_info->iap_working_area) != ERROR_OK)
\r
259 ERROR("no working area specified, can't write LPC2000 internal flash");
\r
260 return ERROR_FLASH_OPERATION_FAILED;
\r
263 /* write IAP code to working area */
\r
264 target_buffer_set_u32(target, jump_gate, ARMV4_5_BX(12));
\r
265 target_buffer_set_u32(target, jump_gate + 4, ARMV4_5_B(0xfffffe, 0));
\r
266 target->type->write_memory(target, lpc2000_info->iap_working_area->address, 4, 2, jump_gate);
\r
269 armv4_5_info.common_magic = ARMV4_5_COMMON_MAGIC;
\r
270 armv4_5_info.core_mode = ARMV4_5_MODE_SVC;
\r
271 armv4_5_info.core_state = ARMV4_5_STATE_ARM;
\r
273 /* command parameter table */
\r
274 init_mem_param(&mem_params[0], lpc2000_info->iap_working_area->address + 8, 4 * 6, PARAM_OUT);
\r
275 target_buffer_set_u32(target, mem_params[0].value, code);
\r
276 target_buffer_set_u32(target, mem_params[0].value + 0x4, param_table[0]);
\r
277 target_buffer_set_u32(target, mem_params[0].value + 0x8, param_table[1]);
\r
278 target_buffer_set_u32(target, mem_params[0].value + 0xc, param_table[2]);
\r
279 target_buffer_set_u32(target, mem_params[0].value + 0x10, param_table[3]);
\r
280 target_buffer_set_u32(target, mem_params[0].value + 0x14, param_table[4]);
\r
282 init_reg_param(®_params[0], "r0", 32, PARAM_OUT);
\r
283 buf_set_u32(reg_params[0].value, 0, 32, lpc2000_info->iap_working_area->address + 0x8);
\r
285 /* command result table */
\r
286 init_mem_param(&mem_params[1], lpc2000_info->iap_working_area->address + 0x20, 4 * 3, PARAM_IN);
\r
288 init_reg_param(®_params[1], "r1", 32, PARAM_OUT);
\r
289 buf_set_u32(reg_params[1].value, 0, 32, lpc2000_info->iap_working_area->address + 0x20);
\r
291 /* IAP entry point */
\r
292 init_reg_param(®_params[2], "r12", 32, PARAM_OUT);
\r
293 buf_set_u32(reg_params[2].value, 0, 32, 0x7ffffff1);
\r
296 init_reg_param(®_params[3], "r13_svc", 32, PARAM_OUT);
\r
297 buf_set_u32(reg_params[3].value, 0, 32, lpc2000_info->iap_working_area->address + 0xac);
\r
299 /* return address */
\r
300 init_reg_param(®_params[4], "lr_svc", 32, PARAM_OUT);
\r
301 buf_set_u32(reg_params[4].value, 0, 32, lpc2000_info->iap_working_area->address + 0x4);
\r
303 target->type->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);
\r
305 status_code = buf_get_u32(mem_params[1].value, 0, 32);
\r
306 result_table[0] = target_buffer_get_u32(target, mem_params[1].value);
\r
307 result_table[1] = target_buffer_get_u32(target, mem_params[1].value + 4);
\r
309 destroy_mem_param(&mem_params[0]);
\r
310 destroy_mem_param(&mem_params[1]);
\r
312 destroy_reg_param(®_params[0]);
\r
313 destroy_reg_param(®_params[1]);
\r
314 destroy_reg_param(®_params[2]);
\r
315 destroy_reg_param(®_params[3]);
\r
316 destroy_reg_param(®_params[4]);
\r
318 return status_code;
\r
321 int lpc2000_iap_blank_check(struct flash_bank_s *bank, int first, int last)
\r
323 u32 param_table[5];
\r
324 u32 result_table[2];
\r
328 if ((first < 0) || (last > bank->num_sectors))
\r
329 return ERROR_FLASH_SECTOR_INVALID;
\r
331 for (i = first; i <= last; i++)
\r
333 /* check single sector */
\r
334 param_table[0] = param_table[1] = i;
\r
335 status_code = lpc2000_iap_call(bank, 53, param_table, result_table);
\r
337 switch (status_code)
\r
339 case ERROR_FLASH_OPERATION_FAILED:
\r
340 return ERROR_FLASH_OPERATION_FAILED;
\r
341 case LPC2000_CMD_SUCCESS:
\r
342 bank->sectors[i].is_erased = 1;
\r
344 case LPC2000_SECTOR_NOT_BLANK:
\r
345 bank->sectors[i].is_erased = 0;
\r
347 case LPC2000_INVALID_SECTOR:
\r
348 bank->sectors[i].is_erased = 0;
\r
351 return ERROR_FLASH_BUSY;
\r
354 ERROR("BUG: unknown LPC2000 status code");
\r
362 /* flash bank lpc2000 <base> <size> 0 0 <target#> <lpc_variant> <cclk> [calc_checksum]
\r
364 int lpc2000_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank)
\r
366 lpc2000_flash_bank_t *lpc2000_info;
\r
370 WARNING("incomplete flash_bank lpc2000 configuration");
\r
371 return ERROR_FLASH_BANK_INVALID;
\r
374 lpc2000_info = malloc(sizeof(lpc2000_flash_bank_t));
\r
375 bank->driver_priv = lpc2000_info;
\r
377 if (strcmp(args[6], "lpc2000_v1") == 0)
\r
379 lpc2000_info->variant = 1;
\r
380 lpc2000_info->cmd51_dst_boundary = 512;
\r
381 lpc2000_info->cmd51_can_256b = 0;
\r
382 lpc2000_info->cmd51_can_8192b = 1;
\r
384 else if (strcmp(args[6], "lpc2000_v2") == 0)
\r
386 lpc2000_info->variant = 2;
\r
387 lpc2000_info->cmd51_dst_boundary = 256;
\r
388 lpc2000_info->cmd51_can_256b = 1;
\r
389 lpc2000_info->cmd51_can_8192b = 0;
\r
393 ERROR("unknown LPC2000 variant");
\r
394 free(lpc2000_info);
\r
395 return ERROR_FLASH_BANK_INVALID;
\r
398 lpc2000_info->iap_working_area = NULL;
\r
399 lpc2000_info->cclk = strtoul(args[7], NULL, 0);
\r
400 lpc2000_info->calc_checksum = 0;
\r
401 lpc2000_build_sector_list(bank);
\r
405 if (strcmp(args[8], "calc_checksum") == 0)
\r
406 lpc2000_info->calc_checksum = 1;
\r
412 int lpc2000_erase(struct flash_bank_s *bank, int first, int last)
\r
414 lpc2000_flash_bank_t *lpc2000_info = bank->driver_priv;
\r
415 u32 param_table[5];
\r
416 u32 result_table[2];
\r
419 param_table[0] = first;
\r
420 param_table[1] = last;
\r
421 param_table[2] = lpc2000_info->cclk;
\r
423 /* Prepare sectors */
\r
424 status_code = lpc2000_iap_call(bank, 50, param_table, result_table);
\r
425 switch (status_code)
\r
427 case ERROR_FLASH_OPERATION_FAILED:
\r
428 return ERROR_FLASH_OPERATION_FAILED;
\r
429 case LPC2000_CMD_SUCCESS:
\r
431 case LPC2000_INVALID_SECTOR:
\r
432 return ERROR_FLASH_SECTOR_INVALID;
\r
435 WARNING("lpc2000 prepare sectors returned %i", status_code);
\r
436 return ERROR_FLASH_OPERATION_FAILED;
\r
439 /* Erase sectors */
\r
440 status_code = lpc2000_iap_call(bank, 52, param_table, result_table);
\r
441 switch (status_code)
\r
443 case ERROR_FLASH_OPERATION_FAILED:
\r
444 return ERROR_FLASH_OPERATION_FAILED;
\r
445 case LPC2000_CMD_SUCCESS:
\r
447 case LPC2000_INVALID_SECTOR:
\r
448 return ERROR_FLASH_SECTOR_INVALID;
\r
451 WARNING("lpc2000 erase sectors returned %i", status_code);
\r
452 return ERROR_FLASH_OPERATION_FAILED;
\r
458 int lpc2000_protect(struct flash_bank_s *bank, int set, int first, int last)
\r
460 /* can't protect/unprotect on the lpc2000 */
\r
464 int lpc2000_write(struct flash_bank_s *bank, u8 *buffer, u32 offset, u32 count)
\r
466 lpc2000_flash_bank_t *lpc2000_info = bank->driver_priv;
\r
467 target_t *target = bank->target;
\r
468 u32 dst_min_alignment;
\r
469 u32 bytes_remaining = count;
\r
470 u32 bytes_written = 0;
\r
471 int first_sector = 0;
\r
472 int last_sector = 0;
\r
473 u32 param_table[5];
\r
474 u32 result_table[2];
\r
477 working_area_t *download_area;
\r
479 /* allocate a working area */
\r
480 if (target_alloc_working_area(target, lpc2000_info->cmd51_max_buffer, &download_area) != ERROR_OK)
\r
482 ERROR("no working area specified, can't write LPC2000 internal flash");
\r
483 return ERROR_FLASH_OPERATION_FAILED;
\r
486 if (offset + count > bank->size)
\r
487 return ERROR_FLASH_DST_OUT_OF_BANK;
\r
489 if (lpc2000_info->cmd51_can_256b)
\r
490 dst_min_alignment = 256;
\r
492 dst_min_alignment = 512;
\r
494 if (offset % dst_min_alignment)
\r
496 WARNING("offset 0x%x breaks required alignment 0x%x", offset, dst_min_alignment);
\r
497 return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
\r
500 for (i = 0; i < bank->num_sectors; i++)
\r
502 if (offset >= bank->sectors[i].offset)
\r
504 if (offset + CEIL(count, dst_min_alignment) * dst_min_alignment > bank->sectors[i].offset)
\r
508 DEBUG("first_sector: %i, last_sector: %i", first_sector, last_sector);
\r
510 /* check if exception vectors should be flashed */
\r
511 if ((offset == 0) && (count >= 0x20) && lpc2000_info->calc_checksum)
\r
515 for (i = 0; i < 8; i++)
\r
517 DEBUG("0x%2.2x: 0x%8.8x", i * 4, buf_get_u32(buffer + (i * 4), 0, 32));
\r
519 checksum += buf_get_u32(buffer + (i * 4), 0, 32);
\r
521 checksum = 0 - checksum;
\r
522 DEBUG("checksum: 0x%8.8x", checksum);
\r
523 buf_set_u32(buffer + 0x14, 0, 32, checksum);
\r
526 while (bytes_remaining > 0)
\r
529 if (bytes_remaining >= lpc2000_info->cmd51_max_buffer)
\r
530 thisrun_bytes = lpc2000_info->cmd51_max_buffer;
\r
531 else if (bytes_remaining >= 1024)
\r
532 thisrun_bytes = 1024;
\r
533 else if ((bytes_remaining >= 512) || (!lpc2000_info->cmd51_can_256b))
\r
534 thisrun_bytes = 512;
\r
536 thisrun_bytes = 256;
\r
538 /* Prepare sectors */
\r
539 param_table[0] = first_sector;
\r
540 param_table[1] = last_sector;
\r
541 status_code = lpc2000_iap_call(bank, 50, param_table, result_table);
\r
542 switch (status_code)
\r
544 case ERROR_FLASH_OPERATION_FAILED:
\r
545 return ERROR_FLASH_OPERATION_FAILED;
\r
546 case LPC2000_CMD_SUCCESS:
\r
548 case LPC2000_INVALID_SECTOR:
\r
549 return ERROR_FLASH_SECTOR_INVALID;
\r
552 WARNING("lpc2000 prepare sectors returned %i", status_code);
\r
553 return ERROR_FLASH_OPERATION_FAILED;
\r
556 if (bytes_remaining >= thisrun_bytes)
\r
558 if (target_write_buffer(bank->target, download_area->address, thisrun_bytes, buffer + bytes_written) != ERROR_OK)
\r
560 target_free_working_area(target, download_area);
\r
561 return ERROR_FLASH_OPERATION_FAILED;
\r
566 u8 *last_buffer = malloc(thisrun_bytes);
\r
568 memcpy(last_buffer, buffer + bytes_written, bytes_remaining);
\r
569 for (i = bytes_remaining; i < thisrun_bytes; i++)
\r
570 last_buffer[i] = 0xff;
\r
571 target_write_buffer(bank->target, download_area->address, thisrun_bytes, last_buffer);
\r
575 DEBUG("writing 0x%x bytes to address 0x%x", thisrun_bytes, bank->base + offset + bytes_written);
\r
578 param_table[0] = bank->base + offset + bytes_written;
\r
579 param_table[1] = download_area->address;
\r
580 param_table[2] = thisrun_bytes;
\r
581 param_table[3] = lpc2000_info->cclk;
\r
582 status_code = lpc2000_iap_call(bank, 51, param_table, result_table);
\r
583 switch (status_code)
\r
585 case ERROR_FLASH_OPERATION_FAILED:
\r
586 return ERROR_FLASH_OPERATION_FAILED;
\r
587 case LPC2000_CMD_SUCCESS:
\r
589 case LPC2000_INVALID_SECTOR:
\r
590 return ERROR_FLASH_SECTOR_INVALID;
\r
593 WARNING("lpc2000 returned %i", status_code);
\r
594 return ERROR_FLASH_OPERATION_FAILED;
\r
597 if (bytes_remaining > thisrun_bytes)
\r
598 bytes_remaining -= thisrun_bytes;
\r
600 bytes_remaining = 0;
\r
601 bytes_written += thisrun_bytes;
\r
604 target_free_working_area(target, download_area);
\r
609 int lpc2000_probe(struct flash_bank_s *bank)
\r
611 /* we can't probe on an lpc2000
\r
612 * if this is an lpc2xxx, it has the configured flash
\r
617 int lpc2000_erase_check(struct flash_bank_s *bank)
\r
619 if (bank->target->state != TARGET_HALTED)
\r
621 return ERROR_TARGET_NOT_HALTED;
\r
624 return lpc2000_iap_blank_check(bank, 0, bank->num_sectors - 1);
\r
627 int lpc2000_protect_check(struct flash_bank_s *bank)
\r
629 /* sectors are always protected */
\r
633 int lpc2000_info(struct flash_bank_s *bank, char *buf, int buf_size)
\r
635 lpc2000_flash_bank_t *lpc2000_info = bank->driver_priv;
\r
637 snprintf(buf, buf_size, "lpc2000 flash driver variant: %i, clk: %i", lpc2000_info->variant, lpc2000_info->cclk);
\r
642 int lpc2000_handle_part_id_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
\r
644 flash_bank_t *bank;
\r
645 u32 param_table[5];
\r
646 u32 result_table[2];
\r
648 lpc2000_flash_bank_t *lpc2000_info;
\r
652 return ERROR_COMMAND_SYNTAX_ERROR;
655 bank = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
\r
658 command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
\r
662 lpc2000_info = bank->driver_priv;
\r
663 if (bank->target->state != TARGET_HALTED)
\r
665 return ERROR_TARGET_NOT_HALTED;
\r
668 if ((status_code = lpc2000_iap_call(bank, 54, param_table, result_table)) != 0x0)
\r
670 if (status_code == ERROR_FLASH_OPERATION_FAILED)
\r
672 command_print(cmd_ctx, "no sufficient working area specified, can't access LPC2000 IAP interface");
\r
675 command_print(cmd_ctx, "lpc2000 IAP returned status code %i", status_code);
\r
679 command_print(cmd_ctx, "lpc2000 part id: 0x%8.8x", result_table[0]);
\r