usbhost.h revision be1def8d43d75e280cdd75d432ddcadeaff580b1
130ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* 230ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * Copyright (C) 2010 The Android Open Source Project 330ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * 430ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * Licensed under the Apache License, Version 2.0 (the "License"); 530ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * you may not use this file except in compliance with the License. 630ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * You may obtain a copy of the License at 730ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * 830ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * http://www.apache.org/licenses/LICENSE-2.0 930ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * 1030ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * Unless required by applicable law or agreed to in writing, software 1130ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * distributed under the License is distributed on an "AS IS" BASIS, 1230ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1330ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * See the License for the specific language governing permissions and 1430ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * limitations under the License. 1530ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood */ 1630ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 1730ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood#ifndef __USB_HOST_H 1830ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood#define __USB_HOST_H 1930ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 2030ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood#ifdef __cplusplus 2130ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodextern "C" { 2230ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood#endif 2330ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 2430ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood#include <stdint.h> 2530ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 263af05b09eb116e48997a2d4611b0a1e033737d2eErik Gilling#include <linux/version.h> 273af05b09eb116e48997a2d4611b0a1e033737d2eErik Gilling#if LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 20) 283af05b09eb116e48997a2d4611b0a1e033737d2eErik Gilling#include <linux/usb/ch9.h> 293af05b09eb116e48997a2d4611b0a1e033737d2eErik Gilling#else 303af05b09eb116e48997a2d4611b0a1e033737d2eErik Gilling#include <linux/usb_ch9.h> 313af05b09eb116e48997a2d4611b0a1e033737d2eErik Gilling#endif 323af05b09eb116e48997a2d4611b0a1e033737d2eErik Gilling 337a96ba436c9a2bacc64e712bdb53bd7accc5c3a9Mike Lockwoodstruct usb_host_context; 3430ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodstruct usb_endpoint_descriptor; 3530ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 3630ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodstruct usb_descriptor_iter { 3730ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood unsigned char* config; 3830ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood unsigned char* config_end; 3930ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood unsigned char* curr_desc; 4030ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood}; 4130ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 42e533c5f1005e8913f577d2aeac5a26f88f55a249Mike Lockwoodstruct usb_request 43e533c5f1005e8913f577d2aeac5a26f88f55a249Mike Lockwood{ 44e533c5f1005e8913f577d2aeac5a26f88f55a249Mike Lockwood struct usb_device *dev; 45e533c5f1005e8913f577d2aeac5a26f88f55a249Mike Lockwood void* buffer; 46e533c5f1005e8913f577d2aeac5a26f88f55a249Mike Lockwood int buffer_length; 47e533c5f1005e8913f577d2aeac5a26f88f55a249Mike Lockwood int actual_length; 48e533c5f1005e8913f577d2aeac5a26f88f55a249Mike Lockwood int max_packet_size; 49e533c5f1005e8913f577d2aeac5a26f88f55a249Mike Lockwood void *private_data; /* struct usbdevfs_urb* */ 50e533c5f1005e8913f577d2aeac5a26f88f55a249Mike Lockwood void *client_data; /* free for use by client */ 51e533c5f1005e8913f577d2aeac5a26f88f55a249Mike Lockwood}; 52e533c5f1005e8913f577d2aeac5a26f88f55a249Mike Lockwood 537a96ba436c9a2bacc64e712bdb53bd7accc5c3a9Mike Lockwood/* Callback for notification when new USB devices are attached. 547a96ba436c9a2bacc64e712bdb53bd7accc5c3a9Mike Lockwood * Return true to exit from usb_host_run. 557a96ba436c9a2bacc64e712bdb53bd7accc5c3a9Mike Lockwood */ 567a96ba436c9a2bacc64e712bdb53bd7accc5c3a9Mike Lockwoodtypedef int (* usb_device_added_cb)(const char *dev_name, void *client_data); 577a96ba436c9a2bacc64e712bdb53bd7accc5c3a9Mike Lockwood 587a96ba436c9a2bacc64e712bdb53bd7accc5c3a9Mike Lockwood/* Callback for notification when USB devices are removed. 597a96ba436c9a2bacc64e712bdb53bd7accc5c3a9Mike Lockwood * Return true to exit from usb_host_run. 607a96ba436c9a2bacc64e712bdb53bd7accc5c3a9Mike Lockwood */ 617a96ba436c9a2bacc64e712bdb53bd7accc5c3a9Mike Lockwoodtypedef int (* usb_device_removed_cb)(const char *dev_name, void *client_data); 627a96ba436c9a2bacc64e712bdb53bd7accc5c3a9Mike Lockwood 63a805519ceedc53afa5453a6d8a7d80038d885d9fMike Lockwood/* Callback indicating that initial device discovery is done. 64a805519ceedc53afa5453a6d8a7d80038d885d9fMike Lockwood * Return true to exit from usb_host_run. 65a805519ceedc53afa5453a6d8a7d80038d885d9fMike Lockwood */ 66a805519ceedc53afa5453a6d8a7d80038d885d9fMike Lockwoodtypedef int (* usb_discovery_done_cb)(void *client_data); 67a805519ceedc53afa5453a6d8a7d80038d885d9fMike Lockwood 687a96ba436c9a2bacc64e712bdb53bd7accc5c3a9Mike Lockwood/* Call this to initialize the USB host library. */ 697a96ba436c9a2bacc64e712bdb53bd7accc5c3a9Mike Lockwoodstruct usb_host_context *usb_host_init(void); 7030ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 717a96ba436c9a2bacc64e712bdb53bd7accc5c3a9Mike Lockwood/* Call this to cleanup the USB host library. */ 727a96ba436c9a2bacc64e712bdb53bd7accc5c3a9Mike Lockwoodvoid usb_host_cleanup(struct usb_host_context *context); 7330ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 747a96ba436c9a2bacc64e712bdb53bd7accc5c3a9Mike Lockwood/* Call this to monitor the USB bus for new and removed devices. 757a96ba436c9a2bacc64e712bdb53bd7accc5c3a9Mike Lockwood * This is intended to be called from a dedicated thread, 767a96ba436c9a2bacc64e712bdb53bd7accc5c3a9Mike Lockwood * as it will not return until one of the callbacks returns true. 7730ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * added_cb will be called immediately for each existing USB device, 7830ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * and subsequently each time a new device is added. 7930ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * removed_cb is called when USB devices are removed from the bus. 80a805519ceedc53afa5453a6d8a7d80038d885d9fMike Lockwood * discovery_done_cb is called after the initial discovery of already 81a805519ceedc53afa5453a6d8a7d80038d885d9fMike Lockwood * connected devices is complete. 8230ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood */ 837a96ba436c9a2bacc64e712bdb53bd7accc5c3a9Mike Lockwoodvoid usb_host_run(struct usb_host_context *context, 847a96ba436c9a2bacc64e712bdb53bd7accc5c3a9Mike Lockwood usb_device_added_cb added_cb, 856ac3aa157493ef24bc837b679dd8292fad8961e0Mike Lockwood usb_device_removed_cb removed_cb, 86a805519ceedc53afa5453a6d8a7d80038d885d9fMike Lockwood usb_discovery_done_cb discovery_done_cb, 876ac3aa157493ef24bc837b679dd8292fad8961e0Mike Lockwood void *client_data); 8830ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 8930ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Creates a usb_device object for a USB device */ 9030ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodstruct usb_device *usb_device_open(const char *dev_name); 9130ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 9230ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Releases all resources associated with the USB device */ 9330ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodvoid usb_device_close(struct usb_device *device); 9430ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 95be1def8d43d75e280cdd75d432ddcadeaff580b1Mike Lockwood/* Creates a usb_device object for already open USB device */ 96cd185f23cc6f062b252d1d19bca55e721290ee62Mike Lockwoodstruct usb_device *usb_device_new(const char *dev_name, int fd); 97cd185f23cc6f062b252d1d19bca55e721290ee62Mike Lockwood 98be1def8d43d75e280cdd75d432ddcadeaff580b1Mike Lockwood/* Returns the file descriptor for the usb_device */ 99cd185f23cc6f062b252d1d19bca55e721290ee62Mike Lockwoodint usb_device_get_fd(struct usb_device *device); 100cd185f23cc6f062b252d1d19bca55e721290ee62Mike Lockwood 10130ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Returns the name for the USB device, which is the same as 10230ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * the dev_name passed to usb_device_open() 10330ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood */ 10430ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodconst char* usb_device_get_name(struct usb_device *device); 10530ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 1067d700f8bdce747a26e3ee4737683194d77286ba3Mike Lockwood/* Returns a unique ID for the device. 1077d700f8bdce747a26e3ee4737683194d77286ba3Mike Lockwood *Currently this is generated from the dev_name path. 108203f102028c4df33c191d8cd610775eba8d5366dMike Lockwood */ 109203f102028c4df33c191d8cd610775eba8d5366dMike Lockwoodint usb_device_get_unique_id(struct usb_device *device); 110203f102028c4df33c191d8cd610775eba8d5366dMike Lockwood 1117d700f8bdce747a26e3ee4737683194d77286ba3Mike Lockwood/* Returns a unique ID for the device name. 1127d700f8bdce747a26e3ee4737683194d77286ba3Mike Lockwood * Currently this is generated from the device path. 1137d700f8bdce747a26e3ee4737683194d77286ba3Mike Lockwood */ 11407eb4af174f31c449a86dd459e2c81702f74acf1Mike Lockwoodint usb_device_get_unique_id_from_name(const char* name); 11507eb4af174f31c449a86dd459e2c81702f74acf1Mike Lockwood 1167d700f8bdce747a26e3ee4737683194d77286ba3Mike Lockwood/* Returns the device name for the unique ID. 1177d700f8bdce747a26e3ee4737683194d77286ba3Mike Lockwood * Call free() to deallocate the returned string */ 1187d700f8bdce747a26e3ee4737683194d77286ba3Mike Lockwoodchar* usb_device_get_name_from_unique_id(int id); 1197d700f8bdce747a26e3ee4737683194d77286ba3Mike Lockwood 12030ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Returns the USB vendor ID from the device descriptor for the USB device */ 12130ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwooduint16_t usb_device_get_vendor_id(struct usb_device *device); 12230ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 12330ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Returns the USB product ID from the device descriptor for the USB device */ 12430ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwooduint16_t usb_device_get_product_id(struct usb_device *device); 12530ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 12650372073d2919480fb32d56cb3b91663b9fca0f1Mike Lockwoodconst struct usb_device_descriptor* usb_device_get_device_descriptor(struct usb_device *device); 12750372073d2919480fb32d56cb3b91663b9fca0f1Mike Lockwood 1281b7d991b433cf6d6fae4f40cb37f9b6c6043cfbcMike Lockwood/* Sends a control message to the specified device on endpoint zero */ 1291b7d991b433cf6d6fae4f40cb37f9b6c6043cfbcMike Lockwoodint usb_device_send_control(struct usb_device *device, 1301b7d991b433cf6d6fae4f40cb37f9b6c6043cfbcMike Lockwood int requestType, 1311b7d991b433cf6d6fae4f40cb37f9b6c6043cfbcMike Lockwood int request, 1321b7d991b433cf6d6fae4f40cb37f9b6c6043cfbcMike Lockwood int value, 1331b7d991b433cf6d6fae4f40cb37f9b6c6043cfbcMike Lockwood int index, 1341b7d991b433cf6d6fae4f40cb37f9b6c6043cfbcMike Lockwood int length, 1351b7d991b433cf6d6fae4f40cb37f9b6c6043cfbcMike Lockwood void* buffer); 1361b7d991b433cf6d6fae4f40cb37f9b6c6043cfbcMike Lockwood 13730ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Returns a USB descriptor string for the given string ID. 13830ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * Used to implement usb_device_get_manufacturer_name, 13930ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * usb_device_get_product_name and usb_device_get_serial. 14030ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * Call free() to free the result when you are done with it. 14130ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood */ 14230ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodchar* usb_device_get_string(struct usb_device *device, int id); 14330ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 14430ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Returns the manufacturer name for the USB device. 14530ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * Call free() to free the result when you are done with it. 14630ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood */ 14730ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodchar* usb_device_get_manufacturer_name(struct usb_device *device); 14830ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 14930ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Returns the product name for the USB device. 15030ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * Call free() to free the result when you are done with it. 15130ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood */ 15230ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodchar* usb_device_get_product_name(struct usb_device *device); 15330ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 15430ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Returns the USB serial number for the USB device. 15530ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * Call free() to free the result when you are done with it. 15630ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood */ 15730ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodchar* usb_device_get_serial(struct usb_device *device); 15830ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 15930ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Returns true if we have write access to the USB device, 16030ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * and false if we only have access to the USB device configuration. 16130ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood */ 16230ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodint usb_device_is_writeable(struct usb_device *device); 16330ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 16430ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Initializes a usb_descriptor_iter, which can be used to iterate through all 16530ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * the USB descriptors for a USB device. 16630ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood */ 16730ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodvoid usb_descriptor_iter_init(struct usb_device *device, struct usb_descriptor_iter *iter); 16830ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 16930ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Returns the next USB descriptor for a device, or NULL if we have reached the 17030ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * end of the list. 17130ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood */ 17230ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodstruct usb_descriptor_header *usb_descriptor_iter_next(struct usb_descriptor_iter *iter); 17330ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 17430ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Claims the specified interface of a USB device */ 17530ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodint usb_device_claim_interface(struct usb_device *device, unsigned int interface); 17630ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 17730ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Releases the specified interface of a USB device */ 17830ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodint usb_device_release_interface(struct usb_device *device, unsigned int interface); 17930ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 180e533c5f1005e8913f577d2aeac5a26f88f55a249Mike Lockwood/* Creates a new usb_request. */ 181e533c5f1005e8913f577d2aeac5a26f88f55a249Mike Lockwoodstruct usb_request *usb_request_new(struct usb_device *dev, 182e533c5f1005e8913f577d2aeac5a26f88f55a249Mike Lockwood const struct usb_endpoint_descriptor *ep_desc); 18330ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 184e533c5f1005e8913f577d2aeac5a26f88f55a249Mike Lockwood/* Releases all resources associated with the request */ 185e533c5f1005e8913f577d2aeac5a26f88f55a249Mike Lockwoodvoid usb_request_free(struct usb_request *req); 18630ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 187e533c5f1005e8913f577d2aeac5a26f88f55a249Mike Lockwood/* Submits a read or write request on the specified device */ 188e533c5f1005e8913f577d2aeac5a26f88f55a249Mike Lockwoodint usb_request_queue(struct usb_request *req); 18930ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 190e533c5f1005e8913f577d2aeac5a26f88f55a249Mike Lockwood /* Waits for the results of a previous usb_request_queue operation. 191e533c5f1005e8913f577d2aeac5a26f88f55a249Mike Lockwood * Returns a usb_request, or NULL for error. 19230ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood */ 193e533c5f1005e8913f577d2aeac5a26f88f55a249Mike Lockwoodstruct usb_request *usb_request_wait(struct usb_device *dev); 19430ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 195e533c5f1005e8913f577d2aeac5a26f88f55a249Mike Lockwood/* Cancels a pending usb_request_queue() operation. */ 196e533c5f1005e8913f577d2aeac5a26f88f55a249Mike Lockwoodint usb_request_cancel(struct usb_request *req); 19730ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 19830ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood#ifdef __cplusplus 19930ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood} 20030ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood#endif 20130ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood#endif /* __USB_HOST_H */ 202