1 /* $NetBSD: ohcivar.h,v 1.18 2000/01/18 20:11:00 augustss Exp $ */
2 /* $FreeBSD: src/sys/dev/usb/ohcivar.h,v 1.15.2.4 2000/10/31 23:23:29 n_hibma Exp $ */
5 * Copyright (c) 1998 The NetBSD Foundation, Inc.
8 * This code is derived from software contributed to The NetBSD Foundation
9 * by Lennart Augustsson (lennart@augustsson.net) at
10 * Carlstedt Research & Technology.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
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.
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.
41 typedef struct ohci_soft_ed {
43 struct ohci_soft_ed *next;
44 ohci_physaddr_t physaddr;
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 128
49 typedef struct ohci_soft_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;
58 #define OHCI_CALL_DONE 0x0001
59 #define OHCI_ADD_LEN 0x0002
60 #define OHCI_TD_HANDLED 0x0004 /* signal process_done has seen it */
62 #define OHCI_STD_SIZE ((sizeof (struct ohci_soft_td) + OHCI_TD_ALIGN - 1) / OHCI_TD_ALIGN * OHCI_TD_ALIGN)
63 #define OHCI_STD_CHUNK 128
65 typedef struct ohci_soft_itd {
67 struct ohci_soft_itd *nextitd; /* mirrors nexttd in ITD */
68 ohci_physaddr_t physaddr;
70 #define OHCI_SITD_SIZE ((sizeof (struct ohci_soft_itd) + OHCI_ITD_ALIGN - 1) / OHCI_ITD_ALIGN * OHCI_ITD_ALIGN)
71 #define OHCI_SITD_CHUNK 64
73 #define OHCI_NO_EDS (2*OHCI_NO_INTRS-1)
75 #define OHCI_HASH_SIZE 128
77 typedef struct ohci_softc {
78 struct usbd_bus sc_bus; /* base device */
80 bus_space_handle_t ioh;
82 #if defined(__FreeBSD__)
85 struct resource *io_res;
86 struct resource *irq_res;
90 struct ohci_hcca *sc_hcca;
91 ohci_soft_ed_t *sc_eds[OHCI_NO_EDS];
92 u_int sc_bws[OHCI_NO_INTRS];
94 u_int32_t sc_eintrs; /* enabled interrupts */
96 ohci_soft_ed_t *sc_isoc_head;
97 ohci_soft_ed_t *sc_ctrl_head;
98 ohci_soft_ed_t *sc_bulk_head;
100 LIST_HEAD(, ohci_soft_td) sc_hash_tds[OHCI_HASH_SIZE];
103 u_int8_t sc_addr; /* device address */
104 u_int8_t sc_conf; /* device configuration */
106 ohci_soft_ed_t *sc_freeeds;
107 ohci_soft_td_t *sc_freetds;
108 ohci_soft_itd_t *sc_freeitds;
110 SIMPLEQ_HEAD(, usbd_xfer) sc_free_xfers; /* free xfers */
112 usbd_xfer_handle sc_intrxfer;
117 #if defined(__NetBSD__)
119 void *sc_shutdownhook; /* cookie from shutdown hook */
122 device_ptr_t sc_child;
125 usbd_status ohci_init(ohci_softc_t *);
126 int ohci_intr(void *);
127 #if defined(__NetBSD__) || defined(__OpenBSD__)
128 int ohci_detach(ohci_softc_t *, int);
129 int ohci_activate(device_ptr_t, enum devact);
132 #define MS_TO_TICKS(ms) ((ms) * hz / 1000)