[PATCH v4 01/20] dt-bindings: i2c: eeprom: Document vendor to be used and deprecated ones

From: Javier Martinez Canillas
Date: Mon May 22 2017 - 10:07:24 EST


The at24 driver allows to register I2C EEPROM chips using different vendor
and devices, but the I2C subsystem does not take the vendor into account
when matching using the I2C table since it only has device entries.

But when matching using an OF table, both the vendor and device has to be
taken into account, so the exact list of supported <vendor,device> tuples
should be documented in the Device Tree binding document.

But there is no need to have different manufacturers if the EEPROM chips
from different manufacturers are really compatible, so matching using a
single "atmel" vendor is enough for all chip types.

Document in the Device Tree binding that the "atmel" manufacturer should
be used, and also document the manufacturers that have been deprecated.

Suggested-by: Wolfram Sang <wsa@xxxxxxxxxxxxx>
Suggested-by: Rob Herring <robh@xxxxxxxxxx>
Signed-off-by: Javier Martinez Canillas <javier@xxxxxxxxxxxx>

---

Changes in v4:
- Document the manufacturers that have been deprecated (Rob Herring).

Changes in v3: None
Changes in v2: None

Documentation/devicetree/bindings/eeprom/eeprom.txt | 14 ++++----------
1 file changed, 4 insertions(+), 10 deletions(-)

diff --git a/Documentation/devicetree/bindings/eeprom/eeprom.txt b/Documentation/devicetree/bindings/eeprom/eeprom.txt
index 5696eb508e95..121499252179 100644
--- a/Documentation/devicetree/bindings/eeprom/eeprom.txt
+++ b/Documentation/devicetree/bindings/eeprom/eeprom.txt
@@ -2,22 +2,16 @@ EEPROMs (I2C)

Required properties:

- - compatible : should be "<manufacturer>,<type>", like these:
+ - compatible : should be "atmel,<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"
+ The following manufacturers values have been deprecated:
+ "at", "at24", "catalyst", "microchip", "nxp", "ramtron", "renesas", "st"

- "microchip,24c128"
-
- "ramtron,24c64"
-
- "renesas,r1ex24002"
-
- If there is no specific driver for <manufacturer>, a generic
- driver based on <type> is selected. Possible types are:
+ Possible types are:
"24c00", "24c01", "24c02", "24c04", "24c08", "24c16", "24c32", "24c64",
"24c128", "24c256", "24c512", "24c1024", "spd"

--
2.9.3