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/file.h>
23 #include <linux/kernel.h>
24 #include <linux/slab.h>
25 #include <linux/module.h>
28 #include "usbip_common.h"
30 #define DRIVER_AUTHOR "Takahiro Hirofuchi <hirofuchi@users.sourceforge.net>"
31 #define DRIVER_DESC "USB/IP Core"
33 #ifdef CONFIG_USBIP_DEBUG
34 unsigned long usbip_debug_flag = 0xffffffff;
36 unsigned long usbip_debug_flag;
38 EXPORT_SYMBOL_GPL(usbip_debug_flag);
41 struct device_attribute dev_attr_usbip_debug;
42 EXPORT_SYMBOL_GPL(dev_attr_usbip_debug);
44 static ssize_t show_flag(struct device *dev, struct device_attribute *attr,
47 return sprintf(buf, "%lx\n", usbip_debug_flag);
50 static ssize_t store_flag(struct device *dev, struct device_attribute *attr,
51 const char *buf, size_t count)
53 sscanf(buf, "%lx", &usbip_debug_flag);
56 DEVICE_ATTR(usbip_debug, (S_IRUGO | S_IWUSR), show_flag, store_flag);
58 static void usbip_dump_buffer(char *buff, int bufflen)
60 print_hex_dump(KERN_DEBUG, "usbip-core", DUMP_PREFIX_OFFSET, 16, 4,
61 buff, bufflen, false);
64 static void usbip_dump_pipe(unsigned int p)
66 unsigned char type = usb_pipetype(p);
67 unsigned char ep = usb_pipeendpoint(p);
68 unsigned char dev = usb_pipedevice(p);
69 unsigned char dir = usb_pipein(p);
71 pr_debug("dev(%d) ep(%d) [%s] ", dev, ep, dir ? "IN" : "OUT");
74 case PIPE_ISOCHRONOUS:
92 static void usbip_dump_usb_device(struct usb_device *udev)
94 struct device *dev = &udev->dev;
97 dev_dbg(dev, " devnum(%d) devpath(%s) ",
98 udev->devnum, udev->devpath);
100 switch (udev->speed) {
102 pr_debug("SPD_HIGH ");
105 pr_debug("SPD_FULL ");
108 pr_debug("SPD_LOW ");
110 case USB_SPEED_UNKNOWN:
111 pr_debug("SPD_UNKNOWN ");
114 pr_debug("SPD_ERROR ");
118 pr_debug("tt %p, ttport %d\n", udev->tt, udev->ttport);
121 for (i = 0; i < 16; i++)
125 dev_dbg(dev, " toggle0(IN) :");
126 for (i = 0; i < 16; i++)
127 pr_debug(" %2u", (udev->toggle[0] & (1 << i)) ? 1 : 0);
130 dev_dbg(dev, " toggle1(OUT):");
131 for (i = 0; i < 16; i++)
132 pr_debug(" %2u", (udev->toggle[1] & (1 << i)) ? 1 : 0);
135 dev_dbg(dev, " epmaxp_in :");
136 for (i = 0; i < 16; i++) {
139 le16_to_cpu(udev->ep_in[i]->desc.wMaxPacketSize));
143 dev_dbg(dev, " epmaxp_out :");
144 for (i = 0; i < 16; i++) {
147 le16_to_cpu(udev->ep_out[i]->desc.wMaxPacketSize));
151 dev_dbg(dev, "parent %p, bus %p\n", udev->parent, udev->bus);
153 dev_dbg(dev, "descriptor %p, config %p, actconfig %p, "
154 "rawdescriptors %p\n", &udev->descriptor, udev->config,
155 udev->actconfig, udev->rawdescriptors);
157 dev_dbg(dev, "have_langid %d, string_langid %d\n",
158 udev->have_langid, udev->string_langid);
160 dev_dbg(dev, "maxchild %d\n", udev->maxchild);
163 static void usbip_dump_request_type(__u8 rt)
165 switch (rt & USB_RECIP_MASK) {
166 case USB_RECIP_DEVICE:
169 case USB_RECIP_INTERFACE:
172 case USB_RECIP_ENDPOINT:
175 case USB_RECIP_OTHER:
184 static void usbip_dump_usb_ctrlrequest(struct usb_ctrlrequest *cmd)
187 pr_debug(" : null pointer\n");
192 pr_debug("bRequestType(%02X) bRequest(%02X) wValue(%04X) wIndex(%04X) "
193 "wLength(%04X) ", cmd->bRequestType, cmd->bRequest,
194 cmd->wValue, cmd->wIndex, cmd->wLength);
197 if ((cmd->bRequestType & USB_TYPE_MASK) == USB_TYPE_STANDARD) {
198 pr_debug("STANDARD ");
199 switch (cmd->bRequest) {
200 case USB_REQ_GET_STATUS:
201 pr_debug("GET_STATUS\n");
203 case USB_REQ_CLEAR_FEATURE:
204 pr_debug("CLEAR_FEAT\n");
206 case USB_REQ_SET_FEATURE:
207 pr_debug("SET_FEAT\n");
209 case USB_REQ_SET_ADDRESS:
210 pr_debug("SET_ADDRRS\n");
212 case USB_REQ_GET_DESCRIPTOR:
213 pr_debug("GET_DESCRI\n");
215 case USB_REQ_SET_DESCRIPTOR:
216 pr_debug("SET_DESCRI\n");
218 case USB_REQ_GET_CONFIGURATION:
219 pr_debug("GET_CONFIG\n");
221 case USB_REQ_SET_CONFIGURATION:
222 pr_debug("SET_CONFIG\n");
224 case USB_REQ_GET_INTERFACE:
225 pr_debug("GET_INTERF\n");
227 case USB_REQ_SET_INTERFACE:
228 pr_debug("SET_INTERF\n");
230 case USB_REQ_SYNCH_FRAME:
231 pr_debug("SYNC_FRAME\n");
234 pr_debug("REQ(%02X)\n", cmd->bRequest);
237 usbip_dump_request_type(cmd->bRequestType);
238 } else if ((cmd->bRequestType & USB_TYPE_MASK) == USB_TYPE_CLASS) {
240 } else if ((cmd->bRequestType & USB_TYPE_MASK) == USB_TYPE_VENDOR) {
241 pr_debug("VENDOR\n");
242 } else if ((cmd->bRequestType & USB_TYPE_MASK) == USB_TYPE_RESERVED) {
243 pr_debug("RESERVED\n");
247 void usbip_dump_urb(struct urb *urb)
252 pr_debug("urb: null pointer!!\n");
257 pr_debug("urb->dev: null pointer!!\n");
261 dev = &urb->dev->dev;
263 dev_dbg(dev, " urb :%p\n", urb);
264 dev_dbg(dev, " dev :%p\n", urb->dev);
266 usbip_dump_usb_device(urb->dev);
268 dev_dbg(dev, " pipe :%08x ", urb->pipe);
270 usbip_dump_pipe(urb->pipe);
272 dev_dbg(dev, " status :%d\n", urb->status);
273 dev_dbg(dev, " transfer_flags :%08X\n", urb->transfer_flags);
274 dev_dbg(dev, " transfer_buffer :%p\n", urb->transfer_buffer);
275 dev_dbg(dev, " transfer_buffer_length:%d\n",
276 urb->transfer_buffer_length);
277 dev_dbg(dev, " actual_length :%d\n", urb->actual_length);
278 dev_dbg(dev, " setup_packet :%p\n", urb->setup_packet);
280 if (urb->setup_packet && usb_pipetype(urb->pipe) == PIPE_CONTROL)
281 usbip_dump_usb_ctrlrequest(
282 (struct usb_ctrlrequest *)urb->setup_packet);
284 dev_dbg(dev, " start_frame :%d\n", urb->start_frame);
285 dev_dbg(dev, " number_of_packets :%d\n", urb->number_of_packets);
286 dev_dbg(dev, " interval :%d\n", urb->interval);
287 dev_dbg(dev, " error_count :%d\n", urb->error_count);
288 dev_dbg(dev, " context :%p\n", urb->context);
289 dev_dbg(dev, " complete :%p\n", urb->complete);
291 EXPORT_SYMBOL_GPL(usbip_dump_urb);
293 void usbip_dump_header(struct usbip_header *pdu)
295 pr_debug("BASE: cmd %u seq %u devid %u dir %u ep %u\n",
302 switch (pdu->base.command) {
303 case USBIP_CMD_SUBMIT:
304 pr_debug("USBIP_CMD_SUBMIT: "
305 "x_flags %u x_len %u sf %u #p %d iv %d\n",
306 pdu->u.cmd_submit.transfer_flags,
307 pdu->u.cmd_submit.transfer_buffer_length,
308 pdu->u.cmd_submit.start_frame,
309 pdu->u.cmd_submit.number_of_packets,
310 pdu->u.cmd_submit.interval);
312 case USBIP_CMD_UNLINK:
313 pr_debug("USBIP_CMD_UNLINK: seq %u\n",
314 pdu->u.cmd_unlink.seqnum);
316 case USBIP_RET_SUBMIT:
317 pr_debug("USBIP_RET_SUBMIT: st %d al %u sf %d #p %d ec %d\n",
318 pdu->u.ret_submit.status,
319 pdu->u.ret_submit.actual_length,
320 pdu->u.ret_submit.start_frame,
321 pdu->u.ret_submit.number_of_packets,
322 pdu->u.ret_submit.error_count);
324 case USBIP_RET_UNLINK:
325 pr_debug("USBIP_RET_UNLINK: status %d\n",
326 pdu->u.ret_unlink.status);
330 pr_err("unknown command\n");
334 EXPORT_SYMBOL_GPL(usbip_dump_header);
336 /* Receive data over TCP/IP. */
337 int usbip_recv(struct socket *sock, void *buf, int size)
344 /* for blocks of if (usbip_dbg_flag_xmit) */
348 usbip_dbg_xmit("enter\n");
350 if (!sock || !buf || !size) {
351 pr_err("invalid arg, sock %p buff %p size %d\n", sock, buf,
357 sock->sk->sk_allocation = GFP_NOIO;
362 msg.msg_control = NULL;
363 msg.msg_controllen = 0;
365 msg.msg_flags = MSG_NOSIGNAL;
367 result = kernel_recvmsg(sock, &msg, &iov, 1, size, MSG_WAITALL);
369 pr_debug("receive sock %p buf %p size %u ret %d total %d\n",
370 sock, buf, size, result, total);
379 if (usbip_dbg_flag_xmit) {
381 pr_debug("%-10s:", current->comm);
383 pr_debug("interrupt :");
385 pr_debug("receiving....\n");
386 usbip_dump_buffer(bp, osize);
387 pr_debug("received, osize %d ret %d size %d total %d\n",
388 osize, result, size, total);
396 EXPORT_SYMBOL_GPL(usbip_recv);
398 struct socket *sockfd_to_socket(unsigned int sockfd)
400 struct socket *socket;
406 pr_err("invalid sockfd\n");
410 inode = file->f_dentry->d_inode;
412 if (!inode || !S_ISSOCK(inode->i_mode))
415 socket = SOCKET_I(inode);
419 EXPORT_SYMBOL_GPL(sockfd_to_socket);
421 /* there may be more cases to tweak the flags. */
422 static unsigned int tweak_transfer_flags(unsigned int flags)
424 flags &= ~URB_NO_TRANSFER_DMA_MAP;
428 static void usbip_pack_cmd_submit(struct usbip_header *pdu, struct urb *urb,
431 struct usbip_header_cmd_submit *spdu = &pdu->u.cmd_submit;
434 * Some members are not still implemented in usbip. I hope this issue
435 * will be discussed when usbip is ported to other operating systems.
439 spdu->transfer_flags =
440 tweak_transfer_flags(urb->transfer_flags);
441 spdu->transfer_buffer_length = urb->transfer_buffer_length;
442 spdu->start_frame = urb->start_frame;
443 spdu->number_of_packets = urb->number_of_packets;
444 spdu->interval = urb->interval;
447 urb->transfer_flags = spdu->transfer_flags;
449 urb->transfer_buffer_length = spdu->transfer_buffer_length;
450 urb->start_frame = spdu->start_frame;
451 urb->number_of_packets = spdu->number_of_packets;
452 urb->interval = spdu->interval;
456 static void usbip_pack_ret_submit(struct usbip_header *pdu, struct urb *urb,
459 struct usbip_header_ret_submit *rpdu = &pdu->u.ret_submit;
464 rpdu->status = urb->status;
465 rpdu->actual_length = urb->actual_length;
466 rpdu->start_frame = urb->start_frame;
467 rpdu->number_of_packets = urb->number_of_packets;
468 rpdu->error_count = urb->error_count;
472 urb->status = rpdu->status;
473 urb->actual_length = rpdu->actual_length;
474 urb->start_frame = rpdu->start_frame;
475 urb->number_of_packets = rpdu->number_of_packets;
476 urb->error_count = rpdu->error_count;
480 void usbip_pack_pdu(struct usbip_header *pdu, struct urb *urb, int cmd,
484 case USBIP_CMD_SUBMIT:
485 usbip_pack_cmd_submit(pdu, urb, pack);
487 case USBIP_RET_SUBMIT:
488 usbip_pack_ret_submit(pdu, urb, pack);
492 pr_err("unknown command\n");
496 EXPORT_SYMBOL_GPL(usbip_pack_pdu);
498 static void correct_endian_basic(struct usbip_header_basic *base, int send)
501 base->command = cpu_to_be32(base->command);
502 base->seqnum = cpu_to_be32(base->seqnum);
503 base->devid = cpu_to_be32(base->devid);
504 base->direction = cpu_to_be32(base->direction);
505 base->ep = cpu_to_be32(base->ep);
507 base->command = be32_to_cpu(base->command);
508 base->seqnum = be32_to_cpu(base->seqnum);
509 base->devid = be32_to_cpu(base->devid);
510 base->direction = be32_to_cpu(base->direction);
511 base->ep = be32_to_cpu(base->ep);
515 static void correct_endian_cmd_submit(struct usbip_header_cmd_submit *pdu,
519 pdu->transfer_flags = cpu_to_be32(pdu->transfer_flags);
521 cpu_to_be32s(&pdu->transfer_buffer_length);
522 cpu_to_be32s(&pdu->start_frame);
523 cpu_to_be32s(&pdu->number_of_packets);
524 cpu_to_be32s(&pdu->interval);
526 pdu->transfer_flags = be32_to_cpu(pdu->transfer_flags);
528 be32_to_cpus(&pdu->transfer_buffer_length);
529 be32_to_cpus(&pdu->start_frame);
530 be32_to_cpus(&pdu->number_of_packets);
531 be32_to_cpus(&pdu->interval);
535 static void correct_endian_ret_submit(struct usbip_header_ret_submit *pdu,
539 cpu_to_be32s(&pdu->status);
540 cpu_to_be32s(&pdu->actual_length);
541 cpu_to_be32s(&pdu->start_frame);
542 cpu_to_be32s(&pdu->number_of_packets);
543 cpu_to_be32s(&pdu->error_count);
545 be32_to_cpus(&pdu->status);
546 be32_to_cpus(&pdu->actual_length);
547 be32_to_cpus(&pdu->start_frame);
548 be32_to_cpus(&pdu->number_of_packets);
549 be32_to_cpus(&pdu->error_count);
553 static void correct_endian_cmd_unlink(struct usbip_header_cmd_unlink *pdu,
557 pdu->seqnum = cpu_to_be32(pdu->seqnum);
559 pdu->seqnum = be32_to_cpu(pdu->seqnum);
562 static void correct_endian_ret_unlink(struct usbip_header_ret_unlink *pdu,
566 cpu_to_be32s(&pdu->status);
568 be32_to_cpus(&pdu->status);
571 void usbip_header_correct_endian(struct usbip_header *pdu, int send)
576 cmd = pdu->base.command;
578 correct_endian_basic(&pdu->base, send);
581 cmd = pdu->base.command;
584 case USBIP_CMD_SUBMIT:
585 correct_endian_cmd_submit(&pdu->u.cmd_submit, send);
587 case USBIP_RET_SUBMIT:
588 correct_endian_ret_submit(&pdu->u.ret_submit, send);
590 case USBIP_CMD_UNLINK:
591 correct_endian_cmd_unlink(&pdu->u.cmd_unlink, send);
593 case USBIP_RET_UNLINK:
594 correct_endian_ret_unlink(&pdu->u.ret_unlink, send);
598 pr_err("unknown command\n");
602 EXPORT_SYMBOL_GPL(usbip_header_correct_endian);
604 static void usbip_iso_packet_correct_endian(
605 struct usbip_iso_packet_descriptor *iso, int send)
607 /* does not need all members. but copy all simply. */
609 iso->offset = cpu_to_be32(iso->offset);
610 iso->length = cpu_to_be32(iso->length);
611 iso->status = cpu_to_be32(iso->status);
612 iso->actual_length = cpu_to_be32(iso->actual_length);
614 iso->offset = be32_to_cpu(iso->offset);
615 iso->length = be32_to_cpu(iso->length);
616 iso->status = be32_to_cpu(iso->status);
617 iso->actual_length = be32_to_cpu(iso->actual_length);
621 static void usbip_pack_iso(struct usbip_iso_packet_descriptor *iso,
622 struct usb_iso_packet_descriptor *uiso, int pack)
625 iso->offset = uiso->offset;
626 iso->length = uiso->length;
627 iso->status = uiso->status;
628 iso->actual_length = uiso->actual_length;
630 uiso->offset = iso->offset;
631 uiso->length = iso->length;
632 uiso->status = iso->status;
633 uiso->actual_length = iso->actual_length;
637 /* must free buffer */
638 void *usbip_alloc_iso_desc_pdu(struct urb *urb, ssize_t *bufflen)
641 struct usbip_iso_packet_descriptor *iso;
642 int np = urb->number_of_packets;
643 ssize_t size = np * sizeof(*iso);
646 buff = kzalloc(size, GFP_KERNEL);
650 for (i = 0; i < np; i++) {
651 iso = buff + (i * sizeof(*iso));
653 usbip_pack_iso(iso, &urb->iso_frame_desc[i], 1);
654 usbip_iso_packet_correct_endian(iso, 1);
661 EXPORT_SYMBOL_GPL(usbip_alloc_iso_desc_pdu);
663 /* some members of urb must be substituted before. */
664 int usbip_recv_iso(struct usbip_device *ud, struct urb *urb)
667 struct usbip_iso_packet_descriptor *iso;
668 int np = urb->number_of_packets;
669 int size = np * sizeof(*iso);
672 int total_length = 0;
674 if (!usb_pipeisoc(urb->pipe))
677 /* my Bluetooth dongle gets ISO URBs which are np = 0 */
679 /* pr_info("iso np == 0\n"); */
680 /* usbip_dump_urb(urb); */
684 buff = kzalloc(size, GFP_KERNEL);
688 ret = usbip_recv(ud->tcp_socket, buff, size);
690 dev_err(&urb->dev->dev, "recv iso_frame_descriptor, %d\n",
694 if (ud->side == USBIP_STUB)
695 usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
697 usbip_event_add(ud, VDEV_EVENT_ERROR_TCP);
702 for (i = 0; i < np; i++) {
703 iso = buff + (i * sizeof(*iso));
705 usbip_iso_packet_correct_endian(iso, 0);
706 usbip_pack_iso(iso, &urb->iso_frame_desc[i], 0);
707 total_length += urb->iso_frame_desc[i].actual_length;
712 if (total_length != urb->actual_length) {
713 dev_err(&urb->dev->dev,
714 "total length of iso packets %d not equal to actual "
715 "length of buffer %d\n",
716 total_length, urb->actual_length);
718 if (ud->side == USBIP_STUB)
719 usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
721 usbip_event_add(ud, VDEV_EVENT_ERROR_TCP);
728 EXPORT_SYMBOL_GPL(usbip_recv_iso);
731 * This functions restores the padding which was removed for optimizing
732 * the bandwidth during transfer over tcp/ip
734 * buffer and iso packets need to be stored and be in propeper endian in urb
735 * before calling this function
737 void usbip_pad_iso(struct usbip_device *ud, struct urb *urb)
739 int np = urb->number_of_packets;
741 int actualoffset = urb->actual_length;
743 if (!usb_pipeisoc(urb->pipe))
746 /* if no packets or length of data is 0, then nothing to unpack */
747 if (np == 0 || urb->actual_length == 0)
751 * if actual_length is transfer_buffer_length then no padding is
754 if (urb->actual_length == urb->transfer_buffer_length)
758 * loop over all packets from last to first (to prevent overwritting
759 * memory when padding) and move them into the proper place
761 for (i = np-1; i > 0; i--) {
762 actualoffset -= urb->iso_frame_desc[i].actual_length;
763 memmove(urb->transfer_buffer + urb->iso_frame_desc[i].offset,
764 urb->transfer_buffer + actualoffset,
765 urb->iso_frame_desc[i].actual_length);
768 EXPORT_SYMBOL_GPL(usbip_pad_iso);
770 /* some members of urb must be substituted before. */
771 int usbip_recv_xbuff(struct usbip_device *ud, struct urb *urb)
776 if (ud->side == USBIP_STUB) {
778 /* the direction of urb must be OUT. */
779 if (usb_pipein(urb->pipe))
782 size = urb->transfer_buffer_length;
785 /* the direction of urb must be IN. */
786 if (usb_pipeout(urb->pipe))
789 size = urb->actual_length;
792 /* no need to recv xbuff */
796 ret = usbip_recv(ud->tcp_socket, urb->transfer_buffer, size);
798 dev_err(&urb->dev->dev, "recv xbuf, %d\n", ret);
799 if (ud->side == USBIP_STUB) {
800 usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
802 usbip_event_add(ud, VDEV_EVENT_ERROR_TCP);
809 EXPORT_SYMBOL_GPL(usbip_recv_xbuff);
811 static int __init usbip_core_init(void)
813 pr_info(DRIVER_DESC " v" USBIP_VERSION "\n");
817 static void __exit usbip_core_exit(void)
822 module_init(usbip_core_init);
823 module_exit(usbip_core_exit);
825 MODULE_AUTHOR(DRIVER_AUTHOR);
826 MODULE_DESCRIPTION(DRIVER_DESC);
827 MODULE_LICENSE("GPL");
828 MODULE_VERSION(USBIP_VERSION);