1 /* $NetBSD: uhcivar.h,v 1.33 2002/02/11 11:41:30 augustss Exp $ */
5 * Copyright (c) 1998 The NetBSD Foundation, Inc.
8 * This code is derived from software contributed to The NetBSD Foundation
9 * by Lennart Augustsson (lennart@augustsson.net) at
10 * Carlstedt Research & Technology.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
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.
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.
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
53 * UHCI_VFRAMELIST_COUNT should be a power of 2 and <= UHCI_FRAMELIST_COUNT.
55 #define UHCI_VFRAMELIST_COUNT 128
57 typedef struct uhci_soft_qh uhci_soft_qh_t;
58 typedef struct uhci_soft_td uhci_soft_td_t;
61 struct uhci_soft_qh *sqh;
62 struct uhci_soft_td *std;
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.
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;
84 struct usbd_xfer xfer;
85 uhci_intr_info_t iinfo;
86 struct usb_task abort_task;
88 u_int32_t uhci_xfer_flags;
91 #define UHCI_XFER_ABORTING 0x0001 /* xfer is aborting. */
92 #define UHCI_XFER_ABORTWAIT 0x0002 /* abort completion is being awaited. */
94 #define UXFER(xfer) ((struct uhci_xfer *)(xfer))
97 * Extra information that we need for a TD.
100 uhci_td_t td; /* The real TD, must be first */
101 uhci_soft_td_qh_t link; /* soft version of the td_link field */
102 uhci_physaddr_t physaddr; /* TD's physical address. */
103 usb_dma_t aux_dma; /* Auxillary storage if needed. */
104 void *aux_data; /* Original aux data virtual address. */
105 int aux_len; /* Auxillary storage size. */
108 * Make the size such that it is a multiple of UHCI_TD_ALIGN. This way
109 * we can pack a number of soft TD together and have the real TD well
111 * NOTE: Minimum size is 32 bytes.
113 #define UHCI_STD_SIZE ((sizeof (struct uhci_soft_td) + UHCI_TD_ALIGN - 1) / UHCI_TD_ALIGN * UHCI_TD_ALIGN)
114 #define UHCI_STD_CHUNK (PAGE_SIZE / UHCI_STD_SIZE)
117 * Extra information that we need for a QH.
119 struct uhci_soft_qh {
120 uhci_qh_t qh; /* The real QH, must be first */
121 uhci_soft_qh_t *hlink; /* soft version of qh_hlink */
122 uhci_soft_td_t *elink; /* soft version of qh_elink */
123 uhci_physaddr_t physaddr; /* QH's physical address. */
124 int pos; /* Timeslot position */
126 /* See comment about UHCI_STD_SIZE. */
127 #define UHCI_SQH_SIZE ((sizeof (struct uhci_soft_qh) + UHCI_QH_ALIGN - 1) / UHCI_QH_ALIGN * UHCI_QH_ALIGN)
128 #define UHCI_SQH_CHUNK (PAGE_SIZE / UHCI_SQH_SIZE)
131 * Information about an entry in the virtual frame list.
134 uhci_soft_td_t *htd; /* pointer to dummy TD */
135 uhci_soft_td_t *etd; /* pointer to last TD */
136 uhci_soft_qh_t *hqh; /* pointer to dummy QH */
137 uhci_soft_qh_t *eqh; /* pointer to last QH */
138 u_int bandwidth; /* max bandwidth used by this frame */
141 #define UHCI_SCFLG_DONEINIT 0x0001 /* uhci_init() done */
143 typedef struct uhci_softc {
144 struct usbd_bus sc_bus; /* base device */
147 bus_space_handle_t ioh;
151 struct resource *io_res;
152 struct resource *irq_res;
153 uhci_physaddr_t *sc_pframes;
155 struct uhci_vframe sc_vframes[UHCI_VFRAMELIST_COUNT];
157 uhci_soft_qh_t *sc_lctl_start; /* dummy QH for low speed control */
158 uhci_soft_qh_t *sc_lctl_end; /* last control QH */
159 uhci_soft_qh_t *sc_hctl_start; /* dummy QH for high speed control */
160 uhci_soft_qh_t *sc_hctl_end; /* last control QH */
161 uhci_soft_qh_t *sc_bulk_start; /* dummy QH for bulk */
162 uhci_soft_qh_t *sc_bulk_end; /* last bulk transfer */
163 uhci_soft_qh_t *sc_last_qh; /* dummy QH at the end */
164 u_int32_t sc_loops; /* number of QHs that wants looping */
166 uhci_soft_td_t *sc_freetds; /* TD free list */
167 uhci_soft_qh_t *sc_freeqhs; /* QH free list */
169 STAILQ_HEAD(, usbd_xfer) sc_free_xfers; /* free xfers */
171 u_int8_t sc_addr; /* device address */
172 u_int8_t sc_conf; /* device configuration */
174 u_int8_t sc_saved_sof;
175 u_int16_t sc_saved_frnum;
177 #ifdef USB_USE_SOFTINTR
179 #endif /* USB_USE_SOFTINTR */
185 LIST_HEAD(, uhci_intr_info) sc_intrhead;
187 /* Info for the root hub interrupt channel. */
188 int sc_ival; /* time between root hub intrs */
189 usbd_xfer_handle sc_intr_xfer; /* root hub interrupt transfer */
190 struct callout sc_poll_handle;
192 char sc_vendor[16]; /* vendor string for root hub */
193 int sc_id_vendor; /* vendor ID for root hub */
195 #if defined(__NetBSD__)
196 void *sc_powerhook; /* cookie from power hook */
197 void *sc_shutdownhook; /* cookie from shutdown hook */
201 usbd_status uhci_init(uhci_softc_t *);
202 int uhci_intr(void *);
203 int uhci_detach(uhci_softc_t *, int);
204 void uhci_shutdown(void *v);
205 void uhci_power(int state, void *priv);