ehcivar.h revision 1.9
1/*	$NetBSD: ehcivar.h,v 1.9 2001/11/20 13:49:23 augustss Exp $	*/
2
3/*
4 * Copyright (c) 2001 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Lennart Augustsson (lennart@augustsson.net).
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 * 3. All advertising materials mentioning features or use of this software
19 *    must display the following acknowledgement:
20 *        This product includes software developed by the NetBSD
21 *        Foundation, Inc. and its contributors.
22 * 4. Neither the name of The NetBSD Foundation nor the names of its
23 *    contributors may be used to endorse or promote products derived
24 *    from this software without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 * POSSIBILITY OF SUCH DAMAGE.
37 */
38
39typedef struct ehci_soft_qtd {
40	ehci_qtd_t qtd;
41	struct ehci_soft_qtd *nextqtd; /* mirrors nextqtd in TD */
42	ehci_physaddr_t physaddr;
43	usbd_xfer_handle xfer;
44	LIST_ENTRY(ehci_soft_qtd) hnext;
45#if 0
46	struct ehci_soft_qtd *dnext; /* next in done list */
47	u_int16_t len;
48	u_int16_t flags;
49#define EHCI_CALL_DONE	0x0001
50#define EHCI_ADD_LEN	0x0002
51#endif
52} ehci_soft_qtd_t;
53#define EHCI_SQTD_SIZE ((sizeof (struct ehci_soft_qtd) + EHCI_QTD_ALIGN - 1) / EHCI_QTD_ALIGN * EHCI_QTD_ALIGN)
54#define EHCI_SQTD_CHUNK (EHCI_PAGE_SIZE / EHCI_SQTD_SIZE)
55
56typedef struct ehci_soft_qh {
57	ehci_qh_t qh;
58	struct ehci_soft_qh *next;
59	struct ehci_soft_qtd *sqtd;
60	ehci_physaddr_t physaddr;
61} ehci_soft_qh_t;
62#define EHCI_SQH_SIZE ((sizeof (struct ehci_soft_qh) + EHCI_QH_ALIGN - 1) / EHCI_QH_ALIGN * EHCI_QH_ALIGN)
63#define EHCI_SQH_CHUNK (EHCI_PAGE_SIZE / EHCI_SQH_SIZE)
64
65
66#define EHCI_HASH_SIZE 128
67#define EHCI_COMPANION_MAX 8
68
69typedef struct ehci_softc {
70	struct usbd_bus sc_bus;		/* base device */
71	bus_space_tag_t iot;
72	bus_space_handle_t ioh;
73	bus_size_t sc_size;
74	u_int sc_offs;			/* offset to operational regs */
75
76	char sc_vendor[16];		/* vendor string for root hub */
77	int sc_id_vendor;		/* vendor ID for root hub */
78
79	void *sc_powerhook;		/* cookie from power hook */
80	void *sc_shutdownhook;		/* cookie from shutdown hook */
81
82	u_int sc_ncomp;
83	u_int sc_npcomp;
84	struct usbd_bus *sc_comps[EHCI_COMPANION_MAX];
85
86	usb_dma_t sc_fldma;
87	u_int sc_flsize;
88
89	ehci_soft_qh_t *sc_freeqhs;
90	ehci_soft_qtd_t *sc_freeqtds;
91
92	int sc_noport;
93	u_int8_t sc_addr;		/* device address */
94	u_int8_t sc_conf;		/* device configuration */
95	usbd_xfer_handle sc_intrxfer;
96	char sc_isreset;
97
98	u_int32_t sc_eintrs;
99	ehci_soft_qh_t *sc_async_head;
100
101	SIMPLEQ_HEAD(, usbd_xfer) sc_free_xfers; /* free xfers */
102
103	struct lock sc_doorbell_lock;
104
105	usb_callout_t sc_tmo_pcd;
106
107	device_ptr_t sc_child;		/* /dev/usb# device */
108
109	char sc_dying;
110} ehci_softc_t;
111
112#define EREAD1(sc, a) bus_space_read_1((sc)->iot, (sc)->ioh, (a))
113#define EREAD2(sc, a) bus_space_read_2((sc)->iot, (sc)->ioh, (a))
114#define EREAD4(sc, a) bus_space_read_4((sc)->iot, (sc)->ioh, (a))
115#define EWRITE1(sc, a, x) bus_space_write_1((sc)->iot, (sc)->ioh, (a), (x))
116#define EWRITE2(sc, a, x) bus_space_write_2((sc)->iot, (sc)->ioh, (a), (x))
117#define EWRITE4(sc, a, x) bus_space_write_4((sc)->iot, (sc)->ioh, (a), (x))
118#define EOREAD1(sc, a) bus_space_read_1((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a))
119#define EOREAD2(sc, a) bus_space_read_2((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a))
120#define EOREAD4(sc, a) bus_space_read_4((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a))
121#define EOWRITE1(sc, a, x) bus_space_write_1((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a), (x))
122#define EOWRITE2(sc, a, x) bus_space_write_2((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a), (x))
123#define EOWRITE4(sc, a, x) bus_space_write_4((sc)->iot, (sc)->ioh, (sc)->sc_offs+(a), (x))
124
125usbd_status	ehci_init(ehci_softc_t *);
126int		ehci_intr(void *);
127int		ehci_detach(ehci_softc_t *, int);
128int		ehci_activate(device_ptr_t, enum devact);
129