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