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, 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 #define EFI_WIRELESS_MAC_CONNECTION_PROTOCOL_GUID \
25 0xda55bc9, 0x45f8, 0x4bb4, {0x87, 0x19, 0x52, 0x24, 0xf1, 0x8a, 0x4d, 0x45 } \
28 typedef struct _EFI_WIRELESS_MAC_CONNECTION_PROTOCOL EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
;
31 /// EFI_80211_BSS_TYPE
34 IeeeInfrastructureBSS
,
41 /// EFI_80211_ACC_NET_TYPE
45 IeeePrivatewithGuest
= 1,
46 IeeeChargeablePublic
= 2,
49 IeeeEmergencyServOnly
= 5,
52 } EFI_80211_ACC_NET_TYPE
;
55 /// EFI_80211_ASSOCIATE_RESULT_CODE
59 AssociateRefusedReasonUnspecified
,
60 AssociateRefusedCapsMismatch
,
61 AssociateRefusedExtReason
,
62 AssociateRefusedAPOutOfMemory
,
63 AssociateRefusedBasicRatesMismatch
,
64 AssociateRejectedEmergencyServicesNotSupported
,
65 AssociateRefusedTemporarily
66 } EFI_80211_ASSOCIATE_RESULT_CODE
;
69 /// EFI_80211_SCAN_RESULT_CODE
73 /// The scan operation finished successfully.
77 /// The scan operation is not supported in current implementation.
80 } EFI_80211_SCAN_RESULT_CODE
;
83 /// EFI_80211_REASON_CODE
86 Ieee80211UnspecifiedReason
= 1,
87 Ieee80211PreviousAuthenticateInvalid
= 2,
88 Ieee80211DeauthenticatedSinceLeaving
= 3,
89 Ieee80211DisassociatedDueToInactive
= 4,
90 Ieee80211DisassociatedSinceApUnable
= 5,
91 Ieee80211Class2FrameNonauthenticated
= 6,
92 Ieee80211Class3FrameNonassociated
= 7,
93 Ieee80211DisassociatedSinceLeaving
= 8,
95 } EFI_80211_REASON_CODE
;
98 /// EFI_80211_DISASSOCIATE_RESULT_CODE
102 /// Disassociation process completed successfully.
106 /// Disassociation failed due to any input parameter is invalid.
108 DisassociateInvalidParameters
109 } EFI_80211_DISASSOCIATE_RESULT_CODE
;
112 /// EFI_80211_AUTHENTICATION_TYPE
116 /// Open system authentication, admits any STA to the DS.
120 /// Shared Key authentication relies on WEP to demonstrate knowledge of a WEP
125 /// FT authentication relies on keys derived during the initial mobility domain
126 /// association to authenticate the stations.
130 /// SAE authentication uses finite field cryptography to prove knowledge of a shared
134 } EFI_80211_AUTHENTICATION_TYPE
;
137 /// EFI_80211_AUTHENTICATION_RESULT_CODE
142 AuthenticateAnticLoggingTokenRequired
,
143 AuthenticateFiniteCyclicGroupNotSupported
,
144 AuthenticationRejected
,
145 AuthenticateInvalidParameter
146 } EFI_80211_AUTHENTICATE_RESULT_CODE
;
149 /// EFI_80211_MAC_ADDRESS
153 } EFI_80211_MAC_ADDRESS
;
156 /// EFI_80211_ELEMENT_HEADER
160 /// A unique element ID defined in IEEE 802.11 specification.
164 /// Specifies the number of octets in the element body.
167 } EFI_80211_ELEMENT_HEADER
;
170 /// EFI_80211_ELEMENT_REQ
174 /// Common header of an element.
176 EFI_80211_ELEMENT_HEADER Hdr
;
178 /// Start of elements that are requested to be included in the Probe Response frame.
179 /// The elements are listed in order of increasing element ID.
182 } EFI_80211_ELEMENT_REQ
;
185 /// EFI_80211_ELEMENT_SSID
189 /// Common header of an element.
191 EFI_80211_ELEMENT_HEADER Hdr
;
193 /// Service set identifier. If Hdr.Length is zero, this field is ignored.
196 } EFI_80211_ELEMENT_SSID
;
199 /// EFI_80211_SCAN_DATA
203 /// Determines whether infrastructure BSS, IBSS, MBSS, or all, are included in the
206 EFI_80211_BSS_TYPE BSSType
;
208 /// Indicates a specific or wildcard BSSID. Use all binary 1s to represent all SSIDs.
210 EFI_80211_MAC_ADDRESS BSSId
;
212 /// Length in bytes of the SSId. If zero, ignore SSId field.
216 /// Specifies the desired SSID or the wildcard SSID. Use NULL to represent all SSIDs.
220 /// Indicates passive scanning if TRUE.
224 /// The delay in microseconds to be used prior to transmitting a Probe frame during
225 /// active scanning. If zero, the value can be overridden by an
226 /// implementation-dependent default value.
230 /// Specifies a list of channels that are examined when scanning for a BSS. If set to
231 /// NULL, all valid channels will be scanned.
235 /// Indicates the minimum time in TU to spend on each channel when scanning. If zero,
236 /// the value can be overridden by an implementation-dependent default value.
238 UINT32 MinChannelTime
;
240 /// Indicates the maximum time in TU to spend on each channel when scanning. If zero,
241 /// the value can be overridden by an implementation-dependent default value.
243 UINT32 MaxChannelTime
;
245 /// Points to an optionally present element. This is an optional parameter and may be
248 EFI_80211_ELEMENT_REQ
*RequestInformation
;
250 /// Indicates one or more SSID elements that are optionally present. This is an
251 /// optional parameter and may be NULL.
253 EFI_80211_ELEMENT_SSID
*SSIDList
;
255 /// Specifies a desired specific access network type or the wildcard access network
256 /// type. Use 15 as wildcard access network type.
258 EFI_80211_ACC_NET_TYPE AccessNetworkType
;
260 /// Specifies zero or more elements. This is an optional parameter and may be NULL.
262 UINT8
*VendorSpecificInfo
;
263 } EFI_80211_SCAN_DATA
;
266 /// EFI_80211_COUNTRY_TRIPLET_SUBBAND
270 /// Indicates the lowest channel number in the subband. It has a positive integer
271 /// value less than 201.
273 UINT8 FirstChannelNum
;
275 /// Indicates the number of channels in the subband.
279 /// Indicates the maximum power in dBm allowed to be transmitted.
281 UINT8 MaxTxPowerLevel
;
282 } EFI_80211_COUNTRY_TRIPLET_SUBBAND
;
285 /// EFI_80211_COUNTRY_TRIPLET_OPERATE
289 /// Indicates the operating extension identifier. It has a positive integer value of
292 UINT8 OperatingExtId
;
294 /// Index into a set of values for radio equipment set of rules.
296 UINT8 OperatingClass
;
298 /// Specifies aAirPropagationTime characteristics used in BSS operation. Refer the
299 /// definition of aAirPropagationTime in IEEE 802.11 specification.
302 } EFI_80211_COUNTRY_TRIPLET_OPERATE
;
305 /// EFI_80211_COUNTRY_TRIPLET
309 /// The subband triplet.
311 EFI_80211_COUNTRY_TRIPLET_SUBBAND Subband
;
313 /// The operating triplet.
315 EFI_80211_COUNTRY_TRIPLET_OPERATE Operating
;
316 } EFI_80211_COUNTRY_TRIPLET
;
319 /// EFI_80211_ELEMENT_COUNTRY
323 /// Common header of an element.
325 EFI_80211_ELEMENT_HEADER Hdr
;
327 /// Specifies country strings in 3 octets.
331 /// Indicates a triplet that repeated in country element. The number of triplets is
332 /// determined by the Hdr.Length field.
334 EFI_80211_COUNTRY_TRIPLET CountryTriplet
[1];
335 } EFI_80211_ELEMENT_COUNTRY
;
338 /// EFI_80211_ELEMENT_DATA_RSN
342 /// Indicates the version number of the RSNA protocol. Value 1 is defined in current
343 /// IEEE 802.11 specification.
347 /// Specifies the cipher suite selector used by the BSS to protect group address frames.
349 UINT32 GroupDataCipherSuite
;
351 /// Indicates the number of pairwise cipher suite selectors that are contained in
352 /// PairwiseCipherSuiteList.
354 //UINT16 PairwiseCipherSuiteCount;
356 /// Contains a series of cipher suite selectors that indicate the pairwise cipher
357 /// suites contained in this element.
359 //UINT32 PairwiseCipherSuiteList[PairwiseCipherSuiteCount];
361 /// Indicates the number of AKM suite selectors that are contained in AKMSuiteList.
363 //UINT16 AKMSuiteCount;
365 /// Contains a series of AKM suite selectors that indicate the AKM suites contained in
368 //UINT32 AKMSuiteList[AKMSuiteCount];
370 /// Indicates requested or advertised capabilities.
372 //UINT16 RSNCapabilities;
374 /// Indicates the number of PKMIDs in the PMKIDList.
378 /// Contains zero or more PKMIDs that the STA believes to be valid for the destination
380 //UINT8 PMKIDList[PMKIDCount][16];
382 /// Specifies the cipher suite selector used by the BSS to protect group addressed
383 /// robust management frames.
385 //UINT32 GroupManagementCipherSuite;
386 } EFI_80211_ELEMENT_DATA_RSN
;
389 /// EFI_80211_ELEMENT_RSN
393 /// Common header of an element.
395 EFI_80211_ELEMENT_HEADER Hdr
;
397 /// Points to RSN element. The size of a RSN element is limited to 255 octets.
399 EFI_80211_ELEMENT_DATA_RSN
*Data
;
400 } EFI_80211_ELEMENT_RSN
;
403 /// EFI_80211_ELEMENT_EXT_CAP
407 /// Common header of an element.
409 EFI_80211_ELEMENT_HEADER Hdr
;
411 /// Indicates the capabilities being advertised by the STA transmitting the element.
412 /// This is a bit field with variable length. Refer to IEEE 802.11 specification for
415 UINT8 Capabilities
[1];
416 } EFI_80211_ELEMENT_EXT_CAP
;
419 /// EFI_80211_BSS_DESCRIPTION
423 /// Indicates a specific BSSID of the found BSS.
425 EFI_80211_MAC_ADDRESS BSSId
;
427 /// Specifies the SSID of the found BSS. If NULL, ignore SSIdLen field.
431 /// Specifies the SSID of the found BSS. If NULL, ignore SSIdLen field.
435 /// Specifies the type of the found BSS.
437 EFI_80211_BSS_TYPE BSSType
;
439 /// The beacon period in TU of the found BSS.
443 /// The timestamp of the received frame from the found BSS.
447 /// The advertised capabilities of the BSS.
449 UINT16 CapabilityInfo
;
451 /// The set of data rates that shall be supported by all STAs that desire to join this
454 UINT8
*BSSBasicRateSet
;
456 /// The set of data rates that the peer STA desires to use for communication within
459 UINT8
*OperationalRateSet
;
461 /// The information required to identify the regulatory domain in which the peer STA
464 EFI_80211_ELEMENT_COUNTRY
*Country
;
466 /// The cipher suites and AKM suites supported in the BSS.
468 EFI_80211_ELEMENT_RSN RSN
;
470 /// Specifies the RSSI of the received frame.
474 /// Specifies the RCPI of the received frame.
476 UINT8 RCPIMeasurement
;
478 /// Specifies the RSNI of the received frame.
480 UINT8 RSNIMeasurement
;
482 /// Specifies the elements requested by the request element of the Probe Request frame.
483 /// This is an optional parameter and may be NULL.
485 UINT8
*RequestedElements
;
487 /// Specifies the BSS membership selectors that represent the set of features that
488 /// shall be supported by all STAs to join this BSS.
490 UINT8
*BSSMembershipSelectorSet
;
492 /// Specifies the parameters within the Extended Capabilities element that are
493 /// supported by the MAC entity. This is an optional parameter and may be NULL.
495 EFI_80211_ELEMENT_EXT_CAP
*ExtCapElement
;
496 } EFI_80211_BSS_DESCRIPTION
;
499 /// EFI_80211_SUBELEMENT_INFO
503 /// Indicates the unique identifier within the containing element or sub-element.
507 /// Specifies the number of octets in the Data field.
511 /// A variable length data buffer.
514 } EFI_80211_SUBELEMENT_INFO
;
517 /// EFI_80211_MULTIPLE_BSSID
521 /// Common header of an element.
523 EFI_80211_ELEMENT_HEADER Hdr
;
525 /// Indicates the maximum number of BSSIDs in the multiple BSSID set. When Indicator
526 /// is set to n, 2n is the maximum number.
530 /// Contains zero or more sub-elements.
532 EFI_80211_SUBELEMENT_INFO SubElement
[1];
533 } EFI_80211_MULTIPLE_BSSID
;
536 /// EFI_80211_BSS_DESP_PILOT
540 /// Indicates a specific BSSID of the found BSS.
542 EFI_80211_MAC_ADDRESS BSSId
;
544 /// Specifies the type of the found BSS.
546 EFI_80211_BSS_TYPE BSSType
;
548 /// One octet field to report condensed capability information.
552 /// Two octet's field to report condensed country string.
554 UINT8 ConCountryStr
[2];
556 /// Indicates the operating class value for the operating channel.
558 UINT8 OperatingClass
;
560 /// Indicates the operating channel.
564 /// Indicates the measurement pilot interval in TU.
568 /// Indicates that the BSS is within a multiple BSSID set.
570 EFI_80211_MULTIPLE_BSSID
*MultipleBSSID
;
572 /// Specifies the RCPI of the received frame.
574 UINT8 RCPIMeasurement
;
576 /// Specifies the RSNI of the received frame.
578 UINT8 RSNIMeasurement
;
579 } EFI_80211_BSS_DESP_PILOT
;
582 /// EFI_80211_SCAN_RESULT
586 /// The number of EFI_80211_BSS_DESCRIPTION in BSSDespSet. If zero, BSSDespSet should
591 /// Points to zero or more instances of EFI_80211_BSS_DESCRIPTION.
593 EFI_80211_BSS_DESCRIPTION
**BSSDespSet
;
595 /// The number of EFI_80211_BSS_DESP_PILOT in BSSDespFromPilotSet. If zero,
596 /// BSSDespFromPilotSet should be ignored.
598 UINTN NumofBSSDespFromPilot
;
600 /// Points to zero or more instances of EFI_80211_BSS_DESP_PILOT.
602 EFI_80211_BSS_DESP_PILOT
**BSSDespFromPilotSet
;
604 /// Specifies zero or more elements. This is an optional parameter and may be NULL.
606 UINT8
*VendorSpecificInfo
;
607 } EFI_80211_SCAN_RESULT
;
610 /// EFI_80211_SCAN_DATA_TOKEN
614 /// This Event will be signaled after the Status field is updated by the EFI Wireless
615 /// MAC Connection Protocol driver. The type of Event must be EFI_NOTIFY_SIGNAL.
619 /// Will be set to one of the following values:
620 /// EFI_SUCCESS: Scan operation completed successfully.
621 /// EFI_NOT_FOUND: Failed to find available BSS.
622 /// EFI_DEVICE_ERROR: An unexpected network or system error occurred.
623 /// EFI_ACCESS_DENIED: The scan operation is not completed due to some underlying
624 /// hardware or software state.
625 /// EFI_NOT_READY: The scan operation is started but not yet completed.
628 /// Pointer to the scan data.
630 EFI_80211_SCAN_DATA
*Data
;
632 /// Indicates the scan state.
634 EFI_80211_SCAN_RESULT_CODE ResultCode
;
636 /// Indicates the scan result. It is caller's responsibility to free this buffer.
638 EFI_80211_SCAN_RESULT
*Result
;
639 } EFI_80211_SCAN_DATA_TOKEN
;
642 /// EFI_80211_ELEMENT_SUPP_CHANNEL_TUPLE
646 /// The first channel number in a subband of supported channels.
648 UINT8 FirstChannelNumber
;
650 /// The number of channels in a subband of supported channels.
652 UINT8 NumberOfChannels
;
653 } EFI_80211_ELEMENT_SUPP_CHANNEL_TUPLE
;
656 /// EFI_80211_ELEMENT_SUPP_CHANNEL
660 /// Common header of an element.
662 EFI_80211_ELEMENT_HEADER Hdr
;
664 /// Indicates one or more tuples of (first channel, number of channels).
666 EFI_80211_ELEMENT_SUPP_CHANNEL_TUPLE Subband
[1];
667 } EFI_80211_ELEMENT_SUPP_CHANNEL
;
670 /// EFI_80211_ASSOCIATE_DATA
674 /// Specifies the address of the peer MAC entity to associate with.
676 EFI_80211_MAC_ADDRESS BSSId
;
678 /// Specifies the requested operational capabilities to the AP in 2 octets.
680 UINT16 CapabilityInfo
;
682 /// Specifies a time limit in TU, after which the associate procedure is terminated.
684 UINT32 FailureTimeout
;
686 /// Specifies if in power save mode, how often the STA awakes and listens for the next
687 /// beacon frame in TU.
689 UINT32 ListenInterval
;
691 /// Indicates a list of channels in which the STA is capable of operating.
693 EFI_80211_ELEMENT_SUPP_CHANNEL
*Channels
;
695 /// The cipher suites and AKM suites selected by the STA.
697 EFI_80211_ELEMENT_RSN RSN
;
699 /// Specifies the parameters within the Extended Capabilities element that are
700 /// supported by the MAC entity. This is an optional parameter and may be NULL.
702 EFI_80211_ELEMENT_EXT_CAP
*ExtCapElement
;
704 /// Specifies zero or more elements. This is an optional parameter and may be NULL.
706 UINT8
*VendorSpecificInfo
;
707 } EFI_80211_ASSOCIATE_DATA
;
710 /// EFI_80211_ELEMENT_TIMEOUT_VAL
714 /// Common header of an element.
716 EFI_80211_ELEMENT_HEADER Hdr
;
718 /// Specifies the timeout interval type.
722 /// Specifies the timeout interval value.
725 } EFI_80211_ELEMENT_TIMEOUT_VAL
;
728 /// EFI_80211_ASSOCIATE_RESULT
732 /// Specifies the address of the peer MAC entity from which the association request
735 EFI_80211_MAC_ADDRESS BSSId
;
737 /// Specifies the operational capabilities advertised by the AP.
739 UINT16 CapabilityInfo
;
741 /// Specifies the association ID value assigned by the AP.
743 UINT16 AssociationID
;
745 /// Indicates the measured RCPI of the corresponding association request frame. It is
746 /// an optional parameter and is set to zero if unavailable.
750 /// Indicates the measured RSNI at the time the corresponding association request
751 /// frame was received. It is an optional parameter and is set to zero if unavailable.
755 /// Specifies the parameters within the Extended Capabilities element that are
756 /// supported by the MAC entity. This is an optional parameter and may be NULL.
758 EFI_80211_ELEMENT_EXT_CAP
*ExtCapElement
;
760 /// Specifies the timeout interval when the result code is AssociateRefusedTemporarily.
762 EFI_80211_ELEMENT_TIMEOUT_VAL TimeoutInterval
;
764 /// Specifies zero or more elements. This is an optional parameter and may be NULL.
766 UINT8
*VendorSpecificInfo
;
767 } EFI_80211_ASSOCIATE_RESULT
;
770 /// EFI_80211_ASSOCIATE_DATA_TOKEN
774 /// This Event will be signaled after the Status field is updated by the EFI Wireless
775 /// MAC Connection Protocol driver. The type of Event must be EFI_NOTIFY_SIGNAL.
779 /// Will be set to one of the following values:
780 /// EFI_SUCCESS: Association operation completed successfully.
781 /// EFI_DEVICE_ERROR: An unexpected network or system error occurred.
785 /// Pointer to the association data.
787 EFI_80211_ASSOCIATE_DATA
*Data
;
789 /// Indicates the association state.
791 EFI_80211_ASSOCIATE_RESULT_CODE ResultCode
;
793 /// Indicates the association result. It is caller's responsibility to free this
796 EFI_80211_ASSOCIATE_RESULT
*Result
;
797 } EFI_80211_ASSOCIATE_DATA_TOKEN
;
800 /// EFI_80211_DISASSOCIATE_DATA
804 /// Specifies the address of the peer MAC entity with which to perform the
805 /// disassociation process.
807 EFI_80211_MAC_ADDRESS BSSId
;
809 /// Specifies the reason for initiating the disassociation process.
811 EFI_80211_REASON_CODE ReasonCode
;
813 /// Zero or more elements, may be NULL.
815 UINT8
*VendorSpecificInfo
;
816 } EFI_80211_DISASSOCIATE_DATA
;
819 /// EFI_80211_DISASSOCIATE_DATA_TOKEN
823 /// This Event will be signaled after the Status field is updated by the EFI Wireless
824 /// MAC Connection Protocol driver. The type of Event must be EFI_NOTIFY_SIGNAL.
828 /// Will be set to one of the following values:
829 /// EFI_SUCCESS: Disassociation operation completed successfully.
830 /// EFI_DEVICE_ERROR: An unexpected network or system error occurred.
831 /// EFI_ACCESS_DENIED: The disassociation operation is not completed due to some
832 /// underlying hardware or software state.
833 /// EFI_NOT_READY: The disassociation operation is started but not yet completed.
837 /// Pointer to the disassociation data.
839 EFI_80211_DISASSOCIATE_DATA
*Data
;
841 /// Indicates the disassociation state.
843 EFI_80211_DISASSOCIATE_RESULT_CODE ResultCode
;
844 } EFI_80211_DISASSOCIATE_DATA_TOKEN
;
847 /// EFI_80211_AUTHENTICATION_DATA
851 /// Specifies the address of the peer MAC entity with which to perform the
852 /// authentication process.
854 EFI_80211_MAC_ADDRESS BSSId
;
856 /// Specifies the type of authentication algorithm to use during the authentication
859 EFI_80211_AUTHENTICATION_TYPE AuthType
;
861 /// Specifies a time limit in TU after which the authentication procedure is
864 UINT32 FailureTimeout
;
866 /// Specifies the set of elements to be included in the first message of the FT
867 /// authentication sequence, may be NULL.
871 /// Specifies the set of elements to be included in the SAE Commit Message or SAE
872 /// Confirm Message, may be NULL.
876 /// Zero or more elements, may be NULL.
878 UINT8
*VendorSpecificInfo
;
879 } EFI_80211_AUTHENTICATE_DATA
;
882 /// EFI_80211_AUTHENTICATION_RESULT
886 /// Specifies the address of the peer MAC entity from which the authentication request
889 EFI_80211_MAC_ADDRESS BSSId
;
891 /// Specifies the set of elements to be included in the second message of the FT
892 /// authentication sequence, may be NULL.
896 /// Specifies the set of elements to be included in the SAE Commit Message or SAE
897 /// Confirm Message, may be NULL.
901 /// Zero or more elements, may be NULL.
903 UINT8
*VendorSpecificInfo
;
904 } EFI_80211_AUTHENTICATE_RESULT
;
907 /// EFI_80211_AUTHENTICATE_DATA_TOKEN
911 /// This Event will be signaled after the Status field is updated by the EFI Wireless
912 /// MAC Connection Protocol driver. The type of Event must be EFI_NOTIFY_SIGNAL.
916 /// Will be set to one of the following values:
917 /// EFI_SUCCESS: Authentication operation completed successfully.
918 /// EFI_PROTOCOL_ERROR: Peer MAC entity rejects the authentication.
919 /// EFI_NO_RESPONSE: Peer MAC entity does not response the authentication request.
920 /// EFI_DEVICE_ERROR: An unexpected network or system error occurred.
921 /// EFI_ACCESS_DENIED: The authentication operation is not completed due to some
922 /// underlying hardware or software state.
923 /// EFI_NOT_READY: The authentication operation is started but not yet completed.
927 /// Pointer to the authentication data.
929 EFI_80211_AUTHENTICATE_DATA
*Data
;
931 /// Indicates the association state.
933 EFI_80211_AUTHENTICATE_RESULT_CODE ResultCode
;
935 /// Indicates the association result. It is caller's responsibility to free this
938 EFI_80211_AUTHENTICATE_RESULT
*Result
;
939 } EFI_80211_AUTHENTICATE_DATA_TOKEN
;
942 /// EFI_80211_DEAUTHENTICATE_DATA
946 /// Specifies the address of the peer MAC entity with which to perform the
947 /// deauthentication process.
949 EFI_80211_MAC_ADDRESS BSSId
;
951 /// Specifies the reason for initiating the deauthentication process.
953 EFI_80211_REASON_CODE ReasonCode
;
955 /// Zero or more elements, may be NULL.
957 UINT8
*VendorSpecificInfo
;
958 } EFI_80211_DEAUTHENTICATE_DATA
;
961 /// EFI_80211_DEAUTHENTICATE_DATA_TOKEN
965 /// This Event will be signaled after the Status field is updated by the EFI Wireless
966 /// MAC Connection Protocol driver. The type of Event must be EFI_NOTIFY_SIGNAL.
970 /// Will be set to one of the following values:
971 /// EFI_SUCCESS: Deauthentication operation completed successfully.
972 /// EFI_DEVICE_ERROR: An unexpected network or system error occurred.
973 /// EFI_ACCESS_DENIED: The deauthentication operation is not completed due to some
974 /// underlying hardware or software state.
975 /// EFI_NOT_READY: The deauthentication operation is started but not yet
980 /// Pointer to the deauthentication data.
982 EFI_80211_DEAUTHENTICATE_DATA
*Data
;
983 } EFI_80211_DEAUTHENTICATE_DATA_TOKEN
;
986 Request a survey of potential BSSs that administrator can later elect to try to join.
988 The Scan() function returns the description of the set of BSSs detected by the scan
989 process. Passive scan operation is performed by default.
991 @param[in] This Pointer to the EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
993 @param[in] Data Pointer to the scan token.
995 @retval EFI_SUCCESS The operation completed successfully.
996 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
1000 @retval EFI_UNSUPPORTED One or more of the input parameters are not supported
1001 by this implementation.
1002 @retval EFI_ALREADY_STARTED The scan operation is already started.
1006 (EFIAPI
*EFI_WIRELESS_MAC_CONNECTION_SCAN
)(
1007 IN EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
*This
,
1008 IN EFI_80211_SCAN_DATA_TOKEN
*Data
1012 Request an association with a specified peer MAC entity that is within an AP.
1014 The Associate() function provides the capability for MAC layer to become associated
1017 @param[in] This Pointer to the EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
1019 @param[in] Data Pointer to the association token.
1021 @retval EFI_SUCCESS The operation completed successfully.
1022 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
1026 @retval EFI_UNSUPPORTED One or more of the input parameters are not supported
1027 by this implementation.
1028 @retval EFI_ALREADY_STARTED The association process is already started.
1029 @retval EFI_NOT_READY Authentication is not performed before this association
1031 @retval EFI_NOT_FOUND The specified peer MAC entity is not found.
1032 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
1036 (EFIAPI
*EFI_WIRELESS_MAC_CONNECTION_ASSOCIATE
)(
1037 IN EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
*This
,
1038 IN EFI_80211_ASSOCIATE_DATA_TOKEN
*Data
1042 Request a disassociation with a specified peer MAC entity.
1044 The Disassociate() function is invoked to terminate an existing association.
1045 Disassociation is a notification and cannot be refused by the receiving peer except
1046 when management frame protection is negotiated and the message integrity check fails.
1048 @param[in] This Pointer to the EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
1050 @param[in] Data Pointer to the disassociation token.
1052 @retval EFI_SUCCESS The operation completed successfully.
1053 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
1056 @retval EFI_ALREADY_STARTED The disassociation process is already started.
1057 @retval EFI_NOT_READY The disassociation service is invoked to a
1058 nonexistent association relationship.
1059 @retval EFI_NOT_FOUND The specified peer MAC entity is not found.
1060 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
1064 (EFIAPI
*EFI_WIRELESS_MAC_CONNECTION_DISASSOCIATE
)(
1065 IN EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
*This
,
1066 IN EFI_80211_DISASSOCIATE_DATA_TOKEN
*Data
1070 Request the process of establishing an authentication relationship with a peer MAC
1073 The Authenticate() function requests authentication with a specified peer MAC entity.
1074 This service might be time-consuming thus is designed to be invoked independently of
1075 the association service.
1077 @param[in] This Pointer to the EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
1079 @param[in] Data Pointer to the authentication token.
1081 @retval EFI_SUCCESS The operation completed successfully.
1082 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
1086 @retval EFI_UNSUPPORTED One or more of the input parameters are not supported
1087 by this implementation.
1088 @retval EFI_ALREADY_STARTED The authentication process is already started.
1089 @retval EFI_NOT_FOUND The specified peer MAC entity is not found.
1090 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
1094 (EFIAPI
*EFI_WIRELESS_MAC_CONNECTION_AUTHENTICATE
)(
1095 IN EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
*This
,
1096 IN EFI_80211_AUTHENTICATE_DATA_TOKEN
*Data
1100 Invalidate the authentication relationship with a peer MAC entity.
1102 The Deauthenticate() function requests that the authentication relationship with a
1103 specified peer MAC entity be invalidated. Deauthentication is a notification and when
1104 it is sent out the association at the transmitting station is terminated.
1106 @param[in] This Pointer to the EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
1108 @param[in] Data Pointer to the deauthentication token.
1110 @retval EFI_SUCCESS The operation completed successfully.
1111 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
1115 @retval EFI_ALREADY_STARTED The deauthentication process is already started.
1116 @retval EFI_NOT_READY The deauthentication service is invoked to a
1117 nonexistent association or authentication relationship.
1118 @retval EFI_NOT_FOUND The specified peer MAC entity is not found.
1119 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
1123 (EFIAPI
*EFI_WIRELESS_MAC_CONNECTION_DEAUTHENTICATE
)(
1124 IN EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
*This
,
1125 IN EFI_80211_DEAUTHENTICATE_DATA_TOKEN
*Data
1129 /// The EFI_WIRELESS_MAC_CONNECTION_PROTOCOL is designed to provide management service
1130 /// interfaces for the EFI wireless network stack to establish wireless connection with
1131 /// AP. An EFI Wireless MAC Connection Protocol instance will be installed on each
1132 /// communication device that the EFI wireless network stack runs on.
1134 struct _EFI_WIRELESS_MAC_CONNECTION_PROTOCOL
{
1135 EFI_WIRELESS_MAC_CONNECTION_SCAN Scan
;
1136 EFI_WIRELESS_MAC_CONNECTION_ASSOCIATE Associate
;
1137 EFI_WIRELESS_MAC_CONNECTION_DISASSOCIATE Disassociate
;
1138 EFI_WIRELESS_MAC_CONNECTION_AUTHENTICATE Authenticate
;
1139 EFI_WIRELESS_MAC_CONNECTION_DEAUTHENTICATE Deauthenticate
;
1142 extern EFI_GUID gEfiWiFiProtocolGuid
;