Merge tag 'iwlwifi-next-for-kalle-2014-12-30' of https://git.kernel.org/pub/scm/linux...
[cascardo/linux.git] / Documentation / devicetree / bindings / arm / gic.txt
1 * ARM Generic Interrupt Controller
2
3 ARM SMP cores are often associated with a GIC, providing per processor
4 interrupts (PPI), shared processor interrupts (SPI) and software
5 generated interrupts (SGI).
6
7 Primary GIC is attached directly to the CPU and typically has PPIs and SGIs.
8 Secondary GICs are cascaded into the upward interrupt controller and do not
9 have PPIs or SGIs.
10
11 Main node required properties:
12
13 - compatible : should be one of:
14         "arm,gic-400"
15         "arm,cortex-a15-gic"
16         "arm,cortex-a9-gic"
17         "arm,cortex-a7-gic"
18         "arm,arm11mp-gic"
19         "brcm,brahma-b15-gic"
20         "arm,arm1176jzf-devchip-gic"
21 - interrupt-controller : Identifies the node as an interrupt controller
22 - #interrupt-cells : Specifies the number of cells needed to encode an
23   interrupt source.  The type shall be a <u32> and the value shall be 3.
24
25   The 1st cell is the interrupt type; 0 for SPI interrupts, 1 for PPI
26   interrupts.
27
28   The 2nd cell contains the interrupt number for the interrupt type.
29   SPI interrupts are in the range [0-987].  PPI interrupts are in the
30   range [0-15].
31
32   The 3rd cell is the flags, encoded as follows:
33         bits[3:0] trigger type and level flags.
34                 1 = low-to-high edge triggered
35                 2 = high-to-low edge triggered
36                 4 = active high level-sensitive
37                 8 = active low level-sensitive
38         bits[15:8] PPI interrupt cpu mask.  Each bit corresponds to each of
39         the 8 possible cpus attached to the GIC.  A bit set to '1' indicated
40         the interrupt is wired to that CPU.  Only valid for PPI interrupts.
41
42 - reg : Specifies base physical address(s) and size of the GIC registers. The
43   first region is the GIC distributor register base and size. The 2nd region is
44   the GIC cpu interface register base and size.
45
46 Optional
47 - interrupts    : Interrupt source of the parent interrupt controller on
48   secondary GICs, or VGIC maintenance interrupt on primary GIC (see
49   below).
50
51 - cpu-offset    : per-cpu offset within the distributor and cpu interface
52   regions, used when the GIC doesn't have banked registers. The offset is
53   cpu-offset * cpu-nr.
54
55 - arm,routable-irqs : Total number of gic irq inputs which are not directly
56                   connected from the peripherals, but are routed dynamically
57                   by a crossbar/multiplexer preceding the GIC. The GIC irq
58                   input line is assigned dynamically when the corresponding
59                   peripheral's crossbar line is mapped.
60 Example:
61
62         intc: interrupt-controller@fff11000 {
63                 compatible = "arm,cortex-a9-gic";
64                 #interrupt-cells = <3>;
65                 #address-cells = <1>;
66                 interrupt-controller;
67                 arm,routable-irqs = <160>;
68                 reg = <0xfff11000 0x1000>,
69                       <0xfff10100 0x100>;
70         };
71
72
73 * GIC virtualization extensions (VGIC)
74
75 For ARM cores that support the virtualization extensions, additional
76 properties must be described (they only exist if the GIC is the
77 primary interrupt controller).
78
79 Required properties:
80
81 - reg : Additional regions specifying the base physical address and
82   size of the VGIC registers. The first additional region is the GIC
83   virtual interface control register base and size. The 2nd additional
84   region is the GIC virtual cpu interface register base and size.
85
86 - interrupts : VGIC maintenance interrupt.
87
88 Example:
89
90         interrupt-controller@2c001000 {
91                 compatible = "arm,cortex-a15-gic";
92                 #interrupt-cells = <3>;
93                 interrupt-controller;
94                 reg = <0x2c001000 0x1000>,
95                       <0x2c002000 0x1000>,
96                       <0x2c004000 0x2000>,
97                       <0x2c006000 0x2000>;
98                 interrupts = <1 9 0xf04>;
99         };
100
101
102 * GICv2m extension for MSI/MSI-x support (Optional)
103
104 Certain revisions of GIC-400 supports MSI/MSI-x via V2M register frame(s).
105 This is enabled by specifying v2m sub-node(s).
106
107 Required properties:
108
109 - compatible        : The value here should contain "arm,gic-v2m-frame".
110
111 - msi-controller    : Identifies the node as an MSI controller.
112
113 - reg               : GICv2m MSI interface register base and size
114
115 Optional properties:
116
117 - arm,msi-base-spi  : When the MSI_TYPER register contains an incorrect
118                       value, this property should contain the SPI base of
119                       the MSI frame, overriding the HW value.
120
121 - arm,msi-num-spis  : When the MSI_TYPER register contains an incorrect
122                       value, this property should contain the number of
123                       SPIs assigned to the frame, overriding the HW value.
124
125 Example:
126
127         interrupt-controller@e1101000 {
128                 compatible = "arm,gic-400";
129                 #interrupt-cells = <3>;
130                 #address-cells = <2>;
131                 #size-cells = <2>;
132                 interrupt-controller;
133                 interrupts = <1 8 0xf04>;
134                 ranges = <0 0 0 0xe1100000 0 0x100000>;
135                 reg = <0x0 0xe1110000 0 0x01000>,
136                       <0x0 0xe112f000 0 0x02000>,
137                       <0x0 0xe1140000 0 0x10000>,
138                       <0x0 0xe1160000 0 0x10000>;
139                 v2m0: v2m@0x8000 {
140                         compatible = "arm,gic-v2m-frame";
141                         msi-controller;
142                         reg = <0x0 0x80000 0 0x1000>;
143                 };
144
145                 ....
146
147                 v2mN: v2m@0x9000 {
148                         compatible = "arm,gic-v2m-frame";
149                         msi-controller;
150                         reg = <0x0 0x90000 0 0x1000>;
151                 };
152         };