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