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>
32 /* STM32L4xxx series for reference.
34 * RM0351 (STM32L4x5/STM32L4x6)
35 * http://www.st.com/resource/en/reference_manual/dm00083560.pdf
37 * RM0394 (STM32L43x/44x/45x/46x)
38 * http://www.st.com/resource/en/reference_manual/dm00151940.pdf
40 * RM0432 (STM32L4R/4Sxx)
41 * http://www.st.com/resource/en/reference_manual/dm00310109.pdf
43 * STM32L476RG Datasheet (for erase timing)
44 * http://www.st.com/resource/en/datasheet/stm32l476rg.pdf
46 * The RM0351 devices have normally two banks, but on 512 and 256 kiB devices
47 * an option byte is available to map all sectors to the first bank.
48 * Both STM32 banks are treated as one OpenOCD bank, as other STM32 devices
51 * RM0394 devices have a single bank only.
53 * RM0432 devices have single and dual bank operating modes.
54 * The FLASH size is 1Mbyte or 2Mbyte.
55 * Bank page (sector) size is 4Kbyte (dual mode) or 8Kbyte (single mode).
57 * Bank mode is controlled by two different bits in option bytes register.
58 * In 2M FLASH devices bit 22 (DBANK) controls Dual Bank mode.
59 * In 1M FLASH devices bit 21 (DB1M) controls Dual Bank mode.
63 /* Erase time can be as high as 25ms, 10x this and assume it's toast... */
65 #define FLASH_ERASE_TIMEOUT 250
67 /* Flash registers offsets */
68 #define STM32_FLASH_ACR 0x00
69 #define STM32_FLASH_KEYR 0x08
70 #define STM32_FLASH_OPTKEYR 0x0c
71 #define STM32_FLASH_SR 0x10
72 #define STM32_FLASH_CR 0x14
73 #define STM32_FLASH_OPTR 0x20
74 #define STM32_FLASH_WRP1AR 0x2c
75 #define STM32_FLASH_WRP1BR 0x30
76 #define STM32_FLASH_WRP2AR 0x4c
77 #define STM32_FLASH_WRP2BR 0x50
79 /* FLASH_CR register bits */
80 #define FLASH_PG (1 << 0)
81 #define FLASH_PER (1 << 1)
82 #define FLASH_MER1 (1 << 2)
83 #define FLASH_PAGE_SHIFT 3
84 #define FLASH_CR_BKER (1 << 11)
85 #define FLASH_MER2 (1 << 15)
86 #define FLASH_STRT (1 << 16)
87 #define FLASH_OPTSTRT (1 << 17)
88 #define FLASH_EOPIE (1 << 24)
89 #define FLASH_ERRIE (1 << 25)
90 #define FLASH_OBLLAUNCH (1 << 27)
91 #define FLASH_OPTLOCK (1 << 30)
92 #define FLASH_LOCK (1 << 31)
94 /* FLASH_SR register bits */
95 #define FLASH_BSY (1 << 16)
96 /* Fast programming not used => related errors not used*/
97 #define FLASH_PGSERR (1 << 7) /* Programming sequence error */
98 #define FLASH_SIZERR (1 << 6) /* Size error */
99 #define FLASH_PGAERR (1 << 5) /* Programming alignment error */
100 #define FLASH_WRPERR (1 << 4) /* Write protection error */
101 #define FLASH_PROGERR (1 << 3) /* Programming error */
102 #define FLASH_OPERR (1 << 1) /* Operation error */
103 #define FLASH_EOP (1 << 0) /* End of operation */
104 #define FLASH_ERROR (FLASH_PGSERR | FLASH_PGSERR | FLASH_PGAERR | FLASH_WRPERR | FLASH_OPERR)
106 /* register unlock keys */
107 #define KEY1 0x45670123
108 #define KEY2 0xCDEF89AB
110 /* option register unlock key */
111 #define OPTKEY1 0x08192A3B
112 #define OPTKEY2 0x4C5D6E7F
114 #define RDP_LEVEL_0 0xAA
115 #define RDP_LEVEL_1 0xBB
116 #define RDP_LEVEL_2 0xCC
119 /* other registers */
120 #define DBGMCU_IDCODE 0xE0042000
128 struct stm32l4_part_info {
130 const char *device_str;
131 const struct stm32l4_rev *revs;
132 const size_t num_revs;
133 const uint16_t max_flash_size_kb;
134 const bool has_dual_bank;
135 const uint32_t flash_regs_base;
136 const uint32_t fsize_addr;
139 struct stm32l4_flash_bank {
145 const struct stm32l4_part_info *part_info;
148 static const struct stm32l4_rev stm32_415_revs[] = {
149 { 0x1000, "1" }, { 0x1001, "2" }, { 0x1003, "3" }, { 0x1007, "4" }
152 static const struct stm32l4_rev stm32_435_revs[] = {
153 { 0x1000, "A" }, { 0x1001, "Z" }, { 0x2001, "Y" },
156 static const struct stm32l4_rev stm32_461_revs[] = {
157 { 0x1000, "A" }, { 0x2000, "B" },
160 static const struct stm32l4_rev stm32_462_revs[] = {
161 { 0x1000, "A" }, { 0x1001, "Z" }, { 0x2001, "Y" },
164 static const struct stm32l4_rev stm32_464_revs[] = {
168 static const struct stm32l4_rev stm32_470_revs[] = {
169 { 0x1000, "A" }, { 0x1001, "Z" }, { 0x1003, "Y" }, { 0x100F, "W" },
172 static const struct stm32l4_rev stm32_495_revs[] = {
176 static const struct stm32l4_part_info stm32l4_parts[] = {
179 .revs = stm32_415_revs,
180 .num_revs = ARRAY_SIZE(stm32_415_revs),
181 .device_str = "STM32L47/L48xx",
182 .max_flash_size_kb = 1024,
183 .has_dual_bank = true,
184 .flash_regs_base = 0x40022000,
185 .fsize_addr = 0x1FFF75E0,
189 .revs = stm32_435_revs,
190 .num_revs = ARRAY_SIZE(stm32_435_revs),
191 .device_str = "STM32L43/L44xx",
192 .max_flash_size_kb = 256,
193 .has_dual_bank = false,
194 .flash_regs_base = 0x40022000,
195 .fsize_addr = 0x1FFF75E0,
199 .revs = stm32_461_revs,
200 .num_revs = ARRAY_SIZE(stm32_461_revs),
201 .device_str = "STM32L49/L4Axx",
202 .max_flash_size_kb = 1024,
203 .has_dual_bank = true,
204 .flash_regs_base = 0x40022000,
205 .fsize_addr = 0x1FFF75E0,
209 .revs = stm32_462_revs,
210 .num_revs = ARRAY_SIZE(stm32_462_revs),
211 .device_str = "STM32L45/L46xx",
212 .max_flash_size_kb = 512,
213 .has_dual_bank = false,
214 .flash_regs_base = 0x40022000,
215 .fsize_addr = 0x1FFF75E0,
219 .revs = stm32_464_revs,
220 .num_revs = ARRAY_SIZE(stm32_464_revs),
221 .device_str = "STM32L41/L42xx",
222 .max_flash_size_kb = 128,
223 .has_dual_bank = false,
224 .flash_regs_base = 0x40022000,
225 .fsize_addr = 0x1FFF75E0,
229 .revs = stm32_470_revs,
230 .num_revs = ARRAY_SIZE(stm32_470_revs),
231 .device_str = "STM32L4R/L4Sxx",
232 .max_flash_size_kb = 2048,
233 .has_dual_bank = true,
234 .flash_regs_base = 0x40022000,
235 .fsize_addr = 0x1FFF75E0,
239 .revs = stm32_495_revs,
240 .num_revs = ARRAY_SIZE(stm32_495_revs),
241 .device_str = "STM32WB5x",
242 .max_flash_size_kb = 1024,
243 .has_dual_bank = false,
244 .flash_regs_base = 0x58004000,
245 .fsize_addr = 0x1FFF75E0,
249 /* flash bank stm32l4x <base> <size> 0 0 <target#> */
250 FLASH_BANK_COMMAND_HANDLER(stm32l4_flash_bank_command)
252 struct stm32l4_flash_bank *stm32l4_info;
255 return ERROR_COMMAND_SYNTAX_ERROR;
257 stm32l4_info = malloc(sizeof(struct stm32l4_flash_bank));
259 return ERROR_FAIL; /* Checkme: What better error to use?*/
260 bank->driver_priv = stm32l4_info;
262 stm32l4_info->probed = 0;
267 static inline uint32_t stm32l4_get_flash_reg(struct flash_bank *bank, uint32_t reg_offset)
269 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
270 return stm32l4_info->part_info->flash_regs_base + reg_offset;
273 static inline int stm32l4_read_flash_reg(struct flash_bank *bank, uint32_t reg_offset, uint32_t *value)
275 return target_read_u32(bank->target, stm32l4_get_flash_reg(bank, reg_offset), value);
278 static inline int stm32l4_write_flash_reg(struct flash_bank *bank, uint32_t reg_offset, uint32_t value)
280 return target_write_u32(bank->target, stm32l4_get_flash_reg(bank, reg_offset), value);
283 static int stm32l4_wait_status_busy(struct flash_bank *bank, int timeout)
286 int retval = ERROR_OK;
288 /* wait for busy to clear */
290 retval = stm32l4_read_flash_reg(bank, STM32_FLASH_SR, &status);
291 if (retval != ERROR_OK)
293 LOG_DEBUG("status: 0x%" PRIx32 "", status);
294 if ((status & FLASH_BSY) == 0)
296 if (timeout-- <= 0) {
297 LOG_ERROR("timed out waiting for flash");
304 if (status & FLASH_WRPERR) {
305 LOG_ERROR("stm32x device protected");
309 /* Clear but report errors */
310 if (status & FLASH_ERROR) {
311 if (retval == ERROR_OK)
313 /* If this operation fails, we ignore it and report the original
316 stm32l4_write_flash_reg(bank, STM32_FLASH_SR, status & FLASH_ERROR);
322 static int stm32l4_unlock_reg(struct flash_bank *bank)
326 /* first check if not already unlocked
327 * otherwise writing on STM32_FLASH_KEYR will fail
329 int retval = stm32l4_read_flash_reg(bank, STM32_FLASH_CR, &ctrl);
330 if (retval != ERROR_OK)
333 if ((ctrl & FLASH_LOCK) == 0)
336 /* unlock flash registers */
337 retval = stm32l4_write_flash_reg(bank, STM32_FLASH_KEYR, KEY1);
338 if (retval != ERROR_OK)
341 retval = stm32l4_write_flash_reg(bank, STM32_FLASH_KEYR, KEY2);
342 if (retval != ERROR_OK)
345 retval = stm32l4_read_flash_reg(bank, STM32_FLASH_CR, &ctrl);
346 if (retval != ERROR_OK)
349 if (ctrl & FLASH_LOCK) {
350 LOG_ERROR("flash not unlocked STM32_FLASH_CR: %" PRIx32, ctrl);
351 return ERROR_TARGET_FAILURE;
357 static int stm32l4_unlock_option_reg(struct flash_bank *bank)
361 int retval = stm32l4_read_flash_reg(bank, STM32_FLASH_CR, &ctrl);
362 if (retval != ERROR_OK)
365 if ((ctrl & FLASH_OPTLOCK) == 0)
368 /* unlock option registers */
369 retval = stm32l4_write_flash_reg(bank, STM32_FLASH_OPTKEYR, OPTKEY1);
370 if (retval != ERROR_OK)
373 retval = stm32l4_write_flash_reg(bank, STM32_FLASH_OPTKEYR, OPTKEY2);
374 if (retval != ERROR_OK)
377 retval = stm32l4_read_flash_reg(bank, STM32_FLASH_CR, &ctrl);
378 if (retval != ERROR_OK)
381 if (ctrl & FLASH_OPTLOCK) {
382 LOG_ERROR("options not unlocked STM32_FLASH_CR: %" PRIx32, ctrl);
383 return ERROR_TARGET_FAILURE;
389 static int stm32l4_write_option(struct flash_bank *bank, uint32_t reg_offset, uint32_t value, uint32_t mask)
393 int retval = stm32l4_read_flash_reg(bank, reg_offset, &optiondata);
394 if (retval != ERROR_OK)
397 retval = stm32l4_unlock_reg(bank);
398 if (retval != ERROR_OK)
401 retval = stm32l4_unlock_option_reg(bank);
402 if (retval != ERROR_OK)
405 optiondata = (optiondata & ~mask) | (value & mask);
407 retval = stm32l4_write_flash_reg(bank, reg_offset, optiondata);
408 if (retval != ERROR_OK)
411 retval = stm32l4_write_flash_reg(bank, STM32_FLASH_CR, FLASH_OPTSTRT);
412 if (retval != ERROR_OK)
415 retval = stm32l4_wait_status_busy(bank, FLASH_ERASE_TIMEOUT);
416 if (retval != ERROR_OK)
422 static int stm32l4_protect_check(struct flash_bank *bank)
424 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
426 uint32_t wrp1ar, wrp1br, wrp2ar, wrp2br;
427 stm32l4_read_flash_reg(bank, STM32_FLASH_WRP1AR, &wrp1ar);
428 stm32l4_read_flash_reg(bank, STM32_FLASH_WRP1BR, &wrp1br);
429 stm32l4_read_flash_reg(bank, STM32_FLASH_WRP2AR, &wrp2ar);
430 stm32l4_read_flash_reg(bank, STM32_FLASH_WRP2BR, &wrp2br);
432 const uint8_t wrp1a_start = wrp1ar & 0xFF;
433 const uint8_t wrp1a_end = (wrp1ar >> 16) & 0xFF;
434 const uint8_t wrp1b_start = wrp1br & 0xFF;
435 const uint8_t wrp1b_end = (wrp1br >> 16) & 0xFF;
436 const uint8_t wrp2a_start = wrp2ar & 0xFF;
437 const uint8_t wrp2a_end = (wrp2ar >> 16) & 0xFF;
438 const uint8_t wrp2b_start = wrp2br & 0xFF;
439 const uint8_t wrp2b_end = (wrp2br >> 16) & 0xFF;
441 for (int i = 0; i < bank->num_sectors; i++) {
442 if (i < stm32l4_info->bank1_sectors) {
443 if (((i >= wrp1a_start) &&
445 ((i >= wrp1b_start) &&
447 bank->sectors[i].is_protected = 1;
449 bank->sectors[i].is_protected = 0;
452 snb = i - stm32l4_info->bank1_sectors;
453 if (((snb >= wrp2a_start) &&
454 (snb <= wrp2a_end)) ||
455 ((snb >= wrp2b_start) &&
457 bank->sectors[i].is_protected = 1;
459 bank->sectors[i].is_protected = 0;
465 static int stm32l4_erase(struct flash_bank *bank, int first, int last)
467 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
471 assert(first < bank->num_sectors);
472 assert(last < bank->num_sectors);
474 if (bank->target->state != TARGET_HALTED) {
475 LOG_ERROR("Target not halted");
476 return ERROR_TARGET_NOT_HALTED;
479 retval = stm32l4_unlock_reg(bank);
480 if (retval != ERROR_OK)
485 To erase a sector, follow the procedure below:
486 1. Check that no Flash memory operation is ongoing by
487 checking the BSY bit in the FLASH_SR register
488 2. Set the PER bit and select the page and bank
489 you wish to erase in the FLASH_CR register
490 3. Set the STRT bit in the FLASH_CR register
491 4. Wait for the BSY bit to be cleared
494 for (i = first; i <= last; i++) {
495 uint32_t erase_flags;
496 erase_flags = FLASH_PER | FLASH_STRT;
498 if (i >= stm32l4_info->bank1_sectors) {
500 snb = i - stm32l4_info->bank1_sectors;
501 erase_flags |= snb << FLASH_PAGE_SHIFT | FLASH_CR_BKER;
503 erase_flags |= i << FLASH_PAGE_SHIFT;
504 retval = stm32l4_write_flash_reg(bank, STM32_FLASH_CR, erase_flags);
505 if (retval != ERROR_OK)
508 retval = stm32l4_wait_status_busy(bank, FLASH_ERASE_TIMEOUT);
509 if (retval != ERROR_OK)
512 bank->sectors[i].is_erased = 1;
515 retval = stm32l4_write_flash_reg(bank, STM32_FLASH_CR, FLASH_LOCK);
516 if (retval != ERROR_OK)
522 static int stm32l4_protect(struct flash_bank *bank, int set, int first, int last)
524 struct target *target = bank->target;
525 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
527 if (target->state != TARGET_HALTED) {
528 LOG_ERROR("Target not halted");
529 return ERROR_TARGET_NOT_HALTED;
534 uint32_t reg_value = 0xFF; /* Default to bank un-protected */
535 if (last >= stm32l4_info->bank1_sectors) {
537 uint8_t begin = first > stm32l4_info->bank1_sectors ? first : 0x00;
538 reg_value = ((last & 0xFF) << 16) | begin;
541 ret = stm32l4_write_option(bank, STM32_FLASH_WRP2AR, reg_value, 0xffffffff);
544 reg_value = 0xFF; /* Default to bank un-protected */
545 if (first < stm32l4_info->bank1_sectors) {
547 uint8_t end = last >= stm32l4_info->bank1_sectors ? 0xFF : last;
548 reg_value = (end << 16) | (first & 0xFF);
551 ret = stm32l4_write_option(bank, STM32_FLASH_WRP1AR, reg_value, 0xffffffff);
557 /* Count is in halfwords */
558 static int stm32l4_write_block(struct flash_bank *bank, const uint8_t *buffer,
559 uint32_t offset, uint32_t count)
561 struct target *target = bank->target;
562 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
563 uint32_t buffer_size = 16384;
564 struct working_area *write_algorithm;
565 struct working_area *source;
566 uint32_t address = bank->base + offset;
567 struct reg_param reg_params[5];
568 struct armv7m_algorithm armv7m_info;
569 int retval = ERROR_OK;
571 static const uint8_t stm32l4_flash_write_code[] = {
572 #include "../../../contrib/loaders/flash/stm32/stm32l4x.inc"
575 if (target_alloc_working_area(target, sizeof(stm32l4_flash_write_code),
576 &write_algorithm) != ERROR_OK) {
577 LOG_WARNING("no working area available, can't do block memory writes");
578 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
581 retval = target_write_buffer(target, write_algorithm->address,
582 sizeof(stm32l4_flash_write_code),
583 stm32l4_flash_write_code);
584 if (retval != ERROR_OK) {
585 target_free_working_area(target, write_algorithm);
590 while (target_alloc_working_area_try(target, buffer_size, &source) !=
593 if (buffer_size <= 256) {
594 /* we already allocated the writing code, but failed to get a
595 * buffer, free the algorithm */
596 target_free_working_area(target, write_algorithm);
598 LOG_WARNING("large enough working area not available, can't do block memory writes");
599 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
603 armv7m_info.common_magic = ARMV7M_COMMON_MAGIC;
604 armv7m_info.core_mode = ARM_MODE_THREAD;
606 init_reg_param(®_params[0], "r0", 32, PARAM_IN_OUT); /* buffer start, status (out) */
607 init_reg_param(®_params[1], "r1", 32, PARAM_OUT); /* buffer end */
608 init_reg_param(®_params[2], "r2", 32, PARAM_OUT); /* target address */
609 init_reg_param(®_params[3], "r3", 32, PARAM_OUT); /* count (double word-64bit) */
610 init_reg_param(®_params[4], "r4", 32, PARAM_OUT); /* flash base */
612 buf_set_u32(reg_params[0].value, 0, 32, source->address);
613 buf_set_u32(reg_params[1].value, 0, 32, source->address + source->size);
614 buf_set_u32(reg_params[2].value, 0, 32, address);
615 buf_set_u32(reg_params[3].value, 0, 32, count / 4);
616 buf_set_u32(reg_params[4].value, 0, 32, stm32l4_info->part_info->flash_regs_base);
618 retval = target_run_flash_async_algorithm(target, buffer, count, 2,
621 source->address, source->size,
622 write_algorithm->address, 0,
625 if (retval == ERROR_FLASH_OPERATION_FAILED) {
626 LOG_ERROR("error executing stm32l4 flash write algorithm");
628 uint32_t error = buf_get_u32(reg_params[0].value, 0, 32) & FLASH_ERROR;
630 if (error & FLASH_WRPERR)
631 LOG_ERROR("flash memory write protected");
634 LOG_ERROR("flash write failed = %08" PRIx32, error);
635 /* Clear but report errors */
636 stm32l4_write_flash_reg(bank, STM32_FLASH_SR, error);
641 target_free_working_area(target, source);
642 target_free_working_area(target, write_algorithm);
644 destroy_reg_param(®_params[0]);
645 destroy_reg_param(®_params[1]);
646 destroy_reg_param(®_params[2]);
647 destroy_reg_param(®_params[3]);
648 destroy_reg_param(®_params[4]);
653 static int stm32l4_write(struct flash_bank *bank, const uint8_t *buffer,
654 uint32_t offset, uint32_t count)
658 if (bank->target->state != TARGET_HALTED) {
659 LOG_ERROR("Target not halted");
660 return ERROR_TARGET_NOT_HALTED;
664 LOG_WARNING("offset 0x%" PRIx32 " breaks required 8-byte alignment",
666 return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
670 LOG_WARNING("Padding %d bytes to keep 8-byte write size",
672 count = (count + 7) & ~7;
673 /* This pads the write chunk with random bytes by overrunning the
674 * write buffer. Padding with the erased pattern 0xff is purely
675 * cosmetical, as 8-byte flash words are ECC secured and the first
676 * write will program the ECC bits. A second write would need
677 * to reprogramm these ECC bits.
678 * But this can only be done after erase!
682 retval = stm32l4_unlock_reg(bank);
683 if (retval != ERROR_OK)
686 /* Only full double words (8-byte) can be programmed*/
687 retval = stm32l4_write_block(bank, buffer, offset, count / 2);
688 if (retval != ERROR_OK) {
689 LOG_WARNING("block write failed");
693 LOG_WARNING("block write succeeded");
694 return stm32l4_write_flash_reg(bank, STM32_FLASH_CR, FLASH_LOCK);
697 static int stm32l4_read_idcode(struct flash_bank *bank, uint32_t *id)
699 int retval = target_read_u32(bank->target, DBGMCU_IDCODE, id);
700 if (retval != ERROR_OK)
706 static int stm32l4_probe(struct flash_bank *bank)
708 struct target *target = bank->target;
709 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
710 const struct stm32l4_part_info *part_info;
712 uint16_t flash_size_in_kb = 0xffff;
716 stm32l4_info->probed = 0;
718 /* read stm32 device id register */
719 int retval = stm32l4_read_idcode(bank, &stm32l4_info->idcode);
720 if (retval != ERROR_OK)
723 device_id = stm32l4_info->idcode & 0xFFF;
725 for (unsigned int n = 0; n < ARRAY_SIZE(stm32l4_parts); n++) {
726 if (device_id == stm32l4_parts[n].id)
727 stm32l4_info->part_info = &stm32l4_parts[n];
730 if (!stm32l4_info->part_info) {
731 LOG_WARNING("Cannot identify target as an STM32 L4 or WB family device.");
735 part_info = stm32l4_info->part_info;
737 char device_info[1024];
738 retval = bank->driver->info(bank, device_info, sizeof(device_info));
739 if (retval != ERROR_OK)
742 LOG_INFO("device idcode = 0x%08" PRIx32 " (%s)", stm32l4_info->idcode, device_info);
744 /* get flash size from target. */
745 retval = target_read_u16(target, part_info->fsize_addr, &flash_size_in_kb);
747 /* failed reading flash size or flash size invalid (early silicon),
748 * default to max target family */
749 if (retval != ERROR_OK || flash_size_in_kb == 0xffff || flash_size_in_kb == 0
750 || flash_size_in_kb > part_info->max_flash_size_kb) {
751 LOG_WARNING("STM32 flash size failed, probe inaccurate - assuming %dk flash",
752 part_info->max_flash_size_kb);
753 flash_size_in_kb = part_info->max_flash_size_kb;
756 LOG_INFO("flash size = %dkbytes", flash_size_in_kb);
758 /* did we assign a flash size? */
759 assert((flash_size_in_kb != 0xffff) && flash_size_in_kb);
761 /* read flash option register */
762 retval = stm32l4_read_flash_reg(bank, STM32_FLASH_OPTR, &options);
763 if (retval != ERROR_OK)
766 stm32l4_info->bank1_sectors = 0;
767 stm32l4_info->hole_sectors = 0;
772 stm32l4_info->dual_bank_mode = false;
777 /* if flash size is max (1M) the device is always dual bank
778 * 0x415: has variants with 512K
779 * 0x461: has variants with 512 and 256
780 * for these variants:
781 * if DUAL_BANK = 0 -> single bank
782 * else -> dual bank without gap
783 * note: the page size is invariant
786 num_pages = flash_size_in_kb / 2;
787 stm32l4_info->bank1_sectors = num_pages;
789 /* check DUAL_BANK bit[21] if the flash is less than 1M */
790 if (flash_size_in_kb == 1024 || (options & BIT(21))) {
791 stm32l4_info->dual_bank_mode = true;
792 stm32l4_info->bank1_sectors = num_pages / 2;
798 /* single bank flash */
800 num_pages = flash_size_in_kb / 2;
801 stm32l4_info->bank1_sectors = num_pages;
804 /* STM32L4R/S can be single/dual bank:
805 * if size = 2M check DBANK bit(22)
806 * if size = 1M check DB1M bit(21)
807 * in single bank configuration the page size is 8K
808 * else (dual bank) the page size is 4K without gap between banks
811 num_pages = flash_size_in_kb / 8;
812 stm32l4_info->bank1_sectors = num_pages;
813 if ((flash_size_in_kb == 2048 && (options & BIT(22))) ||
814 (flash_size_in_kb == 1024 && (options & BIT(21)))) {
815 stm32l4_info->dual_bank_mode = true;
817 num_pages = flash_size_in_kb / 4;
818 stm32l4_info->bank1_sectors = num_pages / 2;
822 /* single bank flash */
824 num_pages = flash_size_in_kb / 4;
825 stm32l4_info->bank1_sectors = num_pages;
828 LOG_ERROR("unsupported device");
832 LOG_INFO("flash mode : %s-bank", stm32l4_info->dual_bank_mode ? "dual" : "single");
834 const int gap_size = stm32l4_info->hole_sectors * page_size;
836 if (stm32l4_info->dual_bank_mode & gap_size) {
837 LOG_INFO("gap detected starting from %0x08" PRIx32 " to %0x08" PRIx32,
838 0x8000000 + stm32l4_info->bank1_sectors * page_size,
839 0x8000000 + stm32l4_info->bank1_sectors * page_size + gap_size);
844 bank->sectors = NULL;
847 bank->size = flash_size_in_kb * 1024 + gap_size;
848 bank->base = 0x08000000;
849 bank->num_sectors = num_pages;
850 bank->sectors = malloc(sizeof(struct flash_sector) * bank->num_sectors);
851 if (bank->sectors == NULL) {
852 LOG_ERROR("failed to allocate bank sectors");
856 for (i = 0; i < bank->num_sectors; i++) {
857 bank->sectors[i].offset = i * page_size;
858 /* in dual bank configuration, if there is a gap between banks
859 * we fix up the sector offset to consider this gap */
860 if (i >= stm32l4_info->bank1_sectors && stm32l4_info->hole_sectors)
861 bank->sectors[i].offset += gap_size;
862 bank->sectors[i].size = page_size;
863 bank->sectors[i].is_erased = -1;
864 bank->sectors[i].is_protected = 1;
867 stm32l4_info->probed = 1;
871 static int stm32l4_auto_probe(struct flash_bank *bank)
873 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
874 if (stm32l4_info->probed)
877 return stm32l4_probe(bank);
880 static int get_stm32l4_info(struct flash_bank *bank, char *buf, int buf_size)
882 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
883 const struct stm32l4_part_info *part_info = stm32l4_info->part_info;
886 const char *rev_str = NULL;
887 uint16_t rev_id = stm32l4_info->idcode >> 16;
888 for (unsigned int i = 0; i < part_info->num_revs; i++) {
889 if (rev_id == part_info->revs[i].rev) {
890 rev_str = part_info->revs[i].str;
892 if (rev_str != NULL) {
893 snprintf(buf, buf_size, "%s - Rev: %s",
894 part_info->device_str, rev_str);
900 snprintf(buf, buf_size, "%s - Rev: unknown (0x%04x)",
901 part_info->device_str, rev_id);
904 snprintf(buf, buf_size, "Cannot identify target as an STM32 L4 or WB device");
911 static int stm32l4_mass_erase(struct flash_bank *bank)
914 struct target *target = bank->target;
915 struct stm32l4_flash_bank *stm32l4_info = bank->driver_priv;
917 uint32_t action = FLASH_MER1;
919 if (stm32l4_info->part_info->has_dual_bank)
920 action |= FLASH_MER2;
922 if (target->state != TARGET_HALTED) {
923 LOG_ERROR("Target not halted");
924 return ERROR_TARGET_NOT_HALTED;
927 retval = stm32l4_unlock_reg(bank);
928 if (retval != ERROR_OK)
931 /* mass erase flash memory */
932 retval = stm32l4_wait_status_busy(bank, FLASH_ERASE_TIMEOUT / 10);
933 if (retval != ERROR_OK)
936 retval = stm32l4_write_flash_reg(bank, STM32_FLASH_CR, action);
937 if (retval != ERROR_OK)
939 retval = stm32l4_write_flash_reg(bank, STM32_FLASH_CR, action | FLASH_STRT);
940 if (retval != ERROR_OK)
943 retval = stm32l4_wait_status_busy(bank, FLASH_ERASE_TIMEOUT);
944 if (retval != ERROR_OK)
947 retval = stm32l4_write_flash_reg(bank, STM32_FLASH_CR, FLASH_LOCK);
948 if (retval != ERROR_OK)
954 COMMAND_HANDLER(stm32l4_handle_mass_erase_command)
959 command_print(CMD, "stm32l4x mass_erase <STM32L4 bank>");
960 return ERROR_COMMAND_SYNTAX_ERROR;
963 struct flash_bank *bank;
964 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
965 if (ERROR_OK != retval)
968 retval = stm32l4_mass_erase(bank);
969 if (retval == ERROR_OK) {
970 /* set all sectors as erased */
971 for (i = 0; i < bank->num_sectors; i++)
972 bank->sectors[i].is_erased = 1;
974 command_print(CMD, "stm32l4x mass erase complete");
976 command_print(CMD, "stm32l4x mass erase failed");
982 COMMAND_HANDLER(stm32l4_handle_option_read_command)
985 command_print(CMD, "stm32l4x option_read <STM32L4 bank> <option_reg offset>");
986 return ERROR_COMMAND_SYNTAX_ERROR;
989 struct flash_bank *bank;
990 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
991 if (ERROR_OK != retval)
994 uint32_t reg_offset, reg_addr;
997 reg_offset = strtoul(CMD_ARGV[1], NULL, 16);
998 reg_addr = stm32l4_get_flash_reg(bank, reg_offset);
1000 retval = stm32l4_read_flash_reg(bank, reg_offset, &value);
1001 if (ERROR_OK != retval)
1004 command_print(CMD, "Option Register: <0x%" PRIx32 "> = 0x%" PRIx32 "", reg_addr, value);
1009 COMMAND_HANDLER(stm32l4_handle_option_write_command)
1012 command_print(CMD, "stm32l4x option_write <STM32L4 bank> <option_reg offset> <value> [mask]");
1013 return ERROR_COMMAND_SYNTAX_ERROR;
1016 struct flash_bank *bank;
1017 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
1018 if (ERROR_OK != retval)
1021 uint32_t reg_offset;
1023 uint32_t mask = 0xFFFFFFFF;
1025 reg_offset = strtoul(CMD_ARGV[1], NULL, 16);
1026 value = strtoul(CMD_ARGV[2], NULL, 16);
1028 mask = strtoul(CMD_ARGV[3], NULL, 16);
1030 command_print(CMD, "%s Option written.\n"
1031 "INFO: a reset or power cycle is required "
1032 "for the new settings to take effect.", bank->driver->name);
1034 retval = stm32l4_write_option(bank, reg_offset, value, mask);
1038 COMMAND_HANDLER(stm32l4_handle_option_load_command)
1041 return ERROR_COMMAND_SYNTAX_ERROR;
1043 struct flash_bank *bank;
1044 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
1045 if (ERROR_OK != retval)
1048 retval = stm32l4_unlock_reg(bank);
1049 if (ERROR_OK != retval)
1052 retval = stm32l4_unlock_option_reg(bank);
1053 if (ERROR_OK != retval)
1056 /* Write the OBLLAUNCH bit in CR -> Cause device "POR" and option bytes reload */
1057 retval = stm32l4_write_flash_reg(bank, STM32_FLASH_CR, FLASH_OBLLAUNCH);
1059 command_print(CMD, "stm32l4x option load (POR) completed.");
1063 COMMAND_HANDLER(stm32l4_handle_lock_command)
1065 struct target *target = NULL;
1068 return ERROR_COMMAND_SYNTAX_ERROR;
1070 struct flash_bank *bank;
1071 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
1072 if (ERROR_OK != retval)
1075 target = bank->target;
1077 if (target->state != TARGET_HALTED) {
1078 LOG_ERROR("Target not halted");
1079 return ERROR_TARGET_NOT_HALTED;
1082 /* set readout protection level 1 by erasing the RDP option byte */
1083 if (stm32l4_write_option(bank, STM32_FLASH_OPTR, 0, 0x000000FF) != ERROR_OK) {
1084 command_print(CMD, "%s failed to lock device", bank->driver->name);
1091 COMMAND_HANDLER(stm32l4_handle_unlock_command)
1093 struct target *target = NULL;
1096 return ERROR_COMMAND_SYNTAX_ERROR;
1098 struct flash_bank *bank;
1099 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
1100 if (ERROR_OK != retval)
1103 target = bank->target;
1105 if (target->state != TARGET_HALTED) {
1106 LOG_ERROR("Target not halted");
1107 return ERROR_TARGET_NOT_HALTED;
1110 if (stm32l4_write_option(bank, STM32_FLASH_OPTR, RDP_LEVEL_0, 0x000000FF) != ERROR_OK) {
1111 command_print(CMD, "%s failed to unlock device", bank->driver->name);
1118 static const struct command_registration stm32l4_exec_command_handlers[] = {
1121 .handler = stm32l4_handle_lock_command,
1122 .mode = COMMAND_EXEC,
1124 .help = "Lock entire flash device.",
1128 .handler = stm32l4_handle_unlock_command,
1129 .mode = COMMAND_EXEC,
1131 .help = "Unlock entire protected flash device.",
1134 .name = "mass_erase",
1135 .handler = stm32l4_handle_mass_erase_command,
1136 .mode = COMMAND_EXEC,
1138 .help = "Erase entire flash device.",
1141 .name = "option_read",
1142 .handler = stm32l4_handle_option_read_command,
1143 .mode = COMMAND_EXEC,
1144 .usage = "bank_id reg_offset",
1145 .help = "Read & Display device option bytes.",
1148 .name = "option_write",
1149 .handler = stm32l4_handle_option_write_command,
1150 .mode = COMMAND_EXEC,
1151 .usage = "bank_id reg_offset value mask",
1152 .help = "Write device option bit fields with provided value.",
1155 .name = "option_load",
1156 .handler = stm32l4_handle_option_load_command,
1157 .mode = COMMAND_EXEC,
1159 .help = "Force re-load of device options (will cause device reset).",
1161 COMMAND_REGISTRATION_DONE
1164 static const struct command_registration stm32l4_command_handlers[] = {
1167 .mode = COMMAND_ANY,
1168 .help = "stm32l4x flash command group",
1170 .chain = stm32l4_exec_command_handlers,
1172 COMMAND_REGISTRATION_DONE
1175 const struct flash_driver stm32l4x_flash = {
1177 .commands = stm32l4_command_handlers,
1178 .flash_bank_command = stm32l4_flash_bank_command,
1179 .erase = stm32l4_erase,
1180 .protect = stm32l4_protect,
1181 .write = stm32l4_write,
1182 .read = default_flash_read,
1183 .probe = stm32l4_probe,
1184 .auto_probe = stm32l4_auto_probe,
1185 .erase_check = default_flash_blank_check,
1186 .protect_check = stm32l4_protect_check,
1187 .info = get_stm32l4_info,
1188 .free_driver_priv = default_flash_free_driver_priv,