IScsiDhcp6.h File Reference

Go to the source code of this file.

Macros
#define	ISCSI_ROOT_PATH_ID   "iscsi:"
#define	ISCSI_ROOT_PATH_FIELD_DELIMITER   ':'
#define	ISCSI_ROOT_PATH_ADDR_START_DELIMITER   '['
#define	ISCSI_ROOT_PATH_ADDR_END_DELIMITER   ']'

Functions
EFI_STATUS	IScsiDhcp6ExtractRootPath (IN CHAR8 *RootPath, IN UINT16 Length, IN OUT ISCSI_ATTEMPT_CONFIG_NVDATA *ConfigData)
EFI_STATUS	IScsiDoDhcp6 (IN EFI_HANDLE Image, IN EFI_HANDLE Controller, IN OUT ISCSI_ATTEMPT_CONFIG_NVDATA *ConfigData)

Detailed Description

The header file of iSCSI DHCP6 related configuration routines.

Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file IScsiDhcp6.h.

Macro Definition Documentation

ISCSI_ROOT_PATH_ADDR_END_DELIMITER

#define ISCSI_ROOT_PATH_ADDR_END_DELIMITER   ']'

Definition at line 15 of file IScsiDhcp6.h.

ISCSI_ROOT_PATH_ADDR_START_DELIMITER

#define ISCSI_ROOT_PATH_ADDR_START_DELIMITER   '['

Definition at line 14 of file IScsiDhcp6.h.

ISCSI_ROOT_PATH_FIELD_DELIMITER

#define ISCSI_ROOT_PATH_FIELD_DELIMITER   ':'

Definition at line 13 of file IScsiDhcp6.h.

ISCSI_ROOT_PATH_ID

#define ISCSI_ROOT_PATH_ID   "iscsi:"

Definition at line 12 of file IScsiDhcp6.h.

Function Documentation

IScsiDhcp6ExtractRootPath()

EFI_STATUS IScsiDhcp6ExtractRootPath	(	IN CHAR8 *	RootPath,
		IN UINT16	Length,
		IN OUT ISCSI_ATTEMPT_CONFIG_NVDATA *	ConfigData
	)

Extract the Root Path option and get the required target information from Boot File Uniform Resource Locator (URL) Option.

Parameters

[in]	RootPath	The RootPath string.
[in]	Length	Length of the RootPath option payload.
[in,out]	ConfigData	The iSCSI session configuration data read from nonvolatile device.

Return values

EFI_SUCCESS	All required information is extracted from the RootPath option.
EFI_NOT_FOUND	The RootPath is not an iSCSI RootPath.
EFI_OUT_OF_RESOURCES	Failed to allocate memory.
EFI_INVALID_PARAMETER	The RootPath is malformatted.

Definition at line 28 of file IScsiDhcp6.c.

IScsiDoDhcp6()

EFI_STATUS IScsiDoDhcp6	(	IN EFI_HANDLE	Image,
		IN EFI_HANDLE	Controller,
		IN OUT ISCSI_ATTEMPT_CONFIG_NVDATA *	ConfigData
	)

Parse the DHCP ACK to get the address configuration and DNS information.

Parameters

[in]	Image	The handle of the driver image.
[in]	Controller	The handle of the controller;
[in,out]	ConfigData	The attempt configuration data.

Return values

EFI_SUCCESS	The DNS information is got from the DHCP ACK.
EFI_NO_MAPPING	DHCP failed to acquire address and other information.
EFI_INVALID_PARAMETER	The DHCP ACK's DNS option is malformatted.
EFI_DEVICE_ERROR	Some unexpected error happened.
EFI_OUT_OF_RESOURCES	There is no sufficient resource to finish the operation.
EFI_NO_MEDIA	There was a media error.

Parse the DHCP ACK to get the address configuration and DNS information.

Parameters

[in]	Image	The handle of the driver image.
[in]	Controller	The handle of the controller;
[in,out]	ConfigData	The attempt configuration data.

Return values

EFI_SUCCESS	The DNS information is got from the DHCP ACK.
EFI_NO_MAPPING	DHCP failed to acquire address and other information.
EFI_INVALID_PARAMETER	The DHCP ACK's DNS option is malformatted.
EFI_DEVICE_ERROR	Some unexpected error occurred.
EFI_OUT_OF_RESOURCES	There is no sufficient resource to finish the operation.
EFI_NO_MEDIA	There was a media error.

Definition at line 391 of file IScsiDhcp6.c.