xref: /linux/Documentation/devicetree/bindings/clock/ti/ti,interface-clock.yaml (revision 7f71507851fc7764b36a3221839607d3a45c2025) 
1# SPDX-License-Identifier: GPL-2.0-only
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/clock/ti/ti,interface-clock.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Texas Instruments interface clock.
8
9maintainers:
10  - Tero Kristo <kristo@kernel.org>
11
12description: |
13  This clock is quite much similar to the basic gate-clock[1], however,
14  it supports a number of additional features, including
15  companion clock finding (match corresponding functional gate
16  clock) and hardware autoidle enable / disable.
17
18  [1] Documentation/devicetree/bindings/clock/gpio-gate-clock.yaml
19
20properties:
21  compatible:
22    enum:
23      - ti,omap3-interface-clock           # basic OMAP3 interface clock
24      - ti,omap3-no-wait-interface-clock   # interface clock which has no hardware
25                                           # capability for waiting clock to be ready
26      - ti,omap3-hsotgusb-interface-clock  # interface clock with USB specific HW handling
27      - ti,omap3-dss-interface-clock       # interface clock with DSS specific HW handling
28      - ti,omap3-ssi-interface-clock       # interface clock with SSI specific HW handling
29      - ti,am35xx-interface-clock          # interface clock with AM35xx specific HW handling
30      - ti,omap2430-interface-clock        # interface clock with OMAP2430 specific HW handling
31
32  "#clock-cells":
33    const: 0
34
35  clocks:
36    maxItems: 1
37
38  clock-output-names:
39    maxItems: 1
40
41  reg:
42    maxItems: 1
43
44  ti,bit-shift:
45    description:
46      bit shift for the bit enabling/disabling the clock
47    $ref: /schemas/types.yaml#/definitions/uint32
48    default: 0
49    maximum: 31
50
51required:
52  - compatible
53  - clocks
54  - '#clock-cells'
55  - reg
56
57additionalProperties: false
58
59examples:
60  - |
61    bus {
62      #address-cells = <1>;
63      #size-cells = <0>;
64
65      aes1_ick: clock-controller@3 {
66        #clock-cells = <0>;
67        compatible = "ti,omap3-interface-clock";
68        clocks = <&security_l4_ick2>;
69        reg = <3>;
70      };
71    };
72