ARMv7-M: make DAP commands verify target is an ARMv7-M
[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, write to the *
16 * Free Software Foundation, Inc., *
17 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
18 ***************************************************************************/
19 #ifndef FLASH_COMMON_H
20 #define FLASH_COMMON_H
21
22 #include <helper/log.h>
23
24 /**
25 * Parses the optional '.index' portion of a flash bank identifier.
26 * @param name The desired driver name, passed by the user.
27 * @returns The parsed index request, or 0 if not present. If the
28 * name provides a suffix but it does not parse as an unsigned integer,
29 * the routine returns ~0U. This will prevent further matching.
30 */
31 unsigned get_flash_name_index(const char *name);
32 /**
33 * Attempt to match the @c expected name with the @c name of a driver.
34 * @param name The name of the driver (from the bank's device structure).
35 * @param expected The expected driver name, passed by the user.
36 */
37 bool flash_driver_name_matches(const char *name, const char *expected);
38
39 #define ERROR_FLASH_BANK_INVALID -900
40 #define ERROR_FLASH_SECTOR_INVALID -901
41 #define ERROR_FLASH_OPERATION_FAILED -902
42 #define ERROR_FLASH_DST_OUT_OF_BANK -903
43 #define ERROR_FLASH_DST_BREAKS_ALIGNMENT -904
44 #define ERROR_FLASH_BUSY -905
45 #define ERROR_FLASH_SECTOR_NOT_ERASED -906
46 #define ERROR_FLASH_BANK_NOT_PROBED -907
47
48 #endif // FLASH_COMMON_H