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 #include "biosvar.h" // GET_GLOBAL
  16
  17 static void
  18 reset_uhci(struct usb_s *cntl)
  19 {
  20     // XXX - don't reset if not needed.
  21
  22     // Reset PIRQ and SMI
  23     pci_config_writew(cntl->bdf, USBLEGSUP, USBLEGSUP_RWC);
  24
  25     // Reset the HC
  26     outw(USBCMD_HCRESET, cntl->iobase + USBCMD);
  27     udelay(5);
  28
  29     // Disable interrupts and commands (just to be safe).
  30     outw(0, cntl->iobase + USBINTR);
  31     outw(0, cntl->iobase + USBCMD);
  32 }
  33
  34 static void
  35 configure_uhci(struct usb_s *cntl)
  36 {
  37     // Allocate ram for schedule storage
  38     struct uhci_td *term_td = malloc_high(sizeof(*term_td));
  39     struct uhci_framelist *fl = memalign_high(sizeof(*fl), sizeof(*fl));
  40     struct uhci_qh *data_qh = malloc_low(sizeof(*data_qh));
  41     struct uhci_qh *term_qh = malloc_high(sizeof(*term_qh));
  42     if (!term_td || !fl || !data_qh || !term_qh) {
  43         dprintf(1, "No ram for uhci init");
  44         return;
  45     }
  46
  47     // Work around for PIIX errata
  48     memset(term_td, 0, sizeof(*term_td));
  49     term_td->link = UHCI_PTR_TERM;
  50     term_td->token = (uhci_explen(0) | (0x7f << TD_TOKEN_DEVADDR_SHIFT)
  51                       | USB_PID_IN);
  52     memset(term_qh, 0, sizeof(*term_qh));
  53     term_qh->element = (u32)term_td;
  54     term_qh->link = UHCI_PTR_TERM;
  55
  56     // Setup primary queue head.
  57     memset(data_qh, 0, sizeof(*data_qh));
  58     data_qh->element = UHCI_PTR_TERM;
  59     data_qh->link = (u32)term_qh | UHCI_PTR_QH;
  60     cntl->qh = data_qh;
  61
  62     // Set schedule to point to primary queue head
  63     int i;
  64     for (i=0; i<ARRAY_SIZE(fl->links); i++) {
  65         fl->links[i] = (u32)data_qh | UHCI_PTR_QH;
  66     }
  67
  68     // Set the frame length to the default: 1 ms exactly
  69     outb(USBSOF_DEFAULT, cntl->iobase + USBSOF);
  70
  71     // Store the frame list base address
  72     outl((u32)fl->links, cntl->iobase + USBFLBASEADD);
  73
  74     // Set the current frame number
  75     outw(0, cntl->iobase + USBFRNUM);
  76 }
  77
  78 static void
  79 start_uhci(struct usb_s *cntl)
  80 {
  81     // Mark as configured and running with a 64-byte max packet.
  82     outw(USBCMD_RS | USBCMD_CF | USBCMD_MAXP, cntl->iobase + USBCMD);
  83 }
  84
  85 // Find any devices connected to the root hub.
  86 static int
  87 check_ports(struct usb_s *cntl)
  88 {
  89     u16 port1 = inw(cntl->iobase + USBPORTSC1);
  90     u16 port2 = inw(cntl->iobase + USBPORTSC2);
  91
  92     if (!((port1 & USBPORTSC_CCS) || (port2 & USBPORTSC_CCS)))
  93         // No devices
  94         return 0;
  95
  96     // reset ports
  97     if (port1 & USBPORTSC_CCS)
  98         outw(USBPORTSC_PR, cntl->iobase + USBPORTSC1);
  99     if (port2 & USBPORTSC_CCS)
 100         outw(USBPORTSC_PR, cntl->iobase + USBPORTSC2);
 101     mdelay(10);
 102     outw(0, cntl->iobase + USBPORTSC1);
 103     outw(0, cntl->iobase + USBPORTSC2);
 104     mdelay(10);
 105
 106     // Configure ports
 107     int totalcount = 0;
 108     port1 = inw(cntl->iobase + USBPORTSC1);
 109     if (port1 & USBPORTSC_CCS) {
 110         outw(USBPORTSC_PE, cntl->iobase + USBPORTSC1);
 111         int count = configure_usb_device(cntl, !!(port1 & USBPORTSC_LSDA));
 112         if (! count)
 113             outw(0, cntl->iobase + USBPORTSC1);
 114         totalcount += count;
 115     }
 116     port2 = inw(cntl->iobase + USBPORTSC2);
 117     if (port2 & USBPORTSC_CCS) {
 118         outw(USBPORTSC_PE, cntl->iobase + USBPORTSC2);
 119         int count = configure_usb_device(cntl, !!(port2 & USBPORTSC_LSDA));
 120         if (! count)
 121             outw(0, cntl->iobase + USBPORTSC2);
 122         totalcount += count;
 123     }
 124     return totalcount;
 125 }
 126
 127 int
 128 uhci_init(struct usb_s *cntl)
 129 {
 130     if (! CONFIG_USB_UHCI)
 131         return 0;
 132
 133     cntl->iobase = (pci_config_readl(cntl->bdf, PCI_BASE_ADDRESS_4)
 134                     & PCI_BASE_ADDRESS_IO_MASK);
 135
 136     dprintf(3, "UHCI init on dev %02x:%02x.%x (io=%x)\n"
 137             , pci_bdf_to_bus(cntl->bdf), pci_bdf_to_dev(cntl->bdf)
 138             , pci_bdf_to_fn(cntl->bdf), cntl->iobase);
 139
 140     pci_set_bus_master(cntl->bdf);
 141
 142     reset_uhci(cntl);
 143     configure_uhci(cntl);
 144     start_uhci(cntl);
 145
 146     int count = check_ports(cntl);
 147     if (! count) {
 148         // XXX - no devices; free data structures.
 149         return 0;
 150     }
 151
 152     return count;
 153 }
 154
 155 static int
 156 wait_qh(struct uhci_qh *qh)
 157 {
 158     // XXX - 500ms just a guess
 159     u64 end = calc_future_tsc(500);
 160     for (;;) {
 161         if (qh->element & UHCI_PTR_TERM)
 162             return 0;
 163         if (rdtscll() > end) {
 164             dprintf(1, "Timeout on wait_qh %p\n", qh);
 165             return -1;
 166         }
 167         cpu_relax();
 168     }
 169 }
 170
 171 int
 172 uhci_control(u32 endp, int dir, const void *cmd, int cmdsize
 173              , void *data, int datasize)
 174 {
 175     if (! CONFIG_USB_UHCI)
 176         return 0;
 177
 178     dprintf(5, "uhci_control %x\n", endp);
 179     struct usb_s *cntl = endp2cntl(endp);
 180     int maxpacket = endp2maxsize(endp);
 181     int lowspeed = endp2speed(endp);
 182     int devaddr = endp2devaddr(endp) | (endp2ep(endp) << 7);
 183
 184     // Setup transfer descriptors
 185     int count = 2 + DIV_ROUND_UP(datasize, maxpacket);
 186     struct uhci_td *tds = malloc_tmphigh(sizeof(*tds) * count);
 187
 188     tds[0].link = (u32)&tds[1] | UHCI_PTR_DEPTH;
 189     tds[0].status = (uhci_maxerr(3) | (lowspeed ? TD_CTRL_LS : 0)
 190                      | TD_CTRL_ACTIVE);
 191     tds[0].token = (uhci_explen(cmdsize) | (devaddr << TD_TOKEN_DEVADDR_SHIFT)
 192                     | USB_PID_SETUP);
 193     tds[0].buffer = (void*)cmd;
 194     int toggle = TD_TOKEN_TOGGLE;
 195     int i;
 196     for (i=1; i<count-1; i++) {
 197         tds[i].link = (u32)&tds[i+1] | UHCI_PTR_DEPTH;
 198         tds[i].status = (uhci_maxerr(3) | (lowspeed ? TD_CTRL_LS : 0)
 199                          | TD_CTRL_ACTIVE);
 200         int len = (i == count-2 ? (datasize - (i-1)*maxpacket) : maxpacket);
 201         tds[i].token = (uhci_explen(len) | toggle
 202                         | (devaddr << TD_TOKEN_DEVADDR_SHIFT)
 203                         | (dir ? USB_PID_IN : USB_PID_OUT));
 204         tds[i].buffer = data + (i-1) * maxpacket;
 205         toggle ^= TD_TOKEN_TOGGLE;
 206     }
 207     tds[i].link = UHCI_PTR_TERM;
 208     tds[i].status = (uhci_maxerr(0) | (lowspeed ? TD_CTRL_LS : 0)
 209                      | TD_CTRL_ACTIVE);
 210     tds[i].token = (uhci_explen(0) | TD_TOKEN_TOGGLE
 211                     | (devaddr << TD_TOKEN_DEVADDR_SHIFT)
 212                     | (dir ? USB_PID_OUT : USB_PID_IN));
 213     tds[i].buffer = 0;
 214
 215     // Transfer data
 216     struct uhci_qh *data_qh = cntl->qh;
 217     data_qh->element = (u32)&tds[0];
 218     int ret = wait_qh(data_qh);
 219     if (ret)
 220         // XXX - leak tds
 221         return ret;
 222     // XXX - free(tds);
 223     return 0;
 224 }
 225
 226 void *
 227 uhci_alloc_intr_pipe(u32 endp, int period)
 228 {
 229     if (! CONFIG_USB_UHCI)
 230         return NULL;
 231
 232     dprintf(7, "uhci_alloc_intr_pipe %x %d\n", endp, period);
 233     struct usb_s *cntl = endp2cntl(endp);
 234     int maxpacket = endp2maxsize(endp);
 235     int lowspeed = endp2speed(endp);
 236     int devaddr = endp2devaddr(endp) | (endp2ep(endp) << 7);
 237     // XXX - just grab 20 for now.
 238     int count = 20;
 239     struct uhci_qh *qh = malloc_low(sizeof(*qh));
 240     struct uhci_td *tds = malloc_low(sizeof(*tds) * count);
 241     if (!qh || !tds)
 242         return NULL;
 243     if (maxpacket > sizeof(tds[0].data))
 244         // XXX - free qh/tds
 245         return NULL;
 246
 247     qh->element = (u32)tds;
 248     int toggle = 0;
 249     int i;
 250     for (i=0; i<count; i++) {
 251         tds[i].link = (i==count-1 ? (u32)&tds[0] : (u32)&tds[i+1]);
 252         tds[i].status = (uhci_maxerr(3) | (lowspeed ? TD_CTRL_LS : 0)
 253                          | TD_CTRL_ACTIVE);
 254         tds[i].token = (uhci_explen(maxpacket) | toggle
 255                         | (devaddr << TD_TOKEN_DEVADDR_SHIFT)
 256                         | USB_PID_IN);
 257         tds[i].buffer = &tds[i].data;
 258         toggle ^= TD_TOKEN_TOGGLE;
 259     }
 260
 261     qh->next_td = &tds[0];
 262
 263     // XXX - need schedule - just add to primary list for now.
 264     struct uhci_qh *data_qh = cntl->qh;
 265     qh->link = data_qh->link;
 266     data_qh->link = (u32)qh | UHCI_PTR_QH;
 267
 268     return qh;
 269 }
 270
 271 int
 272 uhci_poll_intr(void *pipe, void *data)
 273 {
 274     ASSERT16();
 275     if (! CONFIG_USB_UHCI)
 276         return -1;
 277
 278     struct uhci_qh *qh = pipe;
 279     struct uhci_td *td = GET_FLATPTR(qh->next_td);
 280     u32 status = GET_FLATPTR(td->status);
 281     u32 token = GET_FLATPTR(td->token);
 282     if (status & TD_CTRL_ACTIVE)
 283         // No intrs found.
 284         return -1;
 285     // XXX - check for errors.
 286
 287     // Copy data.
 288     memcpy_far(GET_SEG(SS), data
 289                , FLATPTR_TO_SEG(td->data), (void*)FLATPTR_TO_OFFSET(td->data)
 290                , uhci_expected_length(token));
 291
 292     // Reenable this td.
 293     u32 next = GET_FLATPTR(td->link);
 294     SET_FLATPTR(td->status, (uhci_maxerr(0) | (status & TD_CTRL_LS)
 295                              | TD_CTRL_ACTIVE));
 296     SET_FLATPTR(qh->next_td, (void*)(next & ~UHCI_PTR_BITS));
 297
 298     return 0;
 299 }