XCORE SDK
XCORE Software Development Kit
sl_status.h
1 /**************************************************************************/
17 #ifndef SL_STATUS_H
18 #define SL_STATUS_H
19 
20 #include <stdint.h>
21 
22 /*******************************************************************************
23  *************************** SPACE DEFINES *********************************
24  ******************************************************************************/
25 
26 #define SL_STATUS_SPACE_MASK ((sl_status_t)0xFF00)
27 
28 #define SL_STATUS_GENERIC_SPACE ((sl_status_t)0x0000)
29 #define SL_STATUS_WIFI_SPACE ((sl_status_t)0x0B00)
30 
31 /*******************************************************************************
32  *************************** STATUS DEFINES ********************************
33  ******************************************************************************/
34 
35 /*******************************************************************************
36  *************************** GENERIC ERRORS ********************************
37  ******************************************************************************/
38 
39 #define SL_STATUS_OK ((sl_status_t)0x0000)
40 #define SL_STATUS_FAIL ((sl_status_t)0x0001)
41 
42 // State Errors
43 #define SL_STATUS_INVALID_STATE ((sl_status_t)0x0002)
44 #define SL_STATUS_NOT_READY ((sl_status_t)0x0003)
45 #define SL_STATUS_BUSY ((sl_status_t)0x0004)
46 #define SL_STATUS_IN_PROGRESS ((sl_status_t)0x0005)
47 #define SL_STATUS_ABORT ((sl_status_t)0x0006)
48 #define SL_STATUS_TIMEOUT ((sl_status_t)0x0007)
49 #define SL_STATUS_PERMISSION ((sl_status_t)0x0008)
50 #define SL_STATUS_WOULD_BLOCK ((sl_status_t)0x0009)
51 #define SL_STATUS_IDLE ((sl_status_t)0x000A)
52 #define SL_STATUS_IS_WAITING ((sl_status_t)0x000B)
53 #define SL_STATUS_NONE_WAITING ((sl_status_t)0x000C)
54 #define SL_STATUS_SUSPENDED ((sl_status_t)0x000D)
55 #define SL_STATUS_NOT_AVAILABLE ((sl_status_t)0x000E)
56 #define SL_STATUS_NOT_SUPPORTED ((sl_status_t)0x000F)
57 #define SL_STATUS_INITIALIZATION ((sl_status_t)0x0010)
58 #define SL_STATUS_NOT_INITIALIZED ((sl_status_t)0x0011)
59 #define SL_STATUS_ALREADY_INITIALIZED ((sl_status_t)0x0012)
60 #define SL_STATUS_DELETED ((sl_status_t)0x0013)
61 #define SL_STATUS_ISR ((sl_status_t)0x0014)
62 #define SL_STATUS_NETWORK_UP ((sl_status_t)0x0015)
63 #define SL_STATUS_NETWORK_DOWN ((sl_status_t)0x0016)
64 #define SL_STATUS_NOT_JOINED ((sl_status_t)0x0017)
65 #define SL_STATUS_NO_BEACONS ((sl_status_t)0x0018)
66 
67 // Allocation/ownership Errors
68 #define SL_STATUS_ALLOCATION_FAILED ((sl_status_t)0x0019)
69 #define SL_STATUS_NO_MORE_RESOURCE ((sl_status_t)0x001A)
70 #define SL_STATUS_EMPTY ((sl_status_t)0x001B)
71 #define SL_STATUS_FULL ((sl_status_t)0x001C)
72 #define SL_STATUS_WOULD_OVERFLOW ((sl_status_t)0x001D)
73 #define SL_STATUS_HAS_OVERFLOWED ((sl_status_t)0x001E)
74 #define SL_STATUS_OWNERSHIP ((sl_status_t)0x001F)
75 #define SL_STATUS_IS_OWNER ((sl_status_t)0x0020)
76 
77 // Invalid Parameters Errors
78 #define SL_STATUS_INVALID_PARAMETER ((sl_status_t)0x0021)
79 #define SL_STATUS_NULL_POINTER ((sl_status_t)0x0022)
80 #define SL_STATUS_INVALID_CONFIGURATION ((sl_status_t)0x0023)
81 #define SL_STATUS_INVALID_MODE ((sl_status_t)0x0024)
82 #define SL_STATUS_INVALID_HANDLE ((sl_status_t)0x0025)
83 #define SL_STATUS_INVALID_TYPE ((sl_status_t)0x0026)
84 #define SL_STATUS_INVALID_INDEX ((sl_status_t)0x0027)
85 #define SL_STATUS_INVALID_RANGE ((sl_status_t)0x0028)
86 #define SL_STATUS_INVALID_KEY ((sl_status_t)0x0029)
87 #define SL_STATUS_INVALID_CREDENTIALS ((sl_status_t)0x002A)
88 #define SL_STATUS_INVALID_COUNT ((sl_status_t)0x002B)
89 #define SL_STATUS_NOT_FOUND ((sl_status_t)0x002C)
90 #define SL_STATUS_ALREADY_EXISTS ((sl_status_t)0x002D)
91 
92 // IO/Communication Errors
93 #define SL_STATUS_IO ((sl_status_t)0x002E)
94 #define SL_STATUS_IO_TIMEOUT ((sl_status_t)0x002F)
95 #define SL_STATUS_TRANSMIT ((sl_status_t)0x0030)
96 #define SL_STATUS_TRANSMIT_UNDERFLOW ((sl_status_t)0x0031)
97 #define SL_STATUS_TRANSMIT_INCOMPLETE ((sl_status_t)0x0032)
98 #define SL_STATUS_TRANSMIT_BUSY ((sl_status_t)0x0033)
99 #define SL_STATUS_RECEIVE ((sl_status_t)0x0034)
100 #define SL_STATUS_OBJECT_READ ((sl_status_t)0x0035)
101 #define SL_STATUS_OBJECT_WRITE ((sl_status_t)0x0036)
102 #define SL_STATUS_MESSAGE_TOO_LONG ((sl_status_t)0x0037)
103 
104 // EEPROM/Flash Errors
105 #define SL_STATUS_EEPROM_MFG_VERSION_MISMATCH ((sl_status_t)0x0038)
106 #define SL_STATUS_EEPROM_STACK_VERSION_MISMATCH ((sl_status_t)0x0039)
107 #define SL_STATUS_FLASH_WRITE_INHIBITED ((sl_status_t)0x003A)
108 #define SL_STATUS_FLASH_VERIFY_FAILED ((sl_status_t)0x003B)
109 #define SL_STATUS_FLASH_PROGRAM_FAILED ((sl_status_t)0x003C)
110 #define SL_STATUS_FLASH_ERASE_FAILED ((sl_status_t)0x003D)
111 
112 // MAC Errors
113 #define SL_STATUS_MAC_NO_DATA ((sl_status_t)0x003E)
114 #define SL_STATUS_MAC_NO_ACK_RECEIVED ((sl_status_t)0x003F)
115 #define SL_STATUS_MAC_INDIRECT_TIMEOUT ((sl_status_t)0x0040)
116 #define SL_STATUS_MAC_UNKNOWN_HEADER_TYPE ((sl_status_t)0x0041)
117 #define SL_STATUS_MAC_ACK_HEADER_TYPE ((sl_status_t)0x0042)
118 #define SL_STATUS_MAC_COMMAND_TRANSMIT_FAILURE ((sl_status_t)0x0043)
119 
120 // CLI_STORAGE Errors
121 #define SL_STATUS_CLI_STORAGE_NVM_OPEN_ERROR ((sl_status_t)0x0044)
122 
123 // Security status codes
124 #define SL_STATUS_SECURITY_IMAGE_CHECKSUM_ERROR ((sl_status_t)0x0045)
125 #define SL_STATUS_SECURITY_DECRYPT_ERROR ((sl_status_t)0x0046)
126 
127 // Command status codes
128 #define SL_STATUS_COMMAND_IS_INVALID ((sl_status_t)0x0047)
129 #define SL_STATUS_COMMAND_TOO_LONG ((sl_status_t)0x0048)
130 #define SL_STATUS_COMMAND_INCOMPLETE ((sl_status_t)0x0049)
131 
132 /*******************************************************************************
133  ******************************** WIFI ERRORS ******************************
134  ******************************************************************************/
135 
136 #define SL_STATUS_WIFI_INVALID_KEY ((sl_status_t)0x0B01)
137 #define SL_STATUS_WIFI_FIRMWARE_DOWNLOAD_TIMEOUT ((sl_status_t)0x0B02)
138 #define SL_STATUS_WIFI_UNSUPPORTED_MESSAGE_ID ((sl_status_t)0x0B03)
139 #define SL_STATUS_WIFI_WARNING ((sl_status_t)0x0B04)
140 #define SL_STATUS_WIFI_NO_PACKET_TO_RECEIVE ((sl_status_t)0x0B05)
141 #define SL_STATUS_WIFI_SLEEP_GRANTED ((sl_status_t)0x0B08)
142 #define SL_STATUS_WIFI_SLEEP_NOT_GRANTED ((sl_status_t)0x0B09)
143 #define SL_STATUS_WIFI_SECURE_LINK_MAC_KEY_ERROR ((sl_status_t)0x0B10)
144 #define SL_STATUS_WIFI_SECURE_LINK_MAC_KEY_ALREADY_BURNED ((sl_status_t)0x0B11)
145 #define SL_STATUS_WIFI_SECURE_LINK_RAM_MODE_NOT_ALLOWED ((sl_status_t)0x0B12)
146 #define SL_STATUS_WIFI_SECURE_LINK_FAILED_UNKNOWN_MODE ((sl_status_t)0x0B13)
147 #define SL_STATUS_WIFI_SECURE_LINK_EXCHANGE_FAILED ((sl_status_t)0x0B14)
148 #define SL_STATUS_WIFI_WRONG_STATE ((sl_status_t)0x0B18)
149 #define SL_STATUS_WIFI_CHANNEL_NOT_ALLOWED ((sl_status_t)0x0B19)
150 #define SL_STATUS_WIFI_NO_MATCHING_AP ((sl_status_t)0x0B1A)
151 #define SL_STATUS_WIFI_CONNECTION_ABORTED ((sl_status_t)0x0B1B)
152 #define SL_STATUS_WIFI_CONNECTION_TIMEOUT ((sl_status_t)0x0B1C)
153 #define SL_STATUS_WIFI_CONNECTION_REJECTED_BY_AP ((sl_status_t)0x0B1D)
154 #define SL_STATUS_WIFI_CONNECTION_AUTH_FAILURE ((sl_status_t)0x0B1E)
155 #define SL_STATUS_WIFI_RETRY_EXCEEDED ((sl_status_t)0x0B1F)
156 #define SL_STATUS_WIFI_TX_LIFETIME_EXCEEDED ((sl_status_t)0x0B20)
157 
158 /*******************************************************************************
159  ******************************** DATA TYPES *******************************
160  ******************************************************************************/
161 
162 typedef uint32_t sl_status_t;
163 
164 /*******************************************************************************
165  ******************************** FUNCTIONS ********************************
166  ******************************************************************************/
167 
168 #ifdef __cplusplus
169 extern "C" {
170 #endif
171 
172 // Placeholder for future string functions.
173 
174 #ifdef __cplusplus
175 }
176 #endif
177 
178 #endif /* SL_STATUS_H */