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