public inbox for devicetree@vger.kernel.org
 help / color / mirror / Atom feed
* [PATCH] staging: Lakshmi Patil: dt-bindings: misc: Add Xilinx AXI FIFO MM S controller binding
@ 2025-11-09  3:37 Lakshmi Patil
  2025-11-09 13:16 ` Conor Dooley
  0 siblings, 1 reply; 2+ messages in thread
From: Lakshmi Patil @ 2025-11-09  3:37 UTC (permalink / raw)
  Cc: lakshmi16796, Rob Herring, Krzysztof Kozlowski, Conor Dooley,
	devicetree, linux-kernel

Warning found by checkpatch.pl script.

Add the Device Tree binding documentation for the Xilinx AXI FIFO MM S
(AXI Memory Mapped to Stream) controller. The core provides a FIFO-based
interface between AXI Memory-Mapped and AXI-Stream domains and is used in
Xilinx SoC and FPGA designs to offload DMA-style data transfers.

The binding describes the required properties such as compatible string,
register region, clock, reset, and interrupt line.

Signed-off-by: Lakshmi Patil <lakshmi16796@gmail.com>
---
 .../bindings/misc/xlnx,axi-fifo-mm-s.yaml     | 69 +++++++++++++++++++
 1 file changed, 69 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s.yaml

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..d02a7cf9ac0f
--- /dev/null
+++ b/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s.yaml
@@ -0,0 +1,69 @@
+# 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 FIFO MM S Controller
+
+maintainers:
+  - Lakshmi lakshmi16796@gmail.com
+
+description: |
+  The Xilinx AXI FIFO Memory Mapped to Stream (MM2S / S2MM) core provides
+  a FIFO-based interface for moving data between AXI Memory-Mapped and
+  AXI-Stream domains. It supports both transmit and receive paths
+  and is typically used to offload DMA-style data transfers in
+  Xilinx SoCs or FPGA designs.
+
+properties:
+  compatible:
+    enum:
+      - xlnx,axi-fifo-mm-s-4.1
+
+  reg:
+    maxItems: 1
+    description:
+      Base address and size of the AXI FIFO MM S register space.
+
+  interrupts:
+    maxItems: 1
+    description:
+      Interrupt line from the AXI FIFO block, if available.
+
+  clocks:
+    maxItems: 1
+    description:
+      Reference clock for the AXI FIFO interface.
+
+  clock-names:
+    const: s_axi_aclk
+
+  resets:
+    maxItems: 1
+    description:
+      Reset line for the AXI FIFO interface.
+
+  reset-names:
+    const: s_axi_aresetn
+
+required:
+  - compatible
+  - reg
+  - clocks
+  - resets
+
+additionalProperties: true
+
+examples:
+  - |
+    axi_fifo_mm_s@43c00000 {
+        compatible = "xlnx,axi-fifo-mm-s-4.1";
+        reg = <0x43c00000 0x10000>;
+        interrupts = <0 59 4>;
+        clocks = <&clkc 15>;
+        clock-names = "s_axi_aclk";
+        resets = <&rstc 0>;
+        reset-names = "s_axi_aresetn";
+    };
+
-- 
2.34.1


^ permalink raw reply related	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2025-11-09 13:16 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-11-09  3:37 [PATCH] staging: Lakshmi Patil: dt-bindings: misc: Add Xilinx AXI FIFO MM S controller binding Lakshmi Patil
2025-11-09 13:16 ` Conor Dooley

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox