xref: /freebsd/sys/dev/usb/usb_freebsd.h (revision f81cdf24ba5436367377f7c8e8f51f6df2a75ca7)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 /*
29  * Including this file is mandatory for all USB related c-files in the kernel.
30  */
31 
32 #ifndef _USB_FREEBSD_H_
33 #define	_USB_FREEBSD_H_
34 
35 /* Default USB configuration */
36 #define	USB_HAVE_UGEN 1
37 #define	USB_HAVE_DEVCTL 1
38 #define	USB_HAVE_BUSDMA 1
39 #define	USB_HAVE_COMPAT_LINUX 1
40 #define	USB_HAVE_USER_IO 1
41 #define	USB_HAVE_MBUF 1
42 #define	USB_HAVE_TT_SUPPORT 1
43 #define	USB_HAVE_POWERD 1
44 #define	USB_HAVE_MSCTEST 1
45 #define	USB_HAVE_MSCTEST_DETACH 1
46 #define	USB_HAVE_PF 1
47 #define	USB_HAVE_ROOT_MOUNT_HOLD 1
48 #define	USB_HAVE_ID_SECTION 1
49 #define	USB_HAVE_PER_BUS_PROCESS 1
50 #define	USB_HAVE_FIXED_ENDPOINT 0
51 #define	USB_HAVE_FIXED_IFACE 0
52 #define	USB_HAVE_FIXED_CONFIG 0
53 #define	USB_HAVE_FIXED_PORT 0
54 #define	USB_HAVE_DISABLE_ENUM 1
55 #define	USB_HAVE_MALLOC_WAITOK 1
56 
57 /* define zero ticks callout value */
58 #define	USB_CALLOUT_ZERO_TICKS 1
59 
60 #define	USB_TD_GET_PROC(td) (td)->td_proc
61 #define	USB_PROC_GET_GID(td) (td)->p_pgid
62 
63 #if (!defined(USB_HOST_ALIGN)) || (USB_HOST_ALIGN <= 0)
64 /* Use default value. */
65 #undef USB_HOST_ALIGN
66 #if defined(__arm__) || defined(__powerpc__)
67 #define USB_HOST_ALIGN	32		/* Arm and PowerPC need at least this much, if not more */
68 #else
69 #define	USB_HOST_ALIGN	8		/* bytes, must be power of two */
70 #endif
71 #endif
72 /* Sanity check for USB_HOST_ALIGN: Verify power of two. */
73 #if ((-USB_HOST_ALIGN) & USB_HOST_ALIGN) != USB_HOST_ALIGN
74 #error "USB_HOST_ALIGN is not power of two."
75 #endif
76 #define	USB_FS_ISOC_UFRAME_MAX 4	/* exclusive unit */
77 #define	USB_BUS_MAX 256			/* units */
78 #define	USB_MAX_DEVICES 128		/* units */
79 #define	USB_CONFIG_MAX 65535		/* bytes */
80 #define	USB_IFACE_MAX 32		/* units */
81 #define	USB_FIFO_MAX 128		/* units */
82 #define	USB_MAX_EP_STREAMS 8		/* units */
83 #define	USB_MAX_EP_UNITS 32		/* units */
84 #define	USB_MAX_PORTS 255		/* units */
85 
86 #define	USB_MAX_FS_ISOC_FRAMES_PER_XFER (120)	/* units */
87 #define	USB_MAX_HS_ISOC_FRAMES_PER_XFER (8*120)	/* units */
88 
89 #define	USB_HUB_MAX_DEPTH	5
90 #define	USB_EP0_BUFSIZE		1024	/* bytes */
91 #define	USB_CS_RESET_LIMIT	20	/* failures = 20 * 50 ms = 1sec */
92 
93 #define	USB_MAX_AUTO_QUIRK	8	/* maximum number of dynamic quirks */
94 
95 #define	USB_IN_POLLING_MODE_FUNC() usbd_in_polling_mode()
96 #define	USB_IN_POLLING_MODE_VALUE() (SCHEDULER_STOPPED() || kdb_active)
97 
98 typedef uint32_t usb_timeout_t;		/* milliseconds */
99 typedef uint32_t usb_frlength_t;	/* bytes */
100 typedef uint32_t usb_frcount_t;		/* units */
101 typedef uint32_t usb_size_t;		/* bytes */
102 typedef uint32_t usb_ticks_t;		/* system defined */
103 typedef uint16_t usb_power_mask_t;	/* see "USB_HW_POWER_XXX" */
104 typedef uint16_t usb_stream_t;		/* stream ID */
105 
106 #endif	/* _USB_FREEBSD_H_ */
107