4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/** @file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Provides the functions to submit Scsi commands defined in SCSI-2 specification for SCSI devices.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This library class provides the functions to submit SCSI commands defined in SCSI-2 specification
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for hard drive, CD and DVD devices that are the most common SCSI boot targets used by UEFI platforms.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This library class depends on SCSI I/O Protocol defined in UEFI Specification and SCSI-2 industry standard.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncare licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncwhich accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynchttp://opensource.org/licenses/bsd-license.php
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#ifndef __SCSI_LIB_H__
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define __SCSI_LIB_H__
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Protocol/ScsiIo.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Execute Test Unit Ready SCSI command on a specific SCSI target.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes the Test Unit Ready command on the SCSI target specified by ScsiIo.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Timeout is zero, then this function waits indefinitely for the command to complete.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Timeout is greater than zero, then the command is executed and will timeout after Timeout 100 ns units.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If ScsiIo is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If SenseDataLength is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If HostAdapterStatus is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If TargetStatus is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ScsiIo A pointer to the SCSI I/O Protocol instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for the specific SCSI target.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Timeout The timeout in 100 ns units to use for the execution
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of this SCSI Request Packet. A Timeout value of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync zero means that this function will wait indefinitely
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for the SCSI Request Packet to execute. If Timeout
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is greater than zero, then this function will return
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_TIMEOUT if the time required to execute the SCSI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Request Packet is greater than Timeout.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] SenseData A pointer to sense data that was generated by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the execution of the SCSI Request Packet. This
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync buffer must be allocated by the caller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If SenseDataLength is 0, then this parameter is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync optional and may be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] SenseDataLength On input, a pointer to the length in bytes of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the SenseData buffer. On output, a pointer to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the number of bytes written to the SenseData buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] HostAdapterStatus The status of the SCSI Host Controller that produces
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the SCSI bus containing the SCSI target specified by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScsiIo when the SCSI Request Packet was executed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync See the EFI SCSI I/O Protocol in the UEFI Specification
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for details on the possible return values.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] TargetStatus The status returned by the SCSI target specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by ScsiIo when the SCSI Request Packet was executed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync on the SCSI Host Controller. See the EFI SCSI I/O
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Protocol in the UEFI Specification for details on
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the possible return values.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The command was executed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync See HostAdapterStatus, TargetStatus, SenseDataLength,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and SenseData in that order for additional status
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY The SCSI Request Packet could not be sent because
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync there are too many SCSI Command Packets already
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync queued. The SCSI Request Packet was not sent, so
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync no additional status information is available.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The caller may retry again later.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR A device error occurred while attempting to send
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SCSI Request Packet. See HostAdapterStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TargetStatus, SenseDataLength, and SenseData in that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync order for additional status information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is not supported by the SCSI initiator(i.e., SCSI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Host Controller). The SCSI Request Packet was not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync sent, so no additional status information is available.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Packet to execute. See HostAdapterStatus, TargetStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SenseDataLength, and SenseData in that order for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync additional status information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncScsiTestUnitReadyCommand (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT64 Timeout,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT VOID *SenseData, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT UINT8 *SenseDataLength,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT UINT8 *HostAdapterStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT UINT8 *TargetStatus
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Execute Inquiry SCSI command on a specific SCSI target.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes the Inquiry command on the SCSI target specified by ScsiIo.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Timeout is zero, then this function waits indefinitely for the command to complete.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Timeout is greater than zero, then the command is executed and will timeout after Timeout 100 ns units.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If ScsiIo is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If SenseDataLength is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If HostAdapterStatus is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If TargetStatus is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If InquiryDataLength is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ScsiIo A pointer to the SCSI I/O Protocol instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for the specific SCSI target.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Timeout The timeout in 100 ns units to use for the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync execution of this SCSI Request Packet. A Timeout
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync value of zero means that this function will wait
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync indefinitely for the SCSI Request Packet to execute.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Timeout is greater than zero, then this function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will return EFI_TIMEOUT if the time required to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync execute the SCSI Request Packet is greater than Timeout.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] SenseData A pointer to sense data that was generated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by the execution of the SCSI Request Packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This buffer must be allocated by the caller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If SenseDataLength is 0, then this parameter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is optional and may be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] SenseDataLength On input, the length in bytes of the SenseData buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync On output, the number of bytes written to the SenseData buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] HostAdapterStatus The status of the SCSI Host Controller that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync produces the SCSI bus containing the SCSI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync target specified by ScsiIo when the SCSI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Request Packet was executed. See the EFI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SCSI I/O Protocol in the UEFI Specification
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for details on the possible return values.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] TargetStatus The status returned by the SCSI target specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by ScsiIo when the SCSI Request Packet was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync executed on the SCSI Host Controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync See the EFI SCSI I/O Protocol in the UEFI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Specification for details on the possible
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return values.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] InquiryDataBuffer A pointer to inquiry data that was generated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by the execution of the SCSI Request Packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This buffer must be allocated by the caller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If InquiryDataLength is 0, then this parameter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is optional and may be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] InquiryDataLength On input, a pointer to the length in bytes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the InquiryDataBuffer buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync On output, a pointer to the number of bytes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync written to the InquiryDataBuffer buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] EnableVitalProductData If TRUE, then the supported vital product
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync data is returned in InquiryDataBuffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If FALSE, then the standard inquiry data is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returned in InquiryDataBuffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The command was executed successfully. See HostAdapterStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TargetStatus, SenseDataLength, and SenseData in that order
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for additional status information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the entire
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync InquiryDataBuffer could not be transferred. The actual
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync number of bytes transferred is returned in InquiryDataLength.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY The SCSI Request Packet could not be sent because there
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are too many SCSI Command Packets already queued.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The SCSI Request Packet was not sent, so no additional
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync status information is available. The caller may retry again later.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR A device error occurred while attempting to send SCSI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Request Packet. See HostAdapterStatus, TargetStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SenseDataLength, and SenseData in that order for additional
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync status information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync supported by the SCSI initiator(i.e., SCSI Host Controller).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The SCSI Request Packet was not sent, so no additional
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync status information is available.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Packet to execute. See HostAdapterStatus, TargetStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SenseDataLength, and SenseData in that order for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync additional status information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncScsiInquiryCommand (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT64 Timeout,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT VOID *SenseData, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT UINT8 *SenseDataLength,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT UINT8 *HostAdapterStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT UINT8 *TargetStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT VOID *InquiryDataBuffer, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT UINT32 *InquiryDataLength,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN BOOLEAN EnableVitalProductData
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Execute Inquiry SCSI command on a specific SCSI target.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes the Inquiry command on the SCSI target specified by ScsiIo.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Timeout is zero, then this function waits indefinitely for the command to complete.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Timeout is greater than zero, then the command is executed and will timeout after Timeout 100 ns units.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If ScsiIo is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If SenseDataLength is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If HostAdapterStatus is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If TargetStatus is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If InquiryDataLength is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ScsiIo A pointer to the SCSI I/O Protocol instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for the specific SCSI target.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Timeout The timeout in 100 ns units to use for the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync execution of this SCSI Request Packet. A Timeout
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync value of zero means that this function will wait
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync indefinitely for the SCSI Request Packet to execute.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Timeout is greater than zero, then this function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will return EFI_TIMEOUT if the time required to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync execute the SCSI Request Packet is greater than Timeout.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] SenseData A pointer to sense data that was generated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by the execution of the SCSI Request Packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This buffer must be allocated by the caller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If SenseDataLength is 0, then this parameter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is optional and may be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] SenseDataLength On input, the length in bytes of the SenseData buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync On output, the number of bytes written to the SenseData buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] HostAdapterStatus The status of the SCSI Host Controller that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync produces the SCSI bus containing the SCSI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync target specified by ScsiIo when the SCSI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Request Packet was executed. See the EFI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SCSI I/O Protocol in the UEFI Specification
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for details on the possible return values.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] TargetStatus The status returned by the SCSI target specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by ScsiIo when the SCSI Request Packet was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync executed on the SCSI Host Controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync See the EFI SCSI I/O Protocol in the UEFI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Specification for details on the possible
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return values.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] InquiryDataBuffer A pointer to inquiry data that was generated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by the execution of the SCSI Request Packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This buffer must be allocated by the caller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If InquiryDataLength is 0, then this parameter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is optional and may be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] InquiryDataLength On input, a pointer to the length in bytes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the InquiryDataBuffer buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync On output, a pointer to the number of bytes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync written to the InquiryDataBuffer buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] EnableVitalProductData If TRUE, then the supported vital product
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync data for the PageCode is returned in InquiryDataBuffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If FALSE, then the standard inquiry data is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returned in InquiryDataBuffer and PageCode is ignored.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] PageCode The page code of the vital product data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync It's ignored if EnableVitalProductData is FALSE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The command executed successfully. See HostAdapterStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TargetStatus, SenseDataLength, and SenseData in that order
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for additional status information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the entire
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync InquiryDataBuffer could not be transferred. The actual
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync number of bytes transferred is returned in InquiryDataLength.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY The SCSI Request Packet could not be sent because there
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are too many SCSI Command Packets already queued.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The SCSI Request Packet was not sent, so no additional
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync status information is available. The caller may retry again later.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR A device error occurred while attempting to send SCSI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Request Packet. See HostAdapterStatus, TargetStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SenseDataLength, and SenseData in that order for additional
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync status information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync supported by the SCSI initiator(i.e., SCSI Host Controller).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The SCSI Request Packet was not sent, so no additional
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync status information is available.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Packet to execute. See HostAdapterStatus, TargetStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SenseDataLength, and SenseData in that order for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync additional status information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncScsiInquiryCommandEx (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT64 Timeout,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT VOID *SenseData, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT UINT8 *SenseDataLength,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT UINT8 *HostAdapterStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT UINT8 *TargetStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT VOID *InquiryDataBuffer, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT UINT32 *InquiryDataLength,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN BOOLEAN EnableVitalProductData,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT8 PageCode
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Execute Mode Sense(10) SCSI command on a specific SCSI target.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes the SCSI Mode Sense(10) command on the SCSI target specified by ScsiIo.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Timeout is zero, then this function waits indefinitely for the command to complete.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Timeout is greater than zero, then the command is executed and will timeout
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync after Timeout 100 ns units. The DBDField, PageControl, and PageCode parameters
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are used to construct the CDB for this SCSI command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If ScsiIo is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If SenseDataLength is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If HostAdapterStatus is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If TargetStatus is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If DataLength is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ScsiIo A pointer to the SCSI I/O Protocol instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for the specific SCSI target.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Timeout The timeout in 100 ns units to use for the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync execution of this SCSI Request Packet. A Timeout
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync value of zero means that this function will wait
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync indefinitely for the SCSI Request Packet to execute.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Timeout is greater than zero, then this function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will return EFI_TIMEOUT if the time required to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync execute the SCSI Request Packet is greater than Timeout.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] SenseData A pointer to sense data that was generated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by the execution of the SCSI Request Packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This buffer must be allocated by the caller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If SenseDataLength is 0, then this parameter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is optional and may be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] SenseDataLength On input, the length in bytes of the SenseData buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync On output, the number of bytes written to the SenseData buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] HostAdapterStatus The status of the SCSI Host Controller that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync produces the SCSI bus containing the SCSI target
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by ScsiIo when the SCSI Request Packet
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync was executed. See the EFI SCSI I/O Protocol in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UEFI Specification for details on the possible
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return values.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] TargetStatus The status returned by the SCSI target specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by ScsiIo when the SCSI Request Packet was executed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync on the SCSI Host Controller. See the EFI SCSI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync I/O Protocol in the UEFI Specification for details
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync on the possible return values.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] DataBuffer A pointer to data that was generated by the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync execution of the SCSI Request Packet. This
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync buffer must be allocated by the caller. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DataLength is 0, then this parameter is optional
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and may be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] DataLength On input, a pointer to the length in bytes of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the DataBuffer buffer. On output, a pointer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to the number of bytes written to the DataBuffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DBDField Specifies the DBD field of the CDB for this SCSI Command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] PageControl Specifies the PC field of the CDB for this SCSI Command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] PageCode Specifies the Page Control field of the CDB for this SCSI Command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The command was executed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync See HostAdapterStatus, TargetStatus, SenseDataLength,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and SenseData in that order for additional status information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync entire DataBuffer could not be transferred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The actual number of bytes transferred is returned
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in DataLength.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY The SCSI Request Packet could not be sent because
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync there are too many SCSI Command Packets already queued.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The SCSI Request Packet was not sent, so no additional
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync status information is available. The caller may retry
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync again later.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR A device error occurred while attempting to send
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SCSI Request Packet. See HostAdapterStatus, TargetStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SenseDataLength, and SenseData in that order for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync additional status information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is not supported by the SCSI initiator(i.e., SCSI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Host Controller). The SCSI Request Packet was not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync sent, so no additional status information is available.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Request Packet to execute. See HostAdapterStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TargetStatus, SenseDataLength, and SenseData in that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync order for additional status information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncScsiModeSense10Command (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT64 Timeout,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT VOID *SenseData, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT UINT8 *SenseDataLength,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT UINT8 *HostAdapterStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT UINT8 *TargetStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT VOID *DataBuffer, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT UINT32 *DataLength,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT8 DBDField, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT8 PageControl,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT8 PageCode
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Execute Request Sense SCSI command on a specific SCSI target.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes the Request Sense command on the SCSI target specified by ScsiIo.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Timeout is zero, then this function waits indefinitely for the command to complete.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Timeout is greater than zero, then the command is executed and will timeout after Timeout 100 ns units.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If ScsiIo is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If SenseDataLength is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If HostAdapterStatus is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If TargetStatus is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ScsiIo A pointer to SCSI IO protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Timeout The length of timeout period.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] SenseData A pointer to output sense data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] SenseDataLength The length of output sense data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] HostAdapterStatus The status of Host Adapter.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] TargetStatus The status of the target.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Command is executed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY The SCSI Request Packet could not be sent because there are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync too many SCSI Command Packets already queued.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR A device error occurred while attempting to send SCSI Request Packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the SCSI initiator(i.e., SCSI Host Controller)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncScsiRequestSenseCommand (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT64 Timeout,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT VOID *SenseData, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT UINT8 *SenseDataLength,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT UINT8 *HostAdapterStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT UINT8 *TargetStatus
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Execute Read Capacity SCSI command on a specific SCSI target.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes the SCSI Read Capacity command on the SCSI target specified by ScsiIo.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Timeout is zero, then this function waits indefinitely for the command to complete.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Timeout is greater than zero, then the command is executed and will timeout after
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Timeout 100 ns units. The Pmi parameter is used to construct the CDB for this SCSI command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If ScsiIo is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If SenseDataLength is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If HostAdapterStatus is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If TargetStatus is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If DataLength is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ScsiIo A pointer to SCSI IO protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Timeout The length of timeout period.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] SenseData A pointer to output sense data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] SenseDataLength The length of output sense data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] HostAdapterStatus The status of Host Adapter.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] TargetStatus The status of the target.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] DataBuffer A pointer to a data buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] DataLength The length of data buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Pmi Partial medium indicator.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Command is executed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the entire
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DataBuffer could not be transferred. The actual
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync number of bytes transferred is returned in DataLength.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY The SCSI Request Packet could not be sent because
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync there are too many SCSI Command Packets already queued.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR A device error occurred while attempting to send SCSI Request Packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is not supported by the SCSI initiator(i.e., SCSI Host Controller)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncScsiReadCapacityCommand (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT64 Timeout,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT VOID *SenseData, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT UINT8 *SenseDataLength,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT UINT8 *HostAdapterStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT UINT8 *TargetStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT VOID *DataBuffer, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT UINT32 *DataLength,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN BOOLEAN Pmi
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Execute Read Capacity SCSI 16 command on a specific SCSI target.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes the SCSI Read Capacity 16 command on the SCSI target specified by ScsiIo.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Timeout is zero, then this function waits indefinitely for the command to complete.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Timeout is greater than zero, then the command is executed and will timeout after
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Timeout 100 ns units. The Pmi parameter is used to construct the CDB for this SCSI command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If ScsiIo is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If SenseDataLength is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If HostAdapterStatus is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If TargetStatus is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If DataLength is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ScsiIo A pointer to SCSI IO protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Timeout The length of timeout period.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] SenseData A pointer to output sense data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] SenseDataLength The length of output sense data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] HostAdapterStatus The status of Host Adapter.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] TargetStatus The status of the target.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] DataBuffer A pointer to a data buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] DataLength The length of data buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Pmi Partial medium indicator.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Command is executed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the entire
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DataBuffer could not be transferred. The actual
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync number of bytes transferred is returned in DataLength.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY The SCSI Request Packet could not be sent because
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync there are too many SCSI Command Packets already queued.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR A device error occurred while attempting to send SCSI Request Packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is not supported by the SCSI initiator(i.e., SCSI Host Controller)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncScsiReadCapacity16Command (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT64 Timeout,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT VOID *SenseData, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT UINT8 *SenseDataLength,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT UINT8 *HostAdapterStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT UINT8 *TargetStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT VOID *DataBuffer, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT UINT32 *DataLength,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN BOOLEAN Pmi
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Execute Read(10) SCSI command on a specific SCSI target.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes the SCSI Read(10) command on the SCSI target specified by ScsiIo.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Timeout is zero, then this function waits indefinitely for the command to complete.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Timeout is greater than zero, then the command is executed and will timeout
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync after Timeout 100 ns units. The StartLba and SectorSize parameters are used to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync construct the CDB for this SCSI command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If ScsiIo is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If SenseDataLength is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If HostAdapterStatus is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If TargetStatus is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If DataLength is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ScsiIo A pointer to SCSI IO protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Timeout The length of timeout period.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] SenseData A pointer to output sense data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] SenseDataLength The length of output sense data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] HostAdapterStatus The status of Host Adapter.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] TargetStatus The status of the target.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] DataBuffer Read 10 command data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] DataLength The length of data buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] StartLba The start address of LBA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] SectorSize The sector size.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Command is executed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the entire DataBuffer could
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not be transferred. The actual number of bytes transferred is returned in DataLength.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY The SCSI Request Packet could not be sent because there are too many
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SCSI Command Packets already queued.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR A device error occurred while attempting to send SCSI Request Packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the SCSI initiator(i.e., SCSI Host Controller)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncScsiRead10Command (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT64 Timeout,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT VOID *SenseData, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT UINT8 *SenseDataLength,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT UINT8 *HostAdapterStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT UINT8 *TargetStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT VOID *DataBuffer, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT UINT32 *DataLength,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT32 StartLba,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT32 SectorSize
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Execute Write(10) SCSI command on a specific SCSI target.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes the SCSI Write(10) command on the SCSI target specified by ScsiIo.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Timeout is zero, then this function waits indefinitely for the command to complete.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Timeout is greater than zero, then the command is executed and will timeout after
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Timeout 100 ns units. The StartLba and SectorSize parameters are used to construct
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the CDB for this SCSI command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If ScsiIo is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If SenseDataLength is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If HostAdapterStatus is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If TargetStatus is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If DataLength is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ScsiIo SCSI IO Protocol to use
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Timeout The length of timeout period.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] SenseData A pointer to output sense data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] SenseDataLength The length of output sense data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] HostAdapterStatus The status of Host Adapter.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] TargetStatus The status of the target.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] DataBuffer A pointer to a data buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] DataLength The length of data buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] StartLba The start address of LBA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] SectorSize The sector size.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Command is executed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the entire DataBuffer could
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not be transferred. The actual number of bytes transferred is returned in DataLength.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY The SCSI Request Packet could not be sent because there are too many
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SCSI Command Packets already queued.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR A device error occurred while attempting to send SCSI Request Packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the SCSI initiator(i.e., SCSI Host Controller)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncScsiWrite10Command (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT64 Timeout,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT VOID *SenseData, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT UINT8 *SenseDataLength,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT UINT8 *HostAdapterStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT UINT8 *TargetStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT VOID *DataBuffer, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT UINT32 *DataLength,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT32 StartLba,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT32 SectorSize
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Execute Read(16) SCSI command on a specific SCSI target.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes the SCSI Read(16) command on the SCSI target specified by ScsiIo.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Timeout is zero, then this function waits indefinitely for the command to complete.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Timeout is greater than zero, then the command is executed and will timeout
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync after Timeout 100 ns units. The StartLba and SectorSize parameters are used to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync construct the CDB for this SCSI command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If ScsiIo is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If SenseDataLength is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If HostAdapterStatus is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If TargetStatus is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If DataLength is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ScsiIo A pointer to SCSI IO protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Timeout The length of timeout period.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] SenseData A pointer to output sense data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] SenseDataLength The length of output sense data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] HostAdapterStatus The status of Host Adapter.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] TargetStatus The status of the target.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] DataBuffer Read 16 command data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] DataLength The length of data buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] StartLba The start address of LBA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] SectorSize The sector size.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Command is executed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the entire DataBuffer could
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not be transferred. The actual number of bytes transferred is returned in DataLength.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY The SCSI Request Packet could not be sent because there are too many
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SCSI Command Packets already queued.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR A device error occurred while attempting to send SCSI Request Packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the SCSI initiator(i.e., SCSI Host Controller)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncScsiRead16Command (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT64 Timeout,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT VOID *SenseData, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT UINT8 *SenseDataLength,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT UINT8 *HostAdapterStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT UINT8 *TargetStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT VOID *DataBuffer, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT UINT32 *DataLength,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT64 StartLba,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT32 SectorSize
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Execute Write(16) SCSI command on a specific SCSI target.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes the SCSI Write(16) command on the SCSI target specified by ScsiIo.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Timeout is zero, then this function waits indefinitely for the command to complete.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Timeout is greater than zero, then the command is executed and will timeout after
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Timeout 100 ns units. The StartLba and SectorSize parameters are used to construct
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the CDB for this SCSI command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If ScsiIo is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If SenseDataLength is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If HostAdapterStatus is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If TargetStatus is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If DataLength is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ScsiIo SCSI IO Protocol to use
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Timeout The length of timeout period.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] SenseData A pointer to output sense data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] SenseDataLength The length of output sense data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] HostAdapterStatus The status of Host Adapter.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] TargetStatus The status of the target.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] DataBuffer A pointer to a data buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] DataLength The length of data buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] StartLba The start address of LBA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] SectorSize The sector size.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Command is executed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the entire DataBuffer could
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not be transferred. The actual number of bytes transferred is returned in DataLength.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY The SCSI Request Packet could not be sent because there are too many
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SCSI Command Packets already queued.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR A device error occurred while attempting to send SCSI Request Packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the SCSI initiator(i.e., SCSI Host Controller)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncScsiWrite16Command (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT64 Timeout,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT VOID *SenseData, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT UINT8 *SenseDataLength,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT UINT8 *HostAdapterStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT UINT8 *TargetStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT VOID *DataBuffer, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT UINT32 *DataLength,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT64 StartLba,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT32 SectorSize
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#endif