xref: /freebsd/sys/contrib/device-tree/Bindings/arm/keystone/ti,k3-sci-common.yaml (revision aa1a8ff2d6dbc51ef058f46f3db5a8bb77967145)
1*aa1a8ff2SEmmanuel Vadot# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2c66ec88fSEmmanuel Vadot%YAML 1.2
3c66ec88fSEmmanuel Vadot---
4c66ec88fSEmmanuel Vadot$id: http://devicetree.org/schemas/arm/keystone/ti,k3-sci-common.yaml#
5c66ec88fSEmmanuel Vadot$schema: http://devicetree.org/meta-schemas/core.yaml#
6c66ec88fSEmmanuel Vadot
78bab661aSEmmanuel Vadottitle: Common K3 TI-SCI
8c66ec88fSEmmanuel Vadot
9c66ec88fSEmmanuel Vadotmaintainers:
10c66ec88fSEmmanuel Vadot  - Nishanth Menon <nm@ti.com>
11c66ec88fSEmmanuel Vadot
12c66ec88fSEmmanuel Vadotdescription: |
13c66ec88fSEmmanuel Vadot  The TI K3 family of SoCs usually have a central System Controller Processor
14c66ec88fSEmmanuel Vadot  that is responsible for managing various SoC-level resources like clocks,
15c66ec88fSEmmanuel Vadot  resets, interrupts etc. The communication with that processor is performed
16c66ec88fSEmmanuel Vadot  through the TI-SCI protocol.
17c66ec88fSEmmanuel Vadot
18c66ec88fSEmmanuel Vadot  Each specific device management node like a clock controller node, a reset
19c66ec88fSEmmanuel Vadot  controller node or an interrupt-controller node should define a common set
20c66ec88fSEmmanuel Vadot  of properties that enables them to implement the corresponding functionality
21c66ec88fSEmmanuel Vadot  over the TI-SCI protocol. The following are some of the common properties
22c66ec88fSEmmanuel Vadot  needed by such individual nodes. The required properties for each device
23c66ec88fSEmmanuel Vadot  management node is defined in the respective binding.
24c66ec88fSEmmanuel Vadot
25c66ec88fSEmmanuel Vadotproperties:
26c66ec88fSEmmanuel Vadot  ti,sci:
27c66ec88fSEmmanuel Vadot    $ref: /schemas/types.yaml#/definitions/phandle
28c66ec88fSEmmanuel Vadot    description:
29c66ec88fSEmmanuel Vadot      Should be a phandle to the TI-SCI System Controller node
30c66ec88fSEmmanuel Vadot
31c66ec88fSEmmanuel Vadot  ti,sci-dev-id:
32c66ec88fSEmmanuel Vadot    $ref: /schemas/types.yaml#/definitions/uint32
33c66ec88fSEmmanuel Vadot    description: |
34c66ec88fSEmmanuel Vadot      Should contain the TI-SCI device id corresponding to the device. Please
35c66ec88fSEmmanuel Vadot      refer to the corresponding System Controller documentation for valid
36c66ec88fSEmmanuel Vadot      values for the desired device.
37c66ec88fSEmmanuel Vadot
38c66ec88fSEmmanuel Vadot  ti,sci-proc-ids:
39c66ec88fSEmmanuel Vadot    description: Should contain a single tuple of <proc_id host_id>.
40c66ec88fSEmmanuel Vadot    $ref: /schemas/types.yaml#/definitions/uint32-array
41c66ec88fSEmmanuel Vadot    items:
42c66ec88fSEmmanuel Vadot      - description: TI-SCI processor id for the remote processor device
43c66ec88fSEmmanuel Vadot      - description: TI-SCI host id to which processor control ownership
44c66ec88fSEmmanuel Vadot                     should be transferred to
456be33864SEmmanuel Vadot
466be33864SEmmanuel VadotadditionalProperties: true
47