xref: /openbmc/linux/include/ufs/ufshci.h (revision ac8f933664c3a0e2d42f6ee9a2a6d25f87cb23f6)
1dd11376bSBart Van Assche /* SPDX-License-Identifier: GPL-2.0-or-later */
2dd11376bSBart Van Assche /*
3dd11376bSBart Van Assche  * Universal Flash Storage Host controller driver
4dd11376bSBart Van Assche  * Copyright (C) 2011-2013 Samsung India Software Operations
5dd11376bSBart Van Assche  *
6dd11376bSBart Van Assche  * Authors:
7dd11376bSBart Van Assche  *	Santosh Yaraganavi <santosh.sy@samsung.com>
8dd11376bSBart Van Assche  *	Vinayak Holikatti <h.vinayak@samsung.com>
9dd11376bSBart Van Assche  */
10dd11376bSBart Van Assche 
11dd11376bSBart Van Assche #ifndef _UFSHCI_H
12dd11376bSBart Van Assche #define _UFSHCI_H
13dd11376bSBart Van Assche 
14cce9fd60SBart Van Assche #include <linux/types.h>
15cce9fd60SBart Van Assche #include <ufs/ufs.h>
16dd11376bSBart Van Assche 
17dd11376bSBart Van Assche enum {
18dd11376bSBart Van Assche 	TASK_REQ_UPIU_SIZE_DWORDS	= 8,
19dd11376bSBart Van Assche 	TASK_RSP_UPIU_SIZE_DWORDS	= 8,
20dd11376bSBart Van Assche 	ALIGNED_UPIU_SIZE		= 512,
21dd11376bSBart Van Assche };
22dd11376bSBart Van Assche 
23dd11376bSBart Van Assche /* UFSHCI Registers */
24dd11376bSBart Van Assche enum {
25dd11376bSBart Van Assche 	REG_CONTROLLER_CAPABILITIES		= 0x00,
266e1d850aSAsutosh Das 	REG_MCQCAP				= 0x04,
27dd11376bSBart Van Assche 	REG_UFS_VERSION				= 0x08,
28dd11376bSBart Van Assche 	REG_CONTROLLER_DEV_ID			= 0x10,
29dd11376bSBart Van Assche 	REG_CONTROLLER_PROD_ID			= 0x14,
30dd11376bSBart Van Assche 	REG_AUTO_HIBERNATE_IDLE_TIMER		= 0x18,
31dd11376bSBart Van Assche 	REG_INTERRUPT_STATUS			= 0x20,
32dd11376bSBart Van Assche 	REG_INTERRUPT_ENABLE			= 0x24,
33dd11376bSBart Van Assche 	REG_CONTROLLER_STATUS			= 0x30,
34dd11376bSBart Van Assche 	REG_CONTROLLER_ENABLE			= 0x34,
35dd11376bSBart Van Assche 	REG_UIC_ERROR_CODE_PHY_ADAPTER_LAYER	= 0x38,
36dd11376bSBart Van Assche 	REG_UIC_ERROR_CODE_DATA_LINK_LAYER	= 0x3C,
37dd11376bSBart Van Assche 	REG_UIC_ERROR_CODE_NETWORK_LAYER	= 0x40,
38dd11376bSBart Van Assche 	REG_UIC_ERROR_CODE_TRANSPORT_LAYER	= 0x44,
39dd11376bSBart Van Assche 	REG_UIC_ERROR_CODE_DME			= 0x48,
40dd11376bSBart Van Assche 	REG_UTP_TRANSFER_REQ_INT_AGG_CONTROL	= 0x4C,
41dd11376bSBart Van Assche 	REG_UTP_TRANSFER_REQ_LIST_BASE_L	= 0x50,
42dd11376bSBart Van Assche 	REG_UTP_TRANSFER_REQ_LIST_BASE_H	= 0x54,
43dd11376bSBart Van Assche 	REG_UTP_TRANSFER_REQ_DOOR_BELL		= 0x58,
44dd11376bSBart Van Assche 	REG_UTP_TRANSFER_REQ_LIST_CLEAR		= 0x5C,
45dd11376bSBart Van Assche 	REG_UTP_TRANSFER_REQ_LIST_RUN_STOP	= 0x60,
46dd11376bSBart Van Assche 	REG_UTP_TASK_REQ_LIST_BASE_L		= 0x70,
47dd11376bSBart Van Assche 	REG_UTP_TASK_REQ_LIST_BASE_H		= 0x74,
48dd11376bSBart Van Assche 	REG_UTP_TASK_REQ_DOOR_BELL		= 0x78,
49dd11376bSBart Van Assche 	REG_UTP_TASK_REQ_LIST_CLEAR		= 0x7C,
50dd11376bSBart Van Assche 	REG_UTP_TASK_REQ_LIST_RUN_STOP		= 0x80,
51dd11376bSBart Van Assche 	REG_UIC_COMMAND				= 0x90,
52dd11376bSBart Van Assche 	REG_UIC_COMMAND_ARG_1			= 0x94,
53dd11376bSBart Van Assche 	REG_UIC_COMMAND_ARG_2			= 0x98,
54dd11376bSBart Van Assche 	REG_UIC_COMMAND_ARG_3			= 0x9C,
55dd11376bSBart Van Assche 
56dd11376bSBart Van Assche 	UFSHCI_REG_SPACE_SIZE			= 0xA0,
57dd11376bSBart Van Assche 
58dd11376bSBart Van Assche 	REG_UFS_CCAP				= 0x100,
59dd11376bSBart Van Assche 	REG_UFS_CRYPTOCAP			= 0x104,
60dd11376bSBart Van Assche 
612468da61SAsutosh Das 	REG_UFS_MEM_CFG				= 0x300,
627224c806SAsutosh Das 	REG_UFS_MCQ_CFG				= 0x380,
63e02288e0SCan Guo 	REG_UFS_ESILBA				= 0x384,
64e02288e0SCan Guo 	REG_UFS_ESIUBA				= 0x388,
65dd11376bSBart Van Assche 	UFSHCI_CRYPTO_REG_SPACE_SIZE		= 0x400,
66dd11376bSBart Van Assche };
67dd11376bSBart Van Assche 
68dd11376bSBart Van Assche /* Controller capability masks */
69dd11376bSBart Van Assche enum {
70dd11376bSBart Van Assche 	MASK_TRANSFER_REQUESTS_SLOTS		= 0x0000001F,
71dd11376bSBart Van Assche 	MASK_TASK_MANAGEMENT_REQUEST_SLOTS	= 0x00070000,
726ff265fcSBean Huo 	MASK_EHSLUTRD_SUPPORTED			= 0x00400000,
73dd11376bSBart Van Assche 	MASK_AUTO_HIBERN8_SUPPORT		= 0x00800000,
74dd11376bSBart Van Assche 	MASK_64_ADDRESSING_SUPPORT		= 0x01000000,
75dd11376bSBart Van Assche 	MASK_OUT_OF_ORDER_DATA_DELIVERY_SUPPORT	= 0x02000000,
76dd11376bSBart Van Assche 	MASK_UIC_DME_TEST_MODE_SUPPORT		= 0x04000000,
77dd11376bSBart Van Assche 	MASK_CRYPTO_SUPPORT			= 0x10000000,
78*8d1af5c6SKyoungrul Kim 	MASK_LSDB_SUPPORT			= 0x20000000,
796e1d850aSAsutosh Das 	MASK_MCQ_SUPPORT			= 0x40000000,
806e1d850aSAsutosh Das };
816e1d850aSAsutosh Das 
826e1d850aSAsutosh Das /* MCQ capability mask */
836e1d850aSAsutosh Das enum {
846e1d850aSAsutosh Das 	MASK_EXT_IID_SUPPORT = 0x00000400,
85dd11376bSBart Van Assche };
86dd11376bSBart Van Assche 
872468da61SAsutosh Das enum {
882468da61SAsutosh Das 	REG_SQATTR		= 0x0,
892468da61SAsutosh Das 	REG_SQLBA		= 0x4,
902468da61SAsutosh Das 	REG_SQUBA		= 0x8,
912468da61SAsutosh Das 	REG_SQDAO		= 0xC,
922468da61SAsutosh Das 	REG_SQISAO		= 0x10,
932468da61SAsutosh Das 
942468da61SAsutosh Das 	REG_CQATTR		= 0x20,
952468da61SAsutosh Das 	REG_CQLBA		= 0x24,
962468da61SAsutosh Das 	REG_CQUBA		= 0x28,
972468da61SAsutosh Das 	REG_CQDAO		= 0x2C,
982468da61SAsutosh Das 	REG_CQISAO		= 0x30,
992468da61SAsutosh Das };
1002468da61SAsutosh Das 
1012468da61SAsutosh Das enum {
1022468da61SAsutosh Das 	REG_SQHP		= 0x0,
1032468da61SAsutosh Das 	REG_SQTP		= 0x4,
1048d729034SBao D. Nguyen 	REG_SQRTC		= 0x8,
1058d729034SBao D. Nguyen 	REG_SQCTI		= 0xC,
1068d729034SBao D. Nguyen 	REG_SQRTS		= 0x10,
1072468da61SAsutosh Das };
1082468da61SAsutosh Das 
1092468da61SAsutosh Das enum {
1102468da61SAsutosh Das 	REG_CQHP		= 0x0,
1112468da61SAsutosh Das 	REG_CQTP		= 0x4,
1122468da61SAsutosh Das };
1132468da61SAsutosh Das 
1142468da61SAsutosh Das enum {
1152468da61SAsutosh Das 	REG_CQIS		= 0x0,
1162468da61SAsutosh Das 	REG_CQIE		= 0x4,
1172468da61SAsutosh Das };
1182468da61SAsutosh Das 
1198d729034SBao D. Nguyen enum {
1208d729034SBao D. Nguyen 	SQ_START		= 0x0,
1218d729034SBao D. Nguyen 	SQ_STOP			= 0x1,
1228d729034SBao D. Nguyen 	SQ_ICU			= 0x2,
1238d729034SBao D. Nguyen };
1248d729034SBao D. Nguyen 
1258d729034SBao D. Nguyen enum {
1268d729034SBao D. Nguyen 	SQ_STS			= 0x1,
1278d729034SBao D. Nguyen 	SQ_CUS			= 0x2,
1288d729034SBao D. Nguyen };
1298d729034SBao D. Nguyen 
1308d729034SBao D. Nguyen #define SQ_ICU_ERR_CODE_MASK		GENMASK(7, 4)
131dd11376bSBart Van Assche #define UFS_MASK(mask, offset)		((mask) << (offset))
132dd11376bSBart Van Assche 
133dd11376bSBart Van Assche /* UFS Version 08h */
134dd11376bSBart Van Assche #define MINOR_VERSION_NUM_MASK		UFS_MASK(0xFFFF, 0)
135dd11376bSBart Van Assche #define MAJOR_VERSION_NUM_MASK		UFS_MASK(0xFFFF, 16)
136dd11376bSBart Van Assche 
1378d729034SBao D. Nguyen #define UFSHCD_NUM_RESERVED	1
138dd11376bSBart Van Assche /*
139dd11376bSBart Van Assche  * Controller UFSHCI version
140dd11376bSBart Van Assche  * - 2.x and newer use the following scheme:
141dd11376bSBart Van Assche  *   major << 8 + minor << 4
142dd11376bSBart Van Assche  * - 1.x has been converted to match this in
143dd11376bSBart Van Assche  *   ufshcd_get_ufs_version()
144dd11376bSBart Van Assche  */
ufshci_version(u32 major,u32 minor)145dd11376bSBart Van Assche static inline u32 ufshci_version(u32 major, u32 minor)
146dd11376bSBart Van Assche {
147dd11376bSBart Van Assche 	return (major << 8) + (minor << 4);
148dd11376bSBart Van Assche }
149dd11376bSBart Van Assche 
150dd11376bSBart Van Assche /*
151dd11376bSBart Van Assche  * HCDDID - Host Controller Identification Descriptor
152dd11376bSBart Van Assche  *	  - Device ID and Device Class 10h
153dd11376bSBart Van Assche  */
154dd11376bSBart Van Assche #define DEVICE_CLASS	UFS_MASK(0xFFFF, 0)
155dd11376bSBart Van Assche #define DEVICE_ID	UFS_MASK(0xFF, 24)
156dd11376bSBart Van Assche 
157dd11376bSBart Van Assche /*
158dd11376bSBart Van Assche  * HCPMID - Host Controller Identification Descriptor
159dd11376bSBart Van Assche  *	  - Product/Manufacturer ID  14h
160dd11376bSBart Van Assche  */
161dd11376bSBart Van Assche #define MANUFACTURE_ID_MASK	UFS_MASK(0xFFFF, 0)
162dd11376bSBart Van Assche #define PRODUCT_ID_MASK		UFS_MASK(0xFFFF, 16)
163dd11376bSBart Van Assche 
164dd11376bSBart Van Assche /* AHIT - Auto-Hibernate Idle Timer */
165dd11376bSBart Van Assche #define UFSHCI_AHIBERN8_TIMER_MASK		GENMASK(9, 0)
166dd11376bSBart Van Assche #define UFSHCI_AHIBERN8_SCALE_MASK		GENMASK(12, 10)
167dd11376bSBart Van Assche #define UFSHCI_AHIBERN8_SCALE_FACTOR		10
168dd11376bSBart Van Assche #define UFSHCI_AHIBERN8_MAX			(1023 * 100000)
169dd11376bSBart Van Assche 
170dd11376bSBart Van Assche /*
171dd11376bSBart Van Assche  * IS - Interrupt Status - 20h
172dd11376bSBart Van Assche  */
173dd11376bSBart Van Assche #define UTP_TRANSFER_REQ_COMPL			0x1
174dd11376bSBart Van Assche #define UIC_DME_END_PT_RESET			0x2
175dd11376bSBart Van Assche #define UIC_ERROR				0x4
176dd11376bSBart Van Assche #define UIC_TEST_MODE				0x8
177dd11376bSBart Van Assche #define UIC_POWER_MODE				0x10
178dd11376bSBart Van Assche #define UIC_HIBERNATE_EXIT			0x20
179dd11376bSBart Van Assche #define UIC_HIBERNATE_ENTER			0x40
180dd11376bSBart Van Assche #define UIC_LINK_LOST				0x80
181dd11376bSBart Van Assche #define UIC_LINK_STARTUP			0x100
182dd11376bSBart Van Assche #define UTP_TASK_REQ_COMPL			0x200
183dd11376bSBart Van Assche #define UIC_COMMAND_COMPL			0x400
184dd11376bSBart Van Assche #define DEVICE_FATAL_ERROR			0x800
185dd11376bSBart Van Assche #define CONTROLLER_FATAL_ERROR			0x10000
186dd11376bSBart Van Assche #define SYSTEM_BUS_FATAL_ERROR			0x20000
187dd11376bSBart Van Assche #define CRYPTO_ENGINE_FATAL_ERROR		0x40000
1882468da61SAsutosh Das #define MCQ_CQ_EVENT_STATUS			0x100000
189dd11376bSBart Van Assche 
190dd11376bSBart Van Assche #define UFSHCD_UIC_HIBERN8_MASK	(UIC_HIBERNATE_ENTER |\
191dd11376bSBart Van Assche 				UIC_HIBERNATE_EXIT)
192dd11376bSBart Van Assche 
193dd11376bSBart Van Assche #define UFSHCD_UIC_PWR_MASK	(UFSHCD_UIC_HIBERN8_MASK |\
194dd11376bSBart Van Assche 				UIC_POWER_MODE)
195dd11376bSBart Van Assche 
196dd11376bSBart Van Assche #define UFSHCD_UIC_MASK		(UIC_COMMAND_COMPL | UFSHCD_UIC_PWR_MASK)
197dd11376bSBart Van Assche 
1986d17a112SKiwoong Kim #define UFSHCD_ERROR_MASK	(UIC_ERROR | INT_FATAL_ERRORS)
199dd11376bSBart Van Assche 
200dd11376bSBart Van Assche #define INT_FATAL_ERRORS	(DEVICE_FATAL_ERROR |\
201dd11376bSBart Van Assche 				CONTROLLER_FATAL_ERROR |\
202dd11376bSBart Van Assche 				SYSTEM_BUS_FATAL_ERROR |\
203dd11376bSBart Van Assche 				CRYPTO_ENGINE_FATAL_ERROR |\
204dd11376bSBart Van Assche 				UIC_LINK_LOST)
205dd11376bSBart Van Assche 
206dd11376bSBart Van Assche /* HCS - Host Controller Status 30h */
207dd11376bSBart Van Assche #define DEVICE_PRESENT				0x1
208dd11376bSBart Van Assche #define UTP_TRANSFER_REQ_LIST_READY		0x2
209dd11376bSBart Van Assche #define UTP_TASK_REQ_LIST_READY			0x4
210dd11376bSBart Van Assche #define UIC_COMMAND_READY			0x8
211dd11376bSBart Van Assche #define HOST_ERROR_INDICATOR			0x10
212dd11376bSBart Van Assche #define DEVICE_ERROR_INDICATOR			0x20
213dd11376bSBart Van Assche #define UIC_POWER_MODE_CHANGE_REQ_STATUS_MASK	UFS_MASK(0x7, 8)
214dd11376bSBart Van Assche 
215dd11376bSBart Van Assche #define UFSHCD_STATUS_READY	(UTP_TRANSFER_REQ_LIST_READY |\
216dd11376bSBart Van Assche 				UTP_TASK_REQ_LIST_READY |\
217dd11376bSBart Van Assche 				UIC_COMMAND_READY)
218dd11376bSBart Van Assche 
219dd11376bSBart Van Assche enum {
220dd11376bSBart Van Assche 	PWR_OK		= 0x0,
221dd11376bSBart Van Assche 	PWR_LOCAL	= 0x01,
222dd11376bSBart Van Assche 	PWR_REMOTE	= 0x02,
223dd11376bSBart Van Assche 	PWR_BUSY	= 0x03,
224dd11376bSBart Van Assche 	PWR_ERROR_CAP	= 0x04,
225dd11376bSBart Van Assche 	PWR_FATAL_ERROR	= 0x05,
226dd11376bSBart Van Assche };
227dd11376bSBart Van Assche 
228dd11376bSBart Van Assche /* HCE - Host Controller Enable 34h */
229dd11376bSBart Van Assche #define CONTROLLER_ENABLE	0x1
230dd11376bSBart Van Assche #define CONTROLLER_DISABLE	0x0
231dd11376bSBart Van Assche #define CRYPTO_GENERAL_ENABLE	0x2
232dd11376bSBart Van Assche 
233dd11376bSBart Van Assche /* UECPA - Host UIC Error Code PHY Adapter Layer 38h */
234dd11376bSBart Van Assche #define UIC_PHY_ADAPTER_LAYER_ERROR			0x80000000
235dd11376bSBart Van Assche #define UIC_PHY_ADAPTER_LAYER_ERROR_CODE_MASK		0x1F
236dd11376bSBart Van Assche #define UIC_PHY_ADAPTER_LAYER_LANE_ERR_MASK		0xF
237dd11376bSBart Van Assche #define UIC_PHY_ADAPTER_LAYER_GENERIC_ERROR		0x10
238dd11376bSBart Van Assche 
239dd11376bSBart Van Assche /* UECDL - Host UIC Error Code Data Link Layer 3Ch */
240dd11376bSBart Van Assche #define UIC_DATA_LINK_LAYER_ERROR		0x80000000
241dd11376bSBart Van Assche #define UIC_DATA_LINK_LAYER_ERROR_CODE_MASK	0xFFFF
242dd11376bSBart Van Assche #define UIC_DATA_LINK_LAYER_ERROR_TCX_REP_TIMER_EXP	0x2
243dd11376bSBart Van Assche #define UIC_DATA_LINK_LAYER_ERROR_AFCX_REQ_TIMER_EXP	0x4
244dd11376bSBart Van Assche #define UIC_DATA_LINK_LAYER_ERROR_FCX_PRO_TIMER_EXP	0x8
245dd11376bSBart Van Assche #define UIC_DATA_LINK_LAYER_ERROR_RX_BUF_OF	0x20
246dd11376bSBart Van Assche #define UIC_DATA_LINK_LAYER_ERROR_PA_INIT	0x2000
247dd11376bSBart Van Assche #define UIC_DATA_LINK_LAYER_ERROR_NAC_RECEIVED	0x0001
248dd11376bSBart Van Assche #define UIC_DATA_LINK_LAYER_ERROR_TCx_REPLAY_TIMEOUT 0x0002
249dd11376bSBart Van Assche 
250dd11376bSBart Van Assche /* UECN - Host UIC Error Code Network Layer 40h */
251dd11376bSBart Van Assche #define UIC_NETWORK_LAYER_ERROR			0x80000000
252dd11376bSBart Van Assche #define UIC_NETWORK_LAYER_ERROR_CODE_MASK	0x7
253dd11376bSBart Van Assche #define UIC_NETWORK_UNSUPPORTED_HEADER_TYPE	0x1
254dd11376bSBart Van Assche #define UIC_NETWORK_BAD_DEVICEID_ENC		0x2
255dd11376bSBart Van Assche #define UIC_NETWORK_LHDR_TRAP_PACKET_DROPPING	0x4
256dd11376bSBart Van Assche 
257dd11376bSBart Van Assche /* UECT - Host UIC Error Code Transport Layer 44h */
258dd11376bSBart Van Assche #define UIC_TRANSPORT_LAYER_ERROR		0x80000000
259dd11376bSBart Van Assche #define UIC_TRANSPORT_LAYER_ERROR_CODE_MASK	0x7F
260dd11376bSBart Van Assche #define UIC_TRANSPORT_UNSUPPORTED_HEADER_TYPE	0x1
261dd11376bSBart Van Assche #define UIC_TRANSPORT_UNKNOWN_CPORTID		0x2
262dd11376bSBart Van Assche #define UIC_TRANSPORT_NO_CONNECTION_RX		0x4
263dd11376bSBart Van Assche #define UIC_TRANSPORT_CONTROLLED_SEGMENT_DROPPING	0x8
264dd11376bSBart Van Assche #define UIC_TRANSPORT_BAD_TC			0x10
265dd11376bSBart Van Assche #define UIC_TRANSPORT_E2E_CREDIT_OVERFOW	0x20
266dd11376bSBart Van Assche #define UIC_TRANSPORT_SAFETY_VALUE_DROPPING	0x40
267dd11376bSBart Van Assche 
268dd11376bSBart Van Assche /* UECDME - Host UIC Error Code DME 48h */
269dd11376bSBart Van Assche #define UIC_DME_ERROR			0x80000000
270dd11376bSBart Van Assche #define UIC_DME_ERROR_CODE_MASK		0x1
271dd11376bSBart Van Assche 
272dd11376bSBart Van Assche /* UTRIACR - Interrupt Aggregation control register - 0x4Ch */
273dd11376bSBart Van Assche #define INT_AGGR_TIMEOUT_VAL_MASK		0xFF
274dd11376bSBart Van Assche #define INT_AGGR_COUNTER_THRESHOLD_MASK		UFS_MASK(0x1F, 8)
275dd11376bSBart Van Assche #define INT_AGGR_COUNTER_AND_TIMER_RESET	0x10000
276dd11376bSBart Van Assche #define INT_AGGR_STATUS_BIT			0x100000
277dd11376bSBart Van Assche #define INT_AGGR_PARAM_WRITE			0x1000000
278dd11376bSBart Van Assche #define INT_AGGR_ENABLE				0x80000000
279dd11376bSBart Van Assche 
280dd11376bSBart Van Assche /* UTRLRSR - UTP Transfer Request Run-Stop Register 60h */
281dd11376bSBart Van Assche #define UTP_TRANSFER_REQ_LIST_RUN_STOP_BIT	0x1
282dd11376bSBart Van Assche 
283dd11376bSBart Van Assche /* UTMRLRSR - UTP Task Management Request Run-Stop Register 80h */
284dd11376bSBart Van Assche #define UTP_TASK_REQ_LIST_RUN_STOP_BIT		0x1
285dd11376bSBart Van Assche 
286f87b2c41SAsutosh Das /* CQISy - CQ y Interrupt Status Register  */
287f87b2c41SAsutosh Das #define UFSHCD_MCQ_CQIS_TAIL_ENT_PUSH_STS	0x1
288f87b2c41SAsutosh Das 
289dd11376bSBart Van Assche /* UICCMD - UIC Command */
290dd11376bSBart Van Assche #define COMMAND_OPCODE_MASK		0xFF
291dd11376bSBart Van Assche #define GEN_SELECTOR_INDEX_MASK		0xFFFF
292dd11376bSBart Van Assche 
293dd11376bSBart Van Assche #define MIB_ATTRIBUTE_MASK		UFS_MASK(0xFFFF, 16)
294dd11376bSBart Van Assche #define RESET_LEVEL			0xFF
295dd11376bSBart Van Assche 
296dd11376bSBart Van Assche #define ATTR_SET_TYPE_MASK		UFS_MASK(0xFF, 16)
297dd11376bSBart Van Assche #define CONFIG_RESULT_CODE_MASK		0xFF
298dd11376bSBart Van Assche #define GENERIC_ERROR_CODE_MASK		0xFF
299dd11376bSBart Van Assche 
300dd11376bSBart Van Assche /* GenSelectorIndex calculation macros for M-PHY attributes */
301dd11376bSBart Van Assche #define UIC_ARG_MPHY_TX_GEN_SEL_INDEX(lane) (lane)
302dd11376bSBart Van Assche #define UIC_ARG_MPHY_RX_GEN_SEL_INDEX(lane) (PA_MAXDATALANES + (lane))
303dd11376bSBart Van Assche 
304dd11376bSBart Van Assche #define UIC_ARG_MIB_SEL(attr, sel)	((((attr) & 0xFFFF) << 16) |\
305dd11376bSBart Van Assche 					 ((sel) & 0xFFFF))
306dd11376bSBart Van Assche #define UIC_ARG_MIB(attr)		UIC_ARG_MIB_SEL(attr, 0)
307dd11376bSBart Van Assche #define UIC_ARG_ATTR_TYPE(t)		(((t) & 0xFF) << 16)
308dd11376bSBart Van Assche #define UIC_GET_ATTR_ID(v)		(((v) >> 16) & 0xFFFF)
309dd11376bSBart Van Assche 
310dd11376bSBart Van Assche /* Link Status*/
311dd11376bSBart Van Assche enum link_status {
312dd11376bSBart Van Assche 	UFSHCD_LINK_IS_DOWN	= 1,
313dd11376bSBart Van Assche 	UFSHCD_LINK_IS_UP	= 2,
314dd11376bSBart Van Assche };
315dd11376bSBart Van Assche 
316dd11376bSBart Van Assche /* UIC Commands */
317dd11376bSBart Van Assche enum uic_cmd_dme {
318dd11376bSBart Van Assche 	UIC_CMD_DME_GET			= 0x01,
319dd11376bSBart Van Assche 	UIC_CMD_DME_SET			= 0x02,
320dd11376bSBart Van Assche 	UIC_CMD_DME_PEER_GET		= 0x03,
321dd11376bSBart Van Assche 	UIC_CMD_DME_PEER_SET		= 0x04,
322dd11376bSBart Van Assche 	UIC_CMD_DME_POWERON		= 0x10,
323dd11376bSBart Van Assche 	UIC_CMD_DME_POWEROFF		= 0x11,
324dd11376bSBart Van Assche 	UIC_CMD_DME_ENABLE		= 0x12,
325dd11376bSBart Van Assche 	UIC_CMD_DME_RESET		= 0x14,
326dd11376bSBart Van Assche 	UIC_CMD_DME_END_PT_RST		= 0x15,
327dd11376bSBart Van Assche 	UIC_CMD_DME_LINK_STARTUP	= 0x16,
328dd11376bSBart Van Assche 	UIC_CMD_DME_HIBER_ENTER		= 0x17,
329dd11376bSBart Van Assche 	UIC_CMD_DME_HIBER_EXIT		= 0x18,
330dd11376bSBart Van Assche 	UIC_CMD_DME_TEST_MODE		= 0x1A,
331dd11376bSBart Van Assche };
332dd11376bSBart Van Assche 
333dd11376bSBart Van Assche /* UIC Config result code / Generic error code */
334dd11376bSBart Van Assche enum {
335dd11376bSBart Van Assche 	UIC_CMD_RESULT_SUCCESS			= 0x00,
336dd11376bSBart Van Assche 	UIC_CMD_RESULT_INVALID_ATTR		= 0x01,
337dd11376bSBart Van Assche 	UIC_CMD_RESULT_FAILURE			= 0x01,
338dd11376bSBart Van Assche 	UIC_CMD_RESULT_INVALID_ATTR_VALUE	= 0x02,
339dd11376bSBart Van Assche 	UIC_CMD_RESULT_READ_ONLY_ATTR		= 0x03,
340dd11376bSBart Van Assche 	UIC_CMD_RESULT_WRITE_ONLY_ATTR		= 0x04,
341dd11376bSBart Van Assche 	UIC_CMD_RESULT_BAD_INDEX		= 0x05,
342dd11376bSBart Van Assche 	UIC_CMD_RESULT_LOCKED_ATTR		= 0x06,
343dd11376bSBart Van Assche 	UIC_CMD_RESULT_BAD_TEST_FEATURE_INDEX	= 0x07,
344dd11376bSBart Van Assche 	UIC_CMD_RESULT_PEER_COMM_FAILURE	= 0x08,
345dd11376bSBart Van Assche 	UIC_CMD_RESULT_BUSY			= 0x09,
346dd11376bSBart Van Assche 	UIC_CMD_RESULT_DME_FAILURE		= 0x0A,
347dd11376bSBart Van Assche };
348dd11376bSBart Van Assche 
349dd11376bSBart Van Assche #define MASK_UIC_COMMAND_RESULT			0xFF
350dd11376bSBart Van Assche 
351dd11376bSBart Van Assche #define INT_AGGR_COUNTER_THLD_VAL(c)	(((c) & 0x1F) << 8)
352dd11376bSBart Van Assche #define INT_AGGR_TIMEOUT_VAL(t)		(((t) & 0xFF) << 0)
353dd11376bSBart Van Assche 
354dd11376bSBart Van Assche /* Interrupt disable masks */
355dd11376bSBart Van Assche enum {
356dd11376bSBart Van Assche 	/* Interrupt disable mask for UFSHCI v1.0 */
357dd11376bSBart Van Assche 	INTERRUPT_MASK_ALL_VER_10	= 0x30FFF,
358dd11376bSBart Van Assche 	INTERRUPT_MASK_RW_VER_10	= 0x30000,
359dd11376bSBart Van Assche 
360dd11376bSBart Van Assche 	/* Interrupt disable mask for UFSHCI v1.1 */
361dd11376bSBart Van Assche 	INTERRUPT_MASK_ALL_VER_11	= 0x31FFF,
362dd11376bSBart Van Assche 
363dd11376bSBart Van Assche 	/* Interrupt disable mask for UFSHCI v2.1 */
364dd11376bSBart Van Assche 	INTERRUPT_MASK_ALL_VER_21	= 0x71FFF,
365dd11376bSBart Van Assche };
366dd11376bSBart Van Assche 
367dd11376bSBart Van Assche /* CCAP - Crypto Capability 100h */
368dd11376bSBart Van Assche union ufs_crypto_capabilities {
369dd11376bSBart Van Assche 	__le32 reg_val;
370dd11376bSBart Van Assche 	struct {
371dd11376bSBart Van Assche 		u8 num_crypto_cap;
372dd11376bSBart Van Assche 		u8 config_count;
373dd11376bSBart Van Assche 		u8 reserved;
374dd11376bSBart Van Assche 		u8 config_array_ptr;
375dd11376bSBart Van Assche 	};
376dd11376bSBart Van Assche };
377dd11376bSBart Van Assche 
378dd11376bSBart Van Assche enum ufs_crypto_key_size {
379dd11376bSBart Van Assche 	UFS_CRYPTO_KEY_SIZE_INVALID	= 0x0,
380dd11376bSBart Van Assche 	UFS_CRYPTO_KEY_SIZE_128		= 0x1,
381dd11376bSBart Van Assche 	UFS_CRYPTO_KEY_SIZE_192		= 0x2,
382dd11376bSBart Van Assche 	UFS_CRYPTO_KEY_SIZE_256		= 0x3,
383dd11376bSBart Van Assche 	UFS_CRYPTO_KEY_SIZE_512		= 0x4,
384dd11376bSBart Van Assche };
385dd11376bSBart Van Assche 
386dd11376bSBart Van Assche enum ufs_crypto_alg {
387dd11376bSBart Van Assche 	UFS_CRYPTO_ALG_AES_XTS			= 0x0,
388dd11376bSBart Van Assche 	UFS_CRYPTO_ALG_BITLOCKER_AES_CBC	= 0x1,
389dd11376bSBart Van Assche 	UFS_CRYPTO_ALG_AES_ECB			= 0x2,
390dd11376bSBart Van Assche 	UFS_CRYPTO_ALG_ESSIV_AES_CBC		= 0x3,
391dd11376bSBart Van Assche };
392dd11376bSBart Van Assche 
393dd11376bSBart Van Assche /* x-CRYPTOCAP - Crypto Capability X */
394dd11376bSBart Van Assche union ufs_crypto_cap_entry {
395dd11376bSBart Van Assche 	__le32 reg_val;
396dd11376bSBart Van Assche 	struct {
397dd11376bSBart Van Assche 		u8 algorithm_id;
398dd11376bSBart Van Assche 		u8 sdus_mask; /* Supported data unit size mask */
399dd11376bSBart Van Assche 		u8 key_size;
400dd11376bSBart Van Assche 		u8 reserved;
401dd11376bSBart Van Assche 	};
402dd11376bSBart Van Assche };
403dd11376bSBart Van Assche 
404dd11376bSBart Van Assche #define UFS_CRYPTO_CONFIGURATION_ENABLE (1 << 7)
405dd11376bSBart Van Assche #define UFS_CRYPTO_KEY_MAX_SIZE 64
406dd11376bSBart Van Assche /* x-CRYPTOCFG - Crypto Configuration X */
407dd11376bSBart Van Assche union ufs_crypto_cfg_entry {
408dd11376bSBart Van Assche 	__le32 reg_val[32];
409dd11376bSBart Van Assche 	struct {
410dd11376bSBart Van Assche 		u8 crypto_key[UFS_CRYPTO_KEY_MAX_SIZE];
411dd11376bSBart Van Assche 		u8 data_unit_size;
412dd11376bSBart Van Assche 		u8 crypto_cap_idx;
413dd11376bSBart Van Assche 		u8 reserved_1;
414dd11376bSBart Van Assche 		u8 config_enable;
415dd11376bSBart Van Assche 		u8 reserved_multi_host;
416dd11376bSBart Van Assche 		u8 reserved_2;
417dd11376bSBart Van Assche 		u8 vsb[2];
418dd11376bSBart Van Assche 		u8 reserved_3[56];
419dd11376bSBart Van Assche 	};
420dd11376bSBart Van Assche };
421dd11376bSBart Van Assche 
422dd11376bSBart Van Assche /*
423dd11376bSBart Van Assche  * Request Descriptor Definitions
424dd11376bSBart Van Assche  */
425dd11376bSBart Van Assche 
426dd11376bSBart Van Assche /* Transfer request command type */
427dd11376bSBart Van Assche enum {
428dd11376bSBart Van Assche 	UTP_CMD_TYPE_SCSI		= 0x0,
429dd11376bSBart Van Assche 	UTP_CMD_TYPE_UFS		= 0x1,
430dd11376bSBart Van Assche 	UTP_CMD_TYPE_DEV_MANAGE		= 0x2,
431dd11376bSBart Van Assche };
432dd11376bSBart Van Assche 
433dd11376bSBart Van Assche /* To accommodate UFS2.0 required Command type */
434dd11376bSBart Van Assche enum {
435dd11376bSBart Van Assche 	UTP_CMD_TYPE_UFS_STORAGE	= 0x1,
436dd11376bSBart Van Assche };
437dd11376bSBart Van Assche 
438dd11376bSBart Van Assche enum {
439dd11376bSBart Van Assche 	UTP_SCSI_COMMAND		= 0x00000000,
440dd11376bSBart Van Assche 	UTP_NATIVE_UFS_COMMAND		= 0x10000000,
441dd11376bSBart Van Assche 	UTP_DEVICE_MANAGEMENT_FUNCTION	= 0x20000000,
442dd11376bSBart Van Assche };
443dd11376bSBart Van Assche 
444dd11376bSBart Van Assche /* UTP Transfer Request Data Direction (DD) */
44567a2a897SBart Van Assche enum utp_data_direction {
44667a2a897SBart Van Assche 	UTP_NO_DATA_TRANSFER	= 0,
44767a2a897SBart Van Assche 	UTP_HOST_TO_DEVICE	= 1,
44867a2a897SBart Van Assche 	UTP_DEVICE_TO_HOST	= 2,
449dd11376bSBart Van Assche };
450dd11376bSBart Van Assche 
451dd11376bSBart Van Assche /* Overall command status values */
452dd11376bSBart Van Assche enum utp_ocs {
453dd11376bSBart Van Assche 	OCS_SUCCESS			= 0x0,
454dd11376bSBart Van Assche 	OCS_INVALID_CMD_TABLE_ATTR	= 0x1,
455dd11376bSBart Van Assche 	OCS_INVALID_PRDT_ATTR		= 0x2,
456dd11376bSBart Van Assche 	OCS_MISMATCH_DATA_BUF_SIZE	= 0x3,
457dd11376bSBart Van Assche 	OCS_MISMATCH_RESP_UPIU_SIZE	= 0x4,
458dd11376bSBart Van Assche 	OCS_PEER_COMM_FAILURE		= 0x5,
459dd11376bSBart Van Assche 	OCS_ABORTED			= 0x6,
460dd11376bSBart Van Assche 	OCS_FATAL_ERROR			= 0x7,
461dd11376bSBart Van Assche 	OCS_DEVICE_FATAL_ERROR		= 0x8,
462dd11376bSBart Van Assche 	OCS_INVALID_CRYPTO_CONFIG	= 0x9,
463dd11376bSBart Van Assche 	OCS_GENERAL_CRYPTO_ERROR	= 0xA,
464dd11376bSBart Van Assche 	OCS_INVALID_COMMAND_STATUS	= 0x0F,
465dd11376bSBart Van Assche };
466dd11376bSBart Van Assche 
467dd11376bSBart Van Assche enum {
468dd11376bSBart Van Assche 	MASK_OCS			= 0x0F,
469dd11376bSBart Van Assche };
470dd11376bSBart Van Assche 
471dd11376bSBart Van Assche /* The maximum length of the data byte count field in the PRDT is 256KB */
47223caa33dSAvri Altman #define PRDT_DATA_BYTE_COUNT_MAX	SZ_256K
473dd11376bSBart Van Assche /* The granularity of the data byte count field in the PRDT is 32-bit */
474dd11376bSBart Van Assche #define PRDT_DATA_BYTE_COUNT_PAD	4
475dd11376bSBart Van Assche 
476dd11376bSBart Van Assche /**
477dd11376bSBart Van Assche  * struct ufshcd_sg_entry - UFSHCI PRD Entry
478dd11376bSBart Van Assche  * @addr: Physical address; DW-0 and DW-1.
479dd11376bSBart Van Assche  * @reserved: Reserved for future use DW-2
480dd11376bSBart Van Assche  * @size: size of physical segment DW-3
481dd11376bSBart Van Assche  */
482dd11376bSBart Van Assche struct ufshcd_sg_entry {
483dd11376bSBart Van Assche 	__le64    addr;
484dd11376bSBart Van Assche 	__le32    reserved;
485dd11376bSBart Van Assche 	__le32    size;
486ada1e653SEric Biggers 	/*
487ada1e653SEric Biggers 	 * followed by variant-specific fields if
488ada1e653SEric Biggers 	 * CONFIG_SCSI_UFS_VARIABLE_SG_ENTRY_SIZE has been defined.
489ada1e653SEric Biggers 	 */
490dd11376bSBart Van Assche };
491dd11376bSBart Van Assche 
492dd11376bSBart Van Assche /**
493dd11376bSBart Van Assche  * struct utp_transfer_cmd_desc - UTP Command Descriptor (UCD)
494dd11376bSBart Van Assche  * @command_upiu: Command UPIU Frame address
495dd11376bSBart Van Assche  * @response_upiu: Response UPIU Frame address
496ada1e653SEric Biggers  * @prd_table: Physical Region Descriptor: an array of SG_ALL struct
497ada1e653SEric Biggers  *	ufshcd_sg_entry's.  Variant-specific fields may be present after each.
498dd11376bSBart Van Assche  */
499dd11376bSBart Van Assche struct utp_transfer_cmd_desc {
500dd11376bSBart Van Assche 	u8 command_upiu[ALIGNED_UPIU_SIZE];
501dd11376bSBart Van Assche 	u8 response_upiu[ALIGNED_UPIU_SIZE];
502ada1e653SEric Biggers 	u8 prd_table[];
503dd11376bSBart Van Assche };
504dd11376bSBart Van Assche 
505dd11376bSBart Van Assche /**
506dd11376bSBart Van Assche  * struct request_desc_header - Descriptor Header common to both UTRD and UTMRD
507dd11376bSBart Van Assche  */
508dd11376bSBart Van Assche struct request_desc_header {
50967a2a897SBart Van Assche 	u8 cci;
51067a2a897SBart Van Assche 	u8 ehs_length;
51167a2a897SBart Van Assche #if defined(__BIG_ENDIAN)
51267a2a897SBart Van Assche 	u8 enable_crypto:1;
51367a2a897SBart Van Assche 	u8 reserved2:7;
51467a2a897SBart Van Assche 
51567a2a897SBart Van Assche 	u8 command_type:4;
51667a2a897SBart Van Assche 	u8 reserved1:1;
51767a2a897SBart Van Assche 	u8 data_direction:2;
51867a2a897SBart Van Assche 	u8 interrupt:1;
51967a2a897SBart Van Assche #elif defined(__LITTLE_ENDIAN)
52067a2a897SBart Van Assche 	u8 reserved2:7;
52167a2a897SBart Van Assche 	u8 enable_crypto:1;
52267a2a897SBart Van Assche 
52367a2a897SBart Van Assche 	u8 interrupt:1;
52467a2a897SBart Van Assche 	u8 data_direction:2;
52567a2a897SBart Van Assche 	u8 reserved1:1;
52667a2a897SBart Van Assche 	u8 command_type:4;
52767a2a897SBart Van Assche #else
52867a2a897SBart Van Assche #error
52967a2a897SBart Van Assche #endif
53067a2a897SBart Van Assche 
53167a2a897SBart Van Assche 	__le32 dunl;
53267a2a897SBart Van Assche 	u8 ocs;
53367a2a897SBart Van Assche 	u8 cds;
53467a2a897SBart Van Assche 	__le16 ldbc;
53567a2a897SBart Van Assche 	__le32 dunu;
536dd11376bSBart Van Assche };
537dd11376bSBart Van Assche 
53867a2a897SBart Van Assche static_assert(sizeof(struct request_desc_header) == 16);
53967a2a897SBart Van Assche 
540dd11376bSBart Van Assche /**
541dd11376bSBart Van Assche  * struct utp_transfer_req_desc - UTP Transfer Request Descriptor (UTRD)
542dd11376bSBart Van Assche  * @header: UTRD header DW-0 to DW-3
543a8f9a36eSBao D. Nguyen  * @command_desc_base_addr: UCD base address DW 4-5
544dd11376bSBart Van Assche  * @response_upiu_length: response UPIU length DW-6
545dd11376bSBart Van Assche  * @response_upiu_offset: response UPIU offset DW-6
546dd11376bSBart Van Assche  * @prd_table_length: Physical region descriptor length DW-7
547dd11376bSBart Van Assche  * @prd_table_offset: Physical region descriptor offset DW-7
548dd11376bSBart Van Assche  */
549dd11376bSBart Van Assche struct utp_transfer_req_desc {
550dd11376bSBart Van Assche 
551dd11376bSBart Van Assche 	/* DW 0-3 */
552dd11376bSBart Van Assche 	struct request_desc_header header;
553dd11376bSBart Van Assche 
554dd11376bSBart Van Assche 	/* DW 4-5*/
555a8f9a36eSBao D. Nguyen 	__le64  command_desc_base_addr;
556dd11376bSBart Van Assche 
557dd11376bSBart Van Assche 	/* DW 6 */
558dd11376bSBart Van Assche 	__le16  response_upiu_length;
559dd11376bSBart Van Assche 	__le16  response_upiu_offset;
560dd11376bSBart Van Assche 
561dd11376bSBart Van Assche 	/* DW 7 */
562dd11376bSBart Van Assche 	__le16  prd_table_length;
563dd11376bSBart Van Assche 	__le16  prd_table_offset;
564dd11376bSBart Van Assche };
565dd11376bSBart Van Assche 
5664682abfaSAsutosh Das /* MCQ Completion Queue Entry */
5674682abfaSAsutosh Das struct cq_entry {
5684682abfaSAsutosh Das 	/* DW 0-1 */
5694682abfaSAsutosh Das 	__le64 command_desc_base_addr;
5704682abfaSAsutosh Das 
5714682abfaSAsutosh Das 	/* DW 2 */
5724682abfaSAsutosh Das 	__le16  response_upiu_length;
5734682abfaSAsutosh Das 	__le16  response_upiu_offset;
5744682abfaSAsutosh Das 
5754682abfaSAsutosh Das 	/* DW 3 */
5764682abfaSAsutosh Das 	__le16  prd_table_length;
5774682abfaSAsutosh Das 	__le16  prd_table_offset;
5784682abfaSAsutosh Das 
5794682abfaSAsutosh Das 	/* DW 4 */
5804682abfaSAsutosh Das 	__le32 status;
5814682abfaSAsutosh Das 
5824682abfaSAsutosh Das 	/* DW 5-7 */
5834682abfaSAsutosh Das 	__le32 reserved[3];
5844682abfaSAsutosh Das };
5854682abfaSAsutosh Das 
5864682abfaSAsutosh Das static_assert(sizeof(struct cq_entry) == 32);
5874682abfaSAsutosh Das 
588dd11376bSBart Van Assche /*
589dd11376bSBart Van Assche  * UTMRD structure.
590dd11376bSBart Van Assche  */
591dd11376bSBart Van Assche struct utp_task_req_desc {
592dd11376bSBart Van Assche 	/* DW 0-3 */
593dd11376bSBart Van Assche 	struct request_desc_header header;
594dd11376bSBart Van Assche 
595dd11376bSBart Van Assche 	/* DW 4-11 - Task request UPIU structure */
596dd11376bSBart Van Assche 	struct {
597dd11376bSBart Van Assche 		struct utp_upiu_header	req_header;
598dd11376bSBart Van Assche 		__be32			input_param1;
599dd11376bSBart Van Assche 		__be32			input_param2;
600dd11376bSBart Van Assche 		__be32			input_param3;
601dd11376bSBart Van Assche 		__be32			__reserved1[2];
602dd11376bSBart Van Assche 	} upiu_req;
603dd11376bSBart Van Assche 
604dd11376bSBart Van Assche 	/* DW 12-19 - Task Management Response UPIU structure */
605dd11376bSBart Van Assche 	struct {
606dd11376bSBart Van Assche 		struct utp_upiu_header	rsp_header;
607dd11376bSBart Van Assche 		__be32			output_param1;
608dd11376bSBart Van Assche 		__be32			output_param2;
609dd11376bSBart Van Assche 		__be32			__reserved2[3];
610dd11376bSBart Van Assche 	} upiu_rsp;
611dd11376bSBart Van Assche };
612dd11376bSBart Van Assche 
613dd11376bSBart Van Assche #endif /* End of Header */
614