xref: /freebsd-src/sys/dev/usb/usb_freebsd.h (revision 71625ec9ad2a9bc8c09784fbd23b759830e0ee5f)
1ed6d949aSAndrew Thompson /*-
2*4d846d26SWarner Losh  * SPDX-License-Identifier: BSD-2-Clause
3718cf2ccSPedro F. Giffuni  *
4ed6d949aSAndrew Thompson  * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
5ed6d949aSAndrew Thompson  *
6ed6d949aSAndrew Thompson  * Redistribution and use in source and binary forms, with or without
7ed6d949aSAndrew Thompson  * modification, are permitted provided that the following conditions
8ed6d949aSAndrew Thompson  * are met:
9ed6d949aSAndrew Thompson  * 1. Redistributions of source code must retain the above copyright
10ed6d949aSAndrew Thompson  *    notice, this list of conditions and the following disclaimer.
11ed6d949aSAndrew Thompson  * 2. Redistributions in binary form must reproduce the above copyright
12ed6d949aSAndrew Thompson  *    notice, this list of conditions and the following disclaimer in the
13ed6d949aSAndrew Thompson  *    documentation and/or other materials provided with the distribution.
14ed6d949aSAndrew Thompson  *
15ed6d949aSAndrew Thompson  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16ed6d949aSAndrew Thompson  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17ed6d949aSAndrew Thompson  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18ed6d949aSAndrew Thompson  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19ed6d949aSAndrew Thompson  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20ed6d949aSAndrew Thompson  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21ed6d949aSAndrew Thompson  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22ed6d949aSAndrew Thompson  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23ed6d949aSAndrew Thompson  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24ed6d949aSAndrew Thompson  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25ed6d949aSAndrew Thompson  * SUCH DAMAGE.
26ed6d949aSAndrew Thompson  */
27ed6d949aSAndrew Thompson 
28ed6d949aSAndrew Thompson /*
29ed6d949aSAndrew Thompson  * Including this file is mandatory for all USB related c-files in the kernel.
30ed6d949aSAndrew Thompson  */
31ed6d949aSAndrew Thompson 
32ed6d949aSAndrew Thompson #ifndef _USB_FREEBSD_H_
33ed6d949aSAndrew Thompson #define	_USB_FREEBSD_H_
34ed6d949aSAndrew Thompson 
35ed6d949aSAndrew Thompson /* Default USB configuration */
36ed6d949aSAndrew Thompson #define	USB_HAVE_UGEN 1
378bb77249SHans Petter Selasky #define	USB_HAVE_DEVCTL 1
38ed6d949aSAndrew Thompson #define	USB_HAVE_BUSDMA 1
39ed6d949aSAndrew Thompson #define	USB_HAVE_COMPAT_LINUX 1
40ed6d949aSAndrew Thompson #define	USB_HAVE_USER_IO 1
41ed6d949aSAndrew Thompson #define	USB_HAVE_MBUF 1
42ed6d949aSAndrew Thompson #define	USB_HAVE_TT_SUPPORT 1
43ed6d949aSAndrew Thompson #define	USB_HAVE_POWERD 1
44ed6d949aSAndrew Thompson #define	USB_HAVE_MSCTEST 1
45ce19294cSHans Petter Selasky #define	USB_HAVE_MSCTEST_DETACH 1
468be09334SHans Petter Selasky #define	USB_HAVE_PF 1
47d2b99310SHans Petter Selasky #define	USB_HAVE_ROOT_MOUNT_HOLD 1
487b0866b0SHans Petter Selasky #define	USB_HAVE_ID_SECTION 1
499b3a48eeSHans Petter Selasky #define	USB_HAVE_PER_BUS_PROCESS 1
505b0752bbSHans Petter Selasky #define	USB_HAVE_FIXED_ENDPOINT 0
515b0752bbSHans Petter Selasky #define	USB_HAVE_FIXED_IFACE 0
522c79a775SHans Petter Selasky #define	USB_HAVE_FIXED_CONFIG 0
532c79a775SHans Petter Selasky #define	USB_HAVE_FIXED_PORT 0
54c38aa253SHans Petter Selasky #define	USB_HAVE_DISABLE_ENUM 1
5594140f47SMark Johnston #define	USB_HAVE_MALLOC_WAITOK 1
56ed6d949aSAndrew Thompson 
57924b1f5dSHans Petter Selasky /* define zero ticks callout value */
58924b1f5dSHans Petter Selasky #define	USB_CALLOUT_ZERO_TICKS 1
59924b1f5dSHans Petter Selasky 
60ed6d949aSAndrew Thompson #define	USB_TD_GET_PROC(td) (td)->td_proc
61ed6d949aSAndrew Thompson #define	USB_PROC_GET_GID(td) (td)->p_pgid
62ed6d949aSAndrew Thompson 
6399f017d2SHans Petter Selasky #if (!defined(USB_HOST_ALIGN)) || (USB_HOST_ALIGN <= 0)
6499f017d2SHans Petter Selasky /* Use default value. */
65d8d1becfSHans Petter Selasky #undef USB_HOST_ALIGN
6615c0b8c9SMateusz Guzik #if defined(__arm__) || defined(__powerpc__)
6789cd5d08SJohn Baldwin #define USB_HOST_ALIGN	32		/* Arm and PowerPC need at least this much, if not more */
688b18cb1cSWarner Losh #else
69ed6d949aSAndrew Thompson #define	USB_HOST_ALIGN	8		/* bytes, must be power of two */
70d8d1becfSHans Petter Selasky #endif
718b18cb1cSWarner Losh #endif
7299f017d2SHans Petter Selasky /* Sanity check for USB_HOST_ALIGN: Verify power of two. */
7399f017d2SHans Petter Selasky #if ((-USB_HOST_ALIGN) & USB_HOST_ALIGN) != USB_HOST_ALIGN
7499f017d2SHans Petter Selasky #error "USB_HOST_ALIGN is not power of two."
7599f017d2SHans Petter Selasky #endif
76ed6d949aSAndrew Thompson #define	USB_FS_ISOC_UFRAME_MAX 4	/* exclusive unit */
77ed6d949aSAndrew Thompson #define	USB_BUS_MAX 256			/* units */
78ed6d949aSAndrew Thompson #define	USB_MAX_DEVICES 128		/* units */
795b0752bbSHans Petter Selasky #define	USB_CONFIG_MAX 65535		/* bytes */
80ed6d949aSAndrew Thompson #define	USB_IFACE_MAX 32		/* units */
81ed6d949aSAndrew Thompson #define	USB_FIFO_MAX 128		/* units */
82a5cf1aaaSHans Petter Selasky #define	USB_MAX_EP_STREAMS 8		/* units */
835b0752bbSHans Petter Selasky #define	USB_MAX_EP_UNITS 32		/* units */
842c79a775SHans Petter Selasky #define	USB_MAX_PORTS 255		/* units */
85ed6d949aSAndrew Thompson 
86ed6d949aSAndrew Thompson #define	USB_MAX_FS_ISOC_FRAMES_PER_XFER (120)	/* units */
87ed6d949aSAndrew Thompson #define	USB_MAX_HS_ISOC_FRAMES_PER_XFER (8*120)	/* units */
88ed6d949aSAndrew Thompson 
89ed6d949aSAndrew Thompson #define	USB_HUB_MAX_DEPTH	5
90ed6d949aSAndrew Thompson #define	USB_EP0_BUFSIZE		1024	/* bytes */
919eb0d702SHans Petter Selasky #define	USB_CS_RESET_LIMIT	20	/* failures = 20 * 50 ms = 1sec */
92ed6d949aSAndrew Thompson 
939f21f476SHans Petter Selasky #define	USB_MAX_AUTO_QUIRK	8	/* maximum number of dynamic quirks */
94d46dc4adSHans Petter Selasky 
950eb8d462SHans Petter Selasky #define	USB_IN_POLLING_MODE_FUNC() usbd_in_polling_mode()
960eb8d462SHans Petter Selasky #define	USB_IN_POLLING_MODE_VALUE() (SCHEDULER_STOPPED() || kdb_active)
970eb8d462SHans Petter Selasky 
98ed6d949aSAndrew Thompson typedef uint32_t usb_timeout_t;		/* milliseconds */
99ed6d949aSAndrew Thompson typedef uint32_t usb_frlength_t;	/* bytes */
100ed6d949aSAndrew Thompson typedef uint32_t usb_frcount_t;		/* units */
101ed6d949aSAndrew Thompson typedef uint32_t usb_size_t;		/* bytes */
102ed6d949aSAndrew Thompson typedef uint32_t usb_ticks_t;		/* system defined */
103ed6d949aSAndrew Thompson typedef uint16_t usb_power_mask_t;	/* see "USB_HW_POWER_XXX" */
104a5cf1aaaSHans Petter Selasky typedef uint16_t usb_stream_t;		/* stream ID */
105ed6d949aSAndrew Thompson 
106ed6d949aSAndrew Thompson #endif	/* _USB_FREEBSD_H_ */
107