[[linux-nfc] PATCH v1.0 3/3] DT: bindings: net: nfc: ST95HF binding doc

Commit Message

Shikha Singh Sept. 12, 2015, 7:21 a.m. UTC

This patch includes ST95HF binding doc that guides how to
make node entry of ST95HF in DT file of any platform.

Signed-off-by: Shikha Singh <[e-mail]>
---
 .../devicetree/bindings/net/nfc/st95hf.txt         | 55 ++++++++++++++++++++++
 1 file changed, 55 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/net/nfc/st95hf.txt

Patch

diff --git a/Documentation/devicetree/bindings/net/nfc/st95hf.txt b/Documentation/devicetree/bindings/net/nfc/st95hf.txt
new file mode 100644
index 0000000..baa4819
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/nfc/st95hf.txt
@@ -0,0 +1,55 @@ 
+STMicroelectronics NFC Transceiver ST95HF
+-----------------------------------------
+
+ST NFC Transceiver is required to attach with SPI bus.
+ST95HF should be defined in DT as SPI slave device of SPI master
+with which transceiver is physically connected.
+The properties defined below are required to be the part of DT
+to include transceiver into the platform.
+
+Required properties:
+
+- reg: Address of SPI slave "transceiver" on SPI master bus.
+
+- compatible: should be "st,st95hf" for ST NFC transceiver
+
+- spi-max-frequency: Max. operating SPI frequency for transceiver.
+
+- st,st95hf-enable-gpio: GPIO line used to enable transceiver.
+
+- interrupt-parent : Standard way to specify the controller to which
+		transceiver interrupt is routed.
+
+- interrupts : Standard way to define device (transceiver's out) interrupt.
+
+Optional property:
+
+- st95hfvin-supply : This is an optional property.It contains a phandle to
+		transceiver regulator supply node in DT.
+
+Example:
+	 spi@9840000 {
+                        compatible = "st,comms-ssc4-spi";
+                        reg = <0x9840000 0x110>;
+                        interrupts = <GIC_SPI 112 IRQ_TYPE_LEVEL_HIGH>;
+                        clocks = <&clk_s_c0_flexgen CLK_EXT2F_A9>;
+                        clock-names = "ssc";
+                        pinctrl-0 = <&pinctrl_spi0_default>;
+                        pinctrl-names = "default";
+                        #address-cells = <1>;
+                        #size-cells = <0>;
+                        cs-gpios = <&pio0 4>;
+                        status = "okay";
+
+                        st95hf@0{
+                                reg = <0>;
+                                compatible = "st,st95hf";
+                                status = "okay";
+                                spi-max-frequency = <1000000>;
+                                st,st95hf-enable-gpio = <&pio4 0>;
+                                interrupt-parent = <&pio0>;
+                                interrupts = <7 IRQ_TYPE_EDGE_FALLING>;
+                        };
+
+                };
+