xref: /qemu/hw/riscv/riscv-iommu-bits.h (revision 513823e7521a09ed7ad1e32e6454bac3b2cbf52d)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * Copyright © 2022-2023 Rivos Inc.
4  * Copyright © 2023 FORTH-ICS/CARV
5  * Copyright © 2023 RISC-V IOMMU Task Group
6  *
7  * RISC-V IOMMU - Register Layout and Data Structures.
8  *
9  * Based on the IOMMU spec version 1.0, 3/2023
10  * https://github.com/riscv-non-isa/riscv-iommu
11  */
12 
13 #ifndef HW_RISCV_IOMMU_BITS_H
14 #define HW_RISCV_IOMMU_BITS_H
15 
16 #define RISCV_IOMMU_SPEC_DOT_VER 0x010
17 
18 #ifndef GENMASK_ULL
19 #define GENMASK_ULL(h, l) (((~0ULL) >> (63 - (h) + (l))) << (l))
20 #endif
21 
22 /*
23  * struct riscv_iommu_fq_record - Fault/Event Queue Record
24  * See section 3.2 for more info.
25  */
26 struct riscv_iommu_fq_record {
27     uint64_t hdr;
28     uint64_t _reserved;
29     uint64_t iotval;
30     uint64_t iotval2;
31 };
32 /* Header fields */
33 #define RISCV_IOMMU_FQ_HDR_CAUSE        GENMASK_ULL(11, 0)
34 #define RISCV_IOMMU_FQ_HDR_PID          GENMASK_ULL(31, 12)
35 #define RISCV_IOMMU_FQ_HDR_PV           BIT_ULL(32)
36 #define RISCV_IOMMU_FQ_HDR_TTYPE        GENMASK_ULL(39, 34)
37 #define RISCV_IOMMU_FQ_HDR_DID          GENMASK_ULL(63, 40)
38 
39 /*
40  * struct riscv_iommu_pq_record - PCIe Page Request record
41  * For more infos on the PCIe Page Request queue see chapter 3.3.
42  */
43 struct riscv_iommu_pq_record {
44       uint64_t hdr;
45       uint64_t payload;
46 };
47 /* Header fields */
48 #define RISCV_IOMMU_PREQ_HDR_PID        GENMASK_ULL(31, 12)
49 #define RISCV_IOMMU_PREQ_HDR_PV         BIT_ULL(32)
50 #define RISCV_IOMMU_PREQ_HDR_PRIV       BIT_ULL(33)
51 #define RISCV_IOMMU_PREQ_HDR_EXEC       BIT_ULL(34)
52 #define RISCV_IOMMU_PREQ_HDR_DID        GENMASK_ULL(63, 40)
53 /* Payload fields */
54 #define RISCV_IOMMU_PREQ_PAYLOAD_M      GENMASK_ULL(2, 0)
55 
56 /* Common field positions */
57 #define RISCV_IOMMU_PPN_FIELD           GENMASK_ULL(53, 10)
58 #define RISCV_IOMMU_QUEUE_LOGSZ_FIELD   GENMASK_ULL(4, 0)
59 #define RISCV_IOMMU_QUEUE_INDEX_FIELD   GENMASK_ULL(31, 0)
60 #define RISCV_IOMMU_QUEUE_ENABLE        BIT(0)
61 #define RISCV_IOMMU_QUEUE_INTR_ENABLE   BIT(1)
62 #define RISCV_IOMMU_QUEUE_MEM_FAULT     BIT(8)
63 #define RISCV_IOMMU_QUEUE_OVERFLOW      BIT(9)
64 #define RISCV_IOMMU_QUEUE_ACTIVE        BIT(16)
65 #define RISCV_IOMMU_QUEUE_BUSY          BIT(17)
66 #define RISCV_IOMMU_ATP_PPN_FIELD       GENMASK_ULL(43, 0)
67 #define RISCV_IOMMU_ATP_MODE_FIELD      GENMASK_ULL(63, 60)
68 
69 /* 5.3 IOMMU Capabilities (64bits) */
70 #define RISCV_IOMMU_REG_CAP             0x0000
71 #define RISCV_IOMMU_CAP_VERSION         GENMASK_ULL(7, 0)
72 #define RISCV_IOMMU_CAP_SV32            BIT_ULL(8)
73 #define RISCV_IOMMU_CAP_SV39            BIT_ULL(9)
74 #define RISCV_IOMMU_CAP_SV48            BIT_ULL(10)
75 #define RISCV_IOMMU_CAP_SV57            BIT_ULL(11)
76 #define RISCV_IOMMU_CAP_SV32X4          BIT_ULL(16)
77 #define RISCV_IOMMU_CAP_SV39X4          BIT_ULL(17)
78 #define RISCV_IOMMU_CAP_SV48X4          BIT_ULL(18)
79 #define RISCV_IOMMU_CAP_SV57X4          BIT_ULL(19)
80 #define RISCV_IOMMU_CAP_MSI_FLAT        BIT_ULL(22)
81 #define RISCV_IOMMU_CAP_MSI_MRIF        BIT_ULL(23)
82 #define RISCV_IOMMU_CAP_ATS             BIT_ULL(25)
83 #define RISCV_IOMMU_CAP_T2GPA           BIT_ULL(26)
84 #define RISCV_IOMMU_CAP_IGS             GENMASK_ULL(29, 28)
85 #define RISCV_IOMMU_CAP_DBG             BIT_ULL(31)
86 #define RISCV_IOMMU_CAP_PAS             GENMASK_ULL(37, 32)
87 #define RISCV_IOMMU_CAP_PD8             BIT_ULL(38)
88 #define RISCV_IOMMU_CAP_PD17            BIT_ULL(39)
89 #define RISCV_IOMMU_CAP_PD20            BIT_ULL(40)
90 
91 enum riscv_iommu_igs_modes {
92     RISCV_IOMMU_CAP_IGS_MSI = 0,
93     RISCV_IOMMU_CAP_IGS_WSI,
94     RISCV_IOMMU_CAP_IGS_BOTH
95 };
96 
97 /* 5.4 Features control register (32bits) */
98 #define RISCV_IOMMU_REG_FCTL            0x0008
99 #define RISCV_IOMMU_FCTL_BE             BIT(0)
100 #define RISCV_IOMMU_FCTL_WSI            BIT(1)
101 #define RISCV_IOMMU_FCTL_GXL            BIT(2)
102 
103 /* 5.5 Device-directory-table pointer (64bits) */
104 #define RISCV_IOMMU_REG_DDTP            0x0010
105 #define RISCV_IOMMU_DDTP_MODE           GENMASK_ULL(3, 0)
106 #define RISCV_IOMMU_DDTP_BUSY           BIT_ULL(4)
107 #define RISCV_IOMMU_DDTP_PPN            RISCV_IOMMU_PPN_FIELD
108 
109 enum riscv_iommu_ddtp_modes {
110     RISCV_IOMMU_DDTP_MODE_OFF = 0,
111     RISCV_IOMMU_DDTP_MODE_BARE = 1,
112     RISCV_IOMMU_DDTP_MODE_1LVL = 2,
113     RISCV_IOMMU_DDTP_MODE_2LVL = 3,
114     RISCV_IOMMU_DDTP_MODE_3LVL = 4,
115     RISCV_IOMMU_DDTP_MODE_MAX = 4
116 };
117 
118 /* 5.6 Command Queue Base (64bits) */
119 #define RISCV_IOMMU_REG_CQB             0x0018
120 #define RISCV_IOMMU_CQB_LOG2SZ          RISCV_IOMMU_QUEUE_LOGSZ_FIELD
121 #define RISCV_IOMMU_CQB_PPN             RISCV_IOMMU_PPN_FIELD
122 
123 /* 5.7 Command Queue head (32bits) */
124 #define RISCV_IOMMU_REG_CQH             0x0020
125 
126 /* 5.8 Command Queue tail (32bits) */
127 #define RISCV_IOMMU_REG_CQT             0x0024
128 
129 /* 5.9 Fault Queue Base (64bits) */
130 #define RISCV_IOMMU_REG_FQB             0x0028
131 #define RISCV_IOMMU_FQB_LOG2SZ          RISCV_IOMMU_QUEUE_LOGSZ_FIELD
132 #define RISCV_IOMMU_FQB_PPN             RISCV_IOMMU_PPN_FIELD
133 
134 /* 5.10 Fault Queue Head (32bits) */
135 #define RISCV_IOMMU_REG_FQH             0x0030
136 
137 /* 5.11 Fault Queue tail (32bits) */
138 #define RISCV_IOMMU_REG_FQT             0x0034
139 
140 /* 5.12 Page Request Queue base (64bits) */
141 #define RISCV_IOMMU_REG_PQB             0x0038
142 #define RISCV_IOMMU_PQB_LOG2SZ          RISCV_IOMMU_QUEUE_LOGSZ_FIELD
143 #define RISCV_IOMMU_PQB_PPN             RISCV_IOMMU_PPN_FIELD
144 
145 /* 5.13 Page Request Queue head (32bits) */
146 #define RISCV_IOMMU_REG_PQH             0x0040
147 
148 /* 5.14 Page Request Queue tail (32bits) */
149 #define RISCV_IOMMU_REG_PQT             0x0044
150 
151 /* 5.15 Command Queue CSR (32bits) */
152 #define RISCV_IOMMU_REG_CQCSR           0x0048
153 #define RISCV_IOMMU_CQCSR_CQEN          RISCV_IOMMU_QUEUE_ENABLE
154 #define RISCV_IOMMU_CQCSR_CIE           RISCV_IOMMU_QUEUE_INTR_ENABLE
155 #define RISCV_IOMMU_CQCSR_CQMF          RISCV_IOMMU_QUEUE_MEM_FAULT
156 #define RISCV_IOMMU_CQCSR_CMD_TO        BIT(9)
157 #define RISCV_IOMMU_CQCSR_CMD_ILL       BIT(10)
158 #define RISCV_IOMMU_CQCSR_FENCE_W_IP    BIT(11)
159 #define RISCV_IOMMU_CQCSR_CQON          RISCV_IOMMU_QUEUE_ACTIVE
160 #define RISCV_IOMMU_CQCSR_BUSY          RISCV_IOMMU_QUEUE_BUSY
161 
162 /* 5.16 Fault Queue CSR (32bits) */
163 #define RISCV_IOMMU_REG_FQCSR           0x004C
164 #define RISCV_IOMMU_FQCSR_FQEN          RISCV_IOMMU_QUEUE_ENABLE
165 #define RISCV_IOMMU_FQCSR_FIE           RISCV_IOMMU_QUEUE_INTR_ENABLE
166 #define RISCV_IOMMU_FQCSR_FQMF          RISCV_IOMMU_QUEUE_MEM_FAULT
167 #define RISCV_IOMMU_FQCSR_FQOF          RISCV_IOMMU_QUEUE_OVERFLOW
168 #define RISCV_IOMMU_FQCSR_FQON          RISCV_IOMMU_QUEUE_ACTIVE
169 #define RISCV_IOMMU_FQCSR_BUSY          RISCV_IOMMU_QUEUE_BUSY
170 
171 /* 5.17 Page Request Queue CSR (32bits) */
172 #define RISCV_IOMMU_REG_PQCSR           0x0050
173 #define RISCV_IOMMU_PQCSR_PQEN          RISCV_IOMMU_QUEUE_ENABLE
174 #define RISCV_IOMMU_PQCSR_PIE           RISCV_IOMMU_QUEUE_INTR_ENABLE
175 #define RISCV_IOMMU_PQCSR_PQMF          RISCV_IOMMU_QUEUE_MEM_FAULT
176 #define RISCV_IOMMU_PQCSR_PQOF          RISCV_IOMMU_QUEUE_OVERFLOW
177 #define RISCV_IOMMU_PQCSR_PQON          RISCV_IOMMU_QUEUE_ACTIVE
178 #define RISCV_IOMMU_PQCSR_BUSY          RISCV_IOMMU_QUEUE_BUSY
179 
180 /* 5.18 Interrupt Pending Status (32bits) */
181 #define RISCV_IOMMU_REG_IPSR            0x0054
182 #define RISCV_IOMMU_IPSR_CIP            BIT(0)
183 #define RISCV_IOMMU_IPSR_FIP            BIT(1)
184 #define RISCV_IOMMU_IPSR_PIP            BIT(3)
185 
186 enum {
187     RISCV_IOMMU_INTR_CQ,
188     RISCV_IOMMU_INTR_FQ,
189     RISCV_IOMMU_INTR_PM,
190     RISCV_IOMMU_INTR_PQ,
191     RISCV_IOMMU_INTR_COUNT
192 };
193 
194 /* 5.24 Translation request IOVA (64bits) */
195 #define RISCV_IOMMU_REG_TR_REQ_IOVA     0x0258
196 
197 /* 5.25 Translation request control (64bits) */
198 #define RISCV_IOMMU_REG_TR_REQ_CTL      0x0260
199 #define RISCV_IOMMU_TR_REQ_CTL_GO_BUSY  BIT_ULL(0)
200 #define RISCV_IOMMU_TR_REQ_CTL_NW       BIT_ULL(3)
201 #define RISCV_IOMMU_TR_REQ_CTL_PID      GENMASK_ULL(31, 12)
202 #define RISCV_IOMMU_TR_REQ_CTL_DID      GENMASK_ULL(63, 40)
203 
204 /* 5.26 Translation request response (64bits) */
205 #define RISCV_IOMMU_REG_TR_RESPONSE     0x0268
206 #define RISCV_IOMMU_TR_RESPONSE_FAULT   BIT_ULL(0)
207 #define RISCV_IOMMU_TR_RESPONSE_S       BIT_ULL(9)
208 #define RISCV_IOMMU_TR_RESPONSE_PPN     RISCV_IOMMU_PPN_FIELD
209 
210 /* 5.27 Interrupt cause to vector (64bits) */
211 #define RISCV_IOMMU_REG_ICVEC           0x02F8
212 #define RISCV_IOMMU_ICVEC_CIV           GENMASK_ULL(3, 0)
213 #define RISCV_IOMMU_ICVEC_FIV           GENMASK_ULL(7, 4)
214 #define RISCV_IOMMU_ICVEC_PMIV          GENMASK_ULL(11, 8)
215 #define RISCV_IOMMU_ICVEC_PIV           GENMASK_ULL(15, 12)
216 
217 /* 5.28 MSI Configuration table (32 * 64bits) */
218 #define RISCV_IOMMU_REG_MSI_CONFIG      0x0300
219 
220 #define RISCV_IOMMU_REG_SIZE            0x1000
221 
222 #define RISCV_IOMMU_DDTE_VALID          BIT_ULL(0)
223 #define RISCV_IOMMU_DDTE_PPN            RISCV_IOMMU_PPN_FIELD
224 
225 /* Struct riscv_iommu_dc - Device Context - section 2.1 */
226 struct riscv_iommu_dc {
227       uint64_t tc;
228       uint64_t iohgatp;
229       uint64_t ta;
230       uint64_t fsc;
231       uint64_t msiptp;
232       uint64_t msi_addr_mask;
233       uint64_t msi_addr_pattern;
234       uint64_t _reserved;
235 };
236 
237 /* Translation control fields */
238 #define RISCV_IOMMU_DC_TC_V             BIT_ULL(0)
239 #define RISCV_IOMMU_DC_TC_EN_ATS        BIT_ULL(1)
240 #define RISCV_IOMMU_DC_TC_EN_PRI        BIT_ULL(2)
241 #define RISCV_IOMMU_DC_TC_T2GPA         BIT_ULL(3)
242 #define RISCV_IOMMU_DC_TC_DTF           BIT_ULL(4)
243 #define RISCV_IOMMU_DC_TC_PDTV          BIT_ULL(5)
244 #define RISCV_IOMMU_DC_TC_PRPR          BIT_ULL(6)
245 #define RISCV_IOMMU_DC_TC_GADE          BIT_ULL(7)
246 #define RISCV_IOMMU_DC_TC_SADE          BIT_ULL(8)
247 #define RISCV_IOMMU_DC_TC_DPE           BIT_ULL(9)
248 #define RISCV_IOMMU_DC_TC_SBE           BIT_ULL(10)
249 #define RISCV_IOMMU_DC_TC_SXL           BIT_ULL(11)
250 
251 /* Second-stage (aka G-stage) context fields */
252 #define RISCV_IOMMU_DC_IOHGATP_PPN      RISCV_IOMMU_ATP_PPN_FIELD
253 #define RISCV_IOMMU_DC_IOHGATP_GSCID    GENMASK_ULL(59, 44)
254 #define RISCV_IOMMU_DC_IOHGATP_MODE     RISCV_IOMMU_ATP_MODE_FIELD
255 
256 enum riscv_iommu_dc_iohgatp_modes {
257     RISCV_IOMMU_DC_IOHGATP_MODE_BARE = 0,
258     RISCV_IOMMU_DC_IOHGATP_MODE_SV32X4 = 8,
259     RISCV_IOMMU_DC_IOHGATP_MODE_SV39X4 = 8,
260     RISCV_IOMMU_DC_IOHGATP_MODE_SV48X4 = 9,
261     RISCV_IOMMU_DC_IOHGATP_MODE_SV57X4 = 10
262 };
263 
264 /* Translation attributes fields */
265 #define RISCV_IOMMU_DC_TA_PSCID         GENMASK_ULL(31, 12)
266 
267 /* First-stage context fields */
268 #define RISCV_IOMMU_DC_FSC_PPN          RISCV_IOMMU_ATP_PPN_FIELD
269 #define RISCV_IOMMU_DC_FSC_MODE         RISCV_IOMMU_ATP_MODE_FIELD
270 
271 /* Generic I/O MMU command structure - check section 3.1 */
272 struct riscv_iommu_command {
273     uint64_t dword0;
274     uint64_t dword1;
275 };
276 
277 #define RISCV_IOMMU_CMD_OPCODE          GENMASK_ULL(6, 0)
278 #define RISCV_IOMMU_CMD_FUNC            GENMASK_ULL(9, 7)
279 
280 #define RISCV_IOMMU_CMD_IOTINVAL_OPCODE         1
281 #define RISCV_IOMMU_CMD_IOTINVAL_FUNC_VMA       0
282 #define RISCV_IOMMU_CMD_IOTINVAL_FUNC_GVMA      1
283 #define RISCV_IOMMU_CMD_IOTINVAL_AV     BIT_ULL(10)
284 #define RISCV_IOMMU_CMD_IOTINVAL_PSCID  GENMASK_ULL(31, 12)
285 #define RISCV_IOMMU_CMD_IOTINVAL_PSCV   BIT_ULL(32)
286 #define RISCV_IOMMU_CMD_IOTINVAL_GV     BIT_ULL(33)
287 #define RISCV_IOMMU_CMD_IOTINVAL_GSCID  GENMASK_ULL(59, 44)
288 
289 #define RISCV_IOMMU_CMD_IOFENCE_OPCODE          2
290 #define RISCV_IOMMU_CMD_IOFENCE_FUNC_C          0
291 #define RISCV_IOMMU_CMD_IOFENCE_AV      BIT_ULL(10)
292 #define RISCV_IOMMU_CMD_IOFENCE_DATA    GENMASK_ULL(63, 32)
293 
294 #define RISCV_IOMMU_CMD_IODIR_OPCODE            3
295 #define RISCV_IOMMU_CMD_IODIR_FUNC_INVAL_DDT    0
296 #define RISCV_IOMMU_CMD_IODIR_FUNC_INVAL_PDT    1
297 #define RISCV_IOMMU_CMD_IODIR_PID       GENMASK_ULL(31, 12)
298 #define RISCV_IOMMU_CMD_IODIR_DV        BIT_ULL(33)
299 #define RISCV_IOMMU_CMD_IODIR_DID       GENMASK_ULL(63, 40)
300 
301 /* 3.1.4 I/O MMU PCIe ATS */
302 #define RISCV_IOMMU_CMD_ATS_OPCODE              4
303 #define RISCV_IOMMU_CMD_ATS_FUNC_INVAL          0
304 #define RISCV_IOMMU_CMD_ATS_FUNC_PRGR           1
305 #define RISCV_IOMMU_CMD_ATS_PID         GENMASK_ULL(31, 12)
306 #define RISCV_IOMMU_CMD_ATS_PV          BIT_ULL(32)
307 #define RISCV_IOMMU_CMD_ATS_DSV         BIT_ULL(33)
308 #define RISCV_IOMMU_CMD_ATS_RID         GENMASK_ULL(55, 40)
309 #define RISCV_IOMMU_CMD_ATS_DSEG        GENMASK_ULL(63, 56)
310 /* dword1 is the ATS payload, two different payload types for INVAL and PRGR */
311 
312 /* ATS.PRGR payload */
313 #define RISCV_IOMMU_CMD_ATS_PRGR_RESP_CODE      GENMASK_ULL(47, 44)
314 
315 enum riscv_iommu_dc_fsc_atp_modes {
316     RISCV_IOMMU_DC_FSC_MODE_BARE = 0,
317     RISCV_IOMMU_DC_FSC_IOSATP_MODE_SV32 = 8,
318     RISCV_IOMMU_DC_FSC_IOSATP_MODE_SV39 = 8,
319     RISCV_IOMMU_DC_FSC_IOSATP_MODE_SV48 = 9,
320     RISCV_IOMMU_DC_FSC_IOSATP_MODE_SV57 = 10,
321     RISCV_IOMMU_DC_FSC_PDTP_MODE_PD8 = 1,
322     RISCV_IOMMU_DC_FSC_PDTP_MODE_PD17 = 2,
323     RISCV_IOMMU_DC_FSC_PDTP_MODE_PD20 = 3
324 };
325 
326 enum riscv_iommu_fq_causes {
327     RISCV_IOMMU_FQ_CAUSE_INST_FAULT           = 1,
328     RISCV_IOMMU_FQ_CAUSE_RD_ADDR_MISALIGNED   = 4,
329     RISCV_IOMMU_FQ_CAUSE_RD_FAULT             = 5,
330     RISCV_IOMMU_FQ_CAUSE_WR_ADDR_MISALIGNED   = 6,
331     RISCV_IOMMU_FQ_CAUSE_WR_FAULT             = 7,
332     RISCV_IOMMU_FQ_CAUSE_INST_FAULT_S         = 12,
333     RISCV_IOMMU_FQ_CAUSE_RD_FAULT_S           = 13,
334     RISCV_IOMMU_FQ_CAUSE_WR_FAULT_S           = 15,
335     RISCV_IOMMU_FQ_CAUSE_INST_FAULT_VS        = 20,
336     RISCV_IOMMU_FQ_CAUSE_RD_FAULT_VS          = 21,
337     RISCV_IOMMU_FQ_CAUSE_WR_FAULT_VS          = 23,
338     RISCV_IOMMU_FQ_CAUSE_DMA_DISABLED         = 256,
339     RISCV_IOMMU_FQ_CAUSE_DDT_LOAD_FAULT       = 257,
340     RISCV_IOMMU_FQ_CAUSE_DDT_INVALID          = 258,
341     RISCV_IOMMU_FQ_CAUSE_DDT_MISCONFIGURED    = 259,
342     RISCV_IOMMU_FQ_CAUSE_TTYPE_BLOCKED        = 260,
343     RISCV_IOMMU_FQ_CAUSE_MSI_LOAD_FAULT       = 261,
344     RISCV_IOMMU_FQ_CAUSE_MSI_INVALID          = 262,
345     RISCV_IOMMU_FQ_CAUSE_MSI_MISCONFIGURED    = 263,
346     RISCV_IOMMU_FQ_CAUSE_MRIF_FAULT           = 264,
347     RISCV_IOMMU_FQ_CAUSE_PDT_LOAD_FAULT       = 265,
348     RISCV_IOMMU_FQ_CAUSE_PDT_INVALID          = 266,
349     RISCV_IOMMU_FQ_CAUSE_PDT_MISCONFIGURED    = 267,
350     RISCV_IOMMU_FQ_CAUSE_DDT_CORRUPTED        = 268,
351     RISCV_IOMMU_FQ_CAUSE_PDT_CORRUPTED        = 269,
352     RISCV_IOMMU_FQ_CAUSE_MSI_PT_CORRUPTED     = 270,
353     RISCV_IOMMU_FQ_CAUSE_MRIF_CORRUIPTED      = 271,
354     RISCV_IOMMU_FQ_CAUSE_INTERNAL_DP_ERROR    = 272,
355     RISCV_IOMMU_FQ_CAUSE_MSI_WR_FAULT         = 273,
356     RISCV_IOMMU_FQ_CAUSE_PT_CORRUPTED         = 274
357 };
358 
359 /* MSI page table pointer */
360 #define RISCV_IOMMU_DC_MSIPTP_PPN       RISCV_IOMMU_ATP_PPN_FIELD
361 #define RISCV_IOMMU_DC_MSIPTP_MODE      RISCV_IOMMU_ATP_MODE_FIELD
362 #define RISCV_IOMMU_DC_MSIPTP_MODE_OFF  0
363 #define RISCV_IOMMU_DC_MSIPTP_MODE_FLAT 1
364 
365 /* Translation attributes fields */
366 #define RISCV_IOMMU_PC_TA_V             BIT_ULL(0)
367 #define RISCV_IOMMU_PC_TA_RESERVED      GENMASK_ULL(63, 32)
368 
369 /* First stage context fields */
370 #define RISCV_IOMMU_PC_FSC_PPN          GENMASK_ULL(43, 0)
371 #define RISCV_IOMMU_PC_FSC_RESERVED     GENMASK_ULL(59, 44)
372 
373 enum riscv_iommu_fq_ttypes {
374     RISCV_IOMMU_FQ_TTYPE_NONE = 0,
375     RISCV_IOMMU_FQ_TTYPE_UADDR_INST_FETCH = 1,
376     RISCV_IOMMU_FQ_TTYPE_UADDR_RD = 2,
377     RISCV_IOMMU_FQ_TTYPE_UADDR_WR = 3,
378     RISCV_IOMMU_FQ_TTYPE_TADDR_INST_FETCH = 5,
379     RISCV_IOMMU_FQ_TTYPE_TADDR_RD = 6,
380     RISCV_IOMMU_FQ_TTYPE_TADDR_WR = 7,
381     RISCV_IOMMU_FQ_TTYPE_PCIE_ATS_REQ = 8,
382     RISCV_IOMMU_FW_TTYPE_PCIE_MSG_REQ = 9,
383 };
384 
385 /* Header fields */
386 #define RISCV_IOMMU_PREQ_HDR_PID        GENMASK_ULL(31, 12)
387 #define RISCV_IOMMU_PREQ_HDR_PV         BIT_ULL(32)
388 #define RISCV_IOMMU_PREQ_HDR_PRIV       BIT_ULL(33)
389 #define RISCV_IOMMU_PREQ_HDR_EXEC       BIT_ULL(34)
390 #define RISCV_IOMMU_PREQ_HDR_DID        GENMASK_ULL(63, 40)
391 
392 /* Payload fields */
393 #define RISCV_IOMMU_PREQ_PAYLOAD_R      BIT_ULL(0)
394 #define RISCV_IOMMU_PREQ_PAYLOAD_W      BIT_ULL(1)
395 #define RISCV_IOMMU_PREQ_PAYLOAD_L      BIT_ULL(2)
396 #define RISCV_IOMMU_PREQ_PAYLOAD_M      GENMASK_ULL(2, 0)
397 #define RISCV_IOMMU_PREQ_PRG_INDEX      GENMASK_ULL(11, 3)
398 #define RISCV_IOMMU_PREQ_UADDR          GENMASK_ULL(63, 12)
399 
400 
401 /*
402  * struct riscv_iommu_msi_pte - MSI Page Table Entry
403  */
404 struct riscv_iommu_msi_pte {
405       uint64_t pte;
406       uint64_t mrif_info;
407 };
408 
409 /* Fields on pte */
410 #define RISCV_IOMMU_MSI_PTE_V           BIT_ULL(0)
411 #define RISCV_IOMMU_MSI_PTE_M           GENMASK_ULL(2, 1)
412 
413 #define RISCV_IOMMU_MSI_PTE_M_MRIF      1
414 #define RISCV_IOMMU_MSI_PTE_M_BASIC     3
415 
416 /* When M == 1 (MRIF mode) */
417 #define RISCV_IOMMU_MSI_PTE_MRIF_ADDR   GENMASK_ULL(53, 7)
418 /* When M == 3 (basic mode) */
419 #define RISCV_IOMMU_MSI_PTE_PPN         RISCV_IOMMU_PPN_FIELD
420 #define RISCV_IOMMU_MSI_PTE_C           BIT_ULL(63)
421 
422 /* Fields on mrif_info */
423 #define RISCV_IOMMU_MSI_MRIF_NID        GENMASK_ULL(9, 0)
424 #define RISCV_IOMMU_MSI_MRIF_NPPN       RISCV_IOMMU_PPN_FIELD
425 #define RISCV_IOMMU_MSI_MRIF_NID_MSB    BIT_ULL(60)
426 
427 #endif /* _RISCV_IOMMU_BITS_H_ */
428