1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2008 by Spencer Oliver *
6 * spen@spen-soft.co.uk *
8 * This program is free software; you can redistribute it and/or modify *
9 * it under the terms of the GNU General Public License as published by *
10 * the Free Software Foundation; either version 2 of the License, or *
11 * (at your option) any later version. *
13 * This program is distributed in the hope that it will be useful, *
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16 * GNU General Public License for more details. *
18 * You should have received a copy of the GNU General Public License *
19 * along with this program; if not, write to the *
20 * Free Software Foundation, Inc., *
21 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
22 ***************************************************************************/
29 #include "binarybuffer.h"
32 str7x_mem_layout_t mem_layout_str7bank0
[] = {
33 {0x00000000, 0x02000, 0x01},
34 {0x00002000, 0x02000, 0x02},
35 {0x00004000, 0x02000, 0x04},
36 {0x00006000, 0x02000, 0x08},
37 {0x00008000, 0x08000, 0x10},
38 {0x00010000, 0x10000, 0x20},
39 {0x00020000, 0x10000, 0x40},
40 {0x00030000, 0x10000, 0x80}
43 str7x_mem_layout_t mem_layout_str7bank1
[] = {
44 {0x00000000, 0x02000, 0x10000},
45 {0x00002000, 0x02000, 0x20000}
48 static int str7x_register_commands(struct command_context_s
*cmd_ctx
);
49 static int str7x_flash_bank_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
, struct flash_bank_s
*bank
);
50 static int str7x_erase(struct flash_bank_s
*bank
, int first
, int last
);
51 static int str7x_protect(struct flash_bank_s
*bank
, int set
, int first
, int last
);
52 static int str7x_write(struct flash_bank_s
*bank
, uint8_t *buffer
, uint32_t offset
, uint32_t count
);
53 static int str7x_probe(struct flash_bank_s
*bank
);
54 //static int str7x_handle_part_id_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
55 static int str7x_protect_check(struct flash_bank_s
*bank
);
56 static int str7x_info(struct flash_bank_s
*bank
, char *buf
, int buf_size
);
58 static int str7x_handle_disable_jtag_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
60 flash_driver_t str7x_flash
=
63 .register_commands
= str7x_register_commands
,
64 .flash_bank_command
= str7x_flash_bank_command
,
66 .protect
= str7x_protect
,
69 .auto_probe
= str7x_probe
,
70 .erase_check
= default_flash_blank_check
,
71 .protect_check
= str7x_protect_check
,
75 static int str7x_register_commands(struct command_context_s
*cmd_ctx
)
77 command_t
*str7x_cmd
= register_command(cmd_ctx
, NULL
, "str7x", NULL
, COMMAND_ANY
, NULL
);
79 register_command(cmd_ctx
, str7x_cmd
, "disable_jtag", str7x_handle_disable_jtag_command
, COMMAND_EXEC
,
80 "disable jtag access");
85 static int str7x_get_flash_adr(struct flash_bank_s
*bank
, uint32_t reg
)
87 str7x_flash_bank_t
*str7x_info
= bank
->driver_priv
;
88 return (str7x_info
->register_base
| reg
);
91 static int str7x_build_block_list(struct flash_bank_s
*bank
)
93 str7x_flash_bank_t
*str7x_info
= bank
->driver_priv
;
97 int b0_sectors
= 0, b1_sectors
= 0;
114 LOG_ERROR("BUG: unknown bank->size encountered");
118 num_sectors
= b0_sectors
+ b1_sectors
;
120 bank
->num_sectors
= num_sectors
;
121 bank
->sectors
= malloc(sizeof(flash_sector_t
) * num_sectors
);
122 str7x_info
->sector_bits
= malloc(sizeof(uint32_t) * num_sectors
);
126 for (i
= 0; i
< b0_sectors
; i
++)
128 bank
->sectors
[num_sectors
].offset
= mem_layout_str7bank0
[i
].sector_start
;
129 bank
->sectors
[num_sectors
].size
= mem_layout_str7bank0
[i
].sector_size
;
130 bank
->sectors
[num_sectors
].is_erased
= -1;
131 bank
->sectors
[num_sectors
].is_protected
= 1;
132 str7x_info
->sector_bits
[num_sectors
++] = mem_layout_str7bank0
[i
].sector_bit
;
135 for (i
= 0; i
< b1_sectors
; i
++)
137 bank
->sectors
[num_sectors
].offset
= mem_layout_str7bank1
[i
].sector_start
;
138 bank
->sectors
[num_sectors
].size
= mem_layout_str7bank1
[i
].sector_size
;
139 bank
->sectors
[num_sectors
].is_erased
= -1;
140 bank
->sectors
[num_sectors
].is_protected
= 1;
141 str7x_info
->sector_bits
[num_sectors
++] = mem_layout_str7bank1
[i
].sector_bit
;
147 /* flash bank str7x <base> <size> 0 0 <target#> <str71_variant>
149 static int str7x_flash_bank_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
, struct flash_bank_s
*bank
)
151 str7x_flash_bank_t
*str7x_info
;
155 LOG_WARNING("incomplete flash_bank str7x configuration");
156 return ERROR_FLASH_BANK_INVALID
;
159 str7x_info
= malloc(sizeof(str7x_flash_bank_t
));
160 bank
->driver_priv
= str7x_info
;
162 /* set default bits for str71x flash */
163 str7x_info
->busy_bits
= (FLASH_LOCK
| FLASH_BSYA1
| FLASH_BSYA0
);
164 str7x_info
->disable_bit
= (1 << 1);
166 if (strcmp(args
[6], "STR71x") == 0)
168 str7x_info
->register_base
= 0x40100000;
170 else if (strcmp(args
[6], "STR73x") == 0)
172 str7x_info
->register_base
= 0x80100000;
173 str7x_info
->busy_bits
= (FLASH_LOCK
| FLASH_BSYA0
);
175 else if (strcmp(args
[6], "STR75x") == 0)
177 str7x_info
->register_base
= 0x20100000;
178 str7x_info
->disable_bit
= (1 << 0);
182 LOG_ERROR("unknown STR7x variant: '%s'", args
[6]);
184 return ERROR_FLASH_BANK_INVALID
;
187 str7x_build_block_list(bank
);
189 str7x_info
->write_algorithm
= NULL
;
194 static uint32_t str7x_status(struct flash_bank_s
*bank
)
196 target_t
*target
= bank
->target
;
199 target_read_u32(target
, str7x_get_flash_adr(bank
, FLASH_CR0
), &retval
);
204 static uint32_t str7x_result(struct flash_bank_s
*bank
)
206 target_t
*target
= bank
->target
;
209 target_read_u32(target
, str7x_get_flash_adr(bank
, FLASH_ER
), &retval
);
214 static int str7x_protect_check(struct flash_bank_s
*bank
)
216 str7x_flash_bank_t
*str7x_info
= bank
->driver_priv
;
217 target_t
*target
= bank
->target
;
222 if (bank
->target
->state
!= TARGET_HALTED
)
224 LOG_ERROR("Target not halted");
225 return ERROR_TARGET_NOT_HALTED
;
228 target_read_u32(target
, str7x_get_flash_adr(bank
, FLASH_NVWPAR
), &retval
);
230 for (i
= 0; i
< bank
->num_sectors
; i
++)
232 if (retval
& str7x_info
->sector_bits
[i
])
233 bank
->sectors
[i
].is_protected
= 0;
235 bank
->sectors
[i
].is_protected
= 1;
241 static int str7x_erase(struct flash_bank_s
*bank
, int first
, int last
)
243 str7x_flash_bank_t
*str7x_info
= bank
->driver_priv
;
244 target_t
*target
= bank
->target
;
249 uint32_t sectors
= 0;
251 if (bank
->target
->state
!= TARGET_HALTED
)
253 LOG_ERROR("Target not halted");
254 return ERROR_TARGET_NOT_HALTED
;
257 for (i
= first
; i
<= last
; i
++)
259 sectors
|= str7x_info
->sector_bits
[i
];
262 LOG_DEBUG("sectors: 0x%" PRIx32
"", sectors
);
264 /* clear FLASH_ER register */
265 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_ER
), 0x0);
268 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_CR0
), cmd
);
271 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_CR1
), cmd
);
273 cmd
= FLASH_SER
| FLASH_WMS
;
274 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_CR0
), cmd
);
276 while (((retval
= str7x_status(bank
)) & str7x_info
->busy_bits
)) {
280 retval
= str7x_result(bank
);
284 LOG_ERROR("error erasing flash bank, FLASH_ER: 0x%" PRIx32
"", retval
);
285 return ERROR_FLASH_OPERATION_FAILED
;
288 for (i
= first
; i
<= last
; i
++)
289 bank
->sectors
[i
].is_erased
= 1;
294 static int str7x_protect(struct flash_bank_s
*bank
, int set
, int first
, int last
)
296 str7x_flash_bank_t
*str7x_info
= bank
->driver_priv
;
297 target_t
*target
= bank
->target
;
301 uint32_t protect_blocks
;
303 if (bank
->target
->state
!= TARGET_HALTED
)
305 LOG_ERROR("Target not halted");
306 return ERROR_TARGET_NOT_HALTED
;
309 protect_blocks
= 0xFFFFFFFF;
313 for (i
= first
; i
<= last
; i
++)
314 protect_blocks
&= ~(str7x_info
->sector_bits
[i
]);
317 /* clear FLASH_ER register */
318 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_ER
), 0x0);
321 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_CR0
), cmd
);
323 cmd
= str7x_get_flash_adr(bank
, FLASH_NVWPAR
);
324 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_AR
), cmd
);
326 cmd
= protect_blocks
;
327 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_DR0
), cmd
);
329 cmd
= FLASH_SPR
| FLASH_WMS
;
330 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_CR0
), cmd
);
332 while (((retval
= str7x_status(bank
)) & str7x_info
->busy_bits
)) {
336 retval
= str7x_result(bank
);
338 LOG_DEBUG("retval: 0x%8.8" PRIx32
"", retval
);
340 if (retval
& FLASH_ERER
)
341 return ERROR_FLASH_SECTOR_NOT_ERASED
;
342 else if (retval
& FLASH_WPF
)
343 return ERROR_FLASH_OPERATION_FAILED
;
348 static int str7x_write_block(struct flash_bank_s
*bank
, uint8_t *buffer
, uint32_t offset
, uint32_t count
)
350 str7x_flash_bank_t
*str7x_info
= bank
->driver_priv
;
351 target_t
*target
= bank
->target
;
352 uint32_t buffer_size
= 8192;
353 working_area_t
*source
;
354 uint32_t address
= bank
->base
+ offset
;
355 reg_param_t reg_params
[6];
356 armv4_5_algorithm_t armv4_5_info
;
357 int retval
= ERROR_OK
;
359 uint32_t str7x_flash_write_code
[] = {
361 0xe3a04201, /* mov r4, #0x10000000 */
362 0xe5824000, /* str r4, [r2, #0x0] */
363 0xe5821010, /* str r1, [r2, #0x10] */
364 0xe4904004, /* ldr r4, [r0], #4 */
365 0xe5824008, /* str r4, [r2, #0x8] */
366 0xe4904004, /* ldr r4, [r0], #4 */
367 0xe582400c, /* str r4, [r2, #0xc] */
368 0xe3a04209, /* mov r4, #0x90000000 */
369 0xe5824000, /* str r4, [r2, #0x0] */
371 0xe5924000, /* ldr r4, [r2, #0x0] */
372 0xe1140005, /* tst r4, r5 */
373 0x1afffffc, /* bne busy */
374 0xe5924014, /* ldr r4, [r2, #0x14] */
375 0xe31400ff, /* tst r4, #0xff */
376 0x03140c01, /* tsteq r4, #0x100 */
377 0x1a000002, /* bne exit */
378 0xe2811008, /* add r1, r1, #0x8 */
379 0xe2533001, /* subs r3, r3, #1 */
380 0x1affffec, /* bne write */
382 0xeafffffe, /* b exit */
385 /* flash write code */
386 if (target_alloc_working_area(target
, 4 * 20, &str7x_info
->write_algorithm
) != ERROR_OK
)
388 LOG_WARNING("no working area available, can't do block memory writes");
389 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
392 target_write_buffer(target
, str7x_info
->write_algorithm
->address
, 20 * 4, (uint8_t*)str7x_flash_write_code
);
395 while (target_alloc_working_area(target
, buffer_size
, &source
) != ERROR_OK
)
398 if (buffer_size
<= 256)
400 /* if we already allocated the writing code, but failed to get a buffer, free the algorithm */
401 if (str7x_info
->write_algorithm
)
402 target_free_working_area(target
, str7x_info
->write_algorithm
);
404 LOG_WARNING("no large enough working area available, can't do block memory writes");
405 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
409 armv4_5_info
.common_magic
= ARMV4_5_COMMON_MAGIC
;
410 armv4_5_info
.core_mode
= ARMV4_5_MODE_SVC
;
411 armv4_5_info
.core_state
= ARMV4_5_STATE_ARM
;
413 init_reg_param(®_params
[0], "r0", 32, PARAM_OUT
);
414 init_reg_param(®_params
[1], "r1", 32, PARAM_OUT
);
415 init_reg_param(®_params
[2], "r2", 32, PARAM_OUT
);
416 init_reg_param(®_params
[3], "r3", 32, PARAM_OUT
);
417 init_reg_param(®_params
[4], "r4", 32, PARAM_IN
);
418 init_reg_param(®_params
[5], "r5", 32, PARAM_OUT
);
422 uint32_t thisrun_count
= (count
> (buffer_size
/ 8)) ? (buffer_size
/ 8) : count
;
424 target_write_buffer(target
, source
->address
, thisrun_count
* 8, buffer
);
426 buf_set_u32(reg_params
[0].value
, 0, 32, source
->address
);
427 buf_set_u32(reg_params
[1].value
, 0, 32, address
);
428 buf_set_u32(reg_params
[2].value
, 0, 32, str7x_get_flash_adr(bank
, FLASH_CR0
));
429 buf_set_u32(reg_params
[3].value
, 0, 32, thisrun_count
);
430 buf_set_u32(reg_params
[5].value
, 0, 32, str7x_info
->busy_bits
);
432 if ((retval
= target_run_algorithm(target
, 0, NULL
, 6, reg_params
, str7x_info
->write_algorithm
->address
, str7x_info
->write_algorithm
->address
+ (19 * 4), 10000, &armv4_5_info
)) != ERROR_OK
)
434 LOG_ERROR("error executing str7x flash write algorithm");
435 retval
= ERROR_FLASH_OPERATION_FAILED
;
439 if (buf_get_u32(reg_params
[4].value
, 0, 32) != 0x00)
441 retval
= ERROR_FLASH_OPERATION_FAILED
;
445 buffer
+= thisrun_count
* 8;
446 address
+= thisrun_count
* 8;
447 count
-= thisrun_count
;
450 target_free_working_area(target
, source
);
451 target_free_working_area(target
, str7x_info
->write_algorithm
);
453 destroy_reg_param(®_params
[0]);
454 destroy_reg_param(®_params
[1]);
455 destroy_reg_param(®_params
[2]);
456 destroy_reg_param(®_params
[3]);
457 destroy_reg_param(®_params
[4]);
458 destroy_reg_param(®_params
[5]);
463 static int str7x_write(struct flash_bank_s
*bank
, uint8_t *buffer
, uint32_t offset
, uint32_t count
)
465 target_t
*target
= bank
->target
;
466 str7x_flash_bank_t
*str7x_info
= bank
->driver_priv
;
467 uint32_t dwords_remaining
= (count
/ 8);
468 uint32_t bytes_remaining
= (count
& 0x00000007);
469 uint32_t address
= bank
->base
+ offset
;
470 uint32_t bytes_written
= 0;
473 uint32_t check_address
= offset
;
476 if (bank
->target
->state
!= TARGET_HALTED
)
478 LOG_ERROR("Target not halted");
479 return ERROR_TARGET_NOT_HALTED
;
484 LOG_WARNING("offset 0x%" PRIx32
" breaks required 8-byte alignment", offset
);
485 return ERROR_FLASH_DST_BREAKS_ALIGNMENT
;
488 for (i
= 0; i
< bank
->num_sectors
; i
++)
490 uint32_t sec_start
= bank
->sectors
[i
].offset
;
491 uint32_t sec_end
= sec_start
+ bank
->sectors
[i
].size
;
493 /* check if destination falls within the current sector */
494 if ((check_address
>= sec_start
) && (check_address
< sec_end
))
496 /* check if destination ends in the current sector */
497 if (offset
+ count
< sec_end
)
498 check_address
= offset
+ count
;
500 check_address
= sec_end
;
504 if (check_address
!= offset
+ count
)
505 return ERROR_FLASH_DST_OUT_OF_BANK
;
507 /* clear FLASH_ER register */
508 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_ER
), 0x0);
510 /* multiple dwords (8-byte) to be programmed? */
511 if (dwords_remaining
> 0)
513 /* try using a block write */
514 if ((retval
= str7x_write_block(bank
, buffer
, offset
, dwords_remaining
)) != ERROR_OK
)
516 if (retval
== ERROR_TARGET_RESOURCE_NOT_AVAILABLE
)
518 /* if block write failed (no sufficient working area),
519 * we use normal (slow) single dword accesses */
520 LOG_WARNING("couldn't use block writes, falling back to single memory accesses");
522 else if (retval
== ERROR_FLASH_OPERATION_FAILED
)
524 /* if an error occured, we examine the reason, and quit */
525 retval
= str7x_result(bank
);
527 LOG_ERROR("flash writing failed with error code: 0x%x", retval
);
528 return ERROR_FLASH_OPERATION_FAILED
;
533 buffer
+= dwords_remaining
* 8;
534 address
+= dwords_remaining
* 8;
535 dwords_remaining
= 0;
539 while (dwords_remaining
> 0)
543 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_CR0
), cmd
);
546 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_AR
), address
);
549 target_write_memory(target
, str7x_get_flash_adr(bank
, FLASH_DR0
), 4, 1, buffer
+ bytes_written
);
553 target_write_memory(target
, str7x_get_flash_adr(bank
, FLASH_DR1
), 4, 1, buffer
+ bytes_written
);
556 /* start programming cycle */
557 cmd
= FLASH_DWPG
| FLASH_WMS
;
558 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_CR0
), cmd
);
560 while (((retval
= str7x_status(bank
)) & str7x_info
->busy_bits
))
565 retval
= str7x_result(bank
);
567 if (retval
& FLASH_PGER
)
568 return ERROR_FLASH_OPERATION_FAILED
;
569 else if (retval
& FLASH_WPF
)
570 return ERROR_FLASH_OPERATION_FAILED
;
578 uint8_t last_dword
[8] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff};
581 while (bytes_remaining
> 0)
583 last_dword
[i
++] = *(buffer
+ bytes_written
);
590 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_CR0
), cmd
);
593 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_AR
), address
);
596 target_write_memory(target
, str7x_get_flash_adr(bank
, FLASH_DR0
), 4, 1, last_dword
);
600 target_write_memory(target
, str7x_get_flash_adr(bank
, FLASH_DR1
), 4, 1, last_dword
+ 4);
603 /* start programming cycle */
604 cmd
= FLASH_DWPG
| FLASH_WMS
;
605 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_CR0
), cmd
);
607 while (((retval
= str7x_status(bank
)) & str7x_info
->busy_bits
))
612 retval
= str7x_result(bank
);
614 if (retval
& FLASH_PGER
)
615 return ERROR_FLASH_OPERATION_FAILED
;
616 else if (retval
& FLASH_WPF
)
617 return ERROR_FLASH_OPERATION_FAILED
;
623 static int str7x_probe(struct flash_bank_s
*bank
)
629 static int str7x_handle_part_id_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
635 static int str7x_info(struct flash_bank_s
*bank
, char *buf
, int buf_size
)
637 snprintf(buf
, buf_size
, "str7x flash driver info");
641 static int str7x_handle_disable_jtag_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
644 target_t
*target
= NULL
;
645 str7x_flash_bank_t
*str7x_info
= NULL
;
649 uint16_t ProtectionLevel
= 0;
650 uint16_t ProtectionRegs
;
654 command_print(cmd_ctx
, "str7x disable_jtag <bank>");
658 bank
= get_flash_bank_by_num(strtoul(args
[0], NULL
, 0));
661 command_print(cmd_ctx
, "str7x disable_jtag <bank> ok");
665 str7x_info
= bank
->driver_priv
;
667 target
= bank
->target
;
669 if (target
->state
!= TARGET_HALTED
)
671 LOG_ERROR("Target not halted");
672 return ERROR_TARGET_NOT_HALTED
;
675 /* first we get protection status */
676 target_read_u32(target
, str7x_get_flash_adr(bank
, FLASH_NVAPR0
), &retval
);
678 if (!(retval
& str7x_info
->disable_bit
))
683 target_read_u32(target
, str7x_get_flash_adr(bank
, FLASH_NVAPR1
), &retval
);
684 ProtectionRegs
= ~(retval
>> 16);
686 while (((ProtectionRegs
) != 0) && (ProtectionLevel
< 16))
688 ProtectionRegs
>>= 1;
692 if (ProtectionLevel
== 0)
694 flash_cmd
= FLASH_SPR
;
695 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_CR0
), flash_cmd
);
696 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_AR
), 0x4010DFB8);
697 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_DR0
), 0xFFFFFFFD);
698 flash_cmd
= FLASH_SPR
| FLASH_WMS
;
699 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_CR0
), flash_cmd
);
703 flash_cmd
= FLASH_SPR
;
704 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_CR0
), flash_cmd
);
705 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_AR
), 0x4010DFBC);
706 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_DR0
), ~(1 << (15 + ProtectionLevel
)));
707 flash_cmd
= FLASH_SPR
| FLASH_WMS
;
708 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_CR0
), flash_cmd
);