NetworkPkg/IScsiDxe/IScsiDns.h

   1 /** @file
   2  The header file of routines for IScsi driver to perform DNS
   3  resolution based on UEFI DNS protocols.
   4
   5 Copyright (c) 2017 - 2018, Intel Corporation. All rights reserved.<BR>
   6 This program and the accompanying materials
   7 are licensed and made available under the terms and conditions of the BSD License
   8 which accompanies this distribution.  The full text of the license may be found at
   9 http://opensource.org/licenses/bsd-license.php
  10
  11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef _ISCSI_DNS_H_
  17 #define _ISCSI_DNS_H_
  18
  19 /**
  20   Retrieve the host address using the EFI_DNS4_PROTOCOL.
  21
  22   @param[in]  Image               The handle of the driver image.
  23   @param[in]  Controller          The handle of the controller.
  24   @param[in, out]  NvData         The Session config data structure.
  25
  26   @retval EFI_SUCCESS             Operation succeeded.
  27   @retval EFI_OUT_OF_RESOURCES    Failed to allocate needed resources.
  28   @retval EFI_DEVICE_ERROR        An unexpected network error occurred.
  29   @retval Others                  Other errors as indicated.
  30
  31 **/
  32 EFI_STATUS
  33 IScsiDns4 (
  34   IN     EFI_HANDLE                      Image,
  35   IN     EFI_HANDLE                      Controller,
  36   IN OUT ISCSI_SESSION_CONFIG_NVDATA     *NvData
  37   );
  38
  39 /**
  40   Retrieve the host address using the EFI_DNS6_PROTOCOL.
  41
  42   @param[in]  Image               The handle of the driver image.
  43   @param[in]  Controller          The handle of the controller.
  44   @param[in, out]  NvData         The Session config data structure.
  45
  46   @retval EFI_SUCCESS             Operation succeeded.
  47   @retval EFI_OUT_OF_RESOURCES    Failed to allocate needed resources.
  48   @retval EFI_DEVICE_ERROR        An unexpected network error occurred.
  49   @retval Others                  Other errors as indicated.
  50
  51 **/
  52 EFI_STATUS
  53 IScsiDns6 (
  54   IN     EFI_HANDLE                      Image,
  55   IN     EFI_HANDLE                      Controller,
  56   IN OUT ISCSI_SESSION_CONFIG_NVDATA     *NvData
  57   );
  58
  59 #endif