xref: /OK3568_Linux_fs/kernel/drivers/iommu/arm/arm-smmu/arm-smmu.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * IOMMU API for ARM architected SMMU implementations.
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Copyright (C) 2013 ARM Limited
6*4882a593Smuzhiyun  *
7*4882a593Smuzhiyun  * Author: Will Deacon <will.deacon@arm.com>
8*4882a593Smuzhiyun  */
9*4882a593Smuzhiyun 
10*4882a593Smuzhiyun #ifndef _ARM_SMMU_H
11*4882a593Smuzhiyun #define _ARM_SMMU_H
12*4882a593Smuzhiyun 
13*4882a593Smuzhiyun #include <linux/atomic.h>
14*4882a593Smuzhiyun #include <linux/bitfield.h>
15*4882a593Smuzhiyun #include <linux/bits.h>
16*4882a593Smuzhiyun #include <linux/clk.h>
17*4882a593Smuzhiyun #include <linux/device.h>
18*4882a593Smuzhiyun #include <linux/io-64-nonatomic-hi-lo.h>
19*4882a593Smuzhiyun #include <linux/io-pgtable.h>
20*4882a593Smuzhiyun #include <linux/iommu.h>
21*4882a593Smuzhiyun #include <linux/irqreturn.h>
22*4882a593Smuzhiyun #include <linux/mutex.h>
23*4882a593Smuzhiyun #include <linux/spinlock.h>
24*4882a593Smuzhiyun #include <linux/types.h>
25*4882a593Smuzhiyun 
26*4882a593Smuzhiyun /* Configuration registers */
27*4882a593Smuzhiyun #define ARM_SMMU_GR0_sCR0		0x0
28*4882a593Smuzhiyun #define ARM_SMMU_sCR0_VMID16EN		BIT(31)
29*4882a593Smuzhiyun #define ARM_SMMU_sCR0_BSU		GENMASK(15, 14)
30*4882a593Smuzhiyun #define ARM_SMMU_sCR0_FB		BIT(13)
31*4882a593Smuzhiyun #define ARM_SMMU_sCR0_PTM		BIT(12)
32*4882a593Smuzhiyun #define ARM_SMMU_sCR0_VMIDPNE		BIT(11)
33*4882a593Smuzhiyun #define ARM_SMMU_sCR0_USFCFG		BIT(10)
34*4882a593Smuzhiyun #define ARM_SMMU_sCR0_GCFGFIE		BIT(5)
35*4882a593Smuzhiyun #define ARM_SMMU_sCR0_GCFGFRE		BIT(4)
36*4882a593Smuzhiyun #define ARM_SMMU_sCR0_EXIDENABLE	BIT(3)
37*4882a593Smuzhiyun #define ARM_SMMU_sCR0_GFIE		BIT(2)
38*4882a593Smuzhiyun #define ARM_SMMU_sCR0_GFRE		BIT(1)
39*4882a593Smuzhiyun #define ARM_SMMU_sCR0_CLIENTPD		BIT(0)
40*4882a593Smuzhiyun 
41*4882a593Smuzhiyun /* Auxiliary Configuration register */
42*4882a593Smuzhiyun #define ARM_SMMU_GR0_sACR		0x10
43*4882a593Smuzhiyun 
44*4882a593Smuzhiyun /* Identification registers */
45*4882a593Smuzhiyun #define ARM_SMMU_GR0_ID0		0x20
46*4882a593Smuzhiyun #define ARM_SMMU_ID0_S1TS		BIT(30)
47*4882a593Smuzhiyun #define ARM_SMMU_ID0_S2TS		BIT(29)
48*4882a593Smuzhiyun #define ARM_SMMU_ID0_NTS		BIT(28)
49*4882a593Smuzhiyun #define ARM_SMMU_ID0_SMS		BIT(27)
50*4882a593Smuzhiyun #define ARM_SMMU_ID0_ATOSNS		BIT(26)
51*4882a593Smuzhiyun #define ARM_SMMU_ID0_PTFS_NO_AARCH32	BIT(25)
52*4882a593Smuzhiyun #define ARM_SMMU_ID0_PTFS_NO_AARCH32S	BIT(24)
53*4882a593Smuzhiyun #define ARM_SMMU_ID0_NUMIRPT		GENMASK(23, 16)
54*4882a593Smuzhiyun #define ARM_SMMU_ID0_CTTW		BIT(14)
55*4882a593Smuzhiyun #define ARM_SMMU_ID0_NUMSIDB		GENMASK(12, 9)
56*4882a593Smuzhiyun #define ARM_SMMU_ID0_EXIDS		BIT(8)
57*4882a593Smuzhiyun #define ARM_SMMU_ID0_NUMSMRG		GENMASK(7, 0)
58*4882a593Smuzhiyun 
59*4882a593Smuzhiyun #define ARM_SMMU_GR0_ID1		0x24
60*4882a593Smuzhiyun #define ARM_SMMU_ID1_PAGESIZE		BIT(31)
61*4882a593Smuzhiyun #define ARM_SMMU_ID1_NUMPAGENDXB	GENMASK(30, 28)
62*4882a593Smuzhiyun #define ARM_SMMU_ID1_NUMS2CB		GENMASK(23, 16)
63*4882a593Smuzhiyun #define ARM_SMMU_ID1_NUMCB		GENMASK(7, 0)
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun #define ARM_SMMU_GR0_ID2		0x28
66*4882a593Smuzhiyun #define ARM_SMMU_ID2_VMID16		BIT(15)
67*4882a593Smuzhiyun #define ARM_SMMU_ID2_PTFS_64K		BIT(14)
68*4882a593Smuzhiyun #define ARM_SMMU_ID2_PTFS_16K		BIT(13)
69*4882a593Smuzhiyun #define ARM_SMMU_ID2_PTFS_4K		BIT(12)
70*4882a593Smuzhiyun #define ARM_SMMU_ID2_UBS		GENMASK(11, 8)
71*4882a593Smuzhiyun #define ARM_SMMU_ID2_OAS		GENMASK(7, 4)
72*4882a593Smuzhiyun #define ARM_SMMU_ID2_IAS		GENMASK(3, 0)
73*4882a593Smuzhiyun 
74*4882a593Smuzhiyun #define ARM_SMMU_GR0_ID3		0x2c
75*4882a593Smuzhiyun #define ARM_SMMU_GR0_ID4		0x30
76*4882a593Smuzhiyun #define ARM_SMMU_GR0_ID5		0x34
77*4882a593Smuzhiyun #define ARM_SMMU_GR0_ID6		0x38
78*4882a593Smuzhiyun 
79*4882a593Smuzhiyun #define ARM_SMMU_GR0_ID7		0x3c
80*4882a593Smuzhiyun #define ARM_SMMU_ID7_MAJOR		GENMASK(7, 4)
81*4882a593Smuzhiyun #define ARM_SMMU_ID7_MINOR		GENMASK(3, 0)
82*4882a593Smuzhiyun 
83*4882a593Smuzhiyun #define ARM_SMMU_GR0_sGFSR		0x48
84*4882a593Smuzhiyun #define ARM_SMMU_sGFSR_USF		BIT(1)
85*4882a593Smuzhiyun 
86*4882a593Smuzhiyun #define ARM_SMMU_GR0_sGFSYNR0		0x50
87*4882a593Smuzhiyun #define ARM_SMMU_GR0_sGFSYNR1		0x54
88*4882a593Smuzhiyun #define ARM_SMMU_GR0_sGFSYNR2		0x58
89*4882a593Smuzhiyun 
90*4882a593Smuzhiyun /* Global TLB invalidation */
91*4882a593Smuzhiyun #define ARM_SMMU_GR0_TLBIVMID		0x64
92*4882a593Smuzhiyun #define ARM_SMMU_GR0_TLBIALLNSNH	0x68
93*4882a593Smuzhiyun #define ARM_SMMU_GR0_TLBIALLH		0x6c
94*4882a593Smuzhiyun #define ARM_SMMU_GR0_sTLBGSYNC		0x70
95*4882a593Smuzhiyun 
96*4882a593Smuzhiyun #define ARM_SMMU_GR0_sTLBGSTATUS	0x74
97*4882a593Smuzhiyun #define ARM_SMMU_sTLBGSTATUS_GSACTIVE	BIT(0)
98*4882a593Smuzhiyun 
99*4882a593Smuzhiyun /* Stream mapping registers */
100*4882a593Smuzhiyun #define ARM_SMMU_GR0_SMR(n)		(0x800 + ((n) << 2))
101*4882a593Smuzhiyun #define ARM_SMMU_SMR_VALID		BIT(31)
102*4882a593Smuzhiyun #define ARM_SMMU_SMR_MASK		GENMASK(31, 16)
103*4882a593Smuzhiyun #define ARM_SMMU_SMR_ID			GENMASK(15, 0)
104*4882a593Smuzhiyun 
105*4882a593Smuzhiyun #define ARM_SMMU_GR0_S2CR(n)		(0xc00 + ((n) << 2))
106*4882a593Smuzhiyun #define ARM_SMMU_S2CR_PRIVCFG		GENMASK(25, 24)
107*4882a593Smuzhiyun enum arm_smmu_s2cr_privcfg {
108*4882a593Smuzhiyun 	S2CR_PRIVCFG_DEFAULT,
109*4882a593Smuzhiyun 	S2CR_PRIVCFG_DIPAN,
110*4882a593Smuzhiyun 	S2CR_PRIVCFG_UNPRIV,
111*4882a593Smuzhiyun 	S2CR_PRIVCFG_PRIV,
112*4882a593Smuzhiyun };
113*4882a593Smuzhiyun #define ARM_SMMU_S2CR_TYPE		GENMASK(17, 16)
114*4882a593Smuzhiyun enum arm_smmu_s2cr_type {
115*4882a593Smuzhiyun 	S2CR_TYPE_TRANS,
116*4882a593Smuzhiyun 	S2CR_TYPE_BYPASS,
117*4882a593Smuzhiyun 	S2CR_TYPE_FAULT,
118*4882a593Smuzhiyun };
119*4882a593Smuzhiyun #define ARM_SMMU_S2CR_EXIDVALID		BIT(10)
120*4882a593Smuzhiyun #define ARM_SMMU_S2CR_CBNDX		GENMASK(7, 0)
121*4882a593Smuzhiyun 
122*4882a593Smuzhiyun /* Context bank attribute registers */
123*4882a593Smuzhiyun #define ARM_SMMU_GR1_CBAR(n)		(0x0 + ((n) << 2))
124*4882a593Smuzhiyun #define ARM_SMMU_CBAR_IRPTNDX		GENMASK(31, 24)
125*4882a593Smuzhiyun #define ARM_SMMU_CBAR_TYPE		GENMASK(17, 16)
126*4882a593Smuzhiyun enum arm_smmu_cbar_type {
127*4882a593Smuzhiyun 	CBAR_TYPE_S2_TRANS,
128*4882a593Smuzhiyun 	CBAR_TYPE_S1_TRANS_S2_BYPASS,
129*4882a593Smuzhiyun 	CBAR_TYPE_S1_TRANS_S2_FAULT,
130*4882a593Smuzhiyun 	CBAR_TYPE_S1_TRANS_S2_TRANS,
131*4882a593Smuzhiyun };
132*4882a593Smuzhiyun #define ARM_SMMU_CBAR_S1_MEMATTR	GENMASK(15, 12)
133*4882a593Smuzhiyun #define ARM_SMMU_CBAR_S1_MEMATTR_WB	0xf
134*4882a593Smuzhiyun #define ARM_SMMU_CBAR_S1_BPSHCFG	GENMASK(9, 8)
135*4882a593Smuzhiyun #define ARM_SMMU_CBAR_S1_BPSHCFG_NSH	3
136*4882a593Smuzhiyun #define ARM_SMMU_CBAR_VMID		GENMASK(7, 0)
137*4882a593Smuzhiyun 
138*4882a593Smuzhiyun #define ARM_SMMU_GR1_CBFRSYNRA(n)	(0x400 + ((n) << 2))
139*4882a593Smuzhiyun 
140*4882a593Smuzhiyun #define ARM_SMMU_GR1_CBA2R(n)		(0x800 + ((n) << 2))
141*4882a593Smuzhiyun #define ARM_SMMU_CBA2R_VMID16		GENMASK(31, 16)
142*4882a593Smuzhiyun #define ARM_SMMU_CBA2R_VA64		BIT(0)
143*4882a593Smuzhiyun 
144*4882a593Smuzhiyun #define ARM_SMMU_CB_SCTLR		0x0
145*4882a593Smuzhiyun #define ARM_SMMU_SCTLR_S1_ASIDPNE	BIT(12)
146*4882a593Smuzhiyun #define ARM_SMMU_SCTLR_CFCFG		BIT(7)
147*4882a593Smuzhiyun #define ARM_SMMU_SCTLR_CFIE		BIT(6)
148*4882a593Smuzhiyun #define ARM_SMMU_SCTLR_CFRE		BIT(5)
149*4882a593Smuzhiyun #define ARM_SMMU_SCTLR_E		BIT(4)
150*4882a593Smuzhiyun #define ARM_SMMU_SCTLR_AFE		BIT(2)
151*4882a593Smuzhiyun #define ARM_SMMU_SCTLR_TRE		BIT(1)
152*4882a593Smuzhiyun #define ARM_SMMU_SCTLR_M		BIT(0)
153*4882a593Smuzhiyun 
154*4882a593Smuzhiyun #define ARM_SMMU_CB_ACTLR		0x4
155*4882a593Smuzhiyun 
156*4882a593Smuzhiyun #define ARM_SMMU_CB_RESUME		0x8
157*4882a593Smuzhiyun #define ARM_SMMU_RESUME_TERMINATE	BIT(0)
158*4882a593Smuzhiyun 
159*4882a593Smuzhiyun #define ARM_SMMU_CB_TCR2		0x10
160*4882a593Smuzhiyun #define ARM_SMMU_TCR2_SEP		GENMASK(17, 15)
161*4882a593Smuzhiyun #define ARM_SMMU_TCR2_SEP_UPSTREAM	0x7
162*4882a593Smuzhiyun #define ARM_SMMU_TCR2_AS		BIT(4)
163*4882a593Smuzhiyun #define ARM_SMMU_TCR2_PASIZE		GENMASK(3, 0)
164*4882a593Smuzhiyun 
165*4882a593Smuzhiyun #define ARM_SMMU_CB_TTBR0		0x20
166*4882a593Smuzhiyun #define ARM_SMMU_CB_TTBR1		0x28
167*4882a593Smuzhiyun #define ARM_SMMU_TTBRn_ASID		GENMASK_ULL(63, 48)
168*4882a593Smuzhiyun 
169*4882a593Smuzhiyun #define ARM_SMMU_CB_TCR			0x30
170*4882a593Smuzhiyun #define ARM_SMMU_TCR_EAE		BIT(31)
171*4882a593Smuzhiyun #define ARM_SMMU_TCR_EPD1		BIT(23)
172*4882a593Smuzhiyun #define ARM_SMMU_TCR_A1			BIT(22)
173*4882a593Smuzhiyun #define ARM_SMMU_TCR_TG0		GENMASK(15, 14)
174*4882a593Smuzhiyun #define ARM_SMMU_TCR_SH0		GENMASK(13, 12)
175*4882a593Smuzhiyun #define ARM_SMMU_TCR_ORGN0		GENMASK(11, 10)
176*4882a593Smuzhiyun #define ARM_SMMU_TCR_IRGN0		GENMASK(9, 8)
177*4882a593Smuzhiyun #define ARM_SMMU_TCR_EPD0		BIT(7)
178*4882a593Smuzhiyun #define ARM_SMMU_TCR_T0SZ		GENMASK(5, 0)
179*4882a593Smuzhiyun 
180*4882a593Smuzhiyun #define ARM_SMMU_VTCR_RES1		BIT(31)
181*4882a593Smuzhiyun #define ARM_SMMU_VTCR_PS		GENMASK(18, 16)
182*4882a593Smuzhiyun #define ARM_SMMU_VTCR_TG0		ARM_SMMU_TCR_TG0
183*4882a593Smuzhiyun #define ARM_SMMU_VTCR_SH0		ARM_SMMU_TCR_SH0
184*4882a593Smuzhiyun #define ARM_SMMU_VTCR_ORGN0		ARM_SMMU_TCR_ORGN0
185*4882a593Smuzhiyun #define ARM_SMMU_VTCR_IRGN0		ARM_SMMU_TCR_IRGN0
186*4882a593Smuzhiyun #define ARM_SMMU_VTCR_SL0		GENMASK(7, 6)
187*4882a593Smuzhiyun #define ARM_SMMU_VTCR_T0SZ		ARM_SMMU_TCR_T0SZ
188*4882a593Smuzhiyun 
189*4882a593Smuzhiyun #define ARM_SMMU_CB_CONTEXTIDR		0x34
190*4882a593Smuzhiyun #define ARM_SMMU_CB_S1_MAIR0		0x38
191*4882a593Smuzhiyun #define ARM_SMMU_CB_S1_MAIR1		0x3c
192*4882a593Smuzhiyun 
193*4882a593Smuzhiyun #define ARM_SMMU_CB_PAR			0x50
194*4882a593Smuzhiyun #define ARM_SMMU_CB_PAR_F		BIT(0)
195*4882a593Smuzhiyun 
196*4882a593Smuzhiyun #define ARM_SMMU_CB_FSR			0x58
197*4882a593Smuzhiyun #define ARM_SMMU_FSR_MULTI		BIT(31)
198*4882a593Smuzhiyun #define ARM_SMMU_FSR_SS			BIT(30)
199*4882a593Smuzhiyun #define ARM_SMMU_FSR_UUT		BIT(8)
200*4882a593Smuzhiyun #define ARM_SMMU_FSR_ASF		BIT(7)
201*4882a593Smuzhiyun #define ARM_SMMU_FSR_TLBLKF		BIT(6)
202*4882a593Smuzhiyun #define ARM_SMMU_FSR_TLBMCF		BIT(5)
203*4882a593Smuzhiyun #define ARM_SMMU_FSR_EF			BIT(4)
204*4882a593Smuzhiyun #define ARM_SMMU_FSR_PF			BIT(3)
205*4882a593Smuzhiyun #define ARM_SMMU_FSR_AFF		BIT(2)
206*4882a593Smuzhiyun #define ARM_SMMU_FSR_TF			BIT(1)
207*4882a593Smuzhiyun 
208*4882a593Smuzhiyun #define ARM_SMMU_FSR_IGN		(ARM_SMMU_FSR_AFF |		\
209*4882a593Smuzhiyun 					 ARM_SMMU_FSR_ASF |		\
210*4882a593Smuzhiyun 					 ARM_SMMU_FSR_TLBMCF |		\
211*4882a593Smuzhiyun 					 ARM_SMMU_FSR_TLBLKF)
212*4882a593Smuzhiyun 
213*4882a593Smuzhiyun #define ARM_SMMU_FSR_FAULT		(ARM_SMMU_FSR_MULTI |		\
214*4882a593Smuzhiyun 					 ARM_SMMU_FSR_SS |		\
215*4882a593Smuzhiyun 					 ARM_SMMU_FSR_UUT |		\
216*4882a593Smuzhiyun 					 ARM_SMMU_FSR_EF |		\
217*4882a593Smuzhiyun 					 ARM_SMMU_FSR_PF |		\
218*4882a593Smuzhiyun 					 ARM_SMMU_FSR_TF |		\
219*4882a593Smuzhiyun 					 ARM_SMMU_FSR_IGN)
220*4882a593Smuzhiyun 
221*4882a593Smuzhiyun #define ARM_SMMU_CB_FAR			0x60
222*4882a593Smuzhiyun 
223*4882a593Smuzhiyun #define ARM_SMMU_CB_FSYNR0		0x68
224*4882a593Smuzhiyun #define ARM_SMMU_FSYNR0_WNR		BIT(4)
225*4882a593Smuzhiyun 
226*4882a593Smuzhiyun #define ARM_SMMU_CB_S1_TLBIVA		0x600
227*4882a593Smuzhiyun #define ARM_SMMU_CB_S1_TLBIASID		0x610
228*4882a593Smuzhiyun #define ARM_SMMU_CB_S1_TLBIVAL		0x620
229*4882a593Smuzhiyun #define ARM_SMMU_CB_S2_TLBIIPAS2	0x630
230*4882a593Smuzhiyun #define ARM_SMMU_CB_S2_TLBIIPAS2L	0x638
231*4882a593Smuzhiyun #define ARM_SMMU_CB_TLBSYNC		0x7f0
232*4882a593Smuzhiyun #define ARM_SMMU_CB_TLBSTATUS		0x7f4
233*4882a593Smuzhiyun #define ARM_SMMU_CB_ATS1PR		0x800
234*4882a593Smuzhiyun 
235*4882a593Smuzhiyun #define ARM_SMMU_CB_ATSR		0x8f0
236*4882a593Smuzhiyun #define ARM_SMMU_ATSR_ACTIVE		BIT(0)
237*4882a593Smuzhiyun 
238*4882a593Smuzhiyun 
239*4882a593Smuzhiyun /* Maximum number of context banks per SMMU */
240*4882a593Smuzhiyun #define ARM_SMMU_MAX_CBS		128
241*4882a593Smuzhiyun 
242*4882a593Smuzhiyun #define TLB_LOOP_TIMEOUT		1000000	/* 1s! */
243*4882a593Smuzhiyun #define TLB_SPIN_COUNT			10
244*4882a593Smuzhiyun 
245*4882a593Smuzhiyun /* Shared driver definitions */
246*4882a593Smuzhiyun enum arm_smmu_arch_version {
247*4882a593Smuzhiyun 	ARM_SMMU_V1,
248*4882a593Smuzhiyun 	ARM_SMMU_V1_64K,
249*4882a593Smuzhiyun 	ARM_SMMU_V2,
250*4882a593Smuzhiyun };
251*4882a593Smuzhiyun 
252*4882a593Smuzhiyun enum arm_smmu_implementation {
253*4882a593Smuzhiyun 	GENERIC_SMMU,
254*4882a593Smuzhiyun 	ARM_MMU500,
255*4882a593Smuzhiyun 	CAVIUM_SMMUV2,
256*4882a593Smuzhiyun 	QCOM_SMMUV2,
257*4882a593Smuzhiyun };
258*4882a593Smuzhiyun 
259*4882a593Smuzhiyun struct arm_smmu_s2cr {
260*4882a593Smuzhiyun 	struct iommu_group		*group;
261*4882a593Smuzhiyun 	int				count;
262*4882a593Smuzhiyun 	enum arm_smmu_s2cr_type		type;
263*4882a593Smuzhiyun 	enum arm_smmu_s2cr_privcfg	privcfg;
264*4882a593Smuzhiyun 	u8				cbndx;
265*4882a593Smuzhiyun 	bool				pinned;
266*4882a593Smuzhiyun };
267*4882a593Smuzhiyun 
268*4882a593Smuzhiyun struct arm_smmu_smr {
269*4882a593Smuzhiyun 	u16				mask;
270*4882a593Smuzhiyun 	u16				id;
271*4882a593Smuzhiyun 	bool				valid;
272*4882a593Smuzhiyun };
273*4882a593Smuzhiyun 
274*4882a593Smuzhiyun struct arm_smmu_device {
275*4882a593Smuzhiyun 	struct device			*dev;
276*4882a593Smuzhiyun 
277*4882a593Smuzhiyun 	void __iomem			*base;
278*4882a593Smuzhiyun 	unsigned int			numpage;
279*4882a593Smuzhiyun 	unsigned int			pgshift;
280*4882a593Smuzhiyun 
281*4882a593Smuzhiyun #define ARM_SMMU_FEAT_COHERENT_WALK	(1 << 0)
282*4882a593Smuzhiyun #define ARM_SMMU_FEAT_STREAM_MATCH	(1 << 1)
283*4882a593Smuzhiyun #define ARM_SMMU_FEAT_TRANS_S1		(1 << 2)
284*4882a593Smuzhiyun #define ARM_SMMU_FEAT_TRANS_S2		(1 << 3)
285*4882a593Smuzhiyun #define ARM_SMMU_FEAT_TRANS_NESTED	(1 << 4)
286*4882a593Smuzhiyun #define ARM_SMMU_FEAT_TRANS_OPS		(1 << 5)
287*4882a593Smuzhiyun #define ARM_SMMU_FEAT_VMID16		(1 << 6)
288*4882a593Smuzhiyun #define ARM_SMMU_FEAT_FMT_AARCH64_4K	(1 << 7)
289*4882a593Smuzhiyun #define ARM_SMMU_FEAT_FMT_AARCH64_16K	(1 << 8)
290*4882a593Smuzhiyun #define ARM_SMMU_FEAT_FMT_AARCH64_64K	(1 << 9)
291*4882a593Smuzhiyun #define ARM_SMMU_FEAT_FMT_AARCH32_L	(1 << 10)
292*4882a593Smuzhiyun #define ARM_SMMU_FEAT_FMT_AARCH32_S	(1 << 11)
293*4882a593Smuzhiyun #define ARM_SMMU_FEAT_EXIDS		(1 << 12)
294*4882a593Smuzhiyun 	u32				features;
295*4882a593Smuzhiyun 
296*4882a593Smuzhiyun 	enum arm_smmu_arch_version	version;
297*4882a593Smuzhiyun 	enum arm_smmu_implementation	model;
298*4882a593Smuzhiyun 	const struct arm_smmu_impl	*impl;
299*4882a593Smuzhiyun 
300*4882a593Smuzhiyun 	u32				num_context_banks;
301*4882a593Smuzhiyun 	u32				num_s2_context_banks;
302*4882a593Smuzhiyun 	DECLARE_BITMAP(context_map, ARM_SMMU_MAX_CBS);
303*4882a593Smuzhiyun 	struct arm_smmu_cb		*cbs;
304*4882a593Smuzhiyun 	atomic_t			irptndx;
305*4882a593Smuzhiyun 
306*4882a593Smuzhiyun 	u32				num_mapping_groups;
307*4882a593Smuzhiyun 	u16				streamid_mask;
308*4882a593Smuzhiyun 	u16				smr_mask_mask;
309*4882a593Smuzhiyun 	struct arm_smmu_smr		*smrs;
310*4882a593Smuzhiyun 	struct arm_smmu_s2cr		*s2crs;
311*4882a593Smuzhiyun 	struct mutex			stream_map_mutex;
312*4882a593Smuzhiyun 
313*4882a593Smuzhiyun 	unsigned long			va_size;
314*4882a593Smuzhiyun 	unsigned long			ipa_size;
315*4882a593Smuzhiyun 	unsigned long			pa_size;
316*4882a593Smuzhiyun 	unsigned long			pgsize_bitmap;
317*4882a593Smuzhiyun 
318*4882a593Smuzhiyun 	u32				num_global_irqs;
319*4882a593Smuzhiyun 	u32				num_context_irqs;
320*4882a593Smuzhiyun 	unsigned int			*irqs;
321*4882a593Smuzhiyun 	struct clk_bulk_data		*clks;
322*4882a593Smuzhiyun 	int				num_clks;
323*4882a593Smuzhiyun 
324*4882a593Smuzhiyun 	spinlock_t			global_sync_lock;
325*4882a593Smuzhiyun 
326*4882a593Smuzhiyun 	/* IOMMU core code handle */
327*4882a593Smuzhiyun 	struct iommu_device		iommu;
328*4882a593Smuzhiyun };
329*4882a593Smuzhiyun 
330*4882a593Smuzhiyun enum arm_smmu_context_fmt {
331*4882a593Smuzhiyun 	ARM_SMMU_CTX_FMT_NONE,
332*4882a593Smuzhiyun 	ARM_SMMU_CTX_FMT_AARCH64,
333*4882a593Smuzhiyun 	ARM_SMMU_CTX_FMT_AARCH32_L,
334*4882a593Smuzhiyun 	ARM_SMMU_CTX_FMT_AARCH32_S,
335*4882a593Smuzhiyun };
336*4882a593Smuzhiyun 
337*4882a593Smuzhiyun struct arm_smmu_cfg {
338*4882a593Smuzhiyun 	u8				cbndx;
339*4882a593Smuzhiyun 	u8				irptndx;
340*4882a593Smuzhiyun 	union {
341*4882a593Smuzhiyun 		u16			asid;
342*4882a593Smuzhiyun 		u16			vmid;
343*4882a593Smuzhiyun 	};
344*4882a593Smuzhiyun 	enum arm_smmu_cbar_type		cbar;
345*4882a593Smuzhiyun 	enum arm_smmu_context_fmt	fmt;
346*4882a593Smuzhiyun };
347*4882a593Smuzhiyun #define ARM_SMMU_INVALID_IRPTNDX	0xff
348*4882a593Smuzhiyun 
349*4882a593Smuzhiyun struct arm_smmu_cb {
350*4882a593Smuzhiyun 	u64				ttbr[2];
351*4882a593Smuzhiyun 	u32				tcr[2];
352*4882a593Smuzhiyun 	u32				mair[2];
353*4882a593Smuzhiyun 	struct arm_smmu_cfg		*cfg;
354*4882a593Smuzhiyun };
355*4882a593Smuzhiyun 
356*4882a593Smuzhiyun enum arm_smmu_domain_stage {
357*4882a593Smuzhiyun 	ARM_SMMU_DOMAIN_S1 = 0,
358*4882a593Smuzhiyun 	ARM_SMMU_DOMAIN_S2,
359*4882a593Smuzhiyun 	ARM_SMMU_DOMAIN_NESTED,
360*4882a593Smuzhiyun 	ARM_SMMU_DOMAIN_BYPASS,
361*4882a593Smuzhiyun };
362*4882a593Smuzhiyun 
363*4882a593Smuzhiyun struct arm_smmu_domain {
364*4882a593Smuzhiyun 	struct arm_smmu_device		*smmu;
365*4882a593Smuzhiyun 	struct io_pgtable_ops		*pgtbl_ops;
366*4882a593Smuzhiyun 	const struct iommu_flush_ops	*flush_ops;
367*4882a593Smuzhiyun 	struct arm_smmu_cfg		cfg;
368*4882a593Smuzhiyun 	enum arm_smmu_domain_stage	stage;
369*4882a593Smuzhiyun 	bool				non_strict;
370*4882a593Smuzhiyun 	struct mutex			init_mutex; /* Protects smmu pointer */
371*4882a593Smuzhiyun 	spinlock_t			cb_lock; /* Serialises ATS1* ops and TLB syncs */
372*4882a593Smuzhiyun 	struct iommu_domain		domain;
373*4882a593Smuzhiyun };
374*4882a593Smuzhiyun 
375*4882a593Smuzhiyun struct arm_smmu_master_cfg {
376*4882a593Smuzhiyun 	struct arm_smmu_device		*smmu;
377*4882a593Smuzhiyun 	s16				smendx[];
378*4882a593Smuzhiyun };
379*4882a593Smuzhiyun 
arm_smmu_lpae_tcr(const struct io_pgtable_cfg * cfg)380*4882a593Smuzhiyun static inline u32 arm_smmu_lpae_tcr(const struct io_pgtable_cfg *cfg)
381*4882a593Smuzhiyun {
382*4882a593Smuzhiyun 	u32 tcr = FIELD_PREP(ARM_SMMU_TCR_TG0, cfg->arm_lpae_s1_cfg.tcr.tg) |
383*4882a593Smuzhiyun 		FIELD_PREP(ARM_SMMU_TCR_SH0, cfg->arm_lpae_s1_cfg.tcr.sh) |
384*4882a593Smuzhiyun 		FIELD_PREP(ARM_SMMU_TCR_ORGN0, cfg->arm_lpae_s1_cfg.tcr.orgn) |
385*4882a593Smuzhiyun 		FIELD_PREP(ARM_SMMU_TCR_IRGN0, cfg->arm_lpae_s1_cfg.tcr.irgn) |
386*4882a593Smuzhiyun 		FIELD_PREP(ARM_SMMU_TCR_T0SZ, cfg->arm_lpae_s1_cfg.tcr.tsz);
387*4882a593Smuzhiyun 
388*4882a593Smuzhiyun        /*
389*4882a593Smuzhiyun 	* When TTBR1 is selected shift the TCR fields by 16 bits and disable
390*4882a593Smuzhiyun 	* translation in TTBR0
391*4882a593Smuzhiyun 	*/
392*4882a593Smuzhiyun 	if (cfg->quirks & IO_PGTABLE_QUIRK_ARM_TTBR1) {
393*4882a593Smuzhiyun 		tcr = (tcr << 16) & ~ARM_SMMU_TCR_A1;
394*4882a593Smuzhiyun 		tcr |= ARM_SMMU_TCR_EPD0;
395*4882a593Smuzhiyun 	} else
396*4882a593Smuzhiyun 		tcr |= ARM_SMMU_TCR_EPD1;
397*4882a593Smuzhiyun 
398*4882a593Smuzhiyun 	return tcr;
399*4882a593Smuzhiyun }
400*4882a593Smuzhiyun 
arm_smmu_lpae_tcr2(const struct io_pgtable_cfg * cfg)401*4882a593Smuzhiyun static inline u32 arm_smmu_lpae_tcr2(const struct io_pgtable_cfg *cfg)
402*4882a593Smuzhiyun {
403*4882a593Smuzhiyun 	return FIELD_PREP(ARM_SMMU_TCR2_PASIZE, cfg->arm_lpae_s1_cfg.tcr.ips) |
404*4882a593Smuzhiyun 	       FIELD_PREP(ARM_SMMU_TCR2_SEP, ARM_SMMU_TCR2_SEP_UPSTREAM);
405*4882a593Smuzhiyun }
406*4882a593Smuzhiyun 
arm_smmu_lpae_vtcr(const struct io_pgtable_cfg * cfg)407*4882a593Smuzhiyun static inline u32 arm_smmu_lpae_vtcr(const struct io_pgtable_cfg *cfg)
408*4882a593Smuzhiyun {
409*4882a593Smuzhiyun 	return ARM_SMMU_VTCR_RES1 |
410*4882a593Smuzhiyun 	       FIELD_PREP(ARM_SMMU_VTCR_PS, cfg->arm_lpae_s2_cfg.vtcr.ps) |
411*4882a593Smuzhiyun 	       FIELD_PREP(ARM_SMMU_VTCR_TG0, cfg->arm_lpae_s2_cfg.vtcr.tg) |
412*4882a593Smuzhiyun 	       FIELD_PREP(ARM_SMMU_VTCR_SH0, cfg->arm_lpae_s2_cfg.vtcr.sh) |
413*4882a593Smuzhiyun 	       FIELD_PREP(ARM_SMMU_VTCR_ORGN0, cfg->arm_lpae_s2_cfg.vtcr.orgn) |
414*4882a593Smuzhiyun 	       FIELD_PREP(ARM_SMMU_VTCR_IRGN0, cfg->arm_lpae_s2_cfg.vtcr.irgn) |
415*4882a593Smuzhiyun 	       FIELD_PREP(ARM_SMMU_VTCR_SL0, cfg->arm_lpae_s2_cfg.vtcr.sl) |
416*4882a593Smuzhiyun 	       FIELD_PREP(ARM_SMMU_VTCR_T0SZ, cfg->arm_lpae_s2_cfg.vtcr.tsz);
417*4882a593Smuzhiyun }
418*4882a593Smuzhiyun 
419*4882a593Smuzhiyun /* Implementation details, yay! */
420*4882a593Smuzhiyun struct arm_smmu_impl {
421*4882a593Smuzhiyun 	u32 (*read_reg)(struct arm_smmu_device *smmu, int page, int offset);
422*4882a593Smuzhiyun 	void (*write_reg)(struct arm_smmu_device *smmu, int page, int offset,
423*4882a593Smuzhiyun 			  u32 val);
424*4882a593Smuzhiyun 	u64 (*read_reg64)(struct arm_smmu_device *smmu, int page, int offset);
425*4882a593Smuzhiyun 	void (*write_reg64)(struct arm_smmu_device *smmu, int page, int offset,
426*4882a593Smuzhiyun 			    u64 val);
427*4882a593Smuzhiyun 	int (*cfg_probe)(struct arm_smmu_device *smmu);
428*4882a593Smuzhiyun 	int (*reset)(struct arm_smmu_device *smmu);
429*4882a593Smuzhiyun 	int (*init_context)(struct arm_smmu_domain *smmu_domain,
430*4882a593Smuzhiyun 			struct io_pgtable_cfg *cfg, struct device *dev);
431*4882a593Smuzhiyun 	void (*tlb_sync)(struct arm_smmu_device *smmu, int page, int sync,
432*4882a593Smuzhiyun 			 int status);
433*4882a593Smuzhiyun 	int (*def_domain_type)(struct device *dev);
434*4882a593Smuzhiyun 	irqreturn_t (*global_fault)(int irq, void *dev);
435*4882a593Smuzhiyun 	irqreturn_t (*context_fault)(int irq, void *dev);
436*4882a593Smuzhiyun 	int (*alloc_context_bank)(struct arm_smmu_domain *smmu_domain,
437*4882a593Smuzhiyun 				  struct arm_smmu_device *smmu,
438*4882a593Smuzhiyun 				  struct device *dev, int start);
439*4882a593Smuzhiyun 	void (*write_s2cr)(struct arm_smmu_device *smmu, int idx);
440*4882a593Smuzhiyun };
441*4882a593Smuzhiyun 
442*4882a593Smuzhiyun #define INVALID_SMENDX			-1
443*4882a593Smuzhiyun #define cfg_smendx(cfg, fw, i) \
444*4882a593Smuzhiyun 	(i >= fw->num_ids ? INVALID_SMENDX : cfg->smendx[i])
445*4882a593Smuzhiyun #define for_each_cfg_sme(cfg, fw, i, idx) \
446*4882a593Smuzhiyun 	for (i = 0; idx = cfg_smendx(cfg, fw, i), i < fw->num_ids; ++i)
447*4882a593Smuzhiyun 
__arm_smmu_alloc_bitmap(unsigned long * map,int start,int end)448*4882a593Smuzhiyun static inline int __arm_smmu_alloc_bitmap(unsigned long *map, int start, int end)
449*4882a593Smuzhiyun {
450*4882a593Smuzhiyun 	int idx;
451*4882a593Smuzhiyun 
452*4882a593Smuzhiyun 	do {
453*4882a593Smuzhiyun 		idx = find_next_zero_bit(map, end, start);
454*4882a593Smuzhiyun 		if (idx == end)
455*4882a593Smuzhiyun 			return -ENOSPC;
456*4882a593Smuzhiyun 	} while (test_and_set_bit(idx, map));
457*4882a593Smuzhiyun 
458*4882a593Smuzhiyun 	return idx;
459*4882a593Smuzhiyun }
460*4882a593Smuzhiyun 
arm_smmu_page(struct arm_smmu_device * smmu,int n)461*4882a593Smuzhiyun static inline void __iomem *arm_smmu_page(struct arm_smmu_device *smmu, int n)
462*4882a593Smuzhiyun {
463*4882a593Smuzhiyun 	return smmu->base + (n << smmu->pgshift);
464*4882a593Smuzhiyun }
465*4882a593Smuzhiyun 
arm_smmu_readl(struct arm_smmu_device * smmu,int page,int offset)466*4882a593Smuzhiyun static inline u32 arm_smmu_readl(struct arm_smmu_device *smmu, int page, int offset)
467*4882a593Smuzhiyun {
468*4882a593Smuzhiyun 	if (smmu->impl && unlikely(smmu->impl->read_reg))
469*4882a593Smuzhiyun 		return smmu->impl->read_reg(smmu, page, offset);
470*4882a593Smuzhiyun 	return readl_relaxed(arm_smmu_page(smmu, page) + offset);
471*4882a593Smuzhiyun }
472*4882a593Smuzhiyun 
arm_smmu_writel(struct arm_smmu_device * smmu,int page,int offset,u32 val)473*4882a593Smuzhiyun static inline void arm_smmu_writel(struct arm_smmu_device *smmu, int page,
474*4882a593Smuzhiyun 				   int offset, u32 val)
475*4882a593Smuzhiyun {
476*4882a593Smuzhiyun 	if (smmu->impl && unlikely(smmu->impl->write_reg))
477*4882a593Smuzhiyun 		smmu->impl->write_reg(smmu, page, offset, val);
478*4882a593Smuzhiyun 	else
479*4882a593Smuzhiyun 		writel_relaxed(val, arm_smmu_page(smmu, page) + offset);
480*4882a593Smuzhiyun }
481*4882a593Smuzhiyun 
arm_smmu_readq(struct arm_smmu_device * smmu,int page,int offset)482*4882a593Smuzhiyun static inline u64 arm_smmu_readq(struct arm_smmu_device *smmu, int page, int offset)
483*4882a593Smuzhiyun {
484*4882a593Smuzhiyun 	if (smmu->impl && unlikely(smmu->impl->read_reg64))
485*4882a593Smuzhiyun 		return smmu->impl->read_reg64(smmu, page, offset);
486*4882a593Smuzhiyun 	return readq_relaxed(arm_smmu_page(smmu, page) + offset);
487*4882a593Smuzhiyun }
488*4882a593Smuzhiyun 
arm_smmu_writeq(struct arm_smmu_device * smmu,int page,int offset,u64 val)489*4882a593Smuzhiyun static inline void arm_smmu_writeq(struct arm_smmu_device *smmu, int page,
490*4882a593Smuzhiyun 				   int offset, u64 val)
491*4882a593Smuzhiyun {
492*4882a593Smuzhiyun 	if (smmu->impl && unlikely(smmu->impl->write_reg64))
493*4882a593Smuzhiyun 		smmu->impl->write_reg64(smmu, page, offset, val);
494*4882a593Smuzhiyun 	else
495*4882a593Smuzhiyun 		writeq_relaxed(val, arm_smmu_page(smmu, page) + offset);
496*4882a593Smuzhiyun }
497*4882a593Smuzhiyun 
498*4882a593Smuzhiyun #define ARM_SMMU_GR0		0
499*4882a593Smuzhiyun #define ARM_SMMU_GR1		1
500*4882a593Smuzhiyun #define ARM_SMMU_CB(s, n)	((s)->numpage + (n))
501*4882a593Smuzhiyun 
502*4882a593Smuzhiyun #define arm_smmu_gr0_read(s, o)		\
503*4882a593Smuzhiyun 	arm_smmu_readl((s), ARM_SMMU_GR0, (o))
504*4882a593Smuzhiyun #define arm_smmu_gr0_write(s, o, v)	\
505*4882a593Smuzhiyun 	arm_smmu_writel((s), ARM_SMMU_GR0, (o), (v))
506*4882a593Smuzhiyun 
507*4882a593Smuzhiyun #define arm_smmu_gr1_read(s, o)		\
508*4882a593Smuzhiyun 	arm_smmu_readl((s), ARM_SMMU_GR1, (o))
509*4882a593Smuzhiyun #define arm_smmu_gr1_write(s, o, v)	\
510*4882a593Smuzhiyun 	arm_smmu_writel((s), ARM_SMMU_GR1, (o), (v))
511*4882a593Smuzhiyun 
512*4882a593Smuzhiyun #define arm_smmu_cb_read(s, n, o)	\
513*4882a593Smuzhiyun 	arm_smmu_readl((s), ARM_SMMU_CB((s), (n)), (o))
514*4882a593Smuzhiyun #define arm_smmu_cb_write(s, n, o, v)	\
515*4882a593Smuzhiyun 	arm_smmu_writel((s), ARM_SMMU_CB((s), (n)), (o), (v))
516*4882a593Smuzhiyun #define arm_smmu_cb_readq(s, n, o)	\
517*4882a593Smuzhiyun 	arm_smmu_readq((s), ARM_SMMU_CB((s), (n)), (o))
518*4882a593Smuzhiyun #define arm_smmu_cb_writeq(s, n, o, v)	\
519*4882a593Smuzhiyun 	arm_smmu_writeq((s), ARM_SMMU_CB((s), (n)), (o), (v))
520*4882a593Smuzhiyun 
521*4882a593Smuzhiyun struct arm_smmu_device *arm_smmu_impl_init(struct arm_smmu_device *smmu);
522*4882a593Smuzhiyun struct arm_smmu_device *nvidia_smmu_impl_init(struct arm_smmu_device *smmu);
523*4882a593Smuzhiyun struct arm_smmu_device *qcom_smmu_impl_init(struct arm_smmu_device *smmu);
524*4882a593Smuzhiyun struct arm_smmu_device *qcom_adreno_smmu_impl_init(struct arm_smmu_device *smmu);
525*4882a593Smuzhiyun 
526*4882a593Smuzhiyun void arm_smmu_write_context_bank(struct arm_smmu_device *smmu, int idx);
527*4882a593Smuzhiyun int arm_mmu500_reset(struct arm_smmu_device *smmu);
528*4882a593Smuzhiyun 
529*4882a593Smuzhiyun #endif /* _ARM_SMMU_H */
530