]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Bus/Ata/AtaAtapiPassThru/AtaAtapiPassThru.c
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
MdeModulePkg/ScsiDisk: Using back-off algorithm to dynamically adjust transfer length...
[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 - 2014, 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 Status = gBS->UninstallMultipleProtocolInterfaces (
874 Controller,
875 &gEfiAtaPassThruProtocolGuid, &(Instance->AtaPassThru),
876 &gEfiExtScsiPassThruProtocolGuid, &(Instance->ExtScsiPassThru),
877 NULL
878 );
879
880 if (EFI_ERROR (Status)) {
881 return EFI_DEVICE_ERROR;
882 }
883
884 //
885 // Close protocols opened by AtaAtapiPassThru controller driver
886 //
887 gBS->CloseProtocol (
888 Controller,
889 &gEfiIdeControllerInitProtocolGuid,
890 This->DriverBindingHandle,
891 Controller
892 );
893
894 //
895 // Close Non-Blocking timer and free Task list.
896 //
897 if (Instance->TimerEvent != NULL) {
898 gBS->CloseEvent (Instance->TimerEvent);
899 Instance->TimerEvent = NULL;
900 }
901 DestroyAsynTaskList (Instance, FALSE);
902 //
903 // Free allocated resource
904 //
905 DestroyDeviceInfoList (Instance);
906
907 //
908 // If the current working mode is AHCI mode, then pre-allocated resource
909 // for AHCI initialization should be released.
910 //
911 PciIo = Instance->PciIo;
912
913 if (Instance->Mode == EfiAtaAhciMode) {
914 AhciRegisters = &Instance->AhciRegisters;
915 PciIo->Unmap (
916 PciIo,
917 AhciRegisters->MapCommandTable
918 );
919 PciIo->FreeBuffer (
920 PciIo,
921 EFI_SIZE_TO_PAGES ((UINTN) AhciRegisters->MaxCommandTableSize),
922 AhciRegisters->AhciCommandTable
923 );
924 PciIo->Unmap (
925 PciIo,
926 AhciRegisters->MapCmdList
927 );
928 PciIo->FreeBuffer (
929 PciIo,
930 EFI_SIZE_TO_PAGES ((UINTN) AhciRegisters->MaxCommandListSize),
931 AhciRegisters->AhciCmdList
932 );
933 PciIo->Unmap (
934 PciIo,
935 AhciRegisters->MapRFis
936 );
937 PciIo->FreeBuffer (
938 PciIo,
939 EFI_SIZE_TO_PAGES ((UINTN) AhciRegisters->MaxReceiveFisSize),
940 AhciRegisters->AhciRFis
941 );
942 }
943
944 //
945 // Disable this ATA host controller.
946 //
947 Status = PciIo->Attributes (
948 PciIo,
949 EfiPciIoAttributeOperationSupported,
950 0,
951 &Supports
952 );
953 if (!EFI_ERROR (Status)) {
954 Supports &= EFI_PCI_DEVICE_ENABLE;
955 PciIo->Attributes (
956 PciIo,
957 EfiPciIoAttributeOperationDisable,
958 Supports,
959 NULL
960 );
961 }
962
963 //
964 // Restore original PCI attributes
965 //
966 Status = PciIo->Attributes (
967 PciIo,
968 EfiPciIoAttributeOperationSet,
969 Instance->OriginalPciAttributes,
970 NULL
971 );
972 ASSERT_EFI_ERROR (Status);
973
974 FreePool (Instance);
975
976 return Status;
977 }
978
979 /**
980 Traverse the attached ATA devices list to find out the device to access.
981
982 @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance.
983 @param[in] Port The port number of the ATA device to send the command.
984 @param[in] PortMultiplierPort The port multiplier port number of the ATA device to send the command.
985 If there is no port multiplier, then specify 0.
986 @param[in] DeviceType The device type of the ATA device.
987
988 @retval The pointer to the data structure of the device info to access.
989
990 **/
991 LIST_ENTRY *
992 EFIAPI
993 SearchDeviceInfoList (
994 IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance,
995 IN UINT16 Port,
996 IN UINT16 PortMultiplier,
997 IN EFI_ATA_DEVICE_TYPE DeviceType
998 )
999 {
1000 EFI_ATA_DEVICE_INFO *DeviceInfo;
1001 LIST_ENTRY *Node;
1002
1003 Node = GetFirstNode (&Instance->DeviceList);
1004 while (!IsNull (&Instance->DeviceList, Node)) {
1005 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
1006
1007 if ((DeviceInfo->Type == DeviceType) &&
1008 (Port == DeviceInfo->Port) &&
1009 (PortMultiplier == DeviceInfo->PortMultiplier)) {
1010 return Node;
1011 }
1012
1013 Node = GetNextNode (&Instance->DeviceList, Node);
1014 }
1015
1016 return NULL;
1017 }
1018
1019 /**
1020 Allocate device info data structure to contain device info.
1021 And insert the data structure to the tail of device list for tracing.
1022
1023 @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance.
1024 @param[in] Port The port number of the ATA device to send the command.
1025 @param[in] PortMultiplierPort The port multiplier port number of the ATA device to send the command.
1026 If there is no port multiplier, then specify 0.
1027 @param[in] DeviceType The device type of the ATA device.
1028 @param[in] IdentifyData The data buffer to store the output of the IDENTIFY cmd.
1029
1030 @retval EFI_SUCCESS Successfully insert the ata device to the tail of device list.
1031 @retval EFI_OUT_OF_RESOURCES Can not allocate enough resource for use.
1032
1033 **/
1034 EFI_STATUS
1035 EFIAPI
1036 CreateNewDeviceInfo (
1037 IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance,
1038 IN UINT16 Port,
1039 IN UINT16 PortMultiplier,
1040 IN EFI_ATA_DEVICE_TYPE DeviceType,
1041 IN EFI_IDENTIFY_DATA *IdentifyData
1042 )
1043 {
1044 EFI_ATA_DEVICE_INFO *DeviceInfo;
1045
1046 DeviceInfo = AllocateZeroPool (sizeof (EFI_ATA_DEVICE_INFO));
1047
1048 if (DeviceInfo == NULL) {
1049 return EFI_OUT_OF_RESOURCES;
1050 }
1051
1052 DeviceInfo->Signature = ATA_ATAPI_DEVICE_SIGNATURE;
1053 DeviceInfo->Port = Port;
1054 DeviceInfo->PortMultiplier = PortMultiplier;
1055 DeviceInfo->Type = DeviceType;
1056
1057 if (IdentifyData != NULL) {
1058 DeviceInfo->IdentifyData = AllocateCopyPool (sizeof (EFI_IDENTIFY_DATA), IdentifyData);
1059 if (DeviceInfo->IdentifyData == NULL) {
1060 FreePool (DeviceInfo);
1061 return EFI_OUT_OF_RESOURCES;
1062 }
1063 }
1064
1065 InsertTailList (&Instance->DeviceList, &DeviceInfo->Link);
1066
1067 return EFI_SUCCESS;
1068 }
1069
1070 /**
1071 Destroy all attached ATA devices info.
1072
1073 @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance.
1074
1075 **/
1076 VOID
1077 EFIAPI
1078 DestroyDeviceInfoList (
1079 IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance
1080 )
1081 {
1082 EFI_ATA_DEVICE_INFO *DeviceInfo;
1083 LIST_ENTRY *Node;
1084
1085 Node = GetFirstNode (&Instance->DeviceList);
1086 while (!IsNull (&Instance->DeviceList, Node)) {
1087 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
1088
1089 Node = GetNextNode (&Instance->DeviceList, Node);
1090
1091 RemoveEntryList (&DeviceInfo->Link);
1092 if (DeviceInfo->IdentifyData != NULL) {
1093 FreePool (DeviceInfo->IdentifyData);
1094 }
1095 FreePool (DeviceInfo);
1096 }
1097 }
1098
1099 /**
1100 Destroy all pending non blocking tasks.
1101
1102 @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance.
1103 @param[in] IsSigEvent Indicate whether signal the task event when remove the
1104 task.
1105
1106 **/
1107 VOID
1108 EFIAPI
1109 DestroyAsynTaskList (
1110 IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance,
1111 IN BOOLEAN IsSigEvent
1112 )
1113 {
1114 LIST_ENTRY *Entry;
1115 LIST_ENTRY *DelEntry;
1116 ATA_NONBLOCK_TASK *Task;
1117 EFI_TPL OldTpl;
1118
1119 OldTpl = gBS->RaiseTPL (TPL_NOTIFY);
1120 if (!IsListEmpty (&Instance->NonBlockingTaskList)) {
1121 //
1122 // Free the Subtask list.
1123 //
1124 for (Entry = (&Instance->NonBlockingTaskList)->ForwardLink;
1125 Entry != (&Instance->NonBlockingTaskList);
1126 ) {
1127 DelEntry = Entry;
1128 Entry = Entry->ForwardLink;
1129 Task = ATA_NON_BLOCK_TASK_FROM_ENTRY (DelEntry);
1130
1131 RemoveEntryList (DelEntry);
1132 if (IsSigEvent) {
1133 Task->Packet->Asb->AtaStatus = 0x01;
1134 gBS->SignalEvent (Task->Event);
1135 }
1136 FreePool (Task);
1137 }
1138 }
1139 gBS->RestoreTPL (OldTpl);
1140 }
1141
1142 /**
1143 Enumerate all attached ATA devices at IDE mode or AHCI mode separately.
1144
1145 The function is designed to enumerate all attached ATA devices.
1146
1147 @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance.
1148
1149 @retval EFI_SUCCESS Successfully enumerate attached ATA devices.
1150 @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.
1151
1152 **/
1153 EFI_STATUS
1154 EFIAPI
1155 EnumerateAttachedDevice (
1156 IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance
1157 )
1158 {
1159 EFI_STATUS Status;
1160 PCI_TYPE00 PciData;
1161 UINT8 ClassCode;
1162
1163 Status = EFI_SUCCESS;
1164
1165 Status = Instance->PciIo->Pci.Read (
1166 Instance->PciIo,
1167 EfiPciIoWidthUint8,
1168 PCI_CLASSCODE_OFFSET,
1169 sizeof (PciData.Hdr.ClassCode),
1170 PciData.Hdr.ClassCode
1171 );
1172 ASSERT_EFI_ERROR (Status);
1173
1174 ClassCode = PciData.Hdr.ClassCode[1];
1175
1176 switch (ClassCode) {
1177 case PCI_CLASS_MASS_STORAGE_IDE :
1178 //
1179 // The ATA controller is working at IDE mode
1180 //
1181 Instance->Mode = EfiAtaIdeMode;
1182
1183 Status = IdeModeInitialization (Instance);
1184 if (EFI_ERROR (Status)) {
1185 Status = EFI_DEVICE_ERROR;
1186 goto Done;
1187 }
1188 break;
1189 case PCI_CLASS_MASS_STORAGE_SATADPA :
1190 //
1191 // The ATA controller is working at AHCI mode
1192 //
1193 Instance->Mode = EfiAtaAhciMode;
1194
1195 Status = AhciModeInitialization (Instance);
1196
1197 if (EFI_ERROR (Status)) {
1198 Status = EFI_DEVICE_ERROR;
1199 goto Done;
1200 }
1201
1202 break;
1203 default :
1204 Status = EFI_UNSUPPORTED;
1205 }
1206
1207 Done:
1208 return Status;
1209 }
1210
1211 /**
1212 Sends an ATA command to an ATA device that is attached to the ATA controller. This function
1213 supports both blocking I/O and non-blocking I/O. The blocking I/O functionality is required,
1214 and the non-blocking I/O functionality is optional.
1215
1216 @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
1217 @param[in] Port The port number of the ATA device to send the command.
1218 @param[in] PortMultiplierPort The port multiplier port number of the ATA device to send the command.
1219 If there is no port multiplier, then specify 0.
1220 @param[in, out] Packet A pointer to the ATA command to send to the ATA device specified by Port
1221 and PortMultiplierPort.
1222 @param[in] Event If non-blocking I/O is not supported then Event is ignored, and blocking
1223 I/O is performed. If Event is NULL, then blocking I/O is performed. If
1224 Event is not NULL and non blocking I/O is supported, then non-blocking
1225 I/O is performed, and Event will be signaled when the ATA command completes.
1226
1227 @retval EFI_SUCCESS The ATA command was sent by the host. For bi-directional commands,
1228 InTransferLength bytes were transferred from InDataBuffer. For write and
1229 bi-directional commands, OutTransferLength bytes were transferred by OutDataBuffer.
1230 @retval EFI_BAD_BUFFER_SIZE The ATA command was not executed. The number of bytes that could be transferred
1231 is returned in InTransferLength. For write and bi-directional commands,
1232 OutTransferLength bytes were transferred by OutDataBuffer.
1233 @retval EFI_NOT_READY The ATA command could not be sent because there are too many ATA commands
1234 already queued. The caller may retry again later.
1235 @retval EFI_DEVICE_ERROR A device error occurred while attempting to send the ATA command.
1236 @retval EFI_INVALID_PARAMETER Port, PortMultiplierPort, or the contents of Acb are invalid. The ATA
1237 command was not sent, so no additional status information is available.
1238
1239 **/
1240 EFI_STATUS
1241 EFIAPI
1242 AtaPassThruPassThru (
1243 IN EFI_ATA_PASS_THRU_PROTOCOL *This,
1244 IN UINT16 Port,
1245 IN UINT16 PortMultiplierPort,
1246 IN OUT EFI_ATA_PASS_THRU_COMMAND_PACKET *Packet,
1247 IN EFI_EVENT Event OPTIONAL
1248 )
1249 {
1250 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
1251 LIST_ENTRY *Node;
1252 EFI_ATA_DEVICE_INFO *DeviceInfo;
1253 EFI_IDENTIFY_DATA *IdentifyData;
1254 UINT64 Capacity;
1255 UINT32 MaxSectorCount;
1256 ATA_NONBLOCK_TASK *Task;
1257 EFI_TPL OldTpl;
1258
1259 Instance = ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
1260
1261 if ((This->Mode->IoAlign > 1) && !IS_ALIGNED(Packet->InDataBuffer, This->Mode->IoAlign)) {
1262 return EFI_INVALID_PARAMETER;
1263 }
1264
1265 if ((This->Mode->IoAlign > 1) && !IS_ALIGNED(Packet->OutDataBuffer, This->Mode->IoAlign)) {
1266 return EFI_INVALID_PARAMETER;
1267 }
1268
1269 if ((This->Mode->IoAlign > 1) && !IS_ALIGNED(Packet->Asb, This->Mode->IoAlign)) {
1270 return EFI_INVALID_PARAMETER;
1271 }
1272
1273 Node = SearchDeviceInfoList (Instance, Port, PortMultiplierPort, EfiIdeHarddisk);
1274
1275 if (Node == NULL) {
1276 Node = SearchDeviceInfoList(Instance, Port, PortMultiplierPort, EfiIdeCdrom);
1277 if (Node == NULL) {
1278 return EFI_INVALID_PARAMETER;
1279 }
1280 }
1281
1282 //
1283 // convert the transfer length from sector count to byte.
1284 //
1285 if (((Packet->Length & EFI_ATA_PASS_THRU_LENGTH_BYTES) == 0) &&
1286 (Packet->InTransferLength != 0)) {
1287 Packet->InTransferLength = Packet->InTransferLength * 0x200;
1288 }
1289
1290 //
1291 // convert the transfer length from sector count to byte.
1292 //
1293 if (((Packet->Length & EFI_ATA_PASS_THRU_LENGTH_BYTES) == 0) &&
1294 (Packet->OutTransferLength != 0)) {
1295 Packet->OutTransferLength = Packet->OutTransferLength * 0x200;
1296 }
1297
1298 //
1299 // Check whether this device needs 48-bit addressing (ATAPI-6 ata device).
1300 // Per ATA-6 spec, word83: bit15 is zero and bit14 is one.
1301 // If bit10 is one, it means the ata device support 48-bit addressing.
1302 //
1303 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
1304 IdentifyData = DeviceInfo->IdentifyData;
1305 MaxSectorCount = 0x100;
1306 if ((IdentifyData->AtaData.command_set_supported_83 & (BIT10 | BIT15 | BIT14)) == 0x4400) {
1307 Capacity = *((UINT64 *)IdentifyData->AtaData.maximum_lba_for_48bit_addressing);
1308 if (Capacity > 0xFFFFFFF) {
1309 //
1310 // Capacity exceeds 120GB. 48-bit addressing is really needed
1311 // In this case, the max sector count is 0x10000
1312 //
1313 MaxSectorCount = 0x10000;
1314 }
1315 }
1316
1317 //
1318 // If the data buffer described by InDataBuffer/OutDataBuffer and InTransferLength/OutTransferLength
1319 // is too big to be transferred in a single command, then no data is transferred and EFI_BAD_BUFFER_SIZE
1320 // is returned.
1321 //
1322 if (((Packet->InTransferLength != 0) && (Packet->InTransferLength > MaxSectorCount * 0x200)) ||
1323 ((Packet->OutTransferLength != 0) && (Packet->OutTransferLength > MaxSectorCount * 0x200))) {
1324 return EFI_BAD_BUFFER_SIZE;
1325 }
1326
1327 //
1328 // For non-blocking mode, queue the Task into the list.
1329 //
1330 if (Event != NULL) {
1331 Task = AllocateZeroPool (sizeof (ATA_NONBLOCK_TASK));
1332 if (Task == NULL) {
1333 return EFI_OUT_OF_RESOURCES;
1334 }
1335
1336 Task->Signature = ATA_NONBLOCKING_TASK_SIGNATURE;
1337 Task->Port = Port;
1338 Task->PortMultiplier = PortMultiplierPort;
1339 Task->Packet = Packet;
1340 Task->Event = Event;
1341 Task->IsStart = FALSE;
1342 Task->RetryTimes = 0;
1343
1344 OldTpl = gBS->RaiseTPL (TPL_NOTIFY);
1345 InsertTailList (&Instance->NonBlockingTaskList, &Task->Link);
1346 gBS->RestoreTPL (OldTpl);
1347
1348 return EFI_SUCCESS;
1349 } else {
1350 return AtaPassThruPassThruExecute (
1351 Port,
1352 PortMultiplierPort,
1353 Packet,
1354 Instance,
1355 NULL
1356 );
1357 }
1358 }
1359
1360 /**
1361 Used to retrieve the list of legal port numbers for ATA devices on an ATA controller.
1362 These can either be the list of ports where ATA devices are actually present or the
1363 list of legal port numbers for the ATA controller. Regardless, the caller of this
1364 function must probe the port number returned to see if an ATA device is actually
1365 present at that location on the ATA controller.
1366
1367 The GetNextPort() function retrieves the port number on an ATA controller. If on input
1368 Port is 0xFFFF, then the port number of the first port on the ATA controller is returned
1369 in Port and EFI_SUCCESS is returned.
1370
1371 If Port is a port number that was returned on a previous call to GetNextPort(), then the
1372 port number of the next port on the ATA controller is returned in Port, and EFI_SUCCESS
1373 is returned. If Port is not 0xFFFF and Port was not returned on a previous call to
1374 GetNextPort(), then EFI_INVALID_PARAMETER is returned.
1375
1376 If Port is the port number of the last port on the ATA controller, then EFI_NOT_FOUND is
1377 returned.
1378
1379 @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
1380 @param[in, out] Port On input, a pointer to the port number on the ATA controller.
1381 On output, a pointer to the next port number on the ATA
1382 controller. An input value of 0xFFFF retrieves the first port
1383 number on the ATA controller.
1384
1385 @retval EFI_SUCCESS The next port number on the ATA controller was returned in Port.
1386 @retval EFI_NOT_FOUND There are no more ports on this ATA controller.
1387 @retval EFI_INVALID_PARAMETER Port is not 0xFFFF and Port was not returned on a previous call
1388 to GetNextPort().
1389
1390 **/
1391 EFI_STATUS
1392 EFIAPI
1393 AtaPassThruGetNextPort (
1394 IN EFI_ATA_PASS_THRU_PROTOCOL *This,
1395 IN OUT UINT16 *Port
1396 )
1397 {
1398 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
1399 LIST_ENTRY *Node;
1400 EFI_ATA_DEVICE_INFO *DeviceInfo;
1401
1402 Instance = ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
1403
1404 if (Port == NULL) {
1405 return EFI_INVALID_PARAMETER;
1406 }
1407
1408 if (*Port == 0xFFFF) {
1409 //
1410 // If the Port is all 0xFF's, start to traverse the device list from the beginning
1411 //
1412 Node = GetFirstNode (&Instance->DeviceList);
1413
1414 while (!IsNull (&Instance->DeviceList, Node)) {
1415 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
1416
1417 if (DeviceInfo->Type == EfiIdeHarddisk) {
1418 *Port = DeviceInfo->Port;
1419 goto Exit;
1420 }
1421
1422 Node = GetNextNode (&Instance->DeviceList, Node);
1423 }
1424
1425 return EFI_NOT_FOUND;
1426 } else if (*Port == Instance->PreviousPort) {
1427 Node = GetFirstNode (&Instance->DeviceList);
1428
1429 while (!IsNull (&Instance->DeviceList, Node)) {
1430 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
1431
1432 if ((DeviceInfo->Type == EfiIdeHarddisk) &&
1433 (DeviceInfo->Port > *Port)){
1434 *Port = DeviceInfo->Port;
1435 goto Exit;
1436 }
1437
1438 Node = GetNextNode (&Instance->DeviceList, Node);
1439 }
1440
1441 return EFI_NOT_FOUND;
1442 } else {
1443 //
1444 // Port is not equal to 0xFFFF and also not equal to previous return value
1445 //
1446 return EFI_INVALID_PARAMETER;
1447 }
1448
1449 Exit:
1450 //
1451 // Update the PreviousPort and PreviousPortMultiplier.
1452 //
1453 Instance->PreviousPort = *Port;
1454
1455 return EFI_SUCCESS;
1456 }
1457
1458 /**
1459 Used to retrieve the list of legal port multiplier port numbers for ATA devices on a port of an ATA
1460 controller. These can either be the list of port multiplier ports where ATA devices are actually
1461 present on port or the list of legal port multiplier ports on that port. Regardless, the caller of this
1462 function must probe the port number and port multiplier port number returned to see if an ATA
1463 device is actually present.
1464
1465 The GetNextDevice() function retrieves the port multiplier port number of an ATA device
1466 present on a port of an ATA controller.
1467
1468 If PortMultiplierPort points to a port multiplier port number value that was returned on a
1469 previous call to GetNextDevice(), then the port multiplier port number of the next ATA device
1470 on the port of the ATA controller is returned in PortMultiplierPort, and EFI_SUCCESS is
1471 returned.
1472
1473 If PortMultiplierPort points to 0xFFFF, then the port multiplier port number of the first
1474 ATA device on port of the ATA controller is returned in PortMultiplierPort and
1475 EFI_SUCCESS is returned.
1476
1477 If PortMultiplierPort is not 0xFFFF and the value pointed to by PortMultiplierPort
1478 was not returned on a previous call to GetNextDevice(), then EFI_INVALID_PARAMETER
1479 is returned.
1480
1481 If PortMultiplierPort is the port multiplier port number of the last ATA device on the port of
1482 the ATA controller, then EFI_NOT_FOUND is returned.
1483
1484 @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
1485 @param[in] Port The port number present on the ATA controller.
1486 @param[in, out] PortMultiplierPort On input, a pointer to the port multiplier port number of an
1487 ATA device present on the ATA controller.
1488 If on input a PortMultiplierPort of 0xFFFF is specified,
1489 then the port multiplier port number of the first ATA device
1490 is returned. On output, a pointer to the port multiplier port
1491 number of the next ATA device present on an ATA controller.
1492
1493 @retval EFI_SUCCESS The port multiplier port number of the next ATA device on the port
1494 of the ATA controller was returned in PortMultiplierPort.
1495 @retval EFI_NOT_FOUND There are no more ATA devices on this port of the ATA controller.
1496 @retval EFI_INVALID_PARAMETER PortMultiplierPort is not 0xFFFF, and PortMultiplierPort was not
1497 returned on a previous call to GetNextDevice().
1498
1499 **/
1500 EFI_STATUS
1501 EFIAPI
1502 AtaPassThruGetNextDevice (
1503 IN EFI_ATA_PASS_THRU_PROTOCOL *This,
1504 IN UINT16 Port,
1505 IN OUT UINT16 *PortMultiplierPort
1506 )
1507 {
1508 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
1509 LIST_ENTRY *Node;
1510 EFI_ATA_DEVICE_INFO *DeviceInfo;
1511
1512 Instance = ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
1513
1514 if (PortMultiplierPort == NULL) {
1515 return EFI_INVALID_PARAMETER;
1516 }
1517
1518 if (*PortMultiplierPort == 0xFFFF) {
1519 //
1520 // If the PortMultiplierPort is all 0xFF's, start to traverse the device list from the beginning
1521 //
1522 Node = GetFirstNode (&Instance->DeviceList);
1523
1524 while (!IsNull (&Instance->DeviceList, Node)) {
1525 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
1526
1527 if ((DeviceInfo->Type == EfiIdeHarddisk) &&
1528 (DeviceInfo->Port == Port)){
1529 *PortMultiplierPort = DeviceInfo->PortMultiplier;
1530 goto Exit;
1531 }
1532
1533 Node = GetNextNode (&Instance->DeviceList, Node);
1534 }
1535
1536 return EFI_NOT_FOUND;
1537 } else if (*PortMultiplierPort == Instance->PreviousPortMultiplier) {
1538 Node = GetFirstNode (&Instance->DeviceList);
1539
1540 while (!IsNull (&Instance->DeviceList, Node)) {
1541 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
1542
1543 if ((DeviceInfo->Type == EfiIdeHarddisk) &&
1544 (DeviceInfo->Port == Port) &&
1545 (DeviceInfo->PortMultiplier > *PortMultiplierPort)){
1546 *PortMultiplierPort = DeviceInfo->PortMultiplier;
1547 goto Exit;
1548 }
1549
1550 Node = GetNextNode (&Instance->DeviceList, Node);
1551 }
1552
1553 return EFI_NOT_FOUND;
1554 } else {
1555 //
1556 // PortMultiplierPort is not equal to 0xFFFF and also not equal to previous return value
1557 //
1558 return EFI_INVALID_PARAMETER;
1559 }
1560
1561 Exit:
1562 //
1563 // Update the PreviousPort and PreviousPortMultiplier.
1564 //
1565 Instance->PreviousPortMultiplier = *PortMultiplierPort;
1566
1567 return EFI_SUCCESS;
1568 }
1569
1570 /**
1571 Used to allocate and build a device path node for an ATA device on an ATA controller.
1572
1573 The BuildDevicePath() function allocates and builds a single device node for the ATA
1574 device specified by Port and PortMultiplierPort. If the ATA device specified by Port and
1575 PortMultiplierPort is not present on the ATA controller, then EFI_NOT_FOUND is returned.
1576 If DevicePath is NULL, then EFI_INVALID_PARAMETER is returned. If there are not enough
1577 resources to allocate the device path node, then EFI_OUT_OF_RESOURCES is returned.
1578
1579 Otherwise, DevicePath is allocated with the boot service AllocatePool(), the contents of
1580 DevicePath are initialized to describe the ATA device specified by Port and PortMultiplierPort,
1581 and EFI_SUCCESS is returned.
1582
1583 @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
1584 @param[in] Port Port specifies the port number of the ATA device for which a
1585 device path node is to be allocated and built.
1586 @param[in] PortMultiplierPort The port multiplier port number of the ATA device for which a
1587 device path node is to be allocated and built. If there is no
1588 port multiplier, then specify 0.
1589 @param[in, out] DevicePath A pointer to a single device path node that describes the ATA
1590 device specified by Port and PortMultiplierPort. This function
1591 is responsible for allocating the buffer DevicePath with the
1592 boot service AllocatePool(). It is the caller's responsibility
1593 to free DevicePath when the caller is finished with DevicePath.
1594 @retval EFI_SUCCESS The device path node that describes the ATA device specified by
1595 Port and PortMultiplierPort was allocated and returned in DevicePath.
1596 @retval EFI_NOT_FOUND The ATA device specified by Port and PortMultiplierPort does not
1597 exist on the ATA controller.
1598 @retval EFI_INVALID_PARAMETER DevicePath is NULL.
1599 @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate DevicePath.
1600
1601 **/
1602 EFI_STATUS
1603 EFIAPI
1604 AtaPassThruBuildDevicePath (
1605 IN EFI_ATA_PASS_THRU_PROTOCOL *This,
1606 IN UINT16 Port,
1607 IN UINT16 PortMultiplierPort,
1608 IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath
1609 )
1610 {
1611 EFI_DEV_PATH *DevicePathNode;
1612 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
1613 LIST_ENTRY *Node;
1614
1615 Instance = ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
1616
1617 //
1618 // Validate parameters passed in.
1619 //
1620 if (DevicePath == NULL) {
1621 return EFI_INVALID_PARAMETER;
1622 }
1623
1624 Node = SearchDeviceInfoList(Instance, Port, PortMultiplierPort, EfiIdeHarddisk);
1625 if (Node == NULL) {
1626 return EFI_NOT_FOUND;
1627 }
1628
1629 if (Instance->Mode == EfiAtaIdeMode) {
1630 DevicePathNode = AllocateCopyPool (sizeof (ATAPI_DEVICE_PATH), &mAtapiDevicePathTemplate);
1631 if (DevicePathNode == NULL) {
1632 return EFI_OUT_OF_RESOURCES;
1633 }
1634 DevicePathNode->Atapi.PrimarySecondary = (UINT8) Port;
1635 DevicePathNode->Atapi.SlaveMaster = (UINT8) PortMultiplierPort;
1636 DevicePathNode->Atapi.Lun = 0;
1637 } else {
1638 DevicePathNode = AllocateCopyPool (sizeof (SATA_DEVICE_PATH), &mSataDevicePathTemplate);
1639 if (DevicePathNode == NULL) {
1640 return EFI_OUT_OF_RESOURCES;
1641 }
1642
1643 DevicePathNode->Sata.HBAPortNumber = Port;
1644 DevicePathNode->Sata.PortMultiplierPortNumber = PortMultiplierPort;
1645 DevicePathNode->Sata.Lun = 0;
1646 }
1647
1648 *DevicePath = (EFI_DEVICE_PATH_PROTOCOL *) DevicePathNode;
1649
1650 return EFI_SUCCESS;
1651 }
1652
1653 /**
1654 Used to translate a device path node to a port number and port multiplier port number.
1655
1656 The GetDevice() function determines the port and port multiplier port number associated with
1657 the ATA device described by DevicePath. If DevicePath is a device path node type that the
1658 ATA Pass Thru driver supports, then the ATA Pass Thru driver will attempt to translate the contents
1659 DevicePath into a port number and port multiplier port number.
1660
1661 If this translation is successful, then that port number and port multiplier port number are returned
1662 in Port and PortMultiplierPort, and EFI_SUCCESS is returned.
1663
1664 If DevicePath, Port, or PortMultiplierPort are NULL, then EFI_INVALID_PARAMETER is returned.
1665
1666 If DevicePath is not a device path node type that the ATA Pass Thru driver supports, then
1667 EFI_UNSUPPORTED is returned.
1668
1669 If DevicePath is a device path node type that the ATA Pass Thru driver supports, but there is not
1670 a valid translation from DevicePath to a port number and port multiplier port number, then
1671 EFI_NOT_FOUND is returned.
1672
1673 @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
1674 @param[in] DevicePath A pointer to the device path node that describes an ATA device on the
1675 ATA controller.
1676 @param[out] Port On return, points to the port number of an ATA device on the ATA controller.
1677 @param[out] PortMultiplierPort On return, points to the port multiplier port number of an ATA device
1678 on the ATA controller.
1679
1680 @retval EFI_SUCCESS DevicePath was successfully translated to a port number and port multiplier
1681 port number, and they were returned in Port and PortMultiplierPort.
1682 @retval EFI_INVALID_PARAMETER DevicePath is NULL.
1683 @retval EFI_INVALID_PARAMETER Port is NULL.
1684 @retval EFI_INVALID_PARAMETER PortMultiplierPort is NULL.
1685 @retval EFI_UNSUPPORTED This driver does not support the device path node type in DevicePath.
1686 @retval EFI_NOT_FOUND A valid translation from DevicePath to a port number and port multiplier
1687 port number does not exist.
1688 **/
1689 EFI_STATUS
1690 EFIAPI
1691 AtaPassThruGetDevice (
1692 IN EFI_ATA_PASS_THRU_PROTOCOL *This,
1693 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,
1694 OUT UINT16 *Port,
1695 OUT UINT16 *PortMultiplierPort
1696 )
1697 {
1698 EFI_DEV_PATH *DevicePathNode;
1699 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
1700 LIST_ENTRY *Node;
1701
1702 Instance = ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
1703
1704 //
1705 // Validate parameters passed in.
1706 //
1707 if (DevicePath == NULL || Port == NULL || PortMultiplierPort == NULL) {
1708 return EFI_INVALID_PARAMETER;
1709 }
1710
1711 //
1712 // Check whether the DevicePath belongs to SCSI_DEVICE_PATH or ATAPI_DEVICE_PATH
1713 //
1714 if ((DevicePath->Type != MESSAGING_DEVICE_PATH) ||
1715 ((DevicePath->SubType != MSG_SATA_DP) &&
1716 (DevicePath->SubType != MSG_ATAPI_DP)) ||
1717 ((DevicePathNodeLength(DevicePath) != sizeof(ATAPI_DEVICE_PATH)) &&
1718 (DevicePathNodeLength(DevicePath) != sizeof(SATA_DEVICE_PATH)))) {
1719 return EFI_UNSUPPORTED;
1720 }
1721
1722 DevicePathNode = (EFI_DEV_PATH *) DevicePath;
1723
1724 if (Instance->Mode == EfiAtaIdeMode) {
1725 *Port = DevicePathNode->Atapi.PrimarySecondary;
1726 *PortMultiplierPort = DevicePathNode->Atapi.SlaveMaster;
1727 } else {
1728 *Port = DevicePathNode->Sata.HBAPortNumber;
1729 *PortMultiplierPort = DevicePathNode->Sata.PortMultiplierPortNumber;
1730 }
1731
1732 Node = SearchDeviceInfoList(Instance, *Port, *PortMultiplierPort, EfiIdeHarddisk);
1733
1734 if (Node == NULL) {
1735 return EFI_NOT_FOUND;
1736 }
1737
1738 return EFI_SUCCESS;
1739 }
1740
1741 /**
1742 Resets a specific port on the ATA controller. This operation also resets all the ATA devices
1743 connected to the port.
1744
1745 The ResetChannel() function resets an a specific port on an ATA controller. This operation
1746 resets all the ATA devices connected to that port. If this ATA controller does not support
1747 a reset port operation, then EFI_UNSUPPORTED is returned.
1748
1749 If a device error occurs while executing that port reset operation, then EFI_DEVICE_ERROR is
1750 returned.
1751
1752 If a timeout occurs during the execution of the port reset operation, then EFI_TIMEOUT is returned.
1753
1754 If the port reset operation is completed, then EFI_SUCCESS is returned.
1755
1756 @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
1757 @param[in] Port The port number on the ATA controller.
1758
1759 @retval EFI_SUCCESS The ATA controller port was reset.
1760 @retval EFI_UNSUPPORTED The ATA controller does not support a port reset operation.
1761 @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the ATA port.
1762 @retval EFI_TIMEOUT A timeout occurred while attempting to reset the ATA port.
1763
1764 **/
1765 EFI_STATUS
1766 EFIAPI
1767 AtaPassThruResetPort (
1768 IN EFI_ATA_PASS_THRU_PROTOCOL *This,
1769 IN UINT16 Port
1770 )
1771 {
1772 //
1773 // Return success directly then upper layer driver could think reset port operation is done.
1774 //
1775 return EFI_SUCCESS;
1776 }
1777
1778 /**
1779 Resets an ATA device that is connected to an ATA controller.
1780
1781 The ResetDevice() function resets the ATA device specified by Port and PortMultiplierPort.
1782 If this ATA controller does not support a device reset operation, then EFI_UNSUPPORTED is
1783 returned.
1784
1785 If Port or PortMultiplierPort are not in a valid range for this ATA controller, then
1786 EFI_INVALID_PARAMETER is returned.
1787
1788 If a device error occurs while executing that device reset operation, then EFI_DEVICE_ERROR
1789 is returned.
1790
1791 If a timeout occurs during the execution of the device reset operation, then EFI_TIMEOUT is
1792 returned.
1793
1794 If the device reset operation is completed, then EFI_SUCCESS is returned.
1795
1796 @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
1797 @param[in] Port Port represents the port number of the ATA device to be reset.
1798 @param[in] PortMultiplierPort The port multiplier port number of the ATA device to reset.
1799 If there is no port multiplier, then specify 0.
1800 @retval EFI_SUCCESS The ATA device specified by Port and PortMultiplierPort was reset.
1801 @retval EFI_UNSUPPORTED The ATA controller does not support a device reset operation.
1802 @retval EFI_INVALID_PARAMETER Port or PortMultiplierPort are invalid.
1803 @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the ATA device
1804 specified by Port and PortMultiplierPort.
1805 @retval EFI_TIMEOUT A timeout occurred while attempting to reset the ATA device
1806 specified by Port and PortMultiplierPort.
1807
1808 **/
1809 EFI_STATUS
1810 EFIAPI
1811 AtaPassThruResetDevice (
1812 IN EFI_ATA_PASS_THRU_PROTOCOL *This,
1813 IN UINT16 Port,
1814 IN UINT16 PortMultiplierPort
1815 )
1816 {
1817 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
1818 LIST_ENTRY *Node;
1819
1820 Instance = ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
1821
1822 Node = SearchDeviceInfoList (Instance, Port, PortMultiplierPort, EfiIdeHarddisk);
1823
1824 if (Node == NULL) {
1825 return EFI_INVALID_PARAMETER;
1826 }
1827
1828 //
1829 // Return success directly then upper layer driver could think reset device operation is done.
1830 //
1831 return EFI_SUCCESS;
1832 }
1833
1834 /**
1835 Sumbit ATAPI request sense command.
1836
1837 @param[in] This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
1838 @param[in] Target The Target is an array of size TARGET_MAX_BYTES and it represents
1839 the id of the SCSI device to send the SCSI Request Packet. Each
1840 transport driver may choose to utilize a subset of this size to suit the needs
1841 of transport target representation. For example, a Fibre Channel driver
1842 may use only 8 bytes (WWN) to represent an FC target.
1843 @param[in] Lun The LUN of the SCSI device to send the SCSI Request Packet.
1844 @param[in] SenseData A pointer to store sense data.
1845 @param[in] SenseDataLength The sense data length.
1846 @param[in] Timeout The timeout value to execute this cmd, uses 100ns as a unit.
1847
1848 @retval EFI_SUCCESS Send out the ATAPI packet command successfully.
1849 @retval EFI_DEVICE_ERROR The device failed to send data.
1850
1851 **/
1852 EFI_STATUS
1853 EFIAPI
1854 AtaPacketRequestSense (
1855 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,
1856 IN UINT8 *Target,
1857 IN UINT64 Lun,
1858 IN VOID *SenseData,
1859 IN UINT8 SenseDataLength,
1860 IN UINT64 Timeout
1861 )
1862 {
1863 EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET Packet;
1864 UINT8 Cdb[12];
1865 EFI_STATUS Status;
1866
1867 ZeroMem (&Packet, sizeof (EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET));
1868 ZeroMem (Cdb, 12);
1869
1870 Cdb[0] = ATA_CMD_REQUEST_SENSE;
1871 Cdb[4] = SenseDataLength;
1872
1873 Packet.Timeout = Timeout;
1874 Packet.Cdb = Cdb;
1875 Packet.CdbLength = 12;
1876 Packet.DataDirection = EFI_EXT_SCSI_DATA_DIRECTION_READ;
1877 Packet.InDataBuffer = SenseData;
1878 Packet.InTransferLength = SenseDataLength;
1879
1880 Status = ExtScsiPassThruPassThru (This, Target, Lun, &Packet, NULL);
1881
1882 return Status;
1883 }
1884
1885 /**
1886 Sends a SCSI Request Packet to a SCSI device that is attached to the SCSI channel. This function
1887 supports both blocking I/O and nonblocking I/O. The blocking I/O functionality is required, and the
1888 nonblocking I/O functionality is optional.
1889
1890 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
1891 @param Target The Target is an array of size TARGET_MAX_BYTES and it represents
1892 the id of the SCSI device to send the SCSI Request Packet. Each
1893 transport driver may choose to utilize a subset of this size to suit the needs
1894 of transport target representation. For example, a Fibre Channel driver
1895 may use only 8 bytes (WWN) to represent an FC target.
1896 @param Lun The LUN of the SCSI device to send the SCSI Request Packet.
1897 @param Packet A pointer to the SCSI Request Packet to send to the SCSI device
1898 specified by Target and Lun.
1899 @param Event If nonblocking I/O is not supported then Event is ignored, and blocking
1900 I/O is performed. If Event is NULL, then blocking I/O is performed. If
1901 Event is not NULL and non blocking I/O is supported, then
1902 nonblocking I/O is performed, and Event will be signaled when the
1903 SCSI Request Packet completes.
1904
1905 @retval EFI_SUCCESS The SCSI Request Packet was sent by the host. For bi-directional
1906 commands, InTransferLength bytes were transferred from
1907 InDataBuffer. For write and bi-directional commands,
1908 OutTransferLength bytes were transferred by
1909 OutDataBuffer.
1910 @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was not executed. The number of bytes that
1911 could be transferred is returned in InTransferLength. For write
1912 and bi-directional commands, OutTransferLength bytes were
1913 transferred by OutDataBuffer.
1914 @retval EFI_NOT_READY The SCSI Request Packet could not be sent because there are too many
1915 SCSI Request Packets already queued. The caller may retry again later.
1916 @retval EFI_DEVICE_ERROR A device error occurred while attempting to send the SCSI Request
1917 Packet.
1918 @retval EFI_INVALID_PARAMETER Target, Lun, or the contents of ScsiRequestPacket are invalid.
1919 @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported
1920 by the host adapter. This includes the case of Bi-directional SCSI
1921 commands not supported by the implementation. The SCSI Request
1922 Packet was not sent, so no additional status information is available.
1923 @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
1924
1925 **/
1926 EFI_STATUS
1927 EFIAPI
1928 ExtScsiPassThruPassThru (
1929 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,
1930 IN UINT8 *Target,
1931 IN UINT64 Lun,
1932 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet,
1933 IN EFI_EVENT Event OPTIONAL
1934 )
1935 {
1936 EFI_STATUS Status;
1937 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
1938 UINT8 Port;
1939 UINT8 PortMultiplier;
1940 EFI_ATA_HC_WORK_MODE Mode;
1941 LIST_ENTRY *Node;
1942 EFI_ATA_DEVICE_INFO *DeviceInfo;
1943 BOOLEAN SenseReq;
1944 EFI_SCSI_SENSE_DATA *PtrSenseData;
1945 UINTN SenseDataLen;
1946 EFI_STATUS SenseStatus;
1947
1948 SenseDataLen = 0;
1949 Instance = EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
1950
1951 if ((Packet == NULL) || (Packet->Cdb == NULL)) {
1952 return EFI_INVALID_PARAMETER;
1953 }
1954
1955 //
1956 // Don't support variable length CDB
1957 //
1958 if ((Packet->CdbLength != 6) && (Packet->CdbLength != 10) &&
1959 (Packet->CdbLength != 12) && (Packet->CdbLength != 16)) {
1960 return EFI_INVALID_PARAMETER;
1961 }
1962
1963 if ((Packet->SenseDataLength != 0) && (Packet->SenseData == NULL)) {
1964 return EFI_INVALID_PARAMETER;
1965 }
1966
1967 if ((This->Mode->IoAlign > 1) && !IS_ALIGNED(Packet->InDataBuffer, This->Mode->IoAlign)) {
1968 return EFI_INVALID_PARAMETER;
1969 }
1970
1971 if ((This->Mode->IoAlign > 1) && !IS_ALIGNED(Packet->OutDataBuffer, This->Mode->IoAlign)) {
1972 return EFI_INVALID_PARAMETER;
1973 }
1974
1975 if ((This->Mode->IoAlign > 1) && !IS_ALIGNED(Packet->SenseData, This->Mode->IoAlign)) {
1976 return EFI_INVALID_PARAMETER;
1977 }
1978
1979 //
1980 // For ATAPI device, doesn't support multiple LUN device.
1981 //
1982 if (Lun != 0) {
1983 return EFI_INVALID_PARAMETER;
1984 }
1985
1986 //
1987 // The layout of Target array:
1988 // ________________________________________________________________________
1989 // | Byte 0 | Byte 1 | ... | TARGET_MAX_BYTES - 1 |
1990 // |_____________________|_____________________|_____|______________________|
1991 // | | The port multiplier | | |
1992 // | The port number | port number | N/A | N/A |
1993 // |_____________________|_____________________|_____|______________________|
1994 //
1995 // For ATAPI device, 2 bytes is enough to represent the location of SCSI device.
1996 //
1997 Port = Target[0];
1998 PortMultiplier = Target[1];
1999
2000 Node = SearchDeviceInfoList(Instance, Port, PortMultiplier, EfiIdeCdrom);
2001 if (Node == NULL) {
2002 return EFI_INVALID_PARAMETER;
2003 }
2004
2005 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
2006
2007 //
2008 // ATA_CMD_IDENTIFY_DEVICE cmd is a ATA cmd but not a SCSI cmd.
2009 // Normally it should NOT be passed down through ExtScsiPassThru protocol interface.
2010 // But to response EFI_DISK_INFO.Identify() request from ScsiDisk, we should handle this command.
2011 //
2012 if (*((UINT8*)Packet->Cdb) == ATA_CMD_IDENTIFY_DEVICE) {
2013 CopyMem (Packet->InDataBuffer, DeviceInfo->IdentifyData, sizeof (EFI_IDENTIFY_DATA));
2014 //
2015 // For IDENTIFY DEVICE cmd, we don't need to get sense data.
2016 //
2017 Packet->SenseDataLength = 0;
2018 return EFI_SUCCESS;
2019 }
2020
2021 Mode = Instance->Mode;
2022 switch (Mode) {
2023 case EfiAtaIdeMode:
2024 //
2025 // Reassign IDE mode io port registers' base addresses
2026 //
2027 Status = GetIdeRegisterIoAddr (Instance->PciIo, Instance->IdeRegisters);
2028
2029 if (EFI_ERROR (Status)) {
2030 return Status;
2031 }
2032
2033 Status = AtaPacketCommandExecute (Instance->PciIo, &Instance->IdeRegisters[Port], Port, PortMultiplier, Packet);
2034 break;
2035 case EfiAtaAhciMode:
2036 Status = AhciPacketCommandExecute (Instance->PciIo, &Instance->AhciRegisters, Port, PortMultiplier, Packet);
2037 break;
2038 default :
2039 Status = EFI_DEVICE_ERROR;
2040 break;
2041 }
2042
2043 //
2044 // If the cmd doesn't get executed correctly, then check sense data.
2045 //
2046 if (EFI_ERROR (Status) && (Packet->SenseDataLength != 0) && (*((UINT8*)Packet->Cdb) != ATA_CMD_REQUEST_SENSE)) {
2047 PtrSenseData = AllocateAlignedPages (EFI_SIZE_TO_PAGES (sizeof (EFI_SCSI_SENSE_DATA)), This->Mode->IoAlign);
2048 if (PtrSenseData == NULL) {
2049 return EFI_DEVICE_ERROR;
2050 }
2051
2052 for (SenseReq = TRUE; SenseReq;) {
2053 SenseStatus = AtaPacketRequestSense (
2054 This,
2055 Target,
2056 Lun,
2057 PtrSenseData,
2058 sizeof (EFI_SCSI_SENSE_DATA),
2059 Packet->Timeout
2060 );
2061 if (EFI_ERROR (SenseStatus)) {
2062 break;
2063 }
2064
2065 CopyMem ((UINT8*)Packet->SenseData + SenseDataLen, PtrSenseData, sizeof (EFI_SCSI_SENSE_DATA));
2066 SenseDataLen += sizeof (EFI_SCSI_SENSE_DATA);
2067
2068 //
2069 // no more sense key or number of sense keys exceeds predefined,
2070 // skip the loop.
2071 //
2072 if ((PtrSenseData->Sense_Key == EFI_SCSI_SK_NO_SENSE) ||
2073 (SenseDataLen + sizeof (EFI_SCSI_SENSE_DATA) > Packet->SenseDataLength)) {
2074 SenseReq = FALSE;
2075 }
2076 }
2077 FreeAlignedPages (PtrSenseData, EFI_SIZE_TO_PAGES (sizeof (EFI_SCSI_SENSE_DATA)));
2078 }
2079 //
2080 // Update the SenseDataLength field to the data length received.
2081 //
2082 Packet->SenseDataLength = (UINT8)SenseDataLen;
2083 return Status;
2084 }
2085
2086 /**
2087 Used to retrieve the list of legal Target IDs and LUNs for SCSI devices on a SCSI channel. These
2088 can either be the list SCSI devices that are actually present on the SCSI channel, or the list of legal
2089 Target Ids and LUNs for the SCSI channel. Regardless, the caller of this function must probe the
2090 Target ID and LUN returned to see if a SCSI device is actually present at that location on the SCSI
2091 channel.
2092
2093 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
2094 @param Target On input, a pointer to the Target ID (an array of size
2095 TARGET_MAX_BYTES) of a SCSI device present on the SCSI channel.
2096 On output, a pointer to the Target ID (an array of
2097 TARGET_MAX_BYTES) of the next SCSI device present on a SCSI
2098 channel. An input value of 0xF(all bytes in the array are 0xF) in the
2099 Target array retrieves the Target ID of the first SCSI device present on a
2100 SCSI channel.
2101 @param Lun On input, a pointer to the LUN of a SCSI device present on the SCSI
2102 channel. On output, a pointer to the LUN of the next SCSI device present
2103 on a SCSI channel.
2104
2105 @retval EFI_SUCCESS The Target ID and LUN of the next SCSI device on the SCSI
2106 channel was returned in Target and Lun.
2107 @retval EFI_INVALID_PARAMETER Target array is not all 0xF, and Target and Lun were
2108 not returned on a previous call to GetNextTargetLun().
2109 @retval EFI_NOT_FOUND There are no more SCSI devices on this SCSI channel.
2110
2111 **/
2112 EFI_STATUS
2113 EFIAPI
2114 ExtScsiPassThruGetNextTargetLun (
2115 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,
2116 IN OUT UINT8 **Target,
2117 IN OUT UINT64 *Lun
2118 )
2119 {
2120 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
2121 LIST_ENTRY *Node;
2122 EFI_ATA_DEVICE_INFO *DeviceInfo;
2123 UINT8 *Target8;
2124 UINT16 *Target16;
2125
2126 Instance = EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
2127
2128 if (Target == NULL || Lun == NULL) {
2129 return EFI_INVALID_PARAMETER;
2130 }
2131
2132 if (*Target == NULL) {
2133 return EFI_INVALID_PARAMETER;
2134 }
2135
2136 Target8 = *Target;
2137 Target16 = (UINT16 *)*Target;
2138
2139 if (CompareMem(Target8, mScsiId, TARGET_MAX_BYTES) != 0) {
2140 //
2141 // For ATAPI device, we use 2 least significant bytes to represent the location of SCSI device.
2142 // So the higher bytes in Target array should be 0xFF.
2143 //
2144 if (CompareMem (&Target8[2], &mScsiId[2], TARGET_MAX_BYTES - 2) != 0) {
2145 return EFI_INVALID_PARAMETER;
2146 }
2147
2148 //
2149 // When Target is not all 0xFF's, compare 2 least significant bytes with
2150 // previous target id to see if it is returned by previous call.
2151 //
2152 if ((*Target16 != Instance->PreviousTargetId) ||
2153 (*Lun != Instance->PreviousLun)) {
2154 return EFI_INVALID_PARAMETER;
2155 }
2156
2157 //
2158 // Traverse the whole device list to find the next cdrom closed to
2159 // the device signified by Target[0] and Target[1].
2160 //
2161 // Note that we here use a tricky way to find the next cdrom :
2162 // All ata devices are detected and inserted into the device list
2163 // sequentially.
2164 //
2165 Node = GetFirstNode (&Instance->DeviceList);
2166
2167 while (!IsNull (&Instance->DeviceList, Node)) {
2168 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
2169
2170 if ((DeviceInfo->Type == EfiIdeCdrom) &&
2171 ((Target8[0] < DeviceInfo->Port) ||
2172 ((Target8[0] == DeviceInfo->Port) &&
2173 (Target8[1] < DeviceInfo->PortMultiplier)))) {
2174 Target8[0] = (UINT8)DeviceInfo->Port;
2175 Target8[1] = (UINT8)DeviceInfo->PortMultiplier;
2176 goto Exit;
2177 }
2178
2179 Node = GetNextNode (&Instance->DeviceList, Node);
2180 }
2181
2182 return EFI_NOT_FOUND;
2183 } else {
2184 //
2185 // If the array is all 0xFF's, start to traverse the device list from the beginning
2186 //
2187 Node = GetFirstNode (&Instance->DeviceList);
2188 while (!IsNull (&Instance->DeviceList, Node)) {
2189 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
2190
2191 if (DeviceInfo->Type == EfiIdeCdrom) {
2192 Target8[0] = (UINT8)DeviceInfo->Port;
2193 Target8[1] = (UINT8)DeviceInfo->PortMultiplier;
2194 goto Exit;
2195 }
2196
2197 Node = GetNextNode (&Instance->DeviceList, Node);
2198 }
2199
2200 return EFI_NOT_FOUND;
2201 }
2202
2203 Exit:
2204 *Lun = 0;
2205
2206 //
2207 // Update the PreviousTargetId.
2208 //
2209 Instance->PreviousTargetId = *Target16;
2210 Instance->PreviousLun = *Lun;
2211
2212 return EFI_SUCCESS;
2213 }
2214
2215 /**
2216 Used to allocate and build a device path node for a SCSI device on a SCSI channel.
2217
2218 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
2219 @param Target The Target is an array of size TARGET_MAX_BYTES and it specifies the
2220 Target ID of the SCSI device for which a device path node is to be
2221 allocated and built. Transport drivers may chose to utilize a subset of
2222 this size to suit the representation of targets. For example, a Fibre
2223 Channel driver may use only 8 bytes (WWN) in the array to represent a
2224 FC target.
2225 @param Lun The LUN of the SCSI device for which a device path node is to be
2226 allocated and built.
2227 @param DevicePath A pointer to a single device path node that describes the SCSI device
2228 specified by Target and Lun. This function is responsible for
2229 allocating the buffer DevicePath with the boot service
2230 AllocatePool(). It is the caller's responsibility to free
2231 DevicePath when the caller is finished with DevicePath.
2232
2233 @retval EFI_SUCCESS The device path node that describes the SCSI device specified by
2234 Target and Lun was allocated and returned in
2235 DevicePath.
2236 @retval EFI_INVALID_PARAMETER DevicePath is NULL.
2237 @retval EFI_NOT_FOUND The SCSI devices specified by Target and Lun does not exist
2238 on the SCSI channel.
2239 @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate DevicePath.
2240
2241 **/
2242 EFI_STATUS
2243 EFIAPI
2244 ExtScsiPassThruBuildDevicePath (
2245 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,
2246 IN UINT8 *Target,
2247 IN UINT64 Lun,
2248 IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath
2249 )
2250 {
2251 EFI_DEV_PATH *DevicePathNode;
2252 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
2253 UINT8 Port;
2254 UINT8 PortMultiplier;
2255
2256 Instance = EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
2257
2258 Port = Target[0];
2259 PortMultiplier = Target[1];
2260
2261 //
2262 // Validate parameters passed in.
2263 //
2264 if (DevicePath == NULL) {
2265 return EFI_INVALID_PARAMETER;
2266 }
2267
2268 //
2269 // can not build device path for the SCSI Host Controller.
2270 //
2271 if (Lun != 0) {
2272 return EFI_NOT_FOUND;
2273 }
2274
2275 if (SearchDeviceInfoList(Instance, Port, PortMultiplier, EfiIdeCdrom) == NULL) {
2276 return EFI_NOT_FOUND;
2277 }
2278
2279 if (Instance->Mode == EfiAtaIdeMode) {
2280 DevicePathNode = AllocateCopyPool (sizeof (ATAPI_DEVICE_PATH), &mAtapiDevicePathTemplate);
2281 if (DevicePathNode == NULL) {
2282 return EFI_OUT_OF_RESOURCES;
2283 }
2284
2285 DevicePathNode->Atapi.PrimarySecondary = Port;
2286 DevicePathNode->Atapi.SlaveMaster = PortMultiplier;
2287 DevicePathNode->Atapi.Lun = (UINT16) Lun;
2288 } else {
2289 DevicePathNode = AllocateCopyPool (sizeof (SATA_DEVICE_PATH), &mSataDevicePathTemplate);
2290 if (DevicePathNode == NULL) {
2291 return EFI_OUT_OF_RESOURCES;
2292 }
2293
2294 DevicePathNode->Sata.HBAPortNumber = Port;
2295 DevicePathNode->Sata.PortMultiplierPortNumber = PortMultiplier;
2296 DevicePathNode->Sata.Lun = (UINT16) Lun;
2297 }
2298
2299 *DevicePath = (EFI_DEVICE_PATH_PROTOCOL *) DevicePathNode;
2300
2301 return EFI_SUCCESS;
2302 }
2303
2304 /**
2305 Used to translate a device path node to a Target ID and LUN.
2306
2307 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
2308 @param DevicePath A pointer to a single device path node that describes the SCSI device
2309 on the SCSI channel.
2310 @param Target A pointer to the Target Array which represents the ID of a SCSI device
2311 on the SCSI channel.
2312 @param Lun A pointer to the LUN of a SCSI device on the SCSI channel.
2313
2314 @retval EFI_SUCCESS DevicePath was successfully translated to a Target ID and
2315 LUN, and they were returned in Target and Lun.
2316 @retval EFI_INVALID_PARAMETER DevicePath or Target or Lun is NULL.
2317 @retval EFI_NOT_FOUND A valid translation from DevicePath to a Target ID and LUN
2318 does not exist.
2319 @retval EFI_UNSUPPORTED This driver does not support the device path node type in
2320 DevicePath.
2321
2322 **/
2323 EFI_STATUS
2324 EFIAPI
2325 ExtScsiPassThruGetTargetLun (
2326 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,
2327 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,
2328 OUT UINT8 **Target,
2329 OUT UINT64 *Lun
2330 )
2331 {
2332 EFI_DEV_PATH *DevicePathNode;
2333 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
2334 LIST_ENTRY *Node;
2335
2336 Instance = EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
2337
2338 //
2339 // Validate parameters passed in.
2340 //
2341 if (DevicePath == NULL || Target == NULL || Lun == NULL) {
2342 return EFI_INVALID_PARAMETER;
2343 }
2344
2345 if (*Target == NULL) {
2346 return EFI_INVALID_PARAMETER;
2347 }
2348 //
2349 // Check whether the DevicePath belongs to SCSI_DEVICE_PATH
2350 //
2351 if ((DevicePath->Type != MESSAGING_DEVICE_PATH) ||
2352 ((DevicePath->SubType != MSG_ATAPI_DP) &&
2353 (DevicePath->SubType != MSG_SATA_DP)) ||
2354 ((DevicePathNodeLength(DevicePath) != sizeof(ATAPI_DEVICE_PATH)) &&
2355 (DevicePathNodeLength(DevicePath) != sizeof(SATA_DEVICE_PATH)))) {
2356 return EFI_UNSUPPORTED;
2357 }
2358
2359 SetMem (*Target, TARGET_MAX_BYTES, 0xFF);
2360
2361 DevicePathNode = (EFI_DEV_PATH *) DevicePath;
2362
2363 if (Instance->Mode == EfiAtaIdeMode) {
2364 (*Target)[0] = (UINT8) DevicePathNode->Atapi.PrimarySecondary;
2365 (*Target)[1] = (UINT8) DevicePathNode->Atapi.SlaveMaster;
2366 *Lun = (UINT8) DevicePathNode->Atapi.Lun;
2367 } else {
2368 (*Target)[0] = (UINT8) DevicePathNode->Sata.HBAPortNumber;
2369 (*Target)[1] = (UINT8) DevicePathNode->Sata.PortMultiplierPortNumber;
2370 *Lun = (UINT8) DevicePathNode->Sata.Lun;
2371 }
2372
2373 Node = SearchDeviceInfoList(Instance, (*Target)[0], (*Target)[1], EfiIdeCdrom);
2374
2375 if (Node == NULL) {
2376 return EFI_NOT_FOUND;
2377 }
2378
2379 if (*Lun != 0) {
2380 return EFI_NOT_FOUND;
2381 }
2382
2383 return EFI_SUCCESS;
2384 }
2385
2386 /**
2387 Resets a SCSI channel. This operation resets all the SCSI devices connected to the SCSI channel.
2388
2389 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
2390
2391 @retval EFI_SUCCESS The SCSI channel was reset.
2392 @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the SCSI channel.
2393 @retval EFI_TIMEOUT A timeout occurred while attempting to reset the SCSI channel.
2394 @retval EFI_UNSUPPORTED The SCSI channel does not support a channel reset operation.
2395
2396 **/
2397 EFI_STATUS
2398 EFIAPI
2399 ExtScsiPassThruResetChannel (
2400 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This
2401 )
2402 {
2403 //
2404 // Return success directly then upper layer driver could think reset channel operation is done.
2405 //
2406 return EFI_SUCCESS;
2407 }
2408
2409 /**
2410 Resets a SCSI logical unit that is connected to a SCSI channel.
2411
2412 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
2413 @param Target The Target is an array of size TARGET_MAX_BYTE and it represents the
2414 target port ID of the SCSI device containing the SCSI logical unit to
2415 reset. Transport drivers may chose to utilize a subset of this array to suit
2416 the representation of their targets.
2417 @param Lun The LUN of the SCSI device to reset.
2418
2419 @retval EFI_SUCCESS The SCSI device specified by Target and Lun was reset.
2420 @retval EFI_INVALID_PARAMETER Target or Lun is NULL.
2421 @retval EFI_TIMEOUT A timeout occurred while attempting to reset the SCSI device
2422 specified by Target and Lun.
2423 @retval EFI_UNSUPPORTED The SCSI channel does not support a target reset operation.
2424 @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the SCSI device
2425 specified by Target and Lun.
2426
2427 **/
2428 EFI_STATUS
2429 EFIAPI
2430 ExtScsiPassThruResetTargetLun (
2431 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,
2432 IN UINT8 *Target,
2433 IN UINT64 Lun
2434 )
2435 {
2436 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
2437 LIST_ENTRY *Node;
2438 UINT8 Port;
2439 UINT8 PortMultiplier;
2440
2441 Instance = EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
2442 //
2443 // For ATAPI device, doesn't support multiple LUN device.
2444 //
2445 if (Lun != 0) {
2446 return EFI_INVALID_PARAMETER;
2447 }
2448 //
2449 // The layout of Target array:
2450 // ________________________________________________________________________
2451 // | Byte 0 | Byte 1 | ... | TARGET_MAX_BYTES - 1 |
2452 // |_____________________|_____________________|_____|______________________|
2453 // | | The port multiplier | | |
2454 // | The port number | port number | N/A | N/A |
2455 // |_____________________|_____________________|_____|______________________|
2456 //
2457 // For ATAPI device, 2 bytes is enough to represent the location of SCSI device.
2458 //
2459 Port = Target[0];
2460 PortMultiplier = Target[1];
2461
2462 Node = SearchDeviceInfoList(Instance, Port, PortMultiplier, EfiIdeCdrom);
2463 if (Node == NULL) {
2464 return EFI_INVALID_PARAMETER;
2465 }
2466
2467 //
2468 // Return success directly then upper layer driver could think reset target LUN operation is done.
2469 //
2470 return EFI_SUCCESS;
2471 }
2472
2473 /**
2474 Used to retrieve the list of legal Target IDs for SCSI devices on a SCSI channel. These can either
2475 be the list SCSI devices that are actually present on the SCSI channel, or the list of legal Target IDs
2476 for the SCSI channel. Regardless, the caller of this function must probe the Target ID returned to
2477 see if a SCSI device is actually present at that location on the SCSI channel.
2478
2479 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
2480 @param Target (TARGET_MAX_BYTES) of a SCSI device present on the SCSI channel.
2481 On output, a pointer to the Target ID (an array of
2482 TARGET_MAX_BYTES) of the next SCSI device present on a SCSI
2483 channel. An input value of 0xF(all bytes in the array are 0xF) in the
2484 Target array retrieves the Target ID of the first SCSI device present on a
2485 SCSI channel.
2486
2487 @retval EFI_SUCCESS The Target ID of the next SCSI device on the SCSI
2488 channel was returned in Target.
2489 @retval EFI_INVALID_PARAMETER Target or Lun is NULL.
2490 @retval EFI_TIMEOUT Target array is not all 0xF, and Target was not
2491 returned on a previous call to GetNextTarget().
2492 @retval EFI_NOT_FOUND There are no more SCSI devices on this SCSI channel.
2493
2494 **/
2495 EFI_STATUS
2496 EFIAPI
2497 ExtScsiPassThruGetNextTarget (
2498 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,
2499 IN OUT UINT8 **Target
2500 )
2501 {
2502 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
2503 LIST_ENTRY *Node;
2504 EFI_ATA_DEVICE_INFO *DeviceInfo;
2505 UINT8 *Target8;
2506 UINT16 *Target16;
2507
2508 Instance = EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
2509
2510 if (Target == NULL || *Target == NULL) {
2511 return EFI_INVALID_PARAMETER;
2512 }
2513
2514 Target8 = *Target;
2515 Target16 = (UINT16 *)*Target;
2516
2517 if (CompareMem(Target8, mScsiId, TARGET_MAX_BYTES) != 0) {
2518 //
2519 // For ATAPI device, we use 2 least significant bytes to represent the location of SCSI device.
2520 // So the higher bytes in Target array should be 0xFF.
2521 //
2522 if (CompareMem (&Target8[2], &mScsiId[2], TARGET_MAX_BYTES - 2) != 0) {
2523 return EFI_INVALID_PARAMETER;
2524 }
2525
2526 //
2527 // When Target is not all 0xFF's, compare 2 least significant bytes with
2528 // previous target id to see if it is returned by previous call.
2529 //
2530 if (*Target16 != Instance->PreviousTargetId) {
2531 return EFI_INVALID_PARAMETER;
2532 }
2533
2534 //
2535 // Traverse the whole device list to find the next cdrom closed to
2536 // the device signified by Target[0] and Target[1].
2537 //
2538 // Note that we here use a tricky way to find the next cdrom :
2539 // All ata devices are detected and inserted into the device list
2540 // sequentially.
2541 //
2542 Node = GetFirstNode (&Instance->DeviceList);
2543 while (!IsNull (&Instance->DeviceList, Node)) {
2544 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
2545
2546 if ((DeviceInfo->Type == EfiIdeCdrom) &&
2547 ((Target8[0] < DeviceInfo->Port) ||
2548 ((Target8[0] == DeviceInfo->Port) &&
2549 (Target8[1] < DeviceInfo->PortMultiplier)))) {
2550 Target8[0] = (UINT8)DeviceInfo->Port;
2551 Target8[1] = (UINT8)DeviceInfo->PortMultiplier;
2552 goto Exit;
2553 }
2554
2555 Node = GetNextNode (&Instance->DeviceList, Node);
2556 }
2557
2558 return EFI_NOT_FOUND;
2559 } else {
2560 //
2561 // If the array is all 0xFF's, start to traverse the device list from the beginning
2562 //
2563 Node = GetFirstNode (&Instance->DeviceList);
2564
2565 while (!IsNull (&Instance->DeviceList, Node)) {
2566 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
2567
2568 if (DeviceInfo->Type == EfiIdeCdrom) {
2569 Target8[0] = (UINT8)DeviceInfo->Port;
2570 Target8[1] = (UINT8)DeviceInfo->PortMultiplier;
2571 goto Exit;
2572 }
2573
2574 Node = GetNextNode (&Instance->DeviceList, Node);
2575 }
2576
2577 return EFI_NOT_FOUND;
2578 }
2579
2580 Exit:
2581 //
2582 // Update the PreviousTargetId.
2583 //
2584 Instance->PreviousTargetId = *Target16;
2585
2586 return EFI_SUCCESS;
2587 }
2588
EFI Development Kit II mirror for PVE