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);
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_err("unable to find transceiver of type %s\n",
134 usb_phy_type_string(type));
138 get_device(phy->dev);
141 spin_unlock_irqrestore(&phy_lock, flags);
145 EXPORT_SYMBOL_GPL(usb_get_phy);
148 * devm_usb_get_phy_by_phandle - find the USB PHY by phandle
149 * @dev - device that requests this phy
150 * @phandle - name of the property holding the phy phandle value
151 * @index - the index of the phy
153 * Returns the phy driver associated with the given phandle value,
154 * after getting a refcount to it, -ENODEV if there is no such phy or
155 * -EPROBE_DEFER if there is a phandle to the phy, but the device is
156 * not yet loaded. While at that, it also associates the device with
157 * the phy using devres. On driver detach, release function is invoked
158 * on the devres data, then, devres data is freed.
160 * For use by USB host and peripheral drivers.
162 struct usb_phy *devm_usb_get_phy_by_phandle(struct device *dev,
163 const char *phandle, u8 index)
165 struct usb_phy *phy = ERR_PTR(-ENOMEM), **ptr;
167 struct device_node *node;
170 dev_dbg(dev, "device does not have a device node entry\n");
171 return ERR_PTR(-EINVAL);
174 node = of_parse_phandle(dev->of_node, phandle, index);
176 dev_dbg(dev, "failed to get %s phandle in %s node\n", phandle,
177 dev->of_node->full_name);
178 return ERR_PTR(-ENODEV);
181 ptr = devres_alloc(devm_usb_phy_release, sizeof(*ptr), GFP_KERNEL);
183 dev_dbg(dev, "failed to allocate memory for devres\n");
187 spin_lock_irqsave(&phy_lock, flags);
189 phy = __of_usb_find_phy(node);
190 if (IS_ERR(phy) || !try_module_get(phy->dev->driver->owner)) {
191 phy = ERR_PTR(-EPROBE_DEFER);
197 devres_add(dev, ptr);
199 get_device(phy->dev);
202 spin_unlock_irqrestore(&phy_lock, flags);
209 EXPORT_SYMBOL_GPL(devm_usb_get_phy_by_phandle);
212 * usb_get_phy_dev - find the USB PHY
213 * @dev - device that requests this phy
214 * @index - the index of the phy
216 * Returns the phy driver, after getting a refcount to it; or
217 * -ENODEV if there is no such phy. The caller is responsible for
218 * calling usb_put_phy() to release that count.
220 * For use by USB host and peripheral drivers.
222 struct usb_phy *usb_get_phy_dev(struct device *dev, u8 index)
224 struct usb_phy *phy = NULL;
227 spin_lock_irqsave(&phy_lock, flags);
229 phy = __usb_find_phy_dev(dev, &phy_bind_list, index);
230 if (IS_ERR(phy) || !try_module_get(phy->dev->driver->owner)) {
231 pr_err("unable to find transceiver\n");
235 get_device(phy->dev);
238 spin_unlock_irqrestore(&phy_lock, flags);
242 EXPORT_SYMBOL_GPL(usb_get_phy_dev);
245 * devm_usb_get_phy_dev - find the USB PHY using device ptr and index
246 * @dev - device that requests this phy
247 * @index - the index of the phy
249 * Gets the phy using usb_get_phy_dev(), and associates a device with it using
250 * devres. On driver detach, release function is invoked on the devres data,
251 * then, devres data is freed.
253 * For use by USB host and peripheral drivers.
255 struct usb_phy *devm_usb_get_phy_dev(struct device *dev, u8 index)
257 struct usb_phy **ptr, *phy;
259 ptr = devres_alloc(devm_usb_phy_release, sizeof(*ptr), GFP_KERNEL);
263 phy = usb_get_phy_dev(dev, index);
266 devres_add(dev, ptr);
272 EXPORT_SYMBOL_GPL(devm_usb_get_phy_dev);
275 * devm_usb_put_phy - release the USB PHY
276 * @dev - device that wants to release this phy
277 * @phy - the phy returned by devm_usb_get_phy()
279 * destroys the devres associated with this phy and invokes usb_put_phy
280 * to release the phy.
282 * For use by USB host and peripheral drivers.
284 void devm_usb_put_phy(struct device *dev, struct usb_phy *phy)
288 r = devres_destroy(dev, devm_usb_phy_release, devm_usb_phy_match, phy);
289 dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
291 EXPORT_SYMBOL_GPL(devm_usb_put_phy);
294 * usb_put_phy - release the USB PHY
295 * @x: the phy returned by usb_get_phy()
297 * Releases a refcount the caller received from usb_get_phy().
299 * For use by USB host and peripheral drivers.
301 void usb_put_phy(struct usb_phy *x)
304 struct module *owner = x->dev->driver->owner;
310 EXPORT_SYMBOL_GPL(usb_put_phy);
313 * usb_add_phy - declare the USB PHY
314 * @x: the USB phy to be used; or NULL
315 * @type - the type of this PHY
317 * This call is exclusively for use by phy drivers, which
318 * coordinate the activities of drivers for host and peripheral
319 * controllers, and in some cases for VBUS current regulation.
321 int usb_add_phy(struct usb_phy *x, enum usb_phy_type type)
327 if (x->type != USB_PHY_TYPE_UNDEFINED) {
328 dev_err(x->dev, "not accepting initialized PHY %s\n", x->label);
332 spin_lock_irqsave(&phy_lock, flags);
334 list_for_each_entry(phy, &phy_list, head) {
335 if (phy->type == type) {
337 dev_err(x->dev, "transceiver type %s already exists\n",
338 usb_phy_type_string(type));
344 list_add_tail(&x->head, &phy_list);
347 spin_unlock_irqrestore(&phy_lock, flags);
350 EXPORT_SYMBOL_GPL(usb_add_phy);
353 * usb_add_phy_dev - declare the USB PHY
354 * @x: the USB phy to be used; or NULL
356 * This call is exclusively for use by phy drivers, which
357 * coordinate the activities of drivers for host and peripheral
358 * controllers, and in some cases for VBUS current regulation.
360 int usb_add_phy_dev(struct usb_phy *x)
362 struct usb_phy_bind *phy_bind;
366 dev_err(x->dev, "no device provided for PHY\n");
370 spin_lock_irqsave(&phy_lock, flags);
371 list_for_each_entry(phy_bind, &phy_bind_list, list)
372 if (!(strcmp(phy_bind->phy_dev_name, dev_name(x->dev))))
375 list_add_tail(&x->head, &phy_list);
377 spin_unlock_irqrestore(&phy_lock, flags);
380 EXPORT_SYMBOL_GPL(usb_add_phy_dev);
383 * usb_remove_phy - remove the OTG PHY
384 * @x: the USB OTG PHY to be removed;
386 * This reverts the effects of usb_add_phy
388 void usb_remove_phy(struct usb_phy *x)
391 struct usb_phy_bind *phy_bind;
393 spin_lock_irqsave(&phy_lock, flags);
395 list_for_each_entry(phy_bind, &phy_bind_list, list)
396 if (phy_bind->phy == x)
397 phy_bind->phy = NULL;
400 spin_unlock_irqrestore(&phy_lock, flags);
402 EXPORT_SYMBOL_GPL(usb_remove_phy);
405 * usb_bind_phy - bind the phy and the controller that uses the phy
406 * @dev_name: the device name of the device that will bind to the phy
407 * @index: index to specify the port number
408 * @phy_dev_name: the device name of the phy
410 * Fills the phy_bind structure with the dev_name and phy_dev_name. This will
411 * be used when the phy driver registers the phy and when the controller
414 * To be used by platform specific initialization code.
416 int usb_bind_phy(const char *dev_name, u8 index,
417 const char *phy_dev_name)
419 struct usb_phy_bind *phy_bind;
422 phy_bind = kzalloc(sizeof(*phy_bind), GFP_KERNEL);
424 pr_err("phy_bind(): No memory for phy_bind");
428 phy_bind->dev_name = dev_name;
429 phy_bind->phy_dev_name = phy_dev_name;
430 phy_bind->index = index;
432 spin_lock_irqsave(&phy_lock, flags);
433 list_add_tail(&phy_bind->list, &phy_bind_list);
434 spin_unlock_irqrestore(&phy_lock, flags);
438 EXPORT_SYMBOL_GPL(usb_bind_phy);