kinetis : improve kinetis flash driver.
[openocd.git] / src / flash / nor / kinetis.c
index 84cf83133284a73d160367a817e948d654588e08..c2ea1d8cbe19c3b02605ea8e505337a0755d7fe6 100644 (file)
  * and FlexNVM/FlexRAM, so flash command arguments may differ between
  * blocks in the same chip.
  *
- * Although not documented as such by Freescale, it appears that bits
- * 8:7 of the read-only SIM_SDID register reflect the granularity
- * settings 0..3, so sector sizes and block counts are applicable
- * according to the following table.
  */
 
 const struct {
@@ -120,6 +116,67 @@ const struct {
 #define FTFx_CMD_SETFLEXRAM 0x81
 #define FTFx_CMD_MASSERASE  0x44
 
+/* The Kinetis K series uses the following SDID layout :
+ * Bit 31-16 : 0
+ * Bit 15-12 : REVID
+ * Bit 11-7  : DIEID
+ * Bit 6-4   : FAMID
+ * Bit 3-0   : PINID
+ *
+ * The Kinetis KL series uses the following SDID layout :
+ * Bit 31-28 : FAMID
+ * Bit 27-24 : SUBFAMID
+ * Bit 23-20 : SERIESID
+ * Bit 19-16 : SRAMSIZE
+ * Bit 15-12 : REVID
+ * Bit 6-4   : Reserved (0)
+ * Bit 3-0   : PINID
+ *
+ * SERIESID should be 1 for the KL-series so we assume that if
+ * bits 31-16 are 0 then it's a K-series MCU.
+ */
+
+#define KINETIS_SDID_K_SERIES_MASK  0x0000FFFF
+
+#define KINETIS_SDID_DIEID_MASK 0x00000F80
+#define KINETIS_SDID_DIEID_K_A 0x00000100
+#define KINETIS_SDID_DIEID_K_B 0x00000200
+#define KINETIS_SDID_DIEID_KL  0x00000000
+
+/* We can't rely solely on the FAMID field to determine the MCU
+ * type since some FAMID values identify multiple MCUs with
+ * different flash sector sizes (K20 and K22 for instance).
+ * Therefore we combine it with the DIEID bits which may possibly
+ * break if Freescale bumps the DIEID for a particular MCU. */
+#define KINETIS_K_SDID_TYPE_MASK 0x00000FF0
+#define KINETIS_K_SDID_K10_M50  0x00000000
+#define KINETIS_K_SDID_K10_M72  0x00000080
+#define KINETIS_K_SDID_K10_M100         0x00000100
+#define KINETIS_K_SDID_K10_M120         0x00000180
+#define KINETIS_K_SDID_K11              0x00000220
+#define KINETIS_K_SDID_K12              0x00000200
+#define KINETIS_K_SDID_K20_M50  0x00000010
+#define KINETIS_K_SDID_K20_M72  0x00000090
+#define KINETIS_K_SDID_K20_M100         0x00000110
+#define KINETIS_K_SDID_K20_M120         0x00000190
+#define KINETIS_K_SDID_K21_M50   0x00000230
+#define KINETIS_K_SDID_K21_M120         0x00000330
+#define KINETIS_K_SDID_K22_M50   0x00000210
+#define KINETIS_K_SDID_K22_M120         0x00000310
+#define KINETIS_K_SDID_K30_M72   0x000000A0
+#define KINETIS_K_SDID_K30_M100  0x00000120
+#define KINETIS_K_SDID_K40_M72   0x000000B0
+#define KINETIS_K_SDID_K40_M100  0x00000130
+#define KINETIS_K_SDID_K50_M72   0x000000E0
+#define KINETIS_K_SDID_K51_M72  0x000000F0
+#define KINETIS_K_SDID_K53              0x00000170
+#define KINETIS_K_SDID_K60_M100  0x00000140
+#define KINETIS_K_SDID_K60_M150  0x000001C0
+#define KINETIS_K_SDID_K70_M150  0x000001D0
+
+#define KINETIS_KL_SDID_SERIESID_MASK 0x00F00000
+#define KINETIS_KL_SDID_SERIESID_KL   0x00100000
+
 struct kinetis_flash_bank {
        unsigned granularity;
        unsigned bank_ordinal;
@@ -292,11 +349,6 @@ static int kinetis_write_block(struct flash_bank *bank, uint8_t *buffer,
        while (wcount > 0) {
                uint32_t thisrun_count = (wcount > (buffer_size / 4)) ? (buffer_size / 4) : wcount;
 
-               retval = target_write_buffer(target, write_algorithm->address, 8,
-                               kinetis_flash_write_code);
-               if (retval != ERROR_OK)
-                       break;
-
                retval = target_write_buffer(target, source->address, thisrun_count * 4, buffer);
                if (retval != ERROR_OK)
                        break;
@@ -437,7 +489,7 @@ static int kinetis_ftfx_command(struct flash_bank *bank, uint8_t fcmd, uint32_t
                return result;
 
        /* wait for done */
-       for (i = 0; i < 240; i++) { /* Need Entire Erase Nemui Changed */
+       for (i = 0; i < 240; i++) { /* Need longtime for "Mass Erase" Command Nemui Changed */
                result =
                        target_read_memory(bank->target, FTFx_FSTAT, 1, 1, ftfx_fstat);
 
@@ -471,15 +523,15 @@ static int kinetis_mass_erase(struct flash_bank *bank)
        }
 
        /* check if whole bank is blank */
-       LOG_INFO("Kinetis L Series Erase All Blocks");
+       LOG_INFO("Execute Erase All Blocks");
        /* set command and sector address */
        result = kinetis_ftfx_command(bank, FTFx_CMD_MASSERASE, 0,
-                       0, 0, 0, 0,  0, 0, 0, 0,  &ftfx_fstat);
-       /* Anyway Result, write unsecure byte */
+                                           0, 0, 0, 0,  0, 0, 0, 0,  &ftfx_fstat);
+       /* Anyway Result, write FSEC to unsecure forcely */
        /*      if (result != ERROR_OK)
                return result;*/
 
-       /* Write to MCU security status unsecure in Flash security byte(Work around) */
+       /* Write to MCU security status unsecure in Flash security byte(for Kinetis-L need) */
        LOG_INFO("Write to MCU security status unsecure Anyway!");
        uint8_t padding[4] = {0xFE, 0xFF, 0xFF, 0xFF}; /* Write 0xFFFFFFFE */
 
@@ -495,7 +547,6 @@ static int kinetis_mass_erase(struct flash_bank *bank)
 static int kinetis_erase(struct flash_bank *bank, int first, int last)
 {
        int result, i;
-       struct kinetis_flash_bank *kinfo = bank->driver_priv;
 
        if (bank->target->state != TARGET_HALTED) {
                LOG_ERROR("Target not halted");
@@ -505,7 +556,7 @@ static int kinetis_erase(struct flash_bank *bank, int first, int last)
        if ((first > bank->num_sectors) || (last > bank->num_sectors))
                return ERROR_FLASH_OPERATION_FAILED;
 
-       if ((first == 0) && (last == (bank->num_sectors - 1)) && (kinfo->klxx))
+       if ((first == 0) && (last == (bank->num_sectors - 1)))
                return kinetis_mass_erase(bank);
 
        /*
@@ -735,14 +786,62 @@ static int kinetis_read_part_info(struct flash_bank *bank)
        if (result != ERROR_OK)
                return result;
 
-       /* Kinetis L Series SubFamily Check */
        kinfo->klxx = 0;
-       i = (kinfo->sim_sdid >> 20) & 0x0F;
-       if (i == 1) {
+
+       /* K-series MCU? */
+       if ((kinfo->sim_sdid & (~KINETIS_SDID_K_SERIES_MASK)) == 0) {
+               uint32_t mcu_type = kinfo->sim_sdid & KINETIS_K_SDID_TYPE_MASK;
+
+               switch (mcu_type) {
+               case KINETIS_K_SDID_K10_M50:
+               case KINETIS_K_SDID_K20_M50:
+                       /* 1kB sectors */
+                       granularity = 0;
+                       break;
+               case KINETIS_K_SDID_K10_M72:
+               case KINETIS_K_SDID_K20_M72:
+               case KINETIS_K_SDID_K30_M72:
+               case KINETIS_K_SDID_K30_M100:
+               case KINETIS_K_SDID_K40_M72:
+               case KINETIS_K_SDID_K40_M100:
+               case KINETIS_K_SDID_K50_M72:
+                       /* 2kB sectors, 1kB FlexNVM sectors */
+                       granularity = 1;
+                       break;
+               case KINETIS_K_SDID_K10_M100:
+               case KINETIS_K_SDID_K20_M100:
+               case KINETIS_K_SDID_K11:
+               case KINETIS_K_SDID_K12:
+               case KINETIS_K_SDID_K21_M50:
+               case KINETIS_K_SDID_K22_M50:
+               case KINETIS_K_SDID_K51_M72:
+               case KINETIS_K_SDID_K53:
+               case KINETIS_K_SDID_K60_M100:
+                       /* 2kB sectors */
+                       granularity = 2;
+                       break;
+               case KINETIS_K_SDID_K10_M120:
+               case KINETIS_K_SDID_K20_M120:
+               case KINETIS_K_SDID_K21_M120:
+               case KINETIS_K_SDID_K22_M120:
+               case KINETIS_K_SDID_K60_M150:
+               case KINETIS_K_SDID_K70_M150:
+                       /* 4kB sectors */
+                       granularity = 3;
+                       break;
+               default:
+                       LOG_ERROR("Unsupported K-family FAMID");
+                       return ERROR_FLASH_OPER_UNSUPPORTED;
+               }
+       }
+       /* KL-series? */
+       else if ((kinfo->sim_sdid & KINETIS_KL_SDID_SERIESID_MASK) == KINETIS_KL_SDID_SERIESID_KL) {
                kinfo->klxx = 1;
                granularity = 0;
-       } else
-               granularity = (kinfo->sim_sdid >> 7) & 0x03;
+       } else {
+               LOG_ERROR("MCU is unsupported");
+               return ERROR_FLASH_OPER_UNSUPPORTED;
+       }
 
        result = target_read_u32(target, SIM_FCFG1, &kinfo->sim_fcfg1);
        if (result != ERROR_OK)

Linking to existing account procedure

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

SSH host keys fingerprints

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