2 This file implements ATA_PASSTHRU_PROCTOCOL and EXT_SCSI_PASSTHRU_PROTOCOL interfaces
3 for managed ATA controllers.
5 Copyright (c) 2010 - 2013, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #include "AtaAtapiPassThru.h"
19 // EFI_DRIVER_BINDING_PROTOCOL instance
21 EFI_DRIVER_BINDING_PROTOCOL gAtaAtapiPassThruDriverBinding
= {
22 AtaAtapiPassThruSupported
,
23 AtaAtapiPassThruStart
,
30 ATA_ATAPI_PASS_THRU_INSTANCE gAtaAtapiPassThruInstanceTemplate
= {
31 ATA_ATAPI_PASS_THRU_SIGNATURE
,
32 0, // Controller Handle
33 NULL
, // PciIo Protocol
34 NULL
, // IdeControllerInit Protocol
37 // According to UEFI2.3 spec Section 12.10, Drivers for non-RAID ATA controllers should set
38 // both EFI_ATA_PASS_THRU_ATTRIBUTES_PHYSICAL and EFI_ATA_PASS_THRU_ATTRIBUTES_LOGICAL
40 // Note that the driver doesn't support AtaPassThru non blocking I/O.
42 EFI_ATA_PASS_THRU_ATTRIBUTES_PHYSICAL
| EFI_ATA_PASS_THRU_ATTRIBUTES_LOGICAL
| EFI_ATA_PASS_THRU_ATTRIBUTES_NONBLOCKIO
,
51 AtaPassThruGetNextPort
,
52 AtaPassThruGetNextDevice
,
53 AtaPassThruBuildDevicePath
,
56 AtaPassThruResetDevice
58 { // ExtScsiPassThruMode
64 // According to UEFI2.3 spec Section 14.7, Drivers for non-RAID SCSI controllers should set
65 // both EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL and EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL
67 // Note that the driver doesn't support ExtScsiPassThru non blocking I/O.
69 EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL
| EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL
,
77 ExtScsiPassThruPassThru
,
78 ExtScsiPassThruGetNextTargetLun
,
79 ExtScsiPassThruBuildDevicePath
,
80 ExtScsiPassThruGetTargetLun
,
81 ExtScsiPassThruResetChannel
,
82 ExtScsiPassThruResetTargetLun
,
83 ExtScsiPassThruGetNextTarget
85 EfiAtaUnknownMode
, // Work Mode
97 0, // OriginalAttributes
99 0, // PreviousPortMultiplier
100 0, // PreviousTargetId
103 { // NonBlocking TaskList
109 ATAPI_DEVICE_PATH mAtapiDevicePathTemplate
= {
111 MESSAGING_DEVICE_PATH
,
114 (UINT8
) (sizeof (ATAPI_DEVICE_PATH
)),
115 (UINT8
) ((sizeof (ATAPI_DEVICE_PATH
)) >> 8)
123 SATA_DEVICE_PATH mSataDevicePathTemplate
= {
125 MESSAGING_DEVICE_PATH
,
128 (UINT8
) (sizeof (SATA_DEVICE_PATH
)),
129 (UINT8
) ((sizeof (SATA_DEVICE_PATH
)) >> 8)
137 UINT8 mScsiId
[TARGET_MAX_BYTES
] = {
138 0xFF, 0xFF, 0xFF, 0xFF,
139 0xFF, 0xFF, 0xFF, 0xFF,
140 0xFF, 0xFF, 0xFF, 0xFF,
141 0xFF, 0xFF, 0xFF, 0xFF
145 Sends an ATA command to an ATA device that is attached to the ATA controller. This function
146 supports both blocking I/O and non-blocking I/O. The blocking I/O functionality is required,
147 and the non-blocking I/O functionality is optional.
149 @param[in] Port The port number of the ATA device to send the command.
150 @param[in] PortMultiplierPort The port multiplier port number of the ATA device to send the command.
151 If there is no port multiplier, then specify 0.
152 @param[in, out] Packet A pointer to the ATA command to send to the ATA device specified by Port
153 and PortMultiplierPort.
154 @param[in] Instance Pointer to the ATA_ATAPI_PASS_THRU_INSTANCE.
155 @param[in] Task Optional. Pointer to the ATA_NONBLOCK_TASK
156 used by non-blocking mode.
158 @retval EFI_SUCCESS The ATA command was sent by the host. For
159 bi-directional commands, InTransferLength bytes
160 were transferred from InDataBuffer. For
161 write and bi-directional commands, OutTransferLength
162 bytes were transferred by OutDataBuffer.
163 @retval EFI_BAD_BUFFER_SIZE The ATA command was not executed. The number
164 of bytes that could be transferred is returned
165 in InTransferLength. For write and bi-directional
166 commands, OutTransferLength bytes were transferred
168 @retval EFI_NOT_READY The ATA command could not be sent because
169 there are too many ATA commands already
170 queued. The caller may retry again later.
171 @retval EFI_DEVICE_ERROR A device error occurred while attempting
172 to send the ATA command.
173 @retval EFI_INVALID_PARAMETER Port, PortMultiplierPort, or the contents
174 of Acb are invalid. The ATA command was
175 not sent, so no additional status information
181 AtaPassThruPassThruExecute (
183 IN UINT16 PortMultiplierPort
,
184 IN OUT EFI_ATA_PASS_THRU_COMMAND_PACKET
*Packet
,
185 IN ATA_ATAPI_PASS_THRU_INSTANCE
*Instance
,
186 IN ATA_NONBLOCK_TASK
*Task OPTIONAL
189 EFI_ATA_PASS_THRU_CMD_PROTOCOL Protocol
;
190 EFI_ATA_HC_WORK_MODE Mode
;
193 Protocol
= Packet
->Protocol
;
195 Mode
= Instance
->Mode
;
199 // Reassign IDE mode io port registers' base addresses
201 Status
= GetIdeRegisterIoAddr (Instance
->PciIo
, Instance
->IdeRegisters
);
203 if (EFI_ERROR (Status
)) {
208 case EFI_ATA_PASS_THRU_PROTOCOL_ATA_NON_DATA
:
209 Status
= AtaNonDataCommandIn (
211 &Instance
->IdeRegisters
[Port
],
218 case EFI_ATA_PASS_THRU_PROTOCOL_PIO_DATA_IN
:
219 Status
= AtaPioDataInOut (
221 &Instance
->IdeRegisters
[Port
],
222 Packet
->InDataBuffer
,
223 Packet
->InTransferLength
,
231 case EFI_ATA_PASS_THRU_PROTOCOL_PIO_DATA_OUT
:
232 Status
= AtaPioDataInOut (
234 &Instance
->IdeRegisters
[Port
],
235 Packet
->OutDataBuffer
,
236 Packet
->OutTransferLength
,
244 case EFI_ATA_PASS_THRU_PROTOCOL_UDMA_DATA_IN
:
245 Status
= AtaUdmaInOut (
247 &Instance
->IdeRegisters
[Port
],
249 Packet
->InDataBuffer
,
250 Packet
->InTransferLength
,
257 case EFI_ATA_PASS_THRU_PROTOCOL_UDMA_DATA_OUT
:
258 Status
= AtaUdmaInOut (
260 &Instance
->IdeRegisters
[Port
],
262 Packet
->OutDataBuffer
,
263 Packet
->OutTransferLength
,
271 return EFI_UNSUPPORTED
;
274 case EfiAtaAhciMode
:
276 case EFI_ATA_PASS_THRU_PROTOCOL_ATA_NON_DATA
:
277 Status
= AhciNonDataTransfer (
279 &Instance
->AhciRegisters
,
281 (UINT8
)PortMultiplierPort
,
290 case EFI_ATA_PASS_THRU_PROTOCOL_PIO_DATA_IN
:
291 Status
= AhciPioTransfer (
293 &Instance
->AhciRegisters
,
295 (UINT8
)PortMultiplierPort
,
301 Packet
->InDataBuffer
,
302 Packet
->InTransferLength
,
307 case EFI_ATA_PASS_THRU_PROTOCOL_PIO_DATA_OUT
:
308 Status
= AhciPioTransfer (
310 &Instance
->AhciRegisters
,
312 (UINT8
)PortMultiplierPort
,
318 Packet
->OutDataBuffer
,
319 Packet
->OutTransferLength
,
324 case EFI_ATA_PASS_THRU_PROTOCOL_UDMA_DATA_IN
:
325 Status
= AhciDmaTransfer (
327 &Instance
->AhciRegisters
,
329 (UINT8
)PortMultiplierPort
,
335 Packet
->InDataBuffer
,
336 Packet
->InTransferLength
,
341 case EFI_ATA_PASS_THRU_PROTOCOL_UDMA_DATA_OUT
:
342 Status
= AhciDmaTransfer (
344 &Instance
->AhciRegisters
,
346 (UINT8
)PortMultiplierPort
,
352 Packet
->OutDataBuffer
,
353 Packet
->OutTransferLength
,
359 return EFI_UNSUPPORTED
;
364 Status
= EFI_DEVICE_ERROR
;
372 Call back function when the timer event is signaled.
374 @param[in] Event The Event this notify function registered to.
375 @param[in] Context Pointer to the context data registered to the
381 AsyncNonBlockingTransferRoutine (
387 LIST_ENTRY
*EntryHeader
;
388 ATA_NONBLOCK_TASK
*Task
;
390 ATA_ATAPI_PASS_THRU_INSTANCE
*Instance
;
392 Instance
= (ATA_ATAPI_PASS_THRU_INSTANCE
*) Context
;
393 EntryHeader
= &Instance
->NonBlockingTaskList
;
395 // Get the Taks from the Taks List and execute it, until there is
396 // no task in the list or the device is busy with task (EFI_NOT_READY).
399 if (!IsListEmpty (EntryHeader
)) {
400 Entry
= GetFirstNode (EntryHeader
);
401 Task
= ATA_NON_BLOCK_TASK_FROM_ENTRY (Entry
);
406 Status
= AtaPassThruPassThruExecute (
408 Task
->PortMultiplier
,
415 // If the data transfer meet a error, remove all tasks in the list since these tasks are
416 // associated with one task from Ata Bus and signal the event with error status.
418 if ((Status
!= EFI_NOT_READY
) && (Status
!= EFI_SUCCESS
)) {
419 DestroyAsynTaskList (Instance
, TRUE
);
424 // For Non blocking mode, the Status of EFI_NOT_READY means the operation
425 // is not finished yet. Otherwise the operation is successful.
427 if (Status
== EFI_NOT_READY
) {
430 RemoveEntryList (&Task
->Link
);
431 gBS
->SignalEvent (Task
->Event
);
438 The Entry Point of module.
440 @param[in] ImageHandle The firmware allocated handle for the EFI image.
441 @param[in] SystemTable A pointer to the EFI System Table.
443 @retval EFI_SUCCESS The entry point is executed successfully.
444 @retval other Some error occurs when executing this entry point.
449 InitializeAtaAtapiPassThru (
450 IN EFI_HANDLE ImageHandle
,
451 IN EFI_SYSTEM_TABLE
*SystemTable
457 // Install driver model protocol(s).
459 Status
= EfiLibInstallDriverBindingComponentName2 (
462 &gAtaAtapiPassThruDriverBinding
,
464 &gAtaAtapiPassThruComponentName
,
465 &gAtaAtapiPassThruComponentName2
467 ASSERT_EFI_ERROR (Status
);
473 Tests to see if this driver supports a given controller. If a child device is provided,
474 it further tests to see if this driver supports creating a handle for the specified child device.
476 This function checks to see if the driver specified by This supports the device specified by
477 ControllerHandle. Drivers will typically use the device path attached to
478 ControllerHandle and/or the services from the bus I/O abstraction attached to
479 ControllerHandle to determine if the driver supports ControllerHandle. This function
480 may be called many times during platform initialization. In order to reduce boot times, the tests
481 performed by this function must be very small, and take as little time as possible to execute. This
482 function must not change the state of any hardware devices, and this function must be aware that the
483 device specified by ControllerHandle may already be managed by the same driver or a
484 different driver. This function must match its calls to AllocatePages() with FreePages(),
485 AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol().
486 Because ControllerHandle may have been previously started by the same driver, if a protocol is
487 already in the opened state, then it must not be closed with CloseProtocol(). This is required
488 to guarantee the state of ControllerHandle is not modified by this function.
490 @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
491 @param[in] ControllerHandle The handle of the controller to test. This handle
492 must support a protocol interface that supplies
493 an I/O abstraction to the driver.
494 @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This
495 parameter is ignored by device drivers, and is optional for bus
496 drivers. For bus drivers, if this parameter is not NULL, then
497 the bus driver must determine if the bus controller specified
498 by ControllerHandle and the child controller specified
499 by RemainingDevicePath are both supported by this
502 @retval EFI_SUCCESS The device specified by ControllerHandle and
503 RemainingDevicePath is supported by the driver specified by This.
504 @retval EFI_ALREADY_STARTED The device specified by ControllerHandle and
505 RemainingDevicePath is already being managed by the driver
507 @retval EFI_ACCESS_DENIED The device specified by ControllerHandle and
508 RemainingDevicePath is already being managed by a different
509 driver or an application that requires exclusive access.
510 Currently not implemented.
511 @retval EFI_UNSUPPORTED The device specified by ControllerHandle and
512 RemainingDevicePath is not supported by the driver specified by This.
516 AtaAtapiPassThruSupported (
517 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
518 IN EFI_HANDLE Controller
,
519 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
523 EFI_DEVICE_PATH_PROTOCOL
*ParentDevicePath
;
524 EFI_PCI_IO_PROTOCOL
*PciIo
;
526 EFI_IDE_CONTROLLER_INIT_PROTOCOL
*IdeControllerInit
;
529 // SATA Controller is a device driver, and should ingore the
530 // "RemainingDevicePath" according to UEFI spec
532 Status
= gBS
->OpenProtocol (
534 &gEfiDevicePathProtocolGuid
,
535 (VOID
*) &ParentDevicePath
,
536 This
->DriverBindingHandle
,
538 EFI_OPEN_PROTOCOL_BY_DRIVER
540 if (EFI_ERROR (Status
)) {
542 // EFI_ALREADY_STARTED is also an error
547 // Close the protocol because we don't use it here
551 &gEfiDevicePathProtocolGuid
,
552 This
->DriverBindingHandle
,
556 Status
= gBS
->OpenProtocol (
558 &gEfiIdeControllerInitProtocolGuid
,
559 (VOID
**) &IdeControllerInit
,
560 This
->DriverBindingHandle
,
562 EFI_OPEN_PROTOCOL_BY_DRIVER
565 if (EFI_ERROR (Status
)) {
567 // EFI_ALREADY_STARTED is also an error
573 // Close the I/O Abstraction(s) used to perform the supported test
577 &gEfiIdeControllerInitProtocolGuid
,
578 This
->DriverBindingHandle
,
583 // Now test the EfiPciIoProtocol
585 Status
= gBS
->OpenProtocol (
587 &gEfiPciIoProtocolGuid
,
589 This
->DriverBindingHandle
,
591 EFI_OPEN_PROTOCOL_GET_PROTOCOL
593 if (EFI_ERROR (Status
)) {
597 // Now further check the PCI header: Base class (offset 0x0B) and
598 // Sub Class (offset 0x0A). This controller should be an ATA controller
600 Status
= PciIo
->Pci
.Read (
603 PCI_CLASSCODE_OFFSET
,
604 sizeof (PciData
.Hdr
.ClassCode
),
605 PciData
.Hdr
.ClassCode
607 if (EFI_ERROR (Status
)) {
608 return EFI_UNSUPPORTED
;
611 if (IS_PCI_IDE (&PciData
) || IS_PCI_SATADPA (&PciData
)) {
615 return EFI_UNSUPPORTED
;
619 Starts a device controller or a bus controller.
621 The Start() function is designed to be invoked from the EFI boot service ConnectController().
622 As a result, much of the error checking on the parameters to Start() has been moved into this
623 common boot service. It is legal to call Start() from other locations,
624 but the following calling restrictions must be followed, or the system behavior will not be deterministic.
625 1. ControllerHandle must be a valid EFI_HANDLE.
626 2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned
627 EFI_DEVICE_PATH_PROTOCOL.
628 3. Prior to calling Start(), the Supported() function for the driver specified by This must
629 have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.
631 @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
632 @param[in] ControllerHandle The handle of the controller to start. This handle
633 must support a protocol interface that supplies
634 an I/O abstraction to the driver.
635 @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This
636 parameter is ignored by device drivers, and is optional for bus
637 drivers. For a bus driver, if this parameter is NULL, then handles
638 for all the children of Controller are created by this driver.
639 If this parameter is not NULL and the first Device Path Node is
640 not the End of Device Path Node, then only the handle for the
641 child device specified by the first Device Path Node of
642 RemainingDevicePath is created by this driver.
643 If the first Device Path Node of RemainingDevicePath is
644 the End of Device Path Node, no child handle is created by this
647 @retval EFI_SUCCESS The device was started.
648 @retval EFI_DEVICE_ERROR The device could not be started due to a device error.Currently not implemented.
649 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
650 @retval Others The driver failded to start the device.
655 AtaAtapiPassThruStart (
656 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
657 IN EFI_HANDLE Controller
,
658 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
662 EFI_IDE_CONTROLLER_INIT_PROTOCOL
*IdeControllerInit
;
663 ATA_ATAPI_PASS_THRU_INSTANCE
*Instance
;
664 EFI_PCI_IO_PROTOCOL
*PciIo
;
666 UINT64 OriginalPciAttributes
;
668 Status
= EFI_SUCCESS
;
669 IdeControllerInit
= NULL
;
671 OriginalPciAttributes
= 0;
673 DEBUG ((EFI_D_INFO
, "==AtaAtapiPassThru Start== Controller = %x\n", Controller
));
675 Status
= gBS
->OpenProtocol (
677 &gEfiIdeControllerInitProtocolGuid
,
678 (VOID
**) &IdeControllerInit
,
679 This
->DriverBindingHandle
,
681 EFI_OPEN_PROTOCOL_BY_DRIVER
684 if (EFI_ERROR (Status
)) {
685 DEBUG ((EFI_D_ERROR
, "Open Ide_Controller_Init Error, Status=%r", Status
));
689 Status
= gBS
->OpenProtocol (
691 &gEfiPciIoProtocolGuid
,
693 This
->DriverBindingHandle
,
695 EFI_OPEN_PROTOCOL_GET_PROTOCOL
697 if (EFI_ERROR (Status
)) {
698 DEBUG ((EFI_D_ERROR
, "Get Pci_Io Protocol Error, Status=%r", Status
));
702 Status
= PciIo
->Attributes (
704 EfiPciIoAttributeOperationGet
,
706 &OriginalPciAttributes
709 if (EFI_ERROR (Status
)) {
713 Status
= PciIo
->Attributes (
715 EfiPciIoAttributeOperationSupported
,
719 if (!EFI_ERROR (Status
)) {
720 Supports
&= EFI_PCI_DEVICE_ENABLE
;
721 Status
= PciIo
->Attributes (
723 EfiPciIoAttributeOperationEnable
,
729 if (EFI_ERROR (Status
)) {
734 // Allocate a buffer to store the ATA_ATAPI_PASS_THRU_INSTANCE data structure
736 Instance
= AllocateCopyPool (sizeof (ATA_ATAPI_PASS_THRU_INSTANCE
), &gAtaAtapiPassThruInstanceTemplate
);
737 if (Instance
== NULL
) {
741 Instance
->ControllerHandle
= Controller
;
742 Instance
->IdeControllerInit
= IdeControllerInit
;
743 Instance
->PciIo
= PciIo
;
744 Instance
->OriginalPciAttributes
= OriginalPciAttributes
;
745 Instance
->AtaPassThru
.Mode
= &Instance
->AtaPassThruMode
;
746 Instance
->ExtScsiPassThru
.Mode
= &Instance
->ExtScsiPassThruMode
;
747 InitializeListHead(&Instance
->DeviceList
);
748 InitializeListHead(&Instance
->NonBlockingTaskList
);
750 Instance
->TimerEvent
= NULL
;
752 Status
= gBS
->CreateEvent (
753 EVT_TIMER
| EVT_NOTIFY_SIGNAL
,
755 AsyncNonBlockingTransferRoutine
,
757 &Instance
->TimerEvent
759 if (EFI_ERROR (Status
)) {
766 Status
= gBS
->SetTimer (Instance
->TimerEvent
, TimerPeriodic
, 10000);
767 if (EFI_ERROR (Status
)) {
772 // Enumerate all inserted ATA devices.
774 Status
= EnumerateAttachedDevice (Instance
);
775 if (EFI_ERROR (Status
)) {
779 Status
= gBS
->InstallMultipleProtocolInterfaces (
781 &gEfiAtaPassThruProtocolGuid
, &(Instance
->AtaPassThru
),
782 &gEfiExtScsiPassThruProtocolGuid
, &(Instance
->ExtScsiPassThru
),
785 ASSERT_EFI_ERROR (Status
);
790 if (IdeControllerInit
!= NULL
) {
793 &gEfiIdeControllerInitProtocolGuid
,
794 This
->DriverBindingHandle
,
799 if ((Instance
!= NULL
) && (Instance
->TimerEvent
!= NULL
)) {
800 gBS
->CloseEvent (Instance
->TimerEvent
);
804 // Remove all inserted ATA devices.
806 DestroyDeviceInfoList(Instance
);
808 if (Instance
!= NULL
) {
811 return EFI_UNSUPPORTED
;
815 Stops a device controller or a bus controller.
817 The Stop() function is designed to be invoked from the EFI boot service DisconnectController().
818 As a result, much of the error checking on the parameters to Stop() has been moved
819 into this common boot service. It is legal to call Stop() from other locations,
820 but the following calling restrictions must be followed, or the system behavior will not be deterministic.
821 1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this
822 same driver's Start() function.
823 2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid
824 EFI_HANDLE. In addition, all of these handles must have been created in this driver's
825 Start() function, and the Start() function must have called OpenProtocol() on
826 ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.
828 @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
829 @param[in] ControllerHandle A handle to the device being stopped. The handle must
830 support a bus specific I/O protocol for the driver
831 to use to stop the device.
832 @param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer.
833 @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL
834 if NumberOfChildren is 0.
836 @retval EFI_SUCCESS The device was stopped.
837 @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.
842 AtaAtapiPassThruStop (
843 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
844 IN EFI_HANDLE Controller
,
845 IN UINTN NumberOfChildren
,
846 IN EFI_HANDLE
*ChildHandleBuffer
850 ATA_ATAPI_PASS_THRU_INSTANCE
*Instance
;
851 EFI_ATA_PASS_THRU_PROTOCOL
*AtaPassThru
;
852 EFI_PCI_IO_PROTOCOL
*PciIo
;
853 EFI_AHCI_REGISTERS
*AhciRegisters
;
856 DEBUG ((EFI_D_INFO
, "==AtaAtapiPassThru Stop== Controller = %x\n", Controller
));
858 Status
= gBS
->OpenProtocol (
860 &gEfiAtaPassThruProtocolGuid
,
861 (VOID
**) &AtaPassThru
,
862 This
->DriverBindingHandle
,
864 EFI_OPEN_PROTOCOL_GET_PROTOCOL
867 if (EFI_ERROR (Status
)) {
868 return EFI_DEVICE_ERROR
;
871 Instance
= ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS (AtaPassThru
);
874 // Close Non-Blocking timer and free Task list.
876 if (Instance
->TimerEvent
!= NULL
) {
877 gBS
->CloseEvent (Instance
->TimerEvent
);
878 Instance
->TimerEvent
= NULL
;
880 DestroyAsynTaskList (Instance
, FALSE
);
883 // Disable this ATA host controller.
885 PciIo
= Instance
->PciIo
;
886 Status
= PciIo
->Attributes (
888 EfiPciIoAttributeOperationSupported
,
892 if (!EFI_ERROR (Status
)) {
893 Supports
&= EFI_PCI_DEVICE_ENABLE
;
896 EfiPciIoAttributeOperationDisable
,
903 // Restore original PCI attributes
905 Status
= PciIo
->Attributes (
907 EfiPciIoAttributeOperationSet
,
908 Instance
->OriginalPciAttributes
,
911 ASSERT_EFI_ERROR (Status
);
913 gBS
->UninstallMultipleProtocolInterfaces (
915 &gEfiAtaPassThruProtocolGuid
, &(Instance
->AtaPassThru
),
916 &gEfiExtScsiPassThruProtocolGuid
, &(Instance
->ExtScsiPassThru
),
921 // Close protocols opened by AtaAtapiPassThru controller driver
925 &gEfiIdeControllerInitProtocolGuid
,
926 This
->DriverBindingHandle
,
931 // Free allocated resource
933 DestroyDeviceInfoList(Instance
);
936 // If the current working mode is AHCI mode, then pre-allocated resource
937 // for AHCI initialization should be released.
939 if (Instance
->Mode
== EfiAtaAhciMode
) {
940 AhciRegisters
= &Instance
->AhciRegisters
;
943 AhciRegisters
->MapCommandTable
947 EFI_SIZE_TO_PAGES ((UINTN
) AhciRegisters
->MaxCommandTableSize
),
948 AhciRegisters
->AhciCommandTable
952 AhciRegisters
->MapCmdList
956 EFI_SIZE_TO_PAGES ((UINTN
) AhciRegisters
->MaxCommandListSize
),
957 AhciRegisters
->AhciCmdList
961 AhciRegisters
->MapRFis
965 EFI_SIZE_TO_PAGES ((UINTN
) AhciRegisters
->MaxReceiveFisSize
),
966 AhciRegisters
->AhciRFis
975 Traverse the attached ATA devices list to find out the device to access.
977 @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance.
978 @param[in] Port The port number of the ATA device to send the command.
979 @param[in] PortMultiplierPort The port multiplier port number of the ATA device to send the command.
980 If there is no port multiplier, then specify 0.
981 @param[in] DeviceType The device type of the ATA device.
983 @retval The pointer to the data structure of the device info to access.
988 SearchDeviceInfoList (
989 IN ATA_ATAPI_PASS_THRU_INSTANCE
*Instance
,
991 IN UINT16 PortMultiplier
,
992 IN EFI_ATA_DEVICE_TYPE DeviceType
995 EFI_ATA_DEVICE_INFO
*DeviceInfo
;
998 Node
= GetFirstNode (&Instance
->DeviceList
);
999 while (!IsNull (&Instance
->DeviceList
, Node
)) {
1000 DeviceInfo
= ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node
);
1002 if ((DeviceInfo
->Type
== DeviceType
) &&
1003 (Port
== DeviceInfo
->Port
) &&
1004 (PortMultiplier
== DeviceInfo
->PortMultiplier
)) {
1008 Node
= GetNextNode (&Instance
->DeviceList
, Node
);
1015 Allocate device info data structure to contain device info.
1016 And insert the data structure to the tail of device list for tracing.
1018 @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance.
1019 @param[in] Port The port number of the ATA device to send the command.
1020 @param[in] PortMultiplierPort The port multiplier port number of the ATA device to send the command.
1021 If there is no port multiplier, then specify 0.
1022 @param[in] DeviceType The device type of the ATA device.
1023 @param[in] IdentifyData The data buffer to store the output of the IDENTIFY cmd.
1025 @retval EFI_SUCCESS Successfully insert the ata device to the tail of device list.
1026 @retval EFI_OUT_OF_RESOURCES Can not allocate enough resource for use.
1031 CreateNewDeviceInfo (
1032 IN ATA_ATAPI_PASS_THRU_INSTANCE
*Instance
,
1034 IN UINT16 PortMultiplier
,
1035 IN EFI_ATA_DEVICE_TYPE DeviceType
,
1036 IN EFI_IDENTIFY_DATA
*IdentifyData
1039 EFI_ATA_DEVICE_INFO
*DeviceInfo
;
1041 DeviceInfo
= AllocateZeroPool (sizeof (EFI_ATA_DEVICE_INFO
));
1043 if (DeviceInfo
== NULL
) {
1044 return EFI_OUT_OF_RESOURCES
;
1047 DeviceInfo
->Signature
= ATA_ATAPI_DEVICE_SIGNATURE
;
1048 DeviceInfo
->Port
= Port
;
1049 DeviceInfo
->PortMultiplier
= PortMultiplier
;
1050 DeviceInfo
->Type
= DeviceType
;
1052 if (IdentifyData
!= NULL
) {
1053 DeviceInfo
->IdentifyData
= AllocateCopyPool (sizeof (EFI_IDENTIFY_DATA
), IdentifyData
);
1054 if (DeviceInfo
->IdentifyData
== NULL
) {
1055 FreePool (DeviceInfo
);
1056 return EFI_OUT_OF_RESOURCES
;
1060 InsertTailList (&Instance
->DeviceList
, &DeviceInfo
->Link
);
1066 Destroy all attached ATA devices info.
1068 @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance.
1073 DestroyDeviceInfoList (
1074 IN ATA_ATAPI_PASS_THRU_INSTANCE
*Instance
1077 EFI_ATA_DEVICE_INFO
*DeviceInfo
;
1080 Node
= GetFirstNode (&Instance
->DeviceList
);
1081 while (!IsNull (&Instance
->DeviceList
, Node
)) {
1082 DeviceInfo
= ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node
);
1084 Node
= GetNextNode (&Instance
->DeviceList
, Node
);
1086 RemoveEntryList (&DeviceInfo
->Link
);
1087 if (DeviceInfo
->IdentifyData
!= NULL
) {
1088 FreePool (DeviceInfo
->IdentifyData
);
1090 FreePool (DeviceInfo
);
1095 Destroy all pending non blocking tasks.
1097 @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance.
1098 @param[in] IsSigEvent Indicate whether signal the task event when remove the
1104 DestroyAsynTaskList (
1105 IN ATA_ATAPI_PASS_THRU_INSTANCE
*Instance
,
1106 IN BOOLEAN IsSigEvent
1110 LIST_ENTRY
*DelEntry
;
1111 ATA_NONBLOCK_TASK
*Task
;
1114 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
1115 if (!IsListEmpty (&Instance
->NonBlockingTaskList
)) {
1117 // Free the Subtask list.
1119 for (Entry
= (&Instance
->NonBlockingTaskList
)->ForwardLink
;
1120 Entry
!= (&Instance
->NonBlockingTaskList
);
1123 Entry
= Entry
->ForwardLink
;
1124 Task
= ATA_NON_BLOCK_TASK_FROM_ENTRY (DelEntry
);
1126 RemoveEntryList (DelEntry
);
1128 Task
->Packet
->Asb
->AtaStatus
= 0x01;
1129 gBS
->SignalEvent (Task
->Event
);
1134 gBS
->RestoreTPL (OldTpl
);
1138 Enumerate all attached ATA devices at IDE mode or AHCI mode separately.
1140 The function is designed to enumerate all attached ATA devices.
1142 @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance.
1144 @retval EFI_SUCCESS Successfully enumerate attached ATA devices.
1145 @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.
1150 EnumerateAttachedDevice (
1151 IN ATA_ATAPI_PASS_THRU_INSTANCE
*Instance
1158 Status
= EFI_SUCCESS
;
1160 Status
= Instance
->PciIo
->Pci
.Read (
1163 PCI_CLASSCODE_OFFSET
,
1164 sizeof (PciData
.Hdr
.ClassCode
),
1165 PciData
.Hdr
.ClassCode
1167 ASSERT_EFI_ERROR (Status
);
1169 ClassCode
= PciData
.Hdr
.ClassCode
[1];
1171 switch (ClassCode
) {
1172 case PCI_CLASS_MASS_STORAGE_IDE
:
1174 // The ATA controller is working at IDE mode
1176 Instance
->Mode
= EfiAtaIdeMode
;
1178 Status
= IdeModeInitialization (Instance
);
1179 if (EFI_ERROR (Status
)) {
1180 Status
= EFI_DEVICE_ERROR
;
1184 case PCI_CLASS_MASS_STORAGE_SATADPA
:
1186 // The ATA controller is working at AHCI mode
1188 Instance
->Mode
= EfiAtaAhciMode
;
1190 Status
= AhciModeInitialization (Instance
);
1192 if (EFI_ERROR (Status
)) {
1193 Status
= EFI_DEVICE_ERROR
;
1199 Status
= EFI_UNSUPPORTED
;
1207 Sends an ATA command to an ATA device that is attached to the ATA controller. This function
1208 supports both blocking I/O and non-blocking I/O. The blocking I/O functionality is required,
1209 and the non-blocking I/O functionality is optional.
1211 @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
1212 @param[in] Port The port number of the ATA device to send the command.
1213 @param[in] PortMultiplierPort The port multiplier port number of the ATA device to send the command.
1214 If there is no port multiplier, then specify 0.
1215 @param[in, out] Packet A pointer to the ATA command to send to the ATA device specified by Port
1216 and PortMultiplierPort.
1217 @param[in] Event If non-blocking I/O is not supported then Event is ignored, and blocking
1218 I/O is performed. If Event is NULL, then blocking I/O is performed. If
1219 Event is not NULL and non blocking I/O is supported, then non-blocking
1220 I/O is performed, and Event will be signaled when the ATA command completes.
1222 @retval EFI_SUCCESS The ATA command was sent by the host. For bi-directional commands,
1223 InTransferLength bytes were transferred from InDataBuffer. For write and
1224 bi-directional commands, OutTransferLength bytes were transferred by OutDataBuffer.
1225 @retval EFI_BAD_BUFFER_SIZE The ATA command was not executed. The number of bytes that could be transferred
1226 is returned in InTransferLength. For write and bi-directional commands,
1227 OutTransferLength bytes were transferred by OutDataBuffer.
1228 @retval EFI_NOT_READY The ATA command could not be sent because there are too many ATA commands
1229 already queued. The caller may retry again later.
1230 @retval EFI_DEVICE_ERROR A device error occurred while attempting to send the ATA command.
1231 @retval EFI_INVALID_PARAMETER Port, PortMultiplierPort, or the contents of Acb are invalid. The ATA
1232 command was not sent, so no additional status information is available.
1237 AtaPassThruPassThru (
1238 IN EFI_ATA_PASS_THRU_PROTOCOL
*This
,
1240 IN UINT16 PortMultiplierPort
,
1241 IN OUT EFI_ATA_PASS_THRU_COMMAND_PACKET
*Packet
,
1242 IN EFI_EVENT Event OPTIONAL
1245 ATA_ATAPI_PASS_THRU_INSTANCE
*Instance
;
1247 EFI_ATA_DEVICE_INFO
*DeviceInfo
;
1248 EFI_IDENTIFY_DATA
*IdentifyData
;
1250 UINT32 MaxSectorCount
;
1251 ATA_NONBLOCK_TASK
*Task
;
1254 Instance
= ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS (This
);
1256 if ((This
->Mode
->IoAlign
> 1) && !IS_ALIGNED(Packet
->InDataBuffer
, This
->Mode
->IoAlign
)) {
1257 return EFI_INVALID_PARAMETER
;
1260 if ((This
->Mode
->IoAlign
> 1) && !IS_ALIGNED(Packet
->OutDataBuffer
, This
->Mode
->IoAlign
)) {
1261 return EFI_INVALID_PARAMETER
;
1264 if ((This
->Mode
->IoAlign
> 1) && !IS_ALIGNED(Packet
->Asb
, This
->Mode
->IoAlign
)) {
1265 return EFI_INVALID_PARAMETER
;
1268 Node
= SearchDeviceInfoList (Instance
, Port
, PortMultiplierPort
, EfiIdeHarddisk
);
1271 Node
= SearchDeviceInfoList(Instance
, Port
, PortMultiplierPort
, EfiIdeCdrom
);
1273 return EFI_INVALID_PARAMETER
;
1278 // convert the transfer length from sector count to byte.
1280 if (((Packet
->Length
& EFI_ATA_PASS_THRU_LENGTH_BYTES
) == 0) &&
1281 (Packet
->InTransferLength
!= 0)) {
1282 Packet
->InTransferLength
= Packet
->InTransferLength
* 0x200;
1286 // convert the transfer length from sector count to byte.
1288 if (((Packet
->Length
& EFI_ATA_PASS_THRU_LENGTH_BYTES
) == 0) &&
1289 (Packet
->OutTransferLength
!= 0)) {
1290 Packet
->OutTransferLength
= Packet
->OutTransferLength
* 0x200;
1294 // Check whether this device needs 48-bit addressing (ATAPI-6 ata device).
1295 // Per ATA-6 spec, word83: bit15 is zero and bit14 is one.
1296 // If bit10 is one, it means the ata device support 48-bit addressing.
1298 DeviceInfo
= ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node
);
1299 IdentifyData
= DeviceInfo
->IdentifyData
;
1300 MaxSectorCount
= 0x100;
1301 if ((IdentifyData
->AtaData
.command_set_supported_83
& (BIT10
| BIT15
| BIT14
)) == 0x4400) {
1302 Capacity
= *((UINT64
*)IdentifyData
->AtaData
.maximum_lba_for_48bit_addressing
);
1303 if (Capacity
> 0xFFFFFFF) {
1305 // Capacity exceeds 120GB. 48-bit addressing is really needed
1306 // In this case, the max sector count is 0x10000
1308 MaxSectorCount
= 0x10000;
1313 // If the data buffer described by InDataBuffer/OutDataBuffer and InTransferLength/OutTransferLength
1314 // is too big to be transferred in a single command, then no data is transferred and EFI_BAD_BUFFER_SIZE
1317 if (((Packet
->InTransferLength
!= 0) && (Packet
->InTransferLength
> MaxSectorCount
* 0x200)) ||
1318 ((Packet
->OutTransferLength
!= 0) && (Packet
->OutTransferLength
> MaxSectorCount
* 0x200))) {
1319 return EFI_BAD_BUFFER_SIZE
;
1323 // For non-blocking mode, queue the Task into the list.
1325 if (Event
!= NULL
) {
1326 Task
= AllocateZeroPool (sizeof (ATA_NONBLOCK_TASK
));
1328 return EFI_OUT_OF_RESOURCES
;
1331 Task
->Signature
= ATA_NONBLOCKING_TASK_SIGNATURE
;
1333 Task
->PortMultiplier
= PortMultiplierPort
;
1334 Task
->Packet
= Packet
;
1335 Task
->Event
= Event
;
1336 Task
->IsStart
= FALSE
;
1337 Task
->RetryTimes
= 0;
1339 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
1340 InsertTailList (&Instance
->NonBlockingTaskList
, &Task
->Link
);
1341 gBS
->RestoreTPL (OldTpl
);
1345 return AtaPassThruPassThruExecute (
1356 Used to retrieve the list of legal port numbers for ATA devices on an ATA controller.
1357 These can either be the list of ports where ATA devices are actually present or the
1358 list of legal port numbers for the ATA controller. Regardless, the caller of this
1359 function must probe the port number returned to see if an ATA device is actually
1360 present at that location on the ATA controller.
1362 The GetNextPort() function retrieves the port number on an ATA controller. If on input
1363 Port is 0xFFFF, then the port number of the first port on the ATA controller is returned
1364 in Port and EFI_SUCCESS is returned.
1366 If Port is a port number that was returned on a previous call to GetNextPort(), then the
1367 port number of the next port on the ATA controller is returned in Port, and EFI_SUCCESS
1368 is returned. If Port is not 0xFFFF and Port was not returned on a previous call to
1369 GetNextPort(), then EFI_INVALID_PARAMETER is returned.
1371 If Port is the port number of the last port on the ATA controller, then EFI_NOT_FOUND is
1374 @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
1375 @param[in, out] Port On input, a pointer to the port number on the ATA controller.
1376 On output, a pointer to the next port number on the ATA
1377 controller. An input value of 0xFFFF retrieves the first port
1378 number on the ATA controller.
1380 @retval EFI_SUCCESS The next port number on the ATA controller was returned in Port.
1381 @retval EFI_NOT_FOUND There are no more ports on this ATA controller.
1382 @retval EFI_INVALID_PARAMETER Port is not 0xFFFF and Port was not returned on a previous call
1388 AtaPassThruGetNextPort (
1389 IN EFI_ATA_PASS_THRU_PROTOCOL
*This
,
1393 ATA_ATAPI_PASS_THRU_INSTANCE
*Instance
;
1395 EFI_ATA_DEVICE_INFO
*DeviceInfo
;
1397 Instance
= ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS (This
);
1400 return EFI_INVALID_PARAMETER
;
1403 if (*Port
== 0xFFFF) {
1405 // If the Port is all 0xFF's, start to traverse the device list from the beginning
1407 Node
= GetFirstNode (&Instance
->DeviceList
);
1409 while (!IsNull (&Instance
->DeviceList
, Node
)) {
1410 DeviceInfo
= ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node
);
1412 if (DeviceInfo
->Type
== EfiIdeHarddisk
) {
1413 *Port
= DeviceInfo
->Port
;
1417 Node
= GetNextNode (&Instance
->DeviceList
, Node
);
1420 return EFI_NOT_FOUND
;
1421 } else if (*Port
== Instance
->PreviousPort
) {
1422 Node
= GetFirstNode (&Instance
->DeviceList
);
1424 while (!IsNull (&Instance
->DeviceList
, Node
)) {
1425 DeviceInfo
= ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node
);
1427 if ((DeviceInfo
->Type
== EfiIdeHarddisk
) &&
1428 (DeviceInfo
->Port
> *Port
)){
1429 *Port
= DeviceInfo
->Port
;
1433 Node
= GetNextNode (&Instance
->DeviceList
, Node
);
1436 return EFI_NOT_FOUND
;
1439 // Port is not equal to 0xFFFF and also not equal to previous return value
1441 return EFI_INVALID_PARAMETER
;
1446 // Update the PreviousPort and PreviousPortMultiplier.
1448 Instance
->PreviousPort
= *Port
;
1454 Used to retrieve the list of legal port multiplier port numbers for ATA devices on a port of an ATA
1455 controller. These can either be the list of port multiplier ports where ATA devices are actually
1456 present on port or the list of legal port multiplier ports on that port. Regardless, the caller of this
1457 function must probe the port number and port multiplier port number returned to see if an ATA
1458 device is actually present.
1460 The GetNextDevice() function retrieves the port multiplier port number of an ATA device
1461 present on a port of an ATA controller.
1463 If PortMultiplierPort points to a port multiplier port number value that was returned on a
1464 previous call to GetNextDevice(), then the port multiplier port number of the next ATA device
1465 on the port of the ATA controller is returned in PortMultiplierPort, and EFI_SUCCESS is
1468 If PortMultiplierPort points to 0xFFFF, then the port multiplier port number of the first
1469 ATA device on port of the ATA controller is returned in PortMultiplierPort and
1470 EFI_SUCCESS is returned.
1472 If PortMultiplierPort is not 0xFFFF and the value pointed to by PortMultiplierPort
1473 was not returned on a previous call to GetNextDevice(), then EFI_INVALID_PARAMETER
1476 If PortMultiplierPort is the port multiplier port number of the last ATA device on the port of
1477 the ATA controller, then EFI_NOT_FOUND is returned.
1479 @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
1480 @param[in] Port The port number present on the ATA controller.
1481 @param[in, out] PortMultiplierPort On input, a pointer to the port multiplier port number of an
1482 ATA device present on the ATA controller.
1483 If on input a PortMultiplierPort of 0xFFFF is specified,
1484 then the port multiplier port number of the first ATA device
1485 is returned. On output, a pointer to the port multiplier port
1486 number of the next ATA device present on an ATA controller.
1488 @retval EFI_SUCCESS The port multiplier port number of the next ATA device on the port
1489 of the ATA controller was returned in PortMultiplierPort.
1490 @retval EFI_NOT_FOUND There are no more ATA devices on this port of the ATA controller.
1491 @retval EFI_INVALID_PARAMETER PortMultiplierPort is not 0xFFFF, and PortMultiplierPort was not
1492 returned on a previous call to GetNextDevice().
1497 AtaPassThruGetNextDevice (
1498 IN EFI_ATA_PASS_THRU_PROTOCOL
*This
,
1500 IN OUT UINT16
*PortMultiplierPort
1503 ATA_ATAPI_PASS_THRU_INSTANCE
*Instance
;
1505 EFI_ATA_DEVICE_INFO
*DeviceInfo
;
1507 Instance
= ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS (This
);
1509 if (PortMultiplierPort
== NULL
) {
1510 return EFI_INVALID_PARAMETER
;
1513 if (*PortMultiplierPort
== 0xFFFF) {
1515 // If the PortMultiplierPort is all 0xFF's, start to traverse the device list from the beginning
1517 Node
= GetFirstNode (&Instance
->DeviceList
);
1519 while (!IsNull (&Instance
->DeviceList
, Node
)) {
1520 DeviceInfo
= ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node
);
1522 if ((DeviceInfo
->Type
== EfiIdeHarddisk
) &&
1523 (DeviceInfo
->Port
== Port
)){
1524 *PortMultiplierPort
= DeviceInfo
->PortMultiplier
;
1528 Node
= GetNextNode (&Instance
->DeviceList
, Node
);
1531 return EFI_NOT_FOUND
;
1532 } else if (*PortMultiplierPort
== Instance
->PreviousPortMultiplier
) {
1533 Node
= GetFirstNode (&Instance
->DeviceList
);
1535 while (!IsNull (&Instance
->DeviceList
, Node
)) {
1536 DeviceInfo
= ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node
);
1538 if ((DeviceInfo
->Type
== EfiIdeHarddisk
) &&
1539 (DeviceInfo
->Port
== Port
) &&
1540 (DeviceInfo
->PortMultiplier
> *PortMultiplierPort
)){
1541 *PortMultiplierPort
= DeviceInfo
->PortMultiplier
;
1545 Node
= GetNextNode (&Instance
->DeviceList
, Node
);
1548 return EFI_NOT_FOUND
;
1551 // PortMultiplierPort is not equal to 0xFFFF and also not equal to previous return value
1553 return EFI_INVALID_PARAMETER
;
1558 // Update the PreviousPort and PreviousPortMultiplier.
1560 Instance
->PreviousPortMultiplier
= *PortMultiplierPort
;
1566 Used to allocate and build a device path node for an ATA device on an ATA controller.
1568 The BuildDevicePath() function allocates and builds a single device node for the ATA
1569 device specified by Port and PortMultiplierPort. If the ATA device specified by Port and
1570 PortMultiplierPort is not present on the ATA controller, then EFI_NOT_FOUND is returned.
1571 If DevicePath is NULL, then EFI_INVALID_PARAMETER is returned. If there are not enough
1572 resources to allocate the device path node, then EFI_OUT_OF_RESOURCES is returned.
1574 Otherwise, DevicePath is allocated with the boot service AllocatePool(), the contents of
1575 DevicePath are initialized to describe the ATA device specified by Port and PortMultiplierPort,
1576 and EFI_SUCCESS is returned.
1578 @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
1579 @param[in] Port Port specifies the port number of the ATA device for which a
1580 device path node is to be allocated and built.
1581 @param[in] PortMultiplierPort The port multiplier port number of the ATA device for which a
1582 device path node is to be allocated and built. If there is no
1583 port multiplier, then specify 0.
1584 @param[in, out] DevicePath A pointer to a single device path node that describes the ATA
1585 device specified by Port and PortMultiplierPort. This function
1586 is responsible for allocating the buffer DevicePath with the
1587 boot service AllocatePool(). It is the caller's responsibility
1588 to free DevicePath when the caller is finished with DevicePath.
1589 @retval EFI_SUCCESS The device path node that describes the ATA device specified by
1590 Port and PortMultiplierPort was allocated and returned in DevicePath.
1591 @retval EFI_NOT_FOUND The ATA device specified by Port and PortMultiplierPort does not
1592 exist on the ATA controller.
1593 @retval EFI_INVALID_PARAMETER DevicePath is NULL.
1594 @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate DevicePath.
1599 AtaPassThruBuildDevicePath (
1600 IN EFI_ATA_PASS_THRU_PROTOCOL
*This
,
1602 IN UINT16 PortMultiplierPort
,
1603 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
1606 EFI_DEV_PATH
*DevicePathNode
;
1607 ATA_ATAPI_PASS_THRU_INSTANCE
*Instance
;
1610 Instance
= ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS (This
);
1613 // Validate parameters passed in.
1615 if (DevicePath
== NULL
) {
1616 return EFI_INVALID_PARAMETER
;
1619 Node
= SearchDeviceInfoList(Instance
, Port
, PortMultiplierPort
, EfiIdeHarddisk
);
1621 return EFI_NOT_FOUND
;
1624 if (Instance
->Mode
== EfiAtaIdeMode
) {
1625 DevicePathNode
= AllocateCopyPool (sizeof (ATAPI_DEVICE_PATH
), &mAtapiDevicePathTemplate
);
1626 if (DevicePathNode
== NULL
) {
1627 return EFI_OUT_OF_RESOURCES
;
1629 DevicePathNode
->Atapi
.PrimarySecondary
= (UINT8
) Port
;
1630 DevicePathNode
->Atapi
.SlaveMaster
= (UINT8
) PortMultiplierPort
;
1631 DevicePathNode
->Atapi
.Lun
= 0;
1633 DevicePathNode
= AllocateCopyPool (sizeof (SATA_DEVICE_PATH
), &mSataDevicePathTemplate
);
1634 if (DevicePathNode
== NULL
) {
1635 return EFI_OUT_OF_RESOURCES
;
1638 DevicePathNode
->Sata
.HBAPortNumber
= Port
;
1639 DevicePathNode
->Sata
.PortMultiplierPortNumber
= PortMultiplierPort
;
1640 DevicePathNode
->Sata
.Lun
= 0;
1643 *DevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) DevicePathNode
;
1649 Used to translate a device path node to a port number and port multiplier port number.
1651 The GetDevice() function determines the port and port multiplier port number associated with
1652 the ATA device described by DevicePath. If DevicePath is a device path node type that the
1653 ATA Pass Thru driver supports, then the ATA Pass Thru driver will attempt to translate the contents
1654 DevicePath into a port number and port multiplier port number.
1656 If this translation is successful, then that port number and port multiplier port number are returned
1657 in Port and PortMultiplierPort, and EFI_SUCCESS is returned.
1659 If DevicePath, Port, or PortMultiplierPort are NULL, then EFI_INVALID_PARAMETER is returned.
1661 If DevicePath is not a device path node type that the ATA Pass Thru driver supports, then
1662 EFI_UNSUPPORTED is returned.
1664 If DevicePath is a device path node type that the ATA Pass Thru driver supports, but there is not
1665 a valid translation from DevicePath to a port number and port multiplier port number, then
1666 EFI_NOT_FOUND is returned.
1668 @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
1669 @param[in] DevicePath A pointer to the device path node that describes an ATA device on the
1671 @param[out] Port On return, points to the port number of an ATA device on the ATA controller.
1672 @param[out] PortMultiplierPort On return, points to the port multiplier port number of an ATA device
1673 on the ATA controller.
1675 @retval EFI_SUCCESS DevicePath was successfully translated to a port number and port multiplier
1676 port number, and they were returned in Port and PortMultiplierPort.
1677 @retval EFI_INVALID_PARAMETER DevicePath is NULL.
1678 @retval EFI_INVALID_PARAMETER Port is NULL.
1679 @retval EFI_INVALID_PARAMETER PortMultiplierPort is NULL.
1680 @retval EFI_UNSUPPORTED This driver does not support the device path node type in DevicePath.
1681 @retval EFI_NOT_FOUND A valid translation from DevicePath to a port number and port multiplier
1682 port number does not exist.
1686 AtaPassThruGetDevice (
1687 IN EFI_ATA_PASS_THRU_PROTOCOL
*This
,
1688 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
1690 OUT UINT16
*PortMultiplierPort
1693 EFI_DEV_PATH
*DevicePathNode
;
1694 ATA_ATAPI_PASS_THRU_INSTANCE
*Instance
;
1697 Instance
= ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS (This
);
1700 // Validate parameters passed in.
1702 if (DevicePath
== NULL
|| Port
== NULL
|| PortMultiplierPort
== NULL
) {
1703 return EFI_INVALID_PARAMETER
;
1707 // Check whether the DevicePath belongs to SCSI_DEVICE_PATH or ATAPI_DEVICE_PATH
1709 if ((DevicePath
->Type
!= MESSAGING_DEVICE_PATH
) ||
1710 ((DevicePath
->SubType
!= MSG_SATA_DP
) &&
1711 (DevicePath
->SubType
!= MSG_ATAPI_DP
)) ||
1712 ((DevicePathNodeLength(DevicePath
) != sizeof(ATAPI_DEVICE_PATH
)) &&
1713 (DevicePathNodeLength(DevicePath
) != sizeof(SATA_DEVICE_PATH
)))) {
1714 return EFI_UNSUPPORTED
;
1717 DevicePathNode
= (EFI_DEV_PATH
*) DevicePath
;
1719 if (Instance
->Mode
== EfiAtaIdeMode
) {
1720 *Port
= DevicePathNode
->Atapi
.PrimarySecondary
;
1721 *PortMultiplierPort
= DevicePathNode
->Atapi
.SlaveMaster
;
1723 *Port
= DevicePathNode
->Sata
.HBAPortNumber
;
1724 *PortMultiplierPort
= DevicePathNode
->Sata
.PortMultiplierPortNumber
;
1727 Node
= SearchDeviceInfoList(Instance
, *Port
, *PortMultiplierPort
, EfiIdeHarddisk
);
1730 return EFI_NOT_FOUND
;
1737 Resets a specific port on the ATA controller. This operation also resets all the ATA devices
1738 connected to the port.
1740 The ResetChannel() function resets an a specific port on an ATA controller. This operation
1741 resets all the ATA devices connected to that port. If this ATA controller does not support
1742 a reset port operation, then EFI_UNSUPPORTED is returned.
1744 If a device error occurs while executing that port reset operation, then EFI_DEVICE_ERROR is
1747 If a timeout occurs during the execution of the port reset operation, then EFI_TIMEOUT is returned.
1749 If the port reset operation is completed, then EFI_SUCCESS is returned.
1751 @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
1752 @param[in] Port The port number on the ATA controller.
1754 @retval EFI_SUCCESS The ATA controller port was reset.
1755 @retval EFI_UNSUPPORTED The ATA controller does not support a port reset operation.
1756 @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the ATA port.
1757 @retval EFI_TIMEOUT A timeout occurred while attempting to reset the ATA port.
1762 AtaPassThruResetPort (
1763 IN EFI_ATA_PASS_THRU_PROTOCOL
*This
,
1768 // Return success directly then upper layer driver could think reset port operation is done.
1774 Resets an ATA device that is connected to an ATA controller.
1776 The ResetDevice() function resets the ATA device specified by Port and PortMultiplierPort.
1777 If this ATA controller does not support a device reset operation, then EFI_UNSUPPORTED is
1780 If Port or PortMultiplierPort are not in a valid range for this ATA controller, then
1781 EFI_INVALID_PARAMETER is returned.
1783 If a device error occurs while executing that device reset operation, then EFI_DEVICE_ERROR
1786 If a timeout occurs during the execution of the device reset operation, then EFI_TIMEOUT is
1789 If the device reset operation is completed, then EFI_SUCCESS is returned.
1791 @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
1792 @param[in] Port Port represents the port number of the ATA device to be reset.
1793 @param[in] PortMultiplierPort The port multiplier port number of the ATA device to reset.
1794 If there is no port multiplier, then specify 0.
1795 @retval EFI_SUCCESS The ATA device specified by Port and PortMultiplierPort was reset.
1796 @retval EFI_UNSUPPORTED The ATA controller does not support a device reset operation.
1797 @retval EFI_INVALID_PARAMETER Port or PortMultiplierPort are invalid.
1798 @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the ATA device
1799 specified by Port and PortMultiplierPort.
1800 @retval EFI_TIMEOUT A timeout occurred while attempting to reset the ATA device
1801 specified by Port and PortMultiplierPort.
1806 AtaPassThruResetDevice (
1807 IN EFI_ATA_PASS_THRU_PROTOCOL
*This
,
1809 IN UINT16 PortMultiplierPort
1812 ATA_ATAPI_PASS_THRU_INSTANCE
*Instance
;
1815 Instance
= ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS (This
);
1817 Node
= SearchDeviceInfoList (Instance
, Port
, PortMultiplierPort
, EfiIdeHarddisk
);
1820 return EFI_INVALID_PARAMETER
;
1824 // Return success directly then upper layer driver could think reset device operation is done.
1830 Sends a SCSI Request Packet to a SCSI device that is attached to the SCSI channel. This function
1831 supports both blocking I/O and nonblocking I/O. The blocking I/O functionality is required, and the
1832 nonblocking I/O functionality is optional.
1834 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
1835 @param Target The Target is an array of size TARGET_MAX_BYTES and it represents
1836 the id of the SCSI device to send the SCSI Request Packet. Each
1837 transport driver may choose to utilize a subset of this size to suit the needs
1838 of transport target representation. For example, a Fibre Channel driver
1839 may use only 8 bytes (WWN) to represent an FC target.
1840 @param Lun The LUN of the SCSI device to send the SCSI Request Packet.
1841 @param Packet A pointer to the SCSI Request Packet to send to the SCSI device
1842 specified by Target and Lun.
1843 @param Event If nonblocking I/O is not supported then Event is ignored, and blocking
1844 I/O is performed. If Event is NULL, then blocking I/O is performed. If
1845 Event is not NULL and non blocking I/O is supported, then
1846 nonblocking I/O is performed, and Event will be signaled when the
1847 SCSI Request Packet completes.
1849 @retval EFI_SUCCESS The SCSI Request Packet was sent by the host. For bi-directional
1850 commands, InTransferLength bytes were transferred from
1851 InDataBuffer. For write and bi-directional commands,
1852 OutTransferLength bytes were transferred by
1854 @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was not executed. The number of bytes that
1855 could be transferred is returned in InTransferLength. For write
1856 and bi-directional commands, OutTransferLength bytes were
1857 transferred by OutDataBuffer.
1858 @retval EFI_NOT_READY The SCSI Request Packet could not be sent because there are too many
1859 SCSI Request Packets already queued. The caller may retry again later.
1860 @retval EFI_DEVICE_ERROR A device error occurred while attempting to send the SCSI Request
1862 @retval EFI_INVALID_PARAMETER Target, Lun, or the contents of ScsiRequestPacket are invalid.
1863 @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported
1864 by the host adapter. This includes the case of Bi-directional SCSI
1865 commands not supported by the implementation. The SCSI Request
1866 Packet was not sent, so no additional status information is available.
1867 @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
1872 ExtScsiPassThruPassThru (
1873 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
1876 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
,
1877 IN EFI_EVENT Event OPTIONAL
1881 ATA_ATAPI_PASS_THRU_INSTANCE
*Instance
;
1883 UINT8 PortMultiplier
;
1884 EFI_ATA_HC_WORK_MODE Mode
;
1886 EFI_ATA_DEVICE_INFO
*DeviceInfo
;
1888 Instance
= EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS (This
);
1890 if ((Packet
== NULL
) || (Packet
->Cdb
== NULL
)) {
1891 return EFI_INVALID_PARAMETER
;
1895 // Don't support variable length CDB
1897 if ((Packet
->CdbLength
!= 6) && (Packet
->CdbLength
!= 10) &&
1898 (Packet
->CdbLength
!= 12) && (Packet
->CdbLength
!= 16)) {
1899 return EFI_INVALID_PARAMETER
;
1902 if ((This
->Mode
->IoAlign
> 1) && !IS_ALIGNED(Packet
->InDataBuffer
, This
->Mode
->IoAlign
)) {
1903 return EFI_INVALID_PARAMETER
;
1906 if ((This
->Mode
->IoAlign
> 1) && !IS_ALIGNED(Packet
->OutDataBuffer
, This
->Mode
->IoAlign
)) {
1907 return EFI_INVALID_PARAMETER
;
1910 if ((This
->Mode
->IoAlign
> 1) && !IS_ALIGNED(Packet
->SenseData
, This
->Mode
->IoAlign
)) {
1911 return EFI_INVALID_PARAMETER
;
1915 // For ATAPI device, doesn't support multiple LUN device.
1918 return EFI_INVALID_PARAMETER
;
1922 // The layout of Target array:
1923 // ________________________________________________________________________
1924 // | Byte 0 | Byte 1 | ... | TARGET_MAX_BYTES - 1 |
1925 // |_____________________|_____________________|_____|______________________|
1926 // | | The port multiplier | | |
1927 // | The port number | port number | N/A | N/A |
1928 // |_____________________|_____________________|_____|______________________|
1930 // For ATAPI device, 2 bytes is enough to represent the location of SCSI device.
1933 PortMultiplier
= Target
[1];
1935 Node
= SearchDeviceInfoList(Instance
, Port
, PortMultiplier
, EfiIdeCdrom
);
1937 return EFI_INVALID_PARAMETER
;
1940 DeviceInfo
= ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node
);
1943 // ATA_CMD_IDENTIFY_DEVICE cmd is a ATA cmd but not a SCSI cmd.
1944 // Normally it should NOT be passed down through ExtScsiPassThru protocol interface.
1945 // But to response EFI_DISK_INFO.Identify() request from ScsiDisk, we should handle this command.
1947 if (*((UINT8
*)Packet
->Cdb
) == ATA_CMD_IDENTIFY_DEVICE
) {
1948 CopyMem (Packet
->InDataBuffer
, DeviceInfo
->IdentifyData
, sizeof (EFI_IDENTIFY_DATA
));
1952 Mode
= Instance
->Mode
;
1956 // Reassign IDE mode io port registers' base addresses
1958 Status
= GetIdeRegisterIoAddr (Instance
->PciIo
, Instance
->IdeRegisters
);
1960 if (EFI_ERROR (Status
)) {
1964 Status
= AtaPacketCommandExecute (Instance
->PciIo
, &Instance
->IdeRegisters
[Port
], Port
, PortMultiplier
, Packet
);
1966 case EfiAtaAhciMode
:
1967 Status
= AhciPacketCommandExecute (Instance
->PciIo
, &Instance
->AhciRegisters
, Port
, PortMultiplier
, Packet
);
1970 Status
= EFI_DEVICE_ERROR
;
1978 Used to retrieve the list of legal Target IDs and LUNs for SCSI devices on a SCSI channel. These
1979 can either be the list SCSI devices that are actually present on the SCSI channel, or the list of legal
1980 Target Ids and LUNs for the SCSI channel. Regardless, the caller of this function must probe the
1981 Target ID and LUN returned to see if a SCSI device is actually present at that location on the SCSI
1984 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
1985 @param Target On input, a pointer to the Target ID (an array of size
1986 TARGET_MAX_BYTES) of a SCSI device present on the SCSI channel.
1987 On output, a pointer to the Target ID (an array of
1988 TARGET_MAX_BYTES) of the next SCSI device present on a SCSI
1989 channel. An input value of 0xF(all bytes in the array are 0xF) in the
1990 Target array retrieves the Target ID of the first SCSI device present on a
1992 @param Lun On input, a pointer to the LUN of a SCSI device present on the SCSI
1993 channel. On output, a pointer to the LUN of the next SCSI device present
1996 @retval EFI_SUCCESS The Target ID and LUN of the next SCSI device on the SCSI
1997 channel was returned in Target and Lun.
1998 @retval EFI_INVALID_PARAMETER Target array is not all 0xF, and Target and Lun were
1999 not returned on a previous call to GetNextTargetLun().
2000 @retval EFI_NOT_FOUND There are no more SCSI devices on this SCSI channel.
2005 ExtScsiPassThruGetNextTargetLun (
2006 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
2007 IN OUT UINT8
**Target
,
2011 ATA_ATAPI_PASS_THRU_INSTANCE
*Instance
;
2013 EFI_ATA_DEVICE_INFO
*DeviceInfo
;
2017 Instance
= EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS (This
);
2019 if (Target
== NULL
|| Lun
== NULL
) {
2020 return EFI_INVALID_PARAMETER
;
2023 if (*Target
== NULL
) {
2024 return EFI_INVALID_PARAMETER
;
2028 Target16
= (UINT16
*)*Target
;
2030 if (CompareMem(Target8
, mScsiId
, TARGET_MAX_BYTES
) != 0) {
2032 // For ATAPI device, we use 2 least significant bytes to represent the location of SCSI device.
2033 // So the higher bytes in Target array should be 0xFF.
2035 if (CompareMem (&Target8
[2], &mScsiId
[2], TARGET_MAX_BYTES
- 2) != 0) {
2036 return EFI_INVALID_PARAMETER
;
2040 // When Target is not all 0xFF's, compare 2 least significant bytes with
2041 // previous target id to see if it is returned by previous call.
2043 if ((*Target16
!= Instance
->PreviousTargetId
) ||
2044 (*Lun
!= Instance
->PreviousLun
)) {
2045 return EFI_INVALID_PARAMETER
;
2049 // Traverse the whole device list to find the next cdrom closed to
2050 // the device signified by Target[0] and Target[1].
2052 // Note that we here use a tricky way to find the next cdrom :
2053 // All ata devices are detected and inserted into the device list
2056 Node
= GetFirstNode (&Instance
->DeviceList
);
2058 while (!IsNull (&Instance
->DeviceList
, Node
)) {
2059 DeviceInfo
= ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node
);
2061 if ((DeviceInfo
->Type
== EfiIdeCdrom
) &&
2062 ((Target8
[0] < DeviceInfo
->Port
) ||
2063 ((Target8
[0] == DeviceInfo
->Port
) &&
2064 (Target8
[1] < DeviceInfo
->PortMultiplier
)))) {
2065 Target8
[0] = (UINT8
)DeviceInfo
->Port
;
2066 Target8
[1] = (UINT8
)DeviceInfo
->PortMultiplier
;
2070 Node
= GetNextNode (&Instance
->DeviceList
, Node
);
2073 return EFI_NOT_FOUND
;
2076 // If the array is all 0xFF's, start to traverse the device list from the beginning
2078 Node
= GetFirstNode (&Instance
->DeviceList
);
2079 while (!IsNull (&Instance
->DeviceList
, Node
)) {
2080 DeviceInfo
= ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node
);
2082 if (DeviceInfo
->Type
== EfiIdeCdrom
) {
2083 Target8
[0] = (UINT8
)DeviceInfo
->Port
;
2084 Target8
[1] = (UINT8
)DeviceInfo
->PortMultiplier
;
2088 Node
= GetNextNode (&Instance
->DeviceList
, Node
);
2091 return EFI_NOT_FOUND
;
2098 // Update the PreviousTargetId.
2100 Instance
->PreviousTargetId
= *Target16
;
2101 Instance
->PreviousLun
= *Lun
;
2107 Used to allocate and build a device path node for a SCSI device on a SCSI channel.
2109 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
2110 @param Target The Target is an array of size TARGET_MAX_BYTES and it specifies the
2111 Target ID of the SCSI device for which a device path node is to be
2112 allocated and built. Transport drivers may chose to utilize a subset of
2113 this size to suit the representation of targets. For example, a Fibre
2114 Channel driver may use only 8 bytes (WWN) in the array to represent a
2116 @param Lun The LUN of the SCSI device for which a device path node is to be
2117 allocated and built.
2118 @param DevicePath A pointer to a single device path node that describes the SCSI device
2119 specified by Target and Lun. This function is responsible for
2120 allocating the buffer DevicePath with the boot service
2121 AllocatePool(). It is the caller's responsibility to free
2122 DevicePath when the caller is finished with DevicePath.
2124 @retval EFI_SUCCESS The device path node that describes the SCSI device specified by
2125 Target and Lun was allocated and returned in
2127 @retval EFI_INVALID_PARAMETER DevicePath is NULL.
2128 @retval EFI_NOT_FOUND The SCSI devices specified by Target and Lun does not exist
2129 on the SCSI channel.
2130 @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate DevicePath.
2135 ExtScsiPassThruBuildDevicePath (
2136 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
2139 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
2142 EFI_DEV_PATH
*DevicePathNode
;
2143 ATA_ATAPI_PASS_THRU_INSTANCE
*Instance
;
2145 UINT8 PortMultiplier
;
2147 Instance
= EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS (This
);
2150 PortMultiplier
= Target
[1];
2153 // Validate parameters passed in.
2155 if (DevicePath
== NULL
) {
2156 return EFI_INVALID_PARAMETER
;
2160 // can not build device path for the SCSI Host Controller.
2163 return EFI_NOT_FOUND
;
2166 if (SearchDeviceInfoList(Instance
, Port
, PortMultiplier
, EfiIdeCdrom
) == NULL
) {
2167 return EFI_NOT_FOUND
;
2170 if (Instance
->Mode
== EfiAtaIdeMode
) {
2171 DevicePathNode
= AllocateCopyPool (sizeof (ATAPI_DEVICE_PATH
), &mAtapiDevicePathTemplate
);
2172 if (DevicePathNode
== NULL
) {
2173 return EFI_OUT_OF_RESOURCES
;
2176 DevicePathNode
->Atapi
.PrimarySecondary
= Port
;
2177 DevicePathNode
->Atapi
.SlaveMaster
= PortMultiplier
;
2178 DevicePathNode
->Atapi
.Lun
= (UINT16
) Lun
;
2180 DevicePathNode
= AllocateCopyPool (sizeof (SATA_DEVICE_PATH
), &mSataDevicePathTemplate
);
2181 if (DevicePathNode
== NULL
) {
2182 return EFI_OUT_OF_RESOURCES
;
2185 DevicePathNode
->Sata
.HBAPortNumber
= Port
;
2186 DevicePathNode
->Sata
.PortMultiplierPortNumber
= PortMultiplier
;
2187 DevicePathNode
->Sata
.Lun
= (UINT16
) Lun
;
2190 *DevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) DevicePathNode
;
2196 Used to translate a device path node to a Target ID and LUN.
2198 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
2199 @param DevicePath A pointer to a single device path node that describes the SCSI device
2200 on the SCSI channel.
2201 @param Target A pointer to the Target Array which represents the ID of a SCSI device
2202 on the SCSI channel.
2203 @param Lun A pointer to the LUN of a SCSI device on the SCSI channel.
2205 @retval EFI_SUCCESS DevicePath was successfully translated to a Target ID and
2206 LUN, and they were returned in Target and Lun.
2207 @retval EFI_INVALID_PARAMETER DevicePath or Target or Lun is NULL.
2208 @retval EFI_NOT_FOUND A valid translation from DevicePath to a Target ID and LUN
2210 @retval EFI_UNSUPPORTED This driver does not support the device path node type in
2216 ExtScsiPassThruGetTargetLun (
2217 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
2218 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
2223 EFI_DEV_PATH
*DevicePathNode
;
2224 ATA_ATAPI_PASS_THRU_INSTANCE
*Instance
;
2227 Instance
= EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS (This
);
2230 // Validate parameters passed in.
2232 if (DevicePath
== NULL
|| Target
== NULL
|| Lun
== NULL
) {
2233 return EFI_INVALID_PARAMETER
;
2236 if (*Target
== NULL
) {
2237 return EFI_INVALID_PARAMETER
;
2240 // Check whether the DevicePath belongs to SCSI_DEVICE_PATH
2242 if ((DevicePath
->Type
!= MESSAGING_DEVICE_PATH
) ||
2243 ((DevicePath
->SubType
!= MSG_ATAPI_DP
) &&
2244 (DevicePath
->SubType
!= MSG_SATA_DP
)) ||
2245 ((DevicePathNodeLength(DevicePath
) != sizeof(ATAPI_DEVICE_PATH
)) &&
2246 (DevicePathNodeLength(DevicePath
) != sizeof(SATA_DEVICE_PATH
)))) {
2247 return EFI_UNSUPPORTED
;
2250 SetMem (*Target
, TARGET_MAX_BYTES
, 0xFF);
2252 DevicePathNode
= (EFI_DEV_PATH
*) DevicePath
;
2254 if (Instance
->Mode
== EfiAtaIdeMode
) {
2255 (*Target
)[0] = (UINT8
) DevicePathNode
->Atapi
.PrimarySecondary
;
2256 (*Target
)[1] = (UINT8
) DevicePathNode
->Atapi
.SlaveMaster
;
2257 *Lun
= (UINT8
) DevicePathNode
->Atapi
.Lun
;
2259 (*Target
)[0] = (UINT8
) DevicePathNode
->Sata
.HBAPortNumber
;
2260 (*Target
)[1] = (UINT8
) DevicePathNode
->Sata
.PortMultiplierPortNumber
;
2261 *Lun
= (UINT8
) DevicePathNode
->Sata
.Lun
;
2264 Node
= SearchDeviceInfoList(Instance
, (*Target
)[0], (*Target
)[1], EfiIdeCdrom
);
2267 return EFI_NOT_FOUND
;
2271 return EFI_NOT_FOUND
;
2278 Resets a SCSI channel. This operation resets all the SCSI devices connected to the SCSI channel.
2280 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
2282 @retval EFI_SUCCESS The SCSI channel was reset.
2283 @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the SCSI channel.
2284 @retval EFI_TIMEOUT A timeout occurred while attempting to reset the SCSI channel.
2285 @retval EFI_UNSUPPORTED The SCSI channel does not support a channel reset operation.
2290 ExtScsiPassThruResetChannel (
2291 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
2295 // Return success directly then upper layer driver could think reset channel operation is done.
2301 Resets a SCSI logical unit that is connected to a SCSI channel.
2303 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
2304 @param Target The Target is an array of size TARGET_MAX_BYTE and it represents the
2305 target port ID of the SCSI device containing the SCSI logical unit to
2306 reset. Transport drivers may chose to utilize a subset of this array to suit
2307 the representation of their targets.
2308 @param Lun The LUN of the SCSI device to reset.
2310 @retval EFI_SUCCESS The SCSI device specified by Target and Lun was reset.
2311 @retval EFI_INVALID_PARAMETER Target or Lun is NULL.
2312 @retval EFI_TIMEOUT A timeout occurred while attempting to reset the SCSI device
2313 specified by Target and Lun.
2314 @retval EFI_UNSUPPORTED The SCSI channel does not support a target reset operation.
2315 @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the SCSI device
2316 specified by Target and Lun.
2321 ExtScsiPassThruResetTargetLun (
2322 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
2327 ATA_ATAPI_PASS_THRU_INSTANCE
*Instance
;
2330 UINT8 PortMultiplier
;
2332 Instance
= EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS (This
);
2334 // For ATAPI device, doesn't support multiple LUN device.
2337 return EFI_INVALID_PARAMETER
;
2340 // The layout of Target array:
2341 // ________________________________________________________________________
2342 // | Byte 0 | Byte 1 | ... | TARGET_MAX_BYTES - 1 |
2343 // |_____________________|_____________________|_____|______________________|
2344 // | | The port multiplier | | |
2345 // | The port number | port number | N/A | N/A |
2346 // |_____________________|_____________________|_____|______________________|
2348 // For ATAPI device, 2 bytes is enough to represent the location of SCSI device.
2351 PortMultiplier
= Target
[1];
2353 Node
= SearchDeviceInfoList(Instance
, Port
, PortMultiplier
, EfiIdeCdrom
);
2355 return EFI_INVALID_PARAMETER
;
2359 // Return success directly then upper layer driver could think reset target LUN operation is done.
2365 Used to retrieve the list of legal Target IDs for SCSI devices on a SCSI channel. These can either
2366 be the list SCSI devices that are actually present on the SCSI channel, or the list of legal Target IDs
2367 for the SCSI channel. Regardless, the caller of this function must probe the Target ID returned to
2368 see if a SCSI device is actually present at that location on the SCSI channel.
2370 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
2371 @param Target (TARGET_MAX_BYTES) of a SCSI device present on the SCSI channel.
2372 On output, a pointer to the Target ID (an array of
2373 TARGET_MAX_BYTES) of the next SCSI device present on a SCSI
2374 channel. An input value of 0xF(all bytes in the array are 0xF) in the
2375 Target array retrieves the Target ID of the first SCSI device present on a
2378 @retval EFI_SUCCESS The Target ID of the next SCSI device on the SCSI
2379 channel was returned in Target.
2380 @retval EFI_INVALID_PARAMETER Target or Lun is NULL.
2381 @retval EFI_TIMEOUT Target array is not all 0xF, and Target was not
2382 returned on a previous call to GetNextTarget().
2383 @retval EFI_NOT_FOUND There are no more SCSI devices on this SCSI channel.
2388 ExtScsiPassThruGetNextTarget (
2389 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
2390 IN OUT UINT8
**Target
2393 ATA_ATAPI_PASS_THRU_INSTANCE
*Instance
;
2395 EFI_ATA_DEVICE_INFO
*DeviceInfo
;
2399 Instance
= EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS (This
);
2401 if (Target
== NULL
|| *Target
== NULL
) {
2402 return EFI_INVALID_PARAMETER
;
2406 Target16
= (UINT16
*)*Target
;
2408 if (CompareMem(Target8
, mScsiId
, TARGET_MAX_BYTES
) != 0) {
2410 // For ATAPI device, we use 2 least significant bytes to represent the location of SCSI device.
2411 // So the higher bytes in Target array should be 0xFF.
2413 if (CompareMem (&Target8
[2], &mScsiId
[2], TARGET_MAX_BYTES
- 2) != 0) {
2414 return EFI_INVALID_PARAMETER
;
2418 // When Target is not all 0xFF's, compare 2 least significant bytes with
2419 // previous target id to see if it is returned by previous call.
2421 if (*Target16
!= Instance
->PreviousTargetId
) {
2422 return EFI_INVALID_PARAMETER
;
2426 // Traverse the whole device list to find the next cdrom closed to
2427 // the device signified by Target[0] and Target[1].
2429 // Note that we here use a tricky way to find the next cdrom :
2430 // All ata devices are detected and inserted into the device list
2433 Node
= GetFirstNode (&Instance
->DeviceList
);
2434 while (!IsNull (&Instance
->DeviceList
, Node
)) {
2435 DeviceInfo
= ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node
);
2437 if ((DeviceInfo
->Type
== EfiIdeCdrom
) &&
2438 ((Target8
[0] < DeviceInfo
->Port
) ||
2439 ((Target8
[0] == DeviceInfo
->Port
) &&
2440 (Target8
[1] < DeviceInfo
->PortMultiplier
)))) {
2441 Target8
[0] = (UINT8
)DeviceInfo
->Port
;
2442 Target8
[1] = (UINT8
)DeviceInfo
->PortMultiplier
;
2446 Node
= GetNextNode (&Instance
->DeviceList
, Node
);
2449 return EFI_NOT_FOUND
;
2452 // If the array is all 0xFF's, start to traverse the device list from the beginning
2454 Node
= GetFirstNode (&Instance
->DeviceList
);
2456 while (!IsNull (&Instance
->DeviceList
, Node
)) {
2457 DeviceInfo
= ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node
);
2459 if (DeviceInfo
->Type
== EfiIdeCdrom
) {
2460 Target8
[0] = (UINT8
)DeviceInfo
->Port
;
2461 Target8
[1] = (UINT8
)DeviceInfo
->PortMultiplier
;
2465 Node
= GetNextNode (&Instance
->DeviceList
, Node
);
2468 return EFI_NOT_FOUND
;
2473 // Update the PreviousTargetId.
2475 Instance
->PreviousTargetId
= *Target16
;