error.h
Go to the documentation of this file.
1 /**
2  * @file error.h
3  * @brief Error codes description
4  *
5  * @section License
6  *
7  * Copyright (C) 2010-2018 Oryx Embedded SARL. All rights reserved.
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version 2
12  * of the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22  *
23  * @author Oryx Embedded SARL (www.oryx-embedded.com)
24  * @version 1.9.0
25  **/
26 
27 #ifndef _ERROR_H
28 #define _ERROR_H
29 
30 //C++ guard
31 #ifdef __cplusplus
32  extern "C" {
33 #endif
34 
35 
36 /**
37  * @brief Error codes
38  **/
39 
40 typedef enum
41 {
42  NO_ERROR = 0, ///<Success
43  ERROR_FAILURE = 1, ///<Generic error code
44 
45  ERROR_INVALID_PARAMETER, ///<Invalid parameter
46  ERROR_PARAMETER_OUT_OF_RANGE, ///<Specified parameter is out of range
47 
50  ERROR_INVALID_RECIPIENT, ///<Invalid recipient
51  ERROR_INVALID_INTERFACE, ///<Invalid interface
52  ERROR_INVALID_ENDPOINT, ///<Invalid endpoint
53  ERROR_INVALID_ALT_SETTING, ///<Alternate setting does not exist
54  ERROR_UNSUPPORTED_REQUEST, ///<Unsupported request
55  ERROR_UNSUPPORTED_CONFIGURATION, ///<Unsupported configuration
56  ERROR_UNSUPPORTED_FEATURE, ///<Unsupported feature
57  ERROR_ENDPOINT_BUSY, ///<Endpoint already in use
60 
71 
134 
139 
146 
149 
157 
160 
188 
190 
193 
200 
202 
209 
215 
219 
222 
238 
245 
249 
258 
261 
263 
266 } error_t;
267 
268 //C++ guard
269 #ifdef __cplusplus
270  }
271 #endif
272 
273 #endif
Generic error code.
Definition: error.h:43
Invalid parameter.
Definition: error.h:45
Unsupported feature.
Definition: error.h:56
Invalid recipient.
Definition: error.h:50
Alternate setting does not exist.
Definition: error.h:53
Invalid interface.
Definition: error.h:51
Unsupported configuration.
Definition: error.h:55
Endpoint already in use.
Definition: error.h:57
Unsupported request.
Definition: error.h:54
Success.
Definition: error.h:42
error_t
Error codes.
Definition: error.h:40
Invalid endpoint.
Definition: error.h:52
Specified parameter is out of range.
Definition: error.h:46