X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdePkg%2FInclude%2FProtocol%2FScsiPassThruExt.h;h=6c7959e64278430ad8e156d141e796983bb3d0b8;hp=eae16ad3f1651252b2004d8087a008812430d037;hb=9095d37b8fe5bfc3d02adad6ba7fd7359ebc0107;hpb=ed66e1bc0d2be0a185fc47adab4930c3b7e2767f diff --git a/MdePkg/Include/Protocol/ScsiPassThruExt.h b/MdePkg/Include/Protocol/ScsiPassThruExt.h index eae16ad3f1..6c7959e642 100644 --- a/MdePkg/Include/Protocol/ScsiPassThruExt.h +++ b/MdePkg/Include/Protocol/ScsiPassThruExt.h @@ -1,16 +1,16 @@ /** @file EFI_EXT_SCSI_PASS_THRU_PROTOCOL as defined in UEFI 2.0. - This protocol provides services that allow SCSI Pass Thru commands + This protocol provides services that allow SCSI Pass Thru commands to be sent to SCSI devices attached to a SCSI channel. - Copyright (c) 2006 - 2008, Intel Corporation - All rights reserved. This program and the accompanying materials - are licensed and made available under the terms and conditions of the BSD License - which accompanies this distribution. The full text of the license may be found at - http://opensource.org/licenses/bsd-license.php + Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+ This program and the accompanying materials + are licensed and made available under the terms and conditions of the BSD License + which accompanies this distribution. The full text of the license may be found at + http://opensource.org/licenses/bsd-license.php - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -19,7 +19,7 @@ #define EFI_EXT_SCSI_PASS_THRU_PROTOCOL_GUID \ { \ - 0x1d3de7f0, 0x0807, 0x424f, {0xaa, 0x69, 0x11, 0xa5, 0x4e, 0x19, 0xa4, 0x6f } \ + 0x143b7632, 0xb81b, 0x4cb7, {0xab, 0xd3, 0xb6, 0x25, 0xa5, 0xb9, 0xbf, 0xfe } \ } typedef struct _EFI_EXT_SCSI_PASS_THRU_PROTOCOL EFI_EXT_SCSI_PASS_THRU_PROTOCOL; @@ -66,35 +66,96 @@ typedef struct _EFI_EXT_SCSI_PASS_THRU_PROTOCOL EFI_EXT_SCSI_PASS_THRU_PROTOCOL; #define EFI_EXT_SCSI_STATUS_TARGET_TASK_ABORTED 0x40 typedef struct { + /// + /// The Target ID of the host adapter on the SCSI channel. + /// UINT32 AdapterId; + /// + /// Additional information on the attributes of the SCSI channel. + /// UINT32 Attributes; + /// + /// Supplies the alignment requirement for any buffer used in a data transfer. + /// UINT32 IoAlign; } EFI_EXT_SCSI_PASS_THRU_MODE; typedef struct { + /// + /// The timeout, in 100 ns units, to use for the execution of this SCSI + /// Request Packet. A Timeout value of 0 means that this function + /// will wait indefinitely for the SCSI Request Packet to execute. If + /// Timeout is greater than zero, then this function will return + /// EFI_TIMEOUT if the time required to execute the SCSI + /// Request Packet is greater than Timeout. + /// UINT64 Timeout; + /// + /// A pointer to the data buffer to transfer between the SCSI + /// controller and the SCSI device for read and bidirectional commands. + /// VOID *InDataBuffer; + /// + /// A pointer to the data buffer to transfer between the SCSI + /// controller and the SCSI device for write or bidirectional commands. + /// VOID *OutDataBuffer; + /// + /// A pointer to the sense data that was generated by the execution of + /// the SCSI Request Packet. + /// VOID *SenseData; + /// + /// A pointer to buffer that contains the Command Data Block to + /// send to the SCSI device specified by Target and Lun. + /// VOID *Cdb; + /// + /// On Input, the size, in bytes, of InDataBuffer. On output, the + /// number of bytes transferred between the SCSI controller and the SCSI device. + /// UINT32 InTransferLength; + /// + /// On Input, the size, in bytes of OutDataBuffer. On Output, the + /// Number of bytes transferred between SCSI Controller and the SCSI device. + /// UINT32 OutTransferLength; + /// + /// The length, in bytes, of the buffer Cdb. The standard values are 6, + /// 10, 12, and 16, but other values are possible if a variable length CDB is used. + /// UINT8 CdbLength; + /// + /// The direction of the data transfer. 0 for reads, 1 for writes. A + /// value of 2 is Reserved for Bi-Directional SCSI commands. + /// UINT8 DataDirection; + /// + /// The status of the host adapter specified by This when the SCSI + /// Request Packet was executed on the target device. + /// UINT8 HostAdapterStatus; + /// + /// The status returned by the device specified by Target and Lun + /// when the SCSI Request Packet was executed. + /// UINT8 TargetStatus; + /// + /// On input, the length in bytes of the SenseData buffer. On + /// output, the number of bytes written to the SenseData buffer. + /// UINT8 SenseDataLength; } EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET; /** - Sends a SCSI Request Packet to a SCSI device that is attached to the SCSI channel. This function + 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. + nonblocking I/O functionality is optional. @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. @param 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 chose to utilize a subset of this size to suit the needs + 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. @param Lun The LUN of the SCSI device to send the SCSI Request Packet. @@ -135,14 +196,14 @@ EFI_STATUS IN UINT64 Lun, IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet, IN EFI_EVENT Event OPTIONAL - ); + ); /** - Used to retrieve the list of legal Target IDs and LUNs for SCSI devices on a SCSI channel. These + 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. + 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. @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. @param Target On input, a pointer to the Target ID (an array of size @@ -169,7 +230,7 @@ EFI_STATUS IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, IN OUT UINT8 **Target, IN OUT UINT64 *Lun - ); + ); /** Used to allocate and build a device path node for a SCSI device on a SCSI channel. @@ -205,7 +266,7 @@ EFI_STATUS IN UINT8 *Target, IN UINT64 Lun, IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath - ); + ); /** Used to translate a device path node to a Target ID and LUN. @@ -233,7 +294,7 @@ EFI_STATUS IN EFI_DEVICE_PATH_PROTOCOL *DevicePath, OUT UINT8 **Target, OUT UINT64 *Lun - ); + ); /** Resets a SCSI channel. This operation resets all the SCSI devices connected to the SCSI channel. @@ -250,8 +311,8 @@ typedef EFI_STATUS (EFIAPI *EFI_EXT_SCSI_PASS_THRU_RESET_CHANNEL)( IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This - ); - + ); + /** Resets a SCSI logical unit that is connected to a SCSI channel. @@ -277,13 +338,13 @@ EFI_STATUS IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, IN UINT8 *Target, IN UINT64 Lun - ); + ); /** - Used to retrieve the list of legal Target IDs for SCSI devices on a SCSI channel. These can either + Used to retrieve the list of legal Target IDs 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 - for the SCSI channel. Regardless, the caller of this function must probe the Target ID returned to - see if a SCSI device is actually present at that location on the SCSI channel. + for the SCSI channel. Regardless, the caller of this function must probe the Target ID returned to + see if a SCSI device is actually present at that location on the SCSI channel. @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. @param Target (TARGET_MAX_BYTES) of a SCSI device present on the SCSI channel. @@ -296,7 +357,7 @@ EFI_STATUS @retval EFI_SUCCESS The Target ID of the next SCSI device on the SCSI channel was returned in Target. @retval EFI_INVALID_PARAMETER Target or Lun is NULL. - @retval EFI_TIMEOUT Target array is not all 0xF, and Target were not + @retval EFI_TIMEOUT Target array is not all 0xF, and Target was not returned on a previous call to GetNextTarget(). @retval EFI_NOT_FOUND There are no more SCSI devices on this SCSI channel. @@ -306,40 +367,18 @@ EFI_STATUS (EFIAPI *EFI_EXT_SCSI_PASS_THRU_GET_NEXT_TARGET)( IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, IN OUT UINT8 **Target - ); - -/** - @par Protocol Description: - The EFI_EXT_SCSI_PASS_THRU_PROTOCOL provides information about a SCSI channel - and the ability to send SCI Request Packets to any SCSI device attached to - that SCSI channel. The information includes the Target ID of the host controller - on the SCSI channel and the attributes of the SCSI channel. - - @param Mode - A pointer to the EFI_EXT_SCSI_PASS_THRU_MODE data for this SCSI channel. - - @param PassThru - Sends a SCSI Request Packet to a SCSI device that is Connected to the SCSI channel. - - @param GetNextTargetLun - Retrieves the list of legal Target IDs and LUNs for the SCSI devices on a SCSI channel. - - @param BuildDevicePath - Allocates and builds a device path node for a SCSI Device on a SCSI channel. - - @param GetTargetLun - Translates a device path node to a Target ID and LUN. - - @param ResetChannel - Resets the SCSI channel. This operation resets all the SCSI devices connected to the SCSI channel. - - @param ResetTargetLun - Resets a SCSI device that is connected to the SCSI channel. - - @param GetNextTartget - Retrieves the list of legal Target IDs for the SCSI devices on a SCSI channel. -**/ + ); + +/// +/// The EFI_EXT_SCSI_PASS_THRU_PROTOCOL provides information about a SCSI channel +/// and the ability to send SCI Request Packets to any SCSI device attached to +/// that SCSI channel. The information includes the Target ID of the host controller +/// on the SCSI channel and the attributes of the SCSI channel. +/// struct _EFI_EXT_SCSI_PASS_THRU_PROTOCOL { + /// + /// A pointer to the EFI_EXT_SCSI_PASS_THRU_MODE data for this SCSI channel. + /// EFI_EXT_SCSI_PASS_THRU_MODE *Mode; EFI_EXT_SCSI_PASS_THRU_PASSTHRU PassThru; EFI_EXT_SCSI_PASS_THRU_GET_NEXT_TARGET_LUN GetNextTargetLun;