source: mainline/uspace/drv/ohci/batch.c@ e05d6c3

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since e05d6c3 was c9dc471, checked in by Jan Vesely <jano.vesely@…>, 15 years ago

Handle error states on ED properly.
  • Property mode set to 100644
File size: 11.8 KB
Line 
1/*
2 * Copyright (c) 2011 Jan Vesely
3 * 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 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28/** @addtogroup drvusbohci
29 * @{
30 */
31/** @file
32 * @brief OHCI driver USB transaction structure
33 */
34#include <errno.h>
35#include <str_error.h>
36
37#include <usb/usb.h>
38#include <usb/debug.h>
39
40#include "batch.h"
41#include "hcd_endpoint.h"
42#include "utils/malloc32.h"
43#include "hw_struct/endpoint_descriptor.h"
44#include "hw_struct/transfer_descriptor.h"
45
46typedef struct ohci_transfer_batch {
47 ed_t *ed;
48 td_t **tds;
49 size_t td_count;
50 size_t leave_td;
51 char *device_buffer;
52} ohci_transfer_batch_t;
53
54static void ohci_transfer_batch_dispose(void *ohci_batch)
55{
56 ohci_transfer_batch_t *instance = ohci_batch;
57 if (!instance)
58 return;
59 free32(instance->device_buffer);
60 unsigned i = 0;
61 if (instance->tds) {
62 for (; i< instance->td_count; ++i) {
63 if (i != instance->leave_td)
64 free32(instance->tds[i]);
65 }
66 free(instance->tds);
67 }
68 free(instance);
69}
70/*----------------------------------------------------------------------------*/
71static void batch_control(usb_transfer_batch_t *instance,
72 usb_direction_t data_dir, usb_direction_t status_dir);
73static void batch_data(usb_transfer_batch_t *instance);
74/*----------------------------------------------------------------------------*/
75usb_transfer_batch_t * batch_get(ddf_fun_t *fun, endpoint_t *ep,
76 char *buffer, size_t buffer_size, char* setup_buffer, size_t setup_size,
77 usbhc_iface_transfer_in_callback_t func_in,
78 usbhc_iface_transfer_out_callback_t func_out, void *arg)
79{
80#define CHECK_NULL_DISPOSE_RETURN(ptr, message...) \
81 if (ptr == NULL) { \
82 usb_log_error(message); \
83 if (instance) { \
84 usb_transfer_batch_dispose(instance); \
85 } \
86 return NULL; \
87 } else (void)0
88
89 usb_transfer_batch_t *instance = malloc(sizeof(usb_transfer_batch_t));
90 CHECK_NULL_DISPOSE_RETURN(instance,
91 "Failed to allocate batch instance.\n");
92 usb_transfer_batch_init(instance, ep, buffer, NULL, buffer_size,
93 NULL, setup_size, func_in, func_out, arg, fun, NULL,
94 ohci_transfer_batch_dispose);
95
96 hcd_endpoint_t *hcd_ep = hcd_endpoint_get(ep);
97 assert(hcd_ep);
98
99 ohci_transfer_batch_t *data = calloc(sizeof(ohci_transfer_batch_t), 1);
100 CHECK_NULL_DISPOSE_RETURN(data, "Failed to allocate batch data.\n");
101 instance->private_data = data;
102
103 data->td_count =
104 ((buffer_size + OHCI_TD_MAX_TRANSFER - 1) / OHCI_TD_MAX_TRANSFER);
105 if (ep->transfer_type == USB_TRANSFER_CONTROL) {
106 data->td_count += 2;
107 }
108
109 /* we need one extra place for td that is currently assigned to hcd_ep*/
110 data->tds = calloc(sizeof(td_t*), data->td_count + 1);
111 CHECK_NULL_DISPOSE_RETURN(data->tds,
112 "Failed to allocate transfer descriptors.\n");
113
114 data->tds[0] = hcd_ep->td;
115 data->leave_td = 0;
116 unsigned i = 1;
117 for (; i <= data->td_count; ++i) {
118 data->tds[i] = malloc32(sizeof(td_t));
119 CHECK_NULL_DISPOSE_RETURN(data->tds[i],
120 "Failed to allocate TD %d.\n", i );
121 }
122
123 data->ed = hcd_ep->ed;
124
125 if (setup_size + buffer_size > 0) {
126 data->device_buffer = malloc32(setup_size + buffer_size);
127 CHECK_NULL_DISPOSE_RETURN(data->device_buffer,
128 "Failed to allocate device accessible buffer.\n");
129 instance->setup_buffer = data->device_buffer;
130 instance->data_buffer = data->device_buffer + setup_size;
131 memcpy(instance->setup_buffer, setup_buffer, setup_size);
132 }
133
134 return instance;
135}
136/*----------------------------------------------------------------------------*/
137bool batch_is_complete(usb_transfer_batch_t *instance)
138{
139 assert(instance);
140 ohci_transfer_batch_t *data = instance->private_data;
141 assert(data);
142 size_t tds = data->td_count;
143 usb_log_debug("Batch(%p) checking %d td(s) for completion.\n",
144 instance, tds);
145 usb_log_debug("ED: %x:%x:%x:%x.\n",
146 data->ed->status, data->ed->td_head, data->ed->td_tail,
147 data->ed->next);
148 size_t i = 0;
149 for (; i < tds; ++i) {
150 assert(data->tds[i] != NULL);
151 usb_log_debug("TD %d: %x:%x:%x:%x.\n", i,
152 data->tds[i]->status, data->tds[i]->cbp, data->tds[i]->next,
153 data->tds[i]->be);
154 if (!td_is_finished(data->tds[i])) {
155 return false;
156 }
157 instance->error = td_error(data->tds[i]);
158 /* FIXME: calculate real transfered size */
159 instance->transfered_size = instance->buffer_size;
160 if (instance->error != EOK) {
161 usb_log_debug("Batch(%p) found error TD(%d):%x.\n",
162 instance, i, data->tds[i]->status);
163 /* Make sure TD queue is empty (one TD),
164 * ED should be marked as halted */
165 data->ed->td_tail =
166 (data->ed->td_head & ED_TDTAIL_PTR_MASK);
167 ++i;
168 break;
169 }
170 }
171 data->leave_td = i;
172 assert(data->leave_td <= data->td_count);
173 hcd_endpoint_t *hcd_ep = hcd_endpoint_get(instance->ep);
174 assert(hcd_ep);
175 hcd_ep->td = data->tds[i];
176 /* Clear possible ED HALT */
177 data->ed->td_head &= ~ED_TDHEAD_HALTED_FLAG;
178 uint32_t pa = addr_to_phys(hcd_ep->td);
179 assert(pa == (data->ed->td_head & ED_TDHEAD_PTR_MASK));
180 assert(pa == (data->ed->td_tail & ED_TDTAIL_PTR_MASK));
181
182 return true;
183}
184/*----------------------------------------------------------------------------*/
185void batch_commit(usb_transfer_batch_t *instance)
186{
187 assert(instance);
188 ohci_transfer_batch_t *data = instance->private_data;
189 assert(data);
190 ed_set_end_td(data->ed, data->tds[data->td_count]);
191}
192/*----------------------------------------------------------------------------*/
193void batch_control_write(usb_transfer_batch_t *instance)
194{
195 assert(instance);
196 /* We are data out, we are supposed to provide data */
197 memcpy(instance->data_buffer, instance->buffer, instance->buffer_size);
198 instance->next_step = usb_transfer_batch_call_out_and_dispose;
199 batch_control(instance, USB_DIRECTION_OUT, USB_DIRECTION_IN);
200 usb_log_debug("Batch(%p) CONTROL WRITE initialized.\n", instance);
201}
202/*----------------------------------------------------------------------------*/
203void batch_control_read(usb_transfer_batch_t *instance)
204{
205 assert(instance);
206 instance->next_step = usb_transfer_batch_call_in_and_dispose;
207 batch_control(instance, USB_DIRECTION_IN, USB_DIRECTION_OUT);
208 usb_log_debug("Batch(%p) CONTROL READ initialized.\n", instance);
209}
210/*----------------------------------------------------------------------------*/
211void batch_interrupt_in(usb_transfer_batch_t *instance)
212{
213 assert(instance);
214 instance->next_step = usb_transfer_batch_call_in_and_dispose;
215 batch_data(instance);
216 usb_log_debug("Batch(%p) INTERRUPT IN initialized.\n", instance);
217}
218/*----------------------------------------------------------------------------*/
219void batch_interrupt_out(usb_transfer_batch_t *instance)
220{
221 assert(instance);
222 /* We are data out, we are supposed to provide data */
223 memcpy(instance->data_buffer, instance->buffer, instance->buffer_size);
224 instance->next_step = usb_transfer_batch_call_out_and_dispose;
225 batch_data(instance);
226 usb_log_debug("Batch(%p) INTERRUPT OUT initialized.\n", instance);
227}
228/*----------------------------------------------------------------------------*/
229void batch_bulk_in(usb_transfer_batch_t *instance)
230{
231 assert(instance);
232 instance->next_step = usb_transfer_batch_call_in_and_dispose;
233 batch_data(instance);
234 usb_log_debug("Batch(%p) BULK IN initialized.\n", instance);
235}
236/*----------------------------------------------------------------------------*/
237void batch_bulk_out(usb_transfer_batch_t *instance)
238{
239 assert(instance);
240 instance->next_step = usb_transfer_batch_call_in_and_dispose;
241 batch_data(instance);
242 usb_log_debug("Batch(%p) BULK IN initialized.\n", instance);
243}
244/*----------------------------------------------------------------------------*/
245ed_t * batch_ed(usb_transfer_batch_t *instance)
246{
247 assert(instance);
248 ohci_transfer_batch_t *data = instance->private_data;
249 assert(data);
250 return data->ed;
251}
252/*----------------------------------------------------------------------------*/
253void batch_control(usb_transfer_batch_t *instance,
254 usb_direction_t data_dir, usb_direction_t status_dir)
255{
256 assert(instance);
257 ohci_transfer_batch_t *data = instance->private_data;
258 assert(data);
259 usb_log_debug("Using ED(%p): %x:%x:%x:%x.\n", data->ed,
260 data->ed->status, data->ed->td_tail, data->ed->td_head,
261 data->ed->next);
262 int toggle = 0;
263 /* setup stage */
264 td_init(data->tds[0], USB_DIRECTION_BOTH, instance->setup_buffer,
265 instance->setup_size, toggle);
266 td_set_next(data->tds[0], data->tds[1]);
267 usb_log_debug("Created SETUP TD: %x:%x:%x:%x.\n", data->tds[0]->status,
268 data->tds[0]->cbp, data->tds[0]->next, data->tds[0]->be);
269
270 /* data stage */
271 size_t td_current = 1;
272 size_t remain_size = instance->buffer_size;
273 char *buffer = instance->data_buffer;
274 while (remain_size > 0) {
275 size_t transfer_size = remain_size > OHCI_TD_MAX_TRANSFER ?
276 OHCI_TD_MAX_TRANSFER : remain_size;
277 toggle = 1 - toggle;
278
279 td_init(data->tds[td_current], data_dir, buffer,
280 transfer_size, toggle);
281 td_set_next(data->tds[td_current], data->tds[td_current + 1]);
282 usb_log_debug("Created DATA TD: %x:%x:%x:%x.\n",
283 data->tds[td_current]->status, data->tds[td_current]->cbp,
284 data->tds[td_current]->next, data->tds[td_current]->be);
285
286 buffer += transfer_size;
287 remain_size -= transfer_size;
288 assert(td_current < data->td_count - 1);
289 ++td_current;
290 }
291
292 /* status stage */
293 assert(td_current == data->td_count - 1);
294 td_init(data->tds[td_current], status_dir, NULL, 0, 1);
295 td_set_next(data->tds[td_current], data->tds[td_current + 1]);
296 usb_log_debug("Created STATUS TD: %x:%x:%x:%x.\n",
297 data->tds[td_current]->status, data->tds[td_current]->cbp,
298 data->tds[td_current]->next, data->tds[td_current]->be);
299}
300/*----------------------------------------------------------------------------*/
301void batch_data(usb_transfer_batch_t *instance)
302{
303 assert(instance);
304 ohci_transfer_batch_t *data = instance->private_data;
305 assert(data);
306 usb_log_debug("Using ED(%p): %x:%x:%x:%x.\n", data->ed,
307 data->ed->status, data->ed->td_tail, data->ed->td_head,
308 data->ed->next);
309
310 size_t td_current = 0;
311 size_t remain_size = instance->buffer_size;
312 char *buffer = instance->data_buffer;
313 while (remain_size > 0) {
314 size_t transfer_size = remain_size > OHCI_TD_MAX_TRANSFER ?
315 OHCI_TD_MAX_TRANSFER : remain_size;
316
317 td_init(data->tds[td_current], instance->ep->direction,
318 buffer, transfer_size, -1);
319 td_set_next(data->tds[td_current], data->tds[td_current + 1]);
320 usb_log_debug("Created DATA TD: %x:%x:%x:%x.\n",
321 data->tds[td_current]->status, data->tds[td_current]->cbp,
322 data->tds[td_current]->next, data->tds[td_current]->be);
323
324 buffer += transfer_size;
325 remain_size -= transfer_size;
326 assert(td_current < data->td_count);
327 ++td_current;
328 }
329}
330/**
331 * @}
332 */
Note: See TracBrowser for help on using the repository browser.