1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2014 Leon Dang <ldang@nahannisys.com> 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 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. 15 * 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 26 * SUCH DAMAGE. 27 */ 28 29 #ifndef _USB_EMUL_H_ 30 #define _USB_EMUL_H_ 31 32 #include <sys/nv.h> 33 #include <stdlib.h> 34 #include <sys/linker_set.h> 35 #include <pthread.h> 36 37 #define USB_MAX_XFER_BLOCKS 8 38 39 #define USB_XFER_OUT 0 40 #define USB_XFER_IN 1 41 42 43 struct usb_hci; 44 struct usb_device_request; 45 struct usb_data_xfer; 46 struct vm_snapshot_meta; 47 48 /* Device emulation handlers */ 49 struct usb_devemu { 50 const char *ue_emu; /* name of device emulation */ 51 int ue_usbver; /* usb version: 2 or 3 */ 52 int ue_usbspeed; /* usb device speed */ 53 54 /* instance creation */ 55 void *(*ue_init)(struct usb_hci *hci, nvlist_t *nvl); 56 57 /* handlers */ 58 int (*ue_request)(void *sc, struct usb_data_xfer *xfer); 59 int (*ue_data)(void *sc, struct usb_data_xfer *xfer, int dir, 60 int epctx); 61 int (*ue_reset)(void *sc); 62 int (*ue_remove)(void *sc); 63 int (*ue_stop)(void *sc); 64 int (*ue_snapshot)(void *scarg, struct vm_snapshot_meta *meta); 65 }; 66 #define USB_EMUL_SET(x) DATA_SET(usb_emu_set, x) 67 68 /* 69 * USB device events to notify HCI when state changes 70 */ 71 enum hci_usbev { 72 USBDEV_ATTACH, 73 USBDEV_RESET, 74 USBDEV_STOP, 75 USBDEV_REMOVE, 76 }; 77 78 /* usb controller, ie xhci, ehci */ 79 struct usb_hci { 80 int (*hci_intr)(struct usb_hci *hci, int epctx); 81 int (*hci_event)(struct usb_hci *hci, enum hci_usbev evid, 82 void *param); 83 void *hci_sc; /* private softc for hci */ 84 85 /* controller managed fields */ 86 int hci_address; 87 int hci_port; 88 }; 89 90 /* 91 * Each xfer block is mapped to the hci transfer block. 92 * On input into the device handler, blen is set to the length of buf. 93 * The device handler is to update blen to reflect on the residual size 94 * of the buffer, i.e. len(buf) - len(consumed). 95 */ 96 struct usb_data_xfer_block { 97 void *buf; /* IN or OUT pointer */ 98 int blen; /* in:len(buf), out:len(remaining) */ 99 int bdone; /* bytes transferred */ 100 uint32_t processed; /* device processed this + errcode */ 101 void *hci_data; /* HCI private reference */ 102 int ccs; 103 uint32_t streamid; 104 uint64_t trbnext; /* next TRB guest address */ 105 }; 106 107 struct usb_data_xfer { 108 struct usb_data_xfer_block data[USB_MAX_XFER_BLOCKS]; 109 struct usb_device_request *ureq; /* setup ctl request */ 110 int ndata; /* # of data items */ 111 int head; 112 int tail; 113 pthread_mutex_t mtx; 114 }; 115 116 enum USB_ERRCODE { 117 USB_ACK, 118 USB_NAK, 119 USB_STALL, 120 USB_NYET, 121 USB_ERR, 122 USB_SHORT 123 }; 124 125 #define USB_DATA_GET_ERRCODE(x) (x)->processed >> 8 126 #define USB_DATA_SET_ERRCODE(x,e) do { \ 127 (x)->processed = ((x)->processed & 0xFF) | (e << 8); \ 128 } while (0) 129 130 #define USB_DATA_OK(x,i) ((x)->data[(i)].buf != NULL) 131 132 #define USB_DATA_XFER_INIT(x) do { \ 133 memset((x), 0, sizeof(*(x))); \ 134 pthread_mutex_init(&((x)->mtx), NULL); \ 135 } while (0) 136 137 #define USB_DATA_XFER_RESET(x) do { \ 138 memset((x)->data, 0, sizeof((x)->data)); \ 139 (x)->ndata = 0; \ 140 (x)->head = (x)->tail = 0; \ 141 } while (0) 142 143 #define USB_DATA_XFER_LOCK(x) do { \ 144 pthread_mutex_lock(&((x)->mtx)); \ 145 } while (0) 146 147 #define USB_DATA_XFER_UNLOCK(x) do { \ 148 pthread_mutex_unlock(&((x)->mtx)); \ 149 } while (0) 150 151 struct usb_devemu *usb_emu_finddev(const char *name); 152 153 struct usb_data_xfer_block *usb_data_xfer_append(struct usb_data_xfer *xfer, 154 void *buf, int blen, void *hci_data, int ccs); 155 156 157 #endif /* _USB_EMUL_H_ */ 158