usbhost.h revision 203f102028c4df33c191d8cd610775eba8d5366d
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, void *client_data); 36 37/* callback for notification when USB devices are removed */ 38typedef void (* usb_device_removed_cb)(const char *dev_name, void *client_data); 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, 46 usb_device_removed_cb removed_cb, 47 void *client_data); 48 49/* Creates a usb_device object for a USB device */ 50struct usb_device *usb_device_open(const char *dev_name); 51 52/* Releases all resources associated with the USB device */ 53void usb_device_close(struct usb_device *device); 54 55/* Returns the name for the USB device, which is the same as 56 * the dev_name passed to usb_device_open() 57 */ 58const char* usb_device_get_name(struct usb_device *device); 59 60/* Returns a unique ID for the device. Currently this is generated from the 61 * dev_name path. 62 */ 63int usb_device_get_unique_id(struct usb_device *device); 64 65/* Returns the USB vendor ID from the device descriptor for the USB device */ 66uint16_t usb_device_get_vendor_id(struct usb_device *device); 67 68/* Returns the USB product ID from the device descriptor for the USB device */ 69uint16_t usb_device_get_product_id(struct usb_device *device); 70 71/* Returns a USB descriptor string for the given string ID. 72 * Used to implement usb_device_get_manufacturer_name, 73 * usb_device_get_product_name and usb_device_get_serial. 74 * Call free() to free the result when you are done with it. 75 */ 76char* usb_device_get_string(struct usb_device *device, int id); 77 78/* Returns the manufacturer name for the USB device. 79 * Call free() to free the result when you are done with it. 80 */ 81char* usb_device_get_manufacturer_name(struct usb_device *device); 82 83/* Returns the product name for the USB device. 84 * Call free() to free the result when you are done with it. 85 */ 86char* usb_device_get_product_name(struct usb_device *device); 87 88/* Returns the USB serial number for the USB device. 89 * Call free() to free the result when you are done with it. 90 */ 91char* usb_device_get_serial(struct usb_device *device); 92 93/* Returns true if we have write access to the USB device, 94 * and false if we only have access to the USB device configuration. 95 */ 96int usb_device_is_writeable(struct usb_device *device); 97 98/* Initializes a usb_descriptor_iter, which can be used to iterate through all 99 * the USB descriptors for a USB device. 100 */ 101void usb_descriptor_iter_init(struct usb_device *device, struct usb_descriptor_iter *iter); 102 103/* Returns the next USB descriptor for a device, or NULL if we have reached the 104 * end of the list. 105 */ 106struct usb_descriptor_header *usb_descriptor_iter_next(struct usb_descriptor_iter *iter); 107 108/* Claims the specified interface of a USB device */ 109int usb_device_claim_interface(struct usb_device *device, unsigned int interface); 110 111/* Releases the specified interface of a USB device */ 112int usb_device_release_interface(struct usb_device *device, unsigned int interface); 113 114 115/* Creates a new usb_endpoint for the specified endpoint of a USB device. 116 * This can be used to read or write data across the endpoint. 117 */ 118struct usb_endpoint *usb_endpoint_open(struct usb_device *dev, 119 const struct usb_endpoint_descriptor *desc); 120 121/* Releases all resources associated with the endpoint */ 122void usb_endpoint_close(struct usb_endpoint *ep); 123 124/* Begins a read or write operation on the specified endpoint */ 125int usb_endpoint_queue(struct usb_endpoint *ep, void *data, int len); 126 127 /* Waits for the results of a previous usb_endpoint_queue operation on the 128 * specified endpoint. Returns number of bytes transferred, or a negative 129 * value for error. 130 */ 131int usb_endpoint_wait(struct usb_device *device, int *out_ep_num); 132 133/* Cancels a pending usb_endpoint_queue() operation on an endpoint. */ 134int usb_endpoint_cancel(struct usb_endpoint *ep); 135 136/* Returns the usb_device for the given endpoint */ 137struct usb_device *usb_endpoint_get_device(struct usb_endpoint *ep); 138 139/* Returns the endpoint address for the given endpoint */ 140int usb_endpoint_number(struct usb_endpoint *ep); 141 142/* Returns the maximum packet size for the given endpoint. 143 * For bulk endpoints this should be 512 for highspeed or 64 for fullspeed. 144 */ 145int usb_endpoint_max_packet(struct usb_endpoint *ep); 146 147#ifdef __cplusplus 148} 149#endif 150#endif /* __USB_HOST_H */ 151