openocd: fix SPDX tag format for files .c
[fw/openocd] / src / flash / nor / str7x.c
index 6cd5d69f8be8074fa1343c3369b5cd62bd70f72f..b91e22e044813452e621aeb5f8c89892dd0e16eb 100644 (file)
@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+
 /***************************************************************************
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
@@ -7,21 +9,6 @@
  *                                                                         *
  *   Copyright (C) 2010 Ã˜yvind Harboe                                      *
  *   oyvind.harboe@zylin.com                                               *
- *                                                                         *
- *   This program is free software; you can redistribute it and/or modify  *
- *   it under the terms of the GNU General Public License as published by  *
- *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- *   This program is distributed in the hope that it will be useful,       *
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
- *   GNU General Public License for more details.                          *
- *                                                                         *
- *   You should have received a copy of the GNU General Public License     *
- *   along with this program; if not, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
@@ -90,7 +77,6 @@ struct str7x_flash_bank {
        uint32_t disable_bit;
        uint32_t busy_bits;
        uint32_t register_base;
-       struct working_area *write_algorithm;
 };
 
 struct str7x_mem_layout {
@@ -114,7 +100,7 @@ enum str7x_status_codes {
        STR7X_BUSY = 11
 };
 
-static struct str7x_mem_layout mem_layout_str7bank0[] = {
+static const struct str7x_mem_layout mem_layout_str7bank0[] = {
        {0x00000000, 0x02000, 0x01},
        {0x00002000, 0x02000, 0x02},
        {0x00004000, 0x02000, 0x04},
@@ -125,7 +111,7 @@ static struct str7x_mem_layout mem_layout_str7bank0[] = {
        {0x00030000, 0x10000, 0x80}
 };
 
-static struct str7x_mem_layout mem_layout_str7bank1[] = {
+static const struct str7x_mem_layout mem_layout_str7bank1[] = {
        {0x00000000, 0x02000, 0x10000},
        {0x00002000, 0x02000, 0x20000}
 };
@@ -141,7 +127,7 @@ static int str7x_build_block_list(struct flash_bank *bank)
        struct str7x_flash_bank *str7x_info = bank->driver_priv;
 
        int i;
-       int num_sectors;
+       unsigned int num_sectors;
        int b0_sectors = 0, b1_sectors = 0;
 
        switch (bank->size) {
@@ -227,8 +213,6 @@ FLASH_BANK_COMMAND_HANDLER(str7x_flash_bank_command)
 
        str7x_build_block_list(bank);
 
-       str7x_info->write_algorithm = NULL;
-
        return ERROR_OK;
 }
 
@@ -311,7 +295,6 @@ static int str7x_protect_check(struct flash_bank *bank)
        struct str7x_flash_bank *str7x_info = bank->driver_priv;
        struct target *target = bank->target;
 
-       int i;
        uint32_t flash_flags;
 
        if (bank->target->state != TARGET_HALTED) {
@@ -324,7 +307,7 @@ static int str7x_protect_check(struct flash_bank *bank)
        if (retval != ERROR_OK)
                return retval;
 
-       for (i = 0; i < bank->num_sectors; i++) {
+       for (unsigned int i = 0; i < bank->num_sectors; i++) {
                if (flash_flags & str7x_info->sector_bits[i])
                        bank->sectors[i].is_protected = 0;
                else
@@ -334,12 +317,12 @@ static int str7x_protect_check(struct flash_bank *bank)
        return ERROR_OK;
 }
 
-static int str7x_erase(struct flash_bank *bank, int first, int last)
+static int str7x_erase(struct flash_bank *bank, unsigned int first,
+               unsigned int last)
 {
        struct str7x_flash_bank *str7x_info = bank->driver_priv;
        struct target *target = bank->target;
 
-       int i;
        uint32_t cmd;
        uint32_t sectors = 0;
        int err;
@@ -349,7 +332,7 @@ static int str7x_erase(struct flash_bank *bank, int first, int last)
                return ERROR_TARGET_NOT_HALTED;
        }
 
-       for (i = first; i <= last; i++)
+       for (unsigned int i = first; i <= last; i++)
                sectors |= str7x_info->sector_bits[i];
 
        LOG_DEBUG("sectors: 0x%" PRIx32 "", sectors);
@@ -382,17 +365,14 @@ static int str7x_erase(struct flash_bank *bank, int first, int last)
        if (err != ERROR_OK)
                return err;
 
-       for (i = first; i <= last; i++)
-               bank->sectors[i].is_erased = 1;
-
        return ERROR_OK;
 }
 
-static int str7x_protect(struct flash_bank *bank, int set, int first, int last)
+static int str7x_protect(struct flash_bank *bank, int set, unsigned int first,
+               unsigned int last)
 {
        struct str7x_flash_bank *str7x_info = bank->driver_priv;
        struct target *target = bank->target;
-       int i;
        uint32_t cmd;
        uint32_t protect_blocks;
 
@@ -404,7 +384,7 @@ static int str7x_protect(struct flash_bank *bank, int set, int first, int last)
        protect_blocks = 0xFFFFFFFF;
 
        if (set) {
-               for (i = first; i <= last; i++)
+               for (unsigned int i = first; i <= last; i++)
                        protect_blocks &= ~(str7x_info->sector_bits[i]);
        }
 
@@ -445,19 +425,20 @@ static int str7x_protect(struct flash_bank *bank, int set, int first, int last)
        return ERROR_OK;
 }
 
-static int str7x_write_block(struct flash_bank *bank, uint8_t *buffer,
+static int str7x_write_block(struct flash_bank *bank, const uint8_t *buffer,
                uint32_t offset, uint32_t count)
 {
        struct str7x_flash_bank *str7x_info = bank->driver_priv;
        struct target *target = bank->target;
        uint32_t buffer_size = 32768;
+       struct working_area *write_algorithm;
        struct working_area *source;
        uint32_t address = bank->base + offset;
        struct reg_param reg_params[6];
-       struct arm_algorithm armv4_5_info;
+       struct arm_algorithm arm_algo;
        int retval = ERROR_OK;
 
-       /* see contib/loaders/flash/str7x.s for src */
+       /* see contrib/loaders/flash/str7x.s for src */
 
        static const uint32_t str7x_flash_write_code[] = {
                                        /* write:                               */
@@ -487,31 +468,31 @@ static int str7x_write_block(struct flash_bank *bank, uint8_t *buffer,
 
        /* flash write code */
        if (target_alloc_working_area_try(target, sizeof(str7x_flash_write_code),
-                       &str7x_info->write_algorithm) != ERROR_OK) {
+                       &write_algorithm) != ERROR_OK) {
                return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
-       };
+       }
 
-       target_write_buffer(target, str7x_info->write_algorithm->address,
-                       sizeof(str7x_flash_write_code),
-                       (uint8_t *)str7x_flash_write_code);
+       uint8_t code[sizeof(str7x_flash_write_code)];
+       target_buffer_set_u32_array(target, code, ARRAY_SIZE(str7x_flash_write_code),
+                       str7x_flash_write_code);
+       target_write_buffer(target, write_algorithm->address, sizeof(code), code);
 
        /* memory buffer */
        while (target_alloc_working_area_try(target, buffer_size, &source) != ERROR_OK) {
                buffer_size /= 2;
                if (buffer_size <= 256) {
-                       /* if we already allocated the writing code, but failed to get a
+                       /* we already allocated the writing code, but failed to get a
                         * buffer, free the algorithm */
-                       if (str7x_info->write_algorithm)
-                               target_free_working_area(target, str7x_info->write_algorithm);
+                       target_free_working_area(target, write_algorithm);
 
                        LOG_WARNING("no large enough working area available, can't do block memory writes");
                        return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
                }
        }
 
-       armv4_5_info.common_magic = ARM_COMMON_MAGIC;
-       armv4_5_info.core_mode = ARM_MODE_SVC;
-       armv4_5_info.core_state = ARM_STATE_ARM;
+       arm_algo.common_magic = ARM_COMMON_MAGIC;
+       arm_algo.core_mode = ARM_MODE_SVC;
+       arm_algo.core_state = ARM_STATE_ARM;
 
        init_reg_param(&reg_params[0], "r0", 32, PARAM_OUT);
        init_reg_param(&reg_params[1], "r1", 32, PARAM_OUT);
@@ -532,9 +513,9 @@ static int str7x_write_block(struct flash_bank *bank, uint8_t *buffer,
                buf_set_u32(reg_params[5].value, 0, 32, str7x_info->busy_bits);
 
                retval = target_run_algorithm(target, 0, NULL, 6, reg_params,
-                               str7x_info->write_algorithm->address,
-                               str7x_info->write_algorithm->address + (sizeof(str7x_flash_write_code) - 4),
-                               10000, &armv4_5_info);
+                               write_algorithm->address,
+                               write_algorithm->address + (sizeof(str7x_flash_write_code) - 4),
+                               10000, &arm_algo);
                if (retval != ERROR_OK)
                        break;
 
@@ -549,7 +530,7 @@ static int str7x_write_block(struct flash_bank *bank, uint8_t *buffer,
        }
 
        target_free_working_area(target, source);
-       target_free_working_area(target, str7x_info->write_algorithm);
+       target_free_working_area(target, write_algorithm);
 
        destroy_reg_param(&reg_params[0]);
        destroy_reg_param(&reg_params[1]);
@@ -561,7 +542,7 @@ static int str7x_write_block(struct flash_bank *bank, uint8_t *buffer,
        return retval;
 }
 
-static int str7x_write(struct flash_bank *bank, uint8_t *buffer,
+static int str7x_write(struct flash_bank *bank, const uint8_t *buffer,
                uint32_t offset, uint32_t count)
 {
        struct target *target = bank->target;
@@ -572,7 +553,6 @@ static int str7x_write(struct flash_bank *bank, uint8_t *buffer,
        uint32_t cmd;
        int retval;
        uint32_t check_address = offset;
-       int i;
 
        if (bank->target->state != TARGET_HALTED) {
                LOG_ERROR("Target not halted");
@@ -584,7 +564,7 @@ static int str7x_write(struct flash_bank *bank, uint8_t *buffer,
                return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
        }
 
-       for (i = 0; i < bank->num_sectors; i++) {
+       for (unsigned int i = 0; i < bank->num_sectors; i++) {
                uint32_t sec_start = bank->sectors[i].offset;
                uint32_t sec_end = sec_start + bank->sectors[i].size;
 
@@ -708,15 +688,15 @@ COMMAND_HANDLER(str7x_handle_part_id_command)
 }
 #endif
 
-static int get_str7x_info(struct flash_bank *bank, char *buf, int buf_size)
+static int get_str7x_info(struct flash_bank *bank, struct command_invocation *cmd)
 {
-       snprintf(buf, buf_size, "str7x flash driver info");
-       /* STR7x flash doesn't support sector protection interrogation.
-        * FLASH_NVWPAR acts as a write only register; its read value
-        * doesn't reflect the actual protection state of the sectors.
+       /* Setting the write protection on a sector is a permanent change but it
+        * can be disabled temporarily. FLASH_NVWPAR reflects the permanent
+        * protection state of the sectors, not the temporary.
         */
-       LOG_WARNING("STR7x flash lock information might not be correct "
-                       "due to hardware limitations.");
+       command_print_sameline(cmd, "STR7x flash protection info is only valid after a power cycle, "
+                       "clearing the protection is only temporary and may not be reflected in the current "
+                       "info returned.");
        return ERROR_OK;
 }
 
@@ -726,15 +706,15 @@ COMMAND_HANDLER(str7x_handle_disable_jtag_command)
        struct str7x_flash_bank *str7x_info = NULL;
 
        uint32_t flash_cmd;
-       uint16_t ProtectionLevel = 0;
-       uint16_t ProtectionRegs;
+       uint16_t protection_level = 0;
+       uint16_t protection_regs;
 
        if (CMD_ARGC < 1)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
        struct flash_bank *bank;
        int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
-       if (ERROR_OK != retval)
+       if (retval != ERROR_OK)
                return retval;
 
        str7x_info = bank->driver_priv;
@@ -751,17 +731,17 @@ COMMAND_HANDLER(str7x_handle_disable_jtag_command)
        target_read_u32(target, str7x_get_flash_adr(bank, FLASH_NVAPR0), &reg);
 
        if (!(reg & str7x_info->disable_bit))
-               ProtectionLevel = 1;
+               protection_level = 1;
 
        target_read_u32(target, str7x_get_flash_adr(bank, FLASH_NVAPR1), &reg);
-       ProtectionRegs = ~(reg >> 16);
+       protection_regs = ~(reg >> 16);
 
-       while (((ProtectionRegs) != 0) && (ProtectionLevel < 16)) {
-               ProtectionRegs >>= 1;
-               ProtectionLevel++;
+       while (((protection_regs) != 0) && (protection_level < 16)) {
+               protection_regs >>= 1;
+               protection_level++;
        }
 
-       if (ProtectionLevel == 0) {
+       if (protection_level == 0) {
                flash_cmd = FLASH_SPR;
                target_write_u32(target, str7x_get_flash_adr(bank, FLASH_CR0), flash_cmd);
                target_write_u32(target, str7x_get_flash_adr(bank, FLASH_AR), 0x4010DFB8);
@@ -773,7 +753,7 @@ COMMAND_HANDLER(str7x_handle_disable_jtag_command)
                target_write_u32(target, str7x_get_flash_adr(bank, FLASH_CR0), flash_cmd);
                target_write_u32(target, str7x_get_flash_adr(bank, FLASH_AR), 0x4010DFBC);
                target_write_u32(target, str7x_get_flash_adr(bank, FLASH_DR0),
-                               ~(1 << (15 + ProtectionLevel)));
+                               ~(1 << (15 + protection_level)));
                flash_cmd = FLASH_SPR | FLASH_WMS;
                target_write_u32(target, str7x_get_flash_adr(bank, FLASH_CR0), flash_cmd);
        }
@@ -803,7 +783,7 @@ static const struct command_registration str7x_command_handlers[] = {
        COMMAND_REGISTRATION_DONE
 };
 
-struct flash_driver str7x_flash = {
+const struct flash_driver str7x_flash = {
        .name = "str7x",
        .commands = str7x_command_handlers,
        .flash_bank_command = str7x_flash_bank_command,
@@ -816,4 +796,5 @@ struct flash_driver str7x_flash = {
        .erase_check = default_flash_blank_check,
        .protect_check = str7x_protect_check,
        .info = get_str7x_info,
+       .free_driver_priv = default_flash_free_driver_priv,
 };