usbhost.h revision 30ff2c70ce05d761e8cb0ab7ee02b39a681fe0cb
1/* 2 * Copyright (C) 2010 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#ifndef __USB_HOST_H 18#define __USB_HOST_H 19 20#ifdef __cplusplus 21extern "C" { 22#endif 23 24#include <stdint.h> 25 26struct usb_endpoint_descriptor; 27 28struct usb_descriptor_iter { 29 unsigned char* config; 30 unsigned char* config_end; 31 unsigned char* curr_desc; 32}; 33 34/* callback for notification when new USB devices are attached */ 35typedef void (* usb_device_added_cb)(const char *dev_name); 36 37/* callback for notification when USB devices are removed */ 38typedef void (* usb_device_removed_cb)(const char *dev_name); 39 40/* Call this to start monitoring the USB bus. 41 * added_cb will be called immediately for each existing USB device, 42 * and subsequently each time a new device is added. 43 * removed_cb is called when USB devices are removed from the bus. 44 */ 45int usb_host_init(usb_device_added_cb added_cb, usb_device_removed_cb removed_cb); 46 47/* Creates a usb_device object for a USB device */ 48struct usb_device *usb_device_open(const char *dev_name); 49 50/* Releases all resources associated with the USB device */ 51void usb_device_close(struct usb_device *device); 52 53/* Returns the name for the USB device, which is the same as 54 * the dev_name passed to usb_device_open() 55 */ 56const char* usb_device_get_name(struct usb_device *device); 57 58/* Returns the USB vendor ID from the device descriptor for the USB device */ 59uint16_t usb_device_get_vendor_id(struct usb_device *device); 60 61/* Returns the USB product ID from the device descriptor for the USB device */ 62uint16_t usb_device_get_product_id(struct usb_device *device); 63 64/* Returns a USB descriptor string for the given string ID. 65 * Used to implement usb_device_get_manufacturer_name, 66 * usb_device_get_product_name and usb_device_get_serial. 67 * Call free() to free the result when you are done with it. 68 */ 69char* usb_device_get_string(struct usb_device *device, int id); 70 71/* Returns the manufacturer name for the USB device. 72 * Call free() to free the result when you are done with it. 73 */ 74char* usb_device_get_manufacturer_name(struct usb_device *device); 75 76/* Returns the product name for the USB device. 77 * Call free() to free the result when you are done with it. 78 */ 79char* usb_device_get_product_name(struct usb_device *device); 80 81/* Returns the USB serial number for the USB device. 82 * Call free() to free the result when you are done with it. 83 */ 84char* usb_device_get_serial(struct usb_device *device); 85 86/* Returns true if we have write access to the USB device, 87 * and false if we only have access to the USB device configuration. 88 */ 89int usb_device_is_writeable(struct usb_device *device); 90 91/* Initializes a usb_descriptor_iter, which can be used to iterate through all 92 * the USB descriptors for a USB device. 93 */ 94void usb_descriptor_iter_init(struct usb_device *device, struct usb_descriptor_iter *iter); 95 96/* Returns the next USB descriptor for a device, or NULL if we have reached the 97 * end of the list. 98 */ 99struct usb_descriptor_header *usb_descriptor_iter_next(struct usb_descriptor_iter *iter); 100 101/* Claims the specified interface of a USB device */ 102int usb_device_claim_interface(struct usb_device *device, unsigned int interface); 103 104/* Releases the specified interface of a USB device */ 105int usb_device_release_interface(struct usb_device *device, unsigned int interface); 106 107 108/* Creates a new usb_endpoint for the specified endpoint of a USB device. 109 * This can be used to read or write data across the endpoint. 110 */ 111struct usb_endpoint *usb_endpoint_open(struct usb_device *dev, 112 const struct usb_endpoint_descriptor *desc); 113 114/* Releases all resources associated with the endpoint */ 115void usb_endpoint_close(struct usb_endpoint *ep); 116 117/* Begins a read or write operation on the specified endpoint */ 118int usb_endpoint_queue(struct usb_endpoint *ep, void *data, int len); 119 120 /* Waits for the results of a previous usb_endpoint_queue operation on the 121 * specified endpoint. Returns number of bytes transferred, or a negative 122 * value for error. 123 */ 124int usb_endpoint_wait(struct usb_device *device, int *out_ep_num); 125 126/* Cancels a pending usb_endpoint_queue() operation on an endpoint. */ 127int usb_endpoint_cancel(struct usb_endpoint *ep); 128 129/* Returns the endpoint address for the given endpoint */ 130int usb_endpoint_number(struct usb_endpoint *ep); 131 132/* Returns the maximum packet size for the given endpoint. 133 * For bulk endpoints this should be 512 for highspeed or 64 for fullspeed. 134 */ 135int usb_endpoint_max_packet(struct usb_endpoint *ep); 136 137#ifdef __cplusplus 138} 139#endif 140#endif /* __USB_HOST_H */ 141