Re: [PATCH v3 1/5] dt-bindings: at24: consistently document the compatible property
From: Rob Herring <robh+dt@kernel.org>
Date: 2017-12-27 17:21:46
Also in:
linux-i2c, lkml
On Wed, Dec 27, 2017 at 7:50 AM, Bartosz Golaszewski [off-list ref] wrote:
quoted hunk ↗ jump to hunk
Current description of the compatible property for at24 is quite vague. State explicitly that any "<manufacturer>,<model>" pair is accepted as long as one of the listed strings is used as fallback. Signed-off-by: Bartosz Golaszewski <redacted> --- Documentation/devicetree/bindings/eeprom/at24.txt | 37 +++++++++-------------- 1 file changed, 15 insertions(+), 22 deletions(-)diff --git a/Documentation/devicetree/bindings/eeprom/at24.txt b/Documentation/devicetree/bindings/eeprom/at24.txt index cbc80e194ac6..b5ce5a247554 100644 --- a/Documentation/devicetree/bindings/eeprom/at24.txt +++ b/Documentation/devicetree/bindings/eeprom/at24.txt@@ -2,28 +2,21 @@ 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"
Keep this and any others that don't have an atmel model. This should probably also state what the fallback should be (atmel,24c02 ?).
- - 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"
You remove "spd" here and add it back later. Just fold that in below. I'll leave it to others to bikeshed where in the list.
+ - compatible: must be a "<manufacturer>,<model>" pair with one of the
We should enumerate known vendors/manufacturers because something like "linaro,24c00" is not valid.
+ following values as fallback: + + "atmel,24c00", + "atmel,24c01", + "atmel,24c02", + "atmel,24c04", + "atmel,24c08", + "atmel,24c16", + "atmel,24c32", + "atmel,24c64", + "atmel,24c128", + "atmel,24c256", + "atmel,24c512", + "atmel,24c1024" - reg : the I2C address of the EEPROM -- 2.15.1