openocd: fix SPDX tag format for files .c
[fw/openocd] / src / flash / nor / aduc702x.c
index dce6a5e4e5762ff72169c927ef5e57757cb53009..ea7f5e3730da685db96ded5182e07e7a440c7873 100644 (file)
@@ -1,22 +1,9 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+
 /***************************************************************************
  *   Copyright (C) 2008 by Kevin McGuire                                   *
  *   Copyright (C) 2008 by Marcel Wijlaars                                 *
  *   Copyright (C) 2009 by Michael Ashton                                  *
- *                                                                         *
- *   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
@@ -33,31 +20,22 @@ static int aduc702x_build_sector_list(struct flash_bank *bank);
 static int aduc702x_check_flash_completion(struct target *target, unsigned int timeout_ms);
 static int aduc702x_set_write_enable(struct target *target, int enable);
 
-#define ADUC702x_FLASH                          0xfffff800
-#define ADUC702x_FLASH_FEESTA           (0*4)
-#define ADUC702x_FLASH_FEEMOD           (1*4)
-#define ADUC702x_FLASH_FEECON           (2*4)
-#define ADUC702x_FLASH_FEEDAT           (3*4)
-#define ADUC702x_FLASH_FEEADR           (4*4)
-#define ADUC702x_FLASH_FEESIGN          (5*4)
-#define ADUC702x_FLASH_FEEPRO           (6*4)
-#define ADUC702x_FLASH_FEEHIDE          (7*4)
-
-struct aduc702x_flash_bank {
-       struct working_area *write_algorithm;
-};
+#define ADUC702X_FLASH                          0xfffff800
+#define ADUC702X_FLASH_FEESTA           (0*4)
+#define ADUC702X_FLASH_FEEMOD           (1*4)
+#define ADUC702X_FLASH_FEECON           (2*4)
+#define ADUC702X_FLASH_FEEDAT           (3*4)
+#define ADUC702X_FLASH_FEEADR           (4*4)
+#define ADUC702X_FLASH_FEESIGN          (5*4)
+#define ADUC702X_FLASH_FEEPRO           (6*4)
+#define ADUC702X_FLASH_FEEHIDE          (7*4)
 
 /* flash bank aduc702x 0 0 0 0 <target#>
  * The ADC7019-28 devices all have the same flash layout */
 FLASH_BANK_COMMAND_HANDLER(aduc702x_flash_bank_command)
 {
-       struct aduc702x_flash_bank *nbank;
-
-       nbank = malloc(sizeof(struct aduc702x_flash_bank));
-
        bank->base = 0x80000;
        bank->size = 0xF800;    /* top 4k not accessible */
-       bank->driver_priv = nbank;
 
        aduc702x_build_sector_list(bank);
 
@@ -68,13 +46,12 @@ static int aduc702x_build_sector_list(struct flash_bank *bank)
 {
        /* aduc7026_struct flash_bank *aduc7026_info = bank->driver_priv; */
 
-       int i = 0;
        uint32_t offset = 0;
 
        /* sector size is 512 */
        bank->num_sectors = bank->size / 512;
        bank->sectors = malloc(sizeof(struct flash_sector) * bank->num_sectors);
-       for (i = 0; i < bank->num_sectors; ++i) {
+       for (unsigned int i = 0; i < bank->num_sectors; ++i) {
                bank->sectors[i].offset = offset;
                bank->sectors[i].size = 512;
                offset += bank->sectors[i].size;
@@ -85,13 +62,8 @@ static int aduc702x_build_sector_list(struct flash_bank *bank)
        return ERROR_OK;
 }
 
-static int aduc702x_protect_check(struct flash_bank *bank)
-{
-       printf("aduc702x_protect_check not implemented yet.\n");
-       return ERROR_OK;
-}
-
-static int aduc702x_erase(struct flash_bank *bank, int first, int last)
+static int aduc702x_erase(struct flash_bank *bank, unsigned int first,
+               unsigned int last)
 {
        /* int res; */
        int x;
@@ -104,9 +76,9 @@ static int aduc702x_erase(struct flash_bank *bank, int first, int last)
        /* mass erase */
        if (((first | last) == 0) || ((first == 0) && (last >= bank->num_sectors))) {
                LOG_DEBUG("performing mass erase.");
-               target_write_u16(target, ADUC702x_FLASH + ADUC702x_FLASH_FEEDAT, 0x3cff);
-               target_write_u16(target, ADUC702x_FLASH + ADUC702x_FLASH_FEEADR, 0xffc3);
-               target_write_u8(target, ADUC702x_FLASH + ADUC702x_FLASH_FEECON, 0x06);
+               target_write_u16(target, ADUC702X_FLASH + ADUC702X_FLASH_FEEDAT, 0x3cff);
+               target_write_u16(target, ADUC702X_FLASH + ADUC702X_FLASH_FEEADR, 0xffc3);
+               target_write_u8(target, ADUC702X_FLASH + ADUC702X_FLASH_FEECON, 0x06);
 
                if (aduc702x_check_flash_completion(target, 3500) != ERROR_OK) {
                        LOG_ERROR("mass erase failed");
@@ -123,8 +95,8 @@ static int aduc702x_erase(struct flash_bank *bank, int first, int last)
                for (x = 0; x < count; ++x) {
                        adr = bank->base + ((first + x) * 512);
 
-                       target_write_u16(target, ADUC702x_FLASH + ADUC702x_FLASH_FEEADR, adr);
-                       target_write_u8(target, ADUC702x_FLASH + ADUC702x_FLASH_FEECON, 0x05);
+                       target_write_u16(target, ADUC702X_FLASH + ADUC702X_FLASH_FEEADR, adr);
+                       target_write_u8(target, ADUC702X_FLASH + ADUC702X_FLASH_FEECON, 0x05);
 
                        if (aduc702x_check_flash_completion(target, 50) != ERROR_OK) {
                                LOG_ERROR("failed to erase sector at address 0x%08lX", adr);
@@ -141,25 +113,19 @@ static int aduc702x_erase(struct flash_bank *bank, int first, int last)
        return ERROR_OK;
 }
 
-static int aduc702x_protect(struct flash_bank *bank, int set, int first, int last)
-{
-       printf("aduc702x_protect not implemented yet.\n");
-       return ERROR_FLASH_OPERATION_FAILED;
-}
-
 /* If this fn returns ERROR_TARGET_RESOURCE_NOT_AVAILABLE, then the caller can fall
  * back to another mechanism that does not require onboard RAM
  *
  * Caller should not check for other return values specifically
  */
 static int aduc702x_write_block(struct flash_bank *bank,
-       uint8_t *buffer,
+       const uint8_t *buffer,
        uint32_t offset,
        uint32_t count)
 {
-       struct aduc702x_flash_bank *aduc702x_info = bank->driver_priv;
        struct target *target = bank->target;
        uint32_t buffer_size = 7000;
+       struct working_area *write_algorithm;
        struct working_area *source;
        uint32_t address = bank->base + offset;
        struct reg_param reg_params[6];
@@ -210,13 +176,15 @@ static int aduc702x_write_block(struct flash_bank *bank,
 
        /* flash write code */
        if (target_alloc_working_area(target, sizeof(aduc702x_flash_write_code),
-                       &aduc702x_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;
        }
 
-       retval = target_write_buffer(target, aduc702x_info->write_algorithm->address,
-                       sizeof(aduc702x_flash_write_code), (uint8_t *)aduc702x_flash_write_code);
+       uint8_t code[sizeof(aduc702x_flash_write_code)];
+       target_buffer_set_u32_array(target, code, ARRAY_SIZE(aduc702x_flash_write_code),
+                       aduc702x_flash_write_code);
+       retval = target_write_buffer(target, write_algorithm->address, sizeof(code), code);
        if (retval != ERROR_OK)
                return retval;
 
@@ -224,10 +192,9 @@ static int aduc702x_write_block(struct flash_bank *bank,
        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 buffer,
+                       /* we already allocated the writing code, but failed to get a buffer,
                         *free the algorithm */
-                       if (aduc702x_info->write_algorithm)
-                               target_free_working_area(target, aduc702x_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;
@@ -257,8 +224,8 @@ static int aduc702x_write_block(struct flash_bank *bank,
                buf_set_u32(reg_params[4].value, 0, 32, 0xFFFFF800);
 
                retval = target_run_algorithm(target, 0, NULL, 5,
-                               reg_params, aduc702x_info->write_algorithm->address,
-                               aduc702x_info->write_algorithm->address +
+                               reg_params, write_algorithm->address,
+                               write_algorithm->address +
                                sizeof(aduc702x_flash_write_code) - 4,
                                10000, &arm_algo);
                if (retval != ERROR_OK) {
@@ -279,7 +246,7 @@ static int aduc702x_write_block(struct flash_bank *bank,
        }
 
        target_free_working_area(target, source);
-       target_free_working_area(target, aduc702x_info->write_algorithm);
+       target_free_working_area(target, write_algorithm);
 
        destroy_reg_param(&reg_params[0]);
        destroy_reg_param(&reg_params[1]);
@@ -293,7 +260,7 @@ static int aduc702x_write_block(struct flash_bank *bank,
 /* All-JTAG, single-access method.  Very slow.  Used only if there is no
  * working area available. */
 static int aduc702x_write_single(struct flash_bank *bank,
-       uint8_t *buffer,
+       const uint8_t *buffer,
        uint32_t offset,
        uint32_t count)
 {
@@ -305,7 +272,7 @@ static int aduc702x_write_single(struct flash_bank *bank,
 
        for (x = 0; x < count; x += 2) {
                /* FEEADR = address */
-               target_write_u16(target, ADUC702x_FLASH + ADUC702x_FLASH_FEEADR, offset + x);
+               target_write_u16(target, ADUC702X_FLASH + ADUC702X_FLASH_FEEADR, offset + x);
 
                /* set up data */
                if ((x + 1) == count) {
@@ -314,10 +281,10 @@ static int aduc702x_write_single(struct flash_bank *bank,
                } else
                        b = buffer[x + 1];
 
-               target_write_u16(target, ADUC702x_FLASH + ADUC702x_FLASH_FEEDAT, buffer[x] | (b << 8));
+               target_write_u16(target, ADUC702X_FLASH + ADUC702X_FLASH_FEEDAT, buffer[x] | (b << 8));
 
                /* do single-write command */
-               target_write_u8(target, ADUC702x_FLASH + ADUC702x_FLASH_FEECON, 0x02);
+               target_write_u8(target, ADUC702X_FLASH + ADUC702X_FLASH_FEECON, 0x02);
 
                if (aduc702x_check_flash_completion(target, 1) != ERROR_OK) {
                        LOG_ERROR("single write failed for address 0x%08lX",
@@ -334,7 +301,7 @@ static int aduc702x_write_single(struct flash_bank *bank,
        return ERROR_OK;
 }
 
-static int aduc702x_write(struct flash_bank *bank, uint8_t *buffer, uint32_t offset, uint32_t count)
+static int aduc702x_write(struct flash_bank *bank, const uint8_t *buffer, uint32_t offset, uint32_t count)
 {
        int retval;
 
@@ -362,18 +329,12 @@ static int aduc702x_probe(struct flash_bank *bank)
        return ERROR_OK;
 }
 
-static int aduc702x_info(struct flash_bank *bank, char *buf, int buf_size)
-{
-       snprintf(buf, buf_size, "aduc702x flash driver info");
-       return ERROR_OK;
-}
-
 /* sets FEEMOD bit 3
  * enable = 1 enables writes & erases, 0 disables them */
 static int aduc702x_set_write_enable(struct target *target, int enable)
 {
        /* don't bother to preserve int enable bit here */
-       target_write_u16(target, ADUC702x_FLASH + ADUC702x_FLASH_FEEMOD, enable ? 8 : 0);
+       target_write_u16(target, ADUC702X_FLASH + ADUC702X_FLASH_FEEMOD, enable ? 8 : 0);
 
        return ERROR_OK;
 }
@@ -387,9 +348,9 @@ static int aduc702x_check_flash_completion(struct target *target, unsigned int t
 {
        uint8_t v = 4;
 
-       long long endtime = timeval_ms() + timeout_ms;
+       int64_t endtime = timeval_ms() + timeout_ms;
        while (1) {
-               target_read_u8(target, ADUC702x_FLASH + ADUC702x_FLASH_FEESTA, &v);
+               target_read_u8(target, ADUC702X_FLASH + ADUC702X_FLASH_FEESTA, &v);
                if ((v & 4) == 0)
                        break;
                alive_sleep(1);
@@ -406,16 +367,13 @@ static int aduc702x_check_flash_completion(struct target *target, unsigned int t
                return ERROR_OK;
 }
 
-struct flash_driver aduc702x_flash = {
+const struct flash_driver aduc702x_flash = {
        .name = "aduc702x",
        .flash_bank_command = aduc702x_flash_bank_command,
        .erase = aduc702x_erase,
-       .protect = aduc702x_protect,
        .write = aduc702x_write,
        .read = default_flash_read,
        .probe = aduc702x_probe,
        .auto_probe = aduc702x_probe,
        .erase_check = default_flash_blank_check,
-       .protect_check = aduc702x_protect_check,
-       .info = aduc702x_info
 };