1bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/* 2bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Public libusb header file 3bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Copyright (C) 2007-2008 Daniel Drake <dsd@gentoo.org> 4bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Copyright (c) 2001 Johannes Erdfelt <johannes@erdfelt.com> 5bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 6bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * This library is free software; you can redistribute it and/or 7bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * modify it under the terms of the GNU Lesser General Public 8bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * License as published by the Free Software Foundation; either 9bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * version 2.1 of the License, or (at your option) any later version. 10bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 11bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * This library is distributed in the hope that it will be useful, 12bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * but WITHOUT ANY WARRANTY; without even the implied warranty of 13bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Lesser General Public License for more details. 15bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 16bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * You should have received a copy of the GNU Lesser General Public 17bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * License along with this library; if not, write to the Free Software 18bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 19bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 20bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 21bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev#ifndef __LIBUSB_H__ 22bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev#define __LIBUSB_H__ 23bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 24bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev#include <stdint.h> 25bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev#include <sys/time.h> 26bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev#include <sys/types.h> 27bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev#include <time.h> 28bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev#include <limits.h> 29bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 30bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev#ifdef __cplusplus 31bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevextern "C" { 32bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev#endif 33bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 34bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \def libusb_cpu_to_le16 35bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ingroup misc 36bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Convert a 16-bit value from host-endian to little-endian format. On 37bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * little endian systems, this function does nothing. On big endian systems, 38bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * the bytes are swapped. 39bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param x the host-endian value to convert 40bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \returns the value in little-endian byte order 41bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 42bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev#define libusb_cpu_to_le16(x) ({ \ 43bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev union { \ 44bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t b8[2]; \ 45bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint16_t b16; \ 46bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev } _tmp; \ 47bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint16_t _tmp2 = (uint16_t)(x); \ 48bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev _tmp.b8[1] = _tmp2 >> 8; \ 49bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev _tmp.b8[0] = _tmp2 & 0xff; \ 50bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev _tmp.b16; \ 51bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev}) 52bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 53bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \def libusb_le16_to_cpu 54bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ingroup misc 55bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Convert a 16-bit value from little-endian to host-endian format. On 56bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * little endian systems, this function does nothing. On big endian systems, 57bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * the bytes are swapped. 58bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param x the little-endian value to convert 59bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \returns the value in host-endian byte order 60bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 61bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev#define libusb_le16_to_cpu libusb_cpu_to_le16 62bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 63bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/* standard USB stuff */ 64bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 65bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup desc 66bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Device and/or Interface Class codes */ 67bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevenum libusb_class_code { 68bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** In the context of a \ref libusb_device_descriptor "device descriptor", 69bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * this bDeviceClass value indicates that each interface specifies its 70bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * own class information and all interfaces operate independently. 71bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 72bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_CLASS_PER_INTERFACE = 0, 73bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 74bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Audio class */ 75bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_CLASS_AUDIO = 1, 76bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 77bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Communications class */ 78bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_CLASS_COMM = 2, 79bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 80bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Human Interface Device class */ 81bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_CLASS_HID = 3, 82bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 83bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Printer dclass */ 84bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_CLASS_PRINTER = 7, 85bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 86bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Picture transfer protocol class */ 87bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_CLASS_PTP = 6, 88bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 89bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Mass storage class */ 90bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_CLASS_MASS_STORAGE = 8, 91bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 92bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Hub class */ 93bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_CLASS_HUB = 9, 94bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 95bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Data class */ 96bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_CLASS_DATA = 10, 97bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 98bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Wireless class */ 99bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_CLASS_WIRELESS = 0xe0, 100bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 101bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Application class */ 102bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_CLASS_APPLICATION = 0xfe, 103bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 104bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Class is vendor-specific */ 105bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_CLASS_VENDOR_SPEC = 0xff 106bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev}; 107bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 108bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup desc 109bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Descriptor types as defined by the USB specification. */ 110bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevenum libusb_descriptor_type { 111bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Device descriptor. See libusb_device_descriptor. */ 112bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_DT_DEVICE = 0x01, 113bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 114bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Configuration descriptor. See libusb_config_descriptor. */ 115bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_DT_CONFIG = 0x02, 116bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 117bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** String descriptor */ 118bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_DT_STRING = 0x03, 119bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 120bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Interface descriptor. See libusb_interface_descriptor. */ 121bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_DT_INTERFACE = 0x04, 122bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 123bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Endpoint descriptor. See libusb_endpoint_descriptor. */ 124bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_DT_ENDPOINT = 0x05, 125bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 126bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** HID descriptor */ 127bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_DT_HID = 0x21, 128bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 129bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** HID report descriptor */ 130bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_DT_REPORT = 0x22, 131bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 132bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Physical descriptor */ 133bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_DT_PHYSICAL = 0x23, 134bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 135bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Hub descriptor */ 136bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_DT_HUB = 0x29 137bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev}; 138bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 139bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/* Descriptor sizes per descriptor type */ 140bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev#define LIBUSB_DT_DEVICE_SIZE 18 141bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev#define LIBUSB_DT_CONFIG_SIZE 9 142bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev#define LIBUSB_DT_INTERFACE_SIZE 9 143bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev#define LIBUSB_DT_ENDPOINT_SIZE 7 144bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev#define LIBUSB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */ 145bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev#define LIBUSB_DT_HUB_NONVAR_SIZE 7 146bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 147bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev#define LIBUSB_ENDPOINT_ADDRESS_MASK 0x0f /* in bEndpointAddress */ 148bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev#define LIBUSB_ENDPOINT_DIR_MASK 0x80 149bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 150bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup desc 151bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Endpoint direction. Values for bit 7 of the 152bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ref libusb_endpoint_descriptor::bEndpointAddress "endpoint address" scheme. 153bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 154bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevenum libusb_endpoint_direction { 155bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** In: device-to-host */ 156bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_ENDPOINT_IN = 0x80, 157bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 158bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Out: host-to-device */ 159bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_ENDPOINT_OUT = 0x00 160bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev}; 161bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 162bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev#define LIBUSB_TRANSFER_TYPE_MASK 0x03 /* in bmAttributes */ 163bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 164bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup desc 165bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Endpoint transfer type. Values for bits 0:1 of the 166bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ref libusb_endpoint_descriptor::bmAttributes "endpoint attributes" field. 167bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 168bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevenum libusb_transfer_type { 169bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Control endpoint */ 170bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_TRANSFER_TYPE_CONTROL = 0, 171bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 172bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Isochronous endpoint */ 173bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_TRANSFER_TYPE_ISOCHRONOUS = 1, 174bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 175bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Bulk endpoint */ 176bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_TRANSFER_TYPE_BULK = 2, 177bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 178bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Interrupt endpoint */ 179bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_TRANSFER_TYPE_INTERRUPT = 3 180bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev}; 181bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 182bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup misc 183bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Standard requests, as defined in table 9-3 of the USB2 specifications */ 184bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevenum libusb_standard_request { 185bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Request status of the specific recipient */ 186bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_REQUEST_GET_STATUS = 0x00, 187bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 188bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Clear or disable a specific feature */ 189bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_REQUEST_CLEAR_FEATURE = 0x01, 190bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 191bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /* 0x02 is reserved */ 192bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 193bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Set or enable a specific feature */ 194bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_REQUEST_SET_FEATURE = 0x03, 195bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 196bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /* 0x04 is reserved */ 197bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 198bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Set device address for all future accesses */ 199bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_REQUEST_SET_ADDRESS = 0x05, 200bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 201bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Get the specified descriptor */ 202bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_REQUEST_GET_DESCRIPTOR = 0x06, 203bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 204bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Used to update existing descriptors or add new descriptors */ 205bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_REQUEST_SET_DESCRIPTOR = 0x07, 206bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 207bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Get the current device configuration value */ 208bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_REQUEST_GET_CONFIGURATION = 0x08, 209bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 210bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Set device configuration */ 211bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_REQUEST_SET_CONFIGURATION = 0x09, 212bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 213bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Return the selected alternate setting for the specified interface */ 214bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_REQUEST_GET_INTERFACE = 0x0A, 215bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 216bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Select an alternate interface for the specified interface */ 217bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_REQUEST_SET_INTERFACE = 0x0B, 218bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 219bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Set then report an endpoint's synchronization frame */ 220bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_REQUEST_SYNCH_FRAME = 0x0C 221bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev}; 222bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 223bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup misc 224bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Request type bits of the 225bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ref libusb_control_setup::bmRequestType "bmRequestType" field in control 226bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * transfers. */ 227bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevenum libusb_request_type { 228bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Standard */ 229bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_REQUEST_TYPE_STANDARD = (0x00 << 5), 230bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 231bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Class */ 232bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_REQUEST_TYPE_CLASS = (0x01 << 5), 233bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 234bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Vendor */ 235bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_REQUEST_TYPE_VENDOR = (0x02 << 5), 236bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 237bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Reserved */ 238bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_REQUEST_TYPE_RESERVED = (0x03 << 5) 239bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev}; 240bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 241bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup misc 242bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Recipient bits of the 243bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ref libusb_control_setup::bmRequestType "bmRequestType" field in control 244bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * transfers. Values 4 through 31 are reserved. */ 245bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevenum libusb_request_recipient { 246bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Device */ 247bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_RECIPIENT_DEVICE = 0x00, 248bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 249bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Interface */ 250bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_RECIPIENT_INTERFACE = 0x01, 251bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 252bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Endpoint */ 253bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_RECIPIENT_ENDPOINT = 0x02, 254bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 255bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Other */ 256bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_RECIPIENT_OTHER = 0x03 257bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev}; 258bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 259bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev#define LIBUSB_ISO_SYNC_TYPE_MASK 0x0C 260bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 261bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup desc 262bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Synchronization type for isochronous endpoints. Values for bits 2:3 of the 263bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ref libusb_endpoint_descriptor::bmAttributes "bmAttributes" field in 264bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * libusb_endpoint_descriptor. 265bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 266bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevenum libusb_iso_sync_type { 267bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** No synchronization */ 268bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_ISO_SYNC_TYPE_NONE = 0, 269bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 270bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Asynchronous */ 271bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_ISO_SYNC_TYPE_ASYNC = 1, 272bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 273bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Adaptive */ 274bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_ISO_SYNC_TYPE_ADAPTIVE = 2, 275bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 276bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Synchronous */ 277bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_ISO_SYNC_TYPE_SYNC = 3 278bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev}; 279bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 280bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev#define LIBUSB_ISO_USAGE_TYPE_MASK 0x30 281bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 282bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup desc 283bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Usage type for isochronous endpoints. Values for bits 4:5 of the 284bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ref libusb_endpoint_descriptor::bmAttributes "bmAttributes" field in 285bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * libusb_endpoint_descriptor. 286bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 287bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevenum libusb_iso_usage_type { 288bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Data endpoint */ 289bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_ISO_USAGE_TYPE_DATA = 0, 290bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 291bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Feedback endpoint */ 292bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_ISO_USAGE_TYPE_FEEDBACK = 1, 293bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 294bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Implicit feedback Data endpoint */ 295bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_ISO_USAGE_TYPE_IMPLICIT = 2 296bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev}; 297bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 298bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup desc 299bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * A structure representing the standard USB device descriptor. This 300bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * descriptor is documented in section 9.6.1 of the USB 2.0 specification. 301bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * All multiple-byte fields are represented in host-endian format. 302bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 303bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevstruct libusb_device_descriptor { 304bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Size of this descriptor (in bytes) */ 305bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bLength; 306bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 307bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Descriptor type. Will have value 308bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ref libusb_descriptor_type::LIBUSB_DT_DEVICE LIBUSB_DT_DEVICE in this 309bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * context. */ 310bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bDescriptorType; 311bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 312bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** USB specification release number in binary-coded decimal. A value of 313bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 0x0200 indicates USB 2.0, 0x0110 indicates USB 1.1, etc. */ 314bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint16_t bcdUSB; 315bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 316bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** USB-IF class code for the device. See \ref libusb_class_code. */ 317bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bDeviceClass; 318bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 319bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** USB-IF subclass code for the device, qualified by the bDeviceClass 320bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * value */ 321bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bDeviceSubClass; 322bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 323bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** USB-IF protocol code for the device, qualified by the bDeviceClass and 324bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * bDeviceSubClass values */ 325bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bDeviceProtocol; 326bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 327bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Maximum packet size for endpoint 0 */ 328bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bMaxPacketSize0; 329bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 330bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** USB-IF vendor ID */ 331bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint16_t idVendor; 332bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 333bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** USB-IF product ID */ 334bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint16_t idProduct; 335bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 336bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Device release number in binary-coded decimal */ 337bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint16_t bcdDevice; 338bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 339bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Index of string descriptor describing manufacturer */ 340bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t iManufacturer; 341bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 342bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Index of string descriptor describing product */ 343bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t iProduct; 344bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 345bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Index of string descriptor containing device serial number */ 346bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t iSerialNumber; 347bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 348bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Number of possible configurations */ 349bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bNumConfigurations; 350bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev}; 351bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 352bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup desc 353bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * A structure representing the standard USB endpoint descriptor. This 354bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * descriptor is documented in section 9.6.3 of the USB 2.0 specification. 355bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * All multiple-byte fields are represented in host-endian format. 356bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 357bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevstruct libusb_endpoint_descriptor { 358bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Size of this descriptor (in bytes) */ 359bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bLength; 360bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 361bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Descriptor type. Will have value 362bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ref libusb_descriptor_type::LIBUSB_DT_ENDPOINT LIBUSB_DT_ENDPOINT in 363bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * this context. */ 364bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bDescriptorType; 365bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 366bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** The address of the endpoint described by this descriptor. Bits 0:3 are 367bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * the endpoint number. Bits 4:6 are reserved. Bit 7 indicates direction, 368bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * see \ref libusb_endpoint_direction. 369bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 370bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bEndpointAddress; 371bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 372bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Attributes which apply to the endpoint when it is configured using 373bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * the bConfigurationValue. Bits 0:1 determine the transfer type and 374bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * correspond to \ref libusb_transfer_type. Bits 2:3 are only used for 375bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * isochronous endpoints and correspond to \ref libusb_iso_sync_type. 376bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Bits 4:5 are also only used for isochronous endpoints and correspond to 377bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ref libusb_iso_usage_type. Bits 6:7 are reserved. 378bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 379bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bmAttributes; 380bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 381bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Maximum packet size this endpoint is capable of sending/receiving. */ 382bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint16_t wMaxPacketSize; 383bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 384bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Interval for polling endpoint for data transfers. */ 385bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bInterval; 386bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 387bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** For audio devices only: the rate at which synchronization feedback 388bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * is provided. */ 389bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bRefresh; 390bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 391bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** For audio devices only: the address if the synch endpoint */ 392bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bSynchAddress; 393bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 394bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Extra descriptors. If libusb encounters unknown endpoint descriptors, 395bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * it will store them here, should you wish to parse them. */ 396bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev const unsigned char *extra; 397bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 398bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Length of the extra descriptors, in bytes. */ 399bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev int extra_length; 400bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev}; 401bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 402bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup desc 403bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * A structure representing the standard USB interface descriptor. This 404bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * descriptor is documented in section 9.6.5 of the USB 2.0 specification. 405bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * All multiple-byte fields are represented in host-endian format. 406bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 407bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevstruct libusb_interface_descriptor { 408bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Size of this descriptor (in bytes) */ 409bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bLength; 410bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 411bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Descriptor type. Will have value 412bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ref libusb_descriptor_type::LIBUSB_DT_INTERFACE LIBUSB_DT_INTERFACE 413bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * in this context. */ 414bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bDescriptorType; 415bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 416bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Number of this interface */ 417bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bInterfaceNumber; 418bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 419bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Value used to select this alternate setting for this interface */ 420bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bAlternateSetting; 421bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 422bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Number of endpoints used by this interface (excluding the control 423bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * endpoint). */ 424bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bNumEndpoints; 425bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 426bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** USB-IF class code for this interface. See \ref libusb_class_code. */ 427bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bInterfaceClass; 428bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 429bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** USB-IF subclass code for this interface, qualified by the 430bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * bInterfaceClass value */ 431bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bInterfaceSubClass; 432bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 433bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** USB-IF protocol code for this interface, qualified by the 434bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * bInterfaceClass and bInterfaceSubClass values */ 435bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bInterfaceProtocol; 436bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 437bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Index of string descriptor describing this interface */ 438bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t iInterface; 439bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 440bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Array of endpoint descriptors. This length of this array is determined 441bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * by the bNumEndpoints field. */ 442bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev const struct libusb_endpoint_descriptor *endpoint; 443bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 444bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Extra descriptors. If libusb encounters unknown interface descriptors, 445bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * it will store them here, should you wish to parse them. */ 446bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev const unsigned char *extra; 447bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 448bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Length of the extra descriptors, in bytes. */ 449bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev int extra_length; 450bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev}; 451bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 452bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup desc 453bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * A collection of alternate settings for a particular USB interface. 454bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 455bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevstruct libusb_interface { 456bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Array of interface descriptors. The length of this array is determined 457bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * by the num_altsetting field. */ 458bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev const struct libusb_interface_descriptor *altsetting; 459bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 460bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** The number of alternate settings that belong to this interface */ 461bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev int num_altsetting; 462bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev}; 463bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 464bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup desc 465bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * A structure representing the standard USB configuration descriptor. This 466bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * descriptor is documented in section 9.6.3 of the USB 2.0 specification. 467bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * All multiple-byte fields are represented in host-endian format. 468bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 469bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevstruct libusb_config_descriptor { 470bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Size of this descriptor (in bytes) */ 471bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bLength; 472bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 473bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Descriptor type. Will have value 474bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ref libusb_descriptor_type::LIBUSB_DT_CONFIG LIBUSB_DT_CONFIG 475bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * in this context. */ 476bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bDescriptorType; 477bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 478bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Total length of data returned for this configuration */ 479bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint16_t wTotalLength; 480bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 481bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Number of interfaces supported by this configuration */ 482bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bNumInterfaces; 483bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 484bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Identifier value for this configuration */ 485bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bConfigurationValue; 486bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 487bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Index of string descriptor describing this configuration */ 488bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t iConfiguration; 489bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 490bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Configuration characteristics */ 491bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bmAttributes; 492bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 493bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Maximum power consumption of the USB device from this bus in this 494bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * configuration when the device is fully opreation. Expressed in units 495bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * of 2 mA. */ 496bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t MaxPower; 497bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 498bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Array of interfaces supported by this configuration. The length of 499bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * this array is determined by the bNumInterfaces field. */ 500bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev const struct libusb_interface *interface; 501bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 502bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Extra descriptors. If libusb encounters unknown configuration 503bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * descriptors, it will store them here, should you wish to parse them. */ 504bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev const unsigned char *extra; 505bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 506bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Length of the extra descriptors, in bytes. */ 507bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev int extra_length; 508bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev}; 509bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 510bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup asyncio 511bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Setup packet for control transfers. */ 512bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevstruct libusb_control_setup { 513bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Request type. Bits 0:4 determine recipient, see 514bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ref libusb_request_recipient. Bits 5:6 determine type, see 515bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ref libusb_request_type. Bit 7 determines data transfer direction, see 516bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ref libusb_endpoint_direction. 517bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 518bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bmRequestType; 519bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 520bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Request. If the type bits of bmRequestType are equal to 521bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ref libusb_request_type::LIBUSB_REQUEST_TYPE_STANDARD 522bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * "LIBUSB_REQUEST_TYPE_STANDARD" then this field refers to 523bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ref libusb_standard_request. For other cases, use of this field is 524bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * application-specific. */ 525bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bRequest; 526bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 527bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Value. Varies according to request */ 528bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint16_t wValue; 529bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 530bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Index. Varies according to request, typically used to pass an index 531bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * or offset */ 532bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint16_t wIndex; 533bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 534bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Number of bytes to transfer */ 535bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint16_t wLength; 536bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev}; 537bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 538bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev#define LIBUSB_CONTROL_SETUP_SIZE (sizeof(struct libusb_control_setup)) 539bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 540bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/* libusb */ 541bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 542bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevstruct libusb_context; 543bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevstruct libusb_device; 544bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevstruct libusb_device_handle; 545bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 546bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup lib 547bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Structure representing a libusb session. The concept of individual libusb 548bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * sessions allows for your program to use two libraries (or dynamically 549bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * load two modules) which both independently use libusb. This will prevent 550bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * interference between the individual libusb users - for example 551bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * libusb_set_debug() will not affect the other user of the library, and 552bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * libusb_exit() will not destroy resources that the other user is still 553bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * using. 554bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 555bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Sessions are created by libusb_init() and destroyed through libusb_exit(). 556bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * If your application is guaranteed to only ever include a single libusb 557bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * user (i.e. you), you do not have to worry about contexts: pass NULL in 558bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * every function call where a context is required. The default context 559bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * will be used. 560bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 561bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * For more information, see \ref contexts. 562bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 563bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevtypedef struct libusb_context libusb_context; 564bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 565bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup dev 566bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Structure representing a USB device detected on the system. This is an 567bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * opaque type for which you are only ever provided with a pointer, usually 568bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * originating from libusb_get_device_list(). 569bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 570bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Certain operations can be performed on a device, but in order to do any 571bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * I/O you will have to first obtain a device handle using libusb_open(). 572bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 573bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Devices are reference counted with libusb_device_ref() and 574bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * libusb_device_unref(), and are freed when the reference count reaches 0. 575bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * New devices presented by libusb_get_device_list() have a reference count of 576bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 1, and libusb_free_device_list() can optionally decrease the reference count 577bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * on all devices in the list. libusb_open() adds another reference which is 578bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * later destroyed by libusb_close(). 579bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 580bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevtypedef struct libusb_device libusb_device; 581bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 582bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 583bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup dev 584bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Structure representing a handle on a USB device. This is an opaque type for 585bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * which you are only ever provided with a pointer, usually originating from 586bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * libusb_open(). 587bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 588bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * A device handle is used to perform I/O and other operations. When finished 589bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * with a device handle, you should call libusb_close(). 590bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 591bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevtypedef struct libusb_device_handle libusb_device_handle; 592bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 593bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup misc 594bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Error codes. Most libusb functions return 0 on success or one of these 595bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * codes on failure. 596bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 597bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevenum libusb_error { 598bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Success (no error) */ 599bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_SUCCESS = 0, 600bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 601bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Input/output error */ 602bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_ERROR_IO = -1, 603bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 604bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Invalid parameter */ 605bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_ERROR_INVALID_PARAM = -2, 606bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 607bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Access denied (insufficient permissions) */ 608bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_ERROR_ACCESS = -3, 609bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 610bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** No such device (it may have been disconnected) */ 611bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_ERROR_NO_DEVICE = -4, 612bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 613bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Entity not found */ 614bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_ERROR_NOT_FOUND = -5, 615bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 616bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Resource busy */ 617bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_ERROR_BUSY = -6, 618bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 619bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Operation timed out */ 620bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_ERROR_TIMEOUT = -7, 621bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 622bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Overflow */ 623bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_ERROR_OVERFLOW = -8, 624bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 625bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Pipe error */ 626bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_ERROR_PIPE = -9, 627bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 628bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** System call interrupted (perhaps due to signal) */ 629bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_ERROR_INTERRUPTED = -10, 630bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 631bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Insufficient memory */ 632bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_ERROR_NO_MEM = -11, 633bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 634bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Operation not supported or unimplemented on this platform */ 635bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_ERROR_NOT_SUPPORTED = -12, 636bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 637bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Other error */ 638bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_ERROR_OTHER = -99 639bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev}; 640bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 641bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup asyncio 642bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Transfer status codes */ 643bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevenum libusb_transfer_status { 644bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Transfer completed without error. Note that this does not indicate 645bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * that the entire amount of requested data was transferred. */ 646bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_TRANSFER_COMPLETED, 647bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 648bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Transfer failed */ 649bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_TRANSFER_ERROR, 650bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 651bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Transfer timed out */ 652bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_TRANSFER_TIMED_OUT, 653bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 654bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Transfer was cancelled */ 655bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_TRANSFER_CANCELLED, 656bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 657bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** For bulk/interrupt endpoints: halt condition detected (endpoint 658bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * stalled). For control endpoints: control request not supported. */ 659bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_TRANSFER_STALL, 660bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 661bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Device was disconnected */ 662bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_TRANSFER_NO_DEVICE, 663bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 664bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Device sent more data than requested */ 665bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_TRANSFER_OVERFLOW 666bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev}; 667bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 668bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup asyncio 669bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * libusb_transfer.flags values */ 670bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevenum libusb_transfer_flags { 671bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Report short frames as errors */ 672bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_TRANSFER_SHORT_NOT_OK = 1<<0, 673bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 674bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Automatically free() transfer buffer during libusb_free_transfer() */ 675bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_TRANSFER_FREE_BUFFER = 1<<1, 676bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 677bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Automatically call libusb_free_transfer() after callback returns. 678bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * If this flag is set, it is illegal to call libusb_free_transfer() 679bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * from your transfer callback, as this will result in a double-free 680bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * when this flag is acted upon. */ 681bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_TRANSFER_FREE_TRANSFER = 1<<2 682bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev}; 683bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 684bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup asyncio 685bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Isochronous packet descriptor. */ 686bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevstruct libusb_iso_packet_descriptor { 687bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Length of data to request in this packet */ 688bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev unsigned int length; 689bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 690bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Amount of data that was actually transferred */ 691bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev unsigned int actual_length; 692bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 693bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Status code for this packet */ 694bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev enum libusb_transfer_status status; 695bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev}; 696bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 697bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevstruct libusb_transfer; 698bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 699bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup asyncio 700bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Asynchronous transfer callback function type. When submitting asynchronous 701bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * transfers, you pass a pointer to a callback function of this type via the 702bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ref libusb_transfer::callback "callback" member of the libusb_transfer 703bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * structure. libusb will call this function later, when the transfer has 704bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * completed or failed. See \ref asyncio for more information. 705bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param transfer The libusb_transfer struct the callback function is being 706bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * notified about. 707bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 708bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevtypedef void (*libusb_transfer_cb_fn)(struct libusb_transfer *transfer); 709bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 710bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup asyncio 711bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * The generic USB transfer structure. The user populates this structure and 712bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * then submits it in order to request a transfer. After the transfer has 713bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * completed, the library populates the transfer with the results and passes 714bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * it back to the user. 715bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 716bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevstruct libusb_transfer { 717bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Handle of the device that this transfer will be submitted to */ 718bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev libusb_device_handle *dev_handle; 719bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 720bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** A bitwise OR combination of \ref libusb_transfer_flags. */ 721bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t flags; 722bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 723bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Address of the endpoint where this transfer will be sent. */ 724bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev unsigned char endpoint; 725bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 726bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Type of the endpoint from \ref libusb_transfer_type */ 727bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev unsigned char type; 728bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 729bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Timeout for this transfer in millseconds. A value of 0 indicates no 730bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * timeout. */ 731bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev unsigned int timeout; 732bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 733bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** The status of the transfer. Read-only, and only for use within 734bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * transfer callback function. 735bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 736bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * If this is an isochronous transfer, this field may read COMPLETED even 737bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * if there were errors in the frames. Use the 738bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ref libusb_iso_packet_descriptor::status "status" field in each packet 739bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * to determine if errors occurred. */ 740bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev enum libusb_transfer_status status; 741bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 742bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Length of the data buffer */ 743bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev int length; 744bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 745bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Actual length of data that was transferred. Read-only, and only for 746bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * use within transfer callback function. Not valid for isochronous 747bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * endpoint transfers. */ 748bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev int actual_length; 749bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 750bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Callback function. This will be invoked when the transfer completes, 751bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * fails, or is cancelled. */ 752bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev libusb_transfer_cb_fn callback; 753bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 754bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** User context data to pass to the callback function. */ 755bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev void *user_data; 756bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 757bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Data buffer */ 758bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev unsigned char *buffer; 759bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 760bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Number of isochronous packets. Only used for I/O with isochronous 761bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * endpoints. */ 762bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev int num_iso_packets; 763bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 764bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Isochronous packet descriptors, for isochronous transfers only. */ 765bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev struct libusb_iso_packet_descriptor iso_packet_desc 766bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) 767bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev [] /* valid C99 code */ 768bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev#else 769bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev [0] /* non-standard, but usually working code */ 770bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev#endif 771bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev ; 772bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev}; 773bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 774bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_init(libusb_context **ctx); 775bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevvoid libusb_exit(libusb_context *ctx); 776bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevvoid libusb_set_debug(libusb_context *ctx, int level); 777bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 778bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevssize_t libusb_get_device_list(libusb_context *ctx, 779bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev libusb_device ***list); 780bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevvoid libusb_free_device_list(libusb_device **list, int unref_devices); 781bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevlibusb_device *libusb_ref_device(libusb_device *dev); 782bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevvoid libusb_unref_device(libusb_device *dev); 783bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 784bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_get_configuration(libusb_device_handle *dev, int *config); 785bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_get_device_descriptor(libusb_device *dev, 786bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev struct libusb_device_descriptor *desc); 787bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_get_active_config_descriptor(libusb_device *dev, 788bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev struct libusb_config_descriptor **config); 789bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_get_config_descriptor(libusb_device *dev, uint8_t config_index, 790bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev struct libusb_config_descriptor **config); 791bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_get_config_descriptor_by_value(libusb_device *dev, 792bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bConfigurationValue, struct libusb_config_descriptor **config); 793bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevvoid libusb_free_config_descriptor(struct libusb_config_descriptor *config); 794bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevuint8_t libusb_get_bus_number(libusb_device *dev); 795bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevuint8_t libusb_get_device_address(libusb_device *dev); 796bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_get_max_packet_size(libusb_device *dev, unsigned char endpoint); 797bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_get_max_iso_packet_size(libusb_device *dev, unsigned char endpoint); 798bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 799bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_open(libusb_device *dev, libusb_device_handle **handle); 800bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevvoid libusb_close(libusb_device_handle *dev_handle); 801bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevlibusb_device *libusb_get_device(libusb_device_handle *dev_handle); 802bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 803bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_set_configuration(libusb_device_handle *dev, int configuration); 804bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_claim_interface(libusb_device_handle *dev, int iface); 805bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_release_interface(libusb_device_handle *dev, int iface); 806bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 807bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevlibusb_device_handle *libusb_open_device_with_vid_pid(libusb_context *ctx, 808bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint16_t vendor_id, uint16_t product_id); 809bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 810bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_set_interface_alt_setting(libusb_device_handle *dev, 811bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev int interface_number, int alternate_setting); 812bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_clear_halt(libusb_device_handle *dev, unsigned char endpoint); 813bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_reset_device(libusb_device_handle *dev); 814bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 815bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_kernel_driver_active(libusb_device_handle *dev, int interface); 816bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_detach_kernel_driver(libusb_device_handle *dev, int interface); 817bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_attach_kernel_driver(libusb_device_handle *dev, int interface); 818bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 819bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/* async I/O */ 820bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 821bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup asyncio 822bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Get the data section of a control transfer. This convenience function is here 823bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * to remind you that the data does not start until 8 bytes into the actual 824bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * buffer, as the setup packet comes first. 825bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 826bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Calling this function only makes sense from a transfer callback function, 827bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * or situations where you have already allocated a suitably sized buffer at 828bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * transfer->buffer. 829bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 830bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param transfer a transfer 831bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \returns pointer to the first byte of the data section 832bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 833bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevstatic inline unsigned char *libusb_control_transfer_get_data( 834bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev struct libusb_transfer *transfer) 835bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev{ 836bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev return transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE; 837bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev} 838bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 839bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup asyncio 840bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Get the control setup packet of a control transfer. This convenience 841bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * function is here to remind you that the control setup occupies the first 842bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 8 bytes of the transfer data buffer. 843bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 844bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Calling this function only makes sense from a transfer callback function, 845bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * or situations where you have already allocated a suitably sized buffer at 846bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * transfer->buffer. 847bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 848bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param transfer a transfer 849bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \returns a casted pointer to the start of the transfer data buffer 850bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 851bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevstatic inline struct libusb_control_setup *libusb_control_transfer_get_setup( 852bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev struct libusb_transfer *transfer) 853bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev{ 854bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev return (struct libusb_control_setup *) transfer->buffer; 855bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev} 856bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 857bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup asyncio 858bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Helper function to populate the setup packet (first 8 bytes of the data 859bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * buffer) for a control transfer. The wIndex, wValue and wLength values should 860bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * be given in host-endian byte order. 861bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 862bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param buffer buffer to output the setup packet into 863bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param bmRequestType see the 864bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ref libusb_control_setup::bmRequestType "bmRequestType" field of 865bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ref libusb_control_setup 866bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param bRequest see the 867bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ref libusb_control_setup::bRequest "bRequest" field of 868bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ref libusb_control_setup 869bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param wValue see the 870bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ref libusb_control_setup::wValue "wValue" field of 871bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ref libusb_control_setup 872bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param wIndex see the 873bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ref libusb_control_setup::wIndex "wIndex" field of 874bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ref libusb_control_setup 875bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param wLength see the 876bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ref libusb_control_setup::wLength "wLength" field of 877bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \ref libusb_control_setup 878bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 879bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevstatic inline void libusb_fill_control_setup(unsigned char *buffer, 880bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex, 881bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint16_t wLength) 882bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev{ 883bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev struct libusb_control_setup *setup = (struct libusb_control_setup *) buffer; 884bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev setup->bmRequestType = bmRequestType; 885bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev setup->bRequest = bRequest; 886bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev setup->wValue = libusb_cpu_to_le16(wValue); 887bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev setup->wIndex = libusb_cpu_to_le16(wIndex); 888bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev setup->wLength = libusb_cpu_to_le16(wLength); 889bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev} 890bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 891bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevstruct libusb_transfer *libusb_alloc_transfer(int iso_packets); 892bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_submit_transfer(struct libusb_transfer *transfer); 893bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_cancel_transfer(struct libusb_transfer *transfer); 894bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevvoid libusb_free_transfer(struct libusb_transfer *transfer); 895bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 896bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup asyncio 897bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Helper function to populate the required \ref libusb_transfer fields 898bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * for a control transfer. 899bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 900bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * If you pass a transfer buffer to this function, the first 8 bytes will 901bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * be interpreted as a control setup packet, and the wLength field will be 902bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * used to automatically populate the \ref libusb_transfer::length "length" 903bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * field of the transfer. Therefore the recommended approach is: 904bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * -# Allocate a suitably sized data buffer (including space for control setup) 905bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * -# Call libusb_fill_control_setup() 906bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * -# If this is a host-to-device transfer with a data stage, put the data 907bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * in place after the setup packet 908bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * -# Call this function 909bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * -# Call libusb_submit_transfer() 910bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 911bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * It is also legal to pass a NULL buffer to this function, in which case this 912bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * function will not attempt to populate the length field. Remember that you 913bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * must then populate the buffer and length fields later. 914bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 915bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param transfer the transfer to populate 916bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param dev_handle handle of the device that will handle the transfer 917bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param buffer data buffer. If provided, this function will interpret the 918bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * first 8 bytes as a setup packet and infer the transfer length from that. 919bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param callback callback function to be invoked on transfer completion 920bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param user_data user data to pass to callback function 921bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param timeout timeout for the transfer in milliseconds 922bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 923bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevstatic inline void libusb_fill_control_transfer( 924bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev struct libusb_transfer *transfer, libusb_device_handle *dev_handle, 925bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev unsigned char *buffer, libusb_transfer_cb_fn callback, void *user_data, 926bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev unsigned int timeout) 927bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev{ 928bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev struct libusb_control_setup *setup = (struct libusb_control_setup *) buffer; 929bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->dev_handle = dev_handle; 930bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->endpoint = 0; 931bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->type = LIBUSB_TRANSFER_TYPE_CONTROL; 932bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->timeout = timeout; 933bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->buffer = buffer; 934bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev if (setup) 935bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->length = LIBUSB_CONTROL_SETUP_SIZE 936bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev + libusb_le16_to_cpu(setup->wLength); 937bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->user_data = user_data; 938bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->callback = callback; 939bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev} 940bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 941bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup asyncio 942bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Helper function to populate the required \ref libusb_transfer fields 943bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * for a bulk transfer. 944bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 945bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param transfer the transfer to populate 946bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param dev_handle handle of the device that will handle the transfer 947bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param endpoint address of the endpoint where this transfer will be sent 948bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param buffer data buffer 949bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param length length of data buffer 950bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param callback callback function to be invoked on transfer completion 951bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param user_data user data to pass to callback function 952bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param timeout timeout for the transfer in milliseconds 953bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 954bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevstatic inline void libusb_fill_bulk_transfer(struct libusb_transfer *transfer, 955bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev libusb_device_handle *dev_handle, unsigned char endpoint, 956bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev unsigned char *buffer, int length, libusb_transfer_cb_fn callback, 957bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev void *user_data, unsigned int timeout) 958bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev{ 959bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->dev_handle = dev_handle; 960bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->endpoint = endpoint; 961bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->type = LIBUSB_TRANSFER_TYPE_BULK; 962bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->timeout = timeout; 963bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->buffer = buffer; 964bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->length = length; 965bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->user_data = user_data; 966bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->callback = callback; 967bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev} 968bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 969bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup asyncio 970bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Helper function to populate the required \ref libusb_transfer fields 971bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * for an interrupt transfer. 972bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 973bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param transfer the transfer to populate 974bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param dev_handle handle of the device that will handle the transfer 975bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param endpoint address of the endpoint where this transfer will be sent 976bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param buffer data buffer 977bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param length length of data buffer 978bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param callback callback function to be invoked on transfer completion 979bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param user_data user data to pass to callback function 980bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param timeout timeout for the transfer in milliseconds 981bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 982bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevstatic inline void libusb_fill_interrupt_transfer( 983bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev struct libusb_transfer *transfer, libusb_device_handle *dev_handle, 984bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev unsigned char endpoint, unsigned char *buffer, int length, 985bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout) 986bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev{ 987bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->dev_handle = dev_handle; 988bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->endpoint = endpoint; 989bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->type = LIBUSB_TRANSFER_TYPE_INTERRUPT; 990bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->timeout = timeout; 991bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->buffer = buffer; 992bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->length = length; 993bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->user_data = user_data; 994bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->callback = callback; 995bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev} 996bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 997bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup asyncio 998bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Helper function to populate the required \ref libusb_transfer fields 999bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * for an isochronous transfer. 1000bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 1001bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param transfer the transfer to populate 1002bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param dev_handle handle of the device that will handle the transfer 1003bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param endpoint address of the endpoint where this transfer will be sent 1004bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param buffer data buffer 1005bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param length length of data buffer 1006bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param num_iso_packets the number of isochronous packets 1007bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param callback callback function to be invoked on transfer completion 1008bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param user_data user data to pass to callback function 1009bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param timeout timeout for the transfer in milliseconds 1010bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 1011bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevstatic inline void libusb_fill_iso_transfer(struct libusb_transfer *transfer, 1012bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev libusb_device_handle *dev_handle, unsigned char endpoint, 1013bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev unsigned char *buffer, int length, int num_iso_packets, 1014bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout) 1015bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev{ 1016bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->dev_handle = dev_handle; 1017bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->endpoint = endpoint; 1018bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->type = LIBUSB_TRANSFER_TYPE_ISOCHRONOUS; 1019bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->timeout = timeout; 1020bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->buffer = buffer; 1021bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->length = length; 1022bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->num_iso_packets = num_iso_packets; 1023bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->user_data = user_data; 1024bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->callback = callback; 1025bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev} 1026bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 1027bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup asyncio 1028bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Convenience function to set the length of all packets in an isochronous 1029bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * transfer, based on the num_iso_packets field in the transfer structure. 1030bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 1031bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param transfer a transfer 1032bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param length the length to set in each isochronous packet descriptor 1033bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \see libusb_get_max_packet_size() 1034bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 1035bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevstatic inline void libusb_set_iso_packet_lengths( 1036bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev struct libusb_transfer *transfer, unsigned int length) 1037bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev{ 1038bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev int i; 1039bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev for (i = 0; i < transfer->num_iso_packets; i++) 1040bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev transfer->iso_packet_desc[i].length = length; 1041bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev} 1042bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 1043bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup asyncio 1044bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Convenience function to locate the position of an isochronous packet 1045bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * within the buffer of an isochronous transfer. 1046bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 1047bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * This is a thorough function which loops through all preceding packets, 1048bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * accumulating their lengths to find the position of the specified packet. 1049bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Typically you will assign equal lengths to each packet in the transfer, 1050bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * and hence the above method is sub-optimal. You may wish to use 1051bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * libusb_get_iso_packet_buffer_simple() instead. 1052bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 1053bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param transfer a transfer 1054bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param packet the packet to return the address of 1055bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \returns the base address of the packet buffer inside the transfer buffer, 1056bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * or NULL if the packet does not exist. 1057bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \see libusb_get_iso_packet_buffer_simple() 1058bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 1059bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevstatic inline unsigned char *libusb_get_iso_packet_buffer( 1060bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev struct libusb_transfer *transfer, unsigned int packet) 1061bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev{ 1062bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev int i; 1063bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev size_t offset = 0; 1064bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev int _packet; 1065bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 1066bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /* oops..slight bug in the API. packet is an unsigned int, but we use 1067bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * signed integers almost everywhere else. range-check and convert to 1068bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * signed to avoid compiler warnings. FIXME for libusb-2. */ 1069bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev if (packet > INT_MAX) 1070bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev return NULL; 1071bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev _packet = packet; 1072bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 1073bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev if (_packet >= transfer->num_iso_packets) 1074bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev return NULL; 1075bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 1076bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev for (i = 0; i < _packet; i++) 1077bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev offset += transfer->iso_packet_desc[i].length; 1078bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 1079bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev return transfer->buffer + offset; 1080bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev} 1081bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 1082bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup asyncio 1083bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Convenience function to locate the position of an isochronous packet 1084bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * within the buffer of an isochronous transfer, for transfers where each 1085bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * packet is of identical size. 1086bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 1087bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * This function relies on the assumption that every packet within the transfer 1088bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * is of identical size to the first packet. Calculating the location of 1089bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * the packet buffer is then just a simple calculation: 1090bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * <tt>buffer + (packet_size * packet)</tt> 1091bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 1092bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Do not use this function on transfers other than those that have identical 1093bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * packet lengths for each packet. 1094bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 1095bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param transfer a transfer 1096bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param packet the packet to return the address of 1097bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \returns the base address of the packet buffer inside the transfer buffer, 1098bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * or NULL if the packet does not exist. 1099bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \see libusb_get_iso_packet_buffer() 1100bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 1101bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevstatic inline unsigned char *libusb_get_iso_packet_buffer_simple( 1102bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev struct libusb_transfer *transfer, unsigned int packet) 1103bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev{ 1104bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev int _packet; 1105bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 1106bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /* oops..slight bug in the API. packet is an unsigned int, but we use 1107bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * signed integers almost everywhere else. range-check and convert to 1108bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * signed to avoid compiler warnings. FIXME for libusb-2. */ 1109bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev if (packet > INT_MAX) 1110bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev return NULL; 1111bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev _packet = packet; 1112bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 1113bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev if (_packet >= transfer->num_iso_packets) 1114bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev return NULL; 1115bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 1116bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev return transfer->buffer + (transfer->iso_packet_desc[0].length * _packet); 1117bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev} 1118bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 1119bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/* sync I/O */ 1120bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 1121bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_control_transfer(libusb_device_handle *dev_handle, 1122bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t request_type, uint8_t request, uint16_t value, uint16_t index, 1123bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev unsigned char *data, uint16_t length, unsigned int timeout); 1124bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 1125bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_bulk_transfer(libusb_device_handle *dev_handle, 1126bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev unsigned char endpoint, unsigned char *data, int length, 1127bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev int *actual_length, unsigned int timeout); 1128bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 1129bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_interrupt_transfer(libusb_device_handle *dev_handle, 1130bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev unsigned char endpoint, unsigned char *data, int length, 1131bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev int *actual_length, unsigned int timeout); 1132bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 1133bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup desc 1134bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Retrieve a descriptor from the default control pipe. 1135bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * This is a convenience function which formulates the appropriate control 1136bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * message to retrieve the descriptor. 1137bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 1138bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param dev a device handle 1139bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param desc_type the descriptor type, see \ref libusb_descriptor_type 1140bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param desc_index the index of the descriptor to retrieve 1141bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param data output buffer for descriptor 1142bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param length size of data buffer 1143bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \returns number of bytes returned in data, or LIBUSB_ERROR code on failure 1144bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 1145bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevstatic inline int libusb_get_descriptor(libusb_device_handle *dev, 1146bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t desc_type, uint8_t desc_index, unsigned char *data, int length) 1147bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev{ 1148bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev return libusb_control_transfer(dev, LIBUSB_ENDPOINT_IN, 1149bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_REQUEST_GET_DESCRIPTOR, (desc_type << 8) | desc_index, 0, data, 1150bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev length, 1000); 1151bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev} 1152bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 1153bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup desc 1154bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Retrieve a descriptor from a device. 1155bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * This is a convenience function which formulates the appropriate control 1156bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * message to retrieve the descriptor. The string returned is Unicode, as 1157bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * detailed in the USB specifications. 1158bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * 1159bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param dev a device handle 1160bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param desc_index the index of the descriptor to retrieve 1161bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param langid the language ID for the string descriptor 1162bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param data output buffer for descriptor 1163bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param length size of data buffer 1164bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \returns number of bytes returned in data, or LIBUSB_ERROR code on failure 1165bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \see libusb_get_string_descriptor_ascii() 1166bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 1167bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevstatic inline int libusb_get_string_descriptor(libusb_device_handle *dev, 1168bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t desc_index, uint16_t langid, unsigned char *data, int length) 1169bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev{ 1170bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev return libusb_control_transfer(dev, LIBUSB_ENDPOINT_IN, 1171bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev LIBUSB_REQUEST_GET_DESCRIPTOR, (LIBUSB_DT_STRING << 8) | desc_index, 1172bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev langid, data, length, 1000); 1173bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev} 1174bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 1175bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_get_string_descriptor_ascii(libusb_device_handle *dev, 1176bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev uint8_t index, unsigned char *data, int length); 1177bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 1178bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/* polling and timeouts */ 1179bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 1180bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_try_lock_events(libusb_context *ctx); 1181bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevvoid libusb_lock_events(libusb_context *ctx); 1182bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevvoid libusb_unlock_events(libusb_context *ctx); 1183bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_event_handling_ok(libusb_context *ctx); 1184bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_event_handler_active(libusb_context *ctx); 1185bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevvoid libusb_lock_event_waiters(libusb_context *ctx); 1186bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevvoid libusb_unlock_event_waiters(libusb_context *ctx); 1187bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_wait_for_event(libusb_context *ctx, struct timeval *tv); 1188bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 1189bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_handle_events_timeout(libusb_context *ctx, struct timeval *tv); 1190bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_handle_events(libusb_context *ctx); 1191bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_handle_events_locked(libusb_context *ctx, struct timeval *tv); 1192bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_pollfds_handle_timeouts(libusb_context *ctx); 1193bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevint libusb_get_next_timeout(libusb_context *ctx, struct timeval *tv); 1194bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 1195bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup poll 1196bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * File descriptor for polling 1197bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 1198bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevstruct libusb_pollfd { 1199bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Numeric file descriptor */ 1200bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev int fd; 1201bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 1202bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev /** Event flags to poll for from <poll.h>. POLLIN indicates that you 1203bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * should monitor this file descriptor for becoming ready to read from, 1204bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * and POLLOUT indicates that you should monitor this file descriptor for 1205bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * nonblocking write readiness. */ 1206bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev short events; 1207bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev}; 1208bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 1209bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup poll 1210bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Callback function, invoked when a new file descriptor should be added 1211bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * to the set of file descriptors monitored for events. 1212bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param fd the new file descriptor 1213bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param events events to monitor for, see \ref libusb_pollfd for a 1214bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * description 1215bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param user_data User data pointer specified in 1216bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * libusb_set_pollfd_notifiers() call 1217bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \see libusb_set_pollfd_notifiers() 1218bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 1219bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevtypedef void (*libusb_pollfd_added_cb)(int fd, short events, void *user_data); 1220bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 1221bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev/** \ingroup poll 1222bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * Callback function, invoked when a file descriptor should be removed from 1223bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * the set of file descriptors being monitored for events. After returning 1224bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * from this callback, do not use that file descriptor again. 1225bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param fd the file descriptor to stop monitoring 1226bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \param user_data User data pointer specified in 1227bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * libusb_set_pollfd_notifiers() call 1228bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev * \see libusb_set_pollfd_notifiers() 1229bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev */ 1230bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevtypedef void (*libusb_pollfd_removed_cb)(int fd, void *user_data); 1231bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 1232bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevconst struct libusb_pollfd **libusb_get_pollfds(libusb_context *ctx); 1233bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishevvoid libusb_set_pollfd_notifiers(libusb_context *ctx, 1234bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb, 1235bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev void *user_data); 1236bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 1237bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev#ifdef __cplusplus 1238bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev} 1239bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev#endif 1240bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev 1241bda86ae8203fd360c4e87c310498da1e1e4c53a7Yavor Goulishev#endif 1242