1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (C) 2003-2008 Takahiro Hirofuchi
6 #include <asm/byteorder.h>
7 #include <linux/kthread.h>
9 #include <linux/usb/hcd.h>
11 #include "usbip_common.h"
14 static int is_clear_halt_cmd(struct urb *urb)
16 struct usb_ctrlrequest *req;
18 req = (struct usb_ctrlrequest *) urb->setup_packet;
20 return (req->bRequest == USB_REQ_CLEAR_FEATURE) &&
21 (req->bRequestType == USB_RECIP_ENDPOINT) &&
22 (req->wValue == USB_ENDPOINT_HALT);
25 static int is_set_interface_cmd(struct urb *urb)
27 struct usb_ctrlrequest *req;
29 req = (struct usb_ctrlrequest *) urb->setup_packet;
31 return (req->bRequest == USB_REQ_SET_INTERFACE) &&
32 (req->bRequestType == USB_RECIP_INTERFACE);
35 static int is_set_configuration_cmd(struct urb *urb)
37 struct usb_ctrlrequest *req;
39 req = (struct usb_ctrlrequest *) urb->setup_packet;
41 return (req->bRequest == USB_REQ_SET_CONFIGURATION) &&
42 (req->bRequestType == USB_RECIP_DEVICE);
45 static int is_reset_device_cmd(struct urb *urb)
47 struct usb_ctrlrequest *req;
51 req = (struct usb_ctrlrequest *) urb->setup_packet;
52 value = le16_to_cpu(req->wValue);
53 index = le16_to_cpu(req->wIndex);
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);
64 static int tweak_clear_halt_cmd(struct urb *urb)
66 struct usb_ctrlrequest *req;
72 req = (struct usb_ctrlrequest *) urb->setup_packet;
75 * The stalled endpoint is specified in the wIndex value. The endpoint
76 * of the urb is the target of this clear_halt request (i.e., control
79 target_endp = le16_to_cpu(req->wIndex) & 0x000f;
81 /* the stalled endpoint direction is IN or OUT?. USB_DIR_IN is 0x80. */
82 target_dir = le16_to_cpu(req->wIndex) & 0x0080;
85 target_pipe = usb_rcvctrlpipe(urb->dev, target_endp);
87 target_pipe = usb_sndctrlpipe(urb->dev, target_endp);
89 ret = usb_clear_halt(urb->dev, target_pipe);
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);
95 dev_info(&urb->dev->dev,
96 "usb_clear_halt done: devnum %d endp %d\n",
97 urb->dev->devnum, target_endp);
102 static int tweak_set_interface_cmd(struct urb *urb)
104 struct usb_ctrlrequest *req;
109 req = (struct usb_ctrlrequest *) urb->setup_packet;
110 alternate = le16_to_cpu(req->wValue);
111 interface = le16_to_cpu(req->wIndex);
113 usbip_dbg_stub_rx("set_interface: inf %u alt %u\n",
114 interface, alternate);
116 ret = usb_set_interface(urb->dev, interface, alternate);
118 dev_err(&urb->dev->dev,
119 "usb_set_interface error: inf %u alt %u ret %d\n",
120 interface, alternate, ret);
122 dev_info(&urb->dev->dev,
123 "usb_set_interface done: inf %u alt %u\n",
124 interface, alternate);
129 static int tweak_set_configuration_cmd(struct urb *urb)
131 struct stub_priv *priv = (struct stub_priv *) urb->context;
132 struct stub_device *sdev = priv->sdev;
133 struct usb_ctrlrequest *req;
137 req = (struct usb_ctrlrequest *) urb->setup_packet;
138 config = le16_to_cpu(req->wValue);
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",
147 static int tweak_reset_device_cmd(struct urb *urb)
149 struct stub_priv *priv = (struct stub_priv *) urb->context;
150 struct stub_device *sdev = priv->sdev;
152 dev_info(&urb->dev->dev, "usb_queue_reset_device\n");
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");
158 usb_reset_device(sdev->udev);
159 usb_unlock_device(sdev->udev);
165 * clear_halt, set_interface, and set_configuration require special tricks.
167 static void tweak_special_requests(struct urb *urb)
169 if (!urb || !urb->setup_packet)
172 if (usb_pipetype(urb->pipe) != PIPE_CONTROL)
175 if (is_clear_halt_cmd(urb))
176 /* tweak clear_halt */
177 tweak_clear_halt_cmd(urb);
179 else if (is_set_interface_cmd(urb))
180 /* tweak set_interface */
181 tweak_set_interface_cmd(urb);
183 else if (is_set_configuration_cmd(urb))
184 /* tweak set_configuration */
185 tweak_set_configuration_cmd(urb);
187 else if (is_reset_device_cmd(urb))
188 tweak_reset_device_cmd(urb);
190 usbip_dbg_stub_rx("no need to tweak\n");
194 * stub_recv_unlink() unlinks the URB by a call to usb_unlink_urb().
195 * By unlinking the urb asynchronously, stub_rx can continuously
196 * process coming urbs. Even if the urb is unlinked, its completion
197 * handler will be called and stub_tx will send a return pdu.
199 * See also comments about unlinking strategy in vhci_hcd.c.
201 static int stub_recv_cmd_unlink(struct stub_device *sdev,
202 struct usbip_header *pdu)
206 struct stub_priv *priv;
208 spin_lock_irqsave(&sdev->priv_lock, flags);
210 list_for_each_entry(priv, &sdev->priv_init, list) {
211 if (priv->seqnum != pdu->u.cmd_unlink.seqnum)
214 dev_info(&priv->urb->dev->dev, "unlink urb %p\n",
218 * This matched urb is not completed yet (i.e., be in
219 * flight in usb hcd hardware/driver). Now we are
220 * cancelling it. The unlinking flag means that we are
221 * now not going to return the normal result pdu of a
222 * submission request, but going to return a result pdu
223 * of the unlink request.
228 * In the case that unlinking flag is on, prev->seqnum
229 * is changed from the seqnum of the cancelling urb to
230 * the seqnum of the unlink request. This will be used
231 * to make the result pdu of the unlink request.
233 priv->seqnum = pdu->base.seqnum;
235 spin_unlock_irqrestore(&sdev->priv_lock, flags);
238 * usb_unlink_urb() is now out of spinlocking to avoid
239 * spinlock recursion since stub_complete() is
240 * sometimes called in this context but not in the
241 * interrupt context. If stub_complete() is executed
242 * before we call usb_unlink_urb(), usb_unlink_urb()
243 * will return an error value. In this case, stub_tx
244 * will return the result pdu of this unlink request
245 * though submission is completed and actual unlinking
246 * is not executed. OK?
248 /* In the above case, urb->status is not -ECONNRESET,
249 * so a driver in a client host will know the failure
250 * of the unlink request ?
252 ret = usb_unlink_urb(priv->urb);
253 if (ret != -EINPROGRESS)
254 dev_err(&priv->urb->dev->dev,
255 "failed to unlink a urb %p, ret %d\n",
261 usbip_dbg_stub_rx("seqnum %d is not pending\n",
262 pdu->u.cmd_unlink.seqnum);
265 * The urb of the unlink target is not found in priv_init queue. It was
266 * already completed and its results is/was going to be sent by a
267 * CMD_RET pdu. In this case, usb_unlink_urb() is not needed. We only
268 * return the completeness of this unlink request to vhci_hcd.
270 stub_enqueue_ret_unlink(sdev, pdu->base.seqnum, 0);
272 spin_unlock_irqrestore(&sdev->priv_lock, flags);
277 static int valid_request(struct stub_device *sdev, struct usbip_header *pdu)
279 struct usbip_device *ud = &sdev->ud;
282 if (pdu->base.devid == sdev->devid) {
283 spin_lock_irq(&ud->lock);
284 if (ud->status == SDEV_ST_USED) {
285 /* A request is valid. */
288 spin_unlock_irq(&ud->lock);
294 static struct stub_priv *stub_priv_alloc(struct stub_device *sdev,
295 struct usbip_header *pdu)
297 struct stub_priv *priv;
298 struct usbip_device *ud = &sdev->ud;
301 spin_lock_irqsave(&sdev->priv_lock, flags);
303 priv = kmem_cache_zalloc(stub_priv_cache, GFP_ATOMIC);
305 dev_err(&sdev->udev->dev, "alloc stub_priv\n");
306 spin_unlock_irqrestore(&sdev->priv_lock, flags);
307 usbip_event_add(ud, SDEV_EVENT_ERROR_MALLOC);
311 priv->seqnum = pdu->base.seqnum;
315 * After a stub_priv is linked to a list_head,
316 * our error handler can free allocated data.
318 list_add_tail(&priv->list, &sdev->priv_init);
320 spin_unlock_irqrestore(&sdev->priv_lock, flags);
325 static int get_pipe(struct stub_device *sdev, int epnum, int dir)
327 struct usb_device *udev = sdev->udev;
328 struct usb_host_endpoint *ep;
329 struct usb_endpoint_descriptor *epd = NULL;
331 if (dir == USBIP_DIR_IN)
332 ep = udev->ep_in[epnum & 0x7f];
334 ep = udev->ep_out[epnum & 0x7f];
336 dev_err(&sdev->udev->dev, "no such endpoint?, %d\n",
342 if (usb_endpoint_xfer_control(epd)) {
343 if (dir == USBIP_DIR_OUT)
344 return usb_sndctrlpipe(udev, epnum);
346 return usb_rcvctrlpipe(udev, epnum);
349 if (usb_endpoint_xfer_bulk(epd)) {
350 if (dir == USBIP_DIR_OUT)
351 return usb_sndbulkpipe(udev, epnum);
353 return usb_rcvbulkpipe(udev, epnum);
356 if (usb_endpoint_xfer_int(epd)) {
357 if (dir == USBIP_DIR_OUT)
358 return usb_sndintpipe(udev, epnum);
360 return usb_rcvintpipe(udev, epnum);
363 if (usb_endpoint_xfer_isoc(epd)) {
364 if (dir == USBIP_DIR_OUT)
365 return usb_sndisocpipe(udev, epnum);
367 return usb_rcvisocpipe(udev, epnum);
371 dev_err(&sdev->udev->dev, "get pipe, epnum %d\n", epnum);
375 static void masking_bogus_flags(struct urb *urb)
378 struct usb_device *dev;
379 struct usb_host_endpoint *ep;
381 unsigned int allowed;
383 if (!urb || urb->hcpriv || !urb->complete)
386 if ((!dev) || (dev->state < USB_STATE_UNAUTHENTICATED))
389 ep = (usb_pipein(urb->pipe) ? dev->ep_in : dev->ep_out)
390 [usb_pipeendpoint(urb->pipe)];
394 xfertype = usb_endpoint_type(&ep->desc);
395 if (xfertype == USB_ENDPOINT_XFER_CONTROL) {
396 struct usb_ctrlrequest *setup =
397 (struct usb_ctrlrequest *) urb->setup_packet;
401 is_out = !(setup->bRequestType & USB_DIR_IN) ||
404 is_out = usb_endpoint_dir_out(&ep->desc);
407 /* enforce simple/standard policy */
408 allowed = (URB_NO_TRANSFER_DMA_MAP | URB_NO_INTERRUPT |
409 URB_DIR_MASK | URB_FREE_BUFFER);
411 case USB_ENDPOINT_XFER_BULK:
413 allowed |= URB_ZERO_PACKET;
415 case USB_ENDPOINT_XFER_CONTROL:
416 allowed |= URB_NO_FSBR; /* only affects UHCI */
418 default: /* all non-iso endpoints */
420 allowed |= URB_SHORT_NOT_OK;
422 case USB_ENDPOINT_XFER_ISOC:
423 allowed |= URB_ISO_ASAP;
426 urb->transfer_flags &= allowed;
429 static void stub_recv_cmd_submit(struct stub_device *sdev,
430 struct usbip_header *pdu)
433 struct stub_priv *priv;
434 struct usbip_device *ud = &sdev->ud;
435 struct usb_device *udev = sdev->udev;
436 int pipe = get_pipe(sdev, pdu->base.ep, pdu->base.direction);
438 priv = stub_priv_alloc(sdev, pdu);
443 if (usb_pipeisoc(pipe))
444 priv->urb = usb_alloc_urb(pdu->u.cmd_submit.number_of_packets,
447 priv->urb = usb_alloc_urb(0, GFP_KERNEL);
450 usbip_event_add(ud, SDEV_EVENT_ERROR_MALLOC);
454 /* allocate urb transfer buffer, if needed */
455 if (pdu->u.cmd_submit.transfer_buffer_length > 0) {
456 priv->urb->transfer_buffer =
457 kzalloc(pdu->u.cmd_submit.transfer_buffer_length,
459 if (!priv->urb->transfer_buffer) {
460 usbip_event_add(ud, SDEV_EVENT_ERROR_MALLOC);
465 /* copy urb setup packet */
466 priv->urb->setup_packet = kmemdup(&pdu->u.cmd_submit.setup, 8,
468 if (!priv->urb->setup_packet) {
469 dev_err(&udev->dev, "allocate setup_packet\n");
470 usbip_event_add(ud, SDEV_EVENT_ERROR_MALLOC);
474 /* set other members from the base header of pdu */
475 priv->urb->context = (void *) priv;
476 priv->urb->dev = udev;
477 priv->urb->pipe = pipe;
478 priv->urb->complete = stub_complete;
480 usbip_pack_pdu(pdu, priv->urb, USBIP_CMD_SUBMIT, 0);
483 if (usbip_recv_xbuff(ud, priv->urb) < 0)
486 if (usbip_recv_iso(ud, priv->urb) < 0)
489 /* no need to submit an intercepted request, but harmless? */
490 tweak_special_requests(priv->urb);
492 masking_bogus_flags(priv->urb);
493 /* urb is now ready to submit */
494 ret = usb_submit_urb(priv->urb, GFP_KERNEL);
497 usbip_dbg_stub_rx("submit urb ok, seqnum %u\n",
500 dev_err(&udev->dev, "submit_urb error, %d\n", ret);
501 usbip_dump_header(pdu);
502 usbip_dump_urb(priv->urb);
506 * This connection will be discarded.
508 usbip_event_add(ud, SDEV_EVENT_ERROR_SUBMIT);
511 usbip_dbg_stub_rx("Leave\n");
515 static void stub_rx_pdu(struct usbip_device *ud)
518 struct usbip_header pdu;
519 struct stub_device *sdev = container_of(ud, struct stub_device, ud);
520 struct device *dev = &sdev->udev->dev;
522 usbip_dbg_stub_rx("Enter\n");
524 memset(&pdu, 0, sizeof(pdu));
526 /* receive a pdu header */
527 ret = usbip_recv(ud->tcp_socket, &pdu, sizeof(pdu));
528 if (ret != sizeof(pdu)) {
529 dev_err(dev, "recv a header, %d\n", ret);
530 usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
534 usbip_header_correct_endian(&pdu, 0);
536 if (usbip_dbg_flag_stub_rx)
537 usbip_dump_header(&pdu);
539 if (!valid_request(sdev, &pdu)) {
540 dev_err(dev, "recv invalid request\n");
541 usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
545 switch (pdu.base.command) {
546 case USBIP_CMD_UNLINK:
547 stub_recv_cmd_unlink(sdev, &pdu);
550 case USBIP_CMD_SUBMIT:
551 stub_recv_cmd_submit(sdev, &pdu);
556 dev_err(dev, "unknown pdu\n");
557 usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
562 int stub_rx_loop(void *data)
564 struct usbip_device *ud = data;
566 while (!kthread_should_stop()) {
567 if (usbip_event_happened(ud))