1 /* $FreeBSD$ */ 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 (USB_MIN_DEVICES + 1) 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 35 #define DWC_OTG_READ_4(sc, reg) \ 36 bus_space_read_4((sc)->sc_io_tag, (sc)->sc_io_hdl, reg) 37 38 #define DWC_OTG_WRITE_4(sc, reg, data) \ 39 bus_space_write_4((sc)->sc_io_tag, (sc)->sc_io_hdl, reg, data) 40 41 struct dwc_otg_td; 42 struct dwc_otg_softc; 43 44 typedef uint8_t (dwc_otg_cmd_t)(struct dwc_otg_td *td); 45 46 struct dwc_otg_td { 47 struct dwc_otg_td *obj_next; 48 dwc_otg_cmd_t *func; 49 struct usb_page_cache *pc; 50 uint32_t tx_bytes; 51 uint32_t offset; 52 uint32_t remainder; 53 uint16_t max_packet_size; /* packet_size */ 54 uint16_t npkt; 55 uint8_t ep_no; 56 uint8_t error:1; 57 uint8_t alt_next:1; 58 uint8_t short_pkt:1; 59 uint8_t did_stall:1; 60 }; 61 62 struct dwc_otg_std_temp { 63 dwc_otg_cmd_t *func; 64 struct usb_page_cache *pc; 65 struct dwc_otg_td *td; 66 struct dwc_otg_td *td_next; 67 uint32_t len; 68 uint32_t offset; 69 uint16_t max_frame_size; 70 uint8_t short_pkt; 71 /* 72 * short_pkt = 0: transfer should be short terminated 73 * short_pkt = 1: transfer should not be short terminated 74 */ 75 uint8_t setup_alt_next; 76 uint8_t did_stall; 77 uint8_t bulk_or_control; 78 }; 79 80 struct dwc_otg_config_desc { 81 struct usb_config_descriptor confd; 82 struct usb_interface_descriptor ifcd; 83 struct usb_endpoint_descriptor endpd; 84 } __packed; 85 86 union dwc_otg_hub_temp { 87 uWord wValue; 88 struct usb_port_status ps; 89 }; 90 91 struct dwc_otg_flags { 92 uint8_t change_connect:1; 93 uint8_t change_suspend:1; 94 uint8_t status_suspend:1; /* set if suspended */ 95 uint8_t status_vbus:1; /* set if present */ 96 uint8_t status_bus_reset:1; /* set if reset complete */ 97 uint8_t status_high_speed:1; /* set if High Speed is selected */ 98 uint8_t remote_wakeup:1; 99 uint8_t self_powered:1; 100 uint8_t clocks_off:1; 101 uint8_t port_powered:1; 102 uint8_t port_enabled:1; 103 uint8_t d_pulled_up:1; 104 }; 105 106 struct dwc_otg_profile { 107 struct usb_hw_ep_profile usb; 108 uint16_t max_buffer; 109 }; 110 111 struct dwc_otg_softc { 112 struct usb_bus sc_bus; 113 union dwc_otg_hub_temp sc_hub_temp; 114 struct dwc_otg_profile sc_hw_ep_profile[16]; 115 116 struct usb_device *sc_devices[DWC_OTG_MAX_DEVICES]; 117 struct resource *sc_io_res; 118 struct resource *sc_irq_res; 119 void *sc_intr_hdl; 120 bus_size_t sc_io_size; 121 bus_space_tag_t sc_io_tag; 122 bus_space_handle_t sc_io_hdl; 123 124 uint32_t sc_rx_bounce_buffer[1024 / 4]; 125 uint32_t sc_tx_bounce_buffer[(512 * DWC_OTG_MAX_TXP) / 4]; 126 127 uint32_t sc_fifo_size; 128 uint32_t sc_irq_mask; 129 uint32_t sc_last_rx_status; 130 uint32_t sc_out_ctl[16]; 131 uint32_t sc_in_ctl[16]; 132 133 uint16_t sc_active_out_ep; 134 135 uint8_t sc_dev_ep_max; 136 uint8_t sc_dev_in_ep_max; 137 uint8_t sc_rt_addr; /* root HUB address */ 138 uint8_t sc_conf; /* root HUB config */ 139 140 uint8_t sc_hub_idata[1]; 141 142 struct dwc_otg_flags sc_flags; 143 }; 144 145 /* prototypes */ 146 147 void dwc_otg_interrupt(struct dwc_otg_softc *); 148 int dwc_otg_init(struct dwc_otg_softc *); 149 void dwc_otg_uninit(struct dwc_otg_softc *); 150 151 #endif /* _DWC_OTG_H_ */ 152