NetworkPkg/HttpBootDxe/HttpBootImpl.h

   1 /** @file
   2   The declaration of UEFI HTTP boot function.
   3
   4 Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>
   5 This program and the accompanying materials are licensed and made available under
   6 the terms and conditions of the BSD License that accompanies this distribution.
   7 The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php.
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14 #ifndef __EFI_HTTP_BOOT_IMPL_H__
  15 #define __EFI_HTTP_BOOT_IMPL_H__
  16
  17 #define HTTP_BOOT_CHECK_MEDIA_WAITING_TIME          EFI_TIMER_PERIOD_SECONDS(20)
  18
  19 /**
  20   Attempt to complete a DHCPv4 D.O.R.A or DHCPv6 S.R.A.A sequence to retrieve the boot resource information.
  21
  22   @param[in]    Private            The pointer to the driver's private data.
  23
  24   @retval EFI_SUCCESS              Boot info was successfully retrieved.
  25   @retval EFI_INVALID_PARAMETER    Private is NULL.
  26   @retval EFI_NOT_STARTED          The driver is in stopped state.
  27   @retval EFI_DEVICE_ERROR         An unexpected network error occurred.
  28   @retval Others                   Other errors as indicated.
  29
  30 **/
  31 EFI_STATUS
  32 HttpBootDhcp (
  33   IN HTTP_BOOT_PRIVATE_DATA           *Private
  34   );
  35
  36 /**
  37   Disable the use of UEFI HTTP boot function.
  38
  39   @param[in]    Private            The pointer to the driver's private data.
  40
  41   @retval EFI_SUCCESS              HTTP boot was successfully disabled.
  42   @retval EFI_NOT_STARTED          The driver is already in stopped state.
  43   @retval EFI_INVALID_PARAMETER    Private is NULL.
  44   @retval Others                   Unexpected error when stop the function.
  45
  46 **/
  47 EFI_STATUS
  48 HttpBootStop (
  49   IN HTTP_BOOT_PRIVATE_DATA           *Private
  50   );
  51
  52 extern EFI_HTTP_BOOT_CALLBACK_PROTOCOL  gHttpBootDxeHttpBootCallback;
  53
  54 #endif