1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 1998 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) at
9 * Carlstedt Research & Technology.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 *    notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 *    notice, this list of conditions and the following disclaimer in the
18 *    documentation and/or other materials provided with the distribution.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 */
32
33#ifndef _OHCI_H_
34#define	_OHCI_H_
35
36#define	OHCI_MAX_DEVICES MIN(USB_MAX_DEVICES, 128)
37
38#define	OHCI_NO_INTRS		32
39#define	OHCI_HCCA_SIZE		256
40
41/* Structures alignment (bytes) */
42#define	OHCI_HCCA_ALIGN		256
43#define	OHCI_ED_ALIGN		16
44#define	OHCI_TD_ALIGN		16
45#define	OHCI_ITD_ALIGN		32
46
47#define	OHCI_PAGE_SIZE		0x1000
48#define	OHCI_PAGE(x)		((x) &~ 0xfff)
49#define	OHCI_PAGE_OFFSET(x)	((x) & 0xfff)
50#define	OHCI_PAGE_MASK(x)	((x) & 0xfff)
51
52#if	((USB_PAGE_SIZE < OHCI_ED_ALIGN) || (OHCI_ED_ALIGN == 0) ||	\
53	(USB_PAGE_SIZE < OHCI_TD_ALIGN) || (OHCI_TD_ALIGN == 0) ||	\
54	(USB_PAGE_SIZE < OHCI_ITD_ALIGN) || (OHCI_ITD_ALIGN == 0) ||	\
55	(USB_PAGE_SIZE < OHCI_PAGE_SIZE) || (OHCI_PAGE_SIZE == 0))
56#error	"Invalid USB page size!"
57#endif
58
59#define	OHCI_VIRTUAL_FRAMELIST_COUNT 128/* dummy */
60
61#if (OHCI_VIRTUAL_FRAMELIST_COUNT < USB_MAX_FS_ISOC_FRAMES_PER_XFER)
62#error "maximum number of full-speed isochronous frames is higher than supported!"
63#endif
64
65struct ohci_hcca {
66	volatile uint32_t hcca_interrupt_table[OHCI_NO_INTRS];
67	volatile uint32_t hcca_frame_number;
68	volatile uint32_t hcca_done_head;
69#define	OHCI_DONE_INTRS		1
70} __aligned(OHCI_HCCA_ALIGN);
71
72typedef struct ohci_hcca ohci_hcca_t;
73
74struct ohci_ed {
75	volatile uint32_t ed_flags;
76#define	OHCI_ED_GET_FA(s)	((s) & 0x7f)
77#define	OHCI_ED_ADDRMASK	0x0000007f
78#define	OHCI_ED_SET_FA(s)	(s)
79#define	OHCI_ED_GET_EN(s)	(((s) >> 7) & 0xf)
80#define	OHCI_ED_SET_EN(s)	((s) << 7)
81#define	OHCI_ED_DIR_MASK	0x00001800
82#define	OHCI_ED_DIR_TD		0x00000000
83#define	OHCI_ED_DIR_OUT		0x00000800
84#define	OHCI_ED_DIR_IN		0x00001000
85#define	OHCI_ED_SPEED		0x00002000
86#define	OHCI_ED_SKIP		0x00004000
87#define	OHCI_ED_FORMAT_GEN	0x00000000
88#define	OHCI_ED_FORMAT_ISO	0x00008000
89#define	OHCI_ED_GET_MAXP(s)	(((s) >> 16) & 0x07ff)
90#define	OHCI_ED_SET_MAXP(s)	((s) << 16)
91#define	OHCI_ED_MAXPMASK	(0x7ff << 16)
92	volatile uint32_t ed_tailp;
93	volatile uint32_t ed_headp;
94#define	OHCI_HALTED		0x00000001
95#define	OHCI_TOGGLECARRY	0x00000002
96#define	OHCI_HEADMASK		0xfffffffc
97	volatile uint32_t ed_next;
98/*
99 * Extra information needed:
100 */
101	struct ohci_ed *next;
102	struct ohci_ed *prev;
103	struct ohci_ed *obj_next;
104	struct usb_page_cache *page_cache;
105	uint32_t ed_self;
106} __aligned(OHCI_ED_ALIGN);
107
108typedef struct ohci_ed ohci_ed_t;
109
110struct ohci_td {
111	volatile uint32_t td_flags;
112#define	OHCI_TD_R		0x00040000	/* Buffer Rounding  */
113#define	OHCI_TD_DP_MASK		0x00180000	/* Direction / PID */
114#define	OHCI_TD_SETUP		0x00000000
115#define	OHCI_TD_OUT		0x00080000
116#define	OHCI_TD_IN		0x00100000
117#define	OHCI_TD_GET_DI(x)	(((x) >> 21) & 7)	/* Delay Interrupt */
118#define	OHCI_TD_SET_DI(x)	((x) << 21)
119#define	OHCI_TD_NOINTR		0x00e00000
120#define	OHCI_TD_INTR_MASK	0x00e00000
121#define	OHCI_TD_TOGGLE_CARRY	0x00000000
122#define	OHCI_TD_TOGGLE_0	0x02000000
123#define	OHCI_TD_TOGGLE_1	0x03000000
124#define	OHCI_TD_TOGGLE_MASK	0x03000000
125#define	OHCI_TD_GET_EC(x)	(((x) >> 26) & 3)	/* Error Count */
126#define	OHCI_TD_GET_CC(x)	((x) >> 28)	/* Condition Code */
127#define	OHCI_TD_SET_CC(x)	((x) << 28)
128#define	OHCI_TD_NOCC		0xf0000000
129	volatile uint32_t td_cbp;	/* Current Buffer Pointer */
130	volatile uint32_t td_next;	/* Next TD */
131#define	OHCI_TD_NEXT_END	0
132	volatile uint32_t td_be;	/* Buffer End */
133/*
134 * Extra information needed:
135 */
136	struct ohci_td *obj_next;
137	struct ohci_td *alt_next;
138	struct usb_page_cache *page_cache;
139	uint32_t td_self;
140	uint16_t len;
141} __aligned(OHCI_TD_ALIGN);
142
143typedef struct ohci_td ohci_td_t;
144
145struct ohci_itd {
146	volatile uint32_t itd_flags;
147#define	OHCI_ITD_GET_SF(x)	((x) & 0x0000ffff)
148#define	OHCI_ITD_SET_SF(x)	((x) & 0xffff)
149#define	OHCI_ITD_GET_DI(x)	(((x) >> 21) & 7)	/* Delay Interrupt */
150#define	OHCI_ITD_SET_DI(x)	((x) << 21)
151#define	OHCI_ITD_NOINTR		0x00e00000
152#define	OHCI_ITD_GET_FC(x)	((((x) >> 24) & 7)+1)	/* Frame Count */
153#define	OHCI_ITD_SET_FC(x)	(((x)-1) << 24)
154#define	OHCI_ITD_GET_CC(x)	((x) >> 28)	/* Condition Code */
155#define	OHCI_ITD_NOCC		0xf0000000
156#define	OHCI_ITD_NOFFSET	8
157	volatile uint32_t itd_bp0;	/* Buffer Page 0 */
158	volatile uint32_t itd_next;	/* Next ITD */
159	volatile uint32_t itd_be;	/* Buffer End */
160	volatile uint16_t itd_offset[OHCI_ITD_NOFFSET];	/* Buffer offsets and
161							 * Status */
162#define	OHCI_ITD_PAGE_SELECT	0x00001000
163#define	OHCI_ITD_MK_OFFS(len)	(0xe000 | ((len) & 0x1fff))
164#define	OHCI_ITD_PSW_LENGTH(x)	((x) & 0xfff)	/* Transfer length */
165#define	OHCI_ITD_PSW_GET_CC(x)	((x) >> 12)	/* Condition Code */
166/*
167 * Extra information needed:
168 */
169	struct ohci_itd *obj_next;
170	struct usb_page_cache *page_cache;
171	uint32_t itd_self;
172	uint8_t	frames;
173} __aligned(OHCI_ITD_ALIGN);
174
175typedef struct ohci_itd ohci_itd_t;
176
177#define	OHCI_CC_NO_ERROR		0
178#define	OHCI_CC_CRC			1
179#define	OHCI_CC_BIT_STUFFING		2
180#define	OHCI_CC_DATA_TOGGLE_MISMATCH	3
181#define	OHCI_CC_STALL			4
182#define	OHCI_CC_DEVICE_NOT_RESPONDING	5
183#define	OHCI_CC_PID_CHECK_FAILURE	6
184#define	OHCI_CC_UNEXPECTED_PID		7
185#define	OHCI_CC_DATA_OVERRUN		8
186#define	OHCI_CC_DATA_UNDERRUN		9
187#define	OHCI_CC_BUFFER_OVERRUN		12
188#define	OHCI_CC_BUFFER_UNDERRUN		13
189#define	OHCI_CC_NOT_ACCESSED		15
190
191/* Some delay needed when changing certain registers. */
192#define	OHCI_ENABLE_POWER_DELAY		5
193#define	OHCI_READ_DESC_DELAY		5
194
195#define	OHCI_NO_EDS			(2*OHCI_NO_INTRS)
196
197struct ohci_hw_softc {
198	struct usb_page_cache hcca_pc;
199	struct usb_page_cache ctrl_start_pc;
200	struct usb_page_cache bulk_start_pc;
201	struct usb_page_cache isoc_start_pc;
202	struct usb_page_cache intr_start_pc[OHCI_NO_EDS];
203
204	struct usb_page hcca_pg;
205	struct usb_page ctrl_start_pg;
206	struct usb_page bulk_start_pg;
207	struct usb_page isoc_start_pg;
208	struct usb_page intr_start_pg[OHCI_NO_EDS];
209};
210
211struct ohci_config_desc {
212	struct usb_config_descriptor confd;
213	struct usb_interface_descriptor ifcd;
214	struct usb_endpoint_descriptor endpd;
215} __packed;
216
217union ohci_hub_desc {
218	struct usb_status stat;
219	struct usb_port_status ps;
220	struct usb_hub_descriptor hubd;
221	uint8_t	temp[128];
222};
223
224typedef struct ohci_softc {
225	struct ohci_hw_softc sc_hw;
226	struct usb_bus sc_bus;		/* base device */
227	struct usb_callout sc_tmo_rhsc;
228	union ohci_hub_desc sc_hub_desc;
229
230	struct usb_device *sc_devices[OHCI_MAX_DEVICES];
231	struct resource *sc_io_res;
232	struct resource *sc_irq_res;
233	struct ohci_hcca *sc_hcca_p;
234	struct ohci_ed *sc_ctrl_p_last;
235	struct ohci_ed *sc_bulk_p_last;
236	struct ohci_ed *sc_isoc_p_last;
237	struct ohci_ed *sc_intr_p_last[OHCI_NO_EDS];
238	void   *sc_intr_hdl;
239	device_t sc_dev;
240	bus_size_t sc_io_size;
241	bus_space_tag_t sc_io_tag;
242	bus_space_handle_t sc_io_hdl;
243
244	uint32_t sc_eintrs;		/* enabled interrupts */
245
246	uint16_t sc_intr_stat[OHCI_NO_EDS];
247	uint16_t sc_id_vendor;
248
249	uint8_t	sc_noport;
250	uint8_t	sc_addr;		/* device address */
251	uint8_t	sc_conf;		/* device configuration */
252	uint8_t	sc_hub_idata[32];
253
254	char	sc_vendor[16];
255
256} ohci_softc_t;
257
258usb_bus_mem_cb_t ohci_iterate_hw_softc;
259
260usb_error_t ohci_init(ohci_softc_t *sc);
261void	ohci_detach(struct ohci_softc *sc);
262void	ohci_interrupt(ohci_softc_t *sc);
263
264#endif					/* _OHCI_H_ */
265