[03/13] documentation/dt: Add OMAP i2c bindings documentation

Commit Message

Benoit Cousson Sept. 1, 2011, 5:21 p.m. UTC

From: G, Manjunath Kondaiah <[e-mail]>

Add documentation for using omap i2c controller with device
tree support enabled.

Signed-off-by: G, Manjunath Kondaiah <[e-mail]>
[[e-mail]: Update the documentaion with hwmods binding]
Signed-off-by: Benoit Cousson <[e-mail]>
---
 Documentation/devicetree/bindings/i2c/omap-i2c.txt |   30 ++++++++++++++++++++
 1 files changed, 30 insertions(+), 0 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/i2c/omap-i2c.txt

Patch

diff --git a/Documentation/devicetree/bindings/i2c/omap-i2c.txt b/Documentation/devicetree/bindings/i2c/omap-i2c.txt
new file mode 100644
index 0000000..0dc1de0
--- /dev/null
+++ b/Documentation/devicetree/bindings/i2c/omap-i2c.txt
@@ -0,0 +1,30 @@ 
+I2C for OMAP platforms
+
+Required properties :
+- compatible : Must be "ti,omap-i2c"
+- hwmods : Must be "i2c<n>", n being the instance number (1-based)
+- #address-cells = <1>;
+- #size-cells = <0>;
+
+Recommended properties :
+- clock-frequency : Desired I2C bus clock frequency in Hz. Otherwise
+  the default 100 kHz frequency will be used.
+
+Optional properties:
+- Child nodes conforming to i2c bus binding
+
+Note: Current implementation will fetch base address, irq and dma
+from omap hwmod data base during device registration.
+Future plan is to migrate hwmod data base contents into device tree
+blob so that, all the required data will be used from device tree dts
+file.
+
+Examples :
+
+i2c1: i2c@0 {
+    compatible = "ti,omap-i2c";
+    #address-cells = <1>;
+    #size-cells = <0>;
+    hwmods = "i2c1";
+    clock-frequency = <400000>;
+};