str9x: Fix byte order bug
[openocd.git] / src / flash / nor / str9x.c
index 1e71753e67edc5110100dc6af989ba438886b79a..2158622a10016c80a7e945a6ff01bafaa8228706 100644 (file)
  *   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.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
  ***************************************************************************/
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 
 #include "imp.h"
-#include "str9x.h"
 #include <target/arm966e.h>
 #include <target/algorithm.h>
 
+/* Flash registers */
+
+#define FLASH_BBSR             0x54000000              /* Boot Bank Size Register                */
+#define FLASH_NBBSR            0x54000004              /* Non-Boot Bank Size Register            */
+#define FLASH_BBADR            0x5400000C              /* Boot Bank Base Address Register        */
+#define FLASH_NBBADR   0x54000010              /* Non-Boot Bank Base Address Register    */
+#define FLASH_CR               0x54000018              /* Control Register                       */
+#define FLASH_SR               0x5400001C              /* Status Register                        */
+#define FLASH_BCE5ADDR 0x54000020              /* BC Fifth Entry Target Address Register */
+
+struct str9x_flash_bank {
+       uint32_t *sector_bits;
+       int variant;
+       int bank1;
+};
+
+enum str9x_status_codes {
+       STR9X_CMD_SUCCESS = 0,
+       STR9X_INVALID_COMMAND = 1,
+       STR9X_SRC_ADDR_ERROR = 2,
+       STR9X_DST_ADDR_ERROR = 3,
+       STR9X_SRC_ADDR_NOT_MAPPED = 4,
+       STR9X_DST_ADDR_NOT_MAPPED = 5,
+       STR9X_COUNT_ERROR = 6,
+       STR9X_INVALID_SECTOR = 7,
+       STR9X_SECTOR_NOT_BLANK = 8,
+       STR9X_SECTOR_NOT_PREPARED = 9,
+       STR9X_COMPARE_ERROR = 10,
+       STR9X_BUSY = 11
+};
 
 static uint32_t bank1start = 0x00080000;
 
@@ -48,8 +78,7 @@ static int str9x_build_block_list(struct flash_bank *bank)
        str9x_info->variant = 0;
        str9x_info->bank1 = 0;
 
-       switch (bank->size)
-       {
+       switch (bank->size) {
                case (256 * 1024):
                        b0_sectors = 4;
                        break;
@@ -90,8 +119,7 @@ static int str9x_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 = offset;
                bank->sectors[num_sectors].size = 0x10000;
                offset += bank->sectors[i].size;
@@ -100,8 +128,7 @@ static int str9x_build_block_list(struct flash_bank *bank)
                str9x_info->sector_bits[num_sectors++] = (1 << i);
        }
 
-       for (i = 0; i < b1_sectors; i++)
-       {
+       for (i = 0; i < b1_sectors; i++) {
                bank->sectors[num_sectors].offset = offset;
                bank->sectors[num_sectors].size = str9x_info->variant == 0 ? 0x2000 : 0x4000;
                offset += bank->sectors[i].size;
@@ -123,18 +150,13 @@ FLASH_BANK_COMMAND_HANDLER(str9x_flash_bank_command)
        struct str9x_flash_bank *str9x_info;
 
        if (CMD_ARGC < 6)
-       {
-               LOG_WARNING("incomplete flash_bank str9x configuration");
-               return ERROR_FLASH_BANK_INVALID;
-       }
+               return ERROR_COMMAND_SYNTAX_ERROR;
 
        str9x_info = malloc(sizeof(struct str9x_flash_bank));
        bank->driver_priv = str9x_info;
 
        str9x_build_block_list(bank);
 
-       str9x_info->write_algorithm = NULL;
-
        return ERROR_OK;
 }
 
@@ -149,64 +171,49 @@ static int str9x_protect_check(struct flash_bank *bank)
        uint32_t status = 0;
        uint16_t hstatus = 0;
 
-       if (bank->target->state != TARGET_HALTED)
-       {
+       if (bank->target->state != TARGET_HALTED) {
                LOG_ERROR("Target not halted");
                return ERROR_TARGET_NOT_HALTED;
        }
 
        /* read level one protection */
 
-       if (str9x_info->variant)
-       {
-               if (str9x_info->bank1)
-               {
+       if (str9x_info->variant) {
+               if (str9x_info->bank1) {
                        adr = bank1start + 0x18;
-                       if ((retval = target_write_u16(target, adr, 0x90)) != ERROR_OK)
-                       {
+                       retval = target_write_u16(target, adr, 0x90);
+                       if (retval != ERROR_OK)
                                return retval;
-                       }
-                       if ((retval = target_read_u16(target, adr, &hstatus)) != ERROR_OK)
-                       {
+                       retval = target_read_u16(target, adr, &hstatus);
+                       if (retval != ERROR_OK)
                                return retval;
-                       }
                        status = hstatus;
-               }
-               else
-               {
+               } else {
                        adr = bank1start + 0x14;
-                       if ((retval = target_write_u16(target, adr, 0x90)) != ERROR_OK)
-                       {
+                       retval = target_write_u16(target, adr, 0x90);
+                       if (retval != ERROR_OK)
                                return retval;
-                       }
-                       if ((retval = target_read_u32(target, adr, &status)) != ERROR_OK)
-                       {
+                       retval = target_read_u32(target, adr, &status);
+                       if (retval != ERROR_OK)
                                return retval;
-                       }
                }
-       }
-       else
-       {
+       } else {
                adr = bank1start + 0x10;
-               if ((retval = target_write_u16(target, adr, 0x90)) != ERROR_OK)
-               {
+               retval = target_write_u16(target, adr, 0x90);
+               if (retval != ERROR_OK)
                        return retval;
-               }
-               if ((retval = target_read_u16(target, adr, &hstatus)) != ERROR_OK)
-               {
+               retval = target_read_u16(target, adr, &hstatus);
+               if (retval != ERROR_OK)
                        return retval;
-               }
                status = hstatus;
        }
 
        /* read array command */
-       if ((retval = target_write_u16(target, adr, 0xFF)) != ERROR_OK)
-       {
+       retval = target_write_u16(target, adr, 0xFF);
+       if (retval != ERROR_OK)
                return retval;
-       }
 
-       for (i = 0; i < bank->num_sectors; i++)
-       {
+       for (i = 0; i < bank->num_sectors; i++) {
                if (status & str9x_info->sector_bits[i])
                        bank->sectors[i].is_protected = 1;
                else
@@ -225,79 +232,68 @@ static int str9x_erase(struct flash_bank *bank, int first, int last)
        uint8_t erase_cmd;
        int total_timeout;
 
-       if (bank->target->state != TARGET_HALTED)
-       {
+       if (bank->target->state != TARGET_HALTED) {
                LOG_ERROR("Target not halted");
                return ERROR_TARGET_NOT_HALTED;
        }
 
        /* Check if we can erase whole bank */
-       if ((first == 0) && (last == (bank->num_sectors - 1)))
-       {
+       if ((first == 0) && (last == (bank->num_sectors - 1))) {
                /* Optimize to run erase bank command instead of sector */
                erase_cmd = 0x80;
-                /* Add timeout duration since erase bank takes more time */
+               /* Add timeout duration since erase bank takes more time */
                total_timeout = 1000 * bank->num_sectors;
-       }
-       else
-       {
+       } else {
                /* Erase sector command */
                erase_cmd = 0x20;
                total_timeout = 1000;
        }
 
-       for (i = first; i <= last; i++)
-       {
+       /* this is so the compiler can *know* */
+       assert(total_timeout > 0);
+
+       for (i = first; i <= last; i++) {
                int retval;
                adr = bank->base + bank->sectors[i].offset;
 
                /* erase sectors or block */
-               if ((retval = target_write_u16(target, adr, erase_cmd)) != ERROR_OK)
-               {
+               retval = target_write_u16(target, adr, erase_cmd);
+               if (retval != ERROR_OK)
                        return retval;
-               }
-               if ((retval = target_write_u16(target, adr, 0xD0)) != ERROR_OK)
-               {
+               retval = target_write_u16(target, adr, 0xD0);
+               if (retval != ERROR_OK)
                        return retval;
-               }
 
                /* get status */
-               if ((retval = target_write_u16(target, adr, 0x70)) != ERROR_OK)
-               {
+               retval = target_write_u16(target, adr, 0x70);
+               if (retval != ERROR_OK)
                        return retval;
-               }
 
                int timeout;
-               for (timeout = 0; timeout < total_timeout; timeout++) 
-               {
-                       if ((retval = target_read_u8(target, adr, &status)) != ERROR_OK)
-                       {
+               for (timeout = 0; timeout < total_timeout; timeout++) {
+                       retval = target_read_u8(target, adr, &status);
+                       if (retval != ERROR_OK)
                                return retval;
-                       }
                        if (status & 0x80)
                                break;
                        alive_sleep(1);
                }
-               if (timeout == total_timeout)
-               {
+               if (timeout == total_timeout) {
                        LOG_ERROR("erase timed out");
                        return ERROR_FAIL;
                }
 
                /* clear status, also clear read array */
-               if ((retval = target_write_u16(target, adr, 0x50)) != ERROR_OK)
-               {
+               retval = target_write_u16(target, adr, 0x50);
+               if (retval != ERROR_OK)
                        return retval;
-               }
 
                /* read array command */
-               if ((retval = target_write_u16(target, adr, 0xFF)) != ERROR_OK)
-               {
+               retval = target_write_u16(target, adr, 0xFF);
+               if (retval != ERROR_OK)
                        return retval;
-               }
 
-               if (status & 0x22)
-               {
+               if (status & 0x22) {
                        LOG_ERROR("error erasing flash bank, status: 0x%x", status);
                        return ERROR_FLASH_OPERATION_FAILED;
                }
@@ -321,14 +317,12 @@ static int str9x_protect(struct flash_bank *bank,
        uint32_t adr;
        uint8_t status;
 
-       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 (i = first; i <= last; i++) {
                /* Level One Protection */
 
                adr = bank->base + bank->sectors[i].offset;
@@ -355,13 +349,13 @@ 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)
 {
-       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 */
@@ -393,43 +387,39 @@ 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)
-       {
+       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 (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);
        init_reg_param(&reg_params[2], "r2", 32, PARAM_OUT);
        init_reg_param(&reg_params[3], "r3", 32, PARAM_IN);
 
-       while (count > 0)
-       {
+       while (count > 0) {
                uint32_t thisrun_count = (count > (buffer_size / 2)) ? (buffer_size / 2) : count;
 
                target_write_buffer(target, source->address, thisrun_count * 2, buffer);
@@ -438,17 +428,16 @@ static int str9x_write_block(struct flash_bank *bank,
                buf_set_u32(reg_params[1].value, 0, 32, address);
                buf_set_u32(reg_params[2].value, 0, 32, thisrun_count);
 
-               if ((retval = target_run_algorithm(target, 0, NULL, 4, reg_params,
-                               str9x_info->write_algorithm->address,
-                               0, 10000, &armv4_5_info)) != ERROR_OK)
-               {
+               retval = target_run_algorithm(target, 0, NULL, 4, reg_params,
+                               write_algorithm->address,
+                               0, 10000, &arm_algo);
+               if (retval != ERROR_OK) {
                        LOG_ERROR("error executing str9x flash write algorithm");
                        retval = ERROR_FLASH_OPERATION_FAILED;
                        break;
                }
 
-               if (buf_get_u32(reg_params[3].value, 0, 32) != 0x80)
-               {
+               if (buf_get_u32(reg_params[3].value, 0, 32) != 0x80) {
                        retval = ERROR_FLASH_OPERATION_FAILED;
                        break;
                }
@@ -459,7 +448,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]);
@@ -483,26 +472,22 @@ static int str9x_write(struct flash_bank *bank,
        uint32_t bank_adr;
        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 & 0x1)
-       {
+       if (offset & 0x1) {
                LOG_WARNING("offset 0x%" PRIx32 " breaks required 2-byte alignment", offset);
                return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
        }
 
-       for (i = 0; i < bank->num_sectors; i++)
-       {
+       for (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;
@@ -515,33 +500,26 @@ static int str9x_write(struct flash_bank *bank,
                return ERROR_FLASH_DST_OUT_OF_BANK;
 
        /* multiple half words (2-byte) to be programmed? */
-       if (words_remaining > 0)
-       {
+       if (words_remaining > 0) {
                /* try using a block write */
-               if ((retval = str9x_write_block(bank, buffer, offset, words_remaining)) != ERROR_OK)
-               {
-                       if (retval == ERROR_TARGET_RESOURCE_NOT_AVAILABLE)
-                       {
+               retval = str9x_write_block(bank, buffer, offset, words_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)
-                       {
-                               LOG_ERROR("flash writing failed with error code: 0x%x", retval);
+                       } else if (retval == ERROR_FLASH_OPERATION_FAILED) {
+                               LOG_ERROR("flash writing failed");
                                return ERROR_FLASH_OPERATION_FAILED;
                        }
-               }
-               else
-               {
+               } else {
                        buffer += words_remaining * 2;
                        address += words_remaining * 2;
                        words_remaining = 0;
                }
        }
 
-       while (words_remaining > 0)
-       {
+       while (words_remaining > 0) {
                bank_adr = address & ~0x03;
 
                /* write data command */
@@ -552,15 +530,13 @@ static int str9x_write(struct flash_bank *bank,
                target_write_u16(target, bank_adr, 0x70);
 
                int timeout;
-               for (timeout = 0; timeout < 1000; timeout++)
-               {
+               for (timeout = 0; timeout < 1000; timeout++) {
                        target_read_u8(target, bank_adr, &status);
                        if (status & 0x80)
                                break;
                        alive_sleep(1);
                }
-               if (timeout == 1000)
-               {
+               if (timeout == 1000) {
                        LOG_ERROR("write timed out");
                        return ERROR_FAIL;
                }
@@ -579,17 +555,11 @@ static int str9x_write(struct flash_bank *bank,
                address += 2;
        }
 
-       if (bytes_remaining)
-       {
+       if (bytes_remaining) {
                uint8_t last_halfword[2] = {0xff, 0xff};
-               i = 0;
 
-               while (bytes_remaining > 0)
-               {
-                       last_halfword[i++] = *(buffer + bytes_written);
-                       bytes_remaining--;
-                       bytes_written++;
-               }
+               /* copy the last remaining bytes into the write buffer */
+               memcpy(last_halfword, buffer+bytes_written, bytes_remaining);
 
                bank_adr = address & ~0x03;
 
@@ -601,15 +571,13 @@ static int str9x_write(struct flash_bank *bank,
                target_write_u16(target, bank_adr, 0x70);
 
                int timeout;
-               for (timeout = 0; timeout < 1000; timeout++)
-               {
+               for (timeout = 0; timeout < 1000; timeout++) {
                        target_read_u8(target, bank_adr, &status);
                        if (status & 0x80)
                                break;
                        alive_sleep(1);
                }
-               if (timeout == 1000)
-               {
+               if (timeout == 1000) {
                        LOG_ERROR("write timed out");
                        return ERROR_FAIL;
                }
@@ -639,21 +607,12 @@ 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 str9x_flash_bank *str9x_info;
        struct target *target = NULL;
 
        if (CMD_ARGC < 5)
-       {
                return ERROR_COMMAND_SYNTAX_ERROR;
-       }
 
        struct flash_bank *bank;
        int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
@@ -666,12 +625,9 @@ COMMAND_HANDLER(str9x_handle_flash_config_command)
        COMMAND_PARSE_NUMBER(u32, CMD_ARGV[3], bbadr);
        COMMAND_PARSE_NUMBER(u32, CMD_ARGV[4], nbbadr);
 
-       str9x_info = bank->driver_priv;
-
        target = bank->target;
 
-       if (bank->target->state != TARGET_HALTED)
-       {
+       if (bank->target->state != TARGET_HALTED) {
                LOG_ERROR("Target not halted");
                return ERROR_TARGET_NOT_HALTED;
        }
@@ -707,6 +663,7 @@ static const struct command_registration str9x_command_handlers[] = {
                .name = "str9x",
                .mode = COMMAND_ANY,
                .help = "str9x flash command group",
+               .usage = "",
                .chain = str9x_config_command_handlers,
        },
        COMMAND_REGISTRATION_DONE
@@ -724,5 +681,4 @@ struct flash_driver str9x_flash = {
        .auto_probe = str9x_probe,
        .erase_check = default_flash_blank_check,
        .protect_check = str9x_protect_check,
-       .info = get_str9x_info,
 };

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)