devicetree: bindings: add top-level interrupt-source key

doc/_scripts/gen_devicetree_rest.py

@@ -491,16 +491,19 @@ def print_binding_page(binding, base_names, vnd_lookup, dup_compats,
           file=string_io)
 
     # Binding description.
-    if binding.bus:
-        bus_help = f'These nodes are "{binding.bus}" bus nodes.'
-    else:
-        bus_help = ''
     print_block(f'''\
     Description
     ***********
 
-    {bus_help}
     ''', string_io)
+    if binding.bus:
+        print(f'These nodes are "{binding.bus}" bus nodes.\n\n',
+              file=string_io)
+    if binding.interrupt_source:
+        print('These nodes are interrupt sources, which means '
+              'they must have either an ``interrupts`` or an '
+              '``interrupts-extended`` property set.\n\n',
+              file=string_io)
     print(to_code_block(binding.description.strip()), file=string_io)
 
     # Properties.

doc/build/dts/bindings-syntax.rst

@@ -34,6 +34,9 @@ like this:
    # Used to match nodes to this binding:
    compatible: "manufacturer,foo-device"
 
+   # Used to indicate that nodes of this type generate interrupts:
+   interrupt-source: <true | false>
+
    properties:
      # Requirements for and descriptions of the properties that this
      # binding's nodes need to satisfy go here.
@@ -111,6 +114,17 @@ vendor. In these cases, there is no vendor prefix. One example is the
 :dtcompatible:`gpio-leds` compatible which is commonly used to describe board
 LEDs connected to GPIOs.
 
+interrupt-source
+****************
+
+This key is a boolean. It is used to indicate that the hardware represented by
+this compatible generates interrupts. If the binding contains
+``interrupt-source: true``, then any node with this compatible must have either
+an ``interrupts`` or an ``interrupts-extended`` property set.
+
+Refer to the Devicetree Specification v0.3 section 2.4, Interrupts and
+Interrupt Mapping, for more details about these properties.
+
 .. _dt-bindings-properties:
 
 Properties

dts/bindings/adc/nordic,nrf-adc.yaml

@@ -5,15 +5,14 @@ description: nRF ADC node
 
 compatible: "nordic,nrf-adc"
 
+interrupt-source: true
+
 include: adc-controller.yaml
 
 properties:
   reg:
     required: true
 
-  interrupts:
-    required: true
-
   "#io-channel-cells":
     const: 1
 

dts/bindings/adc/nordic,nrf-comp.yaml

@@ -5,15 +5,14 @@ description: Nordic nRF family COMP (Comparator)
 
 compatible: "nordic,nrf-comp"
 
+interrupt-source: true
+
 include: base.yaml
 
 properties:
   reg:
     required: true
 
-  interrupts:
-    required: true
-
   "#io-channel-cells":
     type: int
     const: 1

dts/bindings/adc/nordic,nrf-lpcomp.yaml

@@ -5,15 +5,14 @@ description: Nordic nRF family LPCOMP (Low-power Comparator)
 
 compatible: "nordic,nrf-lpcomp"
 
+interrupt-source: true
+
 include: base.yaml
 
 properties:
   reg:
     required: true
 
-  interrupts:
-    required: true
-
   "#io-channel-cells":
     type: int
     const: 1

dts/bindings/adc/nordic,nrf-saadc.yaml

@@ -5,15 +5,14 @@ description: Nordic Semiconductor nRF family SAADC node
 
 compatible: "nordic,nrf-saadc"
 
+interrupt-source: true
+
 include: adc-controller.yaml
 
 properties:
   reg:
     required: true
 
-  interrupts:
-    required: true
-
   "#io-channel-cells":
     const: 1
 

dts/bindings/arm/nordic,nrf-egu.yaml

@@ -5,11 +5,10 @@ description: Nordic EGU (Event Generator Unit)
 
 compatible: "nordic,nrf-egu"
 
+interrupt-source: true
+
 include: base.yaml
 
 properties:
   reg:
     required: true
-
-  interrupts:
-    required: true

dts/bindings/arm/nordic,nrf-kmu.yaml

@@ -5,11 +5,10 @@ description: Nordic KMU (Key Management Unit)
 
 compatible: "nordic,nrf-kmu"
 
+interrupt-source: true
+
 include: base.yaml
 
 properties:
   reg:
     required: true
-
-  interrupts:
-    required: true

dts/bindings/arm/nordic,nrf-spu.yaml

@@ -2,11 +2,10 @@ description: Nordic SPU (System Protection Unit)
 
 compatible: "nordic,nrf-spu"
 
+interrupt-source: true
+
 include: base.yaml
 
 properties:
   reg:
     required: true
-
-  interrupts:
-    required: true

dts/bindings/arm/nordic,nrf-swi.yaml

@@ -5,11 +5,10 @@ description: Nordic nRF family SWI (Software Interrupt)
 
 compatible: "nordic,nrf-swi"
 
+interrupt-source: true
+
 include: base.yaml
 
 properties:
   reg:
     required: true
-
-  interrupts:
-    required: true

dts/bindings/audio/nordic,nrf-pdm.yaml

@@ -5,15 +5,14 @@ description: Nordic PDM (Pulse Density Modulation interface)
 
 compatible: "nordic,nrf-pdm"
 
+interrupt-source: true
+
 include: [base.yaml, pinctrl-device.yaml]
 
 properties:
   reg:
     required: true
 
-  interrupts:
-    required: true
-
   pinctrl-0:
     required: true
 

dts/bindings/clock/nordic,nrf-clock.yaml

@@ -5,15 +5,14 @@ description: Nordic nRF clock control node
 
 compatible: "nordic,nrf-clock"
 
+interrupt-source: true
+
 include: base.yaml
 
 properties:
   reg:
     required: true
 
-  interrupts:
-    required: true
-
   hfclkaudio-frequency:
     type: int
     description: |

dts/bindings/crypto/nordic,nrf-ccm.yaml

@@ -5,15 +5,14 @@ description: Nordic nRF family CCM (AES CCM mode encryption)
 
 compatible: "nordic,nrf-ccm"
 
+interrupt-source: true
+
 include: base.yaml
 
 properties:
   reg:
     required: true
 
-  interrupts:
-    required: true
-
   length-field-length-8-bits:
     type: boolean
     description: |

dts/bindings/crypto/nordic,nrf-ecb.yaml

@@ -5,11 +5,10 @@ description: Nordic ECB (AES electronic codebook mode encryption)
 
 compatible: "nordic,nrf-ecb"
 
+interrupt-source: true
+
 include: base.yaml
 
 properties:
   reg:
     required: true
-
-  interrupts:
-    required: true

dts/bindings/flash_controller/nordic,nrf-qspi.yaml

@@ -21,6 +21,8 @@ description: |
 
 compatible: "nordic,nrf-qspi"
 
+interrupt-source: true
+
 include: [flash-controller.yaml, pinctrl-device.yaml]
 
 bus: qspi
@@ -34,8 +36,5 @@ properties:
     required: true
     const: 0
 
-  interrupts:
-    required: true
-
   pinctrl-0:
     required: true

dts/bindings/gpio/nordic,nrf-gpiote.yaml

@@ -5,11 +5,10 @@ description: NRF5 GPIOTE node
 
 compatible: "nordic,nrf-gpiote"
 
+interrupt-source: true
+
 include: base.yaml
 
 properties:
   reg:
     required: true
-
-  interrupts:
-    required: true

dts/bindings/i2c/nordic,nrf-twi-common.yaml

@@ -6,12 +6,11 @@
 
 include: [i2c-controller.yaml, pinctrl-device.yaml]
 
+interrupt-source: true
+
 properties:
   reg:
     required: true
 
-  interrupts:
-    required: true
-
   pinctrl-0:
     required: true

dts/bindings/i2s/nordic,nrf-i2s.yaml

@@ -5,15 +5,14 @@ description: Nordic I2S (Inter-IC sound interface)
 
 compatible: "nordic,nrf-i2s"
 
+interrupt-source: true
+
 include: [i2s-controller.yaml, pinctrl-device.yaml]
 
 properties:
   reg:
     required: true
 
-  interrupts:
-    required: true
-
   pinctrl-0:
     required: true
 

dts/bindings/ipm/nordic,nrf-ipc.yaml

@@ -5,11 +5,10 @@ description: Nordic nRF family IPC (Interprocessor Communication)
 
 compatible: "nordic,nrf-ipc"
 
+interrupt-source: true
+
 include: base.yaml
 
 properties:
   reg:
     required: true
-
-  interrupts:
-    required: true

dts/bindings/mbox/nordic,mbox-nrf-ipc.yaml

@@ -5,6 +5,8 @@ description: Nordic nRF family IPC (MBOX Interprocessor Communication)
 
 compatible: "nordic,mbox-nrf-ipc"
 
+interrupt-source: true
+
 include: [base.yaml, mailbox-controller.yaml]
 
 properties:
@@ -18,8 +20,5 @@ properties:
     required: true
     description: RX supported channels mask
 
-  interrupts:
-    required: true
-
 mbox-cells:
   - channel

dts/bindings/net/wireless/nordic,nrf-nfct.yaml

@@ -5,11 +5,10 @@ description: Nordic nRF family NFCT (Near Field Communication Tag)
 
 compatible: "nordic,nrf-nfct"
 
+interrupt-source: true
+
 include: base.yaml
 
 properties:
   reg:
     required: true
-
-  interrupts:
-    required: true

dts/bindings/net/wireless/nordic,nrf-radio.yaml

@@ -108,15 +108,14 @@ description: |
 
 compatible: "nordic,nrf-radio"
 
+interrupt-source: true
+
 include: [base.yaml]
 
 properties:
   reg:
     required: true
 
-  interrupts:
-    required: true
-
   fem:
     type: phandle
     description: |

dts/bindings/power/nordic,nrf-power.yaml

@@ -5,11 +5,10 @@ description: Nordic nRF power control node
 
 compatible: "nordic,nrf-power"
 
+interrupt-source: true
+
 include: base.yaml
 
 properties:
   reg:
     required: true
-
-  interrupts:
-    required: true