drivers/usb/usbip/usbip_common.h

   1 /*
   2  * Copyright (C) 2003-2008 Takahiro Hirofuchi
   3  * Copyright (C) 2015-2016 Samsung Electronics
   4  *               Krzysztof Opasiak <k.opasiak@samsung.com>
   5  *
   6  * This is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
  19  * USA.
  20  */
  21
  22 #ifndef __USBIP_COMMON_H
  23 #define __USBIP_COMMON_H
  24
  25 #include <linux/compiler.h>
  26 #include <linux/device.h>
  27 #include <linux/interrupt.h>
  28 #include <linux/net.h>
  29 #include <linux/printk.h>
  30 #include <linux/spinlock.h>
  31 #include <linux/types.h>
  32 #include <linux/usb.h>
  33 #include <linux/wait.h>
  34 #include <uapi/linux/usbip.h>
  35
  36 #define USBIP_VERSION "1.0.0"
  37
  38 #undef pr_fmt
  39
  40 #ifdef DEBUG
  41 #define pr_fmt(fmt)     KBUILD_MODNAME ": %s:%d: " fmt, __func__, __LINE__
  42 #else
  43 #define pr_fmt(fmt)     KBUILD_MODNAME ": " fmt
  44 #endif
  45
  46 enum {
  47         usbip_debug_xmit        = (1 << 0),
  48         usbip_debug_sysfs       = (1 << 1),
  49         usbip_debug_urb         = (1 << 2),
  50         usbip_debug_eh          = (1 << 3),
  51
  52         usbip_debug_stub_cmp    = (1 << 8),
  53         usbip_debug_stub_dev    = (1 << 9),
  54         usbip_debug_stub_rx     = (1 << 10),
  55         usbip_debug_stub_tx     = (1 << 11),
  56
  57         usbip_debug_vhci_rh     = (1 << 8),
  58         usbip_debug_vhci_hc     = (1 << 9),
  59         usbip_debug_vhci_rx     = (1 << 10),
  60         usbip_debug_vhci_tx     = (1 << 11),
  61         usbip_debug_vhci_sysfs  = (1 << 12)
  62 };
  63
  64 #define usbip_dbg_flag_xmit     (usbip_debug_flag & usbip_debug_xmit)
  65 #define usbip_dbg_flag_vhci_rh  (usbip_debug_flag & usbip_debug_vhci_rh)
  66 #define usbip_dbg_flag_vhci_hc  (usbip_debug_flag & usbip_debug_vhci_hc)
  67 #define usbip_dbg_flag_vhci_rx  (usbip_debug_flag & usbip_debug_vhci_rx)
  68 #define usbip_dbg_flag_vhci_tx  (usbip_debug_flag & usbip_debug_vhci_tx)
  69 #define usbip_dbg_flag_stub_rx  (usbip_debug_flag & usbip_debug_stub_rx)
  70 #define usbip_dbg_flag_stub_tx  (usbip_debug_flag & usbip_debug_stub_tx)
  71 #define usbip_dbg_flag_vhci_sysfs  (usbip_debug_flag & usbip_debug_vhci_sysfs)
  72
  73 extern unsigned long usbip_debug_flag;
  74 extern struct device_attribute dev_attr_usbip_debug;
  75
  76 #define usbip_dbg_with_flag(flag, fmt, args...)         \
  77         do {                                            \
  78                 if (flag & usbip_debug_flag)            \
  79                         pr_debug(fmt, ##args);          \
  80         } while (0)
  81
  82 #define usbip_dbg_sysfs(fmt, args...) \
  83         usbip_dbg_with_flag(usbip_debug_sysfs, fmt , ##args)
  84 #define usbip_dbg_xmit(fmt, args...) \
  85         usbip_dbg_with_flag(usbip_debug_xmit, fmt , ##args)
  86 #define usbip_dbg_urb(fmt, args...) \
  87         usbip_dbg_with_flag(usbip_debug_urb, fmt , ##args)
  88 #define usbip_dbg_eh(fmt, args...) \
  89         usbip_dbg_with_flag(usbip_debug_eh, fmt , ##args)
  90
  91 #define usbip_dbg_vhci_rh(fmt, args...) \
  92         usbip_dbg_with_flag(usbip_debug_vhci_rh, fmt , ##args)
  93 #define usbip_dbg_vhci_hc(fmt, args...) \
  94         usbip_dbg_with_flag(usbip_debug_vhci_hc, fmt , ##args)
  95 #define usbip_dbg_vhci_rx(fmt, args...) \
  96         usbip_dbg_with_flag(usbip_debug_vhci_rx, fmt , ##args)
  97 #define usbip_dbg_vhci_tx(fmt, args...) \
  98         usbip_dbg_with_flag(usbip_debug_vhci_tx, fmt , ##args)
  99 #define usbip_dbg_vhci_sysfs(fmt, args...) \
 100         usbip_dbg_with_flag(usbip_debug_vhci_sysfs, fmt , ##args)
 101
 102 #define usbip_dbg_stub_cmp(fmt, args...) \
 103         usbip_dbg_with_flag(usbip_debug_stub_cmp, fmt , ##args)
 104 #define usbip_dbg_stub_rx(fmt, args...) \
 105         usbip_dbg_with_flag(usbip_debug_stub_rx, fmt , ##args)
 106 #define usbip_dbg_stub_tx(fmt, args...) \
 107         usbip_dbg_with_flag(usbip_debug_stub_tx, fmt , ##args)
 108
 109 /*
 110  * USB/IP request headers
 111  *
 112  * Each request is transferred across the network to its counterpart, which
 113  * facilitates the normal USB communication. The values contained in the headers
 114  * are basically the same as in a URB. Currently, four request types are
 115  * defined:
 116  *
 117  *  - USBIP_CMD_SUBMIT: a USB request block, corresponds to usb_submit_urb()
 118  *    (client to server)
 119  *
 120  *  - USBIP_RET_SUBMIT: the result of USBIP_CMD_SUBMIT
 121  *    (server to client)
 122  *
 123  *  - USBIP_CMD_UNLINK: an unlink request of a pending USBIP_CMD_SUBMIT,
 124  *    corresponds to usb_unlink_urb()
 125  *    (client to server)
 126  *
 127  *  - USBIP_RET_UNLINK: the result of USBIP_CMD_UNLINK
 128  *    (server to client)
 129  *
 130  */
 131 #define USBIP_CMD_SUBMIT        0x0001
 132 #define USBIP_CMD_UNLINK        0x0002
 133 #define USBIP_RET_SUBMIT        0x0003
 134 #define USBIP_RET_UNLINK        0x0004
 135
 136 #define USBIP_DIR_OUT   0x00
 137 #define USBIP_DIR_IN    0x01
 138
 139 /*
 140  * Arbitrary limit for the maximum number of isochronous packets in an URB,
 141  * compare for example the uhci_submit_isochronous function in
 142  * drivers/usb/host/uhci-q.c
 143  */
 144 #define USBIP_MAX_ISO_PACKETS 1024
 145
 146 /**
 147  * struct usbip_header_basic - data pertinent to every request
 148  * @command: the usbip request type
 149  * @seqnum: sequential number that identifies requests; incremented per
 150  *          connection
 151  * @devid: specifies a remote USB device uniquely instead of busnum and devnum;
 152  *         in the stub driver, this value is ((busnum << 16) | devnum)
 153  * @direction: direction of the transfer
 154  * @ep: endpoint number
 155  */
 156 struct usbip_header_basic {
 157         __u32 command;
 158         __u32 seqnum;
 159         __u32 devid;
 160         __u32 direction;
 161         __u32 ep;
 162 } __packed;
 163
 164 /**
 165  * struct usbip_header_cmd_submit - USBIP_CMD_SUBMIT packet header
 166  * @transfer_flags: URB flags
 167  * @transfer_buffer_length: the data size for (in) or (out) transfer
 168  * @start_frame: initial frame for isochronous or interrupt transfers
 169  * @number_of_packets: number of isochronous packets
 170  * @interval: maximum time for the request on the server-side host controller
 171  * @setup: setup data for a control request
 172  */
 173 struct usbip_header_cmd_submit {
 174         __u32 transfer_flags;
 175         __s32 transfer_buffer_length;
 176
 177         /* it is difficult for usbip to sync frames (reserved only?) */
 178         __s32 start_frame;
 179         __s32 number_of_packets;
 180         __s32 interval;
 181
 182         unsigned char setup[8];
 183 } __packed;
 184
 185 /**
 186  * struct usbip_header_ret_submit - USBIP_RET_SUBMIT packet header
 187  * @status: return status of a non-iso request
 188  * @actual_length: number of bytes transferred
 189  * @start_frame: initial frame for isochronous or interrupt transfers
 190  * @number_of_packets: number of isochronous packets
 191  * @error_count: number of errors for isochronous transfers
 192  */
 193 struct usbip_header_ret_submit {
 194         __s32 status;
 195         __s32 actual_length;
 196         __s32 start_frame;
 197         __s32 number_of_packets;
 198         __s32 error_count;
 199 } __packed;
 200
 201 /**
 202  * struct usbip_header_cmd_unlink - USBIP_CMD_UNLINK packet header
 203  * @seqnum: the URB seqnum to unlink
 204  */
 205 struct usbip_header_cmd_unlink {
 206         __u32 seqnum;
 207 } __packed;
 208
 209 /**
 210  * struct usbip_header_ret_unlink - USBIP_RET_UNLINK packet header
 211  * @status: return status of the request
 212  */
 213 struct usbip_header_ret_unlink {
 214         __s32 status;
 215 } __packed;
 216
 217 /**
 218  * struct usbip_header - common header for all usbip packets
 219  * @base: the basic header
 220  * @u: packet type dependent header
 221  */
 222 struct usbip_header {
 223         struct usbip_header_basic base;
 224
 225         union {
 226                 struct usbip_header_cmd_submit  cmd_submit;
 227                 struct usbip_header_ret_submit  ret_submit;
 228                 struct usbip_header_cmd_unlink  cmd_unlink;
 229                 struct usbip_header_ret_unlink  ret_unlink;
 230         } u;
 231 } __packed;
 232
 233 /*
 234  * This is the same as usb_iso_packet_descriptor but packed for pdu.
 235  */
 236 struct usbip_iso_packet_descriptor {
 237         __u32 offset;
 238         __u32 length;                   /* expected length */
 239         __u32 actual_length;
 240         __u32 status;
 241 } __packed;
 242
 243 enum usbip_side {
 244         USBIP_VHCI,
 245         USBIP_STUB,
 246         USBIP_VUDC,
 247 };
 248
 249 /* event handler */
 250 #define USBIP_EH_SHUTDOWN       (1 << 0)
 251 #define USBIP_EH_BYE            (1 << 1)
 252 #define USBIP_EH_RESET          (1 << 2)
 253 #define USBIP_EH_UNUSABLE       (1 << 3)
 254
 255 #define SDEV_EVENT_REMOVED      (USBIP_EH_SHUTDOWN | USBIP_EH_BYE)
 256 #define SDEV_EVENT_DOWN         (USBIP_EH_SHUTDOWN | USBIP_EH_RESET)
 257 #define SDEV_EVENT_ERROR_TCP    (USBIP_EH_SHUTDOWN | USBIP_EH_RESET)
 258 #define SDEV_EVENT_ERROR_SUBMIT (USBIP_EH_SHUTDOWN | USBIP_EH_RESET)
 259 #define SDEV_EVENT_ERROR_MALLOC (USBIP_EH_SHUTDOWN | USBIP_EH_UNUSABLE)
 260
 261 #define VUDC_EVENT_REMOVED   (USBIP_EH_SHUTDOWN | USBIP_EH_RESET | USBIP_EH_BYE)
 262 #define VUDC_EVENT_DOWN         (USBIP_EH_SHUTDOWN | USBIP_EH_RESET)
 263 #define VUDC_EVENT_ERROR_TCP    (USBIP_EH_SHUTDOWN | USBIP_EH_RESET)
 264 /* catastrophic emulated usb error */
 265 #define VUDC_EVENT_ERROR_USB    (USBIP_EH_SHUTDOWN | USBIP_EH_UNUSABLE)
 266 #define VUDC_EVENT_ERROR_MALLOC (USBIP_EH_SHUTDOWN | USBIP_EH_UNUSABLE)
 267
 268 #define VDEV_EVENT_REMOVED (USBIP_EH_SHUTDOWN | USBIP_EH_RESET | USBIP_EH_BYE)
 269 #define VDEV_EVENT_DOWN         (USBIP_EH_SHUTDOWN | USBIP_EH_RESET)
 270 #define VDEV_EVENT_ERROR_TCP    (USBIP_EH_SHUTDOWN | USBIP_EH_RESET)
 271 #define VDEV_EVENT_ERROR_MALLOC (USBIP_EH_SHUTDOWN | USBIP_EH_UNUSABLE)
 272
 273 /* a common structure for stub_device and vhci_device */
 274 struct usbip_device {
 275         enum usbip_side side;
 276         enum usbip_device_status status;
 277
 278         /* lock for status */
 279         spinlock_t lock;
 280
 281         /* mutex for synchronizing sysfs store paths */
 282         struct mutex sysfs_lock;
 283
 284         int sockfd;
 285         struct socket *tcp_socket;
 286
 287         struct task_struct *tcp_rx;
 288         struct task_struct *tcp_tx;
 289
 290         unsigned long event;
 291         wait_queue_head_t eh_waitq;
 292
 293         struct eh_ops {
 294                 void (*shutdown)(struct usbip_device *);
 295                 void (*reset)(struct usbip_device *);
 296                 void (*unusable)(struct usbip_device *);
 297         } eh_ops;
 298 };
 299
 300 #define kthread_get_run(threadfn, data, namefmt, ...)                      \
 301 ({                                                                         \
 302         struct task_struct *__k                                            \
 303                 = kthread_create(threadfn, data, namefmt, ## __VA_ARGS__); \
 304         if (!IS_ERR(__k)) {                                                \
 305                 get_task_struct(__k);                                      \
 306                 wake_up_process(__k);                                      \
 307         }                                                                  \
 308         __k;                                                               \
 309 })
 310
 311 #define kthread_stop_put(k)             \
 312         do {                            \
 313                 kthread_stop(k);        \
 314                 put_task_struct(k);     \
 315         } while (0)
 316
 317 /* usbip_common.c */
 318 void usbip_dump_urb(struct urb *purb);
 319 void usbip_dump_header(struct usbip_header *pdu);
 320
 321 int usbip_recv(struct socket *sock, void *buf, int size);
 322
 323 void usbip_pack_pdu(struct usbip_header *pdu, struct urb *urb, int cmd,
 324                     int pack);
 325 void usbip_header_correct_endian(struct usbip_header *pdu, int send);
 326
 327 struct usbip_iso_packet_descriptor*
 328 usbip_alloc_iso_desc_pdu(struct urb *urb, ssize_t *bufflen);
 329
 330 /* some members of urb must be substituted before. */
 331 int usbip_recv_iso(struct usbip_device *ud, struct urb *urb);
 332 void usbip_pad_iso(struct usbip_device *ud, struct urb *urb);
 333 int usbip_recv_xbuff(struct usbip_device *ud, struct urb *urb);
 334
 335 /* usbip_event.c */
 336 int usbip_init_eh(void);
 337 void usbip_finish_eh(void);
 338 int usbip_start_eh(struct usbip_device *ud);
 339 void usbip_stop_eh(struct usbip_device *ud);
 340 void usbip_event_add(struct usbip_device *ud, unsigned long event);
 341 int usbip_event_happened(struct usbip_device *ud);
 342 int usbip_in_eh(struct task_struct *task);
 343
 344 static inline int interface_to_busnum(struct usb_interface *interface)
 345 {
 346         struct usb_device *udev = interface_to_usbdev(interface);
 347
 348         return udev->bus->busnum;
 349 }
 350
 351 static inline int interface_to_devnum(struct usb_interface *interface)
 352 {
 353         struct usb_device *udev = interface_to_usbdev(interface);
 354
 355         return udev->devnum;
 356 }
 357
 358 #endif /* __USBIP_COMMON_H */