08d96694d98deb94bfa82105723e0aaf60846d67
[dragonfly.git] / sys / bus / usb / ohcivar.h
1 /*
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 $
5  */
6
7 /*
8  * Copyright (c) 1998 The NetBSD Foundation, Inc.
9  * All rights reserved.
10  *
11  * This code is derived from software contributed to The NetBSD Foundation
12  * by Lennart Augustsson (lennart@augustsson.net) at
13  * Carlstedt Research & Technology.
14  *
15  * Redistribution and use in source and binary forms, with or without
16  * modification, are permitted provided that the following conditions
17  * are met:
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.
30  *
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.
42  */
43
44 typedef struct ohci_soft_ed {
45         ohci_ed_t ed;
46         struct ohci_soft_ed *next;
47         ohci_physaddr_t physaddr;
48 } ohci_soft_ed_t;
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)
51
52 typedef struct ohci_soft_td {
53         ohci_td_t 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;
59         u_int16_t len;
60         u_int16_t flags;
61 #define OHCI_CALL_DONE  0x0001
62 #define OHCI_ADD_LEN    0x0002
63 #define OHCI_TD_HANDLED 0x0004          /* signal process_done has seen it */
64 } ohci_soft_td_t;
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)
67
68 typedef struct ohci_soft_itd {
69         ohci_itd_t 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;
75         u_int16_t flags;
76 #define OHCI_ITD_ACTIVE 0x0010          /* Hardware op in progress */
77 #define OHCI_ITD_INTFIN 0x0020          /* Hw completion interrupt seen.*/
78 #ifdef DIAGNOSTIC
79         char isdone;
80 #endif
81 } ohci_soft_itd_t;
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)
84
85 #define OHCI_NO_EDS (2*OHCI_NO_INTRS-1)
86
87 #define OHCI_HASH_SIZE 128
88
89 typedef struct ohci_softc {
90         struct usbd_bus sc_bus;         /* base device */
91         bus_space_tag_t iot;
92         bus_space_handle_t ioh;
93         bus_size_t sc_size;
94
95 #if defined(__FreeBSD__) || defined(__DragonFly__)
96         void *ih;
97
98         struct resource *io_res;
99         struct resource *irq_res;
100 #endif
101
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];
106
107         u_int32_t sc_eintrs;            /* enabled interrupts */
108
109         ohci_soft_ed_t *sc_isoc_head;
110         ohci_soft_ed_t *sc_ctrl_head;
111         ohci_soft_ed_t *sc_bulk_head;
112
113         LIST_HEAD(, ohci_soft_td)  sc_hash_tds[OHCI_HASH_SIZE];
114         LIST_HEAD(, ohci_soft_itd) sc_hash_itds[OHCI_HASH_SIZE];
115
116         int sc_noport;
117         u_int8_t sc_addr;               /* device address */
118         u_int8_t sc_conf;               /* device configuration */
119
120 #ifdef USB_USE_SOFTINTR
121         char sc_softwake;
122 #endif /* USB_USE_SOFTINTR */
123
124         ohci_soft_ed_t *sc_freeeds;
125         ohci_soft_td_t *sc_freetds;
126         ohci_soft_itd_t *sc_freeitds;
127
128         SIMPLEQ_HEAD(, usbd_xfer) sc_free_xfers; /* free xfers */
129
130         usbd_xfer_handle sc_intrxfer;
131
132         ohci_soft_itd_t *sc_sidone;
133         ohci_soft_td_t  *sc_sdone;
134
135         char sc_vendor[16];
136         int sc_id_vendor;
137
138 #if defined(__NetBSD__) || defined(__OpenBSD__)
139         void *sc_powerhook;             /* cookie from power hook */
140         void *sc_shutdownhook;          /* cookie from shutdown hook */
141 #endif
142         u_int32_t sc_control;           /* Preserved during suspend/standby */
143         u_int32_t sc_intre;
144
145         u_int sc_overrun_cnt;
146         struct timeval sc_overrun_ntc;
147
148         usb_callout_t sc_tmo_rhsc;
149
150         device_ptr_t sc_child;
151         char sc_dying;
152 } ohci_softc_t;
153
154 struct ohci_xfer {
155         struct usbd_xfer xfer;
156         struct usb_task abort_task;
157         u_int32_t ohci_xfer_flags;
158 };
159 #define OHCI_ISOC_DIRTY  0x01
160
161 #define OXFER(xfer) ((struct ohci_xfer *)(xfer))
162
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);
168 #endif
169
170 #define MS_TO_TICKS(ms) ((ms) * hz / 1000)
171
172 void            ohci_shutdown(void *v);
173 void            ohci_power(int state, void *priv);