.../bindings/misc/xlnx,axi-fifo-mm-s.yaml | 265 ++++++++++++++++++ MAINTAINERS | 6 + drivers/staging/axis-fifo/axis-fifo.txt | 96 ------- 3 files changed, 271 insertions(+), 96 deletions(-) create mode 100644 Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s.yaml delete mode 100644 drivers/staging/axis-fifo/axis-fifo.txt
Add a YAML schema for the Xilinx AXI-Stream FIFO IP core (PG080).
The binding documents the three supported compatible strings and all
vendor-specific properties that the axis-fifo driver reads from the
device tree.
This resolves the following checkpatch.pl warnings in
drivers/staging/axis-fifo/axis-fifo.c:
WARNING: DT compatible string "xlnx,axi-fifo-mm-s-4.1" appears un-documented
WARNING: DT compatible string "xlnx,axi-fifo-mm-s-4.2" appears un-documented
WARNING: DT compatible string "xlnx,axi-fifo-mm-s-4.3" appears un-documented
Signed-off-by: Pramod Maurya <pramod.nexgen@gmail.com>
---
Changes in v2:
- Delete drivers/staging/axis-fifo/axis-fifo.txt as part of the
conversion (was missing from v1)
- Add all Vivado-generated properties to the schema so that real
hardware DT nodes pass validation with additionalProperties: false
- Update example to match a realistic Vivado-generated DT node
including all properties
.../bindings/misc/xlnx,axi-fifo-mm-s.yaml | 265 ++++++++++++++++++
MAINTAINERS | 6 +
drivers/staging/axis-fifo/axis-fifo.txt | 96 -------
3 files changed, 271 insertions(+), 96 deletions(-)
create mode 100644 Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s.yaml
delete mode 100644 drivers/staging/axis-fifo/axis-fifo.txt
diff --git a/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s.yaml b/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s.yaml
new file mode 100644
index 000000000000..264abb29dd5a
--- /dev/null
+++ b/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s.yaml
@@ -0,0 +1,265 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/misc/xlnx,axi-fifo-mm-s.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Xilinx AXI-Stream FIFO
+
+maintainers:
+ - Jacob Feder <jacobsfeder@gmail.com>
+
+description:
+ The Xilinx AXI-Stream FIFO (PG080) provides a memory-mapped interface to
+ an AXI-Stream FIFO IP core. It allows a processor to transmit and receive
+ AXI-Stream packets via simple MMIO register reads and writes.
+
+properties:
+ compatible:
+ enum:
+ - xlnx,axi-fifo-mm-s-4.1
+ - xlnx,axi-fifo-mm-s-4.2
+ - xlnx,axi-fifo-mm-s-4.3
+
+ reg:
+ maxItems: 1
+
+ interrupts:
+ maxItems: 1
+
+ interrupt-names:
+ maxItems: 1
+
+ xlnx,axi-str-rxd-protocol:
+ $ref: /schemas/types.yaml#/definitions/string
+ description:
+ AXI-Stream receive data protocol type. This property is generated by
+ Vivado and is not used by the driver.
+
+ xlnx,axi-str-rxd-tdata-width:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ Width of the receive AXI-Stream data bus in bits. Currently only 32
+ is supported.
+ const: 32
+
+ xlnx,axi-str-txc-protocol:
+ $ref: /schemas/types.yaml#/definitions/string
+ description:
+ AXI-Stream transmit control protocol type. This property is generated
+ by Vivado and is not used by the driver.
+
+ xlnx,axi-str-txc-tdata-width:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ Width of the transmit control AXI-Stream data bus in bits. This
+ property is generated by Vivado and is not used by the driver.
+
+ xlnx,axi-str-txd-protocol:
+ $ref: /schemas/types.yaml#/definitions/string
+ description:
+ AXI-Stream transmit data protocol type. This property is generated by
+ Vivado and is not used by the driver.
+
+ xlnx,axi-str-txd-tdata-width:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ Width of the transmit AXI-Stream data bus in bits. Currently only 32
+ is supported.
+ const: 32
+
+ xlnx,axis-tdest-width:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ AXI-Stream TDEST signal width in bits. This property is generated by
+ Vivado and is not used by the driver.
+
+ xlnx,axis-tid-width:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ AXI-Stream TID signal width in bits. This property is generated by
+ Vivado and is not used by the driver.
+
+ xlnx,axis-tuser-width:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ AXI-Stream TUSER signal width in bits. This property is generated by
+ Vivado and is not used by the driver.
+
+ xlnx,data-interface-type:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ Data interface type. This property is generated by Vivado and is not
+ used by the driver.
+
+ xlnx,has-axis-tdest:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ Indicates if the AXI-Stream TDEST signal is present. Cut-through mode
+ is not supported by the driver; this value must be 0.
+ const: 0
+
+ xlnx,has-axis-tid:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ Indicates if the AXI-Stream TID signal is present. Cut-through mode
+ is not supported by the driver; this value must be 0.
+ const: 0
+
+ xlnx,has-axis-tkeep:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ Indicates if the AXI-Stream TKEEP signal is present. This feature is
+ not supported by the driver; this value must be 0.
+ const: 0
+
+ xlnx,has-axis-tstrb:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ Indicates if the AXI-Stream TSTRB signal is present. This feature is
+ not supported by the driver; this value must be 0.
+ const: 0
+
+ xlnx,has-axis-tuser:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ Indicates if the AXI-Stream TUSER signal is present. This feature is
+ not supported by the driver; this value must be 0.
+ const: 0
+
+ xlnx,rx-fifo-depth:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ Depth of the receive FIFO in words.
+
+ xlnx,rx-fifo-pe-threshold:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ Receive FIFO programmable empty interrupt threshold in words. This
+ property is generated by Vivado and is not used by the driver.
+
+ xlnx,rx-fifo-pf-threshold:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ Receive FIFO programmable full interrupt threshold in words. This
+ property is generated by Vivado and is not used by the driver.
+
+ xlnx,s-axi-id-width:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ AXI4 ID signal width in bits. This property is generated by Vivado
+ and is not used by the driver.
+
+ xlnx,s-axi4-data-width:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ AXI4 data bus width in bits. This property is generated by Vivado and
+ is not used by the driver.
+
+ xlnx,select-xpm:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ Selects Xilinx Parameterized Macro (XPM) memory primitives. This
+ property is generated by Vivado and is not used by the driver.
+
+ xlnx,tx-fifo-depth:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ Depth of the transmit FIFO in words.
+
+ xlnx,tx-fifo-pe-threshold:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ Transmit FIFO programmable empty interrupt threshold in words. This
+ property is generated by Vivado and is not used by the driver.
+
+ xlnx,tx-fifo-pf-threshold:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ Transmit FIFO programmable full interrupt threshold in words. This
+ property is generated by Vivado and is not used by the driver.
+
+ xlnx,use-rx-cut-through:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ Enables receive cut-through mode. Cut-through mode is not supported
+ by the driver; this value must be 0.
+ const: 0
+
+ xlnx,use-rx-data:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ Set to 1 if the receive data FIFO is enabled, 0 otherwise.
+ enum: [0, 1]
+
+ xlnx,use-tx-ctrl:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ Enables the transmit control FIFO. This feature is not supported by
+ the driver; this value must be 0.
+ const: 0
+
+ xlnx,use-tx-cut-through:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ Enables transmit cut-through mode. Cut-through mode is not supported
+ by the driver; this value must be 0.
+ const: 0
+
+ xlnx,use-tx-data:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ Set to 1 if the transmit data FIFO is enabled, 0 otherwise.
+ enum: [0, 1]
+
+required:
+ - compatible
+ - reg
+ - interrupts
+ - xlnx,axi-str-rxd-tdata-width
+ - xlnx,axi-str-txd-tdata-width
+ - xlnx,rx-fifo-depth
+ - xlnx,tx-fifo-depth
+ - xlnx,use-rx-data
+ - xlnx,use-tx-data
+
+additionalProperties: false
+
+examples:
+ - |
+ axi_fifo: fifo@43c00000 {
+ compatible = "xlnx,axi-fifo-mm-s-4.1";
+ reg = <0x43c00000 0x10000>;
+ interrupt-parent = <&intc>;
+ interrupt-names = "interrupt";
+ interrupts = <0 29 4>;
+ xlnx,axi-str-rxd-protocol = "XIL_AXI_STREAM_ETH_DATA";
+ xlnx,axi-str-rxd-tdata-width = <32>;
+ xlnx,axi-str-txc-protocol = "XIL_AXI_STREAM_ETH_CTRL";
+ xlnx,axi-str-txc-tdata-width = <32>;
+ xlnx,axi-str-txd-protocol = "XIL_AXI_STREAM_ETH_DATA";
+ xlnx,axi-str-txd-tdata-width = <32>;
+ xlnx,axis-tdest-width = <4>;
+ xlnx,axis-tid-width = <4>;
+ xlnx,axis-tuser-width = <4>;
+ xlnx,data-interface-type = <0>;
+ xlnx,has-axis-tdest = <0>;
+ xlnx,has-axis-tid = <0>;
+ xlnx,has-axis-tkeep = <0>;
+ xlnx,has-axis-tstrb = <0>;
+ xlnx,has-axis-tuser = <0>;
+ xlnx,rx-fifo-depth = <0x200>;
+ xlnx,rx-fifo-pe-threshold = <2>;
+ xlnx,rx-fifo-pf-threshold = <0x1fb>;
+ xlnx,s-axi-id-width = <4>;
+ xlnx,s-axi4-data-width = <32>;
+ xlnx,select-xpm = <0>;
+ xlnx,tx-fifo-depth = <0x8000>;
+ xlnx,tx-fifo-pe-threshold = <0x200>;
+ xlnx,tx-fifo-pf-threshold = <0x7ffb>;
+ xlnx,use-rx-cut-through = <0>;
+ xlnx,use-rx-data = <0>;
+ xlnx,use-tx-ctrl = <0>;
+ xlnx,use-tx-cut-through = <0>;
+ xlnx,use-tx-data = <1>;
+ };
diff --git a/MAINTAINERS b/MAINTAINERS
index 9b107057ad8c..84be7c8ae257 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -29130,6 +29130,12 @@ S: Maintained
F: Documentation/devicetree/bindings/net/xlnx,axi-ethernet.yaml
F: drivers/net/ethernet/xilinx/xilinx_axienet*
+XILINX AXI-STREAM FIFO DRIVER
+M: Jacob Feder <jacobsfeder@gmail.com>
+S: Maintained
+F: Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s.yaml
+F: drivers/staging/axis-fifo/
+
XILINX CAN DRIVER
M: Appana Durga Kedareswara rao <appana.durga.rao@xilinx.com>
L: linux-can@vger.kernel.org
diff --git a/drivers/staging/axis-fifo/axis-fifo.txt b/drivers/staging/axis-fifo/axis-fifo.txt
deleted file mode 100644
index 413b81a53202..000000000000
--- a/drivers/staging/axis-fifo/axis-fifo.txt
+++ /dev/null
@@ -1,96 +0,0 @@
-Xilinx AXI-Stream FIFO v4.1 IP core
-
-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)
-
-Required properties:
-- compatible: Should be one of:
- "xlnx,axi-fifo-mm-s-4.1"
- "xlnx,axi-fifo-mm-s-4.2"
- "xlnx,axi-fifo-mm-s-4.3"
-- interrupt-names: Should be "interrupt"
-- interrupt-parent: Should be <&intc>
-- interrupts: Should contain interrupts lines.
-- reg: Should contain registers location and length.
-- xlnx,axi-str-rxd-protocol: Should be "XIL_AXI_STREAM_ETH_DATA"
-- xlnx,axi-str-rxd-tdata-width: Should be <0x20>
-- xlnx,axi-str-txc-protocol: Should be "XIL_AXI_STREAM_ETH_CTRL"
-- xlnx,axi-str-txc-tdata-width: Should be <0x20>
-- xlnx,axi-str-txd-protocol: Should be "XIL_AXI_STREAM_ETH_DATA"
-- xlnx,axi-str-txd-tdata-width: Should be <0x20>
-- xlnx,axis-tdest-width: AXI-Stream TDEST width (ignored by the driver)
-- xlnx,axis-tid-width: AXI-Stream TID width (ignored by the driver)
-- xlnx,axis-tuser-width: AXI-Stream TUSER width (ignored by the driver)
-- xlnx,data-interface-type: Should be <0x0> (ignored by the driver)
-- xlnx,has-axis-tdest: Should be <0x0> (this feature isn't supported)
-- xlnx,has-axis-tid: Should be <0x0> (this feature isn't supported)
-- xlnx,has-axis-tkeep: Should be <0x0> (this feature isn't supported)
-- xlnx,has-axis-tstrb: Should be <0x0> (this feature isn't supported)
-- xlnx,has-axis-tuser: Should be <0x0> (this feature isn't supported)
-- xlnx,rx-fifo-depth: Depth of RX FIFO in words
-- xlnx,rx-fifo-pe-threshold: RX programmable empty interrupt threshold
- (ignored by the driver)
-- xlnx,rx-fifo-pf-threshold: RX programmable full interrupt threshold
- (ignored by the driver)
-- xlnx,s-axi-id-width: Should be <0x4> (ignored by the driver)
-- xlnx,s-axi4-data-width: Should be <0x20> (ignored by the driver)
-- xlnx,select-xpm: Should be <0x0> (ignored by the driver)
-- xlnx,tx-fifo-depth: Depth of TX FIFO in words
-- xlnx,tx-fifo-pe-threshold: TX programmable empty interrupt threshold
- (ignored by the driver)
-- xlnx,tx-fifo-pf-threshold: TX programmable full interrupt threshold
- (ignored by the driver)
-- xlnx,use-rx-cut-through: Should be <0x0> (this feature isn't supported)
-- xlnx,use-rx-data: <0x1> if RX FIFO is enabled, <0x0> otherwise
-- xlnx,use-tx-ctrl: Should be <0x0> (this feature isn't supported)
-- xlnx,use-tx-cut-through: Should be <0x0> (this feature isn't supported)
-- xlnx,use-tx-data: <0x1> if TX FIFO is enabled, <0x0> otherwise
-
-Example:
-
-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>;
-};
--
2.52.0On Sun, May 10, 2026 at 04:44:57AM -0400, Pramod Maurya wrote: > Add a YAML schema for the Xilinx AXI-Stream FIFO IP core (PG080). > The binding documents the three supported compatible strings and all > vendor-specific properties that the axis-fifo driver reads from the > device tree. > > This resolves the following checkpatch.pl warnings in > drivers/staging/axis-fifo/axis-fifo.c: > WARNING: DT compatible string "xlnx,axi-fifo-mm-s-4.1" appears un-documented > WARNING: DT compatible string "xlnx,axi-fifo-mm-s-4.2" appears un-documented > WARNING: DT compatible string "xlnx,axi-fifo-mm-s-4.3" appears un-documented > > Signed-off-by: Pramod Maurya <pramod.nexgen@gmail.com> > --- > Changes in v2: > - Delete drivers/staging/axis-fifo/axis-fifo.txt as part of the > conversion (was missing from v1) > - Add all Vivado-generated properties to the schema so that real > hardware DT nodes pass validation with additionalProperties: false > - Update example to match a realistic Vivado-generated DT node > including all properties > > .../bindings/misc/xlnx,axi-fifo-mm-s.yaml | 265 ++++++++++++++++++ > MAINTAINERS | 6 + > drivers/staging/axis-fifo/axis-fifo.txt | 96 ------- > 3 files changed, 271 insertions(+), 96 deletions(-) > create mode 100644 Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s.yaml No, staging drivers need to be self-contained. When/if the axis-fifo driver moves out of drivers/staging/ this can happen, but not until then. You can convert this to yaml in-place if you want, AND you can test that the conversion is correct. Do you have this hardware to test this with? thanks, greg k-h
On Sun, May 10, 2026 at 06:07:01PM +0200, Greg KH wrote: > On Sun, May 10, 2026 at 04:44:57AM -0400, Pramod Maurya wrote: > > Add a YAML schema for the Xilinx AXI-Stream FIFO IP core (PG080). > > The binding documents the three supported compatible strings and all > > vendor-specific properties that the axis-fifo driver reads from the > > device tree. > > > > This resolves the following checkpatch.pl warnings in > > drivers/staging/axis-fifo/axis-fifo.c: > > WARNING: DT compatible string "xlnx,axi-fifo-mm-s-4.1" appears un-documented > > WARNING: DT compatible string "xlnx,axi-fifo-mm-s-4.2" appears un-documented > > WARNING: DT compatible string "xlnx,axi-fifo-mm-s-4.3" appears un-documented > > > > Signed-off-by: Pramod Maurya <pramod.nexgen@gmail.com> > > --- > > Changes in v2: > > - Delete drivers/staging/axis-fifo/axis-fifo.txt as part of the > > conversion (was missing from v1) > > - Add all Vivado-generated properties to the schema so that real > > hardware DT nodes pass validation with additionalProperties: false > > - Update example to match a realistic Vivado-generated DT node > > including all properties > > > > .../bindings/misc/xlnx,axi-fifo-mm-s.yaml | 265 ++++++++++++++++++ > > MAINTAINERS | 6 + > > drivers/staging/axis-fifo/axis-fifo.txt | 96 ------- > > 3 files changed, 271 insertions(+), 96 deletions(-) > > create mode 100644 Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s.yaml > > No, staging drivers need to be self-contained. When/if the axis-fifo > driver moves out of drivers/staging/ this can happen, but not until > then. > > You can convert this to yaml in-place if you want, AND you can test that > the conversion is correct. Do you have this hardware to test this with? Copy-pasting from v1... | Someone else submitted this conversion (which it is, despite you not | removing the old file), and the commentary I provided for that patch | applies here too: | https://lore.kernel.org/all/20260227-unboxed-customary-7ce6eda1858c@spud/ I suspect that this could be a dma-engine and any patch doing a conversion needs to justify why it is not. pw-bot: changes-requested
© 2016 - 2026 Red Hat, Inc.