tcl/interface: snps_sdp: fix minor typo s/similiar/similar/
[openocd.git] / src / flash / common.h
1 /***************************************************************************
2 * Copyright (C) 2009 by Zachary T Welch <zw@superlucidity.net> *
3 * *
4 * This program is free software; you can redistribute it and/or modify *
5 * it under the terms of the GNU General Public License as published by *
6 * the Free Software Foundation; either version 2 of the License, or *
7 * (at your option) any later version. *
8 * *
9 * This program is distributed in the hope that it will be useful, *
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
12 * GNU General Public License for more details. *
13 * *
14 * You should have received a copy of the GNU General Public License *
15 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
16 ***************************************************************************/
17
18 #ifndef OPENOCD_FLASH_COMMON_H
19 #define OPENOCD_FLASH_COMMON_H
20
21 #include <helper/log.h>
22
23 /**
24 * Parses the optional '.index' portion of a flash bank identifier.
25 * @param name The desired driver name, passed by the user.
26 * @returns The parsed index request, or 0 if not present. If the
27 * name provides a suffix but it does not parse as an unsigned integer,
28 * the routine returns ~0U. This will prevent further matching.
29 */
30 unsigned get_flash_name_index(const char *name);
31 /**
32 * Attempt to match the @c expected name with the @c name of a driver.
33 * @param name The name of the driver (from the bank's device structure).
34 * @param expected The expected driver name, passed by the user.
35 */
36 bool flash_driver_name_matches(const char *name, const char *expected);
37
38 #define ERROR_FLASH_BANK_INVALID (-900)
39 #define ERROR_FLASH_SECTOR_INVALID (-901)
40 #define ERROR_FLASH_OPERATION_FAILED (-902)
41 #define ERROR_FLASH_DST_OUT_OF_BANK (-903)
42 #define ERROR_FLASH_DST_BREAKS_ALIGNMENT (-904)
43 #define ERROR_FLASH_BUSY (-905)
44 #define ERROR_FLASH_SECTOR_NOT_ERASED (-906)
45 #define ERROR_FLASH_BANK_NOT_PROBED (-907)
46 #define ERROR_FLASH_OPER_UNSUPPORTED (-908)
47 #define ERROR_FLASH_PROTECTED (-909)
48
49 #endif /* OPENOCD_FLASH_COMMON_H */