sys/dev/usb/usb_controller.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_CONTROLLER_H_
  28 #define _USB2_CONTROLLER_H_
  29
  30 /* defines */
  31
  32 #define USB_BUS_DMA_TAG_MAX 8
  33
  34 /* structure prototypes */
  35
  36 struct usb2_bus;
  37 struct usb2_page;
  38 struct usb2_pipe;
  39 struct usb2_page_cache;
  40 struct usb2_setup_params;
  41 struct usb2_hw_ep_profile;
  42 struct usb2_fs_isoc_schedule;
  43 struct usb2_config_descriptor;
  44 struct usb2_endpoint_descriptor;
  45
  46 /* typedefs */
  47
  48 typedef void (usb2_bus_mem_sub_cb_t)(struct usb2_bus *bus, struct usb2_page_cache *pc, struct usb2_page *pg, uint32_t size, uint32_t align);
  49 typedef void (usb2_bus_mem_cb_t)(struct usb2_bus *bus, usb2_bus_mem_sub_cb_t *scb);
  50
  51 /*
  52  * The following structure is used to define all the USB BUS
  53  * callbacks.
  54  */
  55 struct usb2_bus_methods {
  56
  57         /* USB Device and Host mode - Mandatory */
  58
  59         void    (*pipe_init) (struct usb2_device *udev, struct usb2_endpoint_descriptor *edesc, struct usb2_pipe *pipe);
  60         void    (*xfer_setup) (struct usb2_setup_params *parm);
  61         void    (*xfer_unsetup) (struct usb2_xfer *xfer);
  62         void    (*get_dma_delay) (struct usb2_bus *, uint32_t *pdelay);
  63         void    (*device_suspend) (struct usb2_device *udev);
  64         void    (*device_resume) (struct usb2_device *udev);
  65         void    (*set_hw_power) (struct usb2_bus *bus);
  66         /*
  67          * The following flag is set if one or more control transfers are
  68          * active:
  69          */
  70 #define USB_HW_POWER_CONTROL    0x01
  71         /*
  72          * The following flag is set if one or more bulk transfers are
  73          * active:
  74          */
  75 #define USB_HW_POWER_BULK       0x02
  76         /*
  77          * The following flag is set if one or more interrupt transfers are
  78          * active:
  79          */
  80 #define USB_HW_POWER_INTERRUPT  0x04
  81         /*
  82          * The following flag is set if one or more isochronous transfers
  83          * are active:
  84          */
  85 #define USB_HW_POWER_ISOC       0x08
  86         /*
  87          * The following flag is set if one or more non-root-HUB devices
  88          * are present on the given USB bus:
  89          */
  90 #define USB_HW_POWER_NON_ROOT_HUB 0x10
  91
  92         /* USB Device mode only - Mandatory */
  93
  94         void    (*get_hw_ep_profile) (struct usb2_device *udev, const struct usb2_hw_ep_profile **ppf, uint8_t ep_addr);
  95         void    (*set_stall) (struct usb2_device *udev, struct usb2_xfer *xfer, struct usb2_pipe *pipe);
  96         void    (*clear_stall) (struct usb2_device *udev, struct usb2_pipe *pipe);
  97
  98         /* USB Device and Host mode - Optional */
  99
 100         void    (*roothub_exec) (struct usb2_bus *);
 101 };
 102
 103 /*
 104  * The following structure is used to define all the USB pipe
 105  * callbacks.
 106  */
 107 struct usb2_pipe_methods {
 108
 109         /* Mandatory USB Device and Host mode callbacks: */
 110
 111         void    (*open) (struct usb2_xfer *xfer);
 112         void    (*close) (struct usb2_xfer *xfer);
 113
 114         void    (*enter) (struct usb2_xfer *xfer);
 115         void    (*start) (struct usb2_xfer *xfer);
 116
 117         /* Optional */
 118
 119         void   *info;
 120
 121         /* Flags */
 122
 123         uint8_t enter_is_cancelable:1;
 124         uint8_t start_is_cancelable:1;
 125 };
 126
 127 /*
 128  * The following structure keeps information about what a hardware USB
 129  * endpoint supports.
 130  */
 131 struct usb2_hw_ep_profile {
 132         uint16_t max_in_frame_size;     /* IN-token direction */
 133         uint16_t max_out_frame_size;    /* OUT-token direction */
 134         uint8_t is_simplex:1;
 135         uint8_t support_multi_buffer:1;
 136         uint8_t support_bulk:1;
 137         uint8_t support_control:1;
 138         uint8_t support_interrupt:1;
 139         uint8_t support_isochronous:1;
 140         uint8_t support_in:1;           /* IN-token is supported */
 141         uint8_t support_out:1;          /* OUT-token is supported */
 142 };
 143
 144 /*
 145  * The following structure is used when trying to allocate hardware
 146  * endpoints for an USB configuration in USB device side mode.
 147  */
 148 struct usb2_hw_ep_scratch_sub {
 149         const struct usb2_hw_ep_profile *pf;
 150         uint16_t max_frame_size;
 151         uint8_t hw_endpoint_out;
 152         uint8_t hw_endpoint_in;
 153         uint8_t needs_ep_type;
 154         uint8_t needs_in:1;
 155         uint8_t needs_out:1;
 156 };
 157
 158 /*
 159  * The following structure is used when trying to allocate hardware
 160  * endpoints for an USB configuration in USB device side mode.
 161  */
 162 struct usb2_hw_ep_scratch {
 163         struct usb2_hw_ep_scratch_sub ep[USB_EP_MAX];
 164         struct usb2_hw_ep_scratch_sub *ep_max;
 165         struct usb2_config_descriptor *cd;
 166         struct usb2_device *udev;
 167         struct usb2_bus_methods *methods;
 168         uint8_t bmOutAlloc[(USB_EP_MAX + 15) / 16];
 169         uint8_t bmInAlloc[(USB_EP_MAX + 15) / 16];
 170 };
 171
 172 /*
 173  * The following structure is used when generating USB descriptors
 174  * from USB templates.
 175  */
 176 struct usb2_temp_setup {
 177         void   *buf;
 178         uint32_t size;
 179         uint8_t usb2_speed;
 180         uint8_t self_powered;
 181         uint8_t bNumEndpoints;
 182         uint8_t bInterfaceNumber;
 183         uint8_t bAlternateSetting;
 184         uint8_t bConfigurationValue;
 185         usb2_error_t err;
 186 };
 187
 188 /* prototypes */
 189
 190 void    usb2_bus_mem_flush_all(struct usb2_bus *bus, usb2_bus_mem_cb_t *cb);
 191 uint8_t usb2_bus_mem_alloc_all(struct usb2_bus *bus, bus_dma_tag_t dmat, usb2_bus_mem_cb_t *cb);
 192 void    usb2_bus_mem_free_all(struct usb2_bus *bus, usb2_bus_mem_cb_t *cb);
 193 void    usb2_bus_roothub_exec(struct usb2_bus *bus);
 194 uint16_t usb2_isoc_time_expand(struct usb2_bus *bus, uint16_t isoc_time_curr);
 195 uint16_t usb2_fs_isoc_schedule_isoc_time_expand(struct usb2_device *udev, struct usb2_fs_isoc_schedule **pp_start, struct usb2_fs_isoc_schedule **pp_end, uint16_t isoc_time);
 196 uint8_t usb2_fs_isoc_schedule_alloc(struct usb2_fs_isoc_schedule *fss, uint8_t *pstart, uint16_t len);
 197
 198 #endif                                  /* _USB2_CONTROLLER_H_ */