Skip to content

Commit 940c685

Browse files
Cruz Monrreal IICruz Monrreal II
Cruz Monrreal II
authored and
Cruz Monrreal II
committed
Merge branch 'SenRamakri-sen_ErrorDoxyUpdate' into rollup-aus_writathon
2 parents e9edbf4 + 8bb21af commit 940c685

File tree

1 file changed

+45
-43
lines changed

1 file changed

+45
-43
lines changed

‎platform/mbed_error.h

Lines changed: 45 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ extern "C" {
9090
* 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
9191
* 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
9292
*
93-
* The ERROR CODE(values encoded into ERROR CODE bit-field in mbed_error_status_t) value range for each error type is also seperated as below:\n
93+
* 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
9494
* Posix Error Codes - 1 to 255.\n
9595
* System Error Codes - 256 to 4095.\n
9696
* Custom Error Codes - 4096 to 65535.\n
@@ -231,31 +231,32 @@ typedef enum _mbed_error_type_t {
231231
* @note
232232
* \n Below are the module code mappings:\n
233233
\verbatim
234-
MBED_MODULE_APPLICATION 0 Application
235-
MBED_MODULE_PLATFORM 1 Platform
236-
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_NETWORK_STACKMODULE_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-
MODULE_DRIVER_SPI 12 SPI Driver
247-
MODULE_DRIVER_GPIO 13 GPIO Driver
248-
MODULE_DRIVER_ANALOG 14 Analog Driver
249-
MODULE_DRIVER_DIGITAL 15 DigitalIO Driver
250-
MODULE_DRIVER_CAN 16 CAN Driver
251-
MODULE_DRIVER_ETHERNET 17 Ethernet Driver
252-
MODULE_DRIVER_CRC 18 CRC Module
253-
MODULE_DRIVER_PWM 19 PWM Driver
254-
MODULE_DRIVER_QSPI 20 QSPI Driver
255-
MODULE_DRIVER_USB 21 USB Driver
256-
MODULE_TARGET_SDK 22 SDK
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
257258
258-
MBED_MODULE_UNKNOWN 255 Unknown module
259+
MBED_MODULE_UNKNOWN 255 Unknown module
259260
\endverbatim
260261
*
261262
*/
@@ -265,7 +266,7 @@ typedef enum _mbed_module_type {
265266
MBED_MODULE_KERNEL,
266267
MBED_MODULE_NETWORK_STACK,
267268
MBED_MODULE_HAL,
268-
MBED_MODULE_NETWORK_STACKMODULE_MEMORY_SUBSYSTEM,
269+
MBED_MODULE_MEMORY_SUBSYSTEM,
269270
MBED_MODULE_FILESYSTEM,
270271
MBED_MODULE_BLOCK_DEVICE,
271272
MBED_MODULE_DRIVER,
@@ -290,7 +291,7 @@ typedef enum _mbed_module_type {
290291
MBED_MODULE_MAX = MBED_MODULE_UNKNOWN
291292
} mbed_module_type_t;
292293

293-
//Use MBED_SUCCESS(=0) or any postive number for successful returns
294+
//Use MBED_SUCCESS(=0) or any positive number for successful returns
294295
#define MBED_SUCCESS 0
295296

296297
#define MBED_POSIX_ERROR_BASE 0
@@ -469,7 +470,7 @@ typedef enum _mbed_module_type {
469470
INVALID_DATA 258 Invalid data
470471
INVALID_FORMAT 259 Invalid format
471472
INVALID_INDEX 260 Invalid Index
472-
INVALID_SIZE 261 Inavlid Size
473+
INVALID_SIZE 261 Invalid Size
473474
INVALID_OPERATION 262 Invalid Operation
474475
NOT_FOUND 263 Not Found
475476
ACCESS_DENIED 264 Access Denied
@@ -484,9 +485,9 @@ typedef enum _mbed_module_type {
484485
OPERATION_ABORTED 273 Operation failed
485486
WRITE_PROTECTED 274 Attempt to write to write-protected resource
486487
NO_RESPONSE 275 No response
487-
SEMAPHORE_LOCK_FAILED 276 Sempahore lock failed
488+
SEMAPHORE_LOCK_FAILED 276 Semaphore lock failed
488489
MUTEX_LOCK_FAILED 277 Mutex lock failed
489-
SEMAPHORE_UNLOCK_FAILED 278 Sempahore unlock failed
490+
SEMAPHORE_UNLOCK_FAILED 278 Semaphore unlock failed
490491
MUTEX_UNLOCK_FAILED 279 Mutex unlock failed
491492
CRC_ERROR 280 CRC error or mismatch
492493
OPEN_FAILED 281 Open failed
@@ -524,11 +525,14 @@ typedef enum _mbed_module_type {
524525
DEVICE_BUSY 313 Device Busy
525526
CONFIG_UNSUPPORTED 314 Configuration not supported
526527
CONFIG_MISMATCH 315 Configuration mismatch
527-
ALREADY_INITIALIZED 316 Already initialzied
528+
ALREADY_INITIALIZED 316 Already initialized
528529
HARDFAULT_EXCEPTION 317 HardFault exception
529530
MEMMANAGE_EXCEPTION 318 MemManage exception
530531
BUSFAULT_EXCEPTION 319 BusFault exception
531532
USAGEFAULT_EXCEPTION 320 UsageFault exception
533+
BLE_NO_FRAME_INITIALIZED, 321 BLE No frame initialized
534+
BLE_BACKEND_CREATION_FAILED 322 BLE Backend creation failed
535+
BLE_BACKEND_NOT_INITIALIZED 323 BLE Backend not initialized
532536
\endverbatim
533537
*
534538
* @note
@@ -561,13 +565,12 @@ typedef enum _mbed_module_type {
561565
*
562566
* \verbatim
563567
++ MbedOS Error Info ++
564-
Error Status: 0x80040103
565-
Error Code: 259
566-
Error Module: 04
567-
Error Message: HAL Module error
568-
Error Location: 0x000067C7
569-
Error Value: 0x00005566
570-
Current Thread: Id: 0x200024A8 EntryFn: 0x0000FB0D StackSize: 0x00001000 StackMem: 0x200014A8 SP: 0x2002FFD8
568+
Error Status: 0x80FF013D Code: 317 Module: 255
569+
Error Message: Fault exception
570+
Location: 0x5CD1
571+
Error Value: 0x4A2A
572+
Current Thread: Id: 0x20001E80 Entry: 0x5EB1 StackSize: 0x1000 StackMem: 0x20000E80 SP: 0x2002FF90
573+
For more info, visit: https://mbed.com/s/error?error=0x80FF013D&mbedos=999999&core=0x410FC241&compile=1&ver=5060528
571574
-- MbedOS Error Info --
572575
\endverbatim
573576
*/
@@ -717,7 +720,7 @@ typedef enum _mbed_error_code {
717720
MBED_DEFINE_SYSTEM_ERROR(INVALID_DATA_DETECTED, 2), /* 258 Invalid data detected */
718721
MBED_DEFINE_SYSTEM_ERROR(INVALID_FORMAT, 3), /* 259 Invalid format */
719722
MBED_DEFINE_SYSTEM_ERROR(INVALID_INDEX, 4), /* 260 Invalid Index */
720-
MBED_DEFINE_SYSTEM_ERROR(INVALID_SIZE, 5), /* 261 Inavlid Size */
723+
MBED_DEFINE_SYSTEM_ERROR(INVALID_SIZE, 5), /* 261 Invalid Size */
721724
MBED_DEFINE_SYSTEM_ERROR(INVALID_OPERATION, 6), /* 262 Invalid Operation */
722725
MBED_DEFINE_SYSTEM_ERROR(ITEM_NOT_FOUND, 7), /* 263 Item Not Found */
723726
MBED_DEFINE_SYSTEM_ERROR(ACCESS_DENIED, 8), /* 264 Access Denied */
@@ -732,9 +735,9 @@ typedef enum _mbed_error_code {
732735
MBED_DEFINE_SYSTEM_ERROR(OPERATION_ABORTED, 17), /* 273 Operation failed */
733736
MBED_DEFINE_SYSTEM_ERROR(WRITE_PROTECTED, 18), /* 274 Attempt to write to write-protected resource */
734737
MBED_DEFINE_SYSTEM_ERROR(NO_RESPONSE, 19), /* 275 No response */
735-
MBED_DEFINE_SYSTEM_ERROR(SEMAPHORE_LOCK_FAILED, 20), /* 276 Sempahore lock failed */
738+
MBED_DEFINE_SYSTEM_ERROR(SEMAPHORE_LOCK_FAILED, 20), /* 276 Semaphore lock failed */
736739
MBED_DEFINE_SYSTEM_ERROR(MUTEX_LOCK_FAILED, 21), /* 277 Mutex lock failed */
737-
MBED_DEFINE_SYSTEM_ERROR(SEMAPHORE_UNLOCK_FAILED, 22), /* 278 Sempahore unlock failed */
740+
MBED_DEFINE_SYSTEM_ERROR(SEMAPHORE_UNLOCK_FAILED, 22), /* 278 Semaphore unlock failed */
738741
MBED_DEFINE_SYSTEM_ERROR(MUTEX_UNLOCK_FAILED, 23), /* 279 Mutex unlock failed */
739742
MBED_DEFINE_SYSTEM_ERROR(CRC_ERROR, 24), /* 280 CRC error or mismatch */
740743
MBED_DEFINE_SYSTEM_ERROR(OPEN_FAILED, 25), /* 281 Open failed */
@@ -772,7 +775,7 @@ typedef enum _mbed_error_code {
772775
MBED_DEFINE_SYSTEM_ERROR(DEVICE_BUSY, 57), /* 313 Device Busy */
773776
MBED_DEFINE_SYSTEM_ERROR(CONFIG_UNSUPPORTED, 58), /* 314 Configuration not supported */
774777
MBED_DEFINE_SYSTEM_ERROR(CONFIG_MISMATCH, 59), /* 315 Configuration mismatch */
775-
MBED_DEFINE_SYSTEM_ERROR(ALREADY_INITIALIZED, 60), /* 316 Already initialzied */
778+
MBED_DEFINE_SYSTEM_ERROR(ALREADY_INITIALIZED, 60), /* 316 Already initialized */
776779
MBED_DEFINE_SYSTEM_ERROR(HARDFAULT_EXCEPTION, 61), /* 317 HardFault exception */
777780
MBED_DEFINE_SYSTEM_ERROR(MEMMANAGE_EXCEPTION, 62), /* 318 MemManage exception */
778781
MBED_DEFINE_SYSTEM_ERROR(BUSFAULT_EXCEPTION, 63), /* 319 BusFault exception */
@@ -919,7 +922,6 @@ void error(const char *format, ...);
919922
* Callback/Error hook function prototype. Applications needing a callback when an error is reported can use mbed_set_error_hook function
920923
* to register a callback/error hook function using the following prototype. When an error happens in the system error handling
921924
* implementation will invoke this callback with the mbed_error_status_t reported and the error context at the time of error.
922-
* @param error_status mbed_error_status_t status being reported.
923925
* @param error_ctx Error context structure associated with this error.
924926
* @return void
925927
*

0 commit comments

Comments
 (0)