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"
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, children %p\n",
161 udev->maxchild, udev->children);
164 static void usbip_dump_request_type(__u8 rt)
166 switch (rt & USB_RECIP_MASK) {
167 case USB_RECIP_DEVICE:
170 case USB_RECIP_INTERFACE:
173 case USB_RECIP_ENDPOINT:
176 case USB_RECIP_OTHER:
185 static void usbip_dump_usb_ctrlrequest(struct usb_ctrlrequest *cmd)
188 pr_debug(" : null pointer\n");
193 pr_debug("bRequestType(%02X) bRequest(%02X) wValue(%04X) wIndex(%04X) "
194 "wLength(%04X) ", cmd->bRequestType, cmd->bRequest,
195 cmd->wValue, cmd->wIndex, cmd->wLength);
198 if ((cmd->bRequestType & USB_TYPE_MASK) == USB_TYPE_STANDARD) {
199 pr_debug("STANDARD ");
200 switch (cmd->bRequest) {
201 case USB_REQ_GET_STATUS:
202 pr_debug("GET_STATUS\n");
204 case USB_REQ_CLEAR_FEATURE:
205 pr_debug("CLEAR_FEAT\n");
207 case USB_REQ_SET_FEATURE:
208 pr_debug("SET_FEAT\n");
210 case USB_REQ_SET_ADDRESS:
211 pr_debug("SET_ADDRRS\n");
213 case USB_REQ_GET_DESCRIPTOR:
214 pr_debug("GET_DESCRI\n");
216 case USB_REQ_SET_DESCRIPTOR:
217 pr_debug("SET_DESCRI\n");
219 case USB_REQ_GET_CONFIGURATION:
220 pr_debug("GET_CONFIG\n");
222 case USB_REQ_SET_CONFIGURATION:
223 pr_debug("SET_CONFIG\n");
225 case USB_REQ_GET_INTERFACE:
226 pr_debug("GET_INTERF\n");
228 case USB_REQ_SET_INTERFACE:
229 pr_debug("SET_INTERF\n");
231 case USB_REQ_SYNCH_FRAME:
232 pr_debug("SYNC_FRAME\n");
235 pr_debug("REQ(%02X)\n", cmd->bRequest);
238 usbip_dump_request_type(cmd->bRequestType);
239 } else if ((cmd->bRequestType & USB_TYPE_MASK) == USB_TYPE_CLASS) {
241 } else if ((cmd->bRequestType & USB_TYPE_MASK) == USB_TYPE_VENDOR) {
242 pr_debug("VENDOR\n");
243 } else if ((cmd->bRequestType & USB_TYPE_MASK) == USB_TYPE_RESERVED) {
244 pr_debug("RESERVED\n");
248 void usbip_dump_urb(struct urb *urb)
253 pr_debug("urb: null pointer!!\n");
258 pr_debug("urb->dev: null pointer!!\n");
262 dev = &urb->dev->dev;
264 dev_dbg(dev, " urb :%p\n", urb);
265 dev_dbg(dev, " dev :%p\n", urb->dev);
267 usbip_dump_usb_device(urb->dev);
269 dev_dbg(dev, " pipe :%08x ", urb->pipe);
271 usbip_dump_pipe(urb->pipe);
273 dev_dbg(dev, " status :%d\n", urb->status);
274 dev_dbg(dev, " transfer_flags :%08X\n", urb->transfer_flags);
275 dev_dbg(dev, " transfer_buffer :%p\n", urb->transfer_buffer);
276 dev_dbg(dev, " transfer_buffer_length:%d\n",
277 urb->transfer_buffer_length);
278 dev_dbg(dev, " actual_length :%d\n", urb->actual_length);
279 dev_dbg(dev, " setup_packet :%p\n", urb->setup_packet);
281 if (urb->setup_packet && usb_pipetype(urb->pipe) == PIPE_CONTROL)
282 usbip_dump_usb_ctrlrequest(
283 (struct usb_ctrlrequest *)urb->setup_packet);
285 dev_dbg(dev, " start_frame :%d\n", urb->start_frame);
286 dev_dbg(dev, " number_of_packets :%d\n", urb->number_of_packets);
287 dev_dbg(dev, " interval :%d\n", urb->interval);
288 dev_dbg(dev, " error_count :%d\n", urb->error_count);
289 dev_dbg(dev, " context :%p\n", urb->context);
290 dev_dbg(dev, " complete :%p\n", urb->complete);
292 EXPORT_SYMBOL_GPL(usbip_dump_urb);
294 void usbip_dump_header(struct usbip_header *pdu)
296 pr_debug("BASE: cmd %u seq %u devid %u dir %u ep %u\n",
303 switch (pdu->base.command) {
304 case USBIP_CMD_SUBMIT:
305 pr_debug("USBIP_CMD_SUBMIT: "
306 "x_flags %u x_len %u sf %u #p %d iv %d\n",
307 pdu->u.cmd_submit.transfer_flags,
308 pdu->u.cmd_submit.transfer_buffer_length,
309 pdu->u.cmd_submit.start_frame,
310 pdu->u.cmd_submit.number_of_packets,
311 pdu->u.cmd_submit.interval);
313 case USBIP_CMD_UNLINK:
314 pr_debug("USBIP_CMD_UNLINK: seq %u\n",
315 pdu->u.cmd_unlink.seqnum);
317 case USBIP_RET_SUBMIT:
318 pr_debug("USBIP_RET_SUBMIT: st %d al %u sf %d #p %d ec %d\n",
319 pdu->u.ret_submit.status,
320 pdu->u.ret_submit.actual_length,
321 pdu->u.ret_submit.start_frame,
322 pdu->u.ret_submit.number_of_packets,
323 pdu->u.ret_submit.error_count);
325 case USBIP_RET_UNLINK:
326 pr_debug("USBIP_RET_UNLINK: status %d\n",
327 pdu->u.ret_unlink.status);
331 pr_err("unknown command\n");
335 EXPORT_SYMBOL_GPL(usbip_dump_header);
337 /* Receive data over TCP/IP. */
338 int usbip_recv(struct socket *sock, void *buf, int size)
345 /* for blocks of if (usbip_dbg_flag_xmit) */
349 usbip_dbg_xmit("enter\n");
351 if (!sock || !buf || !size) {
352 pr_err("invalid arg, sock %p buff %p size %d\n", sock, buf,
358 sock->sk->sk_allocation = GFP_NOIO;
363 msg.msg_control = NULL;
364 msg.msg_controllen = 0;
366 msg.msg_flags = MSG_NOSIGNAL;
368 result = kernel_recvmsg(sock, &msg, &iov, 1, size, MSG_WAITALL);
370 pr_debug("receive sock %p buf %p size %u ret %d total %d\n",
371 sock, buf, size, result, total);
380 if (usbip_dbg_flag_xmit) {
382 pr_debug("%-10s:", current->comm);
384 pr_debug("interrupt :");
386 pr_debug("receiving....\n");
387 usbip_dump_buffer(bp, osize);
388 pr_debug("received, osize %d ret %d size %d total %d\n",
389 osize, result, size, total);
397 EXPORT_SYMBOL_GPL(usbip_recv);
399 struct socket *sockfd_to_socket(unsigned int sockfd)
401 struct socket *socket;
407 pr_err("invalid sockfd\n");
411 inode = file->f_dentry->d_inode;
413 if (!inode || !S_ISSOCK(inode->i_mode))
416 socket = SOCKET_I(inode);
420 EXPORT_SYMBOL_GPL(sockfd_to_socket);
422 /* there may be more cases to tweak the flags. */
423 static unsigned int tweak_transfer_flags(unsigned int flags)
425 flags &= ~URB_NO_TRANSFER_DMA_MAP;
429 static void usbip_pack_cmd_submit(struct usbip_header *pdu, struct urb *urb,
432 struct usbip_header_cmd_submit *spdu = &pdu->u.cmd_submit;
435 * Some members are not still implemented in usbip. I hope this issue
436 * will be discussed when usbip is ported to other operating systems.
440 spdu->transfer_flags =
441 tweak_transfer_flags(urb->transfer_flags);
442 spdu->transfer_buffer_length = urb->transfer_buffer_length;
443 spdu->start_frame = urb->start_frame;
444 spdu->number_of_packets = urb->number_of_packets;
445 spdu->interval = urb->interval;
448 urb->transfer_flags = spdu->transfer_flags;
450 urb->transfer_buffer_length = spdu->transfer_buffer_length;
451 urb->start_frame = spdu->start_frame;
452 urb->number_of_packets = spdu->number_of_packets;
453 urb->interval = spdu->interval;
457 static void usbip_pack_ret_submit(struct usbip_header *pdu, struct urb *urb,
460 struct usbip_header_ret_submit *rpdu = &pdu->u.ret_submit;
465 rpdu->status = urb->status;
466 rpdu->actual_length = urb->actual_length;
467 rpdu->start_frame = urb->start_frame;
468 rpdu->number_of_packets = urb->number_of_packets;
469 rpdu->error_count = urb->error_count;
473 urb->status = rpdu->status;
474 urb->actual_length = rpdu->actual_length;
475 urb->start_frame = rpdu->start_frame;
476 urb->number_of_packets = rpdu->number_of_packets;
477 urb->error_count = rpdu->error_count;
481 void usbip_pack_pdu(struct usbip_header *pdu, struct urb *urb, int cmd,
485 case USBIP_CMD_SUBMIT:
486 usbip_pack_cmd_submit(pdu, urb, pack);
488 case USBIP_RET_SUBMIT:
489 usbip_pack_ret_submit(pdu, urb, pack);
493 pr_err("unknown command\n");
497 EXPORT_SYMBOL_GPL(usbip_pack_pdu);
499 static void correct_endian_basic(struct usbip_header_basic *base, int send)
502 base->command = cpu_to_be32(base->command);
503 base->seqnum = cpu_to_be32(base->seqnum);
504 base->devid = cpu_to_be32(base->devid);
505 base->direction = cpu_to_be32(base->direction);
506 base->ep = cpu_to_be32(base->ep);
508 base->command = be32_to_cpu(base->command);
509 base->seqnum = be32_to_cpu(base->seqnum);
510 base->devid = be32_to_cpu(base->devid);
511 base->direction = be32_to_cpu(base->direction);
512 base->ep = be32_to_cpu(base->ep);
516 static void correct_endian_cmd_submit(struct usbip_header_cmd_submit *pdu,
520 pdu->transfer_flags = cpu_to_be32(pdu->transfer_flags);
522 cpu_to_be32s(&pdu->transfer_buffer_length);
523 cpu_to_be32s(&pdu->start_frame);
524 cpu_to_be32s(&pdu->number_of_packets);
525 cpu_to_be32s(&pdu->interval);
527 pdu->transfer_flags = be32_to_cpu(pdu->transfer_flags);
529 be32_to_cpus(&pdu->transfer_buffer_length);
530 be32_to_cpus(&pdu->start_frame);
531 be32_to_cpus(&pdu->number_of_packets);
532 be32_to_cpus(&pdu->interval);
536 static void correct_endian_ret_submit(struct usbip_header_ret_submit *pdu,
540 cpu_to_be32s(&pdu->status);
541 cpu_to_be32s(&pdu->actual_length);
542 cpu_to_be32s(&pdu->start_frame);
543 cpu_to_be32s(&pdu->number_of_packets);
544 cpu_to_be32s(&pdu->error_count);
546 be32_to_cpus(&pdu->status);
547 be32_to_cpus(&pdu->actual_length);
548 be32_to_cpus(&pdu->start_frame);
549 be32_to_cpus(&pdu->number_of_packets);
550 be32_to_cpus(&pdu->error_count);
554 static void correct_endian_cmd_unlink(struct usbip_header_cmd_unlink *pdu,
558 pdu->seqnum = cpu_to_be32(pdu->seqnum);
560 pdu->seqnum = be32_to_cpu(pdu->seqnum);
563 static void correct_endian_ret_unlink(struct usbip_header_ret_unlink *pdu,
567 cpu_to_be32s(&pdu->status);
569 be32_to_cpus(&pdu->status);
572 void usbip_header_correct_endian(struct usbip_header *pdu, int send)
577 cmd = pdu->base.command;
579 correct_endian_basic(&pdu->base, send);
582 cmd = pdu->base.command;
585 case USBIP_CMD_SUBMIT:
586 correct_endian_cmd_submit(&pdu->u.cmd_submit, send);
588 case USBIP_RET_SUBMIT:
589 correct_endian_ret_submit(&pdu->u.ret_submit, send);
591 case USBIP_CMD_UNLINK:
592 correct_endian_cmd_unlink(&pdu->u.cmd_unlink, send);
594 case USBIP_RET_UNLINK:
595 correct_endian_ret_unlink(&pdu->u.ret_unlink, send);
599 pr_err("unknown command\n");
603 EXPORT_SYMBOL_GPL(usbip_header_correct_endian);
605 static void usbip_iso_packet_correct_endian(
606 struct usbip_iso_packet_descriptor *iso, int send)
608 /* does not need all members. but copy all simply. */
610 iso->offset = cpu_to_be32(iso->offset);
611 iso->length = cpu_to_be32(iso->length);
612 iso->status = cpu_to_be32(iso->status);
613 iso->actual_length = cpu_to_be32(iso->actual_length);
615 iso->offset = be32_to_cpu(iso->offset);
616 iso->length = be32_to_cpu(iso->length);
617 iso->status = be32_to_cpu(iso->status);
618 iso->actual_length = be32_to_cpu(iso->actual_length);
622 static void usbip_pack_iso(struct usbip_iso_packet_descriptor *iso,
623 struct usb_iso_packet_descriptor *uiso, int pack)
626 iso->offset = uiso->offset;
627 iso->length = uiso->length;
628 iso->status = uiso->status;
629 iso->actual_length = uiso->actual_length;
631 uiso->offset = iso->offset;
632 uiso->length = iso->length;
633 uiso->status = iso->status;
634 uiso->actual_length = iso->actual_length;
638 /* must free buffer */
639 void *usbip_alloc_iso_desc_pdu(struct urb *urb, ssize_t *bufflen)
642 struct usbip_iso_packet_descriptor *iso;
643 int np = urb->number_of_packets;
644 ssize_t size = np * sizeof(*iso);
647 buff = kzalloc(size, GFP_KERNEL);
651 for (i = 0; i < np; i++) {
652 iso = buff + (i * sizeof(*iso));
654 usbip_pack_iso(iso, &urb->iso_frame_desc[i], 1);
655 usbip_iso_packet_correct_endian(iso, 1);
662 EXPORT_SYMBOL_GPL(usbip_alloc_iso_desc_pdu);
664 /* some members of urb must be substituted before. */
665 int usbip_recv_iso(struct usbip_device *ud, struct urb *urb)
668 struct usbip_iso_packet_descriptor *iso;
669 int np = urb->number_of_packets;
670 int size = np * sizeof(*iso);
673 int total_length = 0;
675 if (!usb_pipeisoc(urb->pipe))
678 /* my Bluetooth dongle gets ISO URBs which are np = 0 */
680 /* pr_info("iso np == 0\n"); */
681 /* usbip_dump_urb(urb); */
685 buff = kzalloc(size, GFP_KERNEL);
689 ret = usbip_recv(ud->tcp_socket, buff, size);
691 dev_err(&urb->dev->dev, "recv iso_frame_descriptor, %d\n",
695 if (ud->side == USBIP_STUB)
696 usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
698 usbip_event_add(ud, VDEV_EVENT_ERROR_TCP);
703 for (i = 0; i < np; i++) {
704 iso = buff + (i * sizeof(*iso));
706 usbip_iso_packet_correct_endian(iso, 0);
707 usbip_pack_iso(iso, &urb->iso_frame_desc[i], 0);
708 total_length += urb->iso_frame_desc[i].actual_length;
713 if (total_length != urb->actual_length) {
714 dev_err(&urb->dev->dev,
715 "total length of iso packets %d not equal to actual "
716 "length of buffer %d\n",
717 total_length, urb->actual_length);
719 if (ud->side == USBIP_STUB)
720 usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
722 usbip_event_add(ud, VDEV_EVENT_ERROR_TCP);
729 EXPORT_SYMBOL_GPL(usbip_recv_iso);
732 * This functions restores the padding which was removed for optimizing
733 * the bandwidth during transfer over tcp/ip
735 * buffer and iso packets need to be stored and be in propeper endian in urb
736 * before calling this function
738 void usbip_pad_iso(struct usbip_device *ud, struct urb *urb)
740 int np = urb->number_of_packets;
742 int actualoffset = urb->actual_length;
744 if (!usb_pipeisoc(urb->pipe))
747 /* if no packets or length of data is 0, then nothing to unpack */
748 if (np == 0 || urb->actual_length == 0)
752 * if actual_length is transfer_buffer_length then no padding is
755 if (urb->actual_length == urb->transfer_buffer_length)
759 * loop over all packets from last to first (to prevent overwritting
760 * memory when padding) and move them into the proper place
762 for (i = np-1; i > 0; i--) {
763 actualoffset -= urb->iso_frame_desc[i].actual_length;
764 memmove(urb->transfer_buffer + urb->iso_frame_desc[i].offset,
765 urb->transfer_buffer + actualoffset,
766 urb->iso_frame_desc[i].actual_length);
769 EXPORT_SYMBOL_GPL(usbip_pad_iso);
771 /* some members of urb must be substituted before. */
772 int usbip_recv_xbuff(struct usbip_device *ud, struct urb *urb)
777 if (ud->side == USBIP_STUB) {
779 /* the direction of urb must be OUT. */
780 if (usb_pipein(urb->pipe))
783 size = urb->transfer_buffer_length;
786 /* the direction of urb must be IN. */
787 if (usb_pipeout(urb->pipe))
790 size = urb->actual_length;
793 /* no need to recv xbuff */
797 ret = usbip_recv(ud->tcp_socket, urb->transfer_buffer, size);
799 dev_err(&urb->dev->dev, "recv xbuf, %d\n", ret);
800 if (ud->side == USBIP_STUB) {
801 usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
803 usbip_event_add(ud, VDEV_EVENT_ERROR_TCP);
810 EXPORT_SYMBOL_GPL(usbip_recv_xbuff);
812 static int __init usbip_core_init(void)
814 pr_info(DRIVER_DESC " v" USBIP_VERSION "\n");
818 static void __exit usbip_core_exit(void)
823 module_init(usbip_core_init);
824 module_exit(usbip_core_exit);
826 MODULE_AUTHOR(DRIVER_AUTHOR);
827 MODULE_DESCRIPTION(DRIVER_DESC);
828 MODULE_LICENSE("GPL");
829 MODULE_VERSION(USBIP_VERSION);