linux-clk.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Damien Le Moal <damien.lemoal@wdc.com>
To: Palmer Dabbelt <palmer@dabbelt.com>,
	linux-riscv@lists.infradead.org, Rob Herring <robh+dt@kernel.org>,
	devicetree@vger.kernel.org, Stephen Boyd <sboyd@kernel.org>,
	linux-clk@vger.kernel.org,
	Linus Walleij <linus.walleij@linaro.org>,
	linux-gpio@vger.kernel.org,
	Philipp Zabel <p.zabel@pengutronix.de>
Cc: Sean Anderson <seanga2@gmail.com>
Subject: [PATCH v6 11/22] dt-binding: mfd: Document canaan,k210-sysctl bindings
Date: Wed,  9 Dec 2020 14:34:55 +0900	[thread overview]
Message-ID: <20201209053506.122582-12-damien.lemoal@wdc.com> (raw)
In-Reply-To: <20201209053506.122582-1-damien.lemoal@wdc.com>

Document the device tree bindings of the Canaan Kendryte K210 SoC
system controller driver in
Documentation/devicetree/bindings/mfd/canaan,k210-sysctl.yaml.

Signed-off-by: Damien Le Moal <damien.lemoal@wdc.com>
---
 .../bindings/mfd/canaan,k210-sysctl.yaml      | 116 ++++++++++++++++++
 1 file changed, 116 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mfd/canaan,k210-sysctl.yaml

diff --git a/Documentation/devicetree/bindings/mfd/canaan,k210-sysctl.yaml b/Documentation/devicetree/bindings/mfd/canaan,k210-sysctl.yaml
new file mode 100644
index 000000000000..a61d8ea4fbec
--- /dev/null
+++ b/Documentation/devicetree/bindings/mfd/canaan,k210-sysctl.yaml
@@ -0,0 +1,116 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mfd/canaan,k210-sysctl.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Canaan Kendryte K210 System Controller Device Tree Bindings
+
+maintainers:
+  - Damien Le Moal <damien.lemoal@wdc.com>
+
+description:
+  Canaan Inc. Kendryte K210 SoC system controller which provides a
+  register map for controlling the clocks, reset signals and pin power
+  domains of the SoC.
+
+properties:
+  compatible:
+    allOf:
+      - items:
+          - const: canaan,k210-sysctl
+          - const: syscon
+          - const: simple-mfd
+
+  clocks:
+    description:
+      System controller Advanced Power Bus (APB) interface clock source.
+
+  clock-names:
+    maxItems: 1
+    items:
+      - const: pclk
+
+  reg:
+    maxItems: 1
+    description:
+      Offset and length of the system controller register space.
+
+  reg-io-width:
+    const: 4
+
+  clock-controller:
+    # Child node
+    type: object
+    $ref: "../clock/canaan,k210-clk.yaml"
+    description:
+      Clock controller for the SoC clocks. This child node definition
+      should follow the bindings specified in
+      Documentation/devicetree/bindings/clock/canaan,k210-clk.yaml.
+
+  reset-controller:
+    # Child node
+    type: object
+    $ref: "../reset/canaan,k210-rst.yaml"
+    description:
+      Reset controller for the SoC. This child node definition
+      should follow the bindings specified in
+      Documentation/devicetree/bindings/reset/canaan,k210-rst.yaml.
+
+  syscon-reboot:
+    # Child node
+    type: object
+    $ref: "../power/reset/syscon-reboot.yaml"
+    description:
+      Reboot method for the SoC. This child node definition
+      should follow the bindings specified in
+      Documentation/devicetree/bindings/power/reset/syscon-reboot.yaml.
+
+required:
+  - compatible
+  - clocks
+  - reg
+  - clock-controller
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/k210-clk.h>
+    #include <dt-bindings/reset/k210-rst.h>
+
+    clocks {
+      in0: oscllator {
+        compatible = "fixed-clock";
+        #clock-cells = <0>;
+        clock-frequency = <26000000>;
+      };
+    };
+
+    sysctl: syscon@50440000 {
+      compatible = "canaan,k210-sysctl",
+                   "syscon", "simple-mfd";
+      reg = <0x50440000 0x100>;
+      reg-io-width = <4>;
+      clocks = <&sysclk K210_CLK_APB1>;
+      clock-names = "pclk";
+
+      sysclk: clock-controller {
+        #clock-cells = <1>;
+        compatible = "canaan,k210-clk";
+        clocks = <&in0>;
+      };
+
+      sysrst: reset-controller {
+        compatible = "canaan,k210-rst";
+        #reset-cells = <1>;
+      };
+
+      reboot: syscon-reboot {
+        compatible = "syscon-reboot";
+        regmap = <&sysctl>;
+        offset = <48>;
+        mask = <1>;
+        value = <1>;
+      };
+    };
-- 
2.28.0


  parent reply	other threads:[~2020-12-09  5:38 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-12-09  5:34 [PATCH v6 00/22] RISC-V Kendryte K210 support improvements Damien Le Moal
2020-12-09  5:34 ` [PATCH v6 01/22] riscv: Fix kernel time_init() Damien Le Moal
2020-12-09  5:34 ` [PATCH v6 02/22] riscv: Fix sifive serial driver Damien Le Moal
2020-12-09  5:34 ` [PATCH v6 03/22] riscv: Enable interrupts during syscalls with M-Mode Damien Le Moal
2020-12-09  5:34 ` [PATCH v6 04/22] riscv: Fix builtin DTB handling Damien Le Moal
2020-12-09  5:34 ` [PATCH v6 05/22] riscv: Use vendor name for K210 SoC support Damien Le Moal
2020-12-09  5:34 ` [PATCH v6 06/22] riscv: cleanup Canaan Kendryte K210 sysctl driver Damien Le Moal
2020-12-09  5:34 ` [PATCH v6 07/22] dt-bindings: Add Canaan vendor prefix Damien Le Moal
2020-12-09  5:34 ` [PATCH v6 08/22] dt-binding: clock: Document canaan,k210-clk bindings Damien Le Moal
2020-12-09  5:34 ` [PATCH v6 09/22] dt-bindings: reset: Document canaan,k210-rst bindings Damien Le Moal
2020-12-09  5:34 ` [PATCH v6 10/22] dt-bindings: pinctrl: Document canaan,k210-fpioa bindings Damien Le Moal
2020-12-09  5:34 ` Damien Le Moal [this message]
2020-12-09  5:34 ` [PATCH v6 12/22] riscv: Add Canaan Kendryte K210 clock driver Damien Le Moal
2020-12-09  5:34 ` [PATCH v6 13/22] riscv: Add Canaan Kendryte K210 reset controller Damien Le Moal
2020-12-09 13:50   ` kernel test robot
2020-12-09  5:34 ` [PATCH v6 14/22] riscv: Add Canaan Kendryte K210 FPIOA driver Damien Le Moal
2020-12-09  5:34 ` [PATCH v6 15/22] riscv: Update Canaan Kendryte K210 device tree Damien Le Moal
2020-12-09  5:35 ` [PATCH v6 16/22] riscv: Add SiPeed MAIX BiT board " Damien Le Moal
2020-12-09  5:35 ` [PATCH v6 17/22] riscv: Add SiPeed MAIX DOCK " Damien Le Moal
2020-12-09  5:35 ` [PATCH v6 18/22] riscv: Add SiPeed MAIX GO " Damien Le Moal
2020-12-09  5:35 ` [PATCH v6 19/22] riscv: Add SiPeed MAIXDUINO " Damien Le Moal
2020-12-09  5:35 ` [PATCH v6 20/22] riscv: Add Kendryte KD233 " Damien Le Moal
2020-12-09  5:35 ` [PATCH v6 21/22] riscv: Update Canaan Kendryte K210 defconfig Damien Le Moal
2020-12-09  5:35 ` [PATCH v6 22/22] riscv: Add Canaan Kendryte K210 SD card defconfig Damien Le Moal

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20201209053506.122582-12-damien.lemoal@wdc.com \
    --to=damien.lemoal@wdc.com \
    --cc=devicetree@vger.kernel.org \
    --cc=linus.walleij@linaro.org \
    --cc=linux-clk@vger.kernel.org \
    --cc=linux-gpio@vger.kernel.org \
    --cc=linux-riscv@lists.infradead.org \
    --cc=p.zabel@pengutronix.de \
    --cc=palmer@dabbelt.com \
    --cc=robh+dt@kernel.org \
    --cc=sboyd@kernel.org \
    --cc=seanga2@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).