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