-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathErrorsDef.h
327 lines (304 loc) · 20.7 KB
/
ErrorsDef.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
/*!****************************************************************************
* @file ErrorsDef.h
* @author Fabien MAILLY
* @version 1.0.0
* @date 24/08/2020
* @brief Errors definitions
*
* @details These errors definitions are compatibles with all the libraries
* realized by the author
*****************************************************************************/
/* @page License
*
* Copyright (c) 2020-2023 Fabien MAILLY
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS,
* IMPLIED OR STATUTORY, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
* EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
* OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*****************************************************************************/
#ifndef ERRORSDEF_H_
#define ERRORSDEF_H_
//=============================================================================
//-----------------------------------------------------------------------------
#ifdef __cplusplus
extern "C" {
#endif
//-----------------------------------------------------------------------------
/*! @defgroup ErrorsContexts Errors and contexts
* @details These defines sets contexts on errors
* To do this, create a file named 'Specific_Target.c' and 'Specific_Target.h' with target a revelant name for the target platform (example 'Specific_MC_STM32G4.c' and 'Specific_MC_STM32G4.h')
*
* Use in a '.c' file like this:
* @code {.c}
* #include "ErrorsDef.h"
* //------------------------------------------------------------------------------
* #define UNIT_ERR_CONTEXT ERRCONTEXT__TIMERTICKS // Error context of this unit
* //------------------------------------------------------------------------------
*
* eERRORRESULT ExampleFunction(void)
* {
* // Do stuff
* if (a != b) return ERR_GENERATE(ERR__BAD_DATA); // This will combine the ERRCONTEXT__TIMERTICKS context with the ERR__BAD_DATA error
* return ERR_NONE; // This one have an optional a context
* }
* @endcode
*
* If the error and context need to be show on, for example a console log, use this:
* @code {.c}
* //==============================================================================
* // Show the current error on console
* //==============================================================================
* void ShowErrorOnConsole(eERRORRESULT error)
* {
* char* pErrStr = NULL;
* char* pContextStr = NULL;
*
* //--- Get error ---
* eERRORRESULT ErrorDef = ERR_ERROR_Get(error);
* if (ErrorDef == ERR_NONE) return; // No error? Exit
* if (ErrorDef < ERR__ERRORS_MAX) pErrStr = (char*)ERR_ErrorStrings[ErrorDef];
* //--- Get context ---
* eERRORCONTEXTS ErrorContext = ERR_ERROR_CONTEXT_Get(error);
* if (ErrorContext < ERRCONTEXT__CONTEXTS_MAX) pContextStr = (char*)ERRCONTEXT_ContextStrings[ErrorContext];
* //--- Show error ---
* if (pErrStr != NULL)
* {
* if ((pContextStr != NULL) && (ErrorContext != ERRCONTEXT_NO_CONTEXT))
* LOGERROR("%s: %s", pContextStr, pErrStr);
* else LOGERROR("%s", pErrStr);
* }
* else LOGERROR("Unknown error: %u", error);
* }
* @endcode
*
* @{
*/
// Contextualize the error
#define ERR_ERROR_CONTEXT_Pos 8
#define ERR_ERROR_CONTEXT_Mask (0xFF << ERR_ERROR_CONTEXT_Pos)
#define ERR_ERROR_CONTEXT_Get(error) (eERRORRESULT)(((uint32_t)(error) & ERR_ERROR_CONTEXT_Mask) >> ERR_ERROR_CONTEXT_Pos) //!< Get the context of the error
#define ERR_ERROR_CONTEXT_Set(context) (((uint32_t)(context) << ERR_ERROR_CONTEXT_Pos) & ERR_ERROR_CONTEXT_Mask) //!< Set the context of the error
#define ERR_ERROR_Get(error) (eERRORRESULT)((uint32_t)(error) & ~ERR_ERROR_CONTEXT_Mask) //!< Get the error (ie. isolate the error from the context)
#define ERR_ERROR_Set(error) ((uint32_t)(error) & ~ERR_ERROR_CONTEXT_Mask) //!< Set the error
#define ERR_CONTEXTUALIZE(context,error) ( (error) != ERR_NONE ? (eERRORRESULT)(ERR_ERROR_CONTEXT_Set(context) | ERR_ERROR_Set(error)) : ERR_NONE ) //!< Combine the context and the error. Will be simplified at compile time if error is fixed
#define ERR_GENERATE(error) ERR_CONTEXTUALIZE(UNIT_ERR_CONTEXT,(error)) //!< UNIT_ERR_CONTEXT is set on the .c file and is specific to a .c file. It will contain an eERRORCONTEXTS
//------------------------------------------------------------------------------
//**********************************************************************************************************************************************************
//********************************************************************************************************************
// Contexts definitions
//********************************************************************************************************************
// WARNING! Here after use the X-Macros. See on Internet how it works before modifying something
#define CONTEXTS_TABLE \
/* //--- No specific context --- */\
X(ERRCONTEXT_NO_CONTEXT , = 0, "No context" ) \
/* //--- Contexts list --- */\
X(ERRCONTEXT__TIMERTICKS , , "TimerTicks" ) \
X(ERRCONTEXT__INTERNALSTATE, , "InternalState") \
X(ERRCONTEXT__EEPROM , , "EEPROM" )
//------------------------------------------------------------------------------
//! Function's return errors context enumerator
typedef enum
{
#ifdef USE_REDUCED_ERRORS_VALUE
# define X(eName, val, str) eName,
#else
# define X(eName, val, str) eName val, //eName = val,
#endif
CONTEXTS_TABLE
#undef X
ERRCONTEXT__CONTEXTS_MAX, // Keep here
ERRCONTEXT__ENUM_MAX_16BITS = 0xFFFF, // Here to force 16-bit enum
} eERRORCONTEXTS;
#define X(eName, val, str) +1
#define ERRCONTEXT__CONTEXTS_COUNT ( 0 CONTEXTS_TABLE )
#undef X
//------------------------------------------------------------------------------
//! Errors context string table
#ifdef USE_ERRORS_STRING
//! Errors string table
static const char* const ERRCONTEXT_ContextStrings[] =
{
#define X(eName, val, str) [eName] = str,
CONTEXTS_TABLE
#undef X
};
#endif
//------------------------------------------------------------------------------
//**********************************************************************************************************************************************************
//********************************************************************************************************************
// Errors definitions
//********************************************************************************************************************
// WARNING! Here after use the X-Macros. See on Internet how it works before modifying something
#define ERRORS_TABLE \
/* //--- Success --- */\
X(ERR_NONE , = 0, "Succeeded" ) \
/* //--- General errors --- */\
X(ERR__NO_DEVICE_DETECTED , , "No device detected" ) \
X(ERR__OUT_OF_RANGE , , "Value out of range" ) \
X(ERR__UNKNOWN_ELEMENT , , "Unknown element (type or value)" ) \
X(ERR__CONFIGURATION , , "Configuration error" ) \
X(ERR__NOT_SUPPORTED , , "Not supported" ) \
X(ERR__OUT_OF_MEMORY , , "Out of memory" ) \
X(ERR__NOT_AVAILABLE , , "Function not available" ) \
X(ERR__DEVICE_TIMEOUT , , "Device timeout" ) \
X(ERR__PARAMETER_ERROR , , "Parameter error" ) \
X(ERR__NOT_READY , , "Device not ready" ) \
X(ERR__NO_DATA_AVAILABLE , , "No data available" ) \
X(ERR__FREQUENCY_ERROR , , "Frequency error" ) \
X(ERR__CRC_ERROR , , "CRC mismatch error" ) \
X(ERR__BAUDRATE_ERROR , , "Baudrate error" ) \
X(ERR__UNKNOWN , , "Unknown error" ) \
X(ERR__NO_AUTHORIZATION , , "No authorization to execute the command received" ) \
X(ERR__NULL_POINTER , , "Null pointer" ) \
X(ERR__VERSION , , "Version error" ) \
X(ERR__NOT_IMPLEMENTED , , "Not implemented" ) \
X(ERR__DATA_NOT_INITIALIZED, , "Data not initialized" ) \
X(ERR__PERIPHERAL_NOT_VALID, , "Peripheral not valid" ) \
X(ERR__UNKNOWN_COMMAND , , "Unknown command" ) \
X(ERR__BAD_ADDRESS , , "Bad start address or end address" ) \
X(ERR__BAD_DESTINATAIRE , , "Bad destinataire of the frame" ) \
X(ERR__BAD_DATA_SIZE , , "Bad data size" ) \
X(ERR__BAD_FRAME_TYPE , , "Bad frame type" ) \
X(ERR__NO_REPONSE , , "No response" ) \
X(ERR__TIMEOUT , , "General timeout" ) \
X(ERR__BUFFER_FULL , , "Buffer full" ) \
X(ERR__UNKNOWN_DEVICE , , "Unknown device error" ) \
X(ERR__NULL_BUFFER , , "Null buffer parameter" ) \
X(ERR__TOO_MANY_BAD , , "Too many bad things" ) \
X(ERR__TWO_BAD_SIDE_BY_SIDE, , "Two bad things side by side" ) \
X(ERR__TRANSMIT_ERROR , , "Transmit error" ) \
X(ERR__RECEIVE_ERROR , , "Receive error" ) \
X(ERR__UNKNOWN_CHANNEL , , "Unknown channel error" ) \
X(ERR__BAD_DATA , , "Bad data" ) \
X(ERR__BUSY , , "Busy" ) \
X(ERR__EMPTY_DATA , , "Empty data" ) \
X(ERR__NOT_FOUND , , "Not found" ) \
X(ERR__INVALID_HANDLE , , "Invalid handle" ) \
X(ERR__ADDRESS_ALIGNMENT , , "Address alignment error" ) \
X(ERR__READ_ERROR , , "Read error" ) \
X(ERR__WRITE_ERROR , , "Write error" ) \
X(ERR__DATA_MODULO , , "Wrong data modulo for the operation" ) \
X(ERR__BUFFER_OVERRIDE , , "Buffer data override" ) \
X(ERR__PARSE_ERROR , , "Error while parsing data" ) \
X(ERR__OLD_DATA , , "Old data" ) \
X(ERR__CANCELED , , "Canceled" ) \
X(ERR__NO_SYNC , , "No synchronization" ) \
X(ERR__NOT_INITIALIZED , , "Not initialized" ) \
X(ERR__BAD_ENDIANNESS , , "Bad endianness" ) \
X(ERR__INVALID_DATA , , "Invalid data" ) \
/* // Device mode */\
X(ERR__NOT_IN_SLEEP_MODE , = 90, "Operation impossible in sleep mode" ) \
X(ERR__ALREADY_IN_SLEEP , , "Already in sleep mode" ) \
X(ERR__NOT_CONFIG_MODE , , "Operation impossible in configuration mode" ) \
X(ERR__NEED_CONFIG_MODE , , "Device not in configuration mode" ) \
X(ERR__CANNOT_GO_IDLE_STATE, , "Cannot go in idle state" ) \
\
/* //--- Devices errors --- */\
/* // CAN errors */\
X(ERR__RAM_TEST_FAIL , = 100, "RAM test fail" ) \
X(ERR__BITTIME_ERROR , , "Can't calculate a good Bit Time" ) \
X(ERR__TOO_MANY_TEF , , "Too many TEF to configure" ) \
X(ERR__TOO_MANY_TXQ , , "Too many TXQ to configure" ) \
X(ERR__TOO_MANY_FIFO , , "Too many FIFO to configure" ) \
X(ERR__TOO_MANY_BUFFER , , "Too many Buffer to configure" ) \
X(ERR__SID11_NOT_AVAILABLE , , "SID11 not available in CAN2.0 mode" ) \
X(ERR__FILTER_CONSISTENCY , , "Filter inconsistency between Mask and filter" ) \
X(ERR__FILTER_TOO_LARGE , , "Filter too large between filter and config" ) \
X(ERR__BYTE_COUNT_MODULO_4 , , "Byte count should be modulo 4" ) \
/* // SD card errors */\
X(ERR__NO_CARD , , "No card present" ) \
X(ERR__UNUSABLE_CARD , , "Unusable SD card" ) \
X(ERR__CARD_ERROR , , "SD card error" ) \
X(ERR__CARD_COMMAND_ERROR , , "SD card command error" ) \
X(ERR__CARD_WRITE_PROTECTED, , "SD card is write protected" ) \
X(ERR__CARD_ECC_FAIL , , "SD card ECC fail" ) \
X(ERR__CARD_OUT_OF_RANGE , , "SD card out of range argument" ) \
X(ERR__CARD_STUCK_BUSY , , "SD card busy for too long time" ) \
\
/* //--- Interfaces errors --- */\
/* // SPI errors */\
X(ERR__SPI_PARAMETER_ERROR , = 200, "SPI parameter error" ) \
X(ERR__SPI_COMM_ERROR , , "SPI communication error" ) \
X(ERR__SPI_CONFIG_ERROR , , "SPI configuration error" ) \
X(ERR__SPI_TIMEOUT , , "SPI communication timeout" ) \
X(ERR__SPI_INVALID_DATA , , "SPI invalid data" ) \
X(ERR__SPI_FREQUENCY_ERROR , , "SPI frequency error" ) \
X(ERR__SPI_OVERFLOW_ERROR , , "SPI overflow error" ) \
X(ERR__SPI_UNDERFLOW_ERROR , , "SPI underflow error" ) \
X(ERR__SPI_BUSY , , "SPI busy" ) \
X(ERR__SPI_OTHER_BUSY , , "SPI busy by other transfer" ) \
/* // I2C errors */\
X(ERR__I2C_NACK , = 210, "Received a I2C not acknowledge" ) \
X(ERR__I2C_NACK_ADDR , , "Received a I2C not acknowledge while transferring addr") \
X(ERR__I2C_NACK_DATA , , "Received a I2C not acknowledge while transferring data") \
X(ERR__I2C_PARAMETER_ERROR , , "I2C parameter error" ) \
X(ERR__I2C_COMM_ERROR , , "I2C communication error" ) \
X(ERR__I2C_CONFIG_ERROR , , "I2C configuration error" ) \
X(ERR__I2C_TIMEOUT , , "I2C communication timeout" ) \
X(ERR__I2C_DEVICE_NOT_READY, , "I2C device not ready" ) \
X(ERR__I2C_INVALID_ADDRESS , , "I2C invalid address" ) \
X(ERR__I2C_INVALID_COMMAND , , "I2C invalid command" ) \
X(ERR__I2C_FREQUENCY_ERROR , , "I2C frequency error" ) \
X(ERR__I2C_OVERFLOW_ERROR , , "I2C overflow error" ) \
X(ERR__I2C_UNDERFLOW_ERROR , , "I2C underflow error" ) \
X(ERR__I2C_BUSY , , "I2C busy" ) \
X(ERR__I2C_OTHER_BUSY , , "I2C busy by other transfer" ) \
/* // DMA errors */\
X(ERR__DMA_NOT_CONFIGURED , = 225, "DMA not configured" ) \
X(ERR__DMA_PARAMETER_ERROR , , "DMA parameter error" ) \
X(ERR__DMA_ERROR , , "DMA error" ) \
X(ERR__DMA_OVERFLOW_ERROR , , "DMA overflow error" ) \
X(ERR__DMA_UNDERFLOW_ERROR , , "DMA underflow error" ) \
X(ERR__DMA_WRITE_BUS_ERROR , , "DMA write bus error" ) \
X(ERR__DMA_READ_BUS_ERROR , , "DMA read bus error" ) \
/* // Test error */\
X(ERR__TEST_ERROR , = 255, "Test error" )
#define ERR_OK ERR_NONE //!< For backward compatibility
//------------------------------------------------------------------------------
//! Function's return error enumerator
typedef enum
{
#ifdef USE_REDUCED_ERRORS_VALUE
# define X(eName, val, str) eName,
#else
# define X(eName, val, str) eName val,
#endif
ERRORS_TABLE
#undef X
ERR__ERRORS_MAX, // Keep last
} eERRORRESULT;
#define X(eName, val, str) +1
#define ERR__ERRORS_COUNT ( 0 ERRORS_TABLE )
#undef X
//------------------------------------------------------------------------------
#ifdef USE_ERRORS_STRING
//! Errors string table
static const char* const ERR_ErrorStrings[] =
{
#define X(a, b, c) [a]=c,
ERRORS_TABLE
#undef X
};
#endif
//------------------------------------------------------------------------------
//! @}
//------------------------------------------------------------------------------
#ifdef __cplusplus
}
#endif
//------------------------------------------------------------------------------
#endif /* ERRORSDEF_H_ */