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 "usbip_common.h"
22 #include "../../usb/core/hcd.h"
25 static int is_clear_halt_cmd(struct urb *urb)
27 struct usb_ctrlrequest *req;
29 req = (struct usb_ctrlrequest *) urb->setup_packet;
31 return (req->bRequest == USB_REQ_CLEAR_FEATURE) &&
32 (req->bRequestType == USB_RECIP_ENDPOINT) &&
33 (req->wValue == USB_ENDPOINT_HALT);
36 static int is_set_interface_cmd(struct urb *urb)
38 struct usb_ctrlrequest *req;
40 req = (struct usb_ctrlrequest *) urb->setup_packet;
42 return (req->bRequest == USB_REQ_SET_INTERFACE) &&
43 (req->bRequestType == USB_RECIP_INTERFACE);
46 static int is_set_configuration_cmd(struct urb *urb)
48 struct usb_ctrlrequest *req;
50 req = (struct usb_ctrlrequest *) urb->setup_packet;
52 return (req->bRequest == USB_REQ_SET_CONFIGURATION) &&
53 (req->bRequestType == USB_RECIP_DEVICE);
56 static int is_reset_device_cmd(struct urb *urb)
58 struct usb_ctrlrequest *req;
62 req = (struct usb_ctrlrequest *) urb->setup_packet;
63 value = le16_to_cpu(req->wValue);
64 index = le16_to_cpu(req->wIndex);
66 if ((req->bRequest == USB_REQ_SET_FEATURE) &&
67 (req->bRequestType == USB_RT_PORT) &&
68 (value == USB_PORT_FEAT_RESET)) {
69 usbip_dbg_stub_rx("reset_device_cmd, port %u\n", index);
75 static int tweak_clear_halt_cmd(struct urb *urb)
77 struct usb_ctrlrequest *req;
83 req = (struct usb_ctrlrequest *) urb->setup_packet;
86 * The stalled endpoint is specified in the wIndex value. The endpoint
87 * of the urb is the target of this clear_halt request (i.e., control
90 target_endp = le16_to_cpu(req->wIndex) & 0x000f;
92 /* the stalled endpoint direction is IN or OUT?. USB_DIR_IN is 0x80. */
93 target_dir = le16_to_cpu(req->wIndex) & 0x0080;
96 target_pipe = usb_rcvctrlpipe(urb->dev, target_endp);
98 target_pipe = usb_sndctrlpipe(urb->dev, target_endp);
100 ret = usb_clear_halt(urb->dev, target_pipe);
102 usbip_uinfo("clear_halt error: devnum %d endp %d, %d\n",
103 urb->dev->devnum, target_endp, ret);
105 usbip_uinfo("clear_halt done: devnum %d endp %d\n",
106 urb->dev->devnum, target_endp);
111 static int tweak_set_interface_cmd(struct urb *urb)
113 struct usb_ctrlrequest *req;
118 req = (struct usb_ctrlrequest *) urb->setup_packet;
119 alternate = le16_to_cpu(req->wValue);
120 interface = le16_to_cpu(req->wIndex);
122 usbip_dbg_stub_rx("set_interface: inf %u alt %u\n", interface,
125 ret = usb_set_interface(urb->dev, interface, alternate);
127 usbip_uinfo("set_interface error: inf %u alt %u, %d\n",
128 interface, alternate, ret);
130 usbip_uinfo("set_interface done: inf %u alt %u\n",
137 static int tweak_set_configuration_cmd(struct urb *urb)
139 struct usb_ctrlrequest *req;
142 req = (struct usb_ctrlrequest *) urb->setup_packet;
143 config = le16_to_cpu(req->wValue);
146 * I have never seen a multi-config device. Very rare.
147 * For most devices, this will be called to choose a default
148 * configuration only once in an initialization phase.
150 * set_configuration may change a device configuration and its device
151 * drivers will be unbound and assigned for a new device configuration.
152 * This means this usbip driver will be also unbound when called, then
153 * eventually reassigned to the device as far as driver matching
156 * Unfortunatelly, an existing usbip connection will be dropped
157 * due to this driver unbinding. So, skip here.
158 * A user may need to set a special configuration value before
159 * exporting the device.
161 usbip_uinfo("set_configuration (%d) to %s\n", config,
162 dev_name(&urb->dev->dev));
163 usbip_uinfo("but, skip!\n");
166 /* return usb_driver_set_configuration(urb->dev, config); */
169 static int tweak_reset_device_cmd(struct urb *urb)
171 struct stub_priv *priv = (struct stub_priv *) urb->context;
172 struct stub_device *sdev = priv->sdev;
174 usbip_uinfo("reset_device %s\n", dev_name(&urb->dev->dev));
177 * usb_lock_device_for_reset caused a deadlock: it causes the driver
178 * to unbind. In the shutdown the rx thread is signalled to shut down
179 * but this thread is pending in the usb_lock_device_for_reset.
181 * Instead queue the reset.
183 * Unfortunatly an existing usbip connection will be dropped due to
186 usb_queue_reset_device(sdev->interface);
191 * clear_halt, set_interface, and set_configuration require special tricks.
193 static void tweak_special_requests(struct urb *urb)
195 if (!urb || !urb->setup_packet)
198 if (usb_pipetype(urb->pipe) != PIPE_CONTROL)
201 if (is_clear_halt_cmd(urb))
202 /* tweak clear_halt */
203 tweak_clear_halt_cmd(urb);
205 else if (is_set_interface_cmd(urb))
206 /* tweak set_interface */
207 tweak_set_interface_cmd(urb);
209 else if (is_set_configuration_cmd(urb))
210 /* tweak set_configuration */
211 tweak_set_configuration_cmd(urb);
213 else if (is_reset_device_cmd(urb))
214 tweak_reset_device_cmd(urb);
216 usbip_dbg_stub_rx("no need to tweak\n");
220 * stub_recv_unlink() unlinks the URB by a call to usb_unlink_urb().
221 * By unlinking the urb asynchronously, stub_rx can continuously
222 * process coming urbs. Even if the urb is unlinked, its completion
223 * handler will be called and stub_tx will send a return pdu.
225 * See also comments about unlinking strategy in vhci_hcd.c.
227 static int stub_recv_cmd_unlink(struct stub_device *sdev,
228 struct usbip_header *pdu)
232 struct stub_priv *priv;
235 spin_lock_irqsave(&sdev->priv_lock, flags);
237 list_for_each_entry(priv, &sdev->priv_init, list) {
238 if (priv->seqnum == pdu->u.cmd_unlink.seqnum) {
241 dev_info(&priv->urb->dev->dev, "unlink urb %p\n",
245 * This matched urb is not completed yet (i.e., be in
246 * flight in usb hcd hardware/driver). Now we are
247 * cancelling it. The unlinking flag means that we are
248 * now not going to return the normal result pdu of a
249 * submission request, but going to return a result pdu
250 * of the unlink request.
255 * In the case that unlinking flag is on, prev->seqnum
256 * is changed from the seqnum of the cancelling urb to
257 * the seqnum of the unlink request. This will be used
258 * to make the result pdu of the unlink request.
260 priv->seqnum = pdu->base.seqnum;
262 spin_unlock_irqrestore(&sdev->priv_lock, flags);
265 * usb_unlink_urb() is now out of spinlocking to avoid
266 * spinlock recursion since stub_complete() is
267 * sometimes called in this context but not in the
268 * interrupt context. If stub_complete() is executed
269 * before we call usb_unlink_urb(), usb_unlink_urb()
270 * will return an error value. In this case, stub_tx
271 * will return the result pdu of this unlink request
272 * though submission is completed and actual unlinking
273 * is not executed. OK?
275 /* In the above case, urb->status is not -ECONNRESET,
276 * so a driver in a client host will know the failure
277 * of the unlink request ?
279 ret = usb_unlink_urb(priv->urb);
280 if (ret != -EINPROGRESS)
281 dev_err(&priv->urb->dev->dev,
282 "failed to unlink a urb %p, ret %d\n",
288 usbip_dbg_stub_rx("seqnum %d is not pending\n",
289 pdu->u.cmd_unlink.seqnum);
292 * The urb of the unlink target is not found in priv_init queue. It was
293 * already completed and its results is/was going to be sent by a
294 * CMD_RET pdu. In this case, usb_unlink_urb() is not needed. We only
295 * return the completeness of this unlink request to vhci_hcd.
297 stub_enqueue_ret_unlink(sdev, pdu->base.seqnum, 0);
299 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;
309 if (pdu->base.devid == sdev->devid) {
310 spin_lock(&ud->lock);
311 if (ud->status == SDEV_ST_USED) {
312 /* A request is valid. */
313 spin_unlock(&ud->lock);
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);
354 static struct usb_host_endpoint *get_ep_from_epnum(struct usb_device *udev,
357 struct usb_host_config *config;
359 struct usb_host_endpoint *ep = NULL;
366 config = udev->actconfig;
370 for (i = 0; i < config->desc.bNumInterfaces; i++) {
371 struct usb_host_interface *setting;
373 setting = config->interface[i]->cur_altsetting;
375 for (j = 0; j < setting->desc.bNumEndpoints; j++) {
376 ep = &setting->endpoint[j];
377 epnum = (ep->desc.bEndpointAddress & 0x7f);
379 if (epnum == epnum0) {
380 /* usbip_uinfo("found epnum %d\n", epnum0);*/
394 static int get_pipe(struct stub_device *sdev, int epnum, int dir)
396 struct usb_device *udev = interface_to_usbdev(sdev->interface);
397 struct usb_host_endpoint *ep;
398 struct usb_endpoint_descriptor *epd = NULL;
400 ep = get_ep_from_epnum(udev, epnum);
402 dev_err(&sdev->interface->dev, "no such endpoint?, %d\n",
411 /* epnum 0 is always control */
413 if (dir == USBIP_DIR_OUT)
414 return usb_sndctrlpipe(udev, 0);
416 return usb_rcvctrlpipe(udev, 0);
420 if (usb_endpoint_xfer_control(epd)) {
421 if (dir == USBIP_DIR_OUT)
422 return usb_sndctrlpipe(udev, epnum);
424 return usb_rcvctrlpipe(udev, epnum);
427 if (usb_endpoint_xfer_bulk(epd)) {
428 if (dir == USBIP_DIR_OUT)
429 return usb_sndbulkpipe(udev, epnum);
431 return usb_rcvbulkpipe(udev, epnum);
434 if (usb_endpoint_xfer_int(epd)) {
435 if (dir == USBIP_DIR_OUT)
436 return usb_sndintpipe(udev, epnum);
438 return usb_rcvintpipe(udev, epnum);
441 if (usb_endpoint_xfer_isoc(epd)) {
442 if (dir == USBIP_DIR_OUT)
443 return usb_sndisocpipe(udev, epnum);
445 return usb_rcvisocpipe(udev, epnum);
449 dev_err(&sdev->interface->dev, "get pipe, epnum %d\n", epnum);
453 static void stub_recv_cmd_submit(struct stub_device *sdev,
454 struct usbip_header *pdu)
457 struct stub_priv *priv;
458 struct usbip_device *ud = &sdev->ud;
459 struct usb_device *udev = interface_to_usbdev(sdev->interface);
460 int pipe = get_pipe(sdev, pdu->base.ep, pdu->base.direction);
463 priv = stub_priv_alloc(sdev, pdu);
468 if (usb_pipeisoc(pipe))
469 priv->urb = usb_alloc_urb(pdu->u.cmd_submit.number_of_packets,
472 priv->urb = usb_alloc_urb(0, GFP_KERNEL);
475 dev_err(&sdev->interface->dev, "malloc urb\n");
476 usbip_event_add(ud, SDEV_EVENT_ERROR_MALLOC);
480 /* set priv->urb->transfer_buffer */
481 if (pdu->u.cmd_submit.transfer_buffer_length > 0) {
482 priv->urb->transfer_buffer =
483 kzalloc(pdu->u.cmd_submit.transfer_buffer_length,
485 if (!priv->urb->transfer_buffer) {
486 dev_err(&sdev->interface->dev, "malloc x_buff\n");
487 usbip_event_add(ud, SDEV_EVENT_ERROR_MALLOC);
492 /* set priv->urb->setup_packet */
493 priv->urb->setup_packet = kzalloc(8, GFP_KERNEL);
494 if (!priv->urb->setup_packet) {
495 dev_err(&sdev->interface->dev, "allocate setup_packet\n");
496 usbip_event_add(ud, SDEV_EVENT_ERROR_MALLOC);
499 memcpy(priv->urb->setup_packet, &pdu->u.cmd_submit.setup, 8);
501 /* set other members from the base header of pdu */
502 priv->urb->context = (void *) priv;
503 priv->urb->dev = udev;
504 priv->urb->pipe = pipe;
505 priv->urb->complete = stub_complete;
507 usbip_pack_pdu(pdu, priv->urb, USBIP_CMD_SUBMIT, 0);
510 if (usbip_recv_xbuff(ud, priv->urb) < 0)
513 if (usbip_recv_iso(ud, priv->urb) < 0)
516 /* no need to submit an intercepted request, but harmless? */
517 tweak_special_requests(priv->urb);
519 /* urb is now ready to submit */
520 ret = usb_submit_urb(priv->urb, GFP_KERNEL);
523 usbip_dbg_stub_rx("submit urb ok, seqnum %u\n",
526 dev_err(&sdev->interface->dev, "submit_urb error, %d\n", ret);
527 usbip_dump_header(pdu);
528 usbip_dump_urb(priv->urb);
532 * This connection will be discarded.
534 usbip_event_add(ud, SDEV_EVENT_ERROR_SUBMIT);
537 usbip_dbg_stub_rx("Leave\n");
542 static void stub_rx_pdu(struct usbip_device *ud)
545 struct usbip_header pdu;
546 struct stub_device *sdev = container_of(ud, struct stub_device, ud);
547 struct device *dev = &sdev->interface->dev;
549 usbip_dbg_stub_rx("Enter\n");
551 memset(&pdu, 0, sizeof(pdu));
553 /* 1. receive a pdu header */
554 ret = usbip_xmit(0, ud->tcp_socket, (char *) &pdu, sizeof(pdu), 0);
555 if (ret != sizeof(pdu)) {
556 dev_err(dev, "recv a header, %d\n", ret);
557 usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
561 usbip_header_correct_endian(&pdu, 0);
563 if (usbip_dbg_flag_stub_rx)
564 usbip_dump_header(&pdu);
566 if (!valid_request(sdev, &pdu)) {
567 dev_err(dev, "recv invalid request\n");
568 usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
572 switch (pdu.base.command) {
573 case USBIP_CMD_UNLINK:
574 stub_recv_cmd_unlink(sdev, &pdu);
577 case USBIP_CMD_SUBMIT:
578 stub_recv_cmd_submit(sdev, &pdu);
583 dev_err(dev, "unknown pdu\n");
584 usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
590 void stub_rx_loop(struct usbip_task *ut)
592 struct usbip_device *ud = container_of(ut, struct usbip_device, tcp_rx);
595 if (signal_pending(current)) {
596 usbip_dbg_stub_rx("signal caught!\n");
600 if (usbip_event_happened(ud))