w00t, finally we get some serioes response from a usb device! \o/
[ppcskel.git] / 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 general_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 static void dump_address(void *addr, u32 size, const char* str)
223 {
224         sync_before_read(addr, size);
225         printf("%s hexdump @ 0x%08X:\n", str, addr);
226         hexdump(addr, size);
227 }
228
229 /**
230  * Enqueue a transfer descriptor.
231  */
232 u8 first = 0;
233 u8 hcdi_enqueue(usb_transfer_descriptor *td) {
234         static struct general_td *tSetup,*tData;
235         static u32 tSetupbuffer, tDatabuffer, tStatusbuffer;
236         static u32 tSetupblen, tDatablen, tStatusblen;
237
238         if(first == 0) {
239                 printf("step 0\n");
240                 tSetup = allocate_general_td(td->actlen);
241                 general_td_fill(tSetup, td);
242                 tSetupbuffer = (u32) phys_to_virt(ACCESS_LE(tSetup->cbp)); 
243                 tSetupblen = td->actlen;
244                 first++;
245                 return 0;
246         }
247         if(first == 1) {
248                 printf("step 1\n");
249                 tData = allocate_general_td(td->actlen);
250                 general_td_fill(tData, td);
251                 tDatabuffer = (u32) phys_to_virt(ACCESS_LE(tData->cbp)); 
252                 tDatablen = td->actlen;
253                 first++;
254                 return 0;
255         }
256         first = 0;
257         struct general_td *tStatus = allocate_general_td(td->actlen);
258         general_td_fill(tStatus, td);
259         tStatusbuffer = (u32) phys_to_virt(ACCESS_LE(tStatus->cbp)); 
260         tStatusblen = td->actlen;
261
262         printf( "===========================\n"
263                         "===========================\n");
264         control_quirk(); //required? YES! :O ... erm... or no? :/ ... in fact I have no idea
265
266         struct endpoint_descriptor *dummyconfig = allocate_endpoint();
267         dummyconfig->flags = ACCESS_LE(OHCI_ENDPOINT_GENERAL_FORMAT);
268         dummyconfig->headp = dummyconfig->tailp = dummyconfig->nexted = ACCESS_LE(0);
269         dummyconfig->flags |= ACCESS_LE(OHCI_ENDPOINT_LOW_SPEED |
270                         OHCI_ENDPOINT_SET_DEVICE_ADDRESS(td->devaddress) |
271                         OHCI_ENDPOINT_SET_ENDPOINT_NUMBER(td->endpoint) |
272                         OHCI_ENDPOINT_SET_MAX_PACKET_SIZE(td->maxp));
273         write32(OHCI0_HC_CTRL_HEAD_ED, virt_to_phys(dummyconfig));
274
275 #define ED_MASK ((u32)~0x0f) 
276         dummyconfig->headp |= ACCESS_LE(virt_to_phys((void*) ((u32)tSetup & ED_MASK)));
277         tSetup->nexttd = ACCESS_LE(virt_to_phys((void*) ((u32)tData & ED_MASK)));
278         tData->nexttd = ACCESS_LE(virt_to_phys((void*) ((u32)tStatus & ED_MASK)));
279
280         sync_after_write(dummyconfig, 16);
281         sync_after_write(tSetup, sizeof(struct general_td));
282         sync_after_write(tData, sizeof(struct general_td));
283         sync_after_write(tStatus, sizeof(struct general_td));
284
285         dump_address(tSetup, sizeof(struct general_td), "tSetup(before)");
286         dump_address((void*) phys_to_virt(ACCESS_LE(tSetup->cbp)), tSetupblen, "tSetup->cbp(before)");
287
288         dump_address(tData, sizeof(struct general_td), "tData(before)");
289         dump_address((void*) phys_to_virt(ACCESS_LE(tData->cbp)), tDatablen, "tData->cbp(before)");
290
291         dump_address(tStatus, sizeof(struct general_td), "tStatus(before)");
292         dump_address((void*) phys_to_virt(ACCESS_LE(tStatus->cbp)), tStatusblen, "tStatus->cbp(before)");
293
294         dump_address(dummyconfig, sizeof(struct endpoint_descriptor), "dummyconfig(before)");
295
296         printf("ctrl head: 0x%08X\n", read32(OHCI0_HC_CTRL_HEAD_ED));
297         /* trigger control list */
298         set32(OHCI0_HC_CONTROL, OHCI_CTRL_CLE);
299         write32(OHCI0_HC_COMMAND_STATUS, OHCI_CLF);
300
301         //don't use this quirk stuff here!
302 #if 1
303         while(!read32(OHCI0_HC_CTRL_CURRENT_ED)) {
304         }
305 #endif
306
307         udelay(1000000);
308         u32 current = read32(OHCI0_HC_CTRL_CURRENT_ED);
309         printf("current: 0x%08X\n", current);
310         printf("+++++++++++++++++++++++++++++\n");
311         udelay(10000000);
312
313         dump_address(tSetup, sizeof(struct general_td), "tSetup(after)");
314         dump_address((void*) phys_to_virt(ACCESS_LE(tSetup->cbp)), tSetupblen, "tSetup->cbp(after)");
315         dump_address((void*) tSetupbuffer, tSetupblen, "tSetupbuffer");
316         dbg_td_flag(ACCESS_LE(tSetup->flags));
317
318         dump_address(tData, sizeof(struct general_td), "tData(after)");
319         dump_address((void*) phys_to_virt(ACCESS_LE(tData->cbp)), tDatablen, "tData->cbp(after)");
320         dump_address((void*) tDatabuffer, tDatablen, "tDatabuffer");
321         dbg_td_flag(ACCESS_LE(tData->flags));
322
323         dump_address(tStatus, sizeof(struct general_td), "tStatus(after)");
324         //dump_address((void*) phys_to_virt(ACCESS_LE(tStatus->cbp)), tStatusblen, "tStatus->cbp(after)");
325         //dump_address((void*) tStatusbuffer, tStatusblen, "tStatusbuffer");
326         dbg_td_flag(ACCESS_LE(tStatus->flags));
327
328         dump_address(dummyconfig, sizeof(struct endpoint_descriptor), "dummyconfig(after)");
329
330         /* disable control list */
331         write32(OHCI0_HC_CONTROL, read32(OHCI0_HC_CONTROL)&~OHCI_CTRL_CLE);
332
333         /* 
334          * TD should be free'd after taking it from the done queue.
335          * but we are very very dirty and do it anyway :p
336          */
337
338         /* only when a buffer is allocated */
339 #if 0
340         if(td->actlen)
341                 free((void*)tStatusbuffer);
342         free(tStatus);
343 #endif
344         printf("hcdi_enqueue, done!\n");
345         return 0;
346 }
347
348 /**
349  * Remove an transfer descriptor from transfer queue.
350  */
351 u8 hcdi_dequeue(usb_transfer_descriptor *td) {
352         return 0;
353 }
354
355 void hcdi_init() 
356 {
357         printf("ohci-- init\n");
358         dbg_op_state();
359
360         /* disable hc interrupts */
361         set32(OHCI0_HC_INT_DISABLE, OHCI_INTR_MIE);
362
363         /* save fmInterval and calculate FSMPS */
364 #define FSMP(fi) (0x7fff & ((6 * ((fi) - 210)) / 7))
365 #define FI 0x2edf /* 12000 bits per frame (-1) */
366         u32 fmint = read32(OHCI0_HC_FM_INTERVAL) & 0x3fff;
367         if(fmint != FI)
368                 printf("ohci-- fminterval delta: %d\n", fmint - FI);
369         fmint |= FSMP (fmint) << 16;
370
371         /* enable interrupts of both usb host controllers */
372         set32(EHCI_CTL, EHCI_CTL_OH0INTE | EHCI_CTL_OH1INTE | 0xe0000);
373
374         /* reset HC */
375         write32(OHCI0_HC_COMMAND_STATUS, OHCI_HCR);
376
377         /* wait max. 30us */
378         u32 ts = 30;
379         while ((read32(OHCI0_HC_COMMAND_STATUS) & OHCI_HCR) != 0) {
380                  if(--ts == 0) {
381                         printf("ohci-- FAILED");
382                         return;
383                  }
384                  udelay(1);
385         }
386
387         /* disable interrupts; 2ms timelimit here! 
388            now we're in the SUSPEND state ... must go OPERATIONAL
389            within 2msec else HC enters RESUME */
390
391         u32 cookie = irq_kill();
392
393         /* Tell the controller where the control and bulk lists are
394          * The lists are empty now. */
395         write32(OHCI0_HC_CTRL_HEAD_ED, 0);
396         write32(OHCI0_HC_BULK_HEAD_ED, 0);
397
398         /* set hcca adress */
399         sync_after_write(&hcca_oh0, 256);
400         write32(OHCI0_HC_HCCA, virt_to_phys(&hcca_oh0));
401
402         /* set periodicstart */
403 #define FIT (1<<31)
404         u32 fmInterval = read32(OHCI0_HC_FM_INTERVAL) &0x3fff;
405         u32 fit = read32(OHCI0_HC_FM_INTERVAL) & FIT;
406
407         write32(OHCI0_HC_FM_INTERVAL, fmint | (fit ^ FIT));
408         write32(OHCI0_HC_PERIODIC_START, ((9*fmInterval)/10)&0x3fff);
409
410         /* testing bla */
411         if ((read32(OHCI0_HC_FM_INTERVAL) & 0x3fff0000) == 0 || !read32(OHCI0_HC_PERIODIC_START)) {
412                 printf("ohci-- w00t, fail!! see ohci-hcd.c:669\n");
413         }
414         
415         /* start HC operations */
416         write32(OHCI0_HC_CONTROL, OHCI_CONTROL_INIT | OHCI_USB_OPER);
417
418         /* wake on ConnectStatusChange, matching external hubs */
419         write32(OHCI0_HC_RH_STATUS, /*RH_HS_DRWE |*/ RH_HS_LPSC);
420
421         /* Choose the interrupts we care about now, others later on demand */
422         write32(OHCI0_HC_INT_STATUS, ~0);
423         write32(OHCI0_HC_INT_ENABLE, OHCI_INTR_INIT);
424
425         //wtf?
426         wait_ms ((read32(OHCI0_HC_RH_DESCRIPTOR_A) >> 23) & 0x1fe);
427
428         configure_ports((u8)1);
429         irq_restore(cookie);
430
431         dbg_op_state();
432 }
433
434 static void configure_ports(u8 from_init)
435 {
436         printf("OHCI0_HC_RH_DESCRIPTOR_A:\t0x%08X\n", read32(OHCI0_HC_RH_DESCRIPTOR_A));
437         printf("OHCI0_HC_RH_DESCRIPTOR_B:\t0x%08X\n", read32(OHCI0_HC_RH_DESCRIPTOR_B));
438         printf("OHCI0_HC_RH_STATUS:\t\t0x%08X\n", read32(OHCI0_HC_RH_STATUS));
439         printf("OHCI0_HC_RH_PORT_STATUS_1:\t0x%08X\n", read32(OHCI0_HC_RH_PORT_STATUS_1));
440         printf("OHCI0_HC_RH_PORT_STATUS_2:\t0x%08X\n", read32(OHCI0_HC_RH_PORT_STATUS_2));
441
442         setup_port(OHCI0_HC_RH_PORT_STATUS_1, from_init);
443         setup_port(OHCI0_HC_RH_PORT_STATUS_2, from_init);
444         printf("configure_ports done\n");
445 }
446
447 static void setup_port(u32 reg, u8 from_init)
448 {
449         u32 port = read32(reg);
450         if((port & RH_PS_CCS) && ((port & RH_PS_CSC) || from_init)) {
451                 write32(reg, RH_PS_CSC);
452
453                 wait_ms(120);
454
455                 /* clear CSC flag, set PES and start port reset (PRS) */
456                 write32(reg, RH_PS_PES);
457                 while(!(read32(reg) & RH_PS_PES)) {
458                         printf("fu\n");
459                         return;
460                 }
461
462                 write32(reg, RH_PS_PRS);
463
464                 /* spin until port reset is complete */
465                 while(!(read32(reg) & RH_PS_PRSC)); // hint: it may stuck here
466                 printf("loop done\n");
467
468                 wait_ms(20);
469
470                 (void) usb_add_device();
471         }
472 }
473
474 void hcdi_irq()
475 {
476         /* read interrupt status */
477         u32 flags = read32(OHCI0_HC_INT_STATUS);
478
479         /* when all bits are set to 1 some problem occured */
480         if (flags == 0xffffffff) {
481                 printf("ohci-- Houston, we have a serious problem! :(\n");
482                 return;
483         }
484
485         /* only care about interrupts that are enabled */
486         flags &= read32(OHCI0_HC_INT_ENABLE);
487
488         /* nothing to do? */
489         if (flags == 0) {
490                 printf("OHCI Interrupt occured: but not for you! WTF?!\n");
491                 return;
492         }
493
494         printf("OHCI Interrupt occured: ");
495         /* UnrecoverableError */
496         if (flags & OHCI_INTR_UE) {
497                 printf("UnrecoverableError\n");
498                 /* TODO: well, I don't know... nothing,
499                  *       because it won't happen anyway? ;-) */
500         }
501
502         /* RootHubStatusChange */
503         if (flags & OHCI_INTR_RHSC) {
504                 printf("RootHubStatusChange\n");
505                 /* TODO: set some next_statechange variable... */
506                 configure_ports(0);
507                 write32(OHCI0_HC_INT_STATUS, OHCI_INTR_RD | OHCI_INTR_RHSC);
508         }
509         /* ResumeDetected */
510         else if (flags & OHCI_INTR_RD) {
511                 printf("ResumeDetected\n");
512                 write32(OHCI0_HC_INT_STATUS, OHCI_INTR_RD);
513                 /* TODO: figure out what the linux kernel does here... */
514         }
515
516         /* WritebackDoneHead */
517         if (flags & OHCI_INTR_WDH) {
518                 printf("WritebackDoneHead\n");
519                 /* basically the linux irq handler reverse TDs to their urbs
520                  * and set done_head to null.
521                  * since we are polling atm, just should do the latter task.
522                  * however, this won't work for now (i don't know why...)
523                  * TODO!
524                  */
525 #if 0
526                 sync_before_read(&hcca_oh0, 256);
527                 hcca_oh0.done_head = 0;
528                 sync_after_write(&hcca_oh0, 256);
529 #endif
530         }
531
532         /* TODO: handle any pending URB/ED unlinks... */
533
534 #define HC_IS_RUNNING() 1 /* dirty, i know... just a temporary solution */
535         if (HC_IS_RUNNING()) {
536                 write32(OHCI0_HC_INT_STATUS, flags);
537                 write32(OHCI0_HC_INT_ENABLE, OHCI_INTR_MIE);
538         }
539 }
540
541 void show_frame_no()
542 {
543         sync_before_read(&hcca_oh0, 256);
544         printf("***** frame_no: %d *****\n", ACCESS_LE(hcca_oh0.frame_no));
545 }