2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2014 Leon Dang <ldang@nahannisys.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 #include <sys/linker_set.h>
39 #define USB_MAX_XFER_BLOCKS 8
41 #define USB_XFER_OUT 0
46 struct usb_device_request;
48 struct vm_snapshot_meta;
50 /* Device emulation handlers */
52 char *ue_emu; /* name of device emulation */
53 int ue_usbver; /* usb version: 2 or 3 */
54 int ue_usbspeed; /* usb device speed */
56 /* instance creation */
57 void *(*ue_init)(struct usb_hci *hci, nvlist_t *nvl);
60 int (*ue_request)(void *sc, struct usb_data_xfer *xfer);
61 int (*ue_data)(void *sc, struct usb_data_xfer *xfer, int dir,
63 int (*ue_reset)(void *sc);
64 int (*ue_remove)(void *sc);
65 int (*ue_stop)(void *sc);
66 int (*ue_snapshot)(void *scarg, struct vm_snapshot_meta *meta);
68 #define USB_EMUL_SET(x) DATA_SET(usb_emu_set, x);
71 * USB device events to notify HCI when state changes
80 /* usb controller, ie xhci, ehci */
82 int (*hci_intr)(struct usb_hci *hci, int epctx);
83 int (*hci_event)(struct usb_hci *hci, enum hci_usbev evid,
85 void *hci_sc; /* private softc for hci */
87 /* controller managed fields */
93 * Each xfer block is mapped to the hci transfer block.
94 * On input into the device handler, blen is set to the lenght of buf.
95 * The device handler is to update blen to reflect on the residual size
96 * of the buffer, i.e. len(buf) - len(consumed).
98 struct usb_data_xfer_block {
99 void *buf; /* IN or OUT pointer */
100 int blen; /* in:len(buf), out:len(remaining) */
101 int bdone; /* bytes transferred */
102 uint32_t processed; /* device processed this + errcode */
103 void *hci_data; /* HCI private reference */
106 uint64_t trbnext; /* next TRB guest address */
109 struct usb_data_xfer {
110 struct usb_data_xfer_block data[USB_MAX_XFER_BLOCKS];
111 struct usb_device_request *ureq; /* setup ctl request */
112 int ndata; /* # of data items */
127 #define USB_DATA_GET_ERRCODE(x) (x)->processed >> 8
128 #define USB_DATA_SET_ERRCODE(x,e) do { \
129 (x)->processed = ((x)->processed & 0xFF) | (e << 8); \
132 #define USB_DATA_OK(x,i) ((x)->data[(i)].buf != NULL)
134 #define USB_DATA_XFER_INIT(x) do { \
135 memset((x), 0, sizeof(*(x))); \
136 pthread_mutex_init(&((x)->mtx), NULL); \
139 #define USB_DATA_XFER_RESET(x) do { \
140 memset((x)->data, 0, sizeof((x)->data)); \
142 (x)->head = (x)->tail = 0; \
145 #define USB_DATA_XFER_LOCK(x) do { \
146 pthread_mutex_lock(&((x)->mtx)); \
149 #define USB_DATA_XFER_UNLOCK(x) do { \
150 pthread_mutex_unlock(&((x)->mtx)); \
153 struct usb_devemu *usb_emu_finddev(const char *name);
155 struct usb_data_xfer_block *usb_data_xfer_append(struct usb_data_xfer *xfer,
156 void *buf, int blen, void *hci_data, int ccs);
159 #endif /* _USB_EMUL_H_ */