1 /***************************************************************************
2 * Copyright (C) 2015 by Uwe Bonnes *
3 * bon@elektron.ikp.physik.tu-darmstadt.de *
5 * Copyright (C) 2019 by Tarek Bochkati for STMicroelectronics *
6 * tarek.bouchkati@gmail.com *
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, see <http://www.gnu.org/licenses/>. *
20 ***************************************************************************/
27 #include <helper/binarybuffer.h>
28 #include <target/algorithm.h>
29 #include <target/armv7m.h>
33 /* STM32L4xxx series for reference.
35 * RM0351 (STM32L4x5/STM32L4x6)
36 * http://www.st.com/resource/en/reference_manual/dm00083560.pdf
38 * RM0394 (STM32L43x/44x/45x/46x)
39 * http://www.st.com/resource/en/reference_manual/dm00151940.pdf
41 * RM0432 (STM32L4R/4Sxx)
42 * http://www.st.com/resource/en/reference_manual/dm00310109.pdf
44 * STM32L476RG Datasheet (for erase timing)
45 * http://www.st.com/resource/en/datasheet/stm32l476rg.pdf
47 * The RM0351 devices have normally two banks, but on 512 and 256 kiB devices
48 * an option byte is available to map all sectors to the first bank.
49 * Both STM32 banks are treated as one OpenOCD bank, as other STM32 devices
52 * RM0394 devices have a single bank only.
54 * RM0432 devices have single and dual bank operating modes.
55 * - for STM32L4R/Sxx the FLASH size is 2Mbyte or 1Mbyte.
56 * - for STM32L4P/Q5x the FLASH size is 1Mbyte or 512Kbyte.
57 * Bank page (sector) size is 4Kbyte (dual mode) or 8Kbyte (single mode).
59 * Bank mode is controlled by two different bits in option bytes register.
61 * In 2M FLASH devices bit 22 (DBANK) controls Dual Bank mode.
62 * In 1M FLASH devices bit 21 (DB1M) controls Dual Bank mode.
64 * In 1M FLASH devices bit 22 (DBANK) controls Dual Bank mode.
65 * In 512K FLASH devices bit 21 (DB512K) controls Dual Bank mode.
69 /* STM32WBxxx series for reference.
72 * http://www.st.com/resource/en/reference_manual/dm00318631.pdf
75 * http://www.st.com/resource/en/reference_manual/dm00622834.pdf
78 /* STM32WLxxx series for reference.
81 * http://www.st.com/resource/en/reference_manual/dm00530369.pdf
84 /* STM32G0xxx series for reference.
87 * http://www.st.com/resource/en/reference_manual/dm00371828.pdf
90 * http://www.st.com/resource/en/reference_manual/dm00463896.pdf
93 /* STM32G4xxx series for reference.
95 * RM0440 (STM32G43x/44x/47x/48x/49x/4Ax)
96 * http://www.st.com/resource/en/reference_manual/dm00355726.pdf
98 * Cat. 2 devices have single bank only, page size is 2kByte.
100 * Cat. 3 devices have single and dual bank operating modes,
101 * Page size is 2kByte (dual mode) or 4kByte (single mode).
103 * Bank mode is controlled by bit 22 (DBANK) in option bytes register.
104 * Both banks are treated as a single OpenOCD bank.
106 * Cat. 4 devices have single bank only, page size is 2kByte.
109 /* STM32L5xxx series for reference.
111 * RM0428 (STM32L552xx/STM32L562xx)
112 * http://www.st.com/resource/en/reference_manual/dm00346336.pdf
115 /* Erase time can be as high as 25ms, 10x this and assume it's toast... */
117 #define FLASH_ERASE_TIMEOUT 250
120 /* relevant STM32L4 flags ****************************************************/
122 /* this flag indicates if the device flash is with dual bank architecture */
123 #define F_HAS_DUAL_BANK BIT(0)
124 /* this flags is used for dual bank devices only, it indicates if the
125 * 4 WRPxx are usable if the device is configured in single-bank mode */
126 #define F_USE_ALL_WRPXX BIT(1)
127 /* this flag indicates if the device embeds a TrustZone security feature */
128 #define F_HAS_TZ BIT(2)
129 /* end of STM32L4 flags ******************************************************/
132 enum stm32l4_flash_reg_index {
133 STM32_FLASH_ACR_INDEX,
134 STM32_FLASH_KEYR_INDEX,
135 STM32_FLASH_OPTKEYR_INDEX,
136 STM32_FLASH_SR_INDEX,
137 STM32_FLASH_CR_INDEX,
138 STM32_FLASH_OPTR_INDEX,
139 STM32_FLASH_WRP1AR_INDEX,
140 STM32_FLASH_WRP1BR_INDEX,
141 STM32_FLASH_WRP2AR_INDEX,
142 STM32_FLASH_WRP2BR_INDEX,
143 STM32_FLASH_REG_INDEX_NUM,
148 RDP_LEVEL_0_5 = 0x55, /* for devices with TrustZone enabled */
153 static const uint32_t stm32l4_flash_regs[STM32_FLASH_REG_INDEX_NUM] = {
154 [STM32_FLASH_ACR_INDEX] = 0x000,
155 [STM32_FLASH_KEYR_INDEX] = 0x008,
156 [STM32_FLASH_OPTKEYR_INDEX] = 0x00C,
157 [STM32_FLASH_SR_INDEX] = 0x010,
158 [STM32_FLASH_CR_INDEX] = 0x014,
159 [STM32_FLASH_OPTR_INDEX] = 0x020,
160 [STM32_FLASH_WRP1AR_INDEX] = 0x02C,
161 [STM32_FLASH_WRP1BR_INDEX] = 0x030,
162 [STM32_FLASH_WRP2AR_INDEX] = 0x04C,
163 [STM32_FLASH_WRP2BR_INDEX] = 0x050,
166 static const uint32_t stm32l5_ns_flash_regs[STM32_FLASH_REG_INDEX_NUM] = {
167 [STM32_FLASH_ACR_INDEX] = 0x000,
168 [STM32_FLASH_KEYR_INDEX] = 0x008,
169 [STM32_FLASH_OPTKEYR_INDEX] = 0x010,
170 [STM32_FLASH_SR_INDEX] = 0x020,
171 [STM32_FLASH_CR_INDEX] = 0x028,
172 [STM32_FLASH_OPTR_INDEX] = 0x040,
173 [STM32_FLASH_WRP1AR_INDEX] = 0x058,
174 [STM32_FLASH_WRP1BR_INDEX] = 0x05C,
175 [STM32_FLASH_WRP2AR_INDEX] = 0x068,
176 [STM32_FLASH_WRP2BR_INDEX] = 0x06C,
184 struct stm32l4_part_info {
186 const char *device_str;
187 const struct stm32l4_rev *revs;
188 const size_t num_revs;
189 const uint16_t max_flash_size_kb;
190 const uint32_t flags; /* one bit per feature, see STM32L4 flags: macros F_XXX */
191 const uint32_t flash_regs_base;
192 const uint32_t *default_flash_regs;
193 const uint32_t fsize_addr;
194 const uint32_t otp_base;
195 const uint32_t otp_size;
198 struct stm32l4_flash_bank {
201 unsigned int bank1_sectors;
204 uint32_t user_bank_size;
205 uint32_t wrpxxr_mask;
206 const struct stm32l4_part_info *part_info;
207 const uint32_t *flash_regs;
209 enum stm32l4_rdp rdp;
220 enum stm32l4_flash_reg_index reg_idx;
228 /* human readable list of families this drivers supports (sorted alphabetically) */
229 static const char *device_families = "STM32G0/G4/L4/L4+/L5/WB/WL";
231 static const struct stm32l4_rev stm32_415_revs[] = {
232 { 0x1000, "1" }, { 0x1001, "2" }, { 0x1003, "3" }, { 0x1007, "4" }
235 static const struct stm32l4_rev stm32_435_revs[] = {
236 { 0x1000, "A" }, { 0x1001, "Z" }, { 0x2001, "Y" },
239 static const struct stm32l4_rev stm32_460_revs[] = {
240 { 0x1000, "A/Z" } /* A and Z, no typo in RM! */, { 0x2000, "B" },
243 static const struct stm32l4_rev stm32_461_revs[] = {
244 { 0x1000, "A" }, { 0x2000, "B" },
247 static const struct stm32l4_rev stm32_462_revs[] = {
248 { 0x1000, "A" }, { 0x1001, "Z" }, { 0x2001, "Y" },
251 static const struct stm32l4_rev stm32_464_revs[] = {
252 { 0x1000, "A" }, { 0x1001, "Z" }, { 0x2001, "Y" },
255 static const struct stm32l4_rev stm32_466_revs[] = {
256 { 0x1000, "A" }, { 0x1001, "Z" }, { 0x2000, "B" },
259 static const struct stm32l4_rev stm32_468_revs[] = {
260 { 0x1000, "A" }, { 0x2000, "B" }, { 0x2001, "Z" },
263 static const struct stm32l4_rev stm32_469_revs[] = {
264 { 0x1000, "A" }, { 0x2000, "B" }, { 0x2001, "Z" },
267 static const struct stm32l4_rev stm32_470_revs[] = {
268 { 0x1000, "A" }, { 0x1001, "Z" }, { 0x1003, "Y" }, { 0x100F, "W" },
271 static const struct stm32l4_rev stm32_471_revs[] = {
275 static const struct stm32l4_rev stm32_472_revs[] = {
276 { 0x1000, "A" }, { 0x2000, "B" },
279 static const struct stm32l4_rev stm32_479_revs[] = {
283 static const struct stm32l4_rev stm32_495_revs[] = {
287 static const struct stm32l4_rev stm32_496_revs[] = {
291 static const struct stm32l4_rev stm32_497_revs[] = {
295 static const struct stm32l4_part_info stm32l4_parts[] = {
298 .revs = stm32_415_revs,
299 .num_revs = ARRAY_SIZE(stm32_415_revs),
300 .device_str = "STM32L47/L48xx",
301 .max_flash_size_kb = 1024,
302 .flags = F_HAS_DUAL_BANK,
303 .flash_regs_base = 0x40022000,
304 .default_flash_regs = stm32l4_flash_regs,
305 .fsize_addr = 0x1FFF75E0,
306 .otp_base = 0x1FFF7000,
311 .revs = stm32_435_revs,
312 .num_revs = ARRAY_SIZE(stm32_435_revs),
313 .device_str = "STM32L43/L44xx",
314 .max_flash_size_kb = 256,
316 .flash_regs_base = 0x40022000,
317 .default_flash_regs = stm32l4_flash_regs,
318 .fsize_addr = 0x1FFF75E0,
319 .otp_base = 0x1FFF7000,
324 .revs = stm32_460_revs,
325 .num_revs = ARRAY_SIZE(stm32_460_revs),
326 .device_str = "STM32G07/G08xx",
327 .max_flash_size_kb = 128,
329 .flash_regs_base = 0x40022000,
330 .default_flash_regs = stm32l4_flash_regs,
331 .fsize_addr = 0x1FFF75E0,
332 .otp_base = 0x1FFF7000,
337 .revs = stm32_461_revs,
338 .num_revs = ARRAY_SIZE(stm32_461_revs),
339 .device_str = "STM32L49/L4Axx",
340 .max_flash_size_kb = 1024,
341 .flags = F_HAS_DUAL_BANK,
342 .flash_regs_base = 0x40022000,
343 .default_flash_regs = stm32l4_flash_regs,
344 .fsize_addr = 0x1FFF75E0,
345 .otp_base = 0x1FFF7000,
350 .revs = stm32_462_revs,
351 .num_revs = ARRAY_SIZE(stm32_462_revs),
352 .device_str = "STM32L45/L46xx",
353 .max_flash_size_kb = 512,
355 .flash_regs_base = 0x40022000,
356 .default_flash_regs = stm32l4_flash_regs,
357 .fsize_addr = 0x1FFF75E0,
358 .otp_base = 0x1FFF7000,
363 .revs = stm32_464_revs,
364 .num_revs = ARRAY_SIZE(stm32_464_revs),
365 .device_str = "STM32L41/L42xx",
366 .max_flash_size_kb = 128,
368 .flash_regs_base = 0x40022000,
369 .default_flash_regs = stm32l4_flash_regs,
370 .fsize_addr = 0x1FFF75E0,
371 .otp_base = 0x1FFF7000,
376 .revs = stm32_466_revs,
377 .num_revs = ARRAY_SIZE(stm32_466_revs),
378 .device_str = "STM32G03/G04xx",
379 .max_flash_size_kb = 64,
381 .flash_regs_base = 0x40022000,
382 .default_flash_regs = stm32l4_flash_regs,
383 .fsize_addr = 0x1FFF75E0,
384 .otp_base = 0x1FFF7000,
389 .revs = stm32_468_revs,
390 .num_revs = ARRAY_SIZE(stm32_468_revs),
391 .device_str = "STM32G43/G44xx",
392 .max_flash_size_kb = 128,
394 .flash_regs_base = 0x40022000,
395 .default_flash_regs = stm32l4_flash_regs,
396 .fsize_addr = 0x1FFF75E0,
397 .otp_base = 0x1FFF7000,
402 .revs = stm32_469_revs,
403 .num_revs = ARRAY_SIZE(stm32_469_revs),
404 .device_str = "STM32G47/G48xx",
405 .max_flash_size_kb = 512,
406 .flags = F_HAS_DUAL_BANK | F_USE_ALL_WRPXX,
407 .flash_regs_base = 0x40022000,
408 .default_flash_regs = stm32l4_flash_regs,
409 .fsize_addr = 0x1FFF75E0,
410 .otp_base = 0x1FFF7000,
415 .revs = stm32_470_revs,
416 .num_revs = ARRAY_SIZE(stm32_470_revs),
417 .device_str = "STM32L4R/L4Sxx",
418 .max_flash_size_kb = 2048,
419 .flags = F_HAS_DUAL_BANK | F_USE_ALL_WRPXX,
420 .flash_regs_base = 0x40022000,
421 .default_flash_regs = stm32l4_flash_regs,
422 .fsize_addr = 0x1FFF75E0,
423 .otp_base = 0x1FFF7000,
428 .revs = stm32_471_revs,
429 .num_revs = ARRAY_SIZE(stm32_471_revs),
430 .device_str = "STM32L4P5/L4Q5x",
431 .max_flash_size_kb = 1024,
432 .flags = F_HAS_DUAL_BANK | F_USE_ALL_WRPXX,
433 .flash_regs_base = 0x40022000,
434 .default_flash_regs = stm32l4_flash_regs,
435 .fsize_addr = 0x1FFF75E0,
436 .otp_base = 0x1FFF7000,
441 .revs = stm32_472_revs,
442 .num_revs = ARRAY_SIZE(stm32_472_revs),
443 .device_str = "STM32L55/L56xx",
444 .max_flash_size_kb = 512,
445 .flags = F_HAS_DUAL_BANK | F_USE_ALL_WRPXX | F_HAS_TZ,
446 .flash_regs_base = 0x40022000,
447 .default_flash_regs = stm32l5_ns_flash_regs,
448 .fsize_addr = 0x0BFA05E0,
449 .otp_base = 0x0BFA0000,
454 .revs = stm32_479_revs,
455 .num_revs = ARRAY_SIZE(stm32_479_revs),
456 .device_str = "STM32G49/G4Axx",
457 .max_flash_size_kb = 512,
459 .flash_regs_base = 0x40022000,
460 .default_flash_regs = stm32l4_flash_regs,
461 .fsize_addr = 0x1FFF75E0,
462 .otp_base = 0x1FFF7000,
467 .revs = stm32_495_revs,
468 .num_revs = ARRAY_SIZE(stm32_495_revs),
469 .device_str = "STM32WB5x",
470 .max_flash_size_kb = 1024,
472 .flash_regs_base = 0x58004000,
473 .default_flash_regs = stm32l4_flash_regs,
474 .fsize_addr = 0x1FFF75E0,
475 .otp_base = 0x1FFF7000,
480 .revs = stm32_496_revs,
481 .num_revs = ARRAY_SIZE(stm32_496_revs),
482 .device_str = "STM32WB3x",
483 .max_flash_size_kb = 512,
485 .flash_regs_base = 0x58004000,
486 .default_flash_regs = stm32l4_flash_regs,
487 .fsize_addr = 0x1FFF75E0,
488 .otp_base = 0x1FFF7000,
493 .revs = stm32_497_revs,
494 .num_revs = ARRAY_SIZE(stm32_497_revs),
495 .device_str = "STM32WLEx",
496 .max_flash_size_kb = 256,
498 .flash_regs_base = 0x58004000,
499 .default_flash_regs = stm32l4_flash_regs,
500 .fsize_addr = 0x1FFF75E0,
501 .otp_base = 0x1FFF7000,
506 /* flash bank stm32l4x <base> <size> 0 0 <target#> */
507 FLASH_BANK_COMMAND_HANDLER(stm32l4_flash_bank_command)
509 struct stm32l4_flash_bank *stm32l4_info;
512 return ERROR_COMMAND_SYNTAX_ERROR;
514 /* fix-up bank base address: 0 is used for normal flash memory */
516 bank->base = STM32_FLASH_BANK_BASE;
518 stm32l4_info = calloc(1, sizeof(struct stm32l4_flash_bank));
520 return ERROR_FAIL; /* Checkme: What better error to use?*/
521 bank->driver_priv = stm32l4_info;
523 /* The flash write must be aligned to a double word (8-bytes) boundary.
524 * Ask the flash infrastructure to ensure required alignment */
525 bank->write_start_alignment = bank->write_end_alignment = 8;
527 stm32l4_info->probed = false;
528 stm32l4_info->otp_enabled = false;
529 stm32l4_info->user_bank_size = bank->size;
534 /* bitmap helper extension */
540 static void bitmap_to_ranges(unsigned long *bitmap, unsigned int nbits,
541 struct range *ranges, unsigned int *ranges_count) {
543 bool last_bit = 0, cur_bit;
544 for (unsigned int i = 0; i < nbits; i++) {
545 cur_bit = test_bit(i, bitmap);
547 if (cur_bit && !last_bit) {
549 ranges[*ranges_count - 1].start = i;
550 ranges[*ranges_count - 1].end = i;
551 } else if (cur_bit && last_bit) {
552 /* update (increment) the end this range */
553 ranges[*ranges_count - 1].end = i;
560 static inline int range_print_one(struct range *range, char *str)
562 if (range->start == range->end)
563 return sprintf(str, "[%d]", range->start);
565 return sprintf(str, "[%d,%d]", range->start, range->end);
568 static char *range_print_alloc(struct range *ranges, unsigned int ranges_count)
570 /* each range will be printed like the following: [start,end]
571 * start and end, both are unsigned int, an unsigned int takes 10 characters max
572 * plus 3 characters for '[', ',' and ']'
573 * thus means each range can take maximum 23 character
574 * after each range we add a ' ' as separator and finally we need the '\0'
575 * if the ranges_count is zero we reserve one char for '\0' to return an empty string */
576 char *str = calloc(1, ranges_count * (24 * sizeof(char)) + 1);
579 for (unsigned int i = 0; i < ranges_count; i++) {
580 ptr += range_print_one(&(ranges[i]), ptr);
582 if (i < ranges_count - 1)
589 /* end of bitmap helper extension */
591 static inline bool stm32l4_is_otp(struct flash_bank *bank)
593 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
594 return bank->base == stm32l4_info->part_info->otp_base;
597 static int stm32l4_otp_enable(struct flash_bank *bank, bool enable)
599 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
601 if (!stm32l4_is_otp(bank))
604 char *op_str = enable ? "enabled" : "disabled";
606 LOG_INFO("OTP memory (bank #%d) is %s%s for write commands",
608 stm32l4_info->otp_enabled == enable ? "already " : "",
611 stm32l4_info->otp_enabled = enable;
616 static inline bool stm32l4_otp_is_enabled(struct flash_bank *bank)
618 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
619 return stm32l4_info->otp_enabled;
622 static void stm32l4_sync_rdp_tzen(struct flash_bank *bank, uint32_t optr_value)
624 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
628 if (stm32l4_info->part_info->flags & F_HAS_TZ)
629 tzen = (optr_value & FLASH_TZEN) != 0;
631 uint32_t rdp = optr_value & FLASH_RDP_MASK;
633 /* for devices without TrustZone:
634 * RDP level 0 and 2 values are to 0xAA and 0xCC
635 * Any other value corresponds to RDP level 1
636 * for devices with TrusZone:
637 * RDP level 0 and 2 values are 0xAA and 0xCC
638 * RDP level 0.5 value is 0x55 only if TZEN = 1
639 * Any other value corresponds to RDP level 1, including 0x55 if TZEN = 0
642 if (rdp != RDP_LEVEL_0 && rdp != RDP_LEVEL_2) {
643 if (!tzen || (tzen && rdp != RDP_LEVEL_0_5))
647 stm32l4_info->tzen = tzen;
648 stm32l4_info->rdp = rdp;
651 static inline uint32_t stm32l4_get_flash_reg(struct flash_bank *bank, uint32_t reg_offset)
653 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
654 return stm32l4_info->part_info->flash_regs_base + reg_offset;
657 static inline uint32_t stm32l4_get_flash_reg_by_index(struct flash_bank *bank,
658 enum stm32l4_flash_reg_index reg_index)
660 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
661 return stm32l4_get_flash_reg(bank, stm32l4_info->flash_regs[reg_index]);
664 static inline int stm32l4_read_flash_reg(struct flash_bank *bank, uint32_t reg_offset, uint32_t *value)
666 return target_read_u32(bank->target, stm32l4_get_flash_reg(bank, reg_offset), value);
669 static inline int stm32l4_read_flash_reg_by_index(struct flash_bank *bank,
670 enum stm32l4_flash_reg_index reg_index, uint32_t *value)
672 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
673 return stm32l4_read_flash_reg(bank, stm32l4_info->flash_regs[reg_index], value);
676 static inline int stm32l4_write_flash_reg(struct flash_bank *bank, uint32_t reg_offset, uint32_t value)
678 return target_write_u32(bank->target, stm32l4_get_flash_reg(bank, reg_offset), value);
681 static inline int stm32l4_write_flash_reg_by_index(struct flash_bank *bank,
682 enum stm32l4_flash_reg_index reg_index, uint32_t value)
684 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
685 return stm32l4_write_flash_reg(bank, stm32l4_info->flash_regs[reg_index], value);
688 static int stm32l4_wait_status_busy(struct flash_bank *bank, int timeout)
691 int retval = ERROR_OK;
693 /* wait for busy to clear */
695 retval = stm32l4_read_flash_reg_by_index(bank, STM32_FLASH_SR_INDEX, &status);
696 if (retval != ERROR_OK)
698 LOG_DEBUG("status: 0x%" PRIx32 "", status);
699 if ((status & FLASH_BSY) == 0)
701 if (timeout-- <= 0) {
702 LOG_ERROR("timed out waiting for flash");
708 if (status & FLASH_WRPERR) {
709 LOG_ERROR("stm32x device protected");
713 /* Clear but report errors */
714 if (status & FLASH_ERROR) {
715 if (retval == ERROR_OK)
717 /* If this operation fails, we ignore it and report the original
720 stm32l4_write_flash_reg_by_index(bank, STM32_FLASH_SR_INDEX, status & FLASH_ERROR);
726 static int stm32l4_unlock_reg(struct flash_bank *bank)
730 /* first check if not already unlocked
731 * otherwise writing on STM32_FLASH_KEYR will fail
733 int retval = stm32l4_read_flash_reg_by_index(bank, STM32_FLASH_CR_INDEX, &ctrl);
734 if (retval != ERROR_OK)
737 if ((ctrl & FLASH_LOCK) == 0)
740 /* unlock flash registers */
741 retval = stm32l4_write_flash_reg_by_index(bank, STM32_FLASH_KEYR_INDEX, KEY1);
742 if (retval != ERROR_OK)
745 retval = stm32l4_write_flash_reg_by_index(bank, STM32_FLASH_KEYR_INDEX, KEY2);
746 if (retval != ERROR_OK)
749 retval = stm32l4_read_flash_reg_by_index(bank, STM32_FLASH_CR_INDEX, &ctrl);
750 if (retval != ERROR_OK)
753 if (ctrl & FLASH_LOCK) {
754 LOG_ERROR("flash not unlocked STM32_FLASH_CR: %" PRIx32, ctrl);
755 return ERROR_TARGET_FAILURE;
761 static int stm32l4_unlock_option_reg(struct flash_bank *bank)
765 int retval = stm32l4_read_flash_reg_by_index(bank, STM32_FLASH_CR_INDEX, &ctrl);
766 if (retval != ERROR_OK)
769 if ((ctrl & FLASH_OPTLOCK) == 0)
772 /* unlock option registers */
773 retval = stm32l4_write_flash_reg_by_index(bank, STM32_FLASH_OPTKEYR_INDEX, OPTKEY1);
774 if (retval != ERROR_OK)
777 retval = stm32l4_write_flash_reg_by_index(bank, STM32_FLASH_OPTKEYR_INDEX, OPTKEY2);
778 if (retval != ERROR_OK)
781 retval = stm32l4_read_flash_reg_by_index(bank, STM32_FLASH_CR_INDEX, &ctrl);
782 if (retval != ERROR_OK)
785 if (ctrl & FLASH_OPTLOCK) {
786 LOG_ERROR("options not unlocked STM32_FLASH_CR: %" PRIx32, ctrl);
787 return ERROR_TARGET_FAILURE;
793 static int stm32l4_write_option(struct flash_bank *bank, uint32_t reg_offset,
794 uint32_t value, uint32_t mask)
799 retval = stm32l4_read_flash_reg(bank, reg_offset, &optiondata);
800 if (retval != ERROR_OK)
803 retval = stm32l4_unlock_reg(bank);
804 if (retval != ERROR_OK)
807 retval = stm32l4_unlock_option_reg(bank);
808 if (retval != ERROR_OK)
811 optiondata = (optiondata & ~mask) | (value & mask);
813 retval = stm32l4_write_flash_reg(bank, reg_offset, optiondata);
814 if (retval != ERROR_OK)
817 retval = stm32l4_write_flash_reg_by_index(bank, STM32_FLASH_CR_INDEX, FLASH_OPTSTRT);
818 if (retval != ERROR_OK)
821 retval = stm32l4_wait_status_busy(bank, FLASH_ERASE_TIMEOUT);
824 retval2 = stm32l4_write_flash_reg_by_index(bank, STM32_FLASH_CR_INDEX, FLASH_LOCK | FLASH_OPTLOCK);
826 if (retval != ERROR_OK)
832 static int stm32l4_get_one_wrpxy(struct flash_bank *bank, struct stm32l4_wrp *wrpxy,
833 enum stm32l4_flash_reg_index reg_idx, int offset)
835 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
838 wrpxy->reg_idx = reg_idx;
839 wrpxy->offset = offset;
841 ret = stm32l4_read_flash_reg_by_index(bank, wrpxy->reg_idx , &wrpxy->value);
845 wrpxy->first = (wrpxy->value & stm32l4_info->wrpxxr_mask) + wrpxy->offset;
846 wrpxy->last = ((wrpxy->value >> 16) & stm32l4_info->wrpxxr_mask) + wrpxy->offset;
847 wrpxy->used = wrpxy->first <= wrpxy->last;
852 static int stm32l4_get_all_wrpxy(struct flash_bank *bank, enum stm32_bank_id dev_bank_id,
853 struct stm32l4_wrp *wrpxy, unsigned int *n_wrp)
855 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
860 /* for single bank devices there is 2 WRP regions.
861 * for dual bank devices there is 2 WRP regions per bank,
862 * if configured as single bank only 2 WRP are usable
863 * except for STM32L4R/S/P/Q, G4 cat3, L5 ... all 4 WRP are usable
864 * note: this should be revised, if a device will have the SWAP banks option
867 int wrp2y_sectors_offset = -1; /* -1 : unused */
869 /* if bank_id is BANK1 or ALL_BANKS */
870 if (dev_bank_id != STM32_BANK2) {
871 /* get FLASH_WRP1AR */
872 ret = stm32l4_get_one_wrpxy(bank, &wrpxy[(*n_wrp)++], STM32_FLASH_WRP1AR_INDEX, 0);
877 ret = stm32l4_get_one_wrpxy(bank, &wrpxy[(*n_wrp)++], STM32_FLASH_WRP1BR_INDEX, 0);
881 /* for some devices (like STM32L4R/S) in single-bank mode, the 4 WRPxx are usable */
882 if ((stm32l4_info->part_info->flags & F_USE_ALL_WRPXX) && !stm32l4_info->dual_bank_mode)
883 wrp2y_sectors_offset = 0;
886 /* if bank_id is BANK2 or ALL_BANKS */
887 if (dev_bank_id != STM32_BANK1 && stm32l4_info->dual_bank_mode)
888 wrp2y_sectors_offset = stm32l4_info->bank1_sectors;
890 if (wrp2y_sectors_offset > -1) {
892 ret = stm32l4_get_one_wrpxy(bank, &wrpxy[(*n_wrp)++], STM32_FLASH_WRP2AR_INDEX, wrp2y_sectors_offset);
897 ret = stm32l4_get_one_wrpxy(bank, &wrpxy[(*n_wrp)++], STM32_FLASH_WRP2BR_INDEX, wrp2y_sectors_offset);
905 static int stm32l4_write_one_wrpxy(struct flash_bank *bank, struct stm32l4_wrp *wrpxy)
907 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
909 int wrp_start = wrpxy->first - wrpxy->offset;
910 int wrp_end = wrpxy->last - wrpxy->offset;
912 uint32_t wrp_value = (wrp_start & stm32l4_info->wrpxxr_mask) | ((wrp_end & stm32l4_info->wrpxxr_mask) << 16);
914 return stm32l4_write_option(bank, stm32l4_info->flash_regs[wrpxy->reg_idx], wrp_value, 0xffffffff);
917 static int stm32l4_write_all_wrpxy(struct flash_bank *bank, struct stm32l4_wrp *wrpxy, unsigned int n_wrp)
921 for (unsigned int i = 0; i < n_wrp; i++) {
922 ret = stm32l4_write_one_wrpxy(bank, &wrpxy[i]);
930 static int stm32l4_protect_check(struct flash_bank *bank)
933 struct stm32l4_wrp wrpxy[4];
935 int ret = stm32l4_get_all_wrpxy(bank, STM32_ALL_BANKS, wrpxy, &n_wrp);
939 /* initialize all sectors as unprotected */
940 for (unsigned int i = 0; i < bank->num_sectors; i++)
941 bank->sectors[i].is_protected = 0;
943 /* now check WRPxy and mark the protected sectors */
944 for (unsigned int i = 0; i < n_wrp; i++) {
946 for (int s = wrpxy[i].first; s <= wrpxy[i].last; s++)
947 bank->sectors[s].is_protected = 1;
954 static int stm32l4_erase(struct flash_bank *bank, unsigned int first,
957 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
960 assert((first <= last) && (last < bank->num_sectors));
962 if (stm32l4_is_otp(bank)) {
963 LOG_ERROR("cannot erase OTP memory");
964 return ERROR_FLASH_OPER_UNSUPPORTED;
967 if (bank->target->state != TARGET_HALTED) {
968 LOG_ERROR("Target not halted");
969 return ERROR_TARGET_NOT_HALTED;
972 retval = stm32l4_unlock_reg(bank);
973 if (retval != ERROR_OK)
978 To erase a sector, follow the procedure below:
979 1. Check that no Flash memory operation is ongoing by
980 checking the BSY bit in the FLASH_SR register
981 2. Set the PER bit and select the page and bank
982 you wish to erase in the FLASH_CR register
983 3. Set the STRT bit in the FLASH_CR register
984 4. Wait for the BSY bit to be cleared
987 for (unsigned int i = first; i <= last; i++) {
988 uint32_t erase_flags;
989 erase_flags = FLASH_PER | FLASH_STRT;
991 if (i >= stm32l4_info->bank1_sectors) {
993 snb = i - stm32l4_info->bank1_sectors;
994 erase_flags |= snb << FLASH_PAGE_SHIFT | FLASH_CR_BKER;
996 erase_flags |= i << FLASH_PAGE_SHIFT;
997 retval = stm32l4_write_flash_reg_by_index(bank, STM32_FLASH_CR_INDEX, erase_flags);
998 if (retval != ERROR_OK)
1001 retval = stm32l4_wait_status_busy(bank, FLASH_ERASE_TIMEOUT);
1002 if (retval != ERROR_OK)
1005 bank->sectors[i].is_erased = 1;
1009 retval2 = stm32l4_write_flash_reg_by_index(bank, STM32_FLASH_CR_INDEX, FLASH_LOCK);
1011 if (retval != ERROR_OK)
1017 static int stm32l4_protect(struct flash_bank *bank, int set, unsigned int first, unsigned int last)
1019 struct target *target = bank->target;
1020 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
1024 if (stm32l4_is_otp(bank)) {
1025 LOG_ERROR("cannot protect/unprotect OTP memory");
1026 return ERROR_FLASH_OPER_UNSUPPORTED;
1029 if (target->state != TARGET_HALTED) {
1030 LOG_ERROR("Target not halted");
1031 return ERROR_TARGET_NOT_HALTED;
1034 /* the requested sectors could be located into bank1 and/or bank2 */
1035 bool use_bank2 = false;
1036 if (last >= stm32l4_info->bank1_sectors) {
1037 if (first < stm32l4_info->bank1_sectors) {
1038 /* the requested sectors for (un)protection are shared between
1039 * bank 1 and 2, then split the operation */
1041 /* 1- deal with bank 1 sectors */
1042 LOG_DEBUG("The requested sectors for %s are shared between bank 1 and 2",
1043 set ? "protection" : "unprotection");
1044 ret = stm32l4_protect(bank, set, first, stm32l4_info->bank1_sectors - 1);
1045 if (ret != ERROR_OK)
1048 /* 2- then continue with bank 2 sectors */
1049 first = stm32l4_info->bank1_sectors;
1055 /* refresh the sectors' protection */
1056 ret = stm32l4_protect_check(bank);
1057 if (ret != ERROR_OK)
1060 /* check if the desired protection is already configured */
1061 for (i = first; i <= last; i++) {
1062 if (bank->sectors[i].is_protected != set)
1064 else if (i == last) {
1065 LOG_INFO("The specified sectors are already %s", set ? "protected" : "unprotected");
1070 /* all sectors from first to last (or part of them) could have different
1071 * protection other than the requested */
1073 struct stm32l4_wrp wrpxy[4];
1075 ret = stm32l4_get_all_wrpxy(bank, use_bank2 ? STM32_BANK2 : STM32_BANK1, wrpxy, &n_wrp);
1076 if (ret != ERROR_OK)
1079 /* use bitmap and range helpers to optimize the WRP usage */
1080 DECLARE_BITMAP(pages, bank->num_sectors);
1081 bitmap_zero(pages, bank->num_sectors);
1083 for (i = 0; i < n_wrp; i++) {
1084 if (wrpxy[i].used) {
1085 for (int p = wrpxy[i].first; p <= wrpxy[i].last; p++)
1090 /* we have at most 'n_wrp' WRP areas
1091 * add one range if the user is trying to protect a fifth range */
1092 struct range ranges[n_wrp + 1];
1093 unsigned int ranges_count = 0;
1095 bitmap_to_ranges(pages, bank->num_sectors, ranges, &ranges_count);
1097 /* pretty-print the currently protected ranges */
1098 if (ranges_count > 0) {
1099 char *ranges_str = range_print_alloc(ranges, ranges_count);
1100 LOG_DEBUG("current protected areas: %s", ranges_str);
1103 LOG_DEBUG("current protected areas: none");
1105 if (set) { /* flash protect */
1106 for (i = first; i <= last; i++)
1108 } else { /* flash unprotect */
1109 for (i = first; i <= last; i++)
1110 clear_bit(i, pages);
1113 /* check the ranges_count after the user request */
1114 bitmap_to_ranges(pages, bank->num_sectors, ranges, &ranges_count);
1116 /* pretty-print the requested areas for protection */
1117 if (ranges_count > 0) {
1118 char *ranges_str = range_print_alloc(ranges, ranges_count);
1119 LOG_DEBUG("requested areas for protection: %s", ranges_str);
1122 LOG_DEBUG("requested areas for protection: none");
1124 if (ranges_count > n_wrp) {
1125 LOG_ERROR("cannot set the requested protection "
1126 "(only %u write protection areas are available)" , n_wrp);
1130 /* re-init all WRPxy as disabled (first > last)*/
1131 for (i = 0; i < n_wrp; i++) {
1132 wrpxy[i].first = wrpxy[i].offset + 1;
1133 wrpxy[i].last = wrpxy[i].offset;
1136 /* then configure WRPxy areas */
1137 for (i = 0; i < ranges_count; i++) {
1138 wrpxy[i].first = ranges[i].start;
1139 wrpxy[i].last = ranges[i].end;
1142 /* finally write WRPxy registers */
1143 return stm32l4_write_all_wrpxy(bank, wrpxy, n_wrp);
1146 /* Count is in double-words */
1147 static int stm32l4_write_block(struct flash_bank *bank, const uint8_t *buffer,
1148 uint32_t offset, uint32_t count)
1150 struct target *target = bank->target;
1151 uint32_t buffer_size;
1152 struct working_area *write_algorithm;
1153 struct working_area *source;
1154 uint32_t address = bank->base + offset;
1155 struct reg_param reg_params[6];
1156 struct armv7m_algorithm armv7m_info;
1157 int retval = ERROR_OK;
1159 static const uint8_t stm32l4_flash_write_code[] = {
1160 #include "../../../contrib/loaders/flash/stm32/stm32l4x.inc"
1163 if (target_alloc_working_area(target, sizeof(stm32l4_flash_write_code),
1164 &write_algorithm) != ERROR_OK) {
1165 LOG_WARNING("no working area available, can't do block memory writes");
1166 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1169 retval = target_write_buffer(target, write_algorithm->address,
1170 sizeof(stm32l4_flash_write_code),
1171 stm32l4_flash_write_code);
1172 if (retval != ERROR_OK) {
1173 target_free_working_area(target, write_algorithm);
1177 /* memory buffer, size *must* be multiple of dword plus one dword for rp and one for wp */
1178 buffer_size = target_get_working_area_avail(target) & ~(2 * sizeof(uint32_t) - 1);
1179 if (buffer_size < 256) {
1180 LOG_WARNING("large enough working area not available, can't do block memory writes");
1181 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1182 } else if (buffer_size > 16384) {
1183 /* probably won't benefit from more than 16k ... */
1184 buffer_size = 16384;
1187 if (target_alloc_working_area_try(target, buffer_size, &source) != ERROR_OK) {
1188 LOG_ERROR("allocating working area failed");
1189 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1192 armv7m_info.common_magic = ARMV7M_COMMON_MAGIC;
1193 armv7m_info.core_mode = ARM_MODE_THREAD;
1195 init_reg_param(®_params[0], "r0", 32, PARAM_IN_OUT); /* buffer start, status (out) */
1196 init_reg_param(®_params[1], "r1", 32, PARAM_OUT); /* buffer end */
1197 init_reg_param(®_params[2], "r2", 32, PARAM_OUT); /* target address */
1198 init_reg_param(®_params[3], "r3", 32, PARAM_OUT); /* count (double word-64bit) */
1199 init_reg_param(®_params[4], "r4", 32, PARAM_OUT); /* flash status register */
1200 init_reg_param(®_params[5], "r5", 32, PARAM_OUT); /* flash control register */
1202 buf_set_u32(reg_params[0].value, 0, 32, source->address);
1203 buf_set_u32(reg_params[1].value, 0, 32, source->address + source->size);
1204 buf_set_u32(reg_params[2].value, 0, 32, address);
1205 buf_set_u32(reg_params[3].value, 0, 32, count);
1206 buf_set_u32(reg_params[4].value, 0, 32, stm32l4_get_flash_reg_by_index(bank, STM32_FLASH_SR_INDEX));
1207 buf_set_u32(reg_params[5].value, 0, 32, stm32l4_get_flash_reg_by_index(bank, STM32_FLASH_CR_INDEX));
1209 retval = target_run_flash_async_algorithm(target, buffer, count, 8,
1211 ARRAY_SIZE(reg_params), reg_params,
1212 source->address, source->size,
1213 write_algorithm->address, 0,
1216 if (retval == ERROR_FLASH_OPERATION_FAILED) {
1217 LOG_ERROR("error executing stm32l4 flash write algorithm");
1219 uint32_t error = buf_get_u32(reg_params[0].value, 0, 32) & FLASH_ERROR;
1221 if (error & FLASH_WRPERR)
1222 LOG_ERROR("flash memory write protected");
1225 LOG_ERROR("flash write failed = %08" PRIx32, error);
1226 /* Clear but report errors */
1227 stm32l4_write_flash_reg_by_index(bank, STM32_FLASH_SR_INDEX, error);
1228 retval = ERROR_FAIL;
1232 target_free_working_area(target, source);
1233 target_free_working_area(target, write_algorithm);
1235 destroy_reg_param(®_params[0]);
1236 destroy_reg_param(®_params[1]);
1237 destroy_reg_param(®_params[2]);
1238 destroy_reg_param(®_params[3]);
1239 destroy_reg_param(®_params[4]);
1240 destroy_reg_param(®_params[5]);
1245 static int stm32l4_write(struct flash_bank *bank, const uint8_t *buffer,
1246 uint32_t offset, uint32_t count)
1248 int retval = ERROR_OK, retval2;
1250 if (stm32l4_is_otp(bank) && !stm32l4_otp_is_enabled(bank)) {
1251 LOG_ERROR("OTP memory is disabled for write commands");
1255 if (bank->target->state != TARGET_HALTED) {
1256 LOG_ERROR("Target not halted");
1257 return ERROR_TARGET_NOT_HALTED;
1260 /* The flash write must be aligned to a double word (8-bytes) boundary.
1261 * The flash infrastructure ensures it, do just a security check */
1262 assert(offset % 8 == 0);
1263 assert(count % 8 == 0);
1265 /* STM32G4xxx Cat. 3 devices may have gaps between banks, check whether
1266 * data to be written does not go into a gap:
1267 * suppose buffer is fully contained in bank from sector 0 to sector
1268 * num->sectors - 1 and sectors are ordered according to offset
1270 struct flash_sector *head = &bank->sectors[0];
1271 struct flash_sector *tail = &bank->sectors[bank->num_sectors - 1];
1273 while ((head < tail) && (offset >= (head + 1)->offset)) {
1274 /* buffer does not intersect head nor gap behind head */
1278 while ((head < tail) && (offset + count <= (tail - 1)->offset + (tail - 1)->size)) {
1279 /* buffer does not intersect tail nor gap before tail */
1283 LOG_DEBUG("data: 0x%08" PRIx32 " - 0x%08" PRIx32 ", sectors: 0x%08" PRIx32 " - 0x%08" PRIx32,
1284 offset, offset + count - 1, head->offset, tail->offset + tail->size - 1);
1286 /* Now check that there is no gap from head to tail, this should work
1287 * even for multiple or non-symmetric gaps
1289 while (head < tail) {
1290 if (head->offset + head->size != (head + 1)->offset) {
1291 LOG_ERROR("write into gap from " TARGET_ADDR_FMT " to " TARGET_ADDR_FMT,
1292 bank->base + head->offset + head->size,
1293 bank->base + (head + 1)->offset - 1);
1294 retval = ERROR_FLASH_DST_OUT_OF_BANK;
1299 if (retval != ERROR_OK)
1302 retval = stm32l4_unlock_reg(bank);
1303 if (retval != ERROR_OK)
1306 retval = stm32l4_write_block(bank, buffer, offset, count / 8);
1309 retval2 = stm32l4_write_flash_reg_by_index(bank, STM32_FLASH_CR_INDEX, FLASH_LOCK);
1311 if (retval != ERROR_OK) {
1312 LOG_ERROR("block write failed");
1318 static int stm32l4_read_idcode(struct flash_bank *bank, uint32_t *id)
1322 /* try reading possible IDCODE registers, in the following order */
1323 uint32_t DBGMCU_IDCODE[] = {DBGMCU_IDCODE_L4_G4, DBGMCU_IDCODE_G0, DBGMCU_IDCODE_L5};
1325 for (unsigned int i = 0; i < ARRAY_SIZE(DBGMCU_IDCODE); i++) {
1326 retval = target_read_u32(bank->target, DBGMCU_IDCODE[i], id);
1327 if ((retval == ERROR_OK) && ((*id & 0xfff) != 0) && ((*id & 0xfff) != 0xfff))
1331 LOG_ERROR("can't get the device id");
1332 return (retval == ERROR_OK) ? ERROR_FAIL : retval;
1335 static int stm32l4_probe(struct flash_bank *bank)
1337 struct target *target = bank->target;
1338 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
1339 const struct stm32l4_part_info *part_info;
1340 uint16_t flash_size_kb = 0xffff;
1344 stm32l4_info->probed = false;
1346 /* read stm32 device id registers */
1347 int retval = stm32l4_read_idcode(bank, &stm32l4_info->idcode);
1348 if (retval != ERROR_OK)
1351 device_id = stm32l4_info->idcode & 0xFFF;
1353 for (unsigned int n = 0; n < ARRAY_SIZE(stm32l4_parts); n++) {
1354 if (device_id == stm32l4_parts[n].id)
1355 stm32l4_info->part_info = &stm32l4_parts[n];
1358 if (!stm32l4_info->part_info) {
1359 LOG_WARNING("Cannot identify target as an %s family device.", device_families);
1363 part_info = stm32l4_info->part_info;
1364 stm32l4_info->flash_regs = stm32l4_info->part_info->default_flash_regs;
1366 char device_info[1024];
1367 retval = bank->driver->info(bank, device_info, sizeof(device_info));
1368 if (retval != ERROR_OK)
1371 LOG_INFO("device idcode = 0x%08" PRIx32 " (%s)", stm32l4_info->idcode, device_info);
1373 /* read flash option register */
1374 retval = stm32l4_read_flash_reg_by_index(bank, STM32_FLASH_OPTR_INDEX, &options);
1375 if (retval != ERROR_OK)
1378 stm32l4_sync_rdp_tzen(bank, options);
1380 if (part_info->flags & F_HAS_TZ)
1381 LOG_INFO("TZEN = %d : TrustZone %s by option bytes",
1383 stm32l4_info->tzen ? "enabled" : "disabled");
1385 LOG_INFO("RDP level %s (0x%02X)",
1386 stm32l4_info->rdp == RDP_LEVEL_0 ? "0" : stm32l4_info->rdp == RDP_LEVEL_0_5 ? "0.5" : "1",
1389 if (stm32l4_is_otp(bank)) {
1390 bank->size = part_info->otp_size;
1392 LOG_INFO("OTP size is %d bytes, base address is " TARGET_ADDR_FMT, bank->size, bank->base);
1394 /* OTP memory is considered as one sector */
1395 free(bank->sectors);
1396 bank->num_sectors = 1;
1397 bank->sectors = alloc_block_array(0, part_info->otp_size, 1);
1399 if (!bank->sectors) {
1400 LOG_ERROR("failed to allocate bank sectors");
1404 stm32l4_info->probed = true;
1406 } else if (bank->base != STM32_FLASH_BANK_BASE) {
1407 LOG_ERROR("invalid bank base address");
1411 /* get flash size from target. */
1412 retval = target_read_u16(target, part_info->fsize_addr, &flash_size_kb);
1414 /* failed reading flash size or flash size invalid (early silicon),
1415 * default to max target family */
1416 if (retval != ERROR_OK || flash_size_kb == 0xffff || flash_size_kb == 0
1417 || flash_size_kb > part_info->max_flash_size_kb) {
1418 LOG_WARNING("STM32 flash size failed, probe inaccurate - assuming %dk flash",
1419 part_info->max_flash_size_kb);
1420 flash_size_kb = part_info->max_flash_size_kb;
1423 /* if the user sets the size manually then ignore the probed value
1424 * this allows us to work around devices that have a invalid flash size register value */
1425 if (stm32l4_info->user_bank_size) {
1426 LOG_WARNING("overriding size register by configured bank size - MAY CAUSE TROUBLE");
1427 flash_size_kb = stm32l4_info->user_bank_size / 1024;
1430 LOG_INFO("flash size = %dkbytes", flash_size_kb);
1432 /* did we assign a flash size? */
1433 assert((flash_size_kb != 0xffff) && flash_size_kb);
1435 stm32l4_info->bank1_sectors = 0;
1436 stm32l4_info->hole_sectors = 0;
1439 int page_size_kb = 0;
1441 stm32l4_info->dual_bank_mode = false;
1442 bool use_dbank_bit = false;
1444 switch (device_id) {
1445 case 0x415: /* STM32L47/L48xx */
1446 case 0x461: /* STM32L49/L4Axx */
1447 /* if flash size is max (1M) the device is always dual bank
1448 * 0x415: has variants with 512K
1449 * 0x461: has variants with 512 and 256
1450 * for these variants:
1451 * if DUAL_BANK = 0 -> single bank
1452 * else -> dual bank without gap
1453 * note: the page size is invariant
1456 num_pages = flash_size_kb / page_size_kb;
1457 stm32l4_info->bank1_sectors = num_pages;
1459 /* check DUAL_BANK bit[21] if the flash is less than 1M */
1460 if (flash_size_kb == 1024 || (options & BIT(21))) {
1461 stm32l4_info->dual_bank_mode = true;
1462 stm32l4_info->bank1_sectors = num_pages / 2;
1465 case 0x435: /* STM32L43/L44xx */
1466 case 0x460: /* STM32G07/G08xx */
1467 case 0x462: /* STM32L45/L46xx */
1468 case 0x464: /* STM32L41/L42xx */
1469 case 0x466: /* STM32G03/G04xx */
1470 case 0x468: /* STM32G43/G44xx */
1471 case 0x479: /* STM32G49/G4Axx */
1472 case 0x497: /* STM32WLEx */
1473 /* single bank flash */
1475 num_pages = flash_size_kb / page_size_kb;
1476 stm32l4_info->bank1_sectors = num_pages;
1478 case 0x469: /* STM32G47/G48xx */
1479 /* STM32G47/8 can be single/dual bank:
1480 * if DUAL_BANK = 0 -> single bank
1481 * else -> dual bank WITH gap
1484 num_pages = flash_size_kb / page_size_kb;
1485 stm32l4_info->bank1_sectors = num_pages;
1486 if (options & BIT(22)) {
1487 stm32l4_info->dual_bank_mode = true;
1489 num_pages = flash_size_kb / page_size_kb;
1490 stm32l4_info->bank1_sectors = num_pages / 2;
1492 /* for devices with trimmed flash, there is a gap between both banks */
1493 stm32l4_info->hole_sectors =
1494 (part_info->max_flash_size_kb - flash_size_kb) / (2 * page_size_kb);
1497 case 0x470: /* STM32L4R/L4Sxx */
1498 case 0x471: /* STM32L4P5/L4Q5x */
1499 /* STM32L4R/S can be single/dual bank:
1500 * if size = 2M check DBANK bit(22)
1501 * if size = 1M check DB1M bit(21)
1502 * STM32L4P/Q can be single/dual bank
1503 * if size = 1M check DBANK bit(22)
1504 * if size = 512K check DB512K bit(21)
1507 num_pages = flash_size_kb / page_size_kb;
1508 stm32l4_info->bank1_sectors = num_pages;
1509 use_dbank_bit = flash_size_kb == part_info->max_flash_size_kb;
1510 if ((use_dbank_bit && (options & BIT(22))) ||
1511 (!use_dbank_bit && (options & BIT(21)))) {
1512 stm32l4_info->dual_bank_mode = true;
1514 num_pages = flash_size_kb / page_size_kb;
1515 stm32l4_info->bank1_sectors = num_pages / 2;
1518 case 0x472: /* STM32L55/L56xx */
1519 /* STM32L55/L56xx can be single/dual bank:
1520 * if size = 512K check DBANK bit(22)
1521 * if size = 256K check DB256K bit(21)
1524 num_pages = flash_size_kb / page_size_kb;
1525 stm32l4_info->bank1_sectors = num_pages;
1526 use_dbank_bit = flash_size_kb == part_info->max_flash_size_kb;
1527 if ((use_dbank_bit && (options & BIT(22))) ||
1528 (!use_dbank_bit && (options & BIT(21)))) {
1529 stm32l4_info->dual_bank_mode = true;
1531 num_pages = flash_size_kb / page_size_kb;
1532 stm32l4_info->bank1_sectors = num_pages / 2;
1535 case 0x495: /* STM32WB5x */
1536 case 0x496: /* STM32WB3x */
1537 /* single bank flash */
1539 num_pages = flash_size_kb / page_size_kb;
1540 stm32l4_info->bank1_sectors = num_pages;
1543 LOG_ERROR("unsupported device");
1547 LOG_INFO("flash mode : %s-bank", stm32l4_info->dual_bank_mode ? "dual" : "single");
1549 const int gap_size_kb = stm32l4_info->hole_sectors * page_size_kb;
1551 if (gap_size_kb != 0) {
1552 LOG_INFO("gap detected from 0x%08x to 0x%08x",
1553 STM32_FLASH_BANK_BASE + stm32l4_info->bank1_sectors
1554 * page_size_kb * 1024,
1555 STM32_FLASH_BANK_BASE + (stm32l4_info->bank1_sectors
1556 * page_size_kb + gap_size_kb) * 1024 - 1);
1559 /* number of significant bits in WRPxxR differs per device,
1560 * always right adjusted, on some devices non-implemented
1561 * bits read as '0', on others as '1' ...
1562 * notably G4 Cat. 2 implement only 6 bits, contradicting the RM
1565 /* use *max_flash_size* instead of actual size as the trimmed versions
1566 * certainly use the same number of bits
1567 * max_flash_size is always power of two, so max_pages too
1569 uint32_t max_pages = stm32l4_info->part_info->max_flash_size_kb / page_size_kb;
1570 assert((max_pages & (max_pages - 1)) == 0);
1572 /* in dual bank mode number of pages is doubled, but extra bit is bank selection */
1573 stm32l4_info->wrpxxr_mask = ((max_pages >> (stm32l4_info->dual_bank_mode ? 1 : 0)) - 1);
1574 assert((stm32l4_info->wrpxxr_mask & 0xFFFF0000) == 0);
1575 LOG_DEBUG("WRPxxR mask 0x%04" PRIx16, (uint16_t)stm32l4_info->wrpxxr_mask);
1577 free(bank->sectors);
1579 bank->size = (flash_size_kb + gap_size_kb) * 1024;
1580 bank->num_sectors = num_pages;
1581 bank->sectors = malloc(sizeof(struct flash_sector) * bank->num_sectors);
1582 if (bank->sectors == NULL) {
1583 LOG_ERROR("failed to allocate bank sectors");
1587 for (unsigned int i = 0; i < bank->num_sectors; i++) {
1588 bank->sectors[i].offset = i * page_size_kb * 1024;
1589 /* in dual bank configuration, if there is a gap between banks
1590 * we fix up the sector offset to consider this gap */
1591 if (i >= stm32l4_info->bank1_sectors && stm32l4_info->hole_sectors)
1592 bank->sectors[i].offset += gap_size_kb * 1024;
1593 bank->sectors[i].size = page_size_kb * 1024;
1594 bank->sectors[i].is_erased = -1;
1595 bank->sectors[i].is_protected = 1;
1598 stm32l4_info->probed = true;
1602 static int stm32l4_auto_probe(struct flash_bank *bank)
1604 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
1605 if (stm32l4_info->probed)
1608 return stm32l4_probe(bank);
1611 static int get_stm32l4_info(struct flash_bank *bank, char *buf, int buf_size)
1613 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
1614 const struct stm32l4_part_info *part_info = stm32l4_info->part_info;
1617 const char *rev_str = NULL;
1618 uint16_t rev_id = stm32l4_info->idcode >> 16;
1619 for (unsigned int i = 0; i < part_info->num_revs; i++) {
1620 if (rev_id == part_info->revs[i].rev) {
1621 rev_str = part_info->revs[i].str;
1626 int buf_len = snprintf(buf, buf_size, "%s - Rev %s : 0x%04x",
1627 part_info->device_str, rev_str ? rev_str : "'unknown'", rev_id);
1629 if (stm32l4_info->probed)
1630 snprintf(buf + buf_len, buf_size - buf_len, " - %s-bank",
1631 stm32l4_is_otp(bank) ? "OTP" :
1632 stm32l4_info->dual_bank_mode ? "Flash dual" : "Flash single");
1636 snprintf(buf, buf_size, "Cannot identify target as an %s device", device_families);
1643 static int stm32l4_mass_erase(struct flash_bank *bank)
1645 int retval, retval2;
1646 struct target *target = bank->target;
1647 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
1649 if (stm32l4_is_otp(bank)) {
1650 LOG_ERROR("cannot erase OTP memory");
1651 return ERROR_FLASH_OPER_UNSUPPORTED;
1654 uint32_t action = FLASH_MER1;
1656 if (stm32l4_info->part_info->flags & F_HAS_DUAL_BANK)
1657 action |= FLASH_MER2;
1659 if (target->state != TARGET_HALTED) {
1660 LOG_ERROR("Target not halted");
1661 return ERROR_TARGET_NOT_HALTED;
1664 retval = stm32l4_unlock_reg(bank);
1665 if (retval != ERROR_OK)
1668 /* mass erase flash memory */
1669 retval = stm32l4_wait_status_busy(bank, FLASH_ERASE_TIMEOUT / 10);
1670 if (retval != ERROR_OK)
1673 retval = stm32l4_write_flash_reg_by_index(bank, STM32_FLASH_CR_INDEX, action);
1674 if (retval != ERROR_OK)
1677 retval = stm32l4_write_flash_reg_by_index(bank, STM32_FLASH_CR_INDEX, action | FLASH_STRT);
1678 if (retval != ERROR_OK)
1681 retval = stm32l4_wait_status_busy(bank, FLASH_ERASE_TIMEOUT);
1684 retval2 = stm32l4_write_flash_reg_by_index(bank, STM32_FLASH_CR_INDEX, FLASH_LOCK);
1686 if (retval != ERROR_OK)
1692 COMMAND_HANDLER(stm32l4_handle_mass_erase_command)
1695 command_print(CMD, "stm32l4x mass_erase <STM32L4 bank>");
1696 return ERROR_COMMAND_SYNTAX_ERROR;
1699 struct flash_bank *bank;
1700 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
1701 if (ERROR_OK != retval)
1704 retval = stm32l4_mass_erase(bank);
1705 if (retval == ERROR_OK) {
1706 /* set all sectors as erased */
1707 for (unsigned int i = 0; i < bank->num_sectors; i++)
1708 bank->sectors[i].is_erased = 1;
1710 command_print(CMD, "stm32l4x mass erase complete");
1712 command_print(CMD, "stm32l4x mass erase failed");
1718 COMMAND_HANDLER(stm32l4_handle_option_read_command)
1721 command_print(CMD, "stm32l4x option_read <STM32L4 bank> <option_reg offset>");
1722 return ERROR_COMMAND_SYNTAX_ERROR;
1725 struct flash_bank *bank;
1726 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
1727 if (ERROR_OK != retval)
1730 uint32_t reg_offset, reg_addr;
1733 reg_offset = strtoul(CMD_ARGV[1], NULL, 16);
1734 reg_addr = stm32l4_get_flash_reg(bank, reg_offset);
1736 retval = stm32l4_read_flash_reg(bank, reg_offset, &value);
1737 if (ERROR_OK != retval)
1740 command_print(CMD, "Option Register: <0x%" PRIx32 "> = 0x%" PRIx32 "", reg_addr, value);
1745 COMMAND_HANDLER(stm32l4_handle_option_write_command)
1748 command_print(CMD, "stm32l4x option_write <STM32L4 bank> <option_reg offset> <value> [mask]");
1749 return ERROR_COMMAND_SYNTAX_ERROR;
1752 struct flash_bank *bank;
1753 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
1754 if (ERROR_OK != retval)
1757 uint32_t reg_offset;
1759 uint32_t mask = 0xFFFFFFFF;
1761 reg_offset = strtoul(CMD_ARGV[1], NULL, 16);
1762 value = strtoul(CMD_ARGV[2], NULL, 16);
1764 mask = strtoul(CMD_ARGV[3], NULL, 16);
1766 command_print(CMD, "%s Option written.\n"
1767 "INFO: a reset or power cycle is required "
1768 "for the new settings to take effect.", bank->driver->name);
1770 retval = stm32l4_write_option(bank, reg_offset, value, mask);
1774 COMMAND_HANDLER(stm32l4_handle_option_load_command)
1777 return ERROR_COMMAND_SYNTAX_ERROR;
1779 struct flash_bank *bank;
1780 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
1781 if (ERROR_OK != retval)
1784 retval = stm32l4_unlock_reg(bank);
1785 if (ERROR_OK != retval)
1788 retval = stm32l4_unlock_option_reg(bank);
1789 if (ERROR_OK != retval)
1792 /* Set OBL_LAUNCH bit in CR -> system reset and option bytes reload,
1793 * but the RMs explicitly do *NOT* list this as power-on reset cause, and:
1794 * "Note: If the read protection is set while the debugger is still
1795 * connected through JTAG/SWD, apply a POR (power-on reset) instead of a system reset."
1797 retval = stm32l4_write_flash_reg_by_index(bank, STM32_FLASH_CR_INDEX, FLASH_OBL_LAUNCH);
1799 command_print(CMD, "stm32l4x option load completed. Power-on reset might be required");
1801 /* Need to re-probe after change */
1802 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
1803 stm32l4_info->probed = false;
1808 COMMAND_HANDLER(stm32l4_handle_lock_command)
1810 struct target *target = NULL;
1813 return ERROR_COMMAND_SYNTAX_ERROR;
1815 struct flash_bank *bank;
1816 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
1817 if (ERROR_OK != retval)
1820 if (stm32l4_is_otp(bank)) {
1821 LOG_ERROR("cannot lock/unlock OTP memory");
1822 return ERROR_FLASH_OPER_UNSUPPORTED;
1825 target = bank->target;
1827 if (target->state != TARGET_HALTED) {
1828 LOG_ERROR("Target not halted");
1829 return ERROR_TARGET_NOT_HALTED;
1832 /* set readout protection level 1 by erasing the RDP option byte */
1833 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
1834 if (stm32l4_write_option(bank, stm32l4_info->flash_regs[STM32_FLASH_OPTR_INDEX],
1835 RDP_LEVEL_1, FLASH_RDP_MASK) != ERROR_OK) {
1836 command_print(CMD, "%s failed to lock device", bank->driver->name);
1843 COMMAND_HANDLER(stm32l4_handle_unlock_command)
1845 struct target *target = NULL;
1848 return ERROR_COMMAND_SYNTAX_ERROR;
1850 struct flash_bank *bank;
1851 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
1852 if (ERROR_OK != retval)
1855 if (stm32l4_is_otp(bank)) {
1856 LOG_ERROR("cannot lock/unlock OTP memory");
1857 return ERROR_FLASH_OPER_UNSUPPORTED;
1860 target = bank->target;
1862 if (target->state != TARGET_HALTED) {
1863 LOG_ERROR("Target not halted");
1864 return ERROR_TARGET_NOT_HALTED;
1867 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
1868 if (stm32l4_write_option(bank, stm32l4_info->flash_regs[STM32_FLASH_OPTR_INDEX],
1869 RDP_LEVEL_0, FLASH_RDP_MASK) != ERROR_OK) {
1870 command_print(CMD, "%s failed to unlock device", bank->driver->name);
1877 COMMAND_HANDLER(stm32l4_handle_wrp_info_command)
1879 if (CMD_ARGC < 1 || CMD_ARGC > 2)
1880 return ERROR_COMMAND_SYNTAX_ERROR;
1882 struct flash_bank *bank;
1883 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
1884 if (ERROR_OK != retval)
1887 if (stm32l4_is_otp(bank)) {
1888 LOG_ERROR("OTP memory does not have write protection areas");
1889 return ERROR_FLASH_OPER_UNSUPPORTED;
1892 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
1893 enum stm32_bank_id dev_bank_id = STM32_ALL_BANKS;
1894 if (CMD_ARGC == 2) {
1895 if (strcmp(CMD_ARGV[1], "bank1") == 0)
1896 dev_bank_id = STM32_BANK1;
1897 else if (strcmp(CMD_ARGV[1], "bank2") == 0)
1898 dev_bank_id = STM32_BANK2;
1900 return ERROR_COMMAND_ARGUMENT_INVALID;
1903 if (dev_bank_id == STM32_BANK2) {
1904 if (!(stm32l4_info->part_info->flags & F_HAS_DUAL_BANK)) {
1905 LOG_ERROR("this device has no second bank");
1907 } else if (!stm32l4_info->dual_bank_mode) {
1908 LOG_ERROR("this device is configured in single bank mode");
1914 unsigned int n_wrp, i;
1915 struct stm32l4_wrp wrpxy[4];
1917 ret = stm32l4_get_all_wrpxy(bank, dev_bank_id, wrpxy, &n_wrp);
1918 if (ret != ERROR_OK)
1921 /* use bitmap and range helpers to better describe protected areas */
1922 DECLARE_BITMAP(pages, bank->num_sectors);
1923 bitmap_zero(pages, bank->num_sectors);
1925 for (i = 0; i < n_wrp; i++) {
1926 if (wrpxy[i].used) {
1927 for (int p = wrpxy[i].first; p <= wrpxy[i].last; p++)
1932 /* we have at most 'n_wrp' WRP areas */
1933 struct range ranges[n_wrp];
1934 unsigned int ranges_count = 0;
1936 bitmap_to_ranges(pages, bank->num_sectors, ranges, &ranges_count);
1938 if (ranges_count > 0) {
1939 /* pretty-print the protected ranges */
1940 char *ranges_str = range_print_alloc(ranges, ranges_count);
1941 command_print(CMD, "protected areas: %s", ranges_str);
1944 command_print(CMD, "no protected areas");
1949 COMMAND_HANDLER(stm32l4_handle_otp_command)
1952 return ERROR_COMMAND_SYNTAX_ERROR;
1954 struct flash_bank *bank;
1955 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
1956 if (ERROR_OK != retval)
1959 if (!stm32l4_is_otp(bank)) {
1960 command_print(CMD, "the specified bank is not an OTP memory");
1963 if (strcmp(CMD_ARGV[1], "enable") == 0)
1964 stm32l4_otp_enable(bank, true);
1965 else if (strcmp(CMD_ARGV[1], "disable") == 0)
1966 stm32l4_otp_enable(bank, false);
1967 else if (strcmp(CMD_ARGV[1], "show") == 0)
1968 command_print(CMD, "OTP memory bank #%d is %s for write commands.",
1969 bank->bank_number, stm32l4_otp_is_enabled(bank) ? "enabled" : "disabled");
1971 return ERROR_COMMAND_SYNTAX_ERROR;
1976 static const struct command_registration stm32l4_exec_command_handlers[] = {
1979 .handler = stm32l4_handle_lock_command,
1980 .mode = COMMAND_EXEC,
1982 .help = "Lock entire flash device.",
1986 .handler = stm32l4_handle_unlock_command,
1987 .mode = COMMAND_EXEC,
1989 .help = "Unlock entire protected flash device.",
1992 .name = "mass_erase",
1993 .handler = stm32l4_handle_mass_erase_command,
1994 .mode = COMMAND_EXEC,
1996 .help = "Erase entire flash device.",
1999 .name = "option_read",
2000 .handler = stm32l4_handle_option_read_command,
2001 .mode = COMMAND_EXEC,
2002 .usage = "bank_id reg_offset",
2003 .help = "Read & Display device option bytes.",
2006 .name = "option_write",
2007 .handler = stm32l4_handle_option_write_command,
2008 .mode = COMMAND_EXEC,
2009 .usage = "bank_id reg_offset value mask",
2010 .help = "Write device option bit fields with provided value.",
2014 .handler = stm32l4_handle_wrp_info_command,
2015 .mode = COMMAND_EXEC,
2016 .usage = "bank_id [bank1|bank2]",
2017 .help = "list the protected areas using WRP",
2020 .name = "option_load",
2021 .handler = stm32l4_handle_option_load_command,
2022 .mode = COMMAND_EXEC,
2024 .help = "Force re-load of device options (will cause device reset).",
2028 .handler = stm32l4_handle_otp_command,
2029 .mode = COMMAND_EXEC,
2030 .usage = "<bank_id> <enable|disable|show>",
2031 .help = "OTP (One Time Programmable) memory write enable/disable",
2033 COMMAND_REGISTRATION_DONE
2036 static const struct command_registration stm32l4_command_handlers[] = {
2039 .mode = COMMAND_ANY,
2040 .help = "stm32l4x flash command group",
2042 .chain = stm32l4_exec_command_handlers,
2044 COMMAND_REGISTRATION_DONE
2047 const struct flash_driver stm32l4x_flash = {
2049 .commands = stm32l4_command_handlers,
2050 .flash_bank_command = stm32l4_flash_bank_command,
2051 .erase = stm32l4_erase,
2052 .protect = stm32l4_protect,
2053 .write = stm32l4_write,
2054 .read = default_flash_read,
2055 .probe = stm32l4_probe,
2056 .auto_probe = stm32l4_auto_probe,
2057 .erase_check = default_flash_blank_check,
2058 .protect_check = stm32l4_protect_check,
2059 .info = get_stm32l4_info,
2060 .free_driver_priv = default_flash_free_driver_priv,