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 SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8 #ifndef __EFI_HTTP_BOOT_IMPL_H__
   9 #define __EFI_HTTP_BOOT_IMPL_H__
  10
  11 #define HTTP_BOOT_CHECK_MEDIA_WAITING_TIME          EFI_TIMER_PERIOD_SECONDS(20)
  12
  13 /**
  14   Attempt to complete a DHCPv4 D.O.R.A or DHCPv6 S.R.A.A sequence to retrieve the boot resource information.
  15
  16   @param[in]    Private            The pointer to the driver's private data.
  17
  18   @retval EFI_SUCCESS              Boot info was successfully retrieved.
  19   @retval EFI_INVALID_PARAMETER    Private is NULL.
  20   @retval EFI_NOT_STARTED          The driver is in stopped state.
  21   @retval EFI_DEVICE_ERROR         An unexpected network error occurred.
  22   @retval Others                   Other errors as indicated.
  23
  24 **/
  25 EFI_STATUS
  26 HttpBootDhcp (
  27   IN HTTP_BOOT_PRIVATE_DATA           *Private
  28   );
  29
  30 /**
  31   Disable the use of UEFI HTTP boot function.
  32
  33   @param[in]    Private            The pointer to the driver's private data.
  34
  35   @retval EFI_SUCCESS              HTTP boot was successfully disabled.
  36   @retval EFI_NOT_STARTED          The driver is already in stopped state.
  37   @retval EFI_INVALID_PARAMETER    Private is NULL.
  38   @retval Others                   Unexpected error when stop the function.
  39
  40 **/
  41 EFI_STATUS
  42 HttpBootStop (
  43   IN HTTP_BOOT_PRIVATE_DATA           *Private
  44   );
  45
  46 extern EFI_HTTP_BOOT_CALLBACK_PROTOCOL  gHttpBootDxeHttpBootCallback;
  47
  48 #endif