STM32L: Validate flash writes

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

diff --git a/src/flash/nor/driver.h b/src/flash/nor/driver.h
index 0e77132734bbf14d0589b8f6a623ed06ef7f3293..a899dbbd03956746e1a4640a5f02d5f8134b8a95 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  *
@@ -19,6 +20,7 @@
  *   Free Software Foundation, Inc.,                                       *
  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
+
 #ifndef FLASH_NOR_DRIVER_H
 #define FLASH_NOR_DRIVER_H
 
@@ -47,13 +49,17 @@ struct flash_bank;
  * corresponding static <code>flash_driver_<i>callback</i>()</code>
  * routine in flash.c.
  */
-struct flash_driver
-{
+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;
+
+       /**
+        * Gives a human-readable description of arguments.
+        */
+       const char *usage;
 
        /**
         * An array of driver-specific commands to register.  When called
@@ -104,9 +110,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.
@@ -130,6 +139,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.
@@ -177,7 +200,7 @@ struct flash_driver
        /**
         * A more gentle flavor of filash_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
@@ -190,7 +213,8 @@ struct flash_driver
        int (*auto_probe)(struct flash_bank *bank);
 };
 
-#define FLASH_BANK_COMMAND_HANDLER(name) static __FLASH_BANK_COMMAND(name)
+#define FLASH_BANK_COMMAND_HANDLER(name) \
+       static __FLASH_BANK_COMMAND(name)
 
 /**
  * Find a NOR flash driver by its name.
@@ -199,4 +223,4 @@ struct flash_driver
  */
 struct flash_driver *flash_driver_find_by_name(const char *name);
 
-#endif // FLASH_NOR_DRIVER_H
+#endif /* FLASH_NOR_DRIVER_H */