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