Skip to contentSkip to conversation

dt-bindings: usb: Add binding for ti,tps25750

PATCH In review Abdel Alkuor 2 participants 5 messages Aug 17, 2023 – Aug 20, 2023

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 dt-bindings: usb: Add binding for ti,tps25750

From: Abdel Alkuor <[email protected]>

TPS25750 provides power negotiation and capabilities management for USB Type-C applications.

---
 .../devicetree/bindings/usb/ti,tps25750.yaml  | 84 +++++++++++++++++++
 1 file changed, 84 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/usb/ti,tps25750.yaml
Documentation/devicetree/bindings/usb/ti,tps25750.yaml new file +84 -0
new file mode 100644
index 000000000000..326c9c2f766b
@@ -0,0 +1,84 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/usb/ti,tps25750.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Texas Instruments 25750 Type-C Port Switch and Power Delivery controller
+
+maintainers:
+  - Abdel Alkuor <[email protected]>
+
+description: |
+  Texas Instruments 25750 Type-C Port Switch and Power Delivery controller
+
+properties:
+  compatible:
+    enum:
+      - ti,tps25750
+  reg:
+    maxItems: 1
+
+  interrupts:
+    description: |
+    maxItems: 1
+
+  interrupt-names:
+    items:
+      - const: irq
+
+  firmware-name:
+    description: |
+      Should contain the name of the default patch binary
+      file located on the firmware search path which is
+      used to switch the controller into APP mode
+
+  connector:
+    type: object
+    $ref: ../connector/usb-connector.yaml#
+    description:
+      Properties for usb c connector.
+    required:
+      - data-role
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - connector
+
+additionalProperties: true
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        tps25750: tps25750@21 {
+            compatible = "ti,tps25750";
+            reg = <0x21>;
+
+            interrupt-parent = <&msmgpio>;
+            interrupts = <107 IRQ_TYPE_LEVEL_LOW>;
+            interrupt-names = "irq";
+
+            firmware-name = "tps25750.bin";
+
+            pinctrl-names = "default";
+            pinctrl-0 = <&typec_pins>;
+
+            typec_con: connector {
+                compatible = "usb-c-connector";
+                label = "USB-C";
+                data-role = "dual";
+                port {
+                    typec_ep: endpoint {
+                        remote-endpoint = <&otg_ep>;
+                    };
+                };
+            };
+        };
+    };
+...
Signature · 1 line
2.24.4
#1 lore raw
Quoted 6 lines · Abdel Alkuor

From: Abdel Alkuor <[email protected]>

TPS25750 provides power negotiation and capabilities management for USB Type-C applications.

Where is any user of it? DTS, driver or 3rd party upstream open-source project?

A nit, subject: drop second/last, redundant "binding for". The "dt-bindings" prefix is already stating that these are bindings.

Quoted 19 lines
---
 .../devicetree/bindings/usb/ti,tps25750.yaml  | 84 +++++++++++++++++++
 1 file changed, 84 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/usb/ti,tps25750.yaml
Documentation/devicetree/bindings/usb/ti,tps25750.yaml new file +8 -0
new file mode 100644
index 000000000000..326c9c2f766b
@@ -0,0 +1,84 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/usb/ti,tps25750.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Texas Instruments 25750 Type-C Port Switch and Power Delivery controller
+

Documentation/devicetree/bindings/usb/ti,tps25750.yaml line 18

Quoted 10 lines
Documentation/devicetree/bindings/usb/ti,tps25750.yaml new file +10 -0
+maintainers:
+  - Abdel Alkuor <[email protected]>
+
+description: |
+  Texas Instruments 25750 Type-C Port Switch and Power Delivery controller
+
+properties:
+  compatible:
+    enum:
+      - ti,tps25750

Blank line

Documentation/devicetree/bindings/usb/ti,tps25750.yaml line 23

Quoted 5 lines
Documentation/devicetree/bindings/usb/ti,tps25750.yaml new file +5 -0
+  reg:
+    maxItems: 1
+
+  interrupts:
+    description: |

Drop description

Documentation/devicetree/bindings/usb/ti,tps25750.yaml line 28

Quoted 5 lines
Documentation/devicetree/bindings/usb/ti,tps25750.yaml new file +5 -0
+    maxItems: 1
+
+  interrupt-names:
+    items:
+      - const: irq

Drop interrupt-names, it is useless in this form.

Documentation/devicetree/bindings/usb/ti,tps25750.yaml line 34

Quoted 6 lines
Documentation/devicetree/bindings/usb/ti,tps25750.yaml new file +6 -0
+
+  firmware-name:
+    description: |
+      Should contain the name of the default patch binary
+      file located on the firmware search path which is
+      used to switch the controller into APP mode

maxItems: 1

Quoted 15 lines
Documentation/devicetree/bindings/usb/ti,tps25750.yaml new file +15 -0
+
+  connector:
+    type: object
+    $ref: ../connector/usb-connector.yaml#
+    description:
+      Properties for usb c connector.
+    required:
+      - data-role
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - connector
+

Documentation/devicetree/bindings/usb/ti,tps25750.yaml line 59

Quoted 10 lines
Documentation/devicetree/bindings/usb/ti,tps25750.yaml new file +10 -0
+additionalProperties: true
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        tps25750: tps25750@21 {

Node names should be generic. See also an explanation and list of examples (not exhaustive) in DT specification:
https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation

Documentation/devicetree/bindings/usb/ti,tps25750.yaml line 62

Quoted 3 lines
Documentation/devicetree/bindings/usb/ti,tps25750.yaml new file +3 -0
+            compatible = "ti,tps25750";
+            reg = <0x21>;
+

Best regards,
Krzysztof

#2 lore raw
Quoted 3 lines · Krzysztof Kozlowski

Where is any user of it? DTS, driver or 3rd party upstream open-source project?

Yes, for Geotab. We are working on bringing up a new BSP and we have tps25750 which doesn't have a driver in Linux yet. We developed the driver but I thought I needed to get the dt-bindings accepted first before sending the patch for the driver.

Sorry, this is my first time contributing to Linux. Maybe this question was asked before but for some reason I couldn't find it.

What is usually the process? Should I upload the driver too?

Quoted 40 lines

A nit, subject: drop second/last, redundant "binding for". The "dt-bindings" prefix is already stating that these are bindings.

Quoted 1 line

+ - ti,tps25750

Blank line

Documentation/devicetree/bindings/usb/ti,tps25750.yaml line 23

Quoted 4 lines
Documentation/devicetree/bindings/usb/ti,tps25750.yaml new file +3 -0
+  reg:
 
+  interrupts:
+    description: |

Drop description

Documentation/devicetree/bindings/usb/ti,tps25750.yaml line 28

Quoted 3 lines
Documentation/devicetree/bindings/usb/ti,tps25750.yaml new file +3 -0
+  interrupt-names:
+    items:
+      - const: irq

Drop interrupt-names, it is useless in this form.

Documentation/devicetree/bindings/usb/ti,tps25750.yaml line 34

Quoted 5 lines
Documentation/devicetree/bindings/usb/ti,tps25750.yaml new file +5 -0
+  firmware-name:
+    description: |
+      Should contain the name of the default patch binary
+      file located on the firmware search path which is
+      used to switch the controller into APP mode

maxItems: 1

Quoted 1 line

+ tps25750: tps25750@21 {

Node names should be generic. See also an explanation and list of examples (not exhaustive) in DT specification:
https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation

Quoted 8 lines

Documentation/devicetree/bindings/usb/ti,tps25750.yaml line 62

Quoted 3 lines
Documentation/devicetree/bindings/usb/ti,tps25750.yaml new file +3 -0
+            compatible = "ti,tps25750";
+            reg = <0x21>;
+

Best regards,
Krzysztof

Thanks for the review. I've addressed your comments in v2

Best Regards,
Abdel

#3 lore raw
Quoted 9 lines · Abdel Alkuor
Quoted 3 lines · Krzysztof Kozlowski

Where is any user of it? DTS, driver or 3rd party upstream open-source project?

Yes, for Geotab. We are working on bringing up a new BSP and we have tps25750 which doesn't have a driver in Linux yet. We developed the driver but I thought I needed to get the dt-bindings accepted first before sending the patch for the driver.

Quoted 4 lines

Sorry, this is my first time contributing to Linux. Maybe this question was asked before but for some reason I couldn't find it.

What is usually the process? Should I upload the driver too?

Yes, please upload in one patchset, in following order:
1. This bindings patch
2. Driver patch

Best regards,
Krzysztof

#4 lore raw
Quoted 10 lines · Krzysztof Kozlowski
Quoted 9 lines · Abdel Alkuor
Quoted 3 lines · Krzysztof Kozlowski

Where is any user of it? DTS, driver or 3rd party upstream open-source project?

Yes, for Geotab. We are working on bringing up a new BSP and we have tps25750 which doesn't have a driver in Linux yet. We developed the driver but I thought I needed to get the dt-bindings accepted first before sending the patch for the driver.

Quoted 9 lines
Quoted 4 lines

Sorry, this is my first time contributing to Linux. Maybe this question was asked before but for some reason I couldn't find it.

What is usually the process? Should I upload the driver too?

Yes, please upload in one patchset, in following order:
1. This bindings patch
2. Driver patch

Will do. Thanks.

Abdel