sys/bus/u4b/usb_controller.h

   1 /* $FreeBSD: head/sys/dev/usb/usb_controller.h 259023 2013-12-06 08:42:41Z hselasky $ */
   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 _USB_CONTROLLER_H_
  28 #define _USB_CONTROLLER_H_
  29
  30 /* defines */
  31
  32 #define USB_BUS_DMA_TAG_MAX 8
  33
  34 /* structure prototypes  */
  35
  36 struct usb_bus;
  37 struct usb_page;
  38 struct usb_endpoint;
  39 struct usb_page_cache;
  40 struct usb_setup_params;
  41 struct usb_hw_ep_profile;
  42 struct usb_fs_isoc_schedule;
  43 struct usb_endpoint_descriptor;
  44
  45 /* typedefs */
  46
  47 typedef void (usb_bus_mem_sub_cb_t)(struct usb_bus *bus, struct usb_page_cache *pc, struct usb_page *pg, usb_size_t size, usb_size_t align);
  48 typedef void (usb_bus_mem_cb_t)(struct usb_bus *bus, usb_bus_mem_sub_cb_t *scb);
  49
  50 /*
  51  * The following structure is used to define all the USB BUS
  52  * callbacks.
  53  */
  54 struct usb_bus_methods {
  55
  56         /* USB Device and Host mode - Mandatory */
  57
  58         usb_handle_req_t *roothub_exec;
  59
  60         void    (*endpoint_init) (struct usb_device *,
  61                     struct usb_endpoint_descriptor *, struct usb_endpoint *);
  62         void    (*xfer_setup) (struct usb_setup_params *);
  63         void    (*xfer_unsetup) (struct usb_xfer *);
  64         void    (*get_dma_delay) (struct usb_device *, uint32_t *);
  65         void    (*device_suspend) (struct usb_device *);
  66         void    (*device_resume) (struct usb_device *);
  67         void    (*set_hw_power) (struct usb_bus *);
  68         void    (*set_hw_power_sleep) (struct usb_bus *, uint32_t);
  69         /*
  70          * The following flag is set if one or more control transfers are
  71          * active:
  72          */
  73 #define USB_HW_POWER_CONTROL    0x01
  74         /*
  75          * The following flag is set if one or more bulk transfers are
  76          * active:
  77          */
  78 #define USB_HW_POWER_BULK       0x02
  79         /*
  80          * The following flag is set if one or more interrupt transfers are
  81          * active:
  82          */
  83 #define USB_HW_POWER_INTERRUPT  0x04
  84         /*
  85          * The following flag is set if one or more isochronous transfers
  86          * are active:
  87          */
  88 #define USB_HW_POWER_ISOC       0x08
  89         /*
  90          * The following flag is set if one or more non-root-HUB devices
  91          * are present on the given USB bus:
  92          */
  93 #define USB_HW_POWER_NON_ROOT_HUB 0x10
  94         /*
  95          * The following flag is set if we are suspending
  96          */
  97 #define USB_HW_POWER_SUSPEND 0x20
  98         /*
  99          * The following flag is set if we are resuming
 100          */
 101 #define USB_HW_POWER_RESUME 0x40
 102         /*
 103          * The following flag is set if we are shutting down
 104          */
 105 #define USB_HW_POWER_SHUTDOWN 0x60
 106
 107         /* USB Device mode only - Mandatory */
 108
 109         void    (*get_hw_ep_profile) (struct usb_device *udev, const struct usb_hw_ep_profile **ppf, uint8_t ep_addr);
 110         void    (*xfer_stall) (struct usb_xfer *xfer);
 111         void    (*set_stall) (struct usb_device *udev, struct usb_endpoint *ep, uint8_t *did_stall);
 112
 113         /* USB Device mode mandatory. USB Host mode optional. */
 114
 115         void    (*clear_stall) (struct usb_device *udev, struct usb_endpoint *ep);
 116
 117         /* Optional transfer polling support */
 118
 119         void    (*xfer_poll) (struct usb_bus *);
 120
 121         /* Optional fixed power mode support */
 122
 123         void    (*get_power_mode) (struct usb_device *udev, int8_t *pmode);
 124
 125         /* Optional endpoint uninit */
 126
 127         void    (*endpoint_uninit) (struct usb_device *, struct usb_endpoint *);
 128
 129         /* Optional device init */
 130
 131         usb_error_t     (*device_init) (struct usb_device *);
 132
 133         /* Optional device uninit */
 134
 135         void    (*device_uninit) (struct usb_device *);
 136
 137         /* Optional for device and host mode */
 138
 139         void    (*start_dma_delay) (struct usb_xfer *);
 140
 141         void    (*device_state_change) (struct usb_device *);
 142
 143         /* Optional for host mode */
 144
 145         usb_error_t     (*set_address) (struct usb_device *, struct lock *, uint16_t);
 146
 147         /* Optional for device and host mode */
 148
 149         usb_error_t     (*set_endpoint_mode) (struct usb_device *, struct usb_endpoint *, uint8_t);
 150 };
 151
 152 /*
 153  * The following structure is used to define all the USB pipe
 154  * callbacks.
 155  */
 156 struct usb_pipe_methods {
 157
 158         /* Mandatory USB Device and Host mode callbacks: */
 159
 160         void    (*open)(struct usb_xfer *);
 161         void    (*close)(struct usb_xfer *);
 162
 163         void    (*enter)(struct usb_xfer *);
 164         void    (*start)(struct usb_xfer *);
 165
 166         /* Optional */
 167
 168         void   *info;
 169 };
 170
 171 /*
 172  * The following structure keeps information about what a hardware USB
 173  * endpoint supports.
 174  */
 175 struct usb_hw_ep_profile {
 176         uint16_t max_in_frame_size;     /* IN-token direction */
 177         uint16_t max_out_frame_size;    /* OUT-token direction */
 178         uint8_t is_simplex:1;
 179         uint8_t support_multi_buffer:1;
 180         uint8_t support_bulk:1;
 181         uint8_t support_control:1;
 182         uint8_t support_interrupt:1;
 183         uint8_t support_isochronous:1;
 184         uint8_t support_in:1;           /* IN-token is supported */
 185         uint8_t support_out:1;          /* OUT-token is supported */
 186 };
 187
 188 /* prototypes */
 189
 190 void    usb_bus_mem_flush_all(struct usb_bus *bus, usb_bus_mem_cb_t *cb);
 191 uint8_t usb_bus_mem_alloc_all(struct usb_bus *bus, bus_dma_tag_t dmat, usb_bus_mem_cb_t *cb);
 192 void    usb_bus_mem_free_all(struct usb_bus *bus, usb_bus_mem_cb_t *cb);
 193 uint16_t usb_isoc_time_expand(struct usb_bus *bus, uint16_t isoc_time_curr);
 194 void    usb_bus_reset_async_locked(struct usb_bus *bus);
 195 #if USB_HAVE_TT_SUPPORT
 196 uint8_t usbd_fs_isoc_schedule_alloc_slot(struct usb_xfer *isoc_xfer, uint16_t isoc_time);
 197 #endif
 198
 199 #endif                                  /* _USB_CONTROLLER_H_ */