2 This file provides management service interfaces of 802.11 MAC layer. It is used by
3 network applications (and drivers) to establish wireless connection with an access
6 Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>
7 SPDX-License-Identifier: BSD-2-Clause-Patent
9 @par Revision Reference:
10 This Protocol is introduced in UEFI Specification 2.5
14 #ifndef __EFI_WIFI_PROTOCOL_H__
15 #define __EFI_WIFI_PROTOCOL_H__
17 #include <Protocol/WiFi2.h>
19 #define EFI_WIRELESS_MAC_CONNECTION_PROTOCOL_GUID \
21 0xda55bc9, 0x45f8, 0x4bb4, {0x87, 0x19, 0x52, 0x24, 0xf1, 0x8a, 0x4d, 0x45 } \
24 typedef struct _EFI_WIRELESS_MAC_CONNECTION_PROTOCOL EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
;
27 /// EFI_80211_ACC_NET_TYPE
31 IeeePrivatewithGuest
= 1,
32 IeeeChargeablePublic
= 2,
35 IeeeEmergencyServOnly
= 5,
38 } EFI_80211_ACC_NET_TYPE
;
41 /// EFI_80211_ASSOCIATE_RESULT_CODE
45 AssociateRefusedReasonUnspecified
,
46 AssociateRefusedCapsMismatch
,
47 AssociateRefusedExtReason
,
48 AssociateRefusedAPOutOfMemory
,
49 AssociateRefusedBasicRatesMismatch
,
50 AssociateRejectedEmergencyServicesNotSupported
,
51 AssociateRefusedTemporarily
52 } EFI_80211_ASSOCIATE_RESULT_CODE
;
55 /// EFI_80211_SCAN_RESULT_CODE
59 /// The scan operation finished successfully.
63 /// The scan operation is not supported in current implementation.
66 } EFI_80211_SCAN_RESULT_CODE
;
69 /// EFI_80211_REASON_CODE
72 Ieee80211UnspecifiedReason
= 1,
73 Ieee80211PreviousAuthenticateInvalid
= 2,
74 Ieee80211DeauthenticatedSinceLeaving
= 3,
75 Ieee80211DisassociatedDueToInactive
= 4,
76 Ieee80211DisassociatedSinceApUnable
= 5,
77 Ieee80211Class2FrameNonauthenticated
= 6,
78 Ieee80211Class3FrameNonassociated
= 7,
79 Ieee80211DisassociatedSinceLeaving
= 8,
81 } EFI_80211_REASON_CODE
;
84 /// EFI_80211_DISASSOCIATE_RESULT_CODE
88 /// Disassociation process completed successfully.
92 /// Disassociation failed due to any input parameter is invalid.
94 DisassociateInvalidParameters
95 } EFI_80211_DISASSOCIATE_RESULT_CODE
;
98 /// EFI_80211_AUTHENTICATION_TYPE
102 /// Open system authentication, admits any STA to the DS.
106 /// Shared Key authentication relies on WEP to demonstrate knowledge of a WEP
111 /// FT authentication relies on keys derived during the initial mobility domain
112 /// association to authenticate the stations.
116 /// SAE authentication uses finite field cryptography to prove knowledge of a shared
120 } EFI_80211_AUTHENTICATION_TYPE
;
123 /// EFI_80211_AUTHENTICATION_RESULT_CODE
128 AuthenticateAnticLoggingTokenRequired
,
129 AuthenticateFiniteCyclicGroupNotSupported
,
130 AuthenticationRejected
,
131 AuthenticateInvalidParameter
132 } EFI_80211_AUTHENTICATE_RESULT_CODE
;
135 /// EFI_80211_ELEMENT_HEADER
139 /// A unique element ID defined in IEEE 802.11 specification.
143 /// Specifies the number of octets in the element body.
146 } EFI_80211_ELEMENT_HEADER
;
149 /// EFI_80211_ELEMENT_REQ
153 /// Common header of an element.
155 EFI_80211_ELEMENT_HEADER Hdr
;
157 /// Start of elements that are requested to be included in the Probe Response frame.
158 /// The elements are listed in order of increasing element ID.
161 } EFI_80211_ELEMENT_REQ
;
164 /// EFI_80211_ELEMENT_SSID
168 /// Common header of an element.
170 EFI_80211_ELEMENT_HEADER Hdr
;
172 /// Service set identifier. If Hdr.Length is zero, this field is ignored.
175 } EFI_80211_ELEMENT_SSID
;
178 /// EFI_80211_SCAN_DATA
182 /// Determines whether infrastructure BSS, IBSS, MBSS, or all, are included in the
185 EFI_80211_BSS_TYPE BSSType
;
187 /// Indicates a specific or wildcard BSSID. Use all binary 1s to represent all SSIDs.
189 EFI_80211_MAC_ADDRESS BSSId
;
191 /// Length in bytes of the SSId. If zero, ignore SSId field.
195 /// Specifies the desired SSID or the wildcard SSID. Use NULL to represent all SSIDs.
199 /// Indicates passive scanning if TRUE.
203 /// The delay in microseconds to be used prior to transmitting a Probe frame during
204 /// active scanning. If zero, the value can be overridden by an
205 /// implementation-dependent default value.
209 /// Specifies a list of channels that are examined when scanning for a BSS. If set to
210 /// NULL, all valid channels will be scanned.
214 /// Indicates the minimum time in TU to spend on each channel when scanning. If zero,
215 /// the value can be overridden by an implementation-dependent default value.
217 UINT32 MinChannelTime
;
219 /// Indicates the maximum time in TU to spend on each channel when scanning. If zero,
220 /// the value can be overridden by an implementation-dependent default value.
222 UINT32 MaxChannelTime
;
224 /// Points to an optionally present element. This is an optional parameter and may be
227 EFI_80211_ELEMENT_REQ
*RequestInformation
;
229 /// Indicates one or more SSID elements that are optionally present. This is an
230 /// optional parameter and may be NULL.
232 EFI_80211_ELEMENT_SSID
*SSIDList
;
234 /// Specifies a desired specific access network type or the wildcard access network
235 /// type. Use 15 as wildcard access network type.
237 EFI_80211_ACC_NET_TYPE AccessNetworkType
;
239 /// Specifies zero or more elements. This is an optional parameter and may be NULL.
241 UINT8
*VendorSpecificInfo
;
242 } EFI_80211_SCAN_DATA
;
245 /// EFI_80211_COUNTRY_TRIPLET_SUBBAND
249 /// Indicates the lowest channel number in the subband. It has a positive integer
250 /// value less than 201.
252 UINT8 FirstChannelNum
;
254 /// Indicates the number of channels in the subband.
258 /// Indicates the maximum power in dBm allowed to be transmitted.
260 UINT8 MaxTxPowerLevel
;
261 } EFI_80211_COUNTRY_TRIPLET_SUBBAND
;
264 /// EFI_80211_COUNTRY_TRIPLET_OPERATE
268 /// Indicates the operating extension identifier. It has a positive integer value of
271 UINT8 OperatingExtId
;
273 /// Index into a set of values for radio equipment set of rules.
275 UINT8 OperatingClass
;
277 /// Specifies aAirPropagationTime characteristics used in BSS operation. Refer the
278 /// definition of aAirPropagationTime in IEEE 802.11 specification.
281 } EFI_80211_COUNTRY_TRIPLET_OPERATE
;
284 /// EFI_80211_COUNTRY_TRIPLET
288 /// The subband triplet.
290 EFI_80211_COUNTRY_TRIPLET_SUBBAND Subband
;
292 /// The operating triplet.
294 EFI_80211_COUNTRY_TRIPLET_OPERATE Operating
;
295 } EFI_80211_COUNTRY_TRIPLET
;
298 /// EFI_80211_ELEMENT_COUNTRY
302 /// Common header of an element.
304 EFI_80211_ELEMENT_HEADER Hdr
;
306 /// Specifies country strings in 3 octets.
310 /// Indicates a triplet that repeated in country element. The number of triplets is
311 /// determined by the Hdr.Length field.
313 EFI_80211_COUNTRY_TRIPLET CountryTriplet
[1];
314 } EFI_80211_ELEMENT_COUNTRY
;
317 /// EFI_80211_ELEMENT_DATA_RSN
321 /// Indicates the version number of the RSNA protocol. Value 1 is defined in current
322 /// IEEE 802.11 specification.
326 /// Specifies the cipher suite selector used by the BSS to protect group address frames.
328 UINT32 GroupDataCipherSuite
;
330 /// Indicates the number of pairwise cipher suite selectors that are contained in
331 /// PairwiseCipherSuiteList.
333 //UINT16 PairwiseCipherSuiteCount;
335 /// Contains a series of cipher suite selectors that indicate the pairwise cipher
336 /// suites contained in this element.
338 //UINT32 PairwiseCipherSuiteList[PairwiseCipherSuiteCount];
340 /// Indicates the number of AKM suite selectors that are contained in AKMSuiteList.
342 //UINT16 AKMSuiteCount;
344 /// Contains a series of AKM suite selectors that indicate the AKM suites contained in
347 //UINT32 AKMSuiteList[AKMSuiteCount];
349 /// Indicates requested or advertised capabilities.
351 //UINT16 RSNCapabilities;
353 /// Indicates the number of PKMIDs in the PMKIDList.
357 /// Contains zero or more PKMIDs that the STA believes to be valid for the destination
359 //UINT8 PMKIDList[PMKIDCount][16];
361 /// Specifies the cipher suite selector used by the BSS to protect group addressed
362 /// robust management frames.
364 //UINT32 GroupManagementCipherSuite;
365 } EFI_80211_ELEMENT_DATA_RSN
;
368 /// EFI_80211_ELEMENT_RSN
372 /// Common header of an element.
374 EFI_80211_ELEMENT_HEADER Hdr
;
376 /// Points to RSN element. The size of a RSN element is limited to 255 octets.
378 EFI_80211_ELEMENT_DATA_RSN
*Data
;
379 } EFI_80211_ELEMENT_RSN
;
382 /// EFI_80211_ELEMENT_EXT_CAP
386 /// Common header of an element.
388 EFI_80211_ELEMENT_HEADER Hdr
;
390 /// Indicates the capabilities being advertised by the STA transmitting the element.
391 /// This is a bit field with variable length. Refer to IEEE 802.11 specification for
394 UINT8 Capabilities
[1];
395 } EFI_80211_ELEMENT_EXT_CAP
;
398 /// EFI_80211_BSS_DESCRIPTION
402 /// Indicates a specific BSSID of the found BSS.
404 EFI_80211_MAC_ADDRESS BSSId
;
406 /// Specifies the SSID of the found BSS. If NULL, ignore SSIdLen field.
410 /// Specifies the SSID of the found BSS. If NULL, ignore SSIdLen field.
414 /// Specifies the type of the found BSS.
416 EFI_80211_BSS_TYPE BSSType
;
418 /// The beacon period in TU of the found BSS.
422 /// The timestamp of the received frame from the found BSS.
426 /// The advertised capabilities of the BSS.
428 UINT16 CapabilityInfo
;
430 /// The set of data rates that shall be supported by all STAs that desire to join this
433 UINT8
*BSSBasicRateSet
;
435 /// The set of data rates that the peer STA desires to use for communication within
438 UINT8
*OperationalRateSet
;
440 /// The information required to identify the regulatory domain in which the peer STA
443 EFI_80211_ELEMENT_COUNTRY
*Country
;
445 /// The cipher suites and AKM suites supported in the BSS.
447 EFI_80211_ELEMENT_RSN RSN
;
449 /// Specifies the RSSI of the received frame.
453 /// Specifies the RCPI of the received frame.
455 UINT8 RCPIMeasurement
;
457 /// Specifies the RSNI of the received frame.
459 UINT8 RSNIMeasurement
;
461 /// Specifies the elements requested by the request element of the Probe Request frame.
462 /// This is an optional parameter and may be NULL.
464 UINT8
*RequestedElements
;
466 /// Specifies the BSS membership selectors that represent the set of features that
467 /// shall be supported by all STAs to join this BSS.
469 UINT8
*BSSMembershipSelectorSet
;
471 /// Specifies the parameters within the Extended Capabilities element that are
472 /// supported by the MAC entity. This is an optional parameter and may be NULL.
474 EFI_80211_ELEMENT_EXT_CAP
*ExtCapElement
;
475 } EFI_80211_BSS_DESCRIPTION
;
478 /// EFI_80211_SUBELEMENT_INFO
482 /// Indicates the unique identifier within the containing element or sub-element.
486 /// Specifies the number of octets in the Data field.
490 /// A variable length data buffer.
493 } EFI_80211_SUBELEMENT_INFO
;
496 /// EFI_80211_MULTIPLE_BSSID
500 /// Common header of an element.
502 EFI_80211_ELEMENT_HEADER Hdr
;
504 /// Indicates the maximum number of BSSIDs in the multiple BSSID set. When Indicator
505 /// is set to n, 2n is the maximum number.
509 /// Contains zero or more sub-elements.
511 EFI_80211_SUBELEMENT_INFO SubElement
[1];
512 } EFI_80211_MULTIPLE_BSSID
;
515 /// EFI_80211_BSS_DESP_PILOT
519 /// Indicates a specific BSSID of the found BSS.
521 EFI_80211_MAC_ADDRESS BSSId
;
523 /// Specifies the type of the found BSS.
525 EFI_80211_BSS_TYPE BSSType
;
527 /// One octet field to report condensed capability information.
531 /// Two octet's field to report condensed country string.
533 UINT8 ConCountryStr
[2];
535 /// Indicates the operating class value for the operating channel.
537 UINT8 OperatingClass
;
539 /// Indicates the operating channel.
543 /// Indicates the measurement pilot interval in TU.
547 /// Indicates that the BSS is within a multiple BSSID set.
549 EFI_80211_MULTIPLE_BSSID
*MultipleBSSID
;
551 /// Specifies the RCPI of the received frame.
553 UINT8 RCPIMeasurement
;
555 /// Specifies the RSNI of the received frame.
557 UINT8 RSNIMeasurement
;
558 } EFI_80211_BSS_DESP_PILOT
;
561 /// EFI_80211_SCAN_RESULT
565 /// The number of EFI_80211_BSS_DESCRIPTION in BSSDespSet. If zero, BSSDespSet should
570 /// Points to zero or more instances of EFI_80211_BSS_DESCRIPTION.
572 EFI_80211_BSS_DESCRIPTION
**BSSDespSet
;
574 /// The number of EFI_80211_BSS_DESP_PILOT in BSSDespFromPilotSet. If zero,
575 /// BSSDespFromPilotSet should be ignored.
577 UINTN NumofBSSDespFromPilot
;
579 /// Points to zero or more instances of EFI_80211_BSS_DESP_PILOT.
581 EFI_80211_BSS_DESP_PILOT
**BSSDespFromPilotSet
;
583 /// Specifies zero or more elements. This is an optional parameter and may be NULL.
585 UINT8
*VendorSpecificInfo
;
586 } EFI_80211_SCAN_RESULT
;
589 /// EFI_80211_SCAN_DATA_TOKEN
593 /// This Event will be signaled after the Status field is updated by the EFI Wireless
594 /// MAC Connection Protocol driver. The type of Event must be EFI_NOTIFY_SIGNAL.
598 /// Will be set to one of the following values:
599 /// EFI_SUCCESS: Scan operation completed successfully.
600 /// EFI_NOT_FOUND: Failed to find available BSS.
601 /// EFI_DEVICE_ERROR: An unexpected network or system error occurred.
602 /// EFI_ACCESS_DENIED: The scan operation is not completed due to some underlying
603 /// hardware or software state.
604 /// EFI_NOT_READY: The scan operation is started but not yet completed.
607 /// Pointer to the scan data.
609 EFI_80211_SCAN_DATA
*Data
;
611 /// Indicates the scan state.
613 EFI_80211_SCAN_RESULT_CODE ResultCode
;
615 /// Indicates the scan result. It is caller's responsibility to free this buffer.
617 EFI_80211_SCAN_RESULT
*Result
;
618 } EFI_80211_SCAN_DATA_TOKEN
;
621 /// EFI_80211_ELEMENT_SUPP_CHANNEL_TUPLE
625 /// The first channel number in a subband of supported channels.
627 UINT8 FirstChannelNumber
;
629 /// The number of channels in a subband of supported channels.
631 UINT8 NumberOfChannels
;
632 } EFI_80211_ELEMENT_SUPP_CHANNEL_TUPLE
;
635 /// EFI_80211_ELEMENT_SUPP_CHANNEL
639 /// Common header of an element.
641 EFI_80211_ELEMENT_HEADER Hdr
;
643 /// Indicates one or more tuples of (first channel, number of channels).
645 EFI_80211_ELEMENT_SUPP_CHANNEL_TUPLE Subband
[1];
646 } EFI_80211_ELEMENT_SUPP_CHANNEL
;
649 /// EFI_80211_ASSOCIATE_DATA
653 /// Specifies the address of the peer MAC entity to associate with.
655 EFI_80211_MAC_ADDRESS BSSId
;
657 /// Specifies the requested operational capabilities to the AP in 2 octets.
659 UINT16 CapabilityInfo
;
661 /// Specifies a time limit in TU, after which the associate procedure is terminated.
663 UINT32 FailureTimeout
;
665 /// Specifies if in power save mode, how often the STA awakes and listens for the next
666 /// beacon frame in TU.
668 UINT32 ListenInterval
;
670 /// Indicates a list of channels in which the STA is capable of operating.
672 EFI_80211_ELEMENT_SUPP_CHANNEL
*Channels
;
674 /// The cipher suites and AKM suites selected by the STA.
676 EFI_80211_ELEMENT_RSN RSN
;
678 /// Specifies the parameters within the Extended Capabilities element that are
679 /// supported by the MAC entity. This is an optional parameter and may be NULL.
681 EFI_80211_ELEMENT_EXT_CAP
*ExtCapElement
;
683 /// Specifies zero or more elements. This is an optional parameter and may be NULL.
685 UINT8
*VendorSpecificInfo
;
686 } EFI_80211_ASSOCIATE_DATA
;
689 /// EFI_80211_ELEMENT_TIMEOUT_VAL
693 /// Common header of an element.
695 EFI_80211_ELEMENT_HEADER Hdr
;
697 /// Specifies the timeout interval type.
701 /// Specifies the timeout interval value.
704 } EFI_80211_ELEMENT_TIMEOUT_VAL
;
707 /// EFI_80211_ASSOCIATE_RESULT
711 /// Specifies the address of the peer MAC entity from which the association request
714 EFI_80211_MAC_ADDRESS BSSId
;
716 /// Specifies the operational capabilities advertised by the AP.
718 UINT16 CapabilityInfo
;
720 /// Specifies the association ID value assigned by the AP.
722 UINT16 AssociationID
;
724 /// Indicates the measured RCPI of the corresponding association request frame. It is
725 /// an optional parameter and is set to zero if unavailable.
729 /// Indicates the measured RSNI at the time the corresponding association request
730 /// frame was received. It is an optional parameter and is set to zero if unavailable.
734 /// Specifies the parameters within the Extended Capabilities element that are
735 /// supported by the MAC entity. This is an optional parameter and may be NULL.
737 EFI_80211_ELEMENT_EXT_CAP
*ExtCapElement
;
739 /// Specifies the timeout interval when the result code is AssociateRefusedTemporarily.
741 EFI_80211_ELEMENT_TIMEOUT_VAL TimeoutInterval
;
743 /// Specifies zero or more elements. This is an optional parameter and may be NULL.
745 UINT8
*VendorSpecificInfo
;
746 } EFI_80211_ASSOCIATE_RESULT
;
749 /// EFI_80211_ASSOCIATE_DATA_TOKEN
753 /// This Event will be signaled after the Status field is updated by the EFI Wireless
754 /// MAC Connection Protocol driver. The type of Event must be EFI_NOTIFY_SIGNAL.
758 /// Will be set to one of the following values:
759 /// EFI_SUCCESS: Association operation completed successfully.
760 /// EFI_DEVICE_ERROR: An unexpected network or system error occurred.
764 /// Pointer to the association data.
766 EFI_80211_ASSOCIATE_DATA
*Data
;
768 /// Indicates the association state.
770 EFI_80211_ASSOCIATE_RESULT_CODE ResultCode
;
772 /// Indicates the association result. It is caller's responsibility to free this
775 EFI_80211_ASSOCIATE_RESULT
*Result
;
776 } EFI_80211_ASSOCIATE_DATA_TOKEN
;
779 /// EFI_80211_DISASSOCIATE_DATA
783 /// Specifies the address of the peer MAC entity with which to perform the
784 /// disassociation process.
786 EFI_80211_MAC_ADDRESS BSSId
;
788 /// Specifies the reason for initiating the disassociation process.
790 EFI_80211_REASON_CODE ReasonCode
;
792 /// Zero or more elements, may be NULL.
794 UINT8
*VendorSpecificInfo
;
795 } EFI_80211_DISASSOCIATE_DATA
;
798 /// EFI_80211_DISASSOCIATE_DATA_TOKEN
802 /// This Event will be signaled after the Status field is updated by the EFI Wireless
803 /// MAC Connection Protocol driver. The type of Event must be EFI_NOTIFY_SIGNAL.
807 /// Will be set to one of the following values:
808 /// EFI_SUCCESS: Disassociation operation completed successfully.
809 /// EFI_DEVICE_ERROR: An unexpected network or system error occurred.
810 /// EFI_ACCESS_DENIED: The disassociation operation is not completed due to some
811 /// underlying hardware or software state.
812 /// EFI_NOT_READY: The disassociation operation is started but not yet completed.
816 /// Pointer to the disassociation data.
818 EFI_80211_DISASSOCIATE_DATA
*Data
;
820 /// Indicates the disassociation state.
822 EFI_80211_DISASSOCIATE_RESULT_CODE ResultCode
;
823 } EFI_80211_DISASSOCIATE_DATA_TOKEN
;
826 /// EFI_80211_AUTHENTICATION_DATA
830 /// Specifies the address of the peer MAC entity with which to perform the
831 /// authentication process.
833 EFI_80211_MAC_ADDRESS BSSId
;
835 /// Specifies the type of authentication algorithm to use during the authentication
838 EFI_80211_AUTHENTICATION_TYPE AuthType
;
840 /// Specifies a time limit in TU after which the authentication procedure is
843 UINT32 FailureTimeout
;
845 /// Specifies the set of elements to be included in the first message of the FT
846 /// authentication sequence, may be NULL.
850 /// Specifies the set of elements to be included in the SAE Commit Message or SAE
851 /// Confirm Message, may be NULL.
855 /// Zero or more elements, may be NULL.
857 UINT8
*VendorSpecificInfo
;
858 } EFI_80211_AUTHENTICATE_DATA
;
861 /// EFI_80211_AUTHENTICATION_RESULT
865 /// Specifies the address of the peer MAC entity from which the authentication request
868 EFI_80211_MAC_ADDRESS BSSId
;
870 /// Specifies the set of elements to be included in the second message of the FT
871 /// authentication sequence, may be NULL.
875 /// Specifies the set of elements to be included in the SAE Commit Message or SAE
876 /// Confirm Message, may be NULL.
880 /// Zero or more elements, may be NULL.
882 UINT8
*VendorSpecificInfo
;
883 } EFI_80211_AUTHENTICATE_RESULT
;
886 /// EFI_80211_AUTHENTICATE_DATA_TOKEN
890 /// This Event will be signaled after the Status field is updated by the EFI Wireless
891 /// MAC Connection Protocol driver. The type of Event must be EFI_NOTIFY_SIGNAL.
895 /// Will be set to one of the following values:
896 /// EFI_SUCCESS: Authentication operation completed successfully.
897 /// EFI_PROTOCOL_ERROR: Peer MAC entity rejects the authentication.
898 /// EFI_NO_RESPONSE: Peer MAC entity does not response the authentication request.
899 /// EFI_DEVICE_ERROR: An unexpected network or system error occurred.
900 /// EFI_ACCESS_DENIED: The authentication operation is not completed due to some
901 /// underlying hardware or software state.
902 /// EFI_NOT_READY: The authentication operation is started but not yet completed.
906 /// Pointer to the authentication data.
908 EFI_80211_AUTHENTICATE_DATA
*Data
;
910 /// Indicates the association state.
912 EFI_80211_AUTHENTICATE_RESULT_CODE ResultCode
;
914 /// Indicates the association result. It is caller's responsibility to free this
917 EFI_80211_AUTHENTICATE_RESULT
*Result
;
918 } EFI_80211_AUTHENTICATE_DATA_TOKEN
;
921 /// EFI_80211_DEAUTHENTICATE_DATA
925 /// Specifies the address of the peer MAC entity with which to perform the
926 /// deauthentication process.
928 EFI_80211_MAC_ADDRESS BSSId
;
930 /// Specifies the reason for initiating the deauthentication process.
932 EFI_80211_REASON_CODE ReasonCode
;
934 /// Zero or more elements, may be NULL.
936 UINT8
*VendorSpecificInfo
;
937 } EFI_80211_DEAUTHENTICATE_DATA
;
940 /// EFI_80211_DEAUTHENTICATE_DATA_TOKEN
944 /// This Event will be signaled after the Status field is updated by the EFI Wireless
945 /// MAC Connection Protocol driver. The type of Event must be EFI_NOTIFY_SIGNAL.
949 /// Will be set to one of the following values:
950 /// EFI_SUCCESS: Deauthentication operation completed successfully.
951 /// EFI_DEVICE_ERROR: An unexpected network or system error occurred.
952 /// EFI_ACCESS_DENIED: The deauthentication operation is not completed due to some
953 /// underlying hardware or software state.
954 /// EFI_NOT_READY: The deauthentication operation is started but not yet
959 /// Pointer to the deauthentication data.
961 EFI_80211_DEAUTHENTICATE_DATA
*Data
;
962 } EFI_80211_DEAUTHENTICATE_DATA_TOKEN
;
965 Request a survey of potential BSSs that administrator can later elect to try to join.
967 The Scan() function returns the description of the set of BSSs detected by the scan
968 process. Passive scan operation is performed by default.
970 @param[in] This Pointer to the EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
972 @param[in] Data Pointer to the scan token.
974 @retval EFI_SUCCESS The operation completed successfully.
975 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
979 @retval EFI_UNSUPPORTED One or more of the input parameters are not supported
980 by this implementation.
981 @retval EFI_ALREADY_STARTED The scan operation is already started.
985 (EFIAPI
*EFI_WIRELESS_MAC_CONNECTION_SCAN
)(
986 IN EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
*This
,
987 IN EFI_80211_SCAN_DATA_TOKEN
*Data
991 Request an association with a specified peer MAC entity that is within an AP.
993 The Associate() function provides the capability for MAC layer to become associated
996 @param[in] This Pointer to the EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
998 @param[in] Data Pointer to the association token.
1000 @retval EFI_SUCCESS The operation completed successfully.
1001 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
1005 @retval EFI_UNSUPPORTED One or more of the input parameters are not supported
1006 by this implementation.
1007 @retval EFI_ALREADY_STARTED The association process is already started.
1008 @retval EFI_NOT_READY Authentication is not performed before this association
1010 @retval EFI_NOT_FOUND The specified peer MAC entity is not found.
1011 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
1015 (EFIAPI
*EFI_WIRELESS_MAC_CONNECTION_ASSOCIATE
)(
1016 IN EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
*This
,
1017 IN EFI_80211_ASSOCIATE_DATA_TOKEN
*Data
1021 Request a disassociation with a specified peer MAC entity.
1023 The Disassociate() function is invoked to terminate an existing association.
1024 Disassociation is a notification and cannot be refused by the receiving peer except
1025 when management frame protection is negotiated and the message integrity check fails.
1027 @param[in] This Pointer to the EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
1029 @param[in] Data Pointer to the disassociation token.
1031 @retval EFI_SUCCESS The operation completed successfully.
1032 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
1035 @retval EFI_ALREADY_STARTED The disassociation process is already started.
1036 @retval EFI_NOT_READY The disassociation service is invoked to a
1037 nonexistent association relationship.
1038 @retval EFI_NOT_FOUND The specified peer MAC entity is not found.
1039 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
1043 (EFIAPI
*EFI_WIRELESS_MAC_CONNECTION_DISASSOCIATE
)(
1044 IN EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
*This
,
1045 IN EFI_80211_DISASSOCIATE_DATA_TOKEN
*Data
1049 Request the process of establishing an authentication relationship with a peer MAC
1052 The Authenticate() function requests authentication with a specified peer MAC entity.
1053 This service might be time-consuming thus is designed to be invoked independently of
1054 the association service.
1056 @param[in] This Pointer to the EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
1058 @param[in] Data Pointer to the authentication token.
1060 @retval EFI_SUCCESS The operation completed successfully.
1061 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
1065 @retval EFI_UNSUPPORTED One or more of the input parameters are not supported
1066 by this implementation.
1067 @retval EFI_ALREADY_STARTED The authentication process is already started.
1068 @retval EFI_NOT_FOUND The specified peer MAC entity is not found.
1069 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
1073 (EFIAPI
*EFI_WIRELESS_MAC_CONNECTION_AUTHENTICATE
)(
1074 IN EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
*This
,
1075 IN EFI_80211_AUTHENTICATE_DATA_TOKEN
*Data
1079 Invalidate the authentication relationship with a peer MAC entity.
1081 The Deauthenticate() function requests that the authentication relationship with a
1082 specified peer MAC entity be invalidated. Deauthentication is a notification and when
1083 it is sent out the association at the transmitting station is terminated.
1085 @param[in] This Pointer to the EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
1087 @param[in] Data Pointer to the deauthentication token.
1089 @retval EFI_SUCCESS The operation completed successfully.
1090 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
1094 @retval EFI_ALREADY_STARTED The deauthentication process is already started.
1095 @retval EFI_NOT_READY The deauthentication service is invoked to a
1096 nonexistent association or authentication relationship.
1097 @retval EFI_NOT_FOUND The specified peer MAC entity is not found.
1098 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
1102 (EFIAPI
*EFI_WIRELESS_MAC_CONNECTION_DEAUTHENTICATE
)(
1103 IN EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
*This
,
1104 IN EFI_80211_DEAUTHENTICATE_DATA_TOKEN
*Data
1108 /// The EFI_WIRELESS_MAC_CONNECTION_PROTOCOL is designed to provide management service
1109 /// interfaces for the EFI wireless network stack to establish wireless connection with
1110 /// AP. An EFI Wireless MAC Connection Protocol instance will be installed on each
1111 /// communication device that the EFI wireless network stack runs on.
1113 struct _EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
{
1114 EFI_WIRELESS_MAC_CONNECTION_SCAN Scan
;
1115 EFI_WIRELESS_MAC_CONNECTION_ASSOCIATE Associate
;
1116 EFI_WIRELESS_MAC_CONNECTION_DISASSOCIATE Disassociate
;
1117 EFI_WIRELESS_MAC_CONNECTION_AUTHENTICATE Authenticate
;
1118 EFI_WIRELESS_MAC_CONNECTION_DEAUTHENTICATE Deauthenticate
;
1121 extern EFI_GUID gEfiWiFiProtocolGuid
;