drivers/staging/usbip/vhci_hcd.c

   1 /*
   2  * Copyright (C) 2003-2008 Takahiro Hirofuchi
   3  *
   4  * This is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
  17  * USA.
  18  */
  19
  20 #include <linux/slab.h>
  21
  22 #include "usbip_common.h"
  23 #include "vhci.h"
  24
  25 #define DRIVER_VERSION "1.0"
  26 #define DRIVER_AUTHOR "Takahiro Hirofuchi"
  27 #define DRIVER_DESC "Virtual Host Controller Interface Driver for USB/IP"
  28 #define DRIVER_LICENCE "GPL"
  29 MODULE_AUTHOR(DRIVER_AUTHOR);
  30 MODULE_DESCRIPTION(DRIVER_DESC);
  31 MODULE_LICENSE(DRIVER_LICENCE);
  32
  33
  34
  35 /*
  36  * TODO
  37  *      - update root hub emulation
  38  *      - move the emulation code to userland ?
  39  *              porting to other operating systems
  40  *              minimize kernel code
  41  *      - add suspend/resume code
  42  *      - clean up everything
  43  */
  44
  45
  46 /* See usb gadget dummy hcd */
  47
  48
  49 static int vhci_hub_status(struct usb_hcd *hcd, char *buff);
  50 static int vhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
  51                 u16 wIndex, char *buff, u16 wLength);
  52 static int vhci_urb_enqueue(struct usb_hcd *hcd, struct urb *urb,
  53                                                         gfp_t mem_flags);
  54 static int vhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status);
  55 static int vhci_start(struct usb_hcd *vhci_hcd);
  56 static void vhci_stop(struct usb_hcd *hcd);
  57 static int vhci_get_frame_number(struct usb_hcd *hcd);
  58
  59 static const char driver_name[] = "vhci_hcd";
  60 static const char driver_desc[] = "USB/IP Virtual Host Controller";
  61
  62 struct vhci_hcd *the_controller;
  63
  64 static const char *bit_desc[] = {
  65         "CONNECTION",           /*0*/
  66         "ENABLE",               /*1*/
  67         "SUSPEND",              /*2*/
  68         "OVER_CURRENT",         /*3*/
  69         "RESET",                /*4*/
  70         "R5",           /*5*/
  71         "R6",           /*6*/
  72         "R7",           /*7*/
  73         "POWER",                /*8*/
  74         "LOWSPEED",             /*9*/
  75         "HIGHSPEED",            /*10*/
  76         "PORT_TEST",            /*11*/
  77         "INDICATOR",            /*12*/
  78         "R13",          /*13*/
  79         "R14",          /*14*/
  80         "R15",          /*15*/
  81         "C_CONNECTION",         /*16*/
  82         "C_ENABLE",             /*17*/
  83         "C_SUSPEND",            /*18*/
  84         "C_OVER_CURRENT",       /*19*/
  85         "C_RESET",              /*20*/
  86         "R21",          /*21*/
  87         "R22",          /*22*/
  88         "R23",          /*23*/
  89         "R24",          /*24*/
  90         "R25",          /*25*/
  91         "R26",          /*26*/
  92         "R27",          /*27*/
  93         "R28",          /*28*/
  94         "R29",          /*29*/
  95         "R30",          /*30*/
  96         "R31",          /*31*/
  97 };
  98
  99
 100 static void dump_port_status(u32 status)
 101 {
 102         int i = 0;
 103
 104         printk(KERN_DEBUG "status %08x:", status);
 105         for (i = 0; i < 32; i++) {
 106                 if (status & (1 << i))
 107                         printk(" %s", bit_desc[i]);
 108         }
 109
 110         printk("\n");
 111 }
 112
 113
 114
 115 void rh_port_connect(int rhport, enum usb_device_speed speed)
 116 {
 117         unsigned long   flags;
 118
 119         usbip_dbg_vhci_rh("rh_port_connect %d\n", rhport);
 120
 121         spin_lock_irqsave(&the_controller->lock, flags);
 122
 123         the_controller->port_status[rhport] |= USB_PORT_STAT_CONNECTION
 124                 | (1 << USB_PORT_FEAT_C_CONNECTION);
 125
 126         switch (speed) {
 127         case USB_SPEED_HIGH:
 128                 the_controller->port_status[rhport] |= USB_PORT_STAT_HIGH_SPEED;
 129                 break;
 130         case USB_SPEED_LOW:
 131                 the_controller->port_status[rhport] |= USB_PORT_STAT_LOW_SPEED;
 132                 break;
 133         default:
 134                 break;
 135         }
 136
 137         /* spin_lock(&the_controller->vdev[rhport].ud.lock);
 138          * the_controller->vdev[rhport].ud.status = VDEV_CONNECT;
 139          * spin_unlock(&the_controller->vdev[rhport].ud.lock); */
 140
 141         the_controller->pending_port = rhport;
 142
 143         spin_unlock_irqrestore(&the_controller->lock, flags);
 144
 145         usb_hcd_poll_rh_status(vhci_to_hcd(the_controller));
 146 }
 147
 148 void rh_port_disconnect(int rhport)
 149 {
 150         unsigned long flags;
 151
 152         usbip_dbg_vhci_rh("rh_port_disconnect %d\n", rhport);
 153
 154         spin_lock_irqsave(&the_controller->lock, flags);
 155         /* stop_activity(dum, driver); */
 156         the_controller->port_status[rhport] &= ~USB_PORT_STAT_CONNECTION;
 157         the_controller->port_status[rhport] |=
 158                                         (1 << USB_PORT_FEAT_C_CONNECTION);
 159
 160
 161         /* not yet complete the disconnection
 162          * spin_lock(&vdev->ud.lock);
 163          * vdev->ud.status = VHC_ST_DISCONNECT;
 164          * spin_unlock(&vdev->ud.lock); */
 165
 166         spin_unlock_irqrestore(&the_controller->lock, flags);
 167
 168         usb_hcd_poll_rh_status(vhci_to_hcd(the_controller));
 169 }
 170
 171
 172
 173 /*----------------------------------------------------------------------*/
 174
 175 #define PORT_C_MASK \
 176         ((USB_PORT_STAT_C_CONNECTION \
 177           | USB_PORT_STAT_C_ENABLE \
 178           | USB_PORT_STAT_C_SUSPEND \
 179           | USB_PORT_STAT_C_OVERCURRENT \
 180           | USB_PORT_STAT_C_RESET) << 16)
 181
 182 /*
 183  * This function is almostly the same as dummy_hcd.c:dummy_hub_status() without
 184  * suspend/resume support. But, it is modified to provide multiple ports.
 185  *
 186  * @buf: a bitmap to show which port status has been changed.
 187  *  bit  0: reserved or used for another purpose?
 188  *  bit  1: the status of port 0 has been changed.
 189  *  bit  2: the status of port 1 has been changed.
 190  *  ...
 191  *  bit  7: the status of port 6 has been changed.
 192  *  bit  8: the status of port 7 has been changed.
 193  *  ...
 194  *  bit 15: the status of port 14 has been changed.
 195  *
 196  * So, the maximum number of ports is 31 ( port 0 to port 30) ?
 197  *
 198  * The return value is the actual transfered length in byte. If nothing has
 199  * been changed, return 0. In the case that the number of ports is less than or
 200  * equal to 6 (VHCI_NPORTS==7), return 1.
 201  *
 202  */
 203 static int vhci_hub_status(struct usb_hcd *hcd, char *buf)
 204 {
 205         struct vhci_hcd *vhci;
 206         unsigned long   flags;
 207         int             retval = 0;
 208
 209         /* the enough buffer is allocated according to USB_MAXCHILDREN */
 210         unsigned long   *event_bits = (unsigned long *) buf;
 211         int             rhport;
 212         int             changed = 0;
 213
 214
 215         *event_bits = 0;
 216
 217         vhci = hcd_to_vhci(hcd);
 218
 219         spin_lock_irqsave(&vhci->lock, flags);
 220         if (!HCD_HW_ACCESSIBLE(hcd)) {
 221                 usbip_dbg_vhci_rh("hw accessible flag in on?\n");
 222                 goto done;
 223         }
 224
 225         /* check pseudo status register for each port */
 226         for (rhport = 0; rhport < VHCI_NPORTS; rhport++) {
 227                 if ((vhci->port_status[rhport] & PORT_C_MASK)) {
 228                         /* The status of a port has been changed, */
 229                         usbip_dbg_vhci_rh("port %d is changed\n", rhport);
 230
 231                         *event_bits |= 1 << (rhport + 1);
 232                         changed = 1;
 233                 }
 234         }
 235
 236         usbip_uinfo("changed %d\n", changed);
 237
 238         if (hcd->state == HC_STATE_SUSPENDED)
 239                 usb_hcd_resume_root_hub(hcd);
 240
 241         if (changed)
 242                 retval = 1 + (VHCI_NPORTS / 8);
 243         else
 244                 retval = 0;
 245
 246 done:
 247         spin_unlock_irqrestore(&vhci->lock, flags);
 248         return retval;
 249 }
 250
 251 /* See hub_configure in hub.c */
 252 static inline void hub_descriptor(struct usb_hub_descriptor *desc)
 253 {
 254         memset(desc, 0, sizeof(*desc));
 255         desc->bDescriptorType = 0x29;
 256         desc->bDescLength = 9;
 257         desc->wHubCharacteristics = (__force __u16)
 258                 (__constant_cpu_to_le16(0x0001));
 259         desc->bNbrPorts = VHCI_NPORTS;
 260         desc->bitmap[0] = 0xff;
 261         desc->bitmap[1] = 0xff;
 262 }
 263
 264 static int vhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
 265                             u16 wIndex, char *buf, u16 wLength)
 266 {
 267         struct vhci_hcd *dum;
 268         int             retval = 0;
 269         unsigned long   flags;
 270         int             rhport;
 271
 272         u32 prev_port_status[VHCI_NPORTS];
 273
 274         if (!HCD_HW_ACCESSIBLE(hcd))
 275                 return -ETIMEDOUT;
 276
 277         /*
 278          * NOTE:
 279          * wIndex shows the port number and begins from 1.
 280          */
 281         usbip_dbg_vhci_rh("typeReq %x wValue %x wIndex %x\n", typeReq, wValue,
 282                                                                 wIndex);
 283         if (wIndex > VHCI_NPORTS)
 284                 printk(KERN_ERR "%s: invalid port number %d\n", __func__,
 285                                                                 wIndex);
 286         rhport = ((__u8)(wIndex & 0x00ff)) - 1;
 287
 288         dum = hcd_to_vhci(hcd);
 289
 290         spin_lock_irqsave(&dum->lock, flags);
 291
 292         /* store old status and compare now and old later */
 293         if (usbip_dbg_flag_vhci_rh) {
 294                 int i = 0;
 295                 for (i = 0; i < VHCI_NPORTS; i++)
 296                         prev_port_status[i] = dum->port_status[i];
 297         }
 298
 299         switch (typeReq) {
 300         case ClearHubFeature:
 301                 usbip_dbg_vhci_rh(" ClearHubFeature\n");
 302                 break;
 303         case ClearPortFeature:
 304                 switch (wValue) {
 305                 case USB_PORT_FEAT_SUSPEND:
 306                         if (dum->port_status[rhport] & USB_PORT_STAT_SUSPEND) {
 307                                 /* 20msec signaling */
 308                                 dum->resuming = 1;
 309                                 dum->re_timeout =
 310                                         jiffies + msecs_to_jiffies(20);
 311                         }
 312                         break;
 313                 case USB_PORT_FEAT_POWER:
 314                         usbip_dbg_vhci_rh(" ClearPortFeature: "
 315                                                 "USB_PORT_FEAT_POWER\n");
 316                         dum->port_status[rhport] = 0;
 317                         /* dum->address = 0; */
 318                         /* dum->hdev = 0; */
 319                         dum->resuming = 0;
 320                         break;
 321                 case USB_PORT_FEAT_C_RESET:
 322                         usbip_dbg_vhci_rh(" ClearPortFeature: "
 323                                                 "USB_PORT_FEAT_C_RESET\n");
 324                         switch (dum->vdev[rhport].speed) {
 325                         case USB_SPEED_HIGH:
 326                                 dum->port_status[rhport] |=
 327                                                 USB_PORT_STAT_HIGH_SPEED;
 328                                 break;
 329                         case USB_SPEED_LOW:
 330                                 dum->port_status[rhport] |=
 331                                                 USB_PORT_STAT_LOW_SPEED;
 332                                 break;
 333                         default:
 334                                 break;
 335                         }
 336                 default:
 337                         usbip_dbg_vhci_rh(" ClearPortFeature: default %x\n",
 338                                                                 wValue);
 339                         dum->port_status[rhport] &= ~(1 << wValue);
 340                 }
 341                 break;
 342         case GetHubDescriptor:
 343                 usbip_dbg_vhci_rh(" GetHubDescriptor\n");
 344                 hub_descriptor((struct usb_hub_descriptor *) buf);
 345                 break;
 346         case GetHubStatus:
 347                 usbip_dbg_vhci_rh(" GetHubStatus\n");
 348                 *(__le32 *) buf = __constant_cpu_to_le32(0);
 349                 break;
 350         case GetPortStatus:
 351                 usbip_dbg_vhci_rh(" GetPortStatus port %x\n", wIndex);
 352                 if (wIndex > VHCI_NPORTS || wIndex < 1) {
 353                         printk(KERN_ERR "%s: invalid port number %d\n",
 354                                __func__, wIndex);
 355                         retval = -EPIPE;
 356                 }
 357
 358                 /* we do no care of resume. */
 359
 360                 /* whoever resets or resumes must GetPortStatus to
 361                  * complete it!!
 362                  *                                   */
 363                 if (dum->resuming && time_after(jiffies, dum->re_timeout)) {
 364                         printk(KERN_ERR "%s: not yet\n", __func__);
 365                         dum->port_status[rhport] |=
 366                                         (1 << USB_PORT_FEAT_C_SUSPEND);
 367                         dum->port_status[rhport] &=
 368                                         ~(1 << USB_PORT_FEAT_SUSPEND);
 369                         dum->resuming = 0;
 370                         dum->re_timeout = 0;
 371                         /* if (dum->driver && dum->driver->resume) {
 372                          *      spin_unlock (&dum->lock);
 373                          *      dum->driver->resume (&dum->gadget);
 374                          *      spin_lock (&dum->lock);
 375                          * } */
 376                 }
 377
 378                 if ((dum->port_status[rhport] & (1 << USB_PORT_FEAT_RESET)) !=
 379                                 0 && time_after(jiffies, dum->re_timeout)) {
 380                         dum->port_status[rhport] |=
 381                                                 (1 << USB_PORT_FEAT_C_RESET);
 382                         dum->port_status[rhport] &=
 383                                                 ~(1 << USB_PORT_FEAT_RESET);
 384                         dum->re_timeout = 0;
 385
 386                         if (dum->vdev[rhport].ud.status ==
 387                                                         VDEV_ST_NOTASSIGNED) {
 388                                 usbip_dbg_vhci_rh(" enable rhport %d "
 389                                                 "(status %u)\n",
 390                                                 rhport,
 391                                                 dum->vdev[rhport].ud.status);
 392                                 dum->port_status[rhport] |=
 393                                                         USB_PORT_STAT_ENABLE;
 394                         }
 395 #if 0
 396                         if (dum->driver) {
 397
 398                                 dum->port_status[rhport] |=
 399                                                         USB_PORT_STAT_ENABLE;
 400                                 /* give it the best speed we agree on */
 401                                 dum->gadget.speed = dum->driver->speed;
 402                                 dum->gadget.ep0->maxpacket = 64;
 403                                 switch (dum->gadget.speed) {
 404                                 case USB_SPEED_HIGH:
 405                                         dum->port_status[rhport] |=
 406                                         USB_PORT_STAT_HIGH_SPEED;
 407                                         break;
 408                                 case USB_SPEED_LOW:
 409                                         dum->gadget.ep0->maxpacket = 8;
 410                                         dum->port_status[rhport] |=
 411                                         USB_PORT_STAT_LOW_SPEED;
 412                                         break;
 413                                 default:
 414                                         dum->gadget.speed = USB_SPEED_FULL;
 415                                         break;
 416                                 }
 417                         }
 418 #endif
 419
 420                 }
 421                 ((u16 *) buf)[0] = cpu_to_le16(dum->port_status[rhport]);
 422                 ((u16 *) buf)[1] =
 423                                 cpu_to_le16(dum->port_status[rhport] >> 16);
 424
 425                 usbip_dbg_vhci_rh(" GetPortStatus bye %x %x\n", ((u16 *)buf)[0],
 426                                                         ((u16 *)buf)[1]);
 427                 break;
 428         case SetHubFeature:
 429                 usbip_dbg_vhci_rh(" SetHubFeature\n");
 430                 retval = -EPIPE;
 431                 break;
 432         case SetPortFeature:
 433                 switch (wValue) {
 434                 case USB_PORT_FEAT_SUSPEND:
 435                         usbip_dbg_vhci_rh(" SetPortFeature: "
 436                                         "USB_PORT_FEAT_SUSPEND\n");
 437                         printk(KERN_ERR "%s: not yet\n", __func__);
 438 #if 0
 439                         dum->port_status[rhport] |=
 440                                                 (1 << USB_PORT_FEAT_SUSPEND);
 441                         if (dum->driver->suspend) {
 442                                 spin_unlock(&dum->lock);
 443                                 dum->driver->suspend(&dum->gadget);
 444                                 spin_lock(&dum->lock);
 445                         }
 446 #endif
 447                         break;
 448                 case USB_PORT_FEAT_RESET:
 449                         usbip_dbg_vhci_rh(" SetPortFeature: "
 450                                                 "USB_PORT_FEAT_RESET\n");
 451                         /* if it's already running, disconnect first */
 452                         if (dum->port_status[rhport] & USB_PORT_STAT_ENABLE) {
 453                                 dum->port_status[rhport] &=
 454                                                 ~(USB_PORT_STAT_ENABLE |
 455                                                   USB_PORT_STAT_LOW_SPEED |
 456                                                   USB_PORT_STAT_HIGH_SPEED);
 457 #if 0
 458                                 if (dum->driver) {
 459                                         dev_dbg(hardware, "disconnect\n");
 460                                         stop_activity(dum, dum->driver);
 461                                 }
 462 #endif
 463
 464                                 /* FIXME test that code path! */
 465                         }
 466                         /* 50msec reset signaling */
 467                         dum->re_timeout = jiffies + msecs_to_jiffies(50);
 468
 469                         /* FALLTHROUGH */
 470                 default:
 471                         usbip_dbg_vhci_rh(" SetPortFeature: default %d\n",
 472                                                                 wValue);
 473                         dum->port_status[rhport] |= (1 << wValue);
 474                 }
 475                 break;
 476
 477         default:
 478                 printk(KERN_ERR "%s: default: no such request\n", __func__);
 479                 /* dev_dbg (hardware,
 480                  *              "hub control req%04x v%04x i%04x l%d\n",
 481                  *              typeReq, wValue, wIndex, wLength); */
 482
 483                 /* "protocol stall" on error */
 484                 retval = -EPIPE;
 485         }
 486
 487         if (usbip_dbg_flag_vhci_rh) {
 488                 printk(KERN_DEBUG "port %d\n", rhport);
 489                 dump_port_status(prev_port_status[rhport]);
 490                 dump_port_status(dum->port_status[rhport]);
 491         }
 492         usbip_dbg_vhci_rh(" bye\n");
 493
 494         spin_unlock_irqrestore(&dum->lock, flags);
 495
 496         return retval;
 497 }
 498
 499
 500
 501 /*----------------------------------------------------------------------*/
 502
 503 static struct vhci_device *get_vdev(struct usb_device *udev)
 504 {
 505         int i;
 506
 507         if (!udev)
 508                 return NULL;
 509
 510         for (i = 0; i < VHCI_NPORTS; i++)
 511                 if (the_controller->vdev[i].udev == udev)
 512                         return port_to_vdev(i);
 513
 514         return NULL;
 515 }
 516
 517 static void vhci_tx_urb(struct urb *urb)
 518 {
 519         struct vhci_device *vdev = get_vdev(urb->dev);
 520         struct vhci_priv *priv;
 521         unsigned long flag;
 522
 523         if (!vdev) {
 524                 err("could not get virtual device");
 525                 /* BUG(); */
 526                 return;
 527         }
 528
 529         priv = kzalloc(sizeof(struct vhci_priv), GFP_ATOMIC);
 530
 531         spin_lock_irqsave(&vdev->priv_lock, flag);
 532
 533         if (!priv) {
 534                 dev_err(&urb->dev->dev, "malloc vhci_priv\n");
 535                 spin_unlock_irqrestore(&vdev->priv_lock, flag);
 536                 usbip_event_add(&vdev->ud, VDEV_EVENT_ERROR_MALLOC);
 537                 return;
 538         }
 539
 540         priv->seqnum = atomic_inc_return(&the_controller->seqnum);
 541         if (priv->seqnum == 0xffff)
 542                 usbip_uinfo("seqnum max\n");
 543
 544         priv->vdev = vdev;
 545         priv->urb = urb;
 546
 547         urb->hcpriv = (void *) priv;
 548
 549
 550         list_add_tail(&priv->list, &vdev->priv_tx);
 551
 552         wake_up(&vdev->waitq_tx);
 553         spin_unlock_irqrestore(&vdev->priv_lock, flag);
 554 }
 555
 556 static int vhci_urb_enqueue(struct usb_hcd *hcd, struct urb *urb,
 557                             gfp_t mem_flags)
 558 {
 559         struct device *dev = &urb->dev->dev;
 560         int ret = 0;
 561         unsigned long flags;
 562
 563         usbip_dbg_vhci_hc("enter, usb_hcd %p urb %p mem_flags %d\n",
 564                     hcd, urb, mem_flags);
 565
 566         /* patch to usb_sg_init() is in 2.5.60 */
 567         BUG_ON(!urb->transfer_buffer && urb->transfer_buffer_length);
 568
 569         spin_lock_irqsave(&the_controller->lock, flags);
 570
 571         if (urb->status != -EINPROGRESS) {
 572                 dev_err(dev, "URB already unlinked!, status %d\n", urb->status);
 573                 spin_unlock_irqrestore(&the_controller->lock, flags);
 574                 return urb->status;
 575         }
 576
 577         ret = usb_hcd_link_urb_to_ep(hcd, urb);
 578         if (ret)
 579                 goto no_need_unlink;
 580
 581         /*
 582          * The enumeration process is as follows;
 583          *
 584          *  1. Get_Descriptor request to DevAddrs(0) EndPoint(0)
 585          *     to get max packet length of default pipe
 586          *
 587          *  2. Set_Address request to DevAddr(0) EndPoint(0)
 588          *
 589          */
 590
 591         if (usb_pipedevice(urb->pipe) == 0) {
 592                 __u8 type = usb_pipetype(urb->pipe);
 593                 struct usb_ctrlrequest *ctrlreq =
 594                                 (struct usb_ctrlrequest *) urb->setup_packet;
 595                 struct vhci_device *vdev =
 596                                 port_to_vdev(the_controller->pending_port);
 597
 598                 if (type != PIPE_CONTROL || !ctrlreq) {
 599                         dev_err(dev, "invalid request to devnum 0\n");
 600                         ret = -EINVAL;
 601                         goto no_need_xmit;
 602                 }
 603
 604                 switch (ctrlreq->bRequest) {
 605                 case USB_REQ_SET_ADDRESS:
 606                         /* set_address may come when a device is reset */
 607                         dev_info(dev, "SetAddress Request (%d) to port %d\n",
 608                                  ctrlreq->wValue, vdev->rhport);
 609
 610                         vdev->udev = urb->dev;
 611
 612                         spin_lock(&vdev->ud.lock);
 613                         vdev->ud.status = VDEV_ST_USED;
 614                         spin_unlock(&vdev->ud.lock);
 615
 616                         if (urb->status == -EINPROGRESS) {
 617                                 /* This request is successfully completed. */
 618                                 /* If not -EINPROGRESS, possibly unlinked. */
 619                                 urb->status = 0;
 620                         }
 621
 622                         goto no_need_xmit;
 623
 624                 case USB_REQ_GET_DESCRIPTOR:
 625                         if (ctrlreq->wValue == (USB_DT_DEVICE << 8))
 626                                 usbip_dbg_vhci_hc("Not yet?: "
 627                                                 "Get_Descriptor to device 0 "
 628                                                 "(get max pipe size)\n");
 629
 630                         /* FIXME: reference count? (usb_get_dev()) */
 631                         vdev->udev = urb->dev;
 632                         goto out;
 633
 634                 default:
 635                         /* NOT REACHED */
 636                         dev_err(dev, "invalid request to devnum 0 bRequest %u, "
 637                                 "wValue %u\n", ctrlreq->bRequest,
 638                                 ctrlreq->wValue);
 639                         ret =  -EINVAL;
 640                         goto no_need_xmit;
 641                 }
 642
 643         }
 644
 645 out:
 646         vhci_tx_urb(urb);
 647
 648         spin_unlock_irqrestore(&the_controller->lock, flags);
 649
 650         return 0;
 651
 652 no_need_xmit:
 653         usb_hcd_unlink_urb_from_ep(hcd, urb);
 654 no_need_unlink:
 655         spin_unlock_irqrestore(&the_controller->lock, flags);
 656
 657         usb_hcd_giveback_urb(vhci_to_hcd(the_controller), urb, urb->status);
 658
 659         return ret;
 660 }
 661
 662 /*
 663  * vhci_rx gives back the urb after receiving the reply of the urb.  If an
 664  * unlink pdu is sent or not, vhci_rx receives a normal return pdu and gives
 665  * back its urb. For the driver unlinking the urb, the content of the urb is
 666  * not important, but the calling to its completion handler is important; the
 667  * completion of unlinking is notified by the completion handler.
 668  *
 669  *
 670  * CLIENT SIDE
 671  *
 672  * - When vhci_hcd receives RET_SUBMIT,
 673  *
 674  *      - case 1a). the urb of the pdu is not unlinking.
 675  *              - normal case
 676  *              => just give back the urb
 677  *
 678  *      - case 1b). the urb of the pdu is unlinking.
 679  *              - usbip.ko will return a reply of the unlinking request.
 680  *              => give back the urb now and go to case 2b).
 681  *
 682  * - When vhci_hcd receives RET_UNLINK,
 683  *
 684  *      - case 2a). a submit request is still pending in vhci_hcd.
 685  *              - urb was really pending in usbip.ko and urb_unlink_urb() was
 686  *                completed there.
 687  *              => free a pending submit request
 688  *              => notify unlink completeness by giving back the urb
 689  *
 690  *      - case 2b). a submit request is *not* pending in vhci_hcd.
 691  *              - urb was already given back to the core driver.
 692  *              => do not give back the urb
 693  *
 694  *
 695  * SERVER SIDE
 696  *
 697  * - When usbip receives CMD_UNLINK,
 698  *
 699  *      - case 3a). the urb of the unlink request is now in submission.
 700  *              => do usb_unlink_urb().
 701  *              => after the unlink is completed, send RET_UNLINK.
 702  *
 703  *      - case 3b). the urb of the unlink request is not in submission.
 704  *              - may be already completed or never be received
 705  *              => send RET_UNLINK
 706  *
 707  */
 708 static int vhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
 709 {
 710         unsigned long flags;
 711         struct vhci_priv *priv;
 712         struct vhci_device *vdev;
 713
 714         usbip_uinfo("vhci_hcd: dequeue a urb %p\n", urb);
 715
 716
 717         spin_lock_irqsave(&the_controller->lock, flags);
 718
 719         priv = urb->hcpriv;
 720         if (!priv) {
 721                 /* URB was never linked! or will be soon given back by
 722                  * vhci_rx. */
 723                 spin_unlock_irqrestore(&the_controller->lock, flags);
 724                 return 0;
 725         }
 726
 727         {
 728                 int ret = 0;
 729                 ret = usb_hcd_check_unlink_urb(hcd, urb, status);
 730                 if (ret) {
 731                         spin_unlock_irqrestore(&the_controller->lock, flags);
 732                         return ret;
 733                 }
 734         }
 735
 736          /* send unlink request here? */
 737         vdev = priv->vdev;
 738
 739         if (!vdev->ud.tcp_socket) {
 740                 /* tcp connection is closed */
 741                 unsigned long flags2;
 742
 743                 spin_lock_irqsave(&vdev->priv_lock, flags2);
 744
 745                 usbip_uinfo("vhci_hcd: device %p seems to be disconnected\n",
 746                                                                         vdev);
 747                 list_del(&priv->list);
 748                 kfree(priv);
 749                 urb->hcpriv = NULL;
 750
 751                 spin_unlock_irqrestore(&vdev->priv_lock, flags2);
 752
 753                 /*
 754                  * If tcp connection is alive, we have sent CMD_UNLINK.
 755                  * vhci_rx will receive RET_UNLINK and give back the URB.
 756                  * Otherwise, we give back it here.
 757                  */
 758                 usbip_uinfo("vhci_hcd: vhci_urb_dequeue() gives back urb %p\n",
 759                                                                         urb);
 760
 761                 usb_hcd_unlink_urb_from_ep(hcd, urb);
 762
 763                 spin_unlock_irqrestore(&the_controller->lock, flags);
 764                 usb_hcd_giveback_urb(vhci_to_hcd(the_controller), urb,
 765                                                                 urb->status);
 766                 spin_lock_irqsave(&the_controller->lock, flags);
 767
 768         } else {
 769                 /* tcp connection is alive */
 770                 unsigned long flags2;
 771                 struct vhci_unlink *unlink;
 772
 773                 spin_lock_irqsave(&vdev->priv_lock, flags2);
 774
 775                 /* setup CMD_UNLINK pdu */
 776                 unlink = kzalloc(sizeof(struct vhci_unlink), GFP_ATOMIC);
 777                 if (!unlink) {
 778                         usbip_uerr("malloc vhci_unlink\n");
 779                         spin_unlock_irqrestore(&vdev->priv_lock, flags2);
 780                         spin_unlock_irqrestore(&the_controller->lock, flags);
 781                         usbip_event_add(&vdev->ud, VDEV_EVENT_ERROR_MALLOC);
 782                         return -ENOMEM;
 783                 }
 784
 785                 unlink->seqnum = atomic_inc_return(&the_controller->seqnum);
 786                 if (unlink->seqnum == 0xffff)
 787                         usbip_uinfo("seqnum max\n");
 788
 789                 unlink->unlink_seqnum = priv->seqnum;
 790
 791                 usbip_uinfo("vhci_hcd: device %p seems to be still connected\n",
 792                                                                         vdev);
 793
 794                 /* send cmd_unlink and try to cancel the pending URB in the
 795                  * peer */
 796                 list_add_tail(&unlink->list, &vdev->unlink_tx);
 797                 wake_up(&vdev->waitq_tx);
 798
 799                 spin_unlock_irqrestore(&vdev->priv_lock, flags2);
 800         }
 801
 802         spin_unlock_irqrestore(&the_controller->lock, flags);
 803
 804         usbip_dbg_vhci_hc("leave\n");
 805         return 0;
 806 }
 807
 808
 809 static void vhci_device_unlink_cleanup(struct vhci_device *vdev)
 810 {
 811         struct vhci_unlink *unlink, *tmp;
 812
 813         spin_lock(&vdev->priv_lock);
 814
 815         list_for_each_entry_safe(unlink, tmp, &vdev->unlink_tx, list) {
 816                 list_del(&unlink->list);
 817                 kfree(unlink);
 818         }
 819
 820         list_for_each_entry_safe(unlink, tmp, &vdev->unlink_rx, list) {
 821                 list_del(&unlink->list);
 822                 kfree(unlink);
 823         }
 824
 825         spin_unlock(&vdev->priv_lock);
 826 }
 827
 828 /*
 829  * The important thing is that only one context begins cleanup.
 830  * This is why error handling and cleanup become simple.
 831  * We do not want to consider race condition as possible.
 832  */
 833 static void vhci_shutdown_connection(struct usbip_device *ud)
 834 {
 835         struct vhci_device *vdev = container_of(ud, struct vhci_device, ud);
 836
 837         /* need this? see stub_dev.c */
 838         if (ud->tcp_socket) {
 839                 usbip_udbg("shutdown tcp_socket %p\n", ud->tcp_socket);
 840                 kernel_sock_shutdown(ud->tcp_socket, SHUT_RDWR);
 841         }
 842
 843         usbip_stop_threads(&vdev->ud);
 844         usbip_uinfo("stop threads\n");
 845
 846         /* active connection is closed */
 847         if (vdev->ud.tcp_socket != NULL) {
 848                 sock_release(vdev->ud.tcp_socket);
 849                 vdev->ud.tcp_socket = NULL;
 850         }
 851         usbip_uinfo("release socket\n");
 852
 853         vhci_device_unlink_cleanup(vdev);
 854
 855         /*
 856          * rh_port_disconnect() is a trigger of ...
 857          *   usb_disable_device():
 858          *      disable all the endpoints for a USB device.
 859          *   usb_disable_endpoint():
 860          *      disable endpoints. pending urbs are unlinked(dequeued).
 861          *
 862          * NOTE: After calling rh_port_disconnect(), the USB device drivers of a
 863          * deteched device should release used urbs in a cleanup function(i.e.
 864          * xxx_disconnect()). Therefore, vhci_hcd does not need to release
 865          * pushed urbs and their private data in this function.
 866          *
 867          * NOTE: vhci_dequeue() must be considered carefully. When shutdowning
 868          * a connection, vhci_shutdown_connection() expects vhci_dequeue()
 869          * gives back pushed urbs and frees their private data by request of
 870          * the cleanup function of a USB driver. When unlinking a urb with an
 871          * active connection, vhci_dequeue() does not give back the urb which
 872          * is actually given back by vhci_rx after receiving its return pdu.
 873          *
 874          */
 875         rh_port_disconnect(vdev->rhport);
 876
 877         usbip_uinfo("disconnect device\n");
 878 }
 879
 880
 881 static void vhci_device_reset(struct usbip_device *ud)
 882 {
 883         struct vhci_device *vdev = container_of(ud, struct vhci_device, ud);
 884
 885         spin_lock(&ud->lock);
 886
 887         vdev->speed  = 0;
 888         vdev->devid  = 0;
 889
 890         ud->tcp_socket = NULL;
 891
 892         ud->status = VDEV_ST_NULL;
 893
 894         spin_unlock(&ud->lock);
 895 }
 896
 897 static void vhci_device_unusable(struct usbip_device *ud)
 898 {
 899         spin_lock(&ud->lock);
 900
 901         ud->status = VDEV_ST_ERROR;
 902
 903         spin_unlock(&ud->lock);
 904 }
 905
 906 static void vhci_device_init(struct vhci_device *vdev)
 907 {
 908         memset(vdev, 0, sizeof(*vdev));
 909
 910         usbip_task_init(&vdev->ud.tcp_rx, "vhci_rx", vhci_rx_loop);
 911         usbip_task_init(&vdev->ud.tcp_tx, "vhci_tx", vhci_tx_loop);
 912
 913         vdev->ud.side   = USBIP_VHCI;
 914         vdev->ud.status = VDEV_ST_NULL;
 915         /* vdev->ud.lock   = SPIN_LOCK_UNLOCKED; */
 916         spin_lock_init(&vdev->ud.lock);
 917
 918         INIT_LIST_HEAD(&vdev->priv_rx);
 919         INIT_LIST_HEAD(&vdev->priv_tx);
 920         INIT_LIST_HEAD(&vdev->unlink_tx);
 921         INIT_LIST_HEAD(&vdev->unlink_rx);
 922         /* vdev->priv_lock = SPIN_LOCK_UNLOCKED; */
 923         spin_lock_init(&vdev->priv_lock);
 924
 925         init_waitqueue_head(&vdev->waitq_tx);
 926
 927         vdev->ud.eh_ops.shutdown = vhci_shutdown_connection;
 928         vdev->ud.eh_ops.reset = vhci_device_reset;
 929         vdev->ud.eh_ops.unusable = vhci_device_unusable;
 930
 931         usbip_start_eh(&vdev->ud);
 932 }
 933
 934
 935 /*----------------------------------------------------------------------*/
 936
 937 static int vhci_start(struct usb_hcd *hcd)
 938 {
 939         struct vhci_hcd *vhci = hcd_to_vhci(hcd);
 940         int rhport;
 941         int err = 0;
 942
 943         usbip_dbg_vhci_hc("enter vhci_start\n");
 944
 945
 946         /* initialize private data of usb_hcd */
 947
 948         for (rhport = 0; rhport < VHCI_NPORTS; rhport++) {
 949                 struct vhci_device *vdev = &vhci->vdev[rhport];
 950                 vhci_device_init(vdev);
 951                 vdev->rhport = rhport;
 952         }
 953
 954         atomic_set(&vhci->seqnum, 0);
 955         spin_lock_init(&vhci->lock);
 956
 957
 958
 959         hcd->power_budget = 0; /* no limit */
 960         hcd->state  = HC_STATE_RUNNING;
 961         hcd->uses_new_polling = 1;
 962
 963
 964         /* vhci_hcd is now ready to be controlled through sysfs */
 965         err = sysfs_create_group(&vhci_dev(vhci)->kobj, &dev_attr_group);
 966         if (err) {
 967                 usbip_uerr("create sysfs files\n");
 968                 return err;
 969         }
 970
 971         return 0;
 972 }
 973
 974 static void vhci_stop(struct usb_hcd *hcd)
 975 {
 976         struct vhci_hcd *vhci = hcd_to_vhci(hcd);
 977         int rhport = 0;
 978
 979         usbip_dbg_vhci_hc("stop VHCI controller\n");
 980
 981
 982         /* 1. remove the userland interface of vhci_hcd */
 983         sysfs_remove_group(&vhci_dev(vhci)->kobj, &dev_attr_group);
 984
 985         /* 2. shutdown all the ports of vhci_hcd */
 986         for (rhport = 0 ; rhport < VHCI_NPORTS; rhport++) {
 987                 struct vhci_device *vdev = &vhci->vdev[rhport];
 988
 989                 usbip_event_add(&vdev->ud, VDEV_EVENT_REMOVED);
 990                 usbip_stop_eh(&vdev->ud);
 991         }
 992
 993
 994         usbip_uinfo("vhci_stop done\n");
 995 }
 996
 997 /*----------------------------------------------------------------------*/
 998
 999 static int vhci_get_frame_number(struct usb_hcd *hcd)
1000 {
1001         usbip_uerr("Not yet implemented\n");
1002         return 0;
1003 }
1004
1005
1006 #ifdef CONFIG_PM
1007
1008 /* FIXME: suspend/resume */
1009 static int vhci_bus_suspend(struct usb_hcd *hcd)
1010 {
1011         struct vhci_hcd *vhci = hcd_to_vhci(hcd);
1012
1013         dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
1014
1015         spin_lock_irq(&vhci->lock);
1016         /* vhci->rh_state = DUMMY_RH_SUSPENDED;
1017          * set_link_state(vhci); */
1018         hcd->state = HC_STATE_SUSPENDED;
1019         spin_unlock_irq(&vhci->lock);
1020
1021         return 0;
1022 }
1023
1024 static int vhci_bus_resume(struct usb_hcd *hcd)
1025 {
1026         struct vhci_hcd *vhci = hcd_to_vhci(hcd);
1027         int rc = 0;
1028
1029         dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
1030
1031         spin_lock_irq(&vhci->lock);
1032         if (!HCD_HW_ACCESSIBLE(hcd)) {
1033                 rc = -ESHUTDOWN;
1034         } else {
1035                 /* vhci->rh_state = DUMMY_RH_RUNNING;
1036                  * set_link_state(vhci);
1037                  * if (!list_empty(&vhci->urbp_list))
1038                  *      mod_timer(&vhci->timer, jiffies); */
1039                 hcd->state = HC_STATE_RUNNING;
1040         }
1041         spin_unlock_irq(&vhci->lock);
1042         return rc;
1043
1044         return 0;
1045 }
1046
1047 #else
1048
1049 #define vhci_bus_suspend      NULL
1050 #define vhci_bus_resume       NULL
1051 #endif
1052
1053
1054
1055 static struct hc_driver vhci_hc_driver = {
1056         .description    = driver_name,
1057         .product_desc   = driver_desc,
1058         .hcd_priv_size  = sizeof(struct vhci_hcd),
1059
1060         .flags          = HCD_USB2,
1061
1062         .start          = vhci_start,
1063         .stop           = vhci_stop,
1064
1065         .urb_enqueue    = vhci_urb_enqueue,
1066         .urb_dequeue    = vhci_urb_dequeue,
1067
1068         .get_frame_number = vhci_get_frame_number,
1069
1070         .hub_status_data = vhci_hub_status,
1071         .hub_control    = vhci_hub_control,
1072         .bus_suspend    = vhci_bus_suspend,
1073         .bus_resume     = vhci_bus_resume,
1074 };
1075
1076 static int vhci_hcd_probe(struct platform_device *pdev)
1077 {
1078         struct usb_hcd          *hcd;
1079         int                     ret;
1080
1081         usbip_uinfo("proving...\n");
1082
1083         usbip_dbg_vhci_hc("name %s id %d\n", pdev->name, pdev->id);
1084
1085         /* will be removed */
1086         if (pdev->dev.dma_mask) {
1087                 dev_info(&pdev->dev, "vhci_hcd DMA not supported\n");
1088                 return -EINVAL;
1089         }
1090
1091         /*
1092          * Allocate and initialize hcd.
1093          * Our private data is also allocated automatically.
1094          */
1095         hcd = usb_create_hcd(&vhci_hc_driver, &pdev->dev, dev_name(&pdev->dev));
1096         if (!hcd) {
1097                 usbip_uerr("create hcd failed\n");
1098                 return -ENOMEM;
1099         }
1100
1101
1102         /* this is private data for vhci_hcd */
1103         the_controller = hcd_to_vhci(hcd);
1104
1105         /*
1106          * Finish generic HCD structure initialization and register.
1107          * Call the driver's reset() and start() routines.
1108          */
1109         ret = usb_add_hcd(hcd, 0, 0);
1110         if (ret != 0) {
1111                 usbip_uerr("usb_add_hcd failed %d\n", ret);
1112                 usb_put_hcd(hcd);
1113                 the_controller = NULL;
1114                 return ret;
1115         }
1116
1117
1118         usbip_dbg_vhci_hc("bye\n");
1119         return 0;
1120 }
1121
1122
1123 static int vhci_hcd_remove(struct platform_device *pdev)
1124 {
1125         struct usb_hcd  *hcd;
1126
1127         hcd = platform_get_drvdata(pdev);
1128         if (!hcd)
1129                 return 0;
1130
1131         /*
1132          * Disconnects the root hub,
1133          * then reverses the effects of usb_add_hcd(),
1134          * invoking the HCD's stop() methods.
1135          */
1136         usb_remove_hcd(hcd);
1137         usb_put_hcd(hcd);
1138         the_controller = NULL;
1139
1140
1141         return 0;
1142 }
1143
1144
1145
1146 #ifdef CONFIG_PM
1147
1148 /* what should happen for USB/IP under suspend/resume? */
1149 static int vhci_hcd_suspend(struct platform_device *pdev, pm_message_t state)
1150 {
1151         struct usb_hcd *hcd;
1152         int rhport = 0;
1153         int connected = 0;
1154         int ret = 0;
1155
1156         dev_dbg(&pdev->dev, "%s\n", __func__);
1157
1158         hcd = platform_get_drvdata(pdev);
1159
1160         spin_lock(&the_controller->lock);
1161
1162         for (rhport = 0; rhport < VHCI_NPORTS; rhport++)
1163                 if (the_controller->port_status[rhport] &
1164                                                 USB_PORT_STAT_CONNECTION)
1165                         connected += 1;
1166
1167         spin_unlock(&the_controller->lock);
1168
1169         if (connected > 0) {
1170                 usbip_uinfo("We have %d active connection%s. Do not suspend.\n",
1171                                 connected, (connected == 1 ? "" : "s"));
1172                 ret =  -EBUSY;
1173         } else {
1174                 usbip_uinfo("suspend vhci_hcd");
1175                 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1176         }
1177
1178         return ret;
1179 }
1180
1181 static int vhci_hcd_resume(struct platform_device *pdev)
1182 {
1183         struct usb_hcd *hcd;
1184
1185         dev_dbg(&pdev->dev, "%s\n", __func__);
1186
1187         hcd = platform_get_drvdata(pdev);
1188         set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1189         usb_hcd_poll_rh_status(hcd);
1190
1191         return 0;
1192 }
1193
1194 #else
1195
1196 #define vhci_hcd_suspend        NULL
1197 #define vhci_hcd_resume         NULL
1198
1199 #endif
1200
1201
1202 static struct platform_driver vhci_driver = {
1203         .probe  = vhci_hcd_probe,
1204         .remove = __devexit_p(vhci_hcd_remove),
1205         .suspend = vhci_hcd_suspend,
1206         .resume = vhci_hcd_resume,
1207         .driver = {
1208                 .name = (char *) driver_name,
1209                 .owner = THIS_MODULE,
1210         },
1211 };
1212
1213 /*----------------------------------------------------------------------*/
1214
1215 /*
1216  * The VHCI 'device' is 'virtual'; not a real plug&play hardware.
1217  * We need to add this virtual device as a platform device arbitrarily:
1218  *      1. platform_device_register()
1219  */
1220 static void the_pdev_release(struct device *dev)
1221 {
1222         return;
1223 }
1224
1225 static struct platform_device the_pdev = {
1226         /* should be the same name as driver_name */
1227         .name = (char *) driver_name,
1228         .id = -1,
1229         .dev = {
1230                 /* .driver = &vhci_driver, */
1231                 .release = the_pdev_release,
1232         },
1233 };
1234
1235 static int __init vhci_init(void)
1236 {
1237         int ret;
1238
1239         usbip_dbg_vhci_hc("enter\n");
1240         if (usb_disabled())
1241                 return -ENODEV;
1242
1243         printk(KERN_INFO KBUILD_MODNAME ": %s, %s\n", driver_name,
1244                DRIVER_VERSION);
1245
1246         ret = platform_driver_register(&vhci_driver);
1247         if (ret < 0)
1248                 goto err_driver_register;
1249
1250         ret = platform_device_register(&the_pdev);
1251         if (ret < 0)
1252                 goto err_platform_device_register;
1253
1254         usbip_dbg_vhci_hc("bye\n");
1255         return ret;
1256
1257         /* error occurred */
1258 err_platform_device_register:
1259         platform_driver_unregister(&vhci_driver);
1260
1261 err_driver_register:
1262         usbip_dbg_vhci_hc("bye\n");
1263         return ret;
1264 }
1265 module_init(vhci_init);
1266
1267 static void __exit vhci_cleanup(void)
1268 {
1269         usbip_dbg_vhci_hc("enter\n");
1270
1271         platform_device_unregister(&the_pdev);
1272         platform_driver_unregister(&vhci_driver);
1273
1274         usbip_dbg_vhci_hc("bye\n");
1275 }
1276 module_exit(vhci_cleanup);