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, write to the *
23 * Free Software Foundation, Inc., *
24 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
25 ***************************************************************************/
32 #include <helper/binarybuffer.h>
33 #include <target/algorithm.h>
34 #include <target/armv7m.h>
36 /* stm32x register locations */
38 #define FLASH_REG_BASE_B0 0x40022000
39 #define FLASH_REG_BASE_B1 0x40022040
41 #define STM32_FLASH_ACR 0x00
42 #define STM32_FLASH_KEYR 0x04
43 #define STM32_FLASH_OPTKEYR 0x08
44 #define STM32_FLASH_SR 0x0C
45 #define STM32_FLASH_CR 0x10
46 #define STM32_FLASH_AR 0x14
47 #define STM32_FLASH_OBR 0x1C
48 #define STM32_FLASH_WRPR 0x20
50 /* TODO: Check if code using these really should be hard coded to bank 0.
51 * There are valid cases, on dual flash devices the protection of the
52 * second bank is done on the bank0 reg's. */
53 #define STM32_FLASH_ACR_B0 0x40022000
54 #define STM32_FLASH_KEYR_B0 0x40022004
55 #define STM32_FLASH_OPTKEYR_B0 0x40022008
56 #define STM32_FLASH_SR_B0 0x4002200C
57 #define STM32_FLASH_CR_B0 0x40022010
58 #define STM32_FLASH_AR_B0 0x40022014
59 #define STM32_FLASH_OBR_B0 0x4002201C
60 #define STM32_FLASH_WRPR_B0 0x40022020
62 /* option byte location */
64 #define STM32_OB_RDP 0x1FFFF800
65 #define STM32_OB_USER 0x1FFFF802
66 #define STM32_OB_DATA0 0x1FFFF804
67 #define STM32_OB_DATA1 0x1FFFF806
68 #define STM32_OB_WRP0 0x1FFFF808
69 #define STM32_OB_WRP1 0x1FFFF80A
70 #define STM32_OB_WRP2 0x1FFFF80C
71 #define STM32_OB_WRP3 0x1FFFF80E
73 /* FLASH_CR register bits */
75 #define FLASH_PG (1 << 0)
76 #define FLASH_PER (1 << 1)
77 #define FLASH_MER (1 << 2)
78 #define FLASH_OPTPG (1 << 4)
79 #define FLASH_OPTER (1 << 5)
80 #define FLASH_STRT (1 << 6)
81 #define FLASH_LOCK (1 << 7)
82 #define FLASH_OPTWRE (1 << 9)
84 /* FLASH_SR register bits */
86 #define FLASH_BSY (1 << 0)
87 #define FLASH_PGERR (1 << 2)
88 #define FLASH_WRPRTERR (1 << 4)
89 #define FLASH_EOP (1 << 5)
91 /* STM32_FLASH_OBR bit definitions (reading) */
96 #define OPT_RDRSTSTOP 3
97 #define OPT_RDRSTSTDBY 4
98 #define OPT_BFB2 5 /* dual flash bank only */
100 /* register unlock keys */
102 #define KEY1 0x45670123
103 #define KEY2 0xCDEF89AB
105 struct stm32x_options {
107 uint16_t user_options;
108 uint16_t protection[4];
111 struct stm32x_flash_bank {
112 struct stm32x_options option_bytes;
113 struct working_area *write_algorithm;
118 /* used to access dual flash bank stm32xl */
119 uint32_t register_base;
122 static int stm32x_mass_erase(struct flash_bank *bank);
123 static int stm32x_get_device_id(struct flash_bank *bank, uint32_t *device_id);
125 /* flash bank stm32x <base> <size> 0 0 <target#>
127 FLASH_BANK_COMMAND_HANDLER(stm32x_flash_bank_command)
129 struct stm32x_flash_bank *stm32x_info;
132 return ERROR_COMMAND_SYNTAX_ERROR;
134 stm32x_info = malloc(sizeof(struct stm32x_flash_bank));
136 bank->driver_priv = stm32x_info;
137 stm32x_info->write_algorithm = NULL;
138 stm32x_info->probed = 0;
139 stm32x_info->has_dual_banks = false;
140 stm32x_info->register_base = FLASH_REG_BASE_B0;
145 static inline int stm32x_get_flash_reg(struct flash_bank *bank, uint32_t reg)
147 struct stm32x_flash_bank *stm32x_info = bank->driver_priv;
148 return reg + stm32x_info->register_base;
151 static inline int stm32x_get_flash_status(struct flash_bank *bank, uint32_t *status)
153 struct target *target = bank->target;
154 return target_read_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_SR), status);
157 static int stm32x_wait_status_busy(struct flash_bank *bank, int timeout)
159 struct target *target = bank->target;
161 int retval = ERROR_OK;
163 /* wait for busy to clear */
165 retval = stm32x_get_flash_status(bank, &status);
166 if (retval != ERROR_OK)
168 LOG_DEBUG("status: 0x%" PRIx32 "", status);
169 if ((status & FLASH_BSY) == 0)
171 if (timeout-- <= 0) {
172 LOG_ERROR("timed out waiting for flash");
178 if (status & FLASH_WRPRTERR) {
179 LOG_ERROR("stm32x device protected");
183 if (status & FLASH_PGERR) {
184 LOG_ERROR("stm32x device programming failed");
188 /* Clear but report errors */
189 if (status & (FLASH_WRPRTERR | FLASH_PGERR)) {
190 /* If this operation fails, we ignore it and report the original
193 target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_SR),
194 FLASH_WRPRTERR | FLASH_PGERR);
199 int stm32x_check_operation_supported(struct flash_bank *bank)
201 struct stm32x_flash_bank *stm32x_info = bank->driver_priv;
203 /* if we have a dual flash bank device then
204 * we need to perform option byte stuff on bank0 only */
205 if (stm32x_info->register_base != FLASH_REG_BASE_B0) {
206 LOG_ERROR("Option Byte Operation's must use bank0");
207 return ERROR_FLASH_OPERATION_FAILED;
213 static int stm32x_read_options(struct flash_bank *bank)
216 struct stm32x_flash_bank *stm32x_info = NULL;
217 struct target *target = bank->target;
219 stm32x_info = bank->driver_priv;
221 /* read current option bytes */
222 int retval = target_read_u32(target, STM32_FLASH_OBR_B0, &optiondata);
223 if (retval != ERROR_OK)
226 stm32x_info->option_bytes.user_options = (uint16_t)0xFFF8 | ((optiondata >> 2) & 0x07);
227 stm32x_info->option_bytes.RDP = (optiondata & (1 << OPT_READOUT)) ? 0xFFFF : 0x5AA5;
229 if (optiondata & (1 << OPT_READOUT))
230 LOG_INFO("Device Security Bit Set");
232 /* each bit refers to a 4bank protection */
233 retval = target_read_u32(target, STM32_FLASH_WRPR_B0, &optiondata);
234 if (retval != ERROR_OK)
237 stm32x_info->option_bytes.protection[0] = (uint16_t)optiondata;
238 stm32x_info->option_bytes.protection[1] = (uint16_t)(optiondata >> 8);
239 stm32x_info->option_bytes.protection[2] = (uint16_t)(optiondata >> 16);
240 stm32x_info->option_bytes.protection[3] = (uint16_t)(optiondata >> 24);
245 static int stm32x_erase_options(struct flash_bank *bank)
247 struct stm32x_flash_bank *stm32x_info = NULL;
248 struct target *target = bank->target;
250 stm32x_info = bank->driver_priv;
252 /* read current options */
253 stm32x_read_options(bank);
255 /* unlock flash registers */
256 int retval = target_write_u32(target, STM32_FLASH_KEYR_B0, KEY1);
257 if (retval != ERROR_OK)
260 retval = target_write_u32(target, STM32_FLASH_KEYR_B0, KEY2);
261 if (retval != ERROR_OK)
264 /* unlock option flash registers */
265 retval = target_write_u32(target, STM32_FLASH_OPTKEYR_B0, KEY1);
266 if (retval != ERROR_OK)
268 retval = target_write_u32(target, STM32_FLASH_OPTKEYR_B0, KEY2);
269 if (retval != ERROR_OK)
272 /* erase option bytes */
273 retval = target_write_u32(target, STM32_FLASH_CR_B0, FLASH_OPTER | FLASH_OPTWRE);
274 if (retval != ERROR_OK)
276 retval = target_write_u32(target, STM32_FLASH_CR_B0, FLASH_OPTER | FLASH_STRT | FLASH_OPTWRE);
277 if (retval != ERROR_OK)
280 retval = stm32x_wait_status_busy(bank, 10);
281 if (retval != ERROR_OK)
284 /* clear readout protection and complementary option bytes
285 * this will also force a device unlock if set */
286 stm32x_info->option_bytes.RDP = 0x5AA5;
291 static int stm32x_write_options(struct flash_bank *bank)
293 struct stm32x_flash_bank *stm32x_info = NULL;
294 struct target *target = bank->target;
296 stm32x_info = bank->driver_priv;
298 /* unlock flash registers */
299 int retval = target_write_u32(target, STM32_FLASH_KEYR_B0, KEY1);
300 if (retval != ERROR_OK)
302 retval = target_write_u32(target, STM32_FLASH_KEYR_B0, KEY2);
303 if (retval != ERROR_OK)
306 /* unlock option flash registers */
307 retval = target_write_u32(target, STM32_FLASH_OPTKEYR_B0, KEY1);
308 if (retval != ERROR_OK)
310 retval = target_write_u32(target, STM32_FLASH_OPTKEYR_B0, KEY2);
311 if (retval != ERROR_OK)
314 /* program option bytes */
315 retval = target_write_u32(target, STM32_FLASH_CR_B0, FLASH_OPTPG | FLASH_OPTWRE);
316 if (retval != ERROR_OK)
319 /* write user option byte */
320 retval = target_write_u16(target, STM32_OB_USER, stm32x_info->option_bytes.user_options);
321 if (retval != ERROR_OK)
324 retval = stm32x_wait_status_busy(bank, 10);
325 if (retval != ERROR_OK)
328 /* write protection byte 1 */
329 retval = target_write_u16(target, STM32_OB_WRP0, stm32x_info->option_bytes.protection[0]);
330 if (retval != ERROR_OK)
333 retval = stm32x_wait_status_busy(bank, 10);
334 if (retval != ERROR_OK)
337 /* write protection byte 2 */
338 retval = target_write_u16(target, STM32_OB_WRP1, stm32x_info->option_bytes.protection[1]);
339 if (retval != ERROR_OK)
342 retval = stm32x_wait_status_busy(bank, 10);
343 if (retval != ERROR_OK)
346 /* write protection byte 3 */
347 retval = target_write_u16(target, STM32_OB_WRP2, stm32x_info->option_bytes.protection[2]);
348 if (retval != ERROR_OK)
351 retval = stm32x_wait_status_busy(bank, 10);
352 if (retval != ERROR_OK)
355 /* write protection byte 4 */
356 retval = target_write_u16(target, STM32_OB_WRP3, stm32x_info->option_bytes.protection[3]);
357 if (retval != ERROR_OK)
360 retval = stm32x_wait_status_busy(bank, 10);
361 if (retval != ERROR_OK)
364 /* write readout protection bit */
365 retval = target_write_u16(target, STM32_OB_RDP, stm32x_info->option_bytes.RDP);
366 if (retval != ERROR_OK)
369 retval = stm32x_wait_status_busy(bank, 10);
370 if (retval != ERROR_OK)
373 retval = target_write_u32(target, STM32_FLASH_CR_B0, FLASH_LOCK);
374 if (retval != ERROR_OK)
380 static int stm32x_protect_check(struct flash_bank *bank)
382 struct target *target = bank->target;
383 struct stm32x_flash_bank *stm32x_info = bank->driver_priv;
390 if (target->state != TARGET_HALTED) {
391 LOG_ERROR("Target not halted");
392 return ERROR_TARGET_NOT_HALTED;
395 int retval = stm32x_check_operation_supported(bank);
396 if (ERROR_OK != retval)
399 /* medium density - each bit refers to a 4bank protection
400 * high density - each bit refers to a 2bank protection */
401 retval = target_read_u32(target, STM32_FLASH_WRPR_B0, &protection);
402 if (retval != ERROR_OK)
405 /* medium density - each protection bit is for 4 * 1K pages
406 * high density - each protection bit is for 2 * 2K pages */
407 num_bits = (bank->num_sectors / stm32x_info->ppage_size);
409 if (stm32x_info->ppage_size == 2) {
410 /* high density flash/connectivity line protection */
414 if (protection & (1 << 31))
417 /* bit 31 controls sector 62 - 255 protection for high density
418 * bit 31 controls sector 62 - 127 protection for connectivity line */
419 for (s = 62; s < bank->num_sectors; s++)
420 bank->sectors[s].is_protected = set;
422 if (bank->num_sectors > 61)
425 for (i = 0; i < num_bits; i++) {
428 if (protection & (1 << i))
431 for (s = 0; s < stm32x_info->ppage_size; s++)
432 bank->sectors[(i * stm32x_info->ppage_size) + s].is_protected = set;
435 /* low/medium density flash protection */
436 for (i = 0; i < num_bits; i++) {
439 if (protection & (1 << i))
442 for (s = 0; s < stm32x_info->ppage_size; s++)
443 bank->sectors[(i * stm32x_info->ppage_size) + s].is_protected = set;
450 static int stm32x_erase(struct flash_bank *bank, int first, int last)
452 struct target *target = bank->target;
455 if (bank->target->state != TARGET_HALTED) {
456 LOG_ERROR("Target not halted");
457 return ERROR_TARGET_NOT_HALTED;
460 if ((first == 0) && (last == (bank->num_sectors - 1)))
461 return stm32x_mass_erase(bank);
463 /* unlock flash registers */
464 int retval = target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_KEYR), KEY1);
465 if (retval != ERROR_OK)
467 retval = target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_KEYR), KEY2);
468 if (retval != ERROR_OK)
471 for (i = first; i <= last; i++) {
472 retval = target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_CR), FLASH_PER);
473 if (retval != ERROR_OK)
475 retval = target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_AR),
476 bank->base + bank->sectors[i].offset);
477 if (retval != ERROR_OK)
479 retval = target_write_u32(target,
480 stm32x_get_flash_reg(bank, STM32_FLASH_CR), FLASH_PER | FLASH_STRT);
481 if (retval != ERROR_OK)
484 retval = stm32x_wait_status_busy(bank, 100);
485 if (retval != ERROR_OK)
488 bank->sectors[i].is_erased = 1;
491 retval = target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_CR), FLASH_LOCK);
492 if (retval != ERROR_OK)
498 static int stm32x_protect(struct flash_bank *bank, int set, int first, int last)
500 struct stm32x_flash_bank *stm32x_info = NULL;
501 struct target *target = bank->target;
502 uint16_t prot_reg[4] = {0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF};
507 stm32x_info = bank->driver_priv;
509 if (target->state != TARGET_HALTED) {
510 LOG_ERROR("Target not halted");
511 return ERROR_TARGET_NOT_HALTED;
514 int retval = stm32x_check_operation_supported(bank);
515 if (ERROR_OK != retval)
518 if ((first % stm32x_info->ppage_size) != 0) {
519 LOG_WARNING("aligned start protect sector to a %d sector boundary",
520 stm32x_info->ppage_size);
521 first = first - (first % stm32x_info->ppage_size);
523 if (((last + 1) % stm32x_info->ppage_size) != 0) {
524 LOG_WARNING("aligned end protect sector to a %d sector boundary",
525 stm32x_info->ppage_size);
527 last = last - (last % stm32x_info->ppage_size);
531 /* medium density - each bit refers to a 4bank protection
532 * high density - each bit refers to a 2bank protection */
533 retval = target_read_u32(target, STM32_FLASH_WRPR_B0, &protection);
534 if (retval != ERROR_OK)
537 prot_reg[0] = (uint16_t)protection;
538 prot_reg[1] = (uint16_t)(protection >> 8);
539 prot_reg[2] = (uint16_t)(protection >> 16);
540 prot_reg[3] = (uint16_t)(protection >> 24);
542 if (stm32x_info->ppage_size == 2) {
543 /* high density flash */
545 /* bit 7 controls sector 62 - 255 protection */
548 prot_reg[3] &= ~(1 << 7);
550 prot_reg[3] |= (1 << 7);
558 for (i = first; i <= last; i++) {
559 reg = (i / stm32x_info->ppage_size) / 8;
560 bit = (i / stm32x_info->ppage_size) - (reg * 8);
563 prot_reg[reg] &= ~(1 << bit);
565 prot_reg[reg] |= (1 << bit);
568 /* medium density flash */
569 for (i = first; i <= last; i++) {
570 reg = (i / stm32x_info->ppage_size) / 8;
571 bit = (i / stm32x_info->ppage_size) - (reg * 8);
574 prot_reg[reg] &= ~(1 << bit);
576 prot_reg[reg] |= (1 << bit);
580 status = stm32x_erase_options(bank);
581 if (status != ERROR_OK)
584 stm32x_info->option_bytes.protection[0] = prot_reg[0];
585 stm32x_info->option_bytes.protection[1] = prot_reg[1];
586 stm32x_info->option_bytes.protection[2] = prot_reg[2];
587 stm32x_info->option_bytes.protection[3] = prot_reg[3];
589 return stm32x_write_options(bank);
592 static int stm32x_write_block(struct flash_bank *bank, uint8_t *buffer,
593 uint32_t offset, uint32_t count)
595 struct stm32x_flash_bank *stm32x_info = bank->driver_priv;
596 struct target *target = bank->target;
597 uint32_t buffer_size = 16384;
598 struct working_area *source;
599 uint32_t address = bank->base + offset;
600 struct reg_param reg_params[5];
601 struct armv7m_algorithm armv7m_info;
602 int retval = ERROR_OK;
604 /* see contrib/loaders/flash/stm32f1x.S for src */
606 static const uint8_t stm32x_flash_write_code[] = {
607 /* #define STM32_FLASH_CR_OFFSET 0x10 */
608 /* #define STM32_FLASH_SR_OFFSET 0x0C */
610 0x16, 0x68, /* ldr r6, [r2, #0] */
611 0x00, 0x2e, /* cmp r6, #0 */
612 0x1a, 0xd0, /* beq exit */
613 0x55, 0x68, /* ldr r5, [r2, #4] */
614 0xb5, 0x42, /* cmp r5, r6 */
615 0xf9, 0xd0, /* beq wait_fifo */
616 0x01, 0x26, /* movs r6, #1 */
617 0x06, 0x61, /* str r6, [r0, #STM32_FLASH_CR_OFFSET] */
618 0x2e, 0x88, /* ldrh r6, [r5, #0] */
619 0x26, 0x80, /* strh r6, [r4, #0] */
620 0x02, 0x35, /* adds r5, #2 */
621 0x02, 0x34, /* adds r4, #2 */
623 0xc6, 0x68, /* ldr r6, [r0, #STM32_FLASH_SR_OFFSET] */
624 0x01, 0x27, /* movs r7, #1 */
625 0x3e, 0x42, /* tst r6, r7 */
626 0xfb, 0xd1, /* bne busy */
627 0x14, 0x27, /* movs r7, #0x14 */
628 0x3e, 0x42, /* tst r6, r7 */
629 0x08, 0xd1, /* bne error */
630 0x9d, 0x42, /* cmp r5, r3 */
631 0x01, 0xd3, /* bcc no_wrap */
632 0x15, 0x46, /* mov r5, r2 */
633 0x08, 0x35, /* adds r5, #8 */
635 0x55, 0x60, /* str r5, [r2, #4] */
636 0x01, 0x39, /* subs r1, r1, #1 */
637 0x00, 0x29, /* cmp r1, #0 */
638 0x02, 0xd0, /* beq exit */
639 0xe3, 0xe7, /* b wait_fifo */
641 0x00, 0x20, /* movs r0, #0 */
642 0x50, 0x60, /* str r0, [r2, #4] */
644 0x30, 0x46, /* mov r0, r6 */
645 0x00, 0xbe, /* bkpt #0 */
648 /* flash write code */
649 if (target_alloc_working_area(target, sizeof(stm32x_flash_write_code),
650 &stm32x_info->write_algorithm) != ERROR_OK) {
651 LOG_WARNING("no working area available, can't do block memory writes");
652 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
655 retval = target_write_buffer(target, stm32x_info->write_algorithm->address,
656 sizeof(stm32x_flash_write_code), (uint8_t *)stm32x_flash_write_code);
657 if (retval != ERROR_OK)
661 while (target_alloc_working_area_try(target, buffer_size, &source) != ERROR_OK) {
663 buffer_size &= ~3UL; /* Make sure it's 4 byte aligned */
664 if (buffer_size <= 256) {
665 /* if we already allocated the writing code, but failed to get a
666 * buffer, free the algorithm */
667 if (stm32x_info->write_algorithm)
668 target_free_working_area(target, stm32x_info->write_algorithm);
670 LOG_WARNING("no large enough working area available, can't do block memory writes");
671 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
675 init_reg_param(®_params[0], "r0", 32, PARAM_IN_OUT); /* flash base (in), status (out) */
676 init_reg_param(®_params[1], "r1", 32, PARAM_OUT); /* count (halfword-16bit) */
677 init_reg_param(®_params[2], "r2", 32, PARAM_OUT); /* buffer start */
678 init_reg_param(®_params[3], "r3", 32, PARAM_OUT); /* buffer end */
679 init_reg_param(®_params[4], "r4", 32, PARAM_IN_OUT); /* target address */
681 buf_set_u32(reg_params[0].value, 0, 32, stm32x_info->register_base);
682 buf_set_u32(reg_params[1].value, 0, 32, count);
683 buf_set_u32(reg_params[2].value, 0, 32, source->address);
684 buf_set_u32(reg_params[3].value, 0, 32, source->address + source->size);
685 buf_set_u32(reg_params[4].value, 0, 32, address);
687 armv7m_info.common_magic = ARMV7M_COMMON_MAGIC;
688 armv7m_info.core_mode = ARMV7M_MODE_ANY;
690 retval = target_run_flash_async_algorithm(target, buffer, count, 2,
693 source->address, source->size,
694 stm32x_info->write_algorithm->address, 0,
697 if (retval == ERROR_FLASH_OPERATION_FAILED) {
698 LOG_ERROR("flash write failed at address 0x%"PRIx32,
699 buf_get_u32(reg_params[4].value, 0, 32));
701 if (buf_get_u32(reg_params[0].value, 0, 32) & FLASH_PGERR) {
702 LOG_ERROR("flash memory not erased before writing");
703 /* Clear but report errors */
704 target_write_u32(target, STM32_FLASH_SR_B0, FLASH_PGERR);
707 if (buf_get_u32(reg_params[0].value, 0, 32) & FLASH_WRPRTERR) {
708 LOG_ERROR("flash memory write protected");
709 /* Clear but report errors */
710 target_write_u32(target, STM32_FLASH_SR_B0, FLASH_WRPRTERR);
714 target_free_working_area(target, source);
715 target_free_working_area(target, stm32x_info->write_algorithm);
717 destroy_reg_param(®_params[0]);
718 destroy_reg_param(®_params[1]);
719 destroy_reg_param(®_params[2]);
720 destroy_reg_param(®_params[3]);
721 destroy_reg_param(®_params[4]);
726 static int stm32x_write(struct flash_bank *bank, uint8_t *buffer,
727 uint32_t offset, uint32_t count)
729 struct target *target = bank->target;
730 uint32_t words_remaining = (count / 2);
731 uint32_t bytes_remaining = (count & 0x00000001);
732 uint32_t address = bank->base + offset;
733 uint32_t bytes_written = 0;
736 if (bank->target->state != TARGET_HALTED) {
737 LOG_ERROR("Target not halted");
738 return ERROR_TARGET_NOT_HALTED;
742 LOG_WARNING("offset 0x%" PRIx32 " breaks required 2-byte alignment", offset);
743 return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
746 /* unlock flash registers */
747 retval = target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_KEYR), KEY1);
748 if (retval != ERROR_OK)
750 retval = target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_KEYR), KEY2);
751 if (retval != ERROR_OK)
754 /* multiple half words (2-byte) to be programmed? */
755 if (words_remaining > 0) {
756 /* try using a block write */
757 retval = stm32x_write_block(bank, buffer, offset, words_remaining);
758 if (retval != ERROR_OK) {
759 if (retval == ERROR_TARGET_RESOURCE_NOT_AVAILABLE) {
760 /* if block write failed (no sufficient working area),
761 * we use normal (slow) single dword accesses */
762 LOG_WARNING("couldn't use block writes, falling back to single memory accesses");
765 buffer += words_remaining * 2;
766 address += words_remaining * 2;
771 if ((retval != ERROR_OK) && (retval != ERROR_TARGET_RESOURCE_NOT_AVAILABLE))
774 while (words_remaining > 0) {
776 memcpy(&value, buffer + bytes_written, sizeof(uint16_t));
778 retval = target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_CR), FLASH_PG);
779 if (retval != ERROR_OK)
781 retval = target_write_u16(target, address, value);
782 if (retval != ERROR_OK)
785 retval = stm32x_wait_status_busy(bank, 5);
786 if (retval != ERROR_OK)
794 if (bytes_remaining) {
795 uint16_t value = 0xffff;
796 memcpy(&value, buffer + bytes_written, bytes_remaining);
798 retval = target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_CR), FLASH_PG);
799 if (retval != ERROR_OK)
801 retval = target_write_u16(target, address, value);
802 if (retval != ERROR_OK)
805 retval = stm32x_wait_status_busy(bank, 5);
806 if (retval != ERROR_OK)
810 return target_write_u32(target, STM32_FLASH_CR_B0, FLASH_LOCK);
813 static int stm32x_get_device_id(struct flash_bank *bank, uint32_t *device_id)
815 /* This check the device CPUID core register to detect
816 * the M0 from the M3 devices. */
818 struct target *target = bank->target;
819 uint32_t cpuid, device_id_register = 0;
821 /* Get the CPUID from the ARM Core
822 * http://infocenter.arm.com/help/topic/com.arm.doc.ddi0432c/DDI0432C_cortex_m0_r0p0_trm.pdf 4.2.1 */
823 int retval = target_read_u32(target, 0xE000ED00, &cpuid);
824 if (retval != ERROR_OK)
827 if (((cpuid >> 4) & 0xFFF) == 0xC20) {
828 /* 0xC20 is M0 devices */
829 device_id_register = 0x40015800;
830 } else if (((cpuid >> 4) & 0xFFF) == 0xC23) {
831 /* 0xC23 is M3 devices */
832 device_id_register = 0xE0042000;
834 LOG_ERROR("Cannot identify target as a stm32x");
838 /* read stm32 device id register */
839 retval = target_read_u32(target, device_id_register, device_id);
840 if (retval != ERROR_OK)
846 static int stm32x_probe(struct flash_bank *bank)
848 struct target *target = bank->target;
849 struct stm32x_flash_bank *stm32x_info = bank->driver_priv;
851 uint16_t flash_size_in_kb;
854 uint32_t base_address = 0x08000000;
857 stm32x_info->probed = 0;
858 stm32x_info->register_base = FLASH_REG_BASE_B0;
860 /* read stm32 device id register */
861 int retval = stm32x_get_device_id(bank, &device_id);
862 if (retval != ERROR_OK)
865 LOG_INFO("device id = 0x%08" PRIx32 "", device_id);
867 /* get flash size from target. */
868 retval = target_read_u16(target, 0x1FFFF7E0, &flash_size_in_kb);
869 if (retval != ERROR_OK) {
870 LOG_WARNING("failed reading flash size, default to max target family");
871 /* failed reading flash size, default to max target family */
872 flash_size_in_kb = 0xffff;
875 if ((device_id & 0xfff) == 0x410) {
876 /* medium density - we have 1k pages
877 * 4 pages for a protection area */
879 stm32x_info->ppage_size = 4;
881 /* check for early silicon */
882 if (flash_size_in_kb == 0xffff) {
883 /* number of sectors incorrect on revA */
884 LOG_WARNING("STM32 flash size failed, probe inaccurate - assuming 128k flash");
885 flash_size_in_kb = 128;
887 } else if ((device_id & 0xfff) == 0x412) {
888 /* low density - we have 1k pages
889 * 4 pages for a protection area */
891 stm32x_info->ppage_size = 4;
893 /* check for early silicon */
894 if (flash_size_in_kb == 0xffff) {
895 /* number of sectors incorrect on revA */
896 LOG_WARNING("STM32 flash size failed, probe inaccurate - assuming 32k flash");
897 flash_size_in_kb = 32;
899 } else if ((device_id & 0xfff) == 0x414) {
900 /* high density - we have 2k pages
901 * 2 pages for a protection area */
903 stm32x_info->ppage_size = 2;
905 /* check for early silicon */
906 if (flash_size_in_kb == 0xffff) {
907 /* number of sectors incorrect on revZ */
908 LOG_WARNING("STM32 flash size failed, probe inaccurate - assuming 512k flash");
909 flash_size_in_kb = 512;
911 } else if ((device_id & 0xfff) == 0x418) {
912 /* connectivity line density - we have 2k pages
913 * 2 pages for a protection area */
915 stm32x_info->ppage_size = 2;
917 /* check for early silicon */
918 if (flash_size_in_kb == 0xffff) {
919 /* number of sectors incorrect on revZ */
920 LOG_WARNING("STM32 flash size failed, probe inaccurate - assuming 256k flash");
921 flash_size_in_kb = 256;
923 } else if ((device_id & 0xfff) == 0x420) {
924 /* value line density - we have 1k pages
925 * 4 pages for a protection area */
927 stm32x_info->ppage_size = 4;
929 /* check for early silicon */
930 if (flash_size_in_kb == 0xffff) {
931 /* number of sectors may be incorrrect on early silicon */
932 LOG_WARNING("STM32 flash size failed, probe inaccurate - assuming 128k flash");
933 flash_size_in_kb = 128;
935 } else if ((device_id & 0xfff) == 0x428) {
936 /* value line High density - we have 2k pages
937 * 4 pages for a protection area */
939 stm32x_info->ppage_size = 4;
941 /* check for early silicon */
942 if (flash_size_in_kb == 0xffff) {
943 /* number of sectors may be incorrrect on early silicon */
944 LOG_WARNING("STM32 flash size failed, probe inaccurate - assuming 128k flash");
945 flash_size_in_kb = 128;
947 } else if ((device_id & 0xfff) == 0x430) {
948 /* xl line density - we have 2k pages
949 * 2 pages for a protection area */
951 stm32x_info->ppage_size = 2;
952 stm32x_info->has_dual_banks = true;
954 /* check for early silicon */
955 if (flash_size_in_kb == 0xffff) {
956 /* number of sectors may be incorrrect on early silicon */
957 LOG_WARNING("STM32 flash size failed, probe inaccurate - assuming 1024k flash");
958 flash_size_in_kb = 1024;
961 /* split reported size into matching bank */
962 if (bank->base != 0x08080000) {
963 /* bank 0 will be fixed 512k */
964 flash_size_in_kb = 512;
966 flash_size_in_kb -= 512;
967 /* bank1 also uses a register offset */
968 stm32x_info->register_base = FLASH_REG_BASE_B1;
969 base_address = 0x08080000;
971 } else if ((device_id & 0xfff) == 0x440) {
972 /* stm32f0x - we have 1k pages
973 * 4 pages for a protection area */
975 stm32x_info->ppage_size = 4;
977 /* check for early silicon */
978 if (flash_size_in_kb == 0xffff) {
979 /* number of sectors incorrect on revZ */
980 LOG_WARNING("STM32 flash size failed, probe inaccurate - assuming 64k flash");
981 flash_size_in_kb = 64;
984 LOG_WARNING("Cannot identify target as a STM32 family.");
988 LOG_INFO("flash size = %dkbytes", flash_size_in_kb);
990 /* did we assign flash size? */
991 assert(flash_size_in_kb != 0xffff);
993 /* calculate numbers of pages */
994 int num_pages = flash_size_in_kb * 1024 / page_size;
996 /* check that calculation result makes sense */
997 assert(num_pages > 0);
1000 free(bank->sectors);
1001 bank->sectors = NULL;
1004 bank->base = base_address;
1005 bank->size = (num_pages * page_size);
1006 bank->num_sectors = num_pages;
1007 bank->sectors = malloc(sizeof(struct flash_sector) * num_pages);
1009 for (i = 0; i < num_pages; i++) {
1010 bank->sectors[i].offset = i * page_size;
1011 bank->sectors[i].size = page_size;
1012 bank->sectors[i].is_erased = -1;
1013 bank->sectors[i].is_protected = 1;
1016 stm32x_info->probed = 1;
1021 static int stm32x_auto_probe(struct flash_bank *bank)
1023 struct stm32x_flash_bank *stm32x_info = bank->driver_priv;
1024 if (stm32x_info->probed)
1026 return stm32x_probe(bank);
1030 COMMAND_HANDLER(stm32x_handle_part_id_command)
1036 static int get_stm32x_info(struct flash_bank *bank, char *buf, int buf_size)
1041 /* read stm32 device id register */
1042 int retval = stm32x_get_device_id(bank, &device_id);
1043 if (retval != ERROR_OK)
1046 if ((device_id & 0xfff) == 0x410) {
1047 printed = snprintf(buf, buf_size, "stm32x (Medium Density) - Rev: ");
1049 buf_size -= printed;
1051 switch (device_id >> 16) {
1053 snprintf(buf, buf_size, "A");
1057 snprintf(buf, buf_size, "B");
1061 snprintf(buf, buf_size, "Z");
1065 snprintf(buf, buf_size, "Y");
1069 snprintf(buf, buf_size, "unknown");
1072 } else if ((device_id & 0xfff) == 0x412) {
1073 printed = snprintf(buf, buf_size, "stm32x (Low Density) - Rev: ");
1075 buf_size -= printed;
1077 switch (device_id >> 16) {
1079 snprintf(buf, buf_size, "A");
1083 snprintf(buf, buf_size, "unknown");
1086 } else if ((device_id & 0xfff) == 0x414) {
1087 printed = snprintf(buf, buf_size, "stm32x (High Density) - Rev: ");
1089 buf_size -= printed;
1091 switch (device_id >> 16) {
1093 snprintf(buf, buf_size, "A");
1097 snprintf(buf, buf_size, "Z");
1101 snprintf(buf, buf_size, "unknown");
1104 } else if ((device_id & 0xfff) == 0x418) {
1105 printed = snprintf(buf, buf_size, "stm32x (Connectivity) - Rev: ");
1107 buf_size -= printed;
1109 switch (device_id >> 16) {
1111 snprintf(buf, buf_size, "A");
1115 snprintf(buf, buf_size, "Z");
1119 snprintf(buf, buf_size, "unknown");
1122 } else if ((device_id & 0xfff) == 0x420) {
1123 printed = snprintf(buf, buf_size, "stm32x (Value) - Rev: ");
1125 buf_size -= printed;
1127 switch (device_id >> 16) {
1129 snprintf(buf, buf_size, "A");
1133 snprintf(buf, buf_size, "Z");
1137 snprintf(buf, buf_size, "unknown");
1140 } else if ((device_id & 0xfff) == 0x428) {
1141 printed = snprintf(buf, buf_size, "stm32x (Value HD) - Rev: ");
1143 buf_size -= printed;
1145 switch (device_id >> 16) {
1147 snprintf(buf, buf_size, "A");
1151 snprintf(buf, buf_size, "Z");
1155 snprintf(buf, buf_size, "unknown");
1158 } else if ((device_id & 0xfff) == 0x430) {
1159 printed = snprintf(buf, buf_size, "stm32x (XL) - Rev: ");
1161 buf_size -= printed;
1163 switch (device_id >> 16) {
1165 snprintf(buf, buf_size, "A");
1169 snprintf(buf, buf_size, "unknown");
1172 } else if ((device_id & 0xfff) == 0x440) {
1173 printed = snprintf(buf, buf_size, "stm32f0x - Rev: ");
1175 buf_size -= printed;
1177 switch (device_id >> 16) {
1179 snprintf(buf, buf_size, "A");
1183 snprintf(buf, buf_size, "unknown");
1187 snprintf(buf, buf_size, "Cannot identify target as a stm32x\n");
1194 COMMAND_HANDLER(stm32x_handle_lock_command)
1196 struct target *target = NULL;
1197 struct stm32x_flash_bank *stm32x_info = NULL;
1200 return ERROR_COMMAND_SYNTAX_ERROR;
1202 struct flash_bank *bank;
1203 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
1204 if (ERROR_OK != retval)
1207 stm32x_info = bank->driver_priv;
1209 target = bank->target;
1211 if (target->state != TARGET_HALTED) {
1212 LOG_ERROR("Target not halted");
1213 return ERROR_TARGET_NOT_HALTED;
1216 retval = stm32x_check_operation_supported(bank);
1217 if (ERROR_OK != retval)
1220 if (stm32x_erase_options(bank) != ERROR_OK) {
1221 command_print(CMD_CTX, "stm32x failed to erase options");
1225 /* set readout protection */
1226 stm32x_info->option_bytes.RDP = 0;
1228 if (stm32x_write_options(bank) != ERROR_OK) {
1229 command_print(CMD_CTX, "stm32x failed to lock device");
1233 command_print(CMD_CTX, "stm32x locked");
1238 COMMAND_HANDLER(stm32x_handle_unlock_command)
1240 struct target *target = NULL;
1243 return ERROR_COMMAND_SYNTAX_ERROR;
1245 struct flash_bank *bank;
1246 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
1247 if (ERROR_OK != retval)
1250 target = bank->target;
1252 if (target->state != TARGET_HALTED) {
1253 LOG_ERROR("Target not halted");
1254 return ERROR_TARGET_NOT_HALTED;
1257 retval = stm32x_check_operation_supported(bank);
1258 if (ERROR_OK != retval)
1261 if (stm32x_erase_options(bank) != ERROR_OK) {
1262 command_print(CMD_CTX, "stm32x failed to unlock device");
1266 if (stm32x_write_options(bank) != ERROR_OK) {
1267 command_print(CMD_CTX, "stm32x failed to lock device");
1271 command_print(CMD_CTX, "stm32x unlocked.\n"
1272 "INFO: a reset or power cycle is required "
1273 "for the new settings to take effect.");
1278 COMMAND_HANDLER(stm32x_handle_options_read_command)
1280 uint32_t optionbyte;
1281 struct target *target = NULL;
1282 struct stm32x_flash_bank *stm32x_info = NULL;
1285 return ERROR_COMMAND_SYNTAX_ERROR;
1287 struct flash_bank *bank;
1288 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
1289 if (ERROR_OK != retval)
1292 stm32x_info = bank->driver_priv;
1294 target = bank->target;
1296 if (target->state != TARGET_HALTED) {
1297 LOG_ERROR("Target not halted");
1298 return ERROR_TARGET_NOT_HALTED;
1301 retval = stm32x_check_operation_supported(bank);
1302 if (ERROR_OK != retval)
1305 retval = target_read_u32(target, STM32_FLASH_OBR_B0, &optionbyte);
1306 if (retval != ERROR_OK)
1308 command_print(CMD_CTX, "Option Byte: 0x%" PRIx32 "", optionbyte);
1310 if (buf_get_u32((uint8_t *)&optionbyte, OPT_ERROR, 1))
1311 command_print(CMD_CTX, "Option Byte Complement Error");
1313 if (buf_get_u32((uint8_t *)&optionbyte, OPT_READOUT, 1))
1314 command_print(CMD_CTX, "Readout Protection On");
1316 command_print(CMD_CTX, "Readout Protection Off");
1318 if (buf_get_u32((uint8_t *)&optionbyte, OPT_RDWDGSW, 1))
1319 command_print(CMD_CTX, "Software Watchdog");
1321 command_print(CMD_CTX, "Hardware Watchdog");
1323 if (buf_get_u32((uint8_t *)&optionbyte, OPT_RDRSTSTOP, 1))
1324 command_print(CMD_CTX, "Stop: No reset generated");
1326 command_print(CMD_CTX, "Stop: Reset generated");
1328 if (buf_get_u32((uint8_t *)&optionbyte, OPT_RDRSTSTDBY, 1))
1329 command_print(CMD_CTX, "Standby: No reset generated");
1331 command_print(CMD_CTX, "Standby: Reset generated");
1333 if (stm32x_info->has_dual_banks) {
1334 if (buf_get_u32((uint8_t *)&optionbyte, OPT_BFB2, 1))
1335 command_print(CMD_CTX, "Boot: Bank 0");
1337 command_print(CMD_CTX, "Boot: Bank 1");
1343 COMMAND_HANDLER(stm32x_handle_options_write_command)
1345 struct target *target = NULL;
1346 struct stm32x_flash_bank *stm32x_info = NULL;
1347 uint16_t optionbyte = 0xF8;
1350 return ERROR_COMMAND_SYNTAX_ERROR;
1352 struct flash_bank *bank;
1353 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
1354 if (ERROR_OK != retval)
1357 stm32x_info = bank->driver_priv;
1359 target = bank->target;
1361 if (target->state != TARGET_HALTED) {
1362 LOG_ERROR("Target not halted");
1363 return ERROR_TARGET_NOT_HALTED;
1366 retval = stm32x_check_operation_supported(bank);
1367 if (ERROR_OK != retval)
1370 /* REVISIT: ignores some options which we will display...
1371 * and doesn't insist on the specified syntax.
1375 if (strcmp(CMD_ARGV[1], "SWWDG") == 0)
1376 optionbyte |= (1 << 0);
1377 else /* REVISIT must be "HWWDG" then ... */
1378 optionbyte &= ~(1 << 0);
1381 if (strcmp(CMD_ARGV[2], "NORSTSTOP") == 0)
1382 optionbyte |= (1 << 1);
1383 else /* REVISIT must be "RSTSTNDBY" then ... */
1384 optionbyte &= ~(1 << 1);
1386 /* OPT_RDRSTSTDBY */
1387 if (strcmp(CMD_ARGV[3], "NORSTSTNDBY") == 0)
1388 optionbyte |= (1 << 2);
1389 else /* REVISIT must be "RSTSTOP" then ... */
1390 optionbyte &= ~(1 << 2);
1392 if (CMD_ARGC > 4 && stm32x_info->has_dual_banks) {
1394 if (strcmp(CMD_ARGV[4], "BOOT0") == 0)
1395 optionbyte |= (1 << 3);
1397 optionbyte &= ~(1 << 3);
1400 if (stm32x_erase_options(bank) != ERROR_OK) {
1401 command_print(CMD_CTX, "stm32x failed to erase options");
1405 stm32x_info->option_bytes.user_options = optionbyte;
1407 if (stm32x_write_options(bank) != ERROR_OK) {
1408 command_print(CMD_CTX, "stm32x failed to write options");
1412 command_print(CMD_CTX, "stm32x write options complete.\n"
1413 "INFO: a reset or power cycle is required "
1414 "for the new settings to take effect.");
1419 static int stm32x_mass_erase(struct flash_bank *bank)
1421 struct target *target = bank->target;
1423 if (target->state != TARGET_HALTED) {
1424 LOG_ERROR("Target not halted");
1425 return ERROR_TARGET_NOT_HALTED;
1428 /* unlock option flash registers */
1429 int retval = target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_KEYR), KEY1);
1430 if (retval != ERROR_OK)
1432 retval = target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_KEYR), KEY2);
1433 if (retval != ERROR_OK)
1436 /* mass erase flash memory */
1437 retval = target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_CR), FLASH_MER);
1438 if (retval != ERROR_OK)
1440 retval = target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_CR),
1441 FLASH_MER | FLASH_STRT);
1442 if (retval != ERROR_OK)
1445 retval = stm32x_wait_status_busy(bank, 100);
1446 if (retval != ERROR_OK)
1449 retval = target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_CR), FLASH_LOCK);
1450 if (retval != ERROR_OK)
1456 COMMAND_HANDLER(stm32x_handle_mass_erase_command)
1461 return ERROR_COMMAND_SYNTAX_ERROR;
1463 struct flash_bank *bank;
1464 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
1465 if (ERROR_OK != retval)
1468 retval = stm32x_mass_erase(bank);
1469 if (retval == ERROR_OK) {
1470 /* set all sectors as erased */
1471 for (i = 0; i < bank->num_sectors; i++)
1472 bank->sectors[i].is_erased = 1;
1474 command_print(CMD_CTX, "stm32x mass erase complete");
1476 command_print(CMD_CTX, "stm32x mass erase failed");
1481 static const struct command_registration stm32x_exec_command_handlers[] = {
1484 .handler = stm32x_handle_lock_command,
1485 .mode = COMMAND_EXEC,
1487 .help = "Lock entire flash device.",
1491 .handler = stm32x_handle_unlock_command,
1492 .mode = COMMAND_EXEC,
1494 .help = "Unlock entire protected flash device.",
1497 .name = "mass_erase",
1498 .handler = stm32x_handle_mass_erase_command,
1499 .mode = COMMAND_EXEC,
1501 .help = "Erase entire flash device.",
1504 .name = "options_read",
1505 .handler = stm32x_handle_options_read_command,
1506 .mode = COMMAND_EXEC,
1508 .help = "Read and display device option byte.",
1511 .name = "options_write",
1512 .handler = stm32x_handle_options_write_command,
1513 .mode = COMMAND_EXEC,
1514 .usage = "bank_id ('SWWDG'|'HWWDG') "
1515 "('RSTSTNDBY'|'NORSTSTNDBY') "
1516 "('RSTSTOP'|'NORSTSTOP')",
1517 .help = "Replace bits in device option byte.",
1519 COMMAND_REGISTRATION_DONE
1522 static const struct command_registration stm32x_command_handlers[] = {
1525 .mode = COMMAND_ANY,
1526 .help = "stm32f1x flash command group",
1528 .chain = stm32x_exec_command_handlers,
1530 COMMAND_REGISTRATION_DONE
1533 struct flash_driver stm32f1x_flash = {
1535 .commands = stm32x_command_handlers,
1536 .flash_bank_command = stm32x_flash_bank_command,
1537 .erase = stm32x_erase,
1538 .protect = stm32x_protect,
1539 .write = stm32x_write,
1540 .read = default_flash_read,
1541 .probe = stm32x_probe,
1542 .auto_probe = stm32x_auto_probe,
1543 .erase_check = default_flash_mem_blank_check,
1544 .protect_check = stm32x_protect_check,
1545 .info = get_stm32x_info,