3 Copyright (c) 2014 - 2018, Intel Corporation. All rights reserved.<BR>
4 SPDX-License-Identifier: BSD-2-Clause-Patent
8 #include "UfsPassThru.h"
11 // Template for Ufs Pass Thru private data.
13 UFS_PASS_THRU_PRIVATE_DATA gUfsPassThruTemplate
= {
14 UFS_PASS_THRU_SIG
, // Signature
16 { // ExtScsiPassThruMode
18 EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL
| EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL
| EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_NONBLOCKIO
,
24 UfsPassThruGetNextTargetLun
,
25 UfsPassThruBuildDevicePath
,
26 UfsPassThruGetTargetLun
,
27 UfsPassThruResetChannel
,
28 UfsPassThruResetTargetLun
,
29 UfsPassThruGetNextTarget
36 0, // UfsHostController
48 UFS_LUN_0
, // Ufs Common Lun 0
49 UFS_LUN_1
, // Ufs Common Lun 1
50 UFS_LUN_2
, // Ufs Common Lun 2
51 UFS_LUN_3
, // Ufs Common Lun 3
52 UFS_LUN_4
, // Ufs Common Lun 4
53 UFS_LUN_5
, // Ufs Common Lun 5
54 UFS_LUN_6
, // Ufs Common Lun 6
55 UFS_LUN_7
, // Ufs Common Lun 7
56 UFS_WLUN_REPORT_LUNS
, // Ufs Reports Luns Well Known Lun
57 UFS_WLUN_UFS_DEV
, // Ufs Device Well Known Lun
58 UFS_WLUN_BOOT
, // Ufs Boot Well Known Lun
59 UFS_WLUN_RPMB
// RPMB Well Known Lun
61 0x0000, // By default don't expose any Luns.
71 EFI_DRIVER_BINDING_PROTOCOL gUfsPassThruDriverBinding
= {
72 UfsPassThruDriverBindingSupported
,
73 UfsPassThruDriverBindingStart
,
74 UfsPassThruDriverBindingStop
,
80 UFS_DEVICE_PATH mUfsDevicePathTemplate
= {
82 MESSAGING_DEVICE_PATH
,
85 (UINT8
) (sizeof (UFS_DEVICE_PATH
)),
86 (UINT8
) ((sizeof (UFS_DEVICE_PATH
)) >> 8)
93 UINT8 mUfsTargetId
[TARGET_MAX_BYTES
];
96 Sends a SCSI Request Packet to a SCSI device that is attached to the SCSI channel. This function
97 supports both blocking I/O and nonblocking I/O. The blocking I/O functionality is required, and the
98 nonblocking I/O functionality is optional.
100 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
101 @param Target The Target is an array of size TARGET_MAX_BYTES and it represents
102 the id of the SCSI device to send the SCSI Request Packet. Each
103 transport driver may choose to utilize a subset of this size to suit the needs
104 of transport target representation. For example, a Fibre Channel driver
105 may use only 8 bytes (WWN) to represent an FC target.
106 @param Lun The LUN of the SCSI device to send the SCSI Request Packet.
107 @param Packet A pointer to the SCSI Request Packet to send to the SCSI device
108 specified by Target and Lun.
109 @param Event If nonblocking I/O is not supported then Event is ignored, and blocking
110 I/O is performed. If Event is NULL, then blocking I/O is performed. If
111 Event is not NULL and non blocking I/O is supported, then
112 nonblocking I/O is performed, and Event will be signaled when the
113 SCSI Request Packet completes.
115 @retval EFI_SUCCESS The SCSI Request Packet was sent by the host. For bi-directional
116 commands, InTransferLength bytes were transferred from
117 InDataBuffer. For write and bi-directional commands,
118 OutTransferLength bytes were transferred by
120 @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was not executed. The number of bytes that
121 could be transferred is returned in InTransferLength. For write
122 and bi-directional commands, OutTransferLength bytes were
123 transferred by OutDataBuffer.
124 @retval EFI_NOT_READY The SCSI Request Packet could not be sent because there are too many
125 SCSI Request Packets already queued. The caller may retry again later.
126 @retval EFI_DEVICE_ERROR A device error occurred while attempting to send the SCSI Request
128 @retval EFI_INVALID_PARAMETER Target, Lun, or the contents of ScsiRequestPacket are invalid.
129 @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported
130 by the host adapter. This includes the case of Bi-directional SCSI
131 commands not supported by the implementation. The SCSI Request
132 Packet was not sent, so no additional status information is available.
133 @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
138 UfsPassThruPassThru (
139 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
142 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
,
143 IN EFI_EVENT Event OPTIONAL
147 UFS_PASS_THRU_PRIVATE_DATA
*Private
;
151 Private
= UFS_PASS_THRU_PRIVATE_DATA_FROM_THIS (This
);
153 if ((Packet
== NULL
) || (Packet
->Cdb
== NULL
)) {
154 return EFI_INVALID_PARAMETER
;
158 // Don't support variable length CDB
160 if ((Packet
->CdbLength
!= 6) && (Packet
->CdbLength
!= 10) &&
161 (Packet
->CdbLength
!= 12) && (Packet
->CdbLength
!= 16)) {
162 return EFI_INVALID_PARAMETER
;
165 if ((Packet
->SenseDataLength
!= 0) && (Packet
->SenseData
== NULL
)) {
166 return EFI_INVALID_PARAMETER
;
169 if ((This
->Mode
->IoAlign
> 1) && !IS_ALIGNED(Packet
->InDataBuffer
, This
->Mode
->IoAlign
)) {
170 return EFI_INVALID_PARAMETER
;
173 if ((This
->Mode
->IoAlign
> 1) && !IS_ALIGNED(Packet
->OutDataBuffer
, This
->Mode
->IoAlign
)) {
174 return EFI_INVALID_PARAMETER
;
177 if ((This
->Mode
->IoAlign
> 1) && !IS_ALIGNED(Packet
->SenseData
, This
->Mode
->IoAlign
)) {
178 return EFI_INVALID_PARAMETER
;
182 // For UFS 2.0 compatible device, 0 is always used to represent the location of the UFS device.
184 SetMem (mUfsTargetId
, TARGET_MAX_BYTES
, 0x00);
185 if ((Target
== NULL
) || (CompareMem(Target
, mUfsTargetId
, TARGET_MAX_BYTES
) != 0)) {
186 return EFI_INVALID_PARAMETER
;
190 // UFS 2.0 spec Section 10.6.7 - Translation of 8-bit UFS LUN to 64-bit SCSI LUN Address
191 // 0xC1 in the first 8 bits of the 64-bit address indicates a well known LUN address in the SAM SCSI format.
192 // The second 8 bits of the 64-bit address saves the corresponding 8-bit UFS LUN.
194 if ((UINT8
)Lun
== UFS_WLUN_PREFIX
) {
195 UfsLun
= BIT7
| (((UINT8
*)&Lun
)[1] & 0xFF);
196 } else if ((UINT8
)Lun
== 0) {
197 UfsLun
= ((UINT8
*)&Lun
)[1] & 0xFF;
199 return EFI_INVALID_PARAMETER
;
202 for (Index
= 0; Index
< UFS_MAX_LUNS
; Index
++) {
203 if ((Private
->Luns
.BitMask
& (BIT0
<< Index
)) == 0) {
207 if (Private
->Luns
.Lun
[Index
] == UfsLun
) {
212 if (Index
== UFS_MAX_LUNS
) {
213 return EFI_INVALID_PARAMETER
;
216 Status
= UfsExecScsiCmds (Private
, UfsLun
, Packet
, Event
);
222 Used to retrieve the list of legal Target IDs and LUNs for SCSI devices on a SCSI channel. These
223 can either be the list SCSI devices that are actually present on the SCSI channel, or the list of legal
224 Target Ids and LUNs for the SCSI channel. Regardless, the caller of this function must probe the
225 Target ID and LUN returned to see if a SCSI device is actually present at that location on the SCSI
228 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
229 @param Target On input, a pointer to the Target ID (an array of size
230 TARGET_MAX_BYTES) of a SCSI device present on the SCSI channel.
231 On output, a pointer to the Target ID (an array of
232 TARGET_MAX_BYTES) of the next SCSI device present on a SCSI
233 channel. An input value of 0xF(all bytes in the array are 0xF) in the
234 Target array retrieves the Target ID of the first SCSI device present on a
236 @param Lun On input, a pointer to the LUN of a SCSI device present on the SCSI
237 channel. On output, a pointer to the LUN of the next SCSI device present
240 @retval EFI_SUCCESS The Target ID and LUN of the next SCSI device on the SCSI
241 channel was returned in Target and Lun.
242 @retval EFI_INVALID_PARAMETER Target array is not all 0xF, and Target and Lun were
243 not returned on a previous call to GetNextTargetLun().
244 @retval EFI_NOT_FOUND There are no more SCSI devices on this SCSI channel.
249 UfsPassThruGetNextTargetLun (
250 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
251 IN OUT UINT8
**Target
,
255 UFS_PASS_THRU_PRIVATE_DATA
*Private
;
260 Private
= UFS_PASS_THRU_PRIVATE_DATA_FROM_THIS (This
);
262 if (Target
== NULL
|| Lun
== NULL
) {
263 return EFI_INVALID_PARAMETER
;
266 if (*Target
== NULL
) {
267 return EFI_INVALID_PARAMETER
;
271 SetMem (mUfsTargetId
, TARGET_MAX_BYTES
, 0xFF);
272 if (CompareMem (*Target
, mUfsTargetId
, TARGET_MAX_BYTES
) == 0) {
274 // If the array is all 0xFF's, return the first exposed Lun to caller.
276 SetMem (*Target
, TARGET_MAX_BYTES
, 0x00);
277 for (Index
= 0; Index
< UFS_MAX_LUNS
; Index
++) {
278 if ((Private
->Luns
.BitMask
& (BIT0
<< Index
)) != 0) {
279 UfsLun
= Private
->Luns
.Lun
[Index
];
283 if (Index
!= UFS_MAX_LUNS
) {
285 if ((UfsLun
& BIT7
) == BIT7
) {
286 ((UINT8
*)Lun
)[0] = UFS_WLUN_PREFIX
;
287 ((UINT8
*)Lun
)[1] = UfsLun
& ~BIT7
;
289 ((UINT8
*)Lun
)[1] = UfsLun
;
293 return EFI_NOT_FOUND
;
297 SetMem (mUfsTargetId
, TARGET_MAX_BYTES
, 0x00);
298 if (CompareMem (*Target
, mUfsTargetId
, TARGET_MAX_BYTES
) == 0) {
299 if (((UINT8
*)Lun
)[0] == UFS_WLUN_PREFIX
) {
300 UfsLun
= BIT7
| (((UINT8
*)Lun
)[1] & 0xFF);
301 } else if (((UINT8
*)Lun
)[0] == 0) {
302 UfsLun
= ((UINT8
*)Lun
)[1] & 0xFF;
304 return EFI_NOT_FOUND
;
307 for (Index
= 0; Index
< UFS_MAX_LUNS
; Index
++) {
308 if ((Private
->Luns
.BitMask
& (BIT0
<< Index
)) == 0) {
312 if (Private
->Luns
.Lun
[Index
] != UfsLun
) {
316 for (Next
= Index
+ 1; Next
< UFS_MAX_LUNS
; Next
++) {
317 if ((Private
->Luns
.BitMask
& (BIT0
<< Next
)) != 0) {
318 UfsLun
= Private
->Luns
.Lun
[Next
];
323 if (Next
== UFS_MAX_LUNS
) {
324 return EFI_NOT_FOUND
;
330 if (Index
!= UFS_MAX_LUNS
) {
332 if ((UfsLun
& BIT7
) == BIT7
) {
333 ((UINT8
*)Lun
)[0] = UFS_WLUN_PREFIX
;
334 ((UINT8
*)Lun
)[1] = UfsLun
& ~BIT7
;
336 ((UINT8
*)Lun
)[1] = UfsLun
;
340 return EFI_NOT_FOUND
;
344 return EFI_NOT_FOUND
;
348 Used to allocate and build a device path node for a SCSI device on a SCSI channel.
350 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
351 @param Target The Target is an array of size TARGET_MAX_BYTES and it specifies the
352 Target ID of the SCSI device for which a device path node is to be
353 allocated and built. Transport drivers may chose to utilize a subset of
354 this size to suit the representation of targets. For example, a Fibre
355 Channel driver may use only 8 bytes (WWN) in the array to represent a
357 @param Lun The LUN of the SCSI device for which a device path node is to be
359 @param DevicePath A pointer to a single device path node that describes the SCSI device
360 specified by Target and Lun. This function is responsible for
361 allocating the buffer DevicePath with the boot service
362 AllocatePool(). It is the caller's responsibility to free
363 DevicePath when the caller is finished with DevicePath.
365 @retval EFI_SUCCESS The device path node that describes the SCSI device specified by
366 Target and Lun was allocated and returned in
368 @retval EFI_INVALID_PARAMETER DevicePath is NULL.
369 @retval EFI_NOT_FOUND The SCSI devices specified by Target and Lun does not exist
371 @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate DevicePath.
376 UfsPassThruBuildDevicePath (
377 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
380 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
383 UFS_PASS_THRU_PRIVATE_DATA
*Private
;
384 EFI_DEV_PATH
*DevicePathNode
;
388 Private
= UFS_PASS_THRU_PRIVATE_DATA_FROM_THIS (This
);
391 // Validate parameters passed in.
393 SetMem (mUfsTargetId
, TARGET_MAX_BYTES
, 0x00);
394 if (CompareMem (Target
, mUfsTargetId
, TARGET_MAX_BYTES
) != 0) {
395 return EFI_INVALID_PARAMETER
;
398 if ((UINT8
)Lun
== UFS_WLUN_PREFIX
) {
399 UfsLun
= BIT7
| (((UINT8
*)&Lun
)[1] & 0xFF);
400 } else if ((UINT8
)Lun
== 0) {
401 UfsLun
= ((UINT8
*)&Lun
)[1] & 0xFF;
403 return EFI_NOT_FOUND
;
406 for (Index
= 0; Index
< UFS_MAX_LUNS
; Index
++) {
407 if ((Private
->Luns
.BitMask
& (BIT0
<< Index
)) == 0) {
411 if (Private
->Luns
.Lun
[Index
] == UfsLun
) {
416 if (Index
== UFS_MAX_LUNS
) {
417 return EFI_NOT_FOUND
;
420 DevicePathNode
= AllocateCopyPool (sizeof (UFS_DEVICE_PATH
), &mUfsDevicePathTemplate
);
421 if (DevicePathNode
== NULL
) {
422 return EFI_OUT_OF_RESOURCES
;
425 DevicePathNode
->Ufs
.Pun
= 0;
426 DevicePathNode
->Ufs
.Lun
= UfsLun
;
428 *DevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) DevicePathNode
;
434 Used to translate a device path node to a Target ID and LUN.
436 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
437 @param DevicePath A pointer to a single device path node that describes the SCSI device
439 @param Target A pointer to the Target Array which represents the ID of a SCSI device
441 @param Lun A pointer to the LUN of a SCSI device on the SCSI channel.
443 @retval EFI_SUCCESS DevicePath was successfully translated to a Target ID and
444 LUN, and they were returned in Target and Lun.
445 @retval EFI_INVALID_PARAMETER DevicePath or Target or Lun is NULL.
446 @retval EFI_NOT_FOUND A valid translation from DevicePath to a Target ID and LUN
448 @retval EFI_UNSUPPORTED This driver does not support the device path node type in
454 UfsPassThruGetTargetLun (
455 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
456 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
461 UFS_PASS_THRU_PRIVATE_DATA
*Private
;
462 EFI_DEV_PATH
*DevicePathNode
;
467 Private
= UFS_PASS_THRU_PRIVATE_DATA_FROM_THIS (This
);
470 // Validate parameters passed in.
472 if (DevicePath
== NULL
|| Target
== NULL
|| Lun
== NULL
) {
473 return EFI_INVALID_PARAMETER
;
476 if (*Target
== NULL
) {
477 return EFI_INVALID_PARAMETER
;
481 // Check whether the DevicePath belongs to UFS_DEVICE_PATH
483 if ((DevicePath
->Type
!= MESSAGING_DEVICE_PATH
) || (DevicePath
->SubType
!= MSG_UFS_DP
) ||
484 (DevicePathNodeLength(DevicePath
) != sizeof(UFS_DEVICE_PATH
))) {
485 return EFI_UNSUPPORTED
;
488 DevicePathNode
= (EFI_DEV_PATH
*) DevicePath
;
490 Pun
= (UINT8
) DevicePathNode
->Ufs
.Pun
;
491 UfsLun
= (UINT8
) DevicePathNode
->Ufs
.Lun
;
494 return EFI_NOT_FOUND
;
497 for (Index
= 0; Index
< UFS_MAX_LUNS
; Index
++) {
498 if ((Private
->Luns
.BitMask
& (BIT0
<< Index
)) == 0) {
502 if (Private
->Luns
.Lun
[Index
] == UfsLun
) {
507 if (Index
== UFS_MAX_LUNS
) {
508 return EFI_NOT_FOUND
;
511 SetMem (*Target
, TARGET_MAX_BYTES
, 0x00);
513 if ((UfsLun
& BIT7
) == BIT7
) {
514 ((UINT8
*)Lun
)[0] = UFS_WLUN_PREFIX
;
515 ((UINT8
*)Lun
)[1] = UfsLun
& ~BIT7
;
517 ((UINT8
*)Lun
)[1] = UfsLun
;
523 Resets a SCSI channel. This operation resets all the SCSI devices connected to the SCSI channel.
525 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
527 @retval EFI_SUCCESS The SCSI channel was reset.
528 @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the SCSI channel.
529 @retval EFI_TIMEOUT A timeout occurred while attempting to reset the SCSI channel.
530 @retval EFI_UNSUPPORTED The SCSI channel does not support a channel reset operation.
535 UfsPassThruResetChannel (
536 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
540 // Return success directly then upper layer driver could think reset channel operation is done.
546 Resets a SCSI logical unit that is connected to a SCSI channel.
548 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
549 @param Target The Target is an array of size TARGET_MAX_BYTE and it represents the
550 target port ID of the SCSI device containing the SCSI logical unit to
551 reset. Transport drivers may chose to utilize a subset of this array to suit
552 the representation of their targets.
553 @param Lun The LUN of the SCSI device to reset.
555 @retval EFI_SUCCESS The SCSI device specified by Target and Lun was reset.
556 @retval EFI_INVALID_PARAMETER Target or Lun is NULL.
557 @retval EFI_TIMEOUT A timeout occurred while attempting to reset the SCSI device
558 specified by Target and Lun.
559 @retval EFI_UNSUPPORTED The SCSI channel does not support a target reset operation.
560 @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the SCSI device
561 specified by Target and Lun.
566 UfsPassThruResetTargetLun (
567 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
573 // Return success directly then upper layer driver could think reset target LUN operation is done.
579 Used to retrieve the list of legal Target IDs for SCSI devices on a SCSI channel. These can either
580 be the list SCSI devices that are actually present on the SCSI channel, or the list of legal Target IDs
581 for the SCSI channel. Regardless, the caller of this function must probe the Target ID returned to
582 see if a SCSI device is actually present at that location on the SCSI channel.
584 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
585 @param Target (TARGET_MAX_BYTES) of a SCSI device present on the SCSI channel.
586 On output, a pointer to the Target ID (an array of
587 TARGET_MAX_BYTES) of the next SCSI device present on a SCSI
588 channel. An input value of 0xF(all bytes in the array are 0xF) in the
589 Target array retrieves the Target ID of the first SCSI device present on a
592 @retval EFI_SUCCESS The Target ID of the next SCSI device on the SCSI
593 channel was returned in Target.
594 @retval EFI_INVALID_PARAMETER Target or Lun is NULL.
595 @retval EFI_TIMEOUT Target array is not all 0xF, and Target was not
596 returned on a previous call to GetNextTarget().
597 @retval EFI_NOT_FOUND There are no more SCSI devices on this SCSI channel.
602 UfsPassThruGetNextTarget (
603 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
604 IN OUT UINT8
**Target
607 if (Target
== NULL
|| *Target
== NULL
) {
608 return EFI_INVALID_PARAMETER
;
611 SetMem (mUfsTargetId
, TARGET_MAX_BYTES
, 0xFF);
612 if (CompareMem(*Target
, mUfsTargetId
, TARGET_MAX_BYTES
) == 0) {
613 SetMem (*Target
, TARGET_MAX_BYTES
, 0x00);
617 return EFI_NOT_FOUND
;
621 Tests to see if this driver supports a given controller. If a child device is provided,
622 it further tests to see if this driver supports creating a handle for the specified child device.
624 This function checks to see if the driver specified by This supports the device specified by
625 ControllerHandle. Drivers will typically use the device path attached to
626 ControllerHandle and/or the services from the bus I/O abstraction attached to
627 ControllerHandle to determine if the driver supports ControllerHandle. This function
628 may be called many times during platform initialization. In order to reduce boot times, the tests
629 performed by this function must be very small, and take as little time as possible to execute. This
630 function must not change the state of any hardware devices, and this function must be aware that the
631 device specified by ControllerHandle may already be managed by the same driver or a
632 different driver. This function must match its calls to AllocatePages() with FreePages(),
633 AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol().
634 Since ControllerHandle may have been previously started by the same driver, if a protocol is
635 already in the opened state, then it must not be closed with CloseProtocol(). This is required
636 to guarantee the state of ControllerHandle is not modified by this function.
638 @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
639 @param[in] ControllerHandle The handle of the controller to test. This handle
640 must support a protocol interface that supplies
641 an I/O abstraction to the driver.
642 @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This
643 parameter is ignored by device drivers, and is optional for bus
644 drivers. For bus drivers, if this parameter is not NULL, then
645 the bus driver must determine if the bus controller specified
646 by ControllerHandle and the child controller specified
647 by RemainingDevicePath are both supported by this
650 @retval EFI_SUCCESS The device specified by ControllerHandle and
651 RemainingDevicePath is supported by the driver specified by This.
652 @retval EFI_ALREADY_STARTED The device specified by ControllerHandle and
653 RemainingDevicePath is already being managed by the driver
655 @retval EFI_ACCESS_DENIED The device specified by ControllerHandle and
656 RemainingDevicePath is already being managed by a different
657 driver or an application that requires exclusive access.
658 Currently not implemented.
659 @retval EFI_UNSUPPORTED The device specified by ControllerHandle and
660 RemainingDevicePath is not supported by the driver specified by This.
664 UfsPassThruDriverBindingSupported (
665 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
666 IN EFI_HANDLE Controller
,
667 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
671 EFI_DEVICE_PATH_PROTOCOL
*ParentDevicePath
;
672 EDKII_UFS_HOST_CONTROLLER_PROTOCOL
*UfsHostController
;
675 // Ufs Pass Thru driver is a device driver, and should ingore the
676 // "RemainingDevicePath" according to UEFI spec
678 Status
= gBS
->OpenProtocol (
680 &gEfiDevicePathProtocolGuid
,
681 (VOID
*) &ParentDevicePath
,
682 This
->DriverBindingHandle
,
684 EFI_OPEN_PROTOCOL_BY_DRIVER
686 if (EFI_ERROR (Status
)) {
688 // EFI_ALREADY_STARTED is also an error
693 // Close the protocol because we don't use it here
697 &gEfiDevicePathProtocolGuid
,
698 This
->DriverBindingHandle
,
702 Status
= gBS
->OpenProtocol (
704 &gEdkiiUfsHostControllerProtocolGuid
,
705 (VOID
**) &UfsHostController
,
706 This
->DriverBindingHandle
,
708 EFI_OPEN_PROTOCOL_BY_DRIVER
711 if (EFI_ERROR (Status
)) {
713 // EFI_ALREADY_STARTED is also an error
719 // Close the I/O Abstraction(s) used to perform the supported test
723 &gEdkiiUfsHostControllerProtocolGuid
,
724 This
->DriverBindingHandle
,
732 Finishes device initialization by setting fDeviceInit flag and waiting untill device responds by
735 @param[in] Private Pointer to the UFS_PASS_THRU_PRIVATE_DATA.
737 @retval EFI_SUCCESS The operation succeeds.
738 @retval Others The operation fails.
742 UfsFinishDeviceInitialization (
743 IN UFS_PASS_THRU_PRIVATE_DATA
*Private
747 UINT8 DeviceInitStatus
;
750 DeviceInitStatus
= 0xFF;
753 // The host enables the device initialization completion by setting fDeviceInit flag.
755 Status
= UfsSetFlag (Private
, UfsFlagDevInit
);
756 if (EFI_ERROR (Status
)) {
762 Status
= UfsReadFlag (Private
, UfsFlagDevInit
, &DeviceInitStatus
);
763 if (EFI_ERROR (Status
)) {
766 MicroSecondDelay (1);
768 } while (DeviceInitStatus
!= 0 && Timeout
!= 0);
774 Starts a device controller or a bus controller.
776 The Start() function is designed to be invoked from the EFI boot service ConnectController().
777 As a result, much of the error checking on the parameters to Start() has been moved into this
778 common boot service. It is legal to call Start() from other locations,
779 but the following calling restrictions must be followed or the system behavior will not be deterministic.
780 1. ControllerHandle must be a valid EFI_HANDLE.
781 2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned
782 EFI_DEVICE_PATH_PROTOCOL.
783 3. Prior to calling Start(), the Supported() function for the driver specified by This must
784 have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.
786 @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
787 @param[in] ControllerHandle The handle of the controller to start. This handle
788 must support a protocol interface that supplies
789 an I/O abstraction to the driver.
790 @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This
791 parameter is ignored by device drivers, and is optional for bus
792 drivers. For a bus driver, if this parameter is NULL, then handles
793 for all the children of Controller are created by this driver.
794 If this parameter is not NULL and the first Device Path Node is
795 not the End of Device Path Node, then only the handle for the
796 child device specified by the first Device Path Node of
797 RemainingDevicePath is created by this driver.
798 If the first Device Path Node of RemainingDevicePath is
799 the End of Device Path Node, no child handle is created by this
802 @retval EFI_SUCCESS The device was started.
803 @retval EFI_DEVICE_ERROR The device could not be started due to a device error.Currently not implemented.
804 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
805 @retval Others The driver failded to start the device.
810 UfsPassThruDriverBindingStart (
811 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
812 IN EFI_HANDLE Controller
,
813 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
817 EDKII_UFS_HOST_CONTROLLER_PROTOCOL
*UfsHc
;
818 UFS_PASS_THRU_PRIVATE_DATA
*Private
;
821 UFS_UNIT_DESC UnitDescriptor
;
822 UINT32 UnitDescriptorSize
;
824 Status
= EFI_SUCCESS
;
829 DEBUG ((DEBUG_INFO
, "==UfsPassThru Start== Controller = %x\n", Controller
));
831 Status
= gBS
->OpenProtocol (
833 &gEdkiiUfsHostControllerProtocolGuid
,
835 This
->DriverBindingHandle
,
837 EFI_OPEN_PROTOCOL_BY_DRIVER
840 if (EFI_ERROR (Status
)) {
841 DEBUG ((DEBUG_ERROR
, "Open Ufs Host Controller Protocol Error, Status = %r\n", Status
));
846 // Get the UFS Host Controller MMIO Bar Base Address.
848 Status
= UfsHc
->GetUfsHcMmioBar (UfsHc
, &UfsHcBase
);
849 if (EFI_ERROR (Status
)) {
850 DEBUG ((DEBUG_ERROR
, "Get Ufs Host Controller Mmio Bar Error, Status = %r\n", Status
));
855 // Initialize Ufs Pass Thru private data for managed UFS Host Controller.
857 Private
= AllocateCopyPool (sizeof (UFS_PASS_THRU_PRIVATE_DATA
), &gUfsPassThruTemplate
);
858 if (Private
== NULL
) {
859 DEBUG ((DEBUG_ERROR
, "Unable to allocate Ufs Pass Thru private data\n"));
860 Status
= EFI_OUT_OF_RESOURCES
;
864 Private
->ExtScsiPassThru
.Mode
= &Private
->ExtScsiPassThruMode
;
865 Private
->UfsHostController
= UfsHc
;
866 Private
->UfsHcBase
= UfsHcBase
;
867 InitializeListHead (&Private
->Queue
);
870 // Initialize UFS Host Controller H/W.
872 Status
= UfsControllerInit (Private
);
873 if (EFI_ERROR (Status
)) {
874 DEBUG ((DEBUG_ERROR
, "Ufs Host Controller Initialization Error, Status = %r\n", Status
));
879 // UFS 2.0 spec Section 13.1.3.3:
880 // At the end of the UFS Interconnect Layer initialization on both host and device side,
881 // the host shall send a NOP OUT UPIU to verify that the device UTP Layer is ready.
883 Status
= UfsExecNopCmds (Private
);
884 if (EFI_ERROR (Status
)) {
885 DEBUG ((DEBUG_ERROR
, "Ufs Sending NOP IN command Error, Status = %r\n", Status
));
889 Status
= UfsFinishDeviceInitialization (Private
);
890 if (EFI_ERROR (Status
)) {
891 DEBUG ((DEBUG_ERROR
, "Device failed to finish initialization, Status = %r\n", Status
));
896 // Check if 8 common luns are active and set corresponding bit mask.
897 // TODO: Parse device descriptor to decide if exposing RPMB LUN to upper layer for authentication access.
899 UnitDescriptorSize
= sizeof (UFS_UNIT_DESC
);
900 for (Index
= 0; Index
< 8; Index
++) {
901 Status
= UfsRwDeviceDesc (Private
, TRUE
, UfsUnitDesc
, (UINT8
) Index
, 0, &UnitDescriptor
, &UnitDescriptorSize
);
902 if (EFI_ERROR (Status
)) {
903 DEBUG ((DEBUG_ERROR
, "Failed to read unit descriptor, index = %X, status = %r\n", Index
, Status
));
906 if (UnitDescriptor
.LunEn
== 0x1) {
907 DEBUG ((DEBUG_INFO
, "UFS LUN %X is enabled\n", Index
));
908 Private
->Luns
.BitMask
|= (BIT0
<< Index
);
913 // Start the asynchronous interrupt monitor
915 Status
= gBS
->CreateEvent (
916 EVT_TIMER
| EVT_NOTIFY_SIGNAL
,
918 ProcessAsyncTaskList
,
922 if (EFI_ERROR (Status
)) {
923 DEBUG ((DEBUG_ERROR
, "Ufs Create Async Tasks Event Error, Status = %r\n", Status
));
927 Status
= gBS
->SetTimer (
932 if (EFI_ERROR (Status
)) {
933 DEBUG ((DEBUG_ERROR
, "Ufs Set Periodic Timer Error, Status = %r\n", Status
));
937 Status
= gBS
->InstallMultipleProtocolInterfaces (
939 &gEfiExtScsiPassThruProtocolGuid
,
940 &(Private
->ExtScsiPassThru
),
941 &gEfiUfsDeviceConfigProtocolGuid
,
942 &(Private
->UfsDevConfig
),
945 ASSERT_EFI_ERROR (Status
);
950 if (Private
!= NULL
) {
951 if (Private
->TmrlMapping
!= NULL
) {
952 UfsHc
->Unmap (UfsHc
, Private
->TmrlMapping
);
954 if (Private
->UtpTmrlBase
!= NULL
) {
955 UfsHc
->FreeBuffer (UfsHc
, EFI_SIZE_TO_PAGES (Private
->Nutmrs
* sizeof (UTP_TMRD
)), Private
->UtpTmrlBase
);
958 if (Private
->TrlMapping
!= NULL
) {
959 UfsHc
->Unmap (UfsHc
, Private
->TrlMapping
);
961 if (Private
->UtpTrlBase
!= NULL
) {
962 UfsHc
->FreeBuffer (UfsHc
, EFI_SIZE_TO_PAGES (Private
->Nutrs
* sizeof (UTP_TMRD
)), Private
->UtpTrlBase
);
965 if (Private
->TimerEvent
!= NULL
) {
966 gBS
->CloseEvent (Private
->TimerEvent
);
975 &gEdkiiUfsHostControllerProtocolGuid
,
976 This
->DriverBindingHandle
,
985 Stops a device controller or a bus controller.
987 The Stop() function is designed to be invoked from the EFI boot service DisconnectController().
988 As a result, much of the error checking on the parameters to Stop() has been moved
989 into this common boot service. It is legal to call Stop() from other locations,
990 but the following calling restrictions must be followed or the system behavior will not be deterministic.
991 1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this
992 same driver's Start() function.
993 2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid
994 EFI_HANDLE. In addition, all of these handles must have been created in this driver's
995 Start() function, and the Start() function must have called OpenProtocol() on
996 ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.
998 @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
999 @param[in] ControllerHandle A handle to the device being stopped. The handle must
1000 support a bus specific I/O protocol for the driver
1001 to use to stop the device.
1002 @param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer.
1003 @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL
1004 if NumberOfChildren is 0.
1006 @retval EFI_SUCCESS The device was stopped.
1007 @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.
1012 UfsPassThruDriverBindingStop (
1013 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1014 IN EFI_HANDLE Controller
,
1015 IN UINTN NumberOfChildren
,
1016 IN EFI_HANDLE
*ChildHandleBuffer
1020 UFS_PASS_THRU_PRIVATE_DATA
*Private
;
1021 EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*ExtScsiPassThru
;
1022 EDKII_UFS_HOST_CONTROLLER_PROTOCOL
*UfsHc
;
1023 UFS_PASS_THRU_TRANS_REQ
*TransReq
;
1025 LIST_ENTRY
*NextEntry
;
1027 DEBUG ((DEBUG_INFO
, "==UfsPassThru Stop== Controller Controller = %x\n", Controller
));
1029 Status
= gBS
->OpenProtocol (
1031 &gEfiExtScsiPassThruProtocolGuid
,
1032 (VOID
**) &ExtScsiPassThru
,
1033 This
->DriverBindingHandle
,
1035 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1038 if (EFI_ERROR (Status
)) {
1039 return EFI_DEVICE_ERROR
;
1042 Private
= UFS_PASS_THRU_PRIVATE_DATA_FROM_THIS (ExtScsiPassThru
);
1043 UfsHc
= Private
->UfsHostController
;
1046 // Cleanup the resources of I/O requests in the async I/O queue
1048 if (!IsListEmpty(&Private
->Queue
)) {
1049 EFI_LIST_FOR_EACH_SAFE (Entry
, NextEntry
, &Private
->Queue
) {
1050 TransReq
= UFS_PASS_THRU_TRANS_REQ_FROM_THIS (Entry
);
1053 // TODO: Should find/add a proper host adapter return status for this
1056 TransReq
->Packet
->HostAdapterStatus
=
1057 EFI_EXT_SCSI_STATUS_HOST_ADAPTER_PHASE_ERROR
;
1059 SignalCallerEvent (Private
, TransReq
);
1063 Status
= gBS
->UninstallMultipleProtocolInterfaces (
1065 &gEfiExtScsiPassThruProtocolGuid
,
1066 &(Private
->ExtScsiPassThru
),
1067 &gEfiUfsDeviceConfigProtocolGuid
,
1068 &(Private
->UfsDevConfig
),
1072 if (EFI_ERROR (Status
)) {
1073 return EFI_DEVICE_ERROR
;
1077 // Stop Ufs Host Controller
1079 Status
= UfsControllerStop (Private
);
1080 ASSERT_EFI_ERROR (Status
);
1082 if (Private
->TmrlMapping
!= NULL
) {
1083 UfsHc
->Unmap (UfsHc
, Private
->TmrlMapping
);
1085 if (Private
->UtpTmrlBase
!= NULL
) {
1086 UfsHc
->FreeBuffer (UfsHc
, EFI_SIZE_TO_PAGES (Private
->Nutmrs
* sizeof (UTP_TMRD
)), Private
->UtpTmrlBase
);
1089 if (Private
->TrlMapping
!= NULL
) {
1090 UfsHc
->Unmap (UfsHc
, Private
->TrlMapping
);
1092 if (Private
->UtpTrlBase
!= NULL
) {
1093 UfsHc
->FreeBuffer (UfsHc
, EFI_SIZE_TO_PAGES (Private
->Nutrs
* sizeof (UTP_TMRD
)), Private
->UtpTrlBase
);
1096 if (Private
->TimerEvent
!= NULL
) {
1097 gBS
->CloseEvent (Private
->TimerEvent
);
1103 // Close protocols opened by UfsPassThru controller driver
1105 gBS
->CloseProtocol (
1107 &gEdkiiUfsHostControllerProtocolGuid
,
1108 This
->DriverBindingHandle
,
1117 The user Entry Point for module UfsPassThru. The user code starts with this function.
1119 @param[in] ImageHandle The firmware allocated handle for the EFI image.
1120 @param[in] SystemTable A pointer to the EFI System Table.
1122 @retval EFI_SUCCESS The entry point is executed successfully.
1123 @retval other Some error occurs when executing this entry point.
1128 InitializeUfsPassThru (
1129 IN EFI_HANDLE ImageHandle
,
1130 IN EFI_SYSTEM_TABLE
*SystemTable
1136 // Install driver model protocol(s).
1138 Status
= EfiLibInstallDriverBindingComponentName2 (
1141 &gUfsPassThruDriverBinding
,
1143 &gUfsPassThruComponentName
,
1144 &gUfsPassThruComponentName2
1146 ASSERT_EFI_ERROR (Status
);