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

Configure Feed

Select the types of activity you want to include in your feed.

dt-bindings: clock: Convert ti,sci-clk to json schema

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.

Signed-off-by: Nishanth Menon <nm@ti.com>
Reviewed-by: Tero Kristo <kristo@kernel.org>
Acked-by: Stephen Boyd <sboyd@kernel.org>
Link: https://lore.kernel.org/r/20210426155457.21221-3-nm@ti.com
Signed-off-by: Rob Herring <robh@kernel.org>

authored by

Nishanth Menon and committed by
Rob Herring a7dbfa6f 9a81b8cb

+49 -36
-36
Documentation/devicetree/bindings/clock/ti,sci-clk.txt
··· 1 - Texas Instruments TI-SCI Clocks 2 - =============================== 3 - 4 - All clocks on Texas Instruments' SoCs that contain a System Controller, 5 - are only controlled by this entity. Communication between a host processor 6 - running an OS and the System Controller happens through a protocol known 7 - as TI-SCI[1]. This clock implementation plugs into the common clock 8 - framework and makes use of the TI-SCI protocol on clock API requests. 9 - 10 - [1] Documentation/devicetree/bindings/arm/keystone/ti,sci.txt 11 - 12 - Required properties: 13 - ------------------- 14 - - compatible: Must be "ti,k2g-sci-clk" 15 - - #clock-cells: Shall be 2. 16 - In clock consumers, this cell represents the device ID and clock ID 17 - exposed by the PM firmware. The list of valid values for the device IDs 18 - and clocks IDs for 66AK2G SoC are documented at 19 - http://processors.wiki.ti.com/index.php/TISCI#66AK2G02_Data 20 - 21 - Examples: 22 - -------- 23 - 24 - pmmc: pmmc { 25 - compatible = "ti,k2g-sci"; 26 - 27 - k2g_clks: clocks { 28 - compatible = "ti,k2g-sci-clk"; 29 - #clock-cells = <2>; 30 - }; 31 - }; 32 - 33 - uart0: serial@2530c00 { 34 - compatible = "ns16550a"; 35 - clocks = <&k2g_clks 0x2c 0>; 36 - };
+49
Documentation/devicetree/bindings/clock/ti,sci-clk.yaml
··· 1 + # SPDX-License-Identifier: (GPL-2.0-only or BSD-2-Clause) 2 + %YAML 1.2 3 + --- 4 + $id: http://devicetree.org/schemas/clock/ti,sci-clk.yaml# 5 + $schema: http://devicetree.org/meta-schemas/core.yaml# 6 + 7 + title: TI-SCI clock controller node bindings 8 + 9 + maintainers: 10 + - Nishanth Menon <nm@ti.com> 11 + 12 + description: | 13 + Some TI SoCs contain a system controller (like the Power Management Micro 14 + Controller (PMMC) on Keystone 66AK2G SoC) that are responsible for controlling 15 + the state of the various hardware modules present on the SoC. Communication 16 + between the host processor running an OS and the system controller happens 17 + through a protocol called TI System Control Interface (TI-SCI protocol). 18 + 19 + This clock controller node uses the TI SCI protocol to perform various clock 20 + management of various hardware modules (devices) present on the SoC. This 21 + node must be a child node of the associated TI-SCI system controller node. 22 + 23 + properties: 24 + $nodename: 25 + pattern: "^clock-controller$" 26 + 27 + compatible: 28 + const: ti,k2g-sci-clk 29 + 30 + "#clock-cells": 31 + const: 2 32 + description: 33 + The two cells represent values that the TI-SCI controller defines. 34 + 35 + The first cell should contain the device ID. 36 + 37 + The second cell should contain the clock ID. 38 + 39 + Please see http://processors.wiki.ti.com/index.php/TISCI for 40 + protocol documentation for the values to be used for different devices. 41 + 42 + additionalProperties: false 43 + 44 + examples: 45 + - | 46 + k3_clks: clock-controller { 47 + compatible = "ti,k2g-sci-clk"; 48 + #clock-cells = <2>; 49 + };