From: Nishanth Menon <nm@ti.com> To: Philipp Zabel <p.zabel@pengutronix.de>, Stephen Boyd <sboyd@kernel.org>, Michael Turquette <mturquette@baylibre.com>, Rob Herring <robh+dt@kernel.org>, Santosh Shilimkar <ssantosh@kernel.org>, Tero Kristo <kristo@kernel.org>, Nishanth Menon <nm@ti.com> Cc: <linux-clk@vger.kernel.org>, <linux-kernel@vger.kernel.org>, <devicetree@vger.kernel.org>, <linux-arm-kernel@lists.infradead.org> Subject: [PATCH 2/4] dt-bindings: clock: Convert ti,sci-clk to json schema Date: Fri, 16 Apr 2021 01:37:19 -0500 [thread overview] Message-ID: <20210416063721.20538-3-nm@ti.com> (raw) In-Reply-To: <20210416063721.20538-1-nm@ti.com> Convert the ti,sci-clk to json schema for better checks and documentation. Differences being: - Drop consumer example as they are documented in the corresponding bindings themselves. - Standardize the node name as clock-controller rather than clocks as it is more appropriate. - Drop phandle description for clock-cells as it is redundant. NOTE: we do have false positive checkpatch warning with this patch: "DT binding docs and includes should be a separate patch" Signed-off-by: Nishanth Menon <nm@ti.com> --- .../devicetree/bindings/clock/ti,sci-clk.txt | 36 ------------- .../devicetree/bindings/clock/ti,sci-clk.yaml | 52 +++++++++++++++++++ 2 files changed, 52 insertions(+), 36 deletions(-) delete mode 100644 Documentation/devicetree/bindings/clock/ti,sci-clk.txt create mode 100644 Documentation/devicetree/bindings/clock/ti,sci-clk.yaml diff --git a/Documentation/devicetree/bindings/clock/ti,sci-clk.txt b/Documentation/devicetree/bindings/clock/ti,sci-clk.txt deleted file mode 100644 index 4e59dc6b1778..000000000000 --- a/Documentation/devicetree/bindings/clock/ti,sci-clk.txt +++ /dev/null @@ -1,36 +0,0 @@ -Texas Instruments TI-SCI Clocks -=============================== - -All clocks on Texas Instruments' SoCs that contain a System Controller, -are only controlled by this entity. Communication between a host processor -running an OS and the System Controller happens through a protocol known -as TI-SCI[1]. This clock implementation plugs into the common clock -framework and makes use of the TI-SCI protocol on clock API requests. - -[1] Documentation/devicetree/bindings/arm/keystone/ti,sci.txt - -Required properties: -------------------- -- compatible: Must be "ti,k2g-sci-clk" -- #clock-cells: Shall be 2. - In clock consumers, this cell represents the device ID and clock ID - exposed by the PM firmware. The list of valid values for the device IDs - and clocks IDs for 66AK2G SoC are documented at - http://processors.wiki.ti.com/index.php/TISCI#66AK2G02_Data - -Examples: --------- - -pmmc: pmmc { - compatible = "ti,k2g-sci"; - - k2g_clks: clocks { - compatible = "ti,k2g-sci-clk"; - #clock-cells = <2>; - }; -}; - -uart0: serial@2530c00 { - compatible = "ns16550a"; - clocks = <&k2g_clks 0x2c 0>; -}; diff --git a/Documentation/devicetree/bindings/clock/ti,sci-clk.yaml b/Documentation/devicetree/bindings/clock/ti,sci-clk.yaml new file mode 100644 index 000000000000..72633651f0c7 --- /dev/null +++ b/Documentation/devicetree/bindings/clock/ti,sci-clk.yaml @@ -0,0 +1,52 @@ +# SPDX-License-Identifier: (GPL-2.0-only or BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/clock/ti,sci-clk.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: TI-SCI clock controller node bindings + +maintainers: + - Nishanth Menon <nm@ti.com> + +allOf: + - $ref: /schemas/clock/clock.yaml# + +description: | + Some TI SoCs contain a system controller (like the Power Management Micro + Controller (PMMC) on Keystone 66AK2G SoC) that are responsible for controlling + the state of the various hardware modules present on the SoC. Communication + between the host processor running an OS and the system controller happens + through a protocol called TI System Control Interface (TI-SCI protocol). + + This clock controller node uses the TI SCI protocol to perform various clock + management of various hardware modules (devices) present on the SoC. This + node must be a child node of the associated TI-SCI system controller node. + +properties: + $nodename: + pattern: "^clock-controller$" + + compatible: + const: ti,k2g-sci-clk + + "#clock-cells": + const: 2 + description: + The two cells represent values that the TI-SCI controller defines. + + The first cell should contain the device ID. + + The second cell should contain the clock ID. + + Please see http://processors.wiki.ti.com/index.php/TISCI for + protocol documentation for the values to be used for different devices. + +additionalProperties: false + +examples: + - | + k3_clks: clock-controller { + compatible = "ti,k2g-sci-clk"; + #clock-cells = <2>; + }; -- 2.31.0
WARNING: multiple messages have this Message-ID (diff)
From: Nishanth Menon <nm@ti.com> To: Philipp Zabel <p.zabel@pengutronix.de>, Stephen Boyd <sboyd@kernel.org>, Michael Turquette <mturquette@baylibre.com>, Rob Herring <robh+dt@kernel.org>, Santosh Shilimkar <ssantosh@kernel.org>, Tero Kristo <kristo@kernel.org>, Nishanth Menon <nm@ti.com> Cc: <linux-clk@vger.kernel.org>, <linux-kernel@vger.kernel.org>, <devicetree@vger.kernel.org>, <linux-arm-kernel@lists.infradead.org> Subject: [PATCH 2/4] dt-bindings: clock: Convert ti,sci-clk to json schema Date: Fri, 16 Apr 2021 01:37:19 -0500 [thread overview] Message-ID: <20210416063721.20538-3-nm@ti.com> (raw) In-Reply-To: <20210416063721.20538-1-nm@ti.com> Convert the ti,sci-clk to json schema for better checks and documentation. Differences being: - Drop consumer example as they are documented in the corresponding bindings themselves. - Standardize the node name as clock-controller rather than clocks as it is more appropriate. - Drop phandle description for clock-cells as it is redundant. NOTE: we do have false positive checkpatch warning with this patch: "DT binding docs and includes should be a separate patch" Signed-off-by: Nishanth Menon <nm@ti.com> --- .../devicetree/bindings/clock/ti,sci-clk.txt | 36 ------------- .../devicetree/bindings/clock/ti,sci-clk.yaml | 52 +++++++++++++++++++ 2 files changed, 52 insertions(+), 36 deletions(-) delete mode 100644 Documentation/devicetree/bindings/clock/ti,sci-clk.txt create mode 100644 Documentation/devicetree/bindings/clock/ti,sci-clk.yaml diff --git a/Documentation/devicetree/bindings/clock/ti,sci-clk.txt b/Documentation/devicetree/bindings/clock/ti,sci-clk.txt deleted file mode 100644 index 4e59dc6b1778..000000000000 --- a/Documentation/devicetree/bindings/clock/ti,sci-clk.txt +++ /dev/null @@ -1,36 +0,0 @@ -Texas Instruments TI-SCI Clocks -=============================== - -All clocks on Texas Instruments' SoCs that contain a System Controller, -are only controlled by this entity. Communication between a host processor -running an OS and the System Controller happens through a protocol known -as TI-SCI[1]. This clock implementation plugs into the common clock -framework and makes use of the TI-SCI protocol on clock API requests. - -[1] Documentation/devicetree/bindings/arm/keystone/ti,sci.txt - -Required properties: -------------------- -- compatible: Must be "ti,k2g-sci-clk" -- #clock-cells: Shall be 2. - In clock consumers, this cell represents the device ID and clock ID - exposed by the PM firmware. The list of valid values for the device IDs - and clocks IDs for 66AK2G SoC are documented at - http://processors.wiki.ti.com/index.php/TISCI#66AK2G02_Data - -Examples: --------- - -pmmc: pmmc { - compatible = "ti,k2g-sci"; - - k2g_clks: clocks { - compatible = "ti,k2g-sci-clk"; - #clock-cells = <2>; - }; -}; - -uart0: serial@2530c00 { - compatible = "ns16550a"; - clocks = <&k2g_clks 0x2c 0>; -}; diff --git a/Documentation/devicetree/bindings/clock/ti,sci-clk.yaml b/Documentation/devicetree/bindings/clock/ti,sci-clk.yaml new file mode 100644 index 000000000000..72633651f0c7 --- /dev/null +++ b/Documentation/devicetree/bindings/clock/ti,sci-clk.yaml @@ -0,0 +1,52 @@ +# SPDX-License-Identifier: (GPL-2.0-only or BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/clock/ti,sci-clk.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: TI-SCI clock controller node bindings + +maintainers: + - Nishanth Menon <nm@ti.com> + +allOf: + - $ref: /schemas/clock/clock.yaml# + +description: | + Some TI SoCs contain a system controller (like the Power Management Micro + Controller (PMMC) on Keystone 66AK2G SoC) that are responsible for controlling + the state of the various hardware modules present on the SoC. Communication + between the host processor running an OS and the system controller happens + through a protocol called TI System Control Interface (TI-SCI protocol). + + This clock controller node uses the TI SCI protocol to perform various clock + management of various hardware modules (devices) present on the SoC. This + node must be a child node of the associated TI-SCI system controller node. + +properties: + $nodename: + pattern: "^clock-controller$" + + compatible: + const: ti,k2g-sci-clk + + "#clock-cells": + const: 2 + description: + The two cells represent values that the TI-SCI controller defines. + + The first cell should contain the device ID. + + The second cell should contain the clock ID. + + Please see http://processors.wiki.ti.com/index.php/TISCI for + protocol documentation for the values to be used for different devices. + +additionalProperties: false + +examples: + - | + k3_clks: clock-controller { + compatible = "ti,k2g-sci-clk"; + #clock-cells = <2>; + }; -- 2.31.0 _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
next prev parent reply other threads:[~2021-04-16 6:37 UTC|newest] Thread overview: 34+ messages / expand[flat|nested] mbox.gz Atom feed top 2021-04-16 6:37 [PATCH 0/4] dt-bindings: soc/arm: Convert pending ti,sci* bindings to json format Nishanth Menon 2021-04-16 6:37 ` [PATCH 0/4] dt-bindings: soc/arm: Convert pending ti, sci* " Nishanth Menon 2021-04-16 6:37 ` [PATCH 1/4] dt-bindings: reset: Convert ti,sci-reset to json schema Nishanth Menon 2021-04-16 6:37 ` Nishanth Menon 2021-04-21 22:32 ` Rob Herring 2021-04-21 22:32 ` Rob Herring 2021-04-16 6:37 ` Nishanth Menon [this message] 2021-04-16 6:37 ` [PATCH 2/4] dt-bindings: clock: Convert ti,sci-clk " Nishanth Menon 2021-04-16 23:55 ` Stephen Boyd 2021-04-16 23:55 ` [PATCH 2/4] dt-bindings: clock: Convert ti, sci-clk " Stephen Boyd 2021-04-17 12:51 ` [PATCH 2/4] dt-bindings: clock: Convert ti,sci-clk " Nishanth Menon 2021-04-17 12:51 ` [PATCH 2/4] dt-bindings: clock: Convert ti, sci-clk " Nishanth Menon 2021-04-19 13:35 ` [PATCH 2/4] dt-bindings: clock: Convert ti,sci-clk " Nishanth Menon 2021-04-19 13:35 ` [PATCH 2/4] dt-bindings: clock: Convert ti, sci-clk " Nishanth Menon 2021-04-21 22:31 ` [PATCH 2/4] dt-bindings: clock: Convert ti,sci-clk " Rob Herring 2021-04-21 22:31 ` [PATCH 2/4] dt-bindings: clock: Convert ti, sci-clk " Rob Herring 2021-04-22 14:09 ` [PATCH 2/4] dt-bindings: clock: Convert ti,sci-clk " Nishanth Menon 2021-04-22 14:09 ` [PATCH 2/4] dt-bindings: clock: Convert ti, sci-clk " Nishanth Menon 2021-04-16 6:37 ` [PATCH 3/4] dt-bindings: soc: ti: Convert ti,sci-pm-domain " Nishanth Menon 2021-04-16 6:37 ` [PATCH 3/4] dt-bindings: soc: ti: Convert ti, sci-pm-domain " Nishanth Menon 2021-04-21 22:36 ` Rob Herring 2021-04-21 22:36 ` Rob Herring 2021-04-16 6:37 ` [PATCH 4/4] dt-bindings: arm: keystone: Convert ti,sci " Nishanth Menon 2021-04-16 6:37 ` [PATCH 4/4] dt-bindings: arm: keystone: Convert ti, sci " Nishanth Menon 2021-04-21 22:40 ` [PATCH 4/4] dt-bindings: arm: keystone: Convert ti,sci " Rob Herring 2021-04-21 22:40 ` Rob Herring 2021-04-22 14:17 ` Nishanth Menon 2021-04-22 14:17 ` Nishanth Menon 2021-04-22 16:12 ` Rob Herring 2021-04-22 16:12 ` [PATCH 4/4] dt-bindings: arm: keystone: Convert ti, sci " Rob Herring 2021-04-16 10:37 ` [PATCH 0/4] dt-bindings: soc/arm: Convert pending ti,sci* bindings to json format Tero Kristo 2021-04-16 10:37 ` Tero Kristo 2021-04-21 22:12 ` Rob Herring 2021-04-21 22:12 ` Rob Herring
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=20210416063721.20538-3-nm@ti.com \ --to=nm@ti.com \ --cc=devicetree@vger.kernel.org \ --cc=kristo@kernel.org \ --cc=linux-arm-kernel@lists.infradead.org \ --cc=linux-clk@vger.kernel.org \ --cc=linux-kernel@vger.kernel.org \ --cc=mturquette@baylibre.com \ --cc=p.zabel@pengutronix.de \ --cc=robh+dt@kernel.org \ --cc=sboyd@kernel.org \ --cc=ssantosh@kernel.org \ /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: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.