nor: move in driver.h the flash_driver's declaration
[openocd.git] / src / flash / nor / stmqspi.c
index 8278601db2a104ea25faeea886a3cb4d2dc394d6..c9fc1bffa3f1004bf55e445e307915a3933f5028 100644 (file)
@@ -1,22 +1,11 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+
 /***************************************************************************
  *   Copyright (C) 2016 - 2019 by Andreas Bolsch                           *
  *   andreas.bolsch@mni.thm.de                                             *
  *                                                                         *
  *   Copyright (C) 2010 by Antonio Borneo                                  *
  *   borneo.antonio@gmail.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  *
- *   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, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
 
 /* STM QuadSPI (QSPI) and OctoSPI (OCTOSPI) controller are SPI bus controllers
@@ -627,8 +616,6 @@ COMMAND_HANDLER(stmqspi_handle_set)
 
        LOG_DEBUG("%s", __func__);
 
-       dual = (stmqspi_info->saved_cr & BIT(SPI_DUAL_FLASH)) ? 1 : 0;
-
        /* chip_erase_cmd, sectorsize and erase_cmd are optional */
        if ((CMD_ARGC < 7) || (CMD_ARGC > 10))
                return ERROR_COMMAND_SYNTAX_ERROR;
@@ -639,8 +626,9 @@ COMMAND_HANDLER(stmqspi_handle_set)
 
        target = bank->target;
        stmqspi_info = bank->driver_priv;
+       dual = (stmqspi_info->saved_cr & BIT(SPI_DUAL_FLASH)) ? 1 : 0;
 
-       /* invalidate all old info */
+       /* invalidate all flash device info */
        if (stmqspi_info->probed)
                free(bank->sectors);
        bank->size = 0;
@@ -732,10 +720,8 @@ COMMAND_HANDLER(stmqspi_handle_set)
 
        uint32_t dcr;
        retval = target_read_u32(target, io_base + SPI_DCR, &dcr);
-
        if (retval != ERROR_OK)
                return retval;
-
        fsize = (dcr >> SPI_FSIZE_POS) & (BIT(SPI_FSIZE_LEN) - 1);
 
        LOG_DEBUG("FSIZE = 0x%04x", fsize);
@@ -765,13 +751,13 @@ COMMAND_HANDLER(stmqspi_handle_set)
        bank->sectors = sectors;
        stmqspi_info->dev.name = stmqspi_info->devname;
        if (stmqspi_info->dev.size_in_bytes / 4096)
-               LOG_INFO("flash \'%s\' id = unknown\nchip size = %" PRIu32 "kbytes,"
-                       " bank size = %" PRIu32 "kbytes", stmqspi_info->dev.name,
+               LOG_INFO("flash \'%s\' id = unknown\nchip size = %" PRIu32 " KiB,"
+                       " bank size = %" PRIu32 " KiB", stmqspi_info->dev.name,
                        stmqspi_info->dev.size_in_bytes / 1024,
                        (stmqspi_info->dev.size_in_bytes / 1024) << dual);
        else
-               LOG_INFO("flash \'%s\' id = unknown\nchip size = %" PRIu32 "bytes,"
-                       " bank size = %" PRIu32 "bytes", stmqspi_info->dev.name,
+               LOG_INFO("flash \'%s\' id = unknown\nchip size = %" PRIu32 " B,"
+                       " bank size = %" PRIu32 " B", stmqspi_info->dev.name,
                        stmqspi_info->dev.size_in_bytes,
                        stmqspi_info->dev.size_in_bytes << dual);
 
@@ -1810,7 +1796,6 @@ static int find_sfdp_dummy(struct flash_bank *bank, int len)
                }
        }
 
-       retval = ERROR_FAIL;
        LOG_DEBUG("no start of SFDP header even after %u dummy bytes", count);
 
 err:
@@ -2092,16 +2077,17 @@ static int stmqspi_probe(struct flash_bank *bank)
        bool octal_dtr;
        int retval;
 
-       if (stmqspi_info->probed) {
-               bank->size = 0;
-               bank->num_sectors = 0;
+       /* invalidate all flash device info */
+       if (stmqspi_info->probed)
                free(bank->sectors);
-               bank->sectors = NULL;
-               memset(&stmqspi_info->dev, 0, sizeof(stmqspi_info->dev));
-               stmqspi_info->sfdp_dummy1 = 0;
-               stmqspi_info->sfdp_dummy2 = 0;
-               stmqspi_info->probed = false;
-       }
+       bank->size = 0;
+       bank->num_sectors = 0;
+       bank->sectors = NULL;
+       stmqspi_info->sfdp_dummy1 = 0;
+       stmqspi_info->sfdp_dummy2 = 0;
+       stmqspi_info->probed = false;
+       memset(&stmqspi_info->dev, 0, sizeof(stmqspi_info->dev));
+       stmqspi_info->dev.name = "unknown";
 
        /* Abort any previous operation */
        retval = stmqspi_abort(bank);
@@ -2116,8 +2102,8 @@ static int stmqspi_probe(struct flash_bank *bank)
        /* check whether QSPI_ABR is writeable and readback returns the value written */
        retval = target_write_u32(target, io_base + QSPI_ABR, magic);
        if (retval == ERROR_OK) {
-               retval = target_read_u32(target, io_base + QSPI_ABR, &data);
-               retval = target_write_u32(target, io_base + QSPI_ABR, 0);
+               (void)target_read_u32(target, io_base + QSPI_ABR, &data);
+               (void)target_write_u32(target, io_base + QSPI_ABR, 0);
        }
 
        if (data == magic) {
@@ -2217,10 +2203,10 @@ static int stmqspi_probe(struct flash_bank *bank)
                        memcpy(&stmqspi_info->dev, p, sizeof(stmqspi_info->dev));
                        if (p->size_in_bytes / 4096)
                                LOG_INFO("flash1 \'%s\' id = 0x%06" PRIx32 " size = %" PRIu32
-                                       "kbytes", p->name, id1, p->size_in_bytes / 1024);
+                                       " KiB", p->name, id1, p->size_in_bytes / 1024);
                        else
                                LOG_INFO("flash1 \'%s\' id = 0x%06" PRIx32 " size = %" PRIu32
-                                       "bytes", p->name, id1, p->size_in_bytes);
+                                       " B", p->name, id1, p->size_in_bytes);
                        break;
                }
        }
@@ -2239,7 +2225,7 @@ static int stmqspi_probe(struct flash_bank *bank)
 
                if (retval == ERROR_OK) {
                        LOG_INFO("flash1 \'%s\' id = 0x%06" PRIx32 " size = %" PRIu32
-                               "kbytes", temp.name, id1, temp.size_in_bytes / 1024);
+                               " KiB", temp.name, id1, temp.size_in_bytes / 1024);
                        /* save info and retrieved *good* id as spi_sfdp clears all info */
                        memcpy(&stmqspi_info->dev, &temp, sizeof(stmqspi_info->dev));
                        stmqspi_info->dev.device_id = id1;
@@ -2257,10 +2243,10 @@ static int stmqspi_probe(struct flash_bank *bank)
                if (p->device_id == id2) {
                        if (p->size_in_bytes / 4096)
                                LOG_INFO("flash2 \'%s\' id = 0x%06" PRIx32 " size = %" PRIu32
-                                       "kbytes", p->name, id2, p->size_in_bytes / 1024);
+                                       " KiB", p->name, id2, p->size_in_bytes / 1024);
                        else
                                LOG_INFO("flash2 \'%s\' id = 0x%06" PRIx32 " size = %" PRIu32
-                                       "bytes", p->name, id2, p->size_in_bytes);
+                                       " B", p->name, id2, p->size_in_bytes);
 
                        if (!id1)
                                memcpy(&stmqspi_info->dev, p, sizeof(stmqspi_info->dev));
@@ -2297,7 +2283,7 @@ static int stmqspi_probe(struct flash_bank *bank)
 
                if (retval == ERROR_OK)
                        LOG_INFO("flash2 \'%s\' id = 0x%06" PRIx32 " size = %" PRIu32
-                               "kbytes", temp.name, id2, temp.size_in_bytes / 1024);
+                               " KiB", temp.name, id2, temp.size_in_bytes / 1024);
                else {
                        /* even not identified by SFDP, then give up */
                        LOG_WARNING("Unknown flash2 device id = 0x%06" PRIx32
@@ -2403,22 +2389,22 @@ static int get_stmqspi_info(struct flash_bank *bank, struct command_invocation *
        }
 
        command_print_sameline(cmd, "flash%s%s \'%s\', device id = 0x%06" PRIx32
-                       ", flash size = %" PRIu32 "%sbytes\n(page size = %" PRIu32
+                       ", flash size = %" PRIu32 "%s B\n(page size = %" PRIu32
                        ", read = 0x%02" PRIx8 ", qread = 0x%02" PRIx8
                        ", pprog = 0x%02" PRIx8 ", mass_erase = 0x%02" PRIx8
-                       ", sector size = %" PRIu32 "%sbytes, sector_erase = 0x%02" PRIx8 ")",
+                       ", sector size = %" PRIu32 " %sB, sector_erase = 0x%02" PRIx8 ")",
                        ((stmqspi_info->saved_cr & (BIT(SPI_DUAL_FLASH) |
                        BIT(SPI_FSEL_FLASH))) != BIT(SPI_FSEL_FLASH)) ? "1" : "",
                        ((stmqspi_info->saved_cr & (BIT(SPI_DUAL_FLASH) |
                        BIT(SPI_FSEL_FLASH))) != 0) ? "2" : "",
                        stmqspi_info->dev.name, stmqspi_info->dev.device_id,
                        bank->size / 4096 ? bank->size / 1024 : bank->size,
-                       bank->size / 4096 ? "k" : "", stmqspi_info->dev.pagesize,
+                       bank->size / 4096 ? "Ki" : "", stmqspi_info->dev.pagesize,
                        stmqspi_info->dev.read_cmd, stmqspi_info->dev.qread_cmd,
                        stmqspi_info->dev.pprog_cmd, stmqspi_info->dev.chip_erase_cmd,
                        stmqspi_info->dev.sectorsize / 4096 ?
                                stmqspi_info->dev.sectorsize / 1024 : stmqspi_info->dev.sectorsize,
-                       stmqspi_info->dev.sectorsize / 4096 ? "k" : "",
+                       stmqspi_info->dev.sectorsize / 4096 ? "Ki" : "",
                        stmqspi_info->dev.erase_cmd);
 
        return ERROR_OK;
@@ -2461,7 +2447,7 @@ static const struct command_registration stmqspi_command_handlers[] = {
        COMMAND_REGISTRATION_DONE
 };
 
-struct flash_driver stmqspi_flash = {
+const struct flash_driver stmqspi_flash = {
        .name = "stmqspi",
        .commands = stmqspi_command_handlers,
        .flash_bank_command = stmqspi_flash_bank_command,

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)