xref: /linux/Documentation/devicetree/bindings/clock/ti/ti,autoidle.yaml (revision 8d2b0853add1d7534dc0794e3c8e0b9e8c4ec640)
1*5ffe2d2fSSukrut Bellary# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2*5ffe2d2fSSukrut Bellary%YAML 1.2
3*5ffe2d2fSSukrut Bellary---
4*5ffe2d2fSSukrut Bellary$id: http://devicetree.org/schemas/clock/ti/ti,autoidle.yaml#
5*5ffe2d2fSSukrut Bellary$schema: http://devicetree.org/meta-schemas/core.yaml#
6*5ffe2d2fSSukrut Bellary
7*5ffe2d2fSSukrut Bellarytitle: TI autoidle clock
8*5ffe2d2fSSukrut Bellary
9*5ffe2d2fSSukrut Bellarymaintainers:
10*5ffe2d2fSSukrut Bellary  - Tero Kristo <kristo@kernel.org>
11*5ffe2d2fSSukrut Bellary  - Sukrut Bellary <sbellary@baylibre.com>
12*5ffe2d2fSSukrut Bellary
13*5ffe2d2fSSukrut Bellarydescription:
14*5ffe2d2fSSukrut Bellary  Some clocks in TI SoC support the autoidle feature. These properties are
15*5ffe2d2fSSukrut Bellary  applicable only if the clock supports autoidle feature. It assumes a register
16*5ffe2d2fSSukrut Bellary  mapped clock which can be put to idle automatically by hardware based on
17*5ffe2d2fSSukrut Bellary  usage and configuration bit setting. Autoidle clock is never an individual
18*5ffe2d2fSSukrut Bellary  clock, it is always a derivative of some basic clock like a gate, divider, or
19*5ffe2d2fSSukrut Bellary  fixed-factor.
20*5ffe2d2fSSukrut Bellary
21*5ffe2d2fSSukrut Bellaryproperties:
22*5ffe2d2fSSukrut Bellary  ti,autoidle-shift:
23*5ffe2d2fSSukrut Bellary    $ref: /schemas/types.yaml#/definitions/uint32
24*5ffe2d2fSSukrut Bellary    description:
25*5ffe2d2fSSukrut Bellary      bit shift of the autoidle enable bit for the clock
26*5ffe2d2fSSukrut Bellary    maximum: 31
27*5ffe2d2fSSukrut Bellary    default: 0
28*5ffe2d2fSSukrut Bellary
29*5ffe2d2fSSukrut Bellary  ti,invert-autoidle-bit:
30*5ffe2d2fSSukrut Bellary    type: boolean
31*5ffe2d2fSSukrut Bellary    description:
32*5ffe2d2fSSukrut Bellary      autoidle is enabled by setting the bit to 0
33*5ffe2d2fSSukrut Bellary
34*5ffe2d2fSSukrut BellaryadditionalProperties: true
35