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