1
2
3
4
5
6#include <asm/byteorder.h>
7#include <linux/kthread.h>
8#include <linux/usb.h>
9#include <linux/usb/hcd.h>
10
11#include "usbip_common.h"
12#include "stub.h"
13
14static int is_clear_halt_cmd(struct urb *urb)
15{
16 struct usb_ctrlrequest *req;
17
18 req = (struct usb_ctrlrequest *) urb->setup_packet;
19
20 return (req->bRequest == USB_REQ_CLEAR_FEATURE) &&
21 (req->bRequestType == USB_RECIP_ENDPOINT) &&
22 (req->wValue == USB_ENDPOINT_HALT);
23}
24
25static int is_set_interface_cmd(struct urb *urb)
26{
27 struct usb_ctrlrequest *req;
28
29 req = (struct usb_ctrlrequest *) urb->setup_packet;
30
31 return (req->bRequest == USB_REQ_SET_INTERFACE) &&
32 (req->bRequestType == USB_RECIP_INTERFACE);
33}
34
35static int is_set_configuration_cmd(struct urb *urb)
36{
37 struct usb_ctrlrequest *req;
38
39 req = (struct usb_ctrlrequest *) urb->setup_packet;
40
41 return (req->bRequest == USB_REQ_SET_CONFIGURATION) &&
42 (req->bRequestType == USB_RECIP_DEVICE);
43}
44
45static int is_reset_device_cmd(struct urb *urb)
46{
47 struct usb_ctrlrequest *req;
48 __u16 value;
49 __u16 index;
50
51 req = (struct usb_ctrlrequest *) urb->setup_packet;
52 value = le16_to_cpu(req->wValue);
53 index = le16_to_cpu(req->wIndex);
54
55 if ((req->bRequest == USB_REQ_SET_FEATURE) &&
56 (req->bRequestType == USB_RT_PORT) &&
57 (value == USB_PORT_FEAT_RESET)) {
58 usbip_dbg_stub_rx("reset_device_cmd, port %u\n", index);
59 return 1;
60 } else
61 return 0;
62}
63
64static int tweak_clear_halt_cmd(struct urb *urb)
65{
66 struct usb_ctrlrequest *req;
67 int target_endp;
68 int target_dir;
69 int target_pipe;
70 int ret;
71
72 req = (struct usb_ctrlrequest *) urb->setup_packet;
73
74
75
76
77
78
79 target_endp = le16_to_cpu(req->wIndex) & 0x000f;
80
81
82 target_dir = le16_to_cpu(req->wIndex) & 0x0080;
83
84 if (target_dir)
85 target_pipe = usb_rcvctrlpipe(urb->dev, target_endp);
86 else
87 target_pipe = usb_sndctrlpipe(urb->dev, target_endp);
88
89 ret = usb_clear_halt(urb->dev, target_pipe);
90 if (ret < 0)
91 dev_err(&urb->dev->dev,
92 "usb_clear_halt error: devnum %d endp %d ret %d\n",
93 urb->dev->devnum, target_endp, ret);
94 else
95 dev_info(&urb->dev->dev,
96 "usb_clear_halt done: devnum %d endp %d\n",
97 urb->dev->devnum, target_endp);
98
99 return ret;
100}
101
102static int tweak_set_interface_cmd(struct urb *urb)
103{
104 struct usb_ctrlrequest *req;
105 __u16 alternate;
106 __u16 interface;
107 int ret;
108
109 req = (struct usb_ctrlrequest *) urb->setup_packet;
110 alternate = le16_to_cpu(req->wValue);
111 interface = le16_to_cpu(req->wIndex);
112
113 usbip_dbg_stub_rx("set_interface: inf %u alt %u\n",
114 interface, alternate);
115
116 ret = usb_set_interface(urb->dev, interface, alternate);
117 if (ret < 0)
118 dev_err(&urb->dev->dev,
119 "usb_set_interface error: inf %u alt %u ret %d\n",
120 interface, alternate, ret);
121 else
122 dev_info(&urb->dev->dev,
123 "usb_set_interface done: inf %u alt %u\n",
124 interface, alternate);
125
126 return ret;
127}
128
129static int tweak_set_configuration_cmd(struct urb *urb)
130{
131 struct stub_priv *priv = (struct stub_priv *) urb->context;
132 struct stub_device *sdev = priv->sdev;
133 struct usb_ctrlrequest *req;
134 __u16 config;
135 int err;
136
137 req = (struct usb_ctrlrequest *) urb->setup_packet;
138 config = le16_to_cpu(req->wValue);
139
140 err = usb_set_configuration(sdev->udev, config);
141 if (err && err != -ENODEV)
142 dev_err(&sdev->udev->dev, "can't set config #%d, error %d\n",
143 config, err);
144 return 0;
145}
146
147static int tweak_reset_device_cmd(struct urb *urb)
148{
149 struct stub_priv *priv = (struct stub_priv *) urb->context;
150 struct stub_device *sdev = priv->sdev;
151
152 dev_info(&urb->dev->dev, "usb_queue_reset_device\n");
153
154 if (usb_lock_device_for_reset(sdev->udev, NULL) < 0) {
155 dev_err(&urb->dev->dev, "could not obtain lock to reset device\n");
156 return 0;
157 }
158 usb_reset_device(sdev->udev);
159 usb_unlock_device(sdev->udev);
160
161 return 0;
162}
163
164
165
166
167static void tweak_special_requests(struct urb *urb)
168{
169 if (!urb || !urb->setup_packet)
170 return;
171
172 if (usb_pipetype(urb->pipe) != PIPE_CONTROL)
173 return;
174
175 if (is_clear_halt_cmd(urb))
176
177 tweak_clear_halt_cmd(urb);
178
179 else if (is_set_interface_cmd(urb))
180
181 tweak_set_interface_cmd(urb);
182
183 else if (is_set_configuration_cmd(urb))
184
185 tweak_set_configuration_cmd(urb);
186
187 else if (is_reset_device_cmd(urb))
188 tweak_reset_device_cmd(urb);
189 else
190 usbip_dbg_stub_rx("no need to tweak\n");
191}
192
193
194
195
196
197
198
199
200
201static int stub_recv_cmd_unlink(struct stub_device *sdev,
202 struct usbip_header *pdu)
203{
204 int ret;
205 unsigned long flags;
206 struct stub_priv *priv;
207
208 spin_lock_irqsave(&sdev->priv_lock, flags);
209
210 list_for_each_entry(priv, &sdev->priv_init, list) {
211 if (priv->seqnum != pdu->u.cmd_unlink.seqnum)
212 continue;
213
214
215
216
217
218
219
220
221
222 priv->unlinking = 1;
223
224
225
226
227
228
229
230 priv->seqnum = pdu->base.seqnum;
231
232 spin_unlock_irqrestore(&sdev->priv_lock, flags);
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249 ret = usb_unlink_urb(priv->urb);
250 if (ret != -EINPROGRESS)
251 dev_err(&priv->urb->dev->dev,
252 "failed to unlink a urb # %lu, ret %d\n",
253 priv->seqnum, ret);
254
255 return 0;
256 }
257
258 usbip_dbg_stub_rx("seqnum %d is not pending\n",
259 pdu->u.cmd_unlink.seqnum);
260
261
262
263
264
265
266
267 stub_enqueue_ret_unlink(sdev, pdu->base.seqnum, 0);
268
269 spin_unlock_irqrestore(&sdev->priv_lock, flags);
270
271 return 0;
272}
273
274static int valid_request(struct stub_device *sdev, struct usbip_header *pdu)
275{
276 struct usbip_device *ud = &sdev->ud;
277 int valid = 0;
278
279 if (pdu->base.devid == sdev->devid) {
280 spin_lock_irq(&ud->lock);
281 if (ud->status == SDEV_ST_USED) {
282
283 valid = 1;
284 }
285 spin_unlock_irq(&ud->lock);
286 }
287
288 return valid;
289}
290
291static struct stub_priv *stub_priv_alloc(struct stub_device *sdev,
292 struct usbip_header *pdu)
293{
294 struct stub_priv *priv;
295 struct usbip_device *ud = &sdev->ud;
296 unsigned long flags;
297
298 spin_lock_irqsave(&sdev->priv_lock, flags);
299
300 priv = kmem_cache_zalloc(stub_priv_cache, GFP_ATOMIC);
301 if (!priv) {
302 dev_err(&sdev->udev->dev, "alloc stub_priv\n");
303 spin_unlock_irqrestore(&sdev->priv_lock, flags);
304 usbip_event_add(ud, SDEV_EVENT_ERROR_MALLOC);
305 return NULL;
306 }
307
308 priv->seqnum = pdu->base.seqnum;
309 priv->sdev = sdev;
310
311
312
313
314
315 list_add_tail(&priv->list, &sdev->priv_init);
316
317 spin_unlock_irqrestore(&sdev->priv_lock, flags);
318
319 return priv;
320}
321
322static int get_pipe(struct stub_device *sdev, struct usbip_header *pdu)
323{
324 struct usb_device *udev = sdev->udev;
325 struct usb_host_endpoint *ep;
326 struct usb_endpoint_descriptor *epd = NULL;
327 int epnum = pdu->base.ep;
328 int dir = pdu->base.direction;
329
330 if (epnum < 0 || epnum > 15)
331 goto err_ret;
332
333 if (dir == USBIP_DIR_IN)
334 ep = udev->ep_in[epnum & 0x7f];
335 else
336 ep = udev->ep_out[epnum & 0x7f];
337 if (!ep)
338 goto err_ret;
339
340 epd = &ep->desc;
341
342 if (usb_endpoint_xfer_control(epd)) {
343 if (dir == USBIP_DIR_OUT)
344 return usb_sndctrlpipe(udev, epnum);
345 else
346 return usb_rcvctrlpipe(udev, epnum);
347 }
348
349 if (usb_endpoint_xfer_bulk(epd)) {
350 if (dir == USBIP_DIR_OUT)
351 return usb_sndbulkpipe(udev, epnum);
352 else
353 return usb_rcvbulkpipe(udev, epnum);
354 }
355
356 if (usb_endpoint_xfer_int(epd)) {
357 if (dir == USBIP_DIR_OUT)
358 return usb_sndintpipe(udev, epnum);
359 else
360 return usb_rcvintpipe(udev, epnum);
361 }
362
363 if (usb_endpoint_xfer_isoc(epd)) {
364
365 if (pdu->u.cmd_submit.number_of_packets < 0 ||
366 pdu->u.cmd_submit.number_of_packets >
367 USBIP_MAX_ISO_PACKETS) {
368 dev_err(&sdev->udev->dev,
369 "CMD_SUBMIT: isoc invalid num packets %d\n",
370 pdu->u.cmd_submit.number_of_packets);
371 return -1;
372 }
373 if (dir == USBIP_DIR_OUT)
374 return usb_sndisocpipe(udev, epnum);
375 else
376 return usb_rcvisocpipe(udev, epnum);
377 }
378
379err_ret:
380
381 dev_err(&sdev->udev->dev, "CMD_SUBMIT: invalid epnum %d\n", epnum);
382 return -1;
383}
384
385static void masking_bogus_flags(struct urb *urb)
386{
387 int xfertype;
388 struct usb_device *dev;
389 struct usb_host_endpoint *ep;
390 int is_out;
391 unsigned int allowed;
392
393 if (!urb || urb->hcpriv || !urb->complete)
394 return;
395 dev = urb->dev;
396 if ((!dev) || (dev->state < USB_STATE_UNAUTHENTICATED))
397 return;
398
399 ep = (usb_pipein(urb->pipe) ? dev->ep_in : dev->ep_out)
400 [usb_pipeendpoint(urb->pipe)];
401 if (!ep)
402 return;
403
404 xfertype = usb_endpoint_type(&ep->desc);
405 if (xfertype == USB_ENDPOINT_XFER_CONTROL) {
406 struct usb_ctrlrequest *setup =
407 (struct usb_ctrlrequest *) urb->setup_packet;
408
409 if (!setup)
410 return;
411 is_out = !(setup->bRequestType & USB_DIR_IN) ||
412 !setup->wLength;
413 } else {
414 is_out = usb_endpoint_dir_out(&ep->desc);
415 }
416
417
418 allowed = (URB_NO_TRANSFER_DMA_MAP | URB_NO_INTERRUPT |
419 URB_DIR_MASK | URB_FREE_BUFFER);
420 switch (xfertype) {
421 case USB_ENDPOINT_XFER_BULK:
422 if (is_out)
423 allowed |= URB_ZERO_PACKET;
424
425 default:
426 if (!is_out)
427 allowed |= URB_SHORT_NOT_OK;
428 break;
429 case USB_ENDPOINT_XFER_ISOC:
430 allowed |= URB_ISO_ASAP;
431 break;
432 }
433 urb->transfer_flags &= allowed;
434}
435
436static void stub_recv_cmd_submit(struct stub_device *sdev,
437 struct usbip_header *pdu)
438{
439 int ret;
440 struct stub_priv *priv;
441 struct usbip_device *ud = &sdev->ud;
442 struct usb_device *udev = sdev->udev;
443 int pipe = get_pipe(sdev, pdu);
444
445 if (pipe == -1)
446 return;
447
448 priv = stub_priv_alloc(sdev, pdu);
449 if (!priv)
450 return;
451
452
453 if (usb_pipeisoc(pipe))
454 priv->urb = usb_alloc_urb(pdu->u.cmd_submit.number_of_packets,
455 GFP_KERNEL);
456 else
457 priv->urb = usb_alloc_urb(0, GFP_KERNEL);
458
459 if (!priv->urb) {
460 usbip_event_add(ud, SDEV_EVENT_ERROR_MALLOC);
461 return;
462 }
463
464
465 if (pdu->u.cmd_submit.transfer_buffer_length > 0) {
466 priv->urb->transfer_buffer =
467 kzalloc(pdu->u.cmd_submit.transfer_buffer_length,
468 GFP_KERNEL);
469 if (!priv->urb->transfer_buffer) {
470 usbip_event_add(ud, SDEV_EVENT_ERROR_MALLOC);
471 return;
472 }
473 }
474
475
476 priv->urb->setup_packet = kmemdup(&pdu->u.cmd_submit.setup, 8,
477 GFP_KERNEL);
478 if (!priv->urb->setup_packet) {
479 dev_err(&udev->dev, "allocate setup_packet\n");
480 usbip_event_add(ud, SDEV_EVENT_ERROR_MALLOC);
481 return;
482 }
483
484
485 priv->urb->context = (void *) priv;
486 priv->urb->dev = udev;
487 priv->urb->pipe = pipe;
488 priv->urb->complete = stub_complete;
489
490 usbip_pack_pdu(pdu, priv->urb, USBIP_CMD_SUBMIT, 0);
491
492
493 if (usbip_recv_xbuff(ud, priv->urb) < 0)
494 return;
495
496 if (usbip_recv_iso(ud, priv->urb) < 0)
497 return;
498
499
500 tweak_special_requests(priv->urb);
501
502 masking_bogus_flags(priv->urb);
503
504 ret = usb_submit_urb(priv->urb, GFP_KERNEL);
505
506 if (ret == 0)
507 usbip_dbg_stub_rx("submit urb ok, seqnum %u\n",
508 pdu->base.seqnum);
509 else {
510 dev_err(&udev->dev, "submit_urb error, %d\n", ret);
511 usbip_dump_header(pdu);
512 usbip_dump_urb(priv->urb);
513
514
515
516
517
518 usbip_event_add(ud, SDEV_EVENT_ERROR_SUBMIT);
519 }
520
521 usbip_dbg_stub_rx("Leave\n");
522}
523
524
525static void stub_rx_pdu(struct usbip_device *ud)
526{
527 int ret;
528 struct usbip_header pdu;
529 struct stub_device *sdev = container_of(ud, struct stub_device, ud);
530 struct device *dev = &sdev->udev->dev;
531
532 usbip_dbg_stub_rx("Enter\n");
533
534 memset(&pdu, 0, sizeof(pdu));
535
536
537 ret = usbip_recv(ud->tcp_socket, &pdu, sizeof(pdu));
538 if (ret != sizeof(pdu)) {
539 dev_err(dev, "recv a header, %d\n", ret);
540 usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
541 return;
542 }
543
544 usbip_header_correct_endian(&pdu, 0);
545
546 if (usbip_dbg_flag_stub_rx)
547 usbip_dump_header(&pdu);
548
549 if (!valid_request(sdev, &pdu)) {
550 dev_err(dev, "recv invalid request\n");
551 usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
552 return;
553 }
554
555 switch (pdu.base.command) {
556 case USBIP_CMD_UNLINK:
557 stub_recv_cmd_unlink(sdev, &pdu);
558 break;
559
560 case USBIP_CMD_SUBMIT:
561 stub_recv_cmd_submit(sdev, &pdu);
562 break;
563
564 default:
565
566 dev_err(dev, "unknown pdu\n");
567 usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
568 break;
569 }
570}
571
572int stub_rx_loop(void *data)
573{
574 struct usbip_device *ud = data;
575
576 while (!kthread_should_stop()) {
577 if (usbip_event_happened(ud))
578 break;
579
580 stub_rx_pdu(ud);
581 }
582
583 return 0;
584}
585