src/flash: remove 'extern' and wrap headers
[openocd.git] / src / flash / flash.h
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2007,2008 √ėyvind Harboe *
6 * oyvind.harboe@zylin.com *
7 * *
8 * Copyright (C) 2008 by Spencer Oliver *
9 * spen@spen-soft.co.uk *
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 * This program is distributed in the hope that it will be useful, *
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
19 * GNU General Public License for more details. *
20 * *
21 * You should have received a copy of the GNU General Public License *
22 * along with this program; if not, write to the *
23 * Free Software Foundation, Inc., *
24 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
25 ***************************************************************************/
26 #ifndef FLASH_H
27 #define FLASH_H
28
29 #include "target.h"
30 #include "log.h"
31
32 struct image_s;
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 typedef struct flash_sector_s
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 } flash_sector_t;
59
60 struct flash_bank_s;
61
62 /**
63 * @brief Provides the implementation-independent structure that defines
64 * all of the callbacks required by OpenOCD flash drivers.
65 *
66 * Driver authors must implement the routines defined here, providing an
67 * instance with the fields filled out. After that, the instance must
68 * be registered in flash.c, so it can be used by the driver lookup system.
69 *
70 * Specifically, the user can issue the command: @par
71 * @code
72 * flash bank DRIVERNAME ...parameters...
73 * @endcode
74 *
75 * OpenOCD will search for the driver with a @c flash_driver_s::name
76 * that matches @c DRIVERNAME.
77 *
78 * The flash subsystem calls some of the other drivers routines a using
79 * corresponding static <code>flash_driver_<i>callback</i>()</code>
80 * routine in flash.c.
81 */
82 typedef struct flash_driver_s
83 {
84 /**
85 * Gives a human-readable name of this flash driver,
86 * This field is used to select and initialize the driver.
87 */
88 char *name;
89
90 /**
91 * Registers driver-specific commands. When called (during the
92 * "flash bank" command), the driver may register addition
93 * commands to support new flash chip functions.
94 *
95 * @returns ERROR_OK if successful; otherwise, an error code.
96 */
97 int (*register_commands)(struct command_context_s *cmd_ctx);
98
99 /**
100 * Finish the "flash bank" command for @a bank. The
101 * @a bank parameter will have been filled in by the core flash
102 * layer when this routine is called, and the driver can store
103 * additional information in its flash_bank_t::driver_priv field.
104 *
105 * @param cmd_ctx - the command context
106 * @param cmd - the command, in this case 'flash'
107 * @param args - parameters, see below
108 * @param argc - number of parameters on command line
109 * @param bank - new filled in flash bank.
110 *
111 * The args are: @par
112 * @code
113 * args[0] = bank
114 * args[1] = drivername {name above}
115 * args[2] = baseaddress
116 * args[3] = lengthbytes
117 * args[4] = chip_width_in bytes
118 * args[5] = bus_width_bytes
119 * args[6] = driver-specific parameters
120 * @endcode
121 *
122 * For example, args[4] = 16 bit flash, args[5] = 32bit bus.
123 *
124 * If extra arguments are provided (@a argc > 6), they will
125 * start in @a args[6]. These can be used to implement
126 * driver-specific extensions.
127 *
128 * @returns ERROR_OK if successful; otherwise, an error code.
129 */
130 int (*flash_bank_command)(struct command_context_s *cmd_ctx,
131 char *cmd, char **args, int argc, struct flash_bank_s *bank);
132
133 /**
134 * Bank/sector erase routine (target-specific). When
135 * called, the flash driver should erase the specified sectors
136 * using whatever means are at its disposal.
137 *
138 * @param bank The bank of flash to be erased.
139 * @param first The number of the first sector to erase, typically 0.
140 * @param last The number of the last sector to erase, typically N-1.
141 * @returns ERROR_OK if successful; otherwise, an error code.
142 */
143 int (*erase)(struct flash_bank_s *bank, int first, int last);
144
145 /**
146 * Bank/sector protection routine (target-specific).
147 * When called, the driver should disable 'flash write' bits (or
148 * enable 'erase protection' bits) for the given @a bank and @a
149 * sectors.
150 *
151 * @param bank The bank to protect or unprotect.
152 * @param set If non-zero, enable protection; if 0, disable it.
153 * @param first The first sector to (un)protect, typicaly 0.
154 * @param last The last sector to (un)project, typically N-1.
155 * @returns ERROR_OK if successful; otherwise, an error code.
156 */
157 int (*protect)(struct flash_bank_s *bank, int set, int first, int last);
158
159 /**
160 * Program data into the flash. Note CPU address will be
161 * "bank->base + offset", while the physical address is
162 * dependent upon current target MMU mappings.
163 *
164 * @param bank The bank to program
165 * @param buffer The data bytes to write.
166 * @param offset The offset into the chip to program.
167 * @param count The number of bytes to write.
168 * @returns ERROR_OK if successful; otherwise, an error code.
169 */
170 int (*write)(struct flash_bank_s *bank,
171 uint8_t *buffer, uint32_t offset, uint32_t count);
172
173 /**
174 * Probe to determine what kind of flash is present.
175 * This is invoked by the "probe" script command.
176 *
177 * @param bank The bank to probe
178 * @returns ERROR_OK if successful; otherwise, an error code.
179 */
180 int (*probe)(struct flash_bank_s *bank);
181
182 /**
183 * Check the erasure status of a flash bank.
184 * When called, the driver routine must perform the required
185 * checks and then set the @c flash_sector_s::is_erased field
186 * for each of the flash banks's sectors.
187 *
188 * @param bank The bank to check
189 * @returns ERROR_OK if successful; otherwise, an error code.
190 */
191 int (*erase_check)(struct flash_bank_s *bank);
192
193 /**
194 * Determine if the specific bank is "protected" or not.
195 * When called, the driver routine must must perform the
196 * required protection check(s) and then set the @c
197 * flash_sector_s::is_protected field for each of the flash
198 * bank's sectors.
199 *
200 * @param bank - the bank to check
201 * @returns ERROR_OK if successful; otherwise, an error code.
202 */
203 int (*protect_check)(struct flash_bank_s *bank);
204
205 /**
206 * Display human-readable information about the flash
207 * bank into the given buffer. Drivers must be careful to avoid
208 * overflowing the buffer.
209 *
210 * @param bank - the bank to get info about
211 * @param char - where to put the text for the human to read
212 * @param buf_size - the size of the human buffer.
213 * @returns ERROR_OK if successful; otherwise, an error code.
214 */
215 int (*info)(struct flash_bank_s *bank, char *buf, int buf_size);
216
217 /**
218 * A more gentle flavor of filash_driver_s::probe, performing
219 * setup with less noise. Generally, driver routines should test
220 * to seee if the bank has already been probed; if it has, the
221 * driver probably should not perform its probe a second time.
222 *
223 * This callback is often called from the inside of other
224 * routines (e.g. GDB flash downloads) to autoprobe the flash as
225 * it is programing the flash.
226 *
227 * @param bank - the bank to probe
228 * @returns ERROR_OK if successful; otherwise, an error code.
229 */
230 int (*auto_probe)(struct flash_bank_s *bank);
231 } flash_driver_t;
232
233 /**
234 * Provides details of a flash bank, available either on-chip or through
235 * a major interface.
236 *
237 * This structure will be passed as a parameter to the callbacks in the
238 * flash_driver_s structure, some of which may modify the contents of
239 * this structure of the area of flash that it defines. Driver writers
240 * may use the @c driver_priv member to store additional data on a
241 * per-bank basis, if required.
242 */
243 typedef struct flash_bank_s
244 {
245 struct target_s *target; /**< Target to which this bank belongs. */
246
247 flash_driver_t *driver; /**< Driver for this bank. */
248 void *driver_priv; /**< Private driver storage pointer */
249
250 int bank_number; /**< The 'bank' (or chip number) of this instance. */
251 uint32_t base; /**< The base address of this bank */
252 uint32_t size; /**< The size of this chip bank, in bytes */
253
254 int chip_width; /**< Width of the chip in bytes (1,2,4 bytes) */
255 int bus_width; /**< Maximum bus width, in bytes (1,2,4 bytes) */
256
257 /**
258 * The number of sectors on this chip. This value will
259 * be set intially to 0, and the flash driver must set this to
260 * some non-zero value during "probe()" or "auto_probe()".
261 */
262 int num_sectors;
263 /// Array of sectors, allocated and initilized by the flash driver
264 flash_sector_t *sectors;
265
266 struct flash_bank_s *next; /**< The next flash bank on this chip */
267 } flash_bank_t;
268
269 /// Registers the 'flash' subsystem commands
270 int flash_register_commands(struct command_context_s *cmd_ctx);
271 /// Initializes the 'flash' subsystem drivers
272 int flash_init_drivers(struct command_context_s *cmd_ctx);
273
274 /**
275 * Erases @a length bytes in the @a target flash, starting at @a addr.
276 * @returns ERROR_OK if successful; otherwise, an error code.
277 */
278 int flash_erase_address_range(struct target_s *target,
279 uint32_t addr, uint32_t length);
280 /**
281 * Writes @a image into the @a target flash. The @a written parameter
282 * will contain the
283 * @param target The target with the flash to be programmed.
284 * @param image The image that will be programmed to flash.
285 * @param written On return, contains the number of bytes written.
286 * @param erase If non-zero, indicates the flash driver should first
287 * erase the corresponding banks or sectors before programming.
288 * @returns ERROR_OK if successful; otherwise, an error code.
289 */
290 int flash_write(struct target_s *target,
291 struct image_s *image, uint32_t *written, int erase);
292 /**
293 * Forces targets to re-examine their erase/protection state.
294 * This routine must be called when the system may modify the status.
295 */
296 void flash_set_dirty(void);
297 /// @returns The number of flash banks currently defined.
298 int flash_get_bank_count(void);
299 /**
300 * Provides default erased-bank check handling. Checks to see if
301 * the flash driver knows they are erased; if things look uncertain,
302 * this routine will call default_flash_mem_blank_check() to confirm.
303 * @returns ERROR_OK if successful; otherwise, an error code.
304 */
305 int default_flash_blank_check(struct flash_bank_s *bank);
306 /**
307 * Provides a default blank flash memory check. Ensures the contents
308 * of the given bank have truly been erased.
309 * @param bank The flash bank.
310 * @returns ERROR_OK if successful; otherwise, an error code.
311 */
312 int default_flash_mem_blank_check(struct flash_bank_s *bank);
313
314 /**
315 * Returns a flash bank by the specified flash_bank_s bank_number, @a num.
316 * @param num The flash bank number.
317 * @returns A flash_bank_t for flash bank @a num, or NULL
318 */
319 flash_bank_t *get_flash_bank_by_num(int num);
320 /**
321 * Retreives @a bank from a command argument, reporting errors parsing
322 * the bank identifier or retreiving the specified bank.
323 * @param cmd_ctx The command context for reporting errors.
324 * @param str The string containing the bank identifier.
325 * @param bank On output, contians a pointer to the bank or NULL.
326 * @returns ERROR_OK on success, or an error indicating the problem.
327 */
328 int flash_command_get_bank_by_num(struct command_context_s *cmd_ctx,
329 char *str, flash_bank_t **bank);
330 /**
331 * Returns the flash bank like get_flash_bank_by_num(), without probing.
332 * @param num The flash bank number.
333 * @returns A flash_bank_t for flash bank @a num, or NULL.
334 */
335 flash_bank_t *get_flash_bank_by_num_noprobe(int num);
336 /**
337 * Returns the flash bank located at a specified address.
338 * @param target The target, presumed to contain one or more banks.
339 * @param addr An address that is within the range of the bank.
340 * @returns The flash_bank_t located at @a addr, or NULL.
341 */
342 flash_bank_t *get_flash_bank_by_addr(struct target_s *target, uint32_t addr);
343
344 #define ERROR_FLASH_BANK_INVALID (-900)
345 #define ERROR_FLASH_SECTOR_INVALID (-901)
346 #define ERROR_FLASH_OPERATION_FAILED (-902)
347 #define ERROR_FLASH_DST_OUT_OF_BANK (-903)
348 #define ERROR_FLASH_DST_BREAKS_ALIGNMENT (-904)
349 #define ERROR_FLASH_BUSY (-905)
350 #define ERROR_FLASH_SECTOR_NOT_ERASED (-906)
351 #define ERROR_FLASH_BANK_NOT_PROBED (-907)
352
353 #endif /* FLASH_H */