1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * IOMMU API for ARM architected SMMU implementations.
5 * Copyright (C) 2013 ARM Limited
7 * Author: Will Deacon <will.deacon@arm.com>
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/mutex.h>
22 #include <linux/spinlock.h>
23 #include <linux/types.h>
25 /* Configuration registers */
26 #define ARM_SMMU_GR0_sCR0 0x0
27 #define ARM_SMMU_sCR0_VMID16EN BIT(31)
28 #define ARM_SMMU_sCR0_BSU GENMASK(15, 14)
29 #define ARM_SMMU_sCR0_FB BIT(13)
30 #define ARM_SMMU_sCR0_PTM BIT(12)
31 #define ARM_SMMU_sCR0_VMIDPNE BIT(11)
32 #define ARM_SMMU_sCR0_USFCFG BIT(10)
33 #define ARM_SMMU_sCR0_GCFGFIE BIT(5)
34 #define ARM_SMMU_sCR0_GCFGFRE BIT(4)
35 #define ARM_SMMU_sCR0_EXIDENABLE BIT(3)
36 #define ARM_SMMU_sCR0_GFIE BIT(2)
37 #define ARM_SMMU_sCR0_GFRE BIT(1)
38 #define ARM_SMMU_sCR0_CLIENTPD BIT(0)
40 /* Auxiliary Configuration register */
41 #define ARM_SMMU_GR0_sACR 0x10
43 /* Identification registers */
44 #define ARM_SMMU_GR0_ID0 0x20
45 #define ARM_SMMU_ID0_S1TS BIT(30)
46 #define ARM_SMMU_ID0_S2TS BIT(29)
47 #define ARM_SMMU_ID0_NTS BIT(28)
48 #define ARM_SMMU_ID0_SMS BIT(27)
49 #define ARM_SMMU_ID0_ATOSNS BIT(26)
50 #define ARM_SMMU_ID0_PTFS_NO_AARCH32 BIT(25)
51 #define ARM_SMMU_ID0_PTFS_NO_AARCH32S BIT(24)
52 #define ARM_SMMU_ID0_NUMIRPT GENMASK(23, 16)
53 #define ARM_SMMU_ID0_CTTW BIT(14)
54 #define ARM_SMMU_ID0_NUMSIDB GENMASK(12, 9)
55 #define ARM_SMMU_ID0_EXIDS BIT(8)
56 #define ARM_SMMU_ID0_NUMSMRG GENMASK(7, 0)
58 #define ARM_SMMU_GR0_ID1 0x24
59 #define ARM_SMMU_ID1_PAGESIZE BIT(31)
60 #define ARM_SMMU_ID1_NUMPAGENDXB GENMASK(30, 28)
61 #define ARM_SMMU_ID1_NUMS2CB GENMASK(23, 16)
62 #define ARM_SMMU_ID1_NUMCB GENMASK(7, 0)
64 #define ARM_SMMU_GR0_ID2 0x28
65 #define ARM_SMMU_ID2_VMID16 BIT(15)
66 #define ARM_SMMU_ID2_PTFS_64K BIT(14)
67 #define ARM_SMMU_ID2_PTFS_16K BIT(13)
68 #define ARM_SMMU_ID2_PTFS_4K BIT(12)
69 #define ARM_SMMU_ID2_UBS GENMASK(11, 8)
70 #define ARM_SMMU_ID2_OAS GENMASK(7, 4)
71 #define ARM_SMMU_ID2_IAS GENMASK(3, 0)
73 #define ARM_SMMU_GR0_ID3 0x2c
74 #define ARM_SMMU_GR0_ID4 0x30
75 #define ARM_SMMU_GR0_ID5 0x34
76 #define ARM_SMMU_GR0_ID6 0x38
78 #define ARM_SMMU_GR0_ID7 0x3c
79 #define ARM_SMMU_ID7_MAJOR GENMASK(7, 4)
80 #define ARM_SMMU_ID7_MINOR GENMASK(3, 0)
82 #define ARM_SMMU_GR0_sGFSR 0x48
83 #define ARM_SMMU_sGFSR_USF BIT(1)
85 #define ARM_SMMU_GR0_sGFSYNR0 0x50
86 #define ARM_SMMU_GR0_sGFSYNR1 0x54
87 #define ARM_SMMU_GR0_sGFSYNR2 0x58
89 /* Global TLB invalidation */
90 #define ARM_SMMU_GR0_TLBIVMID 0x64
91 #define ARM_SMMU_GR0_TLBIALLNSNH 0x68
92 #define ARM_SMMU_GR0_TLBIALLH 0x6c
93 #define ARM_SMMU_GR0_sTLBGSYNC 0x70
95 #define ARM_SMMU_GR0_sTLBGSTATUS 0x74
96 #define ARM_SMMU_sTLBGSTATUS_GSACTIVE BIT(0)
98 /* Stream mapping registers */
99 #define ARM_SMMU_GR0_SMR(n) (0x800 + ((n) << 2))
100 #define ARM_SMMU_SMR_VALID BIT(31)
101 #define ARM_SMMU_SMR_MASK GENMASK(31, 16)
102 #define ARM_SMMU_SMR_ID GENMASK(15, 0)
104 #define ARM_SMMU_GR0_S2CR(n) (0xc00 + ((n) << 2))
105 #define ARM_SMMU_S2CR_PRIVCFG GENMASK(25, 24)
106 enum arm_smmu_s2cr_privcfg
{
107 S2CR_PRIVCFG_DEFAULT
,
112 #define ARM_SMMU_S2CR_TYPE GENMASK(17, 16)
113 enum arm_smmu_s2cr_type
{
118 #define ARM_SMMU_S2CR_EXIDVALID BIT(10)
119 #define ARM_SMMU_S2CR_CBNDX GENMASK(7, 0)
121 /* Context bank attribute registers */
122 #define ARM_SMMU_GR1_CBAR(n) (0x0 + ((n) << 2))
123 #define ARM_SMMU_CBAR_IRPTNDX GENMASK(31, 24)
124 #define ARM_SMMU_CBAR_TYPE GENMASK(17, 16)
125 enum arm_smmu_cbar_type
{
127 CBAR_TYPE_S1_TRANS_S2_BYPASS
,
128 CBAR_TYPE_S1_TRANS_S2_FAULT
,
129 CBAR_TYPE_S1_TRANS_S2_TRANS
,
131 #define ARM_SMMU_CBAR_S1_MEMATTR GENMASK(15, 12)
132 #define ARM_SMMU_CBAR_S1_MEMATTR_WB 0xf
133 #define ARM_SMMU_CBAR_S1_BPSHCFG GENMASK(9, 8)
134 #define ARM_SMMU_CBAR_S1_BPSHCFG_NSH 3
135 #define ARM_SMMU_CBAR_VMID GENMASK(7, 0)
137 #define ARM_SMMU_GR1_CBFRSYNRA(n) (0x400 + ((n) << 2))
139 #define ARM_SMMU_GR1_CBA2R(n) (0x800 + ((n) << 2))
140 #define ARM_SMMU_CBA2R_VMID16 GENMASK(31, 16)
141 #define ARM_SMMU_CBA2R_VA64 BIT(0)
143 #define ARM_SMMU_CB_SCTLR 0x0
144 #define ARM_SMMU_SCTLR_S1_ASIDPNE BIT(12)
145 #define ARM_SMMU_SCTLR_CFCFG BIT(7)
146 #define ARM_SMMU_SCTLR_CFIE BIT(6)
147 #define ARM_SMMU_SCTLR_CFRE BIT(5)
148 #define ARM_SMMU_SCTLR_E BIT(4)
149 #define ARM_SMMU_SCTLR_AFE BIT(2)
150 #define ARM_SMMU_SCTLR_TRE BIT(1)
151 #define ARM_SMMU_SCTLR_M BIT(0)
153 #define ARM_SMMU_CB_ACTLR 0x4
155 #define ARM_SMMU_CB_RESUME 0x8
156 #define ARM_SMMU_RESUME_TERMINATE BIT(0)
158 #define ARM_SMMU_CB_TCR2 0x10
159 #define ARM_SMMU_TCR2_SEP GENMASK(17, 15)
160 #define ARM_SMMU_TCR2_SEP_UPSTREAM 0x7
161 #define ARM_SMMU_TCR2_AS BIT(4)
162 #define ARM_SMMU_TCR2_PASIZE GENMASK(3, 0)
164 #define ARM_SMMU_CB_TTBR0 0x20
165 #define ARM_SMMU_CB_TTBR1 0x28
166 #define ARM_SMMU_TTBRn_ASID GENMASK_ULL(63, 48)
168 #define ARM_SMMU_CB_TCR 0x30
169 #define ARM_SMMU_TCR_EAE BIT(31)
170 #define ARM_SMMU_TCR_EPD1 BIT(23)
171 #define ARM_SMMU_TCR_TG0 GENMASK(15, 14)
172 #define ARM_SMMU_TCR_SH0 GENMASK(13, 12)
173 #define ARM_SMMU_TCR_ORGN0 GENMASK(11, 10)
174 #define ARM_SMMU_TCR_IRGN0 GENMASK(9, 8)
175 #define ARM_SMMU_TCR_T0SZ GENMASK(5, 0)
177 #define ARM_SMMU_VTCR_RES1 BIT(31)
178 #define ARM_SMMU_VTCR_PS GENMASK(18, 16)
179 #define ARM_SMMU_VTCR_TG0 ARM_SMMU_TCR_TG0
180 #define ARM_SMMU_VTCR_SH0 ARM_SMMU_TCR_SH0
181 #define ARM_SMMU_VTCR_ORGN0 ARM_SMMU_TCR_ORGN0
182 #define ARM_SMMU_VTCR_IRGN0 ARM_SMMU_TCR_IRGN0
183 #define ARM_SMMU_VTCR_SL0 GENMASK(7, 6)
184 #define ARM_SMMU_VTCR_T0SZ ARM_SMMU_TCR_T0SZ
186 #define ARM_SMMU_CB_CONTEXTIDR 0x34
187 #define ARM_SMMU_CB_S1_MAIR0 0x38
188 #define ARM_SMMU_CB_S1_MAIR1 0x3c
190 #define ARM_SMMU_CB_PAR 0x50
191 #define ARM_SMMU_CB_PAR_F BIT(0)
193 #define ARM_SMMU_CB_FSR 0x58
194 #define ARM_SMMU_FSR_MULTI BIT(31)
195 #define ARM_SMMU_FSR_SS BIT(30)
196 #define ARM_SMMU_FSR_UUT BIT(8)
197 #define ARM_SMMU_FSR_ASF BIT(7)
198 #define ARM_SMMU_FSR_TLBLKF BIT(6)
199 #define ARM_SMMU_FSR_TLBMCF BIT(5)
200 #define ARM_SMMU_FSR_EF BIT(4)
201 #define ARM_SMMU_FSR_PF BIT(3)
202 #define ARM_SMMU_FSR_AFF BIT(2)
203 #define ARM_SMMU_FSR_TF BIT(1)
205 #define ARM_SMMU_FSR_IGN (ARM_SMMU_FSR_AFF | \
207 ARM_SMMU_FSR_TLBMCF | \
210 #define ARM_SMMU_FSR_FAULT (ARM_SMMU_FSR_MULTI | \
218 #define ARM_SMMU_CB_FAR 0x60
220 #define ARM_SMMU_CB_FSYNR0 0x68
221 #define ARM_SMMU_FSYNR0_WNR BIT(4)
223 #define ARM_SMMU_CB_S1_TLBIVA 0x600
224 #define ARM_SMMU_CB_S1_TLBIASID 0x610
225 #define ARM_SMMU_CB_S1_TLBIVAL 0x620
226 #define ARM_SMMU_CB_S2_TLBIIPAS2 0x630
227 #define ARM_SMMU_CB_S2_TLBIIPAS2L 0x638
228 #define ARM_SMMU_CB_TLBSYNC 0x7f0
229 #define ARM_SMMU_CB_TLBSTATUS 0x7f4
230 #define ARM_SMMU_CB_ATS1PR 0x800
232 #define ARM_SMMU_CB_ATSR 0x8f0
233 #define ARM_SMMU_ATSR_ACTIVE BIT(0)
236 /* Maximum number of context banks per SMMU */
237 #define ARM_SMMU_MAX_CBS 128
240 /* Shared driver definitions */
241 enum arm_smmu_arch_version
{
247 enum arm_smmu_implementation
{
254 struct arm_smmu_device
{
258 unsigned int numpage
;
259 unsigned int pgshift
;
261 #define ARM_SMMU_FEAT_COHERENT_WALK (1 << 0)
262 #define ARM_SMMU_FEAT_STREAM_MATCH (1 << 1)
263 #define ARM_SMMU_FEAT_TRANS_S1 (1 << 2)
264 #define ARM_SMMU_FEAT_TRANS_S2 (1 << 3)
265 #define ARM_SMMU_FEAT_TRANS_NESTED (1 << 4)
266 #define ARM_SMMU_FEAT_TRANS_OPS (1 << 5)
267 #define ARM_SMMU_FEAT_VMID16 (1 << 6)
268 #define ARM_SMMU_FEAT_FMT_AARCH64_4K (1 << 7)
269 #define ARM_SMMU_FEAT_FMT_AARCH64_16K (1 << 8)
270 #define ARM_SMMU_FEAT_FMT_AARCH64_64K (1 << 9)
271 #define ARM_SMMU_FEAT_FMT_AARCH32_L (1 << 10)
272 #define ARM_SMMU_FEAT_FMT_AARCH32_S (1 << 11)
273 #define ARM_SMMU_FEAT_EXIDS (1 << 12)
276 enum arm_smmu_arch_version version
;
277 enum arm_smmu_implementation model
;
278 const struct arm_smmu_impl
*impl
;
280 u32 num_context_banks
;
281 u32 num_s2_context_banks
;
282 DECLARE_BITMAP(context_map
, ARM_SMMU_MAX_CBS
);
283 struct arm_smmu_cb
*cbs
;
286 u32 num_mapping_groups
;
289 struct arm_smmu_smr
*smrs
;
290 struct arm_smmu_s2cr
*s2crs
;
291 struct mutex stream_map_mutex
;
293 unsigned long va_size
;
294 unsigned long ipa_size
;
295 unsigned long pa_size
;
296 unsigned long pgsize_bitmap
;
299 u32 num_context_irqs
;
301 struct clk_bulk_data
*clks
;
304 spinlock_t global_sync_lock
;
306 /* IOMMU core code handle */
307 struct iommu_device iommu
;
310 enum arm_smmu_context_fmt
{
311 ARM_SMMU_CTX_FMT_NONE
,
312 ARM_SMMU_CTX_FMT_AARCH64
,
313 ARM_SMMU_CTX_FMT_AARCH32_L
,
314 ARM_SMMU_CTX_FMT_AARCH32_S
,
317 struct arm_smmu_cfg
{
324 enum arm_smmu_cbar_type cbar
;
325 enum arm_smmu_context_fmt fmt
;
327 #define ARM_SMMU_INVALID_IRPTNDX 0xff
329 enum arm_smmu_domain_stage
{
330 ARM_SMMU_DOMAIN_S1
= 0,
332 ARM_SMMU_DOMAIN_NESTED
,
333 ARM_SMMU_DOMAIN_BYPASS
,
336 struct arm_smmu_domain
{
337 struct arm_smmu_device
*smmu
;
338 struct io_pgtable_ops
*pgtbl_ops
;
339 const struct iommu_flush_ops
*flush_ops
;
340 struct arm_smmu_cfg cfg
;
341 enum arm_smmu_domain_stage stage
;
343 struct mutex init_mutex
; /* Protects smmu pointer */
344 spinlock_t cb_lock
; /* Serialises ATS1* ops and TLB syncs */
345 struct iommu_domain domain
;
348 static inline u32
arm_smmu_lpae_tcr(struct io_pgtable_cfg
*cfg
)
350 return ARM_SMMU_TCR_EPD1
|
351 FIELD_PREP(ARM_SMMU_TCR_TG0
, cfg
->arm_lpae_s1_cfg
.tcr
.tg
) |
352 FIELD_PREP(ARM_SMMU_TCR_SH0
, cfg
->arm_lpae_s1_cfg
.tcr
.sh
) |
353 FIELD_PREP(ARM_SMMU_TCR_ORGN0
, cfg
->arm_lpae_s1_cfg
.tcr
.orgn
) |
354 FIELD_PREP(ARM_SMMU_TCR_IRGN0
, cfg
->arm_lpae_s1_cfg
.tcr
.irgn
) |
355 FIELD_PREP(ARM_SMMU_TCR_T0SZ
, cfg
->arm_lpae_s1_cfg
.tcr
.tsz
);
358 static inline u32
arm_smmu_lpae_tcr2(struct io_pgtable_cfg
*cfg
)
360 return FIELD_PREP(ARM_SMMU_TCR2_PASIZE
, cfg
->arm_lpae_s1_cfg
.tcr
.ips
) |
361 FIELD_PREP(ARM_SMMU_TCR2_SEP
, ARM_SMMU_TCR2_SEP_UPSTREAM
);
364 static inline u32
arm_smmu_lpae_vtcr(struct io_pgtable_cfg
*cfg
)
366 return ARM_SMMU_VTCR_RES1
|
367 FIELD_PREP(ARM_SMMU_VTCR_PS
, cfg
->arm_lpae_s2_cfg
.vtcr
.ps
) |
368 FIELD_PREP(ARM_SMMU_VTCR_TG0
, cfg
->arm_lpae_s2_cfg
.vtcr
.tg
) |
369 FIELD_PREP(ARM_SMMU_VTCR_SH0
, cfg
->arm_lpae_s2_cfg
.vtcr
.sh
) |
370 FIELD_PREP(ARM_SMMU_VTCR_ORGN0
, cfg
->arm_lpae_s2_cfg
.vtcr
.orgn
) |
371 FIELD_PREP(ARM_SMMU_VTCR_IRGN0
, cfg
->arm_lpae_s2_cfg
.vtcr
.irgn
) |
372 FIELD_PREP(ARM_SMMU_VTCR_SL0
, cfg
->arm_lpae_s2_cfg
.vtcr
.sl
) |
373 FIELD_PREP(ARM_SMMU_VTCR_T0SZ
, cfg
->arm_lpae_s2_cfg
.vtcr
.tsz
);
376 /* Implementation details, yay! */
377 struct arm_smmu_impl
{
378 u32 (*read_reg
)(struct arm_smmu_device
*smmu
, int page
, int offset
);
379 void (*write_reg
)(struct arm_smmu_device
*smmu
, int page
, int offset
,
381 u64 (*read_reg64
)(struct arm_smmu_device
*smmu
, int page
, int offset
);
382 void (*write_reg64
)(struct arm_smmu_device
*smmu
, int page
, int offset
,
384 int (*cfg_probe
)(struct arm_smmu_device
*smmu
);
385 int (*reset
)(struct arm_smmu_device
*smmu
);
386 int (*init_context
)(struct arm_smmu_domain
*smmu_domain
);
387 void (*tlb_sync
)(struct arm_smmu_device
*smmu
, int page
, int sync
,
391 static inline void __iomem
*arm_smmu_page(struct arm_smmu_device
*smmu
, int n
)
393 return smmu
->base
+ (n
<< smmu
->pgshift
);
396 static inline u32
arm_smmu_readl(struct arm_smmu_device
*smmu
, int page
, int offset
)
398 if (smmu
->impl
&& unlikely(smmu
->impl
->read_reg
))
399 return smmu
->impl
->read_reg(smmu
, page
, offset
);
400 return readl_relaxed(arm_smmu_page(smmu
, page
) + offset
);
403 static inline void arm_smmu_writel(struct arm_smmu_device
*smmu
, int page
,
406 if (smmu
->impl
&& unlikely(smmu
->impl
->write_reg
))
407 smmu
->impl
->write_reg(smmu
, page
, offset
, val
);
409 writel_relaxed(val
, arm_smmu_page(smmu
, page
) + offset
);
412 static inline u64
arm_smmu_readq(struct arm_smmu_device
*smmu
, int page
, int offset
)
414 if (smmu
->impl
&& unlikely(smmu
->impl
->read_reg64
))
415 return smmu
->impl
->read_reg64(smmu
, page
, offset
);
416 return readq_relaxed(arm_smmu_page(smmu
, page
) + offset
);
419 static inline void arm_smmu_writeq(struct arm_smmu_device
*smmu
, int page
,
422 if (smmu
->impl
&& unlikely(smmu
->impl
->write_reg64
))
423 smmu
->impl
->write_reg64(smmu
, page
, offset
, val
);
425 writeq_relaxed(val
, arm_smmu_page(smmu
, page
) + offset
);
428 #define ARM_SMMU_GR0 0
429 #define ARM_SMMU_GR1 1
430 #define ARM_SMMU_CB(s, n) ((s)->numpage + (n))
432 #define arm_smmu_gr0_read(s, o) \
433 arm_smmu_readl((s), ARM_SMMU_GR0, (o))
434 #define arm_smmu_gr0_write(s, o, v) \
435 arm_smmu_writel((s), ARM_SMMU_GR0, (o), (v))
437 #define arm_smmu_gr1_read(s, o) \
438 arm_smmu_readl((s), ARM_SMMU_GR1, (o))
439 #define arm_smmu_gr1_write(s, o, v) \
440 arm_smmu_writel((s), ARM_SMMU_GR1, (o), (v))
442 #define arm_smmu_cb_read(s, n, o) \
443 arm_smmu_readl((s), ARM_SMMU_CB((s), (n)), (o))
444 #define arm_smmu_cb_write(s, n, o, v) \
445 arm_smmu_writel((s), ARM_SMMU_CB((s), (n)), (o), (v))
446 #define arm_smmu_cb_readq(s, n, o) \
447 arm_smmu_readq((s), ARM_SMMU_CB((s), (n)), (o))
448 #define arm_smmu_cb_writeq(s, n, o, v) \
449 arm_smmu_writeq((s), ARM_SMMU_CB((s), (n)), (o), (v))
451 struct arm_smmu_device
*arm_smmu_impl_init(struct arm_smmu_device
*smmu
);
452 struct arm_smmu_device
*qcom_smmu_impl_init(struct arm_smmu_device
*smmu
);
454 int arm_mmu500_reset(struct arm_smmu_device
*smmu
);
456 #endif /* _ARM_SMMU_H */