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