diff mbox series

[v4,2/2] usb typec: mt6360: Add MT6360 Type-C DT binding documentation

Message ID 1598610636-4939-2-git-send-email-u0084500@gmail.com
State Superseded
Headers show
Series None | expand

Commit Message

cy_huang Aug. 28, 2020, 10:30 a.m. UTC 
From: ChiYuan Huang <cy_huang@richtek.com>

Add a devicetree binding documentation for the MT6360 Type-C driver.

usb typec: mt6360: Rename DT binding doument from mt6360 to mt636x

Signed-off-by: ChiYuan Huang <cy_huang@richtek.com>
---
 .../bindings/usb/mediatek,mt6360-tcpc.yaml         | 73 ++++++++++++++++++++++
 1 file changed, 73 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/usb/mediatek,mt6360-tcpc.yaml

Comments

cy_huang Aug. 29, 2020, 12:32 a.m. UTC | #1 
Rob Herring <robh@kernel.org> 於 2020年8月29日 週六 上午6:05寫道：
>
> On Fri, Aug 28, 2020 at 06:30:36PM +0800, cy_huang wrote:
> > From: ChiYuan Huang <cy_huang@richtek.com>
> >
> > Add a devicetree binding documentation for the MT6360 Type-C driver.
> >
> > usb typec: mt6360: Rename DT binding doument from mt6360 to mt636x
> >
> > Signed-off-by: ChiYuan Huang <cy_huang@richtek.com>
> > ---
> >  .../bindings/usb/mediatek,mt6360-tcpc.yaml         | 73 ++++++++++++++++++++++
> >  1 file changed, 73 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/usb/mediatek,mt6360-tcpc.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/usb/mediatek,mt6360-tcpc.yaml b/Documentation/devicetree/bindings/usb/mediatek,mt6360-tcpc.yaml
> > new file mode 100644
> > index 00000000..9e8ab0d
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/usb/mediatek,mt6360-tcpc.yaml
> > @@ -0,0 +1,73 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: "http://devicetree.org/schemas/usb/mediatek,mt6360-tcpc.yaml#"
> > +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
> > +
> > +title: Mediatek MT6360 Type-C Port Switch and Power Delivery controller DT bindings
> > +
> > +maintainers:
> > +  - ChiYuan Huang <cy_huang@richtek.com>
> > +
> > +description: |
> > +  Mediatek MT6360 is a multi-functional device. It integrates charger, ADC, flash, RGB indicators,
> > +  regulators (BUCKs/LDOs), and TypeC Port Switch with Power Delivery controller.
> > +  This document only describes MT6360 Type-C Port Switch and Power Delivery controller.
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - mediatek,mt6360-tcpc
> > +
> > +  interrupts-extended:
>
> Use 'interrupts'. The tooling will automatically support
> 'interrupts-extended'.
Okay.
>
> > +    maxItems: 1
> > +
> > +  interrupt-names:
> > +    items:
> > +      - const: PD_IRQB
> > +
> > +patternProperties:
> > +  "connector":
> > +    type: object
> > +    $ref: ../connector/usb-connector.yaml#
> > +    description:
> > +      Properties for usb c connector.
> > +
> > +additionalProperties: false
> > +
> > +required:
> > +  - compatible
> > +  - interrupts-extended
> > +  - interrupt-names
> > +
> > +examples:
> > +  - |
> > +    #include <dt-bindings/interrupt-controller/irq.h>
> > +    #include <dt-bindings/usb/pd.h>
> > +    i2c0 {
> > +        #address-cells = <1>;
> > +        #size-cells = <0>;
> > +
> > +        mt6360@34 {
> > +            compatible = "mediatek,mt6360";
> > +            reg = <0x34>;
> > +
> > +            tcpc {
> > +                compatible = "mediatek,mt6360-tcpc";
> > +                interrupts-extended = <&gpio26 3 IRQ_TYPE_LEVEL_LOW>;
> > +                interrupt-names = "PD_IRQB";
> > +
> > +                connector {
>
> Where's the data connections? The assumption of the binding is the USB
> (2 and 3) connections come from the parent if there's no graph to the
> USB controller(s).
MT6360 is only a subpmic. TypeC part only handle the CC logic to support USBPD.
For the usb connection like as usbhs/usbss,  it need to be handled
by/connect to application processor side.
LIke as connector/usb-connector.yaml decribed, it  specify the port
property to bind USB HS/SS.

>
> > +                        compatible = "usb-c-connector";
> > +                        label = "USB-C";
> > +                        data-role = "dual";
> > +                        power-role = "dual";
> > +                        try-power-role = "sink";
> > +                        source-pdos = <PDO_FIXED(5000, 1000, PDO_FIXED_DUAL_ROLE | PDO_FIXED_DATA_SWAP)>;
> > +                        sink-pdos = <PDO_FIXED(5000, 2000, PDO_FIXED_DUAL_ROLE | PDO_FIXED_DATA_SWAP)>;
> > +                        op-sink-microwatt = <10000000>;
> > +                };
> > +            };
> > +        };
> > +    };
> > +...
> > --
> > 2.7.4
> >
Chunfeng Yun (云春峰) Aug. 31, 2020, 2:58 a.m. UTC | #2 
On Sat, 2020-08-29 at 10:49 +0800, ChiYuan Huang wrote:
> ChiYuan Huang <u0084500@gmail.com> 於 2020年8月29日 週六 上午8:32寫道：

> >

> > Rob Herring <robh@kernel.org> 於 2020年8月29日 週六 上午6:05寫道：

> > >

> > > On Fri, Aug 28, 2020 at 06:30:36PM +0800, cy_huang wrote:

> > > > From: ChiYuan Huang <cy_huang@richtek.com>

> > > >

> > > > Add a devicetree binding documentation for the MT6360 Type-C driver.

> > > >

> > > > usb typec: mt6360: Rename DT binding doument from mt6360 to mt636x

> > > >

> > > > Signed-off-by: ChiYuan Huang <cy_huang@richtek.com>

> > > > ---

> > > >  .../bindings/usb/mediatek,mt6360-tcpc.yaml         | 73 ++++++++++++++++++++++

> > > >  1 file changed, 73 insertions(+)

> > > >  create mode 100644 Documentation/devicetree/bindings/usb/mediatek,mt6360-tcpc.yaml

> > > >

> > > > diff --git a/Documentation/devicetree/bindings/usb/mediatek,mt6360-tcpc.yaml b/Documentation/devicetree/bindings/usb/mediatek,mt6360-tcpc.yaml

> > > > new file mode 100644

> > > > index 00000000..9e8ab0d

> > > > --- /dev/null

> > > > +++ b/Documentation/devicetree/bindings/usb/mediatek,mt6360-tcpc.yaml

> > > > @@ -0,0 +1,73 @@

> > > > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

> > > > +%YAML 1.2

> > > > +---

> > > > +$id: "http://devicetree.org/schemas/usb/mediatek,mt6360-tcpc.yaml#"

> > > > +$schema: "http://devicetree.org/meta-schemas/core.yaml#"

> > > > +

> > > > +title: Mediatek MT6360 Type-C Port Switch and Power Delivery controller DT bindings

> > > > +

> > > > +maintainers:

> > > > +  - ChiYuan Huang <cy_huang@richtek.com>

> > > > +

> > > > +description: |

> > > > +  Mediatek MT6360 is a multi-functional device. It integrates charger, ADC, flash, RGB indicators,

> > > > +  regulators (BUCKs/LDOs), and TypeC Port Switch with Power Delivery controller.

> > > > +  This document only describes MT6360 Type-C Port Switch and Power Delivery controller.

> > > > +

> > > > +properties:

> > > > +  compatible:

> > > > +    enum:

> > > > +      - mediatek,mt6360-tcpc

> > > > +

> > > > +  interrupts-extended:

> > >

> > > Use 'interrupts'. The tooling will automatically support

> > > 'interrupts-extended'.

> > Okay.

> > >

> > > > +    maxItems: 1

> > > > +

> > > > +  interrupt-names:

> > > > +    items:

> > > > +      - const: PD_IRQB

> > > > +

> > > > +patternProperties:

> > > > +  "connector":

> > > > +    type: object

> > > > +    $ref: ../connector/usb-connector.yaml#

> > > > +    description:

> > > > +      Properties for usb c connector.

> > > > +

> > > > +additionalProperties: false

> > > > +

> > > > +required:

> > > > +  - compatible

> > > > +  - interrupts-extended

> > > > +  - interrupt-names

> > > > +

> > > > +examples:

> > > > +  - |

> > > > +    #include <dt-bindings/interrupt-controller/irq.h>

> > > > +    #include <dt-bindings/usb/pd.h>

> > > > +    i2c0 {

> > > > +        #address-cells = <1>;

> > > > +        #size-cells = <0>;

> > > > +

> > > > +        mt6360@34 {

> > > > +            compatible = "mediatek,mt6360";

> > > > +            reg = <0x34>;

> > > > +

> > > > +            tcpc {

> > > > +                compatible = "mediatek,mt6360-tcpc";

> > > > +                interrupts-extended = <&gpio26 3 IRQ_TYPE_LEVEL_LOW>;

> > > > +                interrupt-names = "PD_IRQB";

> > > > +

> > > > +                connector {

> > >

> > > Where's the data connections? The assumption of the binding is the USB

> > > (2 and 3) connections come from the parent if there's no graph to the

> > > USB controller(s).

> > MT6360 is only a subpmic. TypeC part only handle the CC logic to support USBPD.

> > For the usb connection like as usbhs/usbss,  it need to be handled

> > by/connect to application processor side.

> > LIke as connector/usb-connector.yaml decribed, it  specify the port

> > property to bind USB HS/SS.

> >

> Do i need to add the ports into the connector node for example?

> Like as hs/ss/aux, to make the user know to use 6360's tcpc?

> 

> I check the  style in connector/usb-connect.yaml

> Do I also need to replace two space instead of one tab in the binding example?


see writing-schema.rst about examples:

"Note: YAML doesn't allow leading tabs, so spaces must be used instead."
> 

> > >

> > > > +                        compatible = "usb-c-connector";

> > > > +                        label = "USB-C";

> > > > +                        data-role = "dual";

> > > > +                        power-role = "dual";

> > > > +                        try-power-role = "sink";

> > > > +                        source-pdos = <PDO_FIXED(5000, 1000, PDO_FIXED_DUAL_ROLE | PDO_FIXED_DATA_SWAP)>;

> > > > +                        sink-pdos = <PDO_FIXED(5000, 2000, PDO_FIXED_DUAL_ROLE | PDO_FIXED_DATA_SWAP)>;

> > > > +                        op-sink-microwatt = <10000000>;

> > > > +                };

> > > > +            };

> > > > +        };

> > > > +    };

> > > > +...

> > > > --

> > > > 2.7.4

> > > >
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/usb/mediatek,mt6360-tcpc.yaml b/Documentation/devicetree/bindings/usb/mediatek,mt6360-tcpc.yaml
new file mode 100644
index 00000000..9e8ab0d
--- /dev/null
+++ b/Documentation/devicetree/bindings/usb/mediatek,mt6360-tcpc.yaml
@@ -0,0 +1,73 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/usb/mediatek,mt6360-tcpc.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: Mediatek MT6360 Type-C Port Switch and Power Delivery controller DT bindings
+
+maintainers:
+  - ChiYuan Huang <cy_huang@richtek.com>
+
+description: |
+  Mediatek MT6360 is a multi-functional device. It integrates charger, ADC, flash, RGB indicators,
+  regulators (BUCKs/LDOs), and TypeC Port Switch with Power Delivery controller.
+  This document only describes MT6360 Type-C Port Switch and Power Delivery controller.
+
+properties:
+  compatible:
+    enum:
+      - mediatek,mt6360-tcpc
+
+  interrupts-extended:
+    maxItems: 1
+
+  interrupt-names:
+    items:
+      - const: PD_IRQB
+
+patternProperties:
+  "connector":
+    type: object
+    $ref: ../connector/usb-connector.yaml#
+    description:
+      Properties for usb c connector.
+
+additionalProperties: false
+
+required:
+  - compatible
+  - interrupts-extended
+  - interrupt-names
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    #include <dt-bindings/usb/pd.h>
+    i2c0 {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        mt6360@34 {
+            compatible = "mediatek,mt6360";
+            reg = <0x34>;
+
+            tcpc {
+                compatible = "mediatek,mt6360-tcpc";
+                interrupts-extended = <&gpio26 3 IRQ_TYPE_LEVEL_LOW>;
+                interrupt-names = "PD_IRQB";
+
+                connector {
+                        compatible = "usb-c-connector";
+                        label = "USB-C";
+                        data-role = "dual";
+                        power-role = "dual";
+                        try-power-role = "sink";
+                        source-pdos = <PDO_FIXED(5000, 1000, PDO_FIXED_DUAL_ROLE | PDO_FIXED_DATA_SWAP)>;
+                        sink-pdos = <PDO_FIXED(5000, 2000, PDO_FIXED_DUAL_ROLE | PDO_FIXED_DATA_SWAP)>;
+                        op-sink-microwatt = <10000000>;
+                };
+            };
+        };
+    };
+...