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 Andreas Fritiofson *
9 * andreas.fritiofson@gmail.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>
34 /* stm32x register locations */
36 #define FLASH_REG_BASE_B0 0x40022000
37 #define FLASH_REG_BASE_B1 0x40022040
39 #define STM32_FLASH_ACR 0x00
40 #define STM32_FLASH_KEYR 0x04
41 #define STM32_FLASH_OPTKEYR 0x08
42 #define STM32_FLASH_SR 0x0C
43 #define STM32_FLASH_CR 0x10
44 #define STM32_FLASH_AR 0x14
45 #define STM32_FLASH_OBR 0x1C
46 #define STM32_FLASH_WRPR 0x20
48 /* TODO: Check if code using these really should be hard coded to bank 0.
49 * There are valid cases, on dual flash devices the protection of the
50 * second bank is done on the bank0 reg's. */
51 #define STM32_FLASH_ACR_B0 0x40022000
52 #define STM32_FLASH_KEYR_B0 0x40022004
53 #define STM32_FLASH_OPTKEYR_B0 0x40022008
54 #define STM32_FLASH_SR_B0 0x4002200C
55 #define STM32_FLASH_CR_B0 0x40022010
56 #define STM32_FLASH_AR_B0 0x40022014
57 #define STM32_FLASH_OBR_B0 0x4002201C
58 #define STM32_FLASH_WRPR_B0 0x40022020
60 /* option byte location */
62 #define STM32_OB_RDP 0x1FFFF800
63 #define STM32_OB_USER 0x1FFFF802
64 #define STM32_OB_DATA0 0x1FFFF804
65 #define STM32_OB_DATA1 0x1FFFF806
66 #define STM32_OB_WRP0 0x1FFFF808
67 #define STM32_OB_WRP1 0x1FFFF80A
68 #define STM32_OB_WRP2 0x1FFFF80C
69 #define STM32_OB_WRP3 0x1FFFF80E
71 /* FLASH_CR register bits */
73 #define FLASH_PG (1 << 0)
74 #define FLASH_PER (1 << 1)
75 #define FLASH_MER (1 << 2)
76 #define FLASH_OPTPG (1 << 4)
77 #define FLASH_OPTER (1 << 5)
78 #define FLASH_STRT (1 << 6)
79 #define FLASH_LOCK (1 << 7)
80 #define FLASH_OPTWRE (1 << 9)
82 /* FLASH_SR register bits */
84 #define FLASH_BSY (1 << 0)
85 #define FLASH_PGERR (1 << 2)
86 #define FLASH_WRPRTERR (1 << 4)
87 #define FLASH_EOP (1 << 5)
89 /* STM32_FLASH_OBR bit definitions (reading) */
94 #define OPT_RDRSTSTOP 3
95 #define OPT_RDRSTSTDBY 4
96 #define OPT_BFB2 5 /* dual flash bank only */
98 /* register unlock keys */
100 #define KEY1 0x45670123
101 #define KEY2 0xCDEF89AB
105 #define FLASH_WRITE_TIMEOUT 10
106 #define FLASH_ERASE_TIMEOUT 100
108 struct stm32x_options {
110 uint16_t user_options;
112 uint16_t protection[4];
115 struct stm32x_flash_bank {
116 struct stm32x_options option_bytes;
121 /* used to access dual flash bank stm32xl */
122 uint32_t register_base;
123 uint16_t default_rdp;
124 int user_data_offset;
126 uint32_t user_bank_size;
129 static int stm32x_mass_erase(struct flash_bank *bank);
130 static int stm32x_get_device_id(struct flash_bank *bank, uint32_t *device_id);
131 static int stm32x_write_block(struct flash_bank *bank, const uint8_t *buffer,
132 uint32_t offset, uint32_t count);
134 /* flash bank stm32x <base> <size> 0 0 <target#>
136 FLASH_BANK_COMMAND_HANDLER(stm32x_flash_bank_command)
138 struct stm32x_flash_bank *stm32x_info;
141 return ERROR_COMMAND_SYNTAX_ERROR;
143 stm32x_info = malloc(sizeof(struct stm32x_flash_bank));
145 bank->driver_priv = stm32x_info;
146 stm32x_info->probed = 0;
147 stm32x_info->has_dual_banks = false;
148 stm32x_info->register_base = FLASH_REG_BASE_B0;
149 stm32x_info->user_bank_size = bank->size;
154 static inline int stm32x_get_flash_reg(struct flash_bank *bank, uint32_t reg)
156 struct stm32x_flash_bank *stm32x_info = bank->driver_priv;
157 return reg + stm32x_info->register_base;
160 static inline int stm32x_get_flash_status(struct flash_bank *bank, uint32_t *status)
162 struct target *target = bank->target;
163 return target_read_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_SR), status);
166 static int stm32x_wait_status_busy(struct flash_bank *bank, int timeout)
168 struct target *target = bank->target;
170 int retval = ERROR_OK;
172 /* wait for busy to clear */
174 retval = stm32x_get_flash_status(bank, &status);
175 if (retval != ERROR_OK)
177 LOG_DEBUG("status: 0x%" PRIx32 "", status);
178 if ((status & FLASH_BSY) == 0)
180 if (timeout-- <= 0) {
181 LOG_ERROR("timed out waiting for flash");
187 if (status & FLASH_WRPRTERR) {
188 LOG_ERROR("stm32x device protected");
192 if (status & FLASH_PGERR) {
193 LOG_ERROR("stm32x device programming failed");
197 /* Clear but report errors */
198 if (status & (FLASH_WRPRTERR | FLASH_PGERR)) {
199 /* If this operation fails, we ignore it and report the original
202 target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_SR),
203 FLASH_WRPRTERR | FLASH_PGERR);
208 static int stm32x_check_operation_supported(struct flash_bank *bank)
210 struct stm32x_flash_bank *stm32x_info = bank->driver_priv;
212 /* if we have a dual flash bank device then
213 * we need to perform option byte stuff on bank0 only */
214 if (stm32x_info->register_base != FLASH_REG_BASE_B0) {
215 LOG_ERROR("Option Byte Operation's must use bank0");
216 return ERROR_FLASH_OPERATION_FAILED;
222 static int stm32x_read_options(struct flash_bank *bank)
225 struct stm32x_flash_bank *stm32x_info = NULL;
226 struct target *target = bank->target;
228 stm32x_info = bank->driver_priv;
230 /* read current option bytes */
231 int retval = target_read_u32(target, STM32_FLASH_OBR_B0, &optiondata);
232 if (retval != ERROR_OK)
235 stm32x_info->option_bytes.user_options = (optiondata >> stm32x_info->option_offset >> 2) & 0xffff;
236 stm32x_info->option_bytes.user_data = (optiondata >> stm32x_info->user_data_offset) & 0xffff;
237 stm32x_info->option_bytes.RDP = (optiondata & (1 << OPT_READOUT)) ? 0xFFFF : 0x5AA5;
239 if (optiondata & (1 << OPT_READOUT))
240 LOG_INFO("Device Security Bit Set");
242 /* each bit refers to a 4bank protection */
243 retval = target_read_u32(target, STM32_FLASH_WRPR_B0, &optiondata);
244 if (retval != ERROR_OK)
247 stm32x_info->option_bytes.protection[0] = (uint16_t)optiondata;
248 stm32x_info->option_bytes.protection[1] = (uint16_t)(optiondata >> 8);
249 stm32x_info->option_bytes.protection[2] = (uint16_t)(optiondata >> 16);
250 stm32x_info->option_bytes.protection[3] = (uint16_t)(optiondata >> 24);
255 static int stm32x_erase_options(struct flash_bank *bank)
257 struct stm32x_flash_bank *stm32x_info = NULL;
258 struct target *target = bank->target;
260 stm32x_info = bank->driver_priv;
262 /* read current options */
263 stm32x_read_options(bank);
265 /* unlock flash registers */
266 int retval = target_write_u32(target, STM32_FLASH_KEYR_B0, KEY1);
267 if (retval != ERROR_OK)
270 retval = target_write_u32(target, STM32_FLASH_KEYR_B0, KEY2);
271 if (retval != ERROR_OK)
274 /* unlock option flash registers */
275 retval = target_write_u32(target, STM32_FLASH_OPTKEYR_B0, KEY1);
276 if (retval != ERROR_OK)
278 retval = target_write_u32(target, STM32_FLASH_OPTKEYR_B0, KEY2);
279 if (retval != ERROR_OK)
282 /* erase option bytes */
283 retval = target_write_u32(target, STM32_FLASH_CR_B0, FLASH_OPTER | FLASH_OPTWRE);
284 if (retval != ERROR_OK)
286 retval = target_write_u32(target, STM32_FLASH_CR_B0, FLASH_OPTER | FLASH_STRT | FLASH_OPTWRE);
287 if (retval != ERROR_OK)
290 retval = stm32x_wait_status_busy(bank, FLASH_ERASE_TIMEOUT);
291 if (retval != ERROR_OK)
294 /* clear readout protection and complementary option bytes
295 * this will also force a device unlock if set */
296 stm32x_info->option_bytes.RDP = stm32x_info->default_rdp;
301 static int stm32x_write_options(struct flash_bank *bank)
303 struct stm32x_flash_bank *stm32x_info = NULL;
304 struct target *target = bank->target;
306 stm32x_info = bank->driver_priv;
308 /* unlock flash registers */
309 int retval = target_write_u32(target, STM32_FLASH_KEYR_B0, KEY1);
310 if (retval != ERROR_OK)
312 retval = target_write_u32(target, STM32_FLASH_KEYR_B0, KEY2);
313 if (retval != ERROR_OK)
316 /* unlock option flash registers */
317 retval = target_write_u32(target, STM32_FLASH_OPTKEYR_B0, KEY1);
318 if (retval != ERROR_OK)
320 retval = target_write_u32(target, STM32_FLASH_OPTKEYR_B0, KEY2);
321 if (retval != ERROR_OK)
324 /* program option bytes */
325 retval = target_write_u32(target, STM32_FLASH_CR_B0, FLASH_OPTPG | FLASH_OPTWRE);
326 if (retval != ERROR_OK)
329 uint8_t opt_bytes[16];
331 target_buffer_set_u16(target, opt_bytes, stm32x_info->option_bytes.RDP);
332 target_buffer_set_u16(target, opt_bytes + 2, stm32x_info->option_bytes.user_options);
333 target_buffer_set_u16(target, opt_bytes + 4, stm32x_info->option_bytes.user_data & 0xff);
334 target_buffer_set_u16(target, opt_bytes + 6, (stm32x_info->option_bytes.user_data >> 8) & 0xff);
335 target_buffer_set_u16(target, opt_bytes + 8, stm32x_info->option_bytes.protection[0]);
336 target_buffer_set_u16(target, opt_bytes + 10, stm32x_info->option_bytes.protection[1]);
337 target_buffer_set_u16(target, opt_bytes + 12, stm32x_info->option_bytes.protection[2]);
338 target_buffer_set_u16(target, opt_bytes + 14, stm32x_info->option_bytes.protection[3]);
340 uint32_t offset = STM32_OB_RDP - bank->base;
341 retval = stm32x_write_block(bank, opt_bytes, offset, sizeof(opt_bytes) / 2);
342 if (retval != ERROR_OK) {
343 if (retval == ERROR_TARGET_RESOURCE_NOT_AVAILABLE)
344 LOG_ERROR("working area required to erase options bytes");
348 retval = target_write_u32(target, STM32_FLASH_CR_B0, FLASH_LOCK);
349 if (retval != ERROR_OK)
355 static int stm32x_protect_check(struct flash_bank *bank)
357 struct target *target = bank->target;
358 struct stm32x_flash_bank *stm32x_info = bank->driver_priv;
365 int retval = stm32x_check_operation_supported(bank);
366 if (ERROR_OK != retval)
369 /* medium density - each bit refers to a 4bank protection
370 * high density - each bit refers to a 2bank protection */
371 retval = target_read_u32(target, STM32_FLASH_WRPR_B0, &protection);
372 if (retval != ERROR_OK)
375 /* medium density - each protection bit is for 4 * 1K pages
376 * high density - each protection bit is for 2 * 2K pages */
377 num_bits = (bank->num_sectors / stm32x_info->ppage_size);
379 if (stm32x_info->ppage_size == 2) {
380 /* high density flash/connectivity line protection */
384 if (protection & (1 << 31))
387 /* bit 31 controls sector 62 - 255 protection for high density
388 * bit 31 controls sector 62 - 127 protection for connectivity line */
389 for (s = 62; s < bank->num_sectors; s++)
390 bank->sectors[s].is_protected = set;
392 if (bank->num_sectors > 61)
395 for (i = 0; i < num_bits; i++) {
398 if (protection & (1 << i))
401 for (s = 0; s < stm32x_info->ppage_size; s++)
402 bank->sectors[(i * stm32x_info->ppage_size) + s].is_protected = set;
405 /* low/medium density flash protection */
406 for (i = 0; i < num_bits; i++) {
409 if (protection & (1 << i))
412 for (s = 0; s < stm32x_info->ppage_size; s++)
413 bank->sectors[(i * stm32x_info->ppage_size) + s].is_protected = set;
420 static int stm32x_erase(struct flash_bank *bank, int first, int last)
422 struct target *target = bank->target;
425 if (bank->target->state != TARGET_HALTED) {
426 LOG_ERROR("Target not halted");
427 return ERROR_TARGET_NOT_HALTED;
430 if ((first == 0) && (last == (bank->num_sectors - 1)))
431 return stm32x_mass_erase(bank);
433 /* unlock flash registers */
434 int retval = target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_KEYR), KEY1);
435 if (retval != ERROR_OK)
437 retval = target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_KEYR), KEY2);
438 if (retval != ERROR_OK)
441 for (i = first; i <= last; i++) {
442 retval = target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_CR), FLASH_PER);
443 if (retval != ERROR_OK)
445 retval = target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_AR),
446 bank->base + bank->sectors[i].offset);
447 if (retval != ERROR_OK)
449 retval = target_write_u32(target,
450 stm32x_get_flash_reg(bank, STM32_FLASH_CR), FLASH_PER | FLASH_STRT);
451 if (retval != ERROR_OK)
454 retval = stm32x_wait_status_busy(bank, FLASH_ERASE_TIMEOUT);
455 if (retval != ERROR_OK)
458 bank->sectors[i].is_erased = 1;
461 retval = target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_CR), FLASH_LOCK);
462 if (retval != ERROR_OK)
468 static int stm32x_protect(struct flash_bank *bank, int set, int first, int last)
470 struct stm32x_flash_bank *stm32x_info = NULL;
471 struct target *target = bank->target;
472 uint16_t prot_reg[4] = {0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF};
477 stm32x_info = bank->driver_priv;
479 if (target->state != TARGET_HALTED) {
480 LOG_ERROR("Target not halted");
481 return ERROR_TARGET_NOT_HALTED;
484 int retval = stm32x_check_operation_supported(bank);
485 if (ERROR_OK != retval)
488 if ((first % stm32x_info->ppage_size) != 0) {
489 LOG_WARNING("aligned start protect sector to a %d sector boundary",
490 stm32x_info->ppage_size);
491 first = first - (first % stm32x_info->ppage_size);
493 if (((last + 1) % stm32x_info->ppage_size) != 0) {
494 LOG_WARNING("aligned end protect sector to a %d sector boundary",
495 stm32x_info->ppage_size);
497 last = last - (last % stm32x_info->ppage_size);
501 /* medium density - each bit refers to a 4bank protection
502 * high density - each bit refers to a 2bank protection */
503 retval = target_read_u32(target, STM32_FLASH_WRPR_B0, &protection);
504 if (retval != ERROR_OK)
507 prot_reg[0] = (uint16_t)protection;
508 prot_reg[1] = (uint16_t)(protection >> 8);
509 prot_reg[2] = (uint16_t)(protection >> 16);
510 prot_reg[3] = (uint16_t)(protection >> 24);
512 if (stm32x_info->ppage_size == 2) {
513 /* high density flash */
515 /* bit 7 controls sector 62 - 255 protection */
518 prot_reg[3] &= ~(1 << 7);
520 prot_reg[3] |= (1 << 7);
528 for (i = first; i <= last; i++) {
529 reg = (i / stm32x_info->ppage_size) / 8;
530 bit = (i / stm32x_info->ppage_size) - (reg * 8);
533 prot_reg[reg] &= ~(1 << bit);
535 prot_reg[reg] |= (1 << bit);
538 /* medium density flash */
539 for (i = first; i <= last; i++) {
540 reg = (i / stm32x_info->ppage_size) / 8;
541 bit = (i / stm32x_info->ppage_size) - (reg * 8);
544 prot_reg[reg] &= ~(1 << bit);
546 prot_reg[reg] |= (1 << bit);
550 status = stm32x_erase_options(bank);
551 if (status != ERROR_OK)
554 stm32x_info->option_bytes.protection[0] = prot_reg[0];
555 stm32x_info->option_bytes.protection[1] = prot_reg[1];
556 stm32x_info->option_bytes.protection[2] = prot_reg[2];
557 stm32x_info->option_bytes.protection[3] = prot_reg[3];
559 return stm32x_write_options(bank);
562 static int stm32x_write_block(struct flash_bank *bank, const uint8_t *buffer,
563 uint32_t offset, uint32_t count)
565 struct stm32x_flash_bank *stm32x_info = bank->driver_priv;
566 struct target *target = bank->target;
567 uint32_t buffer_size = 16384;
568 struct working_area *write_algorithm;
569 struct working_area *source;
570 uint32_t address = bank->base + offset;
571 struct reg_param reg_params[5];
572 struct armv7m_algorithm armv7m_info;
573 int retval = ERROR_OK;
575 static const uint8_t stm32x_flash_write_code[] = {
576 #include "../../../contrib/loaders/flash/stm32/stm32f1x.inc"
579 /* flash write code */
580 if (target_alloc_working_area(target, sizeof(stm32x_flash_write_code),
581 &write_algorithm) != ERROR_OK) {
582 LOG_WARNING("no working area available, can't do block memory writes");
583 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
586 retval = target_write_buffer(target, write_algorithm->address,
587 sizeof(stm32x_flash_write_code), stm32x_flash_write_code);
588 if (retval != ERROR_OK)
592 while (target_alloc_working_area_try(target, buffer_size, &source) != ERROR_OK) {
594 buffer_size &= ~3UL; /* Make sure it's 4 byte aligned */
595 if (buffer_size <= 256) {
596 /* we already allocated the writing code, but failed to get a
597 * buffer, free the algorithm */
598 target_free_working_area(target, write_algorithm);
600 LOG_WARNING("no large enough working area available, can't do block memory writes");
601 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
605 init_reg_param(®_params[0], "r0", 32, PARAM_IN_OUT); /* flash base (in), status (out) */
606 init_reg_param(®_params[1], "r1", 32, PARAM_OUT); /* count (halfword-16bit) */
607 init_reg_param(®_params[2], "r2", 32, PARAM_OUT); /* buffer start */
608 init_reg_param(®_params[3], "r3", 32, PARAM_OUT); /* buffer end */
609 init_reg_param(®_params[4], "r4", 32, PARAM_IN_OUT); /* target address */
611 buf_set_u32(reg_params[0].value, 0, 32, stm32x_info->register_base);
612 buf_set_u32(reg_params[1].value, 0, 32, count);
613 buf_set_u32(reg_params[2].value, 0, 32, source->address);
614 buf_set_u32(reg_params[3].value, 0, 32, source->address + source->size);
615 buf_set_u32(reg_params[4].value, 0, 32, address);
617 armv7m_info.common_magic = ARMV7M_COMMON_MAGIC;
618 armv7m_info.core_mode = ARM_MODE_THREAD;
620 retval = target_run_flash_async_algorithm(target, buffer, count, 2,
623 source->address, source->size,
624 write_algorithm->address, 0,
627 if (retval == ERROR_FLASH_OPERATION_FAILED) {
628 LOG_ERROR("flash write failed at address 0x%"PRIx32,
629 buf_get_u32(reg_params[4].value, 0, 32));
631 if (buf_get_u32(reg_params[0].value, 0, 32) & FLASH_PGERR) {
632 LOG_ERROR("flash memory not erased before writing");
633 /* Clear but report errors */
634 target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_SR), FLASH_PGERR);
637 if (buf_get_u32(reg_params[0].value, 0, 32) & FLASH_WRPRTERR) {
638 LOG_ERROR("flash memory write protected");
639 /* Clear but report errors */
640 target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_SR), FLASH_WRPRTERR);
644 target_free_working_area(target, source);
645 target_free_working_area(target, write_algorithm);
647 destroy_reg_param(®_params[0]);
648 destroy_reg_param(®_params[1]);
649 destroy_reg_param(®_params[2]);
650 destroy_reg_param(®_params[3]);
651 destroy_reg_param(®_params[4]);
656 static int stm32x_write(struct flash_bank *bank, const uint8_t *buffer,
657 uint32_t offset, uint32_t count)
659 struct target *target = bank->target;
660 uint8_t *new_buffer = NULL;
662 if (bank->target->state != TARGET_HALTED) {
663 LOG_ERROR("Target not halted");
664 return ERROR_TARGET_NOT_HALTED;
668 LOG_ERROR("offset 0x%" PRIx32 " breaks required 2-byte alignment", offset);
669 return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
672 /* If there's an odd number of bytes, the data has to be padded. Duplicate
673 * the buffer and use the normal code path with a single block write since
674 * it's probably cheaper than to special case the last odd write using
675 * discrete accesses. */
677 new_buffer = malloc(count + 1);
678 if (new_buffer == NULL) {
679 LOG_ERROR("odd number of bytes to write and no memory for padding buffer");
682 LOG_INFO("odd number of bytes to write, padding with 0xff");
683 buffer = memcpy(new_buffer, buffer, count);
684 new_buffer[count++] = 0xff;
687 uint32_t words_remaining = count / 2;
690 /* unlock flash registers */
691 retval = target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_KEYR), KEY1);
692 if (retval != ERROR_OK)
694 retval = target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_KEYR), KEY2);
695 if (retval != ERROR_OK)
698 retval = target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_CR), FLASH_PG);
699 if (retval != ERROR_OK)
702 /* try using a block write */
703 retval = stm32x_write_block(bank, buffer, offset, words_remaining);
705 if (retval == ERROR_TARGET_RESOURCE_NOT_AVAILABLE) {
706 /* if block write failed (no sufficient working area),
707 * we use normal (slow) single halfword accesses */
708 LOG_WARNING("couldn't use block writes, falling back to single memory accesses");
710 while (words_remaining > 0) {
712 memcpy(&value, buffer, sizeof(uint16_t));
714 retval = target_write_u16(target, bank->base + offset, value);
715 if (retval != ERROR_OK)
716 goto reset_pg_and_lock;
718 retval = stm32x_wait_status_busy(bank, 5);
719 if (retval != ERROR_OK)
720 goto reset_pg_and_lock;
729 retval2 = target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_CR), FLASH_LOCK);
730 if (retval == ERROR_OK)
740 static int stm32x_get_device_id(struct flash_bank *bank, uint32_t *device_id)
742 /* This check the device CPUID core register to detect
743 * the M0 from the M3 devices. */
745 struct target *target = bank->target;
746 uint32_t cpuid, device_id_register = 0;
748 /* Get the CPUID from the ARM Core
749 * http://infocenter.arm.com/help/topic/com.arm.doc.ddi0432c/DDI0432C_cortex_m0_r0p0_trm.pdf 4.2.1 */
750 int retval = target_read_u32(target, 0xE000ED00, &cpuid);
751 if (retval != ERROR_OK)
754 if (((cpuid >> 4) & 0xFFF) == 0xC20) {
755 /* 0xC20 is M0 devices */
756 device_id_register = 0x40015800;
757 } else if (((cpuid >> 4) & 0xFFF) == 0xC23) {
758 /* 0xC23 is M3 devices */
759 device_id_register = 0xE0042000;
760 } else if (((cpuid >> 4) & 0xFFF) == 0xC24) {
761 /* 0xC24 is M4 devices */
762 device_id_register = 0xE0042000;
764 LOG_ERROR("Cannot identify target as a stm32x");
768 /* read stm32 device id register */
769 retval = target_read_u32(target, device_id_register, device_id);
770 if (retval != ERROR_OK)
776 static int stm32x_get_flash_size(struct flash_bank *bank, uint16_t *flash_size_in_kb)
778 struct target *target = bank->target;
779 uint32_t cpuid, flash_size_reg;
781 int retval = target_read_u32(target, 0xE000ED00, &cpuid);
782 if (retval != ERROR_OK)
785 if (((cpuid >> 4) & 0xFFF) == 0xC20) {
786 /* 0xC20 is M0 devices */
787 flash_size_reg = 0x1FFFF7CC;
788 } else if (((cpuid >> 4) & 0xFFF) == 0xC23) {
789 /* 0xC23 is M3 devices */
790 flash_size_reg = 0x1FFFF7E0;
791 } else if (((cpuid >> 4) & 0xFFF) == 0xC24) {
792 /* 0xC24 is M4 devices */
793 flash_size_reg = 0x1FFFF7CC;
795 LOG_ERROR("Cannot identify target as a stm32x");
799 retval = target_read_u16(target, flash_size_reg, flash_size_in_kb);
800 if (retval != ERROR_OK)
806 static int stm32x_probe(struct flash_bank *bank)
808 struct stm32x_flash_bank *stm32x_info = bank->driver_priv;
810 uint16_t flash_size_in_kb;
811 uint16_t max_flash_size_in_kb;
814 uint32_t base_address = 0x08000000;
816 stm32x_info->probed = 0;
817 stm32x_info->register_base = FLASH_REG_BASE_B0;
818 stm32x_info->user_data_offset = 10;
819 stm32x_info->option_offset = 0;
821 /* default factory protection level */
822 stm32x_info->default_rdp = 0x5AA5;
824 /* read stm32 device id register */
825 int retval = stm32x_get_device_id(bank, &device_id);
826 if (retval != ERROR_OK)
829 LOG_INFO("device id = 0x%08" PRIx32 "", device_id);
831 /* set page size, protection granularity and max flash size depending on family */
832 switch (device_id & 0xfff) {
833 case 0x410: /* medium density */
835 stm32x_info->ppage_size = 4;
836 max_flash_size_in_kb = 128;
838 case 0x412: /* low density */
840 stm32x_info->ppage_size = 4;
841 max_flash_size_in_kb = 32;
843 case 0x414: /* high density */
845 stm32x_info->ppage_size = 2;
846 max_flash_size_in_kb = 512;
848 case 0x418: /* connectivity line density */
850 stm32x_info->ppage_size = 2;
851 max_flash_size_in_kb = 256;
853 case 0x420: /* value line density */
855 stm32x_info->ppage_size = 4;
856 max_flash_size_in_kb = 128;
858 case 0x422: /* stm32f302/3xb/c */
860 stm32x_info->ppage_size = 2;
861 max_flash_size_in_kb = 256;
862 stm32x_info->user_data_offset = 16;
863 stm32x_info->option_offset = 6;
864 stm32x_info->default_rdp = 0x55AA;
866 case 0x446: /* stm32f303xD/E */
868 stm32x_info->ppage_size = 2;
869 max_flash_size_in_kb = 512;
870 stm32x_info->user_data_offset = 16;
871 stm32x_info->option_offset = 6;
872 stm32x_info->default_rdp = 0x55AA;
874 case 0x428: /* value line High density */
876 stm32x_info->ppage_size = 4;
877 max_flash_size_in_kb = 128;
879 case 0x430: /* xl line density (dual flash banks) */
881 stm32x_info->ppage_size = 2;
882 max_flash_size_in_kb = 1024;
883 stm32x_info->has_dual_banks = true;
885 case 0x432: /* stm32f37x */
887 stm32x_info->ppage_size = 2;
888 max_flash_size_in_kb = 256;
889 stm32x_info->user_data_offset = 16;
890 stm32x_info->option_offset = 6;
891 stm32x_info->default_rdp = 0x55AA;
893 case 0x438: /* stm32f33x */
894 case 0x439: /* stm32f302x6/8 */
896 stm32x_info->ppage_size = 2;
897 max_flash_size_in_kb = 64;
898 stm32x_info->user_data_offset = 16;
899 stm32x_info->option_offset = 6;
900 stm32x_info->default_rdp = 0x55AA;
902 case 0x440: /* stm32f05x */
903 case 0x444: /* stm32f03x */
904 case 0x445: /* stm32f04x */
906 stm32x_info->ppage_size = 4;
907 max_flash_size_in_kb = 64;
908 stm32x_info->user_data_offset = 16;
909 stm32x_info->option_offset = 6;
910 stm32x_info->default_rdp = 0x55AA;
912 case 0x448: /* stm32f07x */
913 case 0x442: /* stm32f09x */
915 stm32x_info->ppage_size = 4;
916 max_flash_size_in_kb = 256;
917 stm32x_info->user_data_offset = 16;
918 stm32x_info->option_offset = 6;
919 stm32x_info->default_rdp = 0x55AA;
922 LOG_WARNING("Cannot identify target as a STM32 family.");
926 /* get flash size from target. */
927 retval = stm32x_get_flash_size(bank, &flash_size_in_kb);
929 /* failed reading flash size or flash size invalid (early silicon),
930 * default to max target family */
931 if (retval != ERROR_OK || flash_size_in_kb == 0xffff || flash_size_in_kb == 0) {
932 LOG_WARNING("STM32 flash size failed, probe inaccurate - assuming %dk flash",
933 max_flash_size_in_kb);
934 flash_size_in_kb = max_flash_size_in_kb;
937 if (stm32x_info->has_dual_banks) {
938 /* split reported size into matching bank */
939 if (bank->base != 0x08080000) {
940 /* bank 0 will be fixed 512k */
941 flash_size_in_kb = 512;
943 flash_size_in_kb -= 512;
944 /* bank1 also uses a register offset */
945 stm32x_info->register_base = FLASH_REG_BASE_B1;
946 base_address = 0x08080000;
950 /* if the user sets the size manually then ignore the probed value
951 * this allows us to work around devices that have a invalid flash size register value */
952 if (stm32x_info->user_bank_size) {
953 LOG_INFO("ignoring flash probed value, using configured bank size");
954 flash_size_in_kb = stm32x_info->user_bank_size / 1024;
957 LOG_INFO("flash size = %dkbytes", flash_size_in_kb);
959 /* did we assign flash size? */
960 assert(flash_size_in_kb != 0xffff);
962 /* calculate numbers of pages */
963 int num_pages = flash_size_in_kb * 1024 / page_size;
965 /* check that calculation result makes sense */
966 assert(num_pages > 0);
970 bank->sectors = NULL;
973 bank->base = base_address;
974 bank->size = (num_pages * page_size);
975 bank->num_sectors = num_pages;
976 bank->sectors = malloc(sizeof(struct flash_sector) * num_pages);
978 for (i = 0; i < num_pages; i++) {
979 bank->sectors[i].offset = i * page_size;
980 bank->sectors[i].size = page_size;
981 bank->sectors[i].is_erased = -1;
982 bank->sectors[i].is_protected = 1;
985 stm32x_info->probed = 1;
990 static int stm32x_auto_probe(struct flash_bank *bank)
992 struct stm32x_flash_bank *stm32x_info = bank->driver_priv;
993 if (stm32x_info->probed)
995 return stm32x_probe(bank);
999 COMMAND_HANDLER(stm32x_handle_part_id_command)
1005 static const char *get_stm32f0_revision(uint16_t rev_id)
1007 const char *rev_str = NULL;
1020 static int get_stm32x_info(struct flash_bank *bank, char *buf, int buf_size)
1022 uint32_t dbgmcu_idcode;
1024 /* read stm32 device id register */
1025 int retval = stm32x_get_device_id(bank, &dbgmcu_idcode);
1026 if (retval != ERROR_OK)
1029 uint16_t device_id = dbgmcu_idcode & 0xfff;
1030 uint16_t rev_id = dbgmcu_idcode >> 16;
1031 const char *device_str;
1032 const char *rev_str = NULL;
1034 switch (device_id) {
1036 device_str = "STM32F10x (Medium Density)";
1058 device_str = "STM32F10x (Low Density)";
1068 device_str = "STM32F10x (High Density)";
1086 device_str = "STM32F10x (Connectivity)";
1100 device_str = "STM32F100 (Low/Medium Density)";
1114 device_str = "STM32F302xB/C";
1136 device_str = "STM32F100 (High Density)";
1150 device_str = "STM32F10x (XL Density)";
1160 device_str = "STM32F37x";
1174 device_str = "STM32F33x";
1184 device_str = "STM32F302x6/8";
1198 device_str = "STM32F03x";
1199 rev_str = get_stm32f0_revision(rev_id);
1203 device_str = "STM32F05x";
1204 rev_str = get_stm32f0_revision(rev_id);
1208 device_str = "STM32F04x";
1209 rev_str = get_stm32f0_revision(rev_id);
1213 device_str = "STM32F303xD/E";
1222 device_str = "STM32F07x";
1223 rev_str = get_stm32f0_revision(rev_id);
1227 device_str = "STM32F09x";
1228 rev_str = get_stm32f0_revision(rev_id);
1232 snprintf(buf, buf_size, "Cannot identify target as a STM32F0/1/3\n");
1236 if (rev_str != NULL)
1237 snprintf(buf, buf_size, "%s - Rev: %s", device_str, rev_str);
1239 snprintf(buf, buf_size, "%s - Rev: unknown (0x%04x)", device_str, rev_id);
1244 COMMAND_HANDLER(stm32x_handle_lock_command)
1246 struct target *target = NULL;
1247 struct stm32x_flash_bank *stm32x_info = NULL;
1250 return ERROR_COMMAND_SYNTAX_ERROR;
1252 struct flash_bank *bank;
1253 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
1254 if (ERROR_OK != retval)
1257 stm32x_info = bank->driver_priv;
1259 target = bank->target;
1261 if (target->state != TARGET_HALTED) {
1262 LOG_ERROR("Target not halted");
1263 return ERROR_TARGET_NOT_HALTED;
1266 retval = stm32x_check_operation_supported(bank);
1267 if (ERROR_OK != retval)
1270 if (stm32x_erase_options(bank) != ERROR_OK) {
1271 command_print(CMD_CTX, "stm32x failed to erase options");
1275 /* set readout protection */
1276 stm32x_info->option_bytes.RDP = 0;
1278 if (stm32x_write_options(bank) != ERROR_OK) {
1279 command_print(CMD_CTX, "stm32x failed to lock device");
1283 command_print(CMD_CTX, "stm32x locked");
1288 COMMAND_HANDLER(stm32x_handle_unlock_command)
1290 struct target *target = NULL;
1293 return ERROR_COMMAND_SYNTAX_ERROR;
1295 struct flash_bank *bank;
1296 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
1297 if (ERROR_OK != retval)
1300 target = bank->target;
1302 if (target->state != TARGET_HALTED) {
1303 LOG_ERROR("Target not halted");
1304 return ERROR_TARGET_NOT_HALTED;
1307 retval = stm32x_check_operation_supported(bank);
1308 if (ERROR_OK != retval)
1311 if (stm32x_erase_options(bank) != ERROR_OK) {
1312 command_print(CMD_CTX, "stm32x failed to unlock device");
1316 if (stm32x_write_options(bank) != ERROR_OK) {
1317 command_print(CMD_CTX, "stm32x failed to lock device");
1321 command_print(CMD_CTX, "stm32x unlocked.\n"
1322 "INFO: a reset or power cycle is required "
1323 "for the new settings to take effect.");
1328 COMMAND_HANDLER(stm32x_handle_options_read_command)
1330 uint32_t optionbyte;
1331 struct target *target = NULL;
1332 struct stm32x_flash_bank *stm32x_info = NULL;
1335 return ERROR_COMMAND_SYNTAX_ERROR;
1337 struct flash_bank *bank;
1338 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
1339 if (ERROR_OK != retval)
1342 stm32x_info = bank->driver_priv;
1344 target = bank->target;
1346 if (target->state != TARGET_HALTED) {
1347 LOG_ERROR("Target not halted");
1348 return ERROR_TARGET_NOT_HALTED;
1351 retval = stm32x_check_operation_supported(bank);
1352 if (ERROR_OK != retval)
1355 retval = target_read_u32(target, STM32_FLASH_OBR_B0, &optionbyte);
1356 if (retval != ERROR_OK)
1358 command_print(CMD_CTX, "Option Byte: 0x%" PRIx32 "", optionbyte);
1360 int user_data = optionbyte;
1362 if (optionbyte >> OPT_ERROR & 1)
1363 command_print(CMD_CTX, "Option Byte Complement Error");
1365 if (optionbyte >> OPT_READOUT & 1)
1366 command_print(CMD_CTX, "Readout Protection On");
1368 command_print(CMD_CTX, "Readout Protection Off");
1370 /* user option bytes are offset depending on variant */
1371 optionbyte >>= stm32x_info->option_offset;
1373 if (optionbyte >> OPT_RDWDGSW & 1)
1374 command_print(CMD_CTX, "Software Watchdog");
1376 command_print(CMD_CTX, "Hardware Watchdog");
1378 if (optionbyte >> OPT_RDRSTSTOP & 1)
1379 command_print(CMD_CTX, "Stop: No reset generated");
1381 command_print(CMD_CTX, "Stop: Reset generated");
1383 if (optionbyte >> OPT_RDRSTSTDBY & 1)
1384 command_print(CMD_CTX, "Standby: No reset generated");
1386 command_print(CMD_CTX, "Standby: Reset generated");
1388 if (stm32x_info->has_dual_banks) {
1389 if (optionbyte >> OPT_BFB2 & 1)
1390 command_print(CMD_CTX, "Boot: Bank 0");
1392 command_print(CMD_CTX, "Boot: Bank 1");
1395 command_print(CMD_CTX, "User Option0: 0x%02" PRIx8,
1396 (uint8_t)((user_data >> stm32x_info->user_data_offset) & 0xff));
1397 command_print(CMD_CTX, "User Option1: 0x%02" PRIx8,
1398 (uint8_t)((user_data >> (stm32x_info->user_data_offset + 8)) & 0xff));
1403 COMMAND_HANDLER(stm32x_handle_options_write_command)
1405 struct target *target = NULL;
1406 struct stm32x_flash_bank *stm32x_info = NULL;
1407 uint16_t optionbyte;
1410 return ERROR_COMMAND_SYNTAX_ERROR;
1412 struct flash_bank *bank;
1413 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
1414 if (ERROR_OK != retval)
1417 stm32x_info = bank->driver_priv;
1419 target = bank->target;
1421 if (target->state != TARGET_HALTED) {
1422 LOG_ERROR("Target not halted");
1423 return ERROR_TARGET_NOT_HALTED;
1426 retval = stm32x_check_operation_supported(bank);
1427 if (ERROR_OK != retval)
1430 retval = stm32x_read_options(bank);
1431 if (ERROR_OK != retval)
1434 /* start with current options */
1435 optionbyte = stm32x_info->option_bytes.user_options;
1437 /* skip over flash bank */
1442 if (strcmp("SWWDG", CMD_ARGV[0]) == 0)
1443 optionbyte |= (1 << 0);
1444 else if (strcmp("HWWDG", CMD_ARGV[0]) == 0)
1445 optionbyte &= ~(1 << 0);
1446 else if (strcmp("NORSTSTOP", CMD_ARGV[0]) == 0)
1447 optionbyte |= (1 << 1);
1448 else if (strcmp("RSTSTOP", CMD_ARGV[0]) == 0)
1449 optionbyte &= ~(1 << 1);
1450 else if (strcmp("NORSTSTNDBY", CMD_ARGV[0]) == 0)
1451 optionbyte |= (1 << 2);
1452 else if (strcmp("RSTSTNDBY", CMD_ARGV[0]) == 0)
1453 optionbyte &= ~(1 << 2);
1454 else if (stm32x_info->has_dual_banks) {
1455 if (strcmp("BOOT0", CMD_ARGV[0]) == 0)
1456 optionbyte |= (1 << 3);
1457 else if (strcmp("BOOT1", CMD_ARGV[0]) == 0)
1458 optionbyte &= ~(1 << 3);
1460 return ERROR_COMMAND_SYNTAX_ERROR;
1462 return ERROR_COMMAND_SYNTAX_ERROR;
1467 if (stm32x_erase_options(bank) != ERROR_OK) {
1468 command_print(CMD_CTX, "stm32x failed to erase options");
1472 stm32x_info->option_bytes.user_options = optionbyte;
1474 if (stm32x_write_options(bank) != ERROR_OK) {
1475 command_print(CMD_CTX, "stm32x failed to write options");
1479 command_print(CMD_CTX, "stm32x write options complete.\n"
1480 "INFO: a reset or power cycle is required "
1481 "for the new settings to take effect.");
1486 static int stm32x_mass_erase(struct flash_bank *bank)
1488 struct target *target = bank->target;
1490 if (target->state != TARGET_HALTED) {
1491 LOG_ERROR("Target not halted");
1492 return ERROR_TARGET_NOT_HALTED;
1495 /* unlock option flash registers */
1496 int retval = target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_KEYR), KEY1);
1497 if (retval != ERROR_OK)
1499 retval = target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_KEYR), KEY2);
1500 if (retval != ERROR_OK)
1503 /* mass erase flash memory */
1504 retval = target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_CR), FLASH_MER);
1505 if (retval != ERROR_OK)
1507 retval = target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_CR),
1508 FLASH_MER | FLASH_STRT);
1509 if (retval != ERROR_OK)
1512 retval = stm32x_wait_status_busy(bank, FLASH_ERASE_TIMEOUT);
1513 if (retval != ERROR_OK)
1516 retval = target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_CR), FLASH_LOCK);
1517 if (retval != ERROR_OK)
1523 COMMAND_HANDLER(stm32x_handle_mass_erase_command)
1528 return ERROR_COMMAND_SYNTAX_ERROR;
1530 struct flash_bank *bank;
1531 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
1532 if (ERROR_OK != retval)
1535 retval = stm32x_mass_erase(bank);
1536 if (retval == ERROR_OK) {
1537 /* set all sectors as erased */
1538 for (i = 0; i < bank->num_sectors; i++)
1539 bank->sectors[i].is_erased = 1;
1541 command_print(CMD_CTX, "stm32x mass erase complete");
1543 command_print(CMD_CTX, "stm32x mass erase failed");
1548 static const struct command_registration stm32x_exec_command_handlers[] = {
1551 .handler = stm32x_handle_lock_command,
1552 .mode = COMMAND_EXEC,
1554 .help = "Lock entire flash device.",
1558 .handler = stm32x_handle_unlock_command,
1559 .mode = COMMAND_EXEC,
1561 .help = "Unlock entire protected flash device.",
1564 .name = "mass_erase",
1565 .handler = stm32x_handle_mass_erase_command,
1566 .mode = COMMAND_EXEC,
1568 .help = "Erase entire flash device.",
1571 .name = "options_read",
1572 .handler = stm32x_handle_options_read_command,
1573 .mode = COMMAND_EXEC,
1575 .help = "Read and display device option byte.",
1578 .name = "options_write",
1579 .handler = stm32x_handle_options_write_command,
1580 .mode = COMMAND_EXEC,
1581 .usage = "bank_id ('SWWDG'|'HWWDG') "
1582 "('RSTSTNDBY'|'NORSTSTNDBY') "
1583 "('RSTSTOP'|'NORSTSTOP')",
1584 .help = "Replace bits in device option byte.",
1586 COMMAND_REGISTRATION_DONE
1589 static const struct command_registration stm32x_command_handlers[] = {
1592 .mode = COMMAND_ANY,
1593 .help = "stm32f1x flash command group",
1595 .chain = stm32x_exec_command_handlers,
1597 COMMAND_REGISTRATION_DONE
1600 struct flash_driver stm32f1x_flash = {
1602 .commands = stm32x_command_handlers,
1603 .flash_bank_command = stm32x_flash_bank_command,
1604 .erase = stm32x_erase,
1605 .protect = stm32x_protect,
1606 .write = stm32x_write,
1607 .read = default_flash_read,
1608 .probe = stm32x_probe,
1609 .auto_probe = stm32x_auto_probe,
1610 .erase_check = default_flash_blank_check,
1611 .protect_check = stm32x_protect_check,
1612 .info = get_stm32x_info,
1613 .free_driver_priv = default_flash_free_driver_priv,