1 /***************************************************************************
2 * Copyright (C) 2011 by Mathias Kuester *
5 * Copyright (C) 2011 sleep(5) ltd *
6 * tomas@sleepfive.com *
8 * Copyright (C) 2012 by Christopher D. Kilgour *
9 * techie at whiterocker.com *
11 * Copyright (C) 2013 Nemui Trinomius *
12 * nemuisan_kawausogasuki@live.jp *
14 * This program is free software; you can redistribute it and/or modify *
15 * it under the terms of the GNU General Public License as published by *
16 * the Free Software Foundation; either version 2 of the License, or *
17 * (at your option) any later version. *
19 * This program is distributed in the hope that it will be useful, *
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
22 * GNU General Public License for more details. *
24 * You should have received a copy of the GNU General Public License *
25 * along with this program; if not, write to the *
26 * Free Software Foundation, Inc., *
27 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
28 ***************************************************************************/
34 #include "jtag/interface.h"
36 #include <helper/binarybuffer.h>
37 #include <target/target_type.h>
38 #include <target/algorithm.h>
39 #include <target/armv7m.h>
40 #include <target/cortex_m.h>
43 * Implementation Notes
45 * The persistent memories in the Kinetis chip families K10 through
46 * K70 are all manipulated with the Flash Memory Module. Some
47 * variants call this module the FTFE, others call it the FTFL. To
48 * indicate that both are considered here, we use FTFX.
50 * Within the module, according to the chip variant, the persistent
51 * memory is divided into what Freescale terms Program Flash, FlexNVM,
52 * and FlexRAM. All chip variants have Program Flash. Some chip
53 * variants also have FlexNVM and FlexRAM, which always appear
56 * A given Kinetis chip may have 1, 2 or 4 blocks of flash. Here we map
57 * each block to a separate bank. Each block size varies by chip and
58 * may be determined by the read-only SIM_FCFG1 register. The sector
59 * size within each bank/block varies by chip, and may be 1, 2 or 4k.
60 * The sector size may be different for flash and FlexNVM.
62 * The first half of the flash (1 or 2 blocks) is always Program Flash
63 * and always starts at address 0x00000000. The "PFLSH" flag, bit 23
64 * of the read-only SIM_FCFG2 register, determines whether the second
65 * half of the flash is also Program Flash or FlexNVM+FlexRAM. When
66 * PFLSH is set, the second from the first half. When PFLSH is clear,
67 * the second half of flash is FlexNVM and always starts at address
68 * 0x10000000. FlexRAM, which is also present when PFLSH is clear,
69 * always starts at address 0x14000000.
71 * The Flash Memory Module provides a register set where flash
72 * commands are loaded to perform flash operations like erase and
73 * program. Different commands are available depending on whether
74 * Program Flash or FlexNVM/FlexRAM is being manipulated. Although
75 * the commands used are quite consistent between flash blocks, the
76 * parameters they accept differ according to the flash sector size.
81 #define FLEXRAM 0x14000000
82 #define FTFx_FSTAT 0x40020000
83 #define FTFx_FCNFG 0x40020001
84 #define FTFx_FCCOB3 0x40020004
85 #define FTFx_FPROT3 0x40020010
86 #define FTFx_FDPROT 0x40020017
87 #define SIM_SDID 0x40048024
88 #define SIM_SOPT1 0x40047000
89 #define SIM_FCFG1 0x4004804c
90 #define SIM_FCFG2 0x40048050
91 #define WDOG_STCTRH 0x40052000
94 #define FTFx_CMD_BLOCKSTAT 0x00
95 #define FTFx_CMD_SECTSTAT 0x01
96 #define FTFx_CMD_LWORDPROG 0x06
97 #define FTFx_CMD_SECTERASE 0x09
98 #define FTFx_CMD_SECTWRITE 0x0b
99 #define FTFx_CMD_SETFLEXRAM 0x81
100 #define FTFx_CMD_MASSERASE 0x44
102 /* The older Kinetis K series uses the following SDID layout :
109 * The newer Kinetis series uses the following SDID layout :
111 * Bit 27-24 : SUBFAMID
112 * Bit 23-20 : SERIESID
113 * Bit 19-16 : SRAMSIZE
115 * Bit 6-4 : Reserved (0)
118 * We assume that if bits 31-16 are 0 then it's an older
122 #define KINETIS_SOPT1_RAMSIZE_MASK 0x0000F000
123 #define KINETIS_SOPT1_RAMSIZE_K24FN1M 0x0000B000
125 #define KINETIS_SDID_K_SERIES_MASK 0x0000FFFF
127 #define KINETIS_SDID_DIEID_MASK 0x00000F80
129 #define KINETIS_SDID_DIEID_K22FN128 0x00000680 /* smaller pflash with FTFA */
130 #define KINETIS_SDID_DIEID_K22FN256 0x00000A80
131 #define KINETIS_SDID_DIEID_K22FN512 0x00000E80
132 #define KINETIS_SDID_DIEID_K24FN256 0x00000700
134 #define KINETIS_SDID_DIEID_K24FN1M 0x00000300 /* Detect Errata 7534 */
136 /* We can't rely solely on the FAMID field to determine the MCU
137 * type since some FAMID values identify multiple MCUs with
138 * different flash sector sizes (K20 and K22 for instance).
139 * Therefore we combine it with the DIEID bits which may possibly
140 * break if Freescale bumps the DIEID for a particular MCU. */
141 #define KINETIS_K_SDID_TYPE_MASK 0x00000FF0
142 #define KINETIS_K_SDID_K10_M50 0x00000000
143 #define KINETIS_K_SDID_K10_M72 0x00000080
144 #define KINETIS_K_SDID_K10_M100 0x00000100
145 #define KINETIS_K_SDID_K10_M120 0x00000180
146 #define KINETIS_K_SDID_K11 0x00000220
147 #define KINETIS_K_SDID_K12 0x00000200
148 #define KINETIS_K_SDID_K20_M50 0x00000010
149 #define KINETIS_K_SDID_K20_M72 0x00000090
150 #define KINETIS_K_SDID_K20_M100 0x00000110
151 #define KINETIS_K_SDID_K20_M120 0x00000190
152 #define KINETIS_K_SDID_K21_M50 0x00000230
153 #define KINETIS_K_SDID_K21_M120 0x00000330
154 #define KINETIS_K_SDID_K22_M50 0x00000210
155 #define KINETIS_K_SDID_K22_M120 0x00000310
156 #define KINETIS_K_SDID_K30_M72 0x000000A0
157 #define KINETIS_K_SDID_K30_M100 0x00000120
158 #define KINETIS_K_SDID_K40_M72 0x000000B0
159 #define KINETIS_K_SDID_K40_M100 0x00000130
160 #define KINETIS_K_SDID_K50_M72 0x000000E0
161 #define KINETIS_K_SDID_K51_M72 0x000000F0
162 #define KINETIS_K_SDID_K53 0x00000170
163 #define KINETIS_K_SDID_K60_M100 0x00000140
164 #define KINETIS_K_SDID_K60_M150 0x000001C0
165 #define KINETIS_K_SDID_K70_M150 0x000001D0
167 #define KINETIS_SDID_SERIESID_MASK 0x00F00000
168 #define KINETIS_SDID_SERIESID_K 0x00000000
169 #define KINETIS_SDID_SERIESID_KL 0x00100000
170 #define KINETIS_SDID_SERIESID_KW 0x00500000
171 #define KINETIS_SDID_SERIESID_KV 0x00600000
173 #define KINETIS_SDID_SUBFAMID_MASK 0x0F000000
174 #define KINETIS_SDID_SUBFAMID_KX0 0x00000000
175 #define KINETIS_SDID_SUBFAMID_KX1 0x01000000
176 #define KINETIS_SDID_SUBFAMID_KX2 0x02000000
177 #define KINETIS_SDID_SUBFAMID_KX3 0x03000000
178 #define KINETIS_SDID_SUBFAMID_KX4 0x04000000
179 #define KINETIS_SDID_SUBFAMID_KX5 0x05000000
180 #define KINETIS_SDID_SUBFAMID_KX6 0x06000000
182 #define KINETIS_SDID_FAMILYID_MASK 0xF0000000
183 #define KINETIS_SDID_FAMILYID_K0X 0x00000000
184 #define KINETIS_SDID_FAMILYID_K1X 0x10000000
185 #define KINETIS_SDID_FAMILYID_K2X 0x20000000
186 #define KINETIS_SDID_FAMILYID_K3X 0x30000000
187 #define KINETIS_SDID_FAMILYID_K4X 0x40000000
188 #define KINETIS_SDID_FAMILYID_K6X 0x60000000
189 #define KINETIS_SDID_FAMILYID_K7X 0x70000000
191 struct kinetis_flash_bank {
193 uint32_t sector_size;
194 uint32_t max_flash_prog_size;
195 uint32_t protection_size;
196 uint32_t prog_base; /* base address for FTFx operations */
197 /* same as bank->base for pflash, differs for FlexNVM */
198 uint32_t protection_block; /* number of first protection block in this bank */
212 FS_PROGRAM_SECTOR = 1,
213 FS_PROGRAM_LONGWORD = 2,
214 FS_PROGRAM_PHRASE = 4, /* Unsupported */
218 #define MDM_REG_STAT 0x00
219 #define MDM_REG_CTRL 0x04
220 #define MDM_REG_ID 0xfc
222 #define MDM_STAT_FMEACK (1<<0)
223 #define MDM_STAT_FREADY (1<<1)
224 #define MDM_STAT_SYSSEC (1<<2)
225 #define MDM_STAT_SYSRES (1<<3)
226 #define MDM_STAT_FMEEN (1<<5)
227 #define MDM_STAT_BACKDOOREN (1<<6)
228 #define MDM_STAT_LPEN (1<<7)
229 #define MDM_STAT_VLPEN (1<<8)
230 #define MDM_STAT_LLSMODEXIT (1<<9)
231 #define MDM_STAT_VLLSXMODEXIT (1<<10)
232 #define MDM_STAT_CORE_HALTED (1<<16)
233 #define MDM_STAT_CORE_SLEEPDEEP (1<<17)
234 #define MDM_STAT_CORESLEEPING (1<<18)
236 #define MEM_CTRL_FMEIP (1<<0)
237 #define MEM_CTRL_DBG_DIS (1<<1)
238 #define MEM_CTRL_DBG_REQ (1<<2)
239 #define MEM_CTRL_SYS_RES_REQ (1<<3)
240 #define MEM_CTRL_CORE_HOLD_RES (1<<4)
241 #define MEM_CTRL_VLLSX_DBG_REQ (1<<5)
242 #define MEM_CTRL_VLLSX_DBG_ACK (1<<6)
243 #define MEM_CTRL_VLLSX_STAT_ACK (1<<7)
245 #define MDM_ACCESS_TIMEOUT 3000 /* iterations */
247 static int kinetis_mdm_write_register(struct adiv5_dap *dap, unsigned reg, uint32_t value)
250 LOG_DEBUG("MDM_REG[0x%02x] <- %08" PRIX32, reg, value);
252 retval = dap_queue_ap_write(dap_ap(dap, 1), reg, value);
253 if (retval != ERROR_OK) {
254 LOG_DEBUG("MDM: failed to queue a write request");
258 retval = dap_run(dap);
259 if (retval != ERROR_OK) {
260 LOG_DEBUG("MDM: dap_run failed");
268 static int kinetis_mdm_read_register(struct adiv5_dap *dap, unsigned reg, uint32_t *result)
272 retval = dap_queue_ap_read(dap_ap(dap, 1), reg, result);
273 if (retval != ERROR_OK) {
274 LOG_DEBUG("MDM: failed to queue a read request");
278 retval = dap_run(dap);
279 if (retval != ERROR_OK) {
280 LOG_DEBUG("MDM: dap_run failed");
284 LOG_DEBUG("MDM_REG[0x%02x]: %08" PRIX32, reg, *result);
288 static int kinetis_mdm_poll_register(struct adiv5_dap *dap, unsigned reg, uint32_t mask, uint32_t value)
292 int timeout = MDM_ACCESS_TIMEOUT;
295 retval = kinetis_mdm_read_register(dap, reg, &val);
296 if (retval != ERROR_OK || (val & mask) == value)
302 LOG_DEBUG("MDM: polling timed out");
307 * This function implements the procedure to mass erase the flash via
308 * SWD/JTAG on Kinetis K and L series of devices as it is described in
309 * AN4835 "Production Flash Programming Best Practices for Kinetis K-
310 * and L-series MCUs" Section 4.2.1
312 COMMAND_HANDLER(kinetis_mdm_mass_erase)
314 struct target *target = get_current_target(CMD_CTX);
315 struct cortex_m_common *cortex_m = target_to_cm(target);
316 struct adiv5_dap *dap = cortex_m->armv7m.arm.dap;
319 LOG_ERROR("Cannot perform mass erase with a high-level adapter");
326 * ... Power on the processor, or if power has already been
327 * applied, assert the RESET pin to reset the processor. For
328 * devices that do not have a RESET pin, write the System
329 * Reset Request bit in the MDM-AP control register after
330 * establishing communication...
334 if (jtag_get_reset_config() & RESET_HAS_SRST)
335 adapter_assert_reset();
337 LOG_WARNING("Attempting mass erase without hardware reset. This is not reliable; "
338 "it's recommended you connect SRST and use ``reset_config srst_only''.");
340 retval = kinetis_mdm_write_register(dap, MDM_REG_CTRL, MEM_CTRL_SYS_RES_REQ);
341 if (retval != ERROR_OK)
345 * ... Read the MDM-AP status register until the Flash Ready bit sets...
347 retval = kinetis_mdm_poll_register(dap, MDM_REG_STAT,
348 MDM_STAT_FREADY | MDM_STAT_SYSRES,
350 if (retval != ERROR_OK) {
351 LOG_ERROR("MDM : flash ready timeout");
356 * ... Write the MDM-AP control register to set the Flash Mass
357 * Erase in Progress bit. This will start the mass erase
360 retval = kinetis_mdm_write_register(dap, MDM_REG_CTRL,
361 MEM_CTRL_SYS_RES_REQ | MEM_CTRL_FMEIP);
362 if (retval != ERROR_OK)
365 /* As a sanity check make sure that device started mass erase procedure */
366 retval = kinetis_mdm_poll_register(dap, MDM_REG_STAT,
367 MDM_STAT_FMEACK, MDM_STAT_FMEACK);
368 if (retval != ERROR_OK)
372 * ... Read the MDM-AP control register until the Flash Mass
373 * Erase in Progress bit clears...
375 retval = kinetis_mdm_poll_register(dap, MDM_REG_CTRL,
378 if (retval != ERROR_OK)
382 * ... Negate the RESET signal or clear the System Reset Request
383 * bit in the MDM-AP control register...
385 retval = kinetis_mdm_write_register(dap, MDM_REG_CTRL, 0);
386 if (retval != ERROR_OK)
389 if (jtag_get_reset_config() & RESET_HAS_SRST) {
390 /* halt MCU otherwise it loops in hard fault - WDOG reset cycle */
391 target->reset_halt = true;
392 target->type->assert_reset(target);
393 target->type->deassert_reset(target);
399 static const uint32_t kinetis_known_mdm_ids[] = {
400 0x001C0000, /* Kinetis-K Series */
401 0x001C0020, /* Kinetis-L/M/V/E Series */
405 * This function implements the procedure to connect to
406 * SWD/JTAG on Kinetis K and L series of devices as it is described in
407 * AN4835 "Production Flash Programming Best Practices for Kinetis K-
408 * and L-series MCUs" Section 4.1.1
410 COMMAND_HANDLER(kinetis_check_flash_security_status)
412 struct target *target = get_current_target(CMD_CTX);
413 struct cortex_m_common *cortex_m = target_to_cm(target);
414 struct adiv5_dap *dap = cortex_m->armv7m.arm.dap;
417 LOG_WARNING("Cannot check flash security status with a high-level adapter");
425 * ... The MDM-AP ID register can be read to verify that the
426 * connection is working correctly...
428 retval = kinetis_mdm_read_register(dap, MDM_REG_ID, &val);
429 if (retval != ERROR_OK) {
430 LOG_ERROR("MDM: failed to read ID register");
435 for (size_t i = 0; i < ARRAY_SIZE(kinetis_known_mdm_ids); i++) {
436 if (val == kinetis_known_mdm_ids[i]) {
443 LOG_WARNING("MDM: unknown ID %08" PRIX32, val);
446 * ... Read the MDM-AP status register until the Flash Ready bit sets...
448 retval = kinetis_mdm_poll_register(dap, MDM_REG_STAT,
451 if (retval != ERROR_OK) {
452 LOG_ERROR("MDM: flash ready timeout");
457 * ... Read the System Security bit to determine if security is enabled.
458 * If System Security = 0, then proceed. If System Security = 1, then
459 * communication with the internals of the processor, including the
460 * flash, will not be possible without issuing a mass erase command or
461 * unsecuring the part through other means (backdoor key unlock)...
463 retval = kinetis_mdm_read_register(dap, MDM_REG_STAT, &val);
464 if (retval != ERROR_OK) {
465 LOG_ERROR("MDM: failed to read MDM_REG_STAT");
469 if ((val & (MDM_STAT_SYSSEC | MDM_STAT_CORE_HALTED)) == MDM_STAT_SYSSEC) {
470 LOG_WARNING("MDM: Secured MCU state detected however it may be a false alarm");
471 LOG_WARNING("MDM: Halting target to detect secured state reliably");
473 retval = target_halt(target);
474 if (retval == ERROR_OK)
475 retval = target_wait_state(target, TARGET_HALTED, 100);
477 if (retval != ERROR_OK) {
478 LOG_WARNING("MDM: Target not halted, trying reset halt");
479 target->reset_halt = true;
480 target->type->assert_reset(target);
481 target->type->deassert_reset(target);
485 retval = kinetis_mdm_read_register(dap, MDM_REG_STAT, &val);
486 if (retval != ERROR_OK) {
487 LOG_ERROR("MDM: failed to read MDM_REG_STAT");
492 if (val & MDM_STAT_SYSSEC) {
493 jtag_poll_set_enabled(false);
495 LOG_WARNING("*********** ATTENTION! ATTENTION! ATTENTION! ATTENTION! **********");
496 LOG_WARNING("**** ****");
497 LOG_WARNING("**** Your Kinetis MCU is in secured state, which means that, ****");
498 LOG_WARNING("**** with exception for very basic communication, JTAG/SWD ****");
499 LOG_WARNING("**** interface will NOT work. In order to restore its ****");
500 LOG_WARNING("**** functionality please issue 'kinetis mdm mass_erase' ****");
501 LOG_WARNING("**** command, power cycle the MCU and restart OpenOCD. ****");
502 LOG_WARNING("**** ****");
503 LOG_WARNING("*********** ATTENTION! ATTENTION! ATTENTION! ATTENTION! **********");
505 LOG_INFO("MDM: Chip is unsecured. Continuing.");
506 jtag_poll_set_enabled(true);
512 LOG_ERROR("MDM: Failed to check security status of the MCU. Cannot proceed further");
513 jtag_poll_set_enabled(false);
517 FLASH_BANK_COMMAND_HANDLER(kinetis_flash_bank_command)
519 struct kinetis_flash_bank *bank_info;
522 return ERROR_COMMAND_SYNTAX_ERROR;
524 LOG_INFO("add flash_bank kinetis %s", bank->name);
526 bank_info = malloc(sizeof(struct kinetis_flash_bank));
528 memset(bank_info, 0, sizeof(struct kinetis_flash_bank));
530 bank->driver_priv = bank_info;
535 /* Disable the watchdog on Kinetis devices */
536 int kinetis_disable_wdog(struct target *target, uint32_t sim_sdid)
538 struct working_area *wdog_algorithm;
539 struct armv7m_algorithm armv7m_info;
543 static const uint8_t kinetis_unlock_wdog_code[] = {
544 /* WDOG_UNLOCK = 0xC520 */
545 0x4f, 0xf4, 0x00, 0x53, /* mov.w r3, #8192 ; 0x2000 */
546 0xc4, 0xf2, 0x05, 0x03, /* movt r3, #16389 ; 0x4005 */
547 0x4c, 0xf2, 0x20, 0x52, /* movw r2, #50464 ; 0xc520 */
548 0xda, 0x81, /* strh r2, [r3, #14] */
550 /* WDOG_UNLOCK = 0xD928 */
551 0x4f, 0xf4, 0x00, 0x53, /* mov.w r3, #8192 ; 0x2000 */
552 0xc4, 0xf2, 0x05, 0x03, /* movt r3, #16389 ; 0x4005 */
553 0x4d, 0xf6, 0x28, 0x12, /* movw r2, #55592 ; 0xd928 */
554 0xda, 0x81, /* strh r2, [r3, #14] */
556 /* WDOG_SCR = 0x1d2 */
557 0x4f, 0xf4, 0x00, 0x53, /* mov.w r3, #8192 ; 0x2000 */
558 0xc4, 0xf2, 0x05, 0x03, /* movt r3, #16389 ; 0x4005 */
559 0x4f, 0xf4, 0xe9, 0x72, /* mov.w r2, #466 ; 0x1d2 */
560 0x1a, 0x80, /* strh r2, [r3, #0] */
563 0x00, 0xBE, /* bkpt #0 */
566 /* Decide whether the connected device needs watchdog disabling.
567 * Disable for all Kx devices, i.e., return if it is a KLx */
569 if ((sim_sdid & KINETIS_SDID_SERIESID_MASK) == KINETIS_SDID_SERIESID_KL)
572 /* The connected device requires watchdog disabling. */
573 retval = target_read_u16(target, WDOG_STCTRH, &wdog);
574 if (retval != ERROR_OK)
577 if ((wdog & 0x1) == 0) {
578 /* watchdog already disabled */
581 LOG_INFO("Disabling Kinetis watchdog (initial WDOG_STCTRLH = 0x%x)", wdog);
583 if (target->state != TARGET_HALTED) {
584 LOG_ERROR("Target not halted");
585 return ERROR_TARGET_NOT_HALTED;
588 retval = target_alloc_working_area(target, sizeof(kinetis_unlock_wdog_code), &wdog_algorithm);
589 if (retval != ERROR_OK)
592 retval = target_write_buffer(target, wdog_algorithm->address,
593 sizeof(kinetis_unlock_wdog_code), (uint8_t *)kinetis_unlock_wdog_code);
594 if (retval != ERROR_OK) {
595 target_free_working_area(target, wdog_algorithm);
599 armv7m_info.common_magic = ARMV7M_COMMON_MAGIC;
600 armv7m_info.core_mode = ARM_MODE_THREAD;
602 retval = target_run_algorithm(target, 0, NULL, 0, NULL, wdog_algorithm->address,
603 wdog_algorithm->address + (sizeof(kinetis_unlock_wdog_code) - 2),
604 10000, &armv7m_info);
606 if (retval != ERROR_OK)
607 LOG_ERROR("error executing kinetis wdog unlock algorithm");
609 retval = target_read_u16(target, WDOG_STCTRH, &wdog);
610 if (retval != ERROR_OK)
612 LOG_INFO("WDOG_STCTRLH = 0x%x", wdog);
614 target_free_working_area(target, wdog_algorithm);
619 COMMAND_HANDLER(kinetis_disable_wdog_handler)
623 struct target *target = get_current_target(CMD_CTX);
626 return ERROR_COMMAND_SYNTAX_ERROR;
628 result = target_read_u32(target, SIM_SDID, &sim_sdid);
629 if (result != ERROR_OK) {
630 LOG_ERROR("Failed to read SIMSDID");
634 result = kinetis_disable_wdog(target, sim_sdid);
639 /* Kinetis Program-LongWord Microcodes */
640 static const uint8_t kinetis_flash_write_code[] = {
642 * r0 - workarea buffer
643 * r1 - target address
653 /* for(register uint32_t i=0;i<wcount;i++){ */
654 0x04, 0x1C, /* mov r4, r0 */
655 0x00, 0x23, /* mov r3, #0 */
657 0x0E, 0x1A, /* sub r6, r1, r0 */
658 0xA6, 0x19, /* add r6, r4, r6 */
659 0x93, 0x42, /* cmp r3, r2 */
660 0x16, 0xD0, /* beq .L9 */
662 /* while((FTFx_FSTAT&FTFA_FSTAT_CCIF_MASK) != FTFA_FSTAT_CCIF_MASK){}; */
663 0x0B, 0x4D, /* ldr r5, .L10 */
664 0x2F, 0x78, /* ldrb r7, [r5] */
665 0x7F, 0xB2, /* sxtb r7, r7 */
666 0x00, 0x2F, /* cmp r7, #0 */
667 0xFA, 0xDA, /* bge .L5 */
668 /* FTFx_FSTAT = FTFA_FSTAT_ACCERR_MASK|FTFA_FSTAT_FPVIOL_MASK|FTFA_FSTAT_RDCO */
669 0x70, 0x27, /* mov r7, #112 */
670 0x2F, 0x70, /* strb r7, [r5] */
671 /* FTFx_FCCOB3 = faddr; */
672 0x09, 0x4F, /* ldr r7, .L10+4 */
673 0x3E, 0x60, /* str r6, [r7] */
674 0x06, 0x27, /* mov r7, #6 */
675 /* FTFx_FCCOB0 = 0x06; */
676 0x08, 0x4E, /* ldr r6, .L10+8 */
677 0x37, 0x70, /* strb r7, [r6] */
678 /* FTFx_FCCOB7 = *pLW; */
679 0x80, 0xCC, /* ldmia r4!, {r7} */
680 0x08, 0x4E, /* ldr r6, .L10+12 */
681 0x37, 0x60, /* str r7, [r6] */
682 /* FTFx_FSTAT = FTFA_FSTAT_CCIF_MASK; */
683 0x80, 0x27, /* mov r7, #128 */
684 0x2F, 0x70, /* strb r7, [r5] */
686 /* while((FTFx_FSTAT&FTFA_FSTAT_CCIF_MASK) != FTFA_FSTAT_CCIF_MASK){}; */
687 0x2E, 0x78, /* ldrb r6, [r5] */
688 0x77, 0xB2, /* sxtb r7, r6 */
689 0x00, 0x2F, /* cmp r7, #0 */
690 0xFB, 0xDA, /* bge .L4 */
691 0x01, 0x33, /* add r3, r3, #1 */
692 0xE4, 0xE7, /* b .L2 */
694 0x00, 0xBE, /* bkpt #0 */
696 0x00, 0x00, 0x02, 0x40, /* .word 1073872896 */
697 0x04, 0x00, 0x02, 0x40, /* .word 1073872900 */
698 0x07, 0x00, 0x02, 0x40, /* .word 1073872903 */
699 0x08, 0x00, 0x02, 0x40, /* .word 1073872904 */
702 /* Program LongWord Block Write */
703 static int kinetis_write_block(struct flash_bank *bank, const uint8_t *buffer,
704 uint32_t offset, uint32_t wcount)
706 struct target *target = bank->target;
707 uint32_t buffer_size = 2048; /* Default minimum value */
708 struct working_area *write_algorithm;
709 struct working_area *source;
710 struct kinetis_flash_bank *kinfo = bank->driver_priv;
711 uint32_t address = kinfo->prog_base + offset;
712 struct reg_param reg_params[3];
713 struct armv7m_algorithm armv7m_info;
714 int retval = ERROR_OK;
717 * r0 - workarea buffer
718 * r1 - target address
727 /* Increase buffer_size if needed */
728 if (buffer_size < (target->working_area_size/2))
729 buffer_size = (target->working_area_size/2);
731 LOG_INFO("Kinetis: FLASH Write ...");
733 /* check code alignment */
735 LOG_WARNING("offset 0x%" PRIx32 " breaks required 2-byte alignment", offset);
736 return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
739 /* allocate working area with flash programming code */
740 if (target_alloc_working_area(target, sizeof(kinetis_flash_write_code),
741 &write_algorithm) != ERROR_OK) {
742 LOG_WARNING("no working area available, can't do block memory writes");
743 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
746 retval = target_write_buffer(target, write_algorithm->address,
747 sizeof(kinetis_flash_write_code), kinetis_flash_write_code);
748 if (retval != ERROR_OK)
752 while (target_alloc_working_area(target, buffer_size, &source) != ERROR_OK) {
754 if (buffer_size <= 256) {
755 /* free working area, write algorithm already allocated */
756 target_free_working_area(target, write_algorithm);
758 LOG_WARNING("No large enough working area available, can't do block memory writes");
759 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
763 armv7m_info.common_magic = ARMV7M_COMMON_MAGIC;
764 armv7m_info.core_mode = ARM_MODE_THREAD;
766 init_reg_param(®_params[0], "r0", 32, PARAM_OUT); /* *pLW (*buffer) */
767 init_reg_param(®_params[1], "r1", 32, PARAM_OUT); /* faddr */
768 init_reg_param(®_params[2], "r2", 32, PARAM_OUT); /* number of words to program */
770 /* write code buffer and use Flash programming code within kinetis */
771 /* Set breakpoint to 0 with time-out of 1000 ms */
773 uint32_t thisrun_count = (wcount > (buffer_size / 4)) ? (buffer_size / 4) : wcount;
775 retval = target_write_buffer(target, source->address, thisrun_count * 4, buffer);
776 if (retval != ERROR_OK)
779 buf_set_u32(reg_params[0].value, 0, 32, source->address);
780 buf_set_u32(reg_params[1].value, 0, 32, address);
781 buf_set_u32(reg_params[2].value, 0, 32, thisrun_count);
783 retval = target_run_algorithm(target, 0, NULL, 3, reg_params,
784 write_algorithm->address, 0, 100000, &armv7m_info);
785 if (retval != ERROR_OK) {
786 LOG_ERROR("Error executing kinetis Flash programming algorithm");
787 retval = ERROR_FLASH_OPERATION_FAILED;
791 buffer += thisrun_count * 4;
792 address += thisrun_count * 4;
793 wcount -= thisrun_count;
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]);
806 static int kinetis_protect(struct flash_bank *bank, int set, int first, int last)
808 LOG_WARNING("kinetis_protect not supported yet");
811 if (bank->target->state != TARGET_HALTED) {
812 LOG_ERROR("Target not halted");
813 return ERROR_TARGET_NOT_HALTED;
816 return ERROR_FLASH_BANK_INVALID;
819 static int kinetis_protect_check(struct flash_bank *bank)
821 struct kinetis_flash_bank *kinfo = bank->driver_priv;
824 uint32_t fprot, psec;
826 if (bank->target->state != TARGET_HALTED) {
827 LOG_ERROR("Target not halted");
828 return ERROR_TARGET_NOT_HALTED;
831 if (kinfo->flash_class == FC_PFLASH) {
834 /* read protection register */
835 result = target_read_memory(bank->target, FTFx_FPROT3, 1, 4, buffer);
837 if (result != ERROR_OK)
840 fprot = target_buffer_get_u32(bank->target, buffer);
841 /* Every bit protects 1/32 of the full flash (not necessarily just this bank) */
843 } else if (kinfo->flash_class == FC_FLEX_NVM) {
846 /* read protection register */
847 result = target_read_memory(bank->target, FTFx_FDPROT, 1, 1, &fdprot);
849 if (result != ERROR_OK)
855 LOG_ERROR("Protection checks for FlexRAM not supported");
856 return ERROR_FLASH_BANK_INVALID;
859 b = kinfo->protection_block;
860 for (psec = 0, i = 0; i < bank->num_sectors; i++) {
861 if ((fprot >> b) & 1)
862 bank->sectors[i].is_protected = 0;
864 bank->sectors[i].is_protected = 1;
866 psec += bank->sectors[i].size;
868 if (psec >= kinfo->protection_size) {
877 static int kinetis_ftfx_command(struct target *target, uint8_t fcmd, uint32_t faddr,
878 uint8_t fccob4, uint8_t fccob5, uint8_t fccob6, uint8_t fccob7,
879 uint8_t fccob8, uint8_t fccob9, uint8_t fccoba, uint8_t fccobb,
882 uint8_t command[12] = {faddr & 0xff, (faddr >> 8) & 0xff, (faddr >> 16) & 0xff, fcmd,
883 fccob7, fccob6, fccob5, fccob4,
884 fccobb, fccoba, fccob9, fccob8};
889 for (i = 0; i < 50; i++) {
891 target_read_memory(target, FTFx_FSTAT, 1, 1, &buffer);
893 if (result != ERROR_OK)
902 if (buffer != 0x80) {
903 /* reset error flags */
906 target_write_memory(target, FTFx_FSTAT, 1, 1, &buffer);
907 if (result != ERROR_OK)
911 result = target_write_memory(target, FTFx_FCCOB3, 4, 3, command);
913 if (result != ERROR_OK)
918 result = target_write_memory(target, FTFx_FSTAT, 1, 1, &buffer);
919 if (result != ERROR_OK)
923 for (i = 0; i < 240; i++) { /* Need longtime for "Mass Erase" Command Nemui Changed */
925 target_read_memory(target, FTFx_FSTAT, 1, 1, ftfx_fstat);
927 if (result != ERROR_OK)
930 if (*ftfx_fstat & 0x80)
934 if ((*ftfx_fstat & 0xf0) != 0x80) {
936 ("ftfx command failed FSTAT: %02X FCCOB: %02X%02X%02X%02X %02X%02X%02X%02X %02X%02X%02X%02X",
937 *ftfx_fstat, command[3], command[2], command[1], command[0],
938 command[7], command[6], command[5], command[4],
939 command[11], command[10], command[9], command[8]);
940 return ERROR_FLASH_OPERATION_FAILED;
947 static int kinetis_erase(struct flash_bank *bank, int first, int last)
950 struct kinetis_flash_bank *kinfo = bank->driver_priv;
952 if (bank->target->state != TARGET_HALTED) {
953 LOG_ERROR("Target not halted");
954 return ERROR_TARGET_NOT_HALTED;
957 if ((first > bank->num_sectors) || (last > bank->num_sectors))
958 return ERROR_FLASH_OPERATION_FAILED;
961 * FIXME: TODO: use the 'Erase Flash Block' command if the
962 * requested erase is PFlash or NVM and encompasses the entire
963 * block. Should be quicker.
965 for (i = first; i <= last; i++) {
967 /* set command and sector address */
968 result = kinetis_ftfx_command(bank->target, FTFx_CMD_SECTERASE, kinfo->prog_base + bank->sectors[i].offset,
969 0, 0, 0, 0, 0, 0, 0, 0, &ftfx_fstat);
971 if (result != ERROR_OK) {
972 LOG_WARNING("erase sector %d failed", i);
973 return ERROR_FLASH_OPERATION_FAILED;
976 bank->sectors[i].is_erased = 1;
981 ("flash configuration field erased, please reset the device");
987 static int kinetis_make_ram_ready(struct target *target)
993 /* check if ram ready */
994 result = target_read_memory(target, FTFx_FCNFG, 1, 1, &ftfx_fcnfg);
995 if (result != ERROR_OK)
998 if (ftfx_fcnfg & (1 << 1))
999 return ERROR_OK; /* ram ready */
1001 /* make flex ram available */
1002 result = kinetis_ftfx_command(target, FTFx_CMD_SETFLEXRAM, 0x00ff0000,
1003 0, 0, 0, 0, 0, 0, 0, 0, &ftfx_fstat);
1004 if (result != ERROR_OK)
1005 return ERROR_FLASH_OPERATION_FAILED;
1008 result = target_read_memory(target, FTFx_FCNFG, 1, 1, &ftfx_fcnfg);
1009 if (result != ERROR_OK)
1012 if (ftfx_fcnfg & (1 << 1))
1013 return ERROR_OK; /* ram ready */
1015 return ERROR_FLASH_OPERATION_FAILED;
1018 static int kinetis_write(struct flash_bank *bank, const uint8_t *buffer,
1019 uint32_t offset, uint32_t count)
1021 unsigned int i, result, fallback = 0;
1023 struct kinetis_flash_bank *kinfo = bank->driver_priv;
1024 uint8_t *new_buffer = NULL;
1026 if (bank->target->state != TARGET_HALTED) {
1027 LOG_ERROR("Target not halted");
1028 return ERROR_TARGET_NOT_HALTED;
1031 if (!(kinfo->flash_support & FS_PROGRAM_SECTOR)) {
1032 /* fallback to longword write */
1034 LOG_WARNING("This device supports Program Longword execution only.");
1036 result = kinetis_make_ram_ready(bank->target);
1037 if (result != ERROR_OK) {
1039 LOG_WARNING("FlexRAM not ready, fallback to slow longword write.");
1043 LOG_DEBUG("flash write @08%" PRIX32, offset);
1046 /* program section command */
1047 if (fallback == 0) {
1049 * Kinetis uses different terms for the granularity of
1050 * sector writes, e.g. "phrase" or "128 bits". We use
1051 * the generic term "chunk". The largest possible
1052 * Kinetis "chunk" is 16 bytes (128 bits).
1054 unsigned prog_section_chunk_bytes = kinfo->sector_size >> 8;
1055 unsigned prog_size_bytes = kinfo->max_flash_prog_size;
1056 for (i = 0; i < count; i += prog_size_bytes) {
1057 uint8_t residual_buffer[16];
1059 uint32_t section_count = prog_size_bytes / prog_section_chunk_bytes;
1060 uint32_t residual_wc = 0;
1063 * Assume the word count covers an entire
1066 wc = prog_size_bytes / 4;
1069 * If bytes to be programmed are less than the
1070 * full sector, then determine the number of
1071 * full-words to program, and put together the
1072 * residual buffer so that a full "section"
1073 * may always be programmed.
1075 if ((count - i) < prog_size_bytes) {
1076 /* number of bytes to program beyond full section */
1077 unsigned residual_bc = (count-i) % prog_section_chunk_bytes;
1079 /* number of complete words to copy directly from buffer */
1080 wc = (count - i - residual_bc) / 4;
1082 /* number of total sections to write, including residual */
1083 section_count = DIV_ROUND_UP((count-i), prog_section_chunk_bytes);
1085 /* any residual bytes delivers a whole residual section */
1086 residual_wc = (residual_bc ? prog_section_chunk_bytes : 0)/4;
1088 /* clear residual buffer then populate residual bytes */
1089 (void) memset(residual_buffer, 0xff, prog_section_chunk_bytes);
1090 (void) memcpy(residual_buffer, &buffer[i+4*wc], residual_bc);
1093 LOG_DEBUG("write section @ %08" PRIX32 " with length %" PRIu32 " bytes",
1094 offset + i, (uint32_t)wc*4);
1096 /* write data to flexram as whole-words */
1097 result = target_write_memory(bank->target, FLEXRAM, 4, wc,
1100 if (result != ERROR_OK) {
1101 LOG_ERROR("target_write_memory failed");
1105 /* write the residual words to the flexram */
1107 result = target_write_memory(bank->target,
1112 if (result != ERROR_OK) {
1113 LOG_ERROR("target_write_memory failed");
1118 /* execute section-write command */
1119 result = kinetis_ftfx_command(bank->target, FTFx_CMD_SECTWRITE, kinfo->prog_base + offset + i,
1120 section_count>>8, section_count, 0, 0,
1121 0, 0, 0, 0, &ftfx_fstat);
1123 if (result != ERROR_OK)
1124 return ERROR_FLASH_OPERATION_FAILED;
1127 /* program longword command, not supported in "SF3" devices */
1128 else if (kinfo->flash_support & FS_PROGRAM_LONGWORD) {
1130 uint32_t old_count = count;
1131 count = (old_count | 3) + 1;
1132 new_buffer = malloc(count);
1133 if (new_buffer == NULL) {
1134 LOG_ERROR("odd number of bytes to write and no memory "
1135 "for padding buffer");
1138 LOG_INFO("odd number of bytes to write (%" PRIu32 "), extending to %" PRIu32 " "
1139 "and padding with 0xff", old_count, count);
1140 memset(new_buffer, 0xff, count);
1141 buffer = memcpy(new_buffer, buffer, old_count);
1144 uint32_t words_remaining = count / 4;
1146 kinetis_disable_wdog(bank->target, kinfo->sim_sdid);
1148 /* try using a block write */
1149 int retval = kinetis_write_block(bank, buffer, offset, words_remaining);
1151 if (retval == ERROR_TARGET_RESOURCE_NOT_AVAILABLE) {
1152 /* if block write failed (no sufficient working area),
1153 * we use normal (slow) single word accesses */
1154 LOG_WARNING("couldn't use block writes, falling back to single "
1157 for (i = 0; i < count; i += 4) {
1160 LOG_DEBUG("write longword @ %08" PRIX32, (uint32_t)(offset + i));
1162 uint8_t padding[4] = {0xff, 0xff, 0xff, 0xff};
1163 memcpy(padding, buffer + i, MIN(4, count-i));
1165 result = kinetis_ftfx_command(bank->target, FTFx_CMD_LWORDPROG, kinfo->prog_base + offset + i,
1166 padding[3], padding[2], padding[1], padding[0],
1167 0, 0, 0, 0, &ftfx_fstat);
1169 if (result != ERROR_OK)
1170 return ERROR_FLASH_OPERATION_FAILED;
1174 LOG_ERROR("Flash write strategy not implemented");
1175 return ERROR_FLASH_OPERATION_FAILED;
1181 static int kinetis_read_part_info(struct flash_bank *bank)
1184 uint32_t offset = 0;
1185 uint8_t fcfg1_nvmsize, fcfg1_pfsize, fcfg1_eesize, fcfg1_depart;
1186 uint8_t fcfg2_pflsh;
1187 uint32_t nvm_size = 0, pf_size = 0, df_size = 0, ee_size = 0;
1188 unsigned num_blocks = 0, num_pflash_blocks = 0, num_nvm_blocks = 0, first_nvm_bank = 0,
1189 pflash_sector_size_bytes = 0, nvm_sector_size_bytes = 0;
1190 struct target *target = bank->target;
1191 struct kinetis_flash_bank *kinfo = bank->driver_priv;
1193 kinfo->probed = false;
1195 result = target_read_u32(target, SIM_SDID, &kinfo->sim_sdid);
1196 if (result != ERROR_OK)
1199 if ((kinfo->sim_sdid & (~KINETIS_SDID_K_SERIES_MASK)) == 0) {
1200 /* older K-series MCU */
1201 uint32_t mcu_type = kinfo->sim_sdid & KINETIS_K_SDID_TYPE_MASK;
1204 case KINETIS_K_SDID_K10_M50:
1205 case KINETIS_K_SDID_K20_M50:
1207 pflash_sector_size_bytes = 1<<10;
1208 nvm_sector_size_bytes = 1<<10;
1210 kinfo->flash_support = FS_PROGRAM_LONGWORD | FS_PROGRAM_SECTOR;
1212 case KINETIS_K_SDID_K10_M72:
1213 case KINETIS_K_SDID_K20_M72:
1214 case KINETIS_K_SDID_K30_M72:
1215 case KINETIS_K_SDID_K30_M100:
1216 case KINETIS_K_SDID_K40_M72:
1217 case KINETIS_K_SDID_K40_M100:
1218 case KINETIS_K_SDID_K50_M72:
1219 /* 2kB sectors, 1kB FlexNVM sectors */
1220 pflash_sector_size_bytes = 2<<10;
1221 nvm_sector_size_bytes = 1<<10;
1223 kinfo->flash_support = FS_PROGRAM_LONGWORD | FS_PROGRAM_SECTOR;
1224 kinfo->max_flash_prog_size = 1<<10;
1226 case KINETIS_K_SDID_K10_M100:
1227 case KINETIS_K_SDID_K20_M100:
1228 case KINETIS_K_SDID_K11:
1229 case KINETIS_K_SDID_K12:
1230 case KINETIS_K_SDID_K21_M50:
1231 case KINETIS_K_SDID_K22_M50:
1232 case KINETIS_K_SDID_K51_M72:
1233 case KINETIS_K_SDID_K53:
1234 case KINETIS_K_SDID_K60_M100:
1236 pflash_sector_size_bytes = 2<<10;
1237 nvm_sector_size_bytes = 2<<10;
1239 kinfo->flash_support = FS_PROGRAM_LONGWORD | FS_PROGRAM_SECTOR;
1241 case KINETIS_K_SDID_K21_M120:
1242 case KINETIS_K_SDID_K22_M120:
1243 /* 4kB sectors (MK21FN1M0, MK21FX512, MK22FN1M0, MK22FX512) */
1244 pflash_sector_size_bytes = 4<<10;
1245 kinfo->max_flash_prog_size = 1<<10;
1246 nvm_sector_size_bytes = 4<<10;
1248 kinfo->flash_support = FS_PROGRAM_PHRASE | FS_PROGRAM_SECTOR;
1250 case KINETIS_K_SDID_K10_M120:
1251 case KINETIS_K_SDID_K20_M120:
1252 case KINETIS_K_SDID_K60_M150:
1253 case KINETIS_K_SDID_K70_M150:
1255 pflash_sector_size_bytes = 4<<10;
1256 nvm_sector_size_bytes = 4<<10;
1258 kinfo->flash_support = FS_PROGRAM_PHRASE | FS_PROGRAM_SECTOR;
1261 LOG_ERROR("Unsupported K-family FAMID");
1264 /* Newer K-series or KL series MCU */
1265 switch (kinfo->sim_sdid & KINETIS_SDID_SERIESID_MASK) {
1266 case KINETIS_SDID_SERIESID_K:
1267 switch (kinfo->sim_sdid & (KINETIS_SDID_FAMILYID_MASK | KINETIS_SDID_SUBFAMID_MASK)) {
1268 case KINETIS_SDID_FAMILYID_K0X | KINETIS_SDID_SUBFAMID_KX2:
1269 /* K02FN64, K02FN128: FTFA, 2kB sectors */
1270 pflash_sector_size_bytes = 2<<10;
1272 kinfo->flash_support = FS_PROGRAM_LONGWORD;
1275 case KINETIS_SDID_FAMILYID_K2X | KINETIS_SDID_SUBFAMID_KX2: {
1276 /* MK24FN1M reports as K22, this should detect it (according to errata note 1N83J) */
1278 result = target_read_u32(target, SIM_SOPT1, &sopt1);
1279 if (result != ERROR_OK)
1282 if (((kinfo->sim_sdid & (KINETIS_SDID_DIEID_MASK)) == KINETIS_SDID_DIEID_K24FN1M) &&
1283 ((sopt1 & KINETIS_SOPT1_RAMSIZE_MASK) == KINETIS_SOPT1_RAMSIZE_K24FN1M)) {
1285 pflash_sector_size_bytes = 4<<10;
1287 kinfo->flash_support = FS_PROGRAM_PHRASE | FS_PROGRAM_SECTOR;
1288 kinfo->max_flash_prog_size = 1<<10;
1291 if ((kinfo->sim_sdid & (KINETIS_SDID_DIEID_MASK)) == KINETIS_SDID_DIEID_K22FN128
1292 || (kinfo->sim_sdid & (KINETIS_SDID_DIEID_MASK)) == KINETIS_SDID_DIEID_K22FN256
1293 || (kinfo->sim_sdid & (KINETIS_SDID_DIEID_MASK)) == KINETIS_SDID_DIEID_K22FN512) {
1294 /* K22 with new-style SDID - smaller pflash with FTFA, 2kB sectors */
1295 pflash_sector_size_bytes = 2<<10;
1296 num_blocks = 2; /* 1 or 2 blocks */
1297 kinfo->flash_support = FS_PROGRAM_LONGWORD;
1300 LOG_ERROR("Unsupported Kinetis K22 DIEID");
1303 case KINETIS_SDID_FAMILYID_K2X | KINETIS_SDID_SUBFAMID_KX4:
1304 pflash_sector_size_bytes = 4<<10;
1305 if ((kinfo->sim_sdid & (KINETIS_SDID_DIEID_MASK)) == KINETIS_SDID_DIEID_K24FN256) {
1306 /* K24FN256 - smaller pflash with FTFA */
1308 kinfo->flash_support = FS_PROGRAM_LONGWORD;
1311 /* K24FN1M without errata 7534 */
1313 kinfo->flash_support = FS_PROGRAM_PHRASE | FS_PROGRAM_SECTOR;
1314 kinfo->max_flash_prog_size = 1<<10;
1317 case KINETIS_SDID_FAMILYID_K6X | KINETIS_SDID_SUBFAMID_KX3:
1318 case KINETIS_SDID_FAMILYID_K6X | KINETIS_SDID_SUBFAMID_KX1: /* errata 7534 - should be K63 */
1320 case KINETIS_SDID_FAMILYID_K6X | KINETIS_SDID_SUBFAMID_KX4:
1321 case KINETIS_SDID_FAMILYID_K6X | KINETIS_SDID_SUBFAMID_KX2: /* errata 7534 - should be K64 */
1322 /* K64FN1M0, K64FX512 */
1323 pflash_sector_size_bytes = 4<<10;
1324 nvm_sector_size_bytes = 4<<10;
1325 kinfo->max_flash_prog_size = 1<<10;
1327 kinfo->flash_support = FS_PROGRAM_PHRASE | FS_PROGRAM_SECTOR;
1330 case KINETIS_SDID_FAMILYID_K2X | KINETIS_SDID_SUBFAMID_KX6:
1332 case KINETIS_SDID_FAMILYID_K6X | KINETIS_SDID_SUBFAMID_KX6:
1333 /* K66FN2M0, K66FX1M0 */
1334 pflash_sector_size_bytes = 4<<10;
1335 nvm_sector_size_bytes = 4<<10;
1336 kinfo->max_flash_prog_size = 1<<10;
1338 kinfo->flash_support = FS_PROGRAM_PHRASE | FS_PROGRAM_SECTOR;
1341 LOG_ERROR("Unsupported Kinetis FAMILYID SUBFAMID");
1344 case KINETIS_SDID_SERIESID_KL:
1346 pflash_sector_size_bytes = 1<<10;
1347 nvm_sector_size_bytes = 1<<10;
1349 kinfo->flash_support = FS_PROGRAM_LONGWORD;
1352 LOG_ERROR("Unsupported K-series");
1356 if (pflash_sector_size_bytes == 0) {
1357 LOG_ERROR("MCU is unsupported, SDID 0x%08" PRIx32, kinfo->sim_sdid);
1358 return ERROR_FLASH_OPER_UNSUPPORTED;
1361 result = target_read_u32(target, SIM_FCFG1, &kinfo->sim_fcfg1);
1362 if (result != ERROR_OK)
1365 result = target_read_u32(target, SIM_FCFG2, &kinfo->sim_fcfg2);
1366 if (result != ERROR_OK)
1369 LOG_DEBUG("SDID: 0x%08" PRIX32 " FCFG1: 0x%08" PRIX32 " FCFG2: 0x%08" PRIX32, kinfo->sim_sdid,
1370 kinfo->sim_fcfg1, kinfo->sim_fcfg2);
1372 fcfg1_nvmsize = (uint8_t)((kinfo->sim_fcfg1 >> 28) & 0x0f);
1373 fcfg1_pfsize = (uint8_t)((kinfo->sim_fcfg1 >> 24) & 0x0f);
1374 fcfg1_eesize = (uint8_t)((kinfo->sim_fcfg1 >> 16) & 0x0f);
1375 fcfg1_depart = (uint8_t)((kinfo->sim_fcfg1 >> 8) & 0x0f);
1377 fcfg2_pflsh = (uint8_t)((kinfo->sim_fcfg2 >> 23) & 0x01);
1379 /* when the PFLSH bit is set, there is no FlexNVM/FlexRAM */
1381 switch (fcfg1_nvmsize) {
1387 nvm_size = 1 << (14 + (fcfg1_nvmsize >> 1));
1390 if (pflash_sector_size_bytes >= 4<<10)
1401 switch (fcfg1_eesize) {
1412 ee_size = (16 << (10 - fcfg1_eesize));
1419 switch (fcfg1_depart) {
1426 df_size = nvm_size - (4096 << fcfg1_depart);
1436 df_size = 4096 << (fcfg1_depart & 0x7);
1444 switch (fcfg1_pfsize) {
1451 pf_size = 1 << (14 + (fcfg1_pfsize >> 1));
1454 if (pflash_sector_size_bytes >= 4<<10)
1456 else if (fcfg2_pflsh)
1466 LOG_DEBUG("FlexNVM: %" PRIu32 " PFlash: %" PRIu32 " FlexRAM: %" PRIu32 " PFLSH: %d",
1467 nvm_size, pf_size, ee_size, fcfg2_pflsh);
1469 num_pflash_blocks = num_blocks / (2 - fcfg2_pflsh);
1470 first_nvm_bank = num_pflash_blocks;
1471 num_nvm_blocks = num_blocks - num_pflash_blocks;
1473 LOG_DEBUG("%d blocks total: %d PFlash, %d FlexNVM",
1474 num_blocks, num_pflash_blocks, num_nvm_blocks);
1476 LOG_INFO("Probing flash info for bank %d", bank->bank_number);
1478 if ((unsigned)bank->bank_number < num_pflash_blocks) {
1479 /* pflash, banks start at address zero */
1480 kinfo->flash_class = FC_PFLASH;
1481 bank->size = (pf_size / num_pflash_blocks);
1482 bank->base = 0x00000000 + bank->size * bank->bank_number;
1483 kinfo->prog_base = bank->base;
1484 kinfo->sector_size = pflash_sector_size_bytes;
1485 kinfo->protection_size = pf_size / 32;
1486 kinfo->protection_block = (32 / num_pflash_blocks) * bank->bank_number;
1488 } else if ((unsigned)bank->bank_number < num_blocks) {
1489 /* nvm, banks start at address 0x10000000 */
1490 unsigned nvm_ord = bank->bank_number - first_nvm_bank;
1493 kinfo->flash_class = FC_FLEX_NVM;
1494 bank->size = (nvm_size / num_nvm_blocks);
1495 bank->base = 0x10000000 + bank->size * nvm_ord;
1496 kinfo->prog_base = 0x00800000 + bank->size * nvm_ord;
1497 kinfo->sector_size = nvm_sector_size_bytes;
1499 kinfo->protection_size = 0;
1501 for (i = df_size; ~i & 1; i >>= 1)
1504 kinfo->protection_size = df_size / 8; /* data flash size = 2^^n */
1506 kinfo->protection_size = nvm_size / 8; /* TODO: verify on SF1, not documented in RM */
1508 kinfo->protection_block = (8 / num_nvm_blocks) * nvm_ord;
1510 /* EEPROM backup part of FlexNVM is not accessible, use df_size as a limit */
1511 if (df_size > bank->size * nvm_ord)
1512 limit = df_size - bank->size * nvm_ord;
1516 if (bank->size > limit) {
1518 LOG_DEBUG("FlexNVM bank %d limited to 0x%08" PRIx32 " due to active EEPROM backup",
1519 bank->bank_number, limit);
1522 } else if ((unsigned)bank->bank_number == num_blocks) {
1523 LOG_ERROR("FlexRAM support not yet implemented");
1524 return ERROR_FLASH_OPER_UNSUPPORTED;
1526 LOG_ERROR("Cannot determine parameters for bank %d, only %d banks on device",
1527 bank->bank_number, num_blocks);
1528 return ERROR_FLASH_BANK_INVALID;
1531 if (bank->sectors) {
1532 free(bank->sectors);
1533 bank->sectors = NULL;
1536 if (kinfo->sector_size == 0) {
1537 LOG_ERROR("Unknown sector size for bank %d", bank->bank_number);
1538 return ERROR_FLASH_BANK_INVALID;
1541 if (kinfo->flash_support & FS_PROGRAM_SECTOR
1542 && kinfo->max_flash_prog_size == 0) {
1543 kinfo->max_flash_prog_size = kinfo->sector_size;
1544 /* Program section size is equal to sector size by default */
1547 bank->num_sectors = bank->size / kinfo->sector_size;
1549 if (bank->num_sectors > 0) {
1550 /* FlexNVM bank can be used for EEPROM backup therefore zero sized */
1551 bank->sectors = malloc(sizeof(struct flash_sector) * bank->num_sectors);
1553 for (i = 0; i < bank->num_sectors; i++) {
1554 bank->sectors[i].offset = offset;
1555 bank->sectors[i].size = kinfo->sector_size;
1556 offset += kinfo->sector_size;
1557 bank->sectors[i].is_erased = -1;
1558 bank->sectors[i].is_protected = 1;
1562 kinfo->probed = true;
1567 static int kinetis_probe(struct flash_bank *bank)
1569 if (bank->target->state != TARGET_HALTED) {
1570 LOG_WARNING("Cannot communicate... target not halted.");
1571 return ERROR_TARGET_NOT_HALTED;
1574 return kinetis_read_part_info(bank);
1577 static int kinetis_auto_probe(struct flash_bank *bank)
1579 struct kinetis_flash_bank *kinfo = bank->driver_priv;
1581 if (kinfo && kinfo->probed)
1584 return kinetis_probe(bank);
1587 static int kinetis_info(struct flash_bank *bank, char *buf, int buf_size)
1589 const char *bank_class_names[] = {
1590 "(ANY)", "PFlash", "FlexNVM", "FlexRAM"
1593 struct kinetis_flash_bank *kinfo = bank->driver_priv;
1595 (void) snprintf(buf, buf_size,
1596 "%s driver for %s flash bank %s at 0x%8.8" PRIx32 "",
1597 bank->driver->name, bank_class_names[kinfo->flash_class],
1598 bank->name, bank->base);
1603 static int kinetis_blank_check(struct flash_bank *bank)
1605 struct kinetis_flash_bank *kinfo = bank->driver_priv;
1607 if (bank->target->state != TARGET_HALTED) {
1608 LOG_ERROR("Target not halted");
1609 return ERROR_TARGET_NOT_HALTED;
1612 if (kinfo->flash_class == FC_PFLASH || kinfo->flash_class == FC_FLEX_NVM) {
1614 bool block_dirty = false;
1617 if (kinfo->flash_class == FC_FLEX_NVM) {
1618 uint8_t fcfg1_depart = (uint8_t)((kinfo->sim_fcfg1 >> 8) & 0x0f);
1619 /* block operation cannot be used on FlexNVM when EEPROM backup partition is set */
1620 if (fcfg1_depart != 0xf && fcfg1_depart != 0)
1625 /* check if whole bank is blank */
1626 result = kinetis_ftfx_command(bank->target, FTFx_CMD_BLOCKSTAT, kinfo->prog_base,
1627 0, 0, 0, 0, 0, 0, 0, 0, &ftfx_fstat);
1629 if (result != ERROR_OK || (ftfx_fstat & 0x01))
1634 /* the whole bank is not erased, check sector-by-sector */
1636 for (i = 0; i < bank->num_sectors; i++) {
1638 result = kinetis_ftfx_command(bank->target, FTFx_CMD_SECTSTAT,
1639 kinfo->prog_base + bank->sectors[i].offset,
1640 1, 0, 0, 0, 0, 0, 0, 0, &ftfx_fstat);
1642 if (result == ERROR_OK) {
1643 bank->sectors[i].is_erased = !(ftfx_fstat & 0x01);
1645 LOG_DEBUG("Ignoring errored PFlash sector blank-check");
1646 bank->sectors[i].is_erased = -1;
1650 /* the whole bank is erased, update all sectors */
1652 for (i = 0; i < bank->num_sectors; i++)
1653 bank->sectors[i].is_erased = 1;
1656 LOG_WARNING("kinetis_blank_check not supported yet for FlexRAM");
1657 return ERROR_FLASH_OPERATION_FAILED;
1663 static const struct command_registration kinetis_securtiy_command_handlers[] = {
1665 .name = "check_security",
1666 .mode = COMMAND_EXEC,
1669 .handler = kinetis_check_flash_security_status,
1672 .name = "mass_erase",
1673 .mode = COMMAND_EXEC,
1676 .handler = kinetis_mdm_mass_erase,
1678 COMMAND_REGISTRATION_DONE
1681 static const struct command_registration kinetis_exec_command_handlers[] = {
1684 .mode = COMMAND_ANY,
1687 .chain = kinetis_securtiy_command_handlers,
1690 .name = "disable_wdog",
1691 .mode = COMMAND_EXEC,
1692 .help = "Disable the watchdog timer",
1694 .handler = kinetis_disable_wdog_handler,
1696 COMMAND_REGISTRATION_DONE
1699 static const struct command_registration kinetis_command_handler[] = {
1702 .mode = COMMAND_ANY,
1703 .help = "kinetis flash controller commands",
1705 .chain = kinetis_exec_command_handlers,
1707 COMMAND_REGISTRATION_DONE
1712 struct flash_driver kinetis_flash = {
1714 .commands = kinetis_command_handler,
1715 .flash_bank_command = kinetis_flash_bank_command,
1716 .erase = kinetis_erase,
1717 .protect = kinetis_protect,
1718 .write = kinetis_write,
1719 .read = default_flash_read,
1720 .probe = kinetis_probe,
1721 .auto_probe = kinetis_auto_probe,
1722 .erase_check = kinetis_blank_check,
1723 .protect_check = kinetis_protect_check,
1724 .info = kinetis_info,