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