xref: /freebsd/sys/contrib/device-tree/Bindings/soc/ti/sci-pm-domain.yaml (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
1# SPDX-License-Identifier: (GPL-2.0-only or BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/soc/ti/sci-pm-domain.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: TI-SCI generic power domain node bindings
8
9maintainers:
10  - Nishanth Menon <nm@ti.com>
11
12allOf:
13  - $ref: /schemas/power/power-domain.yaml#
14
15description: |
16  Some TI SoCs contain a system controller (like the Power Management Micro
17  Controller (PMMC) on Keystone 66AK2G SoC) that are responsible for controlling
18  the state of the various hardware modules present on the SoC. Communication
19  between the host processor running an OS and the system controller happens
20  through a protocol called TI System Control Interface (TI-SCI protocol).
21
22  This PM domain node represents the global PM domain managed by the TI-SCI
23  controller. Since this relies on the TI SCI protocol to communicate with
24  the TI-SCI controller, it must be a child of the TI-SCI controller node.
25
26properties:
27  compatible:
28    const: ti,sci-pm-domain
29
30  "#power-domain-cells":
31    enum: [1, 2]
32    description:
33      The two cells represent values that the TI-SCI controller defines.
34
35      The first cell should contain the device ID.
36
37      The second cell, if cell-value is 2, should be one of the following
38      TI_SCI_PD_EXCLUSIVE - Allows the device to be exclusively controlled
39      or
40      TI_SCI_PD_SHARED - Allows the device to be shared by multiple hosts.
41      Please refer to dt-bindings/soc/ti,sci_pm_domain.h for the definitions.
42
43      Please see  http://processors.wiki.ti.com/index.php/TISCI for
44      protocol documentation for the values to be used for different devices.
45
46additionalProperties: false
47
48examples:
49  - |
50    k2g_pds: power-controller {
51        compatible = "ti,sci-pm-domain";
52        #power-domain-cells = <1>;
53    };
54
55  - |
56    k3_pds: power-controller {
57        compatible = "ti,sci-pm-domain";
58        #power-domain-cells = <2>;
59    };
60