- preserve cortex_m3 C_MASKINTS during resume/step
[openocd.git] / src / flash / stm32x.c
blob0f62da91194de04a46a690ccd5736e5fc625bd4c
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2008 by Spencer Oliver *
6 * spen@spen-soft.co.uk *
7 * *
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. *
12 * *
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. *
17 * *
18 * You should have received a copy of the GNU General Public License *
19 * along with this program; if not, write to the *
20 * Free Software Foundation, Inc., *
21 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
22 ***************************************************************************/
23 #ifdef HAVE_CONFIG_H
24 #include "config.h"
25 #endif
27 #include "replacements.h"
29 #include "stm32x.h"
30 #include "flash.h"
31 #include "target.h"
32 #include "log.h"
33 #include "armv7m.h"
34 #include "algorithm.h"
35 #include "binarybuffer.h"
37 #include <stdlib.h>
38 #include <string.h>
40 int stm32x_register_commands(struct command_context_s *cmd_ctx);
41 int stm32x_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank);
42 int stm32x_erase(struct flash_bank_s *bank, int first, int last);
43 int stm32x_protect(struct flash_bank_s *bank, int set, int first, int last);
44 int stm32x_write(struct flash_bank_s *bank, u8 *buffer, u32 offset, u32 count);
45 int stm32x_probe(struct flash_bank_s *bank);
46 int stm32x_auto_probe(struct flash_bank_s *bank);
47 int stm32x_handle_part_id_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
48 int stm32x_protect_check(struct flash_bank_s *bank);
49 int stm32x_info(struct flash_bank_s *bank, char *buf, int buf_size);
51 int stm32x_handle_lock_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
52 int stm32x_handle_unlock_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
53 int stm32x_handle_options_read_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
54 int stm32x_handle_options_write_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
55 int stm32x_handle_mass_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
56 int stm32x_mass_erase(struct flash_bank_s *bank);
58 flash_driver_t stm32x_flash =
60 .name = "stm32x",
61 .register_commands = stm32x_register_commands,
62 .flash_bank_command = stm32x_flash_bank_command,
63 .erase = stm32x_erase,
64 .protect = stm32x_protect,
65 .write = stm32x_write,
66 .probe = stm32x_probe,
67 .auto_probe = stm32x_auto_probe,
68 .erase_check = default_flash_mem_blank_check,
69 .protect_check = stm32x_protect_check,
70 .info = stm32x_info
73 int stm32x_register_commands(struct command_context_s *cmd_ctx)
75 command_t *stm32x_cmd = register_command(cmd_ctx, NULL, "stm32x", NULL, COMMAND_ANY, "stm32x flash specific commands");
77 register_command(cmd_ctx, stm32x_cmd, "lock", stm32x_handle_lock_command, COMMAND_EXEC,
78 "lock device");
79 register_command(cmd_ctx, stm32x_cmd, "unlock", stm32x_handle_unlock_command, COMMAND_EXEC,
80 "unlock protected device");
81 register_command(cmd_ctx, stm32x_cmd, "mass_erase", stm32x_handle_mass_erase_command, COMMAND_EXEC,
82 "mass erase device");
83 register_command(cmd_ctx, stm32x_cmd, "options_read", stm32x_handle_options_read_command, COMMAND_EXEC,
84 "read device option bytes");
85 register_command(cmd_ctx, stm32x_cmd, "options_write", stm32x_handle_options_write_command, COMMAND_EXEC,
86 "write device option bytes");
87 return ERROR_OK;
90 /* flash bank stm32x <base> <size> 0 0 <target#>
92 int stm32x_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank)
94 stm32x_flash_bank_t *stm32x_info;
96 if (argc < 6)
98 LOG_WARNING("incomplete flash_bank stm32x configuration");
99 return ERROR_FLASH_BANK_INVALID;
102 stm32x_info = malloc(sizeof(stm32x_flash_bank_t));
103 bank->driver_priv = stm32x_info;
105 stm32x_info->write_algorithm = NULL;
106 stm32x_info->probed = 0;
108 return ERROR_OK;
111 u32 stm32x_get_flash_status(flash_bank_t *bank)
113 target_t *target = bank->target;
114 u32 status;
116 target_read_u32(target, STM32_FLASH_SR, &status);
118 return status;
121 u32 stm32x_wait_status_busy(flash_bank_t *bank, int timeout)
123 u32 status;
125 /* wait for busy to clear */
126 while (((status = stm32x_get_flash_status(bank)) & FLASH_BSY) && (timeout-- > 0))
128 LOG_DEBUG("status: 0x%x", status);
129 alive_sleep(1);
132 return status;
135 int stm32x_read_options(struct flash_bank_s *bank)
137 u32 optiondata;
138 stm32x_flash_bank_t *stm32x_info = NULL;
139 target_t *target = bank->target;
141 stm32x_info = bank->driver_priv;
143 /* read current option bytes */
144 target_read_u32(target, STM32_FLASH_OBR, &optiondata);
146 stm32x_info->option_bytes.user_options = (u16)0xFFF8|((optiondata >> 2) & 0x07);
147 stm32x_info->option_bytes.RDP = (optiondata & (1 << OPT_READOUT)) ? 0xFFFF : 0x5AA5;
149 if (optiondata & (1 << OPT_READOUT))
150 LOG_INFO("Device Security Bit Set");
152 /* each bit refers to a 4bank protection */
153 target_read_u32(target, STM32_FLASH_WRPR, &optiondata);
155 stm32x_info->option_bytes.protection[0] = (u16)optiondata;
156 stm32x_info->option_bytes.protection[1] = (u16)(optiondata >> 8);
157 stm32x_info->option_bytes.protection[2] = (u16)(optiondata >> 16);
158 stm32x_info->option_bytes.protection[3] = (u16)(optiondata >> 24);
160 return ERROR_OK;
163 int stm32x_erase_options(struct flash_bank_s *bank)
165 stm32x_flash_bank_t *stm32x_info = NULL;
166 target_t *target = bank->target;
167 u32 status;
169 stm32x_info = bank->driver_priv;
171 /* read current options */
172 stm32x_read_options(bank);
174 /* unlock flash registers */
175 target_write_u32(target, STM32_FLASH_KEYR, KEY1);
176 target_write_u32(target, STM32_FLASH_KEYR, KEY2);
178 /* unlock option flash registers */
179 target_write_u32(target, STM32_FLASH_OPTKEYR, KEY1);
180 target_write_u32(target, STM32_FLASH_OPTKEYR, KEY2);
182 /* erase option bytes */
183 target_write_u32(target, STM32_FLASH_CR, FLASH_OPTER|FLASH_OPTWRE);
184 target_write_u32(target, STM32_FLASH_CR, FLASH_OPTER|FLASH_STRT|FLASH_OPTWRE);
186 status = stm32x_wait_status_busy(bank, 10);
188 if( status & FLASH_WRPRTERR )
189 return ERROR_FLASH_OPERATION_FAILED;
190 if( status & FLASH_PGERR )
191 return ERROR_FLASH_OPERATION_FAILED;
193 /* clear readout protection and complementary option bytes
194 * this will also force a device unlock if set */
195 stm32x_info->option_bytes.RDP = 0x5AA5;
197 return ERROR_OK;
200 int stm32x_write_options(struct flash_bank_s *bank)
202 stm32x_flash_bank_t *stm32x_info = NULL;
203 target_t *target = bank->target;
204 u32 status;
206 stm32x_info = bank->driver_priv;
208 /* unlock flash registers */
209 target_write_u32(target, STM32_FLASH_KEYR, KEY1);
210 target_write_u32(target, STM32_FLASH_KEYR, KEY2);
212 /* unlock option flash registers */
213 target_write_u32(target, STM32_FLASH_OPTKEYR, KEY1);
214 target_write_u32(target, STM32_FLASH_OPTKEYR, KEY2);
216 /* program option bytes */
217 target_write_u32(target, STM32_FLASH_CR, FLASH_OPTPG|FLASH_OPTWRE);
219 /* write user option byte */
220 target_write_u16(target, STM32_OB_USER, stm32x_info->option_bytes.user_options);
222 status = stm32x_wait_status_busy(bank, 10);
224 if( status & FLASH_WRPRTERR )
225 return ERROR_FLASH_OPERATION_FAILED;
226 if( status & FLASH_PGERR )
227 return ERROR_FLASH_OPERATION_FAILED;
229 /* write protection byte 1 */
230 target_write_u16(target, STM32_OB_WRP0, stm32x_info->option_bytes.protection[0]);
232 status = stm32x_wait_status_busy(bank, 10);
234 if( status & FLASH_WRPRTERR )
235 return ERROR_FLASH_OPERATION_FAILED;
236 if( status & FLASH_PGERR )
237 return ERROR_FLASH_OPERATION_FAILED;
239 /* write protection byte 2 */
240 target_write_u16(target, STM32_OB_WRP1, stm32x_info->option_bytes.protection[1]);
242 status = stm32x_wait_status_busy(bank, 10);
244 if( status & FLASH_WRPRTERR )
245 return ERROR_FLASH_OPERATION_FAILED;
246 if( status & FLASH_PGERR )
247 return ERROR_FLASH_OPERATION_FAILED;
249 /* write protection byte 3 */
250 target_write_u16(target, STM32_OB_WRP2, stm32x_info->option_bytes.protection[2]);
252 status = stm32x_wait_status_busy(bank, 10);
254 if( status & FLASH_WRPRTERR )
255 return ERROR_FLASH_OPERATION_FAILED;
256 if( status & FLASH_PGERR )
257 return ERROR_FLASH_OPERATION_FAILED;
259 /* write protection byte 4 */
260 target_write_u16(target, STM32_OB_WRP3, stm32x_info->option_bytes.protection[3]);
262 status = stm32x_wait_status_busy(bank, 10);
264 if( status & FLASH_WRPRTERR )
265 return ERROR_FLASH_OPERATION_FAILED;
266 if( status & FLASH_PGERR )
267 return ERROR_FLASH_OPERATION_FAILED;
269 /* write readout protection bit */
270 target_write_u16(target, STM32_OB_RDP, stm32x_info->option_bytes.RDP);
272 status = stm32x_wait_status_busy(bank, 10);
274 if( status & FLASH_WRPRTERR )
275 return ERROR_FLASH_OPERATION_FAILED;
276 if( status & FLASH_PGERR )
277 return ERROR_FLASH_OPERATION_FAILED;
279 target_write_u32(target, STM32_FLASH_CR, FLASH_LOCK);
281 return ERROR_OK;
284 int stm32x_protect_check(struct flash_bank_s *bank)
286 target_t *target = bank->target;
287 stm32x_flash_bank_t *stm32x_info = bank->driver_priv;
289 u32 protection;
290 int i, s;
291 int num_bits;
292 int set;
294 if (target->state != TARGET_HALTED)
296 LOG_ERROR("Target not halted");
297 return ERROR_TARGET_NOT_HALTED;
300 /* medium density - each bit refers to a 4bank protection
301 * high density - each bit refers to a 2bank protection */
302 target_read_u32(target, STM32_FLASH_WRPR, &protection);
304 /* medium density - each protection bit is for 4 * 1K pages
305 * high density - each protection bit is for 2 * 2K pages */
306 num_bits = (bank->num_sectors / stm32x_info->ppage_size);
308 if (stm32x_info->ppage_size == 2)
310 /* high density flash */
312 set = 1;
314 if (protection & (1 << 31))
315 set = 0;
317 /* bit 31 controls sector 62 - 255 protection */
318 for (s = 62; s < bank->num_sectors; s++)
320 bank->sectors[s].is_protected = set;
323 if (bank->num_sectors > 61)
324 num_bits = 31;
326 for (i = 0; i < num_bits; i++)
328 set = 1;
330 if (protection & (1 << i))
331 set = 0;
333 for (s = 0; s < stm32x_info->ppage_size; s++)
334 bank->sectors[(i * stm32x_info->ppage_size) + s].is_protected = set;
337 else
339 /* medium density flash */
340 for (i = 0; i < num_bits; i++)
342 set = 1;
344 if( protection & (1 << i))
345 set = 0;
347 for (s = 0; s < stm32x_info->ppage_size; s++)
348 bank->sectors[(i * stm32x_info->ppage_size) + s].is_protected = set;
352 return ERROR_OK;
355 int stm32x_erase(struct flash_bank_s *bank, int first, int last)
357 target_t *target = bank->target;
358 int i;
359 u32 status;
361 if (bank->target->state != TARGET_HALTED)
363 LOG_ERROR("Target not halted");
364 return ERROR_TARGET_NOT_HALTED;
367 if ((first == 0) && (last == (bank->num_sectors - 1)))
369 return stm32x_mass_erase(bank);
372 /* unlock flash registers */
373 target_write_u32(target, STM32_FLASH_KEYR, KEY1);
374 target_write_u32(target, STM32_FLASH_KEYR, KEY2);
376 for (i = first; i <= last; i++)
378 target_write_u32(target, STM32_FLASH_CR, FLASH_PER);
379 target_write_u32(target, STM32_FLASH_AR, bank->base + bank->sectors[i].offset);
380 target_write_u32(target, STM32_FLASH_CR, FLASH_PER|FLASH_STRT);
382 status = stm32x_wait_status_busy(bank, 10);
384 if( status & FLASH_WRPRTERR )
385 return ERROR_FLASH_OPERATION_FAILED;
386 if( status & FLASH_PGERR )
387 return ERROR_FLASH_OPERATION_FAILED;
388 bank->sectors[i].is_erased = 1;
391 target_write_u32(target, STM32_FLASH_CR, FLASH_LOCK);
393 return ERROR_OK;
396 int stm32x_protect(struct flash_bank_s *bank, int set, int first, int last)
398 stm32x_flash_bank_t *stm32x_info = NULL;
399 target_t *target = bank->target;
400 u16 prot_reg[4] = {0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF};
401 int i, reg, bit;
402 int status;
403 u32 protection;
405 stm32x_info = bank->driver_priv;
407 if (target->state != TARGET_HALTED)
409 LOG_ERROR("Target not halted");
410 return ERROR_TARGET_NOT_HALTED;
413 if ((first && (first % stm32x_info->ppage_size)) || ((last + 1) && (last + 1) % stm32x_info->ppage_size))
415 LOG_WARNING("sector start/end incorrect - stm32 has %dK sector protection", stm32x_info->ppage_size);
416 return ERROR_FLASH_SECTOR_INVALID;
419 /* medium density - each bit refers to a 4bank protection
420 * high density - each bit refers to a 2bank protection */
421 target_read_u32(target, STM32_FLASH_WRPR, &protection);
423 prot_reg[0] = (u16)protection;
424 prot_reg[1] = (u16)(protection >> 8);
425 prot_reg[2] = (u16)(protection >> 16);
426 prot_reg[3] = (u16)(protection >> 24);
428 if (stm32x_info->ppage_size == 2)
430 /* high density flash */
432 /* bit 7 controls sector 62 - 255 protection */
433 if (last > 61)
435 if (set)
436 prot_reg[3] &= ~(1 << 7);
437 else
438 prot_reg[3] |= (1 << 7);
441 if (first > 61)
442 first = 62;
443 if (last > 61)
444 last = 61;
446 for (i = first; i <= last; i++)
448 reg = (i / stm32x_info->ppage_size) / 8;
449 bit = (i / stm32x_info->ppage_size) - (reg * 8);
451 if( set )
452 prot_reg[reg] &= ~(1 << bit);
453 else
454 prot_reg[reg] |= (1 << bit);
457 else
459 /* medium density flash */
460 for (i = first; i <= last; i++)
462 reg = (i / stm32x_info->ppage_size) / 8;
463 bit = (i / stm32x_info->ppage_size) - (reg * 8);
465 if( set )
466 prot_reg[reg] &= ~(1 << bit);
467 else
468 prot_reg[reg] |= (1 << bit);
472 if ((status = stm32x_erase_options(bank)) != ERROR_OK)
473 return status;
475 stm32x_info->option_bytes.protection[0] = prot_reg[0];
476 stm32x_info->option_bytes.protection[1] = prot_reg[1];
477 stm32x_info->option_bytes.protection[2] = prot_reg[2];
478 stm32x_info->option_bytes.protection[3] = prot_reg[3];
480 return stm32x_write_options(bank);
483 int stm32x_write_block(struct flash_bank_s *bank, u8 *buffer, u32 offset, u32 count)
485 stm32x_flash_bank_t *stm32x_info = bank->driver_priv;
486 target_t *target = bank->target;
487 u32 buffer_size = 8192;
488 working_area_t *source;
489 u32 address = bank->base + offset;
490 reg_param_t reg_params[4];
491 armv7m_algorithm_t armv7m_info;
492 int retval = ERROR_OK;
494 u8 stm32x_flash_write_code[] = {
495 /* write: */
496 0xDF, 0xF8, 0x24, 0x40, /* ldr r4, STM32_FLASH_CR */
497 0x09, 0x4D, /* ldr r5, STM32_FLASH_SR */
498 0x4F, 0xF0, 0x01, 0x03, /* mov r3, #1 */
499 0x23, 0x60, /* str r3, [r4, #0] */
500 0x30, 0xF8, 0x02, 0x3B, /* ldrh r3, [r0], #2 */
501 0x21, 0xF8, 0x02, 0x3B, /* strh r3, [r1], #2 */
502 /* busy: */
503 0x2B, 0x68, /* ldr r3, [r5, #0] */
504 0x13, 0xF0, 0x01, 0x0F, /* tst r3, #0x01 */
505 0xFB, 0xD0, /* beq busy */
506 0x13, 0xF0, 0x14, 0x0F, /* tst r3, #0x14 */
507 0x01, 0xD1, /* bne exit */
508 0x01, 0x3A, /* subs r2, r2, #1 */
509 0xED, 0xD1, /* bne write */
510 /* exit: */
511 0xFE, 0xE7, /* b exit */
512 0x10, 0x20, 0x02, 0x40, /* STM32_FLASH_CR: .word 0x40022010 */
513 0x0C, 0x20, 0x02, 0x40 /* STM32_FLASH_SR: .word 0x4002200C */
516 /* flash write code */
517 if (target_alloc_working_area(target, sizeof(stm32x_flash_write_code), &stm32x_info->write_algorithm) != ERROR_OK)
519 LOG_WARNING("no working area available, can't do block memory writes");
520 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
523 if ((retval=target_write_buffer(target, stm32x_info->write_algorithm->address, sizeof(stm32x_flash_write_code), stm32x_flash_write_code))!=ERROR_OK)
524 return retval;
526 /* memory buffer */
527 while (target_alloc_working_area(target, buffer_size, &source) != ERROR_OK)
529 buffer_size /= 2;
530 if (buffer_size <= 256)
532 /* if we already allocated the writing code, but failed to get a buffer, free the algorithm */
533 if (stm32x_info->write_algorithm)
534 target_free_working_area(target, stm32x_info->write_algorithm);
536 LOG_WARNING("no large enough working area available, can't do block memory writes");
537 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
541 armv7m_info.common_magic = ARMV7M_COMMON_MAGIC;
542 armv7m_info.core_mode = ARMV7M_MODE_ANY;
544 init_reg_param(&reg_params[0], "r0", 32, PARAM_OUT);
545 init_reg_param(&reg_params[1], "r1", 32, PARAM_OUT);
546 init_reg_param(&reg_params[2], "r2", 32, PARAM_OUT);
547 init_reg_param(&reg_params[3], "r3", 32, PARAM_IN);
549 while (count > 0)
551 u32 thisrun_count = (count > (buffer_size / 2)) ? (buffer_size / 2) : count;
553 if ((retval = target_write_buffer(target, source->address, thisrun_count * 2, buffer))!=ERROR_OK)
554 break;
556 buf_set_u32(reg_params[0].value, 0, 32, source->address);
557 buf_set_u32(reg_params[1].value, 0, 32, address);
558 buf_set_u32(reg_params[2].value, 0, 32, thisrun_count);
560 if ((retval = target->type->run_algorithm(target, 0, NULL, 4, reg_params, stm32x_info->write_algorithm->address, \
561 stm32x_info->write_algorithm->address + (sizeof(stm32x_flash_write_code) - 10), 10000, &armv7m_info)) != ERROR_OK)
563 LOG_ERROR("error executing stm32x flash write algorithm");
564 retval = ERROR_FLASH_OPERATION_FAILED;
565 break;
568 if (buf_get_u32(reg_params[3].value, 0, 32) & 0x14)
570 retval = ERROR_FLASH_OPERATION_FAILED;
571 break;
574 buffer += thisrun_count * 2;
575 address += thisrun_count * 2;
576 count -= thisrun_count;
579 target_free_working_area(target, source);
580 target_free_working_area(target, stm32x_info->write_algorithm);
582 destroy_reg_param(&reg_params[0]);
583 destroy_reg_param(&reg_params[1]);
584 destroy_reg_param(&reg_params[2]);
585 destroy_reg_param(&reg_params[3]);
587 return retval;
590 int stm32x_write(struct flash_bank_s *bank, u8 *buffer, u32 offset, u32 count)
592 target_t *target = bank->target;
593 u32 words_remaining = (count / 2);
594 u32 bytes_remaining = (count & 0x00000001);
595 u32 address = bank->base + offset;
596 u32 bytes_written = 0;
597 u8 status;
598 u32 retval;
600 if (bank->target->state != TARGET_HALTED)
602 LOG_ERROR("Target not halted");
603 return ERROR_TARGET_NOT_HALTED;
606 if (offset & 0x1)
608 LOG_WARNING("offset 0x%x breaks required 2-byte alignment", offset);
609 return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
612 /* unlock flash registers */
613 target_write_u32(target, STM32_FLASH_KEYR, KEY1);
614 target_write_u32(target, STM32_FLASH_KEYR, KEY2);
616 /* multiple half words (2-byte) to be programmed? */
617 if (words_remaining > 0)
619 /* try using a block write */
620 if ((retval = stm32x_write_block(bank, buffer, offset, words_remaining)) != ERROR_OK)
622 if (retval == ERROR_TARGET_RESOURCE_NOT_AVAILABLE)
624 /* if block write failed (no sufficient working area),
625 * we use normal (slow) single dword accesses */
626 LOG_WARNING("couldn't use block writes, falling back to single memory accesses");
628 else if (retval == ERROR_FLASH_OPERATION_FAILED)
630 LOG_ERROR("flash writing failed with error code: 0x%x", retval);
631 return ERROR_FLASH_OPERATION_FAILED;
634 else
636 buffer += words_remaining * 2;
637 address += words_remaining * 2;
638 words_remaining = 0;
642 while (words_remaining > 0)
644 target_write_u32(target, STM32_FLASH_CR, FLASH_PG);
645 target_write_u16(target, address, *(u16*)(buffer + bytes_written));
647 status = stm32x_wait_status_busy(bank, 5);
649 if( status & FLASH_WRPRTERR )
650 return ERROR_FLASH_OPERATION_FAILED;
651 if( status & FLASH_PGERR )
652 return ERROR_FLASH_OPERATION_FAILED;
654 bytes_written += 2;
655 words_remaining--;
656 address += 2;
659 if (bytes_remaining)
661 u8 last_halfword[2] = {0xff, 0xff};
662 int i = 0;
664 while(bytes_remaining > 0)
666 last_halfword[i++] = *(buffer + bytes_written);
667 bytes_remaining--;
668 bytes_written++;
671 target_write_u32(target, STM32_FLASH_CR, FLASH_PG);
672 target_write_u16(target, address, *(u16*)last_halfword);
674 status = stm32x_wait_status_busy(bank, 5);
676 if( status & FLASH_WRPRTERR )
677 return ERROR_FLASH_OPERATION_FAILED;
678 if( status & FLASH_PGERR )
679 return ERROR_FLASH_OPERATION_FAILED;
682 target_write_u32(target, STM32_FLASH_CR, FLASH_LOCK);
684 return ERROR_OK;
687 int stm32x_probe(struct flash_bank_s *bank)
689 target_t *target = bank->target;
690 stm32x_flash_bank_t *stm32x_info = bank->driver_priv;
691 int i;
692 u16 num_pages;
693 u32 device_id;
694 int page_size;
696 if (bank->target->state != TARGET_HALTED)
698 LOG_ERROR("Target not halted");
699 return ERROR_TARGET_NOT_HALTED;
702 stm32x_info->probed = 0;
704 /* read stm32 device id register */
705 target_read_u32(target, 0xE0042000, &device_id);
706 LOG_INFO( "device id = 0x%08x", device_id );
708 /* get flash size from target */
709 if (target_read_u16(target, 0x1FFFF7E0, &num_pages) != ERROR_OK)
711 /* failed reading flash size, default to max target family */
712 num_pages = 0xffff;
715 if ((device_id & 0x7ff) == 0x410)
717 /* medium density - we have 1k pages
718 * 4 pages for a protection area */
719 page_size = 1024;
720 stm32x_info->ppage_size = 4;
722 /* check for early silicon */
723 if (num_pages == 0xffff)
725 /* number of sectors incorrect on revA */
726 LOG_WARNING( "STM32 flash size failed, probe inaccurate - assuming 128k flash" );
727 num_pages = 128;
730 else if ((device_id & 0x7ff) == 0x414)
732 /* high density - we have 2k pages
733 * 2 pages for a protection area */
734 page_size = 2048;
735 stm32x_info->ppage_size = 2;
737 /* check for early silicon */
738 if (num_pages == 0xffff)
740 /* number of sectors incorrect on revZ */
741 LOG_WARNING( "STM32 flash size failed, probe inaccurate - assuming 512k flash" );
742 num_pages = 512;
745 else
747 LOG_WARNING( "Cannot identify target as a STM32 family." );
748 return ERROR_FLASH_OPERATION_FAILED;
751 LOG_INFO( "flash size = %dkbytes", num_pages );
753 /* calculate numbers of pages */
754 num_pages /= (page_size / 1024);
756 bank->base = 0x08000000;
757 bank->size = (num_pages * page_size);
758 bank->num_sectors = num_pages;
759 bank->sectors = malloc(sizeof(flash_sector_t) * num_pages);
761 for (i = 0; i < num_pages; i++)
763 bank->sectors[i].offset = i * page_size;
764 bank->sectors[i].size = page_size;
765 bank->sectors[i].is_erased = -1;
766 bank->sectors[i].is_protected = 1;
769 stm32x_info->probed = 1;
771 return ERROR_OK;
774 int stm32x_auto_probe(struct flash_bank_s *bank)
776 stm32x_flash_bank_t *stm32x_info = bank->driver_priv;
777 if (stm32x_info->probed)
778 return ERROR_OK;
779 return stm32x_probe(bank);
782 int stm32x_handle_part_id_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
784 return ERROR_OK;
787 int stm32x_info(struct flash_bank_s *bank, char *buf, int buf_size)
789 target_t *target = bank->target;
790 u32 device_id;
791 int printed;
793 /* read stm32 device id register */
794 target_read_u32(target, 0xE0042000, &device_id);
796 if ((device_id & 0x7ff) == 0x410)
798 printed = snprintf(buf, buf_size, "stm32x (Medium Density) - Rev: ");
799 buf += printed;
800 buf_size -= printed;
802 switch(device_id >> 16)
804 case 0x0000:
805 snprintf(buf, buf_size, "A");
806 break;
808 case 0x2000:
809 snprintf(buf, buf_size, "B");
810 break;
812 case 0x2001:
813 snprintf(buf, buf_size, "Z");
814 break;
816 case 0x2003:
817 snprintf(buf, buf_size, "Y");
818 break;
820 default:
821 snprintf(buf, buf_size, "unknown");
822 break;
825 else if ((device_id & 0x7ff) == 0x414)
827 printed = snprintf(buf, buf_size, "stm32x (High Density) - Rev: ");
828 buf += printed;
829 buf_size -= printed;
831 switch(device_id >> 16)
833 case 0x1000:
834 snprintf(buf, buf_size, "A");
835 break;
837 case 0x1001:
838 snprintf(buf, buf_size, "Z");
839 break;
841 default:
842 snprintf(buf, buf_size, "unknown");
843 break;
846 else
848 snprintf(buf, buf_size, "Cannot identify target as a stm32x\n");
849 return ERROR_FLASH_OPERATION_FAILED;
852 return ERROR_OK;
855 int stm32x_handle_lock_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
857 flash_bank_t *bank;
858 target_t *target = NULL;
859 stm32x_flash_bank_t *stm32x_info = NULL;
861 if (argc < 1)
863 command_print(cmd_ctx, "stm32x lock <bank>");
864 return ERROR_OK;
867 bank = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
868 if (!bank)
870 command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
871 return ERROR_OK;
874 stm32x_info = bank->driver_priv;
876 target = bank->target;
878 if (target->state != TARGET_HALTED)
880 LOG_ERROR("Target not halted");
881 return ERROR_TARGET_NOT_HALTED;
884 if (stm32x_erase_options(bank) != ERROR_OK)
886 command_print(cmd_ctx, "stm32x failed to erase options");
887 return ERROR_OK;
890 /* set readout protection */
891 stm32x_info->option_bytes.RDP = 0;
893 if (stm32x_write_options(bank) != ERROR_OK)
895 command_print(cmd_ctx, "stm32x failed to lock device");
896 return ERROR_OK;
899 command_print(cmd_ctx, "stm32x locked");
901 return ERROR_OK;
904 int stm32x_handle_unlock_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
906 flash_bank_t *bank;
907 target_t *target = NULL;
908 stm32x_flash_bank_t *stm32x_info = NULL;
910 if (argc < 1)
912 command_print(cmd_ctx, "stm32x unlock <bank>");
913 return ERROR_OK;
916 bank = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
917 if (!bank)
919 command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
920 return ERROR_OK;
923 stm32x_info = bank->driver_priv;
925 target = bank->target;
927 if (target->state != TARGET_HALTED)
929 LOG_ERROR("Target not halted");
930 return ERROR_TARGET_NOT_HALTED;
933 if (stm32x_erase_options(bank) != ERROR_OK)
935 command_print(cmd_ctx, "stm32x failed to unlock device");
936 return ERROR_OK;
939 if (stm32x_write_options(bank) != ERROR_OK)
941 command_print(cmd_ctx, "stm32x failed to lock device");
942 return ERROR_OK;
945 command_print(cmd_ctx, "stm32x unlocked");
947 return ERROR_OK;
950 int stm32x_handle_options_read_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
952 flash_bank_t *bank;
953 u32 optionbyte;
954 target_t *target = NULL;
955 stm32x_flash_bank_t *stm32x_info = NULL;
957 if (argc < 1)
959 command_print(cmd_ctx, "stm32x options_read <bank>");
960 return ERROR_OK;
963 bank = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
964 if (!bank)
966 command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
967 return ERROR_OK;
970 stm32x_info = bank->driver_priv;
972 target = bank->target;
974 if (target->state != TARGET_HALTED)
976 LOG_ERROR("Target not halted");
977 return ERROR_TARGET_NOT_HALTED;
980 target_read_u32(target, STM32_FLASH_OBR, &optionbyte);
981 command_print(cmd_ctx, "Option Byte: 0x%x", optionbyte);
983 if (buf_get_u32((u8*)&optionbyte, OPT_ERROR, 1))
984 command_print(cmd_ctx, "Option Byte Complement Error");
986 if (buf_get_u32((u8*)&optionbyte, OPT_READOUT, 1))
987 command_print(cmd_ctx, "Readout Protection On");
988 else
989 command_print(cmd_ctx, "Readout Protection Off");
991 if (buf_get_u32((u8*)&optionbyte, OPT_RDWDGSW, 1))
992 command_print(cmd_ctx, "Software Watchdog");
993 else
994 command_print(cmd_ctx, "Hardware Watchdog");
996 if (buf_get_u32((u8*)&optionbyte, OPT_RDRSTSTOP, 1))
997 command_print(cmd_ctx, "Stop: No reset generated");
998 else
999 command_print(cmd_ctx, "Stop: Reset generated");
1001 if (buf_get_u32((u8*)&optionbyte, OPT_RDRSTSTDBY, 1))
1002 command_print(cmd_ctx, "Standby: No reset generated");
1003 else
1004 command_print(cmd_ctx, "Standby: Reset generated");
1006 return ERROR_OK;
1009 int stm32x_handle_options_write_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1011 flash_bank_t *bank;
1012 target_t *target = NULL;
1013 stm32x_flash_bank_t *stm32x_info = NULL;
1014 u16 optionbyte = 0xF8;
1016 if (argc < 4)
1018 command_print(cmd_ctx, "stm32x options_write <bank> <SWWDG|HWWDG> <RSTSTNDBY|NORSTSTNDBY> <RSTSTOP|NORSTSTOP>");
1019 return ERROR_OK;
1022 bank = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
1023 if (!bank)
1025 command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
1026 return ERROR_OK;
1029 stm32x_info = bank->driver_priv;
1031 target = bank->target;
1033 if (target->state != TARGET_HALTED)
1035 LOG_ERROR("Target not halted");
1036 return ERROR_TARGET_NOT_HALTED;
1039 if (strcmp(args[1], "SWWDG") == 0)
1041 optionbyte |= (1<<0);
1043 else
1045 optionbyte &= ~(1<<0);
1048 if (strcmp(args[2], "NORSTSTNDBY") == 0)
1050 optionbyte |= (1<<1);
1052 else
1054 optionbyte &= ~(1<<1);
1057 if (strcmp(args[3], "NORSTSTOP") == 0)
1059 optionbyte |= (1<<2);
1061 else
1063 optionbyte &= ~(1<<2);
1066 if (stm32x_erase_options(bank) != ERROR_OK)
1068 command_print(cmd_ctx, "stm32x failed to erase options");
1069 return ERROR_OK;
1072 stm32x_info->option_bytes.user_options = optionbyte;
1074 if (stm32x_write_options(bank) != ERROR_OK)
1076 command_print(cmd_ctx, "stm32x failed to write options");
1077 return ERROR_OK;
1080 command_print(cmd_ctx, "stm32x write options complete");
1082 return ERROR_OK;
1085 int stm32x_mass_erase(struct flash_bank_s *bank)
1087 target_t *target = bank->target;
1088 u32 status;
1090 if (target->state != TARGET_HALTED)
1092 LOG_ERROR("Target not halted");
1093 return ERROR_TARGET_NOT_HALTED;
1096 /* unlock option flash registers */
1097 target_write_u32(target, STM32_FLASH_KEYR, KEY1);
1098 target_write_u32(target, STM32_FLASH_KEYR, KEY2);
1100 /* mass erase flash memory */
1101 target_write_u32(target, STM32_FLASH_CR, FLASH_MER);
1102 target_write_u32(target, STM32_FLASH_CR, FLASH_MER|FLASH_STRT);
1104 status = stm32x_wait_status_busy(bank, 10);
1106 target_write_u32(target, STM32_FLASH_CR, FLASH_LOCK);
1108 if( status & FLASH_WRPRTERR )
1110 LOG_ERROR("stm32x device protected");
1111 return ERROR_OK;
1114 if( status & FLASH_PGERR )
1116 LOG_ERROR("stm32x device programming failed");
1117 return ERROR_OK;
1120 return ERROR_OK;
1123 int stm32x_handle_mass_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1125 flash_bank_t *bank;
1126 int i;
1128 if (argc < 1)
1130 command_print(cmd_ctx, "stm32x mass_erase <bank>");
1131 return ERROR_OK;
1134 bank = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
1135 if (!bank)
1137 command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
1138 return ERROR_OK;
1141 if (stm32x_mass_erase(bank) == ERROR_OK)
1143 /* set all sectors as erased */
1144 for (i = 0; i < bank->num_sectors; i++)
1146 bank->sectors[i].is_erased = 1;
1149 command_print(cmd_ctx, "stm32x mass erase complete");
1151 else
1153 command_print(cmd_ctx, "stm32x mass erase failed");
1156 return ERROR_OK;