Data Structures
struct	_ISCSI_SESSION_CONFIG_NVDATA

Macros
#define	IP4_NODE_LEN_NEW_VERSIONS 27

#define	IP6_NODE_LEN_OLD_VERSIONS 43

#define	IP6_NODE_LEN_NEW_VERSIONS 60

#define	IP6_OLD_IPADDRESS_OFFSET 42

Typedefs
typedef struct _ISCSI_DRIVER_DATA	ISCSI_DRIVER_DATA

typedef struct _ISCSI_SESSION_CONFIG_NVDATA	ISCSI_SESSION_CONFIG_NVDATA

Functions
UINT8	IScsiGetSubnetMaskPrefixLength (IN EFI_IPv4_ADDRESS *SubnetMask)

EFI_STATUS	IScsiAsciiStrToLun (IN CHAR8 Str, OUT UINT8 Lun)

VOID	IScsiLunToUnicodeStr (IN UINT8 Lun, OUT CHAR16 String)

VOID	IScsiMacAddrToStr (IN EFI_MAC_ADDRESS Mac, IN UINT32 Len, IN UINT16 VlanId, OUT CHAR16 Str)

EFI_STATUS	IScsiAsciiStrToIp (IN CHAR8 Str, IN UINT8 IpMode, OUT EFI_IP_ADDRESS Ip)

EFI_STATUS	IScsiBinToHex (IN UINT8 BinBuffer, IN UINT32 BinLength, IN OUT CHAR8 HexStr, IN OUT UINT32 *HexLength)

EFI_STATUS	IScsiHexToBin (IN OUT UINT8 BinBuffer, IN OUT UINT32 BinLength, IN CHAR8 *HexStr)

UINTN	IScsiNetNtoi (IN CHAR8 *Str)

EFI_STATUS	IScsiGenRandom (IN OUT UINT8 *Rand, IN UINTN RandLength)

EFI_STATUS	IScsiAddNic (IN EFI_HANDLE Controller, IN EFI_HANDLE Image)

EFI_STATUS	IScsiRemoveNic (IN EFI_HANDLE Controller)

EFI_STATUS	IScsiCreateAttempts (IN UINTN AttemptNum)

EFI_STATUS	IScsiCreateKeywords (IN UINTN KeywordNum)

VOID	IScsiCleanAttemptVariable (IN VOID)

ISCSI_NIC_INFO *	IScsiGetNicInfoByIndex (IN UINT8 NicIndex)

UINT16	IScsiGetNICPciLocation (IN EFI_HANDLE Controller, OUT UINTN Bus, OUT UINTN Device, OUT UINTN *Function)

VOID *	IScsiGetVariableAndSize (IN CHAR16 Name, IN EFI_GUID VendorGuid, OUT UINTN *VariableSize)

ISCSI_DRIVER_DATA *	IScsiCreateDriverData (IN EFI_HANDLE Image, IN EFI_HANDLE Controller)

EFI_STATUS	IScsiCleanDriverData (IN ISCSI_DRIVER_DATA *Private)

BOOLEAN	IScsiDhcpIsConfigured (IN EFI_HANDLE Controller, IN UINT8 IpVersion)

BOOLEAN	IScsiDnsIsConfigured (IN EFI_HANDLE Controller)

EFI_STATUS	IScsiGetConfigData (IN ISCSI_DRIVER_DATA *Private)

EFI_DEVICE_PATH_PROTOCOL *	IScsiGetTcpConnDevicePath (IN ISCSI_SESSION *Session)

VOID EFIAPI	IScsiOnExitBootService (IN EFI_EVENT Event, IN VOID *Context)

EFI_STATUS EFIAPI	IScsiTestManagedDevice (IN EFI_HANDLE ControllerHandle, IN EFI_HANDLE DriverBindingHandle, IN EFI_GUID *ProtocolGuid)

Detailed Description

Miscellaneous definitions for iSCSI driver.

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

Definition in file IScsiMisc.h.

Macro Definition Documentation

◆ IP4_NODE_LEN_NEW_VERSIONS

#define IP4_NODE_LEN_NEW_VERSIONS 27

IPv4 Device Path Node Length

Definition at line 18 of file IScsiMisc.h.

◆ IP6_NODE_LEN_NEW_VERSIONS

#define IP6_NODE_LEN_NEW_VERSIONS 60

Definition at line 24 of file IScsiMisc.h.

◆ IP6_NODE_LEN_OLD_VERSIONS

#define IP6_NODE_LEN_OLD_VERSIONS 43

IPv6 Device Path Node Length

Definition at line 23 of file IScsiMisc.h.

◆ IP6_OLD_IPADDRESS_OFFSET

#define IP6_OLD_IPADDRESS_OFFSET 42

The ignored field StaticIpAddress's offset in old IPv6 Device Path

Definition at line 29 of file IScsiMisc.h.

Typedef Documentation

◆ ISCSI_DRIVER_DATA

typedef struct _ISCSI_DRIVER_DATA ISCSI_DRIVER_DATA

Definition at line 13 of file IScsiMisc.h.

Function Documentation

◆ IScsiAddNic()

EFI_STATUS IScsiAddNic	(	IN EFI_HANDLE	Controller,
		IN EFI_HANDLE	Image
	)

Record the NIC information in a global structure.

Parameters

[in]	Controller	The handle of the controller.
[in]	Image	Handle of the image.

Return values

EFI_SUCCESS	The operation is completed.
EFI_OUT_OF_RESOURCES	Do not have sufficient resource to finish this operation.

Record the NIC info in global structure.

Parameters

[in]	Controller	The handle of the controller.
[in]	Image	Handle of the image.

Return values

EFI_SUCCESS	The operation is completed.
EFI_OUT_OF_RESOURCES	Do not have sufficient resources to finish this operation.

Definition at line 607 of file IScsiMisc.c.

◆ IScsiAsciiStrToIp()

EFI_STATUS IScsiAsciiStrToIp	(	IN CHAR8 *	Str,
		IN UINT8	IpMode,
		OUT EFI_IP_ADDRESS *	Ip
	)

Convert the formatted IP address into the binary IP address.

Parameters

[in]	Str	The UNICODE string.
[in]	IpMode	Indicates whether the IP address is v4 or v6.
[out]	Ip	The storage to return the ASCII string.

Return values

EFI_SUCCESS	The binary IP address is returned in Ip.
EFI_INVALID_PARAMETER	The IP string is malformatted or IpMode is invalid.

Definition at line 248 of file IScsiMisc.c.

◆ IScsiAsciiStrToLun()

EFI_STATUS IScsiAsciiStrToLun	(	IN CHAR8 *	Str,
		OUT UINT8 *	Lun
	)

Convert the hexadecimal encoded LUN string into the 64-bit LUN.

Parameters

[in]	Str	The hexadecimal encoded LUN string.
[out]	Lun	Storage to return the 64-bit LUN.

Return values

EFI_SUCCESS	The 64-bit LUN is stored in Lun.
EFI_INVALID_PARAMETER	The string is malformatted.

Definition at line 118 of file IScsiMisc.c.

◆ IScsiBinToHex()

EFI_STATUS IScsiBinToHex	(	IN UINT8 *	BinBuffer,
		IN UINT32	BinLength,
		IN OUT CHAR8 *	HexStr,
		IN OUT UINT32 *	HexLength
	)

Convert the binary encoded buffer into a hexadecimal encoded string.

Parameters

[in]	BinBuffer	The buffer containing the binary data.
[in]	BinLength	Length of the binary buffer.
[in,out]	HexStr	Pointer to the string.
[in,out]	HexLength	The length of the string.

Return values

EFI_SUCCESS	The binary data is converted to the hexadecimal string and the length of the string is updated.
EFI_BUFFER_TOO_SMALL	The string is too small.
EFI_BAD_BUFFER_SIZE	BinLength is too large for hex encoding.
EFI_INVALID_PARAMETER	The IP string is malformatted.

Definition at line 322 of file IScsiMisc.c.

◆ IScsiCleanAttemptVariable()

VOID IScsiCleanAttemptVariable ( IN VOID )

Free the attempt configure data variable.

Definition at line 1551 of file IScsiMisc.c.

◆ IScsiCleanDriverData()

EFI_STATUS IScsiCleanDriverData ( IN ISCSI_DRIVER_DATA * Private )

Clean the iSCSI driver data.

Parameters

[in] Private The iSCSI driver data.

Return values

EFI_SUCCESS	The clean operation is successful.
Others	Other errors as indicated.

Definition at line 1807 of file IScsiMisc.c.

◆ IScsiCreateAttempts()

EFI_STATUS IScsiCreateAttempts ( IN UINTN AttemptNum )

Create and initialize the Attempts.

Parameters

[in] AttemptNum The number of Attempts will be created.

Return values

EFI_SUCCESS	The Attempts have been created successfully.
Others	Failed to create the Attempt.

Definition at line 812 of file IScsiMisc.c.

◆ IScsiCreateDriverData()

ISCSI_DRIVER_DATA * IScsiCreateDriverData	(	IN EFI_HANDLE	Image,
		IN EFI_HANDLE	Controller
	)

Create the iSCSI driver data.

Parameters

[in]	Image	The handle of the driver image.
[in]	Controller	The handle of the controller.

Returns: The iSCSI driver data created.

Return values

NULL	Other errors as indicated.

Definition at line 1748 of file IScsiMisc.c.

◆ IScsiCreateKeywords()

EFI_STATUS IScsiCreateKeywords ( IN UINTN KeywordNum )

Create the iSCSI configuration Keywords for each attempt.

Parameters

[in] KeywordNum The number Sets of Keywords will be created.

Return values

EFI_SUCCESS	The operation is completed.
Others	Failed to create the Keywords.

Create the iSCSI configuration Keywords for each attempt. You can find the keywords defined in the "x-UEFI-ns" namespace (http://www.uefi.org/confignamespace).

Parameters

[in] KeywordNum The number Sets of Keywords will be created.

Return values

EFI_SUCCESS	The operation is completed.
Others	Failed to create the Keywords.

Definition at line 949 of file IScsiMisc.c.

◆ IScsiDhcpIsConfigured()

BOOLEAN IScsiDhcpIsConfigured	(	IN EFI_HANDLE	Controller,
		IN UINT8	IpVersion
	)

Check wheather the Controller handle is configured to use DHCP protocol.

Parameters

[in]	Controller	The handle of the controller.
[in]	IpVersion	IP_VERSION_4 or IP_VERSION_6.

Return values

TRUE	The handle of the controller need the Dhcp protocol.
FALSE	The handle of the controller does not need the Dhcp protocol.

Definition at line 1861 of file IScsiMisc.c.

◆ IScsiDnsIsConfigured()

BOOLEAN IScsiDnsIsConfigured ( IN EFI_HANDLE Controller )

Check wheather the Controller handle is configured to use DNS protocol.

Parameters

[in] Controller The handle of the controller.

Return values

TRUE	The handle of the controller need the DNS protocol.
FALSE	The handle of the controller does not need the DNS protocol.

Check whether the Controller handle is configured to use DNS protocol.

Parameters

[in] Controller The handle of the controller.

Return values

TRUE	The handle of the controller need the Dns protocol.
FALSE	The handle of the controller does not need the Dns protocol.

Definition at line 1964 of file IScsiMisc.c.

◆ IScsiGenRandom()

EFI_STATUS IScsiGenRandom	(	IN OUT UINT8 *	Rand,
		IN UINTN	RandLength
	)

Generate random numbers.

Parameters

[in,out]	Rand	The buffer to contain random numbers.
[in]	RandLength	The length of the Rand buffer.

Return values

EFI_SUCCESS	on success
others	on error

Definition at line 483 of file IScsiMisc.c.

◆ IScsiGetConfigData()

EFI_STATUS IScsiGetConfigData ( IN ISCSI_DRIVER_DATA * Private )

Get the various configuration data of this iSCSI instance.

Parameters

[in] Private The iSCSI driver data.

Return values

EFI_SUCCESS	Obtained the configuration of this instance.
EFI_ABORTED	The operation was aborted.
Others	Other errors as indicated.

Get the various configuration data.

Parameters

[in] Private The iSCSI driver data.

Return values

EFI_SUCCESS	The configuration data is retrieved.
EFI_NOT_FOUND	This iSCSI driver is not configured yet.
EFI_OUT_OF_RESOURCES	Failed to allocate memory.

Definition at line 2055 of file IScsiMisc.c.

◆ IScsiGetNicInfoByIndex()

ISCSI_NIC_INFO * IScsiGetNicInfoByIndex ( IN UINT8 NicIndex )

Get the recorded NIC information from a global structure by the Index.

Parameters

[in] NicIndex The index indicates the position of NIC info.

Returns: Pointer to the NIC info or NULL if not found.

Get the recorded NIC info from global structure by the Index.

Parameters

[in] NicIndex The index indicates the position of NIC info.

Returns: Pointer to the NIC info, or NULL if not found.

Definition at line 1610 of file IScsiMisc.c.

◆ IScsiGetNICPciLocation()

UINT16 IScsiGetNICPciLocation	(	IN EFI_HANDLE	Controller,
		OUT UINTN *	Bus,
		OUT UINTN *	Device,
		OUT UINTN *	Function
	)

Get the NIC's PCI location and return it according to the composited format defined in iSCSI Boot Firmware Table.

Parameters

[in]	Controller	The handle of the controller.
[out]	Bus	The bus number.
[out]	Device	The device number.
[out]	Function	The function number.

Returns: The composited representation of the NIC PCI location.

Definition at line 1640 of file IScsiMisc.c.

◆ IScsiGetSubnetMaskPrefixLength()

UINT8 IScsiGetSubnetMaskPrefixLength ( IN EFI_IPv4_ADDRESS * SubnetMask )

Calculate the prefix length of the IPv4 subnet mask.

Parameters

[in] SubnetMask The IPv4 subnet mask.

Returns: The prefix length of the subnet mask.

Return values

0	Other errors as indicated.

Definition at line 76 of file IScsiMisc.c.

◆ IScsiGetTcpConnDevicePath()

EFI_DEVICE_PATH_PROTOCOL * IScsiGetTcpConnDevicePath ( IN ISCSI_SESSION * Session )

Get the device path of the iSCSI tcp connection and update it.

Parameters

[in] Session The iSCSI session data.

Returns: The updated device path.

Return values

NULL	Other errors as indicated.

Get the device path of the iSCSI tcp connection and update it.

Parameters

Session The iSCSI session.

Returns: The updated device path.

Return values

NULL	Other errors as indicated.

Definition at line 2408 of file IScsiMisc.c.

◆ IScsiGetVariableAndSize()

VOID * IScsiGetVariableAndSize	(	IN CHAR16 *	Name,
		IN EFI_GUID *	VendorGuid,
		OUT UINTN *	VariableSize
	)

Read the EFI variable (VendorGuid/Name) and return a dynamically allocated buffer, and the size of the buffer. If failure, return NULL.

Parameters

[in]	Name	String part of EFI variable name.
[in]	VendorGuid	GUID part of EFI variable name.
[out]	VariableSize	Returns the size of the EFI variable that was read.

Returns: Dynamically allocated memory that contains a copy of the EFI variable.; Caller is responsible freeing the buffer.

Return values

NULL	Variable was not read.

Definition at line 1698 of file IScsiMisc.c.

◆ IScsiHexToBin()

EFI_STATUS IScsiHexToBin	(	IN OUT UINT8 *	BinBuffer,
		IN OUT UINT32 *	BinLength,
		IN CHAR8 *	HexStr
	)

Convert the hexadecimal string into a binary encoded buffer.

Parameters

[in,out]	BinBuffer	The binary buffer.
[in,out]	BinLength	Length of the binary buffer.
[in]	HexStr	The hexadecimal string.

Return values

EFI_SUCCESS	The hexadecimal string is converted into a binary encoded buffer.
EFI_INVALID_PARAMETER	Invalid hex encoding found in HexStr.
EFI_BAD_BUFFER_SIZE	The length of HexStr is too large for decoding: the decoded size cannot be expressed in BinLength on output.
EFI_BUFFER_TOO_SMALL	The binary buffer is too small to hold the converted data.

Definition at line 385 of file IScsiMisc.c.

◆ IScsiLunToUnicodeStr()

VOID IScsiLunToUnicodeStr	(	IN UINT8 *	Lun,
		OUT CHAR16 *	Str
	)

Convert the 64-bit LUN into the hexadecimal encoded LUN string.

Parameters

[in]	Lun	The 64-bit LUN.
[out]	String	The storage to return the hexadecimal encoded LUN string.

Convert the 64-bit LUN into the hexadecimal encoded LUN string.

Parameters

[in]	Lun	The 64-bit LUN.
[out]	Str	The storage to return the hexadecimal encoded LUN string.

Definition at line 193 of file IScsiMisc.c.

◆ IScsiMacAddrToStr()

VOID IScsiMacAddrToStr	(	IN EFI_MAC_ADDRESS *	Mac,
		IN UINT32	Len,
		IN UINT16	VlanId,
		OUT CHAR16 *	Str
	)

Convert the mac address into a hexadecimal encoded "-" separated string.

Parameters

[in]	Mac	The mac address.
[in]	Len	Length in bytes of the mac address.
[in]	VlanId	VLAN ID of the network device.
[out]	Str	The storage to return the mac string.

Definition at line 282 of file IScsiMisc.c.

◆ IScsiNetNtoi()

UINTN IScsiNetNtoi ( IN CHAR8 * Str )

Convert the decimal-constant string or hex-constant string into a numerical value.

Parameters

[in] Str String in decimal or hex.

Returns: The numerical value.

Definition at line 459 of file IScsiMisc.c.

◆ IScsiOnExitBootService()

VOID EFIAPI IScsiOnExitBootService	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

Abort the session when the transition from BS to RT is initiated.

Parameters

[in]	Event	The event signaled.
[in]	Context	The iSCSI driver data.

Definition at line 2523 of file IScsiMisc.c.

◆ IScsiRemoveNic()

EFI_STATUS IScsiRemoveNic ( IN EFI_HANDLE Controller )

Delete the recorded NIC information from a global structure. Also delete corresponding attempts.

Parameters

[in] Controller The handle of the controller.

Return values

EFI_SUCCESS	The operation completed.
EFI_NOT_FOUND	The NIC information to be deleted is not recorded.

Delete the recorded NIC info from global structure. Also delete corresponding attempts.

Parameters

[in] Controller The handle of the controller.

Return values

EFI_SUCCESS	The operation is completed.
EFI_NOT_FOUND	The NIC info to be deleted is not recorded.

Definition at line 717 of file IScsiMisc.c.

◆ IScsiTestManagedDevice()

EFI_STATUS EFIAPI IScsiTestManagedDevice	(	IN EFI_HANDLE	ControllerHandle,
		IN EFI_HANDLE	DriverBindingHandle,
		IN EFI_GUID *	ProtocolGuid
	)

Tests whether a controller handle is being managed by IScsi driver.

This function tests whether the driver specified by DriverBindingHandle is currently managing the controller specified by ControllerHandle. This test is performed by evaluating if the protocol specified by ProtocolGuid is present on ControllerHandle and is was opened by DriverBindingHandle and Nic Device handle with an attribute of EFI_OPEN_PROTOCOL_BY_DRIVER. If ProtocolGuid is NULL, then ASSERT().

Parameters

ControllerHandle	A handle for a controller to test.
DriverBindingHandle	Specifies the driver binding handle for the driver.
ProtocolGuid	Specifies the protocol that the driver specified by DriverBindingHandle opens in its Start() function.

Return values

EFI_SUCCESS	ControllerHandle is managed by the driver specified by DriverBindingHandle.
EFI_UNSUPPORTED	ControllerHandle is not managed by the driver specified by DriverBindingHandle.

Definition at line 2565 of file IScsiMisc.c.

Data Structures

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ IP4_NODE_LEN_NEW_VERSIONS

◆ IP6_NODE_LEN_NEW_VERSIONS

◆ IP6_NODE_LEN_OLD_VERSIONS

◆ IP6_OLD_IPADDRESS_OFFSET

Typedef Documentation

◆ ISCSI_DRIVER_DATA

Function Documentation

◆ IScsiAddNic()

◆ IScsiAsciiStrToIp()

◆ IScsiAsciiStrToLun()

◆ IScsiBinToHex()

◆ IScsiCleanAttemptVariable()

◆ IScsiCleanDriverData()

◆ IScsiCreateAttempts()

◆ IScsiCreateDriverData()

◆ IScsiCreateKeywords()

◆ IScsiDhcpIsConfigured()

◆ IScsiDnsIsConfigured()

◆ IScsiGenRandom()

◆ IScsiGetConfigData()

◆ IScsiGetNicInfoByIndex()

◆ IScsiGetNICPciLocation()

◆ IScsiGetSubnetMaskPrefixLength()

◆ IScsiGetTcpConnDevicePath()

◆ IScsiGetVariableAndSize()

◆ IScsiHexToBin()

◆ IScsiLunToUnicodeStr()

◆ IScsiMacAddrToStr()

◆ IScsiNetNtoi()

◆ IScsiOnExitBootService()

◆ IScsiRemoveNic()

◆ IScsiTestManagedDevice()