linux-kernel - [PATCH] dt-bindings: mips: Convert plain text file to ReST

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <20220521015613.6197-1-soumya.negi97@gmail.com>
Date:   Fri, 20 May 2022 18:56:13 -0700
From:   Soumya Negi <soumya.negi97@...il.com>
To:     Shuah Khan <skhan@...uxfoundation.org>,
        Thomas Bogendoerfer <tsbogend@...ha.franken.de>,
        Rob Herring <robh+dt@...nel.org>,
        Krzysztof Kozlowski <krzysztof.kozlowski+dt@...aro.org>
Cc:     Soumya Negi <soumya.negi97@...il.com>,
        linux-kernel-mentees@...ts.linuxfoundation.org,
        linux-mips@...r.kernel.org, devicetree@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: [PATCH] dt-bindings: mips: Convert plain text file to ReST

Converts .txt documentation file to ReST format(.rst).

Signed-off-by: Soumya Negi <soumya.negi97@...il.com>
---
 .../devicetree/bindings/mips/cpu_irq.rst      | 56 +++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mips/cpu_irq.rst

diff --git a/Documentation/devicetree/bindings/mips/cpu_irq.rst b/Documentation/devicetree/bindings/mips/cpu_irq.rst
new file mode 100644
index 000000000000..601cc12caa2a
--- /dev/null
+++ b/Documentation/devicetree/bindings/mips/cpu_irq.rst
@@ -0,0 +1,56 @@
+=============================
+MIPS CPU interrupt controller
+=============================
+
+On MIPS the ``mips_cpu_irq_of_init()`` helper can be used to initialize the 8 CPU
+IRQs from a devicetree file and create a ``irq_domain`` for IRQ controller.
+
+With the ``irq_domain`` in place we can describe how the 8 IRQs are wired to the
+platforms internal interrupt controller cascade.
+
+Below is an example of a platform describing the cascade inside the devicetree
+and the code used to load it inside ``arch_init_irq()``.
+
+Required properties
+-------------------
+* compatible: Should be **"mti,cpu-interrupt-controller"**
+
+Example devicetree
+------------------
+::
+
+	cpu-irq: cpu-irq {
+		#address-cells = <0>;
+
+		interrupt-controller;
+		#interrupt-cells = <1>;
+
+		compatible = "mti,cpu-interrupt-controller";
+	};
+
+	intc: intc@200 {
+		compatible = "ralink,rt2880-intc";
+		reg = <0x200 0x100>;
+
+		interrupt-controller;
+		#interrupt-cells = <1>;
+
+		interrupt-parent = <&cpu-irq>;
+		interrupts = <2>;
+	};
+
+
+Example platform ``irq.c``
+--------------------------
+::
+
+	static struct of_device_id __initdata of_irq_ids[] = {
+		{ .compatible = "mti,cpu-interrupt-controller", .data = mips_cpu_irq_of_init },
+		{ .compatible = "ralink,rt2880-intc", .data = intc_of_init },
+		{},
+	};
+
+	void __init arch_init_irq(void)
+	{
+		of_irq_init(of_irq_ids);
+	}
-- 
2.17.1