xref: /linux/Documentation/devicetree/bindings/clock/samsung,exynosautov920-clock.yaml (revision 93b41cdc21f3c33607c62b80adbe39c747e7022f) 
1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/clock/samsung,exynosautov920-clock.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Samsung ExynosAuto v920 SoC clock controller
8
9maintainers:
10  - Sunyeal Hong <sunyeal.hong@samsung.com>
11  - Chanwoo Choi <cw00.choi@samsung.com>
12  - Krzysztof Kozlowski <krzk@kernel.org>
13  - Sylwester Nawrocki <s.nawrocki@samsung.com>
14
15description: |
16  ExynosAuto v920 clock controller is comprised of several CMU units, generating
17  clocks for different domains. Those CMU units are modeled as separate device
18  tree nodes, and might depend on each other. Root clocks in that clock tree are
19  two external clocks:: OSCCLK/XTCXO (38.4 MHz) and RTCCLK/XrtcXTI (32768 Hz).
20  The external OSCCLK must be defined as fixed-rate clock in dts.
21
22  CMU_TOP is a top-level CMU, where all base clocks are prepared using PLLs and
23  dividers; all other clocks of function blocks (other CMUs) are usually
24  derived from CMU_TOP.
25
26  Each clock is assigned an identifier and client nodes can use this identifier
27  to specify the clock which they consume. All clocks available for usage
28  in clock consumer nodes are defined as preprocessor macros in
29  'include/dt-bindings/clock/samsung,exynosautov920.h' header.
30
31properties:
32  compatible:
33    enum:
34      - samsung,exynosautov920-cmu-top
35      - samsung,exynosautov920-cmu-peric0
36      - samsung,exynosautov920-cmu-peric1
37      - samsung,exynosautov920-cmu-misc
38      - samsung,exynosautov920-cmu-hsi0
39      - samsung,exynosautov920-cmu-hsi1
40
41  clocks:
42    minItems: 1
43    maxItems: 4
44
45  clock-names:
46    minItems: 1
47    maxItems: 4
48
49  "#clock-cells":
50    const: 1
51
52  reg:
53    maxItems: 1
54
55allOf:
56  - if:
57      properties:
58        compatible:
59          contains:
60            const: samsung,exynosautov920-cmu-top
61
62    then:
63      properties:
64        clocks:
65          items:
66            - description: External reference clock (38.4 MHz)
67
68        clock-names:
69          items:
70            - const: oscclk
71
72  - if:
73      properties:
74        compatible:
75          contains:
76            enum:
77              - samsung,exynosautov920-cmu-peric0
78              - samsung,exynosautov920-cmu-peric1
79
80    then:
81      properties:
82        clocks:
83          items:
84            - description: External reference clock (38.4 MHz)
85            - description: CMU_PERICn NOC clock (from CMU_TOP)
86            - description: CMU_PERICn IP clock (from CMU_TOP)
87
88        clock-names:
89          items:
90            - const: oscclk
91            - const: noc
92            - const: ip
93
94  - if:
95      properties:
96        compatible:
97          enum:
98            - samsung,exynosautov920-cmu-misc
99            - samsung,exynosautov920-cmu-hsi0
100
101    then:
102      properties:
103        clocks:
104          items:
105            - description: External reference clock (38.4 MHz)
106            - description: CMU_MISC/CMU_HSI0 NOC clock (from CMU_TOP)
107
108        clock-names:
109          items:
110            - const: oscclk
111            - const: noc
112
113  - if:
114      properties:
115        compatible:
116          contains:
117            const: samsung,exynosautov920-cmu-hsi1
118
119    then:
120      properties:
121        clocks:
122          items:
123            - description: External reference clock (38.4 MHz)
124            - description: CMU_HSI1 NOC clock (from CMU_TOP)
125            - description: CMU_HSI1 USBDRD clock (from CMU_TOP)
126            - description: CMU_HSI1 MMC_CARD clock (from CMU_TOP)
127
128        clock-names:
129          items:
130            - const: oscclk
131            - const: noc
132            - const: usbdrd
133            - const: mmc_card
134
135required:
136  - compatible
137  - "#clock-cells"
138  - clocks
139  - clock-names
140  - reg
141
142additionalProperties: false
143
144examples:
145  # Clock controller node for CMU_PERIC0
146  - |
147    #include <dt-bindings/clock/samsung,exynosautov920.h>
148
149    cmu_peric0: clock-controller@10800000 {
150        compatible = "samsung,exynosautov920-cmu-peric0";
151        reg = <0x10800000 0x8000>;
152        #clock-cells = <1>;
153
154        clocks = <&xtcxo>,
155                 <&cmu_top DOUT_CLKCMU_PERIC0_NOC>,
156                 <&cmu_top DOUT_CLKCMU_PERIC0_IP>;
157        clock-names = "oscclk",
158                      "noc",
159                      "ip";
160    };
161
162...
163