Kinetis: Symbolic names for Addresses and Commands

Change-Id: I2165b66c37bd1608139b5dd00f48124161e13ef0
Signed-off-by: Alex Austin <alex.austin@spectrumdsi.com>
Reviewed-on: http://openocd.zylin.com/1191
Tested-by: jenkins
Reviewed-by: Christopher Kilgour <techie@whiterocker.com>
Reviewed-by: Spencer Oliver <spen@spen-soft.co.uk>

diff --git a/src/flash/nor/kinetis.c b/src/flash/nor/kinetis.c
index 433d91e9e0c909475194a9a62906055007a45bbb..43075fe1b17a17d4d50b0baa9f99f555947457d0 100644 (file)
--- a/src/flash/nor/kinetis.c
+++ b/src/flash/nor/kinetis.c
@@ -95,6 +95,24 @@ const struct {
        { 4<<10, 4<<10, 4 }
 };
 
        { 4<<10, 4<<10, 4 }
 };
 

+/* Addressess */
+#define FLEXRAM                0x14000000
+#define FTFx_FSTAT     0x40020000
+#define FTFx_FCNFG     0x40020001
+#define FTFx_FCCOB3    0x40020004
+#define FTFx_FPROT3    0x40020010
+#define SIM_SDID       0x40048024
+#define SIM_FCFG1      0x4004804c
+#define SIM_FCFG2      0x40048050
+
+/* Commands */
+#define FTFx_CMD_BLOCKSTAT 0x00
+#define FTFx_CMD_SECTSTAT 0x01
+#define FTFx_CMD_LWORDPROG 0x06
+#define FTFx_CMD_SECTERASE 0x09
+#define FTFx_CMD_SECTWRITE 0x0b
+#define FTFx_CMD_SETFLEXRAM 0x81
+

 struct kinetis_flash_bank {
        unsigned granularity;
        unsigned bank_ordinal;
 struct kinetis_flash_bank {
        unsigned granularity;
        unsigned bank_ordinal;


@@ -160,8 +178,8 @@ static int kinetis_protect_check(struct flash_bank *bank)
                uint32_t fprot, psec;
                int i, b;
 
                uint32_t fprot, psec;
                int i, b;
 

-               /* read protection register FTFx_FPROT */
-               result = target_read_memory(bank->target, 0x40020010, 1, 4, buffer);
+               /* read protection register */
+               result = target_read_memory(bank->target, FTFx_FPROT3, 1, 4, buffer);

 
                if (result != ERROR_OK)
                        return result;
 
                if (result != ERROR_OK)
                        return result;


@@ -204,7 +222,7 @@ static int kinetis_ftfx_command(struct flash_bank *bank, uint32_t w0,
        /* wait for done */
        for (i = 0; i < 50; i++) {
                result =
        /* wait for done */
        for (i = 0; i < 50; i++) {
                result =

-                       target_read_memory(bank->target, 0x40020000, 1, 1, buffer);
+                       target_read_memory(bank->target, FTFx_FSTAT, 1, 1, buffer);

 
                if (result != ERROR_OK)
                        return result;
 
                if (result != ERROR_OK)
                        return result;


@@ -219,7 +237,7 @@ static int kinetis_ftfx_command(struct flash_bank *bank, uint32_t w0,
                /* reset error flags */
                buffer[0] = 0x30;
                result =
                /* reset error flags */
                buffer[0] = 0x30;
                result =

-                       target_write_memory(bank->target, 0x40020000, 1, 1, buffer);
+                       target_write_memory(bank->target, FTFx_FSTAT, 1, 1, buffer);

                if (result != ERROR_OK)
                        return result;
        }
                if (result != ERROR_OK)
                        return result;
        }


@@ -228,21 +246,21 @@ static int kinetis_ftfx_command(struct flash_bank *bank, uint32_t w0,
        target_buffer_set_u32(bank->target, buffer + 4, w1);
        target_buffer_set_u32(bank->target, buffer + 8, w2);
 
        target_buffer_set_u32(bank->target, buffer + 4, w1);
        target_buffer_set_u32(bank->target, buffer + 8, w2);
 

-       result = target_write_memory(bank->target, 0x40020004, 4, 3, buffer);
+       result = target_write_memory(bank->target, FTFx_FCCOB3, 4, 3, buffer);

 
        if (result != ERROR_OK)
                return result;
 
        /* start command */
        buffer[0] = 0x80;
 
        if (result != ERROR_OK)
                return result;
 
        /* start command */
        buffer[0] = 0x80;

-       result = target_write_memory(bank->target, 0x40020000, 1, 1, buffer);
+       result = target_write_memory(bank->target, FTFx_FSTAT, 1, 1, buffer);

        if (result != ERROR_OK)
                return result;
 
        /* wait for done */
        for (i = 0; i < 50; i++) {
                result =
        if (result != ERROR_OK)
                return result;
 
        /* wait for done */
        for (i = 0; i < 50; i++) {
                result =

-                       target_read_memory(bank->target, 0x40020000, 1, 1, ftfx_fstat);
+                       target_read_memory(bank->target, FTFx_FSTAT, 1, 1, ftfx_fstat);

 
                if (result != ERROR_OK)
                        return result;
 
                if (result != ERROR_OK)
                        return result;


@@ -283,7 +301,7 @@ static int kinetis_erase(struct flash_bank *bank, int first, int last)
        for (i = first; i <= last; i++) {
                uint8_t ftfx_fstat;
                /* set command and sector address */
        for (i = first; i <= last; i++) {
                uint8_t ftfx_fstat;
                /* set command and sector address */

-               w0 = (0x09 << 24) | (bank->base + bank->sectors[i].offset);
+               w0 = (FTFx_CMD_SECTERASE << 24) | (bank->base + bank->sectors[i].offset);

 
                result = kinetis_ftfx_command(bank, w0, w1, w2, &ftfx_fstat);
 
 
                result = kinetis_ftfx_command(bank, w0, w1, w2, &ftfx_fstat);
 


@@ -322,7 +340,7 @@ static int kinetis_write(struct flash_bank *bank, uint8_t *buffer,
                LOG_DEBUG("flash write into FlexNVM @%08X", offset);
 
                /* make flex ram available */
                LOG_DEBUG("flash write into FlexNVM @%08X", offset);
 
                /* make flex ram available */

-               w0 = (0x81 << 24) | 0x00ff0000;
+               w0 = (FTFx_CMD_SETFLEXRAM << 24) | 0x00ff0000;

 
                result = kinetis_ftfx_command(bank, w0, w1, w2, &ftfx_fstat);
 
 
                result = kinetis_ftfx_command(bank, w0, w1, w2, &ftfx_fstat);
 


@@ -330,7 +348,7 @@ static int kinetis_write(struct flash_bank *bank, uint8_t *buffer,
                        return ERROR_FLASH_OPERATION_FAILED;
 
                /* check if ram ready */
                        return ERROR_FLASH_OPERATION_FAILED;
 
                /* check if ram ready */

-               result = target_read_memory(bank->target, 0x40020001, 1, 1, buf);
+               result = target_read_memory(bank->target, FTFx_FCNFG, 1, 1, buf);

 
                if (result != ERROR_OK)
                        return result;
 
                if (result != ERROR_OK)
                        return result;


@@ -396,7 +414,7 @@ static int kinetis_write(struct flash_bank *bank, uint8_t *buffer,
                                  offset + i, (count - i));
 
                        /* write data to flexram as whole-words */
                                  offset + i, (count - i));
 
                        /* write data to flexram as whole-words */

-                       result = target_write_memory(bank->target, 0x14000000, 4, wc,
+                       result = target_write_memory(bank->target, FLEXRAM, 4, wc,

                                                     buffer + i);
 
                        if (result != ERROR_OK) {
                                                     buffer + i);
 
                        if (result != ERROR_OK) {


@@ -407,7 +425,7 @@ static int kinetis_write(struct flash_bank *bank, uint8_t *buffer,
                        /* write the residual words to the flexram */
                        if (residual_wc) {
                                result = target_write_memory(bank->target,
                        /* write the residual words to the flexram */
                        if (residual_wc) {
                                result = target_write_memory(bank->target,

-                                                            0x14000000+4*wc,
+                                                            FLEXRAM+4*wc,

                                                             4, residual_wc,
                                                             residual_buffer);
 
                                                             4, residual_wc,
                                                             residual_buffer);
 


@@ -418,7 +436,7 @@ static int kinetis_write(struct flash_bank *bank, uint8_t *buffer,
                        }
 
                        /* execute section-write command */
                        }
 
                        /* execute section-write command */

-                       w0 = (0x0b << 24) | (bank->base + offset + i);
+                       w0 = (FTFx_CMD_SECTWRITE << 24) | (bank->base + offset + i);

                        w1 = section_count << 16;
 
                        result = kinetis_ftfx_command(bank, w0, w1, w2, &ftfx_fstat);
                        w1 = section_count << 16;
 
                        result = kinetis_ftfx_command(bank, w0, w1, w2, &ftfx_fstat);


@@ -434,7 +452,7 @@ static int kinetis_write(struct flash_bank *bank, uint8_t *buffer,
 
                        LOG_DEBUG("write longword @ %08X", offset + i);
 
 
                        LOG_DEBUG("write longword @ %08X", offset + i);
 

-                       w0 = (0x06 << 24) | (bank->base + offset + i);
+                       w0 = (FTFx_CMD_LWORDPROG << 24) | (bank->base + offset + i);

                        if (count - i < 4) {
                                uint32_t padding = 0xffffffff;
                                memcpy(&padding, buffer + i, count - i);
                        if (count - i < 4) {
                                uint32_t padding = 0xffffffff;
                                memcpy(&padding, buffer + i, count - i);


@@ -467,16 +485,18 @@ static int kinetis_read_part_info(struct flash_bank *bank)
                first_nvm_bank = 0, reassign = 0;
        struct kinetis_flash_bank *kinfo = bank->driver_priv;
 
                first_nvm_bank = 0, reassign = 0;
        struct kinetis_flash_bank *kinfo = bank->driver_priv;
 

-       result = target_read_memory(bank->target, 0x40048024, 1, 4, buf);
+       result = target_read_memory(bank->target, SIM_SDID, 1, 4, buf);

        if (result != ERROR_OK)
                return result;
        kinfo->sim_sdid = target_buffer_get_u32(bank->target, buf);
        granularity = (kinfo->sim_sdid >> 7) & 0x03;
        if (result != ERROR_OK)
                return result;
        kinfo->sim_sdid = target_buffer_get_u32(bank->target, buf);
        granularity = (kinfo->sim_sdid >> 7) & 0x03;

-       result = target_read_memory(bank->target, 0x4004804c, 1, 4, buf);
+
+       result = target_read_memory(bank->target, SIM_FCFG1, 1, 4, buf);

        if (result != ERROR_OK)
                return result;
        kinfo->sim_fcfg1 = target_buffer_get_u32(bank->target, buf);
        if (result != ERROR_OK)
                return result;
        kinfo->sim_fcfg1 = target_buffer_get_u32(bank->target, buf);

-       result = target_read_memory(bank->target, 0x40048050, 1, 4, buf);
+
+       result = target_read_memory(bank->target, SIM_FCFG2, 1, 4, buf);

        if (result != ERROR_OK)
                return result;
        kinfo->sim_fcfg2 = target_buffer_get_u32(bank->target, buf);
        if (result != ERROR_OK)
                return result;
        kinfo->sim_fcfg2 = target_buffer_get_u32(bank->target, buf);


@@ -625,7 +645,7 @@ static int kinetis_read_part_info(struct flash_bank *bank)
                                } else if (bank->size != ee_size) {
                                        LOG_WARNING("FlexRAM size mismatch");
                                        reassign = 1;
                                } else if (bank->size != ee_size) {
                                        LOG_WARNING("FlexRAM size mismatch");
                                        reassign = 1;

-                               } else if (bank->base != 0x14000000) {
+                               } else if (bank->base != FLEXRAM) {

                                        LOG_WARNING("FlexRAM address mismatch");
                                        reassign = 1;
                                } else if (kinfo->sector_size !=
                                        LOG_WARNING("FlexRAM address mismatch");
                                        reassign = 1;
                                } else if (kinfo->sector_size !=


@@ -748,7 +768,7 @@ static int kinetis_blank_check(struct flash_bank *bank)
                uint8_t ftfx_fstat;
 
                /* check if whole bank is blank */
                uint8_t ftfx_fstat;
 
                /* check if whole bank is blank */

-               w0 = (0x00 << 24) | bank->base;
+               w0 = (FTFx_CMD_BLOCKSTAT << 24) | bank->base;

                w1 = 0; /* "normal margin" */
 
                result = kinetis_ftfx_command(bank, w0, w1, w2, &ftfx_fstat);
                w1 = 0; /* "normal margin" */
 
                result = kinetis_ftfx_command(bank, w0, w1, w2, &ftfx_fstat);


@@ -760,7 +780,7 @@ static int kinetis_blank_check(struct flash_bank *bank)
                        /* the whole bank is not erased, check sector-by-sector */
                        int i;
                        for (i = 0; i < bank->num_sectors; i++) {
                        /* the whole bank is not erased, check sector-by-sector */
                        int i;
                        for (i = 0; i < bank->num_sectors; i++) {

-                               w0 = (0x01 << 24) | (bank->base + bank->sectors[i].offset);
+                               w0 = (FTFx_CMD_SECTSTAT << 24) | (bank->base + bank->sectors[i].offset);

                                w1 = (0x100 << 16) | 0; /* normal margin */
 
                                result = kinetis_ftfx_command(bank, w0, w1, w2, &ftfx_fstat);
                                w1 = (0x100 << 16) | 0; /* normal margin */
 
                                result = kinetis_ftfx_command(bank, w0, w1, w2, &ftfx_fstat);