1 /* $NetBSD: ehcivar.h,v 1.31 2008/06/28 17:42:53 bouyer 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 usb_dma_t dma; /* qTD's DMA infos */ 37 int offs; /* qTD's offset in usb_dma_t */ 38 usbd_xfer_handle xfer; 39 LIST_ENTRY(ehci_soft_qtd) hnext; 40 u_int16_t len; 41 } ehci_soft_qtd_t; 42 #define EHCI_SQTD_SIZE ((sizeof (struct ehci_soft_qtd) + EHCI_QTD_ALIGN - 1) / EHCI_QTD_ALIGN * EHCI_QTD_ALIGN) 43 #define EHCI_SQTD_CHUNK (EHCI_PAGE_SIZE / EHCI_SQTD_SIZE) 44 45 typedef struct ehci_soft_qh { 46 ehci_qh_t qh; 47 struct ehci_soft_qh *next; 48 struct ehci_soft_qtd *sqtd; 49 ehci_physaddr_t physaddr; 50 usb_dma_t dma; /* QH's DMA infos */ 51 int offs; /* QH's offset in usb_dma_t */ 52 int islot; 53 } ehci_soft_qh_t; 54 #define EHCI_SQH_SIZE ((sizeof (struct ehci_soft_qh) + EHCI_QH_ALIGN - 1) / EHCI_QH_ALIGN * EHCI_QH_ALIGN) 55 #define EHCI_SQH_CHUNK (EHCI_PAGE_SIZE / EHCI_SQH_SIZE) 56 57 struct ehci_xfer { 58 struct usbd_xfer xfer; 59 struct usb_task abort_task; 60 LIST_ENTRY(ehci_xfer) inext; /* list of active xfers */ 61 ehci_soft_qtd_t *sqtdstart; 62 ehci_soft_qtd_t *sqtdend; 63 int isdone; /* used only when DIAGNOSTIC is defined */ 64 }; 65 #define EXFER(xfer) ((struct ehci_xfer *)(xfer)) 66 67 /* Information about an entry in the interrupt list. */ 68 struct ehci_soft_islot { 69 ehci_soft_qh_t *sqh; /* Queue Head. */ 70 }; 71 72 #define EHCI_FRAMELIST_MAXCOUNT 1024 73 #define EHCI_IPOLLRATES 8 /* Poll rates (1ms, 2, 4, 8 .. 128) */ 74 #define EHCI_INTRQHS ((1 << EHCI_IPOLLRATES) - 1) 75 #define EHCI_MAX_POLLRATE (1 << (EHCI_IPOLLRATES - 1)) 76 #define EHCI_IQHIDX(lev, pos) \ 77 ((((pos) & ((1 << (lev)) - 1)) | (1 << (lev))) - 1) 78 #define EHCI_ILEV_IVAL(lev) (1 << (lev)) 79 80 81 #define EHCI_HASH_SIZE 128 82 #define EHCI_COMPANION_MAX 8 83 84 typedef struct ehci_softc { 85 device_t sc_dev; 86 struct usbd_bus sc_bus; 87 bus_space_tag_t iot; 88 bus_space_handle_t ioh; 89 bus_size_t sc_size; 90 u_int sc_offs; /* offset to operational regs */ 91 int sc_flags; /* misc flags */ 92 #define EHCIF_DROPPED_INTR_WORKAROUND 0x01 93 94 char sc_vendor[32]; /* vendor string for root hub */ 95 int sc_id_vendor; /* vendor ID for root hub */ 96 97 u_int32_t sc_cmd; /* shadow of cmd reg during suspend */ 98 99 u_int sc_ncomp; 100 u_int sc_npcomp; 101 device_t sc_comps[EHCI_COMPANION_MAX]; 102 103 usb_dma_t sc_fldma; 104 ehci_link_t *sc_flist; 105 u_int sc_flsize; 106 u_int sc_rand; /* XXX need proper intr scheduling */ 107 108 struct ehci_soft_islot sc_islots[EHCI_INTRQHS]; 109 110 LIST_HEAD(, ehci_xfer) sc_intrhead; 111 112 ehci_soft_qh_t *sc_freeqhs; 113 ehci_soft_qtd_t *sc_freeqtds; 114 115 int sc_noport; 116 u_int8_t sc_hasppc; /* has Port Power Control */ 117 u_int8_t sc_addr; /* device address */ 118 u_int8_t sc_conf; /* device configuration */ 119 usbd_xfer_handle sc_intrxfer; 120 char sc_isreset[EHCI_MAX_PORTS]; 121 #ifdef USB_USE_SOFTINTR 122 char sc_softwake; 123 #endif /* USB_USE_SOFTINTR */ 124 125 u_int32_t sc_eintrs; 126 ehci_soft_qh_t *sc_async_head; 127 128 SIMPLEQ_HEAD(, usbd_xfer) sc_free_xfers; /* free xfers */ 129 130 kmutex_t sc_doorbell_lock; 131 132 usb_callout_t sc_tmo_intrlist; 133 134 #if defined(__NetBSD__) || defined(__OpenBSD__) 135 device_ptr_t sc_child; /* /dev/usb# device */ 136 #endif 137 char sc_dying; 138 #if defined(__NetBSD__) 139 struct usb_dma_reserve sc_dma_reserve; 140 #endif 141 } ehci_softc_t; 142 143 #define EREAD1(sc, a) bus_space_read_1((sc)->iot, (sc)->ioh, (a)) 144 #define EREAD2(sc, a) bus_space_read_2((sc)->iot, (sc)->ioh, (a)) 145 #define EREAD4(sc, a) bus_space_read_4((sc)->iot, (sc)->ioh, (a)) 146 #define EWRITE1(sc, a, x) bus_space_write_1((sc)->iot, (sc)->ioh, (a), (x)) 147 #define EWRITE2(sc, a, x) bus_space_write_2((sc)->iot, (sc)->ioh, (a), (x)) 148 #define EWRITE4(sc, a, x) bus_space_write_4((sc)->iot, (sc)->ioh, (a), (x)) 149 #define EOREAD1(sc, a) bus_space_read_1((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a)) 150 #define EOREAD2(sc, a) bus_space_read_2((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a)) 151 #define EOREAD4(sc, a) bus_space_read_4((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a)) 152 #define EOWRITE1(sc, a, x) bus_space_write_1((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a), (x)) 153 #define EOWRITE2(sc, a, x) bus_space_write_2((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a), (x)) 154 #define EOWRITE4(sc, a, x) bus_space_write_4((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a), (x)) 155 156 usbd_status ehci_init(ehci_softc_t *); 157 int ehci_intr(void *); 158 int ehci_detach(ehci_softc_t *, int); 159 int ehci_activate(device_t, enum devact); 160 void ehci_childdet(device_t, device_t); 161 bool ehci_suspend(device_t PMF_FN_PROTO); 162 bool ehci_resume(device_t PMF_FN_PROTO); 163 bool ehci_shutdown(device_t, int); 164