2 * otg.c -- USB OTG utility code
4 * Copyright (C) 2004 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.
12 #include <linux/kernel.h>
13 #include <linux/export.h>
14 #include <linux/err.h>
15 #include <linux/device.h>
16 #include <linux/module.h>
17 #include <linux/slab.h>
20 #include <linux/usb/otg.h>
22 static LIST_HEAD(phy_list);
23 static LIST_HEAD(phy_bind_list);
24 static DEFINE_SPINLOCK(phy_lock);
26 static struct usb_phy *__usb_find_phy(struct list_head *list,
27 enum usb_phy_type type)
29 struct usb_phy *phy = NULL;
31 list_for_each_entry(phy, list, head) {
32 if (phy->type != type)
38 return ERR_PTR(-ENODEV);
41 static struct usb_phy *__usb_find_phy_dev(struct device *dev,
42 struct list_head *list, u8 index)
44 struct usb_phy_bind *phy_bind = NULL;
46 list_for_each_entry(phy_bind, list, list) {
47 if (!(strcmp(phy_bind->dev_name, dev_name(dev))) &&
48 phy_bind->index == index) {
52 return ERR_PTR(-EPROBE_DEFER);
56 return ERR_PTR(-ENODEV);
59 static struct usb_phy *__of_usb_find_phy(struct device_node *node)
63 list_for_each_entry(phy, &phy_list, head) {
64 if (node != phy->dev->of_node)
70 return ERR_PTR(-ENODEV);
73 static void devm_usb_phy_release(struct device *dev, void *res)
75 struct usb_phy *phy = *(struct usb_phy **)res;
80 static int devm_usb_phy_match(struct device *dev, void *res, void *match_data)
82 return res == match_data;
86 * devm_usb_get_phy - find the USB PHY
87 * @dev - device that requests this phy
88 * @type - the type of the phy the controller requires
90 * Gets the phy using usb_get_phy(), and associates a device with it using
91 * devres. On driver detach, release function is invoked on the devres data,
92 * then, devres data is freed.
94 * For use by USB host and peripheral drivers.
96 struct usb_phy *devm_usb_get_phy(struct device *dev, enum usb_phy_type type)
98 struct usb_phy **ptr, *phy;
100 ptr = devres_alloc(devm_usb_phy_release, sizeof(*ptr), GFP_KERNEL);
104 phy = usb_get_phy(type);
107 devres_add(dev, ptr);
113 EXPORT_SYMBOL(devm_usb_get_phy);
116 * usb_get_phy - find the USB PHY
117 * @type - the type of the phy the controller requires
119 * Returns the phy driver, after getting a refcount to it; or
120 * -ENODEV if there is no such phy. The caller is responsible for
121 * calling usb_put_phy() to release that count.
123 * For use by USB host and peripheral drivers.
125 struct usb_phy *usb_get_phy(enum usb_phy_type type)
127 struct usb_phy *phy = NULL;
130 spin_lock_irqsave(&phy_lock, flags);
132 phy = __usb_find_phy(&phy_list, type);
134 pr_err("unable to find transceiver of type %s\n",
135 usb_phy_type_string(type));
139 get_device(phy->dev);
142 spin_unlock_irqrestore(&phy_lock, flags);
146 EXPORT_SYMBOL(usb_get_phy);
149 * devm_usb_get_phy_by_phandle - find the USB PHY by phandle
150 * @dev - device that requests this phy
151 * @phandle - name of the property holding the phy phandle value
152 * @index - the index of the phy
154 * Returns the phy driver associated with the given phandle value,
155 * after getting a refcount to it, -ENODEV if there is no such phy or
156 * -EPROBE_DEFER if there is a phandle to the phy, but the device is
157 * not yet loaded. While at that, it also associates the device with
158 * the phy using devres. On driver detach, release function is invoked
159 * on the devres data, then, devres data is freed.
161 * For use by USB host and peripheral drivers.
163 struct usb_phy *devm_usb_get_phy_by_phandle(struct device *dev,
164 const char *phandle, u8 index)
166 struct usb_phy *phy = ERR_PTR(-ENOMEM), **ptr;
168 struct device_node *node;
171 dev_dbg(dev, "device does not have a device node entry\n");
172 return ERR_PTR(-EINVAL);
175 node = of_parse_phandle(dev->of_node, phandle, index);
177 dev_dbg(dev, "failed to get %s phandle in %s node\n", phandle,
178 dev->of_node->full_name);
179 return ERR_PTR(-ENODEV);
182 ptr = devres_alloc(devm_usb_phy_release, sizeof(*ptr), GFP_KERNEL);
184 dev_dbg(dev, "failed to allocate memory for devres\n");
188 spin_lock_irqsave(&phy_lock, flags);
190 phy = __of_usb_find_phy(node);
191 if (IS_ERR(phy) || !try_module_get(phy->dev->driver->owner)) {
192 phy = ERR_PTR(-EPROBE_DEFER);
198 devres_add(dev, ptr);
200 get_device(phy->dev);
203 spin_unlock_irqrestore(&phy_lock, flags);
210 EXPORT_SYMBOL(devm_usb_get_phy_by_phandle);
213 * usb_get_phy_dev - find the USB PHY
214 * @dev - device that requests this phy
215 * @index - the index of the phy
217 * Returns the phy driver, after getting a refcount to it; or
218 * -ENODEV if there is no such phy. The caller is responsible for
219 * calling usb_put_phy() to release that count.
221 * For use by USB host and peripheral drivers.
223 struct usb_phy *usb_get_phy_dev(struct device *dev, u8 index)
225 struct usb_phy *phy = NULL;
228 spin_lock_irqsave(&phy_lock, flags);
230 phy = __usb_find_phy_dev(dev, &phy_bind_list, index);
232 pr_err("unable to find transceiver\n");
236 get_device(phy->dev);
239 spin_unlock_irqrestore(&phy_lock, flags);
243 EXPORT_SYMBOL(usb_get_phy_dev);
246 * devm_usb_get_phy_dev - find the USB PHY using device ptr and index
247 * @dev - device that requests this phy
248 * @index - the index of the phy
250 * Gets the phy using usb_get_phy_dev(), and associates a device with it using
251 * devres. On driver detach, release function is invoked on the devres data,
252 * then, devres data is freed.
254 * For use by USB host and peripheral drivers.
256 struct usb_phy *devm_usb_get_phy_dev(struct device *dev, u8 index)
258 struct usb_phy **ptr, *phy;
260 ptr = devres_alloc(devm_usb_phy_release, sizeof(*ptr), GFP_KERNEL);
264 phy = usb_get_phy_dev(dev, index);
267 devres_add(dev, ptr);
273 EXPORT_SYMBOL(devm_usb_get_phy_dev);
276 * devm_usb_put_phy - release the USB PHY
277 * @dev - device that wants to release this phy
278 * @phy - the phy returned by devm_usb_get_phy()
280 * destroys the devres associated with this phy and invokes usb_put_phy
281 * to release the phy.
283 * For use by USB host and peripheral drivers.
285 void devm_usb_put_phy(struct device *dev, struct usb_phy *phy)
289 r = devres_destroy(dev, devm_usb_phy_release, devm_usb_phy_match, phy);
290 dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
292 EXPORT_SYMBOL(devm_usb_put_phy);
295 * usb_put_phy - release the USB PHY
296 * @x: the phy returned by usb_get_phy()
298 * Releases a refcount the caller received from usb_get_phy().
300 * For use by USB host and peripheral drivers.
302 void usb_put_phy(struct usb_phy *x)
307 EXPORT_SYMBOL(usb_put_phy);
310 * usb_add_phy - declare the USB PHY
311 * @x: the USB phy to be used; or NULL
312 * @type - the type of this PHY
314 * This call is exclusively for use by phy drivers, which
315 * coordinate the activities of drivers for host and peripheral
316 * controllers, and in some cases for VBUS current regulation.
318 int usb_add_phy(struct usb_phy *x, enum usb_phy_type type)
324 if (x->type != USB_PHY_TYPE_UNDEFINED) {
325 dev_err(x->dev, "not accepting initialized PHY %s\n", x->label);
329 spin_lock_irqsave(&phy_lock, flags);
331 list_for_each_entry(phy, &phy_list, head) {
332 if (phy->type == type) {
334 dev_err(x->dev, "transceiver type %s already exists\n",
335 usb_phy_type_string(type));
341 list_add_tail(&x->head, &phy_list);
344 spin_unlock_irqrestore(&phy_lock, flags);
347 EXPORT_SYMBOL(usb_add_phy);
350 * usb_add_phy_dev - declare the USB PHY
351 * @x: the USB phy to be used; or NULL
353 * This call is exclusively for use by phy drivers, which
354 * coordinate the activities of drivers for host and peripheral
355 * controllers, and in some cases for VBUS current regulation.
357 int usb_add_phy_dev(struct usb_phy *x)
359 struct usb_phy_bind *phy_bind;
363 dev_err(x->dev, "no device provided for PHY\n");
367 spin_lock_irqsave(&phy_lock, flags);
368 list_for_each_entry(phy_bind, &phy_bind_list, list)
369 if (!(strcmp(phy_bind->phy_dev_name, dev_name(x->dev))))
372 list_add_tail(&x->head, &phy_list);
374 spin_unlock_irqrestore(&phy_lock, flags);
377 EXPORT_SYMBOL(usb_add_phy_dev);
380 * usb_remove_phy - remove the OTG PHY
381 * @x: the USB OTG PHY to be removed;
383 * This reverts the effects of usb_add_phy
385 void usb_remove_phy(struct usb_phy *x)
388 struct usb_phy_bind *phy_bind;
390 spin_lock_irqsave(&phy_lock, flags);
392 list_for_each_entry(phy_bind, &phy_bind_list, list)
393 if (phy_bind->phy == x)
394 phy_bind->phy = NULL;
397 spin_unlock_irqrestore(&phy_lock, flags);
399 EXPORT_SYMBOL(usb_remove_phy);
402 * usb_bind_phy - bind the phy and the controller that uses the phy
403 * @dev_name: the device name of the device that will bind to the phy
404 * @index: index to specify the port number
405 * @phy_dev_name: the device name of the phy
407 * Fills the phy_bind structure with the dev_name and phy_dev_name. This will
408 * be used when the phy driver registers the phy and when the controller
411 * To be used by platform specific initialization code.
413 int __init usb_bind_phy(const char *dev_name, u8 index,
414 const char *phy_dev_name)
416 struct usb_phy_bind *phy_bind;
419 phy_bind = kzalloc(sizeof(*phy_bind), GFP_KERNEL);
421 pr_err("phy_bind(): No memory for phy_bind");
425 phy_bind->dev_name = dev_name;
426 phy_bind->phy_dev_name = phy_dev_name;
427 phy_bind->index = index;
429 spin_lock_irqsave(&phy_lock, flags);
430 list_add_tail(&phy_bind->list, &phy_bind_list);
431 spin_unlock_irqrestore(&phy_lock, flags);
435 EXPORT_SYMBOL_GPL(usb_bind_phy);
437 const char *otg_state_string(enum usb_otg_state state)
440 case OTG_STATE_A_IDLE:
442 case OTG_STATE_A_WAIT_VRISE:
443 return "a_wait_vrise";
444 case OTG_STATE_A_WAIT_BCON:
445 return "a_wait_bcon";
446 case OTG_STATE_A_HOST:
448 case OTG_STATE_A_SUSPEND:
450 case OTG_STATE_A_PERIPHERAL:
451 return "a_peripheral";
452 case OTG_STATE_A_WAIT_VFALL:
453 return "a_wait_vfall";
454 case OTG_STATE_A_VBUS_ERR:
456 case OTG_STATE_B_IDLE:
458 case OTG_STATE_B_SRP_INIT:
460 case OTG_STATE_B_PERIPHERAL:
461 return "b_peripheral";
462 case OTG_STATE_B_WAIT_ACON:
463 return "b_wait_acon";
464 case OTG_STATE_B_HOST:
470 EXPORT_SYMBOL(otg_state_string);