NetBurner 3.0
nbWicedConstants.h
Go to the documentation of this file.
1 /*NB_REVISION*/
2 
3 /*NB_COPYRIGHT*/
4 
9 #ifndef __NBWICEDCONSTANTS_H
10 #define __NBWICEDCONSTANTS_H
11 
12 #define SSID_MAX_LEN 32 // Set by the IEEE 802.11 PHY specifications
13 #define PASS_MAX_LEN 64 // Try to avoid running out of memory on small devices...
14 #define SEC_HUMAN_MAX_LEN 32 // max length for security option string, human readable
15 #define CIPHER_HUMAN_MAX_LEN 32 // max length for cipher option string, human readable
16 
17 
18 #define LIST_TABLE_NUM (0x00)
19 #define SEC_TABLE_NUM (0x01)
20 #define CIPH_TABLE_NUM (0x02)
21 #define BAND_TABLE_NUM (0x03)
22 #define CHANNEL_TABLE_NUM (0x04)
23 #define BSSTYPE_TABLE_NUM (0x05)
24 #define BSSID_TABLE_NUM (0x06)
25 #define SCAN_TABLE_NUM (0x07)
26 #define CONNMODE_TABLE_NUM (0x08)
27 #define DEFAULT_TABLE_TABLE_NUM (0xFF)
28 
29 
30 #define LIST_TABLE_SIZE (10)
31 
32 #define LIST_LABEL_MASTER "Master Table"
33 #define LIST_LABEL_SEC "Security"
34 #define LIST_LABEL_CIPH "Cipher"
35 #define LIST_LABEL_BAND "Band"
36 #define LIST_LABEL_CHANNEL "Channel"
37 #define LIST_LABEL_BSSTYPE "BssType"
38 #define LIST_LABEL_BSSID "BSSID"
39 #define LIST_LABEL_SCAN "Scan Method"
40 #define LIST_LABEL_CONNMODE "Connection Mode"
41 #define LIST_LABEL_DEFAULT "Default Values"
42 
43 #define LIST_VALUE_MASTER LIST_TABLE_NUM
44 #define LIST_VALUE_SEC SEC_TABLE_NUM
45 #define LIST_VALUE_CIPH CIPH_TABLE_NUM
46 #define LIST_VALUE_BAND BAND_TABLE_NUM
47 #define LIST_VALUE_CHANNEL CHANNEL_TABLE_NUM
48 #define LIST_VALUE_BSSTYPE BSSTYPE_TABLE_NUM
49 #define LIST_VALUE_BSSID BSSID_TABLE_NUM
50 #define LIST_VALUE_SCAN SCAN_TABLE_NUM
51 #define LIST_VALUE_CONNMODE CONNMODE_TABLE_NUM
52 #define LIST_VALUE_DEFAULT DEFAULT_TABLE_TABLE_NUM
53 
54 
55 #define SEC_TABLE_SIZE (6)
56 
57 #define SEC_LABEL_OPEN "Open"
58 #define SEC_LABEL_WEP "WEP"
59 #define SEC_LABEL_WPA "WPA"
60 #define SEC_LABEL_WPA2 "WPA2"
61 #define SEC_LABEL_WPS "WPS"
62 #define SEC_LABEL_UNKNOWN "Unknown"
63 
64 #define SEC_VALUE_OPEN (0x00)
65 #define SEC_VALUE_WEP (0x01)
66 #define SEC_VALUE_WPA (0x02)
67 #define SEC_VALUE_WPA2 (0x03)
68 #define SEC_VALUE_WPS (0x04)
69 #define SEC_VALUE_UNKNOWN (0xFF)
70 
71 
72 #define CIPH_TABLE_SIZE (5)
73 
74 #define CIPH_LABEL_NONE "None"
75 #define CIPH_LABEL_TKIP "TKIP"
76 #define CIPH_LABEL_AES "AES"
77 #define CIPH_LABEL_MIXED "Mixed"
78 #define CIPH_LABEL_UNKNOWN "Unknown"
79 
80 #define CIPH_VALUE_NONE (0x00)
81 #define CIPH_VALUE_TKIP (0x01)
82 #define CIPH_VALUE_AES (0x02)
83 #define CIPH_VALUE_MIXED (0x03)
84 #define CIPH_VALUE_UNKNOWN (0xFF)
85 
86 
87 #define BAND_TABLE_SIZE (2)
88 
89 #define BAND_LABEL_5_GHZ "5 GHz"
90 #define BAND_LABEL_2_4_GHZ "2.4 GHz"
91 
92 #define BAND_VALUE_5_GHZ (0x00)
93 #define BAND_VALUE_2_4_GHZ (0x01)
94 
95 
96 #define BSSTYPE_TABLE_SIZE (4)
97 
98 #define BSSTYPE_LABEL_INFR "Infrastructure"
99 #define BSSTYPE_LABEL_ADHOC "AdHoc"
100 #define BSSTYPE_LABEL_ANY "Any"
101 #define BSSTYPE_LABEL_UNKNOWN "Unknown"
102 
103 #define BSSTYPE_VALUE_INFR (0x00)
104 #define BSSTYPE_VALUE_ADHOC (0x01)
105 #define BSSTYPE_VALUE_ANY (0x02)
106 #define BSSTYPE_VALUE_UNKNOWN (0xFF)
107 
108 
109 #define SCAN_TABLE_SIZE (2)
110 
111 #define SCAN_LABEL_ACTIVE "Active"
112 #define SCAN_LABEL_PASSIVE "Passive"
113 
114 #define SCAN_VALUE_ACTIVE (0x00)
115 #define SCAN_VALUE_PASSIVE (0x01)
116 
117 
118 #define CONNMODE_TABLE_SIZE (2)
119 
120 #define CONNMODE_LABEL_CLIENT "Client"
121 #define CONNMODE_LABEL_AP "Access Point"
122 
123 #define CONNMODE_VALUE_CLIENT (0x00)
124 #define CONNMODE_VALUE_AP (0x01)
125 
126 
127 #define DEFAULT_TABLE_TABLE_SIZE (LIST_TABLE_SIZE - 2)
128 
129 #define DEFAULT_TABLE_LABEL_SEC SEC_VALUE_WPA2
130 #define DEFAULT_TABLE_LABEL_CIPH CIPH_VALUE_AES
131 #define DEFAULT_TABLE_LABEL_BAND BAND_VALUE_2_4_GHZ
132 #define DEFAULT_TABLE_LABEL_CHANNEL (0x06)
133 #define DEFAULT_TABLE_LABEL_BSSTYPE BSSTYPE_VALUE_ANY
134 #define DEFAULT_TABLE_LABEL_BSSID (0x00)
135 #define DEFAULT_TABLE_LABEL_SCAN SCAN_VALUE_PASSIVE
136 #define DEFAULT_TABLE_LABEL_CONNMODE CONNMODE_VALUE_CLIENT
137 
138 #define DEFAULT_TABLE_VALUE_SEC LIST_VALUE_SEC
139 #define DEFAULT_TABLE_VALUE_CIPH LIST_VALUE_CIPH
140 #define DEFAULT_TABLE_VALUE_BAND LIST_VALUE_BAND
141 #define DEFAULT_TABLE_VALUE_CHANNEL LIST_VALUE_CHANNEL
142 #define DEFAULT_TABLE_VALUE_BSSTYPE LIST_VALUE_BSSTYPE
143 #define DEFAULT_TABLE_VALUE_BSSID LIST_VALUE_BSSID
144 #define DEFAULT_TABLE_VALUE_SCAN LIST_VALUE_SCAN
145 #define DEFAULT_TABLE_VALUE_CONNMODE LIST_VALUE_CONNMODE
146 
147 
148 #define CONFIG_ERR_SUCCESS 0
149 #define CONFIG_ERR_MSG_LENGTH -1
150 #define CONFIG_ERR_SSID_LEN_SHORT -2
151 #define CONFIG_ERR_SSID_LEN_LONG -3
152 #define CONFIG_ERR_PASSWD_LEN_LONG -4
153 #define CONFIG_ERR_INVALID_TABLE -5
154 #define CONFIG_ERR_INVALID_OPTION -6
155 #define CONFIG_ERR_BSSID_OVERRUN -7
156 #define CONFIG_ERR_BSSID_UNDERRUN -8
157 #define CONFIG_ERR_MULTI_CHANNEL -9
158 #define CONFIG_ERR_CONNECTED -10
159 #define CONFIG_ERR_UNKNOWN 0xFF
160 
161 #define CONNECT_ERR_SUCCESS 0
162 #define CONNECT_ERR_NOT_CONFIG -1
163 #define CONNECT_ERR_INVALID_CONFIG_NUM -2
164 #define CONNECT_ERR_CONNECTED -3
165 #define CONNECT_ERR_SSID_NOT_FOUND -4
166 #define CONNECT_ERR_BSSID_NOT_FOUND -5
167 #define CONNECT_ERR_SEC_MISMATCH -6
168 #define CONNECT_ERR_CIPH_MISMATCH -7
169 #define CONNECT_ERR_INVALID_KEY -8
170 #define CONNECT_ERR_UNKNOWN 0xFF
171 
172 #define SCAN_ERR_SUCCESS 0
173 #define SCAN_ERR_MSG_LENGTH -1
174 #define SCAN_ERR_IN_PROGRESS -2
175 #define SCAN_ERR_SSID_LEN_LONG -3
176 #define SCAN_ERR_INVALID_TABLE -4
177 #define SCAN_ERR_INVALID_OPTION -5
178 #define SCAN_ERR_TOO_MANY_CHANNELS -6
179 #define SCAN_ERR_UNKNOWN 0xFF
180 
181 #define SAVE_CONF_ERR_SUCCESS 0
182 #define SAVE_CONF_ERR_INVALID_CONFIG_NUM -1
183 #define SAVE_CONF_ERR_NOT_CONFIGURED -2
184 #define SAVE_CONF_ERR_UNKNOWN 0xFF
185 
186 #define DRIVER_ERR_SUCCESS 0
187 #define DRIVER_ERR_UNKNOWN 0xFF
188 
189 #define GETOPT_ERR_SUCCESS 0
190 #define GETOPT_ERR_INVALID_TABLE -1
191 #define GETOPT_ERR_UNKNOWN 0xFF
192 
193 #define CONN_STATE_SCAN_FOR_CONN -1
194 #define CONN_STATE_NOT_CONNECTED 0
195 #define CONN_STATE_CONNECTED 1
196 
197 #define MIN_FW_MAJOR_VER 0x00
198 #define MIN_FW_MINOR_VER 0x00
199 #define MAX_FW_MAJOR_VER 0xFF
200 #define MAX_FW_MINOR_VER 0xFF
201 
203 namespace NBWifi
204 {
205  namespace Constants {
206  typedef enum {
207  TaskStart_Err_NoError = 0,
208  TaskStart_Err_Running = -1, // task is already running
209  TaskStart_Err_NotRegistered = -2, // Driver is not registered
210  } TaskStartError;
211 
212  typedef enum {
213  TaskKill_Err_NoError = 0,
214  TaskKill_Err_NotRunning = -1, // task is already running
215  } TaskKillError;
216 
217  typedef enum {
218  Connect_Success = 0,
219  Connect_BadPass = -1,
220  Connect_NoAPFound = -2,
221  Connect_BSSID_NotFound = -3,
222  Connect_TimedOut = -4,
223  } ConnectResult;
224 
225  typedef enum {
226  Band_All = 0,
227  Band_2_4GHz = 1,
228  Band_5GHz = 2,
229  } RadioBand;
230 
231  typedef enum {
232  BssType_Infrastructure = 0,
233  BssType_AdHoc = 1,
234  BssType_Any = 63, // arbitrary, but chosen based as max n-bit number (in this case 6)
235  BssType_Unknown = 255,
236  } BssType;
237 
238  typedef enum {
239  Scan_Passive = 0,
240  Scan_Active = 1,
241  } ScanMethods;
242  } /* ----- end of namespace Constants ----- */
243 
250  namespace Error {
251 
258  typedef enum {
259  NoError = 0,
260  Timeout = -256,
261  BusTimeout = -257,
262  InvalidArgument = -258,
263  TooManyPendingCommands = -259,
264  InvalidRequest = -512,
265  } GeneralErrors;
266 
271  namespace Init {
272 
277  typedef enum {
278  Success = 0,
279  AlreadyInit = -1,
280  NoDevice = -2,
281  InvalidInfo = -3,
282  DevFirmVer = -4,
283  DevHwVer = -5,
284  OptionTables = -6,
286  }
287 
292  namespace Scan {
293 
298  typedef enum {
299  Success = 0,
300  NotInitialized = -1,
301  InProgress = -2,
302  Option = -3,
303  } ScanErrors;
304  }
305 
310  namespace Connect {
311 
316  typedef enum {
317  Success = 0,
318  NotInitialized = -1,
319  AlreadyConnected= -2,
320  Option = -3,
321  CouldNotConfig = -4,
322  SSID_NotFound = -5,
323  BSSID_NotFound = -6,
324  Sec_NotFound = -7,
325  Cipher_NotFound = -8,
326  ConnectFailed = -9,
327  } ConnectErrors;
328  }
329  }
330 } /* ----- end of namespace NBWifi ----- */
331 
332 #endif /* ----- #ifndef __NBWICEDCONSTANTS_H ----- */
Definition: nbWifiConstants.h:362
Definition: nbWifiConstants.h:298
Definition: nbWifiConstants.h:253
Definition: nbWifiConstants.h:322
Definition: nbWifiConstants.h:321
Definition: nbWifiConstants.h:320
Definition: nbWifiConstants.h:360
ConnectErrors
Definition: nbWifiConstants.h:355
Definition: nbWifiConstants.h:318
In Progress.
Definition: nbWifiConstants.h:340
Not Initialized.
Definition: nbWifiConstants.h:339
Definition: nbWifiConstants.h:301
Definition: nbWifiConstants.h:299
Definition: nbWifiConstants.h:247
NBWifi namespace that encompaces the WiFi driver.
Definition: nbWifiBsp.h:15
Definition: nbWifiConstants.h:359
Definition: nbWifiConstants.h:323
Definition: nbWifiConstants.h:364
ScanErrors
Definition: nbWifiConstants.h:337
InitializationErrors
Definition: nbWifiConstants.h:316
Definition: nbWifiConstants.h:357
Definition: nbWifiConstants.h:317
Definition: nbWifiConstants.h:300
Definition: nbWifiConstants.h:302
Definition: nbWifiConstants.h:303
Definition: nbWifiConstants.h:273
Definition: nbWifiConstants.h:358
Definition: nbWifiConstants.h:361
Definition: nbWifiConstants.h:356
Definition: nbWifiConstants.h:363
Definition: nbWifiConstants.h:248
Option.
Definition: nbWifiConstants.h:341
Success.
Definition: nbWifiConstants.h:338
Definition: nbWifiConstants.h:319
GeneralErrors
Definition: nbWifiConstants.h:297
Definition: nbWifiConstants.h:365