projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 4c5a5e0c | 1 | /** @file\r |
| 2 | The header file of iSCSI DHCP6 related configuration routines.\r | |
| 3 | \r | |
| 142c00c3 | 4 | Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.<BR>\r |
| ecf98fbc | 5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
| 4c5a5e0c | 6 | \r |
| 7 | **/\r | |
| 8 | \r | |
| 9 | #ifndef _ISCSI_DHCP6_H_\r | |
| 10 | #define _ISCSI_DHCP6_H_\r | |
| 11 | \r | |
| d1050b9d MK |
12 | #define ISCSI_ROOT_PATH_ID "iscsi:"\r |
| 13 | #define ISCSI_ROOT_PATH_FIELD_DELIMITER ':'\r | |
| 14 | #define ISCSI_ROOT_PATH_ADDR_START_DELIMITER '['\r | |
| 15 | #define ISCSI_ROOT_PATH_ADDR_END_DELIMITER ']'\r | |
| 4c5a5e0c | 16 | \r |
| 17 | /**\r | |
| 18 | Extract the Root Path option and get the required target information from\r | |
| 19 | Boot File Uniform Resource Locator (URL) Option.\r | |
| 20 | \r | |
| 21 | @param[in] RootPath The RootPath string.\r | |
| 22 | @param[in] Length Length of the RootPath option payload.\r | |
| 23 | @param[in, out] ConfigData The iSCSI session configuration data read from\r | |
| 24 | nonvolatile device.\r | |
| 25 | \r | |
| 26 | @retval EFI_SUCCESS All required information is extracted from the\r | |
| 27 | RootPath option.\r | |
| 28 | @retval EFI_NOT_FOUND The RootPath is not an iSCSI RootPath.\r | |
| 29 | @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r | |
| 30 | @retval EFI_INVALID_PARAMETER The RootPath is malformatted.\r | |
| 31 | \r | |
| 32 | **/\r | |
| 33 | EFI_STATUS\r | |
| 34 | IScsiDhcp6ExtractRootPath (\r | |
| 35 | IN CHAR8 *RootPath,\r | |
| 36 | IN UINT16 Length,\r | |
| d1050b9d | 37 | IN OUT ISCSI_ATTEMPT_CONFIG_NVDATA *ConfigData\r |
| 4c5a5e0c | 38 | );\r |
| 39 | \r | |
| 40 | /**\r | |
| 41 | Parse the DHCP ACK to get the address configuration and DNS information.\r | |
| 42 | \r | |
| 43 | @param[in] Image The handle of the driver image.\r | |
| 44 | @param[in] Controller The handle of the controller;\r | |
| 45 | @param[in, out] ConfigData The attempt configuration data.\r | |
| 46 | \r | |
| 47 | @retval EFI_SUCCESS The DNS information is got from the DHCP ACK.\r | |
| 48 | @retval EFI_NO_MAPPING DHCP failed to acquire address and other\r | |
| 49 | information.\r | |
| 50 | @retval EFI_INVALID_PARAMETER The DHCP ACK's DNS option is malformatted.\r | |
| 51 | @retval EFI_DEVICE_ERROR Some unexpected error happened.\r | |
| 52 | @retval EFI_OUT_OF_RESOURCES There is no sufficient resource to finish the\r | |
| 53 | operation.\r | |
| 54 | @retval EFI_NO_MEDIA There was a media error.\r | |
| 55 | \r | |
| 56 | **/\r | |
| 57 | EFI_STATUS\r | |
| 58 | IScsiDoDhcp6 (\r | |
| d1050b9d MK |
59 | IN EFI_HANDLE Image,\r |
| 60 | IN EFI_HANDLE Controller,\r | |
| 61 | IN OUT ISCSI_ATTEMPT_CONFIG_NVDATA *ConfigData\r | |
| 4c5a5e0c | 62 | );\r |
| 63 | \r | |
| 64 | #endif\r |