projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| a3bcde70 HT |
1 | /** @file\r |
| 2 | Boot functions declaration for UefiPxeBc Driver.\r | |
| 3 | \r | |
| 9063c328 | 4 | Copyright (c) 2009 - 2012, Intel Corporation. All rights reserved.<BR>\r |
| a3bcde70 | 5 | \r |
| ecf98fbc | 6 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
| a3bcde70 HT |
7 | \r |
| 8 | **/\r | |
| 9 | \r | |
| 10 | #ifndef __EFI_PXEBC_BOOT_H__\r | |
| 11 | #define __EFI_PXEBC_BOOT_H__\r | |
| 12 | \r | |
| 13 | #define PXEBC_DISPLAY_MAX_LINE 70\r | |
| 14 | #define PXEBC_DEFAULT_UDP_OVERHEAD_SIZE 8\r | |
| 15 | #define PXEBC_DEFAULT_TFTP_OVERHEAD_SIZE 4\r | |
| 16 | \r | |
| 17 | #define PXEBC_IS_SIZE_OVERFLOWED(x) ((sizeof (UINTN) < sizeof (UINT64)) && ((x) > 0xFFFFFFFF))\r | |
| 18 | \r | |
| 19 | \r | |
| 20 | /**\r | |
| 21 | Extract the discover information and boot server entry from the\r | |
| 22 | cached packets if unspecified.\r | |
| 23 | \r | |
| 24 | @param[in] Private Pointer to PxeBc private data.\r | |
| 25 | @param[in] Type The type of bootstrap to perform.\r | |
| 9063c328 | 26 | @param[in, out] DiscoverInfo Pointer to EFI_PXE_BASE_CODE_DISCOVER_INFO.\r |
| a3bcde70 HT |
27 | @param[out] BootEntry Pointer to PXEBC_BOOT_SVR_ENTRY.\r |
| 28 | @param[out] SrvList Pointer to EFI_PXE_BASE_CODE_SRVLIST.\r | |
| 29 | \r | |
| 30 | @retval EFI_SUCCESS Successfully extracted the information.\r | |
| 31 | @retval EFI_DEVICE_ERROR Failed to extract the information.\r | |
| 32 | \r | |
| 33 | **/\r | |
| 34 | EFI_STATUS\r | |
| 35 | PxeBcExtractDiscoverInfo (\r | |
| 36 | IN PXEBC_PRIVATE_DATA *Private,\r | |
| 37 | IN UINT16 Type,\r | |
| 9063c328 | 38 | IN OUT EFI_PXE_BASE_CODE_DISCOVER_INFO **DiscoverInfo,\r |
| a3bcde70 HT |
39 | OUT PXEBC_BOOT_SVR_ENTRY **BootEntry,\r |
| 40 | OUT EFI_PXE_BASE_CODE_SRVLIST **SrvList\r | |
| 41 | );\r | |
| 42 | \r | |
| 43 | \r | |
| 44 | /**\r | |
| 45 | Build the discover packet and send out for boot.\r | |
| 46 | \r | |
| 47 | @param[in] Private Pointer to PxeBc private data.\r | |
| 48 | @param[in] Type PxeBc option boot item type.\r | |
| 49 | @param[in] Layer Pointer to option boot item layer.\r | |
| 50 | @param[in] UseBis Use BIS or not.\r | |
| 51 | @param[in] DestIp Pointer to the server address.\r | |
| 52 | @param[in] IpCount The total count of the server address.\r | |
| 53 | @param[in] SrvList Pointer to the server address list.\r | |
| 54 | \r | |
| 55 | @retval EFI_SUCCESS Successfully discovered boot file.\r | |
| 56 | @retval EFI_OUT_OF_RESOURCES Failed to allocate resources.\r | |
| 57 | @retval EFI_NOT_FOUND Can't get the PXE reply packet.\r | |
| 58 | @retval Others Failed to discover boot file.\r | |
| 59 | \r | |
| 60 | **/\r | |
| 61 | EFI_STATUS\r | |
| 62 | PxeBcDiscoverBootServer (\r | |
| 63 | IN PXEBC_PRIVATE_DATA *Private,\r | |
| 64 | IN UINT16 Type,\r | |
| 65 | IN UINT16 *Layer,\r | |
| 66 | IN BOOLEAN UseBis,\r | |
| 67 | IN EFI_IP_ADDRESS *DestIp,\r | |
| 68 | IN UINT16 IpCount,\r | |
| 69 | IN EFI_PXE_BASE_CODE_SRVLIST *SrvList\r | |
| 70 | );\r | |
| 71 | \r | |
| 72 | \r | |
| 73 | /**\r | |
| 74 | Load boot file into user buffer.\r | |
| 75 | \r | |
| 76 | @param[in] Private Pointer to PxeBc private data.\r | |
| 77 | @param[in, out] BufferSize Size of user buffer for input;\r | |
| 78 | required buffer size for output.\r | |
| 79 | @param[in] Buffer Pointer to user buffer.\r | |
| 80 | \r | |
| 81 | @retval EFI_SUCCESS Successfully obtained all the boot information.\r | |
| 82 | @retval EFI_BUFFER_TOO_SMALL The buffer size is not enough for boot file.\r | |
| 83 | @retval EFI_ABORTED User cancelled the current operation.\r | |
| 84 | @retval Others Failed to parse out the boot information.\r | |
| 85 | \r | |
| 86 | **/\r | |
| 87 | EFI_STATUS\r | |
| 88 | PxeBcLoadBootFile (\r | |
| 89 | IN PXEBC_PRIVATE_DATA *Private,\r | |
| 90 | IN OUT UINTN *BufferSize,\r | |
| 91 | IN VOID *Buffer OPTIONAL\r | |
| 92 | );\r | |
| 93 | \r | |
| 94 | #endif\r |