HttpBootImpl.h 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. /** @file
  2. The declaration of UEFI HTTP boot function.
  3. Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>
  4. SPDX-License-Identifier: BSD-2-Clause-Patent
  5. **/
  6. #ifndef __EFI_HTTP_BOOT_IMPL_H__
  7. #define __EFI_HTTP_BOOT_IMPL_H__
  8. #define HTTP_BOOT_CHECK_MEDIA_WAITING_TIME EFI_TIMER_PERIOD_SECONDS(20)
  9. /**
  10. Attempt to complete a DHCPv4 D.O.R.A or DHCPv6 S.R.A.A sequence to retrieve the boot resource information.
  11. @param[in] Private The pointer to the driver's private data.
  12. @retval EFI_SUCCESS Boot info was successfully retrieved.
  13. @retval EFI_INVALID_PARAMETER Private is NULL.
  14. @retval EFI_NOT_STARTED The driver is in stopped state.
  15. @retval EFI_DEVICE_ERROR An unexpected network error occurred.
  16. @retval Others Other errors as indicated.
  17. **/
  18. EFI_STATUS
  19. HttpBootDhcp (
  20. IN HTTP_BOOT_PRIVATE_DATA *Private
  21. );
  22. /**
  23. Disable the use of UEFI HTTP boot function.
  24. @param[in] Private The pointer to the driver's private data.
  25. @retval EFI_SUCCESS HTTP boot was successfully disabled.
  26. @retval EFI_NOT_STARTED The driver is already in stopped state.
  27. @retval EFI_INVALID_PARAMETER Private is NULL.
  28. @retval Others Unexpected error when stop the function.
  29. **/
  30. EFI_STATUS
  31. HttpBootStop (
  32. IN HTTP_BOOT_PRIVATE_DATA *Private
  33. );
  34. extern EFI_HTTP_BOOT_CALLBACK_PROTOCOL gHttpBootDxeHttpBootCallback;
  35. #endif