bindings/opp/opp-v2-base.yaml

1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
3 ---
4 $id: http://devicetree.org/schemas/opp/opp-v2-base.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
10   - Viresh Kumar <viresh.kumar@linaro.org>
13   Devices work at voltage-current-frequency combinations and some implementations
15   Performance Points aka OPPs. This document defines bindings for these OPPs
19   This describes the OPPs belonging to a device.
25     pattern: '^opp-table(-[a-z0-9]+)?$'
27   opp-shared:
36   '^opp(-?[0-9]+)*$':
39       One or more OPP nodes describing voltage-current-frequency combinations.
42       present only to indicate dependency between devices using the opp-shared
46       opp-hz:
48           Frequency in Hz, expressed as a 64-bit big-endian integer. This is a
49           required property for all device nodes, unless another "required"
63       opp-microvolt:
85       opp-microamp:
92           Should only be set if opp-microvolt or opp-microvolt-<name> is set for
96           separated by angular brackets <>. If current values aren't required
98           aren't required for any of the regulators, then this field is not
99           required. The OPP binding doesn't provide any provisions to relate the
106       opp-microwatt:
108           The power for the OPP in micro-Watts.
111           separated by angular brackets <>. If power values aren't required
113           aren't required for any of the regulators, then this field is not
114           required. The OPP binding doesn't provide any provisions to relate the
121       opp-level:
126       opp-peak-kBps:
129           32-bit big-endian integers. Each element of the array represents the
135       opp-avg-kBps:
138           of 32-bit big-endian integers. Each element of the array represents the
141           meaningful in OPP tables where opp-peak-kBps is present.
145       clock-latency-ns:
150       turbo-mode:
158       opp-suspend:
160           Marks the OPP to be used during device suspend. If multiple OPPs in
161           the table have this, the OPP with highest opp-hz will be used.
164       opp-supported-hw:
166           This property allows a platform to enable only a subset of the OPPs
171           a sub-group of hardware versions supported by the OPP. i.e. <sub-group
172           A>, <sub-group B>, etc. The OPP will be enabled if _any_ of these
173           sub-groups match the hardware's version.
175           Each sub-group is a platform defined array representing the hierarchy
180           opp-supported-hw = <X1 Y1 Z1>, <X2 Y2 Z2>, <X3 Y3 Z3>.
185           hardware's level version and a non-zero output for _all_ the levels in
186           a sub-group means the OPP is supported by hardware. A value of
187           0xFFFFFFFF for each level in the sub-group will enable the OPP for all
189         $ref: /schemas/types.yaml#/definitions/uint32-matrix
195       required-opps:
200           OPP nodes in the same OPP table. This specifies the minimum required
204         $ref: /schemas/types.yaml#/definitions/phandle-array
209       '^opp-microvolt-':
211           Named opp-microvolt property. This is exactly similar to the above
212           opp-microvolt property, but allows multiple voltage ranges to be
214           and matching opp-microvolt-<name> property will be enabled for all
215           OPPs. If the platform doesn't pick a specific <name> or the <name>
216           doesn't match with any opp-microvolt-<name> properties, then
217           opp-microvolt property shall be used, if present.
218         $ref: /schemas/types.yaml#/definitions/uint32-matrix
225       '^opp-microamp-':
227           Named opp-microamp property. Similar to opp-microvolt-<name> property,
229         $ref: /schemas/types.yaml#/definitions/uint32-array
233       '^opp-microwatt-':
235           Named opp-microwatt property. Similar to opp-microamp-<name> property,
237         $ref: /schemas/types.yaml#/definitions/uint32-array
242       opp-avg-kBps: [ opp-peak-kBps ]
244 required:
245   - compatible