dt-bindings: axis-fifo: Added missing binding
Subsystems (2)
PATCH 1/1 dt-bindings: axis-fifo: Added missing binding
drivers/staging/axis-fifo/axis-fifo.txt file described how the devicetree of the driver should look like. Convert it to .yaml file. Issue found by checkpatch.
--- .../axis-fifo/xlnx,axi-fifo-mm-s.yaml | 257 ++++++++++++++++++ 1 file changed, 257 insertions(+) create mode 100644 Documentation/devicetree/bindings/axis-fifo/xlnx,axi-fifo-mm-s.yaml
Documentation/devicetree/bindings/axis-fifo/xlnx,axi-fifo-mm-s.yaml new file +257 -0
@@ -0,0 +1,257 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/axis-fifo/xlnx,axi-fifo-mm-s.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Xilinx AXI-Stream FIFO v4.1 IP core + +maintainers: + - Daniel Matyas <[email protected]> + +description: | + This IP core has read and write AXI-Stream FIFOs, the contents of which can + be accessed from the AXI4 memory-mapped interface. This is useful for + transferring data from a processor into the FPGA fabric. The driver creates + a character device that can be read/written to with standard + open/read/write/close. + + See Xilinx PG080 document for IP details. + + Currently supports only store-forward mode with a 32-bit AXI4-Lite + interface. DOES NOT support: + - cut-through mode + - AXI4 (non-lite) + +properties: + compatible: + enum: + - xlnx,axis-fifo-mm-s-4.1 + - xlnx,axis-fifo-mm-s-4.2 + - xlnx,axis-fifo-mm-s-4.3 + + interrupt-names: + const: interrupt + + interrupts: + maxItems: 1 + + reg: + maxItems: 1 + + xlnx,axi-str-rxd-protocol: + $ref: /schemas/types.yaml#/definitions/string + const: XIL_AXI_STREAM_ETH_DATA + description: AXI4-Stream RX data protocol + + xlnx,axi-str-rxd-tdata-width: + $ref: /schemas/types.yaml#/definitions/uint32 + const: 0x20 + description: AXI4-Stream RX data width + + xlnx,axi-str-txc-protocol: + $ref: /schemas/types.yaml#/definitions/string + const: XIL_AXI_STREAM_ETH_CTRL + description: AXI4-Stream TX control protocol + + xlnx,axi-str-txc-tdata-width: + $ref: /schemas/types.yaml#/definitions/uint32 + const: 0x20 + description: AXI4-Stream TX control data width + + xlnx,axi-str-txd-protocol: + $ref: /schemas/types.yaml#/definitions/string + const: XIL_AXI_STREAM_ETH_DATA + description: AXI4-Stream TX data protocol + + xlnx,axi-str-txd-tdata-width: + $ref: /schemas/types.yaml#/definitions/uint32 + const: 0x20 + description: AXI4-Stream TX data width + + xlnx,axis-tdest-width: + $ref: /schemas/types.yaml#/definitions/uint32 + description: AXI-Stream TDEST width (ignored by the driver) + + xlnx,axis-tid-width: + $ref: /schemas/types.yaml#/definitions/uint32 + description: AXI-Stream TID width (ignored by the driver) + + xlnx,axis-tuser-width: + $ref: /schemas/types.yaml#/definitions/uint32 + description: AXI-Stream TUSER width (ignored by the driver) + + xlnx,data-interface-type: + $ref: /schemas/types.yaml#/definitions/uint32 + const: 0x0 + description: ignored by the driver + + xlnx,has-axis-tdest: + $ref: /schemas/types.yaml#/definitions/uint32 + const: 0x0 + description: this feature isn't supported + + xlnx,has-axis-tid: + $ref: /schemas/types.yaml#/definitions/uint32 + const: 0x0 + description: this feature isn't supported + + xlnx,has-axis-tkeep: + $ref: /schemas/types.yaml#/definitions/uint32 + const: 0x0 + description: this feature isn't supported + + xlnx,has-axis-tstrb: + $ref: /schemas/types.yaml#/definitions/uint32 + const: 0x0 + description: this feature isn't supported + + xlnx,has-axis-tuser: + $ref: /schemas/types.yaml#/definitions/uint32 + const: 0x0 + description: this feature isn't supported + + xlnx,rx-fifo-depth: + $ref: /schemas/types.yaml#/definitions/uint32 + description: Depth of RX FIFO in words + + xlnx,rx-fifo-pe-threshold: + $ref: /schemas/types.yaml#/definitions/uint32 + description: RX programmable empty interrupt threshold + (ignored by the driver) + + xlnx,rx-fifo-pf-threshold: + $ref: /schemas/types.yaml#/definitions/uint32 + description: RX programmable full interrupt threshold + (ignored by the driver) + + xlnx,s-axi-id-width: + $ref: /schemas/types.yaml#/definitions/uint32 + const: 0x4 + description: ignored by the driver + + xlnx,s-axi4-data-width: + $ref: /schemas/types.yaml#/definitions/uint32 + const: 0x20 + description: ignored by the driver + + xlnx,select-xpm: + $ref: /schemas/types.yaml#/definitions/uint32 + const: 0x0 + description: ignored by the driver + + xlnx,tx-fifo-depth: + $ref: /schemas/types.yaml#/definitions/uint32 + description: Depth of TX FIFO in words + + xlnx,tx-fifo-pe-threshold: + $ref: /schemas/types.yaml#/definitions/uint32 + description: TX programmable empty interrupt threshold + (ignored by the driver) + + xlnx,tx-fifo-pf-threshold: + $ref: /schemas/types.yaml#/definitions/uint32 + description: TX programmable full interrupt threshold + (ignored by the driver) + + xlnx,use-rx-cut-through: + $ref: /schemas/types.yaml#/definitions/uint32 + const: 0x0 + description: this feature isn't supported + + xlnx,use-rx-data: + $ref: /schemas/types.yaml#/definitions/uint32 + enum: [0x0, 0x1] + description: <0x1> if RX FIFO is enabled, <0x0> otherwise + + xlnx,use-tx-ctrl: + $ref: /schemas/types.yaml#/definitions/uint32 + const: 0x0 + description: this feature isn't supported + + xlnx,use-tx-cut-through: + $ref: /schemas/types.yaml#/definitions/uint32 + const: 0x0 + description: this feature isn't supported + + xlnx,use-tx-data: + $ref: /schemas/types.yaml#/definitions/uint32 + enum: [0x0, 0x1] + description: <0x1> if TX FIFO is enabled, <0x0> otherwise + +required: + - compatible + - interrupt-names + - interrupts + - reg + - xlnx,axi-str-rxd-protocol + - xlnx,axi-str-rxd-tdata-width + - xlnx,axi-str-txc-protocol + - xlnx,axi-str-txc-tdata-width + - xlnx,axi-str-txd-protocol + - xlnx,axi-str-txd-tdata-width + - xlnx,axis-tdest-width + - xlnx,axis-tid-width + - xlnx,axis-tuser-width + - xlnx,data-interface-type + - xlnx,has-axis-tdest + - xlnx,has-axis-tid + - xlnx,has-axis-tkeep + - xlnx,has-axis-tstrb + - xlnx,has-axis-tuser + - xlnx,rx-fifo-depth + - xlnx,rx-fifo-pe-threshold + - xlnx,rx-fifo-pf-threshold + - xlnx,s-axi-id-width + - xlnx,s-axi4-data-width + - xlnx,select-xpm + - xlnx,tx-fifo-depth + - xlnx,tx-fifo-pe-threshold + - xlnx,tx-fifo-pf-threshold + - xlnx,use-rx-cut-through + - xlnx,use-rx-data + - xlnx,use-tx-ctrl + - xlnx,use-tx-cut-through + - xlnx,use-tx-data + +additionalProperties: false + +examples: + - | + axi_fifo_mm_s_0: axi_fifo_mm_s@43c00000 { + compatible = "xlnx,axi-fifo-mm-s-4.1"; + interrupt-names = "interrupt"; + interrupt-parent = <&intc>; + interrupts = <0 29 4>; + reg = <0x43c00000 0x10000>; + xlnx,axi-str-rxd-protocol = "XIL_AXI_STREAM_ETH_DATA"; + xlnx,axi-str-rxd-tdata-width = <0x20>; + xlnx,axi-str-txc-protocol = "XIL_AXI_STREAM_ETH_CTRL"; + xlnx,axi-str-txc-tdata-width = <0x20>; + xlnx,axi-str-txd-protocol = "XIL_AXI_STREAM_ETH_DATA"; + xlnx,axi-str-txd-tdata-width = <0x20>; + xlnx,axis-tdest-width = <0x4>; + xlnx,axis-tid-width = <0x4>; + xlnx,axis-tuser-width = <0x4>; + xlnx,data-interface-type = <0x0>; + xlnx,has-axis-tdest = <0x0>; + xlnx,has-axis-tid = <0x0>; + xlnx,has-axis-tkeep = <0x0>; + xlnx,has-axis-tstrb = <0x0>; + xlnx,has-axis-tuser = <0x0>; + xlnx,rx-fifo-depth = <0x200>; + xlnx,rx-fifo-pe-threshold = <0x2>; + xlnx,rx-fifo-pf-threshold = <0x1fb>; + xlnx,s-axi-id-width = <0x4>; + xlnx,s-axi4-data-width = <0x20>; + xlnx,select-xpm = <0x0>; + xlnx,tx-fifo-depth = <0x8000>; + xlnx,tx-fifo-pe-threshold = <0x200>; + xlnx,tx-fifo-pf-threshold = <0x7ffb>; + xlnx,use-rx-cut-through = <0x0>; + xlnx,use-rx-data = <0x0>; + xlnx,use-tx-ctrl = <0x0>; + xlnx,use-tx-cut-through = <0x0>; + xlnx,use-tx-data = <0x1>; + }; +...
Signature · 1 line
2.43.0
[email protected]
AI reviewThank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider: - [Low] dt-bindings: axis-fifo: typo in compatible string causes schema validation failure - [Low]…
Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider:
- [Low] dt-bindings: axis-fifo: typo in compatible string causes schema validation failure
- [Low] dt-bindings: axis-fifo: duplicate binding due to undeleted text file --
commit 568433c34dce8d35f577a763a1632c2b7df8dc0b
Author: Daniel Matyas <[email protected]>
dt-bindings: axis-fifo: Added missing binding
drivers/staging/axis-fifo/axis-fifo.txt file described how the devicetree of the driver should look like. Convert it to .yaml file. Issue found by checkpatch.
Quoted 2 lines
drivers/staging/axis-fifo/axis-fifo.txtfile described how the devicetree of the driver should look like. Convert it to .yaml file.
[Severity: Low]
Does this commit leave a duplicate binding in the tree?
The commit message mentions converting the axis-fifo.txt file to .yaml, but the patch does not appear to delete drivers/staging/axis-fifo/axis-fifo.txt.
Quoted 5 lines
Documentation/devicetree/bindings/axis-fifo/xlnx,axi-fifo-mm-s.yaml new file +0
-0
[ ... ]
Documentation/devicetree/bindings/axis-fifo/xlnx,axi-fifo-mm-s.yaml line 31
Quoted 6 lines
Documentation/devicetree/bindings/axis-fifo/xlnx,axi-fifo-mm-s.yaml new file +6
-0+properties: + compatible: + enum: + - xlnx,axis-fifo-mm-s-4.1 + - xlnx,axis-fifo-mm-s-4.2 + - xlnx,axis-fifo-mm-s-4.3
[Severity: Low]
Are these compatible strings misspelled?
The enum defines xlnx,axis-fifo-mm-s-4.1 with an 's' in axis, but the actual compatible string used by the driver, existing device trees, and the provided YAML example is xlnx,axi-fifo-mm-s-4.1 without the 's'. This could cause a schema validation regression.
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1
Rob Herring (Arm)
maintainerQuoted 10 lines · Daniel Matyas
drivers/staging/axis-fifo/axis-fifo.txtfile described how the devicetree of the driver should look like. Convert it to .yaml file. Issue found by checkpatch.Signed-off-by Daniel Matyas <[email protected]>--- .../axis-fifo/xlnx,axi-fifo-mm-s.yaml | 257 ++++++++++++++++++ 1 file changed, 257 insertions(+) create mode 100644 Documentation/devicetree/bindings/axis-fifo/xlnx,axi-fifo-mm-s.yaml
My bot found errors running 'make dt_binding_check' on your patch:
yamllint warnings/errors:
dtschema/dtc warnings/errors:Documentation/devicetree/bindings/axis-fifo/xlnx,axi-fifo-mm-s.example.dtb: /example-0/axi_fifo_mm_s@43c00000: failed to match any schema with compatible: ['xlnx,axi-fifo-mm-s-4.1']
doc reference errors (make refcheckdocs):
See https://patchwork.kernel.org/project/devicetree/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.
Greg KH
maintainerQuoted 9 lines · Daniel Matyas
drivers/staging/axis-fifo/axis-fifo.txtfile described how the devicetree of the driver should look like. Convert it to .yaml file. Issue found by checkpatch.Signed-off-by Daniel Matyas <[email protected]>--- .../axis-fifo/xlnx,axi-fifo-mm-s.yaml | 257 ++++++++++++++++++ 1 file changed, 257 insertions(+) create mode 100644 Documentation/devicetree/bindings/axis-fifo/xlnx,axi-fifo-mm-s.yaml
This doesn't delete a file, so is it really a "conversion"?
thanks,
greg k-h
Quoted 3 lines · Daniel Matyas
drivers/staging/axis-fifo/axis-fifo.txtfile described how the devicetree of the driver should look like. Convert it to .yaml file. Issue found by checkpatch.
You could have checked before. Stop fixing things just because checkpatch told you something.
https://lore.kernel.org/all/?q=dfn%3Aaxis-fifo.txt
Same answer as usually, so a "no".
Best regards,
Krzysztof