]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Bus/Ata/AtaAtapiPassThru/AtaAtapiPassThru.c
MdeModulePkg/AtaBus&AtaAtapiPassThru: Update ATA drivers to follow UEFI2.4 new reques...
[mirror_edk2.git] / MdeModulePkg / Bus / Ata / AtaAtapiPassThru / AtaAtapiPassThru.c
1 /** @file
2 This file implements ATA_PASSTHRU_PROCTOCOL and EXT_SCSI_PASSTHRU_PROTOCOL interfaces
3 for managed ATA controllers.
4
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
10
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.
13
14 **/
15
16 #include "AtaAtapiPassThru.h"
17
18 //
19 // EFI_DRIVER_BINDING_PROTOCOL instance
20 //
21 EFI_DRIVER_BINDING_PROTOCOL gAtaAtapiPassThruDriverBinding = {
22 AtaAtapiPassThruSupported,
23 AtaAtapiPassThruStart,
24 AtaAtapiPassThruStop,
25 0x10,
26 NULL,
27 NULL
28 };
29
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
35 { // AtaPassThruMode
36 //
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
39 // bits.
40 // Note that the driver doesn't support AtaPassThru non blocking I/O.
41 //
42 EFI_ATA_PASS_THRU_ATTRIBUTES_PHYSICAL | EFI_ATA_PASS_THRU_ATTRIBUTES_LOGICAL | EFI_ATA_PASS_THRU_ATTRIBUTES_NONBLOCKIO,
43 //
44 // IoAlign
45 //
46 sizeof (UINTN)
47 },
48 { // AtaPassThru
49 NULL,
50 AtaPassThruPassThru,
51 AtaPassThruGetNextPort,
52 AtaPassThruGetNextDevice,
53 AtaPassThruBuildDevicePath,
54 AtaPassThruGetDevice,
55 AtaPassThruResetPort,
56 AtaPassThruResetDevice
57 },
58 { // ExtScsiPassThruMode
59 //
60 // AdapterId
61 //
62 0,
63 //
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
66 // bits.
67 // Note that the driver doesn't support ExtScsiPassThru non blocking I/O.
68 //
69 EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL | EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL,
70 //
71 // IoAlign
72 //
73 sizeof (UINTN)
74 },
75 { // ExtScsiPassThru
76 NULL,
77 ExtScsiPassThruPassThru,
78 ExtScsiPassThruGetNextTargetLun,
79 ExtScsiPassThruBuildDevicePath,
80 ExtScsiPassThruGetTargetLun,
81 ExtScsiPassThruResetChannel,
82 ExtScsiPassThruResetTargetLun,
83 ExtScsiPassThruGetNextTarget
84 },
85 EfiAtaUnknownMode, // Work Mode
86 { // IdeRegisters
87 {0},
88 {0}
89 },
90 { // AhciRegisters
91 0
92 },
93 { // DeviceList
94 NULL,
95 NULL
96 },
97 0, // OriginalAttributes
98 0, // PreviousPort
99 0, // PreviousPortMultiplier
100 0, // PreviousTargetId
101 0, // PreviousLun
102 NULL, // Timer event
103 { // NonBlocking TaskList
104 NULL,
105 NULL
106 }
107 };
108
109 ATAPI_DEVICE_PATH mAtapiDevicePathTemplate = {
110 {
111 MESSAGING_DEVICE_PATH,
112 MSG_ATAPI_DP,
113 {
114 (UINT8) (sizeof (ATAPI_DEVICE_PATH)),
115 (UINT8) ((sizeof (ATAPI_DEVICE_PATH)) >> 8)
116 }
117 },
118 0,
119 0,
120 0
121 };
122
123 SATA_DEVICE_PATH mSataDevicePathTemplate = {
124 {
125 MESSAGING_DEVICE_PATH,
126 MSG_SATA_DP,
127 {
128 (UINT8) (sizeof (SATA_DEVICE_PATH)),
129 (UINT8) ((sizeof (SATA_DEVICE_PATH)) >> 8)
130 }
131 },
132 0,
133 0,
134 0
135 };
136
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
142 };
143
144 /**
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.
148
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.
157
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
167 by OutDataBuffer.
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
176 is available.
177
178 **/
179 EFI_STATUS
180 EFIAPI
181 AtaPassThruPassThruExecute (
182 IN UINT16 Port,
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
187 )
188 {
189 EFI_ATA_PASS_THRU_CMD_PROTOCOL Protocol;
190 EFI_ATA_HC_WORK_MODE Mode;
191 EFI_STATUS Status;
192
193 Protocol = Packet->Protocol;
194
195 Mode = Instance->Mode;
196 switch (Mode) {
197 case EfiAtaIdeMode:
198 //
199 // Reassign IDE mode io port registers' base addresses
200 //
201 Status = GetIdeRegisterIoAddr (Instance->PciIo, Instance->IdeRegisters);
202
203 if (EFI_ERROR (Status)) {
204 return Status;
205 }
206
207 switch (Protocol) {
208 case EFI_ATA_PASS_THRU_PROTOCOL_ATA_NON_DATA:
209 Status = AtaNonDataCommandIn (
210 Instance->PciIo,
211 &Instance->IdeRegisters[Port],
212 Packet->Acb,
213 Packet->Asb,
214 Packet->Timeout,
215 Task
216 );
217 break;
218 case EFI_ATA_PASS_THRU_PROTOCOL_PIO_DATA_IN:
219 Status = AtaPioDataInOut (
220 Instance->PciIo,
221 &Instance->IdeRegisters[Port],
222 Packet->InDataBuffer,
223 Packet->InTransferLength,
224 TRUE,
225 Packet->Acb,
226 Packet->Asb,
227 Packet->Timeout,
228 Task
229 );
230 break;
231 case EFI_ATA_PASS_THRU_PROTOCOL_PIO_DATA_OUT:
232 Status = AtaPioDataInOut (
233 Instance->PciIo,
234 &Instance->IdeRegisters[Port],
235 Packet->OutDataBuffer,
236 Packet->OutTransferLength,
237 FALSE,
238 Packet->Acb,
239 Packet->Asb,
240 Packet->Timeout,
241 Task
242 );
243 break;
244 case EFI_ATA_PASS_THRU_PROTOCOL_UDMA_DATA_IN:
245 Status = AtaUdmaInOut (
246 Instance,
247 &Instance->IdeRegisters[Port],
248 TRUE,
249 Packet->InDataBuffer,
250 Packet->InTransferLength,
251 Packet->Acb,
252 Packet->Asb,
253 Packet->Timeout,
254 Task
255 );
256 break;
257 case EFI_ATA_PASS_THRU_PROTOCOL_UDMA_DATA_OUT:
258 Status = AtaUdmaInOut (
259 Instance,
260 &Instance->IdeRegisters[Port],
261 FALSE,
262 Packet->OutDataBuffer,
263 Packet->OutTransferLength,
264 Packet->Acb,
265 Packet->Asb,
266 Packet->Timeout,
267 Task
268 );
269 break;
270 default :
271 return EFI_UNSUPPORTED;
272 }
273 break;
274 case EfiAtaAhciMode :
275 switch (Protocol) {
276 case EFI_ATA_PASS_THRU_PROTOCOL_ATA_NON_DATA:
277 Status = AhciNonDataTransfer (
278 Instance->PciIo,
279 &Instance->AhciRegisters,
280 (UINT8)Port,
281 (UINT8)PortMultiplierPort,
282 NULL,
283 0,
284 Packet->Acb,
285 Packet->Asb,
286 Packet->Timeout,
287 Task
288 );
289 break;
290 case EFI_ATA_PASS_THRU_PROTOCOL_PIO_DATA_IN:
291 Status = AhciPioTransfer (
292 Instance->PciIo,
293 &Instance->AhciRegisters,
294 (UINT8)Port,
295 (UINT8)PortMultiplierPort,
296 NULL,
297 0,
298 TRUE,
299 Packet->Acb,
300 Packet->Asb,
301 Packet->InDataBuffer,
302 Packet->InTransferLength,
303 Packet->Timeout,
304 Task
305 );
306 break;
307 case EFI_ATA_PASS_THRU_PROTOCOL_PIO_DATA_OUT:
308 Status = AhciPioTransfer (
309 Instance->PciIo,
310 &Instance->AhciRegisters,
311 (UINT8)Port,
312 (UINT8)PortMultiplierPort,
313 NULL,
314 0,
315 FALSE,
316 Packet->Acb,
317 Packet->Asb,
318 Packet->OutDataBuffer,
319 Packet->OutTransferLength,
320 Packet->Timeout,
321 Task
322 );
323 break;
324 case EFI_ATA_PASS_THRU_PROTOCOL_UDMA_DATA_IN:
325 Status = AhciDmaTransfer (
326 Instance,
327 &Instance->AhciRegisters,
328 (UINT8)Port,
329 (UINT8)PortMultiplierPort,
330 NULL,
331 0,
332 TRUE,
333 Packet->Acb,
334 Packet->Asb,
335 Packet->InDataBuffer,
336 Packet->InTransferLength,
337 Packet->Timeout,
338 Task
339 );
340 break;
341 case EFI_ATA_PASS_THRU_PROTOCOL_UDMA_DATA_OUT:
342 Status = AhciDmaTransfer (
343 Instance,
344 &Instance->AhciRegisters,
345 (UINT8)Port,
346 (UINT8)PortMultiplierPort,
347 NULL,
348 0,
349 FALSE,
350 Packet->Acb,
351 Packet->Asb,
352 Packet->OutDataBuffer,
353 Packet->OutTransferLength,
354 Packet->Timeout,
355 Task
356 );
357 break;
358 default :
359 return EFI_UNSUPPORTED;
360 }
361 break;
362
363 default:
364 Status = EFI_DEVICE_ERROR;
365 break;
366 }
367
368 return Status;
369 }
370
371 /**
372 Call back function when the timer event is signaled.
373
374 @param[in] Event The Event this notify function registered to.
375 @param[in] Context Pointer to the context data registered to the
376 Event.
377
378 **/
379 VOID
380 EFIAPI
381 AsyncNonBlockingTransferRoutine (
382 EFI_EVENT Event,
383 VOID* Context
384 )
385 {
386 LIST_ENTRY *Entry;
387 LIST_ENTRY *EntryHeader;
388 ATA_NONBLOCK_TASK *Task;
389 EFI_STATUS Status;
390 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
391
392 Instance = (ATA_ATAPI_PASS_THRU_INSTANCE *) Context;
393 EntryHeader = &Instance->NonBlockingTaskList;
394 //
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).
397 //
398 while (TRUE) {
399 if (!IsListEmpty (EntryHeader)) {
400 Entry = GetFirstNode (EntryHeader);
401 Task = ATA_NON_BLOCK_TASK_FROM_ENTRY (Entry);
402 } else {
403 return;
404 }
405
406 Status = AtaPassThruPassThruExecute (
407 Task->Port,
408 Task->PortMultiplier,
409 Task->Packet,
410 Instance,
411 Task
412 );
413
414 //
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.
417 //
418 if ((Status != EFI_NOT_READY) && (Status != EFI_SUCCESS)) {
419 DestroyAsynTaskList (Instance, TRUE);
420 break;
421 }
422
423 //
424 // For Non blocking mode, the Status of EFI_NOT_READY means the operation
425 // is not finished yet. Otherwise the operation is successful.
426 //
427 if (Status == EFI_NOT_READY) {
428 break;
429 } else {
430 RemoveEntryList (&Task->Link);
431 gBS->SignalEvent (Task->Event);
432 FreePool (Task);
433 }
434 }
435 }
436
437 /**
438 The Entry Point of module.
439
440 @param[in] ImageHandle The firmware allocated handle for the EFI image.
441 @param[in] SystemTable A pointer to the EFI System Table.
442
443 @retval EFI_SUCCESS The entry point is executed successfully.
444 @retval other Some error occurs when executing this entry point.
445
446 **/
447 EFI_STATUS
448 EFIAPI
449 InitializeAtaAtapiPassThru (
450 IN EFI_HANDLE ImageHandle,
451 IN EFI_SYSTEM_TABLE *SystemTable
452 )
453 {
454 EFI_STATUS Status;
455
456 //
457 // Install driver model protocol(s).
458 //
459 Status = EfiLibInstallDriverBindingComponentName2 (
460 ImageHandle,
461 SystemTable,
462 &gAtaAtapiPassThruDriverBinding,
463 ImageHandle,
464 &gAtaAtapiPassThruComponentName,
465 &gAtaAtapiPassThruComponentName2
466 );
467 ASSERT_EFI_ERROR (Status);
468
469 return Status;
470 }
471
472 /**
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.
475
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.
489
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
500 bus driver.
501
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
506 specified by This.
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.
513 **/
514 EFI_STATUS
515 EFIAPI
516 AtaAtapiPassThruSupported (
517 IN EFI_DRIVER_BINDING_PROTOCOL *This,
518 IN EFI_HANDLE Controller,
519 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
520 )
521 {
522 EFI_STATUS Status;
523 EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath;
524 EFI_PCI_IO_PROTOCOL *PciIo;
525 PCI_TYPE00 PciData;
526 EFI_IDE_CONTROLLER_INIT_PROTOCOL *IdeControllerInit;
527
528 //
529 // SATA Controller is a device driver, and should ingore the
530 // "RemainingDevicePath" according to UEFI spec
531 //
532 Status = gBS->OpenProtocol (
533 Controller,
534 &gEfiDevicePathProtocolGuid,
535 (VOID *) &ParentDevicePath,
536 This->DriverBindingHandle,
537 Controller,
538 EFI_OPEN_PROTOCOL_BY_DRIVER
539 );
540 if (EFI_ERROR (Status)) {
541 //
542 // EFI_ALREADY_STARTED is also an error
543 //
544 return Status;
545 }
546 //
547 // Close the protocol because we don't use it here
548 //
549 gBS->CloseProtocol (
550 Controller,
551 &gEfiDevicePathProtocolGuid,
552 This->DriverBindingHandle,
553 Controller
554 );
555
556 Status = gBS->OpenProtocol (
557 Controller,
558 &gEfiIdeControllerInitProtocolGuid,
559 (VOID **) &IdeControllerInit,
560 This->DriverBindingHandle,
561 Controller,
562 EFI_OPEN_PROTOCOL_BY_DRIVER
563 );
564
565 if (EFI_ERROR (Status)) {
566 //
567 // EFI_ALREADY_STARTED is also an error
568 //
569 return Status;
570 }
571
572 //
573 // Close the I/O Abstraction(s) used to perform the supported test
574 //
575 gBS->CloseProtocol (
576 Controller,
577 &gEfiIdeControllerInitProtocolGuid,
578 This->DriverBindingHandle,
579 Controller
580 );
581
582 //
583 // Now test the EfiPciIoProtocol
584 //
585 Status = gBS->OpenProtocol (
586 Controller,
587 &gEfiPciIoProtocolGuid,
588 (VOID **) &PciIo,
589 This->DriverBindingHandle,
590 Controller,
591 EFI_OPEN_PROTOCOL_GET_PROTOCOL
592 );
593 if (EFI_ERROR (Status)) {
594 return Status;
595 }
596 //
597 // Now further check the PCI header: Base class (offset 0x0B) and
598 // Sub Class (offset 0x0A). This controller should be an ATA controller
599 //
600 Status = PciIo->Pci.Read (
601 PciIo,
602 EfiPciIoWidthUint8,
603 PCI_CLASSCODE_OFFSET,
604 sizeof (PciData.Hdr.ClassCode),
605 PciData.Hdr.ClassCode
606 );
607 if (EFI_ERROR (Status)) {
608 return EFI_UNSUPPORTED;
609 }
610
611 if (IS_PCI_IDE (&PciData) || IS_PCI_SATADPA (&PciData)) {
612 return EFI_SUCCESS;
613 }
614
615 return EFI_UNSUPPORTED;
616 }
617
618 /**
619 Starts a device controller or a bus controller.
620
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.
630
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
645 driver.
646
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.
651
652 **/
653 EFI_STATUS
654 EFIAPI
655 AtaAtapiPassThruStart (
656 IN EFI_DRIVER_BINDING_PROTOCOL *This,
657 IN EFI_HANDLE Controller,
658 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
659 )
660 {
661 EFI_STATUS Status;
662 EFI_IDE_CONTROLLER_INIT_PROTOCOL *IdeControllerInit;
663 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
664 EFI_PCI_IO_PROTOCOL *PciIo;
665 UINT64 Supports;
666 UINT64 OriginalPciAttributes;
667
668 Status = EFI_SUCCESS;
669 IdeControllerInit = NULL;
670 Instance = NULL;
671 OriginalPciAttributes = 0;
672
673 DEBUG ((EFI_D_INFO, "==AtaAtapiPassThru Start== Controller = %x\n", Controller));
674
675 Status = gBS->OpenProtocol (
676 Controller,
677 &gEfiIdeControllerInitProtocolGuid,
678 (VOID **) &IdeControllerInit,
679 This->DriverBindingHandle,
680 Controller,
681 EFI_OPEN_PROTOCOL_BY_DRIVER
682 );
683
684 if (EFI_ERROR (Status)) {
685 DEBUG ((EFI_D_ERROR, "Open Ide_Controller_Init Error, Status=%r", Status));
686 goto ErrorExit;
687 }
688
689 Status = gBS->OpenProtocol (
690 Controller,
691 &gEfiPciIoProtocolGuid,
692 (VOID **) &PciIo,
693 This->DriverBindingHandle,
694 Controller,
695 EFI_OPEN_PROTOCOL_GET_PROTOCOL
696 );
697 if (EFI_ERROR (Status)) {
698 DEBUG ((EFI_D_ERROR, "Get Pci_Io Protocol Error, Status=%r", Status));
699 goto ErrorExit;
700 }
701
702 Status = PciIo->Attributes (
703 PciIo,
704 EfiPciIoAttributeOperationGet,
705 0,
706 &OriginalPciAttributes
707 );
708
709 if (EFI_ERROR (Status)) {
710 goto ErrorExit;
711 }
712
713 Status = PciIo->Attributes (
714 PciIo,
715 EfiPciIoAttributeOperationSupported,
716 0,
717 &Supports
718 );
719 if (!EFI_ERROR (Status)) {
720 Supports &= EFI_PCI_DEVICE_ENABLE;
721 Status = PciIo->Attributes (
722 PciIo,
723 EfiPciIoAttributeOperationEnable,
724 Supports,
725 NULL
726 );
727 }
728
729 if (EFI_ERROR (Status)) {
730 goto ErrorExit;
731 }
732
733 //
734 // Allocate a buffer to store the ATA_ATAPI_PASS_THRU_INSTANCE data structure
735 //
736 Instance = AllocateCopyPool (sizeof (ATA_ATAPI_PASS_THRU_INSTANCE), &gAtaAtapiPassThruInstanceTemplate);
737 if (Instance == NULL) {
738 goto ErrorExit;
739 }
740
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);
749
750 Instance->TimerEvent = NULL;
751
752 Status = gBS->CreateEvent (
753 EVT_TIMER | EVT_NOTIFY_SIGNAL,
754 TPL_NOTIFY,
755 AsyncNonBlockingTransferRoutine,
756 Instance,
757 &Instance->TimerEvent
758 );
759 if (EFI_ERROR (Status)) {
760 goto ErrorExit;
761 }
762
763 //
764 // Set 1ms timer.
765 //
766 Status = gBS->SetTimer (Instance->TimerEvent, TimerPeriodic, 10000);
767 if (EFI_ERROR (Status)) {
768 goto ErrorExit;
769 }
770
771 //
772 // Enumerate all inserted ATA devices.
773 //
774 Status = EnumerateAttachedDevice (Instance);
775 if (EFI_ERROR (Status)) {
776 goto ErrorExit;
777 }
778
779 Status = gBS->InstallMultipleProtocolInterfaces (
780 &Controller,
781 &gEfiAtaPassThruProtocolGuid, &(Instance->AtaPassThru),
782 &gEfiExtScsiPassThruProtocolGuid, &(Instance->ExtScsiPassThru),
783 NULL
784 );
785 ASSERT_EFI_ERROR (Status);
786
787 return Status;
788
789 ErrorExit:
790 if (IdeControllerInit != NULL) {
791 gBS->CloseProtocol (
792 Controller,
793 &gEfiIdeControllerInitProtocolGuid,
794 This->DriverBindingHandle,
795 Controller
796 );
797 }
798
799 if ((Instance != NULL) && (Instance->TimerEvent != NULL)) {
800 gBS->CloseEvent (Instance->TimerEvent);
801 }
802
803 //
804 // Remove all inserted ATA devices.
805 //
806 DestroyDeviceInfoList(Instance);
807
808 if (Instance != NULL) {
809 FreePool (Instance);
810 }
811 return EFI_UNSUPPORTED;
812 }
813
814 /**
815 Stops a device controller or a bus controller.
816
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.
827
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.
835
836 @retval EFI_SUCCESS The device was stopped.
837 @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.
838
839 **/
840 EFI_STATUS
841 EFIAPI
842 AtaAtapiPassThruStop (
843 IN EFI_DRIVER_BINDING_PROTOCOL *This,
844 IN EFI_HANDLE Controller,
845 IN UINTN NumberOfChildren,
846 IN EFI_HANDLE *ChildHandleBuffer
847 )
848 {
849 EFI_STATUS Status;
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;
854 UINT64 Supports;
855
856 DEBUG ((EFI_D_INFO, "==AtaAtapiPassThru Stop== Controller = %x\n", Controller));
857
858 Status = gBS->OpenProtocol (
859 Controller,
860 &gEfiAtaPassThruProtocolGuid,
861 (VOID **) &AtaPassThru,
862 This->DriverBindingHandle,
863 Controller,
864 EFI_OPEN_PROTOCOL_GET_PROTOCOL
865 );
866
867 if (EFI_ERROR (Status)) {
868 return EFI_DEVICE_ERROR;
869 }
870
871 Instance = ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS (AtaPassThru);
872
873 //
874 // Close Non-Blocking timer and free Task list.
875 //
876 if (Instance->TimerEvent != NULL) {
877 gBS->CloseEvent (Instance->TimerEvent);
878 Instance->TimerEvent = NULL;
879 }
880 DestroyAsynTaskList (Instance, FALSE);
881
882 //
883 // Disable this ATA host controller.
884 //
885 PciIo = Instance->PciIo;
886 Status = PciIo->Attributes (
887 PciIo,
888 EfiPciIoAttributeOperationSupported,
889 0,
890 &Supports
891 );
892 if (!EFI_ERROR (Status)) {
893 Supports &= EFI_PCI_DEVICE_ENABLE;
894 PciIo->Attributes (
895 PciIo,
896 EfiPciIoAttributeOperationDisable,
897 Supports,
898 NULL
899 );
900 }
901
902 //
903 // Restore original PCI attributes
904 //
905 Status = PciIo->Attributes (
906 PciIo,
907 EfiPciIoAttributeOperationSet,
908 Instance->OriginalPciAttributes,
909 NULL
910 );
911 ASSERT_EFI_ERROR (Status);
912
913 gBS->UninstallMultipleProtocolInterfaces (
914 Controller,
915 &gEfiAtaPassThruProtocolGuid, &(Instance->AtaPassThru),
916 &gEfiExtScsiPassThruProtocolGuid, &(Instance->ExtScsiPassThru),
917 NULL
918 );
919
920 //
921 // Close protocols opened by AtaAtapiPassThru controller driver
922 //
923 gBS->CloseProtocol (
924 Controller,
925 &gEfiIdeControllerInitProtocolGuid,
926 This->DriverBindingHandle,
927 Controller
928 );
929
930 //
931 // Free allocated resource
932 //
933 DestroyDeviceInfoList(Instance);
934
935 //
936 // If the current working mode is AHCI mode, then pre-allocated resource
937 // for AHCI initialization should be released.
938 //
939 if (Instance->Mode == EfiAtaAhciMode) {
940 AhciRegisters = &Instance->AhciRegisters;
941 PciIo->Unmap (
942 PciIo,
943 AhciRegisters->MapCommandTable
944 );
945 PciIo->FreeBuffer (
946 PciIo,
947 EFI_SIZE_TO_PAGES ((UINTN) AhciRegisters->MaxCommandTableSize),
948 AhciRegisters->AhciCommandTable
949 );
950 PciIo->Unmap (
951 PciIo,
952 AhciRegisters->MapCmdList
953 );
954 PciIo->FreeBuffer (
955 PciIo,
956 EFI_SIZE_TO_PAGES ((UINTN) AhciRegisters->MaxCommandListSize),
957 AhciRegisters->AhciCmdList
958 );
959 PciIo->Unmap (
960 PciIo,
961 AhciRegisters->MapRFis
962 );
963 PciIo->FreeBuffer (
964 PciIo,
965 EFI_SIZE_TO_PAGES ((UINTN) AhciRegisters->MaxReceiveFisSize),
966 AhciRegisters->AhciRFis
967 );
968 }
969 FreePool (Instance);
970
971 return Status;
972 }
973
974 /**
975 Traverse the attached ATA devices list to find out the device to access.
976
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.
982
983 @retval The pointer to the data structure of the device info to access.
984
985 **/
986 LIST_ENTRY *
987 EFIAPI
988 SearchDeviceInfoList (
989 IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance,
990 IN UINT16 Port,
991 IN UINT16 PortMultiplier,
992 IN EFI_ATA_DEVICE_TYPE DeviceType
993 )
994 {
995 EFI_ATA_DEVICE_INFO *DeviceInfo;
996 LIST_ENTRY *Node;
997
998 Node = GetFirstNode (&Instance->DeviceList);
999 while (!IsNull (&Instance->DeviceList, Node)) {
1000 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
1001
1002 if ((DeviceInfo->Type == DeviceType) &&
1003 (Port == DeviceInfo->Port) &&
1004 (PortMultiplier == DeviceInfo->PortMultiplier)) {
1005 return Node;
1006 }
1007
1008 Node = GetNextNode (&Instance->DeviceList, Node);
1009 }
1010
1011 return NULL;
1012 }
1013
1014 /**
1015 Allocate device info data structure to contain device info.
1016 And insert the data structure to the tail of device list for tracing.
1017
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.
1024
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.
1027
1028 **/
1029 EFI_STATUS
1030 EFIAPI
1031 CreateNewDeviceInfo (
1032 IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance,
1033 IN UINT16 Port,
1034 IN UINT16 PortMultiplier,
1035 IN EFI_ATA_DEVICE_TYPE DeviceType,
1036 IN EFI_IDENTIFY_DATA *IdentifyData
1037 )
1038 {
1039 EFI_ATA_DEVICE_INFO *DeviceInfo;
1040
1041 DeviceInfo = AllocateZeroPool (sizeof (EFI_ATA_DEVICE_INFO));
1042
1043 if (DeviceInfo == NULL) {
1044 return EFI_OUT_OF_RESOURCES;
1045 }
1046
1047 DeviceInfo->Signature = ATA_ATAPI_DEVICE_SIGNATURE;
1048 DeviceInfo->Port = Port;
1049 DeviceInfo->PortMultiplier = PortMultiplier;
1050 DeviceInfo->Type = DeviceType;
1051
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;
1057 }
1058 }
1059
1060 InsertTailList (&Instance->DeviceList, &DeviceInfo->Link);
1061
1062 return EFI_SUCCESS;
1063 }
1064
1065 /**
1066 Destroy all attached ATA devices info.
1067
1068 @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance.
1069
1070 **/
1071 VOID
1072 EFIAPI
1073 DestroyDeviceInfoList (
1074 IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance
1075 )
1076 {
1077 EFI_ATA_DEVICE_INFO *DeviceInfo;
1078 LIST_ENTRY *Node;
1079
1080 Node = GetFirstNode (&Instance->DeviceList);
1081 while (!IsNull (&Instance->DeviceList, Node)) {
1082 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
1083
1084 Node = GetNextNode (&Instance->DeviceList, Node);
1085
1086 RemoveEntryList (&DeviceInfo->Link);
1087 if (DeviceInfo->IdentifyData != NULL) {
1088 FreePool (DeviceInfo->IdentifyData);
1089 }
1090 FreePool (DeviceInfo);
1091 }
1092 }
1093
1094 /**
1095 Destroy all pending non blocking tasks.
1096
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
1099 task.
1100
1101 **/
1102 VOID
1103 EFIAPI
1104 DestroyAsynTaskList (
1105 IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance,
1106 IN BOOLEAN IsSigEvent
1107 )
1108 {
1109 LIST_ENTRY *Entry;
1110 LIST_ENTRY *DelEntry;
1111 ATA_NONBLOCK_TASK *Task;
1112 EFI_TPL OldTpl;
1113
1114 OldTpl = gBS->RaiseTPL (TPL_NOTIFY);
1115 if (!IsListEmpty (&Instance->NonBlockingTaskList)) {
1116 //
1117 // Free the Subtask list.
1118 //
1119 for (Entry = (&Instance->NonBlockingTaskList)->ForwardLink;
1120 Entry != (&Instance->NonBlockingTaskList);
1121 ) {
1122 DelEntry = Entry;
1123 Entry = Entry->ForwardLink;
1124 Task = ATA_NON_BLOCK_TASK_FROM_ENTRY (DelEntry);
1125
1126 RemoveEntryList (DelEntry);
1127 if (IsSigEvent) {
1128 Task->Packet->Asb->AtaStatus = 0x01;
1129 gBS->SignalEvent (Task->Event);
1130 }
1131 FreePool (Task);
1132 }
1133 }
1134 gBS->RestoreTPL (OldTpl);
1135 }
1136
1137 /**
1138 Enumerate all attached ATA devices at IDE mode or AHCI mode separately.
1139
1140 The function is designed to enumerate all attached ATA devices.
1141
1142 @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance.
1143
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.
1146
1147 **/
1148 EFI_STATUS
1149 EFIAPI
1150 EnumerateAttachedDevice (
1151 IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance
1152 )
1153 {
1154 EFI_STATUS Status;
1155 PCI_TYPE00 PciData;
1156 UINT8 ClassCode;
1157
1158 Status = EFI_SUCCESS;
1159
1160 Status = Instance->PciIo->Pci.Read (
1161 Instance->PciIo,
1162 EfiPciIoWidthUint8,
1163 PCI_CLASSCODE_OFFSET,
1164 sizeof (PciData.Hdr.ClassCode),
1165 PciData.Hdr.ClassCode
1166 );
1167 ASSERT_EFI_ERROR (Status);
1168
1169 ClassCode = PciData.Hdr.ClassCode[1];
1170
1171 switch (ClassCode) {
1172 case PCI_CLASS_MASS_STORAGE_IDE :
1173 //
1174 // The ATA controller is working at IDE mode
1175 //
1176 Instance->Mode = EfiAtaIdeMode;
1177
1178 Status = IdeModeInitialization (Instance);
1179 if (EFI_ERROR (Status)) {
1180 Status = EFI_DEVICE_ERROR;
1181 goto Done;
1182 }
1183 break;
1184 case PCI_CLASS_MASS_STORAGE_SATADPA :
1185 //
1186 // The ATA controller is working at AHCI mode
1187 //
1188 Instance->Mode = EfiAtaAhciMode;
1189
1190 Status = AhciModeInitialization (Instance);
1191
1192 if (EFI_ERROR (Status)) {
1193 Status = EFI_DEVICE_ERROR;
1194 goto Done;
1195 }
1196
1197 break;
1198 default :
1199 Status = EFI_UNSUPPORTED;
1200 }
1201
1202 Done:
1203 return Status;
1204 }
1205
1206 /**
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.
1210
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.
1221
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.
1233
1234 **/
1235 EFI_STATUS
1236 EFIAPI
1237 AtaPassThruPassThru (
1238 IN EFI_ATA_PASS_THRU_PROTOCOL *This,
1239 IN UINT16 Port,
1240 IN UINT16 PortMultiplierPort,
1241 IN OUT EFI_ATA_PASS_THRU_COMMAND_PACKET *Packet,
1242 IN EFI_EVENT Event OPTIONAL
1243 )
1244 {
1245 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
1246 LIST_ENTRY *Node;
1247 EFI_ATA_DEVICE_INFO *DeviceInfo;
1248 EFI_IDENTIFY_DATA *IdentifyData;
1249 UINT64 Capacity;
1250 UINT32 MaxSectorCount;
1251 ATA_NONBLOCK_TASK *Task;
1252 EFI_TPL OldTpl;
1253
1254 Instance = ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
1255
1256 if ((This->Mode->IoAlign > 1) && !IS_ALIGNED(Packet->InDataBuffer, This->Mode->IoAlign)) {
1257 return EFI_INVALID_PARAMETER;
1258 }
1259
1260 if ((This->Mode->IoAlign > 1) && !IS_ALIGNED(Packet->OutDataBuffer, This->Mode->IoAlign)) {
1261 return EFI_INVALID_PARAMETER;
1262 }
1263
1264 if ((This->Mode->IoAlign > 1) && !IS_ALIGNED(Packet->Asb, This->Mode->IoAlign)) {
1265 return EFI_INVALID_PARAMETER;
1266 }
1267
1268 Node = SearchDeviceInfoList (Instance, Port, PortMultiplierPort, EfiIdeHarddisk);
1269
1270 if (Node == NULL) {
1271 Node = SearchDeviceInfoList(Instance, Port, PortMultiplierPort, EfiIdeCdrom);
1272 if (Node == NULL) {
1273 return EFI_INVALID_PARAMETER;
1274 }
1275 }
1276
1277 //
1278 // convert the transfer length from sector count to byte.
1279 //
1280 if (((Packet->Length & EFI_ATA_PASS_THRU_LENGTH_BYTES) == 0) &&
1281 (Packet->InTransferLength != 0)) {
1282 Packet->InTransferLength = Packet->InTransferLength * 0x200;
1283 }
1284
1285 //
1286 // convert the transfer length from sector count to byte.
1287 //
1288 if (((Packet->Length & EFI_ATA_PASS_THRU_LENGTH_BYTES) == 0) &&
1289 (Packet->OutTransferLength != 0)) {
1290 Packet->OutTransferLength = Packet->OutTransferLength * 0x200;
1291 }
1292
1293 //
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.
1297 //
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) {
1304 //
1305 // Capacity exceeds 120GB. 48-bit addressing is really needed
1306 // In this case, the max sector count is 0x10000
1307 //
1308 MaxSectorCount = 0x10000;
1309 }
1310 }
1311
1312 //
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
1315 // is returned.
1316 //
1317 if (((Packet->InTransferLength != 0) && (Packet->InTransferLength > MaxSectorCount * 0x200)) ||
1318 ((Packet->OutTransferLength != 0) && (Packet->OutTransferLength > MaxSectorCount * 0x200))) {
1319 return EFI_BAD_BUFFER_SIZE;
1320 }
1321
1322 //
1323 // For non-blocking mode, queue the Task into the list.
1324 //
1325 if (Event != NULL) {
1326 Task = AllocateZeroPool (sizeof (ATA_NONBLOCK_TASK));
1327 if (Task == NULL) {
1328 return EFI_OUT_OF_RESOURCES;
1329 }
1330
1331 Task->Signature = ATA_NONBLOCKING_TASK_SIGNATURE;
1332 Task->Port = Port;
1333 Task->PortMultiplier = PortMultiplierPort;
1334 Task->Packet = Packet;
1335 Task->Event = Event;
1336 Task->IsStart = FALSE;
1337 Task->RetryTimes = 0;
1338
1339 OldTpl = gBS->RaiseTPL (TPL_NOTIFY);
1340 InsertTailList (&Instance->NonBlockingTaskList, &Task->Link);
1341 gBS->RestoreTPL (OldTpl);
1342
1343 return EFI_SUCCESS;
1344 } else {
1345 return AtaPassThruPassThruExecute (
1346 Port,
1347 PortMultiplierPort,
1348 Packet,
1349 Instance,
1350 NULL
1351 );
1352 }
1353 }
1354
1355 /**
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.
1361
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.
1365
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.
1370
1371 If Port is the port number of the last port on the ATA controller, then EFI_NOT_FOUND is
1372 returned.
1373
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.
1379
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
1383 to GetNextPort().
1384
1385 **/
1386 EFI_STATUS
1387 EFIAPI
1388 AtaPassThruGetNextPort (
1389 IN EFI_ATA_PASS_THRU_PROTOCOL *This,
1390 IN OUT UINT16 *Port
1391 )
1392 {
1393 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
1394 LIST_ENTRY *Node;
1395 EFI_ATA_DEVICE_INFO *DeviceInfo;
1396
1397 Instance = ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
1398
1399 if (Port == NULL) {
1400 return EFI_INVALID_PARAMETER;
1401 }
1402
1403 if (*Port == 0xFFFF) {
1404 //
1405 // If the Port is all 0xFF's, start to traverse the device list from the beginning
1406 //
1407 Node = GetFirstNode (&Instance->DeviceList);
1408
1409 while (!IsNull (&Instance->DeviceList, Node)) {
1410 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
1411
1412 if (DeviceInfo->Type == EfiIdeHarddisk) {
1413 *Port = DeviceInfo->Port;
1414 goto Exit;
1415 }
1416
1417 Node = GetNextNode (&Instance->DeviceList, Node);
1418 }
1419
1420 return EFI_NOT_FOUND;
1421 } else if (*Port == Instance->PreviousPort) {
1422 Node = GetFirstNode (&Instance->DeviceList);
1423
1424 while (!IsNull (&Instance->DeviceList, Node)) {
1425 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
1426
1427 if ((DeviceInfo->Type == EfiIdeHarddisk) &&
1428 (DeviceInfo->Port > *Port)){
1429 *Port = DeviceInfo->Port;
1430 goto Exit;
1431 }
1432
1433 Node = GetNextNode (&Instance->DeviceList, Node);
1434 }
1435
1436 return EFI_NOT_FOUND;
1437 } else {
1438 //
1439 // Port is not equal to 0xFFFF and also not equal to previous return value
1440 //
1441 return EFI_INVALID_PARAMETER;
1442 }
1443
1444 Exit:
1445 //
1446 // Update the PreviousPort and PreviousPortMultiplier.
1447 //
1448 Instance->PreviousPort = *Port;
1449
1450 return EFI_SUCCESS;
1451 }
1452
1453 /**
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.
1459
1460 The GetNextDevice() function retrieves the port multiplier port number of an ATA device
1461 present on a port of an ATA controller.
1462
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
1466 returned.
1467
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.
1471
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
1474 is returned.
1475
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.
1478
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.
1487
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().
1493
1494 **/
1495 EFI_STATUS
1496 EFIAPI
1497 AtaPassThruGetNextDevice (
1498 IN EFI_ATA_PASS_THRU_PROTOCOL *This,
1499 IN UINT16 Port,
1500 IN OUT UINT16 *PortMultiplierPort
1501 )
1502 {
1503 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
1504 LIST_ENTRY *Node;
1505 EFI_ATA_DEVICE_INFO *DeviceInfo;
1506
1507 Instance = ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
1508
1509 if (PortMultiplierPort == NULL) {
1510 return EFI_INVALID_PARAMETER;
1511 }
1512
1513 if (*PortMultiplierPort == 0xFFFF) {
1514 //
1515 // If the PortMultiplierPort is all 0xFF's, start to traverse the device list from the beginning
1516 //
1517 Node = GetFirstNode (&Instance->DeviceList);
1518
1519 while (!IsNull (&Instance->DeviceList, Node)) {
1520 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
1521
1522 if ((DeviceInfo->Type == EfiIdeHarddisk) &&
1523 (DeviceInfo->Port == Port)){
1524 *PortMultiplierPort = DeviceInfo->PortMultiplier;
1525 goto Exit;
1526 }
1527
1528 Node = GetNextNode (&Instance->DeviceList, Node);
1529 }
1530
1531 return EFI_NOT_FOUND;
1532 } else if (*PortMultiplierPort == Instance->PreviousPortMultiplier) {
1533 Node = GetFirstNode (&Instance->DeviceList);
1534
1535 while (!IsNull (&Instance->DeviceList, Node)) {
1536 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
1537
1538 if ((DeviceInfo->Type == EfiIdeHarddisk) &&
1539 (DeviceInfo->Port == Port) &&
1540 (DeviceInfo->PortMultiplier > *PortMultiplierPort)){
1541 *PortMultiplierPort = DeviceInfo->PortMultiplier;
1542 goto Exit;
1543 }
1544
1545 Node = GetNextNode (&Instance->DeviceList, Node);
1546 }
1547
1548 return EFI_NOT_FOUND;
1549 } else {
1550 //
1551 // PortMultiplierPort is not equal to 0xFFFF and also not equal to previous return value
1552 //
1553 return EFI_INVALID_PARAMETER;
1554 }
1555
1556 Exit:
1557 //
1558 // Update the PreviousPort and PreviousPortMultiplier.
1559 //
1560 Instance->PreviousPortMultiplier = *PortMultiplierPort;
1561
1562 return EFI_SUCCESS;
1563 }
1564
1565 /**
1566 Used to allocate and build a device path node for an ATA device on an ATA controller.
1567
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.
1573
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.
1577
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.
1595
1596 **/
1597 EFI_STATUS
1598 EFIAPI
1599 AtaPassThruBuildDevicePath (
1600 IN EFI_ATA_PASS_THRU_PROTOCOL *This,
1601 IN UINT16 Port,
1602 IN UINT16 PortMultiplierPort,
1603 IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath
1604 )
1605 {
1606 EFI_DEV_PATH *DevicePathNode;
1607 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
1608 LIST_ENTRY *Node;
1609
1610 Instance = ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
1611
1612 //
1613 // Validate parameters passed in.
1614 //
1615 if (DevicePath == NULL) {
1616 return EFI_INVALID_PARAMETER;
1617 }
1618
1619 Node = SearchDeviceInfoList(Instance, Port, PortMultiplierPort, EfiIdeHarddisk);
1620 if (Node == NULL) {
1621 return EFI_NOT_FOUND;
1622 }
1623
1624 if (Instance->Mode == EfiAtaIdeMode) {
1625 DevicePathNode = AllocateCopyPool (sizeof (ATAPI_DEVICE_PATH), &mAtapiDevicePathTemplate);
1626 if (DevicePathNode == NULL) {
1627 return EFI_OUT_OF_RESOURCES;
1628 }
1629 DevicePathNode->Atapi.PrimarySecondary = (UINT8) Port;
1630 DevicePathNode->Atapi.SlaveMaster = (UINT8) PortMultiplierPort;
1631 DevicePathNode->Atapi.Lun = 0;
1632 } else {
1633 DevicePathNode = AllocateCopyPool (sizeof (SATA_DEVICE_PATH), &mSataDevicePathTemplate);
1634 if (DevicePathNode == NULL) {
1635 return EFI_OUT_OF_RESOURCES;
1636 }
1637
1638 DevicePathNode->Sata.HBAPortNumber = Port;
1639 DevicePathNode->Sata.PortMultiplierPortNumber = PortMultiplierPort;
1640 DevicePathNode->Sata.Lun = 0;
1641 }
1642
1643 *DevicePath = (EFI_DEVICE_PATH_PROTOCOL *) DevicePathNode;
1644
1645 return EFI_SUCCESS;
1646 }
1647
1648 /**
1649 Used to translate a device path node to a port number and port multiplier port number.
1650
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.
1655
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.
1658
1659 If DevicePath, Port, or PortMultiplierPort are NULL, then EFI_INVALID_PARAMETER is returned.
1660
1661 If DevicePath is not a device path node type that the ATA Pass Thru driver supports, then
1662 EFI_UNSUPPORTED is returned.
1663
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.
1667
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
1670 ATA controller.
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.
1674
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.
1683 **/
1684 EFI_STATUS
1685 EFIAPI
1686 AtaPassThruGetDevice (
1687 IN EFI_ATA_PASS_THRU_PROTOCOL *This,
1688 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,
1689 OUT UINT16 *Port,
1690 OUT UINT16 *PortMultiplierPort
1691 )
1692 {
1693 EFI_DEV_PATH *DevicePathNode;
1694 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
1695 LIST_ENTRY *Node;
1696
1697 Instance = ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
1698
1699 //
1700 // Validate parameters passed in.
1701 //
1702 if (DevicePath == NULL || Port == NULL || PortMultiplierPort == NULL) {
1703 return EFI_INVALID_PARAMETER;
1704 }
1705
1706 //
1707 // Check whether the DevicePath belongs to SCSI_DEVICE_PATH or ATAPI_DEVICE_PATH
1708 //
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;
1715 }
1716
1717 DevicePathNode = (EFI_DEV_PATH *) DevicePath;
1718
1719 if (Instance->Mode == EfiAtaIdeMode) {
1720 *Port = DevicePathNode->Atapi.PrimarySecondary;
1721 *PortMultiplierPort = DevicePathNode->Atapi.SlaveMaster;
1722 } else {
1723 *Port = DevicePathNode->Sata.HBAPortNumber;
1724 *PortMultiplierPort = DevicePathNode->Sata.PortMultiplierPortNumber;
1725 }
1726
1727 Node = SearchDeviceInfoList(Instance, *Port, *PortMultiplierPort, EfiIdeHarddisk);
1728
1729 if (Node == NULL) {
1730 return EFI_NOT_FOUND;
1731 }
1732
1733 return EFI_SUCCESS;
1734 }
1735
1736 /**
1737 Resets a specific port on the ATA controller. This operation also resets all the ATA devices
1738 connected to the port.
1739
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.
1743
1744 If a device error occurs while executing that port reset operation, then EFI_DEVICE_ERROR is
1745 returned.
1746
1747 If a timeout occurs during the execution of the port reset operation, then EFI_TIMEOUT is returned.
1748
1749 If the port reset operation is completed, then EFI_SUCCESS is returned.
1750
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.
1753
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.
1758
1759 **/
1760 EFI_STATUS
1761 EFIAPI
1762 AtaPassThruResetPort (
1763 IN EFI_ATA_PASS_THRU_PROTOCOL *This,
1764 IN UINT16 Port
1765 )
1766 {
1767 //
1768 // Return success directly then upper layer driver could think reset port operation is done.
1769 //
1770 return EFI_SUCCESS;
1771 }
1772
1773 /**
1774 Resets an ATA device that is connected to an ATA controller.
1775
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
1778 returned.
1779
1780 If Port or PortMultiplierPort are not in a valid range for this ATA controller, then
1781 EFI_INVALID_PARAMETER is returned.
1782
1783 If a device error occurs while executing that device reset operation, then EFI_DEVICE_ERROR
1784 is returned.
1785
1786 If a timeout occurs during the execution of the device reset operation, then EFI_TIMEOUT is
1787 returned.
1788
1789 If the device reset operation is completed, then EFI_SUCCESS is returned.
1790
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.
1802
1803 **/
1804 EFI_STATUS
1805 EFIAPI
1806 AtaPassThruResetDevice (
1807 IN EFI_ATA_PASS_THRU_PROTOCOL *This,
1808 IN UINT16 Port,
1809 IN UINT16 PortMultiplierPort
1810 )
1811 {
1812 //
1813 // Return success directly then upper layer driver could think reset device operation is done.
1814 //
1815 return EFI_SUCCESS;
1816 }
1817
1818 /**
1819 Sends a SCSI Request Packet to a SCSI device that is attached to the SCSI channel. This function
1820 supports both blocking I/O and nonblocking I/O. The blocking I/O functionality is required, and the
1821 nonblocking I/O functionality is optional.
1822
1823 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
1824 @param Target The Target is an array of size TARGET_MAX_BYTES and it represents
1825 the id of the SCSI device to send the SCSI Request Packet. Each
1826 transport driver may choose to utilize a subset of this size to suit the needs
1827 of transport target representation. For example, a Fibre Channel driver
1828 may use only 8 bytes (WWN) to represent an FC target.
1829 @param Lun The LUN of the SCSI device to send the SCSI Request Packet.
1830 @param Packet A pointer to the SCSI Request Packet to send to the SCSI device
1831 specified by Target and Lun.
1832 @param Event If nonblocking I/O is not supported then Event is ignored, and blocking
1833 I/O is performed. If Event is NULL, then blocking I/O is performed. If
1834 Event is not NULL and non blocking I/O is supported, then
1835 nonblocking I/O is performed, and Event will be signaled when the
1836 SCSI Request Packet completes.
1837
1838 @retval EFI_SUCCESS The SCSI Request Packet was sent by the host. For bi-directional
1839 commands, InTransferLength bytes were transferred from
1840 InDataBuffer. For write and bi-directional commands,
1841 OutTransferLength bytes were transferred by
1842 OutDataBuffer.
1843 @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was not executed. The number of bytes that
1844 could be transferred is returned in InTransferLength. For write
1845 and bi-directional commands, OutTransferLength bytes were
1846 transferred by OutDataBuffer.
1847 @retval EFI_NOT_READY The SCSI Request Packet could not be sent because there are too many
1848 SCSI Request Packets already queued. The caller may retry again later.
1849 @retval EFI_DEVICE_ERROR A device error occurred while attempting to send the SCSI Request
1850 Packet.
1851 @retval EFI_INVALID_PARAMETER Target, Lun, or the contents of ScsiRequestPacket are invalid.
1852 @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported
1853 by the host adapter. This includes the case of Bi-directional SCSI
1854 commands not supported by the implementation. The SCSI Request
1855 Packet was not sent, so no additional status information is available.
1856 @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
1857
1858 **/
1859 EFI_STATUS
1860 EFIAPI
1861 ExtScsiPassThruPassThru (
1862 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,
1863 IN UINT8 *Target,
1864 IN UINT64 Lun,
1865 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet,
1866 IN EFI_EVENT Event OPTIONAL
1867 )
1868 {
1869 EFI_STATUS Status;
1870 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
1871 UINT8 Port;
1872 UINT8 PortMultiplier;
1873 EFI_ATA_HC_WORK_MODE Mode;
1874 LIST_ENTRY *Node;
1875 EFI_ATA_DEVICE_INFO *DeviceInfo;
1876
1877 Instance = EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
1878
1879 if ((Packet == NULL) || (Packet->Cdb == NULL)) {
1880 return EFI_INVALID_PARAMETER;
1881 }
1882
1883 //
1884 // Don't support variable length CDB
1885 //
1886 if ((Packet->CdbLength != 6) && (Packet->CdbLength != 10) &&
1887 (Packet->CdbLength != 12) && (Packet->CdbLength != 16)) {
1888 return EFI_INVALID_PARAMETER;
1889 }
1890
1891 if ((This->Mode->IoAlign > 1) && !IS_ALIGNED(Packet->InDataBuffer, This->Mode->IoAlign)) {
1892 return EFI_INVALID_PARAMETER;
1893 }
1894
1895 if ((This->Mode->IoAlign > 1) && !IS_ALIGNED(Packet->OutDataBuffer, This->Mode->IoAlign)) {
1896 return EFI_INVALID_PARAMETER;
1897 }
1898
1899 if ((This->Mode->IoAlign > 1) && !IS_ALIGNED(Packet->SenseData, This->Mode->IoAlign)) {
1900 return EFI_INVALID_PARAMETER;
1901 }
1902
1903 //
1904 // For ATAPI device, doesn't support multiple LUN device.
1905 //
1906 if (Lun != 0) {
1907 return EFI_INVALID_PARAMETER;
1908 }
1909
1910 //
1911 // The layout of Target array:
1912 // ________________________________________________________________________
1913 // | Byte 0 | Byte 1 | ... | TARGET_MAX_BYTES - 1 |
1914 // |_____________________|_____________________|_____|______________________|
1915 // | | The port multiplier | | |
1916 // | The port number | port number | N/A | N/A |
1917 // |_____________________|_____________________|_____|______________________|
1918 //
1919 // For ATAPI device, 2 bytes is enough to represent the location of SCSI device.
1920 //
1921 Port = Target[0];
1922 PortMultiplier = Target[1];
1923
1924 Node = SearchDeviceInfoList(Instance, Port, PortMultiplier, EfiIdeCdrom);
1925 if (Node == NULL) {
1926 return EFI_INVALID_PARAMETER;
1927 }
1928
1929 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
1930
1931 //
1932 // ATA_CMD_IDENTIFY_DEVICE cmd is a ATA cmd but not a SCSI cmd.
1933 // Normally it should NOT be passed down through ExtScsiPassThru protocol interface.
1934 // But to response EFI_DISK_INFO.Identify() request from ScsiDisk, we should handle this command.
1935 //
1936 if (*((UINT8*)Packet->Cdb) == ATA_CMD_IDENTIFY_DEVICE) {
1937 CopyMem (Packet->InDataBuffer, DeviceInfo->IdentifyData, sizeof (EFI_IDENTIFY_DATA));
1938 return EFI_SUCCESS;
1939 }
1940
1941 Mode = Instance->Mode;
1942 switch (Mode) {
1943 case EfiAtaIdeMode:
1944 //
1945 // Reassign IDE mode io port registers' base addresses
1946 //
1947 Status = GetIdeRegisterIoAddr (Instance->PciIo, Instance->IdeRegisters);
1948
1949 if (EFI_ERROR (Status)) {
1950 return Status;
1951 }
1952
1953 Status = AtaPacketCommandExecute (Instance->PciIo, &Instance->IdeRegisters[Port], Port, PortMultiplier, Packet);
1954 break;
1955 case EfiAtaAhciMode:
1956 Status = AhciPacketCommandExecute (Instance->PciIo, &Instance->AhciRegisters, Port, PortMultiplier, Packet);
1957 break;
1958 default :
1959 Status = EFI_DEVICE_ERROR;
1960 break;
1961 }
1962
1963 return Status;
1964 }
1965
1966 /**
1967 Used to retrieve the list of legal Target IDs and LUNs for SCSI devices on a SCSI channel. These
1968 can either be the list SCSI devices that are actually present on the SCSI channel, or the list of legal
1969 Target Ids and LUNs for the SCSI channel. Regardless, the caller of this function must probe the
1970 Target ID and LUN returned to see if a SCSI device is actually present at that location on the SCSI
1971 channel.
1972
1973 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
1974 @param Target On input, a pointer to the Target ID (an array of size
1975 TARGET_MAX_BYTES) of a SCSI device present on the SCSI channel.
1976 On output, a pointer to the Target ID (an array of
1977 TARGET_MAX_BYTES) of the next SCSI device present on a SCSI
1978 channel. An input value of 0xF(all bytes in the array are 0xF) in the
1979 Target array retrieves the Target ID of the first SCSI device present on a
1980 SCSI channel.
1981 @param Lun On input, a pointer to the LUN of a SCSI device present on the SCSI
1982 channel. On output, a pointer to the LUN of the next SCSI device present
1983 on a SCSI channel.
1984
1985 @retval EFI_SUCCESS The Target ID and LUN of the next SCSI device on the SCSI
1986 channel was returned in Target and Lun.
1987 @retval EFI_INVALID_PARAMETER Target array is not all 0xF, and Target and Lun were
1988 not returned on a previous call to GetNextTargetLun().
1989 @retval EFI_NOT_FOUND There are no more SCSI devices on this SCSI channel.
1990
1991 **/
1992 EFI_STATUS
1993 EFIAPI
1994 ExtScsiPassThruGetNextTargetLun (
1995 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,
1996 IN OUT UINT8 **Target,
1997 IN OUT UINT64 *Lun
1998 )
1999 {
2000 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
2001 LIST_ENTRY *Node;
2002 EFI_ATA_DEVICE_INFO *DeviceInfo;
2003 UINT8 *Target8;
2004 UINT16 *Target16;
2005
2006 Instance = EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
2007
2008 if (Target == NULL || Lun == NULL) {
2009 return EFI_INVALID_PARAMETER;
2010 }
2011
2012 if (*Target == NULL) {
2013 return EFI_INVALID_PARAMETER;
2014 }
2015
2016 Target8 = *Target;
2017 Target16 = (UINT16 *)*Target;
2018
2019 if (CompareMem(Target8, mScsiId, TARGET_MAX_BYTES) != 0) {
2020 //
2021 // For ATAPI device, we use 2 least significant bytes to represent the location of SCSI device.
2022 // So the higher bytes in Target array should be 0xFF.
2023 //
2024 if (CompareMem (&Target8[2], &mScsiId[2], TARGET_MAX_BYTES - 2) != 0) {
2025 return EFI_INVALID_PARAMETER;
2026 }
2027
2028 //
2029 // When Target is not all 0xFF's, compare 2 least significant bytes with
2030 // previous target id to see if it is returned by previous call.
2031 //
2032 if ((*Target16 != Instance->PreviousTargetId) ||
2033 (*Lun != Instance->PreviousLun)) {
2034 return EFI_INVALID_PARAMETER;
2035 }
2036
2037 //
2038 // Traverse the whole device list to find the next cdrom closed to
2039 // the device signified by Target[0] and Target[1].
2040 //
2041 // Note that we here use a tricky way to find the next cdrom :
2042 // All ata devices are detected and inserted into the device list
2043 // sequentially.
2044 //
2045 Node = GetFirstNode (&Instance->DeviceList);
2046
2047 while (!IsNull (&Instance->DeviceList, Node)) {
2048 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
2049
2050 if ((DeviceInfo->Type == EfiIdeCdrom) &&
2051 ((Target8[0] < DeviceInfo->Port) ||
2052 ((Target8[0] == DeviceInfo->Port) &&
2053 (Target8[1] < DeviceInfo->PortMultiplier)))) {
2054 Target8[0] = (UINT8)DeviceInfo->Port;
2055 Target8[1] = (UINT8)DeviceInfo->PortMultiplier;
2056 goto Exit;
2057 }
2058
2059 Node = GetNextNode (&Instance->DeviceList, Node);
2060 }
2061
2062 return EFI_NOT_FOUND;
2063 } else {
2064 //
2065 // If the array is all 0xFF's, start to traverse the device list from the beginning
2066 //
2067 Node = GetFirstNode (&Instance->DeviceList);
2068 while (!IsNull (&Instance->DeviceList, Node)) {
2069 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
2070
2071 if (DeviceInfo->Type == EfiIdeCdrom) {
2072 Target8[0] = (UINT8)DeviceInfo->Port;
2073 Target8[1] = (UINT8)DeviceInfo->PortMultiplier;
2074 goto Exit;
2075 }
2076
2077 Node = GetNextNode (&Instance->DeviceList, Node);
2078 }
2079
2080 return EFI_NOT_FOUND;
2081 }
2082
2083 Exit:
2084 *Lun = 0;
2085
2086 //
2087 // Update the PreviousTargetId.
2088 //
2089 Instance->PreviousTargetId = *Target16;
2090 Instance->PreviousLun = *Lun;
2091
2092 return EFI_SUCCESS;
2093 }
2094
2095 /**
2096 Used to allocate and build a device path node for a SCSI device on a SCSI channel.
2097
2098 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
2099 @param Target The Target is an array of size TARGET_MAX_BYTES and it specifies the
2100 Target ID of the SCSI device for which a device path node is to be
2101 allocated and built. Transport drivers may chose to utilize a subset of
2102 this size to suit the representation of targets. For example, a Fibre
2103 Channel driver may use only 8 bytes (WWN) in the array to represent a
2104 FC target.
2105 @param Lun The LUN of the SCSI device for which a device path node is to be
2106 allocated and built.
2107 @param DevicePath A pointer to a single device path node that describes the SCSI device
2108 specified by Target and Lun. This function is responsible for
2109 allocating the buffer DevicePath with the boot service
2110 AllocatePool(). It is the caller's responsibility to free
2111 DevicePath when the caller is finished with DevicePath.
2112
2113 @retval EFI_SUCCESS The device path node that describes the SCSI device specified by
2114 Target and Lun was allocated and returned in
2115 DevicePath.
2116 @retval EFI_INVALID_PARAMETER DevicePath is NULL.
2117 @retval EFI_NOT_FOUND The SCSI devices specified by Target and Lun does not exist
2118 on the SCSI channel.
2119 @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate DevicePath.
2120
2121 **/
2122 EFI_STATUS
2123 EFIAPI
2124 ExtScsiPassThruBuildDevicePath (
2125 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,
2126 IN UINT8 *Target,
2127 IN UINT64 Lun,
2128 IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath
2129 )
2130 {
2131 EFI_DEV_PATH *DevicePathNode;
2132 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
2133 UINT8 Port;
2134 UINT8 PortMultiplier;
2135
2136 Instance = EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
2137
2138 Port = Target[0];
2139 PortMultiplier = Target[1];
2140
2141 //
2142 // Validate parameters passed in.
2143 //
2144 if (DevicePath == NULL) {
2145 return EFI_INVALID_PARAMETER;
2146 }
2147
2148 //
2149 // can not build device path for the SCSI Host Controller.
2150 //
2151 if (Lun != 0) {
2152 return EFI_NOT_FOUND;
2153 }
2154
2155 if (SearchDeviceInfoList(Instance, Port, PortMultiplier, EfiIdeCdrom) == NULL) {
2156 return EFI_NOT_FOUND;
2157 }
2158
2159 if (Instance->Mode == EfiAtaIdeMode) {
2160 DevicePathNode = AllocateCopyPool (sizeof (ATAPI_DEVICE_PATH), &mAtapiDevicePathTemplate);
2161 if (DevicePathNode == NULL) {
2162 return EFI_OUT_OF_RESOURCES;
2163 }
2164
2165 DevicePathNode->Atapi.PrimarySecondary = Port;
2166 DevicePathNode->Atapi.SlaveMaster = PortMultiplier;
2167 DevicePathNode->Atapi.Lun = (UINT16) Lun;
2168 } else {
2169 DevicePathNode = AllocateCopyPool (sizeof (SATA_DEVICE_PATH), &mSataDevicePathTemplate);
2170 if (DevicePathNode == NULL) {
2171 return EFI_OUT_OF_RESOURCES;
2172 }
2173
2174 DevicePathNode->Sata.HBAPortNumber = Port;
2175 DevicePathNode->Sata.PortMultiplierPortNumber = PortMultiplier;
2176 DevicePathNode->Sata.Lun = (UINT16) Lun;
2177 }
2178
2179 *DevicePath = (EFI_DEVICE_PATH_PROTOCOL *) DevicePathNode;
2180
2181 return EFI_SUCCESS;
2182 }
2183
2184 /**
2185 Used to translate a device path node to a Target ID and LUN.
2186
2187 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
2188 @param DevicePath A pointer to a single device path node that describes the SCSI device
2189 on the SCSI channel.
2190 @param Target A pointer to the Target Array which represents the ID of a SCSI device
2191 on the SCSI channel.
2192 @param Lun A pointer to the LUN of a SCSI device on the SCSI channel.
2193
2194 @retval EFI_SUCCESS DevicePath was successfully translated to a Target ID and
2195 LUN, and they were returned in Target and Lun.
2196 @retval EFI_INVALID_PARAMETER DevicePath or Target or Lun is NULL.
2197 @retval EFI_NOT_FOUND A valid translation from DevicePath to a Target ID and LUN
2198 does not exist.
2199 @retval EFI_UNSUPPORTED This driver does not support the device path node type in
2200 DevicePath.
2201
2202 **/
2203 EFI_STATUS
2204 EFIAPI
2205 ExtScsiPassThruGetTargetLun (
2206 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,
2207 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,
2208 OUT UINT8 **Target,
2209 OUT UINT64 *Lun
2210 )
2211 {
2212 EFI_DEV_PATH *DevicePathNode;
2213 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
2214 LIST_ENTRY *Node;
2215
2216 Instance = EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
2217
2218 //
2219 // Validate parameters passed in.
2220 //
2221 if (DevicePath == NULL || Target == NULL || Lun == NULL) {
2222 return EFI_INVALID_PARAMETER;
2223 }
2224
2225 if (*Target == NULL) {
2226 return EFI_INVALID_PARAMETER;
2227 }
2228 //
2229 // Check whether the DevicePath belongs to SCSI_DEVICE_PATH
2230 //
2231 if ((DevicePath->Type != MESSAGING_DEVICE_PATH) ||
2232 ((DevicePath->SubType != MSG_ATAPI_DP) &&
2233 (DevicePath->SubType != MSG_SATA_DP)) ||
2234 ((DevicePathNodeLength(DevicePath) != sizeof(ATAPI_DEVICE_PATH)) &&
2235 (DevicePathNodeLength(DevicePath) != sizeof(SATA_DEVICE_PATH)))) {
2236 return EFI_UNSUPPORTED;
2237 }
2238
2239 SetMem (*Target, TARGET_MAX_BYTES, 0xFF);
2240
2241 DevicePathNode = (EFI_DEV_PATH *) DevicePath;
2242
2243 if (Instance->Mode == EfiAtaIdeMode) {
2244 (*Target)[0] = (UINT8) DevicePathNode->Atapi.PrimarySecondary;
2245 (*Target)[1] = (UINT8) DevicePathNode->Atapi.SlaveMaster;
2246 *Lun = (UINT8) DevicePathNode->Atapi.Lun;
2247 } else {
2248 (*Target)[0] = (UINT8) DevicePathNode->Sata.HBAPortNumber;
2249 (*Target)[1] = (UINT8) DevicePathNode->Sata.PortMultiplierPortNumber;
2250 *Lun = (UINT8) DevicePathNode->Sata.Lun;
2251 }
2252
2253 Node = SearchDeviceInfoList(Instance, (*Target)[0], (*Target)[1], EfiIdeCdrom);
2254
2255 if (Node == NULL) {
2256 return EFI_NOT_FOUND;
2257 }
2258
2259 if (*Lun != 0) {
2260 return EFI_NOT_FOUND;
2261 }
2262
2263 return EFI_SUCCESS;
2264 }
2265
2266 /**
2267 Resets a SCSI channel. This operation resets all the SCSI devices connected to the SCSI channel.
2268
2269 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
2270
2271 @retval EFI_SUCCESS The SCSI channel was reset.
2272 @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the SCSI channel.
2273 @retval EFI_TIMEOUT A timeout occurred while attempting to reset the SCSI channel.
2274 @retval EFI_UNSUPPORTED The SCSI channel does not support a channel reset operation.
2275
2276 **/
2277 EFI_STATUS
2278 EFIAPI
2279 ExtScsiPassThruResetChannel (
2280 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This
2281 )
2282 {
2283 //
2284 // Return success directly then upper layer driver could think reset channel operation is done.
2285 //
2286 return EFI_SUCCESS;
2287 }
2288
2289 /**
2290 Resets a SCSI logical unit that is connected to a SCSI channel.
2291
2292 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
2293 @param Target The Target is an array of size TARGET_MAX_BYTE and it represents the
2294 target port ID of the SCSI device containing the SCSI logical unit to
2295 reset. Transport drivers may chose to utilize a subset of this array to suit
2296 the representation of their targets.
2297 @param Lun The LUN of the SCSI device to reset.
2298
2299 @retval EFI_SUCCESS The SCSI device specified by Target and Lun was reset.
2300 @retval EFI_INVALID_PARAMETER Target or Lun is NULL.
2301 @retval EFI_TIMEOUT A timeout occurred while attempting to reset the SCSI device
2302 specified by Target and Lun.
2303 @retval EFI_UNSUPPORTED The SCSI channel does not support a target reset operation.
2304 @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the SCSI device
2305 specified by Target and Lun.
2306
2307 **/
2308 EFI_STATUS
2309 EFIAPI
2310 ExtScsiPassThruResetTargetLun (
2311 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,
2312 IN UINT8 *Target,
2313 IN UINT64 Lun
2314 )
2315 {
2316 //
2317 // Return success directly then upper layer driver could think reset target LUN operation is done.
2318 //
2319 return EFI_SUCCESS;
2320 }
2321
2322 /**
2323 Used to retrieve the list of legal Target IDs for SCSI devices on a SCSI channel. These can either
2324 be the list SCSI devices that are actually present on the SCSI channel, or the list of legal Target IDs
2325 for the SCSI channel. Regardless, the caller of this function must probe the Target ID returned to
2326 see if a SCSI device is actually present at that location on the SCSI channel.
2327
2328 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
2329 @param Target (TARGET_MAX_BYTES) of a SCSI device present on the SCSI channel.
2330 On output, a pointer to the Target ID (an array of
2331 TARGET_MAX_BYTES) of the next SCSI device present on a SCSI
2332 channel. An input value of 0xF(all bytes in the array are 0xF) in the
2333 Target array retrieves the Target ID of the first SCSI device present on a
2334 SCSI channel.
2335
2336 @retval EFI_SUCCESS The Target ID of the next SCSI device on the SCSI
2337 channel was returned in Target.
2338 @retval EFI_INVALID_PARAMETER Target or Lun is NULL.
2339 @retval EFI_TIMEOUT Target array is not all 0xF, and Target was not
2340 returned on a previous call to GetNextTarget().
2341 @retval EFI_NOT_FOUND There are no more SCSI devices on this SCSI channel.
2342
2343 **/
2344 EFI_STATUS
2345 EFIAPI
2346 ExtScsiPassThruGetNextTarget (
2347 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,
2348 IN OUT UINT8 **Target
2349 )
2350 {
2351 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
2352 LIST_ENTRY *Node;
2353 EFI_ATA_DEVICE_INFO *DeviceInfo;
2354 UINT8 *Target8;
2355 UINT16 *Target16;
2356
2357 Instance = EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
2358
2359 if (Target == NULL || *Target == NULL) {
2360 return EFI_INVALID_PARAMETER;
2361 }
2362
2363 Target8 = *Target;
2364 Target16 = (UINT16 *)*Target;
2365
2366 if (CompareMem(Target8, mScsiId, TARGET_MAX_BYTES) != 0) {
2367 //
2368 // For ATAPI device, we use 2 least significant bytes to represent the location of SCSI device.
2369 // So the higher bytes in Target array should be 0xFF.
2370 //
2371 if (CompareMem (&Target8[2], &mScsiId[2], TARGET_MAX_BYTES - 2) != 0) {
2372 return EFI_INVALID_PARAMETER;
2373 }
2374
2375 //
2376 // When Target is not all 0xFF's, compare 2 least significant bytes with
2377 // previous target id to see if it is returned by previous call.
2378 //
2379 if (*Target16 != Instance->PreviousTargetId) {
2380 return EFI_INVALID_PARAMETER;
2381 }
2382
2383 //
2384 // Traverse the whole device list to find the next cdrom closed to
2385 // the device signified by Target[0] and Target[1].
2386 //
2387 // Note that we here use a tricky way to find the next cdrom :
2388 // All ata devices are detected and inserted into the device list
2389 // sequentially.
2390 //
2391 Node = GetFirstNode (&Instance->DeviceList);
2392 while (!IsNull (&Instance->DeviceList, Node)) {
2393 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
2394
2395 if ((DeviceInfo->Type == EfiIdeCdrom) &&
2396 ((Target8[0] < DeviceInfo->Port) ||
2397 ((Target8[0] == DeviceInfo->Port) &&
2398 (Target8[1] < DeviceInfo->PortMultiplier)))) {
2399 Target8[0] = (UINT8)DeviceInfo->Port;
2400 Target8[1] = (UINT8)DeviceInfo->PortMultiplier;
2401 goto Exit;
2402 }
2403
2404 Node = GetNextNode (&Instance->DeviceList, Node);
2405 }
2406
2407 return EFI_NOT_FOUND;
2408 } else {
2409 //
2410 // If the array is all 0xFF's, start to traverse the device list from the beginning
2411 //
2412 Node = GetFirstNode (&Instance->DeviceList);
2413
2414 while (!IsNull (&Instance->DeviceList, Node)) {
2415 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
2416
2417 if (DeviceInfo->Type == EfiIdeCdrom) {
2418 Target8[0] = (UINT8)DeviceInfo->Port;
2419 Target8[1] = (UINT8)DeviceInfo->PortMultiplier;
2420 goto Exit;
2421 }
2422
2423 Node = GetNextNode (&Instance->DeviceList, Node);
2424 }
2425
2426 return EFI_NOT_FOUND;
2427 }
2428
2429 Exit:
2430 //
2431 // Update the PreviousTargetId.
2432 //
2433 Instance->PreviousTargetId = *Target16;
2434
2435 return EFI_SUCCESS;
2436 }
2437