/** @file\r
- SCSI Pass Through protocol.\r
-\r
- Copyright (c) 2006, Intel Corporation \r
+ SCSI Pass Through protocol as defined in EFI 1.1.\r
+ This protocol allows information about a SCSI channel to be collected, \r
+ and allows SCSI Request Packets to be sent to any SCSI devices on a SCSI\r
+ channel even if those devices are not boot devices. This protocol is attached \r
+ to the device handle of each SCSI channel in a system that the protocol \r
+ supports, and can be used for diagnostics. It may also be used to build \r
+ a Block I/O driver for SCSI hard drives and SCSI CD-ROM or DVD drives to\r
+ allow those devices to become boot devices.\r
+\r
+ Copyright (c) 2006 - 2008, Intel Corporation \r
All rights reserved. This program and the accompanying materials \r
are licensed and made available under the terms and conditions of the BSD License \r
which accompanies this distribution. The full text of the license may be found at \r
0xa59e8fcf, 0xbda0, 0x43bb, {0x90, 0xb1, 0xd3, 0x73, 0x2e, 0xca, 0xa8, 0x77 } \\r
}\r
\r
-//\r
-// Forward reference for pure ANSI compatability\r
-//\r
+///\r
+/// Forward reference for pure ANSI compatability\r
+///\r
typedef struct _EFI_SCSI_PASS_THRU_PROTOCOL EFI_SCSI_PASS_THRU_PROTOCOL;\r
\r
#define EFI_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL 0x0001\r
#define EFI_SCSI_STATUS_TARGET_QUEUE_FULL 0x28 // queue full\r
\r
typedef struct {\r
+ ///\r
+ /// The timeout, in 100 ns units, to use for the execution of this SCSI\r
+ /// Request Packet. A Timeout value of 0 means that this function\r
+ /// will wait indefinitely for the SCSI Request Packet to execute. If\r
+ /// Timeout is greater than zero, then this function will return\r
+ /// EFI_TIMEOUT if the time required to execute the SCSI Request\r
+ /// Packet is greater than Timeout.\r
+ ///\r
UINT64 Timeout;\r
+ ///\r
+ /// A pointer to the data buffer to transfer between the SCSI\r
+ /// controller and the SCSI device. Must be aligned to the boundary\r
+ /// specified in the IoAlign field of the\r
+ /// EFI_SCSI_PASS_THRU_MODE structure.\r
+ ///\r
VOID *DataBuffer;\r
+ ///\r
+ /// A pointer to the sense data that was generated by the execution of\r
+ /// the SCSI Request Packet.\r
+ ///\r
VOID *SenseData;\r
+ ///\r
+ /// A pointer to buffer that contains the Command Data Block to\r
+ /// send to the SCSI device.\r
+ ///\r
VOID *Cdb;\r
+ ///\r
+ /// On Input, the size, in bytes, of InDataBuffer. On output, the\r
+ /// number of bytes transferred between the SCSI controller and the SCSI device.\r
+ ///\r
UINT32 TransferLength;\r
+ ///\r
+ /// The length, in bytes, of the buffer Cdb. The standard values are\r
+ /// 6, 10, 12, and 16, but other values are possible if a variable length CDB is used.\r
+ ///\r
UINT8 CdbLength;\r
+ ///\r
+ /// The direction of the data transfer. 0 for reads, 1 for writes. A\r
+ /// value of 2 is Reserved for Bi-Directional SCSI commands.\r
+ ///\r
UINT8 DataDirection;\r
+ ///\r
+ /// The status of the SCSI Host Controller that produces the SCSI\r
+ /// bus where the SCSI device attached when the SCSI Request\r
+ /// Packet was executed on the SCSI Controller.\r
+ ///\r
UINT8 HostAdapterStatus;\r
+ ///\r
+ /// The status returned by the SCSI device when the SCSI Request\r
+ /// Packet was executed.\r
+ ///\r
UINT8 TargetStatus;\r
+ ///\r
+ /// On input, the length in bytes of the SenseData buffer. On\r
+ /// output, the number of bytes written to the SenseData buffer.\r
+ ///\r
UINT8 SenseDataLength;\r
} EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET;\r
\r
typedef struct {\r
+ ///\r
+ /// A Null-terminated Unicode string that represents the printable name of the SCSI controller.\r
+ ///\r
CHAR16 *ControllerName;\r
+ ///\r
+ /// A Null-terminated Unicode string that represents the printable name of the SCSI channel.\r
+ ///\r
CHAR16 *ChannelName;\r
+ ///\r
+ /// The Target ID of the host adapter on the SCSI channel.\r
+ ///\r
UINT32 AdapterId;\r
+ ///\r
+ /// Additional information on the attributes of the SCSI channel.\r
+ ///\r
UINT32 Attributes;\r
+ ///\r
+ /// Supplies the alignment requirement for any buffer used in a data transfer.\r
+ ///\r
UINT32 IoAlign;\r
} EFI_SCSI_PASS_THRU_MODE;\r
\r
DataBuffer.See HostAdapterStatus, TargetStatus,\r
SenseDataLength,and SenseData in that order\r
for additional status information.\r
- @retval EFI_WARN_BUFFER_TOO_SMALL The SCSI Request Packet was executed, but the\r
+ @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the\r
entire DataBuffer could not be transferred.\r
The actual number of bytes transferred is returned\r
in TransferLength. See HostAdapterStatus,\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SCSI_PASS_THRU_PASSTHRU) (\r
+(EFIAPI *EFI_SCSI_PASS_THRU_PASSTHRU)(\r
IN EFI_SCSI_PASS_THRU_PROTOCOL *This,\r
IN UINT32 Target,\r
IN UINT64 Lun,\r
IN OUT EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet,\r
IN EFI_EVENT Event OPTIONAL\r
- )\r
-;\r
+ );\r
\r
/**\r
Used to retrieve the list of legal Target IDs for SCSI devices \r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SCSI_PASS_THRU_GET_NEXT_DEVICE) (\r
+(EFIAPI *EFI_SCSI_PASS_THRU_GET_NEXT_DEVICE)(\r
IN EFI_SCSI_PASS_THRU_PROTOCOL *This,\r
IN OUT UINT32 *Target,\r
IN OUT UINT64 *Lun\r
- )\r
-;\r
+ );\r
\r
/**\r
Used to allocate and build a device path node for a SCSI device \r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SCSI_PASS_THRU_BUILD_DEVICE_PATH) (\r
+(EFIAPI *EFI_SCSI_PASS_THRU_BUILD_DEVICE_PATH)(\r
IN EFI_SCSI_PASS_THRU_PROTOCOL *This,\r
IN UINT32 Target,\r
IN UINT64 Lun,\r
IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath\r
- )\r
-;\r
+ );\r
\r
/**\r
Used to translate a device path node to a Target ID and LUN.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SCSI_PASS_THRU_GET_TARGET_LUN) (\r
+(EFIAPI *EFI_SCSI_PASS_THRU_GET_TARGET_LUN)(\r
IN EFI_SCSI_PASS_THRU_PROTOCOL *This,\r
IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r
OUT UINT32 *Target,\r
OUT UINT64 *Lun\r
- )\r
-;\r
+ );\r
\r
/**\r
Resets a SCSI channel.This operation resets all the \r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SCSI_PASS_THRU_RESET_CHANNEL) (\r
+(EFIAPI *EFI_SCSI_PASS_THRU_RESET_CHANNEL)(\r
IN EFI_SCSI_PASS_THRU_PROTOCOL *This\r
- )\r
-;\r
+ );\r
\r
/**\r
Resets a SCSI device that is connected to a SCSI channel.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SCSI_PASS_THRU_RESET_TARGET) (\r
+(EFIAPI *EFI_SCSI_PASS_THRU_RESET_TARGET)(\r
IN EFI_SCSI_PASS_THRU_PROTOCOL *This,\r
IN UINT32 Target,\r
IN UINT64 Lun\r
- )\r
-;\r
-\r
+ );\r
+\r
+///\r
+/// The EFI_SCSI_PASS_THRU_PROTOCOL provides information about a SCSI channel and\r
+/// the ability to send SCI Request Packets to any SCSI device attached to that SCSI channel. The\r
+/// information includes the Target ID of the host controller on the SCSI channel, the attributes of\r
+/// the SCSI channel, the printable name for the SCSI controller, and the printable name of the\r
+/// SCSI channel.\r
+///\r
struct _EFI_SCSI_PASS_THRU_PROTOCOL {\r
+ ///\r
+ /// A pointer to the EFI_SCSI_PASS_THRU_MODE data for this SCSI channel.\r
+ ///\r
EFI_SCSI_PASS_THRU_MODE *Mode;\r
EFI_SCSI_PASS_THRU_PASSTHRU PassThru;\r
EFI_SCSI_PASS_THRU_GET_NEXT_DEVICE GetNextDevice;\r
projects / mirror_edk2.git / blobdiff