MdePkg: Replace BSD License with BSD+Patent License

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

/** @file\r
  The Mac Connection2 Protocol adapter functions for WiFi Connection Manager.\r
\r
  Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>\r
\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php.\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef __EFI_WIFI_IMPL__\r
#define __EFI_WIFI_IMPL__\r
\r
/**\r
  Start scan operation, and send out a token to collect available networks.\r
\r
  @param[in]  Nic                 Pointer to the device data of the selected NIC.\r
\r
  @retval EFI_SUCCESS             The operation is completed.\r
  @retval EFI_ALREADY_STARTED     A former scan operation is already ongoing.\r
  @retval EFI_INVALID_PARAMETER   One or more parameters are invalid.\r
  @retval EFI_OUT_OF_RESOURCES    Failed to allocate memory.\r
  @retval Other Errors            Return errors when getting networks from low layer.\r
\r
**/\r
EFI_STATUS\r
WifiMgrStartScan (\r
  IN      WIFI_MGR_DEVICE_DATA        *Nic\r
  );\r
\r
/**\r
  Get current link state from low layer.\r
\r
  @param[in]   Nic                Pointer to the device data of the selected NIC.\r
  @param[out]  LinkState          The pointer to buffer to retrieve link state.\r
\r
  @retval EFI_SUCCESS             The operation is completed.\r
  @retval EFI_INVALID_PARAMETER   One or more parameters are invalid.\r
  @retval EFI_UNSUPPORTED         Adapter information protocol is not supported.\r
  @retval Other Errors            Returned errors when retrieving link state from low layer.\r
\r
**/\r
EFI_STATUS\r
WifiMgrGetLinkState (\r
  IN    WIFI_MGR_DEVICE_DATA          *Nic,\r
  OUT   EFI_ADAPTER_INFO_MEDIA_STATE  *LinkState\r
  );\r
\r
/**\r
  Start connect operation, and send out a token to connect to a target network.\r
\r
  @param[in]  Nic                 Pointer to the device data of the selected NIC.\r
  @param[in]  Profile             The target network to be connected.\r
\r
  @retval EFI_SUCCESS             The operation is completed.\r
  @retval EFI_ALREADY_STARTED     Already in "connected" state, need to perform a disconnect\r
                                  operation first.\r
  @retval EFI_INVALID_PARAMETER   One or more parameters are invalid.\r
  @retval EFI_OUT_OF_RESOURCES    Failed to allocate memory.\r
  @retval Other Errors            Return errors when connecting network on low layer.\r
\r
**/\r
EFI_STATUS\r
WifiMgrConnectToNetwork (\r
  IN    WIFI_MGR_DEVICE_DATA              *Nic,\r
  IN    WIFI_MGR_NETWORK_PROFILE          *Profile\r
  );\r
\r
/**\r
  Start disconnect operation, and send out a token to disconnect from current connected\r
  network.\r
\r
  @param[in]  Nic                 Pointer to the device data of the selected NIC.\r
\r
  @retval EFI_SUCCESS             The operation is completed.\r
  @retval EFI_OUT_OF_RESOURCES    Failed to allocate memory.\r
  @retval Other Errors            Return errors when disconnecting a network on low layer.\r
\r
**/\r
EFI_STATUS\r
WifiMgrDisconnectToNetwork (\r
  IN    WIFI_MGR_DEVICE_DATA              *Nic\r
  );\r
\r
/**\r
  The state machine of the connection manager, periodically check the state and\r
  perform a corresponding operation.\r
\r
  @param[in]  Event                   The timer event to be triggered.\r
  @param[in]  Context                 The context of the Nic device data.\r
\r
**/\r
VOID\r
EFIAPI\r
WifiMgrOnTimerTick (\r
  IN EFI_EVENT              Event,\r
  IN VOID                   *Context\r
  );\r
\r
#endif\r