summaryrefslogtreecommitdiff
path: root/Documentation/devicetree/bindings/clock/samsung,exynos7870-cmu.yaml
blob: 3c58712f12b9fe33890687fb0a70dc1b8015b78b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/clock/samsung,exynos7870-cmu.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Samsung Exynos7870 SoC clock controller

maintainers:
  - Kaustabh Chakraborty <kauschluss@disroot.org>

description: |
  Exynos7870 clock controller is comprised of several CMU units, generating
  clocks for different domains. Those CMU units are modeled as separate device
  tree nodes, and might depend on each other. The root clock in that root tree
  is an external clock: OSCCLK (26 MHz). This external clock must be defined
  as a fixed-rate clock in dts.

  Each clock is assigned an identifier and client nodes can use this identifier
  to specify the clock which they consume. All clocks available for usage
  in clock consumer nodes are defined as preprocessor macros in
  include/dt-bindings/clock/samsung,exynos7870-cmu.h header.

properties:
  compatible:
    enum:
      - samsung,exynos7870-cmu-mif
      - samsung,exynos7870-cmu-dispaud
      - samsung,exynos7870-cmu-fsys
      - samsung,exynos7870-cmu-g3d
      - samsung,exynos7870-cmu-isp
      - samsung,exynos7870-cmu-mfcmscl
      - samsung,exynos7870-cmu-peri

  clocks:
    minItems: 1
    maxItems: 10

  clock-names:
    minItems: 1
    maxItems: 10

  "#clock-cells":
    const: 1

  reg:
    maxItems: 1

required:
  - compatible
  - clocks
  - clock-names
  - "#clock-cells"
  - reg

allOf:
  - if:
      properties:
        compatible:
          contains:
            const: samsung,exynos7870-cmu-mif
    then:
      properties:
        clocks:
          items:
            - description: External reference clock (26 MHz)

        clock-names:
          items:
            - const: oscclk

  - if:
      properties:
        compatible:
          contains:
            const: samsung,exynos7870-cmu-dispaud
    then:
      properties:
        clocks:
          items:
            - description: External reference clock (26 MHz)
            - description: CMU_DISPAUD bus clock (from CMU_MIF)
            - description: DECON external clock (from CMU_MIF)
            - description: DECON vertical clock (from CMU_MIF)

        clock-names:
          items:
            - const: oscclk
            - const: bus
            - const: decon_eclk
            - const: decon_vclk

  - if:
      properties:
        compatible:
          contains:
            const: samsung,exynos7870-cmu-fsys
    then:
      properties:
        clocks:
          items:
            - description: External reference clock (26 MHz)
            - description: CMU_FSYS bus clock (from CMU_MIF)
            - description: USB20DRD clock (from CMU_MIF)

        clock-names:
          items:
            - const: oscclk
            - const: bus
            - const: usb20drd

  - if:
      properties:
        compatible:
          contains:
            const: samsung,exynos7870-cmu-g3d
    then:
      properties:
        clocks:
          items:
            - description: External reference clock (26 MHz)
            - description: G3D switch clock (from CMU_MIF)

        clock-names:
          items:
            - const: oscclk
            - const: switch

  - if:
      properties:
        compatible:
          contains:
            const: samsung,exynos7870-cmu-isp
    then:
      properties:
        clocks:
          items:
            - description: External reference clock (26 MHz)
            - description: ISP camera clock (from CMU_MIF)
            - description: ISP clock (from CMU_MIF)
            - description: ISP VRA clock (from CMU_MIF)

        clock-names:
          items:
            - const: oscclk
            - const: cam
            - const: isp
            - const: vra

  - if:
      properties:
        compatible:
          contains:
            const: samsung,exynos7870-cmu-mfcmscl
    then:
      properties:
        clocks:
          items:
            - description: External reference clock (26 MHz)
            - description: MSCL clock (from CMU_MIF)
            - description: MFC clock (from CMU_MIF)

        clock-names:
          items:
            - const: oscclk
            - const: mfc
            - const: mscl

  - if:
      properties:
        compatible:
          contains:
            const: samsung,exynos7870-cmu-peri
    then:
      properties:
        clocks:
          items:
            - description: External reference clock (26 MHz)
            - description: CMU_PERI bus clock (from CMU_MIF)
            - description: SPI0 clock (from CMU_MIF)
            - description: SPI1 clock (from CMU_MIF)
            - description: SPI2 clock (from CMU_MIF)
            - description: SPI3 clock (from CMU_MIF)
            - description: SPI4 clock (from CMU_MIF)
            - description: UART0 clock (from CMU_MIF)
            - description: UART1 clock (from CMU_MIF)
            - description: UART2 clock (from CMU_MIF)

        clock-names:
          items:
            - const: oscclk
            - const: bus
            - const: spi0
            - const: spi1
            - const: spi2
            - const: spi3
            - const: spi4
            - const: uart0
            - const: uart1
            - const: uart2

additionalProperties: false

examples:
  - |
    #include <dt-bindings/clock/samsung,exynos7870-cmu.h>

    cmu_peri: clock-controller@101f0000 {
      compatible = "samsung,exynos7870-cmu-peri";
      reg = <0x101f0000 0x1000>;
      #clock-cells = <1>;

      clock-names = "oscclk", "bus", "spi0", "spi1", "spi2",
                    "spi3", "spi4", "uart0", "uart1", "uart2";
      clocks = <&oscclk>,
               <&cmu_mif CLK_GOUT_MIF_CMU_PERI_BUS>,
               <&cmu_mif CLK_GOUT_MIF_CMU_PERI_SPI0>,
               <&cmu_mif CLK_GOUT_MIF_CMU_PERI_SPI1>,
               <&cmu_mif CLK_GOUT_MIF_CMU_PERI_SPI2>,
               <&cmu_mif CLK_GOUT_MIF_CMU_PERI_SPI3>,
               <&cmu_mif CLK_GOUT_MIF_CMU_PERI_SPI4>,
               <&cmu_mif CLK_GOUT_MIF_CMU_PERI_UART0>,
               <&cmu_mif CLK_GOUT_MIF_CMU_PERI_UART1>,
               <&cmu_mif CLK_GOUT_MIF_CMU_PERI_UART2>;
    };

...