Devicetree
 help / color / mirror / Atom feed
From: sashiko-bot@kernel.org
To: "Kartik Nair" <contact.kartikn@gmail.com>
Cc: devicetree@vger.kernel.org, robh@kernel.org, krzk+dt@kernel.org,
	conor+dt@kernel.org
Subject: Re: [PATCH] dt-bindings: misc: add documentation for Xilinx AXI-Stream FIFO IP core
Date: Mon, 11 May 2026 21:39:45 +0000	[thread overview]
Message-ID: <20260511213945.A0B80C2BCB0@smtp.kernel.org> (raw)
In-Reply-To: <20260510190908.400-1-contact.kartikn@gmail.com>

Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider:
- [High] The YAML binding schema is incomplete and sets `additionalProperties: false`, which rejects valid device trees and breaks driver probing.
- [Low] The commit introduces a new YAML binding but fails to remove the existing text-based binding, leading to duplicated and conflicting documentation.
--

commit a25eb1af928bc942c4ddef43a8d5e91efa619819
Author: Kartik Nair <contact.kartikn@gmail.com>

dt-bindings: misc: add documentation for Xilinx AXI-Stream FIFO IP core

This patch adds device tree binding documentation for the Xilinx AXI-Stream
FIFO IP core. It introduces a new YAML schema to document the compatible
strings used by the axis-fifo driver.

Does this update also need to remove the existing text-based binding at
drivers/staging/axis-fifo/axis-fifo.txt? Keeping the legacy text file
alongside the new YAML schema introduces duplicated and conflicting
documentation.

> 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 0000000000000..597699034f134
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s.yaml
> @@ -0,0 +1,44 @@
[ ... ]
> +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

The drivers/staging/axis-fifo/axis-fifo.c driver requires several vendor
specific properties to probe successfully, such as
xlnx,axi-str-rxd-tdata-width, xlnx,axi-str-txd-tdata-width,
xlnx,rx-fifo-depth, xlnx,tx-fifo-depth, xlnx,use-rx-data, and
xlnx,use-tx-data.

Are these properties missing from the schema?

> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +
> +additionalProperties: false

If the vendor properties are added to the device tree to allow the driver
to probe, won't setting additionalProperties to false cause the schema
validation to fail?

Device trees that pass this strict schema would then fail at runtime since
the driver will abort the probe when the missing properties are not found.

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20260510190908.400-1-contact.kartikn@gmail.com?part=1

      reply	other threads:[~2026-05-11 21:39 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-05-10 19:09 [PATCH] dt-bindings: misc: add documentation for Xilinx AXI-Stream FIFO IP core Kartik Nair
2026-05-11 21:39 ` sashiko-bot [this message]

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=20260511213945.A0B80C2BCB0@smtp.kernel.org \
    --to=sashiko-bot@kernel.org \
    --cc=conor+dt@kernel.org \
    --cc=contact.kartikn@gmail.com \
    --cc=devicetree@vger.kernel.org \
    --cc=krzk+dt@kernel.org \
    --cc=robh@kernel.org \
    --cc=sashiko@lists.linux.dev \
    /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