src/flash/nor/driver.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath <Dominic.Rath@gmx.de>              *
   3  *   Copyright (C) 2007,2008 Øyvind Harboe <oyvind.harboe@zylin.com>       *
   4  *   Copyright (C) 2008 by Spencer Oliver <spen@spen-soft.co.uk>           *
   5  *   Copyright (C) 2009 Zachary T Welch <zw@superlucidity.net>             *
   6  *                                                                         *
   7  *   This program is free software; you can redistribute it and/or modify  *
   8  *   it under the terms of the GNU General Public License as published by  *
   9  *   the Free Software Foundation; either version 2 of the License, or     *
  10  *   (at your option) any later version.                                   *
  11  *                                                                         *
  12  *   This program is distributed in the hope that it will be useful,       *
  13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  15  *   GNU General Public License for more details.                          *
  16  *                                                                         *
  17  *   You should have received a copy of the GNU General Public License     *
  18  *   along with this program; if not, write to the                         *
  19  *   Free Software Foundation, Inc.,                                       *
  20  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  21  ***************************************************************************/
  22 #ifndef FLASH_NOR_DRIVER_H
  23 #define FLASH_NOR_DRIVER_H
  24
  25 struct flash_bank;
  26
  27 #define __FLASH_BANK_COMMAND(name) \
  28                 COMMAND_HELPER(name, struct flash_bank *bank)
  29
  30 /**
  31  * @brief Provides the implementation-independent structure that defines
  32  * all of the callbacks required by OpenOCD flash drivers.
  33  *
  34  * Driver authors must implement the routines defined here, providing an
  35  * instance with the fields filled out.  After that, the instance must
  36  * be registered in flash.c, so it can be used by the driver lookup system.
  37  *
  38  * Specifically, the user can issue the command: @par
  39  * @code
  40  * flash bank DRIVERNAME ...parameters...
  41  * @endcode
  42  *
  43  * OpenOCD will search for the driver with a @c flash_driver_s::name
  44  * that matches @c DRIVERNAME.
  45  *
  46  * The flash subsystem calls some of the other drivers routines a using
  47  * corresponding static <code>flash_driver_<i>callback</i>()</code>
  48  * routine in flash.c.
  49  */
  50 struct flash_driver
  51 {
  52         /**
  53          * Gives a human-readable name of this flash driver,
  54          * This field is used to select and initialize the driver.
  55          */
  56         char *name;
  57
  58         /**
  59          * An array of driver-specific commands to register.  When called
  60          * during the "flash bank" command, the driver can register addition
  61          * commands to support new flash chip functions.
  62          */
  63         const struct command_registration *commands;
  64
  65         /**
  66          * Finish the "flash bank" command for @a bank.  The
  67          * @a bank parameter will have been filled in by the core flash
  68          * layer when this routine is called, and the driver can store
  69          * additional information in its struct flash_bank::driver_priv field.
  70          *
  71          * The CMD_ARGV are: @par
  72          * @code
  73          * CMD_ARGV[0] = bank
  74          * CMD_ARGV[1] = drivername {name above}
  75          * CMD_ARGV[2] = baseaddress
  76          * CMD_ARGV[3] = lengthbytes
  77          * CMD_ARGV[4] = chip_width_in bytes
  78          * CMD_ARGV[5] = bus_width_bytes
  79          * CMD_ARGV[6] = driver-specific parameters
  80          * @endcode
  81          *
  82          * For example, CMD_ARGV[4] = 16 bit flash, CMD_ARGV[5] = 32bit bus.
  83          *
  84          * If extra arguments are provided (@a CMD_ARGC > 6), they will
  85          * start in @a CMD_ARGV[6].  These can be used to implement
  86          * driver-specific extensions.
  87          *
  88          * @returns ERROR_OK if successful; otherwise, an error code.
  89          */
  90         __FLASH_BANK_COMMAND((*flash_bank_command));
  91
  92         /**
  93          * Bank/sector erase routine (target-specific).  When
  94          * called, the flash driver should erase the specified sectors
  95          * using whatever means are at its disposal.
  96          *
  97          * @param bank The bank of flash to be erased.
  98          * @param first The number of the first sector to erase, typically 0.
  99          * @param last The number of the last sector to erase, typically N-1.
 100          * @returns ERROR_OK if successful; otherwise, an error code.
 101          */
 102         int (*erase)(struct flash_bank *bank, int first, int last);
 103
 104         /**
 105          * Bank/sector protection routine (target-specific).
 106          * When called, the driver should disable 'flash write' bits (or
 107          * enable 'erase protection' bits) for the given @a bank and @a
 108          * sectors.
 109          *
 110          * @param bank The bank to protect or unprotect.
 111          * @param set If non-zero, enable protection; if 0, disable it.
 112          * @param first The first sector to (un)protect, typicaly 0.
 113          * @param last The last sector to (un)project, typically N-1.
 114          * @returns ERROR_OK if successful; otherwise, an error code.
 115          */
 116         int (*protect)(struct flash_bank *bank, int set, int first, int last);
 117
 118         /**
 119          * Program data into the flash.  Note CPU address will be
 120          * "bank->base + offset", while the physical address is
 121          * dependent upon current target MMU mappings.
 122          *
 123          * @param bank The bank to program
 124          * @param buffer The data bytes to write.
 125          * @param offset The offset into the chip to program.
 126          * @param count The number of bytes to write.
 127          * @returns ERROR_OK if successful; otherwise, an error code.
 128          */
 129         int (*write)(struct flash_bank *bank,
 130                         uint8_t *buffer, uint32_t offset, uint32_t count);
 131
 132         /**
 133          * Probe to determine what kind of flash is present.
 134          * This is invoked by the "probe" script command.
 135          *
 136          * @param bank The bank to probe
 137          * @returns ERROR_OK if successful; otherwise, an error code.
 138          */
 139         int (*probe)(struct flash_bank *bank);
 140
 141         /**
 142          * Check the erasure status of a flash bank.
 143          * When called, the driver routine must perform the required
 144          * checks and then set the @c flash_sector_s::is_erased field
 145          * for each of the flash banks's sectors.
 146          *
 147          * @param bank The bank to check
 148          * @returns ERROR_OK if successful; otherwise, an error code.
 149          */
 150         int (*erase_check)(struct flash_bank *bank);
 151
 152         /**
 153          * Determine if the specific bank is "protected" or not.
 154          * When called, the driver routine must must perform the
 155          * required protection check(s) and then set the @c
 156          * flash_sector_s::is_protected field for each of the flash
 157          * bank's sectors.
 158          *
 159          * @param bank - the bank to check
 160          * @returns ERROR_OK if successful; otherwise, an error code.
 161          */
 162         int (*protect_check)(struct flash_bank *bank);
 163
 164         /**
 165          * Display human-readable information about the flash
 166          * bank into the given buffer.  Drivers must be careful to avoid
 167          * overflowing the buffer.
 168          *
 169          * @param bank - the bank to get info about
 170          * @param char - where to put the text for the human to read
 171          * @param buf_size - the size of the human buffer.
 172          * @returns ERROR_OK if successful; otherwise, an error code.
 173          */
 174         int (*info)(struct flash_bank *bank, char *buf, int buf_size);
 175
 176         /**
 177          * A more gentle flavor of filash_driver_s::probe, performing
 178          * setup with less noise.  Generally, driver routines should test
 179          * to seee if the bank has already been probed; if it has, the
 180          * driver probably should not perform its probe a second time.
 181          *
 182          * This callback is often called from the inside of other
 183          * routines (e.g. GDB flash downloads) to autoprobe the flash as
 184          * it is programing the flash.
 185          *
 186          * @param bank - the bank to probe
 187          * @returns ERROR_OK if successful; otherwise, an error code.
 188          */
 189         int (*auto_probe)(struct flash_bank *bank);
 190 };
 191
 192 #define FLASH_BANK_COMMAND_HANDLER(name) static __FLASH_BANK_COMMAND(name)
 193
 194 /**
 195  * Find a NOR flash driver by its name.
 196  * @param name The name of the requested driver.
 197  * @returns The flash_driver called @c name, or NULL if not found.
 198  */
 199 struct flash_driver *flash_driver_find_by_name(const char *name);
 200
 201 #endif // FLASH_NOR_DRIVER_H