2 * phy.c -- USB phy handling
4 * Copyright (C) 2004-2013 Texas Instruments
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 #include <linux/kernel.h>
12 #include <linux/export.h>
13 #include <linux/err.h>
14 #include <linux/device.h>
15 #include <linux/module.h>
16 #include <linux/slab.h>
19 #include <linux/usb/phy.h>
21 static LIST_HEAD(phy_list);
22 static LIST_HEAD(phy_bind_list);
23 static DEFINE_SPINLOCK(phy_lock);
25 static struct usb_phy *__usb_find_phy(struct list_head *list,
26 enum usb_phy_type type)
28 struct usb_phy *phy = NULL;
30 list_for_each_entry(phy, list, head) {
31 if (phy->type != type)
37 return ERR_PTR(-ENODEV);
40 static struct usb_phy *__usb_find_phy_dev(struct device *dev,
41 struct list_head *list, u8 index)
43 struct usb_phy_bind *phy_bind = NULL;
45 list_for_each_entry(phy_bind, list, list) {
46 if (!(strcmp(phy_bind->dev_name, dev_name(dev))) &&
47 phy_bind->index == index) {
51 return ERR_PTR(-EPROBE_DEFER);
55 return ERR_PTR(-ENODEV);
58 static struct usb_phy *__of_usb_find_phy(struct device_node *node)
62 list_for_each_entry(phy, &phy_list, head) {
63 if (node != phy->dev->of_node)
69 return ERR_PTR(-ENODEV);
72 static void devm_usb_phy_release(struct device *dev, void *res)
74 struct usb_phy *phy = *(struct usb_phy **)res;
79 static int devm_usb_phy_match(struct device *dev, void *res, void *match_data)
81 return res == match_data;
85 * devm_usb_get_phy - find the USB PHY
86 * @dev - device that requests this phy
87 * @type - the type of the phy the controller requires
89 * Gets the phy using usb_get_phy(), and associates a device with it using
90 * devres. On driver detach, release function is invoked on the devres data,
91 * then, devres data is freed.
93 * For use by USB host and peripheral drivers.
95 struct usb_phy *devm_usb_get_phy(struct device *dev, enum usb_phy_type type)
97 struct usb_phy **ptr, *phy;
99 ptr = devres_alloc(devm_usb_phy_release, sizeof(*ptr), GFP_KERNEL);
101 return ERR_PTR(-ENOMEM);
103 phy = usb_get_phy(type);
106 devres_add(dev, ptr);
112 EXPORT_SYMBOL_GPL(devm_usb_get_phy);
115 * usb_get_phy - find the USB PHY
116 * @type - the type of the phy the controller requires
118 * Returns the phy driver, after getting a refcount to it; or
119 * -ENODEV if there is no such phy. The caller is responsible for
120 * calling usb_put_phy() to release that count.
122 * For use by USB host and peripheral drivers.
124 struct usb_phy *usb_get_phy(enum usb_phy_type type)
126 struct usb_phy *phy = NULL;
129 spin_lock_irqsave(&phy_lock, flags);
131 phy = __usb_find_phy(&phy_list, type);
132 if (IS_ERR(phy) || !try_module_get(phy->dev->driver->owner)) {
133 pr_debug("PHY: unable to find transceiver of type %s\n",
134 usb_phy_type_string(type));
136 phy = ERR_PTR(-ENODEV);
141 get_device(phy->dev);
144 spin_unlock_irqrestore(&phy_lock, flags);
148 EXPORT_SYMBOL_GPL(usb_get_phy);
151 * devm_usb_get_phy_by_phandle - find the USB PHY by phandle
152 * @dev - device that requests this phy
153 * @phandle - name of the property holding the phy phandle value
154 * @index - the index of the phy
156 * Returns the phy driver associated with the given phandle value,
157 * after getting a refcount to it, -ENODEV if there is no such phy or
158 * -EPROBE_DEFER if there is a phandle to the phy, but the device is
159 * not yet loaded. While at that, it also associates the device with
160 * the phy using devres. On driver detach, release function is invoked
161 * on the devres data, then, devres data is freed.
163 * For use by USB host and peripheral drivers.
165 struct usb_phy *devm_usb_get_phy_by_phandle(struct device *dev,
166 const char *phandle, u8 index)
168 struct usb_phy *phy = ERR_PTR(-ENOMEM), **ptr;
170 struct device_node *node;
173 dev_dbg(dev, "device does not have a device node entry\n");
174 return ERR_PTR(-EINVAL);
177 node = of_parse_phandle(dev->of_node, phandle, index);
179 dev_dbg(dev, "failed to get %s phandle in %s node\n", phandle,
180 dev->of_node->full_name);
181 return ERR_PTR(-ENODEV);
184 ptr = devres_alloc(devm_usb_phy_release, sizeof(*ptr), GFP_KERNEL);
186 dev_dbg(dev, "failed to allocate memory for devres\n");
190 spin_lock_irqsave(&phy_lock, flags);
192 phy = __of_usb_find_phy(node);
193 if (IS_ERR(phy) || !try_module_get(phy->dev->driver->owner)) {
195 phy = ERR_PTR(-EPROBE_DEFER);
202 devres_add(dev, ptr);
204 get_device(phy->dev);
207 spin_unlock_irqrestore(&phy_lock, flags);
214 EXPORT_SYMBOL_GPL(devm_usb_get_phy_by_phandle);
217 * usb_get_phy_dev - find the USB PHY
218 * @dev - device that requests this phy
219 * @index - the index of the phy
221 * Returns the phy driver, after getting a refcount to it; or
222 * -ENODEV if there is no such phy. The caller is responsible for
223 * calling usb_put_phy() to release that count.
225 * For use by USB host and peripheral drivers.
227 struct usb_phy *usb_get_phy_dev(struct device *dev, u8 index)
229 struct usb_phy *phy = NULL;
232 spin_lock_irqsave(&phy_lock, flags);
234 phy = __usb_find_phy_dev(dev, &phy_bind_list, index);
235 if (IS_ERR(phy) || !try_module_get(phy->dev->driver->owner)) {
236 dev_dbg(dev, "unable to find transceiver\n");
238 phy = ERR_PTR(-ENODEV);
243 get_device(phy->dev);
246 spin_unlock_irqrestore(&phy_lock, flags);
250 EXPORT_SYMBOL_GPL(usb_get_phy_dev);
253 * devm_usb_get_phy_dev - find the USB PHY using device ptr and index
254 * @dev - device that requests this phy
255 * @index - the index of the phy
257 * Gets the phy using usb_get_phy_dev(), and associates a device with it using
258 * devres. On driver detach, release function is invoked on the devres data,
259 * then, devres data is freed.
261 * For use by USB host and peripheral drivers.
263 struct usb_phy *devm_usb_get_phy_dev(struct device *dev, u8 index)
265 struct usb_phy **ptr, *phy;
267 ptr = devres_alloc(devm_usb_phy_release, sizeof(*ptr), GFP_KERNEL);
271 phy = usb_get_phy_dev(dev, index);
274 devres_add(dev, ptr);
280 EXPORT_SYMBOL_GPL(devm_usb_get_phy_dev);
283 * devm_usb_put_phy - release the USB PHY
284 * @dev - device that wants to release this phy
285 * @phy - the phy returned by devm_usb_get_phy()
287 * destroys the devres associated with this phy and invokes usb_put_phy
288 * to release the phy.
290 * For use by USB host and peripheral drivers.
292 void devm_usb_put_phy(struct device *dev, struct usb_phy *phy)
296 r = devres_destroy(dev, devm_usb_phy_release, devm_usb_phy_match, phy);
297 dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
299 EXPORT_SYMBOL_GPL(devm_usb_put_phy);
302 * usb_put_phy - release the USB PHY
303 * @x: the phy returned by usb_get_phy()
305 * Releases a refcount the caller received from usb_get_phy().
307 * For use by USB host and peripheral drivers.
309 void usb_put_phy(struct usb_phy *x)
312 struct module *owner = x->dev->driver->owner;
318 EXPORT_SYMBOL_GPL(usb_put_phy);
321 * usb_add_phy - declare the USB PHY
322 * @x: the USB phy to be used; or NULL
323 * @type - the type of this PHY
325 * This call is exclusively for use by phy drivers, which
326 * coordinate the activities of drivers for host and peripheral
327 * controllers, and in some cases for VBUS current regulation.
329 int usb_add_phy(struct usb_phy *x, enum usb_phy_type type)
335 if (x->type != USB_PHY_TYPE_UNDEFINED) {
336 dev_err(x->dev, "not accepting initialized PHY %s\n", x->label);
340 ATOMIC_INIT_NOTIFIER_HEAD(&x->notifier);
342 spin_lock_irqsave(&phy_lock, flags);
344 list_for_each_entry(phy, &phy_list, head) {
345 if (phy->type == type) {
347 dev_err(x->dev, "transceiver type %s already exists\n",
348 usb_phy_type_string(type));
354 list_add_tail(&x->head, &phy_list);
357 spin_unlock_irqrestore(&phy_lock, flags);
360 EXPORT_SYMBOL_GPL(usb_add_phy);
363 * usb_add_phy_dev - declare the USB PHY
364 * @x: the USB phy to be used; or NULL
366 * This call is exclusively for use by phy drivers, which
367 * coordinate the activities of drivers for host and peripheral
368 * controllers, and in some cases for VBUS current regulation.
370 int usb_add_phy_dev(struct usb_phy *x)
372 struct usb_phy_bind *phy_bind;
376 dev_err(x->dev, "no device provided for PHY\n");
380 ATOMIC_INIT_NOTIFIER_HEAD(&x->notifier);
382 spin_lock_irqsave(&phy_lock, flags);
383 list_for_each_entry(phy_bind, &phy_bind_list, list)
384 if (!(strcmp(phy_bind->phy_dev_name, dev_name(x->dev))))
387 list_add_tail(&x->head, &phy_list);
389 spin_unlock_irqrestore(&phy_lock, flags);
392 EXPORT_SYMBOL_GPL(usb_add_phy_dev);
395 * usb_remove_phy - remove the OTG PHY
396 * @x: the USB OTG PHY to be removed;
398 * This reverts the effects of usb_add_phy
400 void usb_remove_phy(struct usb_phy *x)
403 struct usb_phy_bind *phy_bind;
405 spin_lock_irqsave(&phy_lock, flags);
407 list_for_each_entry(phy_bind, &phy_bind_list, list)
408 if (phy_bind->phy == x)
409 phy_bind->phy = NULL;
412 spin_unlock_irqrestore(&phy_lock, flags);
414 EXPORT_SYMBOL_GPL(usb_remove_phy);
417 * usb_bind_phy - bind the phy and the controller that uses the phy
418 * @dev_name: the device name of the device that will bind to the phy
419 * @index: index to specify the port number
420 * @phy_dev_name: the device name of the phy
422 * Fills the phy_bind structure with the dev_name and phy_dev_name. This will
423 * be used when the phy driver registers the phy and when the controller
426 * To be used by platform specific initialization code.
428 int usb_bind_phy(const char *dev_name, u8 index,
429 const char *phy_dev_name)
431 struct usb_phy_bind *phy_bind;
434 phy_bind = kzalloc(sizeof(*phy_bind), GFP_KERNEL);
438 phy_bind->dev_name = dev_name;
439 phy_bind->phy_dev_name = phy_dev_name;
440 phy_bind->index = index;
442 spin_lock_irqsave(&phy_lock, flags);
443 list_add_tail(&phy_bind->list, &phy_bind_list);
444 spin_unlock_irqrestore(&phy_lock, flags);
448 EXPORT_SYMBOL_GPL(usb_bind_phy);
451 * usb_phy_set_event - set event to phy event
452 * @x: the phy returned by usb_get_phy();
454 * This sets event to phy event
456 void usb_phy_set_event(struct usb_phy *x, unsigned long event)
458 x->last_event = event;
460 EXPORT_SYMBOL_GPL(usb_phy_set_event);