source: mainline/uspace/drv/ohci/batch.c@ 777e336

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

More debug (still does not work)
  • Property mode set to 100644
File size: 10.5 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 "utils/malloc32.h"
42#include "hw_struct/endpoint_descriptor.h"
43#include "hw_struct/transfer_descriptor.h"
44
45typedef struct ohci_batch {
46 ed_t *ed;
47 td_t *tds;
48 size_t td_count;
49} ohci_batch_t;
50
51static void batch_control(usb_transfer_batch_t *instance,
52 usb_direction_t data_dir, usb_direction_t status_dir);
53static void batch_call_in_and_dispose(usb_transfer_batch_t *instance);
54static void batch_call_out_and_dispose(usb_transfer_batch_t *instance);
55
56#define DEFAULT_ERROR_COUNT 3
57usb_transfer_batch_t * batch_get(ddf_fun_t *fun, endpoint_t *ep,
58 char *buffer, size_t buffer_size, char* setup_buffer, size_t setup_size,
59 usbhc_iface_transfer_in_callback_t func_in,
60 usbhc_iface_transfer_out_callback_t func_out, void *arg)
61{
62#define CHECK_NULL_DISPOSE_RETURN(ptr, message...) \
63 if (ptr == NULL) { \
64 usb_log_error(message); \
65 if (instance) { \
66 batch_dispose(instance); \
67 } \
68 return NULL; \
69 } else (void)0
70
71 usb_transfer_batch_t *instance = malloc(sizeof(usb_transfer_batch_t));
72 CHECK_NULL_DISPOSE_RETURN(instance,
73 "Failed to allocate batch instance.\n");
74 usb_target_t target =
75 { .address = ep->address, .endpoint = ep->endpoint };
76 usb_transfer_batch_init(instance, target, ep->transfer_type, ep->speed,
77 ep->max_packet_size, buffer, NULL, buffer_size, NULL, setup_size,
78 func_in, func_out, arg, fun, ep, NULL);
79
80 ohci_batch_t *data = malloc(sizeof(ohci_batch_t));
81 CHECK_NULL_DISPOSE_RETURN(data, "Failed to allocate batch data.\n");
82 bzero(data, sizeof(ohci_batch_t));
83 instance->private_data = data;
84
85 /* we needs + 1 transfer descriptor as the last one won't be executed */
86 data->td_count = 1 +
87 ((buffer_size + OHCI_TD_MAX_TRANSFER - 1) / OHCI_TD_MAX_TRANSFER);
88 if (ep->transfer_type == USB_TRANSFER_CONTROL) {
89 data->td_count += 2;
90 }
91
92 data->tds = malloc32(sizeof(td_t) * data->td_count);
93 CHECK_NULL_DISPOSE_RETURN(data->tds,
94 "Failed to allocate transfer descriptors.\n");
95 bzero(data->tds, sizeof(td_t) * data->td_count);
96
97 data->ed = malloc32(sizeof(ed_t));
98 CHECK_NULL_DISPOSE_RETURN(data->ed,
99 "Failed to allocate endpoint descriptor.\n");
100
101 if (buffer_size > 0) {
102 instance->transport_buffer = malloc32(buffer_size);
103 CHECK_NULL_DISPOSE_RETURN(instance->transport_buffer,
104 "Failed to allocate device accessible buffer.\n");
105 }
106
107 if (setup_size > 0) {
108 instance->setup_buffer = malloc32(setup_size);
109 CHECK_NULL_DISPOSE_RETURN(instance->setup_buffer,
110 "Failed to allocate device accessible setup buffer.\n");
111 memcpy(instance->setup_buffer, setup_buffer, setup_size);
112 }
113
114 return instance;
115}
116/*----------------------------------------------------------------------------*/
117void batch_dispose(usb_transfer_batch_t *instance)
118{
119 assert(instance);
120 ohci_batch_t *data = instance->private_data;
121 assert(data);
122 free32(data->ed);
123 free32(data->tds);
124 free32(instance->setup_buffer);
125 free32(instance->transport_buffer);
126 free(data);
127 free(instance);
128}
129/*----------------------------------------------------------------------------*/
130bool batch_is_complete(usb_transfer_batch_t *instance)
131{
132 assert(instance);
133 ohci_batch_t *data = instance->private_data;
134 assert(data);
135 size_t tds = data->td_count - 1;
136 usb_log_debug2("Batch(%p) checking %d td(s) for completion.\n",
137 instance, tds);
138 size_t i = 0;
139 for (; i < tds; ++i) {
140 if (!td_is_finished(&data->tds[i]))
141 return false;
142 instance->error = td_error(&data->tds[i]);
143 /* FIXME: calculate real transfered size */
144 instance->transfered_size = instance->buffer_size;
145 if (instance->error != EOK) {
146 usb_log_debug("Batch(%p) found error TD(%d):%x.\n",
147 instance, i, data->tds[i].status);
148 return true;
149// endpoint_toggle_set(instance->ep,
150 }
151 }
152 return true;
153}
154/*----------------------------------------------------------------------------*/
155void batch_control_write(usb_transfer_batch_t *instance)
156{
157 assert(instance);
158 /* We are data out, we are supposed to provide data */
159 memcpy(instance->transport_buffer, instance->buffer,
160 instance->buffer_size);
161 instance->next_step = batch_call_out_and_dispose;
162 batch_control(instance, USB_DIRECTION_OUT, USB_DIRECTION_IN);
163 usb_log_debug("Batch(%p) CONTROL WRITE initialized.\n", instance);
164}
165/*----------------------------------------------------------------------------*/
166void batch_control_read(usb_transfer_batch_t *instance)
167{
168 assert(instance);
169 instance->next_step = batch_call_in_and_dispose;
170 batch_control(instance, USB_DIRECTION_IN, USB_DIRECTION_OUT);
171 usb_log_debug("Batch(%p) CONTROL READ initialized.\n", instance);
172}
173/*----------------------------------------------------------------------------*/
174void batch_interrupt_in(usb_transfer_batch_t *instance)
175{
176 assert(instance);
177 assert(instance->direction == USB_DIRECTION_IN);
178 instance->next_step = batch_call_in_and_dispose;
179 /* TODO: implement */
180 usb_log_debug("Batch(%p) INTERRUPT IN initialized.\n", instance);
181}
182/*----------------------------------------------------------------------------*/
183void batch_interrupt_out(usb_transfer_batch_t *instance)
184{
185 assert(instance);
186 assert(instance->direction == USB_DIRECTION_OUT);
187 /* We are data out, we are supposed to provide data */
188 memcpy(instance->transport_buffer, instance->buffer,
189 instance->buffer_size);
190 instance->next_step = batch_call_out_and_dispose;
191 /* TODO: implement */
192 usb_log_debug("Batch(%p) INTERRUPT OUT initialized.\n", instance);
193}
194/*----------------------------------------------------------------------------*/
195void batch_bulk_in(usb_transfer_batch_t *instance)
196{
197 assert(instance);
198 instance->direction = USB_DIRECTION_IN;
199 instance->next_step = batch_call_in_and_dispose;
200 /* TODO: implement */
201 usb_log_debug("Batch(%p) BULK IN initialized.\n", instance);
202}
203/*----------------------------------------------------------------------------*/
204void batch_bulk_out(usb_transfer_batch_t *instance)
205{
206 assert(instance);
207 instance->direction = USB_DIRECTION_IN;
208 instance->next_step = batch_call_in_and_dispose;
209 /* TODO: implement */
210 usb_log_debug("Batch(%p) BULK IN initialized.\n", instance);
211}
212/*----------------------------------------------------------------------------*/
213ed_t * batch_ed(usb_transfer_batch_t *instance)
214{
215 assert(instance);
216 ohci_batch_t *data = instance->private_data;
217 assert(data);
218 return data->ed;
219}
220/*----------------------------------------------------------------------------*/
221void batch_control(usb_transfer_batch_t *instance,
222 usb_direction_t data_dir, usb_direction_t status_dir)
223{
224 assert(instance);
225 ohci_batch_t *data = instance->private_data;
226 assert(data);
227 ed_init(data->ed, instance->ep);
228 ed_add_tds(data->ed, &data->tds[0], &data->tds[data->td_count - 1]);
229 usb_log_debug("Created ED(%p): %x:%x:%x:%x.\n", data->ed,
230 data->ed->status, data->ed->td_tail, data->ed->td_head,
231 data->ed->next);
232 int toggle = 0;
233 /* setup stage */
234 td_init(&data->tds[0], USB_DIRECTION_BOTH, instance->setup_buffer,
235 instance->setup_size, toggle);
236 td_set_next(&data->tds[0], &data->tds[1]);
237 usb_log_debug("Created SETUP TD: %x:%x:%x:%x.\n", data->tds[0].status,
238 data->tds[0].cbp, data->tds[0].next, data->tds[0].be);
239
240 /* data stage */
241 size_t td_current = 1;
242 size_t remain_size = instance->buffer_size;
243 char *transfer_buffer = instance->transport_buffer;
244 while (remain_size > 0) {
245 size_t transfer_size = remain_size > OHCI_TD_MAX_TRANSFER ?
246 OHCI_TD_MAX_TRANSFER : remain_size;
247 toggle = 1 - toggle;
248
249 td_init(&data->tds[td_current], data_dir, transfer_buffer,
250 transfer_size, toggle);
251 td_set_next(&data->tds[td_current], &data->tds[td_current + 1]);
252 usb_log_debug("Created DATA TD: %x:%x:%x:%x.\n",
253 data->tds[td_current].status, data->tds[td_current].cbp,
254 data->tds[td_current].next, data->tds[td_current].be);
255
256 transfer_buffer += transfer_size;
257 remain_size -= transfer_size;
258 assert(td_current < data->td_count - 2);
259 ++td_current;
260 }
261
262 /* status stage */
263 assert(td_current == data->td_count - 2);
264 td_init(&data->tds[td_current], status_dir, NULL, 0, 1);
265 usb_log_debug("Created STATUS TD: %x:%x:%x:%x.\n",
266 data->tds[td_current].status, data->tds[td_current].cbp,
267 data->tds[td_current].next, data->tds[td_current].be);
268}
269/*----------------------------------------------------------------------------*/
270/** Helper function calls callback and correctly disposes of batch structure.
271 *
272 * @param[in] instance Batch structure to use.
273 */
274void batch_call_in_and_dispose(usb_transfer_batch_t *instance)
275{
276 assert(instance);
277 usb_transfer_batch_call_in(instance);
278 batch_dispose(instance);
279}
280/*----------------------------------------------------------------------------*/
281/** Helper function calls callback and correctly disposes of batch structure.
282 *
283 * @param[in] instance Batch structure to use.
284 */
285void batch_call_out_and_dispose(usb_transfer_batch_t *instance)
286{
287 assert(instance);
288 usb_transfer_batch_call_out(instance);
289 batch_dispose(instance);
290}
291/**
292 * @}
293 */
Note: See TracBrowser for help on using the repository browser.