ehcivar.h revision 1.23.22.1 1 /* $NetBSD: ehcivar.h,v 1.23.22.1 2008/08/31 16:48:29 jdc 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 (at) 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 usb_dma_t dma; /* qTD's DMA infos */
44 int offs; /* qTD's offset in usb_dma_t */
45 usbd_xfer_handle xfer;
46 LIST_ENTRY(ehci_soft_qtd) hnext;
47 u_int16_t len;
48 } ehci_soft_qtd_t;
49 #define EHCI_SQTD_SIZE ((sizeof (struct ehci_soft_qtd) + EHCI_QTD_ALIGN - 1) / EHCI_QTD_ALIGN * EHCI_QTD_ALIGN)
50 #define EHCI_SQTD_CHUNK (EHCI_PAGE_SIZE / EHCI_SQTD_SIZE)
51
52 typedef struct ehci_soft_qh {
53 ehci_qh_t qh;
54 struct ehci_soft_qh *next;
55 struct ehci_soft_qtd *sqtd;
56 ehci_physaddr_t physaddr;
57 usb_dma_t dma; /* QH's DMA infos */
58 int offs; /* QH's offset in usb_dma_t */
59 int islot;
60 } ehci_soft_qh_t;
61 #define EHCI_SQH_SIZE ((sizeof (struct ehci_soft_qh) + EHCI_QH_ALIGN - 1) / EHCI_QH_ALIGN * EHCI_QH_ALIGN)
62 #define EHCI_SQH_CHUNK (EHCI_PAGE_SIZE / EHCI_SQH_SIZE)
63
64 struct ehci_xfer {
65 struct usbd_xfer xfer;
66 struct usb_task abort_task;
67 LIST_ENTRY(ehci_xfer) inext; /* list of active xfers */
68 ehci_soft_qtd_t *sqtdstart;
69 ehci_soft_qtd_t *sqtdend;
70 int isdone; /* used only when DIAGNOSTIC is defined */
71 };
72 #define EXFER(xfer) ((struct ehci_xfer *)(xfer))
73
74 /* Information about an entry in the interrupt list. */
75 struct ehci_soft_islot {
76 ehci_soft_qh_t *sqh; /* Queue Head. */
77 };
78
79 #define EHCI_FRAMELIST_MAXCOUNT 1024
80 #define EHCI_IPOLLRATES 8 /* Poll rates (1ms, 2, 4, 8 .. 128) */
81 #define EHCI_INTRQHS ((1 << EHCI_IPOLLRATES) - 1)
82 #define EHCI_MAX_POLLRATE (1 << (EHCI_IPOLLRATES - 1))
83 #define EHCI_IQHIDX(lev, pos) \
84 ((((pos) & ((1 << (lev)) - 1)) | (1 << (lev))) - 1)
85 #define EHCI_ILEV_IVAL(lev) (1 << (lev))
86
87
88 #define EHCI_HASH_SIZE 128
89 #define EHCI_COMPANION_MAX 8
90
91 typedef struct ehci_softc {
92 struct usbd_bus sc_bus; /* base device */
93 bus_space_tag_t iot;
94 bus_space_handle_t ioh;
95 bus_size_t sc_size;
96 u_int sc_offs; /* offset to operational regs */
97 int sc_flags; /* misc flags */
98 #define EHCIF_DROPPED_INTR_WORKAROUND 0x01
99
100 char sc_vendor[32]; /* vendor string for root hub */
101 int sc_id_vendor; /* vendor ID for root hub */
102
103 u_int32_t sc_cmd; /* shadow of cmd reg during suspend */
104 void *sc_powerhook; /* cookie from power hook */
105 void *sc_shutdownhook; /* cookie from shutdown hook */
106
107 u_int sc_ncomp;
108 u_int sc_npcomp;
109 struct usbd_bus *sc_comps[EHCI_COMPANION_MAX];
110
111 usb_dma_t sc_fldma;
112 ehci_link_t *sc_flist;
113 u_int sc_flsize;
114 u_int sc_rand; /* XXX need proper intr scheduling */
115
116 struct ehci_soft_islot sc_islots[EHCI_INTRQHS];
117
118 LIST_HEAD(, ehci_xfer) sc_intrhead;
119
120 ehci_soft_qh_t *sc_freeqhs;
121 ehci_soft_qtd_t *sc_freeqtds;
122
123 int sc_noport;
124 u_int8_t sc_hasppc; /* has Port Power Control */
125 u_int8_t sc_addr; /* device address */
126 u_int8_t sc_conf; /* device configuration */
127 usbd_xfer_handle sc_intrxfer;
128 char sc_isreset[EHCI_MAX_PORTS];
129 #ifdef USB_USE_SOFTINTR
130 char sc_softwake;
131 #endif /* USB_USE_SOFTINTR */
132
133 u_int32_t sc_eintrs;
134 ehci_soft_qh_t *sc_async_head;
135
136 SIMPLEQ_HEAD(, usbd_xfer) sc_free_xfers; /* free xfers */
137
138 struct lock sc_doorbell_lock;
139
140 usb_callout_t sc_tmo_pcd;
141 usb_callout_t sc_tmo_intrlist;
142
143 #if defined(__NetBSD__) || defined(__OpenBSD__)
144 device_ptr_t sc_child; /* /dev/usb# device */
145 #endif
146 char sc_dying;
147 #if defined(__NetBSD__)
148 struct usb_dma_reserve sc_dma_reserve;
149 #endif
150 } ehci_softc_t;
151
152 #define EREAD1(sc, a) bus_space_read_1((sc)->iot, (sc)->ioh, (a))
153 #define EREAD2(sc, a) bus_space_read_2((sc)->iot, (sc)->ioh, (a))
154 #define EREAD4(sc, a) bus_space_read_4((sc)->iot, (sc)->ioh, (a))
155 #define EWRITE1(sc, a, x) bus_space_write_1((sc)->iot, (sc)->ioh, (a), (x))
156 #define EWRITE2(sc, a, x) bus_space_write_2((sc)->iot, (sc)->ioh, (a), (x))
157 #define EWRITE4(sc, a, x) bus_space_write_4((sc)->iot, (sc)->ioh, (a), (x))
158 #define EOREAD1(sc, a) bus_space_read_1((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a))
159 #define EOREAD2(sc, a) bus_space_read_2((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a))
160 #define EOREAD4(sc, a) bus_space_read_4((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a))
161 #define EOWRITE1(sc, a, x) bus_space_write_1((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a), (x))
162 #define EOWRITE2(sc, a, x) bus_space_write_2((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a), (x))
163 #define EOWRITE4(sc, a, x) bus_space_write_4((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a), (x))
164
165 usbd_status ehci_init(ehci_softc_t *);
166 int ehci_intr(void *);
167 int ehci_detach(ehci_softc_t *, int);
168 int ehci_activate(device_ptr_t, enum devact);
169