1 /* $FreeBSD: head/sys/dev/usb/usb_bus.h 276717 2015-01-05 20:22:18Z hselasky $ */ 2 /*- 3 * Copyright (c) 2008 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 the USB statistics structure. 44 */ 45 struct usb_bus_stat { 46 uint32_t uds_requests[4]; 47 }; 48 49 /* 50 * The following structure defines an USB BUS. There is one USB BUS 51 * for every Host or Device controller. 52 */ 53 struct usb_bus { 54 struct usb_bus_stat stats_err; 55 struct usb_bus_stat stats_ok; 56 #if USB_HAVE_ROOT_MOUNT_HOLD 57 struct root_hold_token *bus_roothold; 58 #endif 59 60 #if USB_HAVE_PER_BUS_PROCESS 61 #define USB_BUS_GIANT_PROC(bus) (&(bus)->giant_callback_proc) 62 #define USB_BUS_NON_GIANT_PROC(bus) (&(bus)->non_giant_callback_proc) 63 #define USB_BUS_EXPLORE_PROC(bus) (&(bus)->explore_proc) 64 #define USB_BUS_CONTROL_XFER_PROC(bus) (&(bus)->control_xfer_proc) 65 66 /* 67 * There are two callback processes. One for Giant locked 68 * callbacks. One for non-Giant locked callbacks. This should 69 * avoid congestion and reduce response time in most cases. 70 */ 71 struct usb_process giant_callback_proc; 72 struct usb_process non_giant_callback_proc; 73 74 /* Explore process */ 75 struct usb_process explore_proc; 76 77 /* Control request process */ 78 struct usb_process control_xfer_proc; 79 #endif 80 81 struct usb_bus_msg explore_msg[2]; 82 struct usb_bus_msg detach_msg[2]; 83 struct usb_bus_msg attach_msg[2]; 84 struct usb_bus_msg suspend_msg[2]; 85 struct usb_bus_msg resume_msg[2]; 86 struct usb_bus_msg reset_msg[2]; 87 struct usb_bus_msg shutdown_msg[2]; 88 #if USB_HAVE_UGEN 89 struct usb_bus_msg cleanup_msg[2]; 90 LIST_HEAD(,usb_fs_privdata) pd_cleanup_list; 91 #endif 92 /* 93 * This mutex protects the USB hardware: 94 */ 95 struct lock bus_lock; 96 /* 97 * mpf: this is only used in ARM embedded USB controllers 98 * up to this point. Why is it not a spinlock? 99 struct lock bus_spin_lock; 100 */ 101 struct usb_xfer_queue intr_q; 102 struct usb_callout power_wdog; /* power management */ 103 104 device_t parent; 105 device_t bdev; /* filled by HC driver */ 106 107 #if USB_HAVE_BUSDMA 108 struct usb_dma_parent_tag dma_parent_tag[1]; 109 struct usb_dma_tag dma_tags[USB_BUS_DMA_TAG_MAX]; 110 #endif 111 const struct usb_bus_methods *methods; /* filled by HC driver */ 112 struct usb_device **devices; 113 114 struct ifnet *ifp; /* only for USB Packet Filter */ 115 116 usb_power_mask_t hw_power_state; /* see USB_HW_POWER_XXX */ 117 usb_size_t uframe_usage[USB_HS_MICRO_FRAMES_MAX]; 118 119 uint16_t isoc_time_last; /* in milliseconds */ 120 121 uint8_t alloc_failed; /* Set if memory allocation failed. */ 122 uint8_t driver_added_refcount; /* Current driver generation count */ 123 enum usb_revision usbrev; /* USB revision. See "USB_REV_XXX". */ 124 125 uint8_t devices_max; /* maximum number of USB devices */ 126 uint8_t do_hook; /* intr_config_hook */ 127 uint8_t do_probe; /* set if USB should be re-probed */ 128 uint8_t no_explore; /* don't explore USB ports */ 129 uint8_t dma_bits; /* number of DMA address bits */ 130 struct intr_config_hook hook; 131 }; 132 133 #endif /* _USB_BUS_H_ */ 134