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