ehcivar.h revision 1.16
1/* $NetBSD: ehcivar.h,v 1.16 2004/12/21 16:41:24 fvdl 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 39typedef 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 50typedef 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 60struct 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#ifdef DIAGNOSTIC 67 int isdone; 68#endif 69}; 70#define EXFER(xfer) ((struct ehci_xfer *)(xfer)) 71 72/* Information about an entry in the interrupt list. */ 73struct ehci_soft_islot { 74 ehci_soft_qh_t *sqh; /* Queue Head. */ 75}; 76 77#define EHCI_FRAMELIST_MAXCOUNT 1024 78#define EHCI_IPOLLRATES 8 /* Poll rates (1ms, 2, 4, 8 .. 128) */ 79#define EHCI_INTRQHS ((1 << EHCI_IPOLLRATES) - 1) 80#define EHCI_IQHIDX(lev, pos) \ 81 ((((pos) & ((1 << (lev)) - 1)) | (1 << (lev))) - 1) 82#define EHCI_ILEV_IVAL(lev) (1 << (lev)) 83 84 85#define EHCI_HASH_SIZE 128 86#define EHCI_COMPANION_MAX 8 87 88typedef struct ehci_softc { 89 struct usbd_bus sc_bus; /* base device */ 90 bus_space_tag_t iot; 91 bus_space_handle_t ioh; 92 bus_size_t sc_size; 93 u_int sc_offs; /* offset to operational regs */ 94 95 char sc_vendor[16]; /* vendor string for root hub */ 96 int sc_id_vendor; /* vendor ID for root hub */ 97 98 u_int32_t sc_cmd; /* shadow of cmd reg during suspend */ 99 void *sc_powerhook; /* cookie from power hook */ 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_addr; /* device address */ 120 u_int8_t sc_conf; /* device configuration */ 121 usbd_xfer_handle sc_intrxfer; 122 char sc_isreset; 123#ifdef USB_USE_SOFTINTR 124 char sc_softwake; 125#endif /* USB_USE_SOFTINTR */ 126 127 u_int32_t sc_eintrs; 128 ehci_soft_qh_t *sc_async_head; 129 130 SIMPLEQ_HEAD(, usbd_xfer) sc_free_xfers; /* free xfers */ 131 132 struct lock sc_doorbell_lock; 133 134 usb_callout_t sc_tmo_pcd; 135 136 device_ptr_t sc_child; /* /dev/usb# device */ 137 138 char sc_dying; 139#ifdef __NetBSD__ 140 struct usb_dma_reserve sc_dma_reserve; 141#endif 142} ehci_softc_t; 143 144#define EREAD1(sc, a) bus_space_read_1((sc)->iot, (sc)->ioh, (a)) 145#define EREAD2(sc, a) bus_space_read_2((sc)->iot, (sc)->ioh, (a)) 146#define EREAD4(sc, a) bus_space_read_4((sc)->iot, (sc)->ioh, (a)) 147#define EWRITE1(sc, a, x) bus_space_write_1((sc)->iot, (sc)->ioh, (a), (x)) 148#define EWRITE2(sc, a, x) bus_space_write_2((sc)->iot, (sc)->ioh, (a), (x)) 149#define EWRITE4(sc, a, x) bus_space_write_4((sc)->iot, (sc)->ioh, (a), (x)) 150#define EOREAD1(sc, a) bus_space_read_1((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a)) 151#define EOREAD2(sc, a) bus_space_read_2((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a)) 152#define EOREAD4(sc, a) bus_space_read_4((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a)) 153#define EOWRITE1(sc, a, x) bus_space_write_1((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a), (x)) 154#define EOWRITE2(sc, a, x) bus_space_write_2((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a), (x)) 155#define EOWRITE4(sc, a, x) bus_space_write_4((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a), (x)) 156 157usbd_status ehci_init(ehci_softc_t *); 158int ehci_intr(void *); 159int ehci_detach(ehci_softc_t *, int); 160int ehci_activate(device_ptr_t, enum devact); 161