xref: /openbmc/qemu/hw/intc/gicv3_internal.h (revision 3c64a42c0b3e3ca92ef1b9a9243bcee8b9a87c59)
1 /*
2  * ARM GICv3 support - internal interfaces
3  *
4  * Copyright (c) 2012 Linaro Limited
5  * Copyright (c) 2015 Huawei.
6  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
7  * Written by Peter Maydell
8  * Reworked for GICv3 by Shlomo Pongratz and Pavel Fedin
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License along
21  * with this program; if not, see <http://www.gnu.org/licenses/>.
22  */
23 
24 #ifndef QEMU_ARM_GICV3_INTERNAL_H
25 #define QEMU_ARM_GICV3_INTERNAL_H
26 
27 #include "hw/registerfields.h"
28 #include "hw/intc/arm_gicv3_common.h"
29 
30 /* Distributor registers, as offsets from the distributor base address */
31 #define GICD_CTLR            0x0000
32 #define GICD_TYPER           0x0004
33 #define GICD_IIDR            0x0008
34 #define GICD_STATUSR         0x0010
35 #define GICD_SETSPI_NSR      0x0040
36 #define GICD_CLRSPI_NSR      0x0048
37 #define GICD_SETSPI_SR       0x0050
38 #define GICD_CLRSPI_SR       0x0058
39 #define GICD_SEIR            0x0068
40 #define GICD_IGROUPR         0x0080
41 #define GICD_ISENABLER       0x0100
42 #define GICD_ICENABLER       0x0180
43 #define GICD_ISPENDR         0x0200
44 #define GICD_ICPENDR         0x0280
45 #define GICD_ISACTIVER       0x0300
46 #define GICD_ICACTIVER       0x0380
47 #define GICD_IPRIORITYR      0x0400
48 #define GICD_ITARGETSR       0x0800
49 #define GICD_ICFGR           0x0C00
50 #define GICD_IGRPMODR        0x0D00
51 #define GICD_NSACR           0x0E00
52 #define GICD_SGIR            0x0F00
53 #define GICD_CPENDSGIR       0x0F10
54 #define GICD_SPENDSGIR       0x0F20
55 #define GICD_IROUTER         0x6000
56 #define GICD_IDREGS          0xFFD0
57 
58 /* GICD_CTLR fields  */
59 #define GICD_CTLR_EN_GRP0           (1U << 0)
60 #define GICD_CTLR_EN_GRP1NS         (1U << 1) /* GICv3 5.3.20 */
61 #define GICD_CTLR_EN_GRP1S          (1U << 2)
62 #define GICD_CTLR_EN_GRP1_ALL       (GICD_CTLR_EN_GRP1NS | GICD_CTLR_EN_GRP1S)
63 /* Bit 4 is ARE if the system doesn't support TrustZone, ARE_S otherwise */
64 #define GICD_CTLR_ARE               (1U << 4)
65 #define GICD_CTLR_ARE_S             (1U << 4)
66 #define GICD_CTLR_ARE_NS            (1U << 5)
67 #define GICD_CTLR_DS                (1U << 6)
68 #define GICD_CTLR_E1NWF             (1U << 7)
69 #define GICD_CTLR_RWP               (1U << 31)
70 
71 #define GICD_TYPER_LPIS_SHIFT          17
72 
73 /* 16 bits EventId */
74 #define GICD_TYPER_IDBITS            0xf
75 
76 /*
77  * Redistributor frame offsets from RD_base
78  */
79 #define GICR_SGI_OFFSET 0x10000
80 
81 /*
82  * Redistributor registers, offsets from RD_base
83  */
84 #define GICR_CTLR             0x0000
85 #define GICR_IIDR             0x0004
86 #define GICR_TYPER            0x0008
87 #define GICR_STATUSR          0x0010
88 #define GICR_WAKER            0x0014
89 #define GICR_SETLPIR          0x0040
90 #define GICR_CLRLPIR          0x0048
91 #define GICR_PROPBASER        0x0070
92 #define GICR_PENDBASER        0x0078
93 #define GICR_INVLPIR          0x00A0
94 #define GICR_INVALLR          0x00B0
95 #define GICR_SYNCR            0x00C0
96 #define GICR_IDREGS           0xFFD0
97 
98 /* SGI and PPI Redistributor registers, offsets from RD_base */
99 #define GICR_IGROUPR0         (GICR_SGI_OFFSET + 0x0080)
100 #define GICR_ISENABLER0       (GICR_SGI_OFFSET + 0x0100)
101 #define GICR_ICENABLER0       (GICR_SGI_OFFSET + 0x0180)
102 #define GICR_ISPENDR0         (GICR_SGI_OFFSET + 0x0200)
103 #define GICR_ICPENDR0         (GICR_SGI_OFFSET + 0x0280)
104 #define GICR_ISACTIVER0       (GICR_SGI_OFFSET + 0x0300)
105 #define GICR_ICACTIVER0       (GICR_SGI_OFFSET + 0x0380)
106 #define GICR_IPRIORITYR       (GICR_SGI_OFFSET + 0x0400)
107 #define GICR_ICFGR0           (GICR_SGI_OFFSET + 0x0C00)
108 #define GICR_ICFGR1           (GICR_SGI_OFFSET + 0x0C04)
109 #define GICR_IGRPMODR0        (GICR_SGI_OFFSET + 0x0D00)
110 #define GICR_NSACR            (GICR_SGI_OFFSET + 0x0E00)
111 
112 #define GICR_CTLR_ENABLE_LPIS        (1U << 0)
113 #define GICR_CTLR_CES                (1U << 1)
114 #define GICR_CTLR_RWP                (1U << 3)
115 #define GICR_CTLR_DPG0               (1U << 24)
116 #define GICR_CTLR_DPG1NS             (1U << 25)
117 #define GICR_CTLR_DPG1S              (1U << 26)
118 #define GICR_CTLR_UWP                (1U << 31)
119 
120 #define GICR_TYPER_PLPIS             (1U << 0)
121 #define GICR_TYPER_VLPIS             (1U << 1)
122 #define GICR_TYPER_DIRECTLPI         (1U << 3)
123 #define GICR_TYPER_LAST              (1U << 4)
124 #define GICR_TYPER_DPGS              (1U << 5)
125 #define GICR_TYPER_PROCNUM           (0xFFFFU << 8)
126 #define GICR_TYPER_COMMONLPIAFF      (0x3 << 24)
127 #define GICR_TYPER_AFFINITYVALUE     (0xFFFFFFFFULL << 32)
128 
129 #define GICR_WAKER_ProcessorSleep    (1U << 1)
130 #define GICR_WAKER_ChildrenAsleep    (1U << 2)
131 
132 FIELD(GICR_PROPBASER, IDBITS, 0, 5)
133 FIELD(GICR_PROPBASER, INNERCACHE, 7, 3)
134 FIELD(GICR_PROPBASER, SHAREABILITY, 10, 2)
135 FIELD(GICR_PROPBASER, PHYADDR, 12, 40)
136 FIELD(GICR_PROPBASER, OUTERCACHE, 56, 3)
137 
138 FIELD(GICR_PENDBASER, INNERCACHE, 7, 3)
139 FIELD(GICR_PENDBASER, SHAREABILITY, 10, 2)
140 FIELD(GICR_PENDBASER, PHYADDR, 16, 36)
141 FIELD(GICR_PENDBASER, OUTERCACHE, 56, 3)
142 FIELD(GICR_PENDBASER, PTZ, 62, 1)
143 
144 #define GICR_PROPBASER_IDBITS_THRESHOLD          0xd
145 
146 #define ICC_CTLR_EL1_CBPR           (1U << 0)
147 #define ICC_CTLR_EL1_EOIMODE        (1U << 1)
148 #define ICC_CTLR_EL1_PMHE           (1U << 6)
149 #define ICC_CTLR_EL1_PRIBITS_SHIFT 8
150 #define ICC_CTLR_EL1_PRIBITS_MASK   (7U << ICC_CTLR_EL1_PRIBITS_SHIFT)
151 #define ICC_CTLR_EL1_IDBITS_SHIFT 11
152 #define ICC_CTLR_EL1_SEIS           (1U << 14)
153 #define ICC_CTLR_EL1_A3V            (1U << 15)
154 
155 #define ICC_PMR_PRIORITY_MASK    0xff
156 #define ICC_BPR_BINARYPOINT_MASK 0x07
157 #define ICC_IGRPEN_ENABLE        0x01
158 
159 #define ICC_CTLR_EL3_CBPR_EL1S (1U << 0)
160 #define ICC_CTLR_EL3_CBPR_EL1NS (1U << 1)
161 #define ICC_CTLR_EL3_EOIMODE_EL3 (1U << 2)
162 #define ICC_CTLR_EL3_EOIMODE_EL1S (1U << 3)
163 #define ICC_CTLR_EL3_EOIMODE_EL1NS (1U << 4)
164 #define ICC_CTLR_EL3_RM (1U << 5)
165 #define ICC_CTLR_EL3_PMHE (1U << 6)
166 #define ICC_CTLR_EL3_PRIBITS_SHIFT 8
167 #define ICC_CTLR_EL3_IDBITS_SHIFT 11
168 #define ICC_CTLR_EL3_SEIS (1U << 14)
169 #define ICC_CTLR_EL3_A3V (1U << 15)
170 #define ICC_CTLR_EL3_NDS (1U << 17)
171 
172 #define ICH_VMCR_EL2_VENG0_SHIFT 0
173 #define ICH_VMCR_EL2_VENG0 (1U << ICH_VMCR_EL2_VENG0_SHIFT)
174 #define ICH_VMCR_EL2_VENG1_SHIFT 1
175 #define ICH_VMCR_EL2_VENG1 (1U << ICH_VMCR_EL2_VENG1_SHIFT)
176 #define ICH_VMCR_EL2_VACKCTL (1U << 2)
177 #define ICH_VMCR_EL2_VFIQEN (1U << 3)
178 #define ICH_VMCR_EL2_VCBPR_SHIFT 4
179 #define ICH_VMCR_EL2_VCBPR (1U << ICH_VMCR_EL2_VCBPR_SHIFT)
180 #define ICH_VMCR_EL2_VEOIM_SHIFT 9
181 #define ICH_VMCR_EL2_VEOIM (1U << ICH_VMCR_EL2_VEOIM_SHIFT)
182 #define ICH_VMCR_EL2_VBPR1_SHIFT 18
183 #define ICH_VMCR_EL2_VBPR1_LENGTH 3
184 #define ICH_VMCR_EL2_VBPR1_MASK (0x7U << ICH_VMCR_EL2_VBPR1_SHIFT)
185 #define ICH_VMCR_EL2_VBPR0_SHIFT 21
186 #define ICH_VMCR_EL2_VBPR0_LENGTH 3
187 #define ICH_VMCR_EL2_VBPR0_MASK (0x7U << ICH_VMCR_EL2_VBPR0_SHIFT)
188 #define ICH_VMCR_EL2_VPMR_SHIFT 24
189 #define ICH_VMCR_EL2_VPMR_LENGTH 8
190 #define ICH_VMCR_EL2_VPMR_MASK (0xffU << ICH_VMCR_EL2_VPMR_SHIFT)
191 
192 #define ICH_HCR_EL2_EN (1U << 0)
193 #define ICH_HCR_EL2_UIE (1U << 1)
194 #define ICH_HCR_EL2_LRENPIE (1U << 2)
195 #define ICH_HCR_EL2_NPIE (1U << 3)
196 #define ICH_HCR_EL2_VGRP0EIE (1U << 4)
197 #define ICH_HCR_EL2_VGRP0DIE (1U << 5)
198 #define ICH_HCR_EL2_VGRP1EIE (1U << 6)
199 #define ICH_HCR_EL2_VGRP1DIE (1U << 7)
200 #define ICH_HCR_EL2_TC (1U << 10)
201 #define ICH_HCR_EL2_TALL0 (1U << 11)
202 #define ICH_HCR_EL2_TALL1 (1U << 12)
203 #define ICH_HCR_EL2_TSEI (1U << 13)
204 #define ICH_HCR_EL2_TDIR (1U << 14)
205 #define ICH_HCR_EL2_EOICOUNT_SHIFT 27
206 #define ICH_HCR_EL2_EOICOUNT_LENGTH 5
207 #define ICH_HCR_EL2_EOICOUNT_MASK (0x1fU << ICH_HCR_EL2_EOICOUNT_SHIFT)
208 
209 #define ICH_LR_EL2_VINTID_SHIFT 0
210 #define ICH_LR_EL2_VINTID_LENGTH 32
211 #define ICH_LR_EL2_VINTID_MASK (0xffffffffULL << ICH_LR_EL2_VINTID_SHIFT)
212 #define ICH_LR_EL2_PINTID_SHIFT 32
213 #define ICH_LR_EL2_PINTID_LENGTH 10
214 #define ICH_LR_EL2_PINTID_MASK (0x3ffULL << ICH_LR_EL2_PINTID_SHIFT)
215 /* Note that EOI shares with the top bit of the pINTID field */
216 #define ICH_LR_EL2_EOI (1ULL << 41)
217 #define ICH_LR_EL2_PRIORITY_SHIFT 48
218 #define ICH_LR_EL2_PRIORITY_LENGTH 8
219 #define ICH_LR_EL2_PRIORITY_MASK (0xffULL << ICH_LR_EL2_PRIORITY_SHIFT)
220 #define ICH_LR_EL2_GROUP (1ULL << 60)
221 #define ICH_LR_EL2_HW (1ULL << 61)
222 #define ICH_LR_EL2_STATE_SHIFT 62
223 #define ICH_LR_EL2_STATE_LENGTH 2
224 #define ICH_LR_EL2_STATE_MASK (3ULL << ICH_LR_EL2_STATE_SHIFT)
225 /* values for the state field: */
226 #define ICH_LR_EL2_STATE_INVALID 0
227 #define ICH_LR_EL2_STATE_PENDING 1
228 #define ICH_LR_EL2_STATE_ACTIVE 2
229 #define ICH_LR_EL2_STATE_ACTIVE_PENDING 3
230 #define ICH_LR_EL2_STATE_PENDING_BIT (1ULL << ICH_LR_EL2_STATE_SHIFT)
231 #define ICH_LR_EL2_STATE_ACTIVE_BIT (2ULL << ICH_LR_EL2_STATE_SHIFT)
232 
233 #define ICH_MISR_EL2_EOI (1U << 0)
234 #define ICH_MISR_EL2_U (1U << 1)
235 #define ICH_MISR_EL2_LRENP (1U << 2)
236 #define ICH_MISR_EL2_NP (1U << 3)
237 #define ICH_MISR_EL2_VGRP0E (1U << 4)
238 #define ICH_MISR_EL2_VGRP0D (1U << 5)
239 #define ICH_MISR_EL2_VGRP1E (1U << 6)
240 #define ICH_MISR_EL2_VGRP1D (1U << 7)
241 
242 #define ICH_VTR_EL2_LISTREGS_SHIFT 0
243 #define ICH_VTR_EL2_TDS (1U << 19)
244 #define ICH_VTR_EL2_NV4 (1U << 20)
245 #define ICH_VTR_EL2_A3V (1U << 21)
246 #define ICH_VTR_EL2_SEIS (1U << 22)
247 #define ICH_VTR_EL2_IDBITS_SHIFT 23
248 #define ICH_VTR_EL2_PREBITS_SHIFT 26
249 #define ICH_VTR_EL2_PRIBITS_SHIFT 29
250 
251 /* ITS Registers */
252 
253 FIELD(GITS_BASER, SIZE, 0, 8)
254 FIELD(GITS_BASER, PAGESIZE, 8, 2)
255 FIELD(GITS_BASER, SHAREABILITY, 10, 2)
256 FIELD(GITS_BASER, PHYADDR, 12, 36)
257 FIELD(GITS_BASER, PHYADDRL_64K, 16, 32)
258 FIELD(GITS_BASER, PHYADDRH_64K, 12, 4)
259 FIELD(GITS_BASER, ENTRYSIZE, 48, 5)
260 FIELD(GITS_BASER, OUTERCACHE, 53, 3)
261 FIELD(GITS_BASER, TYPE, 56, 3)
262 FIELD(GITS_BASER, INNERCACHE, 59, 3)
263 FIELD(GITS_BASER, INDIRECT, 62, 1)
264 FIELD(GITS_BASER, VALID, 63, 1)
265 
266 FIELD(GITS_CBASER, SIZE, 0, 8)
267 FIELD(GITS_CBASER, SHAREABILITY, 10, 2)
268 FIELD(GITS_CBASER, PHYADDR, 12, 40)
269 FIELD(GITS_CBASER, OUTERCACHE, 53, 3)
270 FIELD(GITS_CBASER, INNERCACHE, 59, 3)
271 FIELD(GITS_CBASER, VALID, 63, 1)
272 
273 FIELD(GITS_CREADR, STALLED, 0, 1)
274 FIELD(GITS_CREADR, OFFSET, 5, 15)
275 
276 FIELD(GITS_CWRITER, RETRY, 0, 1)
277 FIELD(GITS_CWRITER, OFFSET, 5, 15)
278 
279 FIELD(GITS_CTLR, ENABLED, 0, 1)
280 FIELD(GITS_CTLR, QUIESCENT, 31, 1)
281 
282 FIELD(GITS_TYPER, PHYSICAL, 0, 1)
283 FIELD(GITS_TYPER, VIRTUAL, 1, 1)
284 FIELD(GITS_TYPER, ITT_ENTRY_SIZE, 4, 4)
285 FIELD(GITS_TYPER, IDBITS, 8, 5)
286 FIELD(GITS_TYPER, DEVBITS, 13, 5)
287 FIELD(GITS_TYPER, SEIS, 18, 1)
288 FIELD(GITS_TYPER, PTA, 19, 1)
289 FIELD(GITS_TYPER, CIDBITS, 32, 4)
290 FIELD(GITS_TYPER, CIL, 36, 1)
291 
292 #define GITS_IDREGS           0xFFD0
293 
294 #define GITS_BASER_RO_MASK                  (R_GITS_BASER_ENTRYSIZE_MASK | \
295                                               R_GITS_BASER_TYPE_MASK)
296 
297 #define GITS_BASER_PAGESIZE_4K                0
298 #define GITS_BASER_PAGESIZE_16K               1
299 #define GITS_BASER_PAGESIZE_64K               2
300 
301 #define GITS_BASER_TYPE_DEVICE               1ULL
302 #define GITS_BASER_TYPE_VPE                  2ULL
303 #define GITS_BASER_TYPE_COLLECTION           4ULL
304 
305 #define GITS_PAGE_SIZE_4K       0x1000
306 #define GITS_PAGE_SIZE_16K      0x4000
307 #define GITS_PAGE_SIZE_64K      0x10000
308 
309 #define L1TABLE_ENTRY_SIZE         8
310 
311 #define LPI_CTE_ENABLED          TABLE_ENTRY_VALID_MASK
312 #define LPI_PRIORITY_MASK         0xfc
313 
314 #define GITS_CMDQ_ENTRY_WORDS 4
315 #define GITS_CMDQ_ENTRY_SIZE  (GITS_CMDQ_ENTRY_WORDS * sizeof(uint64_t))
316 
317 #define CMD_MASK                  0xff
318 
319 /* ITS Commands */
320 #define GITS_CMD_MOVI             0x01
321 #define GITS_CMD_INT              0x03
322 #define GITS_CMD_CLEAR            0x04
323 #define GITS_CMD_SYNC             0x05
324 #define GITS_CMD_MAPD             0x08
325 #define GITS_CMD_MAPC             0x09
326 #define GITS_CMD_MAPTI            0x0A
327 #define GITS_CMD_MAPI             0x0B
328 #define GITS_CMD_INV              0x0C
329 #define GITS_CMD_INVALL           0x0D
330 #define GITS_CMD_MOVALL           0x0E
331 #define GITS_CMD_DISCARD          0x0F
332 #define GITS_CMD_VMOVI            0x21
333 #define GITS_CMD_VMOVP            0x22
334 #define GITS_CMD_VSYNC            0x25
335 #define GITS_CMD_VMAPP            0x29
336 #define GITS_CMD_VMAPTI           0x2A
337 #define GITS_CMD_VMAPI            0x2B
338 
339 /* MAPC command fields */
340 #define ICID_LENGTH                  16
341 #define ICID_MASK                 ((1U << ICID_LENGTH) - 1)
342 FIELD(MAPC, RDBASE, 16, 32)
343 
344 #define RDBASE_PROCNUM_LENGTH        16
345 #define RDBASE_PROCNUM_MASK       ((1ULL << RDBASE_PROCNUM_LENGTH) - 1)
346 
347 /* MAPD command fields */
348 #define ITTADDR_LENGTH               44
349 #define ITTADDR_SHIFT                 8
350 #define ITTADDR_MASK             MAKE_64BIT_MASK(ITTADDR_SHIFT, ITTADDR_LENGTH)
351 #define SIZE_MASK                 0x1f
352 
353 /* MAPI command fields */
354 #define EVENTID_MASK              ((1ULL << 32) - 1)
355 
356 /* MAPTI command fields */
357 #define pINTID_SHIFT                 32
358 #define pINTID_MASK               MAKE_64BIT_MASK(32, 32)
359 
360 #define DEVID_SHIFT                  32
361 #define DEVID_MASK                MAKE_64BIT_MASK(32, 32)
362 
363 #define VALID_SHIFT               63
364 #define CMD_FIELD_VALID_MASK      (1ULL << VALID_SHIFT)
365 #define L2_TABLE_VALID_MASK       CMD_FIELD_VALID_MASK
366 #define TABLE_ENTRY_VALID_MASK    (1ULL << 0)
367 
368 /* MOVALL command fields */
369 FIELD(MOVALL_2, RDBASE1, 16, 36)
370 FIELD(MOVALL_3, RDBASE2, 16, 36)
371 
372 /* MOVI command fields */
373 FIELD(MOVI_0, DEVICEID, 32, 32)
374 FIELD(MOVI_1, EVENTID, 0, 32)
375 FIELD(MOVI_2, ICID, 0, 16)
376 
377 /* INV command fields */
378 FIELD(INV_0, DEVICEID, 32, 32)
379 FIELD(INV_1, EVENTID, 0, 32)
380 
381 /* VMAPI, VMAPTI command fields */
382 FIELD(VMAPTI_0, DEVICEID, 32, 32)
383 FIELD(VMAPTI_1, EVENTID, 0, 32)
384 FIELD(VMAPTI_1, VPEID, 32, 16)
385 FIELD(VMAPTI_2, VINTID, 0, 32) /* VMAPTI only */
386 FIELD(VMAPTI_2, DOORBELL, 32, 32)
387 
388 /* VMAPP command fields */
389 FIELD(VMAPP_0, ALLOC, 8, 1) /* GICv4.1 only */
390 FIELD(VMAPP_0, PTZ, 9, 1) /* GICv4.1 only */
391 FIELD(VMAPP_0, VCONFADDR, 16, 36) /* GICv4.1 only */
392 FIELD(VMAPP_1, DEFAULT_DOORBELL, 0, 32) /* GICv4.1 only */
393 FIELD(VMAPP_1, VPEID, 32, 16)
394 FIELD(VMAPP_2, RDBASE, 16, 36)
395 FIELD(VMAPP_2, V, 63, 1)
396 FIELD(VMAPP_3, VPTSIZE, 0, 8) /* For GICv4.0, bits [7:6] are RES0 */
397 FIELD(VMAPP_3, VPTADDR, 16, 36)
398 
399 /* VMOVP command fields */
400 FIELD(VMOVP_0, SEQNUM, 32, 16) /* not used for GITS_TYPER.VMOVP == 1 */
401 FIELD(VMOVP_1, ITSLIST, 0, 16) /* not used for GITS_TYPER.VMOVP == 1 */
402 FIELD(VMOVP_1, VPEID, 32, 16)
403 FIELD(VMOVP_2, RDBASE, 16, 36)
404 FIELD(VMOVP_2, DB, 63, 1) /* GICv4.1 only */
405 FIELD(VMOVP_3, DEFAULT_DOORBELL, 0, 32) /* GICv4.1 only */
406 
407 /* VMOVI command fields */
408 FIELD(VMOVI_0, DEVICEID, 32, 32)
409 FIELD(VMOVI_1, EVENTID, 0, 32)
410 FIELD(VMOVI_1, VPEID, 32, 16)
411 FIELD(VMOVI_2, D, 0, 1)
412 FIELD(VMOVI_2, DOORBELL, 32, 32)
413 
414 /*
415  * 12 bytes Interrupt translation Table Entry size
416  * as per Table 5.3 in GICv3 spec
417  * ITE Lower 8 Bytes
418  *   Bits:    | 63 ... 48 | 47 ... 32 | 31 ... 26 | 25 ... 2 |   1     |  0    |
419  *   Values:  | vPEID     | ICID      | unused    |  IntNum  | IntType | Valid |
420  * ITE Higher 4 Bytes
421  *   Bits:    | 31 ... 25 | 24 ... 0 |
422  *   Values:  | unused    | Doorbell |
423  * (When Doorbell is unused, as it always is for INTYPE_PHYSICAL,
424  * the value of that field in memory cannot be relied upon -- older
425  * versions of QEMU did not correctly write to that memory.)
426  */
427 #define ITS_ITT_ENTRY_SIZE            0xC
428 
429 FIELD(ITE_L, VALID, 0, 1)
430 FIELD(ITE_L, INTTYPE, 1, 1)
431 FIELD(ITE_L, INTID, 2, 24)
432 FIELD(ITE_L, ICID, 32, 16)
433 FIELD(ITE_L, VPEID, 48, 16)
434 FIELD(ITE_H, DOORBELL, 0, 24)
435 
436 /* Possible values for ITE_L INTTYPE */
437 #define ITE_INTTYPE_VIRTUAL 0
438 #define ITE_INTTYPE_PHYSICAL 1
439 
440 /* 16 bits EventId */
441 #define ITS_IDBITS                   GICD_TYPER_IDBITS
442 
443 /* 16 bits DeviceId */
444 #define ITS_DEVBITS                   0xF
445 
446 /* 16 bits CollectionId */
447 #define ITS_CIDBITS                  0xF
448 
449 /*
450  * 8 bytes Device Table Entry size
451  * Valid = 1 bit,ITTAddr = 44 bits,Size = 5 bits
452  */
453 #define GITS_DTE_SIZE                 (0x8ULL)
454 
455 FIELD(DTE, VALID, 0, 1)
456 FIELD(DTE, SIZE, 1, 5)
457 FIELD(DTE, ITTADDR, 6, 44)
458 
459 /*
460  * 8 bytes Collection Table Entry size
461  * Valid = 1 bit, RDBase = 16 bits
462  */
463 #define GITS_CTE_SIZE                 (0x8ULL)
464 FIELD(CTE, VALID, 0, 1)
465 FIELD(CTE, RDBASE, 1, RDBASE_PROCNUM_LENGTH)
466 
467 /*
468  * 8 bytes VPE table entry size:
469  * Valid = 1 bit, VPTsize = 5 bits, VPTaddr = 36 bits, RDbase = 16 bits
470  *
471  * Field sizes for Valid and size are mandated; field sizes for RDbase
472  * and VPT_addr are IMPDEF.
473  */
474 #define GITS_VPE_SIZE 0x8ULL
475 
476 FIELD(VTE, VALID, 0, 1)
477 FIELD(VTE, VPTSIZE, 1, 5)
478 FIELD(VTE, VPTADDR, 6, 36)
479 FIELD(VTE, RDBASE, 42, RDBASE_PROCNUM_LENGTH)
480 
481 /* Special interrupt IDs */
482 #define INTID_SECURE 1020
483 #define INTID_NONSECURE 1021
484 #define INTID_SPURIOUS 1023
485 
486 /* Functions internal to the emulated GICv3 */
487 
488 /**
489  * gicv3_intid_is_special:
490  * @intid: interrupt ID
491  *
492  * Return true if @intid is a special interrupt ID (1020 to
493  * 1023 inclusive). This corresponds to the GIC spec pseudocode
494  * IsSpecial() function.
495  */
496 static inline bool gicv3_intid_is_special(int intid)
497 {
498     return intid >= INTID_SECURE && intid <= INTID_SPURIOUS;
499 }
500 
501 /**
502  * gicv3_redist_update:
503  * @cs: GICv3CPUState for this redistributor
504  *
505  * Recalculate the highest priority pending interrupt after a
506  * change to redistributor state, and inform the CPU accordingly.
507  */
508 void gicv3_redist_update(GICv3CPUState *cs);
509 
510 /**
511  * gicv3_update:
512  * @s: GICv3State
513  * @start: first interrupt whose state changed
514  * @len: length of the range of interrupts whose state changed
515  *
516  * Recalculate the highest priority pending interrupts after a
517  * change to the distributor state affecting @len interrupts
518  * starting at @start, and inform the CPUs accordingly.
519  */
520 void gicv3_update(GICv3State *s, int start, int len);
521 
522 /**
523  * gicv3_full_update_noirqset:
524  * @s: GICv3State
525  *
526  * Recalculate the cached information about highest priority
527  * pending interrupts, but don't inform the CPUs. This should be
528  * called after an incoming migration has loaded new state.
529  */
530 void gicv3_full_update_noirqset(GICv3State *s);
531 
532 /**
533  * gicv3_full_update:
534  * @s: GICv3State
535  *
536  * Recalculate the highest priority pending interrupts after
537  * a change that could affect the status of all interrupts,
538  * and inform the CPUs accordingly.
539  */
540 void gicv3_full_update(GICv3State *s);
541 MemTxResult gicv3_dist_read(void *opaque, hwaddr offset, uint64_t *data,
542                             unsigned size, MemTxAttrs attrs);
543 MemTxResult gicv3_dist_write(void *opaque, hwaddr addr, uint64_t data,
544                              unsigned size, MemTxAttrs attrs);
545 MemTxResult gicv3_redist_read(void *opaque, hwaddr offset, uint64_t *data,
546                               unsigned size, MemTxAttrs attrs);
547 MemTxResult gicv3_redist_write(void *opaque, hwaddr offset, uint64_t data,
548                                unsigned size, MemTxAttrs attrs);
549 void gicv3_dist_set_irq(GICv3State *s, int irq, int level);
550 void gicv3_redist_set_irq(GICv3CPUState *cs, int irq, int level);
551 void gicv3_redist_process_lpi(GICv3CPUState *cs, int irq, int level);
552 /**
553  * gicv3_redist_process_vlpi:
554  * @cs: GICv3CPUState
555  * @irq: (virtual) interrupt number
556  * @vptaddr: (guest) address of VLPI table
557  * @doorbell: doorbell (physical) interrupt number (1023 for "no doorbell")
558  * @level: level to set @irq to
559  *
560  * Process a virtual LPI being directly injected by the ITS. This function
561  * will update the VLPI table specified by @vptaddr and @vptsize. If the
562  * vCPU corresponding to that VLPI table is currently running on
563  * the CPU associated with this redistributor, directly inject the VLPI
564  * @irq. If the vCPU is not running on this CPU, raise the doorbell
565  * interrupt instead.
566  */
567 void gicv3_redist_process_vlpi(GICv3CPUState *cs, int irq, uint64_t vptaddr,
568                                int doorbell, int level);
569 void gicv3_redist_lpi_pending(GICv3CPUState *cs, int irq, int level);
570 /**
571  * gicv3_redist_update_lpi:
572  * @cs: GICv3CPUState
573  *
574  * Scan the LPI pending table and recalculate the highest priority
575  * pending LPI and also the overall highest priority pending interrupt.
576  */
577 void gicv3_redist_update_lpi(GICv3CPUState *cs);
578 /**
579  * gicv3_redist_update_lpi_only:
580  * @cs: GICv3CPUState
581  *
582  * Scan the LPI pending table and recalculate cs->hpplpi only,
583  * without calling gicv3_redist_update() to recalculate the overall
584  * highest priority pending interrupt. This should be called after
585  * an incoming migration has loaded new state.
586  */
587 void gicv3_redist_update_lpi_only(GICv3CPUState *cs);
588 /**
589  * gicv3_redist_inv_lpi:
590  * @cs: GICv3CPUState
591  * @irq: LPI to invalidate cached information for
592  *
593  * Forget or update any cached information associated with this LPI.
594  */
595 void gicv3_redist_inv_lpi(GICv3CPUState *cs, int irq);
596 /**
597  * gicv3_redist_inv_vlpi:
598  * @cs: GICv3CPUState
599  * @irq: vLPI to invalidate cached information for
600  * @vptaddr: (guest) address of vLPI table
601  *
602  * Forget or update any cached information associated with this vLPI.
603  */
604 void gicv3_redist_inv_vlpi(GICv3CPUState *cs, int irq, uint64_t vptaddr);
605 /**
606  * gicv3_redist_mov_lpi:
607  * @src: source redistributor
608  * @dest: destination redistributor
609  * @irq: LPI to update
610  *
611  * Move the pending state of the specified LPI from @src to @dest,
612  * as required by the ITS MOVI command.
613  */
614 void gicv3_redist_mov_lpi(GICv3CPUState *src, GICv3CPUState *dest, int irq);
615 /**
616  * gicv3_redist_movall_lpis:
617  * @src: source redistributor
618  * @dest: destination redistributor
619  *
620  * Scan the LPI pending table for @src, and for each pending LPI there
621  * mark it as not-pending for @src and pending for @dest, as required
622  * by the ITS MOVALL command.
623  */
624 void gicv3_redist_movall_lpis(GICv3CPUState *src, GICv3CPUState *dest);
625 /**
626  * gicv3_redist_mov_vlpi:
627  * @src: source redistributor
628  * @src_vptaddr: (guest) address of source VLPI table
629  * @dest: destination redistributor
630  * @dest_vptaddr: (guest) address of destination VLPI table
631  * @irq: VLPI to update
632  * @doorbell: doorbell for destination (1023 for "no doorbell")
633  *
634  * Move the pending state of the specified VLPI from @src to @dest,
635  * as required by the ITS VMOVI command.
636  */
637 void gicv3_redist_mov_vlpi(GICv3CPUState *src, uint64_t src_vptaddr,
638                            GICv3CPUState *dest, uint64_t dest_vptaddr,
639                            int irq, int doorbell);
640 
641 void gicv3_redist_send_sgi(GICv3CPUState *cs, int grp, int irq, bool ns);
642 void gicv3_init_cpuif(GICv3State *s);
643 
644 /**
645  * gicv3_cpuif_update:
646  * @cs: GICv3CPUState for the CPU to update
647  *
648  * Recalculate whether to assert the IRQ or FIQ lines after a change
649  * to the current highest priority pending interrupt, the CPU's
650  * current running priority or the CPU's current exception level or
651  * security state.
652  */
653 void gicv3_cpuif_update(GICv3CPUState *cs);
654 
655 static inline uint32_t gicv3_iidr(void)
656 {
657     /* Return the Implementer Identification Register value
658      * for the emulated GICv3, as reported in GICD_IIDR and GICR_IIDR.
659      *
660      * We claim to be an ARM r0p0 with a zero ProductID.
661      * This is the same as an r0p0 GIC-500.
662      */
663     return 0x43b;
664 }
665 
666 /* CoreSight PIDR0 values for ARM GICv3 implementations */
667 #define GICV3_PIDR0_DIST 0x92
668 #define GICV3_PIDR0_REDIST 0x93
669 #define GICV3_PIDR0_ITS 0x94
670 
671 static inline uint32_t gicv3_idreg(int regoffset, uint8_t pidr0)
672 {
673     /* Return the value of the CoreSight ID register at the specified
674      * offset from the first ID register (as found in the distributor
675      * and redistributor register banks).
676      * These values indicate an ARM implementation of a GICv3.
677      */
678     static const uint8_t gicd_ids[] = {
679         0x44, 0x00, 0x00, 0x00, 0x92, 0xB4, 0x3B, 0x00, 0x0D, 0xF0, 0x05, 0xB1
680     };
681 
682     regoffset /= 4;
683 
684     if (regoffset == 4) {
685         return pidr0;
686     }
687     return gicd_ids[regoffset];
688 }
689 
690 /**
691  * gicv3_irq_group:
692  *
693  * Return the group which this interrupt is configured as (GICV3_G0,
694  * GICV3_G1 or GICV3_G1NS).
695  */
696 static inline int gicv3_irq_group(GICv3State *s, GICv3CPUState *cs, int irq)
697 {
698     bool grpbit, grpmodbit;
699 
700     if (irq < GIC_INTERNAL) {
701         grpbit = extract32(cs->gicr_igroupr0, irq, 1);
702         grpmodbit = extract32(cs->gicr_igrpmodr0, irq, 1);
703     } else {
704         grpbit = gicv3_gicd_group_test(s, irq);
705         grpmodbit = gicv3_gicd_grpmod_test(s, irq);
706     }
707     if (grpbit) {
708         return GICV3_G1NS;
709     }
710     if (s->gicd_ctlr & GICD_CTLR_DS) {
711         return GICV3_G0;
712     }
713     return grpmodbit ? GICV3_G1 : GICV3_G0;
714 }
715 
716 /**
717  * gicv3_redist_affid:
718  *
719  * Return the 32-bit affinity ID of the CPU connected to this redistributor
720  */
721 static inline uint32_t gicv3_redist_affid(GICv3CPUState *cs)
722 {
723     return cs->gicr_typer >> 32;
724 }
725 
726 /**
727  * gicv3_cache_target_cpustate:
728  *
729  * Update the cached CPU state corresponding to the target for this interrupt
730  * (which is kept in s->gicd_irouter_target[]).
731  */
732 static inline void gicv3_cache_target_cpustate(GICv3State *s, int irq)
733 {
734     GICv3CPUState *cs = NULL;
735     int i;
736     uint32_t tgtaff = extract64(s->gicd_irouter[irq], 0, 24) |
737         extract64(s->gicd_irouter[irq], 32, 8) << 24;
738 
739     for (i = 0; i < s->num_cpu; i++) {
740         if (s->cpu[i].gicr_typer >> 32 == tgtaff) {
741             cs = &s->cpu[i];
742             break;
743         }
744     }
745 
746     s->gicd_irouter_target[irq] = cs;
747 }
748 
749 /**
750  * gicv3_cache_all_target_cpustates:
751  *
752  * Populate the entire cache of CPU state pointers for interrupt targets
753  * (eg after inbound migration or CPU reset)
754  */
755 static inline void gicv3_cache_all_target_cpustates(GICv3State *s)
756 {
757     int irq;
758 
759     for (irq = GIC_INTERNAL; irq < GICV3_MAXIRQ; irq++) {
760         gicv3_cache_target_cpustate(s, irq);
761     }
762 }
763 
764 void gicv3_set_gicv3state(CPUState *cpu, GICv3CPUState *s);
765 
766 #endif /* QEMU_ARM_GICV3_INTERNAL_H */
767