Change return value on error.

[openocd.git] / src / flash / nor / str9x.c

diff --git a/src/flash/nor/str9x.c b/src/flash/nor/str9x.c
index bf3f750f192dc956d9a584005a5bb65ff423ab44..5bea2068c523f95c30ff8bf3094e0bed7dc3882a 100644 (file)
--- a/src/flash/nor/str9x.c
+++ b/src/flash/nor/str9x.c
@@ -28,11 +28,45 @@
 #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;
+       struct working_area *write_algorithm;
+};
+
+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;
 
 static int str9x_build_block_list(struct flash_bank *bank)
@@ -124,8 +158,7 @@ FLASH_BANK_COMMAND_HANDLER(str9x_flash_bank_command)
 
        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));
@@ -223,6 +256,7 @@ static int str9x_erase(struct flash_bank *bank, int first, int last)
        uint32_t adr;
        uint8_t status;
        uint8_t erase_cmd;
+       int total_timeout;
 
        if (bank->target->state != TARGET_HALTED)
        {
@@ -230,24 +264,30 @@ static int str9x_erase(struct flash_bank *bank, int first, int last)
                return ERROR_TARGET_NOT_HALTED;
        }
 
-       /* Check if we erase whole bank */
+       /* Check if we can erase whole bank */
        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 */
+               total_timeout = 1000 * bank->num_sectors;
        }
        else
        {
                /* Erase sector command */
                erase_cmd = 0x20;
+               total_timeout = 1000;
        }
 
+       /* 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 */
+               /* erase sectors or block */
                if ((retval = target_write_u16(target, adr, erase_cmd)) != ERROR_OK)
                {
                        return retval;
@@ -264,7 +304,8 @@ static int str9x_erase(struct flash_bank *bank, int first, int last)
                }
 
                int timeout;
-               for (timeout = 0; timeout < 1000; timeout++) {
+               for (timeout = 0; timeout < total_timeout; timeout++) 
+               {
                        if ((retval = target_read_u8(target, adr, &status)) != ERROR_OK)
                        {
                                return retval;
@@ -273,7 +314,7 @@ static int str9x_erase(struct flash_bank *bank, int first, int last)
                                break;
                        alive_sleep(1);
                }
-               if (timeout == 1000)
+               if (timeout == total_timeout)
                {
                        LOG_ERROR("erase timed out");
                        return ERROR_FAIL;
@@ -352,14 +393,16 @@ static int str9x_write_block(struct flash_bank *bank,
 {
        struct str9x_flash_bank *str9x_info = bank->driver_priv;
        struct target *target = bank->target;
-       uint32_t buffer_size = 8192;
+       uint32_t buffer_size = 32768;
        struct working_area *source;
        uint32_t address = bank->base + offset;
        struct reg_param reg_params[4];
        struct arm_algorithm armv4_5_info;
        int retval = ERROR_OK;
 
-       uint32_t str9x_flash_write_code[] = {
+       /* see contib/loaders/flash/str9x.s for src */
+
+       static const uint32_t str9x_flash_write_code[] = {
                                        /* write:                               */
                0xe3c14003,     /*      bic     r4, r1, #3              */
                0xe3a03040,     /*      mov     r3, #0x40               */
@@ -381,25 +424,29 @@ static int str9x_write_block(struct flash_bank *bank,
                0xe2522001,     /*      subs r2, r2, #1         */
                0x1affffed,     /*      bne write                       */
                                        /* exit:                                */
-               0xeafffffe,     /*      b exit                          */
+               0xe1200070,     /*      bkpt #0                         */
        };
 
        /* flash write code */
-       if (target_alloc_working_area(target, 4 * 19, &str9x_info->write_algorithm) != ERROR_OK)
+       if (target_alloc_working_area(target, sizeof(str9x_flash_write_code),
+                       &str9x_info->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, 19 * 4, (uint8_t*)str9x_flash_write_code);
+       target_write_buffer(target, str9x_info->write_algorithm->address,
+                       sizeof(str9x_flash_write_code),
+                       (uint8_t*)str9x_flash_write_code);
 
        /* memory buffer */
-       while (target_alloc_working_area(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 buffer, free the algorithm */
+                       /* if 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);
 
@@ -427,7 +474,9 @@ 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, str9x_info->write_algorithm->address + (18 * 4), 10000, &armv4_5_info)) != ERROR_OK)
+               if ((retval = target_run_algorithm(target, 0, NULL, 4, reg_params,
+                               str9x_info->write_algorithm->address,
+                               0, 10000, &armv4_5_info)) != ERROR_OK)
                {
                        LOG_ERROR("error executing str9x flash write algorithm");
                        retval = ERROR_FLASH_OPERATION_FAILED;
@@ -515,7 +564,7 @@ static int str9x_write(struct flash_bank *bank,
                        }
                        else if (retval == ERROR_FLASH_OPERATION_FAILED)
                        {
-                               LOG_ERROR("flash writing failed with error code: 0x%x", retval);
+                               LOG_ERROR("flash writing failed");
                                return ERROR_FLASH_OPERATION_FAILED;
                        }
                }
@@ -569,7 +618,7 @@ static int str9x_write(struct flash_bank *bank,
        if (bytes_remaining)
        {
                uint8_t last_halfword[2] = {0xff, 0xff};
-               int i = 0;
+               i = 0;
 
                while (bytes_remaining > 0)
                {
@@ -626,7 +675,7 @@ COMMAND_HANDLER(str9x_handle_part_id_command)
 }
 #endif
 
-static int str9x_info(struct flash_bank *bank, char *buf, int buf_size)
+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;
@@ -634,7 +683,6 @@ static int str9x_info(struct flash_bank *bank, char *buf, int buf_size)
 
 COMMAND_HANDLER(str9x_handle_flash_config_command)
 {
-       struct str9x_flash_bank *str9x_info;
        struct target *target = NULL;
 
        if (CMD_ARGC < 5)
@@ -653,8 +701,6 @@ 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)
@@ -680,7 +726,7 @@ COMMAND_HANDLER(str9x_handle_flash_config_command)
 static const struct command_registration str9x_config_command_handlers[] = {
        {
                .name = "flash_config",
-               .handler = &str9x_handle_flash_config_command,
+               .handler = str9x_handle_flash_config_command,
                .mode = COMMAND_EXEC,
                .help = "Configure str9x flash controller, prior to "
                        "programming the flash.",
@@ -688,6 +734,7 @@ static const struct command_registration str9x_config_command_handlers[] = {
        },
        COMMAND_REGISTRATION_DONE
 };
+
 static const struct command_registration str9x_command_handlers[] = {
        {
                .name = "str9x",
@@ -699,15 +746,16 @@ static const struct command_registration str9x_command_handlers[] = {
 };
 
 struct flash_driver str9x_flash = {
-               .name = "str9x",
-               .commands = str9x_command_handlers,
-               .flash_bank_command = &str9x_flash_bank_command,
-               .erase = &str9x_erase,
-               .protect = &str9x_protect,
-               .write = &str9x_write,
-               .probe = &str9x_probe,
-               .auto_probe = &str9x_probe,
-               .erase_check = &default_flash_blank_check,
-               .protect_check = &str9x_protect_check,
-               .info = &str9x_info,
-       };
+       .name = "str9x",
+       .commands = str9x_command_handlers,
+       .flash_bank_command = str9x_flash_bank_command,
+       .erase = str9x_erase,
+       .protect = str9x_protect,
+       .write = str9x_write,
+       .read = default_flash_read,
+       .probe = str9x_probe,
+       .auto_probe = str9x_probe,
+       .erase_check = default_flash_blank_check,
+       .protect_check = str9x_protect_check,
+       .info = get_str9x_info,
+};