use ARRAY_SIZE macro
[fw/openocd] / src / flash / tms470.c
index bad82c4c917d6b949de9f8d4729920b11845473f..59659346971096e10bab562c91dd9b74002293c6 100644 (file)
 #include "tms470.h"
 
 
-static int tms470_register_commands(struct command_context_s *cmd_ctx);
-static int tms470_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank);
-static int tms470_erase(struct flash_bank_s *bank, int first, int last);
-static int tms470_protect(struct flash_bank_s *bank, int set, int first, int last);
-static int tms470_write(struct flash_bank_s *bank, uint8_t * buffer, uint32_t offset, uint32_t count);
-static int tms470_probe(struct flash_bank_s *bank);
-static int tms470_auto_probe(struct flash_bank_s *bank);
-static int tms470_erase_check(struct flash_bank_s *bank);
-static int tms470_protect_check(struct flash_bank_s *bank);
-static int tms470_info(struct flash_bank_s *bank, char *buf, int buf_size);
-
-flash_driver_t tms470_flash = {
-       .name = "tms470",
-       .register_commands = tms470_register_commands,
-       .flash_bank_command = tms470_flash_bank_command,
-       .erase = tms470_erase,
-       .protect = tms470_protect,
-       .write = tms470_write,
-       .probe = tms470_probe,
-       .auto_probe = tms470_auto_probe,
-       .erase_check = tms470_erase_check,
-       .protect_check = tms470_protect_check,
-       .info = tms470_info
-};
-
-/* ---------------------------------------------------------------------- 
+/* ----------------------------------------------------------------------
                       Internal Support, Helpers
    ---------------------------------------------------------------------- */
 
-const flash_sector_t TMS470R1A256_SECTORS[] = {
+const struct flash_sector TMS470R1A256_SECTORS[] = {
        {0x00000000, 0x00002000, -1, -1},
        {0x00002000, 0x00002000, -1, -1},
        {0x00004000, 0x00002000, -1, -1},
@@ -71,9 +46,9 @@ const flash_sector_t TMS470R1A256_SECTORS[] = {
 };
 
 #define TMS470R1A256_NUM_SECTORS \
-       (sizeof(TMS470R1A256_SECTORS)/sizeof(TMS470R1A256_SECTORS[0]))
+       ARRAY_SIZE(TMS470R1A256_SECTORS)
 
-const flash_sector_t TMS470R1A288_BANK0_SECTORS[] = {
+const struct flash_sector TMS470R1A288_BANK0_SECTORS[] = {
        {0x00000000, 0x00002000, -1, -1},
        {0x00002000, 0x00002000, -1, -1},
        {0x00004000, 0x00002000, -1, -1},
@@ -81,9 +56,9 @@ const flash_sector_t TMS470R1A288_BANK0_SECTORS[] = {
 };
 
 #define TMS470R1A288_BANK0_NUM_SECTORS \
-       (sizeof(TMS470R1A288_BANK0_SECTORS)/sizeof(TMS470R1A288_BANK0_SECTORS[0]))
+       ARRAY_SIZE(TMS470R1A288_BANK0_SECTORS)
 
-const flash_sector_t TMS470R1A288_BANK1_SECTORS[] = {
+const struct flash_sector TMS470R1A288_BANK1_SECTORS[] = {
        {0x00040000, 0x00010000, -1, -1},
        {0x00050000, 0x00010000, -1, -1},
        {0x00060000, 0x00010000, -1, -1},
@@ -91,9 +66,9 @@ const flash_sector_t TMS470R1A288_BANK1_SECTORS[] = {
 };
 
 #define TMS470R1A288_BANK1_NUM_SECTORS \
-       (sizeof(TMS470R1A288_BANK1_SECTORS)/sizeof(TMS470R1A288_BANK1_SECTORS[0]))
+       ARRAY_SIZE(TMS470R1A288_BANK1_SECTORS)
 
-const flash_sector_t TMS470R1A384_BANK0_SECTORS[] = {
+const struct flash_sector TMS470R1A384_BANK0_SECTORS[] = {
        {0x00000000, 0x00002000, -1, -1},
        {0x00002000, 0x00002000, -1, -1},
        {0x00004000, 0x00004000, -1, -1},
@@ -107,9 +82,9 @@ const flash_sector_t TMS470R1A384_BANK0_SECTORS[] = {
 };
 
 #define TMS470R1A384_BANK0_NUM_SECTORS \
-       (sizeof(TMS470R1A384_BANK0_SECTORS)/sizeof(TMS470R1A384_BANK0_SECTORS[0]))
+       ARRAY_SIZE(TMS470R1A384_BANK0_SECTORS)
 
-const flash_sector_t TMS470R1A384_BANK1_SECTORS[] = {
+const struct flash_sector TMS470R1A384_BANK1_SECTORS[] = {
        {0x00020000, 0x00008000, -1, -1},
        {0x00028000, 0x00008000, -1, -1},
        {0x00030000, 0x00008000, -1, -1},
@@ -117,9 +92,9 @@ const flash_sector_t TMS470R1A384_BANK1_SECTORS[] = {
 };
 
 #define TMS470R1A384_BANK1_NUM_SECTORS \
-       (sizeof(TMS470R1A384_BANK1_SECTORS)/sizeof(TMS470R1A384_BANK1_SECTORS[0]))
+       ARRAY_SIZE(TMS470R1A384_BANK1_SECTORS)
 
-const flash_sector_t TMS470R1A384_BANK2_SECTORS[] = {
+const struct flash_sector TMS470R1A384_BANK2_SECTORS[] = {
        {0x00040000, 0x00008000, -1, -1},
        {0x00048000, 0x00008000, -1, -1},
        {0x00050000, 0x00008000, -1, -1},
@@ -127,14 +102,14 @@ const flash_sector_t TMS470R1A384_BANK2_SECTORS[] = {
 };
 
 #define TMS470R1A384_BANK2_NUM_SECTORS \
-       (sizeof(TMS470R1A384_BANK2_SECTORS)/sizeof(TMS470R1A384_BANK2_SECTORS[0]))
+       ARRAY_SIZE(TMS470R1A384_BANK2_SECTORS)
 
 /* ---------------------------------------------------------------------- */
 
-static int tms470_read_part_info(struct flash_bank_s *bank)
+static int tms470_read_part_info(struct flash_bank *bank)
 {
-       tms470_flash_bank_t *tms470_info = bank->driver_priv;
-       target_t *target = bank->target;
+       struct tms470_flash_bank *tms470_info = bank->driver_priv;
+       struct target *target = bank->target;
        uint32_t device_ident_reg;
        uint32_t silicon_version;
        uint32_t technology_family;
@@ -288,10 +263,10 @@ static int tms470_read_part_info(struct flash_bank_s *bank)
        bank->chip_width = 32;
        bank->bus_width = 32;
 
-       LOG_INFO("Identified %s, ver=%d, core=%s, nvmem=%s.", 
+       LOG_INFO("Identified %s, ver=%d, core=%s, nvmem=%s.",
                 part_name,
                 (int)(silicon_version),
-                (technology_family ? "1.8v" : "3.3v"), 
+                (technology_family ? "1.8v" : "3.3v"),
                 (rom_flash ? "rom" : "flash"));
 
        tms470_info->device_ident_reg = device_ident_reg;
@@ -314,45 +289,45 @@ static int tms470_read_part_info(struct flash_bank_s *bank)
 static uint32_t keysSet = 0;
 static uint32_t flashKeys[4];
 
-static int tms470_handle_flash_keyset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(tms470_handle_flash_keyset_command)
 {
-       if (argc > 4)
+       if (CMD_ARGC > 4)
        {
-               command_print(cmd_ctx, "tms470 flash_keyset <key0> <key1> <key2> <key3>");
+               command_print(CMD_CTX, "tms470 flash_keyset <key0> <key1> <key2> <key3>");
                return ERROR_INVALID_ARGUMENTS;
        }
-       else if (argc == 4)
+       else if (CMD_ARGC == 4)
        {
                int i;
 
                for (i = 0; i < 4; i++)
                {
-                       int start = (0 == strncmp(args[i], "0x", 2)) ? 2 : 0;
+                       int start = (0 == strncmp(CMD_ARGV[i], "0x", 2)) ? 2 : 0;
 
-                       if (1 != sscanf(&args[i][start], "%" SCNx32 "", &flashKeys[i]))
+                       if (1 != sscanf(&CMD_ARGV[i][start], "%" SCNx32 "", &flashKeys[i]))
                        {
-                               command_print(cmd_ctx, "could not process flash key %s", args[i]);
-                               LOG_ERROR("could not process flash key %s", args[i]);
+                               command_print(CMD_CTX, "could not process flash key %s", CMD_ARGV[i]);
+                               LOG_ERROR("could not process flash key %s", CMD_ARGV[i]);
                                return ERROR_INVALID_ARGUMENTS;
                        }
                }
 
                keysSet = 1;
        }
-       else if (argc != 0)
+       else if (CMD_ARGC != 0)
        {
-               command_print(cmd_ctx, "tms470 flash_keyset <key0> <key1> <key2> <key3>");
+               command_print(CMD_CTX, "tms470 flash_keyset <key0> <key1> <key2> <key3>");
                return ERROR_INVALID_ARGUMENTS;
        }
 
        if (keysSet)
        {
-               command_print(cmd_ctx, "using flash keys 0x%08" PRIx32 ", 0x%08" PRIx32 ", 0x%08" PRIx32 ", 0x%08" PRIx32 "", 
+               command_print(CMD_CTX, "using flash keys 0x%08" PRIx32 ", 0x%08" PRIx32 ", 0x%08" PRIx32 ", 0x%08" PRIx32 "",
                              flashKeys[0], flashKeys[1], flashKeys[2], flashKeys[3]);
        }
        else
        {
-               command_print(cmd_ctx, "flash keys not set");
+               command_print(CMD_CTX, "flash keys not set");
        }
 
        return ERROR_OK;
@@ -378,27 +353,27 @@ static const uint32_t FLASH_KEYS_MIX2[] = { 0x0000ffff, 0x0000ffff,
 
 static int oscMHz = 12;
 
-static int tms470_handle_osc_megahertz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(tms470_handle_osc_megahertz_command)
 {
-       if (argc > 1)
+       if (CMD_ARGC > 1)
        {
-               command_print(cmd_ctx, "tms470 osc_megahertz <MHz>");
+               command_print(CMD_CTX, "tms470 osc_megahertz <MHz>");
                return ERROR_INVALID_ARGUMENTS;
        }
-       else if (argc == 1)
+       else if (CMD_ARGC == 1)
        {
-               sscanf(args[0], "%d", &oscMHz);
+               sscanf(CMD_ARGV[0], "%d", &oscMHz);
        }
 
        if (oscMHz <= 0)
        {
                LOG_ERROR("osc_megahertz must be positive and non-zero!");
-               command_print(cmd_ctx, "osc_megahertz must be positive and non-zero!");
+               command_print(CMD_CTX, "osc_megahertz must be positive and non-zero!");
                oscMHz = 12;
                return ERROR_INVALID_ARGUMENTS;
        }
 
-       command_print(cmd_ctx, "osc_megahertz=%d", oscMHz);
+       command_print(CMD_CTX, "osc_megahertz=%d", oscMHz);
 
        return ERROR_OK;
 }
@@ -407,27 +382,27 @@ static int tms470_handle_osc_megahertz_command(struct command_context_s *cmd_ctx
 
 static int plldis = 0;
 
-static int tms470_handle_plldis_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(tms470_handle_plldis_command)
 {
-       if (argc > 1)
+       if (CMD_ARGC > 1)
        {
-               command_print(cmd_ctx, "tms470 plldis <0 | 1>");
+               command_print(CMD_CTX, "tms470 plldis <0 | 1>");
                return ERROR_INVALID_ARGUMENTS;
        }
-       else if (argc == 1)
+       else if (CMD_ARGC == 1)
        {
-               sscanf(args[0], "%d", &plldis);
+               sscanf(CMD_ARGV[0], "%d", &plldis);
                plldis = plldis ? 1 : 0;
        }
 
-       command_print(cmd_ctx, "plldis=%d", plldis);
+       command_print(CMD_CTX, "plldis=%d", plldis);
 
        return ERROR_OK;
 }
 
 /* ---------------------------------------------------------------------- */
 
-static int tms470_check_flash_unlocked(target_t * target)
+static int tms470_check_flash_unlocked(struct target * target)
 {
        uint32_t fmbbusy;
 
@@ -438,7 +413,7 @@ static int tms470_check_flash_unlocked(target_t * target)
 
 /* ---------------------------------------------------------------------- */
 
-static int tms470_try_flash_keys(target_t * target, const uint32_t * key_set)
+static int tms470_try_flash_keys(struct target * target, const uint32_t * key_set)
 {
        uint32_t glbctrl, fmmstat;
        int retval = ERROR_FLASH_OPERATION_FAILED;
@@ -488,7 +463,7 @@ static int tms470_try_flash_keys(target_t * target, const uint32_t * key_set)
 
                if (ERROR_OK == tms470_check_flash_unlocked(target))
                {
-                       /* 
+                       /*
                         * There seems to be a side-effect of reading the FMPKEY
                         * register in that it re-enables the protection.  So we
                         * re-enable it.
@@ -516,9 +491,9 @@ static int tms470_try_flash_keys(target_t * target, const uint32_t * key_set)
 
 /* ---------------------------------------------------------------------- */
 
-static int tms470_unlock_flash(struct flash_bank_s *bank)
+static int tms470_unlock_flash(struct flash_bank *bank)
 {
-       target_t *target = bank->target;
+       struct target *target = bank->target;
        const uint32_t *p_key_sets[5];
        unsigned i, key_set_count;
 
@@ -555,11 +530,11 @@ static int tms470_unlock_flash(struct flash_bank_s *bank)
 
 /* ---------------------------------------------------------------------- */
 
-static int tms470_flash_initialize_internal_state_machine(struct flash_bank_s *bank)
+static int tms470_flash_initialize_internal_state_machine(struct flash_bank *bank)
 {
        uint32_t fmmac2, fmmac1, fmmaxep, k, delay, glbctrl, sysclk;
-       target_t *target = bank->target;
-       tms470_flash_bank_t *tms470_info = bank->driver_priv;
+       struct target *target = bank->target;
+       struct tms470_flash_bank *tms470_info = bank->driver_priv;
        int result = ERROR_OK;
 
        /*
@@ -691,9 +666,9 @@ static int tms470_flash_initialize_internal_state_machine(struct flash_bank_s *b
 
 /* ---------------------------------------------------------------------- */
 
-int tms470_flash_status(struct flash_bank_s *bank)
+int tms470_flash_status(struct flash_bank *bank)
 {
-       target_t *target = bank->target;
+       struct target *target = bank->target;
        int result = ERROR_OK;
        uint32_t fmmstat;
 
@@ -747,14 +722,14 @@ int tms470_flash_status(struct flash_bank_s *bank)
 
 /* ---------------------------------------------------------------------- */
 
-static int tms470_erase_sector(struct flash_bank_s *bank, int sector)
+static int tms470_erase_sector(struct flash_bank *bank, int sector)
 {
        uint32_t glbctrl, orig_fmregopt, fmbsea, fmbseb, fmmstat;
-       target_t *target = bank->target;
+       struct target *target = bank->target;
        uint32_t flashAddr = bank->base + bank->sectors[sector].offset;
        int result = ERROR_OK;
 
-       /* 
+       /*
         * Set the bit GLBCTRL4 of the GLBCTRL register (in the System
         * module) to enable writing to the flash registers }.
         */
@@ -787,8 +762,8 @@ static int tms470_erase_sector(struct flash_bank_s *bank, int sector)
        }
        bank->sectors[sector].is_protected = 0;
 
-       /* 
-        * clear status regiser, sent erase command, kickoff erase 
+       /*
+        * clear status regiser, sent erase command, kickoff erase
         */
        target_write_u16(target, flashAddr, 0x0040);
        LOG_DEBUG("write *(uint16_t *)0x%08" PRIx32 "=0x0040", flashAddr);
@@ -838,26 +813,46 @@ static int tms470_erase_sector(struct flash_bank_s *bank, int sector)
        return result;
 }
 
-/* ---------------------------------------------------------------------- 
+/* ----------------------------------------------------------------------
               Implementation of Flash Driver Interfaces
    ---------------------------------------------------------------------- */
 
-static int tms470_register_commands(struct command_context_s *cmd_ctx)
-{
-       command_t *tms470_cmd = register_command(cmd_ctx, NULL, "tms470", NULL, COMMAND_ANY, "applies to TI tms470 family");
-
-       register_command(cmd_ctx, tms470_cmd, "flash_keyset", tms470_handle_flash_keyset_command, COMMAND_ANY, "tms470 flash_keyset <key0> <key1> <key2> <key3>");
-       register_command(cmd_ctx, tms470_cmd, "osc_megahertz", tms470_handle_osc_megahertz_command, COMMAND_ANY, "tms470 osc_megahertz <MHz>");
-       register_command(cmd_ctx, tms470_cmd, "plldis", tms470_handle_plldis_command, COMMAND_ANY, "tms470 plldis <0/1>");
-
-       return ERROR_OK;
-}
+static const struct command_registration tms470_any_command_handlers[] = {
+       {
+               .name = "flash_keyset",
+               .handler = &tms470_handle_flash_keyset_command,
+               .mode = COMMAND_ANY,
+               .help = "tms470 flash_keyset <key0> <key1> <key2> <key3>",
+       },
+       {
+               .name = "osc_megahertz",
+               .handler = &tms470_handle_osc_megahertz_command,
+               .mode = COMMAND_ANY,
+               .help = "tms470 osc_megahertz <MHz>",
+       },
+       {
+               .name = "plldis",
+               .handler = &tms470_handle_plldis_command,
+               .mode = COMMAND_ANY,
+               .help = "tms470 plldis <0/1>",
+       },
+       COMMAND_REGISTRATION_DONE
+};
+static const struct command_registration tms470_command_handlers[] = {
+       {
+               .name = "tms470",
+               .mode = COMMAND_ANY,
+               .help = "TI tms470 flash command group",
+               .chain = tms470_any_command_handlers,
+       },
+       COMMAND_REGISTRATION_DONE
+};
 
 /* ---------------------------------------------------------------------- */
 
-static int tms470_erase(struct flash_bank_s *bank, int first, int last)
+static int tms470_erase(struct flash_bank *bank, int first, int last)
 {
-       tms470_flash_bank_t *tms470_info = bank->driver_priv;
+       struct tms470_flash_bank *tms470_info = bank->driver_priv;
        int sector, result = ERROR_OK;
 
        if (bank->target->state != TARGET_HALTED)
@@ -902,10 +897,10 @@ static int tms470_erase(struct flash_bank_s *bank, int first, int last)
 
 /* ---------------------------------------------------------------------- */
 
-static int tms470_protect(struct flash_bank_s *bank, int set, int first, int last)
+static int tms470_protect(struct flash_bank *bank, int set, int first, int last)
 {
-       tms470_flash_bank_t *tms470_info = bank->driver_priv;
-       target_t *target = bank->target;
+       struct tms470_flash_bank *tms470_info = bank->driver_priv;
+       struct target *target = bank->target;
        uint32_t fmmac2, fmbsea, fmbseb;
        int sector;
 
@@ -954,9 +949,9 @@ static int tms470_protect(struct flash_bank_s *bank, int set, int first, int las
 
 /* ---------------------------------------------------------------------- */
 
-static int tms470_write(struct flash_bank_s *bank, uint8_t * buffer, uint32_t offset, uint32_t count)
+static int tms470_write(struct flash_bank *bank, uint8_t * buffer, uint32_t offset, uint32_t count)
 {
-       target_t *target = bank->target;
+       struct target *target = bank->target;
        uint32_t glbctrl, fmbac2, orig_fmregopt, fmbsea, fmbseb, fmmaxpp, fmmstat;
        int result = ERROR_OK;
        uint32_t i;
@@ -1052,7 +1047,7 @@ static int tms470_write(struct flash_bank_s *bank, uint8_t * buffer, uint32_t of
 
 /* ---------------------------------------------------------------------- */
 
-static int tms470_probe(struct flash_bank_s *bank)
+static int tms470_probe(struct flash_bank *bank)
 {
        if (bank->target->state != TARGET_HALTED)
        {
@@ -1063,9 +1058,9 @@ static int tms470_probe(struct flash_bank_s *bank)
        return tms470_read_part_info(bank);
 }
 
-static int tms470_auto_probe(struct flash_bank_s *bank)
+static int tms470_auto_probe(struct flash_bank *bank)
 {
-       tms470_flash_bank_t *tms470_info = bank->driver_priv;
+       struct tms470_flash_bank *tms470_info = bank->driver_priv;
 
        if (tms470_info->device_ident_reg)
                return ERROR_OK;
@@ -1074,10 +1069,10 @@ static int tms470_auto_probe(struct flash_bank_s *bank)
 
 /* ---------------------------------------------------------------------- */
 
-static int tms470_erase_check(struct flash_bank_s *bank)
+static int tms470_erase_check(struct flash_bank *bank)
 {
-       target_t *target = bank->target;
-       tms470_flash_bank_t *tms470_info = bank->driver_priv;
+       struct target *target = bank->target;
+       struct tms470_flash_bank *tms470_info = bank->driver_priv;
        int sector, result = ERROR_OK;
        uint32_t fmmac2, fmbac2, glbctrl, orig_fmregopt;
        static uint8_t buffer[64 * 1024];
@@ -1115,7 +1110,7 @@ static int tms470_erase_check(struct flash_bank_s *bank)
        target_read_u32(target, 0xFFE88004, &fmbac2);
        target_write_u32(target, 0xFFE88004, fmbac2 | 0xff);
 
-       /* 
+       /*
         * The TI primitives inspect the flash memory by reading one 32-bit
         * word at a time.  Here we read an entire sector and inspect it in
         * an attempt to reduce the JTAG overhead.
@@ -1165,10 +1160,10 @@ static int tms470_erase_check(struct flash_bank_s *bank)
 
 /* ---------------------------------------------------------------------- */
 
-static int tms470_protect_check(struct flash_bank_s *bank)
+static int tms470_protect_check(struct flash_bank *bank)
 {
-       target_t *target = bank->target;
-       tms470_flash_bank_t *tms470_info = bank->driver_priv;
+       struct target *target = bank->target;
+       struct tms470_flash_bank *tms470_info = bank->driver_priv;
        int sector, result = ERROR_OK;
        uint32_t fmmac2, fmbsea, fmbseb;
 
@@ -1213,10 +1208,10 @@ static int tms470_protect_check(struct flash_bank_s *bank)
 
 /* ---------------------------------------------------------------------- */
 
-static int tms470_info(struct flash_bank_s *bank, char *buf, int buf_size)
+static int tms470_info(struct flash_bank *bank, char *buf, int buf_size)
 {
        int used = 0;
-       tms470_flash_bank_t *tms470_info = bank->driver_priv;
+       struct tms470_flash_bank *tms470_info = bank->driver_priv;
 
        if (!tms470_info->device_ident_reg)
        {
@@ -1247,16 +1242,30 @@ static int tms470_info(struct flash_bank_s *bank, char *buf, int buf_size)
  * [options...]
  */
 
-static int tms470_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank)
+FLASH_BANK_COMMAND_HANDLER(tms470_flash_bank_command)
 {
-       bank->driver_priv = malloc(sizeof(tms470_flash_bank_t));
+       bank->driver_priv = malloc(sizeof(struct tms470_flash_bank));
 
        if (!bank->driver_priv)
        {
                return ERROR_FLASH_OPERATION_FAILED;
        }
 
-       (void)memset(bank->driver_priv, 0, sizeof(tms470_flash_bank_t));
+       (void)memset(bank->driver_priv, 0, sizeof(struct tms470_flash_bank));
 
        return ERROR_OK;
 }
+
+struct flash_driver tms470_flash = {
+               .name = "tms470",
+               .commands = tms470_command_handlers,
+               .flash_bank_command = &tms470_flash_bank_command,
+               .erase = &tms470_erase,
+               .protect = &tms470_protect,
+               .write = &tms470_write,
+               .probe = &tms470_probe,
+               .auto_probe = &tms470_auto_probe,
+               .erase_check = &tms470_erase_check,
+               .protect_check = &tms470_protect_check,
+               .info = &tms470_info,
+       };