Mike Lockwood | 30ff2c7 | 2010-05-09 16:23:47 -0400 | [diff] [blame] | 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 |
| 21 | extern "C" { |
| 22 | #endif |
| 23 | |
| 24 | #include <stdint.h> |
| 25 | |
Erik Gilling | 3af05b0 | 2010-12-09 15:28:06 -0800 | [diff] [blame] | 26 | #include <linux/version.h> |
| 27 | #if LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 20) |
| 28 | #include <linux/usb/ch9.h> |
| 29 | #else |
| 30 | #include <linux/usb_ch9.h> |
| 31 | #endif |
| 32 | |
Mike Lockwood | 7a96ba4 | 2010-07-01 11:33:41 -0400 | [diff] [blame] | 33 | struct usb_host_context; |
Mike Lockwood | 30ff2c7 | 2010-05-09 16:23:47 -0400 | [diff] [blame] | 34 | struct usb_endpoint_descriptor; |
| 35 | |
| 36 | struct usb_descriptor_iter { |
| 37 | unsigned char* config; |
| 38 | unsigned char* config_end; |
| 39 | unsigned char* curr_desc; |
| 40 | }; |
| 41 | |
Mike Lockwood | e533c5f | 2011-01-04 20:04:36 -0500 | [diff] [blame] | 42 | struct usb_request |
| 43 | { |
| 44 | struct usb_device *dev; |
| 45 | void* buffer; |
| 46 | int buffer_length; |
| 47 | int actual_length; |
| 48 | int max_packet_size; |
| 49 | void *private_data; /* struct usbdevfs_urb* */ |
Mike Lockwood | b5d68a3 | 2011-02-14 08:05:40 -0500 | [diff] [blame] | 50 | int endpoint; |
Mike Lockwood | e533c5f | 2011-01-04 20:04:36 -0500 | [diff] [blame] | 51 | void *client_data; /* free for use by client */ |
| 52 | }; |
| 53 | |
Mike Lockwood | 7a96ba4 | 2010-07-01 11:33:41 -0400 | [diff] [blame] | 54 | /* Callback for notification when new USB devices are attached. |
| 55 | * Return true to exit from usb_host_run. |
| 56 | */ |
| 57 | typedef int (* usb_device_added_cb)(const char *dev_name, void *client_data); |
Mike Lockwood | 30ff2c7 | 2010-05-09 16:23:47 -0400 | [diff] [blame] | 58 | |
Mike Lockwood | 7a96ba4 | 2010-07-01 11:33:41 -0400 | [diff] [blame] | 59 | /* Callback for notification when USB devices are removed. |
| 60 | * Return true to exit from usb_host_run. |
| 61 | */ |
| 62 | typedef int (* usb_device_removed_cb)(const char *dev_name, void *client_data); |
Mike Lockwood | 30ff2c7 | 2010-05-09 16:23:47 -0400 | [diff] [blame] | 63 | |
Mike Lockwood | a805519 | 2010-07-19 20:15:15 -0400 | [diff] [blame] | 64 | /* Callback indicating that initial device discovery is done. |
| 65 | * Return true to exit from usb_host_run. |
| 66 | */ |
| 67 | typedef int (* usb_discovery_done_cb)(void *client_data); |
| 68 | |
Mike Lockwood | 7a96ba4 | 2010-07-01 11:33:41 -0400 | [diff] [blame] | 69 | /* Call this to initialize the USB host library. */ |
| 70 | struct usb_host_context *usb_host_init(void); |
| 71 | |
| 72 | /* Call this to cleanup the USB host library. */ |
| 73 | void usb_host_cleanup(struct usb_host_context *context); |
| 74 | |
Guillaume Ranquet | dea46b6 | 2012-10-23 17:11:44 +0200 | [diff] [blame] | 75 | /* Call this to get the inotify file descriptor. */ |
| 76 | int usb_host_get_fd(struct usb_host_context *context); |
| 77 | |
| 78 | /* Call this to initialize the usb host context. */ |
| 79 | int usb_host_load(struct usb_host_context *context, |
| 80 | usb_device_added_cb added_cb, |
| 81 | usb_device_removed_cb removed_cb, |
| 82 | usb_discovery_done_cb discovery_done_cb, |
| 83 | void *client_data); |
| 84 | |
| 85 | /* Call this to read and handle occuring usb event. */ |
| 86 | int usb_host_read_event(struct usb_host_context *context); |
| 87 | |
Mike Lockwood | 7a96ba4 | 2010-07-01 11:33:41 -0400 | [diff] [blame] | 88 | /* Call this to monitor the USB bus for new and removed devices. |
| 89 | * This is intended to be called from a dedicated thread, |
| 90 | * as it will not return until one of the callbacks returns true. |
Mike Lockwood | 30ff2c7 | 2010-05-09 16:23:47 -0400 | [diff] [blame] | 91 | * added_cb will be called immediately for each existing USB device, |
| 92 | * and subsequently each time a new device is added. |
| 93 | * removed_cb is called when USB devices are removed from the bus. |
Mike Lockwood | a805519 | 2010-07-19 20:15:15 -0400 | [diff] [blame] | 94 | * discovery_done_cb is called after the initial discovery of already |
| 95 | * connected devices is complete. |
Mike Lockwood | 30ff2c7 | 2010-05-09 16:23:47 -0400 | [diff] [blame] | 96 | */ |
Mike Lockwood | 7a96ba4 | 2010-07-01 11:33:41 -0400 | [diff] [blame] | 97 | void usb_host_run(struct usb_host_context *context, |
| 98 | usb_device_added_cb added_cb, |
Mike Lockwood | 6ac3aa1 | 2010-05-25 08:10:02 -0400 | [diff] [blame] | 99 | usb_device_removed_cb removed_cb, |
Mike Lockwood | a805519 | 2010-07-19 20:15:15 -0400 | [diff] [blame] | 100 | usb_discovery_done_cb discovery_done_cb, |
Mike Lockwood | 6ac3aa1 | 2010-05-25 08:10:02 -0400 | [diff] [blame] | 101 | void *client_data); |
Mike Lockwood | 30ff2c7 | 2010-05-09 16:23:47 -0400 | [diff] [blame] | 102 | |
| 103 | /* Creates a usb_device object for a USB device */ |
| 104 | struct usb_device *usb_device_open(const char *dev_name); |
| 105 | |
| 106 | /* Releases all resources associated with the USB device */ |
| 107 | void usb_device_close(struct usb_device *device); |
| 108 | |
Mike Lockwood | be1def8 | 2011-01-07 11:31:58 -0500 | [diff] [blame] | 109 | /* Creates a usb_device object for already open USB device */ |
Mike Lockwood | cd185f2 | 2010-12-12 14:17:02 -0800 | [diff] [blame] | 110 | struct usb_device *usb_device_new(const char *dev_name, int fd); |
| 111 | |
Mike Lockwood | be1def8 | 2011-01-07 11:31:58 -0500 | [diff] [blame] | 112 | /* Returns the file descriptor for the usb_device */ |
Mike Lockwood | cd185f2 | 2010-12-12 14:17:02 -0800 | [diff] [blame] | 113 | int usb_device_get_fd(struct usb_device *device); |
| 114 | |
Mike Lockwood | 30ff2c7 | 2010-05-09 16:23:47 -0400 | [diff] [blame] | 115 | /* Returns the name for the USB device, which is the same as |
| 116 | * the dev_name passed to usb_device_open() |
| 117 | */ |
| 118 | const char* usb_device_get_name(struct usb_device *device); |
| 119 | |
Mike Lockwood | 7d700f8 | 2010-12-29 08:47:29 -0500 | [diff] [blame] | 120 | /* Returns a unique ID for the device. |
| 121 | *Currently this is generated from the dev_name path. |
Mike Lockwood | 203f102 | 2010-05-27 10:12:03 -0400 | [diff] [blame] | 122 | */ |
| 123 | int usb_device_get_unique_id(struct usb_device *device); |
| 124 | |
Mike Lockwood | 7d700f8 | 2010-12-29 08:47:29 -0500 | [diff] [blame] | 125 | /* Returns a unique ID for the device name. |
| 126 | * Currently this is generated from the device path. |
| 127 | */ |
Mike Lockwood | 07eb4af | 2010-07-27 19:05:33 -0400 | [diff] [blame] | 128 | int usb_device_get_unique_id_from_name(const char* name); |
| 129 | |
Mike Lockwood | 7d700f8 | 2010-12-29 08:47:29 -0500 | [diff] [blame] | 130 | /* Returns the device name for the unique ID. |
| 131 | * Call free() to deallocate the returned string */ |
| 132 | char* usb_device_get_name_from_unique_id(int id); |
| 133 | |
Mike Lockwood | 30ff2c7 | 2010-05-09 16:23:47 -0400 | [diff] [blame] | 134 | /* Returns the USB vendor ID from the device descriptor for the USB device */ |
| 135 | uint16_t usb_device_get_vendor_id(struct usb_device *device); |
| 136 | |
| 137 | /* Returns the USB product ID from the device descriptor for the USB device */ |
| 138 | uint16_t usb_device_get_product_id(struct usb_device *device); |
| 139 | |
Mike Lockwood | 5037207 | 2010-12-13 10:15:25 -0800 | [diff] [blame] | 140 | const struct usb_device_descriptor* usb_device_get_device_descriptor(struct usb_device *device); |
| 141 | |
Mike Lockwood | 30ff2c7 | 2010-05-09 16:23:47 -0400 | [diff] [blame] | 142 | /* Returns a USB descriptor string for the given string ID. |
| 143 | * Used to implement usb_device_get_manufacturer_name, |
| 144 | * usb_device_get_product_name and usb_device_get_serial. |
| 145 | * Call free() to free the result when you are done with it. |
| 146 | */ |
| 147 | char* usb_device_get_string(struct usb_device *device, int id); |
| 148 | |
| 149 | /* Returns the manufacturer name for the USB device. |
| 150 | * Call free() to free the result when you are done with it. |
| 151 | */ |
| 152 | char* usb_device_get_manufacturer_name(struct usb_device *device); |
| 153 | |
| 154 | /* Returns the product name for the USB device. |
| 155 | * Call free() to free the result when you are done with it. |
| 156 | */ |
| 157 | char* usb_device_get_product_name(struct usb_device *device); |
| 158 | |
| 159 | /* Returns the USB serial number for the USB device. |
| 160 | * Call free() to free the result when you are done with it. |
| 161 | */ |
| 162 | char* usb_device_get_serial(struct usb_device *device); |
| 163 | |
| 164 | /* Returns true if we have write access to the USB device, |
| 165 | * and false if we only have access to the USB device configuration. |
| 166 | */ |
| 167 | int usb_device_is_writeable(struct usb_device *device); |
| 168 | |
| 169 | /* Initializes a usb_descriptor_iter, which can be used to iterate through all |
| 170 | * the USB descriptors for a USB device. |
| 171 | */ |
| 172 | void usb_descriptor_iter_init(struct usb_device *device, struct usb_descriptor_iter *iter); |
| 173 | |
| 174 | /* Returns the next USB descriptor for a device, or NULL if we have reached the |
| 175 | * end of the list. |
| 176 | */ |
| 177 | struct usb_descriptor_header *usb_descriptor_iter_next(struct usb_descriptor_iter *iter); |
| 178 | |
| 179 | /* Claims the specified interface of a USB device */ |
| 180 | int usb_device_claim_interface(struct usb_device *device, unsigned int interface); |
| 181 | |
| 182 | /* Releases the specified interface of a USB device */ |
| 183 | int usb_device_release_interface(struct usb_device *device, unsigned int interface); |
| 184 | |
Mike Lockwood | ec9e7b1 | 2011-01-22 09:17:07 -0800 | [diff] [blame] | 185 | /* Requests the kernel to connect or disconnect its driver for the specified interface. |
| 186 | * This can be used to ask the kernel to disconnect its driver for a device |
| 187 | * so usb_device_claim_interface can claim it instead. |
| 188 | */ |
| 189 | int usb_device_connect_kernel_driver(struct usb_device *device, |
| 190 | unsigned int interface, int connect); |
| 191 | |
Mike Lockwood | 120b57a | 2011-01-27 10:46:19 -0800 | [diff] [blame] | 192 | /* Sends a control message to the specified device on endpoint zero */ |
| 193 | int usb_device_control_transfer(struct usb_device *device, |
| 194 | int requestType, |
| 195 | int request, |
| 196 | int value, |
| 197 | int index, |
| 198 | void* buffer, |
| 199 | int length, |
| 200 | unsigned int timeout); |
| 201 | |
Mike Lockwood | b5d68a3 | 2011-02-14 08:05:40 -0500 | [diff] [blame] | 202 | /* Reads or writes on a bulk endpoint. |
| 203 | * Returns number of bytes transferred, or negative value for error. |
| 204 | */ |
Mike Lockwood | 120b57a | 2011-01-27 10:46:19 -0800 | [diff] [blame] | 205 | int usb_device_bulk_transfer(struct usb_device *device, |
| 206 | int endpoint, |
| 207 | void* buffer, |
| 208 | int length, |
| 209 | unsigned int timeout); |
| 210 | |
Mike Lockwood | e533c5f | 2011-01-04 20:04:36 -0500 | [diff] [blame] | 211 | /* Creates a new usb_request. */ |
| 212 | struct usb_request *usb_request_new(struct usb_device *dev, |
| 213 | const struct usb_endpoint_descriptor *ep_desc); |
Mike Lockwood | 30ff2c7 | 2010-05-09 16:23:47 -0400 | [diff] [blame] | 214 | |
Mike Lockwood | e533c5f | 2011-01-04 20:04:36 -0500 | [diff] [blame] | 215 | /* Releases all resources associated with the request */ |
| 216 | void usb_request_free(struct usb_request *req); |
Mike Lockwood | 30ff2c7 | 2010-05-09 16:23:47 -0400 | [diff] [blame] | 217 | |
Mike Lockwood | e533c5f | 2011-01-04 20:04:36 -0500 | [diff] [blame] | 218 | /* Submits a read or write request on the specified device */ |
| 219 | int usb_request_queue(struct usb_request *req); |
Mike Lockwood | 30ff2c7 | 2010-05-09 16:23:47 -0400 | [diff] [blame] | 220 | |
Mike Lockwood | e533c5f | 2011-01-04 20:04:36 -0500 | [diff] [blame] | 221 | /* Waits for the results of a previous usb_request_queue operation. |
| 222 | * Returns a usb_request, or NULL for error. |
Mike Lockwood | 30ff2c7 | 2010-05-09 16:23:47 -0400 | [diff] [blame] | 223 | */ |
Mike Lockwood | e533c5f | 2011-01-04 20:04:36 -0500 | [diff] [blame] | 224 | struct usb_request *usb_request_wait(struct usb_device *dev); |
Mike Lockwood | 30ff2c7 | 2010-05-09 16:23:47 -0400 | [diff] [blame] | 225 | |
Mike Lockwood | e533c5f | 2011-01-04 20:04:36 -0500 | [diff] [blame] | 226 | /* Cancels a pending usb_request_queue() operation. */ |
| 227 | int usb_request_cancel(struct usb_request *req); |
Mike Lockwood | 30ff2c7 | 2010-05-09 16:23:47 -0400 | [diff] [blame] | 228 | |
| 229 | #ifdef __cplusplus |
| 230 | } |
| 231 | #endif |
| 232 | #endif /* __USB_HOST_H */ |