Devicetree
 help / color / mirror / Atom feed
From: Kartik Nair <contact.kartikn@gmail.com>
To: robh@kernel.org, krzk+dt@kernel.org, conor+dt@kernel.org
Cc: jacobsfeder@gmail.com, devicetree@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	Kartik Nair <contact.kartikn@gmail.com>
Subject: [PATCH] dt-bindings: misc: add documentation for Xilinx AXI-Stream FIFO IP core
Date: Mon, 11 May 2026 00:39:08 +0530	[thread overview]
Message-ID: <20260510190908.400-1-contact.kartikn@gmail.com> (raw)

Add device tree binding documentation for the Xilinx AXI-Stream FIFO
IP core (PG080). This documents the compatible strings used in
drivers/staging/axis-fifo/axis-fifo.c which were previously flagged
as undocumented by checkpatch.

Documented compatible strings:
- xlnx,axi-fifo-mm-s-4.1
- xlnx,axi-fifo-mm-s-4.2
- xlnx,axi-fifo-mm-s-4.3

Signed-off-by: Kartik Nair <contact.kartikn@gmail.com>
---
 .../bindings/misc/xlnx,axi-fifo-mm-s.yaml     | 44 +++++++++++++++++++
 1 file changed, 44 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 000000000..597699034
--- /dev/null
+++ b/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s.yaml
@@ -0,0 +1,44 @@
+# 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 IP Core
+
+maintainers:
+  - Jacob Feder <jacobsfeder@gmail.com>
+
+description:
+  The Xilinx AXI-Stream FIFO IP core allows memory-mapped access to an
+  AXI-Stream interface. It supports both transmit and receive FIFO
+  operations via a memory-mapped register interface. See Xilinx PG080
+  for full IP details.
+
+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
+
+required:
+  - compatible
+  - reg
+  - interrupts
+
+additionalProperties: false
+
+examples:
+  - |
+    axi_fifo: fifo@43c00000 {
+        compatible = "xlnx,axi-fifo-mm-s-4.1";
+        reg = <0x43c00000 0x10000>;
+        interrupts = <0 58 4>;
+    };
-- 
2.50.0


                 reply	other threads:[~2026-05-10 19:09 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260510190908.400-1-contact.kartikn@gmail.com \
    --to=contact.kartikn@gmail.com \
    --cc=conor+dt@kernel.org \
    --cc=devicetree@vger.kernel.org \
    --cc=jacobsfeder@gmail.com \
    --cc=krzk+dt@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=robh@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox