]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Library/UefiScsiLib/UefiScsiLib.c
Add back logic to encode LUN in CDB for compatibility with SCSI-2 spec, although...
[mirror_edk2.git] / MdePkg / Library / UefiScsiLib / UefiScsiLib.c
index 1458efd2f918dced2b563fe0e826611050b253d6..12af1338d3b31076da9dd88bb92e0b5251665195 100644 (file)
@@ -143,7 +143,7 @@ ScsiTestUnitReadyCommand (
   ScsiIo->GetDeviceLocation (ScsiIo, &Target, &Lun);\r
 \r
   Cdb[0]                        = EFI_SCSI_OP_TEST_UNIT_READY;\r
-  Cdb[1]                        = (UINT8) (Lun & EFI_SCSI_LOGICAL_UNIT_NUMBER_MASK);\r
+  Cdb[1]                        = (UINT8) ((Lun << 5) & EFI_SCSI_LOGICAL_UNIT_NUMBER_MASK);\r
   CommandPacket.CdbLength       = (UINT8) EFI_SCSI_OP_LENGTH_SIX;\r
   CommandPacket.SenseDataLength = *SenseDataLength;\r
 \r
@@ -276,7 +276,7 @@ ScsiInquiryCommand (
   ScsiIo->GetDeviceLocation (ScsiIo, &Target, &Lun);\r
 \r
   Cdb[0]  = EFI_SCSI_OP_INQUIRY;\r
-  Cdb[1]  = (UINT8) (Lun & EFI_SCSI_LOGICAL_UNIT_NUMBER_MASK);\r
+  Cdb[1]  = (UINT8) ((Lun << 5) & EFI_SCSI_LOGICAL_UNIT_NUMBER_MASK);\r
   if (EnableVitalProductData) {\r
     Cdb[1] |= 0x01;\r
   }\r
@@ -428,11 +428,11 @@ ScsiModeSense10Command (
   //\r
   // DBDField is in Cdb[1] bit3 of (bit7..0)\r
   //\r
-  Cdb[1]                        = (UINT8) ((Lun & EFI_SCSI_LOGICAL_UNIT_NUMBER_MASK) + ((DBDField << 3) & 0x08));\r
+  Cdb[1]                        = (UINT8) (((Lun << 5) & EFI_SCSI_LOGICAL_UNIT_NUMBER_MASK) + ((DBDField << 3) & 0x08));\r
   //\r
   // PageControl is in Cdb[2] bit7..6, PageCode is in Cdb[2] bit5..0\r
   //\r
-  Cdb[2]                        = (UINT8) ((PageControl & 0xc0) | (PageCode & 0x3f));\r
+  Cdb[2]                        = (UINT8) (((PageControl << 6) & 0xc0) | (PageCode & 0x3f));\r
   Cdb[7]                        = (UINT8) (*DataLength >> 8);\r
   Cdb[8]                        = (UINT8) (*DataLength);\r
 \r
@@ -516,7 +516,7 @@ ScsiRequestSenseCommand (
   ScsiIo->GetDeviceLocation (ScsiIo, &Target, &Lun);\r
 \r
   Cdb[0]                        = EFI_SCSI_OP_REQUEST_SENSE;\r
-  Cdb[1]                        = (UINT8) (Lun & EFI_SCSI_LOGICAL_UNIT_NUMBER_MASK);\r
+  Cdb[1]                        = (UINT8) ((Lun << 5) & EFI_SCSI_LOGICAL_UNIT_NUMBER_MASK);\r
   Cdb[4]                        = (UINT8) (*SenseDataLength);\r
 \r
   CommandPacket.CdbLength       = (UINT8) EFI_SCSI_OP_LENGTH_SIX;\r
@@ -539,7 +539,7 @@ ScsiRequestSenseCommand (
   Executes the SCSI Read Capacity command on the SCSI target specified by ScsiIo.\r
   If Timeout is zero, then this function waits indefinitely for the command to complete.\r
   If Timeout is greater than zero, then the command is executed and will timeout after\r
-  Timeout 100 ns units.  The PMI parameter is used to construct the CDB for this SCSI command.\r
+  Timeout 100 ns units.  The Pmi parameter is used to construct the CDB for this SCSI command.\r
   If ScsiIo is NULL, then ASSERT().\r
   If SenseDataLength is NULL, then ASSERT().\r
   If HostAdapterStatus is NULL, then ASSERT().\r
@@ -554,7 +554,7 @@ ScsiRequestSenseCommand (
   @param[out]     TargetStatus         The status of the target.\r
   @param[in, out] DataBuffer           A pointer to a data buffer.\r
   @param[in, out] DataLength           The length of data buffer.\r
-  @param[in]      PMI                  Partial medium indicator.\r
+  @param[in]      Pmi                  Partial medium indicator.\r
 \r
   @retval  EFI_SUCCESS           Command is executed successfully.\r
   @retval  EFI_BAD_BUFFER_SIZE   The SCSI Request Packet was executed, but the entire\r
@@ -579,7 +579,7 @@ ScsiReadCapacityCommand (
      OUT UINT8                 *TargetStatus,\r
   IN OUT VOID                  *DataBuffer,   OPTIONAL\r
   IN OUT UINT32                *DataLength,\r
-  IN     BOOLEAN               PMI\r
+  IN     BOOLEAN               Pmi\r
   )\r
 {\r
   EFI_SCSI_IO_SCSI_REQUEST_PACKET CommandPacket;\r
@@ -610,10 +610,10 @@ ScsiReadCapacityCommand (
   ScsiIo->GetDeviceLocation (ScsiIo, &Target, &Lun);\r
 \r
   Cdb[0]  = EFI_SCSI_OP_READ_CAPACITY;\r
-  Cdb[1]  = (UINT8) (Lun & EFI_SCSI_LOGICAL_UNIT_NUMBER_MASK);\r
-  if (!PMI) {\r
+  Cdb[1]  = (UINT8) ((Lun << 5) & EFI_SCSI_LOGICAL_UNIT_NUMBER_MASK);\r
+  if (!Pmi) {\r
     //\r
-    // Partial medium indicator,if PMI is FALSE, the Cdb.2 ~ Cdb.5 MUST BE ZERO.\r
+    // Partial medium indicator,if Pmi is FALSE, the Cdb.2 ~ Cdb.5 MUST BE ZERO.\r
     //\r
     ZeroMem ((Cdb + 2), 4);\r
   } else {\r
@@ -636,49 +636,52 @@ ScsiReadCapacityCommand (
 \r
 \r
 /**\r
-  Function to submit read capacity16 command.\r
-\r
-  @param  ScsiIo            A pointer to SCSI IO protocol.\r
-  @param  Timeout           The length of timeout period.\r
-  @param  SenseData         A pointer to output sense data.\r
-  @param  SenseDataLength   The length of output sense data.\r
-  @param  HostAdapterStatus The status of Host Adapter.\r
-  @param  TargetStatus      The status of the target.\r
-  @param  DataBuffer        A pointer to a data buffer.\r
-  @param  DataLength        The length of data buffer.\r
-  @param  PMI               Partial medium indicator.\r
-\r
-  @retval  EFI_SUCCESS            The status of the unit is tested successfully.\r
-  @retval  EFI_BAD_BUFFER_SIZE    The SCSI Request Packet was executed, \r
-                                  but the entire DataBuffer could not be transferred.\r
-                                  The actual number of bytes transferred is returned\r
-                                  in TransferLength.\r
-  @retval  EFI_NOT_READY          The SCSI Request Packet could not be sent because \r
-                                  there are too many SCSI Command Packets already \r
-                                  queued.\r
-  @retval  EFI_DEVICE_ERROR       A device error occurred while attempting to send \r
-                                  the SCSI Request Packet.\r
-  @retval  EFI_INVALID_PARAMETER  The contents of CommandPacket are invalid.  \r
-  @retval  EFI_UNSUPPORTED        The command described by the SCSI Request Packet\r
-                                  is not supported by the SCSI initiator(i.e., SCSI \r
-                                  Host Controller).\r
-  @retval  EFI_TIMEOUT            A timeout occurred while waiting for the SCSI \r
-                                  Request Packet to execute.\r
+  Execute Read Capacity SCSI 16 command on a specific SCSI target.\r
 \r
-**/\r
+  Executes the SCSI Read Capacity 16 command on the SCSI target specified by ScsiIo.\r
+  If Timeout is zero, then this function waits indefinitely for the command to complete.\r
+  If Timeout is greater than zero, then the command is executed and will timeout after\r
+  Timeout 100 ns units.  The Pmi parameter is used to construct the CDB for this SCSI command.\r
+  If ScsiIo is NULL, then ASSERT().\r
+  If SenseDataLength is NULL, then ASSERT().\r
+  If HostAdapterStatus is NULL, then ASSERT().\r
+  If TargetStatus is NULL, then ASSERT().\r
+  If DataLength is NULL, then ASSERT().\r
+\r
+  @param[in]      ScsiIo               A pointer to SCSI IO protocol.\r
+  @param[in]      Timeout              The length of timeout period.\r
+  @param[in, out] SenseData            A pointer to output sense data.\r
+  @param[in, out] SenseDataLength      The length of output sense data.\r
+  @param[out]     HostAdapterStatus    The status of Host Adapter.\r
+  @param[out]     TargetStatus         The status of the target.\r
+  @param[in, out] DataBuffer           A pointer to a data buffer.\r
+  @param[in, out] DataLength           The length of data buffer.\r
+  @param[in]      Pmi                  Partial medium indicator.\r
+\r
+  @retval  EFI_SUCCESS           Command is executed successfully.\r
+  @retval  EFI_BAD_BUFFER_SIZE   The SCSI Request Packet was executed, but the entire\r
+                                 DataBuffer could not be transferred. The actual\r
+                                 number of bytes transferred is returned in DataLength.\r
+  @retval  EFI_NOT_READY         The SCSI Request Packet could not be sent because\r
+                                 there are too many SCSI Command Packets already queued.\r
+  @retval  EFI_DEVICE_ERROR      A device error occurred while attempting to send SCSI Request Packet.\r
+  @retval  EFI_UNSUPPORTED       The command described by the SCSI Request Packet\r
+                                 is not supported by the SCSI initiator(i.e., SCSI  Host Controller)\r
+  @retval  EFI_TIMEOUT           A timeout occurred while waiting for the SCSI Request Packet to execute.\r
 \r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 ScsiReadCapacity16Command (\r
-  IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
-  IN  UINT64                Timeout,\r
-  IN  VOID                  *SenseData,\r
-  IN OUT UINT8              *SenseDataLength,\r
-  OUT UINT8                 *HostAdapterStatus,\r
-  OUT UINT8                 *TargetStatus,\r
-  OUT VOID                  *DataBuffer,\r
-  IN OUT UINT32             *DataLength,\r
-  IN  BOOLEAN               PMI\r
+  IN     EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
+  IN     UINT64                Timeout,\r
+  IN OUT VOID                  *SenseData,  OPTIONAL\r
+  IN OUT UINT8                 *SenseDataLength,\r
+     OUT UINT8                 *HostAdapterStatus,\r
+     OUT UINT8                 *TargetStatus,\r
+  IN OUT VOID                  *DataBuffer, OPTIONAL\r
+  IN OUT UINT32                *DataLength,\r
+  IN     BOOLEAN               Pmi\r
   )\r
 {\r
   EFI_SCSI_IO_SCSI_REQUEST_PACKET CommandPacket;\r
@@ -704,9 +707,9 @@ ScsiReadCapacity16Command (
 \r
   Cdb[0]  = EFI_SCSI_OP_READ_CAPACITY16;\r
   Cdb[1]  = 0x10;\r
-  if (!PMI) {\r
+  if (!Pmi) {\r
     //\r
-    // Partial medium indicator,if PMI is FALSE, the Cdb.2 ~ Cdb.9 MUST BE ZERO.\r
+    // Partial medium indicator,if Pmi is FALSE, the Cdb.2 ~ Cdb.9 MUST BE ZERO.\r
     //\r
     ZeroMem ((Cdb + 2), 8);\r
   } else {\r
@@ -809,7 +812,7 @@ ScsiRead10Command (
   ScsiIo->GetDeviceLocation (ScsiIo, &Target, &Lun);\r
 \r
   Cdb[0]                        = EFI_SCSI_OP_READ10;\r
-  Cdb[1]                        = (UINT8) (Lun & EFI_SCSI_LOGICAL_UNIT_NUMBER_MASK);\r
+  Cdb[1]                        = (UINT8) ((Lun << 5) & EFI_SCSI_LOGICAL_UNIT_NUMBER_MASK);\r
   Cdb[2]                        = (UINT8) (StartLba >> 24);\r
   Cdb[3]                        = (UINT8) (StartLba >> 16);\r
   Cdb[4]                        = (UINT8) (StartLba >> 8);\r
@@ -911,7 +914,7 @@ ScsiWrite10Command (
   ScsiIo->GetDeviceLocation (ScsiIo, &Target, &Lun);\r
 \r
   Cdb[0]                        = EFI_SCSI_OP_WRITE10;\r
-  Cdb[1]                        = (UINT8) (Lun & EFI_SCSI_LOGICAL_UNIT_NUMBER_MASK);\r
+  Cdb[1]                        = (UINT8) ((Lun << 5) & EFI_SCSI_LOGICAL_UNIT_NUMBER_MASK);\r
   Cdb[2]                        = (UINT8) (StartLba >> 24);\r
   Cdb[3]                        = (UINT8) (StartLba >> 16);\r
   Cdb[4]                        = (UINT8) (StartLba >> 8);\r