1 /* $NetBSD: ehcivar.h,v 1.12 2001/12/31 12:16:57 augustss 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 } ehci_soft_qh_t; 56 #define EHCI_SQH_SIZE ((sizeof (struct ehci_soft_qh) + EHCI_QH_ALIGN - 1) / EHCI_QH_ALIGN * EHCI_QH_ALIGN) 57 #define EHCI_SQH_CHUNK (EHCI_PAGE_SIZE / EHCI_SQH_SIZE) 58 59 struct ehci_xfer { 60 struct usbd_xfer xfer; 61 struct usb_task abort_task; 62 LIST_ENTRY(ehci_xfer) inext; /* list of active xfers */ 63 ehci_soft_qtd_t *sqtdstart; 64 ehci_soft_qtd_t *sqtdend; 65 #ifdef DIAGNOSTIC 66 int isdone; 67 #endif 68 }; 69 #define EXFER(xfer) ((struct ehci_xfer *)(xfer)) 70 71 72 #define EHCI_HASH_SIZE 128 73 #define EHCI_COMPANION_MAX 8 74 75 typedef struct ehci_softc { 76 struct usbd_bus sc_bus; /* base device */ 77 bus_space_tag_t iot; 78 bus_space_handle_t ioh; 79 bus_size_t sc_size; 80 u_int sc_offs; /* offset to operational regs */ 81 82 char sc_vendor[16]; /* vendor string for root hub */ 83 int sc_id_vendor; /* vendor ID for root hub */ 84 85 void *sc_powerhook; /* cookie from power hook */ 86 void *sc_shutdownhook; /* cookie from shutdown hook */ 87 88 u_int sc_ncomp; 89 u_int sc_npcomp; 90 struct usbd_bus *sc_comps[EHCI_COMPANION_MAX]; 91 92 usb_dma_t sc_fldma; 93 u_int sc_flsize; 94 95 LIST_HEAD(, ehci_xfer) sc_intrhead; 96 97 ehci_soft_qh_t *sc_freeqhs; 98 ehci_soft_qtd_t *sc_freeqtds; 99 100 int sc_noport; 101 u_int8_t sc_addr; /* device address */ 102 u_int8_t sc_conf; /* device configuration */ 103 usbd_xfer_handle sc_intrxfer; 104 char sc_isreset; 105 char sc_softwake; 106 107 u_int32_t sc_eintrs; 108 ehci_soft_qh_t *sc_async_head; 109 110 SIMPLEQ_HEAD(, usbd_xfer) sc_free_xfers; /* free xfers */ 111 112 struct lock sc_doorbell_lock; 113 114 usb_callout_t sc_tmo_pcd; 115 116 device_ptr_t sc_child; /* /dev/usb# device */ 117 118 char sc_dying; 119 } ehci_softc_t; 120 121 #define EREAD1(sc, a) bus_space_read_1((sc)->iot, (sc)->ioh, (a)) 122 #define EREAD2(sc, a) bus_space_read_2((sc)->iot, (sc)->ioh, (a)) 123 #define EREAD4(sc, a) bus_space_read_4((sc)->iot, (sc)->ioh, (a)) 124 #define EWRITE1(sc, a, x) bus_space_write_1((sc)->iot, (sc)->ioh, (a), (x)) 125 #define EWRITE2(sc, a, x) bus_space_write_2((sc)->iot, (sc)->ioh, (a), (x)) 126 #define EWRITE4(sc, a, x) bus_space_write_4((sc)->iot, (sc)->ioh, (a), (x)) 127 #define EOREAD1(sc, a) bus_space_read_1((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a)) 128 #define EOREAD2(sc, a) bus_space_read_2((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a)) 129 #define EOREAD4(sc, a) bus_space_read_4((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a)) 130 #define EOWRITE1(sc, a, x) bus_space_write_1((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a), (x)) 131 #define EOWRITE2(sc, a, x) bus_space_write_2((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a), (x)) 132 #define EOWRITE4(sc, a, x) bus_space_write_4((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a), (x)) 133 134 usbd_status ehci_init(ehci_softc_t *); 135 int ehci_intr(void *); 136 int ehci_detach(ehci_softc_t *, int); 137 int ehci_activate(device_ptr_t, enum devact); 138