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