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