Documentation/devicetree/bindings/interrupt-controller/apple,aic.yaml

   1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
   2 %YAML 1.2
   3 ---
   4 $id: http://devicetree.org/schemas/interrupt-controller/apple,aic.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: Apple Interrupt Controller
   8
   9 maintainers:
  10   - Hector Martin <marcan@marcan.st>
  11
  12 description: |
  13   The Apple Interrupt Controller is a simple interrupt controller present on
  14   Apple ARM SoC platforms, including various iPhone and iPad devices and the
  15   "Apple Silicon" Macs.
  16
  17   It provides the following features:
  18
  19   - Level-triggered hardware IRQs wired to SoC blocks
  20     - Single mask bit per IRQ
  21     - Per-IRQ affinity setting
  22     - Automatic masking on event delivery (auto-ack)
  23     - Software triggering (ORed with hw line)
  24   - 2 per-CPU IPIs (meant as "self" and "other", but they are interchangeable
  25     if not symmetric)
  26   - Automatic prioritization (single event/ack register per CPU, lower IRQs =
  27     higher priority)
  28   - Automatic masking on ack
  29   - Default "this CPU" register view and explicit per-CPU views
  30
  31   This device also represents the FIQ interrupt sources on platforms using AIC,
  32   which do not go through a discrete interrupt controller.
  33
  34 allOf:
  35   - $ref: /schemas/interrupt-controller.yaml#
  36
  37 properties:
  38   compatible:
  39     items:
  40       - const: apple,t8103-aic
  41       - const: apple,aic
  42
  43   interrupt-controller: true
  44
  45   '#interrupt-cells':
  46     const: 3
  47     description: |
  48       The 1st cell contains the interrupt type:
  49         - 0: Hardware IRQ
  50         - 1: FIQ
  51
  52       The 2nd cell contains the interrupt number.
  53         - HW IRQs: interrupt number
  54         - FIQs:
  55           - 0: physical HV timer
  56           - 1: virtual HV timer
  57           - 2: physical guest timer
  58           - 3: virtual guest timer
  59           - 4: 'efficient' CPU PMU
  60           - 5: 'performance' CPU PMU
  61
  62       The 3rd cell contains the interrupt flags. This is normally
  63       IRQ_TYPE_LEVEL_HIGH (4).
  64
  65   reg:
  66     description: |
  67       Specifies base physical address and size of the AIC registers.
  68     maxItems: 1
  69
  70   power-domains:
  71     maxItems: 1
  72
  73   affinities:
  74     type: object
  75     additionalProperties: false
  76     description:
  77       FIQ affinity can be expressed as a single "affinities" node,
  78       containing a set of sub-nodes, one per FIQ with a non-default
  79       affinity.
  80     patternProperties:
  81       "^.+-affinity$":
  82         type: object
  83         additionalProperties: false
  84         properties:
  85           apple,fiq-index:
  86             description:
  87               The interrupt number specified as a FIQ, and for which
  88               the affinity is not the default.
  89             $ref: /schemas/types.yaml#/definitions/uint32
  90             maximum: 5
  91
  92           cpus:
  93             description:
  94               Should be a list of phandles to CPU nodes (as described in
  95               Documentation/devicetree/bindings/arm/cpus.yaml).
  96
  97         required:
  98           - apple,fiq-index
  99           - cpus
 100
 101 required:
 102   - compatible
 103   - '#interrupt-cells'
 104   - interrupt-controller
 105   - reg
 106
 107 additionalProperties: false
 108
 109 examples:
 110   - |
 111     soc {
 112         #address-cells = <2>;
 113         #size-cells = <2>;
 114
 115         aic: interrupt-controller@23b100000 {
 116             compatible = "apple,t8103-aic", "apple,aic";
 117             #interrupt-cells = <3>;
 118             interrupt-controller;
 119             reg = <0x2 0x3b100000 0x0 0x8000>;
 120         };
 121     };