drivers/usb/phy/phy.c

   1 /*
   2  * phy.c -- USB phy handling
   3  *
   4  * Copyright (C) 2004-2013 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 #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>
  17 #include <linux/of.h>
  18
  19 #include <linux/usb/phy.h>
  20
  21 static LIST_HEAD(phy_list);
  22 static LIST_HEAD(phy_bind_list);
  23 static DEFINE_SPINLOCK(phy_lock);
  24
  25 static struct usb_phy *__usb_find_phy(struct list_head *list,
  26         enum usb_phy_type type)
  27 {
  28         struct usb_phy  *phy = NULL;
  29
  30         list_for_each_entry(phy, list, head) {
  31                 if (phy->type != type)
  32                         continue;
  33
  34                 return phy;
  35         }
  36
  37         return ERR_PTR(-ENODEV);
  38 }
  39
  40 static struct usb_phy *__usb_find_phy_dev(struct device *dev,
  41         struct list_head *list, u8 index)
  42 {
  43         struct usb_phy_bind *phy_bind = NULL;
  44
  45         list_for_each_entry(phy_bind, list, list) {
  46                 if (!(strcmp(phy_bind->dev_name, dev_name(dev))) &&
  47                                 phy_bind->index == index) {
  48                         if (phy_bind->phy)
  49                                 return phy_bind->phy;
  50                         else
  51                                 return ERR_PTR(-EPROBE_DEFER);
  52                 }
  53         }
  54
  55         return ERR_PTR(-ENODEV);
  56 }
  57
  58 static struct usb_phy *__of_usb_find_phy(struct device_node *node)
  59 {
  60         struct usb_phy  *phy;
  61
  62         list_for_each_entry(phy, &phy_list, head) {
  63                 if (node != phy->dev->of_node)
  64                         continue;
  65
  66                 return phy;
  67         }
  68
  69         return ERR_PTR(-ENODEV);
  70 }
  71
  72 static void devm_usb_phy_release(struct device *dev, void *res)
  73 {
  74         struct usb_phy *phy = *(struct usb_phy **)res;
  75
  76         usb_put_phy(phy);
  77 }
  78
  79 static int devm_usb_phy_match(struct device *dev, void *res, void *match_data)
  80 {
  81         return res == match_data;
  82 }
  83
  84 /**
  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
  88  *
  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.
  92  *
  93  * For use by USB host and peripheral drivers.
  94  */
  95 struct usb_phy *devm_usb_get_phy(struct device *dev, enum usb_phy_type type)
  96 {
  97         struct usb_phy **ptr, *phy;
  98
  99         ptr = devres_alloc(devm_usb_phy_release, sizeof(*ptr), GFP_KERNEL);
 100         if (!ptr)
 101                 return NULL;
 102
 103         phy = usb_get_phy(type);
 104         if (!IS_ERR(phy)) {
 105                 *ptr = phy;
 106                 devres_add(dev, ptr);
 107         } else
 108                 devres_free(ptr);
 109
 110         return phy;
 111 }
 112 EXPORT_SYMBOL_GPL(devm_usb_get_phy);
 113
 114 /**
 115  * usb_get_phy - find the USB PHY
 116  * @type - the type of the phy the controller requires
 117  *
 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.
 121  *
 122  * For use by USB host and peripheral drivers.
 123  */
 124 struct usb_phy *usb_get_phy(enum usb_phy_type type)
 125 {
 126         struct usb_phy  *phy = NULL;
 127         unsigned long   flags;
 128
 129         spin_lock_irqsave(&phy_lock, flags);
 130
 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));
 135                 goto err0;
 136         }
 137
 138         get_device(phy->dev);
 139
 140 err0:
 141         spin_unlock_irqrestore(&phy_lock, flags);
 142
 143         return phy;
 144 }
 145 EXPORT_SYMBOL_GPL(usb_get_phy);
 146
 147  /**
 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
 152  *
 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.
 159  *
 160  * For use by USB host and peripheral drivers.
 161  */
 162 struct usb_phy *devm_usb_get_phy_by_phandle(struct device *dev,
 163         const char *phandle, u8 index)
 164 {
 165         struct usb_phy  *phy = ERR_PTR(-ENOMEM), **ptr;
 166         unsigned long   flags;
 167         struct device_node *node;
 168
 169         if (!dev->of_node) {
 170                 dev_dbg(dev, "device does not have a device node entry\n");
 171                 return ERR_PTR(-EINVAL);
 172         }
 173
 174         node = of_parse_phandle(dev->of_node, phandle, index);
 175         if (!node) {
 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);
 179         }
 180
 181         ptr = devres_alloc(devm_usb_phy_release, sizeof(*ptr), GFP_KERNEL);
 182         if (!ptr) {
 183                 dev_dbg(dev, "failed to allocate memory for devres\n");
 184                 goto err0;
 185         }
 186
 187         spin_lock_irqsave(&phy_lock, flags);
 188
 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);
 192                 devres_free(ptr);
 193                 goto err1;
 194         }
 195
 196         *ptr = phy;
 197         devres_add(dev, ptr);
 198
 199         get_device(phy->dev);
 200
 201 err1:
 202         spin_unlock_irqrestore(&phy_lock, flags);
 203
 204 err0:
 205         of_node_put(node);
 206
 207         return phy;
 208 }
 209 EXPORT_SYMBOL_GPL(devm_usb_get_phy_by_phandle);
 210
 211 /**
 212  * usb_get_phy_dev - find the USB PHY
 213  * @dev - device that requests this phy
 214  * @index - the index of the phy
 215  *
 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.
 219  *
 220  * For use by USB host and peripheral drivers.
 221  */
 222 struct usb_phy *usb_get_phy_dev(struct device *dev, u8 index)
 223 {
 224         struct usb_phy  *phy = NULL;
 225         unsigned long   flags;
 226
 227         spin_lock_irqsave(&phy_lock, flags);
 228
 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");
 232                 goto err0;
 233         }
 234
 235         get_device(phy->dev);
 236
 237 err0:
 238         spin_unlock_irqrestore(&phy_lock, flags);
 239
 240         return phy;
 241 }
 242 EXPORT_SYMBOL_GPL(usb_get_phy_dev);
 243
 244 /**
 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
 248  *
 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.
 252  *
 253  * For use by USB host and peripheral drivers.
 254  */
 255 struct usb_phy *devm_usb_get_phy_dev(struct device *dev, u8 index)
 256 {
 257         struct usb_phy **ptr, *phy;
 258
 259         ptr = devres_alloc(devm_usb_phy_release, sizeof(*ptr), GFP_KERNEL);
 260         if (!ptr)
 261                 return NULL;
 262
 263         phy = usb_get_phy_dev(dev, index);
 264         if (!IS_ERR(phy)) {
 265                 *ptr = phy;
 266                 devres_add(dev, ptr);
 267         } else
 268                 devres_free(ptr);
 269
 270         return phy;
 271 }
 272 EXPORT_SYMBOL_GPL(devm_usb_get_phy_dev);
 273
 274 /**
 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()
 278  *
 279  * destroys the devres associated with this phy and invokes usb_put_phy
 280  * to release the phy.
 281  *
 282  * For use by USB host and peripheral drivers.
 283  */
 284 void devm_usb_put_phy(struct device *dev, struct usb_phy *phy)
 285 {
 286         int r;
 287
 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");
 290 }
 291 EXPORT_SYMBOL_GPL(devm_usb_put_phy);
 292
 293 /**
 294  * usb_put_phy - release the USB PHY
 295  * @x: the phy returned by usb_get_phy()
 296  *
 297  * Releases a refcount the caller received from usb_get_phy().
 298  *
 299  * For use by USB host and peripheral drivers.
 300  */
 301 void usb_put_phy(struct usb_phy *x)
 302 {
 303         if (x) {
 304                 struct module *owner = x->dev->driver->owner;
 305
 306                 put_device(x->dev);
 307                 module_put(owner);
 308         }
 309 }
 310 EXPORT_SYMBOL_GPL(usb_put_phy);
 311
 312 /**
 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
 316  *
 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.
 320  */
 321 int usb_add_phy(struct usb_phy *x, enum usb_phy_type type)
 322 {
 323         int             ret = 0;
 324         unsigned long   flags;
 325         struct usb_phy  *phy;
 326
 327         if (x->type != USB_PHY_TYPE_UNDEFINED) {
 328                 dev_err(x->dev, "not accepting initialized PHY %s\n", x->label);
 329                 return -EINVAL;
 330         }
 331
 332         spin_lock_irqsave(&phy_lock, flags);
 333
 334         list_for_each_entry(phy, &phy_list, head) {
 335                 if (phy->type == type) {
 336                         ret = -EBUSY;
 337                         dev_err(x->dev, "transceiver type %s already exists\n",
 338                                                 usb_phy_type_string(type));
 339                         goto out;
 340                 }
 341         }
 342
 343         x->type = type;
 344         list_add_tail(&x->head, &phy_list);
 345
 346 out:
 347         spin_unlock_irqrestore(&phy_lock, flags);
 348         return ret;
 349 }
 350 EXPORT_SYMBOL_GPL(usb_add_phy);
 351
 352 /**
 353  * usb_add_phy_dev - declare the USB PHY
 354  * @x: the USB phy to be used; or NULL
 355  *
 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.
 359  */
 360 int usb_add_phy_dev(struct usb_phy *x)
 361 {
 362         struct usb_phy_bind *phy_bind;
 363         unsigned long flags;
 364
 365         if (!x->dev) {
 366                 dev_err(x->dev, "no device provided for PHY\n");
 367                 return -EINVAL;
 368         }
 369
 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))))
 373                         phy_bind->phy = x;
 374
 375         list_add_tail(&x->head, &phy_list);
 376
 377         spin_unlock_irqrestore(&phy_lock, flags);
 378         return 0;
 379 }
 380 EXPORT_SYMBOL_GPL(usb_add_phy_dev);
 381
 382 /**
 383  * usb_remove_phy - remove the OTG PHY
 384  * @x: the USB OTG PHY to be removed;
 385  *
 386  * This reverts the effects of usb_add_phy
 387  */
 388 void usb_remove_phy(struct usb_phy *x)
 389 {
 390         unsigned long   flags;
 391         struct usb_phy_bind *phy_bind;
 392
 393         spin_lock_irqsave(&phy_lock, flags);
 394         if (x) {
 395                 list_for_each_entry(phy_bind, &phy_bind_list, list)
 396                         if (phy_bind->phy == x)
 397                                 phy_bind->phy = NULL;
 398                 list_del(&x->head);
 399         }
 400         spin_unlock_irqrestore(&phy_lock, flags);
 401 }
 402 EXPORT_SYMBOL_GPL(usb_remove_phy);
 403
 404 /**
 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
 409  *
 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
 412  * requests this phy.
 413  *
 414  * To be used by platform specific initialization code.
 415  */
 416 int usb_bind_phy(const char *dev_name, u8 index,
 417                                 const char *phy_dev_name)
 418 {
 419         struct usb_phy_bind *phy_bind;
 420         unsigned long flags;
 421
 422         phy_bind = kzalloc(sizeof(*phy_bind), GFP_KERNEL);
 423         if (!phy_bind) {
 424                 pr_err("phy_bind(): No memory for phy_bind");
 425                 return -ENOMEM;
 426         }
 427
 428         phy_bind->dev_name = dev_name;
 429         phy_bind->phy_dev_name = phy_dev_name;
 430         phy_bind->index = index;
 431
 432         spin_lock_irqsave(&phy_lock, flags);
 433         list_add_tail(&phy_bind->list, &phy_bind_list);
 434         spin_unlock_irqrestore(&phy_lock, flags);
 435
 436         return 0;
 437 }
 438 EXPORT_SYMBOL_GPL(usb_bind_phy);