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> *
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. *
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. *
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
25 #include <flash/common.h>
29 * Upper level NOR flash interfaces.
34 #define FLASH_MAX_ERROR_STR (128)
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.
43 /// Bus offset from start of the flash chip (in bytes).
45 /// Number of bytes in this flash sector.
48 * Indication of erasure status: 0 = not erased, 1 = erased,
49 * other = unknown. Set by @c flash_driver_s::erase_check.
53 * Indication of protection status: 0 = unprotected/unlocked,
54 * 1 = protected/locked, other = unknown. Set by
55 * @c flash_driver_s::protect_check.
57 * This information must be considered stale immediately.
58 * A million things could make it stale: power cycle,
59 * reset of target, code running on target, etc.
65 * Provides details of a flash bank, available either on-chip or through
68 * This structure will be passed as a parameter to the callbacks in the
69 * flash_driver_s structure, some of which may modify the contents of
70 * this structure of the area of flash that it defines. Driver writers
71 * may use the @c driver_priv member to store additional data on a
72 * per-bank basis, if required.
78 struct target
*target
; /**< Target to which this bank belongs. */
80 struct flash_driver
*driver
; /**< Driver for this bank. */
81 void *driver_priv
; /**< Private driver storage pointer */
83 int bank_number
; /**< The 'bank' (or chip number) of this instance. */
84 uint32_t base
; /**< The base address of this bank */
85 uint32_t size
; /**< The size of this chip bank, in bytes */
87 int chip_width
; /**< Width of the chip in bytes (1,2,4 bytes) */
88 int bus_width
; /**< Maximum bus width, in bytes (1,2,4 bytes) */
91 * The number of sectors on this chip. This value will
92 * be set intially to 0, and the flash driver must set this to
93 * some non-zero value during "probe()" or "auto_probe()".
96 /// Array of sectors, allocated and initilized by the flash driver
97 struct flash_sector
*sectors
;
99 struct flash_bank
*next
; /**< The next flash bank on this chip */
102 /// Registers the 'flash' subsystem commands
103 int flash_register_commands(struct command_context
*cmd_ctx
);
106 * Erases @a length bytes in the @a target flash, starting at @a addr.
107 * The range @a addr to @a addr + @a length - 1 must be strictly
108 * sector aligned, unless @a pad is true. Setting @a pad true extends
109 * the range, at beginning and/or end, if needed for sector alignment.
110 * @returns ERROR_OK if successful; otherwise, an error code.
112 int flash_erase_address_range(struct target
*target
,
113 bool pad
, uint32_t addr
, uint32_t length
);
115 int flash_unlock_address_range(struct target
*target
, uint32_t addr
,
119 * Writes @a image into the @a target flash. The @a written parameter
121 * @param target The target with the flash to be programmed.
122 * @param image The image that will be programmed to flash.
123 * @param written On return, contains the number of bytes written.
124 * @param erase If non-zero, indicates the flash driver should first
125 * erase the corresponding banks or sectors before programming.
126 * @returns ERROR_OK if successful; otherwise, an error code.
128 int flash_write(struct target
*target
,
129 struct image
*image
, uint32_t *written
, int erase
);
132 * Forces targets to re-examine their erase/protection state.
133 * This routine must be called when the system may modify the status.
135 void flash_set_dirty(void);
136 /// @returns The number of flash banks currently defined.
137 int flash_get_bank_count(void);
139 * Provides default erased-bank check handling. Checks to see if
140 * the flash driver knows they are erased; if things look uncertain,
141 * this routine will call default_flash_mem_blank_check() to confirm.
142 * @returns ERROR_OK if successful; otherwise, an error code.
144 int default_flash_blank_check(struct flash_bank
*bank
);
146 * Provides a default blank flash memory check. Ensures the contents
147 * of the given bank have truly been erased.
148 * @param bank The flash bank.
149 * @returns ERROR_OK if successful; otherwise, an error code.
151 int default_flash_mem_blank_check(struct flash_bank
*bank
);
154 * Returns the flash bank specified by @a name, which matches the
155 * driver name and a suffix (option) specify the driver-specific
156 * bank number. The suffix consists of the '.' and the driver-specific
157 * bank number: when two str9x banks are defined, then 'str9x.1' refers
160 struct flash_bank
*get_flash_bank_by_name(const char *name
);
162 * Returns a flash bank by the specified flash_bank_s bank_number, @a num.
163 * @param num The flash bank number.
164 * @param bank returned bank if fn returns ERROR_OK
165 * @returns ERROR_OK if successful
167 int get_flash_bank_by_num(int num
, struct flash_bank
**bank
);
169 * Retreives @a bank from a command argument, reporting errors parsing
170 * the bank identifier or retreiving the specified bank. The bank
171 * may be identified by its bank number or by @c name.instance, where
172 * @a instance is driver-specific.
173 * @param name_index The index to the string in args containing the
175 * @param bank On output, contians a pointer to the bank or NULL.
176 * @returns ERROR_OK on success, or an error indicating the problem.
178 COMMAND_HELPER(flash_command_get_bank
, unsigned name_index
,
179 struct flash_bank
**bank
);
181 * Returns the flash bank like get_flash_bank_by_num(), without probing.
182 * @param num The flash bank number.
183 * @returns A struct flash_bank for flash bank @a num, or NULL.
185 struct flash_bank
*get_flash_bank_by_num_noprobe(int num
);
187 * Returns the flash bank located at a specified address.
188 * @param target The target, presumed to contain one or more banks.
189 * @param addr An address that is within the range of the bank.
190 * @returns The struct flash_bank located at @a addr, or NULL.
192 struct flash_bank
*get_flash_bank_by_addr(struct target
*target
, uint32_t addr
);
194 #endif // FLASH_NOR_CORE_H