2 * Copyright (c) 2015-2016 The FreeBSD Foundation
4 * This software was developed by Andrew Turner under
5 * the sponsorship of the FreeBSD Foundation.
7 * This software was developed by Semihalf under
8 * the sponsorship of the FreeBSD Foundation.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 #include "opt_platform.h"
34 #include "opt_iommu.h"
36 #include <sys/cdefs.h>
37 __FBSDID("$FreeBSD$");
39 #include <sys/param.h>
40 #include <sys/systm.h>
42 #include <sys/cpuset.h>
43 #include <sys/endian.h>
44 #include <sys/kernel.h>
46 #include <sys/malloc.h>
47 #include <sys/module.h>
48 #include <sys/mutex.h>
50 #include <sys/taskqueue.h>
52 #include <sys/queue.h>
56 #include <sys/sysctl.h>
61 #include <vm/vm_page.h>
63 #include <machine/bus.h>
64 #include <machine/intr.h>
66 #include <arm/arm/gic_common.h>
67 #include <arm64/arm64/gic_v3_reg.h>
68 #include <arm64/arm64/gic_v3_var.h>
71 #include <dev/ofw/openfirm.h>
72 #include <dev/ofw/ofw_bus.h>
73 #include <dev/ofw/ofw_bus_subr.h>
75 #include <dev/pci/pcireg.h>
76 #include <dev/pci/pcivar.h>
79 #include <dev/iommu/iommu.h>
80 #include <dev/iommu/iommu_gas.h>
87 MALLOC_DEFINE(M_GICV3_ITS, "GICv3 ITS",
88 "ARM GICv3 Interrupt Translation Service");
90 #define LPI_NIRQS (64 * 1024)
92 /* The size and alignment of the command circular buffer */
93 #define ITS_CMDQ_SIZE (64 * 1024) /* Must be a multiple of 4K */
94 #define ITS_CMDQ_ALIGN (64 * 1024)
96 #define LPI_CONFTAB_SIZE LPI_NIRQS
97 #define LPI_CONFTAB_ALIGN (64 * 1024)
98 #define LPI_CONFTAB_MAX_ADDR ((1ul << 48) - 1) /* We need a 47 bit PA */
100 /* 1 bit per SPI, PPI, and SGI (8k), and 1 bit per LPI (LPI_CONFTAB_SIZE) */
101 #define LPI_PENDTAB_SIZE ((LPI_NIRQS + GIC_FIRST_LPI) / 8)
102 #define LPI_PENDTAB_ALIGN (64 * 1024)
103 #define LPI_PENDTAB_MAX_ADDR ((1ul << 48) - 1) /* We need a 47 bit PA */
105 #define LPI_INT_TRANS_TAB_ALIGN 256
106 #define LPI_INT_TRANS_TAB_MAX_ADDR ((1ul << 48) - 1)
108 /* ITS commands encoding */
109 #define ITS_CMD_MOVI (0x01)
110 #define ITS_CMD_SYNC (0x05)
111 #define ITS_CMD_MAPD (0x08)
112 #define ITS_CMD_MAPC (0x09)
113 #define ITS_CMD_MAPTI (0x0a)
114 #define ITS_CMD_MAPI (0x0b)
115 #define ITS_CMD_INV (0x0c)
116 #define ITS_CMD_INVALL (0x0d)
118 #define CMD_COMMAND_MASK (0xFFUL)
120 #define CMD_DEVID_SHIFT (32)
121 #define CMD_DEVID_MASK (0xFFFFFFFFUL << CMD_DEVID_SHIFT)
122 /* Size of IRQ ID bitfield */
123 #define CMD_SIZE_MASK (0xFFUL)
125 #define CMD_ID_MASK (0xFFFFFFFFUL)
126 /* Physical LPI ID */
127 #define CMD_PID_SHIFT (32)
128 #define CMD_PID_MASK (0xFFFFFFFFUL << CMD_PID_SHIFT)
130 #define CMD_COL_MASK (0xFFFFUL)
131 /* Target (CPU or Re-Distributor) */
132 #define CMD_TARGET_SHIFT (16)
133 #define CMD_TARGET_MASK (0xFFFFFFFFUL << CMD_TARGET_SHIFT)
134 /* Interrupt Translation Table address */
135 #define CMD_ITT_MASK (0xFFFFFFFFFF00UL)
136 /* Valid command bit */
137 #define CMD_VALID_SHIFT (63)
138 #define CMD_VALID_MASK (1UL << CMD_VALID_SHIFT)
140 #define ITS_TARGET_NONE 0xFBADBEEF
142 /* LPI chunk owned by ITS device */
145 u_int lpi_free; /* First free LPI in set */
146 u_int lpi_num; /* Total number of LPIs in chunk */
147 u_int lpi_busy; /* Number of busy LPIs in chink */
152 TAILQ_ENTRY(its_dev) entry;
155 /* Device ID (i.e. PCI device ID) */
157 /* List of assigned LPIs */
158 struct lpi_chunk lpis;
159 /* Virtual address of ITT */
165 * ITS command descriptor.
166 * Idea for command description passing taken from Linux.
168 struct its_cmd_desc {
173 struct its_dev *its_dev;
188 struct its_dev *its_dev;
195 struct its_dev *its_dev;
201 struct its_dev *its_dev;
206 struct its_dev *its_dev;
217 /* ITS command. Each command is 32 bytes long */
219 uint64_t cmd_dword[4]; /* ITS command double word */
222 /* An ITS private table */
224 vm_offset_t ptab_vaddr;
225 unsigned long ptab_size;
228 /* ITS collection description. */
230 uint64_t col_target; /* Target Re-Distributor */
231 uint64_t col_id; /* Collection ID */
234 struct gicv3_its_irqsrc {
235 struct intr_irqsrc gi_isrc;
238 struct its_dev *gi_its_dev;
239 TAILQ_ENTRY(gicv3_its_irqsrc) gi_link;
242 struct gicv3_its_softc {
244 struct intr_pic *sc_pic;
245 struct resource *sc_its_res;
250 struct its_ptable sc_its_ptab[GITS_BASER_NUM];
251 struct its_col *sc_its_cols[MAXCPU]; /* Per-CPU collections */
254 * TODO: We should get these from the parent as we only want a
255 * single copy of each across the interrupt controller.
257 uint8_t *sc_conf_base;
258 vm_offset_t sc_pend_base[MAXCPU];
260 /* Command handling */
261 struct mtx sc_its_cmd_lock;
262 struct its_cmd *sc_its_cmd_base; /* Command circular buffer address */
263 size_t sc_its_cmd_next_idx;
265 vmem_t *sc_irq_alloc;
266 struct gicv3_its_irqsrc **sc_irqs;
271 struct mtx sc_its_dev_lock;
272 TAILQ_HEAD(its_dev_list, its_dev) sc_its_dev_list;
273 TAILQ_HEAD(free_irqs, gicv3_its_irqsrc) sc_free_irqs;
275 #define ITS_FLAGS_CMDQ_FLUSH 0x00000001
276 #define ITS_FLAGS_LPI_CONF_FLUSH 0x00000002
277 #define ITS_FLAGS_ERRATA_CAVIUM_22375 0x00000004
280 vm_page_t ma; /* fake msi page */
283 static void *conf_base;
285 typedef void (its_quirk_func_t)(device_t);
286 static its_quirk_func_t its_quirk_cavium_22375;
288 static const struct {
292 its_quirk_func_t *func;
295 /* Cavium ThunderX Pass 1.x */
296 .desc = "Cavium ThunderX errata: 22375, 24313",
297 .iidr = GITS_IIDR_RAW(GITS_IIDR_IMPL_CAVIUM,
298 GITS_IIDR_PROD_THUNDER, GITS_IIDR_VAR_THUNDER_1, 0),
299 .iidr_mask = ~GITS_IIDR_REVISION_MASK,
300 .func = its_quirk_cavium_22375,
304 #define gic_its_read_4(sc, reg) \
305 bus_read_4((sc)->sc_its_res, (reg))
306 #define gic_its_read_8(sc, reg) \
307 bus_read_8((sc)->sc_its_res, (reg))
309 #define gic_its_write_4(sc, reg, val) \
310 bus_write_4((sc)->sc_its_res, (reg), (val))
311 #define gic_its_write_8(sc, reg, val) \
312 bus_write_8((sc)->sc_its_res, (reg), (val))
314 static device_attach_t gicv3_its_attach;
315 static device_detach_t gicv3_its_detach;
317 static pic_disable_intr_t gicv3_its_disable_intr;
318 static pic_enable_intr_t gicv3_its_enable_intr;
319 static pic_map_intr_t gicv3_its_map_intr;
320 static pic_setup_intr_t gicv3_its_setup_intr;
321 static pic_post_filter_t gicv3_its_post_filter;
322 static pic_post_ithread_t gicv3_its_post_ithread;
323 static pic_pre_ithread_t gicv3_its_pre_ithread;
324 static pic_bind_intr_t gicv3_its_bind_intr;
326 static pic_init_secondary_t gicv3_its_init_secondary;
328 static msi_alloc_msi_t gicv3_its_alloc_msi;
329 static msi_release_msi_t gicv3_its_release_msi;
330 static msi_alloc_msix_t gicv3_its_alloc_msix;
331 static msi_release_msix_t gicv3_its_release_msix;
332 static msi_map_msi_t gicv3_its_map_msi;
334 static msi_iommu_init_t gicv3_iommu_init;
335 static msi_iommu_deinit_t gicv3_iommu_deinit;
338 static void its_cmd_movi(device_t, struct gicv3_its_irqsrc *);
339 static void its_cmd_mapc(device_t, struct its_col *, uint8_t);
340 static void its_cmd_mapti(device_t, struct gicv3_its_irqsrc *);
341 static void its_cmd_mapd(device_t, struct its_dev *, uint8_t);
342 static void its_cmd_inv(device_t, struct its_dev *, struct gicv3_its_irqsrc *);
343 static void its_cmd_invall(device_t, struct its_col *);
345 static device_method_t gicv3_its_methods[] = {
346 /* Device interface */
347 DEVMETHOD(device_detach, gicv3_its_detach),
349 /* Interrupt controller interface */
350 DEVMETHOD(pic_disable_intr, gicv3_its_disable_intr),
351 DEVMETHOD(pic_enable_intr, gicv3_its_enable_intr),
352 DEVMETHOD(pic_map_intr, gicv3_its_map_intr),
353 DEVMETHOD(pic_setup_intr, gicv3_its_setup_intr),
354 DEVMETHOD(pic_post_filter, gicv3_its_post_filter),
355 DEVMETHOD(pic_post_ithread, gicv3_its_post_ithread),
356 DEVMETHOD(pic_pre_ithread, gicv3_its_pre_ithread),
358 DEVMETHOD(pic_bind_intr, gicv3_its_bind_intr),
359 DEVMETHOD(pic_init_secondary, gicv3_its_init_secondary),
363 DEVMETHOD(msi_alloc_msi, gicv3_its_alloc_msi),
364 DEVMETHOD(msi_release_msi, gicv3_its_release_msi),
365 DEVMETHOD(msi_alloc_msix, gicv3_its_alloc_msix),
366 DEVMETHOD(msi_release_msix, gicv3_its_release_msix),
367 DEVMETHOD(msi_map_msi, gicv3_its_map_msi),
369 DEVMETHOD(msi_iommu_init, gicv3_iommu_init),
370 DEVMETHOD(msi_iommu_deinit, gicv3_iommu_deinit),
377 static DEFINE_CLASS_0(gic, gicv3_its_driver, gicv3_its_methods,
378 sizeof(struct gicv3_its_softc));
381 gicv3_its_cmdq_init(struct gicv3_its_softc *sc)
383 vm_paddr_t cmd_paddr;
386 /* Set up the command circular buffer */
387 sc->sc_its_cmd_base = contigmalloc(ITS_CMDQ_SIZE, M_GICV3_ITS,
388 M_WAITOK | M_ZERO, 0, (1ul << 48) - 1, ITS_CMDQ_ALIGN, 0);
389 sc->sc_its_cmd_next_idx = 0;
391 cmd_paddr = vtophys(sc->sc_its_cmd_base);
393 /* Set the base of the command buffer */
394 reg = GITS_CBASER_VALID |
395 (GITS_CBASER_CACHE_NIWAWB << GITS_CBASER_CACHE_SHIFT) |
396 cmd_paddr | (GITS_CBASER_SHARE_IS << GITS_CBASER_SHARE_SHIFT) |
397 (ITS_CMDQ_SIZE / 4096 - 1);
398 gic_its_write_8(sc, GITS_CBASER, reg);
400 /* Read back to check for fixed value fields */
401 tmp = gic_its_read_8(sc, GITS_CBASER);
403 if ((tmp & GITS_CBASER_SHARE_MASK) !=
404 (GITS_CBASER_SHARE_IS << GITS_CBASER_SHARE_SHIFT)) {
405 /* Check if the hardware reported non-shareable */
406 if ((tmp & GITS_CBASER_SHARE_MASK) ==
407 (GITS_CBASER_SHARE_NS << GITS_CBASER_SHARE_SHIFT)) {
408 /* If so remove the cache attribute */
409 reg &= ~GITS_CBASER_CACHE_MASK;
410 reg &= ~GITS_CBASER_SHARE_MASK;
411 /* Set to Non-cacheable, Non-shareable */
412 reg |= GITS_CBASER_CACHE_NIN << GITS_CBASER_CACHE_SHIFT;
413 reg |= GITS_CBASER_SHARE_NS << GITS_CBASER_SHARE_SHIFT;
415 gic_its_write_8(sc, GITS_CBASER, reg);
418 /* The command queue has to be flushed after each command */
419 sc->sc_its_flags |= ITS_FLAGS_CMDQ_FLUSH;
422 /* Get the next command from the start of the buffer */
423 gic_its_write_8(sc, GITS_CWRITER, 0x0);
427 gicv3_its_table_init(device_t dev, struct gicv3_its_softc *sc)
431 uint64_t cache, reg, share, tmp, type;
432 size_t esize, its_tbl_size, nidents, nitspages, npages;
436 if ((sc->sc_its_flags & ITS_FLAGS_ERRATA_CAVIUM_22375) != 0) {
438 * GITS_TYPER[17:13] of ThunderX reports that device IDs
439 * are to be 21 bits in length. The entry size of the ITS
440 * table can be read from GITS_BASERn[52:48] and on ThunderX
441 * is supposed to be 8 bytes in length (for device table).
442 * Finally the page size that is to be used by ITS to access
443 * this table will be set to 64KB.
445 * This gives 0x200000 entries of size 0x8 bytes covered by
446 * 256 pages each of which 64KB in size. The number of pages
447 * (minus 1) should then be written to GITS_BASERn[7:0]. In
448 * that case this value would be 0xFF but on ThunderX the
449 * maximum value that HW accepts is 0xFD.
451 * Set an arbitrary number of device ID bits to 20 in order
452 * to limit the number of entries in ITS device table to
453 * 0x100000 and the table size to 8MB.
458 devbits = GITS_TYPER_DEVB(gic_its_read_8(sc, GITS_TYPER));
459 cache = GITS_BASER_CACHE_WAWB;
461 share = GITS_BASER_SHARE_IS;
462 page_size = PAGE_SIZE_64K;
464 for (i = 0; i < GITS_BASER_NUM; i++) {
465 reg = gic_its_read_8(sc, GITS_BASER(i));
466 /* The type of table */
467 type = GITS_BASER_TYPE(reg);
468 /* The table entry size */
469 esize = GITS_BASER_ESIZE(reg);
472 case GITS_BASER_TYPE_DEV:
473 nidents = (1 << devbits);
474 its_tbl_size = esize * nidents;
475 its_tbl_size = roundup2(its_tbl_size, PAGE_SIZE_64K);
477 case GITS_BASER_TYPE_VP:
478 case GITS_BASER_TYPE_PP: /* Undocumented? */
479 case GITS_BASER_TYPE_IC:
480 its_tbl_size = page_size;
485 npages = howmany(its_tbl_size, PAGE_SIZE);
487 /* Allocate the table */
488 table = (vm_offset_t)contigmalloc(npages * PAGE_SIZE,
489 M_GICV3_ITS, M_WAITOK | M_ZERO, 0, (1ul << 48) - 1,
492 sc->sc_its_ptab[i].ptab_vaddr = table;
493 sc->sc_its_ptab[i].ptab_size = npages * PAGE_SIZE;
495 paddr = vtophys(table);
498 nitspages = howmany(its_tbl_size, page_size);
500 /* Clear the fields we will be setting */
501 reg &= ~(GITS_BASER_VALID |
502 GITS_BASER_CACHE_MASK | GITS_BASER_TYPE_MASK |
503 GITS_BASER_ESIZE_MASK | GITS_BASER_PA_MASK |
504 GITS_BASER_SHARE_MASK | GITS_BASER_PSZ_MASK |
505 GITS_BASER_SIZE_MASK);
506 /* Set the new values */
507 reg |= GITS_BASER_VALID |
508 (cache << GITS_BASER_CACHE_SHIFT) |
509 (type << GITS_BASER_TYPE_SHIFT) |
510 ((esize - 1) << GITS_BASER_ESIZE_SHIFT) |
511 paddr | (share << GITS_BASER_SHARE_SHIFT) |
515 case PAGE_SIZE_4K: /* 4KB */
517 GITS_BASER_PSZ_4K << GITS_BASER_PSZ_SHIFT;
519 case PAGE_SIZE_16K: /* 16KB */
521 GITS_BASER_PSZ_16K << GITS_BASER_PSZ_SHIFT;
523 case PAGE_SIZE_64K: /* 64KB */
525 GITS_BASER_PSZ_64K << GITS_BASER_PSZ_SHIFT;
529 gic_its_write_8(sc, GITS_BASER(i), reg);
531 /* Read back to check */
532 tmp = gic_its_read_8(sc, GITS_BASER(i));
534 /* Do the shareability masks line up? */
535 if ((tmp & GITS_BASER_SHARE_MASK) !=
536 (reg & GITS_BASER_SHARE_MASK)) {
537 share = (tmp & GITS_BASER_SHARE_MASK) >>
538 GITS_BASER_SHARE_SHIFT;
542 if ((tmp & GITS_BASER_PSZ_MASK) !=
543 (reg & GITS_BASER_PSZ_MASK)) {
546 page_size = PAGE_SIZE_4K;
549 page_size = PAGE_SIZE_16K;
555 device_printf(dev, "GITS_BASER%d: "
556 "unable to be updated: %lx != %lx\n",
561 /* We should have made all needed changes */
570 gicv3_its_conftable_init(struct gicv3_its_softc *sc)
574 conf_table = atomic_load_ptr(&conf_base);
575 if (conf_table == NULL) {
576 conf_table = contigmalloc(LPI_CONFTAB_SIZE,
577 M_GICV3_ITS, M_WAITOK, 0, LPI_CONFTAB_MAX_ADDR,
578 LPI_CONFTAB_ALIGN, 0);
580 if (atomic_cmpset_ptr((uintptr_t *)&conf_base,
581 (uintptr_t)NULL, (uintptr_t)conf_table) == 0) {
582 contigfree(conf_table, LPI_CONFTAB_SIZE, M_GICV3_ITS);
583 conf_table = atomic_load_ptr(&conf_base);
586 sc->sc_conf_base = conf_table;
588 /* Set the default configuration */
589 memset(sc->sc_conf_base, GIC_PRIORITY_MAX | LPI_CONF_GROUP1,
592 /* Flush the table to memory */
593 cpu_dcache_wb_range((vm_offset_t)sc->sc_conf_base, LPI_CONFTAB_SIZE);
597 gicv3_its_pendtables_init(struct gicv3_its_softc *sc)
601 for (i = 0; i <= mp_maxid; i++) {
602 if (CPU_ISSET(i, &sc->sc_cpus) == 0)
605 sc->sc_pend_base[i] = (vm_offset_t)contigmalloc(
606 LPI_PENDTAB_SIZE, M_GICV3_ITS, M_WAITOK | M_ZERO,
607 0, LPI_PENDTAB_MAX_ADDR, LPI_PENDTAB_ALIGN, 0);
609 /* Flush so the ITS can see the memory */
610 cpu_dcache_wb_range((vm_offset_t)sc->sc_pend_base[i],
616 its_init_cpu_lpi(device_t dev, struct gicv3_its_softc *sc)
619 uint64_t xbaser, tmp;
623 gicv3 = device_get_parent(dev);
624 cpuid = PCPU_GET(cpuid);
627 ctlr = gic_r_read_4(gicv3, GICR_CTLR);
628 ctlr &= ~GICR_CTLR_LPI_ENABLE;
629 gic_r_write_4(gicv3, GICR_CTLR, ctlr);
631 /* Make sure changes are observable my the GIC */
635 * Set the redistributor base
637 xbaser = vtophys(sc->sc_conf_base) |
638 (GICR_PROPBASER_SHARE_IS << GICR_PROPBASER_SHARE_SHIFT) |
639 (GICR_PROPBASER_CACHE_NIWAWB << GICR_PROPBASER_CACHE_SHIFT) |
640 (flsl(LPI_CONFTAB_SIZE | GIC_FIRST_LPI) - 1);
641 gic_r_write_8(gicv3, GICR_PROPBASER, xbaser);
643 /* Check the cache attributes we set */
644 tmp = gic_r_read_8(gicv3, GICR_PROPBASER);
646 if ((tmp & GICR_PROPBASER_SHARE_MASK) !=
647 (xbaser & GICR_PROPBASER_SHARE_MASK)) {
648 if ((tmp & GICR_PROPBASER_SHARE_MASK) ==
649 (GICR_PROPBASER_SHARE_NS << GICR_PROPBASER_SHARE_SHIFT)) {
650 /* We need to mark as non-cacheable */
651 xbaser &= ~(GICR_PROPBASER_SHARE_MASK |
652 GICR_PROPBASER_CACHE_MASK);
654 xbaser |= GICR_PROPBASER_CACHE_NIN <<
655 GICR_PROPBASER_CACHE_SHIFT;
657 xbaser |= GICR_PROPBASER_SHARE_NS <<
658 GICR_PROPBASER_SHARE_SHIFT;
659 gic_r_write_8(gicv3, GICR_PROPBASER, xbaser);
661 sc->sc_its_flags |= ITS_FLAGS_LPI_CONF_FLUSH;
665 * Set the LPI pending table base
667 xbaser = vtophys(sc->sc_pend_base[cpuid]) |
668 (GICR_PENDBASER_CACHE_NIWAWB << GICR_PENDBASER_CACHE_SHIFT) |
669 (GICR_PENDBASER_SHARE_IS << GICR_PENDBASER_SHARE_SHIFT);
671 gic_r_write_8(gicv3, GICR_PENDBASER, xbaser);
673 tmp = gic_r_read_8(gicv3, GICR_PENDBASER);
675 if ((tmp & GICR_PENDBASER_SHARE_MASK) ==
676 (GICR_PENDBASER_SHARE_NS << GICR_PENDBASER_SHARE_SHIFT)) {
677 /* Clear the cahce and shareability bits */
678 xbaser &= ~(GICR_PENDBASER_CACHE_MASK |
679 GICR_PENDBASER_SHARE_MASK);
680 /* Mark as non-shareable */
681 xbaser |= GICR_PENDBASER_SHARE_NS << GICR_PENDBASER_SHARE_SHIFT;
682 /* And non-cacheable */
683 xbaser |= GICR_PENDBASER_CACHE_NIN <<
684 GICR_PENDBASER_CACHE_SHIFT;
688 ctlr = gic_r_read_4(gicv3, GICR_CTLR);
689 ctlr |= GICR_CTLR_LPI_ENABLE;
690 gic_r_write_4(gicv3, GICR_CTLR, ctlr);
692 /* Make sure the GIC has seen everything */
697 its_init_cpu(device_t dev, struct gicv3_its_softc *sc)
702 struct redist_pcpu *rpcpu;
704 gicv3 = device_get_parent(dev);
705 cpuid = PCPU_GET(cpuid);
706 if (!CPU_ISSET(cpuid, &sc->sc_cpus))
709 /* Check if the ITS is enabled on this CPU */
710 if ((gic_r_read_8(gicv3, GICR_TYPER) & GICR_TYPER_PLPIS) == 0)
713 rpcpu = gicv3_get_redist(dev);
715 /* Do per-cpu LPI init once */
716 if (!rpcpu->lpi_enabled) {
717 its_init_cpu_lpi(dev, sc);
718 rpcpu->lpi_enabled = true;
721 if ((gic_its_read_8(sc, GITS_TYPER) & GITS_TYPER_PTA) != 0) {
722 /* This ITS wants the redistributor physical address */
723 target = vtophys(rman_get_virtual(&rpcpu->res));
725 /* This ITS wants the unique processor number */
726 target = GICR_TYPER_CPUNUM(gic_r_read_8(gicv3, GICR_TYPER)) <<
730 sc->sc_its_cols[cpuid]->col_target = target;
731 sc->sc_its_cols[cpuid]->col_id = cpuid;
733 its_cmd_mapc(dev, sc->sc_its_cols[cpuid], 1);
734 its_cmd_invall(dev, sc->sc_its_cols[cpuid]);
740 gicv3_its_sysctl_trace_enable(SYSCTL_HANDLER_ARGS)
742 struct gicv3_its_softc *sc;
747 rv = sysctl_handle_bool(oidp, &sc->trace_enable, 0, req);
748 if (rv != 0 || req->newptr == NULL)
750 if (sc->trace_enable)
751 gic_its_write_8(sc, GITS_TRKCTLR, 3);
753 gic_its_write_8(sc, GITS_TRKCTLR, 0);
759 gicv3_its_sysctl_trace_regs(SYSCTL_HANDLER_ARGS)
761 struct gicv3_its_softc *sc;
766 sb = sbuf_new_for_sysctl(NULL, NULL, 128, req);
768 device_printf(sc->dev, "Could not allocate sbuf for output.\n");
772 sbuf_printf(sb, "GITS_TRKCTLR: 0x%08X\n",
773 gic_its_read_4(sc, GITS_TRKCTLR));
774 sbuf_printf(sb, "GITS_TRKR: 0x%08X\n",
775 gic_its_read_4(sc, GITS_TRKR));
776 sbuf_printf(sb, "GITS_TRKDIDR: 0x%08X\n",
777 gic_its_read_4(sc, GITS_TRKDIDR));
778 sbuf_printf(sb, "GITS_TRKPIDR: 0x%08X\n",
779 gic_its_read_4(sc, GITS_TRKPIDR));
780 sbuf_printf(sb, "GITS_TRKVIDR: 0x%08X\n",
781 gic_its_read_4(sc, GITS_TRKVIDR));
782 sbuf_printf(sb, "GITS_TRKTGTR: 0x%08X\n",
783 gic_its_read_4(sc, GITS_TRKTGTR));
785 err = sbuf_finish(sb);
787 device_printf(sc->dev, "Error finishing sbuf: %d\n", err);
793 gicv3_its_init_sysctl(struct gicv3_its_softc *sc)
795 struct sysctl_oid *oid, *child;
796 struct sysctl_ctx_list *ctx_list;
798 ctx_list = device_get_sysctl_ctx(sc->dev);
799 child = device_get_sysctl_tree(sc->dev);
800 oid = SYSCTL_ADD_NODE(ctx_list,
801 SYSCTL_CHILDREN(child), OID_AUTO, "tracing",
802 CTLFLAG_RD| CTLFLAG_MPSAFE, NULL, "Messages tracing");
807 SYSCTL_ADD_PROC(ctx_list,
808 SYSCTL_CHILDREN(oid), OID_AUTO, "enable",
809 CTLTYPE_U8 | CTLFLAG_RW | CTLFLAG_MPSAFE, sc, 0,
810 gicv3_its_sysctl_trace_enable, "CU", "Enable tracing");
811 SYSCTL_ADD_PROC(ctx_list,
812 SYSCTL_CHILDREN(oid), OID_AUTO, "capture",
813 CTLTYPE_STRING | CTLFLAG_RW | CTLFLAG_MPSAFE, sc, 0,
814 gicv3_its_sysctl_trace_regs, "", "Captured tracing registers.");
820 gicv3_its_attach(device_t dev)
822 struct gicv3_its_softc *sc;
823 int domain, err, i, rid;
827 sc = device_get_softc(dev);
829 sc->sc_irq_length = gicv3_get_nirqs(dev);
830 sc->sc_irq_base = GIC_FIRST_LPI;
831 sc->sc_irq_base += device_get_unit(dev) * sc->sc_irq_length;
834 sc->sc_its_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
836 if (sc->sc_its_res == NULL) {
837 device_printf(dev, "Could not allocate memory\n");
841 phys = rounddown2(vtophys(rman_get_virtual(sc->sc_its_res)) +
842 GITS_TRANSLATER, PAGE_SIZE);
843 sc->ma = malloc(sizeof(struct vm_page), M_DEVBUF, M_WAITOK | M_ZERO);
844 vm_page_initfake(sc->ma, phys, VM_MEMATTR_DEFAULT);
846 iidr = gic_its_read_4(sc, GITS_IIDR);
847 for (i = 0; i < nitems(its_quirks); i++) {
848 if ((iidr & its_quirks[i].iidr_mask) == its_quirks[i].iidr) {
850 device_printf(dev, "Applying %s\n",
853 its_quirks[i].func(dev);
858 /* Allocate the private tables */
859 err = gicv3_its_table_init(dev, sc);
863 /* Protects access to the device list */
864 mtx_init(&sc->sc_its_dev_lock, "ITS device lock", NULL, MTX_SPIN);
866 /* Protects access to the ITS command circular buffer. */
867 mtx_init(&sc->sc_its_cmd_lock, "ITS cmd lock", NULL, MTX_SPIN);
869 CPU_ZERO(&sc->sc_cpus);
870 if (bus_get_domain(dev, &domain) == 0) {
871 if (domain < MAXMEMDOM)
872 CPU_COPY(&cpuset_domain[domain], &sc->sc_cpus);
874 CPU_COPY(&all_cpus, &sc->sc_cpus);
877 /* Allocate the command circular buffer */
878 gicv3_its_cmdq_init(sc);
880 /* Allocate the per-CPU collections */
881 for (int cpu = 0; cpu <= mp_maxid; cpu++)
882 if (CPU_ISSET(cpu, &sc->sc_cpus) != 0)
883 sc->sc_its_cols[cpu] = malloc(
884 sizeof(*sc->sc_its_cols[0]), M_GICV3_ITS,
887 sc->sc_its_cols[cpu] = NULL;
890 gic_its_write_4(sc, GITS_CTLR,
891 gic_its_read_4(sc, GITS_CTLR) | GITS_CTLR_EN);
893 /* Create the LPI configuration table */
894 gicv3_its_conftable_init(sc);
896 /* And the pending tebles */
897 gicv3_its_pendtables_init(sc);
899 /* Enable LPIs on this CPU */
900 its_init_cpu(dev, sc);
902 TAILQ_INIT(&sc->sc_its_dev_list);
903 TAILQ_INIT(&sc->sc_free_irqs);
906 * Create the vmem object to allocate INTRNG IRQs from. We try to
907 * use all IRQs not already used by the GICv3.
908 * XXX: This assumes there are no other interrupt controllers in the
911 sc->sc_irq_alloc = vmem_create(device_get_nameunit(dev), 0,
912 gicv3_get_nirqs(dev), 1, 0, M_FIRSTFIT | M_WAITOK);
914 sc->sc_irqs = malloc(sizeof(*sc->sc_irqs) * sc->sc_irq_length,
915 M_GICV3_ITS, M_WAITOK | M_ZERO);
917 /* For GIC-500 install tracking sysctls. */
918 if ((iidr & (GITS_IIDR_PRODUCT_MASK | GITS_IIDR_IMPLEMENTOR_MASK)) ==
919 GITS_IIDR_RAW(GITS_IIDR_IMPL_ARM, GITS_IIDR_PROD_GIC500, 0, 0))
920 gicv3_its_init_sysctl(sc);
926 gicv3_its_detach(device_t dev)
933 its_quirk_cavium_22375(device_t dev)
935 struct gicv3_its_softc *sc;
937 sc = device_get_softc(dev);
938 sc->sc_its_flags |= ITS_FLAGS_ERRATA_CAVIUM_22375;
942 gicv3_its_disable_intr(device_t dev, struct intr_irqsrc *isrc)
944 struct gicv3_its_softc *sc;
945 struct gicv3_its_irqsrc *girq;
948 sc = device_get_softc(dev);
949 girq = (struct gicv3_its_irqsrc *)isrc;
950 conf = sc->sc_conf_base;
952 conf[girq->gi_lpi] &= ~LPI_CONF_ENABLE;
954 if ((sc->sc_its_flags & ITS_FLAGS_LPI_CONF_FLUSH) != 0) {
955 /* Clean D-cache under command. */
956 cpu_dcache_wb_range((vm_offset_t)&conf[girq->gi_lpi], 1);
958 /* DSB inner shareable, store */
962 its_cmd_inv(dev, girq->gi_its_dev, girq);
966 gicv3_its_enable_intr(device_t dev, struct intr_irqsrc *isrc)
968 struct gicv3_its_softc *sc;
969 struct gicv3_its_irqsrc *girq;
972 sc = device_get_softc(dev);
973 girq = (struct gicv3_its_irqsrc *)isrc;
974 conf = sc->sc_conf_base;
976 conf[girq->gi_lpi] |= LPI_CONF_ENABLE;
978 if ((sc->sc_its_flags & ITS_FLAGS_LPI_CONF_FLUSH) != 0) {
979 /* Clean D-cache under command. */
980 cpu_dcache_wb_range((vm_offset_t)&conf[girq->gi_lpi], 1);
982 /* DSB inner shareable, store */
986 its_cmd_inv(dev, girq->gi_its_dev, girq);
990 gicv3_its_intr(void *arg, uintptr_t irq)
992 struct gicv3_its_softc *sc = arg;
993 struct gicv3_its_irqsrc *girq;
994 struct trapframe *tf;
996 irq -= sc->sc_irq_base;
997 girq = sc->sc_irqs[irq];
999 panic("gicv3_its_intr: Invalid interrupt %ld",
1000 irq + sc->sc_irq_base);
1002 tf = curthread->td_intr_frame;
1003 intr_isrc_dispatch(&girq->gi_isrc, tf);
1004 return (FILTER_HANDLED);
1008 gicv3_its_pre_ithread(device_t dev, struct intr_irqsrc *isrc)
1010 struct gicv3_its_irqsrc *girq;
1011 struct gicv3_its_softc *sc;
1013 sc = device_get_softc(dev);
1014 girq = (struct gicv3_its_irqsrc *)isrc;
1015 gicv3_its_disable_intr(dev, isrc);
1016 gic_icc_write(EOIR1, girq->gi_lpi + GIC_FIRST_LPI);
1020 gicv3_its_post_ithread(device_t dev, struct intr_irqsrc *isrc)
1023 gicv3_its_enable_intr(dev, isrc);
1027 gicv3_its_post_filter(device_t dev, struct intr_irqsrc *isrc)
1029 struct gicv3_its_irqsrc *girq;
1030 struct gicv3_its_softc *sc;
1032 sc = device_get_softc(dev);
1033 girq = (struct gicv3_its_irqsrc *)isrc;
1034 gic_icc_write(EOIR1, girq->gi_lpi + GIC_FIRST_LPI);
1038 gicv3_its_select_cpu(device_t dev, struct intr_irqsrc *isrc)
1040 struct gicv3_its_softc *sc;
1042 sc = device_get_softc(dev);
1043 if (CPU_EMPTY(&isrc->isrc_cpu)) {
1044 sc->gic_irq_cpu = intr_irq_next_cpu(sc->gic_irq_cpu,
1046 CPU_SETOF(sc->gic_irq_cpu, &isrc->isrc_cpu);
1053 gicv3_its_bind_intr(device_t dev, struct intr_irqsrc *isrc)
1055 struct gicv3_its_irqsrc *girq;
1057 gicv3_its_select_cpu(dev, isrc);
1059 girq = (struct gicv3_its_irqsrc *)isrc;
1060 its_cmd_movi(dev, girq);
1065 gicv3_its_map_intr(device_t dev, struct intr_map_data *data,
1066 struct intr_irqsrc **isrcp)
1070 * This should never happen, we only call this function to map
1071 * interrupts found before the controller driver is ready.
1073 panic("gicv3_its_map_intr: Unable to map a MSI interrupt");
1077 gicv3_its_setup_intr(device_t dev, struct intr_irqsrc *isrc,
1078 struct resource *res, struct intr_map_data *data)
1081 /* Bind the interrupt to a CPU */
1082 gicv3_its_bind_intr(dev, isrc);
1089 gicv3_its_init_secondary(device_t dev)
1091 struct gicv3_its_softc *sc;
1093 sc = device_get_softc(dev);
1096 * This is fatal as otherwise we may bind interrupts to this CPU.
1097 * We need a way to tell the interrupt framework to only bind to a
1098 * subset of given CPUs when it performs the shuffle.
1100 if (its_init_cpu(dev, sc) != 0)
1101 panic("gicv3_its_init_secondary: No usable ITS on CPU%d",
1107 its_get_devid(device_t pci_dev)
1111 if (pci_get_id(pci_dev, PCI_ID_MSI, &id) != 0)
1112 panic("%s: %s: Unable to get the MSI DeviceID", __func__,
1113 device_get_nameunit(pci_dev));
1118 static struct its_dev *
1119 its_device_find(device_t dev, device_t child)
1121 struct gicv3_its_softc *sc;
1122 struct its_dev *its_dev = NULL;
1124 sc = device_get_softc(dev);
1126 mtx_lock_spin(&sc->sc_its_dev_lock);
1127 TAILQ_FOREACH(its_dev, &sc->sc_its_dev_list, entry) {
1128 if (its_dev->pci_dev == child)
1131 mtx_unlock_spin(&sc->sc_its_dev_lock);
1136 static struct its_dev *
1137 its_device_get(device_t dev, device_t child, u_int nvecs)
1139 struct gicv3_its_softc *sc;
1140 struct its_dev *its_dev;
1141 vmem_addr_t irq_base;
1144 sc = device_get_softc(dev);
1146 its_dev = its_device_find(dev, child);
1147 if (its_dev != NULL)
1150 its_dev = malloc(sizeof(*its_dev), M_GICV3_ITS, M_NOWAIT | M_ZERO);
1151 if (its_dev == NULL)
1154 its_dev->pci_dev = child;
1155 its_dev->devid = its_get_devid(child);
1157 its_dev->lpis.lpi_busy = 0;
1158 its_dev->lpis.lpi_num = nvecs;
1159 its_dev->lpis.lpi_free = nvecs;
1161 if (vmem_alloc(sc->sc_irq_alloc, nvecs, M_FIRSTFIT | M_NOWAIT,
1163 free(its_dev, M_GICV3_ITS);
1166 its_dev->lpis.lpi_base = irq_base;
1168 /* Get ITT entry size */
1169 esize = GITS_TYPER_ITTES(gic_its_read_8(sc, GITS_TYPER));
1172 * Allocate ITT for this device.
1173 * PA has to be 256 B aligned. At least two entries for device.
1175 its_dev->itt_size = roundup2(MAX(nvecs, 2) * esize, 256);
1176 its_dev->itt = (vm_offset_t)contigmalloc(its_dev->itt_size,
1177 M_GICV3_ITS, M_NOWAIT | M_ZERO, 0, LPI_INT_TRANS_TAB_MAX_ADDR,
1178 LPI_INT_TRANS_TAB_ALIGN, 0);
1179 if (its_dev->itt == 0) {
1180 vmem_free(sc->sc_irq_alloc, its_dev->lpis.lpi_base, nvecs);
1181 free(its_dev, M_GICV3_ITS);
1185 mtx_lock_spin(&sc->sc_its_dev_lock);
1186 TAILQ_INSERT_TAIL(&sc->sc_its_dev_list, its_dev, entry);
1187 mtx_unlock_spin(&sc->sc_its_dev_lock);
1189 /* Map device to its ITT */
1190 its_cmd_mapd(dev, its_dev, 1);
1196 its_device_release(device_t dev, struct its_dev *its_dev)
1198 struct gicv3_its_softc *sc;
1200 KASSERT(its_dev->lpis.lpi_busy == 0,
1201 ("its_device_release: Trying to release an inuse ITS device"));
1203 /* Unmap device in ITS */
1204 its_cmd_mapd(dev, its_dev, 0);
1206 sc = device_get_softc(dev);
1208 /* Remove the device from the list of devices */
1209 mtx_lock_spin(&sc->sc_its_dev_lock);
1210 TAILQ_REMOVE(&sc->sc_its_dev_list, its_dev, entry);
1211 mtx_unlock_spin(&sc->sc_its_dev_lock);
1214 KASSERT(its_dev->itt != 0, ("Invalid ITT in valid ITS device"));
1215 contigfree((void *)its_dev->itt, its_dev->itt_size, M_GICV3_ITS);
1217 /* Free the IRQ allocation */
1218 vmem_free(sc->sc_irq_alloc, its_dev->lpis.lpi_base,
1219 its_dev->lpis.lpi_num);
1221 free(its_dev, M_GICV3_ITS);
1224 static struct gicv3_its_irqsrc *
1225 gicv3_its_alloc_irqsrc(device_t dev, struct gicv3_its_softc *sc, u_int irq)
1227 struct gicv3_its_irqsrc *girq = NULL;
1229 KASSERT(sc->sc_irqs[irq] == NULL,
1230 ("%s: Interrupt %u already allocated", __func__, irq));
1231 mtx_lock_spin(&sc->sc_its_dev_lock);
1232 if (!TAILQ_EMPTY(&sc->sc_free_irqs)) {
1233 girq = TAILQ_FIRST(&sc->sc_free_irqs);
1234 TAILQ_REMOVE(&sc->sc_free_irqs, girq, gi_link);
1236 mtx_unlock_spin(&sc->sc_its_dev_lock);
1238 girq = malloc(sizeof(*girq), M_GICV3_ITS,
1243 if (intr_isrc_register(&girq->gi_isrc, dev, 0,
1244 "%s,%u", device_get_nameunit(dev), irq) != 0) {
1245 free(girq, M_GICV3_ITS);
1249 girq->gi_lpi = irq + sc->sc_irq_base - GIC_FIRST_LPI;
1250 sc->sc_irqs[irq] = girq;
1256 gicv3_its_release_irqsrc(struct gicv3_its_softc *sc,
1257 struct gicv3_its_irqsrc *girq)
1261 mtx_assert(&sc->sc_its_dev_lock, MA_OWNED);
1263 irq = girq->gi_lpi + GIC_FIRST_LPI - sc->sc_irq_base;
1264 sc->sc_irqs[irq] = NULL;
1267 girq->gi_its_dev = NULL;
1268 TAILQ_INSERT_TAIL(&sc->sc_free_irqs, girq, gi_link);
1272 gicv3_its_alloc_msi(device_t dev, device_t child, int count, int maxcount,
1273 device_t *pic, struct intr_irqsrc **srcs)
1275 struct gicv3_its_softc *sc;
1276 struct gicv3_its_irqsrc *girq;
1277 struct its_dev *its_dev;
1281 its_dev = its_device_get(dev, child, count);
1282 if (its_dev == NULL)
1285 KASSERT(its_dev->lpis.lpi_free >= count,
1286 ("gicv3_its_alloc_msi: No free LPIs"));
1287 sc = device_get_softc(dev);
1288 irq = its_dev->lpis.lpi_base + its_dev->lpis.lpi_num -
1289 its_dev->lpis.lpi_free;
1291 /* Allocate the irqsrc for each MSI */
1292 for (i = 0; i < count; i++, irq++) {
1293 its_dev->lpis.lpi_free--;
1294 srcs[i] = (struct intr_irqsrc *)gicv3_its_alloc_irqsrc(dev,
1296 if (srcs[i] == NULL)
1300 /* The allocation failed, release them */
1302 mtx_lock_spin(&sc->sc_its_dev_lock);
1303 for (i = 0; i < count; i++) {
1304 girq = (struct gicv3_its_irqsrc *)srcs[i];
1307 gicv3_its_release_irqsrc(sc, girq);
1310 mtx_unlock_spin(&sc->sc_its_dev_lock);
1314 /* Finish the allocation now we have all MSI irqsrcs */
1315 for (i = 0; i < count; i++) {
1316 girq = (struct gicv3_its_irqsrc *)srcs[i];
1318 girq->gi_its_dev = its_dev;
1320 /* Map the message to the given IRQ */
1321 gicv3_its_select_cpu(dev, (struct intr_irqsrc *)girq);
1322 its_cmd_mapti(dev, girq);
1324 its_dev->lpis.lpi_busy += count;
1331 gicv3_its_release_msi(device_t dev, device_t child, int count,
1332 struct intr_irqsrc **isrc)
1334 struct gicv3_its_softc *sc;
1335 struct gicv3_its_irqsrc *girq;
1336 struct its_dev *its_dev;
1339 its_dev = its_device_find(dev, child);
1341 KASSERT(its_dev != NULL,
1342 ("gicv3_its_release_msi: Releasing a MSI interrupt with "
1344 KASSERT(its_dev->lpis.lpi_busy >= count,
1345 ("gicv3_its_release_msi: Releasing more interrupts than "
1346 "were allocated: releasing %d, allocated %d", count,
1347 its_dev->lpis.lpi_busy));
1349 sc = device_get_softc(dev);
1350 mtx_lock_spin(&sc->sc_its_dev_lock);
1351 for (i = 0; i < count; i++) {
1352 girq = (struct gicv3_its_irqsrc *)isrc[i];
1353 gicv3_its_release_irqsrc(sc, girq);
1355 mtx_unlock_spin(&sc->sc_its_dev_lock);
1356 its_dev->lpis.lpi_busy -= count;
1358 if (its_dev->lpis.lpi_busy == 0)
1359 its_device_release(dev, its_dev);
1365 gicv3_its_alloc_msix(device_t dev, device_t child, device_t *pic,
1366 struct intr_irqsrc **isrcp)
1368 struct gicv3_its_softc *sc;
1369 struct gicv3_its_irqsrc *girq;
1370 struct its_dev *its_dev;
1373 nvecs = pci_msix_count(child);
1374 its_dev = its_device_get(dev, child, nvecs);
1375 if (its_dev == NULL)
1378 KASSERT(its_dev->lpis.lpi_free > 0,
1379 ("gicv3_its_alloc_msix: No free LPIs"));
1380 sc = device_get_softc(dev);
1381 irq = its_dev->lpis.lpi_base + its_dev->lpis.lpi_num -
1382 its_dev->lpis.lpi_free;
1384 girq = gicv3_its_alloc_irqsrc(dev, sc, irq);
1387 girq->gi_id = its_dev->lpis.lpi_busy;
1388 girq->gi_its_dev = its_dev;
1390 its_dev->lpis.lpi_free--;
1391 its_dev->lpis.lpi_busy++;
1393 /* Map the message to the given IRQ */
1394 gicv3_its_select_cpu(dev, (struct intr_irqsrc *)girq);
1395 its_cmd_mapti(dev, girq);
1398 *isrcp = (struct intr_irqsrc *)girq;
1404 gicv3_its_release_msix(device_t dev, device_t child, struct intr_irqsrc *isrc)
1406 struct gicv3_its_softc *sc;
1407 struct gicv3_its_irqsrc *girq;
1408 struct its_dev *its_dev;
1410 its_dev = its_device_find(dev, child);
1412 KASSERT(its_dev != NULL,
1413 ("gicv3_its_release_msix: Releasing a MSI-X interrupt with "
1415 KASSERT(its_dev->lpis.lpi_busy > 0,
1416 ("gicv3_its_release_msix: Releasing more interrupts than "
1417 "were allocated: allocated %d", its_dev->lpis.lpi_busy));
1419 sc = device_get_softc(dev);
1420 girq = (struct gicv3_its_irqsrc *)isrc;
1421 mtx_lock_spin(&sc->sc_its_dev_lock);
1422 gicv3_its_release_irqsrc(sc, girq);
1423 mtx_unlock_spin(&sc->sc_its_dev_lock);
1424 its_dev->lpis.lpi_busy--;
1426 if (its_dev->lpis.lpi_busy == 0)
1427 its_device_release(dev, its_dev);
1433 gicv3_its_map_msi(device_t dev, device_t child, struct intr_irqsrc *isrc,
1434 uint64_t *addr, uint32_t *data)
1436 struct gicv3_its_softc *sc;
1437 struct gicv3_its_irqsrc *girq;
1439 sc = device_get_softc(dev);
1440 girq = (struct gicv3_its_irqsrc *)isrc;
1442 *addr = vtophys(rman_get_virtual(sc->sc_its_res)) + GITS_TRANSLATER;
1443 *data = girq->gi_id;
1450 gicv3_iommu_init(device_t dev, device_t child, struct iommu_domain **domain)
1452 struct gicv3_its_softc *sc;
1453 struct iommu_ctx *ctx;
1456 sc = device_get_softc(dev);
1457 ctx = iommu_get_dev_ctx(child);
1460 /* Map the page containing the GITS_TRANSLATER register. */
1461 error = iommu_map_msi(ctx, PAGE_SIZE, 0,
1462 IOMMU_MAP_ENTRY_WRITE, IOMMU_MF_CANWAIT, &sc->ma);
1463 *domain = iommu_get_ctx_domain(ctx);
1469 gicv3_iommu_deinit(device_t dev, device_t child)
1471 struct iommu_ctx *ctx;
1473 ctx = iommu_get_dev_ctx(child);
1477 iommu_unmap_msi(ctx);
1482 * Commands handling.
1485 static __inline void
1486 cmd_format_command(struct its_cmd *cmd, uint8_t cmd_type)
1488 /* Command field: DW0 [7:0] */
1489 cmd->cmd_dword[0] &= htole64(~CMD_COMMAND_MASK);
1490 cmd->cmd_dword[0] |= htole64(cmd_type);
1493 static __inline void
1494 cmd_format_devid(struct its_cmd *cmd, uint32_t devid)
1496 /* Device ID field: DW0 [63:32] */
1497 cmd->cmd_dword[0] &= htole64(~CMD_DEVID_MASK);
1498 cmd->cmd_dword[0] |= htole64((uint64_t)devid << CMD_DEVID_SHIFT);
1501 static __inline void
1502 cmd_format_size(struct its_cmd *cmd, uint16_t size)
1504 /* Size field: DW1 [4:0] */
1505 cmd->cmd_dword[1] &= htole64(~CMD_SIZE_MASK);
1506 cmd->cmd_dword[1] |= htole64((size & CMD_SIZE_MASK));
1509 static __inline void
1510 cmd_format_id(struct its_cmd *cmd, uint32_t id)
1512 /* ID field: DW1 [31:0] */
1513 cmd->cmd_dword[1] &= htole64(~CMD_ID_MASK);
1514 cmd->cmd_dword[1] |= htole64(id);
1517 static __inline void
1518 cmd_format_pid(struct its_cmd *cmd, uint32_t pid)
1520 /* Physical ID field: DW1 [63:32] */
1521 cmd->cmd_dword[1] &= htole64(~CMD_PID_MASK);
1522 cmd->cmd_dword[1] |= htole64((uint64_t)pid << CMD_PID_SHIFT);
1525 static __inline void
1526 cmd_format_col(struct its_cmd *cmd, uint16_t col_id)
1528 /* Collection field: DW2 [16:0] */
1529 cmd->cmd_dword[2] &= htole64(~CMD_COL_MASK);
1530 cmd->cmd_dword[2] |= htole64(col_id);
1533 static __inline void
1534 cmd_format_target(struct its_cmd *cmd, uint64_t target)
1536 /* Target Address field: DW2 [47:16] */
1537 cmd->cmd_dword[2] &= htole64(~CMD_TARGET_MASK);
1538 cmd->cmd_dword[2] |= htole64(target & CMD_TARGET_MASK);
1541 static __inline void
1542 cmd_format_itt(struct its_cmd *cmd, uint64_t itt)
1544 /* ITT Address field: DW2 [47:8] */
1545 cmd->cmd_dword[2] &= htole64(~CMD_ITT_MASK);
1546 cmd->cmd_dword[2] |= htole64(itt & CMD_ITT_MASK);
1549 static __inline void
1550 cmd_format_valid(struct its_cmd *cmd, uint8_t valid)
1552 /* Valid field: DW2 [63] */
1553 cmd->cmd_dword[2] &= htole64(~CMD_VALID_MASK);
1554 cmd->cmd_dword[2] |= htole64((uint64_t)valid << CMD_VALID_SHIFT);
1558 its_cmd_queue_full(struct gicv3_its_softc *sc)
1560 size_t read_idx, next_write_idx;
1562 /* Get the index of the next command */
1563 next_write_idx = (sc->sc_its_cmd_next_idx + 1) %
1564 (ITS_CMDQ_SIZE / sizeof(struct its_cmd));
1565 /* And the index of the current command being read */
1566 read_idx = gic_its_read_4(sc, GITS_CREADR) / sizeof(struct its_cmd);
1569 * The queue is full when the write offset points
1570 * at the command before the current read offset.
1572 return (next_write_idx == read_idx);
1576 its_cmd_sync(struct gicv3_its_softc *sc, struct its_cmd *cmd)
1579 if ((sc->sc_its_flags & ITS_FLAGS_CMDQ_FLUSH) != 0) {
1580 /* Clean D-cache under command. */
1581 cpu_dcache_wb_range((vm_offset_t)cmd, sizeof(*cmd));
1583 /* DSB inner shareable, store */
1589 static inline uint64_t
1590 its_cmd_cwriter_offset(struct gicv3_its_softc *sc, struct its_cmd *cmd)
1594 off = (cmd - sc->sc_its_cmd_base) * sizeof(*cmd);
1600 its_cmd_wait_completion(device_t dev, struct its_cmd *cmd_first,
1601 struct its_cmd *cmd_last)
1603 struct gicv3_its_softc *sc;
1604 uint64_t first, last, read;
1607 sc = device_get_softc(dev);
1610 * XXX ARM64TODO: This is obviously a significant delay.
1611 * The reason for that is that currently the time frames for
1612 * the command to complete are not known.
1616 first = its_cmd_cwriter_offset(sc, cmd_first);
1617 last = its_cmd_cwriter_offset(sc, cmd_last);
1620 read = gic_its_read_8(sc, GITS_CREADR);
1622 if (read < first || read >= last)
1624 } else if (read < first && read >= last)
1627 if (us_left-- == 0) {
1628 /* This means timeout */
1630 "Timeout while waiting for CMD completion.\n");
1637 static struct its_cmd *
1638 its_cmd_alloc_locked(device_t dev)
1640 struct gicv3_its_softc *sc;
1641 struct its_cmd *cmd;
1644 sc = device_get_softc(dev);
1647 * XXX ARM64TODO: This is obviously a significant delay.
1648 * The reason for that is that currently the time frames for
1649 * the command to complete (and therefore free the descriptor)
1654 mtx_assert(&sc->sc_its_cmd_lock, MA_OWNED);
1655 while (its_cmd_queue_full(sc)) {
1656 if (us_left-- == 0) {
1657 /* Timeout while waiting for free command */
1659 "Timeout while waiting for free command\n");
1665 cmd = &sc->sc_its_cmd_base[sc->sc_its_cmd_next_idx];
1666 sc->sc_its_cmd_next_idx++;
1667 sc->sc_its_cmd_next_idx %= ITS_CMDQ_SIZE / sizeof(struct its_cmd);
1673 its_cmd_prepare(struct its_cmd *cmd, struct its_cmd_desc *desc)
1679 cmd_type = desc->cmd_type;
1680 target = ITS_TARGET_NONE;
1683 case ITS_CMD_MOVI: /* Move interrupt ID to another collection */
1684 target = desc->cmd_desc_movi.col->col_target;
1685 cmd_format_command(cmd, ITS_CMD_MOVI);
1686 cmd_format_id(cmd, desc->cmd_desc_movi.id);
1687 cmd_format_col(cmd, desc->cmd_desc_movi.col->col_id);
1688 cmd_format_devid(cmd, desc->cmd_desc_movi.its_dev->devid);
1690 case ITS_CMD_SYNC: /* Wait for previous commands completion */
1691 target = desc->cmd_desc_sync.col->col_target;
1692 cmd_format_command(cmd, ITS_CMD_SYNC);
1693 cmd_format_target(cmd, target);
1695 case ITS_CMD_MAPD: /* Assign ITT to device */
1696 cmd_format_command(cmd, ITS_CMD_MAPD);
1697 cmd_format_itt(cmd, vtophys(desc->cmd_desc_mapd.its_dev->itt));
1699 * Size describes number of bits to encode interrupt IDs
1700 * supported by the device minus one.
1701 * When V (valid) bit is zero, this field should be written
1704 if (desc->cmd_desc_mapd.valid != 0) {
1705 size = fls(desc->cmd_desc_mapd.its_dev->lpis.lpi_num);
1706 size = MAX(1, size) - 1;
1710 cmd_format_size(cmd, size);
1711 cmd_format_devid(cmd, desc->cmd_desc_mapd.its_dev->devid);
1712 cmd_format_valid(cmd, desc->cmd_desc_mapd.valid);
1714 case ITS_CMD_MAPC: /* Map collection to Re-Distributor */
1715 target = desc->cmd_desc_mapc.col->col_target;
1716 cmd_format_command(cmd, ITS_CMD_MAPC);
1717 cmd_format_col(cmd, desc->cmd_desc_mapc.col->col_id);
1718 cmd_format_valid(cmd, desc->cmd_desc_mapc.valid);
1719 cmd_format_target(cmd, target);
1722 target = desc->cmd_desc_mapvi.col->col_target;
1723 cmd_format_command(cmd, ITS_CMD_MAPTI);
1724 cmd_format_devid(cmd, desc->cmd_desc_mapvi.its_dev->devid);
1725 cmd_format_id(cmd, desc->cmd_desc_mapvi.id);
1726 cmd_format_pid(cmd, desc->cmd_desc_mapvi.pid);
1727 cmd_format_col(cmd, desc->cmd_desc_mapvi.col->col_id);
1730 target = desc->cmd_desc_mapi.col->col_target;
1731 cmd_format_command(cmd, ITS_CMD_MAPI);
1732 cmd_format_devid(cmd, desc->cmd_desc_mapi.its_dev->devid);
1733 cmd_format_id(cmd, desc->cmd_desc_mapi.pid);
1734 cmd_format_col(cmd, desc->cmd_desc_mapi.col->col_id);
1737 target = desc->cmd_desc_inv.col->col_target;
1738 cmd_format_command(cmd, ITS_CMD_INV);
1739 cmd_format_devid(cmd, desc->cmd_desc_inv.its_dev->devid);
1740 cmd_format_id(cmd, desc->cmd_desc_inv.pid);
1742 case ITS_CMD_INVALL:
1743 cmd_format_command(cmd, ITS_CMD_INVALL);
1744 cmd_format_col(cmd, desc->cmd_desc_invall.col->col_id);
1747 panic("its_cmd_prepare: Invalid command: %x", cmd_type);
1754 its_cmd_send(device_t dev, struct its_cmd_desc *desc)
1756 struct gicv3_its_softc *sc;
1757 struct its_cmd *cmd, *cmd_sync, *cmd_write;
1758 struct its_col col_sync;
1759 struct its_cmd_desc desc_sync;
1760 uint64_t target, cwriter;
1762 sc = device_get_softc(dev);
1763 mtx_lock_spin(&sc->sc_its_cmd_lock);
1764 cmd = its_cmd_alloc_locked(dev);
1766 device_printf(dev, "could not allocate ITS command\n");
1767 mtx_unlock_spin(&sc->sc_its_cmd_lock);
1771 target = its_cmd_prepare(cmd, desc);
1772 its_cmd_sync(sc, cmd);
1774 if (target != ITS_TARGET_NONE) {
1775 cmd_sync = its_cmd_alloc_locked(dev);
1776 if (cmd_sync != NULL) {
1777 desc_sync.cmd_type = ITS_CMD_SYNC;
1778 col_sync.col_target = target;
1779 desc_sync.cmd_desc_sync.col = &col_sync;
1780 its_cmd_prepare(cmd_sync, &desc_sync);
1781 its_cmd_sync(sc, cmd_sync);
1785 /* Update GITS_CWRITER */
1786 cwriter = sc->sc_its_cmd_next_idx * sizeof(struct its_cmd);
1787 gic_its_write_8(sc, GITS_CWRITER, cwriter);
1788 cmd_write = &sc->sc_its_cmd_base[sc->sc_its_cmd_next_idx];
1789 mtx_unlock_spin(&sc->sc_its_cmd_lock);
1791 its_cmd_wait_completion(dev, cmd, cmd_write);
1796 /* Handlers to send commands */
1798 its_cmd_movi(device_t dev, struct gicv3_its_irqsrc *girq)
1800 struct gicv3_its_softc *sc;
1801 struct its_cmd_desc desc;
1802 struct its_col *col;
1804 sc = device_get_softc(dev);
1805 col = sc->sc_its_cols[CPU_FFS(&girq->gi_isrc.isrc_cpu) - 1];
1807 desc.cmd_type = ITS_CMD_MOVI;
1808 desc.cmd_desc_movi.its_dev = girq->gi_its_dev;
1809 desc.cmd_desc_movi.col = col;
1810 desc.cmd_desc_movi.id = girq->gi_id;
1812 its_cmd_send(dev, &desc);
1816 its_cmd_mapc(device_t dev, struct its_col *col, uint8_t valid)
1818 struct its_cmd_desc desc;
1820 desc.cmd_type = ITS_CMD_MAPC;
1821 desc.cmd_desc_mapc.col = col;
1823 * Valid bit set - map the collection.
1824 * Valid bit cleared - unmap the collection.
1826 desc.cmd_desc_mapc.valid = valid;
1828 its_cmd_send(dev, &desc);
1832 its_cmd_mapti(device_t dev, struct gicv3_its_irqsrc *girq)
1834 struct gicv3_its_softc *sc;
1835 struct its_cmd_desc desc;
1836 struct its_col *col;
1839 sc = device_get_softc(dev);
1841 col_id = CPU_FFS(&girq->gi_isrc.isrc_cpu) - 1;
1842 col = sc->sc_its_cols[col_id];
1844 desc.cmd_type = ITS_CMD_MAPTI;
1845 desc.cmd_desc_mapvi.its_dev = girq->gi_its_dev;
1846 desc.cmd_desc_mapvi.col = col;
1847 /* The EventID sent to the device */
1848 desc.cmd_desc_mapvi.id = girq->gi_id;
1849 /* The physical interrupt presented to softeware */
1850 desc.cmd_desc_mapvi.pid = girq->gi_lpi + GIC_FIRST_LPI;
1852 its_cmd_send(dev, &desc);
1856 its_cmd_mapd(device_t dev, struct its_dev *its_dev, uint8_t valid)
1858 struct its_cmd_desc desc;
1860 desc.cmd_type = ITS_CMD_MAPD;
1861 desc.cmd_desc_mapd.its_dev = its_dev;
1862 desc.cmd_desc_mapd.valid = valid;
1864 its_cmd_send(dev, &desc);
1868 its_cmd_inv(device_t dev, struct its_dev *its_dev,
1869 struct gicv3_its_irqsrc *girq)
1871 struct gicv3_its_softc *sc;
1872 struct its_cmd_desc desc;
1873 struct its_col *col;
1875 sc = device_get_softc(dev);
1876 col = sc->sc_its_cols[CPU_FFS(&girq->gi_isrc.isrc_cpu) - 1];
1878 desc.cmd_type = ITS_CMD_INV;
1879 /* The EventID sent to the device */
1880 desc.cmd_desc_inv.pid = girq->gi_id;
1881 desc.cmd_desc_inv.its_dev = its_dev;
1882 desc.cmd_desc_inv.col = col;
1884 its_cmd_send(dev, &desc);
1888 its_cmd_invall(device_t dev, struct its_col *col)
1890 struct its_cmd_desc desc;
1892 desc.cmd_type = ITS_CMD_INVALL;
1893 desc.cmd_desc_invall.col = col;
1895 its_cmd_send(dev, &desc);
1899 static device_probe_t gicv3_its_fdt_probe;
1900 static device_attach_t gicv3_its_fdt_attach;
1902 static device_method_t gicv3_its_fdt_methods[] = {
1903 /* Device interface */
1904 DEVMETHOD(device_probe, gicv3_its_fdt_probe),
1905 DEVMETHOD(device_attach, gicv3_its_fdt_attach),
1911 #define its_baseclasses its_fdt_baseclasses
1912 DEFINE_CLASS_1(its, gicv3_its_fdt_driver, gicv3_its_fdt_methods,
1913 sizeof(struct gicv3_its_softc), gicv3_its_driver);
1914 #undef its_baseclasses
1915 static devclass_t gicv3_its_fdt_devclass;
1917 EARLY_DRIVER_MODULE(its_fdt, gic, gicv3_its_fdt_driver,
1918 gicv3_its_fdt_devclass, 0, 0, BUS_PASS_INTERRUPT + BUS_PASS_ORDER_MIDDLE);
1921 gicv3_its_fdt_probe(device_t dev)
1924 if (!ofw_bus_status_okay(dev))
1927 if (!ofw_bus_is_compatible(dev, "arm,gic-v3-its"))
1930 device_set_desc(dev, "ARM GIC Interrupt Translation Service");
1931 return (BUS_PROBE_DEFAULT);
1935 gicv3_its_fdt_attach(device_t dev)
1937 struct gicv3_its_softc *sc;
1941 sc = device_get_softc(dev);
1943 err = gicv3_its_attach(dev);
1947 /* Register this device as a interrupt controller */
1948 xref = OF_xref_from_node(ofw_bus_get_node(dev));
1949 sc->sc_pic = intr_pic_register(dev, xref);
1950 err = intr_pic_add_handler(device_get_parent(dev), sc->sc_pic,
1951 gicv3_its_intr, sc, sc->sc_irq_base, sc->sc_irq_length);
1953 device_printf(dev, "Failed to add PIC handler: %d\n", err);
1957 /* Register this device to handle MSI interrupts */
1958 err = intr_msi_register(dev, xref);
1960 device_printf(dev, "Failed to register for MSIs: %d\n", err);
1969 static device_probe_t gicv3_its_acpi_probe;
1970 static device_attach_t gicv3_its_acpi_attach;
1972 static device_method_t gicv3_its_acpi_methods[] = {
1973 /* Device interface */
1974 DEVMETHOD(device_probe, gicv3_its_acpi_probe),
1975 DEVMETHOD(device_attach, gicv3_its_acpi_attach),
1981 #define its_baseclasses its_acpi_baseclasses
1982 DEFINE_CLASS_1(its, gicv3_its_acpi_driver, gicv3_its_acpi_methods,
1983 sizeof(struct gicv3_its_softc), gicv3_its_driver);
1984 #undef its_baseclasses
1985 static devclass_t gicv3_its_acpi_devclass;
1987 EARLY_DRIVER_MODULE(its_acpi, gic, gicv3_its_acpi_driver,
1988 gicv3_its_acpi_devclass, 0, 0, BUS_PASS_INTERRUPT + BUS_PASS_ORDER_MIDDLE);
1991 gicv3_its_acpi_probe(device_t dev)
1994 if (gic_get_bus(dev) != GIC_BUS_ACPI)
1997 if (gic_get_hw_rev(dev) < 3)
2000 device_set_desc(dev, "ARM GIC Interrupt Translation Service");
2001 return (BUS_PROBE_DEFAULT);
2005 gicv3_its_acpi_attach(device_t dev)
2007 struct gicv3_its_softc *sc;
2008 struct gic_v3_devinfo *di;
2011 sc = device_get_softc(dev);
2013 err = gicv3_its_attach(dev);
2017 di = device_get_ivars(dev);
2018 sc->sc_pic = intr_pic_register(dev, di->msi_xref);
2019 err = intr_pic_add_handler(device_get_parent(dev), sc->sc_pic,
2020 gicv3_its_intr, sc, sc->sc_irq_base, sc->sc_irq_length);
2022 device_printf(dev, "Failed to add PIC handler: %d\n", err);
2026 /* Register this device to handle MSI interrupts */
2027 err = intr_msi_register(dev, di->msi_xref);
2029 device_printf(dev, "Failed to register for MSIs: %d\n", err);