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
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
|
// Code for handling UHCI USB controllers.
//
// Copyright (C) 2009 Kevin O'Connor <kevin@koconnor.net>
//
// This file may be distributed under the terms of the GNU LGPLv3 license.
#include "biosvar.h" // GET_LOWFLAT
#include "config.h" // CONFIG_*
#include "malloc.h" // free
#include "output.h" // dprintf
#include "pci.h" // pci_bdf_to_bus
#include "pci_ids.h" // PCI_CLASS_SERIAL_USB_UHCI
#include "pci_regs.h" // PCI_BASE_ADDRESS_4
#include "string.h" // memset
#include "usb.h" // struct usb_s
#include "usb-uhci.h" // USBLEGSUP
#include "util.h" // msleep
#include "x86.h" // outw
struct usb_uhci_s {
struct usb_s usb;
u16 iobase;
struct uhci_qh *control_qh;
struct uhci_framelist *framelist;
};
struct uhci_pipe {
struct uhci_qh qh;
struct uhci_td *next_td;
struct usb_pipe pipe;
u16 iobase;
u8 toggle;
};
/****************************************************************
* Root hub
****************************************************************/
// Check if device attached to a given port
static int
uhci_hub_detect(struct usbhub_s *hub, u32 port)
{
struct usb_uhci_s *cntl = container_of(hub->cntl, struct usb_uhci_s, usb);
u16 ioport = cntl->iobase + USBPORTSC1 + port * 2;
u16 status = inw(ioport);
if (!(status & USBPORTSC_CCS))
// No device found.
return 0;
// XXX - if just powered up, need to wait for USB_TIME_ATTDB?
// Begin reset on port
outw(USBPORTSC_PR, ioport);
msleep(USB_TIME_DRSTR);
return 1;
}
// Reset device on port
static int
uhci_hub_reset(struct usbhub_s *hub, u32 port)
{
struct usb_uhci_s *cntl = container_of(hub->cntl, struct usb_uhci_s, usb);
u16 ioport = cntl->iobase + USBPORTSC1 + port * 2;
// Finish reset on port
outw(0, ioport);
udelay(6); // 64 high-speed bit times
u16 status = inw(ioport);
if (!(status & USBPORTSC_CCS))
// No longer connected
return -1;
outw(USBPORTSC_PE, ioport);
return !!(status & USBPORTSC_LSDA);
}
// Disable port
static void
uhci_hub_disconnect(struct usbhub_s *hub, u32 port)
{
struct usb_uhci_s *cntl = container_of(hub->cntl, struct usb_uhci_s, usb);
u16 ioport = cntl->iobase + USBPORTSC1 + port * 2;
outw(0, ioport);
}
static struct usbhub_op_s uhci_HubOp = {
.detect = uhci_hub_detect,
.reset = uhci_hub_reset,
.disconnect = uhci_hub_disconnect,
};
// Find any devices connected to the root hub.
static int
check_uhci_ports(struct usb_uhci_s *cntl)
{
ASSERT32FLAT();
struct usbhub_s hub;
memset(&hub, 0, sizeof(hub));
hub.cntl = &cntl->usb;
hub.portcount = 2;
hub.op = &uhci_HubOp;
usb_enumerate(&hub);
return hub.devcount;
}
/****************************************************************
* Setup
****************************************************************/
// Wait for next USB frame to start - for ensuring safe memory release.
static void
uhci_waittick(u16 iobase)
{
barrier();
u16 startframe = inw(iobase + USBFRNUM);
u32 end = timer_calc(1000 * 5);
for (;;) {
if (inw(iobase + USBFRNUM) != startframe)
break;
if (timer_check(end)) {
warn_timeout();
return;
}
yield();
}
}
static void
uhci_free_pipes(struct usb_uhci_s *cntl)
{
dprintf(7, "uhci_free_pipes %p\n", cntl);
struct uhci_qh *pos = (void*)(cntl->framelist->links[0] & ~UHCI_PTR_BITS);
for (;;) {
u32 link = pos->link;
if (link == UHCI_PTR_TERM)
break;
struct uhci_qh *next = (void*)(link & ~UHCI_PTR_BITS);
struct uhci_pipe *pipe = container_of(next, struct uhci_pipe, qh);
if (usb_is_freelist(&cntl->usb, &pipe->pipe))
pos->link = next->link;
else
pos = next;
}
uhci_waittick(cntl->iobase);
for (;;) {
struct usb_pipe *usbpipe = cntl->usb.freelist;
if (!usbpipe)
break;
cntl->usb.freelist = usbpipe->freenext;
struct uhci_pipe *pipe = container_of(usbpipe, struct uhci_pipe, pipe);
free(pipe);
}
}
static void
reset_uhci(struct usb_uhci_s *cntl, u16 bdf)
{
// XXX - don't reset if not needed.
// Reset PIRQ and SMI
pci_config_writew(bdf, USBLEGSUP, USBLEGSUP_RWC);
// Reset the HC
outw(USBCMD_HCRESET, cntl->iobase + USBCMD);
udelay(5);
// Disable interrupts and commands (just to be safe).
outw(0, cntl->iobase + USBINTR);
outw(0, cntl->iobase + USBCMD);
}
static void
configure_uhci(void *data)
{
struct usb_uhci_s *cntl = data;
// Allocate ram for schedule storage
struct uhci_td *term_td = malloc_high(sizeof(*term_td));
struct uhci_framelist *fl = memalign_high(sizeof(*fl), sizeof(*fl));
struct uhci_pipe *intr_pipe = malloc_high(sizeof(*intr_pipe));
struct uhci_pipe *term_pipe = malloc_high(sizeof(*term_pipe));
if (!term_td || !fl || !intr_pipe || !term_pipe) {
warn_noalloc();
goto fail;
}
// Work around for PIIX errata
memset(term_td, 0, sizeof(*term_td));
term_td->link = UHCI_PTR_TERM;
term_td->token = (uhci_explen(0) | (0x7f << TD_TOKEN_DEVADDR_SHIFT)
| USB_PID_IN);
memset(term_pipe, 0, sizeof(*term_pipe));
term_pipe->qh.element = (u32)term_td;
term_pipe->qh.link = UHCI_PTR_TERM;
term_pipe->pipe.cntl = &cntl->usb;
// Set schedule to point to primary intr queue head
memset(intr_pipe, 0, sizeof(*intr_pipe));
intr_pipe->qh.element = UHCI_PTR_TERM;
intr_pipe->qh.link = (u32)&term_pipe->qh | UHCI_PTR_QH;
intr_pipe->pipe.cntl = &cntl->usb;
int i;
for (i=0; i<ARRAY_SIZE(fl->links); i++)
fl->links[i] = (u32)&intr_pipe->qh | UHCI_PTR_QH;
cntl->framelist = fl;
cntl->control_qh = &intr_pipe->qh;
barrier();
// Set the frame length to the default: 1 ms exactly
outb(USBSOF_DEFAULT, cntl->iobase + USBSOF);
// Store the frame list base address
outl((u32)fl->links, cntl->iobase + USBFLBASEADD);
// Set the current frame number
outw(0, cntl->iobase + USBFRNUM);
// Mark as configured and running with a 64-byte max packet.
outw(USBCMD_RS | USBCMD_CF | USBCMD_MAXP, cntl->iobase + USBCMD);
// Find devices
int count = check_uhci_ports(cntl);
uhci_free_pipes(cntl);
if (count)
// Success
return;
// No devices found - shutdown and free controller.
outw(0, cntl->iobase + USBCMD);
fail:
free(term_td);
free(fl);
free(intr_pipe);
free(term_pipe);
free(cntl);
}
static void
uhci_controller_setup(struct pci_device *pci)
{
u16 bdf = pci->bdf;
struct usb_uhci_s *cntl = malloc_tmphigh(sizeof(*cntl));
if (!cntl) {
warn_noalloc();
return;
}
wait_preempt(); // Avoid pci_config_readl when preempting
memset(cntl, 0, sizeof(*cntl));
cntl->usb.pci = pci;
cntl->usb.type = USB_TYPE_UHCI;
cntl->iobase = (pci_config_readl(bdf, PCI_BASE_ADDRESS_4)
& PCI_BASE_ADDRESS_IO_MASK);
dprintf(1, "UHCI init on dev %02x:%02x.%x (io=%x)\n"
, pci_bdf_to_bus(bdf), pci_bdf_to_dev(bdf)
, pci_bdf_to_fn(bdf), cntl->iobase);
pci_config_maskw(bdf, PCI_COMMAND, 0, PCI_COMMAND_MASTER);
reset_uhci(cntl, bdf);
run_thread(configure_uhci, cntl);
}
void
uhci_setup(void)
{
if (! CONFIG_USB_UHCI)
return;
struct pci_device *pci;
foreachpci(pci) {
if (pci_classprog(pci) == PCI_CLASS_SERIAL_USB_UHCI)
uhci_controller_setup(pci);
}
}
/****************************************************************
* End point communication
****************************************************************/
static struct usb_pipe *
uhci_alloc_intr_pipe(struct usbdevice_s *usbdev
, struct usb_endpoint_descriptor *epdesc)
{
struct usb_uhci_s *cntl = container_of(
usbdev->hub->cntl, struct usb_uhci_s, usb);
int frameexp = usb_get_period(usbdev, epdesc);
dprintf(7, "uhci_alloc_intr_pipe %p %d\n", &cntl->usb, frameexp);
if (frameexp > 10)
frameexp = 10;
int maxpacket = epdesc->wMaxPacketSize;
// Determine number of entries needed for 2 timer ticks.
int ms = 1<<frameexp;
int count = DIV_ROUND_UP(ticks_to_ms(2), ms);
count = ALIGN(count, 2);
struct uhci_pipe *pipe = malloc_low(sizeof(*pipe));
struct uhci_td *tds = malloc_low(sizeof(*tds) * count);
void *data = malloc_low(maxpacket * count);
if (!pipe || !tds || !data) {
warn_noalloc();
goto fail;
}
memset(pipe, 0, sizeof(*pipe));
usb_desc2pipe(&pipe->pipe, usbdev, epdesc);
int lowspeed = pipe->pipe.speed;
int devaddr = pipe->pipe.devaddr | (pipe->pipe.ep << 7);
pipe->qh.element = (u32)tds;
pipe->next_td = &tds[0];
pipe->iobase = cntl->iobase;
int toggle = 0;
int i;
for (i=0; i<count; i++) {
tds[i].link = (i==count-1 ? (u32)&tds[0] : (u32)&tds[i+1]);
tds[i].status = (uhci_maxerr(3) | (lowspeed ? TD_CTRL_LS : 0)
| TD_CTRL_ACTIVE);
tds[i].token = (uhci_explen(maxpacket) | toggle
| (devaddr << TD_TOKEN_DEVADDR_SHIFT)
| USB_PID_IN);
tds[i].buffer = data + maxpacket * i;
toggle ^= TD_TOKEN_TOGGLE;
}
// Add to interrupt schedule.
struct uhci_framelist *fl = cntl->framelist;
if (frameexp == 0) {
// Add to existing interrupt entry.
struct uhci_qh *intr_qh = (void*)(fl->links[0] & ~UHCI_PTR_BITS);
pipe->qh.link = intr_qh->link;
barrier();
intr_qh->link = (u32)&pipe->qh | UHCI_PTR_QH;
if (cntl->control_qh == intr_qh)
cntl->control_qh = &pipe->qh;
} else {
int startpos = 1<<(frameexp-1);
pipe->qh.link = fl->links[startpos];
barrier();
for (i=startpos; i<ARRAY_SIZE(fl->links); i+=ms)
fl->links[i] = (u32)&pipe->qh | UHCI_PTR_QH;
}
return &pipe->pipe;
fail:
free(pipe);
free(tds);
free(data);
return NULL;
}
struct usb_pipe *
uhci_alloc_pipe(struct usbdevice_s *usbdev
, struct usb_endpoint_descriptor *epdesc)
{
if (! CONFIG_USB_UHCI)
return NULL;
u8 eptype = epdesc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
if (eptype == USB_ENDPOINT_XFER_INT)
return uhci_alloc_intr_pipe(usbdev, epdesc);
struct usb_uhci_s *cntl = container_of(
usbdev->hub->cntl, struct usb_uhci_s, usb);
dprintf(7, "uhci_alloc_async_pipe %p %d\n", &cntl->usb, eptype);
struct usb_pipe *usbpipe = usb_get_freelist(&cntl->usb, eptype);
if (usbpipe) {
// Use previously allocated pipe.
usb_desc2pipe(usbpipe, usbdev, epdesc);
return usbpipe;
}
// Allocate a new queue head.
struct uhci_pipe *pipe;
if (eptype == USB_ENDPOINT_XFER_CONTROL)
pipe = malloc_tmphigh(sizeof(*pipe));
else
pipe = malloc_low(sizeof(*pipe));
if (!pipe) {
warn_noalloc();
return NULL;
}
memset(pipe, 0, sizeof(*pipe));
usb_desc2pipe(&pipe->pipe, usbdev, epdesc);
pipe->qh.element = UHCI_PTR_TERM;
pipe->iobase = cntl->iobase;
// Add queue head to controller list.
struct uhci_qh *control_qh = cntl->control_qh;
pipe->qh.link = control_qh->link;
barrier();
control_qh->link = (u32)&pipe->qh | UHCI_PTR_QH;
if (eptype == USB_ENDPOINT_XFER_CONTROL)
cntl->control_qh = &pipe->qh;
return &pipe->pipe;
}
static int
wait_pipe(struct uhci_pipe *pipe, u32 end)
{
for (;;) {
u32 el_link = GET_LOWFLAT(pipe->qh.element);
if (el_link & UHCI_PTR_TERM)
return 0;
if (timer_check(end)) {
warn_timeout();
u16 iobase = GET_LOWFLAT(pipe->iobase);
struct uhci_td *td = (void*)(el_link & ~UHCI_PTR_BITS);
dprintf(1, "Timeout on wait_pipe %p (td=%p s=%x c=%x/%x)\n"
, pipe, (void*)el_link, GET_LOWFLAT(td->status)
, inw(iobase + USBCMD)
, inw(iobase + USBSTS));
SET_LOWFLAT(pipe->qh.element, UHCI_PTR_TERM);
uhci_waittick(iobase);
return -1;
}
yield();
}
}
static int
wait_td(struct uhci_td *td, u32 end)
{
u32 status;
for (;;) {
status = td->status;
if (!(status & TD_CTRL_ACTIVE))
break;
if (timer_check(end)) {
warn_timeout();
return -1;
}
yield();
}
if (status & TD_CTRL_ANY_ERROR) {
dprintf(1, "wait_td error - status=%x\n", status);
return -2;
}
return 0;
}
int
uhci_send_control(struct usb_pipe *p, int dir, const void *cmd, int cmdsize
, void *data, int datasize)
{
ASSERT32FLAT();
if (! CONFIG_USB_UHCI)
return -1;
dprintf(5, "uhci_control %p\n", p);
struct uhci_pipe *pipe = container_of(p, struct uhci_pipe, pipe);
int maxpacket = pipe->pipe.maxpacket;
int lowspeed = pipe->pipe.speed;
int devaddr = pipe->pipe.devaddr | (pipe->pipe.ep << 7);
// Setup transfer descriptors
int count = 2 + DIV_ROUND_UP(datasize, maxpacket);
struct uhci_td *tds = malloc_tmphigh(sizeof(*tds) * count);
if (!tds) {
warn_noalloc();
return -1;
}
tds[0].link = (u32)&tds[1] | UHCI_PTR_DEPTH;
tds[0].status = (uhci_maxerr(3) | (lowspeed ? TD_CTRL_LS : 0)
| TD_CTRL_ACTIVE);
tds[0].token = (uhci_explen(cmdsize) | (devaddr << TD_TOKEN_DEVADDR_SHIFT)
| USB_PID_SETUP);
tds[0].buffer = (void*)cmd;
int toggle = TD_TOKEN_TOGGLE;
int i;
for (i=1; i<count-1; i++) {
tds[i].link = (u32)&tds[i+1] | UHCI_PTR_DEPTH;
tds[i].status = (uhci_maxerr(3) | (lowspeed ? TD_CTRL_LS : 0)
| TD_CTRL_ACTIVE);
int len = (i == count-2 ? (datasize - (i-1)*maxpacket) : maxpacket);
tds[i].token = (uhci_explen(len) | toggle
| (devaddr << TD_TOKEN_DEVADDR_SHIFT)
| (dir ? USB_PID_IN : USB_PID_OUT));
tds[i].buffer = data + (i-1) * maxpacket;
toggle ^= TD_TOKEN_TOGGLE;
}
tds[i].link = UHCI_PTR_TERM;
tds[i].status = (uhci_maxerr(0) | (lowspeed ? TD_CTRL_LS : 0)
| TD_CTRL_ACTIVE);
tds[i].token = (uhci_explen(0) | TD_TOKEN_TOGGLE
| (devaddr << TD_TOKEN_DEVADDR_SHIFT)
| (dir ? USB_PID_OUT : USB_PID_IN));
tds[i].buffer = 0;
// Transfer data
barrier();
pipe->qh.element = (u32)&tds[0];
int ret = wait_pipe(pipe, timer_calc(usb_xfer_time(p, datasize)));
free(tds);
return ret;
}
#define STACKTDS 4
#define TDALIGN 16
int
uhci_send_bulk(struct usb_pipe *p, int dir, void *data, int datasize)
{
if (! CONFIG_USB_UHCI)
return -1;
struct uhci_pipe *pipe = container_of(p, struct uhci_pipe, pipe);
dprintf(7, "uhci_send_bulk qh=%p dir=%d data=%p size=%d\n"
, &pipe->qh, dir, data, datasize);
int maxpacket = GET_LOWFLAT(pipe->pipe.maxpacket);
int lowspeed = GET_LOWFLAT(pipe->pipe.speed);
int devaddr = (GET_LOWFLAT(pipe->pipe.devaddr)
| (GET_LOWFLAT(pipe->pipe.ep) << 7));
int toggle = GET_LOWFLAT(pipe->toggle) ? TD_TOKEN_TOGGLE : 0;
// Allocate 4 tds on stack (16byte aligned)
u8 tdsbuf[sizeof(struct uhci_td) * STACKTDS + TDALIGN - 1];
struct uhci_td *tds = (void*)ALIGN((u32)tdsbuf, TDALIGN);
memset(tds, 0, sizeof(*tds) * STACKTDS);
// Enable tds
u32 end = timer_calc(usb_xfer_time(p, datasize));
barrier();
SET_LOWFLAT(pipe->qh.element, (u32)MAKE_FLATPTR(GET_SEG(SS), tds));
int tdpos = 0;
while (datasize) {
struct uhci_td *td = &tds[tdpos++ % STACKTDS];
int ret = wait_td(td, end);
if (ret)
goto fail;
int transfer = datasize;
if (transfer > maxpacket)
transfer = maxpacket;
struct uhci_td *nexttd_fl = MAKE_FLATPTR(GET_SEG(SS)
, &tds[tdpos % STACKTDS]);
td->link = (transfer==datasize ? UHCI_PTR_TERM : (u32)nexttd_fl);
td->token = (uhci_explen(transfer) | toggle
| (devaddr << TD_TOKEN_DEVADDR_SHIFT)
| (dir ? USB_PID_IN : USB_PID_OUT));
td->buffer = data;
barrier();
td->status = (uhci_maxerr(3) | (lowspeed ? TD_CTRL_LS : 0)
| TD_CTRL_ACTIVE);
toggle ^= TD_TOKEN_TOGGLE;
data += transfer;
datasize -= transfer;
}
SET_LOWFLAT(pipe->toggle, !!toggle);
return wait_pipe(pipe, end);
fail:
dprintf(1, "uhci_send_bulk failed\n");
SET_LOWFLAT(pipe->qh.element, UHCI_PTR_TERM);
uhci_waittick(GET_LOWFLAT(pipe->iobase));
return -1;
}
int
uhci_poll_intr(struct usb_pipe *p, void *data)
{
ASSERT16();
if (! CONFIG_USB_UHCI)
return -1;
struct uhci_pipe *pipe = container_of(p, struct uhci_pipe, pipe);
struct uhci_td *td = GET_LOWFLAT(pipe->next_td);
u32 status = GET_LOWFLAT(td->status);
u32 token = GET_LOWFLAT(td->token);
if (status & TD_CTRL_ACTIVE)
// No intrs found.
return -1;
// XXX - check for errors.
// Copy data.
void *tddata = GET_LOWFLAT(td->buffer);
memcpy_far(GET_SEG(SS), data, SEG_LOW, LOWFLAT2LOW(tddata)
, uhci_expected_length(token));
// Reenable this td.
struct uhci_td *next = (void*)(GET_LOWFLAT(td->link) & ~UHCI_PTR_BITS);
SET_LOWFLAT(pipe->next_td, next);
barrier();
SET_LOWFLAT(td->status, (uhci_maxerr(0) | (status & TD_CTRL_LS)
| TD_CTRL_ACTIVE));
return 0;
}
|