Commit | Line | Data |
---|---|---|
5fd54ace | 1 | // SPDX-License-Identifier: GPL-2.0+ |
4d7b5c7f TH |
2 | /* |
3 | * Copyright (C) 2003-2008 Takahiro Hirofuchi | |
4d7b5c7f TH |
4 | */ |
5 | ||
7aaacb43 | 6 | #include <linux/device.h> |
3d0a2a22 | 7 | #include <linux/file.h> |
9720b4bc | 8 | #include <linux/kthread.h> |
99c97852 | 9 | #include <linux/module.h> |
5a0e3ad6 | 10 | |
4d7b5c7f TH |
11 | #include "usbip_common.h" |
12 | #include "stub.h" | |
13 | ||
4d7b5c7f | 14 | /* |
d012c2a5 | 15 | * usbip_status shows the status of usbip-host as long as this driver is bound |
16 | * to the target device. | |
4d7b5c7f | 17 | */ |
b1f56aca GKH |
18 | static ssize_t usbip_status_show(struct device *dev, |
19 | struct device_attribute *attr, char *buf) | |
4d7b5c7f TH |
20 | { |
21 | struct stub_device *sdev = dev_get_drvdata(dev); | |
22 | int status; | |
23 | ||
24 | if (!sdev) { | |
25 | dev_err(dev, "sdev is null\n"); | |
26 | return -ENODEV; | |
27 | } | |
28 | ||
dcf14779 | 29 | spin_lock_irq(&sdev->ud.lock); |
4d7b5c7f | 30 | status = sdev->ud.status; |
dcf14779 | 31 | spin_unlock_irq(&sdev->ud.lock); |
4d7b5c7f TH |
32 | |
33 | return snprintf(buf, PAGE_SIZE, "%d\n", status); | |
34 | } | |
b1f56aca | 35 | static DEVICE_ATTR_RO(usbip_status); |
4d7b5c7f TH |
36 | |
37 | /* | |
38 | * usbip_sockfd gets a socket descriptor of an established TCP connection that | |
39 | * is used to transfer usbip requests by kernel threads. -1 is a magic number | |
40 | * by which usbip connection is finished. | |
41 | */ | |
ca35910a | 42 | static ssize_t usbip_sockfd_store(struct device *dev, struct device_attribute *attr, |
4d7b5c7f TH |
43 | const char *buf, size_t count) |
44 | { | |
45 | struct stub_device *sdev = dev_get_drvdata(dev); | |
46 | int sockfd = 0; | |
47 | struct socket *socket; | |
f8cfc023 | 48 | int rv; |
4d7b5c7f TH |
49 | |
50 | if (!sdev) { | |
51 | dev_err(dev, "sdev is null\n"); | |
52 | return -ENODEV; | |
53 | } | |
54 | ||
f8cfc023 EO |
55 | rv = sscanf(buf, "%d", &sockfd); |
56 | if (rv != 1) | |
57 | return -EINVAL; | |
4d7b5c7f TH |
58 | |
59 | if (sockfd != -1) { | |
964ea96e | 60 | int err; |
3eed8c03 | 61 | |
4d7b5c7f TH |
62 | dev_info(dev, "stub up\n"); |
63 | ||
dcf14779 | 64 | spin_lock_irq(&sdev->ud.lock); |
4d7b5c7f TH |
65 | |
66 | if (sdev->ud.status != SDEV_ST_AVAILABLE) { | |
67 | dev_err(dev, "not ready\n"); | |
31398f63 | 68 | goto err; |
4d7b5c7f TH |
69 | } |
70 | ||
964ea96e | 71 | socket = sockfd_lookup(sockfd, &err); |
31398f63 KK |
72 | if (!socket) |
73 | goto err; | |
74 | ||
4d7b5c7f | 75 | sdev->ud.tcp_socket = socket; |
009f41ae | 76 | sdev->ud.sockfd = sockfd; |
4d7b5c7f | 77 | |
dcf14779 | 78 | spin_unlock_irq(&sdev->ud.lock); |
4d7b5c7f | 79 | |
8c4e5834 KK |
80 | sdev->ud.tcp_rx = kthread_get_run(stub_rx_loop, &sdev->ud, |
81 | "stub_rx"); | |
82 | sdev->ud.tcp_tx = kthread_get_run(stub_tx_loop, &sdev->ud, | |
83 | "stub_tx"); | |
4d7b5c7f | 84 | |
dcf14779 | 85 | spin_lock_irq(&sdev->ud.lock); |
4d7b5c7f | 86 | sdev->ud.status = SDEV_ST_USED; |
dcf14779 | 87 | spin_unlock_irq(&sdev->ud.lock); |
4d7b5c7f TH |
88 | |
89 | } else { | |
90 | dev_info(dev, "stub down\n"); | |
91 | ||
dcf14779 | 92 | spin_lock_irq(&sdev->ud.lock); |
31398f63 KK |
93 | if (sdev->ud.status != SDEV_ST_USED) |
94 | goto err; | |
95 | ||
dcf14779 | 96 | spin_unlock_irq(&sdev->ud.lock); |
4d7b5c7f TH |
97 | |
98 | usbip_event_add(&sdev->ud, SDEV_EVENT_DOWN); | |
99 | } | |
100 | ||
101 | return count; | |
31398f63 KK |
102 | |
103 | err: | |
104 | spin_unlock_irq(&sdev->ud.lock); | |
964ea96e | 105 | return -EINVAL; |
4d7b5c7f | 106 | } |
ca35910a | 107 | static DEVICE_ATTR_WO(usbip_sockfd); |
4d7b5c7f TH |
108 | |
109 | static int stub_add_files(struct device *dev) | |
110 | { | |
111 | int err = 0; | |
112 | ||
113 | err = device_create_file(dev, &dev_attr_usbip_status); | |
114 | if (err) | |
115 | goto err_status; | |
116 | ||
117 | err = device_create_file(dev, &dev_attr_usbip_sockfd); | |
118 | if (err) | |
119 | goto err_sockfd; | |
120 | ||
121 | err = device_create_file(dev, &dev_attr_usbip_debug); | |
122 | if (err) | |
123 | goto err_debug; | |
124 | ||
125 | return 0; | |
126 | ||
127 | err_debug: | |
128 | device_remove_file(dev, &dev_attr_usbip_sockfd); | |
4d7b5c7f TH |
129 | err_sockfd: |
130 | device_remove_file(dev, &dev_attr_usbip_status); | |
4d7b5c7f TH |
131 | err_status: |
132 | return err; | |
133 | } | |
134 | ||
135 | static void stub_remove_files(struct device *dev) | |
136 | { | |
137 | device_remove_file(dev, &dev_attr_usbip_status); | |
138 | device_remove_file(dev, &dev_attr_usbip_sockfd); | |
139 | device_remove_file(dev, &dev_attr_usbip_debug); | |
140 | } | |
141 | ||
4d7b5c7f TH |
142 | static void stub_shutdown_connection(struct usbip_device *ud) |
143 | { | |
144 | struct stub_device *sdev = container_of(ud, struct stub_device, ud); | |
145 | ||
146 | /* | |
147 | * When removing an exported device, kernel panic sometimes occurred | |
148 | * and then EIP was sk_wait_data of stub_rx thread. Is this because | |
149 | * sk_wait_data returned though stub_rx thread was already finished by | |
150 | * step 1? | |
151 | */ | |
152 | if (ud->tcp_socket) { | |
90120d15 | 153 | dev_dbg(&sdev->udev->dev, "shutdown sockfd %d\n", ud->sockfd); |
4d7b5c7f TH |
154 | kernel_sock_shutdown(ud->tcp_socket, SHUT_RDWR); |
155 | } | |
156 | ||
157 | /* 1. stop threads */ | |
b7caecb8 | 158 | if (ud->tcp_rx) { |
ba46ce30 | 159 | kthread_stop_put(ud->tcp_rx); |
b7caecb8 | 160 | ud->tcp_rx = NULL; |
161 | } | |
162 | if (ud->tcp_tx) { | |
ba46ce30 | 163 | kthread_stop_put(ud->tcp_tx); |
b7caecb8 | 164 | ud->tcp_tx = NULL; |
165 | } | |
4d7b5c7f | 166 | |
4d7b5c7f | 167 | /* |
87352760 | 168 | * 2. close the socket |
169 | * | |
170 | * tcp_socket is freed after threads are killed so that usbip_xmit does | |
171 | * not touch NULL socket. | |
4d7b5c7f TH |
172 | */ |
173 | if (ud->tcp_socket) { | |
964ea96e | 174 | sockfd_put(ud->tcp_socket); |
4d7b5c7f | 175 | ud->tcp_socket = NULL; |
009f41ae | 176 | ud->sockfd = -1; |
4d7b5c7f TH |
177 | } |
178 | ||
179 | /* 3. free used data */ | |
180 | stub_device_cleanup_urbs(sdev); | |
181 | ||
182 | /* 4. free stub_unlink */ | |
183 | { | |
184 | unsigned long flags; | |
185 | struct stub_unlink *unlink, *tmp; | |
186 | ||
187 | spin_lock_irqsave(&sdev->priv_lock, flags); | |
4d7b5c7f TH |
188 | list_for_each_entry_safe(unlink, tmp, &sdev->unlink_tx, list) { |
189 | list_del(&unlink->list); | |
190 | kfree(unlink); | |
191 | } | |
87352760 | 192 | list_for_each_entry_safe(unlink, tmp, &sdev->unlink_free, |
193 | list) { | |
4d7b5c7f TH |
194 | list_del(&unlink->list); |
195 | kfree(unlink); | |
196 | } | |
4d7b5c7f TH |
197 | spin_unlock_irqrestore(&sdev->priv_lock, flags); |
198 | } | |
199 | } | |
200 | ||
201 | static void stub_device_reset(struct usbip_device *ud) | |
202 | { | |
203 | struct stub_device *sdev = container_of(ud, struct stub_device, ud); | |
2d8f4595 | 204 | struct usb_device *udev = sdev->udev; |
4d7b5c7f TH |
205 | int ret; |
206 | ||
1a4b6f66 | 207 | dev_dbg(&udev->dev, "device reset"); |
2d8f4595 | 208 | |
8c7003a3 | 209 | ret = usb_lock_device_for_reset(udev, NULL); |
4d7b5c7f TH |
210 | if (ret < 0) { |
211 | dev_err(&udev->dev, "lock for reset\n"); | |
dcf14779 | 212 | spin_lock_irq(&ud->lock); |
4d7b5c7f | 213 | ud->status = SDEV_ST_ERROR; |
dcf14779 | 214 | spin_unlock_irq(&ud->lock); |
4d7b5c7f TH |
215 | return; |
216 | } | |
217 | ||
218 | /* try to reset the device */ | |
219 | ret = usb_reset_device(udev); | |
4d7b5c7f TH |
220 | usb_unlock_device(udev); |
221 | ||
dcf14779 | 222 | spin_lock_irq(&ud->lock); |
4d7b5c7f TH |
223 | if (ret) { |
224 | dev_err(&udev->dev, "device reset\n"); | |
225 | ud->status = SDEV_ST_ERROR; | |
4d7b5c7f TH |
226 | } else { |
227 | dev_info(&udev->dev, "device reset\n"); | |
228 | ud->status = SDEV_ST_AVAILABLE; | |
4d7b5c7f | 229 | } |
dcf14779 | 230 | spin_unlock_irq(&ud->lock); |
4d7b5c7f TH |
231 | } |
232 | ||
233 | static void stub_device_unusable(struct usbip_device *ud) | |
234 | { | |
dcf14779 | 235 | spin_lock_irq(&ud->lock); |
4d7b5c7f | 236 | ud->status = SDEV_ST_ERROR; |
dcf14779 | 237 | spin_unlock_irq(&ud->lock); |
4d7b5c7f TH |
238 | } |
239 | ||
4d7b5c7f TH |
240 | /** |
241 | * stub_device_alloc - allocate a new stub_device struct | |
8c7003a3 | 242 | * @udev: usb_device of a new device |
4d7b5c7f TH |
243 | * |
244 | * Allocates and initializes a new stub_device struct. | |
245 | */ | |
b7945b77 | 246 | static struct stub_device *stub_device_alloc(struct usb_device *udev) |
4d7b5c7f TH |
247 | { |
248 | struct stub_device *sdev; | |
b7945b77 VM |
249 | int busnum = udev->bus->busnum; |
250 | int devnum = udev->devnum; | |
4d7b5c7f | 251 | |
b7945b77 | 252 | dev_dbg(&udev->dev, "allocating stub device"); |
4d7b5c7f TH |
253 | |
254 | /* yes, it's a new device */ | |
255 | sdev = kzalloc(sizeof(struct stub_device), GFP_KERNEL); | |
78110bb8 | 256 | if (!sdev) |
4d7b5c7f | 257 | return NULL; |
4d7b5c7f | 258 | |
2d8f4595 | 259 | sdev->udev = usb_get_dev(udev); |
4d7b5c7f TH |
260 | |
261 | /* | |
262 | * devid is defined with devnum when this driver is first allocated. | |
263 | * devnum may change later if a device is reset. However, devid never | |
264 | * changes during a usbip connection. | |
265 | */ | |
b744a45f | 266 | sdev->devid = (busnum << 16) | devnum; |
267 | sdev->ud.side = USBIP_STUB; | |
268 | sdev->ud.status = SDEV_ST_AVAILABLE; | |
4d7b5c7f | 269 | spin_lock_init(&sdev->ud.lock); |
b744a45f | 270 | sdev->ud.tcp_socket = NULL; |
009f41ae | 271 | sdev->ud.sockfd = -1; |
4d7b5c7f TH |
272 | |
273 | INIT_LIST_HEAD(&sdev->priv_init); | |
274 | INIT_LIST_HEAD(&sdev->priv_tx); | |
275 | INIT_LIST_HEAD(&sdev->priv_free); | |
276 | INIT_LIST_HEAD(&sdev->unlink_free); | |
277 | INIT_LIST_HEAD(&sdev->unlink_tx); | |
4d7b5c7f TH |
278 | spin_lock_init(&sdev->priv_lock); |
279 | ||
280 | init_waitqueue_head(&sdev->tx_waitq); | |
281 | ||
282 | sdev->ud.eh_ops.shutdown = stub_shutdown_connection; | |
283 | sdev->ud.eh_ops.reset = stub_device_reset; | |
284 | sdev->ud.eh_ops.unusable = stub_device_unusable; | |
285 | ||
286 | usbip_start_eh(&sdev->ud); | |
287 | ||
b7945b77 | 288 | dev_dbg(&udev->dev, "register new device\n"); |
1a4b6f66 | 289 | |
4d7b5c7f TH |
290 | return sdev; |
291 | } | |
292 | ||
b94b3a62 | 293 | static void stub_device_free(struct stub_device *sdev) |
4d7b5c7f | 294 | { |
4d7b5c7f | 295 | kfree(sdev); |
4d7b5c7f TH |
296 | } |
297 | ||
b7945b77 | 298 | static int stub_probe(struct usb_device *udev) |
4d7b5c7f | 299 | { |
4d7b5c7f | 300 | struct stub_device *sdev = NULL; |
b7945b77 | 301 | const char *udev_busid = dev_name(&udev->dev); |
aa5873e9 | 302 | struct bus_id_priv *busid_priv; |
6080cd0e | 303 | int rc; |
4d7b5c7f | 304 | |
b7945b77 | 305 | dev_dbg(&udev->dev, "Enter\n"); |
4d7b5c7f TH |
306 | |
307 | /* check we should claim or not by busid_table */ | |
aa5873e9 | 308 | busid_priv = get_busid_priv(udev_busid); |
87352760 | 309 | if (!busid_priv || (busid_priv->status == STUB_BUSID_REMOV) || |
b744a45f | 310 | (busid_priv->status == STUB_BUSID_OTHER)) { |
b7945b77 | 311 | dev_info(&udev->dev, |
6165cc51 EW |
312 | "%s is not in match_busid table... skip!\n", |
313 | udev_busid); | |
4d7b5c7f TH |
314 | |
315 | /* | |
316 | * Return value should be ENODEV or ENOXIO to continue trying | |
317 | * other matched drivers by the driver core. | |
318 | * See driver_probe_device() in driver/base/dd.c | |
319 | */ | |
320 | return -ENODEV; | |
321 | } | |
322 | ||
1a4b6f66 | 323 | if (udev->descriptor.bDeviceClass == USB_CLASS_HUB) { |
324 | dev_dbg(&udev->dev, "%s is a usb hub device... skip!\n", | |
325 | udev_busid); | |
4d7b5c7f TH |
326 | return -ENODEV; |
327 | } | |
328 | ||
329 | if (!strcmp(udev->bus->bus_name, "vhci_hcd")) { | |
6165cc51 EW |
330 | dev_dbg(&udev->dev, |
331 | "%s is attached on vhci_hcd... skip!\n", | |
332 | udev_busid); | |
333 | ||
4d7b5c7f TH |
334 | return -ENODEV; |
335 | } | |
336 | ||
d012c2a5 | 337 | /* ok, this is my device */ |
b7945b77 | 338 | sdev = stub_device_alloc(udev); |
4d7b5c7f TH |
339 | if (!sdev) |
340 | return -ENOMEM; | |
341 | ||
b7945b77 VM |
342 | dev_info(&udev->dev, |
343 | "usbip-host: register new device (bus %u dev %u)\n", | |
344 | udev->bus->busnum, udev->devnum); | |
4d7b5c7f | 345 | |
aa5873e9 EK |
346 | busid_priv->shutdown_busid = 0; |
347 | ||
b7945b77 VM |
348 | /* set private data to usb_device */ |
349 | dev_set_drvdata(&udev->dev, sdev); | |
aa5873e9 | 350 | busid_priv->sdev = sdev; |
a46034ca | 351 | busid_priv->udev = udev; |
4d7b5c7f | 352 | |
6080cd0e VM |
353 | /* |
354 | * Claim this hub port. | |
355 | * It doesn't matter what value we pass as owner | |
356 | * (struct dev_state) as long as it is unique. | |
357 | */ | |
358 | rc = usb_hub_claim_port(udev->parent, udev->portnum, | |
9b6f0c4b | 359 | (struct usb_dev_state *) udev); |
6080cd0e VM |
360 | if (rc) { |
361 | dev_dbg(&udev->dev, "unable to claim port\n"); | |
3ff67445 | 362 | goto err_port; |
6080cd0e VM |
363 | } |
364 | ||
3ff67445 AK |
365 | rc = stub_add_files(&udev->dev); |
366 | if (rc) { | |
b7945b77 | 367 | dev_err(&udev->dev, "stub_add_files for %s\n", udev_busid); |
3ff67445 | 368 | goto err_files; |
4d7b5c7f | 369 | } |
aa5873e9 | 370 | busid_priv->status = STUB_BUSID_ALLOC; |
4d7b5c7f TH |
371 | |
372 | return 0; | |
3ff67445 AK |
373 | err_files: |
374 | usb_hub_release_port(udev->parent, udev->portnum, | |
375 | (struct usb_dev_state *) udev); | |
376 | err_port: | |
377 | dev_set_drvdata(&udev->dev, NULL); | |
378 | usb_put_dev(udev); | |
3ff67445 AK |
379 | |
380 | busid_priv->sdev = NULL; | |
381 | stub_device_free(sdev); | |
382 | return rc; | |
4d7b5c7f TH |
383 | } |
384 | ||
aa5873e9 EK |
385 | static void shutdown_busid(struct bus_id_priv *busid_priv) |
386 | { | |
387 | if (busid_priv->sdev && !busid_priv->shutdown_busid) { | |
388 | busid_priv->shutdown_busid = 1; | |
389 | usbip_event_add(&busid_priv->sdev->ud, SDEV_EVENT_REMOVED); | |
390 | ||
77178807 | 391 | /* wait for the stop of the event handler */ |
aa5873e9 EK |
392 | usbip_stop_eh(&busid_priv->sdev->ud); |
393 | } | |
aa5873e9 EK |
394 | } |
395 | ||
4d7b5c7f TH |
396 | /* |
397 | * called in usb_disconnect() or usb_deregister() | |
398 | * but only if actconfig(active configuration) exists | |
399 | */ | |
b7945b77 | 400 | static void stub_disconnect(struct usb_device *udev) |
4d7b5c7f | 401 | { |
aa5873e9 | 402 | struct stub_device *sdev; |
b7945b77 | 403 | const char *udev_busid = dev_name(&udev->dev); |
aa5873e9 | 404 | struct bus_id_priv *busid_priv; |
6080cd0e | 405 | int rc; |
aa5873e9 | 406 | |
b7945b77 | 407 | dev_dbg(&udev->dev, "Enter\n"); |
4d7b5c7f | 408 | |
1a4b6f66 | 409 | busid_priv = get_busid_priv(udev_busid); |
aa5873e9 EK |
410 | if (!busid_priv) { |
411 | BUG(); | |
412 | return; | |
413 | } | |
414 | ||
b7945b77 | 415 | sdev = dev_get_drvdata(&udev->dev); |
aa5873e9 | 416 | |
4d7b5c7f TH |
417 | /* get stub_device */ |
418 | if (!sdev) { | |
b7945b77 | 419 | dev_err(&udev->dev, "could not get device"); |
4d7b5c7f TH |
420 | return; |
421 | } | |
422 | ||
b7945b77 | 423 | dev_set_drvdata(&udev->dev, NULL); |
4d7b5c7f | 424 | |
4d7b5c7f | 425 | /* |
c7f00899 | 426 | * NOTE: rx/tx threads are invoked for each usb_device. |
4d7b5c7f | 427 | */ |
b7945b77 | 428 | stub_remove_files(&udev->dev); |
4d7b5c7f | 429 | |
6080cd0e VM |
430 | /* release port */ |
431 | rc = usb_hub_release_port(udev->parent, udev->portnum, | |
9b6f0c4b | 432 | (struct usb_dev_state *) udev); |
6080cd0e VM |
433 | if (rc) { |
434 | dev_dbg(&udev->dev, "unable to release port\n"); | |
435 | return; | |
436 | } | |
437 | ||
c7f00899 | 438 | /* If usb reset is called from event handler */ |
bb7871ad | 439 | if (usbip_in_eh(current)) |
aa5873e9 | 440 | return; |
4d7b5c7f | 441 | |
c7f00899 | 442 | /* shutdown the current connection */ |
aa5873e9 | 443 | shutdown_busid(busid_priv); |
4d7b5c7f | 444 | |
2d8f4595 | 445 | usb_put_dev(sdev->udev); |
2d8f4595 | 446 | |
c7f00899 | 447 | /* free sdev */ |
aa5873e9 | 448 | busid_priv->sdev = NULL; |
4d7b5c7f TH |
449 | stub_device_free(sdev); |
450 | ||
aa5873e9 EK |
451 | if (busid_priv->status == STUB_BUSID_ALLOC) { |
452 | busid_priv->status = STUB_BUSID_ADDED; | |
453 | } else { | |
454 | busid_priv->status = STUB_BUSID_OTHER; | |
455 | del_match_busid((char *)udev_busid); | |
456 | } | |
4d7b5c7f | 457 | } |
d012c2a5 | 458 | |
b7945b77 | 459 | #ifdef CONFIG_PM |
553a1a50 | 460 | |
b7945b77 VM |
461 | /* These functions need usb_port_suspend and usb_port_resume, |
462 | * which reside in drivers/usb/core/usb.h. Skip for now. */ | |
463 | ||
464 | static int stub_suspend(struct usb_device *udev, pm_message_t message) | |
1aee199c | 465 | { |
b7945b77 VM |
466 | dev_dbg(&udev->dev, "stub_suspend\n"); |
467 | ||
1aee199c AM |
468 | return 0; |
469 | } | |
470 | ||
b7945b77 | 471 | static int stub_resume(struct usb_device *udev, pm_message_t message) |
1aee199c | 472 | { |
b7945b77 VM |
473 | dev_dbg(&udev->dev, "stub_resume\n"); |
474 | ||
1aee199c AM |
475 | return 0; |
476 | } | |
477 | ||
b7945b77 VM |
478 | #endif /* CONFIG_PM */ |
479 | ||
480 | struct usb_device_driver stub_driver = { | |
d012c2a5 | 481 | .name = "usbip-host", |
482 | .probe = stub_probe, | |
483 | .disconnect = stub_disconnect, | |
b7945b77 VM |
484 | #ifdef CONFIG_PM |
485 | .suspend = stub_suspend, | |
486 | .resume = stub_resume, | |
487 | #endif | |
488 | .supports_autosuspend = 0, | |
97c451ca | 489 | }; |