Introduce PMIC based USB type C detection

Introduce the dt-binding for enabling USB type C orientation and role detection using the PM8150B. The driver will be responsible for receiving the interrupt at a state change on the CC lines, reading the orientation/role, and communicating this information to the remote clients, which can include a role switch node and a type C switch.

Signed-off-by Wesley Cheng <[email protected]>

---
 .../bindings/usb/qcom,pmic-typec.yaml         | 117 ++++++++++++++++++
 1 file changed, 117 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/usb/qcom,pmic-typec.yaml

Documentation/devicetree/bindings/usb/qcom,pmic-typec.yaml new file +20 -0

new file mode 100644
index 000000000000..085b4547d75a
@@ -0,0 +1,117 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/usb/qcom,pmic-typec.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: Qualcomm PMIC based USB type C Detection Driver
+
+maintainers:
+  - Wesley Cheng <[email protected]>
+
+description: |
+  Qualcomm PMIC Type C Detect
+
+properties:
+  compatible:
+    enum:
+      - qcom,pm8150b-usb-typec
+
+  reg:

Documentation/devicetree/bindings/usb/qcom,pmic-typec.yaml new file +15 -0

+
+    properties:
+      compatible:
+        enum:
+          - usb-c-connector
+
+      power-role:
+       enum:
+         - dual
+         - source
+         - sink
+
+      data-role:
+        enum:
+          - dual

Documentation/devicetree/bindings/usb/qcom,pmic-typec.yaml new file +53 -1

+            type: object
+
+            properties:
+              remote-endpoint:
+                maxItems: 1
+                description: Node reference to the role switch node
+
+    required:
+      - compatible
+
+required:
+  - compatible
+  - interrupts
+  - connector
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    pm8150b {
+        #address-cells = <1>;
+        #size-cells = <0>;
+        qcom,typec@1500 {
+            compatible = "qcom,pm8150b-usb-typec";
+            reg = <0x1500>;
+            interrupts =
+                <0x2 0x15 0x5 IRQ_TYPE_EDGE_RISING>;
+
+            connector {
+                compatible = "usb-c-connector";
+                power-role = "dual";
+                data-role = "dual";
+                port {
+                    #address-cells = <1>;
+                    #size-cells = <0>;
+                    usb3_data_ss: endpoint@0 {
+                        reg = <0>;
+                        remote-endpoint =
+                                <&qmp_ss_mux>;
+                    };
+
+                    usb3_role: endpoint@1 {
+
+                        reg = <1>;
+                        remote-endpoint =
+                                <&dwc3_drd_switch>;
+                    };
+                };
+            };
+        };
+    };
+...
--

The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum, a Linux Foundation Collaborative Project

On Wed, Jun 17, 2020 at 12:02 PM Wesley Cheng <[email protected]> wrote:

You are duplicating everything in usb-connector.yaml. You should have a $ref to it.

This is wrong. The connector binding says port 0 is the connection the USB HS controller.

What's a type C mux node? Is there a binding for that? There's an ongoing discussion with the CrOS folks on how to describe Alt mode mux/switches.

Documentation/devicetree/bindings/usb/qcom,pmic-typec.yaml line 64

Quoted 9 lines

Documentation/devicetree/bindings/usb/qcom,pmic-typec.yaml new file +9 -0

+            type: object
+
+            properties:
+              remote-endpoint:
+                maxItems: 1
+                description: Node reference to the type C mux
+
+          endpoint@1:
+            description: Connection to role switch node

Again, what's this?

Quoted 5 lines · Rob Herring

On Wed, Jun 17, 2020 at 12:02 PM Wesley Cheng <[email protected]> wrote:

You are duplicating everything in usb-connector.yaml. You should have a $ref to it.

Hi Rob,

Sure, I will add a reference to that doc.

Quoted 7 lines

This is wrong. The connector binding says port 0 is the connection the USB HS controller.

What's a type C mux node? Is there a binding for that? There's an ongoing discussion with the CrOS folks on how to describe Alt mode mux/switches.

I reviewed the connector binding previously, and couldn't seem to come up with a model which fit a design where the type C controller (ie the entity which does the CC orientation and role detection) does not have the SS lane mux included. The SS lane mux is the HW which handles the selection of the SS lanes to utilize based on cable orientation.

Quoted 21 lines · Wesley Cheng

Quoted 5 lines · Rob Herring

On Wed, Jun 17, 2020 at 12:02 PM Wesley Cheng <[email protected]> wrote:

You are duplicating everything in usb-connector.yaml. You should have a $ref to it.

Hi Rob,

Sure, I will add a reference to that doc.

Quoted 7 lines

This is wrong. The connector binding says port 0 is the connection the USB HS controller.

What's a type C mux node? Is there a binding for that? There's an ongoing discussion with the CrOS folks on how to describe Alt mode mux/switches.

Quoted 5 lines

I reviewed the connector binding previously, and couldn't seem to come up with a model which fit a design where the type C controller (ie the entity which does the CC orientation and role detection) does not have the SS lane mux included. The SS lane mux is the HW which handles the selection of the SS lanes to utilize based on cable orientation.

The intent was the controller would be the parent node of the connector.

How the SS lane mux is represented is what needs to be figured out. I don't know what that looks like, but it needs to be something that works for multiple designs. Ideally, that's an extension of the existing 'usb-c-connector' binding, but if there's good reasons to redesign it that can happen.

Rob

The PM8150B has a dedicated USB type C block, which can be used for type C orientation and role detection. Create the reference node to this type C block for further use.

Signed-off-by Wesley Cheng <[email protected]>

---
 arch/arm64/boot/dts/qcom/pm8150b.dtsi | 8 ++++++++
 1 file changed, 8 insertions(+)

arch/arm64/boot/dts/qcom/pm8150b.dtsi +0 -0

index 322379d5c31f..ec44a8bc2f84 100644

arch/arm64/boot/dts/qcom/pm8150b.dtsi +2 -0

+		};
+
 		adc@3100 {
 			compatible = "qcom,spmi-adc5";
 			reg = <0x3100>;

Signature · 2 lines

The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
a Linux Foundation Collaborative Project

drivers/regulator/Kconfig +0 -0

index 074a2ef55943..79d6b7596f0b 100644
@@ -797,6 +797,16 @@ config REGULATOR_QCOM_SPMI
 	  Qualcomm SPMI PMICs as a module. The module will be named
 	  "qcom_spmi-regulator".

drivers/regulator/Kconfig +1 -0

+
 config REGULATOR_RC5T583
 	tristate "RICOH RC5T583 Power regulators"
 	depends on MFD_RC5T583

drivers/regulator/Makefile +0 -0

index c0d6b96ebd78..cbab28aa7b56 100644

Some Qualcomm PMICs have the capability to source the VBUS output to connected peripherals. This driver will register a regulator to the regulator list to enable or disable this source by an external driver.

Signed-off-by Wesley Cheng <[email protected]>

---
 drivers/regulator/Kconfig                   |  10 ++
 drivers/regulator/Makefile                  |   1 +
 drivers/regulator/qcom_usb_vbus-regulator.c | 100 ++++++++++++++++++++
 3 files changed, 111 insertions(+)
 create mode 100644 drivers/regulator/qcom_usb_vbus-regulator.c

drivers/regulator/Kconfig +10 -0

index 074a2ef55943..79d6b7596f0b 100644
@@ -797,6 +797,16 @@ config REGULATOR_QCOM_SPMI
 	  Qualcomm SPMI PMICs as a module. The module will be named
 	  "qcom_spmi-regulator".
 
+config REGULATOR_QCOM_USB_VBUS
+	tristate "Qualcomm USB Vbus regulator driver"
+	depends on SPMI || COMPILE_TEST
+	help
+	  If you say yes to this option, support will be included for the
+	  regulator used to enable the VBUS output.
+
+	  Say M here if you want to include support for enabling the VBUS output
+	  as a module. The module will be named "qcom_usb_vbus-regulator".
+
 config REGULATOR_RC5T583
 	tristate "RICOH RC5T583 Power regulators"
 	depends on MFD_RC5T583

drivers/regulator/Makefile +1 -0

index c0d6b96ebd78..cbab28aa7b56 100644
@@ -89,6 +89,7 @@ obj-$(CONFIG_REGULATOR_QCOM_RPM) += qcom_rpm-regulator.o
 obj-$(CONFIG_REGULATOR_QCOM_RPMH) += qcom-rpmh-regulator.o
 obj-$(CONFIG_REGULATOR_QCOM_SMD_RPM) += qcom_smd-regulator.o
 obj-$(CONFIG_REGULATOR_QCOM_SPMI) += qcom_spmi-regulator.o
+obj-$(CONFIG_REGULATOR_QCOM_USB_VBUS) += qcom_usb_vbus-regulator.o
 obj-$(CONFIG_REGULATOR_PALMAS) += palmas-regulator.o
 obj-$(CONFIG_REGULATOR_PFUZE100) += pfuze100-regulator.o
 obj-$(CONFIG_REGULATOR_PV88060) += pv88060-regulator.o

drivers/regulator/qcom_usb_vbus-regulator.c new file +29 -0

new file mode 100644
index 000000000000..fa7a3d891808
@@ -0,0 +1,100 @@
+// SPDX-License-Identifier: GPL-2.0-only
+//
+// Qualcomm PMIC VBUS output regulator driver
+//
+// Copyright (c) 2020, The Linux Foundation. All rights reserved.
+
+#include <linux/module.h>
+#include <linux/err.h>
+#include <linux/kernel.h>
+#include <linux/of.h>
+#include <linux/of_device.h>
+#include <linux/platform_device.h>
+#include <linux/regulator/driver.h>
+#include <linux/regulator/of_regulator.h>
+#include <linux/regmap.h>
+
+#define CMD_OTG				0x40
+#define OTG_EN				BIT(0)
+#define OTG_CFG				0x53
+#define OTG_EN_SRC_CFG			BIT(1)
+
+static const struct regulator_ops qcom_usb_vbus_reg_ops = {
+	.enable = regulator_enable_regmap,
+	.disable = regulator_disable_regmap,
+	.is_enabled = regulator_is_enabled_regmap,
+};
+
+static struct regulator_desc qcom_usb_vbus_rdesc = {
+	.name = "usb_vbus",

drivers/regulator/qcom_usb_vbus-regulator.c new file +26 -0

+	struct regulator_config config = { };
+	struct regulator_init_data *init_data;
+	int ret;
+	u32 base;
+
+	ret = of_property_read_u32(dev->of_node, "reg", &base);
+	if (ret < 0) {
+		dev_err(dev, "no base address found\n");
+		return ret;
+	}
+
+	regmap = dev_get_regmap(dev->parent, NULL);
+	if (regmap) {
+		dev_err(dev, "Failed to get regmap\n");
+		return -ENOENT;
+	}
+
+	init_data = of_get_regulator_init_data(dev, dev->of_node,
+					       &qcom_usb_vbus_rdesc);
+	if (!init_data)
+		return -ENOMEM;
+
+	qcom_usb_vbus_rdesc.enable_reg = base + CMD_OTG;
+	qcom_usb_vbus_rdesc.enable_mask = OTG_EN;
+	config.dev = dev;
+	config.init_data = init_data;

drivers/regulator/qcom_usb_vbus-regulator.c new file +9 -0

+
+	/* Disable HW logic for VBUS enable */
+	regmap_update_bits(regmap, base + OTG_CFG, OTG_EN_SRC_CFG, 0);
+
+	return 0;
+}
+
+static struct platform_driver qcom_usb_vbus_regulator_driver = {
+	.driver		= {

Signature · 2 lines

The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
a Linux Foundation Collaborative Project

Add the required DTS node for the USB VBUS output regulator, which is available on PM8150B. This will provide the VBUS source to connected peripherals.

Signed-off-by Wesley Cheng <[email protected]>

---
 arch/arm64/boot/dts/qcom/pm8150b.dtsi   | 6 ++++++
 arch/arm64/boot/dts/qcom/sm8150-mtp.dts | 7 +++++++
 2 files changed, 13 insertions(+)

arch/arm64/boot/dts/qcom/pm8150b.dtsi +0 -0

index ec44a8bc2f84..b7274d9d7341 100644
@@ -22,6 +22,12 @@ power-on@800 {
 			status = "disabled";
 		};

arch/arm64/boot/dts/qcom/sm8150-mtp.dts +7 -0

index 6c6325c3af59..3845d19893eb 100644
@@ -426,6 +426,13 @@ &usb_1 {
 	status = "okay";
 };
 
+&spmi_bus {
+	pmic@2 {
+		qcom,dcdc@1100 {
+			status = "okay";
+		};
+};
+
 &usb_1_dwc3 {
 	dr_mode = "peripheral";
 };

Signature · 2 lines

The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
a Linux Foundation Collaborative Project

Add the required DTS node for the USB VBUS output regulator, which is available on PM8150B. This will provide the VBUS source to connected peripherals.

Signed-off-by Wesley Cheng <[email protected]>

---
 arch/arm64/boot/dts/qcom/pm8150b.dtsi   | 6 ++++++
 arch/arm64/boot/dts/qcom/sm8150-mtp.dts | 7 +++++++
 2 files changed, 13 insertions(+)

arch/arm64/boot/dts/qcom/pm8150b.dtsi +0 -0

index ec44a8bc2f84..b7274d9d7341 100644

arch/arm64/boot/dts/qcom/pm8150b.dtsi +5 -0

+			compatible = "qcom,pm8150b-vbus-reg";
+			status = "disabled";
+			reg = <0x1100>;
+		};
+
 		qcom,typec@1500 {
 			compatible = "qcom,pm8150b-usb-typec";
 			status = "disabled";

arch/arm64/boot/dts/qcom/sm8150-mtp.dts +0 -0

index 6c6325c3af59..3845d19893eb 100644

arch/arm64/boot/dts/qcom/sm8150-mtp.dts +1 -0

+
 &usb_1_dwc3 {
 	dr_mode = "peripheral";
 };

Signature · 2 lines

The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
a Linux Foundation Collaborative Project