[PATCH 1/5] dt-bindings: remoteproc: Add PRU consumer bindings

[Grzegorz Jaszczyk]

Hi Rob,

On Mon, 14 Dec 2020 at 23:58, Rob Herring <robh at kernel.org> wrote:
>
> On Fri, Dec 11, 2020 at 03:29:29PM +0100, Grzegorz Jaszczyk wrote:
> > From: Suman Anna <s-anna at ti.com>
> >
> > Add a YAML binding document for PRU consumers. The binding includes
> > all the common properties that can be used by different PRU consumer
> > or application nodes and supported by the PRU remoteproc driver.
> > These are used to configure the PRU hardware for specific user
> > applications.
> >
> > The application nodes themselves should define their own bindings.
> >
> > Co-developed-by: Tero Kristo <t-kristo at ti.com>
> > Signed-off-by: Tero Kristo <t-kristo at ti.com>
> > Signed-off-by: Suman Anna <s-anna at ti.com>
> > Co-developed-by: Grzegorz Jaszczyk <grzegorz.jaszczyk at linaro.org>
> > Signed-off-by: Grzegorz Jaszczyk <grzegorz.jaszczyk at linaro.org>
> > ---
> >  .../bindings/remoteproc/ti,pru-consumer.yaml  | 64 +++++++++++++++++++
> >  1 file changed, 64 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/remoteproc/ti,pru-consumer.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/remoteproc/ti,pru-consumer.yaml b/Documentation/devicetree/bindings/remoteproc/ti,pru-consumer.yaml
> > new file mode 100644
> > index 000000000000..2c5c5e2b6159
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/remoteproc/ti,pru-consumer.yaml
> > @@ -0,0 +1,64 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only or BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/remoteproc/ti,pru-consumer.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Common TI PRU Consumer Binding
> > +
> > +maintainers:
> > +  - Suman Anna <s-anna at ti.com>
> > +
> > +description: |
> > +  A PRU application/consumer/user node typically uses one or more PRU device
> > +  nodes to implement a PRU application/functionality. Each application/client
> > +  node would need a reference to at least a PRU node, and optionally define
> > +  some properties needed for hardware/firmware configuration. The below
> > +  properties are a list of common properties supported by the PRU remoteproc
> > +  infrastructure.
> > +
> > +  The application nodes shall define their own bindings like regular platform
> > +  devices, so below are in addition to each node's bindings.
> > +
> > +properties:
> > +  prus:
>
> ti,prus

Thank you - I will change and post v2 but with this I will run into
issues when this binding will be referenced by some consumer YAML
binding. Running dtbs_check in such case throws:
... k3-am654-base-board.dt.yaml: serial at 28000: 'ti,prus' does not
match any of the regexes: 'pinctrl-[0-9]+'
In the same time if I will remove this property from that node I am getting:
... k3-am654-base-board.dt.yaml: serial at 28000: 'ti,prus' is a required property
as expected.

Getting rid of the comma from this property name workarounds mentioned
problem (which is not proper but allows me to correctly test this
binding): e.g. s/ti,prus/ti-pruss/ or using the previous name without
a comma.
It seems to be an issue with dtbs_check itself which we will encounter
in the future.

Best regards,
Grzegorz

>
> > +    $ref: /schemas/types.yaml#/definitions/phandle-array
> > +    description: phandles to the PRU, RTU or Tx_PRU nodes used
> > +
> > +  firmware-name:
> > +    $ref: /schemas/types.yaml#/definitions/string-array
> > +    description: |
> > +      firmwares for the PRU cores, the default firmware for the core from
> > +      the PRU node will be used if not provided. The firmware names should
> > +      correspond to the PRU cores listed in the 'prus' property
> > +
> > +  ti,pruss-gp-mux-sel:
> > +    $ref: /schemas/types.yaml#/definitions/uint32-array
> > +    enum: [0, 1, 2, 3, 4]
> > +    description: |
> > +      array of values for the GP_MUX_SEL under PRUSS_GPCFG register for a PRU.
> > +      This selects the internal muxing scheme for the PRU instance. Values
> > +      should correspond to the PRU cores listed in the 'prus' property. The
> > +      GP_MUX_SEL setting is a per-slice setting (one setting for PRU0, RTU0,
> > +      and Tx_PRU0 on K3 SoCs). Use the same value for all cores within the
> > +      same slice in the associative array. If the array size is smaller than
> > +      the size of 'prus' property, the default out-of-reset value (0) for the
> > +      PRU core is used.
> > +
> > +required:
> > +  - prus
> > +
> > +dependencies:
> > +  firmware-name: [ prus ]
> > +  ti,pruss-gp-mux-sel: [ prus ]
> > +
> > +additionalProperties: true
> > +
> > +examples:
> > +  - |
> > +    /* PRU application node example */
> > +    pru-app {
> > +        prus = <&pru0>, <&pru1>;
> > +        firmware-name = "pruss-app-fw0", "pruss-app-fw1";
> > +        ti,pruss-gp-mux-sel = <2>, <1>;
> > +    };
> > --
> > 2.29.0
> >