blob: 86b08475c25427bd018d74ffd90514334a2e42a3 [file] [log] [blame]
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -06001/*
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
matt mooney7aaacb42011-05-11 22:33:43 -070020#ifndef __USBIP_COMMON_H
21#define __USBIP_COMMON_H
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -060022
matt mooney4980d962011-05-06 03:47:45 -070023#include <linux/compiler.h>
matt mooney7aaacb42011-05-11 22:33:43 -070024#include <linux/device.h>
25#include <linux/interrupt.h>
26#include <linux/net.h>
27#include <linux/printk.h>
28#include <linux/spinlock.h>
29#include <linux/types.h>
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -060030#include <linux/usb.h>
matt mooney7aaacb42011-05-11 22:33:43 -070031#include <linux/wait.h>
Valentina Manea96c27372014-08-20 07:31:00 +030032#include <uapi/linux/usbip.h>
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -060033
matt mooney6973c6f2011-05-11 01:54:14 -070034#define USBIP_VERSION "1.0.0"
35
matt mooney1a4b6f62011-05-19 16:47:32 -070036#undef pr_fmt
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -060037
matt mooney1a4b6f62011-05-19 16:47:32 -070038#ifdef DEBUG
39#define pr_fmt(fmt) KBUILD_MODNAME ": %s:%d: " fmt, __func__, __LINE__
matt mooney981f30c2011-05-11 01:54:13 -070040#else
matt mooney1a4b6f62011-05-19 16:47:32 -070041#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
42#endif
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -060043
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -060044enum {
45 usbip_debug_xmit = (1 << 0),
46 usbip_debug_sysfs = (1 << 1),
47 usbip_debug_urb = (1 << 2),
48 usbip_debug_eh = (1 << 3),
49
50 usbip_debug_stub_cmp = (1 << 8),
51 usbip_debug_stub_dev = (1 << 9),
52 usbip_debug_stub_rx = (1 << 10),
53 usbip_debug_stub_tx = (1 << 11),
54
55 usbip_debug_vhci_rh = (1 << 8),
56 usbip_debug_vhci_hc = (1 << 9),
57 usbip_debug_vhci_rx = (1 << 10),
58 usbip_debug_vhci_tx = (1 << 11),
59 usbip_debug_vhci_sysfs = (1 << 12)
60};
61
Brian G. Merrellb8868e42009-07-21 00:46:13 -060062#define usbip_dbg_flag_xmit (usbip_debug_flag & usbip_debug_xmit)
63#define usbip_dbg_flag_vhci_rh (usbip_debug_flag & usbip_debug_vhci_rh)
64#define usbip_dbg_flag_vhci_hc (usbip_debug_flag & usbip_debug_vhci_hc)
65#define usbip_dbg_flag_vhci_rx (usbip_debug_flag & usbip_debug_vhci_rx)
66#define usbip_dbg_flag_vhci_tx (usbip_debug_flag & usbip_debug_vhci_tx)
67#define usbip_dbg_flag_stub_rx (usbip_debug_flag & usbip_debug_stub_rx)
68#define usbip_dbg_flag_stub_tx (usbip_debug_flag & usbip_debug_stub_tx)
matt mooney87352762011-05-19 21:36:56 -070069#define usbip_dbg_flag_vhci_sysfs (usbip_debug_flag & usbip_debug_vhci_sysfs)
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -060070
71extern unsigned long usbip_debug_flag;
72extern struct device_attribute dev_attr_usbip_debug;
73
Brian G. Merrellb8868e42009-07-21 00:46:13 -060074#define usbip_dbg_with_flag(flag, fmt, args...) \
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -060075 do { \
76 if (flag & usbip_debug_flag) \
matt mooney1a4b6f62011-05-19 16:47:32 -070077 pr_debug(fmt, ##args); \
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -060078 } while (0)
79
matt mooney4980d962011-05-06 03:47:45 -070080#define usbip_dbg_sysfs(fmt, args...) \
Brian G. Merrellb8868e42009-07-21 00:46:13 -060081 usbip_dbg_with_flag(usbip_debug_sysfs, fmt , ##args)
matt mooney4980d962011-05-06 03:47:45 -070082#define usbip_dbg_xmit(fmt, args...) \
Brian G. Merrellb8868e42009-07-21 00:46:13 -060083 usbip_dbg_with_flag(usbip_debug_xmit, fmt , ##args)
matt mooney4980d962011-05-06 03:47:45 -070084#define usbip_dbg_urb(fmt, args...) \
Brian G. Merrellb8868e42009-07-21 00:46:13 -060085 usbip_dbg_with_flag(usbip_debug_urb, fmt , ##args)
matt mooney4980d962011-05-06 03:47:45 -070086#define usbip_dbg_eh(fmt, args...) \
Brian G. Merrellb8868e42009-07-21 00:46:13 -060087 usbip_dbg_with_flag(usbip_debug_eh, fmt , ##args)
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -060088
Brian G. Merrellb8868e42009-07-21 00:46:13 -060089#define usbip_dbg_vhci_rh(fmt, args...) \
90 usbip_dbg_with_flag(usbip_debug_vhci_rh, fmt , ##args)
91#define usbip_dbg_vhci_hc(fmt, args...) \
92 usbip_dbg_with_flag(usbip_debug_vhci_hc, fmt , ##args)
93#define usbip_dbg_vhci_rx(fmt, args...) \
94 usbip_dbg_with_flag(usbip_debug_vhci_rx, fmt , ##args)
95#define usbip_dbg_vhci_tx(fmt, args...) \
96 usbip_dbg_with_flag(usbip_debug_vhci_tx, fmt , ##args)
matt mooney4980d962011-05-06 03:47:45 -070097#define usbip_dbg_vhci_sysfs(fmt, args...) \
Brian G. Merrellb8868e42009-07-21 00:46:13 -060098 usbip_dbg_with_flag(usbip_debug_vhci_sysfs, fmt , ##args)
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -060099
matt mooney4980d962011-05-06 03:47:45 -0700100#define usbip_dbg_stub_cmp(fmt, args...) \
Brian G. Merrellb8868e42009-07-21 00:46:13 -0600101 usbip_dbg_with_flag(usbip_debug_stub_cmp, fmt , ##args)
matt mooney4980d962011-05-06 03:47:45 -0700102#define usbip_dbg_stub_rx(fmt, args...) \
Brian G. Merrellb8868e42009-07-21 00:46:13 -0600103 usbip_dbg_with_flag(usbip_debug_stub_rx, fmt , ##args)
matt mooney4980d962011-05-06 03:47:45 -0700104#define usbip_dbg_stub_tx(fmt, args...) \
Brian G. Merrellb8868e42009-07-21 00:46:13 -0600105 usbip_dbg_with_flag(usbip_debug_stub_tx, fmt , ##args)
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600106
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600107/*
matt mooneyb7d27ea2011-05-19 21:37:02 -0700108 * USB/IP request headers
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600109 *
matt mooneyb7d27ea2011-05-19 21:37:02 -0700110 * Each request is transferred across the network to its counterpart, which
111 * facilitates the normal USB communication. The values contained in the headers
112 * are basically the same as in a URB. Currently, four request types are
113 * defined:
114 *
115 * - USBIP_CMD_SUBMIT: a USB request block, corresponds to usb_submit_urb()
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600116 * (client to server)
matt mooneyb7d27ea2011-05-19 21:37:02 -0700117 *
118 * - USBIP_RET_SUBMIT: the result of USBIP_CMD_SUBMIT
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600119 * (server to client)
120 *
matt mooneyb7d27ea2011-05-19 21:37:02 -0700121 * - USBIP_CMD_UNLINK: an unlink request of a pending USBIP_CMD_SUBMIT,
122 * corresponds to usb_unlink_urb()
123 * (client to server)
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600124 *
matt mooneyb7d27ea2011-05-19 21:37:02 -0700125 * - USBIP_RET_UNLINK: the result of USBIP_CMD_UNLINK
126 * (server to client)
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600127 *
128 */
matt mooneyb7d27ea2011-05-19 21:37:02 -0700129#define USBIP_CMD_SUBMIT 0x0001
Alexander Thomas7518b9b2011-09-19 16:56:51 +0200130#define USBIP_CMD_UNLINK 0x0002
131#define USBIP_RET_SUBMIT 0x0003
matt mooneyb7d27ea2011-05-19 21:37:02 -0700132#define USBIP_RET_UNLINK 0x0004
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600133
Alexander Thomas7518b9b2011-09-19 16:56:51 +0200134#define USBIP_DIR_OUT 0x00
135#define USBIP_DIR_IN 0x01
matt mooneyb7d27ea2011-05-19 21:37:02 -0700136
137/**
138 * struct usbip_header_basic - data pertinent to every request
139 * @command: the usbip request type
140 * @seqnum: sequential number that identifies requests; incremented per
141 * connection
142 * @devid: specifies a remote USB device uniquely instead of busnum and devnum;
143 * in the stub driver, this value is ((busnum << 16) | devnum)
144 * @direction: direction of the transfer
145 * @ep: endpoint number
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600146 */
147struct usbip_header_basic {
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600148 __u32 command;
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600149 __u32 seqnum;
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600150 __u32 devid;
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600151 __u32 direction;
matt mooneyb7d27ea2011-05-19 21:37:02 -0700152 __u32 ep;
matt mooney4980d962011-05-06 03:47:45 -0700153} __packed;
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600154
matt mooneyb7d27ea2011-05-19 21:37:02 -0700155/**
156 * struct usbip_header_cmd_submit - USBIP_CMD_SUBMIT packet header
157 * @transfer_flags: URB flags
158 * @transfer_buffer_length: the data size for (in) or (out) transfer
159 * @start_frame: initial frame for isochronous or interrupt transfers
160 * @number_of_packets: number of isochronous packets
161 * @interval: maximum time for the request on the server-side host controller
162 * @setup: setup data for a control request
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600163 */
164struct usbip_header_cmd_submit {
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600165 __u32 transfer_flags;
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600166 __s32 transfer_buffer_length;
167
168 /* it is difficult for usbip to sync frames (reserved only?) */
169 __s32 start_frame;
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600170 __s32 number_of_packets;
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600171 __s32 interval;
172
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600173 unsigned char setup[8];
matt mooney4980d962011-05-06 03:47:45 -0700174} __packed;
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600175
matt mooneyb7d27ea2011-05-19 21:37:02 -0700176/**
177 * struct usbip_header_ret_submit - USBIP_RET_SUBMIT packet header
178 * @status: return status of a non-iso request
179 * @actual_length: number of bytes transferred
180 * @start_frame: initial frame for isochronous or interrupt transfers
181 * @number_of_packets: number of isochronous packets
182 * @error_count: number of errors for isochronous transfers
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600183 */
184struct usbip_header_ret_submit {
185 __s32 status;
matt mooneyb7d27ea2011-05-19 21:37:02 -0700186 __s32 actual_length;
187 __s32 start_frame;
188 __s32 number_of_packets;
189 __s32 error_count;
matt mooney4980d962011-05-06 03:47:45 -0700190} __packed;
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600191
matt mooneyb7d27ea2011-05-19 21:37:02 -0700192/**
193 * struct usbip_header_cmd_unlink - USBIP_CMD_UNLINK packet header
194 * @seqnum: the URB seqnum to unlink
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600195 */
196struct usbip_header_cmd_unlink {
matt mooneyb7d27ea2011-05-19 21:37:02 -0700197 __u32 seqnum;
matt mooney4980d962011-05-06 03:47:45 -0700198} __packed;
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600199
matt mooneyb7d27ea2011-05-19 21:37:02 -0700200/**
201 * struct usbip_header_ret_unlink - USBIP_RET_UNLINK packet header
202 * @status: return status of the request
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600203 */
204struct usbip_header_ret_unlink {
205 __s32 status;
matt mooney4980d962011-05-06 03:47:45 -0700206} __packed;
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600207
matt mooneyb7d27ea2011-05-19 21:37:02 -0700208/**
209 * struct usbip_header - common header for all usbip packets
210 * @base: the basic header
211 * @u: packet type dependent header
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600212 */
213struct usbip_header {
214 struct usbip_header_basic base;
215
216 union {
217 struct usbip_header_cmd_submit cmd_submit;
218 struct usbip_header_ret_submit ret_submit;
219 struct usbip_header_cmd_unlink cmd_unlink;
220 struct usbip_header_ret_unlink ret_unlink;
221 } u;
matt mooney4980d962011-05-06 03:47:45 -0700222} __packed;
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600223
matt mooneyb7d27ea2011-05-19 21:37:02 -0700224/*
225 * This is the same as usb_iso_packet_descriptor but packed for pdu.
226 */
227struct usbip_iso_packet_descriptor {
228 __u32 offset;
229 __u32 length; /* expected length */
230 __u32 actual_length;
231 __u32 status;
232} __packed;
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600233
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600234enum usbip_side {
235 USBIP_VHCI,
236 USBIP_STUB,
237};
238
matt mooneyb7d27ea2011-05-19 21:37:02 -0700239/* event handler */
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600240#define USBIP_EH_SHUTDOWN (1 << 0)
241#define USBIP_EH_BYE (1 << 1)
242#define USBIP_EH_RESET (1 << 2)
243#define USBIP_EH_UNUSABLE (1 << 3)
244
Brian G. Merrellb8868e42009-07-21 00:46:13 -0600245#define SDEV_EVENT_REMOVED (USBIP_EH_SHUTDOWN | USBIP_EH_RESET | USBIP_EH_BYE)
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600246#define SDEV_EVENT_DOWN (USBIP_EH_SHUTDOWN | USBIP_EH_RESET)
247#define SDEV_EVENT_ERROR_TCP (USBIP_EH_SHUTDOWN | USBIP_EH_RESET)
248#define SDEV_EVENT_ERROR_SUBMIT (USBIP_EH_SHUTDOWN | USBIP_EH_RESET)
249#define SDEV_EVENT_ERROR_MALLOC (USBIP_EH_SHUTDOWN | USBIP_EH_UNUSABLE)
250
251#define VDEV_EVENT_REMOVED (USBIP_EH_SHUTDOWN | USBIP_EH_BYE)
252#define VDEV_EVENT_DOWN (USBIP_EH_SHUTDOWN | USBIP_EH_RESET)
253#define VDEV_EVENT_ERROR_TCP (USBIP_EH_SHUTDOWN | USBIP_EH_RESET)
254#define VDEV_EVENT_ERROR_MALLOC (USBIP_EH_SHUTDOWN | USBIP_EH_UNUSABLE)
255
matt mooneyb7d27ea2011-05-19 21:37:02 -0700256/* a common structure for stub_device and vhci_device */
257struct usbip_device {
258 enum usbip_side side;
Shuah Khancd84ec92014-03-03 16:38:44 -0700259 enum usbip_device_status status;
matt mooneyb7d27ea2011-05-19 21:37:02 -0700260
261 /* lock for status */
262 spinlock_t lock;
263
264 struct socket *tcp_socket;
265
266 struct task_struct *tcp_rx;
267 struct task_struct *tcp_tx;
268
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600269 unsigned long event;
Arnd Bergmann9720b4b2011-03-02 00:13:05 +0100270 struct task_struct *eh;
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600271 wait_queue_head_t eh_waitq;
272
273 struct eh_ops {
274 void (*shutdown)(struct usbip_device *);
275 void (*reset)(struct usbip_device *);
276 void (*unusable)(struct usbip_device *);
277 } eh_ops;
278};
279
Oleg Nesterovba46ce32012-03-13 19:07:18 +0100280#define kthread_get_run(threadfn, data, namefmt, ...) \
281({ \
282 struct task_struct *__k \
283 = kthread_create(threadfn, data, namefmt, ## __VA_ARGS__); \
284 if (!IS_ERR(__k)) { \
285 get_task_struct(__k); \
286 wake_up_process(__k); \
287 } \
288 __k; \
289})
290
291#define kthread_stop_put(k) \
292 do { \
293 kthread_stop(k); \
294 put_task_struct(k); \
295 } while (0)
296
matt mooneyb7d27ea2011-05-19 21:37:02 -0700297/* usbip_common.c */
298void usbip_dump_urb(struct urb *purb);
299void usbip_dump_header(struct usbip_header *pdu);
300
Bart Westgeest5a08c522011-12-19 17:44:11 -0500301int usbip_recv(struct socket *sock, void *buf, int size);
matt mooneyb7d27ea2011-05-19 21:37:02 -0700302
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600303void usbip_pack_pdu(struct usbip_header *pdu, struct urb *urb, int cmd,
matt mooney4980d962011-05-06 03:47:45 -0700304 int pack);
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600305void usbip_header_correct_endian(struct usbip_header *pdu, int send);
matt mooneyb7d27ea2011-05-19 21:37:02 -0700306
Bart Westgeest36ac9b02012-10-10 13:34:25 -0400307struct usbip_iso_packet_descriptor*
308usbip_alloc_iso_desc_pdu(struct urb *urb, ssize_t *bufflen);
309
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600310/* some members of urb must be substituted before. */
311int usbip_recv_iso(struct usbip_device *ud, struct urb *urb);
Bart Westgeestac2b41a2012-01-23 10:55:46 -0500312void usbip_pad_iso(struct usbip_device *ud, struct urb *urb);
matt mooneyb7d27ea2011-05-19 21:37:02 -0700313int usbip_recv_xbuff(struct usbip_device *ud, struct urb *urb);
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600314
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600315/* usbip_event.c */
Brian G. Merrellb8868e42009-07-21 00:46:13 -0600316int usbip_start_eh(struct usbip_device *ud);
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600317void usbip_stop_eh(struct usbip_device *ud);
318void usbip_event_add(struct usbip_device *ud, unsigned long event);
Brian G. Merrellb8868e42009-07-21 00:46:13 -0600319int usbip_event_happened(struct usbip_device *ud);
Takahiro Hirofuchi05a1f282008-07-09 14:56:51 -0600320
matt mooneyb7d27ea2011-05-19 21:37:02 -0700321static inline int interface_to_busnum(struct usb_interface *interface)
322{
323 struct usb_device *udev = interface_to_usbdev(interface);
Pawel Lebioda3eed8c02014-05-14 19:20:27 +0200324
matt mooneyb7d27ea2011-05-19 21:37:02 -0700325 return udev->bus->busnum;
326}
327
328static inline int interface_to_devnum(struct usb_interface *interface)
329{
330 struct usb_device *udev = interface_to_usbdev(interface);
Pawel Lebioda3eed8c02014-05-14 19:20:27 +0200331
matt mooneyb7d27ea2011-05-19 21:37:02 -0700332 return udev->devnum;
333}
334
matt mooney7aaacb42011-05-11 22:33:43 -0700335#endif /* __USBIP_COMMON_H */