2 UfsPassThruDxe driver is used to produce EFI_EXT_SCSI_PASS_THRU protocol interface
3 for upper layer application to execute UFS-supported SCSI cmds.
5 Copyright (c) 2014 - 2015, 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.
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.
16 #include "UfsPassThru.h"
19 Read 32bits data from specified UFS MMIO register.
21 @param[in] Private The pointer to the UFS_PASS_THRU_PRIVATE_DATA data structure.
22 @param[in] Offset The offset within the UFS Host Controller MMIO space to start
24 @param[out] Value The data buffer to store.
26 @retval EFI_TIMEOUT The operation is time out.
27 @retval EFI_SUCCESS The operation succeeds.
28 @retval Others The operation fails.
33 IN UFS_PASS_THRU_PRIVATE_DATA
*Private
,
38 EDKII_UFS_HOST_CONTROLLER_PROTOCOL
*UfsHc
;
41 UfsHc
= Private
->UfsHostController
;
43 Status
= UfsHc
->Read (UfsHc
, EfiUfsHcWidthUint32
, Offset
, 1, Value
);
49 Write 32bits data to specified UFS MMIO register.
51 @param[in] Private The pointer to the UFS_PASS_THRU_PRIVATE_DATA data structure.
52 @param[in] Offset The offset within the UFS Host Controller MMIO space to start
54 @param[in] Value The data to write.
56 @retval EFI_TIMEOUT The operation is time out.
57 @retval EFI_SUCCESS The operation succeeds.
58 @retval Others The operation fails.
63 IN UFS_PASS_THRU_PRIVATE_DATA
*Private
,
68 EDKII_UFS_HOST_CONTROLLER_PROTOCOL
*UfsHc
;
71 UfsHc
= Private
->UfsHostController
;
73 Status
= UfsHc
->Write (UfsHc
, EfiUfsHcWidthUint32
, Offset
, 1, &Value
);
79 Wait for the value of the specified system memory set to the test value.
81 @param[in] Private The pointer to the UFS_PASS_THRU_PRIVATE_DATA data structure.
82 @param[in] Offset The offset within the UFS Host Controller MMIO space to start
84 @param[in] MaskValue The mask value of memory.
85 @param[in] TestValue The test value of memory.
86 @param[in] Timeout The time out value for wait memory set, uses 100ns as a unit.
88 @retval EFI_TIMEOUT The system memory setting is time out.
89 @retval EFI_SUCCESS The system memory is correct set.
90 @retval Others The operation fails.
95 IN UFS_PASS_THRU_PRIVATE_DATA
*Private
,
104 BOOLEAN InfiniteWait
;
110 InfiniteWait
= FALSE
;
113 Delay
= DivU64x32 (Timeout
, 10) + 1;
117 // Access PCI MMIO space to see if the value is the tested one.
119 Status
= UfsMmioRead32 (Private
, Offset
, &Value
);
120 if (EFI_ERROR (Status
)) {
126 if (Value
== TestValue
) {
131 // Stall for 1 microseconds.
133 MicroSecondDelay (1);
137 } while (InfiniteWait
|| (Delay
> 0));
143 Dump UIC command execution result for debugging.
145 @param[in] UicOpcode The executed UIC opcode.
146 @param[in] Result The result to be parsed.
150 DumpUicCmdExecResult (
155 if (UicOpcode
<= UfsUicDmePeerSet
) {
160 DEBUG ((EFI_D_VERBOSE
, "UIC configuration command fails - INVALID_MIB_ATTRIBUTE\n"));
163 DEBUG ((EFI_D_VERBOSE
, "UIC configuration command fails - INVALID_MIB_ATTRIBUTE_VALUE\n"));
166 DEBUG ((EFI_D_VERBOSE
, "UIC configuration command fails - READ_ONLY_MIB_ATTRIBUTE\n"));
169 DEBUG ((EFI_D_VERBOSE
, "UIC configuration command fails - WRITE_ONLY_MIB_ATTRIBUTE\n"));
172 DEBUG ((EFI_D_VERBOSE
, "UIC configuration command fails - BAD_INDEX\n"));
175 DEBUG ((EFI_D_VERBOSE
, "UIC configuration command fails - LOCKED_MIB_ATTRIBUTE\n"));
178 DEBUG ((EFI_D_VERBOSE
, "UIC configuration command fails - BAD_TEST_FEATURE_INDEX\n"));
181 DEBUG ((EFI_D_VERBOSE
, "UIC configuration command fails - PEER_COMMUNICATION_FAILURE\n"));
184 DEBUG ((EFI_D_VERBOSE
, "UIC configuration command fails - BUSY\n"));
187 DEBUG ((EFI_D_VERBOSE
, "UIC configuration command fails - DME_FAILURE\n"));
198 DEBUG ((EFI_D_VERBOSE
, "UIC control command fails - FAILURE\n"));
208 Dump QUERY RESPONSE UPIU result for debugging.
210 @param[in] Result The result to be parsed.
214 DumpQueryResponseResult (
220 DEBUG ((EFI_D_VERBOSE
, "Query Response with Parameter Not Readable\n"));
223 DEBUG ((EFI_D_VERBOSE
, "Query Response with Parameter Not Writeable\n"));
226 DEBUG ((EFI_D_VERBOSE
, "Query Response with Parameter Already Written\n"));
229 DEBUG ((EFI_D_VERBOSE
, "Query Response with Invalid Length\n"));
232 DEBUG ((EFI_D_VERBOSE
, "Query Response with Invalid Value\n"));
235 DEBUG ((EFI_D_VERBOSE
, "Query Response with Invalid Selector\n"));
238 DEBUG ((EFI_D_VERBOSE
, "Query Response with Invalid Index\n"));
241 DEBUG ((EFI_D_VERBOSE
, "Query Response with Invalid Idn\n"));
244 DEBUG ((EFI_D_VERBOSE
, "Query Response with Invalid Opcode\n"));
247 DEBUG ((EFI_D_VERBOSE
, "Query Response with General Failure\n"));
256 Swap little endian to big endian.
258 @param[in, out] Buffer The data buffer. In input, it contains little endian data.
259 In output, it will become big endian.
260 @param[in] BufferSize The length of converted data.
264 SwapLittleEndianToBigEndian (
265 IN OUT UINT8
*Buffer
,
273 SwapCount
= BufferSize
/ 2;
274 for (Index
= 0; Index
< SwapCount
; Index
++) {
275 Temp
= Buffer
[Index
];
276 Buffer
[Index
] = Buffer
[BufferSize
- 1 - Index
];
277 Buffer
[BufferSize
- 1 - Index
] = Temp
;
282 Fill TSF field of QUERY REQUEST UPIU.
284 @param[in, out] TsfBase The base address of TSF field of QUERY REQUEST UPIU.
285 @param[in] Opcode The opcode of request.
286 @param[in] DescId The descriptor ID of request.
287 @param[in] Index The index of request.
288 @param[in] Selector The selector of request.
289 @param[in] Length The length of transferred data. The maximum is 4.
290 @param[in] Value The value of transferred data.
294 UfsFillTsfOfQueryReqUpiu (
295 IN OUT UTP_UPIU_TSF
*TsfBase
,
297 IN UINT8 DescId OPTIONAL
,
298 IN UINT8 Index OPTIONAL
,
299 IN UINT8 Selector OPTIONAL
,
300 IN UINT16 Length OPTIONAL
,
301 IN UINT32 Value OPTIONAL
304 ASSERT (TsfBase
!= NULL
);
305 ASSERT (Opcode
<= UtpQueryFuncOpcodeTogFlag
);
307 TsfBase
->Opcode
= Opcode
;
308 if (Opcode
!= UtpQueryFuncOpcodeNop
) {
309 TsfBase
->DescId
= DescId
;
310 TsfBase
->Index
= Index
;
311 TsfBase
->Selector
= Selector
;
313 if ((Opcode
== UtpQueryFuncOpcodeRdDesc
) || (Opcode
== UtpQueryFuncOpcodeWrDesc
)) {
314 SwapLittleEndianToBigEndian ((UINT8
*)&Length
, sizeof (Length
));
315 TsfBase
->Length
= Length
;
318 if (Opcode
== UtpQueryFuncOpcodeWrAttr
) {
319 SwapLittleEndianToBigEndian ((UINT8
*)&Value
, sizeof (Value
));
320 TsfBase
->Value
= Value
;
326 Initialize COMMAND UPIU.
328 @param[in, out] Command The base address of COMMAND UPIU.
329 @param[in] Lun The Lun on which the SCSI command is executed.
330 @param[in] TaskTag The task tag of request.
331 @param[in] Cdb The cdb buffer containing SCSI command.
332 @param[in] CdbLength The cdb length.
333 @param[in] DataDirection The direction of data transfer.
334 @param[in] ExpDataTranLen The expected transfer data length.
336 @retval EFI_SUCCESS The initialization succeed.
341 IN OUT UTP_COMMAND_UPIU
*Command
,
346 IN UFS_DATA_DIRECTION DataDirection
,
347 IN UINT32 ExpDataTranLen
352 ASSERT ((Command
!= NULL
) && (Cdb
!= NULL
));
355 // Task attribute is hard-coded to Ordered.
357 if (DataDirection
== UfsDataIn
) {
359 } else if (DataDirection
== UfsDataOut
) {
366 // Fill UTP COMMAND UPIU associated fields.
368 Command
->TransCode
= 0x01;
369 Command
->Flags
= Flags
;
371 Command
->TaskTag
= TaskTag
;
372 Command
->CmdSet
= 0x00;
373 SwapLittleEndianToBigEndian ((UINT8
*)&ExpDataTranLen
, sizeof (ExpDataTranLen
));
374 Command
->ExpDataTranLen
= ExpDataTranLen
;
376 CopyMem (Command
->Cdb
, Cdb
, CdbLength
);
382 Initialize UTP PRDT for data transfer.
384 @param[in] Prdt The base address of PRDT.
385 @param[in] Buffer The buffer to be read or written.
386 @param[in] BufferSize The data size to be read or written.
388 @retval EFI_SUCCESS The initialization succeed.
403 if (BufferSize
== 0) {
407 ASSERT (((UINTN
)Buffer
& (BIT0
| BIT1
)) == 0);
409 RemainingLen
= BufferSize
;
411 PrdtNumber
= (UINTN
)DivU64x32 ((UINT64
)BufferSize
+ UFS_MAX_DATA_LEN_PER_PRD
- 1, UFS_MAX_DATA_LEN_PER_PRD
);
413 for (PrdtIndex
= 0; PrdtIndex
< PrdtNumber
; PrdtIndex
++) {
414 if (RemainingLen
< UFS_MAX_DATA_LEN_PER_PRD
) {
415 Prdt
[PrdtIndex
].DbCount
= (UINT32
)RemainingLen
- 1;
417 Prdt
[PrdtIndex
].DbCount
= UFS_MAX_DATA_LEN_PER_PRD
- 1;
420 Prdt
[PrdtIndex
].DbAddr
= (UINT32
)RShiftU64 ((UINT64
)(UINTN
)Remaining
, 2);
421 Prdt
[PrdtIndex
].DbAddrU
= (UINT32
)RShiftU64 ((UINT64
)(UINTN
)Remaining
, 32);
422 RemainingLen
-= UFS_MAX_DATA_LEN_PER_PRD
;
423 Remaining
+= UFS_MAX_DATA_LEN_PER_PRD
;
430 Initialize QUERY REQUEST UPIU.
432 @param[in, out] QueryReq The base address of QUERY REQUEST UPIU.
433 @param[in] TaskTag The task tag of request.
434 @param[in] Opcode The opcode of request.
435 @param[in] DescId The descriptor ID of request.
436 @param[in] Index The index of request.
437 @param[in] Selector The selector of request.
438 @param[in] DataSize The data size to be read or written.
439 @param[in] Data The buffer to be read or written.
441 @retval EFI_SUCCESS The initialization succeed.
445 UfsInitQueryRequestUpiu (
446 IN OUT UTP_QUERY_REQ_UPIU
*QueryReq
,
452 IN UINTN DataSize OPTIONAL
,
453 IN UINT8
*Data OPTIONAL
456 ASSERT (QueryReq
!= NULL
);
458 QueryReq
->TransCode
= 0x16;
459 QueryReq
->TaskTag
= TaskTag
;
460 if ((Opcode
== UtpQueryFuncOpcodeRdDesc
) || (Opcode
== UtpQueryFuncOpcodeRdFlag
) || (Opcode
== UtpQueryFuncOpcodeRdAttr
)) {
461 QueryReq
->QueryFunc
= QUERY_FUNC_STD_READ_REQ
;
463 QueryReq
->QueryFunc
= QUERY_FUNC_STD_WRITE_REQ
;
466 if (Opcode
== UtpQueryFuncOpcodeWrAttr
) {
467 UfsFillTsfOfQueryReqUpiu (&QueryReq
->Tsf
, Opcode
, DescId
, Index
, Selector
, 0, *(UINT32
*)Data
);
468 } else if ((Opcode
== UtpQueryFuncOpcodeRdDesc
) || (Opcode
== UtpQueryFuncOpcodeWrDesc
)) {
469 UfsFillTsfOfQueryReqUpiu (&QueryReq
->Tsf
, Opcode
, DescId
, Index
, Selector
, (UINT16
)DataSize
, 0);
471 UfsFillTsfOfQueryReqUpiu (&QueryReq
->Tsf
, Opcode
, DescId
, Index
, Selector
, 0, 0);
474 if (Opcode
== UtpQueryFuncOpcodeWrDesc
) {
475 CopyMem (QueryReq
+ 1, Data
, DataSize
);
482 Allocate COMMAND/RESPONSE UPIU for filling UTP TRD's command descriptor field.
484 @param[in] Private The pointer to the UFS_PASS_THRU_PRIVATE_DATA data structure.
485 @param[in] Lun The Lun on which the SCSI command is executed.
486 @param[in] Packet The pointer to the EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET data structure.
487 @param[in] Trd The pointer to the UTP Transfer Request Descriptor.
488 @param[out] CmdDescHost A pointer to store the base system memory address of the allocated range.
489 @param[out] CmdDescMapping A resulting value to pass to Unmap().
491 @retval EFI_SUCCESS The creation succeed.
492 @retval EFI_DEVICE_ERROR The creation failed.
493 @retval EFI_OUT_OF_RESOURCES The memory resource is insufficient.
497 UfsCreateScsiCommandDesc (
498 IN UFS_PASS_THRU_PRIVATE_DATA
*Private
,
500 IN EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
,
502 OUT VOID
**CmdDescHost
,
503 OUT VOID
**CmdDescMapping
508 UTP_COMMAND_UPIU
*CommandUpiu
;
509 EFI_PHYSICAL_ADDRESS CmdDescPhyAddr
;
512 UFS_DATA_DIRECTION DataDirection
;
514 ASSERT ((Private
!= NULL
) && (Packet
!= NULL
) && (Trd
!= NULL
));
516 if (Packet
->DataDirection
== EFI_EXT_SCSI_DATA_DIRECTION_READ
) {
517 DataLen
= Packet
->InTransferLength
;
518 DataDirection
= UfsDataIn
;
520 DataLen
= Packet
->OutTransferLength
;
521 DataDirection
= UfsDataOut
;
525 DataDirection
= UfsNoData
;
528 PrdtNumber
= (UINTN
)DivU64x32 ((UINT64
)DataLen
+ UFS_MAX_DATA_LEN_PER_PRD
- 1, UFS_MAX_DATA_LEN_PER_PRD
);
530 TotalLen
= ROUNDUP8 (sizeof (UTP_COMMAND_UPIU
)) + ROUNDUP8 (sizeof (UTP_RESPONSE_UPIU
)) + PrdtNumber
* sizeof (UTP_TR_PRD
);
532 Status
= UfsAllocateAlignCommonBuffer (Private
, TotalLen
, CmdDescHost
, &CmdDescPhyAddr
, CmdDescMapping
);
533 if (EFI_ERROR (Status
)) {
537 CommandUpiu
= (UTP_COMMAND_UPIU
*)*CmdDescHost
;
539 UfsInitCommandUpiu (CommandUpiu
, Lun
, Private
->TaskTag
++, Packet
->Cdb
, Packet
->CdbLength
, DataDirection
, DataLen
);
542 // Fill UTP_TRD associated fields
543 // NOTE: Some UFS host controllers request the Response UPIU and the Physical Region Description Table
544 // *MUST* be located at a 64-bit aligned boundary.
546 Trd
->Int
= UFS_INTERRUPT_COMMAND
;
547 Trd
->Dd
= DataDirection
;
548 Trd
->Ct
= UFS_STORAGE_COMMAND_TYPE
;
549 Trd
->UcdBa
= (UINT32
)RShiftU64 ((UINT64
)CmdDescPhyAddr
, 7);
550 Trd
->UcdBaU
= (UINT32
)RShiftU64 ((UINT64
)CmdDescPhyAddr
, 32);
551 Trd
->RuL
= (UINT16
)DivU64x32 ((UINT64
)ROUNDUP8 (sizeof (UTP_RESPONSE_UPIU
)), sizeof (UINT32
));
552 Trd
->RuO
= (UINT16
)DivU64x32 ((UINT64
)ROUNDUP8 (sizeof (UTP_COMMAND_UPIU
)), sizeof (UINT32
));
553 Trd
->PrdtL
= (UINT16
)PrdtNumber
;
554 Trd
->PrdtO
= (UINT16
)DivU64x32 ((UINT64
)(ROUNDUP8 (sizeof (UTP_COMMAND_UPIU
)) + ROUNDUP8 (sizeof (UTP_RESPONSE_UPIU
))), sizeof (UINT32
));
559 Allocate QUERY REQUEST/QUERY RESPONSE UPIU for filling UTP TRD's command descriptor field.
561 @param[in] Private The pointer to the UFS_PASS_THRU_PRIVATE_DATA data structure.
562 @param[in] Packet The pointer to the UFS_DEVICE_MANAGEMENT_REQUEST_PACKET data structure.
563 @param[in] Trd The pointer to the UTP Transfer Request Descriptor.
564 @param[out] CmdDescHost A pointer to store the base system memory address of the allocated range.
565 @param[out] CmdDescMapping A resulting value to pass to Unmap().
567 @retval EFI_SUCCESS The creation succeed.
568 @retval EFI_DEVICE_ERROR The creation failed.
569 @retval EFI_OUT_OF_RESOURCES The memory resource is insufficient.
570 @retval EFI_INVALID_PARAMETER The parameter passed in is invalid.
574 UfsCreateDMCommandDesc (
575 IN UFS_PASS_THRU_PRIVATE_DATA
*Private
,
576 IN UFS_DEVICE_MANAGEMENT_REQUEST_PACKET
*Packet
,
578 OUT VOID
**CmdDescHost
,
579 OUT VOID
**CmdDescMapping
583 UTP_QUERY_REQ_UPIU
*QueryReqUpiu
;
588 EFI_PHYSICAL_ADDRESS CmdDescPhyAddr
;
591 ASSERT ((Private
!= NULL
) && (Packet
!= NULL
) && (Trd
!= NULL
));
593 Opcode
= Packet
->Opcode
;
594 if ((Opcode
> UtpQueryFuncOpcodeTogFlag
) || (Opcode
== UtpQueryFuncOpcodeNop
)) {
595 return EFI_INVALID_PARAMETER
;
598 DataDirection
= Packet
->DataDirection
;
599 if (DataDirection
== UfsDataIn
) {
600 DataSize
= Packet
->InTransferLength
;
601 Data
= Packet
->InDataBuffer
;
602 } else if (DataDirection
== UfsDataOut
) {
603 DataSize
= Packet
->OutTransferLength
;
604 Data
= Packet
->OutDataBuffer
;
610 if (((Opcode
!= UtpQueryFuncOpcodeSetFlag
) && (Opcode
!= UtpQueryFuncOpcodeClrFlag
) && (Opcode
!= UtpQueryFuncOpcodeTogFlag
))
611 && ((DataSize
== 0) || (Data
== NULL
))) {
612 return EFI_INVALID_PARAMETER
;
615 if (((Opcode
== UtpQueryFuncOpcodeSetFlag
) || (Opcode
== UtpQueryFuncOpcodeClrFlag
) || (Opcode
== UtpQueryFuncOpcodeTogFlag
))
616 && ((DataSize
!= 0) || (Data
!= NULL
))) {
617 return EFI_INVALID_PARAMETER
;
620 if ((Opcode
== UtpQueryFuncOpcodeWrAttr
) && (DataSize
!= sizeof (UINT32
))) {
621 return EFI_INVALID_PARAMETER
;
624 if ((Opcode
== UtpQueryFuncOpcodeWrDesc
) || (Opcode
== UtpQueryFuncOpcodeRdDesc
)) {
625 TotalLen
= ROUNDUP8 (sizeof (UTP_QUERY_REQ_UPIU
)) + ROUNDUP8 (sizeof (UTP_QUERY_RESP_UPIU
)) + ROUNDUP8 (DataSize
);
627 TotalLen
= ROUNDUP8 (sizeof (UTP_QUERY_REQ_UPIU
)) + ROUNDUP8 (sizeof (UTP_QUERY_RESP_UPIU
));
630 Status
= UfsAllocateAlignCommonBuffer (Private
, TotalLen
, CmdDescHost
, &CmdDescPhyAddr
, CmdDescMapping
);
631 if (EFI_ERROR (Status
)) {
636 // Initialize UTP QUERY REQUEST UPIU
638 QueryReqUpiu
= (UTP_QUERY_REQ_UPIU
*)*CmdDescHost
;
639 ASSERT (QueryReqUpiu
!= NULL
);
640 UfsInitQueryRequestUpiu (
652 // Fill UTP_TRD associated fields
653 // NOTE: Some UFS host controllers request the Query Response UPIU *MUST* be located at a 64-bit aligned boundary.
655 Trd
->Int
= UFS_INTERRUPT_COMMAND
;
656 Trd
->Dd
= DataDirection
;
657 Trd
->Ct
= UFS_STORAGE_COMMAND_TYPE
;
659 Trd
->UcdBa
= (UINT32
)RShiftU64 ((UINT64
)CmdDescPhyAddr
, 7);
660 Trd
->UcdBaU
= (UINT32
)RShiftU64 ((UINT64
)CmdDescPhyAddr
, 32);
661 if (Opcode
== UtpQueryFuncOpcodeWrDesc
) {
662 Trd
->RuL
= (UINT16
)DivU64x32 ((UINT64
)ROUNDUP8 (sizeof (UTP_QUERY_RESP_UPIU
)), sizeof (UINT32
));
663 Trd
->RuO
= (UINT16
)DivU64x32 ((UINT64
)(ROUNDUP8 (sizeof (UTP_QUERY_REQ_UPIU
)) + ROUNDUP8 (DataSize
)), sizeof (UINT32
));
665 Trd
->RuL
= (UINT16
)DivU64x32 ((UINT64
)(ROUNDUP8 (sizeof (UTP_QUERY_RESP_UPIU
)) + ROUNDUP8 (DataSize
)), sizeof (UINT32
));
666 Trd
->RuO
= (UINT16
)DivU64x32 ((UINT64
)ROUNDUP8 (sizeof (UTP_QUERY_REQ_UPIU
)), sizeof (UINT32
));
673 Allocate NOP IN and NOP OUT UPIU for filling UTP TRD's command descriptor field.
675 @param[in] Private The pointer to the UFS_PASS_THRU_PRIVATE_DATA data structure.
676 @param[in] Trd The pointer to the UTP Transfer Request Descriptor.
677 @param[out] CmdDescHost A pointer to store the base system memory address of the allocated range.
678 @param[out] CmdDescMapping A resulting value to pass to Unmap().
680 @retval EFI_SUCCESS The creation succeed.
681 @retval EFI_DEVICE_ERROR The creation failed.
682 @retval EFI_OUT_OF_RESOURCES The memory resource is insufficient.
686 UfsCreateNopCommandDesc (
687 IN UFS_PASS_THRU_PRIVATE_DATA
*Private
,
689 OUT VOID
**CmdDescHost
,
690 OUT VOID
**CmdDescMapping
694 UTP_NOP_OUT_UPIU
*NopOutUpiu
;
696 EFI_PHYSICAL_ADDRESS CmdDescPhyAddr
;
698 ASSERT ((Private
!= NULL
) && (Trd
!= NULL
));
700 TotalLen
= ROUNDUP8 (sizeof (UTP_NOP_OUT_UPIU
)) + ROUNDUP8 (sizeof (UTP_NOP_IN_UPIU
));
701 Status
= UfsAllocateAlignCommonBuffer (Private
, TotalLen
, CmdDescHost
, &CmdDescPhyAddr
, CmdDescMapping
);
702 if (EFI_ERROR (Status
)) {
706 NopOutUpiu
= (UTP_NOP_OUT_UPIU
*)*CmdDescHost
;
707 ASSERT (NopOutUpiu
!= NULL
);
708 NopOutUpiu
->TaskTag
= Private
->TaskTag
++;
711 // Fill UTP_TRD associated fields
712 // NOTE: Some UFS host controllers request the Nop Out UPIU *MUST* be located at a 64-bit aligned boundary.
714 Trd
->Int
= UFS_INTERRUPT_COMMAND
;
716 Trd
->Ct
= UFS_STORAGE_COMMAND_TYPE
;
717 Trd
->UcdBa
= (UINT32
)RShiftU64 ((UINT64
)CmdDescPhyAddr
, 7);
718 Trd
->UcdBaU
= (UINT32
)RShiftU64 ((UINT64
)CmdDescPhyAddr
, 32);
719 Trd
->RuL
= (UINT16
)DivU64x32 ((UINT64
)ROUNDUP8 (sizeof (UTP_NOP_IN_UPIU
)), sizeof (UINT32
));
720 Trd
->RuO
= (UINT16
)DivU64x32 ((UINT64
)ROUNDUP8 (sizeof (UTP_NOP_OUT_UPIU
)), sizeof (UINT32
));
726 Find out available slot in transfer list of a UFS device.
728 @param[in] Private The pointer to the UFS_PASS_THRU_PRIVATE_DATA data structure.
729 @param[out] Slot The available slot.
731 @retval EFI_SUCCESS The available slot was found successfully.
732 @retval EFI_NOT_READY No slot is available at this moment.
736 UfsFindAvailableSlotInTrl (
737 IN UFS_PASS_THRU_PRIVATE_DATA
*Private
,
746 ASSERT ((Private
!= NULL
) && (Slot
!= NULL
));
748 Status
= UfsMmioRead32 (Private
, UFS_HC_UTRLDBR_OFFSET
, &Data
);
749 if (EFI_ERROR (Status
)) {
753 Nutrs
= (UINT8
)((Private
->Capabilities
& UFS_HC_CAP_NUTRS
) + 1);
755 for (Index
= 0; Index
< Nutrs
; Index
++) {
756 if ((Data
& (BIT0
<< Index
)) == 0) {
762 return EFI_NOT_READY
;
766 Find out available slot in task management transfer list of a UFS device.
768 @param[in] Private The pointer to the UFS_PASS_THRU_PRIVATE_DATA data structure.
769 @param[out] Slot The available slot.
771 @retval EFI_SUCCESS The available slot was found successfully.
775 UfsFindAvailableSlotInTmrl (
776 IN UFS_PASS_THRU_PRIVATE_DATA
*Private
,
780 ASSERT ((Private
!= NULL
) && (Slot
!= NULL
));
783 // The simplest algo to always use slot 0.
784 // TODO: enhance it to support async transfer with multiple slot.
792 Start specified slot in transfer list of a UFS device.
794 @param[in] Private The pointer to the UFS_PASS_THRU_PRIVATE_DATA data structure.
795 @param[in] Slot The slot to be started.
800 IN UFS_PASS_THRU_PRIVATE_DATA
*Private
,
807 Status
= UfsMmioRead32 (Private
, UFS_HC_UTRLRSR_OFFSET
, &Data
);
808 if (EFI_ERROR (Status
)) {
812 if ((Data
& UFS_HC_UTRLRSR
) != UFS_HC_UTRLRSR
) {
813 Status
= UfsMmioWrite32 (Private
, UFS_HC_UTRLRSR_OFFSET
, UFS_HC_UTRLRSR
);
814 if (EFI_ERROR (Status
)) {
819 Status
= UfsMmioWrite32 (Private
, UFS_HC_UTRLDBR_OFFSET
, BIT0
<< Slot
);
820 if (EFI_ERROR (Status
)) {
828 Stop specified slot in transfer list of a UFS device.
830 @param[in] Private The pointer to the UFS_PASS_THRU_PRIVATE_DATA data structure.
831 @param[in] Slot The slot to be stop.
836 IN UFS_PASS_THRU_PRIVATE_DATA
*Private
,
843 Status
= UfsMmioRead32 (Private
, UFS_HC_UTRLDBR_OFFSET
, &Data
);
844 if (EFI_ERROR (Status
)) {
848 if ((Data
& (BIT0
<< Slot
)) != 0) {
849 Status
= UfsMmioRead32 (Private
, UFS_HC_UTRLCLR_OFFSET
, &Data
);
850 if (EFI_ERROR (Status
)) {
854 Status
= UfsMmioWrite32 (Private
, UFS_HC_UTRLCLR_OFFSET
, Data
& ~(BIT0
<< Slot
));
855 if (EFI_ERROR (Status
)) {
864 Read or write specified device descriptor of a UFS device.
866 @param[in] Private The pointer to the UFS_PASS_THRU_PRIVATE_DATA data structure.
867 @param[in] Read The boolean variable to show r/w direction.
868 @param[in] DescId The ID of device descriptor.
869 @param[in] Index The Index of device descriptor.
870 @param[in] Selector The Selector of device descriptor.
871 @param[in, out] Descriptor The buffer of device descriptor to be read or written.
872 @param[in] DescSize The size of device descriptor buffer.
874 @retval EFI_SUCCESS The device descriptor was read/written successfully.
875 @retval EFI_DEVICE_ERROR A device error occurred while attempting to r/w the device descriptor.
876 @retval EFI_TIMEOUT A timeout occurred while waiting for the completion of r/w the device descriptor.
881 IN UFS_PASS_THRU_PRIVATE_DATA
*Private
,
886 IN OUT VOID
*Descriptor
,
891 UFS_DEVICE_MANAGEMENT_REQUEST_PACKET Packet
;
894 UTP_QUERY_RESP_UPIU
*QueryResp
;
896 UINT16 ReturnDataSize
;
898 VOID
*CmdDescMapping
;
899 EDKII_UFS_HOST_CONTROLLER_PROTOCOL
*UfsHc
;
901 ZeroMem (&Packet
, sizeof (UFS_DEVICE_MANAGEMENT_REQUEST_PACKET
));
904 Packet
.DataDirection
= UfsDataIn
;
905 Packet
.InDataBuffer
= Descriptor
;
906 Packet
.InTransferLength
= DescSize
;
907 Packet
.Opcode
= UtpQueryFuncOpcodeRdDesc
;
909 Packet
.DataDirection
= UfsDataOut
;
910 Packet
.OutDataBuffer
= Descriptor
;
911 Packet
.OutTransferLength
= DescSize
;
912 Packet
.Opcode
= UtpQueryFuncOpcodeWrDesc
;
914 Packet
.DescId
= DescId
;
915 Packet
.Index
= Index
;
916 Packet
.Selector
= Selector
;
917 Packet
.Timeout
= UFS_TIMEOUT
;
920 // Find out which slot of transfer request list is available.
922 Status
= UfsFindAvailableSlotInTrl (Private
, &Slot
);
923 if (EFI_ERROR (Status
)) {
927 Trd
= ((UTP_TRD
*)Private
->UtpTrlBase
) + Slot
;
929 // Fill transfer request descriptor to this slot.
931 Status
= UfsCreateDMCommandDesc (Private
, &Packet
, Trd
, &CmdDescHost
, &CmdDescMapping
);
932 if (EFI_ERROR (Status
)) {
937 // Check the transfer request result.
939 UfsHc
= Private
->UfsHostController
;
940 QueryResp
= (UTP_QUERY_RESP_UPIU
*)((UINT8
*)CmdDescHost
+ Trd
->RuO
* sizeof (UINT32
));
941 ASSERT (QueryResp
!= NULL
);
942 CmdDescSize
= Trd
->RuO
* sizeof (UINT32
) + Trd
->RuL
* sizeof (UINT32
);
945 // Start to execute the transfer request.
947 UfsStartExecCmd (Private
, Slot
);
950 // Wait for the completion of the transfer request.
952 Status
= UfsWaitMemSet (Private
, UFS_HC_UTRLDBR_OFFSET
, BIT0
, 0, Packet
.Timeout
);
953 if (EFI_ERROR (Status
)) {
957 if (QueryResp
->QueryResp
!= 0) {
958 DumpQueryResponseResult (QueryResp
->QueryResp
);
959 Status
= EFI_DEVICE_ERROR
;
964 ReturnDataSize
= QueryResp
->Tsf
.Length
;
965 SwapLittleEndianToBigEndian ((UINT8
*)&ReturnDataSize
, sizeof (UINT16
));
968 CopyMem (Packet
.InDataBuffer
, (QueryResp
+ 1), ReturnDataSize
);
969 Packet
.InTransferLength
= ReturnDataSize
;
971 Packet
.OutTransferLength
= ReturnDataSize
;
974 Status
= EFI_DEVICE_ERROR
;
978 UfsHc
->Flush (UfsHc
);
980 UfsStopExecCmd (Private
, Slot
);
982 if (CmdDescMapping
!= NULL
) {
983 UfsHc
->Unmap (UfsHc
, CmdDescMapping
);
985 if (CmdDescHost
!= NULL
) {
986 UfsHc
->FreeBuffer (UfsHc
, EFI_SIZE_TO_PAGES (CmdDescSize
), CmdDescHost
);
993 Read or write specified attribute of a UFS device.
995 @param[in] Private The pointer to the UFS_PASS_THRU_PRIVATE_DATA data structure.
996 @param[in] Read The boolean variable to show r/w direction.
997 @param[in] AttrId The ID of Attribute.
998 @param[in] Index The Index of Attribute.
999 @param[in] Selector The Selector of Attribute.
1000 @param[in, out] Attributes The value of Attribute to be read or written.
1002 @retval EFI_SUCCESS The Attribute was read/written successfully.
1003 @retval EFI_DEVICE_ERROR A device error occurred while attempting to r/w the Attribute.
1004 @retval EFI_TIMEOUT A timeout occurred while waiting for the completion of r/w the Attribute.
1009 IN UFS_PASS_THRU_PRIVATE_DATA
*Private
,
1014 IN OUT UINT32
*Attributes
1018 UFS_DEVICE_MANAGEMENT_REQUEST_PACKET Packet
;
1021 UTP_QUERY_RESP_UPIU
*QueryResp
;
1025 VOID
*CmdDescMapping
;
1026 EDKII_UFS_HOST_CONTROLLER_PROTOCOL
*UfsHc
;
1028 ZeroMem (&Packet
, sizeof (UFS_DEVICE_MANAGEMENT_REQUEST_PACKET
));
1031 Packet
.DataDirection
= UfsDataIn
;
1032 Packet
.Opcode
= UtpQueryFuncOpcodeRdAttr
;
1034 Packet
.DataDirection
= UfsDataOut
;
1035 Packet
.Opcode
= UtpQueryFuncOpcodeWrAttr
;
1037 Packet
.DescId
= AttrId
;
1038 Packet
.Index
= Index
;
1039 Packet
.Selector
= Selector
;
1040 Packet
.Timeout
= UFS_TIMEOUT
;
1043 // Find out which slot of transfer request list is available.
1045 Status
= UfsFindAvailableSlotInTrl (Private
, &Slot
);
1046 if (EFI_ERROR (Status
)) {
1050 Trd
= ((UTP_TRD
*)Private
->UtpTrlBase
) + Slot
;
1052 // Fill transfer request descriptor to this slot.
1054 Status
= UfsCreateDMCommandDesc (Private
, &Packet
, Trd
, &CmdDescHost
, &CmdDescMapping
);
1055 if (EFI_ERROR (Status
)) {
1060 // Check the transfer request result.
1062 UfsHc
= Private
->UfsHostController
;
1063 QueryResp
= (UTP_QUERY_RESP_UPIU
*)((UINT8
*)CmdDescHost
+ Trd
->RuO
* sizeof (UINT32
));
1064 ASSERT (QueryResp
!= NULL
);
1065 CmdDescSize
= Trd
->RuO
* sizeof (UINT32
) + Trd
->RuL
* sizeof (UINT32
);
1068 // Start to execute the transfer request.
1070 UfsStartExecCmd (Private
, Slot
);
1073 // Wait for the completion of the transfer request.
1075 Status
= UfsWaitMemSet (Private
, UFS_HC_UTRLDBR_OFFSET
, BIT0
, 0, Packet
.Timeout
);
1076 if (EFI_ERROR (Status
)) {
1080 if (QueryResp
->QueryResp
!= 0) {
1081 DumpQueryResponseResult (QueryResp
->QueryResp
);
1082 Status
= EFI_DEVICE_ERROR
;
1086 if (Trd
->Ocs
== 0) {
1087 ReturnData
= QueryResp
->Tsf
.Value
;
1088 SwapLittleEndianToBigEndian ((UINT8
*)&ReturnData
, sizeof (UINT32
));
1089 *Attributes
= ReturnData
;
1091 Status
= EFI_DEVICE_ERROR
;
1095 UfsHc
->Flush (UfsHc
);
1097 UfsStopExecCmd (Private
, Slot
);
1099 if (CmdDescMapping
!= NULL
) {
1100 UfsHc
->Unmap (UfsHc
, CmdDescMapping
);
1103 if (CmdDescHost
!= NULL
) {
1104 UfsHc
->FreeBuffer (UfsHc
, EFI_SIZE_TO_PAGES (CmdDescSize
), CmdDescHost
);
1111 Read or write specified flag of a UFS device.
1113 @param[in] Private The pointer to the UFS_PASS_THRU_PRIVATE_DATA data structure.
1114 @param[in] Read The boolean variable to show r/w direction.
1115 @param[in] FlagId The ID of flag to be read or written.
1116 @param[in, out] Value The value to set or clear flag.
1118 @retval EFI_SUCCESS The flag was read/written successfully.
1119 @retval EFI_DEVICE_ERROR A device error occurred while attempting to r/w the flag.
1120 @retval EFI_TIMEOUT A timeout occurred while waiting for the completion of r/w the flag.
1125 IN UFS_PASS_THRU_PRIVATE_DATA
*Private
,
1132 UFS_DEVICE_MANAGEMENT_REQUEST_PACKET Packet
;
1135 UTP_QUERY_RESP_UPIU
*QueryResp
;
1138 VOID
*CmdDescMapping
;
1139 EDKII_UFS_HOST_CONTROLLER_PROTOCOL
*UfsHc
;
1141 if (Value
== NULL
) {
1142 return EFI_INVALID_PARAMETER
;
1145 ZeroMem (&Packet
, sizeof (UFS_DEVICE_MANAGEMENT_REQUEST_PACKET
));
1148 ASSERT (Value
!= NULL
);
1149 Packet
.DataDirection
= UfsDataIn
;
1150 Packet
.Opcode
= UtpQueryFuncOpcodeRdFlag
;
1152 Packet
.DataDirection
= UfsDataOut
;
1154 Packet
.Opcode
= UtpQueryFuncOpcodeSetFlag
;
1155 } else if (*Value
== 0) {
1156 Packet
.Opcode
= UtpQueryFuncOpcodeClrFlag
;
1158 return EFI_INVALID_PARAMETER
;
1161 Packet
.DescId
= FlagId
;
1163 Packet
.Selector
= 0;
1164 Packet
.Timeout
= UFS_TIMEOUT
;
1167 // Find out which slot of transfer request list is available.
1169 Status
= UfsFindAvailableSlotInTrl (Private
, &Slot
);
1170 if (EFI_ERROR (Status
)) {
1175 // Fill transfer request descriptor to this slot.
1177 Trd
= ((UTP_TRD
*)Private
->UtpTrlBase
) + Slot
;
1178 Status
= UfsCreateDMCommandDesc (Private
, &Packet
, Trd
, &CmdDescHost
, &CmdDescMapping
);
1179 if (EFI_ERROR (Status
)) {
1184 // Check the transfer request result.
1186 UfsHc
= Private
->UfsHostController
;
1187 QueryResp
= (UTP_QUERY_RESP_UPIU
*)((UINT8
*)CmdDescHost
+ Trd
->RuO
* sizeof (UINT32
));
1188 ASSERT (QueryResp
!= NULL
);
1189 CmdDescSize
= Trd
->RuO
* sizeof (UINT32
) + Trd
->RuL
* sizeof (UINT32
);
1192 // Start to execute the transfer request.
1194 UfsStartExecCmd (Private
, Slot
);
1197 // Wait for the completion of the transfer request.
1199 Status
= UfsWaitMemSet (Private
, UFS_HC_UTRLDBR_OFFSET
, BIT0
, 0, Packet
.Timeout
);
1200 if (EFI_ERROR (Status
)) {
1204 if (QueryResp
->QueryResp
!= 0) {
1205 DumpQueryResponseResult (QueryResp
->QueryResp
);
1206 Status
= EFI_DEVICE_ERROR
;
1210 if (Trd
->Ocs
== 0) {
1211 *Value
= (UINT8
)QueryResp
->Tsf
.Value
;
1213 Status
= EFI_DEVICE_ERROR
;
1217 UfsHc
->Flush (UfsHc
);
1219 UfsStopExecCmd (Private
, Slot
);
1221 if (CmdDescMapping
!= NULL
) {
1222 UfsHc
->Unmap (UfsHc
, CmdDescMapping
);
1224 if (CmdDescHost
!= NULL
) {
1225 UfsHc
->FreeBuffer (UfsHc
, EFI_SIZE_TO_PAGES (CmdDescSize
), CmdDescHost
);
1232 Set specified flag to 1 on a UFS device.
1234 @param[in] Private The pointer to the UFS_PASS_THRU_PRIVATE_DATA data structure.
1235 @param[in] FlagId The ID of flag to be set.
1237 @retval EFI_SUCCESS The flag was set successfully.
1238 @retval EFI_DEVICE_ERROR A device error occurred while attempting to set the flag.
1239 @retval EFI_TIMEOUT A timeout occurred while waiting for the completion of setting the flag.
1244 IN UFS_PASS_THRU_PRIVATE_DATA
*Private
,
1252 Status
= UfsRwFlags (Private
, FALSE
, FlagId
, &Value
);
1258 Clear specified flag to 0 on a UFS device.
1260 @param[in] Private The pointer to the UFS_PASS_THRU_PRIVATE_DATA data structure.
1261 @param[in] FlagId The ID of flag to be cleared.
1263 @retval EFI_SUCCESS The flag was cleared successfully.
1264 @retval EFI_DEVICE_ERROR A device error occurred while attempting to clear the flag.
1265 @retval EFI_TIMEOUT A timeout occurred while waiting for the completion of clearing the flag.
1270 IN UFS_PASS_THRU_PRIVATE_DATA
*Private
,
1278 Status
= UfsRwFlags (Private
, FALSE
, FlagId
, &Value
);
1284 Read specified flag from a UFS device.
1286 @param[in] Private The pointer to the UFS_PASS_THRU_PRIVATE_DATA data structure.
1287 @param[in] FlagId The ID of flag to be read.
1288 @param[out] Value The flag's value.
1290 @retval EFI_SUCCESS The flag was read successfully.
1291 @retval EFI_DEVICE_ERROR A device error occurred while attempting to read the flag.
1292 @retval EFI_TIMEOUT A timeout occurred while waiting for the completion of reading the flag.
1297 IN UFS_PASS_THRU_PRIVATE_DATA
*Private
,
1304 Status
= UfsRwFlags (Private
, TRUE
, FlagId
, Value
);
1310 Sends NOP IN cmd to a UFS device for initialization process request.
1311 For more details, please refer to UFS 2.0 spec Figure 13.3.
1313 @param[in] Private The pointer to the UFS_PASS_THRU_PRIVATE_DATA data structure.
1315 @retval EFI_SUCCESS The NOP IN command was sent by the host. The NOP OUT response was
1316 received successfully.
1317 @retval EFI_DEVICE_ERROR A device error occurred while attempting to execute NOP IN command.
1318 @retval EFI_OUT_OF_RESOURCES The resource for transfer is not available.
1319 @retval EFI_TIMEOUT A timeout occurred while waiting for the NOP IN command to execute.
1324 IN UFS_PASS_THRU_PRIVATE_DATA
*Private
1330 UTP_NOP_IN_UPIU
*NopInUpiu
;
1333 VOID
*CmdDescMapping
;
1334 EDKII_UFS_HOST_CONTROLLER_PROTOCOL
*UfsHc
;
1337 // Find out which slot of transfer request list is available.
1339 Status
= UfsFindAvailableSlotInTrl (Private
, &Slot
);
1340 if (EFI_ERROR (Status
)) {
1344 Trd
= ((UTP_TRD
*)Private
->UtpTrlBase
) + Slot
;
1345 Status
= UfsCreateNopCommandDesc (Private
, Trd
, &CmdDescHost
, &CmdDescMapping
);
1346 if (EFI_ERROR (Status
)) {
1351 // Check the transfer request result.
1353 UfsHc
= Private
->UfsHostController
;
1354 NopInUpiu
= (UTP_NOP_IN_UPIU
*)((UINT8
*)CmdDescHost
+ Trd
->RuO
* sizeof (UINT32
));
1355 ASSERT (NopInUpiu
!= NULL
);
1356 CmdDescSize
= Trd
->RuO
* sizeof (UINT32
) + Trd
->RuL
* sizeof (UINT32
);
1359 // Start to execute the transfer request.
1361 UfsStartExecCmd (Private
, Slot
);
1364 // Wait for the completion of the transfer request.
1366 Status
= UfsWaitMemSet (Private
, UFS_HC_UTRLDBR_OFFSET
, BIT0
, 0, UFS_TIMEOUT
);
1367 if (EFI_ERROR (Status
)) {
1371 if (NopInUpiu
->Resp
!= 0) {
1372 Status
= EFI_DEVICE_ERROR
;
1374 Status
= EFI_SUCCESS
;
1378 UfsHc
->Flush (UfsHc
);
1380 UfsStopExecCmd (Private
, Slot
);
1382 if (CmdDescMapping
!= NULL
) {
1383 UfsHc
->Unmap (UfsHc
, CmdDescMapping
);
1385 if (CmdDescHost
!= NULL
) {
1386 UfsHc
->FreeBuffer (UfsHc
, EFI_SIZE_TO_PAGES (CmdDescSize
), CmdDescHost
);
1393 Sends a UFS-supported SCSI Request Packet to a UFS device that is attached to the UFS host controller.
1395 @param[in] Private The pointer to the UFS_PASS_THRU_PRIVATE_DATA data structure.
1396 @param[in] Lun The LUN of the UFS device to send the SCSI Request Packet.
1397 @param[in, out] Packet A pointer to the SCSI Request Packet to send to a specified Lun of the
1399 @param[in] Event If nonblocking I/O is not supported then Event is ignored, and blocking
1400 I/O is performed. If Event is NULL, then blocking I/O is performed. If
1401 Event is not NULL and non blocking I/O is supported, then
1402 nonblocking I/O is performed, and Event will be signaled when the
1403 SCSI Request Packet completes.
1405 @retval EFI_SUCCESS The SCSI Request Packet was sent by the host. For bi-directional
1406 commands, InTransferLength bytes were transferred from
1407 InDataBuffer. For write and bi-directional commands,
1408 OutTransferLength bytes were transferred by
1410 @retval EFI_DEVICE_ERROR A device error occurred while attempting to send the SCSI Request
1412 @retval EFI_OUT_OF_RESOURCES The resource for transfer is not available.
1413 @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
1418 IN UFS_PASS_THRU_PRIVATE_DATA
*Private
,
1420 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
,
1421 IN EFI_EVENT Event OPTIONAL
1425 UTP_RESPONSE_UPIU
*Response
;
1426 UINT16 SenseDataLen
;
1427 UINT32 ResTranCount
;
1429 EFI_PHYSICAL_ADDRESS DataBufPhyAddr
;
1432 EDKII_UFS_HOST_CONTROLLER_PROTOCOL
*UfsHc
;
1433 EDKII_UFS_HOST_CONTROLLER_OPERATION Flag
;
1434 UFS_DATA_DIRECTION DataDirection
;
1435 UTP_TR_PRD
*PrdtBase
;
1437 UFS_PASS_THRU_TRANS_REQ
*TransReq
;
1439 TransReq
= AllocateZeroPool (sizeof (UFS_PASS_THRU_TRANS_REQ
));
1440 if (TransReq
== NULL
) {
1441 return EFI_OUT_OF_RESOURCES
;
1444 TransReq
->Signature
= UFS_PASS_THRU_TRANS_REQ_SIG
;
1445 TransReq
->TimeoutRemain
= Packet
->Timeout
;
1447 UfsHc
= Private
->UfsHostController
;
1449 // Find out which slot of transfer request list is available.
1451 Status
= UfsFindAvailableSlotInTrl (Private
, &TransReq
->Slot
);
1452 if (EFI_ERROR (Status
)) {
1456 TransReq
->Trd
= ((UTP_TRD
*)Private
->UtpTrlBase
) + TransReq
->Slot
;
1459 // Fill transfer request descriptor to this slot.
1461 Status
= UfsCreateScsiCommandDesc (
1466 &TransReq
->CmdDescHost
,
1467 &TransReq
->CmdDescMapping
1469 if (EFI_ERROR (Status
)) {
1473 TransReq
->CmdDescSize
= TransReq
->Trd
->PrdtO
* sizeof (UINT32
) + TransReq
->Trd
->PrdtL
* sizeof (UTP_TR_PRD
);
1475 if (Packet
->DataDirection
== EFI_EXT_SCSI_DATA_DIRECTION_READ
) {
1476 DataBuf
= Packet
->InDataBuffer
;
1477 DataLen
= Packet
->InTransferLength
;
1478 DataDirection
= UfsDataIn
;
1479 Flag
= EdkiiUfsHcOperationBusMasterWrite
;
1481 DataBuf
= Packet
->OutDataBuffer
;
1482 DataLen
= Packet
->OutTransferLength
;
1483 DataDirection
= UfsDataOut
;
1484 Flag
= EdkiiUfsHcOperationBusMasterRead
;
1488 DataDirection
= UfsNoData
;
1490 MapLength
= DataLen
;
1491 Status
= UfsHc
->Map (
1497 &TransReq
->DataBufMapping
1500 if (EFI_ERROR (Status
) || (DataLen
!= MapLength
)) {
1505 // Fill PRDT table of Command UPIU for executed SCSI cmd.
1507 PrdtBase
= (UTP_TR_PRD
*)((UINT8
*)TransReq
->CmdDescHost
+ ROUNDUP8 (sizeof (UTP_COMMAND_UPIU
)) + ROUNDUP8 (sizeof (UTP_RESPONSE_UPIU
)));
1508 ASSERT (PrdtBase
!= NULL
);
1509 UfsInitUtpPrdt (PrdtBase
, (VOID
*)(UINTN
)DataBufPhyAddr
, DataLen
);
1512 // Insert the async SCSI cmd to the Async I/O list
1514 if (Event
!= NULL
) {
1515 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1516 TransReq
->Packet
= Packet
;
1517 TransReq
->CallerEvent
= Event
;
1518 InsertTailList (&Private
->Queue
, &TransReq
->TransferList
);
1519 gBS
->RestoreTPL (OldTpl
);
1523 // Start to execute the transfer request.
1525 UfsStartExecCmd (Private
, TransReq
->Slot
);
1528 // Immediately return for async I/O.
1530 if (Event
!= NULL
) {
1535 // Wait for the completion of the transfer request.
1537 Status
= UfsWaitMemSet (Private
, UFS_HC_UTRLDBR_OFFSET
, BIT0
, 0, Packet
->Timeout
);
1538 if (EFI_ERROR (Status
)) {
1543 // Get sense data if exists
1545 Response
= (UTP_RESPONSE_UPIU
*)((UINT8
*)TransReq
->CmdDescHost
+ TransReq
->Trd
->RuO
* sizeof (UINT32
));
1546 ASSERT (Response
!= NULL
);
1547 SenseDataLen
= Response
->SenseDataLen
;
1548 SwapLittleEndianToBigEndian ((UINT8
*)&SenseDataLen
, sizeof (UINT16
));
1550 if ((Packet
->SenseDataLength
!= 0) && (Packet
->SenseData
!= NULL
)) {
1551 CopyMem (Packet
->SenseData
, Response
->SenseData
, SenseDataLen
);
1552 Packet
->SenseDataLength
= (UINT8
)SenseDataLen
;
1556 // Check the transfer request result.
1558 Packet
->TargetStatus
= Response
->Status
;
1559 if (Response
->Response
!= 0) {
1560 DEBUG ((EFI_D_ERROR
, "UfsExecScsiCmds() fails with Target Failure\n"));
1561 Status
= EFI_DEVICE_ERROR
;
1565 if (TransReq
->Trd
->Ocs
== 0) {
1566 if (Packet
->DataDirection
== EFI_EXT_SCSI_DATA_DIRECTION_READ
) {
1567 if ((Response
->Flags
& BIT5
) == BIT5
) {
1568 ResTranCount
= Response
->ResTranCount
;
1569 SwapLittleEndianToBigEndian ((UINT8
*)&ResTranCount
, sizeof (UINT32
));
1570 Packet
->InTransferLength
-= ResTranCount
;
1573 if ((Response
->Flags
& BIT5
) == BIT5
) {
1574 ResTranCount
= Response
->ResTranCount
;
1575 SwapLittleEndianToBigEndian ((UINT8
*)&ResTranCount
, sizeof (UINT32
));
1576 Packet
->OutTransferLength
-= ResTranCount
;
1580 Status
= EFI_DEVICE_ERROR
;
1584 UfsHc
->Flush (UfsHc
);
1586 UfsStopExecCmd (Private
, TransReq
->Slot
);
1588 if (TransReq
->DataBufMapping
!= NULL
) {
1589 UfsHc
->Unmap (UfsHc
, TransReq
->DataBufMapping
);
1593 if (TransReq
->CmdDescMapping
!= NULL
) {
1594 UfsHc
->Unmap (UfsHc
, TransReq
->CmdDescMapping
);
1596 if (TransReq
->CmdDescHost
!= NULL
) {
1597 UfsHc
->FreeBuffer (UfsHc
, EFI_SIZE_TO_PAGES (TransReq
->CmdDescSize
), TransReq
->CmdDescHost
);
1599 if (TransReq
!= NULL
) {
1600 FreePool (TransReq
);
1607 Sent UIC DME_LINKSTARTUP command to start the link startup procedure.
1609 @param[in] Private The pointer to the UFS_PASS_THRU_PRIVATE_DATA data structure.
1610 @param[in] UicOpcode The opcode of the UIC command.
1611 @param[in] Arg1 The value for 1st argument of the UIC command.
1612 @param[in] Arg2 The value for 2nd argument of the UIC command.
1613 @param[in] Arg3 The value for 3rd argument of the UIC command.
1615 @return EFI_SUCCESS Successfully execute this UIC command and detect attached UFS device.
1616 @return EFI_DEVICE_ERROR Fail to execute this UIC command and detect attached UFS device.
1617 @return EFI_NOT_FOUND The presence of the UFS device isn't detected.
1621 UfsExecUicCommands (
1622 IN UFS_PASS_THRU_PRIVATE_DATA
*Private
,
1632 Status
= UfsMmioRead32 (Private
, UFS_HC_IS_OFFSET
, &Data
);
1633 if (EFI_ERROR (Status
)) {
1637 if ((Data
& UFS_HC_IS_UCCS
) == UFS_HC_IS_UCCS
) {
1639 // Clear IS.BIT10 UIC Command Completion Status (UCCS) at first.
1641 Status
= UfsMmioWrite32 (Private
, UFS_HC_IS_OFFSET
, Data
);
1642 if (EFI_ERROR (Status
)) {
1648 // When programming UIC command registers, host software shall set the register UICCMD
1649 // only after all the UIC command argument registers (UICCMDARG1, UICCMDARG2 and UICCMDARG3)
1652 Status
= UfsMmioWrite32 (Private
, UFS_HC_UCMD_ARG1_OFFSET
, Arg1
);
1653 if (EFI_ERROR (Status
)) {
1657 Status
= UfsMmioWrite32 (Private
, UFS_HC_UCMD_ARG2_OFFSET
, Arg2
);
1658 if (EFI_ERROR (Status
)) {
1662 Status
= UfsMmioWrite32 (Private
, UFS_HC_UCMD_ARG3_OFFSET
, Arg3
);
1663 if (EFI_ERROR (Status
)) {
1668 // Host software shall only set the UICCMD if HCS.UCRDY is set to 1.
1670 Status
= UfsWaitMemSet (Private
, UFS_HC_STATUS_OFFSET
, UFS_HC_HCS_UCRDY
, UFS_HC_HCS_UCRDY
, UFS_TIMEOUT
);
1671 if (EFI_ERROR (Status
)) {
1675 Status
= UfsMmioWrite32 (Private
, UFS_HC_UIC_CMD_OFFSET
, (UINT32
)UicOpcode
);
1676 if (EFI_ERROR (Status
)) {
1681 // UFS 2.0 spec section 5.3.1 Offset:0x20 IS.Bit10 UIC Command Completion Status (UCCS)
1682 // This bit is set to '1' by the host controller upon completion of a UIC command.
1684 Status
= UfsWaitMemSet (Private
, UFS_HC_IS_OFFSET
, UFS_HC_IS_UCCS
, UFS_HC_IS_UCCS
, UFS_TIMEOUT
);
1685 if (EFI_ERROR (Status
)) {
1689 if (UicOpcode
!= UfsUicDmeReset
) {
1690 Status
= UfsMmioRead32 (Private
, UFS_HC_UCMD_ARG2_OFFSET
, &Data
);
1691 if (EFI_ERROR (Status
)) {
1694 if ((Data
& 0xFF) != 0) {
1696 DumpUicCmdExecResult (UicOpcode
, (UINT8
)(Data
& 0xFF));
1698 return EFI_DEVICE_ERROR
;
1703 // Check value of HCS.DP and make sure that there is a device attached to the Link.
1705 Status
= UfsMmioRead32 (Private
, UFS_HC_STATUS_OFFSET
, &Data
);
1706 if (EFI_ERROR (Status
)) {
1710 if ((Data
& UFS_HC_HCS_DP
) == 0) {
1711 Status
= UfsWaitMemSet (Private
, UFS_HC_IS_OFFSET
, UFS_HC_IS_ULSS
, UFS_HC_IS_ULSS
, UFS_TIMEOUT
);
1712 if (EFI_ERROR (Status
)) {
1713 return EFI_DEVICE_ERROR
;
1715 return EFI_NOT_FOUND
;
1718 DEBUG ((EFI_D_INFO
, "UfsPassThruDxe: found a attached UFS device\n"));
1724 Allocate common buffer for host and UFS bus master access simultaneously.
1726 @param[in] Private The pointer to the UFS_PASS_THRU_PRIVATE_DATA data structure.
1727 @param[in] Size The length of buffer to be allocated.
1728 @param[out] CmdDescHost A pointer to store the base system memory address of the allocated range.
1729 @param[out] CmdDescPhyAddr The resulting map address for the UFS bus master to use to access the hosts CmdDescHost.
1730 @param[out] CmdDescMapping A resulting value to pass to Unmap().
1732 @retval EFI_SUCCESS The common buffer was allocated successfully.
1733 @retval EFI_DEVICE_ERROR The allocation fails.
1734 @retval EFI_OUT_OF_RESOURCES The memory resource is insufficient.
1738 UfsAllocateAlignCommonBuffer (
1739 IN UFS_PASS_THRU_PRIVATE_DATA
*Private
,
1741 OUT VOID
**CmdDescHost
,
1742 OUT EFI_PHYSICAL_ADDRESS
*CmdDescPhyAddr
,
1743 OUT VOID
**CmdDescMapping
1748 BOOLEAN Is32BitAddr
;
1749 EDKII_UFS_HOST_CONTROLLER_PROTOCOL
*UfsHc
;
1751 if ((Private
->Capabilities
& UFS_HC_CAP_64ADDR
) == UFS_HC_CAP_64ADDR
) {
1754 Is32BitAddr
= FALSE
;
1757 UfsHc
= Private
->UfsHostController
;
1758 Status
= UfsHc
->AllocateBuffer (
1761 EfiBootServicesData
,
1762 EFI_SIZE_TO_PAGES (Size
),
1766 if (EFI_ERROR (Status
)) {
1767 *CmdDescMapping
= NULL
;
1768 *CmdDescHost
= NULL
;
1769 *CmdDescPhyAddr
= 0;
1770 return EFI_OUT_OF_RESOURCES
;
1773 Bytes
= EFI_PAGES_TO_SIZE (EFI_SIZE_TO_PAGES (Size
));
1774 Status
= UfsHc
->Map (
1776 EdkiiUfsHcOperationBusMasterCommonBuffer
,
1783 if (EFI_ERROR (Status
) || (Bytes
!= EFI_PAGES_TO_SIZE (EFI_SIZE_TO_PAGES (Size
)))) {
1786 EFI_PAGES_TO_SIZE (EFI_SIZE_TO_PAGES (Size
)),
1789 *CmdDescHost
= NULL
;
1790 return EFI_OUT_OF_RESOURCES
;
1793 if (Is32BitAddr
&& ((*CmdDescPhyAddr
) > 0x100000000ULL
)) {
1795 // The UFS host controller doesn't support 64bit addressing, so should not get a >4G UFS bus master address.
1803 EFI_PAGES_TO_SIZE (EFI_SIZE_TO_PAGES (Size
)),
1806 *CmdDescMapping
= NULL
;
1807 *CmdDescHost
= NULL
;
1808 return EFI_DEVICE_ERROR
;
1811 ZeroMem (*CmdDescHost
, EFI_PAGES_TO_SIZE (EFI_SIZE_TO_PAGES (Size
)));
1816 Enable the UFS host controller for accessing.
1818 @param[in] Private The pointer to the UFS_PASS_THRU_PRIVATE_DATA data structure.
1820 @retval EFI_SUCCESS The UFS host controller enabling was executed successfully.
1821 @retval EFI_DEVICE_ERROR A device error occurred while enabling the UFS host controller.
1825 UfsEnableHostController (
1826 IN UFS_PASS_THRU_PRIVATE_DATA
*Private
1833 // UFS 2.0 spec section 7.1.1 - Host Controller Initialization
1835 // Reinitialize the UFS host controller if HCE bit of HC register is set.
1837 Status
= UfsMmioRead32 (Private
, UFS_HC_ENABLE_OFFSET
, &Data
);
1838 if (EFI_ERROR (Status
)) {
1842 if ((Data
& UFS_HC_HCE_EN
) == UFS_HC_HCE_EN
) {
1844 // Write a 0 to the HCE register at first to disable the host controller.
1846 Status
= UfsMmioWrite32 (Private
, UFS_HC_ENABLE_OFFSET
, 0);
1847 if (EFI_ERROR (Status
)) {
1851 // Wait until HCE is read as '0' before continuing.
1853 Status
= UfsWaitMemSet (Private
, UFS_HC_ENABLE_OFFSET
, UFS_HC_HCE_EN
, 0, UFS_TIMEOUT
);
1854 if (EFI_ERROR (Status
)) {
1855 return EFI_DEVICE_ERROR
;
1860 // Write a 1 to the HCE register to enable the UFS host controller.
1862 Status
= UfsMmioWrite32 (Private
, UFS_HC_ENABLE_OFFSET
, UFS_HC_HCE_EN
);
1863 if (EFI_ERROR (Status
)) {
1868 // Wait until HCE is read as '1' before continuing.
1870 Status
= UfsWaitMemSet (Private
, UFS_HC_ENABLE_OFFSET
, UFS_HC_HCE_EN
, UFS_HC_HCE_EN
, UFS_TIMEOUT
);
1871 if (EFI_ERROR (Status
)) {
1872 return EFI_DEVICE_ERROR
;
1879 Detect if a UFS device attached.
1881 @param[in] Private The pointer to the UFS_PASS_THRU_PRIVATE_DATA data structure.
1883 @retval EFI_SUCCESS The UFS device detection was executed successfully.
1884 @retval EFI_NOT_FOUND Not found a UFS device attached.
1885 @retval EFI_DEVICE_ERROR A device error occurred while detecting the UFS device.
1889 UfsDeviceDetection (
1890 IN UFS_PASS_THRU_PRIVATE_DATA
*Private
1897 // Start UFS device detection.
1898 // Try up to 3 times for establishing data link with device.
1900 for (Retry
= 0; Retry
< 3; Retry
++) {
1901 Status
= UfsExecUicCommands (Private
, UfsUicDmeLinkStartup
, 0, 0, 0);
1902 if (!EFI_ERROR (Status
)) {
1906 if (Status
== EFI_NOT_FOUND
) {
1910 return EFI_DEVICE_ERROR
;
1914 return EFI_NOT_FOUND
;
1921 Initialize UFS task management request list related h/w context.
1923 @param[in] Private The pointer to the UFS_PASS_THRU_PRIVATE_DATA data structure.
1925 @retval EFI_SUCCESS The UFS task management list was initialzed successfully.
1926 @retval EFI_DEVICE_ERROR The initialization fails.
1930 UfsInitTaskManagementRequestList (
1931 IN UFS_PASS_THRU_PRIVATE_DATA
*Private
1937 EFI_PHYSICAL_ADDRESS CmdDescPhyAddr
;
1938 VOID
*CmdDescMapping
;
1942 // Initial h/w and s/w context for future operations.
1945 CmdDescMapping
= NULL
;
1948 Status
= UfsMmioRead32 (Private
, UFS_HC_CAP_OFFSET
, &Data
);
1949 if (EFI_ERROR (Status
)) {
1953 Private
->Capabilities
= Data
;
1956 // Allocate and initialize UTP Task Management Request List.
1958 Nutmrs
= (UINT8
) (RShiftU64 ((Private
->Capabilities
& UFS_HC_CAP_NUTMRS
), 16) + 1);
1959 Status
= UfsAllocateAlignCommonBuffer (Private
, Nutmrs
* sizeof (UTP_TMRD
), &CmdDescHost
, &CmdDescPhyAddr
, &CmdDescMapping
);
1960 if (EFI_ERROR (Status
)) {
1965 // Program the UTP Task Management Request List Base Address and UTP Task Management
1966 // Request List Base Address with a 64-bit address allocated at step 6.
1968 Status
= UfsMmioWrite32 (Private
, UFS_HC_UTMRLBA_OFFSET
, (UINT32
)(UINTN
)CmdDescPhyAddr
);
1969 if (EFI_ERROR (Status
)) {
1973 Status
= UfsMmioWrite32 (Private
, UFS_HC_UTMRLBAU_OFFSET
, (UINT32
)RShiftU64 ((UINT64
)CmdDescPhyAddr
, 32));
1974 if (EFI_ERROR (Status
)) {
1977 Private
->UtpTmrlBase
= CmdDescHost
;
1978 Private
->Nutmrs
= Nutmrs
;
1979 Private
->TmrlMapping
= CmdDescMapping
;
1982 // Enable the UTP Task Management Request List by setting the UTP Task Management
1983 // Request List RunStop Register (UTMRLRSR) to '1'.
1985 Status
= UfsMmioWrite32 (Private
, UFS_HC_UTMRLRSR_OFFSET
, UFS_HC_UTMRLRSR
);
1986 if (EFI_ERROR (Status
)) {
1994 Initialize UFS transfer request list related h/w context.
1996 @param[in] Private The pointer to the UFS_PASS_THRU_PRIVATE_DATA data structure.
1998 @retval EFI_SUCCESS The UFS transfer list was initialzed successfully.
1999 @retval EFI_DEVICE_ERROR The initialization fails.
2003 UfsInitTransferRequestList (
2004 IN UFS_PASS_THRU_PRIVATE_DATA
*Private
2010 EFI_PHYSICAL_ADDRESS CmdDescPhyAddr
;
2011 VOID
*CmdDescMapping
;
2015 // Initial h/w and s/w context for future operations.
2018 CmdDescMapping
= NULL
;
2021 Status
= UfsMmioRead32 (Private
, UFS_HC_CAP_OFFSET
, &Data
);
2022 if (EFI_ERROR (Status
)) {
2026 Private
->Capabilities
= Data
;
2029 // Allocate and initialize UTP Transfer Request List.
2031 Nutrs
= (UINT8
)((Private
->Capabilities
& UFS_HC_CAP_NUTRS
) + 1);
2032 Status
= UfsAllocateAlignCommonBuffer (Private
, Nutrs
* sizeof (UTP_TRD
), &CmdDescHost
, &CmdDescPhyAddr
, &CmdDescMapping
);
2033 if (EFI_ERROR (Status
)) {
2038 // Program the UTP Transfer Request List Base Address and UTP Transfer Request List
2039 // Base Address with a 64-bit address allocated at step 8.
2041 Status
= UfsMmioWrite32 (Private
, UFS_HC_UTRLBA_OFFSET
, (UINT32
)(UINTN
)CmdDescPhyAddr
);
2042 if (EFI_ERROR (Status
)) {
2046 Status
= UfsMmioWrite32 (Private
, UFS_HC_UTRLBAU_OFFSET
, (UINT32
)RShiftU64 ((UINT64
)CmdDescPhyAddr
, 32));
2047 if (EFI_ERROR (Status
)) {
2051 Private
->UtpTrlBase
= CmdDescHost
;
2052 Private
->Nutrs
= Nutrs
;
2053 Private
->TrlMapping
= CmdDescMapping
;
2056 // Enable the UTP Transfer Request List by setting the UTP Transfer Request List
2057 // RunStop Register (UTRLRSR) to '1'.
2059 Status
= UfsMmioWrite32 (Private
, UFS_HC_UTRLRSR_OFFSET
, UFS_HC_UTRLRSR
);
2060 if (EFI_ERROR (Status
)) {
2068 Initialize the UFS host controller.
2070 @param[in] Private The pointer to the UFS_PASS_THRU_PRIVATE_DATA data structure.
2072 @retval EFI_SUCCESS The Ufs Host Controller is initialized successfully.
2073 @retval Others A device error occurred while initializing the controller.
2078 IN UFS_PASS_THRU_PRIVATE_DATA
*Private
2083 Status
= UfsEnableHostController (Private
);
2084 if (EFI_ERROR (Status
)) {
2085 DEBUG ((EFI_D_ERROR
, "UfsControllerInit: Enable Host Controller Fails, Status = %r\n", Status
));
2089 Status
= UfsDeviceDetection (Private
);
2090 if (EFI_ERROR (Status
)) {
2091 DEBUG ((EFI_D_ERROR
, "UfsControllerInit: Device Detection Fails, Status = %r\n", Status
));
2095 Status
= UfsInitTaskManagementRequestList (Private
);
2096 if (EFI_ERROR (Status
)) {
2097 DEBUG ((EFI_D_ERROR
, "UfsControllerInit: Task management list initialization Fails, Status = %r\n", Status
));
2101 Status
= UfsInitTransferRequestList (Private
);
2102 if (EFI_ERROR (Status
)) {
2103 DEBUG ((EFI_D_ERROR
, "UfsControllerInit: Transfer list initialization Fails, Status = %r\n", Status
));
2107 DEBUG ((EFI_D_INFO
, "UfsControllerInit Finished\n"));
2112 Stop the UFS host controller.
2114 @param[in] Private The pointer to the UFS_PASS_THRU_PRIVATE_DATA data structure.
2116 @retval EFI_SUCCESS The Ufs Host Controller is stopped successfully.
2117 @retval Others A device error occurred while stopping the controller.
2122 IN UFS_PASS_THRU_PRIVATE_DATA
*Private
2129 // Enable the UTP Task Management Request List by setting the UTP Task Management
2130 // Request List RunStop Register (UTMRLRSR) to '1'.
2132 Status
= UfsMmioWrite32 (Private
, UFS_HC_UTMRLRSR_OFFSET
, 0);
2133 if (EFI_ERROR (Status
)) {
2138 // Enable the UTP Transfer Request List by setting the UTP Transfer Request List
2139 // RunStop Register (UTRLRSR) to '1'.
2141 Status
= UfsMmioWrite32 (Private
, UFS_HC_UTRLRSR_OFFSET
, 0);
2142 if (EFI_ERROR (Status
)) {
2147 // Write a 0 to the HCE register in order to disable the host controller.
2149 Status
= UfsMmioRead32 (Private
, UFS_HC_ENABLE_OFFSET
, &Data
);
2150 if (EFI_ERROR (Status
)) {
2153 ASSERT ((Data
& UFS_HC_HCE_EN
) == UFS_HC_HCE_EN
);
2155 Status
= UfsMmioWrite32 (Private
, UFS_HC_ENABLE_OFFSET
, 0);
2156 if (EFI_ERROR (Status
)) {
2161 // Wait until HCE is read as '0' before continuing.
2163 Status
= UfsWaitMemSet (Private
, UFS_HC_ENABLE_OFFSET
, UFS_HC_HCE_EN
, 0, UFS_TIMEOUT
);
2164 if (EFI_ERROR (Status
)) {
2165 return EFI_DEVICE_ERROR
;
2168 DEBUG ((EFI_D_INFO
, "UfsController is stopped\n"));
2175 Internal helper function which will signal the caller event and clean up
2178 @param[in] Private The pointer to the UFS_PASS_THRU_PRIVATE_DATA data
2180 @param[in] TransReq The pointer to the UFS_PASS_THRU_TRANS_REQ data
2187 IN UFS_PASS_THRU_PRIVATE_DATA
*Private
,
2188 IN UFS_PASS_THRU_TRANS_REQ
*TransReq
2191 EDKII_UFS_HOST_CONTROLLER_PROTOCOL
*UfsHc
;
2192 EFI_EVENT CallerEvent
;
2194 ASSERT ((Private
!= NULL
) && (TransReq
!= NULL
));
2196 UfsHc
= Private
->UfsHostController
;
2197 CallerEvent
= TransReq
->CallerEvent
;
2199 RemoveEntryList (&TransReq
->TransferList
);
2201 UfsHc
->Flush (UfsHc
);
2203 UfsStopExecCmd (Private
, TransReq
->Slot
);
2205 if (TransReq
->DataBufMapping
!= NULL
) {
2206 UfsHc
->Unmap (UfsHc
, TransReq
->DataBufMapping
);
2209 if (TransReq
->CmdDescMapping
!= NULL
) {
2210 UfsHc
->Unmap (UfsHc
, TransReq
->CmdDescMapping
);
2212 if (TransReq
->CmdDescHost
!= NULL
) {
2215 EFI_SIZE_TO_PAGES (TransReq
->CmdDescSize
),
2216 TransReq
->CmdDescHost
2220 FreePool (TransReq
);
2222 gBS
->SignalEvent (CallerEvent
);
2227 Call back function when the timer event is signaled.
2229 @param[in] Event The Event this notify function registered to.
2230 @param[in] Context Pointer to the context data registered to the Event.
2235 ProcessAsyncTaskList (
2240 UFS_PASS_THRU_PRIVATE_DATA
*Private
;
2242 LIST_ENTRY
*NextEntry
;
2243 UFS_PASS_THRU_TRANS_REQ
*TransReq
;
2244 EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
;
2245 UTP_RESPONSE_UPIU
*Response
;
2246 UINT16 SenseDataLen
;
2247 UINT32 ResTranCount
;
2252 Private
= (UFS_PASS_THRU_PRIVATE_DATA
*) Context
;
2256 // Check the entries in the async I/O queue are done or not.
2258 if (!IsListEmpty(&Private
->Queue
)) {
2259 EFI_LIST_FOR_EACH_SAFE (Entry
, NextEntry
, &Private
->Queue
) {
2260 TransReq
= UFS_PASS_THRU_TRANS_REQ_FROM_THIS (Entry
);
2261 Packet
= TransReq
->Packet
;
2263 if ((SlotsMap
& (BIT0
<< TransReq
->Slot
)) != 0) {
2266 SlotsMap
|= BIT0
<< TransReq
->Slot
;
2268 Status
= UfsMmioRead32 (Private
, UFS_HC_UTRLDBR_OFFSET
, &Value
);
2269 if (EFI_ERROR (Status
)) {
2271 // TODO: Should find/add a proper host adapter return status for this
2274 Packet
->HostAdapterStatus
= EFI_EXT_SCSI_STATUS_HOST_ADAPTER_PHASE_ERROR
;
2275 DEBUG ((EFI_D_VERBOSE
, "ProcessAsyncTaskList(): Signal Event %p UfsMmioRead32() Error.\n", TransReq
->CallerEvent
));
2276 SignalCallerEvent (Private
, TransReq
);
2280 if ((Value
& (BIT0
<< TransReq
->Slot
)) != 0) {
2282 // Scsi cmd not finished yet.
2284 if (TransReq
->TimeoutRemain
> UFS_HC_ASYNC_TIMER
) {
2285 TransReq
->TimeoutRemain
-= UFS_HC_ASYNC_TIMER
;
2291 Packet
->HostAdapterStatus
= EFI_EXT_SCSI_STATUS_HOST_ADAPTER_TIMEOUT_COMMAND
;
2292 DEBUG ((EFI_D_VERBOSE
, "ProcessAsyncTaskList(): Signal Event %p EFI_TIMEOUT.\n", TransReq
->CallerEvent
));
2293 SignalCallerEvent (Private
, TransReq
);
2298 // Scsi cmd finished.
2300 // Get sense data if exists
2302 Response
= (UTP_RESPONSE_UPIU
*)((UINT8
*)TransReq
->CmdDescHost
+ TransReq
->Trd
->RuO
* sizeof (UINT32
));
2303 ASSERT (Response
!= NULL
);
2304 SenseDataLen
= Response
->SenseDataLen
;
2305 SwapLittleEndianToBigEndian ((UINT8
*)&SenseDataLen
, sizeof (UINT16
));
2307 if ((Packet
->SenseDataLength
!= 0) && (Packet
->SenseData
!= NULL
)) {
2308 CopyMem (Packet
->SenseData
, Response
->SenseData
, SenseDataLen
);
2309 Packet
->SenseDataLength
= (UINT8
)SenseDataLen
;
2313 // Check the transfer request result.
2315 Packet
->TargetStatus
= Response
->Status
;
2316 if (Response
->Response
!= 0) {
2317 DEBUG ((EFI_D_VERBOSE
, "ProcessAsyncTaskList(): Signal Event %p Target Failure.\n", TransReq
->CallerEvent
));
2318 SignalCallerEvent (Private
, TransReq
);
2322 if (TransReq
->Trd
->Ocs
== 0) {
2323 if (Packet
->DataDirection
== EFI_EXT_SCSI_DATA_DIRECTION_READ
) {
2324 if ((Response
->Flags
& BIT5
) == BIT5
) {
2325 ResTranCount
= Response
->ResTranCount
;
2326 SwapLittleEndianToBigEndian ((UINT8
*)&ResTranCount
, sizeof (UINT32
));
2327 Packet
->InTransferLength
-= ResTranCount
;
2330 if ((Response
->Flags
& BIT5
) == BIT5
) {
2331 ResTranCount
= Response
->ResTranCount
;
2332 SwapLittleEndianToBigEndian ((UINT8
*)&ResTranCount
, sizeof (UINT32
));
2333 Packet
->OutTransferLength
-= ResTranCount
;
2337 DEBUG ((EFI_D_VERBOSE
, "ProcessAsyncTaskList(): Signal Event %p Target Device Error.\n", TransReq
->CallerEvent
));
2338 SignalCallerEvent (Private
, TransReq
);
2342 DEBUG ((EFI_D_VERBOSE
, "ProcessAsyncTaskList(): Signal Event %p Success.\n", TransReq
->CallerEvent
));
2343 SignalCallerEvent (Private
, TransReq
);