usb/core/core.c

   1 /*
   2  * Copyright (c) 2006, Benedikt Sauter <sauter@ixbat.de>
   3  * All rights reserved.
   4  *
   5  * Short descripton of file:
   6  *
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  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.
  21  *
  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.
  33  */
  34
  35 //#include <stdlib.h>
  36 #include "core.h"
  37 #include "../host/host.h"
  38 #include "usb.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
  44
  45 /**
  46  * Initialize USB stack.
  47  */
  48 void usb_init(u32 reg)
  49 {
  50         core.drivers = list_create();
  51         core.devices = list_create();
  52         core.nextaddress = 1;
  53         hcdi_init(reg);
  54 }
  55
  56 /**
  57  * Get next free usb device address.
  58  */
  59 u8 usb_next_address()
  60 {
  61         u8 addr = core.nextaddress;
  62         core.nextaddress++;
  63         return addr;
  64 }
  65
  66
  67 /**
  68  * Call this function periodically for
  69  * control and transfer management.
  70  */
  71 void usb_periodic()
  72 {
  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;
  78                 drv->check();
  79                 iterator = iterator->next;
  80         }
  81 }
  82
  83
  84 /**
  85  * Enumerate new device and create data structures
  86  * for the core. usb_add_device expected that
  87  * the device answers to address zero.
  88  */
  89 struct usb_device *usb_add_device(u8 lowspeed, u32 reg)
  90 {
  91         struct usb_device *dev = (struct usb_device *) malloc(sizeof(struct usb_device));
  92         dev->conf = (struct usb_conf *) malloc(sizeof(struct usb_conf));
  93         dev->address = 0;
  94         dev->fullspeed = lowspeed ? 0 : 1;
  95         /* send at first time only 8 bytes for lowspeed devices
  96          * 64 bytes for fullspeed
  97          */
  98         dev->bMaxPacketSize0 = lowspeed ? 8 : 64;
  99         dev->ohci = reg;
 100
 101         dev->epSize[0] = 64;
 102         dev->epSize[1] = 64;
 103         dev->epSize[2] = 64;
 104
 105         dev->epTogl[0] = 0;
 106         dev->epTogl[1] = 0;
 107         dev->epTogl[2] = 0;
 108
 109         s8 ret;
 110         ret = usb_get_desc_dev_simple(dev);
 111         if(ret < 0) {
 112                 return (void*) -1;
 113         }
 114
 115 #define WTF
 116 #ifdef WTF
 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 PADDING WTF :O lolololololo \n");
 123         printf("lololololool PADDING WTF :O lolololololo \n");
 124         printf("lololololool PADDING WTF :O lolololololo \n");
 125         printf("lololololool PADDING WTF :O lolololololo \n");
 126         printf("lololololool PADDING WTF :O lolololololo \n");
 127         printf("lololololool PADDING WTF :O lolololololo \n");
 128         printf("lololololool PADDING WTF :O lolololololo \n");
 129         printf("lololololool PADDING WTF :O lolololololo \n");
 130         printf("lololololool PADDING WTF :O lolololololo \n");
 131         printf("lololololool PADDING WTF :O lolololololo \n");
 132         printf("lololol PADDING WTF :O lolololololo \n");
 133         printf("lololololool PADDING WTF :O lolololololo \n");
 134         printf("lolololool PADDING WTF :O lolololololo \n");
 135         printf("lololololool PADDING WTF :O lolololololo \n");
 136         printf("lolololool PADDING WTF :O lolololololo \n");
 137         printf("lololololool PADDING WTF :O lolololololo \n");
 138         printf("lollllool PADDING WTF :O lolololololo \n");
 139         printf("lololololool PADDING WTF :O lolololololo \n");
 140         printf("lololololool PADDING WTF :O lolololololo \n");
 141         printf("lololololool PADDING WTF :O lolololololo \n");
 142         printf("lololololool PADDING WTF :O lolololololo \n");
 143         printf("lololololool PADDING WTF :O lolololololo \n");
 144         printf("lololololool PADDING WTF :O lolololololo \n");
 145         printf("lololololool PADDING WTF :O lolololololo \n");
 146         printf("lololololool PADDING WTF :O lolololololo \n");
 147         printf("lololololool PADDING WTF :O lolololololo \n");
 148         printf("lololololool PADDING WTF :O lolololololo \n");
 149 #endif
 150         u8 address = usb_next_address();
 151         ret = usb_set_address(dev, address);
 152         dev->address = address;
 153         printf("set address to %d\n", dev->address);
 154
 155         /* get device descriptor&co */
 156         ret = usb_get_desc_dev(dev);
 157         if(ret < 0)
 158                 return (void*) -1;
 159
 160         /* print device info */
 161         lsusb(dev);
 162
 163         /* select configuration */
 164         ret = usb_set_configuration(dev, dev->conf->bConfigurationValue);
 165         printf("=============\nusb_set_configuration(ret: %d): %d\n", ret, dev->conf->bConfigurationValue);
 166         printf("=============\nusb_get_configuration: %d\n", usb_get_configuration(dev));
 167
 168 #if 0
 169         u8 buf[8];
 170         memset(buf, 0, 8);
 171         usb_control_msg(dev, 0x00, SET_INTERFACE, 0, dev->conf->intf->bInterfaceNumber, 0, buf, 0);
 172         printf("=============\nusb_set_interface: %d\n", dev->conf->intf->bInterfaceNumber);
 173         hexdump((void*)buf, 8);
 174
 175         memset(buf, 0, 8);
 176         usb_control_msg(dev, 0x81, GET_INTERFACE, 0, dev->conf->intf->bInterfaceNumber, 8, buf, 0);
 177         printf("=============\nusb_get_interface: %d\n", buf[0]);
 178         hexdump((void*)buf, 8);
 179 #endif
 180
 181 #if 0
 182         /* add device to device list */
 183         element *tmp = (element *) malloc(sizeof(element));
 184         tmp->data = (void *) dev;
 185         list_add_tail(core.devices, tmp);
 186
 187         usb_probe_driver();
 188 #endif
 189
 190         return dev;
 191 }
 192
 193 void lsusb(struct usb_device *dev)
 194 {
 195         printf("=== Device Descriptor === \n");
 196         printf("bLength 0x%02X\n", dev->bLength);
 197         printf("bDescriptorType 0x%02X\n", dev->bDeviceClass);
 198         printf("bcdUSB 0x%02X\n", dev->bcdUSB);
 199         printf("bDeviceClass 0x%02X\n", dev->bDeviceClass);
 200         printf("bDeviceSubClass 0x%02X\n", dev->bDeviceSubClass);
 201         printf("bDeviceProtocoll 0x%02X\n", dev->bDeviceProtocoll);
 202         printf("idVendor 0x%04X\n", dev->idVendor);
 203         printf("idProduct 0x%04X\n", dev->idProduct);
 204         printf("bcdDevice 0x%04X\n", dev->bcdDevice);
 205         printf("iManufacturer(0x%02X): \"%s\"\n", dev->iManufacturer, dev->iManufacturer ? usb_get_string_simple(dev, dev->iManufacturer) : "no String");
 206         printf("iProduct(0x%02X): \"%s\"\n", dev->iProduct, dev->iProduct ? usb_get_string_simple(dev, dev->iProduct) : "no String");
 207         printf("iSerialNumber(0x%02X): \"%s\"\n", dev->iSerialNumber, dev->iSerialNumber ? usb_get_string_simple(dev, dev->iSerialNumber) : "no String");
 208         printf("bNumConfigurations 0x%02X\n", dev->bNumConfigurations);
 209
 210         u8 c, i, e;
 211         struct usb_conf *conf = dev->conf;
 212         for(c=0; c <= dev->bNumConfigurations; c++) {
 213                 printf("  === Configuration Descriptor %d ===\n", c+1);
 214                 printf("  bLength 0x%02X\n", conf->bLength);
 215                 printf("  bDescriptorType 0x%02X\n", conf->bDescriptorType);
 216                 printf("  wTotalLength 0x%04X\n", conf->wTotalLength);
 217                 printf("  bNumInterfaces 0x%02X\n", conf->bNumInterfaces);
 218                 printf("  bConfigurationValue 0x%02X\n", conf->bConfigurationValue);
 219                 printf("  iConfiguration (0x%02X): \"%s\"\n", conf->iConfiguration, conf->iConfiguration ? usb_get_string_simple(dev, conf->iConfiguration) : "no String");
 220                 printf("  bmAttributes 0x%02X\n", conf->bmAttributes);
 221                 printf("  bMaxPower 0x%02X\n", conf->bMaxPower);
 222
 223                 struct usb_intf *ifs = conf->intf;
 224                 for(i=1; i <= conf->bNumInterfaces; i++) {
 225                         printf("    === Interface Descriptor %d ===\n", i);
 226                         printf("    bLength 0x%02X\n", ifs->bLength);
 227                         printf("    bDescriptorType 0x%02X\n", ifs->bDescriptorType);
 228                         printf("    bInterfaceNumber 0x%02X\n", ifs->bInterfaceNumber);
 229                         printf("    bAlternateSetting 0x%02X\n", ifs->bAlternateSetting);
 230                         printf("    bNumEndpoints 0x%02X\n", ifs->bNumEndpoints);
 231                         printf("    bInterfaceClass 0x%02X\n", ifs->bInterfaceClass);
 232                         printf("    bInterfaceSubClass 0x%02X\n", ifs->bInterfaceSubClass);
 233                         printf("    bInterfaceProtocol 0x%02X\n", ifs->bInterfaceProtocol);
 234                         printf("    iInterface (0x%02X): \"%s\"\n", ifs->iInterface, ifs->iInterface ? usb_get_string_simple(dev, ifs->iInterface) : "no String");
 235
 236                         struct usb_endp *ed = ifs->endp;
 237                         for(e=1; e <= ifs->bNumEndpoints; e++) {
 238                                 printf("      === Endpoint Descriptor %d ===\n", e);
 239                                 printf("      bLength 0x%02X\n", ed->bLength);
 240                                 printf("      bDescriptorType 0x%02X\n", ed->bDescriptorType);
 241                                 printf("      bEndpointAddress 0x%02X\n", ed->bEndpointAddress);
 242                                 printf("      bmAttributes 0x%02X\n", ed->bmAttributes);
 243                                 printf("      wMaxPacketSize 0x%02X\n", ed->wMaxPacketSize);
 244                                 printf("      bInterval 0x%02X\n", ed->bInterval);
 245
 246                                 ed = ed->next;
 247                         } //endpoint
 248
 249                         ifs = ifs->next;
 250                 } //interface
 251
 252                 conf = conf->next;
 253         } //configuration
 254 }
 255
 256 /**
 257  * Find currently detached device and remove
 258  * data structures
 259  */
 260 u8 usb_remove_device(struct usb_device * dev)
 261 {
 262         // FIXME!!!! dieser quatsch ist nur temporaer
 263         free(core.devices->head);
 264         free(core.devices);
 265         core.devices = list_create();
 266         return 1;
 267 }
 268
 269 /**
 270  * Register new driver at usb stack.
 271  */
 272 u8 usb_register_driver(struct usb_driver * dev)
 273 {
 274         /* add driver to driver list */
 275         struct element *tmp = (struct element *) malloc(sizeof(struct element));
 276         tmp->data = (void *) dev;
 277         tmp->next = NULL;
 278         list_add_tail(core.drivers, tmp);
 279
 280
 281         /**
 282          * first check to find a suitable device
 283          * (root hub drivers need this call here)
 284          */
 285         dev->probe();
 286
 287         return 1;
 288 }
 289
 290
 291 /**
 292  * Call every probe function from every registered
 293  * driver, to check if there is a valid driver
 294  * for the new device.
 295  */
 296 void usb_probe_driver()
 297 {
 298         // call ever registered driver
 299         struct usb_driver *drv;
 300         struct element *iterator = core.drivers->head;
 301         while (iterator != NULL) {
 302                 drv = (struct usb_driver *) iterator->data;
 303                 drv->probe();
 304                 iterator = iterator->next;
 305         }
 306 }
 307
 308 /**
 309  * Not implemented.
 310  */
 311 struct usb_irp *usb_get_irp()
 312 {
 313         return 0;
 314 }
 315
 316 /**
 317  * Not implemented.
 318  */
 319 u8 usb_remove_irp(struct usb_irp *irp)
 320 {
 321
 322         return 1;
 323 }
 324
 325 /**
 326  * Takes usb_irp and split it into
 327  * several usb packeges (SETUP,IN,OUT)
 328  * In the usbstack they are transported with the
 329  * usb_transfer_descriptor data structure.
 330  */
 331 u16 usb_submit_irp(struct usb_irp *irp)
 332 {
 333         struct usb_transfer_descriptor *td;
 334         u8 runloop = 1;
 335         u16 restlength = irp->len;
 336         u8 *td_buf_ptr = irp->buffer;
 337         u8 mybuf[64];
 338
 339         u8 togl = irp->dev->epTogl[(irp->endpoint & 0x7F)];
 340
 341         switch (irp->type) {
 342         case USB_CTRL:
 343                 /* alle requests mit dem gleichen algorithmus zerteilen
 344                  * das einzige ist der spezielle get_Device_descriptor request
 345                  * bei dem eine laenge von 64 angegeben ist.
 346                  * wenn man an adresse 0 einen get_device_desciptor schickt
 347                  * dann reichen die ersten 8 byte.
 348                  */
 349
 350                 /***************** Setup Stage ***********************/
 351                 td = usb_create_transfer_descriptor(irp);
 352                 td->pid = USB_PID_SETUP;
 353                 td->buffer = irp->buffer;
 354
 355                 /* control message are always 8 bytes */
 356                 td->actlen = 8;
 357
 358                 togl = 0;
 359                 /* start with data0 */
 360                 td->togl = togl;
 361                 togl = togl ? 0 : 1;
 362
 363                 /**** send token ****/
 364                 hcdi_enqueue(td, irp->dev->ohci);
 365
 366                 /***************** Data Stage ***********************/
 367                 /**
 368                  * You can see at bit 7 of bmRequestType if this stage is used,
 369                  * default requests are always 8 byte greate, from
 370                  * host to device. Stage 3 is only neccessary if the request
 371                  * expected datas from the device.
 372                  * bit7 - 1 = from device to host -> yes we need data stage
 373                  * bit7 - 0 = from host to device -> no send zero packet
 374                  *
 375                  * nach einem setup token kann nur ein IN token in stage 3 folgen
 376                  * nie aber ein OUT. Ein Zero OUT wird nur als Bestaetigung benoetigt.
 377                  *
 378                  *
 379                  * bit7 = 1
 380                  *      Device to Host
 381                  *      - es kommen noch Daten mit PID_IN an
 382                  *      - host beendet mit PID_OUT DATA1 Zero
 383                  * bit7 - 0
 384                  *      Host zu Device (wie set address)
 385                  *      - device sendet ein PID_IN DATA1 Zero Packet als bestaetigung
 386                  */
 387                 memcpy(mybuf, irp->buffer, td->actlen);
 388                 usb_device_request *setup = (usb_device_request *) mybuf;
 389                 u8 bmRequestType = setup->bmRequestType;
 390                 free(td);
 391
 392                 /* check bit 7 of bmRequestType */
 393                 if (bmRequestType & 0x80) {
 394                         /* schleife die die tds generiert */
 395                         while (runloop && (restlength > 0)) {
 396                                 td = usb_create_transfer_descriptor(irp);
 397                                 td->actlen = irp->epsize;
 398                                 /* stop loop if all bytes are send */
 399                                 if (restlength < irp->epsize) {
 400                                         runloop = 0;
 401                                         td->actlen = restlength;
 402                                 }
 403
 404                                 td->buffer = td_buf_ptr;
 405                                 /* move pointer for next packet */
 406                                 td_buf_ptr += irp->epsize;
 407
 408                                 td->pid = USB_PID_IN;
 409                                 td->togl = togl;
 410                                 togl = togl ? 0 : 1;
 411
 412                                 /* wenn device descriptor von adresse 0 angefragt wird werden nur
 413                                  * die ersten 8 byte abgefragt
 414                                  */
 415                                 if (setup->bRequest == GET_DESCRIPTOR && (setup->wValue & 0xff) == 1
 416                                                 && td->devaddress == 0) {
 417                                         /* stop loop */
 418                                         runloop = 0;
 419                                 }
 420
 421                                 /**** send token ****/
 422                                 hcdi_enqueue(td, irp->dev->ohci);
 423
 424                                 /* pruefe ob noch weitere Pakete vom Device abgeholt werden muessen */
 425                                 restlength = restlength - irp->epsize;
 426                                 free(td);
 427                         }
 428                 }
 429
 430
 431                 /***************** Status Stage ***********************/
 432                 /* Zero packet for end */
 433                 td = usb_create_transfer_descriptor(irp);
 434                 td->togl = 1;                                                           /* zero data packet = always DATA1 packet */
 435                 td->actlen = 0;
 436                 td->buffer = NULL;
 437
 438                 /**
 439                  * bit7 = 1, host beendet mit PID_OUT DATA1 Zero
 440                  * bit7 = 0, device sendet ein PID_IN DATA1 Zero Packet als bestaetigung
 441                  */
 442                 /* check bit 7 of bmRequestType */
 443                 if (bmRequestType & 0x80) {
 444                         td->pid = USB_PID_OUT;
 445                 } else {
 446                         td->pid = USB_PID_IN;
 447                 }
 448                 /**** send token ****/
 449                 hcdi_enqueue(td, irp->dev->ohci);
 450                 free(td);
 451                 break;
 452
 453         case USB_BULK:
 454                 core.stdout("bulk\r\n");
 455                 //u8 runloop=1;
 456                 //u16 restlength = irp->len;
 457                 //char * td_buf_ptr=irp->buffer;
 458
 459                 /* schleife die die tds generiert */
 460                 while (runloop) {
 461
 462                         td = usb_create_transfer_descriptor(irp);
 463                         td->endpoint = td->endpoint & 0x7F;                             /* clear direction bit */
 464
 465                         /* max packet size for given endpoint */
 466                         td->actlen = irp->epsize;
 467
 468                         /* Generate In Packet  */
 469                         if (irp->endpoint & 0x80)
 470                                 td->pid = USB_PID_IN;
 471                         else
 472                                 /* Generate Out Packet */
 473                                 td->pid = USB_PID_OUT;
 474
 475                         /* stop loop if all bytes are send */
 476                         if (restlength <= irp->epsize) {
 477                                 runloop = 0;
 478                                 td->actlen = restlength;
 479                         }
 480
 481                         td->buffer = td_buf_ptr;
 482                         /* move pointer for next packet */
 483                         td_buf_ptr = td_buf_ptr + irp->epsize;
 484
 485                         td->togl = togl;
 486                         if (togl == 0)
 487                                 togl = 1;
 488                         else
 489                                 togl = 0;
 490                                 /**** send token ****/
 491                         hcdi_enqueue(td, irp->dev->ohci);
 492                         free(td);
 493                 }
 494                 /* next togl */
 495                 //if(td->pid == USB_PID_OUT) {
 496                 //if(togl==0) togl=1; else togl=0;
 497                 //}
 498                 irp->dev->epTogl[(irp->endpoint & 0x7F)] = togl;
 499
 500                 break;
 501         }
 502         hcdi_fire(irp->dev->ohci);
 503
 504         return 1;
 505 }
 506
 507
 508
 509 /**
 510  * Create a transfer descriptor with an parent irp.
 511  */
 512 struct usb_transfer_descriptor *usb_create_transfer_descriptor(struct usb_irp * irp)
 513 {
 514         struct usb_transfer_descriptor *td =
 515                         (struct usb_transfer_descriptor *) malloc(sizeof(struct usb_transfer_descriptor));
 516
 517         td->devaddress = irp->dev->address;
 518         td->endpoint = irp->endpoint;
 519         td->iso = 0;
 520         td->state = USB_TRANSFER_DESCR_NONE;
 521         td->maxp = irp->epsize;
 522         td->fullspeed = irp->dev->fullspeed;
 523
 524         return td;
 525 }
 526