]> 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
1) Add type cast for better coding style.
[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 &= (UINT64)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 &= (UINT64)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 = DivU64x32(Packet->Timeout, 1000) + 1;
1343 if (Packet->Timeout == 0) {
1344 Task->InfiniteWait = TRUE;
1345 } else {
1346 Task->InfiniteWait = FALSE;
1347 }
1348
1349 OldTpl = gBS->RaiseTPL (TPL_NOTIFY);
1350 InsertTailList (&Instance->NonBlockingTaskList, &Task->Link);
1351 gBS->RestoreTPL (OldTpl);
1352
1353 return EFI_SUCCESS;
1354 } else {
1355 return AtaPassThruPassThruExecute (
1356 Port,
1357 PortMultiplierPort,
1358 Packet,
1359 Instance,
1360 NULL
1361 );
1362 }
1363 }
1364
1365 /**
1366 Used to retrieve the list of legal port numbers for ATA devices on an ATA controller.
1367 These can either be the list of ports where ATA devices are actually present or the
1368 list of legal port numbers for the ATA controller. Regardless, the caller of this
1369 function must probe the port number returned to see if an ATA device is actually
1370 present at that location on the ATA controller.
1371
1372 The GetNextPort() function retrieves the port number on an ATA controller. If on input
1373 Port is 0xFFFF, then the port number of the first port on the ATA controller is returned
1374 in Port and EFI_SUCCESS is returned.
1375
1376 If Port is a port number that was returned on a previous call to GetNextPort(), then the
1377 port number of the next port on the ATA controller is returned in Port, and EFI_SUCCESS
1378 is returned. If Port is not 0xFFFF and Port was not returned on a previous call to
1379 GetNextPort(), then EFI_INVALID_PARAMETER is returned.
1380
1381 If Port is the port number of the last port on the ATA controller, then EFI_NOT_FOUND is
1382 returned.
1383
1384 @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
1385 @param[in, out] Port On input, a pointer to the port number on the ATA controller.
1386 On output, a pointer to the next port number on the ATA
1387 controller. An input value of 0xFFFF retrieves the first port
1388 number on the ATA controller.
1389
1390 @retval EFI_SUCCESS The next port number on the ATA controller was returned in Port.
1391 @retval EFI_NOT_FOUND There are no more ports on this ATA controller.
1392 @retval EFI_INVALID_PARAMETER Port is not 0xFFFF and Port was not returned on a previous call
1393 to GetNextPort().
1394
1395 **/
1396 EFI_STATUS
1397 EFIAPI
1398 AtaPassThruGetNextPort (
1399 IN EFI_ATA_PASS_THRU_PROTOCOL *This,
1400 IN OUT UINT16 *Port
1401 )
1402 {
1403 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
1404 LIST_ENTRY *Node;
1405 EFI_ATA_DEVICE_INFO *DeviceInfo;
1406
1407 Instance = ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
1408
1409 if (Port == NULL) {
1410 return EFI_INVALID_PARAMETER;
1411 }
1412
1413 if (*Port == 0xFFFF) {
1414 //
1415 // If the Port is all 0xFF's, start to traverse the device list from the beginning
1416 //
1417 Node = GetFirstNode (&Instance->DeviceList);
1418
1419 while (!IsNull (&Instance->DeviceList, Node)) {
1420 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
1421
1422 if (DeviceInfo->Type == EfiIdeHarddisk) {
1423 *Port = DeviceInfo->Port;
1424 goto Exit;
1425 }
1426
1427 Node = GetNextNode (&Instance->DeviceList, Node);
1428 }
1429
1430 return EFI_NOT_FOUND;
1431 } else if (*Port == Instance->PreviousPort) {
1432 Node = GetFirstNode (&Instance->DeviceList);
1433
1434 while (!IsNull (&Instance->DeviceList, Node)) {
1435 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
1436
1437 if ((DeviceInfo->Type == EfiIdeHarddisk) &&
1438 (DeviceInfo->Port > *Port)){
1439 *Port = DeviceInfo->Port;
1440 goto Exit;
1441 }
1442
1443 Node = GetNextNode (&Instance->DeviceList, Node);
1444 }
1445
1446 return EFI_NOT_FOUND;
1447 } else {
1448 //
1449 // Port is not equal to 0xFFFF and also not equal to previous return value
1450 //
1451 return EFI_INVALID_PARAMETER;
1452 }
1453
1454 Exit:
1455 //
1456 // Update the PreviousPort and PreviousPortMultiplier.
1457 //
1458 Instance->PreviousPort = *Port;
1459
1460 return EFI_SUCCESS;
1461 }
1462
1463 /**
1464 Used to retrieve the list of legal port multiplier port numbers for ATA devices on a port of an ATA
1465 controller. These can either be the list of port multiplier ports where ATA devices are actually
1466 present on port or the list of legal port multiplier ports on that port. Regardless, the caller of this
1467 function must probe the port number and port multiplier port number returned to see if an ATA
1468 device is actually present.
1469
1470 The GetNextDevice() function retrieves the port multiplier port number of an ATA device
1471 present on a port of an ATA controller.
1472
1473 If PortMultiplierPort points to a port multiplier port number value that was returned on a
1474 previous call to GetNextDevice(), then the port multiplier port number of the next ATA device
1475 on the port of the ATA controller is returned in PortMultiplierPort, and EFI_SUCCESS is
1476 returned.
1477
1478 If PortMultiplierPort points to 0xFFFF, then the port multiplier port number of the first
1479 ATA device on port of the ATA controller is returned in PortMultiplierPort and
1480 EFI_SUCCESS is returned.
1481
1482 If PortMultiplierPort is not 0xFFFF and the value pointed to by PortMultiplierPort
1483 was not returned on a previous call to GetNextDevice(), then EFI_INVALID_PARAMETER
1484 is returned.
1485
1486 If PortMultiplierPort is the port multiplier port number of the last ATA device on the port of
1487 the ATA controller, then EFI_NOT_FOUND is returned.
1488
1489 @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
1490 @param[in] Port The port number present on the ATA controller.
1491 @param[in, out] PortMultiplierPort On input, a pointer to the port multiplier port number of an
1492 ATA device present on the ATA controller.
1493 If on input a PortMultiplierPort of 0xFFFF is specified,
1494 then the port multiplier port number of the first ATA device
1495 is returned. On output, a pointer to the port multiplier port
1496 number of the next ATA device present on an ATA controller.
1497
1498 @retval EFI_SUCCESS The port multiplier port number of the next ATA device on the port
1499 of the ATA controller was returned in PortMultiplierPort.
1500 @retval EFI_NOT_FOUND There are no more ATA devices on this port of the ATA controller.
1501 @retval EFI_INVALID_PARAMETER PortMultiplierPort is not 0xFFFF, and PortMultiplierPort was not
1502 returned on a previous call to GetNextDevice().
1503
1504 **/
1505 EFI_STATUS
1506 EFIAPI
1507 AtaPassThruGetNextDevice (
1508 IN EFI_ATA_PASS_THRU_PROTOCOL *This,
1509 IN UINT16 Port,
1510 IN OUT UINT16 *PortMultiplierPort
1511 )
1512 {
1513 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
1514 LIST_ENTRY *Node;
1515 EFI_ATA_DEVICE_INFO *DeviceInfo;
1516
1517 Instance = ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
1518
1519 if (PortMultiplierPort == NULL) {
1520 return EFI_INVALID_PARAMETER;
1521 }
1522
1523 if (*PortMultiplierPort == 0xFFFF) {
1524 //
1525 // If the PortMultiplierPort is all 0xFF's, start to traverse the device list from the beginning
1526 //
1527 Node = GetFirstNode (&Instance->DeviceList);
1528
1529 while (!IsNull (&Instance->DeviceList, Node)) {
1530 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
1531
1532 if ((DeviceInfo->Type == EfiIdeHarddisk) &&
1533 (DeviceInfo->Port == Port)){
1534 *PortMultiplierPort = DeviceInfo->PortMultiplier;
1535 goto Exit;
1536 }
1537
1538 Node = GetNextNode (&Instance->DeviceList, Node);
1539 }
1540
1541 return EFI_NOT_FOUND;
1542 } else if (*PortMultiplierPort == Instance->PreviousPortMultiplier) {
1543 Node = GetFirstNode (&Instance->DeviceList);
1544
1545 while (!IsNull (&Instance->DeviceList, Node)) {
1546 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
1547
1548 if ((DeviceInfo->Type == EfiIdeHarddisk) &&
1549 (DeviceInfo->Port == Port) &&
1550 (DeviceInfo->PortMultiplier > *PortMultiplierPort)){
1551 *PortMultiplierPort = DeviceInfo->PortMultiplier;
1552 goto Exit;
1553 }
1554
1555 Node = GetNextNode (&Instance->DeviceList, Node);
1556 }
1557
1558 return EFI_NOT_FOUND;
1559 } else {
1560 //
1561 // PortMultiplierPort is not equal to 0xFFFF and also not equal to previous return value
1562 //
1563 return EFI_INVALID_PARAMETER;
1564 }
1565
1566 Exit:
1567 //
1568 // Update the PreviousPort and PreviousPortMultiplier.
1569 //
1570 Instance->PreviousPortMultiplier = *PortMultiplierPort;
1571
1572 return EFI_SUCCESS;
1573 }
1574
1575 /**
1576 Used to allocate and build a device path node for an ATA device on an ATA controller.
1577
1578 The BuildDevicePath() function allocates and builds a single device node for the ATA
1579 device specified by Port and PortMultiplierPort. If the ATA device specified by Port and
1580 PortMultiplierPort is not present on the ATA controller, then EFI_NOT_FOUND is returned.
1581 If DevicePath is NULL, then EFI_INVALID_PARAMETER is returned. If there are not enough
1582 resources to allocate the device path node, then EFI_OUT_OF_RESOURCES is returned.
1583
1584 Otherwise, DevicePath is allocated with the boot service AllocatePool(), the contents of
1585 DevicePath are initialized to describe the ATA device specified by Port and PortMultiplierPort,
1586 and EFI_SUCCESS is returned.
1587
1588 @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
1589 @param[in] Port Port specifies the port number of the ATA device for which a
1590 device path node is to be allocated and built.
1591 @param[in] PortMultiplierPort The port multiplier port number of the ATA device for which a
1592 device path node is to be allocated and built. If there is no
1593 port multiplier, then specify 0.
1594 @param[in, out] DevicePath A pointer to a single device path node that describes the ATA
1595 device specified by Port and PortMultiplierPort. This function
1596 is responsible for allocating the buffer DevicePath with the
1597 boot service AllocatePool(). It is the caller's responsibility
1598 to free DevicePath when the caller is finished with DevicePath.
1599 @retval EFI_SUCCESS The device path node that describes the ATA device specified by
1600 Port and PortMultiplierPort was allocated and returned in DevicePath.
1601 @retval EFI_NOT_FOUND The ATA device specified by Port and PortMultiplierPort does not
1602 exist on the ATA controller.
1603 @retval EFI_INVALID_PARAMETER DevicePath is NULL.
1604 @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate DevicePath.
1605
1606 **/
1607 EFI_STATUS
1608 EFIAPI
1609 AtaPassThruBuildDevicePath (
1610 IN EFI_ATA_PASS_THRU_PROTOCOL *This,
1611 IN UINT16 Port,
1612 IN UINT16 PortMultiplierPort,
1613 IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath
1614 )
1615 {
1616 EFI_DEV_PATH *DevicePathNode;
1617 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
1618 LIST_ENTRY *Node;
1619
1620 Instance = ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
1621
1622 //
1623 // Validate parameters passed in.
1624 //
1625 if (DevicePath == NULL) {
1626 return EFI_INVALID_PARAMETER;
1627 }
1628
1629 Node = SearchDeviceInfoList(Instance, Port, PortMultiplierPort, EfiIdeHarddisk);
1630 if (Node == NULL) {
1631 return EFI_NOT_FOUND;
1632 }
1633
1634 if (Instance->Mode == EfiAtaIdeMode) {
1635 DevicePathNode = AllocateCopyPool (sizeof (ATAPI_DEVICE_PATH), &mAtapiDevicePathTemplate);
1636 if (DevicePathNode == NULL) {
1637 return EFI_OUT_OF_RESOURCES;
1638 }
1639 DevicePathNode->Atapi.PrimarySecondary = (UINT8) Port;
1640 DevicePathNode->Atapi.SlaveMaster = (UINT8) PortMultiplierPort;
1641 DevicePathNode->Atapi.Lun = 0;
1642 } else {
1643 DevicePathNode = AllocateCopyPool (sizeof (SATA_DEVICE_PATH), &mSataDevicePathTemplate);
1644 if (DevicePathNode == NULL) {
1645 return EFI_OUT_OF_RESOURCES;
1646 }
1647
1648 DevicePathNode->Sata.HBAPortNumber = Port;
1649 DevicePathNode->Sata.PortMultiplierPortNumber = PortMultiplierPort;
1650 DevicePathNode->Sata.Lun = 0;
1651 }
1652
1653 *DevicePath = (EFI_DEVICE_PATH_PROTOCOL *) DevicePathNode;
1654
1655 return EFI_SUCCESS;
1656 }
1657
1658 /**
1659 Used to translate a device path node to a port number and port multiplier port number.
1660
1661 The GetDevice() function determines the port and port multiplier port number associated with
1662 the ATA device described by DevicePath. If DevicePath is a device path node type that the
1663 ATA Pass Thru driver supports, then the ATA Pass Thru driver will attempt to translate the contents
1664 DevicePath into a port number and port multiplier port number.
1665
1666 If this translation is successful, then that port number and port multiplier port number are returned
1667 in Port and PortMultiplierPort, and EFI_SUCCESS is returned.
1668
1669 If DevicePath, Port, or PortMultiplierPort are NULL, then EFI_INVALID_PARAMETER is returned.
1670
1671 If DevicePath is not a device path node type that the ATA Pass Thru driver supports, then
1672 EFI_UNSUPPORTED is returned.
1673
1674 If DevicePath is a device path node type that the ATA Pass Thru driver supports, but there is not
1675 a valid translation from DevicePath to a port number and port multiplier port number, then
1676 EFI_NOT_FOUND is returned.
1677
1678 @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
1679 @param[in] DevicePath A pointer to the device path node that describes an ATA device on the
1680 ATA controller.
1681 @param[out] Port On return, points to the port number of an ATA device on the ATA controller.
1682 @param[out] PortMultiplierPort On return, points to the port multiplier port number of an ATA device
1683 on the ATA controller.
1684
1685 @retval EFI_SUCCESS DevicePath was successfully translated to a port number and port multiplier
1686 port number, and they were returned in Port and PortMultiplierPort.
1687 @retval EFI_INVALID_PARAMETER DevicePath is NULL.
1688 @retval EFI_INVALID_PARAMETER Port is NULL.
1689 @retval EFI_INVALID_PARAMETER PortMultiplierPort is NULL.
1690 @retval EFI_UNSUPPORTED This driver does not support the device path node type in DevicePath.
1691 @retval EFI_NOT_FOUND A valid translation from DevicePath to a port number and port multiplier
1692 port number does not exist.
1693 **/
1694 EFI_STATUS
1695 EFIAPI
1696 AtaPassThruGetDevice (
1697 IN EFI_ATA_PASS_THRU_PROTOCOL *This,
1698 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,
1699 OUT UINT16 *Port,
1700 OUT UINT16 *PortMultiplierPort
1701 )
1702 {
1703 EFI_DEV_PATH *DevicePathNode;
1704 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
1705 LIST_ENTRY *Node;
1706
1707 Instance = ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
1708
1709 //
1710 // Validate parameters passed in.
1711 //
1712 if (DevicePath == NULL || Port == NULL || PortMultiplierPort == NULL) {
1713 return EFI_INVALID_PARAMETER;
1714 }
1715
1716 //
1717 // Check whether the DevicePath belongs to SCSI_DEVICE_PATH or ATAPI_DEVICE_PATH
1718 //
1719 if ((DevicePath->Type != MESSAGING_DEVICE_PATH) ||
1720 ((DevicePath->SubType != MSG_SATA_DP) &&
1721 (DevicePath->SubType != MSG_ATAPI_DP)) ||
1722 ((DevicePathNodeLength(DevicePath) != sizeof(ATAPI_DEVICE_PATH)) &&
1723 (DevicePathNodeLength(DevicePath) != sizeof(SATA_DEVICE_PATH)))) {
1724 return EFI_UNSUPPORTED;
1725 }
1726
1727 DevicePathNode = (EFI_DEV_PATH *) DevicePath;
1728
1729 if (Instance->Mode == EfiAtaIdeMode) {
1730 *Port = DevicePathNode->Atapi.PrimarySecondary;
1731 *PortMultiplierPort = DevicePathNode->Atapi.SlaveMaster;
1732 } else {
1733 *Port = DevicePathNode->Sata.HBAPortNumber;
1734 *PortMultiplierPort = DevicePathNode->Sata.PortMultiplierPortNumber;
1735 }
1736
1737 Node = SearchDeviceInfoList(Instance, *Port, *PortMultiplierPort, EfiIdeHarddisk);
1738
1739 if (Node == NULL) {
1740 return EFI_NOT_FOUND;
1741 }
1742
1743 return EFI_SUCCESS;
1744 }
1745
1746 /**
1747 Resets a specific port on the ATA controller. This operation also resets all the ATA devices
1748 connected to the port.
1749
1750 The ResetChannel() function resets an a specific port on an ATA controller. This operation
1751 resets all the ATA devices connected to that port. If this ATA controller does not support
1752 a reset port operation, then EFI_UNSUPPORTED is returned.
1753
1754 If a device error occurs while executing that port reset operation, then EFI_DEVICE_ERROR is
1755 returned.
1756
1757 If a timeout occurs during the execution of the port reset operation, then EFI_TIMEOUT is returned.
1758
1759 If the port reset operation is completed, then EFI_SUCCESS is returned.
1760
1761 @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
1762 @param[in] Port The port number on the ATA controller.
1763
1764 @retval EFI_SUCCESS The ATA controller port was reset.
1765 @retval EFI_UNSUPPORTED The ATA controller does not support a port reset operation.
1766 @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the ATA port.
1767 @retval EFI_TIMEOUT A timeout occurred while attempting to reset the ATA port.
1768
1769 **/
1770 EFI_STATUS
1771 EFIAPI
1772 AtaPassThruResetPort (
1773 IN EFI_ATA_PASS_THRU_PROTOCOL *This,
1774 IN UINT16 Port
1775 )
1776 {
1777 //
1778 // Return success directly then upper layer driver could think reset port operation is done.
1779 //
1780 return EFI_SUCCESS;
1781 }
1782
1783 /**
1784 Resets an ATA device that is connected to an ATA controller.
1785
1786 The ResetDevice() function resets the ATA device specified by Port and PortMultiplierPort.
1787 If this ATA controller does not support a device reset operation, then EFI_UNSUPPORTED is
1788 returned.
1789
1790 If Port or PortMultiplierPort are not in a valid range for this ATA controller, then
1791 EFI_INVALID_PARAMETER is returned.
1792
1793 If a device error occurs while executing that device reset operation, then EFI_DEVICE_ERROR
1794 is returned.
1795
1796 If a timeout occurs during the execution of the device reset operation, then EFI_TIMEOUT is
1797 returned.
1798
1799 If the device reset operation is completed, then EFI_SUCCESS is returned.
1800
1801 @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
1802 @param[in] Port Port represents the port number of the ATA device to be reset.
1803 @param[in] PortMultiplierPort The port multiplier port number of the ATA device to reset.
1804 If there is no port multiplier, then specify 0.
1805 @retval EFI_SUCCESS The ATA device specified by Port and PortMultiplierPort was reset.
1806 @retval EFI_UNSUPPORTED The ATA controller does not support a device reset operation.
1807 @retval EFI_INVALID_PARAMETER Port or PortMultiplierPort are invalid.
1808 @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the ATA device
1809 specified by Port and PortMultiplierPort.
1810 @retval EFI_TIMEOUT A timeout occurred while attempting to reset the ATA device
1811 specified by Port and PortMultiplierPort.
1812
1813 **/
1814 EFI_STATUS
1815 EFIAPI
1816 AtaPassThruResetDevice (
1817 IN EFI_ATA_PASS_THRU_PROTOCOL *This,
1818 IN UINT16 Port,
1819 IN UINT16 PortMultiplierPort
1820 )
1821 {
1822 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
1823 LIST_ENTRY *Node;
1824
1825 Instance = ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
1826
1827 Node = SearchDeviceInfoList (Instance, Port, PortMultiplierPort, EfiIdeHarddisk);
1828
1829 if (Node == NULL) {
1830 return EFI_INVALID_PARAMETER;
1831 }
1832
1833 //
1834 // Return success directly then upper layer driver could think reset device operation is done.
1835 //
1836 return EFI_SUCCESS;
1837 }
1838
1839 /**
1840 Sumbit ATAPI request sense command.
1841
1842 @param[in] This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
1843 @param[in] Target The Target is an array of size TARGET_MAX_BYTES and it represents
1844 the id of the SCSI device to send the SCSI Request Packet. Each
1845 transport driver may choose to utilize a subset of this size to suit the needs
1846 of transport target representation. For example, a Fibre Channel driver
1847 may use only 8 bytes (WWN) to represent an FC target.
1848 @param[in] Lun The LUN of the SCSI device to send the SCSI Request Packet.
1849 @param[in] SenseData A pointer to store sense data.
1850 @param[in] SenseDataLength The sense data length.
1851 @param[in] Timeout The timeout value to execute this cmd, uses 100ns as a unit.
1852
1853 @retval EFI_SUCCESS Send out the ATAPI packet command successfully.
1854 @retval EFI_DEVICE_ERROR The device failed to send data.
1855
1856 **/
1857 EFI_STATUS
1858 EFIAPI
1859 AtaPacketRequestSense (
1860 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,
1861 IN UINT8 *Target,
1862 IN UINT64 Lun,
1863 IN VOID *SenseData,
1864 IN UINT8 SenseDataLength,
1865 IN UINT64 Timeout
1866 )
1867 {
1868 EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET Packet;
1869 UINT8 Cdb[12];
1870 EFI_STATUS Status;
1871
1872 ZeroMem (&Packet, sizeof (EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET));
1873 ZeroMem (Cdb, 12);
1874
1875 Cdb[0] = ATA_CMD_REQUEST_SENSE;
1876 Cdb[4] = SenseDataLength;
1877
1878 Packet.Timeout = Timeout;
1879 Packet.Cdb = Cdb;
1880 Packet.CdbLength = 12;
1881 Packet.DataDirection = EFI_EXT_SCSI_DATA_DIRECTION_READ;
1882 Packet.InDataBuffer = SenseData;
1883 Packet.InTransferLength = SenseDataLength;
1884
1885 Status = ExtScsiPassThruPassThru (This, Target, Lun, &Packet, NULL);
1886
1887 return Status;
1888 }
1889
1890 /**
1891 Sends a SCSI Request Packet to a SCSI device that is attached to the SCSI channel. This function
1892 supports both blocking I/O and nonblocking I/O. The blocking I/O functionality is required, and the
1893 nonblocking I/O functionality is optional.
1894
1895 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
1896 @param Target The Target is an array of size TARGET_MAX_BYTES and it represents
1897 the id of the SCSI device to send the SCSI Request Packet. Each
1898 transport driver may choose to utilize a subset of this size to suit the needs
1899 of transport target representation. For example, a Fibre Channel driver
1900 may use only 8 bytes (WWN) to represent an FC target.
1901 @param Lun The LUN of the SCSI device to send the SCSI Request Packet.
1902 @param Packet A pointer to the SCSI Request Packet to send to the SCSI device
1903 specified by Target and Lun.
1904 @param Event If nonblocking I/O is not supported then Event is ignored, and blocking
1905 I/O is performed. If Event is NULL, then blocking I/O is performed. If
1906 Event is not NULL and non blocking I/O is supported, then
1907 nonblocking I/O is performed, and Event will be signaled when the
1908 SCSI Request Packet completes.
1909
1910 @retval EFI_SUCCESS The SCSI Request Packet was sent by the host. For bi-directional
1911 commands, InTransferLength bytes were transferred from
1912 InDataBuffer. For write and bi-directional commands,
1913 OutTransferLength bytes were transferred by
1914 OutDataBuffer.
1915 @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was not executed. The number of bytes that
1916 could be transferred is returned in InTransferLength. For write
1917 and bi-directional commands, OutTransferLength bytes were
1918 transferred by OutDataBuffer.
1919 @retval EFI_NOT_READY The SCSI Request Packet could not be sent because there are too many
1920 SCSI Request Packets already queued. The caller may retry again later.
1921 @retval EFI_DEVICE_ERROR A device error occurred while attempting to send the SCSI Request
1922 Packet.
1923 @retval EFI_INVALID_PARAMETER Target, Lun, or the contents of ScsiRequestPacket are invalid.
1924 @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported
1925 by the host adapter. This includes the case of Bi-directional SCSI
1926 commands not supported by the implementation. The SCSI Request
1927 Packet was not sent, so no additional status information is available.
1928 @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
1929
1930 **/
1931 EFI_STATUS
1932 EFIAPI
1933 ExtScsiPassThruPassThru (
1934 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,
1935 IN UINT8 *Target,
1936 IN UINT64 Lun,
1937 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet,
1938 IN EFI_EVENT Event OPTIONAL
1939 )
1940 {
1941 EFI_STATUS Status;
1942 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
1943 UINT8 Port;
1944 UINT8 PortMultiplier;
1945 EFI_ATA_HC_WORK_MODE Mode;
1946 LIST_ENTRY *Node;
1947 EFI_ATA_DEVICE_INFO *DeviceInfo;
1948 BOOLEAN SenseReq;
1949 EFI_SCSI_SENSE_DATA *PtrSenseData;
1950 UINTN SenseDataLen;
1951 EFI_STATUS SenseStatus;
1952
1953 SenseDataLen = 0;
1954 Instance = EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
1955
1956 if ((Packet == NULL) || (Packet->Cdb == NULL)) {
1957 return EFI_INVALID_PARAMETER;
1958 }
1959
1960 //
1961 // Don't support variable length CDB
1962 //
1963 if ((Packet->CdbLength != 6) && (Packet->CdbLength != 10) &&
1964 (Packet->CdbLength != 12) && (Packet->CdbLength != 16)) {
1965 return EFI_INVALID_PARAMETER;
1966 }
1967
1968 if ((Packet->SenseDataLength != 0) && (Packet->SenseData == NULL)) {
1969 return EFI_INVALID_PARAMETER;
1970 }
1971
1972 if ((This->Mode->IoAlign > 1) && !IS_ALIGNED(Packet->InDataBuffer, This->Mode->IoAlign)) {
1973 return EFI_INVALID_PARAMETER;
1974 }
1975
1976 if ((This->Mode->IoAlign > 1) && !IS_ALIGNED(Packet->OutDataBuffer, This->Mode->IoAlign)) {
1977 return EFI_INVALID_PARAMETER;
1978 }
1979
1980 if ((This->Mode->IoAlign > 1) && !IS_ALIGNED(Packet->SenseData, This->Mode->IoAlign)) {
1981 return EFI_INVALID_PARAMETER;
1982 }
1983
1984 //
1985 // For ATAPI device, doesn't support multiple LUN device.
1986 //
1987 if (Lun != 0) {
1988 return EFI_INVALID_PARAMETER;
1989 }
1990
1991 //
1992 // The layout of Target array:
1993 // ________________________________________________________________________
1994 // | Byte 0 | Byte 1 | ... | TARGET_MAX_BYTES - 1 |
1995 // |_____________________|_____________________|_____|______________________|
1996 // | | The port multiplier | | |
1997 // | The port number | port number | N/A | N/A |
1998 // |_____________________|_____________________|_____|______________________|
1999 //
2000 // For ATAPI device, 2 bytes is enough to represent the location of SCSI device.
2001 //
2002 Port = Target[0];
2003 PortMultiplier = Target[1];
2004
2005 Node = SearchDeviceInfoList(Instance, Port, PortMultiplier, EfiIdeCdrom);
2006 if (Node == NULL) {
2007 return EFI_INVALID_PARAMETER;
2008 }
2009
2010 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
2011
2012 //
2013 // ATA_CMD_IDENTIFY_DEVICE cmd is a ATA cmd but not a SCSI cmd.
2014 // Normally it should NOT be passed down through ExtScsiPassThru protocol interface.
2015 // But to response EFI_DISK_INFO.Identify() request from ScsiDisk, we should handle this command.
2016 //
2017 if (*((UINT8*)Packet->Cdb) == ATA_CMD_IDENTIFY_DEVICE) {
2018 CopyMem (Packet->InDataBuffer, DeviceInfo->IdentifyData, sizeof (EFI_IDENTIFY_DATA));
2019 //
2020 // For IDENTIFY DEVICE cmd, we don't need to get sense data.
2021 //
2022 Packet->SenseDataLength = 0;
2023 return EFI_SUCCESS;
2024 }
2025
2026 Mode = Instance->Mode;
2027 switch (Mode) {
2028 case EfiAtaIdeMode:
2029 //
2030 // Reassign IDE mode io port registers' base addresses
2031 //
2032 Status = GetIdeRegisterIoAddr (Instance->PciIo, Instance->IdeRegisters);
2033
2034 if (EFI_ERROR (Status)) {
2035 return Status;
2036 }
2037
2038 Status = AtaPacketCommandExecute (Instance->PciIo, &Instance->IdeRegisters[Port], Port, PortMultiplier, Packet);
2039 break;
2040 case EfiAtaAhciMode:
2041 Status = AhciPacketCommandExecute (Instance->PciIo, &Instance->AhciRegisters, Port, PortMultiplier, Packet);
2042 break;
2043 default :
2044 Status = EFI_DEVICE_ERROR;
2045 break;
2046 }
2047
2048 //
2049 // If the cmd doesn't get executed correctly, then check sense data.
2050 //
2051 if (EFI_ERROR (Status) && (Packet->SenseDataLength != 0) && (*((UINT8*)Packet->Cdb) != ATA_CMD_REQUEST_SENSE)) {
2052 PtrSenseData = AllocateAlignedPages (EFI_SIZE_TO_PAGES (sizeof (EFI_SCSI_SENSE_DATA)), This->Mode->IoAlign);
2053 if (PtrSenseData == NULL) {
2054 return EFI_DEVICE_ERROR;
2055 }
2056
2057 for (SenseReq = TRUE; SenseReq;) {
2058 SenseStatus = AtaPacketRequestSense (
2059 This,
2060 Target,
2061 Lun,
2062 PtrSenseData,
2063 sizeof (EFI_SCSI_SENSE_DATA),
2064 Packet->Timeout
2065 );
2066 if (EFI_ERROR (SenseStatus)) {
2067 break;
2068 }
2069
2070 CopyMem ((UINT8*)Packet->SenseData + SenseDataLen, PtrSenseData, sizeof (EFI_SCSI_SENSE_DATA));
2071 SenseDataLen += sizeof (EFI_SCSI_SENSE_DATA);
2072
2073 //
2074 // no more sense key or number of sense keys exceeds predefined,
2075 // skip the loop.
2076 //
2077 if ((PtrSenseData->Sense_Key == EFI_SCSI_SK_NO_SENSE) ||
2078 (SenseDataLen + sizeof (EFI_SCSI_SENSE_DATA) > Packet->SenseDataLength)) {
2079 SenseReq = FALSE;
2080 }
2081 }
2082 FreeAlignedPages (PtrSenseData, EFI_SIZE_TO_PAGES (sizeof (EFI_SCSI_SENSE_DATA)));
2083 }
2084 //
2085 // Update the SenseDataLength field to the data length received.
2086 //
2087 Packet->SenseDataLength = (UINT8)SenseDataLen;
2088 return Status;
2089 }
2090
2091 /**
2092 Used to retrieve the list of legal Target IDs and LUNs for SCSI devices on a SCSI channel. These
2093 can either be the list SCSI devices that are actually present on the SCSI channel, or the list of legal
2094 Target Ids and LUNs for the SCSI channel. Regardless, the caller of this function must probe the
2095 Target ID and LUN returned to see if a SCSI device is actually present at that location on the SCSI
2096 channel.
2097
2098 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
2099 @param Target On input, a pointer to the Target ID (an array of size
2100 TARGET_MAX_BYTES) of a SCSI device present on the SCSI channel.
2101 On output, a pointer to the Target ID (an array of
2102 TARGET_MAX_BYTES) of the next SCSI device present on a SCSI
2103 channel. An input value of 0xF(all bytes in the array are 0xF) in the
2104 Target array retrieves the Target ID of the first SCSI device present on a
2105 SCSI channel.
2106 @param Lun On input, a pointer to the LUN of a SCSI device present on the SCSI
2107 channel. On output, a pointer to the LUN of the next SCSI device present
2108 on a SCSI channel.
2109
2110 @retval EFI_SUCCESS The Target ID and LUN of the next SCSI device on the SCSI
2111 channel was returned in Target and Lun.
2112 @retval EFI_INVALID_PARAMETER Target array is not all 0xF, and Target and Lun were
2113 not returned on a previous call to GetNextTargetLun().
2114 @retval EFI_NOT_FOUND There are no more SCSI devices on this SCSI channel.
2115
2116 **/
2117 EFI_STATUS
2118 EFIAPI
2119 ExtScsiPassThruGetNextTargetLun (
2120 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,
2121 IN OUT UINT8 **Target,
2122 IN OUT UINT64 *Lun
2123 )
2124 {
2125 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
2126 LIST_ENTRY *Node;
2127 EFI_ATA_DEVICE_INFO *DeviceInfo;
2128 UINT8 *Target8;
2129 UINT16 *Target16;
2130
2131 Instance = EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
2132
2133 if (Target == NULL || Lun == NULL) {
2134 return EFI_INVALID_PARAMETER;
2135 }
2136
2137 if (*Target == NULL) {
2138 return EFI_INVALID_PARAMETER;
2139 }
2140
2141 Target8 = *Target;
2142 Target16 = (UINT16 *)*Target;
2143
2144 if (CompareMem(Target8, mScsiId, TARGET_MAX_BYTES) != 0) {
2145 //
2146 // For ATAPI device, we use 2 least significant bytes to represent the location of SCSI device.
2147 // So the higher bytes in Target array should be 0xFF.
2148 //
2149 if (CompareMem (&Target8[2], &mScsiId[2], TARGET_MAX_BYTES - 2) != 0) {
2150 return EFI_INVALID_PARAMETER;
2151 }
2152
2153 //
2154 // When Target is not all 0xFF's, compare 2 least significant bytes with
2155 // previous target id to see if it is returned by previous call.
2156 //
2157 if ((*Target16 != Instance->PreviousTargetId) ||
2158 (*Lun != Instance->PreviousLun)) {
2159 return EFI_INVALID_PARAMETER;
2160 }
2161
2162 //
2163 // Traverse the whole device list to find the next cdrom closed to
2164 // the device signified by Target[0] and Target[1].
2165 //
2166 // Note that we here use a tricky way to find the next cdrom :
2167 // All ata devices are detected and inserted into the device list
2168 // sequentially.
2169 //
2170 Node = GetFirstNode (&Instance->DeviceList);
2171
2172 while (!IsNull (&Instance->DeviceList, Node)) {
2173 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
2174
2175 if ((DeviceInfo->Type == EfiIdeCdrom) &&
2176 ((Target8[0] < DeviceInfo->Port) ||
2177 ((Target8[0] == DeviceInfo->Port) &&
2178 (Target8[1] < DeviceInfo->PortMultiplier)))) {
2179 Target8[0] = (UINT8)DeviceInfo->Port;
2180 Target8[1] = (UINT8)DeviceInfo->PortMultiplier;
2181 goto Exit;
2182 }
2183
2184 Node = GetNextNode (&Instance->DeviceList, Node);
2185 }
2186
2187 return EFI_NOT_FOUND;
2188 } else {
2189 //
2190 // If the array is all 0xFF's, start to traverse the device list from the beginning
2191 //
2192 Node = GetFirstNode (&Instance->DeviceList);
2193 while (!IsNull (&Instance->DeviceList, Node)) {
2194 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
2195
2196 if (DeviceInfo->Type == EfiIdeCdrom) {
2197 Target8[0] = (UINT8)DeviceInfo->Port;
2198 Target8[1] = (UINT8)DeviceInfo->PortMultiplier;
2199 goto Exit;
2200 }
2201
2202 Node = GetNextNode (&Instance->DeviceList, Node);
2203 }
2204
2205 return EFI_NOT_FOUND;
2206 }
2207
2208 Exit:
2209 *Lun = 0;
2210
2211 //
2212 // Update the PreviousTargetId.
2213 //
2214 Instance->PreviousTargetId = *Target16;
2215 Instance->PreviousLun = *Lun;
2216
2217 return EFI_SUCCESS;
2218 }
2219
2220 /**
2221 Used to allocate and build a device path node for a SCSI device on a SCSI channel.
2222
2223 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
2224 @param Target The Target is an array of size TARGET_MAX_BYTES and it specifies the
2225 Target ID of the SCSI device for which a device path node is to be
2226 allocated and built. Transport drivers may chose to utilize a subset of
2227 this size to suit the representation of targets. For example, a Fibre
2228 Channel driver may use only 8 bytes (WWN) in the array to represent a
2229 FC target.
2230 @param Lun The LUN of the SCSI device for which a device path node is to be
2231 allocated and built.
2232 @param DevicePath A pointer to a single device path node that describes the SCSI device
2233 specified by Target and Lun. This function is responsible for
2234 allocating the buffer DevicePath with the boot service
2235 AllocatePool(). It is the caller's responsibility to free
2236 DevicePath when the caller is finished with DevicePath.
2237
2238 @retval EFI_SUCCESS The device path node that describes the SCSI device specified by
2239 Target and Lun was allocated and returned in
2240 DevicePath.
2241 @retval EFI_INVALID_PARAMETER DevicePath is NULL.
2242 @retval EFI_NOT_FOUND The SCSI devices specified by Target and Lun does not exist
2243 on the SCSI channel.
2244 @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate DevicePath.
2245
2246 **/
2247 EFI_STATUS
2248 EFIAPI
2249 ExtScsiPassThruBuildDevicePath (
2250 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,
2251 IN UINT8 *Target,
2252 IN UINT64 Lun,
2253 IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath
2254 )
2255 {
2256 EFI_DEV_PATH *DevicePathNode;
2257 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
2258 UINT8 Port;
2259 UINT8 PortMultiplier;
2260
2261 Instance = EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
2262
2263 Port = Target[0];
2264 PortMultiplier = Target[1];
2265
2266 //
2267 // Validate parameters passed in.
2268 //
2269 if (DevicePath == NULL) {
2270 return EFI_INVALID_PARAMETER;
2271 }
2272
2273 //
2274 // can not build device path for the SCSI Host Controller.
2275 //
2276 if (Lun != 0) {
2277 return EFI_NOT_FOUND;
2278 }
2279
2280 if (SearchDeviceInfoList(Instance, Port, PortMultiplier, EfiIdeCdrom) == NULL) {
2281 return EFI_NOT_FOUND;
2282 }
2283
2284 if (Instance->Mode == EfiAtaIdeMode) {
2285 DevicePathNode = AllocateCopyPool (sizeof (ATAPI_DEVICE_PATH), &mAtapiDevicePathTemplate);
2286 if (DevicePathNode == NULL) {
2287 return EFI_OUT_OF_RESOURCES;
2288 }
2289
2290 DevicePathNode->Atapi.PrimarySecondary = Port;
2291 DevicePathNode->Atapi.SlaveMaster = PortMultiplier;
2292 DevicePathNode->Atapi.Lun = (UINT16) Lun;
2293 } else {
2294 DevicePathNode = AllocateCopyPool (sizeof (SATA_DEVICE_PATH), &mSataDevicePathTemplate);
2295 if (DevicePathNode == NULL) {
2296 return EFI_OUT_OF_RESOURCES;
2297 }
2298
2299 DevicePathNode->Sata.HBAPortNumber = Port;
2300 DevicePathNode->Sata.PortMultiplierPortNumber = PortMultiplier;
2301 DevicePathNode->Sata.Lun = (UINT16) Lun;
2302 }
2303
2304 *DevicePath = (EFI_DEVICE_PATH_PROTOCOL *) DevicePathNode;
2305
2306 return EFI_SUCCESS;
2307 }
2308
2309 /**
2310 Used to translate a device path node to a Target ID and LUN.
2311
2312 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
2313 @param DevicePath A pointer to a single device path node that describes the SCSI device
2314 on the SCSI channel.
2315 @param Target A pointer to the Target Array which represents the ID of a SCSI device
2316 on the SCSI channel.
2317 @param Lun A pointer to the LUN of a SCSI device on the SCSI channel.
2318
2319 @retval EFI_SUCCESS DevicePath was successfully translated to a Target ID and
2320 LUN, and they were returned in Target and Lun.
2321 @retval EFI_INVALID_PARAMETER DevicePath or Target or Lun is NULL.
2322 @retval EFI_NOT_FOUND A valid translation from DevicePath to a Target ID and LUN
2323 does not exist.
2324 @retval EFI_UNSUPPORTED This driver does not support the device path node type in
2325 DevicePath.
2326
2327 **/
2328 EFI_STATUS
2329 EFIAPI
2330 ExtScsiPassThruGetTargetLun (
2331 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,
2332 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,
2333 OUT UINT8 **Target,
2334 OUT UINT64 *Lun
2335 )
2336 {
2337 EFI_DEV_PATH *DevicePathNode;
2338 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
2339 LIST_ENTRY *Node;
2340
2341 Instance = EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
2342
2343 //
2344 // Validate parameters passed in.
2345 //
2346 if (DevicePath == NULL || Target == NULL || Lun == NULL) {
2347 return EFI_INVALID_PARAMETER;
2348 }
2349
2350 if (*Target == NULL) {
2351 return EFI_INVALID_PARAMETER;
2352 }
2353 //
2354 // Check whether the DevicePath belongs to SCSI_DEVICE_PATH
2355 //
2356 if ((DevicePath->Type != MESSAGING_DEVICE_PATH) ||
2357 ((DevicePath->SubType != MSG_ATAPI_DP) &&
2358 (DevicePath->SubType != MSG_SATA_DP)) ||
2359 ((DevicePathNodeLength(DevicePath) != sizeof(ATAPI_DEVICE_PATH)) &&
2360 (DevicePathNodeLength(DevicePath) != sizeof(SATA_DEVICE_PATH)))) {
2361 return EFI_UNSUPPORTED;
2362 }
2363
2364 SetMem (*Target, TARGET_MAX_BYTES, 0xFF);
2365
2366 DevicePathNode = (EFI_DEV_PATH *) DevicePath;
2367
2368 if (Instance->Mode == EfiAtaIdeMode) {
2369 (*Target)[0] = (UINT8) DevicePathNode->Atapi.PrimarySecondary;
2370 (*Target)[1] = (UINT8) DevicePathNode->Atapi.SlaveMaster;
2371 *Lun = (UINT8) DevicePathNode->Atapi.Lun;
2372 } else {
2373 (*Target)[0] = (UINT8) DevicePathNode->Sata.HBAPortNumber;
2374 (*Target)[1] = (UINT8) DevicePathNode->Sata.PortMultiplierPortNumber;
2375 *Lun = (UINT8) DevicePathNode->Sata.Lun;
2376 }
2377
2378 Node = SearchDeviceInfoList(Instance, (*Target)[0], (*Target)[1], EfiIdeCdrom);
2379
2380 if (Node == NULL) {
2381 return EFI_NOT_FOUND;
2382 }
2383
2384 if (*Lun != 0) {
2385 return EFI_NOT_FOUND;
2386 }
2387
2388 return EFI_SUCCESS;
2389 }
2390
2391 /**
2392 Resets a SCSI channel. This operation resets all the SCSI devices connected to the SCSI channel.
2393
2394 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
2395
2396 @retval EFI_SUCCESS The SCSI channel was reset.
2397 @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the SCSI channel.
2398 @retval EFI_TIMEOUT A timeout occurred while attempting to reset the SCSI channel.
2399 @retval EFI_UNSUPPORTED The SCSI channel does not support a channel reset operation.
2400
2401 **/
2402 EFI_STATUS
2403 EFIAPI
2404 ExtScsiPassThruResetChannel (
2405 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This
2406 )
2407 {
2408 //
2409 // Return success directly then upper layer driver could think reset channel operation is done.
2410 //
2411 return EFI_SUCCESS;
2412 }
2413
2414 /**
2415 Resets a SCSI logical unit that is connected to a SCSI channel.
2416
2417 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
2418 @param Target The Target is an array of size TARGET_MAX_BYTE and it represents the
2419 target port ID of the SCSI device containing the SCSI logical unit to
2420 reset. Transport drivers may chose to utilize a subset of this array to suit
2421 the representation of their targets.
2422 @param Lun The LUN of the SCSI device to reset.
2423
2424 @retval EFI_SUCCESS The SCSI device specified by Target and Lun was reset.
2425 @retval EFI_INVALID_PARAMETER Target or Lun is NULL.
2426 @retval EFI_TIMEOUT A timeout occurred while attempting to reset the SCSI device
2427 specified by Target and Lun.
2428 @retval EFI_UNSUPPORTED The SCSI channel does not support a target reset operation.
2429 @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the SCSI device
2430 specified by Target and Lun.
2431
2432 **/
2433 EFI_STATUS
2434 EFIAPI
2435 ExtScsiPassThruResetTargetLun (
2436 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,
2437 IN UINT8 *Target,
2438 IN UINT64 Lun
2439 )
2440 {
2441 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
2442 LIST_ENTRY *Node;
2443 UINT8 Port;
2444 UINT8 PortMultiplier;
2445
2446 Instance = EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
2447 //
2448 // For ATAPI device, doesn't support multiple LUN device.
2449 //
2450 if (Lun != 0) {
2451 return EFI_INVALID_PARAMETER;
2452 }
2453 //
2454 // The layout of Target array:
2455 // ________________________________________________________________________
2456 // | Byte 0 | Byte 1 | ... | TARGET_MAX_BYTES - 1 |
2457 // |_____________________|_____________________|_____|______________________|
2458 // | | The port multiplier | | |
2459 // | The port number | port number | N/A | N/A |
2460 // |_____________________|_____________________|_____|______________________|
2461 //
2462 // For ATAPI device, 2 bytes is enough to represent the location of SCSI device.
2463 //
2464 Port = Target[0];
2465 PortMultiplier = Target[1];
2466
2467 Node = SearchDeviceInfoList(Instance, Port, PortMultiplier, EfiIdeCdrom);
2468 if (Node == NULL) {
2469 return EFI_INVALID_PARAMETER;
2470 }
2471
2472 //
2473 // Return success directly then upper layer driver could think reset target LUN operation is done.
2474 //
2475 return EFI_SUCCESS;
2476 }
2477
2478 /**
2479 Used to retrieve the list of legal Target IDs for SCSI devices on a SCSI channel. These can either
2480 be the list SCSI devices that are actually present on the SCSI channel, or the list of legal Target IDs
2481 for the SCSI channel. Regardless, the caller of this function must probe the Target ID returned to
2482 see if a SCSI device is actually present at that location on the SCSI channel.
2483
2484 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
2485 @param Target (TARGET_MAX_BYTES) of a SCSI device present on the SCSI channel.
2486 On output, a pointer to the Target ID (an array of
2487 TARGET_MAX_BYTES) of the next SCSI device present on a SCSI
2488 channel. An input value of 0xF(all bytes in the array are 0xF) in the
2489 Target array retrieves the Target ID of the first SCSI device present on a
2490 SCSI channel.
2491
2492 @retval EFI_SUCCESS The Target ID of the next SCSI device on the SCSI
2493 channel was returned in Target.
2494 @retval EFI_INVALID_PARAMETER Target or Lun is NULL.
2495 @retval EFI_TIMEOUT Target array is not all 0xF, and Target was not
2496 returned on a previous call to GetNextTarget().
2497 @retval EFI_NOT_FOUND There are no more SCSI devices on this SCSI channel.
2498
2499 **/
2500 EFI_STATUS
2501 EFIAPI
2502 ExtScsiPassThruGetNextTarget (
2503 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,
2504 IN OUT UINT8 **Target
2505 )
2506 {
2507 ATA_ATAPI_PASS_THRU_INSTANCE *Instance;
2508 LIST_ENTRY *Node;
2509 EFI_ATA_DEVICE_INFO *DeviceInfo;
2510 UINT8 *Target8;
2511 UINT16 *Target16;
2512
2513 Instance = EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS (This);
2514
2515 if (Target == NULL || *Target == NULL) {
2516 return EFI_INVALID_PARAMETER;
2517 }
2518
2519 Target8 = *Target;
2520 Target16 = (UINT16 *)*Target;
2521
2522 if (CompareMem(Target8, mScsiId, TARGET_MAX_BYTES) != 0) {
2523 //
2524 // For ATAPI device, we use 2 least significant bytes to represent the location of SCSI device.
2525 // So the higher bytes in Target array should be 0xFF.
2526 //
2527 if (CompareMem (&Target8[2], &mScsiId[2], TARGET_MAX_BYTES - 2) != 0) {
2528 return EFI_INVALID_PARAMETER;
2529 }
2530
2531 //
2532 // When Target is not all 0xFF's, compare 2 least significant bytes with
2533 // previous target id to see if it is returned by previous call.
2534 //
2535 if (*Target16 != Instance->PreviousTargetId) {
2536 return EFI_INVALID_PARAMETER;
2537 }
2538
2539 //
2540 // Traverse the whole device list to find the next cdrom closed to
2541 // the device signified by Target[0] and Target[1].
2542 //
2543 // Note that we here use a tricky way to find the next cdrom :
2544 // All ata devices are detected and inserted into the device list
2545 // sequentially.
2546 //
2547 Node = GetFirstNode (&Instance->DeviceList);
2548 while (!IsNull (&Instance->DeviceList, Node)) {
2549 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
2550
2551 if ((DeviceInfo->Type == EfiIdeCdrom) &&
2552 ((Target8[0] < DeviceInfo->Port) ||
2553 ((Target8[0] == DeviceInfo->Port) &&
2554 (Target8[1] < DeviceInfo->PortMultiplier)))) {
2555 Target8[0] = (UINT8)DeviceInfo->Port;
2556 Target8[1] = (UINT8)DeviceInfo->PortMultiplier;
2557 goto Exit;
2558 }
2559
2560 Node = GetNextNode (&Instance->DeviceList, Node);
2561 }
2562
2563 return EFI_NOT_FOUND;
2564 } else {
2565 //
2566 // If the array is all 0xFF's, start to traverse the device list from the beginning
2567 //
2568 Node = GetFirstNode (&Instance->DeviceList);
2569
2570 while (!IsNull (&Instance->DeviceList, Node)) {
2571 DeviceInfo = ATA_ATAPI_DEVICE_INFO_FROM_THIS (Node);
2572
2573 if (DeviceInfo->Type == EfiIdeCdrom) {
2574 Target8[0] = (UINT8)DeviceInfo->Port;
2575 Target8[1] = (UINT8)DeviceInfo->PortMultiplier;
2576 goto Exit;
2577 }
2578
2579 Node = GetNextNode (&Instance->DeviceList, Node);
2580 }
2581
2582 return EFI_NOT_FOUND;
2583 }
2584
2585 Exit:
2586 //
2587 // Update the PreviousTargetId.
2588 //
2589 Instance->PreviousTargetId = *Target16;
2590
2591 return EFI_SUCCESS;
2592 }
2593
EFI Development Kit II mirror for PVE