NOR: add read() callback to struct flash_driver
[openocd.git] / src / flash / nor / driver.h
index 0e77132..3757442 100644 (file)
@@ -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  *
@@ -131,6 +132,20 @@ struct flash_driver
                        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.
         *