xref: /linux/Documentation/devicetree/bindings/clock/ti,sci-clk.yaml (revision c771600c6af14749609b49565ffb4cac2959710d)
1440b075bSKrzysztof Kozlowski# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2a7dbfa6fSNishanth Menon%YAML 1.2
3a7dbfa6fSNishanth Menon---
4a7dbfa6fSNishanth Menon$id: http://devicetree.org/schemas/clock/ti,sci-clk.yaml#
5a7dbfa6fSNishanth Menon$schema: http://devicetree.org/meta-schemas/core.yaml#
6a7dbfa6fSNishanth Menon
79fa3ad1aSKrzysztof Kozlowskititle: TI-SCI clock controller
8a7dbfa6fSNishanth Menon
9a7dbfa6fSNishanth Menonmaintainers:
10a7dbfa6fSNishanth Menon  - Nishanth Menon <nm@ti.com>
11a7dbfa6fSNishanth Menon
12a7dbfa6fSNishanth Menondescription: |
13a7dbfa6fSNishanth Menon  Some TI SoCs contain a system controller (like the Power Management Micro
14a7dbfa6fSNishanth Menon  Controller (PMMC) on Keystone 66AK2G SoC) that are responsible for controlling
15a7dbfa6fSNishanth Menon  the state of the various hardware modules present on the SoC. Communication
16a7dbfa6fSNishanth Menon  between the host processor running an OS and the system controller happens
17a7dbfa6fSNishanth Menon  through a protocol called TI System Control Interface (TI-SCI protocol).
18a7dbfa6fSNishanth Menon
19a7dbfa6fSNishanth Menon  This clock controller node uses the TI SCI protocol to perform various clock
20a7dbfa6fSNishanth Menon  management of various hardware modules (devices) present on the SoC. This
21a7dbfa6fSNishanth Menon  node must be a child node of the associated TI-SCI system controller node.
22a7dbfa6fSNishanth Menon
23a7dbfa6fSNishanth Menonproperties:
24a7dbfa6fSNishanth Menon  $nodename:
25a7dbfa6fSNishanth Menon    pattern: "^clock-controller$"
26a7dbfa6fSNishanth Menon
27a7dbfa6fSNishanth Menon  compatible:
28a7dbfa6fSNishanth Menon    const: ti,k2g-sci-clk
29a7dbfa6fSNishanth Menon
30a7dbfa6fSNishanth Menon  "#clock-cells":
31a7dbfa6fSNishanth Menon    const: 2
32a7dbfa6fSNishanth Menon    description:
33a7dbfa6fSNishanth Menon      The two cells represent values that the TI-SCI controller defines.
34a7dbfa6fSNishanth Menon
35a7dbfa6fSNishanth Menon      The first cell should contain the device ID.
36a7dbfa6fSNishanth Menon
37a7dbfa6fSNishanth Menon      The second cell should contain the clock ID.
38a7dbfa6fSNishanth Menon
399040d64fSRichard Genoud      Please see https://software-dl.ti.com/tisci/esd/latest/index.html for
40a7dbfa6fSNishanth Menon      protocol documentation for the values to be used for different devices.
41a7dbfa6fSNishanth Menon
42a7dbfa6fSNishanth MenonadditionalProperties: false
43a7dbfa6fSNishanth Menon
44a7dbfa6fSNishanth Menonexamples:
45a7dbfa6fSNishanth Menon  - |
46a7dbfa6fSNishanth Menon    k3_clks: clock-controller {
47a7dbfa6fSNishanth Menon        compatible = "ti,k2g-sci-clk";
48a7dbfa6fSNishanth Menon        #clock-cells = <2>;
49a7dbfa6fSNishanth Menon    };
50