xref: /linux/Documentation/devicetree/bindings/power/domain-idle-state.yaml (revision a460513ed4b6994bfeb7bd86f72853140bc1ac12) 
1# SPDX-License-Identifier: GPL-2.0
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/power/domain-idle-state.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: PM Domain Idle States binding description
8
9maintainers:
10  - Ulf Hansson <ulf.hansson@linaro.org>
11
12description:
13  A domain idle state node represents the state parameters that will be used to
14  select the state when there are no active components in the PM domain.
15
16properties:
17  $nodename:
18    const: domain-idle-states
19
20patternProperties:
21  "^(cpu|cluster|domain)-":
22    type: object
23    description:
24      Each state node represents a domain idle state description.
25
26    properties:
27      compatible:
28        const: domain-idle-state
29
30      entry-latency-us:
31        description:
32          The worst case latency in microseconds required to enter the idle
33          state. Note that, the exit-latency-us duration may be guaranteed only
34          after the entry-latency-us has passed.
35
36      exit-latency-us:
37        description:
38          The worst case latency in microseconds required to exit the idle
39          state.
40
41      min-residency-us:
42        description:
43          The minimum residency duration in microseconds after which the idle
44          state will yield power benefits, after overcoming the overhead while
45          entering the idle state.
46
47    required:
48      - compatible
49      - entry-latency-us
50      - exit-latency-us
51      - min-residency-us
52
53additionalProperties: false
54
55examples:
56  - |
57
58    domain-idle-states {
59      domain_retention: domain-retention {
60        compatible = "domain-idle-state";
61        entry-latency-us = <20>;
62        exit-latency-us = <40>;
63        min-residency-us = <80>;
64      };
65    };
66...
67