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