openocd: fix SPDX tag format for files .c
[fw/openocd] / src / flash / nor / str7x.c
index adabad7db0c3c3705072994d2327f950ad049dd3..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                                                   *
  *   Copyright (C) 2008 by Spencer Oliver                                  *
  *   spen@spen-soft.co.uk                                                  *
  *                                                                         *
- *   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.             *
+ *   Copyright (C) 2010 Ã˜yvind Harboe                                      *
+ *   oyvind.harboe@zylin.com                                               *
  ***************************************************************************/
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 
 #include "imp.h"
-#include "str7x.h"
 #include <target/arm.h>
 #include <helper/binarybuffer.h>
 #include <target/algorithm.h>
 
+/*  Flash registers */
+
+#define FLASH_CR0              0x00000000
+#define FLASH_CR1              0x00000004
+#define FLASH_DR0              0x00000008
+#define FLASH_DR1              0x0000000C
+#define FLASH_AR               0x00000010
+#define FLASH_ER               0x00000014
+#define FLASH_NVWPAR   0x0000DFB0
+#define FLASH_NVAPR0   0x0000DFB8
+#define FLASH_NVAPR1   0x0000DFBC
+
+/* FLASH_CR0 register bits */
+
+#define FLASH_WMS              0x80000000
+#define FLASH_SUSP             0x40000000
+#define FLASH_WPG              0x20000000
+#define FLASH_DWPG             0x10000000
+#define FLASH_SER              0x08000000
+#define FLASH_SPR              0x01000000
+#define FLASH_BER              0x04000000
+#define FLASH_MER              0x02000000
+#define FLASH_LOCK             0x00000010
+#define FLASH_BSYA1            0x00000004
+#define FLASH_BSYA0            0x00000002
+
+/* FLASH_CR1 register bits */
+
+#define FLASH_B1S              0x02000000
+#define FLASH_B0S              0x01000000
+#define FLASH_B1F1             0x00020000
+#define FLASH_B1F0             0x00010000
+#define FLASH_B0F7             0x00000080
+#define FLASH_B0F6             0x00000040
+#define FLASH_B0F5             0x00000020
+#define FLASH_B0F4             0x00000010
+#define FLASH_B0F3             0x00000008
+#define FLASH_B0F2             0x00000004
+#define FLASH_B0F1             0x00000002
+#define FLASH_B0F0             0x00000001
+
+/* FLASH_ER register bits */
+
+#define FLASH_WPF              0x00000100
+#define FLASH_RESER            0x00000080
+#define FLASH_SEQER            0x00000040
+#define FLASH_10ER             0x00000008
+#define FLASH_PGER             0x00000004
+#define FLASH_ERER             0x00000002
+#define FLASH_ERR              0x00000001
+
+
+struct str7x_flash_bank {
+       uint32_t *sector_bits;
+       uint32_t disable_bit;
+       uint32_t busy_bits;
+       uint32_t register_base;
+};
+
+struct str7x_mem_layout {
+       uint32_t sector_start;
+       uint32_t sector_size;
+       uint32_t sector_bit;
+};
+
+enum str7x_status_codes {
+       STR7X_CMD_SUCCESS = 0,
+       STR7X_INVALID_COMMAND = 1,
+       STR7X_SRC_ADDR_ERROR = 2,
+       STR7X_DST_ADDR_ERROR = 3,
+       STR7X_SRC_ADDR_NOT_MAPPED = 4,
+       STR7X_DST_ADDR_NOT_MAPPED = 5,
+       STR7X_COUNT_ERROR = 6,
+       STR7X_INVALID_SECTOR = 7,
+       STR7X_SECTOR_NOT_BLANK = 8,
+       STR7X_SECTOR_NOT_PREPARED = 9,
+       STR7X_COMPARE_ERROR = 10,
+       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},
@@ -42,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}
 };
@@ -50,7 +119,7 @@ static struct str7x_mem_layout mem_layout_str7bank1[] = {
 static int str7x_get_flash_adr(struct flash_bank *bank, uint32_t reg)
 {
        struct str7x_flash_bank *str7x_info = bank->driver_priv;
-       return (str7x_info->register_base | reg);
+       return str7x_info->register_base | reg;
 }
 
 static int str7x_build_block_list(struct flash_bank *bank)
@@ -58,11 +127,10 @@ 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)
-       {
+       switch (bank->size) {
                case 16 * 1024:
                        b1_sectors = 2;
                        break;
@@ -88,8 +156,7 @@ static int str7x_build_block_list(struct flash_bank *bank)
 
        num_sectors = 0;
 
-       for (i = 0; i < b0_sectors; i++)
-       {
+       for (i = 0; i < b0_sectors; i++) {
                bank->sectors[num_sectors].offset = mem_layout_str7bank0[i].sector_start;
                bank->sectors[num_sectors].size = mem_layout_str7bank0[i].sector_size;
                bank->sectors[num_sectors].is_erased = -1;
@@ -100,8 +167,7 @@ static int str7x_build_block_list(struct flash_bank *bank)
                str7x_info->sector_bits[num_sectors++] = mem_layout_str7bank0[i].sector_bit;
        }
 
-       for (i = 0; i < b1_sectors; i++)
-       {
+       for (i = 0; i < b1_sectors; i++) {
                bank->sectors[num_sectors].offset = mem_layout_str7bank1[i].sector_start;
                bank->sectors[num_sectors].size = mem_layout_str7bank1[i].sector_size;
                bank->sectors[num_sectors].is_erased = -1;
@@ -122,10 +188,7 @@ FLASH_BANK_COMMAND_HANDLER(str7x_flash_bank_command)
        struct str7x_flash_bank *str7x_info;
 
        if (CMD_ARGC < 7)
-       {
-               LOG_WARNING("incomplete flash_bank str7x configuration");
-               return ERROR_FLASH_BANK_INVALID;
-       }
+               return ERROR_COMMAND_SYNTAX_ERROR;
 
        str7x_info = malloc(sizeof(struct str7x_flash_bank));
        bank->driver_priv = str7x_info;
@@ -135,21 +198,14 @@ FLASH_BANK_COMMAND_HANDLER(str7x_flash_bank_command)
        str7x_info->disable_bit = (1 << 1);
 
        if (strcmp(CMD_ARGV[6], "STR71x") == 0)
-       {
                str7x_info->register_base = 0x40100000;
-       }
-       else if (strcmp(CMD_ARGV[6], "STR73x") == 0)
-       {
+       else if (strcmp(CMD_ARGV[6], "STR73x") == 0) {
                str7x_info->register_base = 0x80100000;
                str7x_info->busy_bits = (FLASH_LOCK | FLASH_BSYA0);
-       }
-       else if (strcmp(CMD_ARGV[6], "STR75x") == 0)
-       {
+       } else if (strcmp(CMD_ARGV[6], "STR75x") == 0) {
                str7x_info->register_base = 0x20100000;
                str7x_info->disable_bit = (1 << 0);
-       }
-       else
-       {
+       } else {
                LOG_ERROR("unknown STR7x variant: '%s'", CMD_ARGV[6]);
                free(str7x_info);
                return ERROR_FLASH_BANK_INVALID;
@@ -157,27 +213,79 @@ FLASH_BANK_COMMAND_HANDLER(str7x_flash_bank_command)
 
        str7x_build_block_list(bank);
 
-       str7x_info->write_algorithm = NULL;
-
        return ERROR_OK;
 }
 
-static uint32_t str7x_status(struct flash_bank *bank)
+/* wait for flash to become idle or report errors.
+
+   FIX!!! what's the maximum timeout??? The documentation doesn't
+   state any maximum time.... by inspection it seems > 1000ms is to be
+   expected.
+
+   10000ms is long enough that it should cover anything, yet not
+   quite be equivalent to an infinite loop.
+
+ */
+static int str7x_waitbusy(struct flash_bank *bank)
 {
+       int err;
+       int i;
        struct target *target = bank->target;
-       uint32_t retval;
+       struct str7x_flash_bank *str7x_info = bank->driver_priv;
 
-       target_read_u32(target, str7x_get_flash_adr(bank, FLASH_CR0), &retval);
+       for (i = 0 ; i < 10000; i++) {
+               uint32_t retval;
+               err = target_read_u32(target, str7x_get_flash_adr(bank, FLASH_CR0), &retval);
+               if (err != ERROR_OK)
+                       return err;
 
-       return retval;
+               if ((retval & str7x_info->busy_bits) == 0)
+                       return ERROR_OK;
+
+               alive_sleep(1);
+       }
+       LOG_ERROR("Timed out waiting for str7x flash");
+       return ERROR_FAIL;
 }
 
-static uint32_t str7x_result(struct flash_bank *bank)
+
+static int str7x_result(struct flash_bank *bank)
 {
        struct target *target = bank->target;
-       uint32_t retval;
+       uint32_t flash_flags;
 
-       target_read_u32(target, str7x_get_flash_adr(bank, FLASH_ER), &retval);
+       int retval;
+       retval = target_read_u32(target, str7x_get_flash_adr(bank, FLASH_ER), &flash_flags);
+       if (retval != ERROR_OK)
+               return retval;
+
+       if (flash_flags & FLASH_WPF) {
+               LOG_ERROR("str7x hw write protection set");
+               retval = ERROR_FAIL;
+       }
+       if (flash_flags & FLASH_RESER) {
+               LOG_ERROR("str7x suspended program erase not resumed");
+               retval = ERROR_FAIL;
+       }
+       if (flash_flags & FLASH_10ER) {
+               LOG_ERROR("str7x trying to set bit to 1 when it is already 0");
+               retval = ERROR_FAIL;
+       }
+       if (flash_flags & FLASH_PGER) {
+               LOG_ERROR("str7x program error");
+               retval = ERROR_FAIL;
+       }
+       if (flash_flags & FLASH_ERER) {
+               LOG_ERROR("str7x erase error");
+               retval = ERROR_FAIL;
+       }
+       if (retval == ERROR_OK) {
+               if (flash_flags & FLASH_ERR) {
+                       /* this should always be set if one of the others are set... */
+                       LOG_ERROR("str7x write operation failed / bad setup");
+                       retval = ERROR_FAIL;
+               }
+       }
 
        return retval;
 }
@@ -187,20 +295,20 @@ 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 retval;
+       uint32_t flash_flags;
 
-       if (bank->target->state != TARGET_HALTED)
-       {
+       if (bank->target->state != TARGET_HALTED) {
                LOG_ERROR("Target not halted");
                return ERROR_TARGET_NOT_HALTED;
        }
 
-       target_read_u32(target, str7x_get_flash_adr(bank, FLASH_NVWPAR), &retval);
+       int retval;
+       retval = target_read_u32(target, str7x_get_flash_adr(bank, FLASH_NVWPAR), &flash_flags);
+       if (retval != ERROR_OK)
+               return retval;
 
-       for (i = 0; i < bank->num_sectors; i++)
-       {
-               if (retval & str7x_info->sector_bits[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
                        bank->sectors[i].is_protected = 1;
@@ -209,125 +317,129 @@ 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 retval;
        uint32_t sectors = 0;
+       int err;
 
-       if (bank->target->state != TARGET_HALTED)
-       {
+       if (bank->target->state != TARGET_HALTED) {
                LOG_ERROR("Target not halted");
                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);
 
        /* clear FLASH_ER register */
-       target_write_u32(target, str7x_get_flash_adr(bank, FLASH_ER), 0x0);
+       err = target_write_u32(target, str7x_get_flash_adr(bank, FLASH_ER), 0x0);
+       if (err != ERROR_OK)
+               return err;
 
        cmd = FLASH_SER;
-       target_write_u32(target, str7x_get_flash_adr(bank, FLASH_CR0), cmd);
+       err = target_write_u32(target, str7x_get_flash_adr(bank, FLASH_CR0), cmd);
+       if (err != ERROR_OK)
+               return err;
 
        cmd = sectors;
-       target_write_u32(target, str7x_get_flash_adr(bank, FLASH_CR1), cmd);
+       err = target_write_u32(target, str7x_get_flash_adr(bank, FLASH_CR1), cmd);
+       if (err != ERROR_OK)
+               return err;
 
        cmd = FLASH_SER | FLASH_WMS;
-       target_write_u32(target, str7x_get_flash_adr(bank, FLASH_CR0), cmd);
-
-       while (((retval = str7x_status(bank)) & str7x_info->busy_bits)) {
-               alive_sleep(1);
-       }
+       err = target_write_u32(target, str7x_get_flash_adr(bank, FLASH_CR0), cmd);
+       if (err != ERROR_OK)
+               return err;
 
-       retval = str7x_result(bank);
-
-       if (retval)
-       {
-               LOG_ERROR("error erasing flash bank, FLASH_ER: 0x%" PRIx32 "", retval);
-               return ERROR_FLASH_OPERATION_FAILED;
-       }
+       err = str7x_waitbusy(bank);
+       if (err != ERROR_OK)
+               return err;
 
-       for (i = first; i <= last; i++)
-               bank->sectors[i].is_erased = 1;
+       err = str7x_result(bank);
+       if (err != ERROR_OK)
+               return err;
 
        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 retval;
        uint32_t protect_blocks;
 
-       if (bank->target->state != TARGET_HALTED)
-       {
+       if (bank->target->state != TARGET_HALTED) {
                LOG_ERROR("Target not halted");
                return ERROR_TARGET_NOT_HALTED;
        }
 
        protect_blocks = 0xFFFFFFFF;
 
-       if (set)
-       {
-               for (i = first; i <= last; i++)
+       if (set) {
+               for (unsigned int i = first; i <= last; i++)
                        protect_blocks &= ~(str7x_info->sector_bits[i]);
        }
 
        /* clear FLASH_ER register */
-       target_write_u32(target, str7x_get_flash_adr(bank, FLASH_ER), 0x0);
+       int err;
+       err = target_write_u32(target, str7x_get_flash_adr(bank, FLASH_ER), 0x0);
+       if (err != ERROR_OK)
+               return err;
 
        cmd = FLASH_SPR;
-       target_write_u32(target, str7x_get_flash_adr(bank, FLASH_CR0), cmd);
+       err = target_write_u32(target, str7x_get_flash_adr(bank, FLASH_CR0), cmd);
+       if (err != ERROR_OK)
+               return err;
 
        cmd = str7x_get_flash_adr(bank, FLASH_NVWPAR);
-       target_write_u32(target, str7x_get_flash_adr(bank, FLASH_AR), cmd);
+       err = target_write_u32(target, str7x_get_flash_adr(bank, FLASH_AR), cmd);
+       if (err != ERROR_OK)
+               return err;
 
        cmd = protect_blocks;
-       target_write_u32(target, str7x_get_flash_adr(bank, FLASH_DR0), cmd);
+       err = target_write_u32(target, str7x_get_flash_adr(bank, FLASH_DR0), cmd);
+       if (err != ERROR_OK)
+               return err;
 
        cmd = FLASH_SPR | FLASH_WMS;
-       target_write_u32(target, str7x_get_flash_adr(bank, FLASH_CR0), cmd);
-
-       while (((retval = str7x_status(bank)) & str7x_info->busy_bits)) {
-               alive_sleep(1);
-       }
-
-       retval = str7x_result(bank);
+       err = target_write_u32(target, str7x_get_flash_adr(bank, FLASH_CR0), cmd);
+       if (err != ERROR_OK)
+               return err;
 
-       LOG_DEBUG("retval: 0x%8.8" PRIx32 "", retval);
+       err = str7x_waitbusy(bank);
+       if (err != ERROR_OK)
+               return err;
 
-       if (retval & FLASH_ERER)
-               return ERROR_FLASH_SECTOR_NOT_ERASED;
-       else if (retval & FLASH_WPF)
-               return ERROR_FLASH_OPERATION_FAILED;
+       err = str7x_result(bank);
+       if (err != ERROR_OK)
+               return err;
 
        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 contrib/loaders/flash/str7x.s for src */
+
        static const uint32_t str7x_flash_write_code[] = {
                                        /* write:                               */
                0xe3a04201, /*  mov r4, #0x10000000     */
@@ -339,7 +451,7 @@ static int str7x_write_block(struct flash_bank *bank, uint8_t *buffer,
                0xe582400c, /*  str r4, [r2, #0xc]      */
                0xe3a04209, /*  mov r4, #0x90000000     */
                0xe5824000, /*  str r4, [r2, #0x0]      */
-                           /* busy:                            */
+                                       /* busy:                                */
                0xe5924000, /*  ldr r4, [r2, #0x0]      */
                0xe1140005,     /*      tst r4, r5                      */
                0x1afffffc, /*  bne busy                        */
@@ -356,34 +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)
-       {
+       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
+               if (buffer_size <= 256) {
+                       /* 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);
@@ -392,8 +501,7 @@ static int str7x_write_block(struct flash_bank *bank, uint8_t *buffer,
        init_reg_param(&reg_params[4], "r4", 32, PARAM_IN);
        init_reg_param(&reg_params[5], "r5", 32, PARAM_OUT);
 
-       while (count > 0)
-       {
+       while (count > 0) {
                uint32_t thisrun_count = (count > (buffer_size / 8)) ? (buffer_size / 8) : count;
 
                target_write_buffer(target, source->address, thisrun_count * 8, buffer);
@@ -404,19 +512,15 @@ static int str7x_write_block(struct flash_bank *bank, uint8_t *buffer,
                buf_set_u32(reg_params[3].value, 0, 32, thisrun_count);
                buf_set_u32(reg_params[5].value, 0, 32, str7x_info->busy_bits);
 
-               if ((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)) != ERROR_OK)
-               {
-                       LOG_ERROR("error executing str7x flash write algorithm");
-                       retval = ERROR_FLASH_OPERATION_FAILED;
+               retval = target_run_algorithm(target, 0, NULL, 6, reg_params,
+                               write_algorithm->address,
+                               write_algorithm->address + (sizeof(str7x_flash_write_code) - 4),
+                               10000, &arm_algo);
+               if (retval != ERROR_OK)
                        break;
-               }
 
-               if (buf_get_u32(reg_params[4].value, 0, 32) != 0x00)
-               {
-                       retval = ERROR_FLASH_OPERATION_FAILED;
+               if (buf_get_u32(reg_params[4].value, 0, 32) != 0x00) {
+                       retval = str7x_result(bank);
                        break;
                }
 
@@ -426,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]);
@@ -438,11 +542,10 @@ 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;
-       struct str7x_flash_bank *str7x_info = bank->driver_priv;
        uint32_t dwords_remaining = (count / 8);
        uint32_t bytes_remaining = (count & 0x00000007);
        uint32_t address = bank->base + offset;
@@ -450,28 +553,23 @@ 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)
-       {
+       if (bank->target->state != TARGET_HALTED) {
                LOG_ERROR("Target not halted");
                return ERROR_TARGET_NOT_HALTED;
        }
 
-       if (offset & 0x7)
-       {
+       if (offset & 0x7) {
                LOG_WARNING("offset 0x%" PRIx32 " breaks required 8-byte alignment", offset);
                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;
 
                /* check if destination falls within the current sector */
-               if ((check_address >= sec_start) && (check_address < sec_end))
-               {
+               if ((check_address >= sec_start) && (check_address < sec_end)) {
                        /* check if destination ends in the current sector */
                        if (offset + count < sec_end)
                                check_address = offset + count;
@@ -487,41 +585,25 @@ static int str7x_write(struct flash_bank *bank, uint8_t *buffer,
        target_write_u32(target, str7x_get_flash_adr(bank, FLASH_ER), 0x0);
 
        /* multiple dwords (8-byte) to be programmed? */
-       if (dwords_remaining > 0)
-       {
+       if (dwords_remaining > 0) {
                /* try using a block write */
-               if ((retval = str7x_write_block(bank, buffer, offset,
-                               dwords_remaining)) != ERROR_OK)
-               {
-                       if (retval == ERROR_TARGET_RESOURCE_NOT_AVAILABLE)
-                       {
+               retval = str7x_write_block(bank, buffer, offset, dwords_remaining);
+               if (retval != ERROR_OK) {
+                       if (retval == ERROR_TARGET_RESOURCE_NOT_AVAILABLE) {
                                /* if block write failed (no sufficient working area),
                                 * we use normal (slow) single dword accesses */
                                LOG_WARNING("couldn't use block writes, falling back to single memory accesses");
-                       }
-                       else if (retval == ERROR_FLASH_OPERATION_FAILED)
-                       {
-                               /* if an error occured, we examine the reason, and quit */
-                               retval = str7x_result(bank);
-
-                               LOG_ERROR("flash writing failed with error code: 0x%x", retval);
-                               return ERROR_FLASH_OPERATION_FAILED;
-                       }
-                       else
-                       {
+                       } else {
                                return retval;
                        }
-               }
-               else
-               {
+               } else {
                        buffer += dwords_remaining * 8;
                        address += dwords_remaining * 8;
                        dwords_remaining = 0;
                }
        }
 
-       while (dwords_remaining > 0)
-       {
+       while (dwords_remaining > 0) {
                /* command */
                cmd = FLASH_DWPG;
                target_write_u32(target, str7x_get_flash_adr(bank, FLASH_CR0), cmd);
@@ -543,33 +625,24 @@ static int str7x_write(struct flash_bank *bank, uint8_t *buffer,
                cmd = FLASH_DWPG | FLASH_WMS;
                target_write_u32(target, str7x_get_flash_adr(bank, FLASH_CR0), cmd);
 
-               while (((retval = str7x_status(bank)) & str7x_info->busy_bits))
-               {
-                       alive_sleep(1);
-               }
-
-               retval = str7x_result(bank);
+               int err;
+               err = str7x_waitbusy(bank);
+               if (err != ERROR_OK)
+                       return err;
 
-               if (retval & FLASH_PGER)
-                       return ERROR_FLASH_OPERATION_FAILED;
-               else if (retval & FLASH_WPF)
-                       return ERROR_FLASH_OPERATION_FAILED;
+               err = str7x_result(bank);
+               if (err != ERROR_OK)
+                       return err;
 
                dwords_remaining--;
                address += 8;
        }
 
-       if (bytes_remaining)
-       {
+       if (bytes_remaining) {
                uint8_t last_dword[8] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff};
-               int i = 0;
 
-               while (bytes_remaining > 0)
-               {
-                       last_dword[i++] = *(buffer + bytes_written);
-                       bytes_remaining--;
-                       bytes_written++;
-               }
+               /* copy the last remaining bytes into the write buffer */
+               memcpy(last_dword, buffer+bytes_written, bytes_remaining);
 
                /* command */
                cmd = FLASH_DWPG;
@@ -581,28 +654,23 @@ static int str7x_write(struct flash_bank *bank, uint8_t *buffer,
                /* data word 1 */
                target_write_memory(target, str7x_get_flash_adr(bank, FLASH_DR0),
                                4, 1, last_dword);
-               bytes_written += 4;
 
                /* data word 2 */
                target_write_memory(target, str7x_get_flash_adr(bank, FLASH_DR1),
                                4, 1, last_dword + 4);
-               bytes_written += 4;
 
                /* start programming cycle */
                cmd = FLASH_DWPG | FLASH_WMS;
                target_write_u32(target, str7x_get_flash_adr(bank, FLASH_CR0), cmd);
 
-               while (((retval = str7x_status(bank)) & str7x_info->busy_bits))
-               {
-                       alive_sleep(1);
-               }
-
-               retval = str7x_result(bank);
+               int err;
+               err = str7x_waitbusy(bank);
+               if (err != ERROR_OK)
+                       return err;
 
-               if (retval & FLASH_PGER)
-                       return ERROR_FLASH_OPERATION_FAILED;
-               else if (retval & FLASH_WPF)
-                       return ERROR_FLASH_OPERATION_FAILED;
+               err = str7x_result(bank);
+               if (err != ERROR_OK)
+                       return err;
        }
 
        return ERROR_OK;
@@ -620,15 +688,15 @@ COMMAND_HANDLER(str7x_handle_part_id_command)
 }
 #endif
 
-static int 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;
 }
 
@@ -638,26 +706,22 @@ 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)
-       {
-               command_print(CMD_CTX, "str7x disable_jtag <bank>");
-               return ERROR_OK;
-       }
+               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;
 
        target = bank->target;
 
-       if (target->state != TARGET_HALTED)
-       {
+       if (target->state != TARGET_HALTED) {
                LOG_ERROR("Target not halted");
                return ERROR_TARGET_NOT_HALTED;
        }
@@ -667,35 +731,29 @@ 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);
                target_write_u32(target, str7x_get_flash_adr(bank, FLASH_DR0), 0xFFFFFFFD);
                flash_cmd = FLASH_SPR | FLASH_WMS;
                target_write_u32(target, str7x_get_flash_adr(bank, FLASH_CR0), flash_cmd);
-       }
-       else
-       {
+       } else {
                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), 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);
        }
@@ -706,6 +764,7 @@ COMMAND_HANDLER(str7x_handle_disable_jtag_command)
 static const struct command_registration str7x_exec_command_handlers[] = {
        {
                .name = "disable_jtag",
+               .usage = "<bank>",
                .handler = str7x_handle_disable_jtag_command,
                .mode = COMMAND_EXEC,
                .help = "disable jtag access",
@@ -718,21 +777,24 @@ static const struct command_registration str7x_command_handlers[] = {
                .name = "str7x",
                .mode = COMMAND_ANY,
                .help = "str7x flash command group",
+               .usage = "",
                .chain = str7x_exec_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,
        .erase = str7x_erase,
        .protect = str7x_protect,
        .write = str7x_write,
+       .read = default_flash_read,
        .probe = str7x_probe,
        .auto_probe = str7x_probe,
        .erase_check = default_flash_blank_check,
        .protect_check = str7x_protect_check,
-       .info = str7x_info,
+       .info = get_str7x_info,
+       .free_driver_priv = default_flash_free_driver_priv,
 };