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