Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 496c28b1 authored by Geert Uytterhoeven's avatar Geert Uytterhoeven Committed by Thomas Gleixner
Browse files

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 705bc96c ("irqchip:
    renesas-intc-irqpin: Add minimal runtime PM support")),
  - power-domains.

Add an example, taken from r8a7740.dtsi.

Signed-off-by: default avatarGeert Uytterhoeven <geert+renesas@glider.be>
Acked-by: default avatarSimon 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: default avatarThomas Gleixner <tglx@linutronix.de>
parent 9f61f625

Documentation/devicetree/bindings/interrupt-controller/renesas,intc-irqpin.txt

+37 −2
Original line number Original line Diff line number Diff line
@@ -13,9 +13,12 @@ Required properties: 
- reg: Base address and length of each register bank used by the external

- reg: Base address and length of each register bank used by the external

  IRQ pins driven by the interrupt controller hardware module. The base

  IRQ pins driven by the interrupt controller hardware module. The base

  addresses, length and number of required register banks varies with soctype.

  addresses, length and number of required register banks varies with soctype.



- interrupt-controller: Identifies the node as an interrupt controller.

- #interrupt-cells: has to be <2>: an interrupt index and flags, as defined in

- #interrupt-cells: has to be <2>: an interrupt index and flags, as defined in

  interrupts.txt in this directory

  interrupts.txt in this directory.

- interrupts: Must contain a list of interrupt specifiers. For each interrupt

  provided by this irqpin controller instance, there must be one entry,

  referring to the corresponding parent interrupt.





Optional properties:

Optional properties:
@@ -25,3 +28,35 @@ Optional properties: 
  if different from the default 4 bits

  if different from the default 4 bits

- control-parent: disable and enable interrupts on the parent interrupt

- control-parent: disable and enable interrupts on the parent interrupt

  controller, needed for some broken implementations

  controller, needed for some broken implementations

- clocks: Must contain a reference to the functional clock.  This property is

  mandatory if the hardware implements a controllable functional clock for

  the irqpin controller instance.

- power-domains: Must contain a reference to the power domain. This property is

  mandatory if the irqpin controller instance is part of a controllable power

  domain.





Example

-------



	irqpin1: interrupt-controller@e6900004 {

		compatible = "renesas,intc-irqpin-r8a7740",

			     "renesas,intc-irqpin";

		#interrupt-cells = <2>;

		interrupt-controller;

		reg = <0xe6900004 4>,

			<0xe6900014 4>,

			<0xe6900024 1>,

			<0xe6900044 1>,

			<0xe6900064 1>;

		interrupts = <0 149 IRQ_TYPE_LEVEL_HIGH

			      0 149 IRQ_TYPE_LEVEL_HIGH

			      0 149 IRQ_TYPE_LEVEL_HIGH

			      0 149 IRQ_TYPE_LEVEL_HIGH

			      0 149 IRQ_TYPE_LEVEL_HIGH

			      0 149 IRQ_TYPE_LEVEL_HIGH

			      0 149 IRQ_TYPE_LEVEL_HIGH

			      0 149 IRQ_TYPE_LEVEL_HIGH>;

		clocks = <&mstp2_clks R8A7740_CLK_INTCA>;

		power-domains = <&pd_a4s>;

	};