1 /* $NetBSD: ehcivar.h,v 1.30 2008/04/28 20:23:58 martin 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 * 19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 * POSSIBILITY OF SUCH DAMAGE. 30 */ 31 32 typedef struct ehci_soft_qtd { 33 ehci_qtd_t qtd; 34 struct ehci_soft_qtd *nextqtd; /* mirrors nextqtd in TD */ 35 ehci_physaddr_t physaddr; 36 usbd_xfer_handle xfer; 37 LIST_ENTRY(ehci_soft_qtd) hnext; 38 u_int16_t len; 39 } ehci_soft_qtd_t; 40 #define EHCI_SQTD_SIZE ((sizeof (struct ehci_soft_qtd) + EHCI_QTD_ALIGN - 1) / EHCI_QTD_ALIGN * EHCI_QTD_ALIGN) 41 #define EHCI_SQTD_CHUNK (EHCI_PAGE_SIZE / EHCI_SQTD_SIZE) 42 43 typedef struct ehci_soft_qh { 44 ehci_qh_t qh; 45 struct ehci_soft_qh *next; 46 struct ehci_soft_qtd *sqtd; 47 ehci_physaddr_t physaddr; 48 int islot; 49 } ehci_soft_qh_t; 50 #define EHCI_SQH_SIZE ((sizeof (struct ehci_soft_qh) + EHCI_QH_ALIGN - 1) / EHCI_QH_ALIGN * EHCI_QH_ALIGN) 51 #define EHCI_SQH_CHUNK (EHCI_PAGE_SIZE / EHCI_SQH_SIZE) 52 53 struct ehci_xfer { 54 struct usbd_xfer xfer; 55 struct usb_task abort_task; 56 LIST_ENTRY(ehci_xfer) inext; /* list of active xfers */ 57 ehci_soft_qtd_t *sqtdstart; 58 ehci_soft_qtd_t *sqtdend; 59 int isdone; /* used only when DIAGNOSTIC is defined */ 60 }; 61 #define EXFER(xfer) ((struct ehci_xfer *)(xfer)) 62 63 /* Information about an entry in the interrupt list. */ 64 struct ehci_soft_islot { 65 ehci_soft_qh_t *sqh; /* Queue Head. */ 66 }; 67 68 #define EHCI_FRAMELIST_MAXCOUNT 1024 69 #define EHCI_IPOLLRATES 8 /* Poll rates (1ms, 2, 4, 8 .. 128) */ 70 #define EHCI_INTRQHS ((1 << EHCI_IPOLLRATES) - 1) 71 #define EHCI_MAX_POLLRATE (1 << (EHCI_IPOLLRATES - 1)) 72 #define EHCI_IQHIDX(lev, pos) \ 73 ((((pos) & ((1 << (lev)) - 1)) | (1 << (lev))) - 1) 74 #define EHCI_ILEV_IVAL(lev) (1 << (lev)) 75 76 77 #define EHCI_HASH_SIZE 128 78 #define EHCI_COMPANION_MAX 8 79 80 typedef struct ehci_softc { 81 device_t sc_dev; 82 struct usbd_bus sc_bus; 83 bus_space_tag_t iot; 84 bus_space_handle_t ioh; 85 bus_size_t sc_size; 86 u_int sc_offs; /* offset to operational regs */ 87 int sc_flags; /* misc flags */ 88 #define EHCIF_DROPPED_INTR_WORKAROUND 0x01 89 90 char sc_vendor[32]; /* vendor string for root hub */ 91 int sc_id_vendor; /* vendor ID for root hub */ 92 93 u_int32_t sc_cmd; /* shadow of cmd reg during suspend */ 94 95 u_int sc_ncomp; 96 u_int sc_npcomp; 97 device_t sc_comps[EHCI_COMPANION_MAX]; 98 99 usb_dma_t sc_fldma; 100 ehci_link_t *sc_flist; 101 u_int sc_flsize; 102 u_int sc_rand; /* XXX need proper intr scheduling */ 103 104 struct ehci_soft_islot sc_islots[EHCI_INTRQHS]; 105 106 LIST_HEAD(, ehci_xfer) sc_intrhead; 107 108 ehci_soft_qh_t *sc_freeqhs; 109 ehci_soft_qtd_t *sc_freeqtds; 110 111 int sc_noport; 112 u_int8_t sc_hasppc; /* has Port Power Control */ 113 u_int8_t sc_addr; /* device address */ 114 u_int8_t sc_conf; /* device configuration */ 115 usbd_xfer_handle sc_intrxfer; 116 char sc_isreset[EHCI_MAX_PORTS]; 117 #ifdef USB_USE_SOFTINTR 118 char sc_softwake; 119 #endif /* USB_USE_SOFTINTR */ 120 121 u_int32_t sc_eintrs; 122 ehci_soft_qh_t *sc_async_head; 123 124 SIMPLEQ_HEAD(, usbd_xfer) sc_free_xfers; /* free xfers */ 125 126 kmutex_t sc_doorbell_lock; 127 128 usb_callout_t sc_tmo_intrlist; 129 130 #if defined(__NetBSD__) || defined(__OpenBSD__) 131 device_ptr_t sc_child; /* /dev/usb# device */ 132 #endif 133 char sc_dying; 134 #if defined(__NetBSD__) 135 struct usb_dma_reserve sc_dma_reserve; 136 #endif 137 } ehci_softc_t; 138 139 #define EREAD1(sc, a) bus_space_read_1((sc)->iot, (sc)->ioh, (a)) 140 #define EREAD2(sc, a) bus_space_read_2((sc)->iot, (sc)->ioh, (a)) 141 #define EREAD4(sc, a) bus_space_read_4((sc)->iot, (sc)->ioh, (a)) 142 #define EWRITE1(sc, a, x) bus_space_write_1((sc)->iot, (sc)->ioh, (a), (x)) 143 #define EWRITE2(sc, a, x) bus_space_write_2((sc)->iot, (sc)->ioh, (a), (x)) 144 #define EWRITE4(sc, a, x) bus_space_write_4((sc)->iot, (sc)->ioh, (a), (x)) 145 #define EOREAD1(sc, a) bus_space_read_1((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a)) 146 #define EOREAD2(sc, a) bus_space_read_2((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a)) 147 #define EOREAD4(sc, a) bus_space_read_4((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a)) 148 #define EOWRITE1(sc, a, x) bus_space_write_1((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a), (x)) 149 #define EOWRITE2(sc, a, x) bus_space_write_2((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a), (x)) 150 #define EOWRITE4(sc, a, x) bus_space_write_4((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a), (x)) 151 152 usbd_status ehci_init(ehci_softc_t *); 153 int ehci_intr(void *); 154 int ehci_detach(ehci_softc_t *, int); 155 int ehci_activate(device_t, enum devact); 156 void ehci_childdet(device_t, device_t); 157 bool ehci_suspend(device_t PMF_FN_PROTO); 158 bool ehci_resume(device_t PMF_FN_PROTO); 159 bool ehci_shutdown(device_t, int); 160