xref: /freebsd/sys/dev/usb/usb_freebsd_loader.h (revision 6574b8ed19b093f0af09501d2c9676c28993cb97)
1 /* $FreeBSD$ */
2 /*-
3  * Copyright (c) 2013 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 /*
28  * Including this file is mandatory for all USB related c-files in the loader.
29  */
30 
31 #ifndef _USB_FREEBSD_LOADER_H_
32 #define	_USB_FREEBSD_LOADER_H_
33 
34 /* Default USB configuration */
35 #define	USB_HAVE_UGEN 0
36 #define	USB_HAVE_DEVCTL 0
37 #define	USB_HAVE_BUSDMA 1
38 #define	USB_HAVE_COMPAT_LINUX 0
39 #define	USB_HAVE_USER_IO 0
40 #define	USB_HAVE_MBUF 0
41 #define	USB_HAVE_TT_SUPPORT 1
42 #define	USB_HAVE_POWERD 1
43 #define	USB_HAVE_MSCTEST 1
44 #define	USB_HAVE_MSCTEST_DETACH 0
45 #define	USB_HAVE_PF 0
46 #define	USB_HAVE_ROOT_MOUNT_HOLD 0
47 #define	USB_HAVE_ID_SECTION 0
48 #define	USB_HAVE_PER_BUS_PROCESS 0
49 #define	USB_HAVE_FIXED_ENDPOINT 0
50 #define	USB_HAVE_FIXED_IFACE 0
51 #define	USB_HAVE_FIXED_CONFIG 0
52 #define	USB_HAVE_FIXED_PORT 0
53 
54 #define	USB_CALLOUT_ZERO_TICKS 1
55 
56 #define	USB_TD_GET_PROC(td) (td)->td_proc
57 #define	USB_PROC_GET_GID(td) (td)->p_pgid
58 
59 #if (!defined(USB_HOST_ALIGN)) || (USB_HOST_ALIGN <= 0)
60 /* Use default value. */
61 #undef USB_HOST_ALIGN
62 #define	USB_HOST_ALIGN    8		/* bytes, must be power of two */
63 #endif
64 /* Sanity check for USB_HOST_ALIGN: Verify power of two. */
65 #if ((-USB_HOST_ALIGN) & USB_HOST_ALIGN) != USB_HOST_ALIGN
66 #error "USB_HOST_ALIGN is not power of two."
67 #endif
68 #define	USB_FS_ISOC_UFRAME_MAX 4	/* exclusive unit */
69 #define	USB_BUS_MAX 256			/* units */
70 #define	USB_MAX_DEVICES 128		/* units */
71 #define	USB_CONFIG_MAX 65535		/* bytes */
72 #define	USB_IFACE_MAX 32		/* units */
73 #define	USB_FIFO_MAX 128		/* units */
74 #define	USB_MAX_EP_UNITS 32		/* units */
75 #define	USB_MAX_EP_STREAMS 8		/* units */
76 #define	USB_MAX_PORTS 255		/* units */
77 
78 #define	USB_MAX_FS_ISOC_FRAMES_PER_XFER (120)	/* units */
79 #define	USB_MAX_HS_ISOC_FRAMES_PER_XFER (8*120)	/* units */
80 
81 #define	USB_HUB_MAX_DEPTH	5
82 #define	USB_EP0_BUFSIZE		1024	/* bytes */
83 #define	USB_CS_RESET_LIMIT	20	/* failures = 20 * 50 ms = 1sec */
84 
85 #define	USB_MAX_AUTO_QUIRK	4	/* maximum number of dynamic quirks */
86 
87 typedef uint32_t usb_timeout_t;		/* milliseconds */
88 typedef uint32_t usb_frlength_t;	/* bytes */
89 typedef uint32_t usb_frcount_t;		/* units */
90 typedef uint32_t usb_size_t;		/* bytes */
91 typedef uint32_t usb_ticks_t;		/* system defined */
92 typedef uint16_t usb_power_mask_t;	/* see "USB_HW_POWER_XXX" */
93 typedef uint16_t usb_stream_t;		/* stream ID */
94 
95 #endif					/* _USB_FREEBSD_LOADER_H_ */
96