sys/dev/usb/usb_freebsd.h

   1 /* $FreeBSD$ */
   2 /*-
   3  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   4  *
   5  * Copyright (c) 2008 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 kernel.
  31  */
  32
  33 #ifndef _USB_FREEBSD_H_
  34 #define _USB_FREEBSD_H_
  35
  36 /* Default USB configuration */
  37 #define USB_HAVE_UGEN 1
  38 #define USB_HAVE_DEVCTL 1
  39 #define USB_HAVE_BUSDMA 1
  40 #define USB_HAVE_COMPAT_LINUX 1
  41 #define USB_HAVE_USER_IO 1
  42 #define USB_HAVE_MBUF 1
  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 1
  47 #define USB_HAVE_PF 1
  48 #define USB_HAVE_ROOT_MOUNT_HOLD 1
  49 #define USB_HAVE_ID_SECTION 1
  50 #define USB_HAVE_PER_BUS_PROCESS 1
  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 1
  56 #define USB_HAVE_MALLOC_WAITOK 1
  57
  58 /* define zero ticks callout value */
  59 #define USB_CALLOUT_ZERO_TICKS 1
  60
  61 #define USB_TD_GET_PROC(td) (td)->td_proc
  62 #define USB_PROC_GET_GID(td) (td)->p_pgid
  63
  64 #if (!defined(USB_HOST_ALIGN)) || (USB_HOST_ALIGN <= 0)
  65 /* Use default value. */
  66 #undef USB_HOST_ALIGN
  67 #if defined(__arm__) || defined(__mips__) || defined(__powerpc__)
  68 #define USB_HOST_ALIGN  32              /* Arm and MIPS need at least this much, if not more */
  69 #else
  70 #define USB_HOST_ALIGN    8             /* bytes, must be power of two */
  71 #endif
  72 #endif
  73 /* Sanity check for USB_HOST_ALIGN: Verify power of two. */
  74 #if ((-USB_HOST_ALIGN) & USB_HOST_ALIGN) != USB_HOST_ALIGN
  75 #error "USB_HOST_ALIGN is not power of two."
  76 #endif
  77 #define USB_FS_ISOC_UFRAME_MAX 4        /* exclusive unit */
  78 #define USB_BUS_MAX 256                 /* units */
  79 #define USB_MAX_DEVICES 128             /* units */
  80 #define USB_CONFIG_MAX 65535            /* bytes */
  81 #define USB_IFACE_MAX 32                /* units */
  82 #define USB_FIFO_MAX 128                /* units */
  83 #define USB_MAX_EP_STREAMS 8            /* units */
  84 #define USB_MAX_EP_UNITS 32             /* units */
  85 #define USB_MAX_PORTS 255               /* units */
  86
  87 #define USB_MAX_FS_ISOC_FRAMES_PER_XFER (120)   /* units */
  88 #define USB_MAX_HS_ISOC_FRAMES_PER_XFER (8*120) /* units */
  89
  90 #define USB_HUB_MAX_DEPTH       5
  91 #define USB_EP0_BUFSIZE         1024    /* bytes */
  92 #define USB_CS_RESET_LIMIT      20      /* failures = 20 * 50 ms = 1sec */
  93
  94 #define USB_MAX_AUTO_QUIRK      8       /* maximum number of dynamic quirks */
  95
  96 #define USB_IN_POLLING_MODE_FUNC() usbd_in_polling_mode()
  97 #define USB_IN_POLLING_MODE_VALUE() (SCHEDULER_STOPPED() || kdb_active)
  98
  99 typedef uint32_t usb_timeout_t;         /* milliseconds */
 100 typedef uint32_t usb_frlength_t;        /* bytes */
 101 typedef uint32_t usb_frcount_t;         /* units */
 102 typedef uint32_t usb_size_t;            /* bytes */
 103 typedef uint32_t usb_ticks_t;           /* system defined */
 104 typedef uint16_t usb_power_mask_t;      /* see "USB_HW_POWER_XXX" */
 105 typedef uint16_t usb_stream_t;          /* stream ID */
 106
 107 #endif  /* _USB_FREEBSD_H_ */