All of lore.kernel.org
 help / color / mirror / Atom feed
From: Bartosz Golaszewski <brgl@bgdev.pl>
To: Andy Shevchenko <andy.shevchenko@gmail.com>,
	Rob Herring <robh+dt@kernel.org>,
	Mark Rutland <mark.rutland@arm.com>,
	Javier Martinez Canillas <javier@dowhile0.org>,
	David Lechner <david@lechnology.com>,
	Divagar Mohandass <divagar.mohandass@intel.com>
Cc: linux-i2c@vger.kernel.org, devicetree@vger.kernel.org,
	linux-kernel@vger.kernel.org, Bartosz Golaszewski <brgl@bgdev.pl>
Subject: [PATCH v2 1/5] dt-bindings: at24: consistently document the compatible property
Date: Thu, 21 Dec 2017 14:48:38 +0100	[thread overview]
Message-ID: <20171221134842.31287-2-brgl@bgdev.pl> (raw)
In-Reply-To: <20171221134842.31287-1-brgl@bgdev.pl>

Current description of the compatible property for at24 is quite vague.

Specify an exact list of accepted compatibles and document the - now
deprecated - strings which were previously used in device tree files.

Signed-off-by: Bartosz Golaszewski <brgl@bgdev.pl>
Reviewed-by: Javier Martinez Canillas <javierm@redhat.com>
---
 Documentation/devicetree/bindings/eeprom/at24.txt | 48 ++++++++++++-----------
 1 file changed, 26 insertions(+), 22 deletions(-)

diff --git a/Documentation/devicetree/bindings/eeprom/at24.txt b/Documentation/devicetree/bindings/eeprom/at24.txt
index cbc80e194ac6..16b687458b14 100644
--- a/Documentation/devicetree/bindings/eeprom/at24.txt
+++ b/Documentation/devicetree/bindings/eeprom/at24.txt
@@ -2,28 +2,32 @@ EEPROMs (I2C)
 
 Required properties:
 
-  - compatible : should be "<manufacturer>,<type>", like these:
-
-	"atmel,24c00", "atmel,24c01", "atmel,24c02", "atmel,24c04",
-	"atmel,24c08", "atmel,24c16", "atmel,24c32", "atmel,24c64",
-	"atmel,24c128", "atmel,24c256", "atmel,24c512", "atmel,24c1024"
-
-	"catalyst,24c32"
-
-	"microchip,24c128"
-
-	"ramtron,24c64"
-
-	"renesas,r1ex24002"
-
-	The following manufacturers values have been deprecated:
-	"at", "at24"
-
-	 If there is no specific driver for <manufacturer>, a generic
-	 device with <type> and manufacturer "atmel" should be used.
-	 Possible types are:
-	 "24c00", "24c01", "24c02", "24c04", "24c08", "24c16", "24c32", "24c64",
-	 "24c128", "24c256", "24c512", "24c1024", "spd"
+  - compatible: must be one of the following:
+
+        "atmel,24c00",
+        "atmel,24c01",
+        "atmel,24c02",
+        "atmel,24c04",
+        "atmel,24c08",
+        "atmel,24c16",
+        "atmel,24c32",
+        "atmel,24c64",
+        "atmel,24c128",
+        "atmel,24c256",
+        "atmel,24c512",
+        "atmel,24c1024"
+
+  NOTE: old compatible strings, such as:
+
+        "catalyst,24c32",
+        "microchip,24c128",
+        "ramtron,24c64",
+        "renesas,r1ex24002",
+        "at,24c08",
+        "at24,24c08",
+        "24c32"
+
+  will still work, but are now deprecated.
 
   - reg : the I2C address of the EEPROM
 
-- 
2.15.1

WARNING: multiple messages have this Message-ID (diff)
From: Bartosz Golaszewski <brgl-ARrdPY/1zhM@public.gmane.org>
To: Andy Shevchenko
	<andy.shevchenko-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>,
	Rob Herring <robh+dt-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>,
	Mark Rutland <mark.rutland-5wv7dgnIgG8@public.gmane.org>,
	Javier Martinez Canillas
	<javier-0uQlZySMnqxg9hUCZPvPmw@public.gmane.org>,
	David Lechner <david-nq/r/kbU++upp/zk7JDF2g@public.gmane.org>,
	Divagar Mohandass
	<divagar.mohandass-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
Cc: linux-i2c-u79uwXL29TY76Z2rM5mHXA@public.gmane.org,
	devicetree-u79uwXL29TY76Z2rM5mHXA@public.gmane.org,
	linux-kernel-u79uwXL29TY76Z2rM5mHXA@public.gmane.org,
	Bartosz Golaszewski <brgl-ARrdPY/1zhM@public.gmane.org>
Subject: [PATCH v2 1/5] dt-bindings: at24: consistently document the compatible property
Date: Thu, 21 Dec 2017 14:48:38 +0100	[thread overview]
Message-ID: <20171221134842.31287-2-brgl@bgdev.pl> (raw)
In-Reply-To: <20171221134842.31287-1-brgl-ARrdPY/1zhM@public.gmane.org>

Current description of the compatible property for at24 is quite vague.

Specify an exact list of accepted compatibles and document the - now
deprecated - strings which were previously used in device tree files.

Signed-off-by: Bartosz Golaszewski <brgl-ARrdPY/1zhM@public.gmane.org>
Reviewed-by: Javier Martinez Canillas <javierm-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
---
 Documentation/devicetree/bindings/eeprom/at24.txt | 48 ++++++++++++-----------
 1 file changed, 26 insertions(+), 22 deletions(-)

diff --git a/Documentation/devicetree/bindings/eeprom/at24.txt b/Documentation/devicetree/bindings/eeprom/at24.txt
index cbc80e194ac6..16b687458b14 100644
--- a/Documentation/devicetree/bindings/eeprom/at24.txt
+++ b/Documentation/devicetree/bindings/eeprom/at24.txt
@@ -2,28 +2,32 @@ EEPROMs (I2C)
 
 Required properties:
 
-  - compatible : should be "<manufacturer>,<type>", like these:
-
-	"atmel,24c00", "atmel,24c01", "atmel,24c02", "atmel,24c04",
-	"atmel,24c08", "atmel,24c16", "atmel,24c32", "atmel,24c64",
-	"atmel,24c128", "atmel,24c256", "atmel,24c512", "atmel,24c1024"
-
-	"catalyst,24c32"
-
-	"microchip,24c128"
-
-	"ramtron,24c64"
-
-	"renesas,r1ex24002"
-
-	The following manufacturers values have been deprecated:
-	"at", "at24"
-
-	 If there is no specific driver for <manufacturer>, a generic
-	 device with <type> and manufacturer "atmel" should be used.
-	 Possible types are:
-	 "24c00", "24c01", "24c02", "24c04", "24c08", "24c16", "24c32", "24c64",
-	 "24c128", "24c256", "24c512", "24c1024", "spd"
+  - compatible: must be one of the following:
+
+        "atmel,24c00",
+        "atmel,24c01",
+        "atmel,24c02",
+        "atmel,24c04",
+        "atmel,24c08",
+        "atmel,24c16",
+        "atmel,24c32",
+        "atmel,24c64",
+        "atmel,24c128",
+        "atmel,24c256",
+        "atmel,24c512",
+        "atmel,24c1024"
+
+  NOTE: old compatible strings, such as:
+
+        "catalyst,24c32",
+        "microchip,24c128",
+        "ramtron,24c64",
+        "renesas,r1ex24002",
+        "at,24c08",
+        "at24,24c08",
+        "24c32"
+
+  will still work, but are now deprecated.
 
   - reg : the I2C address of the EEPROM
 
-- 
2.15.1

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

  reply	other threads:[~2017-12-21 13:50 UTC|newest]

Thread overview: 34+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-12-21 13:48 [PATCH v2 0/5] eeprom: at24: device tree support fixes Bartosz Golaszewski
2017-12-21 13:48 ` Bartosz Golaszewski
2017-12-21 13:48 ` Bartosz Golaszewski [this message]
2017-12-21 13:48   ` [PATCH v2 1/5] dt-bindings: at24: consistently document the compatible property Bartosz Golaszewski
2017-12-21 14:09   ` Andy Shevchenko
2017-12-21 14:09     ` Andy Shevchenko
2017-12-21 16:20   ` Peter Rosin
2017-12-21 17:24     ` David Lechner
2017-12-21 17:25       ` David Lechner
2017-12-21 17:25         ` David Lechner
2017-12-21 20:27     ` Javier Martinez Canillas
2017-12-21 23:07       ` Peter Rosin
2017-12-21 23:38         ` Javier Martinez Canillas
2017-12-22 16:58           ` Peter Rosin
2017-12-22 16:58             ` Peter Rosin
2017-12-26 21:32             ` Rob Herring
2017-12-26 22:21               ` Bartosz Golaszewski
2017-12-26 22:21                 ` Bartosz Golaszewski
2017-12-21 13:48 ` [PATCH v2 2/5] dt-bindings: at24: add a missing compatible Bartosz Golaszewski
2017-12-21 14:08   ` Andy Shevchenko
2017-12-21 14:08     ` Andy Shevchenko
2017-12-21 14:18     ` Bartosz Golaszewski
2017-12-21 14:25       ` Andy Shevchenko
2017-12-21 14:25         ` Andy Shevchenko
2017-12-21 14:58         ` Bartosz Golaszewski
2017-12-21 13:48 ` [PATCH v2 3/5] dt-bindings: at24: fix formatting and style Bartosz Golaszewski
2017-12-21 13:48 ` [PATCH v2 4/5] dt-bindings: at24: extend the list of supported chips Bartosz Golaszewski
2017-12-21 13:48   ` Bartosz Golaszewski
2017-12-21 14:12   ` Andy Shevchenko
2017-12-21 14:12     ` Andy Shevchenko
2017-12-21 13:48 ` [PATCH v2 5/5] eeprom: at24: extend the list of chips supported in DT Bartosz Golaszewski
2017-12-21 13:48   ` Bartosz Golaszewski
2017-12-21 14:13   ` Andy Shevchenko
2017-12-21 14:13     ` Andy Shevchenko

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=20171221134842.31287-2-brgl@bgdev.pl \
    --to=brgl@bgdev.pl \
    --cc=andy.shevchenko@gmail.com \
    --cc=david@lechnology.com \
    --cc=devicetree@vger.kernel.org \
    --cc=divagar.mohandass@intel.com \
    --cc=javier@dowhile0.org \
    --cc=linux-i2c@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mark.rutland@arm.com \
    --cc=robh+dt@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.