libusbhost/usbhost.c - platform/system/core - Gitiles

 /*
  * Copyright (C) 2010 The Android Open Source Project
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *      http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */

 // #define DEBUG 1
 #if DEBUG

 #ifdef USE_LIBLOG
 #define LOG_TAG "usbhost"
 #include "utils/Log.h"
 #define D LOGD
 #else
 #define D printf
 #endif

 #else
 #define D(...)
 #endif

 #include <stdio.h>
 #include <stdlib.h>
 #include <unistd.h>
 #include <string.h>

 #include <sys/ioctl.h>
 #include <sys/types.h>
 #include <sys/time.h>
 #include <sys/inotify.h>
 #include <dirent.h>
 #include <fcntl.h>
 #include <errno.h>
 #include <ctype.h>
 #include <pthread.h>

 #include <linux/usbdevice_fs.h>
 #include <asm/byteorder.h>

 #include "usbhost/usbhost.h"

 #define USB_FS_DIR "/dev/bus/usb"
 #define USB_FS_ID_SCANNER   "/dev/bus/usb/%d/%d"
 #define USB_FS_ID_FORMAT    "/dev/bus/usb/%03d/%03d"

 // From drivers/usb/core/devio.c
 // I don't know why this isn't in a kernel header
 #define MAX_USBFS_BUFFER_SIZE   16384

 struct usb_host_context {
     int fd;
 };

 struct usb_device {
     char dev_name[64];
     unsigned char desc[4096];
     int desc_length;
     int fd;
     int writeable;
 };

 static inline int badname(const char *name)
 {
     while(*name) {
         if(!isdigit(*name++)) return 1;
     }
     return 0;
 }

 /* returns true if one of the callbacks indicates we are done */
 static int find_existing_devices(usb_device_added_cb added_cb,
                                   usb_device_removed_cb removed_cb,
                                   void *client_data)
 {
     char busname[32], devname[32];
     DIR *busdir , *devdir ;
     struct dirent *de;
     int done = 0;

     busdir = opendir(USB_FS_DIR);
     if(busdir == 0) return 1;

     while ((de = readdir(busdir)) != 0 && !done) {
         if(badname(de->d_name)) continue;

         snprintf(busname, sizeof busname, "%s/%s", USB_FS_DIR, de->d_name);
         devdir = opendir(busname);
         if(devdir == 0) continue;

         while ((de = readdir(devdir)) && !done) {
             if(badname(de->d_name)) continue;

             snprintf(devname, sizeof devname, "%s/%s", busname, de->d_name);
             done = added_cb(devname, client_data);
         } // end of devdir while
         closedir(devdir);
     } //end of busdir while
     closedir(busdir);

     return done;
 }

 struct usb_host_context *usb_host_init()
 {
     struct usb_host_context *context = calloc(1, sizeof(struct usb_host_context));
     if (!context) {
         fprintf(stderr, "out of memory in usb_host_context\n");
         return NULL;
     }
     context->fd = inotify_init();
     if (context->fd < 0) {
         fprintf(stderr, "inotify_init failed\n");
         free(context);
         return NULL;
     }
     return context;
 }

 void usb_host_cleanup(struct usb_host_context *context)
 {
     close(context->fd);
     free(context);
 }

 void usb_host_run(struct usb_host_context *context,
                   usb_device_added_cb added_cb,
                   usb_device_removed_cb removed_cb,
                   usb_discovery_done_cb discovery_done_cb,
                   void *client_data)
 {
     struct inotify_event* event;
     char event_buf[512];
     char path[100];
     int i, ret, done = 0;
     int wd, wds[10];
     int wd_count = sizeof(wds) / sizeof(wds[0]);

     D("Created device discovery thread\n");

     /* watch for files added and deleted within USB_FS_DIR */
     memset(wds, 0, sizeof(wds));
     /* watch the root for new subdirectories */
     wds[0] = inotify_add_watch(context->fd, USB_FS_DIR, IN_CREATE | IN_DELETE);
     if (wds[0] < 0) {
         fprintf(stderr, "inotify_add_watch failed\n");
         if (discovery_done_cb)
             discovery_done_cb(client_data);
         return;
     }

     /* watch existing subdirectories of USB_FS_DIR */
     for (i = 1; i < wd_count; i++) {
         snprintf(path, sizeof(path), "%s/%03d", USB_FS_DIR, i);
         ret = inotify_add_watch(context->fd, path, IN_CREATE | IN_DELETE);
         if (ret > 0)
             wds[i] = ret;
     }

     /* check for existing devices first, after we have inotify set up */
     done = find_existing_devices(added_cb, removed_cb, client_data);
     if (discovery_done_cb)
         done |= discovery_done_cb(client_data);

     while (!done) {
         ret = read(context->fd, event_buf, sizeof(event_buf));
         if (ret >= (int)sizeof(struct inotify_event)) {
             event = (struct inotify_event *)event_buf;
             wd = event->wd;
             if (wd == wds[0]) {
                 i = atoi(event->name);
                 snprintf(path, sizeof(path), "%s/%s", USB_FS_DIR, event->name);
                 D("new subdirectory %s: index: %d\n", path, i);
                 if (i > 0 && i < wd_count) {
                 ret = inotify_add_watch(context->fd, path, IN_CREATE | IN_DELETE);
                 if (ret > 0)
                     wds[i] = ret;
                 }
             } else {
                 for (i = 1; i < wd_count && !done; i++) {
                     if (wd == wds[i]) {
                         snprintf(path, sizeof(path), "%s/%03d/%s", USB_FS_DIR, i, event->name);
                         if (event->mask == IN_CREATE) {
                             D("new device %s\n", path);
                             done = added_cb(path, client_data);
                         } else if (event->mask == IN_DELETE) {
                             D("gone device %s\n", path);
                             done = removed_cb(path, client_data);
                         }
                     }
                 }
             }
         }
     }
 }

 struct usb_device *usb_device_open(const char *dev_name)
 {
     int fd, did_retry = 0, writeable = 1;

     D("usb_device_open %s\n", dev_name);

 retry:
     fd = open(dev_name, O_RDWR);
     if (fd < 0) {
         /* if we fail, see if have read-only access */
         fd = open(dev_name, O_RDONLY);
         D("usb_device_open open returned %d errno %d\n", fd, errno);
         if (fd < 0 && (errno == EACCES || errno == ENOENT) && !did_retry) {
             /* work around race condition between inotify and permissions management */
             sleep(1);
             did_retry = 1;
             goto retry;
         }

         if (fd < 0)
             return NULL;
         writeable = 0;
         D("[ usb open read-only %s fd = %d]\n", dev_name, fd);
     }

     struct usb_device* result = usb_device_new(dev_name, fd);
     if (result)
         result->writeable = writeable;
     return result;
 }

 void usb_device_close(struct usb_device *device)
 {
     close(device->fd);
     free(device);
 }

 struct usb_device *usb_device_new(const char *dev_name, int fd)
 {
     struct usb_device *device = calloc(1, sizeof(struct usb_device));
     int length;

     D("usb_device_new %s fd: %d\n", dev_name, fd);

     if (lseek(fd, 0, SEEK_SET) != 0)
         goto failed;
     length = read(fd, device->desc, sizeof(device->desc));
     D("usb_device_new read returned %d errno %d\n", length, errno);
     if (length < 0)
         goto failed;

     strncpy(device->dev_name, dev_name, sizeof(device->dev_name) - 1);
     device->fd = fd;
     device->desc_length = length;
     // assume we are writeable, since usb_device_get_fd will only return writeable fds
     device->writeable = 1;
     return device;

 failed:
     close(fd);
     free(device);
     return NULL;
 }

 static int usb_device_reopen_writeable(struct usb_device *device)
 {
     if (device->writeable)
         return 1;

     int fd = open(device->dev_name, O_RDWR);
     if (fd >= 0) {
         close(device->fd);
         device->fd = fd;
         device->writeable = 1;
         return 1;
     }
     D("usb_device_reopen_writeable failed errno %d\n", errno);
     return 0;
 }

 int usb_device_get_fd(struct usb_device *device)
 {
     if (!usb_device_reopen_writeable(device))
         return -1;
     return device->fd;
 }

 const char* usb_device_get_name(struct usb_device *device)
 {
     return device->dev_name;
 }

 int usb_device_get_unique_id(struct usb_device *device)
 {
     int bus = 0, dev = 0;
     sscanf(device->dev_name, USB_FS_ID_SCANNER, &bus, &dev);
     return bus * 1000 + dev;
 }

 int usb_device_get_unique_id_from_name(const char* name)
 {
     int bus = 0, dev = 0;
     sscanf(name, USB_FS_ID_SCANNER, &bus, &dev);
     return bus * 1000 + dev;
 }

 char* usb_device_get_name_from_unique_id(int id)
 {
     int bus = id / 1000;
     int dev = id % 1000;
     char* result = (char *)calloc(1, strlen(USB_FS_ID_FORMAT));
     snprintf(result, strlen(USB_FS_ID_FORMAT) - 1, USB_FS_ID_FORMAT, bus, dev);
     return result;
 }

 uint16_t usb_device_get_vendor_id(struct usb_device *device)
 {
     struct usb_device_descriptor* desc = (struct usb_device_descriptor*)device->desc;
     return __le16_to_cpu(desc->idVendor);
 }

 uint16_t usb_device_get_product_id(struct usb_device *device)
 {
     struct usb_device_descriptor* desc = (struct usb_device_descriptor*)device->desc;
     return __le16_to_cpu(desc->idProduct);
 }

 const struct usb_device_descriptor* usb_device_get_device_descriptor(struct usb_device *device)
 {
     return (struct usb_device_descriptor*)device->desc;
 }

 char* usb_device_get_string(struct usb_device *device, int id)
 {
     char string[256];
     __u16 buffer[128];
     __u16 languages[128];
     int i, result;
     int languageCount = 0;

     string[0] = 0;
     memset(languages, 0, sizeof(languages));

     // read list of supported languages
     result = usb_device_control_transfer(device,
             USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE, USB_REQ_GET_DESCRIPTOR,
             (USB_DT_STRING << 8) | 0, 0, languages, sizeof(languages), 0);
     if (result > 0)
         languageCount = (result - 2) / 2;

     for (i = 1; i <= languageCount; i++) {
         memset(buffer, 0, sizeof(buffer));

         result = usb_device_control_transfer(device,
                 USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE, USB_REQ_GET_DESCRIPTOR,
                 (USB_DT_STRING << 8) | id, languages[i], buffer, sizeof(buffer), 0);
         if (result > 0) {
             int i;
             // skip first word, and copy the rest to the string, changing shorts to bytes.
             result /= 2;
             for (i = 1; i < result; i++)
                 string[i - 1] = buffer[i];
             string[i - 1] = 0;
             return strdup(string);
         }
     }

     return NULL;
 }

 char* usb_device_get_manufacturer_name(struct usb_device *device)
 {
     struct usb_device_descriptor *desc = (struct usb_device_descriptor *)device->desc;

     if (desc->iManufacturer)
         return usb_device_get_string(device, desc->iManufacturer);
     else
         return NULL;
 }

 char* usb_device_get_product_name(struct usb_device *device)
 {
     struct usb_device_descriptor *desc = (struct usb_device_descriptor *)device->desc;

     if (desc->iProduct)
         return usb_device_get_string(device, desc->iProduct);
     else
         return NULL;
 }

 char* usb_device_get_serial(struct usb_device *device)
 {
     struct usb_device_descriptor *desc = (struct usb_device_descriptor *)device->desc;

     if (desc->iSerialNumber)
         return usb_device_get_string(device, desc->iSerialNumber);
     else
         return NULL;
 }

 int usb_device_is_writeable(struct usb_device *device)
 {
     return device->writeable;
 }

 void usb_descriptor_iter_init(struct usb_device *device, struct usb_descriptor_iter *iter)
 {
     iter->config = device->desc;
     iter->config_end = device->desc + device->desc_length;
     iter->curr_desc = device->desc;
 }

 struct usb_descriptor_header *usb_descriptor_iter_next(struct usb_descriptor_iter *iter)
 {
     struct usb_descriptor_header* next;
     if (iter->curr_desc >= iter->config_end)
         return NULL;
     next = (struct usb_descriptor_header*)iter->curr_desc;
     iter->curr_desc += next->bLength;
     return next;
 }

 int usb_device_claim_interface(struct usb_device *device, unsigned int interface)
 {
     return ioctl(device->fd, USBDEVFS_CLAIMINTERFACE, &interface);
 }

 int usb_device_release_interface(struct usb_device *device, unsigned int interface)
 {
     return ioctl(device->fd, USBDEVFS_RELEASEINTERFACE, &interface);
 }

 int usb_device_connect_kernel_driver(struct usb_device *device,
         unsigned int interface, int connect)
 {
     struct usbdevfs_ioctl ctl;

     ctl.ifno = interface;
     ctl.ioctl_code = (connect ? USBDEVFS_CONNECT : USBDEVFS_DISCONNECT);
     ctl.data = NULL;
     return ioctl(device->fd, USBDEVFS_IOCTL, &ctl);
 }

 int usb_device_control_transfer(struct usb_device *device,
                             int requestType,
                             int request,
                             int value,
                             int index,
                             void* buffer,
                             int length,
                             unsigned int timeout)
 {
     struct usbdevfs_ctrltransfer  ctrl;

     // this usually requires read/write permission
     if (!usb_device_reopen_writeable(device))
         return -1;

     memset(&ctrl, 0, sizeof(ctrl));
     ctrl.bRequestType = requestType;
     ctrl.bRequest = request;
     ctrl.wValue = value;
     ctrl.wIndex = index;
     ctrl.wLength = length;
     ctrl.data = buffer;
     ctrl.timeout = timeout;
     return ioctl(device->fd, USBDEVFS_CONTROL, &ctrl);
 }

 int usb_device_bulk_transfer(struct usb_device *device,
                             int endpoint,
                             void* buffer,
                             int length,
                             unsigned int timeout)
 {
     struct usbdevfs_bulktransfer  ctrl;

     // need to limit request size to avoid EINVAL
     if (length > MAX_USBFS_BUFFER_SIZE)
         length = MAX_USBFS_BUFFER_SIZE;

     memset(&ctrl, 0, sizeof(ctrl));
     ctrl.ep = endpoint;
     ctrl.len = length;
     ctrl.data = buffer;
     ctrl.timeout = timeout;
     return ioctl(device->fd, USBDEVFS_BULK, &ctrl);
 }

 struct usb_request *usb_request_new(struct usb_device *dev,
         const struct usb_endpoint_descriptor *ep_desc)
 {
     struct usbdevfs_urb *urb = calloc(1, sizeof(struct usbdevfs_urb));
     if (!urb)
         return NULL;

     if ((ep_desc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_BULK)
         urb->type = USBDEVFS_URB_TYPE_BULK;
     else if ((ep_desc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT)
         urb->type = USBDEVFS_URB_TYPE_INTERRUPT;
     else {
         D("Unsupported endpoint type %d", ep_desc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK);
         free(urb);
         return NULL;
     }
     urb->endpoint = ep_desc->bEndpointAddress;

     struct usb_request *req = calloc(1, sizeof(struct usb_request));
     if (!req) {
         free(urb);
         return NULL;
     }

     req->dev = dev;
     req->max_packet_size = __le16_to_cpu(ep_desc->wMaxPacketSize);
     req->private_data = urb;
     req->endpoint = urb->endpoint;
     urb->usercontext = req;

     return req;
 }

 void usb_request_free(struct usb_request *req)
 {
     free(req->private_data);
     free(req);
 }

 int usb_request_queue(struct usb_request *req)
 {
     struct usbdevfs_urb *urb = (struct usbdevfs_urb*)req->private_data;
     int res;

     urb->status = -1;
     urb->buffer = req->buffer;
     // need to limit request size to avoid EINVAL
     if (req->buffer_length > MAX_USBFS_BUFFER_SIZE)
         urb->buffer_length = MAX_USBFS_BUFFER_SIZE;
     else
         urb->buffer_length = req->buffer_length;

     do {
         res = ioctl(req->dev->fd, USBDEVFS_SUBMITURB, urb);
     } while((res < 0) && (errno == EINTR));

     return res;
 }

 struct usb_request *usb_request_wait(struct usb_device *dev)
 {
     struct usbdevfs_urb *urb = NULL;
     struct usb_request *req = NULL;
     int res;

     while (1) {
         int res = ioctl(dev->fd, USBDEVFS_REAPURB, &urb);
         D("USBDEVFS_REAPURB returned %d\n", res);
         if (res < 0) {
             if(errno == EINTR) {
                 continue;
             }
             D("[ reap urb - error ]\n");
             return NULL;
         } else {
             D("[ urb @%p status = %d, actual = %d ]\n",
                 urb, urb->status, urb->actual_length);
             req = (struct usb_request*)urb->usercontext;
             req->actual_length = urb->actual_length;
         }
         break;
     }
     return req;
 }

 int usb_request_cancel(struct usb_request *req)
 {
     struct usbdevfs_urb *urb = ((struct usbdevfs_urb*)req->private_data);
     return ioctl(req->dev->fd, USBDEVFS_DISCARDURB, &urb);
 }
	/*
	* Copyright (C) 2010 The Android Open Source Project
	*
	* Licensed under the Apache License, Version 2.0 (the "License");
	* you may not use this file except in compliance with the License.
	* You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License.
	*/

	// #define DEBUG 1
	#if DEBUG

	#ifdef USE_LIBLOG
	#define LOG_TAG "usbhost"
	#include "utils/Log.h"
	#define D LOGD
	#else
	#define D printf
	#endif

	#else
	#define D(...)
	#endif

	#include <stdio.h>
	#include <stdlib.h>
	#include <unistd.h>
	#include <string.h>

	#include <sys/ioctl.h>
	#include <sys/types.h>
	#include <sys/time.h>
	#include <sys/inotify.h>
	#include <dirent.h>
	#include <fcntl.h>
	#include <errno.h>
	#include <ctype.h>
	#include <pthread.h>

	#include <linux/usbdevice_fs.h>
	#include <asm/byteorder.h>

	#include "usbhost/usbhost.h"

	#define USB_FS_DIR "/dev/bus/usb"
	#define USB_FS_ID_SCANNER "/dev/bus/usb/%d/%d"
	#define USB_FS_ID_FORMAT "/dev/bus/usb/%03d/%03d"

	// From drivers/usb/core/devio.c
	// I don't know why this isn't in a kernel header
	#define MAX_USBFS_BUFFER_SIZE 16384

	struct usb_host_context {
	int fd;
	};

	struct usb_device {
	char dev_name[64];
	unsigned char desc[4096];
	int desc_length;
	int fd;
	int writeable;
	};

	static inline int badname(const char *name)
	{
	while(*name) {
	if(!isdigit(*name++)) return 1;
	}
	return 0;
	}

	/* returns true if one of the callbacks indicates we are done */
	static int find_existing_devices(usb_device_added_cb added_cb,
	usb_device_removed_cb removed_cb,
	void *client_data)
	{
	char busname[32], devname[32];
	DIR busdir , devdir ;
	struct dirent *de;
	int done = 0;

	busdir = opendir(USB_FS_DIR);
	if(busdir == 0) return 1;

	while ((de = readdir(busdir)) != 0 && !done) {
	if(badname(de->d_name)) continue;

	snprintf(busname, sizeof busname, "%s/%s", USB_FS_DIR, de->d_name);
	devdir = opendir(busname);
	if(devdir == 0) continue;

	while ((de = readdir(devdir)) && !done) {
	if(badname(de->d_name)) continue;

	snprintf(devname, sizeof devname, "%s/%s", busname, de->d_name);
	done = added_cb(devname, client_data);
	} // end of devdir while
	closedir(devdir);
	} //end of busdir while
	closedir(busdir);

	return done;
	}

	struct usb_host_context *usb_host_init()
	{
	struct usb_host_context *context = calloc(1, sizeof(struct usb_host_context));
	if (!context) {
	fprintf(stderr, "out of memory in usb_host_context\n");
	return NULL;
	}
	context->fd = inotify_init();
	if (context->fd < 0) {
	fprintf(stderr, "inotify_init failed\n");
	free(context);
	return NULL;
	}
	return context;
	}

	void usb_host_cleanup(struct usb_host_context *context)
	{
	close(context->fd);
	free(context);
	}

	void usb_host_run(struct usb_host_context *context,
	usb_device_added_cb added_cb,
	usb_device_removed_cb removed_cb,
	usb_discovery_done_cb discovery_done_cb,
	void *client_data)
	{
	struct inotify_event* event;
	char event_buf[512];
	char path[100];
	int i, ret, done = 0;
	int wd, wds[10];
	int wd_count = sizeof(wds) / sizeof(wds[0]);

	D("Created device discovery thread\n");

	/* watch for files added and deleted within USB_FS_DIR */
	memset(wds, 0, sizeof(wds));
	/* watch the root for new subdirectories */
	wds[0] = inotify_add_watch(context->fd, USB_FS_DIR, IN_CREATE \| IN_DELETE);
	if (wds[0] < 0) {
	fprintf(stderr, "inotify_add_watch failed\n");
	if (discovery_done_cb)
	discovery_done_cb(client_data);
	return;
	}

	/* watch existing subdirectories of USB_FS_DIR */
	for (i = 1; i < wd_count; i++) {
	snprintf(path, sizeof(path), "%s/%03d", USB_FS_DIR, i);
	ret = inotify_add_watch(context->fd, path, IN_CREATE \| IN_DELETE);
	if (ret > 0)
	wds[i] = ret;
	}

	/* check for existing devices first, after we have inotify set up */
	done = find_existing_devices(added_cb, removed_cb, client_data);
	if (discovery_done_cb)
	done \|= discovery_done_cb(client_data);

	while (!done) {
	ret = read(context->fd, event_buf, sizeof(event_buf));
	if (ret >= (int)sizeof(struct inotify_event)) {
	event = (struct inotify_event *)event_buf;
	wd = event->wd;
	if (wd == wds[0]) {
	i = atoi(event->name);
	snprintf(path, sizeof(path), "%s/%s", USB_FS_DIR, event->name);
	D("new subdirectory %s: index: %d\n", path, i);
	if (i > 0 && i < wd_count) {
	ret = inotify_add_watch(context->fd, path, IN_CREATE \| IN_DELETE);
	if (ret > 0)
	wds[i] = ret;
	}
	} else {
	for (i = 1; i < wd_count && !done; i++) {
	if (wd == wds[i]) {
	snprintf(path, sizeof(path), "%s/%03d/%s", USB_FS_DIR, i, event->name);
	if (event->mask == IN_CREATE) {
	D("new device %s\n", path);
	done = added_cb(path, client_data);
	} else if (event->mask == IN_DELETE) {
	D("gone device %s\n", path);
	done = removed_cb(path, client_data);
	}
	}
	}
	}
	}
	}
	}

	struct usb_device usb_device_open(const char dev_name)
	{
	int fd, did_retry = 0, writeable = 1;

	D("usb_device_open %s\n", dev_name);

	retry:
	fd = open(dev_name, O_RDWR);
	if (fd < 0) {
	/* if we fail, see if have read-only access */
	fd = open(dev_name, O_RDONLY);
	D("usb_device_open open returned %d errno %d\n", fd, errno);
	if (fd < 0 && (errno == EACCES \|\| errno == ENOENT) && !did_retry) {
	/* work around race condition between inotify and permissions management */
	sleep(1);
	did_retry = 1;
	goto retry;
	}

	if (fd < 0)
	return NULL;
	writeable = 0;
	D("[ usb open read-only %s fd = %d]\n", dev_name, fd);
	}

	struct usb_device* result = usb_device_new(dev_name, fd);
	if (result)
	result->writeable = writeable;
	return result;
	}

	void usb_device_close(struct usb_device *device)
	{
	close(device->fd);
	free(device);
	}

	struct usb_device usb_device_new(const char dev_name, int fd)
	{
	struct usb_device *device = calloc(1, sizeof(struct usb_device));
	int length;

	D("usb_device_new %s fd: %d\n", dev_name, fd);

	if (lseek(fd, 0, SEEK_SET) != 0)
	goto failed;
	length = read(fd, device->desc, sizeof(device->desc));
	D("usb_device_new read returned %d errno %d\n", length, errno);
	if (length < 0)
	goto failed;

	strncpy(device->dev_name, dev_name, sizeof(device->dev_name) - 1);
	device->fd = fd;
	device->desc_length = length;
	// assume we are writeable, since usb_device_get_fd will only return writeable fds
	device->writeable = 1;
	return device;

	failed:
	close(fd);
	free(device);
	return NULL;
	}

	static int usb_device_reopen_writeable(struct usb_device *device)
	{
	if (device->writeable)
	return 1;

	int fd = open(device->dev_name, O_RDWR);
	if (fd >= 0) {
	close(device->fd);
	device->fd = fd;
	device->writeable = 1;
	return 1;
	}
	D("usb_device_reopen_writeable failed errno %d\n", errno);
	return 0;
	}

	int usb_device_get_fd(struct usb_device *device)
	{
	if (!usb_device_reopen_writeable(device))
	return -1;
	return device->fd;
	}

	const char* usb_device_get_name(struct usb_device *device)
	{
	return device->dev_name;
	}

	int usb_device_get_unique_id(struct usb_device *device)
	{
	int bus = 0, dev = 0;
	sscanf(device->dev_name, USB_FS_ID_SCANNER, &bus, &dev);
	return bus * 1000 + dev;
	}

	int usb_device_get_unique_id_from_name(const char* name)
	{
	int bus = 0, dev = 0;
	sscanf(name, USB_FS_ID_SCANNER, &bus, &dev);
	return bus * 1000 + dev;
	}

	char* usb_device_get_name_from_unique_id(int id)
	{
	int bus = id / 1000;
	int dev = id % 1000;
	char* result = (char *)calloc(1, strlen(USB_FS_ID_FORMAT));
	snprintf(result, strlen(USB_FS_ID_FORMAT) - 1, USB_FS_ID_FORMAT, bus, dev);
	return result;
	}

	uint16_t usb_device_get_vendor_id(struct usb_device *device)
	{
	struct usb_device_descriptor* desc = (struct usb_device_descriptor*)device->desc;
	return __le16_to_cpu(desc->idVendor);
	}

	uint16_t usb_device_get_product_id(struct usb_device *device)
	{
	struct usb_device_descriptor* desc = (struct usb_device_descriptor*)device->desc;
	return __le16_to_cpu(desc->idProduct);
	}

	const struct usb_device_descriptor* usb_device_get_device_descriptor(struct usb_device *device)
	{
	return (struct usb_device_descriptor*)device->desc;
	}

	char* usb_device_get_string(struct usb_device *device, int id)
	{
	char string[256];
	__u16 buffer[128];
	__u16 languages[128];
	int i, result;
	int languageCount = 0;

	string[0] = 0;
	memset(languages, 0, sizeof(languages));

	// read list of supported languages
	result = usb_device_control_transfer(device,
	USB_DIR_IN\|USB_TYPE_STANDARD\|USB_RECIP_DEVICE, USB_REQ_GET_DESCRIPTOR,
	(USB_DT_STRING << 8) \| 0, 0, languages, sizeof(languages), 0);
	if (result > 0)
	languageCount = (result - 2) / 2;

	for (i = 1; i <= languageCount; i++) {
	memset(buffer, 0, sizeof(buffer));

	result = usb_device_control_transfer(device,
	USB_DIR_IN\|USB_TYPE_STANDARD\|USB_RECIP_DEVICE, USB_REQ_GET_DESCRIPTOR,
	(USB_DT_STRING << 8) \| id, languages[i], buffer, sizeof(buffer), 0);
	if (result > 0) {
	int i;
	// skip first word, and copy the rest to the string, changing shorts to bytes.
	result /= 2;
	for (i = 1; i < result; i++)
	string[i - 1] = buffer[i];
	string[i - 1] = 0;
	return strdup(string);
	}
	}

	return NULL;
	}

	char* usb_device_get_manufacturer_name(struct usb_device *device)
	{
	struct usb_device_descriptor desc = (struct usb_device_descriptor )device->desc;

	if (desc->iManufacturer)
	return usb_device_get_string(device, desc->iManufacturer);
	else
	return NULL;
	}

	char* usb_device_get_product_name(struct usb_device *device)
	{
	struct usb_device_descriptor desc = (struct usb_device_descriptor )device->desc;

	if (desc->iProduct)
	return usb_device_get_string(device, desc->iProduct);
	else
	return NULL;
	}

	char* usb_device_get_serial(struct usb_device *device)
	{
	struct usb_device_descriptor desc = (struct usb_device_descriptor )device->desc;

	if (desc->iSerialNumber)
	return usb_device_get_string(device, desc->iSerialNumber);
	else
	return NULL;
	}

	int usb_device_is_writeable(struct usb_device *device)
	{
	return device->writeable;
	}

	void usb_descriptor_iter_init(struct usb_device device, struct usb_descriptor_iter iter)
	{
	iter->config = device->desc;
	iter->config_end = device->desc + device->desc_length;
	iter->curr_desc = device->desc;
	}

	struct usb_descriptor_header usb_descriptor_iter_next(struct usb_descriptor_iter iter)
	{
	struct usb_descriptor_header* next;
	if (iter->curr_desc >= iter->config_end)
	return NULL;
	next = (struct usb_descriptor_header*)iter->curr_desc;
	iter->curr_desc += next->bLength;
	return next;
	}

	int usb_device_claim_interface(struct usb_device *device, unsigned int interface)
	{
	return ioctl(device->fd, USBDEVFS_CLAIMINTERFACE, &interface);
	}

	int usb_device_release_interface(struct usb_device *device, unsigned int interface)
	{
	return ioctl(device->fd, USBDEVFS_RELEASEINTERFACE, &interface);
	}

	int usb_device_connect_kernel_driver(struct usb_device *device,
	unsigned int interface, int connect)
	{
	struct usbdevfs_ioctl ctl;

	ctl.ifno = interface;
	ctl.ioctl_code = (connect ? USBDEVFS_CONNECT : USBDEVFS_DISCONNECT);
	ctl.data = NULL;
	return ioctl(device->fd, USBDEVFS_IOCTL, &ctl);
	}

	int usb_device_control_transfer(struct usb_device *device,
	int requestType,
	int request,
	int value,
	int index,
	void* buffer,
	int length,
	unsigned int timeout)
	{
	struct usbdevfs_ctrltransfer ctrl;

	// this usually requires read/write permission
	if (!usb_device_reopen_writeable(device))
	return -1;

	memset(&ctrl, 0, sizeof(ctrl));
	ctrl.bRequestType = requestType;
	ctrl.bRequest = request;
	ctrl.wValue = value;
	ctrl.wIndex = index;
	ctrl.wLength = length;
	ctrl.data = buffer;
	ctrl.timeout = timeout;
	return ioctl(device->fd, USBDEVFS_CONTROL, &ctrl);
	}

	int usb_device_bulk_transfer(struct usb_device *device,
	int endpoint,
	void* buffer,
	int length,
	unsigned int timeout)
	{
	struct usbdevfs_bulktransfer ctrl;

	// need to limit request size to avoid EINVAL
	if (length > MAX_USBFS_BUFFER_SIZE)
	length = MAX_USBFS_BUFFER_SIZE;

	memset(&ctrl, 0, sizeof(ctrl));
	ctrl.ep = endpoint;
	ctrl.len = length;
	ctrl.data = buffer;
	ctrl.timeout = timeout;
	return ioctl(device->fd, USBDEVFS_BULK, &ctrl);
	}

	struct usb_request usb_request_new(struct usb_device dev,
	const struct usb_endpoint_descriptor *ep_desc)
	{
	struct usbdevfs_urb *urb = calloc(1, sizeof(struct usbdevfs_urb));
	if (!urb)
	return NULL;

	if ((ep_desc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_BULK)
	urb->type = USBDEVFS_URB_TYPE_BULK;
	else if ((ep_desc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT)
	urb->type = USBDEVFS_URB_TYPE_INTERRUPT;
	else {
	D("Unsupported endpoint type %d", ep_desc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK);
	free(urb);
	return NULL;
	}
	urb->endpoint = ep_desc->bEndpointAddress;

	struct usb_request *req = calloc(1, sizeof(struct usb_request));
	if (!req) {
	free(urb);
	return NULL;
	}

	req->dev = dev;
	req->max_packet_size = __le16_to_cpu(ep_desc->wMaxPacketSize);
	req->private_data = urb;
	req->endpoint = urb->endpoint;
	urb->usercontext = req;

	return req;
	}

	void usb_request_free(struct usb_request *req)
	{
	free(req->private_data);
	free(req);
	}

	int usb_request_queue(struct usb_request *req)
	{
	struct usbdevfs_urb urb = (struct usbdevfs_urb)req->private_data;
	int res;

	urb->status = -1;
	urb->buffer = req->buffer;
	// need to limit request size to avoid EINVAL
	if (req->buffer_length > MAX_USBFS_BUFFER_SIZE)
	urb->buffer_length = MAX_USBFS_BUFFER_SIZE;
	else
	urb->buffer_length = req->buffer_length;

	do {
	res = ioctl(req->dev->fd, USBDEVFS_SUBMITURB, urb);
	} while((res < 0) && (errno == EINTR));

	return res;
	}

	struct usb_request usb_request_wait(struct usb_device dev)
	{
	struct usbdevfs_urb *urb = NULL;
	struct usb_request *req = NULL;
	int res;

	while (1) {
	int res = ioctl(dev->fd, USBDEVFS_REAPURB, &urb);
	D("USBDEVFS_REAPURB returned %d\n", res);
	if (res < 0) {
	if(errno == EINTR) {
	continue;
	}
	D("[ reap urb - error ]\n");
	return NULL;
	} else {
	D("[ urb @%p status = %d, actual = %d ]\n",
	urb, urb->status, urb->actual_length);
	req = (struct usb_request*)urb->usercontext;
	req->actual_length = urb->actual_length;
	}
	break;
	}
	return req;
	}

	int usb_request_cancel(struct usb_request *req)
	{
	struct usbdevfs_urb urb = ((struct usbdevfs_urb)req->private_data);
	return ioctl(req->dev->fd, USBDEVFS_DISCARDURB, &urb);
	}