xref: /freebsd/sys/contrib/device-tree/Bindings/reset/ti,sci-reset.txt (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
1Texas Instruments System Control Interface (TI-SCI) Reset Controller
2=====================================================================
3
4Some TI SoCs contain a system controller (like the Power Management Micro
5Controller (PMMC) on Keystone 66AK2G SoC) that are responsible for controlling
6the state of the various hardware modules present on the SoC. Communication
7between the host processor running an OS and the system controller happens
8through a protocol called TI System Control Interface (TI-SCI protocol).
9For TI SCI details, please refer to the document,
10Documentation/devicetree/bindings/arm/keystone/ti,sci.txt
11
12TI-SCI Reset Controller Node
13============================
14This reset controller node uses the TI SCI protocol to perform the reset
15management of various hardware modules present on the SoC. Must be a child
16node of the associated TI-SCI system controller node.
17
18Required properties:
19--------------------
20 - compatible	: Should be "ti,sci-reset"
21 - #reset-cells	: Should be 2. Please see the reset consumer node below for
22		  usage details.
23
24TI-SCI Reset Consumer Nodes
25===========================
26Each of the reset consumer nodes should have the following properties,
27in addition to their own properties.
28
29Required properties:
30--------------------
31 - resets	: A phandle and reset specifier pair, one pair for each reset
32		  signal that affects the device, or that the device manages.
33		  The phandle should point to the TI-SCI reset controller node,
34		  and the reset specifier should have 2 cell-values. The first
35		  cell should contain the device ID. The second cell should
36		  contain the reset mask value used by system controller.
37		  Please refer to the protocol documentation for these values
38		  to be used for different devices,
39		  http://processors.wiki.ti.com/index.php/TISCI#66AK2G02_Data
40
41Please also refer to Documentation/devicetree/bindings/reset/reset.txt for
42common reset controller usage by consumers.
43
44Example:
45--------
46The following example demonstrates both a TI-SCI reset controller node and a
47consumer (a DSP device) on the 66AK2G SoC.
48
49pmmc: pmmc {
50	compatible = "ti,k2g-sci";
51
52	k2g_reset: reset-controller {
53		compatible = "ti,sci-reset";
54		#reset-cells = <2>;
55	};
56};
57
58dsp0: dsp@10800000 {
59	...
60	resets = <&k2g_reset 0x0046 0x1>;
61	...
62};
63