sys/dev/usb/usb_controller.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 #ifndef _USB_CONTROLLER_H_
  30 #define _USB_CONTROLLER_H_
  31
  32 /* defines */
  33
  34 #define USB_BUS_DMA_TAG_MAX 8
  35
  36 /* structure prototypes  */
  37
  38 struct usb_bus;
  39 struct usb_page;
  40 struct usb_endpoint;
  41 struct usb_page_cache;
  42 struct usb_setup_params;
  43 struct usb_hw_ep_profile;
  44 struct usb_fs_isoc_schedule;
  45 struct usb_endpoint_descriptor;
  46
  47 /* typedefs */
  48
  49 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);
  50 typedef void (usb_bus_mem_cb_t)(struct usb_bus *bus, usb_bus_mem_sub_cb_t *scb);
  51
  52 /*
  53  * The following structure is used to define all the USB BUS
  54  * callbacks.
  55  */
  56 struct usb_bus_methods {
  57         /* USB Device and Host mode - Mandatory */
  58
  59         usb_handle_req_t *roothub_exec;
  60
  61         void    (*endpoint_init) (struct usb_device *,
  62                     struct usb_endpoint_descriptor *, struct usb_endpoint *);
  63         void    (*xfer_setup) (struct usb_setup_params *);
  64         void    (*xfer_unsetup) (struct usb_xfer *);
  65         void    (*get_dma_delay) (struct usb_device *, uint32_t *);
  66         void    (*device_suspend) (struct usb_device *);
  67         void    (*device_resume) (struct usb_device *);
  68         void    (*set_hw_power) (struct usb_bus *);
  69         void    (*set_hw_power_sleep) (struct usb_bus *, uint32_t);
  70         /*
  71          * The following flag is set if one or more control transfers are
  72          * active:
  73          */
  74 #define USB_HW_POWER_CONTROL    0x01
  75         /*
  76          * The following flag is set if one or more bulk transfers are
  77          * active:
  78          */
  79 #define USB_HW_POWER_BULK       0x02
  80         /*
  81          * The following flag is set if one or more interrupt transfers are
  82          * active:
  83          */
  84 #define USB_HW_POWER_INTERRUPT  0x04
  85         /*
  86          * The following flag is set if one or more isochronous transfers
  87          * are active:
  88          */
  89 #define USB_HW_POWER_ISOC       0x08
  90         /*
  91          * The following flag is set if one or more non-root-HUB devices
  92          * are present on the given USB bus:
  93          */
  94 #define USB_HW_POWER_NON_ROOT_HUB 0x10
  95         /*
  96          * The following flag is set if we are suspending
  97          */
  98 #define USB_HW_POWER_SUSPEND 0x20
  99         /*
 100          * The following flag is set if we are resuming
 101          */
 102 #define USB_HW_POWER_RESUME 0x40
 103         /*
 104          * The following flag is set if we are shutting down
 105          */
 106 #define USB_HW_POWER_SHUTDOWN 0x60
 107
 108         /* USB Device mode only - Mandatory */
 109
 110         void    (*get_hw_ep_profile) (struct usb_device *udev, const struct usb_hw_ep_profile **ppf, uint8_t ep_addr);
 111         void    (*xfer_stall) (struct usb_xfer *xfer);
 112         void    (*set_stall) (struct usb_device *udev, struct usb_endpoint *ep, uint8_t *did_stall);
 113
 114         /* USB Device mode mandatory. USB Host mode optional. */
 115
 116         void    (*clear_stall) (struct usb_device *udev, struct usb_endpoint *ep);
 117
 118         /* Optional transfer polling support */
 119
 120         void    (*xfer_poll) (struct usb_bus *);
 121
 122         /* Optional fixed power mode support */
 123
 124         void    (*get_power_mode) (struct usb_device *udev, int8_t *pmode);
 125
 126         /* Optional endpoint uninit */
 127
 128         void    (*endpoint_uninit) (struct usb_device *, struct usb_endpoint *);
 129
 130         /* Optional device init */
 131
 132         usb_error_t     (*device_init) (struct usb_device *);
 133
 134         /* Optional device uninit */
 135
 136         void    (*device_uninit) (struct usb_device *);
 137
 138         /* Optional for device and host mode */
 139
 140         void    (*start_dma_delay) (struct usb_xfer *);
 141
 142         void    (*device_state_change) (struct usb_device *);
 143
 144         /* Optional for host mode */
 145
 146         usb_error_t     (*set_address) (struct usb_device *, struct mtx *, uint16_t);
 147
 148         /* Optional for device and host mode */
 149
 150         usb_error_t     (*set_endpoint_mode) (struct usb_device *, struct usb_endpoint *, uint8_t);
 151 };
 152
 153 /*
 154  * The following structure is used to define all the USB pipe
 155  * callbacks.
 156  */
 157 struct usb_pipe_methods {
 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_ */