devicetree.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Geert Uytterhoeven <geert+renesas@glider.be>
To: Arnd Bergmann <arnd@arndb.de>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Rob Herring <robh+dt@kernel.org>,
	Mark Rutland <mark.rutland@arm.com>,
	Ivo Sieben <meltedpianoman@gmail.com>
Cc: Chris Wright <chrisw@sous-sol.org>,
	Wolfram Sang <wsa@the-dreams.de>,
	devicetree@vger.kernel.org, linux-kernel@vger.kernel.org,
	Geert Uytterhoeven <geert+renesas@glider.be>
Subject: [PATCH 3/3] dt-bindings: eeprom: at25: Document device-specific compatible values
Date: Thu, 30 Nov 2017 14:29:46 +0100	[thread overview]
Message-ID: <1512048586-17534-4-git-send-email-geert+renesas@glider.be> (raw)
In-Reply-To: <1512048586-17534-1-git-send-email-geert+renesas@glider.be>

Document the recommended presence of a device-specific compatible value,
and list examples that are already in use or soon will be.
This will allow checkpatch to validate compatible values in DTS.

Update the example to match current best practices (generic node name,
specific compatible value first).

Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
---
 Documentation/devicetree/bindings/eeprom/at25.txt | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

diff --git a/Documentation/devicetree/bindings/eeprom/at25.txt b/Documentation/devicetree/bindings/eeprom/at25.txt
index 9b1782809386844d..7129affb2956bb0d 100644
--- a/Documentation/devicetree/bindings/eeprom/at25.txt
+++ b/Documentation/devicetree/bindings/eeprom/at25.txt
@@ -1,7 +1,12 @@
 EEPROMs (SPI) compatible with Atmel at25.
 
 Required properties:
-- compatible : "atmel,at25".
+- compatible : Should be "<vendor>,<type>", and generic value "atmel,at25".
+  Example "<vendor>,<type>" values:
+    "microchip,25lc040"
+    "st,m95m02"
+    "st,m95256"
+
 - reg : chip select number
 - spi-max-frequency : max spi frequency to use
 - pagesize : size of the eeprom page
@@ -24,8 +29,8 @@ Obsolete legacy properties can be used in place of "size", "pagesize",
 Additional compatible properties are also allowed.
 
 Example:
-	at25@0 {
-		compatible = "atmel,at25", "st,m95256";
+	eeprom@0 {
+		compatible = "st,m95256", "atmel,at25";
 		reg = <0>
 		spi-max-frequency = <5000000>;
 		spi-cpha;
-- 
2.7.4

  parent reply	other threads:[~2017-11-30 13:29 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-11-30 13:29 [PATCH 0/3] eeprom: at25: Add DT support for 25lc040 Geert Uytterhoeven
2017-11-30 13:29 ` [PATCH 1/3] eeprom: at25: Add DT support for EEPROMs with odd address bits Geert Uytterhoeven
2017-12-04  9:17   ` Geert Uytterhoeven
2017-12-04 21:17     ` Rob Herring
2017-12-05  8:57       ` Geert Uytterhoeven
     [not found]         ` <CAMuHMdUDPFhSwkHg2wm7yCNAfdUP8wAR9OXxbcu6SDhtZqe2+A-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2017-12-05  9:09           ` Geert Uytterhoeven
2017-12-05 13:56             ` Rob Herring
2017-12-05 14:01               ` Geert Uytterhoeven
     [not found]     ` <CAMuHMdWczQ0KiH7soGLKxX8CQEwxA=kVDc_saYqgytE2U_3WKw-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2017-12-04 22:00       ` Ivo Sieben
2017-12-05  8:59         ` Geert Uytterhoeven
2017-11-30 13:29 ` Geert Uytterhoeven [this message]
     [not found] ` <1512048586-17534-1-git-send-email-geert+renesas-gXvu3+zWzMSzQB+pC5nmwQ@public.gmane.org>
2017-11-30 13:29   ` [PATCH 2/3] dt-bindings: eeprom: at25: Grammar s/are can/can/ Geert Uytterhoeven
2017-12-04 21:22   ` [PATCH 0/3] eeprom: at25: Add DT support for 25lc040 Rob Herring
2017-12-05  9:04     ` Geert Uytterhoeven
2017-12-06 21:12       ` Rob Herring

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=1512048586-17534-4-git-send-email-geert+renesas@glider.be \
    --to=geert+renesas@glider.be \
    --cc=arnd@arndb.de \
    --cc=chrisw@sous-sol.org \
    --cc=devicetree@vger.kernel.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mark.rutland@arm.com \
    --cc=meltedpianoman@gmail.com \
    --cc=robh+dt@kernel.org \
    --cc=wsa@the-dreams.de \
    /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;
as well as URLs for NNTP newsgroup(s).