1 /* $NetBSD: ehcivar.h,v 1.26 2007/12/09 20:28:23 jmcneill Exp $ */ 2 3 /* 4 * Copyright (c) 2001 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Lennart Augustsson (lennart@augustsson.net). 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 3. All advertising materials mentioning features or use of this software 19 * must display the following acknowledgement: 20 * This product includes software developed by the NetBSD 21 * Foundation, Inc. and its contributors. 22 * 4. Neither the name of The NetBSD Foundation nor the names of its 23 * contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 36 * POSSIBILITY OF SUCH DAMAGE. 37 */ 38 39 typedef struct ehci_soft_qtd { 40 ehci_qtd_t qtd; 41 struct ehci_soft_qtd *nextqtd; /* mirrors nextqtd in TD */ 42 ehci_physaddr_t physaddr; 43 usbd_xfer_handle xfer; 44 LIST_ENTRY(ehci_soft_qtd) hnext; 45 u_int16_t len; 46 } ehci_soft_qtd_t; 47 #define EHCI_SQTD_SIZE ((sizeof (struct ehci_soft_qtd) + EHCI_QTD_ALIGN - 1) / EHCI_QTD_ALIGN * EHCI_QTD_ALIGN) 48 #define EHCI_SQTD_CHUNK (EHCI_PAGE_SIZE / EHCI_SQTD_SIZE) 49 50 typedef struct ehci_soft_qh { 51 ehci_qh_t qh; 52 struct ehci_soft_qh *next; 53 struct ehci_soft_qtd *sqtd; 54 ehci_physaddr_t physaddr; 55 int islot; 56 } ehci_soft_qh_t; 57 #define EHCI_SQH_SIZE ((sizeof (struct ehci_soft_qh) + EHCI_QH_ALIGN - 1) / EHCI_QH_ALIGN * EHCI_QH_ALIGN) 58 #define EHCI_SQH_CHUNK (EHCI_PAGE_SIZE / EHCI_SQH_SIZE) 59 60 struct ehci_xfer { 61 struct usbd_xfer xfer; 62 struct usb_task abort_task; 63 LIST_ENTRY(ehci_xfer) inext; /* list of active xfers */ 64 ehci_soft_qtd_t *sqtdstart; 65 ehci_soft_qtd_t *sqtdend; 66 int isdone; /* used only when DIAGNOSTIC is defined */ 67 }; 68 #define EXFER(xfer) ((struct ehci_xfer *)(xfer)) 69 70 /* Information about an entry in the interrupt list. */ 71 struct ehci_soft_islot { 72 ehci_soft_qh_t *sqh; /* Queue Head. */ 73 }; 74 75 #define EHCI_FRAMELIST_MAXCOUNT 1024 76 #define EHCI_IPOLLRATES 8 /* Poll rates (1ms, 2, 4, 8 .. 128) */ 77 #define EHCI_INTRQHS ((1 << EHCI_IPOLLRATES) - 1) 78 #define EHCI_MAX_POLLRATE (1 << (EHCI_IPOLLRATES - 1)) 79 #define EHCI_IQHIDX(lev, pos) \ 80 ((((pos) & ((1 << (lev)) - 1)) | (1 << (lev))) - 1) 81 #define EHCI_ILEV_IVAL(lev) (1 << (lev)) 82 83 84 #define EHCI_HASH_SIZE 128 85 #define EHCI_COMPANION_MAX 8 86 87 typedef struct ehci_softc { 88 struct usbd_bus sc_bus; /* base device */ 89 bus_space_tag_t iot; 90 bus_space_handle_t ioh; 91 bus_size_t sc_size; 92 u_int sc_offs; /* offset to operational regs */ 93 int sc_flags; /* misc flags */ 94 #define EHCIF_DROPPED_INTR_WORKAROUND 0x01 95 96 char sc_vendor[32]; /* vendor string for root hub */ 97 int sc_id_vendor; /* vendor ID for root hub */ 98 99 u_int32_t sc_cmd; /* shadow of cmd reg during suspend */ 100 void *sc_shutdownhook; /* cookie from shutdown hook */ 101 102 u_int sc_ncomp; 103 u_int sc_npcomp; 104 struct usbd_bus *sc_comps[EHCI_COMPANION_MAX]; 105 106 usb_dma_t sc_fldma; 107 ehci_link_t *sc_flist; 108 u_int sc_flsize; 109 u_int sc_rand; /* XXX need proper intr scheduling */ 110 111 struct ehci_soft_islot sc_islots[EHCI_INTRQHS]; 112 113 LIST_HEAD(, ehci_xfer) sc_intrhead; 114 115 ehci_soft_qh_t *sc_freeqhs; 116 ehci_soft_qtd_t *sc_freeqtds; 117 118 int sc_noport; 119 u_int8_t sc_hasppc; /* has Port Power Control */ 120 u_int8_t sc_addr; /* device address */ 121 u_int8_t sc_conf; /* device configuration */ 122 usbd_xfer_handle sc_intrxfer; 123 char sc_isreset[EHCI_MAX_PORTS]; 124 #ifdef USB_USE_SOFTINTR 125 char sc_softwake; 126 #endif /* USB_USE_SOFTINTR */ 127 128 u_int32_t sc_eintrs; 129 ehci_soft_qh_t *sc_async_head; 130 131 SIMPLEQ_HEAD(, usbd_xfer) sc_free_xfers; /* free xfers */ 132 133 kmutex_t sc_doorbell_lock; 134 135 usb_callout_t sc_tmo_intrlist; 136 137 #if defined(__NetBSD__) || defined(__OpenBSD__) 138 device_ptr_t sc_child; /* /dev/usb# device */ 139 #endif 140 char sc_dying; 141 #if defined(__NetBSD__) 142 struct usb_dma_reserve sc_dma_reserve; 143 #endif 144 } ehci_softc_t; 145 146 #define EREAD1(sc, a) bus_space_read_1((sc)->iot, (sc)->ioh, (a)) 147 #define EREAD2(sc, a) bus_space_read_2((sc)->iot, (sc)->ioh, (a)) 148 #define EREAD4(sc, a) bus_space_read_4((sc)->iot, (sc)->ioh, (a)) 149 #define EWRITE1(sc, a, x) bus_space_write_1((sc)->iot, (sc)->ioh, (a), (x)) 150 #define EWRITE2(sc, a, x) bus_space_write_2((sc)->iot, (sc)->ioh, (a), (x)) 151 #define EWRITE4(sc, a, x) bus_space_write_4((sc)->iot, (sc)->ioh, (a), (x)) 152 #define EOREAD1(sc, a) bus_space_read_1((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a)) 153 #define EOREAD2(sc, a) bus_space_read_2((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a)) 154 #define EOREAD4(sc, a) bus_space_read_4((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a)) 155 #define EOWRITE1(sc, a, x) bus_space_write_1((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a), (x)) 156 #define EOWRITE2(sc, a, x) bus_space_write_2((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a), (x)) 157 #define EOWRITE4(sc, a, x) bus_space_write_4((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a), (x)) 158 159 usbd_status ehci_init(ehci_softc_t *); 160 int ehci_intr(void *); 161 int ehci_detach(ehci_softc_t *, int); 162 int ehci_activate(device_ptr_t, enum devact); 163 bool ehci_suspend(device_t dv); 164 bool ehci_resume(device_t dv); 165