xref: /illumos-gate/usr/src/cmd/bhyve/usb_emul.h (revision 32640292)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2014 Leon Dang <ldang@nahannisys.com>
5  * Copyright 2018 Joyent, Inc.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 #ifndef _USB_EMUL_H_
31 #define _USB_EMUL_H_
32 
33 #include <sys/nv.h>
34 #include <stdlib.h>
35 #include <sys/linker_set.h>
36 #include <pthread.h>
37 #ifndef __FreeBSD__
38 #include <synch.h>
39 #endif
40 
41 #define	USB_MAX_XFER_BLOCKS	8
42 
43 #define	USB_XFER_OUT		0
44 #define	USB_XFER_IN		1
45 
46 
47 
48 struct usb_hci;
49 struct usb_device_request;
50 struct usb_data_xfer;
51 
52 /* Device emulation handlers */
53 struct usb_devemu {
54 	const char *ue_emu;	/* name of device emulation */
55 	int	ue_usbver;	/* usb version: 2 or 3 */
56 	int	ue_usbspeed;	/* usb device speed */
57 
58 	/* instance creation */
59 	void	*(*ue_init)(struct usb_hci *hci, nvlist_t *nvl);
60 
61 	/* handlers */
62 	int	(*ue_request)(void *sc, struct usb_data_xfer *xfer);
63 	int	(*ue_data)(void *sc, struct usb_data_xfer *xfer, int dir,
64 	                   int epctx);
65 	int	(*ue_reset)(void *sc);
66 	int	(*ue_remove)(void *sc);
67 	int	(*ue_stop)(void *sc);
68 };
69 #define	USB_EMUL_SET(x)		DATA_SET(usb_emu_set, x)
70 
71 /*
72  * USB device events to notify HCI when state changes
73  */
74 enum hci_usbev {
75 	USBDEV_ATTACH,
76 	USBDEV_RESET,
77 	USBDEV_STOP,
78 	USBDEV_REMOVE,
79 };
80 
81 /* usb controller, ie xhci, ehci */
82 struct usb_hci {
83 	int	(*hci_intr)(struct usb_hci *hci, int epctx);
84 	int	(*hci_event)(struct usb_hci *hci, enum hci_usbev evid,
85 		             void *param);
86 	void	*hci_sc;			/* private softc for hci */
87 
88 	/* controller managed fields */
89 	int	hci_address;
90 	int	hci_port;
91 };
92 
93 /*
94  * Each xfer block is mapped to the hci transfer block.
95  * On input into the device handler, blen is set to the length of buf.
96  * The device handler is to update blen to reflect on the residual size
97  * of the buffer, i.e. len(buf) - len(consumed).
98  */
99 struct usb_data_xfer_block {
100 	void	*buf;			/* IN or OUT pointer */
101 	int	blen;			/* in:len(buf), out:len(remaining) */
102 	int	bdone;			/* bytes transferred */
103 	uint32_t processed;		/* device processed this + errcode */
104 	void	*hci_data;		/* HCI private reference */
105 	int	ccs;
106 	uint32_t streamid;
107 	uint64_t trbnext;		/* next TRB guest address */
108 };
109 
110 struct usb_data_xfer {
111 	struct usb_data_xfer_block data[USB_MAX_XFER_BLOCKS];
112 	struct usb_device_request *ureq; 	/* setup ctl request */
113 	int	ndata;				/* # of data items */
114 	int	head;
115 	int	tail;
116 	pthread_mutex_t mtx;
117 };
118 
119 enum USB_ERRCODE {
120 	USB_ACK,
121 	USB_NAK,
122 	USB_STALL,
123 	USB_NYET,
124 	USB_ERR,
125 	USB_SHORT
126 };
127 
128 #define	USB_DATA_GET_ERRCODE(x)		(x)->processed >> 8
129 #define	USB_DATA_SET_ERRCODE(x,e)	do {				\
130 			(x)->processed = ((x)->processed & 0xFF) | (e << 8); \
131 		} while (0)
132 
133 #define	USB_DATA_OK(x,i)	((x)->data[(i)].buf != NULL)
134 
135 #define	USB_DATA_XFER_INIT(x)	do {					\
136 			memset((x), 0, sizeof(*(x)));			\
137 			pthread_mutex_init(&((x)->mtx), NULL);		\
138 		} while (0)
139 
140 #define	USB_DATA_XFER_RESET(x)	do {					\
141 			memset((x)->data, 0, sizeof((x)->data));	\
142 			(x)->ndata = 0;					\
143 			(x)->head = (x)->tail = 0;			\
144 		} while (0)
145 
146 #define	USB_DATA_XFER_LOCK(x)	do {					\
147 			pthread_mutex_lock(&((x)->mtx));		\
148 		} while (0)
149 
150 #define	USB_DATA_XFER_UNLOCK(x)	do {					\
151 			pthread_mutex_unlock(&((x)->mtx));		\
152 		} while (0)
153 #ifndef __FreeBSD__
154 #define	USB_DATA_XFER_LOCK_HELD(x) MUTEX_HELD(&((x)->mtx))
155 #endif
156 
157 struct usb_devemu *usb_emu_finddev(const char *name);
158 
159 struct usb_data_xfer_block *usb_data_xfer_append(struct usb_data_xfer *xfer,
160                           void *buf, int blen, void *hci_data, int ccs);
161 
162 
163 #endif /* _USB_EMUL_H_ */
164