[net-next,v2,01/10] dt-bindings: net: add the dpaa2-mac DTS definition

Add a documentation entry for the DTS bindings needed and supported by
the dpaa2-mac driver.

Signed-off-by: Ioana Ciornei <ioana.ciornei@nxp.com>
---
Changes in v2:
 - new patch

 .../devicetree/bindings/net/dpaa2-mac.yaml    | 55 +++++++++++++++++++
 1 file changed, 55 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/net/dpaa2-mac.yaml

On Sat, Oct 03, 2020 at 12:07:28AM +0300, Ioana Ciornei wrote:
> Add a documentation entry for the DTS bindings needed and supported by
> the dpaa2-mac driver.
> 
> Signed-off-by: Ioana Ciornei <ioana.ciornei@nxp.com>
> ---
> Changes in v2:
>  - new patch
> 
>  .../devicetree/bindings/net/dpaa2-mac.yaml    | 55 +++++++++++++++++++

Use the compatible string for the filename.

>  1 file changed, 55 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/net/dpaa2-mac.yaml
> 
> diff --git a/Documentation/devicetree/bindings/net/dpaa2-mac.yaml b/Documentation/devicetree/bindings/net/dpaa2-mac.yaml
> new file mode 100644
> index 000000000000..744b0590278d
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/dpaa2-mac.yaml
> @@ -0,0 +1,55 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/net/dpaa2-mac.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: DPAA2 MAC bindings
> +
> +maintainers:
> +  - Ioana Ciornei <ioana.ciornei@nxp.com>
> +
> +description:
> +  This binding represents the DPAA2 MAC objects found on the fsl-mc bus and
> +  located under the 'dpmacs' node for the fsl-mc bus DTS node.

Need $ref to ethernet-controller.yaml

> +
> +properties:
> +  compatible:
> +    const: "fsl,qoriq-mc-dpmac"

Don't need quotes.

> +
> +  reg:
> +    maxItems: 1
> +    description: The DPMAC number
> +
> +  phy-handle: true
> +
> +  phy-connection-type: true
> +
> +  phy-mode: true
> +
> +  pcs-handle:
> +    $ref: /schemas/types.yaml#definitions/phandle
> +    description:
> +      A reference to a node representing a PCS PHY device found on
> +      the internal MDIO bus.

Perhaps use the 'phys' binding? (Too many PHYs with ethernet...)

This would be the on-chip XAUI/SerDes phy? That's typically 'phys' where 
as 'phy-handle' is ethernet PHY. 

> +
> +  managed: true
> +
> +required:
> +  - reg

addtionalProperties: false

> +
> +examples:
> +  - |
> +    dpmacs {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +
> +      dpmac@4 {

ethernet@4

> +        compatible = "fsl,qoriq-mc-dpmac";
> +        reg = <0x4>;
> +        phy-handle = <&mdio1_phy6>;
> +        phy-connection-type = "qsgmii";
> +        managed = "in-band-status";
> +        pcs-handle = <&pcs3_1>;
> +      };
> +    };
> -- 
> 2.28.0
>

On Tue, Oct 06, 2020 at 03:56:35PM -0500, Rob Herring wrote:
> On Sat, Oct 03, 2020 at 12:07:28AM +0300, Ioana Ciornei wrote:
> > Add a documentation entry for the DTS bindings needed and supported by
> > the dpaa2-mac driver.
> > 
> > Signed-off-by: Ioana Ciornei <ioana.ciornei@nxp.com>
> > ---
> > Changes in v2:
> >  - new patch
> > 
> >  .../devicetree/bindings/net/dpaa2-mac.yaml    | 55 +++++++++++++++++++
> 
> Use the compatible string for the filename.

Sure.

> > +title: DPAA2 MAC bindings
> > +
> > +maintainers:
> > +  - Ioana Ciornei <ioana.ciornei@nxp.com>
> > +
> > +description:
> > +  This binding represents the DPAA2 MAC objects found on the fsl-mc bus and
> > +  located under the 'dpmacs' node for the fsl-mc bus DTS node.
> 
> Need $ref to ethernet-controller.yaml
> 
> > +
> > +properties:
> > +  compatible:
> > +    const: "fsl,qoriq-mc-dpmac"
> 
> Don't need quotes.

Got it.

> 
> > +
> > +  reg:
> > +    maxItems: 1
> > +    description: The DPMAC number
> > +
> > +  phy-handle: true
> > +
> > +  phy-connection-type: true
> > +
> > +  phy-mode: true
> > +
> > +  pcs-handle:
> > +    $ref: /schemas/types.yaml#definitions/phandle
> > +    description:
> > +      A reference to a node representing a PCS PHY device found on
> > +      the internal MDIO bus.
> 
> Perhaps use the 'phys' binding? (Too many PHYs with ethernet...)
> 
> This would be the on-chip XAUI/SerDes phy? That's typically 'phys' where 
> as 'phy-handle' is ethernet PHY. 
> 

The PCS deals with proper coding (8b/10b, 64b/66b) and auto-negotiation
between the MAC and whatever is connected to it. It is, logically
speaking, above the SERDES which implements the physical layer
(PMA/PMD). We are not describing or configuring electrical parameters of
SERDES lanes and such here, we are just referencing the PCS found on the
internal MDIO bus of the MAC.

> > +
> > +  managed: true
> > +
> > +required:
> > +  - reg
> 
> addtionalProperties: false

Ok, I'll add it.
I didn't find a reference to it in the writing-schema.rst. I think that
would have helped.

> 
> > +
> > +examples:
> > +  - |
> > +    dpmacs {
> > +      #address-cells = <1>;
> > +      #size-cells = <0>;
> > +
> > +      dpmac@4 {
> 
> ethernet@4

Ok.

> 
> > +        compatible = "fsl,qoriq-mc-dpmac";
> > +        reg = <0x4>;
> > +        phy-handle = <&mdio1_phy6>;
> > +        phy-connection-type = "qsgmii";
> > +        managed = "in-band-status";
> > +        pcs-handle = <&pcs3_1>;
> > +      };
> > +    };
> > -- 
> > 2.28.0
> >