use COMMAND_HANDLER macro to define all commands
[fw/openocd] / src / flash / stm32x.c
index aab8b9a9392017a95a64509458f87ed27145853f..95d15a95189dda15702c6ef103bef8968706fddf 100644 (file)
 #include "binarybuffer.h"
 
 
-static int stm32x_register_commands(struct command_context_s *cmd_ctx);
-static int stm32x_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank);
-static int stm32x_erase(struct flash_bank_s *bank, int first, int last);
-static int stm32x_protect(struct flash_bank_s *bank, int set, int first, int last);
-static int stm32x_write(struct flash_bank_s *bank, uint8_t *buffer, uint32_t offset, uint32_t count);
-static int stm32x_probe(struct flash_bank_s *bank);
-static int stm32x_auto_probe(struct flash_bank_s *bank);
-//static int stm32x_handle_part_id_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-static int stm32x_protect_check(struct flash_bank_s *bank);
-static int stm32x_info(struct flash_bank_s *bank, char *buf, int buf_size);
-
-static int stm32x_handle_lock_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-static int stm32x_handle_unlock_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-static int stm32x_handle_options_read_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-static int stm32x_handle_options_write_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-static int stm32x_handle_mass_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 static int stm32x_mass_erase(struct flash_bank_s *bank);
 
-flash_driver_t stm32x_flash =
-{
-       .name = "stm32x",
-       .register_commands = stm32x_register_commands,
-       .flash_bank_command = stm32x_flash_bank_command,
-       .erase = stm32x_erase,
-       .protect = stm32x_protect,
-       .write = stm32x_write,
-       .probe = stm32x_probe,
-       .auto_probe = stm32x_auto_probe,
-       .erase_check = default_flash_mem_blank_check,
-       .protect_check = stm32x_protect_check,
-       .info = stm32x_info
-};
-
-static int stm32x_register_commands(struct command_context_s *cmd_ctx)
-{
-       command_t *stm32x_cmd = register_command(cmd_ctx, NULL, "stm32x", NULL, COMMAND_ANY, "stm32x flash specific commands");
-
-       register_command(cmd_ctx, stm32x_cmd, "lock", stm32x_handle_lock_command, COMMAND_EXEC,
-                                        "lock device");
-       register_command(cmd_ctx, stm32x_cmd, "unlock", stm32x_handle_unlock_command, COMMAND_EXEC,
-                                        "unlock protected device");
-       register_command(cmd_ctx, stm32x_cmd, "mass_erase", stm32x_handle_mass_erase_command, COMMAND_EXEC,
-                                        "mass erase device");
-       register_command(cmd_ctx, stm32x_cmd, "options_read", stm32x_handle_options_read_command, COMMAND_EXEC,
-                                        "read device option bytes");
-       register_command(cmd_ctx, stm32x_cmd, "options_write", stm32x_handle_options_write_command, COMMAND_EXEC,
-                                        "write device option bytes");
-       return ERROR_OK;
-}
-
 /* flash bank stm32x <base> <size> 0 0 <target#>
  */
 static int stm32x_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank)
@@ -182,9 +134,9 @@ static int stm32x_erase_options(struct flash_bank_s *bank)
 
        status = stm32x_wait_status_busy(bank, 10);
 
-       if ( status & FLASH_WRPRTERR )
+       if (status & FLASH_WRPRTERR)
                return ERROR_FLASH_OPERATION_FAILED;
-       if ( status & FLASH_PGERR )
+       if (status & FLASH_PGERR)
                return ERROR_FLASH_OPERATION_FAILED;
 
        /* clear readout protection and complementary option bytes
@@ -218,9 +170,9 @@ static int stm32x_write_options(struct flash_bank_s *bank)
 
        status = stm32x_wait_status_busy(bank, 10);
 
-       if ( status & FLASH_WRPRTERR )
+       if (status & FLASH_WRPRTERR)
                return ERROR_FLASH_OPERATION_FAILED;
-       if ( status & FLASH_PGERR )
+       if (status & FLASH_PGERR)
                return ERROR_FLASH_OPERATION_FAILED;
 
        /* write protection byte 1 */
@@ -228,9 +180,9 @@ static int stm32x_write_options(struct flash_bank_s *bank)
 
        status = stm32x_wait_status_busy(bank, 10);
 
-       if ( status & FLASH_WRPRTERR )
+       if (status & FLASH_WRPRTERR)
                return ERROR_FLASH_OPERATION_FAILED;
-       if ( status & FLASH_PGERR )
+       if (status & FLASH_PGERR)
                return ERROR_FLASH_OPERATION_FAILED;
 
        /* write protection byte 2 */
@@ -238,9 +190,9 @@ static int stm32x_write_options(struct flash_bank_s *bank)
 
        status = stm32x_wait_status_busy(bank, 10);
 
-       if ( status & FLASH_WRPRTERR )
+       if (status & FLASH_WRPRTERR)
                return ERROR_FLASH_OPERATION_FAILED;
-       if ( status & FLASH_PGERR )
+       if (status & FLASH_PGERR)
                return ERROR_FLASH_OPERATION_FAILED;
 
        /* write protection byte 3 */
@@ -248,9 +200,9 @@ static int stm32x_write_options(struct flash_bank_s *bank)
 
        status = stm32x_wait_status_busy(bank, 10);
 
-       if ( status & FLASH_WRPRTERR )
+       if (status & FLASH_WRPRTERR)
                return ERROR_FLASH_OPERATION_FAILED;
-       if ( status & FLASH_PGERR )
+       if (status & FLASH_PGERR)
                return ERROR_FLASH_OPERATION_FAILED;
 
        /* write protection byte 4 */
@@ -258,9 +210,9 @@ static int stm32x_write_options(struct flash_bank_s *bank)
 
        status = stm32x_wait_status_busy(bank, 10);
 
-       if ( status & FLASH_WRPRTERR )
+       if (status & FLASH_WRPRTERR)
                return ERROR_FLASH_OPERATION_FAILED;
-       if ( status & FLASH_PGERR )
+       if (status & FLASH_PGERR)
                return ERROR_FLASH_OPERATION_FAILED;
 
        /* write readout protection bit */
@@ -268,9 +220,9 @@ static int stm32x_write_options(struct flash_bank_s *bank)
 
        status = stm32x_wait_status_busy(bank, 10);
 
-       if ( status & FLASH_WRPRTERR )
+       if (status & FLASH_WRPRTERR)
                return ERROR_FLASH_OPERATION_FAILED;
-       if ( status & FLASH_PGERR )
+       if (status & FLASH_PGERR)
                return ERROR_FLASH_OPERATION_FAILED;
 
        target_write_u32(target, STM32_FLASH_CR, FLASH_LOCK);
@@ -304,14 +256,15 @@ static int stm32x_protect_check(struct flash_bank_s *bank)
 
        if (stm32x_info->ppage_size == 2)
        {
-               /* high density flash */
+               /* high density flash/connectivity line protection */
 
                set = 1;
 
                if (protection & (1 << 31))
                        set = 0;
 
-               /* bit 31 controls sector 62 - 255 protection */
+               /* bit 31 controls sector 62 - 255 protection for high density
+                * bit 31 controls sector 62 - 127 protection for connectivity line */
                for (s = 62; s < bank->num_sectors; s++)
                {
                        bank->sectors[s].is_protected = set;
@@ -333,12 +286,12 @@ static int stm32x_protect_check(struct flash_bank_s *bank)
        }
        else
        {
-               /* medium density flash */
+               /* low/medium density flash protection */
                for (i = 0; i < num_bits; i++)
                {
                        set = 1;
 
-                       if ( protection & (1 << i))
+                       if (protection & (1 << i))
                                set = 0;
 
                        for (s = 0; s < stm32x_info->ppage_size; s++)
@@ -378,9 +331,9 @@ static int stm32x_erase(struct flash_bank_s *bank, int first, int last)
 
                status = stm32x_wait_status_busy(bank, 10);
 
-               if ( status & FLASH_WRPRTERR )
+               if (status & FLASH_WRPRTERR)
                        return ERROR_FLASH_OPERATION_FAILED;
-               if ( status & FLASH_PGERR )
+               if (status & FLASH_PGERR)
                        return ERROR_FLASH_OPERATION_FAILED;
                bank->sectors[i].is_erased = 1;
        }
@@ -409,7 +362,7 @@ static int stm32x_protect(struct flash_bank_s *bank, int set, int first, int las
 
        if ((first && (first % stm32x_info->ppage_size)) || ((last + 1) && (last + 1) % stm32x_info->ppage_size))
        {
-               LOG_WARNING("sector start/end incorrect - stm32 has %dK sector protection", stm32x_info->ppage_size);
+               LOG_WARNING("Error: start and end sectors must be on a %d sector boundary", stm32x_info->ppage_size);
                return ERROR_FLASH_SECTOR_INVALID;
        }
 
@@ -445,7 +398,7 @@ static int stm32x_protect(struct flash_bank_s *bank, int set, int first, int las
                        reg = (i / stm32x_info->ppage_size) / 8;
                        bit = (i / stm32x_info->ppage_size) - (reg * 8);
 
-                       if ( set )
+                       if (set)
                                prot_reg[reg] &= ~(1 << bit);
                        else
                                prot_reg[reg] |= (1 << bit);
@@ -459,7 +412,7 @@ static int stm32x_protect(struct flash_bank_s *bank, int set, int first, int las
                        reg = (i / stm32x_info->ppage_size) / 8;
                        bit = (i / stm32x_info->ppage_size) - (reg * 8);
 
-                       if ( set )
+                       if (set)
                                prot_reg[reg] &= ~(1 << bit);
                        else
                                prot_reg[reg] |= (1 << bit);
@@ -658,12 +611,12 @@ static int stm32x_write(struct flash_bank_s *bank, uint8_t *buffer, uint32_t off
 
                status = stm32x_wait_status_busy(bank, 5);
 
-               if ( status & FLASH_WRPRTERR )
+               if (status & FLASH_WRPRTERR)
                {
                        LOG_ERROR("flash memory not erased before writing");
                        return ERROR_FLASH_OPERATION_FAILED;
                }
-               if ( status & FLASH_PGERR )
+               if (status & FLASH_PGERR)
                {
                        LOG_ERROR("flash memory write protected");
                        return ERROR_FLASH_OPERATION_FAILED;
@@ -684,12 +637,12 @@ static int stm32x_write(struct flash_bank_s *bank, uint8_t *buffer, uint32_t off
 
                status = stm32x_wait_status_busy(bank, 5);
 
-               if ( status & FLASH_WRPRTERR )
+               if (status & FLASH_WRPRTERR)
                {
                        LOG_ERROR("flash memory not erased before writing");
                        return ERROR_FLASH_OPERATION_FAILED;
                }
-               if ( status & FLASH_PGERR )
+               if (status & FLASH_PGERR)
                {
                        LOG_ERROR("flash memory write protected");
                        return ERROR_FLASH_OPERATION_FAILED;
@@ -720,7 +673,7 @@ static int stm32x_probe(struct flash_bank_s *bank)
 
        /* read stm32 device id register */
        target_read_u32(target, 0xE0042000, &device_id);
-       LOG_INFO( "device id = 0x%08" PRIx32 "", device_id );
+       LOG_INFO("device id = 0x%08" PRIx32 "", device_id);
 
        /* get flash size from target */
        if (target_read_u16(target, 0x1FFFF7E0, &num_pages) != ERROR_OK)
@@ -740,7 +693,7 @@ static int stm32x_probe(struct flash_bank_s *bank)
                if (num_pages == 0xffff)
                {
                        /* number of sectors incorrect on revA */
-                       LOG_WARNING( "STM32 flash size failed, probe inaccurate - assuming 128k flash" );
+                       LOG_WARNING("STM32 flash size failed, probe inaccurate - assuming 128k flash");
                        num_pages = 128;
                }
        }
@@ -755,7 +708,7 @@ static int stm32x_probe(struct flash_bank_s *bank)
                if (num_pages == 0xffff)
                {
                        /* number of sectors incorrect on revA */
-                       LOG_WARNING( "STM32 flash size failed, probe inaccurate - assuming 32k flash" );
+                       LOG_WARNING("STM32 flash size failed, probe inaccurate - assuming 32k flash");
                        num_pages = 32;
                }
        }
@@ -770,32 +723,32 @@ static int stm32x_probe(struct flash_bank_s *bank)
                if (num_pages == 0xffff)
                {
                        /* number of sectors incorrect on revZ */
-                       LOG_WARNING( "STM32 flash size failed, probe inaccurate - assuming 512k flash" );
+                       LOG_WARNING("STM32 flash size failed, probe inaccurate - assuming 512k flash");
                        num_pages = 512;
                }
        }
        else if ((device_id & 0x7ff) == 0x418)
        {
-               /* connectivity line density - we have 1k pages
-                * 4 pages for a protection area */
-               page_size = 1024;
-               stm32x_info->ppage_size = 4;
+               /* connectivity line density - we have 2k pages
+                * 2 pages for a protection area */
+               page_size = 2048;
+               stm32x_info->ppage_size = 2;
 
                /* check for early silicon */
                if (num_pages == 0xffff)
                {
                        /* number of sectors incorrect on revZ */
-                       LOG_WARNING( "STM32 flash size failed, probe inaccurate - assuming 256k flash" );
+                       LOG_WARNING("STM32 flash size failed, probe inaccurate - assuming 256k flash");
                        num_pages = 256;
                }
        }
        else
        {
-               LOG_WARNING( "Cannot identify target as a STM32 family." );
+               LOG_WARNING("Cannot identify target as a STM32 family.");
                return ERROR_FLASH_OPERATION_FAILED;
        }
 
-       LOG_INFO( "flash size = %dkbytes", num_pages );
+       LOG_INFO("flash size = %dkbytes", num_pages);
 
        /* calculate numbers of pages */
        num_pages /= (page_size / 1024);
@@ -827,7 +780,7 @@ static int stm32x_auto_probe(struct flash_bank_s *bank)
 }
 
 #if 0
-static int stm32x_handle_part_id_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(stm32x_handle_part_id_command)
 {
        return ERROR_OK;
 }
@@ -921,6 +874,10 @@ static int stm32x_info(struct flash_bank_s *bank, char *buf, int buf_size)
                                snprintf(buf, buf_size, "A");
                                break;
 
+                       case 0x1001:
+                               snprintf(buf, buf_size, "Z");
+                               break;
+
                        default:
                                snprintf(buf, buf_size, "unknown");
                                break;
@@ -935,9 +892,8 @@ static int stm32x_info(struct flash_bank_s *bank, char *buf, int buf_size)
        return ERROR_OK;
 }
 
-static int stm32x_handle_lock_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(stm32x_handle_lock_command)
 {
-       flash_bank_t *bank;
        target_t *target = NULL;
        stm32x_flash_bank_t *stm32x_info = NULL;
 
@@ -947,12 +903,10 @@ static int stm32x_handle_lock_command(struct command_context_s *cmd_ctx, char *c
                return ERROR_OK;
        }
 
-       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;
 
        stm32x_info = bank->driver_priv;
 
@@ -984,9 +938,8 @@ static int stm32x_handle_lock_command(struct command_context_s *cmd_ctx, char *c
        return ERROR_OK;
 }
 
-static int stm32x_handle_unlock_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(stm32x_handle_unlock_command)
 {
-       flash_bank_t *bank;
        target_t *target = NULL;
        stm32x_flash_bank_t *stm32x_info = NULL;
 
@@ -996,12 +949,10 @@ static int stm32x_handle_unlock_command(struct command_context_s *cmd_ctx, char
                return ERROR_OK;
        }
 
-       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;
 
        stm32x_info = bank->driver_priv;
 
@@ -1030,9 +981,8 @@ static int stm32x_handle_unlock_command(struct command_context_s *cmd_ctx, char
        return ERROR_OK;
 }
 
-static int stm32x_handle_options_read_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(stm32x_handle_options_read_command)
 {
-       flash_bank_t *bank;
        uint32_t optionbyte;
        target_t *target = NULL;
        stm32x_flash_bank_t *stm32x_info = NULL;
@@ -1043,12 +993,10 @@ static int stm32x_handle_options_read_command(struct command_context_s *cmd_ctx,
                return ERROR_OK;
        }
 
-       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;
 
        stm32x_info = bank->driver_priv;
 
@@ -1089,9 +1037,8 @@ static int stm32x_handle_options_read_command(struct command_context_s *cmd_ctx,
        return ERROR_OK;
 }
 
-static int stm32x_handle_options_write_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(stm32x_handle_options_write_command)
 {
-       flash_bank_t *bank;
        target_t *target = NULL;
        stm32x_flash_bank_t *stm32x_info = NULL;
        uint16_t optionbyte = 0xF8;
@@ -1102,12 +1049,10 @@ static int stm32x_handle_options_write_command(struct command_context_s *cmd_ctx
                return ERROR_OK;
        }
 
-       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;
 
        stm32x_info = bank->driver_priv;
 
@@ -1188,13 +1133,13 @@ static int stm32x_mass_erase(struct flash_bank_s *bank)
 
        target_write_u32(target, STM32_FLASH_CR, FLASH_LOCK);
 
-       if ( status & FLASH_WRPRTERR )
+       if (status & FLASH_WRPRTERR)
        {
                LOG_ERROR("stm32x device protected");
                return ERROR_OK;
        }
 
-       if ( status & FLASH_PGERR )
+       if (status & FLASH_PGERR)
        {
                LOG_ERROR("stm32x device programming failed");
                return ERROR_OK;
@@ -1203,9 +1148,8 @@ static int stm32x_mass_erase(struct flash_bank_s *bank)
        return ERROR_OK;
 }
 
-static int stm32x_handle_mass_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(stm32x_handle_mass_erase_command)
 {
-       flash_bank_t *bank;
        int i;
 
        if (argc < 1)
@@ -1214,12 +1158,10 @@ static int stm32x_handle_mass_erase_command(struct command_context_s *cmd_ctx, c
                return ERROR_OK;
        }
 
-       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 (stm32x_mass_erase(bank) == ERROR_OK)
        {
@@ -1238,3 +1180,41 @@ static int stm32x_handle_mass_erase_command(struct command_context_s *cmd_ctx, c
 
        return ERROR_OK;
 }
+
+static int stm32x_register_commands(struct command_context_s *cmd_ctx)
+{
+       command_t *stm32x_cmd = register_command(cmd_ctx, NULL, "stm32x",
+                       NULL, COMMAND_ANY, "stm32x flash specific commands");
+
+       register_command(cmd_ctx, stm32x_cmd, "lock",
+                       stm32x_handle_lock_command, COMMAND_EXEC,
+                       "lock device");
+       register_command(cmd_ctx, stm32x_cmd, "unlock",
+                       stm32x_handle_unlock_command, COMMAND_EXEC,
+                       "unlock protected device");
+       register_command(cmd_ctx, stm32x_cmd, "mass_erase",
+                       stm32x_handle_mass_erase_command, COMMAND_EXEC,
+                       "mass erase device");
+       register_command(cmd_ctx, stm32x_cmd, "options_read",
+                       stm32x_handle_options_read_command, COMMAND_EXEC,
+                       "read device option bytes");
+       register_command(cmd_ctx, stm32x_cmd, "options_write",
+                       stm32x_handle_options_write_command, COMMAND_EXEC,
+                       "write device option bytes");
+
+       return ERROR_OK;
+}
+
+flash_driver_t stm32x_flash = {
+               .name = "stm32x",
+               .register_commands = &stm32x_register_commands,
+               .flash_bank_command = &stm32x_flash_bank_command,
+               .erase = &stm32x_erase,
+               .protect = &stm32x_protect,
+               .write = &stm32x_write,
+               .probe = &stm32x_probe,
+               .auto_probe = &stm32x_auto_probe,
+               .erase_check = &default_flash_mem_blank_check,
+               .protect_check = &stm32x_protect_check,
+               .info = &stm32x_info,
+       };