dt-bindings: W1: w1-gpio: added bindings for w1-gpio
authorEugen Hristev <eugen.hristev@microchip.com>
Tue, 18 Sep 2018 07:35:26 +0000 (10:35 +0300)
committerTom Rini <trini@konsulko.com>
Sat, 29 Sep 2018 00:22:34 +0000 (20:22 -0400)
Added bindings specification for bitbanged gpio driver for Dallas
one wire protocol

Signed-off-by: Eugen Hristev <eugen.hristev@microchip.com>
doc/device-tree-bindings/w1/w1-gpio.txt [new file with mode: 0644]

diff --git a/doc/device-tree-bindings/w1/w1-gpio.txt b/doc/device-tree-bindings/w1/w1-gpio.txt
new file mode 100644 (file)
index 0000000..5a58244
--- /dev/null
@@ -0,0 +1,40 @@
+W1 gpio device binding - one wire protocol over bitbanged gpio
+=======================
+
+
+Child nodes are required in device tree. The driver will detect
+the devices serial number and then search in the child nodes in the device tree
+for the proper node and try to match it with the device.
+
+Also check doc/device-tree-bindings/w1-eeprom for possible child nodes drivers
+
+Driver:
+- drivers/w1/w1-gpio.c
+
+Software w1 device-tree node properties:
+Required:
+* compatible = "w1-gpio";
+* gpios = <...>;
+       This is the gpio used for one wire protocol, using bitbanging
+
+Optional:
+* none
+
+Example:
+
+onewire_tm: onewire {
+               compatible = "w1-gpio";
+               gpios = <&pioA 32 0>;
+};
+
+Example with child:
+
+onewire_tm: onewire {
+               compatible = "w1-gpio";
+               gpios = <&pioA 32 0>;
+
+               eeprom1: eeprom@0 {
+                       compatible = "maxim,ds24xxx";
+               }
+};
+