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 * Copyright (C) 2013 by Roman Dmitrienko *
14 * Copyright (C) 2014 Nemui Trinomius *
15 * nemuisan_kawausogasuki@live.jp *
17 * This program is free software; you can redistribute it and/or modify *
18 * it under the terms of the GNU General Public License as published by *
19 * the Free Software Foundation; either version 2 of the License, or *
20 * (at your option) any later version. *
22 * This program is distributed in the hope that it will be useful, *
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
25 * GNU General Public License for more details. *
27 * You should have received a copy of the GNU General Public License *
28 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
29 ***************************************************************************/
36 #include <helper/binarybuffer.h>
37 #include <target/algorithm.h>
38 #include <target/armv7m.h>
39 #include <target/cortex_m.h>
41 #define EFM_FAMILY_ID_GIANT_GECKO 72
42 #define EFM_FAMILY_ID_LEOPARD_GECKO 74
44 #define EFM32_FLASH_ERASE_TMO 100
45 #define EFM32_FLASH_WDATAREADY_TMO 100
46 #define EFM32_FLASH_WRITE_TMO 100
48 /* size in bytes, not words; must fit all Gecko devices */
49 #define LOCKBITS_PAGE_SZ 512
51 #define EFM32_MSC_INFO_BASE 0x0fe00000
53 #define EFM32_MSC_USER_DATA EFM32_MSC_INFO_BASE
54 #define EFM32_MSC_LOCK_BITS (EFM32_MSC_INFO_BASE+0x4000)
55 #define EFM32_MSC_DEV_INFO (EFM32_MSC_INFO_BASE+0x8000)
57 /* PAGE_SIZE is not present in Zero, Happy and the original Gecko MCU */
58 #define EFM32_MSC_DI_PAGE_SIZE (EFM32_MSC_DEV_INFO+0x1e7)
59 #define EFM32_MSC_DI_FLASH_SZ (EFM32_MSC_DEV_INFO+0x1f8)
60 #define EFM32_MSC_DI_RAM_SZ (EFM32_MSC_DEV_INFO+0x1fa)
61 #define EFM32_MSC_DI_PART_NUM (EFM32_MSC_DEV_INFO+0x1fc)
62 #define EFM32_MSC_DI_PART_FAMILY (EFM32_MSC_DEV_INFO+0x1fe)
63 #define EFM32_MSC_DI_PROD_REV (EFM32_MSC_DEV_INFO+0x1ff)
65 #define EFM32_MSC_REGBASE 0x400c0000
66 #define EFM32_MSC_REGBASE_SERIES1 0x400e0000
67 #define EFM32_MSC_REG_WRITECTRL 0x008
68 #define EFM32_MSC_WRITECTRL_WREN_MASK 0x1
69 #define EFM32_MSC_REG_WRITECMD 0x00c
70 #define EFM32_MSC_WRITECMD_LADDRIM_MASK 0x1
71 #define EFM32_MSC_WRITECMD_ERASEPAGE_MASK 0x2
72 #define EFM32_MSC_WRITECMD_WRITEONCE_MASK 0x8
73 #define EFM32_MSC_REG_ADDRB 0x010
74 #define EFM32_MSC_REG_WDATA 0x018
75 #define EFM32_MSC_REG_STATUS 0x01c
76 #define EFM32_MSC_STATUS_BUSY_MASK 0x1
77 #define EFM32_MSC_STATUS_LOCKED_MASK 0x2
78 #define EFM32_MSC_STATUS_INVADDR_MASK 0x4
79 #define EFM32_MSC_STATUS_WDATAREADY_MASK 0x8
80 #define EFM32_MSC_STATUS_WORDTIMEOUT_MASK 0x10
81 #define EFM32_MSC_STATUS_ERASEABORTED_MASK 0x20
82 #define EFM32_MSC_REG_LOCK 0x03c
83 #define EFM32_MSC_REG_LOCK_SERIES1 0x040
84 #define EFM32_MSC_LOCK_LOCKKEY 0x1b71
86 struct efm32_family_data {
90 /* EFM32 series (EFM32LG995F is the "old" series 0, while EFR32MG12P132
91 is the "new" series 1). Determines location of MSC registers. */
94 /* Page size in bytes, or 0 to read from EFM32_MSC_DI_PAGE_SIZE */
97 /* MSC register base address, or 0 to use default */
101 struct efm32x_flash_bank {
103 uint32_t lb_page[LOCKBITS_PAGE_SZ/4];
109 const struct efm32_family_data *family_data;
110 uint16_t flash_sz_kib;
118 static const struct efm32_family_data efm32_families[] = {
119 { 16, "EFR32MG1P Mighty", .series = 1 },
120 { 17, "EFR32MG1B Mighty", .series = 1 },
121 { 18, "EFR32MG1V Mighty", .series = 1 },
122 { 19, "EFR32MG1P Blue", .series = 1 },
123 { 20, "EFR32MG1B Blue", .series = 1 },
124 { 21, "EFR32MG1V Blue", .series = 1 },
125 { 25, "EFR32FG1P Flex", .series = 1 },
126 { 26, "EFR32FG1B Flex", .series = 1 },
127 { 27, "EFR32FG1V Flex", .series = 1 },
128 { 28, "EFR32MG2P Mighty", .series = 1 },
129 { 29, "EFR32MG2B Mighty", .series = 1 },
130 { 30, "EFR32MG2V Mighty", .series = 1 },
131 { 31, "EFR32BG12P Blue", .series = 1 },
132 { 32, "EFR32BG12B Blue", .series = 1 },
133 { 33, "EFR32BG12V Blue", .series = 1 },
134 { 37, "EFR32FG12P Flex", .series = 1 },
135 { 38, "EFR32FG12B Flex", .series = 1 },
136 { 39, "EFR32FG12V Flex", .series = 1 },
137 { 40, "EFR32MG13P Mighty", .series = 1 },
138 { 41, "EFR32MG13B Mighty", .series = 1 },
139 { 42, "EFR32MG13V Mighty", .series = 1 },
140 { 43, "EFR32BG13P Blue", .series = 1 },
141 { 44, "EFR32BG13B Blue", .series = 1 },
142 { 45, "EFR32BG13V Blue", .series = 1 },
143 { 46, "EFR32ZG13P Zen", .series = 1 },
144 { 49, "EFR32FG13P Flex", .series = 1 },
145 { 50, "EFR32FG13B Flex", .series = 1 },
146 { 51, "EFR32FG13V Flex", .series = 1 },
147 { 52, "EFR32MG14P Mighty", .series = 1 },
148 { 53, "EFR32MG14B Mighty", .series = 1 },
149 { 54, "EFR32MG14V Mighty", .series = 1 },
150 { 55, "EFR32BG14P Blue", .series = 1 },
151 { 56, "EFR32BG14B Blue", .series = 1 },
152 { 57, "EFR32BG14V Blue", .series = 1 },
153 { 58, "EFR32ZG14P Zen", .series = 1 },
154 { 61, "EFR32FG14P Flex", .series = 1 },
155 { 62, "EFR32FG14B Flex", .series = 1 },
156 { 63, "EFR32FG14V Flex", .series = 1 },
157 { 71, "EFM32G", .series = 0, .page_size = 512 },
158 { 72, "EFM32GG Giant", .series = 0 },
159 { 73, "EFM32TG Tiny", .series = 0, .page_size = 512 },
160 { 74, "EFM32LG Leopard", .series = 0 },
161 { 75, "EFM32WG Wonder", .series = 0 },
162 { 76, "EFM32ZG Zero", .series = 0, .page_size = 1024 },
163 { 77, "EFM32HG Happy", .series = 0, .page_size = 1024 },
164 { 81, "EFM32PG1B Pearl", .series = 1 },
165 { 83, "EFM32JG1B Jade", .series = 1 },
166 { 85, "EFM32PG12B Pearl", .series = 1 },
167 { 87, "EFM32JG12B Jade", .series = 1 },
168 { 89, "EFM32PG13B Pearl", .series = 1 },
169 { 91, "EFM32JG13B Jade", .series = 1 },
170 { 100, "EFM32GG11B Giant", .series = 1, .msc_regbase = 0x40000000 },
171 { 103, "EFM32TG11B Tiny", .series = 1, .msc_regbase = 0x40000000 },
172 { 106, "EFM32GG12B Giant", .series = 1, .msc_regbase = 0x40000000 },
173 { 120, "EZR32WG Wonder", .series = 0 },
174 { 121, "EZR32LG Leopard", .series = 0 },
175 { 122, "EZR32HG Happy", .series = 0, .page_size = 1024 },
179 static int efm32x_write(struct flash_bank *bank, const uint8_t *buffer,
180 uint32_t offset, uint32_t count);
182 static int efm32x_get_flash_size(struct flash_bank *bank, uint16_t *flash_sz)
184 return target_read_u16(bank->target, EFM32_MSC_DI_FLASH_SZ, flash_sz);
187 static int efm32x_get_ram_size(struct flash_bank *bank, uint16_t *ram_sz)
189 return target_read_u16(bank->target, EFM32_MSC_DI_RAM_SZ, ram_sz);
192 static int efm32x_get_part_num(struct flash_bank *bank, uint16_t *pnum)
194 return target_read_u16(bank->target, EFM32_MSC_DI_PART_NUM, pnum);
197 static int efm32x_get_part_family(struct flash_bank *bank, uint8_t *pfamily)
199 return target_read_u8(bank->target, EFM32_MSC_DI_PART_FAMILY, pfamily);
202 static int efm32x_get_prod_rev(struct flash_bank *bank, uint8_t *prev)
204 return target_read_u8(bank->target, EFM32_MSC_DI_PROD_REV, prev);
207 static int efm32x_read_reg_u32(struct flash_bank *bank, target_addr_t offset,
210 struct efm32x_flash_bank *efm32x_info = bank->driver_priv;
211 uint32_t base = efm32x_info->reg_base;
213 return target_read_u32(bank->target, base + offset, value);
216 static int efm32x_write_reg_u32(struct flash_bank *bank, target_addr_t offset,
219 struct efm32x_flash_bank *efm32x_info = bank->driver_priv;
220 uint32_t base = efm32x_info->reg_base;
222 return target_write_u32(bank->target, base + offset, value);
225 static int efm32x_read_info(struct flash_bank *bank,
226 struct efm32_info *efm32_info)
230 struct efm32x_flash_bank *efm32x_info = bank->driver_priv;
232 memset(efm32_info, 0, sizeof(struct efm32_info));
234 ret = target_read_u32(bank->target, CPUID, &cpuid);
238 if (((cpuid >> 4) & 0xfff) == 0xc23) {
239 /* Cortex-M3 device */
240 } else if (((cpuid >> 4) & 0xfff) == 0xc24) {
241 /* Cortex-M4 device (WONDER GECKO) */
242 } else if (((cpuid >> 4) & 0xfff) == 0xc60) {
243 /* Cortex-M0+ device */
245 LOG_ERROR("Target is not Cortex-Mx Device");
249 ret = efm32x_get_flash_size(bank, &(efm32_info->flash_sz_kib));
253 ret = efm32x_get_ram_size(bank, &(efm32_info->ram_sz_kib));
257 ret = efm32x_get_part_num(bank, &(efm32_info->part_num));
261 ret = efm32x_get_part_family(bank, &(efm32_info->part_family));
265 ret = efm32x_get_prod_rev(bank, &(efm32_info->prod_rev));
269 for (size_t i = 0; i < ARRAY_SIZE(efm32_families); i++) {
270 if (efm32_families[i].family_id == efm32_info->part_family)
271 efm32_info->family_data = &efm32_families[i];
274 if (efm32_info->family_data == NULL) {
275 LOG_ERROR("Unknown MCU family %d", efm32_info->part_family);
279 switch (efm32_info->family_data->series) {
281 efm32x_info->reg_base = EFM32_MSC_REGBASE;
282 efm32x_info->reg_lock = EFM32_MSC_REG_LOCK;
285 efm32x_info->reg_base = EFM32_MSC_REGBASE_SERIES1;
286 efm32x_info->reg_lock = EFM32_MSC_REG_LOCK_SERIES1;
290 if (efm32_info->family_data->msc_regbase != 0)
291 efm32x_info->reg_base = efm32_info->family_data->msc_regbase;
293 if (efm32_info->family_data->page_size != 0) {
294 efm32_info->page_size = efm32_info->family_data->page_size;
297 ret = target_read_u8(bank->target, EFM32_MSC_DI_PAGE_SIZE,
302 efm32_info->page_size = (1 << ((pg_size+10) & 0xff));
304 if (efm32_info->part_family == EFM_FAMILY_ID_GIANT_GECKO ||
305 efm32_info->part_family == EFM_FAMILY_ID_LEOPARD_GECKO) {
306 /* Giant or Leopard Gecko */
307 if (efm32_info->prod_rev < 18) {
308 /* EFM32 GG/LG errata: MEM_INFO_PAGE_SIZE is invalid
309 for MCUs with PROD_REV < 18 */
310 if (efm32_info->flash_sz_kib < 512)
311 efm32_info->page_size = 2048;
313 efm32_info->page_size = 4096;
317 if ((efm32_info->page_size != 2048) &&
318 (efm32_info->page_size != 4096)) {
319 LOG_ERROR("Invalid page size %u", efm32_info->page_size);
328 * Helper to create a human friendly string describing a part
330 static int efm32x_decode_info(struct efm32_info *info, char *buf, int buf_size)
333 printed = snprintf(buf, buf_size, "%s Gecko, rev %d",
334 info->family_data->name, info->prod_rev);
336 if (printed >= buf_size)
337 return ERROR_BUF_TOO_SMALL;
342 /* flash bank efm32 <base> <size> 0 0 <target#>
344 FLASH_BANK_COMMAND_HANDLER(efm32x_flash_bank_command)
346 struct efm32x_flash_bank *efm32x_info;
349 return ERROR_COMMAND_SYNTAX_ERROR;
351 efm32x_info = malloc(sizeof(struct efm32x_flash_bank));
353 bank->driver_priv = efm32x_info;
354 efm32x_info->probed = false;
355 memset(efm32x_info->lb_page, 0xff, LOCKBITS_PAGE_SZ);
360 /* set or reset given bits in a register */
361 static int efm32x_set_reg_bits(struct flash_bank *bank, uint32_t reg,
362 uint32_t bitmask, int set)
365 uint32_t reg_val = 0;
367 ret = efm32x_read_reg_u32(bank, reg, ®_val);
376 return efm32x_write_reg_u32(bank, reg, reg_val);
379 static int efm32x_set_wren(struct flash_bank *bank, int write_enable)
381 return efm32x_set_reg_bits(bank, EFM32_MSC_REG_WRITECTRL,
382 EFM32_MSC_WRITECTRL_WREN_MASK, write_enable);
385 static int efm32x_msc_lock(struct flash_bank *bank, int lock)
387 struct efm32x_flash_bank *efm32x_info = bank->driver_priv;
388 return efm32x_write_reg_u32(bank, efm32x_info->reg_lock,
389 (lock ? 0 : EFM32_MSC_LOCK_LOCKKEY));
392 static int efm32x_wait_status(struct flash_bank *bank, int timeout,
393 uint32_t wait_mask, int wait_for_set)
399 ret = efm32x_read_reg_u32(bank, EFM32_MSC_REG_STATUS, &status);
403 LOG_DEBUG("status: 0x%" PRIx32 "", status);
405 if (((status & wait_mask) == 0) && (0 == wait_for_set))
407 else if (((status & wait_mask) != 0) && wait_for_set)
410 if (timeout-- <= 0) {
411 LOG_ERROR("timed out waiting for MSC status");
418 if (status & EFM32_MSC_STATUS_ERASEABORTED_MASK)
419 LOG_WARNING("page erase was aborted");
424 static int efm32x_erase_page(struct flash_bank *bank, uint32_t addr)
426 /* this function DOES NOT set WREN; must be set already */
427 /* 1. write address to ADDRB
429 3. check status (INVADDR, LOCKED)
431 5. wait until !STATUS_BUSY
436 LOG_DEBUG("erasing flash page at 0x%08" PRIx32, addr);
438 ret = efm32x_write_reg_u32(bank, EFM32_MSC_REG_ADDRB, addr);
442 ret = efm32x_set_reg_bits(bank, EFM32_MSC_REG_WRITECMD,
443 EFM32_MSC_WRITECMD_LADDRIM_MASK, 1);
447 ret = efm32x_read_reg_u32(bank, EFM32_MSC_REG_STATUS, &status);
451 LOG_DEBUG("status 0x%" PRIx32, status);
453 if (status & EFM32_MSC_STATUS_LOCKED_MASK) {
454 LOG_ERROR("Page is locked");
456 } else if (status & EFM32_MSC_STATUS_INVADDR_MASK) {
457 LOG_ERROR("Invalid address 0x%" PRIx32, addr);
461 ret = efm32x_set_reg_bits(bank, EFM32_MSC_REG_WRITECMD,
462 EFM32_MSC_WRITECMD_ERASEPAGE_MASK, 1);
466 return efm32x_wait_status(bank, EFM32_FLASH_ERASE_TMO,
467 EFM32_MSC_STATUS_BUSY_MASK, 0);
470 static int efm32x_erase(struct flash_bank *bank, unsigned int first,
473 struct target *target = bank->target;
476 if (TARGET_HALTED != target->state) {
477 LOG_ERROR("Target not halted");
478 return ERROR_TARGET_NOT_HALTED;
481 efm32x_msc_lock(bank, 0);
482 ret = efm32x_set_wren(bank, 1);
483 if (ERROR_OK != ret) {
484 LOG_ERROR("Failed to enable MSC write");
488 for (unsigned int i = first; i <= last; i++) {
489 ret = efm32x_erase_page(bank, bank->sectors[i].offset);
491 LOG_ERROR("Failed to erase page %d", i);
494 ret = efm32x_set_wren(bank, 0);
495 efm32x_msc_lock(bank, 1);
500 static int efm32x_read_lock_data(struct flash_bank *bank)
502 struct efm32x_flash_bank *efm32x_info = bank->driver_priv;
503 struct target *target = bank->target;
505 uint32_t *ptr = NULL;
508 assert(bank->num_sectors > 0);
510 /* calculate the number of 32-bit words to read (one lock bit per sector) */
511 data_size = (bank->num_sectors + 31) / 32;
513 ptr = efm32x_info->lb_page;
515 for (int i = 0; i < data_size; i++, ptr++) {
516 ret = target_read_u32(target, EFM32_MSC_LOCK_BITS+i*4, ptr);
517 if (ERROR_OK != ret) {
518 LOG_ERROR("Failed to read PLW %d", i);
523 /* also, read ULW, DLW, MLW, ALW and CLW words */
526 ptr = efm32x_info->lb_page + 126;
527 ret = target_read_u32(target, EFM32_MSC_LOCK_BITS+126*4, ptr);
528 if (ERROR_OK != ret) {
529 LOG_ERROR("Failed to read ULW");
534 ptr = efm32x_info->lb_page + 127;
535 ret = target_read_u32(target, EFM32_MSC_LOCK_BITS+127*4, ptr);
536 if (ERROR_OK != ret) {
537 LOG_ERROR("Failed to read DLW");
541 /* MLW, word 125, present in GG, LG, PG, JG, EFR32 */
542 ptr = efm32x_info->lb_page + 125;
543 ret = target_read_u32(target, EFM32_MSC_LOCK_BITS+125*4, ptr);
544 if (ERROR_OK != ret) {
545 LOG_ERROR("Failed to read MLW");
549 /* ALW, word 124, present in GG, LG, PG, JG, EFR32 */
550 ptr = efm32x_info->lb_page + 124;
551 ret = target_read_u32(target, EFM32_MSC_LOCK_BITS+124*4, ptr);
552 if (ERROR_OK != ret) {
553 LOG_ERROR("Failed to read ALW");
557 /* CLW1, word 123, present in EFR32 */
558 ptr = efm32x_info->lb_page + 123;
559 ret = target_read_u32(target, EFM32_MSC_LOCK_BITS+123*4, ptr);
560 if (ERROR_OK != ret) {
561 LOG_ERROR("Failed to read CLW1");
565 /* CLW0, word 122, present in GG, LG, PG, JG, EFR32 */
566 ptr = efm32x_info->lb_page + 122;
567 ret = target_read_u32(target, EFM32_MSC_LOCK_BITS+122*4, ptr);
568 if (ERROR_OK != ret) {
569 LOG_ERROR("Failed to read CLW0");
576 static int efm32x_write_lock_data(struct flash_bank *bank)
578 struct efm32x_flash_bank *efm32x_info = bank->driver_priv;
581 ret = efm32x_erase_page(bank, EFM32_MSC_LOCK_BITS);
582 if (ERROR_OK != ret) {
583 LOG_ERROR("Failed to erase LB page");
587 return efm32x_write(bank, (uint8_t *)efm32x_info->lb_page, EFM32_MSC_LOCK_BITS,
591 static int efm32x_get_page_lock(struct flash_bank *bank, size_t page)
593 struct efm32x_flash_bank *efm32x_info = bank->driver_priv;
594 uint32_t dw = efm32x_info->lb_page[page >> 5];
597 mask = 1 << (page & 0x1f);
599 return (dw & mask) ? 0 : 1;
602 static int efm32x_set_page_lock(struct flash_bank *bank, size_t page, int set)
604 struct efm32x_flash_bank *efm32x_info = bank->driver_priv;
605 uint32_t *dw = &efm32x_info->lb_page[page >> 5];
608 mask = 1 << (page & 0x1f);
618 static int efm32x_protect(struct flash_bank *bank, int set, unsigned int first,
621 struct target *target = bank->target;
625 LOG_ERROR("Erase device data to reset page locks");
629 if (target->state != TARGET_HALTED) {
630 LOG_ERROR("Target not halted");
631 return ERROR_TARGET_NOT_HALTED;
634 for (unsigned int i = first; i <= last; i++) {
635 ret = efm32x_set_page_lock(bank, i, set);
636 if (ERROR_OK != ret) {
637 LOG_ERROR("Failed to set lock on page %d", i);
642 ret = efm32x_write_lock_data(bank);
643 if (ERROR_OK != ret) {
644 LOG_ERROR("Failed to write LB page");
651 static int efm32x_write_block(struct flash_bank *bank, const uint8_t *buf,
652 uint32_t offset, uint32_t count)
654 struct target *target = bank->target;
655 uint32_t buffer_size = 16384;
656 struct working_area *write_algorithm;
657 struct working_area *source;
658 uint32_t address = bank->base + offset;
659 struct reg_param reg_params[5];
660 struct armv7m_algorithm armv7m_info;
661 struct efm32x_flash_bank *efm32x_info = bank->driver_priv;
664 /* see contrib/loaders/flash/efm32.S for src */
665 static const uint8_t efm32x_flash_write_code[] = {
666 /* #define EFM32_MSC_WRITECTRL_OFFSET 0x008 */
667 /* #define EFM32_MSC_WRITECMD_OFFSET 0x00c */
668 /* #define EFM32_MSC_ADDRB_OFFSET 0x010 */
669 /* #define EFM32_MSC_WDATA_OFFSET 0x018 */
670 /* #define EFM32_MSC_STATUS_OFFSET 0x01c */
672 0x01, 0x26, /* movs r6, #1 */
673 0x86, 0x60, /* str r6, [r0, #EFM32_MSC_WRITECTRL_OFFSET] */
676 0x16, 0x68, /* ldr r6, [r2, #0] */
677 0x00, 0x2e, /* cmp r6, #0 */
678 0x22, 0xd0, /* beq exit */
679 0x55, 0x68, /* ldr r5, [r2, #4] */
680 0xb5, 0x42, /* cmp r5, r6 */
681 0xf9, 0xd0, /* beq wait_fifo */
683 0x04, 0x61, /* str r4, [r0, #EFM32_MSC_ADDRB_OFFSET] */
684 0x01, 0x26, /* movs r6, #1 */
685 0xc6, 0x60, /* str r6, [r0, #EFM32_MSC_WRITECMD_OFFSET] */
686 0xc6, 0x69, /* ldr r6, [r0, #EFM32_MSC_STATUS_OFFSET] */
687 0x06, 0x27, /* movs r7, #6 */
688 0x3e, 0x42, /* tst r6, r7 */
689 0x16, 0xd1, /* bne error */
691 /* wait_wdataready: */
692 0xc6, 0x69, /* ldr r6, [r0, #EFM32_MSC_STATUS_OFFSET] */
693 0x08, 0x27, /* movs r7, #8 */
694 0x3e, 0x42, /* tst r6, r7 */
695 0xfb, 0xd0, /* beq wait_wdataready */
697 0x2e, 0x68, /* ldr r6, [r5] */
698 0x86, 0x61, /* str r6, [r0, #EFM32_MSC_WDATA_OFFSET] */
699 0x08, 0x26, /* movs r6, #8 */
700 0xc6, 0x60, /* str r6, [r0, #EFM32_MSC_WRITECMD_OFFSET] */
702 0x04, 0x35, /* adds r5, #4 */
703 0x04, 0x34, /* adds r4, #4 */
706 0xc6, 0x69, /* ldr r6, [r0, #EFM32_MSC_STATUS_OFFSET] */
707 0x01, 0x27, /* movs r7, #1 */
708 0x3e, 0x42, /* tst r6, r7 */
709 0xfb, 0xd1, /* bne busy */
711 0x9d, 0x42, /* cmp r5, r3 */
712 0x01, 0xd3, /* bcc no_wrap */
713 0x15, 0x46, /* mov r5, r2 */
714 0x08, 0x35, /* adds r5, #8 */
717 0x55, 0x60, /* str r5, [r2, #4] */
718 0x01, 0x39, /* subs r1, r1, #1 */
719 0x00, 0x29, /* cmp r1, #0 */
720 0x02, 0xd0, /* beq exit */
721 0xdb, 0xe7, /* b wait_fifo */
724 0x00, 0x20, /* movs r0, #0 */
725 0x50, 0x60, /* str r0, [r2, #4] */
728 0x30, 0x46, /* mov r0, r6 */
729 0x00, 0xbe, /* bkpt #0 */
733 /* flash write code */
734 if (target_alloc_working_area(target, sizeof(efm32x_flash_write_code),
735 &write_algorithm) != ERROR_OK) {
736 LOG_WARNING("no working area available, can't do block memory writes");
737 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
740 ret = target_write_buffer(target, write_algorithm->address,
741 sizeof(efm32x_flash_write_code), efm32x_flash_write_code);
746 while (target_alloc_working_area_try(target, buffer_size, &source) != ERROR_OK) {
748 buffer_size &= ~3UL; /* Make sure it's 4 byte aligned */
749 if (buffer_size <= 256) {
750 /* we already allocated the writing code, but failed to get a
751 * buffer, free the algorithm */
752 target_free_working_area(target, write_algorithm);
754 LOG_WARNING("no large enough working area available, can't do block memory writes");
755 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
759 init_reg_param(®_params[0], "r0", 32, PARAM_IN_OUT); /* flash base (in), status (out) */
760 init_reg_param(®_params[1], "r1", 32, PARAM_OUT); /* count (word-32bit) */
761 init_reg_param(®_params[2], "r2", 32, PARAM_OUT); /* buffer start */
762 init_reg_param(®_params[3], "r3", 32, PARAM_OUT); /* buffer end */
763 init_reg_param(®_params[4], "r4", 32, PARAM_IN_OUT); /* target address */
765 buf_set_u32(reg_params[0].value, 0, 32, efm32x_info->reg_base);
766 buf_set_u32(reg_params[1].value, 0, 32, count);
767 buf_set_u32(reg_params[2].value, 0, 32, source->address);
768 buf_set_u32(reg_params[3].value, 0, 32, source->address + source->size);
769 buf_set_u32(reg_params[4].value, 0, 32, address);
771 armv7m_info.common_magic = ARMV7M_COMMON_MAGIC;
772 armv7m_info.core_mode = ARM_MODE_THREAD;
774 ret = target_run_flash_async_algorithm(target, buf, count, 4,
777 source->address, source->size,
778 write_algorithm->address, 0,
781 if (ret == ERROR_FLASH_OPERATION_FAILED) {
782 LOG_ERROR("flash write failed at address 0x%"PRIx32,
783 buf_get_u32(reg_params[4].value, 0, 32));
785 if (buf_get_u32(reg_params[0].value, 0, 32) &
786 EFM32_MSC_STATUS_LOCKED_MASK) {
787 LOG_ERROR("flash memory write protected");
790 if (buf_get_u32(reg_params[0].value, 0, 32) &
791 EFM32_MSC_STATUS_INVADDR_MASK) {
792 LOG_ERROR("invalid flash memory write address");
796 target_free_working_area(target, source);
797 target_free_working_area(target, write_algorithm);
799 destroy_reg_param(®_params[0]);
800 destroy_reg_param(®_params[1]);
801 destroy_reg_param(®_params[2]);
802 destroy_reg_param(®_params[3]);
803 destroy_reg_param(®_params[4]);
808 static int efm32x_write_word(struct flash_bank *bank, uint32_t addr,
811 /* this function DOES NOT set WREN; must be set already */
812 /* 1. write address to ADDRB
814 3. check status (INVADDR, LOCKED)
815 4. wait for WDATAREADY
816 5. write data to WDATA
817 6. write WRITECMD_WRITEONCE to WRITECMD
818 7. wait until !STATUS_BUSY
821 /* FIXME: EFM32G ref states (7.3.2) that writes should be
822 * performed twice per dword */
827 /* if not called, GDB errors will be reported during large writes */
830 ret = efm32x_write_reg_u32(bank, EFM32_MSC_REG_ADDRB, addr);
834 ret = efm32x_set_reg_bits(bank, EFM32_MSC_REG_WRITECMD,
835 EFM32_MSC_WRITECMD_LADDRIM_MASK, 1);
839 ret = efm32x_read_reg_u32(bank, EFM32_MSC_REG_STATUS, &status);
843 LOG_DEBUG("status 0x%" PRIx32, status);
845 if (status & EFM32_MSC_STATUS_LOCKED_MASK) {
846 LOG_ERROR("Page is locked");
848 } else if (status & EFM32_MSC_STATUS_INVADDR_MASK) {
849 LOG_ERROR("Invalid address 0x%" PRIx32, addr);
853 ret = efm32x_wait_status(bank, EFM32_FLASH_WDATAREADY_TMO,
854 EFM32_MSC_STATUS_WDATAREADY_MASK, 1);
855 if (ERROR_OK != ret) {
856 LOG_ERROR("Wait for WDATAREADY failed");
860 ret = efm32x_write_reg_u32(bank, EFM32_MSC_REG_WDATA, val);
861 if (ERROR_OK != ret) {
862 LOG_ERROR("WDATA write failed");
866 ret = efm32x_write_reg_u32(bank, EFM32_MSC_REG_WRITECMD,
867 EFM32_MSC_WRITECMD_WRITEONCE_MASK);
868 if (ERROR_OK != ret) {
869 LOG_ERROR("WRITECMD write failed");
873 ret = efm32x_wait_status(bank, EFM32_FLASH_WRITE_TMO,
874 EFM32_MSC_STATUS_BUSY_MASK, 0);
875 if (ERROR_OK != ret) {
876 LOG_ERROR("Wait for BUSY failed");
883 static int efm32x_write(struct flash_bank *bank, const uint8_t *buffer,
884 uint32_t offset, uint32_t count)
886 struct target *target = bank->target;
887 uint8_t *new_buffer = NULL;
889 if (target->state != TARGET_HALTED) {
890 LOG_ERROR("Target not halted");
891 return ERROR_TARGET_NOT_HALTED;
895 LOG_ERROR("offset 0x%" PRIx32 " breaks required 4-byte "
896 "alignment", offset);
897 return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
901 uint32_t old_count = count;
902 count = (old_count | 3) + 1;
903 new_buffer = malloc(count);
904 if (new_buffer == NULL) {
905 LOG_ERROR("odd number of bytes to write and no memory "
906 "for padding buffer");
909 LOG_INFO("odd number of bytes to write (%" PRIu32 "), extending to %" PRIu32 " "
910 "and padding with 0xff", old_count, count);
911 memset(new_buffer, 0xff, count);
912 buffer = memcpy(new_buffer, buffer, old_count);
915 uint32_t words_remaining = count / 4;
918 /* unlock flash registers */
919 efm32x_msc_lock(bank, 0);
920 retval = efm32x_set_wren(bank, 1);
921 if (retval != ERROR_OK)
924 /* try using a block write */
925 retval = efm32x_write_block(bank, buffer, offset, words_remaining);
927 if (retval == ERROR_TARGET_RESOURCE_NOT_AVAILABLE) {
928 /* if block write failed (no sufficient working area),
929 * we use normal (slow) single word accesses */
930 LOG_WARNING("couldn't use block writes, falling back to single "
933 while (words_remaining > 0) {
935 memcpy(&value, buffer, sizeof(uint32_t));
937 retval = efm32x_write_word(bank, offset, value);
938 if (retval != ERROR_OK)
939 goto reset_pg_and_lock;
948 retval2 = efm32x_set_wren(bank, 0);
949 efm32x_msc_lock(bank, 1);
950 if (retval == ERROR_OK)
960 static int efm32x_probe(struct flash_bank *bank)
962 struct efm32x_flash_bank *efm32x_info = bank->driver_priv;
963 struct efm32_info efm32_mcu_info;
965 uint32_t base_address = 0x00000000;
968 efm32x_info->probed = false;
969 memset(efm32x_info->lb_page, 0xff, LOCKBITS_PAGE_SZ);
971 ret = efm32x_read_info(bank, &efm32_mcu_info);
975 ret = efm32x_decode_info(&efm32_mcu_info, buf, sizeof(buf));
979 LOG_INFO("detected part: %s", buf);
980 LOG_INFO("flash size = %dkbytes", efm32_mcu_info.flash_sz_kib);
981 LOG_INFO("flash page size = %dbytes", efm32_mcu_info.page_size);
983 assert(0 != efm32_mcu_info.page_size);
985 int num_pages = efm32_mcu_info.flash_sz_kib * 1024 /
986 efm32_mcu_info.page_size;
988 assert(num_pages > 0);
992 bank->sectors = NULL;
995 bank->base = base_address;
996 bank->size = (num_pages * efm32_mcu_info.page_size);
997 bank->num_sectors = num_pages;
999 ret = efm32x_read_lock_data(bank);
1000 if (ERROR_OK != ret) {
1001 LOG_ERROR("Failed to read LB data");
1005 bank->sectors = malloc(sizeof(struct flash_sector) * num_pages);
1007 for (int i = 0; i < num_pages; i++) {
1008 bank->sectors[i].offset = i * efm32_mcu_info.page_size;
1009 bank->sectors[i].size = efm32_mcu_info.page_size;
1010 bank->sectors[i].is_erased = -1;
1011 bank->sectors[i].is_protected = 1;
1014 efm32x_info->probed = true;
1019 static int efm32x_auto_probe(struct flash_bank *bank)
1021 struct efm32x_flash_bank *efm32x_info = bank->driver_priv;
1022 if (efm32x_info->probed)
1024 return efm32x_probe(bank);
1027 static int efm32x_protect_check(struct flash_bank *bank)
1029 struct target *target = bank->target;
1032 if (target->state != TARGET_HALTED) {
1033 LOG_ERROR("Target not halted");
1034 return ERROR_TARGET_NOT_HALTED;
1037 ret = efm32x_read_lock_data(bank);
1038 if (ERROR_OK != ret) {
1039 LOG_ERROR("Failed to read LB data");
1043 assert(NULL != bank->sectors);
1045 for (unsigned int i = 0; i < bank->num_sectors; i++)
1046 bank->sectors[i].is_protected = efm32x_get_page_lock(bank, i);
1051 static int get_efm32x_info(struct flash_bank *bank, char *buf, int buf_size)
1053 struct efm32_info info;
1056 ret = efm32x_read_info(bank, &info);
1057 if (ERROR_OK != ret) {
1058 LOG_ERROR("Failed to read EFM32 info");
1062 return efm32x_decode_info(&info, buf, buf_size);
1065 COMMAND_HANDLER(efm32x_handle_debuglock_command)
1067 struct target *target = NULL;
1070 return ERROR_COMMAND_SYNTAX_ERROR;
1072 struct flash_bank *bank;
1073 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
1074 if (ERROR_OK != retval)
1077 struct efm32x_flash_bank *efm32x_info = bank->driver_priv;
1079 target = bank->target;
1081 if (target->state != TARGET_HALTED) {
1082 LOG_ERROR("Target not halted");
1083 return ERROR_TARGET_NOT_HALTED;
1087 ptr = efm32x_info->lb_page + 127;
1090 retval = efm32x_write_lock_data(bank);
1091 if (ERROR_OK != retval) {
1092 LOG_ERROR("Failed to write LB page");
1096 command_print(CMD, "efm32x debug interface locked, reset the device to apply");
1101 static const struct command_registration efm32x_exec_command_handlers[] = {
1103 .name = "debuglock",
1104 .handler = efm32x_handle_debuglock_command,
1105 .mode = COMMAND_EXEC,
1107 .help = "Lock the debug interface of the device.",
1109 COMMAND_REGISTRATION_DONE
1112 static const struct command_registration efm32x_command_handlers[] = {
1115 .mode = COMMAND_ANY,
1116 .help = "efm32 flash command group",
1118 .chain = efm32x_exec_command_handlers,
1120 COMMAND_REGISTRATION_DONE
1123 const struct flash_driver efm32_flash = {
1125 .commands = efm32x_command_handlers,
1126 .flash_bank_command = efm32x_flash_bank_command,
1127 .erase = efm32x_erase,
1128 .protect = efm32x_protect,
1129 .write = efm32x_write,
1130 .read = default_flash_read,
1131 .probe = efm32x_probe,
1132 .auto_probe = efm32x_auto_probe,
1133 .erase_check = default_flash_blank_check,
1134 .protect_check = efm32x_protect_check,
1135 .info = get_efm32x_info,
1136 .free_driver_priv = default_flash_free_driver_priv,