hw/usb-desc.c

   1 #include "usb.h"
   2 #include "usb-desc.h"
   3 #include "trace.h"
   4
   5 /* ------------------------------------------------------------------ */
   6
   7 static uint8_t usb_lo(uint16_t val)
   8 {
   9     return val & 0xff;
  10 }
  11
  12 static uint8_t usb_hi(uint16_t val)
  13 {
  14     return (val >> 8) & 0xff;
  15 }
  16
  17 int usb_desc_device(const USBDescID *id, const USBDescDevice *dev,
  18                     uint8_t *dest, size_t len)
  19 {
  20     uint8_t bLength = 0x12;
  21
  22     if (len < bLength) {
  23         return -1;
  24     }
  25
  26     dest[0x00] = bLength;
  27     dest[0x01] = USB_DT_DEVICE;
  28
  29     dest[0x02] = usb_lo(dev->bcdUSB);
  30     dest[0x03] = usb_hi(dev->bcdUSB);
  31     dest[0x04] = dev->bDeviceClass;
  32     dest[0x05] = dev->bDeviceSubClass;
  33     dest[0x06] = dev->bDeviceProtocol;
  34     dest[0x07] = dev->bMaxPacketSize0;
  35
  36     dest[0x08] = usb_lo(id->idVendor);
  37     dest[0x09] = usb_hi(id->idVendor);
  38     dest[0x0a] = usb_lo(id->idProduct);
  39     dest[0x0b] = usb_hi(id->idProduct);
  40     dest[0x0c] = usb_lo(id->bcdDevice);
  41     dest[0x0d] = usb_hi(id->bcdDevice);
  42     dest[0x0e] = id->iManufacturer;
  43     dest[0x0f] = id->iProduct;
  44     dest[0x10] = id->iSerialNumber;
  45
  46     dest[0x11] = dev->bNumConfigurations;
  47
  48     return bLength;
  49 }
  50
  51 int usb_desc_device_qualifier(const USBDescDevice *dev,
  52                               uint8_t *dest, size_t len)
  53 {
  54     uint8_t bLength = 0x0a;
  55
  56     if (len < bLength) {
  57         return -1;
  58     }
  59
  60     dest[0x00] = bLength;
  61     dest[0x01] = USB_DT_DEVICE_QUALIFIER;
  62
  63     dest[0x02] = usb_lo(dev->bcdUSB);
  64     dest[0x03] = usb_hi(dev->bcdUSB);
  65     dest[0x04] = dev->bDeviceClass;
  66     dest[0x05] = dev->bDeviceSubClass;
  67     dest[0x06] = dev->bDeviceProtocol;
  68     dest[0x07] = dev->bMaxPacketSize0;
  69     dest[0x08] = dev->bNumConfigurations;
  70     dest[0x09] = 0; /* reserved */
  71
  72     return bLength;
  73 }
  74
  75 int usb_desc_config(const USBDescConfig *conf, uint8_t *dest, size_t len)
  76 {
  77     uint8_t  bLength = 0x09;
  78     uint16_t wTotalLength = 0;
  79     int i, rc;
  80
  81     if (len < bLength) {
  82         return -1;
  83     }
  84
  85     dest[0x00] = bLength;
  86     dest[0x01] = USB_DT_CONFIG;
  87     dest[0x04] = conf->bNumInterfaces;
  88     dest[0x05] = conf->bConfigurationValue;
  89     dest[0x06] = conf->iConfiguration;
  90     dest[0x07] = conf->bmAttributes;
  91     dest[0x08] = conf->bMaxPower;
  92     wTotalLength += bLength;
  93
  94     /* handle grouped interfaces if any*/
  95     for (i = 0; i < conf->nif_groups; i++) {
  96         rc = usb_desc_iface_group(&(conf->if_groups[i]),
  97                                   dest + wTotalLength,
  98                                   len - wTotalLength);
  99         if (rc < 0) {
 100             return rc;
 101         }
 102         wTotalLength += rc;
 103     }
 104
 105     /* handle normal (ungrouped / no IAD) interfaces if any */
 106     for (i = 0; i < conf->nif; i++) {
 107         rc = usb_desc_iface(conf->ifs + i, dest + wTotalLength, len - wTotalLength);
 108         if (rc < 0) {
 109             return rc;
 110         }
 111         wTotalLength += rc;
 112     }
 113
 114     dest[0x02] = usb_lo(wTotalLength);
 115     dest[0x03] = usb_hi(wTotalLength);
 116     return wTotalLength;
 117 }
 118
 119 int usb_desc_iface_group(const USBDescIfaceAssoc *iad, uint8_t *dest,
 120                          size_t len)
 121 {
 122     int pos = 0;
 123     int i = 0;
 124
 125     /* handle interface association descriptor */
 126     uint8_t bLength = 0x08;
 127
 128     if (len < bLength) {
 129         return -1;
 130     }
 131
 132     dest[0x00] = bLength;
 133     dest[0x01] = USB_DT_INTERFACE_ASSOC;
 134     dest[0x02] = iad->bFirstInterface;
 135     dest[0x03] = iad->bInterfaceCount;
 136     dest[0x04] = iad->bFunctionClass;
 137     dest[0x05] = iad->bFunctionSubClass;
 138     dest[0x06] = iad->bFunctionProtocol;
 139     dest[0x07] = iad->iFunction;
 140     pos += bLength;
 141
 142     /* handle associated interfaces in this group */
 143     for (i = 0; i < iad->nif; i++) {
 144         int rc = usb_desc_iface(&(iad->ifs[i]), dest + pos, len - pos);
 145         if (rc < 0) {
 146             return rc;
 147         }
 148         pos += rc;
 149     }
 150
 151     return pos;
 152 }
 153
 154 int usb_desc_iface(const USBDescIface *iface, uint8_t *dest, size_t len)
 155 {
 156     uint8_t bLength = 0x09;
 157     int i, rc, pos = 0;
 158
 159     if (len < bLength) {
 160         return -1;
 161     }
 162
 163     dest[0x00] = bLength;
 164     dest[0x01] = USB_DT_INTERFACE;
 165     dest[0x02] = iface->bInterfaceNumber;
 166     dest[0x03] = iface->bAlternateSetting;
 167     dest[0x04] = iface->bNumEndpoints;
 168     dest[0x05] = iface->bInterfaceClass;
 169     dest[0x06] = iface->bInterfaceSubClass;
 170     dest[0x07] = iface->bInterfaceProtocol;
 171     dest[0x08] = iface->iInterface;
 172     pos += bLength;
 173
 174     for (i = 0; i < iface->ndesc; i++) {
 175         rc = usb_desc_other(iface->descs + i, dest + pos, len - pos);
 176         if (rc < 0) {
 177             return rc;
 178         }
 179         pos += rc;
 180     }
 181
 182     for (i = 0; i < iface->bNumEndpoints; i++) {
 183         rc = usb_desc_endpoint(iface->eps + i, dest + pos, len - pos);
 184         if (rc < 0) {
 185             return rc;
 186         }
 187         pos += rc;
 188     }
 189
 190     return pos;
 191 }
 192
 193 int usb_desc_endpoint(const USBDescEndpoint *ep, uint8_t *dest, size_t len)
 194 {
 195     uint8_t bLength = ep->is_audio ? 0x09 : 0x07;
 196     uint8_t extralen = ep->extra ? ep->extra[0] : 0;
 197
 198     if (len < bLength + extralen) {
 199         return -1;
 200     }
 201
 202     dest[0x00] = bLength;
 203     dest[0x01] = USB_DT_ENDPOINT;
 204     dest[0x02] = ep->bEndpointAddress;
 205     dest[0x03] = ep->bmAttributes;
 206     dest[0x04] = usb_lo(ep->wMaxPacketSize);
 207     dest[0x05] = usb_hi(ep->wMaxPacketSize);
 208     dest[0x06] = ep->bInterval;
 209     if (ep->is_audio) {
 210         dest[0x07] = ep->bRefresh;
 211         dest[0x08] = ep->bSynchAddress;
 212     }
 213     if (ep->extra) {
 214         memcpy(dest + bLength, ep->extra, extralen);
 215     }
 216
 217     return bLength + extralen;
 218 }
 219
 220 int usb_desc_other(const USBDescOther *desc, uint8_t *dest, size_t len)
 221 {
 222     int bLength = desc->length ? desc->length : desc->data[0];
 223
 224     if (len < bLength) {
 225         return -1;
 226     }
 227
 228     memcpy(dest, desc->data, bLength);
 229     return bLength;
 230 }
 231
 232 /* ------------------------------------------------------------------ */
 233
 234 static const USBDescIface *usb_desc_find_interface(USBDevice *dev,
 235                                                    int nif, int alt)
 236 {
 237     const USBDescIface *iface;
 238     int g, i;
 239
 240     if (!dev->config) {
 241         return NULL;
 242     }
 243     for (g = 0; g < dev->config->nif_groups; g++) {
 244         for (i = 0; i < dev->config->if_groups[g].nif; i++) {
 245             iface = &dev->config->if_groups[g].ifs[i];
 246             if (iface->bInterfaceNumber == nif &&
 247                 iface->bAlternateSetting == alt) {
 248                 return iface;
 249             }
 250         }
 251     }
 252     for (i = 0; i < dev->config->nif; i++) {
 253         iface = &dev->config->ifs[i];
 254         if (iface->bInterfaceNumber == nif &&
 255             iface->bAlternateSetting == alt) {
 256             return iface;
 257         }
 258     }
 259     return NULL;
 260 }
 261
 262 static int usb_desc_set_interface(USBDevice *dev, int index, int value)
 263 {
 264     const USBDescIface *iface;
 265     int old;
 266
 267     iface = usb_desc_find_interface(dev, index, value);
 268     if (iface == NULL) {
 269         return -1;
 270     }
 271
 272     old = dev->altsetting[index];
 273     dev->altsetting[index] = value;
 274     dev->ifaces[index] = iface;
 275
 276     if (dev->info->set_interface && old != value) {
 277         dev->info->set_interface(dev, index, old, value);
 278     }
 279     return 0;
 280 }
 281
 282 static int usb_desc_set_config(USBDevice *dev, int value)
 283 {
 284     int i;
 285
 286     if (value == 0) {
 287         dev->configuration = 0;
 288         dev->ninterfaces   = 0;
 289         dev->config = NULL;
 290     } else {
 291         for (i = 0; i < dev->device->bNumConfigurations; i++) {
 292             if (dev->device->confs[i].bConfigurationValue == value) {
 293                 dev->configuration = value;
 294                 dev->ninterfaces   = dev->device->confs[i].bNumInterfaces;
 295                 dev->config = dev->device->confs + i;
 296                 assert(dev->ninterfaces <= USB_MAX_INTERFACES);
 297             }
 298         }
 299         if (i < dev->device->bNumConfigurations) {
 300             return -1;
 301         }
 302     }
 303
 304     for (i = 0; i < dev->ninterfaces; i++) {
 305         usb_desc_set_interface(dev, i, 0);
 306     }
 307     for (; i < USB_MAX_INTERFACES; i++) {
 308         dev->altsetting[i] = 0;
 309         dev->ifaces[i] = NULL;
 310     }
 311
 312     return 0;
 313 }
 314
 315 static void usb_desc_setdefaults(USBDevice *dev)
 316 {
 317     const USBDesc *desc = dev->info->usb_desc;
 318
 319     assert(desc != NULL);
 320     switch (dev->speed) {
 321     case USB_SPEED_LOW:
 322     case USB_SPEED_FULL:
 323         dev->device = desc->full;
 324         break;
 325     case USB_SPEED_HIGH:
 326         dev->device = desc->high;
 327         break;
 328     }
 329     usb_desc_set_config(dev, 0);
 330 }
 331
 332 void usb_desc_init(USBDevice *dev)
 333 {
 334     const USBDesc *desc = dev->info->usb_desc;
 335
 336     assert(desc != NULL);
 337     dev->speed = USB_SPEED_FULL;
 338     dev->speedmask = 0;
 339     if (desc->full) {
 340         dev->speedmask |= USB_SPEED_MASK_FULL;
 341     }
 342     if (desc->high) {
 343         dev->speedmask |= USB_SPEED_MASK_HIGH;
 344     }
 345     usb_desc_setdefaults(dev);
 346 }
 347
 348 void usb_desc_attach(USBDevice *dev)
 349 {
 350     const USBDesc *desc = dev->info->usb_desc;
 351
 352     assert(desc != NULL);
 353     if (desc->high && (dev->port->speedmask & USB_SPEED_MASK_HIGH)) {
 354         dev->speed = USB_SPEED_HIGH;
 355     } else if (desc->full && (dev->port->speedmask & USB_SPEED_MASK_FULL)) {
 356         dev->speed = USB_SPEED_FULL;
 357     } else {
 358         fprintf(stderr, "usb: port/device speed mismatch for \"%s\"\n",
 359                 dev->info->product_desc);
 360         return;
 361     }
 362     usb_desc_setdefaults(dev);
 363 }
 364
 365 void usb_desc_set_string(USBDevice *dev, uint8_t index, const char *str)
 366 {
 367     USBDescString *s;
 368
 369     QLIST_FOREACH(s, &dev->strings, next) {
 370         if (s->index == index) {
 371             break;
 372         }
 373     }
 374     if (s == NULL) {
 375         s = g_malloc0(sizeof(*s));
 376         s->index = index;
 377         QLIST_INSERT_HEAD(&dev->strings, s, next);
 378     }
 379     g_free(s->str);
 380     s->str = g_strdup(str);
 381 }
 382
 383 const char *usb_desc_get_string(USBDevice *dev, uint8_t index)
 384 {
 385     USBDescString *s;
 386
 387     QLIST_FOREACH(s, &dev->strings, next) {
 388         if (s->index == index) {
 389             return s->str;
 390         }
 391     }
 392     return NULL;
 393 }
 394
 395 int usb_desc_string(USBDevice *dev, int index, uint8_t *dest, size_t len)
 396 {
 397     uint8_t bLength, pos, i;
 398     const char *str;
 399
 400     if (len < 4) {
 401         return -1;
 402     }
 403
 404     if (index == 0) {
 405         /* language ids */
 406         dest[0] = 4;
 407         dest[1] = USB_DT_STRING;
 408         dest[2] = 0x09;
 409         dest[3] = 0x04;
 410         return 4;
 411     }
 412
 413     str = usb_desc_get_string(dev, index);
 414     if (str == NULL) {
 415         str = dev->info->usb_desc->str[index];
 416         if (str == NULL) {
 417             return 0;
 418         }
 419     }
 420
 421     bLength = strlen(str) * 2 + 2;
 422     dest[0] = bLength;
 423     dest[1] = USB_DT_STRING;
 424     i = 0; pos = 2;
 425     while (pos+1 < bLength && pos+1 < len) {
 426         dest[pos++] = str[i++];
 427         dest[pos++] = 0;
 428     }
 429     return pos;
 430 }
 431
 432 int usb_desc_get_descriptor(USBDevice *dev, int value, uint8_t *dest, size_t len)
 433 {
 434     const USBDesc *desc = dev->info->usb_desc;
 435     const USBDescDevice *other_dev;
 436     uint8_t buf[256];
 437     uint8_t type = value >> 8;
 438     uint8_t index = value & 0xff;
 439     int ret = -1;
 440
 441     if (dev->speed == USB_SPEED_HIGH) {
 442         other_dev = dev->info->usb_desc->full;
 443     } else {
 444         other_dev = dev->info->usb_desc->high;
 445     }
 446
 447     switch(type) {
 448     case USB_DT_DEVICE:
 449         ret = usb_desc_device(&desc->id, dev->device, buf, sizeof(buf));
 450         trace_usb_desc_device(dev->addr, len, ret);
 451         break;
 452     case USB_DT_CONFIG:
 453         if (index < dev->device->bNumConfigurations) {
 454             ret = usb_desc_config(dev->device->confs + index, buf, sizeof(buf));
 455         }
 456         trace_usb_desc_config(dev->addr, index, len, ret);
 457         break;
 458     case USB_DT_STRING:
 459         ret = usb_desc_string(dev, index, buf, sizeof(buf));
 460         trace_usb_desc_string(dev->addr, index, len, ret);
 461         break;
 462
 463     case USB_DT_DEVICE_QUALIFIER:
 464         if (other_dev != NULL) {
 465             ret = usb_desc_device_qualifier(other_dev, buf, sizeof(buf));
 466         }
 467         trace_usb_desc_device_qualifier(dev->addr, len, ret);
 468         break;
 469     case USB_DT_OTHER_SPEED_CONFIG:
 470         if (other_dev != NULL && index < other_dev->bNumConfigurations) {
 471             ret = usb_desc_config(other_dev->confs + index, buf, sizeof(buf));
 472             buf[0x01] = USB_DT_OTHER_SPEED_CONFIG;
 473         }
 474         trace_usb_desc_other_speed_config(dev->addr, index, len, ret);
 475         break;
 476
 477     case USB_DT_DEBUG:
 478         /* ignore silently */
 479         break;
 480
 481     default:
 482         fprintf(stderr, "%s: %d unknown type %d (len %zd)\n", __FUNCTION__,
 483                 dev->addr, type, len);
 484         break;
 485     }
 486
 487     if (ret > 0) {
 488         if (ret > len) {
 489             ret = len;
 490         }
 491         memcpy(dest, buf, ret);
 492     }
 493     return ret;
 494 }
 495
 496 int usb_desc_handle_control(USBDevice *dev, USBPacket *p,
 497         int request, int value, int index, int length, uint8_t *data)
 498 {
 499     const USBDesc *desc = dev->info->usb_desc;
 500     int ret = -1;
 501
 502     assert(desc != NULL);
 503     switch(request) {
 504     case DeviceOutRequest | USB_REQ_SET_ADDRESS:
 505         dev->addr = value;
 506         trace_usb_set_addr(dev->addr);
 507         ret = 0;
 508         break;
 509
 510     case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
 511         ret = usb_desc_get_descriptor(dev, value, data, length);
 512         break;
 513
 514     case DeviceRequest | USB_REQ_GET_CONFIGURATION:
 515         data[0] = dev->config->bConfigurationValue;
 516         ret = 1;
 517         break;
 518     case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
 519         ret = usb_desc_set_config(dev, value);
 520         trace_usb_set_config(dev->addr, value, ret);
 521         break;
 522
 523     case DeviceRequest | USB_REQ_GET_STATUS:
 524         data[0] = 0;
 525         if (dev->config->bmAttributes & 0x40) {
 526             data[0] |= 1 << USB_DEVICE_SELF_POWERED;
 527         }
 528         if (dev->remote_wakeup) {
 529             data[0] |= 1 << USB_DEVICE_REMOTE_WAKEUP;
 530         }
 531         data[1] = 0x00;
 532         ret = 2;
 533         break;
 534     case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
 535         if (value == USB_DEVICE_REMOTE_WAKEUP) {
 536             dev->remote_wakeup = 0;
 537             ret = 0;
 538         }
 539         trace_usb_clear_device_feature(dev->addr, value, ret);
 540         break;
 541     case DeviceOutRequest | USB_REQ_SET_FEATURE:
 542         if (value == USB_DEVICE_REMOTE_WAKEUP) {
 543             dev->remote_wakeup = 1;
 544             ret = 0;
 545         }
 546         trace_usb_set_device_feature(dev->addr, value, ret);
 547         break;
 548
 549     case InterfaceRequest | USB_REQ_GET_INTERFACE:
 550         if (index < 0 || index >= dev->ninterfaces) {
 551             break;
 552         }
 553         data[0] = dev->altsetting[index];
 554         ret = 1;
 555         break;
 556     case InterfaceOutRequest | USB_REQ_SET_INTERFACE:
 557         ret = usb_desc_set_interface(dev, index, value);
 558         trace_usb_set_interface(dev->addr, index, value, ret);
 559         break;
 560
 561     }
 562     return ret;
 563 }