1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 /***************************************************************************
4 * Copyright (C) 2005 by Dominic Rath <Dominic.Rath@gmx.de> *
5 * Copyright (C) 2007,2008 Øyvind Harboe <oyvind.harboe@zylin.com> *
6 * Copyright (C) 2008 by Spencer Oliver <spen@spen-soft.co.uk> *
7 * Copyright (C) 2009 Zachary T Welch <zw@superlucidity.net> *
8 * Copyright (C) 2010 by Antonio Borneo <borneo.antonio@gmail.com> *
9 ***************************************************************************/
11 #ifndef OPENOCD_FLASH_NOR_CORE_H
12 #define OPENOCD_FLASH_NOR_CORE_H
14 #include <flash/common.h>
18 * Upper level NOR flash interfaces.
23 #define FLASH_MAX_ERROR_STR (128)
26 * Describes the geometry and status of a single flash sector
27 * within a flash bank. A single bank typically consists of multiple
28 * sectors, each of which can be erased and protected independently.
31 /** Bus offset from start of the flash chip (in bytes). */
33 /** Number of bytes in this flash sector. */
36 * Indication of erasure status: 0 = not erased, 1 = erased,
37 * other = unknown. Set by @c flash_driver_s::erase_check only.
39 * This information must be considered stale immediately.
40 * Don't set it in flash_driver_s::erase or a device mass_erase
41 * Don't clear it in flash_driver_s::write
42 * The flag is not used in a protection block
46 * Indication of protection status: 0 = unprotected/unlocked,
47 * 1 = protected/locked, other = unknown. Set by
48 * @c flash_driver_s::protect_check.
50 * This information must be considered stale immediately.
51 * A million things could make it stale: power cycle,
52 * reset of target, code running on target, etc.
54 * If a flash_bank uses an extra array of protection blocks,
55 * protection flag is not valid in sector array
60 /** Special value for write_start_alignment and write_end_alignment field */
61 #define FLASH_WRITE_ALIGN_SECTOR UINT32_MAX
63 /** Special values for minimal_write_gap field */
64 #define FLASH_WRITE_CONTINUOUS 0
65 #define FLASH_WRITE_GAP_SECTOR UINT32_MAX
68 * Provides details of a flash bank, available either on-chip or through
71 * This structure will be passed as a parameter to the callbacks in the
72 * flash_driver_s structure, some of which may modify the contents of
73 * this structure of the area of flash that it defines. Driver writers
74 * may use the @c driver_priv member to store additional data on a
75 * per-bank basis, if required.
80 struct target *target; /**< Target to which this bank belongs. */
82 const struct flash_driver *driver; /**< Driver for this bank. */
83 void *driver_priv; /**< Private driver storage pointer */
85 unsigned int bank_number; /**< The 'bank' (or chip number) of this instance. */
86 target_addr_t base; /**< The base address of this bank */
87 uint32_t size; /**< The size of this chip bank, in bytes */
89 unsigned int chip_width; /**< Width of the chip in bytes (1,2,4 bytes) */
90 unsigned int bus_width; /**< Maximum bus width, in bytes (1,2,4 bytes) */
92 /** Erased value. Defaults to 0xFF. */
95 /** Default padded value used, normally this matches the flash
96 * erased value. Defaults to 0xFF. */
97 uint8_t default_padded_value;
99 /** Required alignment of flash write start address.
100 * Default 0, no alignment. Can be any power of two or FLASH_WRITE_ALIGN_SECTOR */
101 uint32_t write_start_alignment;
102 /** Required alignment of flash write end address.
103 * Default 0, no alignment. Can be any power of two or FLASH_WRITE_ALIGN_SECTOR */
104 uint32_t write_end_alignment;
105 /** Minimal gap between sections to discontinue flash write
106 * Default FLASH_WRITE_GAP_SECTOR splits the write if one or more untouched
107 * sectors in between.
108 * Can be size in bytes or FLASH_WRITE_CONTINUOUS */
109 uint32_t minimal_write_gap;
112 * The number of sectors on this chip. This value will
113 * be set initially to 0, and the flash driver must set this to
114 * some non-zero value during "probe()" or "auto_probe()".
116 unsigned int num_sectors;
117 /** Array of sectors, allocated and initialized by the flash driver */
118 struct flash_sector *sectors;
121 * The number of protection blocks in this bank. This value
122 * is set initially to 0 and sectors are used as protection blocks.
123 * Driver probe can set protection blocks array to work with
124 * protection granularity different than sector size.
126 unsigned int num_prot_blocks;
127 /** Array of protection blocks, allocated and initialized by the flash driver */
128 struct flash_sector *prot_blocks;
130 struct flash_bank *next; /**< The next flash bank on this chip */
133 /** Registers the 'flash' subsystem commands */
134 int flash_register_commands(struct command_context *cmd_ctx);
137 * Erases @a length bytes in the @a target flash, starting at @a addr.
138 * The range @a addr to @a addr + @a length - 1 must be strictly
139 * sector aligned, unless @a pad is true. Setting @a pad true extends
140 * the range, at beginning and/or end, if needed for sector alignment.
141 * @returns ERROR_OK if successful; otherwise, an error code.
143 int flash_erase_address_range(struct target *target,
144 bool pad, target_addr_t addr, uint32_t length);
146 int flash_unlock_address_range(struct target *target, target_addr_t addr,
150 * Align start address of a flash write region according to bank requirements.
151 * @param bank Pointer to bank descriptor structure
152 * @param addr Address to align
153 * @returns Aligned address
155 target_addr_t flash_write_align_start(struct flash_bank *bank, target_addr_t addr);
157 * Align end address of a flash write region according to bank requirements.
158 * Note: Use address of the last byte to write, not the next after the region.
159 * @param bank Pointer to bank descriptor structure
160 * @param addr Address to align (address of the last byte to write)
161 * @returns Aligned address (address of the last byte of padded region)
163 target_addr_t flash_write_align_end(struct flash_bank *bank, target_addr_t addr);
166 * Writes @a image into the @a target flash. The @a written parameter
168 * @param target The target with the flash to be programmed.
169 * @param image The image that will be programmed to flash.
170 * @param written On return, contains the number of bytes written.
171 * @param erase Indicates whether the flash driver should first
172 * erase the corresponding banks or sectors before programming.
173 * @returns ERROR_OK if successful; otherwise, an error code.
175 int flash_write(struct target *target,
176 struct image *image, uint32_t *written, bool erase);
179 * Forces targets to re-examine their erase/protection state.
180 * This routine must be called when the system may modify the status.
182 void flash_set_dirty(void);
184 /** @returns The number of flash banks currently defined. */
185 unsigned int flash_get_bank_count(void);
187 /** Deallocates bank->driver_priv */
188 void default_flash_free_driver_priv(struct flash_bank *bank);
190 /** Deallocates all flash banks */
191 void flash_free_all_banks(void);
194 * Provides default read implementation for flash memory.
195 * @param bank The bank to read.
196 * @param buffer The data bytes read.
197 * @param offset The offset into the chip to read.
198 * @param count The number of bytes to read.
199 * @returns ERROR_OK if successful; otherwise, an error code.
201 int default_flash_read(struct flash_bank *bank,
202 uint8_t *buffer, uint32_t offset, uint32_t count);
205 * Provides default verify implementation for flash memory.
206 * @param bank The bank to verify.
207 * @param buffer The data bytes to verify.
208 * @param offset The offset into the chip to verify.
209 * @param count The number of bytes to verify.
210 * @returns ERROR_OK if successful; otherwise, an error code.
212 int default_flash_verify(struct flash_bank *bank,
213 const uint8_t *buffer, uint32_t offset, uint32_t count);
216 * Provides default erased-bank check handling. Checks to see if
217 * the flash driver knows they are erased; if things look uncertain,
218 * this routine will call default_flash_mem_blank_check() to confirm.
219 * @returns ERROR_OK if successful; otherwise, an error code.
221 int default_flash_blank_check(struct flash_bank *bank);
223 * Returns the flash bank specified by @a name, which matches the
224 * driver name and a suffix (option) specify the driver-specific
225 * bank number. The suffix consists of the '.' and the driver-specific
226 * bank number: when two str9x banks are defined, then 'str9x.1' refers
229 int get_flash_bank_by_name(const char *name, struct flash_bank **bank_result);
231 * Returns the flash bank specified by @a name, which matches the
232 * driver name and a suffix (option) specify the driver-specific
233 * bank number. The suffix consists of the '.' and the driver-specific
234 * bank number: when two str9x banks are defined, then 'str9x.1' refers
237 struct flash_bank *get_flash_bank_by_name_noprobe(const char *name);
239 * Returns the flash bank like get_flash_bank_by_name(), without probing.
240 * @param num The flash bank number.
241 * @param bank returned bank if fn returns ERROR_OK
242 * @returns ERROR_OK if successful
244 int get_flash_bank_by_num(unsigned int num, struct flash_bank **bank);
246 * Retrieves @a bank from a command argument, reporting errors parsing
247 * the bank identifier or retrieving the specified bank. The bank
248 * may be identified by its bank number or by @c name.instance, where
249 * @a instance is driver-specific.
250 * @param name_index The index to the string in args containing the
252 * @param bank On output, contains a pointer to the bank or NULL.
253 * @returns ERROR_OK on success, or an error indicating the problem.
255 COMMAND_HELPER(flash_command_get_bank, unsigned name_index,
256 struct flash_bank **bank);
258 * Returns the flash bank like get_flash_bank_by_num(), without probing.
259 * @param num The flash bank number.
260 * @returns A struct flash_bank for flash bank @a num, or NULL.
262 struct flash_bank *get_flash_bank_by_num_noprobe(unsigned int num);
264 * Returns the flash bank located at a specified address.
265 * @param target The target, presumed to contain one or more banks.
266 * @param addr An address that is within the range of the bank.
267 * @param check return ERROR_OK and result_bank NULL if the bank does not exist
268 * @param result_bank The struct flash_bank located at @a addr, or NULL.
269 * @returns ERROR_OK on success, or an error indicating the problem.
271 int get_flash_bank_by_addr(struct target *target, target_addr_t addr, bool check,
272 struct flash_bank **result_bank);
274 * Allocate and fill an array of sectors or protection blocks.
275 * @param offset Offset of first block.
276 * @param size Size of each block.
277 * @param num_blocks Number of blocks in array.
278 * @returns A struct flash_sector pointer or NULL when allocation failed.
280 struct flash_sector *alloc_block_array(uint32_t offset, uint32_t size,
281 unsigned int num_blocks);
283 #endif /* OPENOCD_FLASH_NOR_CORE_H */