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 _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_config_descriptor; 44 struct usb_endpoint_descriptor; 45 46 /* typedefs */ 47 48 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); 49 typedef void (usb_bus_mem_cb_t)(struct usb_bus *bus, usb_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 usb_bus_methods { 56 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 (*set_stall) (struct usb_device *udev, struct usb_xfer *xfer, 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 148 /* 149 * The following structure is used to define all the USB pipe 150 * callbacks. 151 */ 152 struct usb_pipe_methods { 153 154 /* Mandatory USB Device and Host mode callbacks: */ 155 156 void (*open)(struct usb_xfer *); 157 void (*close)(struct usb_xfer *); 158 159 void (*enter)(struct usb_xfer *); 160 void (*start)(struct usb_xfer *); 161 162 /* Optional */ 163 164 void *info; 165 }; 166 167 /* 168 * The following structure keeps information about what a hardware USB 169 * endpoint supports. 170 */ 171 struct usb_hw_ep_profile { 172 uint16_t max_in_frame_size; /* IN-token direction */ 173 uint16_t max_out_frame_size; /* OUT-token direction */ 174 uint8_t is_simplex:1; 175 uint8_t support_multi_buffer:1; 176 uint8_t support_bulk:1; 177 uint8_t support_control:1; 178 uint8_t support_interrupt:1; 179 uint8_t support_isochronous:1; 180 uint8_t support_in:1; /* IN-token is supported */ 181 uint8_t support_out:1; /* OUT-token is supported */ 182 }; 183 184 /* 185 * The following structure is used when trying to allocate hardware 186 * endpoints for an USB configuration in USB device side mode. 187 */ 188 struct usb_hw_ep_scratch_sub { 189 const struct usb_hw_ep_profile *pf; 190 uint16_t max_frame_size; 191 uint8_t hw_endpoint_out; 192 uint8_t hw_endpoint_in; 193 uint8_t needs_ep_type; 194 uint8_t needs_in:1; 195 uint8_t needs_out:1; 196 }; 197 198 /* 199 * The following structure is used when trying to allocate hardware 200 * endpoints for an USB configuration in USB device side mode. 201 */ 202 struct usb_hw_ep_scratch { 203 struct usb_hw_ep_scratch_sub ep[USB_EP_MAX]; 204 struct usb_hw_ep_scratch_sub *ep_max; 205 struct usb_config_descriptor *cd; 206 struct usb_device *udev; 207 struct usb_bus_methods *methods; 208 uint8_t bmOutAlloc[(USB_EP_MAX + 15) / 16]; 209 uint8_t bmInAlloc[(USB_EP_MAX + 15) / 16]; 210 }; 211 212 /* 213 * The following structure is used when generating USB descriptors 214 * from USB templates. 215 */ 216 struct usb_temp_setup { 217 void *buf; 218 usb_size_t size; 219 enum usb_dev_speed usb_speed; 220 uint8_t self_powered; 221 uint8_t bNumEndpoints; 222 uint8_t bInterfaceNumber; 223 uint8_t bAlternateSetting; 224 uint8_t bConfigurationValue; 225 usb_error_t err; 226 }; 227 228 /* prototypes */ 229 230 void usb_bus_mem_flush_all(struct usb_bus *bus, usb_bus_mem_cb_t *cb); 231 uint8_t usb_bus_mem_alloc_all(struct usb_bus *bus, bus_dma_tag_t dmat, usb_bus_mem_cb_t *cb); 232 void usb_bus_mem_free_all(struct usb_bus *bus, usb_bus_mem_cb_t *cb); 233 uint16_t usb_isoc_time_expand(struct usb_bus *bus, uint16_t isoc_time_curr); 234 uint16_t usbd_fs_isoc_schedule_isoc_time_expand(struct usb_device *udev, struct usb_fs_isoc_schedule **pp_start, struct usb_fs_isoc_schedule **pp_end, uint16_t isoc_time); 235 uint8_t usbd_fs_isoc_schedule_alloc(struct usb_fs_isoc_schedule *fss, uint8_t *pstart, uint16_t len); 236 237 #endif /* _USB_CONTROLLER_H_ */ 238