1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
|
// Main code for handling USB controllers and devices.
//
// Copyright (C) 2009-2013 Kevin O'Connor <kevin@koconnor.net>
//
// This file may be distributed under the terms of the GNU LGPLv3 license.
#include "biosvar.h" // GET_GLOBAL
#include "config.h" // CONFIG_*
#include "malloc.h" // free
#include "output.h" // dprintf
#include "string.h" // memset
#include "usb.h" // struct usb_s
#include "usb-ehci.h" // ehci_setup
#include "usb-xhci.h" // xhci_setup
#include "usb-hid.h" // usb_keyboard_setup
#include "usb-hub.h" // usb_hub_setup
#include "usb-msc.h" // usb_msc_setup
#include "usb-ohci.h" // ohci_setup
#include "usb-uas.h" // usb_uas_setup
#include "usb-uhci.h" // uhci_setup
#include "util.h" // msleep
#include "x86.h" // __fls
/****************************************************************
* Controller function wrappers
****************************************************************/
// Allocate an async pipe (control or bulk).
struct usb_pipe *
usb_alloc_pipe(struct usbdevice_s *usbdev
, struct usb_endpoint_descriptor *epdesc)
{
switch (usbdev->hub->cntl->type) {
default:
case USB_TYPE_UHCI:
return uhci_alloc_pipe(usbdev, epdesc);
case USB_TYPE_OHCI:
return ohci_alloc_pipe(usbdev, epdesc);
case USB_TYPE_EHCI:
return ehci_alloc_pipe(usbdev, epdesc);
case USB_TYPE_XHCI:
return xhci_alloc_pipe(usbdev, epdesc);
}
}
// Update an pipe (used for control only)
struct usb_pipe *
usb_update_pipe(struct usbdevice_s *usbdev, struct usb_pipe *pipe
, struct usb_endpoint_descriptor *epdesc)
{
switch (usbdev->hub->cntl->type) {
case USB_TYPE_XHCI:
return xhci_update_pipe(usbdev, pipe, epdesc);
default:
usb_free_pipe(usbdev, pipe);
return usb_alloc_pipe(usbdev, epdesc);
}
}
// Send a message on a control pipe using the default control descriptor.
static int
usb_send_control(struct usb_pipe *pipe, int dir, const void *cmd, int cmdsize
, void *data, int datasize)
{
ASSERT32FLAT();
switch (pipe->type) {
default:
case USB_TYPE_UHCI:
return uhci_send_control(pipe, dir, cmd, cmdsize, data, datasize);
case USB_TYPE_OHCI:
return ohci_send_control(pipe, dir, cmd, cmdsize, data, datasize);
case USB_TYPE_EHCI:
return ehci_send_control(pipe, dir, cmd, cmdsize, data, datasize);
case USB_TYPE_XHCI:
return xhci_send_control(pipe, dir, cmd, cmdsize, data, datasize);
}
}
int
usb_send_bulk(struct usb_pipe *pipe_fl, int dir, void *data, int datasize)
{
switch (GET_LOWFLAT(pipe_fl->type)) {
default:
case USB_TYPE_UHCI:
return uhci_send_bulk(pipe_fl, dir, data, datasize);
case USB_TYPE_OHCI:
return ohci_send_bulk(pipe_fl, dir, data, datasize);
case USB_TYPE_EHCI:
return ehci_send_bulk(pipe_fl, dir, data, datasize);
case USB_TYPE_XHCI:
if (MODESEGMENT)
return -1;
return xhci_send_bulk(pipe_fl, dir, data, datasize);
}
}
int
usb_poll_intr(struct usb_pipe *pipe_fl, void *data)
{
ASSERT16();
switch (GET_LOWFLAT(pipe_fl->type)) {
default:
case USB_TYPE_UHCI:
return uhci_poll_intr(pipe_fl, data);
case USB_TYPE_OHCI:
return ohci_poll_intr(pipe_fl, data);
case USB_TYPE_EHCI:
return ehci_poll_intr(pipe_fl, data);
case USB_TYPE_XHCI: ;
extern void _cfunc32flat_xhci_poll_intr(void);
return call32_params(_cfunc32flat_xhci_poll_intr, (u32)pipe_fl
, (u32)MAKE_FLATPTR(GET_SEG(SS), (u32)data), 0, -1);
}
}
int usb_32bit_pipe(struct usb_pipe *pipe_fl)
{
return CONFIG_USB_XHCI && GET_LOWFLAT(pipe_fl->type) == USB_TYPE_XHCI;
}
/****************************************************************
* Helper functions
****************************************************************/
// Send a message to the default control pipe of a device.
int
usb_send_default_control(struct usb_pipe *pipe, const struct usb_ctrlrequest *req
, void *data)
{
return usb_send_control(pipe, req->bRequestType & USB_DIR_IN
, req, sizeof(*req), data, req->wLength);
}
// Free an allocated control or bulk pipe.
void
usb_free_pipe(struct usbdevice_s *usbdev, struct usb_pipe *pipe)
{
ASSERT32FLAT();
if (!pipe)
return;
// Add to controller's free list.
struct usb_s *cntl = pipe->cntl;
pipe->freenext = cntl->freelist;
cntl->freelist = pipe;
}
// Check for an available pipe on the freelist.
struct usb_pipe *
usb_getFreePipe(struct usb_s *cntl, u8 eptype)
{
struct usb_pipe **pfree = &cntl->freelist;
for (;;) {
struct usb_pipe *pipe = *pfree;
if (!pipe)
return NULL;
if (pipe->eptype == eptype) {
*pfree = pipe->freenext;
return pipe;
}
pfree = &pipe->freenext;
}
}
// Fill "pipe" endpoint info from an endpoint descriptor.
void
usb_desc2pipe(struct usb_pipe *pipe, struct usbdevice_s *usbdev
, struct usb_endpoint_descriptor *epdesc)
{
pipe->cntl = usbdev->hub->cntl;
pipe->type = usbdev->hub->cntl->type;
pipe->ep = epdesc->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
pipe->devaddr = usbdev->devaddr;
pipe->speed = usbdev->speed;
pipe->maxpacket = epdesc->wMaxPacketSize;
pipe->eptype = epdesc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
}
// Find the exponential period of the requested interrupt end point.
int
usb_get_period(struct usbdevice_s *usbdev
, struct usb_endpoint_descriptor *epdesc)
{
int period = epdesc->bInterval;
if (usbdev->speed != USB_HIGHSPEED)
return (period <= 0) ? 0 : __fls(period);
return (period <= 4) ? 0 : period - 4;
}
// Maximum time (in ms) a data transfer should take
int
usb_xfer_time(struct usb_pipe *pipe, int datalen)
{
// Use the maximum command time (5 seconds), except for
// set_address commands where we don't want to stall the boot if
// the device doesn't actually exist. Add 100ms to account for
// any controller delays.
if (!GET_LOWFLAT(pipe->devaddr))
return USB_TIME_STATUS + 100;
return USB_TIME_COMMAND + 100;
}
// Find the first endpoint of a given type in an interface description.
struct usb_endpoint_descriptor *
usb_find_desc(struct usbdevice_s *usbdev, int type, int dir)
{
struct usb_endpoint_descriptor *epdesc = (void*)&usbdev->iface[1];
for (;;) {
if ((void*)epdesc >= (void*)usbdev->iface + usbdev->imax
|| epdesc->bDescriptorType == USB_DT_INTERFACE) {
return NULL;
}
if (epdesc->bDescriptorType == USB_DT_ENDPOINT
&& (epdesc->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == dir
&& (epdesc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == type)
return epdesc;
epdesc = (void*)epdesc + epdesc->bLength;
}
}
// Get the first 8 bytes of the device descriptor.
static int
get_device_info8(struct usb_pipe *pipe, struct usb_device_descriptor *dinfo)
{
struct usb_ctrlrequest req;
req.bRequestType = USB_DIR_IN | USB_TYPE_STANDARD | USB_RECIP_DEVICE;
req.bRequest = USB_REQ_GET_DESCRIPTOR;
req.wValue = USB_DT_DEVICE<<8;
req.wIndex = 0;
req.wLength = 8;
return usb_send_default_control(pipe, &req, dinfo);
}
static struct usb_config_descriptor *
get_device_config(struct usb_pipe *pipe)
{
struct usb_config_descriptor cfg;
struct usb_ctrlrequest req;
req.bRequestType = USB_DIR_IN | USB_TYPE_STANDARD | USB_RECIP_DEVICE;
req.bRequest = USB_REQ_GET_DESCRIPTOR;
req.wValue = USB_DT_CONFIG<<8;
req.wIndex = 0;
req.wLength = sizeof(cfg);
int ret = usb_send_default_control(pipe, &req, &cfg);
if (ret)
return NULL;
void *config = malloc_tmphigh(cfg.wTotalLength);
if (!config)
return NULL;
req.wLength = cfg.wTotalLength;
ret = usb_send_default_control(pipe, &req, config);
if (ret)
return NULL;
//hexdump(config, cfg.wTotalLength);
return config;
}
static int
set_configuration(struct usb_pipe *pipe, u16 val)
{
struct usb_ctrlrequest req;
req.bRequestType = USB_DIR_OUT | USB_TYPE_STANDARD | USB_RECIP_DEVICE;
req.bRequest = USB_REQ_SET_CONFIGURATION;
req.wValue = val;
req.wIndex = 0;
req.wLength = 0;
return usb_send_default_control(pipe, &req, NULL);
}
/****************************************************************
* Initialization and enumeration
****************************************************************/
static const int speed_to_ctlsize[] = {
[ USB_FULLSPEED ] = 8,
[ USB_LOWSPEED ] = 8,
[ USB_HIGHSPEED ] = 64,
[ USB_SUPERSPEED ] = 512,
};
// Assign an address to a device in the default state on the given
// controller.
static int
usb_set_address(struct usbdevice_s *usbdev)
{
ASSERT32FLAT();
struct usb_s *cntl = usbdev->hub->cntl;
dprintf(3, "set_address %p\n", cntl);
if (cntl->maxaddr >= USB_MAXADDR)
return -1;
msleep(USB_TIME_RSTRCY);
// Create a pipe for the default address.
struct usb_endpoint_descriptor epdesc = {
.wMaxPacketSize = speed_to_ctlsize[usbdev->speed],
.bmAttributes = USB_ENDPOINT_XFER_CONTROL,
};
usbdev->defpipe = usb_alloc_pipe(usbdev, &epdesc);
if (!usbdev->defpipe)
return -1;
// Send set_address command.
struct usb_ctrlrequest req;
req.bRequestType = USB_DIR_OUT | USB_TYPE_STANDARD | USB_RECIP_DEVICE;
req.bRequest = USB_REQ_SET_ADDRESS;
req.wValue = cntl->maxaddr + 1;
req.wIndex = 0;
req.wLength = 0;
int ret = usb_send_default_control(usbdev->defpipe, &req, NULL);
if (ret) {
usb_free_pipe(usbdev, usbdev->defpipe);
return -1;
}
msleep(USB_TIME_SETADDR_RECOVERY);
cntl->maxaddr++;
usbdev->devaddr = cntl->maxaddr;
usbdev->defpipe = usb_update_pipe(usbdev, usbdev->defpipe, &epdesc);
if (!usbdev->defpipe)
return -1;
return 0;
}
// Called for every found device - see if a driver is available for
// this device and do setup if so.
static int
configure_usb_device(struct usbdevice_s *usbdev)
{
ASSERT32FLAT();
dprintf(3, "config_usb: %p\n", usbdev->defpipe);
// Set the max packet size for endpoint 0 of this device.
struct usb_device_descriptor dinfo;
int ret = get_device_info8(usbdev->defpipe, &dinfo);
if (ret)
return 0;
u16 maxpacket = dinfo.bMaxPacketSize0;
if (dinfo.bcdUSB >= 0x0300)
maxpacket = 1 << dinfo.bMaxPacketSize0;
dprintf(3, "device rev=%04x cls=%02x sub=%02x proto=%02x size=%d\n"
, dinfo.bcdUSB, dinfo.bDeviceClass, dinfo.bDeviceSubClass
, dinfo.bDeviceProtocol, maxpacket);
if (maxpacket < 8)
return 0;
struct usb_endpoint_descriptor epdesc = {
.wMaxPacketSize = maxpacket,
.bmAttributes = USB_ENDPOINT_XFER_CONTROL,
};
usbdev->defpipe = usb_update_pipe(usbdev, usbdev->defpipe, &epdesc);
if (!usbdev->defpipe)
return -1;
// Get configuration
struct usb_config_descriptor *config = get_device_config(usbdev->defpipe);
if (!config)
return 0;
// Determine if a driver exists for this device - only look at the
// first interface of the first configuration.
struct usb_interface_descriptor *iface = (void*)(&config[1]);
if (iface->bInterfaceClass != USB_CLASS_HID
&& iface->bInterfaceClass != USB_CLASS_MASS_STORAGE
&& iface->bInterfaceClass != USB_CLASS_HUB)
// Not a supported device.
goto fail;
// Set the configuration.
ret = set_configuration(usbdev->defpipe, config->bConfigurationValue);
if (ret)
goto fail;
// Configure driver.
usbdev->config = config;
usbdev->iface = iface;
usbdev->imax = (void*)config + config->wTotalLength - (void*)iface;
if (iface->bInterfaceClass == USB_CLASS_HUB)
ret = usb_hub_setup(usbdev);
else if (iface->bInterfaceClass == USB_CLASS_MASS_STORAGE) {
if (iface->bInterfaceProtocol == US_PR_BULK)
ret = usb_msc_setup(usbdev);
if (iface->bInterfaceProtocol == US_PR_UAS)
ret = usb_uas_setup(usbdev);
} else
ret = usb_hid_setup(usbdev);
if (ret)
goto fail;
free(config);
return 1;
fail:
free(config);
return 0;
}
static void
usb_hub_port_setup(void *data)
{
struct usbdevice_s *usbdev = data;
struct usbhub_s *hub = usbdev->hub;
u32 port = usbdev->port;
for (;;) {
// Detect if device present (and possibly start reset)
int ret = hub->op->detect(hub, port);
if (ret > 0)
// Device connected.
break;
if (ret < 0 || timer_check(hub->detectend))
// No device found.
goto done;
msleep(5);
}
// XXX - wait USB_TIME_ATTDB time?
// Reset port and determine device speed
mutex_lock(&hub->cntl->resetlock);
int ret = hub->op->reset(hub, port);
if (ret < 0)
// Reset failed
goto resetfail;
usbdev->speed = ret;
// Set address of port
ret = usb_set_address(usbdev);
if (ret) {
hub->op->disconnect(hub, port);
goto resetfail;
}
mutex_unlock(&hub->cntl->resetlock);
// Configure the device
int count = configure_usb_device(usbdev);
usb_free_pipe(usbdev, usbdev->defpipe);
if (!count)
hub->op->disconnect(hub, port);
hub->devcount += count;
done:
hub->threads--;
free(usbdev);
return;
resetfail:
mutex_unlock(&hub->cntl->resetlock);
goto done;
}
void
usb_enumerate(struct usbhub_s *hub)
{
u32 portcount = hub->portcount;
hub->threads = portcount;
hub->detectend = timer_calc(USB_TIME_SIGATT);
// Launch a thread for every port.
int i;
for (i=0; i<portcount; i++) {
struct usbdevice_s *usbdev = malloc_tmphigh(sizeof(*usbdev));
if (!usbdev) {
warn_noalloc();
continue;
}
memset(usbdev, 0, sizeof(*usbdev));
usbdev->hub = hub;
usbdev->port = i;
run_thread(usb_hub_port_setup, usbdev);
}
// Wait for threads to complete.
while (hub->threads)
yield();
}
void
__usb_setup(void *data)
{
dprintf(3, "init usb\n");
xhci_setup();
ehci_setup();
uhci_setup();
ohci_setup();
}
void
usb_setup(void)
{
ASSERT32FLAT();
if (! CONFIG_USB)
return;
run_thread(__usb_setup, NULL);
}
|