xref: /freebsd/sys/dev/usb/usb_freebsd.h (revision 884a2a699669ec61e2366e3e358342dbc94be24a)
1 /* $FreeBSD$ */
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 /*
28  * Including this file is mandatory for all USB related c-files in the kernel.
29  */
30 
31 #ifndef _USB_FREEBSD_H_
32 #define	_USB_FREEBSD_H_
33 
34 /* Default USB configuration */
35 #define	USB_HAVE_UGEN 1
36 #define	USB_HAVE_DEVCTL 1
37 #define	USB_HAVE_BUSDMA 1
38 #define	USB_HAVE_COMPAT_LINUX 1
39 #define	USB_HAVE_USER_IO 1
40 #define	USB_HAVE_MBUF 1
41 #define	USB_HAVE_TT_SUPPORT 1
42 #define	USB_HAVE_POWERD 1
43 #define	USB_HAVE_MSCTEST 1
44 #define	USB_HAVE_PF 1
45 
46 #define	USB_TD_GET_PROC(td) (td)->td_proc
47 #define	USB_PROC_GET_GID(td) (td)->p_pgid
48 
49 #if (!defined(USB_HOST_ALIGN)) || (USB_HOST_ALIGN <= 0)
50 /* Use default value. */
51 #undef USB_HOST_ALIGN
52 #define	USB_HOST_ALIGN    8		/* bytes, must be power of two */
53 #endif
54 /* Sanity check for USB_HOST_ALIGN: Verify power of two. */
55 #if ((-USB_HOST_ALIGN) & USB_HOST_ALIGN) != USB_HOST_ALIGN
56 #error "USB_HOST_ALIGN is not power of two."
57 #endif
58 #define	USB_FS_ISOC_UFRAME_MAX 4	/* exclusive unit */
59 #define	USB_BUS_MAX 256			/* units */
60 #define	USB_MAX_DEVICES 128		/* units */
61 #define	USB_IFACE_MAX 32		/* units */
62 #define	USB_FIFO_MAX 128		/* units */
63 
64 #define	USB_MAX_FS_ISOC_FRAMES_PER_XFER (120)	/* units */
65 #define	USB_MAX_HS_ISOC_FRAMES_PER_XFER (8*120)	/* units */
66 
67 #define	USB_HUB_MAX_DEPTH	5
68 #define	USB_EP0_BUFSIZE		1024	/* bytes */
69 
70 typedef uint32_t usb_timeout_t;		/* milliseconds */
71 typedef uint32_t usb_frlength_t;	/* bytes */
72 typedef uint32_t usb_frcount_t;		/* units */
73 typedef uint32_t usb_size_t;		/* bytes */
74 typedef uint32_t usb_ticks_t;		/* system defined */
75 typedef uint16_t usb_power_mask_t;	/* see "USB_HW_POWER_XXX" */
76 
77 #endif	/* _USB_FREEBSD_H_ */
78