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 <target/arm.h>
30 #include <helper/binarybuffer.h>
31 #include <target/algorithm.h>
34 static struct str7x_mem_layout mem_layout_str7bank0
[] = {
35 {0x00000000, 0x02000, 0x01},
36 {0x00002000, 0x02000, 0x02},
37 {0x00004000, 0x02000, 0x04},
38 {0x00006000, 0x02000, 0x08},
39 {0x00008000, 0x08000, 0x10},
40 {0x00010000, 0x10000, 0x20},
41 {0x00020000, 0x10000, 0x40},
42 {0x00030000, 0x10000, 0x80}
45 static struct str7x_mem_layout mem_layout_str7bank1
[] = {
46 {0x00000000, 0x02000, 0x10000},
47 {0x00002000, 0x02000, 0x20000}
50 static int str7x_get_flash_adr(struct flash_bank
*bank
, uint32_t reg
)
52 struct str7x_flash_bank
*str7x_info
= bank
->driver_priv
;
53 return (str7x_info
->register_base
| reg
);
56 static int str7x_build_block_list(struct flash_bank
*bank
)
58 struct str7x_flash_bank
*str7x_info
= bank
->driver_priv
;
62 int b0_sectors
= 0, b1_sectors
= 0;
79 LOG_ERROR("BUG: unknown bank->size encountered");
83 num_sectors
= b0_sectors
+ b1_sectors
;
85 bank
->num_sectors
= num_sectors
;
86 bank
->sectors
= malloc(sizeof(struct flash_sector
) * num_sectors
);
87 str7x_info
->sector_bits
= malloc(sizeof(uint32_t) * num_sectors
);
91 for (i
= 0; i
< b0_sectors
; i
++)
93 bank
->sectors
[num_sectors
].offset
= mem_layout_str7bank0
[i
].sector_start
;
94 bank
->sectors
[num_sectors
].size
= mem_layout_str7bank0
[i
].sector_size
;
95 bank
->sectors
[num_sectors
].is_erased
= -1;
96 /* the reset_init handler marks all the sectors unprotected,
97 * matching hardware after reset; keep the driver in sync
99 bank
->sectors
[num_sectors
].is_protected
= 0;
100 str7x_info
->sector_bits
[num_sectors
++] = mem_layout_str7bank0
[i
].sector_bit
;
103 for (i
= 0; i
< b1_sectors
; i
++)
105 bank
->sectors
[num_sectors
].offset
= mem_layout_str7bank1
[i
].sector_start
;
106 bank
->sectors
[num_sectors
].size
= mem_layout_str7bank1
[i
].sector_size
;
107 bank
->sectors
[num_sectors
].is_erased
= -1;
108 /* the reset_init handler marks all the sectors unprotected,
109 * matching hardware after reset; keep the driver in sync
111 bank
->sectors
[num_sectors
].is_protected
= 0;
112 str7x_info
->sector_bits
[num_sectors
++] = mem_layout_str7bank1
[i
].sector_bit
;
118 /* flash bank str7x <base> <size> 0 0 <target#> <str71_variant>
120 FLASH_BANK_COMMAND_HANDLER(str7x_flash_bank_command
)
122 struct str7x_flash_bank
*str7x_info
;
126 LOG_WARNING("incomplete flash_bank str7x configuration");
127 return ERROR_FLASH_BANK_INVALID
;
130 str7x_info
= malloc(sizeof(struct str7x_flash_bank
));
131 bank
->driver_priv
= str7x_info
;
133 /* set default bits for str71x flash */
134 str7x_info
->busy_bits
= (FLASH_LOCK
| FLASH_BSYA1
| FLASH_BSYA0
);
135 str7x_info
->disable_bit
= (1 << 1);
137 if (strcmp(CMD_ARGV
[6], "STR71x") == 0)
139 str7x_info
->register_base
= 0x40100000;
141 else if (strcmp(CMD_ARGV
[6], "STR73x") == 0)
143 str7x_info
->register_base
= 0x80100000;
144 str7x_info
->busy_bits
= (FLASH_LOCK
| FLASH_BSYA0
);
146 else if (strcmp(CMD_ARGV
[6], "STR75x") == 0)
148 str7x_info
->register_base
= 0x20100000;
149 str7x_info
->disable_bit
= (1 << 0);
153 LOG_ERROR("unknown STR7x variant: '%s'", CMD_ARGV
[6]);
155 return ERROR_FLASH_BANK_INVALID
;
158 str7x_build_block_list(bank
);
160 str7x_info
->write_algorithm
= NULL
;
165 static uint32_t str7x_status(struct flash_bank
*bank
)
167 struct target
*target
= bank
->target
;
170 target_read_u32(target
, str7x_get_flash_adr(bank
, FLASH_CR0
), &retval
);
175 static uint32_t str7x_result(struct flash_bank
*bank
)
177 struct target
*target
= bank
->target
;
180 target_read_u32(target
, str7x_get_flash_adr(bank
, FLASH_ER
), &retval
);
185 static int str7x_protect_check(struct flash_bank
*bank
)
187 struct str7x_flash_bank
*str7x_info
= bank
->driver_priv
;
188 struct target
*target
= bank
->target
;
193 if (bank
->target
->state
!= TARGET_HALTED
)
195 LOG_ERROR("Target not halted");
196 return ERROR_TARGET_NOT_HALTED
;
199 target_read_u32(target
, str7x_get_flash_adr(bank
, FLASH_NVWPAR
), &retval
);
201 for (i
= 0; i
< bank
->num_sectors
; i
++)
203 if (retval
& str7x_info
->sector_bits
[i
])
204 bank
->sectors
[i
].is_protected
= 0;
206 bank
->sectors
[i
].is_protected
= 1;
212 static int str7x_erase(struct flash_bank
*bank
, int first
, int last
)
214 struct str7x_flash_bank
*str7x_info
= bank
->driver_priv
;
215 struct target
*target
= bank
->target
;
220 uint32_t sectors
= 0;
222 if (bank
->target
->state
!= TARGET_HALTED
)
224 LOG_ERROR("Target not halted");
225 return ERROR_TARGET_NOT_HALTED
;
228 for (i
= first
; i
<= last
; i
++)
230 sectors
|= str7x_info
->sector_bits
[i
];
233 LOG_DEBUG("sectors: 0x%" PRIx32
"", sectors
);
235 /* clear FLASH_ER register */
236 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_ER
), 0x0);
239 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_CR0
), cmd
);
242 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_CR1
), cmd
);
244 cmd
= FLASH_SER
| FLASH_WMS
;
245 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_CR0
), cmd
);
247 while (((retval
= str7x_status(bank
)) & str7x_info
->busy_bits
)) {
251 retval
= str7x_result(bank
);
255 LOG_ERROR("error erasing flash bank, FLASH_ER: 0x%" PRIx32
"", retval
);
256 return ERROR_FLASH_OPERATION_FAILED
;
259 for (i
= first
; i
<= last
; i
++)
260 bank
->sectors
[i
].is_erased
= 1;
265 static int str7x_protect(struct flash_bank
*bank
, int set
, int first
, int last
)
267 struct str7x_flash_bank
*str7x_info
= bank
->driver_priv
;
268 struct target
*target
= bank
->target
;
272 uint32_t protect_blocks
;
274 if (bank
->target
->state
!= TARGET_HALTED
)
276 LOG_ERROR("Target not halted");
277 return ERROR_TARGET_NOT_HALTED
;
280 protect_blocks
= 0xFFFFFFFF;
284 for (i
= first
; i
<= last
; i
++)
285 protect_blocks
&= ~(str7x_info
->sector_bits
[i
]);
288 /* clear FLASH_ER register */
289 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_ER
), 0x0);
292 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_CR0
), cmd
);
294 cmd
= str7x_get_flash_adr(bank
, FLASH_NVWPAR
);
295 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_AR
), cmd
);
297 cmd
= protect_blocks
;
298 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_DR0
), cmd
);
300 cmd
= FLASH_SPR
| FLASH_WMS
;
301 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_CR0
), cmd
);
303 while (((retval
= str7x_status(bank
)) & str7x_info
->busy_bits
)) {
307 retval
= str7x_result(bank
);
309 LOG_DEBUG("retval: 0x%8.8" PRIx32
"", retval
);
311 if (retval
& FLASH_ERER
)
312 return ERROR_FLASH_SECTOR_NOT_ERASED
;
313 else if (retval
& FLASH_WPF
)
314 return ERROR_FLASH_OPERATION_FAILED
;
319 static int str7x_write_block(struct flash_bank
*bank
, uint8_t *buffer
,
320 uint32_t offset
, uint32_t count
)
322 struct str7x_flash_bank
*str7x_info
= bank
->driver_priv
;
323 struct target
*target
= bank
->target
;
324 uint32_t buffer_size
= 32768;
325 struct working_area
*source
;
326 uint32_t address
= bank
->base
+ offset
;
327 struct reg_param reg_params
[6];
328 struct arm_algorithm armv4_5_info
;
329 int retval
= ERROR_OK
;
331 static const uint32_t str7x_flash_write_code
[] = {
333 0xe3a04201, /* mov r4, #0x10000000 */
334 0xe5824000, /* str r4, [r2, #0x0] */
335 0xe5821010, /* str r1, [r2, #0x10] */
336 0xe4904004, /* ldr r4, [r0], #4 */
337 0xe5824008, /* str r4, [r2, #0x8] */
338 0xe4904004, /* ldr r4, [r0], #4 */
339 0xe582400c, /* str r4, [r2, #0xc] */
340 0xe3a04209, /* mov r4, #0x90000000 */
341 0xe5824000, /* str r4, [r2, #0x0] */
343 0xe5924000, /* ldr r4, [r2, #0x0] */
344 0xe1140005, /* tst r4, r5 */
345 0x1afffffc, /* bne busy */
346 0xe5924014, /* ldr r4, [r2, #0x14] */
347 0xe31400ff, /* tst r4, #0xff */
348 0x03140c01, /* tsteq r4, #0x100 */
349 0x1a000002, /* bne exit */
350 0xe2811008, /* add r1, r1, #0x8 */
351 0xe2533001, /* subs r3, r3, #1 */
352 0x1affffec, /* bne write */
354 0xeafffffe, /* b exit */
357 /* flash write code */
358 if (target_alloc_working_area_try(target
, sizeof(str7x_flash_write_code
),
359 &str7x_info
->write_algorithm
) != ERROR_OK
)
361 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
364 target_write_buffer(target
, str7x_info
->write_algorithm
->address
,
365 sizeof(str7x_flash_write_code
),
366 (uint8_t*)str7x_flash_write_code
);
369 while (target_alloc_working_area_try(target
, buffer_size
, &source
) != ERROR_OK
)
372 if (buffer_size
<= 256)
374 /* if we already allocated the writing code, but failed to get a
375 * buffer, free the algorithm */
376 if (str7x_info
->write_algorithm
)
377 target_free_working_area(target
, str7x_info
->write_algorithm
);
379 LOG_WARNING("no large enough working area available, can't do block memory writes");
380 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
384 armv4_5_info
.common_magic
= ARM_COMMON_MAGIC
;
385 armv4_5_info
.core_mode
= ARM_MODE_SVC
;
386 armv4_5_info
.core_state
= ARM_STATE_ARM
;
388 init_reg_param(®_params
[0], "r0", 32, PARAM_OUT
);
389 init_reg_param(®_params
[1], "r1", 32, PARAM_OUT
);
390 init_reg_param(®_params
[2], "r2", 32, PARAM_OUT
);
391 init_reg_param(®_params
[3], "r3", 32, PARAM_OUT
);
392 init_reg_param(®_params
[4], "r4", 32, PARAM_IN
);
393 init_reg_param(®_params
[5], "r5", 32, PARAM_OUT
);
397 uint32_t thisrun_count
= (count
> (buffer_size
/ 8)) ? (buffer_size
/ 8) : count
;
399 target_write_buffer(target
, source
->address
, thisrun_count
* 8, buffer
);
401 buf_set_u32(reg_params
[0].value
, 0, 32, source
->address
);
402 buf_set_u32(reg_params
[1].value
, 0, 32, address
);
403 buf_set_u32(reg_params
[2].value
, 0, 32, str7x_get_flash_adr(bank
, FLASH_CR0
));
404 buf_set_u32(reg_params
[3].value
, 0, 32, thisrun_count
);
405 buf_set_u32(reg_params
[5].value
, 0, 32, str7x_info
->busy_bits
);
407 if ((retval
= target_run_algorithm(target
, 0, NULL
, 6, reg_params
,
408 str7x_info
->write_algorithm
->address
,
409 str7x_info
->write_algorithm
->address
+ (sizeof(str7x_flash_write_code
) - 4),
410 10000, &armv4_5_info
)) != ERROR_OK
)
412 LOG_ERROR("error executing str7x flash write algorithm");
413 retval
= ERROR_FLASH_OPERATION_FAILED
;
417 if (buf_get_u32(reg_params
[4].value
, 0, 32) != 0x00)
419 retval
= ERROR_FLASH_OPERATION_FAILED
;
423 buffer
+= thisrun_count
* 8;
424 address
+= thisrun_count
* 8;
425 count
-= thisrun_count
;
428 target_free_working_area(target
, source
);
429 target_free_working_area(target
, str7x_info
->write_algorithm
);
431 destroy_reg_param(®_params
[0]);
432 destroy_reg_param(®_params
[1]);
433 destroy_reg_param(®_params
[2]);
434 destroy_reg_param(®_params
[3]);
435 destroy_reg_param(®_params
[4]);
436 destroy_reg_param(®_params
[5]);
441 static int str7x_write(struct flash_bank
*bank
, uint8_t *buffer
,
442 uint32_t offset
, uint32_t count
)
444 struct target
*target
= bank
->target
;
445 struct str7x_flash_bank
*str7x_info
= bank
->driver_priv
;
446 uint32_t dwords_remaining
= (count
/ 8);
447 uint32_t bytes_remaining
= (count
& 0x00000007);
448 uint32_t address
= bank
->base
+ offset
;
449 uint32_t bytes_written
= 0;
452 uint32_t check_address
= offset
;
455 if (bank
->target
->state
!= TARGET_HALTED
)
457 LOG_ERROR("Target not halted");
458 return ERROR_TARGET_NOT_HALTED
;
463 LOG_WARNING("offset 0x%" PRIx32
" breaks required 8-byte alignment", offset
);
464 return ERROR_FLASH_DST_BREAKS_ALIGNMENT
;
467 for (i
= 0; i
< bank
->num_sectors
; i
++)
469 uint32_t sec_start
= bank
->sectors
[i
].offset
;
470 uint32_t sec_end
= sec_start
+ bank
->sectors
[i
].size
;
472 /* check if destination falls within the current sector */
473 if ((check_address
>= sec_start
) && (check_address
< sec_end
))
475 /* check if destination ends in the current sector */
476 if (offset
+ count
< sec_end
)
477 check_address
= offset
+ count
;
479 check_address
= sec_end
;
483 if (check_address
!= offset
+ count
)
484 return ERROR_FLASH_DST_OUT_OF_BANK
;
486 /* clear FLASH_ER register */
487 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_ER
), 0x0);
489 /* multiple dwords (8-byte) to be programmed? */
490 if (dwords_remaining
> 0)
492 /* try using a block write */
493 if ((retval
= str7x_write_block(bank
, buffer
, offset
,
494 dwords_remaining
)) != ERROR_OK
)
496 if (retval
== ERROR_TARGET_RESOURCE_NOT_AVAILABLE
)
498 /* if block write failed (no sufficient working area),
499 * we use normal (slow) single dword accesses */
500 LOG_WARNING("couldn't use block writes, falling back to single memory accesses");
502 else if (retval
== ERROR_FLASH_OPERATION_FAILED
)
504 /* if an error occured, we examine the reason, and quit */
505 retval
= str7x_result(bank
);
507 LOG_ERROR("flash writing failed with error code: 0x%x", retval
);
508 return ERROR_FLASH_OPERATION_FAILED
;
517 buffer
+= dwords_remaining
* 8;
518 address
+= dwords_remaining
* 8;
519 dwords_remaining
= 0;
523 while (dwords_remaining
> 0)
527 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_CR0
), cmd
);
530 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_AR
), address
);
533 target_write_memory(target
, str7x_get_flash_adr(bank
, FLASH_DR0
),
534 4, 1, buffer
+ bytes_written
);
538 target_write_memory(target
, str7x_get_flash_adr(bank
, FLASH_DR1
),
539 4, 1, buffer
+ bytes_written
);
542 /* start programming cycle */
543 cmd
= FLASH_DWPG
| FLASH_WMS
;
544 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_CR0
), cmd
);
546 while (((retval
= str7x_status(bank
)) & str7x_info
->busy_bits
))
551 retval
= str7x_result(bank
);
553 if (retval
& FLASH_PGER
)
554 return ERROR_FLASH_OPERATION_FAILED
;
555 else if (retval
& FLASH_WPF
)
556 return ERROR_FLASH_OPERATION_FAILED
;
564 uint8_t last_dword
[8] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff};
567 while (bytes_remaining
> 0)
569 last_dword
[i
++] = *(buffer
+ bytes_written
);
576 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_CR0
), cmd
);
579 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_AR
), address
);
582 target_write_memory(target
, str7x_get_flash_adr(bank
, FLASH_DR0
),
587 target_write_memory(target
, str7x_get_flash_adr(bank
, FLASH_DR1
),
588 4, 1, last_dword
+ 4);
591 /* start programming cycle */
592 cmd
= FLASH_DWPG
| FLASH_WMS
;
593 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_CR0
), cmd
);
595 while (((retval
= str7x_status(bank
)) & str7x_info
->busy_bits
))
600 retval
= str7x_result(bank
);
602 if (retval
& FLASH_PGER
)
603 return ERROR_FLASH_OPERATION_FAILED
;
604 else if (retval
& FLASH_WPF
)
605 return ERROR_FLASH_OPERATION_FAILED
;
611 static int str7x_probe(struct flash_bank
*bank
)
617 COMMAND_HANDLER(str7x_handle_part_id_command
)
623 static int str7x_info(struct flash_bank
*bank
, char *buf
, int buf_size
)
625 snprintf(buf
, buf_size
, "str7x flash driver info");
626 /* STR7x flash doesn't support sector protection interrogation.
627 * FLASH_NVWPAR acts as a write only register; its read value
628 * doesn't reflect the actual protection state of the sectors.
630 LOG_WARNING("STR7x flash lock information might not be correct "
631 "due to hardware limitations.");
635 COMMAND_HANDLER(str7x_handle_disable_jtag_command
)
637 struct target
*target
= NULL
;
638 struct str7x_flash_bank
*str7x_info
= NULL
;
641 uint16_t ProtectionLevel
= 0;
642 uint16_t ProtectionRegs
;
646 command_print(CMD_CTX
, "str7x disable_jtag <bank>");
650 struct flash_bank
*bank
;
651 int retval
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &bank
);
652 if (ERROR_OK
!= retval
)
655 str7x_info
= bank
->driver_priv
;
657 target
= bank
->target
;
659 if (target
->state
!= TARGET_HALTED
)
661 LOG_ERROR("Target not halted");
662 return ERROR_TARGET_NOT_HALTED
;
665 /* first we get protection status */
667 target_read_u32(target
, str7x_get_flash_adr(bank
, FLASH_NVAPR0
), ®
);
669 if (!(reg
& str7x_info
->disable_bit
))
674 target_read_u32(target
, str7x_get_flash_adr(bank
, FLASH_NVAPR1
), ®
);
675 ProtectionRegs
= ~(reg
>> 16);
677 while (((ProtectionRegs
) != 0) && (ProtectionLevel
< 16))
679 ProtectionRegs
>>= 1;
683 if (ProtectionLevel
== 0)
685 flash_cmd
= FLASH_SPR
;
686 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_CR0
), flash_cmd
);
687 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_AR
), 0x4010DFB8);
688 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_DR0
), 0xFFFFFFFD);
689 flash_cmd
= FLASH_SPR
| FLASH_WMS
;
690 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_CR0
), flash_cmd
);
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
), 0x4010DFBC);
697 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_DR0
),
698 ~(1 << (15 + ProtectionLevel
)));
699 flash_cmd
= FLASH_SPR
| FLASH_WMS
;
700 target_write_u32(target
, str7x_get_flash_adr(bank
, FLASH_CR0
), flash_cmd
);
706 static const struct command_registration str7x_exec_command_handlers
[] = {
708 .name
= "disable_jtag",
709 .handler
= str7x_handle_disable_jtag_command
,
710 .mode
= COMMAND_EXEC
,
711 .help
= "disable jtag access",
713 COMMAND_REGISTRATION_DONE
716 static const struct command_registration str7x_command_handlers
[] = {
720 .help
= "str7x flash command group",
721 .chain
= str7x_exec_command_handlers
,
723 COMMAND_REGISTRATION_DONE
726 struct flash_driver str7x_flash
= {
728 .commands
= str7x_command_handlers
,
729 .flash_bank_command
= str7x_flash_bank_command
,
730 .erase
= str7x_erase
,
731 .protect
= str7x_protect
,
732 .write
= str7x_write
,
733 .probe
= str7x_probe
,
734 .auto_probe
= str7x_probe
,
735 .erase_check
= default_flash_blank_check
,
736 .protect_check
= str7x_protect_check
,