usbhost.h revision 30ff2c70ce05d761e8cb0ab7ee02b39a681fe0cb
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 2630ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodstruct usb_endpoint_descriptor; 2730ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 2830ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodstruct usb_descriptor_iter { 2930ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood unsigned char* config; 3030ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood unsigned char* config_end; 3130ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood unsigned char* curr_desc; 3230ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood}; 3330ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 3430ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* callback for notification when new USB devices are attached */ 3530ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodtypedef void (* usb_device_added_cb)(const char *dev_name); 3630ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 3730ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* callback for notification when USB devices are removed */ 3830ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodtypedef void (* usb_device_removed_cb)(const char *dev_name); 3930ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 4030ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Call this to start monitoring the USB bus. 4130ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * added_cb will be called immediately for each existing USB device, 4230ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * and subsequently each time a new device is added. 4330ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * removed_cb is called when USB devices are removed from the bus. 4430ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood */ 4530ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodint usb_host_init(usb_device_added_cb added_cb, usb_device_removed_cb removed_cb); 4630ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 4730ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Creates a usb_device object for a USB device */ 4830ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodstruct usb_device *usb_device_open(const char *dev_name); 4930ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 5030ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Releases all resources associated with the USB device */ 5130ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodvoid usb_device_close(struct usb_device *device); 5230ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 5330ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Returns the name for the USB device, which is the same as 5430ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * the dev_name passed to usb_device_open() 5530ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood */ 5630ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodconst char* usb_device_get_name(struct usb_device *device); 5730ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 5830ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Returns the USB vendor ID from the device descriptor for the USB device */ 5930ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwooduint16_t usb_device_get_vendor_id(struct usb_device *device); 6030ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 6130ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Returns the USB product ID from the device descriptor for the USB device */ 6230ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwooduint16_t usb_device_get_product_id(struct usb_device *device); 6330ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 6430ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Returns a USB descriptor string for the given string ID. 6530ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * Used to implement usb_device_get_manufacturer_name, 6630ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * usb_device_get_product_name and usb_device_get_serial. 6730ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * Call free() to free the result when you are done with it. 6830ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood */ 6930ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodchar* usb_device_get_string(struct usb_device *device, int id); 7030ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 7130ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Returns the manufacturer name for the USB device. 7230ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * Call free() to free the result when you are done with it. 7330ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood */ 7430ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodchar* usb_device_get_manufacturer_name(struct usb_device *device); 7530ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 7630ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Returns the product name for the USB device. 7730ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * Call free() to free the result when you are done with it. 7830ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood */ 7930ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodchar* usb_device_get_product_name(struct usb_device *device); 8030ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 8130ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Returns the USB serial number for the USB device. 8230ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * Call free() to free the result when you are done with it. 8330ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood */ 8430ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodchar* usb_device_get_serial(struct usb_device *device); 8530ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 8630ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Returns true if we have write access to the USB device, 8730ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * and false if we only have access to the USB device configuration. 8830ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood */ 8930ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodint usb_device_is_writeable(struct usb_device *device); 9030ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 9130ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Initializes a usb_descriptor_iter, which can be used to iterate through all 9230ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * the USB descriptors for a USB device. 9330ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood */ 9430ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodvoid usb_descriptor_iter_init(struct usb_device *device, struct usb_descriptor_iter *iter); 9530ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 9630ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Returns the next USB descriptor for a device, or NULL if we have reached the 9730ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * end of the list. 9830ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood */ 9930ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodstruct usb_descriptor_header *usb_descriptor_iter_next(struct usb_descriptor_iter *iter); 10030ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 10130ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Claims the specified interface of a USB device */ 10230ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodint usb_device_claim_interface(struct usb_device *device, unsigned int interface); 10330ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 10430ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Releases the specified interface of a USB device */ 10530ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodint usb_device_release_interface(struct usb_device *device, unsigned int interface); 10630ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 10730ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 10830ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Creates a new usb_endpoint for the specified endpoint of a USB device. 10930ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * This can be used to read or write data across the endpoint. 11030ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood */ 11130ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodstruct usb_endpoint *usb_endpoint_open(struct usb_device *dev, 11230ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood const struct usb_endpoint_descriptor *desc); 11330ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 11430ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Releases all resources associated with the endpoint */ 11530ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodvoid usb_endpoint_close(struct usb_endpoint *ep); 11630ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 11730ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Begins a read or write operation on the specified endpoint */ 11830ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodint usb_endpoint_queue(struct usb_endpoint *ep, void *data, int len); 11930ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 12030ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood /* Waits for the results of a previous usb_endpoint_queue operation on the 12130ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * specified endpoint. Returns number of bytes transferred, or a negative 12230ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * value for error. 12330ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood */ 12430ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodint usb_endpoint_wait(struct usb_device *device, int *out_ep_num); 12530ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 12630ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Cancels a pending usb_endpoint_queue() operation on an endpoint. */ 12730ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodint usb_endpoint_cancel(struct usb_endpoint *ep); 12830ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 12930ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Returns the endpoint address for the given endpoint */ 13030ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodint usb_endpoint_number(struct usb_endpoint *ep); 13130ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 13230ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood/* Returns the maximum packet size for the given endpoint. 13330ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood * For bulk endpoints this should be 512 for highspeed or 64 for fullspeed. 13430ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood */ 13530ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwoodint usb_endpoint_max_packet(struct usb_endpoint *ep); 13630ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood 13730ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood#ifdef __cplusplus 13830ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood} 13930ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood#endif 14030ff2c70ce05d761e8cb0ab7ee02b39a681fe0cbMike Lockwood#endif /* __USB_HOST_H */ 141