tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add BlockIO revision 3 definition. Add new API ScsiInquiryCommandEx to UefiScsiLib. 

Signed-off-by: niruiyu
Reviewed-by: erictian

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@11691 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
niruiyu 2011-05-23 07:45:40 +00:00
parent afe3969cdc
commit b8a62661e4
4 changed files with 311 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
MdePkg/Include/IndustryStandard/Scsi.h
View File

@ -1,7 +1,7 @@
/** @file /** @file
Support for SCSI-2 standard Support for SCSI-2 standard
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR> Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at
@ -194,6 +194,12 @@
// //
#define EFI_SCSI_TYPE_UNKNOWN 0x1F ///< Unknown or no device type #define EFI_SCSI_TYPE_UNKNOWN 0x1F ///< Unknown or no device type
//
// Page Codes for INQUIRY command
//
#define EFI_SCSI_PAGE_CODE_SUPPORTED_VPD 0x00
#define EFI_SCSI_PAGE_CODE_BLOCK_LIMITS_VPD 0xB0
#pragma pack(1) #pragma pack(1)
/// ///
/// Standard INQUIRY data format /// Standard INQUIRY data format
@ -209,6 +215,44 @@ typedef struct {
UINT8 Reserved_5_95[95 - 5 + 1]; UINT8 Reserved_5_95[95 - 5 + 1];
} EFI_SCSI_INQUIRY_DATA; } EFI_SCSI_INQUIRY_DATA;
///
/// Supported VPD Pages VPD page
///
typedef struct {
UINT8 Peripheral_Type : 5;
UINT8 Peripheral_Qualifier : 3;
UINT8 PageCode;
UINT8 PageLength2;
UINT8 PageLength1;
UINT8 SupportedVpdPageList[0x100];
} EFI_SCSI_SUPPORTED_VPD_PAGES_VPD_PAGE;
///
/// Block Limits VPD page
///
typedef struct {
UINT8 Peripheral_Type : 5;
UINT8 Peripheral_Qualifier : 3;
UINT8 PageCode;
UINT8 Reserved_2;
UINT8 PageLength;
UINT8 Reserved_4_5[2];
UINT8 OptimalTransferLengthGranularity2;
UINT8 OptimalTransferLengthGranularity1;
UINT8 MaximumTransferLength4;
UINT8 MaximumTransferLength3;
UINT8 MaximumTransferLength2;
UINT8 MaximumTransferLength1;
UINT8 OptimalTransferLength4;
UINT8 OptimalTransferLength3;
UINT8 OptimalTransferLength2;
UINT8 OptimalTransferLength1;
UINT8 MaximumPrefetchXdreadXdwriteTransferLength4;
UINT8 MaximumPrefetchXdreadXdwriteTransferLength3;
UINT8 MaximumPrefetchXdreadXdwriteTransferLength2;
UINT8 MaximumPrefetchXdreadXdwriteTransferLength1;
} EFI_SCSI_BLOCK_LIMITS_VPD_PAGE;
/// ///
/// Error codes 70h and 71h sense data format /// Error codes 70h and 71h sense data format
/// ///

98
MdePkg/Include/Library/UefiScsiLib.h
View File

@ -5,7 +5,7 @@
for hard drive, CD and DVD devices that are the most common SCSI boot targets used by UEFI platforms. for hard drive, CD and DVD devices that are the most common SCSI boot targets used by UEFI platforms.
This library class depends on SCSI I/O Protocol defined in UEFI Specification and SCSI-2 industry standard. This library class depends on SCSI I/O Protocol defined in UEFI Specification and SCSI-2 industry standard.
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR> Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at
@ -189,6 +189,102 @@ ScsiInquiryCommand (
); );
/**
Execute Inquiry SCSI command on a specific SCSI target.
Executes the Inquiry command on the SCSI target specified by ScsiIo.
If Timeout is zero, then this function waits indefinitely for the command to complete.
If Timeout is greater than zero, then the command is executed and will timeout after Timeout 100 ns units.
If ScsiIo is NULL, then ASSERT().
If SenseDataLength is NULL, then ASSERT().
If HostAdapterStatus is NULL, then ASSERT().
If TargetStatus is NULL, then ASSERT().
If InquiryDataLength is NULL, then ASSERT().
@param[in] ScsiIo A pointer to the SCSI I/O Protocol instance
for the specific SCSI target.
@param[in] Timeout The timeout in 100 ns units to use for the
execution of this SCSI Request Packet. A Timeout
value of zero 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.
@param[in, out] SenseData A pointer to sense data that was generated
by the execution of the SCSI Request Packet.
This buffer must be allocated by the caller.
If SenseDataLength is 0, then this parameter
is optional and may be NULL.
@param[in, out] SenseDataLength On input, the length in bytes of the SenseData buffer.
On output, the number of bytes written to the SenseData buffer.
@param[out] HostAdapterStatus The status of the SCSI Host Controller that
produces the SCSI bus containing the SCSI
target specified by ScsiIo when the SCSI
Request Packet was executed. See the EFI
SCSI I/O Protocol in the UEFI Specification
for details on the possible return values.
@param[out] TargetStatus The status returned by the SCSI target specified
by ScsiIo when the SCSI Request Packet was
executed on the SCSI Host Controller.
See the EFI SCSI I/O Protocol in the UEFI
Specification for details on the possible
return values.
@param[in, out] InquiryDataBuffer A pointer to inquiry data that was generated
by the execution of the SCSI Request Packet.
This buffer must be allocated by the caller.
If InquiryDataLength is 0, then this parameter
is optional and may be NULL.
@param[in, out] InquiryDataLength On input, a pointer to the length in bytes
of the InquiryDataBuffer buffer.
On output, a pointer to the number of bytes
written to the InquiryDataBuffer buffer.
@param[in] EnableVitalProductData If TRUE, then the supported vital product
data for the PageCode is returned in InquiryDataBuffer.
If FALSE, then the standard inquiry data is
returned in InquiryDataBuffer and PageCode is ignored.
@param[in] PageCode The page code of the vital product data.
It's ignored if EnableVitalProductData is FALSE.
@retval EFI_SUCCESS The command executed successfully. See HostAdapterStatus,
TargetStatus, SenseDataLength, and SenseData in that order
for additional status information.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the entire
InquiryDataBuffer could not be transferred. The actual
number of bytes transferred is returned in InquiryDataLength.
@retval EFI_NOT_READY The SCSI Request Packet could not be sent because there
are too many SCSI Command Packets already queued.
The SCSI Request Packet was not sent, so no additional
status information is available. The caller may retry again later.
@retval EFI_DEVICE_ERROR A device error occurred while attempting to send SCSI
Request Packet. See HostAdapterStatus, TargetStatus,
SenseDataLength, and SenseData in that order for additional
status information.
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not
supported by the SCSI initiator(i.e., SCSI Host Controller).
The SCSI Request Packet was not sent, so no additional
status information is available.
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request
Packet to execute. See HostAdapterStatus, TargetStatus,
SenseDataLength, and SenseData in that order for
additional status information.
**/
EFI_STATUS
EFIAPI
ScsiInquiryCommandEx (
IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
IN UINT64 Timeout,
IN OUT VOID *SenseData, OPTIONAL
IN OUT UINT8 *SenseDataLength,
OUT UINT8 *HostAdapterStatus,
OUT UINT8 *TargetStatus,
IN OUT VOID *InquiryDataBuffer, OPTIONAL
IN OUT UINT32 *InquiryDataLength,
IN BOOLEAN EnableVitalProductData,
IN UINT8 PageCode
);
/** /**
Execute Mode Sense(10) SCSI command on a specific SCSI target. Execute Mode Sense(10) SCSI command on a specific SCSI target.

10
MdePkg/Include/Protocol/BlockIo.h
View File

@ -4,7 +4,7 @@
The Block IO protocol is used to abstract block devices like hard drives, The Block IO protocol is used to abstract block devices like hard drives,
DVD-ROMs and floppy drives. DVD-ROMs and floppy drives.
Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR> Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at
@ -196,10 +196,18 @@ typedef struct {
/// per physical block. /// per physical block.
/// ///
UINT32 LogicalBlocksPerPhysicalBlock; UINT32 LogicalBlocksPerPhysicalBlock;
///
/// Only present if EFI_BLOCK_IO_PROTOCOL.Revision is greater than or equal to
/// EFI_BLOCK_IO_PROTOCOL_REVISION3. Returns the optimal transfer length
/// granularity as a number of logical blocks.
///
UINT32 OptimalTransferLengthGranularity;
} EFI_BLOCK_IO_MEDIA; } EFI_BLOCK_IO_MEDIA;
#define EFI_BLOCK_IO_PROTOCOL_REVISION 0x00010000 #define EFI_BLOCK_IO_PROTOCOL_REVISION 0x00010000
#define EFI_BLOCK_IO_PROTOCOL_REVISION2 0x00020001 #define EFI_BLOCK_IO_PROTOCOL_REVISION2 0x00020001
#define EFI_BLOCK_IO_PROTOCOL_REVISION3 0x00020031
/// ///
/// Revision defined in EFI1.1. /// Revision defined in EFI1.1.

210
MdePkg/Library/UefiScsiLib/UefiScsiLib.c
View File

@ -1,7 +1,7 @@
/** @file /** @file
UEFI SCSI Library implementation UEFI SCSI Library implementation
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR> Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at
@ -159,6 +159,153 @@ ScsiTestUnitReadyCommand (
} }
/**
Execute Inquiry SCSI command on a specific SCSI target.
Executes the Inquiry command on the SCSI target specified by ScsiIo.
If Timeout is zero, then this function waits indefinitely for the command to complete.
If Timeout is greater than zero, then the command is executed and will timeout after Timeout 100 ns units.
If ScsiIo is NULL, then ASSERT().
If SenseDataLength is NULL, then ASSERT().
If HostAdapterStatus is NULL, then ASSERT().
If TargetStatus is NULL, then ASSERT().
If InquiryDataLength is NULL, then ASSERT().
@param[in] ScsiIo A pointer to the SCSI I/O Protocol instance
for the specific SCSI target.
@param[in] Timeout The timeout in 100 ns units to use for the
execution of this SCSI Request Packet. A Timeout
value of zero 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.
@param[in, out] SenseData A pointer to sense data that was generated
by the execution of the SCSI Request Packet.
This buffer must be allocated by the caller.
If SenseDataLength is 0, then this parameter
is optional and may be NULL.
@param[in, out] SenseDataLength On input, the length in bytes of the SenseData buffer.
On output, the number of bytes written to the SenseData buffer.
@param[out] HostAdapterStatus The status of the SCSI Host Controller that
produces the SCSI bus containing the SCSI
target specified by ScsiIo when the SCSI
Request Packet was executed. See the EFI
SCSI I/O Protocol in the UEFI Specification
for details on the possible return values.
@param[out] TargetStatus The status returned by the SCSI target specified
by ScsiIo when the SCSI Request Packet was
executed on the SCSI Host Controller.
See the EFI SCSI I/O Protocol in the UEFI
Specification for details on the possible
return values.
@param[in, out] InquiryDataBuffer A pointer to inquiry data that was generated
by the execution of the SCSI Request Packet.
This buffer must be allocated by the caller.
If InquiryDataLength is 0, then this parameter
is optional and may be NULL.
@param[in, out] InquiryDataLength On input, a pointer to the length in bytes
of the InquiryDataBuffer buffer.
On output, a pointer to the number of bytes
written to the InquiryDataBuffer buffer.
@param[in] EnableVitalProductData If TRUE, then the supported vital product
data for the PageCode is returned in InquiryDataBuffer.
If FALSE, then the standard inquiry data is
returned in InquiryDataBuffer and PageCode is ignored.
@param[in] PageCode The page code of the vital product data.
It's ignored if EnableVitalProductData is FALSE.
@retval EFI_SUCCESS The command executed successfully. See HostAdapterStatus,
TargetStatus, SenseDataLength, and SenseData in that order
for additional status information.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the entire
InquiryDataBuffer could not be transferred. The actual
number of bytes transferred is returned in InquiryDataLength.
@retval EFI_NOT_READY The SCSI Request Packet could not be sent because there
are too many SCSI Command Packets already queued.
The SCSI Request Packet was not sent, so no additional
status information is available. The caller may retry again later.
@retval EFI_DEVICE_ERROR A device error occurred while attempting to send SCSI
Request Packet. See HostAdapterStatus, TargetStatus,
SenseDataLength, and SenseData in that order for additional
status information.
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not
supported by the SCSI initiator(i.e., SCSI Host Controller).
The SCSI Request Packet was not sent, so no additional
status information is available.
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request
Packet to execute. See HostAdapterStatus, TargetStatus,
SenseDataLength, and SenseData in that order for
additional status information.
**/
EFI_STATUS
EFIAPI
ScsiInquiryCommandEx (
IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
IN UINT64 Timeout,
IN OUT VOID *SenseData, OPTIONAL
IN OUT UINT8 *SenseDataLength,
OUT UINT8 *HostAdapterStatus,
OUT UINT8 *TargetStatus,
IN OUT VOID *InquiryDataBuffer, OPTIONAL
IN OUT UINT32 *InquiryDataLength,
IN BOOLEAN EnableVitalProductData,
IN UINT8 PageCode
)
{
EFI_SCSI_IO_SCSI_REQUEST_PACKET CommandPacket;
UINT64 Lun;
UINT8 *Target;
UINT8 TargetArray[EFI_SCSI_TARGET_MAX_BYTES];
EFI_STATUS Status;
UINT8 Cdb[EFI_SCSI_OP_LENGTH_SIX];
ASSERT (SenseDataLength != NULL);
ASSERT (HostAdapterStatus != NULL);
ASSERT (TargetStatus != NULL);
ASSERT (InquiryDataLength != NULL);
ASSERT (ScsiIo != NULL);
ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET));
ZeroMem (Cdb, EFI_SCSI_OP_LENGTH_SIX);
CommandPacket.Timeout = Timeout;
CommandPacket.InDataBuffer = InquiryDataBuffer;
CommandPacket.InTransferLength= *InquiryDataLength;
CommandPacket.SenseData = SenseData;
CommandPacket.SenseDataLength = *SenseDataLength;
CommandPacket.Cdb = Cdb;
Target = &TargetArray[0];
ScsiIo->GetDeviceLocation (ScsiIo, &Target, &Lun);
Cdb[0] = EFI_SCSI_OP_INQUIRY;
Cdb[1] = (UINT8) (LShiftU64 (Lun, 5) & EFI_SCSI_LOGICAL_UNIT_NUMBER_MASK);
if (EnableVitalProductData) {
Cdb[1] |= 0x01;
Cdb[2] = PageCode;
}
if (*InquiryDataLength > 0xff) {
*InquiryDataLength = 0xff;
}
Cdb[4] = (UINT8) (*InquiryDataLength);
CommandPacket.CdbLength = (UINT8) EFI_SCSI_OP_LENGTH_SIX;
CommandPacket.DataDirection = EFI_SCSI_DATA_IN;
Status = ScsiIo->ExecuteScsiCommand (ScsiIo, &CommandPacket, NULL);
*HostAdapterStatus = CommandPacket.HostAdapterStatus;
*TargetStatus = CommandPacket.TargetStatus;
*SenseDataLength = CommandPacket.SenseDataLength;
*InquiryDataLength = CommandPacket.InTransferLength;
return Status;
}
/** /**
Execute Inquiry SCSI command on a specific SCSI target. Execute Inquiry SCSI command on a specific SCSI target.
@ -251,57 +398,20 @@ ScsiInquiryCommand (
IN BOOLEAN EnableVitalProductData IN BOOLEAN EnableVitalProductData
) )
{ {
EFI_SCSI_IO_SCSI_REQUEST_PACKET CommandPacket; return ScsiInquiryCommandEx (
UINT64 Lun; ScsiIo,
UINT8 *Target; Timeout,
UINT8 TargetArray[EFI_SCSI_TARGET_MAX_BYTES]; SenseData,
EFI_STATUS Status; SenseDataLength,
UINT8 Cdb[EFI_SCSI_OP_LENGTH_SIX]; HostAdapterStatus,
TargetStatus,
ASSERT (SenseDataLength != NULL); InquiryDataBuffer,
ASSERT (HostAdapterStatus != NULL); InquiryDataLength,
ASSERT (TargetStatus != NULL); EnableVitalProductData,
ASSERT (InquiryDataLength != NULL); 0
ASSERT (ScsiIo != NULL); );
ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET));
ZeroMem (Cdb, EFI_SCSI_OP_LENGTH_SIX);
CommandPacket.Timeout = Timeout;
CommandPacket.InDataBuffer = InquiryDataBuffer;
CommandPacket.InTransferLength= *InquiryDataLength;
CommandPacket.SenseData = SenseData;
CommandPacket.SenseDataLength = *SenseDataLength;
CommandPacket.Cdb = Cdb;
Target = &TargetArray[0];
ScsiIo->GetDeviceLocation (ScsiIo, &Target, &Lun);
Cdb[0] = EFI_SCSI_OP_INQUIRY;
Cdb[1] = (UINT8) (LShiftU64 (Lun, 5) & EFI_SCSI_LOGICAL_UNIT_NUMBER_MASK);
if (EnableVitalProductData) {
Cdb[1] |= 0x01;
}
if (*InquiryDataLength > 0xff) {
*InquiryDataLength = 0xff;
}
Cdb[4] = (UINT8) (*InquiryDataLength);
CommandPacket.CdbLength = (UINT8) EFI_SCSI_OP_LENGTH_SIX;
CommandPacket.DataDirection = EFI_SCSI_DATA_IN;
Status = ScsiIo->ExecuteScsiCommand (ScsiIo, &CommandPacket, NULL);
*HostAdapterStatus = CommandPacket.HostAdapterStatus;
*TargetStatus = CommandPacket.TargetStatus;
*SenseDataLength = CommandPacket.SenseDataLength;
*InquiryDataLength = CommandPacket.InTransferLength;
return Status;
} }
/** /**
Execute Mode Sense(10) SCSI command on a specific SCSI target. Execute Mode Sense(10) SCSI command on a specific SCSI target.