drivers/usb/gadget/f_phonet.c

   1 /*
   2  * f_phonet.c -- USB CDC Phonet function
   3  *
   4  * Copyright (C) 2007-2008 Nokia Corporation. All rights reserved.
   5  *
   6  * Author: Rémi Denis-Courmont
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * version 2 as published by the Free Software Foundation.
  11  */
  12
  13 #include <linux/mm.h>
  14 #include <linux/slab.h>
  15 #include <linux/kernel.h>
  16 #include <linux/device.h>
  17
  18 #include <linux/netdevice.h>
  19 #include <linux/if_ether.h>
  20 #include <linux/if_phonet.h>
  21 #include <linux/if_arp.h>
  22
  23 #include <linux/usb/ch9.h>
  24 #include <linux/usb/cdc.h>
  25 #include <linux/usb/composite.h>
  26
  27 #include "u_phonet.h"
  28
  29 #define PN_MEDIA_USB    0x1B
  30 #define MAXPACKET       512
  31 #if (PAGE_SIZE % MAXPACKET)
  32 #error MAXPACKET must divide PAGE_SIZE!
  33 #endif
  34
  35 /*-------------------------------------------------------------------------*/
  36
  37 struct phonet_port {
  38         struct f_phonet                 *usb;
  39         spinlock_t                      lock;
  40 };
  41
  42 struct f_phonet {
  43         struct usb_function             function;
  44         struct {
  45                 struct sk_buff          *skb;
  46                 spinlock_t              lock;
  47         } rx;
  48         struct net_device               *dev;
  49         struct usb_ep                   *in_ep, *out_ep;
  50
  51         struct usb_request              *in_req;
  52         struct usb_request              *out_reqv[0];
  53 };
  54
  55 static int phonet_rxq_size = 17;
  56
  57 static inline struct f_phonet *func_to_pn(struct usb_function *f)
  58 {
  59         return container_of(f, struct f_phonet, function);
  60 }
  61
  62 /*-------------------------------------------------------------------------*/
  63
  64 #define USB_CDC_SUBCLASS_PHONET 0xfe
  65 #define USB_CDC_PHONET_TYPE     0xab
  66
  67 static struct usb_interface_descriptor
  68 pn_control_intf_desc = {
  69         .bLength =              sizeof pn_control_intf_desc,
  70         .bDescriptorType =      USB_DT_INTERFACE,
  71
  72         /* .bInterfaceNumber =  DYNAMIC, */
  73         .bInterfaceClass =      USB_CLASS_COMM,
  74         .bInterfaceSubClass =   USB_CDC_SUBCLASS_PHONET,
  75 };
  76
  77 static const struct usb_cdc_header_desc
  78 pn_header_desc = {
  79         .bLength =              sizeof pn_header_desc,
  80         .bDescriptorType =      USB_DT_CS_INTERFACE,
  81         .bDescriptorSubType =   USB_CDC_HEADER_TYPE,
  82         .bcdCDC =               cpu_to_le16(0x0110),
  83 };
  84
  85 static const struct usb_cdc_header_desc
  86 pn_phonet_desc = {
  87         .bLength =              sizeof pn_phonet_desc,
  88         .bDescriptorType =      USB_DT_CS_INTERFACE,
  89         .bDescriptorSubType =   USB_CDC_PHONET_TYPE,
  90         .bcdCDC =               cpu_to_le16(0x1505), /* ??? */
  91 };
  92
  93 static struct usb_cdc_union_desc
  94 pn_union_desc = {
  95         .bLength =              sizeof pn_union_desc,
  96         .bDescriptorType =      USB_DT_CS_INTERFACE,
  97         .bDescriptorSubType =   USB_CDC_UNION_TYPE,
  98
  99         /* .bMasterInterface0 = DYNAMIC, */
 100         /* .bSlaveInterface0 =  DYNAMIC, */
 101 };
 102
 103 static struct usb_interface_descriptor
 104 pn_data_nop_intf_desc = {
 105         .bLength =              sizeof pn_data_nop_intf_desc,
 106         .bDescriptorType =      USB_DT_INTERFACE,
 107
 108         /* .bInterfaceNumber =  DYNAMIC, */
 109         .bAlternateSetting =    0,
 110         .bNumEndpoints =        0,
 111         .bInterfaceClass =      USB_CLASS_CDC_DATA,
 112 };
 113
 114 static struct usb_interface_descriptor
 115 pn_data_intf_desc = {
 116         .bLength =              sizeof pn_data_intf_desc,
 117         .bDescriptorType =      USB_DT_INTERFACE,
 118
 119         /* .bInterfaceNumber =  DYNAMIC, */
 120         .bAlternateSetting =    1,
 121         .bNumEndpoints =        2,
 122         .bInterfaceClass =      USB_CLASS_CDC_DATA,
 123 };
 124
 125 static struct usb_endpoint_descriptor
 126 pn_fs_sink_desc = {
 127         .bLength =              USB_DT_ENDPOINT_SIZE,
 128         .bDescriptorType =      USB_DT_ENDPOINT,
 129
 130         .bEndpointAddress =     USB_DIR_OUT,
 131         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
 132 };
 133
 134 static struct usb_endpoint_descriptor
 135 pn_hs_sink_desc = {
 136         .bLength =              USB_DT_ENDPOINT_SIZE,
 137         .bDescriptorType =      USB_DT_ENDPOINT,
 138
 139         .bEndpointAddress =     USB_DIR_OUT,
 140         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
 141         .wMaxPacketSize =       cpu_to_le16(MAXPACKET),
 142 };
 143
 144 static struct usb_endpoint_descriptor
 145 pn_fs_source_desc = {
 146         .bLength =              USB_DT_ENDPOINT_SIZE,
 147         .bDescriptorType =      USB_DT_ENDPOINT,
 148
 149         .bEndpointAddress =     USB_DIR_IN,
 150         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
 151 };
 152
 153 static struct usb_endpoint_descriptor
 154 pn_hs_source_desc = {
 155         .bLength =              USB_DT_ENDPOINT_SIZE,
 156         .bDescriptorType =      USB_DT_ENDPOINT,
 157
 158         .bEndpointAddress =     USB_DIR_IN,
 159         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
 160         .wMaxPacketSize =       cpu_to_le16(512),
 161 };
 162
 163 static struct usb_descriptor_header *fs_pn_function[] = {
 164         (struct usb_descriptor_header *) &pn_control_intf_desc,
 165         (struct usb_descriptor_header *) &pn_header_desc,
 166         (struct usb_descriptor_header *) &pn_phonet_desc,
 167         (struct usb_descriptor_header *) &pn_union_desc,
 168         (struct usb_descriptor_header *) &pn_data_nop_intf_desc,
 169         (struct usb_descriptor_header *) &pn_data_intf_desc,
 170         (struct usb_descriptor_header *) &pn_fs_sink_desc,
 171         (struct usb_descriptor_header *) &pn_fs_source_desc,
 172         NULL,
 173 };
 174
 175 static struct usb_descriptor_header *hs_pn_function[] = {
 176         (struct usb_descriptor_header *) &pn_control_intf_desc,
 177         (struct usb_descriptor_header *) &pn_header_desc,
 178         (struct usb_descriptor_header *) &pn_phonet_desc,
 179         (struct usb_descriptor_header *) &pn_union_desc,
 180         (struct usb_descriptor_header *) &pn_data_nop_intf_desc,
 181         (struct usb_descriptor_header *) &pn_data_intf_desc,
 182         (struct usb_descriptor_header *) &pn_hs_sink_desc,
 183         (struct usb_descriptor_header *) &pn_hs_source_desc,
 184         NULL,
 185 };
 186
 187 /*-------------------------------------------------------------------------*/
 188
 189 static int pn_net_open(struct net_device *dev)
 190 {
 191         netif_wake_queue(dev);
 192         return 0;
 193 }
 194
 195 static int pn_net_close(struct net_device *dev)
 196 {
 197         netif_stop_queue(dev);
 198         return 0;
 199 }
 200
 201 static void pn_tx_complete(struct usb_ep *ep, struct usb_request *req)
 202 {
 203         struct f_phonet *fp = ep->driver_data;
 204         struct net_device *dev = fp->dev;
 205         struct sk_buff *skb = req->context;
 206
 207         switch (req->status) {
 208         case 0:
 209                 dev->stats.tx_packets++;
 210                 dev->stats.tx_bytes += skb->len;
 211                 break;
 212
 213         case -ESHUTDOWN: /* disconnected */
 214         case -ECONNRESET: /* disabled */
 215                 dev->stats.tx_aborted_errors++;
 216         default:
 217                 dev->stats.tx_errors++;
 218         }
 219
 220         dev_kfree_skb_any(skb);
 221         netif_wake_queue(dev);
 222 }
 223
 224 static int pn_net_xmit(struct sk_buff *skb, struct net_device *dev)
 225 {
 226         struct phonet_port *port = netdev_priv(dev);
 227         struct f_phonet *fp;
 228         struct usb_request *req;
 229         unsigned long flags;
 230
 231         if (skb->protocol != htons(ETH_P_PHONET))
 232                 goto out;
 233
 234         spin_lock_irqsave(&port->lock, flags);
 235         fp = port->usb;
 236         if (unlikely(!fp)) /* race with carrier loss */
 237                 goto out_unlock;
 238
 239         req = fp->in_req;
 240         req->buf = skb->data;
 241         req->length = skb->len;
 242         req->complete = pn_tx_complete;
 243         req->zero = 1;
 244         req->context = skb;
 245
 246         if (unlikely(usb_ep_queue(fp->in_ep, req, GFP_ATOMIC)))
 247                 goto out_unlock;
 248
 249         netif_stop_queue(dev);
 250         skb = NULL;
 251
 252 out_unlock:
 253         spin_unlock_irqrestore(&port->lock, flags);
 254 out:
 255         if (unlikely(skb)) {
 256                 dev_kfree_skb(skb);
 257                 dev->stats.tx_dropped++;
 258         }
 259         return NETDEV_TX_OK;
 260 }
 261
 262 static int pn_net_mtu(struct net_device *dev, int new_mtu)
 263 {
 264         if ((new_mtu < PHONET_MIN_MTU) || (new_mtu > PHONET_MAX_MTU))
 265                 return -EINVAL;
 266         dev->mtu = new_mtu;
 267         return 0;
 268 }
 269
 270 static const struct net_device_ops pn_netdev_ops = {
 271         .ndo_open       = pn_net_open,
 272         .ndo_stop       = pn_net_close,
 273         .ndo_start_xmit = pn_net_xmit,
 274         .ndo_change_mtu = pn_net_mtu,
 275 };
 276
 277 static void pn_net_setup(struct net_device *dev)
 278 {
 279         dev->features           = 0;
 280         dev->type               = ARPHRD_PHONET;
 281         dev->flags              = IFF_POINTOPOINT | IFF_NOARP;
 282         dev->mtu                = PHONET_DEV_MTU;
 283         dev->hard_header_len    = 1;
 284         dev->dev_addr[0]        = PN_MEDIA_USB;
 285         dev->addr_len           = 1;
 286         dev->tx_queue_len       = 1;
 287
 288         dev->netdev_ops         = &pn_netdev_ops;
 289         dev->destructor         = free_netdev;
 290         dev->header_ops         = &phonet_header_ops;
 291 }
 292
 293 /*-------------------------------------------------------------------------*/
 294
 295 /*
 296  * Queue buffer for data from the host
 297  */
 298 static int
 299 pn_rx_submit(struct f_phonet *fp, struct usb_request *req, gfp_t gfp_flags)
 300 {
 301         struct net_device *dev = fp->dev;
 302         struct page *page;
 303         int err;
 304
 305         page = __netdev_alloc_page(dev, gfp_flags);
 306         if (!page)
 307                 return -ENOMEM;
 308
 309         req->buf = page_address(page);
 310         req->length = PAGE_SIZE;
 311         req->context = page;
 312
 313         err = usb_ep_queue(fp->out_ep, req, gfp_flags);
 314         if (unlikely(err))
 315                 netdev_free_page(dev, page);
 316         return err;
 317 }
 318
 319 static void pn_rx_complete(struct usb_ep *ep, struct usb_request *req)
 320 {
 321         struct f_phonet *fp = ep->driver_data;
 322         struct net_device *dev = fp->dev;
 323         struct page *page = req->context;
 324         struct sk_buff *skb;
 325         unsigned long flags;
 326         int status = req->status;
 327
 328         switch (status) {
 329         case 0:
 330                 spin_lock_irqsave(&fp->rx.lock, flags);
 331                 skb = fp->rx.skb;
 332                 if (!skb)
 333                         skb = fp->rx.skb = netdev_alloc_skb(dev, 12);
 334                 if (req->actual < req->length) /* Last fragment */
 335                         fp->rx.skb = NULL;
 336                 spin_unlock_irqrestore(&fp->rx.lock, flags);
 337
 338                 if (unlikely(!skb))
 339                         break;
 340
 341                 if (skb->len == 0) { /* First fragment */
 342                         skb->protocol = htons(ETH_P_PHONET);
 343                         skb_reset_mac_header(skb);
 344                         /* Can't use pskb_pull() on page in IRQ */
 345                         memcpy(skb_put(skb, 1), page_address(page), 1);
 346                 }
 347
 348                 skb_add_rx_frag(skb, skb_shinfo(skb)->nr_frags, page,
 349                                 skb->len == 0, req->actual);
 350                 page = NULL;
 351
 352                 if (req->actual < req->length) { /* Last fragment */
 353                         skb->dev = dev;
 354                         dev->stats.rx_packets++;
 355                         dev->stats.rx_bytes += skb->len;
 356
 357                         netif_rx(skb);
 358                 }
 359                 break;
 360
 361         /* Do not resubmit in these cases: */
 362         case -ESHUTDOWN: /* disconnect */
 363         case -ECONNABORTED: /* hw reset */
 364         case -ECONNRESET: /* dequeued (unlink or netif down) */
 365                 req = NULL;
 366                 break;
 367
 368         /* Do resubmit in these cases: */
 369         case -EOVERFLOW: /* request buffer overflow */
 370                 dev->stats.rx_over_errors++;
 371         default:
 372                 dev->stats.rx_errors++;
 373                 break;
 374         }
 375
 376         if (page)
 377                 netdev_free_page(dev, page);
 378         if (req)
 379                 pn_rx_submit(fp, req, GFP_ATOMIC);
 380 }
 381
 382 /*-------------------------------------------------------------------------*/
 383
 384 static void __pn_reset(struct usb_function *f)
 385 {
 386         struct f_phonet *fp = func_to_pn(f);
 387         struct net_device *dev = fp->dev;
 388         struct phonet_port *port = netdev_priv(dev);
 389
 390         netif_carrier_off(dev);
 391         port->usb = NULL;
 392
 393         usb_ep_disable(fp->out_ep);
 394         usb_ep_disable(fp->in_ep);
 395         if (fp->rx.skb) {
 396                 dev_kfree_skb_irq(fp->rx.skb);
 397                 fp->rx.skb = NULL;
 398         }
 399 }
 400
 401 static int pn_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
 402 {
 403         struct f_phonet *fp = func_to_pn(f);
 404         struct usb_gadget *gadget = fp->function.config->cdev->gadget;
 405
 406         if (intf == pn_control_intf_desc.bInterfaceNumber)
 407                 /* control interface, no altsetting */
 408                 return (alt > 0) ? -EINVAL : 0;
 409
 410         if (intf == pn_data_intf_desc.bInterfaceNumber) {
 411                 struct net_device *dev = fp->dev;
 412                 struct phonet_port *port = netdev_priv(dev);
 413
 414                 /* data intf (0: inactive, 1: active) */
 415                 if (alt > 1)
 416                         return -EINVAL;
 417
 418                 spin_lock(&port->lock);
 419                 __pn_reset(f);
 420                 if (alt == 1) {
 421                         int i;
 422
 423                         if (config_ep_by_speed(gadget, f, fp->in_ep) ||
 424                             config_ep_by_speed(gadget, f, fp->out_ep)) {
 425                                 fp->in_ep->desc = NULL;
 426                                 fp->out_ep->desc = NULL;
 427                                 spin_unlock(&port->lock);
 428                                 return -EINVAL;
 429                         }
 430                         usb_ep_enable(fp->out_ep);
 431                         usb_ep_enable(fp->in_ep);
 432
 433                         port->usb = fp;
 434                         fp->out_ep->driver_data = fp;
 435                         fp->in_ep->driver_data = fp;
 436
 437                         netif_carrier_on(dev);
 438                         for (i = 0; i < phonet_rxq_size; i++)
 439                                 pn_rx_submit(fp, fp->out_reqv[i], GFP_ATOMIC);
 440                 }
 441                 spin_unlock(&port->lock);
 442                 return 0;
 443         }
 444
 445         return -EINVAL;
 446 }
 447
 448 static int pn_get_alt(struct usb_function *f, unsigned intf)
 449 {
 450         struct f_phonet *fp = func_to_pn(f);
 451
 452         if (intf == pn_control_intf_desc.bInterfaceNumber)
 453                 return 0;
 454
 455         if (intf == pn_data_intf_desc.bInterfaceNumber) {
 456                 struct phonet_port *port = netdev_priv(fp->dev);
 457                 u8 alt;
 458
 459                 spin_lock(&port->lock);
 460                 alt = port->usb != NULL;
 461                 spin_unlock(&port->lock);
 462                 return alt;
 463         }
 464
 465         return -EINVAL;
 466 }
 467
 468 static void pn_disconnect(struct usb_function *f)
 469 {
 470         struct f_phonet *fp = func_to_pn(f);
 471         struct phonet_port *port = netdev_priv(fp->dev);
 472         unsigned long flags;
 473
 474         /* remain disabled until set_alt */
 475         spin_lock_irqsave(&port->lock, flags);
 476         __pn_reset(f);
 477         spin_unlock_irqrestore(&port->lock, flags);
 478 }
 479
 480 /*-------------------------------------------------------------------------*/
 481
 482 static __init
 483 int pn_bind(struct usb_configuration *c, struct usb_function *f)
 484 {
 485         struct usb_composite_dev *cdev = c->cdev;
 486         struct usb_gadget *gadget = cdev->gadget;
 487         struct f_phonet *fp = func_to_pn(f);
 488         struct usb_ep *ep;
 489         int status, i;
 490
 491         /* Reserve interface IDs */
 492         status = usb_interface_id(c, f);
 493         if (status < 0)
 494                 goto err;
 495         pn_control_intf_desc.bInterfaceNumber = status;
 496         pn_union_desc.bMasterInterface0 = status;
 497
 498         status = usb_interface_id(c, f);
 499         if (status < 0)
 500                 goto err;
 501         pn_data_nop_intf_desc.bInterfaceNumber = status;
 502         pn_data_intf_desc.bInterfaceNumber = status;
 503         pn_union_desc.bSlaveInterface0 = status;
 504
 505         /* Reserve endpoints */
 506         status = -ENODEV;
 507         ep = usb_ep_autoconfig(gadget, &pn_fs_sink_desc);
 508         if (!ep)
 509                 goto err;
 510         fp->out_ep = ep;
 511         ep->driver_data = fp; /* Claim */
 512
 513         ep = usb_ep_autoconfig(gadget, &pn_fs_source_desc);
 514         if (!ep)
 515                 goto err;
 516         fp->in_ep = ep;
 517         ep->driver_data = fp; /* Claim */
 518
 519         pn_hs_sink_desc.bEndpointAddress =
 520                 pn_fs_sink_desc.bEndpointAddress;
 521         pn_hs_source_desc.bEndpointAddress =
 522                 pn_fs_source_desc.bEndpointAddress;
 523
 524         /* Do not try to bind Phonet twice... */
 525         fp->function.descriptors = fs_pn_function;
 526         fp->function.hs_descriptors = hs_pn_function;
 527
 528         /* Incoming USB requests */
 529         status = -ENOMEM;
 530         for (i = 0; i < phonet_rxq_size; i++) {
 531                 struct usb_request *req;
 532
 533                 req = usb_ep_alloc_request(fp->out_ep, GFP_KERNEL);
 534                 if (!req)
 535                         goto err;
 536
 537                 req->complete = pn_rx_complete;
 538                 fp->out_reqv[i] = req;
 539         }
 540
 541         /* Outgoing USB requests */
 542         fp->in_req = usb_ep_alloc_request(fp->in_ep, GFP_KERNEL);
 543         if (!fp->in_req)
 544                 goto err;
 545
 546         INFO(cdev, "USB CDC Phonet function\n");
 547         INFO(cdev, "using %s, OUT %s, IN %s\n", cdev->gadget->name,
 548                 fp->out_ep->name, fp->in_ep->name);
 549         return 0;
 550
 551 err:
 552         if (fp->out_ep)
 553                 fp->out_ep->driver_data = NULL;
 554         if (fp->in_ep)
 555                 fp->in_ep->driver_data = NULL;
 556         ERROR(cdev, "USB CDC Phonet: cannot autoconfigure\n");
 557         return status;
 558 }
 559
 560 static void
 561 pn_unbind(struct usb_configuration *c, struct usb_function *f)
 562 {
 563         struct f_phonet *fp = func_to_pn(f);
 564         int i;
 565
 566         /* We are already disconnected */
 567         if (fp->in_req)
 568                 usb_ep_free_request(fp->in_ep, fp->in_req);
 569         for (i = 0; i < phonet_rxq_size; i++)
 570                 if (fp->out_reqv[i])
 571                         usb_ep_free_request(fp->out_ep, fp->out_reqv[i]);
 572
 573         kfree(fp);
 574 }
 575
 576 /*-------------------------------------------------------------------------*/
 577
 578 static struct net_device *dev;
 579
 580 int __init phonet_bind_config(struct usb_configuration *c)
 581 {
 582         struct f_phonet *fp;
 583         int err, size;
 584
 585         size = sizeof(*fp) + (phonet_rxq_size * sizeof(struct usb_request *));
 586         fp = kzalloc(size, GFP_KERNEL);
 587         if (!fp)
 588                 return -ENOMEM;
 589
 590         fp->dev = dev;
 591         fp->function.name = "phonet";
 592         fp->function.bind = pn_bind;
 593         fp->function.unbind = pn_unbind;
 594         fp->function.set_alt = pn_set_alt;
 595         fp->function.get_alt = pn_get_alt;
 596         fp->function.disable = pn_disconnect;
 597         spin_lock_init(&fp->rx.lock);
 598
 599         err = usb_add_function(c, &fp->function);
 600         if (err)
 601                 kfree(fp);
 602         return err;
 603 }
 604
 605 int __init gphonet_setup(struct usb_gadget *gadget)
 606 {
 607         struct phonet_port *port;
 608         int err;
 609
 610         /* Create net device */
 611         BUG_ON(dev);
 612         dev = alloc_netdev(sizeof(*port), "upnlink%d", pn_net_setup);
 613         if (!dev)
 614                 return -ENOMEM;
 615
 616         port = netdev_priv(dev);
 617         spin_lock_init(&port->lock);
 618         netif_carrier_off(dev);
 619         SET_NETDEV_DEV(dev, &gadget->dev);
 620
 621         err = register_netdev(dev);
 622         if (err)
 623                 free_netdev(dev);
 624         return err;
 625 }
 626
 627 void gphonet_cleanup(void)
 628 {
 629         unregister_netdev(dev);
 630 }