Theo/Ludo/Joe
/
ER2_Labyrinthe_V3
Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependencies: mbed
Embed:
(wiki syntax)
Show/hide line numbers
mbed_error.h
00001 /** \addtogroup platform */ 00002 /** @{*/ 00003 /** 00004 * \defgroup platform_error Error functions 00005 * @{ 00006 */ 00007 /* mbed Microcontroller Library 00008 * Copyright (c) 2006-2013 ARM Limited 00009 * 00010 * Licensed under the Apache License, Version 2.0 (the "License"); 00011 * you may not use this file except in compliance with the License. 00012 * You may obtain a copy of the License at 00013 * 00014 * http://www.apache.org/licenses/LICENSE-2.0 00015 * 00016 * Unless required by applicable law or agreed to in writing, software 00017 * distributed under the License is distributed on an "AS IS" BASIS, 00018 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 00019 * See the License for the specific language governing permissions and 00020 * limitations under the License. 00021 */ 00022 #ifndef MBED_ERROR_H 00023 #define MBED_ERROR_H 00024 00025 #include "platform/mbed_retarget.h" 00026 #include "platform/mbed_toolchain.h" 00027 00028 #ifdef __cplusplus 00029 extern "C" { 00030 #endif 00031 00032 /** Define this macro to include filenames in error context. For release builds, do not include filename to save memory. 00033 * MBED_PLATFORM_CONF_ERROR_FILENAME_CAPTURE_ENABLED 00034 */ 00035 00036 /** Define this macro to enable error history 00037 * MBED_PLATFORM_CONF_ERROR_HIST_ENABLED 00038 */ 00039 00040 #ifndef MBED_CONF_PLATFORM_MAX_ERROR_FILENAME_LEN 00041 #define MBED_CONF_PLATFORM_MAX_ERROR_FILENAME_LEN 16 00042 #else //MBED_CONF_PLATFORM_MAX_ERROR_FILENAME_LEN 00043 #if MBED_CONF_PLATFORM_MAX_ERROR_FILENAME_LEN > 64 00044 //We have to limit this to 64 bytes since we use mbed_error_printf for error reporting 00045 //and mbed_error_vfprintf uses 128bytes internal buffer which may not be sufficient for anything 00046 //longer that 64 bytes with the current implementation. 00047 #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." 00048 #endif 00049 #endif 00050 00051 #define MBED_ERROR_STATUS_CODE_MASK (0x0000FFFF) 00052 #define MBED_ERROR_STATUS_CODE_POS (0) 00053 #define MBED_ERROR_STATUS_CODE_FIELD_SIZE (16) 00054 00055 #define MBED_ERROR_STATUS_MODULE_MASK (0x00FF0000) 00056 #define MBED_ERROR_STATUS_MODULE_POS (16) 00057 #define MBED_ERROR_STATUS_MODULE_FIELD_SIZE (8) 00058 00059 #define MBED_ERROR_STATUS_TYPE_MASK (0x60000000) 00060 #define MBED_ERROR_STATUS_TYPE_POS (29) 00061 #define MBED_ERROR_STATUS_TYPE_FIELD_SIZE (2) 00062 00063 /* mbed_error_status_t Status Encoding */ 00064 //|31(1 bit) Always Negative|30-29(2 bits) |28-24 | 23-16(8 bits) | 15-0(16 bits) | 00065 //|-1 |TYPE |(unused/reserved) | MODULE TYPE | ERROR CODE | 00066 00067 #define MAKE_MBED_ERROR(type, module, error_code) (mbed_error_status_t) \ 00068 ((0x80000000) | \ 00069 (MBED_ERROR_STATUS_CODE_MASK & (error_code << MBED_ERROR_STATUS_CODE_POS)) | \ 00070 (MBED_ERROR_STATUS_MODULE_MASK & (module << MBED_ERROR_STATUS_MODULE_POS)) | \ 00071 (MBED_ERROR_STATUS_TYPE_MASK & (type << MBED_ERROR_STATUS_TYPE_POS))) 00072 00073 #define MBED_GET_ERROR_TYPE( error_status ) ((error_status & MBED_ERROR_STATUS_TYPE_MASK) >> MBED_ERROR_STATUS_TYPE_POS) 00074 #define MBED_GET_ERROR_MODULE( error_status ) ((error_status & MBED_ERROR_STATUS_MODULE_MASK) >> MBED_ERROR_STATUS_MODULE_POS) 00075 #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)) 00076 00077 /** mbed_error_status_t description 00078 * 00079 * 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 00080 * Internally its encoded as below with bit-fields representing error type, module and error code:\n\n 00081 * mbed_error_status_t Status Encoding:\n 00082 * 00083 \verbatim 00084 | 31 Always Negative | 30-29(2 bits) | 28-24 | 23-16(8 bits) | 15-0(16 bits) | 00085 | -1 | TYPE | (unused/reserved) | MODULE TYPE | ERROR CODE | 00086 \endverbatim 00087 * 00088 * The error status value range for each error type is as follows:\n 00089 * Posix Error Status-es - 0xFFFFFFFF to 0xFFFFFF01(-1 -255) - This corresponds to Posix error codes represented as negative.\n 00090 * 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 00091 * 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 00092 * 00093 * 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 00094 * Posix Error Codes - 1 to 255.\n 00095 * System Error Codes - 256 to 4095.\n 00096 * Custom Error Codes - 4096 to 65535.\n 00097 * 00098 * @note Posix error codes are always encoded as negative of their actual value. For example, EPERM is encoded as -EPERM. 00099 * And, the MODULE TYPE for Posix error codes are always encoded as MBED_MODULE_UNKNOWN.\n 00100 * This is to enable easy injection of Posix error codes into MbedOS error handling system without altering the actual Posix error values.\n 00101 * Accordingly, Posix error codes are represented as -1 to -255 under MbedOS error status representation. 00102 */ 00103 typedef int mbed_error_status_t; 00104 00105 /** 00106 * Macro for defining a Posix error status. This macro is mainly used to define Posix error values in mbed_error_code_t enumeration. 00107 * @param error_name Name of the error without the ERROR_ prefix 00108 * @param error_code Error code value to be used, must be between 1 and 255(inclusive). 00109 * 00110 */ 00111 #define MBED_DEFINE_POSIX_ERROR( error_name, error_code ) \ 00112 MBED_ERROR_CODE_##error_name = error_code, \ 00113 MBED_ERROR_##error_name = -(MBED_POSIX_ERROR_BASE + error_code) 00114 00115 /** 00116 * Macro for defining a System error status. This macro is used to define System error values in mbed_error_code_t enumeration. 00117 * @param error_name Name of the error without the ERROR_ prefix 00118 * @param error_code Error code value to be used, must be between 256 and 4096(inclusive). 00119 * 00120 */ 00121 #define MBED_DEFINE_SYSTEM_ERROR( error_name, error_code ) \ 00122 MBED_ERROR_CODE_##error_name = MBED_SYSTEM_ERROR_BASE + error_code, \ 00123 MBED_ERROR_##error_name = MAKE_MBED_ERROR(MBED_ERROR_TYPE_SYSTEM, MBED_MODULE_UNKNOWN, MBED_ERROR_CODE_##error_name) 00124 00125 /** 00126 * Macro for defining a Custom error status. This macro is used to define custom error values in mbed_error_code_t enumeration. 00127 * @param error_name Name of the error without the ERROR_ prefix 00128 * @param error_code Error code value to be used, must be between 4097 and 65535(inclusive). 00129 * 00130 */ 00131 #define MBED_DEFINE_CUSTOM_ERROR( error_name, error_code ) \ 00132 MBED_ERROR_CODE_##error_name = MBED_CUSTOM_ERROR_BASE + error_code, \ 00133 MBED_ERROR_##error_name = MAKE_MBED_ERROR(MBED_ERROR_TYPE_CUSTOM, MBED_MODULE_UNKNOWN, MBED_ERROR_CODE_##error_name) 00134 00135 00136 /** 00137 * Macros for setting a system warning. These macros will log the error, Its a wrapper for calling mbed_warning API. 00138 * There are 2 versions of this macro. MBED_WARNING takes status and message. MBED_WARNING1 takes an additional context specific argument 00139 * @param error_status mbed_error_status_t status to be set(See mbed_error_status_t enum above for available error status values). 00140 * @param error_msg The error message to be printed out to STDIO/Serial. 00141 * @param error_value Value associated with the error status. This would depend on error code/error scenario. 00142 * 00143 * @code 00144 * 00145 * MBED_WARNING( ERROR_INVALID_SIZE, "MyDriver: Invalid size in read" ) 00146 * MBED_WARNING1( ERROR_INVALID_SIZE, "MyDriver: Invalid size in read", size_val ) 00147 * 00148 * @endcode 00149 * @note The macro calls mbed_warning API with filename and line number info without caller explicitly passing them. 00150 * 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. 00151 * 00152 */ 00153 #ifdef NDEBUG 00154 #define MBED_WARNING1( error_status, error_msg, error_value ) mbed_warning( error_status, (const char *)NULL, (uint32_t)error_value, NULL, 0 ) 00155 #define MBED_WARNING( error_status, error_msg ) mbed_warning( error_status, (const char *)NULL, (uint32_t)0, NULL, 0 ) 00156 #else //NDEBUG 00157 #if MBED_CONF_PLATFORM_ERROR_FILENAME_CAPTURE_ENABLED 00158 #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__ ) 00159 #define MBED_WARNING( error_status, error_msg ) mbed_warning( error_status, (const char *)error_msg, (uint32_t)0 , (const char *)MBED_FILENAME, __LINE__ ) 00160 #else //MBED_CONF_PLATFORM_ERROR_FILENAME_CAPTURE_ENABLED 00161 #define MBED_WARNING1( error_status, error_msg, error_value ) mbed_warning( error_status, (const char *)error_msg, (uint32_t)error_value, NULL, 0 ) 00162 #define MBED_WARNING( error_status, error_msg ) mbed_warning( error_status, (const char *)error_msg, (uint32_t)0, NULL, 0 ) 00163 #endif 00164 #endif 00165 00166 /** 00167 * 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. 00168 * There are 2 versions of this macro. MBED_ERROR takes status and message. MBED_ERROR1 takes an additional context specific argument 00169 * @param error_status mbed_error_status_t status to be set(See mbed_error_status_t enum above for available error status values). 00170 * @param error_msg The error message to be printed out to STDIO/Serial. 00171 * @param error_value Value associated with the error status. This would depend on error code/error scenario. Only available with MBED_ERROR1 00172 * @return 0 or MBED_SUCCESS. 00173 * MBED_ERROR_INVALID_ARGUMENT if called with invalid error status/codes 00174 * 00175 * @code 00176 * 00177 * MBED_ERROR( MBED_ERROR_MUTEX_LOCK_FAILED, "MyDriver: Can't lock driver Mutex" ) 00178 * MBED_ERROR1( MBED_ERROR_MUTEX_LOCK_FAILED, "MyDriver: Can't lock driver Mutex", &my_mutex ) 00179 * 00180 * @endcode 00181 * @note The macro calls mbed_error API with filename and line number info without caller explicitly passing them. 00182 * 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. 00183 * 00184 */ 00185 #ifdef NDEBUG 00186 #define MBED_ERROR1( error_status, error_msg, error_value ) mbed_error( error_status, (const char *)NULL, (uint32_t)error_value, NULL, 0 ) 00187 #define MBED_ERROR( error_status, error_msg ) mbed_error( error_status, (const char *)NULL, (uint32_t)0 , NULL, 0 ) 00188 #else //NDEBUG 00189 #if MBED_CONF_PLATFORM_ERROR_FILENAME_CAPTURE_ENABLED 00190 #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__ ) 00191 #define MBED_ERROR( error_status, error_msg ) mbed_error( error_status, (const char *)error_msg, (uint32_t)0 , (const char *)MBED_FILENAME, __LINE__ ) 00192 #else //MBED_CONF_PLATFORM_ERROR_FILENAME_CAPTURE_ENABLED 00193 #define MBED_ERROR1( error_status, error_msg, error_value ) mbed_error( error_status, (const char *)error_msg, (uint32_t)error_value, NULL, 0 ) 00194 #define MBED_ERROR( error_status, error_msg ) mbed_error( error_status, (const char *)error_msg, (uint32_t)0 , NULL, 0 ) 00195 #endif 00196 #endif 00197 00198 //Error Type definition 00199 /** mbed_error_type_t definition 00200 * @note 00201 * This enumeration defines the Error types supported. The value of these enum values will be encoded into mbed_error_status_t TYPE field.\n 00202 * See mbed_error_status_t description for more info.\n 00203 * MBED_ERROR_TYPE_SYSTEM - Used to indicate that the error status is of System defined Error type.\n 00204 * MBED_ERROR_TYPE_CUSTOM - Used to indicate that the error status is of Custom defined Error type.\n 00205 * MBED_ERROR_TYPE_POSIX - Used to indicate that the error status is of Posix error type.\n 00206 * 00207 */ 00208 typedef enum _mbed_error_type_t { 00209 MBED_ERROR_TYPE_SYSTEM = 0, 00210 MBED_ERROR_TYPE_CUSTOM = 1, 00211 //2 is reserved 00212 //Use 3 for POSIX because we are mapping -1 to -255 to POSIX error codes 00213 //and thus we must use 3 to match the type bits in error status representation which are from 0xFFFFFFFF to 0xFFFFFF00 00214 MBED_ERROR_TYPE_POSIX = 3 00215 } mbed_error_type_t; 00216 00217 //Module type/id definitions 00218 /** mbed_module_type_t definition 00219 * @note 00220 * This enumeration defines the module types. The value of these enum values will be encoded into mbed_error_status_t MODULE field.\n\n 00221 * See mbed_error_status_t description for more info.\n 00222 * 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 00223 * Other module values can be used to provide more info on who/where the error originated from.\n\n 00224 * For example, if I2C driver is the component originating the error you can use MBED_MODULE_DRIVER_I2C to provide more info.\n 00225 * Its used in call to MBED_MAKE_ERROR/MBED_MAKE_SYSTEM_ERROR/MBED_MAKE_CUSTOM_ERROR macros.\n 00226 * 00227 * @code 00228 * Example: mbed_error_status_t i2c_driver_error = MBED_MAKE_ERROR( MBED_MODULE_DRIVER_I2C, MBED_ERROR_CONFIG_UNSUPPORTED ); 00229 * @endcode 00230 * 00231 * @note 00232 * \n Below are the module code mappings:\n 00233 \verbatim 00234 MBED_MODULE_APPLICATION 0 Application 00235 MBED_MODULE_PLATFORM 1 Platform 00236 MBED_MODULE_KERNEL 2 RTX Kernel 00237 MBED_MODULE_NETWORK_STACK 3 Network stack 00238 MBED_MODULE_HAL 4 HAL - Hardware Abstraction Layer 00239 MBED_MODULE_MEMORY_SUBSYSTEM 5 Memory Subsystem 00240 MBED_MODULE_FILESYSTEM 6 Filesystem 00241 MBED_MODULE_BLOCK_DEVICE 7 Block device 00242 MBED_MODULE_DRIVER 8 Driver 00243 MBED_MODULE_DRIVER_SERIAL 9 Serial Driver 00244 MBED_MODULE_DRIVER_RTC 10 RTC Driver 00245 MBED_MODULE_DRIVER_I2C 11 I2C Driver 00246 MBED_MODULE_DRIVER_SPI 12 SPI Driver 00247 MBED_MODULE_DRIVER_GPIO 13 GPIO Driver 00248 MBED_MODULE_DRIVER_ANALOG 14 Analog Driver 00249 MBED_MODULE_DRIVER_DIGITAL 15 DigitalIO Driver 00250 MBED_MODULE_DRIVER_CAN 16 CAN Driver 00251 MBED_MODULE_DRIVER_ETHERNET 17 Ethernet Driver 00252 MBED_MODULE_DRIVER_CRC 18 CRC Module 00253 MBED_MODULE_DRIVER_PWM 19 PWM Driver 00254 MBED_MODULE_DRIVER_QSPI 20 QSPI Driver 00255 MBED_MODULE_DRIVER_USB 21 USB Driver 00256 MBED_MODULE_TARGET_SDK 22 SDK 00257 MBED_MODULE_BLE 23 BLE 00258 00259 MBED_MODULE_UNKNOWN 255 Unknown module 00260 \endverbatim 00261 * 00262 */ 00263 typedef enum _mbed_module_type { 00264 MBED_MODULE_APPLICATION = 0, 00265 MBED_MODULE_PLATFORM, 00266 MBED_MODULE_KERNEL, 00267 MBED_MODULE_NETWORK_STACK, 00268 MBED_MODULE_HAL, 00269 MBED_MODULE_MEMORY_SUBSYSTEM, 00270 MBED_MODULE_FILESYSTEM, 00271 MBED_MODULE_BLOCK_DEVICE, 00272 MBED_MODULE_DRIVER, 00273 MBED_MODULE_DRIVER_SERIAL, 00274 MBED_MODULE_DRIVER_RTC, 00275 MBED_MODULE_DRIVER_I2C, 00276 MBED_MODULE_DRIVER_SPI, 00277 MBED_MODULE_DRIVER_GPIO, 00278 MBED_MODULE_DRIVER_ANALOG, 00279 MBED_MODULE_DRIVER_DIGITAL, 00280 MBED_MODULE_DRIVER_CAN, 00281 MBED_MODULE_DRIVER_ETHERNET, 00282 MBED_MODULE_DRIVER_CRC, 00283 MBED_MODULE_DRIVER_PWM, 00284 MBED_MODULE_DRIVER_QSPI, 00285 MBED_MODULE_DRIVER_USB, 00286 MBED_MODULE_TARGET_SDK, 00287 MBED_MODULE_BLE, 00288 /* Add More entities here as required */ 00289 00290 MBED_MODULE_UNKNOWN = 255, 00291 MBED_MODULE_MAX = MBED_MODULE_UNKNOWN 00292 } mbed_module_type_t; 00293 00294 //Use MBED_SUCCESS(=0) or any positive number for successful returns 00295 #define MBED_SUCCESS 0 00296 00297 #define MBED_POSIX_ERROR_BASE 0 00298 #define MBED_SYSTEM_ERROR_BASE 256 00299 #define MBED_CUSTOM_ERROR_BASE 4096 00300 00301 //Error Code definitions 00302 /** mbed_error_code_t definition 00303 * 00304 * mbed_error_code_t enumeration defines the Error codes and Error status values for MBED_MODULE_UNKNOWN.\n 00305 * It defines all of Posix Error Codes/Statuses and Mbed System Error Codes/Statuses.\n\n 00306 * 00307 * @note 00308 * Posix Error codes are defined using the macro MBED_DEFINE_POSIX_ERROR\n 00309 * For example MBED_DEFINE_POSIX_ERROR( EPERM, EPERM ). This effectively defines the following values:\n 00310 * ERROR_CODE_EPERM = EPERM\n 00311 * ERROR_EPERM = -EPERM\n 00312 * 00313 * Posix Error codes are defined using the macro MBED_DEFINE_POSIX_ERROR\n 00314 * For example MBED_DEFINE_POSIX_ERROR( EPERM, EPERM ). This macro defines the following values:\n 00315 * ERROR_CODE_EPERM = MBED_POSIX_ERROR_BASE+EPERM\n 00316 * ERROR_EPERM = -(MBED_POSIX_ERROR_BASE+EPERM)\n 00317 * Its effectively equivalent to:\n 00318 * ERROR_CODE_EPERM = 1\n 00319 * ERROR_EPERM = -1\n 00320 * All Posix error codes currently supported by MbedOS(defined in mbed_retarget.h) are defined using the MBED_DEFINE_POSIX_ERROR macro.\n\n 00321 * Below are the Posic error codes and the description:\n 00322 * \verbatim 00323 EPERM 1 Operation not permitted 00324 ENOENT 2 No such file or directory 00325 ESRCH 3 No such process 00326 EINTR 4 Interrupted system call 00327 EIO 5 I/O error 00328 ENXIO 6 No such device or address 00329 E2BIG 7 Argument list too long 00330 ENOEXEC 8 Exec format error 00331 EBADF 9 Bad file number 00332 ECHILD 10 No child processes 00333 EAGAIN 11 Try again 00334 ENOMEM 12 Out of memory 00335 EACCES 13 Permission denied 00336 EFAULT 14 Bad address 00337 ENOTBLK 15 Block device required 00338 EBUSY 16 Device or resource busy 00339 EEXIST 17 File exists 00340 EXDEV 18 Cross-device link 00341 ENODEV 19 No such device 00342 ENOTDIR 20 Not a directory 00343 EISDIR 21 Is a directory 00344 EINVAL 22 Invalid argument 00345 ENFILE 23 File table overflow 00346 EMFILE 24 Too many open files 00347 ENOTTY 25 Not a typewriter 00348 ETXTBSY 26 Text file busy 00349 EFBIG 27 File too large 00350 ENOSPC 28 No space left on device 00351 ESPIPE 29 Illegal seek 00352 EROFS 30 Read-only file system 00353 EMLINK 31 Too many links 00354 EPIPE 32 Broken pipe 00355 EDOM 33 Math argument out of domain of func 00356 ERANGE 34 Math result not representable 00357 EDEADLK 35 Resource deadlock would occur 00358 ENAMETOOLONG 36 File name too long 00359 ENOLCK 37 No record locks available 00360 ENOSYS 38 Function not implemented 00361 ENOTEMPTY 39 Directory not empty 00362 ELOOP 40 Too many symbolic links encountered 00363 EWOULDBLOCK EAGAIN Operation would block 00364 ENOMSG 42 No message of desired type 00365 EIDRM 43 Identifier removed 00366 ECHRNG 44 Channel number out of range 00367 EL2NSYNC 45 Level 2 not synchronized 00368 EL3HLT 46 Level 3 halted 00369 EL3RST 47 Level 3 reset 00370 ELNRNG 48 Link number out of range 00371 EUNATCH 49 Protocol driver not attached 00372 ENOCSI 50 No CSI structure available 00373 EL2HLT 51 Level 2 halted 00374 EBADE 52 Invalid exchange 00375 EBADR 53 Invalid request descriptor 00376 EXFULL 54 Exchange full 00377 ENOANO 55 No anode 00378 EBADRQC 56 Invalid request code 00379 EBADSLT 57 Invalid slot 00380 EDEADLOCK EDEADLK Resource deadlock would occur 00381 EBFONT 59 Bad font file format 00382 ENOSTR 60 Device not a stream 00383 ENODATA 61 No data available 00384 ETIME 62 Timer expired 00385 ENOSR 63 Out of streams resources 00386 ENONET 64 Machine is not on the network 00387 ENOPKG 65 Package not installed 00388 EREMOTE 66 Object is remote 00389 ENOLINK 67 Link has been severed 00390 EADV 68 Advertise error 00391 ESRMNT 69 Srmount error 00392 ECOMM 70 Communication error on send 00393 EPROTO 71 Protocol error 00394 EMULTIHOP 72 Multihop attempted 00395 EDOTDOT 73 RFS specific error 00396 EBADMSG 74 Not a data message 00397 EOVERFLOW 75 Value too large for defined data type 00398 ENOTUNIQ 76 Name not unique on network 00399 EBADFD 77 File descriptor in bad state 00400 EREMCHG 78 Remote address changed 00401 ELIBACC 79 Can not access a needed shared library 00402 ELIBBAD 80 Accessing a corrupted shared library 00403 ELIBSCN 81 .lib section in a.out corrupted 00404 ELIBMAX 82 Attempting to link in too many shared libraries 00405 ELIBEXEC 83 Cannot exec a shared library directly 00406 EILSEQ 84 Illegal byte sequence 00407 ERESTART 85 Interrupted system call should be restarted 00408 ESTRPIPE 86 Streams pipe error 00409 EUSERS 87 Too many users 00410 ENOTSOCK 88 Socket operation on non-socket 00411 EDESTADDRREQ 89 Destination address required 00412 EMSGSIZE 90 Message too long 00413 EPROTOTYPE 91 Protocol wrong type for socket 00414 ENOPROTOOPT 92 Protocol not available 00415 EPROTONOSUPPORT 93 Protocol not supported 00416 ESOCKTNOSUPPORT 94 Socket type not supported 00417 EOPNOTSUPP 95 Operation not supported on transport endpoint 00418 EPFNOSUPPORT 96 Protocol family not supported 00419 EAFNOSUPPORT 97 Address family not supported by protocol 00420 EADDRINUSE 98 Address already in use 00421 EADDRNOTAVAIL 99 Cannot assign requested address 00422 ENETDOWN 100 Network is down 00423 ENETUNREACH 101 Network is unreachable 00424 ENETRESET 102 Network dropped connection because of reset 00425 ECONNABORTED 103 Software caused connection abort 00426 ECONNRESET 104 Connection reset by peer 00427 ENOBUFS 105 No buffer space available 00428 EISCONN 106 Transport endpoint is already connected 00429 ENOTCONN 107 Transport endpoint is not connected 00430 ESHUTDOWN 108 Cannot send after transport endpoint shutdown 00431 ETOOMANYREFS 109 Too many references: cannot splice 00432 ETIMEDOUT 110 Connection timed out 00433 ECONNREFUSED 111 Connection refused 00434 EHOSTDOWN 112 Host is down 00435 EHOSTUNREACH 113 No route to host 00436 EALREADY 114 Operation already in progress 00437 EINPROGRESS 115 Operation now in progress 00438 ESTALE 116 Stale NFS file handle 00439 EUCLEAN 117 Structure needs cleaning 00440 ENOTNAM 118 Not a XENIX named type file 00441 ENAVAIL 119 No XENIX semaphores available 00442 EISNAM 120 Is a named type file 00443 EREMOTEIO 121 Remote I/O error 00444 EDQUOT 122 Quota exceeded 00445 ENOMEDIUM 123 No medium found 00446 EMEDIUMTYPE 124 Wrong medium type 00447 ECANCELED 125 Operation Canceled 00448 ENOKEY 126 Required key not available 00449 EKEYEXPIRED 127 Key has expired 00450 EKEYREVOKED 128 Key has been revoked 00451 EKEYREJECTED 129 Key was rejected by service 00452 EOWNERDEAD 130 Owner died 00453 ENOTRECOVERABLE 131 State not recoverable 00454 \endverbatim 00455 * 00456 * @note 00457 * MbedOS System Error codes are defined using the macro MBED_DEFINE_SYSTEM_ERROR\n 00458 * For example MBED_DEFINE_SYSTEM_ERROR( INVALID_ARGUMENT ,1 ) macro defines the following values:\n 00459 * ERROR_CODE_INVALID_ARGUMENT = MBED_SYSTEM_ERROR_BASE+1\n 00460 * ERROR_INVALID_ARGUMENT = MAKE_MBED_ERROR(ERROR_TYPE_SYSTEM, MBED_MODULE_UNKNOWN, ERROR_CODE_INVALID_ARGUMENT)\n 00461 * Its effectively equivalent to:\n 00462 * ERROR_CODE_INVALID_ARGUMENT = 1\n 00463 * ERROR_INVALID_ARGUMENT = 0x80FF0001\n (Note that MODULE field is set to MBED_MODULE_UNKNOWN) 00464 * New System Error codes should be defined using MBED_DEFINE_SYSTEM_ERROR macro and must have an unique error code value\n 00465 * passed as the second argument in the MBED_DEFINE_SYSTEM_ERROR macro.\n\n 00466 * Below are the Mbed System error codes and the description: 00467 * \verbatim 00468 UNKNOWN 256 Unknown error 00469 INVALID_ARGUMENT 257 Invalid Argument 00470 INVALID_DATA 258 Invalid data 00471 INVALID_FORMAT 259 Invalid format 00472 INVALID_INDEX 260 Invalid Index 00473 INVALID_SIZE 261 Invalid Size 00474 INVALID_OPERATION 262 Invalid Operation 00475 NOT_FOUND 263 Not Found 00476 ACCESS_DENIED 264 Access Denied 00477 NOT_SUPPORTED 265 Not supported 00478 BUFFER_FULL 266 Buffer Full 00479 MEDIA_FULL 267 Media/Disk Full 00480 ALREADY_IN_USE 268 Already in use 00481 TIMEOUT 269 Timeout error 00482 NOT_READY 270 Not Ready 00483 FAILED_OPERATION 271 Requested Operation failed 00484 OPERATION_PROHIBITED 272 Operation prohibited 00485 OPERATION_ABORTED 273 Operation failed 00486 WRITE_PROTECTED 274 Attempt to write to write-protected resource 00487 NO_RESPONSE 275 No response 00488 SEMAPHORE_LOCK_FAILED 276 Semaphore lock failed 00489 MUTEX_LOCK_FAILED 277 Mutex lock failed 00490 SEMAPHORE_UNLOCK_FAILED 278 Semaphore unlock failed 00491 MUTEX_UNLOCK_FAILED 279 Mutex unlock failed 00492 CRC_ERROR 280 CRC error or mismatch 00493 OPEN_FAILED 281 Open failed 00494 CLOSE_FAILED 282 Close failed 00495 READ_FAILED 283 Read failed 00496 WRITE_FAILED 284 Write failed 00497 INITIALIZATION_FAILED 285 Initialization failed 00498 BOOT_FAILURE 286 Boot failure 00499 OUT_OF_MEMORY 287 Out of memory 00500 OUT_OF_RESOURCES 288 Out of resources 00501 ALLOC_FAILED 289 Alloc failed 00502 FREE_FAILED 290 Free failed 00503 OVERFLOW 291 Overflow error 00504 UNDERFLOW 292 Underflow error 00505 STACK_OVERFLOW 293 Stack overflow error 00506 ISR_QUEUE_OVERFLOW 294 ISR queue overflow 00507 TIMER_QUEUE_OVERFLOW 295 Timer Queue overflow 00508 CLIB_SPACE_UNAVAILABLE 296 Standard library error - Space unavailable 00509 CLIB_EXCEPTION 297 Standard library error - Exception 00510 CLIB_MUTEX_INIT_FAILURE 298 Standard library error - Mutex Init failure 00511 CREATE_FAILED 299 Create failed 00512 DELETE_FAILED 300 Delete failed 00513 THREAD_CREATE_FAILED 301 Thread Create failed 00514 THREAD_DELETE_FAILED 302 Thread Delete failed 00515 PROHIBITED_IN_ISR_CONTEXT 303 Operation Prohibited in ISR context 00516 PINMAP_INVALID 304 Pinmap Invalid 00517 RTOS_EVENT 305 Unknown Rtos Error 00518 RTOS_THREAD_EVENT 306 Rtos Thread Error 00519 RTOS_MUTEX_EVENT 307 Rtos Mutex Error 00520 RTOS_SEMAPHORE_EVENT 308 Rtos Semaphore Error 00521 RTOS_MEMORY_POOL_EVENT 309 Rtos Memory Pool Error 00522 RTOS_TIMER_EVENT 310 Rtos Timer Error 00523 RTOS_EVENT_FLAGS_EVENT 311 Rtos Event flags Error 00524 RTOS_MESSAGE_QUEUE_EVENT 312 Rtos Message queue Error 00525 DEVICE_BUSY 313 Device Busy 00526 CONFIG_UNSUPPORTED 314 Configuration not supported 00527 CONFIG_MISMATCH 315 Configuration mismatch 00528 ALREADY_INITIALIZED 316 Already initialized 00529 HARDFAULT_EXCEPTION 317 HardFault exception 00530 MEMMANAGE_EXCEPTION 318 MemManage exception 00531 BUSFAULT_EXCEPTION 319 BusFault exception 00532 USAGEFAULT_EXCEPTION 320 UsageFault exception 00533 BLE_NO_FRAME_INITIALIZED, 321 BLE No frame initialized 00534 BLE_BACKEND_CREATION_FAILED 322 BLE Backend creation failed 00535 BLE_BACKEND_NOT_INITIALIZED 323 BLE Backend not initialized 00536 \endverbatim 00537 * 00538 * @note 00539 * Custom Error codes can be defined using the macro DEFINE_CUSTOM_ERROR\n 00540 * This is mainly meant to capture non-generic error codes specific to a device. 00541 * For example DEFINE_CUSTOM_ERROR( MY_CUSTOM_ERROR ,1 ) macro defines the following values:\n 00542 * ERROR_CODE_MY_CUSTOM_ERROR = MBED_CUSTOM_ERROR_BASE+1\n 00543 * ERROR_MY_CUSTOM_ERROR = MAKE_MBED_ERROR(ERROR_TYPE_CUSTOM, MBED_MODULE_UNKNOWN, ERROR_CODE_MY_CUSTOM_ERROR)\n 00544 * Its effectively equivalent to:\n 00545 * ERROR_CODE_MY_CUSTOM_ERROR = 4097\n 00546 * ERROR_MY_CUSTOM_ERROR = 0xA0FF1001\n (Note that MODULE field is set to MBED_MODULE_UNKNOWN) \n\n 00547 * 00548 * @note 00549 * **Using error codes:** \n 00550 * Posix error codes may be used in modules/functions currently using Posix error codes and switching them to Mbed-OS error codes 00551 * may cause interoperability issues. For example, some of the filesystem, network stack implementations may need to use 00552 * Posix error codes in order to keep them compatible with other modules interfacing with them, and may continue to use Posix error codes. 00553 * 00554 * In all other cases, like for any native development of Mbed-OS modules Mbed-OS error codes should be used. 00555 * This makes it easy to use Mbed-OS error reporting/logging infrastructure and makes debugging error scenarios 00556 * much more efficient. 00557 * 00558 * @note 00559 * **Searching for error codes in mbed-os source tree:** \n 00560 * 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 00561 * 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 00562 * Use that error name(\b INVALID_FORMAT) to search the source tree for code locations setting that specific error code. \n 00563 * 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. 00564 * See mbed_module_type_t enum above for module mapping. \n 00565 * 00566 * \verbatim 00567 ++ MbedOS Error Info ++ 00568 Error Status: 0x80FF013D Code: 317 Module: 255 00569 Error Message: Fault exception 00570 Location: 0x5CD1 00571 Error Value: 0x4A2A 00572 Current Thread: Id: 0x20001E80 Entry: 0x5EB1 StackSize: 0x1000 StackMem: 0x20000E80 SP: 0x2002FF90 00573 For more info, visit: https://mbed.com/s/error?error=0x80FF013D&mbedos=999999&core=0x410FC241&compile=1&ver=5060528 00574 -- MbedOS Error Info -- 00575 \endverbatim 00576 */ 00577 00578 typedef enum _mbed_error_code { 00579 //Below are POSIX ERROR CODE definitions, which starts at MBED_POSIX_ERROR_BASE(=0) 00580 //POSIX ERROR CODE definitions starts at offset 0(MBED_POSIX_ERROR_BASE) to align them with actual Posix Error Code 00581 //defintions in mbed_retarget.h 00582 // Error Name Error Code 00583 MBED_DEFINE_POSIX_ERROR(EPERM, EPERM), /* 1 Operation not permitted */ 00584 MBED_DEFINE_POSIX_ERROR(ENOENT, ENOENT), /* 2 No such file or directory */ 00585 MBED_DEFINE_POSIX_ERROR(ESRCH, ESRCH), /* 3 No such process */ 00586 MBED_DEFINE_POSIX_ERROR(EINTR, EINTR), /* 4 Interrupted system call */ 00587 MBED_DEFINE_POSIX_ERROR(EIO, EIO), /* 5 I/O error */ 00588 MBED_DEFINE_POSIX_ERROR(ENXIO, ENXIO), /* 6 No such device or address */ 00589 MBED_DEFINE_POSIX_ERROR(E2BIG, E2BIG), /* 7 Argument list too long */ 00590 MBED_DEFINE_POSIX_ERROR(ENOEXEC, ENOEXEC), /* 8 Exec format error */ 00591 MBED_DEFINE_POSIX_ERROR(EBADF, EBADF), /* 9 Bad file number */ 00592 MBED_DEFINE_POSIX_ERROR(ECHILD, ECHILD), /* 10 No child processes */ 00593 MBED_DEFINE_POSIX_ERROR(EAGAIN, EAGAIN), /* 11 Try again */ 00594 MBED_DEFINE_POSIX_ERROR(ENOMEM, ENOMEM), /* 12 Out of memory */ 00595 MBED_DEFINE_POSIX_ERROR(EACCES, EACCES), /* 13 Permission denied */ 00596 MBED_DEFINE_POSIX_ERROR(EFAULT, EFAULT), /* 14 Bad address */ 00597 MBED_DEFINE_POSIX_ERROR(ENOTBLK, ENOTBLK), /* 15 Block device required */ 00598 MBED_DEFINE_POSIX_ERROR(EBUSY, EBUSY), /* 16 Device or resource busy */ 00599 MBED_DEFINE_POSIX_ERROR(EEXIST, EEXIST), /* 17 File exists */ 00600 MBED_DEFINE_POSIX_ERROR(EXDEV, EXDEV), /* 18 Cross-device link */ 00601 MBED_DEFINE_POSIX_ERROR(ENODEV, ENODEV), /* 19 No such device */ 00602 MBED_DEFINE_POSIX_ERROR(ENOTDIR, ENOTDIR), /* 20 Not a directory */ 00603 MBED_DEFINE_POSIX_ERROR(EISDIR, EISDIR), /* 21 Is a directory */ 00604 MBED_DEFINE_POSIX_ERROR(EINVAL, EINVAL), /* 22 Invalid argument */ 00605 MBED_DEFINE_POSIX_ERROR(ENFILE, ENFILE), /* 23 File table overflow */ 00606 MBED_DEFINE_POSIX_ERROR(EMFILE, EMFILE), /* 24 Too many open files */ 00607 MBED_DEFINE_POSIX_ERROR(ENOTTY, ENOTTY), /* 25 Not a typewriter */ 00608 MBED_DEFINE_POSIX_ERROR(ETXTBSY, ETXTBSY), /* 26 Text file busy */ 00609 MBED_DEFINE_POSIX_ERROR(EFBIG, EFBIG), /* 27 File too large */ 00610 MBED_DEFINE_POSIX_ERROR(ENOSPC, ENOSPC), /* 28 No space left on device */ 00611 MBED_DEFINE_POSIX_ERROR(ESPIPE, ESPIPE), /* 29 Illegal seek */ 00612 MBED_DEFINE_POSIX_ERROR(EROFS, EROFS), /* 30 Read-only file system */ 00613 MBED_DEFINE_POSIX_ERROR(EMLINK, EMLINK), /* 31 Too many links */ 00614 MBED_DEFINE_POSIX_ERROR(EPIPE, EPIPE), /* 32 Broken pipe */ 00615 MBED_DEFINE_POSIX_ERROR(EDOM, EDOM), /* 33 Math argument out of domain of func */ 00616 MBED_DEFINE_POSIX_ERROR(ERANGE, ERANGE), /* 34 Math result not representable */ 00617 MBED_DEFINE_POSIX_ERROR(EDEADLK, EDEADLK), /* 35 Resource deadlock would occur */ 00618 MBED_DEFINE_POSIX_ERROR(ENAMETOOLONG, ENAMETOOLONG), /* 36 File name too long */ 00619 MBED_DEFINE_POSIX_ERROR(ENOLCK, ENOLCK), /* 37 No record locks available */ 00620 MBED_DEFINE_POSIX_ERROR(ENOSYS, ENOSYS), /* 38 Function not implemented */ 00621 MBED_DEFINE_POSIX_ERROR(ENOTEMPTY, ENOTEMPTY), /* 39 Directory not empty */ 00622 MBED_DEFINE_POSIX_ERROR(ELOOP, ELOOP), /* 40 Too many symbolic links encountered */ 00623 MBED_DEFINE_POSIX_ERROR(EWOULDBLOCK, EAGAIN), /* EAGAIN Operation would block */ 00624 MBED_DEFINE_POSIX_ERROR(ENOMSG, ENOMSG), /* 42 No message of desired type */ 00625 MBED_DEFINE_POSIX_ERROR(EIDRM, EIDRM), /* 43 Identifier removed */ 00626 MBED_DEFINE_POSIX_ERROR(ECHRNG, ECHRNG), /* 44 Channel number out of range */ 00627 MBED_DEFINE_POSIX_ERROR(EL2NSYNC, EL2NSYNC), /* 45 Level 2 not synchronized */ 00628 MBED_DEFINE_POSIX_ERROR(EL3HLT, EL3HLT), /* 46 Level 3 halted */ 00629 MBED_DEFINE_POSIX_ERROR(EL3RST, EL3RST), /* 47 Level 3 reset */ 00630 MBED_DEFINE_POSIX_ERROR(ELNRNG, ELNRNG), /* 48 Link number out of range */ 00631 MBED_DEFINE_POSIX_ERROR(EUNATCH, EUNATCH), /* 49 Protocol driver not attached */ 00632 MBED_DEFINE_POSIX_ERROR(ENOCSI, ENOCSI), /* 50 No CSI structure available */ 00633 MBED_DEFINE_POSIX_ERROR(EL2HLT, EL2HLT), /* 51 Level 2 halted */ 00634 MBED_DEFINE_POSIX_ERROR(EBADE, EBADE), /* 52 Invalid exchange */ 00635 MBED_DEFINE_POSIX_ERROR(EBADR, EBADR), /* 53 Invalid request descriptor */ 00636 MBED_DEFINE_POSIX_ERROR(EXFULL, EXFULL), /* 54 Exchange full */ 00637 MBED_DEFINE_POSIX_ERROR(ENOANO, ENOANO), /* 55 No anode */ 00638 MBED_DEFINE_POSIX_ERROR(EBADRQC, EBADRQC), /* 56 Invalid request code */ 00639 MBED_DEFINE_POSIX_ERROR(EBADSLT, EBADSLT), /* 57 Invalid slot */ 00640 MBED_DEFINE_POSIX_ERROR(EDEADLOCK, EDEADLK), /* EDEADLK Resource deadlock would occur */ 00641 MBED_DEFINE_POSIX_ERROR(EBFONT, EBFONT), /* 59 Bad font file format */ 00642 MBED_DEFINE_POSIX_ERROR(ENOSTR, ENOSTR), /* 60 Device not a stream */ 00643 MBED_DEFINE_POSIX_ERROR(ENODATA, ENODATA), /* 61 No data available */ 00644 MBED_DEFINE_POSIX_ERROR(ETIME, ETIME), /* 62 Timer expired */ 00645 MBED_DEFINE_POSIX_ERROR(ENOSR, ENOSR), /* 63 Out of streams resources */ 00646 MBED_DEFINE_POSIX_ERROR(ENONET, ENONET), /* 64 Machine is not on the network */ 00647 MBED_DEFINE_POSIX_ERROR(ENOPKG, ENOPKG), /* 65 Package not installed */ 00648 MBED_DEFINE_POSIX_ERROR(EREMOTE, EREMOTE), /* 66 Object is remote */ 00649 MBED_DEFINE_POSIX_ERROR(ENOLINK, ENOLINK), /* 67 Link has been severed */ 00650 MBED_DEFINE_POSIX_ERROR(EADV, EADV), /* 68 Advertise error */ 00651 MBED_DEFINE_POSIX_ERROR(ESRMNT, ESRMNT), /* 69 Srmount error */ 00652 MBED_DEFINE_POSIX_ERROR(ECOMM, ECOMM), /* 70 Communication error on send */ 00653 MBED_DEFINE_POSIX_ERROR(EPROTO, EPROTO), /* 71 Protocol error */ 00654 MBED_DEFINE_POSIX_ERROR(EMULTIHOP, EMULTIHOP), /* 72 Multihop attempted */ 00655 MBED_DEFINE_POSIX_ERROR(EDOTDOT, EDOTDOT), /* 73 RFS specific error */ 00656 MBED_DEFINE_POSIX_ERROR(EBADMSG, EBADMSG), /* 74 Not a data message */ 00657 MBED_DEFINE_POSIX_ERROR(EOVERFLOW, EOVERFLOW), /* 75 Value too large for defined data type */ 00658 MBED_DEFINE_POSIX_ERROR(ENOTUNIQ, ENOTUNIQ), /* 76 Name not unique on network */ 00659 MBED_DEFINE_POSIX_ERROR(EBADFD, EBADFD), /* 77 File descriptor in bad state */ 00660 MBED_DEFINE_POSIX_ERROR(EREMCHG, EREMCHG), /* 78 Remote address changed */ 00661 MBED_DEFINE_POSIX_ERROR(ELIBACC, ELIBACC), /* 79 Can not access a needed shared library */ 00662 MBED_DEFINE_POSIX_ERROR(ELIBBAD, ELIBBAD), /* 80 Accessing a corrupted shared library */ 00663 MBED_DEFINE_POSIX_ERROR(ELIBSCN, ELIBSCN), /* 81 .lib section in a.out corrupted */ 00664 MBED_DEFINE_POSIX_ERROR(ELIBMAX, ELIBMAX), /* 82 Attempting to link in too many shared libraries */ 00665 MBED_DEFINE_POSIX_ERROR(ELIBEXEC, ELIBEXEC), /* 83 Cannot exec a shared library directly */ 00666 MBED_DEFINE_POSIX_ERROR(EILSEQ, EILSEQ), /* 84 Illegal byte sequence */ 00667 MBED_DEFINE_POSIX_ERROR(ERESTART, ERESTART), /* 85 Interrupted system call should be restarted */ 00668 MBED_DEFINE_POSIX_ERROR(ESTRPIPE, ESTRPIPE), /* 86 Streams pipe error */ 00669 MBED_DEFINE_POSIX_ERROR(EUSERS, EUSERS), /* 87 Too many users */ 00670 MBED_DEFINE_POSIX_ERROR(ENOTSOCK, ENOTSOCK), /* 88 Socket operation on non-socket */ 00671 MBED_DEFINE_POSIX_ERROR(EDESTADDRREQ, EDESTADDRREQ), /* 89 Destination address required */ 00672 MBED_DEFINE_POSIX_ERROR(EMSGSIZE, EMSGSIZE), /* 90 Message too long */ 00673 MBED_DEFINE_POSIX_ERROR(EPROTOTYPE, EPROTOTYPE), /* 91 Protocol wrong type for socket */ 00674 MBED_DEFINE_POSIX_ERROR(ENOPROTOOPT, ENOPROTOOPT), /* 92 Protocol not available */ 00675 MBED_DEFINE_POSIX_ERROR(EPROTONOSUPPORT, EPROTONOSUPPORT), /* 93 Protocol not supported */ 00676 MBED_DEFINE_POSIX_ERROR(ESOCKTNOSUPPORT, ESOCKTNOSUPPORT), /* 94 Socket type not supported */ 00677 MBED_DEFINE_POSIX_ERROR(EOPNOTSUPP, EOPNOTSUPP), /* 95 Operation not supported on transport endpoint */ 00678 MBED_DEFINE_POSIX_ERROR(EPFNOSUPPORT, EPFNOSUPPORT), /* 96 Protocol family not supported */ 00679 MBED_DEFINE_POSIX_ERROR(EAFNOSUPPORT, EAFNOSUPPORT), /* 97 Address family not supported by protocol */ 00680 MBED_DEFINE_POSIX_ERROR(EADDRINUSE, EADDRINUSE), /* 98 Address already in use */ 00681 MBED_DEFINE_POSIX_ERROR(EADDRNOTAVAIL, EADDRNOTAVAIL), /* 99 Cannot assign requested address */ 00682 MBED_DEFINE_POSIX_ERROR(ENETDOWN, ENETDOWN), /* 100 Network is down */ 00683 MBED_DEFINE_POSIX_ERROR(ENETUNREACH, ENETUNREACH), /* 101 Network is unreachable */ 00684 MBED_DEFINE_POSIX_ERROR(ENETRESET, ENETRESET), /* 102 Network dropped connection because of reset */ 00685 MBED_DEFINE_POSIX_ERROR(ECONNABORTED, ECONNABORTED), /* 103 Software caused connection abort */ 00686 MBED_DEFINE_POSIX_ERROR(ECONNRESET, ECONNRESET), /* 104 Connection reset by peer */ 00687 MBED_DEFINE_POSIX_ERROR(ENOBUFS, ENOBUFS), /* 105 No buffer space available */ 00688 MBED_DEFINE_POSIX_ERROR(EISCONN, EISCONN), /* 106 Transport endpoint is already connected */ 00689 MBED_DEFINE_POSIX_ERROR(ENOTCONN, ENOTCONN), /* 107 Transport endpoint is not connected */ 00690 MBED_DEFINE_POSIX_ERROR(ESHUTDOWN, ESHUTDOWN), /* 108 Cannot send after transport endpoint shutdown */ 00691 MBED_DEFINE_POSIX_ERROR(ETOOMANYREFS, ETOOMANYREFS), /* 109 Too many references: cannot splice */ 00692 MBED_DEFINE_POSIX_ERROR(ETIMEDOUT, ETIMEDOUT), /* 110 Connection timed out */ 00693 MBED_DEFINE_POSIX_ERROR(ECONNREFUSED, ECONNREFUSED), /* 111 Connection refused */ 00694 MBED_DEFINE_POSIX_ERROR(EHOSTDOWN, EHOSTDOWN), /* 112 Host is down */ 00695 MBED_DEFINE_POSIX_ERROR(EHOSTUNREACH, EHOSTUNREACH), /* 113 No route to host */ 00696 MBED_DEFINE_POSIX_ERROR(EALREADY, EALREADY), /* 114 Operation already in progress */ 00697 MBED_DEFINE_POSIX_ERROR(EINPROGRESS, EINPROGRESS), /* 115 Operation now in progress */ 00698 MBED_DEFINE_POSIX_ERROR(ESTALE, ESTALE), /* 116 Stale NFS file handle */ 00699 MBED_DEFINE_POSIX_ERROR(EUCLEAN, EUCLEAN), /* 117 Structure needs cleaning */ 00700 MBED_DEFINE_POSIX_ERROR(ENOTNAM, ENOTNAM), /* 118 Not a XENIX named type file */ 00701 MBED_DEFINE_POSIX_ERROR(ENAVAIL, ENAVAIL), /* 119 No XENIX semaphores available */ 00702 MBED_DEFINE_POSIX_ERROR(EISNAM, EISNAM), /* 120 Is a named type file */ 00703 MBED_DEFINE_POSIX_ERROR(EREMOTEIO, EREMOTEIO), /* 121 Remote I/O error */ 00704 MBED_DEFINE_POSIX_ERROR(EDQUOT, EDQUOT), /* 122 Quota exceeded */ 00705 MBED_DEFINE_POSIX_ERROR(ENOMEDIUM, ENOMEDIUM), /* 123 No medium found */ 00706 MBED_DEFINE_POSIX_ERROR(EMEDIUMTYPE, EMEDIUMTYPE), /* 124 Wrong medium type */ 00707 MBED_DEFINE_POSIX_ERROR(ECANCELED, ECANCELED), /* 125 Operation Canceled */ 00708 MBED_DEFINE_POSIX_ERROR(ENOKEY, ENOKEY), /* 126 Required key not available */ 00709 MBED_DEFINE_POSIX_ERROR(EKEYEXPIRED, EKEYEXPIRED), /* 127 Key has expired */ 00710 MBED_DEFINE_POSIX_ERROR(EKEYREVOKED, EKEYREVOKED), /* 128 Key has been revoked */ 00711 MBED_DEFINE_POSIX_ERROR(EKEYREJECTED, EKEYREJECTED), /* 129 Key was rejected by service */ 00712 MBED_DEFINE_POSIX_ERROR(EOWNERDEAD, EOWNERDEAD), /* 130 Owner died */ 00713 MBED_DEFINE_POSIX_ERROR(ENOTRECOVERABLE, ENOTRECOVERABLE), /* 131 State not recoverable */ 00714 00715 //Below are MBED SYSTEM ERROR CODE definitions 00716 //MBED SYSTEM ERROR CODE definitions starts at offset MBED_SYSTEM_ERROR_BASE, see above. 00717 // Error Name Error Offset Error Code 00718 MBED_DEFINE_SYSTEM_ERROR(UNKNOWN, 0), /* 256 Unknown error */ 00719 MBED_DEFINE_SYSTEM_ERROR(INVALID_ARGUMENT, 1), /* 257 Invalid Argument */ 00720 MBED_DEFINE_SYSTEM_ERROR(INVALID_DATA_DETECTED, 2), /* 258 Invalid data detected */ 00721 MBED_DEFINE_SYSTEM_ERROR(INVALID_FORMAT, 3), /* 259 Invalid format */ 00722 MBED_DEFINE_SYSTEM_ERROR(INVALID_INDEX, 4), /* 260 Invalid Index */ 00723 MBED_DEFINE_SYSTEM_ERROR(INVALID_SIZE, 5), /* 261 Invalid Size */ 00724 MBED_DEFINE_SYSTEM_ERROR(INVALID_OPERATION, 6), /* 262 Invalid Operation */ 00725 MBED_DEFINE_SYSTEM_ERROR(ITEM_NOT_FOUND, 7), /* 263 Item Not Found */ 00726 MBED_DEFINE_SYSTEM_ERROR(ACCESS_DENIED, 8), /* 264 Access Denied */ 00727 MBED_DEFINE_SYSTEM_ERROR(UNSUPPORTED, 9), /* 265 Unsupported */ 00728 MBED_DEFINE_SYSTEM_ERROR(BUFFER_FULL, 10), /* 266 Buffer Full */ 00729 MBED_DEFINE_SYSTEM_ERROR(MEDIA_FULL, 11), /* 267 Media/Disk Full */ 00730 MBED_DEFINE_SYSTEM_ERROR(ALREADY_IN_USE, 12), /* 268 Already in use */ 00731 MBED_DEFINE_SYSTEM_ERROR(TIME_OUT, 13), /* 269 Timeout error */ 00732 MBED_DEFINE_SYSTEM_ERROR(NOT_READY, 14), /* 270 Not Ready */ 00733 MBED_DEFINE_SYSTEM_ERROR(FAILED_OPERATION, 15), /* 271 Requested Operation failed */ 00734 MBED_DEFINE_SYSTEM_ERROR(OPERATION_PROHIBITED, 16), /* 272 Operation prohibited */ 00735 MBED_DEFINE_SYSTEM_ERROR(OPERATION_ABORTED, 17), /* 273 Operation failed */ 00736 MBED_DEFINE_SYSTEM_ERROR(WRITE_PROTECTED, 18), /* 274 Attempt to write to write-protected resource */ 00737 MBED_DEFINE_SYSTEM_ERROR(NO_RESPONSE, 19), /* 275 No response */ 00738 MBED_DEFINE_SYSTEM_ERROR(SEMAPHORE_LOCK_FAILED, 20), /* 276 Semaphore lock failed */ 00739 MBED_DEFINE_SYSTEM_ERROR(MUTEX_LOCK_FAILED, 21), /* 277 Mutex lock failed */ 00740 MBED_DEFINE_SYSTEM_ERROR(SEMAPHORE_UNLOCK_FAILED, 22), /* 278 Semaphore unlock failed */ 00741 MBED_DEFINE_SYSTEM_ERROR(MUTEX_UNLOCK_FAILED, 23), /* 279 Mutex unlock failed */ 00742 MBED_DEFINE_SYSTEM_ERROR(CRC_ERROR, 24), /* 280 CRC error or mismatch */ 00743 MBED_DEFINE_SYSTEM_ERROR(OPEN_FAILED, 25), /* 281 Open failed */ 00744 MBED_DEFINE_SYSTEM_ERROR(CLOSE_FAILED, 26), /* 282 Close failed */ 00745 MBED_DEFINE_SYSTEM_ERROR(READ_FAILED, 27), /* 283 Read failed */ 00746 MBED_DEFINE_SYSTEM_ERROR(WRITE_FAILED, 28), /* 284 Write failed */ 00747 MBED_DEFINE_SYSTEM_ERROR(INITIALIZATION_FAILED, 29), /* 285 Initialization failed */ 00748 MBED_DEFINE_SYSTEM_ERROR(BOOT_FAILURE, 30), /* 286 Boot failure */ 00749 MBED_DEFINE_SYSTEM_ERROR(OUT_OF_MEMORY, 31), /* 287 Out of memory */ 00750 MBED_DEFINE_SYSTEM_ERROR(OUT_OF_RESOURCES, 32), /* 288 Out of resources */ 00751 MBED_DEFINE_SYSTEM_ERROR(ALLOC_FAILED, 33), /* 289 Alloc failed */ 00752 MBED_DEFINE_SYSTEM_ERROR(FREE_FAILED, 34), /* 290 Free failed */ 00753 MBED_DEFINE_SYSTEM_ERROR(OVERFLOW, 35), /* 291 Overflow error */ 00754 MBED_DEFINE_SYSTEM_ERROR(UNDERFLOW, 36), /* 292 Underflow error */ 00755 MBED_DEFINE_SYSTEM_ERROR(STACK_OVERFLOW, 37), /* 293 Stack overflow error */ 00756 MBED_DEFINE_SYSTEM_ERROR(ISR_QUEUE_OVERFLOW, 38), /* 294 ISR queue overflow */ 00757 MBED_DEFINE_SYSTEM_ERROR(TIMER_QUEUE_OVERFLOW, 39), /* 295 Timer Queue overflow */ 00758 MBED_DEFINE_SYSTEM_ERROR(CLIB_SPACE_UNAVAILABLE, 40), /* 296 Standard library error - Space unavailable */ 00759 MBED_DEFINE_SYSTEM_ERROR(CLIB_EXCEPTION, 41), /* 297 Standard library error - Exception */ 00760 MBED_DEFINE_SYSTEM_ERROR(CLIB_MUTEX_INIT_FAILURE, 42), /* 298 Standard library error - Mutex Init failure */ 00761 MBED_DEFINE_SYSTEM_ERROR(CREATE_FAILED, 43), /* 299 Create failed */ 00762 MBED_DEFINE_SYSTEM_ERROR(DELETE_FAILED, 44), /* 300 Delete failed */ 00763 MBED_DEFINE_SYSTEM_ERROR(THREAD_CREATE_FAILED, 45), /* 301 Thread Create failed */ 00764 MBED_DEFINE_SYSTEM_ERROR(THREAD_DELETE_FAILED, 46), /* 302 Thread Delete failed */ 00765 MBED_DEFINE_SYSTEM_ERROR(PROHIBITED_IN_ISR_CONTEXT, 47), /* 303 Operation Prohibited in ISR context */ 00766 MBED_DEFINE_SYSTEM_ERROR(PINMAP_INVALID, 48), /* 304 Pinmap Invalid */ 00767 MBED_DEFINE_SYSTEM_ERROR(RTOS_EVENT, 49), /* 305 Unknown Rtos Error */ 00768 MBED_DEFINE_SYSTEM_ERROR(RTOS_THREAD_EVENT, 50), /* 306 Rtos Thread Error */ 00769 MBED_DEFINE_SYSTEM_ERROR(RTOS_MUTEX_EVENT, 51), /* 307 Rtos Mutex Error */ 00770 MBED_DEFINE_SYSTEM_ERROR(RTOS_SEMAPHORE_EVENT, 52), /* 308 Rtos Semaphore Error */ 00771 MBED_DEFINE_SYSTEM_ERROR(RTOS_MEMORY_POOL_EVENT, 53), /* 309 Rtos Memory Pool Error */ 00772 MBED_DEFINE_SYSTEM_ERROR(RTOS_TIMER_EVENT, 54), /* 310 Rtos Timer Error */ 00773 MBED_DEFINE_SYSTEM_ERROR(RTOS_EVENT_FLAGS_EVENT, 55), /* 311 Rtos Event flags Error */ 00774 MBED_DEFINE_SYSTEM_ERROR(RTOS_MESSAGE_QUEUE_EVENT, 56), /* 312 Rtos Message queue Error */ 00775 MBED_DEFINE_SYSTEM_ERROR(DEVICE_BUSY, 57), /* 313 Device Busy */ 00776 MBED_DEFINE_SYSTEM_ERROR(CONFIG_UNSUPPORTED, 58), /* 314 Configuration not supported */ 00777 MBED_DEFINE_SYSTEM_ERROR(CONFIG_MISMATCH, 59), /* 315 Configuration mismatch */ 00778 MBED_DEFINE_SYSTEM_ERROR(ALREADY_INITIALIZED, 60), /* 316 Already initialized */ 00779 MBED_DEFINE_SYSTEM_ERROR(HARDFAULT_EXCEPTION, 61), /* 317 HardFault exception */ 00780 MBED_DEFINE_SYSTEM_ERROR(MEMMANAGE_EXCEPTION, 62), /* 318 MemManage exception */ 00781 MBED_DEFINE_SYSTEM_ERROR(BUSFAULT_EXCEPTION, 63), /* 319 BusFault exception */ 00782 MBED_DEFINE_SYSTEM_ERROR(USAGEFAULT_EXCEPTION, 64), /* 320 UsageFault exception*/ 00783 MBED_DEFINE_SYSTEM_ERROR(BLE_NO_FRAME_INITIALIZED, 65), /* 321 BLE No frame initialized */ 00784 MBED_DEFINE_SYSTEM_ERROR(BLE_BACKEND_CREATION_FAILED, 66), /* 322 BLE Backend creation failed */ 00785 MBED_DEFINE_SYSTEM_ERROR(BLE_BACKEND_NOT_INITIALIZED, 67), /* 323 BLE Backend not initialized */ 00786 00787 //Everytime you add a new system error code, you must update 00788 //Error documentation under Handbook to capture the info on 00789 //the new error status/codes 00790 00791 //MBED CUSTOM ERROR CODE definitions starts at offset MBED_CUSTOM_ERROR_BASE, see above. 00792 /* Add More/Custom Error Codes here, See example below */ 00793 //DEFINE_CUSTOM_ERROR( MY_CUSTOM_ERROR , 1 ), 00794 00795 } mbed_error_code_t; 00796 00797 /** mbed_error_ctx struct 00798 * 00799 * This struct captures the context information at the time of error.\n 00800 * It primarily contains information about the thread where the error originated,\n 00801 * filename/line number of the source file where the error occurred, a context specific error value(error_value)\n 00802 * and the address where the error originated.\n 00803 * 00804 * @note 00805 * Below are the members of mbed_error_ctx struct\n 00806 * error_status mbed_error_status_t value for this error\n 00807 * error_function_address Address where the error occurred\n 00808 * thread_id ID of the thread which generated the error\n 00809 * thread_entry_address Entry function of the thread which generated the error\n 00810 * thread_stack_size Stack Size of the thread which generated the error\n 00811 * thread_stack_mem Stack Top of the thread which generated the error\n 00812 * thread_current_sp Current Stack Pointer of the thread which generated the error\n 00813 * error_value A context/error specific value associated with this error\n 00814 * error_filename Filename where the error originated\n 00815 * error_line_number Line number in error_filename where the error originated\n 00816 */ 00817 typedef struct _mbed_error_ctx { 00818 mbed_error_status_t error_status; 00819 uint32_t error_address; 00820 uint32_t error_value; 00821 uint32_t thread_id; 00822 uint32_t thread_entry_address; 00823 uint32_t thread_stack_size; 00824 uint32_t thread_stack_mem; 00825 uint32_t thread_current_sp; 00826 #ifdef MBED_CONF_PLATFORM_MAX_ERROR_FILENAME_LEN 00827 char error_filename[MBED_CONF_PLATFORM_MAX_ERROR_FILENAME_LEN]; 00828 uint32_t error_line_number; 00829 #endif 00830 } mbed_error_ctx; 00831 00832 /** To generate a fatal compile-time error, you can use the pre-processor #error directive. 00833 * 00834 * @param format C string that contains data stream to be printed. 00835 * Code snippets below show valid format. 00836 * 00837 * @code 00838 * #error "That shouldn't have happened!" 00839 * @endcode 00840 * 00841 * If the compiler evaluates this line, it will report the error and stop the compile. 00842 * 00843 * For example, you could use this to check some user-defined compile-time variables: 00844 * 00845 * @code 00846 * #define NUM_PORTS 7 00847 * #if (NUM_PORTS > 4) 00848 * #error "NUM_PORTS must be less than 4" 00849 * #endif 00850 * @endcode 00851 * 00852 * Reporting Run-Time Errors: 00853 * To generate a fatal run-time error, you can use the mbed error() function. 00854 * 00855 * @code 00856 * error("That shouldn't have happened!"); 00857 * @endcode 00858 * 00859 * If the mbed running the program executes this function, it will print the 00860 * message via the USB serial port, and then die with the blue lights of death! 00861 * 00862 * The message can use printf-style formatting, so you can report variables in the 00863 * message too. For example, you could use this to check a run-time condition: 00864 * 00865 * @code 00866 * if(x >= 5) { 00867 * error("expected x to be less than 5, but got %d", x); 00868 * } 00869 * @endcode 00870 * 00871 * 00872 */ 00873 00874 void error(const char *format, ...); 00875 00876 /** 00877 * Call this Macro to generate a mbed_error_status_t value for a System error 00878 * @param module Module generating the error code. If its unknown, pass MBED_MODULE_UNKNOWN. See mbed_module_type_t for module types. 00879 * @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. 00880 * 00881 * @code 00882 * 00883 * mbed_error_status_t driver_error = MBED_MAKE_SYSTEM_ERROR( MODULE_DRIVER_USB, MBED_ERROR_CODE_INITIALIZATION_FAILED ) 00884 * 00885 * @endcode 00886 * @note This macro generate mbed_error_status_t-es with error type set to MBED_ERROR_TYPE_SYSTEM 00887 * 00888 */ 00889 #define MBED_MAKE_SYSTEM_ERROR(module, error_code) MAKE_MBED_ERROR(MBED_ERROR_TYPE_SYSTEM, module, error_code) 00890 00891 /** 00892 * Call this Macro to generate a mbed_error_status_t value for a Custom error 00893 * @param module Module generating the error code. If its unknown, pass MBED_MODULE_UNKNOWN. See mbed_module_type_t for module types. 00894 * @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. 00895 * 00896 * @code 00897 * 00898 * mbed_error_status_t custom_error = MBED_MAKE_CUSTOM_ERROR( MBED_MODULE_APPLICATION, 0xDEAD//16-bit custom error code ) 00899 * 00900 * @endcode 00901 * @note This macro generate mbed_error_status_t-es with error type set to MBED_ERROR_TYPE_CUSTOM 00902 * 00903 */ 00904 #define MBED_MAKE_CUSTOM_ERROR(module, error_code) MAKE_MBED_ERROR(MBED_ERROR_TYPE_CUSTOM, module, error_code) 00905 00906 /** 00907 * Call this Macro to generate a mbed_error_status_t value for a System error 00908 * @param module Module generating the error code. If its unknown, pass MBED_MODULE_UNKNOWN. See mbed_module_type_t for module types. 00909 * @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. 00910 * 00911 * @code 00912 * 00913 * mbed_error_status_t new_error = MBED_MAKE_ERROR( MODULE_DRIVER_USB, MBED_ERROR_INITIALIZATION_FAILED ) 00914 * 00915 * @endcode 00916 * @note This macro generate mbed_error_status_t-es with error type set to MBED_ERROR_TYPE_SYSTEM 00917 * 00918 */ 00919 #define MBED_MAKE_ERROR(module, error_code) MBED_MAKE_SYSTEM_ERROR(module, error_code) 00920 00921 /** 00922 * Callback/Error hook function prototype. Applications needing a callback when an error is reported can use mbed_set_error_hook function 00923 * to register a callback/error hook function using the following prototype. When an error happens in the system error handling 00924 * implementation will invoke this callback with the mbed_error_status_t reported and the error context at the time of error. 00925 * @param error_ctx Error context structure associated with this error. 00926 * @return void 00927 * 00928 */ 00929 typedef void (*mbed_error_hook_t)(const mbed_error_ctx *error_ctx); 00930 00931 /** 00932 * Call this function to set a system error/warning. This function will log the error status with the context info and return to caller. 00933 * 00934 * @param error_status mbed_error_status_t status to be set(See mbed_error_status_t enum above for available error status values). 00935 * @param error_msg The error message to be printed out to STDIO/Serial. 00936 * @param error_value Value associated with the error status. This would depend on error code/error scenario. 00937 * @param filename Name of the source file originating the error( Most callers can pass __FILE__ here ). 00938 * @param line_number The line number of the source file originating the error( Most callers can pass __LINE__ here ) . 00939 * @return 0 or MBED_SUCCESS. 00940 * MBED_ERROR_INVALID_ARGUMENT if called with invalid error status/codes 00941 * 00942 * @code 00943 * 00944 * mbed_error( ERROR_OUT_OF_MEMORY, "Out of memory error", 0, __FILE__, __LINE__ ) 00945 * 00946 * @endcode 00947 * 00948 * @note See MBED_WARNING/MBED_ERROR macros which provides a wrapper on this API 00949 */ 00950 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); 00951 00952 /** 00953 * Returns the first system error reported. 00954 * @return mbed_error_status_t code logged for the first error or MBED_SUCCESS if no errors are logged. 00955 * 00956 */ 00957 mbed_error_status_t mbed_get_first_error(void); 00958 00959 /** 00960 * Returns the most recent system error reported. 00961 * @return mbed_error_status_t code logged for the last error or MBED_SUCCESS if no errors are logged. 00962 * 00963 */ 00964 mbed_error_status_t mbed_get_last_error(void); 00965 00966 /** 00967 * Returns the number of system errors reported after boot. 00968 * @return int Number of errors reported. 00969 * 00970 */ 00971 int mbed_get_error_count(void); 00972 00973 /** 00974 * 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. 00975 * 00976 * @param error_status mbed_error_status_t status to be set(See mbed_error_status_t enum above for available error status values). 00977 * @param error_msg The error message to be printed out to STDIO/Serial. 00978 * @param error_value Value associated with the error status. This would depend on error code/error scenario. 00979 * @param filename Name of the source file originating the error( Most callers can pass __FILE__ here ). 00980 * @param line_number The line number of the source file originating the error( Most callers can pass __LINE__ here ) . 00981 * @return 0 or MBED_SUCCESS. 00982 * MBED_ERROR_INVALID_ARGUMENT if called with invalid error status/codes 00983 * 00984 * @code 00985 * 00986 * mbed_error( MBED_ERROR_PROHIBITED_OPERATION, "Prohibited operation tried", 0, __FILE__, __LINE__ ) 00987 * 00988 * @endcode 00989 * 00990 * @note See MBED_WARNING/MBED_ERROR macros which provides a wrapper on this API 00991 */ 00992 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); 00993 00994 /** 00995 * Registers an application defined error callback with the error handling system. 00996 * This function will be called with error context info whenever system handles a mbed_error/mbed_warning call 00997 * NOTE: This function should be implemented for re-entrancy as multiple threads may invoke mbed_error which may cause error hook to be called. 00998 * @param custom_error_hook mbed_error_status_t status to be set(See mbed_error_status_t enum above for available error status values). 00999 * @return 0 or MBED_SUCCESS on success. 01000 * MBED_ERROR_INVALID_ARGUMENT in case of NULL for custom_error_hook 01001 * 01002 * @code 01003 * 01004 * mbed_error_status_t my_custom_error_hook(mbed_error_status_t error_status, const mbed_error_ctx *error_ctx) { 01005 * //Do something with the error_status or error_ctx 01006 * } 01007 * 01008 * mbed_set_error_hook( my_custom_error_hook ) 01009 * 01010 * @endcode 01011 * @note The erro hook function implementation should be re-entrant. 01012 * 01013 */ 01014 mbed_error_status_t mbed_set_error_hook(mbed_error_hook_t custom_error_hook); 01015 01016 /** 01017 * Reads the first error context information captured. 01018 * @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. 01019 * @return 0 or MBED_SUCCESS on success. 01020 * MBED_ERROR_INVALID_ARGUMENT in case of invalid index 01021 * 01022 */ 01023 mbed_error_status_t mbed_get_first_error_info(mbed_error_ctx *error_info); 01024 01025 /** 01026 * Reads the last error context information captured. 01027 * @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. 01028 * @return 0 or MBED_ERROR_SUCCESS on success. 01029 * MBED_ERROR_INVALID_ARGUMENT in case of invalid index 01030 * 01031 */ 01032 mbed_error_status_t mbed_get_last_error_info(mbed_error_ctx *error_info); 01033 01034 /** 01035 * Clears the last error, first error, error count and all entries in the error history. 01036 * @return 0 or MBED_SUCCESS on success. 01037 * 01038 */ 01039 mbed_error_status_t mbed_clear_all_errors(void); 01040 01041 /** 01042 * Generates a mbed_error_status_t value based on passed in values for type, module and error code. 01043 * @param error_type Error type based on mbed_error_type_t enum. 01044 * @param module Module type based on mbed_module_type_t enum. 01045 * @param error_code Error codes defined by mbed_error_code_t enum 01046 * @return 0 or MBED_ERROR_SUCCESS on success. 01047 * 01048 */ 01049 mbed_error_status_t mbed_make_error(mbed_error_type_t error_type, mbed_module_type_t module, mbed_error_code_t error_code); 01050 01051 /** 01052 * 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. 01053 * @return Current number of entries in the error history. 01054 * 01055 */ 01056 int mbed_get_error_hist_count(void); 01057 01058 /** 01059 * Reads the error context information for a specific error from error history, specified by the index. 01060 * 01061 * @param index index of the error context entry in the history to be retrieved.\n 01062 * The number of entries in the error history is configured during build and the max index depends on max depth of error history.\n 01063 * 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 01064 * @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. 01065 * @return 0 or MBED_SUCCESS on success. 01066 * MBED_ERROR_INVALID_ARGUMENT in case of invalid index 01067 * 01068 */ 01069 mbed_error_status_t mbed_get_error_hist_info(int index, mbed_error_ctx *error_info); 01070 01071 /** 01072 * Saves the error history information to a file 01073 * 01074 * @param path path to the file in the filesystem 01075 * @return 0 or MBED_ERROR_SUCCESS on success. 01076 * MBED_ERROR_WRITE_FAILED if writing to file failed 01077 * MBED_ERROR_INVALID_ARGUMENT if path is not valid 01078 * 01079 * @note Filesystem support is required in order for this function to work. 01080 * 01081 */ 01082 mbed_error_status_t mbed_save_error_hist(const char *path); 01083 01084 #ifdef __cplusplus 01085 } 01086 #endif 01087 01088 #endif 01089 01090 /** @}*/ 01091 /** @}*/ 01092 01093
Generated on Tue Jul 12 2022 13:34:15 by
1.7.2