NetworkPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / NetworkPkg / WifiConnectionManagerDxe / WifiConnectionMgrMisc.h

/** @file\r
  The Miscellaneous Routines for WiFi Connection Manager.\r
\r
  Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __EFI_WIFI_MGR_MISC_H__\r
#define __EFI_WIFI_MGR_MISC_H__\r
\r
/**\r
  Empty function for event process function.\r
\r
  @param[in] Event    The Event needs to be processed\r
  @param[in] Context  The context of the event\r
\r
**/\r
VOID\r
EFIAPI\r
WifiMgrInternalEmptyFunction (\r
  IN  EFI_EVENT   Event,\r
  IN  VOID        *Context\r
  );\r
\r
/**\r
  Convert the mac address into a hexadecimal encoded ":" seperated string.\r
\r
  @param[in]  Mac     The mac address\r
  @param[in]  StrSize The size, in bytes, of the output buffer specified by Str\r
  @param[out] Str     The storage to return the mac string\r
\r
**/\r
VOID\r
WifiMgrMacAddrToStr (\r
  IN  EFI_80211_MAC_ADDRESS     *Mac,\r
  IN  UINT32                    StrSize,\r
  OUT CHAR16                    *Str\r
  );\r
\r
/**\r
  Read private key file to buffer.\r
\r
  @param[in]   FileContext           The file context of private key file.\r
  @param[out]  PrivateKeyDataAddr    The buffer address to restore private key file, should be\r
                                     freed by caller.\r
  @param[out]  PrivateKeyDataSize    The size of read private key file.\r
\r
  @retval EFI_SUCCESS                Successfully read the private key file.\r
  @retval EFI_INVALID_PARAMETER      One or more of the parameters is invalid.\r
\r
**/\r
EFI_STATUS\r
WifiMgrReadFileToBuffer (\r
  IN   WIFI_MGR_FILE_CONTEXT          *FileContext,\r
  OUT  VOID                           **PrivateKeyDataAddr,\r
  OUT  UINTN                          *PrivateKeyDataSize\r
  );\r
\r
\r
/**\r
  Get the Nic data by the NicIndex.\r
\r
  @param[in]  Private        The pointer to the global private data structure.\r
  @param[in]  NicIndex       The index indicates the position of wireless NIC.\r
\r
  @return     Pointer to the Nic data, or NULL if not found.\r
\r
**/\r
WIFI_MGR_DEVICE_DATA *\r
WifiMgrGetNicByIndex (\r
  IN WIFI_MGR_PRIVATE_DATA      *Private,\r
  IN UINT32                     NicIndex\r
  );\r
\r
/**\r
  Find a network profile through its' SSId and securit type, and the SSId is an unicode string.\r
\r
  @param[in]  SSId                   The target network's SSId.\r
  @param[in]  SecurityType           The target network's security type.\r
  @param[in]  ProfileList            The profile list on a Nic.\r
\r
  @return Pointer to a network profile, or NULL if not found.\r
\r
**/\r
WIFI_MGR_NETWORK_PROFILE *\r
WifiMgrGetProfileByUnicodeSSId (\r
  IN  CHAR16                         *SSId,\r
  IN  UINT8                          SecurityType,\r
  IN  LIST_ENTRY                     *ProfileList\r
  );\r
\r
/**\r
  Find a network profile through its' SSId and securit type, and the SSId is an ascii string.\r
\r
  @param[in]  SSId                   The target network's SSId.\r
  @param[in]  SecurityType           The target network's security type.\r
  @param[in]  ProfileList            The profile list on a Nic.\r
\r
  @return Pointer to a network profile, or NULL if not found.\r
\r
**/\r
WIFI_MGR_NETWORK_PROFILE *\r
WifiMgrGetProfileByAsciiSSId (\r
  IN  CHAR8                          *SSId,\r
  IN  UINT8                          SecurityType,\r
  IN  LIST_ENTRY                     *ProfileList\r
  );\r
\r
/**\r
  Find a network profile through its' profile index.\r
\r
  @param[in]  ProfileIndex           The target network's profile index.\r
  @param[in]  ProfileList            The profile list on a Nic.\r
\r
  @return Pointer to a network profile, or NULL if not found.\r
\r
**/\r
WIFI_MGR_NETWORK_PROFILE *\r
WifiMgrGetProfileByProfileIndex (\r
  IN UINT32                     ProfileIndex,\r
  IN LIST_ENTRY                 *ProfileList\r
  );\r
\r
/**\r
  To test if the AKMSuite is in supported AKMSuite list.\r
\r
  @param[in]  SupportedAKMSuiteCount      The count of the supported AKMSuites.\r
  @param[in]  SupportedAKMSuiteList       The supported AKMSuite list.\r
  @param[in]  AKMSuite                    The AKMSuite to be tested.\r
\r
  @return True if this AKMSuite is supported, or False if not.\r
\r
**/\r
BOOLEAN\r
WifiMgrSupportAKMSuite (\r
  IN  UINT16                              SupportedAKMSuiteCount,\r
  IN  UINT32                              *SupportedAKMSuiteList,\r
  IN  UINT32                              *AKMSuite\r
  );\r
\r
/**\r
  To check if the CipherSuite is in supported CipherSuite list.\r
\r
  @param[in]  SupportedCipherSuiteCount   The count of the supported CipherSuites.\r
  @param[in]  SupportedCipherSuiteList    The supported CipherSuite list.\r
  @param[in]  CipherSuite                 The CipherSuite to be tested.\r
\r
  @return True if this CipherSuite is supported, or False if not.\r
\r
**/\r
BOOLEAN\r
WifiMgrSupportCipherSuite (\r
  IN  UINT16                              SupportedCipherSuiteCount,\r
  IN  UINT32                              *SupportedCipherSuiteList,\r
  IN  UINT32                              *CipherSuite\r
  );\r
\r
/**\r
  Check an AKM suite list and a Cipher suite list to see if one or more AKM suites or Cipher suites\r
  are supported and find the matchable security type.\r
\r
  @param[in]   AKMList                     The target AKM suite list to be checked.\r
  @param[in]   CipherList                  The target Cipher suite list to be checked\r
  @param[in]   Nic                         The Nic to operate, contains the supported AKMSuite list\r
                                           and supported CipherSuite list\r
  @param[out]  SecurityType                To identify a security type from the AKM suite list and\r
                                           Cipher suite list\r
  @param[out]  AKMSuiteSupported           To identify if this security type is supported. If it is\r
                                           NULL, overcome this field\r
  @param[out]  CipherSuiteSupported        To identify if this security type is supported. If it is\r
                                           NULL, overcome this field\r
\r
  @retval EFI_SUCCESS                      This operation has completed successfully.\r
  @retval EFI_INVALID_PARAMETER            No Nic found or the suite list is null.\r
\r
**/\r
EFI_STATUS\r
WifiMgrCheckRSN (\r
  IN    EFI_80211_AKM_SUITE_SELECTOR      *AKMList,\r
  IN    EFI_80211_CIPHER_SUITE_SELECTOR   *CipherList,\r
  IN    WIFI_MGR_DEVICE_DATA              *Nic,\r
  OUT   UINT8                             *SecurityType,\r
  OUT   BOOLEAN                           *AKMSuiteSupported,\r
  OUT   BOOLEAN                           *CipherSuiteSupported\r
  );\r
\r
/**\r
  To get the security type for a certain AKMSuite and CipherSuite.\r
\r
  @param[in]   AKMSuite             An certain AKMSuite.\r
  @param[in]   CipherSuite          An certain CipherSuite.\r
\r
  @return a security type if found, or SECURITY_TYPE_UNKNOWN.\r
\r
**/\r
UINT8\r
WifiMgrGetSecurityType (\r
  IN    UINT32                          *AKMSuite,\r
  IN    UINT32                          *CipherSuite\r
  );\r
\r
/**\r
  Get supported AKMSuites and CipherSuites from supplicant.\r
\r
  @param[in]   Nic                      The Nic to operate.\r
\r
  @retval EFI_SUCCESS                   Get the supported suite list successfully.\r
  @retval EFI_INVALID_PARAMETER         No Nic found or supplicant is NULL.\r
\r
**/\r
EFI_STATUS\r
WifiMgrGetSupportedSuites (\r
  IN    WIFI_MGR_DEVICE_DATA            *Nic\r
  );\r
\r
/**\r
  Clean secrets from a network profile.\r
\r
  @param[in]   Profile               The profile to be cleanned.\r
\r
**/\r
VOID\r
WifiMgrCleanProfileSecrets (\r
  IN  WIFI_MGR_NETWORK_PROFILE       *Profile\r
  );\r
\r
/**\r
  Free all network profiles in a profile list.\r
\r
  @param[in]   ProfileList           The profile list to be freed.\r
\r
**/\r
VOID\r
WifiMgrFreeProfileList (\r
  IN  LIST_ENTRY               *ProfileList\r
  );\r
\r
/**\r
  Free user configured hidden network list.\r
\r
  @param[in]   HiddenList           The hidden network list to be freed.\r
\r
**/\r
VOID\r
WifiMgrFreeHiddenList (\r
  IN  LIST_ENTRY                     *HiddenList\r
  );\r
\r
/**\r
  Free the resources of a config token.\r
\r
  @param[in]   ConfigToken          The config token to be freed.\r
\r
**/\r
VOID\r
WifiMgrFreeToken (\r
  IN   WIFI_MGR_MAC_CONFIG_TOKEN        *ConfigToken\r
  );\r
\r
#endif\r