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/stat.h>
26 #include <linux/module.h>
27 #include <linux/moduleparam.h>
30 #include "usbip_common.h"
33 #define DRIVER_DESC "USB/IP Core"
35 #ifdef CONFIG_USBIP_DEBUG
36 unsigned long usbip_debug_flag = 0xffffffff;
38 unsigned long usbip_debug_flag;
40 EXPORT_SYMBOL_GPL(usbip_debug_flag);
41 module_param(usbip_debug_flag, ulong, S_IRUGO|S_IWUSR);
42 MODULE_PARM_DESC(usbip_debug_flag, "debug flags (defined in usbip_common.h)");
45 struct device_attribute dev_attr_usbip_debug;
46 EXPORT_SYMBOL_GPL(dev_attr_usbip_debug);
48 static ssize_t usbip_debug_show(struct device *dev,
49 struct device_attribute *attr, char *buf)
51 return sprintf(buf, "%lx\n", usbip_debug_flag);
54 static ssize_t usbip_debug_store(struct device *dev,
55 struct device_attribute *attr, const char *buf,
58 if (sscanf(buf, "%lx", &usbip_debug_flag) != 1)
62 DEVICE_ATTR_RW(usbip_debug);
64 static void usbip_dump_buffer(char *buff, int bufflen)
66 print_hex_dump(KERN_DEBUG, "usbip-core", DUMP_PREFIX_OFFSET, 16, 4,
67 buff, bufflen, false);
70 static void usbip_dump_pipe(unsigned int p)
72 unsigned char type = usb_pipetype(p);
73 unsigned char ep = usb_pipeendpoint(p);
74 unsigned char dev = usb_pipedevice(p);
75 unsigned char dir = usb_pipein(p);
77 pr_debug("dev(%d) ep(%d) [%s] ", dev, ep, dir ? "IN" : "OUT");
80 case PIPE_ISOCHRONOUS:
98 static void usbip_dump_usb_device(struct usb_device *udev)
100 struct device *dev = &udev->dev;
103 dev_dbg(dev, " devnum(%d) devpath(%s) usb speed(%s)",
104 udev->devnum, udev->devpath, usb_speed_string(udev->speed));
106 pr_debug("tt %p, ttport %d\n", udev->tt, udev->ttport);
109 for (i = 0; i < 16; i++)
113 dev_dbg(dev, " toggle0(IN) :");
114 for (i = 0; i < 16; i++)
115 pr_debug(" %2u", (udev->toggle[0] & (1 << i)) ? 1 : 0);
118 dev_dbg(dev, " toggle1(OUT):");
119 for (i = 0; i < 16; i++)
120 pr_debug(" %2u", (udev->toggle[1] & (1 << i)) ? 1 : 0);
123 dev_dbg(dev, " epmaxp_in :");
124 for (i = 0; i < 16; i++) {
127 le16_to_cpu(udev->ep_in[i]->desc.wMaxPacketSize));
131 dev_dbg(dev, " epmaxp_out :");
132 for (i = 0; i < 16; i++) {
135 le16_to_cpu(udev->ep_out[i]->desc.wMaxPacketSize));
139 dev_dbg(dev, "parent %p, bus %p\n", udev->parent, udev->bus);
142 "descriptor %p, config %p, actconfig %p, rawdescriptors %p\n",
143 &udev->descriptor, udev->config,
144 udev->actconfig, udev->rawdescriptors);
146 dev_dbg(dev, "have_langid %d, string_langid %d\n",
147 udev->have_langid, udev->string_langid);
149 dev_dbg(dev, "maxchild %d\n", udev->maxchild);
152 static void usbip_dump_request_type(__u8 rt)
154 switch (rt & USB_RECIP_MASK) {
155 case USB_RECIP_DEVICE:
158 case USB_RECIP_INTERFACE:
161 case USB_RECIP_ENDPOINT:
164 case USB_RECIP_OTHER:
173 static void usbip_dump_usb_ctrlrequest(struct usb_ctrlrequest *cmd)
176 pr_debug(" : null pointer\n");
181 pr_debug("bRequestType(%02X) bRequest(%02X) wValue(%04X) wIndex(%04X) wLength(%04X) ",
182 cmd->bRequestType, cmd->bRequest,
183 cmd->wValue, cmd->wIndex, cmd->wLength);
186 if ((cmd->bRequestType & USB_TYPE_MASK) == USB_TYPE_STANDARD) {
187 pr_debug("STANDARD ");
188 switch (cmd->bRequest) {
189 case USB_REQ_GET_STATUS:
190 pr_debug("GET_STATUS\n");
192 case USB_REQ_CLEAR_FEATURE:
193 pr_debug("CLEAR_FEAT\n");
195 case USB_REQ_SET_FEATURE:
196 pr_debug("SET_FEAT\n");
198 case USB_REQ_SET_ADDRESS:
199 pr_debug("SET_ADDRRS\n");
201 case USB_REQ_GET_DESCRIPTOR:
202 pr_debug("GET_DESCRI\n");
204 case USB_REQ_SET_DESCRIPTOR:
205 pr_debug("SET_DESCRI\n");
207 case USB_REQ_GET_CONFIGURATION:
208 pr_debug("GET_CONFIG\n");
210 case USB_REQ_SET_CONFIGURATION:
211 pr_debug("SET_CONFIG\n");
213 case USB_REQ_GET_INTERFACE:
214 pr_debug("GET_INTERF\n");
216 case USB_REQ_SET_INTERFACE:
217 pr_debug("SET_INTERF\n");
219 case USB_REQ_SYNCH_FRAME:
220 pr_debug("SYNC_FRAME\n");
223 pr_debug("REQ(%02X)\n", cmd->bRequest);
226 usbip_dump_request_type(cmd->bRequestType);
227 } else if ((cmd->bRequestType & USB_TYPE_MASK) == USB_TYPE_CLASS) {
229 } else if ((cmd->bRequestType & USB_TYPE_MASK) == USB_TYPE_VENDOR) {
230 pr_debug("VENDOR\n");
231 } else if ((cmd->bRequestType & USB_TYPE_MASK) == USB_TYPE_RESERVED) {
232 pr_debug("RESERVED\n");
236 void usbip_dump_urb(struct urb *urb)
241 pr_debug("urb: null pointer!!\n");
246 pr_debug("urb->dev: null pointer!!\n");
250 dev = &urb->dev->dev;
252 dev_dbg(dev, " urb :%p\n", urb);
253 dev_dbg(dev, " dev :%p\n", urb->dev);
255 usbip_dump_usb_device(urb->dev);
257 dev_dbg(dev, " pipe :%08x ", urb->pipe);
259 usbip_dump_pipe(urb->pipe);
261 dev_dbg(dev, " status :%d\n", urb->status);
262 dev_dbg(dev, " transfer_flags :%08X\n", urb->transfer_flags);
263 dev_dbg(dev, " transfer_buffer :%p\n", urb->transfer_buffer);
264 dev_dbg(dev, " transfer_buffer_length:%d\n",
265 urb->transfer_buffer_length);
266 dev_dbg(dev, " actual_length :%d\n", urb->actual_length);
267 dev_dbg(dev, " setup_packet :%p\n", urb->setup_packet);
269 if (urb->setup_packet && usb_pipetype(urb->pipe) == PIPE_CONTROL)
270 usbip_dump_usb_ctrlrequest(
271 (struct usb_ctrlrequest *)urb->setup_packet);
273 dev_dbg(dev, " start_frame :%d\n", urb->start_frame);
274 dev_dbg(dev, " number_of_packets :%d\n", urb->number_of_packets);
275 dev_dbg(dev, " interval :%d\n", urb->interval);
276 dev_dbg(dev, " error_count :%d\n", urb->error_count);
277 dev_dbg(dev, " context :%p\n", urb->context);
278 dev_dbg(dev, " complete :%p\n", urb->complete);
280 EXPORT_SYMBOL_GPL(usbip_dump_urb);
282 void usbip_dump_header(struct usbip_header *pdu)
284 pr_debug("BASE: cmd %u seq %u devid %u dir %u ep %u\n",
291 switch (pdu->base.command) {
292 case USBIP_CMD_SUBMIT:
293 pr_debug("USBIP_CMD_SUBMIT: x_flags %u x_len %u sf %u #p %d iv %d\n",
294 pdu->u.cmd_submit.transfer_flags,
295 pdu->u.cmd_submit.transfer_buffer_length,
296 pdu->u.cmd_submit.start_frame,
297 pdu->u.cmd_submit.number_of_packets,
298 pdu->u.cmd_submit.interval);
300 case USBIP_CMD_UNLINK:
301 pr_debug("USBIP_CMD_UNLINK: seq %u\n",
302 pdu->u.cmd_unlink.seqnum);
304 case USBIP_RET_SUBMIT:
305 pr_debug("USBIP_RET_SUBMIT: st %d al %u sf %d #p %d ec %d\n",
306 pdu->u.ret_submit.status,
307 pdu->u.ret_submit.actual_length,
308 pdu->u.ret_submit.start_frame,
309 pdu->u.ret_submit.number_of_packets,
310 pdu->u.ret_submit.error_count);
312 case USBIP_RET_UNLINK:
313 pr_debug("USBIP_RET_UNLINK: status %d\n",
314 pdu->u.ret_unlink.status);
318 pr_err("unknown command\n");
322 EXPORT_SYMBOL_GPL(usbip_dump_header);
324 /* Receive data over TCP/IP. */
325 int usbip_recv(struct socket *sock, void *buf, int size)
332 /* for blocks of if (usbip_dbg_flag_xmit) */
336 usbip_dbg_xmit("enter\n");
338 if (!sock || !buf || !size) {
339 pr_err("invalid arg, sock %p buff %p size %d\n", sock, buf,
345 sock->sk->sk_allocation = GFP_NOIO;
350 msg.msg_control = NULL;
351 msg.msg_controllen = 0;
352 msg.msg_flags = MSG_NOSIGNAL;
354 result = kernel_recvmsg(sock, &msg, &iov, 1, size, MSG_WAITALL);
356 pr_debug("receive sock %p buf %p size %u ret %d total %d\n",
357 sock, buf, size, result, total);
366 if (usbip_dbg_flag_xmit) {
368 pr_debug("%-10s:", current->comm);
370 pr_debug("interrupt :");
372 pr_debug("receiving....\n");
373 usbip_dump_buffer(bp, osize);
374 pr_debug("received, osize %d ret %d size %d total %d\n",
375 osize, result, size, total);
383 EXPORT_SYMBOL_GPL(usbip_recv);
385 /* there may be more cases to tweak the flags. */
386 static unsigned int tweak_transfer_flags(unsigned int flags)
388 flags &= ~URB_NO_TRANSFER_DMA_MAP;
392 static void usbip_pack_cmd_submit(struct usbip_header *pdu, struct urb *urb,
395 struct usbip_header_cmd_submit *spdu = &pdu->u.cmd_submit;
398 * Some members are not still implemented in usbip. I hope this issue
399 * will be discussed when usbip is ported to other operating systems.
402 spdu->transfer_flags =
403 tweak_transfer_flags(urb->transfer_flags);
404 spdu->transfer_buffer_length = urb->transfer_buffer_length;
405 spdu->start_frame = urb->start_frame;
406 spdu->number_of_packets = urb->number_of_packets;
407 spdu->interval = urb->interval;
409 urb->transfer_flags = spdu->transfer_flags;
410 urb->transfer_buffer_length = spdu->transfer_buffer_length;
411 urb->start_frame = spdu->start_frame;
412 urb->number_of_packets = spdu->number_of_packets;
413 urb->interval = spdu->interval;
417 static void usbip_pack_ret_submit(struct usbip_header *pdu, struct urb *urb,
420 struct usbip_header_ret_submit *rpdu = &pdu->u.ret_submit;
423 rpdu->status = urb->status;
424 rpdu->actual_length = urb->actual_length;
425 rpdu->start_frame = urb->start_frame;
426 rpdu->number_of_packets = urb->number_of_packets;
427 rpdu->error_count = urb->error_count;
429 urb->status = rpdu->status;
430 urb->actual_length = rpdu->actual_length;
431 urb->start_frame = rpdu->start_frame;
432 urb->number_of_packets = rpdu->number_of_packets;
433 urb->error_count = rpdu->error_count;
437 void usbip_pack_pdu(struct usbip_header *pdu, struct urb *urb, int cmd,
441 case USBIP_CMD_SUBMIT:
442 usbip_pack_cmd_submit(pdu, urb, pack);
444 case USBIP_RET_SUBMIT:
445 usbip_pack_ret_submit(pdu, urb, pack);
449 pr_err("unknown command\n");
453 EXPORT_SYMBOL_GPL(usbip_pack_pdu);
455 static void correct_endian_basic(struct usbip_header_basic *base, int send)
458 base->command = cpu_to_be32(base->command);
459 base->seqnum = cpu_to_be32(base->seqnum);
460 base->devid = cpu_to_be32(base->devid);
461 base->direction = cpu_to_be32(base->direction);
462 base->ep = cpu_to_be32(base->ep);
464 base->command = be32_to_cpu(base->command);
465 base->seqnum = be32_to_cpu(base->seqnum);
466 base->devid = be32_to_cpu(base->devid);
467 base->direction = be32_to_cpu(base->direction);
468 base->ep = be32_to_cpu(base->ep);
472 static void correct_endian_cmd_submit(struct usbip_header_cmd_submit *pdu,
476 pdu->transfer_flags = cpu_to_be32(pdu->transfer_flags);
478 cpu_to_be32s(&pdu->transfer_buffer_length);
479 cpu_to_be32s(&pdu->start_frame);
480 cpu_to_be32s(&pdu->number_of_packets);
481 cpu_to_be32s(&pdu->interval);
483 pdu->transfer_flags = be32_to_cpu(pdu->transfer_flags);
485 be32_to_cpus(&pdu->transfer_buffer_length);
486 be32_to_cpus(&pdu->start_frame);
487 be32_to_cpus(&pdu->number_of_packets);
488 be32_to_cpus(&pdu->interval);
492 static void correct_endian_ret_submit(struct usbip_header_ret_submit *pdu,
496 cpu_to_be32s(&pdu->status);
497 cpu_to_be32s(&pdu->actual_length);
498 cpu_to_be32s(&pdu->start_frame);
499 cpu_to_be32s(&pdu->number_of_packets);
500 cpu_to_be32s(&pdu->error_count);
502 be32_to_cpus(&pdu->status);
503 be32_to_cpus(&pdu->actual_length);
504 be32_to_cpus(&pdu->start_frame);
505 be32_to_cpus(&pdu->number_of_packets);
506 be32_to_cpus(&pdu->error_count);
510 static void correct_endian_cmd_unlink(struct usbip_header_cmd_unlink *pdu,
514 pdu->seqnum = cpu_to_be32(pdu->seqnum);
516 pdu->seqnum = be32_to_cpu(pdu->seqnum);
519 static void correct_endian_ret_unlink(struct usbip_header_ret_unlink *pdu,
523 cpu_to_be32s(&pdu->status);
525 be32_to_cpus(&pdu->status);
528 void usbip_header_correct_endian(struct usbip_header *pdu, int send)
533 cmd = pdu->base.command;
535 correct_endian_basic(&pdu->base, send);
538 cmd = pdu->base.command;
541 case USBIP_CMD_SUBMIT:
542 correct_endian_cmd_submit(&pdu->u.cmd_submit, send);
544 case USBIP_RET_SUBMIT:
545 correct_endian_ret_submit(&pdu->u.ret_submit, send);
547 case USBIP_CMD_UNLINK:
548 correct_endian_cmd_unlink(&pdu->u.cmd_unlink, send);
550 case USBIP_RET_UNLINK:
551 correct_endian_ret_unlink(&pdu->u.ret_unlink, send);
555 pr_err("unknown command\n");
559 EXPORT_SYMBOL_GPL(usbip_header_correct_endian);
561 static void usbip_iso_packet_correct_endian(
562 struct usbip_iso_packet_descriptor *iso, int send)
564 /* does not need all members. but copy all simply. */
566 iso->offset = cpu_to_be32(iso->offset);
567 iso->length = cpu_to_be32(iso->length);
568 iso->status = cpu_to_be32(iso->status);
569 iso->actual_length = cpu_to_be32(iso->actual_length);
571 iso->offset = be32_to_cpu(iso->offset);
572 iso->length = be32_to_cpu(iso->length);
573 iso->status = be32_to_cpu(iso->status);
574 iso->actual_length = be32_to_cpu(iso->actual_length);
578 static void usbip_pack_iso(struct usbip_iso_packet_descriptor *iso,
579 struct usb_iso_packet_descriptor *uiso, int pack)
582 iso->offset = uiso->offset;
583 iso->length = uiso->length;
584 iso->status = uiso->status;
585 iso->actual_length = uiso->actual_length;
587 uiso->offset = iso->offset;
588 uiso->length = iso->length;
589 uiso->status = iso->status;
590 uiso->actual_length = iso->actual_length;
594 /* must free buffer */
595 struct usbip_iso_packet_descriptor*
596 usbip_alloc_iso_desc_pdu(struct urb *urb, ssize_t *bufflen)
598 struct usbip_iso_packet_descriptor *iso;
599 int np = urb->number_of_packets;
600 ssize_t size = np * sizeof(*iso);
603 iso = kzalloc(size, GFP_KERNEL);
607 for (i = 0; i < np; i++) {
608 usbip_pack_iso(&iso[i], &urb->iso_frame_desc[i], 1);
609 usbip_iso_packet_correct_endian(&iso[i], 1);
616 EXPORT_SYMBOL_GPL(usbip_alloc_iso_desc_pdu);
618 /* some members of urb must be substituted before. */
619 int usbip_recv_iso(struct usbip_device *ud, struct urb *urb)
622 struct usbip_iso_packet_descriptor *iso;
623 int np = urb->number_of_packets;
624 int size = np * sizeof(*iso);
627 int total_length = 0;
629 if (!usb_pipeisoc(urb->pipe))
632 /* my Bluetooth dongle gets ISO URBs which are np = 0 */
636 buff = kzalloc(size, GFP_KERNEL);
640 ret = usbip_recv(ud->tcp_socket, buff, size);
642 dev_err(&urb->dev->dev, "recv iso_frame_descriptor, %d\n",
646 if (ud->side == USBIP_STUB)
647 usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
649 usbip_event_add(ud, VDEV_EVENT_ERROR_TCP);
654 iso = (struct usbip_iso_packet_descriptor *) buff;
655 for (i = 0; i < np; i++) {
656 usbip_iso_packet_correct_endian(&iso[i], 0);
657 usbip_pack_iso(&iso[i], &urb->iso_frame_desc[i], 0);
658 total_length += urb->iso_frame_desc[i].actual_length;
663 if (total_length != urb->actual_length) {
664 dev_err(&urb->dev->dev,
665 "total length of iso packets %d not equal to actual length of buffer %d\n",
666 total_length, urb->actual_length);
668 if (ud->side == USBIP_STUB)
669 usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
671 usbip_event_add(ud, VDEV_EVENT_ERROR_TCP);
678 EXPORT_SYMBOL_GPL(usbip_recv_iso);
681 * This functions restores the padding which was removed for optimizing
682 * the bandwidth during transfer over tcp/ip
684 * buffer and iso packets need to be stored and be in propeper endian in urb
685 * before calling this function
687 void usbip_pad_iso(struct usbip_device *ud, struct urb *urb)
689 int np = urb->number_of_packets;
691 int actualoffset = urb->actual_length;
693 if (!usb_pipeisoc(urb->pipe))
696 /* if no packets or length of data is 0, then nothing to unpack */
697 if (np == 0 || urb->actual_length == 0)
701 * if actual_length is transfer_buffer_length then no padding is
704 if (urb->actual_length == urb->transfer_buffer_length)
708 * loop over all packets from last to first (to prevent overwritting
709 * memory when padding) and move them into the proper place
711 for (i = np-1; i > 0; i--) {
712 actualoffset -= urb->iso_frame_desc[i].actual_length;
713 memmove(urb->transfer_buffer + urb->iso_frame_desc[i].offset,
714 urb->transfer_buffer + actualoffset,
715 urb->iso_frame_desc[i].actual_length);
718 EXPORT_SYMBOL_GPL(usbip_pad_iso);
720 /* some members of urb must be substituted before. */
721 int usbip_recv_xbuff(struct usbip_device *ud, struct urb *urb)
726 if (ud->side == USBIP_STUB) {
727 /* the direction of urb must be OUT. */
728 if (usb_pipein(urb->pipe))
731 size = urb->transfer_buffer_length;
733 /* the direction of urb must be IN. */
734 if (usb_pipeout(urb->pipe))
737 size = urb->actual_length;
740 /* no need to recv xbuff */
744 ret = usbip_recv(ud->tcp_socket, urb->transfer_buffer, size);
746 dev_err(&urb->dev->dev, "recv xbuf, %d\n", ret);
747 if (ud->side == USBIP_STUB) {
748 usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
750 usbip_event_add(ud, VDEV_EVENT_ERROR_TCP);
757 EXPORT_SYMBOL_GPL(usbip_recv_xbuff);
759 static int __init usbip_core_init(void)
761 pr_info(DRIVER_DESC " v" USBIP_VERSION "\n");
765 static void __exit usbip_core_exit(void)
770 module_init(usbip_core_init);
771 module_exit(usbip_core_exit);
773 MODULE_AUTHOR(DRIVER_AUTHOR);
774 MODULE_DESCRIPTION(DRIVER_DESC);
775 MODULE_LICENSE("GPL");
776 MODULE_VERSION(USBIP_VERSION);