openocd: src/flash: replace the GPL-2.0-or-later license tag

[openocd.git] / src / flash / nor / driver.h

diff --git a/src/flash/nor/driver.h b/src/flash/nor/driver.h
index 9c56d4ea8ccda07c285ddd9e88e8bc7c6aa7dbf6..931f79421fa200c6d0368751160e46fce02b9977 100644 (file)
--- a/src/flash/nor/driver.h
+++ b/src/flash/nor/driver.h
@@ -1,22 +1,11 @@
+/* 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, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
 
 #ifndef OPENOCD_FLASH_NOR_DRIVER_H
@@ -104,7 +93,8 @@ 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).
@@ -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
@@ -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.
@@ -189,25 +194,24 @@ 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 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.