drivers/staging/usbip/usbip_common.c

   1 /*
   2  * Copyright (C) 2003-2008 Takahiro Hirofuchi
   3  *
   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.
   8  *
   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.
  13  *
  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,
  17  * USA.
  18  */
  19
  20 #include <linux/kernel.h>
  21 #include <linux/smp_lock.h>
  22 #include <linux/file.h>
  23 #include <linux/tcp.h>
  24 #include <linux/in.h>
  25 #include <linux/kthread.h>
  26 #include <linux/slab.h>
  27 #include "usbip_common.h"
  28
  29 /* version information */
  30 #define DRIVER_VERSION "1.0"
  31 #define DRIVER_AUTHOR "Takahiro Hirofuchi <hirofuchi _at_ users.sourceforge.net>"
  32 #define DRIVER_DESC "usbip common driver"
  33
  34 /*-------------------------------------------------------------------------*/
  35 /* debug routines */
  36
  37 #ifdef CONFIG_USB_IP_DEBUG_ENABLE
  38 unsigned long usbip_debug_flag = 0xffffffff;
  39 #else
  40 unsigned long usbip_debug_flag;
  41 #endif
  42 EXPORT_SYMBOL_GPL(usbip_debug_flag);
  43
  44
  45 /* FIXME */
  46 struct device_attribute dev_attr_usbip_debug;
  47 EXPORT_SYMBOL_GPL(dev_attr_usbip_debug);
  48
  49
  50 static ssize_t show_flag(struct device *dev, struct device_attribute *attr,
  51                                                                 char *buf)
  52 {
  53         return sprintf(buf, "%lx\n", usbip_debug_flag);
  54 }
  55
  56 static ssize_t store_flag(struct device *dev, struct device_attribute *attr,
  57                 const char *buf, size_t count)
  58 {
  59         sscanf(buf, "%lx", &usbip_debug_flag);
  60
  61         return count;
  62 }
  63 DEVICE_ATTR(usbip_debug, (S_IRUGO | S_IWUSR), show_flag, store_flag);
  64
  65 static void usbip_dump_buffer(char *buff, int bufflen)
  66 {
  67         print_hex_dump(KERN_DEBUG, "usb-ip", DUMP_PREFIX_OFFSET, 16, 4,
  68                        buff, bufflen, false);
  69 }
  70
  71 static void usbip_dump_pipe(unsigned int p)
  72 {
  73         unsigned char type = usb_pipetype(p);
  74         unsigned char ep = usb_pipeendpoint(p);
  75         unsigned char dev = usb_pipedevice(p);
  76         unsigned char dir = usb_pipein(p);
  77
  78         printk(KERN_DEBUG "dev(%d) ", dev);
  79         printk(KERN_DEBUG "ep(%d) ",  ep);
  80         printk(KERN_DEBUG "%s ", dir ? "IN" : "OUT");
  81
  82         switch (type) {
  83         case PIPE_ISOCHRONOUS:
  84                 printk(KERN_DEBUG "%s ", "ISO");
  85                 break;
  86         case PIPE_INTERRUPT:
  87                 printk(KERN_DEBUG "%s ", "INT");
  88                 break;
  89         case PIPE_CONTROL:
  90                 printk(KERN_DEBUG "%s ", "CTL");
  91                 break;
  92         case PIPE_BULK:
  93                 printk(KERN_DEBUG "%s ", "BLK");
  94                 break;
  95         default:
  96                 printk(KERN_DEBUG "ERR");
  97         }
  98
  99         printk(KERN_DEBUG "\n");
 100
 101 }
 102
 103 static void usbip_dump_usb_device(struct usb_device *udev)
 104 {
 105         struct device *dev = &udev->dev;
 106         int i;
 107
 108         dev_dbg(dev, "       devnum(%d) devpath(%s)",
 109                 udev->devnum, udev->devpath);
 110
 111         switch (udev->speed) {
 112         case USB_SPEED_HIGH:
 113                 printk(KERN_DEBUG " SPD_HIGH");
 114                 break;
 115         case USB_SPEED_FULL:
 116                 printk(KERN_DEBUG " SPD_FULL");
 117                 break;
 118         case USB_SPEED_LOW:
 119                 printk(KERN_DEBUG " SPD_LOW");
 120                 break;
 121         case USB_SPEED_UNKNOWN:
 122                 printk(KERN_DEBUG " SPD_UNKNOWN");
 123                 break;
 124         default:
 125                 printk(KERN_DEBUG " SPD_ERROR");
 126         }
 127
 128         printk(KERN_DEBUG " tt %p, ttport %d", udev->tt, udev->ttport);
 129         printk(KERN_DEBUG "\n");
 130
 131         dev_dbg(dev, "                    ");
 132         for (i = 0; i < 16; i++)
 133                 printk(KERN_DEBUG " %2u", i);
 134         printk(KERN_DEBUG "\n");
 135
 136         dev_dbg(dev, "       toggle0(IN) :");
 137         for (i = 0; i < 16; i++)
 138                 printk(KERN_DEBUG " %2u", (udev->toggle[0] & (1 << i)) ? 1 : 0);
 139         printk(KERN_DEBUG "\n");
 140
 141         dev_dbg(dev, "       toggle1(OUT):");
 142         for (i = 0; i < 16; i++)
 143                 printk(KERN_DEBUG " %2u", (udev->toggle[1] & (1 << i)) ? 1 : 0);
 144         printk(KERN_DEBUG "\n");
 145
 146
 147         dev_dbg(dev, "       epmaxp_in   :");
 148         for (i = 0; i < 16; i++) {
 149                 if (udev->ep_in[i])
 150                         printk(KERN_DEBUG " %2u",
 151                              le16_to_cpu(udev->ep_in[i]->desc.wMaxPacketSize));
 152         }
 153         printk(KERN_DEBUG "\n");
 154
 155         dev_dbg(dev, "       epmaxp_out  :");
 156         for (i = 0; i < 16; i++) {
 157                 if (udev->ep_out[i])
 158                         printk(KERN_DEBUG " %2u",
 159                              le16_to_cpu(udev->ep_out[i]->desc.wMaxPacketSize));
 160         }
 161         printk(KERN_DEBUG "\n");
 162
 163         dev_dbg(dev, "parent %p, bus %p\n", udev->parent, udev->bus);
 164
 165         dev_dbg(dev, "descriptor %p, config %p, actconfig %p, "
 166                 "rawdescriptors %p\n", &udev->descriptor, udev->config,
 167                 udev->actconfig, udev->rawdescriptors);
 168
 169         dev_dbg(dev, "have_langid %d, string_langid %d\n",
 170                 udev->have_langid, udev->string_langid);
 171
 172         dev_dbg(dev, "maxchild %d, children %p\n",
 173                 udev->maxchild, udev->children);
 174 }
 175
 176 static void usbip_dump_request_type(__u8 rt)
 177 {
 178         switch (rt & USB_RECIP_MASK) {
 179         case USB_RECIP_DEVICE:
 180                 printk(KERN_DEBUG "DEVICE");
 181                 break;
 182         case USB_RECIP_INTERFACE:
 183                 printk(KERN_DEBUG "INTERF");
 184                 break;
 185         case USB_RECIP_ENDPOINT:
 186                 printk(KERN_DEBUG "ENDPOI");
 187                 break;
 188         case USB_RECIP_OTHER:
 189                 printk(KERN_DEBUG "OTHER ");
 190                 break;
 191         default:
 192                 printk(KERN_DEBUG "------");
 193         }
 194 }
 195
 196 static void usbip_dump_usb_ctrlrequest(struct usb_ctrlrequest *cmd)
 197 {
 198         if (!cmd) {
 199                 printk(KERN_DEBUG "      %s : null pointer\n", __func__);
 200                 return;
 201         }
 202
 203         printk(KERN_DEBUG "       ");
 204         printk(KERN_DEBUG "bRequestType(%02X) ", cmd->bRequestType);
 205         printk(KERN_DEBUG "bRequest(%02X) " , cmd->bRequest);
 206         printk(KERN_DEBUG "wValue(%04X) ", cmd->wValue);
 207         printk(KERN_DEBUG "wIndex(%04X) ", cmd->wIndex);
 208         printk(KERN_DEBUG "wLength(%04X) ", cmd->wLength);
 209
 210         printk(KERN_DEBUG "\n       ");
 211
 212         if ((cmd->bRequestType & USB_TYPE_MASK) == USB_TYPE_STANDARD) {
 213                 printk(KERN_DEBUG "STANDARD ");
 214                 switch (cmd->bRequest) {
 215                 case USB_REQ_GET_STATUS:
 216                         printk(KERN_DEBUG "GET_STATUS");
 217                         break;
 218                 case USB_REQ_CLEAR_FEATURE:
 219                         printk(KERN_DEBUG "CLEAR_FEAT");
 220                         break;
 221                 case USB_REQ_SET_FEATURE:
 222                         printk(KERN_DEBUG "SET_FEAT  ");
 223                         break;
 224                 case USB_REQ_SET_ADDRESS:
 225                         printk(KERN_DEBUG "SET_ADDRRS");
 226                         break;
 227                 case USB_REQ_GET_DESCRIPTOR:
 228                         printk(KERN_DEBUG "GET_DESCRI");
 229                         break;
 230                 case USB_REQ_SET_DESCRIPTOR:
 231                         printk(KERN_DEBUG "SET_DESCRI");
 232                         break;
 233                 case USB_REQ_GET_CONFIGURATION:
 234                         printk(KERN_DEBUG "GET_CONFIG");
 235                         break;
 236                 case USB_REQ_SET_CONFIGURATION:
 237                         printk(KERN_DEBUG "SET_CONFIG");
 238                         break;
 239                 case USB_REQ_GET_INTERFACE:
 240                         printk(KERN_DEBUG "GET_INTERF");
 241                         break;
 242                 case USB_REQ_SET_INTERFACE:
 243                         printk(KERN_DEBUG "SET_INTERF");
 244                         break;
 245                 case USB_REQ_SYNCH_FRAME:
 246                         printk(KERN_DEBUG "SYNC_FRAME");
 247                         break;
 248                 default:
 249                         printk(KERN_DEBUG "REQ(%02X) ", cmd->bRequest);
 250                 }
 251
 252                 printk(KERN_DEBUG " ");
 253                 usbip_dump_request_type(cmd->bRequestType);
 254
 255         } else if ((cmd->bRequestType & USB_TYPE_MASK) == USB_TYPE_CLASS)
 256                 printk(KERN_DEBUG "CLASS   ");
 257
 258         else if ((cmd->bRequestType & USB_TYPE_MASK) == USB_TYPE_VENDOR)
 259                 printk(KERN_DEBUG "VENDOR  ");
 260
 261         else if ((cmd->bRequestType & USB_TYPE_MASK) == USB_TYPE_RESERVED)
 262                 printk(KERN_DEBUG "RESERVED");
 263
 264         printk(KERN_DEBUG "\n");
 265 }
 266
 267 void usbip_dump_urb(struct urb *urb)
 268 {
 269         struct device *dev;
 270
 271         if (!urb) {
 272                 printk(KERN_DEBUG KBUILD_MODNAME
 273                        ":%s: urb: null pointer!!\n", __func__);
 274                 return;
 275         }
 276
 277         if (!urb->dev) {
 278                 printk(KERN_DEBUG KBUILD_MODNAME
 279                        ":%s: urb->dev: null pointer!!\n", __func__);
 280                 return;
 281         }
 282         dev = &urb->dev->dev;
 283
 284         dev_dbg(dev, "   urb                   :%p\n", urb);
 285         dev_dbg(dev, "   dev                   :%p\n", urb->dev);
 286
 287         usbip_dump_usb_device(urb->dev);
 288
 289         dev_dbg(dev, "   pipe                  :%08x ", urb->pipe);
 290
 291         usbip_dump_pipe(urb->pipe);
 292
 293         dev_dbg(dev, "   status                :%d\n", urb->status);
 294         dev_dbg(dev, "   transfer_flags        :%08X\n", urb->transfer_flags);
 295         dev_dbg(dev, "   transfer_buffer       :%p\n", urb->transfer_buffer);
 296         dev_dbg(dev, "   transfer_buffer_length:%d\n",
 297                                                 urb->transfer_buffer_length);
 298         dev_dbg(dev, "   actual_length         :%d\n", urb->actual_length);
 299         dev_dbg(dev, "   setup_packet          :%p\n", urb->setup_packet);
 300
 301         if (urb->setup_packet && usb_pipetype(urb->pipe) == PIPE_CONTROL)
 302                         usbip_dump_usb_ctrlrequest(
 303                         (struct usb_ctrlrequest *)urb->setup_packet);
 304
 305         dev_dbg(dev, "   start_frame           :%d\n", urb->start_frame);
 306         dev_dbg(dev, "   number_of_packets     :%d\n", urb->number_of_packets);
 307         dev_dbg(dev, "   interval              :%d\n", urb->interval);
 308         dev_dbg(dev, "   error_count           :%d\n", urb->error_count);
 309         dev_dbg(dev, "   context               :%p\n", urb->context);
 310         dev_dbg(dev, "   complete              :%p\n", urb->complete);
 311 }
 312 EXPORT_SYMBOL_GPL(usbip_dump_urb);
 313
 314 void usbip_dump_header(struct usbip_header *pdu)
 315 {
 316         usbip_udbg("BASE: cmd %u seq %u devid %u dir %u ep %u\n",
 317                         pdu->base.command,
 318                         pdu->base.seqnum,
 319                         pdu->base.devid,
 320                         pdu->base.direction,
 321                         pdu->base.ep);
 322
 323         switch (pdu->base.command) {
 324         case USBIP_CMD_SUBMIT:
 325                 usbip_udbg("CMD_SUBMIT: "
 326                                 "x_flags %u x_len %u sf %u #p %u iv %u\n",
 327                                 pdu->u.cmd_submit.transfer_flags,
 328                                 pdu->u.cmd_submit.transfer_buffer_length,
 329                                 pdu->u.cmd_submit.start_frame,
 330                                 pdu->u.cmd_submit.number_of_packets,
 331                                 pdu->u.cmd_submit.interval);
 332                                 break;
 333         case USBIP_CMD_UNLINK:
 334                 usbip_udbg("CMD_UNLINK: seq %u\n", pdu->u.cmd_unlink.seqnum);
 335                 break;
 336         case USBIP_RET_SUBMIT:
 337                 usbip_udbg("RET_SUBMIT: st %d al %u sf %d #p %d ec %d\n",
 338                                 pdu->u.ret_submit.status,
 339                                 pdu->u.ret_submit.actual_length,
 340                                 pdu->u.ret_submit.start_frame,
 341                                 pdu->u.ret_submit.number_of_packets,
 342                                 pdu->u.ret_submit.error_count);
 343         case USBIP_RET_UNLINK:
 344                 usbip_udbg("RET_UNLINK: status %d\n", pdu->u.ret_unlink.status);
 345                 break;
 346         default:
 347                 /* NOT REACHED */
 348                 usbip_udbg("UNKNOWN\n");
 349         }
 350 }
 351 EXPORT_SYMBOL_GPL(usbip_dump_header);
 352
 353
 354 /*-------------------------------------------------------------------------*/
 355 /* thread routines */
 356
 357 int usbip_thread(void *param)
 358 {
 359         struct usbip_task *ut = param;
 360
 361         if (!ut)
 362                 return -EINVAL;
 363
 364         lock_kernel();
 365         daemonize(ut->name);
 366         allow_signal(SIGKILL);
 367         ut->thread = current;
 368         unlock_kernel();
 369
 370         /* srv.rb must wait for rx_thread starting */
 371         complete(&ut->thread_done);
 372
 373         /* start of while loop */
 374         ut->loop_ops(ut);
 375
 376         /* end of loop */
 377         ut->thread = NULL;
 378
 379         complete_and_exit(&ut->thread_done, 0);
 380 }
 381
 382 static void stop_rx_thread(struct usbip_device *ud)
 383 {
 384         if (ud->tcp_rx.thread != NULL) {
 385                 send_sig(SIGKILL, ud->tcp_rx.thread, 1);
 386                 wait_for_completion(&ud->tcp_rx.thread_done);
 387                 usbip_udbg("rx_thread for ud %p has finished\n", ud);
 388         }
 389 }
 390
 391 static void stop_tx_thread(struct usbip_device *ud)
 392 {
 393         if (ud->tcp_tx.thread != NULL) {
 394                 send_sig(SIGKILL, ud->tcp_tx.thread, 1);
 395                 wait_for_completion(&ud->tcp_tx.thread_done);
 396                 usbip_udbg("tx_thread for ud %p has finished\n", ud);
 397         }
 398 }
 399
 400 int usbip_start_threads(struct usbip_device *ud)
 401 {
 402         /*
 403          * threads are invoked per one device (per one connection).
 404          */
 405         struct task_struct *th;
 406         int err = 0;
 407
 408         th = kthread_run(usbip_thread, (void *)&ud->tcp_rx, "usbip");
 409         if (IS_ERR(th)) {
 410                 printk(KERN_WARNING
 411                         "Unable to start control thread\n");
 412                 err = PTR_ERR(th);
 413                 goto ust_exit;
 414         }
 415
 416         th = kthread_run(usbip_thread, (void *)&ud->tcp_tx, "usbip");
 417         if (IS_ERR(th)) {
 418                 printk(KERN_WARNING
 419                         "Unable to start control thread\n");
 420                 err = PTR_ERR(th);
 421                 goto tx_thread_err;
 422         }
 423
 424         /* confirm threads are starting */
 425         wait_for_completion(&ud->tcp_rx.thread_done);
 426         wait_for_completion(&ud->tcp_tx.thread_done);
 427
 428         return 0;
 429
 430 tx_thread_err:
 431         stop_rx_thread(ud);
 432
 433 ust_exit:
 434         return err;
 435 }
 436 EXPORT_SYMBOL_GPL(usbip_start_threads);
 437
 438 void usbip_stop_threads(struct usbip_device *ud)
 439 {
 440         /* kill threads related to this sdev, if v.c. exists */
 441         stop_rx_thread(ud);
 442         stop_tx_thread(ud);
 443 }
 444 EXPORT_SYMBOL_GPL(usbip_stop_threads);
 445
 446 void usbip_task_init(struct usbip_task *ut, char *name,
 447                 void (*loop_ops)(struct usbip_task *))
 448 {
 449         ut->thread = NULL;
 450         init_completion(&ut->thread_done);
 451         ut->name = name;
 452         ut->loop_ops = loop_ops;
 453 }
 454 EXPORT_SYMBOL_GPL(usbip_task_init);
 455
 456
 457 /*-------------------------------------------------------------------------*/
 458 /* socket routines */
 459
 460 /*  Send/receive messages over TCP/IP. I refer drivers/block/nbd.c */
 461 int usbip_xmit(int send, struct socket *sock, char *buf,
 462                int size, int msg_flags)
 463 {
 464         int result;
 465         struct msghdr msg;
 466         struct kvec iov;
 467         int total = 0;
 468
 469         /* for blocks of if (usbip_dbg_flag_xmit) */
 470         char *bp = buf;
 471         int osize = size;
 472
 473         usbip_dbg_xmit("enter\n");
 474
 475         if (!sock || !buf || !size) {
 476                 printk(KERN_ERR "%s: invalid arg, sock %p buff %p size %d\n",
 477                        __func__, sock, buf, size);
 478                 return -EINVAL;
 479         }
 480
 481
 482         if (usbip_dbg_flag_xmit) {
 483                 if (send) {
 484                         if (!in_interrupt())
 485                                 printk(KERN_DEBUG "%-10s:", current->comm);
 486                         else
 487                                 printk(KERN_DEBUG "interrupt  :");
 488
 489                         printk(KERN_DEBUG "%s: sending... , sock %p, buf %p, "
 490                                "size %d, msg_flags %d\n", __func__,
 491                                sock, buf, size, msg_flags);
 492                         usbip_dump_buffer(buf, size);
 493                 }
 494         }
 495
 496
 497         do {
 498                 sock->sk->sk_allocation = GFP_NOIO;
 499                 iov.iov_base    = buf;
 500                 iov.iov_len     = size;
 501                 msg.msg_name    = NULL;
 502                 msg.msg_namelen = 0;
 503                 msg.msg_control = NULL;
 504                 msg.msg_controllen = 0;
 505                 msg.msg_namelen    = 0;
 506                 msg.msg_flags      = msg_flags | MSG_NOSIGNAL;
 507
 508                 if (send)
 509                         result = kernel_sendmsg(sock, &msg, &iov, 1, size);
 510                 else
 511                         result = kernel_recvmsg(sock, &msg, &iov, 1, size,
 512                                                                 MSG_WAITALL);
 513
 514                 if (result <= 0) {
 515                         usbip_udbg("usbip_xmit: %s sock %p buf %p size %u ret "
 516                                         "%d total %d\n",
 517                                         send ? "send" : "receive", sock, buf,
 518                                         size, result, total);
 519                         goto err;
 520                 }
 521
 522                 size -= result;
 523                 buf += result;
 524                 total += result;
 525
 526         } while (size > 0);
 527
 528
 529         if (usbip_dbg_flag_xmit) {
 530                 if (!send) {
 531                         if (!in_interrupt())
 532                                 printk(KERN_DEBUG "%-10s:", current->comm);
 533                         else
 534                                 printk(KERN_DEBUG "interrupt  :");
 535
 536                         printk(KERN_DEBUG "usbip_xmit: receiving....\n");
 537                         usbip_dump_buffer(bp, osize);
 538                         printk(KERN_DEBUG "usbip_xmit: received, osize %d ret "
 539                                         "%d size %d total %d\n", osize, result,
 540                                         size, total);
 541                 }
 542
 543                 if (send)
 544                         printk(KERN_DEBUG "usbip_xmit: send, total %d\n",
 545                                                                         total);
 546         }
 547
 548         return total;
 549
 550 err:
 551         return result;
 552 }
 553 EXPORT_SYMBOL_GPL(usbip_xmit);
 554
 555 struct socket *sockfd_to_socket(unsigned int sockfd)
 556 {
 557         struct socket *socket;
 558         struct file *file;
 559         struct inode *inode;
 560
 561         file = fget(sockfd);
 562         if (!file) {
 563                 printk(KERN_ERR "%s: invalid sockfd\n", __func__);
 564                 return NULL;
 565         }
 566
 567         inode = file->f_dentry->d_inode;
 568
 569         if (!inode || !S_ISSOCK(inode->i_mode))
 570                 return NULL;
 571
 572         socket = SOCKET_I(inode);
 573
 574         return socket;
 575 }
 576 EXPORT_SYMBOL_GPL(sockfd_to_socket);
 577
 578
 579
 580 /*-------------------------------------------------------------------------*/
 581 /* pdu routines */
 582
 583 /* there may be more cases to tweak the flags. */
 584 static unsigned int tweak_transfer_flags(unsigned int flags)
 585 {
 586         flags &= ~URB_NO_TRANSFER_DMA_MAP;
 587         return flags;
 588 }
 589
 590 static void usbip_pack_cmd_submit(struct usbip_header *pdu, struct urb *urb,
 591                                                                 int pack)
 592 {
 593         struct usbip_header_cmd_submit *spdu = &pdu->u.cmd_submit;
 594
 595         /*
 596          * Some members are not still implemented in usbip. I hope this issue
 597          * will be discussed when usbip is ported to other operating systems.
 598          */
 599         if (pack) {
 600                 /* vhci_tx.c */
 601                 spdu->transfer_flags =
 602                                 tweak_transfer_flags(urb->transfer_flags);
 603                 spdu->transfer_buffer_length    = urb->transfer_buffer_length;
 604                 spdu->start_frame               = urb->start_frame;
 605                 spdu->number_of_packets         = urb->number_of_packets;
 606                 spdu->interval                  = urb->interval;
 607         } else  {
 608                 /* stub_rx.c */
 609                 urb->transfer_flags         = spdu->transfer_flags;
 610
 611                 urb->transfer_buffer_length = spdu->transfer_buffer_length;
 612                 urb->start_frame            = spdu->start_frame;
 613                 urb->number_of_packets      = spdu->number_of_packets;
 614                 urb->interval               = spdu->interval;
 615         }
 616 }
 617
 618 static void usbip_pack_ret_submit(struct usbip_header *pdu, struct urb *urb,
 619                                                                 int pack)
 620 {
 621         struct usbip_header_ret_submit *rpdu = &pdu->u.ret_submit;
 622
 623         if (pack) {
 624                 /* stub_tx.c */
 625
 626                 rpdu->status            = urb->status;
 627                 rpdu->actual_length     = urb->actual_length;
 628                 rpdu->start_frame       = urb->start_frame;
 629                 rpdu->number_of_packets = urb->number_of_packets;
 630                 rpdu->error_count       = urb->error_count;
 631         } else {
 632                 /* vhci_rx.c */
 633
 634                 urb->status             = rpdu->status;
 635                 urb->actual_length      = rpdu->actual_length;
 636                 urb->start_frame        = rpdu->start_frame;
 637                 urb->number_of_packets = rpdu->number_of_packets;
 638                 urb->error_count        = rpdu->error_count;
 639         }
 640 }
 641
 642
 643 void usbip_pack_pdu(struct usbip_header *pdu, struct urb *urb, int cmd,
 644                                                                 int pack)
 645 {
 646         switch (cmd) {
 647         case USBIP_CMD_SUBMIT:
 648                 usbip_pack_cmd_submit(pdu, urb, pack);
 649                 break;
 650         case USBIP_RET_SUBMIT:
 651                 usbip_pack_ret_submit(pdu, urb, pack);
 652                 break;
 653         default:
 654                 err("unknown command");
 655                 /* NOTREACHED */
 656                 /* BUG(); */
 657         }
 658 }
 659 EXPORT_SYMBOL_GPL(usbip_pack_pdu);
 660
 661
 662 static void correct_endian_basic(struct usbip_header_basic *base, int send)
 663 {
 664         if (send) {
 665                 base->command   = cpu_to_be32(base->command);
 666                 base->seqnum    = cpu_to_be32(base->seqnum);
 667                 base->devid     = cpu_to_be32(base->devid);
 668                 base->direction = cpu_to_be32(base->direction);
 669                 base->ep        = cpu_to_be32(base->ep);
 670         } else {
 671                 base->command   = be32_to_cpu(base->command);
 672                 base->seqnum    = be32_to_cpu(base->seqnum);
 673                 base->devid     = be32_to_cpu(base->devid);
 674                 base->direction = be32_to_cpu(base->direction);
 675                 base->ep        = be32_to_cpu(base->ep);
 676         }
 677 }
 678
 679 static void correct_endian_cmd_submit(struct usbip_header_cmd_submit *pdu,
 680                                                                 int send)
 681 {
 682         if (send) {
 683                 pdu->transfer_flags = cpu_to_be32(pdu->transfer_flags);
 684
 685                 cpu_to_be32s(&pdu->transfer_buffer_length);
 686                 cpu_to_be32s(&pdu->start_frame);
 687                 cpu_to_be32s(&pdu->number_of_packets);
 688                 cpu_to_be32s(&pdu->interval);
 689         } else {
 690                 pdu->transfer_flags = be32_to_cpu(pdu->transfer_flags);
 691
 692                 be32_to_cpus(&pdu->transfer_buffer_length);
 693                 be32_to_cpus(&pdu->start_frame);
 694                 be32_to_cpus(&pdu->number_of_packets);
 695                 be32_to_cpus(&pdu->interval);
 696         }
 697 }
 698
 699 static void correct_endian_ret_submit(struct usbip_header_ret_submit *pdu,
 700                                                                 int send)
 701 {
 702         if (send) {
 703                 cpu_to_be32s(&pdu->status);
 704                 cpu_to_be32s(&pdu->actual_length);
 705                 cpu_to_be32s(&pdu->start_frame);
 706                 cpu_to_be32s(&pdu->number_of_packets);
 707                 cpu_to_be32s(&pdu->error_count);
 708         } else {
 709                 be32_to_cpus(&pdu->status);
 710                 be32_to_cpus(&pdu->actual_length);
 711                 be32_to_cpus(&pdu->start_frame);
 712                 cpu_to_be32s(&pdu->number_of_packets);
 713                 be32_to_cpus(&pdu->error_count);
 714         }
 715 }
 716
 717 static void correct_endian_cmd_unlink(struct usbip_header_cmd_unlink *pdu,
 718                                                                 int send)
 719 {
 720         if (send)
 721                 pdu->seqnum = cpu_to_be32(pdu->seqnum);
 722         else
 723                 pdu->seqnum = be32_to_cpu(pdu->seqnum);
 724 }
 725
 726 static void correct_endian_ret_unlink(struct usbip_header_ret_unlink *pdu,
 727                                                                 int send)
 728 {
 729         if (send)
 730                 cpu_to_be32s(&pdu->status);
 731         else
 732                 be32_to_cpus(&pdu->status);
 733 }
 734
 735 void usbip_header_correct_endian(struct usbip_header *pdu, int send)
 736 {
 737         __u32 cmd = 0;
 738
 739         if (send)
 740                 cmd = pdu->base.command;
 741
 742         correct_endian_basic(&pdu->base, send);
 743
 744         if (!send)
 745                 cmd = pdu->base.command;
 746
 747         switch (cmd) {
 748         case USBIP_CMD_SUBMIT:
 749                 correct_endian_cmd_submit(&pdu->u.cmd_submit, send);
 750                 break;
 751         case USBIP_RET_SUBMIT:
 752                 correct_endian_ret_submit(&pdu->u.ret_submit, send);
 753                 break;
 754         case USBIP_CMD_UNLINK:
 755                 correct_endian_cmd_unlink(&pdu->u.cmd_unlink, send);
 756                 break;
 757         case USBIP_RET_UNLINK:
 758                 correct_endian_ret_unlink(&pdu->u.ret_unlink, send);
 759                 break;
 760         default:
 761                 /* NOTREACHED */
 762                 err("unknown command in pdu header: %d", cmd);
 763                 /* BUG(); */
 764         }
 765 }
 766 EXPORT_SYMBOL_GPL(usbip_header_correct_endian);
 767
 768 static void usbip_iso_pakcet_correct_endian(
 769                                 struct usbip_iso_packet_descriptor *iso,
 770                                 int send)
 771 {
 772         /* does not need all members. but copy all simply. */
 773         if (send) {
 774                 iso->offset     = cpu_to_be32(iso->offset);
 775                 iso->length     = cpu_to_be32(iso->length);
 776                 iso->status     = cpu_to_be32(iso->status);
 777                 iso->actual_length = cpu_to_be32(iso->actual_length);
 778         } else {
 779                 iso->offset     = be32_to_cpu(iso->offset);
 780                 iso->length     = be32_to_cpu(iso->length);
 781                 iso->status     = be32_to_cpu(iso->status);
 782                 iso->actual_length = be32_to_cpu(iso->actual_length);
 783         }
 784 }
 785
 786 static void usbip_pack_iso(struct usbip_iso_packet_descriptor *iso,
 787                 struct usb_iso_packet_descriptor *uiso, int pack)
 788 {
 789         if (pack) {
 790                 iso->offset             = uiso->offset;
 791                 iso->length             = uiso->length;
 792                 iso->status             = uiso->status;
 793                 iso->actual_length      = uiso->actual_length;
 794         } else {
 795                 uiso->offset            = iso->offset;
 796                 uiso->length            = iso->length;
 797                 uiso->status            = iso->status;
 798                 uiso->actual_length     = iso->actual_length;
 799         }
 800 }
 801
 802
 803 /* must free buffer */
 804 void *usbip_alloc_iso_desc_pdu(struct urb *urb, ssize_t *bufflen)
 805 {
 806         void *buff;
 807         struct usbip_iso_packet_descriptor *iso;
 808         int np = urb->number_of_packets;
 809         ssize_t size = np * sizeof(*iso);
 810         int i;
 811
 812         buff = kzalloc(size, GFP_KERNEL);
 813         if (!buff)
 814                 return NULL;
 815
 816         for (i = 0; i < np; i++) {
 817                 iso = buff + (i * sizeof(*iso));
 818
 819                 usbip_pack_iso(iso, &urb->iso_frame_desc[i], 1);
 820                 usbip_iso_pakcet_correct_endian(iso, 1);
 821         }
 822
 823         *bufflen = size;
 824
 825         return buff;
 826 }
 827 EXPORT_SYMBOL_GPL(usbip_alloc_iso_desc_pdu);
 828
 829 /* some members of urb must be substituted before. */
 830 int usbip_recv_iso(struct usbip_device *ud, struct urb *urb)
 831 {
 832         void *buff;
 833         struct usbip_iso_packet_descriptor *iso;
 834         int np = urb->number_of_packets;
 835         int size = np * sizeof(*iso);
 836         int i;
 837         int ret;
 838         int total_length = 0;
 839
 840         if (!usb_pipeisoc(urb->pipe))
 841                 return 0;
 842
 843         /* my Bluetooth dongle gets ISO URBs which are np = 0 */
 844         if (np == 0) {
 845                 /* usbip_uinfo("iso np == 0\n"); */
 846                 /* usbip_dump_urb(urb); */
 847                 return 0;
 848         }
 849
 850         buff = kzalloc(size, GFP_KERNEL);
 851         if (!buff)
 852                 return -ENOMEM;
 853
 854         ret = usbip_xmit(0, ud->tcp_socket, buff, size, 0);
 855         if (ret != size) {
 856                 dev_err(&urb->dev->dev, "recv iso_frame_descriptor, %d\n",
 857                         ret);
 858                 kfree(buff);
 859
 860                 if (ud->side == USBIP_STUB)
 861                         usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
 862                 else
 863                         usbip_event_add(ud, VDEV_EVENT_ERROR_TCP);
 864
 865                 return -EPIPE;
 866         }
 867
 868
 869         for (i = 0; i < np; i++) {
 870                 iso = buff + (i * sizeof(*iso));
 871
 872                 usbip_iso_pakcet_correct_endian(iso, 0);
 873                 usbip_pack_iso(iso, &urb->iso_frame_desc[i], 0);
 874                 total_length += urb->iso_frame_desc[i].actual_length;
 875         }
 876
 877         kfree(buff);
 878
 879         if (total_length != urb->actual_length) {
 880                 dev_err(&urb->dev->dev,
 881                   "total length of iso packets (%d) not equal to actual length of buffer (%d)\n",
 882                   total_length, urb->actual_length);
 883
 884                 if (ud->side == USBIP_STUB)
 885                         usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
 886                 else
 887                         usbip_event_add(ud, VDEV_EVENT_ERROR_TCP);
 888
 889                 return -EPIPE;
 890         }
 891
 892         return ret;
 893 }
 894 EXPORT_SYMBOL_GPL(usbip_recv_iso);
 895
 896 /*
 897  * This functions restores the padding which was removed for optimizing
 898  * the bandwidth during transfer over tcp/ip
 899  *
 900  * buffer and iso packets need to be stored and be in propeper endian in urb
 901  * before calling this function
 902  */
 903 int usbip_pad_iso(struct usbip_device *ud, struct urb *urb)
 904 {
 905         int np = urb->number_of_packets;
 906         int i;
 907         int ret;
 908         int actualoffset = urb->actual_length;
 909
 910         if (!usb_pipeisoc(urb->pipe))
 911                 return 0;
 912
 913         /* if no packets or length of data is 0, then nothing to unpack */
 914         if (np == 0 || urb->actual_length == 0)
 915                 return 0;
 916
 917         /*
 918          * if actual_length is transfer_buffer_length then no padding is
 919          * present.
 920         */
 921         if (urb->actual_length == urb->transfer_buffer_length)
 922                 return 0;
 923
 924         /*
 925          * loop over all packets from last to first (to prevent overwritting
 926          * memory when padding) and move them into the proper place
 927          */
 928         for (i = np-1; i > 0; i--) {
 929                 actualoffset -= urb->iso_frame_desc[i].actual_length;
 930                 memmove(urb->transfer_buffer + urb->iso_frame_desc[i].offset,
 931                                   urb->transfer_buffer + actualoffset,
 932                                   urb->iso_frame_desc[i].actual_length);
 933         }
 934         return ret;
 935 }
 936 EXPORT_SYMBOL_GPL(usbip_pad_iso);
 937
 938 /* some members of urb must be substituted before. */
 939 int usbip_recv_xbuff(struct usbip_device *ud, struct urb *urb)
 940 {
 941         int ret;
 942         int size;
 943
 944         if (ud->side == USBIP_STUB) {
 945                 /* stub_rx.c */
 946                 /* the direction of urb must be OUT. */
 947                 if (usb_pipein(urb->pipe))
 948                         return 0;
 949
 950                 size = urb->transfer_buffer_length;
 951         } else {
 952                 /* vhci_rx.c */
 953                 /* the direction of urb must be IN. */
 954                 if (usb_pipeout(urb->pipe))
 955                         return 0;
 956
 957                 size = urb->actual_length;
 958         }
 959
 960         /* no need to recv xbuff */
 961         if (!(size > 0))
 962                 return 0;
 963
 964         ret = usbip_xmit(0, ud->tcp_socket, (char *)urb->transfer_buffer,
 965                          size, 0);
 966         if (ret != size) {
 967                 dev_err(&urb->dev->dev, "recv xbuf, %d\n", ret);
 968                 if (ud->side == USBIP_STUB) {
 969                         usbip_event_add(ud, SDEV_EVENT_ERROR_TCP);
 970                 } else {
 971                         usbip_event_add(ud, VDEV_EVENT_ERROR_TCP);
 972                         return -EPIPE;
 973                 }
 974         }
 975
 976         return ret;
 977 }
 978 EXPORT_SYMBOL_GPL(usbip_recv_xbuff);
 979
 980
 981 /*-------------------------------------------------------------------------*/
 982
 983 static int __init usbip_common_init(void)
 984 {
 985         printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "" DRIVER_VERSION);
 986
 987         return 0;
 988 }
 989
 990 static void __exit usbip_common_exit(void)
 991 {
 992         return;
 993 }
 994
 995
 996
 997
 998 module_init(usbip_common_init);
 999 module_exit(usbip_common_exit);
1000
1001 MODULE_AUTHOR(DRIVER_AUTHOR);
1002 MODULE_DESCRIPTION(DRIVER_DESC);
1003 MODULE_LICENSE("GPL");