1 /* $FreeBSD$ */ 2 /*- 3 * Copyright (c) 2008-2019 Hans Petter Selasky. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 */ 26 27 #ifndef _USB_BUS_H_ 28 #define _USB_BUS_H_ 29 30 struct usb_fs_privdata; 31 32 /* 33 * The following structure defines the USB explore message sent to the USB 34 * explore process. 35 */ 36 37 struct usb_bus_msg { 38 struct usb_proc_msg hdr; 39 struct usb_bus *bus; 40 }; 41 42 /* 43 * The following structure defines an USB BUS. There is one USB BUS 44 * for every Host or Device controller. 45 */ 46 struct usb_bus { 47 #if USB_HAVE_ROOT_MOUNT_HOLD 48 struct root_hold_token *bus_roothold; 49 #endif 50 51 /* convenience macros */ 52 #define USB_BUS_TT_PROC(bus) USB_BUS_NON_GIANT_ISOC_PROC(bus) 53 #define USB_BUS_CS_PROC(bus) USB_BUS_NON_GIANT_ISOC_PROC(bus) 54 55 #if USB_HAVE_PER_BUS_PROCESS 56 #define USB_BUS_GIANT_PROC(bus) (&(bus)->giant_callback_proc) 57 #define USB_BUS_NON_GIANT_ISOC_PROC(bus) (&(bus)->non_giant_isoc_callback_proc) 58 #define USB_BUS_NON_GIANT_BULK_PROC(bus) (&(bus)->non_giant_bulk_callback_proc) 59 #define USB_BUS_EXPLORE_PROC(bus) (&(bus)->explore_proc) 60 #define USB_BUS_CONTROL_XFER_PROC(bus) (&(bus)->control_xfer_proc) 61 /* 62 * There are three callback processes. One for Giant locked 63 * callbacks. One for non-Giant locked non-periodic callbacks 64 * and one for non-Giant locked periodic callbacks. This 65 * should avoid congestion and reduce response time in most 66 * cases. 67 */ 68 struct usb_process giant_callback_proc; 69 struct usb_process non_giant_isoc_callback_proc; 70 struct usb_process non_giant_bulk_callback_proc; 71 72 /* Explore process */ 73 struct usb_process explore_proc; 74 75 /* Control request process */ 76 struct usb_process control_xfer_proc; 77 #endif 78 79 struct usb_bus_msg explore_msg[2]; 80 struct usb_bus_msg detach_msg[2]; 81 struct usb_bus_msg attach_msg[2]; 82 struct usb_bus_msg suspend_msg[2]; 83 struct usb_bus_msg resume_msg[2]; 84 struct usb_bus_msg reset_msg[2]; 85 struct usb_bus_msg shutdown_msg[2]; 86 #if USB_HAVE_UGEN 87 struct usb_bus_msg cleanup_msg[2]; 88 LIST_HEAD(,usb_fs_privdata) pd_cleanup_list; 89 #endif 90 /* 91 * This mutex protects the USB hardware: 92 */ 93 struct mtx bus_mtx; 94 struct mtx bus_spin_lock; 95 struct usb_xfer_queue intr_q; 96 struct usb_callout power_wdog; /* power management */ 97 98 device_t parent; 99 device_t bdev; /* filled by HC driver */ 100 101 #if USB_HAVE_BUSDMA 102 struct usb_dma_parent_tag dma_parent_tag[1]; 103 struct usb_dma_tag dma_tags[USB_BUS_DMA_TAG_MAX]; 104 #endif 105 const struct usb_bus_methods *methods; /* filled by HC driver */ 106 struct usb_device **devices; 107 108 struct ifnet *ifp; /* only for USB Packet Filter */ 109 110 usb_power_mask_t hw_power_state; /* see USB_HW_POWER_XXX */ 111 usb_size_t uframe_usage[USB_HS_MICRO_FRAMES_MAX]; 112 113 uint16_t isoc_time_last; /* in milliseconds */ 114 115 uint8_t alloc_failed; /* Set if memory allocation failed. */ 116 uint8_t driver_added_refcount; /* Current driver generation count */ 117 enum usb_revision usbrev; /* USB revision. See "USB_REV_XXX". */ 118 119 uint8_t devices_max; /* maximum number of USB devices */ 120 uint8_t do_probe; /* set if USB should be re-probed */ 121 uint8_t no_explore; /* don't explore USB ports */ 122 uint8_t dma_bits; /* number of DMA address lines */ 123 uint8_t control_ep_quirk; /* need 64kByte buffer for data stage */ 124 }; 125 126 #endif /* _USB_BUS_H_ */ 127