arm_vgic 0.4.2

ARM Virtual Generic Interrupt Controller (VGIC) implementation.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

// Copyright 2025 The Axvisor Team
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#![allow(unused)]
//! TODO: merge this with `src/registers.rs`

/// Maximum number of IRQs supported by GICv3. We count special interrupt numbers from 1020 to 1023,
/// to make the number more intuitive and easier to work with.
pub const MAX_IRQ_V3: usize = 1024;

macro_rules! register_range {
    ($reg:ident, $range:ident, $number:literal, $size:literal) => {
        pub const $range: core::ops::Range<usize> = ($reg)..($reg + $number * $size);
    };
}

pub const GICD_CTLR: usize = 0x0000;
pub const GICD_CTLR_ARE_NS: usize = 1 << 5;
pub const GICD_CTLR_GRP1NS_ENA: usize = 1 << 1;

pub const GICD_TYPER: usize = 0x0004;
pub const GICD_IIDR: usize = 0x0008;
pub const GICD_TYPER2: usize = 0x000c;

pub const GICD_IGROUPR: usize = 0x0080;
pub const GICD_ISENABLER: usize = 0x0100;
pub const GICD_ICENABLER: usize = 0x0180;
pub const GICD_ISPENDR: usize = 0x0200;
pub const GICD_ICPENDR: usize = 0x0280;
pub const GICD_ISACTIVER: usize = 0x0300;
pub const GICD_ICACTIVER: usize = 0x0380;
pub const GICD_IPRIORITYR: usize = 0x0400;
pub const GICD_ITARGETSR: usize = 0x0800;
pub const GICD_ICFGR: usize = 0x0c00;
pub const GICD_IGRPMODR: usize = 0x0d00;
pub const GICD_NSACR: usize = 0x0e00;
pub const GICD_SGIR: usize = 0x0f00;
pub const GICD_CPENDSGIR: usize = 0x0f10;
pub const GICD_SPENDSGIR: usize = 0x0f20;
pub const GICD_IROUTER: usize = 0x6000;

pub const GICDV3_CIDR0: usize = 0xfff0;
pub const GICDV3_PIDR0: usize = 0xffe0;
pub const GICDV3_PIDR2: usize = 0xffe8;
pub const GICDV3_PIDR4: usize = 0xffd0;

register_range!(GICD_IROUTER, GICD_IROUTER_RANGE, 1024, 8);
register_range!(GICD_ITARGETSR, GICD_ITARGETSR_RANGE, 1024, 1);
register_range!(GICD_ICENABLER, GICD_ICENABLER_RANGE, 32, 4);
register_range!(GICD_ISENABLER, GICD_ISENABLER_RANGE, 32, 4);
register_range!(GICD_ICPENDR, GICD_ICPENDR_RANGE, 32, 4);
register_range!(GICD_ISPENDR, GICD_ISPENDR_RANGE, 32, 4);
register_range!(GICD_ICACTIVER, GICD_ICACTIVER_RANGE, 32, 4);
register_range!(GICD_ISACTIVER, GICD_ISACTIVER_RANGE, 32, 4);
register_range!(GICD_IGROUPR, GICD_IGROUPR_RANGE, 32, 4);
register_range!(GICD_ICFGR, GICD_ICFGR_RANGE, 64, 4);
register_range!(GICD_IGRPMODR, GICD_IGRPMODR_RANGE, 32, 4);
// register_range!(GICD_IPRIORITYR, GICD_IPRIORITYR_RANGE, 255, 4);
register_range!(GICD_IPRIORITYR, GICD_IPRIORITYR_RANGE, 256, 4);
register_range!(GICDV3_CIDR0, GICDV3_CIDR0_RANGE, 4, 4);
register_range!(GICDV3_PIDR0, GICDV3_PIDR0_RANGE, 4, 4);
register_range!(GICDV3_PIDR4, GICDV3_PIDR4_RANGE, 4, 4);

pub const GITS_CTRL: usize = 0x0000; // enable / disable
pub const GITS_IIDR: usize = 0x0004; // read-only
pub const GITS_TYPER: usize = 0x0008; // read-only
pub const GITS_MPAMIDR: usize = 0x0010; // read-only
pub const GITS_PARTIDR: usize = 0x0014; // supported MPAM sizes
pub const GITS_MPIDR: usize = 0x0018; // read-only, its affinity
pub const GITS_STATUSR: usize = 0x0040; // error reporting
pub const GITS_UMSIR: usize = 0x0048; // unmapped msi
pub const GITS_CBASER: usize = 0x0080; // the addr of command queue
pub const GITS_CWRITER: usize = 0x0088; // rw, write an command to the cmdq, write this reg to tell hw
pub const GITS_CREADR: usize = 0x0090; // read-only, hardware changes it
pub const GITS_BASER: usize = 0x0100; // itt, desc
pub const GITS_DT_BASER: usize = GITS_BASER; // its table 0 used as device table
pub const GITS_CT_BASER: usize = GITS_BASER + 0x8; // its table 1 used as command table
pub const GITS_COLLECTION_BASER: usize = GITS_BASER + 0x8;
pub const GITS_TRANSLATER: usize = 0x10000 + 0x0040; // to signal an interrupt, written by devices

pub const GICR_CTLR: usize = 0x0000;
pub const GICR_IIDR: usize = 0x0004;
pub const GICR_TYPER: usize = 0x0008;
pub const GICR_STATUSR: usize = 0x0010;
pub const GICR_WAKER: usize = 0x0014;
pub const GICR_SETLPIR: usize = 0x0040;
pub const GICR_CLRLPIR: usize = 0x0048;
pub const GICR_INVLPIR: usize = 0x00a0;
pub const GICR_INVALLR: usize = 0x00b0;
pub const GICR_SYNCR: usize = 0x00c0;
pub const GICR_PIDR2: usize = 0xffe8;
pub const GICR_IMPL_DEF_IDENT_REGS_START: usize = 0xffd0;
pub const GICR_IMPL_DEF_IDENT_REGS_END: usize = 0xfffc;
pub const GICR_SGI_BASE: usize = 0x10000;

pub const GICR_IGROUPR: usize = GICR_SGI_BASE + GICD_IGROUPR;
pub const GICR_ISENABLER: usize = GICR_SGI_BASE + GICD_ISENABLER;
pub const GICR_ICENABLER: usize = GICR_SGI_BASE + GICD_ICENABLER;
pub const GICR_ISPENDR: usize = GICR_SGI_BASE + GICD_ISPENDR;
pub const GICR_ICPENDR: usize = GICR_SGI_BASE + GICD_ICPENDR;
pub const GICR_ISACTIVER: usize = GICR_SGI_BASE + GICD_ISACTIVER;
pub const GICR_ICACTIVER: usize = GICR_SGI_BASE + GICD_ICACTIVER;
pub const GICR_IPRIORITYR: usize = GICR_SGI_BASE + GICD_IPRIORITYR;
pub const GICR_ICFGR: usize = GICR_SGI_BASE + GICD_ICFGR;
pub const GICR_IGRPMODR: usize = GICR_SGI_BASE + GICD_IGRPMODR;
pub const GICR_TYPER_LAST: usize = 1 << 4;

register_range!(GICR_IPRIORITYR, GICR_IPRIORITYR_RANGE, 8, 4);
register_range!(GICR_ICFGR, GICR_ICFGR_RANGE, 2, 4);

pub const GICR_PROPBASER: usize = 0x0070;
pub const GICR_PENDBASER: usize = 0x0078;

pub const MAINTENACE_INTERRUPT: u64 = 25;