diff mbox series

[v2,2/3] spi: dt-bindings: cdns,qspi-nor: Deprecate the Cadence compatible alone

Message ID 20250319094651.1290509-3-miquel.raynal@bootlin.com (mailing list archive)
State Accepted
Commit 8b35d653878fb98f36df8b4968159499258fddf1
Headers show
Series spi: dt-bindings: cdns,qspi-nor: Improve description | expand

Commit Message

Miquel Raynal March 19, 2025, 9:46 a.m. UTC
The initial SPI controller IP from Cadence has always been implemented
into controllers from various hardware manufacturers and because of
that, it has always been (rightfully) doubled with a more specific
compatible. There are likely no reasons to keep this compatible
legitimate, alone. Make sure people do not get mislead by officially
deprecating this compatible.

While at deprecating, let's update the examples to avoid documenting
deprecated properties.

Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
---
It happens that there is a single in tree DT node named spi@ff705000,
so use the same second compatible to match a real life example.
---
 Documentation/devicetree/bindings/spi/cdns,qspi-nor.yaml | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Comments

Rob Herring (Arm) March 19, 2025, 11:32 p.m. UTC | #1
On Wed, 19 Mar 2025 10:46:50 +0100, Miquel Raynal wrote:
> The initial SPI controller IP from Cadence has always been implemented
> into controllers from various hardware manufacturers and because of
> that, it has always been (rightfully) doubled with a more specific
> compatible. There are likely no reasons to keep this compatible
> legitimate, alone. Make sure people do not get mislead by officially
> deprecating this compatible.
> 
> While at deprecating, let's update the examples to avoid documenting
> deprecated properties.
> 
> Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
> ---
> It happens that there is a single in tree DT node named spi@ff705000,
> so use the same second compatible to match a real life example.
> ---
>  Documentation/devicetree/bindings/spi/cdns,qspi-nor.yaml | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 

Reviewed-by: Rob Herring (Arm) <robh@kernel.org>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/spi/cdns,qspi-nor.yaml b/Documentation/devicetree/bindings/spi/cdns,qspi-nor.yaml
index c4315b2e04f2..c6705ad846dd 100644
--- a/Documentation/devicetree/bindings/spi/cdns,qspi-nor.yaml
+++ b/Documentation/devicetree/bindings/spi/cdns,qspi-nor.yaml
@@ -81,6 +81,7 @@  properties:
           # ie. also NAND flashes, not only NOR flashes.
           - const: cdns,qspi-nor
       - const: cdns,qspi-nor
+        deprecated: true
 
   reg:
     items:
@@ -160,7 +161,7 @@  unevaluatedProperties: false
 examples:
   - |
     qspi: spi@ff705000 {
-        compatible = "cdns,qspi-nor";
+        compatible = "intel,socfpga-qspi", "cdns,qspi-nor";
         #address-cells = <1>;
         #size-cells = <0>;
         reg = <0xff705000 0x1000>,