Skip to contentSkip to conversation

usb: phy: moving all PHY API definitions to usb/phy directory

PATCH Superseded Venu Byravarasu 3 participants 5 messages Jan 22, 2013 – Jan 23, 2013 USB

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 usb: phy: moving all PHY API definitions to usb/phy directory

As drivers/usb/otg/otg.c contains most of the PHY related APIs which are not OTG specific, moving them to more logical place under driver/usb/phy.

---
delta from v1:
Missed adding newly created file usb_phy.c with previous patch. hence sending v2, after adding that.

 drivers/usb/otg/otg.c                    |  184 ------------------------------
 drivers/usb/phy/Makefile                 |    1 +
 drivers/usb/{otg/otg.c => phy/usb_phy.c} |   45 +-------
 3 files changed, 6 insertions(+), 224 deletions(-)
 copy drivers/usb/{otg/otg.c => phy/usb_phy.c} (82%)
drivers/usb/otg/otg.c +0 -184
index a30c041..95561b9 100644
@@ -17,190 +17,6 @@
 
 #include <linux/usb/otg.h>
 
-static LIST_HEAD(phy_list);
-static DEFINE_SPINLOCK(phy_lock);
-
-static struct usb_phy *__usb_find_phy(struct list_head *list,
-	enum usb_phy_type type)
-{
-	struct usb_phy  *phy = NULL;
-
-	list_for_each_entry(phy, list, head) {
-		if (phy->type != type)
-			continue;
-
-		return phy;
-	}
-
-	return ERR_PTR(-ENODEV);
-}
-
-static void devm_usb_phy_release(struct device *dev, void *res)
-{
-	struct usb_phy *phy = *(struct usb_phy **)res;
-
-	usb_put_phy(phy);
-}
-
-static int devm_usb_phy_match(struct device *dev, void *res, void *match_data)
-{
-	return res == match_data;
-}
-
-/**
- * devm_usb_get_phy - find the USB PHY
- * @dev - device that requests this phy
- * @type - the type of the phy the controller requires
- *
- * Gets the phy using usb_get_phy(), and associates a device with it using
- * devres. On driver detach, release function is invoked on the devres data,
- * then, devres data is freed.
- *
- * For use by USB host and peripheral drivers.
- */
-struct usb_phy *devm_usb_get_phy(struct device *dev, enum usb_phy_type type)
-{
-	struct usb_phy **ptr, *phy;
-
-	ptr = devres_alloc(devm_usb_phy_release, sizeof(*ptr), GFP_KERNEL);
-	if (!ptr)
-		return NULL;
-
-	phy = usb_get_phy(type);
-	if (!IS_ERR(phy)) {
-		*ptr = phy;
-		devres_add(dev, ptr);
-	} else
-		devres_free(ptr);
-
-	return phy;
-}
-EXPORT_SYMBOL(devm_usb_get_phy);
-
-/**
- * usb_get_phy - find the USB PHY
- * @type - the type of the phy the controller requires
- *
- * Returns the phy driver, after getting a refcount to it; or
- * -ENODEV if there is no such phy.  The caller is responsible for
- * calling usb_put_phy() to release that count.
- *
- * For use by USB host and peripheral drivers.
- */
-struct usb_phy *usb_get_phy(enum usb_phy_type type)
-{
-	struct usb_phy	*phy = NULL;
-	unsigned long	flags;
-
-	spin_lock_irqsave(&phy_lock, flags);
-
-	phy = __usb_find_phy(&phy_list, type);
-	if (IS_ERR(phy)) {
-		pr_err("unable to find transceiver of type %s\n",
-			usb_phy_type_string(type));
-		goto err0;
-	}
-
-	get_device(phy->dev);
-
-err0:
-	spin_unlock_irqrestore(&phy_lock, flags);
-
-	return phy;
-}
-EXPORT_SYMBOL(usb_get_phy);
-
-/**
- * devm_usb_put_phy - release the USB PHY
- * @dev - device that wants to release this phy
- * @phy - the phy returned by devm_usb_get_phy()
- *
- * destroys the devres associated with this phy and invokes usb_put_phy
- * to release the phy.
- *
- * For use by USB host and peripheral drivers.
- */
-void devm_usb_put_phy(struct device *dev, struct usb_phy *phy)
-{
-	int r;
-
-	r = devres_destroy(dev, devm_usb_phy_release, devm_usb_phy_match, phy);
-	dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
-}
-EXPORT_SYMBOL(devm_usb_put_phy);
-
-/**
- * usb_put_phy - release the USB PHY
- * @x: the phy returned by usb_get_phy()
- *
- * Releases a refcount the caller received from usb_get_phy().
- *
- * For use by USB host and peripheral drivers.
- */
-void usb_put_phy(struct usb_phy *x)
-{
-	if (x)
-		put_device(x->dev);
-}
-EXPORT_SYMBOL(usb_put_phy);
-
-/**
- * usb_add_phy - declare the USB PHY
- * @x: the USB phy to be used; or NULL
- * @type - the type of this PHY
- *
- * This call is exclusively for use by phy drivers, which
- * coordinate the activities of drivers for host and peripheral
- * controllers, and in some cases for VBUS current regulation.
- */
-int usb_add_phy(struct usb_phy *x, enum usb_phy_type type)
-{
-	int		ret = 0;
-	unsigned long	flags;
-	struct usb_phy	*phy;
-
-	if (x->type != USB_PHY_TYPE_UNDEFINED) {
-		dev_err(x->dev, "not accepting initialized PHY %s\n", x->label);
-		return -EINVAL;
-	}
-
-	spin_lock_irqsave(&phy_lock, flags);
-
-	list_for_each_entry(phy, &phy_list, head) {
-		if (phy->type == type) {
-			ret = -EBUSY;
-			dev_err(x->dev, "transceiver type %s already exists\n",
-						usb_phy_type_string(type));
-			goto out;
-		}
-	}
-
-	x->type = type;
-	list_add_tail(&x->head, &phy_list);
-
-out:
-	spin_unlock_irqrestore(&phy_lock, flags);
-	return ret;
-}
-EXPORT_SYMBOL(usb_add_phy);
-
-/**
- * usb_remove_phy - remove the OTG PHY
- * @x: the USB OTG PHY to be removed;
- *
- * This reverts the effects of usb_add_phy
- */
-void usb_remove_phy(struct usb_phy *x)
-{
-	unsigned long	flags;
-
-	spin_lock_irqsave(&phy_lock, flags);
-	if (x)
-		list_del(&x->head);
-	spin_unlock_irqrestore(&phy_lock, flags);
-}
-EXPORT_SYMBOL(usb_remove_phy);
-
 const char *otg_state_string(enum usb_otg_state state)
 {
 	switch (state) {
drivers/usb/phy/Makefile +1 -0
index 1a579a8..5a21017 100644
@@ -4,6 +4,7 @@
 
 ccflags-$(CONFIG_USB_DEBUG) := -DDEBUG
 
+obj-y							+= usb_phy.o
 obj-$(CONFIG_OMAP_USB2)			+= omap-usb2.o
 obj-$(CONFIG_USB_ISP1301)		+= isp1301.o
 obj-$(CONFIG_MV_U3D_PHY)		+= mv_u3d_phy.o
drivers/usb/phy/usb_phy.c renamed from drivers/usb/otg/otg.c +5 -40

65 lines not on this page · raw message

Signature · 1 line
1.7.0.4
#1 lore raw

Hi,

Quoted 5 lines · Venu Byravarasu

As drivers/usb/otg/otg.c contains most of the PHY related APIs which are not OTG specific, moving them to more logical place under driver/usb/phy.

Quoted 8 lines

---
delta from v1:
Missed adding newly created file usb_phy.c with previous patch. hence sending v2, after adding that.

 drivers/usb/otg/otg.c                    |  184 ------------------------------
 drivers/usb/phy/Makefile                 |    1 +
 drivers/usb/{otg/otg.c => phy/usb_phy.c} |   45 +-------

let's call this file phy.c or phy-core.c.

Signature · 1 line
balbi
#2 lore raw
In reply to Venu Byravarasu
Quoted 10 lines · Venu Byravarasu

As drivers/usb/otg/otg.c contains most of the PHY related APIs which are not OTG specific, moving them to more logical place under driver/usb/phy.

---
delta from v1:
Missed adding newly created file usb_phy.c with previous patch. hence sending v2, after adding that.

Quoted 5 lines
 drivers/usb/otg/otg.c                    |  184 ------------------------------
 drivers/usb/phy/Makefile                 |    1 +
 drivers/usb/{otg/otg.c => phy/usb_phy.c} |   45 +-------
 3 files changed, 6 insertions(+), 224 deletions(-)
 copy drivers/usb/{otg/otg.c => phy/usb_phy.c} (82%)

what about updating
drivers/usb/otg/Makefile and Kconfig?

i.e. remove CONFIG_USB_OTG_UTILS and otg.o there?

--
cheers,
-roger

Quoted 285 lines
drivers/usb/otg/otg.c +0 -184
index a30c041..95561b9 100644
@@ -17,190 +17,6 @@
 
 #include <linux/usb/otg.h>
 
-static LIST_HEAD(phy_list);
-static DEFINE_SPINLOCK(phy_lock);
-
-static struct usb_phy *__usb_find_phy(struct list_head *list,
-	enum usb_phy_type type)
-{
-	struct usb_phy  *phy = NULL;
-
-	list_for_each_entry(phy, list, head) {
-		if (phy->type != type)
-			continue;
-
-		return phy;
-	}
-
-	return ERR_PTR(-ENODEV);
-}
-
-static void devm_usb_phy_release(struct device *dev, void *res)
-{
-	struct usb_phy *phy = *(struct usb_phy **)res;
-
-	usb_put_phy(phy);
-}
-
-static int devm_usb_phy_match(struct device *dev, void *res, void *match_data)
-{
-	return res == match_data;
-}
-
-/**
- * devm_usb_get_phy - find the USB PHY
- * @dev - device that requests this phy
- * @type - the type of the phy the controller requires
- *
- * Gets the phy using usb_get_phy(), and associates a device with it using
- * devres. On driver detach, release function is invoked on the devres data,
- * then, devres data is freed.
- *
- * For use by USB host and peripheral drivers.
- */
-struct usb_phy *devm_usb_get_phy(struct device *dev, enum usb_phy_type type)
-{
-	struct usb_phy **ptr, *phy;
-
-	ptr = devres_alloc(devm_usb_phy_release, sizeof(*ptr), GFP_KERNEL);
-	if (!ptr)
-		return NULL;
-
-	phy = usb_get_phy(type);
-	if (!IS_ERR(phy)) {
-		*ptr = phy;
-		devres_add(dev, ptr);
-	} else
-		devres_free(ptr);
-
-	return phy;
-}
-EXPORT_SYMBOL(devm_usb_get_phy);
-
-/**
- * usb_get_phy - find the USB PHY
- * @type - the type of the phy the controller requires
- *
- * Returns the phy driver, after getting a refcount to it; or
- * -ENODEV if there is no such phy.  The caller is responsible for
- * calling usb_put_phy() to release that count.
- *
- * For use by USB host and peripheral drivers.
- */
-struct usb_phy *usb_get_phy(enum usb_phy_type type)
-{
-	struct usb_phy	*phy = NULL;
-	unsigned long	flags;
-
-	spin_lock_irqsave(&phy_lock, flags);
-
-	phy = __usb_find_phy(&phy_list, type);
-	if (IS_ERR(phy)) {
-		pr_err("unable to find transceiver of type %s\n",
-			usb_phy_type_string(type));
-		goto err0;
-	}
-
-	get_device(phy->dev);
-
-err0:
-	spin_unlock_irqrestore(&phy_lock, flags);
-
-	return phy;
-}
-EXPORT_SYMBOL(usb_get_phy);
-
-/**
- * devm_usb_put_phy - release the USB PHY
- * @dev - device that wants to release this phy
- * @phy - the phy returned by devm_usb_get_phy()
- *
- * destroys the devres associated with this phy and invokes usb_put_phy
- * to release the phy.
- *
- * For use by USB host and peripheral drivers.
- */
-void devm_usb_put_phy(struct device *dev, struct usb_phy *phy)
-{
-	int r;
-
-	r = devres_destroy(dev, devm_usb_phy_release, devm_usb_phy_match, phy);
-	dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
-}
-EXPORT_SYMBOL(devm_usb_put_phy);
-
-/**
- * usb_put_phy - release the USB PHY
- * @x: the phy returned by usb_get_phy()
- *
- * Releases a refcount the caller received from usb_get_phy().
- *
- * For use by USB host and peripheral drivers.
- */
-void usb_put_phy(struct usb_phy *x)
-{
-	if (x)
-		put_device(x->dev);
-}
-EXPORT_SYMBOL(usb_put_phy);
-
-/**
- * usb_add_phy - declare the USB PHY
- * @x: the USB phy to be used; or NULL
- * @type - the type of this PHY
- *
- * This call is exclusively for use by phy drivers, which
- * coordinate the activities of drivers for host and peripheral
- * controllers, and in some cases for VBUS current regulation.
- */
-int usb_add_phy(struct usb_phy *x, enum usb_phy_type type)
-{
-	int		ret = 0;
-	unsigned long	flags;
-	struct usb_phy	*phy;
-
-	if (x->type != USB_PHY_TYPE_UNDEFINED) {
-		dev_err(x->dev, "not accepting initialized PHY %s\n", x->label);
-		return -EINVAL;
-	}
-
-	spin_lock_irqsave(&phy_lock, flags);
-
-	list_for_each_entry(phy, &phy_list, head) {
-		if (phy->type == type) {
-			ret = -EBUSY;
-			dev_err(x->dev, "transceiver type %s already exists\n",
-						usb_phy_type_string(type));
-			goto out;
-		}
-	}
-
-	x->type = type;
-	list_add_tail(&x->head, &phy_list);
-
-out:
-	spin_unlock_irqrestore(&phy_lock, flags);
-	return ret;
-}
-EXPORT_SYMBOL(usb_add_phy);
-
-/**
- * usb_remove_phy - remove the OTG PHY
- * @x: the USB OTG PHY to be removed;
- *
- * This reverts the effects of usb_add_phy
- */
-void usb_remove_phy(struct usb_phy *x)
-{
-	unsigned long	flags;
-
-	spin_lock_irqsave(&phy_lock, flags);
-	if (x)
-		list_del(&x->head);
-	spin_unlock_irqrestore(&phy_lock, flags);
-}
-EXPORT_SYMBOL(usb_remove_phy);
-
 const char *otg_state_string(enum usb_otg_state state)
 {
 	switch (state) {
drivers/usb/phy/Makefile +1 -0
index 1a579a8..5a21017 100644
@@ -4,6 +4,7 @@
 
 ccflags-$(CONFIG_USB_DEBUG) := -DDEBUG
 
+obj-y							+= usb_phy.o
 obj-$(CONFIG_OMAP_USB2)			+= omap-usb2.o
 obj-$(CONFIG_USB_ISP1301)		+= isp1301.o
 obj-$(CONFIG_MV_U3D_PHY)		+= mv_u3d_phy.o
drivers/usb/phy/usb_phy.c renamed from drivers/usb/otg/otg.c +5 -40
similarity index 82%
copy from drivers/usb/otg/otg.c
copy to drivers/usb/phy/usb_phy.c
index a30c041..1c74261 100644
@@ -1,7 +1,7 @@
 /*
- * otg.c -- USB OTG utility code
+ * usb_phy.c -- USB PHY utility code
  *
- * Copyright (C) 2004 Texas Instruments
+ * Copyright (C) 200 Texas Instruments
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -15,7 +15,7 @@
 #include <linux/device.h>
 #include <linux/slab.h>
 
-#include <linux/usb/otg.h>
+#include <linux/usb/phy.h>
 
 static LIST_HEAD(phy_list);
 static DEFINE_SPINLOCK(phy_lock);
@@ -185,8 +185,8 @@ out:
 EXPORT_SYMBOL(usb_add_phy);
 
 /**
- * usb_remove_phy - remove the OTG PHY
- * @x: the USB OTG PHY to be removed;
+ * usb_remove_phy - remove PHY
+ * @x: the USB PHY to be removed;
  *
  * This reverts the effects of usb_add_phy
  */
@@ -200,38 +200,3 @@ void usb_remove_phy(struct usb_phy *x)
 	spin_unlock_irqrestore(&phy_lock, flags);
 }
 EXPORT_SYMBOL(usb_remove_phy);
-
-const char *otg_state_string(enum usb_otg_state state)
-{
-	switch (state) {
-	case OTG_STATE_A_IDLE:
-		return "a_idle";
-	case OTG_STATE_A_WAIT_VRISE:
-		return "a_wait_vrise";
-	case OTG_STATE_A_WAIT_BCON:
-		return "a_wait_bcon";
-	case OTG_STATE_A_HOST:
-		return "a_host";
-	case OTG_STATE_A_SUSPEND:
-		return "a_suspend";
-	case OTG_STATE_A_PERIPHERAL:
-		return "a_peripheral";
-	case OTG_STATE_A_WAIT_VFALL:
-		return "a_wait_vfall";
-	case OTG_STATE_A_VBUS_ERR:
-		return "a_vbus_err";
-	case OTG_STATE_B_IDLE:
-		return "b_idle";
-	case OTG_STATE_B_SRP_INIT:
-		return "b_srp_init";
-	case OTG_STATE_B_PERIPHERAL:
-		return "b_peripheral";
-	case OTG_STATE_B_WAIT_ACON:
-		return "b_wait_acon";
-	case OTG_STATE_B_HOST:
-		return "b_host";
-	default:
-		return "UNDEFINED";
-	}
-}
-EXPORT_SYMBOL(otg_state_string);
#3 lore raw
Quoted 26 lines

-----Original Message-----
From: Roger Quadros [mailto:[email protected]]
Sent: Tuesday, January 22, 2013 7:51 PM
To: Venu Byravarasu
Cc: [email protected]; [email protected]; [email protected]; [email protected]
Subject: Re: [PATCH v2] usb: phy: moving all PHY API definitions to usb/phy directory

Quoted 10 lines · Venu Byravarasu

As drivers/usb/otg/otg.c contains most of the PHY related APIs which are not OTG specific, moving them to more logical place under driver/usb/phy.

---
delta from v1:
Missed adding newly created file usb_phy.c with previous patch. hence sending v2, after adding that.

Quoted 5 lines
 drivers/usb/otg/otg.c                    |  184 ------------------------------
 drivers/usb/phy/Makefile                 |    1 +
 drivers/usb/{otg/otg.c => phy/usb_phy.c} |   45 +-------
 3 files changed, 6 insertions(+), 224 deletions(-)
 copy drivers/usb/{otg/otg.c => phy/usb_phy.c} (82%)
Quoted 4 lines

what about updating
drivers/usb/otg/Makefile and Kconfig?

i.e. remove CONFIG_USB_OTG_UTILS and otg.o there?

Thanks for your comments.
Those files may still be needed, as we're not removing otg.c, due to remaining only otg function i.e. otg_state_string().

Felipe,
Shall I move otg_state_string() to otg.h and remove otg.c altogether?

Quoted 5 lines

--
cheers,
-roger

#4 lore raw
Quoted 26 lines · Venu Byravarasu
Quoted 26 lines

-----Original Message-----
From: Roger Quadros [mailto:[email protected]]
Sent: Tuesday, January 22, 2013 7:51 PM
To: Venu Byravarasu
Cc: [email protected]; [email protected]; [email protected]; [email protected]
Subject: Re: [PATCH v2] usb: phy: moving all PHY API definitions to usb/phy directory

Quoted 15 lines · Venu Byravarasu

As drivers/usb/otg/otg.c contains most of the PHY related APIs which are not OTG specific, moving them to more logical place under driver/usb/phy.

---
delta from v1:
Missed adding newly created file usb_phy.c with previous patch. hence sending v2, after adding that.

 drivers/usb/otg/otg.c                    |  184 ------------------------------
 drivers/usb/phy/Makefile                 |    1 +
 drivers/usb/{otg/otg.c => phy/usb_phy.c} |   45 +-------
 3 files changed, 6 insertions(+), 224 deletions(-)
 copy drivers/usb/{otg/otg.c => phy/usb_phy.c} (82%)
Quoted 9 lines
Quoted 4 lines

what about updating
drivers/usb/otg/Makefile and Kconfig?

i.e. remove CONFIG_USB_OTG_UTILS and otg.o there?

Thanks for your comments.
Those files may still be needed, as we're not removing otg.c, due to remaining only otg function i.e. otg_state_string().

Oh yes, in that case it is fine.

--
cheers,
-roger.