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