| 1 | /** @file
|
|---|
| 2 | * ARMv8 Generic Interrupt Controller (GIC) Interrupt Translation Service (ITS) definitions.
|
|---|
| 3 | */
|
|---|
| 4 |
|
|---|
| 5 | /*
|
|---|
| 6 | * Copyright (C) 2025 Oracle and/or its affiliates.
|
|---|
| 7 | *
|
|---|
| 8 | * This file is part of VirtualBox base platform packages, as
|
|---|
| 9 | * available from https://www.virtualbox.org.
|
|---|
| 10 | *
|
|---|
| 11 | * This program is free software; you can redistribute it and/or
|
|---|
| 12 | * modify it under the terms of the GNU General Public License
|
|---|
| 13 | * as published by the Free Software Foundation, in version 3 of the
|
|---|
| 14 | * License.
|
|---|
| 15 | *
|
|---|
| 16 | * This program is distributed in the hope that it will be useful, but
|
|---|
| 17 | * WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 18 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|---|
| 19 | * General Public License for more details.
|
|---|
| 20 | *
|
|---|
| 21 | * You should have received a copy of the GNU General Public License
|
|---|
| 22 | * along with this program; if not, see <https://www.gnu.org/licenses>.
|
|---|
| 23 | *
|
|---|
| 24 | * The contents of this file may alternatively be used under the terms
|
|---|
| 25 | * of the Common Development and Distribution License Version 1.0
|
|---|
| 26 | * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
|
|---|
| 27 | * in the VirtualBox distribution, in which case the provisions of the
|
|---|
| 28 | * CDDL are applicable instead of those of the GPL.
|
|---|
| 29 | *
|
|---|
| 30 | * You may elect to license modified versions of this file under the
|
|---|
| 31 | * terms and conditions of either the GPL or the CDDL or both.
|
|---|
| 32 | *
|
|---|
| 33 | * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
|
|---|
| 34 | */
|
|---|
| 35 |
|
|---|
| 36 | #ifndef VBOX_INCLUDED_gic_its_h
|
|---|
| 37 | #define VBOX_INCLUDED_gic_its_h
|
|---|
| 38 | #ifndef RT_WITHOUT_PRAGMA_ONCE
|
|---|
| 39 | # pragma once
|
|---|
| 40 | #endif
|
|---|
| 41 |
|
|---|
| 42 | #include <iprt/types.h>
|
|---|
| 43 | #include <iprt/armv8.h>
|
|---|
| 44 |
|
|---|
| 45 | /** Size of the ITS register frame. */
|
|---|
| 46 | #define GITS_REG_FRAME_SIZE _64K
|
|---|
| 47 |
|
|---|
| 48 | /** GITS_CTLR: Control register - RW. */
|
|---|
| 49 | #define GITS_CTRL_REG_CTLR_OFF 0x0000
|
|---|
| 50 | /** GITS_CTLR: Enabled. */
|
|---|
| 51 | #define GITS_BF_CTRL_REG_CTLR_ENABLED_SHIFT 0
|
|---|
| 52 | #define GITS_BF_CTRL_REG_CTLR_ENABLED_MASK UINT32_C(0x00000001)
|
|---|
| 53 | /** GITS_CTLR: ImDe - Implementation Defined. */
|
|---|
| 54 | #define GITS_BF_CTRL_REG_CTLR_IM_DE_SHIFT 1
|
|---|
| 55 | #define GITS_BF_CTRL_REG_CTLR_IM_DE_MASK UINT32_C(0x00000002)
|
|---|
| 56 | /** GITS_CTLR: Reserved (bits 3:2). */
|
|---|
| 57 | #define GITS_BF_CTRL_REG_CTLR_RSVD_3_2_SHIFT 2
|
|---|
| 58 | #define GITS_BF_CTRL_REG_CTLR_RSVD_3_2_MASK UINT32_C(0x0000000c)
|
|---|
| 59 | /** GITS_CTLR: ITS_Number (0 for GICv3). */
|
|---|
| 60 | #define GITS_BF_CTRL_REG_CTLR_ITS_NUMBER_SHIFT 4
|
|---|
| 61 | #define GITS_BF_CTRL_REG_CTLR_ITS_NUMBER_MASK UINT32_C(0x000000f0)
|
|---|
| 62 | /** GITS_CTLR: UMSIirq - Unmapped MSI reporting interrupt enable. */
|
|---|
| 63 | #define GITS_BF_CTRL_REG_CTLR_UMSI_IRQ_SHIFT 8
|
|---|
| 64 | #define GITS_BF_CTRL_REG_CTLR_UMSI_IRQ_MASK UINT32_C(0x00000100)
|
|---|
| 65 | /** GITS_CTLR: Reserved (bits 30:9). */
|
|---|
| 66 | #define GITS_BF_CTRL_REG_CTLR_RSVD_30_9_SHIFT 9
|
|---|
| 67 | #define GITS_BF_CTRL_REG_CTLR_RSVD_30_9_MASK UINT32_C(0x7ffffe00)
|
|---|
| 68 | /** GITS_CTLR: Quiescent. */
|
|---|
| 69 | #define GITS_BF_CTRL_REG_CTLR_QUIESCENT_SHIFT 31
|
|---|
| 70 | #define GITS_BF_CTRL_REG_CTLR_QUIESCENT_MASK UINT32_C(0x80000000)
|
|---|
| 71 | RT_BF_ASSERT_COMPILE_CHECKS(GITS_BF_CTRL_REG_CTLR_, UINT32_C(0), UINT32_MAX,
|
|---|
| 72 | (ENABLED, IM_DE, RSVD_3_2, ITS_NUMBER, UMSI_IRQ, RSVD_30_9, QUIESCENT));
|
|---|
| 73 |
|
|---|
| 74 | /** GITS_IIDR: Implementer and revision register - RO. */
|
|---|
| 75 | #define GITS_CTRL_REG_IIDR_OFF 0x0004
|
|---|
| 76 | /** GITS_IIDR: Implementer. */
|
|---|
| 77 | #define GITS_BF_CTRL_REG_IIDR_IMPLEMENTER_SHIFT 0
|
|---|
| 78 | #define GITS_BF_CTRL_REG_IIDR_IMPLEMENTER_MASK UINT32_C(0x00000fff)
|
|---|
| 79 | /** GITS_IIDR: Revision. */
|
|---|
| 80 | #define GITS_BF_CTRL_REG_IIDR_REVISION_SHIFT 12
|
|---|
| 81 | #define GITS_BF_CTRL_REG_IIDR_REVISION_MASK UINT32_C(0x0000f000)
|
|---|
| 82 | /** GITS_IIDR: Variant. */
|
|---|
| 83 | #define GITS_BF_CTRL_REG_IIDR_VARIANT_SHIFT 16
|
|---|
| 84 | #define GITS_BF_CTRL_REG_IIDR_VARIANT_MASK UINT32_C(0x000f0000)
|
|---|
| 85 | /** GITS_IIDR: Reserved (bits 23:20). */
|
|---|
| 86 | #define GITS_BF_CTRL_REG_IIDR_RSVD_23_20_SHIFT 20
|
|---|
| 87 | #define GITS_BF_CTRL_REG_IIDR_RSVD_23_20_MASK UINT32_C(0x00f00000)
|
|---|
| 88 | /** GITS_IIDR: Product ID. */
|
|---|
| 89 | #define GITS_BF_CTRL_REG_IIDR_PRODUCT_ID_SHIFT 24
|
|---|
| 90 | #define GITS_BF_CTRL_REG_IIDR_PRODUCT_ID_MASK UINT32_C(0xff000000)
|
|---|
| 91 | RT_BF_ASSERT_COMPILE_CHECKS(GITS_BF_CTRL_REG_IIDR_, UINT32_C(0), UINT32_MAX,
|
|---|
| 92 | (IMPLEMENTER, REVISION, VARIANT, RSVD_23_20, PRODUCT_ID));
|
|---|
| 93 |
|
|---|
| 94 | /** GITS_TYPER: Feature register - RO. */
|
|---|
| 95 | #define GITS_CTRL_REG_TYPER_OFF 0x0008
|
|---|
| 96 | /** GITS_TYPER: Physical - Physical LPI support. */
|
|---|
| 97 | #define GITS_BF_CTRL_REG_TYPER_PHYSICAL_SHIFT 0
|
|---|
| 98 | #define GITS_BF_CTRL_REG_TYPER_PHYSICAL_MASK UINT64_C(0x0000000000000001)
|
|---|
| 99 | /** GITS_TYPER: Virtual - Virtual LPI support. */
|
|---|
| 100 | #define GITS_BF_CTRL_REG_TYPER_VIRTUAL_SHIFT 1
|
|---|
| 101 | #define GITS_BF_CTRL_REG_TYPER_VIRTUAL_MASK UINT64_C(0x0000000000000002)
|
|---|
| 102 | /** GITS_TYPER: CCT - Cumulative Collections Table. */
|
|---|
| 103 | #define GITS_BF_CTRL_REG_TYPER_CCT_SHIFT 2
|
|---|
| 104 | #define GITS_BF_CTRL_REG_TYPER_CCT_MASK UINT64_C(0x0000000000000004)
|
|---|
| 105 | /** GITS_TYPER: Implementation Defined. */
|
|---|
| 106 | #define GITS_BF_CTRL_REG_TYPER_IM_DE_SHIFT 3
|
|---|
| 107 | #define GITS_BF_CTRL_REG_TYPER_IM_DE_MASK UINT64_C(0x0000000000000008)
|
|---|
| 108 | /** GITS_TYPER: ITT_entry_size - Size of translation table entry. */
|
|---|
| 109 | #define GITS_BF_CTRL_REG_TYPER_ITT_ENTRY_SIZE_SHIFT 4
|
|---|
| 110 | #define GITS_BF_CTRL_REG_TYPER_ITT_ENTRY_SIZE_MASK UINT64_C(0x00000000000000f0)
|
|---|
| 111 | /** GITS_TYPER: ID_bits - Number of event ID bits implemented (minus one). */
|
|---|
| 112 | #define GITS_BF_CTRL_REG_TYPER_ID_BITS_SHIFT 8
|
|---|
| 113 | #define GITS_BF_CTRL_REG_TYPER_ID_BITS_MASK UINT64_C(0x0000000000001f00)
|
|---|
| 114 | /** GITS_TYPER: Devbits - Number of device ID bits implemented (minus one). */
|
|---|
| 115 | #define GITS_BF_CTRL_REG_TYPER_DEV_BITS_SHIFT 13
|
|---|
| 116 | #define GITS_BF_CTRL_REG_TYPER_DEV_BITS_MASK UINT64_C(0x000000000003e000)
|
|---|
| 117 | /** GITS_TYPER: SEIS - SEI support for virtual CPUs. */
|
|---|
| 118 | #define GITS_BF_CTRL_REG_TYPER_SEIS_SHIFT 18
|
|---|
| 119 | #define GITS_BF_CTRL_REG_TYPER_SEIS_MASK UINT64_C(0x0000000000040000)
|
|---|
| 120 | /** GITS_TYPER: PTA - Physical target address format. */
|
|---|
| 121 | #define GITS_BF_CTRL_REG_TYPER_PTA_SHIFT 19
|
|---|
| 122 | #define GITS_BF_CTRL_REG_TYPER_PTA_MASK UINT64_C(0x0000000000080000)
|
|---|
| 123 | /** GITS_TYPER: Reserved (bits 23:20). */
|
|---|
| 124 | #define GITS_BF_CTRL_REG_TYPER_RSVD_23_20_SHIFT 20
|
|---|
| 125 | #define GITS_BF_CTRL_REG_TYPER_RSVD_23_20_MASK UINT64_C(0x0000000000f00000)
|
|---|
| 126 | /** GITS_TYPER: HCC - Hardware collection count. */
|
|---|
| 127 | #define GITS_BF_CTRL_REG_TYPER_HCC_SHIFT 24
|
|---|
| 128 | #define GITS_BF_CTRL_REG_TYPER_HCC_MASK UINT64_C(0x00000000ff000000)
|
|---|
| 129 | /** GITS_TYPER: CIDbits - Number of collection ID bits (minus one). */
|
|---|
| 130 | #define GITS_BF_CTRL_REG_TYPER_CID_BITS_SHIFT 32
|
|---|
| 131 | #define GITS_BF_CTRL_REG_TYPER_CID_BITS_MASK UINT64_C(0x0000000f00000000)
|
|---|
| 132 | /** GITS_TYPER: CIL - Collection ID limit. */
|
|---|
| 133 | #define GITS_BF_CTRL_REG_TYPER_CIL_SHIFT 36
|
|---|
| 134 | #define GITS_BF_CTRL_REG_TYPER_CIL_MASK UINT64_C(0x0000001000000000)
|
|---|
| 135 | /** GITS_TYPER: VMOVP - Form of VMOVP command. */
|
|---|
| 136 | #define GITS_BF_CTRL_REG_TYPER_VMOVP_SHIFT 37
|
|---|
| 137 | #define GITS_BF_CTRL_REG_TYPER_VMOVP_MASK UINT64_C(0x0000002000000000)
|
|---|
| 138 | /** GITS_TYPER: MPAM - Memory partitioning and monitoring support. */
|
|---|
| 139 | #define GITS_BF_CTRL_REG_TYPER_MPAM_SHIFT 38
|
|---|
| 140 | #define GITS_BF_CTRL_REG_TYPER_MPAM_MASK UINT64_C(0x0000004000000000)
|
|---|
| 141 | /** GITS_TYPER: VSGI - Direct injection of virtual SGI support. */
|
|---|
| 142 | #define GITS_BF_CTRL_REG_TYPER_VSGI_SHIFT 39
|
|---|
| 143 | #define GITS_BF_CTRL_REG_TYPER_VSGI_MASK UINT64_C(0x0000008000000000)
|
|---|
| 144 | /** GITS_TYPER: VMAPP - VMAPP command support. */
|
|---|
| 145 | #define GITS_BF_CTRL_REG_TYPER_VMAPP_SHIFT 40
|
|---|
| 146 | #define GITS_BF_CTRL_REG_TYPER_VMAPP_MASK UINT64_C(0x0000010000000000)
|
|---|
| 147 | /** GITS_TYPER: SVPET - Shared VPE table configuration. */
|
|---|
| 148 | #define GITS_BF_CTRL_REG_TYPER_SVPET_SHIFT 41
|
|---|
| 149 | #define GITS_BF_CTRL_REG_TYPER_SVPET_MASK UINT64_C(0x0000060000000000)
|
|---|
| 150 | /** GITS_TYPER: nID - Individual doorbell interrupt support. */
|
|---|
| 151 | #define GITS_BF_CTRL_REG_TYPER_NID_SHIFT 43
|
|---|
| 152 | #define GITS_BF_CTRL_REG_TYPER_NID_MASK UINT64_C(0x0000080000000000)
|
|---|
| 153 | /** GITS_TYPER: UMSI - Support for reporting receipts of unmapped MSI. */
|
|---|
| 154 | #define GITS_BF_CTRL_REG_TYPER_UMSI_SHIFT 44
|
|---|
| 155 | #define GITS_BF_CTRL_REG_TYPER_UMSI_MASK UINT64_C(0x0000100000000000)
|
|---|
| 156 | /** GITS_TYPER: UMSIirq - Support for generating interrupt on receiving unmapped MSI. */
|
|---|
| 157 | #define GITS_BF_CTRL_REG_TYPER_UMSI_IRQ_SHIFT 45
|
|---|
| 158 | #define GITS_BF_CTRL_REG_TYPER_UMSI_IRQ_MASK UINT64_C(0x0000200000000000)
|
|---|
| 159 | /** GITS_TYPER: INV - Invalidate ITS cache on disable. */
|
|---|
| 160 | #define GITS_BF_CTRL_REG_TYPER_INV_SHIFT 46
|
|---|
| 161 | #define GITS_BF_CTRL_REG_TYPER_INV_MASK UINT64_C(0x0000400000000000)
|
|---|
| 162 | /** GITS_TYPER: Reserved (bits 63:47). */
|
|---|
| 163 | #define GITS_BF_CTRL_REG_TYPER_RSVD_63_47_SHIFT 47
|
|---|
| 164 | #define GITS_BF_CTRL_REG_TYPER_RSVD_63_47_MASK UINT64_C(0xffff800000000000)
|
|---|
| 165 | RT_BF_ASSERT_COMPILE_CHECKS(GITS_BF_CTRL_REG_TYPER_, UINT64_C(0), UINT64_MAX,
|
|---|
| 166 | (PHYSICAL, VIRTUAL, CCT, IM_DE, ITT_ENTRY_SIZE, ID_BITS, DEV_BITS, SEIS, PTA, RSVD_23_20, HCC,
|
|---|
| 167 | CID_BITS, CIL, VMOVP, MPAM, VSGI, VMAPP, SVPET, NID, UMSI, UMSI_IRQ, INV, RSVD_63_47));
|
|---|
| 168 |
|
|---|
| 169 | /** GITS_MPAMIDR: Memory partitioning ID sizes. */
|
|---|
| 170 | #define GITS_CTRL_REG_MPAMIDR_OFF 0x0010
|
|---|
| 171 | /** GITS_MPAMIDR: PARTIDmax - Maximum PARTID value supported. */
|
|---|
| 172 | #define GITS_BF_CTRL_REG_MPAMIDR_PARTID_MAX_SHIFT 0
|
|---|
| 173 | #define GITS_BF_CTRL_REG_MPAMIDR_PARTID_MAX_MASK UINT32_C(0x0000ffff)
|
|---|
| 174 | /** GITS_MPAMIDR: PMGmax - Maximum PMG value supported. */
|
|---|
| 175 | #define GITS_BF_CTRL_REG_MPAMIDR_PMG_MAX_SHIFT 16
|
|---|
| 176 | #define GITS_BF_CTRL_REG_MPAMIDR_PMG_MAX_MASK UINT32_C(0x00ff0000)
|
|---|
| 177 | /** GITS_MPAMIDR: Reserved (bits 24:31). */
|
|---|
| 178 | #define GITS_BF_CTRL_REG_MPAMIDR_RSVD_31_24_SHIFT 24
|
|---|
| 179 | #define GITS_BF_CTRL_REG_MPAMIDR_RSVD_31_24_MASK UINT32_C(0xff000000)
|
|---|
| 180 | RT_BF_ASSERT_COMPILE_CHECKS(GITS_BF_CTRL_REG_MPAMIDR_, UINT32_C(0), UINT32_MAX, (PARTID_MAX, PMG_MAX, RSVD_31_24));
|
|---|
| 181 |
|
|---|
| 182 | /** GITS_PARTID: PARTID and PMG values register. */
|
|---|
| 183 | #define GITS_CTRL_REG_PARTIDR_OFF 0x0014
|
|---|
| 184 | /** GITS_PARTID: PARTID - PARTID when ITS accesses memory. */
|
|---|
| 185 | #define GITS_BF_CTRL_REG_PARTIDR_PARTID_SHIFT 0
|
|---|
| 186 | #define GITS_BF_CTRL_REG_PARTIDR_PARTID_MASK UINT32_C(0x0000ffff)
|
|---|
| 187 | /** GITS_PARTID: PMG - PMG value when ITS accesses memory. */
|
|---|
| 188 | #define GITS_BF_CTRL_REG_PARTIDR_PMG_SHIFT 16
|
|---|
| 189 | #define GITS_BF_CTRL_REG_PARTIDR_PMG_MASK UINT32_C(0x00ff0000)
|
|---|
| 190 | /** GITS_PARTID: Reserved (bits 24:31). */
|
|---|
| 191 | #define GITS_BF_CTRL_REG_PARTIDR_RSVD_31_24_SHIFT 24
|
|---|
| 192 | #define GITS_BF_CTRL_REG_PARTIDR_RSVD_31_24_MASK UINT32_C(0xff000000)
|
|---|
| 193 | RT_BF_ASSERT_COMPILE_CHECKS(GITS_BF_CTRL_REG_PARTIDR_, UINT32_C(0), UINT32_MAX, (PARTID, PMG, RSVD_31_24));
|
|---|
| 194 |
|
|---|
| 195 | #define GITS_CTRL_REG_MPIDR_OFF 0x0018
|
|---|
| 196 | #define GITS_CTRL_REG_STATUSR_OFF 0x0040
|
|---|
| 197 | #define GITS_CTRL_REG_UMSIR_OFF 0x0048
|
|---|
| 198 | #define GITS_CTRL_REG_CBASER_OFF 0x0080
|
|---|
| 199 | #define GITS_CTRL_REG_CWRITER_OFF 0x0088
|
|---|
| 200 | #define GITS_CTRL_REG_CREADR_OFF 0x0090
|
|---|
| 201 |
|
|---|
| 202 | #define GITS_CTRL_REG_BASER_OFF_FIRST 0x0100
|
|---|
| 203 | #define GITS_CTRL_REG_BASER_OFF_LAST 0x0138
|
|---|
| 204 | #define GITS_CTRL_REG_BASER_RANGE_SIZE (GITS_CTRL_REG_BASER_OFF_LAST + sizeof(uint64_t) - GITS_CTRL_REG_BASER_OFF_FIRST)
|
|---|
| 205 |
|
|---|
| 206 | #define GITS_TRANSLATION_REG_TRANSLATER 0x0040
|
|---|
| 207 |
|
|---|
| 208 | /**
|
|---|
| 209 | * Memory shareability attributes.
|
|---|
| 210 | * In accordance to the ARM GIC spec.
|
|---|
| 211 | */
|
|---|
| 212 | typedef enum GITSATTRSHARE
|
|---|
| 213 | {
|
|---|
| 214 | GITSATTRSHARE_NON_SHAREABLE = 0,
|
|---|
| 215 | GITSATTRSHARE_INNER_SHAREABLE,
|
|---|
| 216 | GITSATTRSHARE_OUTER_SHAREABLE,
|
|---|
| 217 | GITSATTRSHARE_RSVD
|
|---|
| 218 | } GITSATTRSHARE;
|
|---|
| 219 |
|
|---|
| 220 | /**
|
|---|
| 221 | * Memory cacheability attribute.
|
|---|
| 222 | * In accordance to the ARM GIC spec.
|
|---|
| 223 | */
|
|---|
| 224 | typedef enum GITSATTRMEM
|
|---|
| 225 | {
|
|---|
| 226 | GITSATTRMEM_DEFAULT = 0,
|
|---|
| 227 | GITSATTRMEM_NOCACHE,
|
|---|
| 228 | GITSATTRMEM_CACHE_RD_ALLOC_WT,
|
|---|
| 229 | GITSATTRMEM_CACHE_RD_ALLOC_WB,
|
|---|
| 230 | GITSATTRMEM_CACHE_WR_ALLOC_WT,
|
|---|
| 231 | GITSATTRMEM_CACHE_WR_ALLOC_WB,
|
|---|
| 232 | GITSATTRMEM_CACHE_RW_ALLOC_WT,
|
|---|
| 233 | GITSATTRMEM_CACHE_RW_ALLOC_WB
|
|---|
| 234 | } GITSMEMATTR;
|
|---|
| 235 |
|
|---|
| 236 |
|
|---|
| 237 | /**
|
|---|
| 238 | * The ITS entry type.
|
|---|
| 239 | * In accordance to the ARM GIC spec.
|
|---|
| 240 | */
|
|---|
| 241 | typedef enum GITSITSTYPE
|
|---|
| 242 | {
|
|---|
| 243 | GITSITSTYPE_UNIMPLEMENTED = 0,
|
|---|
| 244 | GITSITSTYPE_DEVICES,
|
|---|
| 245 | GITSITSTYPE_VPES,
|
|---|
| 246 | GITSITSTYPE_INTR_COLLECTIONS
|
|---|
| 247 | } GITSITSTYPE;
|
|---|
| 248 |
|
|---|
| 249 | #endif /* !VBOX_INCLUDED_gic_its_h */
|
|---|
| 250 |
|
|---|
