]>
Commit | Line | Data |
---|---|---|
3b2dbece | 1 | /** @file\r |
2 | SCSI disk driver that layers on every SCSI IO protocol in the system.\r | |
6ad55b15 | 3 | \r |
3b7f0a48 | 4 | Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>\r |
cd5ebaa0 | 5 | This program and the accompanying materials\r |
3b2dbece | 6 | are licensed and made available under the terms and conditions of the BSD License\r |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
6ad55b15 | 9 | \r |
3b2dbece | 10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
6ad55b15 | 12 | \r |
3b2dbece | 13 | **/\r |
ed7748fe | 14 | \r |
6ad55b15 | 15 | \r |
16 | #include "ScsiDisk.h"\r | |
17 | \r | |
18 | EFI_DRIVER_BINDING_PROTOCOL gScsiDiskDriverBinding = {\r | |
19 | ScsiDiskDriverBindingSupported,\r | |
20 | ScsiDiskDriverBindingStart,\r | |
21 | ScsiDiskDriverBindingStop,\r | |
22 | 0xa,\r | |
23 | NULL,\r | |
24 | NULL\r | |
25 | };\r | |
26 | \r | |
d716651f | 27 | EFI_DISK_INFO_PROTOCOL gScsiDiskInfoProtocolTemplate = {\r |
28 | EFI_DISK_INFO_SCSI_INTERFACE_GUID,\r | |
29 | ScsiDiskInfoInquiry,\r | |
30 | ScsiDiskInfoIdentify,\r | |
31 | ScsiDiskInfoSenseData,\r | |
32 | ScsiDiskInfoWhichIde\r | |
33 | };\r | |
9b38ff34 | 34 | \r |
957fe093 SZ |
35 | /**\r |
36 | Allocates an aligned buffer for SCSI disk.\r | |
37 | \r | |
38 | This function allocates an aligned buffer for the SCSI disk to perform\r | |
39 | SCSI IO operations. The alignment requirement is from SCSI IO interface.\r | |
40 | \r | |
41 | @param ScsiDiskDevice The SCSI disk involved for the operation.\r | |
42 | @param BufferSize The request buffer size.\r | |
43 | \r | |
44 | @return A pointer to the aligned buffer or NULL if the allocation fails.\r | |
45 | \r | |
46 | **/\r | |
47 | VOID *\r | |
48 | AllocateAlignedBuffer (\r | |
49 | IN SCSI_DISK_DEV *ScsiDiskDevice,\r | |
50 | IN UINTN BufferSize\r | |
51 | )\r | |
52 | {\r | |
53 | return AllocateAlignedPages (EFI_SIZE_TO_PAGES (BufferSize), ScsiDiskDevice->ScsiIo->IoAlign);\r | |
54 | }\r | |
55 | \r | |
56 | /**\r | |
57 | Frees an aligned buffer for SCSI disk.\r | |
58 | \r | |
59 | This function frees an aligned buffer for the SCSI disk to perform\r | |
60 | SCSI IO operations.\r | |
61 | \r | |
62 | @param Buffer The aligned buffer to be freed.\r | |
63 | @param BufferSize The request buffer size.\r | |
64 | \r | |
65 | **/\r | |
66 | VOID\r | |
67 | FreeAlignedBuffer (\r | |
68 | IN VOID *Buffer,\r | |
69 | IN UINTN BufferSize\r | |
70 | )\r | |
71 | {\r | |
72 | if (Buffer != NULL) {\r | |
73 | FreeAlignedPages (Buffer, EFI_SIZE_TO_PAGES (BufferSize));\r | |
74 | }\r | |
75 | }\r | |
76 | \r | |
6ad55b15 | 77 | /**\r |
9beb888e | 78 | The user Entry Point for module ScsiDisk.\r |
79 | \r | |
80 | The user code starts with this function.\r | |
6ad55b15 | 81 | \r |
9beb888e | 82 | @param ImageHandle The firmware allocated handle for the EFI image. \r |
83 | @param SystemTable A pointer to the EFI System Table.\r | |
6ad55b15 | 84 | \r |
85 | @retval EFI_SUCCESS The entry point is executed successfully.\r | |
86 | @retval other Some error occurs when executing this entry point.\r | |
87 | \r | |
88 | **/\r | |
89 | EFI_STATUS\r | |
90 | EFIAPI\r | |
91 | InitializeScsiDisk(\r | |
92 | IN EFI_HANDLE ImageHandle,\r | |
93 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
94 | )\r | |
95 | {\r | |
96 | EFI_STATUS Status;\r | |
97 | \r | |
98 | //\r | |
99 | // Install driver model protocol(s).\r | |
100 | //\r | |
70da5bc2 | 101 | Status = EfiLibInstallDriverBindingComponentName2 (\r |
6ad55b15 | 102 | ImageHandle,\r |
103 | SystemTable,\r | |
104 | &gScsiDiskDriverBinding,\r | |
105 | ImageHandle,\r | |
106 | &gScsiDiskComponentName,\r | |
70da5bc2 | 107 | &gScsiDiskComponentName2\r |
6ad55b15 | 108 | );\r |
109 | ASSERT_EFI_ERROR (Status);\r | |
110 | \r | |
111 | \r | |
112 | return Status;\r | |
113 | }\r | |
114 | \r | |
9beb888e | 115 | /**\r |
116 | Test to see if this driver supports ControllerHandle.\r | |
117 | \r | |
118 | This service is called by the EFI boot service ConnectController(). In order\r | |
119 | to make drivers as small as possible, there are a few calling restrictions for\r | |
120 | this service. ConnectController() must follow these calling restrictions.\r | |
121 | If any other agent wishes to call Supported() it must also follow these\r | |
122 | calling restrictions.\r | |
123 | \r | |
124 | @param This Protocol instance pointer.\r | |
125 | @param ControllerHandle Handle of device to test\r | |
126 | @param RemainingDevicePath Optional parameter use to pick a specific child\r | |
127 | device to start.\r | |
128 | \r | |
129 | @retval EFI_SUCCESS This driver supports this device\r | |
130 | @retval EFI_ALREADY_STARTED This driver is already running on this device\r | |
131 | @retval other This driver does not support this device\r | |
132 | \r | |
133 | **/\r | |
6ad55b15 | 134 | EFI_STATUS\r |
135 | EFIAPI\r | |
136 | ScsiDiskDriverBindingSupported (\r | |
137 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
138 | IN EFI_HANDLE Controller,\r | |
9beb888e | 139 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r |
6ad55b15 | 140 | )\r |
6ad55b15 | 141 | {\r |
142 | EFI_STATUS Status;\r | |
143 | EFI_SCSI_IO_PROTOCOL *ScsiIo;\r | |
144 | UINT8 DeviceType;\r | |
145 | \r | |
146 | Status = gBS->OpenProtocol (\r | |
147 | Controller,\r | |
148 | &gEfiScsiIoProtocolGuid,\r | |
149 | (VOID **) &ScsiIo,\r | |
150 | This->DriverBindingHandle,\r | |
151 | Controller,\r | |
152 | EFI_OPEN_PROTOCOL_BY_DRIVER\r | |
153 | );\r | |
154 | if (EFI_ERROR (Status)) {\r | |
155 | return Status;\r | |
156 | }\r | |
157 | \r | |
158 | Status = ScsiIo->GetDeviceType (ScsiIo, &DeviceType);\r | |
159 | if (!EFI_ERROR (Status)) {\r | |
160 | if ((DeviceType == EFI_SCSI_TYPE_DISK) || (DeviceType == EFI_SCSI_TYPE_CDROM)) {\r | |
161 | Status = EFI_SUCCESS;\r | |
162 | } else {\r | |
163 | Status = EFI_UNSUPPORTED;\r | |
164 | }\r | |
165 | }\r | |
166 | \r | |
167 | gBS->CloseProtocol (\r | |
f36d6e66 | 168 | Controller,\r |
169 | &gEfiScsiIoProtocolGuid,\r | |
170 | This->DriverBindingHandle,\r | |
171 | Controller\r | |
172 | );\r | |
6ad55b15 | 173 | return Status;\r |
174 | }\r | |
175 | \r | |
9beb888e | 176 | \r |
177 | /**\r | |
178 | Start this driver on ControllerHandle.\r | |
179 | \r | |
180 | This service is called by the EFI boot service ConnectController(). In order\r | |
181 | to make drivers as small as possible, there are a few calling restrictions for\r | |
182 | this service. ConnectController() must follow these calling restrictions. If\r | |
183 | any other agent wishes to call Start() it must also follow these calling\r | |
184 | restrictions.\r | |
185 | \r | |
186 | @param This Protocol instance pointer.\r | |
187 | @param ControllerHandle Handle of device to bind driver to\r | |
188 | @param RemainingDevicePath Optional parameter use to pick a specific child\r | |
189 | device to start.\r | |
190 | \r | |
191 | @retval EFI_SUCCESS This driver is added to ControllerHandle\r | |
192 | @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle\r | |
193 | @retval other This driver does not support this device\r | |
194 | \r | |
195 | **/\r | |
6ad55b15 | 196 | EFI_STATUS\r |
197 | EFIAPI\r | |
198 | ScsiDiskDriverBindingStart (\r | |
199 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
200 | IN EFI_HANDLE Controller,\r | |
9beb888e | 201 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r |
6ad55b15 | 202 | )\r |
6ad55b15 | 203 | {\r |
204 | EFI_STATUS Status;\r | |
205 | EFI_SCSI_IO_PROTOCOL *ScsiIo;\r | |
206 | SCSI_DISK_DEV *ScsiDiskDevice;\r | |
207 | BOOLEAN Temp;\r | |
208 | UINT8 Index;\r | |
209 | UINT8 MaxRetry;\r | |
210 | BOOLEAN NeedRetry;\r | |
cbd2a4b3 | 211 | BOOLEAN MustReadCapacity;\r |
212 | \r | |
213 | MustReadCapacity = TRUE;\r | |
6ad55b15 | 214 | \r |
9b38ff34 | 215 | ScsiDiskDevice = (SCSI_DISK_DEV *) AllocateZeroPool (sizeof (SCSI_DISK_DEV));\r |
216 | if (ScsiDiskDevice == NULL) {\r | |
217 | return EFI_OUT_OF_RESOURCES;\r | |
6ad55b15 | 218 | }\r |
219 | \r | |
6ad55b15 | 220 | Status = gBS->OpenProtocol (\r |
221 | Controller,\r | |
222 | &gEfiScsiIoProtocolGuid,\r | |
223 | (VOID **) &ScsiIo,\r | |
224 | This->DriverBindingHandle,\r | |
225 | Controller,\r | |
226 | EFI_OPEN_PROTOCOL_BY_DRIVER\r | |
227 | );\r | |
228 | if (EFI_ERROR (Status)) {\r | |
9b38ff34 | 229 | FreePool (ScsiDiskDevice);\r |
6ad55b15 | 230 | return Status;\r |
231 | }\r | |
232 | \r | |
3b7f0a48 FT |
233 | ScsiDiskDevice->Signature = SCSI_DISK_DEV_SIGNATURE;\r |
234 | ScsiDiskDevice->ScsiIo = ScsiIo;\r | |
235 | ScsiDiskDevice->BlkIo.Revision = EFI_BLOCK_IO_PROTOCOL_REVISION3;\r | |
236 | ScsiDiskDevice->BlkIo.Media = &ScsiDiskDevice->BlkIoMedia;\r | |
237 | ScsiDiskDevice->BlkIo.Media->IoAlign = ScsiIo->IoAlign;\r | |
238 | ScsiDiskDevice->BlkIo.Reset = ScsiDiskReset;\r | |
239 | ScsiDiskDevice->BlkIo.ReadBlocks = ScsiDiskReadBlocks;\r | |
240 | ScsiDiskDevice->BlkIo.WriteBlocks = ScsiDiskWriteBlocks;\r | |
241 | ScsiDiskDevice->BlkIo.FlushBlocks = ScsiDiskFlushBlocks;\r | |
242 | ScsiDiskDevice->Handle = Controller;\r | |
6ad55b15 | 243 | \r |
244 | ScsiIo->GetDeviceType (ScsiIo, &(ScsiDiskDevice->DeviceType));\r | |
245 | switch (ScsiDiskDevice->DeviceType) {\r | |
246 | case EFI_SCSI_TYPE_DISK:\r | |
247 | ScsiDiskDevice->BlkIo.Media->BlockSize = 0x200;\r | |
cbd2a4b3 | 248 | MustReadCapacity = TRUE;\r |
6ad55b15 | 249 | break;\r |
250 | \r | |
251 | case EFI_SCSI_TYPE_CDROM:\r | |
252 | ScsiDiskDevice->BlkIo.Media->BlockSize = 0x800;\r | |
cbd2a4b3 | 253 | MustReadCapacity = FALSE;\r |
6ad55b15 | 254 | break;\r |
255 | }\r | |
256 | //\r | |
257 | // The Sense Data Array's initial size is 6\r | |
258 | //\r | |
259 | ScsiDiskDevice->SenseDataNumber = 6;\r | |
9b38ff34 | 260 | ScsiDiskDevice->SenseData = (EFI_SCSI_SENSE_DATA *) AllocateZeroPool (\r |
261 | sizeof (EFI_SCSI_SENSE_DATA) * ScsiDiskDevice->SenseDataNumber\r | |
262 | );\r | |
263 | if (ScsiDiskDevice->SenseData == NULL) {\r | |
6ad55b15 | 264 | gBS->CloseProtocol (\r |
265 | Controller,\r | |
266 | &gEfiScsiIoProtocolGuid,\r | |
267 | This->DriverBindingHandle,\r | |
268 | Controller\r | |
269 | );\r | |
9b38ff34 | 270 | FreePool (ScsiDiskDevice);\r |
271 | return EFI_OUT_OF_RESOURCES;\r | |
6ad55b15 | 272 | }\r |
273 | \r | |
6ad55b15 | 274 | //\r |
dfe687ca | 275 | // Retrieve device information\r |
6ad55b15 | 276 | //\r |
277 | MaxRetry = 2;\r | |
278 | for (Index = 0; Index < MaxRetry; Index++) {\r | |
279 | Status = ScsiDiskInquiryDevice (ScsiDiskDevice, &NeedRetry);\r | |
280 | if (!EFI_ERROR (Status)) {\r | |
281 | break;\r | |
282 | }\r | |
283 | \r | |
284 | if (!NeedRetry) {\r | |
9b38ff34 | 285 | FreePool (ScsiDiskDevice->SenseData);\r |
6ad55b15 | 286 | gBS->CloseProtocol (\r |
f36d6e66 | 287 | Controller,\r |
288 | &gEfiScsiIoProtocolGuid,\r | |
289 | This->DriverBindingHandle,\r | |
290 | Controller\r | |
291 | );\r | |
9b38ff34 | 292 | FreePool (ScsiDiskDevice);\r |
6ad55b15 | 293 | return EFI_DEVICE_ERROR;\r |
294 | }\r | |
295 | }\r | |
296 | //\r | |
297 | // The second parameter "TRUE" means must\r | |
298 | // retrieve media capacity\r | |
299 | //\r | |
cbd2a4b3 | 300 | Status = ScsiDiskDetectMedia (ScsiDiskDevice, MustReadCapacity, &Temp);\r |
6ad55b15 | 301 | if (!EFI_ERROR (Status)) {\r |
d14faa52 | 302 | //\r |
303 | // Determine if Block IO should be produced on this controller handle\r | |
304 | //\r | |
305 | if (DetermineInstallBlockIo(Controller)) {\r | |
d716651f | 306 | InitializeInstallDiskInfo(ScsiDiskDevice, Controller);\r |
d14faa52 | 307 | Status = gBS->InstallMultipleProtocolInterfaces (\r |
308 | &Controller,\r | |
309 | &gEfiBlockIoProtocolGuid,\r | |
310 | &ScsiDiskDevice->BlkIo,\r | |
d716651f | 311 | &gEfiDiskInfoProtocolGuid,\r |
312 | &ScsiDiskDevice->DiskInfo,\r | |
d14faa52 | 313 | NULL\r |
314 | );\r | |
315 | if (!EFI_ERROR(Status)) {\r | |
316 | ScsiDiskDevice->ControllerNameTable = NULL;\r | |
317 | AddUnicodeString2 (\r | |
318 | "eng",\r | |
319 | gScsiDiskComponentName.SupportedLanguages,\r | |
320 | &ScsiDiskDevice->ControllerNameTable,\r | |
321 | L"SCSI Disk Device",\r | |
322 | TRUE\r | |
323 | );\r | |
324 | AddUnicodeString2 (\r | |
325 | "en",\r | |
326 | gScsiDiskComponentName2.SupportedLanguages,\r | |
327 | &ScsiDiskDevice->ControllerNameTable,\r | |
328 | L"SCSI Disk Device",\r | |
329 | FALSE\r | |
330 | );\r | |
331 | return EFI_SUCCESS;\r | |
332 | }\r | |
333 | } \r | |
6ad55b15 | 334 | }\r |
335 | \r | |
d14faa52 | 336 | gBS->FreePool (ScsiDiskDevice->SenseData);\r |
337 | gBS->FreePool (ScsiDiskDevice);\r | |
338 | gBS->CloseProtocol (\r | |
339 | Controller,\r | |
340 | &gEfiScsiIoProtocolGuid,\r | |
341 | This->DriverBindingHandle,\r | |
342 | Controller\r | |
343 | );\r | |
344 | return Status;\r | |
345 | \r | |
6ad55b15 | 346 | }\r |
347 | \r | |
9beb888e | 348 | \r |
349 | /**\r | |
350 | Stop this driver on ControllerHandle.\r | |
351 | \r | |
352 | This service is called by the EFI boot service DisconnectController().\r | |
353 | In order to make drivers as small as possible, there are a few calling\r | |
354 | restrictions for this service. DisconnectController() must follow these\r | |
355 | calling restrictions. If any other agent wishes to call Stop() it must\r | |
356 | also follow these calling restrictions.\r | |
357 | \r | |
358 | @param This Protocol instance pointer.\r | |
359 | @param ControllerHandle Handle of device to stop driver on\r | |
360 | @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r | |
361 | children is zero stop the entire bus driver.\r | |
362 | @param ChildHandleBuffer List of Child Handles to Stop.\r | |
363 | \r | |
364 | @retval EFI_SUCCESS This driver is removed ControllerHandle\r | |
365 | @retval other This driver was not removed from this device\r | |
366 | \r | |
367 | **/\r | |
6ad55b15 | 368 | EFI_STATUS\r |
369 | EFIAPI\r | |
370 | ScsiDiskDriverBindingStop (\r | |
371 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
372 | IN EFI_HANDLE Controller,\r | |
373 | IN UINTN NumberOfChildren,\r | |
9beb888e | 374 | IN EFI_HANDLE *ChildHandleBuffer OPTIONAL\r |
6ad55b15 | 375 | )\r |
6ad55b15 | 376 | {\r |
377 | EFI_BLOCK_IO_PROTOCOL *BlkIo;\r | |
378 | SCSI_DISK_DEV *ScsiDiskDevice;\r | |
379 | EFI_STATUS Status;\r | |
380 | \r | |
381 | Status = gBS->OpenProtocol (\r | |
382 | Controller,\r | |
383 | &gEfiBlockIoProtocolGuid,\r | |
384 | (VOID **) &BlkIo,\r | |
385 | This->DriverBindingHandle,\r | |
386 | Controller,\r | |
387 | EFI_OPEN_PROTOCOL_GET_PROTOCOL\r | |
388 | );\r | |
389 | if (EFI_ERROR (Status)) {\r | |
390 | return Status;\r | |
391 | }\r | |
392 | \r | |
393 | ScsiDiskDevice = SCSI_DISK_DEV_FROM_THIS (BlkIo);\r | |
d716651f | 394 | Status = gBS->UninstallMultipleProtocolInterfaces (\r |
6ad55b15 | 395 | Controller,\r |
396 | &gEfiBlockIoProtocolGuid,\r | |
d716651f | 397 | &ScsiDiskDevice->BlkIo,\r |
398 | &gEfiDiskInfoProtocolGuid,\r | |
399 | &ScsiDiskDevice->DiskInfo,\r | |
400 | NULL\r | |
6ad55b15 | 401 | );\r |
402 | if (!EFI_ERROR (Status)) {\r | |
403 | gBS->CloseProtocol (\r | |
f36d6e66 | 404 | Controller,\r |
405 | &gEfiScsiIoProtocolGuid,\r | |
406 | This->DriverBindingHandle,\r | |
407 | Controller\r | |
408 | );\r | |
6ad55b15 | 409 | \r |
410 | ReleaseScsiDiskDeviceResources (ScsiDiskDevice);\r | |
411 | \r | |
412 | return EFI_SUCCESS;\r | |
413 | }\r | |
414 | //\r | |
415 | // errors met\r | |
416 | //\r | |
417 | return Status;\r | |
418 | }\r | |
419 | \r | |
9beb888e | 420 | /**\r |
421 | Reset SCSI Disk.\r | |
422 | \r | |
6ad55b15 | 423 | \r |
9beb888e | 424 | @param This The pointer of EFI_BLOCK_IO_PROTOCOL\r |
425 | @param ExtendedVerification The flag about if extend verificate\r | |
426 | \r | |
427 | @retval EFI_SUCCESS The device was reset.\r | |
428 | @retval EFI_DEVICE_ERROR The device is not functioning properly and could\r | |
429 | not be reset.\r | |
d716651f | 430 | @return EFI_STATUS is returned from EFI_SCSI_IO_PROTOCOL.ResetDevice().\r |
9beb888e | 431 | \r |
432 | **/\r | |
6ad55b15 | 433 | EFI_STATUS\r |
434 | EFIAPI\r | |
435 | ScsiDiskReset (\r | |
436 | IN EFI_BLOCK_IO_PROTOCOL *This,\r | |
437 | IN BOOLEAN ExtendedVerification\r | |
438 | )\r | |
6ad55b15 | 439 | {\r |
f36d6e66 | 440 | EFI_TPL OldTpl;\r |
6ad55b15 | 441 | SCSI_DISK_DEV *ScsiDiskDevice;\r |
442 | EFI_STATUS Status;\r | |
6ad55b15 | 443 | \r |
444 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r | |
445 | \r | |
446 | ScsiDiskDevice = SCSI_DISK_DEV_FROM_THIS (This);\r | |
447 | \r | |
448 | Status = ScsiDiskDevice->ScsiIo->ResetDevice (ScsiDiskDevice->ScsiIo);\r | |
449 | \r | |
c6e797ae | 450 | if (EFI_ERROR (Status)) {\r |
451 | Status = EFI_DEVICE_ERROR;\r | |
452 | goto Done;\r | |
453 | }\r | |
454 | \r | |
6ad55b15 | 455 | if (!ExtendedVerification) {\r |
456 | goto Done;\r | |
457 | }\r | |
458 | \r | |
459 | Status = ScsiDiskDevice->ScsiIo->ResetBus (ScsiDiskDevice->ScsiIo);\r | |
460 | \r | |
c6e797ae | 461 | if (EFI_ERROR (Status)) {\r |
462 | Status = EFI_DEVICE_ERROR;\r | |
463 | goto Done;\r | |
464 | }\r | |
465 | \r | |
6ad55b15 | 466 | Done:\r |
467 | gBS->RestoreTPL (OldTpl);\r | |
468 | return Status;\r | |
469 | }\r | |
470 | \r | |
9beb888e | 471 | /**\r |
472 | The function is to Read Block from SCSI Disk.\r | |
473 | \r | |
474 | @param This The pointer of EFI_BLOCK_IO_PROTOCOL.\r | |
475 | @param MediaId The Id of Media detected\r | |
476 | @param Lba The logic block address\r | |
477 | @param BufferSize The size of Buffer\r | |
478 | @param Buffer The buffer to fill the read out data\r | |
479 | \r | |
480 | @retval EFI_SUCCESS Successfully to read out block.\r | |
481 | @retval EFI_DEVICE_ERROR Fail to detect media.\r | |
482 | @retval EFI_NO_MEDIA Media is not present.\r | |
483 | @retval EFI_MEDIA_CHANGED Media has changed.\r | |
484 | @retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device.\r | |
485 | @retval EFI_INVALID_PARAMETER Invalid parameter passed in.\r | |
486 | \r | |
487 | **/\r | |
6ad55b15 | 488 | EFI_STATUS\r |
489 | EFIAPI\r | |
490 | ScsiDiskReadBlocks (\r | |
491 | IN EFI_BLOCK_IO_PROTOCOL *This,\r | |
492 | IN UINT32 MediaId,\r | |
9beb888e | 493 | IN EFI_LBA Lba,\r |
6ad55b15 | 494 | IN UINTN BufferSize,\r |
495 | OUT VOID *Buffer\r | |
496 | )\r | |
6ad55b15 | 497 | {\r |
498 | SCSI_DISK_DEV *ScsiDiskDevice;\r | |
499 | EFI_BLOCK_IO_MEDIA *Media;\r | |
500 | EFI_STATUS Status;\r | |
501 | UINTN BlockSize;\r | |
502 | UINTN NumberOfBlocks;\r | |
503 | BOOLEAN MediaChange;\r | |
504 | EFI_TPL OldTpl;\r | |
505 | \r | |
fcf5e49d RN |
506 | MediaChange = FALSE;\r |
507 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r | |
6ad55b15 | 508 | ScsiDiskDevice = SCSI_DISK_DEV_FROM_THIS (This);\r |
509 | \r | |
9beb888e | 510 | if (!IS_DEVICE_FIXED(ScsiDiskDevice)) {\r |
6ad55b15 | 511 | \r |
512 | Status = ScsiDiskDetectMedia (ScsiDiskDevice, FALSE, &MediaChange);\r | |
513 | if (EFI_ERROR (Status)) {\r | |
514 | Status = EFI_DEVICE_ERROR;\r | |
515 | goto Done;\r | |
516 | }\r | |
517 | \r | |
518 | if (MediaChange) {\r | |
519 | gBS->ReinstallProtocolInterface (\r | |
520 | ScsiDiskDevice->Handle,\r | |
521 | &gEfiBlockIoProtocolGuid,\r | |
522 | &ScsiDiskDevice->BlkIo,\r | |
523 | &ScsiDiskDevice->BlkIo\r | |
524 | );\r | |
9c922525 | 525 | Status = EFI_MEDIA_CHANGED;\r |
526 | goto Done;\r | |
6ad55b15 | 527 | }\r |
528 | }\r | |
529 | //\r | |
530 | // Get the intrinsic block size\r | |
531 | //\r | |
532 | Media = ScsiDiskDevice->BlkIo.Media;\r | |
533 | BlockSize = Media->BlockSize;\r | |
534 | \r | |
535 | NumberOfBlocks = BufferSize / BlockSize;\r | |
536 | \r | |
537 | if (!(Media->MediaPresent)) {\r | |
538 | Status = EFI_NO_MEDIA;\r | |
539 | goto Done;\r | |
540 | }\r | |
541 | \r | |
542 | if (MediaId != Media->MediaId) {\r | |
543 | Status = EFI_MEDIA_CHANGED;\r | |
544 | goto Done;\r | |
545 | }\r | |
546 | \r | |
fcf5e49d RN |
547 | if (Buffer == NULL) {\r |
548 | Status = EFI_INVALID_PARAMETER;\r | |
549 | goto Done;\r | |
550 | }\r | |
551 | \r | |
552 | if (BufferSize == 0) {\r | |
553 | Status = EFI_SUCCESS;\r | |
554 | goto Done;\r | |
555 | }\r | |
556 | \r | |
6ad55b15 | 557 | if (BufferSize % BlockSize != 0) {\r |
558 | Status = EFI_BAD_BUFFER_SIZE;\r | |
559 | goto Done;\r | |
560 | }\r | |
561 | \r | |
9beb888e | 562 | if (Lba > Media->LastBlock) {\r |
6ad55b15 | 563 | Status = EFI_INVALID_PARAMETER;\r |
564 | goto Done;\r | |
565 | }\r | |
566 | \r | |
9beb888e | 567 | if ((Lba + NumberOfBlocks - 1) > Media->LastBlock) {\r |
6ad55b15 | 568 | Status = EFI_INVALID_PARAMETER;\r |
569 | goto Done;\r | |
570 | }\r | |
571 | \r | |
572 | if ((Media->IoAlign > 1) && (((UINTN) Buffer & (Media->IoAlign - 1)) != 0)) {\r | |
573 | Status = EFI_INVALID_PARAMETER;\r | |
574 | goto Done;\r | |
575 | }\r | |
f36d6e66 | 576 | \r |
6ad55b15 | 577 | //\r |
f36d6e66 | 578 | // If all the parameters are valid, then perform read sectors command\r |
6ad55b15 | 579 | // to transfer data from device to host.\r |
580 | //\r | |
9beb888e | 581 | Status = ScsiDiskReadSectors (ScsiDiskDevice, Buffer, Lba, NumberOfBlocks);\r |
6ad55b15 | 582 | \r |
583 | Done:\r | |
584 | gBS->RestoreTPL (OldTpl);\r | |
585 | return Status;\r | |
586 | }\r | |
587 | \r | |
9beb888e | 588 | /**\r |
589 | The function is to Write Block to SCSI Disk.\r | |
590 | \r | |
591 | @param This The pointer of EFI_BLOCK_IO_PROTOCOL\r | |
592 | @param MediaId The Id of Media detected\r | |
593 | @param Lba The logic block address\r | |
594 | @param BufferSize The size of Buffer\r | |
595 | @param Buffer The buffer to fill the read out data\r | |
596 | \r | |
597 | @retval EFI_SUCCESS Successfully to read out block.\r | |
598 | @retval EFI_WRITE_PROTECTED The device can not be written to.\r | |
599 | @retval EFI_DEVICE_ERROR Fail to detect media.\r | |
600 | @retval EFI_NO_MEDIA Media is not present.\r | |
601 | @retval EFI_MEDIA_CHNAGED Media has changed.\r | |
602 | @retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device.\r | |
603 | @retval EFI_INVALID_PARAMETER Invalid parameter passed in.\r | |
604 | \r | |
605 | **/\r | |
6ad55b15 | 606 | EFI_STATUS\r |
607 | EFIAPI\r | |
608 | ScsiDiskWriteBlocks (\r | |
609 | IN EFI_BLOCK_IO_PROTOCOL *This,\r | |
610 | IN UINT32 MediaId,\r | |
9beb888e | 611 | IN EFI_LBA Lba,\r |
6ad55b15 | 612 | IN UINTN BufferSize,\r |
613 | IN VOID *Buffer\r | |
614 | )\r | |
6ad55b15 | 615 | {\r |
616 | SCSI_DISK_DEV *ScsiDiskDevice;\r | |
617 | EFI_BLOCK_IO_MEDIA *Media;\r | |
618 | EFI_STATUS Status;\r | |
619 | UINTN BlockSize;\r | |
620 | UINTN NumberOfBlocks;\r | |
621 | BOOLEAN MediaChange;\r | |
622 | EFI_TPL OldTpl;\r | |
623 | \r | |
fcf5e49d RN |
624 | MediaChange = FALSE;\r |
625 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r | |
6ad55b15 | 626 | ScsiDiskDevice = SCSI_DISK_DEV_FROM_THIS (This);\r |
627 | \r | |
9beb888e | 628 | if (!IS_DEVICE_FIXED(ScsiDiskDevice)) {\r |
6ad55b15 | 629 | \r |
630 | Status = ScsiDiskDetectMedia (ScsiDiskDevice, FALSE, &MediaChange);\r | |
631 | if (EFI_ERROR (Status)) {\r | |
632 | Status = EFI_DEVICE_ERROR;\r | |
633 | goto Done;\r | |
634 | }\r | |
635 | \r | |
636 | if (MediaChange) {\r | |
637 | gBS->ReinstallProtocolInterface (\r | |
638 | ScsiDiskDevice->Handle,\r | |
639 | &gEfiBlockIoProtocolGuid,\r | |
640 | &ScsiDiskDevice->BlkIo,\r | |
641 | &ScsiDiskDevice->BlkIo\r | |
642 | );\r | |
9c922525 | 643 | Status = EFI_MEDIA_CHANGED;\r |
644 | goto Done;\r | |
6ad55b15 | 645 | }\r |
646 | }\r | |
647 | //\r | |
648 | // Get the intrinsic block size\r | |
649 | //\r | |
650 | Media = ScsiDiskDevice->BlkIo.Media;\r | |
651 | BlockSize = Media->BlockSize;\r | |
652 | \r | |
653 | NumberOfBlocks = BufferSize / BlockSize;\r | |
654 | \r | |
655 | if (!(Media->MediaPresent)) {\r | |
656 | Status = EFI_NO_MEDIA;\r | |
657 | goto Done;\r | |
658 | }\r | |
659 | \r | |
660 | if (MediaId != Media->MediaId) {\r | |
661 | Status = EFI_MEDIA_CHANGED;\r | |
662 | goto Done;\r | |
663 | }\r | |
664 | \r | |
fcf5e49d RN |
665 | if (BufferSize == 0) {\r |
666 | Status = EFI_SUCCESS;\r | |
667 | goto Done;\r | |
668 | }\r | |
669 | \r | |
670 | if (Buffer == NULL) {\r | |
671 | Status = EFI_INVALID_PARAMETER;\r | |
672 | goto Done;\r | |
673 | }\r | |
674 | \r | |
6ad55b15 | 675 | if (BufferSize % BlockSize != 0) {\r |
676 | Status = EFI_BAD_BUFFER_SIZE;\r | |
677 | goto Done;\r | |
678 | }\r | |
679 | \r | |
9beb888e | 680 | if (Lba > Media->LastBlock) {\r |
6ad55b15 | 681 | Status = EFI_INVALID_PARAMETER;\r |
682 | goto Done;\r | |
683 | }\r | |
684 | \r | |
9beb888e | 685 | if ((Lba + NumberOfBlocks - 1) > Media->LastBlock) {\r |
6ad55b15 | 686 | Status = EFI_INVALID_PARAMETER;\r |
687 | goto Done;\r | |
688 | }\r | |
689 | \r | |
690 | if ((Media->IoAlign > 1) && (((UINTN) Buffer & (Media->IoAlign - 1)) != 0)) {\r | |
691 | Status = EFI_INVALID_PARAMETER;\r | |
692 | goto Done;\r | |
693 | }\r | |
694 | //\r | |
695 | // if all the parameters are valid, then perform read sectors command\r | |
696 | // to transfer data from device to host.\r | |
697 | //\r | |
9beb888e | 698 | Status = ScsiDiskWriteSectors (ScsiDiskDevice, Buffer, Lba, NumberOfBlocks);\r |
6ad55b15 | 699 | \r |
700 | Done:\r | |
701 | gBS->RestoreTPL (OldTpl);\r | |
6ad55b15 | 702 | return Status;\r |
703 | }\r | |
704 | \r | |
9beb888e | 705 | /**\r |
706 | Flush Block to Disk.\r | |
707 | \r | |
708 | EFI_SUCCESS is returned directly.\r | |
709 | \r | |
710 | @param This The pointer of EFI_BLOCK_IO_PROTOCOL\r | |
711 | \r | |
712 | @retval EFI_SUCCESS All outstanding data was written to the device\r | |
713 | \r | |
714 | **/\r | |
6ad55b15 | 715 | EFI_STATUS\r |
716 | EFIAPI\r | |
717 | ScsiDiskFlushBlocks (\r | |
718 | IN EFI_BLOCK_IO_PROTOCOL *This\r | |
719 | )\r | |
6ad55b15 | 720 | {\r |
721 | //\r | |
722 | // return directly\r | |
723 | //\r | |
724 | return EFI_SUCCESS;\r | |
725 | }\r | |
726 | \r | |
6ad55b15 | 727 | \r |
9beb888e | 728 | /**\r |
d716651f | 729 | Detect Device and read out capacity ,if error occurs, parse the sense key.\r |
6ad55b15 | 730 | \r |
9beb888e | 731 | @param ScsiDiskDevice The pointer of SCSI_DISK_DEV\r |
732 | @param MustReadCapacity The flag about reading device capacity\r | |
733 | @param MediaChange The pointer of flag indicates if media has changed \r | |
6ad55b15 | 734 | \r |
9beb888e | 735 | @retval EFI_DEVICE_ERROR Indicates that error occurs\r |
736 | @retval EFI_SUCCESS Successfully to detect media\r | |
6ad55b15 | 737 | \r |
9beb888e | 738 | **/\r |
739 | EFI_STATUS\r | |
740 | ScsiDiskDetectMedia (\r | |
741 | IN SCSI_DISK_DEV *ScsiDiskDevice,\r | |
742 | IN BOOLEAN MustReadCapacity,\r | |
743 | OUT BOOLEAN *MediaChange\r | |
744 | )\r | |
6ad55b15 | 745 | {\r |
746 | EFI_STATUS Status;\r | |
6ad55b15 | 747 | EFI_SCSI_SENSE_DATA *SenseData;\r |
748 | UINTN NumberOfSenseKeys;\r | |
749 | BOOLEAN NeedRetry;\r | |
750 | BOOLEAN NeedReadCapacity;\r | |
ae5dc795 | 751 | UINT8 Retry;\r |
6ad55b15 | 752 | UINT8 MaxRetry;\r |
753 | EFI_BLOCK_IO_MEDIA OldMedia;\r | |
754 | UINTN Action;\r | |
ae5dc795 | 755 | EFI_EVENT TimeoutEvt;\r |
6ad55b15 | 756 | \r |
757 | Status = EFI_SUCCESS;\r | |
6ad55b15 | 758 | SenseData = NULL;\r |
759 | NumberOfSenseKeys = 0;\r | |
ae5dc795 | 760 | Retry = 0;\r |
6ad55b15 | 761 | MaxRetry = 3;\r |
cbd2a4b3 | 762 | Action = ACTION_NO_ACTION;\r |
ae5dc795 | 763 | NeedReadCapacity = FALSE;\r |
764 | *MediaChange = FALSE;\r | |
765 | TimeoutEvt = NULL;\r | |
f36d6e66 | 766 | \r |
ae5dc795 | 767 | CopyMem (&OldMedia, ScsiDiskDevice->BlkIo.Media, sizeof (OldMedia));\r |
768 | \r | |
769 | Status = gBS->CreateEvent (\r | |
770 | EVT_TIMER,\r | |
771 | TPL_CALLBACK,\r | |
772 | NULL,\r | |
773 | NULL,\r | |
774 | &TimeoutEvt\r | |
775 | );\r | |
776 | if (EFI_ERROR (Status)) {\r | |
777 | return Status;\r | |
778 | }\r | |
779 | \r | |
780 | Status = gBS->SetTimer (TimeoutEvt, TimerRelative, EFI_TIMER_PERIOD_SECONDS(120));\r | |
781 | if (EFI_ERROR (Status)) {\r | |
782 | goto EXIT;\r | |
783 | }\r | |
784 | \r | |
785 | //\r | |
786 | // Sending Test_Unit cmd to poll device status.\r | |
787 | // If the sense data shows the drive is not ready or reset before, we need poll the device status again.\r | |
788 | // We limit the upper boundary to 120 seconds.\r | |
789 | //\r | |
790 | while (EFI_ERROR (gBS->CheckEvent (TimeoutEvt))) {\r | |
6ad55b15 | 791 | Status = ScsiDiskTestUnitReady (\r |
792 | ScsiDiskDevice,\r | |
793 | &NeedRetry,\r | |
794 | &SenseData,\r | |
795 | &NumberOfSenseKeys\r | |
796 | );\r | |
797 | if (!EFI_ERROR (Status)) {\r | |
cbd2a4b3 | 798 | Status = DetectMediaParsingSenseKeys (\r |
799 | ScsiDiskDevice,\r | |
800 | SenseData,\r | |
801 | NumberOfSenseKeys,\r | |
802 | &Action\r | |
803 | );\r | |
804 | if (EFI_ERROR (Status)) {\r | |
ae5dc795 | 805 | goto EXIT;\r |
cbd2a4b3 | 806 | } else if (Action == ACTION_RETRY_COMMAND_LATER) {\r |
807 | continue;\r | |
808 | } else {\r | |
809 | break;\r | |
810 | }\r | |
ae5dc795 | 811 | } else {\r |
812 | Retry++;\r | |
813 | if (!NeedRetry || (Retry >= MaxRetry)) {\r | |
814 | goto EXIT;\r | |
815 | }\r | |
6ad55b15 | 816 | }\r |
817 | }\r | |
818 | \r | |
ae5dc795 | 819 | if (EFI_ERROR (Status)) {\r |
820 | goto EXIT;\r | |
6ad55b15 | 821 | }\r |
822 | \r | |
6ad55b15 | 823 | //\r |
824 | // ACTION_NO_ACTION: need not read capacity\r | |
825 | // other action code: need read capacity\r | |
826 | //\r | |
cbd2a4b3 | 827 | if (Action == ACTION_READ_CAPACITY) {\r |
6ad55b15 | 828 | NeedReadCapacity = TRUE;\r |
829 | }\r | |
f36d6e66 | 830 | \r |
6ad55b15 | 831 | //\r |
832 | // either NeedReadCapacity is TRUE, or MustReadCapacity is TRUE,\r | |
833 | // retrieve capacity via Read Capacity command\r | |
834 | //\r | |
835 | if (NeedReadCapacity || MustReadCapacity) {\r | |
6ad55b15 | 836 | //\r |
837 | // retrieve media information\r | |
838 | //\r | |
ae5dc795 | 839 | for (Retry = 0; Retry < MaxRetry; Retry++) {\r |
840 | Status = ScsiDiskReadCapacity (\r | |
841 | ScsiDiskDevice,\r | |
842 | &NeedRetry,\r | |
843 | &SenseData,\r | |
844 | &NumberOfSenseKeys\r | |
845 | );\r | |
846 | if (!EFI_ERROR (Status)) {\r | |
6ad55b15 | 847 | //\r |
ae5dc795 | 848 | // analyze sense key to action\r |
6ad55b15 | 849 | //\r |
ae5dc795 | 850 | Status = DetectMediaParsingSenseKeys (\r |
851 | ScsiDiskDevice,\r | |
852 | SenseData,\r | |
853 | NumberOfSenseKeys,\r | |
854 | &Action\r | |
855 | );\r | |
856 | if (EFI_ERROR (Status)) {\r | |
857 | //\r | |
858 | // if Status is error, it may indicate crisis error,\r | |
859 | // so return without retry.\r | |
860 | //\r | |
861 | goto EXIT;\r | |
862 | } else if (Action == ACTION_RETRY_COMMAND_LATER) {\r | |
863 | Retry = 0;\r | |
864 | continue;\r | |
865 | } else {\r | |
866 | break;\r | |
867 | }\r | |
868 | } else { \r | |
869 | Retry++;\r | |
870 | if (!NeedRetry || (Retry >= MaxRetry)) {\r | |
871 | goto EXIT;\r | |
872 | }\r | |
6ad55b15 | 873 | }\r |
874 | }\r | |
875 | \r | |
ae5dc795 | 876 | if (EFI_ERROR (Status)) {\r |
877 | goto EXIT;\r | |
6ad55b15 | 878 | }\r |
879 | }\r | |
880 | \r | |
881 | if (ScsiDiskDevice->BlkIo.Media->MediaId != OldMedia.MediaId) {\r | |
882 | //\r | |
883 | // Media change information got from the device\r | |
884 | //\r | |
885 | *MediaChange = TRUE;\r | |
886 | }\r | |
887 | \r | |
888 | if (ScsiDiskDevice->BlkIo.Media->ReadOnly != OldMedia.ReadOnly) {\r | |
889 | *MediaChange = TRUE;\r | |
890 | ScsiDiskDevice->BlkIo.Media->MediaId += 1;\r | |
891 | }\r | |
892 | \r | |
893 | if (ScsiDiskDevice->BlkIo.Media->BlockSize != OldMedia.BlockSize) {\r | |
894 | *MediaChange = TRUE;\r | |
895 | ScsiDiskDevice->BlkIo.Media->MediaId += 1;\r | |
896 | }\r | |
897 | \r | |
898 | if (ScsiDiskDevice->BlkIo.Media->LastBlock != OldMedia.LastBlock) {\r | |
899 | *MediaChange = TRUE;\r | |
900 | ScsiDiskDevice->BlkIo.Media->MediaId += 1;\r | |
901 | }\r | |
902 | \r | |
903 | if (ScsiDiskDevice->BlkIo.Media->MediaPresent != OldMedia.MediaPresent) {\r | |
904 | if (ScsiDiskDevice->BlkIo.Media->MediaPresent) {\r | |
905 | //\r | |
906 | // when change from no media to media present, reset the MediaId to 1.\r | |
907 | //\r | |
908 | ScsiDiskDevice->BlkIo.Media->MediaId = 1;\r | |
909 | } else {\r | |
910 | //\r | |
911 | // when no media, reset the MediaId to zero.\r | |
912 | //\r | |
913 | ScsiDiskDevice->BlkIo.Media->MediaId = 0;\r | |
914 | }\r | |
915 | \r | |
916 | *MediaChange = TRUE;\r | |
917 | }\r | |
918 | \r | |
ae5dc795 | 919 | EXIT:\r |
920 | if (TimeoutEvt != NULL) {\r | |
921 | gBS->CloseEvent (TimeoutEvt);\r | |
922 | }\r | |
923 | return Status;\r | |
6ad55b15 | 924 | }\r |
925 | \r | |
6ad55b15 | 926 | \r |
9beb888e | 927 | /**\r |
928 | Send out Inquiry command to Device.\r | |
6ad55b15 | 929 | \r |
9beb888e | 930 | @param ScsiDiskDevice The pointer of SCSI_DISK_DEV\r |
931 | @param NeedRetry Indicates if needs try again when error happens\r | |
6ad55b15 | 932 | \r |
9beb888e | 933 | @retval EFI_DEVICE_ERROR Indicates that error occurs\r |
934 | @retval EFI_SUCCESS Successfully to detect media\r | |
6ad55b15 | 935 | \r |
9beb888e | 936 | **/\r |
937 | EFI_STATUS\r | |
938 | ScsiDiskInquiryDevice (\r | |
939 | IN OUT SCSI_DISK_DEV *ScsiDiskDevice,\r | |
940 | OUT BOOLEAN *NeedRetry\r | |
941 | )\r | |
6ad55b15 | 942 | {\r |
0e87144e RN |
943 | UINT32 InquiryDataLength;\r |
944 | UINT8 SenseDataLength;\r | |
945 | UINT8 HostAdapterStatus;\r | |
946 | UINT8 TargetStatus;\r | |
947 | EFI_SCSI_SENSE_DATA *SenseDataArray;\r | |
948 | UINTN NumberOfSenseKeys;\r | |
949 | EFI_STATUS Status;\r | |
950 | UINT8 MaxRetry;\r | |
951 | UINT8 Index;\r | |
957fe093 SZ |
952 | EFI_SCSI_SUPPORTED_VPD_PAGES_VPD_PAGE *SupportedVpdPages;\r |
953 | EFI_SCSI_BLOCK_LIMITS_VPD_PAGE *BlockLimits;\r | |
0e87144e | 954 | UINTN PageLength;\r |
6ad55b15 | 955 | \r |
956 | InquiryDataLength = sizeof (EFI_SCSI_INQUIRY_DATA);\r | |
957 | SenseDataLength = 0;\r | |
958 | \r | |
d35be2a4 | 959 | Status = ScsiInquiryCommand (\r |
6ad55b15 | 960 | ScsiDiskDevice->ScsiIo,\r |
3cc033c5 | 961 | SCSI_DISK_TIMEOUT,\r |
6ad55b15 | 962 | NULL,\r |
963 | &SenseDataLength,\r | |
964 | &HostAdapterStatus,\r | |
965 | &TargetStatus,\r | |
966 | (VOID *) &(ScsiDiskDevice->InquiryData),\r | |
967 | &InquiryDataLength,\r | |
968 | FALSE\r | |
969 | );\r | |
6ad55b15 | 970 | //\r |
971 | // no need to check HostAdapterStatus and TargetStatus\r | |
972 | //\r | |
f36d6e66 | 973 | if ((Status == EFI_SUCCESS) || (Status == EFI_WARN_BUFFER_TOO_SMALL)) {\r |
0e87144e RN |
974 | ParseInquiryData (ScsiDiskDevice);\r |
975 | \r | |
976 | if (ScsiDiskDevice->DeviceType == EFI_SCSI_TYPE_DISK) {\r | |
977 | //\r | |
978 | // Check whether the device supports Block Limits VPD page (0xB0)\r | |
979 | //\r | |
957fe093 SZ |
980 | SupportedVpdPages = AllocateAlignedBuffer (ScsiDiskDevice, sizeof (EFI_SCSI_SUPPORTED_VPD_PAGES_VPD_PAGE));\r |
981 | if (SupportedVpdPages == NULL) {\r | |
982 | *NeedRetry = FALSE;\r | |
983 | return EFI_DEVICE_ERROR;\r | |
984 | }\r | |
985 | ZeroMem (SupportedVpdPages, sizeof (EFI_SCSI_SUPPORTED_VPD_PAGES_VPD_PAGE));\r | |
986 | InquiryDataLength = sizeof (EFI_SCSI_SUPPORTED_VPD_PAGES_VPD_PAGE);\r | |
0e87144e RN |
987 | SenseDataLength = 0;\r |
988 | Status = ScsiInquiryCommandEx (\r | |
989 | ScsiDiskDevice->ScsiIo,\r | |
3cc033c5 | 990 | SCSI_DISK_TIMEOUT,\r |
0e87144e RN |
991 | NULL,\r |
992 | &SenseDataLength,\r | |
993 | &HostAdapterStatus,\r | |
994 | &TargetStatus,\r | |
957fe093 | 995 | (VOID *) SupportedVpdPages,\r |
0e87144e RN |
996 | &InquiryDataLength,\r |
997 | TRUE,\r | |
998 | EFI_SCSI_PAGE_CODE_SUPPORTED_VPD\r | |
999 | );\r | |
1000 | if (!EFI_ERROR (Status)) {\r | |
957fe093 SZ |
1001 | PageLength = (SupportedVpdPages->PageLength2 << 8)\r |
1002 | | SupportedVpdPages->PageLength1;\r | |
0e87144e | 1003 | for (Index = 0; Index < PageLength; Index++) {\r |
957fe093 | 1004 | if (SupportedVpdPages->SupportedVpdPageList[Index] == EFI_SCSI_PAGE_CODE_BLOCK_LIMITS_VPD) {\r |
0e87144e RN |
1005 | break;\r |
1006 | }\r | |
1007 | }\r | |
1008 | \r | |
1009 | //\r | |
1010 | // Query the Block Limits VPD page\r | |
1011 | //\r | |
1012 | if (Index < PageLength) {\r | |
957fe093 SZ |
1013 | BlockLimits = AllocateAlignedBuffer (ScsiDiskDevice, sizeof (EFI_SCSI_BLOCK_LIMITS_VPD_PAGE));\r |
1014 | if (BlockLimits == NULL) {\r | |
1015 | FreeAlignedBuffer (SupportedVpdPages, sizeof (EFI_SCSI_SUPPORTED_VPD_PAGES_VPD_PAGE));\r | |
1016 | *NeedRetry = FALSE;\r | |
1017 | return EFI_DEVICE_ERROR;\r | |
1018 | }\r | |
1019 | ZeroMem (BlockLimits, sizeof (EFI_SCSI_BLOCK_LIMITS_VPD_PAGE));\r | |
1020 | InquiryDataLength = sizeof (EFI_SCSI_BLOCK_LIMITS_VPD_PAGE);\r | |
0e87144e RN |
1021 | SenseDataLength = 0;\r |
1022 | Status = ScsiInquiryCommandEx (\r | |
1023 | ScsiDiskDevice->ScsiIo,\r | |
3cc033c5 | 1024 | SCSI_DISK_TIMEOUT,\r |
0e87144e RN |
1025 | NULL,\r |
1026 | &SenseDataLength,\r | |
1027 | &HostAdapterStatus,\r | |
1028 | &TargetStatus,\r | |
957fe093 | 1029 | (VOID *) BlockLimits,\r |
0e87144e RN |
1030 | &InquiryDataLength,\r |
1031 | TRUE,\r | |
1032 | EFI_SCSI_PAGE_CODE_BLOCK_LIMITS_VPD\r | |
1033 | );\r | |
1034 | if (!EFI_ERROR (Status)) {\r | |
1035 | ScsiDiskDevice->BlkIo.Media->OptimalTransferLengthGranularity = \r | |
957fe093 SZ |
1036 | (BlockLimits->OptimalTransferLengthGranularity2 << 8) |\r |
1037 | BlockLimits->OptimalTransferLengthGranularity1;\r | |
0e87144e | 1038 | }\r |
957fe093 SZ |
1039 | \r |
1040 | FreeAlignedBuffer (BlockLimits, sizeof (EFI_SCSI_BLOCK_LIMITS_VPD_PAGE));\r | |
0e87144e RN |
1041 | }\r |
1042 | }\r | |
957fe093 SZ |
1043 | \r |
1044 | FreeAlignedBuffer (SupportedVpdPages, sizeof (EFI_SCSI_SUPPORTED_VPD_PAGES_VPD_PAGE));\r | |
0e87144e RN |
1045 | }\r |
1046 | }\r | |
1047 | \r | |
1048 | if (!EFI_ERROR (Status)) {\r | |
1049 | return EFI_SUCCESS;\r | |
1050 | \r | |
1051 | } else if (Status == EFI_NOT_READY) {\r | |
1052 | *NeedRetry = TRUE;\r | |
1053 | return EFI_DEVICE_ERROR;\r | |
f36d6e66 | 1054 | \r |
0e87144e RN |
1055 | } else if ((Status == EFI_INVALID_PARAMETER) || (Status == EFI_UNSUPPORTED)) {\r |
1056 | *NeedRetry = FALSE;\r | |
1057 | return EFI_DEVICE_ERROR;\r | |
1058 | }\r | |
1059 | //\r | |
1060 | // go ahead to check HostAdapterStatus and TargetStatus\r | |
1061 | // (EFI_TIMEOUT, EFI_DEVICE_ERROR)\r | |
1062 | //\r | |
1063 | \r | |
1064 | Status = CheckHostAdapterStatus (HostAdapterStatus);\r | |
1065 | if ((Status == EFI_TIMEOUT) || (Status == EFI_NOT_READY)) {\r | |
1066 | *NeedRetry = TRUE;\r | |
1067 | return EFI_DEVICE_ERROR;\r | |
1068 | } else if (Status == EFI_DEVICE_ERROR) {\r | |
f36d6e66 | 1069 | //\r |
1070 | // reset the scsi channel\r | |
1071 | //\r | |
6ad55b15 | 1072 | ScsiDiskDevice->ScsiIo->ResetBus (ScsiDiskDevice->ScsiIo);\r |
1073 | *NeedRetry = FALSE;\r | |
1074 | return EFI_DEVICE_ERROR;\r | |
1075 | }\r | |
1076 | \r | |
1077 | Status = CheckTargetStatus (TargetStatus);\r | |
1078 | if (Status == EFI_NOT_READY) {\r | |
1079 | //\r | |
1080 | // reset the scsi device\r | |
1081 | //\r | |
1082 | ScsiDiskDevice->ScsiIo->ResetDevice (ScsiDiskDevice->ScsiIo);\r | |
1083 | *NeedRetry = TRUE;\r | |
1084 | return EFI_DEVICE_ERROR;\r | |
f36d6e66 | 1085 | \r |
6ad55b15 | 1086 | } else if (Status == EFI_DEVICE_ERROR) {\r |
1087 | *NeedRetry = FALSE;\r | |
1088 | return EFI_DEVICE_ERROR;\r | |
1089 | }\r | |
1090 | \r | |
1091 | //\r | |
b96cd313 | 1092 | // if goes here, meant ScsiInquiryCommand() failed.\r |
6ad55b15 | 1093 | // if ScsiDiskRequestSenseKeys() succeeds at last,\r |
b96cd313 | 1094 | // better retry ScsiInquiryCommand(). (by setting *NeedRetry = TRUE)\r |
6ad55b15 | 1095 | //\r |
1096 | MaxRetry = 3;\r | |
1097 | for (Index = 0; Index < MaxRetry; Index++) {\r | |
6ad55b15 | 1098 | Status = ScsiDiskRequestSenseKeys (\r |
1099 | ScsiDiskDevice,\r | |
1100 | NeedRetry,\r | |
1101 | &SenseDataArray,\r | |
1102 | &NumberOfSenseKeys,\r | |
1103 | TRUE\r | |
1104 | );\r | |
1105 | if (!EFI_ERROR (Status)) {\r | |
1106 | *NeedRetry = TRUE;\r | |
1107 | return EFI_DEVICE_ERROR;\r | |
1108 | }\r | |
1109 | \r | |
1110 | if (!*NeedRetry) {\r | |
1111 | return EFI_DEVICE_ERROR;\r | |
1112 | }\r | |
1113 | }\r | |
1114 | //\r | |
1115 | // ScsiDiskRequestSenseKeys() failed after several rounds of retry.\r | |
1116 | // set *NeedRetry = FALSE to avoid the outside caller try again.\r | |
1117 | //\r | |
1118 | *NeedRetry = FALSE;\r | |
1119 | return EFI_DEVICE_ERROR;\r | |
1120 | }\r | |
1121 | \r | |
9beb888e | 1122 | /**\r |
d716651f | 1123 | To test device.\r |
f36d6e66 | 1124 | \r |
1125 | When Test Unit Ready command succeeds, retrieve Sense Keys via Request Sense;\r | |
6ad55b15 | 1126 | When Test Unit Ready command encounters any error caused by host adapter or\r |
1127 | target, return error without retrieving Sense Keys.\r | |
f36d6e66 | 1128 | \r |
9beb888e | 1129 | @param ScsiDiskDevice The pointer of SCSI_DISK_DEV\r |
1130 | @param NeedRetry The pointer of flag indicates try again\r | |
1131 | @param SenseDataArray The pointer of an array of sense data\r | |
1132 | @param NumberOfSenseKeys The pointer of the number of sense data array\r | |
f36d6e66 | 1133 | \r |
9beb888e | 1134 | @retval EFI_DEVICE_ERROR Indicates that error occurs\r |
1135 | @retval EFI_SUCCESS Successfully to test unit\r | |
f36d6e66 | 1136 | \r |
9beb888e | 1137 | **/\r |
1138 | EFI_STATUS\r | |
1139 | ScsiDiskTestUnitReady (\r | |
1140 | IN SCSI_DISK_DEV *ScsiDiskDevice,\r | |
1141 | OUT BOOLEAN *NeedRetry,\r | |
1142 | OUT EFI_SCSI_SENSE_DATA **SenseDataArray,\r | |
1143 | OUT UINTN *NumberOfSenseKeys\r | |
1144 | )\r | |
6ad55b15 | 1145 | {\r |
1146 | EFI_STATUS Status;\r | |
1147 | UINT8 SenseDataLength;\r | |
1148 | UINT8 HostAdapterStatus;\r | |
1149 | UINT8 TargetStatus;\r | |
1150 | UINT8 Index;\r | |
1151 | UINT8 MaxRetry;\r | |
1152 | \r | |
1153 | SenseDataLength = 0;\r | |
1154 | *NumberOfSenseKeys = 0;\r | |
1155 | \r | |
1156 | //\r | |
1157 | // Parameter 3 and 4: do not require sense data, retrieve it when needed.\r | |
1158 | //\r | |
d35be2a4 | 1159 | Status = ScsiTestUnitReadyCommand (\r |
6ad55b15 | 1160 | ScsiDiskDevice->ScsiIo,\r |
3cc033c5 | 1161 | SCSI_DISK_TIMEOUT,\r |
6ad55b15 | 1162 | NULL,\r |
1163 | &SenseDataLength,\r | |
1164 | &HostAdapterStatus,\r | |
1165 | &TargetStatus\r | |
1166 | );\r | |
f36d6e66 | 1167 | //\r |
1168 | // no need to check HostAdapterStatus and TargetStatus\r | |
1169 | //\r | |
6ad55b15 | 1170 | if (Status == EFI_NOT_READY) {\r |
6ad55b15 | 1171 | *NeedRetry = TRUE;\r |
1172 | return EFI_DEVICE_ERROR;\r | |
f36d6e66 | 1173 | \r |
6ad55b15 | 1174 | } else if ((Status == EFI_INVALID_PARAMETER) || (Status == EFI_UNSUPPORTED)) {\r |
6ad55b15 | 1175 | *NeedRetry = FALSE;\r |
1176 | return EFI_DEVICE_ERROR;\r | |
1177 | }\r | |
1178 | //\r | |
f36d6e66 | 1179 | // go ahead to check HostAdapterStatus and TargetStatus(in case of EFI_DEVICE_ERROR)\r |
6ad55b15 | 1180 | //\r |
f36d6e66 | 1181 | \r |
6ad55b15 | 1182 | Status = CheckHostAdapterStatus (HostAdapterStatus);\r |
1183 | if ((Status == EFI_TIMEOUT) || (Status == EFI_NOT_READY)) {\r | |
1184 | *NeedRetry = TRUE;\r | |
1185 | return EFI_DEVICE_ERROR;\r | |
f36d6e66 | 1186 | \r |
6ad55b15 | 1187 | } else if (Status == EFI_DEVICE_ERROR) {\r |
1188 | //\r | |
1189 | // reset the scsi channel\r | |
1190 | //\r | |
1191 | ScsiDiskDevice->ScsiIo->ResetBus (ScsiDiskDevice->ScsiIo);\r | |
1192 | *NeedRetry = FALSE;\r | |
1193 | return EFI_DEVICE_ERROR;\r | |
1194 | }\r | |
1195 | \r | |
1196 | Status = CheckTargetStatus (TargetStatus);\r | |
1197 | if (Status == EFI_NOT_READY) {\r | |
1198 | //\r | |
1199 | // reset the scsi device\r | |
1200 | //\r | |
1201 | ScsiDiskDevice->ScsiIo->ResetDevice (ScsiDiskDevice->ScsiIo);\r | |
1202 | *NeedRetry = TRUE;\r | |
1203 | return EFI_DEVICE_ERROR;\r | |
f36d6e66 | 1204 | \r |
6ad55b15 | 1205 | } else if (Status == EFI_DEVICE_ERROR) {\r |
1206 | *NeedRetry = FALSE;\r | |
1207 | return EFI_DEVICE_ERROR;\r | |
1208 | }\r | |
1209 | \r | |
1210 | MaxRetry = 3;\r | |
1211 | for (Index = 0; Index < MaxRetry; Index++) {\r | |
6ad55b15 | 1212 | Status = ScsiDiskRequestSenseKeys (\r |
1213 | ScsiDiskDevice,\r | |
1214 | NeedRetry,\r | |
1215 | SenseDataArray,\r | |
1216 | NumberOfSenseKeys,\r | |
1217 | FALSE\r | |
1218 | );\r | |
1219 | if (!EFI_ERROR (Status)) {\r | |
1220 | return EFI_SUCCESS;\r | |
1221 | }\r | |
1222 | \r | |
1223 | if (!*NeedRetry) {\r | |
1224 | return EFI_DEVICE_ERROR;\r | |
1225 | }\r | |
1226 | }\r | |
1227 | //\r | |
1228 | // ScsiDiskRequestSenseKeys() failed after several rounds of retry.\r | |
1229 | // set *NeedRetry = FALSE to avoid the outside caller try again.\r | |
1230 | //\r | |
1231 | *NeedRetry = FALSE;\r | |
1232 | return EFI_DEVICE_ERROR;\r | |
1233 | }\r | |
1234 | \r | |
9beb888e | 1235 | /**\r |
f36d6e66 | 1236 | Parsing Sense Keys which got from request sense command.\r |
6ad55b15 | 1237 | \r |
9beb888e | 1238 | @param ScsiDiskDevice The pointer of SCSI_DISK_DEV\r |
1239 | @param SenseData The pointer of EFI_SCSI_SENSE_DATA\r | |
1240 | @param NumberOfSenseKeys The number of sense key \r | |
1241 | @param Action The pointer of action which indicates what is need to do next\r | |
6ad55b15 | 1242 | \r |
9beb888e | 1243 | @retval EFI_DEVICE_ERROR Indicates that error occurs\r |
1244 | @retval EFI_SUCCESS Successfully to complete the parsing\r | |
6ad55b15 | 1245 | \r |
9beb888e | 1246 | **/\r |
1247 | EFI_STATUS\r | |
1248 | DetectMediaParsingSenseKeys (\r | |
1249 | OUT SCSI_DISK_DEV *ScsiDiskDevice,\r | |
1250 | IN EFI_SCSI_SENSE_DATA *SenseData,\r | |
1251 | IN UINTN NumberOfSenseKeys,\r | |
1252 | OUT UINTN *Action\r | |
1253 | )\r | |
6ad55b15 | 1254 | {\r |
1255 | BOOLEAN RetryLater;\r | |
1256 | \r | |
1257 | //\r | |
1258 | // Default is to read capacity, unless..\r | |
1259 | //\r | |
1260 | *Action = ACTION_READ_CAPACITY;\r | |
1261 | \r | |
1262 | if (NumberOfSenseKeys == 0) {\r | |
ae5dc795 | 1263 | if (ScsiDiskDevice->BlkIo.Media->MediaPresent == TRUE) {\r |
1264 | *Action = ACTION_NO_ACTION;\r | |
1265 | }\r | |
6ad55b15 | 1266 | return EFI_SUCCESS;\r |
1267 | }\r | |
1268 | \r | |
1269 | if (!ScsiDiskHaveSenseKey (SenseData, NumberOfSenseKeys)) {\r | |
1270 | //\r | |
1271 | // No Sense Key returned from last submitted command\r | |
1272 | //\r | |
ae5dc795 | 1273 | if (ScsiDiskDevice->BlkIo.Media->MediaPresent == TRUE) {\r |
1274 | *Action = ACTION_NO_ACTION;\r | |
1275 | }\r | |
6ad55b15 | 1276 | return EFI_SUCCESS;\r |
1277 | }\r | |
1278 | \r | |
1279 | if (ScsiDiskIsNoMedia (SenseData, NumberOfSenseKeys)) {\r | |
1280 | ScsiDiskDevice->BlkIo.Media->MediaPresent = FALSE;\r | |
1281 | ScsiDiskDevice->BlkIo.Media->LastBlock = 0;\r | |
1282 | *Action = ACTION_NO_ACTION;\r | |
73a9e822 | 1283 | DEBUG ((EFI_D_VERBOSE, "ScsiDisk: ScsiDiskIsNoMedia\n"));\r |
6ad55b15 | 1284 | return EFI_SUCCESS;\r |
1285 | }\r | |
1286 | \r | |
1287 | if (ScsiDiskIsMediaChange (SenseData, NumberOfSenseKeys)) {\r | |
1288 | ScsiDiskDevice->BlkIo.Media->MediaId++;\r | |
73a9e822 | 1289 | DEBUG ((EFI_D_VERBOSE, "ScsiDisk: ScsiDiskIsMediaChange!\n"));\r |
6ad55b15 | 1290 | return EFI_SUCCESS;\r |
1291 | }\r | |
1292 | \r | |
cbd2a4b3 | 1293 | if (ScsiDiskIsResetBefore (SenseData, NumberOfSenseKeys)) {\r |
1294 | *Action = ACTION_RETRY_COMMAND_LATER;\r | |
73a9e822 | 1295 | DEBUG ((EFI_D_VERBOSE, "ScsiDisk: ScsiDiskIsResetBefore!\n"));\r |
cbd2a4b3 | 1296 | return EFI_SUCCESS;\r |
1297 | }\r | |
1298 | \r | |
6ad55b15 | 1299 | if (ScsiDiskIsMediaError (SenseData, NumberOfSenseKeys)) {\r |
73a9e822 TF |
1300 | DEBUG ((EFI_D_VERBOSE, "ScsiDisk: ScsiDiskIsMediaError\n"));\r |
1301 | *Action = ACTION_RETRY_WITH_BACKOFF_ALGO;\r | |
6ad55b15 | 1302 | return EFI_DEVICE_ERROR;\r |
1303 | }\r | |
1304 | \r | |
1305 | if (ScsiDiskIsHardwareError (SenseData, NumberOfSenseKeys)) {\r | |
73a9e822 TF |
1306 | DEBUG ((EFI_D_VERBOSE, "ScsiDisk: ScsiDiskIsHardwareError\n"));\r |
1307 | *Action = ACTION_RETRY_WITH_BACKOFF_ALGO;\r | |
6ad55b15 | 1308 | return EFI_DEVICE_ERROR;\r |
1309 | }\r | |
1310 | \r | |
1311 | if (!ScsiDiskIsDriveReady (SenseData, NumberOfSenseKeys, &RetryLater)) {\r | |
1312 | if (RetryLater) {\r | |
1313 | *Action = ACTION_RETRY_COMMAND_LATER;\r | |
73a9e822 | 1314 | DEBUG ((EFI_D_VERBOSE, "ScsiDisk: ScsiDiskDriveNotReady!\n"));\r |
6ad55b15 | 1315 | return EFI_SUCCESS;\r |
1316 | }\r | |
ae5dc795 | 1317 | *Action = ACTION_NO_ACTION;\r |
6ad55b15 | 1318 | return EFI_DEVICE_ERROR;\r |
1319 | }\r | |
1320 | \r | |
73a9e822 TF |
1321 | *Action = ACTION_RETRY_WITH_BACKOFF_ALGO;\r |
1322 | DEBUG ((EFI_D_VERBOSE, "ScsiDisk: Sense Key = 0x%x ASC = 0x%x!\n", SenseData->Sense_Key, SenseData->Addnl_Sense_Code));\r | |
6ad55b15 | 1323 | return EFI_SUCCESS;\r |
1324 | }\r | |
1325 | \r | |
6ad55b15 | 1326 | \r |
9beb888e | 1327 | /**\r |
1328 | Send read capacity command to device and get the device parameter.\r | |
6ad55b15 | 1329 | \r |
9beb888e | 1330 | @param ScsiDiskDevice The pointer of SCSI_DISK_DEV\r |
1331 | @param NeedRetry The pointer of flag indicates if need a retry\r | |
1332 | @param SenseDataArray The pointer of an array of sense data\r | |
1333 | @param NumberOfSenseKeys The number of sense key\r | |
6ad55b15 | 1334 | \r |
9beb888e | 1335 | @retval EFI_DEVICE_ERROR Indicates that error occurs\r |
8536cc4b | 1336 | @retval EFI_SUCCESS Successfully to read capacity or sense data is received.\r |
6ad55b15 | 1337 | \r |
9beb888e | 1338 | **/\r |
1339 | EFI_STATUS\r | |
1340 | ScsiDiskReadCapacity (\r | |
1341 | IN OUT SCSI_DISK_DEV *ScsiDiskDevice,\r | |
1342 | OUT BOOLEAN *NeedRetry,\r | |
1343 | OUT EFI_SCSI_SENSE_DATA **SenseDataArray,\r | |
1344 | OUT UINTN *NumberOfSenseKeys\r | |
1345 | )\r | |
6ad55b15 | 1346 | {\r |
b96cd313 | 1347 | UINT8 HostAdapterStatus;\r |
1348 | UINT8 TargetStatus;\r | |
1349 | EFI_STATUS CommandStatus;\r | |
1350 | EFI_STATUS Status;\r | |
1351 | UINT8 Index;\r | |
1352 | UINT8 MaxRetry;\r | |
1353 | UINT8 SenseDataLength;\r | |
b96cd313 | 1354 | UINT32 DataLength10;\r |
1355 | UINT32 DataLength16;\r | |
957fe093 SZ |
1356 | EFI_SCSI_DISK_CAPACITY_DATA *CapacityData10;\r |
1357 | EFI_SCSI_DISK_CAPACITY_DATA16 *CapacityData16;\r | |
b96cd313 | 1358 | \r |
957fe093 SZ |
1359 | CapacityData10 = AllocateAlignedBuffer (ScsiDiskDevice, sizeof (EFI_SCSI_DISK_CAPACITY_DATA));\r |
1360 | if (CapacityData10 == NULL) {\r | |
1361 | *NeedRetry = FALSE;\r | |
1362 | return EFI_DEVICE_ERROR;\r | |
1363 | }\r | |
1364 | CapacityData16 = AllocateAlignedBuffer (ScsiDiskDevice, sizeof (EFI_SCSI_DISK_CAPACITY_DATA16));\r | |
1365 | if (CapacityData16 == NULL) {\r | |
1366 | FreeAlignedBuffer (CapacityData10, sizeof (EFI_SCSI_DISK_CAPACITY_DATA));\r | |
1367 | *NeedRetry = FALSE;\r | |
1368 | return EFI_DEVICE_ERROR;\r | |
1369 | }\r | |
b96cd313 | 1370 | \r |
1371 | SenseDataLength = 0;\r | |
1372 | DataLength10 = sizeof (EFI_SCSI_DISK_CAPACITY_DATA);\r | |
1373 | DataLength16 = sizeof (EFI_SCSI_DISK_CAPACITY_DATA16);\r | |
957fe093 SZ |
1374 | ZeroMem (CapacityData10, sizeof (EFI_SCSI_DISK_CAPACITY_DATA));\r |
1375 | ZeroMem (CapacityData16, sizeof (EFI_SCSI_DISK_CAPACITY_DATA16));\r | |
6ad55b15 | 1376 | \r |
1377 | *NumberOfSenseKeys = 0;\r | |
1378 | *NeedRetry = FALSE;\r | |
b96cd313 | 1379 | \r |
f95bc048 | 1380 | //\r |
1381 | // submit Read Capacity(10) Command. If it returns capacity of FFFFFFFFh, \r | |
1382 | // 16 byte command should be used to access large hard disk >2TB\r | |
1383 | //\r | |
1384 | CommandStatus = ScsiReadCapacityCommand (\r | |
1385 | ScsiDiskDevice->ScsiIo,\r | |
3cc033c5 | 1386 | SCSI_DISK_TIMEOUT,\r |
f95bc048 | 1387 | NULL,\r |
1388 | &SenseDataLength,\r | |
1389 | &HostAdapterStatus,\r | |
1390 | &TargetStatus,\r | |
957fe093 | 1391 | (VOID *) CapacityData10,\r |
f95bc048 | 1392 | &DataLength10,\r |
1393 | FALSE\r | |
1394 | );\r | |
1395 | \r | |
1396 | ScsiDiskDevice->Cdb16Byte = FALSE;\r | |
957fe093 SZ |
1397 | if ((!EFI_ERROR (CommandStatus)) && (CapacityData10->LastLba3 == 0xff) && (CapacityData10->LastLba2 == 0xff) &&\r |
1398 | (CapacityData10->LastLba1 == 0xff) && (CapacityData10->LastLba0 == 0xff)) {\r | |
f95bc048 | 1399 | //\r |
1400 | // use Read Capacity (16), Read (16) and Write (16) next when hard disk size > 2TB\r | |
1401 | //\r | |
1402 | ScsiDiskDevice->Cdb16Byte = TRUE;\r | |
b96cd313 | 1403 | //\r |
f95bc048 | 1404 | // submit Read Capacity(16) Command to get parameter LogicalBlocksPerPhysicalBlock\r |
1405 | // and LowestAlignedLba\r | |
b96cd313 | 1406 | //\r |
f95bc048 | 1407 | CommandStatus = ScsiReadCapacity16Command (\r |
b96cd313 | 1408 | ScsiDiskDevice->ScsiIo,\r |
3cc033c5 | 1409 | SCSI_DISK_TIMEOUT,\r |
b96cd313 | 1410 | NULL,\r |
1411 | &SenseDataLength,\r | |
1412 | &HostAdapterStatus,\r | |
1413 | &TargetStatus,\r | |
957fe093 | 1414 | (VOID *) CapacityData16,\r |
f95bc048 | 1415 | &DataLength16,\r |
b96cd313 | 1416 | FALSE\r |
1417 | );\r | |
f95bc048 | 1418 | }\r |
1419 | \r | |
b96cd313 | 1420 | //\r |
6ad55b15 | 1421 | // no need to check HostAdapterStatus and TargetStatus\r |
1422 | //\r | |
f36d6e66 | 1423 | if (CommandStatus == EFI_SUCCESS) {\r |
957fe093 SZ |
1424 | GetMediaInfo (ScsiDiskDevice, CapacityData10, CapacityData16);\r |
1425 | FreeAlignedBuffer (CapacityData10, sizeof (EFI_SCSI_DISK_CAPACITY_DATA));\r | |
1426 | FreeAlignedBuffer (CapacityData16, sizeof (EFI_SCSI_DISK_CAPACITY_DATA16));\r | |
f36d6e66 | 1427 | return EFI_SUCCESS;\r |
957fe093 SZ |
1428 | }\r |
1429 | \r | |
1430 | FreeAlignedBuffer (CapacityData10, sizeof (EFI_SCSI_DISK_CAPACITY_DATA));\r | |
1431 | FreeAlignedBuffer (CapacityData16, sizeof (EFI_SCSI_DISK_CAPACITY_DATA16));\r | |
1432 | \r | |
1433 | if (CommandStatus == EFI_NOT_READY) {\r | |
f36d6e66 | 1434 | *NeedRetry = TRUE;\r |
1435 | return EFI_DEVICE_ERROR;\r | |
f36d6e66 | 1436 | } else if ((CommandStatus == EFI_INVALID_PARAMETER) || (CommandStatus == EFI_UNSUPPORTED)) {\r |
1437 | *NeedRetry = FALSE;\r | |
1438 | return EFI_DEVICE_ERROR;\r | |
1439 | }\r | |
957fe093 | 1440 | \r |
f36d6e66 | 1441 | //\r |
1442 | // go ahead to check HostAdapterStatus and TargetStatus\r | |
1443 | // (EFI_TIMEOUT, EFI_DEVICE_ERROR, EFI_WARN_BUFFER_TOO_SMALL)\r | |
1444 | //\r | |
1445 | \r | |
1446 | Status = CheckHostAdapterStatus (HostAdapterStatus);\r | |
1447 | if ((Status == EFI_TIMEOUT) || (Status == EFI_NOT_READY)) {\r | |
1448 | *NeedRetry = TRUE;\r | |
1449 | return EFI_DEVICE_ERROR;\r | |
1450 | \r | |
1451 | } else if (Status == EFI_DEVICE_ERROR) {\r | |
6ad55b15 | 1452 | //\r |
1453 | // reset the scsi channel\r | |
1454 | //\r | |
1455 | ScsiDiskDevice->ScsiIo->ResetBus (ScsiDiskDevice->ScsiIo);\r | |
1456 | *NeedRetry = FALSE;\r | |
1457 | return EFI_DEVICE_ERROR;\r | |
1458 | }\r | |
1459 | \r | |
1460 | Status = CheckTargetStatus (TargetStatus);\r | |
1461 | if (Status == EFI_NOT_READY) {\r | |
1462 | //\r | |
1463 | // reset the scsi device\r | |
1464 | //\r | |
1465 | ScsiDiskDevice->ScsiIo->ResetDevice (ScsiDiskDevice->ScsiIo);\r | |
1466 | *NeedRetry = TRUE;\r | |
1467 | return EFI_DEVICE_ERROR;\r | |
f36d6e66 | 1468 | \r |
6ad55b15 | 1469 | } else if (Status == EFI_DEVICE_ERROR) {\r |
1470 | *NeedRetry = FALSE;\r | |
1471 | return EFI_DEVICE_ERROR;\r | |
1472 | }\r | |
1473 | \r | |
1474 | //\r | |
b96cd313 | 1475 | // if goes here, meant ScsiReadCapacityCommand() failed.\r |
6ad55b15 | 1476 | // if ScsiDiskRequestSenseKeys() succeeds at last,\r |
b96cd313 | 1477 | // better retry ScsiReadCapacityCommand(). (by setting *NeedRetry = TRUE)\r |
6ad55b15 | 1478 | //\r |
1479 | MaxRetry = 3;\r | |
1480 | for (Index = 0; Index < MaxRetry; Index++) {\r | |
1481 | \r | |
1482 | Status = ScsiDiskRequestSenseKeys (\r | |
1483 | ScsiDiskDevice,\r | |
1484 | NeedRetry,\r | |
1485 | SenseDataArray,\r | |
1486 | NumberOfSenseKeys,\r | |
1487 | TRUE\r | |
1488 | );\r | |
1489 | if (!EFI_ERROR (Status)) {\r | |
8536cc4b | 1490 | return EFI_SUCCESS;\r |
6ad55b15 | 1491 | }\r |
1492 | \r | |
1493 | if (!*NeedRetry) {\r | |
1494 | return EFI_DEVICE_ERROR;\r | |
1495 | }\r | |
1496 | }\r | |
1497 | //\r | |
1498 | // ScsiDiskRequestSenseKeys() failed after several rounds of retry.\r | |
1499 | // set *NeedRetry = FALSE to avoid the outside caller try again.\r | |
1500 | //\r | |
1501 | *NeedRetry = FALSE;\r | |
1502 | return EFI_DEVICE_ERROR;\r | |
1503 | }\r | |
1504 | \r | |
9beb888e | 1505 | /**\r |
1506 | Check the HostAdapter status and re-interpret it in EFI_STATUS.\r | |
6ad55b15 | 1507 | \r |
9beb888e | 1508 | @param HostAdapterStatus Host Adapter status\r |
6ad55b15 | 1509 | \r |
9beb888e | 1510 | @retval EFI_SUCCESS Host adapter is OK.\r |
1511 | @retval EFI_TIMEOUT Timeout.\r | |
1512 | @retval EFI_NOT_READY Adapter NOT ready.\r | |
1513 | @retval EFI_DEVICE_ERROR Adapter device error.\r | |
6ad55b15 | 1514 | \r |
9beb888e | 1515 | **/\r |
1516 | EFI_STATUS\r | |
1517 | CheckHostAdapterStatus (\r | |
1518 | IN UINT8 HostAdapterStatus\r | |
1519 | )\r | |
6ad55b15 | 1520 | {\r |
1521 | switch (HostAdapterStatus) {\r | |
f36d6e66 | 1522 | case EFI_EXT_SCSI_STATUS_HOST_ADAPTER_OK:\r |
6ad55b15 | 1523 | return EFI_SUCCESS;\r |
1524 | \r | |
f36d6e66 | 1525 | case EFI_EXT_SCSI_STATUS_HOST_ADAPTER_SELECTION_TIMEOUT:\r |
1526 | case EFI_EXT_SCSI_STATUS_HOST_ADAPTER_TIMEOUT:\r | |
1527 | case EFI_EXT_SCSI_STATUS_HOST_ADAPTER_TIMEOUT_COMMAND:\r | |
6ad55b15 | 1528 | return EFI_TIMEOUT;\r |
1529 | \r | |
f36d6e66 | 1530 | case EFI_EXT_SCSI_STATUS_HOST_ADAPTER_MESSAGE_REJECT:\r |
1531 | case EFI_EXT_SCSI_STATUS_HOST_ADAPTER_PARITY_ERROR:\r | |
1532 | case EFI_EXT_SCSI_STATUS_HOST_ADAPTER_REQUEST_SENSE_FAILED:\r | |
1533 | case EFI_EXT_SCSI_STATUS_HOST_ADAPTER_DATA_OVERRUN_UNDERRUN:\r | |
1534 | case EFI_EXT_SCSI_STATUS_HOST_ADAPTER_BUS_RESET:\r | |
6ad55b15 | 1535 | return EFI_NOT_READY;\r |
1536 | \r | |
f36d6e66 | 1537 | case EFI_EXT_SCSI_STATUS_HOST_ADAPTER_BUS_FREE:\r |
1538 | case EFI_EXT_SCSI_STATUS_HOST_ADAPTER_PHASE_ERROR:\r | |
6ad55b15 | 1539 | return EFI_DEVICE_ERROR;\r |
1540 | \r | |
1541 | default:\r | |
1542 | return EFI_SUCCESS;\r | |
1543 | }\r | |
1544 | }\r | |
1545 | \r | |
6ad55b15 | 1546 | \r |
9beb888e | 1547 | /**\r |
1548 | Check the target status and re-interpret it in EFI_STATUS.\r | |
6ad55b15 | 1549 | \r |
9beb888e | 1550 | @param TargetStatus Target status\r |
6ad55b15 | 1551 | \r |
9beb888e | 1552 | @retval EFI_NOT_READY Device is NOT ready.\r |
1553 | @retval EFI_DEVICE_ERROR \r | |
1554 | @retval EFI_SUCCESS\r | |
6ad55b15 | 1555 | \r |
9beb888e | 1556 | **/\r |
1557 | EFI_STATUS\r | |
1558 | CheckTargetStatus (\r | |
1559 | IN UINT8 TargetStatus\r | |
1560 | )\r | |
6ad55b15 | 1561 | {\r |
1562 | switch (TargetStatus) {\r | |
f36d6e66 | 1563 | case EFI_EXT_SCSI_STATUS_TARGET_GOOD:\r |
1564 | case EFI_EXT_SCSI_STATUS_TARGET_CHECK_CONDITION:\r | |
1565 | case EFI_EXT_SCSI_STATUS_TARGET_CONDITION_MET:\r | |
6ad55b15 | 1566 | return EFI_SUCCESS;\r |
1567 | \r | |
f36d6e66 | 1568 | case EFI_EXT_SCSI_STATUS_TARGET_INTERMEDIATE:\r |
1569 | case EFI_EXT_SCSI_STATUS_TARGET_INTERMEDIATE_CONDITION_MET:\r | |
1570 | case EFI_EXT_SCSI_STATUS_TARGET_BUSY:\r | |
1571 | case EFI_EXT_SCSI_STATUS_TARGET_TASK_SET_FULL:\r | |
6ad55b15 | 1572 | return EFI_NOT_READY;\r |
1573 | \r | |
f36d6e66 | 1574 | case EFI_EXT_SCSI_STATUS_TARGET_RESERVATION_CONFLICT:\r |
6ad55b15 | 1575 | return EFI_DEVICE_ERROR;\r |
6ad55b15 | 1576 | \r |
1577 | default:\r | |
1578 | return EFI_SUCCESS;\r | |
1579 | }\r | |
1580 | }\r | |
1581 | \r | |
f36d6e66 | 1582 | \r |
9beb888e | 1583 | /**\r |
6ad55b15 | 1584 | Retrieve all sense keys from the device.\r |
f36d6e66 | 1585 | \r |
9beb888e | 1586 | When encountering error during the process, if retrieve sense keys before\r |
d716651f | 1587 | error encountered, it returns the sense keys with return status set to EFI_SUCCESS,\r |
9beb888e | 1588 | and NeedRetry set to FALSE; otherwize, return the proper return status.\r |
1589 | \r | |
1590 | @param ScsiDiskDevice The pointer of SCSI_DISK_DEV\r | |
1591 | @param NeedRetry The pointer of flag indicates if need a retry\r | |
1592 | @param SenseDataArray The pointer of an array of sense data\r | |
1593 | @param NumberOfSenseKeys The number of sense key\r | |
1594 | @param AskResetIfError The flag indicates if need reset when error occurs\r | |
1595 | \r | |
1596 | @retval EFI_DEVICE_ERROR Indicates that error occurs\r | |
1597 | @retval EFI_SUCCESS Successfully to request sense key\r | |
f36d6e66 | 1598 | \r |
9beb888e | 1599 | **/\r |
1600 | EFI_STATUS\r | |
1601 | ScsiDiskRequestSenseKeys (\r | |
1602 | IN OUT SCSI_DISK_DEV *ScsiDiskDevice,\r | |
1603 | OUT BOOLEAN *NeedRetry,\r | |
1604 | OUT EFI_SCSI_SENSE_DATA **SenseDataArray,\r | |
1605 | OUT UINTN *NumberOfSenseKeys,\r | |
1606 | IN BOOLEAN AskResetIfError\r | |
1607 | )\r | |
6ad55b15 | 1608 | {\r |
1609 | EFI_SCSI_SENSE_DATA *PtrSenseData;\r | |
1610 | UINT8 SenseDataLength;\r | |
1611 | BOOLEAN SenseReq;\r | |
1612 | EFI_STATUS Status;\r | |
1613 | EFI_STATUS FallStatus;\r | |
1614 | UINT8 HostAdapterStatus;\r | |
1615 | UINT8 TargetStatus;\r | |
1616 | \r | |
1617 | FallStatus = EFI_SUCCESS;\r | |
c9325700 | 1618 | SenseDataLength = (UINT8) sizeof (EFI_SCSI_SENSE_DATA);\r |
6ad55b15 | 1619 | \r |
1620 | ZeroMem (\r | |
1621 | ScsiDiskDevice->SenseData,\r | |
1622 | sizeof (EFI_SCSI_SENSE_DATA) * (ScsiDiskDevice->SenseDataNumber)\r | |
1623 | );\r | |
1624 | \r | |
1625 | *NumberOfSenseKeys = 0;\r | |
1626 | *SenseDataArray = ScsiDiskDevice->SenseData;\r | |
73a9e822 TF |
1627 | Status = EFI_SUCCESS;\r |
1628 | PtrSenseData = AllocateAlignedBuffer (ScsiDiskDevice, sizeof (EFI_SCSI_SENSE_DATA));\r | |
1629 | if (PtrSenseData == NULL) {\r | |
1630 | return EFI_DEVICE_ERROR;\r | |
1631 | }\r | |
6ad55b15 | 1632 | \r |
1633 | for (SenseReq = TRUE; SenseReq;) {\r | |
73a9e822 | 1634 | ZeroMem (PtrSenseData, sizeof (EFI_SCSI_SENSE_DATA));\r |
d35be2a4 | 1635 | Status = ScsiRequestSenseCommand (\r |
6ad55b15 | 1636 | ScsiDiskDevice->ScsiIo,\r |
3cc033c5 | 1637 | SCSI_DISK_TIMEOUT,\r |
6ad55b15 | 1638 | PtrSenseData,\r |
1639 | &SenseDataLength,\r | |
1640 | &HostAdapterStatus,\r | |
1641 | &TargetStatus\r | |
1642 | );\r | |
f36d6e66 | 1643 | if ((Status == EFI_SUCCESS) || (Status == EFI_WARN_BUFFER_TOO_SMALL)) {\r |
1644 | FallStatus = EFI_SUCCESS;\r | |
1645 | \r | |
1646 | } else if ((Status == EFI_TIMEOUT) || (Status == EFI_NOT_READY)) {\r | |
1647 | *NeedRetry = TRUE;\r | |
1648 | FallStatus = EFI_DEVICE_ERROR;\r | |
1649 | \r | |
1650 | } else if ((Status == EFI_INVALID_PARAMETER) || (Status == EFI_UNSUPPORTED)) {\r | |
1651 | *NeedRetry = FALSE;\r | |
1652 | FallStatus = EFI_DEVICE_ERROR;\r | |
1653 | \r | |
1654 | } else if (Status == EFI_DEVICE_ERROR) {\r | |
1655 | if (AskResetIfError) {\r | |
1656 | ScsiDiskDevice->ScsiIo->ResetDevice (ScsiDiskDevice->ScsiIo);\r | |
1657 | }\r | |
1658 | \r | |
1659 | FallStatus = EFI_DEVICE_ERROR;\r | |
6ad55b15 | 1660 | }\r |
1661 | \r | |
1662 | if (EFI_ERROR (FallStatus)) {\r | |
1663 | if (*NumberOfSenseKeys != 0) {\r | |
1664 | *NeedRetry = FALSE;\r | |
73a9e822 TF |
1665 | Status = EFI_SUCCESS;\r |
1666 | goto EXIT;\r | |
6ad55b15 | 1667 | } else {\r |
73a9e822 TF |
1668 | Status = EFI_DEVICE_ERROR;\r |
1669 | goto EXIT;\r | |
6ad55b15 | 1670 | }\r |
1671 | }\r | |
1672 | \r | |
73a9e822 | 1673 | CopyMem (ScsiDiskDevice->SenseData + *NumberOfSenseKeys, PtrSenseData, SenseDataLength);\r |
6ad55b15 | 1674 | (*NumberOfSenseKeys) += 1;\r |
1675 | \r | |
1676 | //\r | |
1677 | // no more sense key or number of sense keys exceeds predefined,\r | |
1678 | // skip the loop.\r | |
1679 | //\r | |
1680 | if ((PtrSenseData->Sense_Key == EFI_SCSI_SK_NO_SENSE) || \r | |
1681 | (*NumberOfSenseKeys == ScsiDiskDevice->SenseDataNumber)) {\r | |
1682 | SenseReq = FALSE;\r | |
1683 | }\r | |
6ad55b15 | 1684 | }\r |
73a9e822 TF |
1685 | \r |
1686 | EXIT:\r | |
1687 | FreeAlignedBuffer (PtrSenseData, sizeof (EFI_SCSI_SENSE_DATA));\r | |
1688 | return Status;\r | |
6ad55b15 | 1689 | }\r |
1690 | \r | |
6ad55b15 | 1691 | \r |
9beb888e | 1692 | /**\r |
1693 | Get information from media read capacity command.\r | |
6ad55b15 | 1694 | \r |
9beb888e | 1695 | @param ScsiDiskDevice The pointer of SCSI_DISK_DEV\r |
aa75dfec | 1696 | @param Capacity10 The pointer of EFI_SCSI_DISK_CAPACITY_DATA\r |
1697 | @param Capacity16 The pointer of EFI_SCSI_DISK_CAPACITY_DATA16\r | |
6ad55b15 | 1698 | \r |
9beb888e | 1699 | **/\r |
1700 | VOID\r | |
1701 | GetMediaInfo (\r | |
aa75dfec | 1702 | IN OUT SCSI_DISK_DEV *ScsiDiskDevice,\r |
1703 | IN EFI_SCSI_DISK_CAPACITY_DATA *Capacity10,\r | |
1704 | IN EFI_SCSI_DISK_CAPACITY_DATA16 *Capacity16\r | |
9beb888e | 1705 | )\r |
6ad55b15 | 1706 | {\r |
b96cd313 | 1707 | UINT8 *Ptr;\r |
1708 | \r | |
f95bc048 | 1709 | if (!ScsiDiskDevice->Cdb16Byte) {\r |
b96cd313 | 1710 | ScsiDiskDevice->BlkIo.Media->LastBlock = (Capacity10->LastLba3 << 24) |\r |
1711 | (Capacity10->LastLba2 << 16) |\r | |
1712 | (Capacity10->LastLba1 << 8) |\r | |
1713 | Capacity10->LastLba0;\r | |
1714 | \r | |
1715 | ScsiDiskDevice->BlkIo.Media->BlockSize = (Capacity10->BlockSize3 << 24) |\r | |
1716 | (Capacity10->BlockSize2 << 16) | \r | |
1717 | (Capacity10->BlockSize1 << 8) |\r | |
1718 | Capacity10->BlockSize0;\r | |
0e87144e RN |
1719 | ScsiDiskDevice->BlkIo.Media->LowestAlignedLba = 0;\r |
1720 | ScsiDiskDevice->BlkIo.Media->LogicalBlocksPerPhysicalBlock = 0;\r | |
b96cd313 | 1721 | } else {\r |
b96cd313 | 1722 | Ptr = (UINT8*)&ScsiDiskDevice->BlkIo.Media->LastBlock;\r |
1723 | *Ptr++ = Capacity16->LastLba0;\r | |
1724 | *Ptr++ = Capacity16->LastLba1;\r | |
1725 | *Ptr++ = Capacity16->LastLba2;\r | |
1726 | *Ptr++ = Capacity16->LastLba3;\r | |
1727 | *Ptr++ = Capacity16->LastLba4;\r | |
1728 | *Ptr++ = Capacity16->LastLba5;\r | |
1729 | *Ptr++ = Capacity16->LastLba6;\r | |
1730 | *Ptr = Capacity16->LastLba7;\r | |
0e87144e | 1731 | \r |
b96cd313 | 1732 | ScsiDiskDevice->BlkIo.Media->BlockSize = (Capacity16->BlockSize3 << 24) |\r |
1733 | (Capacity16->BlockSize2 << 16) | \r | |
1734 | (Capacity16->BlockSize1 << 8) |\r | |
1735 | Capacity16->BlockSize0;\r | |
1736 | \r | |
0e87144e RN |
1737 | ScsiDiskDevice->BlkIo.Media->LowestAlignedLba = (Capacity16->LowestAlignLogic2 << 8) |\r |
1738 | Capacity16->LowestAlignLogic1;\r | |
1739 | ScsiDiskDevice->BlkIo.Media->LogicalBlocksPerPhysicalBlock = (1 << Capacity16->LogicPerPhysical);\r | |
b96cd313 | 1740 | }\r |
1741 | \r | |
6ad55b15 | 1742 | ScsiDiskDevice->BlkIo.Media->MediaPresent = TRUE;\r |
b96cd313 | 1743 | \r |
6ad55b15 | 1744 | if (ScsiDiskDevice->DeviceType == EFI_SCSI_TYPE_DISK) {\r |
1745 | ScsiDiskDevice->BlkIo.Media->BlockSize = 0x200;\r | |
1746 | }\r | |
1747 | \r | |
1748 | if (ScsiDiskDevice->DeviceType == EFI_SCSI_TYPE_CDROM) {\r | |
1749 | ScsiDiskDevice->BlkIo.Media->BlockSize = 0x800;\r | |
1750 | }\r | |
1751 | }\r | |
1752 | \r | |
9beb888e | 1753 | /**\r |
1754 | Parse Inquiry data.\r | |
1755 | \r | |
1756 | @param ScsiDiskDevice The pointer of SCSI_DISK_DEV\r | |
1757 | \r | |
1758 | **/\r | |
6ad55b15 | 1759 | VOID\r |
1760 | ParseInquiryData (\r | |
9beb888e | 1761 | IN OUT SCSI_DISK_DEV *ScsiDiskDevice\r |
6ad55b15 | 1762 | )\r |
6ad55b15 | 1763 | {\r |
fbfa4a1d | 1764 | ScsiDiskDevice->FixedDevice = (BOOLEAN) ((ScsiDiskDevice->InquiryData.Rmb == 1) ? 0 : 1);\r |
6ad55b15 | 1765 | ScsiDiskDevice->BlkIoMedia.RemovableMedia = (BOOLEAN) (!ScsiDiskDevice->FixedDevice);\r |
1766 | }\r | |
1767 | \r | |
9beb888e | 1768 | /**\r |
1769 | Read sector from SCSI Disk.\r | |
6ad55b15 | 1770 | \r |
d716651f | 1771 | @param ScsiDiskDevice The pointer of SCSI_DISK_DEV\r |
9beb888e | 1772 | @param Buffer The buffer to fill in the read out data\r |
1773 | @param Lba Logic block address\r | |
1774 | @param NumberOfBlocks The number of blocks to read\r | |
6ad55b15 | 1775 | \r |
9beb888e | 1776 | @retval EFI_DEVICE_ERROR Indicates a device error.\r |
1777 | @retval EFI_SUCCESS Operation is successful.\r | |
6ad55b15 | 1778 | \r |
9beb888e | 1779 | **/\r |
1780 | EFI_STATUS\r | |
1781 | ScsiDiskReadSectors (\r | |
1782 | IN SCSI_DISK_DEV *ScsiDiskDevice,\r | |
1783 | OUT VOID *Buffer,\r | |
1784 | IN EFI_LBA Lba,\r | |
1785 | IN UINTN NumberOfBlocks\r | |
1786 | )\r | |
6ad55b15 | 1787 | {\r |
1788 | UINTN BlocksRemaining;\r | |
6ad55b15 | 1789 | UINT8 *PtrBuffer;\r |
1790 | UINT32 BlockSize;\r | |
1791 | UINT32 ByteCount;\r | |
1792 | UINT32 MaxBlock;\r | |
1793 | UINT32 SectorCount;\r | |
1794 | UINT64 Timeout;\r | |
1795 | EFI_STATUS Status;\r | |
1796 | UINT8 Index;\r | |
1797 | UINT8 MaxRetry;\r | |
1798 | BOOLEAN NeedRetry;\r | |
6ad55b15 | 1799 | \r |
1800 | Status = EFI_SUCCESS;\r | |
1801 | \r | |
1802 | BlocksRemaining = NumberOfBlocks;\r | |
1803 | BlockSize = ScsiDiskDevice->BlkIo.Media->BlockSize;\r | |
a108933e | 1804 | \r |
6ad55b15 | 1805 | //\r |
a108933e | 1806 | // limit the data bytes that can be transferred by one Read(10) or Read(16) Command\r |
6ad55b15 | 1807 | //\r |
f95bc048 | 1808 | if (!ScsiDiskDevice->Cdb16Byte) {\r |
5bf5fb30 | 1809 | MaxBlock = 0xFFFF;\r |
a108933e | 1810 | } else {\r |
5bf5fb30 | 1811 | MaxBlock = 0xFFFFFFFF;\r |
a108933e | 1812 | }\r |
6ad55b15 | 1813 | \r |
1814 | PtrBuffer = Buffer;\r | |
6ad55b15 | 1815 | \r |
1816 | while (BlocksRemaining > 0) {\r | |
1817 | \r | |
1818 | if (BlocksRemaining <= MaxBlock) {\r | |
f95bc048 | 1819 | if (!ScsiDiskDevice->Cdb16Byte) {\r |
a108933e | 1820 | SectorCount = (UINT16) BlocksRemaining;\r |
1821 | } else {\r | |
1822 | SectorCount = (UINT32) BlocksRemaining;\r | |
1823 | }\r | |
6ad55b15 | 1824 | } else {\r |
6ad55b15 | 1825 | SectorCount = MaxBlock;\r |
1826 | }\r | |
1827 | \r | |
1828 | ByteCount = SectorCount * BlockSize;\r | |
9690325d | 1829 | //\r |
1830 | // |------------------------|-----------------|------------------|-----------------|\r | |
1831 | // | ATA Transfer Mode | Transfer Rate | SCSI Interface | Transfer Rate |\r | |
1832 | // |------------------------|-----------------|------------------|-----------------|\r | |
1833 | // | PIO Mode 0 | 3.3Mbytes/sec | SCSI-1 | 5Mbytes/sec |\r | |
1834 | // |------------------------|-----------------|------------------|-----------------|\r | |
1835 | // | PIO Mode 1 | 5.2Mbytes/sec | Fast SCSI | 10Mbytes/sec |\r | |
1836 | // |------------------------|-----------------|------------------|-----------------|\r | |
1837 | // | PIO Mode 2 | 8.3Mbytes/sec | Fast-Wide SCSI | 20Mbytes/sec |\r | |
1838 | // |------------------------|-----------------|------------------|-----------------|\r | |
1839 | // | PIO Mode 3 | 11.1Mbytes/sec | Ultra SCSI | 20Mbytes/sec |\r | |
1840 | // |------------------------|-----------------|------------------|-----------------|\r | |
1841 | // | PIO Mode 4 | 16.6Mbytes/sec | Ultra Wide SCSI | 40Mbytes/sec |\r | |
1842 | // |------------------------|-----------------|------------------|-----------------|\r | |
1843 | // | Single-word DMA Mode 0 | 2.1Mbytes/sec | Ultra2 SCSI | 40Mbytes/sec |\r | |
1844 | // |------------------------|-----------------|------------------|-----------------|\r | |
1845 | // | Single-word DMA Mode 1 | 4.2Mbytes/sec | Ultra2 Wide SCSI | 80Mbytes/sec |\r | |
1846 | // |------------------------|-----------------|------------------|-----------------|\r | |
1847 | // | Single-word DMA Mode 2 | 8.4Mbytes/sec | Ultra3 SCSI | 160Mbytes/sec |\r | |
1848 | // |------------------------|-----------------|------------------|-----------------|\r | |
1849 | // | Multi-word DMA Mode 0 | 4.2Mbytes/sec | Ultra-320 SCSI | 320Mbytes/sec |\r | |
1850 | // |------------------------|-----------------|------------------|-----------------|\r | |
1851 | // | Multi-word DMA Mode 1 | 13.3Mbytes/sec | Ultra-640 SCSI | 640Mbytes/sec |\r | |
1852 | // |------------------------|-----------------|------------------|-----------------|\r | |
1853 | //\r | |
1854 | // As ScsiDisk and ScsiBus driver are used to manage SCSI or ATAPI devices, we have to use\r | |
1855 | // the lowest transfer rate to calculate the possible maximum timeout value for each operation.\r | |
1856 | // From the above table, we could know 2.1Mbytes per second is lowest one.\r | |
3cc033c5 FT |
1857 | // The timout value is rounded up to nearest integar and here an additional 30s is added\r |
1858 | // to follow ATA spec in which it mentioned that the device may take up to 30s to respond\r | |
1859 | // commands in the Standby/Idle mode.\r | |
9690325d | 1860 | //\r |
3cc033c5 | 1861 | Timeout = EFI_TIMER_PERIOD_SECONDS (ByteCount / 2100000 + 31);\r |
6ad55b15 | 1862 | \r |
1863 | MaxRetry = 2;\r | |
1864 | for (Index = 0; Index < MaxRetry; Index++) {\r | |
f95bc048 | 1865 | if (!ScsiDiskDevice->Cdb16Byte) {\r |
1866 | Status = ScsiDiskRead10 (\r | |
a108933e | 1867 | ScsiDiskDevice,\r |
1868 | &NeedRetry,\r | |
a108933e | 1869 | Timeout,\r |
1870 | PtrBuffer,\r | |
1871 | &ByteCount,\r | |
f95bc048 | 1872 | (UINT32) Lba,\r |
a108933e | 1873 | SectorCount\r |
1874 | );\r | |
1875 | } else {\r | |
f95bc048 | 1876 | Status = ScsiDiskRead16 (\r |
a108933e | 1877 | ScsiDiskDevice,\r |
1878 | &NeedRetry,\r | |
a108933e | 1879 | Timeout,\r |
1880 | PtrBuffer,\r | |
1881 | &ByteCount,\r | |
f95bc048 | 1882 | Lba,\r |
a108933e | 1883 | SectorCount\r |
1884 | );\r | |
1885 | }\r | |
6ad55b15 | 1886 | if (!EFI_ERROR (Status)) {\r |
1887 | break;\r | |
1888 | }\r | |
1889 | \r | |
1890 | if (!NeedRetry) {\r | |
1891 | return EFI_DEVICE_ERROR;\r | |
1892 | }\r | |
1893 | \r | |
1894 | }\r | |
1895 | \r | |
1896 | if ((Index == MaxRetry) && (Status != EFI_SUCCESS)) {\r | |
1897 | return EFI_DEVICE_ERROR;\r | |
1898 | }\r | |
1899 | \r | |
1900 | //\r | |
1901 | // actual transferred sectors\r | |
1902 | //\r | |
1903 | SectorCount = ByteCount / BlockSize;\r | |
1904 | \r | |
a108933e | 1905 | Lba += SectorCount;\r |
6ad55b15 | 1906 | PtrBuffer = PtrBuffer + SectorCount * BlockSize;\r |
1907 | BlocksRemaining -= SectorCount;\r | |
1908 | }\r | |
1909 | \r | |
1910 | return EFI_SUCCESS;\r | |
1911 | }\r | |
1912 | \r | |
9beb888e | 1913 | /**\r |
1914 | Write sector to SCSI Disk.\r | |
6ad55b15 | 1915 | \r |
d716651f | 1916 | @param ScsiDiskDevice The pointer of SCSI_DISK_DEV\r |
9beb888e | 1917 | @param Buffer The buffer of data to be written into SCSI Disk\r |
1918 | @param Lba Logic block address\r | |
1919 | @param NumberOfBlocks The number of blocks to read\r | |
6ad55b15 | 1920 | \r |
9beb888e | 1921 | @retval EFI_DEVICE_ERROR Indicates a device error.\r |
1922 | @retval EFI_SUCCESS Operation is successful.\r | |
6ad55b15 | 1923 | \r |
9beb888e | 1924 | **/\r |
1925 | EFI_STATUS\r | |
1926 | ScsiDiskWriteSectors (\r | |
1927 | IN SCSI_DISK_DEV *ScsiDiskDevice,\r | |
1928 | IN VOID *Buffer,\r | |
1929 | IN EFI_LBA Lba,\r | |
1930 | IN UINTN NumberOfBlocks\r | |
1931 | )\r | |
6ad55b15 | 1932 | {\r |
1933 | UINTN BlocksRemaining;\r | |
6ad55b15 | 1934 | UINT8 *PtrBuffer;\r |
1935 | UINT32 BlockSize;\r | |
1936 | UINT32 ByteCount;\r | |
1937 | UINT32 MaxBlock;\r | |
1938 | UINT32 SectorCount;\r | |
1939 | UINT64 Timeout;\r | |
1940 | EFI_STATUS Status;\r | |
1941 | UINT8 Index;\r | |
1942 | UINT8 MaxRetry;\r | |
1943 | BOOLEAN NeedRetry;\r | |
6ad55b15 | 1944 | \r |
1945 | Status = EFI_SUCCESS;\r | |
1946 | \r | |
1947 | BlocksRemaining = NumberOfBlocks;\r | |
1948 | BlockSize = ScsiDiskDevice->BlkIo.Media->BlockSize;\r | |
a108933e | 1949 | \r |
6ad55b15 | 1950 | //\r |
a108933e | 1951 | // limit the data bytes that can be transferred by one Read(10) or Read(16) Command\r |
6ad55b15 | 1952 | //\r |
f95bc048 | 1953 | if (!ScsiDiskDevice->Cdb16Byte) {\r |
5bf5fb30 | 1954 | MaxBlock = 0xFFFF;\r |
a108933e | 1955 | } else {\r |
5bf5fb30 | 1956 | MaxBlock = 0xFFFFFFFF;\r |
a108933e | 1957 | }\r |
6ad55b15 | 1958 | \r |
1959 | PtrBuffer = Buffer;\r | |
6ad55b15 | 1960 | \r |
1961 | while (BlocksRemaining > 0) {\r | |
1962 | \r | |
1963 | if (BlocksRemaining <= MaxBlock) {\r | |
f95bc048 | 1964 | if (!ScsiDiskDevice->Cdb16Byte) {\r |
a108933e | 1965 | SectorCount = (UINT16) BlocksRemaining;\r |
1966 | } else {\r | |
1967 | SectorCount = (UINT32) BlocksRemaining;\r | |
1968 | }\r | |
6ad55b15 | 1969 | } else {\r |
6ad55b15 | 1970 | SectorCount = MaxBlock;\r |
1971 | }\r | |
1972 | \r | |
1973 | ByteCount = SectorCount * BlockSize;\r | |
9690325d | 1974 | //\r |
1975 | // |------------------------|-----------------|------------------|-----------------|\r | |
1976 | // | ATA Transfer Mode | Transfer Rate | SCSI Interface | Transfer Rate |\r | |
1977 | // |------------------------|-----------------|------------------|-----------------|\r | |
1978 | // | PIO Mode 0 | 3.3Mbytes/sec | SCSI-1 | 5Mbytes/sec |\r | |
1979 | // |------------------------|-----------------|------------------|-----------------|\r | |
1980 | // | PIO Mode 1 | 5.2Mbytes/sec | Fast SCSI | 10Mbytes/sec |\r | |
1981 | // |------------------------|-----------------|------------------|-----------------|\r | |
1982 | // | PIO Mode 2 | 8.3Mbytes/sec | Fast-Wide SCSI | 20Mbytes/sec |\r | |
1983 | // |------------------------|-----------------|------------------|-----------------|\r | |
1984 | // | PIO Mode 3 | 11.1Mbytes/sec | Ultra SCSI | 20Mbytes/sec |\r | |
1985 | // |------------------------|-----------------|------------------|-----------------|\r | |
1986 | // | PIO Mode 4 | 16.6Mbytes/sec | Ultra Wide SCSI | 40Mbytes/sec |\r | |
1987 | // |------------------------|-----------------|------------------|-----------------|\r | |
1988 | // | Single-word DMA Mode 0 | 2.1Mbytes/sec | Ultra2 SCSI | 40Mbytes/sec |\r | |
1989 | // |------------------------|-----------------|------------------|-----------------|\r | |
1990 | // | Single-word DMA Mode 1 | 4.2Mbytes/sec | Ultra2 Wide SCSI | 80Mbytes/sec |\r | |
1991 | // |------------------------|-----------------|------------------|-----------------|\r | |
1992 | // | Single-word DMA Mode 2 | 8.4Mbytes/sec | Ultra3 SCSI | 160Mbytes/sec |\r | |
1993 | // |------------------------|-----------------|------------------|-----------------|\r | |
1994 | // | Multi-word DMA Mode 0 | 4.2Mbytes/sec | Ultra-320 SCSI | 320Mbytes/sec |\r | |
1995 | // |------------------------|-----------------|------------------|-----------------|\r | |
1996 | // | Multi-word DMA Mode 1 | 13.3Mbytes/sec | Ultra-640 SCSI | 640Mbytes/sec |\r | |
1997 | // |------------------------|-----------------|------------------|-----------------|\r | |
1998 | //\r | |
1999 | // As ScsiDisk and ScsiBus driver are used to manage SCSI or ATAPI devices, we have to use\r | |
2000 | // the lowest transfer rate to calculate the possible maximum timeout value for each operation.\r | |
2001 | // From the above table, we could know 2.1Mbytes per second is lowest one.\r | |
3cc033c5 FT |
2002 | // The timout value is rounded up to nearest integar and here an additional 30s is added\r |
2003 | // to follow ATA spec in which it mentioned that the device may take up to 30s to respond\r | |
2004 | // commands in the Standby/Idle mode.\r | |
9690325d | 2005 | //\r |
3cc033c5 | 2006 | Timeout = EFI_TIMER_PERIOD_SECONDS (ByteCount / 2100000 + 31);\r |
6ad55b15 | 2007 | MaxRetry = 2;\r |
2008 | for (Index = 0; Index < MaxRetry; Index++) {\r | |
f95bc048 | 2009 | if (!ScsiDiskDevice->Cdb16Byte) {\r |
2010 | Status = ScsiDiskWrite10 (\r | |
a108933e | 2011 | ScsiDiskDevice,\r |
2012 | &NeedRetry,\r | |
a108933e | 2013 | Timeout,\r |
2014 | PtrBuffer,\r | |
2015 | &ByteCount,\r | |
f95bc048 | 2016 | (UINT32) Lba,\r |
a108933e | 2017 | SectorCount\r |
f95bc048 | 2018 | );\r |
a108933e | 2019 | } else {\r |
f95bc048 | 2020 | Status = ScsiDiskWrite16 (\r |
a108933e | 2021 | ScsiDiskDevice,\r |
2022 | &NeedRetry,\r | |
a108933e | 2023 | Timeout,\r |
2024 | PtrBuffer,\r | |
2025 | &ByteCount,\r | |
f95bc048 | 2026 | Lba,\r |
a108933e | 2027 | SectorCount\r |
f95bc048 | 2028 | ); \r |
a108933e | 2029 | }\r |
6ad55b15 | 2030 | if (!EFI_ERROR (Status)) {\r |
2031 | break;\r | |
2032 | }\r | |
2033 | \r | |
2034 | if (!NeedRetry) {\r | |
2035 | return EFI_DEVICE_ERROR;\r | |
2036 | }\r | |
2037 | }\r | |
2038 | \r | |
2039 | if ((Index == MaxRetry) && (Status != EFI_SUCCESS)) {\r | |
2040 | return EFI_DEVICE_ERROR;\r | |
2041 | }\r | |
2042 | //\r | |
2043 | // actual transferred sectors\r | |
2044 | //\r | |
2045 | SectorCount = ByteCount / BlockSize;\r | |
2046 | \r | |
a108933e | 2047 | Lba += SectorCount;\r |
6ad55b15 | 2048 | PtrBuffer = PtrBuffer + SectorCount * BlockSize;\r |
2049 | BlocksRemaining -= SectorCount;\r | |
2050 | }\r | |
2051 | \r | |
2052 | return EFI_SUCCESS;\r | |
2053 | }\r | |
2054 | \r | |
9beb888e | 2055 | \r |
2056 | /**\r | |
a108933e | 2057 | Submit Read(10) command.\r |
9beb888e | 2058 | \r |
2059 | @param ScsiDiskDevice The pointer of ScsiDiskDevice\r | |
2060 | @param NeedRetry The pointer of flag indicates if needs retry if error happens\r | |
9beb888e | 2061 | @param Timeout The time to complete the command\r |
2062 | @param DataBuffer The buffer to fill with the read out data\r | |
2063 | @param DataLength The length of buffer\r | |
2064 | @param StartLba The start logic block address\r | |
73a9e822 | 2065 | @param SectorCount The number of blocks to read\r |
9beb888e | 2066 | \r |
2067 | @return EFI_STATUS is returned by calling ScsiRead10Command().\r | |
2068 | **/\r | |
6ad55b15 | 2069 | EFI_STATUS\r |
2070 | ScsiDiskRead10 (\r | |
9beb888e | 2071 | IN SCSI_DISK_DEV *ScsiDiskDevice,\r |
2072 | OUT BOOLEAN *NeedRetry,\r | |
9beb888e | 2073 | IN UINT64 Timeout,\r |
2074 | OUT UINT8 *DataBuffer,\r | |
2075 | IN OUT UINT32 *DataLength,\r | |
2076 | IN UINT32 StartLba,\r | |
73a9e822 | 2077 | IN UINT32 SectorCount\r |
6ad55b15 | 2078 | )\r |
6ad55b15 | 2079 | {\r |
2080 | UINT8 SenseDataLength;\r | |
2081 | EFI_STATUS Status;\r | |
52f8e370 | 2082 | EFI_STATUS ReturnStatus;\r |
6ad55b15 | 2083 | UINT8 HostAdapterStatus;\r |
2084 | UINT8 TargetStatus;\r | |
52f8e370 | 2085 | UINTN Action;\r |
6ad55b15 | 2086 | \r |
73a9e822 TF |
2087 | //\r |
2088 | // Implement a backoff algorithem to resolve some compatibility issues that\r | |
2089 | // some SCSI targets or ATAPI devices couldn't correctly response reading/writing\r | |
2090 | // big data in a single operation.\r | |
2091 | // This algorithem will at first try to execute original request. If the request fails\r | |
2092 | // with media error sense data or else, it will reduce the transfer length to half and\r | |
2093 | // try again till the operation succeeds or fails with one sector transfer length.\r | |
2094 | //\r | |
2095 | BackOff:\r | |
6ad55b15 | 2096 | *NeedRetry = FALSE;\r |
52f8e370 TF |
2097 | Action = ACTION_NO_ACTION;\r |
2098 | SenseDataLength = (UINT8) (ScsiDiskDevice->SenseDataNumber * sizeof (EFI_SCSI_SENSE_DATA));\r | |
2099 | ReturnStatus = ScsiRead10Command (\r | |
2100 | ScsiDiskDevice->ScsiIo,\r | |
2101 | Timeout,\r | |
2102 | ScsiDiskDevice->SenseData,\r | |
2103 | &SenseDataLength,\r | |
2104 | &HostAdapterStatus,\r | |
2105 | &TargetStatus,\r | |
2106 | DataBuffer,\r | |
2107 | DataLength,\r | |
2108 | StartLba,\r | |
73a9e822 | 2109 | SectorCount\r |
52f8e370 TF |
2110 | );\r |
2111 | \r | |
2112 | if (ReturnStatus == EFI_NOT_READY) {\r | |
2113 | *NeedRetry = TRUE;\r | |
2114 | return EFI_DEVICE_ERROR;\r | |
2115 | } else if ((ReturnStatus == EFI_INVALID_PARAMETER) || (ReturnStatus == EFI_UNSUPPORTED)) {\r | |
2116 | *NeedRetry = FALSE;\r | |
2117 | return ReturnStatus;\r | |
2118 | }\r | |
2119 | \r | |
2120 | //\r | |
2121 | // go ahead to check HostAdapterStatus and TargetStatus\r | |
2122 | // (EFI_TIMEOUT, EFI_DEVICE_ERROR, EFI_WARN_BUFFER_TOO_SMALL)\r | |
2123 | //\r | |
2124 | Status = CheckHostAdapterStatus (HostAdapterStatus);\r | |
2125 | if ((Status == EFI_TIMEOUT) || (Status == EFI_NOT_READY)) {\r | |
2126 | *NeedRetry = TRUE;\r | |
2127 | return EFI_DEVICE_ERROR;\r | |
2128 | } else if (Status == EFI_DEVICE_ERROR) {\r | |
2129 | //\r | |
2130 | // reset the scsi channel\r | |
2131 | //\r | |
2132 | ScsiDiskDevice->ScsiIo->ResetBus (ScsiDiskDevice->ScsiIo);\r | |
2133 | *NeedRetry = FALSE;\r | |
2134 | return EFI_DEVICE_ERROR;\r | |
2135 | }\r | |
2136 | \r | |
2137 | Status = CheckTargetStatus (TargetStatus);\r | |
2138 | if (Status == EFI_NOT_READY) {\r | |
2139 | //\r | |
2140 | // reset the scsi device\r | |
2141 | //\r | |
2142 | ScsiDiskDevice->ScsiIo->ResetDevice (ScsiDiskDevice->ScsiIo);\r | |
2143 | *NeedRetry = TRUE;\r | |
2144 | return EFI_DEVICE_ERROR;\r | |
2145 | } else if (Status == EFI_DEVICE_ERROR) {\r | |
2146 | *NeedRetry = FALSE;\r | |
2147 | return EFI_DEVICE_ERROR;\r | |
2148 | }\r | |
2149 | \r | |
73a9e822 TF |
2150 | if ((TargetStatus == EFI_EXT_SCSI_STATUS_TARGET_CHECK_CONDITION) || (EFI_ERROR (ReturnStatus))) {\r |
2151 | DEBUG ((EFI_D_ERROR, "ScsiDiskRead10: Check Condition happened!\n"));\r | |
52f8e370 | 2152 | Status = DetectMediaParsingSenseKeys (ScsiDiskDevice, ScsiDiskDevice->SenseData, SenseDataLength / sizeof (EFI_SCSI_SENSE_DATA), &Action);\r |
73a9e822 | 2153 | if (Action == ACTION_RETRY_COMMAND_LATER) {\r |
52f8e370 TF |
2154 | *NeedRetry = TRUE;\r |
2155 | return EFI_DEVICE_ERROR;\r | |
73a9e822 TF |
2156 | } else if (Action == ACTION_RETRY_WITH_BACKOFF_ALGO) {\r |
2157 | if (SectorCount <= 1) {\r | |
2158 | //\r | |
2159 | // Jump out if the operation still fails with one sector transfer length.\r | |
2160 | //\r | |
2161 | *NeedRetry = FALSE;\r | |
2162 | return EFI_DEVICE_ERROR;\r | |
2163 | }\r | |
2164 | //\r | |
2165 | // Try again with half length if the sense data shows we need to retry.\r | |
2166 | //\r | |
2167 | SectorCount >>= 1;\r | |
2168 | *DataLength = SectorCount * ScsiDiskDevice->BlkIo.Media->BlockSize;\r | |
2169 | goto BackOff;\r | |
52f8e370 TF |
2170 | } else {\r |
2171 | *NeedRetry = FALSE;\r | |
2172 | return EFI_DEVICE_ERROR;\r | |
2173 | }\r | |
2174 | }\r | |
2175 | \r | |
2176 | return ReturnStatus;\r | |
6ad55b15 | 2177 | }\r |
2178 | \r | |
6ad55b15 | 2179 | \r |
9beb888e | 2180 | /**\r |
a108933e | 2181 | Submit Write(10) Command.\r |
6ad55b15 | 2182 | \r |
9beb888e | 2183 | @param ScsiDiskDevice The pointer of ScsiDiskDevice\r |
2184 | @param NeedRetry The pointer of flag indicates if needs retry if error happens\r | |
9beb888e | 2185 | @param Timeout The time to complete the command\r |
2186 | @param DataBuffer The buffer to fill with the read out data\r | |
2187 | @param DataLength The length of buffer\r | |
2188 | @param StartLba The start logic block address\r | |
73a9e822 | 2189 | @param SectorCount The number of blocks to write\r |
6ad55b15 | 2190 | \r |
9beb888e | 2191 | @return EFI_STATUS is returned by calling ScsiWrite10Command().\r |
6ad55b15 | 2192 | \r |
9beb888e | 2193 | **/\r |
2194 | EFI_STATUS\r | |
2195 | ScsiDiskWrite10 (\r | |
2196 | IN SCSI_DISK_DEV *ScsiDiskDevice,\r | |
2197 | OUT BOOLEAN *NeedRetry,\r | |
9beb888e | 2198 | IN UINT64 Timeout,\r |
2199 | IN UINT8 *DataBuffer,\r | |
2200 | IN OUT UINT32 *DataLength,\r | |
2201 | IN UINT32 StartLba,\r | |
73a9e822 | 2202 | IN UINT32 SectorCount\r |
9beb888e | 2203 | )\r |
6ad55b15 | 2204 | {\r |
2205 | EFI_STATUS Status;\r | |
52f8e370 | 2206 | EFI_STATUS ReturnStatus;\r |
6ad55b15 | 2207 | UINT8 SenseDataLength;\r |
2208 | UINT8 HostAdapterStatus;\r | |
2209 | UINT8 TargetStatus;\r | |
52f8e370 | 2210 | UINTN Action;\r |
6ad55b15 | 2211 | \r |
73a9e822 TF |
2212 | //\r |
2213 | // Implement a backoff algorithem to resolve some compatibility issues that\r | |
2214 | // some SCSI targets or ATAPI devices couldn't correctly response reading/writing\r | |
2215 | // big data in a single operation.\r | |
2216 | // This algorithem will at first try to execute original request. If the request fails\r | |
2217 | // with media error sense data or else, it will reduce the transfer length to half and\r | |
2218 | // try again till the operation succeeds or fails with one sector transfer length.\r | |
2219 | //\r | |
2220 | BackOff:\r | |
6ad55b15 | 2221 | *NeedRetry = FALSE;\r |
52f8e370 TF |
2222 | Action = ACTION_NO_ACTION;\r |
2223 | SenseDataLength = (UINT8) (ScsiDiskDevice->SenseDataNumber * sizeof (EFI_SCSI_SENSE_DATA));\r | |
2224 | ReturnStatus = ScsiWrite10Command (\r | |
2225 | ScsiDiskDevice->ScsiIo,\r | |
2226 | Timeout,\r | |
2227 | ScsiDiskDevice->SenseData,\r | |
2228 | &SenseDataLength,\r | |
2229 | &HostAdapterStatus,\r | |
2230 | &TargetStatus,\r | |
2231 | DataBuffer,\r | |
2232 | DataLength,\r | |
2233 | StartLba,\r | |
73a9e822 | 2234 | SectorCount\r |
52f8e370 TF |
2235 | );\r |
2236 | if (ReturnStatus == EFI_NOT_READY) {\r | |
2237 | *NeedRetry = TRUE;\r | |
2238 | return EFI_DEVICE_ERROR;\r | |
2239 | } else if ((ReturnStatus == EFI_INVALID_PARAMETER) || (ReturnStatus == EFI_UNSUPPORTED)) {\r | |
2240 | *NeedRetry = FALSE;\r | |
2241 | return ReturnStatus;\r | |
2242 | }\r | |
2243 | \r | |
2244 | //\r | |
2245 | // go ahead to check HostAdapterStatus and TargetStatus\r | |
2246 | // (EFI_TIMEOUT, EFI_DEVICE_ERROR, EFI_WARN_BUFFER_TOO_SMALL)\r | |
2247 | //\r | |
2248 | Status = CheckHostAdapterStatus (HostAdapterStatus);\r | |
2249 | if ((Status == EFI_TIMEOUT) || (Status == EFI_NOT_READY)) {\r | |
2250 | *NeedRetry = TRUE;\r | |
2251 | return EFI_DEVICE_ERROR;\r | |
2252 | } else if (Status == EFI_DEVICE_ERROR) {\r | |
2253 | //\r | |
2254 | // reset the scsi channel\r | |
2255 | //\r | |
2256 | ScsiDiskDevice->ScsiIo->ResetBus (ScsiDiskDevice->ScsiIo);\r | |
2257 | *NeedRetry = FALSE;\r | |
2258 | return EFI_DEVICE_ERROR;\r | |
2259 | }\r | |
2260 | \r | |
2261 | Status = CheckTargetStatus (TargetStatus);\r | |
2262 | if (Status == EFI_NOT_READY) {\r | |
2263 | //\r | |
2264 | // reset the scsi device\r | |
2265 | //\r | |
2266 | ScsiDiskDevice->ScsiIo->ResetDevice (ScsiDiskDevice->ScsiIo);\r | |
2267 | *NeedRetry = TRUE;\r | |
2268 | return EFI_DEVICE_ERROR;\r | |
2269 | } else if (Status == EFI_DEVICE_ERROR) {\r | |
2270 | *NeedRetry = FALSE;\r | |
2271 | return EFI_DEVICE_ERROR;\r | |
2272 | }\r | |
2273 | \r | |
73a9e822 TF |
2274 | if ((TargetStatus == EFI_EXT_SCSI_STATUS_TARGET_CHECK_CONDITION) || (EFI_ERROR (ReturnStatus))) {\r |
2275 | DEBUG ((EFI_D_ERROR, "ScsiDiskWrite10: Check Condition happened!\n"));\r | |
52f8e370 | 2276 | Status = DetectMediaParsingSenseKeys (ScsiDiskDevice, ScsiDiskDevice->SenseData, SenseDataLength / sizeof (EFI_SCSI_SENSE_DATA), &Action);\r |
73a9e822 | 2277 | if (Action == ACTION_RETRY_COMMAND_LATER) {\r |
52f8e370 TF |
2278 | *NeedRetry = TRUE;\r |
2279 | return EFI_DEVICE_ERROR;\r | |
73a9e822 TF |
2280 | } else if (Action == ACTION_RETRY_WITH_BACKOFF_ALGO) {\r |
2281 | if (SectorCount <= 1) {\r | |
2282 | //\r | |
2283 | // Jump out if the operation still fails with one sector transfer length.\r | |
2284 | //\r | |
2285 | *NeedRetry = FALSE;\r | |
2286 | return EFI_DEVICE_ERROR;\r | |
2287 | }\r | |
2288 | //\r | |
2289 | // Try again with half length if the sense data shows we need to retry.\r | |
2290 | //\r | |
2291 | SectorCount >>= 1;\r | |
2292 | *DataLength = SectorCount * ScsiDiskDevice->BlkIo.Media->BlockSize;\r | |
2293 | goto BackOff;\r | |
52f8e370 TF |
2294 | } else {\r |
2295 | *NeedRetry = FALSE;\r | |
2296 | return EFI_DEVICE_ERROR;\r | |
2297 | }\r | |
2298 | }\r | |
2299 | \r | |
2300 | return ReturnStatus;\r | |
6ad55b15 | 2301 | }\r |
2302 | \r | |
9beb888e | 2303 | \r |
a108933e | 2304 | /**\r |
2305 | Submit Read(16) command.\r | |
2306 | \r | |
2307 | @param ScsiDiskDevice The pointer of ScsiDiskDevice\r | |
2308 | @param NeedRetry The pointer of flag indicates if needs retry if error happens\r | |
a108933e | 2309 | @param Timeout The time to complete the command\r |
2310 | @param DataBuffer The buffer to fill with the read out data\r | |
2311 | @param DataLength The length of buffer\r | |
2312 | @param StartLba The start logic block address\r | |
73a9e822 | 2313 | @param SectorCount The number of blocks to read\r |
a108933e | 2314 | \r |
73a9e822 | 2315 | @return EFI_STATUS is returned by calling ScsiRead16Command().\r |
a108933e | 2316 | **/\r |
2317 | EFI_STATUS\r | |
2318 | ScsiDiskRead16 (\r | |
2319 | IN SCSI_DISK_DEV *ScsiDiskDevice,\r | |
2320 | OUT BOOLEAN *NeedRetry,\r | |
a108933e | 2321 | IN UINT64 Timeout,\r |
2322 | OUT UINT8 *DataBuffer,\r | |
2323 | IN OUT UINT32 *DataLength,\r | |
2324 | IN UINT64 StartLba,\r | |
73a9e822 | 2325 | IN UINT32 SectorCount\r |
a108933e | 2326 | )\r |
2327 | {\r | |
2328 | UINT8 SenseDataLength;\r | |
2329 | EFI_STATUS Status;\r | |
52f8e370 | 2330 | EFI_STATUS ReturnStatus;\r |
a108933e | 2331 | UINT8 HostAdapterStatus;\r |
2332 | UINT8 TargetStatus;\r | |
52f8e370 | 2333 | UINTN Action;\r |
a108933e | 2334 | \r |
73a9e822 TF |
2335 | //\r |
2336 | // Implement a backoff algorithem to resolve some compatibility issues that\r | |
2337 | // some SCSI targets or ATAPI devices couldn't correctly response reading/writing\r | |
2338 | // big data in a single operation.\r | |
2339 | // This algorithem will at first try to execute original request. If the request fails\r | |
2340 | // with media error sense data or else, it will reduce the transfer length to half and\r | |
2341 | // try again till the operation succeeds or fails with one sector transfer length.\r | |
2342 | //\r | |
2343 | BackOff:\r | |
a108933e | 2344 | *NeedRetry = FALSE;\r |
52f8e370 TF |
2345 | Action = ACTION_NO_ACTION;\r |
2346 | SenseDataLength = (UINT8) (ScsiDiskDevice->SenseDataNumber * sizeof (EFI_SCSI_SENSE_DATA));\r | |
2347 | ReturnStatus = ScsiRead16Command (\r | |
2348 | ScsiDiskDevice->ScsiIo,\r | |
2349 | Timeout,\r | |
2350 | ScsiDiskDevice->SenseData,\r | |
2351 | &SenseDataLength,\r | |
2352 | &HostAdapterStatus,\r | |
2353 | &TargetStatus,\r | |
2354 | DataBuffer,\r | |
2355 | DataLength,\r | |
2356 | StartLba,\r | |
73a9e822 | 2357 | SectorCount\r |
52f8e370 TF |
2358 | );\r |
2359 | if (ReturnStatus == EFI_NOT_READY) {\r | |
2360 | *NeedRetry = TRUE;\r | |
2361 | return EFI_DEVICE_ERROR;\r | |
2362 | } else if ((ReturnStatus == EFI_INVALID_PARAMETER) || (ReturnStatus == EFI_UNSUPPORTED)) {\r | |
2363 | *NeedRetry = FALSE;\r | |
2364 | return ReturnStatus;\r | |
2365 | }\r | |
2366 | \r | |
2367 | //\r | |
2368 | // go ahead to check HostAdapterStatus and TargetStatus\r | |
2369 | // (EFI_TIMEOUT, EFI_DEVICE_ERROR, EFI_WARN_BUFFER_TOO_SMALL)\r | |
2370 | //\r | |
2371 | Status = CheckHostAdapterStatus (HostAdapterStatus);\r | |
2372 | if ((Status == EFI_TIMEOUT) || (Status == EFI_NOT_READY)) {\r | |
2373 | *NeedRetry = TRUE;\r | |
2374 | return EFI_DEVICE_ERROR;\r | |
2375 | } else if (Status == EFI_DEVICE_ERROR) {\r | |
2376 | //\r | |
2377 | // reset the scsi channel\r | |
2378 | //\r | |
2379 | ScsiDiskDevice->ScsiIo->ResetBus (ScsiDiskDevice->ScsiIo);\r | |
2380 | *NeedRetry = FALSE;\r | |
2381 | return EFI_DEVICE_ERROR;\r | |
2382 | }\r | |
2383 | \r | |
2384 | Status = CheckTargetStatus (TargetStatus);\r | |
2385 | if (Status == EFI_NOT_READY) {\r | |
2386 | //\r | |
2387 | // reset the scsi device\r | |
2388 | //\r | |
2389 | ScsiDiskDevice->ScsiIo->ResetDevice (ScsiDiskDevice->ScsiIo);\r | |
2390 | *NeedRetry = TRUE;\r | |
2391 | return EFI_DEVICE_ERROR;\r | |
2392 | } else if (Status == EFI_DEVICE_ERROR) {\r | |
2393 | *NeedRetry = FALSE;\r | |
2394 | return EFI_DEVICE_ERROR;\r | |
2395 | }\r | |
2396 | \r | |
73a9e822 TF |
2397 | if ((TargetStatus == EFI_EXT_SCSI_STATUS_TARGET_CHECK_CONDITION) || (EFI_ERROR (ReturnStatus))) {\r |
2398 | DEBUG ((EFI_D_ERROR, "ScsiDiskRead16: Check Condition happened!\n"));\r | |
52f8e370 | 2399 | Status = DetectMediaParsingSenseKeys (ScsiDiskDevice, ScsiDiskDevice->SenseData, SenseDataLength / sizeof (EFI_SCSI_SENSE_DATA), &Action);\r |
73a9e822 | 2400 | if (Action == ACTION_RETRY_COMMAND_LATER) {\r |
52f8e370 TF |
2401 | *NeedRetry = TRUE;\r |
2402 | return EFI_DEVICE_ERROR;\r | |
73a9e822 TF |
2403 | } else if (Action == ACTION_RETRY_WITH_BACKOFF_ALGO) {\r |
2404 | if (SectorCount <= 1) {\r | |
2405 | //\r | |
2406 | // Jump out if the operation still fails with one sector transfer length.\r | |
2407 | //\r | |
2408 | *NeedRetry = FALSE;\r | |
2409 | return EFI_DEVICE_ERROR;\r | |
2410 | }\r | |
2411 | //\r | |
2412 | // Try again with half length if the sense data shows we need to retry.\r | |
2413 | //\r | |
2414 | SectorCount >>= 1;\r | |
2415 | *DataLength = SectorCount * ScsiDiskDevice->BlkIo.Media->BlockSize;\r | |
2416 | goto BackOff;\r | |
52f8e370 TF |
2417 | } else {\r |
2418 | *NeedRetry = FALSE;\r | |
2419 | return EFI_DEVICE_ERROR;\r | |
2420 | }\r | |
2421 | }\r | |
2422 | \r | |
2423 | return ReturnStatus;\r | |
a108933e | 2424 | }\r |
2425 | \r | |
2426 | \r | |
2427 | /**\r | |
2428 | Submit Write(16) Command.\r | |
2429 | \r | |
2430 | @param ScsiDiskDevice The pointer of ScsiDiskDevice\r | |
2431 | @param NeedRetry The pointer of flag indicates if needs retry if error happens\r | |
a108933e | 2432 | @param Timeout The time to complete the command\r |
2433 | @param DataBuffer The buffer to fill with the read out data\r | |
2434 | @param DataLength The length of buffer\r | |
2435 | @param StartLba The start logic block address\r | |
73a9e822 | 2436 | @param SectorCount The number of blocks to write\r |
a108933e | 2437 | \r |
73a9e822 | 2438 | @return EFI_STATUS is returned by calling ScsiWrite16Command().\r |
a108933e | 2439 | \r |
2440 | **/\r | |
2441 | EFI_STATUS\r | |
2442 | ScsiDiskWrite16 (\r | |
2443 | IN SCSI_DISK_DEV *ScsiDiskDevice,\r | |
2444 | OUT BOOLEAN *NeedRetry,\r | |
a108933e | 2445 | IN UINT64 Timeout,\r |
2446 | IN UINT8 *DataBuffer,\r | |
2447 | IN OUT UINT32 *DataLength,\r | |
2448 | IN UINT64 StartLba,\r | |
73a9e822 | 2449 | IN UINT32 SectorCount\r |
a108933e | 2450 | )\r |
2451 | {\r | |
2452 | EFI_STATUS Status;\r | |
52f8e370 | 2453 | EFI_STATUS ReturnStatus;\r |
a108933e | 2454 | UINT8 SenseDataLength;\r |
2455 | UINT8 HostAdapterStatus;\r | |
2456 | UINT8 TargetStatus;\r | |
52f8e370 | 2457 | UINTN Action;\r |
a108933e | 2458 | \r |
73a9e822 TF |
2459 | //\r |
2460 | // Implement a backoff algorithem to resolve some compatibility issues that\r | |
2461 | // some SCSI targets or ATAPI devices couldn't correctly response reading/writing\r | |
2462 | // big data in a single operation.\r | |
2463 | // This algorithem will at first try to execute original request. If the request fails\r | |
2464 | // with media error sense data or else, it will reduce the transfer length to half and\r | |
2465 | // try again till the operation succeeds or fails with one sector transfer length.\r | |
2466 | //\r | |
2467 | BackOff:\r | |
a108933e | 2468 | *NeedRetry = FALSE;\r |
52f8e370 TF |
2469 | Action = ACTION_NO_ACTION;\r |
2470 | SenseDataLength = (UINT8) (ScsiDiskDevice->SenseDataNumber * sizeof (EFI_SCSI_SENSE_DATA));\r | |
2471 | ReturnStatus = ScsiWrite16Command (\r | |
2472 | ScsiDiskDevice->ScsiIo,\r | |
2473 | Timeout,\r | |
2474 | ScsiDiskDevice->SenseData,\r | |
2475 | &SenseDataLength,\r | |
2476 | &HostAdapterStatus,\r | |
2477 | &TargetStatus,\r | |
2478 | DataBuffer,\r | |
2479 | DataLength,\r | |
2480 | StartLba,\r | |
73a9e822 | 2481 | SectorCount\r |
52f8e370 TF |
2482 | );\r |
2483 | if (ReturnStatus == EFI_NOT_READY) {\r | |
2484 | *NeedRetry = TRUE;\r | |
2485 | return EFI_DEVICE_ERROR;\r | |
2486 | } else if ((ReturnStatus == EFI_INVALID_PARAMETER) || (ReturnStatus == EFI_UNSUPPORTED)) {\r | |
2487 | *NeedRetry = FALSE;\r | |
2488 | return ReturnStatus;\r | |
2489 | }\r | |
2490 | \r | |
2491 | //\r | |
2492 | // go ahead to check HostAdapterStatus and TargetStatus\r | |
2493 | // (EFI_TIMEOUT, EFI_DEVICE_ERROR, EFI_WARN_BUFFER_TOO_SMALL)\r | |
2494 | //\r | |
2495 | Status = CheckHostAdapterStatus (HostAdapterStatus);\r | |
2496 | if ((Status == EFI_TIMEOUT) || (Status == EFI_NOT_READY)) {\r | |
2497 | *NeedRetry = TRUE;\r | |
2498 | return EFI_DEVICE_ERROR;\r | |
2499 | } else if (Status == EFI_DEVICE_ERROR) {\r | |
2500 | //\r | |
2501 | // reset the scsi channel\r | |
2502 | //\r | |
2503 | ScsiDiskDevice->ScsiIo->ResetBus (ScsiDiskDevice->ScsiIo);\r | |
2504 | *NeedRetry = FALSE;\r | |
2505 | return EFI_DEVICE_ERROR;\r | |
2506 | }\r | |
2507 | \r | |
2508 | Status = CheckTargetStatus (TargetStatus);\r | |
2509 | if (Status == EFI_NOT_READY) {\r | |
2510 | //\r | |
2511 | // reset the scsi device\r | |
2512 | //\r | |
2513 | ScsiDiskDevice->ScsiIo->ResetDevice (ScsiDiskDevice->ScsiIo);\r | |
2514 | *NeedRetry = TRUE;\r | |
2515 | return EFI_DEVICE_ERROR;\r | |
2516 | } else if (Status == EFI_DEVICE_ERROR) {\r | |
2517 | *NeedRetry = FALSE;\r | |
2518 | return EFI_DEVICE_ERROR;\r | |
2519 | }\r | |
2520 | \r | |
73a9e822 TF |
2521 | if ((TargetStatus == EFI_EXT_SCSI_STATUS_TARGET_CHECK_CONDITION) || (EFI_ERROR (ReturnStatus))) {\r |
2522 | DEBUG ((EFI_D_ERROR, "ScsiDiskWrite16: Check Condition happened!\n"));\r | |
52f8e370 | 2523 | Status = DetectMediaParsingSenseKeys (ScsiDiskDevice, ScsiDiskDevice->SenseData, SenseDataLength / sizeof (EFI_SCSI_SENSE_DATA), &Action);\r |
73a9e822 | 2524 | if (Action == ACTION_RETRY_COMMAND_LATER) {\r |
52f8e370 TF |
2525 | *NeedRetry = TRUE;\r |
2526 | return EFI_DEVICE_ERROR;\r | |
73a9e822 TF |
2527 | } else if (Action == ACTION_RETRY_WITH_BACKOFF_ALGO) {\r |
2528 | if (SectorCount <= 1) {\r | |
2529 | //\r | |
2530 | // Jump out if the operation still fails with one sector transfer length.\r | |
2531 | //\r | |
2532 | *NeedRetry = FALSE;\r | |
2533 | return EFI_DEVICE_ERROR;\r | |
2534 | }\r | |
2535 | //\r | |
2536 | // Try again with half length if the sense data shows we need to retry.\r | |
2537 | //\r | |
2538 | SectorCount >>= 1;\r | |
2539 | *DataLength = SectorCount * ScsiDiskDevice->BlkIo.Media->BlockSize;\r | |
2540 | goto BackOff;\r | |
52f8e370 TF |
2541 | } else {\r |
2542 | *NeedRetry = FALSE;\r | |
2543 | return EFI_DEVICE_ERROR;\r | |
2544 | }\r | |
2545 | }\r | |
2546 | \r | |
2547 | return ReturnStatus;\r | |
a108933e | 2548 | }\r |
2549 | \r | |
2550 | \r | |
9beb888e | 2551 | /**\r |
2552 | Check sense key to find if media presents.\r | |
2553 | \r | |
2554 | @param SenseData The pointer of EFI_SCSI_SENSE_DATA\r | |
2555 | @param SenseCounts The number of sense key\r | |
2556 | \r | |
2557 | @retval TRUE NOT any media\r | |
2558 | @retval FALSE Media presents\r | |
2559 | **/\r | |
6ad55b15 | 2560 | BOOLEAN\r |
2561 | ScsiDiskIsNoMedia (\r | |
2562 | IN EFI_SCSI_SENSE_DATA *SenseData,\r | |
2563 | IN UINTN SenseCounts\r | |
2564 | )\r | |
6ad55b15 | 2565 | {\r |
2566 | EFI_SCSI_SENSE_DATA *SensePtr;\r | |
2567 | UINTN Index;\r | |
2568 | BOOLEAN IsNoMedia;\r | |
2569 | \r | |
2570 | IsNoMedia = FALSE;\r | |
2571 | SensePtr = SenseData;\r | |
2572 | \r | |
2573 | for (Index = 0; Index < SenseCounts; Index++) {\r | |
6ad55b15 | 2574 | //\r |
2575 | // Sense Key is EFI_SCSI_SK_NOT_READY (0x2),\r | |
2576 | // Additional Sense Code is ASC_NO_MEDIA (0x3A)\r | |
2577 | //\r | |
2578 | if ((SensePtr->Sense_Key == EFI_SCSI_SK_NOT_READY) &&\r | |
2579 | (SensePtr->Addnl_Sense_Code == EFI_SCSI_ASC_NO_MEDIA)) {\r | |
2580 | IsNoMedia = TRUE;\r | |
2581 | }\r | |
6ad55b15 | 2582 | SensePtr++;\r |
2583 | }\r | |
2584 | \r | |
2585 | return IsNoMedia;\r | |
2586 | }\r | |
2587 | \r | |
9beb888e | 2588 | \r |
2589 | /**\r | |
2590 | Parse sense key.\r | |
2591 | \r | |
2592 | @param SenseData The pointer of EFI_SCSI_SENSE_DATA\r | |
2593 | @param SenseCounts The number of sense key\r | |
2594 | \r | |
2595 | @retval TRUE Error\r | |
2596 | @retval FALSE NOT error\r | |
2597 | \r | |
2598 | **/\r | |
6ad55b15 | 2599 | BOOLEAN\r |
2600 | ScsiDiskIsMediaError (\r | |
2601 | IN EFI_SCSI_SENSE_DATA *SenseData,\r | |
2602 | IN UINTN SenseCounts\r | |
2603 | )\r | |
6ad55b15 | 2604 | {\r |
2605 | EFI_SCSI_SENSE_DATA *SensePtr;\r | |
2606 | UINTN Index;\r | |
2607 | BOOLEAN IsError;\r | |
2608 | \r | |
2609 | IsError = FALSE;\r | |
2610 | SensePtr = SenseData;\r | |
2611 | \r | |
2612 | for (Index = 0; Index < SenseCounts; Index++) {\r | |
2613 | \r | |
2614 | switch (SensePtr->Sense_Key) {\r | |
2615 | \r | |
2616 | case EFI_SCSI_SK_MEDIUM_ERROR:\r | |
2617 | //\r | |
2618 | // Sense Key is EFI_SCSI_SK_MEDIUM_ERROR (0x3)\r | |
2619 | //\r | |
2620 | switch (SensePtr->Addnl_Sense_Code) {\r | |
2621 | \r | |
2622 | //\r | |
2623 | // fall through\r | |
2624 | //\r | |
2625 | case EFI_SCSI_ASC_MEDIA_ERR1:\r | |
2626 | \r | |
2627 | //\r | |
2628 | // fall through\r | |
2629 | //\r | |
2630 | case EFI_SCSI_ASC_MEDIA_ERR2:\r | |
2631 | \r | |
2632 | //\r | |
2633 | // fall through\r | |
2634 | //\r | |
2635 | case EFI_SCSI_ASC_MEDIA_ERR3:\r | |
2636 | case EFI_SCSI_ASC_MEDIA_ERR4:\r | |
2637 | IsError = TRUE;\r | |
2638 | break;\r | |
2639 | \r | |
2640 | default:\r | |
2641 | break;\r | |
2642 | }\r | |
2643 | \r | |
2644 | break;\r | |
2645 | \r | |
2646 | case EFI_SCSI_SK_NOT_READY:\r | |
2647 | //\r | |
2648 | // Sense Key is EFI_SCSI_SK_NOT_READY (0x2)\r | |
2649 | //\r | |
2650 | switch (SensePtr->Addnl_Sense_Code) {\r | |
2651 | //\r | |
2652 | // Additional Sense Code is ASC_MEDIA_UPSIDE_DOWN (0x6)\r | |
2653 | //\r | |
2654 | case EFI_SCSI_ASC_MEDIA_UPSIDE_DOWN:\r | |
2655 | IsError = TRUE;\r | |
2656 | break;\r | |
2657 | \r | |
2658 | default:\r | |
2659 | break;\r | |
2660 | }\r | |
2661 | break;\r | |
2662 | \r | |
2663 | default:\r | |
2664 | break;\r | |
2665 | }\r | |
2666 | \r | |
2667 | SensePtr++;\r | |
2668 | }\r | |
2669 | \r | |
2670 | return IsError;\r | |
2671 | }\r | |
2672 | \r | |
9beb888e | 2673 | \r |
2674 | /**\r | |
2675 | Check sense key to find if hardware error happens.\r | |
2676 | \r | |
2677 | @param SenseData The pointer of EFI_SCSI_SENSE_DATA\r | |
2678 | @param SenseCounts The number of sense key\r | |
2679 | \r | |
2680 | @retval TRUE Hardware error exits.\r | |
2681 | @retval FALSE NO error.\r | |
2682 | \r | |
2683 | **/\r | |
6ad55b15 | 2684 | BOOLEAN\r |
2685 | ScsiDiskIsHardwareError (\r | |
2686 | IN EFI_SCSI_SENSE_DATA *SenseData,\r | |
2687 | IN UINTN SenseCounts\r | |
2688 | )\r | |
6ad55b15 | 2689 | {\r |
2690 | EFI_SCSI_SENSE_DATA *SensePtr;\r | |
2691 | UINTN Index;\r | |
2692 | BOOLEAN IsError;\r | |
2693 | \r | |
2694 | IsError = FALSE;\r | |
2695 | SensePtr = SenseData;\r | |
2696 | \r | |
2697 | for (Index = 0; Index < SenseCounts; Index++) {\r | |
2698 | \r | |
2699 | //\r | |
2700 | // Sense Key is EFI_SCSI_SK_HARDWARE_ERROR (0x4)\r | |
2701 | //\r | |
2702 | if (SensePtr->Sense_Key == EFI_SCSI_SK_HARDWARE_ERROR) {\r | |
2703 | IsError = TRUE;\r | |
2704 | }\r | |
2705 | \r | |
2706 | SensePtr++;\r | |
2707 | }\r | |
2708 | \r | |
2709 | return IsError;\r | |
2710 | }\r | |
2711 | \r | |
9beb888e | 2712 | \r |
2713 | /**\r | |
2714 | Check sense key to find if media has changed.\r | |
2715 | \r | |
2716 | @param SenseData The pointer of EFI_SCSI_SENSE_DATA\r | |
2717 | @param SenseCounts The number of sense key\r | |
2718 | \r | |
2719 | @retval TRUE Media is changed.\r | |
d716651f | 2720 | @retval FALSE Media is NOT changed.\r |
9beb888e | 2721 | **/\r |
6ad55b15 | 2722 | BOOLEAN\r |
2723 | ScsiDiskIsMediaChange (\r | |
2724 | IN EFI_SCSI_SENSE_DATA *SenseData,\r | |
2725 | IN UINTN SenseCounts\r | |
2726 | )\r | |
6ad55b15 | 2727 | {\r |
2728 | EFI_SCSI_SENSE_DATA *SensePtr;\r | |
2729 | UINTN Index;\r | |
2730 | BOOLEAN IsMediaChanged;\r | |
2731 | \r | |
2732 | IsMediaChanged = FALSE;\r | |
2733 | SensePtr = SenseData;\r | |
2734 | \r | |
2735 | for (Index = 0; Index < SenseCounts; Index++) {\r | |
2736 | //\r | |
2737 | // Sense Key is EFI_SCSI_SK_UNIT_ATTENTION (0x6),\r | |
2738 | // Additional sense code is EFI_SCSI_ASC_MEDIA_CHANGE (0x28)\r | |
2739 | //\r | |
2740 | if ((SensePtr->Sense_Key == EFI_SCSI_SK_UNIT_ATTENTION) &&\r | |
2741 | (SensePtr->Addnl_Sense_Code == EFI_SCSI_ASC_MEDIA_CHANGE)) {\r | |
2742 | IsMediaChanged = TRUE;\r | |
2743 | }\r | |
2744 | \r | |
2745 | SensePtr++;\r | |
2746 | }\r | |
2747 | \r | |
2748 | return IsMediaChanged;\r | |
2749 | }\r | |
2750 | \r | |
9beb888e | 2751 | /**\r |
2752 | Check sense key to find if reset happens.\r | |
2753 | \r | |
2754 | @param SenseData The pointer of EFI_SCSI_SENSE_DATA\r | |
2755 | @param SenseCounts The number of sense key\r | |
2756 | \r | |
2757 | @retval TRUE It is reset before.\r | |
2758 | @retval FALSE It is NOT reset before.\r | |
2759 | \r | |
2760 | **/\r | |
6ad55b15 | 2761 | BOOLEAN\r |
2762 | ScsiDiskIsResetBefore (\r | |
2763 | IN EFI_SCSI_SENSE_DATA *SenseData,\r | |
2764 | IN UINTN SenseCounts\r | |
2765 | )\r | |
6ad55b15 | 2766 | {\r |
2767 | EFI_SCSI_SENSE_DATA *SensePtr;\r | |
2768 | UINTN Index;\r | |
2769 | BOOLEAN IsResetBefore;\r | |
2770 | \r | |
2771 | IsResetBefore = FALSE;\r | |
2772 | SensePtr = SenseData;\r | |
2773 | \r | |
2774 | for (Index = 0; Index < SenseCounts; Index++) {\r | |
2775 | \r | |
2776 | //\r | |
2777 | // Sense Key is EFI_SCSI_SK_UNIT_ATTENTION (0x6)\r | |
2778 | // Additional Sense Code is EFI_SCSI_ASC_RESET (0x29)\r | |
2779 | //\r | |
2780 | if ((SensePtr->Sense_Key == EFI_SCSI_SK_UNIT_ATTENTION) &&\r | |
2781 | (SensePtr->Addnl_Sense_Code == EFI_SCSI_ASC_RESET)) {\r | |
2782 | IsResetBefore = TRUE;\r | |
2783 | }\r | |
2784 | \r | |
2785 | SensePtr++;\r | |
2786 | }\r | |
2787 | \r | |
2788 | return IsResetBefore;\r | |
2789 | }\r | |
2790 | \r | |
9beb888e | 2791 | /**\r |
2792 | Check sense key to find if the drive is ready.\r | |
2793 | \r | |
2794 | @param SenseData The pointer of EFI_SCSI_SENSE_DATA\r | |
2795 | @param SenseCounts The number of sense key\r | |
2796 | @param RetryLater The flag means if need a retry \r | |
2797 | \r | |
2798 | @retval TRUE Drive is ready.\r | |
2799 | @retval FALSE Drive is NOT ready.\r | |
2800 | \r | |
2801 | **/\r | |
6ad55b15 | 2802 | BOOLEAN\r |
2803 | ScsiDiskIsDriveReady (\r | |
2804 | IN EFI_SCSI_SENSE_DATA *SenseData,\r | |
2805 | IN UINTN SenseCounts,\r | |
2806 | OUT BOOLEAN *RetryLater\r | |
2807 | )\r | |
6ad55b15 | 2808 | {\r |
2809 | EFI_SCSI_SENSE_DATA *SensePtr;\r | |
2810 | UINTN Index;\r | |
2811 | BOOLEAN IsReady;\r | |
2812 | \r | |
2813 | IsReady = TRUE;\r | |
2814 | *RetryLater = FALSE;\r | |
2815 | SensePtr = SenseData;\r | |
2816 | \r | |
2817 | for (Index = 0; Index < SenseCounts; Index++) {\r | |
2818 | \r | |
2819 | switch (SensePtr->Sense_Key) {\r | |
2820 | \r | |
2821 | case EFI_SCSI_SK_NOT_READY:\r | |
2822 | //\r | |
2823 | // Sense Key is EFI_SCSI_SK_NOT_READY (0x2)\r | |
2824 | //\r | |
2825 | switch (SensePtr->Addnl_Sense_Code) {\r | |
2826 | case EFI_SCSI_ASC_NOT_READY:\r | |
2827 | //\r | |
2828 | // Additional Sense Code is EFI_SCSI_ASC_NOT_READY (0x4)\r | |
2829 | //\r | |
2830 | switch (SensePtr->Addnl_Sense_Code_Qualifier) {\r | |
2831 | case EFI_SCSI_ASCQ_IN_PROGRESS:\r | |
2832 | //\r | |
2833 | // Additional Sense Code Qualifier is\r | |
2834 | // EFI_SCSI_ASCQ_IN_PROGRESS (0x1)\r | |
2835 | //\r | |
2836 | IsReady = FALSE;\r | |
2837 | *RetryLater = TRUE;\r | |
2838 | break;\r | |
2839 | \r | |
2840 | default:\r | |
2841 | IsReady = FALSE;\r | |
2842 | *RetryLater = FALSE;\r | |
2843 | break;\r | |
2844 | }\r | |
2845 | break;\r | |
2846 | \r | |
2847 | default:\r | |
2848 | break;\r | |
2849 | }\r | |
2850 | break;\r | |
2851 | \r | |
2852 | default:\r | |
2853 | break;\r | |
2854 | }\r | |
2855 | \r | |
2856 | SensePtr++;\r | |
2857 | }\r | |
2858 | \r | |
2859 | return IsReady;\r | |
2860 | }\r | |
2861 | \r | |
9beb888e | 2862 | /**\r |
2863 | Check sense key to find if it has sense key.\r | |
2864 | \r | |
2865 | @param SenseData - The pointer of EFI_SCSI_SENSE_DATA\r | |
2866 | @param SenseCounts - The number of sense key\r | |
2867 | \r | |
2868 | @retval TRUE It has sense key.\r | |
2869 | @retval FALSE It has NOT any sense key.\r | |
2870 | \r | |
2871 | **/\r | |
6ad55b15 | 2872 | BOOLEAN\r |
2873 | ScsiDiskHaveSenseKey (\r | |
2874 | IN EFI_SCSI_SENSE_DATA *SenseData,\r | |
2875 | IN UINTN SenseCounts\r | |
2876 | )\r | |
6ad55b15 | 2877 | {\r |
2878 | EFI_SCSI_SENSE_DATA *SensePtr;\r | |
2879 | UINTN Index;\r | |
2880 | BOOLEAN HaveSenseKey;\r | |
2881 | \r | |
2882 | if (SenseCounts == 0) {\r | |
2883 | HaveSenseKey = FALSE;\r | |
2884 | } else {\r | |
2885 | HaveSenseKey = TRUE;\r | |
2886 | }\r | |
2887 | \r | |
2888 | SensePtr = SenseData;\r | |
2889 | \r | |
2890 | for (Index = 0; Index < SenseCounts; Index++) {\r | |
2891 | \r | |
2892 | //\r | |
2893 | // Sense Key is SK_NO_SENSE (0x0)\r | |
2894 | //\r | |
2895 | if ((SensePtr->Sense_Key == EFI_SCSI_SK_NO_SENSE) &&\r | |
2896 | (Index == 0)) {\r | |
2897 | HaveSenseKey = FALSE;\r | |
2898 | }\r | |
2899 | \r | |
2900 | SensePtr++;\r | |
2901 | }\r | |
2902 | \r | |
2903 | return HaveSenseKey;\r | |
2904 | }\r | |
2905 | \r | |
9beb888e | 2906 | /**\r |
2907 | Release resource about disk device.\r | |
2908 | \r | |
2909 | @param ScsiDiskDevice The pointer of SCSI_DISK_DEV\r | |
2910 | \r | |
2911 | **/\r | |
6ad55b15 | 2912 | VOID\r |
2913 | ReleaseScsiDiskDeviceResources (\r | |
2914 | IN SCSI_DISK_DEV *ScsiDiskDevice\r | |
2915 | )\r | |
6ad55b15 | 2916 | {\r |
2917 | if (ScsiDiskDevice == NULL) {\r | |
2918 | return ;\r | |
2919 | }\r | |
2920 | \r | |
2921 | if (ScsiDiskDevice->SenseData != NULL) {\r | |
9b38ff34 | 2922 | FreePool (ScsiDiskDevice->SenseData);\r |
6ad55b15 | 2923 | ScsiDiskDevice->SenseData = NULL;\r |
2924 | }\r | |
2925 | \r | |
2926 | if (ScsiDiskDevice->ControllerNameTable != NULL) {\r | |
2927 | FreeUnicodeStringTable (ScsiDiskDevice->ControllerNameTable);\r | |
2928 | ScsiDiskDevice->ControllerNameTable = NULL;\r | |
2929 | }\r | |
2930 | \r | |
9b38ff34 | 2931 | FreePool (ScsiDiskDevice);\r |
6ad55b15 | 2932 | \r |
2933 | ScsiDiskDevice = NULL;\r | |
2934 | }\r | |
d14faa52 | 2935 | \r |
2936 | /**\r | |
2937 | Determine if Block Io should be produced.\r | |
2938 | \r | |
2939 | \r | |
d716651f | 2940 | @param ChildHandle Child Handle to retrieve Parent information.\r |
d14faa52 | 2941 | \r |
2942 | @retval TRUE Should produce Block Io.\r | |
2943 | @retval FALSE Should not produce Block Io.\r | |
2944 | \r | |
2945 | **/ \r | |
2946 | BOOLEAN\r | |
2947 | DetermineInstallBlockIo (\r | |
2948 | IN EFI_HANDLE ChildHandle\r | |
2949 | ) \r | |
2950 | {\r | |
2951 | EFI_SCSI_PASS_THRU_PROTOCOL *ScsiPassThru;\r | |
2952 | EFI_EXT_SCSI_PASS_THRU_PROTOCOL *ExtScsiPassThru;\r | |
2953 | \r | |
2954 | //\r | |
2955 | // Firstly, check if ExtScsiPassThru Protocol parent handle exists. If existence,\r | |
2956 | // check its attribute, logic or physical.\r | |
2957 | //\r | |
2958 | ExtScsiPassThru = (EFI_EXT_SCSI_PASS_THRU_PROTOCOL *)GetParentProtocol (&gEfiExtScsiPassThruProtocolGuid, ChildHandle);\r | |
2959 | if (ExtScsiPassThru != NULL) {\r | |
2960 | if ((ExtScsiPassThru->Mode->Attributes & EFI_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL) != 0) {\r | |
2961 | return TRUE;\r | |
2962 | }\r | |
2963 | }\r | |
2964 | \r | |
2965 | //\r | |
2966 | // Secondly, check if ScsiPassThru Protocol parent handle exists. If existence,\r | |
2967 | // check its attribute, logic or physical.\r | |
2968 | //\r | |
2969 | ScsiPassThru = (EFI_SCSI_PASS_THRU_PROTOCOL *)GetParentProtocol (&gEfiScsiPassThruProtocolGuid, ChildHandle);\r | |
2970 | if (ScsiPassThru != NULL) {\r | |
2971 | if ((ScsiPassThru->Mode->Attributes & EFI_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL) != 0) {\r | |
2972 | return TRUE;\r | |
2973 | }\r | |
2974 | }\r | |
2975 | \r | |
2976 | return FALSE;\r | |
2977 | }\r | |
2978 | \r | |
2979 | /**\r | |
2980 | Search protocol database and check to see if the protocol\r | |
2981 | specified by ProtocolGuid is present on a ControllerHandle and opened by\r | |
2982 | ChildHandle with an attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.\r | |
2983 | If the ControllerHandle is found, then the protocol specified by ProtocolGuid\r | |
2984 | will be opened on it. \r | |
2985 | \r | |
2986 | \r | |
2987 | @param ProtocolGuid ProtocolGuid pointer.\r | |
2988 | @param ChildHandle Child Handle to retrieve Parent information.\r | |
2989 | \r | |
2990 | **/ \r | |
2991 | VOID *\r | |
2992 | EFIAPI\r | |
2993 | GetParentProtocol (\r | |
2994 | IN EFI_GUID *ProtocolGuid,\r | |
2995 | IN EFI_HANDLE ChildHandle\r | |
2996 | ) \r | |
2997 | {\r | |
2998 | UINTN Index;\r | |
2999 | UINTN HandleCount;\r | |
3000 | VOID *Interface; \r | |
3001 | EFI_STATUS Status;\r | |
3002 | EFI_HANDLE *HandleBuffer;\r | |
3003 | \r | |
3004 | //\r | |
3005 | // Retrieve the list of all handles from the handle database\r | |
3006 | //\r | |
3007 | Status = gBS->LocateHandleBuffer (\r | |
3008 | ByProtocol,\r | |
3009 | ProtocolGuid,\r | |
3010 | NULL,\r | |
3011 | &HandleCount,\r | |
3012 | &HandleBuffer\r | |
3013 | );\r | |
3014 | \r | |
3015 | if (EFI_ERROR (Status)) {\r | |
3016 | return NULL;\r | |
3017 | }\r | |
3018 | \r | |
3019 | //\r | |
3020 | // Iterate to find who is parent handle that is opened with ProtocolGuid by ChildHandle \r | |
3021 | //\r | |
3022 | for (Index = 0; Index < HandleCount; Index++) {\r | |
3023 | Status = EfiTestChildHandle (HandleBuffer[Index], ChildHandle, ProtocolGuid);\r | |
3024 | if (!EFI_ERROR (Status)) {\r | |
3025 | Status = gBS->HandleProtocol (HandleBuffer[Index], ProtocolGuid, (VOID **)&Interface);\r | |
3026 | if (!EFI_ERROR (Status)) {\r | |
3027 | gBS->FreePool (HandleBuffer);\r | |
3028 | return Interface;\r | |
3029 | }\r | |
3030 | }\r | |
3031 | }\r | |
3032 | \r | |
3033 | gBS->FreePool (HandleBuffer);\r | |
3034 | return NULL;\r | |
3035 | } \r | |
3036 | \r | |
d716651f | 3037 | /**\r |
3038 | Provides inquiry information for the controller type.\r | |
3039 | \r | |
3040 | This function is used by the IDE bus driver to get inquiry data. Data format\r | |
3041 | of Identify data is defined by the Interface GUID.\r | |
3042 | \r | |
4140a663 | 3043 | @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r |
3044 | @param[in, out] InquiryData Pointer to a buffer for the inquiry data.\r | |
3045 | @param[in, out] InquiryDataSize Pointer to the value for the inquiry data size.\r | |
d716651f | 3046 | \r |
3047 | @retval EFI_SUCCESS The command was accepted without any errors.\r | |
3048 | @retval EFI_NOT_FOUND Device does not support this data class \r | |
3049 | @retval EFI_DEVICE_ERROR Error reading InquiryData from device \r | |
3050 | @retval EFI_BUFFER_TOO_SMALL InquiryDataSize not big enough \r | |
3051 | \r | |
3052 | **/\r | |
3053 | EFI_STATUS\r | |
3054 | EFIAPI\r | |
3055 | ScsiDiskInfoInquiry (\r | |
3056 | IN EFI_DISK_INFO_PROTOCOL *This,\r | |
3057 | IN OUT VOID *InquiryData,\r | |
3058 | IN OUT UINT32 *InquiryDataSize\r | |
3059 | )\r | |
3060 | {\r | |
3061 | EFI_STATUS Status;\r | |
3062 | SCSI_DISK_DEV *ScsiDiskDevice;\r | |
3063 | \r | |
3064 | ScsiDiskDevice = SCSI_DISK_DEV_FROM_DISKINFO (This);\r | |
3065 | \r | |
3066 | Status = EFI_BUFFER_TOO_SMALL;\r | |
3067 | if (*InquiryDataSize >= sizeof (ScsiDiskDevice->InquiryData)) {\r | |
3068 | Status = EFI_SUCCESS;\r | |
3069 | CopyMem (InquiryData, &ScsiDiskDevice->InquiryData, sizeof (ScsiDiskDevice->InquiryData));\r | |
3070 | }\r | |
3071 | *InquiryDataSize = sizeof (ScsiDiskDevice->InquiryData);\r | |
3072 | return Status;\r | |
3073 | }\r | |
3074 | \r | |
3075 | \r | |
3076 | /**\r | |
3077 | Provides identify information for the controller type.\r | |
3078 | \r | |
3079 | This function is used by the IDE bus driver to get identify data. Data format\r | |
3080 | of Identify data is defined by the Interface GUID.\r | |
3081 | \r | |
4140a663 | 3082 | @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL \r |
d716651f | 3083 | instance.\r |
4140a663 | 3084 | @param[in, out] IdentifyData Pointer to a buffer for the identify data.\r |
3085 | @param[in, out] IdentifyDataSize Pointer to the value for the identify data\r | |
d716651f | 3086 | size.\r |
3087 | \r | |
3088 | @retval EFI_SUCCESS The command was accepted without any errors.\r | |
3089 | @retval EFI_NOT_FOUND Device does not support this data class \r | |
3090 | @retval EFI_DEVICE_ERROR Error reading IdentifyData from device \r | |
3091 | @retval EFI_BUFFER_TOO_SMALL IdentifyDataSize not big enough \r | |
3092 | \r | |
3093 | **/\r | |
3094 | EFI_STATUS\r | |
3095 | EFIAPI\r | |
3096 | ScsiDiskInfoIdentify (\r | |
3097 | IN EFI_DISK_INFO_PROTOCOL *This,\r | |
3098 | IN OUT VOID *IdentifyData,\r | |
3099 | IN OUT UINT32 *IdentifyDataSize\r | |
3100 | )\r | |
3101 | {\r | |
3102 | EFI_STATUS Status;\r | |
3103 | SCSI_DISK_DEV *ScsiDiskDevice;\r | |
3104 | \r | |
3105 | if (CompareGuid (&This->Interface, &gEfiDiskInfoScsiInterfaceGuid)) {\r | |
3106 | //\r | |
3107 | // Physical SCSI bus does not support this data class. \r | |
3108 | //\r | |
3109 | return EFI_NOT_FOUND;\r | |
3110 | }\r | |
3111 | \r | |
3112 | ScsiDiskDevice = SCSI_DISK_DEV_FROM_DISKINFO (This);\r | |
3113 | \r | |
3114 | Status = EFI_BUFFER_TOO_SMALL;\r | |
3115 | if (*IdentifyDataSize >= sizeof (ScsiDiskDevice->IdentifyData)) {\r | |
3116 | Status = EFI_SUCCESS;\r | |
3117 | CopyMem (IdentifyData, &ScsiDiskDevice->IdentifyData, sizeof (ScsiDiskDevice->IdentifyData));\r | |
3118 | }\r | |
3119 | *IdentifyDataSize = sizeof (ScsiDiskDevice->IdentifyData);\r | |
3120 | return Status;\r | |
3121 | }\r | |
3122 | \r | |
3123 | /**\r | |
3124 | Provides sense data information for the controller type.\r | |
3125 | \r | |
3126 | This function is used by the IDE bus driver to get sense data. \r | |
3127 | Data format of Sense data is defined by the Interface GUID.\r | |
3128 | \r | |
4140a663 | 3129 | @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r |
3130 | @param[in, out] SenseData Pointer to the SenseData.\r | |
3131 | @param[in, out] SenseDataSize Size of SenseData in bytes.\r | |
3132 | @param[out] SenseDataNumber Pointer to the value for the sense data size.\r | |
d716651f | 3133 | \r |
3134 | @retval EFI_SUCCESS The command was accepted without any errors.\r | |
3135 | @retval EFI_NOT_FOUND Device does not support this data class.\r | |
3136 | @retval EFI_DEVICE_ERROR Error reading SenseData from device.\r | |
3137 | @retval EFI_BUFFER_TOO_SMALL SenseDataSize not big enough.\r | |
3138 | \r | |
3139 | **/\r | |
3140 | EFI_STATUS\r | |
3141 | EFIAPI\r | |
3142 | ScsiDiskInfoSenseData (\r | |
3143 | IN EFI_DISK_INFO_PROTOCOL *This,\r | |
3144 | IN OUT VOID *SenseData,\r | |
3145 | IN OUT UINT32 *SenseDataSize,\r | |
3146 | OUT UINT8 *SenseDataNumber\r | |
3147 | )\r | |
3148 | {\r | |
3149 | return EFI_NOT_FOUND;\r | |
3150 | }\r | |
3151 | \r | |
3152 | \r | |
3153 | /**\r | |
3154 | This function is used by the IDE bus driver to get controller information.\r | |
3155 | \r | |
3156 | @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance. \r | |
3157 | @param[out] IdeChannel Pointer to the Ide Channel number. Primary or secondary.\r | |
3158 | @param[out] IdeDevice Pointer to the Ide Device number. Master or slave.\r | |
3159 | \r | |
3160 | @retval EFI_SUCCESS IdeChannel and IdeDevice are valid.\r | |
3161 | @retval EFI_UNSUPPORTED This is not an IDE device.\r | |
3162 | \r | |
3163 | **/\r | |
3164 | EFI_STATUS\r | |
3165 | EFIAPI\r | |
3166 | ScsiDiskInfoWhichIde (\r | |
3167 | IN EFI_DISK_INFO_PROTOCOL *This,\r | |
3168 | OUT UINT32 *IdeChannel,\r | |
3169 | OUT UINT32 *IdeDevice\r | |
3170 | )\r | |
3171 | {\r | |
3172 | SCSI_DISK_DEV *ScsiDiskDevice;\r | |
3173 | \r | |
3174 | if (CompareGuid (&This->Interface, &gEfiDiskInfoScsiInterfaceGuid)) {\r | |
3175 | //\r | |
3176 | // This is not an IDE physical device.\r | |
3177 | //\r | |
3178 | return EFI_UNSUPPORTED;\r | |
3179 | }\r | |
3180 | \r | |
3181 | ScsiDiskDevice = SCSI_DISK_DEV_FROM_DISKINFO (This);\r | |
3182 | *IdeChannel = ScsiDiskDevice->Channel;\r | |
3183 | *IdeDevice = ScsiDiskDevice->Device;\r | |
3184 | \r | |
3185 | return EFI_SUCCESS;\r | |
3186 | }\r | |
3187 | \r | |
3188 | \r | |
3189 | /**\r | |
3190 | Issues ATA IDENTIFY DEVICE command to identify ATAPI device.\r | |
3191 | \r | |
3192 | This function tries to fill 512-byte ATAPI_IDENTIFY_DATA for ATAPI device to\r | |
3193 | implement Identify() interface for DiskInfo protocol. The ATA command is sent\r | |
3194 | via SCSI Request Packet.\r | |
3195 | \r | |
3196 | @param ScsiDiskDevice The pointer of SCSI_DISK_DEV\r | |
3197 | \r | |
3198 | @retval EFI_SUCCESS The ATAPI device identify data were retrieved successfully.\r | |
3199 | @retval others Some error occurred during the identification that ATAPI device.\r | |
3200 | \r | |
3201 | **/ \r | |
3202 | EFI_STATUS\r | |
3203 | AtapiIdentifyDevice (\r | |
3204 | IN OUT SCSI_DISK_DEV *ScsiDiskDevice\r | |
3205 | )\r | |
3206 | {\r | |
3207 | EFI_SCSI_IO_SCSI_REQUEST_PACKET CommandPacket;\r | |
3208 | UINT8 Cdb[6];\r | |
3209 | \r | |
3210 | //\r | |
3211 | // Initialize SCSI REQUEST_PACKET and 6-byte Cdb\r | |
3212 | //\r | |
3213 | ZeroMem (&CommandPacket, sizeof (CommandPacket));\r | |
3214 | ZeroMem (Cdb, sizeof (Cdb));\r | |
3215 | \r | |
3216 | Cdb[0] = ATA_CMD_IDENTIFY_DEVICE;\r | |
3cc033c5 | 3217 | CommandPacket.Timeout = SCSI_DISK_TIMEOUT;\r |
d716651f | 3218 | CommandPacket.Cdb = Cdb;\r |
c9325700 | 3219 | CommandPacket.CdbLength = (UINT8) sizeof (Cdb);\r |
d716651f | 3220 | CommandPacket.InDataBuffer = &ScsiDiskDevice->IdentifyData;\r |
3221 | CommandPacket.InTransferLength = sizeof (ScsiDiskDevice->IdentifyData);\r | |
3222 | \r | |
3223 | return ScsiDiskDevice->ScsiIo->ExecuteScsiCommand (ScsiDiskDevice->ScsiIo, &CommandPacket, NULL);\r | |
3224 | }\r | |
3225 | \r | |
3226 | \r | |
3227 | /**\r | |
3228 | Initialize the installation of DiskInfo protocol.\r | |
3229 | \r | |
3230 | This function prepares for the installation of DiskInfo protocol on the child handle.\r | |
3231 | By default, it installs DiskInfo protocol with SCSI interface GUID. If it further\r | |
3232 | detects that the physical device is an ATAPI/AHCI device, it then updates interface GUID\r | |
3233 | to be IDE/AHCI interface GUID.\r | |
3234 | \r | |
3235 | @param ScsiDiskDevice The pointer of SCSI_DISK_DEV.\r | |
3236 | @param ChildHandle Child handle to install DiskInfo protocol.\r | |
3237 | \r | |
3238 | **/ \r | |
3239 | VOID\r | |
3240 | InitializeInstallDiskInfo (\r | |
3241 | IN SCSI_DISK_DEV *ScsiDiskDevice,\r | |
3242 | IN EFI_HANDLE ChildHandle\r | |
3243 | )\r | |
3244 | {\r | |
3245 | EFI_STATUS Status;\r | |
3246 | EFI_DEVICE_PATH_PROTOCOL *DevicePathNode;\r | |
3247 | EFI_DEVICE_PATH_PROTOCOL *ChildDevicePathNode;\r | |
3248 | ATAPI_DEVICE_PATH *AtapiDevicePath;\r | |
3249 | SATA_DEVICE_PATH *SataDevicePath;\r | |
3250 | UINTN IdentifyRetry;\r | |
3251 | \r | |
3252 | Status = gBS->HandleProtocol (ChildHandle, &gEfiDevicePathProtocolGuid, (VOID **) &DevicePathNode);\r | |
3253 | //\r | |
3254 | // Device Path protocol must be installed on the device handle. \r | |
3255 | //\r | |
3256 | ASSERT_EFI_ERROR (Status);\r | |
3257 | //\r | |
3258 | // Copy the DiskInfo protocol template.\r | |
3259 | //\r | |
3260 | CopyMem (&ScsiDiskDevice->DiskInfo, &gScsiDiskInfoProtocolTemplate, sizeof (gScsiDiskInfoProtocolTemplate));\r | |
3261 | \r | |
3262 | while (!IsDevicePathEnd (DevicePathNode)) {\r | |
3263 | ChildDevicePathNode = NextDevicePathNode (DevicePathNode);\r | |
3264 | if ((DevicePathType (DevicePathNode) == HARDWARE_DEVICE_PATH) &&\r | |
3265 | (DevicePathSubType (DevicePathNode) == HW_PCI_DP) &&\r | |
3266 | (DevicePathType (ChildDevicePathNode) == MESSAGING_DEVICE_PATH) &&\r | |
3267 | ((DevicePathSubType (ChildDevicePathNode) == MSG_ATAPI_DP) ||\r | |
3268 | (DevicePathSubType (ChildDevicePathNode) == MSG_SATA_DP))) {\r | |
3269 | \r | |
3270 | IdentifyRetry = 3;\r | |
3271 | do {\r | |
3272 | //\r | |
3273 | // Issue ATA Identify Device Command via SCSI command, which is required to publish DiskInfo protocol\r | |
3274 | // with IDE/AHCI interface GUID.\r | |
3275 | //\r | |
3276 | Status = AtapiIdentifyDevice (ScsiDiskDevice);\r | |
3277 | if (!EFI_ERROR (Status)) {\r | |
3278 | if (DevicePathSubType(ChildDevicePathNode) == MSG_ATAPI_DP) {\r | |
3279 | //\r | |
3280 | // We find the valid ATAPI device path\r | |
3281 | //\r | |
3282 | AtapiDevicePath = (ATAPI_DEVICE_PATH *) ChildDevicePathNode;\r | |
3283 | ScsiDiskDevice->Channel = AtapiDevicePath->PrimarySecondary;\r | |
3284 | ScsiDiskDevice->Device = AtapiDevicePath->SlaveMaster;\r | |
3285 | //\r | |
3286 | // Update the DiskInfo.Interface to IDE interface GUID for the physical ATAPI device. \r | |
3287 | //\r | |
3288 | CopyGuid (&ScsiDiskDevice->DiskInfo.Interface, &gEfiDiskInfoIdeInterfaceGuid);\r | |
3289 | } else {\r | |
3290 | //\r | |
3291 | // We find the valid SATA device path\r | |
3292 | //\r | |
3293 | SataDevicePath = (SATA_DEVICE_PATH *) ChildDevicePathNode;\r | |
3294 | ScsiDiskDevice->Channel = SataDevicePath->HBAPortNumber;\r | |
3295 | ScsiDiskDevice->Device = SataDevicePath->PortMultiplierPortNumber;\r | |
3296 | //\r | |
3297 | // Update the DiskInfo.Interface to AHCI interface GUID for the physical AHCI device. \r | |
3298 | //\r | |
3299 | CopyGuid (&ScsiDiskDevice->DiskInfo.Interface, &gEfiDiskInfoAhciInterfaceGuid);\r | |
3300 | }\r | |
3301 | return;\r | |
3302 | }\r | |
3303 | } while (--IdentifyRetry > 0);\r | |
3304 | }\r | |
3305 | DevicePathNode = ChildDevicePathNode;\r | |
3306 | }\r | |
3307 | \r | |
3308 | return;\r | |
3309 | }\r |