[RFC v2 1/2] usb: phy: Hold wakeupsource when USB is enumerated in peripheral mode

[Kiran Kumar Raparthy]

From: Todd Poynor <toddpoynor@xxxxxxxxxx>

usb: phy: Hold wakeupsource when USB is enumerated in peripheral mode

Purpose of this is to prevent the system to enter into suspend state from USB
peripheral traffic by hodling a wakeupsource when USB is connected and
enumerated in peripheral mode(say adb).

Disabled by default, can enable with:
   echo Y > /sys/module/otg_wakeupsource/parameters/enabled

Cc: Felipe Balbi <balbi@xxxxxx>
Cc: Greg Kroah-Hartman <gregkh@xxxxxxxxxxxxxxxxxxx>
Cc: linux-kernel@xxxxxxxxxxxxxxx
Cc: linux-usb@xxxxxxxxxxxxxxx
Cc: Android Kernel Team <kernel-team@xxxxxxxxxxx>
Cc: John Stultz <john.stultz@xxxxxxxxxx>
Cc: Arve Hjøå<arve@xxxxxxxxxxx>
Cc: Benoit Goby <benoit@xxxxxxxxxxx>
Signed-off-by: Todd Poynor <toddpoynor@xxxxxxxxxx>
[kiran: Added context to commit message.
	Included build fix from Benoit Goby and Arve Hjøå
	Removed lock->held field in driver as this mechanism is
	provided in wakeupsource driver.
	wakelock(wl) terminology replaced with wakeup_source(ws).
	changed to "disabled by default" from "enable by default".
	sys entry(module param) field modified to otg_wakeupsource.
	included Todd's refactoring logic.
	Introduced get_phy_hook to handle otgws_xceiv per-PHY.
	otgws_nb moved to otg_wakeupsource_init function.
	wakeupsource handling implemeted per-PHY(in phy core).
	modified Kconfig help text]
Signed-off-by: Kiran Raparthy <kiran.kumar@xxxxxxxxxx>
---
 drivers/usb/phy/Kconfig            |   8 +++
 drivers/usb/phy/Makefile           |   1 +
 drivers/usb/phy/otg-wakeupsource.c | 140 +++++++++++++++++++++++++++++++++++++
 drivers/usb/phy/phy.c              |  42 +++++++++++
 include/linux/usb/phy.h            |   8 +++
 5 files changed, 199 insertions(+)
 create mode 100644 drivers/usb/phy/otg-wakeupsource.c

diff --git a/drivers/usb/phy/Kconfig b/drivers/usb/phy/Kconfig
index e253fa0..d9ddd85 100644
--- a/drivers/usb/phy/Kconfig
+++ b/drivers/usb/phy/Kconfig
@@ -6,6 +6,14 @@ menu "USB Physical Layer drivers"
 config USB_PHY
 	def_bool n
 
+config USB_OTG_WAKEUPSOURCE
+	bool "Hold wakeupsource when USB is enumerated in peripheral mode"
+	depends on PM_SLEEP
+	select USB_PHY
+	help
+	  Prevent the system going into automatic suspend while
+	  it is attached as a USB peripheral by holding a wakeupsource.
+
 #
 # USB Transceiver Drivers
 #
diff --git a/drivers/usb/phy/Makefile b/drivers/usb/phy/Makefile
index 24a9133..ca2fbaf 100644
--- a/drivers/usb/phy/Makefile
+++ b/drivers/usb/phy/Makefile
@@ -3,6 +3,7 @@
 #
 obj-$(CONFIG_USB_PHY)			+= phy.o
 obj-$(CONFIG_OF)			+= of.o
+obj-$(CONFIG_USB_OTG_WAKEUPSOURCE)		+= otg-wakeupsource.o
 
 # transceiver drivers, keep the list sorted
 
diff --git a/drivers/usb/phy/otg-wakeupsource.c b/drivers/usb/phy/otg-wakeupsource.c
new file mode 100644
index 0000000..fca2010
--- /dev/null
+++ b/drivers/usb/phy/otg-wakeupsource.c
@@ -0,0 +1,140 @@
+/*
+ * otg-wakeupsource.c
+ *
+ * Copyright (C) 2011 Google, Inc.
+ *
+ * This software is licensed under the terms of the GNU General Public
+ * License version 2, as published by the Free Software Foundation, and
+ * may be copied, distributed, and modified under those terms.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ */
+
+#include <linux/kernel.h>
+#include <linux/device.h>
+#include <linux/module.h>
+#include <linux/notifier.h>
+#include <linux/pm_wakeup.h>
+#include <linux/spinlock.h>
+#include <linux/usb/otg.h>
+
+bool enabled = false;
+
+static DEFINE_SPINLOCK(otgws_spinlock);
+static struct usb_phy *get_phy_hook(void);
+
+static void otgws_handle_event(struct usb_phy *otgws_xceiv, unsigned long event)
+{
+	unsigned long irqflags;
+
+	spin_lock_irqsave(&otgws_spinlock, irqflags);
+
+	if (!enabled) {
+		usb_drop_wsource(otgws_xceiv);
+		spin_unlock_irqrestore(&otgws_spinlock, irqflags);
+		return;
+	}
+
+	switch (event) {
+	case USB_EVENT_VBUS:
+	case USB_EVENT_ENUMERATED:
+		usb_grab_wsource(otgws_xceiv);
+		break;
+
+	case USB_EVENT_NONE:
+	case USB_EVENT_ID:
+	case USB_EVENT_CHARGER:
+		usb_drop_wsource(otgws_xceiv);
+		break;
+
+	default:
+		break;
+	}
+
+	spin_unlock_irqrestore(&otgws_spinlock, irqflags);
+}
+static struct usb_phy *get_phy_hook(void)
+{
+	struct usb_phy *phy;
+
+	phy = usb_get_phy(USB_PHY_TYPE_USB2);
+
+	if (IS_ERR(phy)) {
+		pr_err("%s: No OTG transceiver found\n", __func__);
+		return NULL;
+	}
+
+	return phy;
+}
+static int otgws_otg_notifications(struct notifier_block *nb,
+				unsigned long event, void *unused)
+{
+	static struct usb_phy *otgws_xceiv;
+
+	otgws_xceiv = get_phy_hook();
+
+	if (otgws_xceiv)
+		otgws_handle_event(otgws_xceiv, event);
+
+	return NOTIFY_OK;
+}
+
+static int set_enabled(const char *val, const struct kernel_param *kp)
+{
+	int rv = param_set_bool(val, kp);
+	static struct usb_phy *otgws_xceiv;
+
+	if (rv)
+		return rv;
+
+	otgws_xceiv = get_phy_hook();
+
+	if (otgws_xceiv)
+		otgws_handle_event(otgws_xceiv, otgws_xceiv->last_event);
+
+	return 0;
+}
+
+static struct kernel_param_ops enabled_param_ops = {
+	.set = set_enabled,
+	.get = param_get_bool,
+};
+
+module_param_cb(enabled, &enabled_param_ops, &enabled, 0644);
+MODULE_PARM_DESC(enabled, "Hold wakeupsource when VBUS present");
+
+static int __init otg_wakeupsource_init(void)
+{
+	int ret;
+	char wsource_name[40];
+	static struct notifier_block otgws_nb;
+	static struct usb_phy *otgws_xceiv;
+
+	otgws_xceiv = get_phy_hook();
+
+	if (NULL == otgws_xceiv)
+		return PTR_ERR(otgws_xceiv);
+
+	snprintf(wsource_name, sizeof(wsource_name), "vbus-%s",
+		dev_name(otgws_xceiv->dev));
+	usb_wsource_init(otgws_xceiv, wsource_name);
+
+	otgws_nb.notifier_call = otgws_otg_notifications;
+	ret = usb_register_notifier(otgws_xceiv, &otgws_nb);
+
+	if (ret) {
+		pr_err("%s: usb_register_notifier on transceiver %s failed\n",
+			 __func__, dev_name(otgws_xceiv->dev));
+		usb_wsource_trash(otgws_xceiv);
+		otgws_xceiv = NULL;
+		return ret;
+	}
+
+	return 0;
+}
+
+late_initcall(otg_wakeupsource_init);
diff --git a/drivers/usb/phy/phy.c b/drivers/usb/phy/phy.c
index 36b6bce..659b1e8 100644
--- a/drivers/usb/phy/phy.c
+++ b/drivers/usb/phy/phy.c
@@ -441,3 +441,45 @@ int usb_bind_phy(const char *dev_name, u8 index,
 	return 0;
 }
 EXPORT_SYMBOL_GPL(usb_bind_phy);
+
+/**
+ * usb_wsource_init - Initialize wakeupsource
+ * @usb_phy: the phy returned by usb_get_phy()
+ * @phy_dev_name: the device name of the phy
+ */
+void usb_wsource_init(struct usb_phy *x, char *phy_dev_name)
+{
+	wakeup_source_init(&x->wsource, phy_dev_name);
+}
+EXPORT_SYMBOL_GPL(usb_wsource_init);
+
+/**
+ * usb_wsource_trash - Trash wakeupsource
+ * @usb_phy: the phy returned by usb_get_phy()
+ */
+void usb_wsource_trash(struct usb_phy *x)
+{
+	wakeup_source_trash(&x->wsource);
+
+}
+EXPORT_SYMBOL_GPL(usb_wsource_trash);
+
+/**
+ * usb_grab_wsource - grab wakeupsource
+ * @usb_phy: the phy returned by usb_get_phy()
+ */
+void usb_grab_wsource(struct usb_phy *x)
+{
+	__pm_stay_awake(&x->wsource);
+}
+EXPORT_SYMBOL_GPL(usb_grab_wsource);
+
+/**
+ * usb_drop_wsource - drop wakeupsource
+ * @usb_phy: the phy returned by usb_get_phy()
+ */
+void usb_drop_wsource(struct usb_phy *x)
+{
+	__pm_relax(&x->wsource);
+}
+EXPORT_SYMBOL_GPL(usb_drop_wsource);
diff --git a/include/linux/usb/phy.h b/include/linux/usb/phy.h
index 353053a..6c680e6 100644
--- a/include/linux/usb/phy.h
+++ b/include/linux/usb/phy.h
@@ -11,6 +11,7 @@
 
 #include <linux/notifier.h>
 #include <linux/usb.h>
+#include <linux/pm_wakeup.h>
 
 enum usb_phy_interface {
 	USBPHY_INTERFACE_MODE_UNKNOWN,
@@ -89,6 +90,9 @@ struct usb_phy {
 	/* for notification of usb_phy_events */
 	struct atomic_notifier_head	notifier;
 
+	/* wakeup source */
+	struct wakeup_source wsource;
+
 	/* to pass extra port status to the root hub */
 	u16			port_status;
 	u16			port_change;
@@ -210,6 +214,10 @@ extern void usb_put_phy(struct usb_phy *);
 extern void devm_usb_put_phy(struct device *dev, struct usb_phy *x);
 extern int usb_bind_phy(const char *dev_name, u8 index,
 				const char *phy_dev_name);
+void usb_wsource_init(struct usb_phy *x, char *phy_dev_name);
+void usb_wsource_trash(struct usb_phy *x);
+void usb_grab_wsource(struct usb_phy *x);
+void usb_drop_wsource(struct usb_phy *x);
 #else
 static inline struct usb_phy *usb_get_phy(enum usb_phy_type type)
 {
-- 
1.8.2.1

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/