src/flash/nor/core.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  *   Copyright (C) 2010 by Antonio Borneo <borneo.antonio@gmail.com>       *
   7  *                                                                         *
   8  *   This program is free software; you can redistribute it and/or modify  *
   9  *   it under the terms of the GNU General Public License as published by  *
  10  *   the Free Software Foundation; either version 2 of the License, or     *
  11  *   (at your option) any later version.                                   *
  12  *                                                                         *
  13  *   This program is distributed in the hope that it will be useful,       *
  14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  16  *   GNU General Public License for more details.                          *
  17  *                                                                         *
  18  *   You should have received a copy of the GNU General Public License     *
  19  *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  20  ***************************************************************************/
  21
  22 #ifndef OPENOCD_FLASH_NOR_CORE_H
  23 #define OPENOCD_FLASH_NOR_CORE_H
  24
  25 #include <flash/common.h>
  26
  27 /**
  28  * @file
  29  * Upper level NOR flash interfaces.
  30  */
  31
  32 struct image;
  33
  34 #define FLASH_MAX_ERROR_STR     (128)
  35
  36 /**
  37  * Describes the geometry and status of a single flash sector
  38  * within a flash bank.  A single bank typically consists of multiple
  39  * sectors, each of which can be erased and protected independently.
  40  */
  41 struct flash_sector {
  42         /** Bus offset from start of the flash chip (in bytes). */
  43         uint32_t offset;
  44         /** Number of bytes in this flash sector. */
  45         uint32_t size;
  46         /**
  47          * Indication of erasure status: 0 = not erased, 1 = erased,
  48          * other = unknown.  Set by @c flash_driver_s::erase_check.
  49          *
  50          * Flag is not used in protection block
  51          */
  52         int is_erased;
  53         /**
  54          * Indication of protection status: 0 = unprotected/unlocked,
  55          * 1 = protected/locked, other = unknown.  Set by
  56          * @c flash_driver_s::protect_check.
  57          *
  58          * This information must be considered stale immediately.
  59          * A million things could make it stale: power cycle,
  60          * reset of target, code running on target, etc.
  61          *
  62          * If a flash_bank uses an extra array of protection blocks,
  63          * protection flag is not valid in sector array
  64          */
  65         int is_protected;
  66 };
  67
  68 /** Special value for write_start_alignment and write_end_alignment field */
  69 #define FLASH_WRITE_ALIGN_SECTOR        UINT32_MAX
  70
  71 /** Special values for minimal_write_gap field */
  72 #define FLASH_WRITE_CONTINUOUS          0
  73 #define FLASH_WRITE_GAP_SECTOR          UINT32_MAX
  74
  75 /**
  76  * Provides details of a flash bank, available either on-chip or through
  77  * a major interface.
  78  *
  79  * This structure will be passed as a parameter to the callbacks in the
  80  * flash_driver_s structure, some of which may modify the contents of
  81  * this structure of the area of flash that it defines.  Driver writers
  82  * may use the @c driver_priv member to store additional data on a
  83  * per-bank basis, if required.
  84  */
  85 struct flash_bank {
  86         char *name;
  87
  88         struct target *target; /**< Target to which this bank belongs. */
  89
  90         struct flash_driver *driver; /**< Driver for this bank. */
  91         void *driver_priv; /**< Private driver storage pointer */
  92
  93         int bank_number; /**< The 'bank' (or chip number) of this instance. */
  94         uint32_t base; /**< The base address of this bank */
  95         uint32_t size; /**< The size of this chip bank, in bytes */
  96
  97         int chip_width; /**< Width of the chip in bytes (1,2,4 bytes) */
  98         int bus_width; /**< Maximum bus width, in bytes (1,2,4 bytes) */
  99
 100         /** Erased value. Defaults to 0xFF. */
 101         uint8_t erased_value;
 102
 103         /** Default padded value used, normally this matches the  flash
 104          * erased value. Defaults to 0xFF. */
 105         uint8_t default_padded_value;
 106
 107         /** Required alignment of flash write start address.
 108          * Default 0, no alignment. Can be any power of two or FLASH_WRITE_ALIGN_SECTOR */
 109         uint32_t write_start_alignment;
 110         /** Required alignment of flash write end address.
 111          * Default 0, no alignment. Can be any power of two or FLASH_WRITE_ALIGN_SECTOR */
 112         uint32_t write_end_alignment;
 113         /** Minimal gap between sections to discontinue flash write
 114          * Default FLASH_WRITE_GAP_SECTOR splits the write if one or more untouched
 115          * sectors in between.
 116      * Can be size in bytes or FLASH_WRITE_CONTINUOUS */
 117         uint32_t minimal_write_gap;
 118
 119         /**
 120          * The number of sectors on this chip.  This value will
 121          * be set intially to 0, and the flash driver must set this to
 122          * some non-zero value during "probe()" or "auto_probe()".
 123          */
 124         int num_sectors;
 125         /** Array of sectors, allocated and initialized by the flash driver */
 126         struct flash_sector *sectors;
 127
 128         /**
 129          * The number of protection blocks in this bank. This value
 130          * is set intially to 0 and sectors are used as protection blocks.
 131          * Driver probe can set protection blocks array to work with
 132          * protection granularity different than sector size.
 133          */
 134         int num_prot_blocks;
 135         /** Array of protection blocks, allocated and initilized by the flash driver */
 136         struct flash_sector *prot_blocks;
 137
 138         struct flash_bank *next; /**< The next flash bank on this chip */
 139 };
 140
 141 /** Registers the 'flash' subsystem commands */
 142 int flash_register_commands(struct command_context *cmd_ctx);
 143
 144 /**
 145  * Erases @a length bytes in the @a target flash, starting at @a addr.
 146  * The range @a addr to @a addr + @a length - 1 must be strictly
 147  * sector aligned, unless @a pad is true.  Setting @a pad true extends
 148  * the range, at beginning and/or end, if needed for sector alignment.
 149  * @returns ERROR_OK if successful; otherwise, an error code.
 150  */
 151 int flash_erase_address_range(struct target *target,
 152                 bool pad, uint32_t addr, uint32_t length);
 153
 154 int flash_unlock_address_range(struct target *target, uint32_t addr,
 155                 uint32_t length);
 156
 157 /**
 158  * Align start address of a flash write region according to bank requirements.
 159  * @param bank Pointer to bank descriptor structure
 160  * @param addr Address to align
 161  * @returns Aligned address
 162 */
 163 target_addr_t flash_write_align_start(struct flash_bank *bank, target_addr_t addr);
 164 /**
 165  * Align end address of a flash write region according to bank requirements.
 166  * Note: Use address of the last byte to write, not the next after the region.
 167  * @param bank Pointer to bank descriptor structure
 168  * @param addr Address to align (address of the last byte to write)
 169  * @returns Aligned address (address of the last byte of padded region)
 170 */
 171 target_addr_t flash_write_align_end(struct flash_bank *bank, target_addr_t addr);
 172
 173 /**
 174  * Writes @a image into the @a target flash.  The @a written parameter
 175  * will contain the
 176  * @param target The target with the flash to be programmed.
 177  * @param image The image that will be programmed to flash.
 178  * @param written On return, contains the number of bytes written.
 179  * @param erase If non-zero, indicates the flash driver should first
 180  * erase the corresponding banks or sectors before programming.
 181  * @returns ERROR_OK if successful; otherwise, an error code.
 182  */
 183 int flash_write(struct target *target,
 184                 struct image *image, uint32_t *written, int erase);
 185
 186 /**
 187  * Forces targets to re-examine their erase/protection state.
 188  * This routine must be called when the system may modify the status.
 189  */
 190 void flash_set_dirty(void);
 191
 192 /** @returns The number of flash banks currently defined. */
 193 int flash_get_bank_count(void);
 194
 195 /** Deallocates bank->driver_priv */
 196 void default_flash_free_driver_priv(struct flash_bank *bank);
 197
 198 /** Deallocates all flash banks */
 199 void flash_free_all_banks(void);
 200 /**
 201  * Provides default read implementation for flash memory.
 202  * @param bank The bank to read.
 203  * @param buffer The data bytes read.
 204  * @param offset The offset into the chip to read.
 205  * @param count The number of bytes to read.
 206  * @returns ERROR_OK if successful; otherwise, an error code.
 207  */
 208 int default_flash_read(struct flash_bank *bank,
 209                 uint8_t *buffer, uint32_t offset, uint32_t count);
 210 /**
 211  * Provides default erased-bank check handling. Checks to see if
 212  * the flash driver knows they are erased; if things look uncertain,
 213  * this routine will call default_flash_mem_blank_check() to confirm.
 214  * @returns ERROR_OK if successful; otherwise, an error code.
 215  */
 216 int default_flash_blank_check(struct flash_bank *bank);
 217
 218 /**
 219  * Returns the flash bank specified by @a name, which matches the
 220  * driver name and a suffix (option) specify the driver-specific
 221  * bank number. The suffix consists of the '.' and the driver-specific
 222  * bank number: when two str9x banks are defined, then 'str9x.1' refers
 223  * to the second.
 224  */
 225 int get_flash_bank_by_name(const char *name, struct flash_bank **bank_result);
 226 /**
 227  * Returns the flash bank specified by @a name, which matches the
 228  * driver name and a suffix (option) specify the driver-specific
 229  * bank number. The suffix consists of the '.' and the driver-specific
 230  * bank number: when two str9x banks are defined, then 'str9x.1' refers
 231  * to the second.
 232  */
 233 struct flash_bank *get_flash_bank_by_name_noprobe(const char *name);
 234 /**
 235  * Returns the flash bank like get_flash_bank_by_name(), without probing.
 236  * @param num The flash bank number.
 237  * @param bank returned bank if fn returns ERROR_OK
 238  * @returns ERROR_OK if successful
 239  */
 240 int get_flash_bank_by_num(int num, struct flash_bank **bank);
 241 /**
 242  * Retreives @a bank from a command argument, reporting errors parsing
 243  * the bank identifier or retreiving the specified bank.  The bank
 244  * may be identified by its bank number or by @c name.instance, where
 245  * @a instance is driver-specific.
 246  * @param name_index The index to the string in args containing the
 247  * bank identifier.
 248  * @param bank On output, contians a pointer to the bank or NULL.
 249  * @returns ERROR_OK on success, or an error indicating the problem.
 250  */
 251 COMMAND_HELPER(flash_command_get_bank, unsigned name_index,
 252                 struct flash_bank **bank);
 253 /**
 254  * Returns the flash bank like get_flash_bank_by_num(), without probing.
 255  * @param num The flash bank number.
 256  * @returns A struct flash_bank for flash bank @a num, or NULL.
 257  */
 258 struct flash_bank *get_flash_bank_by_num_noprobe(int num);
 259 /**
 260  * Returns the flash bank located at a specified address.
 261  * @param target The target, presumed to contain one or more banks.
 262  * @param addr An address that is within the range of the bank.
 263  * @param check return ERROR_OK and result_bank NULL if the bank does not exist
 264  * @returns The struct flash_bank located at @a addr, or NULL.
 265  */
 266 int get_flash_bank_by_addr(struct target *target, uint32_t addr, bool check,
 267                 struct flash_bank **result_bank);
 268 /**
 269  * Allocate and fill an array of sectors or protection blocks.
 270  * @param offset Offset of first block.
 271  * @param size Size of each block.
 272  * @param num_blocks Number of blocks in array.
 273  * @returns A struct flash_sector pointer or NULL when allocation failed.
 274  */
 275 struct flash_sector *alloc_block_array(uint32_t offset, uint32_t size, int num_blocks);
 276
 277 #endif /* OPENOCD_FLASH_NOR_CORE_H */