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>
21 #include <linux/kthread.h>
23 #include "usbip_common.h"
25 #include <linux/usb/hcd.h>
28 static int is_clear_halt_cmd(struct urb *urb)
30 struct usb_ctrlrequest *req;
32 req = (struct usb_ctrlrequest *) urb->setup_packet;
34 return (req->bRequest == USB_REQ_CLEAR_FEATURE) &&
35 (req->bRequestType == USB_RECIP_ENDPOINT) &&
36 (req->wValue == USB_ENDPOINT_HALT);
39 static int is_set_interface_cmd(struct urb *urb)
41 struct usb_ctrlrequest *req;
43 req = (struct usb_ctrlrequest *) urb->setup_packet;
45 return (req->bRequest == USB_REQ_SET_INTERFACE) &&
46 (req->bRequestType == USB_RECIP_INTERFACE);
49 static int is_set_configuration_cmd(struct urb *urb)
51 struct usb_ctrlrequest *req;
53 req = (struct usb_ctrlrequest *) urb->setup_packet;
55 return (req->bRequest == USB_REQ_SET_CONFIGURATION) &&
56 (req->bRequestType == USB_RECIP_DEVICE);
59 static int is_reset_device_cmd(struct urb *urb)
61 struct usb_ctrlrequest *req;
65 req = (struct usb_ctrlrequest *) urb->setup_packet;
66 value = le16_to_cpu(req->wValue);
67 index = le16_to_cpu(req->wIndex);
69 if ((req->bRequest == USB_REQ_SET_FEATURE) &&
70 (req->bRequestType == USB_RT_PORT) &&
71 (value == USB_PORT_FEAT_RESET)) {
72 usbip_dbg_stub_rx("reset_device_cmd, port %u\n", index);
78 static int tweak_clear_halt_cmd(struct urb *urb)
80 struct usb_ctrlrequest *req;
86 req = (struct usb_ctrlrequest *) urb->setup_packet;
89 * The stalled endpoint is specified in the wIndex value. The endpoint
90 * of the urb is the target of this clear_halt request (i.e., control
93 target_endp = le16_to_cpu(req->wIndex) & 0x000f;
95 /* the stalled endpoint direction is IN or OUT?. USB_DIR_IN is 0x80. */
96 target_dir = le16_to_cpu(req->wIndex) & 0x0080;
99 target_pipe = usb_rcvctrlpipe(urb->dev, target_endp);
101 target_pipe = usb_sndctrlpipe(urb->dev, target_endp);
103 ret = usb_clear_halt(urb->dev, target_pipe);
105 usbip_uinfo("clear_halt error: devnum %d endp %d, %d\n",
106 urb->dev->devnum, target_endp, ret);
108 usbip_uinfo("clear_halt done: devnum %d endp %d\n",
109 urb->dev->devnum, target_endp);
114 static int tweak_set_interface_cmd(struct urb *urb)
116 struct usb_ctrlrequest *req;
121 req = (struct usb_ctrlrequest *) urb->setup_packet;
122 alternate = le16_to_cpu(req->wValue);
123 interface = le16_to_cpu(req->wIndex);
125 usbip_dbg_stub_rx("set_interface: inf %u alt %u\n", interface,
128 ret = usb_set_interface(urb->dev, interface, alternate);
130 usbip_uinfo("set_interface error: inf %u alt %u, %d\n",
131 interface, alternate, ret);
133 usbip_uinfo("set_interface done: inf %u alt %u\n",
140 static int tweak_set_configuration_cmd(struct urb *urb)
142 struct usb_ctrlrequest *req;
145 req = (struct usb_ctrlrequest *) urb->setup_packet;
146 config = le16_to_cpu(req->wValue);
149 * I have never seen a multi-config device. Very rare.
150 * For most devices, this will be called to choose a default
151 * configuration only once in an initialization phase.
153 * set_configuration may change a device configuration and its device
154 * drivers will be unbound and assigned for a new device configuration.
155 * This means this usbip driver will be also unbound when called, then
156 * eventually reassigned to the device as far as driver matching
159 * Unfortunatelly, an existing usbip connection will be dropped
160 * due to this driver unbinding. So, skip here.
161 * A user may need to set a special configuration value before
162 * exporting the device.
164 usbip_uinfo("set_configuration (%d) to %s\n", config,
165 dev_name(&urb->dev->dev));
166 usbip_uinfo("but, skip!\n");
169 /* return usb_driver_set_configuration(urb->dev, config); */
172 static int tweak_reset_device_cmd(struct urb *urb)
174 struct stub_priv *priv = (struct stub_priv *) urb->context;
175 struct stub_device *sdev = priv->sdev;
177 usbip_uinfo("reset_device %s\n", dev_name(&urb->dev->dev));
180 * usb_lock_device_for_reset caused a deadlock: it causes the driver
181 * to unbind. In the shutdown the rx thread is signalled to shut down
182 * but this thread is pending in the usb_lock_device_for_reset.
184 * Instead queue the reset.
186 * Unfortunatly an existing usbip connection will be dropped due to
189 usb_queue_reset_device(sdev->interface);
194 * clear_halt, set_interface, and set_configuration require special tricks.
196 static void tweak_special_requests(struct urb *urb)
198 if (!urb || !urb->setup_packet)
201 if (usb_pipetype(urb->pipe) != PIPE_CONTROL)
204 if (is_clear_halt_cmd(urb))
205 /* tweak clear_halt */
206 tweak_clear_halt_cmd(urb);
208 else if (is_set_interface_cmd(urb))
209 /* tweak set_interface */
210 tweak_set_interface_cmd(urb);
212 else if (is_set_configuration_cmd(urb))
213 /* tweak set_configuration */
214 tweak_set_configuration_cmd(urb);
216 else if (is_reset_device_cmd(urb))
217 tweak_reset_device_cmd(urb);
219 usbip_dbg_stub_rx("no need to tweak\n");
223 * stub_recv_unlink() unlinks the URB by a call to usb_unlink_urb().
224 * By unlinking the urb asynchronously, stub_rx can continuously
225 * process coming urbs. Even if the urb is unlinked, its completion
226 * handler will be called and stub_tx will send a return pdu.
228 * See also comments about unlinking strategy in vhci_hcd.c.
230 static int stub_recv_cmd_unlink(struct stub_device *sdev,
231 struct usbip_header *pdu)
235 struct stub_priv *priv;
238 spin_lock_irqsave(&sdev->priv_lock, flags);
240 list_for_each_entry(priv, &sdev->priv_init, list) {
241 if (priv->seqnum == pdu->u.cmd_unlink.seqnum) {
244 dev_info(&priv->urb->dev->dev, "unlink urb %p\n",
248 * This matched urb is not completed yet (i.e., be in
249 * flight in usb hcd hardware/driver). Now we are
250 * cancelling it. The unlinking flag means that we are
251 * now not going to return the normal result pdu of a
252 * submission request, but going to return a result pdu
253 * of the unlink request.
258 * In the case that unlinking flag is on, prev->seqnum
259 * is changed from the seqnum of the cancelling urb to
260 * the seqnum of the unlink request. This will be used
261 * to make the result pdu of the unlink request.
263 priv->seqnum = pdu->base.seqnum;
265 spin_unlock_irqrestore(&sdev->priv_lock, flags);
268 * usb_unlink_urb() is now out of spinlocking to avoid
269 * spinlock recursion since stub_complete() is
270 * sometimes called in this context but not in the
271 * interrupt context. If stub_complete() is executed
272 * before we call usb_unlink_urb(), usb_unlink_urb()
273 * will return an error value. In this case, stub_tx
274 * will return the result pdu of this unlink request
275 * though submission is completed and actual unlinking
276 * is not executed. OK?
278 /* In the above case, urb->status is not -ECONNRESET,
279 * so a driver in a client host will know the failure
280 * of the unlink request ?
282 ret = usb_unlink_urb(priv->urb);
283 if (ret != -EINPROGRESS)
284 dev_err(&priv->urb->dev->dev,
285 "failed to unlink a urb %p, ret %d\n",
291 usbip_dbg_stub_rx("seqnum %d is not pending\n",
292 pdu->u.cmd_unlink.seqnum);
295 * The urb of the unlink target is not found in priv_init queue. It was
296 * already completed and its results is/was going to be sent by a
297 * CMD_RET pdu. In this case, usb_unlink_urb() is not needed. We only
298 * return the completeness of this unlink request to vhci_hcd.
300 stub_enqueue_ret_unlink(sdev, pdu->base.seqnum, 0);
302 spin_unlock_irqrestore(&sdev->priv_lock, flags);
308 static int valid_request(struct stub_device *sdev, struct usbip_header *pdu)
310 struct usbip_device *ud = &sdev->ud;
312 if (pdu->base.devid == sdev->devid) {
313 spin_lock(&ud->lock);
314 if (ud->status == SDEV_ST_USED) {
315 /* A request is valid. */
316 spin_unlock(&ud->lock);
319 spin_unlock(&ud->lock);
325 static struct stub_priv *stub_priv_alloc(struct stub_device *sdev,
326 struct usbip_header *pdu)
328 struct stub_priv *priv;
329 struct usbip_device *ud = &sdev->ud;
332 spin_lock_irqsave(&sdev->priv_lock, flags);
334 priv = kmem_cache_zalloc(stub_priv_cache, GFP_ATOMIC);
336 dev_err(&sdev->interface->dev, "alloc stub_priv\n");
337 spin_unlock_irqrestore(&sdev->priv_lock, flags);
338 usbip_event_add(ud, SDEV_EVENT_ERROR_MALLOC);
342 priv->seqnum = pdu->base.seqnum;
346 * After a stub_priv is linked to a list_head,
347 * our error handler can free allocated data.
349 list_add_tail(&priv->list, &sdev->priv_init);
351 spin_unlock_irqrestore(&sdev->priv_lock, flags);
356 static int get_pipe(struct stub_device *sdev, int epnum, int dir)
358 struct usb_device *udev = sdev->udev;
359 struct usb_host_endpoint *ep;
360 struct usb_endpoint_descriptor *epd = NULL;
362 if (dir == USBIP_DIR_IN)
363 ep = udev->ep_in[epnum & 0x7f];
365 ep = udev->ep_out[epnum & 0x7f];
367 dev_err(&sdev->interface->dev, "no such endpoint?, %d\n",
376 /* epnum 0 is always control */
378 if (dir == USBIP_DIR_OUT)
379 return usb_sndctrlpipe(udev, 0);
381 return usb_rcvctrlpipe(udev, 0);
385 if (usb_endpoint_xfer_control(epd)) {
386 if (dir == USBIP_DIR_OUT)
387 return usb_sndctrlpipe(udev, epnum);
389 return usb_rcvctrlpipe(udev, epnum);
392 if (usb_endpoint_xfer_bulk(epd)) {
393 if (dir == USBIP_DIR_OUT)
394 return usb_sndbulkpipe(udev, epnum);
396 return usb_rcvbulkpipe(udev, epnum);
399 if (usb_endpoint_xfer_int(epd)) {
400 if (dir == USBIP_DIR_OUT)
401 return usb_sndintpipe(udev, epnum);
403 return usb_rcvintpipe(udev, epnum);
406 if (usb_endpoint_xfer_isoc(epd)) {
407 if (dir == USBIP_DIR_OUT)
408 return usb_sndisocpipe(udev, epnum);
410 return usb_rcvisocpipe(udev, epnum);
414 dev_err(&sdev->interface->dev, "get pipe, epnum %d\n", epnum);
418 static void masking_bogus_flags(struct urb *urb)
421 struct usb_device *dev;
422 struct usb_host_endpoint *ep;
424 unsigned int allowed;
426 if (!urb || urb->hcpriv || !urb->complete)
429 if ((!dev) || (dev->state < USB_STATE_UNAUTHENTICATED))
432 ep = (usb_pipein(urb->pipe) ? dev->ep_in : dev->ep_out)
433 [usb_pipeendpoint(urb->pipe)];
437 xfertype = usb_endpoint_type(&ep->desc);
438 if (xfertype == USB_ENDPOINT_XFER_CONTROL) {
439 struct usb_ctrlrequest *setup =
440 (struct usb_ctrlrequest *) urb->setup_packet;
444 is_out = !(setup->bRequestType & USB_DIR_IN) ||
447 is_out = usb_endpoint_dir_out(&ep->desc);
450 /* enforce simple/standard policy */
451 allowed = (URB_NO_TRANSFER_DMA_MAP | URB_NO_INTERRUPT |
452 URB_DIR_MASK | URB_FREE_BUFFER);
454 case USB_ENDPOINT_XFER_BULK:
456 allowed |= URB_ZERO_PACKET;
458 case USB_ENDPOINT_XFER_CONTROL:
459 allowed |= URB_NO_FSBR; /* only affects UHCI */
461 default: /* all non-iso endpoints */
463 allowed |= URB_SHORT_NOT_OK;
465 case USB_ENDPOINT_XFER_ISOC:
466 allowed |= URB_ISO_ASAP;
469 urb->transfer_flags &= allowed;
472 static void stub_recv_cmd_submit(struct stub_device *sdev,
473 struct usbip_header *pdu)
476 struct stub_priv *priv;
477 struct usbip_device *ud = &sdev->ud;
478 struct usb_device *udev = sdev->udev;
479 int pipe = get_pipe(sdev, pdu->base.ep, pdu->base.direction);
482 priv = stub_priv_alloc(sdev, pdu);
487 if (usb_pipeisoc(pipe))
488 priv->urb = usb_alloc_urb(pdu->u.cmd_submit.number_of_packets,
491 priv->urb = usb_alloc_urb(0, GFP_KERNEL);
494 dev_err(&sdev->interface->dev, "malloc urb\n");
495 usbip_event_add(ud, SDEV_EVENT_ERROR_MALLOC);
499 /* set priv->urb->transfer_buffer */
500 if (pdu->u.cmd_submit.transfer_buffer_length > 0) {
501 priv->urb->transfer_buffer =
502 kzalloc(pdu->u.cmd_submit.transfer_buffer_length,
504 if (!priv->urb->transfer_buffer) {
505 dev_err(&sdev->interface->dev, "malloc x_buff\n");
506 usbip_event_add(ud, SDEV_EVENT_ERROR_MALLOC);
511 /* set priv->urb->setup_packet */
512 priv->urb->setup_packet = kmemdup(&pdu->u.cmd_submit.setup, 8,
514 if (!priv->urb->setup_packet) {
515 dev_err(&sdev->interface->dev, "allocate setup_packet\n");
516 usbip_event_add(ud, SDEV_EVENT_ERROR_MALLOC);
520 /* set other members from the base header of pdu */
521 priv->urb->context = (void *) priv;
522 priv->urb->dev = udev;
523 priv->urb->pipe = pipe;
524 priv->urb->complete = stub_complete;
526 usbip_pack_pdu(pdu, priv->urb, USBIP_CMD_SUBMIT, 0);
529 if (usbip_recv_xbuff(ud, priv->urb) < 0)
532 if (usbip_recv_iso(ud, priv->urb) < 0)
535 /* no need to submit an intercepted request, but harmless? */
536 tweak_special_requests(priv->urb);
538 masking_bogus_flags(priv->urb);
539 /* urb is now ready to submit */
540 ret = usb_submit_urb(priv->urb, GFP_KERNEL);
543 usbip_dbg_stub_rx("submit urb ok, seqnum %u\n",
546 dev_err(&sdev->interface->dev, "submit_urb error, %d\n", ret);
547 usbip_dump_header(pdu);
548 usbip_dump_urb(priv->urb);
552 * This connection will be discarded.
554 usbip_event_add(ud, SDEV_EVENT_ERROR_SUBMIT);
557 usbip_dbg_stub_rx("Leave\n");
562 static void stub_rx_pdu(struct usbip_device *ud)
565 struct usbip_header pdu;
566 struct stub_device *sdev = container_of(ud, struct stub_device, ud);
567 struct device *dev = &sdev->interface->dev;
569 usbip_dbg_stub_rx("Enter\n");
571 memset(&pdu, 0, sizeof(pdu));
573 /* 1. receive a pdu header */
574 ret = usbip_xmit(0, ud->tcp_socket, (char *) &pdu, sizeof(pdu), 0);
575 if (ret != sizeof(pdu)) {
576 dev_err(dev, "recv a header, %d\n", ret);
577 usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
581 usbip_header_correct_endian(&pdu, 0);
583 if (usbip_dbg_flag_stub_rx)
584 usbip_dump_header(&pdu);
586 if (!valid_request(sdev, &pdu)) {
587 dev_err(dev, "recv invalid request\n");
588 usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
592 switch (pdu.base.command) {
593 case USBIP_CMD_UNLINK:
594 stub_recv_cmd_unlink(sdev, &pdu);
597 case USBIP_CMD_SUBMIT:
598 stub_recv_cmd_submit(sdev, &pdu);
603 dev_err(dev, "unknown pdu\n");
604 usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
610 int stub_rx_loop(void *data)
612 struct usbip_device *ud = data;
614 while (!kthread_should_stop()) {
615 if (usbip_event_happened(ud))