le_wifiDefs_common.h

Go to the documentation of this file.
1 
2 /*
3  * ====================== WARNING ======================
4  *
5  * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
6  * DO NOT MODIFY IN ANY WAY.
7  *
8  * ====================== WARNING ======================
9  */
10 /**
11  * @file le_wifiDefs_common.h
12  *
13  * Type definitions for le_wifiDefs.
14  *
15  */
16 #ifndef LE_WIFIDEFS_COMMON_H_INCLUDE_GUARD
17 #define LE_WIFIDEFS_COMMON_H_INCLUDE_GUARD
18 
19 
20 #include "legato.h"
21 
22 #define IFGEN_LE_WIFIDEFS_PROTOCOL_ID "bcbfe8eba689d28a4b4eb860b617d097"
23 #define IFGEN_LE_WIFIDEFS_MSG_SIZE 9
24 /** @addtogroup le_wifiDefs
25  * @{ **/
26 
27 
28 //--------------------------------------------------------------------------------------------------
29 /**
30  * The maximum length of the textual representation of an IP address.
31  */
32 //--------------------------------------------------------------------------------------------------
33 #define LE_WIFIDEFS_MAX_IP_LENGTH 15
34 
35 //--------------------------------------------------------------------------------------------------
36 /**
37  * The first WiFi channel.
38  * @note This is only valid for 2,4 GHz WiFi frequencies.
39  */
40 //--------------------------------------------------------------------------------------------------
41 #define LE_WIFIDEFS_MIN_CHANNEL_VALUE 1
42 
43 //--------------------------------------------------------------------------------------------------
44 /**
45  * The last WiFi channel.
46  * @note This is only valid for 2,4 GHz WiFi frequencies.
47  */
48 //--------------------------------------------------------------------------------------------------
49 #define LE_WIFIDEFS_MAX_CHANNEL_VALUE 14
50 
51 //--------------------------------------------------------------------------------------------------
52 /**
53  * The first WiFi channel.
54  * @note This is only valid for 5 GHz WiFi frequencies.
55  */
56 //--------------------------------------------------------------------------------------------------
57 #define LE_WIFIDEFS_MIN_CHANNEL_STD_A 7
58 
59 //--------------------------------------------------------------------------------------------------
60 /**
61  * The last WiFi channel.
62  * @note This is only valid for 5 GHz WiFi frequencies.
63  */
64 //--------------------------------------------------------------------------------------------------
65 #define LE_WIFIDEFS_MAX_CHANNEL_STD_A 196
66 
67 //--------------------------------------------------------------------------------------------------
68 /**
69  * The first WiFi channel.
70  * @note This is only valid for 60 GHz WiFi frequencies.
71  */
72 //--------------------------------------------------------------------------------------------------
73 #define LE_WIFIDEFS_MIN_CHANNEL_STD_AD 1
74 
75 //--------------------------------------------------------------------------------------------------
76 /**
77  * The last WiFi channel.
78  * @note This is only valid for 60 GHz WiFi frequencies.
79  */
80 //--------------------------------------------------------------------------------------------------
81 #define LE_WIFIDEFS_MAX_CHANNEL_STD_AD 6
82 
83 //--------------------------------------------------------------------------------------------------
84 /**
85  * The length of the country code.
86  */
87 //--------------------------------------------------------------------------------------------------
88 #define LE_WIFIDEFS_ISO_COUNTRYCODE_LENGTH 2
89 
90 //--------------------------------------------------------------------------------------------------
91 /**
92  * The maximum number of bytes of the country code
93  * One extra byte is added for the null character.
94  */
95 //--------------------------------------------------------------------------------------------------
96 #define LE_WIFIDEFS_MAX_COUNTRYCODE_BYTES 3
97 
98 //--------------------------------------------------------------------------------------------------
99 /**
100  * The maximum length of the wep key.
101  */
102 //--------------------------------------------------------------------------------------------------
103 #define LE_WIFIDEFS_MAX_WEPKEY_LENGTH 63
104 
105 //--------------------------------------------------------------------------------------------------
106 /**
107  * The maximum number of bytes of the wep key
108  * One extra byte is added for the null character.
109  */
110 //--------------------------------------------------------------------------------------------------
111 #define LE_WIFIDEFS_MAX_WEPKEY_BYTES 64
112 
113 //--------------------------------------------------------------------------------------------------
114 /**
115  * The minimum length of the pass-phrase used to generate PSK is 8 bytes. See 802.11-2007: H4.2.
116  */
117 //--------------------------------------------------------------------------------------------------
118 #define LE_WIFIDEFS_MIN_PASSPHRASE_LENGTH 8
119 
120 //--------------------------------------------------------------------------------------------------
121 /**
122  * The maximum length of the pass-phrase used to generate PSK is 63 bytes. See 802.11-2007: H4.2.
123  */
124 //--------------------------------------------------------------------------------------------------
125 #define LE_WIFIDEFS_MAX_PASSPHRASE_LENGTH 63
126 
127 //--------------------------------------------------------------------------------------------------
128 /**
129  * Maximum length of PSK, Pre Shared Key.
130  * One extra byte is added for the null character.
131  */
132 //--------------------------------------------------------------------------------------------------
133 #define LE_WIFIDEFS_MAX_PASSPHRASE_BYTES 64
134 
135 //--------------------------------------------------------------------------------------------------
136 /**
137  * The length of the PSK, Pre Shared Key, is 64 bytes. See 802.11-2007: H4.2.
138  */
139 //--------------------------------------------------------------------------------------------------
140 #define LE_WIFIDEFS_MAX_PSK_LENGTH 64
141 
142 //--------------------------------------------------------------------------------------------------
143 /**
144  * Maximum length of PSK, Pre Shared Key.
145  * One extra byte is added for the null character.
146  */
147 //--------------------------------------------------------------------------------------------------
148 #define LE_WIFIDEFS_MAX_PSK_BYTES 65
149 
150 //--------------------------------------------------------------------------------------------------
151 /**
152  * Maximum length of the User-Name. RFC2865 recommends the ability to handle at least 63 octets.
153  */
154 //--------------------------------------------------------------------------------------------------
155 #define LE_WIFIDEFS_MAX_USERNAME_LENGTH 63
156 
157 //--------------------------------------------------------------------------------------------------
158 /**
159  * Maximum length of the User-Name.
160  * One extra byte is added for the null character.
161  */
162 //--------------------------------------------------------------------------------------------------
163 #define LE_WIFIDEFS_MAX_USERNAME_BYTES 64
164 
165 //--------------------------------------------------------------------------------------------------
166 /**
167  * Maximum length of the User-Name. RFC2865 recommends at least 130.
168  */
169 //--------------------------------------------------------------------------------------------------
170 #define LE_WIFIDEFS_MAX_PASSWORD_LENGTH 130
171 
172 //--------------------------------------------------------------------------------------------------
173 /**
174  * Maximum length of the User-Name.
175  * One extra byte is added for the null character.
176  */
177 //--------------------------------------------------------------------------------------------------
178 #define LE_WIFIDEFS_MAX_PASSWORD_BYTES 131
179 
180 //--------------------------------------------------------------------------------------------------
181 /**
182  * The minimum length of octets of the Service set identification (SSID).
183  * @note While the values are probably human readable, this is not a string.
184  */
185 //--------------------------------------------------------------------------------------------------
186 #define LE_WIFIDEFS_MIN_SSID_LENGTH 1
187 
188 //--------------------------------------------------------------------------------------------------
189 /**
190  * The maximum length of octets of the Service set identification (SSID).
191  * @note While the values are probably human readable, this is not a string.
192  */
193 //--------------------------------------------------------------------------------------------------
194 #define LE_WIFIDEFS_MAX_SSID_LENGTH 32
195 
196 //--------------------------------------------------------------------------------------------------
197 /**
198  * The maximum length of octets of the Service set identification (SSID).
199  * @note While the values are probably human readable, this is not a string.
200  */
201 //--------------------------------------------------------------------------------------------------
202 #define LE_WIFIDEFS_MAX_SSID_BYTES 33
203 
204 //--------------------------------------------------------------------------------------------------
205 /**
206  * The maximum length of octets of the Basic Service set identifier (BSSID). The length is derived
207  * from 6 bytes represented as hexadecimal character string with bytes separated by colons.
208  */
209 //--------------------------------------------------------------------------------------------------
210 #define LE_WIFIDEFS_MAX_BSSID_LENGTH 17
211 
212 //--------------------------------------------------------------------------------------------------
213 /**
214  * Maximum length of the Basic Service set identifier (BSSID).
215  * One extra byte is added for the null character.
216  */
217 //--------------------------------------------------------------------------------------------------
218 #define LE_WIFIDEFS_MAX_BSSID_BYTES 18
219 
220 //--------------------------------------------------------------------------------------------------
221 /**
222  * The maximum length of WLAN interface name
223  */
224 //--------------------------------------------------------------------------------------------------
225 #define LE_WIFIDEFS_MAX_IFNAME_LENGTH 30
226 
227 //--------------------------------------------------------------------------------------------------
228 /**
229  * Maximum length of WLAN interface name.
230  * One extra byte is added for the null character.
231  */
232 //--------------------------------------------------------------------------------------------------
233 #define LE_WIFIDEFS_MAX_IFNAME_BYTES 31
234 
235 
236 //--------------------------------------------------------------------------------------------------
237 /**
238  * Get if this client bound locally.
239  */
240 //--------------------------------------------------------------------------------------------------
241 LE_SHARED bool ifgen_le_wifiDefs_HasLocalBinding
242 (
243  void
244 );
245 
246 
247 //--------------------------------------------------------------------------------------------------
248 /**
249  * Init data that is common across all threads
250  */
251 //--------------------------------------------------------------------------------------------------
252 LE_SHARED void ifgen_le_wifiDefs_InitCommonData
253 (
254  void
255 );
256 
257 
258 //--------------------------------------------------------------------------------------------------
259 /**
260  * Perform common initialization and open a session
261  */
262 //--------------------------------------------------------------------------------------------------
263 LE_SHARED le_result_t ifgen_le_wifiDefs_OpenSession
264 (
265  le_msg_SessionRef_t _ifgen_sessionRef,
266  bool isBlocking
267 );
268 /** @} **/
269 #endif // LE_WIFIDEFS_COMMON_H_INCLUDE_GUARD
#define LE_SHARED
Definition: le_basics.h:300
le_result_t
Definition: le_basics.h:46
struct le_msg_Session * le_msg_SessionRef_t
Definition: le_messaging.h:860