Code Review / openocd.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
target/xtensa: avoid IHI for writes to non-executable memory
[openocd.git] / src / flash / nor / driver.h
diff --git a/src/flash/nor/driver.h b/src/flash/nor/driver.h
index 466417adb7c57766a3307e63c4ee1cb210906231..7d6f8c5cc4976b5d7a48a6ebe9181eb1b7334cec 100644 (file)
--- a/src/flash/nor/driver.h
+++ b/src/flash/nor/driver.h
@@ -1,28 +1,15 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
 /***************************************************************************
  *   Copyright (C) 2005 by Dominic Rath <Dominic.Rath@gmx.de>              *
  *   Copyright (C) 2007,2008 Øyvind Harboe <oyvind.harboe@zylin.com>       *
  *   Copyright (C) 2008 by Spencer Oliver <spen@spen-soft.co.uk>           *
  *   Copyright (C) 2009 Zachary T Welch <zw@superlucidity.net>             *
  *   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, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
 
-#ifndef FLASH_NOR_DRIVER_H
-#define FLASH_NOR_DRIVER_H
+#ifndef OPENOCD_FLASH_NOR_DRIVER_H
+#define OPENOCD_FLASH_NOR_DRIVER_H
 
 struct flash_bank;
 
@@ -106,11 +93,14 @@ struct flash_driver {
         * @param last The number of the last sector to erase, typically N-1.
         * @returns ERROR_OK if successful; otherwise, an error code.
         */
-       int (*erase)(struct flash_bank *bank, int first, int last);
+       int (*erase)(struct flash_bank *bank, unsigned int first,
+               unsigned int last);
 
        /**
         * Bank/sector protection routine (target-specific).
         *
+        * If protection is not implemented, set method to NULL
+        *
         * When called, the driver should enable/disable protection
         * for MINIMUM the range covered by first..last sectors
         * inclusive. Some chips have alignment requirements will
@@ -119,11 +109,12 @@ struct flash_driver {
         *
         * @param bank The bank to protect or unprotect.
         * @param set If non-zero, enable protection; if 0, disable it.
-        * @param first The first sector to (un)protect, typicaly 0.
+        * @param first The first sector to (un)protect, typically 0.
         * @param last The last sector to (un)project, typically N-1.
         * @returns ERROR_OK if successful; otherwise, an error code.
         */
-       int (*protect)(struct flash_bank *bank, int set, int first, int last);
+       int (*protect)(struct flash_bank *bank, int set, unsigned int first,
+               unsigned int last);
 
        /**
         * Program data into the flash.  Note CPU address will be
@@ -137,7 +128,7 @@ struct flash_driver {
         * @returns ERROR_OK if successful; otherwise, an error code.
         */
        int (*write)(struct flash_bank *bank,
-                       uint8_t *buffer, uint32_t offset, uint32_t count);
+                       const uint8_t *buffer, uint32_t offset, uint32_t count);
 
        /**
         * Read data from the flash. Note CPU address will be
@@ -153,6 +144,20 @@ struct flash_driver {
         int (*read)(struct flash_bank *bank,
                        uint8_t *buffer, uint32_t offset, uint32_t count);
 
+       /**
+        * Verify data in flash.  Note CPU address will be
+        * "bank->base + offset", while the physical address is
+        * dependent upon current target MMU mappings.
+        *
+        * @param bank The bank to verify
+        * @param buffer The data bytes to verify against.
+        * @param offset The offset into the chip to verify.
+        * @param count The number of bytes to verify.
+        * @returns ERROR_OK if successful; otherwise, an error code.
+        */
+       int (*verify)(struct flash_bank *bank,
+                       const uint8_t *buffer, uint32_t offset, uint32_t count);
+
        /**
         * Probe to determine what kind of flash is present.
         * This is invoked by the "probe" script command.
@@ -180,6 +185,8 @@ struct flash_driver {
         * flash_sector_s::is_protected field for each of the flash
         * bank's sectors.
         *
+        * If protection is not implemented, set method to NULL
+        *
         * @param bank - the bank to check
         * @returns ERROR_OK if successful; otherwise, an error code.
         */
@@ -187,30 +194,37 @@ struct flash_driver {
 
        /**
         * Display human-readable information about the flash
-        * bank into the given buffer.  Drivers must be careful to avoid
-        * overflowing the buffer.
+        * bank.
         *
         * @param bank - the bank to get info about
-        * @param char - where to put the text for the human to read
-        * @param buf_size - the size of the human buffer.
+        * @param cmd - command invocation instance for which to generate
+        *              the textual output
         * @returns ERROR_OK if successful; otherwise, an error code.
         */
-       int (*info)(struct flash_bank *bank, char *buf, int buf_size);
+       int (*info)(struct flash_bank *bank, struct command_invocation *cmd);
 
        /**
-        * A more gentle flavor of filash_driver_s::probe, performing
+        * A more gentle flavor of flash_driver_s::probe, performing
         * setup with less noise.  Generally, driver routines should test
-        * to seee if the bank has already been probed; if it has, the
+        * to see if the bank has already been probed; if it has, the
         * driver probably should not perform its probe a second time.
         *
         * This callback is often called from the inside of other
         * routines (e.g. GDB flash downloads) to autoprobe the flash as
-        * it is programing the flash.
+        * it is programming the flash.
         *
         * @param bank - the bank to probe
         * @returns ERROR_OK if successful; otherwise, an error code.
         */
        int (*auto_probe)(struct flash_bank *bank);
+
+       /**
+        * Deallocates private driver structures.
+        * Use default_flash_free_driver_priv() to simply free(bank->driver_priv)
+        *
+        * @param bank - the bank being destroyed
+        */
+       void (*free_driver_priv)(struct flash_bank *bank);
 };
 
 #define FLASH_BANK_COMMAND_HANDLER(name) \
@@ -221,6 +235,79 @@ struct flash_driver {
  * @param name The name of the requested driver.
  * @returns The flash_driver called @c name, or NULL if not found.
  */
-struct flash_driver *flash_driver_find_by_name(const char *name);
+const struct flash_driver *flash_driver_find_by_name(const char *name);
+
+extern const struct flash_driver aduc702x_flash;
+extern const struct flash_driver aducm360_flash;
+extern const struct flash_driver ambiqmicro_flash;
+extern const struct flash_driver at91sam3_flash;
+extern const struct flash_driver at91sam4_flash;
+extern const struct flash_driver at91sam4l_flash;
+extern const struct flash_driver at91sam7_flash;
+extern const struct flash_driver at91samd_flash;
+extern const struct flash_driver ath79_flash;
+extern const struct flash_driver atsame5_flash;
+extern const struct flash_driver atsamv_flash;
+extern const struct flash_driver avr_flash;
+extern const struct flash_driver bluenrgx_flash;
+extern const struct flash_driver cc26xx_flash;
+extern const struct flash_driver cc3220sf_flash;
+extern const struct flash_driver cfi_flash;
+extern const struct flash_driver dsp5680xx_flash;
+extern const struct flash_driver efm32_flash;
+extern const struct flash_driver em357_flash;
+extern const struct flash_driver eneispif_flash;
+extern const struct flash_driver esirisc_flash;
+extern const struct flash_driver faux_flash;
+extern const struct flash_driver fespi_flash;
+extern const struct flash_driver fm3_flash;
+extern const struct flash_driver fm4_flash;
+extern const struct flash_driver jtagspi_flash;
+extern const struct flash_driver kinetis_flash;
+extern const struct flash_driver kinetis_ke_flash;
+extern const struct flash_driver lpc2000_flash;
+extern const struct flash_driver lpc288x_flash;
+extern const struct flash_driver lpc2900_flash;
+extern const struct flash_driver lpcspifi_flash;
+extern const struct flash_driver max32xxx_flash;
+extern const struct flash_driver mdr_flash;
+extern const struct flash_driver mrvlqspi_flash;
+extern const struct flash_driver msp432_flash;
+extern const struct flash_driver niietcm4_flash;
+extern const struct flash_driver npcx_flash;
+extern const struct flash_driver nrf51_flash;
+extern const struct flash_driver nrf5_flash;
+extern const struct flash_driver numicro_flash;
+extern const struct flash_driver ocl_flash;
+extern const struct flash_driver pic32mx_flash;
+extern const struct flash_driver psoc4_flash;
+extern const struct flash_driver psoc5lp_eeprom_flash;
+extern const struct flash_driver psoc5lp_flash;
+extern const struct flash_driver psoc5lp_nvl_flash;
+extern const struct flash_driver psoc6_flash;
+extern const struct flash_driver qn908x_flash;
+extern const struct flash_driver renesas_rpchf_flash;
+extern const struct flash_driver rp2040_flash;
+extern const struct flash_driver rsl10_flash;
+extern const struct flash_driver sh_qspi_flash;
+extern const struct flash_driver sim3x_flash;
+extern const struct flash_driver stellaris_flash;
+extern const struct flash_driver stm32f1x_flash;
+extern const struct flash_driver stm32f2x_flash;
+extern const struct flash_driver stm32h7x_flash;
+extern const struct flash_driver stm32l4x_flash;
+extern const struct flash_driver stm32lx_flash;
+extern const struct flash_driver stmqspi_flash;
+extern const struct flash_driver stmsmi_flash;
+extern const struct flash_driver str7x_flash;
+extern const struct flash_driver str9x_flash;
+extern const struct flash_driver str9xpec_flash;
+extern const struct flash_driver swm050_flash;
+extern const struct flash_driver tms470_flash;
+extern const struct flash_driver virtual_flash;
+extern const struct flash_driver w600_flash;
+extern const struct flash_driver xcf_flash;
+extern const struct flash_driver xmc1xxx_flash;
+extern const struct flash_driver xmc4xxx_flash;
 
-#endif /* FLASH_NOR_DRIVER_H */
+#endif /* OPENOCD_FLASH_NOR_DRIVER_H */
Open On-Chip Debugger

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)