xref: /freebsd/sys/contrib/device-tree/Bindings/power/apple,pmgr-pwrstate.yaml (revision 02e9120893770924227138ba49df1edb3896112a)
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,t8103-pmgr-pwrstate
35          - apple,t8112-pmgr-pwrstate
36          - apple,t6000-pmgr-pwrstate
37      - const: apple,pmgr-pwrstate
38
39  reg:
40    maxItems: 1
41
42  "#power-domain-cells":
43    const: 0
44
45  "#reset-cells":
46    const: 0
47
48  power-domains:
49    description:
50      Reference to parent power domains. A domain may have multiple parents,
51      and all will be powered up when it is powered.
52    minItems: 1
53    maxItems: 8 # Arbitrary, should be enough
54
55  label:
56    description:
57      Specifies the name of the SoC domain being controlled. This is used to
58      name the power/reset domains.
59
60  apple,always-on:
61    description:
62      Forces this power domain to always be powered up.
63    type: boolean
64
65  apple,min-state:
66    description:
67      Specifies the minimum power state for auto-PM.
68      0 = power gated, 4 = clock gated, 15 = on.
69    $ref: /schemas/types.yaml#/definitions/uint32
70    minimum: 0
71    maximum: 15
72
73required:
74  - compatible
75  - reg
76  - "#power-domain-cells"
77  - "#reset-cells"
78  - label
79
80additionalProperties: false
81