3 Copyright (c) 2014 - 2019, 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
39 {NULL
, NULL
}, // UfsHcDriverInterface
49 UFS_LUN_0
, // Ufs Common Lun 0
50 UFS_LUN_1
, // Ufs Common Lun 1
51 UFS_LUN_2
, // Ufs Common Lun 2
52 UFS_LUN_3
, // Ufs Common Lun 3
53 UFS_LUN_4
, // Ufs Common Lun 4
54 UFS_LUN_5
, // Ufs Common Lun 5
55 UFS_LUN_6
, // Ufs Common Lun 6
56 UFS_LUN_7
, // Ufs Common Lun 7
57 UFS_WLUN_REPORT_LUNS
, // Ufs Reports Luns Well Known Lun
58 UFS_WLUN_UFS_DEV
, // Ufs Device Well Known Lun
59 UFS_WLUN_BOOT
, // Ufs Boot Well Known Lun
60 UFS_WLUN_RPMB
// RPMB Well Known Lun
62 0x0000, // By default don't expose any Luns.
72 EFI_DRIVER_BINDING_PROTOCOL gUfsPassThruDriverBinding
= {
73 UfsPassThruDriverBindingSupported
,
74 UfsPassThruDriverBindingStart
,
75 UfsPassThruDriverBindingStop
,
81 UFS_DEVICE_PATH mUfsDevicePathTemplate
= {
83 MESSAGING_DEVICE_PATH
,
86 (UINT8
) (sizeof (UFS_DEVICE_PATH
)),
87 (UINT8
) ((sizeof (UFS_DEVICE_PATH
)) >> 8)
94 UINT8 mUfsTargetId
[TARGET_MAX_BYTES
];
96 GLOBAL_REMOVE_IF_UNREFERENCED EDKII_UFS_HC_PLATFORM_PROTOCOL
*mUfsHcPlatform
;
99 Sends a SCSI Request Packet to a SCSI device that is attached to the SCSI channel. This function
100 supports both blocking I/O and nonblocking I/O. The blocking I/O functionality is required, and the
101 nonblocking I/O functionality is optional.
103 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
104 @param Target The Target is an array of size TARGET_MAX_BYTES and it represents
105 the id of the SCSI device to send the SCSI Request Packet. Each
106 transport driver may choose to utilize a subset of this size to suit the needs
107 of transport target representation. For example, a Fibre Channel driver
108 may use only 8 bytes (WWN) to represent an FC target.
109 @param Lun The LUN of the SCSI device to send the SCSI Request Packet.
110 @param Packet A pointer to the SCSI Request Packet to send to the SCSI device
111 specified by Target and Lun.
112 @param Event If nonblocking I/O is not supported then Event is ignored, and blocking
113 I/O is performed. If Event is NULL, then blocking I/O is performed. If
114 Event is not NULL and non blocking I/O is supported, then
115 nonblocking I/O is performed, and Event will be signaled when the
116 SCSI Request Packet completes.
118 @retval EFI_SUCCESS The SCSI Request Packet was sent by the host. For bi-directional
119 commands, InTransferLength bytes were transferred from
120 InDataBuffer. For write and bi-directional commands,
121 OutTransferLength bytes were transferred by
123 @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was not executed. The number of bytes that
124 could be transferred is returned in InTransferLength. For write
125 and bi-directional commands, OutTransferLength bytes were
126 transferred by OutDataBuffer.
127 @retval EFI_NOT_READY The SCSI Request Packet could not be sent because there are too many
128 SCSI Request Packets already queued. The caller may retry again later.
129 @retval EFI_DEVICE_ERROR A device error occurred while attempting to send the SCSI Request
131 @retval EFI_INVALID_PARAMETER Target, Lun, or the contents of ScsiRequestPacket are invalid.
132 @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported
133 by the host adapter. This includes the case of Bi-directional SCSI
134 commands not supported by the implementation. The SCSI Request
135 Packet was not sent, so no additional status information is available.
136 @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
141 UfsPassThruPassThru (
142 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
145 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
,
146 IN EFI_EVENT Event OPTIONAL
150 UFS_PASS_THRU_PRIVATE_DATA
*Private
;
154 Private
= UFS_PASS_THRU_PRIVATE_DATA_FROM_THIS (This
);
156 if ((Packet
== NULL
) || (Packet
->Cdb
== NULL
)) {
157 return EFI_INVALID_PARAMETER
;
161 // Don't support variable length CDB
163 if ((Packet
->CdbLength
!= 6) && (Packet
->CdbLength
!= 10) &&
164 (Packet
->CdbLength
!= 12) && (Packet
->CdbLength
!= 16)) {
165 return EFI_INVALID_PARAMETER
;
168 if ((Packet
->SenseDataLength
!= 0) && (Packet
->SenseData
== NULL
)) {
169 return EFI_INVALID_PARAMETER
;
172 if ((This
->Mode
->IoAlign
> 1) && !IS_ALIGNED(Packet
->InDataBuffer
, This
->Mode
->IoAlign
)) {
173 return EFI_INVALID_PARAMETER
;
176 if ((This
->Mode
->IoAlign
> 1) && !IS_ALIGNED(Packet
->OutDataBuffer
, This
->Mode
->IoAlign
)) {
177 return EFI_INVALID_PARAMETER
;
180 if ((This
->Mode
->IoAlign
> 1) && !IS_ALIGNED(Packet
->SenseData
, This
->Mode
->IoAlign
)) {
181 return EFI_INVALID_PARAMETER
;
185 // For UFS 2.0 compatible device, 0 is always used to represent the location of the UFS device.
187 SetMem (mUfsTargetId
, TARGET_MAX_BYTES
, 0x00);
188 if ((Target
== NULL
) || (CompareMem(Target
, mUfsTargetId
, TARGET_MAX_BYTES
) != 0)) {
189 return EFI_INVALID_PARAMETER
;
193 // UFS 2.0 spec Section 10.6.7 - Translation of 8-bit UFS LUN to 64-bit SCSI LUN Address
194 // 0xC1 in the first 8 bits of the 64-bit address indicates a well known LUN address in the SAM SCSI format.
195 // The second 8 bits of the 64-bit address saves the corresponding 8-bit UFS LUN.
197 if ((UINT8
)Lun
== UFS_WLUN_PREFIX
) {
198 UfsLun
= BIT7
| (((UINT8
*)&Lun
)[1] & 0xFF);
199 } else if ((UINT8
)Lun
== 0) {
200 UfsLun
= ((UINT8
*)&Lun
)[1] & 0xFF;
202 return EFI_INVALID_PARAMETER
;
205 for (Index
= 0; Index
< UFS_MAX_LUNS
; Index
++) {
206 if ((Private
->Luns
.BitMask
& (BIT0
<< Index
)) == 0) {
210 if (Private
->Luns
.Lun
[Index
] == UfsLun
) {
215 if (Index
== UFS_MAX_LUNS
) {
216 return EFI_INVALID_PARAMETER
;
219 Status
= UfsExecScsiCmds (Private
, UfsLun
, Packet
, Event
);
225 Used to retrieve the list of legal Target IDs and LUNs for SCSI devices on a SCSI channel. These
226 can either be the list SCSI devices that are actually present on the SCSI channel, or the list of legal
227 Target Ids and LUNs for the SCSI channel. Regardless, the caller of this function must probe the
228 Target ID and LUN returned to see if a SCSI device is actually present at that location on the SCSI
231 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
232 @param Target On input, a pointer to the Target ID (an array of size
233 TARGET_MAX_BYTES) of a SCSI device present on the SCSI channel.
234 On output, a pointer to the Target ID (an array of
235 TARGET_MAX_BYTES) of the next SCSI device present on a SCSI
236 channel. An input value of 0xF(all bytes in the array are 0xF) in the
237 Target array retrieves the Target ID of the first SCSI device present on a
239 @param Lun On input, a pointer to the LUN of a SCSI device present on the SCSI
240 channel. On output, a pointer to the LUN of the next SCSI device present
243 @retval EFI_SUCCESS The Target ID and LUN of the next SCSI device on the SCSI
244 channel was returned in Target and Lun.
245 @retval EFI_INVALID_PARAMETER Target array is not all 0xF, and Target and Lun were
246 not returned on a previous call to GetNextTargetLun().
247 @retval EFI_NOT_FOUND There are no more SCSI devices on this SCSI channel.
252 UfsPassThruGetNextTargetLun (
253 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
254 IN OUT UINT8
**Target
,
258 UFS_PASS_THRU_PRIVATE_DATA
*Private
;
263 Private
= UFS_PASS_THRU_PRIVATE_DATA_FROM_THIS (This
);
265 if (Target
== NULL
|| Lun
== NULL
) {
266 return EFI_INVALID_PARAMETER
;
269 if (*Target
== NULL
) {
270 return EFI_INVALID_PARAMETER
;
274 SetMem (mUfsTargetId
, TARGET_MAX_BYTES
, 0xFF);
275 if (CompareMem (*Target
, mUfsTargetId
, TARGET_MAX_BYTES
) == 0) {
277 // If the array is all 0xFF's, return the first exposed Lun to caller.
279 SetMem (*Target
, TARGET_MAX_BYTES
, 0x00);
280 for (Index
= 0; Index
< UFS_MAX_LUNS
; Index
++) {
281 if ((Private
->Luns
.BitMask
& (BIT0
<< Index
)) != 0) {
282 UfsLun
= Private
->Luns
.Lun
[Index
];
286 if (Index
!= UFS_MAX_LUNS
) {
288 if ((UfsLun
& BIT7
) == BIT7
) {
289 ((UINT8
*)Lun
)[0] = UFS_WLUN_PREFIX
;
290 ((UINT8
*)Lun
)[1] = UfsLun
& ~BIT7
;
292 ((UINT8
*)Lun
)[1] = UfsLun
;
296 return EFI_NOT_FOUND
;
300 SetMem (mUfsTargetId
, TARGET_MAX_BYTES
, 0x00);
301 if (CompareMem (*Target
, mUfsTargetId
, TARGET_MAX_BYTES
) == 0) {
302 if (((UINT8
*)Lun
)[0] == UFS_WLUN_PREFIX
) {
303 UfsLun
= BIT7
| (((UINT8
*)Lun
)[1] & 0xFF);
304 } else if (((UINT8
*)Lun
)[0] == 0) {
305 UfsLun
= ((UINT8
*)Lun
)[1] & 0xFF;
307 return EFI_NOT_FOUND
;
310 for (Index
= 0; Index
< UFS_MAX_LUNS
; Index
++) {
311 if ((Private
->Luns
.BitMask
& (BIT0
<< Index
)) == 0) {
315 if (Private
->Luns
.Lun
[Index
] != UfsLun
) {
319 for (Next
= Index
+ 1; Next
< UFS_MAX_LUNS
; Next
++) {
320 if ((Private
->Luns
.BitMask
& (BIT0
<< Next
)) != 0) {
321 UfsLun
= Private
->Luns
.Lun
[Next
];
326 if (Next
== UFS_MAX_LUNS
) {
327 return EFI_NOT_FOUND
;
333 if (Index
!= UFS_MAX_LUNS
) {
335 if ((UfsLun
& BIT7
) == BIT7
) {
336 ((UINT8
*)Lun
)[0] = UFS_WLUN_PREFIX
;
337 ((UINT8
*)Lun
)[1] = UfsLun
& ~BIT7
;
339 ((UINT8
*)Lun
)[1] = UfsLun
;
343 return EFI_NOT_FOUND
;
347 return EFI_NOT_FOUND
;
351 Used to allocate and build a device path node for a SCSI device on a SCSI channel.
353 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
354 @param Target The Target is an array of size TARGET_MAX_BYTES and it specifies the
355 Target ID of the SCSI device for which a device path node is to be
356 allocated and built. Transport drivers may chose to utilize a subset of
357 this size to suit the representation of targets. For example, a Fibre
358 Channel driver may use only 8 bytes (WWN) in the array to represent a
360 @param Lun The LUN of the SCSI device for which a device path node is to be
362 @param DevicePath A pointer to a single device path node that describes the SCSI device
363 specified by Target and Lun. This function is responsible for
364 allocating the buffer DevicePath with the boot service
365 AllocatePool(). It is the caller's responsibility to free
366 DevicePath when the caller is finished with DevicePath.
368 @retval EFI_SUCCESS The device path node that describes the SCSI device specified by
369 Target and Lun was allocated and returned in
371 @retval EFI_INVALID_PARAMETER DevicePath is NULL.
372 @retval EFI_NOT_FOUND The SCSI devices specified by Target and Lun does not exist
374 @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate DevicePath.
379 UfsPassThruBuildDevicePath (
380 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
383 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
386 UFS_PASS_THRU_PRIVATE_DATA
*Private
;
387 EFI_DEV_PATH
*DevicePathNode
;
391 Private
= UFS_PASS_THRU_PRIVATE_DATA_FROM_THIS (This
);
394 // Validate parameters passed in.
396 SetMem (mUfsTargetId
, TARGET_MAX_BYTES
, 0x00);
397 if (CompareMem (Target
, mUfsTargetId
, TARGET_MAX_BYTES
) != 0) {
398 return EFI_INVALID_PARAMETER
;
401 if ((UINT8
)Lun
== UFS_WLUN_PREFIX
) {
402 UfsLun
= BIT7
| (((UINT8
*)&Lun
)[1] & 0xFF);
403 } else if ((UINT8
)Lun
== 0) {
404 UfsLun
= ((UINT8
*)&Lun
)[1] & 0xFF;
406 return EFI_NOT_FOUND
;
409 for (Index
= 0; Index
< UFS_MAX_LUNS
; Index
++) {
410 if ((Private
->Luns
.BitMask
& (BIT0
<< Index
)) == 0) {
414 if (Private
->Luns
.Lun
[Index
] == UfsLun
) {
419 if (Index
== UFS_MAX_LUNS
) {
420 return EFI_NOT_FOUND
;
423 DevicePathNode
= AllocateCopyPool (sizeof (UFS_DEVICE_PATH
), &mUfsDevicePathTemplate
);
424 if (DevicePathNode
== NULL
) {
425 return EFI_OUT_OF_RESOURCES
;
428 DevicePathNode
->Ufs
.Pun
= 0;
429 DevicePathNode
->Ufs
.Lun
= UfsLun
;
431 *DevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) DevicePathNode
;
437 Used to translate a device path node to a Target ID and LUN.
439 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
440 @param DevicePath A pointer to a single device path node that describes the SCSI device
442 @param Target A pointer to the Target Array which represents the ID of a SCSI device
444 @param Lun A pointer to the LUN of a SCSI device on the SCSI channel.
446 @retval EFI_SUCCESS DevicePath was successfully translated to a Target ID and
447 LUN, and they were returned in Target and Lun.
448 @retval EFI_INVALID_PARAMETER DevicePath or Target or Lun is NULL.
449 @retval EFI_NOT_FOUND A valid translation from DevicePath to a Target ID and LUN
451 @retval EFI_UNSUPPORTED This driver does not support the device path node type in
457 UfsPassThruGetTargetLun (
458 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
459 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
464 UFS_PASS_THRU_PRIVATE_DATA
*Private
;
465 EFI_DEV_PATH
*DevicePathNode
;
470 Private
= UFS_PASS_THRU_PRIVATE_DATA_FROM_THIS (This
);
473 // Validate parameters passed in.
475 if (DevicePath
== NULL
|| Target
== NULL
|| Lun
== NULL
) {
476 return EFI_INVALID_PARAMETER
;
479 if (*Target
== NULL
) {
480 return EFI_INVALID_PARAMETER
;
484 // Check whether the DevicePath belongs to UFS_DEVICE_PATH
486 if ((DevicePath
->Type
!= MESSAGING_DEVICE_PATH
) || (DevicePath
->SubType
!= MSG_UFS_DP
) ||
487 (DevicePathNodeLength(DevicePath
) != sizeof(UFS_DEVICE_PATH
))) {
488 return EFI_UNSUPPORTED
;
491 DevicePathNode
= (EFI_DEV_PATH
*) DevicePath
;
493 Pun
= (UINT8
) DevicePathNode
->Ufs
.Pun
;
494 UfsLun
= (UINT8
) DevicePathNode
->Ufs
.Lun
;
497 return EFI_NOT_FOUND
;
500 for (Index
= 0; Index
< UFS_MAX_LUNS
; Index
++) {
501 if ((Private
->Luns
.BitMask
& (BIT0
<< Index
)) == 0) {
505 if (Private
->Luns
.Lun
[Index
] == UfsLun
) {
510 if (Index
== UFS_MAX_LUNS
) {
511 return EFI_NOT_FOUND
;
514 SetMem (*Target
, TARGET_MAX_BYTES
, 0x00);
516 if ((UfsLun
& BIT7
) == BIT7
) {
517 ((UINT8
*)Lun
)[0] = UFS_WLUN_PREFIX
;
518 ((UINT8
*)Lun
)[1] = UfsLun
& ~BIT7
;
520 ((UINT8
*)Lun
)[1] = UfsLun
;
526 Resets a SCSI channel. This operation resets all the SCSI devices connected to the SCSI channel.
528 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
530 @retval EFI_SUCCESS The SCSI channel was reset.
531 @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the SCSI channel.
532 @retval EFI_TIMEOUT A timeout occurred while attempting to reset the SCSI channel.
533 @retval EFI_UNSUPPORTED The SCSI channel does not support a channel reset operation.
538 UfsPassThruResetChannel (
539 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
543 // Return success directly then upper layer driver could think reset channel operation is done.
549 Resets a SCSI logical unit that is connected to a SCSI channel.
551 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
552 @param Target The Target is an array of size TARGET_MAX_BYTE and it represents the
553 target port ID of the SCSI device containing the SCSI logical unit to
554 reset. Transport drivers may chose to utilize a subset of this array to suit
555 the representation of their targets.
556 @param Lun The LUN of the SCSI device to reset.
558 @retval EFI_SUCCESS The SCSI device specified by Target and Lun was reset.
559 @retval EFI_INVALID_PARAMETER Target or Lun is NULL.
560 @retval EFI_TIMEOUT A timeout occurred while attempting to reset the SCSI device
561 specified by Target and Lun.
562 @retval EFI_UNSUPPORTED The SCSI channel does not support a target reset operation.
563 @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the SCSI device
564 specified by Target and Lun.
569 UfsPassThruResetTargetLun (
570 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
576 // Return success directly then upper layer driver could think reset target LUN operation is done.
582 Used to retrieve the list of legal Target IDs for SCSI devices on a SCSI channel. These can either
583 be the list SCSI devices that are actually present on the SCSI channel, or the list of legal Target IDs
584 for the SCSI channel. Regardless, the caller of this function must probe the Target ID returned to
585 see if a SCSI device is actually present at that location on the SCSI channel.
587 @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
588 @param Target (TARGET_MAX_BYTES) of a SCSI device present on the SCSI channel.
589 On output, a pointer to the Target ID (an array of
590 TARGET_MAX_BYTES) of the next SCSI device present on a SCSI
591 channel. An input value of 0xF(all bytes in the array are 0xF) in the
592 Target array retrieves the Target ID of the first SCSI device present on a
595 @retval EFI_SUCCESS The Target ID of the next SCSI device on the SCSI
596 channel was returned in Target.
597 @retval EFI_INVALID_PARAMETER Target or Lun is NULL.
598 @retval EFI_TIMEOUT Target array is not all 0xF, and Target was not
599 returned on a previous call to GetNextTarget().
600 @retval EFI_NOT_FOUND There are no more SCSI devices on this SCSI channel.
605 UfsPassThruGetNextTarget (
606 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
607 IN OUT UINT8
**Target
610 if (Target
== NULL
|| *Target
== NULL
) {
611 return EFI_INVALID_PARAMETER
;
614 SetMem (mUfsTargetId
, TARGET_MAX_BYTES
, 0xFF);
615 if (CompareMem(*Target
, mUfsTargetId
, TARGET_MAX_BYTES
) == 0) {
616 SetMem (*Target
, TARGET_MAX_BYTES
, 0x00);
620 return EFI_NOT_FOUND
;
624 Tests to see if this driver supports a given controller. If a child device is provided,
625 it further tests to see if this driver supports creating a handle for the specified child device.
627 This function checks to see if the driver specified by This supports the device specified by
628 ControllerHandle. Drivers will typically use the device path attached to
629 ControllerHandle and/or the services from the bus I/O abstraction attached to
630 ControllerHandle to determine if the driver supports ControllerHandle. This function
631 may be called many times during platform initialization. In order to reduce boot times, the tests
632 performed by this function must be very small, and take as little time as possible to execute. This
633 function must not change the state of any hardware devices, and this function must be aware that the
634 device specified by ControllerHandle may already be managed by the same driver or a
635 different driver. This function must match its calls to AllocatePages() with FreePages(),
636 AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol().
637 Since ControllerHandle may have been previously started by the same driver, if a protocol is
638 already in the opened state, then it must not be closed with CloseProtocol(). This is required
639 to guarantee the state of ControllerHandle is not modified by this function.
641 @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
642 @param[in] ControllerHandle The handle of the controller to test. This handle
643 must support a protocol interface that supplies
644 an I/O abstraction to the driver.
645 @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This
646 parameter is ignored by device drivers, and is optional for bus
647 drivers. For bus drivers, if this parameter is not NULL, then
648 the bus driver must determine if the bus controller specified
649 by ControllerHandle and the child controller specified
650 by RemainingDevicePath are both supported by this
653 @retval EFI_SUCCESS The device specified by ControllerHandle and
654 RemainingDevicePath is supported by the driver specified by This.
655 @retval EFI_ALREADY_STARTED The device specified by ControllerHandle and
656 RemainingDevicePath is already being managed by the driver
658 @retval EFI_ACCESS_DENIED The device specified by ControllerHandle and
659 RemainingDevicePath is already being managed by a different
660 driver or an application that requires exclusive access.
661 Currently not implemented.
662 @retval EFI_UNSUPPORTED The device specified by ControllerHandle and
663 RemainingDevicePath is not supported by the driver specified by This.
667 UfsPassThruDriverBindingSupported (
668 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
669 IN EFI_HANDLE Controller
,
670 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
674 EFI_DEVICE_PATH_PROTOCOL
*ParentDevicePath
;
675 EDKII_UFS_HOST_CONTROLLER_PROTOCOL
*UfsHostController
;
678 // Ufs Pass Thru driver is a device driver, and should ingore the
679 // "RemainingDevicePath" according to UEFI spec
681 Status
= gBS
->OpenProtocol (
683 &gEfiDevicePathProtocolGuid
,
684 (VOID
*) &ParentDevicePath
,
685 This
->DriverBindingHandle
,
687 EFI_OPEN_PROTOCOL_BY_DRIVER
689 if (EFI_ERROR (Status
)) {
691 // EFI_ALREADY_STARTED is also an error
696 // Close the protocol because we don't use it here
700 &gEfiDevicePathProtocolGuid
,
701 This
->DriverBindingHandle
,
705 Status
= gBS
->OpenProtocol (
707 &gEdkiiUfsHostControllerProtocolGuid
,
708 (VOID
**) &UfsHostController
,
709 This
->DriverBindingHandle
,
711 EFI_OPEN_PROTOCOL_BY_DRIVER
714 if (EFI_ERROR (Status
)) {
716 // EFI_ALREADY_STARTED is also an error
722 // Close the I/O Abstraction(s) used to perform the supported test
726 &gEdkiiUfsHostControllerProtocolGuid
,
727 This
->DriverBindingHandle
,
735 Finishes device initialization by setting fDeviceInit flag and waiting untill device responds by
738 @param[in] Private Pointer to the UFS_PASS_THRU_PRIVATE_DATA.
740 @retval EFI_SUCCESS The operation succeeds.
741 @retval Others The operation fails.
745 UfsFinishDeviceInitialization (
746 IN UFS_PASS_THRU_PRIVATE_DATA
*Private
750 UINT8 DeviceInitStatus
;
753 DeviceInitStatus
= 0xFF;
756 // The host enables the device initialization completion by setting fDeviceInit flag.
758 Status
= UfsSetFlag (Private
, UfsFlagDevInit
);
759 if (EFI_ERROR (Status
)) {
765 Status
= UfsReadFlag (Private
, UfsFlagDevInit
, &DeviceInitStatus
);
766 if (EFI_ERROR (Status
)) {
769 MicroSecondDelay (1);
771 } while (DeviceInitStatus
!= 0 && Timeout
!= 0);
777 Starts a device controller or a bus controller.
779 The Start() function is designed to be invoked from the EFI boot service ConnectController().
780 As a result, much of the error checking on the parameters to Start() has been moved into this
781 common boot service. It is legal to call Start() from other locations,
782 but the following calling restrictions must be followed or the system behavior will not be deterministic.
783 1. ControllerHandle must be a valid EFI_HANDLE.
784 2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned
785 EFI_DEVICE_PATH_PROTOCOL.
786 3. Prior to calling Start(), the Supported() function for the driver specified by This must
787 have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.
789 @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
790 @param[in] ControllerHandle The handle of the controller to start. This handle
791 must support a protocol interface that supplies
792 an I/O abstraction to the driver.
793 @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This
794 parameter is ignored by device drivers, and is optional for bus
795 drivers. For a bus driver, if this parameter is NULL, then handles
796 for all the children of Controller are created by this driver.
797 If this parameter is not NULL and the first Device Path Node is
798 not the End of Device Path Node, then only the handle for the
799 child device specified by the first Device Path Node of
800 RemainingDevicePath is created by this driver.
801 If the first Device Path Node of RemainingDevicePath is
802 the End of Device Path Node, no child handle is created by this
805 @retval EFI_SUCCESS The device was started.
806 @retval EFI_DEVICE_ERROR The device could not be started due to a device error.Currently not implemented.
807 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
808 @retval Others The driver failded to start the device.
813 UfsPassThruDriverBindingStart (
814 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
815 IN EFI_HANDLE Controller
,
816 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
820 EDKII_UFS_HOST_CONTROLLER_PROTOCOL
*UfsHc
;
821 UFS_PASS_THRU_PRIVATE_DATA
*Private
;
824 UFS_UNIT_DESC UnitDescriptor
;
825 UINT32 UnitDescriptorSize
;
827 Status
= EFI_SUCCESS
;
832 DEBUG ((DEBUG_INFO
, "==UfsPassThru Start== Controller = %x\n", Controller
));
834 Status
= gBS
->OpenProtocol (
836 &gEdkiiUfsHostControllerProtocolGuid
,
838 This
->DriverBindingHandle
,
840 EFI_OPEN_PROTOCOL_BY_DRIVER
843 if (EFI_ERROR (Status
)) {
844 DEBUG ((DEBUG_ERROR
, "Open Ufs Host Controller Protocol Error, Status = %r\n", Status
));
849 // Get the UFS Host Controller MMIO Bar Base Address.
851 Status
= UfsHc
->GetUfsHcMmioBar (UfsHc
, &UfsHcBase
);
852 if (EFI_ERROR (Status
)) {
853 DEBUG ((DEBUG_ERROR
, "Get Ufs Host Controller Mmio Bar Error, Status = %r\n", Status
));
858 // Initialize Ufs Pass Thru private data for managed UFS Host Controller.
860 Private
= AllocateCopyPool (sizeof (UFS_PASS_THRU_PRIVATE_DATA
), &gUfsPassThruTemplate
);
861 if (Private
== NULL
) {
862 DEBUG ((DEBUG_ERROR
, "Unable to allocate Ufs Pass Thru private data\n"));
863 Status
= EFI_OUT_OF_RESOURCES
;
867 Private
->ExtScsiPassThru
.Mode
= &Private
->ExtScsiPassThruMode
;
868 Private
->UfsHostController
= UfsHc
;
869 Private
->UfsHcBase
= UfsHcBase
;
870 Private
->Handle
= Controller
;
871 Private
->UfsHcDriverInterface
.UfsHcProtocol
= UfsHc
;
872 Private
->UfsHcDriverInterface
.UfsExecUicCommand
= UfsHcDriverInterfaceExecUicCommand
;
873 InitializeListHead (&Private
->Queue
);
876 // This has to be done before initializing UfsHcInfo or calling the UfsControllerInit
878 if (mUfsHcPlatform
== NULL
) {
879 Status
= gBS
->LocateProtocol (&gEdkiiUfsHcPlatformProtocolGuid
, NULL
, (VOID
**)&mUfsHcPlatform
);
880 if (EFI_ERROR (Status
)) {
881 DEBUG ((DEBUG_INFO
, "No UfsHcPlatformProtocol present\n"));
885 Status
= GetUfsHcInfo (Private
);
886 if (EFI_ERROR (Status
)) {
887 DEBUG ((DEBUG_ERROR
, "Failed to initialize UfsHcInfo\n"));
892 // Initialize UFS Host Controller H/W.
894 Status
= UfsControllerInit (Private
);
895 if (EFI_ERROR (Status
)) {
896 DEBUG ((DEBUG_ERROR
, "Ufs Host Controller Initialization Error, Status = %r\n", Status
));
901 // UFS 2.0 spec Section 13.1.3.3:
902 // At the end of the UFS Interconnect Layer initialization on both host and device side,
903 // the host shall send a NOP OUT UPIU to verify that the device UTP Layer is ready.
905 Status
= UfsExecNopCmds (Private
);
906 if (EFI_ERROR (Status
)) {
907 DEBUG ((DEBUG_ERROR
, "Ufs Sending NOP IN command Error, Status = %r\n", Status
));
911 Status
= UfsFinishDeviceInitialization (Private
);
912 if (EFI_ERROR (Status
)) {
913 DEBUG ((DEBUG_ERROR
, "Device failed to finish initialization, Status = %r\n", Status
));
918 // Check if 8 common luns are active and set corresponding bit mask.
919 // TODO: Parse device descriptor to decide if exposing RPMB LUN to upper layer for authentication access.
921 UnitDescriptorSize
= sizeof (UFS_UNIT_DESC
);
922 for (Index
= 0; Index
< 8; Index
++) {
923 Status
= UfsRwDeviceDesc (Private
, TRUE
, UfsUnitDesc
, (UINT8
) Index
, 0, &UnitDescriptor
, &UnitDescriptorSize
);
924 if (EFI_ERROR (Status
)) {
925 DEBUG ((DEBUG_ERROR
, "Failed to read unit descriptor, index = %X, status = %r\n", Index
, Status
));
928 if (UnitDescriptor
.LunEn
== 0x1) {
929 DEBUG ((DEBUG_INFO
, "UFS LUN %X is enabled\n", Index
));
930 Private
->Luns
.BitMask
|= (BIT0
<< Index
);
935 // Start the asynchronous interrupt monitor
937 Status
= gBS
->CreateEvent (
938 EVT_TIMER
| EVT_NOTIFY_SIGNAL
,
940 ProcessAsyncTaskList
,
944 if (EFI_ERROR (Status
)) {
945 DEBUG ((DEBUG_ERROR
, "Ufs Create Async Tasks Event Error, Status = %r\n", Status
));
949 Status
= gBS
->SetTimer (
954 if (EFI_ERROR (Status
)) {
955 DEBUG ((DEBUG_ERROR
, "Ufs Set Periodic Timer Error, Status = %r\n", Status
));
959 Status
= gBS
->InstallMultipleProtocolInterfaces (
961 &gEfiExtScsiPassThruProtocolGuid
,
962 &(Private
->ExtScsiPassThru
),
963 &gEfiUfsDeviceConfigProtocolGuid
,
964 &(Private
->UfsDevConfig
),
967 ASSERT_EFI_ERROR (Status
);
972 if (Private
!= NULL
) {
973 if (Private
->TmrlMapping
!= NULL
) {
974 UfsHc
->Unmap (UfsHc
, Private
->TmrlMapping
);
976 if (Private
->UtpTmrlBase
!= NULL
) {
977 UfsHc
->FreeBuffer (UfsHc
, EFI_SIZE_TO_PAGES (Private
->Nutmrs
* sizeof (UTP_TMRD
)), Private
->UtpTmrlBase
);
980 if (Private
->TrlMapping
!= NULL
) {
981 UfsHc
->Unmap (UfsHc
, Private
->TrlMapping
);
983 if (Private
->UtpTrlBase
!= NULL
) {
984 UfsHc
->FreeBuffer (UfsHc
, EFI_SIZE_TO_PAGES (Private
->Nutrs
* sizeof (UTP_TMRD
)), Private
->UtpTrlBase
);
987 if (Private
->TimerEvent
!= NULL
) {
988 gBS
->CloseEvent (Private
->TimerEvent
);
997 &gEdkiiUfsHostControllerProtocolGuid
,
998 This
->DriverBindingHandle
,
1007 Stops a device controller or a bus controller.
1009 The Stop() function is designed to be invoked from the EFI boot service DisconnectController().
1010 As a result, much of the error checking on the parameters to Stop() has been moved
1011 into this common boot service. It is legal to call Stop() from other locations,
1012 but the following calling restrictions must be followed or the system behavior will not be deterministic.
1013 1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this
1014 same driver's Start() function.
1015 2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid
1016 EFI_HANDLE. In addition, all of these handles must have been created in this driver's
1017 Start() function, and the Start() function must have called OpenProtocol() on
1018 ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.
1020 @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
1021 @param[in] ControllerHandle A handle to the device being stopped. The handle must
1022 support a bus specific I/O protocol for the driver
1023 to use to stop the device.
1024 @param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer.
1025 @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL
1026 if NumberOfChildren is 0.
1028 @retval EFI_SUCCESS The device was stopped.
1029 @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.
1034 UfsPassThruDriverBindingStop (
1035 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1036 IN EFI_HANDLE Controller
,
1037 IN UINTN NumberOfChildren
,
1038 IN EFI_HANDLE
*ChildHandleBuffer
1042 UFS_PASS_THRU_PRIVATE_DATA
*Private
;
1043 EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*ExtScsiPassThru
;
1044 EDKII_UFS_HOST_CONTROLLER_PROTOCOL
*UfsHc
;
1045 UFS_PASS_THRU_TRANS_REQ
*TransReq
;
1047 LIST_ENTRY
*NextEntry
;
1049 DEBUG ((DEBUG_INFO
, "==UfsPassThru Stop== Controller Controller = %x\n", Controller
));
1051 Status
= gBS
->OpenProtocol (
1053 &gEfiExtScsiPassThruProtocolGuid
,
1054 (VOID
**) &ExtScsiPassThru
,
1055 This
->DriverBindingHandle
,
1057 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1060 if (EFI_ERROR (Status
)) {
1061 return EFI_DEVICE_ERROR
;
1064 Private
= UFS_PASS_THRU_PRIVATE_DATA_FROM_THIS (ExtScsiPassThru
);
1065 UfsHc
= Private
->UfsHostController
;
1068 // Cleanup the resources of I/O requests in the async I/O queue
1070 if (!IsListEmpty(&Private
->Queue
)) {
1071 EFI_LIST_FOR_EACH_SAFE (Entry
, NextEntry
, &Private
->Queue
) {
1072 TransReq
= UFS_PASS_THRU_TRANS_REQ_FROM_THIS (Entry
);
1075 // TODO: Should find/add a proper host adapter return status for this
1078 TransReq
->Packet
->HostAdapterStatus
=
1079 EFI_EXT_SCSI_STATUS_HOST_ADAPTER_PHASE_ERROR
;
1081 SignalCallerEvent (Private
, TransReq
);
1085 Status
= gBS
->UninstallMultipleProtocolInterfaces (
1087 &gEfiExtScsiPassThruProtocolGuid
,
1088 &(Private
->ExtScsiPassThru
),
1089 &gEfiUfsDeviceConfigProtocolGuid
,
1090 &(Private
->UfsDevConfig
),
1094 if (EFI_ERROR (Status
)) {
1095 return EFI_DEVICE_ERROR
;
1099 // Stop Ufs Host Controller
1101 Status
= UfsControllerStop (Private
);
1102 ASSERT_EFI_ERROR (Status
);
1104 if (Private
->TmrlMapping
!= NULL
) {
1105 UfsHc
->Unmap (UfsHc
, Private
->TmrlMapping
);
1107 if (Private
->UtpTmrlBase
!= NULL
) {
1108 UfsHc
->FreeBuffer (UfsHc
, EFI_SIZE_TO_PAGES (Private
->Nutmrs
* sizeof (UTP_TMRD
)), Private
->UtpTmrlBase
);
1111 if (Private
->TrlMapping
!= NULL
) {
1112 UfsHc
->Unmap (UfsHc
, Private
->TrlMapping
);
1114 if (Private
->UtpTrlBase
!= NULL
) {
1115 UfsHc
->FreeBuffer (UfsHc
, EFI_SIZE_TO_PAGES (Private
->Nutrs
* sizeof (UTP_TMRD
)), Private
->UtpTrlBase
);
1118 if (Private
->TimerEvent
!= NULL
) {
1119 gBS
->CloseEvent (Private
->TimerEvent
);
1125 // Close protocols opened by UfsPassThru controller driver
1127 gBS
->CloseProtocol (
1129 &gEdkiiUfsHostControllerProtocolGuid
,
1130 This
->DriverBindingHandle
,
1139 The user Entry Point for module UfsPassThru. The user code starts with this function.
1141 @param[in] ImageHandle The firmware allocated handle for the EFI image.
1142 @param[in] SystemTable A pointer to the EFI System Table.
1144 @retval EFI_SUCCESS The entry point is executed successfully.
1145 @retval other Some error occurs when executing this entry point.
1150 InitializeUfsPassThru (
1151 IN EFI_HANDLE ImageHandle
,
1152 IN EFI_SYSTEM_TABLE
*SystemTable
1158 // Install driver model protocol(s).
1160 Status
= EfiLibInstallDriverBindingComponentName2 (
1163 &gUfsPassThruDriverBinding
,
1165 &gUfsPassThruComponentName
,
1166 &gUfsPassThruComponentName2
1168 ASSERT_EFI_ERROR (Status
);