kernel - Fix panic in uhci attach error path (2)
[dragonfly.git] / sys / bus / u4b / controller / uhci.h
CommitLineData
e1a08f23 1/* $FreeBSD: head/sys/dev/usb/controller/uhci.h 228483 2011-12-14 00:28:54Z hselasky $ */
12bd3c8b
SW
2/*-
3 * Copyright (c) 1998 The NetBSD Foundation, Inc.
4 * All rights reserved.
5 *
6 * This code is derived from software contributed to The NetBSD Foundation
7 * by Lennart Augustsson (lennart@augustsson.net) at
8 * Carlstedt Research & Technology.
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 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32#ifndef _UHCI_H_
33#define _UHCI_H_
34
35#define UHCI_MAX_DEVICES MIN(USB_MAX_DEVICES, 128)
36
37#define UHCI_FRAMELIST_COUNT 1024 /* units */
38#define UHCI_FRAMELIST_ALIGN 4096 /* bytes */
39
40/* Structures alignment (bytes) */
41#define UHCI_TD_ALIGN 16
42#define UHCI_QH_ALIGN 16
43
44#if ((USB_PAGE_SIZE < UHCI_TD_ALIGN) || (UHCI_TD_ALIGN == 0) || \
45 (USB_PAGE_SIZE < UHCI_QH_ALIGN) || (UHCI_QH_ALIGN == 0))
46#error "Invalid USB page size!"
47#endif
48
49typedef uint32_t uhci_physaddr_t;
50
51#define UHCI_PTR_T 0x00000001
52#define UHCI_PTR_TD 0x00000000
53#define UHCI_PTR_QH 0x00000002
54#define UHCI_PTR_VF 0x00000004
55
56/*
57 * The Queue Heads (QH) and Transfer Descriptors (TD) are accessed by
58 * both the CPU and the USB-controller which run concurrently. Great
59 * care must be taken. When the data-structures are linked into the
60 * USB controller's frame list, the USB-controller "owns" the
61 * td_status and qh_elink fields, which will not be written by the
62 * CPU.
63 *
64 */
65
66struct uhci_td {
67/*
68 * Data used by the UHCI controller.
69 * volatile is used in order to mantain struct members ordering.
70 */
71 volatile uint32_t td_next;
72 volatile uint32_t td_status;
73#define UHCI_TD_GET_ACTLEN(s) (((s) + 1) & 0x3ff)
74#define UHCI_TD_ZERO_ACTLEN(t) ((t) | 0x3ff)
75#define UHCI_TD_BITSTUFF 0x00020000
76#define UHCI_TD_CRCTO 0x00040000
77#define UHCI_TD_NAK 0x00080000
78#define UHCI_TD_BABBLE 0x00100000
79#define UHCI_TD_DBUFFER 0x00200000
80#define UHCI_TD_STALLED 0x00400000
81#define UHCI_TD_ACTIVE 0x00800000
82#define UHCI_TD_IOC 0x01000000
83#define UHCI_TD_IOS 0x02000000
84#define UHCI_TD_LS 0x04000000
85#define UHCI_TD_GET_ERRCNT(s) (((s) >> 27) & 3)
86#define UHCI_TD_SET_ERRCNT(n) ((n) << 27)
87#define UHCI_TD_SPD 0x20000000
88 volatile uint32_t td_token;
89#define UHCI_TD_PID 0x000000ff
90#define UHCI_TD_PID_IN 0x00000069
91#define UHCI_TD_PID_OUT 0x000000e1
92#define UHCI_TD_PID_SETUP 0x0000002d
93#define UHCI_TD_GET_PID(s) ((s) & 0xff)
94#define UHCI_TD_SET_DEVADDR(a) ((a) << 8)
95#define UHCI_TD_GET_DEVADDR(s) (((s) >> 8) & 0x7f)
96#define UHCI_TD_SET_ENDPT(e) (((e) & 0xf) << 15)
97#define UHCI_TD_GET_ENDPT(s) (((s) >> 15) & 0xf)
98#define UHCI_TD_SET_DT(t) ((t) << 19)
99#define UHCI_TD_GET_DT(s) (((s) >> 19) & 1)
100#define UHCI_TD_SET_MAXLEN(l) (((l)-1) << 21)
101#define UHCI_TD_GET_MAXLEN(s) ((((s) >> 21) + 1) & 0x7ff)
102#define UHCI_TD_MAXLEN_MASK 0xffe00000
103 volatile uint32_t td_buffer;
104/*
105 * Extra information needed:
106 */
107 struct uhci_td *next;
108 struct uhci_td *prev;
109 struct uhci_td *obj_next;
110 struct usb_page_cache *page_cache;
111 struct usb_page_cache *fix_pc;
112 uint32_t td_self;
113 uint16_t len;
114} __aligned(UHCI_TD_ALIGN);
115
116typedef struct uhci_td uhci_td_t;
117
118#define UHCI_TD_ERROR (UHCI_TD_BITSTUFF | UHCI_TD_CRCTO | \
119 UHCI_TD_BABBLE | UHCI_TD_DBUFFER | UHCI_TD_STALLED)
120
121#define UHCI_TD_SETUP(len, endp, dev) (UHCI_TD_SET_MAXLEN(len) | \
122 UHCI_TD_SET_ENDPT(endp) | \
123 UHCI_TD_SET_DEVADDR(dev) | \
124 UHCI_TD_PID_SETUP)
125
126#define UHCI_TD_OUT(len, endp, dev, dt) (UHCI_TD_SET_MAXLEN(len) | \
127 UHCI_TD_SET_ENDPT(endp) | \
128 UHCI_TD_SET_DEVADDR(dev) | \
129 UHCI_TD_PID_OUT | UHCI_TD_SET_DT(dt))
130
131#define UHCI_TD_IN(len, endp, dev, dt) (UHCI_TD_SET_MAXLEN(len) | \
132 UHCI_TD_SET_ENDPT(endp) | \
133 UHCI_TD_SET_DEVADDR(dev) | \
134 UHCI_TD_PID_IN | UHCI_TD_SET_DT(dt))
135
136struct uhci_qh {
137/*
138 * Data used by the UHCI controller.
139 */
140 volatile uint32_t qh_h_next;
141 volatile uint32_t qh_e_next;
142/*
143 * Extra information needed:
144 */
145 struct uhci_qh *h_next;
146 struct uhci_qh *h_prev;
147 struct uhci_qh *obj_next;
148 struct uhci_td *e_next;
149 struct usb_page_cache *page_cache;
150 uint32_t qh_self;
151 uint16_t intr_pos;
152} __aligned(UHCI_QH_ALIGN);
153
154typedef struct uhci_qh uhci_qh_t;
155
156/* Maximum number of isochronous TD's and QH's interrupt */
157#define UHCI_VFRAMELIST_COUNT 128
158#define UHCI_IFRAMELIST_COUNT (2 * UHCI_VFRAMELIST_COUNT)
159
160#if (((UHCI_VFRAMELIST_COUNT & (UHCI_VFRAMELIST_COUNT-1)) != 0) || \
161 (UHCI_VFRAMELIST_COUNT > UHCI_FRAMELIST_COUNT))
162#error "UHCI_VFRAMELIST_COUNT is not power of two"
163#error "or UHCI_VFRAMELIST_COUNT > UHCI_FRAMELIST_COUNT"
164#endif
165
166#if (UHCI_VFRAMELIST_COUNT < USB_MAX_FS_ISOC_FRAMES_PER_XFER)
167#error "maximum number of full-speed isochronous frames is higher than supported!"
168#endif
169
170struct uhci_config_desc {
171 struct usb_config_descriptor confd;
172 struct usb_interface_descriptor ifcd;
173 struct usb_endpoint_descriptor endpd;
174} __packed;
175
176union uhci_hub_desc {
177 struct usb_status stat;
178 struct usb_port_status ps;
179 uint8_t temp[128];
180};
181
182struct uhci_hw_softc {
183 struct usb_page_cache pframes_pc;
184 struct usb_page_cache isoc_start_pc[UHCI_VFRAMELIST_COUNT];
185 struct usb_page_cache intr_start_pc[UHCI_IFRAMELIST_COUNT];
186 struct usb_page_cache ls_ctl_start_pc;
187 struct usb_page_cache fs_ctl_start_pc;
188 struct usb_page_cache bulk_start_pc;
189 struct usb_page_cache last_qh_pc;
190 struct usb_page_cache last_td_pc;
191
192 struct usb_page pframes_pg;
193 struct usb_page isoc_start_pg[UHCI_VFRAMELIST_COUNT];
194 struct usb_page intr_start_pg[UHCI_IFRAMELIST_COUNT];
195 struct usb_page ls_ctl_start_pg;
196 struct usb_page fs_ctl_start_pg;
197 struct usb_page bulk_start_pg;
198 struct usb_page last_qh_pg;
199 struct usb_page last_td_pg;
200};
201
202typedef struct uhci_softc {
203 struct uhci_hw_softc sc_hw;
204 struct usb_bus sc_bus; /* base device */
205 union uhci_hub_desc sc_hub_desc;
206 struct usb_callout sc_root_intr;
207
208 struct usb_device *sc_devices[UHCI_MAX_DEVICES];
209 /* pointer to last TD for isochronous */
210 struct uhci_td *sc_isoc_p_last[UHCI_VFRAMELIST_COUNT];
211 /* pointer to last QH for interrupt */
212 struct uhci_qh *sc_intr_p_last[UHCI_IFRAMELIST_COUNT];
213 /* pointer to last QH for low speed control */
214 struct uhci_qh *sc_ls_ctl_p_last;
215 /* pointer to last QH for full speed control */
216 struct uhci_qh *sc_fs_ctl_p_last;
217 /* pointer to last QH for bulk */
218 struct uhci_qh *sc_bulk_p_last;
219 struct uhci_qh *sc_reclaim_qh_p;
220 struct uhci_qh *sc_last_qh_p;
221 struct uhci_td *sc_last_td_p;
222 struct resource *sc_io_res;
223 struct resource *sc_irq_res;
224 void *sc_intr_hdl;
225 device_t sc_dev;
226 bus_size_t sc_io_size;
227 bus_space_tag_t sc_io_tag;
228 bus_space_handle_t sc_io_hdl;
229
230 uint32_t sc_loops; /* number of QHs that wants looping */
231
232 uint16_t sc_intr_stat[UHCI_IFRAMELIST_COUNT];
233
234 uint8_t sc_addr; /* device address */
235 uint8_t sc_conf; /* device configuration */
54b047d4 236 uint8_t sc_didinit; /* uchi_init() called */
12bd3c8b
SW
237 uint8_t sc_isreset; /* bits set if a root hub is reset */
238 uint8_t sc_isresumed; /* bits set if a port was resumed */
239 uint8_t sc_hub_idata[1];
240
241 char sc_vendor[16]; /* vendor string for root hub */
242} uhci_softc_t;
243
244usb_bus_mem_cb_t uhci_iterate_hw_softc;
245
246usb_error_t uhci_init(uhci_softc_t *sc);
247void uhci_reset(uhci_softc_t *sc);
248void uhci_interrupt(uhci_softc_t *sc);
249
250#endif /* _UHCI_H_ */