[PATCH V5 1/5] dt-bindings: arm: fsl: add scu binding doc

[PATCH V5 1/5] dt-bindings: arm: fsl: add scu binding doc

[Dong Aisheng]

The System Controller Firmware (SCFW) is a low-level system function
which runs on a dedicated Cortex-M core to provide power, clock, and
resource management. It exists on some i.MX8 processors. e.g. i.MX8QM
(QM, QP), and i.MX8QX (QXP, DX).

Cc: Rob Herring <robh+dt@kernel.org>
Cc: Mark Rutland <mark.rutland@arm.com>
Cc: Sascha Hauer <kernel@pengutronix.de>
Cc: Jassi Brar <jassisinghbrar@gmail.com>
Cc: Linus Walleij <linus.walleij@linaro.org>
Cc: Stephen Boyd <sboyd@kernel.org>
Cc: "Rafael J. Wysocki" <rjw@rjwysocki.net>
Cc: Ulf Hansson <ulf.hansson@linaro.org>
Cc: Shawn Guo <shawnguo@kernel.org>
Cc: Fabio Estevam <fabio.estevam@nxp.com>
Cc: devicetree@vger.kernel.org
Cc: linux-clk@vger.kernel.org
Cc: linux-gpio@vger.kernel.org
Cc: linux-pm@vger.kernel.org
Signed-off-by: Dong Aisheng <aisheng.dong@nxp.com>
---
v4->v5:
 * scu node should be under firmware node
 * add pd/clk/pinctrl binding as well according to Rob's suggestion
 * switch to new generic MU binding
   Use 8 separate mu channels in one MU instance for SCU communication
v3->v4:
 * fully change to mailbox binding
 * add child node description
v2->v3:
 * update a bit to mailbox binding
v1->v2:
 * remove status
 * changed to mu1
---
 .../devicetree/bindings/arm/freescale/fsl,scu.txt  | 179 +++++++++++++++++++++
 1 file changed, 179 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/arm/freescale/fsl,scu.txt

diff --git a/Documentation/devicetree/bindings/arm/freescale/fsl,scu.txt b/Documentation/devicetree/bindings/arm/freescale/fsl,scu.txt
new file mode 100644
index 0000000..2cd7e4a
--- /dev/null
+++ b/Documentation/devicetree/bindings/arm/freescale/fsl,scu.txt
@@ -0,0 +1,179 @@
+NXP i.MX System Controller Firmware (SCFW) --------------------------------------------------------------------
+
+The System Controller Firmware (SCFW) is a low-level system function
+which runs on a dedicated Cortex-M core to provide power, clock, and
+resource management. It exists on some i.MX8 processors. e.g. i.MX8QM
+(QM, QP), and i.MX8QX (QXP, DX).
+
+The AP communicates with the SC using a multi-ported MU module found
+in the LSIO subsystem. The current definition of this MU module provides
+5 remote AP connections to the SC to support up to 5 execution environments
+(TZ, HV, standard Linux, etc.). The SC side of this MU module interfaces
+with the LSIO DSC IP bus. The SC firmware will communicate with this MU
+using the MSI bus.
+
+System Controller Device Node:
+============================================================
+
+The scu node with the following properties shall be under the /firmware/ node.
+
+Required properties:
+-------------------
+- compatible:	should be "fsl,imx-scu".
+- mbox-names:	should include "tx0", "tx1", "tx2", "tx3",
+			       "rx0", "rx1", "rx2", "rx3".
+- mboxes:	List of phandle of 4 MU channels for tx and 4 MU channels
+		for rx. All 8 MU channels must be in the same MU instance.
+		Cross instances are not allowed. The MU instance can only
+		be one of LSIO MU0~M4 for imx8qxp and imx8qm. Users need
+		to make sure use the one which is not conflict with other
+		execution environments. e.g. ATF.
+		Note:
+		Channel 0 must be "tx0" or "rx0".
+		Channel 1 must be "tx1" or "rx1".
+		Channel 2 must be "tx2" or "rx2".
+		Channel 3 must be "tx3" or "rx3".
+		e.g.
+		mboxes = <&lsio_mu1 0 0
+			  &lsio_mu1 0 1
+			  &lsio_mu1 0 2
+			  &lsio_mu1 0 3
+			  &lsio_mu1 1 0
+			  &lsio_mu1 1 1
+			  &lsio_mu1 1 2
+			  &lsio_mu1 1 3>;
+		See Documentation/devicetree/bindings/mailbox/fsl,mu.txt
+		for detailed mailbox binding.
+
+i.MX SCU Client Device Node:
+============================================================
+
+Client nodes are maintained as children of the relevant IMX-SCU device node.
+
+Power domain bindings based on SCU Message Protocol
+------------------------------------------------------------
+
+This binding for the SCU power domain providers uses the generic power
+domain binding[2].
+
+Required properties:
+- compatible:		Should be "fsl,scu-pd".
+- #address-cells:	Should be 1.
+- #size-cells:		Should be 0.
+
+Required properties for power domain sub nodes:
+- #power-domain-cells:	Must be 0.
+
+Optional Properties:
+- reg:			Resource ID of this power domain.
+			No exist means uncontrollable by user.
+			See detailed Resource ID list from:
+			include/dt-bindings/power/imx-rsrc.h
+- power-domains:	phandle pointing to the parent power domain.
+
+Clock bindings based on SCU Message Protocol
+------------------------------------------------------------
+
+This binding uses the common clock binding[1].
+
+Required properties:
+- compatible:		Should be "fsl,imx8qxp-clock".
+- #clock-cells:		Should be 1. Contains the Clock ID value.
+
+The clock consumer should specify the desired clock by having the clock
+ID in its "clocks" phandle cell.
+
+See the full list of clock IDs from:
+include/dt-bindings/clock/imx8qxp-clock.h
+
+Pinctrl bindings based on SCU Message Protocol
+------------------------------------------------------------
+
+This binding uses the i.MX common pinctrl binding[3].
+
+Required properties:
+- compatible:		Should be "fsl,imx8qxp-iomuxc".
+
+Required properties for Pinctrl sub nodes:
+- fsl,pins:		Each entry consists of 3 integers which represents
+			the mux and config setting for one pin. The first 2
+			integers <pin_id mux_mode> are specified using a
+			PIN_FUNC_ID macro, which can be found in
+			<dt-bindings/pinctrl/pads-imx8qxp.h>.
+			The last integer CONFIG is the pad setting value like
+			pull-up on this pin.
+
+			Please refer to i.MX8QXP Reference Manual for detailed
+			CONFIG settings.
+
+[1] Documentation/devicetree/bindings/clock/clock-bindings.txt
+[2] Documentation/devicetree/bindings/power/power_domain.txt
+[3] Documentation/devicetree/bindings/pinctrl/fsl,imx-pinctrl.txt
+
+Example (imx8qxp):
+-------------
+lsio_mu1: mailbox@5d1c0000 {
+	...
+	#mbox-cells = <2>;
+};
+
+firmware {
+	scu {
+		compatible = "fsl,imx-scu";
+		mbox-names = "tx0", "tx1", "tx2", "tx3",
+			     "rx0", "rx1", "rx2", "rx3";
+		mboxes = <&lsio_mu1 0 0
+			  &lsio_mu1 0 1
+			  &lsio_mu1 0 2
+			  &lsio_mu1 0 3
+			  &lsio_mu1 1 0
+			  &lsio_mu1 1 1
+			  &lsio_mu1 1 2
+			  &lsio_mu1 1 3>;
+
+		clk: clk {
+			compatible = "fsl,imx8qxp-clk";
+			#clock-cells = <1>;
+		};
+
+		iomuxc {
+			compatible = "fsl,imx8qxp-iomuxc";
+
+			pinctrl_lpuart0: lpuart0grp {
+				fsl,pins = <
+					SC_P_UART0_RX_ADMA_UART0_RX	0x06000020
+					SC_P_UART0_TX_ADMA_UART0_TX	0x06000020
+				>;
+			};
+			...
+		};
+
+		imx8qx-pm {
+			compatible = "fsl,scu-pd";
+			#address-cells = <1>;
+			#size-cells = <0>;
+
+			pd_dma: dma-power-domain {
+				#power-domain-cells = <0>;
+
+				pd_dma_lpuart0: dma-lpuart0@57 {
+					reg = <SC_R_UART_0>;
+					#power-domain-cells = <0>;
+					power-domains = <&pd_dma>;
+				};
+				...
+			};
+			...
+		};
+	};
+};
+
+serial@5a060000 {
+	...
+	pinctrl-names = "default";
+	pinctrl-0 = <&pinctrl_lpuart0>;
+	clocks = <&clk IMX8QXP_UART0_CLK>,
+		 <&clk IMX8QXP_UART0_IPG_CLK>;
+	clock-names = "per", "ipg";
+	power-domains = <&pd_dma_lpuart0>;
+};
-- 
2.7.4

Re: [PATCH V5 1/5] dt-bindings: arm: fsl: add scu binding doc

[Rob Herring]

On Tue, Aug 21, 2018 at 12:08:21AM +0800, Dong Aisheng wrote:
> The System Controller Firmware (SCFW) is a low-level system function
> which runs on a dedicated Cortex-M core to provide power, clock, and
> resource management. It exists on some i.MX8 processors. e.g. i.MX8QM
> (QM, QP), and i.MX8QX (QXP, DX).
> 
> Cc: Rob Herring <robh+dt@kernel.org>
> Cc: Mark Rutland <mark.rutland@arm.com>
> Cc: Sascha Hauer <kernel@pengutronix.de>
> Cc: Jassi Brar <jassisinghbrar@gmail.com>
> Cc: Linus Walleij <linus.walleij@linaro.org>
> Cc: Stephen Boyd <sboyd@kernel.org>
> Cc: "Rafael J. Wysocki" <rjw@rjwysocki.net>
> Cc: Ulf Hansson <ulf.hansson@linaro.org>
> Cc: Shawn Guo <shawnguo@kernel.org>
> Cc: Fabio Estevam <fabio.estevam@nxp.com>
> Cc: devicetree@vger.kernel.org
> Cc: linux-clk@vger.kernel.org
> Cc: linux-gpio@vger.kernel.org
> Cc: linux-pm@vger.kernel.org
> Signed-off-by: Dong Aisheng <aisheng.dong@nxp.com>
> ---
> v4->v5:
>  * scu node should be under firmware node
>  * add pd/clk/pinctrl binding as well according to Rob's suggestion
>  * switch to new generic MU binding
>    Use 8 separate mu channels in one MU instance for SCU communication
> v3->v4:
>  * fully change to mailbox binding
>  * add child node description
> v2->v3:
>  * update a bit to mailbox binding
> v1->v2:
>  * remove status
>  * changed to mu1
> ---
>  .../devicetree/bindings/arm/freescale/fsl,scu.txt  | 179 +++++++++++++++++++++
>  1 file changed, 179 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/arm/freescale/fsl,scu.txt
> 
> diff --git a/Documentation/devicetree/bindings/arm/freescale/fsl,scu.txt b/Documentation/devicetree/bindings/arm/freescale/fsl,scu.txt
> new file mode 100644
> index 0000000..2cd7e4a
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/arm/freescale/fsl,scu.txt
> @@ -0,0 +1,179 @@
> +NXP i.MX System Controller Firmware (SCFW) --------------------------------------------------------------------

Think you wanted a newline here              ^?

> +
> +The System Controller Firmware (SCFW) is a low-level system function
> +which runs on a dedicated Cortex-M core to provide power, clock, and
> +resource management. It exists on some i.MX8 processors. e.g. i.MX8QM
> +(QM, QP), and i.MX8QX (QXP, DX).
> +
> +The AP communicates with the SC using a multi-ported MU module found
> +in the LSIO subsystem. The current definition of this MU module provides
> +5 remote AP connections to the SC to support up to 5 execution environments
> +(TZ, HV, standard Linux, etc.). The SC side of this MU module interfaces
> +with the LSIO DSC IP bus. The SC firmware will communicate with this MU
> +using the MSI bus.

How are 5 users supported with only 4 channels defined below?

> +
> +System Controller Device Node:
> +============================================================
> +
> +The scu node with the following properties shall be under the /firmware/ node.
> +
> +Required properties:
> +-------------------
> +- compatible:	should be "fsl,imx-scu".
> +- mbox-names:	should include "tx0", "tx1", "tx2", "tx3",
> +			       "rx0", "rx1", "rx2", "rx3".
> +- mboxes:	List of phandle of 4 MU channels for tx and 4 MU channels
> +		for rx. All 8 MU channels must be in the same MU instance.
> +		Cross instances are not allowed. The MU instance can only
> +		be one of LSIO MU0~M4 for imx8qxp and imx8qm. Users need
> +		to make sure use the one which is not conflict with other
> +		execution environments. e.g. ATF.

How is one supposed to know what channels are in use already?

IMO, ATF should remove the channel it uses before passing the DT to the 
next stage. That doesn't help if later stages get a different DT though.

> +		Note:
> +		Channel 0 must be "tx0" or "rx0".
> +		Channel 1 must be "tx1" or "rx1".
> +		Channel 2 must be "tx2" or "rx2".
> +		Channel 3 must be "tx3" or "rx3".
> +		e.g.
> +		mboxes = <&lsio_mu1 0 0
> +			  &lsio_mu1 0 1
> +			  &lsio_mu1 0 2
> +			  &lsio_mu1 0 3
> +			  &lsio_mu1 1 0
> +			  &lsio_mu1 1 1
> +			  &lsio_mu1 1 2
> +			  &lsio_mu1 1 3>;
> +		See Documentation/devicetree/bindings/mailbox/fsl,mu.txt
> +		for detailed mailbox binding.
> +
> +i.MX SCU Client Device Node:
> +============================================================
> +
> +Client nodes are maintained as children of the relevant IMX-SCU device node.
> +
> +Power domain bindings based on SCU Message Protocol
> +------------------------------------------------------------
> +
> +This binding for the SCU power domain providers uses the generic power
> +domain binding[2].
> +
> +Required properties:
> +- compatible:		Should be "fsl,scu-pd".
> +- #address-cells:	Should be 1.
> +- #size-cells:		Should be 0.
> +
> +Required properties for power domain sub nodes:
> +- #power-domain-cells:	Must be 0.
> +
> +Optional Properties:
> +- reg:			Resource ID of this power domain.
> +			No exist means uncontrollable by user.
> +			See detailed Resource ID list from:
> +			include/dt-bindings/power/imx-rsrc.h
> +- power-domains:	phandle pointing to the parent power domain.
> +
> +Clock bindings based on SCU Message Protocol
> +------------------------------------------------------------
> +
> +This binding uses the common clock binding[1].
> +
> +Required properties:
> +- compatible:		Should be "fsl,imx8qxp-clock".
> +- #clock-cells:		Should be 1. Contains the Clock ID value.

There was a recent patch adding input clocks to other i.MX CCM bindings. 
Is that needed here?

> +
> +The clock consumer should specify the desired clock by having the clock
> +ID in its "clocks" phandle cell.
> +
> +See the full list of clock IDs from:
> +include/dt-bindings/clock/imx8qxp-clock.h
> +
> +Pinctrl bindings based on SCU Message Protocol
> +------------------------------------------------------------
> +
> +This binding uses the i.MX common pinctrl binding[3].
> +
> +Required properties:
> +- compatible:		Should be "fsl,imx8qxp-iomuxc".
> +
> +Required properties for Pinctrl sub nodes:
> +- fsl,pins:		Each entry consists of 3 integers which represents
> +			the mux and config setting for one pin. The first 2
> +			integers <pin_id mux_mode> are specified using a
> +			PIN_FUNC_ID macro, which can be found in
> +			<dt-bindings/pinctrl/pads-imx8qxp.h>.
> +			The last integer CONFIG is the pad setting value like
> +			pull-up on this pin.
> +
> +			Please refer to i.MX8QXP Reference Manual for detailed
> +			CONFIG settings.
> +
> +[1] Documentation/devicetree/bindings/clock/clock-bindings.txt
> +[2] Documentation/devicetree/bindings/power/power_domain.txt
> +[3] Documentation/devicetree/bindings/pinctrl/fsl,imx-pinctrl.txt
> +
> +Example (imx8qxp):
> +-------------
> +lsio_mu1: mailbox@5d1c0000 {
> +	...
> +	#mbox-cells = <2>;
> +};
> +
> +firmware {
> +	scu {
> +		compatible = "fsl,imx-scu";
> +		mbox-names = "tx0", "tx1", "tx2", "tx3",
> +			     "rx0", "rx1", "rx2", "rx3";
> +		mboxes = <&lsio_mu1 0 0
> +			  &lsio_mu1 0 1
> +			  &lsio_mu1 0 2
> +			  &lsio_mu1 0 3
> +			  &lsio_mu1 1 0
> +			  &lsio_mu1 1 1
> +			  &lsio_mu1 1 2
> +			  &lsio_mu1 1 3>;
> +
> +		clk: clk {
> +			compatible = "fsl,imx8qxp-clk";
> +			#clock-cells = <1>;
> +		};
> +
> +		iomuxc {
> +			compatible = "fsl,imx8qxp-iomuxc";
> +
> +			pinctrl_lpuart0: lpuart0grp {
> +				fsl,pins = <
> +					SC_P_UART0_RX_ADMA_UART0_RX	0x06000020
> +					SC_P_UART0_TX_ADMA_UART0_TX	0x06000020
> +				>;
> +			};
> +			...
> +		};
> +
> +		imx8qx-pm {
> +			compatible = "fsl,scu-pd";
> +			#address-cells = <1>;
> +			#size-cells = <0>;
> +
> +			pd_dma: dma-power-domain {
> +				#power-domain-cells = <0>;
> +
> +				pd_dma_lpuart0: dma-lpuart0@57 {
> +					reg = <SC_R_UART_0>;
> +					#power-domain-cells = <0>;
> +					power-domains = <&pd_dma>;
> +				};
> +				...
> +			};
> +			...
> +		};
> +	};
> +};
> +
> +serial@5a060000 {
> +	...
> +	pinctrl-names = "default";
> +	pinctrl-0 = <&pinctrl_lpuart0>;
> +	clocks = <&clk IMX8QXP_UART0_CLK>,
> +		 <&clk IMX8QXP_UART0_IPG_CLK>;
> +	clock-names = "per", "ipg";
> +	power-domains = <&pd_dma_lpuart0>;
> +};
> -- 
> 2.7.4
> 

RE: [PATCH V5 1/5] dt-bindings: arm: fsl: add scu binding doc

[A.s. Dong]

Hi Rob,

> -----Original Message-----
> From: Rob Herring <robh@kernel.org>
> Sent: Tuesday, August 21, 2018 2:12 AM
> To: A.s. Dong <aisheng.dong@nxp.com>
> Cc: linux-arm-kernel@lists.infradead.org; dongas86@gmail.com;
> kernel@pengutronix.de; shawnguo@kernel.org; Fabio Estevam
> <fabio.estevam@nxp.com>; dl-linux-imx <linux-imx@nxp.com>; Mark
> Rutland <mark.rutland@arm.com>; Jassi Brar <jassisinghbrar@gmail.com>;
> Linus Walleij <linus.walleij@linaro.org>; Stephen Boyd <sboyd@kernel.org>=
;
> Rafael J. Wysocki <rjw@rjwysocki.net>; Ulf Hansson
> <ulf.hansson@linaro.org>; devicetree@vger.kernel.org; linux-
> clk@vger.kernel.org; linux-gpio@vger.kernel.org; linux-pm@vger.kernel.org
> Subject: Re: [PATCH V5 1/5] dt-bindings: arm: fsl: add scu binding doc
>=20
> On Tue, Aug 21, 2018 at 12:08:21AM +0800, Dong Aisheng wrote:
> > The System Controller Firmware (SCFW) is a low-level system function
> > which runs on a dedicated Cortex-M core to provide power, clock, and
> > resource management. It exists on some i.MX8 processors. e.g. i.MX8QM
> > (QM, QP), and i.MX8QX (QXP, DX).
> >
> > Cc: Rob Herring <robh+dt@kernel.org>
> > Cc: Mark Rutland <mark.rutland@arm.com>
> > Cc: Sascha Hauer <kernel@pengutronix.de>
> > Cc: Jassi Brar <jassisinghbrar@gmail.com>
> > Cc: Linus Walleij <linus.walleij@linaro.org>
> > Cc: Stephen Boyd <sboyd@kernel.org>
> > Cc: "Rafael J. Wysocki" <rjw@rjwysocki.net>
> > Cc: Ulf Hansson <ulf.hansson@linaro.org>
> > Cc: Shawn Guo <shawnguo@kernel.org>
> > Cc: Fabio Estevam <fabio.estevam@nxp.com>
> > Cc: devicetree@vger.kernel.org
> > Cc: linux-clk@vger.kernel.org
> > Cc: linux-gpio@vger.kernel.org
> > Cc: linux-pm@vger.kernel.org
> > Signed-off-by: Dong Aisheng <aisheng.dong@nxp.com>
> > ---
> > v4->v5:
> >  * scu node should be under firmware node
> >  * add pd/clk/pinctrl binding as well according to Rob's suggestion
> >  * switch to new generic MU binding
> >    Use 8 separate mu channels in one MU instance for SCU communication
> > v3->v4:
> >  * fully change to mailbox binding
> >  * add child node description
> > v2->v3:
> >  * update a bit to mailbox binding
> > v1->v2:
> >  * remove status
> >  * changed to mu1
> > ---
> >  .../devicetree/bindings/arm/freescale/fsl,scu.txt  | 179
> > +++++++++++++++++++++
> >  1 file changed, 179 insertions(+)
> >  create mode 100644
> > Documentation/devicetree/bindings/arm/freescale/fsl,scu.txt
> >
> > diff --git
> > a/Documentation/devicetree/bindings/arm/freescale/fsl,scu.txt
> > b/Documentation/devicetree/bindings/arm/freescale/fsl,scu.txt
> > new file mode 100644
> > index 0000000..2cd7e4a
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/arm/freescale/fsl,scu.txt
> > @@ -0,0 +1,179 @@
> > +NXP i.MX System Controller Firmware (SCFW)
> > +--------------------------------------------------------------------
>=20
> Think you wanted a newline here              ^?

Yes, of course.
It seems to be introduced by mistake.
Thanks for reminder.

>=20
> > +
> > +The System Controller Firmware (SCFW) is a low-level system function
> > +which runs on a dedicated Cortex-M core to provide power, clock, and
> > +resource management. It exists on some i.MX8 processors. e.g. i.MX8QM
> > +(QM, QP), and i.MX8QX (QXP, DX).
> > +
> > +The AP communicates with the SC using a multi-ported MU module found
> > +in the LSIO subsystem. The current definition of this MU module
> > +provides
> > +5 remote AP connections to the SC to support up to 5 execution
> > +environments (TZ, HV, standard Linux, etc.). The SC side of this MU
> > +module interfaces with the LSIO DSC IP bus. The SC firmware will
> > +communicate with this MU using the MSI bus.
>=20
> How are 5 users supported with only 4 channels defined below?

There're 5 MU instances designed to be specifically communicate with
SCU Firmware on MX8 hardware.

With the new generic mu binding [1], each MU instance is abstracted
Into 16 virtual MU channels. (4 Tx, 4 Rx, 4 Tx doorbell, 4 Rx doorbell).
(MU has 4 pair of Tx/Rx data register which can be used to send/receive
multi words. With new binding, each data register is abstracted into one
MU channel, totally 8 channels for data transfer).

SCU protocol is already designed to uses all data registers to send/receive
multi words according to MU hardware reference manual. So it must
use all channels in one MU instances with new binding.

On MX8, it can be one of LSIO MU0~M4.
=20
[1] https://patchwork.kernel.org/patch/10554565/

>=20
> > +
> > +System Controller Device Node:
> >
> +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D
> =3D=3D=3D
> > +
> > +The scu node with the following properties shall be under the /firmwar=
e/
> node.
> > +
> > +Required properties:
> > +-------------------
> > +- compatible:	should be "fsl,imx-scu".
> > +- mbox-names:	should include "tx0", "tx1", "tx2", "tx3",
> > +			       "rx0", "rx1", "rx2", "rx3".
> > +- mboxes:	List of phandle of 4 MU channels for tx and 4 MU channels
> > +		for rx. All 8 MU channels must be in the same MU instance.
> > +		Cross instances are not allowed. The MU instance can only
> > +		be one of LSIO MU0~M4 for imx8qxp and imx8qm. Users
> need
> > +		to make sure use the one which is not conflict with other
> > +		execution environments. e.g. ATF.
>=20
> How is one supposed to know what channels are in use already?
>=20

Currently it's simply predefined.
E.g. ATF uses MU0 and u-Boot & Kernel uses MU1.

> IMO, ATF should remove the channel it uses before passing the DT to the
> next stage.=20

Sounds like a good idea.
To be more specific, you mean simply marking the MU node status used in ATF
to be "disabled" before passing to the next stage, am I understand correct?

> That doesn't help if later stages get a different DT though.

Doesn't help? Sorry a bit confusing...

>=20
> > +		Note:
> > +		Channel 0 must be "tx0" or "rx0".
> > +		Channel 1 must be "tx1" or "rx1".
> > +		Channel 2 must be "tx2" or "rx2".
> > +		Channel 3 must be "tx3" or "rx3".
> > +		e.g.
> > +		mboxes =3D <&lsio_mu1 0 0
> > +			  &lsio_mu1 0 1
> > +			  &lsio_mu1 0 2
> > +			  &lsio_mu1 0 3
> > +			  &lsio_mu1 1 0
> > +			  &lsio_mu1 1 1
> > +			  &lsio_mu1 1 2
> > +			  &lsio_mu1 1 3>;
> > +		See Documentation/devicetree/bindings/mailbox/fsl,mu.txt
> > +		for detailed mailbox binding.
> > +
> > +i.MX SCU Client Device Node:
> >
> +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D
> =3D=3D=3D
> > +
> > +Client nodes are maintained as children of the relevant IMX-SCU device
> node.
> > +
> > +Power domain bindings based on SCU Message Protocol
> > +------------------------------------------------------------
> > +
> > +This binding for the SCU power domain providers uses the generic
> > +power domain binding[2].
> > +
> > +Required properties:
> > +- compatible:		Should be "fsl,scu-pd".
> > +- #address-cells:	Should be 1.
> > +- #size-cells:		Should be 0.
> > +
> > +Required properties for power domain sub nodes:
> > +- #power-domain-cells:	Must be 0.
> > +
> > +Optional Properties:
> > +- reg:			Resource ID of this power domain.
> > +			No exist means uncontrollable by user.
> > +			See detailed Resource ID list from:
> > +			include/dt-bindings/power/imx-rsrc.h
> > +- power-domains:	phandle pointing to the parent power domain.
> > +
> > +Clock bindings based on SCU Message Protocol
> > +------------------------------------------------------------
> > +
> > +This binding uses the common clock binding[1].
> > +
> > +Required properties:
> > +- compatible:		Should be "fsl,imx8qxp-clock".
> > +- #clock-cells:		Should be 1. Contains the Clock ID value.
>=20
> There was a recent patch adding input clocks to other i.MX CCM bindings.
> Is that needed here?
>=20

Will double check it, thanks for reminder.

Regards
Dong Aisheng

> > +
> > +The clock consumer should specify the desired clock by having the
> > +clock ID in its "clocks" phandle cell.
> > +
> > +See the full list of clock IDs from:
> > +include/dt-bindings/clock/imx8qxp-clock.h
> > +
> > +Pinctrl bindings based on SCU Message Protocol
> > +------------------------------------------------------------
> > +
> > +This binding uses the i.MX common pinctrl binding[3].
> > +
> > +Required properties:
> > +- compatible:		Should be "fsl,imx8qxp-iomuxc".
> > +
> > +Required properties for Pinctrl sub nodes:
> > +- fsl,pins:		Each entry consists of 3 integers which represents
> > +			the mux and config setting for one pin. The first 2
> > +			integers <pin_id mux_mode> are specified using a
> > +			PIN_FUNC_ID macro, which can be found in
> > +			<dt-bindings/pinctrl/pads-imx8qxp.h>.
> > +			The last integer CONFIG is the pad setting value like
> > +			pull-up on this pin.
> > +
> > +			Please refer to i.MX8QXP Reference Manual for
> detailed
> > +			CONFIG settings.
> > +
> > +[1] Documentation/devicetree/bindings/clock/clock-bindings.txt
> > +[2] Documentation/devicetree/bindings/power/power_domain.txt
> > +[3] Documentation/devicetree/bindings/pinctrl/fsl,imx-pinctrl.txt
> > +
> > +Example (imx8qxp):
> > +-------------
> > +lsio_mu1: mailbox@5d1c0000 {
> > +	...
> > +	#mbox-cells =3D <2>;
> > +};
> > +
> > +firmware {
> > +	scu {
> > +		compatible =3D "fsl,imx-scu";
> > +		mbox-names =3D "tx0", "tx1", "tx2", "tx3",
> > +			     "rx0", "rx1", "rx2", "rx3";
> > +		mboxes =3D <&lsio_mu1 0 0
> > +			  &lsio_mu1 0 1
> > +			  &lsio_mu1 0 2
> > +			  &lsio_mu1 0 3
> > +			  &lsio_mu1 1 0
> > +			  &lsio_mu1 1 1
> > +			  &lsio_mu1 1 2
> > +			  &lsio_mu1 1 3>;
> > +
> > +		clk: clk {
> > +			compatible =3D "fsl,imx8qxp-clk";
> > +			#clock-cells =3D <1>;
> > +		};
> > +
> > +		iomuxc {
> > +			compatible =3D "fsl,imx8qxp-iomuxc";
> > +
> > +			pinctrl_lpuart0: lpuart0grp {
> > +				fsl,pins =3D <
> > +					SC_P_UART0_RX_ADMA_UART0_RX
> 	0x06000020
> > +					SC_P_UART0_TX_ADMA_UART0_TX
> 	0x06000020
> > +				>;
> > +			};
> > +			...
> > +		};
> > +
> > +		imx8qx-pm {
> > +			compatible =3D "fsl,scu-pd";
> > +			#address-cells =3D <1>;
> > +			#size-cells =3D <0>;
> > +
> > +			pd_dma: dma-power-domain {
> > +				#power-domain-cells =3D <0>;
> > +
> > +				pd_dma_lpuart0: dma-lpuart0@57 {
> > +					reg =3D <SC_R_UART_0>;
> > +					#power-domain-cells =3D <0>;
> > +					power-domains =3D <&pd_dma>;
> > +				};
> > +				...
> > +			};
> > +			...
> > +		};
> > +	};
> > +};
> > +
> > +serial@5a060000 {
> > +	...
> > +	pinctrl-names =3D "default";
> > +	pinctrl-0 =3D <&pinctrl_lpuart0>;
> > +	clocks =3D <&clk IMX8QXP_UART0_CLK>,
> > +		 <&clk IMX8QXP_UART0_IPG_CLK>;
> > +	clock-names =3D "per", "ipg";
> > +	power-domains =3D <&pd_dma_lpuart0>;
> > +};
> > --
> > 2.7.4
> >

RE: [PATCH V5 1/5] dt-bindings: arm: fsl: add scu binding doc

[A.s. Dong]

Hi Rob,

> > > +Clock bindings based on SCU Message Protocol
> > > +------------------------------------------------------------
> > > +
> > > +This binding uses the common clock binding[1].
> > > +
> > > +Required properties:
> > > +- compatible:		Should be "fsl,imx8qxp-clock".
> > > +- #clock-cells:		Should be 1. Contains the Clock ID value.
> >
> > There was a recent patch adding input clocks to other i.MX CCM bindings=
.
> > Is that needed here?
> >
>=20
> Will double check it, thanks for reminder.

It should work for mx8 as well.

I will add them like below:
+- clocks:              List of clock specifiers, must contain an entry for
+                       each required entry in clock-names
+- clock-names:         Should include entries "xtal_32KHz", "xtal_24MHz"

Thanks for the suggestion.

Regards
Dong Aisheng

Re: [PATCH V5 1/5] dt-bindings: arm: fsl: add scu binding doc

[Jassi Brar]

On Tue, Aug 21, 2018 at 8:30 AM A.s. Dong <aisheng.dong@nxp.com> wrote:
>
> > > +
> > > +The System Controller Firmware (SCFW) is a low-level system function
> > > +which runs on a dedicated Cortex-M core to provide power, clock, and
> > > +resource management. It exists on some i.MX8 processors. e.g. i.MX8QM
> > > +(QM, QP), and i.MX8QX (QXP, DX).
> > > +
> > > +The AP communicates with the SC using a multi-ported MU module found
> > > +in the LSIO subsystem. The current definition of this MU module
> > > +provides
> > > +5 remote AP connections to the SC to support up to 5 execution
> > > +environments (TZ, HV, standard Linux, etc.). The SC side of this MU
> > > +module interfaces with the LSIO DSC IP bus. The SC firmware will
> > > +communicate with this MU using the MSI bus.
> >
> > How are 5 users supported with only 4 channels defined below?
>
> There're 5 MU instances designed to be specifically communicate with
> SCU Firmware on MX8 hardware.
>
This is correct.

> With the new generic mu binding [1], each MU instance is abstracted
> Into 16 virtual MU channels. (4 Tx, 4 Rx, 4 Tx doorbell, 4 Rx doorbell).
> (MU has 4 pair of Tx/Rx data register which can be used to send/receive
> multi words. With new binding, each data register is abstracted into one
> MU channel, totally 8 channels for data transfer).
>
> SCU protocol is already designed to uses all data registers to send/receive
> multi words according to MU hardware reference manual. So it must
> use all channels in one MU instances with new binding.
>
FYI, this is incorrect.
The 16 channels are physical and not virtual. In fact, all this is to
avoid virtual channels.
The physical resources required by new bindings are exactly the same
as by old bindings. Now you use 8 physical channels instead of 1
virtual.

RE: [PATCH V5 1/5] dt-bindings: arm: fsl: add scu binding doc

[A.s. Dong]

PiAtLS0tLU9yaWdpbmFsIE1lc3NhZ2UtLS0tLQ0KPiBGcm9tOiBKYXNzaSBCcmFyIFttYWlsdG86
amFzc2lzaW5naGJyYXJAZ21haWwuY29tXQ0KPiBPbiBUdWUsIEF1ZyAyMSwgMjAxOCBhdCA4OjMw
IEFNIEEucy4gRG9uZyA8YWlzaGVuZy5kb25nQG54cC5jb20+IHdyb3RlOg0KPiA+DQo+ID4gPiA+
ICsNCj4gPiA+ID4gK1RoZSBTeXN0ZW0gQ29udHJvbGxlciBGaXJtd2FyZSAoU0NGVykgaXMgYSBs
b3ctbGV2ZWwgc3lzdGVtDQo+ID4gPiA+ICtmdW5jdGlvbiB3aGljaCBydW5zIG9uIGEgZGVkaWNh
dGVkIENvcnRleC1NIGNvcmUgdG8gcHJvdmlkZQ0KPiA+ID4gPiArcG93ZXIsIGNsb2NrLCBhbmQg
cmVzb3VyY2UgbWFuYWdlbWVudC4gSXQgZXhpc3RzIG9uIHNvbWUgaS5NWDgNCj4gPiA+ID4gK3By
b2Nlc3NvcnMuIGUuZy4gaS5NWDhRTSAoUU0sIFFQKSwgYW5kIGkuTVg4UVggKFFYUCwgRFgpLg0K
PiA+ID4gPiArDQo+ID4gPiA+ICtUaGUgQVAgY29tbXVuaWNhdGVzIHdpdGggdGhlIFNDIHVzaW5n
IGEgbXVsdGktcG9ydGVkIE1VIG1vZHVsZQ0KPiA+ID4gPiArZm91bmQgaW4gdGhlIExTSU8gc3Vi
c3lzdGVtLiBUaGUgY3VycmVudCBkZWZpbml0aW9uIG9mIHRoaXMgTVUNCj4gPiA+ID4gK21vZHVs
ZSBwcm92aWRlcw0KPiA+ID4gPiArNSByZW1vdGUgQVAgY29ubmVjdGlvbnMgdG8gdGhlIFNDIHRv
IHN1cHBvcnQgdXAgdG8gNSBleGVjdXRpb24NCj4gPiA+ID4gK2Vudmlyb25tZW50cyAoVFosIEhW
LCBzdGFuZGFyZCBMaW51eCwgZXRjLikuIFRoZSBTQyBzaWRlIG9mIHRoaXMNCj4gPiA+ID4gK01V
IG1vZHVsZSBpbnRlcmZhY2VzIHdpdGggdGhlIExTSU8gRFNDIElQIGJ1cy4gVGhlIFNDIGZpcm13
YXJlDQo+ID4gPiA+ICt3aWxsIGNvbW11bmljYXRlIHdpdGggdGhpcyBNVSB1c2luZyB0aGUgTVNJ
IGJ1cy4NCj4gPiA+DQo+ID4gPiBIb3cgYXJlIDUgdXNlcnMgc3VwcG9ydGVkIHdpdGggb25seSA0
IGNoYW5uZWxzIGRlZmluZWQgYmVsb3c/DQo+ID4NCj4gPiBUaGVyZSdyZSA1IE1VIGluc3RhbmNl
cyBkZXNpZ25lZCB0byBiZSBzcGVjaWZpY2FsbHkgY29tbXVuaWNhdGUgd2l0aA0KPiA+IFNDVSBG
aXJtd2FyZSBvbiBNWDggaGFyZHdhcmUuDQo+ID4NCj4gVGhpcyBpcyBjb3JyZWN0Lg0KPiANCj4g
PiBXaXRoIHRoZSBuZXcgZ2VuZXJpYyBtdSBiaW5kaW5nIFsxXSwgZWFjaCBNVSBpbnN0YW5jZSBp
cyBhYnN0cmFjdGVkDQo+ID4gSW50byAxNiB2aXJ0dWFsIE1VIGNoYW5uZWxzLiAoNCBUeCwgNCBS
eCwgNCBUeCBkb29yYmVsbCwgNCBSeCBkb29yYmVsbCkuDQo+ID4gKE1VIGhhcyA0IHBhaXIgb2Yg
VHgvUnggZGF0YSByZWdpc3RlciB3aGljaCBjYW4gYmUgdXNlZCB0bw0KPiA+IHNlbmQvcmVjZWl2
ZSBtdWx0aSB3b3Jkcy4gV2l0aCBuZXcgYmluZGluZywgZWFjaCBkYXRhIHJlZ2lzdGVyIGlzDQo+
ID4gYWJzdHJhY3RlZCBpbnRvIG9uZSBNVSBjaGFubmVsLCB0b3RhbGx5IDggY2hhbm5lbHMgZm9y
IGRhdGEgdHJhbnNmZXIpLg0KPiA+DQo+ID4gU0NVIHByb3RvY29sIGlzIGFscmVhZHkgZGVzaWdu
ZWQgdG8gdXNlcyBhbGwgZGF0YSByZWdpc3RlcnMgdG8NCj4gPiBzZW5kL3JlY2VpdmUgbXVsdGkg
d29yZHMgYWNjb3JkaW5nIHRvIE1VIGhhcmR3YXJlIHJlZmVyZW5jZSBtYW51YWwuIFNvDQo+ID4g
aXQgbXVzdCB1c2UgYWxsIGNoYW5uZWxzIGluIG9uZSBNVSBpbnN0YW5jZXMgd2l0aCBuZXcgYmlu
ZGluZy4NCj4gPg0KPiBGWUksIHRoaXMgaXMgaW5jb3JyZWN0Lg0KPiBUaGUgMTYgY2hhbm5lbHMg
YXJlIHBoeXNpY2FsIGFuZCBub3QgdmlydHVhbC4gSW4gZmFjdCwgYWxsIHRoaXMgaXMgdG8gYXZv
aWQgdmlydHVhbA0KPiBjaGFubmVscy4NCj4gVGhlIHBoeXNpY2FsIHJlc291cmNlcyByZXF1aXJl
ZCBieSBuZXcgYmluZGluZ3MgYXJlIGV4YWN0bHkgdGhlIHNhbWUgYXMgYnkgb2xkDQo+IGJpbmRp
bmdzLiBOb3cgeW91IHVzZSA4IHBoeXNpY2FsIGNoYW5uZWxzIGluc3RlYWQgb2YgMSB2aXJ0dWFs
Lg0KDQpPa2F5LCBnb3QgaXQuDQpJJ20gZmluZSB0byByZWZlciB0byB0aGVtIGFsbCBhcyBwaHlz
aWNhbCBjaGFubmVscy4NClRoYW5rcw0KDQpSZWdhcmRzDQpEb25nIEFpc2hlbmcNCg==