flash/nor/stm32f1x: fix error message
[fw/openocd] / src / flash / nor / stm32f1x.c
index fbd75982836c38b0b1b847bb66530efbdff77bf6..9cd282d65d7088055f0091b6f7daba719d2c1ecb 100644 (file)
@@ -116,7 +116,7 @@ struct stm32x_options {
 struct stm32x_flash_bank {
        struct stm32x_options option_bytes;
        int ppage_size;
-       int probed;
+       bool probed;
 
        bool has_dual_banks;
        /* used to access dual flash bank stm32xl */
@@ -131,7 +131,7 @@ struct stm32x_flash_bank {
 static int stm32x_mass_erase(struct flash_bank *bank);
 static int stm32x_get_device_id(struct flash_bank *bank, uint32_t *device_id);
 static int stm32x_write_block(struct flash_bank *bank, const uint8_t *buffer,
-               uint32_t offset, uint32_t count);
+               uint32_t address, uint32_t count);
 
 /* flash bank stm32x <base> <size> 0 0 <target#>
  */
@@ -145,7 +145,7 @@ FLASH_BANK_COMMAND_HANDLER(stm32x_flash_bank_command)
        stm32x_info = malloc(sizeof(struct stm32x_flash_bank));
 
        bank->driver_priv = stm32x_info;
-       stm32x_info->probed = 0;
+       stm32x_info->probed = false;
        stm32x_info->has_dual_banks = false;
        stm32x_info->can_load_options = false;
        stm32x_info->register_base = FLASH_REG_BASE_B0;
@@ -215,7 +215,7 @@ static int stm32x_check_operation_supported(struct flash_bank *bank)
        /* if we have a dual flash bank device then
         * we need to perform option byte stuff on bank0 only */
        if (stm32x_info->register_base != FLASH_REG_BASE_B0) {
-               LOG_ERROR("Option Byte Operation's must use bank0");
+               LOG_ERROR("Option byte operations must use bank 0");
                return ERROR_FLASH_OPERATION_FAILED;
        }
 
@@ -229,34 +229,20 @@ static int stm32x_read_options(struct flash_bank *bank)
        uint32_t option_bytes;
        int retval;
 
-       /* read user and read protection option bytes */
-       retval = target_read_u32(target, STM32_OB_RDP, &option_bytes);
+       /* read user and read protection option bytes, user data option bytes */
+       retval = target_read_u32(target, STM32_FLASH_OBR_B0, &option_bytes);
        if (retval != ERROR_OK)
                return retval;
 
-       stm32x_info->option_bytes.rdp = option_bytes & 0xFF;
-       stm32x_info->option_bytes.user = (option_bytes >> 16) & 0xFF;
-
-       /* read user data option bytes */
-       retval = target_read_u32(target, STM32_OB_DATA0, &option_bytes);
-       if (retval != ERROR_OK)
-               return retval;
-
-       stm32x_info->option_bytes.data = ((option_bytes >> 8) & 0xFF00) | (option_bytes & 0xFF);
+       stm32x_info->option_bytes.rdp = (option_bytes & (1 << OPT_READOUT)) ? 0 : stm32x_info->default_rdp;
+       stm32x_info->option_bytes.user = (option_bytes >> stm32x_info->option_offset >> 2) & 0xff;
+       stm32x_info->option_bytes.data = (option_bytes >> stm32x_info->user_data_offset) & 0xffff;
 
        /* read write protection option bytes */
-       retval = target_read_u32(target, STM32_OB_WRP0, &option_bytes);
-       if (retval != ERROR_OK)
-               return retval;
-
-       stm32x_info->option_bytes.protection = ((option_bytes >> 8) & 0xFF00) | (option_bytes & 0xFF);
-
-       retval = target_read_u32(target, STM32_OB_WRP2, &option_bytes);
+       retval = target_read_u32(target, STM32_FLASH_WRPR_B0, &stm32x_info->option_bytes.protection);
        if (retval != ERROR_OK)
                return retval;
 
-       stm32x_info->option_bytes.protection |= (((option_bytes >> 8) & 0xFF00) | (option_bytes & 0xFF)) << 16;
-
        return ERROR_OK;
 }
 
@@ -343,8 +329,7 @@ static int stm32x_write_options(struct flash_bank *bank)
        target_buffer_set_u16(target, opt_bytes + 12, (stm32x_info->option_bytes.protection >> 16) & 0xff);
        target_buffer_set_u16(target, opt_bytes + 14, (stm32x_info->option_bytes.protection >> 24) & 0xff);
 
-       uint32_t offset = STM32_OB_RDP - bank->base;
-       retval = stm32x_write_block(bank, opt_bytes, offset, sizeof(opt_bytes) / 2);
+       retval = stm32x_write_block(bank, opt_bytes, STM32_OB_RDP, sizeof(opt_bytes) / 2);
        if (retval != ERROR_OK) {
                if (retval == ERROR_TARGET_RESOURCE_NOT_AVAILABLE)
                        LOG_ERROR("working area required to erase options bytes");
@@ -374,16 +359,16 @@ static int stm32x_protect_check(struct flash_bank *bank)
        if (retval != ERROR_OK)
                return retval;
 
-       for (int i = 0; i < bank->num_prot_blocks; i++)
+       for (unsigned int i = 0; i < bank->num_prot_blocks; i++)
                bank->prot_blocks[i].is_protected = (protection & (1 << i)) ? 0 : 1;
 
        return ERROR_OK;
 }
 
-static int stm32x_erase(struct flash_bank *bank, int first, int last)
+static int stm32x_erase(struct flash_bank *bank, unsigned int first,
+               unsigned int last)
 {
        struct target *target = bank->target;
-       int i;
 
        if (bank->target->state != TARGET_HALTED) {
                LOG_ERROR("Target not halted");
@@ -401,7 +386,7 @@ static int stm32x_erase(struct flash_bank *bank, int first, int last)
        if (retval != ERROR_OK)
                return retval;
 
-       for (i = first; i <= last; i++) {
+       for (unsigned int i = first; i <= last; i++) {
                retval = target_write_u32(target, stm32x_get_flash_reg(bank, STM32_FLASH_CR), FLASH_PER);
                if (retval != ERROR_OK)
                        return retval;
@@ -428,7 +413,8 @@ static int stm32x_erase(struct flash_bank *bank, int first, int last)
        return ERROR_OK;
 }
 
-static int stm32x_protect(struct flash_bank *bank, int set, int first, int last)
+static int stm32x_protect(struct flash_bank *bank, int set, unsigned int first,
+               unsigned int last)
 {
        struct target *target = bank->target;
        struct stm32x_flash_bank *stm32x_info = bank->driver_priv;
@@ -443,10 +429,12 @@ static int stm32x_protect(struct flash_bank *bank, int set, int first, int last)
                return retval;
 
        retval = stm32x_erase_options(bank);
-       if (retval != ERROR_OK)
+       if (retval != ERROR_OK) {
+               LOG_ERROR("stm32x failed to erase options");
                return retval;
+       }
 
-       for (int i = first; i <= last; i++) {
+       for (unsigned int i = first; i <= last; i++) {
                if (set)
                        stm32x_info->option_bytes.protection &= ~(1 << i);
                else
@@ -457,14 +445,13 @@ static int stm32x_protect(struct flash_bank *bank, int set, int first, int last)
 }
 
 static int stm32x_write_block(struct flash_bank *bank, const uint8_t *buffer,
-               uint32_t offset, uint32_t count)
+               uint32_t address, uint32_t count)
 {
        struct stm32x_flash_bank *stm32x_info = bank->driver_priv;
        struct target *target = bank->target;
        uint32_t buffer_size = 16384;
        struct working_area *write_algorithm;
        struct working_area *source;
-       uint32_t address = bank->base + offset;
        struct reg_param reg_params[5];
        struct armv7m_algorithm armv7m_info;
        int retval = ERROR_OK;
@@ -599,7 +586,7 @@ static int stm32x_write(struct flash_bank *bank, const uint8_t *buffer,
                goto cleanup;
 
        /* try using a block write */
-       retval = stm32x_write_block(bank, buffer, offset, words_remaining);
+       retval = stm32x_write_block(bank, buffer, bank->base + offset, words_remaining);
 
        if (retval == ERROR_TARGET_RESOURCE_NOT_AVAILABLE) {
                /* if block write failed (no sufficient working area),
@@ -630,9 +617,7 @@ reset_pg_and_lock:
                retval = retval2;
 
 cleanup:
-       if (new_buffer)
-               free(new_buffer);
-
+       free(new_buffer);
        return retval;
 }
 
@@ -711,7 +696,7 @@ static int stm32x_probe(struct flash_bank *bank)
        int page_size;
        uint32_t base_address = 0x08000000;
 
-       stm32x_info->probed = 0;
+       stm32x_info->probed = false;
        stm32x_info->register_base = FLASH_REG_BASE_B0;
        stm32x_info->user_data_offset = 10;
        stm32x_info->option_offset = 0;
@@ -728,31 +713,79 @@ static int stm32x_probe(struct flash_bank *bank)
 
        /* set page size, protection granularity and max flash size depending on family */
        switch (device_id & 0xfff) {
-       case 0x410: /* medium density */
+       case 0x440: /* stm32f05x */
+               page_size = 1024;
+               stm32x_info->ppage_size = 4;
+               max_flash_size_in_kb = 64;
+               stm32x_info->user_data_offset = 16;
+               stm32x_info->option_offset = 6;
+               stm32x_info->default_rdp = 0xAA;
+               stm32x_info->can_load_options = true;
+               break;
+       case 0x444: /* stm32f03x */
+       case 0x445: /* stm32f04x */
+               page_size = 1024;
+               stm32x_info->ppage_size = 4;
+               max_flash_size_in_kb = 32;
+               stm32x_info->user_data_offset = 16;
+               stm32x_info->option_offset = 6;
+               stm32x_info->default_rdp = 0xAA;
+               stm32x_info->can_load_options = true;
+               break;
+       case 0x448: /* stm32f07x */
+               page_size = 2048;
+               stm32x_info->ppage_size = 4;
+               max_flash_size_in_kb = 128;
+               stm32x_info->user_data_offset = 16;
+               stm32x_info->option_offset = 6;
+               stm32x_info->default_rdp = 0xAA;
+               stm32x_info->can_load_options = true;
+               break;
+       case 0x442: /* stm32f09x */
+               page_size = 2048;
+               stm32x_info->ppage_size = 4;
+               max_flash_size_in_kb = 256;
+               stm32x_info->user_data_offset = 16;
+               stm32x_info->option_offset = 6;
+               stm32x_info->default_rdp = 0xAA;
+               stm32x_info->can_load_options = true;
+               break;
+       case 0x410: /* stm32f1x medium-density */
                page_size = 1024;
                stm32x_info->ppage_size = 4;
                max_flash_size_in_kb = 128;
                break;
-       case 0x412: /* low density */
+       case 0x412: /* stm32f1x low-density */
                page_size = 1024;
                stm32x_info->ppage_size = 4;
                max_flash_size_in_kb = 32;
                break;
-       case 0x414: /* high density */
+       case 0x414: /* stm32f1x high-density */
                page_size = 2048;
                stm32x_info->ppage_size = 2;
                max_flash_size_in_kb = 512;
                break;
-       case 0x418: /* connectivity line density */
+       case 0x418: /* stm32f1x connectivity */
                page_size = 2048;
                stm32x_info->ppage_size = 2;
                max_flash_size_in_kb = 256;
                break;
-       case 0x420: /* value line density */
+       case 0x430: /* stm32f1 XL-density (dual flash banks) */
+               page_size = 2048;
+               stm32x_info->ppage_size = 2;
+               max_flash_size_in_kb = 1024;
+               stm32x_info->has_dual_banks = true;
+               break;
+       case 0x420: /* stm32f100xx low- and medium-density value line */
                page_size = 1024;
                stm32x_info->ppage_size = 4;
                max_flash_size_in_kb = 128;
                break;
+       case 0x428: /* stm32f100xx high-density value line */
+               page_size = 2048;
+               stm32x_info->ppage_size = 4;
+               max_flash_size_in_kb = 512;
+               break;
        case 0x422: /* stm32f302/3xb/c */
                page_size = 2048;
                stm32x_info->ppage_size = 2;
@@ -771,17 +804,6 @@ static int stm32x_probe(struct flash_bank *bank)
                stm32x_info->default_rdp = 0xAA;
                stm32x_info->can_load_options = true;
                break;
-       case 0x428: /* value line High density */
-               page_size = 2048;
-               stm32x_info->ppage_size = 4;
-               max_flash_size_in_kb = 128;
-               break;
-       case 0x430: /* xl line density (dual flash banks) */
-               page_size = 2048;
-               stm32x_info->ppage_size = 2;
-               max_flash_size_in_kb = 1024;
-               stm32x_info->has_dual_banks = true;
-               break;
        case 0x432: /* stm32f37x */
                page_size = 2048;
                stm32x_info->ppage_size = 2;
@@ -801,27 +823,6 @@ static int stm32x_probe(struct flash_bank *bank)
                stm32x_info->default_rdp = 0xAA;
                stm32x_info->can_load_options = true;
                break;
-       case 0x440: /* stm32f05x */
-       case 0x444: /* stm32f03x */
-       case 0x445: /* stm32f04x */
-               page_size = 1024;
-               stm32x_info->ppage_size = 4;
-               max_flash_size_in_kb = 64;
-               stm32x_info->user_data_offset = 16;
-               stm32x_info->option_offset = 6;
-               stm32x_info->default_rdp = 0xAA;
-               stm32x_info->can_load_options = true;
-               break;
-       case 0x448: /* stm32f07x */
-       case 0x442: /* stm32f09x */
-               page_size = 2048;
-               stm32x_info->ppage_size = 4;
-               max_flash_size_in_kb = 256;
-               stm32x_info->user_data_offset = 16;
-               stm32x_info->option_offset = 6;
-               stm32x_info->default_rdp = 0xAA;
-               stm32x_info->can_load_options = true;
-               break;
        default:
                LOG_WARNING("Cannot identify target as a STM32 family.");
                return ERROR_FAIL;
@@ -869,15 +870,11 @@ static int stm32x_probe(struct flash_bank *bank)
        /* check that calculation result makes sense */
        assert(num_pages > 0);
 
-       if (bank->sectors) {
-               free(bank->sectors);
-               bank->sectors = NULL;
-       }
+       free(bank->sectors);
+       bank->sectors = NULL;
 
-       if (bank->prot_blocks) {
-               free(bank->prot_blocks);
-               bank->prot_blocks = NULL;
-       }
+       free(bank->prot_blocks);
+       bank->prot_blocks = NULL;
 
        bank->base = base_address;
        bank->size = (num_pages * page_size);
@@ -900,7 +897,7 @@ static int stm32x_probe(struct flash_bank *bank)
        if (num_prot_blocks == 32)
                bank->prot_blocks[31].size = (num_pages - (31 * stm32x_info->ppage_size)) * page_size;
 
-       stm32x_info->probed = 1;
+       stm32x_info->probed = true;
 
        return ERROR_OK;
 }
@@ -1186,7 +1183,7 @@ COMMAND_HANDLER(stm32x_handle_lock_command)
                return retval;
 
        if (stm32x_erase_options(bank) != ERROR_OK) {
-               command_print(CMD_CTX, "stm32x failed to erase options");
+               command_print(CMD, "stm32x failed to erase options");
                return ERROR_OK;
        }
 
@@ -1194,11 +1191,11 @@ COMMAND_HANDLER(stm32x_handle_lock_command)
        stm32x_info->option_bytes.rdp = 0;
 
        if (stm32x_write_options(bank) != ERROR_OK) {
-               command_print(CMD_CTX, "stm32x failed to lock device");
+               command_print(CMD, "stm32x failed to lock device");
                return ERROR_OK;
        }
 
-       command_print(CMD_CTX, "stm32x locked");
+       command_print(CMD, "stm32x locked");
 
        return ERROR_OK;
 }
@@ -1227,16 +1224,16 @@ COMMAND_HANDLER(stm32x_handle_unlock_command)
                return retval;
 
        if (stm32x_erase_options(bank) != ERROR_OK) {
-               command_print(CMD_CTX, "stm32x failed to unlock device");
+               command_print(CMD, "stm32x failed to erase options");
                return ERROR_OK;
        }
 
        if (stm32x_write_options(bank) != ERROR_OK) {
-               command_print(CMD_CTX, "stm32x failed to lock device");
+               command_print(CMD, "stm32x failed to unlock device");
                return ERROR_OK;
        }
 
-       command_print(CMD_CTX, "stm32x unlocked.\n"
+       command_print(CMD, "stm32x unlocked.\n"
                        "INFO: a reset or power cycle is required "
                        "for the new settings to take effect.");
 
@@ -1281,30 +1278,30 @@ COMMAND_HANDLER(stm32x_handle_options_read_command)
                return retval;
 
        if (optionbyte & (1 << OPT_ERROR))
-               command_print(CMD_CTX, "option byte complement error");
+               command_print(CMD, "option byte complement error");
 
-       command_print(CMD_CTX, "option byte register = 0x%" PRIx32 "", optionbyte);
-       command_print(CMD_CTX, "write protection register = 0x%" PRIx32 "", protection);
+       command_print(CMD, "option byte register = 0x%" PRIx32 "", optionbyte);
+       command_print(CMD, "write protection register = 0x%" PRIx32 "", protection);
 
-       command_print(CMD_CTX, "read protection: %s",
+       command_print(CMD, "read protection: %s",
                                (optionbyte & (1 << OPT_READOUT)) ? "on" : "off");
 
        /* user option bytes are offset depending on variant */
        optionbyte >>= stm32x_info->option_offset;
 
-       command_print(CMD_CTX, "watchdog: %sware",
+       command_print(CMD, "watchdog: %sware",
                                (optionbyte & (1 << OPT_RDWDGSW)) ? "soft" : "hard");
 
-       command_print(CMD_CTX, "stop mode: %sreset generated upon entry",
+       command_print(CMD, "stop mode: %sreset generated upon entry",
                                (optionbyte & (1 << OPT_RDRSTSTOP)) ? "no " : "");
 
-       command_print(CMD_CTX, "standby mode: %sreset generated upon entry",
+       command_print(CMD, "standby mode: %sreset generated upon entry",
                                (optionbyte & (1 << OPT_RDRSTSTDBY)) ? "no " : "");
 
        if (stm32x_info->has_dual_banks)
-               command_print(CMD_CTX, "boot: bank %d", (optionbyte & (1 << OPT_BFB2)) ? 0 : 1);
+               command_print(CMD, "boot: bank %d", (optionbyte & (1 << OPT_BFB2)) ? 0 : 1);
 
-       command_print(CMD_CTX, "user data = 0x%02" PRIx16 "", user_data);
+       command_print(CMD, "user data = 0x%02" PRIx16 "", user_data);
 
        return ERROR_OK;
 }
@@ -1313,7 +1310,8 @@ COMMAND_HANDLER(stm32x_handle_options_write_command)
 {
        struct target *target = NULL;
        struct stm32x_flash_bank *stm32x_info = NULL;
-       uint16_t optionbyte;
+       uint8_t optionbyte;
+       uint16_t useropt;
 
        if (CMD_ARGC < 2)
                return ERROR_COMMAND_SYNTAX_ERROR;
@@ -1342,6 +1340,7 @@ COMMAND_HANDLER(stm32x_handle_options_write_command)
 
        /* start with current options */
        optionbyte = stm32x_info->option_bytes.user;
+       useropt = stm32x_info->option_bytes.data;
 
        /* skip over flash bank */
        CMD_ARGC--;
@@ -1360,7 +1359,13 @@ COMMAND_HANDLER(stm32x_handle_options_write_command)
                        optionbyte |= (1 << 2);
                else if (strcmp("RSTSTNDBY", CMD_ARGV[0]) == 0)
                        optionbyte &= ~(1 << 2);
-               else if (stm32x_info->has_dual_banks) {
+               else if (strcmp("USEROPT", CMD_ARGV[0]) == 0) {
+                       if (CMD_ARGC < 2)
+                               return ERROR_COMMAND_SYNTAX_ERROR;
+                       COMMAND_PARSE_NUMBER(u16, CMD_ARGV[1], useropt);
+                       CMD_ARGC--;
+                       CMD_ARGV++;
+               } else if (stm32x_info->has_dual_banks) {
                        if (strcmp("BOOT0", CMD_ARGV[0]) == 0)
                                optionbyte |= (1 << 3);
                        else if (strcmp("BOOT1", CMD_ARGV[0]) == 0)
@@ -1374,18 +1379,19 @@ COMMAND_HANDLER(stm32x_handle_options_write_command)
        }
 
        if (stm32x_erase_options(bank) != ERROR_OK) {
-               command_print(CMD_CTX, "stm32x failed to erase options");
+               command_print(CMD, "stm32x failed to erase options");
                return ERROR_OK;
        }
 
        stm32x_info->option_bytes.user = optionbyte;
+       stm32x_info->option_bytes.data = useropt;
 
        if (stm32x_write_options(bank) != ERROR_OK) {
-               command_print(CMD_CTX, "stm32x failed to write options");
+               command_print(CMD, "stm32x failed to write options");
                return ERROR_OK;
        }
 
-       command_print(CMD_CTX, "stm32x write options complete.\n"
+       command_print(CMD, "stm32x write options complete.\n"
                                "INFO: %spower cycle is required "
                                "for the new settings to take effect.",
                                stm32x_info->can_load_options
@@ -1478,8 +1484,6 @@ static int stm32x_mass_erase(struct flash_bank *bank)
 
 COMMAND_HANDLER(stm32x_handle_mass_erase_command)
 {
-       int i;
-
        if (CMD_ARGC < 1)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
@@ -1491,12 +1495,12 @@ COMMAND_HANDLER(stm32x_handle_mass_erase_command)
        retval = stm32x_mass_erase(bank);
        if (retval == ERROR_OK) {
                /* set all sectors as erased */
-               for (i = 0; i < bank->num_sectors; i++)
+               for (unsigned int i = 0; i < bank->num_sectors; i++)
                        bank->sectors[i].is_erased = 1;
 
-               command_print(CMD_CTX, "stm32x mass erase complete");
+               command_print(CMD, "stm32x mass erase complete");
        } else
-               command_print(CMD_CTX, "stm32x mass erase failed");
+               command_print(CMD, "stm32x mass erase failed");
 
        return retval;
 }
@@ -1536,7 +1540,7 @@ static const struct command_registration stm32x_exec_command_handlers[] = {
                .mode = COMMAND_EXEC,
                .usage = "bank_id ('SWWDG'|'HWWDG') "
                        "('RSTSTNDBY'|'NORSTSTNDBY') "
-                       "('RSTSTOP'|'NORSTSTOP')",
+                       "('RSTSTOP'|'NORSTSTOP') ('USEROPT' user_data)",
                .help = "Replace bits in device option bytes.",
        },
        {
@@ -1560,7 +1564,7 @@ static const struct command_registration stm32x_command_handlers[] = {
        COMMAND_REGISTRATION_DONE
 };
 
-struct flash_driver stm32f1x_flash = {
+const struct flash_driver stm32f1x_flash = {
        .name = "stm32f1x",
        .commands = stm32x_command_handlers,
        .flash_bank_command = stm32x_flash_bank_command,