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"
61       opp-microvolt:
83       opp-microamp:
90           Should only be set if opp-microvolt or opp-microvolt-<name> is set for
94           separated by angular brackets <>. If current values aren't required
96           aren't required for any of the regulators, then this field is not
97           required. The OPP binding doesn't provide any provisions to relate the
104       opp-microwatt:
106           The power for the OPP in micro-Watts.
109           separated by angular brackets <>. If power values aren't required
111           aren't required for any of the regulators, then this field is not
112           required. The OPP binding doesn't provide any provisions to relate the
119       opp-level:
124       opp-peak-kBps:
127           32-bit big-endian integers. Each element of the array represents the
133       opp-avg-kBps:
136           of 32-bit big-endian integers. Each element of the array represents the
139           meaningful in OPP tables where opp-peak-kBps is present.
143       clock-latency-ns:
148       turbo-mode:
156       opp-suspend:
158           Marks the OPP to be used during device suspend. If multiple OPPs in
159           the table have this, the OPP with highest opp-hz will be used.
162       opp-supported-hw:
164           This property allows a platform to enable only a subset of the OPPs
169           a sub-group of hardware versions supported by the OPP. i.e. <sub-group
170           A>, <sub-group B>, etc. The OPP will be enabled if _any_ of these
171           sub-groups match the hardware's version.
173           Each sub-group is a platform defined array representing the hierarchy
178           opp-supported-hw = <X1 Y1 Z1>, <X2 Y2 Z2>, <X3 Y3 Z3>.
183           hardware's level version and a non-zero output for _all_ the levels in
184           a sub-group means the OPP is supported by hardware. A value of
185           0xFFFFFFFF for each level in the sub-group will enable the OPP for all
187         $ref: /schemas/types.yaml#/definitions/uint32-matrix
193       required-opps:
198           OPP nodes in the same OPP table. This specifies the minimum required
202         $ref: /schemas/types.yaml#/definitions/phandle-array
207       '^opp-microvolt-':
209           Named opp-microvolt property. This is exactly similar to the above
210           opp-microvolt property, but allows multiple voltage ranges to be
212           and matching opp-microvolt-<name> property will be enabled for all
213           OPPs. If the platform doesn't pick a specific <name> or the <name>
214           doesn't match with any opp-microvolt-<name> properties, then
215           opp-microvolt property shall be used, if present.
216         $ref: /schemas/types.yaml#/definitions/uint32-matrix
223       '^opp-microamp-':
225           Named opp-microamp property. Similar to opp-microvolt-<name> property,
227         $ref: /schemas/types.yaml#/definitions/uint32-array
231       '^opp-microwatt-':
233           Named opp-microwatt property. Similar to opp-microamp-<name> property,
235         $ref: /schemas/types.yaml#/definitions/uint32-array
240       opp-avg-kBps: [ opp-peak-kBps ]
242 required:
243   - compatible