1 /* $NetBSD: uhcivar.h,v 1.33 2002/02/11 11:41:30 augustss Exp $ */ 2 /* $FreeBSD: src/sys/dev/usb/uhcivar.h,v 1.14 1999/11/17 22:33:42 n_hibma Exp $ */ 3 4 /* 5 * Copyright (c) 1998 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) at 10 * Carlstedt Research & Technology. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice, this list of conditions and the following disclaimer. 17 * 2. Redistributions in binary form must reproduce the above copyright 18 * notice, this list of conditions and the following disclaimer in the 19 * documentation and/or other materials provided with the distribution. 20 * 3. All advertising materials mentioning features or use of this software 21 * must display the following acknowledgement: 22 * This product includes software developed by the NetBSD 23 * Foundation, Inc. and its contributors. 24 * 4. Neither the name of The NetBSD Foundation nor the names of its 25 * contributors may be used to endorse or promote products derived 26 * from this software without specific prior written permission. 27 * 28 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 29 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 31 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 32 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 33 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 34 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 35 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 36 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 37 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 38 * POSSIBILITY OF SUCH DAMAGE. 39 */ 40 41 /* 42 * To avoid having 1024 TDs for each isochronous transfer we introduce 43 * a virtual frame list. Every UHCI_VFRAMELIST_COUNT entries in the real 44 * frame list points to a non-active TD. These, in turn, form the 45 * starts of the virtual frame list. This also has the advantage that it 46 * simplifies linking in/out of TDs/QHs in the schedule. 47 * Furthermore, initially each of the inactive TDs point to an inactive 48 * QH that forms the start of the interrupt traffic for that slot. 49 * Each of these QHs point to the same QH that is the start of control 50 * traffic. This QH points at another QH which is the start of the 51 * bulk traffic. 52 * 53 * UHCI_VFRAMELIST_COUNT should be a power of 2 and <= UHCI_FRAMELIST_COUNT. 54 */ 55 #define UHCI_VFRAMELIST_COUNT 128 56 57 typedef struct uhci_soft_qh uhci_soft_qh_t; 58 typedef struct uhci_soft_td uhci_soft_td_t; 59 60 typedef union { 61 struct uhci_soft_qh *sqh; 62 struct uhci_soft_td *std; 63 } uhci_soft_td_qh_t; 64 65 /* 66 * An interrupt info struct contains the information needed to 67 * execute a requested routine when the controller generates an 68 * interrupt. Since we cannot know which transfer generated 69 * the interrupt all structs are linked together so they can be 70 * searched at interrupt time. 71 */ 72 typedef struct uhci_intr_info { 73 struct uhci_softc *sc; 74 usbd_xfer_handle xfer; 75 uhci_soft_td_t *stdstart; 76 uhci_soft_td_t *stdend; 77 LIST_ENTRY(uhci_intr_info) list; 78 #ifdef DIAGNOSTIC 79 int isdone; 80 #endif 81 } uhci_intr_info_t; 82 83 struct uhci_xfer { 84 struct usbd_xfer xfer; 85 uhci_intr_info_t iinfo; 86 struct usb_task abort_task; 87 int curframe; 88 }; 89 90 #define UXFER(xfer) ((struct uhci_xfer *)(xfer)) 91 92 /* 93 * Extra information that we need for a TD. 94 */ 95 struct uhci_soft_td { 96 uhci_td_t td; /* The real TD, must be first */ 97 uhci_soft_td_qh_t link; /* soft version of the td_link field */ 98 uhci_physaddr_t physaddr; /* TD's physical address. */ 99 }; 100 /* 101 * Make the size such that it is a multiple of UHCI_TD_ALIGN. This way 102 * we can pack a number of soft TD together and have the real TD well 103 * aligned. 104 * NOTE: Minimum size is 32 bytes. 105 */ 106 #define UHCI_STD_SIZE ((sizeof (struct uhci_soft_td) + UHCI_TD_ALIGN - 1) / UHCI_TD_ALIGN * UHCI_TD_ALIGN) 107 #define UHCI_STD_CHUNK 128 /*(PAGE_SIZE / UHCI_TD_SIZE)*/ 108 109 /* 110 * Extra information that we need for a QH. 111 */ 112 struct uhci_soft_qh { 113 uhci_qh_t qh; /* The real QH, must be first */ 114 uhci_soft_qh_t *hlink; /* soft version of qh_hlink */ 115 uhci_soft_td_t *elink; /* soft version of qh_elink */ 116 uhci_physaddr_t physaddr; /* QH's physical address. */ 117 int pos; /* Timeslot position */ 118 }; 119 /* See comment about UHCI_STD_SIZE. */ 120 #define UHCI_SQH_SIZE ((sizeof (struct uhci_soft_qh) + UHCI_QH_ALIGN - 1) / UHCI_QH_ALIGN * UHCI_QH_ALIGN) 121 #define UHCI_SQH_CHUNK 128 /*(PAGE_SIZE / UHCI_QH_SIZE)*/ 122 123 /* 124 * Information about an entry in the virtual frame list. 125 */ 126 struct uhci_vframe { 127 uhci_soft_td_t *htd; /* pointer to dummy TD */ 128 uhci_soft_td_t *etd; /* pointer to last TD */ 129 uhci_soft_qh_t *hqh; /* pointer to dummy QH */ 130 uhci_soft_qh_t *eqh; /* pointer to last QH */ 131 u_int bandwidth; /* max bandwidth used by this frame */ 132 }; 133 134 typedef struct uhci_softc { 135 struct usbd_bus sc_bus; /* base device */ 136 bus_space_tag_t iot; 137 bus_space_handle_t ioh; 138 bus_size_t sc_size; 139 140 uhci_physaddr_t *sc_pframes; 141 usb_dma_t sc_dma; 142 struct uhci_vframe sc_vframes[UHCI_VFRAMELIST_COUNT]; 143 144 uhci_soft_qh_t *sc_lctl_start; /* dummy QH for low speed control */ 145 uhci_soft_qh_t *sc_lctl_end; /* last control QH */ 146 uhci_soft_qh_t *sc_hctl_start; /* dummy QH for high speed control */ 147 uhci_soft_qh_t *sc_hctl_end; /* last control QH */ 148 uhci_soft_qh_t *sc_bulk_start; /* dummy QH for bulk */ 149 uhci_soft_qh_t *sc_bulk_end; /* last bulk transfer */ 150 uhci_soft_qh_t *sc_last_qh; /* dummy QH at the end */ 151 u_int32_t sc_loops; /* number of QHs that wants looping */ 152 153 uhci_soft_td_t *sc_freetds; /* TD free list */ 154 uhci_soft_qh_t *sc_freeqhs; /* QH free list */ 155 156 SIMPLEQ_HEAD(, usbd_xfer) sc_free_xfers; /* free xfers */ 157 158 u_int8_t sc_addr; /* device address */ 159 u_int8_t sc_conf; /* device configuration */ 160 161 u_int8_t sc_saved_sof; 162 u_int16_t sc_saved_frnum; 163 164 char sc_softwake; 165 char sc_isreset; 166 char sc_suspend; 167 char sc_dying; 168 169 LIST_HEAD(, uhci_intr_info) sc_intrhead; 170 171 /* Info for the root hub interrupt "pipe". */ 172 int sc_ival; /* time between root hub intrs */ 173 usbd_xfer_handle sc_intr_xfer; /* root hub interrupt transfer */ 174 usb_callout_t sc_poll_handle; 175 176 char sc_vendor[16]; /* vendor string for root hub */ 177 int sc_id_vendor; /* vendor ID for root hub */ 178 179 void *sc_powerhook; /* cookie from power hook */ 180 void *sc_shutdownhook; /* cookie from shutdown hook */ 181 182 device_ptr_t sc_child; /* /dev/usb# device */ 183 } uhci_softc_t; 184 185 usbd_status uhci_init(uhci_softc_t *); 186 int uhci_intr(void *); 187 #if defined(__NetBSD__) || defined(__OpenBSD__) 188 int uhci_detach(uhci_softc_t *, int); 189 int uhci_activate(device_ptr_t, enum devact); 190 #endif 191 192