Back to home page

OSCL-LXR

 
 

    


0001 /* SPDX-License-Identifier: GPL-2.0-only */
0002 /*
0003  * IOMMU API for ARM architected SMMUv3 implementations.
0004  *
0005  * Copyright (C) 2015 ARM Limited
0006  */
0007 
0008 #ifndef _ARM_SMMU_V3_H
0009 #define _ARM_SMMU_V3_H
0010 
0011 #include <linux/bitfield.h>
0012 #include <linux/iommu.h>
0013 #include <linux/kernel.h>
0014 #include <linux/mmzone.h>
0015 #include <linux/sizes.h>
0016 
0017 /* MMIO registers */
0018 #define ARM_SMMU_IDR0           0x0
0019 #define IDR0_ST_LVL         GENMASK(28, 27)
0020 #define IDR0_ST_LVL_2LVL        1
0021 #define IDR0_STALL_MODEL        GENMASK(25, 24)
0022 #define IDR0_STALL_MODEL_STALL      0
0023 #define IDR0_STALL_MODEL_FORCE      2
0024 #define IDR0_TTENDIAN           GENMASK(22, 21)
0025 #define IDR0_TTENDIAN_MIXED     0
0026 #define IDR0_TTENDIAN_LE        2
0027 #define IDR0_TTENDIAN_BE        3
0028 #define IDR0_CD2L           (1 << 19)
0029 #define IDR0_VMID16         (1 << 18)
0030 #define IDR0_PRI            (1 << 16)
0031 #define IDR0_SEV            (1 << 14)
0032 #define IDR0_MSI            (1 << 13)
0033 #define IDR0_ASID16         (1 << 12)
0034 #define IDR0_ATS            (1 << 10)
0035 #define IDR0_HYP            (1 << 9)
0036 #define IDR0_COHACC         (1 << 4)
0037 #define IDR0_TTF            GENMASK(3, 2)
0038 #define IDR0_TTF_AARCH64        2
0039 #define IDR0_TTF_AARCH32_64     3
0040 #define IDR0_S1P            (1 << 1)
0041 #define IDR0_S2P            (1 << 0)
0042 
0043 #define ARM_SMMU_IDR1           0x4
0044 #define IDR1_TABLES_PRESET      (1 << 30)
0045 #define IDR1_QUEUES_PRESET      (1 << 29)
0046 #define IDR1_REL            (1 << 28)
0047 #define IDR1_CMDQS          GENMASK(25, 21)
0048 #define IDR1_EVTQS          GENMASK(20, 16)
0049 #define IDR1_PRIQS          GENMASK(15, 11)
0050 #define IDR1_SSIDSIZE           GENMASK(10, 6)
0051 #define IDR1_SIDSIZE            GENMASK(5, 0)
0052 
0053 #define ARM_SMMU_IDR3           0xc
0054 #define IDR3_RIL            (1 << 10)
0055 
0056 #define ARM_SMMU_IDR5           0x14
0057 #define IDR5_STALL_MAX          GENMASK(31, 16)
0058 #define IDR5_GRAN64K            (1 << 6)
0059 #define IDR5_GRAN16K            (1 << 5)
0060 #define IDR5_GRAN4K         (1 << 4)
0061 #define IDR5_OAS            GENMASK(2, 0)
0062 #define IDR5_OAS_32_BIT         0
0063 #define IDR5_OAS_36_BIT         1
0064 #define IDR5_OAS_40_BIT         2
0065 #define IDR5_OAS_42_BIT         3
0066 #define IDR5_OAS_44_BIT         4
0067 #define IDR5_OAS_48_BIT         5
0068 #define IDR5_OAS_52_BIT         6
0069 #define IDR5_VAX            GENMASK(11, 10)
0070 #define IDR5_VAX_52_BIT         1
0071 
0072 #define ARM_SMMU_CR0            0x20
0073 #define CR0_ATSCHK          (1 << 4)
0074 #define CR0_CMDQEN          (1 << 3)
0075 #define CR0_EVTQEN          (1 << 2)
0076 #define CR0_PRIQEN          (1 << 1)
0077 #define CR0_SMMUEN          (1 << 0)
0078 
0079 #define ARM_SMMU_CR0ACK         0x24
0080 
0081 #define ARM_SMMU_CR1            0x28
0082 #define CR1_TABLE_SH            GENMASK(11, 10)
0083 #define CR1_TABLE_OC            GENMASK(9, 8)
0084 #define CR1_TABLE_IC            GENMASK(7, 6)
0085 #define CR1_QUEUE_SH            GENMASK(5, 4)
0086 #define CR1_QUEUE_OC            GENMASK(3, 2)
0087 #define CR1_QUEUE_IC            GENMASK(1, 0)
0088 /* CR1 cacheability fields don't quite follow the usual TCR-style encoding */
0089 #define CR1_CACHE_NC            0
0090 #define CR1_CACHE_WB            1
0091 #define CR1_CACHE_WT            2
0092 
0093 #define ARM_SMMU_CR2            0x2c
0094 #define CR2_PTM             (1 << 2)
0095 #define CR2_RECINVSID           (1 << 1)
0096 #define CR2_E2H             (1 << 0)
0097 
0098 #define ARM_SMMU_GBPA           0x44
0099 #define GBPA_UPDATE         (1 << 31)
0100 #define GBPA_ABORT          (1 << 20)
0101 
0102 #define ARM_SMMU_IRQ_CTRL       0x50
0103 #define IRQ_CTRL_EVTQ_IRQEN     (1 << 2)
0104 #define IRQ_CTRL_PRIQ_IRQEN     (1 << 1)
0105 #define IRQ_CTRL_GERROR_IRQEN       (1 << 0)
0106 
0107 #define ARM_SMMU_IRQ_CTRLACK        0x54
0108 
0109 #define ARM_SMMU_GERROR         0x60
0110 #define GERROR_SFM_ERR          (1 << 8)
0111 #define GERROR_MSI_GERROR_ABT_ERR   (1 << 7)
0112 #define GERROR_MSI_PRIQ_ABT_ERR     (1 << 6)
0113 #define GERROR_MSI_EVTQ_ABT_ERR     (1 << 5)
0114 #define GERROR_MSI_CMDQ_ABT_ERR     (1 << 4)
0115 #define GERROR_PRIQ_ABT_ERR     (1 << 3)
0116 #define GERROR_EVTQ_ABT_ERR     (1 << 2)
0117 #define GERROR_CMDQ_ERR         (1 << 0)
0118 #define GERROR_ERR_MASK         0x1fd
0119 
0120 #define ARM_SMMU_GERRORN        0x64
0121 
0122 #define ARM_SMMU_GERROR_IRQ_CFG0    0x68
0123 #define ARM_SMMU_GERROR_IRQ_CFG1    0x70
0124 #define ARM_SMMU_GERROR_IRQ_CFG2    0x74
0125 
0126 #define ARM_SMMU_STRTAB_BASE        0x80
0127 #define STRTAB_BASE_RA          (1UL << 62)
0128 #define STRTAB_BASE_ADDR_MASK       GENMASK_ULL(51, 6)
0129 
0130 #define ARM_SMMU_STRTAB_BASE_CFG    0x88
0131 #define STRTAB_BASE_CFG_FMT     GENMASK(17, 16)
0132 #define STRTAB_BASE_CFG_FMT_LINEAR  0
0133 #define STRTAB_BASE_CFG_FMT_2LVL    1
0134 #define STRTAB_BASE_CFG_SPLIT       GENMASK(10, 6)
0135 #define STRTAB_BASE_CFG_LOG2SIZE    GENMASK(5, 0)
0136 
0137 #define ARM_SMMU_CMDQ_BASE      0x90
0138 #define ARM_SMMU_CMDQ_PROD      0x98
0139 #define ARM_SMMU_CMDQ_CONS      0x9c
0140 
0141 #define ARM_SMMU_EVTQ_BASE      0xa0
0142 #define ARM_SMMU_EVTQ_PROD      0xa8
0143 #define ARM_SMMU_EVTQ_CONS      0xac
0144 #define ARM_SMMU_EVTQ_IRQ_CFG0      0xb0
0145 #define ARM_SMMU_EVTQ_IRQ_CFG1      0xb8
0146 #define ARM_SMMU_EVTQ_IRQ_CFG2      0xbc
0147 
0148 #define ARM_SMMU_PRIQ_BASE      0xc0
0149 #define ARM_SMMU_PRIQ_PROD      0xc8
0150 #define ARM_SMMU_PRIQ_CONS      0xcc
0151 #define ARM_SMMU_PRIQ_IRQ_CFG0      0xd0
0152 #define ARM_SMMU_PRIQ_IRQ_CFG1      0xd8
0153 #define ARM_SMMU_PRIQ_IRQ_CFG2      0xdc
0154 
0155 #define ARM_SMMU_REG_SZ         0xe00
0156 
0157 /* Common MSI config fields */
0158 #define MSI_CFG0_ADDR_MASK      GENMASK_ULL(51, 2)
0159 #define MSI_CFG2_SH         GENMASK(5, 4)
0160 #define MSI_CFG2_MEMATTR        GENMASK(3, 0)
0161 
0162 /* Common memory attribute values */
0163 #define ARM_SMMU_SH_NSH         0
0164 #define ARM_SMMU_SH_OSH         2
0165 #define ARM_SMMU_SH_ISH         3
0166 #define ARM_SMMU_MEMATTR_DEVICE_nGnRE   0x1
0167 #define ARM_SMMU_MEMATTR_OIWB       0xf
0168 
0169 #define Q_IDX(llq, p)           ((p) & ((1 << (llq)->max_n_shift) - 1))
0170 #define Q_WRP(llq, p)           ((p) & (1 << (llq)->max_n_shift))
0171 #define Q_OVERFLOW_FLAG         (1U << 31)
0172 #define Q_OVF(p)            ((p) & Q_OVERFLOW_FLAG)
0173 #define Q_ENT(q, p)         ((q)->base +            \
0174                      Q_IDX(&((q)->llq), p) *    \
0175                      (q)->ent_dwords)
0176 
0177 #define Q_BASE_RWA          (1UL << 62)
0178 #define Q_BASE_ADDR_MASK        GENMASK_ULL(51, 5)
0179 #define Q_BASE_LOG2SIZE         GENMASK(4, 0)
0180 
0181 /* Ensure DMA allocations are naturally aligned */
0182 #ifdef CONFIG_CMA_ALIGNMENT
0183 #define Q_MAX_SZ_SHIFT          (PAGE_SHIFT + CONFIG_CMA_ALIGNMENT)
0184 #else
0185 #define Q_MAX_SZ_SHIFT          (PAGE_SHIFT + MAX_ORDER - 1)
0186 #endif
0187 
0188 /*
0189  * Stream table.
0190  *
0191  * Linear: Enough to cover 1 << IDR1.SIDSIZE entries
0192  * 2lvl: 128k L1 entries,
0193  *       256 lazy entries per table (each table covers a PCI bus)
0194  */
0195 #define STRTAB_L1_SZ_SHIFT      20
0196 #define STRTAB_SPLIT            8
0197 
0198 #define STRTAB_L1_DESC_DWORDS       1
0199 #define STRTAB_L1_DESC_SPAN     GENMASK_ULL(4, 0)
0200 #define STRTAB_L1_DESC_L2PTR_MASK   GENMASK_ULL(51, 6)
0201 
0202 #define STRTAB_STE_DWORDS       8
0203 #define STRTAB_STE_0_V          (1UL << 0)
0204 #define STRTAB_STE_0_CFG        GENMASK_ULL(3, 1)
0205 #define STRTAB_STE_0_CFG_ABORT      0
0206 #define STRTAB_STE_0_CFG_BYPASS     4
0207 #define STRTAB_STE_0_CFG_S1_TRANS   5
0208 #define STRTAB_STE_0_CFG_S2_TRANS   6
0209 
0210 #define STRTAB_STE_0_S1FMT      GENMASK_ULL(5, 4)
0211 #define STRTAB_STE_0_S1FMT_LINEAR   0
0212 #define STRTAB_STE_0_S1FMT_64K_L2   2
0213 #define STRTAB_STE_0_S1CTXPTR_MASK  GENMASK_ULL(51, 6)
0214 #define STRTAB_STE_0_S1CDMAX        GENMASK_ULL(63, 59)
0215 
0216 #define STRTAB_STE_1_S1DSS      GENMASK_ULL(1, 0)
0217 #define STRTAB_STE_1_S1DSS_TERMINATE    0x0
0218 #define STRTAB_STE_1_S1DSS_BYPASS   0x1
0219 #define STRTAB_STE_1_S1DSS_SSID0    0x2
0220 
0221 #define STRTAB_STE_1_S1C_CACHE_NC   0UL
0222 #define STRTAB_STE_1_S1C_CACHE_WBRA 1UL
0223 #define STRTAB_STE_1_S1C_CACHE_WT   2UL
0224 #define STRTAB_STE_1_S1C_CACHE_WB   3UL
0225 #define STRTAB_STE_1_S1CIR      GENMASK_ULL(3, 2)
0226 #define STRTAB_STE_1_S1COR      GENMASK_ULL(5, 4)
0227 #define STRTAB_STE_1_S1CSH      GENMASK_ULL(7, 6)
0228 
0229 #define STRTAB_STE_1_S1STALLD       (1UL << 27)
0230 
0231 #define STRTAB_STE_1_EATS       GENMASK_ULL(29, 28)
0232 #define STRTAB_STE_1_EATS_ABT       0UL
0233 #define STRTAB_STE_1_EATS_TRANS     1UL
0234 #define STRTAB_STE_1_EATS_S1CHK     2UL
0235 
0236 #define STRTAB_STE_1_STRW       GENMASK_ULL(31, 30)
0237 #define STRTAB_STE_1_STRW_NSEL1     0UL
0238 #define STRTAB_STE_1_STRW_EL2       2UL
0239 
0240 #define STRTAB_STE_1_SHCFG      GENMASK_ULL(45, 44)
0241 #define STRTAB_STE_1_SHCFG_INCOMING 1UL
0242 
0243 #define STRTAB_STE_2_S2VMID     GENMASK_ULL(15, 0)
0244 #define STRTAB_STE_2_VTCR       GENMASK_ULL(50, 32)
0245 #define STRTAB_STE_2_VTCR_S2T0SZ    GENMASK_ULL(5, 0)
0246 #define STRTAB_STE_2_VTCR_S2SL0     GENMASK_ULL(7, 6)
0247 #define STRTAB_STE_2_VTCR_S2IR0     GENMASK_ULL(9, 8)
0248 #define STRTAB_STE_2_VTCR_S2OR0     GENMASK_ULL(11, 10)
0249 #define STRTAB_STE_2_VTCR_S2SH0     GENMASK_ULL(13, 12)
0250 #define STRTAB_STE_2_VTCR_S2TG      GENMASK_ULL(15, 14)
0251 #define STRTAB_STE_2_VTCR_S2PS      GENMASK_ULL(18, 16)
0252 #define STRTAB_STE_2_S2AA64     (1UL << 51)
0253 #define STRTAB_STE_2_S2ENDI     (1UL << 52)
0254 #define STRTAB_STE_2_S2PTW      (1UL << 54)
0255 #define STRTAB_STE_2_S2R        (1UL << 58)
0256 
0257 #define STRTAB_STE_3_S2TTB_MASK     GENMASK_ULL(51, 4)
0258 
0259 /*
0260  * Context descriptors.
0261  *
0262  * Linear: when less than 1024 SSIDs are supported
0263  * 2lvl: at most 1024 L1 entries,
0264  *       1024 lazy entries per table.
0265  */
0266 #define CTXDESC_SPLIT           10
0267 #define CTXDESC_L2_ENTRIES      (1 << CTXDESC_SPLIT)
0268 
0269 #define CTXDESC_L1_DESC_DWORDS      1
0270 #define CTXDESC_L1_DESC_V       (1UL << 0)
0271 #define CTXDESC_L1_DESC_L2PTR_MASK  GENMASK_ULL(51, 12)
0272 
0273 #define CTXDESC_CD_DWORDS       8
0274 #define CTXDESC_CD_0_TCR_T0SZ       GENMASK_ULL(5, 0)
0275 #define CTXDESC_CD_0_TCR_TG0        GENMASK_ULL(7, 6)
0276 #define CTXDESC_CD_0_TCR_IRGN0      GENMASK_ULL(9, 8)
0277 #define CTXDESC_CD_0_TCR_ORGN0      GENMASK_ULL(11, 10)
0278 #define CTXDESC_CD_0_TCR_SH0        GENMASK_ULL(13, 12)
0279 #define CTXDESC_CD_0_TCR_EPD0       (1ULL << 14)
0280 #define CTXDESC_CD_0_TCR_EPD1       (1ULL << 30)
0281 
0282 #define CTXDESC_CD_0_ENDI       (1UL << 15)
0283 #define CTXDESC_CD_0_V          (1UL << 31)
0284 
0285 #define CTXDESC_CD_0_TCR_IPS        GENMASK_ULL(34, 32)
0286 #define CTXDESC_CD_0_TCR_TBI0       (1ULL << 38)
0287 
0288 #define CTXDESC_CD_0_AA64       (1UL << 41)
0289 #define CTXDESC_CD_0_S          (1UL << 44)
0290 #define CTXDESC_CD_0_R          (1UL << 45)
0291 #define CTXDESC_CD_0_A          (1UL << 46)
0292 #define CTXDESC_CD_0_ASET       (1UL << 47)
0293 #define CTXDESC_CD_0_ASID       GENMASK_ULL(63, 48)
0294 
0295 #define CTXDESC_CD_1_TTB0_MASK      GENMASK_ULL(51, 4)
0296 
0297 /*
0298  * When the SMMU only supports linear context descriptor tables, pick a
0299  * reasonable size limit (64kB).
0300  */
0301 #define CTXDESC_LINEAR_CDMAX        ilog2(SZ_64K / (CTXDESC_CD_DWORDS << 3))
0302 
0303 /* Command queue */
0304 #define CMDQ_ENT_SZ_SHIFT       4
0305 #define CMDQ_ENT_DWORDS         ((1 << CMDQ_ENT_SZ_SHIFT) >> 3)
0306 #define CMDQ_MAX_SZ_SHIFT       (Q_MAX_SZ_SHIFT - CMDQ_ENT_SZ_SHIFT)
0307 
0308 #define CMDQ_CONS_ERR           GENMASK(30, 24)
0309 #define CMDQ_ERR_CERROR_NONE_IDX    0
0310 #define CMDQ_ERR_CERROR_ILL_IDX     1
0311 #define CMDQ_ERR_CERROR_ABT_IDX     2
0312 #define CMDQ_ERR_CERROR_ATC_INV_IDX 3
0313 
0314 #define CMDQ_PROD_OWNED_FLAG        Q_OVERFLOW_FLAG
0315 
0316 /*
0317  * This is used to size the command queue and therefore must be at least
0318  * BITS_PER_LONG so that the valid_map works correctly (it relies on the
0319  * total number of queue entries being a multiple of BITS_PER_LONG).
0320  */
0321 #define CMDQ_BATCH_ENTRIES      BITS_PER_LONG
0322 
0323 #define CMDQ_0_OP           GENMASK_ULL(7, 0)
0324 #define CMDQ_0_SSV          (1UL << 11)
0325 
0326 #define CMDQ_PREFETCH_0_SID     GENMASK_ULL(63, 32)
0327 #define CMDQ_PREFETCH_1_SIZE        GENMASK_ULL(4, 0)
0328 #define CMDQ_PREFETCH_1_ADDR_MASK   GENMASK_ULL(63, 12)
0329 
0330 #define CMDQ_CFGI_0_SSID        GENMASK_ULL(31, 12)
0331 #define CMDQ_CFGI_0_SID         GENMASK_ULL(63, 32)
0332 #define CMDQ_CFGI_1_LEAF        (1UL << 0)
0333 #define CMDQ_CFGI_1_RANGE       GENMASK_ULL(4, 0)
0334 
0335 #define CMDQ_TLBI_0_NUM         GENMASK_ULL(16, 12)
0336 #define CMDQ_TLBI_RANGE_NUM_MAX     31
0337 #define CMDQ_TLBI_0_SCALE       GENMASK_ULL(24, 20)
0338 #define CMDQ_TLBI_0_VMID        GENMASK_ULL(47, 32)
0339 #define CMDQ_TLBI_0_ASID        GENMASK_ULL(63, 48)
0340 #define CMDQ_TLBI_1_LEAF        (1UL << 0)
0341 #define CMDQ_TLBI_1_TTL         GENMASK_ULL(9, 8)
0342 #define CMDQ_TLBI_1_TG          GENMASK_ULL(11, 10)
0343 #define CMDQ_TLBI_1_VA_MASK     GENMASK_ULL(63, 12)
0344 #define CMDQ_TLBI_1_IPA_MASK        GENMASK_ULL(51, 12)
0345 
0346 #define CMDQ_ATC_0_SSID         GENMASK_ULL(31, 12)
0347 #define CMDQ_ATC_0_SID          GENMASK_ULL(63, 32)
0348 #define CMDQ_ATC_0_GLOBAL       (1UL << 9)
0349 #define CMDQ_ATC_1_SIZE         GENMASK_ULL(5, 0)
0350 #define CMDQ_ATC_1_ADDR_MASK        GENMASK_ULL(63, 12)
0351 
0352 #define CMDQ_PRI_0_SSID         GENMASK_ULL(31, 12)
0353 #define CMDQ_PRI_0_SID          GENMASK_ULL(63, 32)
0354 #define CMDQ_PRI_1_GRPID        GENMASK_ULL(8, 0)
0355 #define CMDQ_PRI_1_RESP         GENMASK_ULL(13, 12)
0356 
0357 #define CMDQ_RESUME_0_RESP_TERM     0UL
0358 #define CMDQ_RESUME_0_RESP_RETRY    1UL
0359 #define CMDQ_RESUME_0_RESP_ABORT    2UL
0360 #define CMDQ_RESUME_0_RESP      GENMASK_ULL(13, 12)
0361 #define CMDQ_RESUME_0_SID       GENMASK_ULL(63, 32)
0362 #define CMDQ_RESUME_1_STAG      GENMASK_ULL(15, 0)
0363 
0364 #define CMDQ_SYNC_0_CS          GENMASK_ULL(13, 12)
0365 #define CMDQ_SYNC_0_CS_NONE     0
0366 #define CMDQ_SYNC_0_CS_IRQ      1
0367 #define CMDQ_SYNC_0_CS_SEV      2
0368 #define CMDQ_SYNC_0_MSH         GENMASK_ULL(23, 22)
0369 #define CMDQ_SYNC_0_MSIATTR     GENMASK_ULL(27, 24)
0370 #define CMDQ_SYNC_0_MSIDATA     GENMASK_ULL(63, 32)
0371 #define CMDQ_SYNC_1_MSIADDR_MASK    GENMASK_ULL(51, 2)
0372 
0373 /* Event queue */
0374 #define EVTQ_ENT_SZ_SHIFT       5
0375 #define EVTQ_ENT_DWORDS         ((1 << EVTQ_ENT_SZ_SHIFT) >> 3)
0376 #define EVTQ_MAX_SZ_SHIFT       (Q_MAX_SZ_SHIFT - EVTQ_ENT_SZ_SHIFT)
0377 
0378 #define EVTQ_0_ID           GENMASK_ULL(7, 0)
0379 
0380 #define EVT_ID_TRANSLATION_FAULT    0x10
0381 #define EVT_ID_ADDR_SIZE_FAULT      0x11
0382 #define EVT_ID_ACCESS_FAULT     0x12
0383 #define EVT_ID_PERMISSION_FAULT     0x13
0384 
0385 #define EVTQ_0_SSV          (1UL << 11)
0386 #define EVTQ_0_SSID         GENMASK_ULL(31, 12)
0387 #define EVTQ_0_SID          GENMASK_ULL(63, 32)
0388 #define EVTQ_1_STAG         GENMASK_ULL(15, 0)
0389 #define EVTQ_1_STALL            (1UL << 31)
0390 #define EVTQ_1_PnU          (1UL << 33)
0391 #define EVTQ_1_InD          (1UL << 34)
0392 #define EVTQ_1_RnW          (1UL << 35)
0393 #define EVTQ_1_S2           (1UL << 39)
0394 #define EVTQ_1_CLASS            GENMASK_ULL(41, 40)
0395 #define EVTQ_1_TT_READ          (1UL << 44)
0396 #define EVTQ_2_ADDR         GENMASK_ULL(63, 0)
0397 #define EVTQ_3_IPA          GENMASK_ULL(51, 12)
0398 
0399 /* PRI queue */
0400 #define PRIQ_ENT_SZ_SHIFT       4
0401 #define PRIQ_ENT_DWORDS         ((1 << PRIQ_ENT_SZ_SHIFT) >> 3)
0402 #define PRIQ_MAX_SZ_SHIFT       (Q_MAX_SZ_SHIFT - PRIQ_ENT_SZ_SHIFT)
0403 
0404 #define PRIQ_0_SID          GENMASK_ULL(31, 0)
0405 #define PRIQ_0_SSID         GENMASK_ULL(51, 32)
0406 #define PRIQ_0_PERM_PRIV        (1UL << 58)
0407 #define PRIQ_0_PERM_EXEC        (1UL << 59)
0408 #define PRIQ_0_PERM_READ        (1UL << 60)
0409 #define PRIQ_0_PERM_WRITE       (1UL << 61)
0410 #define PRIQ_0_PRG_LAST         (1UL << 62)
0411 #define PRIQ_0_SSID_V           (1UL << 63)
0412 
0413 #define PRIQ_1_PRG_IDX          GENMASK_ULL(8, 0)
0414 #define PRIQ_1_ADDR_MASK        GENMASK_ULL(63, 12)
0415 
0416 /* High-level queue structures */
0417 #define ARM_SMMU_POLL_TIMEOUT_US    1000000 /* 1s! */
0418 #define ARM_SMMU_POLL_SPIN_COUNT    10
0419 
0420 #define MSI_IOVA_BASE           0x8000000
0421 #define MSI_IOVA_LENGTH         0x100000
0422 
0423 enum pri_resp {
0424     PRI_RESP_DENY = 0,
0425     PRI_RESP_FAIL = 1,
0426     PRI_RESP_SUCC = 2,
0427 };
0428 
0429 struct arm_smmu_cmdq_ent {
0430     /* Common fields */
0431     u8              opcode;
0432     bool                substream_valid;
0433 
0434     /* Command-specific fields */
0435     union {
0436         #define CMDQ_OP_PREFETCH_CFG    0x1
0437         struct {
0438             u32         sid;
0439         } prefetch;
0440 
0441         #define CMDQ_OP_CFGI_STE    0x3
0442         #define CMDQ_OP_CFGI_ALL    0x4
0443         #define CMDQ_OP_CFGI_CD     0x5
0444         #define CMDQ_OP_CFGI_CD_ALL 0x6
0445         struct {
0446             u32         sid;
0447             u32         ssid;
0448             union {
0449                 bool        leaf;
0450                 u8      span;
0451             };
0452         } cfgi;
0453 
0454         #define CMDQ_OP_TLBI_NH_ASID    0x11
0455         #define CMDQ_OP_TLBI_NH_VA  0x12
0456         #define CMDQ_OP_TLBI_EL2_ALL    0x20
0457         #define CMDQ_OP_TLBI_EL2_ASID   0x21
0458         #define CMDQ_OP_TLBI_EL2_VA 0x22
0459         #define CMDQ_OP_TLBI_S12_VMALL  0x28
0460         #define CMDQ_OP_TLBI_S2_IPA 0x2a
0461         #define CMDQ_OP_TLBI_NSNH_ALL   0x30
0462         struct {
0463             u8          num;
0464             u8          scale;
0465             u16         asid;
0466             u16         vmid;
0467             bool            leaf;
0468             u8          ttl;
0469             u8          tg;
0470             u64         addr;
0471         } tlbi;
0472 
0473         #define CMDQ_OP_ATC_INV     0x40
0474         #define ATC_INV_SIZE_ALL    52
0475         struct {
0476             u32         sid;
0477             u32         ssid;
0478             u64         addr;
0479             u8          size;
0480             bool            global;
0481         } atc;
0482 
0483         #define CMDQ_OP_PRI_RESP    0x41
0484         struct {
0485             u32         sid;
0486             u32         ssid;
0487             u16         grpid;
0488             enum pri_resp       resp;
0489         } pri;
0490 
0491         #define CMDQ_OP_RESUME      0x44
0492         struct {
0493             u32         sid;
0494             u16         stag;
0495             u8          resp;
0496         } resume;
0497 
0498         #define CMDQ_OP_CMD_SYNC    0x46
0499         struct {
0500             u64         msiaddr;
0501         } sync;
0502     };
0503 };
0504 
0505 struct arm_smmu_ll_queue {
0506     union {
0507         u64         val;
0508         struct {
0509             u32     prod;
0510             u32     cons;
0511         };
0512         struct {
0513             atomic_t    prod;
0514             atomic_t    cons;
0515         } atomic;
0516         u8          __pad[SMP_CACHE_BYTES];
0517     } ____cacheline_aligned_in_smp;
0518     u32             max_n_shift;
0519 };
0520 
0521 struct arm_smmu_queue {
0522     struct arm_smmu_ll_queue    llq;
0523     int             irq; /* Wired interrupt */
0524 
0525     __le64              *base;
0526     dma_addr_t          base_dma;
0527     u64             q_base;
0528 
0529     size_t              ent_dwords;
0530 
0531     u32 __iomem         *prod_reg;
0532     u32 __iomem         *cons_reg;
0533 };
0534 
0535 struct arm_smmu_queue_poll {
0536     ktime_t             timeout;
0537     unsigned int            delay;
0538     unsigned int            spin_cnt;
0539     bool                wfe;
0540 };
0541 
0542 struct arm_smmu_cmdq {
0543     struct arm_smmu_queue       q;
0544     atomic_long_t           *valid_map;
0545     atomic_t            owner_prod;
0546     atomic_t            lock;
0547 };
0548 
0549 struct arm_smmu_cmdq_batch {
0550     u64             cmds[CMDQ_BATCH_ENTRIES * CMDQ_ENT_DWORDS];
0551     int             num;
0552 };
0553 
0554 struct arm_smmu_evtq {
0555     struct arm_smmu_queue       q;
0556     struct iopf_queue       *iopf;
0557     u32             max_stalls;
0558 };
0559 
0560 struct arm_smmu_priq {
0561     struct arm_smmu_queue       q;
0562 };
0563 
0564 /* High-level stream table and context descriptor structures */
0565 struct arm_smmu_strtab_l1_desc {
0566     u8              span;
0567 
0568     __le64              *l2ptr;
0569     dma_addr_t          l2ptr_dma;
0570 };
0571 
0572 struct arm_smmu_ctx_desc {
0573     u16             asid;
0574     u64             ttbr;
0575     u64             tcr;
0576     u64             mair;
0577 
0578     refcount_t          refs;
0579     struct mm_struct        *mm;
0580 };
0581 
0582 struct arm_smmu_l1_ctx_desc {
0583     __le64              *l2ptr;
0584     dma_addr_t          l2ptr_dma;
0585 };
0586 
0587 struct arm_smmu_ctx_desc_cfg {
0588     __le64              *cdtab;
0589     dma_addr_t          cdtab_dma;
0590     struct arm_smmu_l1_ctx_desc *l1_desc;
0591     unsigned int            num_l1_ents;
0592 };
0593 
0594 struct arm_smmu_s1_cfg {
0595     struct arm_smmu_ctx_desc_cfg    cdcfg;
0596     struct arm_smmu_ctx_desc    cd;
0597     u8              s1fmt;
0598     u8              s1cdmax;
0599 };
0600 
0601 struct arm_smmu_s2_cfg {
0602     u16             vmid;
0603     u64             vttbr;
0604     u64             vtcr;
0605 };
0606 
0607 struct arm_smmu_strtab_cfg {
0608     __le64              *strtab;
0609     dma_addr_t          strtab_dma;
0610     struct arm_smmu_strtab_l1_desc  *l1_desc;
0611     unsigned int            num_l1_ents;
0612 
0613     u64             strtab_base;
0614     u32             strtab_base_cfg;
0615 };
0616 
0617 /* An SMMUv3 instance */
0618 struct arm_smmu_device {
0619     struct device           *dev;
0620     void __iomem            *base;
0621     void __iomem            *page1;
0622 
0623 #define ARM_SMMU_FEAT_2_LVL_STRTAB  (1 << 0)
0624 #define ARM_SMMU_FEAT_2_LVL_CDTAB   (1 << 1)
0625 #define ARM_SMMU_FEAT_TT_LE     (1 << 2)
0626 #define ARM_SMMU_FEAT_TT_BE     (1 << 3)
0627 #define ARM_SMMU_FEAT_PRI       (1 << 4)
0628 #define ARM_SMMU_FEAT_ATS       (1 << 5)
0629 #define ARM_SMMU_FEAT_SEV       (1 << 6)
0630 #define ARM_SMMU_FEAT_MSI       (1 << 7)
0631 #define ARM_SMMU_FEAT_COHERENCY     (1 << 8)
0632 #define ARM_SMMU_FEAT_TRANS_S1      (1 << 9)
0633 #define ARM_SMMU_FEAT_TRANS_S2      (1 << 10)
0634 #define ARM_SMMU_FEAT_STALLS        (1 << 11)
0635 #define ARM_SMMU_FEAT_HYP       (1 << 12)
0636 #define ARM_SMMU_FEAT_STALL_FORCE   (1 << 13)
0637 #define ARM_SMMU_FEAT_VAX       (1 << 14)
0638 #define ARM_SMMU_FEAT_RANGE_INV     (1 << 15)
0639 #define ARM_SMMU_FEAT_BTM       (1 << 16)
0640 #define ARM_SMMU_FEAT_SVA       (1 << 17)
0641 #define ARM_SMMU_FEAT_E2H       (1 << 18)
0642     u32             features;
0643 
0644 #define ARM_SMMU_OPT_SKIP_PREFETCH  (1 << 0)
0645 #define ARM_SMMU_OPT_PAGE0_REGS_ONLY    (1 << 1)
0646 #define ARM_SMMU_OPT_MSIPOLL        (1 << 2)
0647     u32             options;
0648 
0649     struct arm_smmu_cmdq        cmdq;
0650     struct arm_smmu_evtq        evtq;
0651     struct arm_smmu_priq        priq;
0652 
0653     int             gerr_irq;
0654     int             combined_irq;
0655 
0656     unsigned long           ias; /* IPA */
0657     unsigned long           oas; /* PA */
0658     unsigned long           pgsize_bitmap;
0659 
0660 #define ARM_SMMU_MAX_ASIDS      (1 << 16)
0661     unsigned int            asid_bits;
0662 
0663 #define ARM_SMMU_MAX_VMIDS      (1 << 16)
0664     unsigned int            vmid_bits;
0665     DECLARE_BITMAP(vmid_map, ARM_SMMU_MAX_VMIDS);
0666 
0667     unsigned int            ssid_bits;
0668     unsigned int            sid_bits;
0669 
0670     struct arm_smmu_strtab_cfg  strtab_cfg;
0671 
0672     /* IOMMU core code handle */
0673     struct iommu_device     iommu;
0674 
0675     struct rb_root          streams;
0676     struct mutex            streams_mutex;
0677 };
0678 
0679 struct arm_smmu_stream {
0680     u32             id;
0681     struct arm_smmu_master      *master;
0682     struct rb_node          node;
0683 };
0684 
0685 /* SMMU private data for each master */
0686 struct arm_smmu_master {
0687     struct arm_smmu_device      *smmu;
0688     struct device           *dev;
0689     struct arm_smmu_domain      *domain;
0690     struct list_head        domain_head;
0691     struct arm_smmu_stream      *streams;
0692     unsigned int            num_streams;
0693     bool                ats_enabled;
0694     bool                stall_enabled;
0695     bool                sva_enabled;
0696     bool                iopf_enabled;
0697     struct list_head        bonds;
0698     unsigned int            ssid_bits;
0699 };
0700 
0701 /* SMMU private data for an IOMMU domain */
0702 enum arm_smmu_domain_stage {
0703     ARM_SMMU_DOMAIN_S1 = 0,
0704     ARM_SMMU_DOMAIN_S2,
0705     ARM_SMMU_DOMAIN_NESTED,
0706     ARM_SMMU_DOMAIN_BYPASS,
0707 };
0708 
0709 struct arm_smmu_domain {
0710     struct arm_smmu_device      *smmu;
0711     struct mutex            init_mutex; /* Protects smmu pointer */
0712 
0713     struct io_pgtable_ops       *pgtbl_ops;
0714     bool                stall_enabled;
0715     atomic_t            nr_ats_masters;
0716 
0717     enum arm_smmu_domain_stage  stage;
0718     union {
0719         struct arm_smmu_s1_cfg  s1_cfg;
0720         struct arm_smmu_s2_cfg  s2_cfg;
0721     };
0722 
0723     struct iommu_domain     domain;
0724 
0725     struct list_head        devices;
0726     spinlock_t          devices_lock;
0727 
0728     struct list_head        mmu_notifiers;
0729 };
0730 
0731 static inline struct arm_smmu_domain *to_smmu_domain(struct iommu_domain *dom)
0732 {
0733     return container_of(dom, struct arm_smmu_domain, domain);
0734 }
0735 
0736 extern struct xarray arm_smmu_asid_xa;
0737 extern struct mutex arm_smmu_asid_lock;
0738 extern struct arm_smmu_ctx_desc quiet_cd;
0739 
0740 int arm_smmu_write_ctx_desc(struct arm_smmu_domain *smmu_domain, int ssid,
0741                 struct arm_smmu_ctx_desc *cd);
0742 void arm_smmu_tlb_inv_asid(struct arm_smmu_device *smmu, u16 asid);
0743 void arm_smmu_tlb_inv_range_asid(unsigned long iova, size_t size, int asid,
0744                  size_t granule, bool leaf,
0745                  struct arm_smmu_domain *smmu_domain);
0746 bool arm_smmu_free_asid(struct arm_smmu_ctx_desc *cd);
0747 int arm_smmu_atc_inv_domain(struct arm_smmu_domain *smmu_domain, int ssid,
0748                 unsigned long iova, size_t size);
0749 
0750 #ifdef CONFIG_ARM_SMMU_V3_SVA
0751 bool arm_smmu_sva_supported(struct arm_smmu_device *smmu);
0752 bool arm_smmu_master_sva_supported(struct arm_smmu_master *master);
0753 bool arm_smmu_master_sva_enabled(struct arm_smmu_master *master);
0754 int arm_smmu_master_enable_sva(struct arm_smmu_master *master);
0755 int arm_smmu_master_disable_sva(struct arm_smmu_master *master);
0756 bool arm_smmu_master_iopf_supported(struct arm_smmu_master *master);
0757 struct iommu_sva *arm_smmu_sva_bind(struct device *dev, struct mm_struct *mm,
0758                     void *drvdata);
0759 void arm_smmu_sva_unbind(struct iommu_sva *handle);
0760 u32 arm_smmu_sva_get_pasid(struct iommu_sva *handle);
0761 void arm_smmu_sva_notifier_synchronize(void);
0762 #else /* CONFIG_ARM_SMMU_V3_SVA */
0763 static inline bool arm_smmu_sva_supported(struct arm_smmu_device *smmu)
0764 {
0765     return false;
0766 }
0767 
0768 static inline bool arm_smmu_master_sva_supported(struct arm_smmu_master *master)
0769 {
0770     return false;
0771 }
0772 
0773 static inline bool arm_smmu_master_sva_enabled(struct arm_smmu_master *master)
0774 {
0775     return false;
0776 }
0777 
0778 static inline int arm_smmu_master_enable_sva(struct arm_smmu_master *master)
0779 {
0780     return -ENODEV;
0781 }
0782 
0783 static inline int arm_smmu_master_disable_sva(struct arm_smmu_master *master)
0784 {
0785     return -ENODEV;
0786 }
0787 
0788 static inline bool arm_smmu_master_iopf_supported(struct arm_smmu_master *master)
0789 {
0790     return false;
0791 }
0792 
0793 static inline struct iommu_sva *
0794 arm_smmu_sva_bind(struct device *dev, struct mm_struct *mm, void *drvdata)
0795 {
0796     return ERR_PTR(-ENODEV);
0797 }
0798 
0799 static inline void arm_smmu_sva_unbind(struct iommu_sva *handle) {}
0800 
0801 static inline u32 arm_smmu_sva_get_pasid(struct iommu_sva *handle)
0802 {
0803     return IOMMU_PASID_INVALID;
0804 }
0805 
0806 static inline void arm_smmu_sva_notifier_synchronize(void) {}
0807 #endif /* CONFIG_ARM_SMMU_V3_SVA */
0808 #endif /* _ARM_SMMU_V3_H */