IScsiExtScsiPassThru.c File Reference

#include "IScsiImpl.h"

Go to the source code of this file.

Functions
EFI_STATUS EFIAPI	IScsiExtScsiPassThruFunction (IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, IN UINT8 *Target, IN UINT64 Lun, IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet, IN EFI_EVENT Event OPTIONAL)
EFI_STATUS EFIAPI	IScsiExtScsiPassThruGetNextTargetLun (IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, IN OUT UINT8 **Target, IN OUT UINT64 *Lun)
EFI_STATUS EFIAPI	IScsiExtScsiPassThruBuildDevicePath (IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, IN UINT8 *Target, IN UINT64 Lun, IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath)
EFI_STATUS EFIAPI	IScsiExtScsiPassThruGetTargetLun (IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, IN EFI_DEVICE_PATH_PROTOCOL *DevicePath, OUT UINT8 **Target, OUT UINT64 *Lun)
EFI_STATUS EFIAPI	IScsiExtScsiPassThruResetChannel (IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This)
EFI_STATUS EFIAPI	IScsiExtScsiPassThruResetTargetLun (IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, IN UINT8 *Target, IN UINT64 Lun)
EFI_STATUS EFIAPI	IScsiExtScsiPassThruGetNextTarget (IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, IN OUT UINT8 **Target)

Variables
EFI_EXT_SCSI_PASS_THRU_PROTOCOL	gIScsiExtScsiPassThruProtocolTemplate

Detailed Description

The implementation of EFI_EXT_SCSI_PASS_THRU_PROTOCOL.

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

Definition in file IScsiExtScsiPassThru.c.

Function Documentation

IScsiExtScsiPassThruBuildDevicePath()

EFI_STATUS EFIAPI IScsiExtScsiPassThruBuildDevicePath	(	IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *	This,
		IN UINT8 *	Target,
		IN UINT64	Lun,
		IN OUT EFI_DEVICE_PATH_PROTOCOL **	DevicePath
	)

Allocate and build a device path node for a SCSI device on a SCSI channel.

Parameters

[in]	This	Protocol instance pointer.
[in]	Target	The Target ID of the SCSI device for which a device path node is to be allocated and built.
[in]	Lun	The LUN of the SCSI device for which a device path node is to be allocated and built.
[in,out]	DevicePath	A pointer to a single device path node that describes the SCSI device specified by Target and Lun. This function is responsible for allocating the buffer DevicePath with the boot service AllocatePool(). It is the caller's responsibility to free DevicePath when the caller is finished with DevicePath.

Return values

EFI_SUCCESS	The device path node that describes the SCSI device specified by Target and Lun was allocated and returned in DevicePath.
EFI_NOT_FOUND	The SCSI devices specified by Target and Lun does not exist on the SCSI channel.
EFI_INVALID_PARAMETER	DevicePath is NULL.
EFI_OUT_OF_RESOURCES	There are not enough resources to allocate DevicePath.

Definition at line 199 of file IScsiExtScsiPassThru.c.

IScsiExtScsiPassThruFunction()

EFI_STATUS EFIAPI IScsiExtScsiPassThruFunction	(	IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *	This,
		IN UINT8 *	Target,
		IN UINT64	Lun,
		IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *	Packet,
		IN EFI_EVENT Event	OPTIONAL
	)

Sends a SCSI Request Packet to a SCSI device that is attached to the SCSI channel. This function supports both blocking I/O and nonblocking I/O. The blocking I/O functionality is required, and the nonblocking I/O functionality is optional.

Parameters

[in]	This	A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
[in]	Target	The Target is an array of size TARGET_MAX_BYTES and it represents the id of the SCSI device to send the SCSI Request Packet. Each transport driver may choose to utilize a subset of this size to suit the needs of transport target representation. For example, a Fibre Channel driver may use only 8 bytes (WWN) to represent an FC target.
[in]	Lun	The LUN of the SCSI device to send the SCSI Request Packet.
[in,out]	Packet	A pointer to the SCSI Request Packet to send to the SCSI device specified by Target and Lun.
[in]	Event	If nonblocking I/O is not supported then Event is ignored, and blocking I/O is performed. If Event is NULL, then blocking I/O is performed. If Event is not NULL and non blocking I/O is supported, then nonblocking I/O is performed, and Event will be signaled when the SCSI Request Packet completes.

Return values

EFI_SUCCESS	The SCSI Request Packet was sent by the host. For bi-directional commands, InTransferLength bytes were transferred from InDataBuffer. For write and bi-directional commands, OutTransferLength bytes were transferred by OutDataBuffer.
EFI_BAD_BUFFER_SIZE	The SCSI Request Packet was not executed. The number of bytes that could be transferred is returned in InTransferLength. For write and bi-directional commands, OutTransferLength bytes were transferred by OutDataBuffer.
EFI_NOT_READY	The SCSI Request Packet could not be sent because there are too many SCSI Request Packets already queued. The caller may retry later.
EFI_DEVICE_ERROR	A device error occurred while attempting to send the SCSI Request Packet.
EFI_INVALID_PARAMETER	Target, Lun, or the contents of ScsiRequestPacket, are invalid.
EFI_UNSUPPORTED	The command described by the SCSI Request Packet is not supported by the host adapter. This includes the case of Bi-directional SCSI commands not supported by the implementation. The SCSI Request Packet was not sent, so no additional status information is available.
EFI_TIMEOUT	A timeout occurred while waiting for the SCSI Request Packet to execute.

Definition at line 74 of file IScsiExtScsiPassThru.c.

IScsiExtScsiPassThruGetNextTarget()

EFI_STATUS EFIAPI IScsiExtScsiPassThruGetNextTarget	(	IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *	This,
		IN OUT UINT8 **	Target
	)

Retrieve the list of legal Target IDs for SCSI devices on a SCSI channel.

Parameters

[in]	This	A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
[in,out]	Target	(TARGET_MAX_BYTES) of a SCSI device present on the SCSI channel. On output, a pointer to the Target ID (an array of TARGET_MAX_BYTES) of the next SCSI device present on a SCSI channel. An input value of 0xF(all bytes in the array are 0xF) in the Target array retrieves the Target ID of the first SCSI device present on a SCSI channel.

Return values

EFI_SUCCESS	The Target ID of the next SCSI device on the SCSI channel was returned in Target.
EFI_INVALID_PARAMETER	Target or Lun is NULL.
EFI_TIMEOUT	Target array is not all 0xF, and Target was not returned on a previous call to GetNextTarget().
EFI_NOT_FOUND	There are no more SCSI devices on this SCSI channel.

Definition at line 397 of file IScsiExtScsiPassThru.c.

IScsiExtScsiPassThruGetNextTargetLun()

EFI_STATUS EFIAPI IScsiExtScsiPassThruGetNextTargetLun	(	IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *	This,
		IN OUT UINT8 **	Target,
		IN OUT UINT64 *	Lun
	)

Used to retrieve the list of legal Target IDs and LUNs for SCSI devices on a SCSI channel. These can either be the list SCSI devices that are actually present on the SCSI channel, or the list of legal Target Ids and LUNs for the SCSI channel. Regardless, the caller of this function must probe the Target ID and LUN returned to see if a SCSI device is actually present at that location on the SCSI channel.

Parameters

[in]	This	The EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
[in,out]	Target	On input, a pointer to the Target ID of a SCSI device present on the SCSI channel. On output, a pointer to the Target ID of the next SCSI device present on a SCSI channel. An input value of 0xFFFFFFFF retrieves the Target ID of the first SCSI device present on a SCSI channel.
[in,out]	Lun	On input, a pointer to the LUN of a SCSI device present on the SCSI channel. On output, a pointer to the LUN of the next SCSI device present on a SCSI channel.

Return values

EFI_SUCCESS	The Target ID and Lun of the next SCSI device on the SCSI channel was returned in Target and Lun.
EFI_NOT_FOUND	There are no more SCSI devices on this SCSI channel.
EFI_INVALID_PARAMETER	Target is not 0xFFFFFFFF,and Target and Lun were not returned on a previous call to GetNextDevice().

Definition at line 140 of file IScsiExtScsiPassThru.c.

IScsiExtScsiPassThruGetTargetLun()

EFI_STATUS EFIAPI IScsiExtScsiPassThruGetTargetLun	(	IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *	This,
		IN EFI_DEVICE_PATH_PROTOCOL *	DevicePath,
		OUT UINT8 **	Target,
		OUT UINT64 *	Lun
	)

Translate a device path node to a Target ID and LUN.

Parameters

[in]	This	Protocol instance pointer.
[in]	DevicePath	A pointer to the device path node that describes a SCSI device on the SCSI channel.
[out]	Target	A pointer to the Target ID of a SCSI device on the SCSI channel.
[out]	Lun	A pointer to the LUN of a SCSI device on the SCSI channel.

Return values

EFI_SUCCESS	DevicePath was successfully translated to a Target ID and LUN, and they were returned in Target and Lun.
EFI_INVALID_PARAMETER	DevicePath/Target/Lun is NULL.
EFI_UNSUPPORTED	This driver does not support the device path node type in DevicePath.
EFI_NOT_FOUND	A valid translation does not exist from DevicePath to a TargetID and LUN.

Definition at line 298 of file IScsiExtScsiPassThru.c.

IScsiExtScsiPassThruResetChannel()

EFI_STATUS EFIAPI IScsiExtScsiPassThruResetChannel

(

IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *

This

)

Resets a SCSI channel. This operation resets all the SCSI devices connected to the SCSI channel.

Parameters

[in]

This

Protocol instance pointer.

Return values

EFI_UNSUPPORTED

It is not supported.

Definition at line 346 of file IScsiExtScsiPassThru.c.

IScsiExtScsiPassThruResetTargetLun()

EFI_STATUS EFIAPI IScsiExtScsiPassThruResetTargetLun	(	IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *	This,
		IN UINT8 *	Target,
		IN UINT64	Lun
	)

Resets a SCSI device that is connected to a SCSI channel.

Parameters

[in]	This	Protocol instance pointer.
[in]	Target	The Target ID of the SCSI device to reset.
[in]	Lun	The LUN of the SCSI device to reset.

Return values

EFI_UNSUPPORTED

It is not supported.

Definition at line 365 of file IScsiExtScsiPassThru.c.

Variable Documentation

gIScsiExtScsiPassThruProtocolTemplate

EFI_EXT_SCSI_PASS_THRU_PROTOCOL gIScsiExtScsiPassThruProtocolTemplate

Initial value:

= {
  NULL,
  IScsiExtScsiPassThruFunction,
  IScsiExtScsiPassThruGetNextTargetLun,
  IScsiExtScsiPassThruBuildDevicePath,
  IScsiExtScsiPassThruGetTargetLun,
  IScsiExtScsiPassThruResetChannel,
  IScsiExtScsiPassThruResetTargetLun,
  IScsiExtScsiPassThruGetNextTarget
}

Definition at line 11 of file IScsiExtScsiPassThru.c.