NOR/CFI: identify memory accesses not using "bus_width".
[openocd.git] / src / flash / nor / cfi.c
index 5f7ed1e2ee4823f8ae8673e94da2b68f1c2779fd..ca2fb0bb8df717c4a5fed746e9d14a41e57b0f4e 100644 (file)
@@ -3,6 +3,7 @@
  *   Dominic.Rath@gmx.de                                                   *
  *   Copyright (C) 2009 Michael Schwingen                                  *
  *   michael@schwingen.org                                                 *
+ *   Copyright (C) 2010 Ã˜yvind 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  *
@@ -56,6 +57,7 @@ static const struct cfi_fixup cfi_0002_fixups[] = {
        {CFI_MFR_SST, 0x00D7, cfi_fixup_0002_unlock_addresses, &cfi_unlock_addresses[CFI_UNLOCK_5555_2AAA]},
        {CFI_MFR_SST, 0x2780, cfi_fixup_0002_unlock_addresses, &cfi_unlock_addresses[CFI_UNLOCK_5555_2AAA]},
        {CFI_MFR_ATMEL, 0x00C8, cfi_fixup_atmel_reversed_erase_regions, NULL},
+   {CFI_MFR_FUJITSU, 0x22ea, cfi_fixup_0002_unlock_addresses, &cfi_unlock_addresses[CFI_UNLOCK_555_2AA]},
        {CFI_MFR_FUJITSU, 0x226b, cfi_fixup_0002_unlock_addresses, &cfi_unlock_addresses[CFI_UNLOCK_5555_2AAA]},
        {CFI_MFR_AMIC, 0xb31a, cfi_fixup_0002_unlock_addresses, &cfi_unlock_addresses[CFI_UNLOCK_555_2AA]},
        {CFI_MFR_MX, 0x225b, cfi_fixup_0002_unlock_addresses, &cfi_unlock_addresses[CFI_UNLOCK_555_2AA]},
@@ -103,7 +105,6 @@ static __inline__ uint32_t flash_address(struct flash_bank *bank, int sector, ui
                }
                return bank->base + bank->sectors[sector].offset + offset * bank->bus_width;
        }
-
 }
 
 static void cfi_command(struct flash_bank *bank, uint8_t cmd, uint8_t *cmd_buf)
@@ -231,6 +232,35 @@ static uint32_t cfi_query_u32(struct flash_bank *bank, int sector, uint32_t offs
                                data[(3 * bank->bus_width) - 1] << 16 | data[(4 * bank->bus_width) - 1] << 24;
 }
 
+static int cfi_reset(struct flash_bank *bank)
+{
+       struct cfi_flash_bank *cfi_info = bank->driver_priv;
+       int retval = ERROR_OK;
+
+       if ((retval = cfi_send_command(bank, 0xf0, flash_address(bank, 0, 0x0))) != ERROR_OK)
+       {
+               return retval;
+       }
+
+       if ((retval = cfi_send_command(bank, 0xff, flash_address(bank, 0, 0x0))) != ERROR_OK)
+       {
+               return retval;
+       }
+
+       if (cfi_info->manufacturer == 0x20 &&
+                       (cfi_info->device_id == 0x227E || cfi_info->device_id == 0x7E))
+       {
+               /* Numonix M29W128G is cmd 0xFF intolerant - causes internal undefined state
+                * so we send an extra 0xF0 reset to fix the bug */
+               if ((retval = cfi_send_command(bank, 0xf0, flash_address(bank, 0, 0x00))) != ERROR_OK)
+               {
+                       return retval;
+               }
+       }
+
+       return retval;
+}
+
 static void cfi_intel_clear_status_register(struct flash_bank *bank)
 {
        struct target *target = bank->target;
@@ -244,7 +274,7 @@ static void cfi_intel_clear_status_register(struct flash_bank *bank)
        cfi_send_command(bank, 0x50, flash_address(bank, 0, 0x0));
 }
 
-uint8_t cfi_intel_wait_status_busy(struct flash_bank *bank, int timeout)
+static uint8_t cfi_intel_wait_status_busy(struct flash_bank *bank, int timeout)
 {
        uint8_t status;
 
@@ -285,7 +315,7 @@ uint8_t cfi_intel_wait_status_busy(struct flash_bank *bank, int timeout)
        return status;
 }
 
-int cfi_spansion_wait_status_busy(struct flash_bank *bank, int timeout)
+static int cfi_spansion_wait_status_busy(struct flash_bank *bank, int timeout)
 {
        uint8_t status, oldstatus;
        struct cfi_flash_bank *cfi_info = bank->driver_priv;
@@ -334,11 +364,7 @@ static int cfi_read_intel_pri_ext(struct flash_bank *bank)
 
        if ((pri_ext->pri[0] != 'P') || (pri_ext->pri[1] != 'R') || (pri_ext->pri[2] != 'I'))
        {
-               if ((retval = cfi_send_command(bank, 0xf0, flash_address(bank, 0, 0x0))) != ERROR_OK)
-               {
-                       return retval;
-               }
-               if ((retval = cfi_send_command(bank, 0xff, flash_address(bank, 0, 0x0))) != ERROR_OK)
+               if ((retval = cfi_reset(bank)) != ERROR_OK)
                {
                        return retval;
                }
@@ -598,12 +624,18 @@ FLASH_BANK_COMMAND_HANDLER(cfi_flash_bank_command)
                return ERROR_FLASH_BANK_INVALID;
        }
 
-       uint16_t chip_width, bus_width;
-       COMMAND_PARSE_NUMBER(u16, CMD_ARGV[3], bus_width);
-       COMMAND_PARSE_NUMBER(u16, CMD_ARGV[4], chip_width);
-
-       if ((chip_width > CFI_MAX_CHIP_WIDTH)
-                       || (bus_width > CFI_MAX_BUS_WIDTH))
+       /* both widths must:
+        * - not exceed max value;
+        * - not be null;
+        * - be equal to a power of 2.
+        * bus must be wide enought to hold one chip */
+       if ((bank->chip_width > CFI_MAX_CHIP_WIDTH)
+                       || (bank->bus_width > CFI_MAX_BUS_WIDTH)
+                       || (bank->chip_width == 0)
+                       || (bank->bus_width == 0)
+                       || (bank->chip_width & (bank->chip_width - 1))
+                       || (bank->bus_width & (bank->bus_width - 1))
+                       || (bank->chip_width > bank->bus_width))
        {
                LOG_ERROR("chip and bus width have to specified in bytes");
                return ERROR_FLASH_BANK_INVALID;
@@ -855,6 +887,17 @@ static int cfi_intel_protect(struct flash_bank *bank, int set, int first, int la
         */
        if ((!set) && (!(pri_ext->feature_support & 0x20)))
        {
+               /* FIX!!! this code path is broken!!!
+                *
+                * The correct approach is:
+                *
+                * 1. read out current protection status
+                *
+                * 2. override read out protection status w/unprotected.
+                *
+                * 3. re-protect what should be protected.
+                *
+                */
                for (i = 0; i < bank->num_sectors; i++)
                {
                        if (bank->sectors[i].is_protected == 1)
@@ -891,6 +934,7 @@ static int cfi_protect(struct flash_bank *bank, int set, int first, int last)
 
        if ((first < 0) || (last < first) || (last >= bank->num_sectors))
        {
+               LOG_ERROR("Invalid sector range");
                return ERROR_FLASH_SECTOR_INVALID;
        }
 
@@ -901,14 +945,12 @@ static int cfi_protect(struct flash_bank *bank, int set, int first, int last)
        {
                case 1:
                case 3:
-                       cfi_intel_protect(bank, set, first, last);
+                       return cfi_intel_protect(bank, set, first, last);
                        break;
                default:
                        LOG_ERROR("protect: cfi primary command set %i unsupported", cfi_info->pri_id);
-                       break;
+                       return ERROR_FAIL;
        }
-
-       return ERROR_OK;
 }
 
 /* FIXME Replace this by a simple memcpy() - still unsure about sideeffects */
@@ -1120,7 +1162,7 @@ static int cfi_intel_write_block(struct flash_bank *bank, uint8_t *buffer, uint3
        /* Get a workspace buffer for the data to flash starting with 32k size.
           Half size until buffer would be smaller 256 Bytem then fail back */
        /* FIXME Why 256 bytes, why not 32 bytes (smallest flash write page */
-       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)
@@ -1145,7 +1187,7 @@ static int cfi_intel_write_block(struct flash_bank *bank, uint8_t *buffer, uint3
        busy_pattern_val  = cfi_command_val(bank, 0x80);
        error_pattern_val = cfi_command_val(bank, 0x7e);
 
-       LOG_INFO("Using target buffer at 0x%08" PRIx32 " and of size 0x%04" PRIx32, source->address, buffer_size);
+       LOG_DEBUG("Using target buffer at 0x%08" PRIx32 " and of size 0x%04" PRIx32, source->address, buffer_size);
 
        /* Programming main loop */
        while (count > 0)
@@ -1166,7 +1208,7 @@ static int cfi_intel_write_block(struct flash_bank *bank, uint8_t *buffer, uint3
                buf_set_u32(reg_params[5].value, 0, 32, busy_pattern_val);
                buf_set_u32(reg_params[6].value, 0, 32, error_pattern_val);
 
-               LOG_INFO("Write 0x%04" PRIx32 " bytes to flash at 0x%08" PRIx32 , thisrun_count, address);
+               LOG_DEBUG("Write 0x%04" PRIx32 " bytes to flash at 0x%08" PRIx32 , thisrun_count, address);
 
                /* Execute algorithm, assume breakpoint for last instruction */
                retval = target_run_algorithm(target, 0, NULL, 7, reg_params,
@@ -1448,7 +1490,7 @@ static int cfi_spansion_write_block(struct flash_bank *bank, uint8_t *buffer, ui
        }
        /* the following code still assumes target code is fixed 24*4 bytes */
 
-       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)
@@ -1562,9 +1604,11 @@ static int cfi_intel_write_words(struct flash_bank *bank, uint8_t *word, uint32_
        struct target *target = bank->target;
 
        /* Calculate buffer size and boundary mask */
+       /* buffersize is (buffer size per chip) * (number of chips) */
+       /* bufferwsize is buffersize in words */
        uint32_t buffersize = (1UL << cfi_info->max_buf_write_size) * (bank->bus_width / bank->chip_width);
        uint32_t buffermask = buffersize-1;
-       uint32_t bufferwsize;
+       uint32_t bufferwsize = buffersize / bank->bus_width;
 
        /* Check for valid range */
        if (address & buffermask)
@@ -1573,18 +1617,6 @@ static int cfi_intel_write_words(struct flash_bank *bank, uint8_t *word, uint32_
                          bank->base, address, cfi_info->max_buf_write_size);
                return ERROR_FLASH_OPERATION_FAILED;
        }
-       switch (bank->chip_width)
-       {
-       case 4 : bufferwsize = buffersize / 4; break;
-       case 2 : bufferwsize = buffersize / 2; break;
-       case 1 : bufferwsize = buffersize; break;
-       default:
-               LOG_ERROR("Unsupported chip width %d", bank->chip_width);
-               return ERROR_FLASH_OPERATION_FAILED;
-       }
-
-       bufferwsize/=(bank->bus_width / bank->chip_width);
-
 
        /* Check for valid size */
        if (wordcount > bufferwsize)
@@ -1691,9 +1723,11 @@ static int cfi_spansion_write_words(struct flash_bank *bank, uint8_t *word, uint
        struct cfi_spansion_pri_ext *pri_ext = cfi_info->pri_ext;
 
        /* Calculate buffer size and boundary mask */
+       /* buffersize is (buffer size per chip) * (number of chips) */
+       /* bufferwsize is buffersize in words */
        uint32_t buffersize = (1UL << cfi_info->max_buf_write_size) * (bank->bus_width / bank->chip_width);
        uint32_t buffermask = buffersize-1;
-       uint32_t bufferwsize;
+       uint32_t bufferwsize = buffersize / bank->bus_width;
 
        /* Check for valid range */
        if (address & buffermask)
@@ -1701,17 +1735,6 @@ static int cfi_spansion_write_words(struct flash_bank *bank, uint8_t *word, uint
                LOG_ERROR("Write address at base 0x%" PRIx32 ", address %" PRIx32 " not aligned to 2^%d boundary", bank->base, address, cfi_info->max_buf_write_size);
                return ERROR_FLASH_OPERATION_FAILED;
        }
-       switch (bank->chip_width)
-       {
-       case 4 : bufferwsize = buffersize / 4; break;
-       case 2 : bufferwsize = buffersize / 2; break;
-       case 1 : bufferwsize = buffersize; break;
-       default:
-               LOG_ERROR("Unsupported chip width %d", bank->chip_width);
-               return ERROR_FLASH_OPERATION_FAILED;
-       }
-
-       bufferwsize/=(bank->bus_width / bank->chip_width);
 
        /* Check for valid size */
        if (wordcount > bufferwsize)
@@ -1810,7 +1833,7 @@ static int cfi_write_words(struct flash_bank *bank, uint8_t *word, uint32_t word
        return ERROR_FLASH_OPERATION_FAILED;
 }
 
-int cfi_write(struct flash_bank *bank, uint8_t *buffer, uint32_t offset, uint32_t count)
+static int cfi_write(struct flash_bank *bank, uint8_t *buffer, uint32_t offset, uint32_t count)
 {
        struct cfi_flash_bank *cfi_info = bank->driver_priv;
        struct target *target = bank->target;
@@ -1848,6 +1871,7 @@ int cfi_write(struct flash_bank *bank, uint8_t *buffer, uint32_t offset, uint32_
                for (i = 0; i < align; ++i, ++copy_p)
                {
                        uint8_t byte;
+                       /* FIXME: access flash at bus_width size */
                        if ((retval = target_read_memory(target, copy_p, 1, 1, &byte)) != ERROR_OK)
                        {
                                return retval;
@@ -1867,6 +1891,7 @@ int cfi_write(struct flash_bank *bank, uint8_t *buffer, uint32_t offset, uint32_
                for (; (count == 0) && (i < bank->bus_width); ++i, ++copy_p)
                {
                        uint8_t byte;
+                       /* FIXME: access flash at bus_width size */
                        if ((retval = target_read_memory(target, copy_p, 1, 1, &byte)) != ERROR_OK)
                        {
                                return retval;
@@ -1908,22 +1933,12 @@ int cfi_write(struct flash_bank *bank, uint8_t *buffer, uint32_t offset, uint32_
        {
                if (retval == ERROR_TARGET_RESOURCE_NOT_AVAILABLE)
                {
-                       //adjust buffersize for chip width
+                       /* Calculate buffer size and boundary mask */
+                       /* buffersize is (buffer size per chip) * (number of chips) */
+                       /* bufferwsize is buffersize in words */
                        uint32_t buffersize = (1UL << cfi_info->max_buf_write_size) * (bank->bus_width / bank->chip_width);
                        uint32_t buffermask = buffersize-1;
-                       uint32_t bufferwsize;
-
-                       switch (bank->chip_width)
-                       {
-                       case 4 : bufferwsize = buffersize / 4; break;
-                       case 2 : bufferwsize = buffersize / 2; break;
-                       case 1 : bufferwsize = buffersize; break;
-                       default:
-                               LOG_ERROR("Unsupported chip width %d", bank->chip_width);
-                               return ERROR_FLASH_OPERATION_FAILED;
-                       }
-
-                       bufferwsize/=(bank->bus_width / bank->chip_width);
+                       uint32_t bufferwsize = buffersize / bank->bus_width;
 
                        /* fall back to memory writes */
                        while (count >= (uint32_t)bank->bus_width)
@@ -1970,11 +1985,7 @@ int cfi_write(struct flash_bank *bank, uint8_t *buffer, uint32_t offset, uint32_
        }
 
        /* return to read array mode, so we can read from flash again for padding */
-       if ((retval = cfi_send_command(bank, 0xf0, flash_address(bank, 0, 0x0))) != ERROR_OK)
-       {
-               return retval;
-       }
-       if ((retval = cfi_send_command(bank, 0xff, flash_address(bank, 0, 0x0))) != ERROR_OK)
+       if ((retval = cfi_reset(bank)) != ERROR_OK)
        {
                return retval;
        }
@@ -1996,6 +2007,7 @@ int cfi_write(struct flash_bank *bank, uint8_t *buffer, uint32_t offset, uint32_
                for (; i < bank->bus_width; ++i, ++copy_p)
                {
                        uint8_t byte;
+                       /* FIXME: access flash at bus_width size */
                        if ((retval = target_read_memory(target, copy_p, 1, 1, &byte)) != ERROR_OK)
                        {
                                return retval;
@@ -2008,11 +2020,7 @@ int cfi_write(struct flash_bank *bank, uint8_t *buffer, uint32_t offset, uint32_
        }
 
        /* return to read array mode */
-       if ((retval = cfi_send_command(bank, 0xf0, flash_address(bank, 0, 0x0))) != ERROR_OK)
-       {
-               return retval;
-       }
-       return cfi_send_command(bank, 0xff, flash_address(bank, 0, 0x0));
+       return cfi_reset(bank);
 }
 
 static void cfi_fixup_atmel_reversed_erase_regions(struct flash_bank *bank, void *param)
@@ -2076,11 +2084,7 @@ static int cfi_query_string(struct flash_bank *bank, int address)
 
        if ((cfi_info->qry[0] != 'Q') || (cfi_info->qry[1] != 'R') || (cfi_info->qry[2] != 'Y'))
        {
-               if ((retval = cfi_send_command(bank, 0xf0, flash_address(bank, 0, 0x0))) != ERROR_OK)
-               {
-                       return retval;
-               }
-               if ((retval = cfi_send_command(bank, 0xff, flash_address(bank, 0, 0x0))) != ERROR_OK)
+               if ((retval = cfi_reset(bank)) != ERROR_OK)
                {
                        return retval;
                }
@@ -2136,10 +2140,12 @@ static int cfi_probe(struct flash_bank *bank)
        if (bank->chip_width == 1)
        {
                uint8_t manufacturer, device_id;
+               /* FIXME: access flash at bus_width size */
                if ((retval = target_read_u8(target, flash_address(bank, 0, 0x00), &manufacturer)) != ERROR_OK)
                {
                        return retval;
                }
+               /* FIXME: access flash at bus_width size */
                if ((retval = target_read_u8(target, flash_address(bank, 0, 0x01), &device_id)) != ERROR_OK)
                {
                        return retval;
@@ -2149,10 +2155,12 @@ static int cfi_probe(struct flash_bank *bank)
        }
        else if (bank->chip_width == 2)
        {
+               /* FIXME: access flash at bus_width size */
                if ((retval = target_read_u16(target, flash_address(bank, 0, 0x00), &cfi_info->manufacturer)) != ERROR_OK)
                {
                        return retval;
                }
+               /* FIXME: access flash at bus_width size */
                if ((retval = target_read_u16(target, flash_address(bank, 0, 0x01), &cfi_info->device_id)) != ERROR_OK)
                {
                        return retval;
@@ -2161,11 +2169,7 @@ static int cfi_probe(struct flash_bank *bank)
 
        LOG_INFO("Flash Manufacturer/Device: 0x%04x 0x%04x", cfi_info->manufacturer, cfi_info->device_id);
        /* switch back to read array mode */
-       if ((retval = cfi_send_command(bank, 0xf0, flash_address(bank, 0, 0x00))) != ERROR_OK)
-       {
-               return retval;
-       }
-       if ((retval = cfi_send_command(bank, 0xff, flash_address(bank, 0, 0x00))) != ERROR_OK)
+       if ((retval = cfi_reset(bank)) != ERROR_OK)
        {
                return retval;
        }
@@ -2282,11 +2286,7 @@ static int cfi_probe(struct flash_bank *bank)
                /* return to read array mode
                 * we use both reset commands, as some Intel flashes fail to recognize the 0xF0 command
                 */
-               if ((retval = cfi_send_command(bank, 0xf0, flash_address(bank, 0, 0x0))) != ERROR_OK)
-               {
-                       return retval;
-               }
-               if ((retval = cfi_send_command(bank, 0xff, flash_address(bank, 0, 0x0))) != ERROR_OK)
+               if ((retval = cfi_reset(bank)) != ERROR_OK)
                {
                        return retval;
                }
@@ -2370,7 +2370,6 @@ static int cfi_auto_probe(struct flash_bank *bank)
        return cfi_probe(bank);
 }
 
-
 static int cfi_intel_protect_check(struct flash_bank *bank)
 {
        int retval;
@@ -2551,6 +2550,7 @@ struct flash_driver cfi_flash = {
        .write = cfi_write,
        .probe = cfi_probe,
        .auto_probe = cfi_auto_probe,
+       /* FIXME: access flash at bus_width size */
        .erase_check = default_flash_blank_check,
        .protect_check = cfi_protect_check,
        .info = cfi_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)