2 * Copyright (C) 2003-2008 Takahiro Hirofuchi
3 * Copyright (C) 2015-2016 Samsung Electronics
4 * Krzysztof Opasiak <k.opasiak@samsung.com>
6 * This is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
22 #include <asm/byteorder.h>
23 #include <linux/file.h>
25 #include <linux/kernel.h>
26 #include <linux/slab.h>
27 #include <linux/stat.h>
28 #include <linux/module.h>
29 #include <linux/moduleparam.h>
32 #include "usbip_common.h"
34 #define DRIVER_AUTHOR "Takahiro Hirofuchi <hirofuchi@users.sourceforge.net>"
35 #define DRIVER_DESC "USB/IP Core"
37 #ifdef CONFIG_USBIP_DEBUG
38 unsigned long usbip_debug_flag = 0xffffffff;
40 unsigned long usbip_debug_flag;
42 EXPORT_SYMBOL_GPL(usbip_debug_flag);
43 module_param(usbip_debug_flag, ulong, S_IRUGO|S_IWUSR);
44 MODULE_PARM_DESC(usbip_debug_flag, "debug flags (defined in usbip_common.h)");
47 struct device_attribute dev_attr_usbip_debug;
48 EXPORT_SYMBOL_GPL(dev_attr_usbip_debug);
50 static ssize_t usbip_debug_show(struct device *dev,
51 struct device_attribute *attr, char *buf)
53 return sprintf(buf, "%lx\n", usbip_debug_flag);
56 static ssize_t usbip_debug_store(struct device *dev,
57 struct device_attribute *attr, const char *buf,
60 if (sscanf(buf, "%lx", &usbip_debug_flag) != 1)
64 DEVICE_ATTR_RW(usbip_debug);
66 static void usbip_dump_buffer(char *buff, int bufflen)
68 print_hex_dump(KERN_DEBUG, "usbip-core", DUMP_PREFIX_OFFSET, 16, 4,
69 buff, bufflen, false);
72 static void usbip_dump_pipe(unsigned int p)
74 unsigned char type = usb_pipetype(p);
75 unsigned char ep = usb_pipeendpoint(p);
76 unsigned char dev = usb_pipedevice(p);
77 unsigned char dir = usb_pipein(p);
79 pr_debug("dev(%d) ep(%d) [%s] ", dev, ep, dir ? "IN" : "OUT");
82 case PIPE_ISOCHRONOUS:
100 static void usbip_dump_usb_device(struct usb_device *udev)
102 struct device *dev = &udev->dev;
105 dev_dbg(dev, " devnum(%d) devpath(%s) usb speed(%s)",
106 udev->devnum, udev->devpath, usb_speed_string(udev->speed));
108 pr_debug("tt hub ttport %d\n", udev->ttport);
111 for (i = 0; i < 16; i++)
115 dev_dbg(dev, " toggle0(IN) :");
116 for (i = 0; i < 16; i++)
117 pr_debug(" %2u", (udev->toggle[0] & (1 << i)) ? 1 : 0);
120 dev_dbg(dev, " toggle1(OUT):");
121 for (i = 0; i < 16; i++)
122 pr_debug(" %2u", (udev->toggle[1] & (1 << i)) ? 1 : 0);
125 dev_dbg(dev, " epmaxp_in :");
126 for (i = 0; i < 16; i++) {
129 le16_to_cpu(udev->ep_in[i]->desc.wMaxPacketSize));
133 dev_dbg(dev, " epmaxp_out :");
134 for (i = 0; i < 16; i++) {
137 le16_to_cpu(udev->ep_out[i]->desc.wMaxPacketSize));
141 dev_dbg(dev, "parent %s, bus %s\n", dev_name(&udev->parent->dev),
142 udev->bus->bus_name);
144 dev_dbg(dev, "have_langid %d, string_langid %d\n",
145 udev->have_langid, udev->string_langid);
147 dev_dbg(dev, "maxchild %d\n", udev->maxchild);
150 static void usbip_dump_request_type(__u8 rt)
152 switch (rt & USB_RECIP_MASK) {
153 case USB_RECIP_DEVICE:
156 case USB_RECIP_INTERFACE:
159 case USB_RECIP_ENDPOINT:
162 case USB_RECIP_OTHER:
171 static void usbip_dump_usb_ctrlrequest(struct usb_ctrlrequest *cmd)
174 pr_debug(" : null pointer\n");
179 pr_debug("bRequestType(%02X) bRequest(%02X) wValue(%04X) wIndex(%04X) wLength(%04X) ",
180 cmd->bRequestType, cmd->bRequest,
181 cmd->wValue, cmd->wIndex, cmd->wLength);
184 if ((cmd->bRequestType & USB_TYPE_MASK) == USB_TYPE_STANDARD) {
185 pr_debug("STANDARD ");
186 switch (cmd->bRequest) {
187 case USB_REQ_GET_STATUS:
188 pr_debug("GET_STATUS\n");
190 case USB_REQ_CLEAR_FEATURE:
191 pr_debug("CLEAR_FEAT\n");
193 case USB_REQ_SET_FEATURE:
194 pr_debug("SET_FEAT\n");
196 case USB_REQ_SET_ADDRESS:
197 pr_debug("SET_ADDRRS\n");
199 case USB_REQ_GET_DESCRIPTOR:
200 pr_debug("GET_DESCRI\n");
202 case USB_REQ_SET_DESCRIPTOR:
203 pr_debug("SET_DESCRI\n");
205 case USB_REQ_GET_CONFIGURATION:
206 pr_debug("GET_CONFIG\n");
208 case USB_REQ_SET_CONFIGURATION:
209 pr_debug("SET_CONFIG\n");
211 case USB_REQ_GET_INTERFACE:
212 pr_debug("GET_INTERF\n");
214 case USB_REQ_SET_INTERFACE:
215 pr_debug("SET_INTERF\n");
217 case USB_REQ_SYNCH_FRAME:
218 pr_debug("SYNC_FRAME\n");
221 pr_debug("REQ(%02X)\n", cmd->bRequest);
224 usbip_dump_request_type(cmd->bRequestType);
225 } else if ((cmd->bRequestType & USB_TYPE_MASK) == USB_TYPE_CLASS) {
227 } else if ((cmd->bRequestType & USB_TYPE_MASK) == USB_TYPE_VENDOR) {
228 pr_debug("VENDOR\n");
229 } else if ((cmd->bRequestType & USB_TYPE_MASK) == USB_TYPE_RESERVED) {
230 pr_debug("RESERVED\n");
234 void usbip_dump_urb(struct urb *urb)
239 pr_debug("urb: null pointer!!\n");
244 pr_debug("urb->dev: null pointer!!\n");
248 dev = &urb->dev->dev;
250 usbip_dump_usb_device(urb->dev);
252 dev_dbg(dev, " pipe :%08x ", urb->pipe);
254 usbip_dump_pipe(urb->pipe);
256 dev_dbg(dev, " status :%d\n", urb->status);
257 dev_dbg(dev, " transfer_flags :%08X\n", urb->transfer_flags);
258 dev_dbg(dev, " transfer_buffer_length:%d\n",
259 urb->transfer_buffer_length);
260 dev_dbg(dev, " actual_length :%d\n", urb->actual_length);
262 if (urb->setup_packet && usb_pipetype(urb->pipe) == PIPE_CONTROL)
263 usbip_dump_usb_ctrlrequest(
264 (struct usb_ctrlrequest *)urb->setup_packet);
266 dev_dbg(dev, " start_frame :%d\n", urb->start_frame);
267 dev_dbg(dev, " number_of_packets :%d\n", urb->number_of_packets);
268 dev_dbg(dev, " interval :%d\n", urb->interval);
269 dev_dbg(dev, " error_count :%d\n", urb->error_count);
271 EXPORT_SYMBOL_GPL(usbip_dump_urb);
273 void usbip_dump_header(struct usbip_header *pdu)
275 pr_debug("BASE: cmd %u seq %u devid %u dir %u ep %u\n",
282 switch (pdu->base.command) {
283 case USBIP_CMD_SUBMIT:
284 pr_debug("USBIP_CMD_SUBMIT: x_flags %u x_len %u sf %u #p %d iv %d\n",
285 pdu->u.cmd_submit.transfer_flags,
286 pdu->u.cmd_submit.transfer_buffer_length,
287 pdu->u.cmd_submit.start_frame,
288 pdu->u.cmd_submit.number_of_packets,
289 pdu->u.cmd_submit.interval);
291 case USBIP_CMD_UNLINK:
292 pr_debug("USBIP_CMD_UNLINK: seq %u\n",
293 pdu->u.cmd_unlink.seqnum);
295 case USBIP_RET_SUBMIT:
296 pr_debug("USBIP_RET_SUBMIT: st %d al %u sf %d #p %d ec %d\n",
297 pdu->u.ret_submit.status,
298 pdu->u.ret_submit.actual_length,
299 pdu->u.ret_submit.start_frame,
300 pdu->u.ret_submit.number_of_packets,
301 pdu->u.ret_submit.error_count);
303 case USBIP_RET_UNLINK:
304 pr_debug("USBIP_RET_UNLINK: status %d\n",
305 pdu->u.ret_unlink.status);
309 pr_err("unknown command\n");
313 EXPORT_SYMBOL_GPL(usbip_dump_header);
315 /* Receive data over TCP/IP. */
316 int usbip_recv(struct socket *sock, void *buf, int size)
319 struct kvec iov = {.iov_base = buf, .iov_len = size};
320 struct msghdr msg = {.msg_flags = MSG_NOSIGNAL};
323 if (!sock || !buf || !size)
326 iov_iter_kvec(&msg.msg_iter, READ|ITER_KVEC, &iov, 1, size);
328 usbip_dbg_xmit("enter\n");
332 sock->sk->sk_allocation = GFP_NOIO;
334 result = sock_recvmsg(sock, &msg, MSG_WAITALL);
339 } while (msg_data_left(&msg));
341 if (usbip_dbg_flag_xmit) {
343 pr_debug("%-10s:", current->comm);
345 pr_debug("interrupt :");
347 pr_debug("receiving....\n");
348 usbip_dump_buffer(buf, size);
349 pr_debug("received, osize %d ret %d size %zd total %d\n",
350 size, result, msg_data_left(&msg), total);
358 EXPORT_SYMBOL_GPL(usbip_recv);
360 /* there may be more cases to tweak the flags. */
361 static unsigned int tweak_transfer_flags(unsigned int flags)
363 flags &= ~URB_NO_TRANSFER_DMA_MAP;
367 static void usbip_pack_cmd_submit(struct usbip_header *pdu, struct urb *urb,
370 struct usbip_header_cmd_submit *spdu = &pdu->u.cmd_submit;
373 * Some members are not still implemented in usbip. I hope this issue
374 * will be discussed when usbip is ported to other operating systems.
377 spdu->transfer_flags =
378 tweak_transfer_flags(urb->transfer_flags);
379 spdu->transfer_buffer_length = urb->transfer_buffer_length;
380 spdu->start_frame = urb->start_frame;
381 spdu->number_of_packets = urb->number_of_packets;
382 spdu->interval = urb->interval;
384 urb->transfer_flags = spdu->transfer_flags;
385 urb->transfer_buffer_length = spdu->transfer_buffer_length;
386 urb->start_frame = spdu->start_frame;
387 urb->number_of_packets = spdu->number_of_packets;
388 urb->interval = spdu->interval;
392 static void usbip_pack_ret_submit(struct usbip_header *pdu, struct urb *urb,
395 struct usbip_header_ret_submit *rpdu = &pdu->u.ret_submit;
398 rpdu->status = urb->status;
399 rpdu->actual_length = urb->actual_length;
400 rpdu->start_frame = urb->start_frame;
401 rpdu->number_of_packets = urb->number_of_packets;
402 rpdu->error_count = urb->error_count;
404 urb->status = rpdu->status;
405 urb->actual_length = rpdu->actual_length;
406 urb->start_frame = rpdu->start_frame;
407 urb->number_of_packets = rpdu->number_of_packets;
408 urb->error_count = rpdu->error_count;
412 void usbip_pack_pdu(struct usbip_header *pdu, struct urb *urb, int cmd,
416 case USBIP_CMD_SUBMIT:
417 usbip_pack_cmd_submit(pdu, urb, pack);
419 case USBIP_RET_SUBMIT:
420 usbip_pack_ret_submit(pdu, urb, pack);
424 pr_err("unknown command\n");
428 EXPORT_SYMBOL_GPL(usbip_pack_pdu);
430 static void correct_endian_basic(struct usbip_header_basic *base, int send)
433 base->command = cpu_to_be32(base->command);
434 base->seqnum = cpu_to_be32(base->seqnum);
435 base->devid = cpu_to_be32(base->devid);
436 base->direction = cpu_to_be32(base->direction);
437 base->ep = cpu_to_be32(base->ep);
439 base->command = be32_to_cpu(base->command);
440 base->seqnum = be32_to_cpu(base->seqnum);
441 base->devid = be32_to_cpu(base->devid);
442 base->direction = be32_to_cpu(base->direction);
443 base->ep = be32_to_cpu(base->ep);
447 static void correct_endian_cmd_submit(struct usbip_header_cmd_submit *pdu,
451 pdu->transfer_flags = cpu_to_be32(pdu->transfer_flags);
453 cpu_to_be32s(&pdu->transfer_buffer_length);
454 cpu_to_be32s(&pdu->start_frame);
455 cpu_to_be32s(&pdu->number_of_packets);
456 cpu_to_be32s(&pdu->interval);
458 pdu->transfer_flags = be32_to_cpu(pdu->transfer_flags);
460 be32_to_cpus(&pdu->transfer_buffer_length);
461 be32_to_cpus(&pdu->start_frame);
462 be32_to_cpus(&pdu->number_of_packets);
463 be32_to_cpus(&pdu->interval);
467 static void correct_endian_ret_submit(struct usbip_header_ret_submit *pdu,
471 cpu_to_be32s(&pdu->status);
472 cpu_to_be32s(&pdu->actual_length);
473 cpu_to_be32s(&pdu->start_frame);
474 cpu_to_be32s(&pdu->number_of_packets);
475 cpu_to_be32s(&pdu->error_count);
477 be32_to_cpus(&pdu->status);
478 be32_to_cpus(&pdu->actual_length);
479 be32_to_cpus(&pdu->start_frame);
480 be32_to_cpus(&pdu->number_of_packets);
481 be32_to_cpus(&pdu->error_count);
485 static void correct_endian_cmd_unlink(struct usbip_header_cmd_unlink *pdu,
489 pdu->seqnum = cpu_to_be32(pdu->seqnum);
491 pdu->seqnum = be32_to_cpu(pdu->seqnum);
494 static void correct_endian_ret_unlink(struct usbip_header_ret_unlink *pdu,
498 cpu_to_be32s(&pdu->status);
500 be32_to_cpus(&pdu->status);
503 void usbip_header_correct_endian(struct usbip_header *pdu, int send)
508 cmd = pdu->base.command;
510 correct_endian_basic(&pdu->base, send);
513 cmd = pdu->base.command;
516 case USBIP_CMD_SUBMIT:
517 correct_endian_cmd_submit(&pdu->u.cmd_submit, send);
519 case USBIP_RET_SUBMIT:
520 correct_endian_ret_submit(&pdu->u.ret_submit, send);
522 case USBIP_CMD_UNLINK:
523 correct_endian_cmd_unlink(&pdu->u.cmd_unlink, send);
525 case USBIP_RET_UNLINK:
526 correct_endian_ret_unlink(&pdu->u.ret_unlink, send);
530 pr_err("unknown command\n");
534 EXPORT_SYMBOL_GPL(usbip_header_correct_endian);
536 static void usbip_iso_packet_correct_endian(
537 struct usbip_iso_packet_descriptor *iso, int send)
539 /* does not need all members. but copy all simply. */
541 iso->offset = cpu_to_be32(iso->offset);
542 iso->length = cpu_to_be32(iso->length);
543 iso->status = cpu_to_be32(iso->status);
544 iso->actual_length = cpu_to_be32(iso->actual_length);
546 iso->offset = be32_to_cpu(iso->offset);
547 iso->length = be32_to_cpu(iso->length);
548 iso->status = be32_to_cpu(iso->status);
549 iso->actual_length = be32_to_cpu(iso->actual_length);
553 static void usbip_pack_iso(struct usbip_iso_packet_descriptor *iso,
554 struct usb_iso_packet_descriptor *uiso, int pack)
557 iso->offset = uiso->offset;
558 iso->length = uiso->length;
559 iso->status = uiso->status;
560 iso->actual_length = uiso->actual_length;
562 uiso->offset = iso->offset;
563 uiso->length = iso->length;
564 uiso->status = iso->status;
565 uiso->actual_length = iso->actual_length;
569 /* must free buffer */
570 struct usbip_iso_packet_descriptor*
571 usbip_alloc_iso_desc_pdu(struct urb *urb, ssize_t *bufflen)
573 struct usbip_iso_packet_descriptor *iso;
574 int np = urb->number_of_packets;
575 ssize_t size = np * sizeof(*iso);
578 iso = kzalloc(size, GFP_KERNEL);
582 for (i = 0; i < np; i++) {
583 usbip_pack_iso(&iso[i], &urb->iso_frame_desc[i], 1);
584 usbip_iso_packet_correct_endian(&iso[i], 1);
591 EXPORT_SYMBOL_GPL(usbip_alloc_iso_desc_pdu);
593 /* some members of urb must be substituted before. */
594 int usbip_recv_iso(struct usbip_device *ud, struct urb *urb)
597 struct usbip_iso_packet_descriptor *iso;
598 int np = urb->number_of_packets;
599 int size = np * sizeof(*iso);
602 int total_length = 0;
604 if (!usb_pipeisoc(urb->pipe))
607 /* my Bluetooth dongle gets ISO URBs which are np = 0 */
611 buff = kzalloc(size, GFP_KERNEL);
615 ret = usbip_recv(ud->tcp_socket, buff, size);
617 dev_err(&urb->dev->dev, "recv iso_frame_descriptor, %d\n",
621 if (ud->side == USBIP_STUB || ud->side == USBIP_VUDC)
622 usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
624 usbip_event_add(ud, VDEV_EVENT_ERROR_TCP);
629 iso = (struct usbip_iso_packet_descriptor *) buff;
630 for (i = 0; i < np; i++) {
631 usbip_iso_packet_correct_endian(&iso[i], 0);
632 usbip_pack_iso(&iso[i], &urb->iso_frame_desc[i], 0);
633 total_length += urb->iso_frame_desc[i].actual_length;
638 if (total_length != urb->actual_length) {
639 dev_err(&urb->dev->dev,
640 "total length of iso packets %d not equal to actual length of buffer %d\n",
641 total_length, urb->actual_length);
643 if (ud->side == USBIP_STUB || ud->side == USBIP_VUDC)
644 usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
646 usbip_event_add(ud, VDEV_EVENT_ERROR_TCP);
653 EXPORT_SYMBOL_GPL(usbip_recv_iso);
656 * This functions restores the padding which was removed for optimizing
657 * the bandwidth during transfer over tcp/ip
659 * buffer and iso packets need to be stored and be in propeper endian in urb
660 * before calling this function
662 void usbip_pad_iso(struct usbip_device *ud, struct urb *urb)
664 int np = urb->number_of_packets;
666 int actualoffset = urb->actual_length;
668 if (!usb_pipeisoc(urb->pipe))
671 /* if no packets or length of data is 0, then nothing to unpack */
672 if (np == 0 || urb->actual_length == 0)
676 * if actual_length is transfer_buffer_length then no padding is
679 if (urb->actual_length == urb->transfer_buffer_length)
683 * loop over all packets from last to first (to prevent overwriting
684 * memory when padding) and move them into the proper place
686 for (i = np-1; i > 0; i--) {
687 actualoffset -= urb->iso_frame_desc[i].actual_length;
688 memmove(urb->transfer_buffer + urb->iso_frame_desc[i].offset,
689 urb->transfer_buffer + actualoffset,
690 urb->iso_frame_desc[i].actual_length);
693 EXPORT_SYMBOL_GPL(usbip_pad_iso);
695 /* some members of urb must be substituted before. */
696 int usbip_recv_xbuff(struct usbip_device *ud, struct urb *urb)
698 struct scatterlist *sg;
705 if (ud->side == USBIP_STUB || ud->side == USBIP_VUDC) {
706 /* the direction of urb must be OUT. */
707 if (usb_pipein(urb->pipe))
710 size = urb->transfer_buffer_length;
712 /* the direction of urb must be IN. */
713 if (usb_pipeout(urb->pipe))
716 size = urb->actual_length;
719 /* no need to recv xbuff */
723 if (size > urb->transfer_buffer_length)
724 /* should not happen, probably malicious packet */
729 for_each_sg(urb->sg, sg, urb->num_sgs, i) {
732 if (copy < sg->length)
735 recv_size = sg->length;
737 recv = usbip_recv(ud->tcp_socket, sg_virt(sg),
740 if (recv != recv_size)
753 ret = usbip_recv(ud->tcp_socket, urb->transfer_buffer, size);
761 dev_err(&urb->dev->dev, "recv xbuf, %d\n", ret);
762 if (ud->side == USBIP_STUB || ud->side == USBIP_VUDC)
763 usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
765 usbip_event_add(ud, VDEV_EVENT_ERROR_TCP);
769 EXPORT_SYMBOL_GPL(usbip_recv_xbuff);
771 static int __init usbip_core_init(void)
775 ret = usbip_init_eh();
782 static void __exit usbip_core_exit(void)
788 module_init(usbip_core_init);
789 module_exit(usbip_core_exit);
791 MODULE_AUTHOR(DRIVER_AUTHOR);
792 MODULE_DESCRIPTION(DRIVER_DESC);
793 MODULE_LICENSE("GPL");