Skip to contentSkip to conversation

dt-bindings: misc: xlnx,sd-fec: convert bindings to yaml

PATCH Superseded Dragan Cvetic 3 participants 4 messages Jan 29, 2024 – Jan 30, 2024

Subsystems (4)

v2 of 5 Superseded Latest is v5 →

lore
Share & tools
lore

Dragan Cvetic

author maintainer
#0 lore raw

PATCH v2 1/1 dt-bindings: misc: xlnx,sd-fec: convert bindings to yaml

Convert AMD (Xilinx) sd-fec bindings to yaml format, so it can validate dt-entries as well as any future additions to yaml.
Change in clocks is due to IP is itself configurable and only the first two clocks are in all combinations. The last 6 clocks can be present in some of them. It means order is not really fixed and any combination is possible.
Interrupt may or may not be present.
The documentation for sd-fec bindings is now YAML, so update the MAINTAINERS file.
Update the link to the new yaml file in xilinx_sdfec.rst.

---
Changes in v2:
---
Drop clocks description.
Use "contains:" with enum for optional clock-names and update comment explaining diference from the original DT binding file. Remove trailing full stops.
Add more details in sdfec-code description.
Set sdfec-code to "string" not "string-array"

---
 .../devicetree/bindings/misc/xlnx,sd-fec.txt  |  58 --------
 .../devicetree/bindings/misc/xlnx,sd-fec.yaml | 136 ++++++++++++++++++
 Documentation/misc-devices/xilinx_sdfec.rst   |   2 +-
 MAINTAINERS                                   |   2 +-
 4 files changed, 138 insertions(+), 60 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/misc/xlnx,sd-fec.txt
 create mode 100644 Documentation/devicetree/bindings/misc/xlnx,sd-fec.yaml
Documentation/devicetree/bindings/misc/xlnx,sd-fec.txt deleted +0 -58
deleted file mode 100644
index e3289634fa30..000000000000
@@ -1,58 +0,0 @@
-* Xilinx SDFEC(16nm) IP *
-
-The Soft Decision Forward Error Correction (SDFEC) Engine is a Hard IP block
-which provides high-throughput LDPC and Turbo Code implementations.
-The LDPC decode & encode functionality is capable of covering a range of
-customer specified Quasi-cyclic (QC) codes. The Turbo decode functionality
-principally covers codes used by LTE. The FEC Engine offers significant
-power and area savings versus implementations done in the FPGA fabric.
-
-
-Required properties:
-- compatible: Must be "xlnx,sd-fec-1.1"
-- clock-names : List of input clock names from the following:
-    - "core_clk", Main processing clock for processing core (required)
-    - "s_axi_aclk", AXI4-Lite memory-mapped slave interface clock (required)
-    - "s_axis_din_aclk", DIN AXI4-Stream Slave interface clock (optional)
-    - "s_axis_din_words-aclk", DIN_WORDS AXI4-Stream Slave interface clock (optional)
-    - "s_axis_ctrl_aclk",  Control input AXI4-Stream Slave interface clock (optional)
-    - "m_axis_dout_aclk", DOUT AXI4-Stream Master interface clock (optional)
-    - "m_axis_dout_words_aclk", DOUT_WORDS AXI4-Stream Master interface clock (optional)
-    - "m_axis_status_aclk", Status output AXI4-Stream Master interface clock (optional)
-- clocks : Clock phandles (see clock_bindings.txt for details).
-- reg: Should contain Xilinx SDFEC 16nm Hardened IP block registers
-  location and length.
-- xlnx,sdfec-code : Should contain "ldpc" or "turbo" to describe the codes
-  being used.
-- xlnx,sdfec-din-words : A value 0 indicates that the DIN_WORDS interface is
-  driven with a fixed value and is not present on the device, a value of 1
-  configures the DIN_WORDS to be block based, while a value of 2 configures the
-  DIN_WORDS input to be supplied for each AXI transaction.
-- xlnx,sdfec-din-width : Configures the DIN AXI stream where a value of 1
-  configures a width of "1x128b", 2 a width of "2x128b" and 4 configures a width
-  of "4x128b".
-- xlnx,sdfec-dout-words : A value 0 indicates that the DOUT_WORDS interface is
-  driven with a fixed value and is not present on the device, a value of 1
-  configures the DOUT_WORDS to be block based, while a value of 2 configures the
-  DOUT_WORDS input to be supplied for each AXI transaction.
-- xlnx,sdfec-dout-width : Configures the DOUT AXI stream where a value of 1
-  configures a width of "1x128b", 2 a width of "2x128b" and 4 configures a width
-  of "4x128b".
-Optional properties:
-- interrupts: should contain SDFEC interrupt number
-
-Example
----------------------------------------
-	sd_fec_0: sd-fec@a0040000 {
-		compatible = "xlnx,sd-fec-1.1";
-		clock-names = "core_clk","s_axi_aclk","s_axis_ctrl_aclk","s_axis_din_aclk","m_axis_status_aclk","m_axis_dout_aclk";
-		clocks = <&misc_clk_2>,<&misc_clk_0>,<&misc_clk_1>,<&misc_clk_1>,<&misc_clk_1>, <&misc_clk_1>;
-		reg = <0x0 0xa0040000 0x0 0x40000>;
-		interrupt-parent = <&axi_intc>;
-		interrupts = <1 0>;
-		xlnx,sdfec-code = "ldpc";
-		xlnx,sdfec-din-words = <0>;
-		xlnx,sdfec-din-width = <2>;
-		xlnx,sdfec-dout-words = <0>;
-		xlnx,sdfec-dout-width = <1>;
-	};
Documentation/devicetree/bindings/misc/xlnx,sd-fec.yaml new file +136 -0

136 lines not on this page · raw message

Documentation/misc-devices/xilinx_sdfec.rst +1 -1
index 8c8a289d69a3..698e6630f3a7 100644
@@ -29,7 +29,7 @@ follows:
   - Does not support shared LDPC code table wraparound
 
 The device tree entry is described in:
-`linux-xlnx/Documentation/devicetree/bindings/misc/xlnx,sd-fec.txt <https://github.com/Xilinx/linux-xlnx/blob/master/Documentation/devicetree/bindings/misc/xlnx%2Csd-fec.txt>`_
+`linux-xlnx/Documentation/devicetree/bindings/misc/xlnx,sd-fec.yaml <https://github.com/Xilinx/linux-xlnx/blob/master/Documentation/devicetree/bindings/misc/xlnx%2Csd-fec.yaml>`_
 
 
 Modes of Operation
MAINTAINERS +1 -1
index 8999497011a2..d62e04322e19 100644
@@ -24157,7 +24157,7 @@ XILINX SD-FEC IP CORES
 M:	Derek Kiernan <[email protected]>
 M:	Dragan Cvetic <[email protected]>
 S:	Maintained
-F:	Documentation/devicetree/bindings/misc/xlnx,sd-fec.txt
+F:	Documentation/devicetree/bindings/misc/xlnx,sd-fec.yaml
 F:	Documentation/misc-devices/xilinx_sdfec.rst
 F:	drivers/misc/Kconfig
 F:	drivers/misc/Makefile
Signature · 1 line
2.34.1
maintainer
#1 lore raw
Quoted 21 lines · Dragan Cvetic

Convert AMD (Xilinx) sd-fec bindings to yaml format, so it can validate dt-entries as well as any future additions to yaml.
Change in clocks is due to IP is itself configurable and only the first two clocks are in all combinations. The last 6 clocks can be present in some of them. It means order is not really fixed and any combination is possible.
Interrupt may or may not be present.
The documentation for sd-fec bindings is now YAML, so update the MAINTAINERS file.
Update the link to the new yaml file in xilinx_sdfec.rst.

---
Changes in v2:
---
Drop clocks description.
Use "contains:" with enum for optional clock-names and update comment explaining diference from the original DT binding file. Remove trailing full stops.
Add more details in sdfec-code description.
Set sdfec-code to "string" not "string-array"

Quoted 9 lines
---
 .../devicetree/bindings/misc/xlnx,sd-fec.txt  |  58 --------
 .../devicetree/bindings/misc/xlnx,sd-fec.yaml | 136 ++++++++++++++++++
 Documentation/misc-devices/xilinx_sdfec.rst   |   2 +-
 MAINTAINERS                                   |   2 +-
 4 files changed, 138 insertions(+), 60 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/misc/xlnx,sd-fec.txt
 create mode 100644 Documentation/devicetree/bindings/misc/xlnx,sd-fec.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:
Error: Documentation/devicetree/bindings/misc/xlnx,sd-fec.example.dts:32.29-30 syntax error FATAL ERROR: Unable to parse input tree
make[2]: *** [scripts/Makefile.lib:419: Documentation/devicetree/bindings/misc/xlnx,sd-fec.example.dtb] Error 1 make[2]: *** Waiting for unfinished jobs....
make[1]: *** [/builds/robherring/dt-review-ci/linux/Makefile:1428: dt_binding_check] Error 2
make: *** [Makefile:240: __sub-make] Error 2

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/[email protected]

The base for the series is generally the latest rc1. A different dependency should be noted in *this* patch.

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 after running the above command yourself. Note that DT_SCHEMA_FILES can be set to your schema file to speed up checking your schema. However, it must be unset to test all examples with your schema.

author maintainer
#2 lore raw

Hi Rob,

Quoted 45 lines

-----Original Message-----
From: Rob Herring <[email protected]>
Sent: Monday, January 29, 2024 10:21 PM
To: Cvetic, Dragan <[email protected]>
Cc: Krzysztof Kozlowski <[email protected]>; Rob Herring <[email protected]>; Simek, Michal <[email protected]>; open list:OPEN FIRMWARE AND FLATTENED DEVICE TREE BINDINGS <[email protected]>; Jonathan Corbet <[email protected]>; Kiernan, Derek <[email protected]>; moderated list:ARM/ZYNQ ARCHITECTURE <[email protected]>; open list:DOCUMENTATION <linux- [email protected]>; open list <[email protected]>; Erim, Salih <[email protected]>; Conor Dooley <[email protected]>
Subject: Re: [PATCH v2] dt-bindings: misc: xlnx,sd-fec: convert bindings to yaml

Quoted 21 lines · Dragan Cvetic

Convert AMD (Xilinx) sd-fec bindings to yaml format, so it can validate dt-entries as well as any future additions to yaml.
Change in clocks is due to IP is itself configurable and only the first two clocks are in all combinations. The last 6 clocks can be present in some of them. It means order is not really fixed and any combination is possible.
Interrupt may or may not be present.
The documentation for sd-fec bindings is now YAML, so update the MAINTAINERS file.
Update the link to the new yaml file in xilinx_sdfec.rst.

---
Changes in v2:
---
Drop clocks description.
Use "contains:" with enum for optional clock-names and update comment explaining diference from the original DT binding file. Remove trailing full stops.
Add more details in sdfec-code description.
Set sdfec-code to "string" not "string-array"

Quoted 7 lines
---
 .../devicetree/bindings/misc/xlnx,sd-fec.txt  |  58 --------
 .../devicetree/bindings/misc/xlnx,sd-fec.yaml | 136 ++++++++++++++++++
 Documentation/misc-devices/xilinx_sdfec.rst   |   2 +-
 MAINTAINERS                                   |   2 +-
 4 files changed, 138 insertions(+), 60 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/misc/xlnx,sd-
Quoted 7 lines

fec.txt

Quoted 1 line
 create mode 100644 Documentation/devicetree/bindings/misc/xlnx,sd-

fec.yaml

Quoted 1 line

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'

Accepted, will do it.

Quoted 27 lines

on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:

dtschema/dtc warnings/errors:
Error: Documentation/devicetree/bindings/misc/xlnx,sd- fec.example.dts:32.29-30 syntax error
FATAL ERROR: Unable to parse input tree
make[2]: *** [scripts/Makefile.lib:419:
Documentation/devicetree/bindings/misc/xlnx,sd-fec.example.dtb] Error 1 make[2]: *** Waiting for unfinished jobs....
make[1]: *** [/builds/robherring/dt-review-ci/linux/Makefile:1428:
dt_binding_check] Error 2
make: *** [Makefile:240: __sub-make] Error 2

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-
bindings/patch/[email protected]

The base for the series is generally the latest rc1. A different dependency should be noted in *this* patch.

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:

Quoted 6 lines

pip3 install dtschema --upgrade

Please check and re-submit after running the above command yourself. Note that DT_SCHEMA_FILES can be set to your schema file to speed up checking your schema. However, it must be unset to test all examples with your schema.

All comments accepted

Kind Regards
Dragan

#3 lore raw
Quoted 49 lines · Dragan

Hi Rob,

Quoted 47 lines

-----Original Message-----
From: Rob Herring <[email protected]>
Sent: Monday, January 29, 2024 10:21 PM
To: Cvetic, Dragan <[email protected]>
Cc: Krzysztof Kozlowski <[email protected]>; Rob Herring <[email protected]>; Simek, Michal <[email protected]>; open list:OPEN FIRMWARE AND FLATTENED DEVICE TREE BINDINGS <[email protected]>; Jonathan Corbet <[email protected]>; Kiernan, Derek <[email protected]>; moderated list:ARM/ZYNQ ARCHITECTURE <[email protected]>; open list:DOCUMENTATION <linux- [email protected]>; open list <[email protected]>; Erim, Salih <[email protected]>; Conor Dooley <[email protected]>
Subject: Re: [PATCH v2] dt-bindings: misc: xlnx,sd-fec: convert bindings to yaml

Quoted 21 lines · Dragan Cvetic

Convert AMD (Xilinx) sd-fec bindings to yaml format, so it can validate dt-entries as well as any future additions to yaml.
Change in clocks is due to IP is itself configurable and only the first two clocks are in all combinations. The last 6 clocks can be present in some of them. It means order is not really fixed and any combination is possible.
Interrupt may or may not be present.
The documentation for sd-fec bindings is now YAML, so update the MAINTAINERS file.
Update the link to the new yaml file in xilinx_sdfec.rst.

---
Changes in v2:
---
Drop clocks description.
Use "contains:" with enum for optional clock-names and update comment explaining diference from the original DT binding file. Remove trailing full stops.
Add more details in sdfec-code description.
Set sdfec-code to "string" not "string-array"

Quoted 7 lines
---
 .../devicetree/bindings/misc/xlnx,sd-fec.txt  |  58 --------
 .../devicetree/bindings/misc/xlnx,sd-fec.yaml | 136 ++++++++++++++++++
 Documentation/misc-devices/xilinx_sdfec.rst   |   2 +-
 MAINTAINERS                                   |   2 +-
 4 files changed, 138 insertions(+), 60 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/misc/xlnx,sd-

fec.txt

Quoted 1 line
 create mode 100644 Documentation/devicetree/bindings/misc/xlnx,sd-
Quoted 8 lines
Quoted 5 lines

fec.yaml

Quoted 1 line

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'

Accepted, will do it.

There is nothing to accept here, but instead please test your patches *before* sending them.

Best regards,
Krzysztof