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 _USB_CONTROLLER_H_
28#define _USB_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_device *, 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, uint8_t *did_stall);
100
101 /* USB Device mode mandatory. USB Host mode optional. */
102
103 void (*clear_stall) (struct usb_device *udev, struct usb_endpoint *ep);
104
105 /* Optional transfer polling support */
106
107 void (*xfer_poll) (struct usb_bus *);
108
109 /* Optional fixed power mode support */
110
111 void (*get_power_mode) (struct usb_device *udev, int8_t *pmode);
112
113 /* Optional endpoint uninit */
114
115 void (*endpoint_uninit) (struct usb_device *, struct usb_endpoint *);
116
117 /* Optional device init */
118
119 usb_error_t (*device_init) (struct usb_device *);
120
121 /* Optional device uninit */
122
123 void (*device_uninit) (struct usb_device *);
124
125 /* Optional for device and host mode */
126
127 void (*start_dma_delay) (struct usb_xfer *);
128
129 void (*device_state_change) (struct usb_device *);
130
131 /* Optional for host mode */
132
133 usb_error_t (*set_address) (struct usb_device *, struct mtx *, uint16_t);
134};
135
136/*
137 * The following structure is used to define all the USB pipe
138 * callbacks.
139 */
140struct usb_pipe_methods {
141
142 /* Mandatory USB Device and Host mode callbacks: */
143
144 void (*open)(struct usb_xfer *);
145 void (*close)(struct usb_xfer *);
146
147 void (*enter)(struct usb_xfer *);
148 void (*start)(struct usb_xfer *);
149
150 /* Optional */
151
152 void *info;
153};
154
155/*
156 * The following structure keeps information about what a hardware USB
157 * endpoint supports.
158 */
159struct usb_hw_ep_profile {
160 uint16_t max_in_frame_size; /* IN-token direction */
161 uint16_t max_out_frame_size; /* OUT-token direction */
162 uint8_t is_simplex:1;
163 uint8_t support_multi_buffer:1;
164 uint8_t support_bulk:1;
165 uint8_t support_control:1;
166 uint8_t support_interrupt:1;
167 uint8_t support_isochronous:1;
168 uint8_t support_in:1; /* IN-token is supported */
169 uint8_t support_out:1; /* OUT-token is supported */
170};
171
172/*
173 * The following structure is used when trying to allocate hardware
174 * endpoints for an USB configuration in USB device side mode.
175 */
176struct usb_hw_ep_scratch_sub {
177 const struct usb_hw_ep_profile *pf;
178 uint16_t max_frame_size;
179 uint8_t hw_endpoint_out;
180 uint8_t hw_endpoint_in;
181 uint8_t needs_ep_type;
182 uint8_t needs_in:1;
183 uint8_t needs_out:1;
184};
185
186/*
187 * The following structure is used when trying to allocate hardware
188 * endpoints for an USB configuration in USB device side mode.
189 */
190struct usb_hw_ep_scratch {
191 struct usb_hw_ep_scratch_sub ep[USB_EP_MAX];
192 struct usb_hw_ep_scratch_sub *ep_max;
193 struct usb_config_descriptor *cd;
194 struct usb_device *udev;
195 struct usb_bus_methods *methods;
196 uint8_t bmOutAlloc[(USB_EP_MAX + 15) / 16];
197 uint8_t bmInAlloc[(USB_EP_MAX + 15) / 16];
198};
199
200/*
201 * The following structure is used when generating USB descriptors
202 * from USB templates.
203 */
204struct usb_temp_setup {
205 void *buf;
206 usb_size_t size;
207 enum usb_dev_speed usb_speed;
208 uint8_t self_powered;
209 uint8_t bNumEndpoints;
210 uint8_t bInterfaceNumber;
211 uint8_t bAlternateSetting;
212 uint8_t bConfigurationValue;
213 usb_error_t err;
214};
215
216/* prototypes */
217
218void usb_bus_mem_flush_all(struct usb_bus *bus, usb_bus_mem_cb_t *cb);
219uint8_t usb_bus_mem_alloc_all(struct usb_bus *bus, bus_dma_tag_t dmat, usb_bus_mem_cb_t *cb);
220void usb_bus_mem_free_all(struct usb_bus *bus, usb_bus_mem_cb_t *cb);
221uint16_t usb_isoc_time_expand(struct usb_bus *bus, uint16_t isoc_time_curr);
222uint16_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);
223uint8_t usbd_fs_isoc_schedule_alloc(struct usb_fs_isoc_schedule *fss, uint8_t *pstart, uint16_t len);
| 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 _USB_CONTROLLER_H_
28#define _USB_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_device *, 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, uint8_t *did_stall);
100
101 /* USB Device mode mandatory. USB Host mode optional. */
102
103 void (*clear_stall) (struct usb_device *udev, struct usb_endpoint *ep);
104
105 /* Optional transfer polling support */
106
107 void (*xfer_poll) (struct usb_bus *);
108
109 /* Optional fixed power mode support */
110
111 void (*get_power_mode) (struct usb_device *udev, int8_t *pmode);
112
113 /* Optional endpoint uninit */
114
115 void (*endpoint_uninit) (struct usb_device *, struct usb_endpoint *);
116
117 /* Optional device init */
118
119 usb_error_t (*device_init) (struct usb_device *);
120
121 /* Optional device uninit */
122
123 void (*device_uninit) (struct usb_device *);
124
125 /* Optional for device and host mode */
126
127 void (*start_dma_delay) (struct usb_xfer *);
128
129 void (*device_state_change) (struct usb_device *);
130
131 /* Optional for host mode */
132
133 usb_error_t (*set_address) (struct usb_device *, struct mtx *, uint16_t);
134};
135
136/*
137 * The following structure is used to define all the USB pipe
138 * callbacks.
139 */
140struct usb_pipe_methods {
141
142 /* Mandatory USB Device and Host mode callbacks: */
143
144 void (*open)(struct usb_xfer *);
145 void (*close)(struct usb_xfer *);
146
147 void (*enter)(struct usb_xfer *);
148 void (*start)(struct usb_xfer *);
149
150 /* Optional */
151
152 void *info;
153};
154
155/*
156 * The following structure keeps information about what a hardware USB
157 * endpoint supports.
158 */
159struct usb_hw_ep_profile {
160 uint16_t max_in_frame_size; /* IN-token direction */
161 uint16_t max_out_frame_size; /* OUT-token direction */
162 uint8_t is_simplex:1;
163 uint8_t support_multi_buffer:1;
164 uint8_t support_bulk:1;
165 uint8_t support_control:1;
166 uint8_t support_interrupt:1;
167 uint8_t support_isochronous:1;
168 uint8_t support_in:1; /* IN-token is supported */
169 uint8_t support_out:1; /* OUT-token is supported */
170};
171
172/*
173 * The following structure is used when trying to allocate hardware
174 * endpoints for an USB configuration in USB device side mode.
175 */
176struct usb_hw_ep_scratch_sub {
177 const struct usb_hw_ep_profile *pf;
178 uint16_t max_frame_size;
179 uint8_t hw_endpoint_out;
180 uint8_t hw_endpoint_in;
181 uint8_t needs_ep_type;
182 uint8_t needs_in:1;
183 uint8_t needs_out:1;
184};
185
186/*
187 * The following structure is used when trying to allocate hardware
188 * endpoints for an USB configuration in USB device side mode.
189 */
190struct usb_hw_ep_scratch {
191 struct usb_hw_ep_scratch_sub ep[USB_EP_MAX];
192 struct usb_hw_ep_scratch_sub *ep_max;
193 struct usb_config_descriptor *cd;
194 struct usb_device *udev;
195 struct usb_bus_methods *methods;
196 uint8_t bmOutAlloc[(USB_EP_MAX + 15) / 16];
197 uint8_t bmInAlloc[(USB_EP_MAX + 15) / 16];
198};
199
200/*
201 * The following structure is used when generating USB descriptors
202 * from USB templates.
203 */
204struct usb_temp_setup {
205 void *buf;
206 usb_size_t size;
207 enum usb_dev_speed usb_speed;
208 uint8_t self_powered;
209 uint8_t bNumEndpoints;
210 uint8_t bInterfaceNumber;
211 uint8_t bAlternateSetting;
212 uint8_t bConfigurationValue;
213 usb_error_t err;
214};
215
216/* prototypes */
217
218void usb_bus_mem_flush_all(struct usb_bus *bus, usb_bus_mem_cb_t *cb);
219uint8_t usb_bus_mem_alloc_all(struct usb_bus *bus, bus_dma_tag_t dmat, usb_bus_mem_cb_t *cb);
220void usb_bus_mem_free_all(struct usb_bus *bus, usb_bus_mem_cb_t *cb);
221uint16_t usb_isoc_time_expand(struct usb_bus *bus, uint16_t isoc_time_curr);
222uint16_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);
223uint8_t usbd_fs_isoc_schedule_alloc(struct usb_fs_isoc_schedule *fss, uint8_t *pstart, uint16_t len);
|