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 * Copyright (C) 2015 Tomas Vanek *
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 ***************************************************************************/
35 #include "jtag/interface.h"
37 #include <helper/binarybuffer.h>
38 #include <helper/time_support.h>
39 #include <target/target_type.h>
40 #include <target/algorithm.h>
41 #include <target/armv7m.h>
42 #include <target/cortex_m.h>
45 * Implementation Notes
47 * The persistent memories in the Kinetis chip families K10 through
48 * K70 are all manipulated with the Flash Memory Module. Some
49 * variants call this module the FTFE, others call it the FTFL. To
50 * indicate that both are considered here, we use FTFX.
52 * Within the module, according to the chip variant, the persistent
53 * memory is divided into what Freescale terms Program Flash, FlexNVM,
54 * and FlexRAM. All chip variants have Program Flash. Some chip
55 * variants also have FlexNVM and FlexRAM, which always appear
58 * A given Kinetis chip may have 1, 2 or 4 blocks of flash. Here we map
59 * each block to a separate bank. Each block size varies by chip and
60 * may be determined by the read-only SIM_FCFG1 register. The sector
61 * size within each bank/block varies by chip, and may be 1, 2 or 4k.
62 * The sector size may be different for flash and FlexNVM.
64 * The first half of the flash (1 or 2 blocks) is always Program Flash
65 * and always starts at address 0x00000000. The "PFLSH" flag, bit 23
66 * of the read-only SIM_FCFG2 register, determines whether the second
67 * half of the flash is also Program Flash or FlexNVM+FlexRAM. When
68 * PFLSH is set, the second from the first half. When PFLSH is clear,
69 * the second half of flash is FlexNVM and always starts at address
70 * 0x10000000. FlexRAM, which is also present when PFLSH is clear,
71 * always starts at address 0x14000000.
73 * The Flash Memory Module provides a register set where flash
74 * commands are loaded to perform flash operations like erase and
75 * program. Different commands are available depending on whether
76 * Program Flash or FlexNVM/FlexRAM is being manipulated. Although
77 * the commands used are quite consistent between flash blocks, the
78 * parameters they accept differ according to the flash sector size.
83 #define FCF_ADDRESS 0x00000400
87 #define FCF_FDPROT 0xf
90 #define FLEXRAM 0x14000000
92 #define MSCM_OCMDR0 0x40001400
93 #define FMC_PFB01CR 0x4001f004
94 #define FTFx_FSTAT 0x40020000
95 #define FTFx_FCNFG 0x40020001
96 #define FTFx_FCCOB3 0x40020004
97 #define FTFx_FPROT3 0x40020010
98 #define FTFx_FDPROT 0x40020017
99 #define SIM_SDID 0x40048024
100 #define SIM_SOPT1 0x40047000
101 #define SIM_FCFG1 0x4004804c
102 #define SIM_FCFG2 0x40048050
103 #define SIM_COPC 0x40048100
104 #define WDOG_BASE 0x40052000
105 #define WDOG32_KE1X 0x40052000
106 #define WDOG32_KL28 0x40076000
107 #define SMC_PMCTRL 0x4007E001
108 #define SMC_PMSTAT 0x4007E003
109 #define MCM_PLACR 0xF000300C
112 #define WDOG_STCTRLH_OFFSET 0
113 #define WDOG32_CS_OFFSET 0
116 #define PM_STAT_RUN 0x01
117 #define PM_STAT_VLPR 0x04
118 #define PM_CTRL_RUNM_RUN 0x00
121 #define FTFx_CMD_BLOCKSTAT 0x00
122 #define FTFx_CMD_SECTSTAT 0x01
123 #define FTFx_CMD_LWORDPROG 0x06
124 #define FTFx_CMD_SECTERASE 0x09
125 #define FTFx_CMD_SECTWRITE 0x0b
126 #define FTFx_CMD_MASSERASE 0x44
127 #define FTFx_CMD_PGMPART 0x80
128 #define FTFx_CMD_SETFLEXRAM 0x81
130 /* The older Kinetis K series uses the following SDID layout :
137 * The newer Kinetis series uses the following SDID layout :
139 * Bit 27-24 : SUBFAMID
140 * Bit 23-20 : SERIESID
141 * Bit 19-16 : SRAMSIZE
143 * Bit 6-4 : Reserved (0)
146 * We assume that if bits 31-16 are 0 then it's an older
150 #define KINETIS_SOPT1_RAMSIZE_MASK 0x0000F000
151 #define KINETIS_SOPT1_RAMSIZE_K24FN1M 0x0000B000
153 #define KINETIS_SDID_K_SERIES_MASK 0x0000FFFF
155 #define KINETIS_SDID_DIEID_MASK 0x00000F80
157 #define KINETIS_SDID_DIEID_K22FN128 0x00000680 /* smaller pflash with FTFA */
158 #define KINETIS_SDID_DIEID_K22FN256 0x00000A80
159 #define KINETIS_SDID_DIEID_K22FN512 0x00000E80
160 #define KINETIS_SDID_DIEID_K24FN256 0x00000700
162 #define KINETIS_SDID_DIEID_K24FN1M 0x00000300 /* Detect Errata 7534 */
164 /* We can't rely solely on the FAMID field to determine the MCU
165 * type since some FAMID values identify multiple MCUs with
166 * different flash sector sizes (K20 and K22 for instance).
167 * Therefore we combine it with the DIEID bits which may possibly
168 * break if Freescale bumps the DIEID for a particular MCU. */
169 #define KINETIS_K_SDID_TYPE_MASK 0x00000FF0
170 #define KINETIS_K_SDID_K10_M50 0x00000000
171 #define KINETIS_K_SDID_K10_M72 0x00000080
172 #define KINETIS_K_SDID_K10_M100 0x00000100
173 #define KINETIS_K_SDID_K10_M120 0x00000180
174 #define KINETIS_K_SDID_K11 0x00000220
175 #define KINETIS_K_SDID_K12 0x00000200
176 #define KINETIS_K_SDID_K20_M50 0x00000010
177 #define KINETIS_K_SDID_K20_M72 0x00000090
178 #define KINETIS_K_SDID_K20_M100 0x00000110
179 #define KINETIS_K_SDID_K20_M120 0x00000190
180 #define KINETIS_K_SDID_K21_M50 0x00000230
181 #define KINETIS_K_SDID_K21_M120 0x00000330
182 #define KINETIS_K_SDID_K22_M50 0x00000210
183 #define KINETIS_K_SDID_K22_M120 0x00000310
184 #define KINETIS_K_SDID_K30_M72 0x000000A0
185 #define KINETIS_K_SDID_K30_M100 0x00000120
186 #define KINETIS_K_SDID_K40_M72 0x000000B0
187 #define KINETIS_K_SDID_K40_M100 0x00000130
188 #define KINETIS_K_SDID_K50_M72 0x000000E0
189 #define KINETIS_K_SDID_K51_M72 0x000000F0
190 #define KINETIS_K_SDID_K53 0x00000170
191 #define KINETIS_K_SDID_K60_M100 0x00000140
192 #define KINETIS_K_SDID_K60_M150 0x000001C0
193 #define KINETIS_K_SDID_K70_M150 0x000001D0
195 #define KINETIS_SDID_SERIESID_MASK 0x00F00000
196 #define KINETIS_SDID_SERIESID_K 0x00000000
197 #define KINETIS_SDID_SERIESID_KL 0x00100000
198 #define KINETIS_SDID_SERIESID_KE 0x00200000
199 #define KINETIS_SDID_SERIESID_KW 0x00500000
200 #define KINETIS_SDID_SERIESID_KV 0x00600000
202 #define KINETIS_SDID_SUBFAMID_SHIFT 24
203 #define KINETIS_SDID_SUBFAMID_MASK 0x0F000000
204 #define KINETIS_SDID_SUBFAMID_KX0 0x00000000
205 #define KINETIS_SDID_SUBFAMID_KX1 0x01000000
206 #define KINETIS_SDID_SUBFAMID_KX2 0x02000000
207 #define KINETIS_SDID_SUBFAMID_KX3 0x03000000
208 #define KINETIS_SDID_SUBFAMID_KX4 0x04000000
209 #define KINETIS_SDID_SUBFAMID_KX5 0x05000000
210 #define KINETIS_SDID_SUBFAMID_KX6 0x06000000
211 #define KINETIS_SDID_SUBFAMID_KX7 0x07000000
212 #define KINETIS_SDID_SUBFAMID_KX8 0x08000000
214 #define KINETIS_SDID_FAMILYID_SHIFT 28
215 #define KINETIS_SDID_FAMILYID_MASK 0xF0000000
216 #define KINETIS_SDID_FAMILYID_K0X 0x00000000
217 #define KINETIS_SDID_FAMILYID_K1X 0x10000000
218 #define KINETIS_SDID_FAMILYID_K2X 0x20000000
219 #define KINETIS_SDID_FAMILYID_K3X 0x30000000
220 #define KINETIS_SDID_FAMILYID_K4X 0x40000000
221 #define KINETIS_SDID_FAMILYID_K5X 0x50000000
222 #define KINETIS_SDID_FAMILYID_K6X 0x60000000
223 #define KINETIS_SDID_FAMILYID_K7X 0x70000000
224 #define KINETIS_SDID_FAMILYID_K8X 0x80000000
225 #define KINETIS_SDID_FAMILYID_KL8X 0x90000000
227 /* The field originally named DIEID has new name/meaning on KE1x */
228 #define KINETIS_SDID_PROJECTID_MASK KINETIS_SDID_DIEID_MASK
229 #define KINETIS_SDID_PROJECTID_KE1xF 0x00000080
230 #define KINETIS_SDID_PROJECTID_KE1xZ 0x00000100
232 struct kinetis_flash_bank
{
233 struct kinetis_chip
*k_chip
;
235 unsigned bank_number
; /* bank number in particular chip */
236 struct flash_bank
*bank
;
238 uint32_t sector_size
;
239 uint32_t protection_size
;
240 uint32_t prog_base
; /* base address for FTFx operations */
241 /* usually same as bank->base for pflash, differs for FlexNVM */
242 uint32_t protection_block
; /* number of first protection block in this bank */
252 #define KINETIS_MAX_BANKS 4u
254 struct kinetis_chip
{
255 struct target
*target
;
261 uint32_t fcfg2_maxaddr0_shifted
;
262 uint32_t fcfg2_maxaddr1_shifted
;
264 unsigned num_pflash_blocks
, num_nvm_blocks
;
265 unsigned pflash_sector_size
, nvm_sector_size
;
266 unsigned max_flash_prog_size
;
268 uint32_t pflash_base
;
269 uint32_t pflash_size
;
271 uint32_t nvm_size
; /* whole FlexNVM */
272 uint32_t dflash_size
; /* accessible rest of FlexNVM if EEPROM backup uses part of FlexNVM */
274 uint32_t progr_accel_ram
;
277 FS_PROGRAM_SECTOR
= 1,
278 FS_PROGRAM_LONGWORD
= 2,
279 FS_PROGRAM_PHRASE
= 4, /* Unsupported */
281 FS_NO_CMD_BLOCKSTAT
= 0x40,
282 FS_WIDTH_256BIT
= 0x80,
287 KINETIS_CACHE_K
, /* invalidate using FMC->PFB0CR/PFB01CR */
288 KINETIS_CACHE_L
, /* invalidate using MCM->PLACR */
289 KINETIS_CACHE_MSCM
, /* devices like KE1xF, invalidate MSCM->OCMDR0 */
303 struct kinetis_flash_bank banks
[KINETIS_MAX_BANKS
];
306 struct kinetis_type
{
311 static const struct kinetis_type kinetis_types_old
[] = {
312 { KINETIS_K_SDID_K10_M50
, "MK10D%s5" },
313 { KINETIS_K_SDID_K10_M72
, "MK10D%s7" },
314 { KINETIS_K_SDID_K10_M100
, "MK10D%s10" },
315 { KINETIS_K_SDID_K10_M120
, "MK10F%s12" },
316 { KINETIS_K_SDID_K11
, "MK11D%s5" },
317 { KINETIS_K_SDID_K12
, "MK12D%s5" },
319 { KINETIS_K_SDID_K20_M50
, "MK20D%s5" },
320 { KINETIS_K_SDID_K20_M72
, "MK20D%s7" },
321 { KINETIS_K_SDID_K20_M100
, "MK20D%s10" },
322 { KINETIS_K_SDID_K20_M120
, "MK20F%s12" },
323 { KINETIS_K_SDID_K21_M50
, "MK21D%s5" },
324 { KINETIS_K_SDID_K21_M120
, "MK21F%s12" },
325 { KINETIS_K_SDID_K22_M50
, "MK22D%s5" },
326 { KINETIS_K_SDID_K22_M120
, "MK22F%s12" },
328 { KINETIS_K_SDID_K30_M72
, "MK30D%s7" },
329 { KINETIS_K_SDID_K30_M100
, "MK30D%s10" },
331 { KINETIS_K_SDID_K40_M72
, "MK40D%s7" },
332 { KINETIS_K_SDID_K40_M100
, "MK40D%s10" },
334 { KINETIS_K_SDID_K50_M72
, "MK50D%s7" },
335 { KINETIS_K_SDID_K51_M72
, "MK51D%s7" },
336 { KINETIS_K_SDID_K53
, "MK53D%s10" },
338 { KINETIS_K_SDID_K60_M100
, "MK60D%s10" },
339 { KINETIS_K_SDID_K60_M150
, "MK60F%s15" },
341 { KINETIS_K_SDID_K70_M150
, "MK70F%s15" },
347 #define MDM_REG_STAT 0x00
348 #define MDM_REG_CTRL 0x04
349 #define MDM_REG_ID 0xfc
351 #define MDM_STAT_FMEACK (1<<0)
352 #define MDM_STAT_FREADY (1<<1)
353 #define MDM_STAT_SYSSEC (1<<2)
354 #define MDM_STAT_SYSRES (1<<3)
355 #define MDM_STAT_FMEEN (1<<5)
356 #define MDM_STAT_BACKDOOREN (1<<6)
357 #define MDM_STAT_LPEN (1<<7)
358 #define MDM_STAT_VLPEN (1<<8)
359 #define MDM_STAT_LLSMODEXIT (1<<9)
360 #define MDM_STAT_VLLSXMODEXIT (1<<10)
361 #define MDM_STAT_CORE_HALTED (1<<16)
362 #define MDM_STAT_CORE_SLEEPDEEP (1<<17)
363 #define MDM_STAT_CORESLEEPING (1<<18)
365 #define MDM_CTRL_FMEIP (1<<0)
366 #define MDM_CTRL_DBG_DIS (1<<1)
367 #define MDM_CTRL_DBG_REQ (1<<2)
368 #define MDM_CTRL_SYS_RES_REQ (1<<3)
369 #define MDM_CTRL_CORE_HOLD_RES (1<<4)
370 #define MDM_CTRL_VLLSX_DBG_REQ (1<<5)
371 #define MDM_CTRL_VLLSX_DBG_ACK (1<<6)
372 #define MDM_CTRL_VLLSX_STAT_ACK (1<<7)
374 #define MDM_ACCESS_TIMEOUT 500 /* msec */
377 static bool allow_fcf_writes
;
378 static uint8_t fcf_fopt
= 0xff;
379 static bool create_banks
;
382 struct flash_driver kinetis_flash
;
383 static int kinetis_write_inner(struct flash_bank
*bank
, const uint8_t *buffer
,
384 uint32_t offset
, uint32_t count
);
385 static int kinetis_probe_chip(struct kinetis_chip
*k_chip
);
386 static int kinetis_auto_probe(struct flash_bank
*bank
);
389 static int kinetis_mdm_write_register(struct adiv5_dap
*dap
, unsigned reg
, uint32_t value
)
392 LOG_DEBUG("MDM_REG[0x%02x] <- %08" PRIX32
, reg
, value
);
394 retval
= dap_queue_ap_write(dap_ap(dap
, MDM_AP
), reg
, value
);
395 if (retval
!= ERROR_OK
) {
396 LOG_DEBUG("MDM: failed to queue a write request");
400 retval
= dap_run(dap
);
401 if (retval
!= ERROR_OK
) {
402 LOG_DEBUG("MDM: dap_run failed");
410 static int kinetis_mdm_read_register(struct adiv5_dap
*dap
, unsigned reg
, uint32_t *result
)
414 retval
= dap_queue_ap_read(dap_ap(dap
, MDM_AP
), reg
, result
);
415 if (retval
!= ERROR_OK
) {
416 LOG_DEBUG("MDM: failed to queue a read request");
420 retval
= dap_run(dap
);
421 if (retval
!= ERROR_OK
) {
422 LOG_DEBUG("MDM: dap_run failed");
426 LOG_DEBUG("MDM_REG[0x%02x]: %08" PRIX32
, reg
, *result
);
430 static int kinetis_mdm_poll_register(struct adiv5_dap
*dap
, unsigned reg
,
431 uint32_t mask
, uint32_t value
, uint32_t timeout_ms
)
435 int64_t ms_timeout
= timeval_ms() + timeout_ms
;
438 retval
= kinetis_mdm_read_register(dap
, reg
, &val
);
439 if (retval
!= ERROR_OK
|| (val
& mask
) == value
)
443 } while (timeval_ms() < ms_timeout
);
445 LOG_DEBUG("MDM: polling timed out");
450 * This command can be used to break a watchdog reset loop when
451 * connecting to an unsecured target. Unlike other commands, halt will
452 * automatically retry as it does not know how far into the boot process
453 * it is when the command is called.
455 COMMAND_HANDLER(kinetis_mdm_halt
)
457 struct target
*target
= get_current_target(CMD_CTX
);
458 struct cortex_m_common
*cortex_m
= target_to_cm(target
);
459 struct adiv5_dap
*dap
= cortex_m
->armv7m
.arm
.dap
;
463 int64_t ms_timeout
= timeval_ms() + MDM_ACCESS_TIMEOUT
;
466 LOG_ERROR("Cannot perform halt with a high-level adapter");
473 kinetis_mdm_write_register(dap
, MDM_REG_CTRL
, MDM_CTRL_CORE_HOLD_RES
);
477 retval
= kinetis_mdm_read_register(dap
, MDM_REG_STAT
, &stat
);
478 if (retval
!= ERROR_OK
) {
479 LOG_DEBUG("MDM: failed to read MDM_REG_STAT");
483 /* Repeat setting MDM_CTRL_CORE_HOLD_RES until system is out of
484 * reset with flash ready and without security
486 if ((stat
& (MDM_STAT_FREADY
| MDM_STAT_SYSSEC
| MDM_STAT_SYSRES
))
487 == (MDM_STAT_FREADY
| MDM_STAT_SYSRES
))
490 if (timeval_ms() >= ms_timeout
) {
491 LOG_ERROR("MDM: halt timed out");
496 LOG_DEBUG("MDM: halt succeded after %d attempts.", tries
);
499 /* enable polling in case kinetis_check_flash_security_status disabled it */
500 jtag_poll_set_enabled(true);
504 target
->reset_halt
= true;
505 target
->type
->assert_reset(target
);
507 retval
= kinetis_mdm_write_register(dap
, MDM_REG_CTRL
, 0);
508 if (retval
!= ERROR_OK
) {
509 LOG_ERROR("MDM: failed to clear MDM_REG_CTRL");
513 target
->type
->deassert_reset(target
);
518 COMMAND_HANDLER(kinetis_mdm_reset
)
520 struct target
*target
= get_current_target(CMD_CTX
);
521 struct cortex_m_common
*cortex_m
= target_to_cm(target
);
522 struct adiv5_dap
*dap
= cortex_m
->armv7m
.arm
.dap
;
526 LOG_ERROR("Cannot perform reset with a high-level adapter");
530 retval
= kinetis_mdm_write_register(dap
, MDM_REG_CTRL
, MDM_CTRL_SYS_RES_REQ
);
531 if (retval
!= ERROR_OK
) {
532 LOG_ERROR("MDM: failed to write MDM_REG_CTRL");
536 retval
= kinetis_mdm_poll_register(dap
, MDM_REG_STAT
, MDM_STAT_SYSRES
, 0, 500);
537 if (retval
!= ERROR_OK
) {
538 LOG_ERROR("MDM: failed to assert reset");
542 retval
= kinetis_mdm_write_register(dap
, MDM_REG_CTRL
, 0);
543 if (retval
!= ERROR_OK
) {
544 LOG_ERROR("MDM: failed to clear MDM_REG_CTRL");
552 * This function implements the procedure to mass erase the flash via
553 * SWD/JTAG on Kinetis K and L series of devices as it is described in
554 * AN4835 "Production Flash Programming Best Practices for Kinetis K-
555 * and L-series MCUs" Section 4.2.1. To prevent a watchdog reset loop,
556 * the core remains halted after this function completes as suggested
557 * by the application note.
559 COMMAND_HANDLER(kinetis_mdm_mass_erase
)
561 struct target
*target
= get_current_target(CMD_CTX
);
562 struct cortex_m_common
*cortex_m
= target_to_cm(target
);
563 struct adiv5_dap
*dap
= cortex_m
->armv7m
.arm
.dap
;
566 LOG_ERROR("Cannot perform mass erase with a high-level adapter");
573 * ... Power on the processor, or if power has already been
574 * applied, assert the RESET pin to reset the processor. For
575 * devices that do not have a RESET pin, write the System
576 * Reset Request bit in the MDM-AP control register after
577 * establishing communication...
580 /* assert SRST if configured */
581 bool has_srst
= jtag_get_reset_config() & RESET_HAS_SRST
;
583 adapter_assert_reset();
585 retval
= kinetis_mdm_write_register(dap
, MDM_REG_CTRL
, MDM_CTRL_SYS_RES_REQ
);
586 if (retval
!= ERROR_OK
&& !has_srst
) {
587 LOG_ERROR("MDM: failed to assert reset");
588 goto deassert_reset_and_exit
;
592 * ... Read the MDM-AP status register repeatedly and wait for
593 * stable conditions suitable for mass erase:
594 * - mass erase is enabled
596 * - reset is finished
598 * Mass erase is started as soon as all conditions are met in 32
599 * subsequent status reads.
601 * In case of not stable conditions (RESET/WDOG loop in secured device)
602 * the user is asked for manual pressing of RESET button
605 int cnt_mass_erase_disabled
= 0;
607 int64_t ms_start
= timeval_ms();
608 bool man_reset_requested
= false;
612 int64_t ms_elapsed
= timeval_ms() - ms_start
;
614 if (!man_reset_requested
&& ms_elapsed
> 100) {
615 LOG_INFO("MDM: Press RESET button now if possible.");
616 man_reset_requested
= true;
619 if (ms_elapsed
> 3000) {
620 LOG_ERROR("MDM: waiting for mass erase conditions timed out.");
621 LOG_INFO("Mass erase of a secured MCU is not possible without hardware reset.");
622 LOG_INFO("Connect SRST, use 'reset_config srst_only' and retry.");
623 goto deassert_reset_and_exit
;
625 retval
= kinetis_mdm_read_register(dap
, MDM_REG_STAT
, &stat
);
626 if (retval
!= ERROR_OK
) {
631 if (!(stat
& MDM_STAT_FMEEN
)) {
633 cnt_mass_erase_disabled
++;
634 if (cnt_mass_erase_disabled
> 10) {
635 LOG_ERROR("MDM: mass erase is disabled");
636 goto deassert_reset_and_exit
;
641 if ((stat
& (MDM_STAT_FREADY
| MDM_STAT_SYSRES
)) == MDM_STAT_FREADY
)
646 } while (cnt_ready
< 32);
649 * ... Write the MDM-AP control register to set the Flash Mass
650 * Erase in Progress bit. This will start the mass erase
653 retval
= kinetis_mdm_write_register(dap
, MDM_REG_CTRL
, MDM_CTRL_SYS_RES_REQ
| MDM_CTRL_FMEIP
);
654 if (retval
!= ERROR_OK
) {
655 LOG_ERROR("MDM: failed to start mass erase");
656 goto deassert_reset_and_exit
;
660 * ... Read the MDM-AP control register until the Flash Mass
661 * Erase in Progress bit clears...
662 * Data sheed defines erase time <3.6 sec/512kB flash block.
663 * The biggest device has 4 pflash blocks => timeout 16 sec.
665 retval
= kinetis_mdm_poll_register(dap
, MDM_REG_CTRL
, MDM_CTRL_FMEIP
, 0, 16000);
666 if (retval
!= ERROR_OK
) {
667 LOG_ERROR("MDM: mass erase timeout");
668 goto deassert_reset_and_exit
;
672 /* enable polling in case kinetis_check_flash_security_status disabled it */
673 jtag_poll_set_enabled(true);
677 target
->reset_halt
= true;
678 target
->type
->assert_reset(target
);
681 * ... Negate the RESET signal or clear the System Reset Request
682 * bit in the MDM-AP control register.
684 retval
= kinetis_mdm_write_register(dap
, MDM_REG_CTRL
, 0);
685 if (retval
!= ERROR_OK
)
686 LOG_ERROR("MDM: failed to clear MDM_REG_CTRL");
688 target
->type
->deassert_reset(target
);
692 deassert_reset_and_exit
:
693 kinetis_mdm_write_register(dap
, MDM_REG_CTRL
, 0);
695 adapter_deassert_reset();
699 static const uint32_t kinetis_known_mdm_ids
[] = {
700 0x001C0000, /* Kinetis-K Series */
701 0x001C0020, /* Kinetis-L/M/V/E Series */
702 0x001C0030, /* Kinetis with a Cortex-M7, in time of writing KV58 */
706 * This function implements the procedure to connect to
707 * SWD/JTAG on Kinetis K and L series of devices as it is described in
708 * AN4835 "Production Flash Programming Best Practices for Kinetis K-
709 * and L-series MCUs" Section 4.1.1
711 COMMAND_HANDLER(kinetis_check_flash_security_status
)
713 struct target
*target
= get_current_target(CMD_CTX
);
714 struct cortex_m_common
*cortex_m
= target_to_cm(target
);
715 struct adiv5_dap
*dap
= cortex_m
->armv7m
.arm
.dap
;
718 LOG_WARNING("Cannot check flash security status with a high-level adapter");
723 return ERROR_OK
; /* too early to check, in JTAG mode ops may not be initialised */
729 * ... The MDM-AP ID register can be read to verify that the
730 * connection is working correctly...
732 retval
= kinetis_mdm_read_register(dap
, MDM_REG_ID
, &val
);
733 if (retval
!= ERROR_OK
) {
734 LOG_ERROR("MDM: failed to read ID register");
739 return ERROR_OK
; /* dap not yet initialised */
742 for (size_t i
= 0; i
< ARRAY_SIZE(kinetis_known_mdm_ids
); i
++) {
743 if (val
== kinetis_known_mdm_ids
[i
]) {
750 LOG_WARNING("MDM: unknown ID %08" PRIX32
, val
);
753 * ... Read the System Security bit to determine if security is enabled.
754 * If System Security = 0, then proceed. If System Security = 1, then
755 * communication with the internals of the processor, including the
756 * flash, will not be possible without issuing a mass erase command or
757 * unsecuring the part through other means (backdoor key unlock)...
759 retval
= kinetis_mdm_read_register(dap
, MDM_REG_STAT
, &val
);
760 if (retval
!= ERROR_OK
) {
761 LOG_ERROR("MDM: failed to read MDM_REG_STAT");
766 * System Security bit is also active for short time during reset.
767 * If a MCU has blank flash and runs in RESET/WDOG loop,
768 * System Security bit is active most of time!
769 * We should observe Flash Ready bit and read status several times
770 * to avoid false detection of secured MCU
772 int secured_score
= 0, flash_not_ready_score
= 0;
774 if ((val
& (MDM_STAT_SYSSEC
| MDM_STAT_FREADY
)) != MDM_STAT_FREADY
) {
778 for (i
= 0; i
< 32; i
++) {
779 stats
[i
] = MDM_STAT_FREADY
;
780 dap_queue_ap_read(dap_ap(dap
, MDM_AP
), MDM_REG_STAT
, &stats
[i
]);
782 retval
= dap_run(dap
);
783 if (retval
!= ERROR_OK
) {
784 LOG_DEBUG("MDM: dap_run failed when validating secured state");
787 for (i
= 0; i
< 32; i
++) {
788 if (stats
[i
] & MDM_STAT_SYSSEC
)
790 if (!(stats
[i
] & MDM_STAT_FREADY
))
791 flash_not_ready_score
++;
795 if (flash_not_ready_score
<= 8 && secured_score
> 24) {
796 jtag_poll_set_enabled(false);
798 LOG_WARNING("*********** ATTENTION! ATTENTION! ATTENTION! ATTENTION! **********");
799 LOG_WARNING("**** ****");
800 LOG_WARNING("**** Your Kinetis MCU is in secured state, which means that, ****");
801 LOG_WARNING("**** with exception for very basic communication, JTAG/SWD ****");
802 LOG_WARNING("**** interface will NOT work. In order to restore its ****");
803 LOG_WARNING("**** functionality please issue 'kinetis mdm mass_erase' ****");
804 LOG_WARNING("**** command, power cycle the MCU and restart OpenOCD. ****");
805 LOG_WARNING("**** ****");
806 LOG_WARNING("*********** ATTENTION! ATTENTION! ATTENTION! ATTENTION! **********");
808 } else if (flash_not_ready_score
> 24) {
809 jtag_poll_set_enabled(false);
810 LOG_WARNING("**** Your Kinetis MCU is probably locked-up in RESET/WDOG loop. ****");
811 LOG_WARNING("**** Common reason is a blank flash (at least a reset vector). ****");
812 LOG_WARNING("**** Issue 'kinetis mdm halt' command or if SRST is connected ****");
813 LOG_WARNING("**** and configured, use 'reset halt' ****");
814 LOG_WARNING("**** If MCU cannot be halted, it is likely secured and running ****");
815 LOG_WARNING("**** in RESET/WDOG loop. Issue 'kinetis mdm mass_erase' ****");
818 LOG_INFO("MDM: Chip is unsecured. Continuing.");
819 jtag_poll_set_enabled(true);
826 static struct kinetis_chip
*kinetis_get_chip(struct target
*target
)
828 struct flash_bank
*bank_iter
;
829 struct kinetis_flash_bank
*k_bank
;
831 /* iterate over all kinetis banks */
832 for (bank_iter
= flash_bank_list(); bank_iter
; bank_iter
= bank_iter
->next
) {
833 if (bank_iter
->driver
!= &kinetis_flash
834 || bank_iter
->target
!= target
)
837 k_bank
= bank_iter
->driver_priv
;
842 return k_bank
->k_chip
;
847 FLASH_BANK_COMMAND_HANDLER(kinetis_flash_bank_command
)
849 struct target
*target
= bank
->target
;
850 struct kinetis_chip
*k_chip
;
851 struct kinetis_flash_bank
*k_bank
;
854 return ERROR_COMMAND_SYNTAX_ERROR
;
856 LOG_INFO("add flash_bank kinetis %s", bank
->name
);
858 k_chip
= kinetis_get_chip(target
);
860 if (k_chip
== NULL
) {
861 k_chip
= calloc(sizeof(struct kinetis_chip
), 1);
862 if (k_chip
== NULL
) {
863 LOG_ERROR("No memory");
867 k_chip
->target
= target
;
870 if (k_chip
->num_banks
>= KINETIS_MAX_BANKS
) {
871 LOG_ERROR("Only %u Kinetis flash banks are supported", KINETIS_MAX_BANKS
);
875 bank
->driver_priv
= k_bank
= &(k_chip
->banks
[k_chip
->num_banks
]);
876 k_bank
->k_chip
= k_chip
;
877 k_bank
->bank_number
= k_chip
->num_banks
;
885 static int kinetis_create_missing_banks(struct kinetis_chip
*k_chip
)
889 struct kinetis_flash_bank
*k_bank
;
890 struct flash_bank
*bank
;
891 char base_name
[80], name
[80], num
[4];
894 num_blocks
= k_chip
->num_pflash_blocks
+ k_chip
->num_nvm_blocks
;
895 if (num_blocks
> KINETIS_MAX_BANKS
) {
896 LOG_ERROR("Only %u Kinetis flash banks are supported", KINETIS_MAX_BANKS
);
900 bank
= k_chip
->banks
[0].bank
;
901 if (bank
&& bank
->name
) {
902 strncpy(base_name
, bank
->name
, sizeof(base_name
));
903 p
= strstr(base_name
, ".pflash");
906 if (k_chip
->num_pflash_blocks
> 1) {
907 /* rename first bank if numbering is needed */
908 snprintf(name
, sizeof(name
), "%s.pflash0", base_name
);
909 free((void *)bank
->name
);
910 bank
->name
= strdup(name
);
914 strncpy(base_name
, target_name(k_chip
->target
), sizeof(base_name
));
915 p
= strstr(base_name
, ".cpu");
920 for (bank_idx
= 1; bank_idx
< num_blocks
; bank_idx
++) {
921 k_bank
= &(k_chip
->banks
[bank_idx
]);
929 if (bank_idx
< k_chip
->num_pflash_blocks
) {
931 if (k_chip
->num_pflash_blocks
> 1)
932 snprintf(num
, sizeof(num
), "%u", bank_idx
);
935 if (k_chip
->num_nvm_blocks
> 1)
936 snprintf(num
, sizeof(num
), "%u",
937 bank_idx
- k_chip
->num_pflash_blocks
);
940 bank
= calloc(sizeof(struct flash_bank
), 1);
944 bank
->target
= k_chip
->target
;
945 bank
->driver
= &kinetis_flash
;
946 bank
->default_padded_value
= bank
->erased_value
= 0xff;
948 snprintf(name
, sizeof(name
), "%s.%s%s",
949 base_name
, class, num
);
950 bank
->name
= strdup(name
);
952 bank
->driver_priv
= k_bank
= &(k_chip
->banks
[k_chip
->num_banks
]);
953 k_bank
->k_chip
= k_chip
;
954 k_bank
->bank_number
= bank_idx
;
956 if (k_chip
->num_banks
<= bank_idx
)
957 k_chip
->num_banks
= bank_idx
+ 1;
959 flash_bank_add(bank
);
965 static int kinetis_disable_wdog_algo(struct target
*target
, size_t code_size
, const uint8_t *code
, uint32_t wdog_base
)
967 struct working_area
*wdog_algorithm
;
968 struct armv7m_algorithm armv7m_info
;
969 struct reg_param reg_params
[1];
972 if (target
->state
!= TARGET_HALTED
) {
973 LOG_ERROR("Target not halted");
974 return ERROR_TARGET_NOT_HALTED
;
977 retval
= target_alloc_working_area(target
, code_size
, &wdog_algorithm
);
978 if (retval
!= ERROR_OK
)
981 retval
= target_write_buffer(target
, wdog_algorithm
->address
,
983 if (retval
== ERROR_OK
) {
984 armv7m_info
.common_magic
= ARMV7M_COMMON_MAGIC
;
985 armv7m_info
.core_mode
= ARM_MODE_THREAD
;
987 init_reg_param(®_params
[0], "r0", 32, PARAM_IN
);
988 buf_set_u32(reg_params
[0].value
, 0, 32, wdog_base
);
990 retval
= target_run_algorithm(target
, 0, NULL
, 1, reg_params
,
991 wdog_algorithm
->address
,
992 wdog_algorithm
->address
+ code_size
- 2,
995 destroy_reg_param(®_params
[0]);
997 if (retval
!= ERROR_OK
)
998 LOG_ERROR("Error executing Kinetis WDOG unlock algorithm");
1001 target_free_working_area(target
, wdog_algorithm
);
1006 /* Disable the watchdog on Kinetis devices
1007 * Standard Kx WDOG peripheral checks timing and therefore requires to run algo.
1009 static int kinetis_disable_wdog_kx(struct target
*target
)
1011 const uint32_t wdog_base
= WDOG_BASE
;
1015 static const uint8_t kinetis_unlock_wdog_code
[] = {
1016 #include "../../../contrib/loaders/watchdog/armv7m_kinetis_wdog.inc"
1019 retval
= target_read_u16(target
, wdog_base
+ WDOG_STCTRLH_OFFSET
, &wdog
);
1020 if (retval
!= ERROR_OK
)
1023 if ((wdog
& 0x1) == 0) {
1024 /* watchdog already disabled */
1027 LOG_INFO("Disabling Kinetis watchdog (initial WDOG_STCTRLH = 0x%04" PRIx16
")", wdog
);
1029 retval
= kinetis_disable_wdog_algo(target
, sizeof(kinetis_unlock_wdog_code
), kinetis_unlock_wdog_code
, wdog_base
);
1030 if (retval
!= ERROR_OK
)
1033 retval
= target_read_u16(target
, wdog_base
+ WDOG_STCTRLH_OFFSET
, &wdog
);
1034 if (retval
!= ERROR_OK
)
1037 LOG_INFO("WDOG_STCTRLH = 0x%04" PRIx16
, wdog
);
1038 return (wdog
& 0x1) ? ERROR_FAIL
: ERROR_OK
;
1041 static int kinetis_disable_wdog32(struct target
*target
, uint32_t wdog_base
)
1046 static const uint8_t kinetis_unlock_wdog_code
[] = {
1047 #include "../../../contrib/loaders/watchdog/armv7m_kinetis_wdog32.inc"
1050 retval
= target_read_u32(target
, wdog_base
+ WDOG32_CS_OFFSET
, &wdog_cs
);
1051 if (retval
!= ERROR_OK
)
1054 if ((wdog_cs
& 0x80) == 0)
1055 return ERROR_OK
; /* watchdog already disabled */
1057 LOG_INFO("Disabling Kinetis watchdog (initial WDOG_CS 0x%08" PRIx32
")", wdog_cs
);
1059 retval
= kinetis_disable_wdog_algo(target
, sizeof(kinetis_unlock_wdog_code
), kinetis_unlock_wdog_code
, wdog_base
);
1060 if (retval
!= ERROR_OK
)
1063 retval
= target_read_u32(target
, wdog_base
+ WDOG32_CS_OFFSET
, &wdog_cs
);
1064 if (retval
!= ERROR_OK
)
1067 if ((wdog_cs
& 0x80) == 0)
1068 return ERROR_OK
; /* watchdog disabled successfully */
1070 LOG_ERROR("Cannot disable Kinetis watchdog (WDOG_CS 0x%08" PRIx32
"), issue 'reset init'", wdog_cs
);
1074 static int kinetis_disable_wdog(struct kinetis_chip
*k_chip
)
1076 struct target
*target
= k_chip
->target
;
1080 if (!k_chip
->probed
) {
1081 retval
= kinetis_probe_chip(k_chip
);
1082 if (retval
!= ERROR_OK
)
1086 switch (k_chip
->watchdog_type
) {
1087 case KINETIS_WDOG_K
:
1088 return kinetis_disable_wdog_kx(target
);
1090 case KINETIS_WDOG_COP
:
1091 retval
= target_read_u8(target
, SIM_COPC
, &sim_copc
);
1092 if (retval
!= ERROR_OK
)
1095 if ((sim_copc
& 0xc) == 0)
1096 return ERROR_OK
; /* watchdog already disabled */
1098 LOG_INFO("Disabling Kinetis watchdog (initial SIM_COPC 0x%02" PRIx8
")", sim_copc
);
1099 retval
= target_write_u8(target
, SIM_COPC
, sim_copc
& ~0xc);
1100 if (retval
!= ERROR_OK
)
1103 retval
= target_read_u8(target
, SIM_COPC
, &sim_copc
);
1104 if (retval
!= ERROR_OK
)
1107 if ((sim_copc
& 0xc) == 0)
1108 return ERROR_OK
; /* watchdog disabled successfully */
1110 LOG_ERROR("Cannot disable Kinetis watchdog (SIM_COPC 0x%02" PRIx8
"), issue 'reset init'", sim_copc
);
1113 case KINETIS_WDOG32_KE1X
:
1114 return kinetis_disable_wdog32(target
, WDOG32_KE1X
);
1116 case KINETIS_WDOG32_KL28
:
1117 return kinetis_disable_wdog32(target
, WDOG32_KL28
);
1124 COMMAND_HANDLER(kinetis_disable_wdog_handler
)
1127 struct target
*target
= get_current_target(CMD_CTX
);
1128 struct kinetis_chip
*k_chip
= kinetis_get_chip(target
);
1134 return ERROR_COMMAND_SYNTAX_ERROR
;
1136 result
= kinetis_disable_wdog(k_chip
);
1141 static int kinetis_ftfx_decode_error(uint8_t fstat
)
1144 LOG_ERROR("Flash operation failed, illegal command");
1145 return ERROR_FLASH_OPER_UNSUPPORTED
;
1147 } else if (fstat
& 0x10)
1148 LOG_ERROR("Flash operation failed, protection violated");
1150 else if (fstat
& 0x40)
1151 LOG_ERROR("Flash operation failed, read collision");
1153 else if (fstat
& 0x80)
1157 LOG_ERROR("Flash operation timed out");
1159 return ERROR_FLASH_OPERATION_FAILED
;
1162 static int kinetis_ftfx_clear_error(struct target
*target
)
1164 /* reset error flags */
1165 return target_write_u8(target
, FTFx_FSTAT
, 0x70);
1169 static int kinetis_ftfx_prepare(struct target
*target
)
1174 /* wait until busy */
1175 for (i
= 0; i
< 50; i
++) {
1176 result
= target_read_u8(target
, FTFx_FSTAT
, &fstat
);
1177 if (result
!= ERROR_OK
)
1184 if ((fstat
& 0x80) == 0) {
1185 LOG_ERROR("Flash controller is busy");
1186 return ERROR_FLASH_OPERATION_FAILED
;
1188 if (fstat
!= 0x80) {
1189 /* reset error flags */
1190 result
= kinetis_ftfx_clear_error(target
);
1195 /* Kinetis Program-LongWord Microcodes */
1196 static const uint8_t kinetis_flash_write_code
[] = {
1197 #include "../../../contrib/loaders/flash/kinetis/kinetis_flash.inc"
1200 /* Program LongWord Block Write */
1201 static int kinetis_write_block(struct flash_bank
*bank
, const uint8_t *buffer
,
1202 uint32_t offset
, uint32_t wcount
)
1204 struct target
*target
= bank
->target
;
1205 uint32_t buffer_size
= 2048; /* Default minimum value */
1206 struct working_area
*write_algorithm
;
1207 struct working_area
*source
;
1208 struct kinetis_flash_bank
*k_bank
= bank
->driver_priv
;
1209 uint32_t address
= k_bank
->prog_base
+ offset
;
1210 uint32_t end_address
;
1211 struct reg_param reg_params
[5];
1212 struct armv7m_algorithm armv7m_info
;
1216 /* Increase buffer_size if needed */
1217 if (buffer_size
< (target
->working_area_size
/2))
1218 buffer_size
= (target
->working_area_size
/2);
1220 /* allocate working area with flash programming code */
1221 if (target_alloc_working_area(target
, sizeof(kinetis_flash_write_code
),
1222 &write_algorithm
) != ERROR_OK
) {
1223 LOG_WARNING("no working area available, can't do block memory writes");
1224 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
1227 retval
= target_write_buffer(target
, write_algorithm
->address
,
1228 sizeof(kinetis_flash_write_code
), kinetis_flash_write_code
);
1229 if (retval
!= ERROR_OK
)
1233 while (target_alloc_working_area(target
, buffer_size
, &source
) != ERROR_OK
) {
1235 if (buffer_size
<= 256) {
1236 /* free working area, write algorithm already allocated */
1237 target_free_working_area(target
, write_algorithm
);
1239 LOG_WARNING("No large enough working area available, can't do block memory writes");
1240 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
1244 armv7m_info
.common_magic
= ARMV7M_COMMON_MAGIC
;
1245 armv7m_info
.core_mode
= ARM_MODE_THREAD
;
1247 init_reg_param(®_params
[0], "r0", 32, PARAM_IN_OUT
); /* address */
1248 init_reg_param(®_params
[1], "r1", 32, PARAM_OUT
); /* word count */
1249 init_reg_param(®_params
[2], "r2", 32, PARAM_OUT
);
1250 init_reg_param(®_params
[3], "r3", 32, PARAM_OUT
);
1251 init_reg_param(®_params
[4], "r4", 32, PARAM_OUT
);
1253 buf_set_u32(reg_params
[0].value
, 0, 32, address
);
1254 buf_set_u32(reg_params
[1].value
, 0, 32, wcount
);
1255 buf_set_u32(reg_params
[2].value
, 0, 32, source
->address
);
1256 buf_set_u32(reg_params
[3].value
, 0, 32, source
->address
+ source
->size
);
1257 buf_set_u32(reg_params
[4].value
, 0, 32, FTFx_FSTAT
);
1259 retval
= target_run_flash_async_algorithm(target
, buffer
, wcount
, 4,
1262 source
->address
, source
->size
,
1263 write_algorithm
->address
, 0,
1266 if (retval
== ERROR_FLASH_OPERATION_FAILED
) {
1267 end_address
= buf_get_u32(reg_params
[0].value
, 0, 32);
1269 LOG_ERROR("Error writing flash at %08" PRIx32
, end_address
);
1271 retval
= target_read_u8(target
, FTFx_FSTAT
, &fstat
);
1272 if (retval
== ERROR_OK
) {
1273 retval
= kinetis_ftfx_decode_error(fstat
);
1275 /* reset error flags */
1276 target_write_u8(target
, FTFx_FSTAT
, 0x70);
1278 } else if (retval
!= ERROR_OK
)
1279 LOG_ERROR("Error executing kinetis Flash programming algorithm");
1281 target_free_working_area(target
, source
);
1282 target_free_working_area(target
, write_algorithm
);
1284 destroy_reg_param(®_params
[0]);
1285 destroy_reg_param(®_params
[1]);
1286 destroy_reg_param(®_params
[2]);
1287 destroy_reg_param(®_params
[3]);
1288 destroy_reg_param(®_params
[4]);
1293 static int kinetis_protect(struct flash_bank
*bank
, int set
, int first
, int last
)
1297 if (allow_fcf_writes
) {
1298 LOG_ERROR("Protection setting is possible with 'kinetis fcf_source protection' only!");
1302 if (!bank
->prot_blocks
|| bank
->num_prot_blocks
== 0) {
1303 LOG_ERROR("No protection possible for current bank!");
1304 return ERROR_FLASH_BANK_INVALID
;
1307 for (i
= first
; i
< bank
->num_prot_blocks
&& i
<= last
; i
++)
1308 bank
->prot_blocks
[i
].is_protected
= set
;
1310 LOG_INFO("Protection bits will be written at the next FCF sector erase or write.");
1311 LOG_INFO("Do not issue 'flash info' command until protection is written,");
1312 LOG_INFO("doing so would re-read protection status from MCU.");
1317 static int kinetis_protect_check(struct flash_bank
*bank
)
1319 struct kinetis_flash_bank
*k_bank
= bank
->driver_priv
;
1324 if (k_bank
->flash_class
== FC_PFLASH
) {
1326 /* read protection register */
1327 result
= target_read_u32(bank
->target
, FTFx_FPROT3
, &fprot
);
1328 if (result
!= ERROR_OK
)
1331 /* Every bit protects 1/32 of the full flash (not necessarily just this bank) */
1333 } else if (k_bank
->flash_class
== FC_FLEX_NVM
) {
1336 /* read protection register */
1337 result
= target_read_u8(bank
->target
, FTFx_FDPROT
, &fdprot
);
1338 if (result
!= ERROR_OK
)
1344 LOG_ERROR("Protection checks for FlexRAM not supported");
1345 return ERROR_FLASH_BANK_INVALID
;
1348 b
= k_bank
->protection_block
;
1349 for (i
= 0; i
< bank
->num_prot_blocks
; i
++) {
1350 if ((fprot
>> b
) & 1)
1351 bank
->prot_blocks
[i
].is_protected
= 0;
1353 bank
->prot_blocks
[i
].is_protected
= 1;
1362 static int kinetis_fill_fcf(struct flash_bank
*bank
, uint8_t *fcf
)
1364 uint32_t fprot
= 0xffffffff;
1365 uint8_t fsec
= 0xfe; /* set MCU unsecure */
1366 uint8_t fdprot
= 0xff;
1369 unsigned num_blocks
;
1370 uint32_t pflash_bit
;
1372 struct flash_bank
*bank_iter
;
1373 struct kinetis_flash_bank
*k_bank
= bank
->driver_priv
;
1374 struct kinetis_chip
*k_chip
= k_bank
->k_chip
;
1376 memset(fcf
, 0xff, FCF_SIZE
);
1381 /* iterate over all kinetis banks */
1382 /* current bank is bank 0, it contains FCF */
1383 num_blocks
= k_chip
->num_pflash_blocks
+ k_chip
->num_nvm_blocks
;
1384 for (bank_idx
= 0; bank_idx
< num_blocks
; bank_idx
++) {
1385 k_bank
= &(k_chip
->banks
[bank_idx
]);
1386 bank_iter
= k_bank
->bank
;
1388 if (bank_iter
== NULL
) {
1389 LOG_WARNING("Missing bank %u configuration, FCF protection flags may be incomplette", bank_idx
);
1393 kinetis_auto_probe(bank_iter
);
1395 if (k_bank
->flash_class
== FC_PFLASH
) {
1396 for (i
= 0; i
< bank_iter
->num_prot_blocks
; i
++) {
1397 if (bank_iter
->prot_blocks
[i
].is_protected
== 1)
1398 fprot
&= ~pflash_bit
;
1403 } else if (k_bank
->flash_class
== FC_FLEX_NVM
) {
1404 for (i
= 0; i
< bank_iter
->num_prot_blocks
; i
++) {
1405 if (bank_iter
->prot_blocks
[i
].is_protected
== 1)
1406 fdprot
&= ~dflash_bit
;
1414 target_buffer_set_u32(bank
->target
, fcf
+ FCF_FPROT
, fprot
);
1415 fcf
[FCF_FSEC
] = fsec
;
1416 fcf
[FCF_FOPT
] = fcf_fopt
;
1417 fcf
[FCF_FDPROT
] = fdprot
;
1421 static int kinetis_ftfx_command(struct target
*target
, uint8_t fcmd
, uint32_t faddr
,
1422 uint8_t fccob4
, uint8_t fccob5
, uint8_t fccob6
, uint8_t fccob7
,
1423 uint8_t fccob8
, uint8_t fccob9
, uint8_t fccoba
, uint8_t fccobb
,
1424 uint8_t *ftfx_fstat
)
1426 uint8_t command
[12] = {faddr
& 0xff, (faddr
>> 8) & 0xff, (faddr
>> 16) & 0xff, fcmd
,
1427 fccob7
, fccob6
, fccob5
, fccob4
,
1428 fccobb
, fccoba
, fccob9
, fccob8
};
1431 int64_t ms_timeout
= timeval_ms() + 250;
1433 result
= target_write_memory(target
, FTFx_FCCOB3
, 4, 3, command
);
1434 if (result
!= ERROR_OK
)
1438 result
= target_write_u8(target
, FTFx_FSTAT
, 0x80);
1439 if (result
!= ERROR_OK
)
1444 result
= target_read_u8(target
, FTFx_FSTAT
, &fstat
);
1446 if (result
!= ERROR_OK
)
1452 } while (timeval_ms() < ms_timeout
);
1455 *ftfx_fstat
= fstat
;
1457 if ((fstat
& 0xf0) != 0x80) {
1458 LOG_DEBUG("ftfx command failed FSTAT: %02X FCCOB: %02X%02X%02X%02X %02X%02X%02X%02X %02X%02X%02X%02X",
1459 fstat
, command
[3], command
[2], command
[1], command
[0],
1460 command
[7], command
[6], command
[5], command
[4],
1461 command
[11], command
[10], command
[9], command
[8]);
1463 return kinetis_ftfx_decode_error(fstat
);
1470 static int kinetis_check_run_mode(struct target
*target
)
1473 uint8_t pmctrl
, pmstat
;
1475 if (target
->state
!= TARGET_HALTED
) {
1476 LOG_ERROR("Target not halted");
1477 return ERROR_TARGET_NOT_HALTED
;
1480 result
= target_read_u8(target
, SMC_PMSTAT
, &pmstat
);
1481 if (result
!= ERROR_OK
)
1484 if (pmstat
== PM_STAT_RUN
)
1487 if (pmstat
== PM_STAT_VLPR
) {
1488 /* It is safe to switch from VLPR to RUN mode without changing clock */
1489 LOG_INFO("Switching from VLPR to RUN mode.");
1490 pmctrl
= PM_CTRL_RUNM_RUN
;
1491 result
= target_write_u8(target
, SMC_PMCTRL
, pmctrl
);
1492 if (result
!= ERROR_OK
)
1495 for (i
= 100; i
; i
--) {
1496 result
= target_read_u8(target
, SMC_PMSTAT
, &pmstat
);
1497 if (result
!= ERROR_OK
)
1500 if (pmstat
== PM_STAT_RUN
)
1505 LOG_ERROR("Flash operation not possible in current run mode: SMC_PMSTAT: 0x%x", pmstat
);
1506 LOG_ERROR("Issue a 'reset init' command.");
1507 return ERROR_TARGET_NOT_HALTED
;
1511 static void kinetis_invalidate_flash_cache(struct kinetis_chip
*k_chip
)
1513 struct target
*target
= k_chip
->target
;
1515 switch (k_chip
->cache_type
) {
1516 case KINETIS_CACHE_K
:
1517 target_write_u8(target
, FMC_PFB01CR
+ 2, 0xf0);
1518 /* Set CINV_WAY bits - request invalidate of all cache ways */
1519 /* FMC_PFB0CR has same address and CINV_WAY bits as FMC_PFB01CR */
1522 case KINETIS_CACHE_L
:
1523 target_write_u8(target
, MCM_PLACR
+ 1, 0x04);
1524 /* set bit CFCC - Clear Flash Controller Cache */
1527 case KINETIS_CACHE_MSCM
:
1528 target_write_u32(target
, MSCM_OCMDR0
, 0x30);
1529 /* disable data prefetch and flash speculate */
1538 static int kinetis_erase(struct flash_bank
*bank
, int first
, int last
)
1541 struct kinetis_flash_bank
*k_bank
= bank
->driver_priv
;
1543 result
= kinetis_check_run_mode(bank
->target
);
1544 if (result
!= ERROR_OK
)
1547 /* reset error flags */
1548 result
= kinetis_ftfx_prepare(bank
->target
);
1549 if (result
!= ERROR_OK
)
1552 if ((first
> bank
->num_sectors
) || (last
> bank
->num_sectors
))
1553 return ERROR_FLASH_OPERATION_FAILED
;
1556 * FIXME: TODO: use the 'Erase Flash Block' command if the
1557 * requested erase is PFlash or NVM and encompasses the entire
1558 * block. Should be quicker.
1560 for (i
= first
; i
<= last
; i
++) {
1561 /* set command and sector address */
1562 result
= kinetis_ftfx_command(bank
->target
, FTFx_CMD_SECTERASE
, k_bank
->prog_base
+ bank
->sectors
[i
].offset
,
1563 0, 0, 0, 0, 0, 0, 0, 0, NULL
);
1565 if (result
!= ERROR_OK
) {
1566 LOG_WARNING("erase sector %d failed", i
);
1567 return ERROR_FLASH_OPERATION_FAILED
;
1570 bank
->sectors
[i
].is_erased
= 1;
1572 if (k_bank
->prog_base
== 0
1573 && bank
->sectors
[i
].offset
<= FCF_ADDRESS
1574 && bank
->sectors
[i
].offset
+ bank
->sectors
[i
].size
> FCF_ADDRESS
+ FCF_SIZE
) {
1575 if (allow_fcf_writes
) {
1576 LOG_WARNING("Flash Configuration Field erased, DO NOT reset or power off the device");
1577 LOG_WARNING("until correct FCF is programmed or MCU gets security lock.");
1579 uint8_t fcf_buffer
[FCF_SIZE
];
1581 kinetis_fill_fcf(bank
, fcf_buffer
);
1582 result
= kinetis_write_inner(bank
, fcf_buffer
, FCF_ADDRESS
, FCF_SIZE
);
1583 if (result
!= ERROR_OK
)
1584 LOG_WARNING("Flash Configuration Field write failed");
1585 bank
->sectors
[i
].is_erased
= 0;
1590 kinetis_invalidate_flash_cache(k_bank
->k_chip
);
1595 static int kinetis_make_ram_ready(struct target
*target
)
1600 /* check if ram ready */
1601 result
= target_read_u8(target
, FTFx_FCNFG
, &ftfx_fcnfg
);
1602 if (result
!= ERROR_OK
)
1605 if (ftfx_fcnfg
& (1 << 1))
1606 return ERROR_OK
; /* ram ready */
1608 /* make flex ram available */
1609 result
= kinetis_ftfx_command(target
, FTFx_CMD_SETFLEXRAM
, 0x00ff0000,
1610 0, 0, 0, 0, 0, 0, 0, 0, NULL
);
1611 if (result
!= ERROR_OK
)
1612 return ERROR_FLASH_OPERATION_FAILED
;
1615 result
= target_read_u8(target
, FTFx_FCNFG
, &ftfx_fcnfg
);
1616 if (result
!= ERROR_OK
)
1619 if (ftfx_fcnfg
& (1 << 1))
1620 return ERROR_OK
; /* ram ready */
1622 return ERROR_FLASH_OPERATION_FAILED
;
1626 static int kinetis_write_sections(struct flash_bank
*bank
, const uint8_t *buffer
,
1627 uint32_t offset
, uint32_t count
)
1629 int result
= ERROR_OK
;
1630 struct kinetis_flash_bank
*k_bank
= bank
->driver_priv
;
1631 struct kinetis_chip
*k_chip
= k_bank
->k_chip
;
1632 uint8_t *buffer_aligned
= NULL
;
1634 * Kinetis uses different terms for the granularity of
1635 * sector writes, e.g. "phrase" or "128 bits". We use
1636 * the generic term "chunk". The largest possible
1637 * Kinetis "chunk" is 16 bytes (128 bits).
1639 uint32_t prog_section_chunk_bytes
= k_bank
->sector_size
>> 8;
1640 uint32_t prog_size_bytes
= k_chip
->max_flash_prog_size
;
1643 uint32_t size
= prog_size_bytes
- offset
% prog_size_bytes
;
1644 uint32_t align_begin
= offset
% prog_section_chunk_bytes
;
1646 uint32_t size_aligned
;
1647 uint16_t chunk_count
;
1653 align_end
= (align_begin
+ size
) % prog_section_chunk_bytes
;
1655 align_end
= prog_section_chunk_bytes
- align_end
;
1657 size_aligned
= align_begin
+ size
+ align_end
;
1658 chunk_count
= size_aligned
/ prog_section_chunk_bytes
;
1660 if (size
!= size_aligned
) {
1661 /* aligned section: the first, the last or the only */
1662 if (!buffer_aligned
)
1663 buffer_aligned
= malloc(prog_size_bytes
);
1665 memset(buffer_aligned
, 0xff, size_aligned
);
1666 memcpy(buffer_aligned
+ align_begin
, buffer
, size
);
1668 result
= target_write_memory(bank
->target
, k_chip
->progr_accel_ram
,
1669 4, size_aligned
/ 4, buffer_aligned
);
1671 LOG_DEBUG("section @ %08" PRIx32
" aligned begin %" PRIu32
", end %" PRIu32
,
1672 bank
->base
+ offset
, align_begin
, align_end
);
1674 result
= target_write_memory(bank
->target
, k_chip
->progr_accel_ram
,
1675 4, size_aligned
/ 4, buffer
);
1677 LOG_DEBUG("write section @ %08" PRIx32
" with length %" PRIu32
" bytes",
1678 bank
->base
+ offset
, size
);
1680 if (result
!= ERROR_OK
) {
1681 LOG_ERROR("target_write_memory failed");
1685 /* execute section-write command */
1686 result
= kinetis_ftfx_command(bank
->target
, FTFx_CMD_SECTWRITE
,
1687 k_bank
->prog_base
+ offset
- align_begin
,
1688 chunk_count
>>8, chunk_count
, 0, 0,
1689 0, 0, 0, 0, &ftfx_fstat
);
1691 if (result
!= ERROR_OK
) {
1692 LOG_ERROR("Error writing section at %08" PRIx32
, bank
->base
+ offset
);
1696 if (ftfx_fstat
& 0x01) {
1697 LOG_ERROR("Flash write error at %08" PRIx32
, bank
->base
+ offset
);
1698 if (k_bank
->prog_base
== 0 && offset
== FCF_ADDRESS
+ FCF_SIZE
1699 && (k_chip
->flash_support
& FS_WIDTH_256BIT
)) {
1700 LOG_ERROR("Flash write immediately after the end of Flash Config Field shows error");
1701 LOG_ERROR("because the flash memory is 256 bits wide (data were written correctly).");
1702 LOG_ERROR("Either change the linker script to add a gap of 16 bytes after FCF");
1703 LOG_ERROR("or set 'kinetis fcf_source write'");
1712 free(buffer_aligned
);
1717 static int kinetis_write_inner(struct flash_bank
*bank
, const uint8_t *buffer
,
1718 uint32_t offset
, uint32_t count
)
1720 int result
, fallback
= 0;
1721 struct kinetis_flash_bank
*k_bank
= bank
->driver_priv
;
1722 struct kinetis_chip
*k_chip
= k_bank
->k_chip
;
1724 if (!(k_chip
->flash_support
& FS_PROGRAM_SECTOR
)) {
1725 /* fallback to longword write */
1727 LOG_INFO("This device supports Program Longword execution only.");
1729 result
= kinetis_make_ram_ready(bank
->target
);
1730 if (result
!= ERROR_OK
) {
1732 LOG_WARNING("FlexRAM not ready, fallback to slow longword write.");
1736 LOG_DEBUG("flash write @ %08" PRIx32
, bank
->base
+ offset
);
1738 if (fallback
== 0) {
1739 /* program section command */
1740 kinetis_write_sections(bank
, buffer
, offset
, count
);
1741 } else if (k_chip
->flash_support
& FS_PROGRAM_LONGWORD
) {
1742 /* program longword command, not supported in FTFE */
1743 uint8_t *new_buffer
= NULL
;
1745 /* check word alignment */
1747 LOG_ERROR("offset 0x%" PRIx32
" breaks the required alignment", offset
);
1748 return ERROR_FLASH_DST_BREAKS_ALIGNMENT
;
1752 uint32_t old_count
= count
;
1753 count
= (old_count
| 3) + 1;
1754 new_buffer
= malloc(count
);
1755 if (new_buffer
== NULL
) {
1756 LOG_ERROR("odd number of bytes to write and no memory "
1757 "for padding buffer");
1760 LOG_INFO("odd number of bytes to write (%" PRIu32
"), extending to %" PRIu32
" "
1761 "and padding with 0xff", old_count
, count
);
1762 memset(new_buffer
+ old_count
, 0xff, count
- old_count
);
1763 buffer
= memcpy(new_buffer
, buffer
, old_count
);
1766 uint32_t words_remaining
= count
/ 4;
1768 kinetis_disable_wdog(k_chip
);
1770 /* try using a block write */
1771 result
= kinetis_write_block(bank
, buffer
, offset
, words_remaining
);
1773 if (result
== ERROR_TARGET_RESOURCE_NOT_AVAILABLE
) {
1774 /* if block write failed (no sufficient working area),
1775 * we use normal (slow) single word accesses */
1776 LOG_WARNING("couldn't use block writes, falling back to single "
1779 while (words_remaining
) {
1782 LOG_DEBUG("write longword @ %08" PRIx32
, (uint32_t)(bank
->base
+ offset
));
1784 result
= kinetis_ftfx_command(bank
->target
, FTFx_CMD_LWORDPROG
, k_bank
->prog_base
+ offset
,
1785 buffer
[3], buffer
[2], buffer
[1], buffer
[0],
1786 0, 0, 0, 0, &ftfx_fstat
);
1788 if (result
!= ERROR_OK
) {
1789 LOG_ERROR("Error writing longword at %08" PRIx32
, bank
->base
+ offset
);
1793 if (ftfx_fstat
& 0x01)
1794 LOG_ERROR("Flash write error at %08" PRIx32
, bank
->base
+ offset
);
1803 LOG_ERROR("Flash write strategy not implemented");
1804 return ERROR_FLASH_OPERATION_FAILED
;
1807 kinetis_invalidate_flash_cache(k_chip
);
1812 static int kinetis_write(struct flash_bank
*bank
, const uint8_t *buffer
,
1813 uint32_t offset
, uint32_t count
)
1816 bool set_fcf
= false;
1818 struct kinetis_flash_bank
*k_bank
= bank
->driver_priv
;
1820 result
= kinetis_check_run_mode(bank
->target
);
1821 if (result
!= ERROR_OK
)
1824 /* reset error flags */
1825 result
= kinetis_ftfx_prepare(bank
->target
);
1826 if (result
!= ERROR_OK
)
1829 if (k_bank
->prog_base
== 0 && !allow_fcf_writes
) {
1830 if (bank
->sectors
[1].offset
<= FCF_ADDRESS
)
1831 sect
= 1; /* 1kb sector, FCF in 2nd sector */
1833 if (offset
< bank
->sectors
[sect
].offset
+ bank
->sectors
[sect
].size
1834 && offset
+ count
> bank
->sectors
[sect
].offset
)
1835 set_fcf
= true; /* write to any part of sector with FCF */
1839 uint8_t fcf_buffer
[FCF_SIZE
];
1840 uint8_t fcf_current
[FCF_SIZE
];
1842 kinetis_fill_fcf(bank
, fcf_buffer
);
1844 if (offset
< FCF_ADDRESS
) {
1845 /* write part preceding FCF */
1846 result
= kinetis_write_inner(bank
, buffer
, offset
, FCF_ADDRESS
- offset
);
1847 if (result
!= ERROR_OK
)
1851 result
= target_read_memory(bank
->target
, bank
->base
+ FCF_ADDRESS
, 4, FCF_SIZE
/ 4, fcf_current
);
1852 if (result
== ERROR_OK
&& memcmp(fcf_current
, fcf_buffer
, FCF_SIZE
) == 0)
1856 /* write FCF if differs from flash - eliminate multiple writes */
1857 result
= kinetis_write_inner(bank
, fcf_buffer
, FCF_ADDRESS
, FCF_SIZE
);
1858 if (result
!= ERROR_OK
)
1862 LOG_WARNING("Flash Configuration Field written.");
1863 LOG_WARNING("Reset or power off the device to make settings effective.");
1865 if (offset
+ count
> FCF_ADDRESS
+ FCF_SIZE
) {
1866 uint32_t delta
= FCF_ADDRESS
+ FCF_SIZE
- offset
;
1867 /* write part after FCF */
1868 result
= kinetis_write_inner(bank
, buffer
+ delta
, FCF_ADDRESS
+ FCF_SIZE
, count
- delta
);
1873 /* no FCF fiddling, normal write */
1874 return kinetis_write_inner(bank
, buffer
, offset
, count
);
1878 static int kinetis_probe_chip(struct kinetis_chip
*k_chip
)
1881 uint8_t fcfg1_nvmsize
, fcfg1_pfsize
, fcfg1_eesize
, fcfg1_depart
;
1882 uint8_t fcfg2_pflsh
;
1883 uint32_t ee_size
= 0;
1884 uint32_t pflash_size_k
, nvm_size_k
, dflash_size_k
;
1885 uint32_t pflash_size_m
;
1886 unsigned num_blocks
= 0;
1887 unsigned maxaddr_shift
= 13;
1888 struct target
*target
= k_chip
->target
;
1890 unsigned familyid
= 0, subfamid
= 0;
1891 unsigned cpu_mhz
= 120;
1893 bool use_nvm_marking
= false;
1894 char flash_marking
[8], nvm_marking
[2];
1897 k_chip
->probed
= false;
1898 k_chip
->pflash_sector_size
= 0;
1899 k_chip
->pflash_base
= 0;
1900 k_chip
->nvm_base
= 0x10000000;
1901 k_chip
->progr_accel_ram
= FLEXRAM
;
1905 result
= target_read_u32(target
, SIM_SDID
, &k_chip
->sim_sdid
);
1906 if (result
!= ERROR_OK
)
1909 if ((k_chip
->sim_sdid
& (~KINETIS_SDID_K_SERIES_MASK
)) == 0) {
1910 /* older K-series MCU */
1911 uint32_t mcu_type
= k_chip
->sim_sdid
& KINETIS_K_SDID_TYPE_MASK
;
1912 k_chip
->cache_type
= KINETIS_CACHE_K
;
1913 k_chip
->watchdog_type
= KINETIS_WDOG_K
;
1916 case KINETIS_K_SDID_K10_M50
:
1917 case KINETIS_K_SDID_K20_M50
:
1919 k_chip
->pflash_sector_size
= 1<<10;
1920 k_chip
->nvm_sector_size
= 1<<10;
1922 k_chip
->flash_support
= FS_PROGRAM_LONGWORD
| FS_PROGRAM_SECTOR
;
1924 case KINETIS_K_SDID_K10_M72
:
1925 case KINETIS_K_SDID_K20_M72
:
1926 case KINETIS_K_SDID_K30_M72
:
1927 case KINETIS_K_SDID_K30_M100
:
1928 case KINETIS_K_SDID_K40_M72
:
1929 case KINETIS_K_SDID_K40_M100
:
1930 case KINETIS_K_SDID_K50_M72
:
1931 /* 2kB sectors, 1kB FlexNVM sectors */
1932 k_chip
->pflash_sector_size
= 2<<10;
1933 k_chip
->nvm_sector_size
= 1<<10;
1935 k_chip
->flash_support
= FS_PROGRAM_LONGWORD
| FS_PROGRAM_SECTOR
;
1936 k_chip
->max_flash_prog_size
= 1<<10;
1938 case KINETIS_K_SDID_K10_M100
:
1939 case KINETIS_K_SDID_K20_M100
:
1940 case KINETIS_K_SDID_K11
:
1941 case KINETIS_K_SDID_K12
:
1942 case KINETIS_K_SDID_K21_M50
:
1943 case KINETIS_K_SDID_K22_M50
:
1944 case KINETIS_K_SDID_K51_M72
:
1945 case KINETIS_K_SDID_K53
:
1946 case KINETIS_K_SDID_K60_M100
:
1948 k_chip
->pflash_sector_size
= 2<<10;
1949 k_chip
->nvm_sector_size
= 2<<10;
1951 k_chip
->flash_support
= FS_PROGRAM_LONGWORD
| FS_PROGRAM_SECTOR
;
1953 case KINETIS_K_SDID_K21_M120
:
1954 case KINETIS_K_SDID_K22_M120
:
1955 /* 4kB sectors (MK21FN1M0, MK21FX512, MK22FN1M0, MK22FX512) */
1956 k_chip
->pflash_sector_size
= 4<<10;
1957 k_chip
->max_flash_prog_size
= 1<<10;
1958 k_chip
->nvm_sector_size
= 4<<10;
1960 k_chip
->flash_support
= FS_PROGRAM_PHRASE
| FS_PROGRAM_SECTOR
;
1962 case KINETIS_K_SDID_K10_M120
:
1963 case KINETIS_K_SDID_K20_M120
:
1964 case KINETIS_K_SDID_K60_M150
:
1965 case KINETIS_K_SDID_K70_M150
:
1967 k_chip
->pflash_sector_size
= 4<<10;
1968 k_chip
->nvm_sector_size
= 4<<10;
1970 k_chip
->flash_support
= FS_PROGRAM_PHRASE
| FS_PROGRAM_SECTOR
;
1973 LOG_ERROR("Unsupported K-family FAMID");
1976 for (idx
= 0; idx
< ARRAY_SIZE(kinetis_types_old
); idx
++) {
1977 if (kinetis_types_old
[idx
].sdid
== mcu_type
) {
1978 strcpy(name
, kinetis_types_old
[idx
].name
);
1979 use_nvm_marking
= true;
1985 /* Newer K-series or KL series MCU */
1986 familyid
= (k_chip
->sim_sdid
& KINETIS_SDID_FAMILYID_MASK
) >> KINETIS_SDID_FAMILYID_SHIFT
;
1987 subfamid
= (k_chip
->sim_sdid
& KINETIS_SDID_SUBFAMID_MASK
) >> KINETIS_SDID_SUBFAMID_SHIFT
;
1989 switch (k_chip
->sim_sdid
& KINETIS_SDID_SERIESID_MASK
) {
1990 case KINETIS_SDID_SERIESID_K
:
1991 use_nvm_marking
= true;
1992 k_chip
->cache_type
= KINETIS_CACHE_K
;
1993 k_chip
->watchdog_type
= KINETIS_WDOG_K
;
1995 switch (k_chip
->sim_sdid
& (KINETIS_SDID_FAMILYID_MASK
| KINETIS_SDID_SUBFAMID_MASK
)) {
1996 case KINETIS_SDID_FAMILYID_K0X
| KINETIS_SDID_SUBFAMID_KX2
:
1997 /* K02FN64, K02FN128: FTFA, 2kB sectors */
1998 k_chip
->pflash_sector_size
= 2<<10;
2000 k_chip
->flash_support
= FS_PROGRAM_LONGWORD
;
2004 case KINETIS_SDID_FAMILYID_K2X
| KINETIS_SDID_SUBFAMID_KX2
: {
2005 /* MK24FN1M reports as K22, this should detect it (according to errata note 1N83J) */
2007 result
= target_read_u32(target
, SIM_SOPT1
, &sopt1
);
2008 if (result
!= ERROR_OK
)
2011 if (((k_chip
->sim_sdid
& (KINETIS_SDID_DIEID_MASK
)) == KINETIS_SDID_DIEID_K24FN1M
) &&
2012 ((sopt1
& KINETIS_SOPT1_RAMSIZE_MASK
) == KINETIS_SOPT1_RAMSIZE_K24FN1M
)) {
2014 k_chip
->pflash_sector_size
= 4<<10;
2016 k_chip
->flash_support
= FS_PROGRAM_PHRASE
| FS_PROGRAM_SECTOR
;
2017 k_chip
->max_flash_prog_size
= 1<<10;
2018 subfamid
= 4; /* errata 1N83J fix */
2021 if ((k_chip
->sim_sdid
& (KINETIS_SDID_DIEID_MASK
)) == KINETIS_SDID_DIEID_K22FN128
2022 || (k_chip
->sim_sdid
& (KINETIS_SDID_DIEID_MASK
)) == KINETIS_SDID_DIEID_K22FN256
2023 || (k_chip
->sim_sdid
& (KINETIS_SDID_DIEID_MASK
)) == KINETIS_SDID_DIEID_K22FN512
) {
2024 /* K22 with new-style SDID - smaller pflash with FTFA, 2kB sectors */
2025 k_chip
->pflash_sector_size
= 2<<10;
2026 /* autodetect 1 or 2 blocks */
2027 k_chip
->flash_support
= FS_PROGRAM_LONGWORD
;
2030 LOG_ERROR("Unsupported Kinetis K22 DIEID");
2033 case KINETIS_SDID_FAMILYID_K2X
| KINETIS_SDID_SUBFAMID_KX4
:
2034 k_chip
->pflash_sector_size
= 4<<10;
2035 if ((k_chip
->sim_sdid
& (KINETIS_SDID_DIEID_MASK
)) == KINETIS_SDID_DIEID_K24FN256
) {
2036 /* K24FN256 - smaller pflash with FTFA */
2038 k_chip
->flash_support
= FS_PROGRAM_LONGWORD
;
2041 /* K24FN1M without errata 7534 */
2043 k_chip
->flash_support
= FS_PROGRAM_PHRASE
| FS_PROGRAM_SECTOR
;
2044 k_chip
->max_flash_prog_size
= 1<<10;
2047 case KINETIS_SDID_FAMILYID_K6X
| KINETIS_SDID_SUBFAMID_KX1
: /* errata 7534 - should be K63 */
2048 case KINETIS_SDID_FAMILYID_K6X
| KINETIS_SDID_SUBFAMID_KX2
: /* errata 7534 - should be K64 */
2049 subfamid
+= 2; /* errata 7534 fix */
2050 case KINETIS_SDID_FAMILYID_K6X
| KINETIS_SDID_SUBFAMID_KX3
:
2052 case KINETIS_SDID_FAMILYID_K6X
| KINETIS_SDID_SUBFAMID_KX4
:
2053 /* K64FN1M0, K64FX512 */
2054 k_chip
->pflash_sector_size
= 4<<10;
2055 k_chip
->nvm_sector_size
= 4<<10;
2056 k_chip
->max_flash_prog_size
= 1<<10;
2058 k_chip
->flash_support
= FS_PROGRAM_PHRASE
| FS_PROGRAM_SECTOR
;
2061 case KINETIS_SDID_FAMILYID_K2X
| KINETIS_SDID_SUBFAMID_KX6
:
2063 case KINETIS_SDID_FAMILYID_K6X
| KINETIS_SDID_SUBFAMID_KX6
:
2064 /* K66FN2M0, K66FX1M0 */
2065 k_chip
->pflash_sector_size
= 4<<10;
2066 k_chip
->nvm_sector_size
= 4<<10;
2067 k_chip
->max_flash_prog_size
= 1<<10;
2069 k_chip
->flash_support
= FS_PROGRAM_PHRASE
| FS_PROGRAM_SECTOR
;
2073 case KINETIS_SDID_FAMILYID_K8X
| KINETIS_SDID_SUBFAMID_KX0
:
2074 case KINETIS_SDID_FAMILYID_K8X
| KINETIS_SDID_SUBFAMID_KX1
:
2075 case KINETIS_SDID_FAMILYID_K8X
| KINETIS_SDID_SUBFAMID_KX2
:
2076 /* K80FN256, K81FN256, K82FN256 */
2077 k_chip
->pflash_sector_size
= 4<<10;
2079 k_chip
->flash_support
= FS_PROGRAM_LONGWORD
| FS_NO_CMD_BLOCKSTAT
;
2083 case KINETIS_SDID_FAMILYID_KL8X
| KINETIS_SDID_SUBFAMID_KX1
:
2084 case KINETIS_SDID_FAMILYID_KL8X
| KINETIS_SDID_SUBFAMID_KX2
:
2085 /* KL81Z128, KL82Z128 */
2086 k_chip
->pflash_sector_size
= 2<<10;
2088 k_chip
->flash_support
= FS_PROGRAM_LONGWORD
| FS_NO_CMD_BLOCKSTAT
;
2089 k_chip
->cache_type
= KINETIS_CACHE_L
;
2091 use_nvm_marking
= false;
2092 snprintf(name
, sizeof(name
), "MKL8%uZ%%s7",
2097 LOG_ERROR("Unsupported Kinetis FAMILYID SUBFAMID");
2100 if (name
[0] == '\0')
2101 snprintf(name
, sizeof(name
), "MK%u%uF%%s%u",
2102 familyid
, subfamid
, cpu_mhz
/ 10);
2105 case KINETIS_SDID_SERIESID_KL
:
2107 k_chip
->pflash_sector_size
= 1<<10;
2108 k_chip
->nvm_sector_size
= 1<<10;
2109 /* autodetect 1 or 2 blocks */
2110 k_chip
->flash_support
= FS_PROGRAM_LONGWORD
;
2111 k_chip
->cache_type
= KINETIS_CACHE_L
;
2112 k_chip
->watchdog_type
= KINETIS_WDOG_COP
;
2115 if (subfamid
== 3 && (familyid
== 1 || familyid
== 2))
2117 snprintf(name
, sizeof(name
), "MKL%u%uZ%%s%u",
2118 familyid
, subfamid
, cpu_mhz
/ 10);
2121 case KINETIS_SDID_SERIESID_KV
:
2123 k_chip
->watchdog_type
= KINETIS_WDOG_K
;
2124 switch (k_chip
->sim_sdid
& (KINETIS_SDID_FAMILYID_MASK
| KINETIS_SDID_SUBFAMID_MASK
)) {
2125 case KINETIS_SDID_FAMILYID_K1X
| KINETIS_SDID_SUBFAMID_KX0
:
2126 /* KV10: FTFA, 1kB sectors */
2127 k_chip
->pflash_sector_size
= 1<<10;
2129 k_chip
->flash_support
= FS_PROGRAM_LONGWORD
;
2130 k_chip
->cache_type
= KINETIS_CACHE_L
;
2131 strcpy(name
, "MKV10Z%s7");
2134 case KINETIS_SDID_FAMILYID_K1X
| KINETIS_SDID_SUBFAMID_KX1
:
2135 /* KV11: FTFA, 2kB sectors */
2136 k_chip
->pflash_sector_size
= 2<<10;
2138 k_chip
->flash_support
= FS_PROGRAM_LONGWORD
;
2139 k_chip
->cache_type
= KINETIS_CACHE_L
;
2140 strcpy(name
, "MKV11Z%s7");
2143 case KINETIS_SDID_FAMILYID_K3X
| KINETIS_SDID_SUBFAMID_KX0
:
2144 /* KV30: FTFA, 2kB sectors, 1 block */
2145 case KINETIS_SDID_FAMILYID_K3X
| KINETIS_SDID_SUBFAMID_KX1
:
2146 /* KV31: FTFA, 2kB sectors, 2 blocks */
2147 k_chip
->pflash_sector_size
= 2<<10;
2148 /* autodetect 1 or 2 blocks */
2149 k_chip
->flash_support
= FS_PROGRAM_LONGWORD
;
2150 k_chip
->cache_type
= KINETIS_CACHE_K
;
2153 case KINETIS_SDID_FAMILYID_K4X
| KINETIS_SDID_SUBFAMID_KX2
:
2154 case KINETIS_SDID_FAMILYID_K4X
| KINETIS_SDID_SUBFAMID_KX4
:
2155 case KINETIS_SDID_FAMILYID_K4X
| KINETIS_SDID_SUBFAMID_KX6
:
2156 /* KV4x: FTFA, 4kB sectors */
2157 k_chip
->pflash_sector_size
= 4<<10;
2159 k_chip
->flash_support
= FS_PROGRAM_LONGWORD
;
2160 k_chip
->cache_type
= KINETIS_CACHE_K
;
2164 case KINETIS_SDID_FAMILYID_K5X
| KINETIS_SDID_SUBFAMID_KX6
:
2165 case KINETIS_SDID_FAMILYID_K5X
| KINETIS_SDID_SUBFAMID_KX8
:
2166 /* KV5x: FTFE, 8kB sectors */
2167 k_chip
->pflash_sector_size
= 8<<10;
2168 k_chip
->max_flash_prog_size
= 1<<10;
2171 k_chip
->flash_support
= FS_PROGRAM_PHRASE
| FS_PROGRAM_SECTOR
| FS_WIDTH_256BIT
;
2172 k_chip
->pflash_base
= 0x10000000;
2173 k_chip
->progr_accel_ram
= 0x18000000;
2178 LOG_ERROR("Unsupported KV FAMILYID SUBFAMID");
2181 if (name
[0] == '\0')
2182 snprintf(name
, sizeof(name
), "MKV%u%uF%%s%u",
2183 familyid
, subfamid
, cpu_mhz
/ 10);
2186 case KINETIS_SDID_SERIESID_KE
:
2188 k_chip
->watchdog_type
= KINETIS_WDOG32_KE1X
;
2189 switch (k_chip
->sim_sdid
&
2190 (KINETIS_SDID_FAMILYID_MASK
| KINETIS_SDID_SUBFAMID_MASK
| KINETIS_SDID_PROJECTID_MASK
)) {
2191 case KINETIS_SDID_FAMILYID_K1X
| KINETIS_SDID_SUBFAMID_KX4
| KINETIS_SDID_PROJECTID_KE1xZ
:
2192 case KINETIS_SDID_FAMILYID_K1X
| KINETIS_SDID_SUBFAMID_KX5
| KINETIS_SDID_PROJECTID_KE1xZ
:
2193 /* KE1xZ: FTFE, 2kB sectors */
2194 k_chip
->pflash_sector_size
= 2<<10;
2195 k_chip
->nvm_sector_size
= 2<<10;
2196 k_chip
->max_flash_prog_size
= 1<<9;
2198 k_chip
->flash_support
= FS_PROGRAM_PHRASE
| FS_PROGRAM_SECTOR
;
2199 k_chip
->cache_type
= KINETIS_CACHE_L
;
2202 snprintf(name
, sizeof(name
), "MKE%u%uZ%%s%u",
2203 familyid
, subfamid
, cpu_mhz
/ 10);
2206 case KINETIS_SDID_FAMILYID_K1X
| KINETIS_SDID_SUBFAMID_KX4
| KINETIS_SDID_PROJECTID_KE1xF
:
2207 case KINETIS_SDID_FAMILYID_K1X
| KINETIS_SDID_SUBFAMID_KX6
| KINETIS_SDID_PROJECTID_KE1xF
:
2208 case KINETIS_SDID_FAMILYID_K1X
| KINETIS_SDID_SUBFAMID_KX8
| KINETIS_SDID_PROJECTID_KE1xF
:
2209 /* KE1xF: FTFE, 4kB sectors */
2210 k_chip
->pflash_sector_size
= 4<<10;
2211 k_chip
->nvm_sector_size
= 2<<10;
2212 k_chip
->max_flash_prog_size
= 1<<10;
2214 k_chip
->flash_support
= FS_PROGRAM_PHRASE
| FS_PROGRAM_SECTOR
;
2215 k_chip
->cache_type
= KINETIS_CACHE_MSCM
;
2218 snprintf(name
, sizeof(name
), "MKE%u%uF%%s%u",
2219 familyid
, subfamid
, cpu_mhz
/ 10);
2223 LOG_ERROR("Unsupported KE FAMILYID SUBFAMID");
2228 LOG_ERROR("Unsupported K-series");
2232 if (k_chip
->pflash_sector_size
== 0) {
2233 LOG_ERROR("MCU is unsupported, SDID 0x%08" PRIx32
, k_chip
->sim_sdid
);
2234 return ERROR_FLASH_OPER_UNSUPPORTED
;
2237 result
= target_read_u32(target
, SIM_FCFG1
, &k_chip
->sim_fcfg1
);
2238 if (result
!= ERROR_OK
)
2241 result
= target_read_u32(target
, SIM_FCFG2
, &k_chip
->sim_fcfg2
);
2242 if (result
!= ERROR_OK
)
2245 LOG_DEBUG("SDID: 0x%08" PRIX32
" FCFG1: 0x%08" PRIX32
" FCFG2: 0x%08" PRIX32
, k_chip
->sim_sdid
,
2246 k_chip
->sim_fcfg1
, k_chip
->sim_fcfg2
);
2248 fcfg1_nvmsize
= (uint8_t)((k_chip
->sim_fcfg1
>> 28) & 0x0f);
2249 fcfg1_pfsize
= (uint8_t)((k_chip
->sim_fcfg1
>> 24) & 0x0f);
2250 fcfg1_eesize
= (uint8_t)((k_chip
->sim_fcfg1
>> 16) & 0x0f);
2251 fcfg1_depart
= (uint8_t)((k_chip
->sim_fcfg1
>> 8) & 0x0f);
2253 fcfg2_pflsh
= (uint8_t)((k_chip
->sim_fcfg2
>> 23) & 0x01);
2254 k_chip
->fcfg2_maxaddr0_shifted
= ((k_chip
->sim_fcfg2
>> 24) & 0x7f) << maxaddr_shift
;
2255 k_chip
->fcfg2_maxaddr1_shifted
= ((k_chip
->sim_fcfg2
>> 16) & 0x7f) << maxaddr_shift
;
2257 if (num_blocks
== 0)
2258 num_blocks
= k_chip
->fcfg2_maxaddr1_shifted
? 2 : 1;
2259 else if (k_chip
->fcfg2_maxaddr1_shifted
== 0 && num_blocks
>= 2) {
2261 LOG_WARNING("MAXADDR1 is zero, number of flash banks adjusted to 1");
2262 } else if (k_chip
->fcfg2_maxaddr1_shifted
!= 0 && num_blocks
== 1) {
2264 LOG_WARNING("MAXADDR1 is non zero, number of flash banks adjusted to 2");
2267 /* when the PFLSH bit is set, there is no FlexNVM/FlexRAM */
2269 switch (fcfg1_nvmsize
) {
2275 k_chip
->nvm_size
= 1 << (14 + (fcfg1_nvmsize
>> 1));
2278 if (k_chip
->pflash_sector_size
>= 4<<10)
2279 k_chip
->nvm_size
= 512<<10;
2282 k_chip
->nvm_size
= 256<<10;
2285 k_chip
->nvm_size
= 0;
2289 switch (fcfg1_eesize
) {
2300 ee_size
= (16 << (10 - fcfg1_eesize
));
2307 switch (fcfg1_depart
) {
2314 k_chip
->dflash_size
= k_chip
->nvm_size
- (4096 << fcfg1_depart
);
2317 k_chip
->dflash_size
= 0;
2324 k_chip
->dflash_size
= 4096 << (fcfg1_depart
& 0x7);
2327 k_chip
->dflash_size
= k_chip
->nvm_size
;
2332 switch (fcfg1_pfsize
) {
2339 k_chip
->pflash_size
= 1 << (14 + (fcfg1_pfsize
>> 1));
2342 /* a peculiar case: Freescale states different sizes for 0xf
2343 * K02P64M100SFARM 128 KB ... duplicate of code 0x7
2344 * K22P121M120SF8RM 256 KB ... duplicate of code 0x9
2345 * K22P121M120SF7RM 512 KB ... duplicate of code 0xb
2346 * K22P100M120SF5RM 1024 KB ... duplicate of code 0xd
2347 * K26P169M180SF5RM 2048 KB ... the only unique value
2348 * fcfg2_maxaddr0 seems to be the only clue to pflash_size
2349 * Checking fcfg2_maxaddr0 in bank probe is pointless then
2352 k_chip
->pflash_size
= k_chip
->fcfg2_maxaddr0_shifted
* num_blocks
;
2354 k_chip
->pflash_size
= k_chip
->fcfg2_maxaddr0_shifted
* num_blocks
/ 2;
2355 if (k_chip
->pflash_size
!= 2048<<10)
2356 LOG_WARNING("SIM_FCFG1 PFSIZE = 0xf: please check if pflash is %u KB", k_chip
->pflash_size
>>10);
2360 k_chip
->pflash_size
= 0;
2364 if (k_chip
->flash_support
& FS_PROGRAM_SECTOR
&& k_chip
->max_flash_prog_size
== 0) {
2365 k_chip
->max_flash_prog_size
= k_chip
->pflash_sector_size
;
2366 /* Program section size is equal to sector size by default */
2369 k_chip
->num_pflash_blocks
= num_blocks
/ (2 - fcfg2_pflsh
);
2370 k_chip
->num_nvm_blocks
= num_blocks
- k_chip
->num_pflash_blocks
;
2372 if (use_nvm_marking
) {
2373 nvm_marking
[0] = k_chip
->num_nvm_blocks
? 'X' : 'N';
2374 nvm_marking
[1] = '\0';
2376 nvm_marking
[0] = '\0';
2378 pflash_size_k
= k_chip
->pflash_size
/ 1024;
2379 pflash_size_m
= pflash_size_k
/ 1024;
2381 snprintf(flash_marking
, sizeof(flash_marking
), "%s%" PRIu32
"M0xxx", nvm_marking
, pflash_size_m
);
2383 snprintf(flash_marking
, sizeof(flash_marking
), "%s%" PRIu32
"xxx", nvm_marking
, pflash_size_k
);
2385 snprintf(k_chip
->name
, sizeof(k_chip
->name
), name
, flash_marking
);
2386 LOG_INFO("Kinetis %s detected: %u flash blocks", k_chip
->name
, num_blocks
);
2387 LOG_INFO("%u PFlash banks: %" PRIu32
"k total", k_chip
->num_pflash_blocks
, pflash_size_k
);
2388 if (k_chip
->num_nvm_blocks
) {
2389 nvm_size_k
= k_chip
->nvm_size
/ 1024;
2390 dflash_size_k
= k_chip
->dflash_size
/ 1024;
2391 LOG_INFO("%u FlexNVM banks: %" PRIu32
"k total, %" PRIu32
"k available as data flash, %" PRIu32
"bytes FlexRAM",
2392 k_chip
->num_nvm_blocks
, nvm_size_k
, dflash_size_k
, ee_size
);
2395 k_chip
->probed
= true;
2398 kinetis_create_missing_banks(k_chip
);
2403 static int kinetis_probe(struct flash_bank
*bank
)
2406 uint8_t fcfg2_maxaddr0
, fcfg2_pflsh
, fcfg2_maxaddr1
;
2407 unsigned num_blocks
, first_nvm_bank
;
2409 struct kinetis_flash_bank
*k_bank
= bank
->driver_priv
;
2410 struct kinetis_chip
*k_chip
= k_bank
->k_chip
;
2412 k_bank
->probed
= false;
2414 if (!k_chip
->probed
) {
2415 result
= kinetis_probe_chip(k_chip
);
2416 if (result
!= ERROR_OK
)
2420 num_blocks
= k_chip
->num_pflash_blocks
+ k_chip
->num_nvm_blocks
;
2421 first_nvm_bank
= k_chip
->num_pflash_blocks
;
2423 if (k_bank
->bank_number
< k_chip
->num_pflash_blocks
) {
2424 /* pflash, banks start at address zero */
2425 k_bank
->flash_class
= FC_PFLASH
;
2426 bank
->size
= (k_chip
->pflash_size
/ k_chip
->num_pflash_blocks
);
2427 bank
->base
= k_chip
->pflash_base
+ bank
->size
* k_bank
->bank_number
;
2428 k_bank
->prog_base
= 0x00000000 + bank
->size
* k_bank
->bank_number
;
2429 k_bank
->sector_size
= k_chip
->pflash_sector_size
;
2430 /* pflash is divided into 32 protection areas for
2431 * parts with more than 32K of PFlash. For parts with
2432 * less the protection unit is set to 1024 bytes */
2433 k_bank
->protection_size
= MAX(k_chip
->pflash_size
/ 32, 1024);
2434 bank
->num_prot_blocks
= 32 / k_chip
->num_pflash_blocks
;
2435 k_bank
->protection_block
= bank
->num_prot_blocks
* k_bank
->bank_number
;
2437 size_k
= bank
->size
/ 1024;
2438 LOG_DEBUG("Kinetis bank %u: %" PRIu32
"k PFlash, FTFx base 0x%08" PRIx32
", sect %u",
2439 k_bank
->bank_number
, size_k
, k_bank
->prog_base
, k_bank
->sector_size
);
2441 } else if (k_bank
->bank_number
< num_blocks
) {
2442 /* nvm, banks start at address 0x10000000 */
2443 unsigned nvm_ord
= k_bank
->bank_number
- first_nvm_bank
;
2446 k_bank
->flash_class
= FC_FLEX_NVM
;
2447 bank
->size
= k_chip
->nvm_size
/ k_chip
->num_nvm_blocks
;
2448 bank
->base
= k_chip
->nvm_base
+ bank
->size
* nvm_ord
;
2449 k_bank
->prog_base
= 0x00800000 + bank
->size
* nvm_ord
;
2450 k_bank
->sector_size
= k_chip
->nvm_sector_size
;
2451 if (k_chip
->dflash_size
== 0) {
2452 k_bank
->protection_size
= 0;
2454 for (i
= k_chip
->dflash_size
; ~i
& 1; i
>>= 1)
2457 k_bank
->protection_size
= k_chip
->dflash_size
/ 8; /* data flash size = 2^^n */
2459 k_bank
->protection_size
= k_chip
->nvm_size
/ 8; /* TODO: verify on SF1, not documented in RM */
2461 bank
->num_prot_blocks
= 8 / k_chip
->num_nvm_blocks
;
2462 k_bank
->protection_block
= bank
->num_prot_blocks
* nvm_ord
;
2464 /* EEPROM backup part of FlexNVM is not accessible, use dflash_size as a limit */
2465 if (k_chip
->dflash_size
> bank
->size
* nvm_ord
)
2466 limit
= k_chip
->dflash_size
- bank
->size
* nvm_ord
;
2470 if (bank
->size
> limit
) {
2472 LOG_DEBUG("FlexNVM bank %d limited to 0x%08" PRIx32
" due to active EEPROM backup",
2473 k_bank
->bank_number
, limit
);
2476 size_k
= bank
->size
/ 1024;
2477 LOG_DEBUG("Kinetis bank %u: %" PRIu32
"k FlexNVM, FTFx base 0x%08" PRIx32
", sect %u",
2478 k_bank
->bank_number
, size_k
, k_bank
->prog_base
, k_bank
->sector_size
);
2481 LOG_ERROR("Cannot determine parameters for bank %d, only %d banks on device",
2482 k_bank
->bank_number
, num_blocks
);
2483 return ERROR_FLASH_BANK_INVALID
;
2486 fcfg2_pflsh
= (uint8_t)((k_chip
->sim_fcfg2
>> 23) & 0x01);
2487 fcfg2_maxaddr0
= (uint8_t)((k_chip
->sim_fcfg2
>> 24) & 0x7f);
2488 fcfg2_maxaddr1
= (uint8_t)((k_chip
->sim_fcfg2
>> 16) & 0x7f);
2490 if (k_bank
->bank_number
== 0 && k_chip
->fcfg2_maxaddr0_shifted
!= bank
->size
)
2491 LOG_WARNING("MAXADDR0 0x%02" PRIx8
" check failed,"
2492 " please report to OpenOCD mailing list", fcfg2_maxaddr0
);
2495 if (k_bank
->bank_number
== 1 && k_chip
->fcfg2_maxaddr1_shifted
!= bank
->size
)
2496 LOG_WARNING("MAXADDR1 0x%02" PRIx8
" check failed,"
2497 " please report to OpenOCD mailing list", fcfg2_maxaddr1
);
2499 if (k_bank
->bank_number
== first_nvm_bank
2500 && k_chip
->fcfg2_maxaddr1_shifted
!= k_chip
->dflash_size
)
2501 LOG_WARNING("FlexNVM MAXADDR1 0x%02" PRIx8
" check failed,"
2502 " please report to OpenOCD mailing list", fcfg2_maxaddr1
);
2505 if (bank
->sectors
) {
2506 free(bank
->sectors
);
2507 bank
->sectors
= NULL
;
2509 if (bank
->prot_blocks
) {
2510 free(bank
->prot_blocks
);
2511 bank
->prot_blocks
= NULL
;
2514 if (k_bank
->sector_size
== 0) {
2515 LOG_ERROR("Unknown sector size for bank %d", bank
->bank_number
);
2516 return ERROR_FLASH_BANK_INVALID
;
2519 bank
->num_sectors
= bank
->size
/ k_bank
->sector_size
;
2521 if (bank
->num_sectors
> 0) {
2522 /* FlexNVM bank can be used for EEPROM backup therefore zero sized */
2523 bank
->sectors
= alloc_block_array(0, k_bank
->sector_size
, bank
->num_sectors
);
2527 bank
->prot_blocks
= alloc_block_array(0, k_bank
->protection_size
, bank
->num_prot_blocks
);
2528 if (!bank
->prot_blocks
)
2532 bank
->num_prot_blocks
= 0;
2535 k_bank
->probed
= true;
2540 static int kinetis_auto_probe(struct flash_bank
*bank
)
2542 struct kinetis_flash_bank
*k_bank
= bank
->driver_priv
;
2544 if (k_bank
&& k_bank
->probed
)
2547 return kinetis_probe(bank
);
2550 static int kinetis_info(struct flash_bank
*bank
, char *buf
, int buf_size
)
2552 const char *bank_class_names
[] = {
2553 "(ANY)", "PFlash", "FlexNVM", "FlexRAM"
2556 struct kinetis_flash_bank
*k_bank
= bank
->driver_priv
;
2557 struct kinetis_chip
*k_chip
= k_bank
->k_chip
;
2558 uint32_t size_k
= bank
->size
/ 1024;
2560 snprintf(buf
, buf_size
,
2561 "%s %s: %" PRIu32
"k %s bank %s at 0x%08" PRIx32
,
2562 bank
->driver
->name
, k_chip
->name
,
2563 size_k
, bank_class_names
[k_bank
->flash_class
],
2564 bank
->name
, bank
->base
);
2569 static int kinetis_blank_check(struct flash_bank
*bank
)
2571 struct kinetis_flash_bank
*k_bank
= bank
->driver_priv
;
2572 struct kinetis_chip
*k_chip
= k_bank
->k_chip
;
2575 /* suprisingly blank check does not work in VLPR and HSRUN modes */
2576 result
= kinetis_check_run_mode(bank
->target
);
2577 if (result
!= ERROR_OK
)
2580 /* reset error flags */
2581 result
= kinetis_ftfx_prepare(bank
->target
);
2582 if (result
!= ERROR_OK
)
2585 if (k_bank
->flash_class
== FC_PFLASH
|| k_bank
->flash_class
== FC_FLEX_NVM
) {
2586 bool block_dirty
= true;
2587 bool use_block_cmd
= !(k_chip
->flash_support
& FS_NO_CMD_BLOCKSTAT
);
2590 if (use_block_cmd
&& k_bank
->flash_class
== FC_FLEX_NVM
) {
2591 uint8_t fcfg1_depart
= (uint8_t)((k_chip
->sim_fcfg1
>> 8) & 0x0f);
2592 /* block operation cannot be used on FlexNVM when EEPROM backup partition is set */
2593 if (fcfg1_depart
!= 0xf && fcfg1_depart
!= 0)
2594 use_block_cmd
= false;
2597 if (use_block_cmd
) {
2598 /* check if whole bank is blank */
2599 result
= kinetis_ftfx_command(bank
->target
, FTFx_CMD_BLOCKSTAT
, k_bank
->prog_base
,
2600 0, 0, 0, 0, 0, 0, 0, 0, &ftfx_fstat
);
2602 if (result
!= ERROR_OK
)
2603 kinetis_ftfx_clear_error(bank
->target
);
2604 else if ((ftfx_fstat
& 0x01) == 0)
2605 block_dirty
= false;
2609 /* the whole bank is not erased, check sector-by-sector */
2611 for (i
= 0; i
< bank
->num_sectors
; i
++) {
2613 result
= kinetis_ftfx_command(bank
->target
, FTFx_CMD_SECTSTAT
,
2614 k_bank
->prog_base
+ bank
->sectors
[i
].offset
,
2615 1, 0, 0, 0, 0, 0, 0, 0, &ftfx_fstat
);
2617 if (result
== ERROR_OK
) {
2618 bank
->sectors
[i
].is_erased
= !(ftfx_fstat
& 0x01);
2620 LOG_DEBUG("Ignoring errored PFlash sector blank-check");
2621 kinetis_ftfx_clear_error(bank
->target
);
2622 bank
->sectors
[i
].is_erased
= -1;
2626 /* the whole bank is erased, update all sectors */
2628 for (i
= 0; i
< bank
->num_sectors
; i
++)
2629 bank
->sectors
[i
].is_erased
= 1;
2632 LOG_WARNING("kinetis_blank_check not supported yet for FlexRAM");
2633 return ERROR_FLASH_OPERATION_FAILED
;
2640 COMMAND_HANDLER(kinetis_nvm_partition
)
2644 unsigned num_blocks
, first_nvm_bank
;
2645 unsigned long par
, log2
= 0, ee1
= 0, ee2
= 0;
2646 enum { SHOW_INFO
, DF_SIZE
, EEBKP_SIZE
} sz_type
= SHOW_INFO
;
2648 uint8_t load_flex_ram
= 1;
2649 uint8_t ee_size_code
= 0x3f;
2650 uint8_t flex_nvm_partition_code
= 0;
2651 uint8_t ee_split
= 3;
2652 struct target
*target
= get_current_target(CMD_CTX
);
2653 struct kinetis_chip
*k_chip
;
2656 if (CMD_ARGC
>= 2) {
2657 if (strcmp(CMD_ARGV
[0], "dataflash") == 0)
2659 else if (strcmp(CMD_ARGV
[0], "eebkp") == 0)
2660 sz_type
= EEBKP_SIZE
;
2662 par
= strtoul(CMD_ARGV
[1], NULL
, 10);
2663 while (par
>> (log2
+ 3))
2668 result
= target_read_u32(target
, SIM_FCFG1
, &sim_fcfg1
);
2669 if (result
!= ERROR_OK
)
2672 flex_nvm_partition_code
= (uint8_t)((sim_fcfg1
>> 8) & 0x0f);
2673 switch (flex_nvm_partition_code
) {
2675 command_print(CMD_CTX
, "No EEPROM backup, data flash only");
2683 command_print(CMD_CTX
, "EEPROM backup %d KB", 4 << flex_nvm_partition_code
);
2686 command_print(CMD_CTX
, "No data flash, EEPROM backup only");
2694 command_print(CMD_CTX
, "data flash %d KB", 4 << (flex_nvm_partition_code
& 7));
2697 command_print(CMD_CTX
, "No EEPROM backup, data flash only (DEPART not set)");
2700 command_print(CMD_CTX
, "Unsupported EEPROM backup size code 0x%02" PRIx8
, flex_nvm_partition_code
);
2705 flex_nvm_partition_code
= 0x8 | log2
;
2709 flex_nvm_partition_code
= log2
;
2714 ee1
= ee2
= strtoul(CMD_ARGV
[2], NULL
, 10) / 2;
2715 else if (CMD_ARGC
>= 4) {
2716 ee1
= strtoul(CMD_ARGV
[2], NULL
, 10);
2717 ee2
= strtoul(CMD_ARGV
[3], NULL
, 10);
2720 enable
= ee1
+ ee2
> 0;
2722 for (log2
= 2; ; log2
++) {
2723 if (ee1
+ ee2
== (16u << 10) >> log2
)
2725 if (ee1
+ ee2
> (16u << 10) >> log2
|| log2
>= 9) {
2726 LOG_ERROR("Unsupported EEPROM size");
2727 return ERROR_FLASH_OPERATION_FAILED
;
2733 else if (ee1
* 7 == ee2
)
2735 else if (ee1
!= ee2
) {
2736 LOG_ERROR("Unsupported EEPROM sizes ratio");
2737 return ERROR_FLASH_OPERATION_FAILED
;
2740 ee_size_code
= log2
| ee_split
<< 4;
2744 COMMAND_PARSE_ON_OFF(CMD_ARGV
[4], enable
);
2748 LOG_INFO("DEPART 0x%" PRIx8
", EEPROM size code 0x%" PRIx8
,
2749 flex_nvm_partition_code
, ee_size_code
);
2751 result
= kinetis_check_run_mode(target
);
2752 if (result
!= ERROR_OK
)
2755 /* reset error flags */
2756 result
= kinetis_ftfx_prepare(target
);
2757 if (result
!= ERROR_OK
)
2760 result
= kinetis_ftfx_command(target
, FTFx_CMD_PGMPART
, load_flex_ram
,
2761 ee_size_code
, flex_nvm_partition_code
, 0, 0,
2763 if (result
!= ERROR_OK
)
2766 command_print(CMD_CTX
, "FlexNVM partition set. Please reset MCU.");
2768 k_chip
= kinetis_get_chip(target
);
2770 first_nvm_bank
= k_chip
->num_pflash_blocks
;
2771 num_blocks
= k_chip
->num_pflash_blocks
+ k_chip
->num_nvm_blocks
;
2772 for (bank_idx
= first_nvm_bank
; bank_idx
< num_blocks
; bank_idx
++)
2773 k_chip
->banks
[bank_idx
].probed
= false; /* re-probe before next use */
2774 k_chip
->probed
= false;
2777 command_print(CMD_CTX
, "FlexNVM banks will be re-probed to set new data flash size.");
2781 COMMAND_HANDLER(kinetis_fcf_source_handler
)
2784 return ERROR_COMMAND_SYNTAX_ERROR
;
2786 if (CMD_ARGC
== 1) {
2787 if (strcmp(CMD_ARGV
[0], "write") == 0)
2788 allow_fcf_writes
= true;
2789 else if (strcmp(CMD_ARGV
[0], "protection") == 0)
2790 allow_fcf_writes
= false;
2792 return ERROR_COMMAND_SYNTAX_ERROR
;
2795 if (allow_fcf_writes
) {
2796 command_print(CMD_CTX
, "Arbitrary Flash Configuration Field writes enabled.");
2797 command_print(CMD_CTX
, "Protection info writes to FCF disabled.");
2798 LOG_WARNING("BEWARE: incorrect flash configuration may permanently lock the device.");
2800 command_print(CMD_CTX
, "Protection info writes to Flash Configuration Field enabled.");
2801 command_print(CMD_CTX
, "Arbitrary FCF writes disabled. Mode safe from unwanted locking of the device.");
2807 COMMAND_HANDLER(kinetis_fopt_handler
)
2810 return ERROR_COMMAND_SYNTAX_ERROR
;
2813 fcf_fopt
= (uint8_t)strtoul(CMD_ARGV
[0], NULL
, 0);
2815 command_print(CMD_CTX
, "FCF_FOPT 0x%02" PRIx8
, fcf_fopt
);
2820 COMMAND_HANDLER(kinetis_create_banks_handler
)
2823 return ERROR_COMMAND_SYNTAX_ERROR
;
2825 create_banks
= true;
2831 static const struct command_registration kinetis_security_command_handlers
[] = {
2833 .name
= "check_security",
2834 .mode
= COMMAND_EXEC
,
2835 .help
= "Check status of device security lock",
2837 .handler
= kinetis_check_flash_security_status
,
2841 .mode
= COMMAND_EXEC
,
2842 .help
= "Issue a halt via the MDM-AP",
2844 .handler
= kinetis_mdm_halt
,
2847 .name
= "mass_erase",
2848 .mode
= COMMAND_EXEC
,
2849 .help
= "Issue a complete flash erase via the MDM-AP",
2851 .handler
= kinetis_mdm_mass_erase
,
2854 .mode
= COMMAND_EXEC
,
2855 .help
= "Issue a reset via the MDM-AP",
2857 .handler
= kinetis_mdm_reset
,
2859 COMMAND_REGISTRATION_DONE
2862 static const struct command_registration kinetis_exec_command_handlers
[] = {
2865 .mode
= COMMAND_ANY
,
2866 .help
= "MDM-AP command group",
2868 .chain
= kinetis_security_command_handlers
,
2871 .name
= "disable_wdog",
2872 .mode
= COMMAND_EXEC
,
2873 .help
= "Disable the watchdog timer",
2875 .handler
= kinetis_disable_wdog_handler
,
2878 .name
= "nvm_partition",
2879 .mode
= COMMAND_EXEC
,
2880 .help
= "Show/set data flash or EEPROM backup size in kilobytes,"
2881 " set two EEPROM sizes in bytes and FlexRAM loading during reset",
2882 .usage
= "('info'|'dataflash' size|'eebkp' size) [eesize1 eesize2] ['on'|'off']",
2883 .handler
= kinetis_nvm_partition
,
2886 .name
= "fcf_source",
2887 .mode
= COMMAND_EXEC
,
2888 .help
= "Use protection as a source for Flash Configuration Field or allow writing arbitrary values to the FCF"
2889 " Mode 'protection' is safe from unwanted locking of the device.",
2890 .usage
= "['protection'|'write']",
2891 .handler
= kinetis_fcf_source_handler
,
2895 .mode
= COMMAND_EXEC
,
2896 .help
= "FCF_FOPT value source in 'kinetis fcf_source protection' mode",
2898 .handler
= kinetis_fopt_handler
,
2901 .name
= "create_banks",
2902 .mode
= COMMAND_CONFIG
,
2903 .help
= "Driver creates additional banks if device with two/four flash blocks is probed",
2904 .handler
= kinetis_create_banks_handler
,
2906 COMMAND_REGISTRATION_DONE
2909 static const struct command_registration kinetis_command_handler
[] = {
2912 .mode
= COMMAND_ANY
,
2913 .help
= "Kinetis flash controller commands",
2915 .chain
= kinetis_exec_command_handlers
,
2917 COMMAND_REGISTRATION_DONE
2922 struct flash_driver kinetis_flash
= {
2924 .commands
= kinetis_command_handler
,
2925 .flash_bank_command
= kinetis_flash_bank_command
,
2926 .erase
= kinetis_erase
,
2927 .protect
= kinetis_protect
,
2928 .write
= kinetis_write
,
2929 .read
= default_flash_read
,
2930 .probe
= kinetis_probe
,
2931 .auto_probe
= kinetis_auto_probe
,
2932 .erase_check
= kinetis_blank_check
,
2933 .protect_check
= kinetis_protect_check
,
2934 .info
= kinetis_info
,