dwc_otg.h revision 240419
1/* $FreeBSD: head/sys/dev/usb/controller/dwc_otg.h 240419 2012-09-12 19:15:29Z hselasky $ */ 2/*- 3 * Copyright (c) 2012 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 _DWC_OTG_H_ 28#define _DWC_OTG_H_ 29 30#define DWC_OTG_MAX_DEVICES MIN(USB_MAX_DEVICES, 32) 31#define DWC_OTG_FRAME_MASK 0x7FF 32#define DWC_OTG_MAX_TXP 4 33#define DWC_OTG_MAX_TXN (0x200 * DWC_OTG_MAX_TXP) 34#define DWC_OTG_MAX_CHANNELS 16 35#define DWC_OTG_MAX_ENDPOINTS 16 36 37#define DWC_OTG_READ_4(sc, reg) \ 38 bus_space_read_4((sc)->sc_io_tag, (sc)->sc_io_hdl, reg) 39 40#define DWC_OTG_WRITE_4(sc, reg, data) \ 41 bus_space_write_4((sc)->sc_io_tag, (sc)->sc_io_hdl, reg, data) 42 43struct dwc_otg_td; 44struct dwc_otg_softc; 45 46typedef uint8_t (dwc_otg_cmd_t)(struct dwc_otg_td *td); 47 48struct dwc_otg_td { 49 struct dwc_otg_td *obj_next; 50 dwc_otg_cmd_t *func; 51 struct usb_page_cache *pc; 52 uint32_t tx_bytes; 53 uint32_t offset; 54 uint32_t remainder; 55 uint32_t hcchar; /* HOST CFG */ 56 uint32_t hcsplt; /* HOST CFG */ 57 uint16_t max_packet_size; /* packet_size */ 58 uint16_t npkt; 59 uint8_t sof_res; 60 uint8_t sof_val; 61 uint8_t ep_no; 62 uint8_t channel; 63 uint8_t error:1; 64 uint8_t error_any:1; 65 uint8_t error_stall:1; 66 uint8_t alt_next:1; 67 uint8_t short_pkt:1; 68 uint8_t did_stall:1; 69 uint8_t toggle:1; 70 uint8_t set_toggle:1; 71 uint8_t did_nak:1; 72 uint8_t did_complete:1; 73 uint8_t got_short:1; 74}; 75 76struct dwc_otg_std_temp { 77 dwc_otg_cmd_t *func; 78 struct usb_page_cache *pc; 79 struct dwc_otg_td *td; 80 struct dwc_otg_td *td_next; 81 uint32_t len; 82 uint32_t offset; 83 uint16_t max_frame_size; 84 uint8_t short_pkt; 85 86 /* 87 * short_pkt = 0: transfer should be short terminated 88 * short_pkt = 1: transfer should not be short terminated 89 */ 90 uint8_t setup_alt_next; 91 uint8_t did_stall; 92 uint8_t bulk_or_control; 93}; 94 95struct dwc_otg_config_desc { 96 struct usb_config_descriptor confd; 97 struct usb_interface_descriptor ifcd; 98 struct usb_endpoint_descriptor endpd; 99} __packed; 100 101union dwc_otg_hub_temp { 102 uWord wValue; 103 struct usb_port_status ps; 104}; 105 106struct dwc_otg_flags { 107 uint8_t change_connect:1; 108 uint8_t change_suspend:1; 109 uint8_t change_reset:1; 110 uint8_t change_enabled:1; 111 uint8_t change_over_current:1; 112 uint8_t status_suspend:1; /* set if suspended */ 113 uint8_t status_vbus:1; /* set if present */ 114 uint8_t status_bus_reset:1; /* set if reset complete */ 115 uint8_t status_high_speed:1; /* set if High Speed is selected */ 116 uint8_t status_low_speed:1; /* set if Low Speed is selected */ 117 uint8_t status_device_mode:1; /* set if device mode */ 118 uint8_t self_powered:1; 119 uint8_t clocks_off:1; 120 uint8_t port_powered:1; 121 uint8_t port_enabled:1; 122 uint8_t port_over_current:1; 123 uint8_t d_pulled_up:1; 124}; 125 126struct dwc_otg_profile { 127 struct usb_hw_ep_profile usb; 128 uint16_t max_buffer; 129}; 130 131struct dwc_otg_softc { 132 struct usb_bus sc_bus; 133 union dwc_otg_hub_temp sc_hub_temp; 134 struct dwc_otg_profile sc_hw_ep_profile[DWC_OTG_MAX_ENDPOINTS]; 135 136 struct usb_device *sc_devices[DWC_OTG_MAX_DEVICES]; 137 struct resource *sc_io_res; 138 struct resource *sc_irq_res; 139 void *sc_intr_hdl; 140 bus_size_t sc_io_size; 141 bus_space_tag_t sc_io_tag; 142 bus_space_handle_t sc_io_hdl; 143 144 uint32_t sc_rx_bounce_buffer[1024 / 4]; 145 uint32_t sc_tx_bounce_buffer[(512 * DWC_OTG_MAX_TXP) / 4]; 146 147 uint32_t sc_fifo_size; 148 uint32_t sc_irq_mask; 149 uint32_t sc_last_rx_status; 150 uint32_t sc_out_ctl[DWC_OTG_MAX_ENDPOINTS]; 151 uint32_t sc_in_ctl[DWC_OTG_MAX_ENDPOINTS]; 152 uint32_t sc_hcchar[DWC_OTG_MAX_CHANNELS]; 153 uint32_t sc_sof_refs; 154 uint32_t sc_sof_val; 155 uint32_t sc_hprt_val; 156 157 uint16_t sc_active_rx_ep; 158 159 uint8_t sc_dev_ep_max; 160 uint8_t sc_dev_in_ep_max; 161 uint8_t sc_host_ch_max; 162 uint8_t sc_rt_addr; /* root HUB address */ 163 uint8_t sc_conf; /* root HUB config */ 164 uint8_t sc_mode; /* mode of operation */ 165#define DWC_MODE_OTG 0 /* both modes */ 166#define DWC_MODE_DEVICE 1 /* device only */ 167#define DWC_MODE_HOST 2 /* host only */ 168 169 uint8_t sc_hub_idata[1]; 170 171 struct dwc_otg_flags sc_flags; 172}; 173 174/* prototypes */ 175 176void dwc_otg_interrupt(struct dwc_otg_softc *); 177int dwc_otg_init(struct dwc_otg_softc *); 178void dwc_otg_uninit(struct dwc_otg_softc *); 179 180#endif /* _DWC_OTG_H_ */ 181