Skip to contentSkip to conversation

usb: add support for Intel dual role port mux

PATCH Superseded Lu Baolu 4 participants 12 messages Mar 18, 2016

Subsystems (3)

v5 of 10 Superseded Latest is v10 →

lore
Share & tools
lore

Lu Baolu

author
#0 lore raw

v5 cover usb: add support for Intel dual role port mux

Intel SOC chips are featured with USB dual role. The host role is provided by Intel xHCI IP, and the gadget role is provided by IP from designware. Tablet platform designs always share a single port for both host and gadget controllers. There is a mux to switch the port to the right controller according to the cable type. OS needs to provide the callback to control the mux when a plug-in event raises. The method to control the mux is platform dependent. At least three types of implementation can be found across current devices. 1) GPIO pins; 2) a unit which can be controlled by memory mapped registers; 3) ACPI ASL code.

This patch series adds supports for Intel dual role port mux. It includes:
(1) A helper layer on top of extcon for individual mux driver. It listens to the USB-HOST extcon cable and call the switch call-back when the cable state changes.
(2) Drivers for GPIO controlled port mux which could be found on Baytrail devices. A mfd driver is used to split the GPIOs into USB gpio extcon device and a USB mux device. Driver for USB gpio extcon device is already in upstream Linux. This patch series includes a driver for GPIO USB mux.
(3) Drivers for USB port mux controlled through memory mapped registers and the logic to create the mux device. This type of dual role port mux could be found in Cherry Trail and Broxton devices.

Lu Baolu (6):
extcon: usb-gpio: add device binding for platform device
extcon: usb-gpio: add support for ACPI gpio interface
usb: mux: add common code for Intel dual role port mux
usb: mux: add driver for Intel gpio controlled port mux
usb: mux: add driver for Intel drcfg controlled port mux
mfd: intel_vuport: Add Intel virtual USB port MFD Driver

Change log:
v4->v5:
- Change the extcon interfaces with the new ones suggested by 2a9de9c0f08d6 (extcon: Use the unique id for external connector instead of string)
- remove patch "usb: pci-quirks: add Intel USB drcfg mux device" from this serial due to that it's not driver staff. Will be submitted seperately.

v3->v4:
- Check all patches with "checkpatch.pl --strict", and fix all CHECKs;
- Change sysfs node from "intel_mux" to "port_mux";
- Refines below confusing functions:
intel_usb_mux_register() -> intel_usb_mux_bind_cable() intel_usb_mux_unregister() -> intel_usb_mux_unbind_cable();
- Remove unnecessary struct intel_mux_dev.

v2->v3:
- uvport mfd driver got reviewed by Lee Jones, the following changes were made accordingly.
- seperate uvport driver from the mux drivers in MAINTAINERS file
- refine the description in Kconfig
- refine the mfd_cell structure data

v1->v2:
- move mux driver from drivers/usb/misc to drivers/usb/mux;
- replace debugfs with sysfs for user level mux control;
- remove unnecessary register restore if mux registeration failed;
- Add "Acked-by: Chanwoo Choi <[email protected]>" to extcon changes;
- Make the file names and exported function names more specific;
- Remove the usb_mux_get_dev() interface;
- Move "struct intel_usb_mux" from .h to .c file;
- Fix various kbuild robot warnings.

 Documentation/ABI/testing/sysfs-bus-platform |  15 +++
 MAINTAINERS                                  |  15 +++
 drivers/extcon/extcon-usb-gpio.c             |  10 +-
 drivers/mfd/Kconfig                          |   8 ++
 drivers/mfd/Makefile                         |   1 +
 drivers/mfd/intel-vuport.c                   |  74 +++++++++++
 drivers/usb/Kconfig                          |   2 +
 drivers/usb/Makefile                         |   1 +
 drivers/usb/mux/Kconfig                      |  28 +++++
 drivers/usb/mux/Makefile                     |   6 +
 drivers/usb/mux/intel-mux-drcfg.c            | 159 ++++++++++++++++++++++++
 drivers/usb/mux/intel-mux-gpio.c             | 122 +++++++++++++++++++
 drivers/usb/mux/intel-mux.c                  | 175 +++++++++++++++++++++++++++
 include/linux/usb/intel-mux.h                |  40 ++++++
 14 files changed, 655 insertions(+), 1 deletion(-)
 create mode 100644 drivers/mfd/intel-vuport.c
 create mode 100644 drivers/usb/mux/Kconfig
 create mode 100644 drivers/usb/mux/Makefile
 create mode 100644 drivers/usb/mux/intel-mux-drcfg.c
 create mode 100644 drivers/usb/mux/intel-mux-gpio.c
 create mode 100644 drivers/usb/mux/intel-mux.c
 create mode 100644 include/linux/usb/intel-mux.h
Signature · 1 line
2.1.4
author
#1 lore raw

PATCH v5 1/6 extcon: usb-gpio: add device binding for platform device

This is needed to handle the GPIO connected USB ID pin found on Intel Baytrail devices.

---
 drivers/extcon/extcon-usb-gpio.c | 7 +++++++
 1 file changed, 7 insertions(+)
drivers/extcon/extcon-usb-gpio.c +7 -0
index 2b2fecf..af9c8b0 100644
@@ -206,6 +206,12 @@ static const struct of_device_id usb_extcon_dt_match[] = {
 };
 MODULE_DEVICE_TABLE(of, usb_extcon_dt_match);
 
+static const struct platform_device_id usb_extcon_platform_ids[] = {
+	{ .name = "extcon-usb-gpio", },
+	{ /* sentinel */ }
+};
+MODULE_DEVICE_TABLE(platform, usb_extcon_platform_ids);
+
 static struct platform_driver usb_extcon_driver = {
 	.probe		= usb_extcon_probe,
 	.remove		= usb_extcon_remove,
@@ -214,6 +220,7 @@ static struct platform_driver usb_extcon_driver = {
 		.pm	= &usb_extcon_pm_ops,
 		.of_match_table = usb_extcon_dt_match,
 	},
+	.id_table = usb_extcon_platform_ids,
 };
 
 module_platform_driver(usb_extcon_driver);
Signature · 1 line
2.1.4
author
#2 lore raw

PATCH v5 2/6 extcon: usb-gpio: add support for ACPI gpio interface

In reply to Lu Baolu

GPIO resource could be retrieved through APCI as well.

---
 drivers/extcon/extcon-usb-gpio.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
drivers/extcon/extcon-usb-gpio.c +2 -1
index af9c8b0..472c431 100644
@@ -26,6 +26,7 @@
 #include <linux/platform_device.h>
 #include <linux/slab.h>
 #include <linux/workqueue.h>
+#include <linux/acpi.h>
 
 #define USB_GPIO_DEBOUNCE_MS	20	/* ms */
 
@@ -91,7 +92,7 @@ static int usb_extcon_probe(struct platform_device *pdev)
 	struct usb_extcon_info *info;
 	int ret;
 
-	if (!np)
+	if (!np && !ACPI_HANDLE(dev))
 		return -EINVAL;
 
 	info = devm_kzalloc(&pdev->dev, sizeof(*info), GFP_KERNEL);
Signature · 1 line
2.1.4
author
#3 lore raw

PATCH v5 3/6 usb: mux: add common code for Intel dual role port mux

In reply to Lu Baolu

Several Intel PCHs and SOCs have an internal mux that is used to share one USB port between device controller and host controller.

A usb port mux could be abstracted as the following elements:
1) mux state: HOST or PERIPHERAL;
2) an extcon cable which triggers the change of mux state between HOST and PERIPHERAL;
3) The required action to do the real port switch.

This patch adds the common code to handle usb port mux. With this common code, the individual mux driver, which always is platform dependent, could focus on the real operation of mux switch.

---
 Documentation/ABI/testing/sysfs-bus-platform |  15 +++
 MAINTAINERS                                  |   7 ++
 drivers/usb/Kconfig                          |   2 +
 drivers/usb/Makefile                         |   1 +
 drivers/usb/mux/Kconfig                      |  12 ++
 drivers/usb/mux/Makefile                     |   4 +
 drivers/usb/mux/intel-mux.c                  | 175 +++++++++++++++++++++++++++
 include/linux/usb/intel-mux.h                |  40 ++++++
 8 files changed, 256 insertions(+)
 create mode 100644 drivers/usb/mux/Kconfig
 create mode 100644 drivers/usb/mux/Makefile
 create mode 100644 drivers/usb/mux/intel-mux.c
 create mode 100644 include/linux/usb/intel-mux.h
Documentation/ABI/testing/sysfs-bus-platform +15 -0
index 5172a61..23bf76e 100644
@@ -18,3 +18,18 @@ Description:
 		devices to opt-out of driver binding using a driver_override
 		name such as "none".  Only a single driver may be specified in
 		the override, there is no support for parsing delimiters.
+
+What:		/sys/bus/platform/devices/.../port_mux
+Date:		Febuary 2016
+Contact:	Lu Baolu <[email protected]>
+Description:
+		In some platforms, a single USB port is shared between a USB host
+		controller and a device controller. A USB mux driver is needed to
+		handle the port mux. port_mux attribute shows and stores the mux
+		state.
+		For read:
+		'peripheral' - mux switched to PERIPHERAL controller;
+		'host'       - mux switched to HOST controller.
+		For write:
+		'peripheral' - mux will be switched to PERIPHERAL controller;
+		'host'       - mux will be switched to HOST controller.
MAINTAINERS +7 -0
index da3e4d8..0dbee11 100644
@@ -11399,6 +11399,13 @@ T:	git git://git.kernel.org/pub/scm/linux/kernel/git/balbi/usb.git
 S:	Maintained
 F:	drivers/usb/phy/
 
+USB PORT MUX DRIVER
+M:	Lu Baolu <[email protected]>
+L:	[email protected]
+S:	Supported
+F:	include/linux/usb/intel-mux.h
+F:	drivers/usb/mux/intel-mux.c
+
 USB PRINTER DRIVER (usblp)
 M:	Pete Zaitcev <[email protected]>
 L:	[email protected]
drivers/usb/Kconfig +2 -0
index 8ed451d..dbd6620 100644
@@ -149,6 +149,8 @@ endif # USB
 
 source "drivers/usb/phy/Kconfig"
 
+source "drivers/usb/mux/Kconfig"
+
 source "drivers/usb/gadget/Kconfig"
 
 config USB_LED_TRIG
drivers/usb/Makefile +1 -0
index d5c57f1..6433f0c 100644
@@ -6,6 +6,7 @@
 
 obj-$(CONFIG_USB)		+= core/
 obj-$(CONFIG_USB_SUPPORT)	+= phy/
+obj-$(CONFIG_USB_SUPPORT)	+= mux/
 
 obj-$(CONFIG_USB_DWC3)		+= dwc3/
 obj-$(CONFIG_USB_DWC2)		+= dwc2/
drivers/usb/mux/Kconfig new file +12 -0
new file mode 100644
index 0000000..62e2cc3
@@ -0,0 +1,12 @@
+#
+# USB port mux driver configuration
+#
+menu "USB Port MUX drivers"
+config INTEL_USB_MUX
+	select EXTCON
+	def_bool n
+	help
+	  Common code for all Intel dual role port mux drivers. All Intel
+	  usb port mux drivers should select it.
+
+endmenu
drivers/usb/mux/Makefile new file +4 -0
new file mode 100644
index 0000000..84f0ae8
@@ -0,0 +1,4 @@
+#
+# Makefile for USB port mux drivers
+#
+obj-$(CONFIG_INTEL_USB_MUX)		+= intel-mux.o
drivers/usb/mux/intel-mux.c new file +175 -0

175 lines not on this page · raw message

include/linux/usb/intel-mux.h new file +40 -0
new file mode 100644
index 0000000..b00975a
@@ -0,0 +1,40 @@
+/**
+ * intel_mux.h - USB Port Mux definitions
+ *
+ * Copyright (C) 2016 Intel Corporation
+ *
+ * Author: Lu Baolu <[email protected]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ */
+
+#ifndef __LINUX_USB_INTEL_MUX_H
+#define __LINUX_USB_INTEL_MUX_H
+
+#if IS_ENABLED(CONFIG_INTEL_USB_MUX)
+int intel_usb_mux_bind_cable(struct device *dev, const char *extcon_name,
+			     int (*cable_set_cb)(struct device *dev),
+			     int (*cable_unset_cb)(struct device *dev));
+int intel_usb_mux_unbind_cable(struct device *dev);
+#ifdef CONFIG_PM_SLEEP
+void intel_usb_mux_complete(struct device *dev);
+#endif
+
+#else
+static inline int
+int intel_usb_mux_bind_cable(struct device *dev, const char *extcon_name,
+			     int (*cable_set_cb)(struct device *dev),
+			     int (*cable_unset_cb)(struct device *dev))
+{
+	return -ENODEV;
+}
+
+static inline int intel_usb_mux_unbind_cable(struct device *dev)
+{
+	return 0;
+}
+#endif /* CONFIG_INTEL_USB_MUX */
+
+#endif /* __LINUX_USB_INTEL_MUX_H */
Signature · 1 line
2.1.4
maintainer Reviewed-by on v5 3/6
#4 lore raw

Re: [PATCH v5 3/6] usb: mux: add common code for Intel dual role port mux

Hi Baolu,

Quoted 9 lines · Lu Baolu

Several Intel PCHs and SOCs have an internal mux that is used to share one USB port between device controller and host controller.

A usb port mux could be abstracted as the following elements:
1) mux state: HOST or PERIPHERAL;
2) an extcon cable which triggers the change of mux state between HOST and PERIPHERAL;
3) The required action to do the real port switch.

Quoted 7 lines

This patch adds the common code to handle usb port mux. With this common code, the individual mux driver, which always is platform dependent, could focus on the real operation of mux switch.

Looks good to me about extcon usage.

For extcon usage,

Best Regards,
Chanwoo Choi

Quoted 337 lines
---
 Documentation/ABI/testing/sysfs-bus-platform |  15 +++
 MAINTAINERS                                  |   7 ++
 drivers/usb/Kconfig                          |   2 +
 drivers/usb/Makefile                         |   1 +
 drivers/usb/mux/Kconfig                      |  12 ++
 drivers/usb/mux/Makefile                     |   4 +
 drivers/usb/mux/intel-mux.c                  | 175 +++++++++++++++++++++++++++
 include/linux/usb/intel-mux.h                |  40 ++++++
 8 files changed, 256 insertions(+)
 create mode 100644 drivers/usb/mux/Kconfig
 create mode 100644 drivers/usb/mux/Makefile
 create mode 100644 drivers/usb/mux/intel-mux.c
 create mode 100644 include/linux/usb/intel-mux.h
Documentation/ABI/testing/sysfs-bus-platform +15 -0
index 5172a61..23bf76e 100644
@@ -18,3 +18,18 @@ Description:
 		devices to opt-out of driver binding using a driver_override
 		name such as "none".  Only a single driver may be specified in
 		the override, there is no support for parsing delimiters.
+
+What:		/sys/bus/platform/devices/.../port_mux
+Date:		Febuary 2016
+Contact:	Lu Baolu <[email protected]>
+Description:
+		In some platforms, a single USB port is shared between a USB host
+		controller and a device controller. A USB mux driver is needed to
+		handle the port mux. port_mux attribute shows and stores the mux
+		state.
+		For read:
+		'peripheral' - mux switched to PERIPHERAL controller;
+		'host'       - mux switched to HOST controller.
+		For write:
+		'peripheral' - mux will be switched to PERIPHERAL controller;
+		'host'       - mux will be switched to HOST controller.
MAINTAINERS +7 -0
index da3e4d8..0dbee11 100644
@@ -11399,6 +11399,13 @@ T:	git git://git.kernel.org/pub/scm/linux/kernel/git/balbi/usb.git
 S:	Maintained
 F:	drivers/usb/phy/
 
+USB PORT MUX DRIVER
+M:	Lu Baolu <[email protected]>
+L:	[email protected]
+S:	Supported
+F:	include/linux/usb/intel-mux.h
+F:	drivers/usb/mux/intel-mux.c
+
 USB PRINTER DRIVER (usblp)
 M:	Pete Zaitcev <[email protected]>
 L:	[email protected]
drivers/usb/Kconfig +2 -0
index 8ed451d..dbd6620 100644
@@ -149,6 +149,8 @@ endif # USB
 
 source "drivers/usb/phy/Kconfig"
 
+source "drivers/usb/mux/Kconfig"
+
 source "drivers/usb/gadget/Kconfig"
 
 config USB_LED_TRIG
drivers/usb/Makefile +1 -0
index d5c57f1..6433f0c 100644
@@ -6,6 +6,7 @@
 
 obj-$(CONFIG_USB)		+= core/
 obj-$(CONFIG_USB_SUPPORT)	+= phy/
+obj-$(CONFIG_USB_SUPPORT)	+= mux/
 
 obj-$(CONFIG_USB_DWC3)		+= dwc3/
 obj-$(CONFIG_USB_DWC2)		+= dwc2/
drivers/usb/mux/Kconfig new file +12 -0
new file mode 100644
index 0000000..62e2cc3
@@ -0,0 +1,12 @@
+#
+# USB port mux driver configuration
+#
+menu "USB Port MUX drivers"
+config INTEL_USB_MUX
+	select EXTCON
+	def_bool n
+	help
+	  Common code for all Intel dual role port mux drivers. All Intel
+	  usb port mux drivers should select it.
+
+endmenu
drivers/usb/mux/Makefile new file +4 -0
new file mode 100644
index 0000000..84f0ae8
@@ -0,0 +1,4 @@
+#
+# Makefile for USB port mux drivers
+#
+obj-$(CONFIG_INTEL_USB_MUX)		+= intel-mux.o
drivers/usb/mux/intel-mux.c new file +175 -0
new file mode 100644
index 0000000..d18b96f
@@ -0,0 +1,175 @@
+/**
+ * intel_mux.c - USB Port Mux support
+ *
+ * Copyright (C) 2016 Intel Corporation
+ *
+ * Author: Lu Baolu <[email protected]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ */
+#include <linux/slab.h>
+#include <linux/notifier.h>
+#include <linux/extcon.h>
+#include <linux/err.h>
+
+struct intel_usb_mux {
+	struct device *dev;
+	struct extcon_dev *edev;
+	int (*cable_set_cb)(struct device *dev);
+	int (*cable_unset_cb)(struct device *dev);
+
+	struct notifier_block nb;
+
+	/*
+	 * The state of the mux.
+	 * 0, 1 - mux switch state
+	 * -1   - uninitialized state
+	 */
+	int mux_state;
+
+	 /* lock for mux_state */
+	struct mutex mux_mutex;
+};
+
+static int usb_mux_change_state(struct intel_usb_mux *mux, int state)
+{
+	int ret;
+	struct device *dev = mux->dev;
+
+	dev_WARN_ONCE(dev,
+		      !mutex_is_locked(&mux->mux_mutex),
+		      "mutex is unlocked\n");
+
+	mux->mux_state = state;
+
+	if (mux->mux_state)
+		ret = mux->cable_set_cb(dev);
+	else
+		ret = mux->cable_unset_cb(dev);
+
+	return ret;
+}
+
+static int usb_mux_notifier(struct notifier_block *nb,
+			    unsigned long event, void *ptr)
+{
+	struct intel_usb_mux *mux;
+	int state;
+	int ret = NOTIFY_DONE;
+
+	mux = container_of(nb, struct intel_usb_mux, nb);
+
+	state = extcon_get_cable_state_(mux->edev, EXTCON_USB_HOST);
+
+	if (mux->mux_state == -1 || mux->mux_state != state) {
+		mutex_lock(&mux->mux_mutex);
+		ret = usb_mux_change_state(mux, state);
+		mutex_unlock(&mux->mux_mutex);
+	}
+
+	return ret;
+}
+
+static ssize_t port_mux_show(struct device *dev,
+			     struct device_attribute *attr, char *buf)
+{
+	struct intel_usb_mux *mux = dev_get_drvdata(dev);
+
+	if (dev_WARN_ONCE(dev, !mux, "mux without data structure\n"))
+		return 0;
+
+	return sprintf(buf, "%s\n", mux->mux_state ? "host" : "peripheral");
+}
+
+static ssize_t port_mux_store(struct device *dev,
+			      struct device_attribute *attr,
+			      const char *buf, size_t count)
+{
+	struct intel_usb_mux *mux = dev_get_drvdata(dev);
+	int state;
+
+	if (dev_WARN_ONCE(dev, !mux, "mux without data structure\n"))
+		return -EINVAL;
+
+	if (sysfs_streq(buf, "peripheral"))
+		state = 0;
+	else if (sysfs_streq(buf, "host"))
+		state = 1;
+	else
+		return -EINVAL;
+
+	mutex_lock(&mux->mux_mutex);
+	usb_mux_change_state(mux, state);
+	mutex_unlock(&mux->mux_mutex);
+
+	return count;
+}
+static DEVICE_ATTR_RW(port_mux);
+
+int intel_usb_mux_bind_cable(struct device *dev, const char *extcon_name,
+			     int (*cable_set_cb)(struct device *dev),
+			     int (*cable_unset_cb)(struct device *dev))
+{
+	int ret;
+	struct intel_usb_mux *mux;
+	struct extcon_dev *edev;
+
+	edev = extcon_get_extcon_dev(extcon_name);
+	if (IS_ERR_OR_NULL(edev))
+		return -ENODEV;
+
+	mux = devm_kzalloc(dev, sizeof(*mux), GFP_KERNEL);
+	if (!mux)
+		return -ENOMEM;
+
+	mux->dev = dev;
+	mux->edev = edev;
+	mux->cable_set_cb = cable_set_cb;
+	mux->cable_unset_cb = cable_unset_cb;
+	mux->nb.notifier_call = usb_mux_notifier;
+	mutex_init(&mux->mux_mutex);
+	mux->mux_state = -1;
+
+	dev_set_drvdata(dev, mux);
+	ret = extcon_register_notifier(edev, EXTCON_USB_HOST, &mux->nb);
+	if (ret < 0) {
+		dev_err(dev, "failed to register extcon notifier\n");
+		return -ENODEV;
+	}
+
+	usb_mux_notifier(&mux->nb, 0, NULL);
+
+	/* register the sysfs interface */
+	ret = device_create_file(dev, &dev_attr_port_mux);
+	if (ret) {
+		extcon_unregister_notifier(edev, EXTCON_USB_HOST, &mux->nb);
+		dev_err(dev, "failed to create sysfs attribute\n");
+		return -ENODEV;
+	}
+
+	return 0;
+}
+EXPORT_SYMBOL_GPL(intel_usb_mux_bind_cable);
+
+int intel_usb_mux_unbind_cable(struct device *dev)
+{
+	struct intel_usb_mux *mux = dev_get_drvdata(dev);
+
+	device_remove_file(dev, &dev_attr_port_mux);
+	extcon_unregister_notifier(mux->edev, EXTCON_USB_HOST, &mux->nb);
+
+	return 0;
+}
+EXPORT_SYMBOL_GPL(intel_usb_mux_unbind_cable);
+
+#ifdef CONFIG_PM_SLEEP
+void intel_usb_mux_complete(struct device *dev)
+{
+	struct intel_usb_mux *mux = dev_get_drvdata(dev);
+
+	usb_mux_notifier(&mux->nb, 0, NULL);
+}
+EXPORT_SYMBOL_GPL(intel_usb_mux_complete);
+#endif
include/linux/usb/intel-mux.h new file +40 -0
new file mode 100644
index 0000000..b00975a
@@ -0,0 +1,40 @@
+/**
+ * intel_mux.h - USB Port Mux definitions
+ *
+ * Copyright (C) 2016 Intel Corporation
+ *
+ * Author: Lu Baolu <[email protected]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ */
+
+#ifndef __LINUX_USB_INTEL_MUX_H
+#define __LINUX_USB_INTEL_MUX_H
+
+#if IS_ENABLED(CONFIG_INTEL_USB_MUX)
+int intel_usb_mux_bind_cable(struct device *dev, const char *extcon_name,
+			     int (*cable_set_cb)(struct device *dev),
+			     int (*cable_unset_cb)(struct device *dev));
+int intel_usb_mux_unbind_cable(struct device *dev);
+#ifdef CONFIG_PM_SLEEP
+void intel_usb_mux_complete(struct device *dev);
+#endif
+
+#else
+static inline int
+int intel_usb_mux_bind_cable(struct device *dev, const char *extcon_name,
+			     int (*cable_set_cb)(struct device *dev),
+			     int (*cable_unset_cb)(struct device *dev))
+{
+	return -ENODEV;
+}
+
+static inline int intel_usb_mux_unbind_cable(struct device *dev)
+{
+	return 0;
+}
+#endif /* CONFIG_INTEL_USB_MUX */
+
+#endif /* __LINUX_USB_INTEL_MUX_H */
author
#5 lore raw

Re: [PATCH v5 3/6] usb: mux: add common code for Intel dual role port mux

Hi Chanwoo,

Quoted 16 lines · Chanwoo Choi

Hi Baolu,

Quoted 13 lines · Lu Baolu

Several Intel PCHs and SOCs have an internal mux that is used to share one USB port between device controller and host controller.

A usb port mux could be abstracted as the following elements:
1) mux state: HOST or PERIPHERAL;
2) an extcon cable which triggers the change of mux state between HOST and PERIPHERAL;
3) The required action to do the real port switch.

This patch adds the common code to handle usb port mux. With this common code, the individual mux driver, which always is platform dependent, could focus on the real operation of mux switch.

Quoted 7 lines
Quoted 3 lines

Looks good to me about extcon usage.

For extcon usage,

Thank you!

Quoted 347 lines

Best Regards,
Chanwoo Choi

Quoted 327 lines
---
 Documentation/ABI/testing/sysfs-bus-platform |  15 +++
 MAINTAINERS                                  |   7 ++
 drivers/usb/Kconfig                          |   2 +
 drivers/usb/Makefile                         |   1 +
 drivers/usb/mux/Kconfig                      |  12 ++
 drivers/usb/mux/Makefile                     |   4 +
 drivers/usb/mux/intel-mux.c                  | 175 +++++++++++++++++++++++++++
 include/linux/usb/intel-mux.h                |  40 ++++++
 8 files changed, 256 insertions(+)
 create mode 100644 drivers/usb/mux/Kconfig
 create mode 100644 drivers/usb/mux/Makefile
 create mode 100644 drivers/usb/mux/intel-mux.c
 create mode 100644 include/linux/usb/intel-mux.h
Documentation/ABI/testing/sysfs-bus-platform +15 -0
index 5172a61..23bf76e 100644
@@ -18,3 +18,18 @@ Description:
 		devices to opt-out of driver binding using a driver_override
 		name such as "none".  Only a single driver may be specified in
 		the override, there is no support for parsing delimiters.
+
+What:		/sys/bus/platform/devices/.../port_mux
+Date:		Febuary 2016
+Contact:	Lu Baolu <[email protected]>
+Description:
+		In some platforms, a single USB port is shared between a USB host
+		controller and a device controller. A USB mux driver is needed to
+		handle the port mux. port_mux attribute shows and stores the mux
+		state.
+		For read:
+		'peripheral' - mux switched to PERIPHERAL controller;
+		'host'       - mux switched to HOST controller.
+		For write:
+		'peripheral' - mux will be switched to PERIPHERAL controller;
+		'host'       - mux will be switched to HOST controller.
MAINTAINERS +7 -0
index da3e4d8..0dbee11 100644
@@ -11399,6 +11399,13 @@ T:	git git://git.kernel.org/pub/scm/linux/kernel/git/balbi/usb.git
 S:	Maintained
 F:	drivers/usb/phy/
 
+USB PORT MUX DRIVER
+M:	Lu Baolu <[email protected]>
+L:	[email protected]
+S:	Supported
+F:	include/linux/usb/intel-mux.h
+F:	drivers/usb/mux/intel-mux.c
+
 USB PRINTER DRIVER (usblp)
 M:	Pete Zaitcev <[email protected]>
 L:	[email protected]
drivers/usb/Kconfig +2 -0
index 8ed451d..dbd6620 100644
@@ -149,6 +149,8 @@ endif # USB
 
 source "drivers/usb/phy/Kconfig"
 
+source "drivers/usb/mux/Kconfig"
+
 source "drivers/usb/gadget/Kconfig"
 
 config USB_LED_TRIG
drivers/usb/Makefile +1 -0
index d5c57f1..6433f0c 100644
@@ -6,6 +6,7 @@
 
 obj-$(CONFIG_USB)		+= core/
 obj-$(CONFIG_USB_SUPPORT)	+= phy/
+obj-$(CONFIG_USB_SUPPORT)	+= mux/
 
 obj-$(CONFIG_USB_DWC3)		+= dwc3/
 obj-$(CONFIG_USB_DWC2)		+= dwc2/
drivers/usb/mux/Kconfig new file +12 -0
new file mode 100644
index 0000000..62e2cc3
@@ -0,0 +1,12 @@
+#
+# USB port mux driver configuration
+#
+menu "USB Port MUX drivers"
+config INTEL_USB_MUX
+	select EXTCON
+	def_bool n
+	help
+	  Common code for all Intel dual role port mux drivers. All Intel
+	  usb port mux drivers should select it.
+
+endmenu
drivers/usb/mux/Makefile new file +4 -0
new file mode 100644
index 0000000..84f0ae8
@@ -0,0 +1,4 @@
+#
+# Makefile for USB port mux drivers
+#
+obj-$(CONFIG_INTEL_USB_MUX)		+= intel-mux.o
drivers/usb/mux/intel-mux.c new file +175 -0
new file mode 100644
index 0000000..d18b96f
@@ -0,0 +1,175 @@
+/**
+ * intel_mux.c - USB Port Mux support
+ *
+ * Copyright (C) 2016 Intel Corporation
+ *
+ * Author: Lu Baolu <[email protected]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ */
+#include <linux/slab.h>
+#include <linux/notifier.h>
+#include <linux/extcon.h>
+#include <linux/err.h>
+
+struct intel_usb_mux {
+	struct device *dev;
+	struct extcon_dev *edev;
+	int (*cable_set_cb)(struct device *dev);
+	int (*cable_unset_cb)(struct device *dev);
+
+	struct notifier_block nb;
+
+	/*
+	 * The state of the mux.
+	 * 0, 1 - mux switch state
+	 * -1   - uninitialized state
+	 */
+	int mux_state;
+
+	 /* lock for mux_state */
+	struct mutex mux_mutex;
+};
+
+static int usb_mux_change_state(struct intel_usb_mux *mux, int state)
+{
+	int ret;
+	struct device *dev = mux->dev;
+
+	dev_WARN_ONCE(dev,
+		      !mutex_is_locked(&mux->mux_mutex),
+		      "mutex is unlocked\n");
+
+	mux->mux_state = state;
+
+	if (mux->mux_state)
+		ret = mux->cable_set_cb(dev);
+	else
+		ret = mux->cable_unset_cb(dev);
+
+	return ret;
+}
+
+static int usb_mux_notifier(struct notifier_block *nb,
+			    unsigned long event, void *ptr)
+{
+	struct intel_usb_mux *mux;
+	int state;
+	int ret = NOTIFY_DONE;
+
+	mux = container_of(nb, struct intel_usb_mux, nb);
+
+	state = extcon_get_cable_state_(mux->edev, EXTCON_USB_HOST);
+
+	if (mux->mux_state == -1 || mux->mux_state != state) {
+		mutex_lock(&mux->mux_mutex);
+		ret = usb_mux_change_state(mux, state);
+		mutex_unlock(&mux->mux_mutex);
+	}
+
+	return ret;
+}
+
+static ssize_t port_mux_show(struct device *dev,
+			     struct device_attribute *attr, char *buf)
+{
+	struct intel_usb_mux *mux = dev_get_drvdata(dev);
+
+	if (dev_WARN_ONCE(dev, !mux, "mux without data structure\n"))
+		return 0;
+
+	return sprintf(buf, "%s\n", mux->mux_state ? "host" : "peripheral");
+}
+
+static ssize_t port_mux_store(struct device *dev,
+			      struct device_attribute *attr,
+			      const char *buf, size_t count)
+{
+	struct intel_usb_mux *mux = dev_get_drvdata(dev);
+	int state;
+
+	if (dev_WARN_ONCE(dev, !mux, "mux without data structure\n"))
+		return -EINVAL;
+
+	if (sysfs_streq(buf, "peripheral"))
+		state = 0;
+	else if (sysfs_streq(buf, "host"))
+		state = 1;
+	else
+		return -EINVAL;
+
+	mutex_lock(&mux->mux_mutex);
+	usb_mux_change_state(mux, state);
+	mutex_unlock(&mux->mux_mutex);
+
+	return count;
+}
+static DEVICE_ATTR_RW(port_mux);
+
+int intel_usb_mux_bind_cable(struct device *dev, const char *extcon_name,
+			     int (*cable_set_cb)(struct device *dev),
+			     int (*cable_unset_cb)(struct device *dev))
+{
+	int ret;
+	struct intel_usb_mux *mux;
+	struct extcon_dev *edev;
+
+	edev = extcon_get_extcon_dev(extcon_name);
+	if (IS_ERR_OR_NULL(edev))
+		return -ENODEV;
+
+	mux = devm_kzalloc(dev, sizeof(*mux), GFP_KERNEL);
+	if (!mux)
+		return -ENOMEM;
+
+	mux->dev = dev;
+	mux->edev = edev;
+	mux->cable_set_cb = cable_set_cb;
+	mux->cable_unset_cb = cable_unset_cb;
+	mux->nb.notifier_call = usb_mux_notifier;
+	mutex_init(&mux->mux_mutex);
+	mux->mux_state = -1;
+
+	dev_set_drvdata(dev, mux);
+	ret = extcon_register_notifier(edev, EXTCON_USB_HOST, &mux->nb);
+	if (ret < 0) {
+		dev_err(dev, "failed to register extcon notifier\n");
+		return -ENODEV;
+	}
+
+	usb_mux_notifier(&mux->nb, 0, NULL);
+
+	/* register the sysfs interface */
+	ret = device_create_file(dev, &dev_attr_port_mux);
+	if (ret) {
+		extcon_unregister_notifier(edev, EXTCON_USB_HOST, &mux->nb);
+		dev_err(dev, "failed to create sysfs attribute\n");
+		return -ENODEV;
+	}
+
+	return 0;
+}
+EXPORT_SYMBOL_GPL(intel_usb_mux_bind_cable);
+
+int intel_usb_mux_unbind_cable(struct device *dev)
+{
+	struct intel_usb_mux *mux = dev_get_drvdata(dev);
+
+	device_remove_file(dev, &dev_attr_port_mux);
+	extcon_unregister_notifier(mux->edev, EXTCON_USB_HOST, &mux->nb);
+
+	return 0;
+}
+EXPORT_SYMBOL_GPL(intel_usb_mux_unbind_cable);
+
+#ifdef CONFIG_PM_SLEEP
+void intel_usb_mux_complete(struct device *dev)
+{
+	struct intel_usb_mux *mux = dev_get_drvdata(dev);
+
+	usb_mux_notifier(&mux->nb, 0, NULL);
+}
+EXPORT_SYMBOL_GPL(intel_usb_mux_complete);
+#endif
include/linux/usb/intel-mux.h new file +30 -0
new file mode 100644
index 0000000..b00975a
@@ -0,0 +1,40 @@
+/**
+ * intel_mux.h - USB Port Mux definitions
+ *
+ * Copyright (C) 2016 Intel Corporation
+ *
+ * Author: Lu Baolu <[email protected]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ */
+
+#ifndef __LINUX_USB_INTEL_MUX_H
+#define __LINUX_USB_INTEL_MUX_H
+
+#if IS_ENABLED(CONFIG_INTEL_USB_MUX)
+int intel_usb_mux_bind_cable(struct device *dev, const char *extcon_name,
+			     int (*cable_set_cb)(struct device *dev),
+			     int (*cable_unset_cb)(struct device *dev));
+int intel_usb_mux_unbind_cable(struct device *dev);
+#ifdef CONFIG_PM_SLEEP
+void intel_usb_mux_complete(struct device *dev);
+#endif
+
+#else
+static inline int
+int intel_usb_mux_bind_cable(struct device *dev, const char *extcon_name,
+			     int (*cable_set_cb)(struct device *dev),
+			     int (*cable_unset_cb)(struct device *dev))
+{

include/linux/usb/intel-mux.h line 40

Quoted 10 lines
include/linux/usb/intel-mux.h new file +10 -0
+	return -ENODEV;
+}
+
+static inline int intel_usb_mux_unbind_cable(struct device *dev)
+{
+	return 0;
+}
+#endif /* CONFIG_INTEL_USB_MUX */
+
+#endif /* __LINUX_USB_INTEL_MUX_H */

--
To unsubscribe from this list: send the line "unsubscribe linux-usb" in the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html

author
#6 lore raw

PATCH v5 4/6 usb: mux: add driver for Intel gpio controlled port mux

In reply to Lu Baolu

In some Intel platforms, a single usb port is shared between USB host and device controller. The shared port is under control of GPIO pins.

This patch adds the support for USB GPIO controlled port mux.

---
 MAINTAINERS                      |   1 +
 drivers/usb/mux/Kconfig          |   9 +++
 drivers/usb/mux/Makefile         |   1 +
 drivers/usb/mux/intel-mux-gpio.c | 122 +++++++++++++++++++++++++++++++++++++++
 4 files changed, 133 insertions(+)
 create mode 100644 drivers/usb/mux/intel-mux-gpio.c
MAINTAINERS +1 -0
index 0dbee11..99bc198 100644
@@ -11405,6 +11405,7 @@ L:	[email protected]
 S:	Supported
 F:	include/linux/usb/intel-mux.h
 F:	drivers/usb/mux/intel-mux.c
+F:	drivers/usb/mux/intel-mux-gpio.c
 
 USB PRINTER DRIVER (usblp)
 M:	Pete Zaitcev <[email protected]>
drivers/usb/mux/Kconfig +9 -0
index 62e2cc3..2b197c1 100644
@@ -9,4 +9,13 @@ config INTEL_USB_MUX
 	  Common code for all Intel dual role port mux drivers. All Intel
 	  usb port mux drivers should select it.
 
+config INTEL_MUX_GPIO
+	tristate "Intel dual role port mux controlled by GPIOs"
+	depends on GPIOLIB
+	depends on X86 && ACPI
+	select INTEL_USB_MUX
+	help
+	  Say Y here to enable support for Intel dual role port mux
+	  controlled by GPIOs.
+
 endmenu
drivers/usb/mux/Makefile +1 -0
index 84f0ae8..66f765c 100644
@@ -2,3 +2,4 @@
 # Makefile for USB port mux drivers
 #
 obj-$(CONFIG_INTEL_USB_MUX)		+= intel-mux.o
+obj-$(CONFIG_INTEL_MUX_GPIO)		+= intel-mux-gpio.o
drivers/usb/mux/intel-mux-gpio.c new file +122 -0

122 lines not on this page · raw message

Signature · 1 line
2.1.4
author
#7 lore raw

PATCH v5 5/6 usb: mux: add driver for Intel drcfg controlled port mux

In reply to Lu Baolu

Several Intel PCHs and SOCs have an internal mux that is used to share one USB port between device controller and host controller. The mux is handled through the Dual Role Configuration Register.

---
 MAINTAINERS                       |   1 +
 drivers/usb/mux/Kconfig           |   7 ++
 drivers/usb/mux/Makefile          |   1 +
 drivers/usb/mux/intel-mux-drcfg.c | 159 ++++++++++++++++++++++++++++++++++++++
 4 files changed, 168 insertions(+)
 create mode 100644 drivers/usb/mux/intel-mux-drcfg.c
MAINTAINERS +1 -0
index 99bc198..1d0f090 100644
@@ -11406,6 +11406,7 @@ S:	Supported
 F:	include/linux/usb/intel-mux.h
 F:	drivers/usb/mux/intel-mux.c
 F:	drivers/usb/mux/intel-mux-gpio.c
+F:	drivers/usb/mux/intel-mux-drcfg.c
 
 USB PRINTER DRIVER (usblp)
 M:	Pete Zaitcev <[email protected]>
drivers/usb/mux/Kconfig +7 -0
index 2b197c1..975c5a0 100644
@@ -18,4 +18,11 @@ config INTEL_MUX_GPIO
 	  Say Y here to enable support for Intel dual role port mux
 	  controlled by GPIOs.
 
+config INTEL_MUX_DRCFG
+	tristate "Intel dual role port mux controlled by register"
+	depends on X86
+	select INTEL_USB_MUX
+	help
+	  Say Y here to enable support for Intel dual role port mux
+	  controlled by the Dual Role Configuration Register.
 endmenu
drivers/usb/mux/Makefile +1 -0
index 66f765c..3179909 100644
@@ -3,3 +3,4 @@
 #
 obj-$(CONFIG_INTEL_USB_MUX)		+= intel-mux.o
 obj-$(CONFIG_INTEL_MUX_GPIO)		+= intel-mux-gpio.o
+obj-$(CONFIG_INTEL_MUX_DRCFG)		+= intel-mux-drcfg.o
drivers/usb/mux/intel-mux-drcfg.c new file +159 -0

159 lines not on this page · raw message

Signature · 1 line
2.1.4
author
#8 lore raw

PATCH v5 6/6 mfd: intel_vuport: Add Intel virtual USB port MFD Driver

In reply to Lu Baolu

Some Intel platforms have an USB port mux controlled by GPIOs. There's a single ACPI platform device that provides both USB ID extcon device and a USB port mux device. This MFD driver will split the 2 devices for their respective drivers.

---
 MAINTAINERS                |  6 ++++
 drivers/mfd/Kconfig        |  8 +++++
 drivers/mfd/Makefile       |  1 +
 drivers/mfd/intel-vuport.c | 74 ++++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 89 insertions(+)
 create mode 100644 drivers/mfd/intel-vuport.c
MAINTAINERS +6 -0
index 1d0f090..0a932b3 100644
@@ -5599,6 +5599,12 @@ L:	[email protected]
 S:	Supported
 F:	drivers/cpufreq/intel_pstate.c
 
+INTEL VIRTUAL USB PORT DRIVER
+M:	Lu Baolu <[email protected]>
+L:	[email protected]
+S:	Supported
+F:	drivers/mfd/intel-vuport.c
+
 INTEL FRAMEBUFFER DRIVER (excluding 810 and 815)
 M:	Maik Broemme <[email protected]>
 L:	[email protected]
drivers/mfd/Kconfig +8 -0
index 9ca66de..48933d4 100644
@@ -1534,5 +1534,13 @@ config MFD_VEXPRESS_SYSREG
 	  System Registers are the platform configuration block
 	  on the ARM Ltd. Versatile Express board.
 
+config MFD_INTEL_VUPORT
+	tristate "Intel virtual USB port controller"
+	select MFD_CORE
+	depends on X86 && ACPI
+	help
+	  Say Y here to enable support for Intel's dual role port mux
+	  controlled by GPIOs.
+
 endmenu
 endif
drivers/mfd/Makefile +1 -0
index 0f230a6..0ccd107 100644
@@ -198,3 +198,4 @@ intel-soc-pmic-objs		:= intel_soc_pmic_core.o intel_soc_pmic_crc.o
 intel-soc-pmic-$(CONFIG_INTEL_PMC_IPC)	+= intel_soc_pmic_bxtwc.o
 obj-$(CONFIG_INTEL_SOC_PMIC)	+= intel-soc-pmic.o
 obj-$(CONFIG_MFD_MT6397)	+= mt6397-core.o
+obj-$(CONFIG_MFD_INTEL_VUPORT)	+= intel-vuport.o
drivers/mfd/intel-vuport.c new file +74 -0

74 lines not on this page · raw message

Signature · 1 line
2.1.4
#9 lore raw

Re: [PATCH v5 6/6] mfd: intel_vuport: Add Intel virtual USB port MFD Driver

Quoted 7 lines · Lu Baolu

Some Intel platforms have an USB port mux controlled by GPIOs. There's a single ACPI platform device that provides both USB ID extcon device and a USB port mux device. This MFD driver will split the 2 devices for their respective drivers.

This should be at the top.

You couldn't have written the patch before it was suggested.

Quoted 2 lines

What is this sign-off meant to indicate?

Quoted 1 line

Why is this here?

a) I don't provide "Reviewed-by:" tags #alarmbells
b) I have never signed this patch off

Quoted 2 lines
---
 MAINTAINERS                |  6 ++++

Seperate patch.

Quoted 5 lines
 drivers/mfd/Kconfig        |  8 +++++
 drivers/mfd/Makefile       |  1 +
 drivers/mfd/intel-vuport.c | 74 ++++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 89 insertions(+)
 create mode 100644 drivers/mfd/intel-vuport.c

[...]

Signature · 4 lines
Lee Jones
Linaro STMicroelectronics Landing Team Lead
Linaro.org │ Open source software for ARM SoCs
Follow Linaro: Facebook | Twitter | Blog
author
#10 lore raw

Re: [PATCH v5 6/6] mfd: intel_vuport: Add Intel virtual USB port MFD Driver

Quoted 7 lines · Lee Jones
Quoted 5 lines · Lu Baolu

Some Intel platforms have an USB port mux controlled by GPIOs. There's a single ACPI platform device that provides both USB ID extcon device and a USB port mux device. This MFD driver will split the 2 devices for their respective drivers.

Quoted 5 lines
Quoted 2 lines

This should be at the top.

You couldn't have written the patch before it was suggested.

Yes. I will change this.

Quoted 4 lines
Quoted 3 lines

What is this sign-off meant to indicate?

Fengguang's sign-off was added due to folding a patch contributed by his kbuild robot.

https://lkml.org/lkml/2016/3/3/118

I will add this in commit message.

Quoted 6 lines
Quoted 2 lines

Why is this here?

a) I don't provide "Reviewed-by:" tags #alarmbells
b) I have never signed this patch off

Sorry about this. I will remove this line.

Quoted 4 lines
Quoted 3 lines
---
 MAINTAINERS                |  6 ++++

Seperate patch.

If I make it in a separate patch, checkpatch.pl will give me below warning.

"
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating? #51:
new file mode 100644
"

Is it forgivable?

Best regards,
Baolu

Quoted 8 lines
Quoted 6 lines
 drivers/mfd/Kconfig        |  8 +++++
 drivers/mfd/Makefile       |  1 +
 drivers/mfd/intel-vuport.c | 74 ++++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 89 insertions(+)
 create mode 100644 drivers/mfd/intel-vuport.c

[...]

#11 lore raw

Re: [PATCH v5 6/6] mfd: intel_vuport: Add Intel virtual USB port MFD Driver

Quoted 19 lines · Lu Baolu
Quoted 7 lines · Lee Jones
Quoted 5 lines · Lu Baolu

Some Intel platforms have an USB port mux controlled by GPIOs. There's a single ACPI platform device that provides both USB ID extcon device and a USB port mux device. This MFD driver will split the 2 devices for their respective drivers.

Quoted 5 lines
Quoted 2 lines

This should be at the top.

You couldn't have written the patch before it was suggested.

Yes. I will change this.

Quoted 1 line
Quoted 6 lines
Quoted 3 lines
Quoted 2 lines

What is this sign-off meant to indicate?

Fengguang's sign-off was added due to folding a patch contributed by his kbuild robot.

No, you can't do that, he only signed off on his fixup patch, not your overall larger patch!

I'm going to stop you now and require you to get this properly reviewed, and signed-off-by some experienced Intel kernel developers before I look at this at all. Take advantage of the resources you have, don't force the community to point out these basic mistakes.

Also, you know I'm not looking at new patches until after -rc1 is out, so please wait until then before resending.

greg k-h