Skip to content

Commit

Permalink
dt-bindings: at24: consistently document the compatible property
Browse files Browse the repository at this point in the history
Current description of the compatible property for at24 is quite vague.

State explicitly that any "<manufacturer>,<model>" pair is accepted as
long as a correct fallback is used for non-atmel chips.

Signed-off-by: Bartosz Golaszewski <brgl@bgdev.pl>
Reviewed-by: Rob Herring <robh@kernel.org>
  • Loading branch information
Bartosz Golaszewski committed Jan 2, 2018
1 parent 98fb3a3 commit 6da28ac
Showing 1 changed file with 36 additions and 22 deletions.
58 changes: 36 additions & 22 deletions Documentation/devicetree/bindings/eeprom/at24.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,42 @@ 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 a "<manufacturer>,<model>" pair. The following <model>
values are supported (assuming "atmel" as manufacturer):

"atmel,24c00",
"atmel,24c01",
"atmel,24c02",
"atmel,spd",
"atmel,24c04",
"atmel,24c08",
"atmel,24c16",
"atmel,24c32",
"atmel,24c64",
"atmel,24c128",
"atmel,24c256",
"atmel,24c512",
"atmel,24c1024",

If <manufacturer> is not "atmel", then a fallback must be used
with the same <model> and "atmel" as manufacturer.

Example:
compatible = "microchip,24c128", "atmel,24c128";

Supported manufacturers are:

"catalyst",
"microchip",
"ramtron",
"renesas",
"nxp",
"st",

Some vendors use different model names for chips which are just
variants of the above. Known such exceptions are listed below:

"renesas,r1ex24002" - the fallback is "atmel,24c02"

- reg : the I2C address of the EEPROM

Expand Down

0 comments on commit 6da28ac

Please sign in to comment.