2 ppcskel - a Free Software replacement for the Nintendo/BroadOn bootloader.
5 Copyright (C) 2009 Bernhard Urban <lewurm@gmx.net>
6 Copyright (C) 2009 Sebastian Falbesoner <sebastian.falbesoner@gmail.com>
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
12 #include "../../bootmii_ppc.h"
13 #include "../../hollywood.h"
14 #include "../../irq.h"
15 #include "../../string.h"
16 #include "../../malloc.h"
19 #include "../usbspec/usb11spec.h"
21 /* macro for accessing u32 variables that need to be in little endian byte order;
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!
26 #define LE(dword) (u32)( (((dword) & 0xFF000000) >> 24) | \
27 (((dword) & 0x00FF0000) >> 8) | \
28 (((dword) & 0x0000FF00) << 8) | \
29 (((dword) & 0x000000FF) << 24) )
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 configure_ports(u8 from_init);
36 static void setup_port(u32 reg, u8 from_init);
38 static struct ohci_hcca hcca_oh0;
41 static struct endpoint_descriptor *allocate_endpoint()
43 struct endpoint_descriptor *ep;
44 ep = (struct endpoint_descriptor *)memalign(16, sizeof(struct endpoint_descriptor));
45 memset(ep, 0, sizeof(struct endpoint_descriptor));
46 ep->flags = LE(OHCI_ENDPOINT_GENERAL_FORMAT);
47 ep->headp = ep->tailp = ep->nexted = LE(0);
51 static struct general_td *allocate_general_td()
53 struct general_td *td;
54 td = (struct general_td *)memalign(16, sizeof(struct general_td));
55 memset(td, 0, sizeof(struct general_td));
58 td->cbp = td->be = LE(0);
62 static void control_quirk()
64 static struct endpoint_descriptor *ed = 0; /* empty ED */
65 static struct general_td *td = 0; /* dummy TD */
72 * Allocate and keep a special empty ED with just a dummy TD.
75 ed = allocate_endpoint();
79 td = allocate_general_td(0);
86 ed->tailp = ed->headp = LE(virt_to_phys((void*) ((u32)td & OHCI_ENDPOINT_HEAD_MASK)));
87 ed->flags |= LE(OHCI_ENDPOINT_DIRECTION_OUT);
91 * The OHCI USB host controllers on the Nintendo Wii
92 * video game console stop working when new TDs are
93 * added to a scheduled control ED after a transfer has
94 * has taken place on it.
96 * Before scheduling any new control TD, we make the
97 * controller happy by always loading a special control ED
98 * with a single dummy TD and letting the controller attempt
100 * The controller won't do anything with it, as the special
101 * ED has no TDs, but it will keep the controller from failing
102 * on the next transfer.
104 head = read32(OHCI0_HC_CTRL_HEAD_ED);
106 printf("head: 0x%08X\n", head);
108 * Load the special empty ED and tell the controller to
109 * process the control list.
111 sync_after_write(ed, 16);
112 sync_after_write(td, 16);
113 write32(OHCI0_HC_CTRL_HEAD_ED, virt_to_phys(ed));
115 status = read32(OHCI0_HC_CONTROL);
116 set32(OHCI0_HC_CONTROL, OHCI_CTRL_CLE);
117 write32(OHCI0_HC_COMMAND_STATUS, OHCI_CLF);
119 /* spin until the controller is done with the control list */
120 current = read32(OHCI0_HC_CTRL_CURRENT_ED);
123 current = read32(OHCI0_HC_CTRL_CURRENT_ED);
126 printf("current: 0x%08X\n", current);
128 /* restore the old control head and control settings */
129 write32(OHCI0_HC_CONTROL, status);
130 write32(OHCI0_HC_CTRL_HEAD_ED, head);
137 static void dbg_op_state()
139 switch (read32(OHCI0_HC_CONTROL) & OHCI_CTRL_HCFS) {
140 case OHCI_USB_SUSPEND:
141 printf("ohci-- OHCI_USB_SUSPEND\n");
144 printf("ohci-- OHCI_USB_RESET\n");
147 printf("ohci-- OHCI_USB_OPER\n");
149 case OHCI_USB_RESUME:
150 printf("ohci-- OHCI_USB_RESUME\n");
155 static void dbg_td_flag(u32 flag)
157 printf("**************** dbg_td_flag: 0x%08X ***************\n", flag);
158 printf("CC: %X\tshould be 0, see page 32 (ohci spec)\n", (flag>>28)&0xf);
159 printf("EC: %X\tsee page 20 (ohci spec)\n", (flag>>26)&3);
160 printf(" T: %X\n", (flag>>24)&3);
161 printf("DI: %X\n", (flag>>21)&7);
162 printf("DP: %X\n", (flag>>19)&3);
163 printf(" R: %X\n", (flag>>18)&1);
164 printf("********************************************************\n");
167 static void general_td_fill(struct general_td *dest, const usb_transfer_descriptor *src)
170 dest->cbp = LE(virt_to_phys(src->buffer));
171 dest->be = LE(LE(dest->cbp) + src->actlen - 1);
172 /* save virtual address here */
173 dest->bufaddr = (u32) src->buffer;
176 dest->cbp = dest->be = LE(0);
180 dest->buflen = src->actlen;
182 dest->flags &= LE(~OHCI_TD_DIRECTION_PID_MASK);
185 printf("pid_setup\n");
186 dest->flags |= LE(OHCI_TD_DIRECTION_PID_SETUP);
187 dest->flags |= LE(OHCI_TD_TOGGLE_0);
188 dest->flags |= LE(OHCI_TD_BUFFER_ROUNDING);
192 dest->flags |= LE(OHCI_TD_DIRECTION_PID_OUT);
193 dest->flags |= LE(OHCI_TD_BUFFER_ROUNDING);
196 * TODO: just temporary solution! (consider it with len?)
197 * there can be also regular PID_OUT pakets
199 dest->flags |= LE(OHCI_TD_TOGGLE_1);
203 dest->flags |= LE(OHCI_TD_DIRECTION_PID_IN);
204 if(src->maxp > src->actlen) {
205 dest->flags |= LE(OHCI_TD_BUFFER_ROUNDING);
206 printf("round buffer!");
209 * let the endpoint do the togglestuff!
210 * TODO: just temporary solution!
211 * there can be also inregular PID_IN pakets (@Status Stage)
213 dest->flags |= LE(OHCI_TD_TOGGLE_CARRY);
215 /* should be done by HC!
216 * first pid_in start with DATA0 */
218 dummyconfig.headp = LE( src->togl ?
219 LE(dummyconfig.headp) | OHCI_ENDPOINT_TOGGLE_CARRY :
220 LE(dummyconfig.headp) & ~OHCI_ENDPOINT_TOGGLE_CARRY);
224 dest->flags |= LE(OHCI_TD_SET_DELAY_INTERRUPT(7));
228 static void dump_address(void *addr, u32 size, const char* str)
230 printf("%s hexdump (%d) @ 0x%08X:\n", str, size, addr);
235 static struct endpoint_descriptor _edhead;
236 struct endpoint_descriptor *edhead = 0;
240 printf("<^> <^> <^> hcdi_fire(start)\n");
246 control_quirk(); //required? YES! :O ... erm... or no? :/ ... in fact I have no idea
247 write32(OHCI0_HC_CTRL_HEAD_ED, virt_to_phys(edhead));
250 sync_after_write(edhead, sizeof(struct endpoint_descriptor));
252 dump_address(edhead, sizeof(struct endpoint_descriptor), "edhead(before)");
255 struct general_td *x = phys_to_virt(LE(edhead->headp) & OHCI_ENDPOINT_HEAD_MASK);
256 while(virt_to_phys(x)) {
257 sync_after_write(x, sizeof(struct general_td));
259 dump_address(x, sizeof(struct general_td), "x(before)");
263 sync_after_write((void*) phys_to_virt(LE(x->cbp)), x->buflen);
265 dump_address((void*) phys_to_virt(LE(x->cbp)), x->buflen, "x->cbp(before)");
268 x = phys_to_virt(LE(x->nexttd));
271 /* trigger control list */
272 set32(OHCI0_HC_CONTROL, OHCI_CTRL_CLE);
273 write32(OHCI0_HC_COMMAND_STATUS, OHCI_CLF);
275 struct general_td *n=0, *prev = 0, *next = 0;
276 /* poll until edhead->headp is null */
278 sync_before_read(edhead, sizeof(struct endpoint_descriptor));
280 printf("edhead->headp: 0x%08X\n", LE(edhead->headp));
284 /* if halted, debug output plz. will break the transfer */
285 if((LE(edhead->headp) & OHCI_ENDPOINT_HALTED)) {
286 n = phys_to_virt(LE(edhead->headp)&~0xf);
287 prev = phys_to_virt((u32)prev);
292 sync_before_read((void*) n, sizeof(struct general_td));
294 printf("n: 0x%08X\n", n);
295 dump_address(n, sizeof(struct general_td), "n(after)");
298 sync_before_read((void*) n->bufaddr, n->buflen);
300 dump_address((void*) n->bufaddr, n->buflen, "n->bufaddr(after)");
303 dbg_td_flag(LE(n->flags));
305 sync_before_read((void*) prev, sizeof(struct general_td));
307 printf("prev: 0x%08X\n", prev);
308 dump_address(prev, sizeof(struct general_td), "prev(after)");
310 if(prev->buflen >0) {
311 sync_before_read((void*) prev->bufaddr, prev->buflen);
313 dump_address((void*) prev->bufaddr, prev->buflen, "prev->bufaddr(after)");
317 dbg_td_flag(LE(prev->flags));
318 printf("halted end!\n");
322 prev = (struct general_td*) (LE(edhead->headp)&~0xf);
323 } while(LE(edhead->headp)&~0xf);
325 n = phys_to_virt(read32(OHCI0_HC_DONE_HEAD) & ~1);
327 printf("hc_done_head: 0x%08X\n", read32(OHCI0_HC_DONE_HEAD));
331 /* reverse done queue */
332 while(virt_to_phys(n) && edhead->tdcount) {
333 sync_before_read((void*) n, sizeof(struct general_td));
335 printf("n: 0x%08X\n", n);
336 printf("next: 0x%08X\n", next);
337 printf("prev: 0x%08X\n", prev);
341 n = (struct general_td*) phys_to_virt(LE(n->nexttd));
342 next->nexttd = (u32) prev;
350 while(virt_to_phys(n)) {
352 dump_address(n, sizeof(struct general_td), "n(after)");
355 sync_before_read((void*) n->bufaddr, n->buflen);
357 dump_address((void*) n->bufaddr, n->buflen, "n->bufaddr(after)");
361 dbg_td_flag(LE(n->flags));
364 n = (struct general_td*) n->nexttd;
368 hcca_oh0.done_head = 0;
369 sync_after_write(&hcca_oh0, sizeof(hcca_oh0));
371 write32(OHCI0_HC_CONTROL, read32(OHCI0_HC_CONTROL)&~OHCI_CTRL_CLE);
376 printf("<^> <^> <^> hcdi_fire(end)\n");
381 * Enqueue a transfer descriptor.
383 u8 hcdi_enqueue(const usb_transfer_descriptor *td) {
385 printf("*()*()*()*()*()*()*() hcdi_enqueue(start)\n");
389 memset(edhead, 0, sizeof(struct endpoint_descriptor));
390 edhead->flags = LE(OHCI_ENDPOINT_GENERAL_FORMAT);
391 edhead->headp = edhead->tailp = edhead->nexted = LE(0);
392 edhead->flags |= LE(OHCI_ENDPOINT_LOW_SPEED |
393 OHCI_ENDPOINT_SET_DEVICE_ADDRESS(td->devaddress) |
394 OHCI_ENDPOINT_SET_ENDPOINT_NUMBER(td->endpoint) |
395 OHCI_ENDPOINT_SET_MAX_PACKET_SIZE(td->maxp));
399 struct general_td *tdhw = allocate_general_td();
400 general_td_fill(tdhw, td);
405 edhead->headp = LE(virt_to_phys((void*) ((u32)tdhw & OHCI_ENDPOINT_HEAD_MASK)));
408 /* headp in endpoint already exists
411 struct general_td *n = (struct general_td*) phys_to_virt(LE(edhead->headp) & OHCI_ENDPOINT_HEAD_MASK);
412 while(LE(n->nexttd)) {
413 n = phys_to_virt(LE(n->nexttd));
415 n->nexttd = LE(virt_to_phys((void*) ((u32)tdhw & OHCI_ENDPOINT_HEAD_MASK)));
417 printf("n: 0x%08X\n", n);
418 printf("n->nexttd: 0x%08X\n", phys_to_virt(LE(n->nexttd)));
423 printf("*()*()*()*()*()*()*() hcdi_enqueue(end)\n");
430 * Remove an transfer descriptor from transfer queue.
432 u8 hcdi_dequeue(usb_transfer_descriptor *td) {
438 printf("ohci-- init\n");
441 /* disable hc interrupts */
442 set32(OHCI0_HC_INT_DISABLE, OHCI_INTR_MIE);
444 /* save fmInterval and calculate FSMPS */
445 #define FSMP(fi) (0x7fff & ((6 * ((fi) - 210)) / 7))
446 #define FI 0x2edf /* 12000 bits per frame (-1) */
447 u32 fmint = read32(OHCI0_HC_FM_INTERVAL) & 0x3fff;
449 printf("ohci-- fminterval delta: %d\n", fmint - FI);
450 fmint |= FSMP (fmint) << 16;
452 /* enable interrupts of both usb host controllers */
453 set32(EHCI_CTL, EHCI_CTL_OH0INTE | EHCI_CTL_OH1INTE | 0xe0000);
456 write32(OHCI0_HC_COMMAND_STATUS, OHCI_HCR);
460 while ((read32(OHCI0_HC_COMMAND_STATUS) & OHCI_HCR) != 0) {
462 printf("ohci-- FAILED");
468 /* disable interrupts; 2ms timelimit here!
469 now we're in the SUSPEND state ... must go OPERATIONAL
470 within 2msec else HC enters RESUME */
472 u32 cookie = irq_kill();
474 /* Tell the controller where the control and bulk lists are
475 * The lists are empty now. */
476 write32(OHCI0_HC_CTRL_HEAD_ED, 0);
477 write32(OHCI0_HC_BULK_HEAD_ED, 0);
479 /* set hcca adress */
480 sync_after_write(&hcca_oh0, 256);
481 write32(OHCI0_HC_HCCA, virt_to_phys(&hcca_oh0));
483 /* set periodicstart */
485 u32 fmInterval = read32(OHCI0_HC_FM_INTERVAL) &0x3fff;
486 u32 fit = read32(OHCI0_HC_FM_INTERVAL) & FIT;
488 write32(OHCI0_HC_FM_INTERVAL, fmint | (fit ^ FIT));
489 write32(OHCI0_HC_PERIODIC_START, ((9*fmInterval)/10)&0x3fff);
492 if ((read32(OHCI0_HC_FM_INTERVAL) & 0x3fff0000) == 0 || !read32(OHCI0_HC_PERIODIC_START)) {
493 printf("ohci-- w00t, fail!! see ohci-hcd.c:669\n");
496 /* start HC operations */
497 write32(OHCI0_HC_CONTROL, OHCI_CONTROL_INIT | OHCI_USB_OPER);
499 /* wake on ConnectStatusChange, matching external hubs */
500 write32(OHCI0_HC_RH_STATUS, /*RH_HS_DRWE |*/ RH_HS_LPSC);
502 /* Choose the interrupts we care about now, others later on demand */
503 write32(OHCI0_HC_INT_STATUS, ~0);
504 write32(OHCI0_HC_INT_ENABLE, OHCI_INTR_INIT);
507 wait_ms ((read32(OHCI0_HC_RH_DESCRIPTOR_A) >> 23) & 0x1fe);
509 configure_ports((u8)1);
515 static void configure_ports(u8 from_init)
518 printf("OHCI0_HC_RH_DESCRIPTOR_A:\t0x%08X\n", read32(OHCI0_HC_RH_DESCRIPTOR_A));
519 printf("OHCI0_HC_RH_DESCRIPTOR_B:\t0x%08X\n", read32(OHCI0_HC_RH_DESCRIPTOR_B));
520 printf("OHCI0_HC_RH_STATUS:\t\t0x%08X\n", read32(OHCI0_HC_RH_STATUS));
521 printf("OHCI0_HC_RH_PORT_STATUS_1:\t0x%08X\n", read32(OHCI0_HC_RH_PORT_STATUS_1));
522 printf("OHCI0_HC_RH_PORT_STATUS_2:\t0x%08X\n", read32(OHCI0_HC_RH_PORT_STATUS_2));
525 setup_port(OHCI0_HC_RH_PORT_STATUS_1, from_init);
526 setup_port(OHCI0_HC_RH_PORT_STATUS_2, from_init);
528 printf("configure_ports done\n");
532 static void setup_port(u32 reg, u8 from_init)
534 u32 port = read32(reg);
535 if((port & RH_PS_CCS) && ((port & RH_PS_CSC) || from_init)) {
536 write32(reg, RH_PS_CSC);
540 /* clear CSC flag, set PES and start port reset (PRS) */
541 write32(reg, RH_PS_PES);
542 while(!(read32(reg) & RH_PS_PES)) {
549 write32(reg, RH_PS_PRS);
551 /* spin until port reset is complete */
552 while(!(read32(reg) & RH_PS_PRSC)); // hint: it may stuck here
554 printf("loop done\n");
557 (void) usb_add_device();
563 /* read interrupt status */
564 u32 flags = read32(OHCI0_HC_INT_STATUS);
566 /* when all bits are set to 1 some problem occured */
567 if (flags == 0xffffffff) {
568 printf("ohci-- Houston, we have a serious problem! :(\n");
572 /* only care about interrupts that are enabled */
573 flags &= read32(OHCI0_HC_INT_ENABLE);
577 printf("OHCI Interrupt occured: but not for you! WTF?!\n");
581 printf("OHCI Interrupt occured: ");
582 /* UnrecoverableError */
583 if (flags & OHCI_INTR_UE) {
584 printf("UnrecoverableError\n");
585 /* TODO: well, I don't know... nothing,
586 * because it won't happen anyway? ;-) */
589 /* RootHubStatusChange */
590 if (flags & OHCI_INTR_RHSC) {
591 printf("RootHubStatusChange\n");
592 /* TODO: set some next_statechange variable... */
594 write32(OHCI0_HC_INT_STATUS, OHCI_INTR_RD | OHCI_INTR_RHSC);
597 else if (flags & OHCI_INTR_RD) {
598 printf("ResumeDetected\n");
599 write32(OHCI0_HC_INT_STATUS, OHCI_INTR_RD);
600 /* TODO: figure out what the linux kernel does here... */
603 /* WritebackDoneHead */
604 if (flags & OHCI_INTR_WDH) {
605 printf("WritebackDoneHead\n");
606 /* basically the linux irq handler reverse TDs to their urbs
607 * and set done_head to null.
608 * since we are polling atm, just should do the latter task.
609 * however, this won't work for now (i don't know why...)
613 sync_before_read(&hcca_oh0, 256);
614 hcca_oh0.done_head = 0;
615 sync_after_write(&hcca_oh0, 256);
619 /* TODO: handle any pending URB/ED unlinks... */
621 #define HC_IS_RUNNING() 1 /* dirty, i know... just a temporary solution */
622 if (HC_IS_RUNNING()) {
623 write32(OHCI0_HC_INT_STATUS, flags);
624 write32(OHCI0_HC_INT_ENABLE, OHCI_INTR_MIE);
630 sync_before_read(&hcca_oh0, 256);
631 printf("***** frame_no: %d *****\n", LE(hcca_oh0.frame_no));