xref: /freebsd/sys/contrib/device-tree/Bindings/power/reset/xlnx,zynqmp-power.txt (revision ebacd8013fe5f7fdf9f6a5b286f6680dd2891036)
1--------------------------------------------------------------------
2Device Tree Bindings for the Xilinx Zynq MPSoC Power Management
3--------------------------------------------------------------------
4The zynqmp-power node describes the power management configurations.
5It will control remote suspend/shutdown interfaces.
6
7Required properties:
8 - compatible:		Must contain:	"xlnx,zynqmp-power"
9 - interrupts:		Interrupt specifier
10
11Optional properties:
12 - mbox-names	: Name given to channels seen in the 'mboxes' property.
13		  "tx" - Mailbox corresponding to transmit path
14		  "rx" - Mailbox corresponding to receive path
15 - mboxes	: Standard property to specify a Mailbox. Each value of
16		  the mboxes property should contain a phandle to the
17		  mailbox controller device node and an args specifier
18		  that will be the phandle to the intended sub-mailbox
19		  child node to be used for communication. See
20		  Documentation/devicetree/bindings/mailbox/mailbox.txt
21		  for more details about the generic mailbox controller
22		  and client driver bindings. Also see
23		  Documentation/devicetree/bindings/mailbox/ \
24		  xlnx,zynqmp-ipi-mailbox.txt for typical controller that
25		  is used to communicate with this System controllers.
26
27--------
28Examples
29--------
30
31Example with interrupt method:
32
33firmware {
34	zynqmp_firmware: zynqmp-firmware {
35		compatible = "xlnx,zynqmp-firmware";
36		method = "smc";
37
38		zynqmp_power: zynqmp-power {
39			compatible = "xlnx,zynqmp-power";
40			interrupts = <0 35 4>;
41		};
42	};
43};
44
45Example with IPI mailbox method:
46
47firmware {
48	zynqmp_firmware: zynqmp-firmware {
49		compatible = "xlnx,zynqmp-firmware";
50		method = "smc";
51
52		zynqmp_power: zynqmp-power {
53			compatible = "xlnx,zynqmp-power";
54			interrupt-parent = <&gic>;
55			interrupts = <0 35 4>;
56			mboxes = <&ipi_mailbox_pmu0 0>,
57				 <&ipi_mailbox_pmu0 1>;
58			mbox-names = "tx", "rx";
59		};
60	};
61};
62