usb_controller.h revision 194228 
1/* $FreeBSD: head/sys/dev/usb/usb_controller.h 194228 2009-06-15 01:02:43Z thompsa $ */
2/*-
3 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 */
26
27#ifndef _USB2_CONTROLLER_H_
28#define	_USB2_CONTROLLER_H_
29
30/* defines */
31
32#define	USB_BUS_DMA_TAG_MAX 8
33
34/* structure prototypes  */
35
36struct usb_bus;
37struct usb_page;
38struct usb_endpoint;
39struct usb_page_cache;
40struct usb_setup_params;
41struct usb_hw_ep_profile;
42struct usb_fs_isoc_schedule;
43struct usb_config_descriptor;
44struct usb_endpoint_descriptor;
45
46/* typedefs */
47
48typedef void (usb_bus_mem_sub_cb_t)(struct usb_bus *bus, struct usb_page_cache *pc, struct usb_page *pg, usb_size_t size, usb_size_t align);
49typedef void (usb_bus_mem_cb_t)(struct usb_bus *bus, usb_bus_mem_sub_cb_t *scb);
50
51/*
52 * The following structure is used to define all the USB BUS
53 * callbacks.
54 */
55struct usb_bus_methods {
56
57	/* USB Device and Host mode - Mandatory */
58
59	usb_handle_req_t *roothub_exec;
60
61	void    (*endpoint_init) (struct usb_device *,
62		    struct usb_endpoint_descriptor *, struct usb_endpoint *);
63	void    (*xfer_setup) (struct usb_setup_params *);
64	void    (*xfer_unsetup) (struct usb_xfer *);
65	void    (*get_dma_delay) (struct usb_bus *, uint32_t *);
66	void    (*device_suspend) (struct usb_device *);
67	void    (*device_resume) (struct usb_device *);
68	void    (*set_hw_power) (struct usb_bus *);
69
70	/*
71	 * The following flag is set if one or more control transfers are
72	 * active:
73	 */
74#define	USB_HW_POWER_CONTROL	0x01
75	/*
76	 * The following flag is set if one or more bulk transfers are
77	 * active:
78	 */
79#define	USB_HW_POWER_BULK	0x02
80	/*
81	 * The following flag is set if one or more interrupt transfers are
82	 * active:
83	 */
84#define	USB_HW_POWER_INTERRUPT	0x04
85	/*
86	 * The following flag is set if one or more isochronous transfers
87	 * are active:
88	 */
89#define	USB_HW_POWER_ISOC	0x08
90	/*
91	 * The following flag is set if one or more non-root-HUB devices
92	 * are present on the given USB bus:
93	 */
94#define	USB_HW_POWER_NON_ROOT_HUB 0x10
95
96	/* USB Device mode only - Mandatory */
97
98	void    (*get_hw_ep_profile) (struct usb_device *udev, const struct usb_hw_ep_profile **ppf, uint8_t ep_addr);
99	void    (*set_stall) (struct usb_device *udev, struct usb_xfer *xfer, struct usb_endpoint *ep);
100	void    (*clear_stall) (struct usb_device *udev, struct usb_endpoint *ep);
101
102};
103
104/*
105 * The following structure is used to define all the USB pipe
106 * callbacks.
107 */
108struct usb_pipe_methods {
109
110	/* Mandatory USB Device and Host mode callbacks: */
111
112	usb_callback_t *open;
113	usb_callback_t *close;
114
115	usb_callback_t *enter;
116	usb_callback_t *start;
117
118	/* Optional */
119
120	void   *info;
121};
122
123/*
124 * The following structure keeps information about what a hardware USB
125 * endpoint supports.
126 */
127struct usb_hw_ep_profile {
128	uint16_t max_in_frame_size;	/* IN-token direction */
129	uint16_t max_out_frame_size;	/* OUT-token direction */
130	uint8_t	is_simplex:1;
131	uint8_t	support_multi_buffer:1;
132	uint8_t	support_bulk:1;
133	uint8_t	support_control:1;
134	uint8_t	support_interrupt:1;
135	uint8_t	support_isochronous:1;
136	uint8_t	support_in:1;		/* IN-token is supported */
137	uint8_t	support_out:1;		/* OUT-token is supported */
138};
139
140/*
141 * The following structure is used when trying to allocate hardware
142 * endpoints for an USB configuration in USB device side mode.
143 */
144struct usb_hw_ep_scratch_sub {
145	const struct usb_hw_ep_profile *pf;
146	uint16_t max_frame_size;
147	uint8_t	hw_endpoint_out;
148	uint8_t	hw_endpoint_in;
149	uint8_t	needs_ep_type;
150	uint8_t	needs_in:1;
151	uint8_t	needs_out:1;
152};
153
154/*
155 * The following structure is used when trying to allocate hardware
156 * endpoints for an USB configuration in USB device side mode.
157 */
158struct usb_hw_ep_scratch {
159	struct usb_hw_ep_scratch_sub ep[USB_EP_MAX];
160	struct usb_hw_ep_scratch_sub *ep_max;
161	struct usb_config_descriptor *cd;
162	struct usb_device *udev;
163	struct usb_bus_methods *methods;
164	uint8_t	bmOutAlloc[(USB_EP_MAX + 15) / 16];
165	uint8_t	bmInAlloc[(USB_EP_MAX + 15) / 16];
166};
167
168/*
169 * The following structure is used when generating USB descriptors
170 * from USB templates.
171 */
172struct usb_temp_setup {
173	void   *buf;
174	usb_size_t size;
175	enum usb_dev_speed	usb_speed;
176	uint8_t	self_powered;
177	uint8_t	bNumEndpoints;
178	uint8_t	bInterfaceNumber;
179	uint8_t	bAlternateSetting;
180	uint8_t	bConfigurationValue;
181	usb_error_t err;
182};
183
184/* prototypes */
185
186void	usb_bus_mem_flush_all(struct usb_bus *bus, usb_bus_mem_cb_t *cb);
187uint8_t	usb_bus_mem_alloc_all(struct usb_bus *bus, bus_dma_tag_t dmat, usb_bus_mem_cb_t *cb);
188void	usb_bus_mem_free_all(struct usb_bus *bus, usb_bus_mem_cb_t *cb);
189uint16_t usb_isoc_time_expand(struct usb_bus *bus, uint16_t isoc_time_curr);
190uint16_t usbd_fs_isoc_schedule_isoc_time_expand(struct usb_device *udev, struct usb_fs_isoc_schedule **pp_start, struct usb_fs_isoc_schedule **pp_end, uint16_t isoc_time);
191uint8_t	usbd_fs_isoc_schedule_alloc(struct usb_fs_isoc_schedule *fss, uint8_t *pstart, uint16_t len);
192
193#endif					/* _USB2_CONTROLLER_H_ */
194