openocd: fix SPDX tag format for files .c
[fw/openocd] / src / flash / nor / str9x.c
index 472f922c1f703c75a0a90ebaa25f86440a242e5f..1a26b839e9aa063f90da653cfbaccae3ad67ecd0 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) 2008 by Oyvind 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
@@ -46,7 +33,6 @@ struct str9x_flash_bank {
        uint32_t *sector_bits;
        int variant;
        int bank1;
-       struct working_area *write_algorithm;
 };
 
 enum str9x_status_codes {
@@ -71,7 +57,7 @@ static int str9x_build_block_list(struct flash_bank *bank)
        struct str9x_flash_bank *str9x_info = bank->driver_priv;
 
        int i;
-       int num_sectors;
+       unsigned int num_sectors;
        int b0_sectors = 0, b1_sectors = 0;
        uint32_t offset = 0;
 
@@ -158,8 +144,6 @@ FLASH_BANK_COMMAND_HANDLER(str9x_flash_bank_command)
 
        str9x_build_block_list(bank);
 
-       str9x_info->write_algorithm = NULL;
-
        return ERROR_OK;
 }
 
@@ -169,7 +153,6 @@ static int str9x_protect_check(struct flash_bank *bank)
        struct str9x_flash_bank *str9x_info = bank->driver_priv;
        struct target *target = bank->target;
 
-       int i;
        uint32_t adr;
        uint32_t status = 0;
        uint16_t hstatus = 0;
@@ -216,7 +199,7 @@ static int str9x_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 (status & str9x_info->sector_bits[i])
                        bank->sectors[i].is_protected = 1;
                else
@@ -226,10 +209,10 @@ static int str9x_protect_check(struct flash_bank *bank)
        return ERROR_OK;
 }
 
-static int str9x_erase(struct flash_bank *bank, int first, int last)
+static int str9x_erase(struct flash_bank *bank, unsigned int first,
+               unsigned int last)
 {
        struct target *target = bank->target;
-       int i;
        uint32_t adr;
        uint8_t status;
        uint8_t erase_cmd;
@@ -255,7 +238,7 @@ static int str9x_erase(struct flash_bank *bank, int first, int last)
        /* this is so the compiler can *know* */
        assert(total_timeout > 0);
 
-       for (i = first; i <= last; i++) {
+       for (unsigned int i = first; i <= last; i++) {
                int retval;
                adr = bank->base + bank->sectors[i].offset;
 
@@ -306,17 +289,13 @@ static int str9x_erase(struct flash_bank *bank, int first, int last)
                        break;
        }
 
-       for (i = first; i <= last; i++)
-               bank->sectors[i].is_erased = 1;
-
        return ERROR_OK;
 }
 
-static int str9x_protect(struct flash_bank *bank,
-               int set, int first, int last)
+static int str9x_protect(struct flash_bank *bank, int set, unsigned int first,
+               unsigned int last)
 {
        struct target *target = bank->target;
-       int i;
        uint32_t adr;
        uint8_t status;
 
@@ -325,7 +304,7 @@ static int str9x_protect(struct flash_bank *bank,
                return ERROR_TARGET_NOT_HALTED;
        }
 
-       for (i = first; i <= last; i++) {
+       for (unsigned int i = first; i <= last; i++) {
                /* Level One Protection */
 
                adr = bank->base + bank->sectors[i].offset;
@@ -350,18 +329,18 @@ static int str9x_protect(struct flash_bank *bank,
 }
 
 static int str9x_write_block(struct flash_bank *bank,
-               uint8_t *buffer, uint32_t offset, uint32_t count)
+               const uint8_t *buffer, uint32_t offset, uint32_t count)
 {
-       struct str9x_flash_bank *str9x_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[4];
-       struct arm_algorithm armv4_5_info;
+       struct arm_algorithm arm_algo;
        int retval = ERROR_OK;
 
-       /* see contib/loaders/flash/str9x.s for src */
+       /* see contrib/loaders/flash/str9x.s for src */
 
        static const uint32_t str9x_flash_write_code[] = {
                                        /* write:                               */
@@ -390,32 +369,32 @@ static int str9x_write_block(struct flash_bank *bank,
 
        /* flash write code */
        if (target_alloc_working_area(target, sizeof(str9x_flash_write_code),
-                       &str9x_info->write_algorithm) != ERROR_OK) {
+                       &write_algorithm) != ERROR_OK) {
                LOG_WARNING("no working area available, can't do block memory writes");
                return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
-       };
+       }
 
-       target_write_buffer(target, str9x_info->write_algorithm->address,
-                       sizeof(str9x_flash_write_code),
-                       (uint8_t *)str9x_flash_write_code);
+       uint8_t code[sizeof(str9x_flash_write_code)];
+       target_buffer_set_u32_array(target, code, ARRAY_SIZE(str9x_flash_write_code),
+                       str9x_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 (str9x_info->write_algorithm)
-                               target_free_working_area(target, str9x_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);
@@ -432,8 +411,8 @@ static int str9x_write_block(struct flash_bank *bank,
                buf_set_u32(reg_params[2].value, 0, 32, thisrun_count);
 
                retval = target_run_algorithm(target, 0, NULL, 4, reg_params,
-                               str9x_info->write_algorithm->address,
-                               0, 10000, &armv4_5_info);
+                               write_algorithm->address,
+                               0, 10000, &arm_algo);
                if (retval != ERROR_OK) {
                        LOG_ERROR("error executing str9x flash write algorithm");
                        retval = ERROR_FLASH_OPERATION_FAILED;
@@ -451,7 +430,7 @@ static int str9x_write_block(struct flash_bank *bank,
        }
 
        target_free_working_area(target, source);
-       target_free_working_area(target, str9x_info->write_algorithm);
+       target_free_working_area(target, write_algorithm);
 
        destroy_reg_param(&reg_params[0]);
        destroy_reg_param(&reg_params[1]);
@@ -462,7 +441,7 @@ static int str9x_write_block(struct flash_bank *bank,
 }
 
 static int str9x_write(struct flash_bank *bank,
-               uint8_t *buffer, uint32_t offset, uint32_t count)
+               const uint8_t *buffer, uint32_t offset, uint32_t count)
 {
        struct target *target = bank->target;
        uint32_t words_remaining = (count / 2);
@@ -473,7 +452,6 @@ static int str9x_write(struct flash_bank *bank,
        int retval;
        uint32_t check_address = offset;
        uint32_t bank_adr;
-       int i;
 
        if (bank->target->state != TARGET_HALTED) {
                LOG_ERROR("Target not halted");
@@ -485,7 +463,7 @@ static int str9x_write(struct flash_bank *bank,
                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;
 
@@ -610,12 +588,6 @@ COMMAND_HANDLER(str9x_handle_part_id_command)
 }
 #endif
 
-static int get_str9x_info(struct flash_bank *bank, char *buf, int buf_size)
-{
-       snprintf(buf, buf_size, "str9x flash driver info");
-       return ERROR_OK;
-}
-
 COMMAND_HANDLER(str9x_handle_flash_config_command)
 {
        struct target *target = NULL;
@@ -625,7 +597,7 @@ COMMAND_HANDLER(str9x_handle_flash_config_command)
 
        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;
 
        uint32_t bbsr, nbbsr, bbadr, nbbadr;
@@ -678,7 +650,7 @@ static const struct command_registration str9x_command_handlers[] = {
        COMMAND_REGISTRATION_DONE
 };
 
-struct flash_driver str9x_flash = {
+const struct flash_driver str9x_flash = {
        .name = "str9x",
        .commands = str9x_command_handlers,
        .flash_bank_command = str9x_flash_bank_command,
@@ -690,5 +662,5 @@ struct flash_driver str9x_flash = {
        .auto_probe = str9x_probe,
        .erase_check = default_flash_blank_check,
        .protect_check = str9x_protect_check,
-       .info = get_str9x_info,
+       .free_driver_priv = default_flash_free_driver_priv,
 };