cfi_protect is not implemented on Spansion flashes (many do not even have protection...

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

diff --git a/src/flash/nor/driver.h b/src/flash/nor/driver.h
index de71a39bf1b9f9ce12f4f0027d4429306d04e1cc..afd05285a2766fcd9f3e586a1d7338a8740b0fc5 100644 (file)
--- a/src/flash/nor/driver.h
+++ b/src/flash/nor/driver.h
@@ -3,6 +3,7 @@
  *   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  *
@@ -53,7 +54,7 @@ struct flash_driver
         * Gives a human-readable name of this flash driver,
         * This field is used to select and initialize the driver.
         */
-       char *name;
+       const char *name;
 
        /**
         * An array of driver-specific commands to register.  When called
@@ -75,11 +76,12 @@ struct flash_driver
         * CMD_ARGV[2] = baseaddress
         * CMD_ARGV[3] = lengthbytes
         * CMD_ARGV[4] = chip_width_in bytes
-        * CMD_ARGV[5] = bus_width_bytes
+        * CMD_ARGV[5] = bus_width_in_bytes
         * CMD_ARGV[6] = driver-specific parameters
         * @endcode
         *
-        * For example, CMD_ARGV[4] = 16 bit flash, CMD_ARGV[5] = 32bit bus.
+        * For example, CMD_ARGV[4] = 2 (for 16 bit flash),
+        *      CMD_ARGV[5] = 4 (for 32 bit bus).
         *
         * If extra arguments are provided (@a CMD_ARGC > 6), they will
         * start in @a CMD_ARGV[6].  These can be used to implement
@@ -103,9 +105,12 @@ struct flash_driver
 
        /**
         * Bank/sector protection routine (target-specific).
-        * When called, the driver should disable 'flash write' bits (or
-        * enable 'erase protection' bits) for the given @a bank and @a
-        * sectors.
+        *
+        * When called, the driver should enable/disable protection
+        * for MINIMUM the range covered by first..last sectors
+        * inclusive. Some chips have alignment requirements will
+        * cause the actual range to be protected / unprotected to
+        * be larger than the first..last range.
         *
         * @param bank The bank to protect or unprotect.
         * @param set If non-zero, enable protection; if 0, disable it.
@@ -129,6 +134,20 @@ struct flash_driver
        int (*write)(struct flash_bank *bank,
                        uint8_t *buffer, uint32_t offset, uint32_t count);
 
+       /**
+        * Read data from the 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 read.
+        * @param buffer The data bytes read.
+        * @param offset The offset into the chip to read.
+        * @param count The number of bytes to read.
+        * @returns ERROR_OK if successful; otherwise, an error code.
+        */
+        int (*read)(struct flash_bank *bank,
+                       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.