MdePkg/Include/Library/ScsiLib.h

   1 /** @file
   2   Common Libarary for SCSI
   3
   4   Copyright (c) 2006 - 2007, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef _SCSI_LIB_H
  16 #define _SCSI_LIB_H
  17
  18 #include <Protocol/ScsiIo.h>
  19
  20 //
  21 // the time unit is 100ns, since the SCSI I/O defines timeout in 100ns unit.
  22 //
  23 #define EFI_SCSI_STALL_1_MICROSECOND  10
  24 #define EFI_SCSI_STALL_1_MILLISECOND  10000
  25 #define EFI_SCSI_STALL_1_SECOND       10000000
  26
  27 //
  28 // this macro cannot be directly used by the gBS->Stall(),
  29 // since the value output by this macro is in 100ns unit,
  30 // not 1us unit (1us = 1000ns)
  31 //
  32 #define EfiScsiStallSeconds(a)  (a) * EFI_SCSI_STALL_1_SECOND
  33
  34
  35 /**
  36   Function test the ready status of the SCSI unit.
  37
  38   @param[in]     ScsiIo             A pointer to SCSI IO protocol.
  39   @param[in]     Timeout            The length of timeout period.
  40   @param[out]    SenseData          A pointer to output sense data.
  41   @param[out]    SenseDataLength    The length of output sense data.
  42   @param[out]    HostAdapterStatus  The status of Host Adapter.
  43   @param[out]    TargetStatus       The status of the target.
  44
  45   @retval EFI_SUCCESS           The status of the unit is tested successfully.
  46   @retval EFI_BAD_BUFFER_SIZE   The SCSI Request Packet was executed,
  47                                 but the entire DataBuffer could not be transferred.
  48                                 The actual number of bytes transferred is returned
  49                                 in InTransferLength.
  50   @retval EFI_NOT_READY         The SCSI Request Packet could not be sent because
  51                                 there are too many SCSI Command Packets already
  52                                 queued.
  53   @retval EFI_DEVICE_ERROR      A device error occurred while attempting to send
  54                                 the SCSI Request Packet.
  55   @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid.
  56   @retval EFI_UNSUPPORTED       The command described by the SCSI Request Packet
  57                                 is not supported by the SCSI initiator(i.e., SCSI
  58                                 Host Controller).
  59   @retval EFI_TIMEOUT           A timeout occurred while waiting for the SCSI
  60                                 Request Packet to execute.
  61
  62 **/
  63 EFI_STATUS
  64 EFIAPI
  65 ScsiTestUnitReadyCommand (
  66   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,
  67   IN  UINT64                Timeout,
  68   OUT VOID                  *SenseData,
  69   OUT UINT8                 *SenseDataLength,
  70   OUT UINT8                 *HostAdapterStatus,
  71   OUT UINT8                 *TargetStatus
  72   );
  73
  74
  75 /**
  76   Function to submit SCSI inquiry command.
  77
  78   @param[in]     ScsiIo             SCSI IO Protocol to use
  79   @param[in]     Timeout            The length of timeout period.
  80   @param[out]    SenseData          A pointer to output sense data.
  81   @param[in,out] SenseDataLength    The length of output sense data.
  82   @param[out]    HostAdapterStatus  The status of Host Adapter.
  83   @param[out]    TargetStatus       The status of the target.
  84   @param[in,out] InquirydataBuffer  A pointer to inquiry data buffer.
  85   @param[in,out] InquiryDataLength  The length of inquiry data buffer.
  86   @param[in]     EnableVitalProductData  Boolean to enable Vital Product Data.
  87
  88   @retval EFI_SUCCESS         The status of the unit is tested successfully.
  89   @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
  90                               but the entire DataBuffer could not be transferred.
  91                               The actual number of bytes transferred is returned
  92                               in TransferLength.
  93   @retval EFI_NOT_READY   The SCSI Request Packet could not be sent because
  94                           there are too many SCSI Command Packets already
  95                           queued.
  96   @retval EFI_DEVICE_ERROR  A device error occurred while attempting to send
  97                             the SCSI Request Packet.
  98   @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid.
  99   @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet
 100                           is not supported by the SCSI initiator(i.e., SCSI
 101                           Host Controller).
 102   @retval EFI_TIMEOUT     A timeout occurred while waiting for the SCSI
 103                           Request Packet to execute.
 104
 105 **/
 106 EFI_STATUS
 107 EFIAPI
 108 ScsiInquiryCommand (
 109   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,
 110   IN  UINT64                Timeout,
 111   IN  VOID                  *SenseData,
 112   IN OUT UINT8              *SenseDataLength,
 113   OUT UINT8                 *HostAdapterStatus,
 114   OUT UINT8                 *TargetStatus,
 115   IN OUT VOID               *InquiryDataBuffer,
 116   IN OUT UINT32             *InquiryDataLength,
 117   IN  BOOLEAN               EnableVitalProductData
 118   );
 119
 120
 121 /**
 122   Function to submit SCSI mode sense 10 command.
 123
 124   @param[in]     ScsiIo             A pointer to SCSI IO protocol.
 125   @param[in]     Timeout            The length of timeout period.
 126   @param[out]    SenseData          A pointer to output sense data.
 127   @param[in,out] SenseDataLength    The length of output sense data.
 128   @param[out]    HostAdapterStatus  The status of Host Adapter.
 129   @param[out]    TargetStatus       The status of the target.
 130   @param[in]     DataBuffer         A pointer to input data buffer.
 131   @param[in,out] DataLength         The length of input data buffer.
 132   @param[in]     DBDField           The DBD Field (Optional).
 133   @param[in]     PageControl        Page Control.
 134   @param[in]     PageCode           Page code.
 135
 136   @retval EFI_SUCCESS               The status of the unit is tested successfully.
 137   @retval EFI_BAD_BUFFER_SIZE       The SCSI Request Packet was executed,
 138                                     but the entire DataBuffer could not be transferred.
 139                                     The actual number of bytes transferred is returned
 140                                     in TransferLength.
 141   @retval EFI_NOT_READY             The SCSI Request Packet could not be sent because
 142                                     there are too many SCSI Command Packets already
 143                                     queued.
 144   @retval EFI_DEVICE_ERROR          A device error occurred while attempting to send
 145                                     the SCSI Request Packet.
 146   @retval EFI_INVALID_PARAMETER     The contents of CommandPacket are invalid.
 147   @retval EFI_UNSUPPORTED           The command described by the SCSI Request Packet
 148                                     is not supported by the SCSI initiator(i.e., SCSI
 149                                     Host Controller).
 150   @retval EFI_TIMEOUT               A timeout occurred while waiting for the SCSI
 151                                     Request Packet to execute.
 152
 153 **/
 154 EFI_STATUS
 155 EFIAPI
 156 ScsiModeSense10Command (
 157   IN  EFI_SCSI_IO_PROTOCOL    *ScsiIo,
 158   IN  UINT64                  Timeout,
 159   IN  VOID                    *SenseData,
 160   IN OUT UINT8                *SenseDataLength,
 161   OUT UINT8                   *HostAdapterStatus,
 162   OUT UINT8                   *TargetStatus,
 163   IN  VOID                    *DataBuffer,
 164   IN OUT UINT32               *DataLength,
 165   IN  UINT8                   DBDField, OPTIONAL
 166   IN  UINT8                   PageControl,
 167   IN  UINT8                   PageCode
 168   );
 169
 170
 171
 172 /**
 173   Function to submit SCSI request sense command.
 174   ScsiIo               - A pointer to SCSI IO protocol.
 175   Timeout              - The length of timeout period.
 176   SenseData            - A pointer to output sense data.
 177   SenseDataLength      - The length of output sense data.
 178   HostAdapterStatus    - The status of Host Adapter.
 179   TargetStatus         - The status of the target.
 180
 181   @param[in]     ScsiIo             SCSI IO Protocol to use
 182   @param[in]     Timeout            TODO:
 183   @param[out]    SenseData          TODO:
 184   @param[in,out] SenseDataLength    TODO:
 185   @param[out]    HostAdapterStatus  TODO:
 186   @param[out]    TargetStatus       TODO:
 187
 188   @retval EFI_SUCCESS        Valid data returned
 189   @retval EFI_SUCCESS        The status of the unit is tested successfully.
 190   @retval EFI_BAD_BUFFER_SIZE       The SCSI Request Packet was executed,
 191                                     but the entire DataBuffer could not be transferred.
 192                                     The actual number of bytes transferred is returned
 193                                     in TransferLength.
 194   @retval EFI_NOT_READY             The SCSI Request Packet could not be sent because
 195                                     there are too many SCSI Command Packets already
 196                                     queued.
 197   @retval EFI_DEVICE_ERROR          A device error occurred while attempting to send
 198                                     the SCSI Request Packet.
 199   @retval EFI_INVALID_PARAMETER     The contents of CommandPacket are invalid.
 200   @retval EFI_UNSUPPORTED           The command described by the SCSI Request Packet
 201                                     is not supported by the SCSI initiator(i.e., SCSI
 202                                     Host Controller).
 203   @retval EFI_TIMEOUT               A timeout occurred while waiting for the SCSI
 204                                     Request Packet to execute.
 205
 206 **/
 207 EFI_STATUS
 208 EFIAPI
 209 ScsiRequestSenseCommand (
 210   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,
 211   IN  UINT64                Timeout,
 212   IN  VOID                  *SenseData,
 213   IN OUT UINT8              *SenseDataLength,
 214   OUT UINT8                 *HostAdapterStatus,
 215   OUT UINT8                 *TargetStatus
 216   );
 217
 218
 219 /**
 220   Function to submit read capacity command.
 221
 222   @param[in]     ScsiIo             A pointer to SCSI IO protocol.
 223   @param[in]     Timeout            The length of timeout period.
 224   @param[out]    SenseData          A pointer to output sense data.
 225   @param[in,out] SenseDataLength    The length of output sense data.
 226   @param[out]    HostAdapterStatus  The status of Host Adapter.
 227   @param[out]    TargetStatus       The status of the target.
 228   @param[out]    DataBuffer         A pointer to a data buffer.
 229   @param[in,out] DataLength         The length of data buffer.
 230   @param[in]     PMI                Partial medium indicator.
 231
 232   @retval  EFI_SUCCESS                The status of the unit is tested successfully.
 233   @retval  EFI_BAD_BUFFER_SIZE        The SCSI Request Packet was executed,
 234                                       but the entire DataBuffer could not be transferred.
 235                                       The actual number of bytes transferred is returned
 236                                       in TransferLength.
 237   @retval  EFI_NOT_READY              The SCSI Request Packet could not be sent because
 238                                       there are too many SCSI Command Packets already
 239                                       queued.
 240   @retval  EFI_DEVICE_ERROR           A device error occurred while attempting to send
 241                                       the SCSI Request Packet.
 242   @retval  EFI_INVALID_PARAMETER      The contents of CommandPacket are invalid.
 243   @retval  EFI_UNSUPPORTED            The command described by the SCSI Request Packet
 244                                       is not supported by the SCSI initiator(i.e., SCSI
 245                                       Host Controller).
 246   @retval  EFI_TIMEOUT                A timeout occurred while waiting for the SCSI
 247                                       Request Packet to execute.
 248
 249 **/
 250 EFI_STATUS
 251 ScsiReadCapacityCommand (
 252   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,
 253   IN  UINT64                Timeout,
 254   IN  VOID                  *SenseData,
 255   IN OUT UINT8              *SenseDataLength,
 256   OUT UINT8                 *HostAdapterStatus,
 257   OUT UINT8                 *TargetStatus,
 258   OUT VOID                  *DataBuffer,
 259   IN OUT UINT32             *DataLength,
 260   IN  BOOLEAN               PMI
 261   );
 262
 263
 264 /**
 265   Function to submit read 10 command.
 266
 267   @param[in]     ScsiIo             A pointer to SCSI IO protocol.
 268   @param[in]     Timeout            The length of timeout period.
 269   @param[out]    SenseData          A pointer to output sense data.
 270   @param[in,out] SenseDataLength    The length of output sense data.
 271   @param[out]    HostAdapterStatus  The status of Host Adapter.
 272   @param[out]    TargetStatus       The status of the target.
 273   @param[out]    DataBuffer         Read 10 command data.
 274   @param[in,out] DataLength         The length of data buffer.
 275   @param[in]     StartLba           The start address of LBA.
 276   @param[in]     SectorSize         The sector size.
 277
 278   @retval EFI_SUCCESS               The status of the unit is tested successfully.
 279   @retval EFI_BAD_BUFFER_SIZE       The SCSI Request Packet was executed,
 280                                     but the entire DataBuffer could not be transferred.
 281                                     The actual number of bytes transferred is returned
 282                                     in TransferLength.
 283   @retval EFI_NOT_READY             The SCSI Request Packet could not be sent because
 284                                     there are too many SCSI Command Packets already
 285                                     queued.
 286   @retval EFI_DEVICE_ERROR          A device error occurred while attempting to send
 287                                     the SCSI Request Packet.
 288   @retval EFI_INVALID_PARAMETER     The contents of CommandPacket are invalid.
 289   @retval EFI_UNSUPPORTED           The command described by the SCSI Request Packet
 290                                     is not supported by the SCSI initiator(i.e., SCSI
 291                                     Host Controller).
 292   @retval EFI_TIMEOUT               A timeout occurred while waiting for the SCSI
 293                                     Request Packet to execute.
 294
 295 **/
 296 EFI_STATUS
 297 EFIAPI
 298 ScsiRead10Command (
 299   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,
 300   IN  UINT64                Timeout,
 301   IN  VOID                  *SenseData,
 302   IN OUT UINT8              *SenseDataLength,
 303   OUT UINT8                 *HostAdapterStatus,
 304   OUT UINT8                 *TargetStatus,
 305   OUT VOID                  *DataBuffer,
 306   IN OUT UINT32             *DataLength,
 307   IN  UINT32                StartLba,
 308   IN  UINT32                SectorSize
 309   );
 310
 311
 312 /**
 313   Function to submit SCSI write 10 command.
 314
 315   @param[in]     ScsiIo             SCSI IO Protocol to use
 316   @param[in]     Timeout            The length of timeout period.
 317   @param[out]    SenseData          A pointer to output sense data.
 318   @param[in,out] SenseDataLength    The length of output sense data.
 319   @param[out]    HostAdapterStatus  The status of Host Adapter.
 320   @param[out]    TargetStatus       The status of the target.
 321   @param[out]    DataBuffer         A pointer to a data buffer.
 322   @param[in,out] DataLength         The length of data buffer.
 323   @param[in]     StartLba           The start address of LBA.
 324   @param[in]     SectorSize         The sector size.
 325
 326   @retval EFI_SUCCESS               The status of the unit is tested successfully.
 327   @retval EFI_BAD_BUFFER_SIZE       The SCSI Request Packet was executed,
 328                                     but the entire DataBuffer could not be transferred.
 329                                     The actual number of bytes transferred is returned
 330                                     in InTransferLength.
 331   @retval EFI_NOT_READY             The SCSI Request Packet could not be sent because
 332                                     there are too many SCSI Command Packets already
 333                                     queued.
 334   @retval EFI_DEVICE_ERROR          A device error occurred while attempting to send
 335                                     the SCSI Request Packet.
 336   @retval EFI_INVALID_PARAMETER     The contents of CommandPacket are invalid.
 337   @retval EFI_UNSUPPORTED           The command described by the SCSI Request Packet
 338                                     is not supported by the SCSI initiator(i.e., SCSI
 339                                     Host Controller).
 340   @retval EFI_TIMEOUT               A timeout occurred while waiting for the SCSI
 341                                     Request Packet to execute.
 342
 343 **/
 344 EFI_STATUS
 345 EFIAPI
 346 ScsiWrite10Command (
 347   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,
 348   IN  UINT64                Timeout,
 349   IN  VOID                  *SenseData,
 350   IN OUT UINT8              *SenseDataLength,
 351   OUT UINT8                 *HostAdapterStatus,
 352   OUT UINT8                 *TargetStatus,
 353   OUT VOID                  *DataBuffer,
 354   IN OUT UINT32             *DataLength,
 355   IN  UINT32                StartLba,
 356   IN  UINT32                SectorSize
 357   );
 358
 359
 360 #endif