source: mainline/uspace/drv/bus/usb/vhc/transfer.c@ 64d138b

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 64d138b was 6832245, checked in by Ondřej Hlavatý <aearsis@…>, 8 years ago

usbhost bus: refactor the bus ops

This way, method names better represent the entity it is working with.
Their semantics was shifted a bit.

Regarding the tree of structures:

bus ← device ← endpoint ← batch

Previously, devices were kept in DDF function nodes, and endpoints had
pointer to the bus and device. Now, devices have pointer to bus,
endpoints don't.

Pointer to hcd_t in bus is WIP, and will be removed.
  • Property mode set to 100644
File size: 7.8 KB
Line 
1/*
2 * Copyright (c) 2011 Vojtech Horky
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
29#include <errno.h>
30#include <str_error.h>
31#include <usb/debug.h>
32#include <usbvirt/device.h>
33#include <usb/host/bandwidth.h>
34#include <usb/host/endpoint.h>
35#include <usb/host/usb_transfer_batch.h>
36#include <usbvirt/ipc.h>
37#include "vhcd.h"
38#include "hub/virthub.h"
39
40static bool is_set_address_transfer(vhc_transfer_t *transfer)
41{
42 if (transfer->batch->target.endpoint != 0) {
43 return false;
44 }
45 if (transfer->batch->ep->transfer_type != USB_TRANSFER_CONTROL) {
46 return false;
47 }
48 if (transfer->batch->dir != USB_DIRECTION_OUT) {
49 return false;
50 }
51 const usb_device_request_setup_packet_t *setup
52 = &transfer->batch->setup.packet;
53 if (setup->request_type != 0) {
54 return false;
55 }
56 if (setup->request != USB_DEVREQ_SET_ADDRESS) {
57 return false;
58 }
59
60 return true;
61}
62
63static int process_transfer_local(usb_transfer_batch_t *batch,
64 usbvirt_device_t *dev, size_t *actual_data_size)
65{
66 int rc;
67
68 const usb_direction_t dir = batch->dir;
69
70 if (batch->ep->transfer_type == USB_TRANSFER_CONTROL) {
71 if (dir == USB_DIRECTION_IN) {
72 rc = usbvirt_control_read(dev,
73 batch->setup.buffer, USB_SETUP_PACKET_SIZE,
74 batch->buffer, batch->buffer_size,
75 actual_data_size);
76 } else {
77 assert(dir == USB_DIRECTION_OUT);
78 rc = usbvirt_control_write(dev,
79 batch->setup.buffer, USB_SETUP_PACKET_SIZE,
80 batch->buffer, batch->buffer_size);
81 }
82 } else {
83 if (dir == USB_DIRECTION_IN) {
84 rc = usbvirt_data_in(dev, batch->ep->transfer_type,
85 batch->ep->endpoint,
86 batch->buffer, batch->buffer_size,
87 actual_data_size);
88 } else {
89 assert(dir == USB_DIRECTION_OUT);
90 rc = usbvirt_data_out(dev, batch->ep->transfer_type,
91 batch->ep->endpoint,
92 batch->buffer, batch->buffer_size);
93 }
94 }
95
96 return rc;
97}
98
99static int process_transfer_remote(usb_transfer_batch_t *batch,
100 async_sess_t *sess, size_t *actual_data_size)
101{
102 int rc;
103
104 const usb_direction_t dir = batch->dir;
105
106 if (batch->ep->transfer_type == USB_TRANSFER_CONTROL) {
107 if (dir == USB_DIRECTION_IN) {
108 rc = usbvirt_ipc_send_control_read(sess,
109 batch->setup.buffer, USB_SETUP_PACKET_SIZE,
110 batch->buffer, batch->buffer_size,
111 actual_data_size);
112 } else {
113 assert(dir == USB_DIRECTION_OUT);
114 rc = usbvirt_ipc_send_control_write(sess,
115 batch->setup.buffer, USB_SETUP_PACKET_SIZE,
116 batch->buffer, batch->buffer_size);
117 }
118 } else {
119 if (dir == USB_DIRECTION_IN) {
120 rc = usbvirt_ipc_send_data_in(sess, batch->ep->endpoint,
121 batch->ep->transfer_type,
122 batch->buffer, batch->buffer_size,
123 actual_data_size);
124 } else {
125 assert(dir == USB_DIRECTION_OUT);
126 rc = usbvirt_ipc_send_data_out(sess, batch->ep->endpoint,
127 batch->ep->transfer_type,
128 batch->buffer, batch->buffer_size);
129 }
130 }
131
132 return rc;
133}
134
135static vhc_transfer_t *dequeue_first_transfer(vhc_virtdev_t *dev)
136{
137 assert(fibril_mutex_is_locked(&dev->guard));
138 assert(!list_empty(&dev->transfer_queue));
139
140 vhc_transfer_t *transfer = list_get_instance(
141 list_first(&dev->transfer_queue), vhc_transfer_t, link);
142 list_remove(&transfer->link);
143
144 return transfer;
145}
146
147static void execute_transfer_callback_and_free(vhc_transfer_t *transfer,
148 size_t data_transfer_size, int outcome)
149{
150 assert(outcome != ENAK);
151 assert(transfer);
152 assert(transfer->batch);
153 transfer->batch->error = outcome;
154 transfer->batch->transfered_size = data_transfer_size;
155 usb_transfer_batch_finish(transfer->batch);
156 free(transfer);
157}
158
159static const bus_ops_t vhc_bus_ops = {
160 .parent = &usb2_bus_ops,
161 .endpoint_count_bw = bandwidth_count_usb11,
162};
163
164int vhc_init(vhc_data_t *instance, hcd_t *hcd)
165{
166 assert(instance);
167 list_initialize(&instance->devices);
168 fibril_mutex_initialize(&instance->guard);
169 usb2_bus_init(&instance->bus, hcd, BANDWIDTH_AVAILABLE_USB11);
170 instance->bus.base.ops = &vhc_bus_ops;
171 instance->magic = 0xDEADBEEF;
172 return virthub_init(&instance->hub, "root hub");
173}
174
175int vhc_schedule(hcd_t *hcd, usb_transfer_batch_t *batch)
176{
177 assert(hcd);
178 assert(batch);
179 vhc_data_t *vhc = hcd_get_driver_data(hcd);
180 assert(vhc);
181
182 vhc_transfer_t *transfer = malloc(sizeof(vhc_transfer_t));
183 if (!transfer)
184 return ENOMEM;
185 link_initialize(&transfer->link);
186 transfer->batch = batch;
187
188 fibril_mutex_lock(&vhc->guard);
189
190 int targets = 0;
191
192 list_foreach(vhc->devices, link, vhc_virtdev_t, dev) {
193 fibril_mutex_lock(&dev->guard);
194 if (dev->address == transfer->batch->target.address) {
195 if (!targets) {
196 list_append(&transfer->link, &dev->transfer_queue);
197 }
198 ++targets;
199 }
200 fibril_mutex_unlock(&dev->guard);
201 }
202
203 fibril_mutex_unlock(&vhc->guard);
204
205 if (targets > 1)
206 usb_log_warning("Transfer would be accepted by more devices!\n");
207
208 return targets ? EOK : ENOENT;
209}
210
211int vhc_transfer_queue_processor(void *arg)
212{
213 vhc_virtdev_t *dev = arg;
214 fibril_mutex_lock(&dev->guard);
215 while (dev->plugged) {
216 if (list_empty(&dev->transfer_queue)) {
217 fibril_mutex_unlock(&dev->guard);
218 async_usleep(10 * 1000);
219 fibril_mutex_lock(&dev->guard);
220 continue;
221 }
222
223 vhc_transfer_t *transfer = dequeue_first_transfer(dev);
224 fibril_mutex_unlock(&dev->guard);
225
226 int rc = EOK;
227 size_t data_transfer_size = 0;
228 if (dev->dev_sess) {
229 rc = process_transfer_remote(transfer->batch,
230 dev->dev_sess, &data_transfer_size);
231 } else if (dev->dev_local != NULL) {
232 rc = process_transfer_local(transfer->batch,
233 dev->dev_local, &data_transfer_size);
234 } else {
235 usb_log_warning("Device has no remote phone nor local node.\n");
236 rc = ESTALL;
237 }
238
239 usb_log_debug2("Transfer %p processed: %s.\n",
240 transfer, str_error(rc));
241
242 fibril_mutex_lock(&dev->guard);
243 if (rc == EOK) {
244 if (is_set_address_transfer(transfer)) {
245 usb_device_request_setup_packet_t *setup =
246 (void*) transfer->batch->setup.buffer;
247 dev->address = setup->value;
248 usb_log_debug2("Address changed to %d\n",
249 dev->address);
250 }
251 }
252 if (rc == ENAK) {
253 // FIXME: this will work only because we do
254 // not NAK control transfers but this is generally
255 // a VERY bad idea indeed
256 list_append(&transfer->link, &dev->transfer_queue);
257 }
258 fibril_mutex_unlock(&dev->guard);
259
260 if (rc != ENAK) {
261 execute_transfer_callback_and_free(transfer,
262 data_transfer_size, rc);
263 }
264
265 async_usleep(1000 * 100);
266 fibril_mutex_lock(&dev->guard);
267 }
268
269 /* Immediately fail all remaining transfers. */
270 while (!list_empty(&dev->transfer_queue)) {
271 vhc_transfer_t *transfer = dequeue_first_transfer(dev);
272 execute_transfer_callback_and_free(transfer, 0, EBADCHECKSUM);
273 }
274
275 fibril_mutex_unlock(&dev->guard);
276
277 return EOK;
278}
Note: See TracBrowser for help on using the repository browser.