drivers/usb/gadget/udc/udc-core.c

   1 /**
   2  * udc.c - Core UDC Framework
   3  *
   4  * Copyright (C) 2010 Texas Instruments
   5  * Author: Felipe Balbi <balbi@ti.com>
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License version 2  of
   9  * the License as published by the Free Software Foundation.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <linux/kernel.h>
  21 #include <linux/module.h>
  22 #include <linux/device.h>
  23 #include <linux/list.h>
  24 #include <linux/err.h>
  25 #include <linux/dma-mapping.h>
  26 #include <linux/workqueue.h>
  27
  28 #include <linux/usb/ch9.h>
  29 #include <linux/usb/gadget.h>
  30 #include <linux/usb.h>
  31
  32 /**
  33  * struct usb_udc - describes one usb device controller
  34  * @driver - the gadget driver pointer. For use by the class code
  35  * @dev - the child device to the actual controller
  36  * @gadget - the gadget. For use by the class code
  37  * @list - for use by the udc class driver
  38  * @vbus - for udcs who care about vbus status, this value is real vbus status;
  39  * for udcs who do not care about vbus status, this value is always true
  40  *
  41  * This represents the internal data structure which is used by the UDC-class
  42  * to hold information about udc driver and gadget together.
  43  */
  44 struct usb_udc {
  45         struct usb_gadget_driver        *driver;
  46         struct usb_gadget               *gadget;
  47         struct device                   dev;
  48         struct list_head                list;
  49         bool                            vbus;
  50 };
  51
  52 static struct class *udc_class;
  53 static LIST_HEAD(udc_list);
  54 static DEFINE_MUTEX(udc_lock);
  55
  56 /* ------------------------------------------------------------------------- */
  57
  58 #ifdef  CONFIG_HAS_DMA
  59
  60 int usb_gadget_map_request(struct usb_gadget *gadget,
  61                 struct usb_request *req, int is_in)
  62 {
  63         struct device *dev = gadget->dev.parent;
  64
  65         if (req->length == 0)
  66                 return 0;
  67
  68         if (req->num_sgs) {
  69                 int     mapped;
  70
  71                 mapped = dma_map_sg(dev, req->sg, req->num_sgs,
  72                                 is_in ? DMA_TO_DEVICE : DMA_FROM_DEVICE);
  73                 if (mapped == 0) {
  74                         dev_err(&gadget->dev, "failed to map SGs\n");
  75                         return -EFAULT;
  76                 }
  77
  78                 req->num_mapped_sgs = mapped;
  79         } else {
  80                 req->dma = dma_map_single(dev, req->buf, req->length,
  81                                 is_in ? DMA_TO_DEVICE : DMA_FROM_DEVICE);
  82
  83                 if (dma_mapping_error(dev, req->dma)) {
  84                         dev_err(dev, "failed to map buffer\n");
  85                         return -EFAULT;
  86                 }
  87         }
  88
  89         return 0;
  90 }
  91 EXPORT_SYMBOL_GPL(usb_gadget_map_request);
  92
  93 void usb_gadget_unmap_request(struct usb_gadget *gadget,
  94                 struct usb_request *req, int is_in)
  95 {
  96         if (req->length == 0)
  97                 return;
  98
  99         if (req->num_mapped_sgs) {
 100                 dma_unmap_sg(gadget->dev.parent, req->sg, req->num_mapped_sgs,
 101                                 is_in ? DMA_TO_DEVICE : DMA_FROM_DEVICE);
 102
 103                 req->num_mapped_sgs = 0;
 104         } else {
 105                 dma_unmap_single(gadget->dev.parent, req->dma, req->length,
 106                                 is_in ? DMA_TO_DEVICE : DMA_FROM_DEVICE);
 107         }
 108 }
 109 EXPORT_SYMBOL_GPL(usb_gadget_unmap_request);
 110
 111 #endif  /* CONFIG_HAS_DMA */
 112
 113 /* ------------------------------------------------------------------------- */
 114
 115 /**
 116  * usb_gadget_giveback_request - give the request back to the gadget layer
 117  * Context: in_interrupt()
 118  *
 119  * This is called by device controller drivers in order to return the
 120  * completed request back to the gadget layer.
 121  */
 122 void usb_gadget_giveback_request(struct usb_ep *ep,
 123                 struct usb_request *req)
 124 {
 125         if (likely(req->status == 0))
 126                 usb_led_activity(USB_LED_EVENT_GADGET);
 127
 128         req->complete(ep, req);
 129 }
 130 EXPORT_SYMBOL_GPL(usb_gadget_giveback_request);
 131
 132 /* ------------------------------------------------------------------------- */
 133
 134 static void usb_gadget_state_work(struct work_struct *work)
 135 {
 136         struct usb_gadget *gadget = work_to_gadget(work);
 137         struct usb_udc *udc = gadget->udc;
 138
 139         if (udc)
 140                 sysfs_notify(&udc->dev.kobj, NULL, "state");
 141 }
 142
 143 void usb_gadget_set_state(struct usb_gadget *gadget,
 144                 enum usb_device_state state)
 145 {
 146         gadget->state = state;
 147         schedule_work(&gadget->work);
 148 }
 149 EXPORT_SYMBOL_GPL(usb_gadget_set_state);
 150
 151 /* ------------------------------------------------------------------------- */
 152
 153 static void usb_udc_connect_control(struct usb_udc *udc)
 154 {
 155         if (udc->vbus)
 156                 usb_gadget_connect(udc->gadget);
 157         else
 158                 usb_gadget_disconnect(udc->gadget);
 159 }
 160
 161 /**
 162  * usb_udc_vbus_handler - updates the udc core vbus status, and try to
 163  * connect or disconnect gadget
 164  * @gadget: The gadget which vbus change occurs
 165  * @status: The vbus status
 166  *
 167  * The udc driver calls it when it wants to connect or disconnect gadget
 168  * according to vbus status.
 169  */
 170 void usb_udc_vbus_handler(struct usb_gadget *gadget, bool status)
 171 {
 172         struct usb_udc *udc = gadget->udc;
 173
 174         if (udc) {
 175                 udc->vbus = status;
 176                 usb_udc_connect_control(udc);
 177         }
 178 }
 179 EXPORT_SYMBOL_GPL(usb_udc_vbus_handler);
 180
 181 /**
 182  * usb_gadget_udc_reset - notifies the udc core that bus reset occurs
 183  * @gadget: The gadget which bus reset occurs
 184  * @driver: The gadget driver we want to notify
 185  *
 186  * If the udc driver has bus reset handler, it needs to call this when the bus
 187  * reset occurs, it notifies the gadget driver that the bus reset occurs as
 188  * well as updates gadget state.
 189  */
 190 void usb_gadget_udc_reset(struct usb_gadget *gadget,
 191                 struct usb_gadget_driver *driver)
 192 {
 193         driver->reset(gadget);
 194         usb_gadget_set_state(gadget, USB_STATE_DEFAULT);
 195 }
 196 EXPORT_SYMBOL_GPL(usb_gadget_udc_reset);
 197
 198 /**
 199  * usb_gadget_udc_start - tells usb device controller to start up
 200  * @udc: The UDC to be started
 201  *
 202  * This call is issued by the UDC Class driver when it's about
 203  * to register a gadget driver to the device controller, before
 204  * calling gadget driver's bind() method.
 205  *
 206  * It allows the controller to be powered off until strictly
 207  * necessary to have it powered on.
 208  *
 209  * Returns zero on success, else negative errno.
 210  */
 211 static inline int usb_gadget_udc_start(struct usb_udc *udc)
 212 {
 213         return udc->gadget->ops->udc_start(udc->gadget, udc->driver);
 214 }
 215
 216 /**
 217  * usb_gadget_udc_stop - tells usb device controller we don't need it anymore
 218  * @gadget: The device we want to stop activity
 219  * @driver: The driver to unbind from @gadget
 220  *
 221  * This call is issued by the UDC Class driver after calling
 222  * gadget driver's unbind() method.
 223  *
 224  * The details are implementation specific, but it can go as
 225  * far as powering off UDC completely and disable its data
 226  * line pullups.
 227  */
 228 static inline void usb_gadget_udc_stop(struct usb_udc *udc)
 229 {
 230         udc->gadget->ops->udc_stop(udc->gadget);
 231 }
 232
 233 /**
 234  * usb_udc_release - release the usb_udc struct
 235  * @dev: the dev member within usb_udc
 236  *
 237  * This is called by driver's core in order to free memory once the last
 238  * reference is released.
 239  */
 240 static void usb_udc_release(struct device *dev)
 241 {
 242         struct usb_udc *udc;
 243
 244         udc = container_of(dev, struct usb_udc, dev);
 245         dev_dbg(dev, "releasing '%s'\n", dev_name(dev));
 246         kfree(udc);
 247 }
 248
 249 static const struct attribute_group *usb_udc_attr_groups[];
 250
 251 static void usb_udc_nop_release(struct device *dev)
 252 {
 253         dev_vdbg(dev, "%s\n", __func__);
 254 }
 255
 256 /**
 257  * usb_add_gadget_udc_release - adds a new gadget to the udc class driver list
 258  * @parent: the parent device to this udc. Usually the controller driver's
 259  * device.
 260  * @gadget: the gadget to be added to the list.
 261  * @release: a gadget release function.
 262  *
 263  * Returns zero on success, negative errno otherwise.
 264  */
 265 int usb_add_gadget_udc_release(struct device *parent, struct usb_gadget *gadget,
 266                 void (*release)(struct device *dev))
 267 {
 268         struct usb_udc          *udc;
 269         int                     ret = -ENOMEM;
 270
 271         udc = kzalloc(sizeof(*udc), GFP_KERNEL);
 272         if (!udc)
 273                 goto err1;
 274
 275         dev_set_name(&gadget->dev, "gadget");
 276         INIT_WORK(&gadget->work, usb_gadget_state_work);
 277         gadget->dev.parent = parent;
 278
 279 #ifdef  CONFIG_HAS_DMA
 280         dma_set_coherent_mask(&gadget->dev, parent->coherent_dma_mask);
 281         gadget->dev.dma_parms = parent->dma_parms;
 282         gadget->dev.dma_mask = parent->dma_mask;
 283 #endif
 284
 285         if (release)
 286                 gadget->dev.release = release;
 287         else
 288                 gadget->dev.release = usb_udc_nop_release;
 289
 290         ret = device_register(&gadget->dev);
 291         if (ret)
 292                 goto err2;
 293
 294         device_initialize(&udc->dev);
 295         udc->dev.release = usb_udc_release;
 296         udc->dev.class = udc_class;
 297         udc->dev.groups = usb_udc_attr_groups;
 298         udc->dev.parent = parent;
 299         ret = dev_set_name(&udc->dev, "%s", kobject_name(&parent->kobj));
 300         if (ret)
 301                 goto err3;
 302
 303         udc->gadget = gadget;
 304         gadget->udc = udc;
 305
 306         mutex_lock(&udc_lock);
 307         list_add_tail(&udc->list, &udc_list);
 308
 309         ret = device_add(&udc->dev);
 310         if (ret)
 311                 goto err4;
 312
 313         usb_gadget_set_state(gadget, USB_STATE_NOTATTACHED);
 314         udc->vbus = true;
 315
 316         mutex_unlock(&udc_lock);
 317
 318         return 0;
 319
 320 err4:
 321         list_del(&udc->list);
 322         mutex_unlock(&udc_lock);
 323
 324 err3:
 325         put_device(&udc->dev);
 326         device_del(&gadget->dev);
 327
 328 err2:
 329         put_device(&gadget->dev);
 330         kfree(udc);
 331
 332 err1:
 333         return ret;
 334 }
 335 EXPORT_SYMBOL_GPL(usb_add_gadget_udc_release);
 336
 337 /**
 338  * usb_add_gadget_udc - adds a new gadget to the udc class driver list
 339  * @parent: the parent device to this udc. Usually the controller
 340  * driver's device.
 341  * @gadget: the gadget to be added to the list
 342  *
 343  * Returns zero on success, negative errno otherwise.
 344  */
 345 int usb_add_gadget_udc(struct device *parent, struct usb_gadget *gadget)
 346 {
 347         return usb_add_gadget_udc_release(parent, gadget, NULL);
 348 }
 349 EXPORT_SYMBOL_GPL(usb_add_gadget_udc);
 350
 351 static void usb_gadget_remove_driver(struct usb_udc *udc)
 352 {
 353         dev_dbg(&udc->dev, "unregistering UDC driver [%s]\n",
 354                         udc->driver->function);
 355
 356         kobject_uevent(&udc->dev.kobj, KOBJ_CHANGE);
 357
 358         usb_gadget_disconnect(udc->gadget);
 359         udc->driver->disconnect(udc->gadget);
 360         udc->driver->unbind(udc->gadget);
 361         usb_gadget_udc_stop(udc);
 362
 363         udc->driver = NULL;
 364         udc->dev.driver = NULL;
 365         udc->gadget->dev.driver = NULL;
 366 }
 367
 368 /**
 369  * usb_del_gadget_udc - deletes @udc from udc_list
 370  * @gadget: the gadget to be removed.
 371  *
 372  * This, will call usb_gadget_unregister_driver() if
 373  * the @udc is still busy.
 374  */
 375 void usb_del_gadget_udc(struct usb_gadget *gadget)
 376 {
 377         struct usb_udc *udc = gadget->udc;
 378
 379         if (!udc)
 380                 return;
 381
 382         dev_vdbg(gadget->dev.parent, "unregistering gadget\n");
 383
 384         mutex_lock(&udc_lock);
 385         list_del(&udc->list);
 386         mutex_unlock(&udc_lock);
 387
 388         if (udc->driver)
 389                 usb_gadget_remove_driver(udc);
 390
 391         kobject_uevent(&udc->dev.kobj, KOBJ_REMOVE);
 392         flush_work(&gadget->work);
 393         device_unregister(&udc->dev);
 394         device_unregister(&gadget->dev);
 395 }
 396 EXPORT_SYMBOL_GPL(usb_del_gadget_udc);
 397
 398 /* ------------------------------------------------------------------------- */
 399
 400 static int udc_bind_to_driver(struct usb_udc *udc, struct usb_gadget_driver *driver)
 401 {
 402         int ret;
 403
 404         dev_dbg(&udc->dev, "registering UDC driver [%s]\n",
 405                         driver->function);
 406
 407         udc->driver = driver;
 408         udc->dev.driver = &driver->driver;
 409         udc->gadget->dev.driver = &driver->driver;
 410
 411         ret = driver->bind(udc->gadget, driver);
 412         if (ret)
 413                 goto err1;
 414         ret = usb_gadget_udc_start(udc);
 415         if (ret) {
 416                 driver->unbind(udc->gadget);
 417                 goto err1;
 418         }
 419         usb_udc_connect_control(udc);
 420
 421         kobject_uevent(&udc->dev.kobj, KOBJ_CHANGE);
 422         return 0;
 423 err1:
 424         if (ret != -EISNAM)
 425                 dev_err(&udc->dev, "failed to start %s: %d\n",
 426                         udc->driver->function, ret);
 427         udc->driver = NULL;
 428         udc->dev.driver = NULL;
 429         udc->gadget->dev.driver = NULL;
 430         return ret;
 431 }
 432
 433 int usb_udc_attach_driver(const char *name, struct usb_gadget_driver *driver)
 434 {
 435         struct usb_udc *udc = NULL;
 436         int ret = -ENODEV;
 437
 438         mutex_lock(&udc_lock);
 439         list_for_each_entry(udc, &udc_list, list) {
 440                 ret = strcmp(name, dev_name(&udc->dev));
 441                 if (!ret)
 442                         break;
 443         }
 444         if (ret) {
 445                 ret = -ENODEV;
 446                 goto out;
 447         }
 448         if (udc->driver) {
 449                 ret = -EBUSY;
 450                 goto out;
 451         }
 452         ret = udc_bind_to_driver(udc, driver);
 453 out:
 454         mutex_unlock(&udc_lock);
 455         return ret;
 456 }
 457 EXPORT_SYMBOL_GPL(usb_udc_attach_driver);
 458
 459 int usb_gadget_probe_driver(struct usb_gadget_driver *driver)
 460 {
 461         struct usb_udc          *udc = NULL;
 462         int                     ret;
 463
 464         if (!driver || !driver->bind || !driver->setup)
 465                 return -EINVAL;
 466
 467         mutex_lock(&udc_lock);
 468         list_for_each_entry(udc, &udc_list, list) {
 469                 /* For now we take the first one */
 470                 if (!udc->driver)
 471                         goto found;
 472         }
 473
 474         pr_debug("couldn't find an available UDC\n");
 475         mutex_unlock(&udc_lock);
 476         return -ENODEV;
 477 found:
 478         ret = udc_bind_to_driver(udc, driver);
 479         mutex_unlock(&udc_lock);
 480         return ret;
 481 }
 482 EXPORT_SYMBOL_GPL(usb_gadget_probe_driver);
 483
 484 int usb_gadget_unregister_driver(struct usb_gadget_driver *driver)
 485 {
 486         struct usb_udc          *udc = NULL;
 487         int                     ret = -ENODEV;
 488
 489         if (!driver || !driver->unbind)
 490                 return -EINVAL;
 491
 492         mutex_lock(&udc_lock);
 493         list_for_each_entry(udc, &udc_list, list)
 494                 if (udc->driver == driver) {
 495                         usb_gadget_remove_driver(udc);
 496                         usb_gadget_set_state(udc->gadget,
 497                                         USB_STATE_NOTATTACHED);
 498                         ret = 0;
 499                         break;
 500                 }
 501
 502         mutex_unlock(&udc_lock);
 503         return ret;
 504 }
 505 EXPORT_SYMBOL_GPL(usb_gadget_unregister_driver);
 506
 507 /* ------------------------------------------------------------------------- */
 508
 509 static ssize_t usb_udc_srp_store(struct device *dev,
 510                 struct device_attribute *attr, const char *buf, size_t n)
 511 {
 512         struct usb_udc          *udc = container_of(dev, struct usb_udc, dev);
 513
 514         if (sysfs_streq(buf, "1"))
 515                 usb_gadget_wakeup(udc->gadget);
 516
 517         return n;
 518 }
 519 static DEVICE_ATTR(srp, S_IWUSR, NULL, usb_udc_srp_store);
 520
 521 static ssize_t usb_udc_softconn_store(struct device *dev,
 522                 struct device_attribute *attr, const char *buf, size_t n)
 523 {
 524         struct usb_udc          *udc = container_of(dev, struct usb_udc, dev);
 525
 526         if (!udc->driver) {
 527                 dev_err(dev, "soft-connect without a gadget driver\n");
 528                 return -EOPNOTSUPP;
 529         }
 530
 531         if (sysfs_streq(buf, "connect")) {
 532                 usb_gadget_udc_start(udc);
 533                 usb_gadget_connect(udc->gadget);
 534         } else if (sysfs_streq(buf, "disconnect")) {
 535                 usb_gadget_disconnect(udc->gadget);
 536                 udc->driver->disconnect(udc->gadget);
 537                 usb_gadget_udc_stop(udc);
 538         } else {
 539                 dev_err(dev, "unsupported command '%s'\n", buf);
 540                 return -EINVAL;
 541         }
 542
 543         return n;
 544 }
 545 static DEVICE_ATTR(soft_connect, S_IWUSR, NULL, usb_udc_softconn_store);
 546
 547 static ssize_t state_show(struct device *dev, struct device_attribute *attr,
 548                           char *buf)
 549 {
 550         struct usb_udc          *udc = container_of(dev, struct usb_udc, dev);
 551         struct usb_gadget       *gadget = udc->gadget;
 552
 553         return sprintf(buf, "%s\n", usb_state_string(gadget->state));
 554 }
 555 static DEVICE_ATTR_RO(state);
 556
 557 #define USB_UDC_SPEED_ATTR(name, param)                                 \
 558 ssize_t name##_show(struct device *dev,                                 \
 559                 struct device_attribute *attr, char *buf)               \
 560 {                                                                       \
 561         struct usb_udc *udc = container_of(dev, struct usb_udc, dev);   \
 562         return snprintf(buf, PAGE_SIZE, "%s\n",                         \
 563                         usb_speed_string(udc->gadget->param));          \
 564 }                                                                       \
 565 static DEVICE_ATTR_RO(name)
 566
 567 static USB_UDC_SPEED_ATTR(current_speed, speed);
 568 static USB_UDC_SPEED_ATTR(maximum_speed, max_speed);
 569
 570 #define USB_UDC_ATTR(name)                                      \
 571 ssize_t name##_show(struct device *dev,                         \
 572                 struct device_attribute *attr, char *buf)       \
 573 {                                                               \
 574         struct usb_udc          *udc = container_of(dev, struct usb_udc, dev); \
 575         struct usb_gadget       *gadget = udc->gadget;          \
 576                                                                 \
 577         return snprintf(buf, PAGE_SIZE, "%d\n", gadget->name);  \
 578 }                                                               \
 579 static DEVICE_ATTR_RO(name)
 580
 581 static USB_UDC_ATTR(is_otg);
 582 static USB_UDC_ATTR(is_a_peripheral);
 583 static USB_UDC_ATTR(b_hnp_enable);
 584 static USB_UDC_ATTR(a_hnp_support);
 585 static USB_UDC_ATTR(a_alt_hnp_support);
 586 static USB_UDC_ATTR(is_selfpowered);
 587
 588 static struct attribute *usb_udc_attrs[] = {
 589         &dev_attr_srp.attr,
 590         &dev_attr_soft_connect.attr,
 591         &dev_attr_state.attr,
 592         &dev_attr_current_speed.attr,
 593         &dev_attr_maximum_speed.attr,
 594
 595         &dev_attr_is_otg.attr,
 596         &dev_attr_is_a_peripheral.attr,
 597         &dev_attr_b_hnp_enable.attr,
 598         &dev_attr_a_hnp_support.attr,
 599         &dev_attr_a_alt_hnp_support.attr,
 600         &dev_attr_is_selfpowered.attr,
 601         NULL,
 602 };
 603
 604 static const struct attribute_group usb_udc_attr_group = {
 605         .attrs = usb_udc_attrs,
 606 };
 607
 608 static const struct attribute_group *usb_udc_attr_groups[] = {
 609         &usb_udc_attr_group,
 610         NULL,
 611 };
 612
 613 static int usb_udc_uevent(struct device *dev, struct kobj_uevent_env *env)
 614 {
 615         struct usb_udc          *udc = container_of(dev, struct usb_udc, dev);
 616         int                     ret;
 617
 618         ret = add_uevent_var(env, "USB_UDC_NAME=%s", udc->gadget->name);
 619         if (ret) {
 620                 dev_err(dev, "failed to add uevent USB_UDC_NAME\n");
 621                 return ret;
 622         }
 623
 624         if (udc->driver) {
 625                 ret = add_uevent_var(env, "USB_UDC_DRIVER=%s",
 626                                 udc->driver->function);
 627                 if (ret) {
 628                         dev_err(dev, "failed to add uevent USB_UDC_DRIVER\n");
 629                         return ret;
 630                 }
 631         }
 632
 633         return 0;
 634 }
 635
 636 static int __init usb_udc_init(void)
 637 {
 638         udc_class = class_create(THIS_MODULE, "udc");
 639         if (IS_ERR(udc_class)) {
 640                 pr_err("failed to create udc class --> %ld\n",
 641                                 PTR_ERR(udc_class));
 642                 return PTR_ERR(udc_class);
 643         }
 644
 645         udc_class->dev_uevent = usb_udc_uevent;
 646         return 0;
 647 }
 648 subsys_initcall(usb_udc_init);
 649
 650 static void __exit usb_udc_exit(void)
 651 {
 652         class_destroy(udc_class);
 653 }
 654 module_exit(usb_udc_exit);
 655
 656 MODULE_DESCRIPTION("UDC Framework");
 657 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
 658 MODULE_LICENSE("GPL v2");