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