roms/seabios/src/usb-ohci.c

   1 // Code for handling OHCI 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 "usb-ohci.h" // struct ohci_hcca
  11 #include "pci_regs.h" // PCI_BASE_ADDRESS_0
  12 #include "usb.h" // struct usb_s
  13 #include "farptr.h" // GET_FLATPTR
  14
  15 #define FIT                     (1 << 31)
  16
  17 struct usb_ohci_s {
  18     struct usb_s usb;
  19     struct ohci_regs *regs;
  20 };
  21
  22
  23 /****************************************************************
  24  * Root hub
  25  ****************************************************************/
  26
  27 // Check if device attached to port
  28 static int
  29 ohci_hub_detect(struct usbhub_s *hub, u32 port)
  30 {
  31     struct usb_ohci_s *cntl = container_of(hub->cntl, struct usb_ohci_s, usb);
  32     u32 sts = readl(&cntl->regs->roothub_portstatus[port]);
  33     if (!(sts & RH_PS_CCS))
  34         // No device.
  35         return -1;
  36
  37     // XXX - need to wait for USB_TIME_ATTDB if just powered up?
  38
  39     return 0;
  40 }
  41
  42 // Disable port
  43 static void
  44 ohci_hub_disconnect(struct usbhub_s *hub, u32 port)
  45 {
  46     struct usb_ohci_s *cntl = container_of(hub->cntl, struct usb_ohci_s, usb);
  47     writel(&cntl->regs->roothub_portstatus[port], RH_PS_CCS|RH_PS_LSDA);
  48 }
  49
  50 // Reset device on port
  51 static int
  52 ohci_hub_reset(struct usbhub_s *hub, u32 port)
  53 {
  54     struct usb_ohci_s *cntl = container_of(hub->cntl, struct usb_ohci_s, usb);
  55     writel(&cntl->regs->roothub_portstatus[port], RH_PS_PRS);
  56     u32 sts;
  57     u64 end = calc_future_tsc(USB_TIME_DRSTR * 2);
  58     for (;;) {
  59         sts = readl(&cntl->regs->roothub_portstatus[port]);
  60         if (!(sts & RH_PS_PRS))
  61             // XXX - need to ensure USB_TIME_DRSTR time in reset?
  62             break;
  63         if (check_tsc(end)) {
  64             // Timeout.
  65             warn_timeout();
  66             ohci_hub_disconnect(hub, port);
  67             return -1;
  68         }
  69         yield();
  70     }
  71
  72     if ((sts & (RH_PS_CCS|RH_PS_PES)) != (RH_PS_CCS|RH_PS_PES))
  73         // Device no longer present
  74         return -1;
  75
  76     return !!(sts & RH_PS_LSDA);
  77 }
  78
  79 static struct usbhub_op_s ohci_HubOp = {
  80     .detect = ohci_hub_detect,
  81     .reset = ohci_hub_reset,
  82     .disconnect = ohci_hub_disconnect,
  83 };
  84
  85 // Find any devices connected to the root hub.
  86 static int
  87 check_ohci_ports(struct usb_ohci_s *cntl)
  88 {
  89     ASSERT32FLAT();
  90     // Turn on power for all devices on roothub.
  91     u32 rha = readl(&cntl->regs->roothub_a);
  92     rha &= ~(RH_A_PSM | RH_A_OCPM);
  93     writel(&cntl->regs->roothub_status, RH_HS_LPSC);
  94     writel(&cntl->regs->roothub_b, RH_B_PPCM);
  95     msleep((rha >> 24) * 2);
  96     // XXX - need to sleep for USB_TIME_SIGATT if just powered up?
  97
  98     struct usbhub_s hub;
  99     memset(&hub, 0, sizeof(hub));
 100     hub.cntl = &cntl->usb;
 101     hub.portcount = rha & RH_A_NDP;
 102     hub.op = &ohci_HubOp;
 103     usb_enumerate(&hub);
 104     return hub.devcount;
 105 }
 106
 107
 108 /****************************************************************
 109  * Setup
 110  ****************************************************************/
 111
 112 static int
 113 start_ohci(struct usb_ohci_s *cntl, struct ohci_hcca *hcca)
 114 {
 115     u32 oldfminterval = readl(&cntl->regs->fminterval);
 116     u32 oldrwc = readl(&cntl->regs->control) & OHCI_CTRL_RWC;
 117
 118     // XXX - check if already running?
 119
 120     // Do reset
 121     writel(&cntl->regs->control, OHCI_USB_RESET | oldrwc);
 122     readl(&cntl->regs->control); // flush writes
 123     msleep(USB_TIME_DRSTR);
 124
 125     // Do software init (min 10us, max 2ms)
 126     u64 end = calc_future_tsc_usec(10);
 127     writel(&cntl->regs->cmdstatus, OHCI_HCR);
 128     for (;;) {
 129         u32 status = readl(&cntl->regs->cmdstatus);
 130         if (! status & OHCI_HCR)
 131             break;
 132         if (check_tsc(end)) {
 133             warn_timeout();
 134             return -1;
 135         }
 136     }
 137
 138     // Init memory
 139     writel(&cntl->regs->ed_controlhead, 0);
 140     writel(&cntl->regs->ed_bulkhead, 0);
 141     writel(&cntl->regs->hcca, (u32)hcca);
 142
 143     // Init fminterval
 144     u32 fi = oldfminterval & 0x3fff;
 145     writel(&cntl->regs->fminterval
 146            , (((oldfminterval & FIT) ^ FIT)
 147               | fi | (((6 * (fi - 210)) / 7) << 16)));
 148     writel(&cntl->regs->periodicstart, ((9 * fi) / 10) & 0x3fff);
 149     readl(&cntl->regs->control); // flush writes
 150
 151     // XXX - verify that fminterval was setup correctly.
 152
 153     // Go into operational state
 154     writel(&cntl->regs->control
 155            , (OHCI_CTRL_CBSR | OHCI_CTRL_CLE | OHCI_CTRL_PLE
 156               | OHCI_USB_OPER | oldrwc));
 157     readl(&cntl->regs->control); // flush writes
 158
 159     return 0;
 160 }
 161
 162 static void
 163 stop_ohci(struct usb_ohci_s *cntl)
 164 {
 165     u32 oldrwc = readl(&cntl->regs->control) & OHCI_CTRL_RWC;
 166     writel(&cntl->regs->control, oldrwc);
 167     readl(&cntl->regs->control); // flush writes
 168 }
 169
 170 static void
 171 configure_ohci(void *data)
 172 {
 173     struct usb_ohci_s *cntl = data;
 174
 175     // Allocate memory
 176     struct ohci_hcca *hcca = memalign_high(256, sizeof(*hcca));
 177     struct ohci_ed *intr_ed = malloc_high(sizeof(*intr_ed));
 178     if (!hcca || !intr_ed) {
 179         warn_noalloc();
 180         goto free;
 181     }
 182     memset(hcca, 0, sizeof(*hcca));
 183     memset(intr_ed, 0, sizeof(*intr_ed));
 184     intr_ed->hwINFO = ED_SKIP;
 185     int i;
 186     for (i=0; i<ARRAY_SIZE(hcca->int_table); i++)
 187         hcca->int_table[i] = (u32)intr_ed;
 188
 189     int ret = start_ohci(cntl, hcca);
 190     if (ret)
 191         goto err;
 192
 193     int count = check_ohci_ports(cntl);
 194     free_pipe(cntl->usb.defaultpipe);
 195     if (! count)
 196         goto err;
 197     return;
 198
 199 err:
 200     stop_ohci(cntl);
 201 free:
 202     free(hcca);
 203     free(intr_ed);
 204 }
 205
 206 void
 207 ohci_init(u16 bdf, int busid)
 208 {
 209     if (! CONFIG_USB_OHCI)
 210         return;
 211     struct usb_ohci_s *cntl = malloc_tmphigh(sizeof(*cntl));
 212     memset(cntl, 0, sizeof(*cntl));
 213     cntl->usb.busid = busid;
 214     cntl->usb.type = USB_TYPE_OHCI;
 215
 216     u32 baseaddr = pci_config_readl(bdf, PCI_BASE_ADDRESS_0);
 217     cntl->regs = (void*)(baseaddr & PCI_BASE_ADDRESS_MEM_MASK);
 218
 219     dprintf(1, "OHCI init on dev %02x:%02x.%x (regs=%p)\n"
 220             , pci_bdf_to_bus(bdf), pci_bdf_to_dev(bdf)
 221             , pci_bdf_to_fn(bdf), cntl->regs);
 222
 223     // Enable bus mastering and memory access.
 224     pci_config_maskw(bdf, PCI_COMMAND
 225                      , 0, PCI_COMMAND_MASTER|PCI_COMMAND_MEMORY);
 226
 227     // XXX - check for and disable SMM control?
 228
 229     // Disable interrupts
 230     writel(&cntl->regs->intrdisable, ~0);
 231     writel(&cntl->regs->intrstatus, ~0);
 232
 233     run_thread(configure_ohci, cntl);
 234 }
 235
 236
 237 /****************************************************************
 238  * End point communication
 239  ****************************************************************/
 240
 241 static int
 242 wait_ed(struct ohci_ed *ed)
 243 {
 244     // XXX - 500ms just a guess
 245     u64 end = calc_future_tsc(500);
 246     for (;;) {
 247         if (ed->hwHeadP == ed->hwTailP)
 248             return 0;
 249         if (check_tsc(end)) {
 250             warn_timeout();
 251             return -1;
 252         }
 253         yield();
 254     }
 255 }
 256
 257 // Wait for next USB frame to start - for ensuring safe memory release.
 258 static void
 259 ohci_waittick(struct usb_ohci_s *cntl)
 260 {
 261     barrier();
 262     struct ohci_hcca *hcca = (void*)cntl->regs->hcca;
 263     u32 startframe = hcca->frame_no;
 264     u64 end = calc_future_tsc(1000 * 5);
 265     for (;;) {
 266         if (hcca->frame_no != startframe)
 267             break;
 268         if (check_tsc(end)) {
 269             warn_timeout();
 270             return;
 271         }
 272         yield();
 273     }
 274 }
 275
 276 static void
 277 signal_freelist(struct usb_ohci_s *cntl)
 278 {
 279     u32 v = readl(&cntl->regs->control);
 280     if (v & OHCI_CTRL_CLE) {
 281         writel(&cntl->regs->control, v & ~(OHCI_CTRL_CLE|OHCI_CTRL_BLE));
 282         ohci_waittick(cntl);
 283         writel(&cntl->regs->ed_controlcurrent, 0);
 284         writel(&cntl->regs->ed_bulkcurrent, 0);
 285         writel(&cntl->regs->control, v);
 286     } else {
 287         ohci_waittick(cntl);
 288     }
 289 }
 290
 291 struct ohci_pipe {
 292     struct ohci_ed ed;
 293     struct usb_pipe pipe;
 294     void *data;
 295     int count;
 296     struct ohci_td *tds;
 297 };
 298
 299 void
 300 ohci_free_pipe(struct usb_pipe *p)
 301 {
 302     if (! CONFIG_USB_OHCI)
 303         return;
 304     dprintf(7, "ohci_free_pipe %p\n", p);
 305     struct ohci_pipe *pipe = container_of(p, struct ohci_pipe, pipe);
 306     struct usb_ohci_s *cntl = container_of(
 307         pipe->pipe.cntl, struct usb_ohci_s, usb);
 308
 309     u32 *pos = &cntl->regs->ed_controlhead;
 310     for (;;) {
 311         struct ohci_ed *next = (void*)*pos;
 312         if (!next) {
 313             // Not found?!  Exit without freeing.
 314             warn_internalerror();
 315             return;
 316         }
 317         if (next == &pipe->ed) {
 318             *pos = next->hwNextED;
 319             signal_freelist(cntl);
 320             free(pipe);
 321             return;
 322         }
 323         pos = &next->hwNextED;
 324     }
 325 }
 326
 327 struct usb_pipe *
 328 ohci_alloc_control_pipe(struct usb_pipe *dummy)
 329 {
 330     if (! CONFIG_USB_OHCI)
 331         return NULL;
 332     struct usb_ohci_s *cntl = container_of(
 333         dummy->cntl, struct usb_ohci_s, usb);
 334     dprintf(7, "ohci_alloc_control_pipe %p\n", &cntl->usb);
 335
 336     // Allocate a queue head.
 337     struct ohci_pipe *pipe = malloc_tmphigh(sizeof(*pipe));
 338     if (!pipe) {
 339         warn_noalloc();
 340         return NULL;
 341     }
 342     memset(pipe, 0, sizeof(*pipe));
 343     memcpy(&pipe->pipe, dummy, sizeof(pipe->pipe));
 344     pipe->ed.hwINFO = ED_SKIP;
 345
 346     // Add queue head to controller list.
 347     pipe->ed.hwNextED = cntl->regs->ed_controlhead;
 348     barrier();
 349     cntl->regs->ed_controlhead = (u32)&pipe->ed;
 350     return &pipe->pipe;
 351 }
 352
 353 int
 354 ohci_control(struct usb_pipe *p, int dir, const void *cmd, int cmdsize
 355              , void *data, int datasize)
 356 {
 357     if (! CONFIG_USB_OHCI)
 358         return -1;
 359     dprintf(5, "ohci_control %p\n", p);
 360     if (datasize > 4096) {
 361         // XXX - should support larger sizes.
 362         warn_noalloc();
 363         return -1;
 364     }
 365     struct ohci_pipe *pipe = container_of(p, struct ohci_pipe, pipe);
 366     struct usb_ohci_s *cntl = container_of(
 367         pipe->pipe.cntl, struct usb_ohci_s, usb);
 368     int maxpacket = pipe->pipe.maxpacket;
 369     int lowspeed = pipe->pipe.speed;
 370     int devaddr = pipe->pipe.devaddr | (pipe->pipe.ep << 7);
 371
 372     // Setup transfer descriptors
 373     struct ohci_td *tds = malloc_tmphigh(sizeof(*tds) * 3);
 374     if (!tds) {
 375         warn_noalloc();
 376         return -1;
 377     }
 378     struct ohci_td *td = tds;
 379     td->hwINFO = TD_DP_SETUP | TD_T_DATA0 | TD_CC;
 380     td->hwCBP = (u32)cmd;
 381     td->hwNextTD = (u32)&td[1];
 382     td->hwBE = (u32)cmd + cmdsize - 1;
 383     td++;
 384     if (datasize) {
 385         td->hwINFO = (dir ? TD_DP_IN : TD_DP_OUT) | TD_T_DATA1 | TD_CC;
 386         td->hwCBP = (u32)data;
 387         td->hwNextTD = (u32)&td[1];
 388         td->hwBE = (u32)data + datasize - 1;
 389         td++;
 390     }
 391     td->hwINFO = (dir ? TD_DP_OUT : TD_DP_IN) | TD_T_DATA1 | TD_CC;
 392     td->hwCBP = 0;
 393     td->hwNextTD = (u32)&td[1];
 394     td->hwBE = 0;
 395     td++;
 396
 397     // Transfer data
 398     pipe->ed.hwINFO = ED_SKIP;
 399     barrier();
 400     pipe->ed.hwHeadP = (u32)tds;
 401     pipe->ed.hwTailP = (u32)td;
 402     barrier();
 403     pipe->ed.hwINFO = devaddr | (maxpacket << 16) | (lowspeed ? ED_LOWSPEED : 0);
 404     writel(&cntl->regs->cmdstatus, OHCI_CLF);
 405
 406     int ret = wait_ed(&pipe->ed);
 407     pipe->ed.hwINFO = ED_SKIP;
 408     if (ret)
 409         ohci_waittick(cntl);
 410     free(tds);
 411     return ret;
 412 }
 413
 414 struct usb_pipe *
 415 ohci_alloc_intr_pipe(struct usb_pipe *dummy, int frameexp)
 416 {
 417     if (! CONFIG_USB_OHCI)
 418         return NULL;
 419     struct usb_ohci_s *cntl = container_of(
 420         dummy->cntl, struct usb_ohci_s, usb);
 421     dprintf(7, "ohci_alloc_intr_pipe %p %d\n", &cntl->usb, frameexp);
 422
 423     if (frameexp > 5)
 424         frameexp = 5;
 425     int maxpacket = dummy->maxpacket;
 426     int lowspeed = dummy->speed;
 427     int devaddr = dummy->devaddr | (dummy->ep << 7);
 428     // Determine number of entries needed for 2 timer ticks.
 429     int ms = 1<<frameexp;
 430     int count = DIV_ROUND_UP(PIT_TICK_INTERVAL * 1000 * 2, PIT_TICK_RATE * ms)+1;
 431     struct ohci_pipe *pipe = malloc_low(sizeof(*pipe));
 432     struct ohci_td *tds = malloc_low(sizeof(*tds) * count);
 433     void *data = malloc_low(maxpacket * count);
 434     if (!pipe || !tds || !data)
 435         goto err;
 436     memset(pipe, 0, sizeof(*pipe));
 437     memcpy(&pipe->pipe, dummy, sizeof(pipe->pipe));
 438     pipe->data = data;
 439     pipe->count = count;
 440     pipe->tds = tds;
 441
 442     struct ohci_ed *ed = &pipe->ed;
 443     ed->hwHeadP = (u32)&tds[0];
 444     ed->hwTailP = (u32)&tds[count-1];
 445     ed->hwINFO = devaddr | (maxpacket << 16) | (lowspeed ? ED_LOWSPEED : 0);
 446
 447     int i;
 448     for (i=0; i<count-1; i++) {
 449         tds[i].hwINFO = TD_DP_IN | TD_T_TOGGLE | TD_CC;
 450         tds[i].hwCBP = (u32)data + maxpacket * i;
 451         tds[i].hwNextTD = (u32)&tds[i+1];
 452         tds[i].hwBE = tds[i].hwCBP + maxpacket - 1;
 453     }
 454
 455     // Add to interrupt schedule.
 456     barrier();
 457     struct ohci_hcca *hcca = (void*)cntl->regs->hcca;
 458     if (frameexp == 0) {
 459         // Add to existing interrupt entry.
 460         struct ohci_ed *intr_ed = (void*)hcca->int_table[0];
 461         ed->hwNextED = intr_ed->hwNextED;
 462         intr_ed->hwNextED = (u32)ed;
 463     } else {
 464         int startpos = 1<<(frameexp-1);
 465         ed->hwNextED = hcca->int_table[startpos];
 466         for (i=startpos; i<ARRAY_SIZE(hcca->int_table); i+=ms)
 467             hcca->int_table[i] = (u32)ed;
 468     }
 469
 470     return &pipe->pipe;
 471
 472 err:
 473     free(pipe);
 474     free(tds);
 475     free(data);
 476     return NULL;
 477 }
 478
 479 int
 480 ohci_poll_intr(struct usb_pipe *p, void *data)
 481 {
 482     ASSERT16();
 483     if (! CONFIG_USB_OHCI)
 484         return -1;
 485
 486     struct ohci_pipe *pipe = container_of(p, struct ohci_pipe, pipe);
 487     struct ohci_td *tds = GET_FLATPTR(pipe->tds);
 488     struct ohci_td *head = (void*)GET_FLATPTR(pipe->ed.hwHeadP);
 489     struct ohci_td *tail = (void*)GET_FLATPTR(pipe->ed.hwTailP);
 490     int count = GET_FLATPTR(pipe->count);
 491     int pos = (tail - tds + 1) % count;
 492     struct ohci_td *next = &tds[pos];
 493     if (head == next)
 494         // No intrs found.
 495         return -1;
 496     // XXX - check for errors.
 497
 498     // Copy data.
 499     int maxpacket = GET_FLATPTR(pipe->pipe.maxpacket);
 500     void *pipedata = GET_FLATPTR(pipe->data);
 501     void *intrdata = pipedata + maxpacket * pos;
 502     memcpy_far(GET_SEG(SS), data
 503                , FLATPTR_TO_SEG(intrdata), (void*)FLATPTR_TO_OFFSET(intrdata)
 504                , maxpacket);
 505
 506     // Reenable this td.
 507     SET_FLATPTR(tail->hwINFO, TD_DP_IN | TD_T_TOGGLE | TD_CC);
 508     intrdata = pipedata + maxpacket * (tail-tds);
 509     SET_FLATPTR(tail->hwCBP, (u32)intrdata);
 510     SET_FLATPTR(tail->hwNextTD, (u32)next);
 511     SET_FLATPTR(tail->hwBE, (u32)intrdata + maxpacket - 1);
 512     barrier();
 513     SET_FLATPTR(pipe->ed.hwTailP, (u32)next);
 514
 515     return 0;
 516 }