1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
|
/** @file
This file defines the EFI Wireless MAC Connection II Protocol.
Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@par Revision Reference:
This Protocol is introduced in UEFI Specification 2.6
**/
#ifndef __EFI_WIFI2_PROTOCOL_H__
#define __EFI_WIFI2_PROTOCOL_H__
#define EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL_GUID \
{ \
0x1b0fb9bf, 0x699d, 0x4fdd, { 0xa7, 0xc3, 0x25, 0x46, 0x68, 0x1b, 0xf6, 0x3b } \
}
typedef struct _EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL;
///
/// EFI_80211_BSS_TYPE
///
typedef enum {
IeeeInfrastructureBSS,
IeeeIndependentBSS,
IeeeMeshBSS,
IeeeAnyBss
} EFI_80211_BSS_TYPE;
///
/// EFI_80211_CONNECT_NETWORK_RESULT_CODE
///
typedef enum {
//
// The connection establishment operation finished successfully.
//
ConnectSuccess,
//
// The connection was refused by the Network.
//
ConnectRefused,
//
// The connection establishment operation failed (i.e, Network is not
// detected).
//
ConnectFailed,
//
// The connection establishment operation was terminated on timeout.
//
ConnectFailureTimeout,
//
// The connection establishment operation failed on other reason.
//
ConnectFailedReasonUnspecified
} EFI_80211_CONNECT_NETWORK_RESULT_CODE;
///
/// EFI_80211_MAC_ADDRESS
///
typedef struct {
UINT8 Addr[6];
} EFI_80211_MAC_ADDRESS;
#define EFI_MAX_SSID_LEN 32
///
/// EFI_80211_SSID
///
typedef struct {
//
// Length in bytes of the SSId. If zero, ignore SSId field.
//
UINT8 SSIdLen;
//
// Specifies the service set identifier.
//
UINT8 SSId[EFI_MAX_SSID_LEN];
} EFI_80211_SSID;
///
/// EFI_80211_GET_NETWORKS_DATA
///
typedef struct {
//
// The number of EFI_80211_SSID in SSIDList. If zero, SSIDList should be
// ignored.
//
UINT32 NumOfSSID;
//
// The SSIDList is a pointer to an array of EFI_80211_SSID instances. The
// number of entries is specified by NumOfSSID. The array should only include
// SSIDs of hidden networks. It is suggested that the caller inputs less than
// 10 elements in the SSIDList. It is the caller's responsibility to free
// this buffer.
//
EFI_80211_SSID SSIDList[1];
} EFI_80211_GET_NETWORKS_DATA;
///
/// EFI_80211_SUITE_SELECTOR
///
typedef struct {
//
// Organization Unique Identifier, as defined in IEEE 802.11 standard,
// usually set to 00-0F-AC.
//
UINT8 Oui[3];
//
// Suites types, as defined in IEEE 802.11 standard.
//
UINT8 SuiteType;
} EFI_80211_SUITE_SELECTOR;
///
/// EFI_80211_AKM_SUITE_SELECTOR
///
typedef struct {
//
// Indicates the number of AKM suite selectors that are contained in
// AKMSuiteList. If zero, the AKMSuiteList is ignored.
//
UINT16 AKMSuiteCount;
//
// A variable-length array of AKM suites, as defined in IEEE 802.11 standard,
// Table 8-101. The number of entries is specified by AKMSuiteCount.
//
EFI_80211_SUITE_SELECTOR AKMSuiteList[1];
} EFI_80211_AKM_SUITE_SELECTOR;
///
/// EFI_80211_CIPHER_SUITE_SELECTOR
///
typedef struct {
//
// Indicates the number of cipher suites that are contained in
// CipherSuiteList. If zero, the CipherSuiteList is ignored.
//
UINT16 CipherSuiteCount;
//
// A variable-length array of cipher suites, as defined in IEEE 802.11
// standard, Table 8-99. The number of entries is specified by
// CipherSuiteCount.
//
EFI_80211_SUITE_SELECTOR CipherSuiteList[1];
} EFI_80211_CIPHER_SUITE_SELECTOR;
///
/// EFI_80211_NETWORK
///
typedef struct {
//
// Specifies the type of the BSS.
//
EFI_80211_BSS_TYPE BSSType;
//
// Specifies the SSID of the BSS.
//
EFI_80211_SSID SSId;
//
// Pointer to the AKM suites supported in the wireless network.
//
EFI_80211_AKM_SUITE_SELECTOR *AKMSuite;
//
// Pointer to the cipher suites supported in the wireless network.
//
EFI_80211_CIPHER_SUITE_SELECTOR *CipherSuite;
} EFI_80211_NETWORK;
///
/// EFI_80211_NETWORK_DESCRIPTION
///
typedef struct {
//
// Specifies the found wireless network.
//
EFI_80211_NETWORK Network;
//
// Indicates the network quality as a value between 0 to 100, where 100
// indicates the highest network quality.
//
UINT8 NetworkQuality;
} EFI_80211_NETWORK_DESCRIPTION;
///
/// EFI_80211_GET_NETWORKS_RESULT
///
typedef struct {
//
// The number of EFI_80211_NETWORK_DESCRIPTION in NetworkDesc. If zero,
// NetworkDesc should be ignored.
//
UINT8 NumOfNetworkDesc;
//
// The NetworkDesc is a pointer to an array of EFI_80211_NETWORK_DESCRIPTION
// instances. It is caller's responsibility to free this buffer.
//
EFI_80211_NETWORK_DESCRIPTION **NetworkDesc;
} EFI_80211_GET_NETWORKS_RESULT;
///
/// EFI_80211_GET_NETWORKS_TOKEN
///
typedef struct {
//
// If the status code returned by GetNetworks() is EFI_SUCCESS, then this
// Event will be signaled after the Status field is updated by the EFI
// Wireless MAC Connection Protocol II driver. The type of Event must be
// EFI_NOTIFY_SIGNAL.
//
EFI_EVENT Event;
//
// Will be set to one of the following values:
// EFI_SUCCESS: The operation completed successfully.
// EFI_NOT_FOUND: Failed to find available wireless networks.
// EFI_DEVICE_ERROR: An unexpected network or system error occurred.
// EFI_ACCESS_DENIED: The operation is not completed due to some underlying
// hardware or software state.
// EFI_NOT_READY: The operation is started but not yet completed.
//
EFI_STATUS Status;
//
// Pointer to the input data for getting networks.
//
EFI_80211_GET_NETWORKS_DATA *Data;
//
// Indicates the scan result. It is caller's responsibility to free this
// buffer.
//
EFI_80211_GET_NETWORKS_RESULT *Result;
} EFI_80211_GET_NETWORKS_TOKEN;
///
/// EFI_80211_CONNECT_NETWORK_DATA
///
typedef struct {
//
// Specifies the wireless network to connect to.
//
EFI_80211_NETWORK *Network;
//
// Specifies a time limit in seconds that is optionally present, after which
// the connection establishment procedure is terminated by the UNDI driver.
// This is an optional parameter and may be 0. Values of 5 seconds or higher
// are recommended.
//
UINT32 FailureTimeout;
} EFI_80211_CONNECT_NETWORK_DATA;
///
/// EFI_80211_CONNECT_NETWORK_TOKEN
///
typedef struct {
//
// If the status code returned by ConnectNetwork() is EFI_SUCCESS, then this
// Event will be signaled after the Status field is updated by the EFI
// Wireless MAC Connection Protocol II driver. The type of Event must be
// EFI_NOTIFY_SIGNAL.
//
EFI_EVENT Event;
//
// Will be set to one of the following values:
// EFI_SUCCESS: The operation completed successfully.
// EFI_DEVICE_ERROR: An unexpected network or system error occurred.
// EFI_ACCESS_DENIED: The operation is not completed due to some underlying
// hardware or software state.
// EFI_NOT_READY: The operation is started but not yet completed.
//
EFI_STATUS Status;
//
// Pointer to the connection data.
//
EFI_80211_CONNECT_NETWORK_DATA *Data;
//
// Indicates the connection state.
//
EFI_80211_CONNECT_NETWORK_RESULT_CODE ResultCode;
} EFI_80211_CONNECT_NETWORK_TOKEN;
///
/// EFI_80211_DISCONNECT_NETWORK_TOKEN
///
typedef struct {
//
// If the status code returned by DisconnectNetwork() is EFI_SUCCESS, then
// this Event will be signaled after the Status field is updated by the EFI
// Wireless MAC Connection Protocol II driver. The type of Event must be
// EFI_NOTIFY_SIGNAL.
//
EFI_EVENT Event;
//
// Will be set to one of the following values:
// EFI_SUCCESS: The operation completed successfully
// EFI_DEVICE_ERROR: An unexpected network or system error occurred.
// EFI_ACCESS_DENIED: The operation is not completed due to some underlying
// hardware or software state.
//
EFI_STATUS Status;
} EFI_80211_DISCONNECT_NETWORK_TOKEN;
/**
Request a survey of potential wireless networks that administrator can later
elect to try to join.
@param[in] This Pointer to the
EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL
instance.
@param[in] Token Pointer to the token for getting wireless
network.
@retval EFI_SUCCESS The operation started, and an event will
eventually be raised for the caller.
@retval EFI_INVALID_PARAMETER One or more of the following conditions is
TRUE:
This is NULL.
Token is NULL.
@retval EFI_UNSUPPORTED One or more of the input parameters is not
supported by this implementation.
@retval EFI_ALREADY_STARTED The operation of getting wireless network is
already started.
@retval EFI_OUT_OF_RESOURCES Required system resources could not be
allocated.
**/
typedef
EFI_STATUS
(EFIAPI *EFI_WIRELESS_MAC_CONNECTION_II_GET_NETWORKS) (
IN EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL *This,
IN EFI_80211_GET_NETWORKS_TOKEN *Token
);
/**
Connect a wireless network specified by a particular SSID, BSS type and
Security type.
@param[in] This Pointer to the
EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL
instance.
@param[in] Token Pointer to the token for connecting wireless
network.
@retval EFI_SUCCESS The operation started successfully. Results
will be notified eventually.
@retval EFI_INVALID_PARAMETER One or more of the following conditions is
TRUE:
This is NULL.
Token is NULL.
@retval EFI_UNSUPPORTED One or more of the input parameters are not
supported by this implementation.
@retval EFI_ALREADY_STARTED The connection process is already started.
@retval EFI_NOT_FOUND The specified wireless network is not found.
@retval EFI_OUT_OF_RESOURCES Required system resources could not be
allocated.
**/
typedef
EFI_STATUS
(EFIAPI *EFI_WIRELESS_MAC_CONNECTION_II_CONNECT_NETWORK) (
IN EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL *This,
IN EFI_80211_CONNECT_NETWORK_TOKEN *Token
);
/**
Request a disconnection with current connected wireless network.
@param[in] This Pointer to the
EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL
instance.
@param[in] Token Pointer to the token for disconnecting
wireless network.
@retval EFI_SUCCESS The operation started successfully. Results
will be notified eventually.
@retval EFI_INVALID_PARAMETER One or more of the following conditions is
TRUE:
This is NULL.
Token is NULL.
@retval EFI_UNSUPPORTED One or more of the input parameters are not
supported by this implementation.
@retval EFI_NOT_FOUND Not connected to a wireless network.
@retval EFI_OUT_OF_RESOURCES Required system resources could not be
allocated.
**/
typedef
EFI_STATUS
(EFIAPI *EFI_WIRELESS_MAC_CONNECTION_II_DISCONNECT_NETWORK) (
IN EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL *This,
IN EFI_80211_DISCONNECT_NETWORK_TOKEN *Token
);
///
/// The EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL provides network management
/// service interfaces for 802.11 network stack. It is used by network
/// applications (and drivers) to establish wireless connection with a wireless
/// network.
///
struct _EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL {
EFI_WIRELESS_MAC_CONNECTION_II_GET_NETWORKS GetNetworks;
EFI_WIRELESS_MAC_CONNECTION_II_CONNECT_NETWORK ConnectNetwork;
EFI_WIRELESS_MAC_CONNECTION_II_DISCONNECT_NETWORK DisconnectNetwork;
};
extern EFI_GUID gEfiWiFi2ProtocolGuid;
#endif
|