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, write to the                         *
  20  *   Free Software Foundation, Inc.,                                       *
  21  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  22  ***************************************************************************/
  23 #ifndef FLASH_NOR_CORE_H
  24 #define FLASH_NOR_CORE_H
  25
  26 #include <flash/common.h>
  27
  28 /**
  29  * @file
  30  * Upper level NOR flash interfaces.
  31  */
  32
  33 struct image;
  34
  35 #define FLASH_MAX_ERROR_STR     (128)
  36
  37 /**
  38  * Describes the geometry and status of a single flash sector
  39  * within a flash bank.  A single bank typically consists of multiple
  40  * sectors, each of which can be erased and protected independently.
  41  */
  42 struct flash_sector
  43 {
  44         /// Bus offset from start of the flash chip (in bytes).
  45         uint32_t offset;
  46         /// Number of bytes in this flash sector.
  47         uint32_t size;
  48         /**
  49          * Indication of erasure status: 0 = not erased, 1 = erased,
  50          * other = unknown.  Set by @c flash_driver_s::erase_check.
  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         int is_protected;
  63 };
  64
  65 /**
  66  * Provides details of a flash bank, available either on-chip or through
  67  * a major interface.
  68  *
  69  * This structure will be passed as a parameter to the callbacks in the
  70  * flash_driver_s structure, some of which may modify the contents of
  71  * this structure of the area of flash that it defines.  Driver writers
  72  * may use the @c driver_priv member to store additional data on a
  73  * per-bank basis, if required.
  74  */
  75 struct flash_bank
  76 {
  77         char *name;
  78
  79         struct target *target; /**< Target to which this bank belongs. */
  80
  81         struct flash_driver *driver; /**< Driver for this bank. */
  82         void *driver_priv; /**< Private driver storage pointer */
  83
  84         int bank_number; /**< The 'bank' (or chip number) of this instance. */
  85         uint32_t base; /**< The base address of this bank */
  86         uint32_t size; /**< The size of this chip bank, in bytes */
  87
  88         int chip_width; /**< Width of the chip in bytes (1,2,4 bytes) */
  89         int bus_width; /**< Maximum bus width, in bytes (1,2,4 bytes) */
  90
  91         /**
  92          * The number of sectors on this chip.  This value will
  93          * be set intially to 0, and the flash driver must set this to
  94          * some non-zero value during "probe()" or "auto_probe()".
  95          */
  96         int num_sectors;
  97         /// Array of sectors, allocated and initilized by the flash driver
  98         struct flash_sector *sectors;
  99
 100         struct flash_bank *next; /**< The next flash bank on this chip */
 101 };
 102
 103 /// Registers the 'flash' subsystem commands
 104 int flash_register_commands(struct command_context *cmd_ctx);
 105
 106 /**
 107  * Erases @a length bytes in the @a target flash, starting at @a addr.
 108  * The range @a addr to @a addr + @a length - 1 must be strictly
 109  * sector aligned, unless @a pad is true.  Setting @a pad true extends
 110  * the range, at beginning and/or end, if needed for sector alignment.
 111  * @returns ERROR_OK if successful; otherwise, an error code.
 112  */
 113 int flash_erase_address_range(struct target *target,
 114                 bool pad, uint32_t addr, uint32_t length);
 115
 116 int flash_unlock_address_range(struct target *target, uint32_t addr,
 117                 uint32_t length);
 118
 119 /**
 120  * Writes @a image into the @a target flash.  The @a written parameter
 121  * will contain the
 122  * @param target The target with the flash to be programmed.
 123  * @param image The image that will be programmed to flash.
 124  * @param written On return, contains the number of bytes written.
 125  * @param erase If non-zero, indicates the flash driver should first
 126  * erase the corresponding banks or sectors before programming.
 127  * @returns ERROR_OK if successful; otherwise, an error code.
 128  */
 129 int flash_write(struct target *target,
 130                 struct image *image, uint32_t *written, int erase);
 131
 132 /**
 133  * Forces targets to re-examine their erase/protection state.
 134  * This routine must be called when the system may modify the status.
 135  */
 136 void flash_set_dirty(void);
 137 /// @returns The number of flash banks currently defined.
 138 int flash_get_bank_count(void);
 139 /**
 140  * Provides default read implementation for flash memory.
 141  * @param bank The bank to read.
 142  * @param buffer The data bytes read.
 143  * @param offset The offset into the chip to read.
 144  * @param count The number of bytes to read.
 145  * @returns ERROR_OK if successful; otherwise, an error code.
 146  */
 147 int default_flash_read(struct flash_bank *bank,
 148                 uint8_t *buffer, uint32_t offset, uint32_t count);
 149 /**
 150  * Provides default erased-bank check handling. Checks to see if
 151  * the flash driver knows they are erased; if things look uncertain,
 152  * this routine will call default_flash_mem_blank_check() to confirm.
 153  * @returns ERROR_OK if successful; otherwise, an error code.
 154  */
 155 int default_flash_blank_check(struct flash_bank *bank);
 156 /**
 157  * Provides a default blank flash memory check.  Ensures the contents
 158  * of the given bank have truly been erased.
 159  * @param bank The flash bank.
 160  * @returns ERROR_OK if successful; otherwise, an error code.
 161  */
 162 int default_flash_mem_blank_check(struct flash_bank *bank);
 163
 164 /**
 165  * Returns the flash bank specified by @a name, which matches the
 166  * driver name and a suffix (option) specify the driver-specific
 167  * bank number. The suffix consists of the '.' and the driver-specific
 168  * bank number: when two str9x banks are defined, then 'str9x.1' refers
 169  * to the second.
 170  */
 171 struct flash_bank *get_flash_bank_by_name(const char *name);
 172 /**
 173  * Returns a flash bank by the specified flash_bank_s bank_number, @a num.
 174  * @param num The flash bank number.
 175  * @param bank returned bank if fn returns ERROR_OK
 176  * @returns ERROR_OK if successful
 177  */
 178 int get_flash_bank_by_num(int num, struct flash_bank **bank);
 179 /**
 180  * Retreives @a bank from a command argument, reporting errors parsing
 181  * the bank identifier or retreiving the specified bank.  The bank
 182  * may be identified by its bank number or by @c name.instance, where
 183  * @a instance is driver-specific.
 184  * @param name_index The index to the string in args containing the
 185  * bank identifier.
 186  * @param bank On output, contians a pointer to the bank or NULL.
 187  * @returns ERROR_OK on success, or an error indicating the problem.
 188  */
 189 COMMAND_HELPER(flash_command_get_bank, unsigned name_index,
 190                 struct flash_bank **bank);
 191 /**
 192  * Returns the flash bank like get_flash_bank_by_num(), without probing.
 193  * @param num The flash bank number.
 194  * @returns A struct flash_bank for flash bank @a num, or NULL.
 195  */
 196 struct flash_bank *get_flash_bank_by_num_noprobe(int num);
 197 /**
 198  * Returns the flash bank located at a specified address.
 199  * @param target The target, presumed to contain one or more banks.
 200  * @param addr An address that is within the range of the bank.
 201  * @returns The struct flash_bank located at @a addr, or NULL.
 202  */
 203 struct flash_bank *get_flash_bank_by_addr(struct target *target, uint32_t addr);
 204
 205 #endif // FLASH_NOR_CORE_H