usb_bus.h revision 278278 
1/* $FreeBSD: stable/10/sys/dev/usb/usb_bus.h 278278 2015-02-05 20:03:02Z 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/*
31 * The following structure defines the USB explore message sent to the USB
32 * explore process.
33 */
34
35struct usb_bus_msg {
36	struct usb_proc_msg hdr;
37	struct usb_bus *bus;
38};
39
40/*
41 * The following structure defines the USB statistics structure.
42 */
43struct usb_bus_stat {
44	uint32_t uds_requests[4];
45};
46
47/*
48 * The following structure defines an USB BUS. There is one USB BUS
49 * for every Host or Device controller.
50 */
51struct usb_bus {
52	struct usb_bus_stat stats_err;
53	struct usb_bus_stat stats_ok;
54#if USB_HAVE_ROOT_MOUNT_HOLD
55	struct root_hold_token *bus_roothold;
56#endif
57
58#if USB_HAVE_PER_BUS_PROCESS
59#define	USB_BUS_GIANT_PROC(bus) (&(bus)->giant_callback_proc)
60#define	USB_BUS_NON_GIANT_PROC(bus) (&(bus)->non_giant_callback_proc)
61#define	USB_BUS_EXPLORE_PROC(bus) (&(bus)->explore_proc)
62#define	USB_BUS_CONTROL_XFER_PROC(bus) (&(bus)->control_xfer_proc)
63
64	/*
65	 * There are two callback processes. One for Giant locked
66	 * callbacks. One for non-Giant locked callbacks. This should
67	 * avoid congestion and reduce response time in most cases.
68	 */
69	struct usb_process giant_callback_proc;
70	struct usb_process non_giant_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	/*
87	 * This mutex protects the USB hardware:
88	 */
89	struct mtx bus_mtx;
90	struct mtx bus_spin_lock;
91	struct usb_xfer_queue intr_q;
92	struct usb_callout power_wdog;	/* power management */
93
94	device_t parent;
95	device_t bdev;			/* filled by HC driver */
96
97#if USB_HAVE_BUSDMA
98	struct usb_dma_parent_tag dma_parent_tag[1];
99	struct usb_dma_tag dma_tags[USB_BUS_DMA_TAG_MAX];
100#endif
101	struct usb_bus_methods *methods;	/* filled by HC driver */
102	struct usb_device **devices;
103
104	struct ifnet *ifp;	/* only for USB Packet Filter */
105
106	usb_power_mask_t hw_power_state;	/* see USB_HW_POWER_XXX */
107	usb_size_t uframe_usage[USB_HS_MICRO_FRAMES_MAX];
108
109	uint16_t isoc_time_last;	/* in milliseconds */
110
111	uint8_t	alloc_failed;		/* Set if memory allocation failed. */
112	uint8_t	driver_added_refcount;	/* Current driver generation count */
113	enum usb_revision usbrev;	/* USB revision. See "USB_REV_XXX". */
114
115	uint8_t	devices_max;		/* maximum number of USB devices */
116	uint8_t	do_probe;		/* set if USB should be re-probed */
117	uint8_t no_explore;		/* don't explore USB ports */
118	uint8_t dma_bits;		/* number of DMA address lines */
119};
120
121#endif					/* _USB_BUS_H_ */
122