Portal Compiler
Mistake on this page?
Report an issue in GitHub or email us
mbed_error.h
1 /** \addtogroup platform */
2 /** @{*/
3 /**
4  * \defgroup platform_error Error functions
5  * @{
6  */
7 /* mbed Microcontroller Library
8  * Copyright (c) 2006-2013 ARM Limited
9  * SPDX-License-Identifier: Apache-2.0
10  *
11  * Licensed under the Apache License, Version 2.0 (the "License");
12  * you may not use this file except in compliance with the License.
13  * You may obtain a copy of the License at
14  *
15  * http://www.apache.org/licenses/LICENSE-2.0
16  *
17  * Unless required by applicable law or agreed to in writing, software
18  * distributed under the License is distributed on an "AS IS" BASIS,
19  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20  * See the License for the specific language governing permissions and
21  * limitations under the License.
22  */
23 #ifndef MBED_ERROR_H
24 #define MBED_ERROR_H
25 
26 #include "platform/mbed_retarget.h"
27 #include "platform/mbed_toolchain.h"
28 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32 
33 /** Define this macro to include filenames in error context. For release builds, do not include filename to save memory.
34  * MBED_PLATFORM_CONF_ERROR_FILENAME_CAPTURE_ENABLED
35  */
36 
37 /** Define this macro to enable error history
38  * MBED_PLATFORM_CONF_ERROR_HIST_ENABLED
39  */
40 
41 #ifndef MBED_CONF_PLATFORM_MAX_ERROR_FILENAME_LEN
42 #define MBED_CONF_PLATFORM_MAX_ERROR_FILENAME_LEN 16
43 #else //MBED_CONF_PLATFORM_MAX_ERROR_FILENAME_LEN
44 #if MBED_CONF_PLATFORM_MAX_ERROR_FILENAME_LEN > 64
45 //We have to limit this to 64 bytes since we use mbed_error_printf for error reporting
46 //and mbed_error_vprintf uses 128bytes internal buffer which may not be sufficient for anything
47 //longer that 64 bytes with the current implementation.
48 #error "Unsupported error filename buffer length detected, max supported length is 64 chars. Please change MBED_CONF_PLATFORM_MAX_ERROR_FILENAME_LEN or max-error-filename-len in configuration."
49 #endif
50 #endif
51 
52 #define MBED_ERROR_STATUS_CODE_MASK (0x0000FFFF)
53 #define MBED_ERROR_STATUS_CODE_POS (0)
54 #define MBED_ERROR_STATUS_CODE_FIELD_SIZE (16)
55 
56 #define MBED_ERROR_STATUS_MODULE_MASK (0x00FF0000)
57 #define MBED_ERROR_STATUS_MODULE_POS (16)
58 #define MBED_ERROR_STATUS_MODULE_FIELD_SIZE (8)
59 
60 #define MBED_ERROR_STATUS_TYPE_MASK (0x60000000)
61 #define MBED_ERROR_STATUS_TYPE_POS (29)
62 #define MBED_ERROR_STATUS_TYPE_FIELD_SIZE (2)
63 
64 /* mbed_error_status_t Status Encoding */
65 //|31(1 bit) Always Negative|30-29(2 bits) |28-24 | 23-16(8 bits) | 15-0(16 bits) |
66 //|-1 |TYPE |(unused/reserved) | MODULE TYPE | ERROR CODE |
67 
68 #define MAKE_MBED_ERROR(type, module, error_code) (mbed_error_status_t) \
69  ((0x80000000) | \
70  (MBED_ERROR_STATUS_CODE_MASK & (error_code << MBED_ERROR_STATUS_CODE_POS)) | \
71  (MBED_ERROR_STATUS_MODULE_MASK & (module << MBED_ERROR_STATUS_MODULE_POS)) | \
72  (MBED_ERROR_STATUS_TYPE_MASK & (type << MBED_ERROR_STATUS_TYPE_POS)))
73 
74 #define MBED_GET_ERROR_TYPE( error_status ) ((error_status & MBED_ERROR_STATUS_TYPE_MASK) >> MBED_ERROR_STATUS_TYPE_POS)
75 #define MBED_GET_ERROR_MODULE( error_status ) ((error_status & MBED_ERROR_STATUS_MODULE_MASK) >> MBED_ERROR_STATUS_MODULE_POS)
76 #define MBED_GET_ERROR_CODE( error_status ) (int)((MBED_GET_ERROR_TYPE( error_status ) == MBED_ERROR_TYPE_POSIX)?(-error_status):((error_status & MBED_ERROR_STATUS_CODE_MASK) >> MBED_ERROR_STATUS_CODE_POS))
77 
78 /** mbed_error_status_t description
79  *
80  * mbed_error_status_t type represents the error status values under MbedOS. mbed_error_status_t values are signed integers and always be negative.\n
81  * Internally its encoded as below with bit-fields representing error type, module and error code:\n\n
82  * mbed_error_status_t Status Encoding:\n
83  *
84  \verbatim
85  | 31 Always Negative | 30-29(2 bits) | 28-24 | 23-16(8 bits) | 15-0(16 bits) |
86  | -1 | TYPE | (unused/reserved) | MODULE TYPE | ERROR CODE |
87  \endverbatim
88  *
89  * The error status value range for each error type is as follows:\n
90  * POSIX Error Status-es - 0xFFFFFFFF to 0xFFFFFF01(-1 -255) - This corresponds to POSIX error codes represented as negative.\n
91  * System Error Status-es - 0x80XX0100 to 0x80XX0FFF - This corresponds to System error codes range(all values are negative). Bits 23-16 will be module type(marked with XX)\n
92  * Custom Error Status-es - 0xA0XX1000 to 0xA0XXFFFF - This corresponds to Custom error codes range(all values are negative). Bits 23-16 will be module type(marked with XX)\n\n
93  *
94  * The ERROR CODE(values encoded into ERROR CODE bit-field in mbed_error_status_t) value range for each error type is also separated as below:\n
95  * POSIX Error Codes - 1 to 255.\n
96  * System Error Codes - 256 to 4095.\n
97  * Custom Error Codes - 4096 to 65535.\n
98  *
99  * @note POSIX error codes are always encoded as negative of their actual value. For example, EPERM is encoded as -EPERM.
100  * And, the MODULE TYPE for POSIX error codes are always encoded as MBED_MODULE_UNKNOWN.\n
101  * This is to enable easy injection of POSIX error codes into MbedOS error handling system without altering the actual POSIX error values.\n
102  * Accordingly, POSIX error codes are represented as -1 to -255 under MbedOS error status representation.
103  */
104 typedef int mbed_error_status_t;
105 
106 /**
107  * Macro for defining a POSIX error status. This macro is mainly used to define POSIX error values in mbed_error_code_t enumeration.
108  * @param error_name Name of the error without the ERROR_ prefix
109  * @param error_code Error code value to be used, must be between 1 and 255(inclusive).
110  *
111  */
112 #define MBED_DEFINE_POSIX_ERROR( error_name, error_code ) \
113  MBED_ERROR_CODE_##error_name = error_code, \
114  MBED_ERROR_##error_name = -(MBED_POSIX_ERROR_BASE + error_code)
115 
116 /**
117  * Macro for defining a System error status. This macro is used to define System error values in mbed_error_code_t enumeration.
118  * @param error_name Name of the error without the ERROR_ prefix
119  * @param error_code Error code value to be used, must be between 256 and 4096(inclusive).
120  *
121  */
122 #define MBED_DEFINE_SYSTEM_ERROR( error_name, error_code ) \
123  MBED_ERROR_CODE_##error_name = MBED_SYSTEM_ERROR_BASE + error_code, \
124  MBED_ERROR_##error_name = MAKE_MBED_ERROR(MBED_ERROR_TYPE_SYSTEM, MBED_MODULE_UNKNOWN, MBED_ERROR_CODE_##error_name)
125 
126 /**
127  * Macro for defining a Custom error status. This macro is used to define custom error values in mbed_error_code_t enumeration.
128  * @param error_name Name of the error without the ERROR_ prefix
129  * @param error_code Error code value to be used, must be between 4097 and 65535(inclusive).
130  *
131  */
132 #define MBED_DEFINE_CUSTOM_ERROR( error_name, error_code ) \
133  MBED_ERROR_CODE_##error_name = MBED_CUSTOM_ERROR_BASE + error_code, \
134  MBED_ERROR_##error_name = MAKE_MBED_ERROR(MBED_ERROR_TYPE_CUSTOM, MBED_MODULE_UNKNOWN, MBED_ERROR_CODE_##error_name)
135 
136 
137 /**
138  * Macros for setting a system warning. These macros will log the error, Its a wrapper for calling mbed_warning API.
139  * There are 2 versions of this macro. MBED_WARNING takes status and message. MBED_WARNING1 takes an additional context specific argument
140  * @param error_status mbed_error_status_t status to be set(See mbed_error_status_t enum above for available error status values).
141  * @param error_msg The error message to be printed out to STDIO/Serial.
142  * @param error_value Value associated with the error status. This would depend on error code/error scenario.
143  *
144  * @code
145  *
146  * MBED_WARNING( ERROR_INVALID_SIZE, "MyDriver: Invalid size in read" )
147  * MBED_WARNING1( ERROR_INVALID_SIZE, "MyDriver: Invalid size in read", size_val )
148  *
149  * @endcode
150  * @note The macro calls mbed_warning API with filename and line number info without caller explicitly passing them.
151  * Since this macro is a wrapper for mbed_warning API callers should process the return value from this macro which is the return value from calling mbed_error API.
152  *
153  */
154 #ifdef NDEBUG
155 #define MBED_WARNING1( error_status, error_msg, error_value ) mbed_warning( error_status, (const char *)NULL, (uint32_t)error_value, NULL, 0 )
156 #define MBED_WARNING( error_status, error_msg ) mbed_warning( error_status, (const char *)NULL, (uint32_t)0, NULL, 0 )
157 #else //NDEBUG
158 #if MBED_CONF_PLATFORM_ERROR_FILENAME_CAPTURE_ENABLED
159 #define MBED_WARNING1( error_status, error_msg, error_value ) mbed_warning( error_status, (const char *)error_msg, (uint32_t)error_value, (const char *)MBED_FILENAME, __LINE__ )
160 #define MBED_WARNING( error_status, error_msg ) mbed_warning( error_status, (const char *)error_msg, (uint32_t)0 , (const char *)MBED_FILENAME, __LINE__ )
161 #else //MBED_CONF_PLATFORM_ERROR_FILENAME_CAPTURE_ENABLED
162 #define MBED_WARNING1( error_status, error_msg, error_value ) mbed_warning( error_status, (const char *)error_msg, (uint32_t)error_value, NULL, 0 )
163 #define MBED_WARNING( error_status, error_msg ) mbed_warning( error_status, (const char *)error_msg, (uint32_t)0, NULL, 0 )
164 #endif
165 #endif
166 
167 /**
168  * Macros for setting a fatal system error. These macros will log the error, prints the error report and halts the system. Its a wrapper for calling mbed_error API.
169  * There are 2 versions of this macro. MBED_ERROR takes status and message. MBED_ERROR1 takes an additional context specific argument
170  * @param error_status mbed_error_status_t status to be set(See mbed_error_status_t enum above for available error status values).
171  * @param error_msg The error message to be printed out to STDIO/Serial.
172  * @param error_value Value associated with the error status. This would depend on error code/error scenario. Only available with MBED_ERROR1
173  * @return Does not return
174  *
175  * @code
176  *
177  * MBED_ERROR( MBED_ERROR_MUTEX_LOCK_FAILED, "MyDriver: Can't lock driver Mutex" )
178  * MBED_ERROR1( MBED_ERROR_MUTEX_LOCK_FAILED, "MyDriver: Can't lock driver Mutex", &my_mutex )
179  *
180  * @endcode
181  * @note The macro calls mbed_error API with filename and line number info without caller explicitly passing them.
182  * Since this macro is a wrapper for mbed_error API callers should process the return value from this macro which is the return value from calling mbed_error API.
183  *
184  */
185 #ifdef NDEBUG
186 #define MBED_ERROR1( error_status, error_msg, error_value ) mbed_error( error_status, (const char *)NULL, (uint32_t)error_value, NULL, 0 )
187 #define MBED_ERROR( error_status, error_msg ) mbed_error( error_status, (const char *)NULL, (uint32_t)0 , NULL, 0 )
188 #else //NDEBUG
189 #if MBED_CONF_PLATFORM_ERROR_FILENAME_CAPTURE_ENABLED
190 #define MBED_ERROR1( error_status, error_msg, error_value ) mbed_error( error_status, (const char *)error_msg, (uint32_t)error_value, (const char *)MBED_FILENAME, __LINE__ )
191 #define MBED_ERROR( error_status, error_msg ) mbed_error( error_status, (const char *)error_msg, (uint32_t)0 , (const char *)MBED_FILENAME, __LINE__ )
192 #else //MBED_CONF_PLATFORM_ERROR_FILENAME_CAPTURE_ENABLED
193 #define MBED_ERROR1( error_status, error_msg, error_value ) mbed_error( error_status, (const char *)error_msg, (uint32_t)error_value, NULL, 0 )
194 #define MBED_ERROR( error_status, error_msg ) mbed_error( error_status, (const char *)error_msg, (uint32_t)0 , NULL, 0 )
195 #endif
196 #endif
197 
198 //Error Type definition
199 /** mbed_error_type_t definition
200  * @note
201  * This enumeration defines the Error types supported. The value of these enum values will be encoded into mbed_error_status_t TYPE field.\n
202  * See mbed_error_status_t description for more info.\n
203  * MBED_ERROR_TYPE_SYSTEM - Used to indicate that the error status is of System defined Error type.\n
204  * MBED_ERROR_TYPE_CUSTOM - Used to indicate that the error status is of Custom defined Error type.\n
205  * MBED_ERROR_TYPE_POSIX - Used to indicate that the error status is of POSIX error type.\n
206  *
207  */
208 typedef enum _mbed_error_type_t {
209  MBED_ERROR_TYPE_SYSTEM = 0,
210  MBED_ERROR_TYPE_CUSTOM = 1,
211  //2 is reserved
212  //Use 3 for POSIX because we are mapping -1 to -255 to POSIX error codes
213  //and thus we must use 3 to match the type bits in error status representation which are from 0xFFFFFFFF to 0xFFFFFF00
214  MBED_ERROR_TYPE_POSIX = 3
215 } mbed_error_type_t;
216 
217 //Module type/id definitions
218 /** mbed_module_type_t definition
219  * @note
220  * This enumeration defines the module types. The value of these enum values will be encoded into mbed_error_status_t MODULE field.\n\n
221  * See mbed_error_status_t description for more info.\n
222  * MBED_MODULE_UNKNOWN - This module type can be used if caller of the mbed_error/mbed_warning doesn't know who is the actual originator of the error.\n
223  * Other module values can be used to provide more info on who/where the error originated from.\n\n
224  * For example, if I2C driver is the component originating the error you can use MBED_MODULE_DRIVER_I2C to provide more info.\n
225  * Its used in call to MBED_MAKE_ERROR/MBED_MAKE_SYSTEM_ERROR/MBED_MAKE_CUSTOM_ERROR macros.\n
226  *
227  * @code
228  * Example: mbed_error_status_t i2c_driver_error = MBED_MAKE_ERROR( MBED_MODULE_DRIVER_I2C, MBED_ERROR_CONFIG_UNSUPPORTED );
229  * @endcode
230  *
231  * @note
232  * \n Below are the module code mappings:\n
233  \verbatim
234  MBED_MODULE_APPLICATION 0 Application
235  MBED_MODULE_PLATFORM 1 Platform
236  MBED_MODULE_KERNEL 2 RTX Kernel
237  MBED_MODULE_NETWORK_STACK 3 Network stack
238  MBED_MODULE_HAL 4 HAL - Hardware Abstraction Layer
239  MBED_MODULE_MEMORY_SUBSYSTEM 5 Memory Subsystem
240  MBED_MODULE_FILESYSTEM 6 Filesystem
241  MBED_MODULE_BLOCK_DEVICE 7 Block device
242  MBED_MODULE_DRIVER 8 Driver
243  MBED_MODULE_DRIVER_SERIAL 9 Serial Driver
244  MBED_MODULE_DRIVER_RTC 10 RTC Driver
245  MBED_MODULE_DRIVER_I2C 11 I2C Driver
246  MBED_MODULE_DRIVER_SPI 12 SPI Driver
247  MBED_MODULE_DRIVER_GPIO 13 GPIO Driver
248  MBED_MODULE_DRIVER_ANALOG 14 Analog Driver
249  MBED_MODULE_DRIVER_DIGITAL 15 DigitalIO Driver
250  MBED_MODULE_DRIVER_CAN 16 CAN Driver
251  MBED_MODULE_DRIVER_ETHERNET 17 Ethernet Driver
252  MBED_MODULE_DRIVER_CRC 18 CRC Module
253  MBED_MODULE_DRIVER_PWM 19 PWM Driver
254  MBED_MODULE_DRIVER_QSPI 20 QSPI Driver
255  MBED_MODULE_DRIVER_USB 21 USB Driver
256  MBED_MODULE_TARGET_SDK 22 SDK
257  MBED_MODULE_BLE 23 BLE
258  MBED_MODULE_NETWORK_STATS 24 Network Statistics
259 
260  MBED_MODULE_UNKNOWN 255 Unknown module
261  \endverbatim
262  *
263  */
264 typedef enum _mbed_module_type {
265  MBED_MODULE_APPLICATION = 0,
266  MBED_MODULE_PLATFORM,
267  MBED_MODULE_KERNEL,
268  MBED_MODULE_NETWORK_STACK,
269  MBED_MODULE_HAL,
270  MBED_MODULE_MEMORY_SUBSYSTEM,
271  MBED_MODULE_FILESYSTEM,
272  MBED_MODULE_BLOCK_DEVICE,
273  MBED_MODULE_DRIVER,
274  MBED_MODULE_DRIVER_SERIAL,
275  MBED_MODULE_DRIVER_RTC,
276  MBED_MODULE_DRIVER_I2C,
277  MBED_MODULE_DRIVER_SPI,
278  MBED_MODULE_DRIVER_GPIO,
279  MBED_MODULE_DRIVER_ANALOG,
280  MBED_MODULE_DRIVER_DIGITAL,
281  MBED_MODULE_DRIVER_CAN,
282  MBED_MODULE_DRIVER_ETHERNET,
283  MBED_MODULE_DRIVER_CRC,
284  MBED_MODULE_DRIVER_PWM,
285  MBED_MODULE_DRIVER_QSPI,
286  MBED_MODULE_DRIVER_USB,
287  MBED_MODULE_TARGET_SDK,
288  MBED_MODULE_BLE,
289  MBED_MODULE_NETWORK_STATS,
290  /* Add More entities here as required */
291 
292  MBED_MODULE_UNKNOWN = 255,
293  MBED_MODULE_MAX = MBED_MODULE_UNKNOWN
294 } mbed_module_type_t;
295 
296 //Use MBED_SUCCESS(=0) or any positive number for successful returns
297 #define MBED_SUCCESS 0
298 
299 #define MBED_POSIX_ERROR_BASE 0
300 #define MBED_SYSTEM_ERROR_BASE 256
301 #define MBED_CUSTOM_ERROR_BASE 4096
302 
303 //Error Code definitions
304 /** mbed_error_code_t definition
305  *
306  * mbed_error_code_t enumeration defines the Error codes and Error status values for MBED_MODULE_UNKNOWN.\n
307  * It defines all of POSIX Error Codes/Statuses and Mbed System Error Codes/Statuses.\n\n
308  *
309  * @note
310  * POSIX Error codes are defined using the macro MBED_DEFINE_POSIX_ERROR\n
311  * For example MBED_DEFINE_POSIX_ERROR( EPERM, EPERM ). This effectively defines the following values:\n
312  * ERROR_CODE_EPERM = EPERM\n
313  * ERROR_EPERM = -EPERM\n
314  *
315  * POSIX Error codes are defined using the macro MBED_DEFINE_POSIX_ERROR\n
316  * For example MBED_DEFINE_POSIX_ERROR( EPERM, EPERM ). This macro defines the following values:\n
317  * ERROR_CODE_EPERM = MBED_POSIX_ERROR_BASE+EPERM\n
318  * ERROR_EPERM = -(MBED_POSIX_ERROR_BASE+EPERM)\n
319  * Its effectively equivalent to:\n
320  * ERROR_CODE_EPERM = 1\n
321  * ERROR_EPERM = -1\n
322  * All POSIX error codes currently supported by MbedOS(defined in mbed_retarget.h) are defined using the MBED_DEFINE_POSIX_ERROR macro.\n\n
323  * Below are the POSIX error codes and the description:\n
324  * \verbatim
325  EPERM 1 Operation not permitted
326  ENOENT 2 No such file or directory
327  ESRCH 3 No such process
328  EINTR 4 Interrupted system call
329  EIO 5 I/O error
330  ENXIO 6 No such device or address
331  E2BIG 7 Argument list too long
332  ENOEXEC 8 Exec format error
333  EBADF 9 Bad file number
334  ECHILD 10 No child processes
335  EAGAIN 11 Try again
336  ENOMEM 12 Out of memory
337  EACCES 13 Permission denied
338  EFAULT 14 Bad address
339  ENOTBLK 15 Block device required
340  EBUSY 16 Device or resource busy
341  EEXIST 17 File exists
342  EXDEV 18 Cross-device link
343  ENODEV 19 No such device
344  ENOTDIR 20 Not a directory
345  EISDIR 21 Is a directory
346  EINVAL 22 Invalid argument
347  ENFILE 23 File table overflow
348  EMFILE 24 Too many open files
349  ENOTTY 25 Not a typewriter
350  ETXTBSY 26 Text file busy
351  EFBIG 27 File too large
352  ENOSPC 28 No space left on device
353  ESPIPE 29 Illegal seek
354  EROFS 30 Read-only file system
355  EMLINK 31 Too many links
356  EPIPE 32 Broken pipe
357  EDOM 33 Math argument out of domain of func
358  ERANGE 34 Math result not representable
359  EDEADLK 35 Resource deadlock would occur
360  ENAMETOOLONG 36 File name too long
361  ENOLCK 37 No record locks available
362  ENOSYS 38 Function not implemented
363  ENOTEMPTY 39 Directory not empty
364  ELOOP 40 Too many symbolic links encountered
365  EWOULDBLOCK EAGAIN Operation would block
366  ENOMSG 42 No message of desired type
367  EIDRM 43 Identifier removed
368  ECHRNG 44 Channel number out of range
369  EL2NSYNC 45 Level 2 not synchronized
370  EL3HLT 46 Level 3 halted
371  EL3RST 47 Level 3 reset
372  ELNRNG 48 Link number out of range
373  EUNATCH 49 Protocol driver not attached
374  ENOCSI 50 No CSI structure available
375  EL2HLT 51 Level 2 halted
376  EBADE 52 Invalid exchange
377  EBADR 53 Invalid request descriptor
378  EXFULL 54 Exchange full
379  ENOANO 55 No anode
380  EBADRQC 56 Invalid request code
381  EBADSLT 57 Invalid slot
382  EDEADLOCK EDEADLK Resource deadlock would occur
383  EBFONT 59 Bad font file format
384  ENOSTR 60 Device not a stream
385  ENODATA 61 No data available
386  ETIME 62 Timer expired
387  ENOSR 63 Out of streams resources
388  ENONET 64 Machine is not on the network
389  ENOPKG 65 Package not installed
390  EREMOTE 66 Object is remote
391  ENOLINK 67 Link has been severed
392  EADV 68 Advertise error
393  ESRMNT 69 Srmount error
394  ECOMM 70 Communication error on send
395  EPROTO 71 Protocol error
396  EMULTIHOP 72 Multihop attempted
397  EDOTDOT 73 RFS specific error
398  EBADMSG 74 Not a data message
399  EOVERFLOW 75 Value too large for defined data type
400  ENOTUNIQ 76 Name not unique on network
401  EBADFD 77 File descriptor in bad state
402  EREMCHG 78 Remote address changed
403  ELIBACC 79 Can not access a needed shared library
404  ELIBBAD 80 Accessing a corrupted shared library
405  ELIBSCN 81 .lib section in a.out corrupted
406  ELIBMAX 82 Attempting to link in too many shared libraries
407  ELIBEXEC 83 Cannot exec a shared library directly
408  EILSEQ 84 Illegal byte sequence
409  ERESTART 85 Interrupted system call should be restarted
410  ESTRPIPE 86 Streams pipe error
411  EUSERS 87 Too many users
412  ENOTSOCK 88 Socket operation on non-socket
413  EDESTADDRREQ 89 Destination address required
414  EMSGSIZE 90 Message too long
415  EPROTOTYPE 91 Protocol wrong type for socket
416  ENOPROTOOPT 92 Protocol not available
417  EPROTONOSUPPORT 93 Protocol not supported
418  ESOCKTNOSUPPORT 94 Socket type not supported
419  EOPNOTSUPP 95 Operation not supported on transport endpoint
420  EPFNOSUPPORT 96 Protocol family not supported
421  EAFNOSUPPORT 97 Address family not supported by protocol
422  EADDRINUSE 98 Address already in use
423  EADDRNOTAVAIL 99 Cannot assign requested address
424  ENETDOWN 100 Network is down
425  ENETUNREACH 101 Network is unreachable
426  ENETRESET 102 Network dropped connection because of reset
427  ECONNABORTED 103 Software caused connection abort
428  ECONNRESET 104 Connection reset by peer
429  ENOBUFS 105 No buffer space available
430  EISCONN 106 Transport endpoint is already connected
431  ENOTCONN 107 Transport endpoint is not connected
432  ESHUTDOWN 108 Cannot send after transport endpoint shutdown
433  ETOOMANYREFS 109 Too many references: cannot splice
434  ETIMEDOUT 110 Connection timed out
435  ECONNREFUSED 111 Connection refused
436  EHOSTDOWN 112 Host is down
437  EHOSTUNREACH 113 No route to host
438  EALREADY 114 Operation already in progress
439  EINPROGRESS 115 Operation now in progress
440  ESTALE 116 Stale NFS file handle
441  EUCLEAN 117 Structure needs cleaning
442  ENOTNAM 118 Not a XENIX named type file
443  ENAVAIL 119 No XENIX semaphores available
444  EISNAM 120 Is a named type file
445  EREMOTEIO 121 Remote I/O error
446  EDQUOT 122 Quota exceeded
447  ENOMEDIUM 123 No medium found
448  EMEDIUMTYPE 124 Wrong medium type
449  ECANCELED 125 Operation Canceled
450  ENOKEY 126 Required key not available
451  EKEYEXPIRED 127 Key has expired
452  EKEYREVOKED 128 Key has been revoked
453  EKEYREJECTED 129 Key was rejected by service
454  EOWNERDEAD 130 Owner died
455  ENOTRECOVERABLE 131 State not recoverable
456  \endverbatim
457  *
458  * @note
459  * MbedOS System Error codes are defined using the macro MBED_DEFINE_SYSTEM_ERROR\n
460  * For example MBED_DEFINE_SYSTEM_ERROR( INVALID_ARGUMENT ,1 ) macro defines the following values:\n
461  * ERROR_CODE_INVALID_ARGUMENT = MBED_SYSTEM_ERROR_BASE+1\n
462  * ERROR_INVALID_ARGUMENT = MAKE_MBED_ERROR(ERROR_TYPE_SYSTEM, MBED_MODULE_UNKNOWN, ERROR_CODE_INVALID_ARGUMENT)\n
463  * Its effectively equivalent to:\n
464  * ERROR_CODE_INVALID_ARGUMENT = 1\n
465  * ERROR_INVALID_ARGUMENT = 0x80FF0001\n (Note that MODULE field is set to MBED_MODULE_UNKNOWN)
466  * New System Error codes should be defined using MBED_DEFINE_SYSTEM_ERROR macro and must have an unique error code value\n
467  * passed as the second argument in the MBED_DEFINE_SYSTEM_ERROR macro.\n\n
468  * Below are the Mbed System error codes and the description:
469  * \verbatim
470  UNKNOWN 256 Unknown error
471  INVALID_ARGUMENT 257 Invalid Argument
472  INVALID_DATA 258 Invalid data
473  INVALID_FORMAT 259 Invalid format
474  INVALID_INDEX 260 Invalid Index
475  INVALID_SIZE 261 Invalid Size
476  INVALID_OPERATION 262 Invalid Operation
477  NOT_FOUND 263 Not Found
478  ACCESS_DENIED 264 Access Denied
479  NOT_SUPPORTED 265 Not supported
480  BUFFER_FULL 266 Buffer Full
481  MEDIA_FULL 267 Media/Disk Full
482  ALREADY_IN_USE 268 Already in use
483  TIMEOUT 269 Timeout error
484  NOT_READY 270 Not Ready
485  FAILED_OPERATION 271 Requested Operation failed
486  OPERATION_PROHIBITED 272 Operation prohibited
487  OPERATION_ABORTED 273 Operation failed
488  WRITE_PROTECTED 274 Attempt to write to write-protected resource
489  NO_RESPONSE 275 No response
490  SEMAPHORE_LOCK_FAILED 276 Semaphore lock failed
491  MUTEX_LOCK_FAILED 277 Mutex lock failed
492  SEMAPHORE_UNLOCK_FAILED 278 Semaphore unlock failed
493  MUTEX_UNLOCK_FAILED 279 Mutex unlock failed
494  CRC_ERROR 280 CRC error or mismatch
495  OPEN_FAILED 281 Open failed
496  CLOSE_FAILED 282 Close failed
497  READ_FAILED 283 Read failed
498  WRITE_FAILED 284 Write failed
499  INITIALIZATION_FAILED 285 Initialization failed
500  BOOT_FAILURE 286 Boot failure
501  OUT_OF_MEMORY 287 Out of memory
502  OUT_OF_RESOURCES 288 Out of resources
503  ALLOC_FAILED 289 Alloc failed
504  FREE_FAILED 290 Free failed
505  OVERFLOW 291 Overflow error
506  UNDERFLOW 292 Underflow error
507  STACK_OVERFLOW 293 Stack overflow error
508  ISR_QUEUE_OVERFLOW 294 ISR queue overflow
509  TIMER_QUEUE_OVERFLOW 295 Timer Queue overflow
510  CLIB_SPACE_UNAVAILABLE 296 Standard library error - Space unavailable
511  CLIB_EXCEPTION 297 Standard library error - Exception
512  CLIB_MUTEX_INIT_FAILURE 298 Standard library error - Mutex Init failure
513  CREATE_FAILED 299 Create failed
514  DELETE_FAILED 300 Delete failed
515  THREAD_CREATE_FAILED 301 Thread Create failed
516  THREAD_DELETE_FAILED 302 Thread Delete failed
517  PROHIBITED_IN_ISR_CONTEXT 303 Operation Prohibited in ISR context
518  PINMAP_INVALID 304 Pinmap Invalid
519  RTOS_EVENT 305 Unknown Rtos Error
520  RTOS_THREAD_EVENT 306 Rtos Thread Error
521  RTOS_MUTEX_EVENT 307 Rtos Mutex Error
522  RTOS_SEMAPHORE_EVENT 308 Rtos Semaphore Error
523  RTOS_MEMORY_POOL_EVENT 309 Rtos Memory Pool Error
524  RTOS_TIMER_EVENT 310 Rtos Timer Error
525  RTOS_EVENT_FLAGS_EVENT 311 Rtos Event flags Error
526  RTOS_MESSAGE_QUEUE_EVENT 312 Rtos Message queue Error
527  DEVICE_BUSY 313 Device Busy
528  CONFIG_UNSUPPORTED 314 Configuration not supported
529  CONFIG_MISMATCH 315 Configuration mismatch
530  ALREADY_INITIALIZED 316 Already initialized
531  HARDFAULT_EXCEPTION 317 HardFault exception
532  MEMMANAGE_EXCEPTION 318 MemManage exception
533  BUSFAULT_EXCEPTION 319 BusFault exception
534  USAGEFAULT_EXCEPTION 320 UsageFault exception
535  BLE_NO_FRAME_INITIALIZED, 321 BLE No frame initialized
536  BLE_BACKEND_CREATION_FAILED 322 BLE Backend creation failed
537  BLE_BACKEND_NOT_INITIALIZED 323 BLE Backend not initialized
538  ASSERTION_FAILED 324 Assertion Failed
539  AUTHENTICATION_FAILED 325 Authentication Failed
540  RBP_AUTHENTICATION_FAILED 326 Rollback Protect Authentication Failed
541  \endverbatim
542  *
543  * @note
544  * Custom Error codes can be defined using the macro DEFINE_CUSTOM_ERROR\n
545  * This is mainly meant to capture non-generic error codes specific to a device.
546  * For example DEFINE_CUSTOM_ERROR( MY_CUSTOM_ERROR ,1 ) macro defines the following values:\n
547  * ERROR_CODE_MY_CUSTOM_ERROR = MBED_CUSTOM_ERROR_BASE+1\n
548  * ERROR_MY_CUSTOM_ERROR = MAKE_MBED_ERROR(ERROR_TYPE_CUSTOM, MBED_MODULE_UNKNOWN, ERROR_CODE_MY_CUSTOM_ERROR)\n
549  * Its effectively equivalent to:\n
550  * ERROR_CODE_MY_CUSTOM_ERROR = 4097\n
551  * ERROR_MY_CUSTOM_ERROR = 0xA0FF1001\n (Note that MODULE field is set to MBED_MODULE_UNKNOWN) \n\n
552  *
553  * @note
554  * **Using error codes:** \n
555  * POSIX error codes may be used in modules/functions currently using POSIX error codes and switching them to Mbed-OS error codes
556  * may cause interoperability issues. For example, some of the filesystem, network stack implementations may need to use
557  * POSIX error codes in order to keep them compatible with other modules interfacing with them, and may continue to use POSIX error codes.
558  *
559  * In all other cases, like for any native development of Mbed-OS modules Mbed-OS error codes should be used.
560  * This makes it easy to use Mbed-OS error reporting/logging infrastructure and makes debugging error scenarios
561  * much more efficient.
562  *
563  * @note
564  * **Searching for error codes in mbed-os source tree:** \n
565  * If you get an error report as below which you want to search for in mbed-os source tree, first take note of "Error Code" number. \n
566  * For example, the below error report has an error code of \b 259. Find the error name associated with the error code and in this case its \b INVALID_FORMAT. \n
567  * Use that error name(\b INVALID_FORMAT) to search the source tree for code locations setting that specific error code. \n
568  * If the Error module reported is not 255(which indicates unknown module), you can also use that to narrow down to the specific component reporting the error.
569  * See mbed_module_type_t enum above for module mapping. \n
570  *
571  * \verbatim
572  ++ MbedOS Error Info ++
573  Error Status: 0x80FF013D Code: 317 Module: 255
574  Error Message: Fault exception
575  Location: 0x5CD1
576  Error Value: 0x4A2A
577  Current Thread: Id: 0x20001E80 Entry: 0x5EB1 StackSize: 0x1000 StackMem: 0x20000E80 SP: 0x2002FF90
578  For more info, visit: https://mbed.com/s/error?error=0x80FF013D&mbedos=999999&core=0x410FC241&compile=1&ver=5060528
579  -- MbedOS Error Info --
580  \endverbatim
581  */
582 
583 typedef enum _mbed_error_code {
584  //Below are POSIX ERROR CODE definitions, which starts at MBED_POSIX_ERROR_BASE(=0)
585  //POSIX ERROR CODE definitions starts at offset 0(MBED_POSIX_ERROR_BASE) to align them with actual POSIX Error Code
586  //defintions in mbed_retarget.h
587  // Error Name Error Code
588  MBED_DEFINE_POSIX_ERROR(EPERM, EPERM), /* 1 Operation not permitted */
589  MBED_DEFINE_POSIX_ERROR(ENOENT, ENOENT), /* 2 No such file or directory */
590  MBED_DEFINE_POSIX_ERROR(ESRCH, ESRCH), /* 3 No such process */
591  MBED_DEFINE_POSIX_ERROR(EINTR, EINTR), /* 4 Interrupted system call */
592  MBED_DEFINE_POSIX_ERROR(EIO, EIO), /* 5 I/O error */
593  MBED_DEFINE_POSIX_ERROR(ENXIO, ENXIO), /* 6 No such device or address */
594  MBED_DEFINE_POSIX_ERROR(E2BIG, E2BIG), /* 7 Argument list too long */
595  MBED_DEFINE_POSIX_ERROR(ENOEXEC, ENOEXEC), /* 8 Exec format error */
596  MBED_DEFINE_POSIX_ERROR(EBADF, EBADF), /* 9 Bad file number */
597  MBED_DEFINE_POSIX_ERROR(ECHILD, ECHILD), /* 10 No child processes */
598  MBED_DEFINE_POSIX_ERROR(EAGAIN, EAGAIN), /* 11 Try again */
599  MBED_DEFINE_POSIX_ERROR(ENOMEM, ENOMEM), /* 12 Out of memory */
600  MBED_DEFINE_POSIX_ERROR(EACCES, EACCES), /* 13 Permission denied */
601  MBED_DEFINE_POSIX_ERROR(EFAULT, EFAULT), /* 14 Bad address */
602  MBED_DEFINE_POSIX_ERROR(ENOTBLK, ENOTBLK), /* 15 Block device required */
603  MBED_DEFINE_POSIX_ERROR(EBUSY, EBUSY), /* 16 Device or resource busy */
604  MBED_DEFINE_POSIX_ERROR(EEXIST, EEXIST), /* 17 File exists */
605  MBED_DEFINE_POSIX_ERROR(EXDEV, EXDEV), /* 18 Cross-device link */
606  MBED_DEFINE_POSIX_ERROR(ENODEV, ENODEV), /* 19 No such device */
607  MBED_DEFINE_POSIX_ERROR(ENOTDIR, ENOTDIR), /* 20 Not a directory */
608  MBED_DEFINE_POSIX_ERROR(EISDIR, EISDIR), /* 21 Is a directory */
609  MBED_DEFINE_POSIX_ERROR(EINVAL, EINVAL), /* 22 Invalid argument */
610  MBED_DEFINE_POSIX_ERROR(ENFILE, ENFILE), /* 23 File table overflow */
611  MBED_DEFINE_POSIX_ERROR(EMFILE, EMFILE), /* 24 Too many open files */
612  MBED_DEFINE_POSIX_ERROR(ENOTTY, ENOTTY), /* 25 Not a typewriter */
613  MBED_DEFINE_POSIX_ERROR(ETXTBSY, ETXTBSY), /* 26 Text file busy */
614  MBED_DEFINE_POSIX_ERROR(EFBIG, EFBIG), /* 27 File too large */
615  MBED_DEFINE_POSIX_ERROR(ENOSPC, ENOSPC), /* 28 No space left on device */
616  MBED_DEFINE_POSIX_ERROR(ESPIPE, ESPIPE), /* 29 Illegal seek */
617  MBED_DEFINE_POSIX_ERROR(EROFS, EROFS), /* 30 Read-only file system */
618  MBED_DEFINE_POSIX_ERROR(EMLINK, EMLINK), /* 31 Too many links */
619  MBED_DEFINE_POSIX_ERROR(EPIPE, EPIPE), /* 32 Broken pipe */
620  MBED_DEFINE_POSIX_ERROR(EDOM, EDOM), /* 33 Math argument out of domain of func */
621  MBED_DEFINE_POSIX_ERROR(ERANGE, ERANGE), /* 34 Math result not representable */
622  MBED_DEFINE_POSIX_ERROR(EDEADLK, EDEADLK), /* 35 Resource deadlock would occur */
623  MBED_DEFINE_POSIX_ERROR(ENAMETOOLONG, ENAMETOOLONG), /* 36 File name too long */
624  MBED_DEFINE_POSIX_ERROR(ENOLCK, ENOLCK), /* 37 No record locks available */
625  MBED_DEFINE_POSIX_ERROR(ENOSYS, ENOSYS), /* 38 Function not implemented */
626  MBED_DEFINE_POSIX_ERROR(ENOTEMPTY, ENOTEMPTY), /* 39 Directory not empty */
627  MBED_DEFINE_POSIX_ERROR(ELOOP, ELOOP), /* 40 Too many symbolic links encountered */
628  MBED_DEFINE_POSIX_ERROR(EWOULDBLOCK, EAGAIN), /* EAGAIN Operation would block */
629  MBED_DEFINE_POSIX_ERROR(ENOMSG, ENOMSG), /* 42 No message of desired type */
630  MBED_DEFINE_POSIX_ERROR(EIDRM, EIDRM), /* 43 Identifier removed */
631  MBED_DEFINE_POSIX_ERROR(ECHRNG, ECHRNG), /* 44 Channel number out of range */
632  MBED_DEFINE_POSIX_ERROR(EL2NSYNC, EL2NSYNC), /* 45 Level 2 not synchronized */
633  MBED_DEFINE_POSIX_ERROR(EL3HLT, EL3HLT), /* 46 Level 3 halted */
634  MBED_DEFINE_POSIX_ERROR(EL3RST, EL3RST), /* 47 Level 3 reset */
635  MBED_DEFINE_POSIX_ERROR(ELNRNG, ELNRNG), /* 48 Link number out of range */
636  MBED_DEFINE_POSIX_ERROR(EUNATCH, EUNATCH), /* 49 Protocol driver not attached */
637  MBED_DEFINE_POSIX_ERROR(ENOCSI, ENOCSI), /* 50 No CSI structure available */
638  MBED_DEFINE_POSIX_ERROR(EL2HLT, EL2HLT), /* 51 Level 2 halted */
639  MBED_DEFINE_POSIX_ERROR(EBADE, EBADE), /* 52 Invalid exchange */
640  MBED_DEFINE_POSIX_ERROR(EBADR, EBADR), /* 53 Invalid request descriptor */
641  MBED_DEFINE_POSIX_ERROR(EXFULL, EXFULL), /* 54 Exchange full */
642  MBED_DEFINE_POSIX_ERROR(ENOANO, ENOANO), /* 55 No anode */
643  MBED_DEFINE_POSIX_ERROR(EBADRQC, EBADRQC), /* 56 Invalid request code */
644  MBED_DEFINE_POSIX_ERROR(EBADSLT, EBADSLT), /* 57 Invalid slot */
645  MBED_DEFINE_POSIX_ERROR(EDEADLOCK, EDEADLK), /* EDEADLK Resource deadlock would occur */
646  MBED_DEFINE_POSIX_ERROR(EBFONT, EBFONT), /* 59 Bad font file format */
647  MBED_DEFINE_POSIX_ERROR(ENOSTR, ENOSTR), /* 60 Device not a stream */
648  MBED_DEFINE_POSIX_ERROR(ENODATA, ENODATA), /* 61 No data available */
649  MBED_DEFINE_POSIX_ERROR(ETIME, ETIME), /* 62 Timer expired */
650  MBED_DEFINE_POSIX_ERROR(ENOSR, ENOSR), /* 63 Out of streams resources */
651  MBED_DEFINE_POSIX_ERROR(ENONET, ENONET), /* 64 Machine is not on the network */
652  MBED_DEFINE_POSIX_ERROR(ENOPKG, ENOPKG), /* 65 Package not installed */
653  MBED_DEFINE_POSIX_ERROR(EREMOTE, EREMOTE), /* 66 Object is remote */
654  MBED_DEFINE_POSIX_ERROR(ENOLINK, ENOLINK), /* 67 Link has been severed */
655  MBED_DEFINE_POSIX_ERROR(EADV, EADV), /* 68 Advertise error */
656  MBED_DEFINE_POSIX_ERROR(ESRMNT, ESRMNT), /* 69 Srmount error */
657  MBED_DEFINE_POSIX_ERROR(ECOMM, ECOMM), /* 70 Communication error on send */
658  MBED_DEFINE_POSIX_ERROR(EPROTO, EPROTO), /* 71 Protocol error */
659  MBED_DEFINE_POSIX_ERROR(EMULTIHOP, EMULTIHOP), /* 72 Multihop attempted */
660  MBED_DEFINE_POSIX_ERROR(EDOTDOT, EDOTDOT), /* 73 RFS specific error */
661  MBED_DEFINE_POSIX_ERROR(EBADMSG, EBADMSG), /* 74 Not a data message */
662  MBED_DEFINE_POSIX_ERROR(EOVERFLOW, EOVERFLOW), /* 75 Value too large for defined data type */
663  MBED_DEFINE_POSIX_ERROR(ENOTUNIQ, ENOTUNIQ), /* 76 Name not unique on network */
664  MBED_DEFINE_POSIX_ERROR(EBADFD, EBADFD), /* 77 File descriptor in bad state */
665  MBED_DEFINE_POSIX_ERROR(EREMCHG, EREMCHG), /* 78 Remote address changed */
666  MBED_DEFINE_POSIX_ERROR(ELIBACC, ELIBACC), /* 79 Can not access a needed shared library */
667  MBED_DEFINE_POSIX_ERROR(ELIBBAD, ELIBBAD), /* 80 Accessing a corrupted shared library */
668  MBED_DEFINE_POSIX_ERROR(ELIBSCN, ELIBSCN), /* 81 .lib section in a.out corrupted */
669  MBED_DEFINE_POSIX_ERROR(ELIBMAX, ELIBMAX), /* 82 Attempting to link in too many shared libraries */
670  MBED_DEFINE_POSIX_ERROR(ELIBEXEC, ELIBEXEC), /* 83 Cannot exec a shared library directly */
671  MBED_DEFINE_POSIX_ERROR(EILSEQ, EILSEQ), /* 84 Illegal byte sequence */
672  MBED_DEFINE_POSIX_ERROR(ERESTART, ERESTART), /* 85 Interrupted system call should be restarted */
673  MBED_DEFINE_POSIX_ERROR(ESTRPIPE, ESTRPIPE), /* 86 Streams pipe error */
674  MBED_DEFINE_POSIX_ERROR(EUSERS, EUSERS), /* 87 Too many users */
675  MBED_DEFINE_POSIX_ERROR(ENOTSOCK, ENOTSOCK), /* 88 Socket operation on non-socket */
676  MBED_DEFINE_POSIX_ERROR(EDESTADDRREQ, EDESTADDRREQ), /* 89 Destination address required */
677  MBED_DEFINE_POSIX_ERROR(EMSGSIZE, EMSGSIZE), /* 90 Message too long */
678  MBED_DEFINE_POSIX_ERROR(EPROTOTYPE, EPROTOTYPE), /* 91 Protocol wrong type for socket */
679  MBED_DEFINE_POSIX_ERROR(ENOPROTOOPT, ENOPROTOOPT), /* 92 Protocol not available */
680  MBED_DEFINE_POSIX_ERROR(EPROTONOSUPPORT, EPROTONOSUPPORT), /* 93 Protocol not supported */
681  MBED_DEFINE_POSIX_ERROR(ESOCKTNOSUPPORT, ESOCKTNOSUPPORT), /* 94 Socket type not supported */
682  MBED_DEFINE_POSIX_ERROR(EOPNOTSUPP, EOPNOTSUPP), /* 95 Operation not supported on transport endpoint */
683  MBED_DEFINE_POSIX_ERROR(EPFNOSUPPORT, EPFNOSUPPORT), /* 96 Protocol family not supported */
684  MBED_DEFINE_POSIX_ERROR(EAFNOSUPPORT, EAFNOSUPPORT), /* 97 Address family not supported by protocol */
685  MBED_DEFINE_POSIX_ERROR(EADDRINUSE, EADDRINUSE), /* 98 Address already in use */
686  MBED_DEFINE_POSIX_ERROR(EADDRNOTAVAIL, EADDRNOTAVAIL), /* 99 Cannot assign requested address */
687  MBED_DEFINE_POSIX_ERROR(ENETDOWN, ENETDOWN), /* 100 Network is down */
688  MBED_DEFINE_POSIX_ERROR(ENETUNREACH, ENETUNREACH), /* 101 Network is unreachable */
689  MBED_DEFINE_POSIX_ERROR(ENETRESET, ENETRESET), /* 102 Network dropped connection because of reset */
690  MBED_DEFINE_POSIX_ERROR(ECONNABORTED, ECONNABORTED), /* 103 Software caused connection abort */
691  MBED_DEFINE_POSIX_ERROR(ECONNRESET, ECONNRESET), /* 104 Connection reset by peer */
692  MBED_DEFINE_POSIX_ERROR(ENOBUFS, ENOBUFS), /* 105 No buffer space available */
693  MBED_DEFINE_POSIX_ERROR(EISCONN, EISCONN), /* 106 Transport endpoint is already connected */
694  MBED_DEFINE_POSIX_ERROR(ENOTCONN, ENOTCONN), /* 107 Transport endpoint is not connected */
695  MBED_DEFINE_POSIX_ERROR(ESHUTDOWN, ESHUTDOWN), /* 108 Cannot send after transport endpoint shutdown */
696  MBED_DEFINE_POSIX_ERROR(ETOOMANYREFS, ETOOMANYREFS), /* 109 Too many references: cannot splice */
697  MBED_DEFINE_POSIX_ERROR(ETIMEDOUT, ETIMEDOUT), /* 110 Connection timed out */
698  MBED_DEFINE_POSIX_ERROR(ECONNREFUSED, ECONNREFUSED), /* 111 Connection refused */
699  MBED_DEFINE_POSIX_ERROR(EHOSTDOWN, EHOSTDOWN), /* 112 Host is down */
700  MBED_DEFINE_POSIX_ERROR(EHOSTUNREACH, EHOSTUNREACH), /* 113 No route to host */
701  MBED_DEFINE_POSIX_ERROR(EALREADY, EALREADY), /* 114 Operation already in progress */
702  MBED_DEFINE_POSIX_ERROR(EINPROGRESS, EINPROGRESS), /* 115 Operation now in progress */
703  MBED_DEFINE_POSIX_ERROR(ESTALE, ESTALE), /* 116 Stale NFS file handle */
704  MBED_DEFINE_POSIX_ERROR(EUCLEAN, EUCLEAN), /* 117 Structure needs cleaning */
705  MBED_DEFINE_POSIX_ERROR(ENOTNAM, ENOTNAM), /* 118 Not a XENIX named type file */
706  MBED_DEFINE_POSIX_ERROR(ENAVAIL, ENAVAIL), /* 119 No XENIX semaphores available */
707  MBED_DEFINE_POSIX_ERROR(EISNAM, EISNAM), /* 120 Is a named type file */
708  MBED_DEFINE_POSIX_ERROR(EREMOTEIO, EREMOTEIO), /* 121 Remote I/O error */
709  MBED_DEFINE_POSIX_ERROR(EDQUOT, EDQUOT), /* 122 Quota exceeded */
710  MBED_DEFINE_POSIX_ERROR(ENOMEDIUM, ENOMEDIUM), /* 123 No medium found */
711  MBED_DEFINE_POSIX_ERROR(EMEDIUMTYPE, EMEDIUMTYPE), /* 124 Wrong medium type */
712  MBED_DEFINE_POSIX_ERROR(ECANCELED, ECANCELED), /* 125 Operation Canceled */
713  MBED_DEFINE_POSIX_ERROR(ENOKEY, ENOKEY), /* 126 Required key not available */
714  MBED_DEFINE_POSIX_ERROR(EKEYEXPIRED, EKEYEXPIRED), /* 127 Key has expired */
715  MBED_DEFINE_POSIX_ERROR(EKEYREVOKED, EKEYREVOKED), /* 128 Key has been revoked */
716  MBED_DEFINE_POSIX_ERROR(EKEYREJECTED, EKEYREJECTED), /* 129 Key was rejected by service */
717  MBED_DEFINE_POSIX_ERROR(EOWNERDEAD, EOWNERDEAD), /* 130 Owner died */
718  MBED_DEFINE_POSIX_ERROR(ENOTRECOVERABLE, ENOTRECOVERABLE), /* 131 State not recoverable */
719 
720  //Below are MBED SYSTEM ERROR CODE definitions
721  //MBED SYSTEM ERROR CODE definitions starts at offset MBED_SYSTEM_ERROR_BASE, see above.
722  // Error Name Error Offset Error Code
723  MBED_DEFINE_SYSTEM_ERROR(UNKNOWN, 0), /* 256 Unknown error */
724  MBED_DEFINE_SYSTEM_ERROR(INVALID_ARGUMENT, 1), /* 257 Invalid Argument */
725  MBED_DEFINE_SYSTEM_ERROR(INVALID_DATA_DETECTED, 2), /* 258 Invalid data detected */
726  MBED_DEFINE_SYSTEM_ERROR(INVALID_FORMAT, 3), /* 259 Invalid format */
727  MBED_DEFINE_SYSTEM_ERROR(INVALID_INDEX, 4), /* 260 Invalid Index */
728  MBED_DEFINE_SYSTEM_ERROR(INVALID_SIZE, 5), /* 261 Invalid Size */
729  MBED_DEFINE_SYSTEM_ERROR(INVALID_OPERATION, 6), /* 262 Invalid Operation */
730  MBED_DEFINE_SYSTEM_ERROR(ITEM_NOT_FOUND, 7), /* 263 Item Not Found */
731  MBED_DEFINE_SYSTEM_ERROR(ACCESS_DENIED, 8), /* 264 Access Denied */
732  MBED_DEFINE_SYSTEM_ERROR(UNSUPPORTED, 9), /* 265 Unsupported */
733  MBED_DEFINE_SYSTEM_ERROR(BUFFER_FULL, 10), /* 266 Buffer Full */
734  MBED_DEFINE_SYSTEM_ERROR(MEDIA_FULL, 11), /* 267 Media/Disk Full */
735  MBED_DEFINE_SYSTEM_ERROR(ALREADY_IN_USE, 12), /* 268 Already in use */
736  MBED_DEFINE_SYSTEM_ERROR(TIME_OUT, 13), /* 269 Timeout error */
737  MBED_DEFINE_SYSTEM_ERROR(NOT_READY, 14), /* 270 Not Ready */
738  MBED_DEFINE_SYSTEM_ERROR(FAILED_OPERATION, 15), /* 271 Requested Operation failed */
739  MBED_DEFINE_SYSTEM_ERROR(OPERATION_PROHIBITED, 16), /* 272 Operation prohibited */
740  MBED_DEFINE_SYSTEM_ERROR(OPERATION_ABORTED, 17), /* 273 Operation failed */
741  MBED_DEFINE_SYSTEM_ERROR(WRITE_PROTECTED, 18), /* 274 Attempt to write to write-protected resource */
742  MBED_DEFINE_SYSTEM_ERROR(NO_RESPONSE, 19), /* 275 No response */
743  MBED_DEFINE_SYSTEM_ERROR(SEMAPHORE_LOCK_FAILED, 20), /* 276 Semaphore lock failed */
744  MBED_DEFINE_SYSTEM_ERROR(MUTEX_LOCK_FAILED, 21), /* 277 Mutex lock failed */
745  MBED_DEFINE_SYSTEM_ERROR(SEMAPHORE_UNLOCK_FAILED, 22), /* 278 Semaphore unlock failed */
746  MBED_DEFINE_SYSTEM_ERROR(MUTEX_UNLOCK_FAILED, 23), /* 279 Mutex unlock failed */
747  MBED_DEFINE_SYSTEM_ERROR(CRC_ERROR, 24), /* 280 CRC error or mismatch */
748  MBED_DEFINE_SYSTEM_ERROR(OPEN_FAILED, 25), /* 281 Open failed */
749  MBED_DEFINE_SYSTEM_ERROR(CLOSE_FAILED, 26), /* 282 Close failed */
750  MBED_DEFINE_SYSTEM_ERROR(READ_FAILED, 27), /* 283 Read failed */
751  MBED_DEFINE_SYSTEM_ERROR(WRITE_FAILED, 28), /* 284 Write failed */
752  MBED_DEFINE_SYSTEM_ERROR(INITIALIZATION_FAILED, 29), /* 285 Initialization failed */
753  MBED_DEFINE_SYSTEM_ERROR(BOOT_FAILURE, 30), /* 286 Boot failure */
754  MBED_DEFINE_SYSTEM_ERROR(OUT_OF_MEMORY, 31), /* 287 Out of memory */
755  MBED_DEFINE_SYSTEM_ERROR(OUT_OF_RESOURCES, 32), /* 288 Out of resources */
756  MBED_DEFINE_SYSTEM_ERROR(ALLOC_FAILED, 33), /* 289 Alloc failed */
757  MBED_DEFINE_SYSTEM_ERROR(FREE_FAILED, 34), /* 290 Free failed */
758  MBED_DEFINE_SYSTEM_ERROR(OVERFLOW, 35), /* 291 Overflow error */
759  MBED_DEFINE_SYSTEM_ERROR(UNDERFLOW, 36), /* 292 Underflow error */
760  MBED_DEFINE_SYSTEM_ERROR(STACK_OVERFLOW, 37), /* 293 Stack overflow error */
761  MBED_DEFINE_SYSTEM_ERROR(ISR_QUEUE_OVERFLOW, 38), /* 294 ISR queue overflow */
762  MBED_DEFINE_SYSTEM_ERROR(TIMER_QUEUE_OVERFLOW, 39), /* 295 Timer Queue overflow */
763  MBED_DEFINE_SYSTEM_ERROR(CLIB_SPACE_UNAVAILABLE, 40), /* 296 Standard library error - Space unavailable */
764  MBED_DEFINE_SYSTEM_ERROR(CLIB_EXCEPTION, 41), /* 297 Standard library error - Exception */
765  MBED_DEFINE_SYSTEM_ERROR(CLIB_MUTEX_INIT_FAILURE, 42), /* 298 Standard library error - Mutex Init failure */
766  MBED_DEFINE_SYSTEM_ERROR(CREATE_FAILED, 43), /* 299 Create failed */
767  MBED_DEFINE_SYSTEM_ERROR(DELETE_FAILED, 44), /* 300 Delete failed */
768  MBED_DEFINE_SYSTEM_ERROR(THREAD_CREATE_FAILED, 45), /* 301 Thread Create failed */
769  MBED_DEFINE_SYSTEM_ERROR(THREAD_DELETE_FAILED, 46), /* 302 Thread Delete failed */
770  MBED_DEFINE_SYSTEM_ERROR(PROHIBITED_IN_ISR_CONTEXT, 47), /* 303 Operation Prohibited in ISR context */
771  MBED_DEFINE_SYSTEM_ERROR(PINMAP_INVALID, 48), /* 304 Pinmap Invalid */
772  MBED_DEFINE_SYSTEM_ERROR(RTOS_EVENT, 49), /* 305 Unknown Rtos Error */
773  MBED_DEFINE_SYSTEM_ERROR(RTOS_THREAD_EVENT, 50), /* 306 Rtos Thread Error */
774  MBED_DEFINE_SYSTEM_ERROR(RTOS_MUTEX_EVENT, 51), /* 307 Rtos Mutex Error */
775  MBED_DEFINE_SYSTEM_ERROR(RTOS_SEMAPHORE_EVENT, 52), /* 308 Rtos Semaphore Error */
776  MBED_DEFINE_SYSTEM_ERROR(RTOS_MEMORY_POOL_EVENT, 53), /* 309 Rtos Memory Pool Error */
777  MBED_DEFINE_SYSTEM_ERROR(RTOS_TIMER_EVENT, 54), /* 310 Rtos Timer Error */
778  MBED_DEFINE_SYSTEM_ERROR(RTOS_EVENT_FLAGS_EVENT, 55), /* 311 Rtos Event flags Error */
779  MBED_DEFINE_SYSTEM_ERROR(RTOS_MESSAGE_QUEUE_EVENT, 56), /* 312 Rtos Message queue Error */
780  MBED_DEFINE_SYSTEM_ERROR(DEVICE_BUSY, 57), /* 313 Device Busy */
781  MBED_DEFINE_SYSTEM_ERROR(CONFIG_UNSUPPORTED, 58), /* 314 Configuration not supported */
782  MBED_DEFINE_SYSTEM_ERROR(CONFIG_MISMATCH, 59), /* 315 Configuration mismatch */
783  MBED_DEFINE_SYSTEM_ERROR(ALREADY_INITIALIZED, 60), /* 316 Already initialized */
784  MBED_DEFINE_SYSTEM_ERROR(HARDFAULT_EXCEPTION, 61), /* 317 HardFault exception */
785  MBED_DEFINE_SYSTEM_ERROR(MEMMANAGE_EXCEPTION, 62), /* 318 MemManage exception */
786  MBED_DEFINE_SYSTEM_ERROR(BUSFAULT_EXCEPTION, 63), /* 319 BusFault exception */
787  MBED_DEFINE_SYSTEM_ERROR(USAGEFAULT_EXCEPTION, 64), /* 320 UsageFault exception*/
788  MBED_DEFINE_SYSTEM_ERROR(BLE_NO_FRAME_INITIALIZED, 65), /* 321 BLE No frame initialized */
789  MBED_DEFINE_SYSTEM_ERROR(BLE_BACKEND_CREATION_FAILED, 66), /* 322 BLE Backend creation failed */
790  MBED_DEFINE_SYSTEM_ERROR(BLE_BACKEND_NOT_INITIALIZED, 67), /* 323 BLE Backend not initialized */
791  MBED_DEFINE_SYSTEM_ERROR(ASSERTION_FAILED, 68), /* 324 Assertion Failed */
792  MBED_DEFINE_SYSTEM_ERROR(AUTHENTICATION_FAILED, 69), /* 325 Authentication Failed */
793  MBED_DEFINE_SYSTEM_ERROR(RBP_AUTHENTICATION_FAILED, 70), /* 326 Rollback Protection Authentication Failed */
794  MBED_DEFINE_SYSTEM_ERROR(BLE_USE_INCOMPATIBLE_API, 71), /* 327 Concurrent use of incompatible versions of a BLE API */
795  MBED_DEFINE_SYSTEM_ERROR(BLE_ILLEGAL_STATE, 72), /* 328 BLE stack entered illegal state */
796 
797  //Everytime you add a new system error code, you must update
798  //Error documentation under Handbook to capture the info on
799  //the new error status/codes
800 
801  //MBED CUSTOM ERROR CODE definitions starts at offset MBED_CUSTOM_ERROR_BASE, see above.
802  /* Add More/Custom Error Codes here, See example below */
803  //DEFINE_CUSTOM_ERROR( MY_CUSTOM_ERROR , 1 ),
804 
805 } mbed_error_code_t;
806 
807 /** mbed_error_ctx struct
808  *
809  * This struct captures the context information at the time of error.\n
810  * It primarily contains information about the thread where the error originated,\n
811  * filename/line number of the source file where the error occurred, a context specific error value(error_value)\n
812  * and the address where the error originated.\n
813  *
814  * @note
815  * Below are the members of mbed_error_ctx struct\n
816  * error_status mbed_error_status_t value for this error\n
817  * error_function_address Address where the error occurred\n
818  * thread_id ID of the thread which generated the error\n
819  * thread_entry_address Entry function of the thread which generated the error\n
820  * thread_stack_size Stack Size of the thread which generated the error\n
821  * thread_stack_mem Stack Top of the thread which generated the error\n
822  * thread_current_sp Current Stack Pointer of the thread which generated the error\n
823  * error_value A context/error specific value associated with this error\n
824  * error_filename Filename where the error originated\n
825  * error_line_number Line number in error_filename where the error originated\n
826  */
827 typedef struct _mbed_error_ctx {
828  mbed_error_status_t error_status;
829  uint32_t error_address;
830  uint32_t error_value;
831  uint32_t thread_id;
832  uint32_t thread_entry_address;
833  uint32_t thread_stack_size;
834  uint32_t thread_stack_mem;
835  uint32_t thread_current_sp;
836 #ifdef MBED_CONF_PLATFORM_MAX_ERROR_FILENAME_LEN
837  char error_filename[MBED_CONF_PLATFORM_MAX_ERROR_FILENAME_LEN];
838  uint32_t error_line_number;
839 #endif
840 #if MBED_CONF_PLATFORM_CRASH_CAPTURE_ENABLED
841  int32_t error_reboot_count;//everytime we write this struct we increment this value by 1, irrespective of time between reboots. Note that the data itself might change, but everytime we reboot due to error we update this count by 1
842  int32_t is_error_processed;//once this error is processed set this value to 1
843  uint32_t crc_error_ctx;//crc_error_ctx should always be the last member in this struct
844 #endif
845 } mbed_error_ctx;
846 
847 /** To generate a fatal compile-time error, you can use the pre-processor #error directive.
848  *
849  * @param format C string that contains data stream to be printed.
850  * Code snippets below show valid format.
851  *
852  * @code
853  * #error "That shouldn't have happened!"
854  * @endcode
855  *
856  * If the compiler evaluates this line, it will report the error and stop the compile.
857  *
858  * For example, you could use this to check some user-defined compile-time variables:
859  *
860  * @code
861  * #define NUM_PORTS 7
862  * #if (NUM_PORTS > 4)
863  * #error "NUM_PORTS must be less than 4"
864  * #endif
865  * @endcode
866  *
867  * Reporting Run-Time Errors:
868  * To generate a fatal run-time error, you can use the mbed error() function.
869  *
870  * @code
871  * error("That shouldn't have happened!");
872  * @endcode
873  *
874  * If the mbed running the program executes this function, it will print the
875  * message via the USB serial port, and then die with the blue lights of death!
876  *
877  * The message can use printf-style formatting, so you can report variables in the
878  * message too. For example, you could use this to check a run-time condition:
879  *
880  * @code
881  * if(x >= 5) {
882  * error("expected x to be less than 5, but got %d", x);
883  * }
884  * @endcode
885  *
886  *
887  */
888 
889 MBED_NORETURN void error(const char *format, ...) MBED_PRINTF(1, 2);
890 
891 /**
892  * Call this Macro to generate a mbed_error_status_t value for a System error
893  * @param module Module generating the error code. If its unknown, pass MBED_MODULE_UNKNOWN. See mbed_module_type_t for module types.
894  * @param error_code The mbed_error_code_t code to be used in generating the mbed_error_status_t. See mbed_error_code_t for error codes.
895  *
896  * @code
897  *
898  * mbed_error_status_t driver_error = MBED_MAKE_SYSTEM_ERROR( MODULE_DRIVER_USB, MBED_ERROR_CODE_INITIALIZATION_FAILED )
899  *
900  * @endcode
901  * @note This macro generate mbed_error_status_t-es with error type set to MBED_ERROR_TYPE_SYSTEM
902  *
903  */
904 #define MBED_MAKE_SYSTEM_ERROR(module, error_code) MAKE_MBED_ERROR(MBED_ERROR_TYPE_SYSTEM, module, error_code)
905 
906 /**
907  * Call this Macro to generate a mbed_error_status_t value for a Custom error
908  * @param module Module generating the error code. If its unknown, pass MBED_MODULE_UNKNOWN. See mbed_module_type_t for module types.
909  * @param error_code The mbed_error_code_t code to be used in generating the mbed_error_status_t. See mbed_error_code_t for error codes.
910  *
911  * @code
912  *
913  * mbed_error_status_t custom_error = MBED_MAKE_CUSTOM_ERROR( MBED_MODULE_APPLICATION, 0xDEAD//16-bit custom error code )
914  *
915  * @endcode
916  * @note This macro generate mbed_error_status_t-es with error type set to MBED_ERROR_TYPE_CUSTOM
917  *
918  */
919 #define MBED_MAKE_CUSTOM_ERROR(module, error_code) MAKE_MBED_ERROR(MBED_ERROR_TYPE_CUSTOM, module, error_code)
920 
921 /**
922  * Call this Macro to generate a mbed_error_status_t value for a System error
923  * @param module Module generating the error code. If its unknown, pass MBED_MODULE_UNKNOWN. See mbed_module_type_t for module types.
924  * @param error_code The mbed_error_code_t code to be used in generating the mbed_error_status_t. See mbed_error_code_t for error codes.
925  *
926  * @code
927  *
928  * mbed_error_status_t new_error = MBED_MAKE_ERROR( MODULE_DRIVER_USB, MBED_ERROR_INITIALIZATION_FAILED )
929  *
930  * @endcode
931  * @note This macro generate mbed_error_status_t-es with error type set to MBED_ERROR_TYPE_SYSTEM
932  *
933  */
934 #define MBED_MAKE_ERROR(module, error_code) MBED_MAKE_SYSTEM_ERROR(module, error_code)
935 
936 /**
937  * Callback/Error hook function prototype. Applications needing a callback when an error is reported can use mbed_set_error_hook function
938  * to register a callback/error hook function using the following prototype. When an error happens in the system error handling
939  * implementation will invoke this callback with the mbed_error_status_t reported and the error context at the time of error.
940  * @param error_ctx Error context structure associated with this error.
941  * @return void
942  *
943  */
944 typedef void (*mbed_error_hook_t)(const mbed_error_ctx *error_ctx);
945 
946 
947 /**
948  * Callback function for reporting error context during boot up. When MbedOS error handling system detects a fatal error
949  * it will auto-reboot the system(if MBED_CONF_PLATFORM_FATAL_ERROR_AUTO_REBOOT_ENABLED is enabled) after capturing the
950  * error info in special crash data RAM region. Once rebooted, MbedOS initialization routines will call this function with a pointer to
951  * the captured mbed_error_ctx structure. If application implementation needs to receive this callback, mbed_error_reboot_callback
952  * function should be overridden with custom implementation. By default it's defined as a WEAK function in mbed_error.c.
953  * Note that this callback will be invoked before the system starts executing main() function. So the implementation of
954  * the callback should be aware any resource limitations/availability of resources which are yet to be initialized by application main().
955  *
956  * @param error_ctx Error context structure associated with this error.
957  * @return void
958  *
959  */
960 void mbed_error_reboot_callback(mbed_error_ctx *error_context);
961 
962 /**
963  * Initialize error handling system, this is called by the mbed-os boot sequence. This is not required to be called by Application unless the boot sequence is overridden by the system implementation.
964  * NOTE: If MBED_CONF_PLATFORM_FATAL_ERROR_AUTO_REBOOT_ENABLED is enabled and if the current reboot count exceeds MBED_CONF_PLATFORM_ERROR_REBOOT_MAX the system will halt when this function is called,
965  * and in such cases the caller will not get the control back. Also note that calling this function may trigger mbed_error_reboot_callback() if application side overides mbed_error_reboot_callback().
966  * @return MBED_SUCCESS on success.
967  *
968  */
969 
970 mbed_error_status_t mbed_error_initialize(void);
971 
972 /**
973  * Call this function to retrieve the error context after a fatal error which triggered a system reboot. The function retrieves the error context stored in crash-report ram area which is preserved over reboot.
974  * @param error_info Pointer to mbed_error_ctx struct allocated by the caller. This is the mbed_error_ctx info captured as part of the fatal error which triggered the reboot.
975  * @return 0 or MBED_SUCCESS on success.
976  * MBED_ERROR_INVALID_ARGUMENT in case of invalid error_info pointer
977  * MBED_ERROR_ITEM_NOT_FOUND if no reboot context is currently captured by the system
978  *
979  */
980 mbed_error_status_t mbed_get_reboot_error_info(mbed_error_ctx *error_info);
981 
982 /**
983  * Calling this function resets the current reboot context captured by the system(stored in special crash data RAM region).
984  * @return MBED_SUCCESS on success.
985  * MBED_ERROR_ITEM_NOT_FOUND if no reboot context is currently captured by the system
986  */
987 mbed_error_status_t mbed_reset_reboot_error_info(void);
988 
989 /**
990  * Calling this function resets the current reboot count stored as part of error context captured in special crash data RAM region.
991  * The function will also update the CRC value stored as part of error context accordingly.
992  * @return MBED_SUCCESS on success.
993  * MBED_ERROR_ITEM_NOT_FOUND if no reboot context is currently captured by the system
994  */
995 mbed_error_status_t mbed_reset_reboot_count(void);
996 
997 /**
998  * Call this function to set a system error/warning. This function will log the error status with the context info and return to caller.
999  *
1000  * @param error_status mbed_error_status_t status to be set(See mbed_error_status_t enum above for available error status values).
1001  * @param error_msg The error message to be printed out to STDIO/Serial.
1002  * @param error_value Value associated with the error status. This would depend on error code/error scenario.
1003  * @param filename Name of the source file originating the error( Most callers can pass __FILE__ here ).
1004  * @param line_number The line number of the source file originating the error( Most callers can pass __LINE__ here ) .
1005  * @return 0 or MBED_SUCCESS.
1006  * MBED_ERROR_INVALID_ARGUMENT if called with invalid error status/codes
1007  *
1008  * @code
1009  *
1010  * mbed_error( ERROR_OUT_OF_MEMORY, "Out of memory error", 0, __FILE__, __LINE__ )
1011  *
1012  * @endcode
1013  *
1014  * @note See MBED_WARNING/MBED_ERROR macros which provides a wrapper on this API
1015  */
1016 mbed_error_status_t mbed_warning(mbed_error_status_t error_status, const char *error_msg, unsigned int error_value, const char *filename, int line_number);
1017 
1018 /**
1019  * Returns the first system error reported.
1020  * @return mbed_error_status_t code logged for the first error or MBED_SUCCESS if no errors are logged.
1021  *
1022  */
1023 mbed_error_status_t mbed_get_first_error(void);
1024 
1025 /**
1026  * Returns the most recent system error reported.
1027  * @return mbed_error_status_t code logged for the last error or MBED_SUCCESS if no errors are logged.
1028  *
1029  */
1030 mbed_error_status_t mbed_get_last_error(void);
1031 
1032 /**
1033  * Returns the number of system errors reported after boot.
1034  * @return int Number of errors reported.
1035  *
1036  */
1037 int mbed_get_error_count(void);
1038 
1039 /**
1040  * Call this function to set a fatal system error and halt the system. This function will log the fatal error with the context info and prints the error report and halts the system.
1041  *
1042  * @param error_status mbed_error_status_t status to be set(See mbed_error_status_t enum above for available error status values).
1043  * @param error_msg The error message to be printed out to STDIO/Serial.
1044  * @param error_value Value associated with the error status. This would depend on error code/error scenario.
1045  * @param filename Name of the source file originating the error( Most callers can pass __FILE__ here ).
1046  * @param line_number The line number of the source file originating the error( Most callers can pass __LINE__ here ) .
1047  * @return Does not return.
1048  *
1049  * @code
1050  *
1051  * mbed_error( MBED_ERROR_PROHIBITED_OPERATION, "Prohibited operation tried", 0, __FILE__, __LINE__ )
1052  *
1053  * @endcode
1054  *
1055  * @note See MBED_WARNING/MBED_ERROR macros which provides a wrapper on this API
1056  */
1057 MBED_NORETURN mbed_error_status_t mbed_error(mbed_error_status_t error_status, const char *error_msg, unsigned int error_value, const char *filename, int line_number);
1058 
1059 /**
1060  * Registers an application defined error callback with the error handling system.
1061  * This function will be called with error context info whenever system handles a mbed_error/mbed_warning call
1062  * NOTE: This function should be implemented for re-entrancy as multiple threads may invoke mbed_error which may cause error hook to be called.
1063  * @param custom_error_hook mbed_error_status_t status to be set(See mbed_error_status_t enum above for available error status values).
1064  * @return 0 or MBED_SUCCESS on success.
1065  * MBED_ERROR_INVALID_ARGUMENT in case of NULL for custom_error_hook
1066  *
1067  * @code
1068  *
1069  * mbed_error_status_t my_custom_error_hook(mbed_error_status_t error_status, const mbed_error_ctx *error_ctx) {
1070  * //Do something with the error_status or error_ctx
1071  * }
1072  *
1073  * mbed_set_error_hook( my_custom_error_hook )
1074  *
1075  * @endcode
1076  * @note The erro hook function implementation should be re-entrant.
1077  *
1078  */
1079 mbed_error_status_t mbed_set_error_hook(mbed_error_hook_t custom_error_hook);
1080 
1081 /**
1082  * Reads the first error context information captured.
1083  * @param error_info This is the mbed_error_context info captured as part of the first mbed_error call. The caller should pass a pointer to mbed_error_context struct allocated by the caller.
1084  * @return 0 or MBED_SUCCESS on success.
1085  * MBED_ERROR_INVALID_ARGUMENT in case of invalid index
1086  *
1087  */
1088 mbed_error_status_t mbed_get_first_error_info(mbed_error_ctx *error_info);
1089 
1090 /**
1091  * Reads the last error context information captured.
1092  * @param error_info This is the mbed_error_context info captured as part of the last mbed_error call. The caller should pass a pointer to mbed_error_context struct allocated by the caller.
1093  * @return 0 or MBED_ERROR_SUCCESS on success.
1094  * MBED_ERROR_INVALID_ARGUMENT in case of invalid index
1095  *
1096  */
1097 mbed_error_status_t mbed_get_last_error_info(mbed_error_ctx *error_info);
1098 
1099 /**
1100  * Clears the last error, first error, error count and all entries in the error history.
1101  * @return 0 or MBED_SUCCESS on success.
1102  *
1103  */
1104 mbed_error_status_t mbed_clear_all_errors(void);
1105 
1106 /**
1107  * Generates a mbed_error_status_t value based on passed in values for type, module and error code.
1108  * @param error_type Error type based on mbed_error_type_t enum.
1109  * @param module Module type based on mbed_module_type_t enum.
1110  * @param error_code Error codes defined by mbed_error_code_t enum
1111  * @return 0 or MBED_ERROR_SUCCESS on success.
1112  *
1113  */
1114 mbed_error_status_t mbed_make_error(mbed_error_type_t error_type, mbed_module_type_t module, mbed_error_code_t error_code);
1115 
1116 /**
1117  * Returns the current number of entries in the error history, if there has been more than max number of errors logged the number returned will be max depth of error history.
1118  * @return Current number of entries in the error history.
1119  *
1120  */
1121 int mbed_get_error_hist_count(void);
1122 
1123 /**
1124  * Reads the error context information for a specific error from error history, specified by the index.
1125  *
1126  * @param index index of the error context entry in the history to be retrieved.\n
1127  * The number of entries in the error history is configured during build and the max index depends on max depth of error history.\n
1128  * index = 0 points to the oldest entry in the history, and index = (max history depth - 1) points to the latest entry in the error history.\n
1129  * @param error_info This is the mbed_error_context info captured as part of the error history. The caller should pass a pointer to mbed_error_context struct allocated by the caller.
1130  * @return 0 or MBED_SUCCESS on success.
1131  * MBED_ERROR_INVALID_ARGUMENT in case of invalid index
1132  *
1133  */
1134 mbed_error_status_t mbed_get_error_hist_info(int index, mbed_error_ctx *error_info);
1135 
1136 /**
1137  * Saves the error history information to a file
1138  *
1139  * @param path path to the file in the filesystem
1140  * @return 0 or MBED_ERROR_SUCCESS on success.
1141  * MBED_ERROR_WRITE_FAILED if writing to file failed
1142  * MBED_ERROR_INVALID_ARGUMENT if path is not valid
1143  *
1144  * @note Filesystem support is required in order for this function to work.
1145  *
1146  */
1147 mbed_error_status_t mbed_save_error_hist(const char *path);
1148 
1149 #ifdef __cplusplus
1150 }
1151 #endif
1152 
1153 #endif
1154 
1155 /** @}*/
1156 /** @}*/
1157 
1158 
mbed_set_error_hook
mbed_error_status_t mbed_set_error_hook(mbed_error_hook_t custom_error_hook)
Registers an application defined error callback with the error handling system.
mbed_error_initialize
mbed_error_status_t mbed_error_initialize(void)
Initialize error handling system, this is called by the mbed-os boot sequence.
mbed_error_reboot_callback
void mbed_error_reboot_callback(mbed_error_ctx *error_context)
Callback function for reporting error context during boot up.
error
MBED_NORETURN void error(const char *format,...) MBED_PRINTF(1
To generate a fatal compile-time error, you can use the pre-processor error directive.
_mbed_module_type
_mbed_module_type
mbed_module_type_t definition
Definition: mbed_error.h:264
mbed_error_type_t
enum _mbed_error_type_t mbed_error_type_t
mbed_error_type_t definition
MBED_DEFINE_POSIX_ERROR
#define MBED_DEFINE_POSIX_ERROR(error_name, error_code)
Macro for defining a POSIX error status.
Definition: mbed_error.h:112
mbed_make_error
mbed_error_status_t mbed_make_error(mbed_error_type_t error_type, mbed_module_type_t module, mbed_error_code_t error_code)
Generates a mbed_error_status_t value based on passed in values for type, module and error code...
mbed_get_error_count
int mbed_get_error_count(void)
Returns the number of system errors reported after boot.
mbed_get_last_error
mbed_error_status_t mbed_get_last_error(void)
Returns the most recent system error reported.
mbed_get_last_error_info
mbed_error_status_t mbed_get_last_error_info(mbed_error_ctx *error_info)
Reads the last error context information captured.
mbed_get_error_hist_count
int mbed_get_error_hist_count(void)
Returns the current number of entries in the error history, if there has been more than max number of...
mbed_error_code_t
enum _mbed_error_code mbed_error_code_t
mbed_error_code_t definition
mbed_error
MBED_NORETURN mbed_error_status_t mbed_error(mbed_error_status_t error_status, const char *error_msg, unsigned int error_value, const char *filename, int line_number)
Call this function to set a fatal system error and halt the system.
mbed_get_error_hist_info
mbed_error_status_t mbed_get_error_hist_info(int index, mbed_error_ctx *error_info)
Reads the error context information for a specific error from error history, specified by the index...
mbed_module_type_t
enum _mbed_module_type mbed_module_type_t
mbed_module_type_t definition
mbed_clear_all_errors
mbed_error_status_t mbed_clear_all_errors(void)
Clears the last error, first error, error count and all entries in the error history.
mbed_warning
mbed_error_status_t mbed_warning(mbed_error_status_t error_status, const char *error_msg, unsigned int error_value, const char *filename, int line_number)
Call this function to set a system error/warning.
MBED_DEFINE_SYSTEM_ERROR
#define MBED_DEFINE_SYSTEM_ERROR(error_name, error_code)
Macro for defining a System error status.
Definition: mbed_error.h:122
mbed_error_ctx
struct _mbed_error_ctx mbed_error_ctx
mbed_error_ctx struct
mbed_reset_reboot_count
mbed_error_status_t mbed_reset_reboot_count(void)
Calling this function resets the current reboot count stored as part of error context captured in spe...
mbed_error_status_t
int mbed_error_status_t
mbed_error_status_t description
Definition: mbed_error.h:104
_mbed_error_type_t
_mbed_error_type_t
mbed_error_type_t definition
Definition: mbed_error.h:208
_mbed_error_code
_mbed_error_code
mbed_error_code_t definition
Definition: mbed_error.h:583
mbed_get_first_error_info
mbed_error_status_t mbed_get_first_error_info(mbed_error_ctx *error_info)
Reads the first error context information captured.
mbed_get_first_error
mbed_error_status_t mbed_get_first_error(void)
Returns the first system error reported.
MBED_NORETURN
#define MBED_NORETURN
MBED_NORETURN Declare a function that will never return.
Definition: mbed_toolchain.h:235
mbed_save_error_hist
mbed_error_status_t mbed_save_error_hist(const char *path)
Saves the error history information to a file.
mbed_error_hook_t
void(* mbed_error_hook_t)(const mbed_error_ctx *error_ctx)
Callback/Error hook function prototype.
Definition: mbed_error.h:944
mbed_reset_reboot_error_info
mbed_error_status_t mbed_reset_reboot_error_info(void)
Calling this function resets the current reboot context captured by the system(stored in special cras...
mbed_get_reboot_error_info
mbed_error_status_t mbed_get_reboot_error_info(mbed_error_ctx *error_info)
Call this function to retrieve the error context after a fatal error which triggered a system reboot...
_mbed_error_ctx
mbed_error_ctx struct
Definition: mbed_error.h:827
MBED_CONF_PLATFORM_MAX_ERROR_FILENAME_LEN
#define MBED_CONF_PLATFORM_MAX_ERROR_FILENAME_LEN
Define this macro to include filenames in error context.
Definition: mbed_error.h:42
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.