2 * $NetBSD: ohcivar.h,v 1.30 2001/12/31 12:20:35 augustss Exp $
3 * $FreeBSD: src/sys/dev/usb/ohcivar.h,v 1.36 2003/12/22 15:18:46 shiba Exp $
4 * $DragonFly: src/sys/bus/usb/ohcivar.h,v 1.4 2004/02/11 15:17:26 joerg Exp $
8 * Copyright (c) 1998 The NetBSD Foundation, Inc.
11 * This code is derived from software contributed to The NetBSD Foundation
12 * by Lennart Augustsson (lennart@augustsson.net) at
13 * Carlstedt Research & Technology.
15 * Redistribution and use in source and binary forms, with or without
16 * modification, are permitted provided that the following conditions
18 * 1. Redistributions of source code must retain the above copyright
19 * notice, this list of conditions and the following disclaimer.
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in the
22 * documentation and/or other materials provided with the distribution.
23 * 3. All advertising materials mentioning features or use of this software
24 * must display the following acknowledgement:
25 * This product includes software developed by the NetBSD
26 * Foundation, Inc. and its contributors.
27 * 4. Neither the name of The NetBSD Foundation nor the names of its
28 * contributors may be used to endorse or promote products derived
29 * from this software without specific prior written permission.
31 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
32 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
33 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
34 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
35 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
36 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
37 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
38 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
39 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGE.
44 typedef struct ohci_soft_ed {
46 struct ohci_soft_ed *next;
47 ohci_physaddr_t physaddr;
49 #define OHCI_SED_SIZE ((sizeof (struct ohci_soft_ed) + OHCI_ED_ALIGN - 1) / OHCI_ED_ALIGN * OHCI_ED_ALIGN)
50 #define OHCI_SED_CHUNK (PAGE_SIZE / OHCI_SED_SIZE)
52 typedef struct ohci_soft_td {
54 struct ohci_soft_td *nexttd; /* mirrors nexttd in TD */
55 struct ohci_soft_td *dnext; /* next in done list */
56 ohci_physaddr_t physaddr;
57 LIST_ENTRY(ohci_soft_td) hnext;
58 usbd_xfer_handle xfer;
61 #define OHCI_CALL_DONE 0x0001
62 #define OHCI_ADD_LEN 0x0002
63 #define OHCI_TD_HANDLED 0x0004 /* signal process_done has seen it */
65 #define OHCI_STD_SIZE ((sizeof (struct ohci_soft_td) + OHCI_TD_ALIGN - 1) / OHCI_TD_ALIGN * OHCI_TD_ALIGN)
66 #define OHCI_STD_CHUNK (PAGE_SIZE / OHCI_STD_SIZE)
68 typedef struct ohci_soft_itd {
70 struct ohci_soft_itd *nextitd; /* mirrors nexttd in ITD */
71 struct ohci_soft_itd *dnext; /* next in done list */
72 ohci_physaddr_t physaddr;
73 LIST_ENTRY(ohci_soft_itd) hnext;
74 usbd_xfer_handle xfer;
76 #define OHCI_ITD_ACTIVE 0x0010 /* Hardware op in progress */
77 #define OHCI_ITD_INTFIN 0x0020 /* Hw completion interrupt seen.*/
82 #define OHCI_SITD_SIZE ((sizeof (struct ohci_soft_itd) + OHCI_ITD_ALIGN - 1) / OHCI_ITD_ALIGN * OHCI_ITD_ALIGN)
83 #define OHCI_SITD_CHUNK (PAGE_SIZE / OHCI_SITD_SIZE)
85 #define OHCI_NO_EDS (2*OHCI_NO_INTRS-1)
87 #define OHCI_HASH_SIZE 128
89 typedef struct ohci_softc {
90 struct usbd_bus sc_bus; /* base device */
92 bus_space_handle_t ioh;
95 #if defined(__FreeBSD__) || defined(__DragonFly__)
98 struct resource *io_res;
99 struct resource *irq_res;
102 usb_dma_t sc_hccadma;
103 struct ohci_hcca *sc_hcca;
104 ohci_soft_ed_t *sc_eds[OHCI_NO_EDS];
105 u_int sc_bws[OHCI_NO_INTRS];
107 u_int32_t sc_eintrs; /* enabled interrupts */
109 ohci_soft_ed_t *sc_isoc_head;
110 ohci_soft_ed_t *sc_ctrl_head;
111 ohci_soft_ed_t *sc_bulk_head;
113 LIST_HEAD(, ohci_soft_td) sc_hash_tds[OHCI_HASH_SIZE];
114 LIST_HEAD(, ohci_soft_itd) sc_hash_itds[OHCI_HASH_SIZE];
117 u_int8_t sc_addr; /* device address */
118 u_int8_t sc_conf; /* device configuration */
120 #ifdef USB_USE_SOFTINTR
122 #endif /* USB_USE_SOFTINTR */
124 ohci_soft_ed_t *sc_freeeds;
125 ohci_soft_td_t *sc_freetds;
126 ohci_soft_itd_t *sc_freeitds;
128 SIMPLEQ_HEAD(, usbd_xfer) sc_free_xfers; /* free xfers */
130 usbd_xfer_handle sc_intrxfer;
132 ohci_soft_itd_t *sc_sidone;
133 ohci_soft_td_t *sc_sdone;
138 #if defined(__NetBSD__) || defined(__OpenBSD__)
139 void *sc_powerhook; /* cookie from power hook */
140 void *sc_shutdownhook; /* cookie from shutdown hook */
142 u_int32_t sc_control; /* Preserved during suspend/standby */
145 u_int sc_overrun_cnt;
146 struct timeval sc_overrun_ntc;
148 usb_callout_t sc_tmo_rhsc;
150 device_ptr_t sc_child;
155 struct usbd_xfer xfer;
156 struct usb_task abort_task;
157 u_int32_t ohci_xfer_flags;
159 #define OHCI_ISOC_DIRTY 0x01
161 #define OXFER(xfer) ((struct ohci_xfer *)(xfer))
163 usbd_status ohci_init(ohci_softc_t *);
164 int ohci_intr(void *);
165 #if defined(__NetBSD__) || defined(__OpenBSD__)
166 int ohci_detach(ohci_softc_t *, int);
167 int ohci_activate(device_ptr_t, enum devact);
170 #define MS_TO_TICKS(ms) ((ms) * hz / 1000)
172 void ohci_shutdown(void *v);
173 void ohci_power(int state, void *priv);