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/slab.h>
22 #include "usbip_common.h"
24 #include <linux/usb/hcd.h>
27 static int is_clear_halt_cmd(struct urb
*urb
)
29 struct usb_ctrlrequest
*req
;
31 req
= (struct usb_ctrlrequest
*) urb
->setup_packet
;
33 return (req
->bRequest
== USB_REQ_CLEAR_FEATURE
) &&
34 (req
->bRequestType
== USB_RECIP_ENDPOINT
) &&
35 (req
->wValue
== USB_ENDPOINT_HALT
);
38 static int is_set_interface_cmd(struct urb
*urb
)
40 struct usb_ctrlrequest
*req
;
42 req
= (struct usb_ctrlrequest
*) urb
->setup_packet
;
44 return (req
->bRequest
== USB_REQ_SET_INTERFACE
) &&
45 (req
->bRequestType
== USB_RECIP_INTERFACE
);
48 static int is_set_configuration_cmd(struct urb
*urb
)
50 struct usb_ctrlrequest
*req
;
52 req
= (struct usb_ctrlrequest
*) urb
->setup_packet
;
54 return (req
->bRequest
== USB_REQ_SET_CONFIGURATION
) &&
55 (req
->bRequestType
== USB_RECIP_DEVICE
);
58 static int is_reset_device_cmd(struct urb
*urb
)
60 struct usb_ctrlrequest
*req
;
64 req
= (struct usb_ctrlrequest
*) urb
->setup_packet
;
65 value
= le16_to_cpu(req
->wValue
);
66 index
= le16_to_cpu(req
->wIndex
);
68 if ((req
->bRequest
== USB_REQ_SET_FEATURE
) &&
69 (req
->bRequestType
== USB_RT_PORT
) &&
70 (value
== USB_PORT_FEAT_RESET
)) {
71 usbip_dbg_stub_rx("reset_device_cmd, port %u\n", index
);
77 static int tweak_clear_halt_cmd(struct urb
*urb
)
79 struct usb_ctrlrequest
*req
;
85 req
= (struct usb_ctrlrequest
*) urb
->setup_packet
;
88 * The stalled endpoint is specified in the wIndex value. The endpoint
89 * of the urb is the target of this clear_halt request (i.e., control
92 target_endp
= le16_to_cpu(req
->wIndex
) & 0x000f;
94 /* the stalled endpoint direction is IN or OUT?. USB_DIR_IN is 0x80. */
95 target_dir
= le16_to_cpu(req
->wIndex
) & 0x0080;
98 target_pipe
= usb_rcvctrlpipe(urb
->dev
, target_endp
);
100 target_pipe
= usb_sndctrlpipe(urb
->dev
, target_endp
);
102 ret
= usb_clear_halt(urb
->dev
, target_pipe
);
104 usbip_uinfo("clear_halt error: devnum %d endp %d, %d\n",
105 urb
->dev
->devnum
, target_endp
, ret
);
107 usbip_uinfo("clear_halt done: devnum %d endp %d\n",
108 urb
->dev
->devnum
, target_endp
);
113 static int tweak_set_interface_cmd(struct urb
*urb
)
115 struct usb_ctrlrequest
*req
;
120 req
= (struct usb_ctrlrequest
*) urb
->setup_packet
;
121 alternate
= le16_to_cpu(req
->wValue
);
122 interface
= le16_to_cpu(req
->wIndex
);
124 usbip_dbg_stub_rx("set_interface: inf %u alt %u\n", interface
,
127 ret
= usb_set_interface(urb
->dev
, interface
, alternate
);
129 usbip_uinfo("set_interface error: inf %u alt %u, %d\n",
130 interface
, alternate
, ret
);
132 usbip_uinfo("set_interface done: inf %u alt %u\n",
139 static int tweak_set_configuration_cmd(struct urb
*urb
)
141 struct usb_ctrlrequest
*req
;
144 req
= (struct usb_ctrlrequest
*) urb
->setup_packet
;
145 config
= le16_to_cpu(req
->wValue
);
148 * I have never seen a multi-config device. Very rare.
149 * For most devices, this will be called to choose a default
150 * configuration only once in an initialization phase.
152 * set_configuration may change a device configuration and its device
153 * drivers will be unbound and assigned for a new device configuration.
154 * This means this usbip driver will be also unbound when called, then
155 * eventually reassigned to the device as far as driver matching
158 * Unfortunatelly, an existing usbip connection will be dropped
159 * due to this driver unbinding. So, skip here.
160 * A user may need to set a special configuration value before
161 * exporting the device.
163 usbip_uinfo("set_configuration (%d) to %s\n", config
,
164 dev_name(&urb
->dev
->dev
));
165 usbip_uinfo("but, skip!\n");
168 /* return usb_driver_set_configuration(urb->dev, config); */
171 static int tweak_reset_device_cmd(struct urb
*urb
)
173 struct usb_ctrlrequest
*req
;
178 req
= (struct usb_ctrlrequest
*) urb
->setup_packet
;
179 value
= le16_to_cpu(req
->wValue
);
180 index
= le16_to_cpu(req
->wIndex
);
182 usbip_uinfo("reset_device (port %d) to %s\n", index
,
183 dev_name(&urb
->dev
->dev
));
185 /* all interfaces should be owned by usbip driver, so just reset it. */
186 ret
= usb_lock_device_for_reset(urb
->dev
, NULL
);
188 dev_err(&urb
->dev
->dev
, "lock for reset\n");
192 /* try to reset the device */
193 ret
= usb_reset_device(urb
->dev
);
195 dev_err(&urb
->dev
->dev
, "device reset\n");
197 usb_unlock_device(urb
->dev
);
203 * clear_halt, set_interface, and set_configuration require special tricks.
205 static void tweak_special_requests(struct urb
*urb
)
207 if (!urb
|| !urb
->setup_packet
)
210 if (usb_pipetype(urb
->pipe
) != PIPE_CONTROL
)
213 if (is_clear_halt_cmd(urb
))
214 /* tweak clear_halt */
215 tweak_clear_halt_cmd(urb
);
217 else if (is_set_interface_cmd(urb
))
218 /* tweak set_interface */
219 tweak_set_interface_cmd(urb
);
221 else if (is_set_configuration_cmd(urb
))
222 /* tweak set_configuration */
223 tweak_set_configuration_cmd(urb
);
225 else if (is_reset_device_cmd(urb
))
226 tweak_reset_device_cmd(urb
);
228 usbip_dbg_stub_rx("no need to tweak\n");
232 * stub_recv_unlink() unlinks the URB by a call to usb_unlink_urb().
233 * By unlinking the urb asynchronously, stub_rx can continuously
234 * process coming urbs. Even if the urb is unlinked, its completion
235 * handler will be called and stub_tx will send a return pdu.
237 * See also comments about unlinking strategy in vhci_hcd.c.
239 static int stub_recv_cmd_unlink(struct stub_device
*sdev
,
240 struct usbip_header
*pdu
)
244 struct stub_priv
*priv
;
247 spin_lock_irqsave(&sdev
->priv_lock
, flags
);
249 list_for_each_entry(priv
, &sdev
->priv_init
, list
) {
250 if (priv
->seqnum
== pdu
->u
.cmd_unlink
.seqnum
) {
253 dev_info(&priv
->urb
->dev
->dev
, "unlink urb %p\n",
257 * This matched urb is not completed yet (i.e., be in
258 * flight in usb hcd hardware/driver). Now we are
259 * cancelling it. The unlinking flag means that we are
260 * now not going to return the normal result pdu of a
261 * submission request, but going to return a result pdu
262 * of the unlink request.
267 * In the case that unlinking flag is on, prev->seqnum
268 * is changed from the seqnum of the cancelling urb to
269 * the seqnum of the unlink request. This will be used
270 * to make the result pdu of the unlink request.
272 priv
->seqnum
= pdu
->base
.seqnum
;
274 spin_unlock_irqrestore(&sdev
->priv_lock
, flags
);
277 * usb_unlink_urb() is now out of spinlocking to avoid
278 * spinlock recursion since stub_complete() is
279 * sometimes called in this context but not in the
280 * interrupt context. If stub_complete() is executed
281 * before we call usb_unlink_urb(), usb_unlink_urb()
282 * will return an error value. In this case, stub_tx
283 * will return the result pdu of this unlink request
284 * though submission is completed and actual unlinking
285 * is not executed. OK?
287 /* In the above case, urb->status is not -ECONNRESET,
288 * so a driver in a client host will know the failure
289 * of the unlink request ?
291 ret
= usb_unlink_urb(priv
->urb
);
292 if (ret
!= -EINPROGRESS
)
293 dev_err(&priv
->urb
->dev
->dev
,
294 "failed to unlink a urb %p, ret %d\n",
300 usbip_dbg_stub_rx("seqnum %d is not pending\n",
301 pdu
->u
.cmd_unlink
.seqnum
);
304 * The urb of the unlink target is not found in priv_init queue. It was
305 * already completed and its results is/was going to be sent by a
306 * CMD_RET pdu. In this case, usb_unlink_urb() is not needed. We only
307 * return the completeness of this unlink request to vhci_hcd.
309 stub_enqueue_ret_unlink(sdev
, pdu
->base
.seqnum
, 0);
311 spin_unlock_irqrestore(&sdev
->priv_lock
, flags
);
317 static int valid_request(struct stub_device
*sdev
, struct usbip_header
*pdu
)
319 struct usbip_device
*ud
= &sdev
->ud
;
321 if (pdu
->base
.devid
== sdev
->devid
) {
322 spin_lock(&ud
->lock
);
323 if (ud
->status
== SDEV_ST_USED
) {
324 /* A request is valid. */
325 spin_unlock(&ud
->lock
);
328 spin_unlock(&ud
->lock
);
334 static struct stub_priv
*stub_priv_alloc(struct stub_device
*sdev
,
335 struct usbip_header
*pdu
)
337 struct stub_priv
*priv
;
338 struct usbip_device
*ud
= &sdev
->ud
;
341 spin_lock_irqsave(&sdev
->priv_lock
, flags
);
343 priv
= kmem_cache_zalloc(stub_priv_cache
, GFP_ATOMIC
);
345 dev_err(&sdev
->interface
->dev
, "alloc stub_priv\n");
346 spin_unlock_irqrestore(&sdev
->priv_lock
, flags
);
347 usbip_event_add(ud
, SDEV_EVENT_ERROR_MALLOC
);
351 priv
->seqnum
= pdu
->base
.seqnum
;
355 * After a stub_priv is linked to a list_head,
356 * our error handler can free allocated data.
358 list_add_tail(&priv
->list
, &sdev
->priv_init
);
360 spin_unlock_irqrestore(&sdev
->priv_lock
, flags
);
365 static int get_pipe(struct stub_device
*sdev
, int epnum
, int dir
)
367 struct usb_device
*udev
= interface_to_usbdev(sdev
->interface
);
368 struct usb_host_endpoint
*ep
;
369 struct usb_endpoint_descriptor
*epd
= NULL
;
371 if (dir
== USBIP_DIR_IN
)
372 ep
= udev
->ep_in
[epnum
& 0x7f];
374 ep
= udev
->ep_out
[epnum
& 0x7f];
376 dev_err(&sdev
->interface
->dev
, "no such endpoint?, %d\n",
385 /* epnum 0 is always control */
387 if (dir
== USBIP_DIR_OUT
)
388 return usb_sndctrlpipe(udev
, 0);
390 return usb_rcvctrlpipe(udev
, 0);
394 if (usb_endpoint_xfer_control(epd
)) {
395 if (dir
== USBIP_DIR_OUT
)
396 return usb_sndctrlpipe(udev
, epnum
);
398 return usb_rcvctrlpipe(udev
, epnum
);
401 if (usb_endpoint_xfer_bulk(epd
)) {
402 if (dir
== USBIP_DIR_OUT
)
403 return usb_sndbulkpipe(udev
, epnum
);
405 return usb_rcvbulkpipe(udev
, epnum
);
408 if (usb_endpoint_xfer_int(epd
)) {
409 if (dir
== USBIP_DIR_OUT
)
410 return usb_sndintpipe(udev
, epnum
);
412 return usb_rcvintpipe(udev
, epnum
);
415 if (usb_endpoint_xfer_isoc(epd
)) {
416 if (dir
== USBIP_DIR_OUT
)
417 return usb_sndisocpipe(udev
, epnum
);
419 return usb_rcvisocpipe(udev
, epnum
);
423 dev_err(&sdev
->interface
->dev
, "get pipe, epnum %d\n", epnum
);
427 static void masking_bogus_flags(struct urb
*urb
)
430 struct usb_device
*dev
;
431 struct usb_host_endpoint
*ep
;
433 unsigned int allowed
;
435 if (!urb
|| urb
->hcpriv
|| !urb
->complete
)
438 if ((!dev
) || (dev
->state
< USB_STATE_UNAUTHENTICATED
))
441 ep
= (usb_pipein(urb
->pipe
) ? dev
->ep_in
: dev
->ep_out
)
442 [usb_pipeendpoint(urb
->pipe
)];
446 xfertype
= usb_endpoint_type(&ep
->desc
);
447 if (xfertype
== USB_ENDPOINT_XFER_CONTROL
) {
448 struct usb_ctrlrequest
*setup
=
449 (struct usb_ctrlrequest
*) urb
->setup_packet
;
453 is_out
= !(setup
->bRequestType
& USB_DIR_IN
) ||
456 is_out
= usb_endpoint_dir_out(&ep
->desc
);
459 /* enforce simple/standard policy */
460 allowed
= (URB_NO_TRANSFER_DMA_MAP
| URB_NO_INTERRUPT
|
461 URB_DIR_MASK
| URB_FREE_BUFFER
);
463 case USB_ENDPOINT_XFER_BULK
:
465 allowed
|= URB_ZERO_PACKET
;
467 case USB_ENDPOINT_XFER_CONTROL
:
468 allowed
|= URB_NO_FSBR
; /* only affects UHCI */
470 default: /* all non-iso endpoints */
472 allowed
|= URB_SHORT_NOT_OK
;
474 case USB_ENDPOINT_XFER_ISOC
:
475 allowed
|= URB_ISO_ASAP
;
478 urb
->transfer_flags
&= allowed
;
481 static void stub_recv_cmd_submit(struct stub_device
*sdev
,
482 struct usbip_header
*pdu
)
485 struct stub_priv
*priv
;
486 struct usbip_device
*ud
= &sdev
->ud
;
487 struct usb_device
*udev
= interface_to_usbdev(sdev
->interface
);
488 int pipe
= get_pipe(sdev
, pdu
->base
.ep
, pdu
->base
.direction
);
491 priv
= stub_priv_alloc(sdev
, pdu
);
496 if (usb_pipeisoc(pipe
))
497 priv
->urb
= usb_alloc_urb(pdu
->u
.cmd_submit
.number_of_packets
,
500 priv
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
503 dev_err(&sdev
->interface
->dev
, "malloc urb\n");
504 usbip_event_add(ud
, SDEV_EVENT_ERROR_MALLOC
);
508 /* set priv->urb->transfer_buffer */
509 if (pdu
->u
.cmd_submit
.transfer_buffer_length
> 0) {
510 priv
->urb
->transfer_buffer
=
511 kzalloc(pdu
->u
.cmd_submit
.transfer_buffer_length
,
513 if (!priv
->urb
->transfer_buffer
) {
514 dev_err(&sdev
->interface
->dev
, "malloc x_buff\n");
515 usbip_event_add(ud
, SDEV_EVENT_ERROR_MALLOC
);
520 /* set priv->urb->setup_packet */
521 priv
->urb
->setup_packet
= kmemdup(&pdu
->u
.cmd_submit
.setup
, 8,
523 if (!priv
->urb
->setup_packet
) {
524 dev_err(&sdev
->interface
->dev
, "allocate setup_packet\n");
525 usbip_event_add(ud
, SDEV_EVENT_ERROR_MALLOC
);
529 /* set other members from the base header of pdu */
530 priv
->urb
->context
= (void *) priv
;
531 priv
->urb
->dev
= udev
;
532 priv
->urb
->pipe
= pipe
;
533 priv
->urb
->complete
= stub_complete
;
535 usbip_pack_pdu(pdu
, priv
->urb
, USBIP_CMD_SUBMIT
, 0);
538 if (usbip_recv_xbuff(ud
, priv
->urb
) < 0)
541 if (usbip_recv_iso(ud
, priv
->urb
) < 0)
544 /* no need to submit an intercepted request, but harmless? */
545 tweak_special_requests(priv
->urb
);
547 masking_bogus_flags(priv
->urb
);
548 /* urb is now ready to submit */
549 ret
= usb_submit_urb(priv
->urb
, GFP_KERNEL
);
552 usbip_dbg_stub_rx("submit urb ok, seqnum %u\n",
555 dev_err(&sdev
->interface
->dev
, "submit_urb error, %d\n", ret
);
556 usbip_dump_header(pdu
);
557 usbip_dump_urb(priv
->urb
);
561 * This connection will be discarded.
563 usbip_event_add(ud
, SDEV_EVENT_ERROR_SUBMIT
);
566 usbip_dbg_stub_rx("Leave\n");
571 static void stub_rx_pdu(struct usbip_device
*ud
)
574 struct usbip_header pdu
;
575 struct stub_device
*sdev
= container_of(ud
, struct stub_device
, ud
);
576 struct device
*dev
= &sdev
->interface
->dev
;
578 usbip_dbg_stub_rx("Enter\n");
580 memset(&pdu
, 0, sizeof(pdu
));
582 /* 1. receive a pdu header */
583 ret
= usbip_xmit(0, ud
->tcp_socket
, (char *) &pdu
, sizeof(pdu
), 0);
584 if (ret
!= sizeof(pdu
)) {
585 dev_err(dev
, "recv a header, %d\n", ret
);
586 usbip_event_add(ud
, SDEV_EVENT_ERROR_TCP
);
590 usbip_header_correct_endian(&pdu
, 0);
592 if (usbip_dbg_flag_stub_rx
)
593 usbip_dump_header(&pdu
);
595 if (!valid_request(sdev
, &pdu
)) {
596 dev_err(dev
, "recv invalid request\n");
597 usbip_event_add(ud
, SDEV_EVENT_ERROR_TCP
);
601 switch (pdu
.base
.command
) {
602 case USBIP_CMD_UNLINK
:
603 stub_recv_cmd_unlink(sdev
, &pdu
);
606 case USBIP_CMD_SUBMIT
:
607 stub_recv_cmd_submit(sdev
, &pdu
);
612 dev_err(dev
, "unknown pdu\n");
613 usbip_event_add(ud
, SDEV_EVENT_ERROR_TCP
);
619 void stub_rx_loop(struct usbip_task
*ut
)
621 struct usbip_device
*ud
= container_of(ut
, struct usbip_device
, tcp_rx
);
624 if (signal_pending(current
)) {
625 usbip_dbg_stub_rx("signal caught!\n");
629 if (usbip_event_happened(ud
))