xref: /linux/Documentation/devicetree/bindings/power/apple,pmgr-pwrstate.yaml (revision 7a012a692e7cfbca245d195a80f23634d3d74fcc) 
1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/power/apple,pmgr-pwrstate.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Apple SoC PMGR Power States
8
9maintainers:
10  - Hector Martin <marcan@marcan.st>
11
12allOf:
13  - $ref: power-domain.yaml#
14
15description: |
16  Apple SoCs include PMGR blocks responsible for power management,
17  which can control various clocks, resets, power states, and
18  performance features. This binding describes the device power
19  state registers, which control power states and resets.
20
21  Each instance of a power controller within the PMGR syscon node
22  represents a generic power domain provider, as documented in
23  Documentation/devicetree/bindings/power/power-domain.yaml.
24  The provider controls a single SoC block. The power hierarchy is
25  represented via power-domains relationships between these nodes.
26
27  See Documentation/devicetree/bindings/arm/apple/apple,pmgr.yaml
28  for the top-level PMGR node documentation.
29
30properties:
31  compatible:
32    items:
33      - enum:
34          - apple,s5l8960x-pmgr-pwrstate
35          - apple,t7000-pmgr-pwrstate
36          - apple,s8000-pmgr-pwrstate
37          - apple,t8010-pmgr-pwrstate
38          - apple,t8015-pmgr-pwrstate
39          - apple,t8103-pmgr-pwrstate
40          - apple,t8112-pmgr-pwrstate
41          - apple,t6000-pmgr-pwrstate
42      - const: apple,pmgr-pwrstate
43
44  reg:
45    maxItems: 1
46
47  "#power-domain-cells":
48    const: 0
49
50  "#reset-cells":
51    const: 0
52
53  power-domains:
54    description:
55      Reference to parent power domains. A domain may have multiple parents,
56      and all will be powered up when it is powered.
57    minItems: 1
58    maxItems: 8 # Arbitrary, should be enough
59
60  label:
61    description:
62      Specifies the name of the SoC domain being controlled. This is used to
63      name the power/reset domains.
64
65  apple,always-on:
66    description:
67      Forces this power domain to always be powered up.
68    type: boolean
69
70  apple,min-state:
71    description:
72      Specifies the minimum power state for auto-PM.
73      0 = power gated, 4 = clock gated, 15 = on.
74    $ref: /schemas/types.yaml#/definitions/uint32
75    minimum: 0
76    maximum: 15
77
78required:
79  - compatible
80  - reg
81  - "#power-domain-cells"
82  - "#reset-cells"
83  - label
84
85additionalProperties: false
86