OpenOCD
kinetis.c
Go to the documentation of this file.
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 
3 /***************************************************************************
4  * Copyright (C) 2011 by Mathias Kuester *
5  * kesmtp@freenet.de *
6  * *
7  * Copyright (C) 2011 sleep(5) ltd *
8  * tomas@sleepfive.com *
9  * *
10  * Copyright (C) 2012 by Christopher D. Kilgour *
11  * techie at whiterocker.com *
12  * *
13  * Copyright (C) 2013 Nemui Trinomius *
14  * nemuisan_kawausogasuki@live.jp *
15  * *
16  * Copyright (C) 2015 Tomas Vanek *
17  * vanekt@fbl.cz *
18  ***************************************************************************/
19 
20 #ifdef HAVE_CONFIG_H
21 #include "config.h"
22 #endif
23 
24 #include "jtag/interface.h"
25 #include "imp.h"
26 #include <helper/binarybuffer.h>
27 #include <helper/time_support.h>
28 #include <target/target_type.h>
29 #include <target/algorithm.h>
30 #include <target/arm_adi_v5.h>
31 #include <target/armv7m.h>
32 #include <target/cortex_m.h>
33 
34 /*
35  * Implementation Notes
36  *
37  * The persistent memories in the Kinetis chip families K10 through
38  * K70 are all manipulated with the Flash Memory Module. Some
39  * variants call this module the FTFE, others call it the FTFL. To
40  * indicate that both are considered here, we use FTFX.
41  *
42  * Within the module, according to the chip variant, the persistent
43  * memory is divided into what Freescale terms Program Flash, FlexNVM,
44  * and FlexRAM. All chip variants have Program Flash. Some chip
45  * variants also have FlexNVM and FlexRAM, which always appear
46  * together.
47  *
48  * A given Kinetis chip may have 1, 2 or 4 blocks of flash. Here we map
49  * each block to a separate bank. Each block size varies by chip and
50  * may be determined by the read-only SIM_FCFG1 register. The sector
51  * size within each bank/block varies by chip, and may be 1, 2 or 4k.
52  * The sector size may be different for flash and FlexNVM.
53  *
54  * The first half of the flash (1 or 2 blocks) is always Program Flash
55  * and always starts at address 0x00000000. The "PFLSH" flag, bit 23
56  * of the read-only SIM_FCFG2 register, determines whether the second
57  * half of the flash is also Program Flash or FlexNVM+FlexRAM. When
58  * PFLSH is set, the second from the first half. When PFLSH is clear,
59  * the second half of flash is FlexNVM and always starts at address
60  * 0x10000000. FlexRAM, which is also present when PFLSH is clear,
61  * always starts at address 0x14000000.
62  *
63  * The Flash Memory Module provides a register set where flash
64  * commands are loaded to perform flash operations like erase and
65  * program. Different commands are available depending on whether
66  * Program Flash or FlexNVM/FlexRAM is being manipulated. Although
67  * the commands used are quite consistent between flash blocks, the
68  * parameters they accept differ according to the flash sector size.
69  *
70  */
71 
72 /* Addresses */
73 #define FCF_ADDRESS 0x00000400
74 #define FCF_FPROT 0x8
75 #define FCF_FSEC 0xc
76 #define FCF_FOPT 0xd
77 #define FCF_FDPROT 0xf
78 #define FCF_SIZE 0x10
79 
80 #define FLEXRAM 0x14000000
81 
82 #define MSCM_OCMDR0 0x40001400
83 #define MSCM_OCMDR1 0x40001404
84 #define FMC_PFB01CR 0x4001f004
85 #define FTFX_FSTAT 0x40020000
86 #define FTFX_FCNFG 0x40020001
87 #define FTFX_FCCOB3 0x40020004
88 #define FTFX_FPROT3 0x40020010
89 #define FTFX_FDPROT 0x40020017
90 #define SIM_BASE 0x40047000
91 #define SIM_BASE_KL28 0x40074000
92 #define SIM_COPC 0x40048100
93  /* SIM_COPC does not exist on devices with changed SIM_BASE */
94 #define WDOG_BASE 0x40052000
95 #define WDOG32_KE1X 0x40052000
96 #define WDOG32_KL28 0x40076000
97 #define SMC_PMCTRL 0x4007E001
98 #define SMC_PMSTAT 0x4007E003
99 #define SMC32_PMCTRL 0x4007E00C
100 #define SMC32_PMSTAT 0x4007E014
101 #define PMC_REGSC 0x4007D002
102 #define MC_PMCTRL 0x4007E003
103 #define MCM_PLACR 0xF000300C
104 
105 /* Offsets */
106 #define SIM_SOPT1_OFFSET 0x0000
107 #define SIM_SDID_OFFSET 0x1024
108 #define SIM_FCFG1_OFFSET 0x104c
109 #define SIM_FCFG2_OFFSET 0x1050
110 
111 #define WDOG_STCTRLH_OFFSET 0
112 #define WDOG32_CS_OFFSET 0
113 
114 /* Values */
115 #define PM_STAT_RUN 0x01
116 #define PM_STAT_VLPR 0x04
117 #define PM_CTRL_RUNM_RUN 0x00
118 
119 /* Commands */
120 #define FTFX_CMD_BLOCKSTAT 0x00
121 #define FTFX_CMD_SECTSTAT 0x01
122 #define FTFX_CMD_LWORDPROG 0x06
123 #define FTFX_CMD_SECTERASE 0x09
124 #define FTFX_CMD_SECTWRITE 0x0b
125 #define FTFX_CMD_MASSERASE 0x44
126 #define FTFX_CMD_PGMPART 0x80
127 #define FTFX_CMD_SETFLEXRAM 0x81
128 
129 /* The older Kinetis K series uses the following SDID layout :
130  * Bit 31-16 : 0
131  * Bit 15-12 : REVID
132  * Bit 11-7 : DIEID
133  * Bit 6-4 : FAMID
134  * Bit 3-0 : PINID
135  *
136  * The newer Kinetis series uses the following SDID layout :
137  * Bit 31-28 : FAMID
138  * Bit 27-24 : SUBFAMID
139  * Bit 23-20 : SERIESID
140  * Bit 19-16 : SRAMSIZE
141  * Bit 15-12 : REVID
142  * Bit 6-4 : Reserved (0)
143  * Bit 3-0 : PINID
144  *
145  * We assume that if bits 31-16 are 0 then it's an older
146  * K-series MCU.
147  */
148 
149 #define KINETIS_SOPT1_RAMSIZE_MASK 0x0000F000
150 #define KINETIS_SOPT1_RAMSIZE_K24FN1M 0x0000B000
151 
152 #define KINETIS_SDID_K_SERIES_MASK 0x0000FFFF
153 
154 #define KINETIS_SDID_DIEID_MASK 0x00000F80
155 
156 #define KINETIS_SDID_DIEID_K22FN128 0x00000680 /* smaller pflash with FTFA */
157 #define KINETIS_SDID_DIEID_K22FN256 0x00000A80
158 #define KINETIS_SDID_DIEID_K22FN512 0x00000E80
159 #define KINETIS_SDID_DIEID_K24FN256 0x00000700
160 
161 #define KINETIS_SDID_DIEID_K24FN1M 0x00000300 /* Detect Errata 7534 */
162 
163 /* We can't rely solely on the FAMID field to determine the MCU
164  * type since some FAMID values identify multiple MCUs with
165  * different flash sector sizes (K20 and K22 for instance).
166  * Therefore we combine it with the DIEID bits which may possibly
167  * break if Freescale bumps the DIEID for a particular MCU. */
168 #define KINETIS_K_SDID_TYPE_MASK 0x00000FF0
169 #define KINETIS_K_SDID_K10_M50 0x00000000
170 #define KINETIS_K_SDID_K10_M72 0x00000080
171 #define KINETIS_K_SDID_K10_M100 0x00000100
172 #define KINETIS_K_SDID_K10_M120 0x00000180
173 #define KINETIS_K_SDID_K11 0x00000220
174 #define KINETIS_K_SDID_K12 0x00000200
175 #define KINETIS_K_SDID_K20_M50 0x00000010
176 #define KINETIS_K_SDID_K20_M72 0x00000090
177 #define KINETIS_K_SDID_K20_M100 0x00000110
178 #define KINETIS_K_SDID_K20_M120 0x00000190
179 #define KINETIS_K_SDID_K21_M50 0x00000230
180 #define KINETIS_K_SDID_K21_M120 0x00000330
181 #define KINETIS_K_SDID_K22_M50 0x00000210
182 #define KINETIS_K_SDID_K22_M120 0x00000310
183 #define KINETIS_K_SDID_K30_M72 0x000000A0
184 #define KINETIS_K_SDID_K30_M100 0x00000120
185 #define KINETIS_K_SDID_K40_M72 0x000000B0
186 #define KINETIS_K_SDID_K40_M100 0x00000130
187 #define KINETIS_K_SDID_K50_M72 0x000000E0
188 #define KINETIS_K_SDID_K51_M72 0x000000F0
189 #define KINETIS_K_SDID_K53 0x00000170
190 #define KINETIS_K_SDID_K60_M100 0x00000140
191 #define KINETIS_K_SDID_K60_M150 0x000001C0
192 #define KINETIS_K_SDID_K70_M150 0x000001D0
193 
194 #define KINETIS_K_REVID_MASK 0x0000F000
195 #define KINETIS_K_REVID_SHIFT 12
196 
197 #define KINETIS_SDID_SERIESID_MASK 0x00F00000
198 #define KINETIS_SDID_SERIESID_K 0x00000000
199 #define KINETIS_SDID_SERIESID_KL 0x00100000
200 #define KINETIS_SDID_SERIESID_KE 0x00200000
201 #define KINETIS_SDID_SERIESID_KW 0x00500000
202 #define KINETIS_SDID_SERIESID_KV 0x00600000
203 
204 #define KINETIS_SDID_SUBFAMID_SHIFT 24
205 #define KINETIS_SDID_SUBFAMID_MASK 0x0F000000
206 #define KINETIS_SDID_SUBFAMID_KX0 0x00000000
207 #define KINETIS_SDID_SUBFAMID_KX1 0x01000000
208 #define KINETIS_SDID_SUBFAMID_KX2 0x02000000
209 #define KINETIS_SDID_SUBFAMID_KX3 0x03000000
210 #define KINETIS_SDID_SUBFAMID_KX4 0x04000000
211 #define KINETIS_SDID_SUBFAMID_KX5 0x05000000
212 #define KINETIS_SDID_SUBFAMID_KX6 0x06000000
213 #define KINETIS_SDID_SUBFAMID_KX7 0x07000000
214 #define KINETIS_SDID_SUBFAMID_KX8 0x08000000
215 
216 #define KINETIS_SDID_FAMILYID_SHIFT 28
217 #define KINETIS_SDID_FAMILYID_MASK 0xF0000000
218 #define KINETIS_SDID_FAMILYID_K0X 0x00000000
219 #define KINETIS_SDID_FAMILYID_K1X 0x10000000
220 #define KINETIS_SDID_FAMILYID_K2X 0x20000000
221 #define KINETIS_SDID_FAMILYID_K3X 0x30000000
222 #define KINETIS_SDID_FAMILYID_K4X 0x40000000
223 #define KINETIS_SDID_FAMILYID_K5X 0x50000000
224 #define KINETIS_SDID_FAMILYID_K6X 0x60000000
225 #define KINETIS_SDID_FAMILYID_K7X 0x70000000
226 #define KINETIS_SDID_FAMILYID_K8X 0x80000000
227 #define KINETIS_SDID_FAMILYID_KL8X 0x90000000
228 
229 /* The field originally named DIEID has new name/meaning on KE1x */
230 #define KINETIS_SDID_PROJECTID_MASK KINETIS_SDID_DIEID_MASK
231 #define KINETIS_SDID_PROJECTID_KE1XF 0x00000080
232 #define KINETIS_SDID_PROJECTID_KE1XZ 0x00000100
233 
234 /* The S32K series uses a different, incompatible SDID layout :
235  * Bit 31-28 : GENERATION
236  * Bit 27-24 : SUBSERIES
237  * Bit 23-20 : DERIVATE
238  * Bit 19-16 : RAMSIZE
239  * Bit 15-12 : REVID
240  * Bit 11-8 : PACKAGE
241  * Bit 7-0 : FEATURES
242  */
243 
244 #define KINETIS_SDID_S32K_SERIES_MASK 0xFF000000 /* GENERATION + SUBSERIES */
245 #define KINETIS_SDID_S32K_SERIES_K11X 0x11000000
246 #define KINETIS_SDID_S32K_SERIES_K14X 0x14000000
247 
248 #define KINETIS_SDID_S32K_DERIVATE_MASK 0x00F00000
249 #define KINETIS_SDID_S32K_DERIVATE_KXX2 0x00200000
250 #define KINETIS_SDID_S32K_DERIVATE_KXX3 0x00300000
251 #define KINETIS_SDID_S32K_DERIVATE_KXX4 0x00400000
252 #define KINETIS_SDID_S32K_DERIVATE_KXX5 0x00500000
253 #define KINETIS_SDID_S32K_DERIVATE_KXX6 0x00600000
254 #define KINETIS_SDID_S32K_DERIVATE_KXX8 0x00800000
255 
256 #define KINETIS_SDID_S32K_FEATURE_CSEC 0x00000080
257 
260  bool probed;
261  unsigned int bank_number; /* bank number in particular chip */
262  struct flash_bank *bank;
263 
264  uint32_t sector_size;
265  uint32_t protection_size;
266  uint32_t prog_base; /* base address for FTFx operations */
267  /* usually same as bank->base for pflash, differs for FlexNVM */
268  uint32_t protection_block; /* number of first protection block in this bank */
269 
270  enum {
271  FC_AUTO = 0,
276 };
277 
278 #define KINETIS_MAX_BANKS 4u
279 
283 };
284 
285 struct kinetis_chip {
286  struct target *target;
287  bool probed;
288 
289  uint32_t sim_sdid;
290  uint32_t sim_fcfg1;
291  uint32_t sim_fcfg2;
294 
297  unsigned int max_flash_prog_size;
298 
299  uint32_t pflash_base;
300  uint32_t pflash_size;
301  uint32_t nvm_base;
302  uint32_t nvm_size; /* whole FlexNVM */
303  uint32_t dflash_size; /* accessible rest of FlexNVM if EEPROM backup uses part of FlexNVM */
304 
305  uint32_t progr_accel_ram;
306  uint32_t sim_base;
307 
309 
310  enum {
313  FS_PROGRAM_PHRASE = 4, /* Unsupported */
314 
317  FS_ECC = 0x100,
319 
320  enum {
322  KINETIS_CACHE_K, /* invalidate using FMC->PFB0CR/PFB01CR */
323  KINETIS_CACHE_L, /* invalidate using MCM->PLACR */
324  KINETIS_CACHE_MSCM, /* devices like KE1xF, invalidate MSCM->OCMDR0 */
325  KINETIS_CACHE_MSCM2, /* devices like S32K, invalidate MSCM->OCMDR0 and MSCM->OCMDR1 */
327 
328  enum {
335 
336  enum {
341 
342  char name[40];
343 
344  unsigned int num_banks;
346 };
347 
348 struct kinetis_type {
349  uint32_t sdid;
350  char *name;
351 };
352 
353 static const struct kinetis_type kinetis_types_old[] = {
354  { KINETIS_K_SDID_K10_M50, "MK10D%s5" },
355  { KINETIS_K_SDID_K10_M72, "MK10D%s7" },
356  { KINETIS_K_SDID_K10_M100, "MK10D%s10" },
357  { KINETIS_K_SDID_K10_M120, "MK10F%s12" },
358  { KINETIS_K_SDID_K11, "MK11D%s5" },
359  { KINETIS_K_SDID_K12, "MK12D%s5" },
360 
361  { KINETIS_K_SDID_K20_M50, "MK20D%s5" },
362  { KINETIS_K_SDID_K20_M72, "MK20D%s7" },
363  { KINETIS_K_SDID_K20_M100, "MK20D%s10" },
364  { KINETIS_K_SDID_K20_M120, "MK20F%s12" },
365  { KINETIS_K_SDID_K21_M50, "MK21D%s5" },
366  { KINETIS_K_SDID_K21_M120, "MK21F%s12" },
367  { KINETIS_K_SDID_K22_M50, "MK22D%s5" },
368  { KINETIS_K_SDID_K22_M120, "MK22F%s12" },
369 
370  { KINETIS_K_SDID_K30_M72, "MK30D%s7" },
371  { KINETIS_K_SDID_K30_M100, "MK30D%s10" },
372 
373  { KINETIS_K_SDID_K40_M72, "MK40D%s7" },
374  { KINETIS_K_SDID_K40_M100, "MK40D%s10" },
375 
376  { KINETIS_K_SDID_K50_M72, "MK50D%s7" },
377  { KINETIS_K_SDID_K51_M72, "MK51D%s7" },
378  { KINETIS_K_SDID_K53, "MK53D%s10" },
379 
380  { KINETIS_K_SDID_K60_M100, "MK60D%s10" },
381  { KINETIS_K_SDID_K60_M150, "MK60F%s15" },
382 
383  { KINETIS_K_SDID_K70_M150, "MK70F%s15" },
384 };
385 
386 
387 #define MDM_AP 1
388 
389 #define MDM_REG_STAT 0x00
390 #define MDM_REG_CTRL 0x04
391 #define MDM_REG_ID 0xfc
392 
393 #define MDM_STAT_FMEACK (1<<0)
394 #define MDM_STAT_FREADY (1<<1)
395 #define MDM_STAT_SYSSEC (1<<2)
396 #define MDM_STAT_SYSRES (1<<3)
397 #define MDM_STAT_FMEEN (1<<5)
398 #define MDM_STAT_BACKDOOREN (1<<6)
399 #define MDM_STAT_LPEN (1<<7)
400 #define MDM_STAT_VLPEN (1<<8)
401 #define MDM_STAT_LLSMODEXIT (1<<9)
402 #define MDM_STAT_VLLSXMODEXIT (1<<10)
403 #define MDM_STAT_CORE_HALTED (1<<16)
404 #define MDM_STAT_CORE_SLEEPDEEP (1<<17)
405 #define MDM_STAT_CORESLEEPING (1<<18)
406 
407 #define MDM_CTRL_FMEIP (1<<0)
408 #define MDM_CTRL_DBG_DIS (1<<1)
409 #define MDM_CTRL_DBG_REQ (1<<2)
410 #define MDM_CTRL_SYS_RES_REQ (1<<3)
411 #define MDM_CTRL_CORE_HOLD_RES (1<<4)
412 #define MDM_CTRL_VLLSX_DBG_REQ (1<<5)
413 #define MDM_CTRL_VLLSX_DBG_ACK (1<<6)
414 #define MDM_CTRL_VLLSX_STAT_ACK (1<<7)
415 
416 #define MDM_ACCESS_TIMEOUT 500 /* msec */
417 
418 
419 static bool allow_fcf_writes;
420 static uint8_t fcf_fopt = 0xff;
421 static bool create_banks;
422 
423 
424 const struct flash_driver kinetis_flash;
425 static int kinetis_write_inner(struct flash_bank *bank, const uint8_t *buffer,
426  uint32_t offset, uint32_t count);
427 static int kinetis_probe_chip(struct kinetis_chip *k_chip);
428 static int kinetis_probe_chip_s32k(struct kinetis_chip *k_chip);
429 static int kinetis_auto_probe(struct flash_bank *bank);
430 
431 
432 static int kinetis_mdm_write_register(struct adiv5_dap *dap, unsigned int reg, uint32_t value)
433 {
434  LOG_DEBUG("MDM_REG[0x%02x] <- %08" PRIX32, reg, value);
435 
436  struct adiv5_ap *ap = dap_get_ap(dap, MDM_AP);
437  if (!ap) {
438  LOG_DEBUG("MDM: failed to get AP");
439  return ERROR_FAIL;
440  }
441 
442  int retval = dap_queue_ap_write(ap, reg, value);
443  if (retval != ERROR_OK) {
444  LOG_DEBUG("MDM: failed to queue a write request");
445  dap_put_ap(ap);
446  return retval;
447  }
448 
449  retval = dap_run(dap);
450  dap_put_ap(ap);
451  if (retval != ERROR_OK) {
452  LOG_DEBUG("MDM: dap_run failed");
453  return retval;
454  }
455 
456 
457  return ERROR_OK;
458 }
459 
460 static int kinetis_mdm_read_register(struct adiv5_dap *dap, unsigned int reg, uint32_t *result)
461 {
462  struct adiv5_ap *ap = dap_get_ap(dap, MDM_AP);
463  if (!ap) {
464  LOG_DEBUG("MDM: failed to get AP");
465  return ERROR_FAIL;
466  }
467 
468  int retval = dap_queue_ap_read(ap, reg, result);
469  if (retval != ERROR_OK) {
470  LOG_DEBUG("MDM: failed to queue a read request");
471  dap_put_ap(ap);
472  return retval;
473  }
474 
475  retval = dap_run(dap);
476  dap_put_ap(ap);
477  if (retval != ERROR_OK) {
478  LOG_DEBUG("MDM: dap_run failed");
479  return retval;
480  }
481 
482  LOG_DEBUG("MDM_REG[0x%02x]: %08" PRIX32, reg, *result);
483  return ERROR_OK;
484 }
485 
486 static int kinetis_mdm_poll_register(struct adiv5_dap *dap, unsigned int reg,
487  uint32_t mask, uint32_t value, uint32_t timeout_ms)
488 {
489  uint32_t val;
490  int retval;
491  int64_t ms_timeout = timeval_ms() + timeout_ms;
492 
493  do {
494  retval = kinetis_mdm_read_register(dap, reg, &val);
495  if (retval != ERROR_OK || (val & mask) == value)
496  return retval;
497 
498  alive_sleep(1);
499  } while (timeval_ms() < ms_timeout);
500 
501  LOG_DEBUG("MDM: polling timed out");
502  return ERROR_FAIL;
503 }
504 
505 /*
506  * This command can be used to break a watchdog reset loop when
507  * connecting to an unsecured target. Unlike other commands, halt will
508  * automatically retry as it does not know how far into the boot process
509  * it is when the command is called.
510  */
511 COMMAND_HANDLER(kinetis_mdm_halt)
512 {
514  struct cortex_m_common *cortex_m = target_to_cm(target);
515  struct adiv5_dap *dap = cortex_m->armv7m.arm.dap;
516  int retval;
517  int tries = 0;
518  uint32_t stat;
519  int64_t ms_timeout = timeval_ms() + MDM_ACCESS_TIMEOUT;
520 
521  if (!dap) {
522  LOG_ERROR("Cannot perform halt with a high-level adapter");
523  return ERROR_FAIL;
524  }
525 
526  while (true) {
527  tries++;
528 
530 
531  alive_sleep(1);
532 
533  retval = kinetis_mdm_read_register(dap, MDM_REG_STAT, &stat);
534  if (retval != ERROR_OK) {
535  LOG_DEBUG("MDM: failed to read MDM_REG_STAT");
536  continue;
537  }
538 
539  /* Repeat setting MDM_CTRL_CORE_HOLD_RES until system is out of
540  * reset with flash ready and without security
541  */
544  break;
545 
546  if (timeval_ms() >= ms_timeout) {
547  LOG_ERROR("MDM: halt timed out");
548  return ERROR_FAIL;
549  }
550  }
551 
552  LOG_DEBUG("MDM: halt succeeded after %d attempts.", tries);
553 
555  /* enable polling in case kinetis_check_flash_security_status disabled it */
556  jtag_poll_set_enabled(true);
557 
558  alive_sleep(100);
559 
560  target->reset_halt = true;
562 
563  retval = kinetis_mdm_write_register(dap, MDM_REG_CTRL, 0);
564  if (retval != ERROR_OK) {
565  LOG_ERROR("MDM: failed to clear MDM_REG_CTRL");
566  return retval;
567  }
568 
570 
571  return ERROR_OK;
572 }
573 
574 COMMAND_HANDLER(kinetis_mdm_reset)
575 {
577  struct cortex_m_common *cortex_m = target_to_cm(target);
578  struct adiv5_dap *dap = cortex_m->armv7m.arm.dap;
579  int retval;
580 
581  if (!dap) {
582  LOG_ERROR("Cannot perform reset with a high-level adapter");
583  return ERROR_FAIL;
584  }
585 
587  if (retval != ERROR_OK) {
588  LOG_ERROR("MDM: failed to write MDM_REG_CTRL");
589  return retval;
590  }
591 
593  if (retval != ERROR_OK) {
594  LOG_ERROR("MDM: failed to assert reset");
595  return retval;
596  }
597 
598  retval = kinetis_mdm_write_register(dap, MDM_REG_CTRL, 0);
599  if (retval != ERROR_OK) {
600  LOG_ERROR("MDM: failed to clear MDM_REG_CTRL");
601  return retval;
602  }
603 
604  return ERROR_OK;
605 }
606 
607 /*
608  * This function implements the procedure to mass erase the flash via
609  * SWD/JTAG on Kinetis K and L series of devices as it is described in
610  * AN4835 "Production Flash Programming Best Practices for Kinetis K-
611  * and L-series MCUs" Section 4.2.1. To prevent a watchdog reset loop,
612  * the core remains halted after this function completes as suggested
613  * by the application note.
614  */
615 COMMAND_HANDLER(kinetis_mdm_mass_erase)
616 {
618  struct cortex_m_common *cortex_m = target_to_cm(target);
619  struct adiv5_dap *dap = cortex_m->armv7m.arm.dap;
620 
621  if (!dap) {
622  LOG_ERROR("Cannot perform mass erase with a high-level adapter");
623  return ERROR_FAIL;
624  }
625 
626  int retval;
627 
628  /*
629  * ... Power on the processor, or if power has already been
630  * applied, assert the RESET pin to reset the processor. For
631  * devices that do not have a RESET pin, write the System
632  * Reset Request bit in the MDM-AP control register after
633  * establishing communication...
634  */
635 
636  /* assert SRST if configured */
637  bool has_srst = jtag_get_reset_config() & RESET_HAS_SRST;
638  if (has_srst)
640 
642  if (retval != ERROR_OK && !has_srst) {
643  LOG_ERROR("MDM: failed to assert reset");
644  goto deassert_reset_and_exit;
645  }
646 
647  /*
648  * ... Read the MDM-AP status register repeatedly and wait for
649  * stable conditions suitable for mass erase:
650  * - mass erase is enabled
651  * - flash is ready
652  * - reset is finished
653  *
654  * Mass erase is started as soon as all conditions are met in 32
655  * subsequent status reads.
656  *
657  * In case of not stable conditions (RESET/WDOG loop in secured device)
658  * the user is asked for manual pressing of RESET button
659  * as a last resort.
660  */
661  int cnt_mass_erase_disabled = 0;
662  int cnt_ready = 0;
663  int64_t ms_start = timeval_ms();
664  bool man_reset_requested = false;
665 
666  do {
667  uint32_t stat = 0;
668  int64_t ms_elapsed = timeval_ms() - ms_start;
669 
670  if (!man_reset_requested && ms_elapsed > 100) {
671  LOG_INFO("MDM: Press RESET button now if possible.");
672  man_reset_requested = true;
673  }
674 
675  if (ms_elapsed > 3000) {
676  LOG_ERROR("MDM: waiting for mass erase conditions timed out.");
677  LOG_INFO("Mass erase of a secured MCU is not possible without hardware reset.");
678  LOG_INFO("Connect SRST, use 'reset_config srst_only' and retry.");
679  goto deassert_reset_and_exit;
680  }
681  retval = kinetis_mdm_read_register(dap, MDM_REG_STAT, &stat);
682  if (retval != ERROR_OK) {
683  cnt_ready = 0;
684  continue;
685  }
686 
687  if (!(stat & MDM_STAT_FMEEN)) {
688  cnt_ready = 0;
689  cnt_mass_erase_disabled++;
690  if (cnt_mass_erase_disabled > 10) {
691  LOG_ERROR("MDM: mass erase is disabled");
692  goto deassert_reset_and_exit;
693  }
694  continue;
695  }
696 
697  if ((stat & (MDM_STAT_FREADY | MDM_STAT_SYSRES)) == MDM_STAT_FREADY)
698  cnt_ready++;
699  else
700  cnt_ready = 0;
701 
702  } while (cnt_ready < 32);
703 
704  /*
705  * ... Write the MDM-AP control register to set the Flash Mass
706  * Erase in Progress bit. This will start the mass erase
707  * process...
708  */
710  if (retval != ERROR_OK) {
711  LOG_ERROR("MDM: failed to start mass erase");
712  goto deassert_reset_and_exit;
713  }
714 
715  /*
716  * ... Read the MDM-AP control register until the Flash Mass
717  * Erase in Progress bit clears...
718  * Data sheed defines erase time <3.6 sec/512kB flash block.
719  * The biggest device has 4 pflash blocks => timeout 16 sec.
720  */
721  retval = kinetis_mdm_poll_register(dap, MDM_REG_CTRL, MDM_CTRL_FMEIP, 0, 16000);
722  if (retval != ERROR_OK) {
723  LOG_ERROR("MDM: mass erase timeout");
724  goto deassert_reset_and_exit;
725  }
726 
728  /* enable polling in case kinetis_check_flash_security_status disabled it */
729  jtag_poll_set_enabled(true);
730 
731  alive_sleep(100);
732 
733  target->reset_halt = true;
735 
736  /*
737  * ... Negate the RESET signal or clear the System Reset Request
738  * bit in the MDM-AP control register.
739  */
740  retval = kinetis_mdm_write_register(dap, MDM_REG_CTRL, 0);
741  if (retval != ERROR_OK)
742  LOG_ERROR("MDM: failed to clear MDM_REG_CTRL");
743 
745 
746  return retval;
747 
748 deassert_reset_and_exit:
750  if (has_srst)
752  return retval;
753 }
754 
755 static const uint32_t kinetis_known_mdm_ids[] = {
756  0x001C0000, /* Kinetis-K Series */
757  0x001C0020, /* Kinetis-L/M/V/E Series */
758  0x001C0030, /* Kinetis with a Cortex-M7, in time of writing KV58 */
759 };
760 
761 /*
762  * This function implements the procedure to connect to
763  * SWD/JTAG on Kinetis K and L series of devices as it is described in
764  * AN4835 "Production Flash Programming Best Practices for Kinetis K-
765  * and L-series MCUs" Section 4.1.1
766  */
767 COMMAND_HANDLER(kinetis_check_flash_security_status)
768 {
770  struct cortex_m_common *cortex_m = target_to_cm(target);
771  struct adiv5_dap *dap = cortex_m->armv7m.arm.dap;
772 
773  if (!dap) {
774  LOG_WARNING("Cannot check flash security status with a high-level adapter");
775  return ERROR_OK;
776  }
777 
778  if (!dap->ops)
779  return ERROR_OK; /* too early to check, in JTAG mode ops may not be initialised */
780 
781  uint32_t val;
782  int retval;
783 
784  /*
785  * ... The MDM-AP ID register can be read to verify that the
786  * connection is working correctly...
787  */
788  retval = kinetis_mdm_read_register(dap, MDM_REG_ID, &val);
789  if (retval != ERROR_OK) {
790  LOG_ERROR("MDM: failed to read ID register");
791  return ERROR_OK;
792  }
793 
794  if (val == 0)
795  return ERROR_OK; /* dap not yet initialised */
796 
797  bool found = false;
798  for (size_t i = 0; i < ARRAY_SIZE(kinetis_known_mdm_ids); i++) {
799  if (val == kinetis_known_mdm_ids[i]) {
800  found = true;
801  break;
802  }
803  }
804 
805  if (!found)
806  LOG_WARNING("MDM: unknown ID %08" PRIX32, val);
807 
808  /*
809  * ... Read the System Security bit to determine if security is enabled.
810  * If System Security = 0, then proceed. If System Security = 1, then
811  * communication with the internals of the processor, including the
812  * flash, will not be possible without issuing a mass erase command or
813  * unsecuring the part through other means (backdoor key unlock)...
814  */
815  retval = kinetis_mdm_read_register(dap, MDM_REG_STAT, &val);
816  if (retval != ERROR_OK) {
817  LOG_ERROR("MDM: failed to read MDM_REG_STAT");
818  return ERROR_OK;
819  }
820 
821  /*
822  * System Security bit is also active for short time during reset.
823  * If a MCU has blank flash and runs in RESET/WDOG loop,
824  * System Security bit is active most of time!
825  * We should observe Flash Ready bit and read status several times
826  * to avoid false detection of secured MCU
827  */
828  int secured_score = 0, flash_not_ready_score = 0;
829 
830  if ((val & (MDM_STAT_SYSSEC | MDM_STAT_FREADY)) != MDM_STAT_FREADY) {
831  uint32_t stats[32];
832  struct adiv5_ap *ap = dap_get_ap(dap, MDM_AP);
833  if (!ap) {
834  LOG_ERROR("MDM: failed to get AP");
835  return ERROR_OK;
836  }
837 
838  for (unsigned int i = 0; i < 32; i++) {
839  stats[i] = MDM_STAT_FREADY;
840  dap_queue_ap_read(ap, MDM_REG_STAT, &stats[i]);
841  }
842  retval = dap_run(dap);
843  dap_put_ap(ap);
844  if (retval != ERROR_OK) {
845  LOG_DEBUG("MDM: dap_run failed when validating secured state");
846  return ERROR_OK;
847  }
848  for (unsigned int i = 0; i < 32; i++) {
849  if (stats[i] & MDM_STAT_SYSSEC)
850  secured_score++;
851  if (!(stats[i] & MDM_STAT_FREADY))
852  flash_not_ready_score++;
853  }
854  }
855 
856  if (flash_not_ready_score <= 8 && secured_score > 24) {
857  jtag_poll_set_enabled(false);
858 
859  LOG_WARNING("*********** ATTENTION! ATTENTION! ATTENTION! ATTENTION! **********");
860  LOG_WARNING("**** ****");
861  LOG_WARNING("**** Your Kinetis MCU is in secured state, which means that, ****");
862  LOG_WARNING("**** with exception for very basic communication, JTAG/SWD ****");
863  LOG_WARNING("**** interface will NOT work. In order to restore its ****");
864  LOG_WARNING("**** functionality please issue 'kinetis mdm mass_erase' ****");
865  LOG_WARNING("**** command, power cycle the MCU and restart OpenOCD. ****");
866  LOG_WARNING("**** ****");
867  LOG_WARNING("*********** ATTENTION! ATTENTION! ATTENTION! ATTENTION! **********");
868 
869  } else if (flash_not_ready_score > 24) {
870  jtag_poll_set_enabled(false);
871  LOG_WARNING("**** Your Kinetis MCU is probably locked-up in RESET/WDOG loop. ****");
872  LOG_WARNING("**** Common reason is a blank flash (at least a reset vector). ****");
873  LOG_WARNING("**** Issue 'kinetis mdm halt' command or if SRST is connected ****");
874  LOG_WARNING("**** and configured, use 'reset halt' ****");
875  LOG_WARNING("**** If MCU cannot be halted, it is likely secured and running ****");
876  LOG_WARNING("**** in RESET/WDOG loop. Issue 'kinetis mdm mass_erase' ****");
877 
878  } else {
879  LOG_INFO("MDM: Chip is unsecured. Continuing.");
880  jtag_poll_set_enabled(true);
881  }
882 
883  return ERROR_OK;
884 }
885 
886 
888 {
889  struct flash_bank *bank_iter;
890  struct kinetis_flash_bank *k_bank;
891 
892  /* iterate over all kinetis banks */
893  for (bank_iter = flash_bank_list(); bank_iter; bank_iter = bank_iter->next) {
894  if (bank_iter->driver != &kinetis_flash
895  || bank_iter->target != target)
896  continue;
897 
898  k_bank = bank_iter->driver_priv;
899  if (!k_bank)
900  continue;
901 
902  if (k_bank->k_chip)
903  return k_bank->k_chip;
904  }
905  return NULL;
906 }
907 
908 static uint8_t kinetis_fcfg1_depart(enum kinetis_chip_type chip_type, uint32_t sim_fcfg1)
909 {
910  unsigned int shift = chip_type == KINETIS_CT_S32K ? 12 : 8;
911 
912  return (sim_fcfg1 >> shift) & 0x0f;
913 }
914 
915 static int kinetis_chip_options(struct kinetis_chip *k_chip, int argc, const char *argv[])
916 {
917  for (int i = 0; i < argc; i++) {
918  if (strcmp(argv[i], "-sim-base") == 0) {
919  if (i + 1 < argc)
920  k_chip->sim_base = strtoul(argv[++i], NULL, 0);
921  } else if (strcmp(argv[i], "-s32k") == 0) {
923  } else
924  LOG_ERROR("Unsupported flash bank option %s", argv[i]);
925  }
926  return ERROR_OK;
927 }
928 
929 FLASH_BANK_COMMAND_HANDLER(kinetis_flash_bank_command)
930 {
931  struct target *target = bank->target;
932  struct kinetis_chip *k_chip;
933  struct kinetis_flash_bank *k_bank;
934  int retval;
935 
936  if (CMD_ARGC < 6)
938 
939  LOG_INFO("add flash_bank kinetis %s", bank->name);
940 
942 
943  if (!k_chip) {
944  k_chip = calloc(1, sizeof(struct kinetis_chip));
945  if (!k_chip) {
946  LOG_ERROR("No memory");
947  return ERROR_FAIL;
948  }
949 
950  k_chip->target = target;
951 
952  /* only the first defined bank can define chip options */
953  retval = kinetis_chip_options(k_chip, CMD_ARGC - 6, CMD_ARGV + 6);
954  if (retval != ERROR_OK)
955  return retval;
956  }
957 
959  LOG_ERROR("Only %u Kinetis flash banks are supported", KINETIS_MAX_BANKS);
960  return ERROR_FAIL;
961  }
962 
963  bank->driver_priv = k_bank = &(k_chip->banks[k_chip->num_banks]);
964  k_bank->k_chip = k_chip;
965  k_bank->bank_number = k_chip->num_banks;
966  k_bank->bank = bank;
967  k_chip->num_banks++;
968 
969  return ERROR_OK;
970 }
971 
972 
974 {
975  struct kinetis_flash_bank *k_bank = bank->driver_priv;
976  if (!k_bank)
977  return;
978 
979  struct kinetis_chip *k_chip = k_bank->k_chip;
980  if (!k_chip)
981  return;
982 
983  k_chip->num_banks--;
984  if (k_chip->num_banks == 0)
985  free(k_chip);
986 }
987 
988 
989 static int kinetis_create_missing_banks(struct kinetis_chip *k_chip)
990 {
991  unsigned int num_blocks;
992  struct kinetis_flash_bank *k_bank;
993  struct flash_bank *bank;
994  char base_name[69], name[87], num[11];
995  char *class, *p;
996 
997  num_blocks = k_chip->num_pflash_blocks + k_chip->num_nvm_blocks;
998  if (num_blocks > KINETIS_MAX_BANKS) {
999  LOG_ERROR("Only %u Kinetis flash banks are supported", KINETIS_MAX_BANKS);
1000  return ERROR_FAIL;
1001  }
1002 
1003  bank = k_chip->banks[0].bank;
1004  if (bank && bank->name) {
1005  strncpy(base_name, bank->name, sizeof(base_name) - 1);
1006  base_name[sizeof(base_name) - 1] = '\0';
1007  p = strstr(base_name, ".pflash");
1008  if (p) {
1009  *p = '\0';
1010  if (k_chip->num_pflash_blocks > 1) {
1011  /* rename first bank if numbering is needed */
1012  snprintf(name, sizeof(name), "%s.pflash0", base_name);
1013  free(bank->name);
1014  bank->name = strdup(name);
1015  }
1016  }
1017  } else {
1018  strncpy(base_name, target_name(k_chip->target), sizeof(base_name) - 1);
1019  base_name[sizeof(base_name) - 1] = '\0';
1020  p = strstr(base_name, ".cpu");
1021  if (p)
1022  *p = '\0';
1023  }
1024 
1025  for (unsigned int bank_idx = 1; bank_idx < num_blocks; bank_idx++) {
1026  k_bank = &(k_chip->banks[bank_idx]);
1027  bank = k_bank->bank;
1028 
1029  if (bank)
1030  continue;
1031 
1032  num[0] = '\0';
1033 
1034  if (bank_idx < k_chip->num_pflash_blocks) {
1035  class = "pflash";
1036  if (k_chip->num_pflash_blocks > 1)
1037  snprintf(num, sizeof(num), "%u", bank_idx);
1038  } else {
1039  class = "flexnvm";
1040  if (k_chip->num_nvm_blocks > 1)
1041  snprintf(num, sizeof(num), "%u",
1042  bank_idx - k_chip->num_pflash_blocks);
1043  }
1044 
1045  bank = calloc(1, sizeof(struct flash_bank));
1046  if (!bank)
1047  return ERROR_FAIL;
1048 
1049  bank->target = k_chip->target;
1050  bank->driver = &kinetis_flash;
1051  bank->default_padded_value = bank->erased_value = 0xff;
1052  bank->minimal_write_gap = FLASH_WRITE_GAP_SECTOR;
1053 
1054  snprintf(name, sizeof(name), "%s.%s%s",
1055  base_name, class, num);
1056  bank->name = strdup(name);
1057 
1058  bank->driver_priv = k_bank = &(k_chip->banks[k_chip->num_banks]);
1059  k_bank->k_chip = k_chip;
1060  k_bank->bank_number = bank_idx;
1061  k_bank->bank = bank;
1062  if (k_chip->num_banks <= bank_idx)
1063  k_chip->num_banks = bank_idx + 1;
1064 
1066  }
1067  return ERROR_OK;
1068 }
1069 
1070 
1071 static int kinetis_disable_wdog_algo(struct target *target, size_t code_size, const uint8_t *code, uint32_t wdog_base)
1072 {
1073  struct working_area *wdog_algorithm;
1074  struct armv7m_algorithm armv7m_info;
1075  struct reg_param reg_params[1];
1076  int retval;
1077 
1078  if (target->state != TARGET_HALTED) {
1079  LOG_ERROR("Target not halted");
1080  return ERROR_TARGET_NOT_HALTED;
1081  }
1082 
1083  retval = target_alloc_working_area(target, code_size, &wdog_algorithm);
1084  if (retval != ERROR_OK)
1085  return retval;
1086 
1087  retval = target_write_buffer(target, wdog_algorithm->address,
1088  code_size, code);
1089  if (retval == ERROR_OK) {
1090  armv7m_info.common_magic = ARMV7M_COMMON_MAGIC;
1091  armv7m_info.core_mode = ARM_MODE_THREAD;
1092 
1093  init_reg_param(&reg_params[0], "r0", 32, PARAM_OUT);
1094  buf_set_u32(reg_params[0].value, 0, 32, wdog_base);
1095 
1096  retval = target_run_algorithm(target, 0, NULL, 1, reg_params,
1097  wdog_algorithm->address,
1098  wdog_algorithm->address + code_size - 2,
1099  500, &armv7m_info);
1100 
1101  destroy_reg_param(&reg_params[0]);
1102 
1103  if (retval != ERROR_OK)
1104  LOG_ERROR("Error executing Kinetis WDOG unlock algorithm");
1105  }
1106 
1107  target_free_working_area(target, wdog_algorithm);
1108 
1109  return retval;
1110 }
1111 
1112 /* Disable the watchdog on Kinetis devices
1113  * Standard Kx WDOG peripheral checks timing and therefore requires to run algo.
1114  */
1116 {
1117  const uint32_t wdog_base = WDOG_BASE;
1118  uint16_t wdog;
1119  int retval;
1120 
1121  static const uint8_t kinetis_unlock_wdog_code[] = {
1122 #include "../../../contrib/loaders/watchdog/armv7m_kinetis_wdog.inc"
1123  };
1124 
1125  retval = target_read_u16(target, wdog_base + WDOG_STCTRLH_OFFSET, &wdog);
1126  if (retval != ERROR_OK)
1127  return retval;
1128 
1129  if ((wdog & 0x1) == 0) {
1130  /* watchdog already disabled */
1131  return ERROR_OK;
1132  }
1133  LOG_INFO("Disabling Kinetis watchdog (initial WDOG_STCTRLH = 0x%04" PRIx16 ")", wdog);
1134 
1135  retval = kinetis_disable_wdog_algo(target, sizeof(kinetis_unlock_wdog_code), kinetis_unlock_wdog_code, wdog_base);
1136  if (retval != ERROR_OK)
1137  return retval;
1138 
1139  retval = target_read_u16(target, wdog_base + WDOG_STCTRLH_OFFSET, &wdog);
1140  if (retval != ERROR_OK)
1141  return retval;
1142 
1143  LOG_INFO("WDOG_STCTRLH = 0x%04" PRIx16, wdog);
1144  return (wdog & 0x1) ? ERROR_FAIL : ERROR_OK;
1145 }
1146 
1147 static int kinetis_disable_wdog32(struct target *target, uint32_t wdog_base)
1148 {
1149  uint32_t wdog_cs;
1150  int retval;
1151 
1152  static const uint8_t kinetis_unlock_wdog_code[] = {
1153 #include "../../../contrib/loaders/watchdog/armv7m_kinetis_wdog32.inc"
1154  };
1155 
1156  retval = target_read_u32(target, wdog_base + WDOG32_CS_OFFSET, &wdog_cs);
1157  if (retval != ERROR_OK)
1158  return retval;
1159 
1160  if ((wdog_cs & 0x80) == 0)
1161  return ERROR_OK; /* watchdog already disabled */
1162 
1163  LOG_INFO("Disabling Kinetis watchdog (initial WDOG_CS 0x%08" PRIx32 ")", wdog_cs);
1164 
1165  retval = kinetis_disable_wdog_algo(target, sizeof(kinetis_unlock_wdog_code), kinetis_unlock_wdog_code, wdog_base);
1166  if (retval != ERROR_OK)
1167  return retval;
1168 
1169  retval = target_read_u32(target, wdog_base + WDOG32_CS_OFFSET, &wdog_cs);
1170  if (retval != ERROR_OK)
1171  return retval;
1172 
1173  if ((wdog_cs & 0x80) == 0)
1174  return ERROR_OK; /* watchdog disabled successfully */
1175 
1176  LOG_ERROR("Cannot disable Kinetis watchdog (WDOG_CS 0x%08" PRIx32 "), issue 'reset init'", wdog_cs);
1177  return ERROR_FAIL;
1178 }
1179 
1180 static int kinetis_disable_wdog(struct kinetis_chip *k_chip)
1181 {
1182  struct target *target = k_chip->target;
1183  uint8_t sim_copc;
1184  int retval;
1185 
1186  if (!k_chip->probed) {
1187  switch (k_chip->chip_type) {
1188  case KINETIS_CT_S32K:
1189  retval = kinetis_probe_chip_s32k(k_chip);
1190  break;
1191  default:
1192  retval = kinetis_probe_chip(k_chip);
1193  }
1194  if (retval != ERROR_OK)
1195  return retval;
1196  }
1197 
1198  switch (k_chip->watchdog_type) {
1199  case KINETIS_WDOG_K:
1201 
1202  case KINETIS_WDOG_COP:
1203  retval = target_read_u8(target, SIM_COPC, &sim_copc);
1204  if (retval != ERROR_OK)
1205  return retval;
1206 
1207  if ((sim_copc & 0xc) == 0)
1208  return ERROR_OK; /* watchdog already disabled */
1209 
1210  LOG_INFO("Disabling Kinetis watchdog (initial SIM_COPC 0x%02" PRIx8 ")", sim_copc);
1211  retval = target_write_u8(target, SIM_COPC, sim_copc & ~0xc);
1212  if (retval != ERROR_OK)
1213  return retval;
1214 
1215  retval = target_read_u8(target, SIM_COPC, &sim_copc);
1216  if (retval != ERROR_OK)
1217  return retval;
1218 
1219  if ((sim_copc & 0xc) == 0)
1220  return ERROR_OK; /* watchdog disabled successfully */
1221 
1222  LOG_ERROR("Cannot disable Kinetis watchdog (SIM_COPC 0x%02" PRIx8 "), issue 'reset init'", sim_copc);
1223  return ERROR_FAIL;
1224 
1225  case KINETIS_WDOG32_KE1X:
1227 
1228  case KINETIS_WDOG32_KL28:
1230 
1231  default:
1232  return ERROR_OK;
1233  }
1234 }
1235 
1236 COMMAND_HANDLER(kinetis_disable_wdog_handler)
1237 {
1239  struct kinetis_chip *k_chip = kinetis_get_chip(target);
1240 
1241  if (!k_chip)
1242  return ERROR_FAIL;
1243 
1244  if (CMD_ARGC > 0)
1246 
1247  return kinetis_disable_wdog(k_chip);
1248 }
1249 
1250 
1251 static int kinetis_ftfx_decode_error(uint8_t fstat)
1252 {
1253  if (fstat & 0x20) {
1254  LOG_ERROR("Flash operation failed, illegal command");
1256 
1257  } else if (fstat & 0x10)
1258  LOG_ERROR("Flash operation failed, protection violated");
1259 
1260  else if (fstat & 0x40)
1261  LOG_ERROR("Flash operation failed, read collision");
1262 
1263  else if (fstat & 0x80)
1264  return ERROR_OK;
1265 
1266  else
1267  LOG_ERROR("Flash operation timed out");
1268 
1270 }
1271 
1273 {
1274  /* reset error flags */
1275  return target_write_u8(target, FTFX_FSTAT, 0x70);
1276 }
1277 
1278 
1280 {
1281  int result;
1282  uint8_t fstat;
1283 
1284  /* wait until busy */
1285  for (unsigned int i = 0; i < 50; i++) {
1286  result = target_read_u8(target, FTFX_FSTAT, &fstat);
1287  if (result != ERROR_OK)
1288  return result;
1289 
1290  if (fstat & 0x80)
1291  break;
1292  }
1293 
1294  if ((fstat & 0x80) == 0) {
1295  LOG_ERROR("Flash controller is busy");
1297  }
1298  if (fstat != 0x80) {
1299  /* reset error flags */
1300  result = kinetis_ftfx_clear_error(target);
1301  }
1302  return result;
1303 }
1304 
1305 /* Kinetis Program-LongWord Microcodes */
1306 static const uint8_t kinetis_flash_write_code[] = {
1307 #include "../../../contrib/loaders/flash/kinetis/kinetis_flash.inc"
1308 };
1309 
1310 /* Program LongWord Block Write */
1311 static int kinetis_write_block(struct flash_bank *bank, const uint8_t *buffer,
1312  uint32_t offset, uint32_t wcount)
1313 {
1314  struct target *target = bank->target;
1315  uint32_t buffer_size;
1316  struct working_area *write_algorithm;
1317  struct working_area *source;
1318  struct kinetis_flash_bank *k_bank = bank->driver_priv;
1319  uint32_t address = k_bank->prog_base + offset;
1320  uint32_t end_address;
1321  struct reg_param reg_params[5];
1322  struct armv7m_algorithm armv7m_info;
1323  int retval;
1324  uint8_t fstat;
1325 
1326  /* allocate working area with flash programming code */
1328  &write_algorithm) != ERROR_OK) {
1329  LOG_WARNING("no working area available, can't do block memory writes");
1331  }
1332 
1333  retval = target_write_buffer(target, write_algorithm->address,
1335  if (retval != ERROR_OK)
1336  return retval;
1337 
1338  /* memory buffer, size *must* be multiple of word */
1339  buffer_size = target_get_working_area_avail(target) & ~(sizeof(uint32_t) - 1);
1340  if (buffer_size < 256) {
1341  LOG_WARNING("large enough working area not available, can't do block memory writes");
1343  } else if (buffer_size > 16384) {
1344  /* probably won't benefit from more than 16k ... */
1345  buffer_size = 16384;
1346  }
1347 
1349  LOG_ERROR("allocating working area failed");
1351  }
1352 
1353  armv7m_info.common_magic = ARMV7M_COMMON_MAGIC;
1354  armv7m_info.core_mode = ARM_MODE_THREAD;
1355 
1356  init_reg_param(&reg_params[0], "r0", 32, PARAM_IN_OUT); /* address */
1357  init_reg_param(&reg_params[1], "r1", 32, PARAM_OUT); /* word count */
1358  init_reg_param(&reg_params[2], "r2", 32, PARAM_OUT);
1359  init_reg_param(&reg_params[3], "r3", 32, PARAM_OUT);
1360  init_reg_param(&reg_params[4], "r4", 32, PARAM_OUT);
1361 
1362  buf_set_u32(reg_params[0].value, 0, 32, address);
1363  buf_set_u32(reg_params[1].value, 0, 32, wcount);
1364  buf_set_u32(reg_params[2].value, 0, 32, source->address);
1365  buf_set_u32(reg_params[3].value, 0, 32, source->address + source->size);
1366  buf_set_u32(reg_params[4].value, 0, 32, FTFX_FSTAT);
1367 
1368  retval = target_run_flash_async_algorithm(target, buffer, wcount, 4,
1369  0, NULL,
1370  5, reg_params,
1371  source->address, source->size,
1372  write_algorithm->address, 0,
1373  &armv7m_info);
1374 
1375  if (retval == ERROR_FLASH_OPERATION_FAILED) {
1376  end_address = buf_get_u32(reg_params[0].value, 0, 32);
1377 
1378  LOG_ERROR("Error writing flash at %08" PRIx32, end_address);
1379 
1380  retval = target_read_u8(target, FTFX_FSTAT, &fstat);
1381  if (retval == ERROR_OK) {
1382  retval = kinetis_ftfx_decode_error(fstat);
1383 
1384  /* reset error flags */
1386  }
1387  } else if (retval != ERROR_OK)
1388  LOG_ERROR("Error executing kinetis Flash programming algorithm");
1389 
1391  target_free_working_area(target, write_algorithm);
1392 
1393  destroy_reg_param(&reg_params[0]);
1394  destroy_reg_param(&reg_params[1]);
1395  destroy_reg_param(&reg_params[2]);
1396  destroy_reg_param(&reg_params[3]);
1397  destroy_reg_param(&reg_params[4]);
1398 
1399  return retval;
1400 }
1401 
1402 static int kinetis_protect(struct flash_bank *bank, int set, unsigned int first,
1403  unsigned int last)
1404 {
1405  if (allow_fcf_writes) {
1406  LOG_ERROR("Protection setting is possible with 'kinetis fcf_source protection' only!");
1407  return ERROR_FAIL;
1408  }
1409 
1410  if (!bank->prot_blocks || bank->num_prot_blocks == 0) {
1411  LOG_ERROR("No protection possible for current bank!");
1412  return ERROR_FLASH_BANK_INVALID;
1413  }
1414 
1415  for (unsigned int i = first; i < bank->num_prot_blocks && i <= last; i++)
1416  bank->prot_blocks[i].is_protected = set;
1417 
1418  LOG_INFO("Protection bits will be written at the next FCF sector erase or write.");
1419  LOG_INFO("Do not issue 'flash info' command until protection is written,");
1420  LOG_INFO("doing so would re-read protection status from MCU.");
1421 
1422  return ERROR_OK;
1423 }
1424 
1426 {
1427  struct kinetis_flash_bank *k_bank = bank->driver_priv;
1428  int result;
1429  int b;
1430  uint32_t fprot;
1431 
1432  if (k_bank->flash_class == FC_PFLASH) {
1433 
1434  /* read protection register */
1435  result = target_read_u32(bank->target, FTFX_FPROT3, &fprot);
1436  if (result != ERROR_OK)
1437  return result;
1438 
1439  /* Every bit protects 1/32 of the full flash (not necessarily just this bank) */
1440 
1441  } else if (k_bank->flash_class == FC_FLEX_NVM) {
1442  uint8_t fdprot;
1443 
1444  /* read protection register */
1445  result = target_read_u8(bank->target, FTFX_FDPROT, &fdprot);
1446  if (result != ERROR_OK)
1447  return result;
1448 
1449  fprot = fdprot;
1450 
1451  } else {
1452  LOG_ERROR("Protection checks for FlexRAM not supported");
1453  return ERROR_FLASH_BANK_INVALID;
1454  }
1455 
1456  b = k_bank->protection_block;
1457  for (unsigned int i = 0; i < bank->num_prot_blocks; i++) {
1458  if ((fprot >> b) & 1)
1459  bank->prot_blocks[i].is_protected = 0;
1460  else
1461  bank->prot_blocks[i].is_protected = 1;
1462 
1463  b++;
1464  }
1465 
1466  return ERROR_OK;
1467 }
1468 
1469 
1470 static int kinetis_fill_fcf(struct flash_bank *bank, uint8_t *fcf)
1471 {
1472  uint32_t fprot = 0xffffffff;
1473  uint8_t fsec = 0xfe; /* set MCU unsecure */
1474  uint8_t fdprot = 0xff;
1475  unsigned int num_blocks;
1476  uint32_t pflash_bit;
1477  uint8_t dflash_bit;
1478  struct flash_bank *bank_iter;
1479  struct kinetis_flash_bank *k_bank = bank->driver_priv;
1480  struct kinetis_chip *k_chip = k_bank->k_chip;
1481 
1482  memset(fcf, 0xff, FCF_SIZE);
1483 
1484  pflash_bit = 1;
1485  dflash_bit = 1;
1486 
1487  /* iterate over all kinetis banks */
1488  /* current bank is bank 0, it contains FCF */
1489  num_blocks = k_chip->num_pflash_blocks + k_chip->num_nvm_blocks;
1490  for (unsigned int bank_idx = 0; bank_idx < num_blocks; bank_idx++) {
1491  k_bank = &(k_chip->banks[bank_idx]);
1492  bank_iter = k_bank->bank;
1493 
1494  if (!bank_iter) {
1495  LOG_WARNING("Missing bank %u configuration, FCF protection flags may be incomplete", bank_idx);
1496  continue;
1497  }
1498 
1499  kinetis_auto_probe(bank_iter);
1500 
1501  if (bank_iter->num_prot_blocks == 0) {
1502  if (k_bank->flash_class == FC_PFLASH) {
1503  LOG_ERROR("BUG: PFLASH bank %u has no protection blocks",
1504  bank_idx);
1505  } else {
1506  LOG_DEBUG("skipping FLEX_NVM bank %u with no prot blocks (EE bkp only)",
1507  bank_idx);
1508  }
1509  continue;
1510  }
1511 
1512  if (!bank_iter->prot_blocks) {
1513  LOG_ERROR("BUG: bank %u has NULL protection blocks array",
1514  bank_idx);
1515  continue;
1516  }
1517 
1518  if (k_bank->flash_class == FC_PFLASH) {
1519  for (unsigned int i = 0; i < bank_iter->num_prot_blocks; i++) {
1520  if (bank_iter->prot_blocks[i].is_protected == 1)
1521  fprot &= ~pflash_bit;
1522 
1523  pflash_bit <<= 1;
1524  }
1525 
1526  } else if (k_bank->flash_class == FC_FLEX_NVM) {
1527  for (unsigned int i = 0; i < bank_iter->num_prot_blocks; i++) {
1528  if (bank_iter->prot_blocks[i].is_protected == 1)
1529  fdprot &= ~dflash_bit;
1530 
1531  dflash_bit <<= 1;
1532  }
1533 
1534  }
1535  }
1536 
1537  target_buffer_set_u32(bank->target, fcf + FCF_FPROT, fprot);
1538  fcf[FCF_FSEC] = fsec;
1539  fcf[FCF_FOPT] = fcf_fopt;
1540  fcf[FCF_FDPROT] = fdprot;
1541  return ERROR_OK;
1542 }
1543 
1544 static int kinetis_ftfx_command(struct target *target, uint8_t fcmd, uint32_t faddr,
1545  uint8_t fccob4, uint8_t fccob5, uint8_t fccob6, uint8_t fccob7,
1546  uint8_t fccob8, uint8_t fccob9, uint8_t fccoba, uint8_t fccobb,
1547  uint8_t *ftfx_fstat)
1548 {
1549  uint8_t command[12] = {faddr & 0xff, (faddr >> 8) & 0xff, (faddr >> 16) & 0xff, fcmd,
1550  fccob7, fccob6, fccob5, fccob4,
1551  fccobb, fccoba, fccob9, fccob8};
1552  int result;
1553  uint8_t fstat;
1554  int64_t ms_timeout = timeval_ms() + 250;
1555 
1556  result = target_write_memory(target, FTFX_FCCOB3, 4, 3, command);
1557  if (result != ERROR_OK)
1558  return result;
1559 
1560  /* start command */
1561  result = target_write_u8(target, FTFX_FSTAT, 0x80);
1562  if (result != ERROR_OK)
1563  return result;
1564 
1565  /* wait for done */
1566  do {
1567  result = target_read_u8(target, FTFX_FSTAT, &fstat);
1568 
1569  if (result != ERROR_OK)
1570  return result;
1571 
1572  if (fstat & 0x80)
1573  break;
1574 
1575  } while (timeval_ms() < ms_timeout);
1576 
1577  if (ftfx_fstat)
1578  *ftfx_fstat = fstat;
1579 
1580  if ((fstat & 0xf0) != 0x80) {
1581  LOG_DEBUG("ftfx command failed FSTAT: %02X FCCOB: %02X%02X%02X%02X %02X%02X%02X%02X %02X%02X%02X%02X",
1582  fstat, command[3], command[2], command[1], command[0],
1583  command[7], command[6], command[5], command[4],
1584  command[11], command[10], command[9], command[8]);
1585 
1586  return kinetis_ftfx_decode_error(fstat);
1587  }
1588 
1589  return ERROR_OK;
1590 }
1591 
1592 
1593 static int kinetis_read_pmstat(struct kinetis_chip *k_chip, uint8_t *pmstat)
1594 {
1595  int result;
1596  uint32_t stat32;
1597  struct target *target = k_chip->target;
1598 
1599  switch (k_chip->sysmodectrlr_type) {
1600  case KINETIS_SMC:
1601  return target_read_u8(target, SMC_PMSTAT, pmstat);
1602 
1603  case KINETIS_SMC32:
1604  result = target_read_u32(target, SMC32_PMSTAT, &stat32);
1605  if (result == ERROR_OK)
1606  *pmstat = stat32 & 0xff;
1607  return result;
1608 
1609  case KINETIS_MC:
1610  /* emulate SMC by reading PMC_REGSC bit 3 (VLPRS) */
1611  result = target_read_u8(target, PMC_REGSC, pmstat);
1612  if (result == ERROR_OK) {
1613  if (*pmstat & 0x08)
1614  *pmstat = PM_STAT_VLPR;
1615  else
1616  *pmstat = PM_STAT_RUN;
1617  }
1618  return result;
1619  }
1620  return ERROR_FAIL;
1621 }
1622 
1623 static int kinetis_check_run_mode(struct kinetis_chip *k_chip)
1624 {
1625  int result;
1626  uint8_t pmstat;
1627  struct target *target;
1628 
1629  if (!k_chip) {
1630  LOG_ERROR("Chip not probed.");
1631  return ERROR_FAIL;
1632  }
1633  target = k_chip->target;
1634 
1635  if (target->state != TARGET_HALTED) {
1636  LOG_ERROR("Target not halted");
1637  return ERROR_TARGET_NOT_HALTED;
1638  }
1639 
1640  result = kinetis_read_pmstat(k_chip, &pmstat);
1641  if (result != ERROR_OK)
1642  return result;
1643 
1644  if (pmstat == PM_STAT_RUN)
1645  return ERROR_OK;
1646 
1647  if (pmstat == PM_STAT_VLPR) {
1648  /* It is safe to switch from VLPR to RUN mode without changing clock */
1649  LOG_INFO("Switching from VLPR to RUN mode.");
1650 
1651  switch (k_chip->sysmodectrlr_type) {
1652  case KINETIS_SMC:
1654  break;
1655 
1656  case KINETIS_SMC32:
1658  break;
1659 
1660  case KINETIS_MC:
1662  break;
1663  }
1664  if (result != ERROR_OK)
1665  return result;
1666 
1667  for (unsigned int i = 100; i > 0; i--) {
1668  result = kinetis_read_pmstat(k_chip, &pmstat);
1669  if (result != ERROR_OK)
1670  return result;
1671 
1672  if (pmstat == PM_STAT_RUN)
1673  return ERROR_OK;
1674  }
1675  }
1676 
1677  LOG_ERROR("Flash operation not possible in current run mode: SMC_PMSTAT: 0x%x", pmstat);
1678  LOG_ERROR("Issue a 'reset init' command.");
1679  return ERROR_TARGET_NOT_HALTED;
1680 }
1681 
1682 
1684 {
1685  struct target *target = k_chip->target;
1686 
1687  switch (k_chip->cache_type) {
1688  case KINETIS_CACHE_K:
1689  target_write_u8(target, FMC_PFB01CR + 2, 0xf0);
1690  /* Set CINV_WAY bits - request invalidate of all cache ways */
1691  /* FMC_PFB0CR has same address and CINV_WAY bits as FMC_PFB01CR */
1692  break;
1693 
1694  case KINETIS_CACHE_L:
1695  target_write_u8(target, MCM_PLACR + 1, 0x04);
1696  /* set bit CFCC - Clear Flash Controller Cache */
1697  break;
1698 
1699  case KINETIS_CACHE_MSCM:
1701  /* disable data prefetch and flash speculate */
1702  break;
1703 
1704  case KINETIS_CACHE_MSCM2:
1707  /* disable data prefetch and flash speculate */
1708  break;
1709 
1710  default:
1711  break;
1712  }
1713 }
1714 
1715 
1716 static int kinetis_erase(struct flash_bank *bank, unsigned int first,
1717  unsigned int last)
1718 {
1719  int result;
1720  struct kinetis_flash_bank *k_bank = bank->driver_priv;
1721  struct kinetis_chip *k_chip = k_bank->k_chip;
1722 
1723  result = kinetis_check_run_mode(k_chip);
1724  if (result != ERROR_OK)
1725  return result;
1726 
1727  /* reset error flags */
1728  result = kinetis_ftfx_prepare(bank->target);
1729  if (result != ERROR_OK)
1730  return result;
1731 
1732  if ((first > bank->num_sectors) || (last > bank->num_sectors))
1734 
1735  /*
1736  * FIXME: TODO: use the 'Erase Flash Block' command if the
1737  * requested erase is PFlash or NVM and encompasses the entire
1738  * block. Should be quicker.
1739  */
1740  for (unsigned int i = first; i <= last; i++) {
1741  /* set command and sector address */
1742  result = kinetis_ftfx_command(bank->target, FTFX_CMD_SECTERASE, k_bank->prog_base + bank->sectors[i].offset,
1743  0, 0, 0, 0, 0, 0, 0, 0, NULL);
1744 
1745  if (result != ERROR_OK) {
1746  LOG_WARNING("erase sector %u failed", i);
1748  }
1749 
1750  if (k_bank->prog_base == 0
1751  && bank->sectors[i].offset <= FCF_ADDRESS
1752  && bank->sectors[i].offset + bank->sectors[i].size > FCF_ADDRESS + FCF_SIZE) {
1753  if (allow_fcf_writes) {
1754  LOG_WARNING("Flash Configuration Field erased, DO NOT reset or power off the device");
1755  LOG_WARNING("until correct FCF is programmed or MCU gets security lock.");
1756  } else {
1757  uint8_t fcf_buffer[FCF_SIZE];
1758 
1759  kinetis_fill_fcf(bank, fcf_buffer);
1760  result = kinetis_write_inner(bank, fcf_buffer, FCF_ADDRESS, FCF_SIZE);
1761  if (result != ERROR_OK)
1762  LOG_WARNING("Flash Configuration Field write failed");
1763  else
1764  LOG_DEBUG("Generated FCF written");
1765  }
1766  }
1767  }
1768 
1770 
1771  return ERROR_OK;
1772 }
1773 
1775 {
1776  int result;
1777  uint8_t ftfx_fcnfg;
1778 
1779  /* check if ram ready */
1780  result = target_read_u8(target, FTFX_FCNFG, &ftfx_fcnfg);
1781  if (result != ERROR_OK)
1782  return result;
1783 
1784  if (ftfx_fcnfg & (1 << 1))
1785  return ERROR_OK; /* ram ready */
1786 
1787  /* make flex ram available */
1788  result = kinetis_ftfx_command(target, FTFX_CMD_SETFLEXRAM, 0x00ff0000,
1789  0, 0, 0, 0, 0, 0, 0, 0, NULL);
1790  if (result != ERROR_OK)
1792 
1793  /* check again */
1794  result = target_read_u8(target, FTFX_FCNFG, &ftfx_fcnfg);
1795  if (result != ERROR_OK)
1796  return result;
1797 
1798  if (ftfx_fcnfg & (1 << 1))
1799  return ERROR_OK; /* ram ready */
1800 
1802 }
1803 
1804 
1805 static int kinetis_write_sections(struct flash_bank *bank, const uint8_t *buffer,
1806  uint32_t offset, uint32_t count)
1807 {
1808  int result = ERROR_OK;
1809  struct kinetis_flash_bank *k_bank = bank->driver_priv;
1810  struct kinetis_chip *k_chip = k_bank->k_chip;
1811  uint8_t *buffer_aligned = NULL;
1812  /*
1813  * Kinetis uses different terms for the granularity of
1814  * sector writes, e.g. "phrase" or "128 bits". We use
1815  * the generic term "chunk". The largest possible
1816  * Kinetis "chunk" is 16 bytes (128 bits).
1817  */
1818  uint32_t prog_section_chunk_bytes = k_bank->sector_size >> 8;
1819  uint32_t prog_size_bytes = k_chip->max_flash_prog_size;
1820 
1821  while (count > 0) {
1822  uint32_t size = prog_size_bytes - offset % prog_size_bytes;
1823  uint32_t align_begin = offset % prog_section_chunk_bytes;
1824  uint32_t align_end;
1825  uint32_t size_aligned;
1826  uint16_t chunk_count;
1827  uint8_t ftfx_fstat;
1828 
1829  if (size > count)
1830  size = count;
1831 
1832  align_end = (align_begin + size) % prog_section_chunk_bytes;
1833  if (align_end)
1834  align_end = prog_section_chunk_bytes - align_end;
1835 
1836  size_aligned = align_begin + size + align_end;
1837  chunk_count = size_aligned / prog_section_chunk_bytes;
1838 
1839  if (size != size_aligned) {
1840  /* aligned section: the first, the last or the only */
1841  if (!buffer_aligned)
1842  buffer_aligned = malloc(prog_size_bytes);
1843 
1844  memset(buffer_aligned, 0xff, size_aligned);
1845  memcpy(buffer_aligned + align_begin, buffer, size);
1846 
1847  result = target_write_memory(bank->target, k_chip->progr_accel_ram,
1848  4, size_aligned / 4, buffer_aligned);
1849 
1850  LOG_DEBUG("section @ " TARGET_ADDR_FMT " aligned begin %" PRIu32
1851  ", end %" PRIu32,
1852  bank->base + offset, align_begin, align_end);
1853  } else
1854  result = target_write_memory(bank->target, k_chip->progr_accel_ram,
1855  4, size_aligned / 4, buffer);
1856 
1857  LOG_DEBUG("write section @ " TARGET_ADDR_FMT " with length %" PRIu32
1858  " bytes",
1859  bank->base + offset, size);
1860 
1861  if (result != ERROR_OK) {
1862  LOG_ERROR("target_write_memory failed");
1863  break;
1864  }
1865 
1866  /* execute section-write command */
1867  result = kinetis_ftfx_command(bank->target, FTFX_CMD_SECTWRITE,
1868  k_bank->prog_base + offset - align_begin,
1869  chunk_count>>8, chunk_count, 0, 0,
1870  0, 0, 0, 0, &ftfx_fstat);
1871 
1872  if (result != ERROR_OK) {
1873  LOG_ERROR("Error writing section at " TARGET_ADDR_FMT,
1874  bank->base + offset);
1875  break;
1876  }
1877 
1878  if (ftfx_fstat & 0x01) {
1879  LOG_ERROR("Flash write error at " TARGET_ADDR_FMT,
1880  bank->base + offset);
1881  if (k_bank->prog_base == 0 && offset == FCF_ADDRESS + FCF_SIZE
1882  && (k_chip->flash_support & FS_WIDTH_256BIT)) {
1883  LOG_ERROR("Flash write immediately after the end of Flash Config Field shows error");
1884  LOG_ERROR("because the flash memory is 256 bits wide (data were written correctly).");
1885  LOG_ERROR("Either change the linker script to add a gap of 16 bytes after FCF");
1886  LOG_ERROR("or set 'kinetis fcf_source write'");
1887  }
1888  }
1889 
1890  buffer += size;
1891  offset += size;
1892  count -= size;
1893 
1894  keep_alive();
1895  }
1896 
1897  free(buffer_aligned);
1898  return result;
1899 }
1900 
1901 
1902 static int kinetis_write_inner(struct flash_bank *bank, const uint8_t *buffer,
1903  uint32_t offset, uint32_t count)
1904 {
1905  int result;
1906  bool fallback = false;
1907  struct kinetis_flash_bank *k_bank = bank->driver_priv;
1908  struct kinetis_chip *k_chip = k_bank->k_chip;
1909 
1910  if (!(k_chip->flash_support & FS_PROGRAM_SECTOR)) {
1911  /* fallback to longword write */
1912  fallback = true;
1913  LOG_INFO("This device supports Program Longword execution only.");
1914  } else {
1915  result = kinetis_make_ram_ready(bank->target);
1916  if (result != ERROR_OK) {
1917  fallback = true;
1918  LOG_WARNING("FlexRAM not ready, fallback to slow longword write.");
1919  }
1920  }
1921 
1922  LOG_DEBUG("flash write @ " TARGET_ADDR_FMT, bank->base + offset);
1923 
1924  if (!fallback) {
1925  /* program section command */
1927  } else if (k_chip->flash_support & FS_PROGRAM_LONGWORD) {
1928  /* program longword command, not supported in FTFE */
1929  uint8_t *new_buffer = NULL;
1930 
1931  /* check word alignment */
1932  if (offset & 0x3) {
1933  LOG_ERROR("offset 0x%" PRIx32 " breaks the required alignment", offset);
1935  }
1936 
1937  if (count & 0x3) {
1938  uint32_t old_count = count;
1939  count = (old_count | 3) + 1;
1940  new_buffer = malloc(count);
1941  if (!new_buffer) {
1942  LOG_ERROR("odd number of bytes to write and no memory "
1943  "for padding buffer");
1944  return ERROR_FAIL;
1945  }
1946  LOG_INFO("odd number of bytes to write (%" PRIu32 "), extending to %" PRIu32 " "
1947  "and padding with 0xff", old_count, count);
1948  memset(new_buffer + old_count, 0xff, count - old_count);
1949  buffer = memcpy(new_buffer, buffer, old_count);
1950  }
1951 
1952  uint32_t words_remaining = count / 4;
1953 
1954  kinetis_disable_wdog(k_chip);
1955 
1956  /* try using a block write */
1957  result = kinetis_write_block(bank, buffer, offset, words_remaining);
1958 
1959  if (result == ERROR_TARGET_RESOURCE_NOT_AVAILABLE) {
1960  /* if block write failed (no sufficient working area),
1961  * we use normal (slow) single word accesses */
1962  LOG_WARNING("couldn't use block writes, falling back to single "
1963  "memory accesses");
1964 
1965  while (words_remaining) {
1966  uint8_t ftfx_fstat;
1967 
1968  LOG_DEBUG("write longword @ %08" PRIx32, (uint32_t)(bank->base + offset));
1969 
1970  result = kinetis_ftfx_command(bank->target, FTFX_CMD_LWORDPROG, k_bank->prog_base + offset,
1971  buffer[3], buffer[2], buffer[1], buffer[0],
1972  0, 0, 0, 0, &ftfx_fstat);
1973 
1974  if (result != ERROR_OK) {
1975  LOG_ERROR("Error writing longword at " TARGET_ADDR_FMT,
1976  bank->base + offset);
1977  break;
1978  }
1979 
1980  if (ftfx_fstat & 0x01)
1981  LOG_ERROR("Flash write error at " TARGET_ADDR_FMT,
1982  bank->base + offset);
1983 
1984  buffer += 4;
1985  offset += 4;
1986  words_remaining--;
1987 
1988  keep_alive();
1989  }
1990  }
1991  free(new_buffer);
1992  } else {
1993  LOG_ERROR("Flash write strategy not implemented");
1995  }
1996 
1998  return result;
1999 }
2000 
2001 
2002 static int kinetis_write(struct flash_bank *bank, const uint8_t *buffer,
2003  uint32_t offset, uint32_t count)
2004 {
2005  int result;
2006  bool set_fcf = false;
2007  bool fcf_in_data_valid = false;
2008  bool fcf_differs = false;
2009  int sect = 0;
2010  struct kinetis_flash_bank *k_bank = bank->driver_priv;
2011  struct kinetis_chip *k_chip = k_bank->k_chip;
2012  uint8_t fcf_buffer[FCF_SIZE];
2013  uint8_t fcf_current[FCF_SIZE];
2014  uint8_t fcf_in_data[FCF_SIZE];
2015 
2016  result = kinetis_check_run_mode(k_chip);
2017  if (result != ERROR_OK)
2018  return result;
2019 
2020  /* reset error flags */
2021  result = kinetis_ftfx_prepare(bank->target);
2022  if (result != ERROR_OK)
2023  return result;
2024 
2025  if (k_bank->prog_base == 0 && !allow_fcf_writes) {
2026  if (bank->sectors[1].offset <= FCF_ADDRESS)
2027  sect = 1; /* 1kb sector, FCF in 2nd sector */
2028 
2029  if (offset < bank->sectors[sect].offset + bank->sectors[sect].size
2030  && offset + count > bank->sectors[sect].offset)
2031  set_fcf = true; /* write to any part of sector with FCF */
2032  }
2033 
2034  if (set_fcf) {
2035  kinetis_fill_fcf(bank, fcf_buffer);
2036 
2037  fcf_in_data_valid = offset <= FCF_ADDRESS
2038  && offset + count >= FCF_ADDRESS + FCF_SIZE;
2039  if (fcf_in_data_valid) {
2040  memcpy(fcf_in_data, buffer + FCF_ADDRESS - offset, FCF_SIZE);
2041  if (memcmp(fcf_in_data, fcf_buffer, 8)) {
2042  fcf_differs = true;
2043  LOG_INFO("Setting of backdoor key is not supported in mode 'kinetis fcf_source protection'.");
2044  }
2045  if (memcmp(fcf_in_data + FCF_FPROT, fcf_buffer + FCF_FPROT, 4)) {
2046  fcf_differs = true;
2047  LOG_INFO("Flash protection requested in the programmed file differs from current setting.");
2048  }
2049  if (fcf_in_data[FCF_FDPROT] != fcf_buffer[FCF_FDPROT]) {
2050  fcf_differs = true;
2051  LOG_INFO("Data flash protection requested in the programmed file differs from current setting.");
2052  }
2053  if ((fcf_in_data[FCF_FSEC] & 3) != 2) {
2054  fcf_in_data_valid = false;
2055  LOG_INFO("Device security requested in the programmed file! Write denied.");
2056  } else if (fcf_in_data[FCF_FSEC] != fcf_buffer[FCF_FSEC]) {
2057  fcf_differs = true;
2058  LOG_INFO("Strange unsecure mode 0x%02" PRIx8
2059  " requested in the programmed file, set FSEC = 0x%02" PRIx8
2060  " in the startup code!",
2061  fcf_in_data[FCF_FSEC], fcf_buffer[FCF_FSEC]);
2062  }
2063  if (fcf_in_data[FCF_FOPT] != fcf_buffer[FCF_FOPT]) {
2064  fcf_differs = true;
2065  LOG_INFO("FOPT requested in the programmed file differs from current setting, set 'kinetis fopt 0x%02"
2066  PRIx8 "'.", fcf_in_data[FCF_FOPT]);
2067  }
2068 
2069  /* If the device has ECC flash, then we cannot re-program FCF */
2070  if (fcf_differs) {
2071  if (k_chip->flash_support & FS_ECC) {
2072  fcf_in_data_valid = false;
2073  LOG_INFO("Cannot re-program FCF. Expect verify errors at FCF (0x400-0x40f).");
2074  } else {
2075  LOG_INFO("Trying to re-program FCF.");
2076  if (!(k_chip->flash_support & FS_PROGRAM_LONGWORD))
2077  LOG_INFO("Flash re-programming may fail on this device!");
2078  }
2079  }
2080  }
2081  }
2082 
2083  if (set_fcf && !fcf_in_data_valid) {
2084  if (offset < FCF_ADDRESS) {
2085  /* write part preceding FCF */
2087  if (result != ERROR_OK)
2088  return result;
2089  }
2090 
2091  result = target_read_memory(bank->target, bank->base + FCF_ADDRESS, 4, FCF_SIZE / 4, fcf_current);
2092  if (result == ERROR_OK && memcmp(fcf_current, fcf_buffer, FCF_SIZE) == 0)
2093  set_fcf = false;
2094 
2095  if (set_fcf) {
2096  /* write FCF if differs from flash - eliminate multiple writes */
2097  result = kinetis_write_inner(bank, fcf_buffer, FCF_ADDRESS, FCF_SIZE);
2098  if (result != ERROR_OK)
2099  return result;
2100  }
2101 
2102  LOG_WARNING("Flash Configuration Field written.");
2103  LOG_WARNING("Reset or power off the device to make settings effective.");
2104 
2105  if (offset + count > FCF_ADDRESS + FCF_SIZE) {
2106  uint32_t delta = FCF_ADDRESS + FCF_SIZE - offset;
2107  /* write part after FCF */
2108  result = kinetis_write_inner(bank, buffer + delta, FCF_ADDRESS + FCF_SIZE, count - delta);
2109  }
2110  return result;
2111 
2112  } else {
2113  /* no FCF fiddling, normal write */
2115  }
2116 }
2117 
2118 
2119 static int kinetis_probe_chip_s32k(struct kinetis_chip *k_chip)
2120 {
2121  int result;
2122  uint8_t fcfg1_eesize, fcfg1_depart;
2123  uint32_t ee_size = 0;
2124  uint32_t pflash_size_k, nvm_size_k, dflash_size_k;
2125  unsigned int generation = 0, subseries = 0, derivate = 0;
2126 
2127  struct target *target = k_chip->target;
2128  k_chip->probed = false;
2129  k_chip->pflash_sector_size = 0;
2130  k_chip->pflash_base = 0;
2131  k_chip->nvm_base = 0x10000000;
2132  k_chip->progr_accel_ram = FLEXRAM;
2133  k_chip->flash_support = FS_PROGRAM_PHRASE | FS_PROGRAM_SECTOR;
2134  k_chip->watchdog_type = KINETIS_WDOG32_KE1X;
2135  k_chip->sysmodectrlr_type = KINETIS_SMC32;
2136 
2137  if (k_chip->sim_base == 0)
2138  k_chip->sim_base = SIM_BASE;
2139 
2140  result = target_read_u32(target, k_chip->sim_base + SIM_SDID_OFFSET, &k_chip->sim_sdid);
2141  if (result != ERROR_OK)
2142  return result;
2143 
2144  generation = (k_chip->sim_sdid) >> 28 & 0x0f;
2145  subseries = (k_chip->sim_sdid) >> 24 & 0x0f;
2146  derivate = (k_chip->sim_sdid) >> 20 & 0x0f;
2147 
2148  switch (k_chip->sim_sdid & KINETIS_SDID_S32K_SERIES_MASK) {
2150  k_chip->cache_type = KINETIS_CACHE_L;
2151  k_chip->num_pflash_blocks = 1;
2152  k_chip->num_nvm_blocks = 1;
2153  /* Non-interleaved */
2154  k_chip->max_flash_prog_size = 512;
2155 
2156  switch (k_chip->sim_sdid & KINETIS_SDID_S32K_DERIVATE_MASK) {
2158  /* S32K116 CPU 48Mhz Flash 128KB RAM 17KB+2KB */
2159  /* Non-Interleaved */
2160  k_chip->pflash_size = 128 << 10;
2161  k_chip->pflash_sector_size = 2 << 10;
2162  /* Non-Interleaved */
2163  k_chip->nvm_size = 32 << 10;
2164  k_chip->nvm_sector_size = 2 << 10;
2165  break;
2167  /* S32K118 CPU 80Mhz Flash 256KB+32KB RAM 32KB+4KB */
2168  /* Non-Interleaved */
2169  k_chip->pflash_size = 256 << 10;
2170  k_chip->pflash_sector_size = 2 << 10;
2171  /* Non-Interleaved */
2172  k_chip->nvm_size = 32 << 10;
2173  k_chip->nvm_sector_size = 2 << 10;
2174  break;
2175  }
2176  break;
2177 
2179  k_chip->cache_type = KINETIS_CACHE_MSCM2;
2180  k_chip->num_pflash_blocks = 1;
2181  k_chip->num_nvm_blocks = 1;
2182  /* Non-interleaved */
2183  k_chip->max_flash_prog_size = 512;
2184  switch (k_chip->sim_sdid & KINETIS_SDID_S32K_DERIVATE_MASK) {
2187  /* S32K142/S32K142W CPU 80Mhz Flash 256KB+64KB RAM 32KB+4KB */
2188  /* Non-Interleaved */
2189  k_chip->pflash_size = 256 << 10;
2190  k_chip->pflash_sector_size = 2 << 10;
2191  /* Non-Interleaved */
2192  k_chip->nvm_size = 64 << 10;
2193  k_chip->nvm_sector_size = 2 << 10;
2194  break;
2197  /* S32K144/S32K144W CPU 80Mhz Flash 512KB+64KB RAM 64KB+4KB */
2198  /* Interleaved */
2199  k_chip->pflash_size = 512 << 10;
2200  k_chip->pflash_sector_size = 4 << 10;
2201  /* Non-Interleaved */
2202  k_chip->nvm_size = 64 << 10;
2203  k_chip->nvm_sector_size = 2 << 10;
2204  break;
2206  /* S32K146 CPU 80Mhz Flash 1024KB+64KB RAM 128KB+4KB */
2207  /* Interleaved */
2208  k_chip->pflash_size = 1024 << 10;
2209  k_chip->pflash_sector_size = 4 << 10;
2210  k_chip->num_pflash_blocks = 2;
2211  /* Non-Interleaved */
2212  k_chip->nvm_size = 64 << 10;
2213  k_chip->nvm_sector_size = 2 << 10;
2214  break;
2216  /* S32K148 CPU 80Mhz Flash 1536KB+512KB RAM 256KB+4KB */
2217  /* Interleaved */
2218  k_chip->pflash_size = 1536 << 10;
2219  k_chip->pflash_sector_size = 4 << 10;
2220  k_chip->num_pflash_blocks = 3;
2221  /* Interleaved */
2222  k_chip->nvm_size = 512 << 10;
2223  k_chip->nvm_sector_size = 4 << 10;
2224  /* Interleaved */
2225  k_chip->max_flash_prog_size = 1 << 10;
2226  break;
2227  }
2228  break;
2229 
2230  default:
2231  LOG_ERROR("Unsupported S32K1xx-series");
2232  }
2233 
2234  if (k_chip->pflash_sector_size == 0) {
2235  LOG_ERROR("MCU is unsupported, SDID 0x%08" PRIx32, k_chip->sim_sdid);
2237  }
2238 
2239  result = target_read_u32(target, k_chip->sim_base + SIM_FCFG1_OFFSET, &k_chip->sim_fcfg1);
2240  if (result != ERROR_OK)
2241  return result;
2242  k_chip->sim_fcfg2 = 0; /* S32K1xx does not implement FCFG2 register. */
2243 
2244  fcfg1_depart = (k_chip->sim_fcfg1 >> 12) & 0x0f;
2245  fcfg1_eesize = (k_chip->sim_fcfg1 >> 16) & 0x0f;
2246  if (fcfg1_eesize <= 9)
2247  ee_size = (16 << (10 - fcfg1_eesize));
2248  if (fcfg1_depart == 0xf) {
2249  /* Default value. On most S32K1xx, this means FlexNVM is not partitioned. But on S32K148, this
2250  can be valid (and mean 512KB DFlash / 0KB EEPROM backup) _if_ a PGMPART has been previously
2251  launched. We can't distinguish this, so there we treat it as a valid value. */
2252  if (generation == 1 && subseries == 4 && derivate == 8) {
2253  LOG_WARNING("DEPART 0b1111 on S32K148: assuming 512 KiB DFlash. This is only valid if a PGMPART"
2254  " has been previously launched. Use DEPART 0b0000 to avoid this warning.");
2255  k_chip->dflash_size = k_chip->nvm_size;
2256  } else {
2257  k_chip->dflash_size = 0;
2258  }
2259  } else if ((fcfg1_depart & 0x8) == 0) {
2260  /* Binary 0xxx values encode the amount reserved for EEPROM emulation. */
2261  if (fcfg1_depart)
2262  k_chip->dflash_size = k_chip->nvm_size - (4096 << fcfg1_depart);
2263  else
2264  k_chip->dflash_size = k_chip->nvm_size;
2265  } else {
2266  /* Binary 1xxx valued encode the DFlash size. */
2267  if (fcfg1_depart & 0x7)
2268  k_chip->dflash_size = 4096 << (fcfg1_depart & 0x7);
2269  else
2270  k_chip->dflash_size = 0;
2271  }
2272 
2273  snprintf(k_chip->name, sizeof(k_chip->name), "S32K%u%u%u",
2274  generation, subseries, derivate);
2275 
2276  pflash_size_k = k_chip->pflash_size / 1024;
2277  dflash_size_k = k_chip->dflash_size / 1024;
2278 
2279  LOG_INFO("%s detected: %u flash blocks", k_chip->name, k_chip->num_pflash_blocks + k_chip->num_nvm_blocks);
2280  LOG_INFO("%u PFlash banks: %" PRIu32 " KiB total", k_chip->num_pflash_blocks, pflash_size_k);
2281 
2282  nvm_size_k = k_chip->nvm_size / 1024;
2283 
2284  if (k_chip->num_nvm_blocks) {
2285  LOG_INFO("%u FlexNVM banks: %" PRIu32 " KiB total, %" PRIu32 " KiB available as data flash, %"
2286  PRIu32 " bytes FlexRAM",
2287  k_chip->num_nvm_blocks, nvm_size_k, dflash_size_k, ee_size);
2288  }
2289 
2290  k_chip->probed = true;
2291 
2292  if (create_banks)
2294 
2295  return ERROR_OK;
2296 }
2297 
2298 
2299 static int kinetis_probe_chip(struct kinetis_chip *k_chip)
2300 {
2301  int result;
2302  uint8_t fcfg1_nvmsize, fcfg1_pfsize, fcfg1_eesize, fcfg1_depart;
2303  uint8_t fcfg2_pflsh;
2304  uint32_t ee_size = 0;
2305  uint32_t pflash_size_k, nvm_size_k, dflash_size_k;
2306  uint32_t pflash_size_m;
2307  unsigned int num_blocks = 0;
2308  unsigned int maxaddr_shift = 13;
2309  struct target *target = k_chip->target;
2310 
2311  unsigned int familyid = 0, subfamid = 0;
2312  unsigned int cpu_mhz = 120;
2313  bool use_nvm_marking = false;
2314  char flash_marking[12], nvm_marking[2];
2315  char name[40];
2316 
2317  k_chip->probed = false;
2318  k_chip->pflash_sector_size = 0;
2319  k_chip->pflash_base = 0;
2320  k_chip->nvm_base = 0x10000000;
2321  k_chip->progr_accel_ram = FLEXRAM;
2322 
2323  name[0] = '\0';
2324 
2325  if (k_chip->sim_base)
2326  result = target_read_u32(target, k_chip->sim_base + SIM_SDID_OFFSET, &k_chip->sim_sdid);
2327  else {
2328  result = target_read_u32(target, SIM_BASE + SIM_SDID_OFFSET, &k_chip->sim_sdid);
2329  if (result == ERROR_OK)
2330  k_chip->sim_base = SIM_BASE;
2331  else {
2333  if (result == ERROR_OK)
2334  k_chip->sim_base = SIM_BASE_KL28;
2335  }
2336  }
2337  if (result != ERROR_OK)
2338  return result;
2339 
2340  if ((k_chip->sim_sdid & (~KINETIS_SDID_K_SERIES_MASK)) == 0) {
2341  /* older K-series MCU */
2342  uint32_t mcu_type = k_chip->sim_sdid & KINETIS_K_SDID_TYPE_MASK;
2343  k_chip->cache_type = KINETIS_CACHE_K;
2344  k_chip->watchdog_type = KINETIS_WDOG_K;
2345 
2346  switch (mcu_type) {
2349  /* 1kB sectors */
2350  k_chip->pflash_sector_size = 1<<10;
2351  k_chip->nvm_sector_size = 1<<10;
2352  num_blocks = 2;
2353  k_chip->flash_support = FS_PROGRAM_LONGWORD | FS_PROGRAM_SECTOR;
2354  break;
2362  /* 2kB sectors, 1kB FlexNVM sectors */
2363  k_chip->pflash_sector_size = 2<<10;
2364  k_chip->nvm_sector_size = 1<<10;
2365  num_blocks = 2;
2366  k_chip->flash_support = FS_PROGRAM_LONGWORD | FS_PROGRAM_SECTOR;
2367  k_chip->max_flash_prog_size = 1<<10;
2368  break;
2371  case KINETIS_K_SDID_K11:
2372  case KINETIS_K_SDID_K12:
2376  case KINETIS_K_SDID_K53:
2378  /* 2kB sectors */
2379  k_chip->pflash_sector_size = 2<<10;
2380  k_chip->nvm_sector_size = 2<<10;
2381  num_blocks = 2;
2382  k_chip->flash_support = FS_PROGRAM_LONGWORD | FS_PROGRAM_SECTOR;
2383  break;
2386  /* 4kB sectors (MK21FN1M0, MK21FX512, MK22FN1M0, MK22FX512) */
2387  k_chip->pflash_sector_size = 4<<10;
2388  k_chip->max_flash_prog_size = 1<<10;
2389  k_chip->nvm_sector_size = 4<<10;
2390  num_blocks = 2;
2391  k_chip->flash_support = FS_PROGRAM_PHRASE | FS_PROGRAM_SECTOR;
2392  break;
2397  /* 4kB sectors */
2398  k_chip->pflash_sector_size = 4<<10;
2399  k_chip->nvm_sector_size = 4<<10;
2400  num_blocks = 4;
2401  k_chip->flash_support = FS_PROGRAM_PHRASE | FS_PROGRAM_SECTOR;
2402  break;
2403  default:
2404  LOG_ERROR("Unsupported K-family FAMID");
2405  }
2406 
2407  for (size_t idx = 0; idx < ARRAY_SIZE(kinetis_types_old); idx++) {
2408  if (kinetis_types_old[idx].sdid == mcu_type) {
2409  strcpy(name, kinetis_types_old[idx].name);
2410  use_nvm_marking = true;
2411  break;
2412  }
2413  }
2414 
2415  /* first revision of some devices has no SMC */
2416  switch (mcu_type) {
2422  {
2423  uint32_t revid = (k_chip->sim_sdid & KINETIS_K_REVID_MASK) >> KINETIS_K_REVID_SHIFT;
2424  /* highest bit set corresponds to rev 2.x */
2425  if (revid <= 7) {
2426  k_chip->sysmodectrlr_type = KINETIS_MC;
2427  strcat(name, " Rev 1.x");
2428  }
2429  }
2430  break;
2431  }
2432 
2433  } else {
2434  /* Newer K-series or KL series MCU */
2437 
2438  switch (k_chip->sim_sdid & KINETIS_SDID_SERIESID_MASK) {
2440  use_nvm_marking = true;
2441  k_chip->cache_type = KINETIS_CACHE_K;
2442  k_chip->watchdog_type = KINETIS_WDOG_K;
2443 
2446  /* K02FN64, K02FN128: FTFA, 2kB sectors */
2447  k_chip->pflash_sector_size = 2<<10;
2448  num_blocks = 1;
2449  k_chip->flash_support = FS_PROGRAM_LONGWORD;
2450  cpu_mhz = 100;
2451  break;
2452 
2454  /* MK24FN1M reports as K22, this should detect it (according to errata note 1N83J) */
2455  uint32_t sopt1;
2456  result = target_read_u32(target, k_chip->sim_base + SIM_SOPT1_OFFSET, &sopt1);
2457  if (result != ERROR_OK)
2458  return result;
2459 
2462  /* MK24FN1M */
2463  k_chip->pflash_sector_size = 4<<10;
2464  num_blocks = 2;
2465  k_chip->flash_support = FS_PROGRAM_PHRASE | FS_PROGRAM_SECTOR;
2466  k_chip->max_flash_prog_size = 1<<10;
2467  subfamid = 4; /* errata 1N83J fix */
2468  break;
2469  }
2473  /* K22 with new-style SDID - smaller pflash with FTFA, 2kB sectors */
2474  k_chip->pflash_sector_size = 2<<10;
2475  /* autodetect 1 or 2 blocks */
2476  k_chip->flash_support = FS_PROGRAM_LONGWORD;
2477  break;
2478  }
2479  LOG_ERROR("Unsupported Kinetis K22 DIEID");
2480  break;
2481  }
2483  k_chip->pflash_sector_size = 4<<10;
2485  /* K24FN256 - smaller pflash with FTFA */
2486  num_blocks = 1;
2487  k_chip->flash_support = FS_PROGRAM_LONGWORD;
2488  break;
2489  }
2490  /* K24FN1M without errata 7534 */
2491  num_blocks = 2;
2492  k_chip->flash_support = FS_PROGRAM_PHRASE | FS_PROGRAM_SECTOR;
2493  k_chip->max_flash_prog_size = 1<<10;
2494  break;
2495 
2496  case KINETIS_SDID_FAMILYID_K6X | KINETIS_SDID_SUBFAMID_KX1: /* errata 7534 - should be K63 */
2497  case KINETIS_SDID_FAMILYID_K6X | KINETIS_SDID_SUBFAMID_KX2: /* errata 7534 - should be K64 */
2498  subfamid += 2; /* errata 7534 fix */
2499  /* fallthrough */
2501  /* K63FN1M0 */
2503  /* K64FN1M0, K64FX512 */
2504  k_chip->pflash_sector_size = 4<<10;
2505  k_chip->nvm_sector_size = 4<<10;
2506  k_chip->max_flash_prog_size = 1<<10;
2507  num_blocks = 2;
2508  k_chip->flash_support = FS_PROGRAM_PHRASE | FS_PROGRAM_SECTOR;
2509  break;
2510 
2512  /* K26FN2M0 */
2514  /* K66FN2M0, K66FX1M0 */
2515  k_chip->pflash_sector_size = 4<<10;
2516  k_chip->nvm_sector_size = 4<<10;
2517  k_chip->max_flash_prog_size = 1<<10;
2518  num_blocks = 4;
2519  k_chip->flash_support = FS_PROGRAM_PHRASE | FS_PROGRAM_SECTOR | FS_ECC;
2520  cpu_mhz = 180;
2521  break;
2522 
2524  /* K27FN2M0 */
2526  /* K28FN2M0 */
2527  k_chip->pflash_sector_size = 4<<10;
2528  k_chip->max_flash_prog_size = 1<<10;
2529  num_blocks = 4;
2530  k_chip->flash_support = FS_PROGRAM_PHRASE | FS_PROGRAM_SECTOR | FS_ECC;
2531  cpu_mhz = 150;
2532  break;
2533 
2537  /* K80FN256, K81FN256, K82FN256 */
2538  k_chip->pflash_sector_size = 4<<10;
2539  num_blocks = 1;
2540  k_chip->flash_support = FS_PROGRAM_LONGWORD | FS_NO_CMD_BLOCKSTAT;
2541  cpu_mhz = 150;
2542  break;
2543 
2546  /* KL81Z128, KL82Z128 */
2547  k_chip->pflash_sector_size = 2<<10;
2548  num_blocks = 1;
2549  k_chip->flash_support = FS_PROGRAM_LONGWORD | FS_NO_CMD_BLOCKSTAT;
2550  k_chip->cache_type = KINETIS_CACHE_L;
2551 
2552  use_nvm_marking = false;
2553  snprintf(name, sizeof(name), "MKL8%uZ%%s7",
2554  subfamid);
2555  break;
2556 
2557  default:
2558  LOG_ERROR("Unsupported Kinetis FAMILYID SUBFAMID");
2559  }
2560 
2561  if (name[0] == '\0')
2562  snprintf(name, sizeof(name), "MK%u%uF%%s%u",
2563  familyid, subfamid, cpu_mhz / 10);
2564  break;
2565 
2567  /* KL-series */
2568  k_chip->pflash_sector_size = 1<<10;
2569  k_chip->nvm_sector_size = 1<<10;
2570  /* autodetect 1 or 2 blocks */
2571  k_chip->flash_support = FS_PROGRAM_LONGWORD;
2572  k_chip->cache_type = KINETIS_CACHE_L;
2573  k_chip->watchdog_type = KINETIS_WDOG_COP;
2574 
2575  cpu_mhz = 48;
2579  subfamid = 7;
2580  break;
2581 
2583  cpu_mhz = 72;
2584  k_chip->pflash_sector_size = 2<<10;
2585  num_blocks = 2;
2586  k_chip->watchdog_type = KINETIS_WDOG32_KL28;
2587  k_chip->sysmodectrlr_type = KINETIS_SMC32;
2588  break;
2589  }
2590 
2591  snprintf(name, sizeof(name), "MKL%u%uZ%%s%u",
2592  familyid, subfamid, cpu_mhz / 10);
2593  break;
2594 
2596  /* Newer KW-series (all KW series except KW2xD, KW01Z) */
2597  cpu_mhz = 48;
2600  /* KW40Z */
2602  /* KW30Z */
2604  /* KW20Z */
2605  /* FTFA, 1kB sectors */
2606  k_chip->pflash_sector_size = 1<<10;
2607  k_chip->nvm_sector_size = 1<<10;
2608  /* autodetect 1 or 2 blocks */
2609  k_chip->flash_support = FS_PROGRAM_LONGWORD;
2610  k_chip->cache_type = KINETIS_CACHE_L;
2611  k_chip->watchdog_type = KINETIS_WDOG_COP;
2612  break;
2614  /* KW41Z */
2616  /* KW31Z */
2618  /* KW21Z */
2619  /* FTFA, 2kB sectors */
2620  k_chip->pflash_sector_size = 2<<10;
2621  k_chip->nvm_sector_size = 2<<10;
2622  /* autodetect 1 or 2 blocks */
2623  k_chip->flash_support = FS_PROGRAM_LONGWORD;
2624  k_chip->cache_type = KINETIS_CACHE_L;
2625  k_chip->watchdog_type = KINETIS_WDOG_COP;
2626  break;
2627  default:
2628  LOG_ERROR("Unsupported KW FAMILYID SUBFAMID");
2629  }
2630  snprintf(name, sizeof(name), "MKW%u%uZ%%s%u",
2631  familyid, subfamid, cpu_mhz / 10);
2632  break;
2633 
2635  /* KV-series */
2636  k_chip->watchdog_type = KINETIS_WDOG_K;
2639  /* KV10: FTFA, 1kB sectors */
2640  k_chip->pflash_sector_size = 1<<10;
2641  num_blocks = 1;
2642  k_chip->flash_support = FS_PROGRAM_LONGWORD;
2643  k_chip->cache_type = KINETIS_CACHE_L;
2644  strcpy(name, "MKV10Z%s7");
2645  break;
2646 
2648  /* KV11: FTFA, 2kB sectors */
2649  k_chip->pflash_sector_size = 2<<10;
2650  num_blocks = 1;
2651  k_chip->flash_support = FS_PROGRAM_LONGWORD;
2652  k_chip->cache_type = KINETIS_CACHE_L;
2653  strcpy(name, "MKV11Z%s7");
2654  break;
2655 
2657  /* KV30: FTFA, 2kB sectors, 1 block */
2659  /* KV31: FTFA, 2kB sectors, 2 blocks */
2660  k_chip->pflash_sector_size = 2<<10;
2661  /* autodetect 1 or 2 blocks */
2662  k_chip->flash_support = FS_PROGRAM_LONGWORD;
2663  k_chip->cache_type = KINETIS_CACHE_K;
2664  break;
2665 
2669  /* KV4x: FTFA, 4kB sectors */
2670  k_chip->pflash_sector_size = 4<<10;
2671  num_blocks = 1;
2672  k_chip->flash_support = FS_PROGRAM_LONGWORD;
2673  k_chip->cache_type = KINETIS_CACHE_K;
2674  cpu_mhz = 168;
2675  break;
2676 
2679  /* KV5x: FTFE, 8kB sectors */
2680  k_chip->pflash_sector_size = 8<<10;
2681  k_chip->max_flash_prog_size = 1<<10;
2682  num_blocks = 1;
2683  maxaddr_shift = 14;
2684  k_chip->flash_support = FS_PROGRAM_PHRASE | FS_PROGRAM_SECTOR | FS_WIDTH_256BIT | FS_ECC;
2685  k_chip->pflash_base = 0x10000000;
2686  k_chip->progr_accel_ram = 0x18000000;
2687  cpu_mhz = 240;
2688  break;
2689 
2690  default:
2691  LOG_ERROR("Unsupported KV FAMILYID SUBFAMID");
2692  }
2693 
2694  if (name[0] == '\0')
2695  snprintf(name, sizeof(name), "MKV%u%uF%%s%u",
2696  familyid, subfamid, cpu_mhz / 10);
2697  break;
2698 
2700  /* KE1x-series */
2701  k_chip->watchdog_type = KINETIS_WDOG32_KE1X;
2702  switch (k_chip->sim_sdid &
2706  /* KE1xZ: FTFE, 2kB sectors */
2707  k_chip->pflash_sector_size = 2<<10;
2708  k_chip->nvm_sector_size = 2<<10;
2709  k_chip->max_flash_prog_size = 1<<9;
2710  num_blocks = 2;
2711  k_chip->flash_support = FS_PROGRAM_PHRASE | FS_PROGRAM_SECTOR;
2712  k_chip->cache_type = KINETIS_CACHE_L;
2713 
2714  cpu_mhz = 72;
2715  snprintf(name, sizeof(name), "MKE%u%uZ%%s%u",
2716  familyid, subfamid, cpu_mhz / 10);
2717  break;
2718 
2722  /* KE1xF: FTFE, 4kB sectors */
2723  k_chip->pflash_sector_size = 4<<10;
2724  k_chip->nvm_sector_size = 2<<10;
2725  k_chip->max_flash_prog_size = 1<<10;
2726  num_blocks = 2;
2727  k_chip->flash_support = FS_PROGRAM_PHRASE | FS_PROGRAM_SECTOR;
2728  k_chip->cache_type = KINETIS_CACHE_MSCM;
2729 
2730  cpu_mhz = 168;
2731  snprintf(name, sizeof(name), "MKE%u%uF%%s%u",
2732  familyid, subfamid, cpu_mhz / 10);
2733  break;
2734 
2735  default:
2736  LOG_ERROR("Unsupported KE FAMILYID SUBFAMID");
2737  }
2738  break;
2739 
2740  default:
2741  LOG_ERROR("Unsupported K-series");
2742  }
2743  }
2744 
2745  if (k_chip->pflash_sector_size == 0) {
2746  LOG_ERROR("MCU is unsupported, SDID 0x%08" PRIx32, k_chip->sim_sdid);
2748  }
2749 
2750  result = target_read_u32(target, k_chip->sim_base + SIM_FCFG1_OFFSET, &k_chip->sim_fcfg1);
2751  if (result != ERROR_OK)
2752  return result;
2753 
2754  result = target_read_u32(target, k_chip->sim_base + SIM_FCFG2_OFFSET, &k_chip->sim_fcfg2);
2755  if (result != ERROR_OK)
2756  return result;
2757 
2758  LOG_DEBUG("SDID: 0x%08" PRIX32 " FCFG1: 0x%08" PRIX32 " FCFG2: 0x%08" PRIX32, k_chip->sim_sdid,
2759  k_chip->sim_fcfg1, k_chip->sim_fcfg2);
2760 
2761  fcfg1_nvmsize = (uint8_t)((k_chip->sim_fcfg1 >> 28) & 0x0f);
2762  fcfg1_pfsize = (uint8_t)((k_chip->sim_fcfg1 >> 24) & 0x0f);
2763  fcfg1_eesize = (uint8_t)((k_chip->sim_fcfg1 >> 16) & 0x0f);
2764  fcfg1_depart = (uint8_t)((k_chip->sim_fcfg1 >> 8) & 0x0f);
2765 
2766  fcfg2_pflsh = (uint8_t)((k_chip->sim_fcfg2 >> 23) & 0x01);
2767  k_chip->fcfg2_maxaddr0_shifted = ((k_chip->sim_fcfg2 >> 24) & 0x7f) << maxaddr_shift;
2768  k_chip->fcfg2_maxaddr1_shifted = ((k_chip->sim_fcfg2 >> 16) & 0x7f) << maxaddr_shift;
2769 
2770  if (num_blocks == 0)
2771  num_blocks = k_chip->fcfg2_maxaddr1_shifted ? 2 : 1;
2772  else if (k_chip->fcfg2_maxaddr1_shifted == 0 && num_blocks >= 2 && fcfg2_pflsh) {
2773  /* fcfg2_maxaddr1 may be zero due to partitioning whole NVM as EEPROM backup
2774  * Do not adjust block count in this case! */
2775  num_blocks = 1;
2776  LOG_WARNING("MAXADDR1 is zero, number of flash banks adjusted to 1");
2777  } else if (k_chip->fcfg2_maxaddr1_shifted != 0 && num_blocks == 1) {
2778  num_blocks = 2;
2779  LOG_WARNING("MAXADDR1 is non zero, number of flash banks adjusted to 2");
2780  }
2781 
2782  /* when the PFLSH bit is set, there is no FlexNVM/FlexRAM */
2783  if (!fcfg2_pflsh) {
2784  switch (fcfg1_nvmsize) {
2785  case 0x03:
2786  case 0x05:
2787  case 0x07:
2788  case 0x09:
2789  case 0x0b:
2790  k_chip->nvm_size = 1 << (14 + (fcfg1_nvmsize >> 1));
2791  break;
2792  case 0x0f:
2793  if (k_chip->pflash_sector_size >= 4<<10)
2794  k_chip->nvm_size = 512<<10;
2795  else
2796  /* K20_100 */
2797  k_chip->nvm_size = 256<<10;
2798  break;
2799  default:
2800  k_chip->nvm_size = 0;
2801  break;
2802  }
2803 
2804  switch (fcfg1_eesize) {
2805  case 0x00:
2806  case 0x01:
2807  case 0x02:
2808  case 0x03:
2809  case 0x04:
2810  case 0x05:
2811  case 0x06:
2812  case 0x07:
2813  case 0x08:
2814  case 0x09:
2815  ee_size = (16 << (10 - fcfg1_eesize));
2816  break;
2817  default:
2818  ee_size = 0;
2819  break;
2820  }
2821 
2822  switch (fcfg1_depart) {
2823  case 0x01:
2824  case 0x02:
2825  case 0x03:
2826  case 0x04:
2827  case 0x05:
2828  case 0x06:
2829  k_chip->dflash_size = k_chip->nvm_size - (4096 << fcfg1_depart);
2830  break;
2831  case 0x07:
2832  case 0x08:
2833  k_chip->dflash_size = 0;
2834  break;
2835  case 0x09:
2836  case 0x0a:
2837  case 0x0b:
2838  case 0x0c:
2839  case 0x0d:
2840  k_chip->dflash_size = 4096 << (fcfg1_depart & 0x7);
2841  break;
2842  default:
2843  k_chip->dflash_size = k_chip->nvm_size;
2844  break;
2845  }
2846  }
2847 
2848  switch (fcfg1_pfsize) {
2849  case 0x00:
2850  k_chip->pflash_size = 8192;
2851  break;
2852  case 0x01:
2853  case 0x03:
2854  case 0x05:
2855  case 0x07:
2856  case 0x09:
2857  case 0x0b:
2858  case 0x0d:
2859  k_chip->pflash_size = 1 << (14 + (fcfg1_pfsize >> 1));
2860  break;
2861  case 0x0f:
2862  /* a peculiar case: Freescale states different sizes for 0xf
2863  * KL03P24M48SF0RM 32 KB .... duplicate of code 0x3
2864  * K02P64M100SFARM 128 KB ... duplicate of code 0x7
2865  * K22P121M120SF8RM 256 KB ... duplicate of code 0x9
2866  * K22P121M120SF7RM 512 KB ... duplicate of code 0xb
2867  * K22P100M120SF5RM 1024 KB ... duplicate of code 0xd
2868  * K26P169M180SF5RM 2048 KB ... the only unique value
2869  * fcfg2_maxaddr0 seems to be the only clue to pflash_size
2870  * Checking fcfg2_maxaddr0 in bank probe is pointless then
2871  */
2872  if (fcfg2_pflsh)
2873  k_chip->pflash_size = k_chip->fcfg2_maxaddr0_shifted * num_blocks;
2874  else
2875  k_chip->pflash_size = k_chip->fcfg2_maxaddr0_shifted * num_blocks / 2;
2876  if (k_chip->pflash_size != 2048<<10)
2877  LOG_WARNING("SIM_FCFG1 PFSIZE = 0xf: please check if pflash is %" PRIu32 " KB", k_chip->pflash_size>>10);
2878 
2879  break;
2880  default:
2881  k_chip->pflash_size = 0;
2882  break;
2883  }
2884 
2885  if (k_chip->flash_support & FS_PROGRAM_SECTOR && k_chip->max_flash_prog_size == 0) {
2886  k_chip->max_flash_prog_size = k_chip->pflash_sector_size;
2887  /* Program section size is equal to sector size by default */
2888  }
2889 
2890  if (fcfg2_pflsh) {
2891  k_chip->num_pflash_blocks = num_blocks;
2892  k_chip->num_nvm_blocks = 0;
2893  } else {
2894  k_chip->num_pflash_blocks = (num_blocks + 1) / 2;
2895  k_chip->num_nvm_blocks = num_blocks - k_chip->num_pflash_blocks;
2896  }
2897 
2898  if (use_nvm_marking) {
2899  nvm_marking[0] = k_chip->num_nvm_blocks ? 'X' : 'N';
2900  nvm_marking[1] = '\0';
2901  } else
2902  nvm_marking[0] = '\0';
2903 
2904  pflash_size_k = k_chip->pflash_size / 1024;
2905  pflash_size_m = pflash_size_k / 1024;
2906  if (pflash_size_m)
2907  snprintf(flash_marking, sizeof(flash_marking), "%s%" PRIu32 "M0xxx", nvm_marking, pflash_size_m);
2908  else
2909  snprintf(flash_marking, sizeof(flash_marking), "%s%" PRIu32 "xxx", nvm_marking, pflash_size_k);
2910 
2911  snprintf(k_chip->name, sizeof(k_chip->name), name, flash_marking);
2912  LOG_INFO("Kinetis %s detected: %u flash blocks", k_chip->name, num_blocks);
2913  LOG_INFO("%u PFlash banks: %" PRIu32 " KiB total", k_chip->num_pflash_blocks, pflash_size_k);
2914  if (k_chip->num_nvm_blocks) {
2915  nvm_size_k = k_chip->nvm_size / 1024;
2916  dflash_size_k = k_chip->dflash_size / 1024;
2917  LOG_INFO("%u FlexNVM banks: %" PRIu32 " KiB total, %" PRIu32 " KiB available as data flash, %"
2918  PRIu32 " bytes FlexRAM", k_chip->num_nvm_blocks, nvm_size_k, dflash_size_k, ee_size);
2919  }
2920 
2921  k_chip->probed = true;
2922 
2923  if (create_banks)
2925 
2926  return ERROR_OK;
2927 }
2928 
2929 static int kinetis_probe(struct flash_bank *bank)
2930 {
2931  int result;
2932  uint8_t fcfg2_maxaddr0, fcfg2_pflsh, fcfg2_maxaddr1;
2933  unsigned int num_blocks, first_nvm_bank;
2934  uint32_t size_k;
2935  struct kinetis_flash_bank *k_bank = bank->driver_priv;
2936  struct kinetis_chip *k_chip;
2937 
2938  assert(k_bank);
2939  k_chip = k_bank->k_chip;
2940 
2941  k_bank->probed = false;
2942 
2943  if (!k_chip->probed) {
2944  switch (k_chip->chip_type) {
2945  case KINETIS_CT_S32K:
2946  result = kinetis_probe_chip_s32k(k_chip);
2947  break;
2948  default:
2949  result = kinetis_probe_chip(k_chip);
2950  }
2951  if (result != ERROR_OK)
2952  return result;
2953  }
2954 
2955  num_blocks = k_chip->num_pflash_blocks + k_chip->num_nvm_blocks;
2956  first_nvm_bank = k_chip->num_pflash_blocks;
2957 
2958  if (k_bank->bank_number < k_chip->num_pflash_blocks) {
2959  /* pflash, banks start at address zero */
2960  k_bank->flash_class = FC_PFLASH;
2961  bank->size = (k_chip->pflash_size / k_chip->num_pflash_blocks);
2962  bank->base = k_chip->pflash_base + bank->size * k_bank->bank_number;
2963  k_bank->prog_base = 0x00000000 + bank->size * k_bank->bank_number;
2964  k_bank->sector_size = k_chip->pflash_sector_size;
2965  /* pflash is divided into 32 protection areas for
2966  * parts with more than 32K of PFlash. For parts with
2967  * less the protection unit is set to 1024 bytes */
2968  k_bank->protection_size = MAX(k_chip->pflash_size / 32, 1024);
2969  bank->num_prot_blocks = bank->size / k_bank->protection_size;
2970  k_bank->protection_block = bank->num_prot_blocks * k_bank->bank_number;
2971 
2972  size_k = bank->size / 1024;
2973  LOG_DEBUG("Kinetis bank %u: %" PRIu32 "k PFlash, FTFx base 0x%08" PRIx32 ", sect %" PRIu32,
2974  k_bank->bank_number, size_k, k_bank->prog_base, k_bank->sector_size);
2975 
2976  } else if (k_bank->bank_number < num_blocks) {
2977  /* nvm, banks start at address 0x10000000 */
2978  unsigned int nvm_ord = k_bank->bank_number - first_nvm_bank;
2979  uint32_t limit;
2980 
2981  k_bank->flash_class = FC_FLEX_NVM;
2982  bank->size = k_chip->nvm_size / k_chip->num_nvm_blocks;
2983  bank->base = k_chip->nvm_base + bank->size * nvm_ord;
2984  k_bank->prog_base = 0x00800000 + bank->size * nvm_ord;
2985  k_bank->sector_size = k_chip->nvm_sector_size;
2986  if (k_chip->dflash_size == 0) {
2987  k_bank->protection_size = 0;
2988  } else {
2989  int i;
2990  for (i = k_chip->dflash_size; ~i & 1; i >>= 1)
2991  ;
2992  if (i == 1)
2993  k_bank->protection_size = k_chip->dflash_size / 8; /* data flash size = 2^^n */
2994  else
2995  k_bank->protection_size = k_chip->nvm_size / 8; /* TODO: verify on SF1, not documented in RM */
2996  }
2997  bank->num_prot_blocks = 8 / k_chip->num_nvm_blocks;
2998  k_bank->protection_block = bank->num_prot_blocks * nvm_ord;
2999 
3000  /* EEPROM backup part of FlexNVM is not accessible, use dflash_size as a limit */
3001  if (k_chip->dflash_size > bank->size * nvm_ord)
3002  limit = k_chip->dflash_size - bank->size * nvm_ord;
3003  else
3004  limit = 0;
3005 
3006  if (bank->size > limit) {
3007  bank->size = limit;
3008  LOG_DEBUG("FlexNVM bank %u limited to 0x%08" PRIx32 " due to active EEPROM backup",
3009  k_bank->bank_number, limit);
3010  }
3011 
3012  size_k = bank->size / 1024;
3013  LOG_DEBUG("Kinetis bank %u: %" PRIu32 "k FlexNVM, FTFx base 0x%08" PRIx32 ", sect %" PRIu32,
3014  k_bank->bank_number, size_k, k_bank->prog_base, k_bank->sector_size);
3015 
3016  } else {
3017  LOG_ERROR("Cannot determine parameters for bank %u, only %u banks on device",
3018  k_bank->bank_number, num_blocks);
3019  return ERROR_FLASH_BANK_INVALID;
3020  }
3021 
3022  /* S32K1xx does not implement FCFG2 register. Skip checks. */
3023  if (k_chip->chip_type != KINETIS_CT_S32K) {
3024  fcfg2_pflsh = (uint8_t)((k_chip->sim_fcfg2 >> 23) & 0x01);
3025  fcfg2_maxaddr0 = (uint8_t)((k_chip->sim_fcfg2 >> 24) & 0x7f);
3026  fcfg2_maxaddr1 = (uint8_t)((k_chip->sim_fcfg2 >> 16) & 0x7f);
3027 
3028  if (k_bank->bank_number == 0 && k_chip->fcfg2_maxaddr0_shifted != bank->size)
3029  LOG_WARNING("MAXADDR0 0x%02" PRIx8 " check failed,"
3030  " please report to OpenOCD mailing list", fcfg2_maxaddr0);
3031 
3032  if (fcfg2_pflsh) {
3033  if (k_bank->bank_number == 1 && k_chip->fcfg2_maxaddr1_shifted != bank->size)
3034  LOG_WARNING("MAXADDR1 0x%02" PRIx8 " check failed,"
3035  " please report to OpenOCD mailing list", fcfg2_maxaddr1);
3036  } else {
3037  if (k_bank->bank_number == first_nvm_bank
3038  && k_chip->fcfg2_maxaddr1_shifted != k_chip->dflash_size)
3039  LOG_WARNING("FlexNVM MAXADDR1 0x%02" PRIx8 " check failed,"
3040  " please report to OpenOCD mailing list", fcfg2_maxaddr1);
3041  }
3042  }
3043 
3044  free(bank->sectors);
3045  bank->sectors = NULL;
3046 
3047  free(bank->prot_blocks);
3048  bank->prot_blocks = NULL;
3049 
3050  if (k_bank->sector_size == 0) {
3051  LOG_ERROR("Unknown sector size for bank %u", bank->bank_number);
3052  return ERROR_FLASH_BANK_INVALID;
3053  }
3054 
3055  bank->num_sectors = bank->size / k_bank->sector_size;
3056 
3057  if (bank->num_sectors > 0) {
3058  /* FlexNVM bank can be used for EEPROM backup therefore zero sized */
3059  bank->sectors = alloc_block_array(0, k_bank->sector_size, bank->num_sectors);
3060  if (!bank->sectors)
3061  return ERROR_FAIL;
3062 
3063  bank->prot_blocks = alloc_block_array(0, k_bank->protection_size, bank->num_prot_blocks);
3064  if (!bank->prot_blocks)
3065  return ERROR_FAIL;
3066 
3067  } else {
3068  bank->num_prot_blocks = 0;
3069  }
3070 
3071  k_bank->probed = true;
3072 
3073  return ERROR_OK;
3074 }
3075 
3077 {
3078  struct kinetis_flash_bank *k_bank = bank->driver_priv;
3079 
3080  if (k_bank && k_bank->probed)
3081  return ERROR_OK;
3082 
3083  return kinetis_probe(bank);
3084 }
3085 
3086 static int kinetis_info(struct flash_bank *bank, struct command_invocation *cmd)
3087 {
3088  const char *bank_class_names[] = {
3089  "(ANY)", "PFlash", "FlexNVM", "FlexRAM"
3090  };
3091 
3092  struct kinetis_flash_bank *k_bank = bank->driver_priv;
3093  struct kinetis_chip *k_chip = k_bank->k_chip;
3094  uint32_t size_k = bank->size / 1024;
3095 
3097  "%s %s: %" PRIu32 "k %s bank %s at " TARGET_ADDR_FMT,
3098  bank->driver->name, k_chip->name,
3099  size_k, bank_class_names[k_bank->flash_class],
3100  bank->name, bank->base);
3101 
3102  return ERROR_OK;
3103 }
3104 
3106 {
3107  struct kinetis_flash_bank *k_bank = bank->driver_priv;
3108  struct kinetis_chip *k_chip = k_bank->k_chip;
3109  int result;
3110 
3111  /* surprisingly blank check does not work in VLPR and HSRUN modes */
3112  result = kinetis_check_run_mode(k_chip);
3113  if (result != ERROR_OK)
3114  return result;
3115 
3116  /* reset error flags */
3117  result = kinetis_ftfx_prepare(bank->target);
3118  if (result != ERROR_OK)
3119  return result;
3120 
3121  if (k_bank->flash_class == FC_PFLASH || k_bank->flash_class == FC_FLEX_NVM) {
3122  bool block_dirty = true;
3123  bool use_block_cmd = !(k_chip->flash_support & FS_NO_CMD_BLOCKSTAT);
3124  uint8_t ftfx_fstat;
3125 
3126  if (use_block_cmd && k_bank->flash_class == FC_FLEX_NVM) {
3127  uint8_t fcfg1_depart = kinetis_fcfg1_depart(k_chip->chip_type, k_chip->sim_fcfg1);
3128  /* block operation cannot be used on FlexNVM when EEPROM backup partition is set */
3129  if (fcfg1_depart != 0xf && fcfg1_depart != 0)
3130  use_block_cmd = false;
3131  }
3132 
3133  if (use_block_cmd) {
3134  /* check if whole bank is blank */
3135  result = kinetis_ftfx_command(bank->target, FTFX_CMD_BLOCKSTAT, k_bank->prog_base,
3136  0, 0, 0, 0, 0, 0, 0, 0, &ftfx_fstat);
3137 
3138  if (result != ERROR_OK)
3139  kinetis_ftfx_clear_error(bank->target);
3140  else if ((ftfx_fstat & 0x01) == 0)
3141  block_dirty = false;
3142  }
3143 
3144  if (block_dirty) {
3145  /* the whole bank is not erased, check sector-by-sector */
3146  for (unsigned int i = 0; i < bank->num_sectors; i++) {
3147  /* normal margin */
3148  result = kinetis_ftfx_command(bank->target, FTFX_CMD_SECTSTAT,
3149  k_bank->prog_base + bank->sectors[i].offset,
3150  1, 0, 0, 0, 0, 0, 0, 0, &ftfx_fstat);
3151 
3152  if (result == ERROR_OK) {
3153  bank->sectors[i].is_erased = !(ftfx_fstat & 0x01);
3154  } else {
3155  LOG_DEBUG("Ignoring error on PFlash sector blank-check");
3156  kinetis_ftfx_clear_error(bank->target);
3157  bank->sectors[i].is_erased = -1;
3158  }
3159  }
3160  } else {
3161  /* the whole bank is erased, update all sectors */
3162  for (unsigned int i = 0; i < bank->num_sectors; i++)
3163  bank->sectors[i].is_erased = 1;
3164  }
3165  } else {
3166  LOG_WARNING("kinetis_blank_check not supported yet for FlexRAM");
3168  }
3169 
3170  return ERROR_OK;
3171 }
3172 
3173 
3174 COMMAND_HANDLER(kinetis_nvm_partition)
3175 {
3176  int result;
3177  unsigned int bank_idx;
3178  unsigned int num_blocks, first_nvm_bank;
3179  unsigned long par, log2 = 0, ee1 = 0, ee2 = 0;
3180  enum { SHOW_INFO, DF_SIZE, EEBKP_SIZE } sz_type = SHOW_INFO;
3181  bool enable;
3182  uint8_t load_flex_ram = 1;
3183  uint8_t ee_size_code = 0x3f;
3184  uint8_t flex_nvm_partition_code = 0;
3185  uint8_t ee_split = 3;
3186  uint8_t csec_key_size = 0;
3188  struct kinetis_chip *k_chip;
3189  uint32_t sim_fcfg1;
3190 
3191  k_chip = kinetis_get_chip(target);
3192  if (!k_chip) {
3193  command_print(CMD, "[%s] is not a Kinetis chip", target_name(target));
3194  return ERROR_FAIL;
3195  }
3196 
3197  if (CMD_ARGC >= 2) {
3198  if (strcmp(CMD_ARGV[0], "dataflash") == 0)
3199  sz_type = DF_SIZE;
3200  else if (strcmp(CMD_ARGV[0], "eebkp") == 0)
3201  sz_type = EEBKP_SIZE;
3202 
3203  COMMAND_PARSE_NUMBER(ulong, CMD_ARGV[1], par);
3204  while (par >> (log2 + 3))
3205  log2++;
3206  }
3207  switch (sz_type) {
3208  case SHOW_INFO:
3209  result = target_read_u32(target, k_chip->sim_base + SIM_FCFG1_OFFSET, &sim_fcfg1);
3210  if (result != ERROR_OK)
3211  return result;
3212 
3213  flex_nvm_partition_code = kinetis_fcfg1_depart(k_chip->chip_type, sim_fcfg1);
3214  switch (flex_nvm_partition_code) {
3215  case 0:
3216  command_print(CMD, "No EEPROM backup, data flash only");
3217  break;
3218  case 1:
3219  case 2:
3220  case 3:
3221  case 4:
3222  case 5:
3223  case 6:
3224  command_print(CMD, "EEPROM backup %d KB", 4 << flex_nvm_partition_code);
3225  break;
3226  case 8:
3227  command_print(CMD, "No data flash, EEPROM backup only");
3228  break;
3229  case 0x9:
3230  case 0xA:
3231  case 0xB:
3232  case 0xC:
3233  case 0xD:
3234  case 0xE:
3235  command_print(CMD, "data flash %d KB", 4 << (flex_nvm_partition_code & 7));
3236  break;
3237  case 0xf:
3238  command_print(CMD, "No EEPROM backup, data flash only (DEPART not set)");
3239  break;
3240  default:
3241  command_print(CMD, "Unsupported EEPROM backup size code 0x%02" PRIx8, flex_nvm_partition_code);
3242  }
3243  return ERROR_OK;
3244 
3245  case DF_SIZE:
3246  flex_nvm_partition_code = 0x8 | log2;
3247  break;
3248 
3249  case EEBKP_SIZE:
3250  flex_nvm_partition_code = log2;
3251  break;
3252  }
3253 
3254  if (CMD_ARGC == 3) {
3255  unsigned long eex;
3256  COMMAND_PARSE_NUMBER(ulong, CMD_ARGV[2], eex);
3257  ee1 = ee2 = eex / 2;
3258  } else if (CMD_ARGC >= 4) {
3259  COMMAND_PARSE_NUMBER(ulong, CMD_ARGV[2], ee1);
3260  COMMAND_PARSE_NUMBER(ulong, CMD_ARGV[3], ee2);
3261  }
3262 
3263  enable = ee1 + ee2 > 0;
3264  if (enable) {
3265  for (log2 = 2; ; log2++) {
3266  if (ee1 + ee2 == (16u << 10) >> log2)
3267  break;
3268  if (ee1 + ee2 > (16u << 10) >> log2 || log2 >= 9) {
3269  command_print(CMD, "Unsupported EEPROM size");
3271  }
3272  }
3273 
3274  if (k_chip->chip_type == KINETIS_CT_S32K && ee1 != ee2) {
3275  command_print(CMD, "S32K1xx EEPROM cannot be split into two blocks");
3277  }
3278 
3279  if (ee1 * 3 == ee2)
3280  ee_split = 1;
3281  else if (ee1 * 7 == ee2)
3282  ee_split = 0;
3283  else if (ee1 != ee2) {
3284  command_print(CMD, "Unsupported EEPROM sizes ratio");
3286  }
3287 
3288  ee_size_code = log2 | ee_split << 4;
3289  }
3290 
3291  if (CMD_ARGC >= 5)
3292  COMMAND_PARSE_ON_OFF(CMD_ARGV[4], enable);
3293  if (enable)
3294  load_flex_ram = 0;
3295 
3296  if (CMD_ARGC >= 6) {
3297  unsigned int csec_keys;
3298 
3299  COMMAND_PARSE_NUMBER(uint, CMD_ARGV[5], csec_keys);
3300  switch (csec_keys) {
3301  case 0:
3302  csec_key_size = 0;
3303  break;
3304  case 5:
3305  csec_key_size = 1;
3306  break;
3307  case 10:
3308  csec_key_size = 2;
3309  break;
3310  case 20:
3311  csec_key_size = 3;
3312  break;
3313  default:
3314  command_print(CMD, "Number of CSEc keys must be 0, 5, 10 or 20");
3316  }
3317  }
3318 
3319  if (csec_key_size) {
3320  if (k_chip->chip_type != KINETIS_CT_S32K) {
3321  command_print(CMD, "CSEc keys not supported on this device");
3323  }
3324  if (!k_chip->probed) {
3325  result = kinetis_probe_chip_s32k(k_chip);
3326  if (result != ERROR_OK)
3327  return result;
3328  }
3329  if (!(k_chip->sim_sdid & KINETIS_SDID_S32K_FEATURE_CSEC)) {
3330  command_print(CMD, "CSEc keys not supported on this device");
3332  }
3333  if (ee1 + ee2 == 0 || load_flex_ram) {
3334  command_print(CMD, "CSEc keys require EEPROM with FlexRAM loading during reset");
3336  }
3337  }
3338 
3339  /* S32K1xx has no EEPROM split and rejects the command if split bits are set */
3340  if (k_chip->chip_type == KINETIS_CT_S32K)
3341  ee_size_code &= 0x0f;
3342 
3343  LOG_INFO("DEPART 0x%" PRIx8 ", EEPROM size code 0x%" PRIx8,
3344  flex_nvm_partition_code, ee_size_code);
3345 
3346  result = kinetis_check_run_mode(k_chip);
3347  if (result != ERROR_OK)
3348  return result;
3349 
3350  /* reset error flags */
3351  result = kinetis_ftfx_prepare(target);
3352  if (result != ERROR_OK)
3353  return result;
3354 
3355  result = kinetis_ftfx_command(target, FTFX_CMD_PGMPART, load_flex_ram | csec_key_size << 16,
3356  ee_size_code, flex_nvm_partition_code, 0, 0,
3357  0, 0, 0, 0, NULL);
3358  if (result != ERROR_OK)
3359  return result;
3360 
3361  command_print(CMD, "FlexNVM partition set. Please reset MCU.");
3362 
3363  first_nvm_bank = k_chip->num_pflash_blocks;
3364  num_blocks = k_chip->num_pflash_blocks + k_chip->num_nvm_blocks;
3365  for (bank_idx = first_nvm_bank; bank_idx < num_blocks; bank_idx++)
3366  k_chip->banks[bank_idx].probed = false; /* re-probe before next use */
3367  k_chip->probed = false;
3368 
3369  command_print(CMD, "FlexNVM banks will be re-probed to set new data flash size.");
3370  return ERROR_OK;
3371 }
3372 
3373 COMMAND_HANDLER(kinetis_fcf_source_handler)
3374 {
3375  if (CMD_ARGC > 1)
3377 
3378  if (CMD_ARGC == 1) {
3379  if (strcmp(CMD_ARGV[0], "write") == 0)
3380  allow_fcf_writes = true;
3381  else if (strcmp(CMD_ARGV[0], "protection") == 0)
3382  allow_fcf_writes = false;
3383  else
3385  }
3386 
3387  if (allow_fcf_writes) {
3388  command_print(CMD, "Arbitrary Flash Configuration Field writes enabled.");
3389  command_print(CMD, "Protection info writes to FCF disabled.");
3390  LOG_WARNING("BEWARE: incorrect flash configuration may permanently lock the device.");
3391  } else {
3392  command_print(CMD, "Protection info writes to Flash Configuration Field enabled.");
3393  command_print(CMD, "Arbitrary FCF writes disabled. Mode safe from unwanted locking of the device.");
3394  }
3395 
3396  return ERROR_OK;
3397 }
3398 
3399 COMMAND_HANDLER(kinetis_fopt_handler)
3400 {
3401  if (CMD_ARGC > 1)
3403 
3404  if (CMD_ARGC == 1) {
3406  } else {
3407  command_print(CMD, "FCF_FOPT 0x%02" PRIx8, fcf_fopt);
3408  }
3409 
3410  return ERROR_OK;
3411 }
3412 
3413 COMMAND_HANDLER(kinetis_create_banks_handler)
3414 {
3415  if (CMD_ARGC > 0)
3417 
3418  create_banks = true;
3419 
3420  return ERROR_OK;
3421 }
3422 
3423 
3425  {
3426  .name = "check_security",
3427  .mode = COMMAND_EXEC,
3428  .help = "Check status of device security lock",
3429  .usage = "",
3430  .handler = kinetis_check_flash_security_status,
3431  },
3432  {
3433  .name = "halt",
3434  .mode = COMMAND_EXEC,
3435  .help = "Issue a halt via the MDM-AP",
3436  .usage = "",
3437  .handler = kinetis_mdm_halt,
3438  },
3439  {
3440  .name = "mass_erase",
3441  .mode = COMMAND_EXEC,
3442  .help = "Issue a complete flash erase via the MDM-AP",
3443  .usage = "",
3444  .handler = kinetis_mdm_mass_erase,
3445  },
3446  {
3447  .name = "reset",
3448  .mode = COMMAND_EXEC,
3449  .help = "Issue a reset via the MDM-AP",
3450  .usage = "",
3451  .handler = kinetis_mdm_reset,
3452  },
3454 };
3455 
3456 static const struct command_registration kinetis_exec_command_handlers[] = {
3457  {
3458  .name = "mdm",
3459  .mode = COMMAND_ANY,
3460  .help = "MDM-AP command group",
3461  .usage = "",
3463  },
3464  {
3465  .name = "disable_wdog",
3466  .mode = COMMAND_EXEC,
3467  .help = "Disable the watchdog timer",
3468  .usage = "",
3469  .handler = kinetis_disable_wdog_handler,
3470  },
3471  {
3472  .name = "nvm_partition",
3473  .mode = COMMAND_EXEC,
3474  .help = "Show/set data flash or EEPROM backup size in kilobytes,"
3475  " set two EEPROM sizes in bytes, FlexRAM loading during reset"
3476  " and number of CSEc keys",
3477  .usage = "('info'|'dataflash' size|'eebkp' size) [eesize1 eesize2] ['on'|'off'] [csec_keys]",
3478  .handler = kinetis_nvm_partition,
3479  },
3480  {
3481  .name = "fcf_source",
3482  .mode = COMMAND_EXEC,
3483  .help = "Use protection as a source for Flash Configuration Field or allow writing arbitrary values to the FCF"
3484  " Mode 'protection' is safe from unwanted locking of the device.",
3485  .usage = "['protection'|'write']",
3486  .handler = kinetis_fcf_source_handler,
3487  },
3488  {
3489  .name = "fopt",
3490  .mode = COMMAND_EXEC,
3491  .help = "FCF_FOPT value source in 'kinetis fcf_source protection' mode",
3492  .usage = "[num]",
3493  .handler = kinetis_fopt_handler,
3494  },
3495  {
3496  .name = "create_banks",
3497  .mode = COMMAND_CONFIG,
3498  .help = "Driver creates additional banks if device with two/four flash blocks is probed",
3499  .handler = kinetis_create_banks_handler,
3500  .usage = "",
3501  },
3503 };
3504 
3505 static const struct command_registration kinetis_command_handler[] = {
3506  {
3507  .name = "kinetis",
3508  .mode = COMMAND_ANY,
3509  .help = "Kinetis flash controller commands",
3510  .usage = "",
3512  },
3514 };
3515 
3516 
3517 
3518 const struct flash_driver kinetis_flash = {
3519  .name = "kinetis",
3520  .commands = kinetis_command_handler,
3521  .flash_bank_command = kinetis_flash_bank_command,
3522  .erase = kinetis_erase,
3523  .protect = kinetis_protect,
3524  .write = kinetis_write,
3525  .read = default_flash_read,
3526  .probe = kinetis_probe,
3527  .auto_probe = kinetis_auto_probe,
3528  .erase_check = kinetis_blank_check,
3529  .protect_check = kinetis_protect_check,
3530  .info = kinetis_info,
3531  .free_driver_priv = kinetis_free_driver_priv,
3532 };
void init_reg_param(struct reg_param *param, const char *reg_name, uint32_t size, enum param_direction direction)
Definition: algorithm.c:29
void destroy_reg_param(struct reg_param *param)
Definition: algorithm.c:38
@ PARAM_OUT
Definition: algorithm.h:16
@ PARAM_IN_OUT
Definition: algorithm.h:17
const char * name
Definition: am13e230x.c:167
@ ARM_MODE_THREAD
Definition: arm.h:94
struct adiv5_ap * dap_get_ap(struct adiv5_dap *dap, uint64_t ap_num)
Definition: arm_adi_v5.c:1222
int dap_put_ap(struct adiv5_ap *ap)
Definition: arm_adi_v5.c:1242
This defines formats and data structures used to talk to ADIv5 entities.
static int dap_queue_ap_read(struct adiv5_ap *ap, unsigned int reg, uint32_t *data)
Queue an AP register read.
Definition: arm_adi_v5.h:590
static int dap_queue_ap_write(struct adiv5_ap *ap, unsigned int reg, uint32_t data)
Queue an AP register write.
Definition: arm_adi_v5.h:610
static int dap_run(struct adiv5_dap *dap)
Perform all queued DAP operations, and clear any errors posted in the CTRL_STAT register when they ar...
Definition: arm_adi_v5.h:648
#define ARMV7M_COMMON_MAGIC
Definition: armv7m.h:229
Support functions to access arbitrary bits in a byte array.
static uint32_t buf_get_u32(const uint8_t *_buffer, unsigned int first, unsigned int num)
Retrieves num bits from _buffer, starting at the first bit, returning the bits in a 32-bit word.
Definition: binarybuffer.h:104
static void buf_set_u32(uint8_t *_buffer, unsigned int first, unsigned int num, uint32_t value)
Sets num bits in _buffer, starting at the first bit, using the bits in value.
Definition: binarybuffer.h:34
void command_print_sameline(struct command_invocation *cmd, const char *format,...)
Definition: command.c:378
void command_print(struct command_invocation *cmd, const char *format,...)
Definition: command.c:389
#define CMD
Use this macro to access the command being handled, rather than accessing the variable directly.
Definition: command.h:146
#define CMD_ARGV
Use this macro to access the arguments for the command being handled, rather than accessing the varia...
Definition: command.h:161
#define COMMAND_PARSE_ON_OFF(in, out)
parses an on/off command argument
Definition: command.h:533
#define ERROR_COMMAND_SYNTAX_ERROR
Definition: command.h:405
#define CMD_ARGC
Use this macro to access the number of arguments for the command being handled, rather than accessing...
Definition: command.h:156
#define COMMAND_PARSE_NUMBER(type, in, out)
parses the string in into out as a type, or prints a command error and passes the error code to the c...
Definition: command.h:445
#define CMD_CTX
Use this macro to access the context of the command being handled, rather than accessing the variable...
Definition: command.h:151
#define COMMAND_REGISTRATION_DONE
Use this as the last entry in an array of command_registration records.
Definition: command.h:256
#define ERROR_COMMAND_ARGUMENT_INVALID
Definition: command.h:407
@ COMMAND_CONFIG
Definition: command.h:41
@ COMMAND_ANY
Definition: command.h:42
@ COMMAND_EXEC
Definition: command.h:40
static struct cortex_m_common * target_to_cm(struct target *target)
Definition: cortex_m.h:347
uint64_t buffer
Pointer to data buffer to send over SPI.
Definition: dw-spi-helper.h:0
uint32_t size
Size of dw_spi_transaction::buffer.
Definition: dw-spi-helper.h:4
uint32_t buffer_size
Size of dw_spi_program::buffer.
Definition: dw-spi-helper.h:5
uint32_t address
Starting address. Sector aligned.
Definition: dw-spi-helper.h:0
uint8_t bank
Definition: esirisc.c:135
#define ERROR_FLASH_OPER_UNSUPPORTED
Definition: flash/common.h:36
#define ERROR_FLASH_BANK_INVALID
Definition: flash/common.h:28
#define ERROR_FLASH_OPERATION_FAILED
Definition: flash/common.h:30
#define ERROR_FLASH_DST_BREAKS_ALIGNMENT
Definition: flash/common.h:32
struct flash_sector * alloc_block_array(uint32_t offset, uint32_t size, unsigned int num_blocks)
Allocate and fill an array of sectors or protection blocks.
void flash_bank_add(struct flash_bank *bank)
Adds a new NOR bank to the global list of banks.
int default_flash_read(struct flash_bank *bank, uint8_t *buffer, uint32_t offset, uint32_t count)
Provides default read implementation for flash memory.
struct flash_bank * flash_bank_list(void)
void jtag_poll_set_enabled(bool value)
Assign flag reporting whether JTAG polling is disallowed.
Definition: jtag/core.c:166
int adapter_deassert_reset(void)
Definition: jtag/core.c:1895
enum reset_types jtag_get_reset_config(void)
Definition: jtag/core.c:1730
int adapter_assert_reset(void)
Definition: jtag/core.c:1875
@ RESET_HAS_SRST
Definition: jtag.h:218
#define KINETIS_SOPT1_RAMSIZE_K24FN1M
Definition: kinetis.c:150
#define KINETIS_K_SDID_K60_M100
Definition: kinetis.c:190
#define KINETIS_SDID_DIEID_K22FN256
Definition: kinetis.c:157
#define PM_STAT_RUN
Definition: kinetis.c:115
#define KINETIS_SDID_SERIESID_MASK
Definition: kinetis.c:197
static int kinetis_probe_chip_s32k(struct kinetis_chip *k_chip)
Definition: kinetis.c:2119
static int kinetis_protect_check(struct flash_bank *bank)
Definition: kinetis.c:1425
#define KINETIS_K_SDID_K22_M50
Definition: kinetis.c:181
#define WDOG_BASE
Definition: kinetis.c:94
#define WDOG32_KE1X
Definition: kinetis.c:95
#define KINETIS_SDID_PROJECTID_KE1XF
Definition: kinetis.c:231
#define KINETIS_SDID_FAMILYID_SHIFT
Definition: kinetis.c:216
#define FTFX_CMD_SECTERASE
Definition: kinetis.c:123
static int kinetis_create_missing_banks(struct kinetis_chip *k_chip)
Definition: kinetis.c:989
#define PM_CTRL_RUNM_RUN
Definition: kinetis.c:117
#define FCF_FPROT
Definition: kinetis.c:74
#define SIM_FCFG1_OFFSET
Definition: kinetis.c:108
#define KINETIS_SDID_SUBFAMID_MASK
Definition: kinetis.c:205
static int kinetis_info(struct flash_bank *bank, struct command_invocation *cmd)
Definition: kinetis.c:3086
#define KINETIS_SDID_SERIESID_KL
Definition: kinetis.c:199
#define MDM_AP
Definition: kinetis.c:387
#define KINETIS_SDID_S32K_SERIES_MASK
Definition: kinetis.c:244
static int kinetis_blank_check(struct flash_bank *bank)
Definition: kinetis.c:3105
#define KINETIS_K_SDID_K21_M120
Definition: kinetis.c:180
#define SIM_SDID_OFFSET
Definition: kinetis.c:107
#define FCF_SIZE
Definition: kinetis.c:78
#define MDM_STAT_SYSSEC
Definition: kinetis.c:395
static bool create_banks
Definition: kinetis.c:421
#define KINETIS_K_SDID_K30_M100
Definition: kinetis.c:184
#define KINETIS_K_SDID_K12
Definition: kinetis.c:174
#define KINETIS_K_SDID_K40_M72
Definition: kinetis.c:185
static int kinetis_write_block(struct flash_bank *bank, const uint8_t *buffer, uint32_t offset, uint32_t wcount)
Definition: kinetis.c:1311
#define FTFX_CMD_SETFLEXRAM
Definition: kinetis.c:127
static int kinetis_probe(struct flash_bank *bank)
Definition: kinetis.c:2929
#define KINETIS_SDID_FAMILYID_K1X
Definition: kinetis.c:219
#define KINETIS_SDID_SUBFAMID_KX6
Definition: kinetis.c:212
#define KINETIS_MAX_BANKS
Definition: kinetis.c:278
#define MDM_CTRL_CORE_HOLD_RES
Definition: kinetis.c:411
static int kinetis_chip_options(struct kinetis_chip *k_chip, int argc, const char *argv[])
Definition: kinetis.c:915
#define SMC32_PMSTAT
Definition: kinetis.c:100
#define KINETIS_SDID_S32K_SERIES_K14X
Definition: kinetis.c:246
#define FTFX_FCNFG
Definition: kinetis.c:86
static int kinetis_disable_wdog32(struct target *target, uint32_t wdog_base)
Definition: kinetis.c:1147
#define KINETIS_SDID_FAMILYID_K3X
Definition: kinetis.c:221
#define KINETIS_K_SDID_K60_M150
Definition: kinetis.c:191
#define MDM_STAT_FMEEN
Definition: kinetis.c:397
#define SMC_PMCTRL
Definition: kinetis.c:97
#define MDM_REG_ID
Definition: kinetis.c:391
#define KINETIS_SDID_DIEID_K24FN1M
Definition: kinetis.c:161
#define KINETIS_SDID_FAMILYID_MASK
Definition: kinetis.c:217
#define KINETIS_K_REVID_MASK
Definition: kinetis.c:194
#define KINETIS_K_SDID_K20_M100
Definition: kinetis.c:177
static int kinetis_protect(struct flash_bank *bank, int set, unsigned int first, unsigned int last)
Definition: kinetis.c:1402
#define WDOG32_KL28
Definition: kinetis.c:96
#define KINETIS_K_SDID_K22_M120
Definition: kinetis.c:182
#define KINETIS_SDID_PROJECTID_MASK
Definition: kinetis.c:230
static const uint8_t kinetis_flash_write_code[]
Definition: kinetis.c:1306
static const struct kinetis_type kinetis_types_old[]
Definition: kinetis.c:353
#define KINETIS_SDID_FAMILYID_KL8X
Definition: kinetis.c:227
#define KINETIS_SDID_FAMILYID_K5X
Definition: kinetis.c:223
COMMAND_HANDLER(kinetis_mdm_halt)
Definition: kinetis.c:511
static int kinetis_write(struct flash_bank *bank, const uint8_t *buffer, uint32_t offset, uint32_t count)
Definition: kinetis.c:2002
static int kinetis_fill_fcf(struct flash_bank *bank, uint8_t *fcf)
Definition: kinetis.c:1470
#define KINETIS_K_SDID_K40_M100
Definition: kinetis.c:186
#define SMC_PMSTAT
Definition: kinetis.c:98
#define KINETIS_SDID_SERIESID_K
Definition: kinetis.c:198
#define KINETIS_SDID_SERIESID_KV
Definition: kinetis.c:202
#define FCF_ADDRESS
Definition: kinetis.c:73
#define KINETIS_SDID_S32K_DERIVATE_KXX8
Definition: kinetis.c:254
static const struct command_registration kinetis_exec_command_handlers[]
Definition: kinetis.c:3456
#define KINETIS_SDID_SUBFAMID_KX2
Definition: kinetis.c:208
static uint8_t fcf_fopt
Definition: kinetis.c:420
#define FTFX_CMD_BLOCKSTAT
Definition: kinetis.c:120
#define KINETIS_K_SDID_TYPE_MASK
Definition: kinetis.c:168
#define KINETIS_K_SDID_K70_M150
Definition: kinetis.c:192
static int kinetis_make_ram_ready(struct target *target)
Definition: kinetis.c:1774
#define KINETIS_SDID_FAMILYID_K4X
Definition: kinetis.c:222
#define KINETIS_K_SDID_K53
Definition: kinetis.c:189
static int kinetis_probe_chip(struct kinetis_chip *k_chip)
Definition: kinetis.c:2299
#define KINETIS_SDID_DIEID_MASK
Definition: kinetis.c:154
#define KINETIS_K_REVID_SHIFT
Definition: kinetis.c:195
#define KINETIS_SDID_PROJECTID_KE1XZ
Definition: kinetis.c:232
static int kinetis_disable_wdog_kx(struct target *target)
Definition: kinetis.c:1115
#define KINETIS_SDID_S32K_FEATURE_CSEC
Definition: kinetis.c:256
static int kinetis_ftfx_clear_error(struct target *target)
Definition: kinetis.c:1272
#define KINETIS_SDID_S32K_DERIVATE_KXX5
Definition: kinetis.c:252
#define KINETIS_SDID_SERIESID_KW
Definition: kinetis.c:201
#define FCF_FOPT
Definition: kinetis.c:76
static int kinetis_check_run_mode(struct kinetis_chip *k_chip)
Definition: kinetis.c:1623
#define KINETIS_SDID_K_SERIES_MASK
Definition: kinetis.c:152
#define KINETIS_SDID_SUBFAMID_KX8
Definition: kinetis.c:214
#define KINETIS_SDID_S32K_DERIVATE_KXX4
Definition: kinetis.c:251
#define SIM_FCFG2_OFFSET
Definition: kinetis.c:109
#define KINETIS_SDID_S32K_DERIVATE_KXX3
Definition: kinetis.c:250
#define KINETIS_K_SDID_K10_M100
Definition: kinetis.c:171
#define KINETIS_SDID_SUBFAMID_KX7
Definition: kinetis.c:213
#define PM_STAT_VLPR
Definition: kinetis.c:116
static int kinetis_write_inner(struct flash_bank *bank, const uint8_t *buffer, uint32_t offset, uint32_t count)
Definition: kinetis.c:1902
#define KINETIS_SDID_FAMILYID_K8X
Definition: kinetis.c:226
static int kinetis_auto_probe(struct flash_bank *bank)
Definition: kinetis.c:3076
#define KINETIS_K_SDID_K20_M120
Definition: kinetis.c:178
#define KINETIS_SDID_SUBFAMID_SHIFT
Definition: kinetis.c:204
#define KINETIS_SDID_SUBFAMID_KX0
Definition: kinetis.c:206
#define MDM_REG_STAT
Definition: kinetis.c:389
static int kinetis_ftfx_command(struct target *target, uint8_t fcmd, uint32_t faddr, uint8_t fccob4, uint8_t fccob5, uint8_t fccob6, uint8_t fccob7, uint8_t fccob8, uint8_t fccob9, uint8_t fccoba, uint8_t fccobb, uint8_t *ftfx_fstat)
Definition: kinetis.c:1544
#define FMC_PFB01CR
Definition: kinetis.c:84
#define MDM_CTRL_FMEIP
Definition: kinetis.c:407
#define MSCM_OCMDR0
Definition: kinetis.c:82
#define MCM_PLACR
Definition: kinetis.c:103
#define SIM_BASE_KL28
Definition: kinetis.c:91
#define KINETIS_SDID_SUBFAMID_KX3
Definition: kinetis.c:209
#define KINETIS_K_SDID_K10_M120
Definition: kinetis.c:172
#define KINETIS_SDID_FAMILYID_K0X
Definition: kinetis.c:218
#define SIM_COPC
Definition: kinetis.c:92
static void kinetis_invalidate_flash_cache(struct kinetis_chip *k_chip)
Definition: kinetis.c:1683
#define KINETIS_SDID_FAMILYID_K2X
Definition: kinetis.c:220
static int kinetis_write_sections(struct flash_bank *bank, const uint8_t *buffer, uint32_t offset, uint32_t count)
Definition: kinetis.c:1805
static uint8_t kinetis_fcfg1_depart(enum kinetis_chip_type chip_type, uint32_t sim_fcfg1)
Definition: kinetis.c:908
const struct flash_driver kinetis_flash
Definition: kinetis.c:424
#define KINETIS_K_SDID_K30_M72
Definition: kinetis.c:183
static const uint32_t kinetis_known_mdm_ids[]
Definition: kinetis.c:755
#define KINETIS_SDID_SUBFAMID_KX5
Definition: kinetis.c:211
FLASH_BANK_COMMAND_HANDLER(kinetis_flash_bank_command)
Definition: kinetis.c:929
static int kinetis_mdm_read_register(struct adiv5_dap *dap, unsigned int reg, uint32_t *result)
Definition: kinetis.c:460
static void kinetis_free_driver_priv(struct flash_bank *bank)
Definition: kinetis.c:973
#define SIM_SOPT1_OFFSET
Definition: kinetis.c:106
#define KINETIS_SDID_SUBFAMID_KX1
Definition: kinetis.c:207
#define KINETIS_K_SDID_K11
Definition: kinetis.c:173
#define KINETIS_K_SDID_K20_M72
Definition: kinetis.c:176
#define KINETIS_SDID_S32K_SERIES_K11X
Definition: kinetis.c:245
static int kinetis_ftfx_prepare(struct target *target)
Definition: kinetis.c:1279
#define KINETIS_SDID_DIEID_K22FN128
Definition: kinetis.c:156
#define KINETIS_K_SDID_K10_M50
Definition: kinetis.c:169
#define FTFX_CMD_SECTSTAT
Definition: kinetis.c:121
#define SMC32_PMCTRL
Definition: kinetis.c:99
#define FTFX_CMD_PGMPART
Definition: kinetis.c:126
#define KINETIS_SDID_S32K_DERIVATE_MASK
Definition: kinetis.c:248
static bool allow_fcf_writes
Definition: kinetis.c:419
static struct kinetis_chip * kinetis_get_chip(struct target *target)
Definition: kinetis.c:887
#define FTFX_FDPROT
Definition: kinetis.c:89
static int kinetis_mdm_write_register(struct adiv5_dap *dap, unsigned int reg, uint32_t value)
Definition: kinetis.c:432
#define FTFX_CMD_LWORDPROG
Definition: kinetis.c:122
#define SIM_BASE
Definition: kinetis.c:90
#define FTFX_FPROT3
Definition: kinetis.c:88
#define KINETIS_K_SDID_K10_M72
Definition: kinetis.c:170
#define FCF_FSEC
Definition: kinetis.c:75
#define FLEXRAM
Definition: kinetis.c:80
static int kinetis_disable_wdog(struct kinetis_chip *k_chip)
Definition: kinetis.c:1180
#define KINETIS_SDID_DIEID_K22FN512
Definition: kinetis.c:158
#define KINETIS_SDID_S32K_DERIVATE_KXX2
Definition: kinetis.c:249
#define KINETIS_SDID_DIEID_K24FN256
Definition: kinetis.c:159
#define PMC_REGSC
Definition: kinetis.c:101
#define KINETIS_SDID_SERIESID_KE
Definition: kinetis.c:200
#define MDM_ACCESS_TIMEOUT
Definition: kinetis.c:416
#define MDM_STAT_FREADY
Definition: kinetis.c:394
static int kinetis_mdm_poll_register(struct adiv5_dap *dap, unsigned int reg, uint32_t mask, uint32_t value, uint32_t timeout_ms)
Definition: kinetis.c:486
#define FTFX_FCCOB3
Definition: kinetis.c:87
#define MDM_REG_CTRL
Definition: kinetis.c:390
#define MDM_STAT_SYSRES
Definition: kinetis.c:396
static int kinetis_erase(struct flash_bank *bank, unsigned int first, unsigned int last)
Definition: kinetis.c:1716
#define KINETIS_K_SDID_K51_M72
Definition: kinetis.c:188
kinetis_chip_type
Definition: kinetis.c:280
@ KINETIS_CT_S32K
Definition: kinetis.c:282
@ KINETIS_CT_KINETIS
Definition: kinetis.c:281
#define WDOG32_CS_OFFSET
Definition: kinetis.c:112
static const struct command_registration kinetis_command_handler[]
Definition: kinetis.c:3505
static int kinetis_read_pmstat(struct kinetis_chip *k_chip, uint8_t *pmstat)
Definition: kinetis.c:1593
#define KINETIS_SOPT1_RAMSIZE_MASK
Definition: kinetis.c:149
static int kinetis_disable_wdog_algo(struct target *target, size_t code_size, const uint8_t *code, uint32_t wdog_base)
Definition: kinetis.c:1071
#define KINETIS_SDID_FAMILYID_K6X
Definition: kinetis.c:224
static int kinetis_ftfx_decode_error(uint8_t fstat)
Definition: kinetis.c:1251
#define KINETIS_K_SDID_K50_M72
Definition: kinetis.c:187
#define FTFX_FSTAT
Definition: kinetis.c:85
#define KINETIS_SDID_S32K_DERIVATE_KXX6
Definition: kinetis.c:253
#define FTFX_CMD_SECTWRITE
Definition: kinetis.c:124
#define FCF_FDPROT
Definition: kinetis.c:77
#define MSCM_OCMDR1
Definition: kinetis.c:83
#define KINETIS_K_SDID_K21_M50
Definition: kinetis.c:179
static const struct command_registration kinetis_security_command_handlers[]
Definition: kinetis.c:3424
#define KINETIS_K_SDID_K20_M50
Definition: kinetis.c:175
#define MDM_CTRL_SYS_RES_REQ
Definition: kinetis.c:410
#define WDOG_STCTRLH_OFFSET
Definition: kinetis.c:111
#define MC_PMCTRL
Definition: kinetis.c:102
#define KINETIS_SDID_SUBFAMID_KX4
Definition: kinetis.c:210
void alive_sleep(uint64_t ms)
Definition: log.c:478
void keep_alive(void)
Definition: log.c:437
#define LOG_WARNING(expr ...)
Definition: log.h:144
#define ERROR_FAIL
Definition: log.h:188
#define LOG_ERROR(expr ...)
Definition: log.h:147
#define LOG_INFO(expr ...)
Definition: log.h:141
#define LOG_DEBUG(expr ...)
Definition: log.h:124
#define ERROR_OK
Definition: log.h:182
#define FLASH_WRITE_GAP_SECTOR
Definition: nor/core.h:63
uint8_t mask
Definition: parport.c:70
#define MAX(a, b)
Definition: replacements.h:25
struct target * target
Definition: rtt/rtt.c:26
struct rtt_source source
Definition: rtt/rtt.c:23
This represents an ARM Debug Interface (v5) Access Port (AP).
Definition: arm_adi_v5.h:250
struct adiv5_dap * dap
DAP this AP belongs to.
Definition: arm_adi_v5.h:254
This represents an ARM Debug Interface (v5) Debug Access Port (DAP).
Definition: arm_adi_v5.h:348
const struct dap_ops * ops
Definition: arm_adi_v5.h:349
struct adiv5_dap * dap
For targets conforming to ARM Debug Interface v5, this handle references the Debug Access Port (DAP) ...
Definition: arm.h:258
unsigned int common_magic
Definition: armv7m.h:306
enum arm_mode core_mode
Definition: armv7m.h:308
struct arm arm
Definition: armv7m.h:234
When run_command is called, a new instance will be created on the stack, filled with the proper value...
Definition: command.h:76
const char * name
Definition: command.h:239
struct armv7m_common armv7m
Definition: cortex_m.h:275
Provides details of a flash bank, available either on-chip or through a major interface.
Definition: nor/core.h:75
unsigned int num_prot_blocks
The number of protection blocks in this bank.
Definition: nor/core.h:137
const struct flash_driver * driver
Driver for this bank.
Definition: nor/core.h:80
void * driver_priv
Private driver storage pointer.
Definition: nor/core.h:81
struct flash_sector * prot_blocks
Array of protection blocks, allocated and initialized by the flash driver.
Definition: nor/core.h:139
struct flash_bank * next
The next flash bank on this chip.
Definition: nor/core.h:141
struct target * target
Target to which this bank belongs.
Definition: nor/core.h:78
Provides the implementation-independent structure that defines all of the callbacks required by OpenO...
Definition: nor/driver.h:39
const char * name
Gives a human-readable name of this flash driver, This field is used to select and initialize the dri...
Definition: nor/driver.h:44
int is_protected
Indication of protection status: 0 = unprotected/unlocked, 1 = protected/locked, other = unknown.
Definition: nor/core.h:55
uint32_t nvm_base
Definition: kinetis.c:301
enum kinetis_chip::@10 watchdog_type
uint32_t sim_sdid
Definition: kinetis.c:289
unsigned int nvm_sector_size
Definition: kinetis.c:296
struct kinetis_flash_bank banks[KINETIS_MAX_BANKS]
Definition: kinetis.c:345
char name[40]
Definition: kinetis.c:342
uint32_t pflash_size
Definition: kinetis.c:300
uint32_t sim_fcfg2
Definition: kinetis.c:291
uint32_t sim_fcfg1
Definition: kinetis.c:290
uint32_t nvm_size
Definition: kinetis.c:302
struct target * target
Definition: kinetis.c:286
enum kinetis_chip_type chip_type
Definition: kinetis.c:308
@ KINETIS_SMC32
Definition: kinetis.c:338
unsigned int num_nvm_blocks
Definition: kinetis.c:295
enum kinetis_chip::@8 flash_support
unsigned int pflash_sector_size
Definition: kinetis.c:296
enum kinetis_chip::@9 cache_type
uint32_t sim_base
Definition: kinetis.c:306
@ FS_PROGRAM_PHRASE
Definition: kinetis.c:313
@ FS_PROGRAM_LONGWORD
Definition: kinetis.c:312
@ FS_WIDTH_256BIT
Definition: kinetis.c:316
@ FS_NO_CMD_BLOCKSTAT
Definition: kinetis.c:315
@ FS_PROGRAM_SECTOR
Definition: kinetis.c:311
enum kinetis_chip::@11 sysmodectrlr_type
@ KINETIS_WDOG_K
Definition: kinetis.c:330
@ KINETIS_WDOG32_KL28
Definition: kinetis.c:333
@ KINETIS_WDOG_NONE
Definition: kinetis.c:329
@ KINETIS_WDOG32_KE1X
Definition: kinetis.c:332
@ KINETIS_WDOG_COP
Definition: kinetis.c:331
uint32_t progr_accel_ram
Definition: kinetis.c:305
unsigned int max_flash_prog_size
Definition: kinetis.c:297
bool probed
Definition: kinetis.c:287
unsigned int num_pflash_blocks
Definition: kinetis.c:295
uint32_t dflash_size
Definition: kinetis.c:303
@ KINETIS_CACHE_K
Definition: kinetis.c:322
@ KINETIS_CACHE_L
Definition: kinetis.c:323
@ KINETIS_CACHE_MSCM
Definition: kinetis.c:324
@ KINETIS_CACHE_MSCM2
Definition: kinetis.c:325
@ KINETIS_CACHE_NONE
Definition: kinetis.c:321
unsigned int num_banks
Definition: kinetis.c:344
uint32_t fcfg2_maxaddr0_shifted
Definition: kinetis.c:292
uint32_t pflash_base
Definition: kinetis.c:299
uint32_t fcfg2_maxaddr1_shifted
Definition: kinetis.c:293
uint32_t sector_size
Definition: kinetis.c:264
uint32_t prog_base
Definition: kinetis.c:266
uint32_t protection_size
Definition: kinetis.c:265
struct flash_bank * bank
Definition: kinetis.c:262
enum kinetis_flash_bank::@7 flash_class
struct kinetis_chip * k_chip
Definition: kinetis.c:259
unsigned int bank_number
Definition: kinetis.c:261
uint32_t protection_block
Definition: kinetis.c:268
char * name
Definition: kinetis.c:350
uint32_t sdid
Definition: kinetis.c:349
uint8_t * value
Definition: algorithm.h:30
Definition: register.h:111
int(* deassert_reset)(struct target *target)
The implementation is responsible for polling the target such that target->state reflects the state c...
Definition: target_type.h:77
int(* assert_reset)(struct target *target)
Definition: target_type.h:65
Definition: target.h:119
enum target_state state
Definition: target.h:167
struct target_type * type
Definition: target.h:120
bool reset_halt
Definition: target.h:154
target_addr_t address
Definition: target.h:89
void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value)
Definition: target.c:363
int target_write_buffer(struct target *target, target_addr_t address, uint32_t size, const uint8_t *buffer)
Definition: target.c:2410
int target_write_u8(struct target *target, target_addr_t address, uint8_t value)
Definition: target.c:2710
int target_read_u8(struct target *target, target_addr_t address, uint8_t *value)
Definition: target.c:2642
int target_run_algorithm(struct target *target, int num_mem_params, struct mem_param *mem_params, int num_reg_params, struct reg_param *reg_param, target_addr_t entry_point, target_addr_t exit_point, unsigned int timeout_ms, void *arch_info)
Downloads a target-specific native code algorithm to the target, and executes it.
Definition: target.c:787
int target_write_memory(struct target *target, target_addr_t address, uint32_t size, uint32_t count, const uint8_t *buffer)
Write count items of size bytes to the memory of target at the address given.
Definition: target.c:1289
uint32_t target_get_working_area_avail(struct target *target)
Definition: target.c:2220
int target_alloc_working_area(struct target *target, uint32_t size, struct working_area **area)
Definition: target.c:2118
int target_write_u32(struct target *target, target_addr_t address, uint32_t value)
Definition: target.c:2676
int target_poll(struct target *target)
Definition: target.c:488
int target_free_working_area(struct target *target, struct working_area *area)
Free a working area.
Definition: target.c:2174
int target_read_u16(struct target *target, target_addr_t address, uint16_t *value)
Definition: target.c:2622
int target_run_flash_async_algorithm(struct target *target, const uint8_t *buffer, uint32_t count, int block_size, int num_mem_params, struct mem_param *mem_params, int num_reg_params, struct reg_param *reg_params, uint32_t buffer_start, uint32_t buffer_size, uint32_t entry_point, uint32_t exit_point, void *arch_info)
Streams data to a circular buffer on target intended for consumption by code running asynchronously o...
Definition: target.c:946
int target_read_u32(struct target *target, target_addr_t address, uint32_t *value)
Definition: target.c:2602
int target_read_memory(struct target *target, target_addr_t address, uint32_t size, uint32_t count, uint8_t *buffer)
Read count items of size bytes from the memory of target at the address given.
Definition: target.c:1261
struct target * get_current_target(struct command_context *cmd_ctx)
Definition: target.c:469
#define ERROR_TARGET_NOT_HALTED
Definition: target.h:818
static const char * target_name(const struct target *target)
Returns the instance-specific name of the specified target.
Definition: target.h:247
@ TARGET_HALTED
Definition: target.h:58
#define ERROR_TARGET_RESOURCE_NOT_AVAILABLE
Definition: target.h:822
int64_t timeval_ms(void)
#define TARGET_ADDR_FMT
Definition: types.h:286
#define ARRAY_SIZE(x)
Compute the number of elements of a variable length array.
Definition: types.h:57
#define NULL
Definition: usb.h:16
uint8_t cmd
Definition: vdebug.c:1
uint8_t offset[4]
Definition: vdebug.c:9
uint8_t count[4]
Definition: vdebug.c:22