On Tue, Nov 12, 2019 at 05:20:50AM -0800, Rajan Vaja wrote:
> Add IPI mailbox property and its example in xilinx zynqmp-power
> documentation.
>
> Signed-off-by: Rajan Vaja <rajan.vaja@xxxxxxxxxx>
> ---
> .../bindings/power/reset/xlnx,zynqmp-power.txt | 41 ++++++++++++++++++++--
> 1 file changed, 38 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/devicetree/bindings/power/reset/xlnx,zynqmp-power.txt b/Documentation/devicetree/bindings/power/reset/xlnx,zynqmp-power.txt
> index d366f1e..450f3a4 100644
> --- a/Documentation/devicetree/bindings/power/reset/xlnx,zynqmp-power.txt
> +++ b/Documentation/devicetree/bindings/power/reset/xlnx,zynqmp-power.txt
> @@ -8,9 +8,27 @@ Required properties:
> - compatible: Must contain: "xlnx,zynqmp-power"
> - interrupts: Interrupt specifier
>
> --------
> -Example
> --------
> +Optional properties:
> + - mbox-names : Name given to channels seen in the 'mboxes' property.
> + "rx" - Mailbox corresponding to receive path
> + "tx" - Mailbox corresponding to transmit path
The order here doesn't match the example. The order should be defined.
> + - mboxes : Standard property to specify a Mailbox. Each value of
> + the mboxes property should contain a phandle to the
> + mailbox controller device node and an args specifier
> + that will be the phandle to the intended sub-mailbox
> + child node to be used for communication. See
> + Documentation/devicetree/bindings/mailbox/mailbox.txt
> + for more details about the generic mailbox controller
> + and client driver bindings. Also see
> + Documentation/devicetree/bindings/mailbox/ \
> + xlnx,zynqmp-ipi-mailbox.txt for typical controller that
> + is used to communicate with this System controllers.
> +
> +--------
> +Examples
> +--------
> +
> +Example with interrupt method:
>
> firmware {
> zynqmp_firmware: zynqmp-firmware {
> @@ -23,3 +41,20 @@ firmware {
> };
> };
> };
> +
> +Example with IPI mailbox method:
> +
> +firmware {
> +
> + zynqmp_firmware: zynqmp-firmware {
> + compatible = "xlnx,zynqmp-firmware";
> + method = "smc";
> +
> + zynqmp_power: zynqmp-power {
> + compatible = "xlnx,zynqmp-power";
> + mboxes = <&ipi_mailbox_pmu0 0>,
> + <&ipi_mailbox_pmu0 1>;
> + mbox-names = "tx", "rx";
interrupts is required.
> + };
> + };
> +};
> --
> 2.7.4
>
