1 /* $NetBSD: ehcivar.h,v 1.12 2001/12/31 12:16:57 augustss Exp $ */
5 * Copyright (c) 2001 The NetBSD Foundation, Inc.
8 * This code is derived from software contributed to The NetBSD Foundation
9 * by Lennart Augustsson (lennart@augustsson.net).
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
40 typedef struct ehci_soft_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;
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)
51 typedef struct ehci_soft_qh {
53 struct ehci_soft_qh *next;
54 struct ehci_soft_qh *prev;
55 struct ehci_soft_qtd *sqtd;
56 ehci_physaddr_t physaddr;
57 int islot; /* Interrupt list slot. */
59 #define EHCI_SQH_SIZE ((sizeof (struct ehci_soft_qh) + EHCI_QH_ALIGN - 1) / EHCI_QH_ALIGN * EHCI_QH_ALIGN)
60 #define EHCI_SQH_CHUNK (EHCI_PAGE_SIZE / EHCI_SQH_SIZE)
63 struct usbd_xfer xfer;
64 struct usb_task abort_task;
65 LIST_ENTRY(ehci_xfer) inext; /* list of active xfers */
66 ehci_soft_qtd_t *sqtdstart;
67 ehci_soft_qtd_t *sqtdend;
72 #define EXFER(xfer) ((struct ehci_xfer *)(xfer))
75 * Information about an entry in the interrupt list.
77 struct ehci_soft_islot {
78 ehci_soft_qh_t *sqh; /* Queue Head. */
81 #define EHCI_FRAMELIST_MAXCOUNT 1024
82 #define EHCI_IPOLLRATES 8 /* Poll rates (1ms, 2, 4, 8 ... 128) */
83 #define EHCI_INTRQHS ((1 << EHCI_IPOLLRATES) - 1)
84 #define EHCI_IQHIDX(lev, pos) \
85 ((((pos) & ((1 << (lev)) - 1)) | (1 << (lev))) - 1)
86 #define EHCI_ILEV_IVAL(lev) (1 << (lev))
88 #define EHCI_HASH_SIZE 128
89 #define EHCI_COMPANION_MAX 8
91 #define EHCI_SCFLG_DONEINIT 0x0001 /* ehci_init() has been called. */
93 typedef struct ehci_softc {
94 struct usbd_bus sc_bus; /* base device */
97 bus_space_handle_t ioh;
99 #if defined(__FreeBSD__)
102 struct resource *io_res;
103 struct resource *irq_res;
105 u_int sc_offs; /* offset to operational regs */
107 char sc_vendor[16]; /* vendor string for root hub */
108 int sc_id_vendor; /* vendor ID for root hub */
110 u_int32_t sc_cmd; /* shadow of cmd reg during suspend */
111 #if defined(__NetBSD__) || defined(__OpenBSD__)
112 void *sc_powerhook; /* cookie from power hook */
113 void *sc_shutdownhook; /* cookie from shutdown hook */
118 struct usbd_bus *sc_comps[EHCI_COMPANION_MAX];
121 ehci_link_t *sc_flist;
124 struct ehci_soft_islot sc_islots[EHCI_INTRQHS];
126 LIST_HEAD(, ehci_xfer) sc_intrhead;
128 ehci_soft_qh_t *sc_freeqhs;
129 ehci_soft_qtd_t *sc_freeqtds;
132 u_int8_t sc_addr; /* device address */
133 u_int8_t sc_conf; /* device configuration */
134 usbd_xfer_handle sc_intrxfer;
136 #ifdef USB_USE_SOFTINTR
138 #endif /* USB_USE_SOFTINTR */
141 ehci_soft_qh_t *sc_async_head;
143 SIMPLEQ_HEAD(, usbd_xfer) sc_free_xfers; /* free xfers */
145 struct lock sc_doorbell_lock;
147 usb_callout_t sc_tmo_pcd;
149 device_ptr_t sc_child; /* /dev/usb# device */
154 #define EREAD1(sc, a) bus_space_read_1((sc)->iot, (sc)->ioh, (a))
155 #define EREAD2(sc, a) bus_space_read_2((sc)->iot, (sc)->ioh, (a))
156 #define EREAD4(sc, a) bus_space_read_4((sc)->iot, (sc)->ioh, (a))
157 #define EWRITE1(sc, a, x) bus_space_write_1((sc)->iot, (sc)->ioh, (a), (x))
158 #define EWRITE2(sc, a, x) bus_space_write_2((sc)->iot, (sc)->ioh, (a), (x))
159 #define EWRITE4(sc, a, x) bus_space_write_4((sc)->iot, (sc)->ioh, (a), (x))
160 #define EOREAD1(sc, a) bus_space_read_1((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a))
161 #define EOREAD2(sc, a) bus_space_read_2((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a))
162 #define EOREAD4(sc, a) bus_space_read_4((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a))
163 #define EOWRITE1(sc, a, x) bus_space_write_1((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a), (x))
164 #define EOWRITE2(sc, a, x) bus_space_write_2((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a), (x))
165 #define EOWRITE4(sc, a, x) bus_space_write_4((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a), (x))
167 usbd_status ehci_init(ehci_softc_t *);
168 int ehci_intr(void *);
169 int ehci_detach(ehci_softc_t *, int);
170 #if defined(__NetBSD__) || defined(__OpenBSD__)
171 int ehci_activate(device_ptr_t, enum devact);
173 void ehci_power(int state, void *priv);
174 void ehci_shutdown(void *v);
176 #define MS_TO_TICKS(ms) ((ms) * hz / 1000)