image_t -> struct image
[fw/openocd] / src / flash / lpc2900.c
index 902180cbe3af8856bad226d9da31577e7af7968c..5b6a5be4dde01d2933c301d5c5a17a33958fb154 100644 (file)
 /**
  * Private data for \c lpc2900 flash driver.
  */
-typedef struct lpc2900_flash_bank_s
+struct lpc2900_flash_bank
 {
        /**
         * Holds the value read from CHIPID register.
@@ -168,23 +168,8 @@ typedef struct lpc2900_flash_bank_s
         */
        uint32_t max_ram_block;
 
-} lpc2900_flash_bank_t;
-
-
-
+};
 
-static int lpc2900_register_commands(struct command_context_s *cmd_ctx);
-static int lpc2900_flash_bank_command(struct command_context_s *cmd_ctx,
-                                      char *cmd, char **args, int argc,
-                                      struct flash_bank_s *bank);
-static int lpc2900_erase(struct flash_bank_s *bank, int first, int last);
-static int lpc2900_protect(struct flash_bank_s *bank, int set, int first, int last);
-static int lpc2900_write(struct flash_bank_s *bank,
-                         uint8_t *buffer, uint32_t offset, uint32_t count);
-static int lpc2900_probe(struct flash_bank_s *bank);
-static int lpc2900_erase_check(struct flash_bank_s *bank);
-static int lpc2900_protect_check(struct flash_bank_s *bank);
-static int lpc2900_info(struct flash_bank_s *bank, char *buf, int buf_size);
 
 static uint32_t lpc2900_wait_status(flash_bank_t *bank, uint32_t mask, int timeout);
 static void lpc2900_setup(struct flash_bank_s *bank);
@@ -246,7 +231,7 @@ static uint32_t lpc2900_wait_status( flash_bank_t *bank,
 static void lpc2900_setup( struct flash_bank_s *bank )
 {
        uint32_t fcra;
-       lpc2900_flash_bank_t *lpc2900_info = bank->driver_priv;
+       struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
 
 
        /* Power up the flash block */
@@ -268,7 +253,7 @@ static void lpc2900_setup( struct flash_bank_s *bank )
  */
 static uint32_t lpc2900_is_ready( struct flash_bank_s *bank )
 {
-       lpc2900_flash_bank_t *lpc2900_info = bank->driver_priv;
+       struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
 
        if( lpc2900_info->chipid != EXPECTED_CHIPID )
        {
@@ -459,7 +444,7 @@ static int lpc2900_write_index_page( struct flash_bank_s *bank,
        }
 
        /* Private info */
-       lpc2900_flash_bank_t *lpc2900_info = bank->driver_priv;
+       struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
 
        /* Enable flash block and set the correct CRA clock of 66 kHz */
        lpc2900_setup( bank );
@@ -545,16 +530,9 @@ static uint32_t lpc2900_calc_tr( uint32_t clock, uint32_t time )
  *
  * Uses the Built-In-Self-Test (BIST) to generate a 128-bit hash value
  * of the flash content.
- *
- * @param cmd_ctx
- * @param cmd
- * @param args
- * @param argc
  */
-static int lpc2900_handle_signature_command( struct command_context_s *cmd_ctx,
-                                             char *cmd, char **args, int argc )
+COMMAND_HANDLER(lpc2900_handle_signature_command)
 {
-       flash_bank_t *bank;
        uint32_t status;
        uint32_t signature[4];
 
@@ -565,13 +543,10 @@ static int lpc2900_handle_signature_command( struct command_context_s *cmd_ctx,
                return ERROR_FLASH_BANK_INVALID;
        }
 
-       /* Get the bank descriptor */
-       bank = get_flash_bank_by_num( strtoul(args[0], NULL, 0) );
-       if( !bank )
-       {
-               command_print( cmd_ctx, "flash bank '#%s' is out of bounds", args[0] );
-               return ERROR_OK;
-       }
+       flash_bank_t *bank;
+       int retval = flash_command_get_bank_by_num(cmd_ctx, args[0], &bank);
+       if (ERROR_OK != retval)
+               return retval;
 
        if( bank->target->state != TARGET_HALTED )
        {
@@ -605,31 +580,20 @@ static int lpc2900_handle_signature_command( struct command_context_s *cmd_ctx,
  *
  * Read customer info from index sector, and store that block of data into
  * a disk file. The format is binary.
- *
- * @param cmd_ctx
- * @param cmd
- * @param args
- * @param argc
  */
-static int lpc2900_handle_read_custom_command( struct command_context_s *cmd_ctx,
-                                               char *cmd, char **args, int argc )
+COMMAND_HANDLER(lpc2900_handle_read_custom_command)
 {
-       flash_bank_t *bank;
-
-
        if( argc < 2 )
        {
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
-       /* Get the bank descriptor */
-       bank = get_flash_bank_by_num( strtoul(args[0], NULL, 0) );
-       if( !bank )
-       {
-               command_print( cmd_ctx, "flash bank '#%s' is out of bounds", args[0] );
-               return ERROR_OK;
-       }
-       lpc2900_flash_bank_t *lpc2900_info = bank->driver_priv;
+       flash_bank_t *bank;
+       int retval = flash_command_get_bank_by_num(cmd_ctx, args[0], &bank);
+       if (ERROR_OK != retval)
+               return retval;
+
+       struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
        lpc2900_info->risky = 0;
 
        /* Get target, and check if it's halted */
@@ -658,8 +622,8 @@ static int lpc2900_handle_read_custom_command( struct command_context_s *cmd_ctx
        target_write_u32( target, FCTR, FCTR_FS_CS | FCTR_FS_WEB );
 
        /* Try and open the file */
-       fileio_t fileio;
-       char *filename = args[1];
+       struct fileio fileio;
+       const char *filename = args[1];
        int ret = fileio_open( &fileio, filename, FILEIO_WRITE, FILEIO_BINARY );
        if( ret != ERROR_OK )
        {
@@ -687,31 +651,20 @@ static int lpc2900_handle_read_custom_command( struct command_context_s *cmd_ctx
 
 /**
  * Enter password to enable potentially dangerous options.
- *
- * @param cmd_ctx
- * @param cmd
- * @param args
- * @param argc
  */
-static int lpc2900_handle_password_command(struct command_context_s *cmd_ctx,
-                                           char *cmd, char **args, int argc)
+COMMAND_HANDLER(lpc2900_handle_password_command)
 {
-       flash_bank_t *bank;
-
-
        if (argc < 2)
        {
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
-       /* Get the bank descriptor */
-       bank = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
-       if (!bank)
-       {
-               command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
-               return ERROR_OK;
-       }
-       lpc2900_flash_bank_t *lpc2900_info = bank->driver_priv;
+       flash_bank_t *bank;
+       int retval = flash_command_get_bank_by_num(cmd_ctx, args[0], &bank);
+       if (ERROR_OK != retval)
+               return retval;
+
+       struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
 
 #define ISS_PASSWORD "I_know_what_I_am_doing"
 
@@ -733,28 +686,20 @@ static int lpc2900_handle_password_command(struct command_context_s *cmd_ctx,
 
 /**
  * Write customer info from file to the index sector.
- *
- * @param cmd_ctx
- * @param cmd
- * @param args
- * @param argc
  */
-static int lpc2900_handle_write_custom_command( struct command_context_s *cmd_ctx,
-                                                char *cmd, char **args, int argc )
+COMMAND_HANDLER(lpc2900_handle_write_custom_command)
 {
        if (argc < 2)
        {
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
-       /* Get the bank descriptor */
-       flash_bank_t *bank = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
-       if (!bank)
-       {
-               command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
-               return ERROR_OK;
-       }
-       lpc2900_flash_bank_t *lpc2900_info = bank->driver_priv;
+       flash_bank_t *bank;
+       int retval = flash_command_get_bank_by_num(cmd_ctx, args[0], &bank);
+       if (ERROR_OK != retval)
+               return retval;
+
+       struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
 
        /* Check if command execution is allowed. */
        if( !lpc2900_info->risky )
@@ -773,14 +718,14 @@ static int lpc2900_handle_write_custom_command( struct command_context_s *cmd_ct
        }
 
        /* The image will always start at offset 0 */
-       image_t image;
+       struct image image;
        image.base_address_set = 1;
        image.base_address = 0;
        image.start_address_set = 0;
 
-       char *filename = args[1];
-       char *type = (argc >= 3) ? args[2] : NULL;
-       int retval = image_open(&image, filename, type);
+       const char *filename = args[1];
+       const char *type = (argc >= 3) ? args[2] : NULL;
+       retval = image_open(&image, filename, type);
        if (retval != ERROR_OK)
        {
                return retval;
@@ -851,14 +796,8 @@ static int lpc2900_handle_write_custom_command( struct command_context_s *cmd_ct
 
 /**
  * Activate 'sector security' for a range of sectors.
- *
- * @param cmd_ctx
- * @param cmd
- * @param args
- * @param argc
  */
-static int lpc2900_handle_secure_sector_command(struct command_context_s *cmd_ctx,
-                                                char *cmd, char **args, int argc)
+COMMAND_HANDLER(lpc2900_handle_secure_sector_command)
 {
        if (argc < 3)
        {
@@ -866,13 +805,12 @@ static int lpc2900_handle_secure_sector_command(struct command_context_s *cmd_ct
        }
 
        /* Get the bank descriptor */
-       flash_bank_t *bank = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
-       if (!bank)
-       {
-               command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
-               return ERROR_OK;
-       }
-       lpc2900_flash_bank_t *lpc2900_info = bank->driver_priv;
+       flash_bank_t *bank;
+       int retval = flash_command_get_bank_by_num(cmd_ctx, args[0], &bank);
+       if (ERROR_OK != retval)
+               return retval;
+
+       struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
 
        /* Check if command execution is allowed. */
        if( !lpc2900_info->risky )
@@ -884,8 +822,9 @@ static int lpc2900_handle_secure_sector_command(struct command_context_s *cmd_ct
        lpc2900_info->risky = 0;
 
        /* Read sector range, and do a sanity check. */
-       int first = strtoul(args[1], NULL, 0);
-       int last = strtoul(args[2], NULL, 0);
+       int first, last;
+       COMMAND_PARSE_NUMBER(int, args[1], first);
+       COMMAND_PARSE_NUMBER(int, args[2], last);
        if( (first >= bank->num_sectors) ||
            (last >= bank->num_sectors) ||
            (first > last) )
@@ -896,7 +835,6 @@ static int lpc2900_handle_secure_sector_command(struct command_context_s *cmd_ct
 
        uint8_t page[FLASH_PAGE_SIZE];
        int sector;
-       int retval;
 
        /* Sectors in page 6 */
        if( (first <= 4) || (last >= 8) )
@@ -957,14 +895,8 @@ static int lpc2900_handle_secure_sector_command(struct command_context_s *cmd_ct
 
 /**
  * Activate JTAG protection.
- *
- * @param cmd_ctx
- * @param cmd
- * @param args
- * @param argc
  */
-static int lpc2900_handle_secure_jtag_command(struct command_context_s *cmd_ctx,
-                                              char *cmd, char **args, int argc)
+COMMAND_HANDLER(lpc2900_handle_secure_jtag_command)
 {
        if (argc < 1)
        {
@@ -972,13 +904,12 @@ static int lpc2900_handle_secure_jtag_command(struct command_context_s *cmd_ctx,
        }
 
        /* Get the bank descriptor */
-       flash_bank_t *bank = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
-       if (!bank)
-       {
-               command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
-               return ERROR_OK;
-       }
-       lpc2900_flash_bank_t *lpc2900_info = bank->driver_priv;
+       flash_bank_t *bank;
+       int retval = flash_command_get_bank_by_num(cmd_ctx, args[0], &bank);
+       if (ERROR_OK != retval)
+               return retval;
+
+       struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
 
        /* Check if command execution is allowed. */
        if( !lpc2900_info->risky )
@@ -1001,7 +932,6 @@ static int lpc2900_handle_secure_jtag_command(struct command_context_s *cmd_ctx,
        page[0x30 +  3] = 0x7F;
 
        /* Write to page 5 */
-       int retval;
        if( (retval = lpc2900_write_index_page( bank, 5, &page ))
                        != ERROR_OK )
        {
@@ -1021,8 +951,6 @@ static int lpc2900_handle_secure_jtag_command(struct command_context_s *cmd_ctx,
 
 /**
  * Register private command handlers.
- *
- * @param cmd_ctx
  */
 static int lpc2900_register_commands(struct command_context_s *cmd_ctx)
 {
@@ -1087,22 +1015,10 @@ static int lpc2900_register_commands(struct command_context_s *cmd_ctx)
 }
 
 
-/**
- * Evaluate flash bank command.
- *
- * Syntax: flash bank lpc2900 0 0 0 0 target# system_base_clock
- *
- * @param cmd_ctx
- * @param cmd
- * @param args
- * @param argc
- * @param bank Pointer to the flash bank descriptor
- */
-static int lpc2900_flash_bank_command(struct command_context_s *cmd_ctx,
-                                      char *cmd, char **args, int argc,
-                                      struct flash_bank_s *bank)
+/// Evaluate flash bank command.
+FLASH_BANK_COMMAND_HANDLER(lpc2900_flash_bank_command)
 {
-       lpc2900_flash_bank_t *lpc2900_info;
+       struct lpc2900_flash_bank *lpc2900_info;
 
        if (argc < 6)
        {
@@ -1110,14 +1026,16 @@ static int lpc2900_flash_bank_command(struct command_context_s *cmd_ctx,
                return ERROR_FLASH_BANK_INVALID;
        }
 
-       lpc2900_info = malloc(sizeof(lpc2900_flash_bank_t));
+       lpc2900_info = malloc(sizeof(struct lpc2900_flash_bank));
        bank->driver_priv = lpc2900_info;
 
        /* Get flash clock.
         * Reject it if we can't meet the requirements for program time
         * (if clock too slow), or for erase time (clock too fast).
         */
-       lpc2900_info->clk_sys_fmc = strtoul(args[6], NULL, 0) * 1000;
+       uint32_t clk_sys_fmc;
+       COMMAND_PARSE_NUMBER(u32, args[6], clk_sys_fmc);
+       lpc2900_info->clk_sys_fmc = clk_sys_fmc * 1000;
 
        uint32_t clock_limit;
        /* Check program time limit */
@@ -1158,7 +1076,7 @@ static int lpc2900_erase(struct flash_bank_s *bank, int first, int last)
        int sector;
        int last_unsecured_sector;
        target_t *target = bank->target;
-       lpc2900_flash_bank_t *lpc2900_info = bank->driver_priv;
+       struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
 
 
        status = lpc2900_is_ready(bank);
@@ -1288,7 +1206,7 @@ static int lpc2900_write(struct flash_bank_s *bank, uint8_t *buffer,
        uint32_t status;
        uint32_t num_bytes;
        target_t *target = bank->target;
-       lpc2900_flash_bank_t *lpc2900_info = bank->driver_priv;
+       struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
        int sector;
        int retval;
 
@@ -1376,7 +1294,7 @@ static int lpc2900_write(struct flash_bank_s *bank, uint8_t *buffer,
 
        /* Try working area allocation. Start with a large buffer, and try with
           reduced size if that fails. */
-       working_area_t *warea;
+       struct working_area *warea;
        uint32_t buffer_size = lpc2900_info->max_ram_block - 1 * KiB;
        while( (retval = target_alloc_working_area(target,
                                                   buffer_size + target_code_size,
@@ -1395,8 +1313,8 @@ static int lpc2900_write(struct flash_bank_s *bank, uint8_t *buffer,
 
        if( warea )
        {
-               reg_param_t reg_params[5];
-               armv4_5_algorithm_t armv4_5_info;
+               struct reg_param reg_params[5];
+               struct armv4_5_algorithm armv4_5_info;
 
                /* We can use target mode. Download the algorithm. */
                retval = target_write_buffer( target,
@@ -1632,7 +1550,7 @@ static int lpc2900_write(struct flash_bank_s *bank, uint8_t *buffer,
  */
 static int lpc2900_probe(struct flash_bank_s *bank)
 {
-       lpc2900_flash_bank_t *lpc2900_info = bank->driver_priv;
+       struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
        target_t *target = bank->target;
        int i = 0;
        uint32_t offset;
@@ -1784,7 +1702,7 @@ static int lpc2900_probe(struct flash_bank_s *bank)
         * the logical flash number are translated into the physical flash numbers
         * of the device.
         */
-       bank->sectors = malloc(sizeof(flash_sector_t) * bank->num_sectors);
+       bank->sectors = malloc(sizeof(struct flash_sector) * bank->num_sectors);
 
        offset = 0;
        for (i = 0; i < bank->num_sectors; i++)
@@ -1912,7 +1830,7 @@ static int lpc2900_info(struct flash_bank_s *bank, char *buf, int buf_size)
 }
 
 
-flash_driver_t lpc2900_flash =
+struct flash_driver lpc2900_flash =
 {
        .name               = "lpc2900",
        .register_commands  = lpc2900_register_commands,