xref: /openbmc/qemu/hw/intc/arm_gicv3_its.c (revision 469cf23bf857412e45bb480eabd8f0cd890b41b1)
1 /*
2  * ITS emulation for a GICv3-based system
3  *
4  * Copyright Linaro.org 2021
5  *
6  * Authors:
7  *  Shashi Mallela <shashi.mallela@linaro.org>
8  *
9  * This work is licensed under the terms of the GNU GPL, version 2 or (at your
10  * option) any later version.  See the COPYING file in the top-level directory.
11  *
12  */
13 
14 #include "qemu/osdep.h"
15 #include "qemu/log.h"
16 #include "trace.h"
17 #include "hw/qdev-properties.h"
18 #include "hw/intc/arm_gicv3_its_common.h"
19 #include "gicv3_internal.h"
20 #include "qom/object.h"
21 #include "qapi/error.h"
22 
23 typedef struct GICv3ITSClass GICv3ITSClass;
24 /* This is reusing the GICv3ITSState typedef from ARM_GICV3_ITS_COMMON */
25 DECLARE_OBJ_CHECKERS(GICv3ITSState, GICv3ITSClass,
26                      ARM_GICV3_ITS, TYPE_ARM_GICV3_ITS)
27 
28 struct GICv3ITSClass {
29     GICv3ITSCommonClass parent_class;
30     void (*parent_reset)(DeviceState *dev);
31 };
32 
33 /*
34  * This is an internal enum used to distinguish between LPI triggered
35  * via command queue and LPI triggered via gits_translater write.
36  */
37 typedef enum ItsCmdType {
38     NONE = 0, /* internal indication for GITS_TRANSLATER write */
39     CLEAR = 1,
40     DISCARD = 2,
41     INTERRUPT = 3,
42 } ItsCmdType;
43 
44 typedef struct DTEntry {
45     bool valid;
46     unsigned size;
47     uint64_t ittaddr;
48 } DTEntry;
49 
50 typedef struct CTEntry {
51     bool valid;
52     uint32_t rdbase;
53 } CTEntry;
54 
55 typedef struct ITEntry {
56     bool valid;
57     int inttype;
58     uint32_t intid;
59     uint32_t doorbell;
60     uint32_t icid;
61     uint32_t vpeid;
62 } ITEntry;
63 
64 typedef struct VTEntry {
65     bool valid;
66     unsigned vptsize;
67     uint32_t rdbase;
68     uint64_t vptaddr;
69 } VTEntry;
70 
71 /*
72  * The ITS spec permits a range of CONSTRAINED UNPREDICTABLE options
73  * if a command parameter is not correct. These include both "stall
74  * processing of the command queue" and "ignore this command, and
75  * keep processing the queue". In our implementation we choose that
76  * memory transaction errors reading the command packet provoke a
77  * stall, but errors in parameters cause us to ignore the command
78  * and continue processing.
79  * The process_* functions which handle individual ITS commands all
80  * return an ItsCmdResult which tells process_cmdq() whether it should
81  * stall, keep going because of an error, or keep going because the
82  * command was a success.
83  */
84 typedef enum ItsCmdResult {
85     CMD_STALL = 0,
86     CMD_CONTINUE = 1,
87     CMD_CONTINUE_OK = 2,
88 } ItsCmdResult;
89 
90 /* True if the ITS supports the GICv4 virtual LPI feature */
91 static bool its_feature_virtual(GICv3ITSState *s)
92 {
93     return s->typer & R_GITS_TYPER_VIRTUAL_MASK;
94 }
95 
96 static inline bool intid_in_lpi_range(uint32_t id)
97 {
98     return id >= GICV3_LPI_INTID_START &&
99         id < (1 << (GICD_TYPER_IDBITS + 1));
100 }
101 
102 static inline bool valid_doorbell(uint32_t id)
103 {
104     /* Doorbell fields may be an LPI, or 1023 to mean "no doorbell" */
105     return id == INTID_SPURIOUS || intid_in_lpi_range(id);
106 }
107 
108 static uint64_t baser_base_addr(uint64_t value, uint32_t page_sz)
109 {
110     uint64_t result = 0;
111 
112     switch (page_sz) {
113     case GITS_PAGE_SIZE_4K:
114     case GITS_PAGE_SIZE_16K:
115         result = FIELD_EX64(value, GITS_BASER, PHYADDR) << 12;
116         break;
117 
118     case GITS_PAGE_SIZE_64K:
119         result = FIELD_EX64(value, GITS_BASER, PHYADDRL_64K) << 16;
120         result |= FIELD_EX64(value, GITS_BASER, PHYADDRH_64K) << 48;
121         break;
122 
123     default:
124         break;
125     }
126     return result;
127 }
128 
129 static uint64_t table_entry_addr(GICv3ITSState *s, TableDesc *td,
130                                  uint32_t idx, MemTxResult *res)
131 {
132     /*
133      * Given a TableDesc describing one of the ITS in-guest-memory
134      * tables and an index into it, return the guest address
135      * corresponding to that table entry.
136      * If there was a memory error reading the L1 table of an
137      * indirect table, *res is set accordingly, and we return -1.
138      * If the L1 table entry is marked not valid, we return -1 with
139      * *res set to MEMTX_OK.
140      *
141      * The specification defines the format of level 1 entries of a
142      * 2-level table, but the format of level 2 entries and the format
143      * of flat-mapped tables is IMPDEF.
144      */
145     AddressSpace *as = &s->gicv3->dma_as;
146     uint32_t l2idx;
147     uint64_t l2;
148     uint32_t num_l2_entries;
149 
150     *res = MEMTX_OK;
151 
152     if (!td->indirect) {
153         /* Single level table */
154         return td->base_addr + idx * td->entry_sz;
155     }
156 
157     /* Two level table */
158     l2idx = idx / (td->page_sz / L1TABLE_ENTRY_SIZE);
159 
160     l2 = address_space_ldq_le(as,
161                               td->base_addr + (l2idx * L1TABLE_ENTRY_SIZE),
162                               MEMTXATTRS_UNSPECIFIED, res);
163     if (*res != MEMTX_OK) {
164         return -1;
165     }
166     if (!(l2 & L2_TABLE_VALID_MASK)) {
167         return -1;
168     }
169 
170     num_l2_entries = td->page_sz / td->entry_sz;
171     return (l2 & ((1ULL << 51) - 1)) + (idx % num_l2_entries) * td->entry_sz;
172 }
173 
174 /*
175  * Read the Collection Table entry at index @icid. On success (including
176  * successfully determining that there is no valid CTE for this index),
177  * we return MEMTX_OK and populate the CTEntry struct @cte accordingly.
178  * If there is an error reading memory then we return the error code.
179  */
180 static MemTxResult get_cte(GICv3ITSState *s, uint16_t icid, CTEntry *cte)
181 {
182     AddressSpace *as = &s->gicv3->dma_as;
183     MemTxResult res = MEMTX_OK;
184     uint64_t entry_addr = table_entry_addr(s, &s->ct, icid, &res);
185     uint64_t cteval;
186 
187     if (entry_addr == -1) {
188         /* No L2 table entry, i.e. no valid CTE, or a memory error */
189         cte->valid = false;
190         goto out;
191     }
192 
193     cteval = address_space_ldq_le(as, entry_addr, MEMTXATTRS_UNSPECIFIED, &res);
194     if (res != MEMTX_OK) {
195         goto out;
196     }
197     cte->valid = FIELD_EX64(cteval, CTE, VALID);
198     cte->rdbase = FIELD_EX64(cteval, CTE, RDBASE);
199 out:
200     if (res != MEMTX_OK) {
201         trace_gicv3_its_cte_read_fault(icid);
202     } else {
203         trace_gicv3_its_cte_read(icid, cte->valid, cte->rdbase);
204     }
205     return res;
206 }
207 
208 /*
209  * Update the Interrupt Table entry at index @evinted in the table specified
210  * by the dte @dte. Returns true on success, false if there was a memory
211  * access error.
212  */
213 static bool update_ite(GICv3ITSState *s, uint32_t eventid, const DTEntry *dte,
214                        const ITEntry *ite)
215 {
216     AddressSpace *as = &s->gicv3->dma_as;
217     MemTxResult res = MEMTX_OK;
218     hwaddr iteaddr = dte->ittaddr + eventid * ITS_ITT_ENTRY_SIZE;
219     uint64_t itel = 0;
220     uint32_t iteh = 0;
221 
222     trace_gicv3_its_ite_write(dte->ittaddr, eventid, ite->valid,
223                               ite->inttype, ite->intid, ite->icid,
224                               ite->vpeid, ite->doorbell);
225 
226     if (ite->valid) {
227         itel = FIELD_DP64(itel, ITE_L, VALID, 1);
228         itel = FIELD_DP64(itel, ITE_L, INTTYPE, ite->inttype);
229         itel = FIELD_DP64(itel, ITE_L, INTID, ite->intid);
230         itel = FIELD_DP64(itel, ITE_L, ICID, ite->icid);
231         itel = FIELD_DP64(itel, ITE_L, VPEID, ite->vpeid);
232         iteh = FIELD_DP32(iteh, ITE_H, DOORBELL, ite->doorbell);
233     }
234 
235     address_space_stq_le(as, iteaddr, itel, MEMTXATTRS_UNSPECIFIED, &res);
236     if (res != MEMTX_OK) {
237         return false;
238     }
239     address_space_stl_le(as, iteaddr + 8, iteh, MEMTXATTRS_UNSPECIFIED, &res);
240     return res == MEMTX_OK;
241 }
242 
243 /*
244  * Read the Interrupt Table entry at index @eventid from the table specified
245  * by the DTE @dte. On success, we return MEMTX_OK and populate the ITEntry
246  * struct @ite accordingly. If there is an error reading memory then we return
247  * the error code.
248  */
249 static MemTxResult get_ite(GICv3ITSState *s, uint32_t eventid,
250                            const DTEntry *dte, ITEntry *ite)
251 {
252     AddressSpace *as = &s->gicv3->dma_as;
253     MemTxResult res = MEMTX_OK;
254     uint64_t itel;
255     uint32_t iteh;
256     hwaddr iteaddr = dte->ittaddr + eventid * ITS_ITT_ENTRY_SIZE;
257 
258     itel = address_space_ldq_le(as, iteaddr, MEMTXATTRS_UNSPECIFIED, &res);
259     if (res != MEMTX_OK) {
260         trace_gicv3_its_ite_read_fault(dte->ittaddr, eventid);
261         return res;
262     }
263 
264     iteh = address_space_ldl_le(as, iteaddr + 8, MEMTXATTRS_UNSPECIFIED, &res);
265     if (res != MEMTX_OK) {
266         trace_gicv3_its_ite_read_fault(dte->ittaddr, eventid);
267         return res;
268     }
269 
270     ite->valid = FIELD_EX64(itel, ITE_L, VALID);
271     ite->inttype = FIELD_EX64(itel, ITE_L, INTTYPE);
272     ite->intid = FIELD_EX64(itel, ITE_L, INTID);
273     ite->icid = FIELD_EX64(itel, ITE_L, ICID);
274     ite->vpeid = FIELD_EX64(itel, ITE_L, VPEID);
275     ite->doorbell = FIELD_EX64(iteh, ITE_H, DOORBELL);
276     trace_gicv3_its_ite_read(dte->ittaddr, eventid, ite->valid,
277                              ite->inttype, ite->intid, ite->icid,
278                              ite->vpeid, ite->doorbell);
279     return MEMTX_OK;
280 }
281 
282 /*
283  * Read the Device Table entry at index @devid. On success (including
284  * successfully determining that there is no valid DTE for this index),
285  * we return MEMTX_OK and populate the DTEntry struct accordingly.
286  * If there is an error reading memory then we return the error code.
287  */
288 static MemTxResult get_dte(GICv3ITSState *s, uint32_t devid, DTEntry *dte)
289 {
290     MemTxResult res = MEMTX_OK;
291     AddressSpace *as = &s->gicv3->dma_as;
292     uint64_t entry_addr = table_entry_addr(s, &s->dt, devid, &res);
293     uint64_t dteval;
294 
295     if (entry_addr == -1) {
296         /* No L2 table entry, i.e. no valid DTE, or a memory error */
297         dte->valid = false;
298         goto out;
299     }
300     dteval = address_space_ldq_le(as, entry_addr, MEMTXATTRS_UNSPECIFIED, &res);
301     if (res != MEMTX_OK) {
302         goto out;
303     }
304     dte->valid = FIELD_EX64(dteval, DTE, VALID);
305     dte->size = FIELD_EX64(dteval, DTE, SIZE);
306     /* DTE word field stores bits [51:8] of the ITT address */
307     dte->ittaddr = FIELD_EX64(dteval, DTE, ITTADDR) << ITTADDR_SHIFT;
308 out:
309     if (res != MEMTX_OK) {
310         trace_gicv3_its_dte_read_fault(devid);
311     } else {
312         trace_gicv3_its_dte_read(devid, dte->valid, dte->size, dte->ittaddr);
313     }
314     return res;
315 }
316 
317 /*
318  * Read the vPE Table entry at index @vpeid. On success (including
319  * successfully determining that there is no valid entry for this index),
320  * we return MEMTX_OK and populate the VTEntry struct accordingly.
321  * If there is an error reading memory then we return the error code.
322  */
323 static MemTxResult get_vte(GICv3ITSState *s, uint32_t vpeid, VTEntry *vte)
324 {
325     MemTxResult res = MEMTX_OK;
326     AddressSpace *as = &s->gicv3->dma_as;
327     uint64_t entry_addr = table_entry_addr(s, &s->vpet, vpeid, &res);
328     uint64_t vteval;
329 
330     if (entry_addr == -1) {
331         /* No L2 table entry, i.e. no valid VTE, or a memory error */
332         vte->valid = false;
333         goto out;
334     }
335     vteval = address_space_ldq_le(as, entry_addr, MEMTXATTRS_UNSPECIFIED, &res);
336     if (res != MEMTX_OK) {
337         goto out;
338     }
339     vte->valid = FIELD_EX64(vteval, VTE, VALID);
340     vte->vptsize = FIELD_EX64(vteval, VTE, VPTSIZE);
341     vte->vptaddr = FIELD_EX64(vteval, VTE, VPTADDR);
342     vte->rdbase = FIELD_EX64(vteval, VTE, RDBASE);
343 out:
344     if (res != MEMTX_OK) {
345         trace_gicv3_its_vte_read_fault(vpeid);
346     } else {
347         trace_gicv3_its_vte_read(vpeid, vte->valid, vte->vptsize,
348                                  vte->vptaddr, vte->rdbase);
349     }
350     return res;
351 }
352 
353 /*
354  * Given a (DeviceID, EventID), look up the corresponding ITE, including
355  * checking for the various invalid-value cases. If we find a valid ITE,
356  * fill in @ite and @dte and return CMD_CONTINUE_OK. Otherwise return
357  * CMD_STALL or CMD_CONTINUE as appropriate (and the contents of @ite
358  * should not be relied on).
359  *
360  * The string @who is purely for the LOG_GUEST_ERROR messages,
361  * and should indicate the name of the calling function or similar.
362  */
363 static ItsCmdResult lookup_ite(GICv3ITSState *s, const char *who,
364                                uint32_t devid, uint32_t eventid, ITEntry *ite,
365                                DTEntry *dte)
366 {
367     uint64_t num_eventids;
368 
369     if (devid >= s->dt.num_entries) {
370         qemu_log_mask(LOG_GUEST_ERROR,
371                       "%s: invalid command attributes: devid %d>=%d",
372                       who, devid, s->dt.num_entries);
373         return CMD_CONTINUE;
374     }
375 
376     if (get_dte(s, devid, dte) != MEMTX_OK) {
377         return CMD_STALL;
378     }
379     if (!dte->valid) {
380         qemu_log_mask(LOG_GUEST_ERROR,
381                       "%s: invalid command attributes: "
382                       "invalid dte for %d\n", who, devid);
383         return CMD_CONTINUE;
384     }
385 
386     num_eventids = 1ULL << (dte->size + 1);
387     if (eventid >= num_eventids) {
388         qemu_log_mask(LOG_GUEST_ERROR,
389                       "%s: invalid command attributes: eventid %d >= %"
390                       PRId64 "\n", who, eventid, num_eventids);
391         return CMD_CONTINUE;
392     }
393 
394     if (get_ite(s, eventid, dte, ite) != MEMTX_OK) {
395         return CMD_STALL;
396     }
397 
398     if (!ite->valid) {
399         qemu_log_mask(LOG_GUEST_ERROR,
400                       "%s: invalid command attributes: invalid ITE\n", who);
401         return CMD_CONTINUE;
402     }
403 
404     return CMD_CONTINUE_OK;
405 }
406 
407 /*
408  * Given an ICID, look up the corresponding CTE, including checking for various
409  * invalid-value cases. If we find a valid CTE, fill in @cte and return
410  * CMD_CONTINUE_OK; otherwise return CMD_STALL or CMD_CONTINUE (and the
411  * contents of @cte should not be relied on).
412  *
413  * The string @who is purely for the LOG_GUEST_ERROR messages,
414  * and should indicate the name of the calling function or similar.
415  */
416 static ItsCmdResult lookup_cte(GICv3ITSState *s, const char *who,
417                                uint32_t icid, CTEntry *cte)
418 {
419     if (icid >= s->ct.num_entries) {
420         qemu_log_mask(LOG_GUEST_ERROR, "%s: invalid ICID 0x%x\n", who, icid);
421         return CMD_CONTINUE;
422     }
423     if (get_cte(s, icid, cte) != MEMTX_OK) {
424         return CMD_STALL;
425     }
426     if (!cte->valid) {
427         qemu_log_mask(LOG_GUEST_ERROR, "%s: invalid CTE\n", who);
428         return CMD_CONTINUE;
429     }
430     if (cte->rdbase >= s->gicv3->num_cpu) {
431         return CMD_CONTINUE;
432     }
433     return CMD_CONTINUE_OK;
434 }
435 
436 /*
437  * Given a VPEID, look up the corresponding VTE, including checking
438  * for various invalid-value cases. if we find a valid VTE, fill in @vte
439  * and return CMD_CONTINUE_OK; otherwise return CMD_STALL or CMD_CONTINUE
440  * (and the contents of @vte should not be relied on).
441  *
442  * The string @who is purely for the LOG_GUEST_ERROR messages,
443  * and should indicate the name of the calling function or similar.
444  */
445 static ItsCmdResult lookup_vte(GICv3ITSState *s, const char *who,
446                                uint32_t vpeid, VTEntry *vte)
447 {
448     if (vpeid >= s->vpet.num_entries) {
449         qemu_log_mask(LOG_GUEST_ERROR, "%s: invalid VPEID 0x%x\n", who, vpeid);
450         return CMD_CONTINUE;
451     }
452 
453     if (get_vte(s, vpeid, vte) != MEMTX_OK) {
454         return CMD_STALL;
455     }
456     if (!vte->valid) {
457         qemu_log_mask(LOG_GUEST_ERROR,
458                       "%s: invalid VTE for VPEID 0x%x\n", who, vpeid);
459         return CMD_CONTINUE;
460     }
461 
462     if (vte->rdbase >= s->gicv3->num_cpu) {
463         return CMD_CONTINUE;
464     }
465     return CMD_CONTINUE_OK;
466 }
467 
468 static ItsCmdResult process_its_cmd_phys(GICv3ITSState *s, const ITEntry *ite,
469                                          int irqlevel)
470 {
471     CTEntry cte;
472     ItsCmdResult cmdres;
473 
474     cmdres = lookup_cte(s, __func__, ite->icid, &cte);
475     if (cmdres != CMD_CONTINUE_OK) {
476         return cmdres;
477     }
478     gicv3_redist_process_lpi(&s->gicv3->cpu[cte.rdbase], ite->intid, irqlevel);
479     return CMD_CONTINUE_OK;
480 }
481 
482 static ItsCmdResult process_its_cmd_virt(GICv3ITSState *s, const ITEntry *ite,
483                                          int irqlevel)
484 {
485     VTEntry vte;
486     ItsCmdResult cmdres;
487 
488     cmdres = lookup_vte(s, __func__, ite->vpeid, &vte);
489     if (cmdres != CMD_CONTINUE_OK) {
490         return cmdres;
491     }
492 
493     if (!intid_in_lpi_range(ite->intid) ||
494         ite->intid >= (1ULL << (vte.vptsize + 1))) {
495         qemu_log_mask(LOG_GUEST_ERROR, "%s: intid 0x%x out of range\n",
496                       __func__, ite->intid);
497         return CMD_CONTINUE;
498     }
499 
500     /*
501      * For QEMU the actual pending of the vLPI is handled in the
502      * redistributor code
503      */
504     gicv3_redist_process_vlpi(&s->gicv3->cpu[vte.rdbase], ite->intid,
505                               vte.vptaddr << 16, ite->doorbell, irqlevel);
506     return CMD_CONTINUE_OK;
507 }
508 
509 /*
510  * This function handles the processing of following commands based on
511  * the ItsCmdType parameter passed:-
512  * 1. triggering of lpi interrupt translation via ITS INT command
513  * 2. triggering of lpi interrupt translation via gits_translater register
514  * 3. handling of ITS CLEAR command
515  * 4. handling of ITS DISCARD command
516  */
517 static ItsCmdResult do_process_its_cmd(GICv3ITSState *s, uint32_t devid,
518                                        uint32_t eventid, ItsCmdType cmd)
519 {
520     DTEntry dte;
521     ITEntry ite;
522     ItsCmdResult cmdres;
523     int irqlevel;
524 
525     cmdres = lookup_ite(s, __func__, devid, eventid, &ite, &dte);
526     if (cmdres != CMD_CONTINUE_OK) {
527         return cmdres;
528     }
529 
530     irqlevel = (cmd == CLEAR || cmd == DISCARD) ? 0 : 1;
531 
532     switch (ite.inttype) {
533     case ITE_INTTYPE_PHYSICAL:
534         cmdres = process_its_cmd_phys(s, &ite, irqlevel);
535         break;
536     case ITE_INTTYPE_VIRTUAL:
537         if (!its_feature_virtual(s)) {
538             /* Can't happen unless guest is illegally writing to table memory */
539             qemu_log_mask(LOG_GUEST_ERROR,
540                           "%s: invalid type %d in ITE (table corrupted?)\n",
541                           __func__, ite.inttype);
542             return CMD_CONTINUE;
543         }
544         cmdres = process_its_cmd_virt(s, &ite, irqlevel);
545         break;
546     default:
547         g_assert_not_reached();
548     }
549 
550     if (cmdres == CMD_CONTINUE_OK && cmd == DISCARD) {
551         ITEntry ite = {};
552         /* remove mapping from interrupt translation table */
553         ite.valid = false;
554         return update_ite(s, eventid, &dte, &ite) ? CMD_CONTINUE_OK : CMD_STALL;
555     }
556     return CMD_CONTINUE_OK;
557 }
558 
559 static ItsCmdResult process_its_cmd(GICv3ITSState *s, const uint64_t *cmdpkt,
560                                     ItsCmdType cmd)
561 {
562     uint32_t devid, eventid;
563 
564     devid = (cmdpkt[0] & DEVID_MASK) >> DEVID_SHIFT;
565     eventid = cmdpkt[1] & EVENTID_MASK;
566     switch (cmd) {
567     case INTERRUPT:
568         trace_gicv3_its_cmd_int(devid, eventid);
569         break;
570     case CLEAR:
571         trace_gicv3_its_cmd_clear(devid, eventid);
572         break;
573     case DISCARD:
574         trace_gicv3_its_cmd_discard(devid, eventid);
575         break;
576     default:
577         g_assert_not_reached();
578     }
579     return do_process_its_cmd(s, devid, eventid, cmd);
580 }
581 
582 static ItsCmdResult process_mapti(GICv3ITSState *s, const uint64_t *cmdpkt,
583                                   bool ignore_pInt)
584 {
585     uint32_t devid, eventid;
586     uint32_t pIntid = 0;
587     uint64_t num_eventids;
588     uint16_t icid = 0;
589     DTEntry dte;
590     ITEntry ite;
591 
592     devid = (cmdpkt[0] & DEVID_MASK) >> DEVID_SHIFT;
593     eventid = cmdpkt[1] & EVENTID_MASK;
594     icid = cmdpkt[2] & ICID_MASK;
595 
596     if (ignore_pInt) {
597         pIntid = eventid;
598         trace_gicv3_its_cmd_mapi(devid, eventid, icid);
599     } else {
600         pIntid = (cmdpkt[1] & pINTID_MASK) >> pINTID_SHIFT;
601         trace_gicv3_its_cmd_mapti(devid, eventid, icid, pIntid);
602     }
603 
604     if (devid >= s->dt.num_entries) {
605         qemu_log_mask(LOG_GUEST_ERROR,
606                       "%s: invalid command attributes: devid %d>=%d",
607                       __func__, devid, s->dt.num_entries);
608         return CMD_CONTINUE;
609     }
610 
611     if (get_dte(s, devid, &dte) != MEMTX_OK) {
612         return CMD_STALL;
613     }
614     num_eventids = 1ULL << (dte.size + 1);
615 
616     if (icid >= s->ct.num_entries) {
617         qemu_log_mask(LOG_GUEST_ERROR,
618                       "%s: invalid ICID 0x%x >= 0x%x\n",
619                       __func__, icid, s->ct.num_entries);
620         return CMD_CONTINUE;
621     }
622 
623     if (!dte.valid) {
624         qemu_log_mask(LOG_GUEST_ERROR,
625                       "%s: no valid DTE for devid 0x%x\n", __func__, devid);
626         return CMD_CONTINUE;
627     }
628 
629     if (eventid >= num_eventids) {
630         qemu_log_mask(LOG_GUEST_ERROR,
631                       "%s: invalid event ID 0x%x >= 0x%" PRIx64 "\n",
632                       __func__, eventid, num_eventids);
633         return CMD_CONTINUE;
634     }
635 
636     if (!intid_in_lpi_range(pIntid)) {
637         qemu_log_mask(LOG_GUEST_ERROR,
638                       "%s: invalid interrupt ID 0x%x\n", __func__, pIntid);
639         return CMD_CONTINUE;
640     }
641 
642     /* add ite entry to interrupt translation table */
643     ite.valid = true;
644     ite.inttype = ITE_INTTYPE_PHYSICAL;
645     ite.intid = pIntid;
646     ite.icid = icid;
647     ite.doorbell = INTID_SPURIOUS;
648     ite.vpeid = 0;
649     return update_ite(s, eventid, &dte, &ite) ? CMD_CONTINUE_OK : CMD_STALL;
650 }
651 
652 static ItsCmdResult process_vmapti(GICv3ITSState *s, const uint64_t *cmdpkt,
653                                    bool ignore_vintid)
654 {
655     uint32_t devid, eventid, vintid, doorbell, vpeid;
656     uint32_t num_eventids;
657     DTEntry dte;
658     ITEntry ite;
659 
660     if (!its_feature_virtual(s)) {
661         return CMD_CONTINUE;
662     }
663 
664     devid = FIELD_EX64(cmdpkt[0], VMAPTI_0, DEVICEID);
665     eventid = FIELD_EX64(cmdpkt[1], VMAPTI_1, EVENTID);
666     vpeid = FIELD_EX64(cmdpkt[1], VMAPTI_1, VPEID);
667     doorbell = FIELD_EX64(cmdpkt[2], VMAPTI_2, DOORBELL);
668     if (ignore_vintid) {
669         vintid = eventid;
670         trace_gicv3_its_cmd_vmapi(devid, eventid, vpeid, doorbell);
671     } else {
672         vintid = FIELD_EX64(cmdpkt[2], VMAPTI_2, VINTID);
673         trace_gicv3_its_cmd_vmapti(devid, eventid, vpeid, vintid, doorbell);
674     }
675 
676     if (devid >= s->dt.num_entries) {
677         qemu_log_mask(LOG_GUEST_ERROR,
678                       "%s: invalid DeviceID 0x%x (must be less than 0x%x)\n",
679                       __func__, devid, s->dt.num_entries);
680         return CMD_CONTINUE;
681     }
682 
683     if (get_dte(s, devid, &dte) != MEMTX_OK) {
684         return CMD_STALL;
685     }
686 
687     if (!dte.valid) {
688         qemu_log_mask(LOG_GUEST_ERROR,
689                       "%s: no entry in device table for DeviceID 0x%x\n",
690                       __func__, devid);
691         return CMD_CONTINUE;
692     }
693 
694     num_eventids = 1ULL << (dte.size + 1);
695 
696     if (eventid >= num_eventids) {
697         qemu_log_mask(LOG_GUEST_ERROR,
698                       "%s: EventID 0x%x too large for DeviceID 0x%x "
699                       "(must be less than 0x%x)\n",
700                       __func__, eventid, devid, num_eventids);
701         return CMD_CONTINUE;
702     }
703     if (!intid_in_lpi_range(vintid)) {
704         qemu_log_mask(LOG_GUEST_ERROR,
705                       "%s: VIntID 0x%x not a valid LPI\n",
706                       __func__, vintid);
707         return CMD_CONTINUE;
708     }
709     if (!valid_doorbell(doorbell)) {
710         qemu_log_mask(LOG_GUEST_ERROR,
711                       "%s: Doorbell %d not 1023 and not a valid LPI\n",
712                       __func__, doorbell);
713         return CMD_CONTINUE;
714     }
715     if (vpeid >= s->vpet.num_entries) {
716         qemu_log_mask(LOG_GUEST_ERROR,
717                       "%s: VPEID 0x%x out of range (must be less than 0x%x)\n",
718                       __func__, vpeid, s->vpet.num_entries);
719         return CMD_CONTINUE;
720     }
721     /* add ite entry to interrupt translation table */
722     ite.valid = true;
723     ite.inttype = ITE_INTTYPE_VIRTUAL;
724     ite.intid = vintid;
725     ite.icid = 0;
726     ite.doorbell = doorbell;
727     ite.vpeid = vpeid;
728     return update_ite(s, eventid, &dte, &ite) ? CMD_CONTINUE_OK : CMD_STALL;
729 }
730 
731 /*
732  * Update the Collection Table entry for @icid to @cte. Returns true
733  * on success, false if there was a memory access error.
734  */
735 static bool update_cte(GICv3ITSState *s, uint16_t icid, const CTEntry *cte)
736 {
737     AddressSpace *as = &s->gicv3->dma_as;
738     uint64_t entry_addr;
739     uint64_t cteval = 0;
740     MemTxResult res = MEMTX_OK;
741 
742     trace_gicv3_its_cte_write(icid, cte->valid, cte->rdbase);
743 
744     if (cte->valid) {
745         /* add mapping entry to collection table */
746         cteval = FIELD_DP64(cteval, CTE, VALID, 1);
747         cteval = FIELD_DP64(cteval, CTE, RDBASE, cte->rdbase);
748     }
749 
750     entry_addr = table_entry_addr(s, &s->ct, icid, &res);
751     if (res != MEMTX_OK) {
752         /* memory access error: stall */
753         return false;
754     }
755     if (entry_addr == -1) {
756         /* No L2 table for this index: discard write and continue */
757         return true;
758     }
759 
760     address_space_stq_le(as, entry_addr, cteval, MEMTXATTRS_UNSPECIFIED, &res);
761     return res == MEMTX_OK;
762 }
763 
764 static ItsCmdResult process_mapc(GICv3ITSState *s, const uint64_t *cmdpkt)
765 {
766     uint16_t icid;
767     CTEntry cte;
768 
769     icid = cmdpkt[2] & ICID_MASK;
770     cte.valid = cmdpkt[2] & CMD_FIELD_VALID_MASK;
771     if (cte.valid) {
772         cte.rdbase = (cmdpkt[2] & R_MAPC_RDBASE_MASK) >> R_MAPC_RDBASE_SHIFT;
773         cte.rdbase &= RDBASE_PROCNUM_MASK;
774     } else {
775         cte.rdbase = 0;
776     }
777     trace_gicv3_its_cmd_mapc(icid, cte.rdbase, cte.valid);
778 
779     if (icid >= s->ct.num_entries) {
780         qemu_log_mask(LOG_GUEST_ERROR, "ITS MAPC: invalid ICID 0x%x\n", icid);
781         return CMD_CONTINUE;
782     }
783     if (cte.valid && cte.rdbase >= s->gicv3->num_cpu) {
784         qemu_log_mask(LOG_GUEST_ERROR,
785                       "ITS MAPC: invalid RDBASE %u\n", cte.rdbase);
786         return CMD_CONTINUE;
787     }
788 
789     return update_cte(s, icid, &cte) ? CMD_CONTINUE_OK : CMD_STALL;
790 }
791 
792 /*
793  * Update the Device Table entry for @devid to @dte. Returns true
794  * on success, false if there was a memory access error.
795  */
796 static bool update_dte(GICv3ITSState *s, uint32_t devid, const DTEntry *dte)
797 {
798     AddressSpace *as = &s->gicv3->dma_as;
799     uint64_t entry_addr;
800     uint64_t dteval = 0;
801     MemTxResult res = MEMTX_OK;
802 
803     trace_gicv3_its_dte_write(devid, dte->valid, dte->size, dte->ittaddr);
804 
805     if (dte->valid) {
806         /* add mapping entry to device table */
807         dteval = FIELD_DP64(dteval, DTE, VALID, 1);
808         dteval = FIELD_DP64(dteval, DTE, SIZE, dte->size);
809         dteval = FIELD_DP64(dteval, DTE, ITTADDR, dte->ittaddr);
810     }
811 
812     entry_addr = table_entry_addr(s, &s->dt, devid, &res);
813     if (res != MEMTX_OK) {
814         /* memory access error: stall */
815         return false;
816     }
817     if (entry_addr == -1) {
818         /* No L2 table for this index: discard write and continue */
819         return true;
820     }
821     address_space_stq_le(as, entry_addr, dteval, MEMTXATTRS_UNSPECIFIED, &res);
822     return res == MEMTX_OK;
823 }
824 
825 static ItsCmdResult process_mapd(GICv3ITSState *s, const uint64_t *cmdpkt)
826 {
827     uint32_t devid;
828     DTEntry dte;
829 
830     devid = (cmdpkt[0] & DEVID_MASK) >> DEVID_SHIFT;
831     dte.size = cmdpkt[1] & SIZE_MASK;
832     dte.ittaddr = (cmdpkt[2] & ITTADDR_MASK) >> ITTADDR_SHIFT;
833     dte.valid = cmdpkt[2] & CMD_FIELD_VALID_MASK;
834 
835     trace_gicv3_its_cmd_mapd(devid, dte.size, dte.ittaddr, dte.valid);
836 
837     if (devid >= s->dt.num_entries) {
838         qemu_log_mask(LOG_GUEST_ERROR,
839                       "ITS MAPD: invalid device ID field 0x%x >= 0x%x\n",
840                       devid, s->dt.num_entries);
841         return CMD_CONTINUE;
842     }
843 
844     if (dte.size > FIELD_EX64(s->typer, GITS_TYPER, IDBITS)) {
845         qemu_log_mask(LOG_GUEST_ERROR,
846                       "ITS MAPD: invalid size %d\n", dte.size);
847         return CMD_CONTINUE;
848     }
849 
850     return update_dte(s, devid, &dte) ? CMD_CONTINUE_OK : CMD_STALL;
851 }
852 
853 static ItsCmdResult process_movall(GICv3ITSState *s, const uint64_t *cmdpkt)
854 {
855     uint64_t rd1, rd2;
856 
857     rd1 = FIELD_EX64(cmdpkt[2], MOVALL_2, RDBASE1);
858     rd2 = FIELD_EX64(cmdpkt[3], MOVALL_3, RDBASE2);
859 
860     trace_gicv3_its_cmd_movall(rd1, rd2);
861 
862     if (rd1 >= s->gicv3->num_cpu) {
863         qemu_log_mask(LOG_GUEST_ERROR,
864                       "%s: RDBASE1 %" PRId64
865                       " out of range (must be less than %d)\n",
866                       __func__, rd1, s->gicv3->num_cpu);
867         return CMD_CONTINUE;
868     }
869     if (rd2 >= s->gicv3->num_cpu) {
870         qemu_log_mask(LOG_GUEST_ERROR,
871                       "%s: RDBASE2 %" PRId64
872                       " out of range (must be less than %d)\n",
873                       __func__, rd2, s->gicv3->num_cpu);
874         return CMD_CONTINUE;
875     }
876 
877     if (rd1 == rd2) {
878         /* Move to same target must succeed as a no-op */
879         return CMD_CONTINUE_OK;
880     }
881 
882     /* Move all pending LPIs from redistributor 1 to redistributor 2 */
883     gicv3_redist_movall_lpis(&s->gicv3->cpu[rd1], &s->gicv3->cpu[rd2]);
884 
885     return CMD_CONTINUE_OK;
886 }
887 
888 static ItsCmdResult process_movi(GICv3ITSState *s, const uint64_t *cmdpkt)
889 {
890     uint32_t devid, eventid;
891     uint16_t new_icid;
892     DTEntry dte;
893     CTEntry old_cte, new_cte;
894     ITEntry old_ite;
895     ItsCmdResult cmdres;
896 
897     devid = FIELD_EX64(cmdpkt[0], MOVI_0, DEVICEID);
898     eventid = FIELD_EX64(cmdpkt[1], MOVI_1, EVENTID);
899     new_icid = FIELD_EX64(cmdpkt[2], MOVI_2, ICID);
900 
901     trace_gicv3_its_cmd_movi(devid, eventid, new_icid);
902 
903     cmdres = lookup_ite(s, __func__, devid, eventid, &old_ite, &dte);
904     if (cmdres != CMD_CONTINUE_OK) {
905         return cmdres;
906     }
907 
908     if (old_ite.inttype != ITE_INTTYPE_PHYSICAL) {
909         qemu_log_mask(LOG_GUEST_ERROR,
910                       "%s: invalid command attributes: invalid ITE\n",
911                       __func__);
912         return CMD_CONTINUE;
913     }
914 
915     cmdres = lookup_cte(s, __func__, old_ite.icid, &old_cte);
916     if (cmdres != CMD_CONTINUE_OK) {
917         return cmdres;
918     }
919     cmdres = lookup_cte(s, __func__, new_icid, &new_cte);
920     if (cmdres != CMD_CONTINUE_OK) {
921         return cmdres;
922     }
923 
924     if (old_cte.rdbase != new_cte.rdbase) {
925         /* Move the LPI from the old redistributor to the new one */
926         gicv3_redist_mov_lpi(&s->gicv3->cpu[old_cte.rdbase],
927                              &s->gicv3->cpu[new_cte.rdbase],
928                              old_ite.intid);
929     }
930 
931     /* Update the ICID field in the interrupt translation table entry */
932     old_ite.icid = new_icid;
933     return update_ite(s, eventid, &dte, &old_ite) ? CMD_CONTINUE_OK : CMD_STALL;
934 }
935 
936 /*
937  * Update the vPE Table entry at index @vpeid with the entry @vte.
938  * Returns true on success, false if there was a memory access error.
939  */
940 static bool update_vte(GICv3ITSState *s, uint32_t vpeid, const VTEntry *vte)
941 {
942     AddressSpace *as = &s->gicv3->dma_as;
943     uint64_t entry_addr;
944     uint64_t vteval = 0;
945     MemTxResult res = MEMTX_OK;
946 
947     trace_gicv3_its_vte_write(vpeid, vte->valid, vte->vptsize, vte->vptaddr,
948                               vte->rdbase);
949 
950     if (vte->valid) {
951         vteval = FIELD_DP64(vteval, VTE, VALID, 1);
952         vteval = FIELD_DP64(vteval, VTE, VPTSIZE, vte->vptsize);
953         vteval = FIELD_DP64(vteval, VTE, VPTADDR, vte->vptaddr);
954         vteval = FIELD_DP64(vteval, VTE, RDBASE, vte->rdbase);
955     }
956 
957     entry_addr = table_entry_addr(s, &s->vpet, vpeid, &res);
958     if (res != MEMTX_OK) {
959         return false;
960     }
961     if (entry_addr == -1) {
962         /* No L2 table for this index: discard write and continue */
963         return true;
964     }
965     address_space_stq_le(as, entry_addr, vteval, MEMTXATTRS_UNSPECIFIED, &res);
966     return res == MEMTX_OK;
967 }
968 
969 static ItsCmdResult process_vmapp(GICv3ITSState *s, const uint64_t *cmdpkt)
970 {
971     VTEntry vte;
972     uint32_t vpeid;
973 
974     if (!its_feature_virtual(s)) {
975         return CMD_CONTINUE;
976     }
977 
978     vpeid = FIELD_EX64(cmdpkt[1], VMAPP_1, VPEID);
979     vte.rdbase = FIELD_EX64(cmdpkt[2], VMAPP_2, RDBASE);
980     vte.valid = FIELD_EX64(cmdpkt[2], VMAPP_2, V);
981     vte.vptsize = FIELD_EX64(cmdpkt[3], VMAPP_3, VPTSIZE);
982     vte.vptaddr = FIELD_EX64(cmdpkt[3], VMAPP_3, VPTADDR);
983 
984     trace_gicv3_its_cmd_vmapp(vpeid, vte.rdbase, vte.valid,
985                               vte.vptaddr, vte.vptsize);
986 
987     /*
988      * For GICv4.0 the VPT_size field is only 5 bits, whereas we
989      * define our field macros to include the full GICv4.1 8 bits.
990      * The range check on VPT_size will catch the cases where
991      * the guest set the RES0-in-GICv4.0 bits [7:6].
992      */
993     if (vte.vptsize > FIELD_EX64(s->typer, GITS_TYPER, IDBITS)) {
994         qemu_log_mask(LOG_GUEST_ERROR,
995                       "%s: invalid VPT_size 0x%x\n", __func__, vte.vptsize);
996         return CMD_CONTINUE;
997     }
998 
999     if (vte.valid && vte.rdbase >= s->gicv3->num_cpu) {
1000         qemu_log_mask(LOG_GUEST_ERROR,
1001                       "%s: invalid rdbase 0x%x\n", __func__, vte.rdbase);
1002         return CMD_CONTINUE;
1003     }
1004 
1005     if (vpeid >= s->vpet.num_entries) {
1006         qemu_log_mask(LOG_GUEST_ERROR,
1007                       "%s: VPEID 0x%x out of range (must be less than 0x%x)\n",
1008                       __func__, vpeid, s->vpet.num_entries);
1009         return CMD_CONTINUE;
1010     }
1011 
1012     return update_vte(s, vpeid, &vte) ? CMD_CONTINUE_OK : CMD_STALL;
1013 }
1014 
1015 /*
1016  * Current implementation blocks until all
1017  * commands are processed
1018  */
1019 static void process_cmdq(GICv3ITSState *s)
1020 {
1021     uint32_t wr_offset = 0;
1022     uint32_t rd_offset = 0;
1023     uint32_t cq_offset = 0;
1024     AddressSpace *as = &s->gicv3->dma_as;
1025     uint8_t cmd;
1026     int i;
1027 
1028     if (!(s->ctlr & R_GITS_CTLR_ENABLED_MASK)) {
1029         return;
1030     }
1031 
1032     wr_offset = FIELD_EX64(s->cwriter, GITS_CWRITER, OFFSET);
1033 
1034     if (wr_offset >= s->cq.num_entries) {
1035         qemu_log_mask(LOG_GUEST_ERROR,
1036                       "%s: invalid write offset "
1037                       "%d\n", __func__, wr_offset);
1038         return;
1039     }
1040 
1041     rd_offset = FIELD_EX64(s->creadr, GITS_CREADR, OFFSET);
1042 
1043     if (rd_offset >= s->cq.num_entries) {
1044         qemu_log_mask(LOG_GUEST_ERROR,
1045                       "%s: invalid read offset "
1046                       "%d\n", __func__, rd_offset);
1047         return;
1048     }
1049 
1050     while (wr_offset != rd_offset) {
1051         ItsCmdResult result = CMD_CONTINUE_OK;
1052         void *hostmem;
1053         hwaddr buflen;
1054         uint64_t cmdpkt[GITS_CMDQ_ENTRY_WORDS];
1055 
1056         cq_offset = (rd_offset * GITS_CMDQ_ENTRY_SIZE);
1057 
1058         buflen = GITS_CMDQ_ENTRY_SIZE;
1059         hostmem = address_space_map(as, s->cq.base_addr + cq_offset,
1060                                     &buflen, false, MEMTXATTRS_UNSPECIFIED);
1061         if (!hostmem || buflen != GITS_CMDQ_ENTRY_SIZE) {
1062             if (hostmem) {
1063                 address_space_unmap(as, hostmem, buflen, false, 0);
1064             }
1065             s->creadr = FIELD_DP64(s->creadr, GITS_CREADR, STALLED, 1);
1066             qemu_log_mask(LOG_GUEST_ERROR,
1067                           "%s: could not read command at 0x%" PRIx64 "\n",
1068                           __func__, s->cq.base_addr + cq_offset);
1069             break;
1070         }
1071         for (i = 0; i < ARRAY_SIZE(cmdpkt); i++) {
1072             cmdpkt[i] = ldq_le_p(hostmem + i * sizeof(uint64_t));
1073         }
1074         address_space_unmap(as, hostmem, buflen, false, 0);
1075 
1076         cmd = cmdpkt[0] & CMD_MASK;
1077 
1078         trace_gicv3_its_process_command(rd_offset, cmd);
1079 
1080         switch (cmd) {
1081         case GITS_CMD_INT:
1082             result = process_its_cmd(s, cmdpkt, INTERRUPT);
1083             break;
1084         case GITS_CMD_CLEAR:
1085             result = process_its_cmd(s, cmdpkt, CLEAR);
1086             break;
1087         case GITS_CMD_SYNC:
1088             /*
1089              * Current implementation makes a blocking synchronous call
1090              * for every command issued earlier, hence the internal state
1091              * is already consistent by the time SYNC command is executed.
1092              * Hence no further processing is required for SYNC command.
1093              */
1094             trace_gicv3_its_cmd_sync();
1095             break;
1096         case GITS_CMD_MAPD:
1097             result = process_mapd(s, cmdpkt);
1098             break;
1099         case GITS_CMD_MAPC:
1100             result = process_mapc(s, cmdpkt);
1101             break;
1102         case GITS_CMD_MAPTI:
1103             result = process_mapti(s, cmdpkt, false);
1104             break;
1105         case GITS_CMD_MAPI:
1106             result = process_mapti(s, cmdpkt, true);
1107             break;
1108         case GITS_CMD_DISCARD:
1109             result = process_its_cmd(s, cmdpkt, DISCARD);
1110             break;
1111         case GITS_CMD_INV:
1112         case GITS_CMD_INVALL:
1113             /*
1114              * Current implementation doesn't cache any ITS tables,
1115              * but the calculated lpi priority information. We only
1116              * need to trigger lpi priority re-calculation to be in
1117              * sync with LPI config table or pending table changes.
1118              */
1119             trace_gicv3_its_cmd_inv();
1120             for (i = 0; i < s->gicv3->num_cpu; i++) {
1121                 gicv3_redist_update_lpi(&s->gicv3->cpu[i]);
1122             }
1123             break;
1124         case GITS_CMD_MOVI:
1125             result = process_movi(s, cmdpkt);
1126             break;
1127         case GITS_CMD_MOVALL:
1128             result = process_movall(s, cmdpkt);
1129             break;
1130         case GITS_CMD_VMAPTI:
1131             result = process_vmapti(s, cmdpkt, false);
1132             break;
1133         case GITS_CMD_VMAPI:
1134             result = process_vmapti(s, cmdpkt, true);
1135             break;
1136         case GITS_CMD_VMAPP:
1137             result = process_vmapp(s, cmdpkt);
1138             break;
1139         default:
1140             trace_gicv3_its_cmd_unknown(cmd);
1141             break;
1142         }
1143         if (result != CMD_STALL) {
1144             /* CMD_CONTINUE or CMD_CONTINUE_OK */
1145             rd_offset++;
1146             rd_offset %= s->cq.num_entries;
1147             s->creadr = FIELD_DP64(s->creadr, GITS_CREADR, OFFSET, rd_offset);
1148         } else {
1149             /* CMD_STALL */
1150             s->creadr = FIELD_DP64(s->creadr, GITS_CREADR, STALLED, 1);
1151             qemu_log_mask(LOG_GUEST_ERROR,
1152                           "%s: 0x%x cmd processing failed, stalling\n",
1153                           __func__, cmd);
1154             break;
1155         }
1156     }
1157 }
1158 
1159 /*
1160  * This function extracts the ITS Device and Collection table specific
1161  * parameters (like base_addr, size etc) from GITS_BASER register.
1162  * It is called during ITS enable and also during post_load migration
1163  */
1164 static void extract_table_params(GICv3ITSState *s)
1165 {
1166     uint16_t num_pages = 0;
1167     uint8_t  page_sz_type;
1168     uint8_t type;
1169     uint32_t page_sz = 0;
1170     uint64_t value;
1171 
1172     for (int i = 0; i < 8; i++) {
1173         TableDesc *td;
1174         int idbits;
1175 
1176         value = s->baser[i];
1177 
1178         if (!value) {
1179             continue;
1180         }
1181 
1182         page_sz_type = FIELD_EX64(value, GITS_BASER, PAGESIZE);
1183 
1184         switch (page_sz_type) {
1185         case 0:
1186             page_sz = GITS_PAGE_SIZE_4K;
1187             break;
1188 
1189         case 1:
1190             page_sz = GITS_PAGE_SIZE_16K;
1191             break;
1192 
1193         case 2:
1194         case 3:
1195             page_sz = GITS_PAGE_SIZE_64K;
1196             break;
1197 
1198         default:
1199             g_assert_not_reached();
1200         }
1201 
1202         num_pages = FIELD_EX64(value, GITS_BASER, SIZE) + 1;
1203 
1204         type = FIELD_EX64(value, GITS_BASER, TYPE);
1205 
1206         switch (type) {
1207         case GITS_BASER_TYPE_DEVICE:
1208             td = &s->dt;
1209             idbits = FIELD_EX64(s->typer, GITS_TYPER, DEVBITS) + 1;
1210             break;
1211         case GITS_BASER_TYPE_COLLECTION:
1212             td = &s->ct;
1213             if (FIELD_EX64(s->typer, GITS_TYPER, CIL)) {
1214                 idbits = FIELD_EX64(s->typer, GITS_TYPER, CIDBITS) + 1;
1215             } else {
1216                 /* 16-bit CollectionId supported when CIL == 0 */
1217                 idbits = 16;
1218             }
1219             break;
1220         case GITS_BASER_TYPE_VPE:
1221             td = &s->vpet;
1222             /*
1223              * For QEMU vPEIDs are always 16 bits. (GICv4.1 allows an
1224              * implementation to implement fewer bits and report this
1225              * via GICD_TYPER2.)
1226              */
1227             idbits = 16;
1228             break;
1229         default:
1230             /*
1231              * GITS_BASER<n>.TYPE is read-only, so GITS_BASER_RO_MASK
1232              * ensures we will only see type values corresponding to
1233              * the values set up in gicv3_its_reset().
1234              */
1235             g_assert_not_reached();
1236         }
1237 
1238         memset(td, 0, sizeof(*td));
1239         /*
1240          * If GITS_BASER<n>.Valid is 0 for any <n> then we will not process
1241          * interrupts. (GITS_TYPER.HCC is 0 for this implementation, so we
1242          * do not have a special case where the GITS_BASER<n>.Valid bit is 0
1243          * for the register corresponding to the Collection table but we
1244          * still have to process interrupts using non-memory-backed
1245          * Collection table entries.)
1246          * The specification makes it UNPREDICTABLE to enable the ITS without
1247          * marking each BASER<n> as valid. We choose to handle these as if
1248          * the table was zero-sized, so commands using the table will fail
1249          * and interrupts requested via GITS_TRANSLATER writes will be ignored.
1250          * This happens automatically by leaving the num_entries field at
1251          * zero, which will be caught by the bounds checks we have before
1252          * every table lookup anyway.
1253          */
1254         if (!FIELD_EX64(value, GITS_BASER, VALID)) {
1255             continue;
1256         }
1257         td->page_sz = page_sz;
1258         td->indirect = FIELD_EX64(value, GITS_BASER, INDIRECT);
1259         td->entry_sz = FIELD_EX64(value, GITS_BASER, ENTRYSIZE) + 1;
1260         td->base_addr = baser_base_addr(value, page_sz);
1261         if (!td->indirect) {
1262             td->num_entries = (num_pages * page_sz) / td->entry_sz;
1263         } else {
1264             td->num_entries = (((num_pages * page_sz) /
1265                                   L1TABLE_ENTRY_SIZE) *
1266                                  (page_sz / td->entry_sz));
1267         }
1268         td->num_entries = MIN(td->num_entries, 1ULL << idbits);
1269     }
1270 }
1271 
1272 static void extract_cmdq_params(GICv3ITSState *s)
1273 {
1274     uint16_t num_pages = 0;
1275     uint64_t value = s->cbaser;
1276 
1277     num_pages = FIELD_EX64(value, GITS_CBASER, SIZE) + 1;
1278 
1279     memset(&s->cq, 0 , sizeof(s->cq));
1280 
1281     if (FIELD_EX64(value, GITS_CBASER, VALID)) {
1282         s->cq.num_entries = (num_pages * GITS_PAGE_SIZE_4K) /
1283                              GITS_CMDQ_ENTRY_SIZE;
1284         s->cq.base_addr = FIELD_EX64(value, GITS_CBASER, PHYADDR);
1285         s->cq.base_addr <<= R_GITS_CBASER_PHYADDR_SHIFT;
1286     }
1287 }
1288 
1289 static MemTxResult gicv3_its_translation_read(void *opaque, hwaddr offset,
1290                                               uint64_t *data, unsigned size,
1291                                               MemTxAttrs attrs)
1292 {
1293     /*
1294      * GITS_TRANSLATER is write-only, and all other addresses
1295      * in the interrupt translation space frame are RES0.
1296      */
1297     *data = 0;
1298     return MEMTX_OK;
1299 }
1300 
1301 static MemTxResult gicv3_its_translation_write(void *opaque, hwaddr offset,
1302                                                uint64_t data, unsigned size,
1303                                                MemTxAttrs attrs)
1304 {
1305     GICv3ITSState *s = (GICv3ITSState *)opaque;
1306     bool result = true;
1307 
1308     trace_gicv3_its_translation_write(offset, data, size, attrs.requester_id);
1309 
1310     switch (offset) {
1311     case GITS_TRANSLATER:
1312         if (s->ctlr & R_GITS_CTLR_ENABLED_MASK) {
1313             result = do_process_its_cmd(s, attrs.requester_id, data, NONE);
1314         }
1315         break;
1316     default:
1317         break;
1318     }
1319 
1320     if (result) {
1321         return MEMTX_OK;
1322     } else {
1323         return MEMTX_ERROR;
1324     }
1325 }
1326 
1327 static bool its_writel(GICv3ITSState *s, hwaddr offset,
1328                               uint64_t value, MemTxAttrs attrs)
1329 {
1330     bool result = true;
1331     int index;
1332 
1333     switch (offset) {
1334     case GITS_CTLR:
1335         if (value & R_GITS_CTLR_ENABLED_MASK) {
1336             s->ctlr |= R_GITS_CTLR_ENABLED_MASK;
1337             extract_table_params(s);
1338             extract_cmdq_params(s);
1339             process_cmdq(s);
1340         } else {
1341             s->ctlr &= ~R_GITS_CTLR_ENABLED_MASK;
1342         }
1343         break;
1344     case GITS_CBASER:
1345         /*
1346          * IMPDEF choice:- GITS_CBASER register becomes RO if ITS is
1347          *                 already enabled
1348          */
1349         if (!(s->ctlr & R_GITS_CTLR_ENABLED_MASK)) {
1350             s->cbaser = deposit64(s->cbaser, 0, 32, value);
1351             s->creadr = 0;
1352         }
1353         break;
1354     case GITS_CBASER + 4:
1355         /*
1356          * IMPDEF choice:- GITS_CBASER register becomes RO if ITS is
1357          *                 already enabled
1358          */
1359         if (!(s->ctlr & R_GITS_CTLR_ENABLED_MASK)) {
1360             s->cbaser = deposit64(s->cbaser, 32, 32, value);
1361             s->creadr = 0;
1362         }
1363         break;
1364     case GITS_CWRITER:
1365         s->cwriter = deposit64(s->cwriter, 0, 32,
1366                                (value & ~R_GITS_CWRITER_RETRY_MASK));
1367         if (s->cwriter != s->creadr) {
1368             process_cmdq(s);
1369         }
1370         break;
1371     case GITS_CWRITER + 4:
1372         s->cwriter = deposit64(s->cwriter, 32, 32, value);
1373         break;
1374     case GITS_CREADR:
1375         if (s->gicv3->gicd_ctlr & GICD_CTLR_DS) {
1376             s->creadr = deposit64(s->creadr, 0, 32,
1377                                   (value & ~R_GITS_CREADR_STALLED_MASK));
1378         } else {
1379             /* RO register, ignore the write */
1380             qemu_log_mask(LOG_GUEST_ERROR,
1381                           "%s: invalid guest write to RO register at offset "
1382                           TARGET_FMT_plx "\n", __func__, offset);
1383         }
1384         break;
1385     case GITS_CREADR + 4:
1386         if (s->gicv3->gicd_ctlr & GICD_CTLR_DS) {
1387             s->creadr = deposit64(s->creadr, 32, 32, value);
1388         } else {
1389             /* RO register, ignore the write */
1390             qemu_log_mask(LOG_GUEST_ERROR,
1391                           "%s: invalid guest write to RO register at offset "
1392                           TARGET_FMT_plx "\n", __func__, offset);
1393         }
1394         break;
1395     case GITS_BASER ... GITS_BASER + 0x3f:
1396         /*
1397          * IMPDEF choice:- GITS_BASERn register becomes RO if ITS is
1398          *                 already enabled
1399          */
1400         if (!(s->ctlr & R_GITS_CTLR_ENABLED_MASK)) {
1401             index = (offset - GITS_BASER) / 8;
1402 
1403             if (s->baser[index] == 0) {
1404                 /* Unimplemented GITS_BASERn: RAZ/WI */
1405                 break;
1406             }
1407             if (offset & 7) {
1408                 value <<= 32;
1409                 value &= ~GITS_BASER_RO_MASK;
1410                 s->baser[index] &= GITS_BASER_RO_MASK | MAKE_64BIT_MASK(0, 32);
1411                 s->baser[index] |= value;
1412             } else {
1413                 value &= ~GITS_BASER_RO_MASK;
1414                 s->baser[index] &= GITS_BASER_RO_MASK | MAKE_64BIT_MASK(32, 32);
1415                 s->baser[index] |= value;
1416             }
1417         }
1418         break;
1419     case GITS_IIDR:
1420     case GITS_IDREGS ... GITS_IDREGS + 0x2f:
1421         /* RO registers, ignore the write */
1422         qemu_log_mask(LOG_GUEST_ERROR,
1423                       "%s: invalid guest write to RO register at offset "
1424                       TARGET_FMT_plx "\n", __func__, offset);
1425         break;
1426     default:
1427         result = false;
1428         break;
1429     }
1430     return result;
1431 }
1432 
1433 static bool its_readl(GICv3ITSState *s, hwaddr offset,
1434                              uint64_t *data, MemTxAttrs attrs)
1435 {
1436     bool result = true;
1437     int index;
1438 
1439     switch (offset) {
1440     case GITS_CTLR:
1441         *data = s->ctlr;
1442         break;
1443     case GITS_IIDR:
1444         *data = gicv3_iidr();
1445         break;
1446     case GITS_IDREGS ... GITS_IDREGS + 0x2f:
1447         /* ID registers */
1448         *data = gicv3_idreg(offset - GITS_IDREGS, GICV3_PIDR0_ITS);
1449         break;
1450     case GITS_TYPER:
1451         *data = extract64(s->typer, 0, 32);
1452         break;
1453     case GITS_TYPER + 4:
1454         *data = extract64(s->typer, 32, 32);
1455         break;
1456     case GITS_CBASER:
1457         *data = extract64(s->cbaser, 0, 32);
1458         break;
1459     case GITS_CBASER + 4:
1460         *data = extract64(s->cbaser, 32, 32);
1461         break;
1462     case GITS_CREADR:
1463         *data = extract64(s->creadr, 0, 32);
1464         break;
1465     case GITS_CREADR + 4:
1466         *data = extract64(s->creadr, 32, 32);
1467         break;
1468     case GITS_CWRITER:
1469         *data = extract64(s->cwriter, 0, 32);
1470         break;
1471     case GITS_CWRITER + 4:
1472         *data = extract64(s->cwriter, 32, 32);
1473         break;
1474     case GITS_BASER ... GITS_BASER + 0x3f:
1475         index = (offset - GITS_BASER) / 8;
1476         if (offset & 7) {
1477             *data = extract64(s->baser[index], 32, 32);
1478         } else {
1479             *data = extract64(s->baser[index], 0, 32);
1480         }
1481         break;
1482     default:
1483         result = false;
1484         break;
1485     }
1486     return result;
1487 }
1488 
1489 static bool its_writell(GICv3ITSState *s, hwaddr offset,
1490                                uint64_t value, MemTxAttrs attrs)
1491 {
1492     bool result = true;
1493     int index;
1494 
1495     switch (offset) {
1496     case GITS_BASER ... GITS_BASER + 0x3f:
1497         /*
1498          * IMPDEF choice:- GITS_BASERn register becomes RO if ITS is
1499          *                 already enabled
1500          */
1501         if (!(s->ctlr & R_GITS_CTLR_ENABLED_MASK)) {
1502             index = (offset - GITS_BASER) / 8;
1503             if (s->baser[index] == 0) {
1504                 /* Unimplemented GITS_BASERn: RAZ/WI */
1505                 break;
1506             }
1507             s->baser[index] &= GITS_BASER_RO_MASK;
1508             s->baser[index] |= (value & ~GITS_BASER_RO_MASK);
1509         }
1510         break;
1511     case GITS_CBASER:
1512         /*
1513          * IMPDEF choice:- GITS_CBASER register becomes RO if ITS is
1514          *                 already enabled
1515          */
1516         if (!(s->ctlr & R_GITS_CTLR_ENABLED_MASK)) {
1517             s->cbaser = value;
1518             s->creadr = 0;
1519         }
1520         break;
1521     case GITS_CWRITER:
1522         s->cwriter = value & ~R_GITS_CWRITER_RETRY_MASK;
1523         if (s->cwriter != s->creadr) {
1524             process_cmdq(s);
1525         }
1526         break;
1527     case GITS_CREADR:
1528         if (s->gicv3->gicd_ctlr & GICD_CTLR_DS) {
1529             s->creadr = value & ~R_GITS_CREADR_STALLED_MASK;
1530         } else {
1531             /* RO register, ignore the write */
1532             qemu_log_mask(LOG_GUEST_ERROR,
1533                           "%s: invalid guest write to RO register at offset "
1534                           TARGET_FMT_plx "\n", __func__, offset);
1535         }
1536         break;
1537     case GITS_TYPER:
1538         /* RO registers, ignore the write */
1539         qemu_log_mask(LOG_GUEST_ERROR,
1540                       "%s: invalid guest write to RO register at offset "
1541                       TARGET_FMT_plx "\n", __func__, offset);
1542         break;
1543     default:
1544         result = false;
1545         break;
1546     }
1547     return result;
1548 }
1549 
1550 static bool its_readll(GICv3ITSState *s, hwaddr offset,
1551                               uint64_t *data, MemTxAttrs attrs)
1552 {
1553     bool result = true;
1554     int index;
1555 
1556     switch (offset) {
1557     case GITS_TYPER:
1558         *data = s->typer;
1559         break;
1560     case GITS_BASER ... GITS_BASER + 0x3f:
1561         index = (offset - GITS_BASER) / 8;
1562         *data = s->baser[index];
1563         break;
1564     case GITS_CBASER:
1565         *data = s->cbaser;
1566         break;
1567     case GITS_CREADR:
1568         *data = s->creadr;
1569         break;
1570     case GITS_CWRITER:
1571         *data = s->cwriter;
1572         break;
1573     default:
1574         result = false;
1575         break;
1576     }
1577     return result;
1578 }
1579 
1580 static MemTxResult gicv3_its_read(void *opaque, hwaddr offset, uint64_t *data,
1581                                   unsigned size, MemTxAttrs attrs)
1582 {
1583     GICv3ITSState *s = (GICv3ITSState *)opaque;
1584     bool result;
1585 
1586     switch (size) {
1587     case 4:
1588         result = its_readl(s, offset, data, attrs);
1589         break;
1590     case 8:
1591         result = its_readll(s, offset, data, attrs);
1592         break;
1593     default:
1594         result = false;
1595         break;
1596     }
1597 
1598     if (!result) {
1599         qemu_log_mask(LOG_GUEST_ERROR,
1600                       "%s: invalid guest read at offset " TARGET_FMT_plx
1601                       " size %u\n", __func__, offset, size);
1602         trace_gicv3_its_badread(offset, size);
1603         /*
1604          * The spec requires that reserved registers are RAZ/WI;
1605          * so use false returns from leaf functions as a way to
1606          * trigger the guest-error logging but don't return it to
1607          * the caller, or we'll cause a spurious guest data abort.
1608          */
1609         *data = 0;
1610     } else {
1611         trace_gicv3_its_read(offset, *data, size);
1612     }
1613     return MEMTX_OK;
1614 }
1615 
1616 static MemTxResult gicv3_its_write(void *opaque, hwaddr offset, uint64_t data,
1617                                    unsigned size, MemTxAttrs attrs)
1618 {
1619     GICv3ITSState *s = (GICv3ITSState *)opaque;
1620     bool result;
1621 
1622     switch (size) {
1623     case 4:
1624         result = its_writel(s, offset, data, attrs);
1625         break;
1626     case 8:
1627         result = its_writell(s, offset, data, attrs);
1628         break;
1629     default:
1630         result = false;
1631         break;
1632     }
1633 
1634     if (!result) {
1635         qemu_log_mask(LOG_GUEST_ERROR,
1636                       "%s: invalid guest write at offset " TARGET_FMT_plx
1637                       " size %u\n", __func__, offset, size);
1638         trace_gicv3_its_badwrite(offset, data, size);
1639         /*
1640          * The spec requires that reserved registers are RAZ/WI;
1641          * so use false returns from leaf functions as a way to
1642          * trigger the guest-error logging but don't return it to
1643          * the caller, or we'll cause a spurious guest data abort.
1644          */
1645     } else {
1646         trace_gicv3_its_write(offset, data, size);
1647     }
1648     return MEMTX_OK;
1649 }
1650 
1651 static const MemoryRegionOps gicv3_its_control_ops = {
1652     .read_with_attrs = gicv3_its_read,
1653     .write_with_attrs = gicv3_its_write,
1654     .valid.min_access_size = 4,
1655     .valid.max_access_size = 8,
1656     .impl.min_access_size = 4,
1657     .impl.max_access_size = 8,
1658     .endianness = DEVICE_NATIVE_ENDIAN,
1659 };
1660 
1661 static const MemoryRegionOps gicv3_its_translation_ops = {
1662     .read_with_attrs = gicv3_its_translation_read,
1663     .write_with_attrs = gicv3_its_translation_write,
1664     .valid.min_access_size = 2,
1665     .valid.max_access_size = 4,
1666     .impl.min_access_size = 2,
1667     .impl.max_access_size = 4,
1668     .endianness = DEVICE_NATIVE_ENDIAN,
1669 };
1670 
1671 static void gicv3_arm_its_realize(DeviceState *dev, Error **errp)
1672 {
1673     GICv3ITSState *s = ARM_GICV3_ITS_COMMON(dev);
1674     int i;
1675 
1676     for (i = 0; i < s->gicv3->num_cpu; i++) {
1677         if (!(s->gicv3->cpu[i].gicr_typer & GICR_TYPER_PLPIS)) {
1678             error_setg(errp, "Physical LPI not supported by CPU %d", i);
1679             return;
1680         }
1681     }
1682 
1683     gicv3_its_init_mmio(s, &gicv3_its_control_ops, &gicv3_its_translation_ops);
1684 
1685     /* set the ITS default features supported */
1686     s->typer = FIELD_DP64(s->typer, GITS_TYPER, PHYSICAL, 1);
1687     s->typer = FIELD_DP64(s->typer, GITS_TYPER, ITT_ENTRY_SIZE,
1688                           ITS_ITT_ENTRY_SIZE - 1);
1689     s->typer = FIELD_DP64(s->typer, GITS_TYPER, IDBITS, ITS_IDBITS);
1690     s->typer = FIELD_DP64(s->typer, GITS_TYPER, DEVBITS, ITS_DEVBITS);
1691     s->typer = FIELD_DP64(s->typer, GITS_TYPER, CIL, 1);
1692     s->typer = FIELD_DP64(s->typer, GITS_TYPER, CIDBITS, ITS_CIDBITS);
1693 }
1694 
1695 static void gicv3_its_reset(DeviceState *dev)
1696 {
1697     GICv3ITSState *s = ARM_GICV3_ITS_COMMON(dev);
1698     GICv3ITSClass *c = ARM_GICV3_ITS_GET_CLASS(s);
1699 
1700     c->parent_reset(dev);
1701 
1702     /* Quiescent bit reset to 1 */
1703     s->ctlr = FIELD_DP32(s->ctlr, GITS_CTLR, QUIESCENT, 1);
1704 
1705     /*
1706      * setting GITS_BASER0.Type = 0b001 (Device)
1707      *         GITS_BASER1.Type = 0b100 (Collection Table)
1708      *         GITS_BASER2.Type = 0b010 (vPE) for GICv4 and later
1709      *         GITS_BASER<n>.Type,where n = 3 to 7 are 0b00 (Unimplemented)
1710      *         GITS_BASER<0,1>.Page_Size = 64KB
1711      * and default translation table entry size to 16 bytes
1712      */
1713     s->baser[0] = FIELD_DP64(s->baser[0], GITS_BASER, TYPE,
1714                              GITS_BASER_TYPE_DEVICE);
1715     s->baser[0] = FIELD_DP64(s->baser[0], GITS_BASER, PAGESIZE,
1716                              GITS_BASER_PAGESIZE_64K);
1717     s->baser[0] = FIELD_DP64(s->baser[0], GITS_BASER, ENTRYSIZE,
1718                              GITS_DTE_SIZE - 1);
1719 
1720     s->baser[1] = FIELD_DP64(s->baser[1], GITS_BASER, TYPE,
1721                              GITS_BASER_TYPE_COLLECTION);
1722     s->baser[1] = FIELD_DP64(s->baser[1], GITS_BASER, PAGESIZE,
1723                              GITS_BASER_PAGESIZE_64K);
1724     s->baser[1] = FIELD_DP64(s->baser[1], GITS_BASER, ENTRYSIZE,
1725                              GITS_CTE_SIZE - 1);
1726 
1727     if (its_feature_virtual(s)) {
1728         s->baser[2] = FIELD_DP64(s->baser[2], GITS_BASER, TYPE,
1729                                  GITS_BASER_TYPE_VPE);
1730         s->baser[2] = FIELD_DP64(s->baser[2], GITS_BASER, PAGESIZE,
1731                                  GITS_BASER_PAGESIZE_64K);
1732         s->baser[2] = FIELD_DP64(s->baser[2], GITS_BASER, ENTRYSIZE,
1733                                  GITS_VPE_SIZE - 1);
1734     }
1735 }
1736 
1737 static void gicv3_its_post_load(GICv3ITSState *s)
1738 {
1739     if (s->ctlr & R_GITS_CTLR_ENABLED_MASK) {
1740         extract_table_params(s);
1741         extract_cmdq_params(s);
1742     }
1743 }
1744 
1745 static Property gicv3_its_props[] = {
1746     DEFINE_PROP_LINK("parent-gicv3", GICv3ITSState, gicv3, "arm-gicv3",
1747                      GICv3State *),
1748     DEFINE_PROP_END_OF_LIST(),
1749 };
1750 
1751 static void gicv3_its_class_init(ObjectClass *klass, void *data)
1752 {
1753     DeviceClass *dc = DEVICE_CLASS(klass);
1754     GICv3ITSClass *ic = ARM_GICV3_ITS_CLASS(klass);
1755     GICv3ITSCommonClass *icc = ARM_GICV3_ITS_COMMON_CLASS(klass);
1756 
1757     dc->realize = gicv3_arm_its_realize;
1758     device_class_set_props(dc, gicv3_its_props);
1759     device_class_set_parent_reset(dc, gicv3_its_reset, &ic->parent_reset);
1760     icc->post_load = gicv3_its_post_load;
1761 }
1762 
1763 static const TypeInfo gicv3_its_info = {
1764     .name = TYPE_ARM_GICV3_ITS,
1765     .parent = TYPE_ARM_GICV3_ITS_COMMON,
1766     .instance_size = sizeof(GICv3ITSState),
1767     .class_init = gicv3_its_class_init,
1768     .class_size = sizeof(GICv3ITSClass),
1769 };
1770 
1771 static void gicv3_its_register_types(void)
1772 {
1773     type_register_static(&gicv3_its_info);
1774 }
1775 
1776 type_init(gicv3_its_register_types)
1777