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 - 2018, Intel Corporation. All rights reserved.<BR>
6 SPDX-License-Identifier: BSD-2-Clause-Patent
10 #ifndef _UFS_PASS_THRU_HCI_H_
11 #define _UFS_PASS_THRU_HCI_H_
14 // Host Capabilities Register Offsets
16 #define UFS_HC_CAP_OFFSET 0x0000 // Controller Capabilities
17 #define UFS_HC_VER_OFFSET 0x0008 // Version
18 #define UFS_HC_DDID_OFFSET 0x0010 // Device ID and Device Class
19 #define UFS_HC_PMID_OFFSET 0x0014 // Product ID and Manufacturer ID
20 #define UFS_HC_AHIT_OFFSET 0x0018 // Auto-Hibernate Idle Timer
22 // Operation and Runtime Register Offsets
24 #define UFS_HC_IS_OFFSET 0x0020 // Interrupt Status
25 #define UFS_HC_IE_OFFSET 0x0024 // Interrupt Enable
26 #define UFS_HC_STATUS_OFFSET 0x0030 // Host Controller Status
27 #define UFS_HC_ENABLE_OFFSET 0x0034 // Host Controller Enable
28 #define UFS_HC_UECPA_OFFSET 0x0038 // Host UIC Error Code PHY Adapter Layer
29 #define UFS_HC_UECDL_OFFSET 0x003c // Host UIC Error Code Data Link Layer
30 #define UFS_HC_UECN_OFFSET 0x0040 // Host UIC Error Code Network Layer
31 #define UFS_HC_UECT_OFFSET 0x0044 // Host UIC Error Code Transport Layer
32 #define UFS_HC_UECDME_OFFSET 0x0048 // Host UIC Error Code DME
33 #define UFS_HC_UTRIACR_OFFSET 0x004c // UTP Transfer Request Interrupt Aggregation Control Register
35 // UTP Transfer Register Offsets
37 #define UFS_HC_UTRLBA_OFFSET 0x0050 // UTP Transfer Request List Base Address
38 #define UFS_HC_UTRLBAU_OFFSET 0x0054 // UTP Transfer Request List Base Address Upper 32-Bits
39 #define UFS_HC_UTRLDBR_OFFSET 0x0058 // UTP Transfer Request List Door Bell Register
40 #define UFS_HC_UTRLCLR_OFFSET 0x005c // UTP Transfer Request List CLear Register
41 #define UFS_HC_UTRLRSR_OFFSET 0x0060 // UTP Transfer Request Run-Stop Register
43 // UTP Task Management Register Offsets
45 #define UFS_HC_UTMRLBA_OFFSET 0x0070 // UTP Task Management Request List Base Address
46 #define UFS_HC_UTMRLBAU_OFFSET 0x0074 // UTP Task Management Request List Base Address Upper 32-Bits
47 #define UFS_HC_UTMRLDBR_OFFSET 0x0078 // UTP Task Management Request List Door Bell Register
48 #define UFS_HC_UTMRLCLR_OFFSET 0x007c // UTP Task Management Request List CLear Register
49 #define UFS_HC_UTMRLRSR_OFFSET 0x0080 // UTP Task Management Run-Stop Register
51 // UIC Command Register Offsets
53 #define UFS_HC_UIC_CMD_OFFSET 0x0090 // UIC Command Register
54 #define UFS_HC_UCMD_ARG1_OFFSET 0x0094 // UIC Command Argument 1
55 #define UFS_HC_UCMD_ARG2_OFFSET 0x0098 // UIC Command Argument 2
56 #define UFS_HC_UCMD_ARG3_OFFSET 0x009c // UIC Command Argument 3
58 // UMA Register Offsets
60 #define UFS_HC_UMA_OFFSET 0x00b0 // Reserved for Unified Memory Extension
62 #define UFS_HC_HCE_EN BIT0
63 #define UFS_HC_HCS_DP BIT0
64 #define UFS_HC_HCS_UCRDY BIT3
65 #define UFS_HC_IS_ULSS BIT8
66 #define UFS_HC_IS_UCCS BIT10
67 #define UFS_HC_CAP_64ADDR BIT24
68 #define UFS_HC_CAP_NUTMRS (BIT16 | BIT17 | BIT18)
69 #define UFS_HC_CAP_NUTRS (BIT0 | BIT1 | BIT2 | BIT3 | BIT4)
70 #define UFS_HC_UTMRLRSR BIT0
71 #define UFS_HC_UTRLRSR BIT0
74 // The initial value of the OCS field of UTP TRD or TMRD descriptor
75 // defined in JEDEC JESD223 specification
77 #define UFS_HC_TRD_OCS_INIT_VALUE 0x0F
80 // A maximum of length of 256KB is supported by PRDT entry
82 #define UFS_MAX_DATA_LEN_PER_PRD 0x40000
84 #define UFS_STORAGE_COMMAND_TYPE 0x01
86 #define UFS_REGULAR_COMMAND 0x00
87 #define UFS_INTERRUPT_COMMAND 0x01
89 #define UFS_LUN_0 0x00
90 #define UFS_LUN_1 0x01
91 #define UFS_LUN_2 0x02
92 #define UFS_LUN_3 0x03
93 #define UFS_LUN_4 0x04
94 #define UFS_LUN_5 0x05
95 #define UFS_LUN_6 0x06
96 #define UFS_LUN_7 0x07
97 #define UFS_WLUN_REPORT_LUNS 0x81
98 #define UFS_WLUN_UFS_DEV 0xD0
99 #define UFS_WLUN_BOOT 0xB0
100 #define UFS_WLUN_RPMB 0xC4
105 // UFSHCI 2.0 Spec Section 5.2.1 Offset 00h: CAP - Controller Capabilities
108 UINT8 Nutrs
:4; // Number of UTP Transfer Request Slots
111 UINT8 NoRtt
; // Number of outstanding READY TO TRANSFER (RTT) requests supported
113 UINT8 Nutmrs
:3; // Number of UTP Task Management Request Slots
115 UINT8 AutoHs
:1; // Auto-Hibernation Support
117 UINT8 As64
:1; // 64-bit addressing supported
118 UINT8 Oodds
:1; // Out of order data delivery supported
119 UINT8 UicDmetms
:1; // UIC DME_TEST_MODE command supported
120 UINT8 Ume
:1; // Reserved for Unified Memory Extension
125 // UFSHCI 2.0 Spec Section 5.2.2 Offset 08h: VER - UFS Version
128 UINT8 Vs
:4; // Version Suffix
129 UINT8 Mnr
:4; // Minor version number
131 UINT8 Mjr
; // Major version number
137 // UFSHCI 2.0 Spec Section 5.2.3 Offset 10h: HCPID - Host Controller Product ID
139 #define UFS_HC_PID UINT32
142 // UFSHCI 2.0 Spec Section 5.2.4 Offset 14h: HCMID - Host Controller Manufacturer ID
144 #define UFS_HC_MID UINT32
147 // UFSHCI 2.0 Spec Section 5.2.5 Offset 18h: AHIT - Auto-Hibernate Idle Timer
150 UINT32 Ahitv
:10; // Auto-Hibernate Idle Timer Value
151 UINT32 Ts
:3; // Timer scale
156 // UFSHCI 2.0 Spec Section 5.3.1 Offset 20h: IS - Interrupt Status
159 UINT16 Utrcs
:1; // UTP Transfer Request Completion Status
160 UINT16 Udepri
:1; // UIC DME_ENDPOINT_RESET Indication
161 UINT16 Ue
:1; // UIC Error
162 UINT16 Utms
:1; // UIC Test Mode Status
164 UINT16 Upms
:1; // UIC Power Mode Status
165 UINT16 Uhxs
:1; // UIC Hibernate Exit Status
166 UINT16 Uhes
:1; // UIC Hibernate Enter Status
167 UINT16 Ulls
:1; // UIC Link Lost Status
169 UINT16 Ulss
:1; // UIC Link Startup Status
170 UINT16 Utmrcs
:1; // UTP Task Management Request Completion Status
171 UINT16 Uccs
:1; // UIC Command Completion Status
172 UINT16 Dfes
:1; // Device Fatal Error Status
174 UINT16 Utpes
:1; // UTP Error Status
177 UINT16 Hcfes
:1; // Host Controller Fatal Error Status
178 UINT16 Sbfes
:1; // System Bus Fatal Error Status
183 // UFSHCI 2.0 Spec Section 5.3.2 Offset 24h: IE - Interrupt Enable
186 UINT16 Utrce
:1; // UTP Transfer Request Completion Enable
187 UINT16 Udeprie
:1; // UIC DME_ENDPOINT_RESET Enable
188 UINT16 Uee
:1; // UIC Error Enable
189 UINT16 Utmse
:1; // UIC Test Mode Status Enable
191 UINT16 Upmse
:1; // UIC Power Mode Status Enable
192 UINT16 Uhxse
:1; // UIC Hibernate Exit Status Enable
193 UINT16 Uhese
:1; // UIC Hibernate Enter Status Enable
194 UINT16 Ullse
:1; // UIC Link Lost Status Enable
196 UINT16 Ulsse
:1; // UIC Link Startup Status Enable
197 UINT16 Utmrce
:1; // UTP Task Management Request Completion Enable
198 UINT16 Ucce
:1; // UIC Command Completion Enable
199 UINT16 Dfee
:1; // Device Fatal Error Enable
201 UINT16 Utpee
:1; // UTP Error Enable
204 UINT16 Hcfee
:1; // Host Controller Fatal Error Enable
205 UINT16 Sbfee
:1; // System Bus Fatal Error Enable
210 // UFSHCI 2.0 Spec Section 5.3.3 Offset 30h: HCS - Host Controller Status
213 UINT8 Dp
:1; // Device Present
214 UINT8 UtrlRdy
:1; // UTP Transfer Request List Ready
215 UINT8 UtmrlRdy
:1; // UTP Task Management Request List Ready
216 UINT8 UcRdy
:1; // UIC COMMAND Ready
219 UINT8 Upmcrs
:3; // UIC Power Mode Change Request Status
220 UINT8 Rsvd2
:1; // UIC Hibernate Exit Status Enable
221 UINT8 Utpec
:4; // UTP Error Code
223 UINT8 TtagUtpE
; // Task Tag of UTP error
224 UINT8 TlunUtpE
; // Target LUN of UTP error
228 // UFSHCI 2.0 Spec Section 5.3.4 Offset 34h: HCE - Host Controller Enable
231 UINT32 Hce
:1; // Host Controller Enable
236 // UFSHCI 2.0 Spec Section 5.3.5 Offset 38h: UECPA - Host UIC Error Code PHY Adapter Layer
239 UINT32 Ec
:5; // UIC PHY Adapter Layer Error Code
241 UINT32 Err
:1; // UIC PHY Adapter Layer Error
245 // UFSHCI 2.0 Spec Section 5.3.6 Offset 3ch: UECDL - Host UIC Error Code Data Link Layer
248 UINT32 Ec
:15; // UIC Data Link Layer Error Code
250 UINT32 Err
:1; // UIC Data Link Layer Error
254 // UFSHCI 2.0 Spec Section 5.3.7 Offset 40h: UECN - Host UIC Error Code Network Layer
257 UINT32 Ec
:3; // UIC Network Layer Error Code
259 UINT32 Err
:1; // UIC Network Layer Error
263 // UFSHCI 2.0 Spec Section 5.3.8 Offset 44h: UECT - Host UIC Error Code Transport Layer
266 UINT32 Ec
:7; // UIC Transport Layer Error Code
268 UINT32 Err
:1; // UIC Transport Layer Error
272 // UFSHCI 2.0 Spec Section 5.3.9 Offset 48h: UECDME - Host UIC Error Code
275 UINT32 Ec
:1; // UIC DME Error Code
277 UINT32 Err
:1; // UIC DME Error
281 // UFSHCI 2.0 Spec Section 5.3.10 Offset 4Ch: UTRIACR - UTP Transfer Request Interrupt Aggregation Control Register
284 UINT8 IaToVal
; // Interrupt aggregation timeout value
286 UINT8 IacTh
:5; // Interrupt aggregation counter threshold
289 UINT8 Ctr
:1; // Counter and Timer Reset
291 UINT8 Iasb
:1; // Interrupt aggregation status bit
294 UINT8 IapwEn
:1; // Interrupt aggregation parameter write enable
296 UINT8 IaEn
:1; // Interrupt Aggregation Enable/Disable
300 // UFSHCI 2.0 Spec Section 5.4.1 Offset 50h: UTRLBA - UTP Transfer Request List Base Address
304 UINT32 UtrlBa
:22; // UTP Transfer Request List Base Address
308 // UFSHCI 2.0 Spec Section 5.4.2 Offset 54h: UTRLBAU - UTP Transfer Request List Base Address Upper 32-bits
310 #define UFS_HC_UTRLBAU UINT32
313 // UFSHCI 2.0 Spec Section 5.4.3 Offset 58h: UTRLDBR - UTP Transfer Request List Door Bell Register
315 #define UFS_HC_UTRLDBR UINT32
318 // UFSHCI 2.0 Spec Section 5.4.4 Offset 5Ch: UTRLCLR - UTP Transfer Request List CLear Register
320 #define UFS_HC_UTRLCLR UINT32
324 // UFSHCI 2.0 Spec Section 5.4.5 Offset 60h: UTRLRSR - UTP Transfer Request List Run Stop Register
327 UINT32 UtrlRsr
:1; // UTP Transfer Request List Run-Stop Register
333 // UFSHCI 2.0 Spec Section 5.5.1 Offset 70h: UTMRLBA - UTP Task Management Request List Base Address
337 UINT32 UtmrlBa
:22; // UTP Task Management Request List Base Address
341 // UFSHCI 2.0 Spec Section 5.5.2 Offset 74h: UTMRLBAU - UTP Task Management Request List Base Address Upper 32-bits
343 #define UFS_HC_UTMRLBAU UINT32
346 // UFSHCI 2.0 Spec Section 5.5.3 Offset 78h: UTMRLDBR - UTP Task Management Request List Door Bell Register
349 UINT32 UtmrlDbr
:8; // UTP Task Management Request List Door bell Register
354 // UFSHCI 2.0 Spec Section 5.5.4 Offset 7Ch: UTMRLCLR - UTP Task Management Request List CLear Register
357 UINT32 UtmrlClr
:8; // UTP Task Management List Clear Register
363 // UFSHCI 2.0 Spec Section 5.5.5 Offset 80h: UTMRLRSR - UTP Task Management Request List Run Stop Register
366 UINT32 UtmrlRsr
:1; // UTP Task Management Request List Run-Stop Register
372 // UFSHCI 2.0 Spec Section 5.6.1 Offset 90h: UICCMD - UIC Command
375 UINT32 CmdOp
:8; // Command Opcode
380 // UFSHCI 2.0 Spec Section 5.6.2 Offset 94h: UICCMDARG1 - UIC Command Argument 1
382 #define UFS_HC_UICCMD_ARG1 UINT32
385 // UFSHCI 2.0 Spec Section 5.6.2 Offset 98h: UICCMDARG2 - UIC Command Argument 2
387 #define UFS_HC_UICCMD_ARG2 UINT32
390 // UFSHCI 2.0 Spec Section 5.6.2 Offset 9ch: UICCMDARG3 - UIC Command Argument 3
392 #define UFS_HC_UICCMD_ARG3 UINT32
395 // UIC command opcodes
400 UfsUicDmePeerGet
= 0x03,
401 UfsUicDmePeerSet
= 0x04,
402 UfsUicDmePwrOn
= 0x10,
403 UfsUicDmePwrOff
= 0x11,
404 UfsUicDmeEnable
= 0x12,
405 UfsUicDmeReset
= 0x14,
406 UfsUicDmeEndpointReset
= 0x15,
407 UfsUicDmeLinkStartup
= 0x16,
408 UfsUicDmeHibernateEnter
= 0x17,
409 UfsUicDmeHibernateExit
= 0x18,
410 UfsUicDmeTestMode
= 0x1A
414 // UTP Transfer Request Descriptor
421 UINT32 Int
:1; /* Interrupt */
422 UINT32 Dd
:2; /* Data Direction */
424 UINT32 Ct
:4; /* Command Type */
434 UINT32 Ocs
:8; /* Overall Command Status */
446 UINT32 UcdBa
:25; /* UTP Command Descriptor Base Address */
451 UINT32 UcdBaU
; /* UTP Command Descriptor Base Address Upper 32-bits */
456 UINT16 RuL
; /* Response UPIU Length */
457 UINT16 RuO
; /* Response UPIU Offset */
462 UINT16 PrdtL
; /* PRDT Length */
463 UINT16 PrdtO
; /* PRDT Offset */
471 UINT32 DbAddr
:30; /* Data Base Address */
476 UINT32 DbAddrU
; /* Data Base Address Upper 32-bits */
486 UINT32 DbCount
:18; /* Data Byte Count */
491 // UFS 2.0 Spec Section 10.5.3 - UTP Command UPIU
497 UINT8 TransCode
:6; /* Transaction Type - 0x01*/
502 UINT8 TaskTag
; /* Task Tag */
507 UINT8 CmdSet
:4; /* Command Set Type */
516 UINT8 EhsLen
; /* Total EHS Length - 0x00 */
518 UINT16 DataSegLen
; /* Data Segment Length - Big Endian - 0x0000 */
523 UINT32 ExpDataTranLen
; /* Expected Data Transfer Length - Big Endian */
532 // UFS 2.0 Spec Section 10.5.4 - UTP Response UPIU
538 UINT8 TransCode
:6; /* Transaction Type - 0x21*/
543 UINT8 TaskTag
; /* Task Tag */
548 UINT8 CmdSet
:4; /* Command Set Type */
551 UINT8 Response
; /* Response */
552 UINT8 Status
; /* Status */
557 UINT8 EhsLen
; /* Total EHS Length - 0x00 */
558 UINT8 DevInfo
; /* Device Information */
559 UINT16 DataSegLen
; /* Data Segment Length - Big Endian */
564 UINT32 ResTranCount
; /* Residual Transfer Count - Big Endian */
572 // Data Segment - Sense Data
574 UINT16 SenseDataLen
; /* Sense Data Length - Big Endian */
575 UINT8 SenseData
[18]; /* Sense Data */
579 // UFS 2.0 Spec Section 10.5.5 - UTP Data-Out UPIU
585 UINT8 TransCode
:6; /* Transaction Type - 0x02*/
590 UINT8 TaskTag
; /* Task Tag */
600 UINT8 EhsLen
; /* Total EHS Length - 0x00 */
602 UINT16 DataSegLen
; /* Data Segment Length - Big Endian */
607 UINT32 DataBufOffset
; /* Data Buffer Offset - Big Endian */
612 UINT32 DataTranCount
; /* Data Transfer Count - Big Endian */
620 // Data Segment - Data to be sent out
622 //UINT8 Data[]; /* Data to be sent out, maximum is 65535 bytes */
626 // UFS 2.0 Spec Section 10.5.6 - UTP Data-In UPIU
632 UINT8 TransCode
:6; /* Transaction Type - 0x22*/
637 UINT8 TaskTag
; /* Task Tag */
647 UINT8 EhsLen
; /* Total EHS Length - 0x00 */
649 UINT16 DataSegLen
; /* Data Segment Length - Big Endian */
654 UINT32 DataBufOffset
; /* Data Buffer Offset - Big Endian */
659 UINT32 DataTranCount
; /* Data Transfer Count - Big Endian */
667 // Data Segment - Data to be read
669 //UINT8 Data[]; /* Data to be read, maximum is 65535 bytes */
673 // UFS 2.0 Spec Section 10.5.7 - UTP Ready-To-Transfer UPIU
679 UINT8 TransCode
:6; /* Transaction Type - 0x31*/
684 UINT8 TaskTag
; /* Task Tag */
694 UINT8 EhsLen
; /* Total EHS Length - 0x00 */
696 UINT16 DataSegLen
; /* Data Segment Length - Big Endian - 0x0000 */
701 UINT32 DataBufOffset
; /* Data Buffer Offset - Big Endian */
706 UINT32 DataTranCount
; /* Data Transfer Count - Big Endian */
714 // Data Segment - Data to be read
716 //UINT8 Data[]; /* Data to be read, maximum is 65535 bytes */
717 } UTP_RDY_TO_TRAN_UPIU
;
720 // UFS 2.0 Spec Section 10.5.8 - UTP Task Management Request UPIU
726 UINT8 TransCode
:6; /* Transaction Type - 0x04*/
731 UINT8 TaskTag
; /* Task Tag */
737 UINT8 TskManFunc
; /* Task Management Function */
743 UINT8 EhsLen
; /* Total EHS Length - 0x00 */
745 UINT16 DataSegLen
; /* Data Segment Length - Big Endian - 0x0000 */
750 UINT32 InputParam1
; /* Input Parameter 1 - Big Endian */
755 UINT32 InputParam2
; /* Input Parameter 2 - Big Endian */
760 UINT32 InputParam3
; /* Input Parameter 3 - Big Endian */
769 // UFS 2.0 Spec Section 10.5.9 - UTP Task Management Response UPIU
775 UINT8 TransCode
:6; /* Transaction Type - 0x24*/
780 UINT8 TaskTag
; /* Task Tag */
786 UINT8 Resp
; /* Response */
792 UINT8 EhsLen
; /* Total EHS Length - 0x00 */
794 UINT16 DataSegLen
; /* Data Segment Length - Big Endian - 0x0000 */
799 UINT32 OutputParam1
; /* Output Parameter 1 - Big Endian */
804 UINT32 OutputParam2
; /* Output Parameter 2 - Big Endian */
813 // UTP Task Management Request Descriptor
820 UINT32 Int
:1; /* Interrupt */
831 UINT32 Ocs
:8; /* Overall Command Status */
842 UTP_TM_REQ_UPIU TmReq
; /* Task Management Request UPIU */
847 UTP_TM_RESP_UPIU TmResp
; /* Task Management Response UPIU */
863 // UFS 2.0 Spec Section 10.5.10 - UTP Query Request UPIU
869 UINT8 TransCode
:6; /* Transaction Type - 0x16*/
874 UINT8 TaskTag
; /* Task Tag */
880 UINT8 QueryFunc
; /* Query Function */
886 UINT8 EhsLen
; /* Total EHS Length - 0x00 */
888 UINT16 DataSegLen
; /* Data Segment Length - Big Endian */
893 UTP_UPIU_TSF Tsf
; /* Transaction Specific Fields */
901 // Data Segment - Data to be transferred
903 //UINT8 Data[]; /* Data to be transferred, maximum is 65535 bytes */
904 } UTP_QUERY_REQ_UPIU
;
906 #define QUERY_FUNC_STD_READ_REQ 0x01
907 #define QUERY_FUNC_STD_WRITE_REQ 0x81
910 UtpQueryFuncOpcodeNop
= 0x00,
911 UtpQueryFuncOpcodeRdDesc
= 0x01,
912 UtpQueryFuncOpcodeWrDesc
= 0x02,
913 UtpQueryFuncOpcodeRdAttr
= 0x03,
914 UtpQueryFuncOpcodeWrAttr
= 0x04,
915 UtpQueryFuncOpcodeRdFlag
= 0x05,
916 UtpQueryFuncOpcodeSetFlag
= 0x06,
917 UtpQueryFuncOpcodeClrFlag
= 0x07,
918 UtpQueryFuncOpcodeTogFlag
= 0x08
919 } UTP_QUERY_FUNC_OPCODE
;
922 // UFS 2.0 Spec Section 10.5.11 - UTP Query Response UPIU
928 UINT8 TransCode
:6; /* Transaction Type - 0x36*/
933 UINT8 TaskTag
; /* Task Tag */
939 UINT8 QueryFunc
; /* Query Function */
940 UINT8 QueryResp
; /* Query Response */
946 UINT8 EhsLen
; /* Total EHS Length - 0x00 */
947 UINT8 DevInfo
; /* Device Information */
948 UINT16 DataSegLen
; /* Data Segment Length - Big Endian */
953 UTP_UPIU_TSF Tsf
; /* Transaction Specific Fields */
961 // Data Segment - Data to be transferred
963 //UINT8 Data[]; /* Data to be transferred, maximum is 65535 bytes */
964 } UTP_QUERY_RESP_UPIU
;
967 UfsUtpQueryResponseSuccess
= 0x00,
968 UfsUtpQueryResponseParamNotReadable
= 0xF6,
969 UfsUtpQueryResponseParamNotWriteable
= 0xF7,
970 UfsUtpQueryResponseParamAlreadyWritten
= 0xF8,
971 UfsUtpQueryResponseInvalidLen
= 0xF9,
972 UfsUtpQueryResponseInvalidVal
= 0xFA,
973 UfsUtpQueryResponseInvalidSelector
= 0xFB,
974 UfsUtpQueryResponseInvalidIndex
= 0xFC,
975 UfsUtpQueryResponseInvalidIdn
= 0xFD,
976 UfsUtpQueryResponseInvalidOpc
= 0xFE,
977 UfsUtpQueryResponseGeneralFailure
= 0xFF
978 } UTP_QUERY_RESP_CODE
;
981 // UFS 2.0 Spec Section 10.5.12 - UTP Reject UPIU
987 UINT8 TransCode
:6; /* Transaction Type - 0x3F*/
992 UINT8 TaskTag
; /* Task Tag */
998 UINT8 Response
; /* Response - 0x01 */
1004 UINT8 EhsLen
; /* Total EHS Length - 0x00 */
1005 UINT8 DevInfo
; /* Device Information - 0x00 */
1006 UINT16 DataSegLen
; /* Data Segment Length - Big Endian - 0x0000 */
1011 UINT8 HdrSts
; /* Basic Header Status */
1013 UINT8 E2ESts
; /* End-to-End Status */
1023 // UFS 2.0 Spec Section 10.5.13 - UTP NOP OUT UPIU
1029 UINT8 TransCode
:6; /* Transaction Type - 0x00*/
1034 UINT8 TaskTag
; /* Task Tag */
1044 UINT8 EhsLen
; /* Total EHS Length - 0x00 */
1046 UINT16 DataSegLen
; /* Data Segment Length - Big Endian - 0x0000 */
1055 // UFS 2.0 Spec Section 10.5.14 - UTP NOP IN UPIU
1061 UINT8 TransCode
:6; /* Transaction Type - 0x20*/
1066 UINT8 TaskTag
; /* Task Tag */
1072 UINT8 Resp
; /* Response - 0x00 */
1078 UINT8 EhsLen
; /* Total EHS Length - 0x00 */
1079 UINT8 DevInfo
; /* Device Information - 0x00 */
1080 UINT16 DataSegLen
; /* Data Segment Length - Big Endian - 0x0000 */
1092 UfsDeviceDesc
= 0x00,
1093 UfsConfigDesc
= 0x01,
1095 UfsInterConnDesc
= 0x04,
1096 UfsStringDesc
= 0x05,
1097 UfsGeometryDesc
= 0x07,
1102 // UFS 2.0 Spec Section 14.1.6.2 - Device Descriptor
1115 UINT8 InitPowerMode
;
1116 UINT8 HighPriorityLun
;
1117 UINT8 SecureRemovalType
;
1120 UINT8 InitActiveIccLevel
;
1122 UINT16 ManufactureDate
;
1123 UINT8 ManufacturerName
;
1127 UINT16 ManufacturerId
;
1128 UINT8 Ud0BaseOffset
;
1129 UINT8 Ud0ConfParamLen
;
1131 UINT16 PeriodicRtcUpdate
;
1142 UINT8 InitPowerMode
;
1143 UINT8 HighPriorityLun
;
1144 UINT8 SecureRemovalType
;
1145 UINT8 InitActiveIccLevel
;
1146 UINT16 PeriodicRtcUpdate
;
1148 } UFS_CONFIG_DESC_GEN_HEADER
;
1155 UINT32 NumAllocUnits
;
1156 UINT8 DataReliability
;
1158 UINT8 ProvisionType
;
1161 } UFS_UNIT_DESC_CONFIG_PARAMS
;
1164 // UFS 2.0 Spec Section 14.1.6.3 - Configuration Descriptor
1167 UFS_CONFIG_DESC_GEN_HEADER Header
;
1168 UFS_UNIT_DESC_CONFIG_PARAMS UnitDescConfParams
[8];
1172 // UFS 2.0 Spec Section 14.1.6.4 - Geometry Descriptor
1179 UINT64 TotalRawDevCapacity
;
1182 UINT8 AllocUnitSize
;
1183 UINT8 MinAddrBlkSize
;
1184 UINT8 OptReadBlkSize
;
1185 UINT8 OptWriteBlkSize
;
1187 UINT8 MaxOutBufSize
;
1192 UINT8 SysDataTagUnitSize
;
1193 UINT8 SysDataResUnitSize
;
1194 UINT8 SupSecRemovalTypes
;
1196 UINT32 SysCodeMaxNumAllocUnits
;
1197 UINT16 SupCodeCapAdjFac
;
1198 UINT32 NonPersMaxNumAllocUnits
;
1199 UINT16 NonPersCapAdjFac
;
1200 UINT32 Enhance1MaxNumAllocUnits
;
1201 UINT16 Enhance1CapAdjFac
;
1202 UINT32 Enhance2MaxNumAllocUnits
;
1203 UINT16 Enhance2CapAdjFac
;
1204 UINT32 Enhance3MaxNumAllocUnits
;
1205 UINT16 Enhance3CapAdjFac
;
1206 UINT32 Enhance4MaxNumAllocUnits
;
1207 UINT16 Enhance4CapAdjFac
;
1208 } UFS_GEOMETRY_DESC
;
1211 // UFS 2.0 Spec Section 14.1.6.5 - Unit Descriptor
1223 UINT8 DataReliability
;
1225 UINT64 LogicBlkCount
;
1226 UINT32 EraseBlkSize
;
1227 UINT8 ProvisionType
;
1228 UINT64 PhyMemResCount
;
1230 UINT8 LargeUnitGranularity
;
1234 // UFS 2.0 Spec Section 14.1.6.6 - RPMB Unit Descriptor
1248 UINT64 LogicBlkCount
;
1249 UINT32 EraseBlkSize
;
1250 UINT8 ProvisionType
;
1251 UINT64 PhyMemResCount
;
1253 } UFS_RPMB_UNIT_DESC
;
1259 } UFS_POWER_PARAM_ELEMENT
;
1262 // UFS 2.0 Spec Section 14.1.6.7 - Power Parameter Descriptor
1267 UFS_POWER_PARAM_ELEMENT ActiveIccLevelVcc
[16];
1268 UFS_POWER_PARAM_ELEMENT ActiveIccLevelVccQ
[16];
1269 UFS_POWER_PARAM_ELEMENT ActiveIccLevelVccQ2
[16];
1273 // UFS 2.0 Spec Section 14.1.6.8 - InterConnect Descriptor
1280 } UFS_INTER_CONNECT_DESC
;
1283 // UFS 2.0 Spec Section 14.1.6.9 - 14.1.6.12 - String Descriptor
1288 CHAR16 Unicode
[126];
1292 // UFS 2.0 Spec Section 14.2 - Flags
1295 UfsFlagDevInit
= 0x01,
1296 UfsFlagPermWpEn
= 0x02,
1297 UfsFlagPowerOnWpEn
= 0x03,
1298 UfsFlagBgOpsEn
= 0x04,
1299 UfsFlagPurgeEn
= 0x06,
1300 UfsFlagPhyResRemoval
= 0x08,
1301 UfsFlagBusyRtc
= 0x09,
1302 UfsFlagPermDisFwUpdate
= 0x0B
1306 // UFS 2.0 Spec Section 14.2 - Attributes
1309 UfsAttrBootLunEn
= 0x00,
1310 UfsAttrCurPowerMode
= 0x02,
1311 UfsAttrActiveIccLevel
= 0x03,
1312 UfsAttrOutOfOrderDataEn
= 0x04,
1313 UfsAttrBgOpStatus
= 0x05,
1314 UfsAttrPurgeStatus
= 0x06,
1315 UfsAttrMaxDataInSize
= 0x07,
1316 UfsAttrMaxDataOutSize
= 0x08,
1317 UfsAttrDynCapNeeded
= 0x09,
1318 UfsAttrRefClkFreq
= 0x0a,
1319 UfsAttrConfigDescLock
= 0x0b,
1320 UfsAttrMaxNumOfRtt
= 0x0c,
1321 UfsAttrExceptionEvtCtrl
= 0x0d,
1322 UfsAttrExceptionEvtSts
= 0x0e,
1323 UfsAttrSecondsPassed
= 0x0f,
1324 UfsAttrContextConf
= 0x10,
1325 UfsAttrCorrPrgBlkNum
= 0x11
1333 } UFS_DATA_DIRECTION
;