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 <asm/byteorder.h>
21 #include <linux/kthread.h>
22 #include <linux/usb.h>
23 #include <linux/usb/hcd.h>
25 #include "usbip_common.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 dev_err(&urb->dev->dev, "usb_clear_halt error: devnum %d endp "
106 "%d ret %d\n", urb->dev->devnum, target_endp, ret);
108 dev_info(&urb->dev->dev, "usb_clear_halt done: devnum %d endp "
109 "%d\n", 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",
126 interface, alternate);
128 ret = usb_set_interface(urb->dev, interface, alternate);
130 dev_err(&urb->dev->dev, "usb_set_interface error: inf %u alt "
131 "%u ret %d\n", interface, alternate, ret);
133 dev_info(&urb->dev->dev, "usb_set_interface done: inf %u alt "
134 "%u\n", interface, alternate);
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 dev_info(&urb->dev->dev, "usb_set_configuration %d to %s... skip!\n",
164 config, dev_name(&urb->dev->dev));
167 /* return usb_driver_set_configuration(urb->dev, config); */
170 static int tweak_reset_device_cmd(struct urb *urb)
172 struct stub_priv *priv = (struct stub_priv *) urb->context;
173 struct stub_device *sdev = priv->sdev;
175 dev_info(&urb->dev->dev, "usb_queue_reset_device\n");
178 * With the implementation of pre_reset and post_reset the driver no
179 * longer unbinds. This allows the use of synchronous reset.
182 if (usb_lock_device_for_reset(sdev->udev, sdev->interface) < 0) {
183 dev_err(&urb->dev->dev, "could not obtain lock to reset device\n");
186 usb_reset_device(sdev->udev);
187 usb_unlock_device(sdev->udev);
193 * clear_halt, set_interface, and set_configuration require special tricks.
195 static void tweak_special_requests(struct urb *urb)
197 if (!urb || !urb->setup_packet)
200 if (usb_pipetype(urb->pipe) != PIPE_CONTROL)
203 if (is_clear_halt_cmd(urb))
204 /* tweak clear_halt */
205 tweak_clear_halt_cmd(urb);
207 else if (is_set_interface_cmd(urb))
208 /* tweak set_interface */
209 tweak_set_interface_cmd(urb);
211 else if (is_set_configuration_cmd(urb))
212 /* tweak set_configuration */
213 tweak_set_configuration_cmd(urb);
215 else if (is_reset_device_cmd(urb))
216 tweak_reset_device_cmd(urb);
218 usbip_dbg_stub_rx("no need to tweak\n");
222 * stub_recv_unlink() unlinks the URB by a call to usb_unlink_urb().
223 * By unlinking the urb asynchronously, stub_rx can continuously
224 * process coming urbs. Even if the urb is unlinked, its completion
225 * handler will be called and stub_tx will send a return pdu.
227 * See also comments about unlinking strategy in vhci_hcd.c.
229 static int stub_recv_cmd_unlink(struct stub_device *sdev,
230 struct usbip_header *pdu)
234 struct stub_priv *priv;
236 spin_lock_irqsave(&sdev->priv_lock, flags);
238 list_for_each_entry(priv, &sdev->priv_init, list) {
239 if (priv->seqnum == pdu->u.cmd_unlink.seqnum) {
242 dev_info(&priv->urb->dev->dev, "unlink urb %p\n",
246 * This matched urb is not completed yet (i.e., be in
247 * flight in usb hcd hardware/driver). Now we are
248 * cancelling it. The unlinking flag means that we are
249 * now not going to return the normal result pdu of a
250 * submission request, but going to return a result pdu
251 * of the unlink request.
256 * In the case that unlinking flag is on, prev->seqnum
257 * is changed from the seqnum of the cancelling urb to
258 * the seqnum of the unlink request. This will be used
259 * to make the result pdu of the unlink request.
261 priv->seqnum = pdu->base.seqnum;
263 spin_unlock_irqrestore(&sdev->priv_lock, flags);
266 * usb_unlink_urb() is now out of spinlocking to avoid
267 * spinlock recursion since stub_complete() is
268 * sometimes called in this context but not in the
269 * interrupt context. If stub_complete() is executed
270 * before we call usb_unlink_urb(), usb_unlink_urb()
271 * will return an error value. In this case, stub_tx
272 * will return the result pdu of this unlink request
273 * though submission is completed and actual unlinking
274 * is not executed. OK?
276 /* In the above case, urb->status is not -ECONNRESET,
277 * so a driver in a client host will know the failure
278 * of the unlink request ?
280 ret = usb_unlink_urb(priv->urb);
281 if (ret != -EINPROGRESS)
282 dev_err(&priv->urb->dev->dev,
283 "failed to unlink a urb %p, ret %d\n",
289 usbip_dbg_stub_rx("seqnum %d is not pending\n",
290 pdu->u.cmd_unlink.seqnum);
293 * The urb of the unlink target is not found in priv_init queue. It was
294 * already completed and its results is/was going to be sent by a
295 * CMD_RET pdu. In this case, usb_unlink_urb() is not needed. We only
296 * return the completeness of this unlink request to vhci_hcd.
298 stub_enqueue_ret_unlink(sdev, pdu->base.seqnum, 0);
300 spin_unlock_irqrestore(&sdev->priv_lock, flags);
305 static int valid_request(struct stub_device *sdev, struct usbip_header *pdu)
307 struct usbip_device *ud = &sdev->ud;
310 if (pdu->base.devid == sdev->devid) {
311 spin_lock(&ud->lock);
312 if (ud->status == SDEV_ST_USED) {
313 /* A request is valid. */
316 spin_unlock(&ud->lock);
322 static struct stub_priv *stub_priv_alloc(struct stub_device *sdev,
323 struct usbip_header *pdu)
325 struct stub_priv *priv;
326 struct usbip_device *ud = &sdev->ud;
329 spin_lock_irqsave(&sdev->priv_lock, flags);
331 priv = kmem_cache_zalloc(stub_priv_cache, GFP_ATOMIC);
333 dev_err(&sdev->interface->dev, "alloc stub_priv\n");
334 spin_unlock_irqrestore(&sdev->priv_lock, flags);
335 usbip_event_add(ud, SDEV_EVENT_ERROR_MALLOC);
339 priv->seqnum = pdu->base.seqnum;
343 * After a stub_priv is linked to a list_head,
344 * our error handler can free allocated data.
346 list_add_tail(&priv->list, &sdev->priv_init);
348 spin_unlock_irqrestore(&sdev->priv_lock, flags);
353 static int get_pipe(struct stub_device *sdev, struct usbip_header *pdu)
355 struct usb_device *udev = sdev->udev;
356 struct usb_host_endpoint *ep;
357 struct usb_endpoint_descriptor *epd = NULL;
358 int epnum = pdu->base.ep;
359 int dir = pdu->base.direction;
361 if (epnum < 0 || epnum > 15)
364 if (dir == USBIP_DIR_IN)
365 ep = udev->ep_in[epnum & 0x7f];
367 ep = udev->ep_out[epnum & 0x7f];
373 /* validate transfer_buffer_length */
374 if (pdu->u.cmd_submit.transfer_buffer_length > INT_MAX) {
375 dev_err(&sdev->interface->dev,
376 "CMD_SUBMIT: -EMSGSIZE transfer_buffer_length %d\n",
377 pdu->u.cmd_submit.transfer_buffer_length);
381 if (usb_endpoint_xfer_control(epd)) {
382 if (dir == USBIP_DIR_OUT)
383 return usb_sndctrlpipe(udev, epnum);
385 return usb_rcvctrlpipe(udev, epnum);
388 if (usb_endpoint_xfer_bulk(epd)) {
389 if (dir == USBIP_DIR_OUT)
390 return usb_sndbulkpipe(udev, epnum);
392 return usb_rcvbulkpipe(udev, epnum);
395 if (usb_endpoint_xfer_int(epd)) {
396 if (dir == USBIP_DIR_OUT)
397 return usb_sndintpipe(udev, epnum);
399 return usb_rcvintpipe(udev, epnum);
402 if (usb_endpoint_xfer_isoc(epd)) {
403 /* validate packet size and number of packets */
404 unsigned int maxp, packets, bytes;
406 maxp = usb_endpoint_maxp(epd);
407 maxp *= usb_endpoint_maxp_mult(epd);
408 bytes = pdu->u.cmd_submit.transfer_buffer_length;
409 packets = DIV_ROUND_UP(bytes, maxp);
411 if (pdu->u.cmd_submit.number_of_packets < 0 ||
412 pdu->u.cmd_submit.number_of_packets > packets) {
413 dev_err(&sdev->interface->dev,
414 "CMD_SUBMIT: isoc invalid num packets %d\n",
415 pdu->u.cmd_submit.number_of_packets);
418 if (dir == USBIP_DIR_OUT)
419 return usb_sndisocpipe(udev, epnum);
421 return usb_rcvisocpipe(udev, epnum);
426 dev_err(&sdev->interface->dev, "CMD_SUBMIT: invalid epnum %d\n", epnum);
430 static void masking_bogus_flags(struct urb *urb)
433 struct usb_device *dev;
434 struct usb_host_endpoint *ep;
436 unsigned int allowed;
438 if (!urb || urb->hcpriv || !urb->complete)
441 if ((!dev) || (dev->state < USB_STATE_UNAUTHENTICATED))
444 ep = (usb_pipein(urb->pipe) ? dev->ep_in : dev->ep_out)
445 [usb_pipeendpoint(urb->pipe)];
449 xfertype = usb_endpoint_type(&ep->desc);
450 if (xfertype == USB_ENDPOINT_XFER_CONTROL) {
451 struct usb_ctrlrequest *setup =
452 (struct usb_ctrlrequest *) urb->setup_packet;
456 is_out = !(setup->bRequestType & USB_DIR_IN) ||
459 is_out = usb_endpoint_dir_out(&ep->desc);
462 /* enforce simple/standard policy */
463 allowed = (URB_NO_TRANSFER_DMA_MAP | URB_NO_INTERRUPT |
464 URB_DIR_MASK | URB_FREE_BUFFER);
466 case USB_ENDPOINT_XFER_BULK:
468 allowed |= URB_ZERO_PACKET;
470 case USB_ENDPOINT_XFER_CONTROL:
471 allowed |= URB_NO_FSBR; /* only affects UHCI */
473 default: /* all non-iso endpoints */
475 allowed |= URB_SHORT_NOT_OK;
477 case USB_ENDPOINT_XFER_ISOC:
478 allowed |= URB_ISO_ASAP;
481 urb->transfer_flags &= allowed;
484 static void stub_recv_cmd_submit(struct stub_device *sdev,
485 struct usbip_header *pdu)
488 struct stub_priv *priv;
489 struct usbip_device *ud = &sdev->ud;
490 struct usb_device *udev = sdev->udev;
491 int pipe = get_pipe(sdev, pdu);
496 priv = stub_priv_alloc(sdev, pdu);
501 if (usb_pipeisoc(pipe))
502 priv->urb = usb_alloc_urb(pdu->u.cmd_submit.number_of_packets,
505 priv->urb = usb_alloc_urb(0, GFP_KERNEL);
508 dev_err(&sdev->interface->dev, "malloc urb\n");
509 usbip_event_add(ud, SDEV_EVENT_ERROR_MALLOC);
513 /* set priv->urb->transfer_buffer */
514 if (pdu->u.cmd_submit.transfer_buffer_length > 0 &&
515 pdu->u.cmd_submit.transfer_buffer_length <= INT_MAX) {
516 priv->urb->transfer_buffer =
517 kzalloc(pdu->u.cmd_submit.transfer_buffer_length,
519 if (!priv->urb->transfer_buffer) {
520 dev_err(&sdev->interface->dev, "malloc x_buff\n");
521 usbip_event_add(ud, SDEV_EVENT_ERROR_MALLOC);
526 /* set priv->urb->setup_packet */
527 priv->urb->setup_packet = kmemdup(&pdu->u.cmd_submit.setup, 8,
529 if (!priv->urb->setup_packet) {
530 dev_err(&sdev->interface->dev, "allocate setup_packet\n");
531 usbip_event_add(ud, SDEV_EVENT_ERROR_MALLOC);
535 /* set other members from the base header of pdu */
536 priv->urb->context = (void *) priv;
537 priv->urb->dev = udev;
538 priv->urb->pipe = pipe;
539 priv->urb->complete = stub_complete;
541 usbip_pack_pdu(pdu, priv->urb, USBIP_CMD_SUBMIT, 0);
544 if (usbip_recv_xbuff(ud, priv->urb) < 0)
547 if (usbip_recv_iso(ud, priv->urb) < 0)
550 /* no need to submit an intercepted request, but harmless? */
551 tweak_special_requests(priv->urb);
553 masking_bogus_flags(priv->urb);
554 /* urb is now ready to submit */
555 ret = usb_submit_urb(priv->urb, GFP_KERNEL);
558 usbip_dbg_stub_rx("submit urb ok, seqnum %u\n",
561 dev_err(&sdev->interface->dev, "submit_urb error, %d\n", ret);
562 usbip_dump_header(pdu);
563 usbip_dump_urb(priv->urb);
567 * This connection will be discarded.
569 usbip_event_add(ud, SDEV_EVENT_ERROR_SUBMIT);
572 usbip_dbg_stub_rx("Leave\n");
577 static void stub_rx_pdu(struct usbip_device *ud)
580 struct usbip_header pdu;
581 struct stub_device *sdev = container_of(ud, struct stub_device, ud);
582 struct device *dev = &sdev->interface->dev;
584 usbip_dbg_stub_rx("Enter\n");
586 memset(&pdu, 0, sizeof(pdu));
588 /* 1. receive a pdu header */
589 ret = usbip_recv(ud->tcp_socket, &pdu, sizeof(pdu));
590 if (ret != sizeof(pdu)) {
591 dev_err(dev, "recv a header, %d\n", ret);
592 usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
596 usbip_header_correct_endian(&pdu, 0);
598 if (usbip_dbg_flag_stub_rx)
599 usbip_dump_header(&pdu);
601 if (!valid_request(sdev, &pdu)) {
602 dev_err(dev, "recv invalid request\n");
603 usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
607 switch (pdu.base.command) {
608 case USBIP_CMD_UNLINK:
609 stub_recv_cmd_unlink(sdev, &pdu);
612 case USBIP_CMD_SUBMIT:
613 stub_recv_cmd_submit(sdev, &pdu);
618 dev_err(dev, "unknown pdu\n");
619 usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
624 int stub_rx_loop(void *data)
626 struct usbip_device *ud = data;
628 while (!kthread_should_stop()) {
629 if (usbip_event_happened(ud))