[mirror_edk2.git] / MdeModulePkg / Bus / Scsi / ScsiBusDxe / ScsiBus.h

/*++\r
\r
Copyright (c) 2006, Intel Corporation                                                         \r
All rights reserved. This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                          \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
Module Name:\r
\r
    ScsiBus.h\r
\r
Abstract:\r
\r
    Header file for SCSI Bus Driver.\r
\r
Revision History\r
++*/\r
\r
// TODO: fix comment to end with --*/\r
#ifndef _SCSI_BUS_H\r
#define _SCSI_BUS_H\r
\r
\r
#include <IndustryStandard/scsi.h>\r
//\r
// 1000 * 1000 * 10\r
//\r
#define ONE_SECOND_TIMER      10000000  \r
\r
#define SCSI_IO_DEV_SIGNATURE EFI_SIGNATURE_32 ('s', 'c', 'i', 'o')\r
\r
typedef struct _SCSI_TARGET_ID {\r
 union {\r
   UINT32  Scsi;\r
   UINT8   ExtScsi[4];   \r
 } ScsiId;\r
  UINT8   ExtScsiId[12];\r
}SCSI_TARGET_ID;\r
\r
\r
typedef struct {\r
   VOID   *Data1;\r
   VOID   *Data2;\r
} SCSI_EVENT_DATA;\r
\r
\r
typedef struct {\r
  UINT32                             Signature;\r
  EFI_HANDLE                         Handle;\r
  EFI_SCSI_IO_PROTOCOL               ScsiIo;\r
  EFI_DEVICE_PATH_PROTOCOL           *DevicePath;\r
  BOOLEAN                            ExtScsiSupport; \r
  EFI_SCSI_PASS_THRU_PROTOCOL        *ScsiPassThru;\r
  EFI_EXT_SCSI_PASS_THRU_PROTOCOL    *ExtScsiPassThru;\r
  SCSI_TARGET_ID                     Pun;\r
  UINT64                             Lun;\r
  UINT8                              ScsiDeviceType;\r
  UINT8                              ScsiVersion;\r
  BOOLEAN                            RemovableDevice;\r
} SCSI_IO_DEV;\r
\r
#define SCSI_IO_DEV_FROM_THIS(a)  CR (a, SCSI_IO_DEV, ScsiIo, SCSI_IO_DEV_SIGNATURE)\r
\r
//\r
// SCSI Bus Controller device strcuture\r
//\r
#define EFI_SCSI_BUS_PROTOCOL_GUID \\r
  { \\r
    0x5261213D, 0x3A3D, 0x441E, 0xB3, 0xAF, 0x21, 0xD3, 0xF7, 0xA4, 0xCA, 0x17 \\r
  }\r
\r
typedef struct _EFI_SCSI_BUS_PROTOCOL {\r
  UINT64  Reserved;\r
} EFI_SCSI_BUS_PROTOCOL;\r
\r
#define SCSI_BUS_DEVICE_SIGNATURE  EFI_SIGNATURE_32 ('s', 'c', 's', 'i')\r
\r
\r
typedef struct _SCSI_BUS_DEVICE {\r
  UINTN                                 Signature;\r
  EFI_SCSI_BUS_PROTOCOL                 BusIdentify;\r
  BOOLEAN                               ExtScsiSupport; \r
  EFI_SCSI_PASS_THRU_PROTOCOL           *ScsiInterface;\r
  EFI_EXT_SCSI_PASS_THRU_PROTOCOL       *ExtScsiInterface;\r
  EFI_DEVICE_PATH_PROTOCOL              *DevicePath;\r
} SCSI_BUS_DEVICE;\r
\r
#define SCSI_BUS_CONTROLLER_DEVICE_FROM_THIS(a)  CR (a, SCSI_BUS_DEVICE, BusIdentify, SCSI_BUS_DEVICE_SIGNATURE)\r
\r
//\r
// Global Variables\r
//\r
extern EFI_DRIVER_BINDING_PROTOCOL  gScsiBusDriverBinding;\r
extern EFI_COMPONENT_NAME_PROTOCOL  gScsiBusComponentName;\r
\r
EFI_STATUS\r
EFIAPI\r
SCSIBusDriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
SCSIBusDriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
SCSIBusDriverBindingStop (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL     *This,\r
  IN  EFI_HANDLE                      Controller,\r
  IN  UINTN                           NumberOfChildren,\r
  IN  EFI_HANDLE                      *ChildHandleBuffer\r
  );\r
\r
//\r
// EFI Component Name Functions\r
//\r
EFI_STATUS\r
EFIAPI\r
ScsiBusComponentNameGetDriverName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
  IN  CHAR8                        *Language,\r
  OUT CHAR16                       **DriverName\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
ScsiBusComponentNameGetControllerName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,\r
  IN  EFI_HANDLE                                      ControllerHandle,\r
  IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,\r
  IN  CHAR8                                           *Language,\r
  OUT CHAR16                                          **ControllerName\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
ScsiGetDeviceType (\r
  IN  EFI_SCSI_IO_PROTOCOL     *This,\r
  OUT UINT8                    *DeviceType\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Retrieves the device type information of the SCSI Controller.\r
    \r
Arguments:\r
\r
  This                  - Protocol instance pointer.\r
  DeviceType            - A pointer to the device type information\r
                            retrieved from the SCSI Controller. \r
\r
Returns:\r
\r
  EFI_SUCCESS           - Retrieves the device type information successfully.\r
  EFI_INVALID_PARAMETER - The DeviceType is NULL.\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
ScsiResetBus (\r
  IN  EFI_SCSI_IO_PROTOCOL     *This\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Resets the SCSI Bus that the SCSI Controller is attached to.\r
    \r
Arguments:\r
\r
  This                  - Protocol instance pointer.\r
\r
Returns:\r
\r
  EFI_SUCCESS           - The SCSI bus is reset successfully.\r
  EFI_DEVICE_ERROR      - Errors encountered when resetting the SCSI bus.\r
  EFI_UNSUPPORTED       - The bus reset operation is not supported by the\r
                          SCSI Host Controller.\r
  EFI_TIMEOUT           - A timeout occurred while attempting to reset \r
                          the SCSI bus.\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
ScsiResetDevice (\r
  IN  EFI_SCSI_IO_PROTOCOL     *This\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Resets the SCSI Controller that the device handle specifies.\r
    \r
Arguments:\r
\r
  This                  - Protocol instance pointer.\r
    \r
Returns:\r
\r
  EFI_SUCCESS           - Reset the SCSI controller successfully.\r
  EFI_DEVICE_ERROR      - Errors are encountered when resetting the\r
                          SCSI Controller.\r
  EFI_UNSUPPORTED       - The SCSI bus does not support a device \r
                          reset operation.\r
  EFI_TIMEOUT           - A timeout occurred while attempting to \r
                          reset the SCSI Controller.\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
ScsiExecuteSCSICommand (\r
  IN  EFI_SCSI_IO_PROTOCOL                 *This,\r
  IN OUT  EFI_SCSI_IO_SCSI_REQUEST_PACKET  *CommandPacket,\r
  IN  EFI_EVENT                            Event\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Sends a SCSI Request Packet to the SCSI Controller for execution.\r
    \r
Arguments:\r
\r
  This                  - Protocol instance pointer.\r
  Packet                - The SCSI request packet to send to the SCSI \r
                          Controller specified by the device handle.\r
  Event                 - If the SCSI bus where the SCSI device is attached\r
                          does not support non-blocking I/O, then Event is \r
                          ignored, and blocking I/O is performed.  \r
                          If Event is NULL, then blocking I/O is performed.\r
                          If Event is not NULL and non-blocking I/O is \r
                          supported, then non-blocking I/O is performed,\r
                          and Event will be signaled when the SCSI Request\r
                          Packet completes.\r
Returns:\r
\r
  EFI_SUCCESS           - The SCSI Request Packet was sent by the host \r
                          successfully, and TransferLength bytes were \r
                          transferred to/from DataBuffer.See \r
                          HostAdapterStatus, TargetStatus, \r
                          SenseDataLength, and SenseData in that order\r
                          for additional status information.\r
  EFI_BAD_BUFFER_SIZE   - The SCSI Request Packet was executed, \r
                          but the entire DataBuffer could not be transferred.\r
                          The actual number of bytes transferred is returned\r
                          in TransferLength. See HostAdapterStatus, \r
                          TargetStatus, SenseDataLength, and SenseData in \r
                          that order for additional status information.\r
  EFI_NOT_READY         - The SCSI Request Packet could not be sent because \r
                          there are too many SCSI Command Packets already \r
                          queued.The caller may retry again later.\r
  EFI_DEVICE_ERROR      - A device error occurred while attempting to send \r
                          the SCSI Request Packet. See HostAdapterStatus, \r
                          TargetStatus, SenseDataLength, and SenseData in \r
                          that order for additional status information.\r
  EFI_INVALID_PARAMETER - The contents of CommandPacket are invalid.  \r
                          The SCSI Request Packet was not sent, so no \r
                          additional status information is available.\r
  EFI_UNSUPPORTED       - The command described by the SCSI Request Packet\r
                          is not supported by the SCSI initiator(i.e., SCSI \r
                          Host Controller). The SCSI Request Packet was not\r
                          sent, so no additional status information is \r
                          available.\r
  EFI_TIMEOUT           - A timeout occurred while waiting for the SCSI \r
                          Request Packet to execute. See HostAdapterStatus,\r
                          TargetStatus, SenseDataLength, and SenseData in \r
                          that order for additional status information.\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
ScsiScanCreateDevice (\r
  EFI_DRIVER_BINDING_PROTOCOL   *This,\r
  EFI_HANDLE                    Controller,\r
  SCSI_TARGET_ID                *TargetId,\r
  UINT64                        Lun,\r
  SCSI_BUS_DEVICE              *ScsiBusDev\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Scan SCSI Bus to discover the device, and attach ScsiIoProtocol to it.\r
\r
Arguments:\r
\r
  This              - Protocol instance pointer\r
  Controller        - Controller handle\r
  Pun               - The Pun of the SCSI device on the SCSI channel.\r
  Lun               - The Lun of the SCSI device on the SCSI channel.\r
  ScsiBusDev        - The pointer of SCSI_BUS_DEVICE\r
\r
Returns:\r
\r
  EFI_SUCCESS       - Successfully to discover the device and attach ScsiIoProtocol to it.\r
  EFI_OUT_OF_RESOURCES - Fail to discover the device.\r
\r
--*/\r
;\r
\r
BOOLEAN\r
DiscoverScsiDevice (\r
  SCSI_IO_DEV   *ScsiIoDevice\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  ScsiIoDevice  - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
GetLunList (\r
  EFI_SCSI_PASS_THRU_PROTOCOL *ScsiPassThru,\r
  UINT32                      Target,\r
  UINT64                      **LunArray,\r
  UINTN                       *NumberOfLuns\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  ScsiPassThru  - TODO: add argument description\r
  Target        - TODO: add argument description\r
  LunArray      - TODO: add argument description\r
  NumberOfLuns  - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
ScsiBusSubmitReportLunCommand (\r
  EFI_SCSI_PASS_THRU_PROTOCOL   *ScsiPassThru,\r
  UINT32                        Target,\r
  UINTN                         AllocationLength,\r
  VOID                          *Buffer,\r
  EFI_SCSI_SENSE_DATA           *SenseData,\r
  UINT8                         *SenseDataLength,\r
  UINT8                         *HostAdapterStatus,\r
  UINT8                         *TargetStatus\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  ScsiPassThru      - TODO: add argument description\r
  Target            - TODO: add argument description\r
  AllocationLength  - TODO: add argument description\r
  Buffer            - TODO: add argument description\r
  SenseData         - TODO: add argument description\r
  SenseDataLength   - TODO: add argument description\r
  HostAdapterStatus - TODO: add argument description\r
  TargetStatus      - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
#endif\r
Commit	Line	Data
3a10d471	1	/*++\r
	2	\r
	3	Copyright (c) 2006, Intel Corporation \r
	4	All rights reserved. This program and the accompanying materials \r
	5	are licensed and made available under the terms and conditions of the BSD License \r
	6	which accompanies this distribution. The full text of the license may be found at \r
	7	http://opensource.org/licenses/bsd-license.php \r
	8	\r
	9	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	10	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	11	\r
	12	Module Name:\r
	13	\r
	14	ScsiBus.h\r
	15	\r
	16	Abstract:\r
	17	\r
	18	Header file for SCSI Bus Driver.\r
	19	\r
	20	Revision History\r
	21	++*/\r
	22	\r
	23	// TODO: fix comment to end with --*/\r
	24	#ifndef _SCSI_BUS_H\r
	25	#define _SCSI_BUS_H\r
	26	\r
	27	\r
	28	#include <IndustryStandard/scsi.h>\r
	29	//\r
	30	// 1000 * 1000 * 10\r
	31	//\r
	32	#define ONE_SECOND_TIMER 10000000 \r
	33	\r
	34	#define SCSI_IO_DEV_SIGNATURE EFI_SIGNATURE_32 ('s', 'c', 'i', 'o')\r
	35	\r
70c94b3b	36	typedef struct _SCSI_TARGET_ID {\r
	37	union {\r
	38	UINT32 Scsi;\r
	39	UINT8 ExtScsi[4]; \r
	40	} ScsiId;\r
	41	UINT8 ExtScsiId[12];\r
	42	}SCSI_TARGET_ID;\r
	43	\r
	44	\r
	45	typedef struct {\r
	46	VOID *Data1;\r
	47	VOID *Data2;\r
	48	} SCSI_EVENT_DATA;\r
	49	\r
	50	\r
3a10d471	51	typedef struct {\r
70c94b3b	52	UINT32 Signature;\r
	53	EFI_HANDLE Handle;\r
	54	EFI_SCSI_IO_PROTOCOL ScsiIo;\r
	55	EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
	56	BOOLEAN ExtScsiSupport; \r
	57	EFI_SCSI_PASS_THRU_PROTOCOL *ScsiPassThru;\r
	58	EFI_EXT_SCSI_PASS_THRU_PROTOCOL *ExtScsiPassThru;\r
	59	SCSI_TARGET_ID Pun;\r
	60	UINT64 Lun;\r
	61	UINT8 ScsiDeviceType;\r
	62	UINT8 ScsiVersion;\r
	63	BOOLEAN RemovableDevice;\r
3a10d471	64	} SCSI_IO_DEV;\r
	65	\r
	66	#define SCSI_IO_DEV_FROM_THIS(a) CR (a, SCSI_IO_DEV, ScsiIo, SCSI_IO_DEV_SIGNATURE)\r
	67	\r
70c94b3b	68	//\r
	69	// SCSI Bus Controller device strcuture\r
	70	//\r
	71	#define EFI_SCSI_BUS_PROTOCOL_GUID \\r
	72	{ \\r
	73	0x5261213D, 0x3A3D, 0x441E, 0xB3, 0xAF, 0x21, 0xD3, 0xF7, 0xA4, 0xCA, 0x17 \\r
	74	}\r
	75	\r
	76	typedef struct _EFI_SCSI_BUS_PROTOCOL {\r
	77	UINT64 Reserved;\r
	78	} EFI_SCSI_BUS_PROTOCOL;\r
	79	\r
	80	#define SCSI_BUS_DEVICE_SIGNATURE EFI_SIGNATURE_32 ('s', 'c', 's', 'i')\r
	81	\r
	82	\r
	83	typedef struct _SCSI_BUS_DEVICE {\r
	84	UINTN Signature;\r
	85	EFI_SCSI_BUS_PROTOCOL BusIdentify;\r
	86	BOOLEAN ExtScsiSupport; \r
	87	EFI_SCSI_PASS_THRU_PROTOCOL *ScsiInterface;\r
	88	EFI_EXT_SCSI_PASS_THRU_PROTOCOL *ExtScsiInterface;\r
	89	EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
	90	} SCSI_BUS_DEVICE;\r
	91	\r
	92	#define SCSI_BUS_CONTROLLER_DEVICE_FROM_THIS(a) CR (a, SCSI_BUS_DEVICE, BusIdentify, SCSI_BUS_DEVICE_SIGNATURE)\r
	93	\r
3a10d471	94	//\r
	95	// Global Variables\r
	96	//\r
	97	extern EFI_DRIVER_BINDING_PROTOCOL gScsiBusDriverBinding;\r
	98	extern EFI_COMPONENT_NAME_PROTOCOL gScsiBusComponentName;\r
	99	\r
	100	EFI_STATUS\r
	101	EFIAPI\r
	102	SCSIBusDriverBindingSupported (\r
	103	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	104	IN EFI_HANDLE Controller,\r
	105	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
	106	);\r
	107	\r
	108	EFI_STATUS\r
	109	EFIAPI\r
	110	SCSIBusDriverBindingStart (\r
	111	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	112	IN EFI_HANDLE Controller,\r
	113	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
	114	);\r
	115	\r
	116	EFI_STATUS\r
	117	EFIAPI\r
	118	SCSIBusDriverBindingStop (\r
	119	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	120	IN EFI_HANDLE Controller,\r
	121	IN UINTN NumberOfChildren,\r
	122	IN EFI_HANDLE *ChildHandleBuffer\r
	123	);\r
	124	\r
	125	//\r
	126	// EFI Component Name Functions\r
	127	//\r
	128	EFI_STATUS\r
	129	EFIAPI\r
	130	ScsiBusComponentNameGetDriverName (\r
	131	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	132	IN CHAR8 *Language,\r
	133	OUT CHAR16 **DriverName\r
	134	);\r
	135	\r
	136	EFI_STATUS\r
	137	EFIAPI\r
	138	ScsiBusComponentNameGetControllerName (\r
	139	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	140	IN EFI_HANDLE ControllerHandle,\r
	141	IN EFI_HANDLE ChildHandle OPTIONAL,\r
	142	IN CHAR8 *Language,\r
	143	OUT CHAR16 **ControllerName\r
	144	);\r
	145	\r
	146	EFI_STATUS\r
	147	EFIAPI\r
	148	ScsiGetDeviceType (\r
	149	IN EFI_SCSI_IO_PROTOCOL *This,\r
	150	OUT UINT8 *DeviceType\r
	151	)\r
	152	/*++\r
	153	\r
	154	Routine Description:\r
	155	\r
70c94b3b	156	Retrieves the device type information of the SCSI Controller.\r
70c94b3b	157	\r
3a10d471	158	Arguments:\r
3a10d471	159	\r
70c94b3b	160	This - Protocol instance pointer.\r
	161	DeviceType - A pointer to the device type information\r
	162	retrieved from the SCSI Controller. \r
3a10d471	163	\r
	164	Returns:\r
	165	\r
70c94b3b	166	EFI_SUCCESS - Retrieves the device type information successfully.\r
70c94b3b	167	EFI_INVALID_PARAMETER - The DeviceType is NULL.\r
3a10d471	168	\r
	169	--*/\r
	170	;\r
	171	\r
	172	EFI_STATUS\r
	173	EFIAPI\r
	174	ScsiResetBus (\r
	175	IN EFI_SCSI_IO_PROTOCOL *This\r
	176	)\r
	177	/*++\r
	178	\r
	179	Routine Description:\r
	180	\r
70c94b3b	181	Resets the SCSI Bus that the SCSI Controller is attached to.\r
70c94b3b	182	\r
3a10d471	183	Arguments:\r
3a10d471	184	\r
70c94b3b	185	This - Protocol instance pointer.\r
3a10d471	186	\r
	187	Returns:\r
	188	\r
70c94b3b	189	EFI_SUCCESS - The SCSI bus is reset successfully.\r
	190	EFI_DEVICE_ERROR - Errors encountered when resetting the SCSI bus.\r
	191	EFI_UNSUPPORTED - The bus reset operation is not supported by the\r
	192	SCSI Host Controller.\r
	193	EFI_TIMEOUT - A timeout occurred while attempting to reset \r
	194	the SCSI bus.\r
3a10d471	195	\r
	196	--*/\r
	197	;\r
	198	\r
	199	EFI_STATUS\r
	200	EFIAPI\r
	201	ScsiResetDevice (\r
	202	IN EFI_SCSI_IO_PROTOCOL *This\r
	203	)\r
	204	/*++\r
	205	\r
	206	Routine Description:\r
	207	\r
70c94b3b	208	Resets the SCSI Controller that the device handle specifies.\r
70c94b3b	209	\r
3a10d471	210	Arguments:\r
3a10d471	211	\r
70c94b3b	212	This - Protocol instance pointer.\r
70c94b3b	213	\r
3a10d471	214	Returns:\r
3a10d471	215	\r
70c94b3b	216	EFI_SUCCESS - Reset the SCSI controller successfully.\r
	217	EFI_DEVICE_ERROR - Errors are encountered when resetting the\r
	218	SCSI Controller.\r
	219	EFI_UNSUPPORTED - The SCSI bus does not support a device \r
	220	reset operation.\r
	221	EFI_TIMEOUT - A timeout occurred while attempting to \r
	222	reset the SCSI Controller.\r
3a10d471	223	\r
	224	--*/\r
	225	;\r
	226	\r
	227	EFI_STATUS\r
	228	EFIAPI\r
	229	ScsiExecuteSCSICommand (\r
	230	IN EFI_SCSI_IO_PROTOCOL *This,\r
	231	IN OUT EFI_SCSI_IO_SCSI_REQUEST_PACKET *CommandPacket,\r
	232	IN EFI_EVENT Event\r
	233	)\r
	234	/*++\r
	235	\r
	236	Routine Description:\r
	237	\r
70c94b3b	238	Sends a SCSI Request Packet to the SCSI Controller for execution.\r
70c94b3b	239	\r
3a10d471	240	Arguments:\r
3a10d471	241	\r
70c94b3b	242	This - Protocol instance pointer.\r
	243	Packet - The SCSI request packet to send to the SCSI \r
	244	Controller specified by the device handle.\r
	245	Event - If the SCSI bus where the SCSI device is attached\r
	246	does not support non-blocking I/O, then Event is \r
	247	ignored, and blocking I/O is performed. \r
	248	If Event is NULL, then blocking I/O is performed.\r
	249	If Event is not NULL and non-blocking I/O is \r
	250	supported, then non-blocking I/O is performed,\r
	251	and Event will be signaled when the SCSI Request\r
	252	Packet completes.\r
3a10d471	253	Returns:\r
3a10d471	254	\r
70c94b3b	255	EFI_SUCCESS - The SCSI Request Packet was sent by the host \r
	256	successfully, and TransferLength bytes were \r
	257	transferred to/from DataBuffer.See \r
	258	HostAdapterStatus, TargetStatus, \r
	259	SenseDataLength, and SenseData in that order\r
	260	for additional status information.\r
	261	EFI_BAD_BUFFER_SIZE - The SCSI Request Packet was executed, \r
	262	but the entire DataBuffer could not be transferred.\r
	263	The actual number of bytes transferred is returned\r
	264	in TransferLength. See HostAdapterStatus, \r
	265	TargetStatus, SenseDataLength, and SenseData in \r
	266	that order for additional status information.\r
	267	EFI_NOT_READY - The SCSI Request Packet could not be sent because \r
	268	there are too many SCSI Command Packets already \r
	269	queued.The caller may retry again later.\r
	270	EFI_DEVICE_ERROR - A device error occurred while attempting to send \r
	271	the SCSI Request Packet. See HostAdapterStatus, \r
	272	TargetStatus, SenseDataLength, and SenseData in \r
	273	that order for additional status information.\r
	274	EFI_INVALID_PARAMETER - The contents of CommandPacket are invalid. \r
	275	The SCSI Request Packet was not sent, so no \r
	276	additional status information is available.\r
	277	EFI_UNSUPPORTED - The command described by the SCSI Request Packet\r
	278	is not supported by the SCSI initiator(i.e., SCSI \r
	279	Host Controller). The SCSI Request Packet was not\r
	280	sent, so no additional status information is \r
	281	available.\r
	282	EFI_TIMEOUT - A timeout occurred while waiting for the SCSI \r
	283	Request Packet to execute. See HostAdapterStatus,\r
	284	TargetStatus, SenseDataLength, and SenseData in \r
	285	that order for additional status information.\r
3a10d471	286	\r
	287	--*/\r
	288	;\r
	289	\r
	290	EFI_STATUS\r
	291	ScsiScanCreateDevice (\r
	292	EFI_DRIVER_BINDING_PROTOCOL *This,\r
	293	EFI_HANDLE Controller,\r
70c94b3b	294	SCSI_TARGET_ID *TargetId,\r
3a10d471	295	UINT64 Lun,\r
70c94b3b	296	SCSI_BUS_DEVICE *ScsiBusDev\r
3a10d471	297	)\r
	298	/*++\r
	299	\r
	300	Routine Description:\r
	301	\r
70c94b3b	302	Scan SCSI Bus to discover the device, and attach ScsiIoProtocol to it.\r
3a10d471	303	\r
	304	Arguments:\r
	305	\r
70c94b3b	306	This - Protocol instance pointer\r
	307	Controller - Controller handle\r
	308	Pun - The Pun of the SCSI device on the SCSI channel.\r
	309	Lun - The Lun of the SCSI device on the SCSI channel.\r
	310	ScsiBusDev - The pointer of SCSI_BUS_DEVICE\r
3a10d471	311	\r
	312	Returns:\r
	313	\r
70c94b3b	314	EFI_SUCCESS - Successfully to discover the device and attach ScsiIoProtocol to it.\r
70c94b3b	315	EFI_OUT_OF_RESOURCES - Fail to discover the device.\r
3a10d471	316	\r
	317	--*/\r
	318	;\r
	319	\r
	320	BOOLEAN\r
	321	DiscoverScsiDevice (\r
	322	SCSI_IO_DEV *ScsiIoDevice\r
	323	)\r
	324	/*++\r
	325	\r
	326	Routine Description:\r
	327	\r
	328	TODO: Add function description\r
	329	\r
	330	Arguments:\r
	331	\r
	332	ScsiIoDevice - TODO: add argument description\r
	333	\r
	334	Returns:\r
	335	\r
	336	TODO: add return values\r
	337	\r
	338	--*/\r
	339	;\r
	340	\r
	341	EFI_STATUS\r
	342	GetLunList (\r
	343	EFI_SCSI_PASS_THRU_PROTOCOL *ScsiPassThru,\r
	344	UINT32 Target,\r
	345	UINT64 **LunArray,\r
	346	UINTN *NumberOfLuns\r
	347	)\r
	348	/*++\r
	349	\r
	350	Routine Description:\r
	351	\r
	352	TODO: Add function description\r
	353	\r
	354	Arguments:\r
	355	\r
	356	ScsiPassThru - TODO: add argument description\r
	357	Target - TODO: add argument description\r
	358	LunArray - TODO: add argument description\r
	359	NumberOfLuns - TODO: add argument description\r
	360	\r
	361	Returns:\r
	362	\r
	363	TODO: add return values\r
	364	\r
	365	--*/\r
	366	;\r
	367	\r
	368	EFI_STATUS\r
	369	ScsiBusSubmitReportLunCommand (\r
	370	EFI_SCSI_PASS_THRU_PROTOCOL *ScsiPassThru,\r
	371	UINT32 Target,\r
	372	UINTN AllocationLength,\r
	373	VOID *Buffer,\r
	374	EFI_SCSI_SENSE_DATA *SenseData,\r
	375	UINT8 *SenseDataLength,\r
	376	UINT8 *HostAdapterStatus,\r
	377	UINT8 *TargetStatus\r
	378	)\r
	379	/*++\r
380	\r
381	Routine Description:\r
382	\r
383	TODO: Add function description\r
384	\r
385	Arguments:\r
386	\r
387	ScsiPassThru - TODO: add argument description\r
388	Target - TODO: add argument description\r
389	AllocationLength - TODO: add argument description\r
390	Buffer - TODO: add argument description\r
391	SenseData - TODO: add argument description\r
392	SenseDataLength - TODO: add argument description\r
393	HostAdapterStatus - TODO: add argument description\r
394	TargetStatus - TODO: add argument description\r
395	\r
396	Returns:\r
397	\r
398	TODO: add return values\r
399	\r
400	--*/\r
401	;\r
402	#endif\r