dt-bindings: misc: xlnx,sd-fec: convert bindings to yaml
Dragan Cvetic
maintainerPATCH v3 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"
---
Changes in v3:
Fix a mistake in example, set interrupt type to 0.
--- .../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
@@ -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
@@ -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
@@ -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
Quoted 12 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 theMAINTAINERSfile.
Update the link to the new yaml file inxilinx_sdfec.rst.Signed-off-by Dragan Cvetic <[email protected]>
Quoted 12 lines
---
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"
---
Changes in v3:
Fix a mistake in example, set interrupt type to 0.
Why? That's not a correct interrupt type in most of the cases.
Was this patch tested?
...
Quoted 9 lines
Documentation/devicetree/bindings/misc/xlnx,sd-fec.yaml new file +3
-0@@ -0,0 +1,136 @@ +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) +%YAML 1.2 +---
Documentation/devicetree/bindings/misc/xlnx,sd-fec.yaml line 13
Quoted 10 lines
Documentation/devicetree/bindings/misc/xlnx,sd-fec.yaml new file +10
-0+$id: http://devicetree.org/schemas/misc/xlnx,sd-fec.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Xilinx SDFEC(16nm) IP + +maintainers: + - Cvetic, Dragan <[email protected]> + - Erim, Salih <[email protected]> + +description: |
Do not need '|' unless you need to preserve formatting.
Quoted 9 lines
Documentation/devicetree/bindings/misc/xlnx,sd-fec.yaml new file +7
-0+ 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. +
Documentation/devicetree/bindings/misc/xlnx,sd-fec.yaml line 105
Quoted 10 lines
Documentation/devicetree/bindings/misc/xlnx,sd-fec.yaml new file +10
-0+ xlnx,sdfec-dout-words: + description: | + 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. + $ref: /schemas/types.yaml#/definitions/uint32 + enum: [ 0, 1, 2 ] + +
Just one blank line.
Best regards,
Krzysztof
Cvetic, Dragan
maintainerHi Krzysztof,
Quoted 42 lines
-----Original Message-----
From: Krzysztof Kozlowski <[email protected]>
Sent: Tuesday, January 30, 2024 2:31 PM
To: Cvetic, Dragan <[email protected]>; Rob Herring <[email protected]>; Krzysztof Kozlowski <[email protected]>; Conor Dooley <[email protected]>; Kiernan, Derek <[email protected]>; Jonathan Corbet <[email protected]>; Simek, Michal <[email protected]>; Erim, Salih <[email protected]>; open list:OPEN FIRMWARE AND FLATTENED DEVICE TREE BINDINGS <[email protected]>; open list <linux- [email protected]>; open list:DOCUMENTATION <linux- [email protected]>; moderated list:ARM/ZYNQ ARCHITECTURE <linux-arm- [email protected]>
Subject: Re: [PATCH v3] dt-bindings: misc: xlnx,sd-fec: convert bindings to yamlQuoted 12 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 theMAINTAINERSfile.
Update the link to the new yaml file inxilinx_sdfec.rst.Signed-off-by Dragan Cvetic <[email protected]>Quoted 12 lines
---
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"
---
Changes in v3:
Fix a mistake in example, set interrupt type to 0.
Quoted 1 line
Why? That's not a correct interrupt type in most of the cases.
The interrupt type is set to active high in IP, cannot be changed with driver. I keep 0 to be aligned with the original document.
What do you suggest?
Quoted 3 lines
Was this patch tested?
Yes it was, both "make dt_binding_check" and "make dtbs_check" v2 was my, human mistake. I sent wrong patch. I'm sorry for that.
Quoted 16 lines
...
Review
Quoted 1 line
(quoted diff) +0
-0
b/Documentation/devicetree/bindings/misc/xlnx,sd-fec.yamlQuoted 12 lines
new file mode 100644
index 000000000000..ed87c48a9ee9Documentation/devicetree/bindings/misc/xlnx,sd-fec.yaml new file +7
-0@@ -0,0 +1,136 @@ +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/misc/xlnx,sd-fec.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Xilinx SDFEC(16nm) IP
Quoted 8 lines
Documentation/devicetree/bindings/misc/xlnx,sd-fec.yaml line 13
Quoted 6 lines
Documentation/devicetree/bindings/misc/xlnx,sd-fec.yaml new file +6
-0+ +maintainers: + - Cvetic, Dragan <[email protected]> + - Erim, Salih <[email protected]> + +description: |Do not need '|' unless you need to preserve formatting.
Accepted, will remove it.
Quoted 17 lines
Documentation/devicetree/bindings/misc/xlnx,sd-fec.yaml line 14
Quoted 2 lines
Documentation/devicetree/bindings/misc/xlnx,sd-fec.yaml new file +1
-0+ The Soft Decision Forward Error Correction (SDFEC) Engine is a Hard IPblock
Documentation/devicetree/bindings/misc/xlnx,sd-fec.yaml
Quoted 3 lines
Documentation/devicetree/bindings/misc/xlnx,sd-fec.yaml new file +3
-0+ 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 decodefunctionality
Documentation/devicetree/bindings/misc/xlnx,sd-fec.yaml
Quoted 10 lines
Documentation/devicetree/bindings/misc/xlnx,sd-fec.yaml new file +8
-0+ principally covers codes used by LTE. The FEC Engine offers significant + power and area savings versus implementations done in the FPGA fabric. + + xlnx,sdfec-dout-words: + description: | + 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
Quoted 8 lines
configures the
Documentation/devicetree/bindings/misc/xlnx,sd-fec.yaml line 105
Quoted 5 lines
Documentation/devicetree/bindings/misc/xlnx,sd-fec.yaml new file +5
-0+ DOUT_WORDS input to be supplied for each AXI transaction. + $ref: /schemas/types.yaml#/definitions/uint32 + enum: [ 0, 1, 2 ] + +Just one blank line.
Accepted, will remove it.
Kind Regards
Dragan
Quoted 44 lines · Dragan
Hi Krzysztof,
Quoted 42 lines
-----Original Message-----
From: Krzysztof Kozlowski <[email protected]>
Sent: Tuesday, January 30, 2024 2:31 PM
To: Cvetic, Dragan <[email protected]>; Rob Herring <[email protected]>; Krzysztof Kozlowski <[email protected]>; Conor Dooley <[email protected]>; Kiernan, Derek <[email protected]>; Jonathan Corbet <[email protected]>; Simek, Michal <[email protected]>; Erim, Salih <[email protected]>; open list:OPEN FIRMWARE AND FLATTENED DEVICE TREE BINDINGS <[email protected]>; open list <linux- [email protected]>; open list:DOCUMENTATION <linux- [email protected]>; moderated list:ARM/ZYNQ ARCHITECTURE <linux-arm- [email protected]>
Subject: Re: [PATCH v3] dt-bindings: misc: xlnx,sd-fec: convert bindings to yamlQuoted 24 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 theMAINTAINERSfile.
Update the link to the new yaml file inxilinx_sdfec.rst.Signed-off-by Dragan Cvetic <[email protected]>---
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"
---
Changes in v3:
Fix a mistake in example, set interrupt type to 0.
Quoted 5 lines
Quoted 1 line
Why? That's not a correct interrupt type in most of the cases.
The interrupt type is set to active high in IP, cannot be changed with driver. I keep 0 to be aligned with the original document.
What do you suggest?
Use proper type, so active high.
Best regards,
Krzysztof