dt-bindings: nfc: Add Documentation for I2C NFC devicetree node

Add description for NFC I2C devicetree node.

It is derived from 'msm-4.19 commit ea7266aa5447
("Add Documentation for nq-nci").

Change-Id: I27b01976fde2896b82112e678ece891fe0e89615
This commit is contained in:
Karthik Poosa 2019-12-09 15:30:24 +05:30 • committed by Gerrit - the friendly Code Review server
commit cca70a9aeb

50
bindings/nfc/sn-nci.txt Normal file
View file

@ -0,0 +1,50 @@
Qualcomm Technologies, Inc SNxxx NFC NCI device
Near Field Communication (NFC) device is based on NFC Controller Interface (NCI)
Required properties:
- compatible: "qcom,sn-nci"
- reg: NCI I2C slave address.
- qcom,sn-ven: specific gpio for hardware reset.
- qcom,sn-irq: specific gpio for read interrupt.
- qcom,sn-firm: gpio for firmware download
- qcom,sn-clkreq: gpio for clock
- interrupt-parent: Should be phandle for the interrupt controller
that services interrupts for this device.
- interrupts: Nfc read interrupt,gpio-clk-req interrupt
Recommended properties:
- interrupt-names: names of interrupts, should include "nfc_irq", used for reference
Optional properties:
- pinctrl-names, pinctrl-0, pincntrl-1: references to our pincntrl settings
- clocks, clock-names: must contain the SNxxx's core clock.
- qcom,clk-src: NFC clock for antenna
Example:
sn-nci@2b {
compatible = "qcom,sn-nci";
reg = <0x2b>;
qcom,sn-irq = <&tlmm 87 0x00>;
qcom,sn-ven = <&tlmm 62 0x00>;
qcom,sn-firm = <&tlmm 86 0x00>;
qcom,sn-clkreq = <&tlmm 63 0x00>;
qcom,clk-src = "BBCLK2";
interrupt-parent = <&tlmm>;
interrupts = <29 0>;
interrupt-names = "nfc_irq";
pinctrl-names = "default","sleep";
pinctrl-0 = <&nfc_enable_active &nfc_fwdl_active
&nfc_clk_req_active &nfc_int_active>;
pinctrl-1 = <&nfc_enable_suspend &nfc_fwdl_suspend
&nfc_clk_req_suspend &nfc_int_suspend>;
clocks = <&clock_rpm clk_bb_clk2_pin>;
clock-names = "ref_clk";
status = "ok";
};