Skip to contentSkip to conversation

dt-bindings: usb: add documentation for typec switch simple driver

PATCH Superseded Li Jun 4 participants 13 messages Nov 23, 2020 – Dec 3, 2020

Subsystems (5)

v6 of 7 Superseded Latest is v7 →

lore
Share & tools
lore

Li Jun

author
#0 lore raw

PATCH v6 1/6 dt-bindings: usb: add documentation for typec switch simple driver

Some platforms need a simple driver to do some controls according to typec orientation, this can be extended to be a generic driver with compatible with "typec-orientation-switch".

---
changes for v6:
- Use general mux bindings for typec switch, one typec switch may have 1 or 2 GPIOs for channel selection, if 1 GPIO, only can be used to select cc1 or cc2; if 2 GPIOs, the second GPIO can be used to deselect both channels or keep normal operations.
- Add one more connection to usb controller.

No changes for v5.

changes on v4:
- Use compatible instead of bool property for switch matching.
- Change switch GPIO to be switch simple.
- Change the active channel selection GPIO to be optional.

previous discussion:
http://patchwork.ozlabs.org/patch/1054342/

 .../bindings/usb/typec-switch-simple.yaml          | 122 +++++++++++++++++++++
 1 file changed, 122 insertions(+)
Documentation/devicetree/bindings/usb/typec-switch-simple.yaml new file +122 -0
new file mode 100644
index 0000000..030ade5
@@ -0,0 +1,122 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/usb/typec-switch-simple.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Typec Orientation Switch Simple Solution Bindings
+
+maintainers:
+  - Li Jun <[email protected]>
+
+description: |-
+  USB SuperSpeed (SS) lanes routing to which side of typec connector is
+  decided by orientation, this maybe achieved by some simple control like
+  GPIO toggle.
+
+properties:
+  compatible:
+    const: typec-orientation-switch
+
+  '#mux-control-cells':
+    const: 0
+
+  switch-gpios:
+    description: |
+      GPIO specifiers to select the target channel of mux.
+      The first GPIO is for cc1 and cc2 selection, the GPIO flag use
+      GPIO_ACTIVE_HIGH if GPIO physical state high is for cc1; or use
+      GPIO_ACTIVE_LOW if GPIO physical state low is for cc1.
+      The second gpio is to deselect any channles by places all channels
+      in high-impedance state to reduce current consumption, the gpio flag
+      use GPIO_ACTIVE_HIGH if GPIO physical state high is for
+      high-impedance state (so low for normal operations); or Use
+      GPIO_ACTIVE_LOW if GPIO physical state low is for high-impedance
+      state(so high for normal operations).
+    minItems: 1
+    maxItems: 2
+
+  idle-state:
+    description: -|
+      For TYPEC_ORIENTATION_NONE by deselect both channels if supported.
+    const: 2
+
+  # Standard properties described in
+  # Documentation/devicetree/bindings/mux/mux-controller.txt
+
+  port:
+    type: object
+    additionalProperties: false
+    description: -|
+      Connection to the remote endpoint using OF graph bindings that model
+      SS data bus to typec connector.
+
+    properties:
+      '#address-cells':
+        const: 1
+
+      '#size-cells':
+        const: 0
+
+      endpoint@0:
+        type: object
+        description: Endpoint connected to typec connector.
+        additionalProperties: false
+
+        properties:
+          reg:
+            const: 0
+          remote-endpoint: true
+
+        required:
+          - remote-endpoint
+
+      endpoint@1:
+        type: object
+        description: Endpoint connected to usb controller.
+        additionalProperties: false
+
+        properties:
+          reg:
+            const: 1
+          remote-endpoint: true
+
+        required:
+          - remote-endpoint
+
+    required:
+      - endpoint@0
+
+required:
+  - compatible
+  - port
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    typec_switch: mux-controller {
+        compatible = "typec-orientation-switch";
+        #mux-control-cells = <0>;
+        pinctrl-names = "default";
+        pinctrl-0 = <&pinctrl_ss_sel>;
+        switch-gpios = <&gpio3 15 GPIO_ACTIVE_HIGH>,
+                       <&gpio2 20 GPIO_ACTIVE_HIGH>;
+        idle-state = <2>;
+
+        port {
+                #address-cells = <1>;
+                #size-cells = <0>;
+
+                usb3_orien_sel: endpoint@0 {
+                        reg = <0>;
+                        remote-endpoint = <&typec_con_ss>;
+                };
+
+                usb3_con_data: endpoint@1 {
+                        reg = <1>;
+                        remote-endpoint = <&dwc3_0>;
+                };
+        };
+    };
Signature · 1 line
2.7.4
author
#1 lore raw

PATCH v6 2/6 device property: Add fwnode_is_compatible() and device_is_compatible() helpers

From: Heikki Krogerus <[email protected]>

Since there are also some ACPI platforms where the "compatible" property is used, introducing a generic helper function fwnode_is_compatible() that can be used with DT, ACPI and swnodes, and a wrapper function device_is_compatible() with it.

The function calls of_device_is_comaptible() with OF nodes, and with ACPI and swnodes it matches the given string against the "compatible" string property array.

---
 drivers/base/property.c  | 39 +++++++++++++++++++++++++++++++++++++++
 include/linux/property.h |  2 ++
 2 files changed, 41 insertions(+)
drivers/base/property.c +39 -0
index d58aa98..d1c1f30 100644
@@ -1184,3 +1184,42 @@ const void *device_get_match_data(struct device *dev)
 	return fwnode_call_ptr_op(dev_fwnode(dev), device_get_match_data, dev);
 }
 EXPORT_SYMBOL_GPL(device_get_match_data);
+
+/**
+ * fwnode_is_compatible - Check does fwnode have the given compatible string
+ * @fwnode: fwnode with the "compatible" property
+ * @compat: The compatible string
+ *
+ * Match the compatible strings of @fwnode against @compat.
+ *
+ * Returns positive value on match, and 0 when no matching compatible
+ * string is found.
+ */
+int fwnode_is_compatible(struct fwnode_handle *fwnode, const char *compat)
+{
+	int ret;
+
+	if (is_of_node(fwnode))
+		return of_device_is_compatible(to_of_node(fwnode), compat);
+
+	ret = fwnode_property_match_string(fwnode, "compatible", compat);
+
+	return ret < 0 ? 0 : 1;
+}
+EXPORT_SYMBOL_GPL(fwnode_is_compatible);
+
+/**
+ * device_is_compatible - Check does a device have the given compatible string
+ * @dev: Device with the "compatible" property
+ * @compat: The compatible string
+ *
+ * Match the compatible strings of @dev against @compat.
+ *
+ * Returns positive value on match, and 0 when no matching compatible
+ * string is found.
+ */
+int device_is_compatible(struct device *dev, const char *compat)
+{
+	return fwnode_is_compatible(dev_fwnode(dev), compat);
+}
+EXPORT_SYMBOL_GPL(device_is_compatible);
include/linux/property.h +2 -0
index 9f805c4..42c1d99 100644
@@ -48,6 +48,7 @@ int device_property_read_string(struct device *dev, const char *propname,
 				const char **val);
 int device_property_match_string(struct device *dev,
 				 const char *propname, const char *string);
+int device_is_compatible(struct device *dev, const char *compat);
 
 bool fwnode_device_is_available(const struct fwnode_handle *fwnode);
 bool fwnode_property_present(const struct fwnode_handle *fwnode,
@@ -117,6 +118,7 @@ struct fwnode_handle *fwnode_handle_get(struct fwnode_handle *fwnode);
 void fwnode_handle_put(struct fwnode_handle *fwnode);
 
 int fwnode_irq_get(struct fwnode_handle *fwnode, unsigned int index);
+int fwnode_is_compatible(struct fwnode_handle *fwnode, const char *compat);
 
 unsigned int device_get_child_node_count(struct device *dev);
 
Signature · 1 line
2.7.4
author
#2 lore raw

PATCH v6 3/6 usb: typec: mux: add "compatible" property for switch match

In reply to Li Jun

For those need a dedicated typec switch simple solution driver, use compatible property for matching.

---
 drivers/usb/typec/mux.c | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)
drivers/usb/typec/mux.c +4 -3
index 52ad277..3da17d1 100644
@@ -39,7 +39,8 @@ static void *typec_switch_match(struct device_connection *con, int ep,
 {
 	struct device *dev;
 
-	if (con->id && !fwnode_property_present(con->fwnode, con->id))
+	if (con->id && !fwnode_is_compatible(con->fwnode, con->id) &&
+		       !fwnode_property_present(con->fwnode, con->id))
 		return NULL;
 
 	dev = class_find_device(&typec_mux_class, NULL, con->fwnode,
@@ -61,8 +62,8 @@ struct typec_switch *fwnode_typec_switch_get(struct fwnode_handle *fwnode)
 {
 	struct typec_switch *sw;
 
-	sw = fwnode_connection_find_match(fwnode, "orientation-switch", NULL,
-					  typec_switch_match);
+	sw = fwnode_connection_find_match(fwnode, "typec-orientation-switch",
+					  NULL, typec_switch_match);
 	if (!IS_ERR_OR_NULL(sw))
 		WARN_ON(!try_module_get(sw->dev.parent->driver->owner));
 
Signature · 1 line
2.7.4
author
#3 lore raw

PATCH v6 4/6 usb: typec: mux: use fwnode's dev for driver module user count

In reply to Li Jun

As the typec switch provider driver's dev may not the parent of typec_switch dev(may be the switch's parent's parent), but we use the typec switch provider driver dev's fwnode anyway, so change to use fwnode's dev to get driver's user count.

---
New patch for v6.

 drivers/usb/typec/mux.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/usb/typec/mux.c +2 -2
index 3da17d1..0219aa4 100644
@@ -65,7 +65,7 @@ struct typec_switch *fwnode_typec_switch_get(struct fwnode_handle *fwnode)
 	sw = fwnode_connection_find_match(fwnode, "typec-orientation-switch",
 					  NULL, typec_switch_match);
 	if (!IS_ERR_OR_NULL(sw))
-		WARN_ON(!try_module_get(sw->dev.parent->driver->owner));
+		WARN_ON(!try_module_get(dev_fwnode(&sw->dev)->dev->driver->owner));
 
 	return sw;
 }
@@ -80,7 +80,7 @@ EXPORT_SYMBOL_GPL(fwnode_typec_switch_get);
 void typec_switch_put(struct typec_switch *sw)
 {
 	if (!IS_ERR_OR_NULL(sw)) {
-		module_put(sw->dev.parent->driver->owner);
+		module_put(dev_fwnode(&sw->dev)->dev->driver->owner);
 		put_device(&sw->dev);
 	}
 }
Signature · 1 line
2.7.4
maintainer Acked-by on v6 4/6
#4 lore raw

Re: [PATCH v6 4/6] usb: typec: mux: use fwnode's dev for driver module user count

Quoted 6 lines · Li Jun

As the typec switch provider driver's dev may not the parent of typec_switch dev(may be the switch's parent's parent), but we use the typec switch provider driver dev's fwnode anyway, so change to use fwnode's dev to get driver's user count.

Quoted 30 lines

---
New patch for v6.

 drivers/usb/typec/mux.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/usb/typec/mux.c +2 -2
index 3da17d1..0219aa4 100644
@@ -65,7 +65,7 @@ struct typec_switch *fwnode_typec_switch_get(struct fwnode_handle *fwnode)
 	sw = fwnode_connection_find_match(fwnode, "typec-orientation-switch",
 					  NULL, typec_switch_match);
 	if (!IS_ERR_OR_NULL(sw))
-		WARN_ON(!try_module_get(sw->dev.parent->driver->owner));
+		WARN_ON(!try_module_get(dev_fwnode(&sw->dev)->dev->driver->owner));
 
 	return sw;
 }
@@ -80,7 +80,7 @@ EXPORT_SYMBOL_GPL(fwnode_typec_switch_get);
 void typec_switch_put(struct typec_switch *sw)
 {
 	if (!IS_ERR_OR_NULL(sw)) {
-		module_put(sw->dev.parent->driver->owner);
+		module_put(dev_fwnode(&sw->dev)->dev->driver->owner);
 		put_device(&sw->dev);
 	}
 }
Signature · 1 line
2.7.4

thanks,

Signature · 1 line
heikki
author
#5 lore raw

PATCH v6 5/6 usb: typec: mux: add typec switch via general mux control

In reply to Li Jun

The general mux controller can be easily extended to support various mux selection, this especially fits typec orientation switch block with a dedicated driver.

---
New patch for v6.

 drivers/usb/typec/bus.h       |  1 +
 drivers/usb/typec/mux.c       | 44 ++++++++++++++++++++++++++++++++++++++++---
 include/linux/usb/typec_mux.h |  7 +------
 3 files changed, 43 insertions(+), 9 deletions(-)
drivers/usb/typec/bus.h +1 -0
index 8ba8112..235ee82 100644
@@ -38,6 +38,7 @@ extern struct class typec_mux_class;
 struct typec_switch {
 	struct device dev;
 	typec_switch_set_fn_t set;
+	struct mux_control *mux_ctrl;
 };
 
 struct typec_mux {
drivers/usb/typec/mux.c +41 -3

76 lines not on this page · raw message

include/linux/usb/typec_mux.h +1 -6
index a9d9957..e2ea141 100644
@@ -26,15 +26,10 @@ struct typec_switch *fwnode_typec_switch_get(struct fwnode_handle *fwnode);
 void typec_switch_put(struct typec_switch *sw);
 int typec_switch_set(struct typec_switch *sw,
 		     enum typec_orientation orientation);
-
-static inline struct typec_switch *typec_switch_get(struct device *dev)
-{
-	return fwnode_typec_switch_get(dev_fwnode(dev));
-}
-
 struct typec_switch *
 typec_switch_register(struct device *parent,
 		      const struct typec_switch_desc *desc);
+struct typec_switch *typec_switch_get(struct device *dev);
 void typec_switch_unregister(struct typec_switch *sw);
 
 void typec_switch_set_drvdata(struct typec_switch *sw, void *data);
Signature · 1 line
2.7.4
#6 lore raw

Re: [PATCH v6 5/6] usb: typec: mux: add typec switch via general mux control

Quoted 3 lines · Li Jun

The general mux controller can be easily extended to support various mux selection, this especially fits typec orientation switch block with a dedicated driver.

...

drivers/usb/typec/mux.c static void *typec_switch_match(struct device_connection *con, int ep, · line 50

Quoted 11 lines
drivers/usb/typec/mux.c +0 -2
@@ -42,10 +43,8 @@ static void *typec_switch_match(struct device_connection *con, int ep,
 	if (con->id && !fwnode_is_compatible(con->fwnode, con->id) &&
 		       !fwnode_property_present(con->fwnode, con->id))
 		return NULL;
-
 	dev = class_find_device(&typec_mux_class, NULL, con->fwnode,
 				switch_fwnode_match);
-
 	return dev ? to_typec_switch(dev) : ERR_PTR(-EPROBE_DEFER);
 }
 

Not related change.

...

drivers/usb/typec/mux.c typec_switch_register(struct device *parent,

Quoted 4 lines
drivers/usb/typec/mux.c +3 -0
+	if (sw->mux_ctrl)
+		return typec_switch_mux_ctrl(sw->mux_ctrl, orientation);
 
+	else

Redundant.

Quoted 1 line
drivers/usb/typec/mux.c +1 -0
+		return sw->set(sw, orientation);
Signature · 2 lines
With Best Regards,
Andy Shevchenko
author
#7 lore raw

RE: [PATCH v6 5/6] usb: typec: mux: add typec switch via general mux control

Hi,

Quoted 23 lines

-----Original Message-----
From: Andy Shevchenko <[email protected]>
Sent: Monday, November 23, 2020 11:31 PM
To: Jun Li <[email protected]>
Cc: [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; dl-linux-imx <[email protected]>; Peter Chen <[email protected]>
Subject: Re: [PATCH v6 5/6] usb: typec: mux: add typec switch via general mux control

Quoted 3 lines · Li Jun

The general mux controller can be easily extended to support various mux selection, this especially fits typec orientation switch block with a dedicated driver.

...

Review static void *typec_switch_match(struct

Quoted 1 line
(quoted diff) +0 -0
@@ -42,10 +43,8 @@ static void *typec_switch_match(struct

device_connection *con, int ep,

Quoted 11 lines

drivers/usb/typec/mux.c static void *typec_switch_match(struct device_connection *con, int ep, · line 50

Quoted 9 lines
drivers/usb/typec/mux.c +0 -2
 	if (con->id && !fwnode_is_compatible(con->fwnode, con->id) &&
 		       !fwnode_property_present(con->fwnode, con->id))
 		return NULL;
-
 	dev = class_find_device(&typec_mux_class, NULL, con->fwnode,
 				switch_fwnode_match);
-
 	return dev ? to_typec_switch(dev) : ERR_PTR(-EPROBE_DEFER);  }
 

Not related change.

Oops, above 2 blank lines should be kept, I will remove the changes.

Quoted 9 lines

...

drivers/usb/typec/mux.c typec_switch_register(struct device *parent,

Quoted 4 lines
drivers/usb/typec/mux.c +3 -0
+	if (sw->mux_ctrl)
+		return typec_switch_mux_ctrl(sw->mux_ctrl, orientation);
 
+	else

Redundant.

will remove it.

Thanks
Li Jun

Quoted 7 lines

drivers/usb/typec/mux.c typec_switch_register(struct device *parent, · line 189

Quoted 2 lines
drivers/usb/typec/mux.c +1 -0
+		return sw->set(sw, orientation);

--
With Best Regards,
Andy Shevchenko

author
#8 lore raw

PATCH v6 6/6 usb: typec: mux: add typec switch simple driver

In reply to Li Jun

This patch adds a simple typec switch driver for cases which only needs some simple operations but a dedicated driver is required, current driver only supports GPIO toggle to switch the super speed active channel according to typec orientation.

---
Changes for v6:
- Use general mux control for typec switch, currently only support max 2 GPIOs to control one typec switch with 3 states: orientation normal(cc1), reverse(cc2), none(deselected both channels).

Changes for v5:
- A few changes address Andy's comment, remove gpio check as it's optional, add module name for Kconfig, use correct header files, and other minor changes.
- Remove the mutex lock as it's not required currently.

Changes for v4:
- Change driver name to be switch simple from switch GPIO, to make it generic for possible extention.
- Use compatiable "typec-orientation-switch" instead of bool property for switch matching.
- Make acitve channel selection GPIO to be optional.
- Remove Andy's R-b tag since the driver changes a lot.

Change for v3:
- Remove file name in driver description.
- Add Andy Shevchenko's Reviewed-by tag.

Changes for v2:
- Use the correct head files for gpio api and of_device_id:
#include <linux/gpio/consumer.h>
#include <linux/mod_devicetable.h>
- Add driver dependency on GPIOLIB

 drivers/usb/typec/mux/Kconfig         |  10 +++
 drivers/usb/typec/mux/Makefile        |   1 +
 drivers/usb/typec/mux/switch-simple.c | 126 ++++++++++++++++++++++++++++++++++
 3 files changed, 137 insertions(+)
drivers/usb/typec/mux/Kconfig +10 -0
index a4dbd11..11320d7 100644
@@ -18,4 +18,14 @@ config TYPEC_MUX_INTEL_PMC
 	  control the USB role switch and also the multiplexer/demultiplexer
 	  switches used with USB Type-C Alternate Modes.
 
+config TYPEC_SWITCH_SIMPLE
+	tristate "Type-C orientation switch simple driver"
+	depends on GPIOLIB
+	help
+	  Say Y or M if your system need a simple driver for typec switch
+	  control, like use GPIO to select active channel.
+
+	  To compile this driver as a module, choose M here: the
+	  module will be called switch-simple.
+
 endmenu
drivers/usb/typec/mux/Makefile +1 -0
index 280a6f5..712d0ad 100644
@@ -2,3 +2,4 @@
 
 obj-$(CONFIG_TYPEC_MUX_PI3USB30532)	+= pi3usb30532.o
 obj-$(CONFIG_TYPEC_MUX_INTEL_PMC)	+= intel_pmc_mux.o
+obj-$(CONFIG_TYPEC_SWITCH_SIMPLE)	+= switch-simple.o
drivers/usb/typec/mux/switch-simple.c new file +126 -0

126 lines not on this page · raw message

Signature · 1 line
2.7.4
maintainer Acked-by on v6 6/6
#9 lore raw

Re: [PATCH v6 6/6] usb: typec: mux: add typec switch simple driver

Quoted 6 lines · Li Jun

This patch adds a simple typec switch driver for cases which only needs some simple operations but a dedicated driver is required, current driver only supports GPIO toggle to switch the super speed active channel according to typec orientation.

Quoted 197 lines

---
Changes for v6:
- Use general mux control for typec switch, currently only support max 2 GPIOs to control one typec switch with 3 states: orientation normal(cc1), reverse(cc2), none(deselected both channels).

Changes for v5:
- A few changes address Andy's comment, remove gpio check as it's optional, add module name for Kconfig, use correct header files, and other minor changes.
- Remove the mutex lock as it's not required currently.

Changes for v4:
- Change driver name to be switch simple from switch GPIO, to make it generic for possible extention.
- Use compatiable "typec-orientation-switch" instead of bool property for switch matching.
- Make acitve channel selection GPIO to be optional.
- Remove Andy's R-b tag since the driver changes a lot.

Change for v3:
- Remove file name in driver description.
- Add Andy Shevchenko's Reviewed-by tag.

Changes for v2:
- Use the correct head files for gpio api and of_device_id:
#include <linux/gpio/consumer.h>
#include <linux/mod_devicetable.h>
- Add driver dependency on GPIOLIB

 drivers/usb/typec/mux/Kconfig         |  10 +++
 drivers/usb/typec/mux/Makefile        |   1 +
 drivers/usb/typec/mux/switch-simple.c | 126 ++++++++++++++++++++++++++++++++++
 3 files changed, 137 insertions(+)
drivers/usb/typec/mux/Kconfig +10 -0
index a4dbd11..11320d7 100644
@@ -18,4 +18,14 @@ config TYPEC_MUX_INTEL_PMC
 	  control the USB role switch and also the multiplexer/demultiplexer
 	  switches used with USB Type-C Alternate Modes.
 
+config TYPEC_SWITCH_SIMPLE
+	tristate "Type-C orientation switch simple driver"
+	depends on GPIOLIB
+	help
+	  Say Y or M if your system need a simple driver for typec switch
+	  control, like use GPIO to select active channel.
+
+	  To compile this driver as a module, choose M here: the
+	  module will be called switch-simple.
+
 endmenu
drivers/usb/typec/mux/Makefile +1 -0
index 280a6f5..712d0ad 100644
@@ -2,3 +2,4 @@
 
 obj-$(CONFIG_TYPEC_MUX_PI3USB30532)	+= pi3usb30532.o
 obj-$(CONFIG_TYPEC_MUX_INTEL_PMC)	+= intel_pmc_mux.o
+obj-$(CONFIG_TYPEC_SWITCH_SIMPLE)	+= switch-simple.o
drivers/usb/typec/mux/switch-simple.c new file +126 -0
new file mode 100644
index 0000000..4671169
@@ -0,0 +1,126 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * Type-C switch simple control driver
+ *
+ * Copyright 2020 NXP
+ * Author: Jun Li <[email protected]>
+ */
+
+#include <linux/delay.h>
+#include <linux/gpio/consumer.h>
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/mod_devicetable.h>
+#include <linux/mutex.h>
+#include <linux/mux/driver.h>
+#include <linux/platform_device.h>
+#include <linux/usb/typec_mux.h>
+
+struct typec_switch_simple {
+	struct typec_switch *sw;
+	struct mux_control *mux;
+	struct gpio_descs *switch_gpios;
+};
+
+static int typec_switch_simple_mux_set(struct mux_control *mux, int state)
+{
+	struct typec_switch_simple *typec_ss = mux_chip_priv(mux->chip);
+	DECLARE_BITMAP(values, BITS_PER_TYPE(state));
+
+	values[0] = state;
+	gpiod_set_array_value_cansleep(typec_ss->switch_gpios->ndescs,
+				       typec_ss->switch_gpios->desc,
+				       typec_ss->switch_gpios->info,
+				       values);
+
+	return 0;
+}
+
+static const struct mux_control_ops typec_switch_mux_ops = {
+	.set = typec_switch_simple_mux_set,
+};
+
+static int typec_switch_simple_probe(struct platform_device *pdev)
+{
+	struct device			*dev = &pdev->dev;
+	struct mux_chip			*mux_chip;
+	struct typec_switch_desc	sw_desc;
+	struct typec_switch_simple	*typec_ss;
+	int				idle_state;
+	int				pins;
+	int				ret;
+
+	pins = gpiod_count(dev, "switch");
+	mux_chip = devm_mux_chip_alloc(dev, 1, sizeof(*typec_ss));
+	if (IS_ERR(mux_chip))
+		return PTR_ERR(mux_chip);
+
+	typec_ss = mux_chip_priv(mux_chip);
+	mux_chip->ops = &typec_switch_mux_ops;
+
+	/* Get the super speed active channel selection GPIO */
+	typec_ss->switch_gpios = devm_gpiod_get_array_optional(dev,
+				 "switch", GPIOD_OUT_LOW);
+	if (IS_ERR(typec_ss->switch_gpios))
+		return PTR_ERR(typec_ss->switch_gpios);
+
+	if (pins) {
+		WARN_ON(pins != typec_ss->switch_gpios->ndescs || pins > 2);
+		mux_chip->mux->states = pins + 1;
+	}
+
+	ret = device_property_read_u32(dev, "idle-state", (u32 *)&idle_state);
+	if (ret >= 0 && idle_state != MUX_IDLE_AS_IS) {
+		if (idle_state < 0 || idle_state >= mux_chip->mux->states) {
+			dev_err(dev, "invalid idle-state %u\n", idle_state);
+			return -EINVAL;
+		}
+		mux_chip->mux->idle_state = idle_state;
+	}
+
+	ret = devm_mux_chip_register(dev, mux_chip);
+	if (ret < 0)
+		return ret;
+
+	platform_set_drvdata(pdev, typec_ss);
+	sw_desc.drvdata = typec_ss;
+	sw_desc.fwnode = dev->fwnode;
+
+	typec_ss->sw = typec_switch_register(&mux_chip->dev, &sw_desc);
+	if (IS_ERR(typec_ss->sw)) {
+		dev_err(dev, "Error registering typec switch: %ld\n",
+			PTR_ERR(typec_ss->sw));
+		return PTR_ERR(typec_ss->sw);
+	}
+
+	return 0;
+}
+
+static int typec_switch_simple_remove(struct platform_device *pdev)
+{
+	struct typec_switch_simple *typec_ss = platform_get_drvdata(pdev);
+
+	typec_switch_unregister(typec_ss->sw);
+
+	return 0;
+}
+
+static const struct of_device_id of_typec_switch_simple_match[] = {
+	{ .compatible = "typec-orientation-switch" },
+	{ /* Sentinel */ }
+};
+MODULE_DEVICE_TABLE(of, of_typec_switch_simple_match);
+
+static struct platform_driver typec_switch_simple_driver = {
+	.probe		= typec_switch_simple_probe,
+	.remove		= typec_switch_simple_remove,
+	.driver		= {
+		.name	= "typec-switch-simple",
+		.of_match_table = of_typec_switch_simple_match,
+	},
+};
+
+module_platform_driver(typec_switch_simple_driver);
+MODULE_LICENSE("GPL v2");
+MODULE_DESCRIPTION("TypeC Orientation Switch Simple driver");
+MODULE_AUTHOR("Jun Li <[email protected]>");
Signature · 1 line
2.7.4

thanks,

Signature · 1 line
heikki
maintainer
#10 lore raw
In reply to Li Jun
Quoted 44 lines · Li Jun

Some platforms need a simple driver to do some controls according to typec orientation, this can be extended to be a generic driver with compatible with "typec-orientation-switch".

---
changes for v6:
- Use general mux bindings for typec switch, one typec switch may have 1 or 2 GPIOs for channel selection, if 1 GPIO, only can be used to select cc1 or cc2; if 2 GPIOs, the second GPIO can be used to deselect both channels or keep normal operations.
- Add one more connection to usb controller.

No changes for v5.

changes on v4:
- Use compatible instead of bool property for switch matching.
- Change switch GPIO to be switch simple.
- Change the active channel selection GPIO to be optional.

previous discussion:
http://patchwork.ozlabs.org/patch/1054342/

 .../bindings/usb/typec-switch-simple.yaml          | 122 +++++++++++++++++++++
 1 file changed, 122 insertions(+)
Documentation/devicetree/bindings/usb/typec-switch-simple.yaml new file +12 -0
new file mode 100644
index 0000000..030ade5
@@ -0,0 +1,122 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/usb/typec-switch-simple.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Typec Orientation Switch Simple Solution Bindings
+
+maintainers:
+  - Li Jun <[email protected]>
+
+description: |-

Documentation/devicetree/bindings/usb/typec-switch-simple.yaml line 22

Quoted 10 lines
Documentation/devicetree/bindings/usb/typec-switch-simple.yaml new file +10 -0
+  USB SuperSpeed (SS) lanes routing to which side of typec connector is
+  decided by orientation, this maybe achieved by some simple control like
+  GPIO toggle.
+
+properties:
+  compatible:
+    const: typec-orientation-switch
+
+  '#mux-control-cells':
+    const: 0

Who is the mux-control consumer?

Quoted 89 lines
Documentation/devicetree/bindings/usb/typec-switch-simple.yaml new file +89 -0
+
+  switch-gpios:
+    description: |
+      GPIO specifiers to select the target channel of mux.
+      The first GPIO is for cc1 and cc2 selection, the GPIO flag use
+      GPIO_ACTIVE_HIGH if GPIO physical state high is for cc1; or use
+      GPIO_ACTIVE_LOW if GPIO physical state low is for cc1.
+      The second gpio is to deselect any channles by places all channels
+      in high-impedance state to reduce current consumption, the gpio flag
+      use GPIO_ACTIVE_HIGH if GPIO physical state high is for
+      high-impedance state (so low for normal operations); or Use
+      GPIO_ACTIVE_LOW if GPIO physical state low is for high-impedance
+      state(so high for normal operations).
+    minItems: 1
+    maxItems: 2
+
+  idle-state:
+    description: -|
+      For TYPEC_ORIENTATION_NONE by deselect both channels if supported.
+    const: 2
+
+  # Standard properties described in
+  # Documentation/devicetree/bindings/mux/mux-controller.txt
+
+  port:
+    type: object
+    additionalProperties: false
+    description: -|
+      Connection to the remote endpoint using OF graph bindings that model
+      SS data bus to typec connector.
+
+    properties:
+      '#address-cells':
+        const: 1
+
+      '#size-cells':
+        const: 0
+
+      endpoint@0:
+        type: object
+        description: Endpoint connected to typec connector.
+        additionalProperties: false
+
+        properties:
+          reg:
+            const: 0
+          remote-endpoint: true
+
+        required:
+          - remote-endpoint
+
+      endpoint@1:
+        type: object
+        description: Endpoint connected to usb controller.
+        additionalProperties: false
+
+        properties:
+          reg:
+            const: 1
+          remote-endpoint: true
+
+        required:
+          - remote-endpoint
+
+    required:
+      - endpoint@0
+
+required:
+  - compatible
+  - port
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    typec_switch: mux-controller {
+        compatible = "typec-orientation-switch";
+        #mux-control-cells = <0>;
+        pinctrl-names = "default";
+        pinctrl-0 = <&pinctrl_ss_sel>;
+        switch-gpios = <&gpio3 15 GPIO_ACTIVE_HIGH>,
+                       <&gpio2 20 GPIO_ACTIVE_HIGH>;
+        idle-state = <2>;
+
+        port {
+                #address-cells = <1>;
+                #size-cells = <0>;
+

Documentation/devicetree/bindings/usb/typec-switch-simple.yaml line 121

Quoted 10 lines
Documentation/devicetree/bindings/usb/typec-switch-simple.yaml new file +10 -0
+                usb3_orien_sel: endpoint@0 {
+                        reg = <0>;
+                        remote-endpoint = <&typec_con_ss>;
+                };
+
+                usb3_con_data: endpoint@1 {
+                        reg = <1>;
+                        remote-endpoint = <&dwc3_0>;
+                };
+        };

This still seems unnecessarily complicated. What I had in mind is just something like this:

mux: mux-controller {
compatible = "gpio-mux";
#mux-control-cells = <0>;
mux-gpios = <&gpio3 15 GPIO_ACTIVE_HIGH>,

              <&gpio2 20 GPIO_ACTIVE_HIGH>;

idle-state = <2>;
};

connector {
compatible = "usb-c-connector";
mux-controls = <&mux>;
...
};

Then you aren't re-implementing the gpio-mux driver.

This should work for *any* mux implementation as long as the mux states always have the same meanings from the perspective of the connector.

Of course, I have little visibility into the possible h/w implementations for Type-C and maybe this isn't sufficient. So input from Type-C experts would be helpful.

Rob

author
#11 lore raw
Quoted 105 lines

-----Original Message-----
From: Rob Herring <[email protected]>
Sent: Tuesday, December 1, 2020 5:47 AM
To: Jun Li <[email protected]>
Cc: [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; dl-linux-imx <[email protected]>; Peter Chen <[email protected]>
Subject: Re: [PATCH v6 1/6] dt-bindings: usb: add documentation for typec switch simple driver

Quoted 13 lines · Li Jun

Some platforms need a simple driver to do some controls according to typec orientation, this can be extended to be a generic driver with compatible with "typec-orientation-switch".

---
changes for v6:
- Use general mux bindings for typec switch, one typec switch may have 1 or 2 GPIOs for channel selection, if 1 GPIO, only can be used to select cc1 or cc2; if 2 GPIOs, the second GPIO can be used to deselect both channels or keep normal operations.
- Add one more connection to usb controller.

Quoted 9 lines

No changes for v5.

changes on v4:
- Use compatible instead of bool property for switch matching.
- Change switch GPIO to be switch simple.
- Change the active channel selection GPIO to be optional.

previous discussion:

https://eur01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fpatch

Quoted 1 line

work.ozlabs.org%2Fpatch%2F1054342%2F&amp;data=04%7C01%7Cjun.li%40nxp.c

Quoted 1 line

om%7C4436142512ac45fef86f08d8957983c2%7C686ea1d3bc2b4c6fa92cd99c5c3016

Quoted 1 line

35%7C0%7C1%7C637423696442152522%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLj

Quoted 1 line

AwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&amp;sdata=

Quoted 3 lines

JCV9OtFkfLv4bH2LIxfnk0lVIO6j830%2F%2Bx2OMOi%2Fs6o%3D&amp;reserved=0

 .../bindings/usb/typec-switch-simple.yaml          | 122

+++++++++++++++++++++

Quoted 11 lines
 1 file changed, 122 insertions(+)

diff --git a/Documentation/devicetree/bindings/usb/typec-switch-simple.yaml b/Documentation/devicetree/bindings/usb/typec-switch-simple.yaml new file mode 100644
index 0000000..030ade5

Documentation/devicetree/bindings/usb/typec-switch-simple.yaml line 3

Quoted 3 lines
Documentation/devicetree/bindings/usb/typec-switch-simple.yaml new file +3 -0
@@ -0,0 +1,122 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2
+---
+$id:

+https://eur01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevi

Quoted 1 line

+cetree.org%2Fschemas%2Fusb%2Ftypec-switch-simple.yaml%23&amp;data=04%

Quoted 1 line

+7C01%7Cjun.li%40nxp.com%7C4436142512ac45fef86f08d8957983c2%7C686ea1d3

Quoted 1 line

+bc2b4c6fa92cd99c5c301635%7C0%7C1%7C637423696442152522%7CUnknown%7CTWF

Quoted 1 line

+pbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6

Quoted 1 line

+Mn0%3D%7C3000&amp;sdata=vSLcoGYWCgwpsi4LWbKo2VTyCVgN%2BA7zjHfE8QCS4rg

Quoted 3 lines

+%3D&amp;reserved=0
+$schema:

+https://eur01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevi

Quoted 1 line

+cetree.org%2Fmeta-schemas%2Fcore.yaml%23&amp;data=04%7C01%7Cjun.li%40

Quoted 1 line

+nxp.com%7C4436142512ac45fef86f08d8957983c2%7C686ea1d3bc2b4c6fa92cd99c

Quoted 1 line

+5c301635%7C0%7C1%7C637423696442152522%7CUnknown%7CTWFpbGZsb3d8eyJWIjo

Quoted 1 line

+iMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&am

Quoted 1 line

+p;sdata=0fd3wjAtKwLCQAY3NG2Be4qNA9FiFhtO0HIZmCK7AQs%3D&amp;reserved=0

Quoted 13 lines
Documentation/devicetree/bindings/usb/typec-switch-simple.yaml new file +13 -0
+
+title: Typec Orientation Switch Simple Solution Bindings
+
+maintainers:
+  - Li Jun <[email protected]>
+
+description: |-
+  USB SuperSpeed (SS) lanes routing to which side of typec connector
+is
+  decided by orientation, this maybe achieved by some simple control
+like
+  GPIO toggle.
+
Quoted 8 lines

Documentation/devicetree/bindings/usb/typec-switch-simple.yaml line 22

Quoted 6 lines
Documentation/devicetree/bindings/usb/typec-switch-simple.yaml new file +6 -0
+properties:
+  compatible:
+    const: typec-orientation-switch
+
+  '#mux-control-cells':
+    const: 0

Who is the mux-control consumer?

Typec(controller)

       ptn5110: tcpc@50 {
                compatible = "nxp,ptn5110";
                pinctrl-names = "default";
                pinctrl-0 = <&pinctrl_typec>;
                reg = <0x50>;
                interrupt-parent = <&gpio4>;
                interrupts = <19 8>;
                mux-controls = <&typec_switch>;
                mux-control-names = "mux-typec-switch";

                usb_con: connector {
                        compatible = "usb-c-connector";
                        ... ...
                        ports {
                                #address-cells = <1>;
                                #size-cells = <0>;

                                port@1 {
                                        reg = <1>;
                                        typec_con_ss: endpoint {
                                                remote-endpoint = <&usb3_orien_sel>;
                                        };
                                };
                        };
                };
        };
Quoted 119 lines

Documentation/devicetree/bindings/usb/typec-switch-simple.yaml

Quoted 10 lines
Documentation/devicetree/bindings/usb/typec-switch-simple.yaml new file +9 -0
+
+  switch-gpios:
+    description: |
+      GPIO specifiers to select the target channel of mux.
+      The first GPIO is for cc1 and cc2 selection, the GPIO flag use
+      GPIO_ACTIVE_HIGH if GPIO physical state high is for cc1; or use
+      GPIO_ACTIVE_LOW if GPIO physical state low is for cc1.
+      The second gpio is to deselect any channles by places all channels
+      in high-impedance state to reduce current consumption, the gpio

flag

Quoted 80 lines
Documentation/devicetree/bindings/usb/typec-switch-simple.yaml new file +80 -0
+      use GPIO_ACTIVE_HIGH if GPIO physical state high is for
+      high-impedance state (so low for normal operations); or Use
+      GPIO_ACTIVE_LOW if GPIO physical state low is for high-impedance
+      state(so high for normal operations).
+    minItems: 1
+    maxItems: 2
+
+  idle-state:
+    description: -|
+      For TYPEC_ORIENTATION_NONE by deselect both channels if supported.
+    const: 2
+
+  # Standard properties described in
+  # Documentation/devicetree/bindings/mux/mux-controller.txt
+
+  port:
+    type: object
+    additionalProperties: false
+    description: -|
+      Connection to the remote endpoint using OF graph bindings that model
+      SS data bus to typec connector.
+
+    properties:
+      '#address-cells':
+        const: 1
+
+      '#size-cells':
+        const: 0
+
+      endpoint@0:
+        type: object
+        description: Endpoint connected to typec connector.
+        additionalProperties: false
+
+        properties:
+          reg:
+            const: 0
+          remote-endpoint: true
+
+        required:
+          - remote-endpoint
+
+      endpoint@1:
+        type: object
+        description: Endpoint connected to usb controller.
+        additionalProperties: false
+
+        properties:
+          reg:
+            const: 1
+          remote-endpoint: true
+
+        required:
+          - remote-endpoint
+
+    required:
+      - endpoint@0
+
+required:
+  - compatible
+  - port
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    typec_switch: mux-controller {
+        compatible = "typec-orientation-switch";
+        #mux-control-cells = <0>;
+        pinctrl-names = "default";
+        pinctrl-0 = <&pinctrl_ss_sel>;
+        switch-gpios = <&gpio3 15 GPIO_ACTIVE_HIGH>,
+                       <&gpio2 20 GPIO_ACTIVE_HIGH>;
+        idle-state = <2>;
+
+        port {
+                #address-cells = <1>;
+                #size-cells = <0>;
+

Documentation/devicetree/bindings/usb/typec-switch-simple.yaml line 121

Quoted 10 lines
Documentation/devicetree/bindings/usb/typec-switch-simple.yaml new file +10 -0
+                usb3_orien_sel: endpoint@0 {
+                        reg = <0>;
+                        remote-endpoint = <&typec_con_ss>;
+                };
+
+                usb3_con_data: endpoint@1 {
+                        reg = <1>;
+                        remote-endpoint = <&dwc3_0>;
+                };
+        };

This still seems unnecessarily complicated. What I had in mind is just something like this:

mux: mux-controller {
compatible = "gpio-mux";
#mux-control-cells = <0>;
mux-gpios = <&gpio3 15 GPIO_ACTIVE_HIGH>,

              <&gpio2 20 GPIO_ACTIVE_HIGH>;

idle-state = <2>;
};

connector {
compatible = "usb-c-connector";
mux-controls = <&mux>;
...
};

Quoted 8 lines

Then you aren't re-implementing the gpio-mux driver.

This should work for *any* mux implementation as long as the mux states always have the same meanings from the perspective of the connector.

Of course, I have little visibility into the possible h/w implementations for Type-C and maybe this isn't sufficient. So input from Type-C experts would be helpful.

From h/w point view, this can work if only consider my(GPIO) case. But I still need register a typec switch in provider side to make it under the unified typec switch interface:

  7 struct typec_switch {
  6         struct device dev;
  5         typec_switch_set_fn_t set;
  4         struct mux_control *mux_ctrl;
  3 };

typec_switch->dev.parent = mux_chip->dev;

So either I put the typec switch creation in exiting mux-gpio driver; or I create a new typec switch driver with gpio mux code duplication.

If I go directly with mux control w/o(out of) typec_switch, then I don't need any driver change as you expect, but I guess this is not preferred, @Heikki, any comments?

Thanks
Li Jun

Quoted 2 lines

Rob

author
#12 lore raw

Hi Rob

Quoted 201 lines

-----Original Message-----
From: Jun Li
Sent: Tuesday, December 1, 2020 11:13 AM
To: Rob Herring <[email protected]>
Cc: [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; dl-linux-imx <[email protected]>; Peter Chen <[email protected]>
Subject: RE: [PATCH v6 1/6] dt-bindings: usb: add documentation for typec switch simple driver

Quoted 15 lines

-----Original Message-----
From: Rob Herring <[email protected]>
Sent: Tuesday, December 1, 2020 5:47 AM
To: Jun Li <[email protected]>
Cc: [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; dl-linux-imx <[email protected]>; Peter Chen <[email protected]>
Subject: Re: [PATCH v6 1/6] dt-bindings: usb: add documentation for typec switch simple driver

Quoted 24 lines
Quoted 22 lines · Li Jun

Some platforms need a simple driver to do some controls according to typec orientation, this can be extended to be a generic driver with compatible with "typec-orientation-switch".

---
changes for v6:
- Use general mux bindings for typec switch, one typec switch may have 1 or 2 GPIOs for channel selection, if 1 GPIO, only can be used to select cc1 or cc2; if 2 GPIOs, the second GPIO can be used to deselect both channels or keep normal operations.
- Add one more connection to usb controller.

No changes for v5.

changes on v4:
- Use compatible instead of bool property for switch matching.
- Change switch GPIO to be switch simple.
- Change the active channel selection GPIO to be optional.

previous discussion:

https://eur01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fpatch

Quoted 2 lines
Quoted 1 line

work.ozlabs.org%2Fpatch%2F1054342%2F&amp;data=04%7C01%7Cjun.li%40nxp.c

Quoted 2 lines
Quoted 1 line

om%7C4436142512ac45fef86f08d8957983c2%7C686ea1d3bc2b4c6fa92cd99c5c3016

Quoted 2 lines
Quoted 1 line

35%7C0%7C1%7C637423696442152522%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLj

Quoted 2 lines
Quoted 1 line

AwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&amp;sdata=

Quoted 6 lines
Quoted 3 lines

JCV9OtFkfLv4bH2LIxfnk0lVIO6j830%2F%2Bx2OMOi%2Fs6o%3D&amp;reserved=0

 .../bindings/usb/typec-switch-simple.yaml          | 122

+++++++++++++++++++++

Quoted 2 lines
 1 file changed, 122 insertions(+)
Quoted 13 lines

Documentation/devicetree/bindings/usb/typec-switch-simple.yaml line 3

Quoted 12 lines

diff --git a/Documentation/devicetree/bindings/usb/typec-switch-simple.yaml b/Documentation/devicetree/bindings/usb/typec-switch-simple.yaml new file mode 100644
index 0000000..030ade5

Documentation/devicetree/bindings/usb/typec-switch-simple.yaml new file +3 -0
@@ -0,0 +1,122 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2
+---
+$id:

+https://eur01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevi

Quoted 2 lines
Quoted 1 line

+cetree.org%2Fschemas%2Fusb%2Ftypec-switch-simple.yaml%23&amp;data=04%

Quoted 2 lines
Quoted 1 line

+7C01%7Cjun.li%40nxp.com%7C4436142512ac45fef86f08d8957983c2%7C686ea1d3

Quoted 2 lines
Quoted 1 line

+bc2b4c6fa92cd99c5c301635%7C0%7C1%7C637423696442152522%7CUnknown%7CTWF

Quoted 2 lines
Quoted 1 line

+pbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6

Quoted 2 lines
Quoted 1 line

+Mn0%3D%7C3000&amp;sdata=vSLcoGYWCgwpsi4LWbKo2VTyCVgN%2BA7zjHfE8QCS4rg

Quoted 4 lines
Quoted 3 lines

+%3D&amp;reserved=0
+$schema:

+https://eur01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevi

Quoted 2 lines
Quoted 1 line

+cetree.org%2Fmeta-schemas%2Fcore.yaml%23&amp;data=04%7C01%7Cjun.li%40

Quoted 2 lines
Quoted 1 line

+nxp.com%7C4436142512ac45fef86f08d8957983c2%7C686ea1d3bc2b4c6fa92cd99c

Quoted 2 lines
Quoted 1 line

+5c301635%7C0%7C1%7C637423696442152522%7CUnknown%7CTWFpbGZsb3d8eyJWIjo

Quoted 2 lines
Quoted 1 line

+iMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&am

Quoted 2 lines
Quoted 1 line

+p;sdata=0fd3wjAtKwLCQAY3NG2Be4qNA9FiFhtO0HIZmCK7AQs%3D&amp;reserved=0

Quoted 13 lines
Quoted 13 lines
Documentation/devicetree/bindings/usb/typec-switch-simple.yaml new file +13 -0
+
+title: Typec Orientation Switch Simple Solution Bindings
+
+maintainers:
+  - Li Jun <[email protected]>
+
+description: |-
+  USB SuperSpeed (SS) lanes routing to which side of typec
+connector is
+  decided by orientation, this maybe achieved by some simple
+control like
+  GPIO toggle.
+
Quoted 8 lines

Documentation/devicetree/bindings/usb/typec-switch-simple.yaml line 22

Quoted 6 lines
Documentation/devicetree/bindings/usb/typec-switch-simple.yaml new file +6 -0
+properties:
+  compatible:
+    const: typec-orientation-switch
+
+  '#mux-control-cells':
+    const: 0

Who is the mux-control consumer?

Typec(controller)

       ptn5110: tcpc@50 {
                compatible = "nxp,ptn5110";
                pinctrl-names = "default";
                pinctrl-0 = <&pinctrl_typec>;
                reg = <0x50>;
                interrupt-parent = <&gpio4>;
                interrupts = <19 8>;
                mux-controls = <&typec_switch>;
                mux-control-names = "mux-typec-switch";

                usb_con: connector {
                        compatible = "usb-c-connector";
                        ... ...
                        ports {
                                #address-cells = <1>;
                                #size-cells = <0>;

                                port@1 {
                                        reg = <1>;
                                        typec_con_ss: endpoint {
                                                remote-endpoint =
<&usb3_orien_sel>;
                                        };
                                };
                        };
                };
        };
Quoted 25 lines

Documentation/devicetree/bindings/usb/typec-switch-simple.yaml

Quoted 11 lines
Documentation/devicetree/bindings/usb/typec-switch-simple.yaml new file +10 -0
+
+  switch-gpios:
+    description: |
+      GPIO specifiers to select the target channel of mux.
+      The first GPIO is for cc1 and cc2 selection, the GPIO flag use
+      GPIO_ACTIVE_HIGH if GPIO physical state high is for cc1; or use
+      GPIO_ACTIVE_LOW if GPIO physical state low is for cc1.
+      The second gpio is to deselect any channles by places all channels
+      in high-impedance state to reduce current consumption, the
+ gpio

flag

Quoted 13 lines
Documentation/devicetree/bindings/usb/typec-switch-simple.yaml new file +13 -0
+      use GPIO_ACTIVE_HIGH if GPIO physical state high is for
+      high-impedance state (so low for normal operations); or Use
+      GPIO_ACTIVE_LOW if GPIO physical state low is for high-impedance
+      state(so high for normal operations).
+    minItems: 1
+    maxItems: 2
+
+  idle-state:
+    description: -|
+      For TYPEC_ORIENTATION_NONE by deselect both channels if supported.
+    const: 2
+
+  # Standard properties described in  #
Quoted 104 lines
Quoted 7 lines

Documentation/devicetree/bindings/usb/typec-switch-simple.yaml

Quoted 7 lines

+ Documentation/devicetree/bindings/mux/mux-controller.txt

Documentation/devicetree/bindings/usb/typec-switch-simple.yaml new file +6 -0
+
+  port:
+    type: object
+    additionalProperties: false
+    description: -|
+      Connection to the remote endpoint using OF graph bindings that

model

Quoted 96 lines
Quoted 60 lines
Documentation/devicetree/bindings/usb/typec-switch-simple.yaml new file +60 -0
+      SS data bus to typec connector.
+
+    properties:
+      '#address-cells':
+        const: 1
+
+      '#size-cells':
+        const: 0
+
+      endpoint@0:
+        type: object
+        description: Endpoint connected to typec connector.
+        additionalProperties: false
+
+        properties:
+          reg:
+            const: 0
+          remote-endpoint: true
+
+        required:
+          - remote-endpoint
+
+      endpoint@1:
+        type: object
+        description: Endpoint connected to usb controller.
+        additionalProperties: false
+
+        properties:
+          reg:
+            const: 1
+          remote-endpoint: true
+
+        required:
+          - remote-endpoint
+
+    required:
+      - endpoint@0
+
+required:
+  - compatible
+  - port
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    typec_switch: mux-controller {
+        compatible = "typec-orientation-switch";
+        #mux-control-cells = <0>;
+        pinctrl-names = "default";
+        pinctrl-0 = <&pinctrl_ss_sel>;
+        switch-gpios = <&gpio3 15 GPIO_ACTIVE_HIGH>,
+                       <&gpio2 20 GPIO_ACTIVE_HIGH>;
+        idle-state = <2>;
+
+        port {
+                #address-cells = <1>;
+                #size-cells = <0>;
+

Documentation/devicetree/bindings/usb/typec-switch-simple.yaml line 121

Quoted 10 lines
Documentation/devicetree/bindings/usb/typec-switch-simple.yaml new file +10 -0
+                usb3_orien_sel: endpoint@0 {
+                        reg = <0>;
+                        remote-endpoint = <&typec_con_ss>;
+                };
+
+                usb3_con_data: endpoint@1 {
+                        reg = <1>;
+                        remote-endpoint = <&dwc3_0>;
+                };
+        };

This still seems unnecessarily complicated. What I had in mind is just something like this:

mux: mux-controller {
compatible = "gpio-mux";
#mux-control-cells = <0>;
mux-gpios = <&gpio3 15 GPIO_ACTIVE_HIGH>,

              <&gpio2 20 GPIO_ACTIVE_HIGH>;

idle-state = <2>;
};

connector {
compatible = "usb-c-connector";
mux-controls = <&mux>;
...
};

Then you aren't re-implementing the gpio-mux driver.

This should work for *any* mux implementation as long as the mux states always have the same meanings from the perspective of the connector.

Of course, I have little visibility into the possible h/w implementations for Type-C and maybe this isn't sufficient. So input from Type-C experts would be helpful.

More thinking of this, I have a proposal like this:

34 mux: mux-controller {

 33                 compatible = "gpio-mux";
 32                 #mux-control-cells = <0>;
 29                 switch-gpios = <&gpio4 20 GPIO_ACTIVE_LOW>,

28 <&gpio2 20 GPIO_ACTIVE_HIGH>;
27 idle-state = <2>;
26 };
25

Then I don't need re-implement the gpio-mux driver.

24 typec_switch {

 23                 compatible = "typec-orientation-switch";
 22                 mux-controls = <&mux>;
 21                 mux-control-names = "mux-typec-switch";

20
19 port {
18 usb3_data_ss: endpoint@0 {
17 remote-endpoint = <&typec_con_ss>;
16 };
15 };
14 };

The simple typec switch driver as the consumer of mux-control, and also as the provider of typec_switch to typec class, this can be extended to use other mux solutions.

31 usb_con: connector {

 30                         compatible = "usb-c-connector";
 29                         label = "USB-C";
 20                         ... ...
 19                         ports {

18 #address-cells = <1>;
17 #size-cells = <0>;
16
15 port@1 {
14 reg = <1>;
13 typec_con_ss: endpoint {
12 remote-endpoint = <&usb3_data_ss>;
11 };
10 };
9 };
8 };

Then existing typec mux interface can be kept, is this making sense to you?

Thanks
Li Jun

Quoted 25 lines

From h/w point view, this can work if only consider my(GPIO) case. But I still need register a typec switch in provider side to make it under the unified typec switch interface:

  7 struct typec_switch {
  6         struct device dev;
  5         typec_switch_set_fn_t set;
  4         struct mux_control *mux_ctrl;
  3 };

typec_switch->dev.parent = mux_chip->dev;

So either I put the typec switch creation in exiting mux-gpio driver; or I create a new typec switch driver with gpio mux code duplication.

If I go directly with mux control w/o(out of) typec_switch, then I don't need any driver change as you expect, but I guess this is not preferred, @Heikki, any comments?

Thanks
Li Jun

Quoted 2 lines

Rob