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 ohci_hcca hcca_oh0;
  30
  31 static struct endpoint_descriptor *allocate_endpoint()
  32 {
  33         struct endpoint_descriptor *ep;
  34         ep = (struct endpoint_descriptor *)calloc(sizeof(struct endpoint_descriptor), 16);
  35         ep->flags = ACCESS_LE(OHCI_ENDPOINT_GENERAL_FORMAT);
  36         ep->headp = ep->tailp = ep->nexted = ACCESS_LE(0);
  37         return ep;
  38 }
  39
  40 static struct general_td *allocate_general_td(size_t bsize)
  41 {
  42         struct general_td *td;
  43         td = (struct general_td *)calloc(sizeof(struct general_td), 16);
  44         td->flags = ACCESS_LE(0);
  45         td->nexttd = ACCESS_LE(virt_to_phys(td));
  46         if(bsize == 0) {
  47                 td->cbp = td->be = ACCESS_LE(0);
  48         } else {
  49                 td->cbp = ACCESS_LE(virt_to_phys(malloc(bsize)));
  50                 td->be = ACCESS_LE(ACCESS_LE(td->cbp) + bsize - 1);
  51         }
  52         return td;
  53 }
  54
  55 static void control_quirk()
  56 {
  57         static struct endpoint_descriptor *ed; /* empty ED */
  58         static struct general_td *td; /* dummy TD */
  59         u32 head;
  60         u32 current;
  61         u32 status;
  62
  63         /*
  64          * One time only.
  65          * Allocate and keep a special empty ED with just a dummy TD.
  66          */
  67         if (!ed) {
  68                 ed = allocate_endpoint();
  69                 if (!ed)
  70                         return;
  71
  72                 td = allocate_general_td(0);
  73                 if (!td) {
  74                         free(ed);
  75                         ed = NULL;
  76                         return;
  77                 }
  78
  79 #define ED_MASK ((u32)~0x0f)
  80                 ed->tailp = ed->headp = ACCESS_LE(virt_to_phys((void*) ((u32)td & ED_MASK)));
  81                 ed->flags |= ACCESS_LE(OHCI_ENDPOINT_DIRECTION_OUT);
  82         }
  83
  84         /*
  85          * The OHCI USB host controllers on the Nintendo Wii
  86          * video game console stop working when new TDs are
  87          * added to a scheduled control ED after a transfer has
  88          * has taken place on it.
  89          *
  90          * Before scheduling any new control TD, we make the
  91          * controller happy by always loading a special control ED
  92          * with a single dummy TD and letting the controller attempt
  93          * the transfer.
  94          * The controller won't do anything with it, as the special
  95          * ED has no TDs, but it will keep the controller from failing
  96          * on the next transfer.
  97          */
  98         head = read32(OHCI0_HC_CTRL_HEAD_ED);
  99         if (head) {
 100                 printf("head: 0x%08X\n", head);
 101                 /*
 102                  * Load the special empty ED and tell the controller to
 103                  * process the control list.
 104                  */
 105                 sync_after_write(ed, 64);
 106                 sync_after_write(td, 64);
 107                 write32(OHCI0_HC_CTRL_HEAD_ED, virt_to_phys(ed));
 108
 109                 status = read32(OHCI0_HC_CONTROL);
 110                 set32(OHCI0_HC_CONTROL, OHCI_CTRL_CLE);
 111                 write32(OHCI0_HC_COMMAND_STATUS, OHCI_CLF);
 112
 113                 /* spin until the controller is done with the control list */
 114                 current = read32(OHCI0_HC_CTRL_CURRENT_ED);
 115                 while(!current) {
 116                         udelay(10);
 117                         current = read32(OHCI0_HC_CTRL_CURRENT_ED);
 118                 }
 119
 120                 printf("current: 0x%08X\n", current);
 121
 122                 /* restore the old control head and control settings */
 123                 write32(OHCI0_HC_CONTROL, status);
 124                 write32(OHCI0_HC_CTRL_HEAD_ED, head);
 125         } else {
 126                 printf("nohead!\n");
 127         }
 128 }
 129
 130
 131 static void dbg_op_state()
 132 {
 133         switch (read32(OHCI0_HC_CONTROL) & OHCI_CTRL_HCFS) {
 134                 case OHCI_USB_SUSPEND:
 135                         printf("ohci-- OHCI_USB_SUSPEND\n");
 136                         break;
 137                 case OHCI_USB_RESET:
 138                         printf("ohci-- OHCI_USB_RESET\n");
 139                         break;
 140                 case OHCI_USB_OPER:
 141                         printf("ohci-- OHCI_USB_OPER\n");
 142                         break;
 143                 case OHCI_USB_RESUME:
 144                         printf("ohci-- OHCI_USB_RESUME\n");
 145                         break;
 146         }
 147 }
 148
 149
 150 /**
 151  * Enqueue a transfer descriptor.
 152  */
 153 u8 hcdi_enqueue(usb_transfer_descriptor *td) {
 154         control_quirk();
 155
 156         printf( "===========================\n"
 157                         "===========================\n"
 158                         "done head (vor sync): 0x%08X\n", ACCESS_LE(hcca_oh0.done_head));
 159         sync_before_read(&hcca_oh0, 256);
 160         printf("done head (nach sync): 0x%08X\n", ACCESS_LE(hcca_oh0.done_head));
 161
 162         struct general_td *tmptd = allocate_general_td(td->actlen);
 163         (void) memcpy((void*) (phys_to_virt(ACCESS_LE(tmptd->cbp))), td->buffer, td->actlen); /* throws dsi exception after some time :X */
 164
 165         tmptd->flags &= ACCESS_LE(~OHCI_TD_DIRECTION_PID_MASK);
 166         switch(td->pid) {
 167                 case USB_PID_SETUP:
 168                         printf("pid_setup\n");
 169                         tmptd->flags |= ACCESS_LE(OHCI_TD_DIRECTION_PID_SETUP);
 170                         break;
 171                 case USB_PID_OUT:
 172                         printf("pid_out\n");
 173                         tmptd->flags |= ACCESS_LE(OHCI_TD_DIRECTION_PID_OUT);
 174                         break;
 175                 case USB_PID_IN:
 176                         printf("pid_in\n");
 177                         tmptd->flags |= ACCESS_LE(OHCI_TD_DIRECTION_PID_IN);
 178                         break;
 179         }
 180         tmptd->flags |= ACCESS_LE((td->togl) ? OHCI_TD_TOGGLE_1 : OHCI_TD_TOGGLE_0);
 181
 182         printf("tmptd hexump (before):\n");
 183         hexdump(tmptd, sizeof(struct general_td));
 184         printf("tmptd-cbp hexump (before):\n");
 185         hexdump((void*) (phys_to_virt(ACCESS_LE(tmptd->cbp))), td->actlen);
 186
 187         sync_after_write((void*) ACCESS_LE(tmptd->cbp), td->actlen);
 188         sync_after_write(tmptd, sizeof(struct general_td));
 189
 190         struct endpoint_descriptor *dummyconfig = allocate_endpoint();
 191
 192         u32 current2 = read32(OHCI0_HC_CTRL_CURRENT_ED);
 193         printf("current2: 0x%08X\n", current2);
 194
 195 #define ED_MASK2 ~0 /*((u32)~0x0f) */
 196 #define ED_MASK ((u32)~0x0f)
 197         printf("tmpdt & ED_MASK: 0x%08X\n", virt_to_phys((void*) ((u32)tmptd & ED_MASK)));
 198         dummyconfig->tailp = dummyconfig->headp = ACCESS_LE(virt_to_phys((void*) ((u32)tmptd & ED_MASK)));
 199
 200         dummyconfig->flags |= ACCESS_LE(OHCI_ENDPOINT_LOW_SPEED |
 201                 OHCI_ENDPOINT_SET_DEVICE_ADDRESS(td->devaddress) |
 202                 OHCI_ENDPOINT_SET_ENDPOINT_NUMBER(td->endpoint) |
 203                 OHCI_ENDPOINT_SET_MAX_PACKET_SIZE(td->maxp));
 204
 205         sync_after_write(dummyconfig, 64);
 206         write32(OHCI0_HC_CTRL_HEAD_ED, virt_to_phys(dummyconfig));
 207
 208         printf("OHCI_CTRL_CLE: 0x%08X\n", read32(OHCI0_HC_CONTROL)&OHCI_CTRL_CLE);
 209         printf("OHCI_CLF: 0x%08X\n", read32(OHCI0_HC_COMMAND_STATUS)&OHCI_CLF);
 210         set32(OHCI0_HC_CONTROL, OHCI_CTRL_CLE);
 211         write32(OHCI0_HC_COMMAND_STATUS, OHCI_CLF);
 212
 213         printf("+++++++++++++++++++++++++++++\n");
 214         /* spin until the controller is done with the control list */
 215         u32 current = read32(OHCI0_HC_CTRL_CURRENT_ED);
 216         printf("current: 0x%08X\n", current);
 217         while(!current) {
 218                 udelay(10);
 219                 current = read32(OHCI0_HC_CTRL_CURRENT_ED);
 220         }
 221
 222         udelay(2000);
 223         udelay(2000);
 224         udelay(2000);
 225         current = read32(OHCI0_HC_CTRL_CURRENT_ED);
 226         printf("current: 0x%08X\n", current);
 227         printf("+++++++++++++++++++++++++++++\n");
 228         udelay(2000);
 229         udelay(2000);
 230         udelay(2000);
 231         udelay(2000);
 232         udelay(2000);
 233         udelay(2000);
 234         udelay(2000);
 235         udelay(2000);
 236
 237         sync_before_read(tmptd, sizeof(struct general_td));
 238         printf("tmptd hexump (after):\n");
 239         hexdump(tmptd, sizeof(struct general_td));
 240
 241         sync_before_read((void*) ACCESS_LE(tmptd->cbp), td->actlen);
 242         printf("tmptd-cbp hexump (after):\n");
 243         hexdump((void*) (phys_to_virt(ACCESS_LE(tmptd->cbp))), td->actlen);
 244
 245         printf("done head (vor sync): 0x%08X\n", ACCESS_LE(hcca_oh0.done_head));
 246         sync_before_read(&hcca_oh0, 256);
 247         printf("done head (nach sync): 0x%08X\n", ACCESS_LE(hcca_oh0.done_head));
 248
 249         free(tmptd);
 250         return 0;
 251 }
 252
 253 /**
 254  * Remove an transfer descriptor from transfer queue.
 255  */
 256 u8 hcdi_dequeue(usb_transfer_descriptor *td) {
 257         return 0;
 258 }
 259
 260 void hcdi_init()
 261 {
 262         printf("ohci-- init\n");
 263         dbg_op_state();
 264
 265         /* disable hc interrupts */
 266         set32(OHCI0_HC_INT_DISABLE, OHCI_INTR_MIE);
 267
 268         /* save fmInterval and calculate FSMPS */
 269 #define FSMP(fi) (0x7fff & ((6 * ((fi) - 210)) / 7))
 270 #define FI 0x2edf /* 12000 bits per frame (-1) */
 271         u32 fmint = read32(OHCI0_HC_FM_INTERVAL) & 0x3fff;
 272         if(fmint != FI)
 273                 printf("ohci-- fminterval delta: %d\n", fmint - FI);
 274         fmint |= FSMP (fmint) << 16;
 275
 276         /* enable interrupts of both usb host controllers */
 277         set32(EHCI_CTL, EHCI_CTL_OH0INTE | EHCI_CTL_OH1INTE | 0xe0000);
 278
 279         /* reset HC */
 280         write32(OHCI0_HC_COMMAND_STATUS, OHCI_HCR);
 281
 282         /* wait max. 30us */
 283         u32 ts = 30;
 284         while ((read32(OHCI0_HC_COMMAND_STATUS) & OHCI_HCR) != 0) {
 285                  if(--ts == 0) {
 286                         printf("ohci-- FAILED");
 287                         return;
 288                  }
 289                  udelay(1);
 290         }
 291
 292         /* disable interrupts; 2ms timelimit here!
 293            now we're in the SUSPEND state ... must go OPERATIONAL
 294            within 2msec else HC enters RESUME */
 295
 296         u32 cookie = irq_kill();
 297
 298         /* Tell the controller where the control and bulk lists are
 299          * The lists are empty now. */
 300         write32(OHCI0_HC_CTRL_HEAD_ED, 0);
 301         write32(OHCI0_HC_BULK_HEAD_ED, 0);
 302
 303         /* set hcca adress */
 304         sync_after_write(&hcca_oh0, 256);
 305         write32(OHCI0_HC_HCCA, virt_to_phys(&hcca_oh0));
 306
 307         /* set periodicstart */
 308 #define FIT (1<<31)
 309         u32 fmInterval = read32(OHCI0_HC_FM_INTERVAL) &0x3fff;
 310         u32 fit = read32(OHCI0_HC_FM_INTERVAL) & FIT;
 311
 312         write32(OHCI0_HC_FM_INTERVAL, fmint | (fit ^ FIT));
 313         write32(OHCI0_HC_PERIODIC_START, ((9*fmInterval)/10)&0x3fff);
 314
 315         /* testing bla */
 316         if ((read32(OHCI0_HC_FM_INTERVAL) & 0x3fff0000) == 0 || !read32(OHCI0_HC_PERIODIC_START)) {
 317                 printf("ohci-- w00t, fail!! see ohci-hcd.c:669\n");
 318         }
 319
 320         /* start HC operations */
 321         write32(OHCI0_HC_CONTROL, OHCI_CONTROL_INIT | OHCI_USB_OPER);
 322
 323         /* wake on ConnectStatusChange, matching external hubs */
 324         set32(OHCI0_HC_RH_STATUS, RH_HS_DRWE);
 325
 326         /* Choose the interrupts we care about now, others later on demand */
 327         write32(OHCI0_HC_INT_STATUS, ~0);
 328         write32(OHCI0_HC_INT_ENABLE, OHCI_INTR_INIT);
 329
 330         irq_restore(cookie);
 331
 332         dbg_op_state();
 333 }
 334
 335 void hcdi_irq()
 336 {
 337         /* read interrupt status */
 338         u32 flags = read32(OHCI0_HC_INT_STATUS);
 339
 340         /* when all bits are set to 1 some problem occured */
 341         if (flags == 0xffffffff) {
 342                 printf("ohci-- Houston, we have a serious problem! :(\n");
 343                 return;
 344         }
 345
 346         /* only care about interrupts that are enabled */
 347         flags &= read32(OHCI0_HC_INT_ENABLE);
 348
 349         /* nothing to do? */
 350         if (flags == 0)
 351                 return;
 352
 353         printf("OHCI Interrupt occured: ");
 354         /* UnrecoverableError */
 355         if (flags & OHCI_INTR_UE) {
 356                 printf("UnrecoverableError\n");
 357                 /* TODO: well, I don't know... nothing,
 358                  *       because it won't happen anyway? ;-) */
 359         }
 360
 361         /* RootHubStatusChange */
 362         if (flags & OHCI_INTR_RHSC) {
 363                 printf("RootHubStatusChange\n");
 364                 /* TODO: set some next_statechange variable... */
 365                 write32(OHCI0_HC_INT_STATUS, OHCI_INTR_RD | OHCI_INTR_RHSC);
 366         }
 367         /* ResumeDetected */
 368         else if (flags & OHCI_INTR_RD) {
 369                 printf("ResumeDetected\n");
 370                 write32(OHCI0_HC_INT_STATUS, OHCI_INTR_RD);
 371                 /* TODO: figure out what the linux kernel does here... */
 372         }
 373
 374         /* WritebackDoneHead */
 375         if (flags & OHCI_INTR_WDH) {
 376                 printf("WritebackDoneHead\n");
 377                 /* TODO: figure out what the linux kernel does here... */
 378         }
 379
 380         /* TODO: handle any pending URB/ED unlinks... */
 381
 382 #define HC_IS_RUNNING() 1 /* dirty, i know... just a temporary solution */
 383         if (HC_IS_RUNNING()) {
 384                 write32(OHCI0_HC_INT_STATUS, flags);
 385                 write32(OHCI0_HC_INT_ENABLE, OHCI_INTR_MIE);
 386         }
 387 }
 388