2 * Copyright (C) 2003-2008 Takahiro Hirofuchi
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.
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.
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,
20 #include <linux/device.h>
21 #include <linux/file.h>
22 #include <linux/kthread.h>
23 #include <linux/module.h>
25 #include "usbip_common.h"
29 * Define device IDs here if you want to explicitly limit exportable devices.
30 * In most cases, wildcard matching will be okay because driver binding can be
31 * changed dynamically by a userland program.
33 static struct usb_device_id stub_table[] = {
36 { USB_DEVICE(0x05ac, 0x0301) }, /* Mac 1 button mouse */
37 { USB_DEVICE(0x0430, 0x0009) }, /* Plat Home Keyboard */
38 { USB_DEVICE(0x059b, 0x0001) }, /* Iomega USB Zip 100 */
39 { USB_DEVICE(0x04b3, 0x4427) }, /* IBM USB CD-ROM */
40 { USB_DEVICE(0x05a9, 0xa511) }, /* LifeView USB cam */
41 { USB_DEVICE(0x55aa, 0x0201) }, /* Imation card reader */
42 { USB_DEVICE(0x046d, 0x0870) }, /* Qcam Express(QV-30) */
43 { USB_DEVICE(0x04bb, 0x0101) }, /* IO-DATA HD 120GB */
44 { USB_DEVICE(0x04bb, 0x0904) }, /* IO-DATA USB-ET/TX */
45 { USB_DEVICE(0x04bb, 0x0201) }, /* IO-DATA USB-ET/TX */
46 { USB_DEVICE(0x08bb, 0x2702) }, /* ONKYO USB Speaker */
47 { USB_DEVICE(0x046d, 0x08b2) }, /* Logicool Qcam 4000 Pro */
49 /* magic for wild card */
51 { 0, } /* Terminating entry */
53 MODULE_DEVICE_TABLE(usb, stub_table);
56 * usbip_status shows the status of usbip-host as long as this driver is bound
57 * to the target device.
59 static ssize_t show_status(struct device *dev, struct device_attribute *attr,
62 struct stub_device *sdev = dev_get_drvdata(dev);
66 dev_err(dev, "sdev is null\n");
70 spin_lock(&sdev->ud.lock);
71 status = sdev->ud.status;
72 spin_unlock(&sdev->ud.lock);
74 return snprintf(buf, PAGE_SIZE, "%d\n", status);
76 static DEVICE_ATTR(usbip_status, S_IRUGO, show_status, NULL);
79 * usbip_sockfd gets a socket descriptor of an established TCP connection that
80 * is used to transfer usbip requests by kernel threads. -1 is a magic number
81 * by which usbip connection is finished.
83 static ssize_t store_sockfd(struct device *dev, struct device_attribute *attr,
84 const char *buf, size_t count)
86 struct stub_device *sdev = dev_get_drvdata(dev);
88 struct socket *socket;
91 dev_err(dev, "sdev is null\n");
95 sscanf(buf, "%d", &sockfd);
98 dev_info(dev, "stub up\n");
100 spin_lock(&sdev->ud.lock);
102 if (sdev->ud.status != SDEV_ST_AVAILABLE) {
103 dev_err(dev, "not ready\n");
104 spin_unlock(&sdev->ud.lock);
108 socket = sockfd_to_socket(sockfd);
110 spin_unlock(&sdev->ud.lock);
113 sdev->ud.tcp_socket = socket;
115 spin_unlock(&sdev->ud.lock);
117 sdev->ud.tcp_rx = kthread_get_run(stub_rx_loop, &sdev->ud, "stub_rx");
118 sdev->ud.tcp_tx = kthread_get_run(stub_tx_loop, &sdev->ud, "stub_tx");
120 spin_lock(&sdev->ud.lock);
121 sdev->ud.status = SDEV_ST_USED;
122 spin_unlock(&sdev->ud.lock);
125 dev_info(dev, "stub down\n");
127 spin_lock(&sdev->ud.lock);
128 if (sdev->ud.status != SDEV_ST_USED) {
129 spin_unlock(&sdev->ud.lock);
132 spin_unlock(&sdev->ud.lock);
134 usbip_event_add(&sdev->ud, SDEV_EVENT_DOWN);
139 static DEVICE_ATTR(usbip_sockfd, S_IWUSR, NULL, store_sockfd);
141 static int stub_add_files(struct device *dev)
145 err = device_create_file(dev, &dev_attr_usbip_status);
149 err = device_create_file(dev, &dev_attr_usbip_sockfd);
153 err = device_create_file(dev, &dev_attr_usbip_debug);
160 device_remove_file(dev, &dev_attr_usbip_sockfd);
162 device_remove_file(dev, &dev_attr_usbip_status);
167 static void stub_remove_files(struct device *dev)
169 device_remove_file(dev, &dev_attr_usbip_status);
170 device_remove_file(dev, &dev_attr_usbip_sockfd);
171 device_remove_file(dev, &dev_attr_usbip_debug);
174 static void stub_shutdown_connection(struct usbip_device *ud)
176 struct stub_device *sdev = container_of(ud, struct stub_device, ud);
179 * When removing an exported device, kernel panic sometimes occurred
180 * and then EIP was sk_wait_data of stub_rx thread. Is this because
181 * sk_wait_data returned though stub_rx thread was already finished by
184 if (ud->tcp_socket) {
185 dev_dbg(&sdev->udev->dev, "shutdown tcp_socket %p\n",
187 kernel_sock_shutdown(ud->tcp_socket, SHUT_RDWR);
190 /* 1. stop threads */
192 kthread_stop_put(ud->tcp_rx);
196 kthread_stop_put(ud->tcp_tx);
201 * 2. close the socket
203 * tcp_socket is freed after threads are killed so that usbip_xmit does
204 * not touch NULL socket.
206 if (ud->tcp_socket) {
207 fput(ud->tcp_socket->file);
208 ud->tcp_socket = NULL;
211 /* 3. free used data */
212 stub_device_cleanup_urbs(sdev);
214 /* 4. free stub_unlink */
217 struct stub_unlink *unlink, *tmp;
219 spin_lock_irqsave(&sdev->priv_lock, flags);
220 list_for_each_entry_safe(unlink, tmp, &sdev->unlink_tx, list) {
221 list_del(&unlink->list);
224 list_for_each_entry_safe(unlink, tmp, &sdev->unlink_free,
226 list_del(&unlink->list);
229 spin_unlock_irqrestore(&sdev->priv_lock, flags);
233 static void stub_device_reset(struct usbip_device *ud)
235 struct stub_device *sdev = container_of(ud, struct stub_device, ud);
236 struct usb_device *udev = sdev->udev;
239 dev_dbg(&udev->dev, "device reset");
241 ret = usb_lock_device_for_reset(udev, sdev->interface);
243 dev_err(&udev->dev, "lock for reset\n");
244 spin_lock(&ud->lock);
245 ud->status = SDEV_ST_ERROR;
246 spin_unlock(&ud->lock);
250 /* try to reset the device */
251 ret = usb_reset_device(udev);
252 usb_unlock_device(udev);
254 spin_lock(&ud->lock);
256 dev_err(&udev->dev, "device reset\n");
257 ud->status = SDEV_ST_ERROR;
259 dev_info(&udev->dev, "device reset\n");
260 ud->status = SDEV_ST_AVAILABLE;
262 spin_unlock(&ud->lock);
265 static void stub_device_unusable(struct usbip_device *ud)
267 spin_lock(&ud->lock);
268 ud->status = SDEV_ST_ERROR;
269 spin_unlock(&ud->lock);
273 * stub_device_alloc - allocate a new stub_device struct
274 * @interface: usb_interface of a new device
276 * Allocates and initializes a new stub_device struct.
278 static struct stub_device *stub_device_alloc(struct usb_device *udev,
279 struct usb_interface *interface)
281 struct stub_device *sdev;
282 int busnum = interface_to_busnum(interface);
283 int devnum = interface_to_devnum(interface);
285 dev_dbg(&interface->dev, "allocating stub device");
287 /* yes, it's a new device */
288 sdev = kzalloc(sizeof(struct stub_device), GFP_KERNEL);
290 dev_err(&interface->dev, "no memory for stub_device\n");
294 sdev->interface = usb_get_intf(interface);
295 sdev->udev = usb_get_dev(udev);
298 * devid is defined with devnum when this driver is first allocated.
299 * devnum may change later if a device is reset. However, devid never
300 * changes during a usbip connection.
302 sdev->devid = (busnum << 16) | devnum;
303 sdev->ud.side = USBIP_STUB;
304 sdev->ud.status = SDEV_ST_AVAILABLE;
305 spin_lock_init(&sdev->ud.lock);
306 sdev->ud.tcp_socket = NULL;
308 INIT_LIST_HEAD(&sdev->priv_init);
309 INIT_LIST_HEAD(&sdev->priv_tx);
310 INIT_LIST_HEAD(&sdev->priv_free);
311 INIT_LIST_HEAD(&sdev->unlink_free);
312 INIT_LIST_HEAD(&sdev->unlink_tx);
313 spin_lock_init(&sdev->priv_lock);
315 init_waitqueue_head(&sdev->tx_waitq);
317 sdev->ud.eh_ops.shutdown = stub_shutdown_connection;
318 sdev->ud.eh_ops.reset = stub_device_reset;
319 sdev->ud.eh_ops.unusable = stub_device_unusable;
321 usbip_start_eh(&sdev->ud);
323 dev_dbg(&interface->dev, "register new interface\n");
328 static int stub_device_free(struct stub_device *sdev)
334 pr_debug("kfree udev ok\n");
340 * If a usb device has multiple active interfaces, this driver is bound to all
341 * the active interfaces. However, usbip exports *a* usb device (i.e., not *an*
342 * active interface). Currently, a userland program must ensure that it
343 * looks at the usbip's sysfs entries of only the first active interface.
345 * TODO: use "struct usb_device_driver" to bind a usb device.
346 * However, it seems it is not fully supported in mainline kernel yet
349 static int stub_probe(struct usb_interface *interface,
350 const struct usb_device_id *id)
352 struct usb_device *udev = interface_to_usbdev(interface);
353 struct stub_device *sdev = NULL;
354 const char *udev_busid = dev_name(interface->dev.parent);
356 struct bus_id_priv *busid_priv;
358 dev_dbg(&interface->dev, "Enter\n");
360 /* check we should claim or not by busid_table */
361 busid_priv = get_busid_priv(udev_busid);
362 if (!busid_priv || (busid_priv->status == STUB_BUSID_REMOV) ||
363 (busid_priv->status == STUB_BUSID_OTHER)) {
364 dev_info(&interface->dev, "%s is not in match_busid table... "
365 "skip!\n", udev_busid);
368 * Return value should be ENODEV or ENOXIO to continue trying
369 * other matched drivers by the driver core.
370 * See driver_probe_device() in driver/base/dd.c
375 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB) {
376 dev_dbg(&udev->dev, "%s is a usb hub device... skip!\n",
381 if (!strcmp(udev->bus->bus_name, "vhci_hcd")) {
382 dev_dbg(&udev->dev, "%s is attached on vhci_hcd... skip!\n",
387 if (busid_priv->status == STUB_BUSID_ALLOC) {
388 sdev = busid_priv->sdev;
392 busid_priv->interf_count++;
393 dev_info(&interface->dev, "usbip-host: register new interface "
394 "(bus %u dev %u ifn %u)\n",
395 udev->bus->busnum, udev->devnum,
396 interface->cur_altsetting->desc.bInterfaceNumber);
398 /* set private data to usb_interface */
399 usb_set_intfdata(interface, sdev);
401 err = stub_add_files(&interface->dev);
403 dev_err(&interface->dev, "stub_add_files for %s\n",
405 usb_set_intfdata(interface, NULL);
406 busid_priv->interf_count--;
410 usb_get_intf(interface);
414 /* ok, this is my device */
415 sdev = stub_device_alloc(udev, interface);
419 dev_info(&interface->dev, "usbip-host: register new device "
420 "(bus %u dev %u ifn %u)\n", udev->bus->busnum, udev->devnum,
421 interface->cur_altsetting->desc.bInterfaceNumber);
423 busid_priv->interf_count = 0;
424 busid_priv->shutdown_busid = 0;
426 /* set private data to usb_interface */
427 usb_set_intfdata(interface, sdev);
428 busid_priv->interf_count++;
429 busid_priv->sdev = sdev;
431 err = stub_add_files(&interface->dev);
433 dev_err(&interface->dev, "stub_add_files for %s\n", udev_busid);
434 usb_set_intfdata(interface, NULL);
435 usb_put_intf(interface);
437 kthread_stop_put(sdev->ud.eh);
439 busid_priv->interf_count = 0;
440 busid_priv->sdev = NULL;
441 stub_device_free(sdev);
444 busid_priv->status = STUB_BUSID_ALLOC;
449 static void shutdown_busid(struct bus_id_priv *busid_priv)
451 if (busid_priv->sdev && !busid_priv->shutdown_busid) {
452 busid_priv->shutdown_busid = 1;
453 usbip_event_add(&busid_priv->sdev->ud, SDEV_EVENT_REMOVED);
455 /* 2. wait for the stop of the event handler */
456 usbip_stop_eh(&busid_priv->sdev->ud);
461 * called in usb_disconnect() or usb_deregister()
462 * but only if actconfig(active configuration) exists
464 static void stub_disconnect(struct usb_interface *interface)
466 struct stub_device *sdev;
467 const char *udev_busid = dev_name(interface->dev.parent);
468 struct bus_id_priv *busid_priv;
470 dev_dbg(&interface->dev, "Enter\n");
472 busid_priv = get_busid_priv(udev_busid);
478 sdev = usb_get_intfdata(interface);
480 /* get stub_device */
482 dev_err(&interface->dev, "could not get device");
486 usb_set_intfdata(interface, NULL);
489 * NOTE: rx/tx threads are invoked for each usb_device.
491 stub_remove_files(&interface->dev);
493 /* If usb reset is called from event handler */
494 if (busid_priv->sdev->ud.eh == current) {
495 busid_priv->interf_count--;
499 if (busid_priv->interf_count > 1) {
500 busid_priv->interf_count--;
501 shutdown_busid(busid_priv);
502 usb_put_intf(interface);
506 busid_priv->interf_count = 0;
508 /* shutdown the current connection */
509 shutdown_busid(busid_priv);
511 usb_put_dev(sdev->udev);
512 usb_put_intf(interface);
515 busid_priv->sdev = NULL;
516 stub_device_free(sdev);
518 if (busid_priv->status == STUB_BUSID_ALLOC) {
519 busid_priv->status = STUB_BUSID_ADDED;
521 busid_priv->status = STUB_BUSID_OTHER;
522 del_match_busid((char *)udev_busid);
527 * Presence of pre_reset and post_reset prevents the driver from being unbound
528 * when the device is being reset
531 int stub_pre_reset(struct usb_interface *interface)
533 dev_dbg(&interface->dev, "pre_reset\n");
537 int stub_post_reset(struct usb_interface *interface)
539 dev_dbg(&interface->dev, "post_reset\n");
543 struct usb_driver stub_driver = {
544 .name = "usbip-host",
546 .disconnect = stub_disconnect,
547 .id_table = stub_table,
548 .pre_reset = stub_pre_reset,
549 .post_reset = stub_post_reset,