usb/host/ohci.c

   1 /*
   2        ppcskel - a Free Software replacement for the Nintendo/BroadOn bootloader.
   3        ohci hardware support
   4
   5 Copyright (C) 2009     Bernhard Urban <lewurm@gmx.net>
   6 Copyright (C) 2009     Sebastian Falbesoner <sebastian.falbesoner@gmail.com>
   7
   8 # This code is licensed to you under the terms of the GNU GPL, version 2;
   9 # see file COPYING or http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt
  10 */
  11
  12 #include "../../bootmii_ppc.h"
  13 #include "../../hollywood.h"
  14 #include "../../irq.h"
  15 #include "../../string.h"
  16 #include "../../malloc.h"
  17 #include "ohci.h"
  18 #include "host.h"
  19 #include "../usbspec/usb11spec.h"
  20
  21 /* macro for accessing u32 variables that need to be in little endian byte order;
  22  *
  23  * whenever you read or write from an u32 field that the ohci host controller
  24  * will read or write from too, use this macro for access!
  25  */
  26 #define LE(dword) (u32)( (((dword) & 0xFF000000) >> 24) | \
  27                            (((dword) & 0x00FF0000) >> 8)  | \
  28                            (((dword) & 0x0000FF00) << 8)  | \
  29                            (((dword) & 0x000000FF) << 24) )
  30
  31 static struct endpoint_descriptor *allocate_endpoint();
  32 static struct general_td *allocate_general_td();
  33 static void control_quirk();
  34 static void dbg_op_state();
  35 //static void dbg_td_flag(u32 flag);
  36 static void configure_ports(u8 from_init);
  37 static void setup_port(u32 reg, u8 from_init);
  38
  39 static struct ohci_hcca hcca_oh0;
  40
  41
  42 static struct endpoint_descriptor *allocate_endpoint()
  43 {
  44         struct endpoint_descriptor *ep;
  45         ep = (struct endpoint_descriptor *)memalign(16, sizeof(struct endpoint_descriptor));
  46         memset(ep, 0, sizeof(struct endpoint_descriptor));
  47         ep->flags = LE(OHCI_ENDPOINT_GENERAL_FORMAT);
  48         ep->headp = ep->tailp = ep->nexted = LE(0);
  49         return ep;
  50 }
  51
  52 static struct general_td *allocate_general_td()
  53 {
  54         struct general_td *td;
  55         td = (struct general_td *)memalign(16, sizeof(struct general_td));
  56         memset(td, 0, sizeof(struct general_td));
  57         td->flags = LE(0);
  58         td->nexttd = LE(0);
  59         td->cbp = td->be = LE(0);
  60         return td;
  61 }
  62
  63 static void control_quirk()
  64 {
  65         static struct endpoint_descriptor *ed = 0; /* empty ED */
  66         static struct general_td *td = 0; /* dummy TD */
  67         u32 head;
  68         u32 current;
  69         u32 status;
  70
  71         /*
  72          * One time only.
  73          * Allocate and keep a special empty ED with just a dummy TD.
  74          */
  75         if (!ed) {
  76                 ed = allocate_endpoint();
  77                 if (!ed)
  78                         return;
  79
  80                 td = allocate_general_td(0);
  81                 if (!td) {
  82                         free(ed);
  83                         ed = NULL;
  84                         return;
  85                 }
  86
  87                 ed->tailp = ed->headp = LE(virt_to_phys((void*) ((u32)td & OHCI_ENDPOINT_HEAD_MASK)));
  88                 ed->flags |= LE(OHCI_ENDPOINT_DIRECTION_OUT);
  89         }
  90
  91         /*
  92          * The OHCI USB host controllers on the Nintendo Wii
  93          * video game console stop working when new TDs are
  94          * added to a scheduled control ED after a transfer has
  95          * has taken place on it.
  96          *
  97          * Before scheduling any new control TD, we make the
  98          * controller happy by always loading a special control ED
  99          * with a single dummy TD and letting the controller attempt
 100          * the transfer.
 101          * The controller won't do anything with it, as the special
 102          * ED has no TDs, but it will keep the controller from failing
 103          * on the next transfer.
 104          */
 105         head = read32(OHCI0_HC_CTRL_HEAD_ED);
 106         if (head) {
 107                 printf("head: 0x%08X\n", head);
 108                 /*
 109                  * Load the special empty ED and tell the controller to
 110                  * process the control list.
 111                  */
 112                 sync_after_write(ed, 16);
 113                 sync_after_write(td, 16);
 114                 write32(OHCI0_HC_CTRL_HEAD_ED, virt_to_phys(ed));
 115
 116                 status = read32(OHCI0_HC_CONTROL);
 117                 set32(OHCI0_HC_CONTROL, OHCI_CTRL_CLE);
 118                 write32(OHCI0_HC_COMMAND_STATUS, OHCI_CLF);
 119
 120                 /* spin until the controller is done with the control list */
 121                 current = read32(OHCI0_HC_CTRL_CURRENT_ED);
 122                 while(!current) {
 123                         udelay(10);
 124                         current = read32(OHCI0_HC_CTRL_CURRENT_ED);
 125                 }
 126
 127                 printf("current: 0x%08X\n", current);
 128
 129                 /* restore the old control head and control settings */
 130                 write32(OHCI0_HC_CONTROL, status);
 131                 write32(OHCI0_HC_CTRL_HEAD_ED, head);
 132         } else {
 133                 printf("nohead!\n");
 134         }
 135 }
 136
 137
 138 static void dbg_op_state()
 139 {
 140         switch (read32(OHCI0_HC_CONTROL) & OHCI_CTRL_HCFS) {
 141                 case OHCI_USB_SUSPEND:
 142                         printf("ohci-- OHCI_USB_SUSPEND\n");
 143                         break;
 144                 case OHCI_USB_RESET:
 145                         printf("ohci-- OHCI_USB_RESET\n");
 146                         break;
 147                 case OHCI_USB_OPER:
 148                         printf("ohci-- OHCI_USB_OPER\n");
 149                         break;
 150                 case OHCI_USB_RESUME:
 151                         printf("ohci-- OHCI_USB_RESUME\n");
 152                         break;
 153         }
 154 }
 155
 156 static void dbg_td_flag(u32 flag)
 157 {
 158         printf("**************** dbg_td_flag: 0x%08X ***************\n", flag);
 159         printf("CC: %X\tshould be 0, see page 32 (ohci spec)\n", (flag>>28)&0xf);
 160         printf("EC: %X\tsee page 20 (ohci spec)\n", (flag>>26)&3);
 161         printf(" T: %X\n", (flag>>24)&3);
 162         printf("DI: %X\n", (flag>>21)&7);
 163         printf("DP: %X\n", (flag>>19)&3);
 164         printf(" R: %X\n", (flag>>18)&1);
 165         printf("********************************************************\n");
 166 }
 167
 168 static void general_td_fill(struct general_td *dest, const usb_transfer_descriptor *src)
 169 {
 170         if(src->actlen) {
 171                 dest->cbp = LE(virt_to_phys(src->buffer));
 172                 dest->be = LE(LE(dest->cbp) + src->actlen - 1);
 173                 /* save virtual address here */
 174                 dest->bufaddr = (u32) src->buffer;
 175         }
 176         else {
 177                 dest->cbp = dest->be = LE(0);
 178                 dest->bufaddr = 0;
 179         }
 180
 181         dest->buflen = src->actlen;
 182
 183         dest->flags &= LE(~OHCI_TD_DIRECTION_PID_MASK);
 184         switch(src->pid) {
 185                 case USB_PID_SETUP:
 186                         printf("pid_setup\n");
 187                         dest->flags |= LE(OHCI_TD_DIRECTION_PID_SETUP);
 188                         dest->flags |= LE(OHCI_TD_TOGGLE_0);
 189                         dest->flags |= LE(OHCI_TD_BUFFER_ROUNDING);
 190                         break;
 191                 case USB_PID_OUT:
 192                         printf("pid_out\n");
 193                         dest->flags |= LE(OHCI_TD_DIRECTION_PID_OUT);
 194                         dest->flags |= LE(OHCI_TD_BUFFER_ROUNDING);
 195
 196                         /*
 197                          * TODO: just temporary solution! (consider it with len?)
 198                          * there can be also regular PID_OUT pakets
 199                          */
 200                         dest->flags |= LE(OHCI_TD_TOGGLE_1);
 201                         break;
 202                 case USB_PID_IN:
 203                         printf("pid_in\n");
 204                         dest->flags |= LE(OHCI_TD_DIRECTION_PID_IN);
 205                         dest->flags |= LE(OHCI_TD_BUFFER_ROUNDING);
 206                         /*
 207                          * let the endpoint do the togglestuff!
 208                          * TODO: just temporary solution!
 209                          * there can be also inregular PID_IN pakets (@Status Stage)
 210                          */
 211                         dest->flags |= LE(OHCI_TD_TOGGLE_CARRY);
 212 #if 0
 213                         /* should be done by HC!
 214                          * first pid_in start with DATA0 */
 215                          */
 216                         dummyconfig.headp = LE( src->togl ?
 217                                         LE(dummyconfig.headp) | OHCI_ENDPOINT_TOGGLE_CARRY :
 218                                         LE(dummyconfig.headp) & ~OHCI_ENDPOINT_TOGGLE_CARRY);
 219 #endif
 220                         break;
 221         }
 222         dest->flags |= LE(OHCI_TD_SET_DELAY_INTERRUPT(7));
 223 }
 224
 225 static void dump_address(void *addr, u32 size, const char* str)
 226 {
 227         printf("%s hexdump (%d) @ 0x%08X:\n", str, size, addr);
 228         hexdump(addr, size);
 229 }
 230
 231 static struct endpoint_descriptor _edhead;
 232 struct endpoint_descriptor *edhead = 0;
 233 void hcdi_fire()
 234 {
 235         printf("<^>  <^>  <^> hcdi_fire(start)\n");
 236
 237         if(edhead == 0)
 238                 return;
 239
 240         control_quirk(); //required? YES! :O ... erm... or no? :/ ... in fact I have no idea
 241         write32(OHCI0_HC_CTRL_HEAD_ED, virt_to_phys(edhead));
 242
 243         /* sync it all */
 244         sync_after_write(edhead, sizeof(struct endpoint_descriptor));
 245         dump_address(edhead, sizeof(struct endpoint_descriptor), "edhead(before)");
 246
 247         struct general_td *x = phys_to_virt(LE(edhead->headp) & OHCI_ENDPOINT_HEAD_MASK);
 248         printf("STRUCT LEN: %d\n", sizeof(struct general_td));
 249         while(virt_to_phys(x)) {
 250                 sync_after_write(x, sizeof(struct general_td));
 251                 dump_address(x, sizeof(struct general_td), "x(before)");
 252
 253                 if(x->buflen > 0) {
 254                         sync_after_write((void*) phys_to_virt(LE(x->cbp)), x->buflen);
 255                         dump_address((void*) phys_to_virt(LE(x->cbp)), x->buflen, "x->cbp(before)");
 256                 }
 257                 x = phys_to_virt(LE(x->nexttd));
 258         }
 259
 260         /* trigger control list */
 261         set32(OHCI0_HC_CONTROL, OHCI_CTRL_CLE);
 262         write32(OHCI0_HC_COMMAND_STATUS, OHCI_CLF);
 263
 264         /* poll until edhead->headp is null */
 265         do {
 266                 sync_before_read(edhead, sizeof(struct endpoint_descriptor));
 267                 printf("edhead->headp: 0x%08X\n", LE(edhead->headp));
 268         } while(LE(edhead->headp)&~0xf);
 269
 270         struct general_td *n = phys_to_virt(read32(OHCI0_HC_DONE_HEAD) & ~1);
 271         printf("hc_done_head: 0x%08X\n", read32(OHCI0_HC_DONE_HEAD));
 272
 273         struct general_td *prev = 0, *next = 0;
 274         /* reverse done queue */
 275         while(virt_to_phys(n) && edhead->tdcount) {
 276                 sync_before_read((void*) n, sizeof(struct general_td));
 277                 printf("n: 0x%08X\n", n);
 278                 printf("next: 0x%08X\n", next);
 279                 printf("prev: 0x%08X\n", prev);
 280
 281                 next = n;
 282                 n = (struct general_td*) phys_to_virt(LE(n->nexttd));
 283                 next->nexttd = (u32) prev;
 284                 prev = next;
 285
 286                 edhead->tdcount--;
 287         }
 288
 289         n = next;
 290         prev = 0;
 291         while(virt_to_phys(n)) {
 292                 dump_address(n, sizeof(struct general_td), "n(after)");
 293
 294                 if(n->buflen > 0) {
 295                         sync_before_read((void*) n->bufaddr, n->buflen);
 296                         dump_address((void*) n->bufaddr, n->buflen, "n->bufaddr(after)");
 297                 }
 298                 dbg_td_flag(LE(n->flags));
 299                 prev = n;
 300                 n = (struct general_td*) n->nexttd;
 301                 free(prev);
 302         }
 303
 304         hcca_oh0.done_head = 0;
 305         sync_after_write(&hcca_oh0, sizeof(hcca_oh0));
 306
 307         write32(OHCI0_HC_CONTROL, read32(OHCI0_HC_CONTROL)&~OHCI_CTRL_CLE);
 308
 309         edhead = 0;
 310
 311         printf("<^>  <^>  <^> hcdi_fire(end)\n");
 312 }
 313
 314 /**
 315  * Enqueue a transfer descriptor.
 316  */
 317 u8 hcdi_enqueue(const usb_transfer_descriptor *td) {
 318         printf("*()*()*()*()*()*()*() hcdi_enqueue(start)\n");
 319         if(!edhead) {
 320                 edhead = &_edhead;
 321                 memset(edhead, 0, sizeof(struct endpoint_descriptor));
 322                 edhead->flags = LE(OHCI_ENDPOINT_GENERAL_FORMAT);
 323                 edhead->headp = edhead->tailp = edhead->nexted = LE(0);
 324                 edhead->flags |= LE(OHCI_ENDPOINT_LOW_SPEED |
 325                                 OHCI_ENDPOINT_SET_DEVICE_ADDRESS(td->devaddress) |
 326                                 OHCI_ENDPOINT_SET_ENDPOINT_NUMBER(td->endpoint) |
 327                                 OHCI_ENDPOINT_SET_MAX_PACKET_SIZE(td->maxp));
 328                 edhead->tdcount = 0;
 329         }
 330
 331         struct general_td *tdhw = allocate_general_td();
 332         general_td_fill(tdhw, td);
 333         edhead->tdcount ++;
 334
 335         if(!edhead->headp) {
 336                 /* first transfer */
 337                 edhead->headp = LE(virt_to_phys((void*) ((u32)tdhw & OHCI_ENDPOINT_HEAD_MASK)));
 338         }
 339         else {
 340                 /* headp in endpoint already exists
 341                  * => go to list end
 342                  */
 343                 struct general_td *n = (struct general_td*) phys_to_virt(LE(edhead->headp) & OHCI_ENDPOINT_HEAD_MASK);
 344                 while(LE(n->nexttd)) {
 345                         n = phys_to_virt(LE(n->nexttd));
 346                 }
 347                 n->nexttd = LE(virt_to_phys((void*) ((u32)tdhw & OHCI_ENDPOINT_HEAD_MASK)));
 348                 printf("n: 0x%08X\n", n);
 349                 printf("n->nexttd: 0x%08X\n", phys_to_virt(LE(n->nexttd)));
 350         }
 351
 352         printf("*()*()*()*()*()*()*() hcdi_enqueue(end)\n");
 353         return 0;
 354 }
 355
 356
 357 /**
 358  * Remove an transfer descriptor from transfer queue.
 359  */
 360 u8 hcdi_dequeue(usb_transfer_descriptor *td) {
 361         return 0;
 362 }
 363
 364 void hcdi_init()
 365 {
 366         printf("ohci-- init\n");
 367         dbg_op_state();
 368
 369         /* disable hc interrupts */
 370         set32(OHCI0_HC_INT_DISABLE, OHCI_INTR_MIE);
 371
 372         /* save fmInterval and calculate FSMPS */
 373 #define FSMP(fi) (0x7fff & ((6 * ((fi) - 210)) / 7))
 374 #define FI 0x2edf /* 12000 bits per frame (-1) */
 375         u32 fmint = read32(OHCI0_HC_FM_INTERVAL) & 0x3fff;
 376         if(fmint != FI)
 377                 printf("ohci-- fminterval delta: %d\n", fmint - FI);
 378         fmint |= FSMP (fmint) << 16;
 379
 380         /* enable interrupts of both usb host controllers */
 381         set32(EHCI_CTL, EHCI_CTL_OH0INTE | EHCI_CTL_OH1INTE | 0xe0000);
 382
 383         /* reset HC */
 384         write32(OHCI0_HC_COMMAND_STATUS, OHCI_HCR);
 385
 386         /* wait max. 30us */
 387         u32 ts = 30;
 388         while ((read32(OHCI0_HC_COMMAND_STATUS) & OHCI_HCR) != 0) {
 389                  if(--ts == 0) {
 390                         printf("ohci-- FAILED");
 391                         return;
 392                  }
 393                  udelay(1);
 394         }
 395
 396         /* disable interrupts; 2ms timelimit here!
 397            now we're in the SUSPEND state ... must go OPERATIONAL
 398            within 2msec else HC enters RESUME */
 399
 400         u32 cookie = irq_kill();
 401
 402         /* Tell the controller where the control and bulk lists are
 403          * The lists are empty now. */
 404         write32(OHCI0_HC_CTRL_HEAD_ED, 0);
 405         write32(OHCI0_HC_BULK_HEAD_ED, 0);
 406
 407         /* set hcca adress */
 408         sync_after_write(&hcca_oh0, 256);
 409         write32(OHCI0_HC_HCCA, virt_to_phys(&hcca_oh0));
 410
 411         /* set periodicstart */
 412 #define FIT (1<<31)
 413         u32 fmInterval = read32(OHCI0_HC_FM_INTERVAL) &0x3fff;
 414         u32 fit = read32(OHCI0_HC_FM_INTERVAL) & FIT;
 415
 416         write32(OHCI0_HC_FM_INTERVAL, fmint | (fit ^ FIT));
 417         write32(OHCI0_HC_PERIODIC_START, ((9*fmInterval)/10)&0x3fff);
 418
 419         /* testing bla */
 420         if ((read32(OHCI0_HC_FM_INTERVAL) & 0x3fff0000) == 0 || !read32(OHCI0_HC_PERIODIC_START)) {
 421                 printf("ohci-- w00t, fail!! see ohci-hcd.c:669\n");
 422         }
 423
 424         /* start HC operations */
 425         write32(OHCI0_HC_CONTROL, OHCI_CONTROL_INIT | OHCI_USB_OPER);
 426
 427         /* wake on ConnectStatusChange, matching external hubs */
 428         write32(OHCI0_HC_RH_STATUS, /*RH_HS_DRWE |*/ RH_HS_LPSC);
 429
 430         /* Choose the interrupts we care about now, others later on demand */
 431         write32(OHCI0_HC_INT_STATUS, ~0);
 432         write32(OHCI0_HC_INT_ENABLE, OHCI_INTR_INIT);
 433
 434         //wtf?
 435         wait_ms ((read32(OHCI0_HC_RH_DESCRIPTOR_A) >> 23) & 0x1fe);
 436
 437         configure_ports((u8)1);
 438         irq_restore(cookie);
 439
 440         dbg_op_state();
 441 }
 442
 443 static void configure_ports(u8 from_init)
 444 {
 445         printf("OHCI0_HC_RH_DESCRIPTOR_A:\t0x%08X\n", read32(OHCI0_HC_RH_DESCRIPTOR_A));
 446         printf("OHCI0_HC_RH_DESCRIPTOR_B:\t0x%08X\n", read32(OHCI0_HC_RH_DESCRIPTOR_B));
 447         printf("OHCI0_HC_RH_STATUS:\t\t0x%08X\n", read32(OHCI0_HC_RH_STATUS));
 448         printf("OHCI0_HC_RH_PORT_STATUS_1:\t0x%08X\n", read32(OHCI0_HC_RH_PORT_STATUS_1));
 449         printf("OHCI0_HC_RH_PORT_STATUS_2:\t0x%08X\n", read32(OHCI0_HC_RH_PORT_STATUS_2));
 450
 451         setup_port(OHCI0_HC_RH_PORT_STATUS_1, from_init);
 452         setup_port(OHCI0_HC_RH_PORT_STATUS_2, from_init);
 453         printf("configure_ports done\n");
 454 }
 455
 456 static void setup_port(u32 reg, u8 from_init)
 457 {
 458         u32 port = read32(reg);
 459         if((port & RH_PS_CCS) && ((port & RH_PS_CSC) || from_init)) {
 460                 write32(reg, RH_PS_CSC);
 461
 462                 wait_ms(120);
 463
 464                 /* clear CSC flag, set PES and start port reset (PRS) */
 465                 write32(reg, RH_PS_PES);
 466                 while(!(read32(reg) & RH_PS_PES)) {
 467                         printf("fu\n");
 468                         return;
 469                 }
 470
 471                 write32(reg, RH_PS_PRS);
 472
 473                 /* spin until port reset is complete */
 474                 while(!(read32(reg) & RH_PS_PRSC)); // hint: it may stuck here
 475                 printf("loop done\n");
 476
 477                 (void) usb_add_device();
 478         }
 479 }
 480
 481 void hcdi_irq()
 482 {
 483         /* read interrupt status */
 484         u32 flags = read32(OHCI0_HC_INT_STATUS);
 485
 486         /* when all bits are set to 1 some problem occured */
 487         if (flags == 0xffffffff) {
 488                 printf("ohci-- Houston, we have a serious problem! :(\n");
 489                 return;
 490         }
 491
 492         /* only care about interrupts that are enabled */
 493         flags &= read32(OHCI0_HC_INT_ENABLE);
 494
 495         /* nothing to do? */
 496         if (flags == 0) {
 497                 printf("OHCI Interrupt occured: but not for you! WTF?!\n");
 498                 return;
 499         }
 500
 501         printf("OHCI Interrupt occured: ");
 502         /* UnrecoverableError */
 503         if (flags & OHCI_INTR_UE) {
 504                 printf("UnrecoverableError\n");
 505                 /* TODO: well, I don't know... nothing,
 506                  *       because it won't happen anyway? ;-) */
 507         }
 508
 509         /* RootHubStatusChange */
 510         if (flags & OHCI_INTR_RHSC) {
 511                 printf("RootHubStatusChange\n");
 512                 /* TODO: set some next_statechange variable... */
 513                 configure_ports(0);
 514                 write32(OHCI0_HC_INT_STATUS, OHCI_INTR_RD | OHCI_INTR_RHSC);
 515         }
 516         /* ResumeDetected */
 517         else if (flags & OHCI_INTR_RD) {
 518                 printf("ResumeDetected\n");
 519                 write32(OHCI0_HC_INT_STATUS, OHCI_INTR_RD);
 520                 /* TODO: figure out what the linux kernel does here... */
 521         }
 522
 523         /* WritebackDoneHead */
 524         if (flags & OHCI_INTR_WDH) {
 525                 printf("WritebackDoneHead\n");
 526                 /* basically the linux irq handler reverse TDs to their urbs
 527                  * and set done_head to null.
 528                  * since we are polling atm, just should do the latter task.
 529                  * however, this won't work for now (i don't know why...)
 530                  * TODO!
 531                  */
 532 #if 0
 533                 sync_before_read(&hcca_oh0, 256);
 534                 hcca_oh0.done_head = 0;
 535                 sync_after_write(&hcca_oh0, 256);
 536 #endif
 537         }
 538
 539         /* TODO: handle any pending URB/ED unlinks... */
 540
 541 #define HC_IS_RUNNING() 1 /* dirty, i know... just a temporary solution */
 542         if (HC_IS_RUNNING()) {
 543                 write32(OHCI0_HC_INT_STATUS, flags);
 544                 write32(OHCI0_HC_INT_ENABLE, OHCI_INTR_MIE);
 545         }
 546 }
 547
 548 void show_frame_no()
 549 {
 550         sync_before_read(&hcca_oh0, 256);
 551         printf("***** frame_no: %d *****\n", LE(hcca_oh0.frame_no));
 552 }