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;
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) )
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);
37 static struct ohci_hcca hcca_oh0;
40 static struct endpoint_descriptor *allocate_endpoint()
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);
49 static struct general_td *allocate_general_td(size_t bsize)
51 struct general_td *td;
52 td = (struct general_td *)memalign(16, sizeof(struct general_td));
53 td->flags = ACCESS_LE(0);
55 td->nexttd = ACCESS_LE(virt_to_phys(td));
56 //td->nexttd = ACCESS_LE(0);
58 td->cbp = td->be = ACCESS_LE(0);
60 //td->cbp = ACCESS_LE(virt_to_phys(memalign(16, bsize))); //memailgn required here?
61 td->cbp = ACCESS_LE(virt_to_phys(malloc(bsize)));
62 memset(phys_to_virt(ACCESS_LE(td->cbp)), 0, bsize);
63 td->be = ACCESS_LE(ACCESS_LE(td->cbp) + bsize - 1);
68 static void control_quirk()
70 static struct endpoint_descriptor *ed = 0; /* empty ED */
71 static struct general_td *td = 0; /* dummy TD */
78 * Allocate and keep a special empty ED with just a dummy TD.
81 ed = allocate_endpoint();
85 td = allocate_general_td(0);
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);
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.
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
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.
111 head = read32(OHCI0_HC_CTRL_HEAD_ED);
113 printf("head: 0x%08X\n", head);
115 * Load the special empty ED and tell the controller to
116 * process the control list.
118 sync_after_write(ed, 16);
119 sync_after_write(td, 16);
120 write32(OHCI0_HC_CTRL_HEAD_ED, virt_to_phys(ed));
122 status = read32(OHCI0_HC_CONTROL);
123 set32(OHCI0_HC_CONTROL, OHCI_CTRL_CLE);
124 write32(OHCI0_HC_COMMAND_STATUS, OHCI_CLF);
126 /* spin until the controller is done with the control list */
127 current = read32(OHCI0_HC_CTRL_CURRENT_ED);
130 current = read32(OHCI0_HC_CTRL_CURRENT_ED);
133 printf("current: 0x%08X\n", current);
135 /* restore the old control head and control settings */
136 write32(OHCI0_HC_CONTROL, status);
137 write32(OHCI0_HC_CTRL_HEAD_ED, head);
144 static void dbg_op_state()
146 switch (read32(OHCI0_HC_CONTROL) & OHCI_CTRL_HCFS) {
147 case OHCI_USB_SUSPEND:
148 printf("ohci-- OHCI_USB_SUSPEND\n");
151 printf("ohci-- OHCI_USB_RESET\n");
154 printf("ohci-- OHCI_USB_OPER\n");
156 case OHCI_USB_RESUME:
157 printf("ohci-- OHCI_USB_RESUME\n");
162 static void dbg_td_flag(u32 flag)
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");
177 * Enqueue a transfer descriptor.
179 u8 hcdi_enqueue(usb_transfer_descriptor *td) {
180 control_quirk(); //required? YES! :O
183 static struct endpoint_descriptor dummyconfig;
184 memset(&dummyconfig, 0, 16);
185 dummyconfig.flags = ACCESS_LE(OHCI_ENDPOINT_GENERAL_FORMAT);
186 dummyconfig.headp = dummyconfig.tailp = dummyconfig.nexted = ACCESS_LE(0);
188 printf( "===========================\n"
189 "===========================\n");
190 printf("td->buffer(1): 0x%08X\n", (void*)td->buffer);
191 sync_before_read(&hcca_oh0, 256);
192 printf("done head (nach sync): 0x%08X\n", ACCESS_LE(hcca_oh0.done_head));
193 printf("HCCA->frame_no: %d\nhcca->hccapad1: %d\n",
194 ((ACCESS_LE(hcca_oh0.frame_no) & 0xffff)>>16),
195 ACCESS_LE(hcca_oh0.frame_no)&0x0000ffff );
197 struct general_td *tmptd = allocate_general_td(td->actlen);
198 (void) memcpy((void*) (phys_to_virt(ACCESS_LE(tmptd->cbp))), td->buffer, td->actlen);
200 tmptd->flags &= ACCESS_LE(~OHCI_TD_DIRECTION_PID_MASK);
203 printf("pid_setup\n");
204 tmptd->flags |= ACCESS_LE(OHCI_TD_DIRECTION_PID_SETUP);
208 tmptd->flags |= ACCESS_LE(OHCI_TD_DIRECTION_PID_OUT);
212 tmptd->flags |= ACCESS_LE(OHCI_TD_DIRECTION_PID_IN);
215 tmptd->flags |= ACCESS_LE((td->togl) ? OHCI_TD_TOGGLE_1 : OHCI_TD_TOGGLE_0);
216 //tmptd->flags |= ACCESS_LE(OHCI_TD_TOGGLE_1);
218 printf("tmptd hexdump (before) 0x%08X:\n", tmptd);
219 hexdump(tmptd, sizeof(struct general_td));
220 //save buffer adress here; HC may change tmptd->cbp
221 tmptdbuffer = (u32) phys_to_virt(ACCESS_LE(tmptd->cbp));
222 printf("tmptd->cbp hexdump (before) 0x%08X:\n", phys_to_virt(ACCESS_LE(tmptd->cbp)));
223 hexdump((void*) phys_to_virt(ACCESS_LE(tmptd->cbp)), td->actlen);
225 sync_after_write(tmptd, sizeof(struct general_td));
226 sync_after_write((void*) phys_to_virt(ACCESS_LE(tmptd->cbp)), td->actlen);
228 #define ED_MASK ((u32)~0x0f)
229 dummyconfig.headp = ACCESS_LE(virt_to_phys((void*) ((u32)tmptd & ED_MASK)));
231 dummyconfig.flags |= ACCESS_LE(OHCI_ENDPOINT_LOW_SPEED |
232 OHCI_ENDPOINT_SET_DEVICE_ADDRESS(td->devaddress) |
233 OHCI_ENDPOINT_SET_ENDPOINT_NUMBER(td->endpoint) |
234 OHCI_ENDPOINT_SET_MAX_PACKET_SIZE(td->maxp));
236 printf("dummyconfig hexdump (before) 0x%08X:\n", &dummyconfig);
237 hexdump((void*) &dummyconfig, 16);
239 sync_after_write(&dummyconfig, 16);
240 write32(OHCI0_HC_CTRL_HEAD_ED, virt_to_phys(&dummyconfig));
242 printf("OHCI_CTRL_CLE: 0x%08X || ", read32(OHCI0_HC_CONTROL)&OHCI_CTRL_CLE);
243 printf("OHCI_CLF: 0x%08X\n", read32(OHCI0_HC_COMMAND_STATUS)&OHCI_CLF);
244 set32(OHCI0_HC_CONTROL, OHCI_CTRL_CLE);
245 write32(OHCI0_HC_COMMAND_STATUS, OHCI_CLF);
247 //printf("+++++++++++++++++++++++++++++\n");
248 /* spin until the controller is done with the control list */
249 //printf("current: 0x%08X\n", current);
251 //don't use this quirk stuff here!
253 while(!read32(OHCI0_HC_CTRL_CURRENT_ED)) {
258 u32 current = read32(OHCI0_HC_CTRL_CURRENT_ED);
259 printf("current: 0x%08X\n", current);
260 printf("+++++++++++++++++++++++++++++\n");
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));
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);
272 sync_before_read(&dummyconfig, 16);
273 printf("dummyconfig hexdump (after) 0x%08X:\n", &dummyconfig);
274 hexdump((void*) &dummyconfig, 16);
276 sync_before_read(&hcca_oh0, 256);
277 printf("done head (nach sync): 0x%08X\n", ACCESS_LE(hcca_oh0.done_head));
279 printf("td->buffer(1): 0x%08X\n", (void*)td->buffer);
280 struct general_td* donetd = phys_to_virt(ACCESS_LE(hcca_oh0.done_head)&~1);
281 sync_before_read(donetd, 16);
282 printf("done head hexdump: 0x%08X\n", donetd);
283 hexdump((void*) donetd, 16);
284 printf("td->buffer(2): 0x%08X\n", (void*)td->buffer);
286 sync_before_read((void*) phys_to_virt(ACCESS_LE(tmptd->cbp)), td->actlen);
287 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);
288 (void) memcpy((void*) (td->buffer), phys_to_virt(ACCESS_LE(tmptd->cbp)), td->actlen);
290 write32(OHCI0_HC_CONTROL, read32(OHCI0_HC_CONTROL)&~OHCI_CTRL_CLE);
291 dummyconfig.headp = dummyconfig.tailp = dummyconfig.nexted = ACCESS_LE(0);
295 * TD should be free'd after taking it from the done queue.
296 * but we are very very dirty and do it anyway :p
299 /* only when a buffer is allocated */
301 free((void*)tmptdbuffer);
307 * Remove an transfer descriptor from transfer queue.
309 u8 hcdi_dequeue(usb_transfer_descriptor *td) {
315 printf("ohci-- init\n");
318 /* disable hc interrupts */
319 set32(OHCI0_HC_INT_DISABLE, OHCI_INTR_MIE);
321 /* save fmInterval and calculate FSMPS */
322 #define FSMP(fi) (0x7fff & ((6 * ((fi) - 210)) / 7))
323 #define FI 0x2edf /* 12000 bits per frame (-1) */
324 u32 fmint = read32(OHCI0_HC_FM_INTERVAL) & 0x3fff;
326 printf("ohci-- fminterval delta: %d\n", fmint - FI);
327 fmint |= FSMP (fmint) << 16;
329 /* enable interrupts of both usb host controllers */
330 set32(EHCI_CTL, EHCI_CTL_OH0INTE | EHCI_CTL_OH1INTE | 0xe0000);
333 write32(OHCI0_HC_COMMAND_STATUS, OHCI_HCR);
337 while ((read32(OHCI0_HC_COMMAND_STATUS) & OHCI_HCR) != 0) {
339 printf("ohci-- FAILED");
345 /* disable interrupts; 2ms timelimit here!
346 now we're in the SUSPEND state ... must go OPERATIONAL
347 within 2msec else HC enters RESUME */
349 u32 cookie = irq_kill();
351 /* Tell the controller where the control and bulk lists are
352 * The lists are empty now. */
353 write32(OHCI0_HC_CTRL_HEAD_ED, 0);
354 write32(OHCI0_HC_BULK_HEAD_ED, 0);
356 /* set hcca adress */
357 sync_after_write(&hcca_oh0, 256);
358 write32(OHCI0_HC_HCCA, virt_to_phys(&hcca_oh0));
360 /* set periodicstart */
362 u32 fmInterval = read32(OHCI0_HC_FM_INTERVAL) &0x3fff;
363 u32 fit = read32(OHCI0_HC_FM_INTERVAL) & FIT;
365 write32(OHCI0_HC_FM_INTERVAL, fmint | (fit ^ FIT));
366 write32(OHCI0_HC_PERIODIC_START, ((9*fmInterval)/10)&0x3fff);
369 if ((read32(OHCI0_HC_FM_INTERVAL) & 0x3fff0000) == 0 || !read32(OHCI0_HC_PERIODIC_START)) {
370 printf("ohci-- w00t, fail!! see ohci-hcd.c:669\n");
373 /* start HC operations */
374 write32(OHCI0_HC_CONTROL, OHCI_CONTROL_INIT | OHCI_USB_OPER);
376 /* wake on ConnectStatusChange, matching external hubs */
377 write32(OHCI0_HC_RH_STATUS, /*RH_HS_DRWE |*/ RH_HS_LPSC);
379 /* Choose the interrupts we care about now, others later on demand */
380 write32(OHCI0_HC_INT_STATUS, ~0);
381 write32(OHCI0_HC_INT_ENABLE, OHCI_INTR_INIT);
384 wait_ms ((read32(OHCI0_HC_RH_DESCRIPTOR_A) >> 23) & 0x1fe);
386 configure_ports((u8)1);
392 static void configure_ports(u8 from_init)
394 printf("OHCI0_HC_RH_DESCRIPTOR_A:\t0x%08X\n", read32(OHCI0_HC_RH_DESCRIPTOR_A));
395 printf("OHCI0_HC_RH_DESCRIPTOR_B:\t0x%08X\n", read32(OHCI0_HC_RH_DESCRIPTOR_B));
396 printf("OHCI0_HC_RH_STATUS:\t\t0x%08X\n", read32(OHCI0_HC_RH_STATUS));
397 printf("OHCI0_HC_RH_PORT_STATUS_1:\t0x%08X\n", read32(OHCI0_HC_RH_PORT_STATUS_1));
398 printf("OHCI0_HC_RH_PORT_STATUS_2:\t0x%08X\n", read32(OHCI0_HC_RH_PORT_STATUS_2));
400 setup_port(OHCI0_HC_RH_PORT_STATUS_1, from_init);
401 setup_port(OHCI0_HC_RH_PORT_STATUS_2, from_init);
402 printf("configure_ports done\n");
405 static void setup_port(u32 reg, u8 from_init)
407 u32 port = read32(reg);
408 if((port & RH_PS_CCS) && ((port & RH_PS_CSC) || from_init)) {
409 write32(reg, RH_PS_CSC);
413 /* clear CSC flag, set PES and start port reset (PRS) */
414 write32(reg, RH_PS_PES);
415 while(!(read32(reg) & RH_PS_PES)) {
420 write32(reg, RH_PS_PRS);
422 /* spin until port reset is complete */
423 while(!(read32(reg) & RH_PS_PRSC)); // hint: it may stuck here
424 printf("loop done\n");
426 (void) usb_add_device();
432 /* read interrupt status */
433 u32 flags = read32(OHCI0_HC_INT_STATUS);
435 /* when all bits are set to 1 some problem occured */
436 if (flags == 0xffffffff) {
437 printf("ohci-- Houston, we have a serious problem! :(\n");
441 /* only care about interrupts that are enabled */
442 flags &= read32(OHCI0_HC_INT_ENABLE);
446 printf("OHCI Interrupt occured: but not for you! WTF?!\n");
450 printf("OHCI Interrupt occured: ");
451 /* UnrecoverableError */
452 if (flags & OHCI_INTR_UE) {
453 printf("UnrecoverableError\n");
454 /* TODO: well, I don't know... nothing,
455 * because it won't happen anyway? ;-) */
458 /* RootHubStatusChange */
459 if (flags & OHCI_INTR_RHSC) {
460 printf("RootHubStatusChange\n");
461 /* TODO: set some next_statechange variable... */
463 write32(OHCI0_HC_INT_STATUS, OHCI_INTR_RD | OHCI_INTR_RHSC);
466 else if (flags & OHCI_INTR_RD) {
467 printf("ResumeDetected\n");
468 write32(OHCI0_HC_INT_STATUS, OHCI_INTR_RD);
469 /* TODO: figure out what the linux kernel does here... */
472 /* WritebackDoneHead */
473 if (flags & OHCI_INTR_WDH) {
474 printf("WritebackDoneHead\n");
475 /* basically the linux irq handler reverse TDs to their urbs
476 * and set done_head to null.
477 * since we are polling atm, just should do the latter task.
478 * however, this won't work for now (i don't know why...)
482 sync_before_read(&hcca_oh0, 256);
483 hcca_oh0.done_head = 0;
484 sync_after_write(&hcca_oh0, 256);
488 /* TODO: handle any pending URB/ED unlinks... */
490 #define HC_IS_RUNNING() 1 /* dirty, i know... just a temporary solution */
491 if (HC_IS_RUNNING()) {
492 write32(OHCI0_HC_INT_STATUS, flags);
493 write32(OHCI0_HC_INT_ENABLE, OHCI_INTR_MIE);
499 sync_before_read(&hcca_oh0, 256);
500 printf("***** frame_no: %d *****\n", ACCESS_LE(hcca_oh0.frame_no));