Work is currently being done to add the phy-ocelot-serdes driver to a
non-syscon configuration. Doing so will require updates to the
documentation.
I can certainly wait until that change set to submit this, but I feel
sooner is better than later for Documentation format updates. Also,
those updates likely won't be ready before this next merge window.
The only liberty I took was adding Alexandre and UNGLinuxDriver as the
maintainers, otherwise the content should be the same.
Colin Foster (1):
dt-bindings: phy: ocelot-serdes: convert to YAML
.../bindings/phy/phy-ocelot-serdes.txt | 43 -------------
.../bindings/phy/phy-ocelot-serdes.yaml | 61 +++++++++++++++++++
MAINTAINERS | 1 +
3 files changed, 62 insertions(+), 43 deletions(-)
delete mode 100644 Documentation/devicetree/bindings/phy/phy-ocelot-serdes.txt
create mode 100644 Documentation/devicetree/bindings/phy/phy-ocelot-serdes.yaml
--
2.25.1
Convert the phy-ocelot-serdes device tree binding to the new YAML format.
Additionally, add the file to MAINTAINERS since the original file didn't
exist.
Signed-off-by: Colin Foster <[email protected]>
---
.../bindings/phy/phy-ocelot-serdes.txt | 43 -------------
.../bindings/phy/phy-ocelot-serdes.yaml | 61 +++++++++++++++++++
MAINTAINERS | 1 +
3 files changed, 62 insertions(+), 43 deletions(-)
delete mode 100644 Documentation/devicetree/bindings/phy/phy-ocelot-serdes.txt
create mode 100644 Documentation/devicetree/bindings/phy/phy-ocelot-serdes.yaml
diff --git a/Documentation/devicetree/bindings/phy/phy-ocelot-serdes.txt b/Documentation/devicetree/bindings/phy/phy-ocelot-serdes.txt
deleted file mode 100644
index 332219860187..000000000000
--- a/Documentation/devicetree/bindings/phy/phy-ocelot-serdes.txt
+++ /dev/null
@@ -1,43 +0,0 @@
-Microsemi Ocelot SerDes muxing driver
--------------------------------------
-
-On Microsemi Ocelot, there is a handful of registers in HSIO address
-space for setting up the SerDes to switch port muxing.
-
-A SerDes X can be "muxed" to work with switch port Y or Z for example.
-One specific SerDes can also be used as a PCIe interface.
-
-Hence, a SerDes represents an interface, be it an Ethernet or a PCIe one.
-
-There are two kinds of SerDes: SERDES1G supports 10/100Mbps in
-half/full-duplex and 1000Mbps in full-duplex mode while SERDES6G supports
-10/100Mbps in half/full-duplex and 1000/2500Mbps in full-duplex mode.
-
-Also, SERDES6G number (aka "macro") 0 is the only interface supporting
-QSGMII.
-
-This is a child of the HSIO syscon ("mscc,ocelot-hsio", see
-Documentation/devicetree/bindings/mips/mscc.txt) on the Microsemi Ocelot.
-
-Required properties:
-
-- compatible: should be "mscc,vsc7514-serdes"
-- #phy-cells : from the generic phy bindings, must be 2.
- The first number defines the input port to use for a given
- SerDes macro. The second defines the macro to use. They are
- defined in dt-bindings/phy/phy-ocelot-serdes.h
-
-Example:
-
- serdes: serdes {
- compatible = "mscc,vsc7514-serdes";
- #phy-cells = <2>;
- };
-
- ethernet {
- port1 {
- phy-handle = <&phy_foo>;
- /* Link SERDES1G_5 to port1 */
- phys = <&serdes 1 SERDES1G_5>;
- };
- };
diff --git a/Documentation/devicetree/bindings/phy/phy-ocelot-serdes.yaml b/Documentation/devicetree/bindings/phy/phy-ocelot-serdes.yaml
new file mode 100644
index 000000000000..0666974d886a
--- /dev/null
+++ b/Documentation/devicetree/bindings/phy/phy-ocelot-serdes.yaml
@@ -0,0 +1,61 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/phy/phy-ocelot-serdes.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Microsemi Ocelot SerDes muxing driver
+
+maintainers:
+ - Alexandre Belloni <[email protected]>
+ - [email protected]
+
+description: |
+ On Microsemi Ocelot, there is a handful of registers in HSIO address
+ space for setting up the SerDes to switch port muxing.
+
+ A SerDes X can be "muxed" to work with switch port Y or Z for example.
+ One specific SerDes can also be used as a PCIe interface.
+
+ Hence, a SerDes represents an interface, be it an Ethernet or a PCIe one.
+
+ There are two kinds of SerDes: SERDES1G supports 10/100Mbps in
+ half/full-duplex and 1000Mbps in full-duplex mode while SERDES6G supports
+ 10/100Mbps in half/full-duplex and 1000/2500Mbps in full-duplex mode.
+
+ Also, SERDES6G number (aka "macro") 0 is the only interface supporting
+ QSGMII.
+
+ This is a child of the HSIO syscon ("mscc,ocelot-hsio", see
+ Documentation/devicetree/bindings/mips/mscc.txt) on the Microsemi Ocelot.
+
+properties:
+ compatible:
+ enum:
+ - mscc,vsc7514-serdes
+ "#phy-cells":
+ const: 2
+ description: |
+ from the generic phy bindings, must be 2. The first number
+ defines the input port to use for a given SerDes macro. The
+ second defines the macro to use. They are defined in
+ dt-bindings/phy/phy-ocelot-serdes.h
+
+required:
+ - compatible
+ - "#phy-cells"
+
+examlpes:
+ - |
+ serdes: serdes {
+ compatible = "mscc,vsc7514-serdes";
+ #phy-cells = <2>;
+ };
+
+ ethernet {
+ port1 {
+ phy-handle = <&phy_foo>;
+ /* Link SERDES1G_5 to port1 */
+ phys = <&serdes 1 SERDES1G_5>;
+ };
+ };
diff --git a/MAINTAINERS b/MAINTAINERS
index 714fd8b45e5a..10dd3c6ad6ad 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -13481,6 +13481,7 @@ M: [email protected]
L: [email protected]
S: Supported
F: Documentation/devicetree/bindings/mips/mscc.txt
+F: Documentation/devicetree/bindings/phy/phy-ocelot-serdes.yaml
F: Documentation/devicetree/bindings/pinctrl/mscc,ocelot-pinctrl.yaml
F: Documentation/devicetree/bindings/power/reset/ocelot-reset.txt
F: arch/mips/boot/dts/mscc/
--
2.25.1
On 23/08/2022 09:00, Colin Foster wrote:
> Convert the phy-ocelot-serdes device tree binding to the new YAML format.
>
> Additionally, add the file to MAINTAINERS since the original file didn't
> exist.
>
> Signed-off-by: Colin Foster <[email protected]>
> ---
> .../bindings/phy/phy-ocelot-serdes.txt | 43 -------------
> .../bindings/phy/phy-ocelot-serdes.yaml | 61 +++++++++++++++++++
> MAINTAINERS | 1 +
> 3 files changed, 62 insertions(+), 43 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/phy/phy-ocelot-serdes.txt
> create mode 100644 Documentation/devicetree/bindings/phy/phy-ocelot-serdes.yaml
Filename based on compatible, so
mscc,vsc7514-serdes.yaml
>
> diff --git a/Documentation/devicetree/bindings/phy/phy-ocelot-serdes.yaml b/Documentation/devicetree/bindings/phy/phy-ocelot-serdes.yaml
> new file mode 100644
> index 000000000000..0666974d886a
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/phy/phy-ocelot-serdes.yaml
> @@ -0,0 +1,61 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/phy/phy-ocelot-serdes.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Microsemi Ocelot SerDes muxing driver
s/driver//
Bindings are for hardware, not for Linux drivers.
> +
> +maintainers:
> + - Alexandre Belloni <[email protected]>
> + - [email protected]
> +
> +description: |
> + On Microsemi Ocelot, there is a handful of registers in HSIO address
> + space for setting up the SerDes to switch port muxing.
> +
> + A SerDes X can be "muxed" to work with switch port Y or Z for example.
> + One specific SerDes can also be used as a PCIe interface.
> +
> + Hence, a SerDes represents an interface, be it an Ethernet or a PCIe one.
> +
> + There are two kinds of SerDes: SERDES1G supports 10/100Mbps in
> + half/full-duplex and 1000Mbps in full-duplex mode while SERDES6G supports
> + 10/100Mbps in half/full-duplex and 1000/2500Mbps in full-duplex mode.
> +
> + Also, SERDES6G number (aka "macro") 0 is the only interface supporting
> + QSGMII.
> +
> + This is a child of the HSIO syscon ("mscc,ocelot-hsio", see
> + Documentation/devicetree/bindings/mips/mscc.txt) on the Microsemi Ocelot.
> +
> +properties:
> + compatible:
> + enum:
> + - mscc,vsc7514-serdes
Missing blank line
> + "#phy-cells":
> + const: 2
> + description: |
> + from the generic phy bindings, must be 2.
Skip first sentence, it's obvious.
The first number
> + defines the input port to use for a given SerDes macro. The
> + second defines the macro to use. They are defined in
> + dt-bindings/phy/phy-ocelot-serdes.h
> +
> +required:
> + - compatible
> + - "#phy-cells"
Missing additionalProperties: false
Base your YAML on example-schema.
> +
> +examlpes:
Typo.
> + - |
> + serdes: serdes {
> + compatible = "mscc,vsc7514-serdes";
> + #phy-cells = <2>;
> + };
> +
> + ethernet {
> + port1 {
> + phy-handle = <&phy_foo>;
> + /* Link SERDES1G_5 to port1 */
> + phys = <&serdes 1 SERDES1G_5>;
> + };
> + };
Skip consumer examples in provider bindings. They're obvious.
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 714fd8b45e5a..10dd3c6ad6ad 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -13481,6 +13481,7 @@ M: [email protected]
> L: [email protected]
> S: Supported
> F: Documentation/devicetree/bindings/mips/mscc.txt
> +F: Documentation/devicetree/bindings/phy/phy-ocelot-serdes.yaml
> F: Documentation/devicetree/bindings/pinctrl/mscc,ocelot-pinctrl.yaml
> F: Documentation/devicetree/bindings/power/reset/ocelot-reset.txt
> F: arch/mips/boot/dts/mscc/
Best regards,
Krzysztof
On Mon, 22 Aug 2022 23:00:52 -0700, Colin Foster wrote:
> Convert the phy-ocelot-serdes device tree binding to the new YAML format.
>
> Additionally, add the file to MAINTAINERS since the original file didn't
> exist.
>
> Signed-off-by: Colin Foster <[email protected]>
> ---
> .../bindings/phy/phy-ocelot-serdes.txt | 43 -------------
> .../bindings/phy/phy-ocelot-serdes.yaml | 61 +++++++++++++++++++
> MAINTAINERS | 1 +
> 3 files changed, 62 insertions(+), 43 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/phy/phy-ocelot-serdes.txt
> create mode 100644 Documentation/devicetree/bindings/phy/phy-ocelot-serdes.yaml
>
My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):
yamllint warnings/errors:
dtschema/dtc warnings/errors:
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/phy/phy-ocelot-serdes.yaml: 'examlpes' is not one of ['$id', '$schema', 'title', 'description', 'examples', 'required', 'allOf', 'anyOf', 'oneOf', 'definitions', '$defs', 'additionalProperties', 'dependencies', 'dependentRequired', 'dependentSchemas', 'patternProperties', 'properties', 'if', 'then', 'else', 'unevaluatedProperties', 'deprecated', 'maintainers', 'select', '$ref']
from schema $id: http://devicetree.org/meta-schemas/base.yaml#
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/phy/phy-ocelot-serdes.yaml: 'oneOf' conditional failed, one must be fixed:
'unevaluatedProperties' is a required property
'additionalProperties' is a required property
hint: Either unevaluatedProperties or additionalProperties must be present
from schema $id: http://devicetree.org/meta-schemas/core.yaml#
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/phy/phy-ocelot-serdes.yaml: ignoring, error in schema:
doc reference errors (make refcheckdocs):
See https://patchwork.ozlabs.org/patch/
This check can fail if there are any dependencies. The base for a patch
series is generally the most recent rc1.
If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:
pip3 install dtschema --upgrade
Please check and re-submit.
Hi Krzysztof,
Thanks for the feedback! I'll make these changes for v2. I'm out next
week and don't want to send-and-run, so it might be the following week
when I get around to it.
On Tue, Aug 23, 2022 at 11:36:29AM +0300, Krzysztof Kozlowski wrote:
> On 23/08/2022 09:00, Colin Foster wrote:
> > Convert the phy-ocelot-serdes device tree binding to the new YAML format.
> >
> > Additionally, add the file to MAINTAINERS since the original file didn't
> > exist.
> >
> > Signed-off-by: Colin Foster <[email protected]>
> > ---
> > .../bindings/phy/phy-ocelot-serdes.txt | 43 -------------
> > .../bindings/phy/phy-ocelot-serdes.yaml | 61 +++++++++++++++++++
> > MAINTAINERS | 1 +
> > 3 files changed, 62 insertions(+), 43 deletions(-)
> > delete mode 100644 Documentation/devicetree/bindings/phy/phy-ocelot-serdes.txt
> > create mode 100644 Documentation/devicetree/bindings/phy/phy-ocelot-serdes.yaml
>
> Filename based on compatible, so
> mscc,vsc7514-serdes.yaml
>
> >
>
>
> > diff --git a/Documentation/devicetree/bindings/phy/phy-ocelot-serdes.yaml b/Documentation/devicetree/bindings/phy/phy-ocelot-serdes.yaml
> > new file mode 100644
> > index 000000000000..0666974d886a
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/phy/phy-ocelot-serdes.yaml
> > @@ -0,0 +1,61 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/phy/phy-ocelot-serdes.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Microsemi Ocelot SerDes muxing driver
>
> s/driver//
>
> Bindings are for hardware, not for Linux drivers.
>
> > +
> > +maintainers:
> > + - Alexandre Belloni <[email protected]>
> > + - [email protected]
> > +
> > +description: |
> > + On Microsemi Ocelot, there is a handful of registers in HSIO address
> > + space for setting up the SerDes to switch port muxing.
> > +
> > + A SerDes X can be "muxed" to work with switch port Y or Z for example.
> > + One specific SerDes can also be used as a PCIe interface.
> > +
> > + Hence, a SerDes represents an interface, be it an Ethernet or a PCIe one.
> > +
> > + There are two kinds of SerDes: SERDES1G supports 10/100Mbps in
> > + half/full-duplex and 1000Mbps in full-duplex mode while SERDES6G supports
> > + 10/100Mbps in half/full-duplex and 1000/2500Mbps in full-duplex mode.
> > +
> > + Also, SERDES6G number (aka "macro") 0 is the only interface supporting
> > + QSGMII.
> > +
> > + This is a child of the HSIO syscon ("mscc,ocelot-hsio", see
> > + Documentation/devicetree/bindings/mips/mscc.txt) on the Microsemi Ocelot.
> > +
> > +properties:
> > + compatible:
> > + enum:
> > + - mscc,vsc7514-serdes
>
> Missing blank line
>
> > + "#phy-cells":
> > + const: 2
> > + description: |
> > + from the generic phy bindings, must be 2.
>
> Skip first sentence, it's obvious.
>
> The first number
> > + defines the input port to use for a given SerDes macro. The
> > + second defines the macro to use. They are defined in
> > + dt-bindings/phy/phy-ocelot-serdes.h
> > +
> > +required:
> > + - compatible
> > + - "#phy-cells"
>
> Missing additionalProperties: false
>
> Base your YAML on example-schema.
>
> > +
> > +examlpes:
>
> Typo.
>
>
> > + - |
> > + serdes: serdes {
> > + compatible = "mscc,vsc7514-serdes";
> > + #phy-cells = <2>;
> > + };
> > +
> > + ethernet {
> > + port1 {
> > + phy-handle = <&phy_foo>;
> > + /* Link SERDES1G_5 to port1 */
> > + phys = <&serdes 1 SERDES1G_5>;
> > + };
> > + };
>
> Skip consumer examples in provider bindings. They're obvious.
>
> > diff --git a/MAINTAINERS b/MAINTAINERS
> > index 714fd8b45e5a..10dd3c6ad6ad 100644
> > --- a/MAINTAINERS
> > +++ b/MAINTAINERS
> > @@ -13481,6 +13481,7 @@ M: [email protected]
> > L: [email protected]
> > S: Supported
> > F: Documentation/devicetree/bindings/mips/mscc.txt
> > +F: Documentation/devicetree/bindings/phy/phy-ocelot-serdes.yaml
> > F: Documentation/devicetree/bindings/pinctrl/mscc,ocelot-pinctrl.yaml
> > F: Documentation/devicetree/bindings/power/reset/ocelot-reset.txt
> > F: arch/mips/boot/dts/mscc/
>
>
> Best regards,
> Krzysztof
Thanks Rob,
I'll fix this up for v2. I ran sanity checks before submitting, but
apparently not all the correct ones.
On Tue, Aug 23, 2022 at 01:47:07PM -0500, Rob Herring wrote:
> On Mon, 22 Aug 2022 23:00:52 -0700, Colin Foster wrote:
> > Convert the phy-ocelot-serdes device tree binding to the new YAML format.
> >
> > Additionally, add the file to MAINTAINERS since the original file didn't
> > exist.
> >
> > Signed-off-by: Colin Foster <[email protected]>
> > ---
> > .../bindings/phy/phy-ocelot-serdes.txt | 43 -------------
> > .../bindings/phy/phy-ocelot-serdes.yaml | 61 +++++++++++++++++++
> > MAINTAINERS | 1 +
> > 3 files changed, 62 insertions(+), 43 deletions(-)
> > delete mode 100644 Documentation/devicetree/bindings/phy/phy-ocelot-serdes.txt
> > create mode 100644 Documentation/devicetree/bindings/phy/phy-ocelot-serdes.yaml
> >
>
> My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
> on your patch (DT_CHECKER_FLAGS is new in v5.13):
>
> yamllint warnings/errors:
>
> dtschema/dtc warnings/errors:
> /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/phy/phy-ocelot-serdes.yaml: 'examlpes' is not one of ['$id', '$schema', 'title', 'description', 'examples', 'required', 'allOf', 'anyOf', 'oneOf', 'definitions', '$defs', 'additionalProperties', 'dependencies', 'dependentRequired', 'dependentSchemas', 'patternProperties', 'properties', 'if', 'then', 'else', 'unevaluatedProperties', 'deprecated', 'maintainers', 'select', '$ref']
> from schema $id: http://devicetree.org/meta-schemas/base.yaml#
> /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/phy/phy-ocelot-serdes.yaml: 'oneOf' conditional failed, one must be fixed:
> 'unevaluatedProperties' is a required property
> 'additionalProperties' is a required property
> hint: Either unevaluatedProperties or additionalProperties must be present
> from schema $id: http://devicetree.org/meta-schemas/core.yaml#
> /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/phy/phy-ocelot-serdes.yaml: ignoring, error in schema:
>
> doc reference errors (make refcheckdocs):
>
> See https://patchwork.ozlabs.org/patch/
>
> This check can fail if there are any dependencies. The base for a patch
> series is generally the most recent rc1.
>
> If you already ran 'make dt_binding_check' and didn't see the above
> error(s), then make sure 'yamllint' is installed and dt-schema is up to
> date:
>
> pip3 install dtschema --upgrade
>
> Please check and re-submit.
>