mirror of
https://git.proxmox.com/git/mirror_edk2
synced 2025-10-31 09:21:56 +00:00
9344f09215
https://bugzilla.tianocore.org/show_bug.cgi?id=1373 Replace BSD 2-Clause License with BSD+Patent License. This change is based on the following emails: https://lists.01.org/pipermail/edk2-devel/2019-February/036260.html https://lists.01.org/pipermail/edk2-devel/2018-October/030385.html RFCs with detailed process for the license change: V3: https://lists.01.org/pipermail/edk2-devel/2019-March/038116.html V2: https://lists.01.org/pipermail/edk2-devel/2019-March/037669.html V1: https://lists.01.org/pipermail/edk2-devel/2019-March/037500.html Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com> Reviewed-by: Liming Gao <liming.gao@intel.com>
312 lines
14 KiB
C
312 lines
14 KiB
C
/** @file
|
|
EFI_SCSI_IO_PROTOCOL as defined in UEFI 2.0.
|
|
This protocol is used by code, typically drivers, running in the EFI boot
|
|
services environment to access SCSI devices. In particular, functions for
|
|
managing devices on SCSI buses are defined here.
|
|
|
|
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#ifndef __EFI_SCSI_IO_PROTOCOL_H__
|
|
#define __EFI_SCSI_IO_PROTOCOL_H__
|
|
|
|
#define EFI_SCSI_IO_PROTOCOL_GUID \
|
|
{ \
|
|
0x932f47e6, 0x2362, 0x4002, {0x80, 0x3e, 0x3c, 0xd5, 0x4b, 0x13, 0x8f, 0x85 } \
|
|
}
|
|
|
|
///
|
|
/// Forward reference for pure ANSI compatability
|
|
///
|
|
typedef struct _EFI_SCSI_IO_PROTOCOL EFI_SCSI_IO_PROTOCOL;
|
|
|
|
//
|
|
// SCSI Device type information, defined in the SCSI Primary Commands standard (e.g., SPC-4)
|
|
//
|
|
#define EFI_SCSI_IO_TYPE_DISK 0x00 ///< Disk device
|
|
#define EFI_SCSI_IO_TYPE_TAPE 0x01 ///< Tape device
|
|
#define EFI_SCSI_IO_TYPE_PRINTER 0x02 ///< Printer
|
|
#define EFI_SCSI_IO_TYPE_PROCESSOR 0x03 ///< Processor
|
|
#define EFI_SCSI_IO_TYPE_WORM 0x04 ///< Write-once read-multiple
|
|
#define EFI_SCSI_IO_TYPE_CDROM 0x05 ///< CD or DVD device
|
|
#define EFI_SCSI_IO_TYPE_SCANNER 0x06 ///< Scanner device
|
|
#define EFI_SCSI_IO_TYPE_OPTICAL 0x07 ///< Optical memory device
|
|
#define EFI_SCSI_IO_TYPE_MEDIUMCHANGER 0x08 ///< Medium Changer device
|
|
#define EFI_SCSI_IO_TYPE_COMMUNICATION 0x09 ///< Communications device
|
|
#define MFI_SCSI_IO_TYPE_A 0x0A ///< Obsolete
|
|
#define MFI_SCSI_IO_TYPE_B 0x0B ///< Obsolete
|
|
#define MFI_SCSI_IO_TYPE_RAID 0x0C ///< Storage array controller device (e.g., RAID)
|
|
#define MFI_SCSI_IO_TYPE_SES 0x0D ///< Enclosure services device
|
|
#define MFI_SCSI_IO_TYPE_RBC 0x0E ///< Simplified direct-access device (e.g., magnetic disk)
|
|
#define MFI_SCSI_IO_TYPE_OCRW 0x0F ///< Optical card reader/writer device
|
|
#define MFI_SCSI_IO_TYPE_BRIDGE 0x10 ///< Bridge Controller Commands
|
|
#define MFI_SCSI_IO_TYPE_OSD 0x11 ///< Object-based Storage Device
|
|
#define EFI_SCSI_IO_TYPE_RESERVED_LOW 0x12 ///< Reserved (low)
|
|
#define EFI_SCSI_IO_TYPE_RESERVED_HIGH 0x1E ///< Reserved (high)
|
|
#define EFI_SCSI_IO_TYPE_UNKNOWN 0x1F ///< Unknown no device type
|
|
|
|
//
|
|
// SCSI Data Direction definition
|
|
//
|
|
#define EFI_SCSI_IO_DATA_DIRECTION_READ 0
|
|
#define EFI_SCSI_IO_DATA_DIRECTION_WRITE 1
|
|
#define EFI_SCSI_IO_DATA_DIRECTION_BIDIRECTIONAL 2
|
|
|
|
//
|
|
// SCSI Host Adapter Status definition
|
|
//
|
|
#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_OK 0x00
|
|
#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_TIMEOUT_COMMAND 0x09 ///< timeout when processing the command
|
|
#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_TIMEOUT 0x0b ///< timeout when waiting for the command processing
|
|
#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_MESSAGE_REJECT 0x0d ///< a message reject was received when processing command
|
|
#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_BUS_RESET 0x0e ///< a bus reset was detected
|
|
#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_PARITY_ERROR 0x0f
|
|
#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_REQUEST_SENSE_FAILED 0x10 ///< the adapter failed in issuing request sense command
|
|
#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_SELECTION_TIMEOUT 0x11 ///< selection timeout
|
|
#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_DATA_OVERRUN_UNDERRUN 0x12 ///< data overrun or data underrun
|
|
#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_BUS_FREE 0x13 ///< Unexepected bus free
|
|
#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_PHASE_ERROR 0x14 ///< Target bus phase sequence failure
|
|
#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_OTHER 0x7f
|
|
|
|
|
|
//
|
|
// SCSI Target Status definition
|
|
//
|
|
#define EFI_SCSI_IO_STATUS_TARGET_GOOD 0x00
|
|
#define EFI_SCSI_IO_STATUS_TARGET_CHECK_CONDITION 0x02 ///< check condition
|
|
#define EFI_SCSI_IO_STATUS_TARGET_CONDITION_MET 0x04 ///< condition met
|
|
#define EFI_SCSI_IO_STATUS_TARGET_BUSY 0x08 ///< busy
|
|
#define EFI_SCSI_IO_STATUS_TARGET_INTERMEDIATE 0x10 ///< intermediate
|
|
#define EFI_SCSI_IO_STATUS_TARGET_INTERMEDIATE_CONDITION_MET 0x14 ///< intermediate-condition met
|
|
#define EFI_SCSI_IO_STATUS_TARGET_RESERVATION_CONFLICT 0x18 ///< reservation conflict
|
|
#define EFI_SCSI_IO_STATUS_TARGET_COMMOND_TERMINATED 0x22 ///< command terminated
|
|
#define EFI_SCSI_IO_STATUS_TARGET_QUEUE_FULL 0x28 ///< queue full
|
|
|
|
typedef struct {
|
|
///
|
|
/// The timeout, in 100 ns units, to use for the execution of this SCSI
|
|
/// Request Packet. A Timeout value of 0 means that this function
|
|
/// will wait indefinitely for the SCSI Request Packet to execute. If
|
|
/// Timeout is greater than zero, then this function will return
|
|
/// EFI_TIMEOUT if the time required to execute the SCSI Request
|
|
/// Packet is greater than Timeout.
|
|
///
|
|
UINT64 Timeout;
|
|
///
|
|
/// A pointer to the data buffer to transfer between the SCSI
|
|
/// controller and the SCSI device for SCSI READ command
|
|
///
|
|
VOID *InDataBuffer;
|
|
///
|
|
/// A pointer to the data buffer to transfer between the SCSI
|
|
/// controller and the SCSI device for SCSI WRITE command.
|
|
///
|
|
VOID *OutDataBuffer;
|
|
///
|
|
/// A pointer to the sense data that was generated by the execution of
|
|
/// the SCSI Request Packet.
|
|
///
|
|
VOID *SenseData;
|
|
///
|
|
/// A pointer to buffer that contains the Command Data Block to
|
|
/// send to the SCSI device.
|
|
///
|
|
VOID *Cdb;
|
|
///
|
|
/// On Input, the size, in bytes, of InDataBuffer. On output, the
|
|
/// number of bytes transferred between the SCSI controller and the SCSI device.
|
|
///
|
|
UINT32 InTransferLength;
|
|
///
|
|
/// On Input, the size, in bytes of OutDataBuffer. On Output, the
|
|
/// Number of bytes transferred between SCSI Controller and the SCSI device.
|
|
///
|
|
UINT32 OutTransferLength;
|
|
///
|
|
/// The length, in bytes, of the buffer Cdb. The standard values are
|
|
/// 6, 10, 12, and 16, but other values are possible if a variable length CDB is used.
|
|
///
|
|
UINT8 CdbLength;
|
|
///
|
|
/// The direction of the data transfer. 0 for reads, 1 for writes. A
|
|
/// value of 2 is Reserved for Bi-Directional SCSI commands.
|
|
///
|
|
UINT8 DataDirection;
|
|
///
|
|
/// The status of the SCSI Host Controller that produces the SCSI
|
|
/// bus where the SCSI device attached when the SCSI Request
|
|
/// Packet was executed on the SCSI Controller.
|
|
///
|
|
UINT8 HostAdapterStatus;
|
|
///
|
|
/// The status returned by the SCSI device when the SCSI Request
|
|
/// Packet was executed.
|
|
///
|
|
UINT8 TargetStatus;
|
|
///
|
|
/// On input, the length in bytes of the SenseData buffer. On
|
|
/// output, the number of bytes written to the SenseData buffer.
|
|
///
|
|
UINT8 SenseDataLength;
|
|
} EFI_SCSI_IO_SCSI_REQUEST_PACKET;
|
|
|
|
/**
|
|
Retrieves the device type information of the SCSI Controller.
|
|
|
|
@param This Protocol instance pointer.
|
|
@param DeviceType A pointer to the device type information
|
|
retrieved from the SCSI Controller.
|
|
|
|
@retval EFI_SUCCESS Retrieved the device type information successfully.
|
|
@retval EFI_INVALID_PARAMETER The DeviceType is NULL.
|
|
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EFI_SCSI_IO_PROTOCOL_GET_DEVICE_TYPE)(
|
|
IN EFI_SCSI_IO_PROTOCOL *This,
|
|
OUT UINT8 *DeviceType
|
|
);
|
|
|
|
/**
|
|
Retrieves the device location in the SCSI channel.
|
|
|
|
@param This Protocol instance pointer.
|
|
@param Target A pointer to the Target ID of a SCSI device
|
|
on the SCSI channel.
|
|
@param Lun A pointer to the LUN of the SCSI device on
|
|
the SCSI channel.
|
|
|
|
@retval EFI_SUCCESS Retrieves the device location successfully.
|
|
@retval EFI_INVALID_PARAMETER The Target or Lun is NULL.
|
|
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EFI_SCSI_IO_PROTOCOL_GET_DEVICE_LOCATION)(
|
|
IN EFI_SCSI_IO_PROTOCOL *This,
|
|
IN OUT UINT8 **Target,
|
|
OUT UINT64 *Lun
|
|
);
|
|
|
|
/**
|
|
Resets the SCSI Bus that the SCSI Controller is attached to.
|
|
|
|
@param This Protocol instance pointer.
|
|
|
|
@retval EFI_SUCCESS The SCSI bus is reset successfully.
|
|
@retval EFI_DEVICE_ERROR Errors encountered when resetting the SCSI bus.
|
|
@retval EFI_UNSUPPORTED The bus reset operation is not supported by the
|
|
SCSI Host Controller.
|
|
@retval EFI_TIMEOUT A timeout occurred while attempting to reset
|
|
the SCSI bus.
|
|
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EFI_SCSI_IO_PROTOCOL_RESET_BUS)(
|
|
IN EFI_SCSI_IO_PROTOCOL *This
|
|
);
|
|
|
|
/**
|
|
Resets the SCSI Controller that the device handle specifies.
|
|
|
|
@param This Protocol instance pointer.
|
|
|
|
@retval EFI_SUCCESS Reset the SCSI controller successfully.
|
|
@retval EFI_DEVICE_ERROR Errors were encountered when resetting the
|
|
SCSI Controller.
|
|
@retval EFI_UNSUPPORTED The SCSI bus does not support a device
|
|
reset operation.
|
|
@retval EFI_TIMEOUT A timeout occurred while attempting to
|
|
reset the SCSI Controller.
|
|
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EFI_SCSI_IO_PROTOCOL_RESET_DEVICE)(
|
|
IN EFI_SCSI_IO_PROTOCOL *This
|
|
);
|
|
|
|
|
|
/**
|
|
Sends a SCSI Request Packet to the SCSI Controller for execution.
|
|
|
|
@param This Protocol instance pointer.
|
|
@param Packet The SCSI request packet to send to the SCSI
|
|
Controller specified by the device handle.
|
|
@param Event If the SCSI bus to which the SCSI device is attached
|
|
does not support non-blocking I/O, then Event is
|
|
ignored, and blocking I/O is performed.
|
|
If Event is NULL, then blocking I/O is performed.
|
|
If Event is not NULL and non-blocking I/O is
|
|
supported, then non-blocking I/O is performed,
|
|
and Event will be signaled when the SCSI Request
|
|
Packet completes.
|
|
|
|
@retval EFI_SUCCESS The SCSI Request Packet was sent by the host
|
|
successfully, and TransferLength bytes were
|
|
transferred to/from DataBuffer. See
|
|
HostAdapterStatus, TargetStatus,
|
|
SenseDataLength, and SenseData in that order
|
|
for additional status information.
|
|
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
|
|
but the entire DataBuffer could not be transferred.
|
|
The actual number of bytes transferred is returned
|
|
in TransferLength. See HostAdapterStatus,
|
|
TargetStatus, SenseDataLength, and SenseData in
|
|
that order for additional status information.
|
|
@retval EFI_NOT_READY The SCSI Request Packet could not be sent because
|
|
there are too many SCSI Command Packets already
|
|
queued.The caller may retry again later.
|
|
@retval EFI_DEVICE_ERROR A device error occurred while attempting to send
|
|
the SCSI Request Packet. See HostAdapterStatus,
|
|
TargetStatus, SenseDataLength, and SenseData in
|
|
that order for additional status information.
|
|
@retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid.
|
|
The SCSI Request Packet was not sent, so no
|
|
additional status information is available.
|
|
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet
|
|
is not supported by the SCSI initiator(i.e., SCSI
|
|
Host Controller). The SCSI Request Packet was not
|
|
sent, so no additional status information is
|
|
available.
|
|
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
|
|
Request Packet to execute. See HostAdapterStatus,
|
|
TargetStatus, SenseDataLength, and SenseData in
|
|
that order for additional status information.
|
|
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EFI_SCSI_IO_PROTOCOL_EXEC_SCSI_COMMAND)(
|
|
IN EFI_SCSI_IO_PROTOCOL *This,
|
|
IN OUT EFI_SCSI_IO_SCSI_REQUEST_PACKET *Packet,
|
|
IN EFI_EVENT Event OPTIONAL
|
|
);
|
|
|
|
///
|
|
/// Provides services to manage and communicate with SCSI devices.
|
|
///
|
|
struct _EFI_SCSI_IO_PROTOCOL {
|
|
EFI_SCSI_IO_PROTOCOL_GET_DEVICE_TYPE GetDeviceType;
|
|
EFI_SCSI_IO_PROTOCOL_GET_DEVICE_LOCATION GetDeviceLocation;
|
|
EFI_SCSI_IO_PROTOCOL_RESET_BUS ResetBus;
|
|
EFI_SCSI_IO_PROTOCOL_RESET_DEVICE ResetDevice;
|
|
EFI_SCSI_IO_PROTOCOL_EXEC_SCSI_COMMAND ExecuteScsiCommand;
|
|
|
|
///
|
|
/// Supplies the alignment requirement for any buffer used in a data transfer.
|
|
/// IoAlign values of 0 and 1 mean that the buffer can be placed anywhere in memory.
|
|
/// Otherwise, IoAlign must be a power of 2, and the requirement is that the
|
|
/// start address of a buffer must be evenly divisible by IoAlign with no remainder.
|
|
///
|
|
UINT32 IoAlign;
|
|
};
|
|
|
|
extern EFI_GUID gEfiScsiIoProtocolGuid;
|
|
|
|
#endif
|