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