726dd957ececc37802d2f072d793aee3654d63fe
[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, write to the *
20 * Free Software Foundation, Inc., *
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
22 ***************************************************************************/
23
24 #ifndef FLASH_NOR_CORE_H
25 #define FLASH_NOR_CORE_H
26
27 #include <flash/common.h>
28
29 /**
30 * @file
31 * Upper level NOR flash interfaces.
32 */
33
34 struct image;
35
36 #define FLASH_MAX_ERROR_STR (128)
37
38 /**
39 * Describes the geometry and status of a single flash sector
40 * within a flash bank. A single bank typically consists of multiple
41 * sectors, each of which can be erased and protected independently.
42 */
43 struct flash_sector {
44 /** Bus offset from start of the flash chip (in bytes). */
45 uint32_t offset;
46 /** Number of bytes in this flash sector. */
47 uint32_t size;
48 /**
49 * Indication of erasure status: 0 = not erased, 1 = erased,
50 * other = unknown. Set by @c flash_driver_s::erase_check.
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 int is_protected;
63 };
64
65 /**
66 * Provides details of a flash bank, available either on-chip or through
67 * a major interface.
68 *
69 * This structure will be passed as a parameter to the callbacks in the
70 * flash_driver_s structure, some of which may modify the contents of
71 * this structure of the area of flash that it defines. Driver writers
72 * may use the @c driver_priv member to store additional data on a
73 * per-bank basis, if required.
74 */
75 struct flash_bank {
76 const char *name;
77
78 struct target *target; /**< Target to which this bank belongs. */
79
80 struct flash_driver *driver; /**< Driver for this bank. */
81 void *driver_priv; /**< Private driver storage pointer */
82
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 */
86
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) */
89
90 /** Default padded value used, normally this matches the flash
91 * erased value. Defaults to 0xFF. */
92 uint8_t default_padded_value;
93
94 /**
95 * The number of sectors on this chip. This value will
96 * be set intially to 0, and the flash driver must set this to
97 * some non-zero value during "probe()" or "auto_probe()".
98 */
99 int num_sectors;
100 /** Array of sectors, allocated and initilized by the flash driver */
101 struct flash_sector *sectors;
102
103 struct flash_bank *next; /**< The next flash bank on this chip */
104 };
105
106 /** Registers the 'flash' subsystem commands */
107 int flash_register_commands(struct command_context *cmd_ctx);
108
109 /**
110 * Erases @a length bytes in the @a target flash, starting at @a addr.
111 * The range @a addr to @a addr + @a length - 1 must be strictly
112 * sector aligned, unless @a pad is true. Setting @a pad true extends
113 * the range, at beginning and/or end, if needed for sector alignment.
114 * @returns ERROR_OK if successful; otherwise, an error code.
115 */
116 int flash_erase_address_range(struct target *target,
117 bool pad, uint32_t addr, uint32_t length);
118
119 int flash_unlock_address_range(struct target *target, uint32_t addr,
120 uint32_t length);
121
122 /**
123 * Writes @a image into the @a target flash. The @a written parameter
124 * will contain the
125 * @param target The target with the flash to be programmed.
126 * @param image The image that will be programmed to flash.
127 * @param written On return, contains the number of bytes written.
128 * @param erase If non-zero, indicates the flash driver should first
129 * erase the corresponding banks or sectors before programming.
130 * @returns ERROR_OK if successful; otherwise, an error code.
131 */
132 int flash_write(struct target *target,
133 struct image *image, uint32_t *written, int erase);
134
135 /**
136 * Forces targets to re-examine their erase/protection state.
137 * This routine must be called when the system may modify the status.
138 */
139 void flash_set_dirty(void);
140 /** @returns The number of flash banks currently defined. */
141 int flash_get_bank_count(void);
142 /**
143 * Provides default read implementation for flash memory.
144 * @param bank The bank to read.
145 * @param buffer The data bytes read.
146 * @param offset The offset into the chip to read.
147 * @param count The number of bytes to read.
148 * @returns ERROR_OK if successful; otherwise, an error code.
149 */
150 int default_flash_read(struct flash_bank *bank,
151 uint8_t *buffer, uint32_t offset, uint32_t count);
152 /**
153 * Provides default erased-bank check handling. Checks to see if
154 * the flash driver knows they are erased; if things look uncertain,
155 * this routine will call default_flash_mem_blank_check() to confirm.
156 * @returns ERROR_OK if successful; otherwise, an error code.
157 */
158 int default_flash_blank_check(struct flash_bank *bank);
159
160 /**
161 * Returns the flash bank specified by @a name, which matches the
162 * driver name and a suffix (option) specify the driver-specific
163 * bank number. The suffix consists of the '.' and the driver-specific
164 * bank number: when two str9x banks are defined, then 'str9x.1' refers
165 * to the second.
166 */
167 int get_flash_bank_by_name(const char *name, struct flash_bank **bank_result);
168 /**
169 * Returns the flash bank specified by @a name, which matches the
170 * driver name and a suffix (option) specify the driver-specific
171 * bank number. The suffix consists of the '.' and the driver-specific
172 * bank number: when two str9x banks are defined, then 'str9x.1' refers
173 * to the second.
174 */
175 struct flash_bank *get_flash_bank_by_name_noprobe(const char *name);
176 /**
177 * Returns the flash bank like get_flash_bank_by_name(), without probing.
178 * @param num The flash bank number.
179 * @param bank returned bank if fn returns ERROR_OK
180 * @returns ERROR_OK if successful
181 */
182 int get_flash_bank_by_num(int num, struct flash_bank **bank);
183 /**
184 * Retreives @a bank from a command argument, reporting errors parsing
185 * the bank identifier or retreiving the specified bank. The bank
186 * may be identified by its bank number or by @c name.instance, where
187 * @a instance is driver-specific.
188 * @param name_index The index to the string in args containing the
189 * bank identifier.
190 * @param bank On output, contians a pointer to the bank or NULL.
191 * @returns ERROR_OK on success, or an error indicating the problem.
192 */
193 COMMAND_HELPER(flash_command_get_bank, unsigned name_index,
194 struct flash_bank **bank);
195 /**
196 * Returns the flash bank like get_flash_bank_by_num(), without probing.
197 * @param num The flash bank number.
198 * @returns A struct flash_bank for flash bank @a num, or NULL.
199 */
200 struct flash_bank *get_flash_bank_by_num_noprobe(int num);
201 /**
202 * Returns the flash bank located at a specified address.
203 * @param target The target, presumed to contain one or more banks.
204 * @param addr An address that is within the range of the bank.
205 * @param check return ERROR_OK and result_bank NULL if the bank does not exist
206 * @returns The struct flash_bank located at @a addr, or NULL.
207 */
208 int get_flash_bank_by_addr(struct target *target, uint32_t addr, bool check,
209 struct flash_bank **result_bank);
210
211 #endif /* FLASH_NOR_CORE_H */