NFC: dts: st21nfca_i2c: Add DTS Documentation
authorChristophe Ricard <christophe.ricard@gmail.com>
Tue, 13 May 2014 20:03:40 +0000 (22:03 +0200)
committerSamuel Ortiz <sameo@linux.intel.com>
Mon, 19 May 2014 22:47:43 +0000 (00:47 +0200)
Describe the properties used by the st21nfca NFC controller driver.

Signed-off-by: Christophe Ricard <christophe-h.ricard@st.com>
Signed-off-by: Samuel Ortiz <sameo@linux.intel.com>
Documentation/devicetree/bindings/net/nfc/st21nfca.txt [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/net/nfc/st21nfca.txt b/Documentation/devicetree/bindings/net/nfc/st21nfca.txt
new file mode 100644 (file)
index 0000000..4724fe6
--- /dev/null
@@ -0,0 +1,33 @@
+* STMicroelectronics SAS. ST21NFCA NFC Controller
+
+Required properties:
+- compatible: Should be "st,st21nfca-i2c".
+- clock-frequency: I²C work frequency.
+- reg: address on the bus
+- interrupt-parent: phandle for the interrupt gpio controller
+- interrupts: GPIO interrupt to which the chip is connected
+- enable-gpios: Output GPIO pin used for enabling/disabling the ST21NFCA
+
+Optional SoC Specific Properties:
+- pinctrl-names: Contains only one value - "default".
+- pintctrl-0: Specifies the pin control groups used for this controller.
+
+Example (for ARM-based BeagleBoard xM with ST21NFCA on I2C2):
+
+&i2c2 {
+
+       status = "okay";
+
+       st21nfca: st21nfca@1 {
+
+               compatible = "st,st21nfca_i2c";
+
+               reg = <0x01>;
+               clock-frequency = <400000>;
+
+               interrupt-parent = <&gpio5>;
+               interrupts = <2 IRQ_TYPE_LEVEL_LOW>;
+
+               enable-gpios = <&gpio5 29 GPIO_ACTIVE_HIGH>;
+       };
+};