summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorGeert Uytterhoeven <geert+renesas@glider.be>2017-11-30 16:29:46 +0300
committerRob Herring <robh@kernel.org>2017-12-07 00:11:43 +0300
commit3bcca2c271259ab2c3b539f0afa17d0043854c01 (patch)
tree47e15e9130d777712c8ecdbd78a9f1cd2fbcdc16 /Documentation
parentba341abd5480f41057b424a0047374aebd505f17 (diff)
downloadlinux-3bcca2c271259ab2c3b539f0afa17d0043854c01.tar.xz
dt-bindings: eeprom: at25: Document device-specific compatible values
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> Signed-off-by: Rob Herring <robh@kernel.org>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/devicetree/bindings/eeprom/at25.txt11
1 files changed, 8 insertions, 3 deletions
diff --git a/Documentation/devicetree/bindings/eeprom/at25.txt b/Documentation/devicetree/bindings/eeprom/at25.txt
index 95eb65334d39..e823d90b802f 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
@@ -22,8 +27,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;