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 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 @par Revision Reference:
16 This Protocol is introduced in UEFI Specification 2.5
20 #ifndef __EFI_WIFI_PROTOCOL_H__
21 #define __EFI_WIFI_PROTOCOL_H__
23 #include <Protocol/WiFi2.h>
25 #define EFI_WIRELESS_MAC_CONNECTION_PROTOCOL_GUID \
27 0xda55bc9, 0x45f8, 0x4bb4, {0x87, 0x19, 0x52, 0x24, 0xf1, 0x8a, 0x4d, 0x45 } \
30 typedef struct _EFI_WIRELESS_MAC_CONNECTION_PROTOCOL EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
;
33 /// EFI_80211_ACC_NET_TYPE
37 IeeePrivatewithGuest
= 1,
38 IeeeChargeablePublic
= 2,
41 IeeeEmergencyServOnly
= 5,
44 } EFI_80211_ACC_NET_TYPE
;
47 /// EFI_80211_ASSOCIATE_RESULT_CODE
51 AssociateRefusedReasonUnspecified
,
52 AssociateRefusedCapsMismatch
,
53 AssociateRefusedExtReason
,
54 AssociateRefusedAPOutOfMemory
,
55 AssociateRefusedBasicRatesMismatch
,
56 AssociateRejectedEmergencyServicesNotSupported
,
57 AssociateRefusedTemporarily
58 } EFI_80211_ASSOCIATE_RESULT_CODE
;
61 /// EFI_80211_SCAN_RESULT_CODE
65 /// The scan operation finished successfully.
69 /// The scan operation is not supported in current implementation.
72 } EFI_80211_SCAN_RESULT_CODE
;
75 /// EFI_80211_REASON_CODE
78 Ieee80211UnspecifiedReason
= 1,
79 Ieee80211PreviousAuthenticateInvalid
= 2,
80 Ieee80211DeauthenticatedSinceLeaving
= 3,
81 Ieee80211DisassociatedDueToInactive
= 4,
82 Ieee80211DisassociatedSinceApUnable
= 5,
83 Ieee80211Class2FrameNonauthenticated
= 6,
84 Ieee80211Class3FrameNonassociated
= 7,
85 Ieee80211DisassociatedSinceLeaving
= 8,
87 } EFI_80211_REASON_CODE
;
90 /// EFI_80211_DISASSOCIATE_RESULT_CODE
94 /// Disassociation process completed successfully.
98 /// Disassociation failed due to any input parameter is invalid.
100 DisassociateInvalidParameters
101 } EFI_80211_DISASSOCIATE_RESULT_CODE
;
104 /// EFI_80211_AUTHENTICATION_TYPE
108 /// Open system authentication, admits any STA to the DS.
112 /// Shared Key authentication relies on WEP to demonstrate knowledge of a WEP
117 /// FT authentication relies on keys derived during the initial mobility domain
118 /// association to authenticate the stations.
122 /// SAE authentication uses finite field cryptography to prove knowledge of a shared
126 } EFI_80211_AUTHENTICATION_TYPE
;
129 /// EFI_80211_AUTHENTICATION_RESULT_CODE
134 AuthenticateAnticLoggingTokenRequired
,
135 AuthenticateFiniteCyclicGroupNotSupported
,
136 AuthenticationRejected
,
137 AuthenticateInvalidParameter
138 } EFI_80211_AUTHENTICATE_RESULT_CODE
;
141 /// EFI_80211_ELEMENT_HEADER
145 /// A unique element ID defined in IEEE 802.11 specification.
149 /// Specifies the number of octets in the element body.
152 } EFI_80211_ELEMENT_HEADER
;
155 /// EFI_80211_ELEMENT_REQ
159 /// Common header of an element.
161 EFI_80211_ELEMENT_HEADER Hdr
;
163 /// Start of elements that are requested to be included in the Probe Response frame.
164 /// The elements are listed in order of increasing element ID.
167 } EFI_80211_ELEMENT_REQ
;
170 /// EFI_80211_ELEMENT_SSID
174 /// Common header of an element.
176 EFI_80211_ELEMENT_HEADER Hdr
;
178 /// Service set identifier. If Hdr.Length is zero, this field is ignored.
181 } EFI_80211_ELEMENT_SSID
;
184 /// EFI_80211_SCAN_DATA
188 /// Determines whether infrastructure BSS, IBSS, MBSS, or all, are included in the
191 EFI_80211_BSS_TYPE BSSType
;
193 /// Indicates a specific or wildcard BSSID. Use all binary 1s to represent all SSIDs.
195 EFI_80211_MAC_ADDRESS BSSId
;
197 /// Length in bytes of the SSId. If zero, ignore SSId field.
201 /// Specifies the desired SSID or the wildcard SSID. Use NULL to represent all SSIDs.
205 /// Indicates passive scanning if TRUE.
209 /// The delay in microseconds to be used prior to transmitting a Probe frame during
210 /// active scanning. If zero, the value can be overridden by an
211 /// implementation-dependent default value.
215 /// Specifies a list of channels that are examined when scanning for a BSS. If set to
216 /// NULL, all valid channels will be scanned.
220 /// Indicates the minimum time in TU to spend on each channel when scanning. If zero,
221 /// the value can be overridden by an implementation-dependent default value.
223 UINT32 MinChannelTime
;
225 /// Indicates the maximum time in TU to spend on each channel when scanning. If zero,
226 /// the value can be overridden by an implementation-dependent default value.
228 UINT32 MaxChannelTime
;
230 /// Points to an optionally present element. This is an optional parameter and may be
233 EFI_80211_ELEMENT_REQ
*RequestInformation
;
235 /// Indicates one or more SSID elements that are optionally present. This is an
236 /// optional parameter and may be NULL.
238 EFI_80211_ELEMENT_SSID
*SSIDList
;
240 /// Specifies a desired specific access network type or the wildcard access network
241 /// type. Use 15 as wildcard access network type.
243 EFI_80211_ACC_NET_TYPE AccessNetworkType
;
245 /// Specifies zero or more elements. This is an optional parameter and may be NULL.
247 UINT8
*VendorSpecificInfo
;
248 } EFI_80211_SCAN_DATA
;
251 /// EFI_80211_COUNTRY_TRIPLET_SUBBAND
255 /// Indicates the lowest channel number in the subband. It has a positive integer
256 /// value less than 201.
258 UINT8 FirstChannelNum
;
260 /// Indicates the number of channels in the subband.
264 /// Indicates the maximum power in dBm allowed to be transmitted.
266 UINT8 MaxTxPowerLevel
;
267 } EFI_80211_COUNTRY_TRIPLET_SUBBAND
;
270 /// EFI_80211_COUNTRY_TRIPLET_OPERATE
274 /// Indicates the operating extension identifier. It has a positive integer value of
277 UINT8 OperatingExtId
;
279 /// Index into a set of values for radio equipment set of rules.
281 UINT8 OperatingClass
;
283 /// Specifies aAirPropagationTime characteristics used in BSS operation. Refer the
284 /// definition of aAirPropagationTime in IEEE 802.11 specification.
287 } EFI_80211_COUNTRY_TRIPLET_OPERATE
;
290 /// EFI_80211_COUNTRY_TRIPLET
294 /// The subband triplet.
296 EFI_80211_COUNTRY_TRIPLET_SUBBAND Subband
;
298 /// The operating triplet.
300 EFI_80211_COUNTRY_TRIPLET_OPERATE Operating
;
301 } EFI_80211_COUNTRY_TRIPLET
;
304 /// EFI_80211_ELEMENT_COUNTRY
308 /// Common header of an element.
310 EFI_80211_ELEMENT_HEADER Hdr
;
312 /// Specifies country strings in 3 octets.
316 /// Indicates a triplet that repeated in country element. The number of triplets is
317 /// determined by the Hdr.Length field.
319 EFI_80211_COUNTRY_TRIPLET CountryTriplet
[1];
320 } EFI_80211_ELEMENT_COUNTRY
;
323 /// EFI_80211_ELEMENT_DATA_RSN
327 /// Indicates the version number of the RSNA protocol. Value 1 is defined in current
328 /// IEEE 802.11 specification.
332 /// Specifies the cipher suite selector used by the BSS to protect group address frames.
334 UINT32 GroupDataCipherSuite
;
336 /// Indicates the number of pairwise cipher suite selectors that are contained in
337 /// PairwiseCipherSuiteList.
339 //UINT16 PairwiseCipherSuiteCount;
341 /// Contains a series of cipher suite selectors that indicate the pairwise cipher
342 /// suites contained in this element.
344 //UINT32 PairwiseCipherSuiteList[PairwiseCipherSuiteCount];
346 /// Indicates the number of AKM suite selectors that are contained in AKMSuiteList.
348 //UINT16 AKMSuiteCount;
350 /// Contains a series of AKM suite selectors that indicate the AKM suites contained in
353 //UINT32 AKMSuiteList[AKMSuiteCount];
355 /// Indicates requested or advertised capabilities.
357 //UINT16 RSNCapabilities;
359 /// Indicates the number of PKMIDs in the PMKIDList.
363 /// Contains zero or more PKMIDs that the STA believes to be valid for the destination
365 //UINT8 PMKIDList[PMKIDCount][16];
367 /// Specifies the cipher suite selector used by the BSS to protect group addressed
368 /// robust management frames.
370 //UINT32 GroupManagementCipherSuite;
371 } EFI_80211_ELEMENT_DATA_RSN
;
374 /// EFI_80211_ELEMENT_RSN
378 /// Common header of an element.
380 EFI_80211_ELEMENT_HEADER Hdr
;
382 /// Points to RSN element. The size of a RSN element is limited to 255 octets.
384 EFI_80211_ELEMENT_DATA_RSN
*Data
;
385 } EFI_80211_ELEMENT_RSN
;
388 /// EFI_80211_ELEMENT_EXT_CAP
392 /// Common header of an element.
394 EFI_80211_ELEMENT_HEADER Hdr
;
396 /// Indicates the capabilities being advertised by the STA transmitting the element.
397 /// This is a bit field with variable length. Refer to IEEE 802.11 specification for
400 UINT8 Capabilities
[1];
401 } EFI_80211_ELEMENT_EXT_CAP
;
404 /// EFI_80211_BSS_DESCRIPTION
408 /// Indicates a specific BSSID of the found BSS.
410 EFI_80211_MAC_ADDRESS BSSId
;
412 /// Specifies the SSID of the found BSS. If NULL, ignore SSIdLen field.
416 /// Specifies the SSID of the found BSS. If NULL, ignore SSIdLen field.
420 /// Specifies the type of the found BSS.
422 EFI_80211_BSS_TYPE BSSType
;
424 /// The beacon period in TU of the found BSS.
428 /// The timestamp of the received frame from the found BSS.
432 /// The advertised capabilities of the BSS.
434 UINT16 CapabilityInfo
;
436 /// The set of data rates that shall be supported by all STAs that desire to join this
439 UINT8
*BSSBasicRateSet
;
441 /// The set of data rates that the peer STA desires to use for communication within
444 UINT8
*OperationalRateSet
;
446 /// The information required to identify the regulatory domain in which the peer STA
449 EFI_80211_ELEMENT_COUNTRY
*Country
;
451 /// The cipher suites and AKM suites supported in the BSS.
453 EFI_80211_ELEMENT_RSN RSN
;
455 /// Specifies the RSSI of the received frame.
459 /// Specifies the RCPI of the received frame.
461 UINT8 RCPIMeasurement
;
463 /// Specifies the RSNI of the received frame.
465 UINT8 RSNIMeasurement
;
467 /// Specifies the elements requested by the request element of the Probe Request frame.
468 /// This is an optional parameter and may be NULL.
470 UINT8
*RequestedElements
;
472 /// Specifies the BSS membership selectors that represent the set of features that
473 /// shall be supported by all STAs to join this BSS.
475 UINT8
*BSSMembershipSelectorSet
;
477 /// Specifies the parameters within the Extended Capabilities element that are
478 /// supported by the MAC entity. This is an optional parameter and may be NULL.
480 EFI_80211_ELEMENT_EXT_CAP
*ExtCapElement
;
481 } EFI_80211_BSS_DESCRIPTION
;
484 /// EFI_80211_SUBELEMENT_INFO
488 /// Indicates the unique identifier within the containing element or sub-element.
492 /// Specifies the number of octets in the Data field.
496 /// A variable length data buffer.
499 } EFI_80211_SUBELEMENT_INFO
;
502 /// EFI_80211_MULTIPLE_BSSID
506 /// Common header of an element.
508 EFI_80211_ELEMENT_HEADER Hdr
;
510 /// Indicates the maximum number of BSSIDs in the multiple BSSID set. When Indicator
511 /// is set to n, 2n is the maximum number.
515 /// Contains zero or more sub-elements.
517 EFI_80211_SUBELEMENT_INFO SubElement
[1];
518 } EFI_80211_MULTIPLE_BSSID
;
521 /// EFI_80211_BSS_DESP_PILOT
525 /// Indicates a specific BSSID of the found BSS.
527 EFI_80211_MAC_ADDRESS BSSId
;
529 /// Specifies the type of the found BSS.
531 EFI_80211_BSS_TYPE BSSType
;
533 /// One octet field to report condensed capability information.
537 /// Two octet's field to report condensed country string.
539 UINT8 ConCountryStr
[2];
541 /// Indicates the operating class value for the operating channel.
543 UINT8 OperatingClass
;
545 /// Indicates the operating channel.
549 /// Indicates the measurement pilot interval in TU.
553 /// Indicates that the BSS is within a multiple BSSID set.
555 EFI_80211_MULTIPLE_BSSID
*MultipleBSSID
;
557 /// Specifies the RCPI of the received frame.
559 UINT8 RCPIMeasurement
;
561 /// Specifies the RSNI of the received frame.
563 UINT8 RSNIMeasurement
;
564 } EFI_80211_BSS_DESP_PILOT
;
567 /// EFI_80211_SCAN_RESULT
571 /// The number of EFI_80211_BSS_DESCRIPTION in BSSDespSet. If zero, BSSDespSet should
576 /// Points to zero or more instances of EFI_80211_BSS_DESCRIPTION.
578 EFI_80211_BSS_DESCRIPTION
**BSSDespSet
;
580 /// The number of EFI_80211_BSS_DESP_PILOT in BSSDespFromPilotSet. If zero,
581 /// BSSDespFromPilotSet should be ignored.
583 UINTN NumofBSSDespFromPilot
;
585 /// Points to zero or more instances of EFI_80211_BSS_DESP_PILOT.
587 EFI_80211_BSS_DESP_PILOT
**BSSDespFromPilotSet
;
589 /// Specifies zero or more elements. This is an optional parameter and may be NULL.
591 UINT8
*VendorSpecificInfo
;
592 } EFI_80211_SCAN_RESULT
;
595 /// EFI_80211_SCAN_DATA_TOKEN
599 /// This Event will be signaled after the Status field is updated by the EFI Wireless
600 /// MAC Connection Protocol driver. The type of Event must be EFI_NOTIFY_SIGNAL.
604 /// Will be set to one of the following values:
605 /// EFI_SUCCESS: Scan operation completed successfully.
606 /// EFI_NOT_FOUND: Failed to find available BSS.
607 /// EFI_DEVICE_ERROR: An unexpected network or system error occurred.
608 /// EFI_ACCESS_DENIED: The scan operation is not completed due to some underlying
609 /// hardware or software state.
610 /// EFI_NOT_READY: The scan operation is started but not yet completed.
613 /// Pointer to the scan data.
615 EFI_80211_SCAN_DATA
*Data
;
617 /// Indicates the scan state.
619 EFI_80211_SCAN_RESULT_CODE ResultCode
;
621 /// Indicates the scan result. It is caller's responsibility to free this buffer.
623 EFI_80211_SCAN_RESULT
*Result
;
624 } EFI_80211_SCAN_DATA_TOKEN
;
627 /// EFI_80211_ELEMENT_SUPP_CHANNEL_TUPLE
631 /// The first channel number in a subband of supported channels.
633 UINT8 FirstChannelNumber
;
635 /// The number of channels in a subband of supported channels.
637 UINT8 NumberOfChannels
;
638 } EFI_80211_ELEMENT_SUPP_CHANNEL_TUPLE
;
641 /// EFI_80211_ELEMENT_SUPP_CHANNEL
645 /// Common header of an element.
647 EFI_80211_ELEMENT_HEADER Hdr
;
649 /// Indicates one or more tuples of (first channel, number of channels).
651 EFI_80211_ELEMENT_SUPP_CHANNEL_TUPLE Subband
[1];
652 } EFI_80211_ELEMENT_SUPP_CHANNEL
;
655 /// EFI_80211_ASSOCIATE_DATA
659 /// Specifies the address of the peer MAC entity to associate with.
661 EFI_80211_MAC_ADDRESS BSSId
;
663 /// Specifies the requested operational capabilities to the AP in 2 octets.
665 UINT16 CapabilityInfo
;
667 /// Specifies a time limit in TU, after which the associate procedure is terminated.
669 UINT32 FailureTimeout
;
671 /// Specifies if in power save mode, how often the STA awakes and listens for the next
672 /// beacon frame in TU.
674 UINT32 ListenInterval
;
676 /// Indicates a list of channels in which the STA is capable of operating.
678 EFI_80211_ELEMENT_SUPP_CHANNEL
*Channels
;
680 /// The cipher suites and AKM suites selected by the STA.
682 EFI_80211_ELEMENT_RSN RSN
;
684 /// Specifies the parameters within the Extended Capabilities element that are
685 /// supported by the MAC entity. This is an optional parameter and may be NULL.
687 EFI_80211_ELEMENT_EXT_CAP
*ExtCapElement
;
689 /// Specifies zero or more elements. This is an optional parameter and may be NULL.
691 UINT8
*VendorSpecificInfo
;
692 } EFI_80211_ASSOCIATE_DATA
;
695 /// EFI_80211_ELEMENT_TIMEOUT_VAL
699 /// Common header of an element.
701 EFI_80211_ELEMENT_HEADER Hdr
;
703 /// Specifies the timeout interval type.
707 /// Specifies the timeout interval value.
710 } EFI_80211_ELEMENT_TIMEOUT_VAL
;
713 /// EFI_80211_ASSOCIATE_RESULT
717 /// Specifies the address of the peer MAC entity from which the association request
720 EFI_80211_MAC_ADDRESS BSSId
;
722 /// Specifies the operational capabilities advertised by the AP.
724 UINT16 CapabilityInfo
;
726 /// Specifies the association ID value assigned by the AP.
728 UINT16 AssociationID
;
730 /// Indicates the measured RCPI of the corresponding association request frame. It is
731 /// an optional parameter and is set to zero if unavailable.
735 /// Indicates the measured RSNI at the time the corresponding association request
736 /// frame was received. It is an optional parameter and is set to zero if unavailable.
740 /// Specifies the parameters within the Extended Capabilities element that are
741 /// supported by the MAC entity. This is an optional parameter and may be NULL.
743 EFI_80211_ELEMENT_EXT_CAP
*ExtCapElement
;
745 /// Specifies the timeout interval when the result code is AssociateRefusedTemporarily.
747 EFI_80211_ELEMENT_TIMEOUT_VAL TimeoutInterval
;
749 /// Specifies zero or more elements. This is an optional parameter and may be NULL.
751 UINT8
*VendorSpecificInfo
;
752 } EFI_80211_ASSOCIATE_RESULT
;
755 /// EFI_80211_ASSOCIATE_DATA_TOKEN
759 /// This Event will be signaled after the Status field is updated by the EFI Wireless
760 /// MAC Connection Protocol driver. The type of Event must be EFI_NOTIFY_SIGNAL.
764 /// Will be set to one of the following values:
765 /// EFI_SUCCESS: Association operation completed successfully.
766 /// EFI_DEVICE_ERROR: An unexpected network or system error occurred.
770 /// Pointer to the association data.
772 EFI_80211_ASSOCIATE_DATA
*Data
;
774 /// Indicates the association state.
776 EFI_80211_ASSOCIATE_RESULT_CODE ResultCode
;
778 /// Indicates the association result. It is caller's responsibility to free this
781 EFI_80211_ASSOCIATE_RESULT
*Result
;
782 } EFI_80211_ASSOCIATE_DATA_TOKEN
;
785 /// EFI_80211_DISASSOCIATE_DATA
789 /// Specifies the address of the peer MAC entity with which to perform the
790 /// disassociation process.
792 EFI_80211_MAC_ADDRESS BSSId
;
794 /// Specifies the reason for initiating the disassociation process.
796 EFI_80211_REASON_CODE ReasonCode
;
798 /// Zero or more elements, may be NULL.
800 UINT8
*VendorSpecificInfo
;
801 } EFI_80211_DISASSOCIATE_DATA
;
804 /// EFI_80211_DISASSOCIATE_DATA_TOKEN
808 /// This Event will be signaled after the Status field is updated by the EFI Wireless
809 /// MAC Connection Protocol driver. The type of Event must be EFI_NOTIFY_SIGNAL.
813 /// Will be set to one of the following values:
814 /// EFI_SUCCESS: Disassociation operation completed successfully.
815 /// EFI_DEVICE_ERROR: An unexpected network or system error occurred.
816 /// EFI_ACCESS_DENIED: The disassociation operation is not completed due to some
817 /// underlying hardware or software state.
818 /// EFI_NOT_READY: The disassociation operation is started but not yet completed.
822 /// Pointer to the disassociation data.
824 EFI_80211_DISASSOCIATE_DATA
*Data
;
826 /// Indicates the disassociation state.
828 EFI_80211_DISASSOCIATE_RESULT_CODE ResultCode
;
829 } EFI_80211_DISASSOCIATE_DATA_TOKEN
;
832 /// EFI_80211_AUTHENTICATION_DATA
836 /// Specifies the address of the peer MAC entity with which to perform the
837 /// authentication process.
839 EFI_80211_MAC_ADDRESS BSSId
;
841 /// Specifies the type of authentication algorithm to use during the authentication
844 EFI_80211_AUTHENTICATION_TYPE AuthType
;
846 /// Specifies a time limit in TU after which the authentication procedure is
849 UINT32 FailureTimeout
;
851 /// Specifies the set of elements to be included in the first message of the FT
852 /// authentication sequence, may be NULL.
856 /// Specifies the set of elements to be included in the SAE Commit Message or SAE
857 /// Confirm Message, may be NULL.
861 /// Zero or more elements, may be NULL.
863 UINT8
*VendorSpecificInfo
;
864 } EFI_80211_AUTHENTICATE_DATA
;
867 /// EFI_80211_AUTHENTICATION_RESULT
871 /// Specifies the address of the peer MAC entity from which the authentication request
874 EFI_80211_MAC_ADDRESS BSSId
;
876 /// Specifies the set of elements to be included in the second message of the FT
877 /// authentication sequence, may be NULL.
881 /// Specifies the set of elements to be included in the SAE Commit Message or SAE
882 /// Confirm Message, may be NULL.
886 /// Zero or more elements, may be NULL.
888 UINT8
*VendorSpecificInfo
;
889 } EFI_80211_AUTHENTICATE_RESULT
;
892 /// EFI_80211_AUTHENTICATE_DATA_TOKEN
896 /// This Event will be signaled after the Status field is updated by the EFI Wireless
897 /// MAC Connection Protocol driver. The type of Event must be EFI_NOTIFY_SIGNAL.
901 /// Will be set to one of the following values:
902 /// EFI_SUCCESS: Authentication operation completed successfully.
903 /// EFI_PROTOCOL_ERROR: Peer MAC entity rejects the authentication.
904 /// EFI_NO_RESPONSE: Peer MAC entity does not response the authentication request.
905 /// EFI_DEVICE_ERROR: An unexpected network or system error occurred.
906 /// EFI_ACCESS_DENIED: The authentication operation is not completed due to some
907 /// underlying hardware or software state.
908 /// EFI_NOT_READY: The authentication operation is started but not yet completed.
912 /// Pointer to the authentication data.
914 EFI_80211_AUTHENTICATE_DATA
*Data
;
916 /// Indicates the association state.
918 EFI_80211_AUTHENTICATE_RESULT_CODE ResultCode
;
920 /// Indicates the association result. It is caller's responsibility to free this
923 EFI_80211_AUTHENTICATE_RESULT
*Result
;
924 } EFI_80211_AUTHENTICATE_DATA_TOKEN
;
927 /// EFI_80211_DEAUTHENTICATE_DATA
931 /// Specifies the address of the peer MAC entity with which to perform the
932 /// deauthentication process.
934 EFI_80211_MAC_ADDRESS BSSId
;
936 /// Specifies the reason for initiating the deauthentication process.
938 EFI_80211_REASON_CODE ReasonCode
;
940 /// Zero or more elements, may be NULL.
942 UINT8
*VendorSpecificInfo
;
943 } EFI_80211_DEAUTHENTICATE_DATA
;
946 /// EFI_80211_DEAUTHENTICATE_DATA_TOKEN
950 /// This Event will be signaled after the Status field is updated by the EFI Wireless
951 /// MAC Connection Protocol driver. The type of Event must be EFI_NOTIFY_SIGNAL.
955 /// Will be set to one of the following values:
956 /// EFI_SUCCESS: Deauthentication operation completed successfully.
957 /// EFI_DEVICE_ERROR: An unexpected network or system error occurred.
958 /// EFI_ACCESS_DENIED: The deauthentication operation is not completed due to some
959 /// underlying hardware or software state.
960 /// EFI_NOT_READY: The deauthentication operation is started but not yet
965 /// Pointer to the deauthentication data.
967 EFI_80211_DEAUTHENTICATE_DATA
*Data
;
968 } EFI_80211_DEAUTHENTICATE_DATA_TOKEN
;
971 Request a survey of potential BSSs that administrator can later elect to try to join.
973 The Scan() function returns the description of the set of BSSs detected by the scan
974 process. Passive scan operation is performed by default.
976 @param[in] This Pointer to the EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
978 @param[in] Data Pointer to the scan token.
980 @retval EFI_SUCCESS The operation completed successfully.
981 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
985 @retval EFI_UNSUPPORTED One or more of the input parameters are not supported
986 by this implementation.
987 @retval EFI_ALREADY_STARTED The scan operation is already started.
991 (EFIAPI
*EFI_WIRELESS_MAC_CONNECTION_SCAN
)(
992 IN EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
*This
,
993 IN EFI_80211_SCAN_DATA_TOKEN
*Data
997 Request an association with a specified peer MAC entity that is within an AP.
999 The Associate() function provides the capability for MAC layer to become associated
1002 @param[in] This Pointer to the EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
1004 @param[in] Data Pointer to the association token.
1006 @retval EFI_SUCCESS The operation completed successfully.
1007 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
1011 @retval EFI_UNSUPPORTED One or more of the input parameters are not supported
1012 by this implementation.
1013 @retval EFI_ALREADY_STARTED The association process is already started.
1014 @retval EFI_NOT_READY Authentication is not performed before this association
1016 @retval EFI_NOT_FOUND The specified peer MAC entity is not found.
1017 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
1021 (EFIAPI
*EFI_WIRELESS_MAC_CONNECTION_ASSOCIATE
)(
1022 IN EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
*This
,
1023 IN EFI_80211_ASSOCIATE_DATA_TOKEN
*Data
1027 Request a disassociation with a specified peer MAC entity.
1029 The Disassociate() function is invoked to terminate an existing association.
1030 Disassociation is a notification and cannot be refused by the receiving peer except
1031 when management frame protection is negotiated and the message integrity check fails.
1033 @param[in] This Pointer to the EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
1035 @param[in] Data Pointer to the disassociation token.
1037 @retval EFI_SUCCESS The operation completed successfully.
1038 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
1041 @retval EFI_ALREADY_STARTED The disassociation process is already started.
1042 @retval EFI_NOT_READY The disassociation service is invoked to a
1043 nonexistent association relationship.
1044 @retval EFI_NOT_FOUND The specified peer MAC entity is not found.
1045 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
1049 (EFIAPI
*EFI_WIRELESS_MAC_CONNECTION_DISASSOCIATE
)(
1050 IN EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
*This
,
1051 IN EFI_80211_DISASSOCIATE_DATA_TOKEN
*Data
1055 Request the process of establishing an authentication relationship with a peer MAC
1058 The Authenticate() function requests authentication with a specified peer MAC entity.
1059 This service might be time-consuming thus is designed to be invoked independently of
1060 the association service.
1062 @param[in] This Pointer to the EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
1064 @param[in] Data Pointer to the authentication token.
1066 @retval EFI_SUCCESS The operation completed successfully.
1067 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
1071 @retval EFI_UNSUPPORTED One or more of the input parameters are not supported
1072 by this implementation.
1073 @retval EFI_ALREADY_STARTED The authentication process is already started.
1074 @retval EFI_NOT_FOUND The specified peer MAC entity is not found.
1075 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
1079 (EFIAPI
*EFI_WIRELESS_MAC_CONNECTION_AUTHENTICATE
)(
1080 IN EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
*This
,
1081 IN EFI_80211_AUTHENTICATE_DATA_TOKEN
*Data
1085 Invalidate the authentication relationship with a peer MAC entity.
1087 The Deauthenticate() function requests that the authentication relationship with a
1088 specified peer MAC entity be invalidated. Deauthentication is a notification and when
1089 it is sent out the association at the transmitting station is terminated.
1091 @param[in] This Pointer to the EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
1093 @param[in] Data Pointer to the deauthentication token.
1095 @retval EFI_SUCCESS The operation completed successfully.
1096 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
1100 @retval EFI_ALREADY_STARTED The deauthentication process is already started.
1101 @retval EFI_NOT_READY The deauthentication service is invoked to a
1102 nonexistent association or authentication relationship.
1103 @retval EFI_NOT_FOUND The specified peer MAC entity is not found.
1104 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
1108 (EFIAPI
*EFI_WIRELESS_MAC_CONNECTION_DEAUTHENTICATE
)(
1109 IN EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
*This
,
1110 IN EFI_80211_DEAUTHENTICATE_DATA_TOKEN
*Data
1114 /// The EFI_WIRELESS_MAC_CONNECTION_PROTOCOL is designed to provide management service
1115 /// interfaces for the EFI wireless network stack to establish wireless connection with
1116 /// AP. An EFI Wireless MAC Connection Protocol instance will be installed on each
1117 /// communication device that the EFI wireless network stack runs on.
1119 struct _EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
{
1120 EFI_WIRELESS_MAC_CONNECTION_SCAN Scan
;
1121 EFI_WIRELESS_MAC_CONNECTION_ASSOCIATE Associate
;
1122 EFI_WIRELESS_MAC_CONNECTION_DISASSOCIATE Disassociate
;
1123 EFI_WIRELESS_MAC_CONNECTION_AUTHENTICATE Authenticate
;
1124 EFI_WIRELESS_MAC_CONNECTION_DEAUTHENTICATE Deauthenticate
;
1127 extern EFI_GUID gEfiWiFiProtocolGuid
;