FreeBSD/Linux Kernel Cross Reference
sys/dev/usb/ohcivar.h
1 /* $NetBSD: ohcivar.h,v 1.30 2001/12/31 12:20:35 augustss Exp $ */
2 /* $FreeBSD: src/sys/dev/usb/ohcivar.h,v 1.47 2007/06/14 16:23:31 imp 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 typedef struct ohci_soft_ed {
42 ohci_ed_t ed;
43 struct ohci_soft_ed *next;
44 ohci_physaddr_t physaddr;
45 } ohci_soft_ed_t;
46 #define OHCI_SED_SIZE ((sizeof (struct ohci_soft_ed) + OHCI_ED_ALIGN - 1) / OHCI_ED_ALIGN * OHCI_ED_ALIGN)
47 #define OHCI_SED_CHUNK (PAGE_SIZE / OHCI_SED_SIZE)
48
49 typedef struct ohci_soft_td {
50 ohci_td_t td;
51 struct ohci_soft_td *nexttd; /* mirrors nexttd in TD */
52 struct ohci_soft_td *dnext; /* next in done list */
53 ohci_physaddr_t physaddr;
54 LIST_ENTRY(ohci_soft_td) hnext;
55 usbd_xfer_handle xfer;
56 u_int16_t len;
57 u_int16_t flags;
58 #define OHCI_CALL_DONE 0x0001
59 #define OHCI_ADD_LEN 0x0002
60 } ohci_soft_td_t;
61 #define OHCI_STD_SIZE ((sizeof (struct ohci_soft_td) + OHCI_TD_ALIGN - 1) / OHCI_TD_ALIGN * OHCI_TD_ALIGN)
62 #define OHCI_STD_CHUNK (PAGE_SIZE / OHCI_STD_SIZE)
63
64 typedef struct ohci_soft_itd {
65 ohci_itd_t itd;
66 struct ohci_soft_itd *nextitd; /* mirrors nexttd in ITD */
67 struct ohci_soft_itd *dnext; /* next in done list */
68 ohci_physaddr_t physaddr;
69 LIST_ENTRY(ohci_soft_itd) hnext;
70 usbd_xfer_handle xfer;
71 u_int16_t flags;
72 #define OHCI_ITD_ACTIVE 0x0010 /* Hardware op in progress */
73 #define OHCI_ITD_INTFIN 0x0020 /* Hw completion interrupt seen.*/
74 #ifdef DIAGNOSTIC
75 char isdone;
76 #endif
77 } ohci_soft_itd_t;
78 #define OHCI_SITD_SIZE ((sizeof (struct ohci_soft_itd) + OHCI_ITD_ALIGN - 1) / OHCI_ITD_ALIGN * OHCI_ITD_ALIGN)
79 #define OHCI_SITD_CHUNK (PAGE_SIZE / OHCI_SITD_SIZE)
80
81 #define OHCI_NO_EDS (2*OHCI_NO_INTRS-1)
82
83 #define OHCI_HASH_SIZE 128
84
85 #define OHCI_SCFLG_DONEINIT 0x0001 /* ohci_init() done. */
86
87 typedef struct ohci_softc {
88 struct usbd_bus sc_bus; /* base device */
89 int sc_flags;
90 bus_space_tag_t iot;
91 bus_space_handle_t ioh;
92 bus_size_t sc_size;
93
94 void *ih;
95
96 struct resource *io_res;
97 struct resource *irq_res;
98
99 usb_dma_t sc_hccadma;
100 struct ohci_hcca *sc_hcca;
101 ohci_soft_ed_t *sc_eds[OHCI_NO_EDS];
102 u_int sc_bws[OHCI_NO_INTRS];
103
104 u_int32_t sc_eintrs; /* enabled interrupts */
105
106 ohci_soft_ed_t *sc_isoc_head;
107 ohci_soft_ed_t *sc_ctrl_head;
108 ohci_soft_ed_t *sc_bulk_head;
109
110 LIST_HEAD(, ohci_soft_td) sc_hash_tds[OHCI_HASH_SIZE];
111 LIST_HEAD(, ohci_soft_itd) sc_hash_itds[OHCI_HASH_SIZE];
112
113 int sc_noport;
114 u_int8_t sc_addr; /* device address */
115 u_int8_t sc_conf; /* device configuration */
116
117 #ifdef USB_USE_SOFTINTR
118 char sc_softwake;
119 #endif /* USB_USE_SOFTINTR */
120
121 ohci_soft_ed_t *sc_freeeds;
122 ohci_soft_td_t *sc_freetds;
123 ohci_soft_itd_t *sc_freeitds;
124
125 STAILQ_HEAD(, usbd_xfer) sc_free_xfers; /* free xfers */
126
127 usbd_xfer_handle sc_intrxfer;
128
129 ohci_soft_itd_t *sc_sidone;
130 ohci_soft_td_t *sc_sdone;
131
132 char sc_vendor[16];
133 int sc_id_vendor;
134
135 #if defined(__NetBSD__) || defined(__OpenBSD__)
136 void *sc_powerhook; /* cookie from power hook */
137 void *sc_shutdownhook; /* cookie from shutdown hook */
138 #endif
139 u_int32_t sc_control; /* Preserved during suspend/standby */
140 u_int32_t sc_intre;
141
142 u_int sc_overrun_cnt;
143 struct timeval sc_overrun_ntc;
144
145 struct callout sc_tmo_rhsc;
146 char sc_dying;
147 } ohci_softc_t;
148
149 struct ohci_xfer {
150 struct usbd_xfer xfer;
151 struct usb_task abort_task;
152 u_int32_t ohci_xfer_flags;
153 };
154 #define OHCI_XFER_ABORTING 0x01 /* xfer is aborting. */
155 #define OHCI_XFER_ABORTWAIT 0x02 /* abort completion is being awaited. */
156
157 #define OXFER(xfer) ((struct ohci_xfer *)(xfer))
158 #define MS_TO_TICKS(ms) ((ms) * hz / 1000)
159
160 usbd_status ohci_init(ohci_softc_t *);
161 void ohci_intr(void *);
162 int ohci_detach(ohci_softc_t *, int);
163 void ohci_shutdown(void *v);
164 void ohci_power(int state, void *priv);
165
|