ohcivar.h revision 1.20 1 /* $NetBSD: ohcivar.h,v 1.20 2000/02/22 11:30:55 augustss Exp $ */
2 /* $FreeBSD: src/sys/dev/usb/ohcivar.h,v 1.13 1999/11/17 22:33:41 n_hibma 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 (augustss (at) carlstedt.se) 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 128
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 128
63
64 typedef struct ohci_soft_itd {
65 ohci_itd_t itd;
66 struct ohci_soft_itd *nextitd; /* mirrors nexttd in ITD */
67 ohci_physaddr_t physaddr;
68 } ohci_soft_itd_t;
69 #define OHCI_SITD_SIZE ((sizeof (struct ohci_soft_itd) + OHCI_ITD_ALIGN - 1) / OHCI_ITD_ALIGN * OHCI_ITD_ALIGN)
70 #define OHCI_SITD_CHUNK 64
71
72 #define OHCI_NO_EDS (2*OHCI_NO_INTRS-1)
73
74 #define OHCI_HASH_SIZE 128
75
76 typedef struct ohci_softc {
77 struct usbd_bus sc_bus; /* base device */
78 bus_space_tag_t iot;
79 bus_space_handle_t ioh;
80
81 usb_dma_t sc_hccadma;
82 struct ohci_hcca *sc_hcca;
83 ohci_soft_ed_t *sc_eds[OHCI_NO_EDS];
84 u_int sc_bws[OHCI_NO_INTRS];
85
86 u_int32_t sc_eintrs;
87 ohci_soft_ed_t *sc_isoc_head;
88 ohci_soft_ed_t *sc_ctrl_head;
89 ohci_soft_ed_t *sc_bulk_head;
90
91 LIST_HEAD(, ohci_soft_td) sc_hash_tds[OHCI_HASH_SIZE];
92
93 int sc_noport;
94 u_int8_t sc_addr; /* device address */
95 u_int8_t sc_conf; /* device configuration */
96
97 ohci_soft_ed_t *sc_freeeds;
98 ohci_soft_td_t *sc_freetds;
99 ohci_soft_itd_t *sc_freeitds;
100
101 SIMPLEQ_HEAD(, usbd_xfer) sc_free_xfers; /* free xfers */
102
103 usbd_xfer_handle sc_intrxfer;
104
105 ohci_physaddr_t sc_done;
106
107 char sc_vendor[16];
108 int sc_id_vendor;
109
110 #if defined(__NetBSD__) || defined(__OpenBSD__)
111 void *sc_powerhook; /* cookie from power hook */
112 void *sc_shutdownhook; /* cookie from shutdown hook */
113 #endif
114
115 device_ptr_t sc_child;
116 } ohci_softc_t;
117
118 usbd_status ohci_init __P((ohci_softc_t *));
119 int ohci_intr __P((void *));
120 #if defined(__NetBSD__) || defined(__OpenBSD__)
121 int ohci_detach __P((ohci_softc_t *, int));
122 int ohci_activate __P((device_ptr_t, enum devact));
123 #endif
124
125 #define MS_TO_TICKS(ms) ((ms) * hz / 1000)
126