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.
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
75 element *iterator = core.drivers->head;
76 while (iterator != NULL) {
77 drv = (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 usb_device *usb_add_device()
91 usb_device *dev = (usb_device *) malloc(sizeof(usb_device));
93 /* send at first time only 8 bytes */
94 dev->bMaxPacketSize0 = 8;
106 memset(buf, 0, sizeof(buf));
109 memset(buf, 0, sizeof(buf));
110 ret = usb_get_dev_desc_simple(dev, buf, sizeof(buf));
112 printf("=============\nbuf: 0x%08X\nafter usb_get_dev_desc_simple(ret: %d):\n", buf, ret);
113 hexdump(buf, sizeof(buf));
119 /* set MaxPacketSize */
121 u8 address = usb_next_address();
122 ret = usb_set_address(dev, address);
123 dev->address = address;
125 printf("set address to %d\n", dev->address);
128 memset(buf, 0, sizeof(buf));
129 ret = usb_get_dev_desc(dev, buf, sizeof(buf));
131 printf("=============\nbuf: 0x%08X\nafter usb_get_dev_desc(ret: %d):\n", buf, ret);
132 hexdump(buf, sizeof(buf));
135 char *man, *prod, *serial;
136 if(dev->iManufacturer) {
137 memset(buf, 0, sizeof(buf));
138 man = usb_get_string_simple(dev, dev->iManufacturer, buf, sizeof(buf));
139 printf("iManufacturer:\n");
140 hexdump(buf, sizeof(buf));
142 man = (char*) malloc(11);
143 memset(man, '\0', sizeof(man));
144 strlcpy(man, "no String", 10);
147 memset(buf, 0, sizeof(buf));
148 prod = usb_get_string_simple(dev, dev->iProduct, buf, sizeof(buf));
150 prod = (char*) malloc(11);
151 memset(prod, '\0', sizeof(prod));
152 strlcpy(prod, "no String", 10);
154 if(dev->iSerialNumber) {
155 memset(buf, 0, sizeof(buf));
156 serial = usb_get_string_simple(dev, dev->iSerialNumber, buf, sizeof(buf));
158 serial = (char*) malloc(11);
159 memset(serial, '\0', sizeof(serial));
160 strlcpy(serial, "no String", 10);
164 printf( "bLength 0x%02X\n"
165 "bDescriptorType 0x%02X\n"
167 "bDeviceClass 0x%02X\n"
168 "bDeviceSubClass 0x%02X\n"
169 "bDeviceProtocoll 0x%02X\n"
173 "iManufacturer(0x%02X): \"%s\"\n"
174 "iProduct(0x%02X): \"%s\"\n"
175 "iSerialNumber(0x%02X): \"%s\"\n"
176 "bNumConfigurations 0x%02X\n", dev->bLength, dev->bDeviceClass,
177 dev->bcdUSB, dev->bDescriptorType, dev->bDeviceSubClass,
178 dev->bDeviceProtocoll, dev->idVendor, dev->idProduct, dev->bcdDevice,
179 dev->iManufacturer, man,
181 dev->iSerialNumber, serial,
182 dev->bNumConfigurations);
184 memset(buf, 0, sizeof(buf));
185 /* in the most cases usb devices have just one configuration descriptor */
186 ret = usb_get_configuration(dev, 0, buf, sizeof(buf));
187 printf("=============\nbuf: 0x%08X\nafter usb_get_configuration(ret: %d):\n", buf, ret);
188 hexdump(buf, sizeof(buf));
192 usb_get_descriptor(dev, DEVICE, 0, buf, 8);
194 usb_get_descriptor(dev, DEVICE, 0, buf, size >= buf[0] ? buf[0] : size);
197 memset(buf, 0, sizeof(buf));
198 usb_control_msg(dev, 0x80, GET_DESCRIPTOR, (DEVICE << 8) | 0, 0, 8, buf, 0);
199 printf("=============\nbuf: 0x%08X\nafter usb control msg:\n", buf);
200 hexdump(buf, sizeof(buf));
202 memset(buf, 0, sizeof(buf));
203 usb_control_msg(dev, 0x80, GET_DESCRIPTOR, (DEVICE << 8) | 0, 0, buf[0], buf, 0);
204 printf("=============\nbuf: 0x%08X\nafter usb control msg:\n", buf);
205 hexdump(buf, sizeof(buf));
207 memset(buf, 0, sizeof(buf));
208 usb_get_string_simple(dev, 1, buf);
209 printf("=============\nbuf: 0x%08X\nafter usb control msg:\n", buf);
210 hexdump(buf, sizeof(buf));
216 /* setup real ep0 fifo size */
217 dev->bMaxPacketSize0 = (u8) buf[7];
223 /* save real length of device descriptor */
224 devdescr_size = (u8) buf[0];
226 /* define new adress */
227 memset(buf, 0, sizeof(buf));
228 usb_control_msg(dev, 0x00, SET_ADDRESS, address, 0, 0, buf, 8, 0);
229 dev->address = address;
230 printf("=============\nbuf: 0x%08X\nafter usb control msg:\n", buf);
231 hexdump(buf, sizeof(buf));
232 printf("address: %d\n", address);
235 /* get complete device descriptor */
236 memset(buf, 0, sizeof(buf));
237 usb_control_msg(dev, 0x80, GET_DESCRIPTOR, DEVICE<<8, 0, devdescr_size, buf, 8, 0);
239 printf("=============\nbuf: 0x%08X\nafter usb control msg:\n", buf);
240 hexdump(buf, sizeof(buf));
242 /* save only really neccessary values for this small usbstack */
246 memset(buf, 0, sizeof(buf));
247 usb_control_msg(dev, 0x80, GET_DESCRIPTOR, (STRING<<8)|2, 0, 0x1a, buf, 8, 0);
248 hexdump(buf, sizeof(buf));
249 printf("String Descriptor [1]: ");
251 for (i=2; i<buf[0]; i+=2)
252 printf("%c", buf[i]);
257 usb_control_msg(dev, 0x80, GET_DESCRIPTOR, (STRING<<8) | 2, 0, 0x20, buf, 8, 0);
258 printf("String Descriptor [2]: ");
259 for (i=2; i<buf[0]; i+=2)
260 printf("%c", buf[i]);
264 // string descriptoren werden nicht im arbeitsspeicher gehalten -> on demand mit
265 // entprechenden funktionen
266 // hier muss man noch mehr abholen, konfigurationene, interfaces und endpunkte
269 /* add device to device list */
270 element *tmp = (element *) malloc(sizeof(element));
271 tmp->data = (void *) dev;
272 list_add_tail(core.devices, tmp);
281 * Find currently detached device and remove
284 u8 usb_remove_device(usb_device * dev)
286 // FIXME!!!! dieser quatsch ist nur temporaer
287 free(core.devices->head);
289 core.devices = list_create();
294 * Register new driver at usb stack.
296 u8 usb_register_driver(usb_driver * dev)
298 /* add driver to driver list */
299 element *tmp = (element *) malloc(sizeof(element));
300 tmp->data = (void *) dev;
302 list_add_tail(core.drivers, tmp);
306 * first check to find a suitable device
307 * (root hub drivers need this call here)
316 * Call every probe function from every registered
317 * driver, to check if there is a valid driver
318 * for the new device.
320 void usb_probe_driver()
322 // call ever registered driver
324 element *iterator = core.drivers->head;
325 while (iterator != NULL) {
326 drv = (usb_driver *) iterator->data;
328 iterator = iterator->next;
335 usb_irp *usb_get_irp()
343 u8 usb_remove_irp(usb_irp * irp)
350 * Takes usb_irp and split it into
351 * several usb packeges (SETUP,IN,OUT)
352 * In the usbstack they are transported with the
353 * usb_transfer_descriptor data structure.
355 u16 usb_submit_irp(usb_irp *irp)
357 usb_transfer_descriptor *td;
359 u16 restlength = irp->len;
360 u8 *td_buf_ptr = irp->buffer;
363 u8 togl = irp->dev->epTogl[(irp->endpoint & 0x7F)];
367 /* alle requests mit dem gleichen algorithmus zerteilen
368 * das einzige ist der spezielle get_Device_descriptor request
369 * bei dem eine laenge von 64 angegeben ist.
370 * wenn man an adresse 0 einen get_device_desciptor schickt
371 * dann reichen die ersten 8 byte.
374 /***************** Setup Stage ***********************/
375 td = usb_create_transfer_descriptor(irp);
376 td->pid = USB_PID_SETUP;
377 td->buffer = irp->buffer;
379 /* control message are always 8 bytes */
383 /* start with data0 */
387 /**** send token ****/
390 /***************** Data Stage ***********************/
392 * You can see at bit 7 of bmRequestType if this stage is used,
393 * default requests are always 8 byte greate, from
394 * host to device. Stage 3 is only neccessary if the request
395 * expected datas from the device.
396 * bit7 - 1 = from device to host -> yes we need data stage
397 * bit7 - 0 = from host to device -> no send zero packet
399 * nach einem setup token kann nur ein IN token in stage 3 folgen
400 * nie aber ein OUT. Ein Zero OUT wird nur als Bestaetigung benoetigt.
405 * - es kommen noch Daten mit PID_IN an
406 * - host beendet mit PID_OUT DATA1 Zero
408 * Host zu Device (wie set address)
409 * - device sendet ein PID_IN DATA1 Zero Packet als bestaetigung
411 memcpy(mybuf, irp->buffer, td->actlen);
412 usb_device_request *setup = (usb_device_request *) mybuf;
413 u8 bmRequestType = setup->bmRequestType;
416 /* check bit 7 of bmRequestType */
417 if (bmRequestType & 0x80) {
418 /* schleife die die tds generiert */
419 while (runloop && (restlength > 0)) {
420 td = usb_create_transfer_descriptor(irp);
421 td->actlen = irp->epsize;
422 /* stop loop if all bytes are send */
423 if (restlength < irp->epsize) {
425 td->actlen = restlength;
428 td->buffer = td_buf_ptr;
429 /* move pointer for next packet */
430 td_buf_ptr += irp->epsize;
432 td->pid = USB_PID_IN;
436 /* wenn device descriptor von adresse 0 angefragt wird werden nur
437 * die ersten 8 byte abgefragt
439 if (setup->bRequest == GET_DESCRIPTOR && (setup->wValue & 0xff) == 1
440 && td->devaddress == 0) {
445 /**** send token ****/
448 /* pruefe ob noch weitere Pakete vom Device abgeholt werden muessen */
449 restlength = restlength - irp->epsize;
455 /***************** Status Stage ***********************/
456 /* Zero packet for end */
457 td = usb_create_transfer_descriptor(irp);
458 td->togl = 1; /* zero data packet = always DATA1 packet */
463 * bit7 = 1, host beendet mit PID_OUT DATA1 Zero
464 * bit7 = 0, device sendet ein PID_IN DATA1 Zero Packet als bestaetigung
466 /* check bit 7 of bmRequestType */
467 if (bmRequestType & 0x80) {
468 td->pid = USB_PID_OUT;
470 td->pid = USB_PID_IN;
472 /**** send token ****/
478 core.stdout("bulk\r\n");
480 //u16 restlength = irp->len;
481 //char * td_buf_ptr=irp->buffer;
483 /* schleife die die tds generiert */
486 td = usb_create_transfer_descriptor(irp);
487 td->endpoint = td->endpoint & 0x7F; /* clear direction bit */
489 /* max packet size for given endpoint */
490 td->actlen = irp->epsize;
492 /* Generate In Packet */
493 if (irp->endpoint & 0x80)
494 td->pid = USB_PID_IN;
496 /* Generate Out Packet */
497 td->pid = USB_PID_OUT;
499 /* stop loop if all bytes are send */
500 if (restlength <= irp->epsize) {
502 td->actlen = restlength;
505 td->buffer = td_buf_ptr;
506 /* move pointer for next packet */
507 td_buf_ptr = td_buf_ptr + irp->epsize;
514 /**** send token ****/
519 //if(td->pid == USB_PID_OUT) {
520 //if(togl==0) togl=1; else togl=0;
522 irp->dev->epTogl[(irp->endpoint & 0x7F)] = togl;
534 * Create a transfer descriptor with an parent irp.
536 usb_transfer_descriptor *usb_create_transfer_descriptor(usb_irp * irp)
538 usb_transfer_descriptor *td =
539 (usb_transfer_descriptor *) malloc(sizeof(usb_transfer_descriptor));
541 td->devaddress = irp->dev->address;
542 td->endpoint = irp->endpoint;
544 td->state = USB_TRANSFER_DESCR_NONE;
545 td->maxp = irp->epsize;