drivers/usb/otg/otg.c

   1 /*
   2  * otg.c -- USB OTG utility code
   3  *
   4  * Copyright (C) 2004 Texas Instruments
   5  *
   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.
  10  */
  11
  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>
  18 #include <linux/of.h>
  19
  20 #include <linux/usb/otg.h>
  21
  22 static LIST_HEAD(phy_list);
  23 static LIST_HEAD(phy_bind_list);
  24 static DEFINE_SPINLOCK(phy_lock);
  25
  26 static struct usb_phy *__usb_find_phy(struct list_head *list,
  27         enum usb_phy_type type)
  28 {
  29         struct usb_phy  *phy = NULL;
  30
  31         list_for_each_entry(phy, list, head) {
  32                 if (phy->type != type)
  33                         continue;
  34
  35                 return phy;
  36         }
  37
  38         return ERR_PTR(-ENODEV);
  39 }
  40
  41 static struct usb_phy *__usb_find_phy_dev(struct device *dev,
  42         struct list_head *list, u8 index)
  43 {
  44         struct usb_phy_bind *phy_bind = NULL;
  45
  46         list_for_each_entry(phy_bind, list, list) {
  47                 if (!(strcmp(phy_bind->dev_name, dev_name(dev))) &&
  48                                 phy_bind->index == index) {
  49                         if (phy_bind->phy)
  50                                 return phy_bind->phy;
  51                         else
  52                                 return ERR_PTR(-EPROBE_DEFER);
  53                 }
  54         }
  55
  56         return ERR_PTR(-ENODEV);
  57 }
  58
  59 static struct usb_phy *__of_usb_find_phy(struct device_node *node)
  60 {
  61         struct usb_phy  *phy;
  62
  63         list_for_each_entry(phy, &phy_list, head) {
  64                 if (node != phy->dev->of_node)
  65                         continue;
  66
  67                 return phy;
  68         }
  69
  70         return ERR_PTR(-ENODEV);
  71 }
  72
  73 static void devm_usb_phy_release(struct device *dev, void *res)
  74 {
  75         struct usb_phy *phy = *(struct usb_phy **)res;
  76
  77         usb_put_phy(phy);
  78 }
  79
  80 static int devm_usb_phy_match(struct device *dev, void *res, void *match_data)
  81 {
  82         return res == match_data;
  83 }
  84
  85 /**
  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
  89  *
  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.
  93  *
  94  * For use by USB host and peripheral drivers.
  95  */
  96 struct usb_phy *devm_usb_get_phy(struct device *dev, enum usb_phy_type type)
  97 {
  98         struct usb_phy **ptr, *phy;
  99
 100         ptr = devres_alloc(devm_usb_phy_release, sizeof(*ptr), GFP_KERNEL);
 101         if (!ptr)
 102                 return NULL;
 103
 104         phy = usb_get_phy(type);
 105         if (!IS_ERR(phy)) {
 106                 *ptr = phy;
 107                 devres_add(dev, ptr);
 108         } else
 109                 devres_free(ptr);
 110
 111         return phy;
 112 }
 113 EXPORT_SYMBOL(devm_usb_get_phy);
 114
 115 /**
 116  * usb_get_phy - find the USB PHY
 117  * @type - the type of the phy the controller requires
 118  *
 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.
 122  *
 123  * For use by USB host and peripheral drivers.
 124  */
 125 struct usb_phy *usb_get_phy(enum usb_phy_type type)
 126 {
 127         struct usb_phy  *phy = NULL;
 128         unsigned long   flags;
 129
 130         spin_lock_irqsave(&phy_lock, flags);
 131
 132         phy = __usb_find_phy(&phy_list, type);
 133         if (IS_ERR(phy) || !try_module_get(phy->dev->driver->owner)) {
 134                 pr_err("unable to find transceiver of type %s\n",
 135                         usb_phy_type_string(type));
 136                 goto err0;
 137         }
 138
 139         get_device(phy->dev);
 140
 141 err0:
 142         spin_unlock_irqrestore(&phy_lock, flags);
 143
 144         return phy;
 145 }
 146 EXPORT_SYMBOL(usb_get_phy);
 147
 148  /**
 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
 153  *
 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.
 160  *
 161  * For use by USB host and peripheral drivers.
 162  */
 163 struct usb_phy *devm_usb_get_phy_by_phandle(struct device *dev,
 164         const char *phandle, u8 index)
 165 {
 166         struct usb_phy  *phy = ERR_PTR(-ENOMEM), **ptr;
 167         unsigned long   flags;
 168         struct device_node *node;
 169
 170         if (!dev->of_node) {
 171                 dev_dbg(dev, "device does not have a device node entry\n");
 172                 return ERR_PTR(-EINVAL);
 173         }
 174
 175         node = of_parse_phandle(dev->of_node, phandle, index);
 176         if (!node) {
 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);
 180         }
 181
 182         ptr = devres_alloc(devm_usb_phy_release, sizeof(*ptr), GFP_KERNEL);
 183         if (!ptr) {
 184                 dev_dbg(dev, "failed to allocate memory for devres\n");
 185                 goto err0;
 186         }
 187
 188         spin_lock_irqsave(&phy_lock, flags);
 189
 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);
 193                 devres_free(ptr);
 194                 goto err1;
 195         }
 196
 197         *ptr = phy;
 198         devres_add(dev, ptr);
 199
 200         get_device(phy->dev);
 201
 202 err1:
 203         spin_unlock_irqrestore(&phy_lock, flags);
 204
 205 err0:
 206         of_node_put(node);
 207
 208         return phy;
 209 }
 210 EXPORT_SYMBOL(devm_usb_get_phy_by_phandle);
 211
 212 /**
 213  * usb_get_phy_dev - find the USB PHY
 214  * @dev - device that requests this phy
 215  * @index - the index of the phy
 216  *
 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.
 220  *
 221  * For use by USB host and peripheral drivers.
 222  */
 223 struct usb_phy *usb_get_phy_dev(struct device *dev, u8 index)
 224 {
 225         struct usb_phy  *phy = NULL;
 226         unsigned long   flags;
 227
 228         spin_lock_irqsave(&phy_lock, flags);
 229
 230         phy = __usb_find_phy_dev(dev, &phy_bind_list, index);
 231         if (IS_ERR(phy) || !try_module_get(phy->dev->driver->owner)) {
 232                 pr_err("unable to find transceiver\n");
 233                 goto err0;
 234         }
 235
 236         get_device(phy->dev);
 237
 238 err0:
 239         spin_unlock_irqrestore(&phy_lock, flags);
 240
 241         return phy;
 242 }
 243 EXPORT_SYMBOL(usb_get_phy_dev);
 244
 245 /**
 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
 249  *
 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.
 253  *
 254  * For use by USB host and peripheral drivers.
 255  */
 256 struct usb_phy *devm_usb_get_phy_dev(struct device *dev, u8 index)
 257 {
 258         struct usb_phy **ptr, *phy;
 259
 260         ptr = devres_alloc(devm_usb_phy_release, sizeof(*ptr), GFP_KERNEL);
 261         if (!ptr)
 262                 return NULL;
 263
 264         phy = usb_get_phy_dev(dev, index);
 265         if (!IS_ERR(phy)) {
 266                 *ptr = phy;
 267                 devres_add(dev, ptr);
 268         } else
 269                 devres_free(ptr);
 270
 271         return phy;
 272 }
 273 EXPORT_SYMBOL(devm_usb_get_phy_dev);
 274
 275 /**
 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()
 279  *
 280  * destroys the devres associated with this phy and invokes usb_put_phy
 281  * to release the phy.
 282  *
 283  * For use by USB host and peripheral drivers.
 284  */
 285 void devm_usb_put_phy(struct device *dev, struct usb_phy *phy)
 286 {
 287         int r;
 288
 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");
 291 }
 292 EXPORT_SYMBOL(devm_usb_put_phy);
 293
 294 /**
 295  * usb_put_phy - release the USB PHY
 296  * @x: the phy returned by usb_get_phy()
 297  *
 298  * Releases a refcount the caller received from usb_get_phy().
 299  *
 300  * For use by USB host and peripheral drivers.
 301  */
 302 void usb_put_phy(struct usb_phy *x)
 303 {
 304         if (x) {
 305                 struct module *owner = x->dev->driver->owner;
 306
 307                 put_device(x->dev);
 308                 module_put(owner);
 309         }
 310 }
 311 EXPORT_SYMBOL(usb_put_phy);
 312
 313 /**
 314  * usb_add_phy - declare the USB PHY
 315  * @x: the USB phy to be used; or NULL
 316  * @type - the type of this PHY
 317  *
 318  * This call is exclusively for use by phy drivers, which
 319  * coordinate the activities of drivers for host and peripheral
 320  * controllers, and in some cases for VBUS current regulation.
 321  */
 322 int usb_add_phy(struct usb_phy *x, enum usb_phy_type type)
 323 {
 324         int             ret = 0;
 325         unsigned long   flags;
 326         struct usb_phy  *phy;
 327
 328         if (x->type != USB_PHY_TYPE_UNDEFINED) {
 329                 dev_err(x->dev, "not accepting initialized PHY %s\n", x->label);
 330                 return -EINVAL;
 331         }
 332
 333         spin_lock_irqsave(&phy_lock, flags);
 334
 335         list_for_each_entry(phy, &phy_list, head) {
 336                 if (phy->type == type) {
 337                         ret = -EBUSY;
 338                         dev_err(x->dev, "transceiver type %s already exists\n",
 339                                                 usb_phy_type_string(type));
 340                         goto out;
 341                 }
 342         }
 343
 344         x->type = type;
 345         list_add_tail(&x->head, &phy_list);
 346
 347 out:
 348         spin_unlock_irqrestore(&phy_lock, flags);
 349         return ret;
 350 }
 351 EXPORT_SYMBOL(usb_add_phy);
 352
 353 /**
 354  * usb_add_phy_dev - declare the USB PHY
 355  * @x: the USB phy to be used; or NULL
 356  *
 357  * This call is exclusively for use by phy drivers, which
 358  * coordinate the activities of drivers for host and peripheral
 359  * controllers, and in some cases for VBUS current regulation.
 360  */
 361 int usb_add_phy_dev(struct usb_phy *x)
 362 {
 363         struct usb_phy_bind *phy_bind;
 364         unsigned long flags;
 365
 366         if (!x->dev) {
 367                 dev_err(x->dev, "no device provided for PHY\n");
 368                 return -EINVAL;
 369         }
 370
 371         spin_lock_irqsave(&phy_lock, flags);
 372         list_for_each_entry(phy_bind, &phy_bind_list, list)
 373                 if (!(strcmp(phy_bind->phy_dev_name, dev_name(x->dev))))
 374                         phy_bind->phy = x;
 375
 376         list_add_tail(&x->head, &phy_list);
 377
 378         spin_unlock_irqrestore(&phy_lock, flags);
 379         return 0;
 380 }
 381 EXPORT_SYMBOL(usb_add_phy_dev);
 382
 383 /**
 384  * usb_remove_phy - remove the OTG PHY
 385  * @x: the USB OTG PHY to be removed;
 386  *
 387  * This reverts the effects of usb_add_phy
 388  */
 389 void usb_remove_phy(struct usb_phy *x)
 390 {
 391         unsigned long   flags;
 392         struct usb_phy_bind *phy_bind;
 393
 394         spin_lock_irqsave(&phy_lock, flags);
 395         if (x) {
 396                 list_for_each_entry(phy_bind, &phy_bind_list, list)
 397                         if (phy_bind->phy == x)
 398                                 phy_bind->phy = NULL;
 399                 list_del(&x->head);
 400         }
 401         spin_unlock_irqrestore(&phy_lock, flags);
 402 }
 403 EXPORT_SYMBOL(usb_remove_phy);
 404
 405 /**
 406  * usb_bind_phy - bind the phy and the controller that uses the phy
 407  * @dev_name: the device name of the device that will bind to the phy
 408  * @index: index to specify the port number
 409  * @phy_dev_name: the device name of the phy
 410  *
 411  * Fills the phy_bind structure with the dev_name and phy_dev_name. This will
 412  * be used when the phy driver registers the phy and when the controller
 413  * requests this phy.
 414  *
 415  * To be used by platform specific initialization code.
 416  */
 417 int __init usb_bind_phy(const char *dev_name, u8 index,
 418                                 const char *phy_dev_name)
 419 {
 420         struct usb_phy_bind *phy_bind;
 421         unsigned long flags;
 422
 423         phy_bind = kzalloc(sizeof(*phy_bind), GFP_KERNEL);
 424         if (!phy_bind) {
 425                 pr_err("phy_bind(): No memory for phy_bind");
 426                 return -ENOMEM;
 427         }
 428
 429         phy_bind->dev_name = dev_name;
 430         phy_bind->phy_dev_name = phy_dev_name;
 431         phy_bind->index = index;
 432
 433         spin_lock_irqsave(&phy_lock, flags);
 434         list_add_tail(&phy_bind->list, &phy_bind_list);
 435         spin_unlock_irqrestore(&phy_lock, flags);
 436
 437         return 0;
 438 }
 439 EXPORT_SYMBOL_GPL(usb_bind_phy);
 440
 441 const char *otg_state_string(enum usb_otg_state state)
 442 {
 443         switch (state) {
 444         case OTG_STATE_A_IDLE:
 445                 return "a_idle";
 446         case OTG_STATE_A_WAIT_VRISE:
 447                 return "a_wait_vrise";
 448         case OTG_STATE_A_WAIT_BCON:
 449                 return "a_wait_bcon";
 450         case OTG_STATE_A_HOST:
 451                 return "a_host";
 452         case OTG_STATE_A_SUSPEND:
 453                 return "a_suspend";
 454         case OTG_STATE_A_PERIPHERAL:
 455                 return "a_peripheral";
 456         case OTG_STATE_A_WAIT_VFALL:
 457                 return "a_wait_vfall";
 458         case OTG_STATE_A_VBUS_ERR:
 459                 return "a_vbus_err";
 460         case OTG_STATE_B_IDLE:
 461                 return "b_idle";
 462         case OTG_STATE_B_SRP_INIT:
 463                 return "b_srp_init";
 464         case OTG_STATE_B_PERIPHERAL:
 465                 return "b_peripheral";
 466         case OTG_STATE_B_WAIT_ACON:
 467                 return "b_wait_acon";
 468         case OTG_STATE_B_HOST:
 469                 return "b_host";
 470         default:
 471                 return "UNDEFINED";
 472         }
 473 }
 474 EXPORT_SYMBOL(otg_state_string);