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 * Copyright (C) 2011 by Clement Burin des Roziers *
9 * clement.burin-des-roziers@hikob.com *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
16 * This program is distributed in the hope that it will be useful, *
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
19 * GNU General Public License for more details. *
21 * You should have received a copy of the GNU General Public License *
22 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
23 ***************************************************************************/
30 #include <helper/binarybuffer.h>
31 #include <target/algorithm.h>
32 #include <target/armv7m.h>
33 #include <target/cortex_m.h>
35 /* stm32lx flash register locations */
37 #define FLASH_ACR 0x00
38 #define FLASH_PECR 0x04
39 #define FLASH_PDKEYR 0x08
40 #define FLASH_PEKEYR 0x0C
41 #define FLASH_PRGKEYR 0x10
42 #define FLASH_OPTKEYR 0x14
44 #define FLASH_OBR 0x1C
45 #define FLASH_WRPR 0x20
48 #define FLASH_ACR__LATENCY (1<<0)
49 #define FLASH_ACR__PRFTEN (1<<1)
50 #define FLASH_ACR__ACC64 (1<<2)
51 #define FLASH_ACR__SLEEP_PD (1<<3)
52 #define FLASH_ACR__RUN_PD (1<<4)
55 #define FLASH_PECR__PELOCK (1<<0)
56 #define FLASH_PECR__PRGLOCK (1<<1)
57 #define FLASH_PECR__OPTLOCK (1<<2)
58 #define FLASH_PECR__PROG (1<<3)
59 #define FLASH_PECR__DATA (1<<4)
60 #define FLASH_PECR__FTDW (1<<8)
61 #define FLASH_PECR__ERASE (1<<9)
62 #define FLASH_PECR__FPRG (1<<10)
63 #define FLASH_PECR__EOPIE (1<<16)
64 #define FLASH_PECR__ERRIE (1<<17)
65 #define FLASH_PECR__OBL_LAUNCH (1<<18)
68 #define FLASH_SR__BSY (1<<0)
69 #define FLASH_SR__EOP (1<<1)
70 #define FLASH_SR__ENDHV (1<<2)
71 #define FLASH_SR__READY (1<<3)
72 #define FLASH_SR__WRPERR (1<<8)
73 #define FLASH_SR__PGAERR (1<<9)
74 #define FLASH_SR__SIZERR (1<<10)
75 #define FLASH_SR__OPTVERR (1<<11)
78 #define PEKEY1 0x89ABCDEF
79 #define PEKEY2 0x02030405
80 #define PRGKEY1 0x8C9DAEBF
81 #define PRGKEY2 0x13141516
82 #define OPTKEY1 0xFBEAD9C8
83 #define OPTKEY2 0x24252627
86 #define DBGMCU_IDCODE 0xE0042000
87 #define DBGMCU_IDCODE_L0 0x40015800
90 #define FLASH_SECTOR_SIZE 4096
91 #define FLASH_BANK0_ADDRESS 0x08000000
94 #define OPTION_BYTES_ADDRESS 0x1FF80000
96 #define OPTION_BYTE_0_PR1 0xFFFF0000
97 #define OPTION_BYTE_0_PR0 0xFF5500AA
99 static int stm32lx_unlock_program_memory(struct flash_bank
*bank
);
100 static int stm32lx_lock_program_memory(struct flash_bank
*bank
);
101 static int stm32lx_enable_write_half_page(struct flash_bank
*bank
);
102 static int stm32lx_erase_sector(struct flash_bank
*bank
, int sector
);
103 static int stm32lx_wait_until_bsy_clear(struct flash_bank
*bank
);
104 static int stm32lx_lock(struct flash_bank
*bank
);
105 static int stm32lx_unlock(struct flash_bank
*bank
);
106 static int stm32lx_mass_erase(struct flash_bank
*bank
);
107 static int stm32lx_wait_until_bsy_clear_timeout(struct flash_bank
*bank
, int timeout
);
108 static int stm32lx_update_part_info(struct flash_bank
*bank
, uint16_t flash_size_in_kb
);
115 struct stm32lx_part_info
{
117 const char *device_str
;
118 const struct stm32lx_rev
*revs
;
120 unsigned int page_size
;
121 unsigned int pages_per_sector
;
122 uint16_t max_flash_size_kb
;
123 uint16_t first_bank_size_kb
; /* used when has_dual_banks is true */
126 uint32_t flash_base
; /* Flash controller registers location */
127 uint32_t fsize_base
; /* Location of FSIZE register */
130 struct stm32lx_flash_bank
{
133 uint32_t user_bank_size
;
136 struct stm32lx_part_info part_info
;
139 static const struct stm32lx_rev stm32_416_revs
[] = {
140 { 0x1000, "A" }, { 0x1008, "Y" }, { 0x1038, "W" }, { 0x1078, "V" },
142 static const struct stm32lx_rev stm32_417_revs
[] = {
143 { 0x1000, "A" }, { 0x1008, "Z" }, { 0x1018, "Y" }, { 0x1038, "X" }
145 static const struct stm32lx_rev stm32_425_revs
[] = {
146 { 0x1000, "A" }, { 0x2000, "B" }, { 0x2008, "Y" },
148 static const struct stm32lx_rev stm32_427_revs
[] = {
149 { 0x1000, "A" }, { 0x1018, "Y" }, { 0x1038, "X" }, { 0x10f8, "V" },
151 static const struct stm32lx_rev stm32_429_revs
[] = {
152 { 0x1000, "A" }, { 0x1018, "Z" },
154 static const struct stm32lx_rev stm32_436_revs
[] = {
155 { 0x1000, "A" }, { 0x1008, "Z" }, { 0x1018, "Y" },
157 static const struct stm32lx_rev stm32_437_revs
[] = {
160 static const struct stm32lx_rev stm32_447_revs
[] = {
161 { 0x1000, "A" }, { 0x2000, "B" }, { 0x2008, "Z" },
163 static const struct stm32lx_rev stm32_457_revs
[] = {
164 { 0x1000, "A" }, { 0x1008, "Z" },
167 static const struct stm32lx_part_info stm32lx_parts
[] = {
170 .revs
= stm32_416_revs
,
171 .num_revs
= ARRAY_SIZE(stm32_416_revs
),
172 .device_str
= "STM32L1xx (Cat.1 - Low/Medium Density)",
174 .pages_per_sector
= 16,
175 .max_flash_size_kb
= 128,
176 .has_dual_banks
= false,
177 .flash_base
= 0x40023C00,
178 .fsize_base
= 0x1FF8004C,
182 .revs
= stm32_417_revs
,
183 .num_revs
= ARRAY_SIZE(stm32_417_revs
),
184 .device_str
= "STM32L0xx (Cat. 3)",
186 .pages_per_sector
= 32,
187 .max_flash_size_kb
= 64,
188 .has_dual_banks
= false,
189 .flash_base
= 0x40022000,
190 .fsize_base
= 0x1FF8007C,
194 .revs
= stm32_425_revs
,
195 .num_revs
= ARRAY_SIZE(stm32_425_revs
),
196 .device_str
= "STM32L0xx (Cat. 2)",
198 .pages_per_sector
= 32,
199 .max_flash_size_kb
= 32,
200 .has_dual_banks
= false,
201 .flash_base
= 0x40022000,
202 .fsize_base
= 0x1FF8007C,
206 .revs
= stm32_427_revs
,
207 .num_revs
= ARRAY_SIZE(stm32_427_revs
),
208 .device_str
= "STM32L1xx (Cat.3 - Medium+ Density)",
210 .pages_per_sector
= 16,
211 .max_flash_size_kb
= 256,
212 .has_dual_banks
= false,
213 .flash_base
= 0x40023C00,
214 .fsize_base
= 0x1FF800CC,
218 .revs
= stm32_429_revs
,
219 .num_revs
= ARRAY_SIZE(stm32_429_revs
),
220 .device_str
= "STM32L1xx (Cat.2)",
222 .pages_per_sector
= 16,
223 .max_flash_size_kb
= 128,
224 .has_dual_banks
= false,
225 .flash_base
= 0x40023C00,
226 .fsize_base
= 0x1FF8004C,
230 .revs
= stm32_436_revs
,
231 .num_revs
= ARRAY_SIZE(stm32_436_revs
),
232 .device_str
= "STM32L1xx (Cat.4/Cat.3 - Medium+/High Density)",
234 .pages_per_sector
= 16,
235 .max_flash_size_kb
= 384,
236 .first_bank_size_kb
= 192,
237 .has_dual_banks
= true,
238 .flash_base
= 0x40023C00,
239 .fsize_base
= 0x1FF800CC,
243 .revs
= stm32_437_revs
,
244 .num_revs
= ARRAY_SIZE(stm32_437_revs
),
245 .device_str
= "STM32L1xx (Cat.5/Cat.6)",
247 .pages_per_sector
= 16,
248 .max_flash_size_kb
= 512,
249 .first_bank_size_kb
= 0, /* determined in runtime */
250 .has_dual_banks
= true,
251 .flash_base
= 0x40023C00,
252 .fsize_base
= 0x1FF800CC,
256 .revs
= stm32_447_revs
,
257 .num_revs
= ARRAY_SIZE(stm32_447_revs
),
258 .device_str
= "STM32L0xx (Cat.5)",
260 .pages_per_sector
= 32,
261 .max_flash_size_kb
= 192,
262 .first_bank_size_kb
= 0, /* determined in runtime */
263 .has_dual_banks
= false, /* determined in runtime */
264 .flash_base
= 0x40022000,
265 .fsize_base
= 0x1FF8007C,
269 .revs
= stm32_457_revs
,
270 .num_revs
= ARRAY_SIZE(stm32_457_revs
),
271 .device_str
= "STM32L0xx (Cat.1)",
273 .pages_per_sector
= 32,
274 .max_flash_size_kb
= 16,
275 .has_dual_banks
= false,
276 .flash_base
= 0x40022000,
277 .fsize_base
= 0x1FF8007C,
281 /* flash bank stm32lx <base> <size> 0 0 <target#>
283 FLASH_BANK_COMMAND_HANDLER(stm32lx_flash_bank_command
)
285 struct stm32lx_flash_bank
*stm32lx_info
;
287 return ERROR_COMMAND_SYNTAX_ERROR
;
289 /* Create the bank structure */
290 stm32lx_info
= calloc(1, sizeof(*stm32lx_info
));
292 /* Check allocation */
293 if (stm32lx_info
== NULL
) {
294 LOG_ERROR("failed to allocate bank structure");
298 bank
->driver_priv
= stm32lx_info
;
300 stm32lx_info
->probed
= 0;
301 stm32lx_info
->user_bank_size
= bank
->size
;
303 /* the stm32l erased value is 0x00 */
304 bank
->default_padded_value
= bank
->erased_value
= 0x00;
309 COMMAND_HANDLER(stm32lx_handle_mass_erase_command
)
314 return ERROR_COMMAND_SYNTAX_ERROR
;
316 struct flash_bank
*bank
;
317 int retval
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &bank
);
318 if (ERROR_OK
!= retval
)
321 retval
= stm32lx_mass_erase(bank
);
322 if (retval
== ERROR_OK
) {
323 /* set all sectors as erased */
324 for (i
= 0; i
< bank
->num_sectors
; i
++)
325 bank
->sectors
[i
].is_erased
= 1;
327 command_print(CMD_CTX
, "stm32lx mass erase complete");
329 command_print(CMD_CTX
, "stm32lx mass erase failed");
335 COMMAND_HANDLER(stm32lx_handle_lock_command
)
338 return ERROR_COMMAND_SYNTAX_ERROR
;
340 struct flash_bank
*bank
;
341 int retval
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &bank
);
342 if (ERROR_OK
!= retval
)
345 retval
= stm32lx_lock(bank
);
347 if (retval
== ERROR_OK
)
348 command_print(CMD_CTX
, "STM32Lx locked, takes effect after power cycle.");
350 command_print(CMD_CTX
, "STM32Lx lock failed");
355 COMMAND_HANDLER(stm32lx_handle_unlock_command
)
358 return ERROR_COMMAND_SYNTAX_ERROR
;
360 struct flash_bank
*bank
;
361 int retval
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &bank
);
362 if (ERROR_OK
!= retval
)
365 retval
= stm32lx_unlock(bank
);
367 if (retval
== ERROR_OK
)
368 command_print(CMD_CTX
, "STM32Lx unlocked, takes effect after power cycle.");
370 command_print(CMD_CTX
, "STM32Lx unlock failed");
375 static int stm32lx_protect_check(struct flash_bank
*bank
)
378 struct target
*target
= bank
->target
;
379 struct stm32lx_flash_bank
*stm32lx_info
= bank
->driver_priv
;
384 * Read the WRPR word, and check each bit (corresponding to each
387 retval
= target_read_u32(target
, stm32lx_info
->flash_base
+ FLASH_WRPR
,
389 if (retval
!= ERROR_OK
)
392 for (int i
= 0; i
< bank
->num_sectors
; i
++) {
394 bank
->sectors
[i
].is_protected
= 1;
396 bank
->sectors
[i
].is_protected
= 0;
401 static int stm32lx_erase(struct flash_bank
*bank
, int first
, int last
)
406 * It could be possible to do a mass erase if all sectors must be
407 * erased, but it is not implemented yet.
410 if (bank
->target
->state
!= TARGET_HALTED
) {
411 LOG_ERROR("Target not halted");
412 return ERROR_TARGET_NOT_HALTED
;
416 * Loop over the selected sectors and erase them
418 for (int i
= first
; i
<= last
; i
++) {
419 retval
= stm32lx_erase_sector(bank
, i
);
420 if (retval
!= ERROR_OK
)
422 bank
->sectors
[i
].is_erased
= 1;
427 static int stm32lx_write_half_pages(struct flash_bank
*bank
, const uint8_t *buffer
,
428 uint32_t offset
, uint32_t count
)
430 struct target
*target
= bank
->target
;
431 struct stm32lx_flash_bank
*stm32lx_info
= bank
->driver_priv
;
433 uint32_t hp_nb
= stm32lx_info
->part_info
.page_size
/ 2;
434 uint32_t buffer_size
= 16384;
435 struct working_area
*write_algorithm
;
436 struct working_area
*source
;
437 uint32_t address
= bank
->base
+ offset
;
439 struct reg_param reg_params
[3];
440 struct armv7m_algorithm armv7m_info
;
442 int retval
= ERROR_OK
;
444 static const uint8_t stm32lx_flash_write_code
[] = {
445 #include "../../../contrib/loaders/flash/stm32/stm32lx.inc"
448 /* Make sure we're performing a half-page aligned write. */
450 LOG_ERROR("The byte count must be %" PRIu32
"B-aligned but count is %" PRIi32
"B)", hp_nb
, count
);
454 /* flash write code */
455 if (target_alloc_working_area(target
, sizeof(stm32lx_flash_write_code
),
456 &write_algorithm
) != ERROR_OK
) {
457 LOG_DEBUG("no working area for block memory writes");
458 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
461 /* Write the flashing code */
462 retval
= target_write_buffer(target
,
463 write_algorithm
->address
,
464 sizeof(stm32lx_flash_write_code
),
465 stm32lx_flash_write_code
);
466 if (retval
!= ERROR_OK
) {
467 target_free_working_area(target
, write_algorithm
);
471 /* Allocate half pages memory */
472 while (target_alloc_working_area_try(target
, buffer_size
, &source
) != ERROR_OK
) {
473 if (buffer_size
> 1024)
478 if (buffer_size
<= stm32lx_info
->part_info
.page_size
) {
479 /* we already allocated the writing code, but failed to get a
480 * buffer, free the algorithm */
481 target_free_working_area(target
, write_algorithm
);
483 LOG_WARNING("no large enough working area available, can't do block memory writes");
484 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
488 armv7m_info
.common_magic
= ARMV7M_COMMON_MAGIC
;
489 armv7m_info
.core_mode
= ARM_MODE_THREAD
;
490 init_reg_param(®_params
[0], "r0", 32, PARAM_OUT
);
491 init_reg_param(®_params
[1], "r1", 32, PARAM_OUT
);
492 init_reg_param(®_params
[2], "r2", 32, PARAM_OUT
);
494 /* Enable half-page write */
495 retval
= stm32lx_enable_write_half_page(bank
);
496 if (retval
!= ERROR_OK
) {
497 target_free_working_area(target
, source
);
498 target_free_working_area(target
, write_algorithm
);
500 destroy_reg_param(®_params
[0]);
501 destroy_reg_param(®_params
[1]);
502 destroy_reg_param(®_params
[2]);
506 struct armv7m_common
*armv7m
= target_to_armv7m(target
);
507 if (armv7m
== NULL
) {
509 /* something is very wrong if armv7m is NULL */
510 LOG_ERROR("unable to get armv7m target");
514 /* save any DEMCR flags and configure target to catch any Hard Faults */
515 uint32_t demcr_save
= armv7m
->demcr
;
516 armv7m
->demcr
= VC_HARDERR
;
518 /* Loop while there are bytes to write */
521 this_count
= (count
> buffer_size
) ? buffer_size
: count
;
523 /* Write the next half pages */
524 retval
= target_write_buffer(target
, source
->address
, this_count
, buffer
);
525 if (retval
!= ERROR_OK
)
528 /* 4: Store useful information in the registers */
529 /* the destination address of the copy (R0) */
530 buf_set_u32(reg_params
[0].value
, 0, 32, address
);
531 /* The source address of the copy (R1) */
532 buf_set_u32(reg_params
[1].value
, 0, 32, source
->address
);
533 /* The length of the copy (R2) */
534 buf_set_u32(reg_params
[2].value
, 0, 32, this_count
/ 4);
536 /* 5: Execute the bunch of code */
537 retval
= target_run_algorithm(target
, 0, NULL
, sizeof(reg_params
)
538 / sizeof(*reg_params
), reg_params
,
539 write_algorithm
->address
, 0, 10000, &armv7m_info
);
540 if (retval
!= ERROR_OK
)
543 /* check for Hard Fault */
544 if (armv7m
->exception_number
== 3)
547 /* 6: Wait while busy */
548 retval
= stm32lx_wait_until_bsy_clear(bank
);
549 if (retval
!= ERROR_OK
)
552 buffer
+= this_count
;
553 address
+= this_count
;
557 /* restore previous flags */
558 armv7m
->demcr
= demcr_save
;
560 if (armv7m
->exception_number
== 3) {
562 /* the stm32l15x devices seem to have an issue when blank.
563 * if a ram loader is executed on a blank device it will
564 * Hard Fault, this issue does not happen for a already programmed device.
565 * A related issue is described in the stm32l151xx errata (Doc ID 17721 Rev 6 - 2.1.3).
566 * The workaround of handling the Hard Fault exception does work, but makes the
567 * loader more complicated, as a compromise we manually write the pages, programming time
568 * is reduced by 50% using this slower method.
571 LOG_WARNING("Couldn't use loader, falling back to page memory writes");
575 this_count
= (count
> hp_nb
) ? hp_nb
: count
;
577 /* Write the next half pages */
578 retval
= target_write_buffer(target
, address
, this_count
, buffer
);
579 if (retval
!= ERROR_OK
)
582 /* Wait while busy */
583 retval
= stm32lx_wait_until_bsy_clear(bank
);
584 if (retval
!= ERROR_OK
)
587 buffer
+= this_count
;
588 address
+= this_count
;
593 if (retval
== ERROR_OK
)
594 retval
= stm32lx_lock_program_memory(bank
);
596 target_free_working_area(target
, source
);
597 target_free_working_area(target
, write_algorithm
);
599 destroy_reg_param(®_params
[0]);
600 destroy_reg_param(®_params
[1]);
601 destroy_reg_param(®_params
[2]);
606 static int stm32lx_write(struct flash_bank
*bank
, const uint8_t *buffer
,
607 uint32_t offset
, uint32_t count
)
609 struct target
*target
= bank
->target
;
610 struct stm32lx_flash_bank
*stm32lx_info
= bank
->driver_priv
;
612 uint32_t hp_nb
= stm32lx_info
->part_info
.page_size
/ 2;
613 uint32_t halfpages_number
;
614 uint32_t bytes_remaining
= 0;
615 uint32_t address
= bank
->base
+ offset
;
616 uint32_t bytes_written
= 0;
619 if (bank
->target
->state
!= TARGET_HALTED
) {
620 LOG_ERROR("Target not halted");
621 return ERROR_TARGET_NOT_HALTED
;
625 LOG_ERROR("offset 0x%" PRIx32
" breaks required 4-byte alignment", offset
);
626 return ERROR_FLASH_DST_BREAKS_ALIGNMENT
;
629 retval
= stm32lx_unlock_program_memory(bank
);
630 if (retval
!= ERROR_OK
)
633 /* first we need to write any unaligned head bytes upto
634 * the next 128 byte page */
637 bytes_remaining
= MIN(count
, hp_nb
- (offset
% hp_nb
));
639 while (bytes_remaining
> 0) {
640 uint8_t value
[4] = {0xff, 0xff, 0xff, 0xff};
642 /* copy remaining bytes into the write buffer */
643 uint32_t bytes_to_write
= MIN(4, bytes_remaining
);
644 memcpy(value
, buffer
+ bytes_written
, bytes_to_write
);
646 retval
= target_write_buffer(target
, address
, 4, value
);
647 if (retval
!= ERROR_OK
)
648 goto reset_pg_and_lock
;
650 bytes_written
+= bytes_to_write
;
651 bytes_remaining
-= bytes_to_write
;
654 retval
= stm32lx_wait_until_bsy_clear(bank
);
655 if (retval
!= ERROR_OK
)
656 goto reset_pg_and_lock
;
659 offset
+= bytes_written
;
660 count
-= bytes_written
;
662 /* this should always pass this check here */
663 assert((offset
% hp_nb
) == 0);
665 /* calculate half pages */
666 halfpages_number
= count
/ hp_nb
;
668 if (halfpages_number
) {
669 retval
= stm32lx_write_half_pages(bank
, buffer
+ bytes_written
, offset
, hp_nb
* halfpages_number
);
670 if (retval
== ERROR_TARGET_RESOURCE_NOT_AVAILABLE
) {
671 /* attempt slow memory writes */
672 LOG_WARNING("couldn't use block writes, falling back to single memory accesses");
673 halfpages_number
= 0;
675 if (retval
!= ERROR_OK
)
680 /* write any remaining bytes */
681 uint32_t page_bytes_written
= hp_nb
* halfpages_number
;
682 bytes_written
+= page_bytes_written
;
683 address
+= page_bytes_written
;
684 bytes_remaining
= count
- page_bytes_written
;
686 retval
= stm32lx_unlock_program_memory(bank
);
687 if (retval
!= ERROR_OK
)
690 while (bytes_remaining
> 0) {
691 uint8_t value
[4] = {0xff, 0xff, 0xff, 0xff};
693 /* copy remaining bytes into the write buffer */
694 uint32_t bytes_to_write
= MIN(4, bytes_remaining
);
695 memcpy(value
, buffer
+ bytes_written
, bytes_to_write
);
697 retval
= target_write_buffer(target
, address
, 4, value
);
698 if (retval
!= ERROR_OK
)
699 goto reset_pg_and_lock
;
701 bytes_written
+= bytes_to_write
;
702 bytes_remaining
-= bytes_to_write
;
705 retval
= stm32lx_wait_until_bsy_clear(bank
);
706 if (retval
!= ERROR_OK
)
707 goto reset_pg_and_lock
;
711 retval2
= stm32lx_lock_program_memory(bank
);
712 if (retval
== ERROR_OK
)
718 static int stm32lx_read_id_code(struct target
*target
, uint32_t *id
)
720 struct armv7m_common
*armv7m
= target_to_armv7m(target
);
722 if (armv7m
->arm
.is_armv6m
== true)
723 retval
= target_read_u32(target
, DBGMCU_IDCODE_L0
, id
);
725 /* read stm32 device id register */
726 retval
= target_read_u32(target
, DBGMCU_IDCODE
, id
);
730 static int stm32lx_probe(struct flash_bank
*bank
)
732 struct target
*target
= bank
->target
;
733 struct stm32lx_flash_bank
*stm32lx_info
= bank
->driver_priv
;
735 uint16_t flash_size_in_kb
;
737 uint32_t base_address
= FLASH_BANK0_ADDRESS
;
738 uint32_t second_bank_base
;
741 stm32lx_info
->probed
= 0;
743 int retval
= stm32lx_read_id_code(bank
->target
, &device_id
);
744 if (retval
!= ERROR_OK
)
747 stm32lx_info
->idcode
= device_id
;
749 LOG_DEBUG("device id = 0x%08" PRIx32
"", device_id
);
751 for (n
= 0; n
< ARRAY_SIZE(stm32lx_parts
); n
++) {
752 if ((device_id
& 0xfff) == stm32lx_parts
[n
].id
) {
753 stm32lx_info
->part_info
= stm32lx_parts
[n
];
758 if (n
== ARRAY_SIZE(stm32lx_parts
)) {
759 LOG_WARNING("Cannot identify target as a STM32L family.");
762 LOG_INFO("Device: %s", stm32lx_info
->part_info
.device_str
);
765 stm32lx_info
->flash_base
= stm32lx_info
->part_info
.flash_base
;
767 /* Get the flash size from target. */
768 retval
= target_read_u16(target
, stm32lx_info
->part_info
.fsize_base
,
771 /* 0x436 devices report their flash size as a 0 or 1 code indicating 384K
772 * or 256K, respectively. Please see RM0038 r8 or newer and refer to
774 if (retval
== ERROR_OK
&& (device_id
& 0xfff) == 0x436) {
775 if (flash_size_in_kb
== 0)
776 flash_size_in_kb
= 384;
777 else if (flash_size_in_kb
== 1)
778 flash_size_in_kb
= 256;
781 /* 0x429 devices only use the lowest 8 bits of the flash size register */
782 if (retval
== ERROR_OK
&& (device_id
& 0xfff) == 0x429) {
783 flash_size_in_kb
&= 0xff;
786 /* Failed reading flash size or flash size invalid (early silicon),
787 * default to max target family */
788 if (retval
!= ERROR_OK
|| flash_size_in_kb
== 0xffff || flash_size_in_kb
== 0) {
789 LOG_WARNING("STM32L flash size failed, probe inaccurate - assuming %dk flash",
790 stm32lx_info
->part_info
.max_flash_size_kb
);
791 flash_size_in_kb
= stm32lx_info
->part_info
.max_flash_size_kb
;
792 } else if (flash_size_in_kb
> stm32lx_info
->part_info
.max_flash_size_kb
) {
793 LOG_WARNING("STM32L probed flash size assumed incorrect since FLASH_SIZE=%dk > %dk, - assuming %dk flash",
794 flash_size_in_kb
, stm32lx_info
->part_info
.max_flash_size_kb
,
795 stm32lx_info
->part_info
.max_flash_size_kb
);
796 flash_size_in_kb
= stm32lx_info
->part_info
.max_flash_size_kb
;
799 /* Overwrite default dual-bank configuration */
800 retval
= stm32lx_update_part_info(bank
, flash_size_in_kb
);
801 if (retval
!= ERROR_OK
)
804 if (stm32lx_info
->part_info
.has_dual_banks
) {
805 /* Use the configured base address to determine if this is the first or second flash bank.
806 * Verify that the base address is reasonably correct and determine the flash bank size
808 second_bank_base
= base_address
+
809 stm32lx_info
->part_info
.first_bank_size_kb
* 1024;
810 if (bank
->base
== second_bank_base
|| !bank
->base
) {
811 /* This is the second bank */
812 base_address
= second_bank_base
;
813 flash_size_in_kb
= flash_size_in_kb
-
814 stm32lx_info
->part_info
.first_bank_size_kb
;
815 } else if (bank
->base
== base_address
) {
816 /* This is the first bank */
817 flash_size_in_kb
= stm32lx_info
->part_info
.first_bank_size_kb
;
819 LOG_WARNING("STM32L flash bank base address config is incorrect."
820 " 0x%" PRIx32
" but should rather be 0x%" PRIx32
" or 0x%" PRIx32
,
821 bank
->base
, base_address
, second_bank_base
);
824 LOG_INFO("STM32L flash has dual banks. Bank (%d) size is %dkb, base address is 0x%" PRIx32
,
825 bank
->bank_number
, flash_size_in_kb
, base_address
);
827 LOG_INFO("STM32L flash size is %dkb, base address is 0x%" PRIx32
, flash_size_in_kb
, base_address
);
830 /* if the user sets the size manually then ignore the probed value
831 * this allows us to work around devices that have a invalid flash size register value */
832 if (stm32lx_info
->user_bank_size
) {
833 flash_size_in_kb
= stm32lx_info
->user_bank_size
/ 1024;
834 LOG_INFO("ignoring flash probed value, using configured bank size: %dkbytes", flash_size_in_kb
);
837 /* calculate numbers of sectors (4kB per sector) */
838 int num_sectors
= (flash_size_in_kb
* 1024) / FLASH_SECTOR_SIZE
;
842 bank
->sectors
= NULL
;
845 bank
->size
= flash_size_in_kb
* 1024;
846 bank
->base
= base_address
;
847 bank
->num_sectors
= num_sectors
;
848 bank
->sectors
= malloc(sizeof(struct flash_sector
) * num_sectors
);
849 if (bank
->sectors
== NULL
) {
850 LOG_ERROR("failed to allocate bank sectors");
854 for (i
= 0; i
< num_sectors
; i
++) {
855 bank
->sectors
[i
].offset
= i
* FLASH_SECTOR_SIZE
;
856 bank
->sectors
[i
].size
= FLASH_SECTOR_SIZE
;
857 bank
->sectors
[i
].is_erased
= -1;
858 bank
->sectors
[i
].is_protected
= -1;
861 stm32lx_info
->probed
= 1;
866 static int stm32lx_auto_probe(struct flash_bank
*bank
)
868 struct stm32lx_flash_bank
*stm32lx_info
= bank
->driver_priv
;
870 if (stm32lx_info
->probed
)
873 return stm32lx_probe(bank
);
876 /* This method must return a string displaying information about the bank */
877 static int stm32lx_get_info(struct flash_bank
*bank
, char *buf
, int buf_size
)
879 struct stm32lx_flash_bank
*stm32lx_info
= bank
->driver_priv
;
880 const struct stm32lx_part_info
*info
= &stm32lx_info
->part_info
;
881 uint16_t rev_id
= stm32lx_info
->idcode
>> 16;
882 const char *rev_str
= NULL
;
884 if (!stm32lx_info
->probed
) {
885 int retval
= stm32lx_probe(bank
);
886 if (retval
!= ERROR_OK
) {
887 snprintf(buf
, buf_size
,
888 "Unable to find bank information.");
893 for (unsigned int i
= 0; i
< info
->num_revs
; i
++)
894 if (rev_id
== info
->revs
[i
].rev
)
895 rev_str
= info
->revs
[i
].str
;
897 if (rev_str
!= NULL
) {
898 snprintf(buf
, buf_size
,
900 info
->device_str
, rev_str
);
902 snprintf(buf
, buf_size
,
903 "%s - Rev: unknown (0x%04x)",
904 info
->device_str
, rev_id
);
910 static const struct command_registration stm32lx_exec_command_handlers
[] = {
912 .name
= "mass_erase",
913 .handler
= stm32lx_handle_mass_erase_command
,
914 .mode
= COMMAND_EXEC
,
916 .help
= "Erase entire flash device. including available EEPROM",
920 .handler
= stm32lx_handle_lock_command
,
921 .mode
= COMMAND_EXEC
,
923 .help
= "Increase the readout protection to Level 1.",
927 .handler
= stm32lx_handle_unlock_command
,
928 .mode
= COMMAND_EXEC
,
930 .help
= "Lower the readout protection from Level 1 to 0.",
932 COMMAND_REGISTRATION_DONE
935 static const struct command_registration stm32lx_command_handlers
[] = {
939 .help
= "stm32lx flash command group",
941 .chain
= stm32lx_exec_command_handlers
,
943 COMMAND_REGISTRATION_DONE
946 struct flash_driver stm32lx_flash
= {
948 .commands
= stm32lx_command_handlers
,
949 .flash_bank_command
= stm32lx_flash_bank_command
,
950 .erase
= stm32lx_erase
,
951 .write
= stm32lx_write
,
952 .read
= default_flash_read
,
953 .probe
= stm32lx_probe
,
954 .auto_probe
= stm32lx_auto_probe
,
955 .erase_check
= default_flash_blank_check
,
956 .protect_check
= stm32lx_protect_check
,
957 .info
= stm32lx_get_info
,
958 .free_driver_priv
= default_flash_free_driver_priv
,
961 /* Static methods implementation */
962 static int stm32lx_unlock_program_memory(struct flash_bank
*bank
)
964 struct target
*target
= bank
->target
;
965 struct stm32lx_flash_bank
*stm32lx_info
= bank
->driver_priv
;
970 * Unlocking the program memory is done by unlocking the PECR,
971 * then by writing the 2 PRGKEY to the PRGKEYR register
974 /* check flash is not already unlocked */
975 retval
= target_read_u32(target
, stm32lx_info
->flash_base
+ FLASH_PECR
,
977 if (retval
!= ERROR_OK
)
980 if ((reg32
& FLASH_PECR__PRGLOCK
) == 0)
983 /* To unlock the PECR write the 2 PEKEY to the PEKEYR register */
984 retval
= target_write_u32(target
, stm32lx_info
->flash_base
+ FLASH_PEKEYR
,
986 if (retval
!= ERROR_OK
)
989 retval
= target_write_u32(target
, stm32lx_info
->flash_base
+ FLASH_PEKEYR
,
991 if (retval
!= ERROR_OK
)
994 /* Make sure it worked */
995 retval
= target_read_u32(target
, stm32lx_info
->flash_base
+ FLASH_PECR
,
997 if (retval
!= ERROR_OK
)
1000 if (reg32
& FLASH_PECR__PELOCK
) {
1001 LOG_ERROR("PELOCK is not cleared :(");
1002 return ERROR_FLASH_OPERATION_FAILED
;
1005 retval
= target_write_u32(target
, stm32lx_info
->flash_base
+ FLASH_PRGKEYR
,
1007 if (retval
!= ERROR_OK
)
1009 retval
= target_write_u32(target
, stm32lx_info
->flash_base
+ FLASH_PRGKEYR
,
1011 if (retval
!= ERROR_OK
)
1014 /* Make sure it worked */
1015 retval
= target_read_u32(target
, stm32lx_info
->flash_base
+ FLASH_PECR
,
1017 if (retval
!= ERROR_OK
)
1020 if (reg32
& FLASH_PECR__PRGLOCK
) {
1021 LOG_ERROR("PRGLOCK is not cleared :(");
1022 return ERROR_FLASH_OPERATION_FAILED
;
1028 static int stm32lx_enable_write_half_page(struct flash_bank
*bank
)
1030 struct target
*target
= bank
->target
;
1031 struct stm32lx_flash_bank
*stm32lx_info
= bank
->driver_priv
;
1036 * Unlock the program memory, then set the FPRG bit in the PECR register.
1038 retval
= stm32lx_unlock_program_memory(bank
);
1039 if (retval
!= ERROR_OK
)
1042 retval
= target_read_u32(target
, stm32lx_info
->flash_base
+ FLASH_PECR
,
1044 if (retval
!= ERROR_OK
)
1047 reg32
|= FLASH_PECR__FPRG
;
1048 retval
= target_write_u32(target
, stm32lx_info
->flash_base
+ FLASH_PECR
,
1050 if (retval
!= ERROR_OK
)
1053 retval
= target_read_u32(target
, stm32lx_info
->flash_base
+ FLASH_PECR
,
1055 if (retval
!= ERROR_OK
)
1058 reg32
|= FLASH_PECR__PROG
;
1059 retval
= target_write_u32(target
, stm32lx_info
->flash_base
+ FLASH_PECR
,
1065 static int stm32lx_lock_program_memory(struct flash_bank
*bank
)
1067 struct target
*target
= bank
->target
;
1068 struct stm32lx_flash_bank
*stm32lx_info
= bank
->driver_priv
;
1072 /* To lock the program memory, simply set the lock bit and lock PECR */
1074 retval
= target_read_u32(target
, stm32lx_info
->flash_base
+ FLASH_PECR
,
1076 if (retval
!= ERROR_OK
)
1079 reg32
|= FLASH_PECR__PRGLOCK
;
1080 retval
= target_write_u32(target
, stm32lx_info
->flash_base
+ FLASH_PECR
,
1082 if (retval
!= ERROR_OK
)
1085 retval
= target_read_u32(target
, stm32lx_info
->flash_base
+ FLASH_PECR
,
1087 if (retval
!= ERROR_OK
)
1090 reg32
|= FLASH_PECR__PELOCK
;
1091 retval
= target_write_u32(target
, stm32lx_info
->flash_base
+ FLASH_PECR
,
1093 if (retval
!= ERROR_OK
)
1099 static int stm32lx_erase_sector(struct flash_bank
*bank
, int sector
)
1101 struct target
*target
= bank
->target
;
1102 struct stm32lx_flash_bank
*stm32lx_info
= bank
->driver_priv
;
1107 * To erase a sector (i.e. stm32lx_info->part_info.pages_per_sector pages),
1108 * first unlock the memory, loop over the pages of this sector
1109 * and write 0x0 to its first word.
1112 retval
= stm32lx_unlock_program_memory(bank
);
1113 if (retval
!= ERROR_OK
)
1116 for (int page
= 0; page
< (int)stm32lx_info
->part_info
.pages_per_sector
;
1118 reg32
= FLASH_PECR__PROG
| FLASH_PECR__ERASE
;
1119 retval
= target_write_u32(target
,
1120 stm32lx_info
->flash_base
+ FLASH_PECR
, reg32
);
1121 if (retval
!= ERROR_OK
)
1124 retval
= stm32lx_wait_until_bsy_clear(bank
);
1125 if (retval
!= ERROR_OK
)
1128 uint32_t addr
= bank
->base
+ bank
->sectors
[sector
].offset
+ (page
1129 * stm32lx_info
->part_info
.page_size
);
1130 retval
= target_write_u32(target
, addr
, 0x0);
1131 if (retval
!= ERROR_OK
)
1134 retval
= stm32lx_wait_until_bsy_clear(bank
);
1135 if (retval
!= ERROR_OK
)
1139 retval
= stm32lx_lock_program_memory(bank
);
1140 if (retval
!= ERROR_OK
)
1146 static inline int stm32lx_get_flash_status(struct flash_bank
*bank
, uint32_t *status
)
1148 struct target
*target
= bank
->target
;
1149 struct stm32lx_flash_bank
*stm32lx_info
= bank
->driver_priv
;
1151 return target_read_u32(target
, stm32lx_info
->flash_base
+ FLASH_SR
, status
);
1154 static int stm32lx_wait_until_bsy_clear(struct flash_bank
*bank
)
1156 return stm32lx_wait_until_bsy_clear_timeout(bank
, 100);
1159 static int stm32lx_unlock_options_bytes(struct flash_bank
*bank
)
1161 struct target
*target
= bank
->target
;
1162 struct stm32lx_flash_bank
*stm32lx_info
= bank
->driver_priv
;
1167 * Unlocking the options bytes is done by unlocking the PECR,
1168 * then by writing the 2 FLASH_PEKEYR to the FLASH_OPTKEYR register
1171 /* check flash is not already unlocked */
1172 retval
= target_read_u32(target
, stm32lx_info
->flash_base
+ FLASH_PECR
, ®32
);
1173 if (retval
!= ERROR_OK
)
1176 if ((reg32
& FLASH_PECR__OPTLOCK
) == 0)
1179 if ((reg32
& FLASH_PECR__PELOCK
) != 0) {
1181 retval
= target_write_u32(target
, stm32lx_info
->flash_base
+ FLASH_PEKEYR
, PEKEY1
);
1182 if (retval
!= ERROR_OK
)
1185 retval
= target_write_u32(target
, stm32lx_info
->flash_base
+ FLASH_PEKEYR
, PEKEY2
);
1186 if (retval
!= ERROR_OK
)
1190 /* To unlock the PECR write the 2 OPTKEY to the FLASH_OPTKEYR register */
1191 retval
= target_write_u32(target
, stm32lx_info
->flash_base
+ FLASH_OPTKEYR
, OPTKEY1
);
1192 if (retval
!= ERROR_OK
)
1195 retval
= target_write_u32(target
, stm32lx_info
->flash_base
+ FLASH_OPTKEYR
, OPTKEY2
);
1196 if (retval
!= ERROR_OK
)
1202 static int stm32lx_wait_until_bsy_clear_timeout(struct flash_bank
*bank
, int timeout
)
1204 struct target
*target
= bank
->target
;
1205 struct stm32lx_flash_bank
*stm32lx_info
= bank
->driver_priv
;
1207 int retval
= ERROR_OK
;
1209 /* wait for busy to clear */
1211 retval
= stm32lx_get_flash_status(bank
, &status
);
1212 if (retval
!= ERROR_OK
)
1215 LOG_DEBUG("status: 0x%" PRIx32
"", status
);
1216 if ((status
& FLASH_SR__BSY
) == 0)
1219 if (timeout
-- <= 0) {
1220 LOG_ERROR("timed out waiting for flash");
1226 if (status
& FLASH_SR__WRPERR
) {
1227 LOG_ERROR("access denied / write protected");
1228 retval
= ERROR_FAIL
;
1231 if (status
& FLASH_SR__PGAERR
) {
1232 LOG_ERROR("invalid program address");
1233 retval
= ERROR_FAIL
;
1236 /* Clear but report errors */
1237 if (status
& FLASH_SR__OPTVERR
) {
1238 /* If this operation fails, we ignore it and report the original retval */
1239 target_write_u32(target
, stm32lx_info
->flash_base
+ FLASH_SR
, status
& FLASH_SR__OPTVERR
);
1245 static int stm32lx_obl_launch(struct flash_bank
*bank
)
1247 struct target
*target
= bank
->target
;
1248 struct stm32lx_flash_bank
*stm32lx_info
= bank
->driver_priv
;
1251 /* This will fail as the target gets immediately rebooted */
1252 target_write_u32(target
, stm32lx_info
->flash_base
+ FLASH_PECR
,
1253 FLASH_PECR__OBL_LAUNCH
);
1257 target_halt(target
);
1258 retval
= target_poll(target
);
1259 } while (--tries
> 0 &&
1260 (retval
!= ERROR_OK
|| target
->state
!= TARGET_HALTED
));
1262 return tries
? ERROR_OK
: ERROR_FAIL
;
1265 static int stm32lx_lock(struct flash_bank
*bank
)
1268 struct target
*target
= bank
->target
;
1270 if (target
->state
!= TARGET_HALTED
) {
1271 LOG_ERROR("Target not halted");
1272 return ERROR_TARGET_NOT_HALTED
;
1275 retval
= stm32lx_unlock_options_bytes(bank
);
1276 if (retval
!= ERROR_OK
)
1279 /* set the RDP protection level to 1 */
1280 retval
= target_write_u32(target
, OPTION_BYTES_ADDRESS
, OPTION_BYTE_0_PR1
);
1281 if (retval
!= ERROR_OK
)
1287 static int stm32lx_unlock(struct flash_bank
*bank
)
1290 struct target
*target
= bank
->target
;
1292 if (target
->state
!= TARGET_HALTED
) {
1293 LOG_ERROR("Target not halted");
1294 return ERROR_TARGET_NOT_HALTED
;
1297 retval
= stm32lx_unlock_options_bytes(bank
);
1298 if (retval
!= ERROR_OK
)
1301 /* set the RDP protection level to 0 */
1302 retval
= target_write_u32(target
, OPTION_BYTES_ADDRESS
, OPTION_BYTE_0_PR0
);
1303 if (retval
!= ERROR_OK
)
1306 retval
= stm32lx_wait_until_bsy_clear_timeout(bank
, 30000);
1307 if (retval
!= ERROR_OK
)
1313 static int stm32lx_mass_erase(struct flash_bank
*bank
)
1316 struct target
*target
= bank
->target
;
1317 struct stm32lx_flash_bank
*stm32lx_info
= NULL
;
1320 if (target
->state
!= TARGET_HALTED
) {
1321 LOG_ERROR("Target not halted");
1322 return ERROR_TARGET_NOT_HALTED
;
1325 stm32lx_info
= bank
->driver_priv
;
1327 retval
= stm32lx_lock(bank
);
1328 if (retval
!= ERROR_OK
)
1331 retval
= stm32lx_obl_launch(bank
);
1332 if (retval
!= ERROR_OK
)
1335 retval
= stm32lx_unlock(bank
);
1336 if (retval
!= ERROR_OK
)
1339 retval
= stm32lx_obl_launch(bank
);
1340 if (retval
!= ERROR_OK
)
1343 retval
= target_read_u32(target
, stm32lx_info
->flash_base
+ FLASH_PECR
, ®32
);
1344 if (retval
!= ERROR_OK
)
1347 retval
= target_write_u32(target
, stm32lx_info
->flash_base
+ FLASH_PECR
, reg32
| FLASH_PECR__OPTLOCK
);
1348 if (retval
!= ERROR_OK
)
1354 static int stm32lx_update_part_info(struct flash_bank
*bank
, uint16_t flash_size_in_kb
)
1356 struct stm32lx_flash_bank
*stm32lx_info
= bank
->driver_priv
;
1358 switch (stm32lx_info
->part_info
.id
) {
1359 case 0x447: /* STM32L0xx (Cat.5) devices */
1360 if (flash_size_in_kb
== 192 || flash_size_in_kb
== 128) {
1361 stm32lx_info
->part_info
.first_bank_size_kb
= flash_size_in_kb
/ 2;
1362 stm32lx_info
->part_info
.has_dual_banks
= true;
1365 case 0x437: /* STM32L1xx (Cat.5/Cat.6) */
1366 stm32lx_info
->part_info
.first_bank_size_kb
= flash_size_in_kb
/ 2;
Linking to existing account procedure
If you already have an account and want to add another login method
you
MUST first sign in with your existing account and
then change URL to read
https://review.openocd.org/login/?link
to get to this page again but this time it'll work for linking. Thank you.
SSH host keys fingerprints
1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=.. |
|+o.. . |
|*.o . . |
|+B . . . |
|Bo. = o S |
|Oo.+ + = |
|oB=.* = . o |
| =+=.+ + E |
|. .=o . o |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)