Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

irqchip: renesas: intc-irqpin: Improve binding documentation

Add missing documentation for required properties:
- interrupt-controller,
- parent interrupts (one entry per provided interrupt).

Add missing documentation for optional properties:
- functional clock (managed since commit 705bc96c2c15313c ("irqchip:
renesas-intc-irqpin: Add minimal runtime PM support")),
- power-domains.

Add an example, taken from r8a7740.dtsi.

Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
Acked-by: Simon Horman <horms+renesas@verge.net.au>
Cc: Jason Cooper <jason@lakedaemon.net>
Link: http://lkml.kernel.org/r/1432891663-23641-1-git-send-email-geert%2Brenesas@glider.be
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>

authored by

Geert Uytterhoeven and committed by
Thomas Gleixner
496c28b1 9f61f625

+37 -2
+37 -2
Documentation/devicetree/bindings/interrupt-controller/renesas,intc-irqpin.txt
··· 13 13 - reg: Base address and length of each register bank used by the external 14 14 IRQ pins driven by the interrupt controller hardware module. The base 15 15 addresses, length and number of required register banks varies with soctype. 16 - 16 + - interrupt-controller: Identifies the node as an interrupt controller. 17 17 - #interrupt-cells: has to be <2>: an interrupt index and flags, as defined in 18 - interrupts.txt in this directory 18 + interrupts.txt in this directory. 19 + - interrupts: Must contain a list of interrupt specifiers. For each interrupt 20 + provided by this irqpin controller instance, there must be one entry, 21 + referring to the corresponding parent interrupt. 19 22 20 23 Optional properties: 21 24 ··· 28 25 if different from the default 4 bits 29 26 - control-parent: disable and enable interrupts on the parent interrupt 30 27 controller, needed for some broken implementations 28 + - clocks: Must contain a reference to the functional clock. This property is 29 + mandatory if the hardware implements a controllable functional clock for 30 + the irqpin controller instance. 31 + - power-domains: Must contain a reference to the power domain. This property is 32 + mandatory if the irqpin controller instance is part of a controllable power 33 + domain. 34 + 35 + 36 + Example 37 + ------- 38 + 39 + irqpin1: interrupt-controller@e6900004 { 40 + compatible = "renesas,intc-irqpin-r8a7740", 41 + "renesas,intc-irqpin"; 42 + #interrupt-cells = <2>; 43 + interrupt-controller; 44 + reg = <0xe6900004 4>, 45 + <0xe6900014 4>, 46 + <0xe6900024 1>, 47 + <0xe6900044 1>, 48 + <0xe6900064 1>; 49 + interrupts = <0 149 IRQ_TYPE_LEVEL_HIGH 50 + 0 149 IRQ_TYPE_LEVEL_HIGH 51 + 0 149 IRQ_TYPE_LEVEL_HIGH 52 + 0 149 IRQ_TYPE_LEVEL_HIGH 53 + 0 149 IRQ_TYPE_LEVEL_HIGH 54 + 0 149 IRQ_TYPE_LEVEL_HIGH 55 + 0 149 IRQ_TYPE_LEVEL_HIGH 56 + 0 149 IRQ_TYPE_LEVEL_HIGH>; 57 + clocks = <&mstp2_clks R8A7740_CLK_INTCA>; 58 + power-domains = <&pd_a4s>; 59 + };