vgabios: Use standard VGA IO wrappers in geodevga.c.
[seabios.git] / src / usb-uhci.c
1 // Code for handling UHCI USB controllers.
2 //
3 // Copyright (C) 2009  Kevin O'Connor <kevin@koconnor.net>
4 //
5 // This file may be distributed under the terms of the GNU LGPLv3 license.
6
7 #include "util.h" // dprintf
8 #include "pci.h" // pci_bdf_to_bus
9 #include "config.h" // CONFIG_*
10 #include "ioport.h" // outw
11 #include "usb-uhci.h" // USBLEGSUP
12 #include "pci_regs.h" // PCI_BASE_ADDRESS_4
13 #include "usb.h" // struct usb_s
14 #include "farptr.h" // GET_FLATPTR
15
16 struct usb_uhci_s {
17     struct usb_s usb;
18     u16 iobase;
19     struct uhci_qh *control_qh, *bulk_qh;
20     struct uhci_framelist *framelist;
21 };
22
23
24 /****************************************************************
25  * Root hub
26  ****************************************************************/
27
28 // Check if device attached to a given port
29 static int
30 uhci_hub_detect(struct usbhub_s *hub, u32 port)
31 {
32     struct usb_uhci_s *cntl = container_of(hub->cntl, struct usb_uhci_s, usb);
33     u16 ioport = cntl->iobase + USBPORTSC1 + port * 2;
34
35     u16 status = inw(ioport);
36     if (!(status & USBPORTSC_CCS))
37         // No device
38         return -1;
39
40     // XXX - if just powered up, need to wait for USB_TIME_ATTDB?
41
42     // Begin reset on port
43     outw(USBPORTSC_PR, ioport);
44     msleep(USB_TIME_DRSTR);
45     return 0;
46 }
47
48 // Reset device on port
49 static int
50 uhci_hub_reset(struct usbhub_s *hub, u32 port)
51 {
52     struct usb_uhci_s *cntl = container_of(hub->cntl, struct usb_uhci_s, usb);
53     u16 ioport = cntl->iobase + USBPORTSC1 + port * 2;
54
55     // Finish reset on port
56     outw(0, ioport);
57     udelay(6); // 64 high-speed bit times
58     u16 status = inw(ioport);
59     if (!(status & USBPORTSC_CCS))
60         // No longer connected
61         return -1;
62     outw(USBPORTSC_PE, ioport);
63     return !!(status & USBPORTSC_LSDA);
64 }
65
66 // Disable port
67 static void
68 uhci_hub_disconnect(struct usbhub_s *hub, u32 port)
69 {
70     struct usb_uhci_s *cntl = container_of(hub->cntl, struct usb_uhci_s, usb);
71     u16 ioport = cntl->iobase + USBPORTSC1 + port * 2;
72     outw(0, ioport);
73 }
74
75 static struct usbhub_op_s uhci_HubOp = {
76     .detect = uhci_hub_detect,
77     .reset = uhci_hub_reset,
78     .disconnect = uhci_hub_disconnect,
79 };
80
81 // Find any devices connected to the root hub.
82 static int
83 check_uhci_ports(struct usb_uhci_s *cntl)
84 {
85     ASSERT32FLAT();
86     struct usbhub_s hub;
87     memset(&hub, 0, sizeof(hub));
88     hub.cntl = &cntl->usb;
89     hub.portcount = 2;
90     hub.op = &uhci_HubOp;
91     usb_enumerate(&hub);
92     return hub.devcount;
93 }
94
95
96 /****************************************************************
97  * Setup
98  ****************************************************************/
99
100 static void
101 reset_uhci(struct usb_uhci_s *cntl, u16 bdf)
102 {
103     // XXX - don't reset if not needed.
104
105     // Reset PIRQ and SMI
106     pci_config_writew(bdf, USBLEGSUP, USBLEGSUP_RWC);
107
108     // Reset the HC
109     outw(USBCMD_HCRESET, cntl->iobase + USBCMD);
110     udelay(5);
111
112     // Disable interrupts and commands (just to be safe).
113     outw(0, cntl->iobase + USBINTR);
114     outw(0, cntl->iobase + USBCMD);
115 }
116
117 static void
118 configure_uhci(void *data)
119 {
120     struct usb_uhci_s *cntl = data;
121
122     // Allocate ram for schedule storage
123     struct uhci_td *term_td = malloc_high(sizeof(*term_td));
124     struct uhci_framelist *fl = memalign_high(sizeof(*fl), sizeof(*fl));
125     struct uhci_qh *intr_qh = malloc_high(sizeof(*intr_qh));
126     struct uhci_qh *term_qh = malloc_high(sizeof(*term_qh));
127     if (!term_td || !fl || !intr_qh || !term_qh) {
128         warn_noalloc();
129         goto fail;
130     }
131
132     // Work around for PIIX errata
133     memset(term_td, 0, sizeof(*term_td));
134     term_td->link = UHCI_PTR_TERM;
135     term_td->token = (uhci_explen(0) | (0x7f << TD_TOKEN_DEVADDR_SHIFT)
136                       | USB_PID_IN);
137     memset(term_qh, 0, sizeof(*term_qh));
138     term_qh->element = (u32)term_td;
139     term_qh->link = UHCI_PTR_TERM;
140
141     // Set schedule to point to primary intr queue head
142     memset(intr_qh, 0, sizeof(*intr_qh));
143     intr_qh->element = UHCI_PTR_TERM;
144     intr_qh->link = (u32)term_qh | UHCI_PTR_QH;
145     int i;
146     for (i=0; i<ARRAY_SIZE(fl->links); i++)
147         fl->links[i] = (u32)intr_qh | UHCI_PTR_QH;
148     cntl->framelist = fl;
149     cntl->control_qh = cntl->bulk_qh = intr_qh;
150     barrier();
151
152     // Set the frame length to the default: 1 ms exactly
153     outb(USBSOF_DEFAULT, cntl->iobase + USBSOF);
154
155     // Store the frame list base address
156     outl((u32)fl->links, cntl->iobase + USBFLBASEADD);
157
158     // Set the current frame number
159     outw(0, cntl->iobase + USBFRNUM);
160
161     // Mark as configured and running with a 64-byte max packet.
162     outw(USBCMD_RS | USBCMD_CF | USBCMD_MAXP, cntl->iobase + USBCMD);
163
164     // Find devices
165     int count = check_uhci_ports(cntl);
166     free_pipe(cntl->usb.defaultpipe);
167     if (count)
168         // Success
169         return;
170
171     // No devices found - shutdown and free controller.
172     outw(0, cntl->iobase + USBCMD);
173 fail:
174     free(term_td);
175     free(fl);
176     free(intr_qh);
177     free(term_qh);
178     free(cntl);
179 }
180
181 void
182 uhci_init(struct pci_device *pci, int busid)
183 {
184     if (! CONFIG_USB_UHCI)
185         return;
186     u16 bdf = pci->bdf;
187     struct usb_uhci_s *cntl = malloc_tmphigh(sizeof(*cntl));
188     if (!cntl) {
189         warn_noalloc();
190         return;
191     }
192     memset(cntl, 0, sizeof(*cntl));
193     cntl->usb.busid = busid;
194     cntl->usb.pci = pci;
195     cntl->usb.type = USB_TYPE_UHCI;
196     cntl->iobase = (pci_config_readl(bdf, PCI_BASE_ADDRESS_4)
197                     & PCI_BASE_ADDRESS_IO_MASK);
198
199     dprintf(1, "UHCI init on dev %02x:%02x.%x (io=%x)\n"
200             , pci_bdf_to_bus(bdf), pci_bdf_to_dev(bdf)
201             , pci_bdf_to_fn(bdf), cntl->iobase);
202
203     pci_config_maskw(bdf, PCI_COMMAND, 0, PCI_COMMAND_MASTER);
204
205     reset_uhci(cntl, bdf);
206
207     run_thread(configure_uhci, cntl);
208 }
209
210
211 /****************************************************************
212  * End point communication
213  ****************************************************************/
214
215 struct uhci_pipe {
216     struct uhci_qh qh;
217     struct uhci_td *next_td;
218     struct usb_pipe pipe;
219     u16 iobase;
220     u8 toggle;
221 };
222
223 // Wait for next USB frame to start - for ensuring safe memory release.
224 static void
225 uhci_waittick(u16 iobase)
226 {
227     barrier();
228     u16 startframe = inw(iobase + USBFRNUM);
229     u64 end = calc_future_tsc(1000 * 5);
230     for (;;) {
231         if (inw(iobase + USBFRNUM) != startframe)
232             break;
233         if (check_tsc(end)) {
234             warn_timeout();
235             return;
236         }
237         yield();
238     }
239 }
240
241 static int
242 wait_pipe(struct uhci_pipe *pipe, int timeout)
243 {
244     u64 end = calc_future_tsc(timeout);
245     for (;;) {
246         u32 el_link = GET_FLATPTR(pipe->qh.element);
247         if (el_link & UHCI_PTR_TERM)
248             return 0;
249         if (check_tsc(end)) {
250             warn_timeout();
251             u16 iobase = GET_FLATPTR(pipe->iobase);
252             struct uhci_td *td = (void*)(el_link & ~UHCI_PTR_BITS);
253             dprintf(1, "Timeout on wait_pipe %p (td=%p s=%x c=%x/%x)\n"
254                     , pipe, (void*)el_link, GET_FLATPTR(td->status)
255                     , inw(iobase + USBCMD)
256                     , inw(iobase + USBSTS));
257             SET_FLATPTR(pipe->qh.element, UHCI_PTR_TERM);
258             uhci_waittick(iobase);
259             return -1;
260         }
261         yield();
262     }
263 }
264
265 void
266 uhci_free_pipe(struct usb_pipe *p)
267 {
268     if (! CONFIG_USB_UHCI)
269         return;
270     dprintf(7, "uhci_free_pipe %p\n", p);
271     struct uhci_pipe *pipe = container_of(p, struct uhci_pipe, pipe);
272     struct usb_uhci_s *cntl = container_of(
273         pipe->pipe.cntl, struct usb_uhci_s, usb);
274
275     struct uhci_qh *pos = (void*)(cntl->framelist->links[0] & ~UHCI_PTR_BITS);
276     for (;;) {
277         u32 link = pos->link;
278         if (link == UHCI_PTR_TERM) {
279             // Not found?!  Exit without freeing.
280             warn_internalerror();
281             return;
282         }
283         struct uhci_qh *next = (void*)(link & ~UHCI_PTR_BITS);
284         if (next == &pipe->qh) {
285             pos->link = next->link;
286             if (cntl->control_qh == next)
287                 cntl->control_qh = pos;
288             if (cntl->bulk_qh == next)
289                 cntl->bulk_qh = pos;
290             uhci_waittick(cntl->iobase);
291             free(pipe);
292             return;
293         }
294         pos = next;
295     }
296 }
297
298 struct usb_pipe *
299 uhci_alloc_control_pipe(struct usb_pipe *dummy)
300 {
301     if (! CONFIG_USB_UHCI)
302         return NULL;
303     struct usb_uhci_s *cntl = container_of(
304         dummy->cntl, struct usb_uhci_s, usb);
305     dprintf(7, "uhci_alloc_control_pipe %p\n", &cntl->usb);
306
307     // Allocate a queue head.
308     struct uhci_pipe *pipe = malloc_tmphigh(sizeof(*pipe));
309     if (!pipe) {
310         warn_noalloc();
311         return NULL;
312     }
313     memset(pipe, 0, sizeof(*pipe));
314     memcpy(&pipe->pipe, dummy, sizeof(pipe->pipe));
315     pipe->qh.element = UHCI_PTR_TERM;
316     pipe->iobase = cntl->iobase;
317
318     // Add queue head to controller list.
319     struct uhci_qh *control_qh = cntl->control_qh;
320     pipe->qh.link = control_qh->link;
321     barrier();
322     control_qh->link = (u32)&pipe->qh | UHCI_PTR_QH;
323     if (cntl->bulk_qh == control_qh)
324         cntl->bulk_qh = &pipe->qh;
325     return &pipe->pipe;
326 }
327
328 int
329 uhci_control(struct usb_pipe *p, int dir, const void *cmd, int cmdsize
330              , void *data, int datasize)
331 {
332     ASSERT32FLAT();
333     if (! CONFIG_USB_UHCI)
334         return -1;
335     dprintf(5, "uhci_control %p\n", p);
336     struct uhci_pipe *pipe = container_of(p, struct uhci_pipe, pipe);
337
338     int maxpacket = pipe->pipe.maxpacket;
339     int lowspeed = pipe->pipe.speed;
340     int devaddr = pipe->pipe.devaddr | (pipe->pipe.ep << 7);
341
342     // Setup transfer descriptors
343     int count = 2 + DIV_ROUND_UP(datasize, maxpacket);
344     struct uhci_td *tds = malloc_tmphigh(sizeof(*tds) * count);
345     if (!tds) {
346         warn_noalloc();
347         return -1;
348     }
349
350     tds[0].link = (u32)&tds[1] | UHCI_PTR_DEPTH;
351     tds[0].status = (uhci_maxerr(3) | (lowspeed ? TD_CTRL_LS : 0)
352                      | TD_CTRL_ACTIVE);
353     tds[0].token = (uhci_explen(cmdsize) | (devaddr << TD_TOKEN_DEVADDR_SHIFT)
354                     | USB_PID_SETUP);
355     tds[0].buffer = (void*)cmd;
356     int toggle = TD_TOKEN_TOGGLE;
357     int i;
358     for (i=1; i<count-1; i++) {
359         tds[i].link = (u32)&tds[i+1] | UHCI_PTR_DEPTH;
360         tds[i].status = (uhci_maxerr(3) | (lowspeed ? TD_CTRL_LS : 0)
361                          | TD_CTRL_ACTIVE);
362         int len = (i == count-2 ? (datasize - (i-1)*maxpacket) : maxpacket);
363         tds[i].token = (uhci_explen(len) | toggle
364                         | (devaddr << TD_TOKEN_DEVADDR_SHIFT)
365                         | (dir ? USB_PID_IN : USB_PID_OUT));
366         tds[i].buffer = data + (i-1) * maxpacket;
367         toggle ^= TD_TOKEN_TOGGLE;
368     }
369     tds[i].link = UHCI_PTR_TERM;
370     tds[i].status = (uhci_maxerr(0) | (lowspeed ? TD_CTRL_LS : 0)
371                      | TD_CTRL_ACTIVE);
372     tds[i].token = (uhci_explen(0) | TD_TOKEN_TOGGLE
373                     | (devaddr << TD_TOKEN_DEVADDR_SHIFT)
374                     | (dir ? USB_PID_OUT : USB_PID_IN));
375     tds[i].buffer = 0;
376
377     // Transfer data
378     barrier();
379     pipe->qh.element = (u32)&tds[0];
380     int ret = wait_pipe(pipe, 500);
381     free(tds);
382     return ret;
383 }
384
385 struct usb_pipe *
386 uhci_alloc_bulk_pipe(struct usb_pipe *dummy)
387 {
388     if (! CONFIG_USB_UHCI)
389         return NULL;
390     struct usb_uhci_s *cntl = container_of(
391         dummy->cntl, struct usb_uhci_s, usb);
392     dprintf(7, "uhci_alloc_bulk_pipe %p\n", &cntl->usb);
393
394     // Allocate a queue head.
395     struct uhci_pipe *pipe = malloc_low(sizeof(*pipe));
396     if (!pipe) {
397         warn_noalloc();
398         return NULL;
399     }
400     memset(pipe, 0, sizeof(*pipe));
401     memcpy(&pipe->pipe, dummy, sizeof(pipe->pipe));
402     pipe->qh.element = UHCI_PTR_TERM;
403     pipe->iobase = cntl->iobase;
404
405     // Add queue head to controller list.
406     struct uhci_qh *bulk_qh = cntl->bulk_qh;
407     pipe->qh.link = bulk_qh->link;
408     barrier();
409     bulk_qh->link = (u32)&pipe->qh | UHCI_PTR_QH;
410
411     return &pipe->pipe;
412 }
413
414 static int
415 wait_td(struct uhci_td *td)
416 {
417     u64 end = calc_future_tsc(5000); // XXX - lookup real time.
418     u32 status;
419     for (;;) {
420         status = td->status;
421         if (!(status & TD_CTRL_ACTIVE))
422             break;
423         if (check_tsc(end)) {
424             warn_timeout();
425             return -1;
426         }
427         yield();
428     }
429     if (status & TD_CTRL_ANY_ERROR) {
430         dprintf(1, "wait_td error - status=%x\n", status);
431         return -2;
432     }
433     return 0;
434 }
435
436 #define STACKTDS 4
437 #define TDALIGN 16
438
439 int
440 uhci_send_bulk(struct usb_pipe *p, int dir, void *data, int datasize)
441 {
442     if (! CONFIG_USB_UHCI)
443         return -1;
444     struct uhci_pipe *pipe = container_of(p, struct uhci_pipe, pipe);
445     dprintf(7, "uhci_send_bulk qh=%p dir=%d data=%p size=%d\n"
446             , &pipe->qh, dir, data, datasize);
447     int maxpacket = GET_FLATPTR(pipe->pipe.maxpacket);
448     int lowspeed = GET_FLATPTR(pipe->pipe.speed);
449     int devaddr = (GET_FLATPTR(pipe->pipe.devaddr)
450                    | (GET_FLATPTR(pipe->pipe.ep) << 7));
451     int toggle = GET_FLATPTR(pipe->toggle) ? TD_TOKEN_TOGGLE : 0;
452
453     // Allocate 4 tds on stack (16byte aligned)
454     u8 tdsbuf[sizeof(struct uhci_td) * STACKTDS + TDALIGN - 1];
455     struct uhci_td *tds = (void*)ALIGN((u32)tdsbuf, TDALIGN);
456     memset(tds, 0, sizeof(*tds) * STACKTDS);
457
458     // Enable tds
459     barrier();
460     SET_FLATPTR(pipe->qh.element, (u32)MAKE_FLATPTR(GET_SEG(SS), tds));
461
462     int tdpos = 0;
463     while (datasize) {
464         struct uhci_td *td = &tds[tdpos++ % STACKTDS];
465         int ret = wait_td(td);
466         if (ret)
467             goto fail;
468
469         int transfer = datasize;
470         if (transfer > maxpacket)
471             transfer = maxpacket;
472         struct uhci_td *nexttd_fl = MAKE_FLATPTR(GET_SEG(SS)
473                                                  , &tds[tdpos % STACKTDS]);
474         td->link = (transfer==datasize ? UHCI_PTR_TERM : (u32)nexttd_fl);
475         td->token = (uhci_explen(transfer) | toggle
476                      | (devaddr << TD_TOKEN_DEVADDR_SHIFT)
477                      | (dir ? USB_PID_IN : USB_PID_OUT));
478         td->buffer = data;
479         barrier();
480         td->status = (uhci_maxerr(3) | (lowspeed ? TD_CTRL_LS : 0)
481                       | TD_CTRL_ACTIVE);
482         toggle ^= TD_TOKEN_TOGGLE;
483
484         data += transfer;
485         datasize -= transfer;
486     }
487     SET_FLATPTR(pipe->toggle, !!toggle);
488     return wait_pipe(pipe, 5000);
489 fail:
490     dprintf(1, "uhci_send_bulk failed\n");
491     SET_FLATPTR(pipe->qh.element, UHCI_PTR_TERM);
492     uhci_waittick(GET_FLATPTR(pipe->iobase));
493     return -1;
494 }
495
496 struct usb_pipe *
497 uhci_alloc_intr_pipe(struct usb_pipe *dummy, int frameexp)
498 {
499     if (! CONFIG_USB_UHCI)
500         return NULL;
501     struct usb_uhci_s *cntl = container_of(
502         dummy->cntl, struct usb_uhci_s, usb);
503     dprintf(7, "uhci_alloc_intr_pipe %p %d\n", &cntl->usb, frameexp);
504
505     if (frameexp > 10)
506         frameexp = 10;
507     int maxpacket = dummy->maxpacket;
508     int lowspeed = dummy->speed;
509     int devaddr = dummy->devaddr | (dummy->ep << 7);
510     // Determine number of entries needed for 2 timer ticks.
511     int ms = 1<<frameexp;
512     int count = DIV_ROUND_UP(PIT_TICK_INTERVAL * 1000 * 2, PIT_TICK_RATE * ms);
513     count = ALIGN(count, 2);
514     struct uhci_pipe *pipe = malloc_low(sizeof(*pipe));
515     struct uhci_td *tds = malloc_low(sizeof(*tds) * count);
516     void *data = malloc_low(maxpacket * count);
517     if (!pipe || !tds || !data) {
518         warn_noalloc();
519         goto fail;
520     }
521     memset(pipe, 0, sizeof(*pipe));
522     memcpy(&pipe->pipe, dummy, sizeof(pipe->pipe));
523     pipe->qh.element = (u32)tds;
524     pipe->next_td = &tds[0];
525     pipe->iobase = cntl->iobase;
526
527     int toggle = 0;
528     int i;
529     for (i=0; i<count; i++) {
530         tds[i].link = (i==count-1 ? (u32)&tds[0] : (u32)&tds[i+1]);
531         tds[i].status = (uhci_maxerr(3) | (lowspeed ? TD_CTRL_LS : 0)
532                          | TD_CTRL_ACTIVE);
533         tds[i].token = (uhci_explen(maxpacket) | toggle
534                         | (devaddr << TD_TOKEN_DEVADDR_SHIFT)
535                         | USB_PID_IN);
536         tds[i].buffer = data + maxpacket * i;
537         toggle ^= TD_TOKEN_TOGGLE;
538     }
539
540     // Add to interrupt schedule.
541     struct uhci_framelist *fl = cntl->framelist;
542     if (frameexp == 0) {
543         // Add to existing interrupt entry.
544         struct uhci_qh *intr_qh = (void*)(fl->links[0] & ~UHCI_PTR_BITS);
545         pipe->qh.link = intr_qh->link;
546         barrier();
547         intr_qh->link = (u32)&pipe->qh | UHCI_PTR_QH;
548         if (cntl->control_qh == intr_qh)
549             cntl->control_qh = &pipe->qh;
550         if (cntl->bulk_qh == intr_qh)
551             cntl->bulk_qh = &pipe->qh;
552     } else {
553         int startpos = 1<<(frameexp-1);
554         pipe->qh.link = fl->links[startpos];
555         barrier();
556         for (i=startpos; i<ARRAY_SIZE(fl->links); i+=ms)
557             fl->links[i] = (u32)&pipe->qh | UHCI_PTR_QH;
558     }
559
560     return &pipe->pipe;
561 fail:
562     free(pipe);
563     free(tds);
564     free(data);
565     return NULL;
566 }
567
568 int
569 uhci_poll_intr(struct usb_pipe *p, void *data)
570 {
571     ASSERT16();
572     if (! CONFIG_USB_UHCI)
573         return -1;
574
575     struct uhci_pipe *pipe = container_of(p, struct uhci_pipe, pipe);
576     struct uhci_td *td = GET_FLATPTR(pipe->next_td);
577     u32 status = GET_FLATPTR(td->status);
578     u32 token = GET_FLATPTR(td->token);
579     if (status & TD_CTRL_ACTIVE)
580         // No intrs found.
581         return -1;
582     // XXX - check for errors.
583
584     // Copy data.
585     void *tddata = GET_FLATPTR(td->buffer);
586     memcpy_far(GET_SEG(SS), data
587                , FLATPTR_TO_SEG(tddata), (void*)FLATPTR_TO_OFFSET(tddata)
588                , uhci_expected_length(token));
589
590     // Reenable this td.
591     struct uhci_td *next = (void*)(GET_FLATPTR(td->link) & ~UHCI_PTR_BITS);
592     SET_FLATPTR(pipe->next_td, next);
593     barrier();
594     SET_FLATPTR(td->status, (uhci_maxerr(0) | (status & TD_CTRL_LS)
595                              | TD_CTRL_ACTIVE));
596
597     return 0;
598 }