ae5701a22ca6bcd2a26b8a59d16911c1460c03dd
[openocd.git] / src / flash / stm32x.c
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) any later version. *
9 * *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
14 * *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
20 #ifdef HAVE_CONFIG_H
21 #include "config.h"
22 #endif
23
24 #include "replacements.h"
25
26 #include "stm32x.h"
27 #include "flash.h"
28 #include "target.h"
29 #include "log.h"
30 #include "armv7m.h"
31 #include "algorithm.h"
32 #include "binarybuffer.h"
33
34 #include <stdlib.h>
35 #include <string.h>
36
37 int stm32x_register_commands(struct command_context_s *cmd_ctx);
38 int stm32x_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank);
39 int stm32x_erase(struct flash_bank_s *bank, int first, int last);
40 int stm32x_protect(struct flash_bank_s *bank, int set, int first, int last);
41 int stm32x_write(struct flash_bank_s *bank, u8 *buffer, u32 offset, u32 count);
42 int stm32x_probe(struct flash_bank_s *bank);
43 int stm32x_auto_probe(struct flash_bank_s *bank);
44 int stm32x_handle_part_id_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
45 int stm32x_protect_check(struct flash_bank_s *bank);
46 int stm32x_info(struct flash_bank_s *bank, char *buf, int buf_size);
47
48 int stm32x_handle_lock_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
49 int stm32x_handle_unlock_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
50 int stm32x_handle_options_read_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
51 int stm32x_handle_options_write_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
52 int stm32x_handle_mass_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
53 int stm32x_mass_erase(struct flash_bank_s *bank);
54
55 flash_driver_t stm32x_flash =
56 {
57 .name = "stm32x",
58 .register_commands = stm32x_register_commands,
59 .flash_bank_command = stm32x_flash_bank_command,
60 .erase = stm32x_erase,
61 .protect = stm32x_protect,
62 .write = stm32x_write,
63 .probe = stm32x_probe,
64 .auto_probe = stm32x_auto_probe,
65 .erase_check = default_flash_mem_blank_check,
66 .protect_check = stm32x_protect_check,
67 .info = stm32x_info
68 };
69
70 int stm32x_register_commands(struct command_context_s *cmd_ctx)
71 {
72 command_t *stm32x_cmd = register_command(cmd_ctx, NULL, "stm32x", NULL, COMMAND_ANY, "stm32x flash specific commands");
73
74 register_command(cmd_ctx, stm32x_cmd, "lock", stm32x_handle_lock_command, COMMAND_EXEC,
75 "lock device");
76 register_command(cmd_ctx, stm32x_cmd, "unlock", stm32x_handle_unlock_command, COMMAND_EXEC,
77 "unlock protected device");
78 register_command(cmd_ctx, stm32x_cmd, "mass_erase", stm32x_handle_mass_erase_command, COMMAND_EXEC,
79 "mass erase device");
80 register_command(cmd_ctx, stm32x_cmd, "options_read", stm32x_handle_options_read_command, COMMAND_EXEC,
81 "read device option bytes");
82 register_command(cmd_ctx, stm32x_cmd, "options_write", stm32x_handle_options_write_command, COMMAND_EXEC,
83 "write device option bytes");
84 return ERROR_OK;
85 }
86
87 /* flash bank stm32x <base> <size> 0 0 <target#>
88 */
89 int stm32x_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank)
90 {
91 stm32x_flash_bank_t *stm32x_info;
92
93 if (argc < 6)
94 {
95 LOG_WARNING("incomplete flash_bank stm32x configuration");
96 return ERROR_FLASH_BANK_INVALID;
97 }
98
99 stm32x_info = malloc(sizeof(stm32x_flash_bank_t));
100 bank->driver_priv = stm32x_info;
101
102 stm32x_info->write_algorithm = NULL;
103 stm32x_info->probed = 0;
104
105 return ERROR_OK;
106 }
107
108 u32 stm32x_get_flash_status(flash_bank_t *bank)
109 {
110 target_t *target = bank->target;
111 u32 status;
112
113 target_read_u32(target, STM32_FLASH_SR, &status);
114
115 return status;
116 }
117
118 u32 stm32x_wait_status_busy(flash_bank_t *bank, int timeout)
119 {
120 u32 status;
121
122 /* wait for busy to clear */
123 while (((status = stm32x_get_flash_status(bank)) & FLASH_BSY) && (timeout-- > 0))
124 {
125 LOG_DEBUG("status: 0x%x", status);
126 usleep(1000);
127 }
128
129 return status;
130 }
131
132 int stm32x_read_options(struct flash_bank_s *bank)
133 {
134 u32 optiondata;
135 stm32x_flash_bank_t *stm32x_info = NULL;
136 target_t *target = bank->target;
137
138 stm32x_info = bank->driver_priv;
139
140 /* read current option bytes */
141 target_read_u32(target, STM32_FLASH_OBR, &optiondata);
142
143 stm32x_info->option_bytes.user_options = (u16)0xFFF8|((optiondata >> 2) & 0x07);
144 stm32x_info->option_bytes.RDP = (optiondata & (1 << OPT_READOUT)) ? 0xFFFF : 0x5AA5;
145
146 if (optiondata & (1 << OPT_READOUT))
147 LOG_INFO("Device Security Bit Set");
148
149 /* each bit refers to a 4bank protection */
150 target_read_u32(target, STM32_FLASH_WRPR, &optiondata);
151
152 stm32x_info->option_bytes.protection[0] = (u16)optiondata;
153 stm32x_info->option_bytes.protection[1] = (u16)(optiondata >> 8);
154 stm32x_info->option_bytes.protection[2] = (u16)(optiondata >> 16);
155 stm32x_info->option_bytes.protection[3] = (u16)(optiondata >> 24);
156
157 return ERROR_OK;
158 }
159
160 int stm32x_erase_options(struct flash_bank_s *bank)
161 {
162 stm32x_flash_bank_t *stm32x_info = NULL;
163 target_t *target = bank->target;
164 u32 status;
165
166 stm32x_info = bank->driver_priv;
167
168 /* read current options */
169 stm32x_read_options(bank);
170
171 /* unlock flash registers */
172 target_write_u32(target, STM32_FLASH_KEYR, KEY1);
173 target_write_u32(target, STM32_FLASH_KEYR, KEY2);
174
175 /* unlock option flash registers */
176 target_write_u32(target, STM32_FLASH_OPTKEYR, KEY1);
177 target_write_u32(target, STM32_FLASH_OPTKEYR, KEY2);
178
179 /* erase option bytes */
180 target_write_u32(target, STM32_FLASH_CR, FLASH_OPTER|FLASH_OPTWRE);
181 target_write_u32(target, STM32_FLASH_CR, FLASH_OPTER|FLASH_STRT|FLASH_OPTWRE);
182
183 status = stm32x_wait_status_busy(bank, 10);
184
185 if( status & FLASH_WRPRTERR )
186 return ERROR_FLASH_OPERATION_FAILED;
187 if( status & FLASH_PGERR )
188 return ERROR_FLASH_OPERATION_FAILED;
189
190 /* clear readout protection and complementary option bytes
191 * this will also force a device unlock if set */
192 stm32x_info->option_bytes.RDP = 0x5AA5;
193
194 return ERROR_OK;
195 }
196
197 int stm32x_write_options(struct flash_bank_s *bank)
198 {
199 stm32x_flash_bank_t *stm32x_info = NULL;
200 target_t *target = bank->target;
201 u32 status;
202
203 stm32x_info = bank->driver_priv;
204
205 /* unlock flash registers */
206 target_write_u32(target, STM32_FLASH_KEYR, KEY1);
207 target_write_u32(target, STM32_FLASH_KEYR, KEY2);
208
209 /* unlock option flash registers */
210 target_write_u32(target, STM32_FLASH_OPTKEYR, KEY1);
211 target_write_u32(target, STM32_FLASH_OPTKEYR, KEY2);
212
213 /* program option bytes */
214 target_write_u32(target, STM32_FLASH_CR, FLASH_OPTPG|FLASH_OPTWRE);
215
216 /* write user option byte */
217 target_write_u16(target, STM32_OB_USER, stm32x_info->option_bytes.user_options);
218
219 status = stm32x_wait_status_busy(bank, 10);
220
221 if( status & FLASH_WRPRTERR )
222 return ERROR_FLASH_OPERATION_FAILED;
223 if( status & FLASH_PGERR )
224 return ERROR_FLASH_OPERATION_FAILED;
225
226 /* write protection byte 1 */
227 target_write_u16(target, STM32_OB_WRP0, stm32x_info->option_bytes.protection[0]);
228
229 status = stm32x_wait_status_busy(bank, 10);
230
231 if( status & FLASH_WRPRTERR )
232 return ERROR_FLASH_OPERATION_FAILED;
233 if( status & FLASH_PGERR )
234 return ERROR_FLASH_OPERATION_FAILED;
235
236 /* write protection byte 2 */
237 target_write_u16(target, STM32_OB_WRP1, stm32x_info->option_bytes.protection[1]);
238
239 status = stm32x_wait_status_busy(bank, 10);
240
241 if( status & FLASH_WRPRTERR )
242 return ERROR_FLASH_OPERATION_FAILED;
243 if( status & FLASH_PGERR )
244 return ERROR_FLASH_OPERATION_FAILED;
245
246 /* write protection byte 3 */
247 target_write_u16(target, STM32_OB_WRP2, stm32x_info->option_bytes.protection[2]);
248
249 status = stm32x_wait_status_busy(bank, 10);
250
251 if( status & FLASH_WRPRTERR )
252 return ERROR_FLASH_OPERATION_FAILED;
253 if( status & FLASH_PGERR )
254 return ERROR_FLASH_OPERATION_FAILED;
255
256 /* write protection byte 4 */
257 target_write_u16(target, STM32_OB_WRP3, stm32x_info->option_bytes.protection[3]);
258
259 status = stm32x_wait_status_busy(bank, 10);
260
261 if( status & FLASH_WRPRTERR )
262 return ERROR_FLASH_OPERATION_FAILED;
263 if( status & FLASH_PGERR )
264 return ERROR_FLASH_OPERATION_FAILED;
265
266 /* write readout protection bit */
267 target_write_u16(target, STM32_OB_RDP, stm32x_info->option_bytes.RDP);
268
269 status = stm32x_wait_status_busy(bank, 10);
270
271 if( status & FLASH_WRPRTERR )
272 return ERROR_FLASH_OPERATION_FAILED;
273 if( status & FLASH_PGERR )
274 return ERROR_FLASH_OPERATION_FAILED;
275
276 target_write_u32(target, STM32_FLASH_CR, FLASH_LOCK);
277
278 return ERROR_OK;
279 }
280
281 int stm32x_protect_check(struct flash_bank_s *bank)
282 {
283 target_t *target = bank->target;
284 stm32x_flash_bank_t *stm32x_info = bank->driver_priv;
285
286 u32 protection;
287 int i, s;
288 int num_bits;
289
290 if (target->state != TARGET_HALTED)
291 {
292 return ERROR_TARGET_NOT_HALTED;
293 }
294
295 /* medium density - each bit refers to a 4bank protection
296 * high density - each bit refers to a 2bank protection */
297 target_read_u32(target, STM32_FLASH_WRPR, &protection);
298
299 /* medium density - each protection bit is for 4 * 1K pages
300 * high density - each protection bit is for 2 * 2K pages */
301 num_bits = (bank->num_sectors / stm32x_info->ppage_size);
302
303 for (i = 0; i < num_bits; i++)
304 {
305 int set = 1;
306
307 if( protection & (1 << i))
308 set = 0;
309
310 for (s = 0; s < stm32x_info->ppage_size; s++)
311 bank->sectors[(i * stm32x_info->ppage_size) + s].is_protected = set;
312 }
313
314 return ERROR_OK;
315 }
316
317 int stm32x_erase(struct flash_bank_s *bank, int first, int last)
318 {
319 target_t *target = bank->target;
320 int i;
321 u32 status;
322
323 if (bank->target->state != TARGET_HALTED)
324 {
325 return ERROR_TARGET_NOT_HALTED;
326 }
327
328 if ((first == 0) && (last == (bank->num_sectors - 1)))
329 {
330 return stm32x_mass_erase(bank);
331 }
332
333 /* unlock flash registers */
334 target_write_u32(target, STM32_FLASH_KEYR, KEY1);
335 target_write_u32(target, STM32_FLASH_KEYR, KEY2);
336
337 for (i = first; i <= last; i++)
338 {
339 target_write_u32(target, STM32_FLASH_CR, FLASH_PER);
340 target_write_u32(target, STM32_FLASH_AR, bank->base + bank->sectors[i].offset);
341 target_write_u32(target, STM32_FLASH_CR, FLASH_PER|FLASH_STRT);
342
343 status = stm32x_wait_status_busy(bank, 10);
344
345 if( status & FLASH_WRPRTERR )
346 return ERROR_FLASH_OPERATION_FAILED;
347 if( status & FLASH_PGERR )
348 return ERROR_FLASH_OPERATION_FAILED;
349 bank->sectors[i].is_erased = 1;
350 }
351
352 target_write_u32(target, STM32_FLASH_CR, FLASH_LOCK);
353
354 return ERROR_OK;
355 }
356
357 int stm32x_protect(struct flash_bank_s *bank, int set, int first, int last)
358 {
359 stm32x_flash_bank_t *stm32x_info = NULL;
360 target_t *target = bank->target;
361 u16 prot_reg[4] = {0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF};
362 int i, reg, bit;
363 int status;
364 u32 protection;
365
366 stm32x_info = bank->driver_priv;
367
368 if (target->state != TARGET_HALTED)
369 {
370 return ERROR_TARGET_NOT_HALTED;
371 }
372
373 if ((first && (first % stm32x_info->ppage_size)) || ((last + 1) && (last + 1) % stm32x_info->ppage_size))
374 {
375 LOG_WARNING("sector start/end incorrect - stm32 has %dK sector protection", stm32x_info->ppage_size);
376 return ERROR_FLASH_SECTOR_INVALID;
377 }
378
379 /* medium density - each bit refers to a 4bank protection
380 * high density - each bit refers to a 2bank protection */
381 target_read_u32(target, STM32_FLASH_WRPR, &protection);
382
383 prot_reg[0] = (u16)protection;
384 prot_reg[1] = (u16)(protection >> 8);
385 prot_reg[2] = (u16)(protection >> 16);
386 prot_reg[3] = (u16)(protection >> 24);
387
388 for (i = first; i <= last; i++)
389 {
390 reg = (i / stm32x_info->ppage_size) / 8;
391 bit = (i / stm32x_info->ppage_size) - (reg * 8);
392
393 if( set )
394 prot_reg[reg] &= ~(1 << bit);
395 else
396 prot_reg[reg] |= (1 << bit);
397 }
398
399 if ((status = stm32x_erase_options(bank)) != ERROR_OK)
400 return status;
401
402 stm32x_info->option_bytes.protection[0] = prot_reg[0];
403 stm32x_info->option_bytes.protection[1] = prot_reg[1];
404 stm32x_info->option_bytes.protection[2] = prot_reg[2];
405 stm32x_info->option_bytes.protection[3] = prot_reg[3];
406
407 return stm32x_write_options(bank);
408 }
409
410 int stm32x_write_block(struct flash_bank_s *bank, u8 *buffer, u32 offset, u32 count)
411 {
412 stm32x_flash_bank_t *stm32x_info = bank->driver_priv;
413 target_t *target = bank->target;
414 u32 buffer_size = 8192;
415 working_area_t *source;
416 u32 address = bank->base + offset;
417 reg_param_t reg_params[4];
418 armv7m_algorithm_t armv7m_info;
419 int retval = ERROR_OK;
420
421 u8 stm32x_flash_write_code[] = {
422 /* write: */
423 0xDF, 0xF8, 0x24, 0x40, /* ldr r4, STM32_FLASH_CR */
424 0x09, 0x4D, /* ldr r5, STM32_FLASH_SR */
425 0x4F, 0xF0, 0x01, 0x03, /* mov r3, #1 */
426 0x23, 0x60, /* str r3, [r4, #0] */
427 0x30, 0xF8, 0x02, 0x3B, /* ldrh r3, [r0], #2 */
428 0x21, 0xF8, 0x02, 0x3B, /* strh r3, [r1], #2 */
429 /* busy: */
430 0x2B, 0x68, /* ldr r3, [r5, #0] */
431 0x13, 0xF0, 0x01, 0x0F, /* tst r3, #0x01 */
432 0xFB, 0xD0, /* beq busy */
433 0x13, 0xF0, 0x14, 0x0F, /* tst r3, #0x14 */
434 0x01, 0xD1, /* bne exit */
435 0x01, 0x3A, /* subs r2, r2, #1 */
436 0xED, 0xD1, /* bne write */
437 /* exit: */
438 0xFE, 0xE7, /* b exit */
439 0x10, 0x20, 0x02, 0x40, /* STM32_FLASH_CR: .word 0x40022010 */
440 0x0C, 0x20, 0x02, 0x40 /* STM32_FLASH_SR: .word 0x4002200C */
441 };
442
443 /* flash write code */
444 if (target_alloc_working_area(target, sizeof(stm32x_flash_write_code), &stm32x_info->write_algorithm) != ERROR_OK)
445 {
446 LOG_WARNING("no working area available, can't do block memory writes");
447 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
448 };
449
450 if ((retval=target_write_buffer(target, stm32x_info->write_algorithm->address, sizeof(stm32x_flash_write_code), stm32x_flash_write_code))!=ERROR_OK)
451 return retval;
452
453 /* memory buffer */
454 while (target_alloc_working_area(target, buffer_size, &source) != ERROR_OK)
455 {
456 buffer_size /= 2;
457 if (buffer_size <= 256)
458 {
459 /* if we already allocated the writing code, but failed to get a buffer, free the algorithm */
460 if (stm32x_info->write_algorithm)
461 target_free_working_area(target, stm32x_info->write_algorithm);
462
463 LOG_WARNING("no large enough working area available, can't do block memory writes");
464 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
465 }
466 };
467
468 armv7m_info.common_magic = ARMV7M_COMMON_MAGIC;
469 armv7m_info.core_mode = ARMV7M_MODE_ANY;
470
471 init_reg_param(&reg_params[0], "r0", 32, PARAM_OUT);
472 init_reg_param(&reg_params[1], "r1", 32, PARAM_OUT);
473 init_reg_param(&reg_params[2], "r2", 32, PARAM_OUT);
474 init_reg_param(&reg_params[3], "r3", 32, PARAM_IN);
475
476 while (count > 0)
477 {
478 u32 thisrun_count = (count > (buffer_size / 2)) ? (buffer_size / 2) : count;
479
480 if ((retval = target_write_buffer(target, source->address, thisrun_count * 2, buffer))!=ERROR_OK)
481 break;
482
483 buf_set_u32(reg_params[0].value, 0, 32, source->address);
484 buf_set_u32(reg_params[1].value, 0, 32, address);
485 buf_set_u32(reg_params[2].value, 0, 32, thisrun_count);
486
487 if ((retval = target->type->run_algorithm(target, 0, NULL, 4, reg_params, stm32x_info->write_algorithm->address, \
488 stm32x_info->write_algorithm->address + (sizeof(stm32x_flash_write_code) - 10), 10000, &armv7m_info)) != ERROR_OK)
489 {
490 LOG_ERROR("error executing stm32x flash write algorithm");
491 retval = ERROR_FLASH_OPERATION_FAILED;
492 break;
493 }
494
495 if (buf_get_u32(reg_params[3].value, 0, 32) & 0x14)
496 {
497 retval = ERROR_FLASH_OPERATION_FAILED;
498 break;
499 }
500
501 buffer += thisrun_count * 2;
502 address += thisrun_count * 2;
503 count -= thisrun_count;
504 }
505
506 target_free_working_area(target, source);
507 target_free_working_area(target, stm32x_info->write_algorithm);
508
509 destroy_reg_param(&reg_params[0]);
510 destroy_reg_param(&reg_params[1]);
511 destroy_reg_param(&reg_params[2]);
512 destroy_reg_param(&reg_params[3]);
513
514 return retval;
515 }
516
517 int stm32x_write(struct flash_bank_s *bank, u8 *buffer, u32 offset, u32 count)
518 {
519 target_t *target = bank->target;
520 u32 words_remaining = (count / 2);
521 u32 bytes_remaining = (count & 0x00000001);
522 u32 address = bank->base + offset;
523 u32 bytes_written = 0;
524 u8 status;
525 u32 retval;
526
527 if (bank->target->state != TARGET_HALTED)
528 {
529 return ERROR_TARGET_NOT_HALTED;
530 }
531
532 if (offset & 0x1)
533 {
534 LOG_WARNING("offset 0x%x breaks required 2-byte alignment", offset);
535 return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
536 }
537
538 /* unlock flash registers */
539 target_write_u32(target, STM32_FLASH_KEYR, KEY1);
540 target_write_u32(target, STM32_FLASH_KEYR, KEY2);
541
542 /* multiple half words (2-byte) to be programmed? */
543 if (words_remaining > 0)
544 {
545 /* try using a block write */
546 if ((retval = stm32x_write_block(bank, buffer, offset, words_remaining)) != ERROR_OK)
547 {
548 if (retval == ERROR_TARGET_RESOURCE_NOT_AVAILABLE)
549 {
550 /* if block write failed (no sufficient working area),
551 * we use normal (slow) single dword accesses */
552 LOG_WARNING("couldn't use block writes, falling back to single memory accesses");
553 }
554 else if (retval == ERROR_FLASH_OPERATION_FAILED)
555 {
556 LOG_ERROR("flash writing failed with error code: 0x%x", retval);
557 return ERROR_FLASH_OPERATION_FAILED;
558 }
559 }
560 else
561 {
562 buffer += words_remaining * 2;
563 address += words_remaining * 2;
564 words_remaining = 0;
565 }
566 }
567
568 while (words_remaining > 0)
569 {
570 target_write_u32(target, STM32_FLASH_CR, FLASH_PG);
571 target_write_u16(target, address, *(u16*)(buffer + bytes_written));
572
573 status = stm32x_wait_status_busy(bank, 5);
574
575 if( status & FLASH_WRPRTERR )
576 return ERROR_FLASH_OPERATION_FAILED;
577 if( status & FLASH_PGERR )
578 return ERROR_FLASH_OPERATION_FAILED;
579
580 bytes_written += 2;
581 words_remaining--;
582 address += 2;
583 }
584
585 if (bytes_remaining)
586 {
587 u8 last_halfword[2] = {0xff, 0xff};
588 int i = 0;
589
590 while(bytes_remaining > 0)
591 {
592 last_halfword[i++] = *(buffer + bytes_written);
593 bytes_remaining--;
594 bytes_written++;
595 }
596
597 target_write_u32(target, STM32_FLASH_CR, FLASH_PG);
598 target_write_u16(target, address, *(u16*)last_halfword);
599
600 status = stm32x_wait_status_busy(bank, 5);
601
602 if( status & FLASH_WRPRTERR )
603 return ERROR_FLASH_OPERATION_FAILED;
604 if( status & FLASH_PGERR )
605 return ERROR_FLASH_OPERATION_FAILED;
606 }
607
608 target_write_u32(target, STM32_FLASH_CR, FLASH_LOCK);
609
610 return ERROR_OK;
611 }
612
613 int stm32x_probe(struct flash_bank_s *bank)
614 {
615 target_t *target = bank->target;
616 stm32x_flash_bank_t *stm32x_info = bank->driver_priv;
617 int i;
618 u16 num_pages;
619 u32 device_id;
620 int page_size;
621
622 if (bank->target->state != TARGET_HALTED)
623 {
624 return ERROR_TARGET_NOT_HALTED;
625 }
626
627 stm32x_info->probed = 0;
628
629 /* read stm32 device id register */
630 target_read_u32(target, 0xE0042000, &device_id);
631 LOG_INFO( "device id = 0x%08x", device_id );
632
633 switch (device_id & 0x7ff)
634 {
635 case 0x410:
636 /* medium density - we have 1k pages
637 * 4 pages for a protection area */
638 page_size = 1024;
639 stm32x_info->ppage_size = 4;
640 break;
641
642 case 0x414:
643 /* high density - we have 2k pages
644 * 2 pages for a protection area */
645 page_size = 2048;
646 stm32x_info->ppage_size = 2;
647 break;
648
649 default:
650 LOG_WARNING( "Cannot identify target as a STM32 family." );
651 return ERROR_FLASH_OPERATION_FAILED;
652 }
653
654 /* get flash size from target */
655 if (target_read_u16(target, 0x1FFFF7E0, &num_pages) != ERROR_OK)
656 {
657 /* failed reading flash size, default to 128k */
658 LOG_WARNING( "STM32 flash size failed, probe inaccurate - assuming 128k flash" );
659 num_pages = 128;
660 }
661
662 /* check for early silicon rev A */
663 if ((device_id >> 16) == 0 )
664 {
665 /* number of sectors incorrect on revA */
666 LOG_WARNING( "STM32 Rev A Silicon detected, probe inaccurate - assuming 128k flash" );
667 num_pages = 128;
668 }
669
670 LOG_INFO( "flash size = %dkbytes", num_pages );
671
672 /* calculate numbers of pages */
673 num_pages /= (page_size / 1024);
674
675 bank->base = 0x08000000;
676 bank->size = (num_pages * page_size);
677 bank->num_sectors = num_pages;
678 bank->sectors = malloc(sizeof(flash_sector_t) * num_pages);
679
680 for (i = 0; i < num_pages; i++)
681 {
682 bank->sectors[i].offset = i * page_size;
683 bank->sectors[i].size = page_size;
684 bank->sectors[i].is_erased = -1;
685 bank->sectors[i].is_protected = 1;
686 }
687
688 stm32x_info->probed = 1;
689
690 return ERROR_OK;
691 }
692
693 int stm32x_auto_probe(struct flash_bank_s *bank)
694 {
695 stm32x_flash_bank_t *stm32x_info = bank->driver_priv;
696 if (stm32x_info->probed)
697 return ERROR_OK;
698 return stm32x_probe(bank);
699 }
700
701 int stm32x_handle_part_id_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
702 {
703 return ERROR_OK;
704 }
705
706 int stm32x_info(struct flash_bank_s *bank, char *buf, int buf_size)
707 {
708 snprintf(buf, buf_size, "stm32x flash driver info" );
709 return ERROR_OK;
710 }
711
712 int stm32x_handle_lock_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
713 {
714 flash_bank_t *bank;
715 target_t *target = NULL;
716 stm32x_flash_bank_t *stm32x_info = NULL;
717
718 if (argc < 1)
719 {
720 command_print(cmd_ctx, "stm32x lock <bank>");
721 return ERROR_OK;
722 }
723
724 bank = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
725 if (!bank)
726 {
727 command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
728 return ERROR_OK;
729 }
730
731 stm32x_info = bank->driver_priv;
732
733 target = bank->target;
734
735 if (target->state != TARGET_HALTED)
736 {
737 return ERROR_TARGET_NOT_HALTED;
738 }
739
740 if (stm32x_erase_options(bank) != ERROR_OK)
741 {
742 command_print(cmd_ctx, "stm32x failed to erase options");
743 return ERROR_OK;
744 }
745
746 /* set readout protection */
747 stm32x_info->option_bytes.RDP = 0;
748
749 if (stm32x_write_options(bank) != ERROR_OK)
750 {
751 command_print(cmd_ctx, "stm32x failed to lock device");
752 return ERROR_OK;
753 }
754
755 command_print(cmd_ctx, "stm32x locked");
756
757 return ERROR_OK;
758 }
759
760 int stm32x_handle_unlock_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
761 {
762 flash_bank_t *bank;
763 target_t *target = NULL;
764 stm32x_flash_bank_t *stm32x_info = NULL;
765
766 if (argc < 1)
767 {
768 command_print(cmd_ctx, "stm32x unlock <bank>");
769 return ERROR_OK;
770 }
771
772 bank = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
773 if (!bank)
774 {
775 command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
776 return ERROR_OK;
777 }
778
779 stm32x_info = bank->driver_priv;
780
781 target = bank->target;
782
783 if (target->state != TARGET_HALTED)
784 {
785 return ERROR_TARGET_NOT_HALTED;
786 }
787
788 if (stm32x_erase_options(bank) != ERROR_OK)
789 {
790 command_print(cmd_ctx, "stm32x failed to unlock device");
791 return ERROR_OK;
792 }
793
794 if (stm32x_write_options(bank) != ERROR_OK)
795 {
796 command_print(cmd_ctx, "stm32x failed to lock device");
797 return ERROR_OK;
798 }
799
800 command_print(cmd_ctx, "stm32x unlocked");
801
802 return ERROR_OK;
803 }
804
805 int stm32x_handle_options_read_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
806 {
807 flash_bank_t *bank;
808 u32 optionbyte;
809 target_t *target = NULL;
810 stm32x_flash_bank_t *stm32x_info = NULL;
811
812 if (argc < 1)
813 {
814 command_print(cmd_ctx, "stm32x options_read <bank>");
815 return ERROR_OK;
816 }
817
818 bank = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
819 if (!bank)
820 {
821 command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
822 return ERROR_OK;
823 }
824
825 stm32x_info = bank->driver_priv;
826
827 target = bank->target;
828
829 if (target->state != TARGET_HALTED)
830 {
831 return ERROR_TARGET_NOT_HALTED;
832 }
833
834 target_read_u32(target, STM32_FLASH_OBR, &optionbyte);
835 command_print(cmd_ctx, "Option Byte: 0x%x", optionbyte);
836
837 if (buf_get_u32((u8*)&optionbyte, OPT_ERROR, 1))
838 command_print(cmd_ctx, "Option Byte Complement Error");
839
840 if (buf_get_u32((u8*)&optionbyte, OPT_READOUT, 1))
841 command_print(cmd_ctx, "Readout Protection On");
842 else
843 command_print(cmd_ctx, "Readout Protection Off");
844
845 if (buf_get_u32((u8*)&optionbyte, OPT_RDWDGSW, 1))
846 command_print(cmd_ctx, "Software Watchdog");
847 else
848 command_print(cmd_ctx, "Hardware Watchdog");
849
850 if (buf_get_u32((u8*)&optionbyte, OPT_RDRSTSTOP, 1))
851 command_print(cmd_ctx, "Stop: No reset generated");
852 else
853 command_print(cmd_ctx, "Stop: Reset generated");
854
855 if (buf_get_u32((u8*)&optionbyte, OPT_RDRSTSTDBY, 1))
856 command_print(cmd_ctx, "Standby: No reset generated");
857 else
858 command_print(cmd_ctx, "Standby: Reset generated");
859
860 return ERROR_OK;
861 }
862
863 int stm32x_handle_options_write_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
864 {
865 flash_bank_t *bank;
866 target_t *target = NULL;
867 stm32x_flash_bank_t *stm32x_info = NULL;
868 u16 optionbyte = 0xF8;
869
870 if (argc < 4)
871 {
872 command_print(cmd_ctx, "stm32x options_write <bank> <SWWDG|HWWDG> <RSTSTNDBY|NORSTSTNDBY> <RSTSTOP|NORSTSTOP>");
873 return ERROR_OK;
874 }
875
876 bank = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
877 if (!bank)
878 {
879 command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
880 return ERROR_OK;
881 }
882
883 stm32x_info = bank->driver_priv;
884
885 target = bank->target;
886
887 if (target->state != TARGET_HALTED)
888 {
889 return ERROR_TARGET_NOT_HALTED;
890 }
891
892 if (strcmp(args[1], "SWWDG") == 0)
893 {
894 optionbyte |= (1<<0);
895 }
896 else
897 {
898 optionbyte &= ~(1<<0);
899 }
900
901 if (strcmp(args[2], "NORSTSTNDBY") == 0)
902 {
903 optionbyte |= (1<<1);
904 }
905 else
906 {
907 optionbyte &= ~(1<<1);
908 }
909
910 if (strcmp(args[3], "NORSTSTOP") == 0)
911 {
912 optionbyte |= (1<<2);
913 }
914 else
915 {
916 optionbyte &= ~(1<<2);
917 }
918
919 if (stm32x_erase_options(bank) != ERROR_OK)
920 {
921 command_print(cmd_ctx, "stm32x failed to erase options");
922 return ERROR_OK;
923 }
924
925 stm32x_info->option_bytes.user_options = optionbyte;
926
927 if (stm32x_write_options(bank) != ERROR_OK)
928 {
929 command_print(cmd_ctx, "stm32x failed to write options");
930 return ERROR_OK;
931 }
932
933 command_print(cmd_ctx, "stm32x write options complete");
934
935 return ERROR_OK;
936 }
937
938 int stm32x_mass_erase(struct flash_bank_s *bank)
939 {
940 target_t *target = bank->target;
941 u32 status;
942
943 if (target->state != TARGET_HALTED)
944 {
945 return ERROR_TARGET_NOT_HALTED;
946 }
947
948 /* unlock option flash registers */
949 target_write_u32(target, STM32_FLASH_KEYR, KEY1);
950 target_write_u32(target, STM32_FLASH_KEYR, KEY2);
951
952 /* mass erase flash memory */
953 target_write_u32(target, STM32_FLASH_CR, FLASH_MER);
954 target_write_u32(target, STM32_FLASH_CR, FLASH_MER|FLASH_STRT);
955
956 status = stm32x_wait_status_busy(bank, 10);
957
958 target_write_u32(target, STM32_FLASH_CR, FLASH_LOCK);
959
960 if( status & FLASH_WRPRTERR )
961 {
962 LOG_ERROR("stm32x device protected");
963 return ERROR_OK;
964 }
965
966 if( status & FLASH_PGERR )
967 {
968 LOG_ERROR("stm32x device programming failed");
969 return ERROR_OK;
970 }
971
972 return ERROR_OK;
973 }
974
975 int stm32x_handle_mass_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
976 {
977 flash_bank_t *bank;
978 int i;
979
980 if (argc < 1)
981 {
982 command_print(cmd_ctx, "stm32x mass_erase <bank>");
983 return ERROR_OK;
984 }
985
986 bank = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
987 if (!bank)
988 {
989 command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
990 return ERROR_OK;
991 }
992
993 if (stm32x_mass_erase(bank) == ERROR_OK)
994 {
995 /* set all sectors as erased */
996 for (i = 0; i < bank->num_sectors; i++)
997 {
998 bank->sectors[i].is_erased = 1;
999 }
1000
1001 command_print(cmd_ctx, "stm32x mass erase complete");
1002 }
1003 else
1004 {
1005 command_print(cmd_ctx, "stm32x mass erase failed");
1006 }
1007
1008 return ERROR_OK;
1009 }

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)