sys/dev/usb/usb_bus.h

   1 /* $FreeBSD$ */
   2 /*-
   3  * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  */
  26
  27 #ifndef _USB2_BUS_H_
  28 #define _USB2_BUS_H_
  29
  30 /*
  31  * The following structure defines the USB explore message sent to the
  32  * USB explore process.
  33  */
  34
  35 struct usb2_bus_msg {
  36         struct usb2_proc_msg hdr;
  37         struct usb2_bus *bus;
  38 };
  39
  40 /*
  41  * The following structure defines the USB statistics structure.
  42  */
  43 struct usb2_bus_stat {
  44         uint32_t uds_requests[4];
  45 };
  46
  47 /*
  48  * The following structure defines an USB BUS. There is one USB BUS
  49  * for every Host or Device controller.
  50  */
  51 struct usb2_bus {
  52         struct usb2_bus_stat stats_err;
  53         struct usb2_bus_stat stats_ok;
  54         struct usb2_process explore_proc;
  55         struct usb2_process roothub_proc;
  56         struct root_hold_token *bus_roothold;
  57         /*
  58          * There are two callback processes. One for Giant locked
  59          * callbacks. One for non-Giant locked callbacks. This should
  60          * avoid congestion and reduce response time in most cases.
  61          */
  62         struct usb2_process giant_callback_proc;
  63         struct usb2_process non_giant_callback_proc;
  64         struct usb2_bus_msg explore_msg[2];
  65         struct usb2_bus_msg detach_msg[2];
  66         struct usb2_bus_msg attach_msg[2];
  67         struct usb2_bus_msg roothub_msg[2];
  68         /*
  69          * This mutex protects the USB hardware:
  70          */
  71         struct mtx bus_mtx;
  72         struct usb2_xfer_queue intr_q;
  73         struct usb2_callout power_wdog; /* power management */
  74
  75         device_t parent;
  76         device_t bdev;                  /* filled by HC driver */
  77
  78         struct usb2_dma_parent_tag dma_parent_tag[1];
  79         struct usb2_dma_tag dma_tags[USB_BUS_DMA_TAG_MAX];
  80
  81         struct usb2_bus_methods *methods;       /* filled by HC driver */
  82         struct usb2_device **devices;
  83
  84         uint32_t hw_power_state;        /* see USB_HW_POWER_XXX */
  85         uint32_t uframe_usage[USB_HS_MICRO_FRAMES_MAX];
  86         uint32_t transfer_count[4];
  87         uint16_t isoc_time_last;        /* in milliseconds */
  88
  89         uint8_t alloc_failed;           /* Set if memory allocation failed. */
  90         uint8_t driver_added_refcount;  /* Current driver generation count */
  91         uint8_t usbrev;                 /* USB revision. See "USB_REV_XXX". */
  92
  93         uint8_t devices_max;            /* maximum number of USB devices */
  94         uint8_t do_probe;               /* set if USB BUS should be re-probed */
  95
  96         union {
  97                 struct usb2_hw_ep_scratch hw_ep_scratch[1];
  98                 struct usb2_temp_setup temp_setup[1];
  99                 uint8_t data[128];
 100         }       scratch[1];
 101 };
 102
 103 #endif                                  /* _USB2_BUS_H_ */