2 Common Libarary for SCSI
4 Copyright (c) 2006 - 2007, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 #include <Protocol/ScsiIo.h>
21 // the time unit is 100ns, since the SCSI I/O defines timeout in 100ns unit.
23 #define EFI_SCSI_STALL_1_MICROSECOND 10
24 #define EFI_SCSI_STALL_1_MILLISECOND 10000
25 #define EFI_SCSI_STALL_1_SECOND 10000000
28 // this macro cannot be directly used by the gBS->Stall(),
29 // since the value output by this macro is in 100ns unit,
30 // not 1us unit (1us = 1000ns)
32 #define EfiScsiStallSeconds(a) (a) * EFI_SCSI_STALL_1_SECOND
36 Function test the ready status of the SCSI unit.
38 @param[in] ScsiIo A pointer to SCSI IO protocol.
39 @param[in] Timeout The length of timeout period.
40 @param[out] SenseData A pointer to output sense data.
41 @param[out] SenseDataLength The length of output sense data.
42 @param[out] HostAdapterStatus The status of Host Adapter.
43 @param[out] TargetStatus The status of the target.
45 @retval EFI_SUCCESS The status of the unit is tested successfully.
46 @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
47 but the entire DataBuffer could not be transferred.
48 The actual number of bytes transferred is returned
50 @retval EFI_NOT_READY The SCSI Request Packet could not be sent because
51 there are too many SCSI Command Packets already
53 @retval EFI_DEVICE_ERROR A device error occurred while attempting to send
54 the SCSI Request Packet.
55 @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid.
56 @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet
57 is not supported by the SCSI initiator(i.e., SCSI
59 @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
60 Request Packet to execute.
65 ScsiTestUnitReadyCommand (
66 IN EFI_SCSI_IO_PROTOCOL
*ScsiIo
,
69 OUT UINT8
*SenseDataLength
,
70 OUT UINT8
*HostAdapterStatus
,
71 OUT UINT8
*TargetStatus
76 Function to submit SCSI inquiry command.
78 @param[in] ScsiIo SCSI IO Protocol to use
79 @param[in] Timeout The length of timeout period.
80 @param[out] SenseData A pointer to output sense data.
81 @param[in,out] SenseDataLength The length of output sense data.
82 @param[out] HostAdapterStatus The status of Host Adapter.
83 @param[out] TargetStatus The status of the target.
84 @param[in,out] InquirydataBuffer A pointer to inquiry data buffer.
85 @param[in,out] InquiryDataLength The length of inquiry data buffer.
86 @param[in] EnableVitalProductData Boolean to enable Vital Product Data.
88 @retval EFI_SUCCESS The status of the unit is tested successfully.
89 @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
90 but the entire DataBuffer could not be transferred.
91 The actual number of bytes transferred is returned
93 @retval EFI_NOT_READY The SCSI Request Packet could not be sent because
94 there are too many SCSI Command Packets already
96 @retval EFI_DEVICE_ERROR A device error occurred while attempting to send
97 the SCSI Request Packet.
98 @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid.
99 @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet
100 is not supported by the SCSI initiator(i.e., SCSI
102 @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
103 Request Packet to execute.
109 IN EFI_SCSI_IO_PROTOCOL
*ScsiIo
,
112 IN OUT UINT8
*SenseDataLength
,
113 OUT UINT8
*HostAdapterStatus
,
114 OUT UINT8
*TargetStatus
,
115 IN OUT VOID
*InquiryDataBuffer
,
116 IN OUT UINT32
*InquiryDataLength
,
117 IN BOOLEAN EnableVitalProductData
122 Function to submit SCSI mode sense 10 command.
124 @param[in] ScsiIo A pointer to SCSI IO protocol.
125 @param[in] Timeout The length of timeout period.
126 @param[out] SenseData A pointer to output sense data.
127 @param[in,out] SenseDataLength The length of output sense data.
128 @param[out] HostAdapterStatus The status of Host Adapter.
129 @param[out] TargetStatus The status of the target.
130 @param[in] DataBuffer A pointer to input data buffer.
131 @param[in,out] DataLength The length of input data buffer.
132 @param[in] DBDField The DBD Field (Optional).
133 @param[in] PageControl Page Control.
134 @param[in] PageCode Page code.
136 @retval EFI_SUCCESS The status of the unit is tested successfully.
137 @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
138 but the entire DataBuffer could not be transferred.
139 The actual number of bytes transferred is returned
141 @retval EFI_NOT_READY The SCSI Request Packet could not be sent because
142 there are too many SCSI Command Packets already
144 @retval EFI_DEVICE_ERROR A device error occurred while attempting to send
145 the SCSI Request Packet.
146 @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid.
147 @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet
148 is not supported by the SCSI initiator(i.e., SCSI
150 @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
151 Request Packet to execute.
156 ScsiModeSense10Command (
157 IN EFI_SCSI_IO_PROTOCOL
*ScsiIo
,
160 IN OUT UINT8
*SenseDataLength
,
161 OUT UINT8
*HostAdapterStatus
,
162 OUT UINT8
*TargetStatus
,
164 IN OUT UINT32
*DataLength
,
165 IN UINT8 DBDField
, OPTIONAL
166 IN UINT8 PageControl
,
173 Function to submit SCSI request sense command.
174 ScsiIo - A pointer to SCSI IO protocol.
175 Timeout - The length of timeout period.
176 SenseData - A pointer to output sense data.
177 SenseDataLength - The length of output sense data.
178 HostAdapterStatus - The status of Host Adapter.
179 TargetStatus - The status of the target.
181 @param[in] ScsiIo SCSI IO Protocol to use
182 @param[in] Timeout TODO:
183 @param[out] SenseData TODO:
184 @param[in,out] SenseDataLength TODO:
185 @param[out] HostAdapterStatus TODO:
186 @param[out] TargetStatus TODO:
188 @retval EFI_SUCCESS Valid data returned
189 @retval EFI_SUCCESS The status of the unit is tested successfully.
190 @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
191 but the entire DataBuffer could not be transferred.
192 The actual number of bytes transferred is returned
194 @retval EFI_NOT_READY The SCSI Request Packet could not be sent because
195 there are too many SCSI Command Packets already
197 @retval EFI_DEVICE_ERROR A device error occurred while attempting to send
198 the SCSI Request Packet.
199 @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid.
200 @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet
201 is not supported by the SCSI initiator(i.e., SCSI
203 @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
204 Request Packet to execute.
209 ScsiRequestSenseCommand (
210 IN EFI_SCSI_IO_PROTOCOL
*ScsiIo
,
213 IN OUT UINT8
*SenseDataLength
,
214 OUT UINT8
*HostAdapterStatus
,
215 OUT UINT8
*TargetStatus
220 Function to submit read capacity command.
222 @param[in] ScsiIo A pointer to SCSI IO protocol.
223 @param[in] Timeout The length of timeout period.
224 @param[out] SenseData A pointer to output sense data.
225 @param[in,out] SenseDataLength The length of output sense data.
226 @param[out] HostAdapterStatus The status of Host Adapter.
227 @param[out] TargetStatus The status of the target.
228 @param[out] DataBuffer A pointer to a data buffer.
229 @param[in,out] DataLength The length of data buffer.
230 @param[in] PMI Partial medium indicator.
232 @retval EFI_SUCCESS The status of the unit is tested successfully.
233 @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
234 but the entire DataBuffer could not be transferred.
235 The actual number of bytes transferred is returned
237 @retval EFI_NOT_READY The SCSI Request Packet could not be sent because
238 there are too many SCSI Command Packets already
240 @retval EFI_DEVICE_ERROR A device error occurred while attempting to send
241 the SCSI Request Packet.
242 @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid.
243 @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet
244 is not supported by the SCSI initiator(i.e., SCSI
246 @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
247 Request Packet to execute.
252 ScsiReadCapacityCommand (
253 IN EFI_SCSI_IO_PROTOCOL
*ScsiIo
,
256 IN OUT UINT8
*SenseDataLength
,
257 OUT UINT8
*HostAdapterStatus
,
258 OUT UINT8
*TargetStatus
,
259 OUT VOID
*DataBuffer
,
260 IN OUT UINT32
*DataLength
,
266 Function to submit read 10 command.
268 @param[in] ScsiIo A pointer to SCSI IO protocol.
269 @param[in] Timeout The length of timeout period.
270 @param[out] SenseData A pointer to output sense data.
271 @param[in,out] SenseDataLength The length of output sense data.
272 @param[out] HostAdapterStatus The status of Host Adapter.
273 @param[out] TargetStatus The status of the target.
274 @param[out] DataBuffer Read 10 command data.
275 @param[in,out] DataLength The length of data buffer.
276 @param[in] StartLba The start address of LBA.
277 @param[in] SectorSize The sector size.
279 @retval EFI_SUCCESS The status of the unit is tested successfully.
280 @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
281 but the entire DataBuffer could not be transferred.
282 The actual number of bytes transferred is returned
284 @retval EFI_NOT_READY The SCSI Request Packet could not be sent because
285 there are too many SCSI Command Packets already
287 @retval EFI_DEVICE_ERROR A device error occurred while attempting to send
288 the SCSI Request Packet.
289 @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid.
290 @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet
291 is not supported by the SCSI initiator(i.e., SCSI
293 @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
294 Request Packet to execute.
300 IN EFI_SCSI_IO_PROTOCOL
*ScsiIo
,
303 IN OUT UINT8
*SenseDataLength
,
304 OUT UINT8
*HostAdapterStatus
,
305 OUT UINT8
*TargetStatus
,
306 OUT VOID
*DataBuffer
,
307 IN OUT UINT32
*DataLength
,
314 Function to submit SCSI write 10 command.
316 @param[in] ScsiIo SCSI IO Protocol to use
317 @param[in] Timeout The length of timeout period.
318 @param[out] SenseData A pointer to output sense data.
319 @param[in,out] SenseDataLength The length of output sense data.
320 @param[out] HostAdapterStatus The status of Host Adapter.
321 @param[out] TargetStatus The status of the target.
322 @param[out] DataBuffer A pointer to a data buffer.
323 @param[in,out] DataLength The length of data buffer.
324 @param[in] StartLba The start address of LBA.
325 @param[in] SectorSize The sector size.
327 @retval EFI_SUCCESS The status of the unit is tested successfully.
328 @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
329 but the entire DataBuffer could not be transferred.
330 The actual number of bytes transferred is returned
332 @retval EFI_NOT_READY The SCSI Request Packet could not be sent because
333 there are too many SCSI Command Packets already
335 @retval EFI_DEVICE_ERROR A device error occurred while attempting to send
336 the SCSI Request Packet.
337 @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid.
338 @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet
339 is not supported by the SCSI initiator(i.e., SCSI
341 @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
342 Request Packet to execute.
348 IN EFI_SCSI_IO_PROTOCOL
*ScsiIo
,
351 IN OUT UINT8
*SenseDataLength
,
352 OUT UINT8
*HostAdapterStatus
,
353 OUT UINT8
*TargetStatus
,
354 OUT VOID
*DataBuffer
,
355 IN OUT UINT32
*DataLength
,