2 * Copyright (c) 2006, Benedikt Sauter <sauter@ixbat.de>
5 * Short descripton of file:
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * * Redistributions in binary form must reproduce the above
15 * copyright notice, this list of conditions and the following
16 * disclaimer in the documentation and/or other materials provided
17 * with the distribution.
18 * * Neither the name of the FH Augsburg nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 #include "../host/host.h"
39 #include "../usbspec/usb11spec.h"
40 #include "../lib/list.h"
41 #include "../../malloc.h"
42 #include "../../bootmii_ppc.h" //printf
43 #include "../../string.h" //memset
46 * Initialize USB stack.
48 void usb_init(u32 reg)
50 core.drivers = list_create();
51 core.devices = list_create();
57 * Get next free usb device address.
61 u8 addr = core.nextaddress;
68 * Call this function periodically for
69 * control and transfer management.
73 // call ever registered driver
74 struct usb_driver *drv;
75 struct element *iterator = core.drivers->head;
76 while (iterator != NULL) {
77 drv = (struct usb_driver *) iterator->data;
79 iterator = iterator->next;
85 * Enumerate new device and create data structures
86 * for the core. usb_add_device expected that
87 * the device answers to address zero.
89 struct usb_device *usb_add_device(u8 lowspeed, u32 reg)
91 struct usb_device *dev = (struct usb_device *) malloc(sizeof(struct usb_device));
92 dev->conf = (struct usb_conf *) malloc(sizeof(struct usb_conf));
94 dev->fullspeed = lowspeed ? 0 : 1;
95 /* send at first time only 8 bytes for lowspeed devices
96 * 64 bytes for fullspeed
98 dev->bMaxPacketSize0 = lowspeed ? 8 : 64;
110 ret = usb_get_desc_dev_simple(dev);
117 printf("lololololool PADDING WTF :O lolololololo \n");
118 printf("lololololool PADDING WTF :O lolololololo \n");
119 printf("lololololool PADDING WTF :O lolololololo \n");
120 printf("lololololool PADDING WTF :O lolololololo \n");
121 printf("lololololool PADDING WTF :O lolololololo \n");
122 printf("lololololool PADING WTF :O lolololololo \n");
123 printf("loolololool PADDING WTF :O lolololololo \n");
124 printf("lololololool PADDING WTF :O lolololololo \n");
125 printf("lololololool PADDNG WTF :O lolololololo \n");
126 printf("lololololool PADDING WTF :O lolololololo \n");
127 printf("lololololool PADDINGWTF :O lolololololo \n");
128 printf("lololololool PADDING WTF :O lolololololo \n");
129 printf("lololololool PADDING WTF :Ololololololo \n");
130 printf("lololololool PADDING WTF :O lolololololo \n");
131 printf("lololololool PADDING WTF :O llololololo \n");
132 printf("lololololool PADDING WTF :O loololololo \n");
133 printf("lololololool PADDING WTF :O lolololololo \n");
134 printf("lololololool PADDING WTF :O loloooloo \n");
135 printf("lololololool PADDING WTF :O lolololololo \n");
136 printf("lololololool PADDING WTF :O lolololololo \n");
137 printf("lololololool PADDING WTF :O lolololoolo \n");
138 printf("lololololool PADDING WTF :O lololooolo \n");
139 printf("lololololool PADDING WTF :O loloolololo \n");
140 printf("lololol PADDING WTF :O lolololololo \n");
141 printf("lololololool PADDING WTF :O lolololololo \n");
142 printf("lolololool PADDING WTF :O lololoololo \n");
143 printf("lololololool PADDING WTF :O lolololololo \n");
144 printf("lolololool PADDING WTF :O lolololololo \n");
145 printf("lololololool PADDING WTF :O lolololololo \n");
146 printf("lollllool PADDING WTF :O lolololololo \n");
147 printf("lololololool PADDING WTF :O lolololololo \n");
148 printf("lololololool PADDING WTF :O lolololololo \n");
149 printf("lololololool PADDING WTF :O lolololololo \n");
150 printf("lololololool PADDING WTF :O lolololololo \n");
151 printf("lololololool PADDING WTF :O lolololololo \n");
152 printf("lololololool PADDING WTF :O lolololololo \n");
153 printf("lololololool PADDING WTF :O loloolololo \n");
154 printf("lololololool PADDING WTF lololololo \n");
155 printf("lololololool PADDING WTF :O lolololololo \n");
156 printf("lololololool PADDING WTF :O lolololololo \n");
158 u8 address = usb_next_address();
159 ret = usb_set_address(dev, address);
160 dev->address = address;
161 printf("set address to %d\n", dev->address);
163 /* get device descriptor&co */
164 ret = usb_get_desc_dev(dev);
168 /* print device info */
172 #define GET_PROTOCOL 0x03
173 #define SET_PROTOCOL 0x0b
180 /* select configuration */
182 ret = usb_set_configuration(dev, 1);
183 printf("=============\nusb_set_configuration(ret: %d): %d\n", ret, dev->conf->bConfigurationValue);
185 printf("=============\nusb_get_configuration: %d (should be 1 here)\n", usb_get_configuration(dev));
189 memset(buf, 0, 0xff);
190 usb_control_msg(dev, 0x81, GET_DESCRIPTOR, 0x2200, 0x0, 0x41, buf, 0);
191 printf("wtf request\n");
192 hexdump((void*)buf, 0x41);
197 /* see p48 in HID spec */
199 usb_control_msg(dev, SETit, SET_PROTOCOL, 0, 0, 0, buf, 0);
200 printf("=============\nhid_set_protocol %d\n", 0);
201 hexdump((void*)buf, 8);
205 usb_control_msg(dev, GETit, GET_PROTOCOL, 0, 0, 4, buf, 0);
206 printf("=============\nusb_get_interface: %d\n", buf[0]);
207 hexdump((void*)buf, 8);
211 /* I just don't know why on some devices
212 * {s,g}et_{configuration,interface} won't work.
213 * may the setter works and getter are poorly implemented?
214 * however, I try here some interrupt inputs, assuming
215 * the setters are fine*/
218 s8 epnum = dev->conf->intf->endp->bEndpointAddress & 0xf;
219 printf("epnum: 0x%04X\n", epnum);
222 (void) usb_interrupt_read(dev, epnum, buf, 8, 0);
223 printf("============\nusb_interrupt_read:\n");
224 hexdump((void*)buf, 8);
230 /* add device to device list */
231 element *tmp = (element *) malloc(sizeof(element));
232 tmp->data = (void *) dev;
233 list_add_tail(core.devices, tmp);
241 void lsusb(struct usb_device *dev)
243 printf("=== Device Descriptor === \n");
244 printf("bLength 0x%02X\n", dev->bLength);
245 printf("bDescriptorType 0x%02X\n", dev->bDeviceClass);
246 printf("bcdUSB 0x%04X\n", dev->bcdUSB);
247 printf("bDeviceClass 0x%02X\n", dev->bDeviceClass);
248 printf("bDeviceSubClass 0x%02X\n", dev->bDeviceSubClass);
249 printf("bDeviceProtocoll 0x%02X\n", dev->bDeviceProtocoll);
250 printf("bMaxPacketSize 0x%02X\n", dev->bMaxPacketSize0);
251 printf("idVendor 0x%04X\n", dev->idVendor);
252 printf("idProduct 0x%04X\n", dev->idProduct);
253 printf("bcdDevice 0x%04X\n", dev->bcdDevice);
254 printf("iManufacturer(0x%02X): \"%s\"\n", dev->iManufacturer, dev->iManufacturer ? usb_get_string_simple(dev, dev->iManufacturer) : "no String");
255 printf("iProduct(0x%02X): \"%s\"\n", dev->iProduct, dev->iProduct ? usb_get_string_simple(dev, dev->iProduct) : "no String");
256 printf("iSerialNumber(0x%02X): \"%s\"\n", dev->iSerialNumber, dev->iSerialNumber ? usb_get_string_simple(dev, dev->iSerialNumber) : "no String");
257 printf("bNumConfigurations 0x%02X\n", dev->bNumConfigurations);
260 struct usb_conf *conf = dev->conf;
261 for(c=0; c <= dev->bNumConfigurations; c++) {
262 printf(" === Configuration Descriptor %d ===\n", c+1);
263 printf(" bLength 0x%02X\n", conf->bLength);
264 printf(" bDescriptorType 0x%02X\n", conf->bDescriptorType);
265 printf(" wTotalLength 0x%04X\n", conf->wTotalLength);
266 printf(" bNumInterfaces 0x%02X\n", conf->bNumInterfaces);
267 printf(" bConfigurationValue 0x%02X\n", conf->bConfigurationValue);
268 printf(" iConfiguration (0x%02X): \"%s\"\n", conf->iConfiguration, conf->iConfiguration ? usb_get_string_simple(dev, conf->iConfiguration) : "no String");
269 printf(" bmAttributes 0x%02X\n", conf->bmAttributes);
270 printf(" bMaxPower 0x%02X\n", conf->bMaxPower);
272 struct usb_intf *ifs = conf->intf;
273 for(i=1; i <= conf->bNumInterfaces; i++) {
274 printf(" === Interface Descriptor %d ===\n", i);
275 printf(" bLength 0x%02X\n", ifs->bLength);
276 printf(" bDescriptorType 0x%02X\n", ifs->bDescriptorType);
277 printf(" bInterfaceNumber 0x%02X\n", ifs->bInterfaceNumber);
278 printf(" bAlternateSetting 0x%02X\n", ifs->bAlternateSetting);
279 printf(" bNumEndpoints 0x%02X\n", ifs->bNumEndpoints);
280 printf(" bInterfaceClass 0x%02X\n", ifs->bInterfaceClass);
281 printf(" bInterfaceSubClass 0x%02X\n", ifs->bInterfaceSubClass);
282 printf(" bInterfaceProtocol 0x%02X\n", ifs->bInterfaceProtocol);
283 printf(" iInterface (0x%02X): \"%s\"\n", ifs->iInterface, ifs->iInterface ? usb_get_string_simple(dev, ifs->iInterface) : "no String");
285 struct usb_endp *ed = ifs->endp;
286 for(e=1; e <= ifs->bNumEndpoints; e++) {
287 printf(" === Endpoint Descriptor %d ===\n", e);
288 printf(" bLength 0x%02X\n", ed->bLength);
289 printf(" bDescriptorType 0x%02X\n", ed->bDescriptorType);
290 printf(" bEndpointAddress 0x%02X\n", ed->bEndpointAddress);
291 printf(" bmAttributes 0x%02X\n", ed->bmAttributes);
292 printf(" wMaxPacketSize 0x%02X\n", ed->wMaxPacketSize);
293 printf(" bInterval 0x%02X\n", ed->bInterval);
306 * Find currently detached device and remove
309 u8 usb_remove_device(struct usb_device * dev)
311 // FIXME!!!! dieser quatsch ist nur temporaer
312 free(core.devices->head);
314 core.devices = list_create();
319 * Register new driver at usb stack.
321 u8 usb_register_driver(struct usb_driver * dev)
323 /* add driver to driver list */
324 struct element *tmp = (struct element *) malloc(sizeof(struct element));
325 tmp->data = (void *) dev;
327 list_add_tail(core.drivers, tmp);
331 * first check to find a suitable device
332 * (root hub drivers need this call here)
341 * Call every probe function from every registered
342 * driver, to check if there is a valid driver
343 * for the new device.
345 void usb_probe_driver()
347 // call ever registered driver
348 struct usb_driver *drv;
349 struct element *iterator = core.drivers->head;
350 while (iterator != NULL) {
351 drv = (struct usb_driver *) iterator->data;
353 iterator = iterator->next;
360 struct usb_irp *usb_get_irp()
368 u8 usb_remove_irp(struct usb_irp *irp)
375 * Takes usb_irp and split it into
376 * several usb packeges (SETUP,IN,OUT)
377 * In the usbstack they are transported with the
378 * usb_transfer_descriptor data structure.
380 u16 usb_submit_irp(struct usb_irp *irp)
382 struct usb_transfer_descriptor *td;
384 u16 restlength = irp->len;
385 u8 *td_buf_ptr = irp->buffer;
388 u8 togl = irp->dev->epTogl[(irp->endpoint & 0x7F)];
392 /* alle requests mit dem gleichen algorithmus zerteilen
393 * das einzige ist der spezielle get_Device_descriptor request
394 * bei dem eine laenge von 64 angegeben ist.
395 * wenn man an adresse 0 einen get_device_desciptor schickt
396 * dann reichen die ersten 8 byte.
399 /***************** Setup Stage ***********************/
400 td = usb_create_transfer_descriptor(irp);
401 td->pid = USB_PID_SETUP;
402 td->buffer = irp->buffer;
404 /* control message are always 8 bytes */
408 /* start with data0 */
412 /**** send token ****/
413 hcdi_enqueue(td, irp->dev->ohci);
415 /***************** Data Stage ***********************/
417 * You can see at bit 7 of bmRequestType if this stage is used,
418 * default requests are always 8 byte greate, from
419 * host to device. Stage 3 is only neccessary if the request
420 * expected datas from the device.
421 * bit7 - 1 = from device to host -> yes we need data stage
422 * bit7 - 0 = from host to device -> no send zero packet
424 * nach einem setup token kann nur ein IN token in stage 3 folgen
425 * nie aber ein OUT. Ein Zero OUT wird nur als Bestaetigung benoetigt.
430 * - es kommen noch Daten mit PID_IN an
431 * - host beendet mit PID_OUT DATA1 Zero
433 * Host zu Device (wie set address)
434 * - device sendet ein PID_IN DATA1 Zero Packet als bestaetigung
436 memcpy(mybuf, irp->buffer, td->actlen);
437 usb_device_request *setup = (usb_device_request *) mybuf;
438 u8 bmRequestType = setup->bmRequestType;
441 /* check bit 7 of bmRequestType */
442 if (bmRequestType & 0x80) {
443 /* schleife die die tds generiert */
444 while (runloop && (restlength > 0)) {
445 td = usb_create_transfer_descriptor(irp);
446 td->actlen = irp->epsize;
447 /* stop loop if all bytes are send */
448 if (restlength < irp->epsize) {
450 td->actlen = restlength;
453 td->buffer = td_buf_ptr;
454 /* move pointer for next packet */
455 td_buf_ptr += irp->epsize;
457 td->pid = USB_PID_IN;
461 /* wenn device descriptor von adresse 0 angefragt wird werden nur
462 * die ersten 8 byte abgefragt
464 if (setup->bRequest == GET_DESCRIPTOR && (setup->wValue & 0xff) == 1
465 && td->devaddress == 0) {
470 /**** send token ****/
471 hcdi_enqueue(td, irp->dev->ohci);
473 /* pruefe ob noch weitere Pakete vom Device abgeholt werden muessen */
474 restlength = restlength - irp->epsize;
480 /***************** Status Stage ***********************/
481 /* Zero packet for end */
482 td = usb_create_transfer_descriptor(irp);
483 td->togl = 1; /* zero data packet = always DATA1 packet */
488 * bit7 = 1, host beendet mit PID_OUT DATA1 Zero
489 * bit7 = 0, device sendet ein PID_IN DATA1 Zero Packet als bestaetigung
491 /* check bit 7 of bmRequestType */
492 if (bmRequestType & 0x80) {
493 td->pid = USB_PID_OUT;
495 td->pid = USB_PID_IN;
497 /**** send token ****/
498 hcdi_enqueue(td, irp->dev->ohci);
504 //u16 restlength = irp->len;
505 //char * td_buf_ptr=irp->buffer;
507 /* schleife die die tds generiert */
509 td = usb_create_transfer_descriptor(irp);
510 td->endpoint = td->endpoint & 0x7F; /* clear direction bit */
512 /* max packet size for given endpoint */
513 td->actlen = irp->epsize;
515 /* Generate In Packet */
516 if (irp->endpoint & 0x80)
517 td->pid = USB_PID_IN;
519 /* Generate Out Packet */
520 td->pid = USB_PID_OUT;
522 /* stop loop if all bytes are send */
523 if (restlength <= irp->epsize) {
525 td->actlen = restlength;
528 td->buffer = td_buf_ptr;
529 /* move pointer for next packet */
530 td_buf_ptr = td_buf_ptr + irp->epsize;
534 /**** send token ****/
535 hcdi_enqueue(td, irp->dev->ohci);
539 //if(td->pid == USB_PID_OUT) {
540 //if(togl==0) togl=1; else togl=0;
542 irp->dev->epTogl[(irp->endpoint & 0x7F)] = togl;
548 //u16 restlength = irp->len;
549 //char * td_buf_ptr=irp->buffer;
551 /* schleife die die tds generiert */
552 while (runloop && (restlength > 0)) {
553 td = usb_create_transfer_descriptor(irp);
554 /* max packet size for given endpoint */
555 td->actlen = irp->epsize;
557 td->pid = USB_PID_IN;
558 /* TODO: USB_PID_OUT */
560 /* stop loop if all bytes are send */
561 if (restlength < irp->epsize) {
563 td->actlen = restlength;
566 td->buffer = td_buf_ptr;
567 /* move pointer for next packet */
568 td_buf_ptr += irp->epsize;
573 /**** send token ****/
574 hcdi_enqueue(td, irp->dev->ohci);
575 restlength = restlength - irp->epsize;
579 irp->dev->epTogl[(irp->endpoint & 0x7F)] = togl;
581 hcdi_fire(irp->dev->ohci);
589 * Create a transfer descriptor with an parent irp.
591 struct usb_transfer_descriptor *usb_create_transfer_descriptor(struct usb_irp * irp)
593 struct usb_transfer_descriptor *td =
594 (struct usb_transfer_descriptor *) malloc(sizeof(struct usb_transfer_descriptor));
596 td->devaddress = irp->dev->address;
597 td->endpoint = irp->endpoint;
599 td->state = USB_TRANSFER_DESCR_NONE;
600 td->maxp = irp->epsize;
601 td->fullspeed = irp->dev->fullspeed;
602 td->type = irp->type;