]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.c
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
MdeModulePkg ScsiDiskDxe: Add retry scheme for async SCSI I/O command
[mirror_edk2.git] / MdeModulePkg / Bus / Scsi / ScsiDiskDxe / ScsiDisk.c
1 /** @file
2 SCSI disk driver that layers on every SCSI IO protocol in the system.
3
4 Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
9
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12
13 **/
14
15
16 #include "ScsiDisk.h"
17
18 EFI_DRIVER_BINDING_PROTOCOL gScsiDiskDriverBinding = {
19 ScsiDiskDriverBindingSupported,
20 ScsiDiskDriverBindingStart,
21 ScsiDiskDriverBindingStop,
22 0xa,
23 NULL,
24 NULL
25 };
26
27 EFI_DISK_INFO_PROTOCOL gScsiDiskInfoProtocolTemplate = {
28 EFI_DISK_INFO_SCSI_INTERFACE_GUID,
29 ScsiDiskInfoInquiry,
30 ScsiDiskInfoIdentify,
31 ScsiDiskInfoSenseData,
32 ScsiDiskInfoWhichIde
33 };
34
35 /**
36 Allocates an aligned buffer for SCSI disk.
37
38 This function allocates an aligned buffer for the SCSI disk to perform
39 SCSI IO operations. The alignment requirement is from SCSI IO interface.
40
41 @param ScsiDiskDevice The SCSI disk involved for the operation.
42 @param BufferSize The request buffer size.
43
44 @return A pointer to the aligned buffer or NULL if the allocation fails.
45
46 **/
47 VOID *
48 AllocateAlignedBuffer (
49 IN SCSI_DISK_DEV *ScsiDiskDevice,
50 IN UINTN BufferSize
51 )
52 {
53 return AllocateAlignedPages (EFI_SIZE_TO_PAGES (BufferSize), ScsiDiskDevice->ScsiIo->IoAlign);
54 }
55
56 /**
57 Frees an aligned buffer for SCSI disk.
58
59 This function frees an aligned buffer for the SCSI disk to perform
60 SCSI IO operations.
61
62 @param Buffer The aligned buffer to be freed.
63 @param BufferSize The request buffer size.
64
65 **/
66 VOID
67 FreeAlignedBuffer (
68 IN VOID *Buffer,
69 IN UINTN BufferSize
70 )
71 {
72 if (Buffer != NULL) {
73 FreeAlignedPages (Buffer, EFI_SIZE_TO_PAGES (BufferSize));
74 }
75 }
76
77 /**
78 The user Entry Point for module ScsiDisk.
79
80 The user code starts with this function.
81
82 @param ImageHandle The firmware allocated handle for the EFI image.
83 @param SystemTable A pointer to the EFI System Table.
84
85 @retval EFI_SUCCESS The entry point is executed successfully.
86 @retval other Some error occurs when executing this entry point.
87
88 **/
89 EFI_STATUS
90 EFIAPI
91 InitializeScsiDisk(
92 IN EFI_HANDLE ImageHandle,
93 IN EFI_SYSTEM_TABLE *SystemTable
94 )
95 {
96 EFI_STATUS Status;
97
98 //
99 // Install driver model protocol(s).
100 //
101 Status = EfiLibInstallDriverBindingComponentName2 (
102 ImageHandle,
103 SystemTable,
104 &gScsiDiskDriverBinding,
105 ImageHandle,
106 &gScsiDiskComponentName,
107 &gScsiDiskComponentName2
108 );
109 ASSERT_EFI_ERROR (Status);
110
111
112 return Status;
113 }
114
115 /**
116 Test to see if this driver supports ControllerHandle.
117
118 This service is called by the EFI boot service ConnectController(). In order
119 to make drivers as small as possible, there are a few calling restrictions for
120 this service. ConnectController() must follow these calling restrictions.
121 If any other agent wishes to call Supported() it must also follow these
122 calling restrictions.
123
124 @param This Protocol instance pointer.
125 @param ControllerHandle Handle of device to test
126 @param RemainingDevicePath Optional parameter use to pick a specific child
127 device to start.
128
129 @retval EFI_SUCCESS This driver supports this device
130 @retval EFI_ALREADY_STARTED This driver is already running on this device
131 @retval other This driver does not support this device
132
133 **/
134 EFI_STATUS
135 EFIAPI
136 ScsiDiskDriverBindingSupported (
137 IN EFI_DRIVER_BINDING_PROTOCOL *This,
138 IN EFI_HANDLE Controller,
139 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
140 )
141 {
142 EFI_STATUS Status;
143 EFI_SCSI_IO_PROTOCOL *ScsiIo;
144 UINT8 DeviceType;
145
146 Status = gBS->OpenProtocol (
147 Controller,
148 &gEfiScsiIoProtocolGuid,
149 (VOID **) &ScsiIo,
150 This->DriverBindingHandle,
151 Controller,
152 EFI_OPEN_PROTOCOL_BY_DRIVER
153 );
154 if (EFI_ERROR (Status)) {
155 return Status;
156 }
157
158 Status = ScsiIo->GetDeviceType (ScsiIo, &DeviceType);
159 if (!EFI_ERROR (Status)) {
160 if ((DeviceType == EFI_SCSI_TYPE_DISK) || (DeviceType == EFI_SCSI_TYPE_CDROM)) {
161 Status = EFI_SUCCESS;
162 } else {
163 Status = EFI_UNSUPPORTED;
164 }
165 }
166
167 gBS->CloseProtocol (
168 Controller,
169 &gEfiScsiIoProtocolGuid,
170 This->DriverBindingHandle,
171 Controller
172 );
173 return Status;
174 }
175
176
177 /**
178 Start this driver on ControllerHandle.
179
180 This service is called by the EFI boot service ConnectController(). In order
181 to make drivers as small as possible, there are a few calling restrictions for
182 this service. ConnectController() must follow these calling restrictions. If
183 any other agent wishes to call Start() it must also follow these calling
184 restrictions.
185
186 @param This Protocol instance pointer.
187 @param ControllerHandle Handle of device to bind driver to
188 @param RemainingDevicePath Optional parameter use to pick a specific child
189 device to start.
190
191 @retval EFI_SUCCESS This driver is added to ControllerHandle
192 @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle
193 @retval other This driver does not support this device
194
195 **/
196 EFI_STATUS
197 EFIAPI
198 ScsiDiskDriverBindingStart (
199 IN EFI_DRIVER_BINDING_PROTOCOL *This,
200 IN EFI_HANDLE Controller,
201 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
202 )
203 {
204 EFI_STATUS Status;
205 EFI_SCSI_IO_PROTOCOL *ScsiIo;
206 SCSI_DISK_DEV *ScsiDiskDevice;
207 BOOLEAN Temp;
208 UINT8 Index;
209 UINT8 MaxRetry;
210 BOOLEAN NeedRetry;
211 BOOLEAN MustReadCapacity;
212
213 MustReadCapacity = TRUE;
214
215 ScsiDiskDevice = (SCSI_DISK_DEV *) AllocateZeroPool (sizeof (SCSI_DISK_DEV));
216 if (ScsiDiskDevice == NULL) {
217 return EFI_OUT_OF_RESOURCES;
218 }
219
220 Status = gBS->OpenProtocol (
221 Controller,
222 &gEfiScsiIoProtocolGuid,
223 (VOID **) &ScsiIo,
224 This->DriverBindingHandle,
225 Controller,
226 EFI_OPEN_PROTOCOL_BY_DRIVER
227 );
228 if (EFI_ERROR (Status)) {
229 FreePool (ScsiDiskDevice);
230 return Status;
231 }
232
233 ScsiDiskDevice->Signature = SCSI_DISK_DEV_SIGNATURE;
234 ScsiDiskDevice->ScsiIo = ScsiIo;
235 ScsiDiskDevice->BlkIo.Revision = EFI_BLOCK_IO_PROTOCOL_REVISION3;
236 ScsiDiskDevice->BlkIo.Media = &ScsiDiskDevice->BlkIoMedia;
237 ScsiDiskDevice->BlkIo.Media->IoAlign = ScsiIo->IoAlign;
238 ScsiDiskDevice->BlkIo.Reset = ScsiDiskReset;
239 ScsiDiskDevice->BlkIo.ReadBlocks = ScsiDiskReadBlocks;
240 ScsiDiskDevice->BlkIo.WriteBlocks = ScsiDiskWriteBlocks;
241 ScsiDiskDevice->BlkIo.FlushBlocks = ScsiDiskFlushBlocks;
242 ScsiDiskDevice->BlkIo2.Media = &ScsiDiskDevice->BlkIoMedia;
243 ScsiDiskDevice->BlkIo2.Reset = ScsiDiskResetEx;
244 ScsiDiskDevice->BlkIo2.ReadBlocksEx = ScsiDiskReadBlocksEx;
245 ScsiDiskDevice->BlkIo2.WriteBlocksEx = ScsiDiskWriteBlocksEx;
246 ScsiDiskDevice->BlkIo2.FlushBlocksEx = ScsiDiskFlushBlocksEx;
247 ScsiDiskDevice->Handle = Controller;
248 InitializeListHead (&ScsiDiskDevice->BlkIo2Queue);
249
250 ScsiIo->GetDeviceType (ScsiIo, &(ScsiDiskDevice->DeviceType));
251 switch (ScsiDiskDevice->DeviceType) {
252 case EFI_SCSI_TYPE_DISK:
253 ScsiDiskDevice->BlkIo.Media->BlockSize = 0x200;
254 MustReadCapacity = TRUE;
255 break;
256
257 case EFI_SCSI_TYPE_CDROM:
258 ScsiDiskDevice->BlkIo.Media->BlockSize = 0x800;
259 ScsiDiskDevice->BlkIo.Media->ReadOnly = TRUE;
260 MustReadCapacity = FALSE;
261 break;
262 }
263 //
264 // The Sense Data Array's initial size is 6
265 //
266 ScsiDiskDevice->SenseDataNumber = 6;
267 ScsiDiskDevice->SenseData = (EFI_SCSI_SENSE_DATA *) AllocateZeroPool (
268 sizeof (EFI_SCSI_SENSE_DATA) * ScsiDiskDevice->SenseDataNumber
269 );
270 if (ScsiDiskDevice->SenseData == NULL) {
271 gBS->CloseProtocol (
272 Controller,
273 &gEfiScsiIoProtocolGuid,
274 This->DriverBindingHandle,
275 Controller
276 );
277 FreePool (ScsiDiskDevice);
278 return EFI_OUT_OF_RESOURCES;
279 }
280
281 //
282 // Retrieve device information
283 //
284 MaxRetry = 2;
285 for (Index = 0; Index < MaxRetry; Index++) {
286 Status = ScsiDiskInquiryDevice (ScsiDiskDevice, &NeedRetry);
287 if (!EFI_ERROR (Status)) {
288 break;
289 }
290
291 if (!NeedRetry) {
292 FreePool (ScsiDiskDevice->SenseData);
293 gBS->CloseProtocol (
294 Controller,
295 &gEfiScsiIoProtocolGuid,
296 This->DriverBindingHandle,
297 Controller
298 );
299 FreePool (ScsiDiskDevice);
300 return EFI_DEVICE_ERROR;
301 }
302 }
303 //
304 // The second parameter "TRUE" means must
305 // retrieve media capacity
306 //
307 Status = ScsiDiskDetectMedia (ScsiDiskDevice, MustReadCapacity, &Temp);
308 if (!EFI_ERROR (Status)) {
309 //
310 // Determine if Block IO & Block IO2 should be produced on this controller
311 // handle
312 //
313 if (DetermineInstallBlockIo(Controller)) {
314 InitializeInstallDiskInfo(ScsiDiskDevice, Controller);
315 Status = gBS->InstallMultipleProtocolInterfaces (
316 &Controller,
317 &gEfiBlockIoProtocolGuid,
318 &ScsiDiskDevice->BlkIo,
319 &gEfiBlockIo2ProtocolGuid,
320 &ScsiDiskDevice->BlkIo2,
321 &gEfiDiskInfoProtocolGuid,
322 &ScsiDiskDevice->DiskInfo,
323 NULL
324 );
325 if (!EFI_ERROR(Status)) {
326 ScsiDiskDevice->ControllerNameTable = NULL;
327 AddUnicodeString2 (
328 "eng",
329 gScsiDiskComponentName.SupportedLanguages,
330 &ScsiDiskDevice->ControllerNameTable,
331 L"SCSI Disk Device",
332 TRUE
333 );
334 AddUnicodeString2 (
335 "en",
336 gScsiDiskComponentName2.SupportedLanguages,
337 &ScsiDiskDevice->ControllerNameTable,
338 L"SCSI Disk Device",
339 FALSE
340 );
341 return EFI_SUCCESS;
342 }
343 }
344 }
345
346 gBS->FreePool (ScsiDiskDevice->SenseData);
347 gBS->FreePool (ScsiDiskDevice);
348 gBS->CloseProtocol (
349 Controller,
350 &gEfiScsiIoProtocolGuid,
351 This->DriverBindingHandle,
352 Controller
353 );
354 return Status;
355
356 }
357
358
359 /**
360 Stop this driver on ControllerHandle.
361
362 This service is called by the EFI boot service DisconnectController().
363 In order to make drivers as small as possible, there are a few calling
364 restrictions for this service. DisconnectController() must follow these
365 calling restrictions. If any other agent wishes to call Stop() it must
366 also follow these calling restrictions.
367
368 @param This Protocol instance pointer.
369 @param ControllerHandle Handle of device to stop driver on
370 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
371 children is zero stop the entire bus driver.
372 @param ChildHandleBuffer List of Child Handles to Stop.
373
374 @retval EFI_SUCCESS This driver is removed ControllerHandle
375 @retval other This driver was not removed from this device
376
377 **/
378 EFI_STATUS
379 EFIAPI
380 ScsiDiskDriverBindingStop (
381 IN EFI_DRIVER_BINDING_PROTOCOL *This,
382 IN EFI_HANDLE Controller,
383 IN UINTN NumberOfChildren,
384 IN EFI_HANDLE *ChildHandleBuffer OPTIONAL
385 )
386 {
387 EFI_BLOCK_IO_PROTOCOL *BlkIo;
388 SCSI_DISK_DEV *ScsiDiskDevice;
389 EFI_STATUS Status;
390
391 Status = gBS->OpenProtocol (
392 Controller,
393 &gEfiBlockIoProtocolGuid,
394 (VOID **) &BlkIo,
395 This->DriverBindingHandle,
396 Controller,
397 EFI_OPEN_PROTOCOL_GET_PROTOCOL
398 );
399 if (EFI_ERROR (Status)) {
400 return Status;
401 }
402
403 ScsiDiskDevice = SCSI_DISK_DEV_FROM_BLKIO (BlkIo);
404
405 //
406 // Wait for the BlockIo2 requests queue to become empty
407 //
408 while (!IsListEmpty (&ScsiDiskDevice->BlkIo2Queue));
409
410 Status = gBS->UninstallMultipleProtocolInterfaces (
411 Controller,
412 &gEfiBlockIoProtocolGuid,
413 &ScsiDiskDevice->BlkIo,
414 &gEfiBlockIo2ProtocolGuid,
415 &ScsiDiskDevice->BlkIo2,
416 &gEfiDiskInfoProtocolGuid,
417 &ScsiDiskDevice->DiskInfo,
418 NULL
419 );
420 if (!EFI_ERROR (Status)) {
421 gBS->CloseProtocol (
422 Controller,
423 &gEfiScsiIoProtocolGuid,
424 This->DriverBindingHandle,
425 Controller
426 );
427
428 ReleaseScsiDiskDeviceResources (ScsiDiskDevice);
429
430 return EFI_SUCCESS;
431 }
432 //
433 // errors met
434 //
435 return Status;
436 }
437
438 /**
439 Reset SCSI Disk.
440
441
442 @param This The pointer of EFI_BLOCK_IO_PROTOCOL
443 @param ExtendedVerification The flag about if extend verificate
444
445 @retval EFI_SUCCESS The device was reset.
446 @retval EFI_DEVICE_ERROR The device is not functioning properly and could
447 not be reset.
448 @return EFI_STATUS is returned from EFI_SCSI_IO_PROTOCOL.ResetDevice().
449
450 **/
451 EFI_STATUS
452 EFIAPI
453 ScsiDiskReset (
454 IN EFI_BLOCK_IO_PROTOCOL *This,
455 IN BOOLEAN ExtendedVerification
456 )
457 {
458 EFI_TPL OldTpl;
459 SCSI_DISK_DEV *ScsiDiskDevice;
460 EFI_STATUS Status;
461
462 OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
463
464 ScsiDiskDevice = SCSI_DISK_DEV_FROM_BLKIO (This);
465
466 Status = ScsiDiskDevice->ScsiIo->ResetDevice (ScsiDiskDevice->ScsiIo);
467
468 if (EFI_ERROR (Status)) {
469 Status = EFI_DEVICE_ERROR;
470 goto Done;
471 }
472
473 if (!ExtendedVerification) {
474 goto Done;
475 }
476
477 Status = ScsiDiskDevice->ScsiIo->ResetBus (ScsiDiskDevice->ScsiIo);
478
479 if (EFI_ERROR (Status)) {
480 Status = EFI_DEVICE_ERROR;
481 goto Done;
482 }
483
484 Done:
485 gBS->RestoreTPL (OldTpl);
486 return Status;
487 }
488
489 /**
490 The function is to Read Block from SCSI Disk.
491
492 @param This The pointer of EFI_BLOCK_IO_PROTOCOL.
493 @param MediaId The Id of Media detected
494 @param Lba The logic block address
495 @param BufferSize The size of Buffer
496 @param Buffer The buffer to fill the read out data
497
498 @retval EFI_SUCCESS Successfully to read out block.
499 @retval EFI_DEVICE_ERROR Fail to detect media.
500 @retval EFI_NO_MEDIA Media is not present.
501 @retval EFI_MEDIA_CHANGED Media has changed.
502 @retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device.
503 @retval EFI_INVALID_PARAMETER Invalid parameter passed in.
504
505 **/
506 EFI_STATUS
507 EFIAPI
508 ScsiDiskReadBlocks (
509 IN EFI_BLOCK_IO_PROTOCOL *This,
510 IN UINT32 MediaId,
511 IN EFI_LBA Lba,
512 IN UINTN BufferSize,
513 OUT VOID *Buffer
514 )
515 {
516 SCSI_DISK_DEV *ScsiDiskDevice;
517 EFI_BLOCK_IO_MEDIA *Media;
518 EFI_STATUS Status;
519 UINTN BlockSize;
520 UINTN NumberOfBlocks;
521 BOOLEAN MediaChange;
522 EFI_TPL OldTpl;
523
524 MediaChange = FALSE;
525 OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
526 ScsiDiskDevice = SCSI_DISK_DEV_FROM_BLKIO (This);
527
528 if (!IS_DEVICE_FIXED(ScsiDiskDevice)) {
529
530 Status = ScsiDiskDetectMedia (ScsiDiskDevice, FALSE, &MediaChange);
531 if (EFI_ERROR (Status)) {
532 Status = EFI_DEVICE_ERROR;
533 goto Done;
534 }
535
536 if (MediaChange) {
537 gBS->ReinstallProtocolInterface (
538 ScsiDiskDevice->Handle,
539 &gEfiBlockIoProtocolGuid,
540 &ScsiDiskDevice->BlkIo,
541 &ScsiDiskDevice->BlkIo
542 );
543 gBS->ReinstallProtocolInterface (
544 ScsiDiskDevice->Handle,
545 &gEfiBlockIo2ProtocolGuid,
546 &ScsiDiskDevice->BlkIo2,
547 &ScsiDiskDevice->BlkIo2
548 );
549 Status = EFI_MEDIA_CHANGED;
550 goto Done;
551 }
552 }
553 //
554 // Get the intrinsic block size
555 //
556 Media = ScsiDiskDevice->BlkIo.Media;
557 BlockSize = Media->BlockSize;
558
559 NumberOfBlocks = BufferSize / BlockSize;
560
561 if (!(Media->MediaPresent)) {
562 Status = EFI_NO_MEDIA;
563 goto Done;
564 }
565
566 if (MediaId != Media->MediaId) {
567 Status = EFI_MEDIA_CHANGED;
568 goto Done;
569 }
570
571 if (Buffer == NULL) {
572 Status = EFI_INVALID_PARAMETER;
573 goto Done;
574 }
575
576 if (BufferSize == 0) {
577 Status = EFI_SUCCESS;
578 goto Done;
579 }
580
581 if (BufferSize % BlockSize != 0) {
582 Status = EFI_BAD_BUFFER_SIZE;
583 goto Done;
584 }
585
586 if (Lba > Media->LastBlock) {
587 Status = EFI_INVALID_PARAMETER;
588 goto Done;
589 }
590
591 if ((Lba + NumberOfBlocks - 1) > Media->LastBlock) {
592 Status = EFI_INVALID_PARAMETER;
593 goto Done;
594 }
595
596 if ((Media->IoAlign > 1) && (((UINTN) Buffer & (Media->IoAlign - 1)) != 0)) {
597 Status = EFI_INVALID_PARAMETER;
598 goto Done;
599 }
600
601 //
602 // If all the parameters are valid, then perform read sectors command
603 // to transfer data from device to host.
604 //
605 Status = ScsiDiskReadSectors (ScsiDiskDevice, Buffer, Lba, NumberOfBlocks);
606
607 Done:
608 gBS->RestoreTPL (OldTpl);
609 return Status;
610 }
611
612 /**
613 The function is to Write Block to SCSI Disk.
614
615 @param This The pointer of EFI_BLOCK_IO_PROTOCOL
616 @param MediaId The Id of Media detected
617 @param Lba The logic block address
618 @param BufferSize The size of Buffer
619 @param Buffer The buffer to fill the read out data
620
621 @retval EFI_SUCCESS Successfully to read out block.
622 @retval EFI_WRITE_PROTECTED The device can not be written to.
623 @retval EFI_DEVICE_ERROR Fail to detect media.
624 @retval EFI_NO_MEDIA Media is not present.
625 @retval EFI_MEDIA_CHNAGED Media has changed.
626 @retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device.
627 @retval EFI_INVALID_PARAMETER Invalid parameter passed in.
628
629 **/
630 EFI_STATUS
631 EFIAPI
632 ScsiDiskWriteBlocks (
633 IN EFI_BLOCK_IO_PROTOCOL *This,
634 IN UINT32 MediaId,
635 IN EFI_LBA Lba,
636 IN UINTN BufferSize,
637 IN VOID *Buffer
638 )
639 {
640 SCSI_DISK_DEV *ScsiDiskDevice;
641 EFI_BLOCK_IO_MEDIA *Media;
642 EFI_STATUS Status;
643 UINTN BlockSize;
644 UINTN NumberOfBlocks;
645 BOOLEAN MediaChange;
646 EFI_TPL OldTpl;
647
648 MediaChange = FALSE;
649 OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
650 ScsiDiskDevice = SCSI_DISK_DEV_FROM_BLKIO (This);
651
652 if (!IS_DEVICE_FIXED(ScsiDiskDevice)) {
653
654 Status = ScsiDiskDetectMedia (ScsiDiskDevice, FALSE, &MediaChange);
655 if (EFI_ERROR (Status)) {
656 Status = EFI_DEVICE_ERROR;
657 goto Done;
658 }
659
660 if (MediaChange) {
661 gBS->ReinstallProtocolInterface (
662 ScsiDiskDevice->Handle,
663 &gEfiBlockIoProtocolGuid,
664 &ScsiDiskDevice->BlkIo,
665 &ScsiDiskDevice->BlkIo
666 );
667 gBS->ReinstallProtocolInterface (
668 ScsiDiskDevice->Handle,
669 &gEfiBlockIo2ProtocolGuid,
670 &ScsiDiskDevice->BlkIo2,
671 &ScsiDiskDevice->BlkIo2
672 );
673 Status = EFI_MEDIA_CHANGED;
674 goto Done;
675 }
676 }
677 //
678 // Get the intrinsic block size
679 //
680 Media = ScsiDiskDevice->BlkIo.Media;
681 BlockSize = Media->BlockSize;
682
683 NumberOfBlocks = BufferSize / BlockSize;
684
685 if (!(Media->MediaPresent)) {
686 Status = EFI_NO_MEDIA;
687 goto Done;
688 }
689
690 if (MediaId != Media->MediaId) {
691 Status = EFI_MEDIA_CHANGED;
692 goto Done;
693 }
694
695 if (Media->ReadOnly) {
696 Status = EFI_WRITE_PROTECTED;
697 goto Done;
698 }
699
700 if (BufferSize == 0) {
701 Status = EFI_SUCCESS;
702 goto Done;
703 }
704
705 if (Buffer == NULL) {
706 Status = EFI_INVALID_PARAMETER;
707 goto Done;
708 }
709
710 if (BufferSize % BlockSize != 0) {
711 Status = EFI_BAD_BUFFER_SIZE;
712 goto Done;
713 }
714
715 if (Lba > Media->LastBlock) {
716 Status = EFI_INVALID_PARAMETER;
717 goto Done;
718 }
719
720 if ((Lba + NumberOfBlocks - 1) > Media->LastBlock) {
721 Status = EFI_INVALID_PARAMETER;
722 goto Done;
723 }
724
725 if ((Media->IoAlign > 1) && (((UINTN) Buffer & (Media->IoAlign - 1)) != 0)) {
726 Status = EFI_INVALID_PARAMETER;
727 goto Done;
728 }
729 //
730 // if all the parameters are valid, then perform read sectors command
731 // to transfer data from device to host.
732 //
733 Status = ScsiDiskWriteSectors (ScsiDiskDevice, Buffer, Lba, NumberOfBlocks);
734
735 Done:
736 gBS->RestoreTPL (OldTpl);
737 return Status;
738 }
739
740 /**
741 Flush Block to Disk.
742
743 EFI_SUCCESS is returned directly.
744
745 @param This The pointer of EFI_BLOCK_IO_PROTOCOL
746
747 @retval EFI_SUCCESS All outstanding data was written to the device
748
749 **/
750 EFI_STATUS
751 EFIAPI
752 ScsiDiskFlushBlocks (
753 IN EFI_BLOCK_IO_PROTOCOL *This
754 )
755 {
756 //
757 // return directly
758 //
759 return EFI_SUCCESS;
760 }
761
762
763 /**
764 Reset SCSI Disk.
765
766 @param This The pointer of EFI_BLOCK_IO2_PROTOCOL.
767 @param ExtendedVerification The flag about if extend verificate.
768
769 @retval EFI_SUCCESS The device was reset.
770 @retval EFI_DEVICE_ERROR The device is not functioning properly and could
771 not be reset.
772 @return EFI_STATUS is returned from EFI_SCSI_IO_PROTOCOL.ResetDevice().
773
774 **/
775 EFI_STATUS
776 EFIAPI
777 ScsiDiskResetEx (
778 IN EFI_BLOCK_IO2_PROTOCOL *This,
779 IN BOOLEAN ExtendedVerification
780 )
781 {
782 EFI_TPL OldTpl;
783 SCSI_DISK_DEV *ScsiDiskDevice;
784 EFI_STATUS Status;
785
786 OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
787
788 ScsiDiskDevice = SCSI_DISK_DEV_FROM_BLKIO2 (This);
789
790 Status = ScsiDiskDevice->ScsiIo->ResetDevice (ScsiDiskDevice->ScsiIo);
791
792 if (EFI_ERROR (Status)) {
793 Status = EFI_DEVICE_ERROR;
794 goto Done;
795 }
796
797 if (!ExtendedVerification) {
798 goto Done;
799 }
800
801 Status = ScsiDiskDevice->ScsiIo->ResetBus (ScsiDiskDevice->ScsiIo);
802
803 if (EFI_ERROR (Status)) {
804 Status = EFI_DEVICE_ERROR;
805 goto Done;
806 }
807
808 Done:
809 gBS->RestoreTPL (OldTpl);
810 return Status;
811 }
812
813 /**
814 The function is to Read Block from SCSI Disk.
815
816 @param This The pointer of EFI_BLOCK_IO_PROTOCOL.
817 @param MediaId The Id of Media detected.
818 @param Lba The logic block address.
819 @param Token A pointer to the token associated with the transaction.
820 @param BufferSize The size of Buffer.
821 @param Buffer The buffer to fill the read out data.
822
823 @retval EFI_SUCCESS The read request was queued if Token-> Event is
824 not NULL. The data was read correctly from the
825 device if theToken-> Event is NULL.
826 @retval EFI_DEVICE_ERROR The device reported an error while attempting
827 to perform the read operation.
828 @retval EFI_NO_MEDIA There is no media in the device.
829 @retval EFI_MEDIA_CHANGED The MediaId is not for the current media.
830 @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of
831 the intrinsic block size of the device.
832 @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not
833 valid, or the buffer is not on proper
834 alignment.
835 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a
836 lack of resources.
837
838 **/
839 EFI_STATUS
840 EFIAPI
841 ScsiDiskReadBlocksEx (
842 IN EFI_BLOCK_IO2_PROTOCOL *This,
843 IN UINT32 MediaId,
844 IN EFI_LBA Lba,
845 IN OUT EFI_BLOCK_IO2_TOKEN *Token,
846 IN UINTN BufferSize,
847 OUT VOID *Buffer
848 )
849 {
850 SCSI_DISK_DEV *ScsiDiskDevice;
851 EFI_BLOCK_IO_MEDIA *Media;
852 EFI_STATUS Status;
853 UINTN BlockSize;
854 UINTN NumberOfBlocks;
855 BOOLEAN MediaChange;
856 EFI_TPL OldTpl;
857
858 MediaChange = FALSE;
859 OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
860 ScsiDiskDevice = SCSI_DISK_DEV_FROM_BLKIO2 (This);
861
862 if (!IS_DEVICE_FIXED(ScsiDiskDevice)) {
863
864 Status = ScsiDiskDetectMedia (ScsiDiskDevice, FALSE, &MediaChange);
865 if (EFI_ERROR (Status)) {
866 Status = EFI_DEVICE_ERROR;
867 goto Done;
868 }
869
870 if (MediaChange) {
871 gBS->ReinstallProtocolInterface (
872 ScsiDiskDevice->Handle,
873 &gEfiBlockIoProtocolGuid,
874 &ScsiDiskDevice->BlkIo,
875 &ScsiDiskDevice->BlkIo
876 );
877 gBS->ReinstallProtocolInterface (
878 ScsiDiskDevice->Handle,
879 &gEfiBlockIo2ProtocolGuid,
880 &ScsiDiskDevice->BlkIo2,
881 &ScsiDiskDevice->BlkIo2
882 );
883 Status = EFI_MEDIA_CHANGED;
884 goto Done;
885 }
886 }
887 //
888 // Get the intrinsic block size
889 //
890 Media = ScsiDiskDevice->BlkIo2.Media;
891 BlockSize = Media->BlockSize;
892
893 NumberOfBlocks = BufferSize / BlockSize;
894
895 if (!(Media->MediaPresent)) {
896 Status = EFI_NO_MEDIA;
897 goto Done;
898 }
899
900 if (MediaId != Media->MediaId) {
901 Status = EFI_MEDIA_CHANGED;
902 goto Done;
903 }
904
905 if (Buffer == NULL) {
906 Status = EFI_INVALID_PARAMETER;
907 goto Done;
908 }
909
910 if (BufferSize == 0) {
911 if ((Token != NULL) && (Token->Event != NULL)) {
912 Token->TransactionStatus = EFI_SUCCESS;
913 gBS->SignalEvent (Token->Event);
914 }
915
916 Status = EFI_SUCCESS;
917 goto Done;
918 }
919
920 if (BufferSize % BlockSize != 0) {
921 Status = EFI_BAD_BUFFER_SIZE;
922 goto Done;
923 }
924
925 if (Lba > Media->LastBlock) {
926 Status = EFI_INVALID_PARAMETER;
927 goto Done;
928 }
929
930 if ((Lba + NumberOfBlocks - 1) > Media->LastBlock) {
931 Status = EFI_INVALID_PARAMETER;
932 goto Done;
933 }
934
935 if ((Media->IoAlign > 1) && (((UINTN) Buffer & (Media->IoAlign - 1)) != 0)) {
936 Status = EFI_INVALID_PARAMETER;
937 goto Done;
938 }
939
940 //
941 // If all the parameters are valid, then perform read sectors command
942 // to transfer data from device to host.
943 //
944 if ((Token != NULL) && (Token->Event != NULL)) {
945 Token->TransactionStatus = EFI_SUCCESS;
946 Status = ScsiDiskAsyncReadSectors (
947 ScsiDiskDevice,
948 Buffer,
949 Lba,
950 NumberOfBlocks,
951 Token
952 );
953 } else {
954 Status = ScsiDiskReadSectors (
955 ScsiDiskDevice,
956 Buffer,
957 Lba,
958 NumberOfBlocks
959 );
960 }
961
962 Done:
963 gBS->RestoreTPL (OldTpl);
964 return Status;
965 }
966
967 /**
968 The function is to Write Block to SCSI Disk.
969
970 @param This The pointer of EFI_BLOCK_IO_PROTOCOL.
971 @param MediaId The Id of Media detected.
972 @param Lba The logic block address.
973 @param Token A pointer to the token associated with the transaction.
974 @param BufferSize The size of Buffer.
975 @param Buffer The buffer to fill the read out data.
976
977 @retval EFI_SUCCESS The data were written correctly to the device.
978 @retval EFI_WRITE_PROTECTED The device cannot be written to.
979 @retval EFI_NO_MEDIA There is no media in the device.
980 @retval EFI_MEDIA_CHANGED The MediaId is not for the current media.
981 @retval EFI_DEVICE_ERROR The device reported an error while attempting
982 to perform the write operation.
983 @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of
984 the intrinsic block size of the device.
985 @retval EFI_INVALID_PARAMETER The write request contains LBAs that are not
986 valid, or the buffer is not on proper
987 alignment.
988
989 **/
990 EFI_STATUS
991 EFIAPI
992 ScsiDiskWriteBlocksEx (
993 IN EFI_BLOCK_IO2_PROTOCOL *This,
994 IN UINT32 MediaId,
995 IN EFI_LBA Lba,
996 IN OUT EFI_BLOCK_IO2_TOKEN *Token,
997 IN UINTN BufferSize,
998 IN VOID *Buffer
999 )
1000 {
1001 SCSI_DISK_DEV *ScsiDiskDevice;
1002 EFI_BLOCK_IO_MEDIA *Media;
1003 EFI_STATUS Status;
1004 UINTN BlockSize;
1005 UINTN NumberOfBlocks;
1006 BOOLEAN MediaChange;
1007 EFI_TPL OldTpl;
1008
1009 MediaChange = FALSE;
1010 OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
1011 ScsiDiskDevice = SCSI_DISK_DEV_FROM_BLKIO2 (This);
1012
1013 if (!IS_DEVICE_FIXED(ScsiDiskDevice)) {
1014
1015 Status = ScsiDiskDetectMedia (ScsiDiskDevice, FALSE, &MediaChange);
1016 if (EFI_ERROR (Status)) {
1017 Status = EFI_DEVICE_ERROR;
1018 goto Done;
1019 }
1020
1021 if (MediaChange) {
1022 gBS->ReinstallProtocolInterface (
1023 ScsiDiskDevice->Handle,
1024 &gEfiBlockIoProtocolGuid,
1025 &ScsiDiskDevice->BlkIo,
1026 &ScsiDiskDevice->BlkIo
1027 );
1028 gBS->ReinstallProtocolInterface (
1029 ScsiDiskDevice->Handle,
1030 &gEfiBlockIo2ProtocolGuid,
1031 &ScsiDiskDevice->BlkIo2,
1032 &ScsiDiskDevice->BlkIo2
1033 );
1034 Status = EFI_MEDIA_CHANGED;
1035 goto Done;
1036 }
1037 }
1038 //
1039 // Get the intrinsic block size
1040 //
1041 Media = ScsiDiskDevice->BlkIo2.Media;
1042 BlockSize = Media->BlockSize;
1043
1044 NumberOfBlocks = BufferSize / BlockSize;
1045
1046 if (!(Media->MediaPresent)) {
1047 Status = EFI_NO_MEDIA;
1048 goto Done;
1049 }
1050
1051 if (MediaId != Media->MediaId) {
1052 Status = EFI_MEDIA_CHANGED;
1053 goto Done;
1054 }
1055
1056 if (Media->ReadOnly) {
1057 Status = EFI_WRITE_PROTECTED;
1058 goto Done;
1059 }
1060
1061 if (BufferSize == 0) {
1062 if ((Token != NULL) && (Token->Event != NULL)) {
1063 Token->TransactionStatus = EFI_SUCCESS;
1064 gBS->SignalEvent (Token->Event);
1065 }
1066
1067 Status = EFI_SUCCESS;
1068 goto Done;
1069 }
1070
1071 if (Buffer == NULL) {
1072 Status = EFI_INVALID_PARAMETER;
1073 goto Done;
1074 }
1075
1076 if (BufferSize % BlockSize != 0) {
1077 Status = EFI_BAD_BUFFER_SIZE;
1078 goto Done;
1079 }
1080
1081 if (Lba > Media->LastBlock) {
1082 Status = EFI_INVALID_PARAMETER;
1083 goto Done;
1084 }
1085
1086 if ((Lba + NumberOfBlocks - 1) > Media->LastBlock) {
1087 Status = EFI_INVALID_PARAMETER;
1088 goto Done;
1089 }
1090
1091 if ((Media->IoAlign > 1) && (((UINTN) Buffer & (Media->IoAlign - 1)) != 0)) {
1092 Status = EFI_INVALID_PARAMETER;
1093 goto Done;
1094 }
1095
1096 //
1097 // if all the parameters are valid, then perform write sectors command
1098 // to transfer data from device to host.
1099 //
1100 if ((Token != NULL) && (Token->Event != NULL)) {
1101 Token->TransactionStatus = EFI_SUCCESS;
1102 Status = ScsiDiskAsyncWriteSectors (
1103 ScsiDiskDevice,
1104 Buffer,
1105 Lba,
1106 NumberOfBlocks,
1107 Token
1108 );
1109 } else {
1110 Status = ScsiDiskWriteSectors (
1111 ScsiDiskDevice,
1112 Buffer,
1113 Lba,
1114 NumberOfBlocks
1115 );
1116 }
1117
1118 Done:
1119 gBS->RestoreTPL (OldTpl);
1120 return Status;
1121 }
1122
1123 /**
1124 Flush the Block Device.
1125
1126 @param This Indicates a pointer to the calling context.
1127 @param Token A pointer to the token associated with the transaction.
1128
1129 @retval EFI_SUCCESS All outstanding data was written to the device.
1130 @retval EFI_DEVICE_ERROR The device reported an error while attempting to
1131 write data.
1132 @retval EFI_WRITE_PROTECTED The device cannot be written to.
1133 @retval EFI_NO_MEDIA There is no media in the device.
1134 @retval EFI_MEDIA_CHANGED The MediaId is not for the current media.
1135
1136 **/
1137 EFI_STATUS
1138 EFIAPI
1139 ScsiDiskFlushBlocksEx (
1140 IN EFI_BLOCK_IO2_PROTOCOL *This,
1141 IN OUT EFI_BLOCK_IO2_TOKEN *Token
1142 )
1143 {
1144 SCSI_DISK_DEV *ScsiDiskDevice;
1145 EFI_BLOCK_IO_MEDIA *Media;
1146 EFI_STATUS Status;
1147 BOOLEAN MediaChange;
1148 EFI_TPL OldTpl;
1149
1150 MediaChange = FALSE;
1151 OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
1152 ScsiDiskDevice = SCSI_DISK_DEV_FROM_BLKIO2 (This);
1153
1154 if (!IS_DEVICE_FIXED(ScsiDiskDevice)) {
1155
1156 Status = ScsiDiskDetectMedia (ScsiDiskDevice, FALSE, &MediaChange);
1157 if (EFI_ERROR (Status)) {
1158 Status = EFI_DEVICE_ERROR;
1159 goto Done;
1160 }
1161
1162 if (MediaChange) {
1163 gBS->ReinstallProtocolInterface (
1164 ScsiDiskDevice->Handle,
1165 &gEfiBlockIoProtocolGuid,
1166 &ScsiDiskDevice->BlkIo,
1167 &ScsiDiskDevice->BlkIo
1168 );
1169 gBS->ReinstallProtocolInterface (
1170 ScsiDiskDevice->Handle,
1171 &gEfiBlockIo2ProtocolGuid,
1172 &ScsiDiskDevice->BlkIo2,
1173 &ScsiDiskDevice->BlkIo2
1174 );
1175 Status = EFI_MEDIA_CHANGED;
1176 goto Done;
1177 }
1178 }
1179
1180 Media = ScsiDiskDevice->BlkIo2.Media;
1181
1182 if (!(Media->MediaPresent)) {
1183 Status = EFI_NO_MEDIA;
1184 goto Done;
1185 }
1186
1187 if (Media->ReadOnly) {
1188 Status = EFI_WRITE_PROTECTED;
1189 goto Done;
1190 }
1191
1192 //
1193 // Wait for the BlockIo2 requests queue to become empty
1194 //
1195 while (!IsListEmpty (&ScsiDiskDevice->BlkIo2Queue));
1196
1197 Status = EFI_SUCCESS;
1198
1199 //
1200 // Signal caller event
1201 //
1202 if ((Token != NULL) && (Token->Event != NULL)) {
1203 Token->TransactionStatus = EFI_SUCCESS;
1204 gBS->SignalEvent (Token->Event);
1205 }
1206
1207 Done:
1208 gBS->RestoreTPL (OldTpl);
1209 return Status;
1210 }
1211
1212
1213 /**
1214 Detect Device and read out capacity ,if error occurs, parse the sense key.
1215
1216 @param ScsiDiskDevice The pointer of SCSI_DISK_DEV
1217 @param MustReadCapacity The flag about reading device capacity
1218 @param MediaChange The pointer of flag indicates if media has changed
1219
1220 @retval EFI_DEVICE_ERROR Indicates that error occurs
1221 @retval EFI_SUCCESS Successfully to detect media
1222
1223 **/
1224 EFI_STATUS
1225 ScsiDiskDetectMedia (
1226 IN SCSI_DISK_DEV *ScsiDiskDevice,
1227 IN BOOLEAN MustReadCapacity,
1228 OUT BOOLEAN *MediaChange
1229 )
1230 {
1231 EFI_STATUS Status;
1232 EFI_SCSI_SENSE_DATA *SenseData;
1233 UINTN NumberOfSenseKeys;
1234 BOOLEAN NeedRetry;
1235 BOOLEAN NeedReadCapacity;
1236 UINT8 Retry;
1237 UINT8 MaxRetry;
1238 EFI_BLOCK_IO_MEDIA OldMedia;
1239 UINTN Action;
1240 EFI_EVENT TimeoutEvt;
1241
1242 Status = EFI_SUCCESS;
1243 SenseData = NULL;
1244 NumberOfSenseKeys = 0;
1245 Retry = 0;
1246 MaxRetry = 3;
1247 Action = ACTION_NO_ACTION;
1248 NeedReadCapacity = FALSE;
1249 *MediaChange = FALSE;
1250 TimeoutEvt = NULL;
1251
1252 CopyMem (&OldMedia, ScsiDiskDevice->BlkIo.Media, sizeof (OldMedia));
1253
1254 Status = gBS->CreateEvent (
1255 EVT_TIMER,
1256 TPL_CALLBACK,
1257 NULL,
1258 NULL,
1259 &TimeoutEvt
1260 );
1261 if (EFI_ERROR (Status)) {
1262 return Status;
1263 }
1264
1265 Status = gBS->SetTimer (TimeoutEvt, TimerRelative, EFI_TIMER_PERIOD_SECONDS(120));
1266 if (EFI_ERROR (Status)) {
1267 goto EXIT;
1268 }
1269
1270 //
1271 // Sending Test_Unit cmd to poll device status.
1272 // If the sense data shows the drive is not ready or reset before, we need poll the device status again.
1273 // We limit the upper boundary to 120 seconds.
1274 //
1275 while (EFI_ERROR (gBS->CheckEvent (TimeoutEvt))) {
1276 Status = ScsiDiskTestUnitReady (
1277 ScsiDiskDevice,
1278 &NeedRetry,
1279 &SenseData,
1280 &NumberOfSenseKeys
1281 );
1282 if (!EFI_ERROR (Status)) {
1283 Status = DetectMediaParsingSenseKeys (
1284 ScsiDiskDevice,
1285 SenseData,
1286 NumberOfSenseKeys,
1287 &Action
1288 );
1289 if (EFI_ERROR (Status)) {
1290 goto EXIT;
1291 } else if (Action == ACTION_RETRY_COMMAND_LATER) {
1292 continue;
1293 } else {
1294 break;
1295 }
1296 } else {
1297 Retry++;
1298 if (!NeedRetry || (Retry >= MaxRetry)) {
1299 goto EXIT;
1300 }
1301 }
1302 }
1303
1304 if (EFI_ERROR (Status)) {
1305 goto EXIT;
1306 }
1307
1308 //
1309 // ACTION_NO_ACTION: need not read capacity
1310 // other action code: need read capacity
1311 //
1312 if (Action == ACTION_READ_CAPACITY) {
1313 NeedReadCapacity = TRUE;
1314 }
1315
1316 //
1317 // either NeedReadCapacity is TRUE, or MustReadCapacity is TRUE,
1318 // retrieve capacity via Read Capacity command
1319 //
1320 if (NeedReadCapacity || MustReadCapacity) {
1321 //
1322 // retrieve media information
1323 //
1324 for (Retry = 0; Retry < MaxRetry; Retry++) {
1325 Status = ScsiDiskReadCapacity (
1326 ScsiDiskDevice,
1327 &NeedRetry,
1328 &SenseData,
1329 &NumberOfSenseKeys
1330 );
1331 if (!EFI_ERROR (Status)) {
1332 //
1333 // analyze sense key to action
1334 //
1335 Status = DetectMediaParsingSenseKeys (
1336 ScsiDiskDevice,
1337 SenseData,
1338 NumberOfSenseKeys,
1339 &Action
1340 );
1341 if (EFI_ERROR (Status)) {
1342 //
1343 // if Status is error, it may indicate crisis error,
1344 // so return without retry.
1345 //
1346 goto EXIT;
1347 } else if (Action == ACTION_RETRY_COMMAND_LATER) {
1348 Retry = 0;
1349 continue;
1350 } else {
1351 break;
1352 }
1353 } else {
1354 Retry++;
1355 if (!NeedRetry || (Retry >= MaxRetry)) {
1356 goto EXIT;
1357 }
1358 }
1359 }
1360
1361 if (EFI_ERROR (Status)) {
1362 goto EXIT;
1363 }
1364 }
1365
1366 if (ScsiDiskDevice->BlkIo.Media->MediaId != OldMedia.MediaId) {
1367 //
1368 // Media change information got from the device
1369 //
1370 *MediaChange = TRUE;
1371 }
1372
1373 if (ScsiDiskDevice->BlkIo.Media->ReadOnly != OldMedia.ReadOnly) {
1374 *MediaChange = TRUE;
1375 ScsiDiskDevice->BlkIo.Media->MediaId += 1;
1376 }
1377
1378 if (ScsiDiskDevice->BlkIo.Media->BlockSize != OldMedia.BlockSize) {
1379 *MediaChange = TRUE;
1380 ScsiDiskDevice->BlkIo.Media->MediaId += 1;
1381 }
1382
1383 if (ScsiDiskDevice->BlkIo.Media->LastBlock != OldMedia.LastBlock) {
1384 *MediaChange = TRUE;
1385 ScsiDiskDevice->BlkIo.Media->MediaId += 1;
1386 }
1387
1388 if (ScsiDiskDevice->BlkIo.Media->MediaPresent != OldMedia.MediaPresent) {
1389 if (ScsiDiskDevice->BlkIo.Media->MediaPresent) {
1390 //
1391 // when change from no media to media present, reset the MediaId to 1.
1392 //
1393 ScsiDiskDevice->BlkIo.Media->MediaId = 1;
1394 } else {
1395 //
1396 // when no media, reset the MediaId to zero.
1397 //
1398 ScsiDiskDevice->BlkIo.Media->MediaId = 0;
1399 }
1400
1401 *MediaChange = TRUE;
1402 }
1403
1404 EXIT:
1405 if (TimeoutEvt != NULL) {
1406 gBS->CloseEvent (TimeoutEvt);
1407 }
1408 return Status;
1409 }
1410
1411
1412 /**
1413 Send out Inquiry command to Device.
1414
1415 @param ScsiDiskDevice The pointer of SCSI_DISK_DEV
1416 @param NeedRetry Indicates if needs try again when error happens
1417
1418 @retval EFI_DEVICE_ERROR Indicates that error occurs
1419 @retval EFI_SUCCESS Successfully to detect media
1420
1421 **/
1422 EFI_STATUS
1423 ScsiDiskInquiryDevice (
1424 IN OUT SCSI_DISK_DEV *ScsiDiskDevice,
1425 OUT BOOLEAN *NeedRetry
1426 )
1427 {
1428 UINT32 InquiryDataLength;
1429 UINT8 SenseDataLength;
1430 UINT8 HostAdapterStatus;
1431 UINT8 TargetStatus;
1432 EFI_SCSI_SENSE_DATA *SenseDataArray;
1433 UINTN NumberOfSenseKeys;
1434 EFI_STATUS Status;
1435 UINT8 MaxRetry;
1436 UINT8 Index;
1437 EFI_SCSI_SUPPORTED_VPD_PAGES_VPD_PAGE *SupportedVpdPages;
1438 EFI_SCSI_BLOCK_LIMITS_VPD_PAGE *BlockLimits;
1439 UINTN PageLength;
1440
1441 InquiryDataLength = sizeof (EFI_SCSI_INQUIRY_DATA);
1442 SenseDataLength = 0;
1443
1444 Status = ScsiInquiryCommand (
1445 ScsiDiskDevice->ScsiIo,
1446 SCSI_DISK_TIMEOUT,
1447 NULL,
1448 &SenseDataLength,
1449 &HostAdapterStatus,
1450 &TargetStatus,
1451 (VOID *) &(ScsiDiskDevice->InquiryData),
1452 &InquiryDataLength,
1453 FALSE
1454 );
1455 //
1456 // no need to check HostAdapterStatus and TargetStatus
1457 //
1458 if ((Status == EFI_SUCCESS) || (Status == EFI_WARN_BUFFER_TOO_SMALL)) {
1459 ParseInquiryData (ScsiDiskDevice);
1460
1461 if (ScsiDiskDevice->DeviceType == EFI_SCSI_TYPE_DISK) {
1462 //
1463 // Check whether the device supports Block Limits VPD page (0xB0)
1464 //
1465 SupportedVpdPages = AllocateAlignedBuffer (ScsiDiskDevice, sizeof (EFI_SCSI_SUPPORTED_VPD_PAGES_VPD_PAGE));
1466 if (SupportedVpdPages == NULL) {
1467 *NeedRetry = FALSE;
1468 return EFI_DEVICE_ERROR;
1469 }
1470 ZeroMem (SupportedVpdPages, sizeof (EFI_SCSI_SUPPORTED_VPD_PAGES_VPD_PAGE));
1471 InquiryDataLength = sizeof (EFI_SCSI_SUPPORTED_VPD_PAGES_VPD_PAGE);
1472 SenseDataLength = 0;
1473 Status = ScsiInquiryCommandEx (
1474 ScsiDiskDevice->ScsiIo,
1475 SCSI_DISK_TIMEOUT,
1476 NULL,
1477 &SenseDataLength,
1478 &HostAdapterStatus,
1479 &TargetStatus,
1480 (VOID *) SupportedVpdPages,
1481 &InquiryDataLength,
1482 TRUE,
1483 EFI_SCSI_PAGE_CODE_SUPPORTED_VPD
1484 );
1485 if (!EFI_ERROR (Status)) {
1486 PageLength = (SupportedVpdPages->PageLength2 << 8)
1487 | SupportedVpdPages->PageLength1;
1488 for (Index = 0; Index < PageLength; Index++) {
1489 if (SupportedVpdPages->SupportedVpdPageList[Index] == EFI_SCSI_PAGE_CODE_BLOCK_LIMITS_VPD) {
1490 break;
1491 }
1492 }
1493
1494 //
1495 // Query the Block Limits VPD page
1496 //
1497 if (Index < PageLength) {
1498 BlockLimits = AllocateAlignedBuffer (ScsiDiskDevice, sizeof (EFI_SCSI_BLOCK_LIMITS_VPD_PAGE));
1499 if (BlockLimits == NULL) {
1500 FreeAlignedBuffer (SupportedVpdPages, sizeof (EFI_SCSI_SUPPORTED_VPD_PAGES_VPD_PAGE));
1501 *NeedRetry = FALSE;
1502 return EFI_DEVICE_ERROR;
1503 }
1504 ZeroMem (BlockLimits, sizeof (EFI_SCSI_BLOCK_LIMITS_VPD_PAGE));
1505 InquiryDataLength = sizeof (EFI_SCSI_BLOCK_LIMITS_VPD_PAGE);
1506 SenseDataLength = 0;
1507 Status = ScsiInquiryCommandEx (
1508 ScsiDiskDevice->ScsiIo,
1509 SCSI_DISK_TIMEOUT,
1510 NULL,
1511 &SenseDataLength,
1512 &HostAdapterStatus,
1513 &TargetStatus,
1514 (VOID *) BlockLimits,
1515 &InquiryDataLength,
1516 TRUE,
1517 EFI_SCSI_PAGE_CODE_BLOCK_LIMITS_VPD
1518 );
1519 if (!EFI_ERROR (Status)) {
1520 ScsiDiskDevice->BlkIo.Media->OptimalTransferLengthGranularity =
1521 (BlockLimits->OptimalTransferLengthGranularity2 << 8) |
1522 BlockLimits->OptimalTransferLengthGranularity1;
1523 }
1524
1525 FreeAlignedBuffer (BlockLimits, sizeof (EFI_SCSI_BLOCK_LIMITS_VPD_PAGE));
1526 }
1527 }
1528
1529 FreeAlignedBuffer (SupportedVpdPages, sizeof (EFI_SCSI_SUPPORTED_VPD_PAGES_VPD_PAGE));
1530 }
1531 }
1532
1533 if (!EFI_ERROR (Status)) {
1534 return EFI_SUCCESS;
1535
1536 } else if (Status == EFI_NOT_READY) {
1537 *NeedRetry = TRUE;
1538 return EFI_DEVICE_ERROR;
1539
1540 } else if ((Status == EFI_INVALID_PARAMETER) || (Status == EFI_UNSUPPORTED)) {
1541 *NeedRetry = FALSE;
1542 return EFI_DEVICE_ERROR;
1543 }
1544 //
1545 // go ahead to check HostAdapterStatus and TargetStatus
1546 // (EFI_TIMEOUT, EFI_DEVICE_ERROR)
1547 //
1548
1549 Status = CheckHostAdapterStatus (HostAdapterStatus);
1550 if ((Status == EFI_TIMEOUT) || (Status == EFI_NOT_READY)) {
1551 *NeedRetry = TRUE;
1552 return EFI_DEVICE_ERROR;
1553 } else if (Status == EFI_DEVICE_ERROR) {
1554 //
1555 // reset the scsi channel
1556 //
1557 ScsiDiskDevice->ScsiIo->ResetBus (ScsiDiskDevice->ScsiIo);
1558 *NeedRetry = FALSE;
1559 return EFI_DEVICE_ERROR;
1560 }
1561
1562 Status = CheckTargetStatus (TargetStatus);
1563 if (Status == EFI_NOT_READY) {
1564 //
1565 // reset the scsi device
1566 //
1567 ScsiDiskDevice->ScsiIo->ResetDevice (ScsiDiskDevice->ScsiIo);
1568 *NeedRetry = TRUE;
1569 return EFI_DEVICE_ERROR;
1570
1571 } else if (Status == EFI_DEVICE_ERROR) {
1572 *NeedRetry = FALSE;
1573 return EFI_DEVICE_ERROR;
1574 }
1575
1576 //
1577 // if goes here, meant ScsiInquiryCommand() failed.
1578 // if ScsiDiskRequestSenseKeys() succeeds at last,
1579 // better retry ScsiInquiryCommand(). (by setting *NeedRetry = TRUE)
1580 //
1581 MaxRetry = 3;
1582 for (Index = 0; Index < MaxRetry; Index++) {
1583 Status = ScsiDiskRequestSenseKeys (
1584 ScsiDiskDevice,
1585 NeedRetry,
1586 &SenseDataArray,
1587 &NumberOfSenseKeys,
1588 TRUE
1589 );
1590 if (!EFI_ERROR (Status)) {
1591 *NeedRetry = TRUE;
1592 return EFI_DEVICE_ERROR;
1593 }
1594
1595 if (!*NeedRetry) {
1596 return EFI_DEVICE_ERROR;
1597 }
1598 }
1599 //
1600 // ScsiDiskRequestSenseKeys() failed after several rounds of retry.
1601 // set *NeedRetry = FALSE to avoid the outside caller try again.
1602 //
1603 *NeedRetry = FALSE;
1604 return EFI_DEVICE_ERROR;
1605 }
1606
1607 /**
1608 To test device.
1609
1610 When Test Unit Ready command succeeds, retrieve Sense Keys via Request Sense;
1611 When Test Unit Ready command encounters any error caused by host adapter or
1612 target, return error without retrieving Sense Keys.
1613
1614 @param ScsiDiskDevice The pointer of SCSI_DISK_DEV
1615 @param NeedRetry The pointer of flag indicates try again
1616 @param SenseDataArray The pointer of an array of sense data
1617 @param NumberOfSenseKeys The pointer of the number of sense data array
1618
1619 @retval EFI_DEVICE_ERROR Indicates that error occurs
1620 @retval EFI_SUCCESS Successfully to test unit
1621
1622 **/
1623 EFI_STATUS
1624 ScsiDiskTestUnitReady (
1625 IN SCSI_DISK_DEV *ScsiDiskDevice,
1626 OUT BOOLEAN *NeedRetry,
1627 OUT EFI_SCSI_SENSE_DATA **SenseDataArray,
1628 OUT UINTN *NumberOfSenseKeys
1629 )
1630 {
1631 EFI_STATUS Status;
1632 UINT8 SenseDataLength;
1633 UINT8 HostAdapterStatus;
1634 UINT8 TargetStatus;
1635 UINT8 Index;
1636 UINT8 MaxRetry;
1637
1638 SenseDataLength = (UINT8) (ScsiDiskDevice->SenseDataNumber * sizeof (EFI_SCSI_SENSE_DATA));
1639 *NumberOfSenseKeys = 0;
1640
1641 //
1642 // Parameter 3 and 4: do not require sense data, retrieve it when needed.
1643 //
1644 Status = ScsiTestUnitReadyCommand (
1645 ScsiDiskDevice->ScsiIo,
1646 SCSI_DISK_TIMEOUT,
1647 ScsiDiskDevice->SenseData,
1648 &SenseDataLength,
1649 &HostAdapterStatus,
1650 &TargetStatus
1651 );
1652 //
1653 // no need to check HostAdapterStatus and TargetStatus
1654 //
1655 if (Status == EFI_NOT_READY) {
1656 *NeedRetry = TRUE;
1657 return EFI_DEVICE_ERROR;
1658
1659 } else if ((Status == EFI_INVALID_PARAMETER) || (Status == EFI_UNSUPPORTED)) {
1660 *NeedRetry = FALSE;
1661 return EFI_DEVICE_ERROR;
1662 }
1663 //
1664 // go ahead to check HostAdapterStatus and TargetStatus(in case of EFI_DEVICE_ERROR)
1665 //
1666
1667 Status = CheckHostAdapterStatus (HostAdapterStatus);
1668 if ((Status == EFI_TIMEOUT) || (Status == EFI_NOT_READY)) {
1669 *NeedRetry = TRUE;
1670 return EFI_DEVICE_ERROR;
1671
1672 } else if (Status == EFI_DEVICE_ERROR) {
1673 //
1674 // reset the scsi channel
1675 //
1676 ScsiDiskDevice->ScsiIo->ResetBus (ScsiDiskDevice->ScsiIo);
1677 *NeedRetry = FALSE;
1678 return EFI_DEVICE_ERROR;
1679 }
1680
1681 Status = CheckTargetStatus (TargetStatus);
1682 if (Status == EFI_NOT_READY) {
1683 //
1684 // reset the scsi device
1685 //
1686 ScsiDiskDevice->ScsiIo->ResetDevice (ScsiDiskDevice->ScsiIo);
1687 *NeedRetry = TRUE;
1688 return EFI_DEVICE_ERROR;
1689
1690 } else if (Status == EFI_DEVICE_ERROR) {
1691 *NeedRetry = FALSE;
1692 return EFI_DEVICE_ERROR;
1693 }
1694
1695 if (SenseDataLength != 0) {
1696 *NumberOfSenseKeys = SenseDataLength / sizeof (EFI_SCSI_SENSE_DATA);
1697 *SenseDataArray = ScsiDiskDevice->SenseData;
1698 return EFI_SUCCESS;
1699 }
1700
1701 MaxRetry = 3;
1702 for (Index = 0; Index < MaxRetry; Index++) {
1703 Status = ScsiDiskRequestSenseKeys (
1704 ScsiDiskDevice,
1705 NeedRetry,
1706 SenseDataArray,
1707 NumberOfSenseKeys,
1708 FALSE
1709 );
1710 if (!EFI_ERROR (Status)) {
1711 return EFI_SUCCESS;
1712 }
1713
1714 if (!*NeedRetry) {
1715 return EFI_DEVICE_ERROR;
1716 }
1717 }
1718 //
1719 // ScsiDiskRequestSenseKeys() failed after several rounds of retry.
1720 // set *NeedRetry = FALSE to avoid the outside caller try again.
1721 //
1722 *NeedRetry = FALSE;
1723 return EFI_DEVICE_ERROR;
1724 }
1725
1726 /**
1727 Parsing Sense Keys which got from request sense command.
1728
1729 @param ScsiDiskDevice The pointer of SCSI_DISK_DEV
1730 @param SenseData The pointer of EFI_SCSI_SENSE_DATA
1731 @param NumberOfSenseKeys The number of sense key
1732 @param Action The pointer of action which indicates what is need to do next
1733
1734 @retval EFI_DEVICE_ERROR Indicates that error occurs
1735 @retval EFI_SUCCESS Successfully to complete the parsing
1736
1737 **/
1738 EFI_STATUS
1739 DetectMediaParsingSenseKeys (
1740 OUT SCSI_DISK_DEV *ScsiDiskDevice,
1741 IN EFI_SCSI_SENSE_DATA *SenseData,
1742 IN UINTN NumberOfSenseKeys,
1743 OUT UINTN *Action
1744 )
1745 {
1746 BOOLEAN RetryLater;
1747
1748 //
1749 // Default is to read capacity, unless..
1750 //
1751 *Action = ACTION_READ_CAPACITY;
1752
1753 if (NumberOfSenseKeys == 0) {
1754 if (ScsiDiskDevice->BlkIo.Media->MediaPresent == TRUE) {
1755 *Action = ACTION_NO_ACTION;
1756 }
1757 return EFI_SUCCESS;
1758 }
1759
1760 if (!ScsiDiskHaveSenseKey (SenseData, NumberOfSenseKeys)) {
1761 //
1762 // No Sense Key returned from last submitted command
1763 //
1764 if (ScsiDiskDevice->BlkIo.Media->MediaPresent == TRUE) {
1765 *Action = ACTION_NO_ACTION;
1766 }
1767 return EFI_SUCCESS;
1768 }
1769
1770 if (ScsiDiskIsNoMedia (SenseData, NumberOfSenseKeys)) {
1771 ScsiDiskDevice->BlkIo.Media->MediaPresent = FALSE;
1772 ScsiDiskDevice->BlkIo.Media->LastBlock = 0;
1773 *Action = ACTION_NO_ACTION;
1774 DEBUG ((EFI_D_VERBOSE, "ScsiDisk: ScsiDiskIsNoMedia\n"));
1775 return EFI_SUCCESS;
1776 }
1777
1778 if (ScsiDiskIsMediaChange (SenseData, NumberOfSenseKeys)) {
1779 ScsiDiskDevice->BlkIo.Media->MediaId++;
1780 DEBUG ((EFI_D_VERBOSE, "ScsiDisk: ScsiDiskIsMediaChange!\n"));
1781 return EFI_SUCCESS;
1782 }
1783
1784 if (ScsiDiskIsResetBefore (SenseData, NumberOfSenseKeys)) {
1785 *Action = ACTION_RETRY_COMMAND_LATER;
1786 DEBUG ((EFI_D_VERBOSE, "ScsiDisk: ScsiDiskIsResetBefore!\n"));
1787 return EFI_SUCCESS;
1788 }
1789
1790 if (ScsiDiskIsMediaError (SenseData, NumberOfSenseKeys)) {
1791 DEBUG ((EFI_D_VERBOSE, "ScsiDisk: ScsiDiskIsMediaError\n"));
1792 *Action = ACTION_RETRY_WITH_BACKOFF_ALGO;
1793 return EFI_DEVICE_ERROR;
1794 }
1795
1796 if (ScsiDiskIsHardwareError (SenseData, NumberOfSenseKeys)) {
1797 DEBUG ((EFI_D_VERBOSE, "ScsiDisk: ScsiDiskIsHardwareError\n"));
1798 *Action = ACTION_RETRY_WITH_BACKOFF_ALGO;
1799 return EFI_DEVICE_ERROR;
1800 }
1801
1802 if (!ScsiDiskIsDriveReady (SenseData, NumberOfSenseKeys, &RetryLater)) {
1803 if (RetryLater) {
1804 *Action = ACTION_RETRY_COMMAND_LATER;
1805 DEBUG ((EFI_D_VERBOSE, "ScsiDisk: ScsiDiskDriveNotReady!\n"));
1806 return EFI_SUCCESS;
1807 }
1808 *Action = ACTION_NO_ACTION;
1809 return EFI_DEVICE_ERROR;
1810 }
1811
1812 *Action = ACTION_RETRY_WITH_BACKOFF_ALGO;
1813 DEBUG ((EFI_D_VERBOSE, "ScsiDisk: Sense Key = 0x%x ASC = 0x%x!\n", SenseData->Sense_Key, SenseData->Addnl_Sense_Code));
1814 return EFI_SUCCESS;
1815 }
1816
1817
1818 /**
1819 Send read capacity command to device and get the device parameter.
1820
1821 @param ScsiDiskDevice The pointer of SCSI_DISK_DEV
1822 @param NeedRetry The pointer of flag indicates if need a retry
1823 @param SenseDataArray The pointer of an array of sense data
1824 @param NumberOfSenseKeys The number of sense key
1825
1826 @retval EFI_DEVICE_ERROR Indicates that error occurs
1827 @retval EFI_SUCCESS Successfully to read capacity or sense data is received.
1828
1829 **/
1830 EFI_STATUS
1831 ScsiDiskReadCapacity (
1832 IN OUT SCSI_DISK_DEV *ScsiDiskDevice,
1833 OUT BOOLEAN *NeedRetry,
1834 OUT EFI_SCSI_SENSE_DATA **SenseDataArray,
1835 OUT UINTN *NumberOfSenseKeys
1836 )
1837 {
1838 UINT8 HostAdapterStatus;
1839 UINT8 TargetStatus;
1840 EFI_STATUS CommandStatus;
1841 EFI_STATUS Status;
1842 UINT8 Index;
1843 UINT8 MaxRetry;
1844 UINT8 SenseDataLength;
1845 UINT32 DataLength10;
1846 UINT32 DataLength16;
1847 EFI_SCSI_DISK_CAPACITY_DATA *CapacityData10;
1848 EFI_SCSI_DISK_CAPACITY_DATA16 *CapacityData16;
1849
1850 CapacityData10 = AllocateAlignedBuffer (ScsiDiskDevice, sizeof (EFI_SCSI_DISK_CAPACITY_DATA));
1851 if (CapacityData10 == NULL) {
1852 *NeedRetry = FALSE;
1853 return EFI_DEVICE_ERROR;
1854 }
1855 CapacityData16 = AllocateAlignedBuffer (ScsiDiskDevice, sizeof (EFI_SCSI_DISK_CAPACITY_DATA16));
1856 if (CapacityData16 == NULL) {
1857 FreeAlignedBuffer (CapacityData10, sizeof (EFI_SCSI_DISK_CAPACITY_DATA));
1858 *NeedRetry = FALSE;
1859 return EFI_DEVICE_ERROR;
1860 }
1861
1862 SenseDataLength = 0;
1863 DataLength10 = sizeof (EFI_SCSI_DISK_CAPACITY_DATA);
1864 DataLength16 = sizeof (EFI_SCSI_DISK_CAPACITY_DATA16);
1865 ZeroMem (CapacityData10, sizeof (EFI_SCSI_DISK_CAPACITY_DATA));
1866 ZeroMem (CapacityData16, sizeof (EFI_SCSI_DISK_CAPACITY_DATA16));
1867
1868 *NumberOfSenseKeys = 0;
1869 *NeedRetry = FALSE;
1870
1871 //
1872 // submit Read Capacity(10) Command. If it returns capacity of FFFFFFFFh,
1873 // 16 byte command should be used to access large hard disk >2TB
1874 //
1875 CommandStatus = ScsiReadCapacityCommand (
1876 ScsiDiskDevice->ScsiIo,
1877 SCSI_DISK_TIMEOUT,
1878 NULL,
1879 &SenseDataLength,
1880 &HostAdapterStatus,
1881 &TargetStatus,
1882 (VOID *) CapacityData10,
1883 &DataLength10,
1884 FALSE
1885 );
1886
1887 ScsiDiskDevice->Cdb16Byte = FALSE;
1888 if ((!EFI_ERROR (CommandStatus)) && (CapacityData10->LastLba3 == 0xff) && (CapacityData10->LastLba2 == 0xff) &&
1889 (CapacityData10->LastLba1 == 0xff) && (CapacityData10->LastLba0 == 0xff)) {
1890 //
1891 // use Read Capacity (16), Read (16) and Write (16) next when hard disk size > 2TB
1892 //
1893 ScsiDiskDevice->Cdb16Byte = TRUE;
1894 //
1895 // submit Read Capacity(16) Command to get parameter LogicalBlocksPerPhysicalBlock
1896 // and LowestAlignedLba
1897 //
1898 CommandStatus = ScsiReadCapacity16Command (
1899 ScsiDiskDevice->ScsiIo,
1900 SCSI_DISK_TIMEOUT,
1901 NULL,
1902 &SenseDataLength,
1903 &HostAdapterStatus,
1904 &TargetStatus,
1905 (VOID *) CapacityData16,
1906 &DataLength16,
1907 FALSE
1908 );
1909 }
1910
1911 //
1912 // no need to check HostAdapterStatus and TargetStatus
1913 //
1914 if (CommandStatus == EFI_SUCCESS) {
1915 GetMediaInfo (ScsiDiskDevice, CapacityData10, CapacityData16);
1916 FreeAlignedBuffer (CapacityData10, sizeof (EFI_SCSI_DISK_CAPACITY_DATA));
1917 FreeAlignedBuffer (CapacityData16, sizeof (EFI_SCSI_DISK_CAPACITY_DATA16));
1918 return EFI_SUCCESS;
1919 }
1920
1921 FreeAlignedBuffer (CapacityData10, sizeof (EFI_SCSI_DISK_CAPACITY_DATA));
1922 FreeAlignedBuffer (CapacityData16, sizeof (EFI_SCSI_DISK_CAPACITY_DATA16));
1923
1924 if (CommandStatus == EFI_NOT_READY) {
1925 *NeedRetry = TRUE;
1926 return EFI_DEVICE_ERROR;
1927 } else if ((CommandStatus == EFI_INVALID_PARAMETER) || (CommandStatus == EFI_UNSUPPORTED)) {
1928 *NeedRetry = FALSE;
1929 return EFI_DEVICE_ERROR;
1930 }
1931
1932 //
1933 // go ahead to check HostAdapterStatus and TargetStatus
1934 // (EFI_TIMEOUT, EFI_DEVICE_ERROR, EFI_WARN_BUFFER_TOO_SMALL)
1935 //
1936
1937 Status = CheckHostAdapterStatus (HostAdapterStatus);
1938 if ((Status == EFI_TIMEOUT) || (Status == EFI_NOT_READY)) {
1939 *NeedRetry = TRUE;
1940 return EFI_DEVICE_ERROR;
1941
1942 } else if (Status == EFI_DEVICE_ERROR) {
1943 //
1944 // reset the scsi channel
1945 //
1946 ScsiDiskDevice->ScsiIo->ResetBus (ScsiDiskDevice->ScsiIo);
1947 *NeedRetry = FALSE;
1948 return EFI_DEVICE_ERROR;
1949 }
1950
1951 Status = CheckTargetStatus (TargetStatus);
1952 if (Status == EFI_NOT_READY) {
1953 //
1954 // reset the scsi device
1955 //
1956 ScsiDiskDevice->ScsiIo->ResetDevice (ScsiDiskDevice->ScsiIo);
1957 *NeedRetry = TRUE;
1958 return EFI_DEVICE_ERROR;
1959
1960 } else if (Status == EFI_DEVICE_ERROR) {
1961 *NeedRetry = FALSE;
1962 return EFI_DEVICE_ERROR;
1963 }
1964
1965 //
1966 // if goes here, meant ScsiReadCapacityCommand() failed.
1967 // if ScsiDiskRequestSenseKeys() succeeds at last,
1968 // better retry ScsiReadCapacityCommand(). (by setting *NeedRetry = TRUE)
1969 //
1970 MaxRetry = 3;
1971 for (Index = 0; Index < MaxRetry; Index++) {
1972
1973 Status = ScsiDiskRequestSenseKeys (
1974 ScsiDiskDevice,
1975 NeedRetry,
1976 SenseDataArray,
1977 NumberOfSenseKeys,
1978 TRUE
1979 );
1980 if (!EFI_ERROR (Status)) {
1981 return EFI_SUCCESS;
1982 }
1983
1984 if (!*NeedRetry) {
1985 return EFI_DEVICE_ERROR;
1986 }
1987 }
1988 //
1989 // ScsiDiskRequestSenseKeys() failed after several rounds of retry.
1990 // set *NeedRetry = FALSE to avoid the outside caller try again.
1991 //
1992 *NeedRetry = FALSE;
1993 return EFI_DEVICE_ERROR;
1994 }
1995
1996 /**
1997 Check the HostAdapter status and re-interpret it in EFI_STATUS.
1998
1999 @param HostAdapterStatus Host Adapter status
2000
2001 @retval EFI_SUCCESS Host adapter is OK.
2002 @retval EFI_TIMEOUT Timeout.
2003 @retval EFI_NOT_READY Adapter NOT ready.
2004 @retval EFI_DEVICE_ERROR Adapter device error.
2005
2006 **/
2007 EFI_STATUS
2008 CheckHostAdapterStatus (
2009 IN UINT8 HostAdapterStatus
2010 )
2011 {
2012 switch (HostAdapterStatus) {
2013 case EFI_EXT_SCSI_STATUS_HOST_ADAPTER_OK:
2014 return EFI_SUCCESS;
2015
2016 case EFI_EXT_SCSI_STATUS_HOST_ADAPTER_SELECTION_TIMEOUT:
2017 case EFI_EXT_SCSI_STATUS_HOST_ADAPTER_TIMEOUT:
2018 case EFI_EXT_SCSI_STATUS_HOST_ADAPTER_TIMEOUT_COMMAND:
2019 return EFI_TIMEOUT;
2020
2021 case EFI_EXT_SCSI_STATUS_HOST_ADAPTER_MESSAGE_REJECT:
2022 case EFI_EXT_SCSI_STATUS_HOST_ADAPTER_PARITY_ERROR:
2023 case EFI_EXT_SCSI_STATUS_HOST_ADAPTER_REQUEST_SENSE_FAILED:
2024 case EFI_EXT_SCSI_STATUS_HOST_ADAPTER_DATA_OVERRUN_UNDERRUN:
2025 case EFI_EXT_SCSI_STATUS_HOST_ADAPTER_BUS_RESET:
2026 return EFI_NOT_READY;
2027
2028 case EFI_EXT_SCSI_STATUS_HOST_ADAPTER_BUS_FREE:
2029 case EFI_EXT_SCSI_STATUS_HOST_ADAPTER_PHASE_ERROR:
2030 return EFI_DEVICE_ERROR;
2031
2032 default:
2033 return EFI_SUCCESS;
2034 }
2035 }
2036
2037
2038 /**
2039 Check the target status and re-interpret it in EFI_STATUS.
2040
2041 @param TargetStatus Target status
2042
2043 @retval EFI_NOT_READY Device is NOT ready.
2044 @retval EFI_DEVICE_ERROR
2045 @retval EFI_SUCCESS
2046
2047 **/
2048 EFI_STATUS
2049 CheckTargetStatus (
2050 IN UINT8 TargetStatus
2051 )
2052 {
2053 switch (TargetStatus) {
2054 case EFI_EXT_SCSI_STATUS_TARGET_GOOD:
2055 case EFI_EXT_SCSI_STATUS_TARGET_CHECK_CONDITION:
2056 case EFI_EXT_SCSI_STATUS_TARGET_CONDITION_MET:
2057 return EFI_SUCCESS;
2058
2059 case EFI_EXT_SCSI_STATUS_TARGET_INTERMEDIATE:
2060 case EFI_EXT_SCSI_STATUS_TARGET_INTERMEDIATE_CONDITION_MET:
2061 case EFI_EXT_SCSI_STATUS_TARGET_BUSY:
2062 case EFI_EXT_SCSI_STATUS_TARGET_TASK_SET_FULL:
2063 return EFI_NOT_READY;
2064
2065 case EFI_EXT_SCSI_STATUS_TARGET_RESERVATION_CONFLICT:
2066 return EFI_DEVICE_ERROR;
2067
2068 default:
2069 return EFI_SUCCESS;
2070 }
2071 }
2072
2073
2074 /**
2075 Retrieve all sense keys from the device.
2076
2077 When encountering error during the process, if retrieve sense keys before
2078 error encountered, it returns the sense keys with return status set to EFI_SUCCESS,
2079 and NeedRetry set to FALSE; otherwize, return the proper return status.
2080
2081 @param ScsiDiskDevice The pointer of SCSI_DISK_DEV
2082 @param NeedRetry The pointer of flag indicates if need a retry
2083 @param SenseDataArray The pointer of an array of sense data
2084 @param NumberOfSenseKeys The number of sense key
2085 @param AskResetIfError The flag indicates if need reset when error occurs
2086
2087 @retval EFI_DEVICE_ERROR Indicates that error occurs
2088 @retval EFI_SUCCESS Successfully to request sense key
2089
2090 **/
2091 EFI_STATUS
2092 ScsiDiskRequestSenseKeys (
2093 IN OUT SCSI_DISK_DEV *ScsiDiskDevice,
2094 OUT BOOLEAN *NeedRetry,
2095 OUT EFI_SCSI_SENSE_DATA **SenseDataArray,
2096 OUT UINTN *NumberOfSenseKeys,
2097 IN BOOLEAN AskResetIfError
2098 )
2099 {
2100 EFI_SCSI_SENSE_DATA *PtrSenseData;
2101 UINT8 SenseDataLength;
2102 BOOLEAN SenseReq;
2103 EFI_STATUS Status;
2104 EFI_STATUS FallStatus;
2105 UINT8 HostAdapterStatus;
2106 UINT8 TargetStatus;
2107
2108 FallStatus = EFI_SUCCESS;
2109 SenseDataLength = (UINT8) sizeof (EFI_SCSI_SENSE_DATA);
2110
2111 ZeroMem (
2112 ScsiDiskDevice->SenseData,
2113 sizeof (EFI_SCSI_SENSE_DATA) * (ScsiDiskDevice->SenseDataNumber)
2114 );
2115
2116 *NumberOfSenseKeys = 0;
2117 *SenseDataArray = ScsiDiskDevice->SenseData;
2118 Status = EFI_SUCCESS;
2119 PtrSenseData = AllocateAlignedBuffer (ScsiDiskDevice, sizeof (EFI_SCSI_SENSE_DATA));
2120 if (PtrSenseData == NULL) {
2121 return EFI_DEVICE_ERROR;
2122 }
2123
2124 for (SenseReq = TRUE; SenseReq;) {
2125 ZeroMem (PtrSenseData, sizeof (EFI_SCSI_SENSE_DATA));
2126 Status = ScsiRequestSenseCommand (
2127 ScsiDiskDevice->ScsiIo,
2128 SCSI_DISK_TIMEOUT,
2129 PtrSenseData,
2130 &SenseDataLength,
2131 &HostAdapterStatus,
2132 &TargetStatus
2133 );
2134 if ((Status == EFI_SUCCESS) || (Status == EFI_WARN_BUFFER_TOO_SMALL)) {
2135 FallStatus = EFI_SUCCESS;
2136
2137 } else if ((Status == EFI_TIMEOUT) || (Status == EFI_NOT_READY)) {
2138 *NeedRetry = TRUE;
2139 FallStatus = EFI_DEVICE_ERROR;
2140
2141 } else if ((Status == EFI_INVALID_PARAMETER) || (Status == EFI_UNSUPPORTED)) {
2142 *NeedRetry = FALSE;
2143 FallStatus = EFI_DEVICE_ERROR;
2144
2145 } else if (Status == EFI_DEVICE_ERROR) {
2146 if (AskResetIfError) {
2147 ScsiDiskDevice->ScsiIo->ResetDevice (ScsiDiskDevice->ScsiIo);
2148 }
2149
2150 FallStatus = EFI_DEVICE_ERROR;
2151 }
2152
2153 if (EFI_ERROR (FallStatus)) {
2154 if (*NumberOfSenseKeys != 0) {
2155 *NeedRetry = FALSE;
2156 Status = EFI_SUCCESS;
2157 goto EXIT;
2158 } else {
2159 Status = EFI_DEVICE_ERROR;
2160 goto EXIT;
2161 }
2162 }
2163
2164 CopyMem (ScsiDiskDevice->SenseData + *NumberOfSenseKeys, PtrSenseData, SenseDataLength);
2165 (*NumberOfSenseKeys) += 1;
2166
2167 //
2168 // no more sense key or number of sense keys exceeds predefined,
2169 // skip the loop.
2170 //
2171 if ((PtrSenseData->Sense_Key == EFI_SCSI_SK_NO_SENSE) ||
2172 (*NumberOfSenseKeys == ScsiDiskDevice->SenseDataNumber)) {
2173 SenseReq = FALSE;
2174 }
2175 }
2176
2177 EXIT:
2178 FreeAlignedBuffer (PtrSenseData, sizeof (EFI_SCSI_SENSE_DATA));
2179 return Status;
2180 }
2181
2182
2183 /**
2184 Get information from media read capacity command.
2185
2186 @param ScsiDiskDevice The pointer of SCSI_DISK_DEV
2187 @param Capacity10 The pointer of EFI_SCSI_DISK_CAPACITY_DATA
2188 @param Capacity16 The pointer of EFI_SCSI_DISK_CAPACITY_DATA16
2189
2190 **/
2191 VOID
2192 GetMediaInfo (
2193 IN OUT SCSI_DISK_DEV *ScsiDiskDevice,
2194 IN EFI_SCSI_DISK_CAPACITY_DATA *Capacity10,
2195 IN EFI_SCSI_DISK_CAPACITY_DATA16 *Capacity16
2196 )
2197 {
2198 UINT8 *Ptr;
2199
2200 if (!ScsiDiskDevice->Cdb16Byte) {
2201 ScsiDiskDevice->BlkIo.Media->LastBlock = (Capacity10->LastLba3 << 24) |
2202 (Capacity10->LastLba2 << 16) |
2203 (Capacity10->LastLba1 << 8) |
2204 Capacity10->LastLba0;
2205
2206 ScsiDiskDevice->BlkIo.Media->BlockSize = (Capacity10->BlockSize3 << 24) |
2207 (Capacity10->BlockSize2 << 16) |
2208 (Capacity10->BlockSize1 << 8) |
2209 Capacity10->BlockSize0;
2210 ScsiDiskDevice->BlkIo.Media->LowestAlignedLba = 0;
2211 ScsiDiskDevice->BlkIo.Media->LogicalBlocksPerPhysicalBlock = 0;
2212 } else {
2213 Ptr = (UINT8*)&ScsiDiskDevice->BlkIo.Media->LastBlock;
2214 *Ptr++ = Capacity16->LastLba0;
2215 *Ptr++ = Capacity16->LastLba1;
2216 *Ptr++ = Capacity16->LastLba2;
2217 *Ptr++ = Capacity16->LastLba3;
2218 *Ptr++ = Capacity16->LastLba4;
2219 *Ptr++ = Capacity16->LastLba5;
2220 *Ptr++ = Capacity16->LastLba6;
2221 *Ptr = Capacity16->LastLba7;
2222
2223 ScsiDiskDevice->BlkIo.Media->BlockSize = (Capacity16->BlockSize3 << 24) |
2224 (Capacity16->BlockSize2 << 16) |
2225 (Capacity16->BlockSize1 << 8) |
2226 Capacity16->BlockSize0;
2227
2228 ScsiDiskDevice->BlkIo.Media->LowestAlignedLba = (Capacity16->LowestAlignLogic2 << 8) |
2229 Capacity16->LowestAlignLogic1;
2230 ScsiDiskDevice->BlkIo.Media->LogicalBlocksPerPhysicalBlock = (1 << Capacity16->LogicPerPhysical);
2231 }
2232
2233 ScsiDiskDevice->BlkIo.Media->MediaPresent = TRUE;
2234 }
2235
2236 /**
2237 Parse Inquiry data.
2238
2239 @param ScsiDiskDevice The pointer of SCSI_DISK_DEV
2240
2241 **/
2242 VOID
2243 ParseInquiryData (
2244 IN OUT SCSI_DISK_DEV *ScsiDiskDevice
2245 )
2246 {
2247 ScsiDiskDevice->FixedDevice = (BOOLEAN) ((ScsiDiskDevice->InquiryData.Rmb == 1) ? 0 : 1);
2248 ScsiDiskDevice->BlkIoMedia.RemovableMedia = (BOOLEAN) (!ScsiDiskDevice->FixedDevice);
2249 }
2250
2251 /**
2252 Read sector from SCSI Disk.
2253
2254 @param ScsiDiskDevice The pointer of SCSI_DISK_DEV
2255 @param Buffer The buffer to fill in the read out data
2256 @param Lba Logic block address
2257 @param NumberOfBlocks The number of blocks to read
2258
2259 @retval EFI_DEVICE_ERROR Indicates a device error.
2260 @retval EFI_SUCCESS Operation is successful.
2261
2262 **/
2263 EFI_STATUS
2264 ScsiDiskReadSectors (
2265 IN SCSI_DISK_DEV *ScsiDiskDevice,
2266 OUT VOID *Buffer,
2267 IN EFI_LBA Lba,
2268 IN UINTN NumberOfBlocks
2269 )
2270 {
2271 UINTN BlocksRemaining;
2272 UINT8 *PtrBuffer;
2273 UINT32 BlockSize;
2274 UINT32 ByteCount;
2275 UINT32 MaxBlock;
2276 UINT32 SectorCount;
2277 UINT32 NextSectorCount;
2278 UINT64 Timeout;
2279 EFI_STATUS Status;
2280 UINT8 Index;
2281 UINT8 MaxRetry;
2282 BOOLEAN NeedRetry;
2283
2284 Status = EFI_SUCCESS;
2285
2286 BlocksRemaining = NumberOfBlocks;
2287 BlockSize = ScsiDiskDevice->BlkIo.Media->BlockSize;
2288
2289 //
2290 // limit the data bytes that can be transferred by one Read(10) or Read(16) Command
2291 //
2292 if (!ScsiDiskDevice->Cdb16Byte) {
2293 MaxBlock = 0xFFFF;
2294 } else {
2295 MaxBlock = 0xFFFFFFFF;
2296 }
2297
2298 PtrBuffer = Buffer;
2299
2300 while (BlocksRemaining > 0) {
2301
2302 if (BlocksRemaining <= MaxBlock) {
2303 if (!ScsiDiskDevice->Cdb16Byte) {
2304 SectorCount = (UINT16) BlocksRemaining;
2305 } else {
2306 SectorCount = (UINT32) BlocksRemaining;
2307 }
2308 } else {
2309 SectorCount = MaxBlock;
2310 }
2311
2312 ByteCount = SectorCount * BlockSize;
2313 //
2314 // |------------------------|-----------------|------------------|-----------------|
2315 // | ATA Transfer Mode | Transfer Rate | SCSI Interface | Transfer Rate |
2316 // |------------------------|-----------------|------------------|-----------------|
2317 // | PIO Mode 0 | 3.3Mbytes/sec | SCSI-1 | 5Mbytes/sec |
2318 // |------------------------|-----------------|------------------|-----------------|
2319 // | PIO Mode 1 | 5.2Mbytes/sec | Fast SCSI | 10Mbytes/sec |
2320 // |------------------------|-----------------|------------------|-----------------|
2321 // | PIO Mode 2 | 8.3Mbytes/sec | Fast-Wide SCSI | 20Mbytes/sec |
2322 // |------------------------|-----------------|------------------|-----------------|
2323 // | PIO Mode 3 | 11.1Mbytes/sec | Ultra SCSI | 20Mbytes/sec |
2324 // |------------------------|-----------------|------------------|-----------------|
2325 // | PIO Mode 4 | 16.6Mbytes/sec | Ultra Wide SCSI | 40Mbytes/sec |
2326 // |------------------------|-----------------|------------------|-----------------|
2327 // | Single-word DMA Mode 0 | 2.1Mbytes/sec | Ultra2 SCSI | 40Mbytes/sec |
2328 // |------------------------|-----------------|------------------|-----------------|
2329 // | Single-word DMA Mode 1 | 4.2Mbytes/sec | Ultra2 Wide SCSI | 80Mbytes/sec |
2330 // |------------------------|-----------------|------------------|-----------------|
2331 // | Single-word DMA Mode 2 | 8.4Mbytes/sec | Ultra3 SCSI | 160Mbytes/sec |
2332 // |------------------------|-----------------|------------------|-----------------|
2333 // | Multi-word DMA Mode 0 | 4.2Mbytes/sec | Ultra-320 SCSI | 320Mbytes/sec |
2334 // |------------------------|-----------------|------------------|-----------------|
2335 // | Multi-word DMA Mode 1 | 13.3Mbytes/sec | Ultra-640 SCSI | 640Mbytes/sec |
2336 // |------------------------|-----------------|------------------|-----------------|
2337 //
2338 // As ScsiDisk and ScsiBus driver are used to manage SCSI or ATAPI devices, we have to use
2339 // the lowest transfer rate to calculate the possible maximum timeout value for each operation.
2340 // From the above table, we could know 2.1Mbytes per second is lowest one.
2341 // The timout value is rounded up to nearest integar and here an additional 30s is added
2342 // to follow ATA spec in which it mentioned that the device may take up to 30s to respond
2343 // commands in the Standby/Idle mode.
2344 //
2345 Timeout = EFI_TIMER_PERIOD_SECONDS (ByteCount / 2100000 + 31);
2346
2347 MaxRetry = 2;
2348 for (Index = 0; Index < MaxRetry; Index++) {
2349 if (!ScsiDiskDevice->Cdb16Byte) {
2350 Status = ScsiDiskRead10 (
2351 ScsiDiskDevice,
2352 &NeedRetry,
2353 Timeout,
2354 PtrBuffer,
2355 &ByteCount,
2356 (UINT32) Lba,
2357 SectorCount
2358 );
2359 } else {
2360 Status = ScsiDiskRead16 (
2361 ScsiDiskDevice,
2362 &NeedRetry,
2363 Timeout,
2364 PtrBuffer,
2365 &ByteCount,
2366 Lba,
2367 SectorCount
2368 );
2369 }
2370 if (!EFI_ERROR (Status)) {
2371 break;
2372 }
2373
2374 if (!NeedRetry) {
2375 return EFI_DEVICE_ERROR;
2376 }
2377
2378 //
2379 // We need to retry. However, if ScsiDiskRead10() or ScsiDiskRead16() has
2380 // lowered ByteCount on output, we must make sure that we lower
2381 // SectorCount accordingly. SectorCount will be encoded in the CDB, and
2382 // it is invalid to request more sectors in the CDB than the entire
2383 // transfer (ie. ByteCount) can carry.
2384 //
2385 // In addition, ByteCount is only expected to go down, or stay unchaged.
2386 // Therefore we don't need to update Timeout: the original timeout should
2387 // accommodate shorter transfers too.
2388 //
2389 NextSectorCount = ByteCount / BlockSize;
2390 if (NextSectorCount < SectorCount) {
2391 SectorCount = NextSectorCount;
2392 //
2393 // Account for any rounding down.
2394 //
2395 ByteCount = SectorCount * BlockSize;
2396 }
2397 }
2398
2399 if ((Index == MaxRetry) && (Status != EFI_SUCCESS)) {
2400 return EFI_DEVICE_ERROR;
2401 }
2402
2403 //
2404 // actual transferred sectors
2405 //
2406 SectorCount = ByteCount / BlockSize;
2407
2408 Lba += SectorCount;
2409 PtrBuffer = PtrBuffer + SectorCount * BlockSize;
2410 BlocksRemaining -= SectorCount;
2411 }
2412
2413 return EFI_SUCCESS;
2414 }
2415
2416 /**
2417 Write sector to SCSI Disk.
2418
2419 @param ScsiDiskDevice The pointer of SCSI_DISK_DEV
2420 @param Buffer The buffer of data to be written into SCSI Disk
2421 @param Lba Logic block address
2422 @param NumberOfBlocks The number of blocks to read
2423
2424 @retval EFI_DEVICE_ERROR Indicates a device error.
2425 @retval EFI_SUCCESS Operation is successful.
2426
2427 **/
2428 EFI_STATUS
2429 ScsiDiskWriteSectors (
2430 IN SCSI_DISK_DEV *ScsiDiskDevice,
2431 IN VOID *Buffer,
2432 IN EFI_LBA Lba,
2433 IN UINTN NumberOfBlocks
2434 )
2435 {
2436 UINTN BlocksRemaining;
2437 UINT8 *PtrBuffer;
2438 UINT32 BlockSize;
2439 UINT32 ByteCount;
2440 UINT32 MaxBlock;
2441 UINT32 SectorCount;
2442 UINT32 NextSectorCount;
2443 UINT64 Timeout;
2444 EFI_STATUS Status;
2445 UINT8 Index;
2446 UINT8 MaxRetry;
2447 BOOLEAN NeedRetry;
2448
2449 Status = EFI_SUCCESS;
2450
2451 BlocksRemaining = NumberOfBlocks;
2452 BlockSize = ScsiDiskDevice->BlkIo.Media->BlockSize;
2453
2454 //
2455 // limit the data bytes that can be transferred by one Read(10) or Read(16) Command
2456 //
2457 if (!ScsiDiskDevice->Cdb16Byte) {
2458 MaxBlock = 0xFFFF;
2459 } else {
2460 MaxBlock = 0xFFFFFFFF;
2461 }
2462
2463 PtrBuffer = Buffer;
2464
2465 while (BlocksRemaining > 0) {
2466
2467 if (BlocksRemaining <= MaxBlock) {
2468 if (!ScsiDiskDevice->Cdb16Byte) {
2469 SectorCount = (UINT16) BlocksRemaining;
2470 } else {
2471 SectorCount = (UINT32) BlocksRemaining;
2472 }
2473 } else {
2474 SectorCount = MaxBlock;
2475 }
2476
2477 ByteCount = SectorCount * BlockSize;
2478 //
2479 // |------------------------|-----------------|------------------|-----------------|
2480 // | ATA Transfer Mode | Transfer Rate | SCSI Interface | Transfer Rate |
2481 // |------------------------|-----------------|------------------|-----------------|
2482 // | PIO Mode 0 | 3.3Mbytes/sec | SCSI-1 | 5Mbytes/sec |
2483 // |------------------------|-----------------|------------------|-----------------|
2484 // | PIO Mode 1 | 5.2Mbytes/sec | Fast SCSI | 10Mbytes/sec |
2485 // |------------------------|-----------------|------------------|-----------------|
2486 // | PIO Mode 2 | 8.3Mbytes/sec | Fast-Wide SCSI | 20Mbytes/sec |
2487 // |------------------------|-----------------|------------------|-----------------|
2488 // | PIO Mode 3 | 11.1Mbytes/sec | Ultra SCSI | 20Mbytes/sec |
2489 // |------------------------|-----------------|------------------|-----------------|
2490 // | PIO Mode 4 | 16.6Mbytes/sec | Ultra Wide SCSI | 40Mbytes/sec |
2491 // |------------------------|-----------------|------------------|-----------------|
2492 // | Single-word DMA Mode 0 | 2.1Mbytes/sec | Ultra2 SCSI | 40Mbytes/sec |
2493 // |------------------------|-----------------|------------------|-----------------|
2494 // | Single-word DMA Mode 1 | 4.2Mbytes/sec | Ultra2 Wide SCSI | 80Mbytes/sec |
2495 // |------------------------|-----------------|------------------|-----------------|
2496 // | Single-word DMA Mode 2 | 8.4Mbytes/sec | Ultra3 SCSI | 160Mbytes/sec |
2497 // |------------------------|-----------------|------------------|-----------------|
2498 // | Multi-word DMA Mode 0 | 4.2Mbytes/sec | Ultra-320 SCSI | 320Mbytes/sec |
2499 // |------------------------|-----------------|------------------|-----------------|
2500 // | Multi-word DMA Mode 1 | 13.3Mbytes/sec | Ultra-640 SCSI | 640Mbytes/sec |
2501 // |------------------------|-----------------|------------------|-----------------|
2502 //
2503 // As ScsiDisk and ScsiBus driver are used to manage SCSI or ATAPI devices, we have to use
2504 // the lowest transfer rate to calculate the possible maximum timeout value for each operation.
2505 // From the above table, we could know 2.1Mbytes per second is lowest one.
2506 // The timout value is rounded up to nearest integar and here an additional 30s is added
2507 // to follow ATA spec in which it mentioned that the device may take up to 30s to respond
2508 // commands in the Standby/Idle mode.
2509 //
2510 Timeout = EFI_TIMER_PERIOD_SECONDS (ByteCount / 2100000 + 31);
2511 MaxRetry = 2;
2512 for (Index = 0; Index < MaxRetry; Index++) {
2513 if (!ScsiDiskDevice->Cdb16Byte) {
2514 Status = ScsiDiskWrite10 (
2515 ScsiDiskDevice,
2516 &NeedRetry,
2517 Timeout,
2518 PtrBuffer,
2519 &ByteCount,
2520 (UINT32) Lba,
2521 SectorCount
2522 );
2523 } else {
2524 Status = ScsiDiskWrite16 (
2525 ScsiDiskDevice,
2526 &NeedRetry,
2527 Timeout,
2528 PtrBuffer,
2529 &ByteCount,
2530 Lba,
2531 SectorCount
2532 );
2533 }
2534 if (!EFI_ERROR (Status)) {
2535 break;
2536 }
2537
2538 if (!NeedRetry) {
2539 return EFI_DEVICE_ERROR;
2540 }
2541
2542 //
2543 // We need to retry. However, if ScsiDiskWrite10() or ScsiDiskWrite16()
2544 // has lowered ByteCount on output, we must make sure that we lower
2545 // SectorCount accordingly. SectorCount will be encoded in the CDB, and
2546 // it is invalid to request more sectors in the CDB than the entire
2547 // transfer (ie. ByteCount) can carry.
2548 //
2549 // In addition, ByteCount is only expected to go down, or stay unchaged.
2550 // Therefore we don't need to update Timeout: the original timeout should
2551 // accommodate shorter transfers too.
2552 //
2553 NextSectorCount = ByteCount / BlockSize;
2554 if (NextSectorCount < SectorCount) {
2555 SectorCount = NextSectorCount;
2556 //
2557 // Account for any rounding down.
2558 //
2559 ByteCount = SectorCount * BlockSize;
2560 }
2561 }
2562
2563 if ((Index == MaxRetry) && (Status != EFI_SUCCESS)) {
2564 return EFI_DEVICE_ERROR;
2565 }
2566 //
2567 // actual transferred sectors
2568 //
2569 SectorCount = ByteCount / BlockSize;
2570
2571 Lba += SectorCount;
2572 PtrBuffer = PtrBuffer + SectorCount * BlockSize;
2573 BlocksRemaining -= SectorCount;
2574 }
2575
2576 return EFI_SUCCESS;
2577 }
2578
2579 /**
2580 Asynchronously read sector from SCSI Disk.
2581
2582 @param ScsiDiskDevice The pointer of SCSI_DISK_DEV.
2583 @param Buffer The buffer to fill in the read out data.
2584 @param Lba Logic block address.
2585 @param NumberOfBlocks The number of blocks to read.
2586 @param Token A pointer to the token associated with the
2587 non-blocking read request.
2588
2589 @retval EFI_INVALID_PARAMETER Token is NULL or Token->Event is NULL.
2590 @retval EFI_DEVICE_ERROR Indicates a device error.
2591 @retval EFI_SUCCESS Operation is successful.
2592
2593 **/
2594 EFI_STATUS
2595 ScsiDiskAsyncReadSectors (
2596 IN SCSI_DISK_DEV *ScsiDiskDevice,
2597 OUT VOID *Buffer,
2598 IN EFI_LBA Lba,
2599 IN UINTN NumberOfBlocks,
2600 IN EFI_BLOCK_IO2_TOKEN *Token
2601 )
2602 {
2603 UINTN BlocksRemaining;
2604 UINT8 *PtrBuffer;
2605 UINT32 BlockSize;
2606 UINT32 ByteCount;
2607 UINT32 MaxBlock;
2608 UINT32 SectorCount;
2609 UINT64 Timeout;
2610 SCSI_BLKIO2_REQUEST *BlkIo2Req;
2611 EFI_STATUS Status;
2612
2613 if ((Token == NULL) || (Token->Event == NULL)) {
2614 return EFI_INVALID_PARAMETER;
2615 }
2616
2617 BlkIo2Req = AllocateZeroPool (sizeof (SCSI_BLKIO2_REQUEST));
2618 if (BlkIo2Req == NULL) {
2619 return EFI_OUT_OF_RESOURCES;
2620 }
2621
2622 BlkIo2Req->Token = Token;
2623 InsertTailList (&ScsiDiskDevice->BlkIo2Queue, &BlkIo2Req->Link);
2624 InitializeListHead (&BlkIo2Req->ScsiRWQueue);
2625
2626 Status = EFI_SUCCESS;
2627
2628 BlocksRemaining = NumberOfBlocks;
2629 BlockSize = ScsiDiskDevice->BlkIo.Media->BlockSize;
2630
2631 //
2632 // Limit the data bytes that can be transferred by one Read(10) or Read(16)
2633 // Command
2634 //
2635 if (!ScsiDiskDevice->Cdb16Byte) {
2636 MaxBlock = 0xFFFF;
2637 } else {
2638 MaxBlock = 0xFFFFFFFF;
2639 }
2640
2641 PtrBuffer = Buffer;
2642
2643 while (BlocksRemaining > 0) {
2644
2645 if (BlocksRemaining <= MaxBlock) {
2646 if (!ScsiDiskDevice->Cdb16Byte) {
2647 SectorCount = (UINT16) BlocksRemaining;
2648 } else {
2649 SectorCount = (UINT32) BlocksRemaining;
2650 }
2651 } else {
2652 SectorCount = MaxBlock;
2653 }
2654
2655 ByteCount = SectorCount * BlockSize;
2656 //
2657 // |------------------------|-----------------|------------------|-----------------|
2658 // | ATA Transfer Mode | Transfer Rate | SCSI Interface | Transfer Rate |
2659 // |------------------------|-----------------|------------------|-----------------|
2660 // | PIO Mode 0 | 3.3Mbytes/sec | SCSI-1 | 5Mbytes/sec |
2661 // |------------------------|-----------------|------------------|-----------------|
2662 // | PIO Mode 1 | 5.2Mbytes/sec | Fast SCSI | 10Mbytes/sec |
2663 // |------------------------|-----------------|------------------|-----------------|
2664 // | PIO Mode 2 | 8.3Mbytes/sec | Fast-Wide SCSI | 20Mbytes/sec |
2665 // |------------------------|-----------------|------------------|-----------------|
2666 // | PIO Mode 3 | 11.1Mbytes/sec | Ultra SCSI | 20Mbytes/sec |
2667 // |------------------------|-----------------|------------------|-----------------|
2668 // | PIO Mode 4 | 16.6Mbytes/sec | Ultra Wide SCSI | 40Mbytes/sec |
2669 // |------------------------|-----------------|------------------|-----------------|
2670 // | Single-word DMA Mode 0 | 2.1Mbytes/sec | Ultra2 SCSI | 40Mbytes/sec |
2671 // |------------------------|-----------------|------------------|-----------------|
2672 // | Single-word DMA Mode 1 | 4.2Mbytes/sec | Ultra2 Wide SCSI | 80Mbytes/sec |
2673 // |------------------------|-----------------|------------------|-----------------|
2674 // | Single-word DMA Mode 2 | 8.4Mbytes/sec | Ultra3 SCSI | 160Mbytes/sec |
2675 // |------------------------|-----------------|------------------|-----------------|
2676 // | Multi-word DMA Mode 0 | 4.2Mbytes/sec | Ultra-320 SCSI | 320Mbytes/sec |
2677 // |------------------------|-----------------|------------------|-----------------|
2678 // | Multi-word DMA Mode 1 | 13.3Mbytes/sec | Ultra-640 SCSI | 640Mbytes/sec |
2679 // |------------------------|-----------------|------------------|-----------------|
2680 //
2681 // As ScsiDisk and ScsiBus driver are used to manage SCSI or ATAPI devices,
2682 // we have to use the lowest transfer rate to calculate the possible
2683 // maximum timeout value for each operation.
2684 // From the above table, we could know 2.1Mbytes per second is lowest one.
2685 // The timout value is rounded up to nearest integar and here an additional
2686 // 30s is added to follow ATA spec in which it mentioned that the device
2687 // may take up to 30s to respond commands in the Standby/Idle mode.
2688 //
2689 Timeout = EFI_TIMER_PERIOD_SECONDS (ByteCount / 2100000 + 31);
2690
2691 if (!ScsiDiskDevice->Cdb16Byte) {
2692 Status = ScsiDiskAsyncRead10 (
2693 ScsiDiskDevice,
2694 Timeout,
2695 0,
2696 PtrBuffer,
2697 ByteCount,
2698 (UINT32) Lba,
2699 SectorCount,
2700 BlkIo2Req,
2701 Token
2702 );
2703 } else {
2704 Status = ScsiDiskAsyncRead16 (
2705 ScsiDiskDevice,
2706 Timeout,
2707 0,
2708 PtrBuffer,
2709 ByteCount,
2710 Lba,
2711 SectorCount,
2712 BlkIo2Req,
2713 Token
2714 );
2715 }
2716 if (EFI_ERROR (Status)) {
2717 //
2718 // Some devices will return EFI_DEVICE_ERROR or EFI_TIMEOUT when the data
2719 // length of a SCSI I/O command is too large.
2720 // In this case, we retry sending the SCSI command with a data length
2721 // half of its previous value.
2722 //
2723 if ((Status == EFI_DEVICE_ERROR) || (Status == EFI_TIMEOUT)) {
2724 if ((MaxBlock > 1) && (SectorCount > 1)) {
2725 MaxBlock = MIN (MaxBlock, SectorCount) >> 1;
2726 continue;
2727 }
2728 }
2729
2730 if (IsListEmpty (&BlkIo2Req->ScsiRWQueue)) {
2731 //
2732 // Free the SCSI_BLKIO2_REQUEST structure only when there is no other
2733 // SCSI sub-task running. Otherwise, it will be freed in the callback
2734 // function ScsiDiskNotify().
2735 //
2736 RemoveEntryList (&BlkIo2Req->Link);
2737 FreePool (BlkIo2Req);
2738
2739 //
2740 // It is safe to return error status to the caller, since there is no
2741 // previous SCSI sub-task executing.
2742 //
2743 return EFI_DEVICE_ERROR;
2744 } else {
2745 //
2746 // There are previous SCSI commands still running, EFI_SUCCESS should
2747 // be returned to make sure that the caller does not free resources
2748 // still using by these SCSI commands.
2749 //
2750 return EFI_SUCCESS;
2751 }
2752 }
2753
2754 //
2755 // Sectors submitted for transfer
2756 //
2757 SectorCount = ByteCount / BlockSize;
2758
2759 Lba += SectorCount;
2760 PtrBuffer = PtrBuffer + SectorCount * BlockSize;
2761 BlocksRemaining -= SectorCount;
2762 }
2763
2764 return EFI_SUCCESS;
2765 }
2766
2767 /**
2768 Asynchronously write sector to SCSI Disk.
2769
2770 @param ScsiDiskDevice The pointer of SCSI_DISK_DEV.
2771 @param Buffer The buffer of data to be written into SCSI Disk.
2772 @param Lba Logic block address.
2773 @param NumberOfBlocks The number of blocks to read.
2774 @param Token A pointer to the token associated with the
2775 non-blocking read request.
2776
2777 @retval EFI_INVALID_PARAMETER Token is NULL or Token->Event is NULL
2778 @retval EFI_DEVICE_ERROR Indicates a device error.
2779 @retval EFI_SUCCESS Operation is successful.
2780
2781 **/
2782 EFI_STATUS
2783 ScsiDiskAsyncWriteSectors (
2784 IN SCSI_DISK_DEV *ScsiDiskDevice,
2785 IN VOID *Buffer,
2786 IN EFI_LBA Lba,
2787 IN UINTN NumberOfBlocks,
2788 IN EFI_BLOCK_IO2_TOKEN *Token
2789 )
2790 {
2791 UINTN BlocksRemaining;
2792 UINT8 *PtrBuffer;
2793 UINT32 BlockSize;
2794 UINT32 ByteCount;
2795 UINT32 MaxBlock;
2796 UINT32 SectorCount;
2797 UINT64 Timeout;
2798 SCSI_BLKIO2_REQUEST *BlkIo2Req;
2799 EFI_STATUS Status;
2800
2801 if ((Token == NULL) || (Token->Event == NULL)) {
2802 return EFI_INVALID_PARAMETER;
2803 }
2804
2805 BlkIo2Req = AllocateZeroPool (sizeof (SCSI_BLKIO2_REQUEST));
2806 if (BlkIo2Req == NULL) {
2807 return EFI_OUT_OF_RESOURCES;
2808 }
2809
2810 BlkIo2Req->Token = Token;
2811 InsertTailList (&ScsiDiskDevice->BlkIo2Queue, &BlkIo2Req->Link);
2812 InitializeListHead (&BlkIo2Req->ScsiRWQueue);
2813
2814 Status = EFI_SUCCESS;
2815
2816 BlocksRemaining = NumberOfBlocks;
2817 BlockSize = ScsiDiskDevice->BlkIo.Media->BlockSize;
2818
2819 //
2820 // Limit the data bytes that can be transferred by one Read(10) or Read(16)
2821 // Command
2822 //
2823 if (!ScsiDiskDevice->Cdb16Byte) {
2824 MaxBlock = 0xFFFF;
2825 } else {
2826 MaxBlock = 0xFFFFFFFF;
2827 }
2828
2829 PtrBuffer = Buffer;
2830
2831 while (BlocksRemaining > 0) {
2832
2833 if (BlocksRemaining <= MaxBlock) {
2834 if (!ScsiDiskDevice->Cdb16Byte) {
2835 SectorCount = (UINT16) BlocksRemaining;
2836 } else {
2837 SectorCount = (UINT32) BlocksRemaining;
2838 }
2839 } else {
2840 SectorCount = MaxBlock;
2841 }
2842
2843 ByteCount = SectorCount * BlockSize;
2844 //
2845 // |------------------------|-----------------|------------------|-----------------|
2846 // | ATA Transfer Mode | Transfer Rate | SCSI Interface | Transfer Rate |
2847 // |------------------------|-----------------|------------------|-----------------|
2848 // | PIO Mode 0 | 3.3Mbytes/sec | SCSI-1 | 5Mbytes/sec |
2849 // |------------------------|-----------------|------------------|-----------------|
2850 // | PIO Mode 1 | 5.2Mbytes/sec | Fast SCSI | 10Mbytes/sec |
2851 // |------------------------|-----------------|------------------|-----------------|
2852 // | PIO Mode 2 | 8.3Mbytes/sec | Fast-Wide SCSI | 20Mbytes/sec |
2853 // |------------------------|-----------------|------------------|-----------------|
2854 // | PIO Mode 3 | 11.1Mbytes/sec | Ultra SCSI | 20Mbytes/sec |
2855 // |------------------------|-----------------|------------------|-----------------|
2856 // | PIO Mode 4 | 16.6Mbytes/sec | Ultra Wide SCSI | 40Mbytes/sec |
2857 // |------------------------|-----------------|------------------|-----------------|
2858 // | Single-word DMA Mode 0 | 2.1Mbytes/sec | Ultra2 SCSI | 40Mbytes/sec |
2859 // |------------------------|-----------------|------------------|-----------------|
2860 // | Single-word DMA Mode 1 | 4.2Mbytes/sec | Ultra2 Wide SCSI | 80Mbytes/sec |
2861 // |------------------------|-----------------|------------------|-----------------|
2862 // | Single-word DMA Mode 2 | 8.4Mbytes/sec | Ultra3 SCSI | 160Mbytes/sec |
2863 // |------------------------|-----------------|------------------|-----------------|
2864 // | Multi-word DMA Mode 0 | 4.2Mbytes/sec | Ultra-320 SCSI | 320Mbytes/sec |
2865 // |------------------------|-----------------|------------------|-----------------|
2866 // | Multi-word DMA Mode 1 | 13.3Mbytes/sec | Ultra-640 SCSI | 640Mbytes/sec |
2867 // |------------------------|-----------------|------------------|-----------------|
2868 //
2869 // As ScsiDisk and ScsiBus driver are used to manage SCSI or ATAPI devices,
2870 // we have to use the lowest transfer rate to calculate the possible
2871 // maximum timeout value for each operation.
2872 // From the above table, we could know 2.1Mbytes per second is lowest one.
2873 // The timout value is rounded up to nearest integar and here an additional
2874 // 30s is added to follow ATA spec in which it mentioned that the device
2875 // may take up to 30s to respond commands in the Standby/Idle mode.
2876 //
2877 Timeout = EFI_TIMER_PERIOD_SECONDS (ByteCount / 2100000 + 31);
2878
2879 if (!ScsiDiskDevice->Cdb16Byte) {
2880 Status = ScsiDiskAsyncWrite10 (
2881 ScsiDiskDevice,
2882 Timeout,
2883 0,
2884 PtrBuffer,
2885 ByteCount,
2886 (UINT32) Lba,
2887 SectorCount,
2888 BlkIo2Req,
2889 Token
2890 );
2891 } else {
2892 Status = ScsiDiskAsyncWrite16 (
2893 ScsiDiskDevice,
2894 Timeout,
2895 0,
2896 PtrBuffer,
2897 ByteCount,
2898 Lba,
2899 SectorCount,
2900 BlkIo2Req,
2901 Token
2902 );
2903 }
2904 if (EFI_ERROR (Status)) {
2905 //
2906 // Some devices will return EFI_DEVICE_ERROR or EFI_TIMEOUT when the data
2907 // length of a SCSI I/O command is too large.
2908 // In this case, we retry sending the SCSI command with a data length
2909 // half of its previous value.
2910 //
2911 if ((Status == EFI_DEVICE_ERROR) || (Status == EFI_TIMEOUT)) {
2912 if ((MaxBlock > 1) && (SectorCount > 1)) {
2913 MaxBlock = MIN (MaxBlock, SectorCount) >> 1;
2914 continue;
2915 }
2916 }
2917
2918 if (IsListEmpty (&BlkIo2Req->ScsiRWQueue)) {
2919 //
2920 // Free the SCSI_BLKIO2_REQUEST structure only when there is no other
2921 // SCSI sub-task running. Otherwise, it will be freed in the callback
2922 // function ScsiDiskNotify().
2923 //
2924 RemoveEntryList (&BlkIo2Req->Link);
2925 FreePool (BlkIo2Req);
2926
2927 //
2928 // It is safe to return error status to the caller, since there is no
2929 // previous SCSI sub-task executing.
2930 //
2931 return EFI_DEVICE_ERROR;
2932 } else {
2933 //
2934 // There are previous SCSI commands still running, EFI_SUCCESS should
2935 // be returned to make sure that the caller does not free resources
2936 // still using by these SCSI commands.
2937 //
2938 return EFI_SUCCESS;
2939 }
2940 }
2941
2942 //
2943 // Sectors submitted for transfer
2944 //
2945 SectorCount = ByteCount / BlockSize;
2946
2947 Lba += SectorCount;
2948 PtrBuffer = PtrBuffer + SectorCount * BlockSize;
2949 BlocksRemaining -= SectorCount;
2950 }
2951
2952 return EFI_SUCCESS;
2953 }
2954
2955
2956 /**
2957 Submit Read(10) command.
2958
2959 @param ScsiDiskDevice The pointer of ScsiDiskDevice
2960 @param NeedRetry The pointer of flag indicates if needs retry if error happens
2961 @param Timeout The time to complete the command
2962 @param DataBuffer The buffer to fill with the read out data
2963 @param DataLength The length of buffer
2964 @param StartLba The start logic block address
2965 @param SectorCount The number of blocks to read
2966
2967 @return EFI_STATUS is returned by calling ScsiRead10Command().
2968 **/
2969 EFI_STATUS
2970 ScsiDiskRead10 (
2971 IN SCSI_DISK_DEV *ScsiDiskDevice,
2972 OUT BOOLEAN *NeedRetry,
2973 IN UINT64 Timeout,
2974 OUT UINT8 *DataBuffer,
2975 IN OUT UINT32 *DataLength,
2976 IN UINT32 StartLba,
2977 IN UINT32 SectorCount
2978 )
2979 {
2980 UINT8 SenseDataLength;
2981 EFI_STATUS Status;
2982 EFI_STATUS ReturnStatus;
2983 UINT8 HostAdapterStatus;
2984 UINT8 TargetStatus;
2985 UINTN Action;
2986
2987 //
2988 // Implement a backoff algorithem to resolve some compatibility issues that
2989 // some SCSI targets or ATAPI devices couldn't correctly response reading/writing
2990 // big data in a single operation.
2991 // This algorithem will at first try to execute original request. If the request fails
2992 // with media error sense data or else, it will reduce the transfer length to half and
2993 // try again till the operation succeeds or fails with one sector transfer length.
2994 //
2995 BackOff:
2996 *NeedRetry = FALSE;
2997 Action = ACTION_NO_ACTION;
2998 SenseDataLength = (UINT8) (ScsiDiskDevice->SenseDataNumber * sizeof (EFI_SCSI_SENSE_DATA));
2999 ReturnStatus = ScsiRead10Command (
3000 ScsiDiskDevice->ScsiIo,
3001 Timeout,
3002 ScsiDiskDevice->SenseData,
3003 &SenseDataLength,
3004 &HostAdapterStatus,
3005 &TargetStatus,
3006 DataBuffer,
3007 DataLength,
3008 StartLba,
3009 SectorCount
3010 );
3011
3012 if (ReturnStatus == EFI_NOT_READY || ReturnStatus == EFI_BAD_BUFFER_SIZE) {
3013 *NeedRetry = TRUE;
3014 return EFI_DEVICE_ERROR;
3015 } else if ((ReturnStatus == EFI_INVALID_PARAMETER) || (ReturnStatus == EFI_UNSUPPORTED)) {
3016 *NeedRetry = FALSE;
3017 return ReturnStatus;
3018 }
3019
3020 //
3021 // go ahead to check HostAdapterStatus and TargetStatus
3022 // (EFI_TIMEOUT, EFI_DEVICE_ERROR, EFI_WARN_BUFFER_TOO_SMALL)
3023 //
3024 Status = CheckHostAdapterStatus (HostAdapterStatus);
3025 if ((Status == EFI_TIMEOUT) || (Status == EFI_NOT_READY)) {
3026 *NeedRetry = TRUE;
3027 return EFI_DEVICE_ERROR;
3028 } else if (Status == EFI_DEVICE_ERROR) {
3029 //
3030 // reset the scsi channel
3031 //
3032 ScsiDiskDevice->ScsiIo->ResetBus (ScsiDiskDevice->ScsiIo);
3033 *NeedRetry = FALSE;
3034 return EFI_DEVICE_ERROR;
3035 }
3036
3037 Status = CheckTargetStatus (TargetStatus);
3038 if (Status == EFI_NOT_READY) {
3039 //
3040 // reset the scsi device
3041 //
3042 ScsiDiskDevice->ScsiIo->ResetDevice (ScsiDiskDevice->ScsiIo);
3043 *NeedRetry = TRUE;
3044 return EFI_DEVICE_ERROR;
3045 } else if (Status == EFI_DEVICE_ERROR) {
3046 *NeedRetry = FALSE;
3047 return EFI_DEVICE_ERROR;
3048 }
3049
3050 if ((TargetStatus == EFI_EXT_SCSI_STATUS_TARGET_CHECK_CONDITION) || (EFI_ERROR (ReturnStatus))) {
3051 DEBUG ((EFI_D_ERROR, "ScsiDiskRead10: Check Condition happened!\n"));
3052 Status = DetectMediaParsingSenseKeys (ScsiDiskDevice, ScsiDiskDevice->SenseData, SenseDataLength / sizeof (EFI_SCSI_SENSE_DATA), &Action);
3053 if (Action == ACTION_RETRY_COMMAND_LATER) {
3054 *NeedRetry = TRUE;
3055 return EFI_DEVICE_ERROR;
3056 } else if (Action == ACTION_RETRY_WITH_BACKOFF_ALGO) {
3057 if (SectorCount <= 1) {
3058 //
3059 // Jump out if the operation still fails with one sector transfer length.
3060 //
3061 *NeedRetry = FALSE;
3062 return EFI_DEVICE_ERROR;
3063 }
3064 //
3065 // Try again with half length if the sense data shows we need to retry.
3066 //
3067 SectorCount >>= 1;
3068 *DataLength = SectorCount * ScsiDiskDevice->BlkIo.Media->BlockSize;
3069 goto BackOff;
3070 } else {
3071 *NeedRetry = FALSE;
3072 return EFI_DEVICE_ERROR;
3073 }
3074 }
3075
3076 return ReturnStatus;
3077 }
3078
3079
3080 /**
3081 Submit Write(10) Command.
3082
3083 @param ScsiDiskDevice The pointer of ScsiDiskDevice
3084 @param NeedRetry The pointer of flag indicates if needs retry if error happens
3085 @param Timeout The time to complete the command
3086 @param DataBuffer The buffer to fill with the read out data
3087 @param DataLength The length of buffer
3088 @param StartLba The start logic block address
3089 @param SectorCount The number of blocks to write
3090
3091 @return EFI_STATUS is returned by calling ScsiWrite10Command().
3092
3093 **/
3094 EFI_STATUS
3095 ScsiDiskWrite10 (
3096 IN SCSI_DISK_DEV *ScsiDiskDevice,
3097 OUT BOOLEAN *NeedRetry,
3098 IN UINT64 Timeout,
3099 IN UINT8 *DataBuffer,
3100 IN OUT UINT32 *DataLength,
3101 IN UINT32 StartLba,
3102 IN UINT32 SectorCount
3103 )
3104 {
3105 EFI_STATUS Status;
3106 EFI_STATUS ReturnStatus;
3107 UINT8 SenseDataLength;
3108 UINT8 HostAdapterStatus;
3109 UINT8 TargetStatus;
3110 UINTN Action;
3111
3112 //
3113 // Implement a backoff algorithem to resolve some compatibility issues that
3114 // some SCSI targets or ATAPI devices couldn't correctly response reading/writing
3115 // big data in a single operation.
3116 // This algorithem will at first try to execute original request. If the request fails
3117 // with media error sense data or else, it will reduce the transfer length to half and
3118 // try again till the operation succeeds or fails with one sector transfer length.
3119 //
3120 BackOff:
3121 *NeedRetry = FALSE;
3122 Action = ACTION_NO_ACTION;
3123 SenseDataLength = (UINT8) (ScsiDiskDevice->SenseDataNumber * sizeof (EFI_SCSI_SENSE_DATA));
3124 ReturnStatus = ScsiWrite10Command (
3125 ScsiDiskDevice->ScsiIo,
3126 Timeout,
3127 ScsiDiskDevice->SenseData,
3128 &SenseDataLength,
3129 &HostAdapterStatus,
3130 &TargetStatus,
3131 DataBuffer,
3132 DataLength,
3133 StartLba,
3134 SectorCount
3135 );
3136 if (ReturnStatus == EFI_NOT_READY || ReturnStatus == EFI_BAD_BUFFER_SIZE) {
3137 *NeedRetry = TRUE;
3138 return EFI_DEVICE_ERROR;
3139 } else if ((ReturnStatus == EFI_INVALID_PARAMETER) || (ReturnStatus == EFI_UNSUPPORTED)) {
3140 *NeedRetry = FALSE;
3141 return ReturnStatus;
3142 }
3143
3144 //
3145 // go ahead to check HostAdapterStatus and TargetStatus
3146 // (EFI_TIMEOUT, EFI_DEVICE_ERROR, EFI_WARN_BUFFER_TOO_SMALL)
3147 //
3148 Status = CheckHostAdapterStatus (HostAdapterStatus);
3149 if ((Status == EFI_TIMEOUT) || (Status == EFI_NOT_READY)) {
3150 *NeedRetry = TRUE;
3151 return EFI_DEVICE_ERROR;
3152 } else if (Status == EFI_DEVICE_ERROR) {
3153 //
3154 // reset the scsi channel
3155 //
3156 ScsiDiskDevice->ScsiIo->ResetBus (ScsiDiskDevice->ScsiIo);
3157 *NeedRetry = FALSE;
3158 return EFI_DEVICE_ERROR;
3159 }
3160
3161 Status = CheckTargetStatus (TargetStatus);
3162 if (Status == EFI_NOT_READY) {
3163 //
3164 // reset the scsi device
3165 //
3166 ScsiDiskDevice->ScsiIo->ResetDevice (ScsiDiskDevice->ScsiIo);
3167 *NeedRetry = TRUE;
3168 return EFI_DEVICE_ERROR;
3169 } else if (Status == EFI_DEVICE_ERROR) {
3170 *NeedRetry = FALSE;
3171 return EFI_DEVICE_ERROR;
3172 }
3173
3174 if ((TargetStatus == EFI_EXT_SCSI_STATUS_TARGET_CHECK_CONDITION) || (EFI_ERROR (ReturnStatus))) {
3175 DEBUG ((EFI_D_ERROR, "ScsiDiskWrite10: Check Condition happened!\n"));
3176 Status = DetectMediaParsingSenseKeys (ScsiDiskDevice, ScsiDiskDevice->SenseData, SenseDataLength / sizeof (EFI_SCSI_SENSE_DATA), &Action);
3177 if (Action == ACTION_RETRY_COMMAND_LATER) {
3178 *NeedRetry = TRUE;
3179 return EFI_DEVICE_ERROR;
3180 } else if (Action == ACTION_RETRY_WITH_BACKOFF_ALGO) {
3181 if (SectorCount <= 1) {
3182 //
3183 // Jump out if the operation still fails with one sector transfer length.
3184 //
3185 *NeedRetry = FALSE;
3186 return EFI_DEVICE_ERROR;
3187 }
3188 //
3189 // Try again with half length if the sense data shows we need to retry.
3190 //
3191 SectorCount >>= 1;
3192 *DataLength = SectorCount * ScsiDiskDevice->BlkIo.Media->BlockSize;
3193 goto BackOff;
3194 } else {
3195 *NeedRetry = FALSE;
3196 return EFI_DEVICE_ERROR;
3197 }
3198 }
3199
3200 return ReturnStatus;
3201 }
3202
3203
3204 /**
3205 Submit Read(16) command.
3206
3207 @param ScsiDiskDevice The pointer of ScsiDiskDevice
3208 @param NeedRetry The pointer of flag indicates if needs retry if error happens
3209 @param Timeout The time to complete the command
3210 @param DataBuffer The buffer to fill with the read out data
3211 @param DataLength The length of buffer
3212 @param StartLba The start logic block address
3213 @param SectorCount The number of blocks to read
3214
3215 @return EFI_STATUS is returned by calling ScsiRead16Command().
3216 **/
3217 EFI_STATUS
3218 ScsiDiskRead16 (
3219 IN SCSI_DISK_DEV *ScsiDiskDevice,
3220 OUT BOOLEAN *NeedRetry,
3221 IN UINT64 Timeout,
3222 OUT UINT8 *DataBuffer,
3223 IN OUT UINT32 *DataLength,
3224 IN UINT64 StartLba,
3225 IN UINT32 SectorCount
3226 )
3227 {
3228 UINT8 SenseDataLength;
3229 EFI_STATUS Status;
3230 EFI_STATUS ReturnStatus;
3231 UINT8 HostAdapterStatus;
3232 UINT8 TargetStatus;
3233 UINTN Action;
3234
3235 //
3236 // Implement a backoff algorithem to resolve some compatibility issues that
3237 // some SCSI targets or ATAPI devices couldn't correctly response reading/writing
3238 // big data in a single operation.
3239 // This algorithem will at first try to execute original request. If the request fails
3240 // with media error sense data or else, it will reduce the transfer length to half and
3241 // try again till the operation succeeds or fails with one sector transfer length.
3242 //
3243 BackOff:
3244 *NeedRetry = FALSE;
3245 Action = ACTION_NO_ACTION;
3246 SenseDataLength = (UINT8) (ScsiDiskDevice->SenseDataNumber * sizeof (EFI_SCSI_SENSE_DATA));
3247 ReturnStatus = ScsiRead16Command (
3248 ScsiDiskDevice->ScsiIo,
3249 Timeout,
3250 ScsiDiskDevice->SenseData,
3251 &SenseDataLength,
3252 &HostAdapterStatus,
3253 &TargetStatus,
3254 DataBuffer,
3255 DataLength,
3256 StartLba,
3257 SectorCount
3258 );
3259 if (ReturnStatus == EFI_NOT_READY || ReturnStatus == EFI_BAD_BUFFER_SIZE) {
3260 *NeedRetry = TRUE;
3261 return EFI_DEVICE_ERROR;
3262 } else if ((ReturnStatus == EFI_INVALID_PARAMETER) || (ReturnStatus == EFI_UNSUPPORTED)) {
3263 *NeedRetry = FALSE;
3264 return ReturnStatus;
3265 }
3266
3267 //
3268 // go ahead to check HostAdapterStatus and TargetStatus
3269 // (EFI_TIMEOUT, EFI_DEVICE_ERROR, EFI_WARN_BUFFER_TOO_SMALL)
3270 //
3271 Status = CheckHostAdapterStatus (HostAdapterStatus);
3272 if ((Status == EFI_TIMEOUT) || (Status == EFI_NOT_READY)) {
3273 *NeedRetry = TRUE;
3274 return EFI_DEVICE_ERROR;
3275 } else if (Status == EFI_DEVICE_ERROR) {
3276 //
3277 // reset the scsi channel
3278 //
3279 ScsiDiskDevice->ScsiIo->ResetBus (ScsiDiskDevice->ScsiIo);
3280 *NeedRetry = FALSE;
3281 return EFI_DEVICE_ERROR;
3282 }
3283
3284 Status = CheckTargetStatus (TargetStatus);
3285 if (Status == EFI_NOT_READY) {
3286 //
3287 // reset the scsi device
3288 //
3289 ScsiDiskDevice->ScsiIo->ResetDevice (ScsiDiskDevice->ScsiIo);
3290 *NeedRetry = TRUE;
3291 return EFI_DEVICE_ERROR;
3292 } else if (Status == EFI_DEVICE_ERROR) {
3293 *NeedRetry = FALSE;
3294 return EFI_DEVICE_ERROR;
3295 }
3296
3297 if ((TargetStatus == EFI_EXT_SCSI_STATUS_TARGET_CHECK_CONDITION) || (EFI_ERROR (ReturnStatus))) {
3298 DEBUG ((EFI_D_ERROR, "ScsiDiskRead16: Check Condition happened!\n"));
3299 Status = DetectMediaParsingSenseKeys (ScsiDiskDevice, ScsiDiskDevice->SenseData, SenseDataLength / sizeof (EFI_SCSI_SENSE_DATA), &Action);
3300 if (Action == ACTION_RETRY_COMMAND_LATER) {
3301 *NeedRetry = TRUE;
3302 return EFI_DEVICE_ERROR;
3303 } else if (Action == ACTION_RETRY_WITH_BACKOFF_ALGO) {
3304 if (SectorCount <= 1) {
3305 //
3306 // Jump out if the operation still fails with one sector transfer length.
3307 //
3308 *NeedRetry = FALSE;
3309 return EFI_DEVICE_ERROR;
3310 }
3311 //
3312 // Try again with half length if the sense data shows we need to retry.
3313 //
3314 SectorCount >>= 1;
3315 *DataLength = SectorCount * ScsiDiskDevice->BlkIo.Media->BlockSize;
3316 goto BackOff;
3317 } else {
3318 *NeedRetry = FALSE;
3319 return EFI_DEVICE_ERROR;
3320 }
3321 }
3322
3323 return ReturnStatus;
3324 }
3325
3326
3327 /**
3328 Submit Write(16) Command.
3329
3330 @param ScsiDiskDevice The pointer of ScsiDiskDevice
3331 @param NeedRetry The pointer of flag indicates if needs retry if error happens
3332 @param Timeout The time to complete the command
3333 @param DataBuffer The buffer to fill with the read out data
3334 @param DataLength The length of buffer
3335 @param StartLba The start logic block address
3336 @param SectorCount The number of blocks to write
3337
3338 @return EFI_STATUS is returned by calling ScsiWrite16Command().
3339
3340 **/
3341 EFI_STATUS
3342 ScsiDiskWrite16 (
3343 IN SCSI_DISK_DEV *ScsiDiskDevice,
3344 OUT BOOLEAN *NeedRetry,
3345 IN UINT64 Timeout,
3346 IN UINT8 *DataBuffer,
3347 IN OUT UINT32 *DataLength,
3348 IN UINT64 StartLba,
3349 IN UINT32 SectorCount
3350 )
3351 {
3352 EFI_STATUS Status;
3353 EFI_STATUS ReturnStatus;
3354 UINT8 SenseDataLength;
3355 UINT8 HostAdapterStatus;
3356 UINT8 TargetStatus;
3357 UINTN Action;
3358
3359 //
3360 // Implement a backoff algorithem to resolve some compatibility issues that
3361 // some SCSI targets or ATAPI devices couldn't correctly response reading/writing
3362 // big data in a single operation.
3363 // This algorithem will at first try to execute original request. If the request fails
3364 // with media error sense data or else, it will reduce the transfer length to half and
3365 // try again till the operation succeeds or fails with one sector transfer length.
3366 //
3367 BackOff:
3368 *NeedRetry = FALSE;
3369 Action = ACTION_NO_ACTION;
3370 SenseDataLength = (UINT8) (ScsiDiskDevice->SenseDataNumber * sizeof (EFI_SCSI_SENSE_DATA));
3371 ReturnStatus = ScsiWrite16Command (
3372 ScsiDiskDevice->ScsiIo,
3373 Timeout,
3374 ScsiDiskDevice->SenseData,
3375 &SenseDataLength,
3376 &HostAdapterStatus,
3377 &TargetStatus,
3378 DataBuffer,
3379 DataLength,
3380 StartLba,
3381 SectorCount
3382 );
3383 if (ReturnStatus == EFI_NOT_READY || ReturnStatus == EFI_BAD_BUFFER_SIZE) {
3384 *NeedRetry = TRUE;
3385 return EFI_DEVICE_ERROR;
3386 } else if ((ReturnStatus == EFI_INVALID_PARAMETER) || (ReturnStatus == EFI_UNSUPPORTED)) {
3387 *NeedRetry = FALSE;
3388 return ReturnStatus;
3389 }
3390
3391 //
3392 // go ahead to check HostAdapterStatus and TargetStatus
3393 // (EFI_TIMEOUT, EFI_DEVICE_ERROR, EFI_WARN_BUFFER_TOO_SMALL)
3394 //
3395 Status = CheckHostAdapterStatus (HostAdapterStatus);
3396 if ((Status == EFI_TIMEOUT) || (Status == EFI_NOT_READY)) {
3397 *NeedRetry = TRUE;
3398 return EFI_DEVICE_ERROR;
3399 } else if (Status == EFI_DEVICE_ERROR) {
3400 //
3401 // reset the scsi channel
3402 //
3403 ScsiDiskDevice->ScsiIo->ResetBus (ScsiDiskDevice->ScsiIo);
3404 *NeedRetry = FALSE;
3405 return EFI_DEVICE_ERROR;
3406 }
3407
3408 Status = CheckTargetStatus (TargetStatus);
3409 if (Status == EFI_NOT_READY) {
3410 //
3411 // reset the scsi device
3412 //
3413 ScsiDiskDevice->ScsiIo->ResetDevice (ScsiDiskDevice->ScsiIo);
3414 *NeedRetry = TRUE;
3415 return EFI_DEVICE_ERROR;
3416 } else if (Status == EFI_DEVICE_ERROR) {
3417 *NeedRetry = FALSE;
3418 return EFI_DEVICE_ERROR;
3419 }
3420
3421 if ((TargetStatus == EFI_EXT_SCSI_STATUS_TARGET_CHECK_CONDITION) || (EFI_ERROR (ReturnStatus))) {
3422 DEBUG ((EFI_D_ERROR, "ScsiDiskWrite16: Check Condition happened!\n"));
3423 Status = DetectMediaParsingSenseKeys (ScsiDiskDevice, ScsiDiskDevice->SenseData, SenseDataLength / sizeof (EFI_SCSI_SENSE_DATA), &Action);
3424 if (Action == ACTION_RETRY_COMMAND_LATER) {
3425 *NeedRetry = TRUE;
3426 return EFI_DEVICE_ERROR;
3427 } else if (Action == ACTION_RETRY_WITH_BACKOFF_ALGO) {
3428 if (SectorCount <= 1) {
3429 //
3430 // Jump out if the operation still fails with one sector transfer length.
3431 //
3432 *NeedRetry = FALSE;
3433 return EFI_DEVICE_ERROR;
3434 }
3435 //
3436 // Try again with half length if the sense data shows we need to retry.
3437 //
3438 SectorCount >>= 1;
3439 *DataLength = SectorCount * ScsiDiskDevice->BlkIo.Media->BlockSize;
3440 goto BackOff;
3441 } else {
3442 *NeedRetry = FALSE;
3443 return EFI_DEVICE_ERROR;
3444 }
3445 }
3446
3447 return ReturnStatus;
3448 }
3449
3450
3451 /**
3452 Internal helper notify function in which determine whether retry of a SCSI
3453 Read/Write command is needed and signal the event passed from Block I/O(2) if
3454 the SCSI I/O operation completes.
3455
3456 @param Event The instance of EFI_EVENT.
3457 @param Context The parameter passed in.
3458
3459 **/
3460 VOID
3461 EFIAPI
3462 ScsiDiskNotify (
3463 IN EFI_EVENT Event,
3464 IN VOID *Context
3465 )
3466 {
3467 EFI_STATUS Status;
3468 SCSI_ASYNC_RW_REQUEST *Request;
3469 SCSI_DISK_DEV *ScsiDiskDevice;
3470 EFI_BLOCK_IO2_TOKEN *Token;
3471 UINTN Action;
3472 UINT32 OldDataLength;
3473 UINT32 OldSectorCount;
3474 UINT8 MaxRetry;
3475
3476 gBS->CloseEvent (Event);
3477
3478 Request = (SCSI_ASYNC_RW_REQUEST *) Context;
3479 ScsiDiskDevice = Request->ScsiDiskDevice;
3480 Token = Request->BlkIo2Req->Token;
3481 OldDataLength = Request->DataLength;
3482 OldSectorCount = Request->SectorCount;
3483 MaxRetry = 2;
3484
3485 //
3486 // If previous sub-tasks already fails, no need to process this sub-task.
3487 //
3488 if (Token->TransactionStatus != EFI_SUCCESS) {
3489 goto Exit;
3490 }
3491
3492 //
3493 // Check HostAdapterStatus and TargetStatus
3494 // (EFI_TIMEOUT, EFI_DEVICE_ERROR, EFI_WARN_BUFFER_TOO_SMALL)
3495 //
3496 Status = CheckHostAdapterStatus (Request->HostAdapterStatus);
3497 if ((Status == EFI_TIMEOUT) || (Status == EFI_NOT_READY)) {
3498 if (++Request->TimesRetry > MaxRetry) {
3499 Token->TransactionStatus = EFI_DEVICE_ERROR;
3500 goto Exit;
3501 } else {
3502 goto Retry;
3503 }
3504 } else if (Status == EFI_DEVICE_ERROR) {
3505 //
3506 // reset the scsi channel
3507 //
3508 ScsiDiskDevice->ScsiIo->ResetBus (ScsiDiskDevice->ScsiIo);
3509 Token->TransactionStatus = EFI_DEVICE_ERROR;
3510 goto Exit;
3511 }
3512
3513 Status = CheckTargetStatus (Request->TargetStatus);
3514 if (Status == EFI_NOT_READY) {
3515 //
3516 // reset the scsi device
3517 //
3518 ScsiDiskDevice->ScsiIo->ResetDevice (ScsiDiskDevice->ScsiIo);
3519 if (++Request->TimesRetry > MaxRetry) {
3520 Token->TransactionStatus = EFI_DEVICE_ERROR;
3521 goto Exit;
3522 } else {
3523 goto Retry;
3524 }
3525 } else if (Status == EFI_DEVICE_ERROR) {
3526 Token->TransactionStatus = EFI_DEVICE_ERROR;
3527 goto Exit;
3528 }
3529
3530 if (Request->TargetStatus == EFI_EXT_SCSI_STATUS_TARGET_CHECK_CONDITION) {
3531 DEBUG ((EFI_D_ERROR, "ScsiDiskNotify: Check Condition happened!\n"));
3532
3533 Status = DetectMediaParsingSenseKeys (
3534 ScsiDiskDevice,
3535 Request->SenseData,
3536 Request->SenseDataLength / sizeof (EFI_SCSI_SENSE_DATA),
3537 &Action
3538 );
3539 if (Action == ACTION_RETRY_COMMAND_LATER) {
3540 if (++Request->TimesRetry > MaxRetry) {
3541 Token->TransactionStatus = EFI_DEVICE_ERROR;
3542 goto Exit;
3543 } else {
3544 goto Retry;
3545 }
3546 } else if (Action == ACTION_RETRY_WITH_BACKOFF_ALGO) {
3547 if (Request->SectorCount <= 1) {
3548 //
3549 // Jump out if the operation still fails with one sector transfer
3550 // length.
3551 //
3552 Token->TransactionStatus = EFI_DEVICE_ERROR;
3553 goto Exit;
3554 }
3555 //
3556 // Try again with two half length request if the sense data shows we need
3557 // to retry.
3558 //
3559 Request->SectorCount >>= 1;
3560 Request->DataLength = Request->SectorCount * ScsiDiskDevice->BlkIo.Media->BlockSize;
3561 Request->TimesRetry = 0;
3562
3563 goto Retry;
3564 } else {
3565 Token->TransactionStatus = EFI_DEVICE_ERROR;
3566 goto Exit;
3567 }
3568 }
3569
3570 //
3571 // This sub-task succeeds, no need to retry.
3572 //
3573 goto Exit;
3574
3575 Retry:
3576 if (Request->InBuffer != NULL) {
3577 //
3578 // SCSI read command
3579 //
3580 if (!ScsiDiskDevice->Cdb16Byte) {
3581 Status = ScsiDiskAsyncRead10 (
3582 ScsiDiskDevice,
3583 Request->Timeout,
3584 Request->TimesRetry,
3585 Request->InBuffer,
3586 Request->DataLength,
3587 (UINT32) Request->StartLba,
3588 Request->SectorCount,
3589 Request->BlkIo2Req,
3590 Token
3591 );
3592 } else {
3593 Status = ScsiDiskAsyncRead16 (
3594 ScsiDiskDevice,
3595 Request->Timeout,
3596 Request->TimesRetry,
3597 Request->InBuffer,
3598 Request->DataLength,
3599 Request->StartLba,
3600 Request->SectorCount,
3601 Request->BlkIo2Req,
3602 Token
3603 );
3604 }
3605
3606 if (EFI_ERROR (Status)) {
3607 Token->TransactionStatus = EFI_DEVICE_ERROR;
3608 goto Exit;
3609 } else if (OldSectorCount != Request->SectorCount) {
3610 //
3611 // Original sub-task will be split into two new sub-tasks with smaller
3612 // DataLength
3613 //
3614 if (!ScsiDiskDevice->Cdb16Byte) {
3615 Status = ScsiDiskAsyncRead10 (
3616 ScsiDiskDevice,
3617 Request->Timeout,
3618 0,
3619 Request->InBuffer + Request->SectorCount * ScsiDiskDevice->BlkIo.Media->BlockSize,
3620 OldDataLength - Request->DataLength,
3621 (UINT32) Request->StartLba + Request->SectorCount,
3622 OldSectorCount - Request->SectorCount,
3623 Request->BlkIo2Req,
3624 Token
3625 );
3626 } else {
3627 Status = ScsiDiskAsyncRead16 (
3628 ScsiDiskDevice,
3629 Request->Timeout,
3630 0,
3631 Request->InBuffer + Request->SectorCount * ScsiDiskDevice->BlkIo.Media->BlockSize,
3632 OldDataLength - Request->DataLength,
3633 Request->StartLba + Request->SectorCount,
3634 OldSectorCount - Request->SectorCount,
3635 Request->BlkIo2Req,
3636 Token
3637 );
3638 }
3639 if (EFI_ERROR (Status)) {
3640 Token->TransactionStatus = EFI_DEVICE_ERROR;
3641 goto Exit;
3642 }
3643 }
3644 } else {
3645 //
3646 // SCSI write command
3647 //
3648 if (!ScsiDiskDevice->Cdb16Byte) {
3649 Status = ScsiDiskAsyncWrite10 (
3650 ScsiDiskDevice,
3651 Request->Timeout,
3652 Request->TimesRetry,
3653 Request->OutBuffer,
3654 Request->DataLength,
3655 (UINT32) Request->StartLba,
3656 Request->SectorCount,
3657 Request->BlkIo2Req,
3658 Token
3659 );
3660 } else {
3661 Status = ScsiDiskAsyncWrite16 (
3662 ScsiDiskDevice,
3663 Request->Timeout,
3664 Request->TimesRetry,
3665 Request->OutBuffer,
3666 Request->DataLength,
3667 Request->StartLba,
3668 Request->SectorCount,
3669 Request->BlkIo2Req,
3670 Token
3671 );
3672 }
3673
3674 if (EFI_ERROR (Status)) {
3675 Token->TransactionStatus = EFI_DEVICE_ERROR;
3676 goto Exit;
3677 } else if (OldSectorCount != Request->SectorCount) {
3678 //
3679 // Original sub-task will be split into two new sub-tasks with smaller
3680 // DataLength
3681 //
3682 if (!ScsiDiskDevice->Cdb16Byte) {
3683 Status = ScsiDiskAsyncWrite10 (
3684 ScsiDiskDevice,
3685 Request->Timeout,
3686 0,
3687 Request->OutBuffer + Request->SectorCount * ScsiDiskDevice->BlkIo.Media->BlockSize,
3688 OldDataLength - Request->DataLength,
3689 (UINT32) Request->StartLba + Request->SectorCount,
3690 OldSectorCount - Request->SectorCount,
3691 Request->BlkIo2Req,
3692 Token
3693 );
3694 } else {
3695 Status = ScsiDiskAsyncWrite16 (
3696 ScsiDiskDevice,
3697 Request->Timeout,
3698 0,
3699 Request->OutBuffer + Request->SectorCount * ScsiDiskDevice->BlkIo.Media->BlockSize,
3700 OldDataLength - Request->DataLength,
3701 Request->StartLba + Request->SectorCount,
3702 OldSectorCount - Request->SectorCount,
3703 Request->BlkIo2Req,
3704 Token
3705 );
3706 }
3707 if (EFI_ERROR (Status)) {
3708 Token->TransactionStatus = EFI_DEVICE_ERROR;
3709 goto Exit;
3710 }
3711 }
3712 }
3713
3714 Exit:
3715 RemoveEntryList (&Request->Link);
3716 if (IsListEmpty (&Request->BlkIo2Req->ScsiRWQueue)) {
3717 //
3718 // The last SCSI R/W command of a BlockIo2 request completes
3719 //
3720 RemoveEntryList (&Request->BlkIo2Req->Link);
3721 FreePool (Request->BlkIo2Req); // Should be freed only once
3722 gBS->SignalEvent (Token->Event);
3723 }
3724
3725 FreePool (Request->SenseData);
3726 FreePool (Request);
3727 }
3728
3729
3730 /**
3731 Submit Async Read(10) command.
3732
3733 @param ScsiDiskDevice The pointer of ScsiDiskDevice.
3734 @param Timeout The time to complete the command.
3735 @param TimesRetry The number of times the command has been retried.
3736 @param DataBuffer The buffer to fill with the read out data.
3737 @param DataLength The length of buffer.
3738 @param StartLba The start logic block address.
3739 @param SectorCount The number of blocks to read.
3740 @param BlkIo2Req The upstream BlockIo2 request.
3741 @param Token The pointer to the token associated with the
3742 non-blocking read request.
3743
3744 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a
3745 lack of resources.
3746 @return others Status returned by calling
3747 ScsiRead10CommandEx().
3748
3749 **/
3750 EFI_STATUS
3751 ScsiDiskAsyncRead10 (
3752 IN SCSI_DISK_DEV *ScsiDiskDevice,
3753 IN UINT64 Timeout,
3754 IN UINT8 TimesRetry,
3755 OUT UINT8 *DataBuffer,
3756 IN UINT32 DataLength,
3757 IN UINT32 StartLba,
3758 IN UINT32 SectorCount,
3759 IN OUT SCSI_BLKIO2_REQUEST *BlkIo2Req,
3760 IN EFI_BLOCK_IO2_TOKEN *Token
3761 )
3762 {
3763 EFI_STATUS Status;
3764 SCSI_ASYNC_RW_REQUEST *Request;
3765 EFI_EVENT AsyncIoEvent;
3766
3767 AsyncIoEvent = NULL;
3768
3769 Request = AllocateZeroPool (sizeof (SCSI_ASYNC_RW_REQUEST));
3770 if (Request == NULL) {
3771 return EFI_OUT_OF_RESOURCES;
3772 }
3773 InsertTailList (&BlkIo2Req->ScsiRWQueue, &Request->Link);
3774
3775 Request->SenseDataLength = (UINT8) (6 * sizeof (EFI_SCSI_SENSE_DATA));
3776 Request->SenseData = AllocateZeroPool (Request->SenseDataLength);
3777 if (Request->SenseData == NULL) {
3778 Status = EFI_OUT_OF_RESOURCES;
3779 goto ErrorExit;
3780 }
3781
3782 Request->ScsiDiskDevice = ScsiDiskDevice;
3783 Request->Timeout = Timeout;
3784 Request->TimesRetry = TimesRetry;
3785 Request->InBuffer = DataBuffer;
3786 Request->DataLength = DataLength;
3787 Request->StartLba = StartLba;
3788 Request->SectorCount = SectorCount;
3789 Request->BlkIo2Req = BlkIo2Req;
3790
3791 //
3792 // Create Event
3793 //
3794 Status = gBS->CreateEvent (
3795 EVT_NOTIFY_SIGNAL,
3796 TPL_CALLBACK,
3797 ScsiDiskNotify,
3798 Request,
3799 &AsyncIoEvent
3800 );
3801 if (EFI_ERROR(Status)) {
3802 goto ErrorExit;
3803 }
3804
3805 Status = ScsiRead10CommandEx (
3806 ScsiDiskDevice->ScsiIo,
3807 Request->Timeout,
3808 Request->SenseData,
3809 &Request->SenseDataLength,
3810 &Request->HostAdapterStatus,
3811 &Request->TargetStatus,
3812 Request->InBuffer,
3813 &Request->DataLength,
3814 (UINT32) Request->StartLba,
3815 Request->SectorCount,
3816 AsyncIoEvent
3817 );
3818 if (EFI_ERROR(Status)) {
3819 goto ErrorExit;
3820 }
3821
3822 return EFI_SUCCESS;
3823
3824 ErrorExit:
3825 if (AsyncIoEvent != NULL) {
3826 gBS->CloseEvent (AsyncIoEvent);
3827 }
3828
3829 if (Request != NULL) {
3830 if (Request->SenseData != NULL) {
3831 FreePool (Request->SenseData);
3832 }
3833
3834 RemoveEntryList (&Request->Link);
3835 FreePool (Request);
3836 }
3837
3838 return Status;
3839 }
3840
3841
3842 /**
3843 Submit Async Write(10) command.
3844
3845 @param ScsiDiskDevice The pointer of ScsiDiskDevice.
3846 @param Timeout The time to complete the command.
3847 @param TimesRetry The number of times the command has been retried.
3848 @param DataBuffer The buffer contains the data to write.
3849 @param DataLength The length of buffer.
3850 @param StartLba The start logic block address.
3851 @param SectorCount The number of blocks to write.
3852 @param BlkIo2Req The upstream BlockIo2 request.
3853 @param Token The pointer to the token associated with the
3854 non-blocking read request.
3855
3856 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a
3857 lack of resources.
3858 @return others Status returned by calling
3859 ScsiWrite10CommandEx().
3860
3861 **/
3862 EFI_STATUS
3863 ScsiDiskAsyncWrite10 (
3864 IN SCSI_DISK_DEV *ScsiDiskDevice,
3865 IN UINT64 Timeout,
3866 IN UINT8 TimesRetry,
3867 IN UINT8 *DataBuffer,
3868 IN UINT32 DataLength,
3869 IN UINT32 StartLba,
3870 IN UINT32 SectorCount,
3871 IN OUT SCSI_BLKIO2_REQUEST *BlkIo2Req,
3872 IN EFI_BLOCK_IO2_TOKEN *Token
3873 )
3874 {
3875 EFI_STATUS Status;
3876 SCSI_ASYNC_RW_REQUEST *Request;
3877 EFI_EVENT AsyncIoEvent;
3878
3879 AsyncIoEvent = NULL;
3880
3881 Request = AllocateZeroPool (sizeof (SCSI_ASYNC_RW_REQUEST));
3882 if (Request == NULL) {
3883 return EFI_OUT_OF_RESOURCES;
3884 }
3885 InsertTailList (&BlkIo2Req->ScsiRWQueue, &Request->Link);
3886
3887 Request->SenseDataLength = (UINT8) (6 * sizeof (EFI_SCSI_SENSE_DATA));
3888 Request->SenseData = AllocateZeroPool (Request->SenseDataLength);
3889 if (Request->SenseData == NULL) {
3890 Status = EFI_OUT_OF_RESOURCES;
3891 goto ErrorExit;
3892 }
3893
3894 Request->ScsiDiskDevice = ScsiDiskDevice;
3895 Request->Timeout = Timeout;
3896 Request->TimesRetry = TimesRetry;
3897 Request->OutBuffer = DataBuffer;
3898 Request->DataLength = DataLength;
3899 Request->StartLba = StartLba;
3900 Request->SectorCount = SectorCount;
3901 Request->BlkIo2Req = BlkIo2Req;
3902
3903 //
3904 // Create Event
3905 //
3906 Status = gBS->CreateEvent (
3907 EVT_NOTIFY_SIGNAL,
3908 TPL_CALLBACK,
3909 ScsiDiskNotify,
3910 Request,
3911 &AsyncIoEvent
3912 );
3913 if (EFI_ERROR(Status)) {
3914 goto ErrorExit;
3915 }
3916
3917 Status = ScsiWrite10CommandEx (
3918 ScsiDiskDevice->ScsiIo,
3919 Request->Timeout,
3920 Request->SenseData,
3921 &Request->SenseDataLength,
3922 &Request->HostAdapterStatus,
3923 &Request->TargetStatus,
3924 Request->OutBuffer,
3925 &Request->DataLength,
3926 (UINT32) Request->StartLba,
3927 Request->SectorCount,
3928 AsyncIoEvent
3929 );
3930 if (EFI_ERROR(Status)) {
3931 goto ErrorExit;
3932 }
3933
3934 return EFI_SUCCESS;
3935
3936 ErrorExit:
3937 if (AsyncIoEvent != NULL) {
3938 gBS->CloseEvent (AsyncIoEvent);
3939 }
3940
3941 if (Request != NULL) {
3942 if (Request->SenseData != NULL) {
3943 FreePool (Request->SenseData);
3944 }
3945
3946 RemoveEntryList (&Request->Link);
3947 FreePool (Request);
3948 }
3949
3950 return Status;
3951 }
3952
3953
3954 /**
3955 Submit Async Read(16) command.
3956
3957 @param ScsiDiskDevice The pointer of ScsiDiskDevice.
3958 @param Timeout The time to complete the command.
3959 @param TimesRetry The number of times the command has been retried.
3960 @param DataBuffer The buffer to fill with the read out data.
3961 @param DataLength The length of buffer.
3962 @param StartLba The start logic block address.
3963 @param SectorCount The number of blocks to read.
3964 @param BlkIo2Req The upstream BlockIo2 request.
3965 @param Token The pointer to the token associated with the
3966 non-blocking read request.
3967
3968 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a
3969 lack of resources.
3970 @return others Status returned by calling
3971 ScsiRead16CommandEx().
3972
3973 **/
3974 EFI_STATUS
3975 ScsiDiskAsyncRead16 (
3976 IN SCSI_DISK_DEV *ScsiDiskDevice,
3977 IN UINT64 Timeout,
3978 IN UINT8 TimesRetry,
3979 OUT UINT8 *DataBuffer,
3980 IN UINT32 DataLength,
3981 IN UINT64 StartLba,
3982 IN UINT32 SectorCount,
3983 IN OUT SCSI_BLKIO2_REQUEST *BlkIo2Req,
3984 IN EFI_BLOCK_IO2_TOKEN *Token
3985 )
3986 {
3987 EFI_STATUS Status;
3988 SCSI_ASYNC_RW_REQUEST *Request;
3989 EFI_EVENT AsyncIoEvent;
3990
3991 AsyncIoEvent = NULL;
3992
3993 Request = AllocateZeroPool (sizeof (SCSI_ASYNC_RW_REQUEST));
3994 if (Request == NULL) {
3995 return EFI_OUT_OF_RESOURCES;
3996 }
3997 InsertTailList (&BlkIo2Req->ScsiRWQueue, &Request->Link);
3998
3999 Request->SenseDataLength = (UINT8) (6 * sizeof (EFI_SCSI_SENSE_DATA));
4000 Request->SenseData = AllocateZeroPool (Request->SenseDataLength);
4001 if (Request->SenseData == NULL) {
4002 Status = EFI_OUT_OF_RESOURCES;
4003 goto ErrorExit;
4004 }
4005
4006 Request->ScsiDiskDevice = ScsiDiskDevice;
4007 Request->Timeout = Timeout;
4008 Request->TimesRetry = TimesRetry;
4009 Request->InBuffer = DataBuffer;
4010 Request->DataLength = DataLength;
4011 Request->StartLba = StartLba;
4012 Request->SectorCount = SectorCount;
4013 Request->BlkIo2Req = BlkIo2Req;
4014
4015 //
4016 // Create Event
4017 //
4018 Status = gBS->CreateEvent (
4019 EVT_NOTIFY_SIGNAL,
4020 TPL_CALLBACK,
4021 ScsiDiskNotify,
4022 Request,
4023 &AsyncIoEvent
4024 );
4025 if (EFI_ERROR(Status)) {
4026 goto ErrorExit;
4027 }
4028
4029 Status = ScsiRead16CommandEx (
4030 ScsiDiskDevice->ScsiIo,
4031 Request->Timeout,
4032 Request->SenseData,
4033 &Request->SenseDataLength,
4034 &Request->HostAdapterStatus,
4035 &Request->TargetStatus,
4036 Request->InBuffer,
4037 &Request->DataLength,
4038 Request->StartLba,
4039 Request->SectorCount,
4040 AsyncIoEvent
4041 );
4042 if (EFI_ERROR(Status)) {
4043 goto ErrorExit;
4044 }
4045
4046 return EFI_SUCCESS;
4047
4048 ErrorExit:
4049 if (AsyncIoEvent != NULL) {
4050 gBS->CloseEvent (AsyncIoEvent);
4051 }
4052
4053 if (Request != NULL) {
4054 if (Request->SenseData != NULL) {
4055 FreePool (Request->SenseData);
4056 }
4057
4058 RemoveEntryList (&Request->Link);
4059 FreePool (Request);
4060 }
4061
4062 return Status;
4063 }
4064
4065
4066 /**
4067 Submit Async Write(16) command.
4068
4069 @param ScsiDiskDevice The pointer of ScsiDiskDevice.
4070 @param Timeout The time to complete the command.
4071 @param TimesRetry The number of times the command has been retried.
4072 @param DataBuffer The buffer contains the data to write.
4073 @param DataLength The length of buffer.
4074 @param StartLba The start logic block address.
4075 @param SectorCount The number of blocks to write.
4076 @param BlkIo2Req The upstream BlockIo2 request.
4077 @param Token The pointer to the token associated with the
4078 non-blocking read request.
4079
4080 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a
4081 lack of resources.
4082 @return others Status returned by calling
4083 ScsiWrite16CommandEx().
4084
4085 **/
4086 EFI_STATUS
4087 ScsiDiskAsyncWrite16 (
4088 IN SCSI_DISK_DEV *ScsiDiskDevice,
4089 IN UINT64 Timeout,
4090 IN UINT8 TimesRetry,
4091 IN UINT8 *DataBuffer,
4092 IN UINT32 DataLength,
4093 IN UINT64 StartLba,
4094 IN UINT32 SectorCount,
4095 IN OUT SCSI_BLKIO2_REQUEST *BlkIo2Req,
4096 IN EFI_BLOCK_IO2_TOKEN *Token
4097 )
4098 {
4099 EFI_STATUS Status;
4100 SCSI_ASYNC_RW_REQUEST *Request;
4101 EFI_EVENT AsyncIoEvent;
4102
4103 AsyncIoEvent = NULL;
4104
4105 Request = AllocateZeroPool (sizeof (SCSI_ASYNC_RW_REQUEST));
4106 if (Request == NULL) {
4107 return EFI_OUT_OF_RESOURCES;
4108 }
4109 InsertTailList (&BlkIo2Req->ScsiRWQueue, &Request->Link);
4110
4111 Request->SenseDataLength = (UINT8) (6 * sizeof (EFI_SCSI_SENSE_DATA));
4112 Request->SenseData = AllocateZeroPool (Request->SenseDataLength);
4113 if (Request->SenseData == NULL) {
4114 Status = EFI_OUT_OF_RESOURCES;
4115 goto ErrorExit;
4116 }
4117
4118 Request->ScsiDiskDevice = ScsiDiskDevice;
4119 Request->Timeout = Timeout;
4120 Request->TimesRetry = TimesRetry;
4121 Request->OutBuffer = DataBuffer;
4122 Request->DataLength = DataLength;
4123 Request->StartLba = StartLba;
4124 Request->SectorCount = SectorCount;
4125 Request->BlkIo2Req = BlkIo2Req;
4126
4127 //
4128 // Create Event
4129 //
4130 Status = gBS->CreateEvent (
4131 EVT_NOTIFY_SIGNAL,
4132 TPL_CALLBACK,
4133 ScsiDiskNotify,
4134 Request,
4135 &AsyncIoEvent
4136 );
4137 if (EFI_ERROR(Status)) {
4138 goto ErrorExit;
4139 }
4140
4141 Status = ScsiWrite16CommandEx (
4142 ScsiDiskDevice->ScsiIo,
4143 Request->Timeout,
4144 Request->SenseData,
4145 &Request->SenseDataLength,
4146 &Request->HostAdapterStatus,
4147 &Request->TargetStatus,
4148 Request->OutBuffer,
4149 &Request->DataLength,
4150 Request->StartLba,
4151 Request->SectorCount,
4152 AsyncIoEvent
4153 );
4154 if (EFI_ERROR(Status)) {
4155 goto ErrorExit;
4156 }
4157
4158 return EFI_SUCCESS;
4159
4160 ErrorExit:
4161 if (AsyncIoEvent != NULL) {
4162 gBS->CloseEvent (AsyncIoEvent);
4163 }
4164
4165 if (Request != NULL) {
4166 if (Request->SenseData != NULL) {
4167 FreePool (Request->SenseData);
4168 }
4169
4170 RemoveEntryList (&Request->Link);
4171 FreePool (Request);
4172 }
4173
4174 return Status;
4175 }
4176
4177
4178 /**
4179 Check sense key to find if media presents.
4180
4181 @param SenseData The pointer of EFI_SCSI_SENSE_DATA
4182 @param SenseCounts The number of sense key
4183
4184 @retval TRUE NOT any media
4185 @retval FALSE Media presents
4186 **/
4187 BOOLEAN
4188 ScsiDiskIsNoMedia (
4189 IN EFI_SCSI_SENSE_DATA *SenseData,
4190 IN UINTN SenseCounts
4191 )
4192 {
4193 EFI_SCSI_SENSE_DATA *SensePtr;
4194 UINTN Index;
4195 BOOLEAN IsNoMedia;
4196
4197 IsNoMedia = FALSE;
4198 SensePtr = SenseData;
4199
4200 for (Index = 0; Index < SenseCounts; Index++) {
4201 //
4202 // Sense Key is EFI_SCSI_SK_NOT_READY (0x2),
4203 // Additional Sense Code is ASC_NO_MEDIA (0x3A)
4204 //
4205 if ((SensePtr->Sense_Key == EFI_SCSI_SK_NOT_READY) &&
4206 (SensePtr->Addnl_Sense_Code == EFI_SCSI_ASC_NO_MEDIA)) {
4207 IsNoMedia = TRUE;
4208 }
4209 SensePtr++;
4210 }
4211
4212 return IsNoMedia;
4213 }
4214
4215
4216 /**
4217 Parse sense key.
4218
4219 @param SenseData The pointer of EFI_SCSI_SENSE_DATA
4220 @param SenseCounts The number of sense key
4221
4222 @retval TRUE Error
4223 @retval FALSE NOT error
4224
4225 **/
4226 BOOLEAN
4227 ScsiDiskIsMediaError (
4228 IN EFI_SCSI_SENSE_DATA *SenseData,
4229 IN UINTN SenseCounts
4230 )
4231 {
4232 EFI_SCSI_SENSE_DATA *SensePtr;
4233 UINTN Index;
4234 BOOLEAN IsError;
4235
4236 IsError = FALSE;
4237 SensePtr = SenseData;
4238
4239 for (Index = 0; Index < SenseCounts; Index++) {
4240
4241 switch (SensePtr->Sense_Key) {
4242
4243 case EFI_SCSI_SK_MEDIUM_ERROR:
4244 //
4245 // Sense Key is EFI_SCSI_SK_MEDIUM_ERROR (0x3)
4246 //
4247 switch (SensePtr->Addnl_Sense_Code) {
4248
4249 //
4250 // fall through
4251 //
4252 case EFI_SCSI_ASC_MEDIA_ERR1:
4253
4254 //
4255 // fall through
4256 //
4257 case EFI_SCSI_ASC_MEDIA_ERR2:
4258
4259 //
4260 // fall through
4261 //
4262 case EFI_SCSI_ASC_MEDIA_ERR3:
4263 case EFI_SCSI_ASC_MEDIA_ERR4:
4264 IsError = TRUE;
4265 break;
4266
4267 default:
4268 break;
4269 }
4270
4271 break;
4272
4273 case EFI_SCSI_SK_NOT_READY:
4274 //
4275 // Sense Key is EFI_SCSI_SK_NOT_READY (0x2)
4276 //
4277 switch (SensePtr->Addnl_Sense_Code) {
4278 //
4279 // Additional Sense Code is ASC_MEDIA_UPSIDE_DOWN (0x6)
4280 //
4281 case EFI_SCSI_ASC_MEDIA_UPSIDE_DOWN:
4282 IsError = TRUE;
4283 break;
4284
4285 default:
4286 break;
4287 }
4288 break;
4289
4290 default:
4291 break;
4292 }
4293
4294 SensePtr++;
4295 }
4296
4297 return IsError;
4298 }
4299
4300
4301 /**
4302 Check sense key to find if hardware error happens.
4303
4304 @param SenseData The pointer of EFI_SCSI_SENSE_DATA
4305 @param SenseCounts The number of sense key
4306
4307 @retval TRUE Hardware error exits.
4308 @retval FALSE NO error.
4309
4310 **/
4311 BOOLEAN
4312 ScsiDiskIsHardwareError (
4313 IN EFI_SCSI_SENSE_DATA *SenseData,
4314 IN UINTN SenseCounts
4315 )
4316 {
4317 EFI_SCSI_SENSE_DATA *SensePtr;
4318 UINTN Index;
4319 BOOLEAN IsError;
4320
4321 IsError = FALSE;
4322 SensePtr = SenseData;
4323
4324 for (Index = 0; Index < SenseCounts; Index++) {
4325
4326 //
4327 // Sense Key is EFI_SCSI_SK_HARDWARE_ERROR (0x4)
4328 //
4329 if (SensePtr->Sense_Key == EFI_SCSI_SK_HARDWARE_ERROR) {
4330 IsError = TRUE;
4331 }
4332
4333 SensePtr++;
4334 }
4335
4336 return IsError;
4337 }
4338
4339
4340 /**
4341 Check sense key to find if media has changed.
4342
4343 @param SenseData The pointer of EFI_SCSI_SENSE_DATA
4344 @param SenseCounts The number of sense key
4345
4346 @retval TRUE Media is changed.
4347 @retval FALSE Media is NOT changed.
4348 **/
4349 BOOLEAN
4350 ScsiDiskIsMediaChange (
4351 IN EFI_SCSI_SENSE_DATA *SenseData,
4352 IN UINTN SenseCounts
4353 )
4354 {
4355 EFI_SCSI_SENSE_DATA *SensePtr;
4356 UINTN Index;
4357 BOOLEAN IsMediaChanged;
4358
4359 IsMediaChanged = FALSE;
4360 SensePtr = SenseData;
4361
4362 for (Index = 0; Index < SenseCounts; Index++) {
4363 //
4364 // Sense Key is EFI_SCSI_SK_UNIT_ATTENTION (0x6),
4365 // Additional sense code is EFI_SCSI_ASC_MEDIA_CHANGE (0x28)
4366 //
4367 if ((SensePtr->Sense_Key == EFI_SCSI_SK_UNIT_ATTENTION) &&
4368 (SensePtr->Addnl_Sense_Code == EFI_SCSI_ASC_MEDIA_CHANGE)) {
4369 IsMediaChanged = TRUE;
4370 }
4371
4372 SensePtr++;
4373 }
4374
4375 return IsMediaChanged;
4376 }
4377
4378 /**
4379 Check sense key to find if reset happens.
4380
4381 @param SenseData The pointer of EFI_SCSI_SENSE_DATA
4382 @param SenseCounts The number of sense key
4383
4384 @retval TRUE It is reset before.
4385 @retval FALSE It is NOT reset before.
4386
4387 **/
4388 BOOLEAN
4389 ScsiDiskIsResetBefore (
4390 IN EFI_SCSI_SENSE_DATA *SenseData,
4391 IN UINTN SenseCounts
4392 )
4393 {
4394 EFI_SCSI_SENSE_DATA *SensePtr;
4395 UINTN Index;
4396 BOOLEAN IsResetBefore;
4397
4398 IsResetBefore = FALSE;
4399 SensePtr = SenseData;
4400
4401 for (Index = 0; Index < SenseCounts; Index++) {
4402
4403 //
4404 // Sense Key is EFI_SCSI_SK_UNIT_ATTENTION (0x6)
4405 // Additional Sense Code is EFI_SCSI_ASC_RESET (0x29)
4406 //
4407 if ((SensePtr->Sense_Key == EFI_SCSI_SK_UNIT_ATTENTION) &&
4408 (SensePtr->Addnl_Sense_Code == EFI_SCSI_ASC_RESET)) {
4409 IsResetBefore = TRUE;
4410 }
4411
4412 SensePtr++;
4413 }
4414
4415 return IsResetBefore;
4416 }
4417
4418 /**
4419 Check sense key to find if the drive is ready.
4420
4421 @param SenseData The pointer of EFI_SCSI_SENSE_DATA
4422 @param SenseCounts The number of sense key
4423 @param RetryLater The flag means if need a retry
4424
4425 @retval TRUE Drive is ready.
4426 @retval FALSE Drive is NOT ready.
4427
4428 **/
4429 BOOLEAN
4430 ScsiDiskIsDriveReady (
4431 IN EFI_SCSI_SENSE_DATA *SenseData,
4432 IN UINTN SenseCounts,
4433 OUT BOOLEAN *RetryLater
4434 )
4435 {
4436 EFI_SCSI_SENSE_DATA *SensePtr;
4437 UINTN Index;
4438 BOOLEAN IsReady;
4439
4440 IsReady = TRUE;
4441 *RetryLater = FALSE;
4442 SensePtr = SenseData;
4443
4444 for (Index = 0; Index < SenseCounts; Index++) {
4445
4446 switch (SensePtr->Sense_Key) {
4447
4448 case EFI_SCSI_SK_NOT_READY:
4449 //
4450 // Sense Key is EFI_SCSI_SK_NOT_READY (0x2)
4451 //
4452 switch (SensePtr->Addnl_Sense_Code) {
4453 case EFI_SCSI_ASC_NOT_READY:
4454 //
4455 // Additional Sense Code is EFI_SCSI_ASC_NOT_READY (0x4)
4456 //
4457 switch (SensePtr->Addnl_Sense_Code_Qualifier) {
4458 case EFI_SCSI_ASCQ_IN_PROGRESS:
4459 //
4460 // Additional Sense Code Qualifier is
4461 // EFI_SCSI_ASCQ_IN_PROGRESS (0x1)
4462 //
4463 IsReady = FALSE;
4464 *RetryLater = TRUE;
4465 break;
4466
4467 default:
4468 IsReady = FALSE;
4469 *RetryLater = FALSE;
4470 break;
4471 }
4472 break;
4473
4474 default:
4475 break;
4476 }
4477 break;
4478
4479 default:
4480 break;
4481 }
4482
4483 SensePtr++;
4484 }
4485
4486 return IsReady;
4487 }
4488
4489 /**
4490 Check sense key to find if it has sense key.
4491
4492 @param SenseData - The pointer of EFI_SCSI_SENSE_DATA
4493 @param SenseCounts - The number of sense key
4494
4495 @retval TRUE It has sense key.
4496 @retval FALSE It has NOT any sense key.
4497
4498 **/
4499 BOOLEAN
4500 ScsiDiskHaveSenseKey (
4501 IN EFI_SCSI_SENSE_DATA *SenseData,
4502 IN UINTN SenseCounts
4503 )
4504 {
4505 EFI_SCSI_SENSE_DATA *SensePtr;
4506 UINTN Index;
4507 BOOLEAN HaveSenseKey;
4508
4509 if (SenseCounts == 0) {
4510 HaveSenseKey = FALSE;
4511 } else {
4512 HaveSenseKey = TRUE;
4513 }
4514
4515 SensePtr = SenseData;
4516
4517 for (Index = 0; Index < SenseCounts; Index++) {
4518
4519 //
4520 // Sense Key is SK_NO_SENSE (0x0)
4521 //
4522 if ((SensePtr->Sense_Key == EFI_SCSI_SK_NO_SENSE) &&
4523 (Index == 0)) {
4524 HaveSenseKey = FALSE;
4525 }
4526
4527 SensePtr++;
4528 }
4529
4530 return HaveSenseKey;
4531 }
4532
4533 /**
4534 Release resource about disk device.
4535
4536 @param ScsiDiskDevice The pointer of SCSI_DISK_DEV
4537
4538 **/
4539 VOID
4540 ReleaseScsiDiskDeviceResources (
4541 IN SCSI_DISK_DEV *ScsiDiskDevice
4542 )
4543 {
4544 if (ScsiDiskDevice == NULL) {
4545 return ;
4546 }
4547
4548 if (ScsiDiskDevice->SenseData != NULL) {
4549 FreePool (ScsiDiskDevice->SenseData);
4550 ScsiDiskDevice->SenseData = NULL;
4551 }
4552
4553 if (ScsiDiskDevice->ControllerNameTable != NULL) {
4554 FreeUnicodeStringTable (ScsiDiskDevice->ControllerNameTable);
4555 ScsiDiskDevice->ControllerNameTable = NULL;
4556 }
4557
4558 FreePool (ScsiDiskDevice);
4559
4560 ScsiDiskDevice = NULL;
4561 }
4562
4563 /**
4564 Determine if Block Io & Block Io2 should be produced.
4565
4566
4567 @param ChildHandle Child Handle to retrieve Parent information.
4568
4569 @retval TRUE Should produce Block Io & Block Io2.
4570 @retval FALSE Should not produce Block Io & Block Io2.
4571
4572 **/
4573 BOOLEAN
4574 DetermineInstallBlockIo (
4575 IN EFI_HANDLE ChildHandle
4576 )
4577 {
4578 EFI_SCSI_PASS_THRU_PROTOCOL *ScsiPassThru;
4579 EFI_EXT_SCSI_PASS_THRU_PROTOCOL *ExtScsiPassThru;
4580
4581 //
4582 // Firstly, check if ExtScsiPassThru Protocol parent handle exists. If existence,
4583 // check its attribute, logic or physical.
4584 //
4585 ExtScsiPassThru = (EFI_EXT_SCSI_PASS_THRU_PROTOCOL *)GetParentProtocol (&gEfiExtScsiPassThruProtocolGuid, ChildHandle);
4586 if (ExtScsiPassThru != NULL) {
4587 if ((ExtScsiPassThru->Mode->Attributes & EFI_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL) != 0) {
4588 return TRUE;
4589 }
4590 }
4591
4592 //
4593 // Secondly, check if ScsiPassThru Protocol parent handle exists. If existence,
4594 // check its attribute, logic or physical.
4595 //
4596 ScsiPassThru = (EFI_SCSI_PASS_THRU_PROTOCOL *)GetParentProtocol (&gEfiScsiPassThruProtocolGuid, ChildHandle);
4597 if (ScsiPassThru != NULL) {
4598 if ((ScsiPassThru->Mode->Attributes & EFI_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL) != 0) {
4599 return TRUE;
4600 }
4601 }
4602
4603 return FALSE;
4604 }
4605
4606 /**
4607 Search protocol database and check to see if the protocol
4608 specified by ProtocolGuid is present on a ControllerHandle and opened by
4609 ChildHandle with an attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.
4610 If the ControllerHandle is found, then the protocol specified by ProtocolGuid
4611 will be opened on it.
4612
4613
4614 @param ProtocolGuid ProtocolGuid pointer.
4615 @param ChildHandle Child Handle to retrieve Parent information.
4616
4617 **/
4618 VOID *
4619 EFIAPI
4620 GetParentProtocol (
4621 IN EFI_GUID *ProtocolGuid,
4622 IN EFI_HANDLE ChildHandle
4623 )
4624 {
4625 UINTN Index;
4626 UINTN HandleCount;
4627 VOID *Interface;
4628 EFI_STATUS Status;
4629 EFI_HANDLE *HandleBuffer;
4630
4631 //
4632 // Retrieve the list of all handles from the handle database
4633 //
4634 Status = gBS->LocateHandleBuffer (
4635 ByProtocol,
4636 ProtocolGuid,
4637 NULL,
4638 &HandleCount,
4639 &HandleBuffer
4640 );
4641
4642 if (EFI_ERROR (Status)) {
4643 return NULL;
4644 }
4645
4646 //
4647 // Iterate to find who is parent handle that is opened with ProtocolGuid by ChildHandle
4648 //
4649 for (Index = 0; Index < HandleCount; Index++) {
4650 Status = EfiTestChildHandle (HandleBuffer[Index], ChildHandle, ProtocolGuid);
4651 if (!EFI_ERROR (Status)) {
4652 Status = gBS->HandleProtocol (HandleBuffer[Index], ProtocolGuid, (VOID **)&Interface);
4653 if (!EFI_ERROR (Status)) {
4654 gBS->FreePool (HandleBuffer);
4655 return Interface;
4656 }
4657 }
4658 }
4659
4660 gBS->FreePool (HandleBuffer);
4661 return NULL;
4662 }
4663
4664 /**
4665 Provides inquiry information for the controller type.
4666
4667 This function is used by the IDE bus driver to get inquiry data. Data format
4668 of Identify data is defined by the Interface GUID.
4669
4670 @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance.
4671 @param[in, out] InquiryData Pointer to a buffer for the inquiry data.
4672 @param[in, out] InquiryDataSize Pointer to the value for the inquiry data size.
4673
4674 @retval EFI_SUCCESS The command was accepted without any errors.
4675 @retval EFI_NOT_FOUND Device does not support this data class
4676 @retval EFI_DEVICE_ERROR Error reading InquiryData from device
4677 @retval EFI_BUFFER_TOO_SMALL InquiryDataSize not big enough
4678
4679 **/
4680 EFI_STATUS
4681 EFIAPI
4682 ScsiDiskInfoInquiry (
4683 IN EFI_DISK_INFO_PROTOCOL *This,
4684 IN OUT VOID *InquiryData,
4685 IN OUT UINT32 *InquiryDataSize
4686 )
4687 {
4688 EFI_STATUS Status;
4689 SCSI_DISK_DEV *ScsiDiskDevice;
4690
4691 ScsiDiskDevice = SCSI_DISK_DEV_FROM_DISKINFO (This);
4692
4693 Status = EFI_BUFFER_TOO_SMALL;
4694 if (*InquiryDataSize >= sizeof (ScsiDiskDevice->InquiryData)) {
4695 Status = EFI_SUCCESS;
4696 CopyMem (InquiryData, &ScsiDiskDevice->InquiryData, sizeof (ScsiDiskDevice->InquiryData));
4697 }
4698 *InquiryDataSize = sizeof (ScsiDiskDevice->InquiryData);
4699 return Status;
4700 }
4701
4702
4703 /**
4704 Provides identify information for the controller type.
4705
4706 This function is used by the IDE bus driver to get identify data. Data format
4707 of Identify data is defined by the Interface GUID.
4708
4709 @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL
4710 instance.
4711 @param[in, out] IdentifyData Pointer to a buffer for the identify data.
4712 @param[in, out] IdentifyDataSize Pointer to the value for the identify data
4713 size.
4714
4715 @retval EFI_SUCCESS The command was accepted without any errors.
4716 @retval EFI_NOT_FOUND Device does not support this data class
4717 @retval EFI_DEVICE_ERROR Error reading IdentifyData from device
4718 @retval EFI_BUFFER_TOO_SMALL IdentifyDataSize not big enough
4719
4720 **/
4721 EFI_STATUS
4722 EFIAPI
4723 ScsiDiskInfoIdentify (
4724 IN EFI_DISK_INFO_PROTOCOL *This,
4725 IN OUT VOID *IdentifyData,
4726 IN OUT UINT32 *IdentifyDataSize
4727 )
4728 {
4729 EFI_STATUS Status;
4730 SCSI_DISK_DEV *ScsiDiskDevice;
4731
4732 if (CompareGuid (&This->Interface, &gEfiDiskInfoScsiInterfaceGuid) || CompareGuid (&This->Interface, &gEfiDiskInfoUfsInterfaceGuid)) {
4733 //
4734 // Physical SCSI bus does not support this data class.
4735 //
4736 return EFI_NOT_FOUND;
4737 }
4738
4739 ScsiDiskDevice = SCSI_DISK_DEV_FROM_DISKINFO (This);
4740
4741 Status = EFI_BUFFER_TOO_SMALL;
4742 if (*IdentifyDataSize >= sizeof (ScsiDiskDevice->IdentifyData)) {
4743 Status = EFI_SUCCESS;
4744 CopyMem (IdentifyData, &ScsiDiskDevice->IdentifyData, sizeof (ScsiDiskDevice->IdentifyData));
4745 }
4746 *IdentifyDataSize = sizeof (ScsiDiskDevice->IdentifyData);
4747 return Status;
4748 }
4749
4750 /**
4751 Provides sense data information for the controller type.
4752
4753 This function is used by the IDE bus driver to get sense data.
4754 Data format of Sense data is defined by the Interface GUID.
4755
4756 @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance.
4757 @param[in, out] SenseData Pointer to the SenseData.
4758 @param[in, out] SenseDataSize Size of SenseData in bytes.
4759 @param[out] SenseDataNumber Pointer to the value for the sense data size.
4760
4761 @retval EFI_SUCCESS The command was accepted without any errors.
4762 @retval EFI_NOT_FOUND Device does not support this data class.
4763 @retval EFI_DEVICE_ERROR Error reading SenseData from device.
4764 @retval EFI_BUFFER_TOO_SMALL SenseDataSize not big enough.
4765
4766 **/
4767 EFI_STATUS
4768 EFIAPI
4769 ScsiDiskInfoSenseData (
4770 IN EFI_DISK_INFO_PROTOCOL *This,
4771 IN OUT VOID *SenseData,
4772 IN OUT UINT32 *SenseDataSize,
4773 OUT UINT8 *SenseDataNumber
4774 )
4775 {
4776 return EFI_NOT_FOUND;
4777 }
4778
4779
4780 /**
4781 This function is used by the IDE bus driver to get controller information.
4782
4783 @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance.
4784 @param[out] IdeChannel Pointer to the Ide Channel number. Primary or secondary.
4785 @param[out] IdeDevice Pointer to the Ide Device number. Master or slave.
4786
4787 @retval EFI_SUCCESS IdeChannel and IdeDevice are valid.
4788 @retval EFI_UNSUPPORTED This is not an IDE device.
4789
4790 **/
4791 EFI_STATUS
4792 EFIAPI
4793 ScsiDiskInfoWhichIde (
4794 IN EFI_DISK_INFO_PROTOCOL *This,
4795 OUT UINT32 *IdeChannel,
4796 OUT UINT32 *IdeDevice
4797 )
4798 {
4799 SCSI_DISK_DEV *ScsiDiskDevice;
4800
4801 if (CompareGuid (&This->Interface, &gEfiDiskInfoScsiInterfaceGuid) || CompareGuid (&This->Interface, &gEfiDiskInfoUfsInterfaceGuid)) {
4802 //
4803 // This is not an IDE physical device.
4804 //
4805 return EFI_UNSUPPORTED;
4806 }
4807
4808 ScsiDiskDevice = SCSI_DISK_DEV_FROM_DISKINFO (This);
4809 *IdeChannel = ScsiDiskDevice->Channel;
4810 *IdeDevice = ScsiDiskDevice->Device;
4811
4812 return EFI_SUCCESS;
4813 }
4814
4815
4816 /**
4817 Issues ATA IDENTIFY DEVICE command to identify ATAPI device.
4818
4819 This function tries to fill 512-byte ATAPI_IDENTIFY_DATA for ATAPI device to
4820 implement Identify() interface for DiskInfo protocol. The ATA command is sent
4821 via SCSI Request Packet.
4822
4823 @param ScsiDiskDevice The pointer of SCSI_DISK_DEV
4824
4825 @retval EFI_SUCCESS The ATAPI device identify data were retrieved successfully.
4826 @retval others Some error occurred during the identification that ATAPI device.
4827
4828 **/
4829 EFI_STATUS
4830 AtapiIdentifyDevice (
4831 IN OUT SCSI_DISK_DEV *ScsiDiskDevice
4832 )
4833 {
4834 EFI_SCSI_IO_SCSI_REQUEST_PACKET CommandPacket;
4835 UINT8 Cdb[6];
4836
4837 //
4838 // Initialize SCSI REQUEST_PACKET and 6-byte Cdb
4839 //
4840 ZeroMem (&CommandPacket, sizeof (CommandPacket));
4841 ZeroMem (Cdb, sizeof (Cdb));
4842
4843 Cdb[0] = ATA_CMD_IDENTIFY_DEVICE;
4844 CommandPacket.Timeout = SCSI_DISK_TIMEOUT;
4845 CommandPacket.Cdb = Cdb;
4846 CommandPacket.CdbLength = (UINT8) sizeof (Cdb);
4847 CommandPacket.InDataBuffer = &ScsiDiskDevice->IdentifyData;
4848 CommandPacket.InTransferLength = sizeof (ScsiDiskDevice->IdentifyData);
4849
4850 return ScsiDiskDevice->ScsiIo->ExecuteScsiCommand (ScsiDiskDevice->ScsiIo, &CommandPacket, NULL);
4851 }
4852
4853
4854 /**
4855 Initialize the installation of DiskInfo protocol.
4856
4857 This function prepares for the installation of DiskInfo protocol on the child handle.
4858 By default, it installs DiskInfo protocol with SCSI interface GUID. If it further
4859 detects that the physical device is an ATAPI/AHCI device, it then updates interface GUID
4860 to be IDE/AHCI interface GUID.
4861
4862 @param ScsiDiskDevice The pointer of SCSI_DISK_DEV.
4863 @param ChildHandle Child handle to install DiskInfo protocol.
4864
4865 **/
4866 VOID
4867 InitializeInstallDiskInfo (
4868 IN SCSI_DISK_DEV *ScsiDiskDevice,
4869 IN EFI_HANDLE ChildHandle
4870 )
4871 {
4872 EFI_STATUS Status;
4873 EFI_DEVICE_PATH_PROTOCOL *DevicePathNode;
4874 EFI_DEVICE_PATH_PROTOCOL *ChildDevicePathNode;
4875 ATAPI_DEVICE_PATH *AtapiDevicePath;
4876 SATA_DEVICE_PATH *SataDevicePath;
4877 UINTN IdentifyRetry;
4878
4879 Status = gBS->HandleProtocol (ChildHandle, &gEfiDevicePathProtocolGuid, (VOID **) &DevicePathNode);
4880 //
4881 // Device Path protocol must be installed on the device handle.
4882 //
4883 ASSERT_EFI_ERROR (Status);
4884 //
4885 // Copy the DiskInfo protocol template.
4886 //
4887 CopyMem (&ScsiDiskDevice->DiskInfo, &gScsiDiskInfoProtocolTemplate, sizeof (gScsiDiskInfoProtocolTemplate));
4888
4889 while (!IsDevicePathEnd (DevicePathNode)) {
4890 ChildDevicePathNode = NextDevicePathNode (DevicePathNode);
4891 if ((DevicePathType (DevicePathNode) == HARDWARE_DEVICE_PATH) &&
4892 (DevicePathSubType (DevicePathNode) == HW_PCI_DP) &&
4893 (DevicePathType (ChildDevicePathNode) == MESSAGING_DEVICE_PATH) &&
4894 ((DevicePathSubType (ChildDevicePathNode) == MSG_ATAPI_DP) ||
4895 (DevicePathSubType (ChildDevicePathNode) == MSG_SATA_DP))) {
4896
4897 IdentifyRetry = 3;
4898 do {
4899 //
4900 // Issue ATA Identify Device Command via SCSI command, which is required to publish DiskInfo protocol
4901 // with IDE/AHCI interface GUID.
4902 //
4903 Status = AtapiIdentifyDevice (ScsiDiskDevice);
4904 if (!EFI_ERROR (Status)) {
4905 if (DevicePathSubType(ChildDevicePathNode) == MSG_ATAPI_DP) {
4906 //
4907 // We find the valid ATAPI device path
4908 //
4909 AtapiDevicePath = (ATAPI_DEVICE_PATH *) ChildDevicePathNode;
4910 ScsiDiskDevice->Channel = AtapiDevicePath->PrimarySecondary;
4911 ScsiDiskDevice->Device = AtapiDevicePath->SlaveMaster;
4912 //
4913 // Update the DiskInfo.Interface to IDE interface GUID for the physical ATAPI device.
4914 //
4915 CopyGuid (&ScsiDiskDevice->DiskInfo.Interface, &gEfiDiskInfoIdeInterfaceGuid);
4916 } else {
4917 //
4918 // We find the valid SATA device path
4919 //
4920 SataDevicePath = (SATA_DEVICE_PATH *) ChildDevicePathNode;
4921 ScsiDiskDevice->Channel = SataDevicePath->HBAPortNumber;
4922 ScsiDiskDevice->Device = SataDevicePath->PortMultiplierPortNumber;
4923 //
4924 // Update the DiskInfo.Interface to AHCI interface GUID for the physical AHCI device.
4925 //
4926 CopyGuid (&ScsiDiskDevice->DiskInfo.Interface, &gEfiDiskInfoAhciInterfaceGuid);
4927 }
4928 return;
4929 }
4930 } while (--IdentifyRetry > 0);
4931 } else if ((DevicePathType (ChildDevicePathNode) == MESSAGING_DEVICE_PATH) &&
4932 (DevicePathSubType (ChildDevicePathNode) == MSG_UFS_DP)) {
4933 CopyGuid (&ScsiDiskDevice->DiskInfo.Interface, &gEfiDiskInfoUfsInterfaceGuid);
4934 break;
4935 }
4936 DevicePathNode = ChildDevicePathNode;
4937 }
4938
4939 return;
4940 }
EFI Development Kit II mirror for PVE