usb_linux.c revision 3d9b265b7d34d886a2f44e486c25e402d7df791b
1/* 2 * Copyright (C) 2007 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17#include <stdio.h> 18#include <stdlib.h> 19#include <unistd.h> 20#include <string.h> 21 22#include <sys/ioctl.h> 23#include <sys/types.h> 24#include <dirent.h> 25#include <fcntl.h> 26#include <errno.h> 27#include <ctype.h> 28 29#include <linux/usbdevice_fs.h> 30#include <linux/version.h> 31#if LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 20) 32#include <linux/usb/ch9.h> 33#else 34#include <linux/usb_ch9.h> 35#endif 36#include <asm/byteorder.h> 37 38#include "sysdeps.h" 39 40#define TRACE_TAG TRACE_USB 41#include "adb.h" 42 43 44/* usb scan debugging is waaaay too verbose */ 45#define DBGX(x...) 46 47static adb_mutex_t usb_lock = ADB_MUTEX_INITIALIZER; 48 49struct usb_handle 50{ 51 usb_handle *prev; 52 usb_handle *next; 53 54 char fname[64]; 55 int desc; 56 unsigned char ep_in; 57 unsigned char ep_out; 58 59 unsigned zero_mask; 60 61 struct usbdevfs_urb urb_in; 62 struct usbdevfs_urb urb_out; 63 64 int urb_in_busy; 65 int urb_out_busy; 66 int dead; 67 68 adb_cond_t notify; 69 adb_mutex_t lock; 70 71 // for garbage collecting disconnected devices 72 int mark; 73 74 // ID of thread currently in REAPURB 75 pthread_t reaper_thread; 76}; 77 78static usb_handle handle_list = { 79 .prev = &handle_list, 80 .next = &handle_list, 81}; 82 83static int known_device(const char *dev_name) 84{ 85 usb_handle *usb; 86 87 adb_mutex_lock(&usb_lock); 88 for(usb = handle_list.next; usb != &handle_list; usb = usb->next){ 89 if(!strcmp(usb->fname, dev_name)) { 90 // set mark flag to indicate this device is still alive 91 usb->mark = 1; 92 adb_mutex_unlock(&usb_lock); 93 return 1; 94 } 95 } 96 adb_mutex_unlock(&usb_lock); 97 return 0; 98} 99 100static void kick_disconnected_devices() 101{ 102 usb_handle *usb; 103 104 adb_mutex_lock(&usb_lock); 105 // kick any devices in the device list that were not found in the device scan 106 for(usb = handle_list.next; usb != &handle_list; usb = usb->next){ 107 if (usb->mark == 0) { 108 usb_kick(usb); 109 } else { 110 usb->mark = 0; 111 } 112 } 113 adb_mutex_unlock(&usb_lock); 114 115} 116 117static void register_device(const char *dev_name, unsigned char ep_in, unsigned char ep_out, 118 int ifc, const char *serial, unsigned zero_mask); 119 120static inline int badname(const char *name) 121{ 122 while(*name) { 123 if(!isdigit(*name++)) return 1; 124 } 125 return 0; 126} 127 128static int find_usb_device(const char *base, 129 void (*register_device_callback) (const char *, unsigned char, unsigned char, int, const char *, unsigned)) 130{ 131 char busname[32], devname[32]; 132 unsigned char local_ep_in, local_ep_out; 133 DIR *busdir , *devdir ; 134 struct dirent *de; 135 int fd ; 136 int found_device = 0; 137 char serial[256]; 138 139 busdir = opendir(base); 140 if(busdir == 0) return 0; 141 142 while((de = readdir(busdir)) != 0) { 143 if(badname(de->d_name)) continue; 144 145 snprintf(busname, sizeof busname, "%s/%s", base, de->d_name); 146 devdir = opendir(busname); 147 if(devdir == 0) continue; 148 149// DBGX("[ scanning %s ]\n", busname); 150 while((de = readdir(devdir))) { 151 unsigned char devdesc[256]; 152 unsigned char* bufptr = devdesc; 153 struct usb_device_descriptor* device; 154 struct usb_config_descriptor* config; 155 struct usb_interface_descriptor* interface; 156 struct usb_endpoint_descriptor *ep1, *ep2; 157 unsigned zero_mask = 0; 158 unsigned vid, pid; 159 int i, interfaces; 160 size_t desclength; 161 162 if(badname(de->d_name)) continue; 163 snprintf(devname, sizeof devname, "%s/%s", busname, de->d_name); 164 165 if(known_device(devname)) { 166 DBGX("skipping %s\n", devname); 167 continue; 168 } 169 170// DBGX("[ scanning %s ]\n", devname); 171 if((fd = unix_open(devname, O_RDWR)) < 0) { 172 continue; 173 } 174 175 desclength = adb_read(fd, devdesc, sizeof(devdesc)); 176 177 // should have device and configuration descriptors, and atleast two endpoints 178 if (desclength < USB_DT_DEVICE_SIZE + USB_DT_CONFIG_SIZE) { 179 D("desclength %d is too small\n", desclength); 180 adb_close(fd); 181 continue; 182 } 183 184 device = (struct usb_device_descriptor*)bufptr; 185 bufptr += USB_DT_DEVICE_SIZE; 186 187 if((device->bLength != USB_DT_DEVICE_SIZE) || (device->bDescriptorType != USB_DT_DEVICE)) { 188 adb_close(fd); 189 continue; 190 } 191 192 vid = __le16_to_cpu(device->idVendor); 193 pid = __le16_to_cpu(device->idProduct); 194 pid = devdesc[10] | (devdesc[11] << 8); 195 DBGX("[ %s is V:%04x P:%04x ]\n", devname, vid, pid); 196 197 // should have config descriptor next 198 config = (struct usb_config_descriptor *)bufptr; 199 bufptr += USB_DT_CONFIG_SIZE; 200 if (config->bLength != USB_DT_CONFIG_SIZE || config->bDescriptorType != USB_DT_CONFIG) { 201 D("usb_config_descriptor not found\n"); 202 adb_close(fd); 203 continue; 204 } 205 206 // loop through all the interfaces and look for the ADB interface 207 interfaces = config->bNumInterfaces; 208 for (i = 0; i < interfaces; i++) { 209 if (bufptr + USB_DT_ENDPOINT_SIZE > devdesc + desclength) 210 break; 211 212 interface = (struct usb_interface_descriptor *)bufptr; 213 bufptr += USB_DT_INTERFACE_SIZE; 214 if (interface->bLength != USB_DT_INTERFACE_SIZE || 215 interface->bDescriptorType != USB_DT_INTERFACE) { 216 D("usb_interface_descriptor not found\n"); 217 break; 218 } 219 220 DBGX("bInterfaceClass: %d, bInterfaceSubClass: %d," 221 "bInterfaceProtocol: %d, bNumEndpoints: %d\n", 222 interface->bInterfaceClass, interface->bInterfaceSubClass, 223 interface->bInterfaceProtocol, interface->bNumEndpoints); 224 225 if (interface->bNumEndpoints == 2 && 226 is_adb_interface(vid, pid, interface->bInterfaceClass, 227 interface->bInterfaceSubClass, interface->bInterfaceProtocol)) { 228 229 DBGX("looking for bulk endpoints\n"); 230 // looks like ADB... 231 ep1 = (struct usb_endpoint_descriptor *)bufptr; 232 bufptr += USB_DT_ENDPOINT_SIZE; 233 ep2 = (struct usb_endpoint_descriptor *)bufptr; 234 bufptr += USB_DT_ENDPOINT_SIZE; 235 236 if (bufptr > devdesc + desclength || 237 ep1->bLength != USB_DT_ENDPOINT_SIZE || 238 ep1->bDescriptorType != USB_DT_ENDPOINT || 239 ep2->bLength != USB_DT_ENDPOINT_SIZE || 240 ep2->bDescriptorType != USB_DT_ENDPOINT) { 241 D("endpoints not found\n"); 242 break; 243 } 244 245 // both endpoints should be bulk 246 if (ep1->bmAttributes != USB_ENDPOINT_XFER_BULK || 247 ep2->bmAttributes != USB_ENDPOINT_XFER_BULK) { 248 D("bulk endpoints not found\n"); 249 continue; 250 } 251 252 /* aproto 01 needs 0 termination */ 253 if(interface->bInterfaceProtocol == 0x01) { 254 zero_mask = ep1->wMaxPacketSize - 1; 255 } 256 257 // we have a match. now we just need to figure out which is in and which is out. 258 if (ep1->bEndpointAddress & USB_ENDPOINT_DIR_MASK) { 259 local_ep_in = ep1->bEndpointAddress; 260 local_ep_out = ep2->bEndpointAddress; 261 } else { 262 local_ep_in = ep2->bEndpointAddress; 263 local_ep_out = ep1->bEndpointAddress; 264 } 265 266 // read the device's serial number 267 serial[0] = 0; 268 memset(serial, 0, sizeof(serial)); 269 if (device->iSerialNumber) { 270 struct usbdevfs_ctrltransfer ctrl; 271 __u16 buffer[128]; 272 __u16 languages[128]; 273 int i, result; 274 int languageCount = 0; 275 276 memset(languages, 0, sizeof(languages)); 277 memset(&ctrl, 0, sizeof(ctrl)); 278 279 // read list of supported languages 280 ctrl.bRequestType = USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE; 281 ctrl.bRequest = USB_REQ_GET_DESCRIPTOR; 282 ctrl.wValue = (USB_DT_STRING << 8) | 0; 283 ctrl.wIndex = 0; 284 ctrl.wLength = sizeof(languages); 285 ctrl.data = languages; 286 287 result = ioctl(fd, USBDEVFS_CONTROL, &ctrl); 288 if (result > 0) 289 languageCount = (result - 2) / 2; 290 291 for (i = 1; i <= languageCount; i++) { 292 memset(buffer, 0, sizeof(buffer)); 293 memset(&ctrl, 0, sizeof(ctrl)); 294 295 ctrl.bRequestType = USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE; 296 ctrl.bRequest = USB_REQ_GET_DESCRIPTOR; 297 ctrl.wValue = (USB_DT_STRING << 8) | device->iSerialNumber; 298 ctrl.wIndex = languages[i]; 299 ctrl.wLength = sizeof(buffer); 300 ctrl.data = buffer; 301 302 result = ioctl(fd, USBDEVFS_CONTROL, &ctrl); 303 if (result > 0) { 304 int i; 305 // skip first word, and copy the rest to the serial string, changing shorts to bytes. 306 result /= 2; 307 for (i = 1; i < result; i++) 308 serial[i - 1] = buffer[i]; 309 serial[i - 1] = 0; 310 break; 311 } 312 } 313 } 314 315 register_device_callback(devname, local_ep_in, local_ep_out, 316 interface->bInterfaceNumber, serial, zero_mask); 317 318 found_device = 1; 319 break; 320 } else { 321 // skip to next interface 322 bufptr += (interface->bNumEndpoints * USB_DT_ENDPOINT_SIZE); 323 } 324 } // end of for 325 326 adb_close(fd); 327 } // end of devdir while 328 closedir(devdir); 329 } //end of busdir while 330 closedir(busdir); 331 332 return found_device; 333} 334 335void usb_cleanup() 336{ 337} 338 339static int usb_bulk_write(usb_handle *h, const void *data, int len) 340{ 341 struct usbdevfs_urb *urb = &h->urb_out; 342 int res; 343 344 memset(urb, 0, sizeof(*urb)); 345 urb->type = USBDEVFS_URB_TYPE_BULK; 346 urb->endpoint = h->ep_out; 347 urb->status = -1; 348 urb->buffer = (void*) data; 349 urb->buffer_length = len; 350 351 D("++ write ++\n"); 352 353 adb_mutex_lock(&h->lock); 354 if(h->dead) { 355 res = -1; 356 goto fail; 357 } 358 do { 359 res = ioctl(h->desc, USBDEVFS_SUBMITURB, urb); 360 } while((res < 0) && (errno == EINTR)); 361 362 if(res < 0) { 363 goto fail; 364 } 365 366 res = -1; 367 h->urb_out_busy = 1; 368 for(;;) { 369 adb_cond_wait(&h->notify, &h->lock); 370 if(h->dead) { 371 break; 372 } 373 if(h->urb_out_busy == 0) { 374 if(urb->status == 0) { 375 res = urb->actual_length; 376 } 377 break; 378 } 379 } 380fail: 381 adb_mutex_unlock(&h->lock); 382 D("-- write --\n"); 383 return res; 384} 385 386static int usb_bulk_read(usb_handle *h, void *data, int len) 387{ 388 struct usbdevfs_urb *urb = &h->urb_in; 389 struct usbdevfs_urb *out = NULL; 390 int res; 391 392 memset(urb, 0, sizeof(*urb)); 393 urb->type = USBDEVFS_URB_TYPE_BULK; 394 urb->endpoint = h->ep_in; 395 urb->status = -1; 396 urb->buffer = data; 397 urb->buffer_length = len; 398 399 400 adb_mutex_lock(&h->lock); 401 if(h->dead) { 402 res = -1; 403 goto fail; 404 } 405 do { 406 res = ioctl(h->desc, USBDEVFS_SUBMITURB, urb); 407 } while((res < 0) && (errno == EINTR)); 408 409 if(res < 0) { 410 goto fail; 411 } 412 413 h->urb_in_busy = 1; 414 for(;;) { 415 D("[ reap urb - wait ]\n"); 416 h->reaper_thread = pthread_self(); 417 adb_mutex_unlock(&h->lock); 418 res = ioctl(h->desc, USBDEVFS_REAPURB, &out); 419 adb_mutex_lock(&h->lock); 420 h->reaper_thread = 0; 421 if(h->dead) { 422 res = -1; 423 break; 424 } 425 if(res < 0) { 426 if(errno == EINTR) { 427 continue; 428 } 429 D("[ reap urb - error ]\n"); 430 break; 431 } 432 D("[ urb @%p status = %d, actual = %d ]\n", 433 out, out->status, out->actual_length); 434 435 if(out == &h->urb_in) { 436 D("[ reap urb - IN complete ]\n"); 437 h->urb_in_busy = 0; 438 if(urb->status == 0) { 439 res = urb->actual_length; 440 } else { 441 res = -1; 442 } 443 break; 444 } 445 if(out == &h->urb_out) { 446 D("[ reap urb - OUT compelete ]\n"); 447 h->urb_out_busy = 0; 448 adb_cond_broadcast(&h->notify); 449 } 450 } 451fail: 452 adb_mutex_unlock(&h->lock); 453 return res; 454} 455 456 457int usb_write(usb_handle *h, const void *_data, int len) 458{ 459 unsigned char *data = (unsigned char*) _data; 460 int n; 461 int need_zero = 0; 462 463 if(h->zero_mask) { 464 /* if we need 0-markers and our transfer 465 ** is an even multiple of the packet size, 466 ** we make note of it 467 */ 468 if(!(len & h->zero_mask)) { 469 need_zero = 1; 470 } 471 } 472 473 while(len > 0) { 474 int xfer = (len > 4096) ? 4096 : len; 475 476 n = usb_bulk_write(h, data, xfer); 477 if(n != xfer) { 478 D("ERROR: n = %d, errno = %d (%s)\n", 479 n, errno, strerror(errno)); 480 return -1; 481 } 482 483 len -= xfer; 484 data += xfer; 485 } 486 487 if(need_zero){ 488 n = usb_bulk_write(h, _data, 0); 489 return n; 490 } 491 492 return 0; 493} 494 495int usb_read(usb_handle *h, void *_data, int len) 496{ 497 unsigned char *data = (unsigned char*) _data; 498 int n; 499 500 D("++ usb_read ++\n"); 501 while(len > 0) { 502 int xfer = (len > 4096) ? 4096 : len; 503 504 D("[ usb read %d fd = %d], fname=%s\n", xfer, h->desc, h->fname); 505 n = usb_bulk_read(h, data, xfer); 506 D("[ usb read %d ] = %d, fname=%s\n", xfer, n, h->fname); 507 if(n != xfer) { 508 if((errno == ETIMEDOUT) && (h->desc != -1)) { 509 D("[ timeout ]\n"); 510 if(n > 0){ 511 data += n; 512 len -= n; 513 } 514 continue; 515 } 516 D("ERROR: n = %d, errno = %d (%s)\n", 517 n, errno, strerror(errno)); 518 return -1; 519 } 520 521 len -= xfer; 522 data += xfer; 523 } 524 525 D("-- usb_read --\n"); 526 return 0; 527} 528 529void usb_kick(usb_handle *h) 530{ 531 D("[ kicking %p (fd = %d) ]\n", h, h->desc); 532 adb_mutex_lock(&h->lock); 533 if(h->dead == 0) { 534 h->dead = 1; 535 536 /* HACK ALERT! 537 ** Sometimes we get stuck in ioctl(USBDEVFS_REAPURB). 538 ** This is a workaround for that problem. 539 */ 540 if (h->reaper_thread) { 541 pthread_kill(h->reaper_thread, SIGALRM); 542 } 543 544 /* cancel any pending transactions 545 ** these will quietly fail if the txns are not active, 546 ** but this ensures that a reader blocked on REAPURB 547 ** will get unblocked 548 */ 549 ioctl(h->desc, USBDEVFS_DISCARDURB, &h->urb_in); 550 ioctl(h->desc, USBDEVFS_DISCARDURB, &h->urb_out); 551 h->urb_in.status = -ENODEV; 552 h->urb_out.status = -ENODEV; 553 h->urb_in_busy = 0; 554 h->urb_out_busy = 0; 555 adb_cond_broadcast(&h->notify); 556 } 557 adb_mutex_unlock(&h->lock); 558} 559 560int usb_close(usb_handle *h) 561{ 562 D("[ usb close ... ]\n"); 563 adb_mutex_lock(&usb_lock); 564 h->next->prev = h->prev; 565 h->prev->next = h->next; 566 h->prev = 0; 567 h->next = 0; 568 569 adb_close(h->desc); 570 D("[ usb closed %p (fd = %d) ]\n", h, h->desc); 571 adb_mutex_unlock(&usb_lock); 572 573 free(h); 574 return 0; 575} 576 577static void register_device(const char *dev_name, 578 unsigned char ep_in, unsigned char ep_out, 579 int interface, 580 const char *serial, unsigned zero_mask) 581{ 582 usb_handle* usb = 0; 583 int n = 0; 584 585 /* Since Linux will not reassign the device ID (and dev_name) 586 ** as long as the device is open, we can add to the list here 587 ** once we open it and remove from the list when we're finally 588 ** closed and everything will work out fine. 589 ** 590 ** If we have a usb_handle on the list 'o handles with a matching 591 ** name, we have no further work to do. 592 */ 593 adb_mutex_lock(&usb_lock); 594 for(usb = handle_list.next; usb != &handle_list; usb = usb->next){ 595 if(!strcmp(usb->fname, dev_name)) { 596 adb_mutex_unlock(&usb_lock); 597 return; 598 } 599 } 600 adb_mutex_unlock(&usb_lock); 601 602 D("[ usb located new device %s (%d/%d/%d) ]\n", 603 dev_name, ep_in, ep_out, interface); 604 usb = calloc(1, sizeof(usb_handle)); 605 strcpy(usb->fname, dev_name); 606 usb->ep_in = ep_in; 607 usb->ep_out = ep_out; 608 usb->zero_mask = zero_mask; 609 610 adb_cond_init(&usb->notify, 0); 611 adb_mutex_init(&usb->lock, 0); 612 /* initialize mark to 1 so we don't get garbage collected after the device scan */ 613 usb->mark = 1; 614 usb->reaper_thread = 0; 615 616 usb->desc = unix_open(usb->fname, O_RDWR); 617 if(usb->desc < 0) goto fail; 618 D("[ usb open %s fd = %d]\n", usb->fname, usb->desc); 619 n = ioctl(usb->desc, USBDEVFS_CLAIMINTERFACE, &interface); 620 if(n != 0) goto fail; 621 622 /* add to the end of the active handles */ 623 adb_mutex_lock(&usb_lock); 624 usb->next = &handle_list; 625 usb->prev = handle_list.prev; 626 usb->prev->next = usb; 627 usb->next->prev = usb; 628 adb_mutex_unlock(&usb_lock); 629 630 register_usb_transport(usb, serial); 631 return; 632 633fail: 634 D("[ usb open %s error=%d, err_str = %s]\n", 635 usb->fname, errno, strerror(errno)); 636 if(usb->desc >= 0) { 637 adb_close(usb->desc); 638 } 639 free(usb); 640} 641 642void* device_poll_thread(void* unused) 643{ 644 D("Created device thread\n"); 645 for(;;) { 646 /* XXX use inotify */ 647 find_usb_device("/dev/bus/usb", register_device); 648 kick_disconnected_devices(); 649 sleep(1); 650 } 651 return NULL; 652} 653 654static void sigalrm_handler(int signo) 655{ 656 // don't need to do anything here 657} 658 659void usb_init() 660{ 661 adb_thread_t tid; 662 struct sigaction actions; 663 664 memset(&actions, 0, sizeof(actions)); 665 sigemptyset(&actions.sa_mask); 666 actions.sa_flags = 0; 667 actions.sa_handler = sigalrm_handler; 668 sigaction(SIGALRM,& actions, NULL); 669 670 if(adb_thread_create(&tid, device_poll_thread, NULL)){ 671 fatal_errno("cannot create input thread"); 672 } 673} 674 675