[PATCH v7 09/15] dt-bindings: firmware: Add fsl,scu yaml file

[Viorel Suman]

On 22-07-06 08:36:58, Rob Herring wrote:
> On Mon, Jul 04, 2022 at 07:15:35PM +0300, Viorel Suman (OSS) wrote:
> > From: Abel Vesa <abel.vesa at nxp.com>

[...]

> > diff --git a/Documentation/devicetree/bindings/firmware/fsl,scu.yaml b/Documentation/devicetree/bindings/firmware/fsl,scu.yaml
> > new file mode 100644
> > index 000000000000..c1f5b727352e
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/firmware/fsl,scu.yaml
> > @@ -0,0 +1,160 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/firmware/fsl,scu.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: NXP i.MX System Controller Firmware (SCFW)
> > +
> > +maintainers:
> > +  - Dong Aisheng <aisheng.dong at nxp.com>
> > +
> > +description: System Controller Device Node
> 
> The formatting here is not maintained unless you use a literal block 
> ('|'). But I would just drop this first line.
> 

Thank you for review, will update in the following version.

> > +  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.
> > +
> > +properties:
> > +  compatible:
> > +    const: fsl,imx-scu
> > +
> > +  clock-controller:
> > +    description:
> > +      Clock controller node that provides the clocks controlled by the SCU
> > +    $ref: /schemas/clock/fsl,scu-clk.yaml
> > +
> > +  ocotp:
> > +    description:
> > +      OCOTP controller node provided by the SCU
> > +    $ref: /schemas/nvmem/fsl,scu-ocotp.yaml
> > +
> > +  keys:
> > +    description:
> > +      Keys provided by the SCU
> > +    $ref: /schemas/input/fsl,scu-key.yaml
> > +
> > +  mboxes:
> > +    description: |
> > +      List of phandle of 4 MU channels for tx, 4 MU channels for
> > +      rx, and 1 optional MU channel for general interrupt.
> > +      All 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.
> > +    minItems: 1
> > +    maxItems: 10
> 
> Based on the description, shouldn't this be:
> 
> minItems: 8
> maxItems: 9
>

Actually the description should be updated - there is a series sent by Abel
adding the support for i.MX8 DXL - it has just 1 MU channel for rx, 1 - for tx,
and 1 optional for general interrupt. An approach would be to add a structure
which will include two options - one for 8..9, another for 2..3.
Hopefully I'll be able to define a generic one.

> > +
> > +  mbox-names:
> > +    description:
> > +      include "gip3" if want to support general MU interrupt.
> 
> What are all the other names? Needs to be a schema, not freeform text.

Right, ok.

> > +    minItems: 1
> > +    maxItems: 10
> > +
> > +  pinctrl:
> > +    description:
> > +      Pin controller provided by the SCU
> > +    $ref: /schemas/pinctrl/fsl,scu-pinctrl.yaml
> > +
> > +  power-controller:
> > +    description: |
> > +      Power domains controller node that provides the power domains
> > +      controlled by the SCU
> > +    $ref: /schemas/power/fsl,scu-pd.yaml
> > +
> > +  rtc:
> > +    description:
> > +      RTC controller provided by the SCU
> > +    $ref: /schemas/rtc/fsl,scu-rtc.yaml
> > +
> > +  thermal-sensor:
> > +    description:
> > +      Thermal sensor provided by the SCU
> > +    $ref: /schemas/thermal/fsl,scu-thermal.yaml
> > +
> > +  watchdog:
> > +    description:
> > +      Watchdog controller provided by the SCU
> > +    $ref: /schemas/watchdog/fsl,scu-wdt.yaml
> > +
> > +required:
> > +  - compatible
> > +  - mbox-names
> > +  - mboxes
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > +  - |
> > +    #include <dt-bindings/firmware/imx/rsrc.h>
> > +    #include <dt-bindings/input/input.h>
> > +    #include <dt-bindings/pinctrl/pads-imx8qxp.h>
> > +
> > +    firmware {
> > +        system-controller {
> > +            compatible = "fsl,imx-scu";
> > +            mbox-names = "tx0", "tx1", "tx2", "tx3",
> > +                         "rx0", "rx1", "rx2", "rx3",
> > +                         "gip3";
> > +            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
> > +                      &lsio_mu1 3 3>;
> > +
> > +            clock-controller {
> > +                compatible = "fsl,imx8qxp-clk", "fsl,scu-clk";
> > +                #clock-cells = <2>;
> > +            };
> > +
> > +            pinctrl {
> > +                compatible = "fsl,imx8qxp-iomuxc";
> > +
> > +                pinctrl_lpuart0: lpuart0grp {
> > +                    fsl,pins = <
> > +                        IMX8QXP_UART0_RX_ADMA_UART0_RX   0x06000020
> > +                        IMX8QXP_UART0_TX_ADMA_UART0_TX   0x06000020
> > +                    >;
> > +                };
> > +            };
> > +
> > +            ocotp {
> > +                compatible = "fsl,imx8qxp-scu-ocotp";
> > +                #address-cells = <1>;
> > +                #size-cells = <1>;
> > +
> > +                fec_mac0: mac at 2c4 {
> > +                    reg = <0x2c4 6>;
> > +                };
> > +            };
> > +
> > +            power-controller {
> > +                compatible = "fsl,imx8qxp-scu-pd", "fsl,scu-pd";
> > +                #power-domain-cells = <1>;
> > +            };
> > +
> > +            rtc {
> > +                compatible = "fsl,imx8qxp-sc-rtc";
> > +            };
> > +
> > +            keys {
> > +                compatible = "fsl,imx8qxp-sc-key", "fsl,imx-sc-key";
> > +                linux,keycodes = <KEY_POWER>;
> > +            };
> > +
> > +            watchdog {
> > +                compatible = "fsl,imx8qxp-sc-wdt", "fsl,imx-sc-wdt";
> > +                timeout-sec = <60>;
> > +            };
> > +
> > +            thermal-sensor {
> > +                compatible = "fsl,imx8qxp-sc-thermal", "fsl,imx-sc-thermal";
> > +                #thermal-sensor-cells = <1>;
> > +            };
> > +        };
> > +    };
> > -- 
> > 2.25.1
> > 
> >