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