MLK-16820-5 dt-bindings: typec: add documentation for tcpci
authorLi Jun <jun.li@nxp.com>
Tue, 28 Nov 2017 11:18:44 +0000 (19:18 +0800)
committerNitin Garg <nitin.garg@nxp.com>
Mon, 19 Mar 2018 20:55:47 +0000 (15:55 -0500)
TCPCI stands for typec port controller interface, its implementation
has full typec port control with power delivery support, it's a
standard i2c slave with GPIO input as irq interface, detail see spec
"Universal Serial Bus Type-C Port Controller Interface Specification
Revision 1.0, Version 1.1"

Signed-off-by: Li Jun <jun.li@nxp.com>
Acked-by: Peter Chen <peter.chen@nxp.com>
Documentation/devicetree/bindings/usb/typec-tcpci.txt [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/usb/typec-tcpci.txt b/Documentation/devicetree/bindings/usb/typec-tcpci.txt
new file mode 100644 (file)
index 0000000..7ef2167
--- /dev/null
@@ -0,0 +1,40 @@
+TCPCI(Typec port cotroller interface) binding
+---------------------------------------------
+
+Required properties:
+- compatible:       should be "usb,tcpci".
+- reg:              the i2c slave address of typec port controller device.
+- interrupt-parent: the phandle to the interrupt controller which provides
+                    the interrupt.
+- interrupts:       interrupt specification for tcpci alert.
+- port-type:        typec port type.
+- default-role:     preferred power role if port type is "drp".
+
+Required properties only for power source or drp:
+- src-pdos
+
+Required properties only for power sink or drp:
+- snk-pdos
+- max-snk-mv
+- max-snk-ma
+- op-snk-mw
+
+Optional properties:
+- sink-disable:     disable vbus sink in sink role in case we only can be source
+                    for power but need dual data role.
+
+Example:
+
+ptn5110@50 {
+       compatible = "usb,tcpci";
+       reg = <0x50>;
+       interrupt-parent = <&gpio3>;
+       interrupts = <3 IRQ_TYPE_LEVEL_LOW>;
+       port-type = "drp";
+       default-role = "sink";
+       src-pdos = <0x380190c8>;
+       snk-pdos = <0x380190c8 0x3802d0c8>;
+       max-snk-mv = <9000>;
+       max-snk-ma = <1000>;
+       op-snk-mw = <9000>;
+};