1ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/* -*- Mode: C; indent-tabs-mode:t ; c-basic-offset:8 -*- */ 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* 3ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Core functions for libusbx 4ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Copyright © 2012-2013 Nathan Hjelm <hjelmn@cs.unm.edu> 5ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Copyright © 2007-2008 Daniel Drake <dsd@gentoo.org> 6ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Copyright © 2001 Johannes Erdfelt <johannes@erdfelt.com> 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This library is free software; you can redistribute it and/or 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * modify it under the terms of the GNU Lesser General Public 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * License as published by the Free Software Foundation; either 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * version 2.1 of the License, or (at your option) any later version. 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This library is distributed in the hope that it will be useful, 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * but WITHOUT ANY WARRANTY; without even the implied warranty of 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Lesser General Public License for more details. 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * You should have received a copy of the GNU Lesser General Public 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * License along with this library; if not, write to the Free Software 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 23ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#include "config.h" 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <errno.h> 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <stdarg.h> 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <stdio.h> 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <stdlib.h> 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string.h> 30ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#ifdef HAVE_SYS_TYPES_H 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <sys/types.h> 32ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#endif 33eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#ifdef HAVE_SYS_TIME_H 34eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#include <sys/time.h> 35eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#endif 36eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 37ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#ifdef __ANDROID__ 38ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#include <android/log.h> 39ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#endif 40ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "libusbi.h" 42ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#include "hotplug.h" 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(OS_LINUX) 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)const struct usbi_os_backend * const usbi_backend = &linux_usbfs_backend; 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#elif defined(OS_DARWIN) 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)const struct usbi_os_backend * const usbi_backend = &darwin_backend; 48eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#elif defined(OS_OPENBSD) 49eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdochconst struct usbi_os_backend * const usbi_backend = &openbsd_backend; 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#elif defined(OS_WINDOWS) 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)const struct usbi_os_backend * const usbi_backend = &windows_backend; 52ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#elif defined(OS_WINCE) 53ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochconst struct usbi_os_backend * const usbi_backend = &wince_backend; 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#else 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#error "Unsupported OS" 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct libusb_context *usbi_default_context = NULL; 59ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochconst struct libusb_version libusb_version_internal = 60ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch { LIBUSB_MAJOR, LIBUSB_MINOR, LIBUSB_MICRO, LIBUSB_NANO, 61ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_RC, "http://libusbx.org" }; 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)static int default_context_refcnt = 0; 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)static usbi_mutex_static_t default_context_lock = USBI_MUTEX_INITIALIZER; 64ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochstatic struct timeval timestamp_origin = { 0, 0 }; 65ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 66ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochusbi_mutex_static_t active_contexts_lock = USBI_MUTEX_INITIALIZER; 67ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochstruct list_head active_contexts_list; 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** 70ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \mainpage libusbx-1.0 API Reference 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \section intro Introduction 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 74ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * libusbx is an open source library that allows you to communicate with USB 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * devices from userspace. For more info, see the 76ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * <a href="http://libusbx.org">libusbx homepage</a>. 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This documentation is aimed at application developers wishing to 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * communicate with USB peripherals from their own software. After reviewing 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * this documentation, feedback and questions can be sent to the 81ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * <a href="http://mailing-list.libusbx.org">libusbx-devel mailing list</a>. 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This documentation assumes knowledge of how to operate USB devices from 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * a software standpoint (descriptors, configurations, interfaces, endpoints, 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * control/bulk/interrupt/isochronous transfers, etc). Full information 86ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * can be found in the <a href="http://www.usb.org/developers/docs/">USB 3.0 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Specification</a> which is available for free download. You can probably 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * find less verbose introductions by searching the web. 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \section features Library features 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * - All transfer types supported (control/bulk/interrupt/isochronous) 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * - 2 transfer interfaces: 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * -# Synchronous (simple) 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * -# Asynchronous (more complicated, but more powerful) 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * - Thread safe (although the asynchronous interface means that you 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * usually won't need to thread) 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * - Lightweight with lean API 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * - Compatible with libusb-0.1 through the libusb-compat-0.1 translation layer 100ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * - Hotplug support (on some platforms). See \ref hotplug. 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \section gettingstarted Getting Started 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * To begin reading the API documentation, start with the Modules page which 105ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * links to the different categories of libusbx's functionality. 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * One decision you will have to make is whether to use the synchronous 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * or the asynchronous data transfer interface. The \ref io documentation 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * provides some insight into this topic. 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 111ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Some example programs can be found in the libusbx source distribution under 112ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * the "examples" subdirectory. The libusbx homepage includes a list of 113ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * real-life project examples which use libusbx. 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \section errorhandling Error handling 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 117ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * libusbx functions typically return 0 on success or a negative error code 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * on failure. These negative error codes relate to LIBUSB_ERROR constants 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * which are listed on the \ref misc "miscellaneous" documentation page. 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \section msglog Debug message logging 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 123ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * libusbx uses stderr for all logging. By default, logging is set to NONE, 124ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * which means that no output will be produced. However, unless the library 125ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * has been compiled with logging disabled, then any application calls to 126ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * libusb_set_debug(), or the setting of the environmental variable 127ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * LIBUSB_DEBUG outside of the application, can result in logging being 128ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * produced. Your application should therefore not close stderr, but instead 129ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * direct it to the null device if its output is undesireable. 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 131ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * The libusb_set_debug() function can be used to enable logging of certain 132ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * messages. Under standard configuration, libusbx doesn't really log much 133ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * so you are advised to use this function to enable all error/warning/ 134ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * informational messages. It will help debug problems with your software. 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * The logged messages are unstructured. There is no one-to-one correspondence 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * between messages being logged and success or failure return codes from 138ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * libusbx functions. There is no format to the messages, so you should not 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * try to capture or parse them. They are not and will not be localized. 140ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * These messages are not intended to being passed to your application user; 141ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * instead, you should interpret the error codes returned from libusbx functions 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * and provide appropriate notification to the user. The messages are simply 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * there to aid you as a programmer, and if you're confused because you're 144ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * getting a strange error code from a libusbx function, enabling message 1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * logging may give you a suitable explanation. 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * The LIBUSB_DEBUG environment variable can be used to enable message logging 148ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * at run-time. This environment variable should be set to a log level number, 149ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * which is interpreted the same as the libusb_set_debug() parameter. When this 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * environment variable is set, the message logging verbosity level is fixed 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * and libusb_set_debug() effectively does nothing. 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 153ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * libusbx can be compiled without any logging functions, useful for embedded 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * systems. In this case, libusb_set_debug() and the LIBUSB_DEBUG environment 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * variable have no effects. 1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 157ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * libusbx can also be compiled with verbose debugging messages always. When 158ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * the library is compiled in this way, all messages of all verbosities are 159ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * always logged. libusb_set_debug() and the LIBUSB_DEBUG environment variable 160ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * have no effects. 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \section remarks Other remarks 1635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 164ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * libusbx does have imperfections. The \ref caveats "caveats" page attempts 1655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * to document these. 1665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 1675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** 1695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \page caveats Caveats 1705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 1715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \section devresets Device resets 1725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 1735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * The libusb_reset_device() function allows you to reset a device. If your 1745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * program has to call such a function, it should obviously be aware that 1755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * the reset will cause device state to change (e.g. register values may be 1765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * reset). 1775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 1785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * The problem is that any other program could reset the device your program 179ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * is working with, at any time. libusbx does not offer a mechanism to inform 1805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * you when this has happened, so if someone else resets your device it will 1815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * not be clear to your own program why the device state has changed. 1825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 1835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Ultimately, this is a limitation of writing drivers in userspace. 1845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Separation from the USB stack in the underlying kernel makes it difficult 1855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * for the operating system to deliver such notifications to your program. 1865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * The Linux kernel USB stack allows such reset notifications to be delivered 1875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * to in-kernel USB drivers, but it is not clear how such notifications could 1885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * be delivered to second-class drivers that live in userspace. 1895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 1905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \section blockonly Blocking-only functionality 1915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 1925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * The functionality listed below is only available through synchronous, 1935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * blocking functions. There are no asynchronous/non-blocking alternatives, 1945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * and no clear ways of implementing these. 1955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 1965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * - Configuration activation (libusb_set_configuration()) 1975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * - Interface/alternate setting activation (libusb_set_interface_alt_setting()) 1985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * - Releasing of interfaces (libusb_release_interface()) 1995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * - Clearing of halt/stall condition (libusb_clear_halt()) 2005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * - Device resets (libusb_reset_device()) 2015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 2025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \section configsel Configuration selection and handling 2035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 204ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * When libusbx presents a device handle to an application, there is a chance 2055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * that the corresponding device may be in unconfigured state. For devices 2065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * with multiple configurations, there is also a chance that the configuration 2075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * currently selected is not the one that the application wants to use. 2085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 2095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * The obvious solution is to add a call to libusb_set_configuration() early 2105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * on during your device initialization routines, but there are caveats to 2115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * be aware of: 2125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * -# If the device is already in the desired configuration, calling 2135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * libusb_set_configuration() using the same configuration value will cause 2145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * a lightweight device reset. This may not be desirable behaviour. 215ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * -# libusbx will be unable to change configuration if the device is in 2165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * another configuration and other programs or drivers have claimed 2175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * interfaces under that configuration. 218ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * -# In the case where the desired configuration is already active, libusbx 2195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * may not even be able to perform a lightweight device reset. For example, 2205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * take my USB keyboard with fingerprint reader: I'm interested in driving 221ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * the fingerprint reader interface through libusbx, but the kernel's 2225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * USB-HID driver will almost always have claimed the keyboard interface. 2235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Because the kernel has claimed an interface, it is not even possible to 2245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * perform the lightweight device reset, so libusb_set_configuration() will 2255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * fail. (Luckily the device in question only has a single configuration.) 2265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 2275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * One solution to some of the above problems is to consider the currently 2285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * active configuration. If the configuration we want is already active, then 2295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * we don't have to select any configuration: 2305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)\code 2315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)cfg = libusb_get_configuration(dev); 2325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)if (cfg != desired) 2335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) libusb_set_configuration(dev, desired); 2345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)\endcode 2355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 2365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This is probably suitable for most scenarios, but is inherently racy: 2375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * another application or driver may change the selected configuration 2385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * <em>after</em> the libusb_get_configuration() call. 2395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 2405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Even in cases where libusb_set_configuration() succeeds, consider that other 2415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * applications or drivers may change configuration after your application 2425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * calls libusb_set_configuration(). 2435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 2445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * One possible way to lock your device into a specific configuration is as 2455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * follows: 2465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * -# Set the desired configuration (or use the logic above to realise that 2475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * it is already in the desired configuration) 2485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * -# Claim the interface that you wish to use 2495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * -# Check that the currently active configuration is the one that you want 2505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * to use. 2515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 2525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * The above method works because once an interface is claimed, no application 2535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * or driver is able to select another configuration. 2545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 2555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \section earlycomp Early transfer completion 2565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 2575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * NOTE: This section is currently Linux-centric. I am not sure if any of these 2585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * considerations apply to Darwin or other platforms. 2595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 2605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * When a transfer completes early (i.e. when less data is received/sent in 261ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * any one packet than the transfer buffer allows for) then libusbx is designed 2625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * to terminate the transfer immediately, not transferring or receiving any 2635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * more data unless other transfers have been queued by the user. 2645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 265ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * On legacy platforms, libusbx is unable to do this in all situations. After 266ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * the incomplete packet occurs, "surplus" data may be transferred. For recent 267ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * versions of libusbx, this information is kept (the data length of the 268ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * transfer is updated) and, for device-to-host transfers, any surplus data was 269ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * added to the buffer. Still, this is not a nice solution because it loses the 270ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * information about the end of the short packet, and the user probably wanted 271ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * that surplus data to arrive in the next logical transfer. 272ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 273eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * 274eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * \section zlp Zero length packets 275eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * 276ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * - libusbx is able to send a packet of zero length to an endpoint simply by 277ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * submitting a transfer of zero length. 278eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * - The \ref libusb_transfer_flags::LIBUSB_TRANSFER_ADD_ZERO_PACKET 279eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * "LIBUSB_TRANSFER_ADD_ZERO_PACKET" flag is currently only supported on Linux. 2805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 2815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** 2835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \page contexts Contexts 2845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 285ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * It is possible that libusbx may be used simultaneously from two independent 2865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * libraries linked into the same executable. For example, if your application 2875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * has a plugin-like system which allows the user to dynamically load a range 2885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * of modules into your program, it is feasible that two independently 289ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * developed modules may both use libusbx. 2905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 291ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * libusbx is written to allow for these multiple user scenarios. The two 292ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * "instances" of libusbx will not interfere: libusb_set_debug() calls 2935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * from one user will not affect the same settings for other users, other 294ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * users can continue using libusbx after one of them calls libusb_exit(), etc. 2955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 296ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * This is made possible through libusbx's <em>context</em> concept. When you 2975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * call libusb_init(), you are (optionally) given a context. You can then pass 298ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * this context pointer back into future libusbx functions. 2995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 3005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * In order to keep things simple for more simplistic applications, it is 3015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * legal to pass NULL to all functions requiring a context pointer (as long as 302ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * you're sure no other code will attempt to use libusbx from the same process). 3035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * When you pass NULL, the default context will be used. The default context 3045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * is created the first time a process calls libusb_init() when no other 3055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * context is alive. Contexts are destroyed during libusb_exit(). 3065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 3075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * The default context is reference-counted and can be shared. That means that 3085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * if libusb_init(NULL) is called twice within the same process, the two 3095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * users end up sharing the same context. The deinitialization and freeing of 3105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * the default context will only happen when the last user calls libusb_exit(). 3115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * In other words, the default context is created and initialized when its 3125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * reference count goes from 0 to 1, and is deinitialized and destroyed when 3135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * its reference count goes from 1 to 0. 3145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 315ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * You may be wondering why only a subset of libusbx functions require a 316ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * context pointer in their function definition. Internally, libusbx stores 3175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * context pointers in other objects (e.g. libusb_device instances) and hence 3185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * can infer the context from those objects. 3195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 3205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** 3225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * @defgroup lib Library initialization/deinitialization 323ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * This page details how to initialize and deinitialize libusbx. Initialization 324ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * must be performed before using any libusbx functionality, and similarly you 325ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * must not call any libusbx functions after deinitialization. 3265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 3275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** 3295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * @defgroup dev Device handling and enumeration 3305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * The functionality documented below is designed to help with the following 3315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * operations: 3325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * - Enumerating the USB devices currently attached to the system 3335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * - Choosing a device to operate from your software 3345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * - Opening and closing the chosen device 3355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 3365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \section nutshell In a nutshell... 3375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 3385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * The description below really makes things sound more complicated than they 3395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * actually are. The following sequence of function calls will be suitable 3405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * for almost all scenarios and does not require you to have such a deep 3415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * understanding of the resource management issues: 3425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \code 3435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// discover devices 3445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)libusb_device **list; 3455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)libusb_device *found = NULL; 3465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)ssize_t cnt = libusb_get_device_list(NULL, &list); 3475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)ssize_t i = 0; 3485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int err = 0; 3495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)if (cnt < 0) 3505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) error(); 3515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)for (i = 0; i < cnt; i++) { 3535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) libusb_device *device = list[i]; 3545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (is_interesting(device)) { 3555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) found = device; 3565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) break; 3575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 3595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)if (found) { 3615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) libusb_device_handle *handle; 3625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) err = libusb_open(found, &handle); 3645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (err) 3655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) error(); 3665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // etc 3675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 3685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)libusb_free_device_list(list, 1); 3705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)\endcode 3715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 3725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * The two important points: 3735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * - You asked libusb_free_device_list() to unreference the devices (2nd 3745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * parameter) 3755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * - You opened the device before freeing the list and unreferencing the 3765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * devices 3775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 3785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * If you ended up with a handle, you can now proceed to perform I/O on the 3795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * device. 3805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 3815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \section devshandles Devices and device handles 382ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * libusbx has a concept of a USB device, represented by the 3835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_device opaque type. A device represents a USB device that 3845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * is currently or was previously connected to the system. Using a reference 3855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * to a device, you can determine certain information about the device (e.g. 3865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * you can read the descriptor data). 3875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 3885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * The libusb_get_device_list() function can be used to obtain a list of 3895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * devices currently connected to the system. This is known as device 3905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * discovery. 3915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 3925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Just because you have a reference to a device does not mean it is 3935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * necessarily usable. The device may have been unplugged, you may not have 3945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * permission to operate such device, or another program or driver may be 3955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * using the device. 3965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 3975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * When you've found a device that you'd like to operate, you must ask 398ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * libusbx to open the device using the libusb_open() function. Assuming 399ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * success, libusbx then returns you a <em>device handle</em> 4005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * (a \ref libusb_device_handle pointer). All "real" I/O operations then 4015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * operate on the handle rather than the original device pointer. 4025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 4035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \section devref Device discovery and reference counting 4045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 4055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Device discovery (i.e. calling libusb_get_device_list()) returns a 4065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * freshly-allocated list of devices. The list itself must be freed when 407ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * you are done with it. libusbx also needs to know when it is OK to free 4085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * the contents of the list - the devices themselves. 4095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 410ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * To handle these issues, libusbx provides you with two separate items: 4115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * - A function to free the list itself 4125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * - A reference counting system for the devices inside 4135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 4145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * New devices presented by the libusb_get_device_list() function all have a 4155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * reference count of 1. You can increase and decrease reference count using 4165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * libusb_ref_device() and libusb_unref_device(). A device is destroyed when 4175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * its reference count reaches 0. 4185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 4195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * With the above information in mind, the process of opening a device can 4205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * be viewed as follows: 4215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * -# Discover devices using libusb_get_device_list(). 4225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * -# Choose the device that you want to operate, and call libusb_open(). 4235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * -# Unref all devices in the discovered device list. 4245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * -# Free the discovered device list. 4255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 4265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * The order is important - you must not unreference the device before 4275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * attempting to open it, because unreferencing it may destroy the device. 4285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 4295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * For convenience, the libusb_free_device_list() function includes a 4305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * parameter to optionally unreference all the devices in the list before 4315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * freeing the list itself. This combines steps 3 and 4 above. 4325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 4335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * As an implementation detail, libusb_open() actually adds a reference to 4345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * the device in question. This is because the device remains available 4355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * through the handle via libusb_get_device(). The reference is deleted during 4365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * libusb_close(). 4375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 4385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** @defgroup misc Miscellaneous */ 4405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* we traverse usbfs without knowing how many devices we are going to find. 4425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * so we create this discovered_devs model which is similar to a linked-list 4435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * which grows when required. it can be freed once discovery has completed, 4445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * eliminating the need for a list node in the libusb_device structure 4455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * itself. */ 4465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DISCOVERED_DEVICES_SIZE_STEP 8 4475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)static struct discovered_devs *discovered_devs_alloc(void) 4495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 4505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct discovered_devs *ret = 4515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) malloc(sizeof(*ret) + (sizeof(void *) * DISCOVERED_DEVICES_SIZE_STEP)); 4525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (ret) { 4545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ret->len = 0; 4555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ret->capacity = DISCOVERED_DEVICES_SIZE_STEP; 4565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 4575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return ret; 4585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 4595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* append a device to the discovered devices collection. may realloc itself, 4615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * returning new discdevs. returns NULL on realloc failure. */ 4625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct discovered_devs *discovered_devs_append( 4635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct discovered_devs *discdevs, struct libusb_device *dev) 4645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 4655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t len = discdevs->len; 4665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t capacity; 4675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* if there is space, just append the device */ 4695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (len < discdevs->capacity) { 4705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) discdevs->devices[len] = libusb_ref_device(dev); 4715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) discdevs->len++; 4725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return discdevs; 4735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 4745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* exceeded capacity, need to grow */ 4765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_dbg("need to increase capacity"); 4775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) capacity = discdevs->capacity + DISCOVERED_DEVICES_SIZE_STEP; 478ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch discdevs = usbi_reallocf(discdevs, 4795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) sizeof(*discdevs) + (sizeof(void *) * capacity)); 4805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (discdevs) { 4815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) discdevs->capacity = capacity; 4825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) discdevs->devices[len] = libusb_ref_device(dev); 4835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) discdevs->len++; 4845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 4855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return discdevs; 4875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 4885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)static void discovered_devs_free(struct discovered_devs *discdevs) 4905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 4915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t i; 4925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for (i = 0; i < discdevs->len; i++) 4945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) libusb_unref_device(discdevs->devices[i]); 4955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) free(discdevs); 4975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 4985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* Allocate a new device with a specific session ID. The returned device has 5005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * a reference count of 1. */ 5015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct libusb_device *usbi_alloc_device(struct libusb_context *ctx, 5025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned long session_id) 5035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 5045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t priv_size = usbi_backend->device_priv_size; 5055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_device *dev = calloc(1, sizeof(*dev) + priv_size); 5065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int r; 5075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!dev) 5095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return NULL; 5105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) r = usbi_mutex_init(&dev->lock, NULL); 5125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (r) { 5135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) free(dev); 5145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return NULL; 5155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 5165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) dev->ctx = ctx; 5185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) dev->refcnt = 1; 5195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) dev->session_data = session_id; 5205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) dev->speed = LIBUSB_SPEED_UNKNOWN; 521ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 522ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (!libusb_has_capability(LIBUSB_CAP_HAS_HOTPLUG)) { 523ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_connect_device (dev); 524ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch } 525ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 526ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return dev; 527ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch} 528ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 529ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochvoid usbi_connect_device(struct libusb_device *dev) 530ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch{ 531ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch libusb_hotplug_message message; 532ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch ssize_t ret; 533ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 534ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch memset(&message, 0, sizeof(message)); 535ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch message.event = LIBUSB_HOTPLUG_EVENT_DEVICE_ARRIVED; 536ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch message.device = dev; 537ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch dev->attached = 1; 538ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 539ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_mutex_lock(&dev->ctx->usb_devs_lock); 540ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch list_add(&dev->list, &dev->ctx->usb_devs); 541ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_mutex_unlock(&dev->ctx->usb_devs_lock); 542ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 543ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /* Signal that an event has occurred for this device if we support hotplug AND 544ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * the hotplug pipe is ready. This prevents an event from getting raised during 545ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * initial enumeration. */ 546ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (libusb_has_capability(LIBUSB_CAP_HAS_HOTPLUG) && dev->ctx->hotplug_pipe[1] > 0) { 547ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch ret = usbi_write(dev->ctx->hotplug_pipe[1], &message, sizeof(message)); 548ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (sizeof (message) != ret) { 549ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_err(DEVICE_CTX(dev), "error writing hotplug message"); 550ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch } 551ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch } 552ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch} 553ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 554ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochvoid usbi_disconnect_device(struct libusb_device *dev) 555ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch{ 556ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch libusb_hotplug_message message; 557ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch struct libusb_context *ctx = dev->ctx; 558ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch ssize_t ret; 559ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 560ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch memset(&message, 0, sizeof(message)); 561ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch message.event = LIBUSB_HOTPLUG_EVENT_DEVICE_LEFT; 562ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch message.device = dev; 563ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_mutex_lock(&dev->lock); 564ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch dev->attached = 0; 565ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_mutex_unlock(&dev->lock); 566ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 567ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /* Signal that an event has occurred for this device if we support hotplug AND 568ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * the hotplug pipe is ready. This prevents an event from getting raised during 569ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * initial enumeration. libusb_handle_events will take care of dereferencing the 570ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * device. */ 571ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (libusb_has_capability(LIBUSB_CAP_HAS_HOTPLUG) && dev->ctx->hotplug_pipe[1] > 0) { 572ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch ret = usbi_write(dev->ctx->hotplug_pipe[1], &message, sizeof(message)); 573ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (sizeof(message) != ret) { 574ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_err(DEVICE_CTX(dev), "error writing hotplug message"); 575ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch } 576ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch } 5775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_lock(&ctx->usb_devs_lock); 579ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch list_del(&dev->list); 5805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_unlock(&ctx->usb_devs_lock); 5815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 5825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* Perform some final sanity checks on a newly discovered device. If this 5845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * function fails (negative return code), the device should not be added 5855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * to the discovered device list. */ 5865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int usbi_sanitize_device(struct libusb_device *dev) 5875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 5885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int r; 5895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t num_configurations; 5905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 591ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch r = usbi_device_cache_descriptor(dev); 5925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (r < 0) 5935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return r; 5945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 595ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch num_configurations = dev->device_descriptor.bNumConfigurations; 5965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (num_configurations > USB_MAXCONFIG) { 5975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_err(DEVICE_CTX(dev), "too many configurations"); 5985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return LIBUSB_ERROR_IO; 5995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } else if (0 == num_configurations) 6005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_dbg("zero configurations, maybe an unauthorized device"); 6015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) dev->num_configurations = num_configurations; 6035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return 0; 6045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 6055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 606ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/* Examine libusbx's internal list of known devices, looking for one with 6075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * a specific session ID. Returns the matching device if it was found, and 6085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * NULL otherwise. */ 6095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct libusb_device *usbi_get_device_by_session_id(struct libusb_context *ctx, 6105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned long session_id) 6115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 6125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_device *dev; 6135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_device *ret = NULL; 6145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_lock(&ctx->usb_devs_lock); 6165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) list_for_each_entry(dev, &ctx->usb_devs, list, struct libusb_device) 6175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (dev->session_data == session_id) { 6185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ret = dev; 6195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) break; 6205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 6215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_unlock(&ctx->usb_devs_lock); 6225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return ret; 6245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 6255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** @ingroup dev 6275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Returns a list of USB devices currently attached to the system. This is 6285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * your entry point into finding a USB device to operate. 6295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 6305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * You are expected to unreference all the devices when you are done with 6315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * them, and then free the list with libusb_free_device_list(). Note that 6325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * libusb_free_device_list() can unref all the devices for you. Be careful 6335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * not to unreference a device you are about to open until after you have 6345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * opened it. 6355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 6365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This return value of this function indicates the number of devices in 6375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * the resultant list. The list is actually one element larger, as it is 6385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * NULL-terminated. 6395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 6405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param ctx the context to operate on, or NULL for the default context 6415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param list output location for a list of devices. Must be later freed with 6425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * libusb_free_device_list(). 643ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \returns the number of devices in the outputted list, or any 6445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_error according to errors encountered by the backend. 6455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 6465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)ssize_t API_EXPORTED libusb_get_device_list(libusb_context *ctx, 6475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) libusb_device ***list) 6485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 6495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct discovered_devs *discdevs = discovered_devs_alloc(); 6505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_device **ret; 6515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int r = 0; 6525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ssize_t i, len; 6535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) USBI_GET_CONTEXT(ctx); 6545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_dbg(""); 6555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!discdevs) 6575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return LIBUSB_ERROR_NO_MEM; 6585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 659ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (libusb_has_capability(LIBUSB_CAP_HAS_HOTPLUG)) { 660ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /* backend provides hotplug support */ 661ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch struct libusb_device *dev; 662ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 663ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (usbi_backend->hotplug_poll) 664ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_backend->hotplug_poll(); 665ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 666ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_mutex_lock(&ctx->usb_devs_lock); 667ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch list_for_each_entry(dev, &ctx->usb_devs, list, struct libusb_device) { 668ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch discdevs = discovered_devs_append(discdevs, dev); 669ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 670ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (!discdevs) { 671ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch r = LIBUSB_ERROR_NO_MEM; 672ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch break; 673ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch } 674ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch } 675ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_mutex_unlock(&ctx->usb_devs_lock); 676ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch } else { 677ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /* backend does not provide hotplug support */ 678ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch r = usbi_backend->get_device_list(ctx, &discdevs); 679ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch } 680ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 6815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (r < 0) { 6825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) len = r; 6835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) goto out; 6845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 6855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* convert discovered_devs into a list */ 6875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) len = discdevs->len; 688ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch ret = calloc(len + 1, sizeof(struct libusb_device *)); 6895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!ret) { 6905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) len = LIBUSB_ERROR_NO_MEM; 6915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) goto out; 6925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 6935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ret[len] = NULL; 6955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for (i = 0; i < len; i++) { 6965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_device *dev = discdevs->devices[i]; 6975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ret[i] = libusb_ref_device(dev); 6985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 6995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) *list = ret; 7005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)out: 7025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) discovered_devs_free(discdevs); 7035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return len; 7045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 7055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup dev 7075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Frees a list of devices previously discovered using 7085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * libusb_get_device_list(). If the unref_devices parameter is set, the 7095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * reference count of each device in the list is decremented by 1. 7105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param list the list to free 7115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param unref_devices whether to unref the devices in the list 7125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 7135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void API_EXPORTED libusb_free_device_list(libusb_device **list, 7145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int unref_devices) 7155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 7165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!list) 7175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return; 7185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (unref_devices) { 7205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int i = 0; 7215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_device *dev; 7225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) while ((dev = list[i++]) != NULL) 7245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) libusb_unref_device(dev); 7255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 7265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) free(list); 7275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 7285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup dev 7305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Get the number of the bus that a device is connected to. 7315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param dev a device 7325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns the bus number 7335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 7345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)uint8_t API_EXPORTED libusb_get_bus_number(libusb_device *dev) 7355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 7365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return dev->bus_number; 7375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 7385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup dev 740ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Get the number of the port that a device is connected to. 741ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Unless the OS does something funky, or you are hot-plugging USB extension cards, 742ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * the port number returned by this call is usually guaranteed to be uniquely tied 743ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * to a physical port, meaning that different devices plugged on the same physical 744ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * port should return the same port number. 745ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 746ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * But outside of this, there is no guarantee that the port number returned by this 747ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * call will remain the same, or even match the order in which ports have been 748ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * numbered by the HUB/HCD manufacturer. 749ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 750ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \param dev a device 751ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \returns the port number (0 if not available) 752ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch */ 753ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochuint8_t API_EXPORTED libusb_get_port_number(libusb_device *dev) 754ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch{ 755ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return dev->port_number; 756ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch} 757ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 758ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/** \ingroup dev 759ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Get the list of all port numbers from root for the specified device 760ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 761ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Since version 1.0.16, \ref LIBUSBX_API_VERSION >= 0x01000102 762ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \param dev a device 763ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \param port_numbers the array that should contain the port numbers 764ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \param port_numbers_len the maximum length of the array. As per the USB 3.0 765ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * specs, the current maximum limit for the depth is 7. 766ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \returns the number of elements filled 767ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \returns LIBUSB_ERROR_OVERFLOW if the array is too small 768ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch */ 769ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochint API_EXPORTED libusb_get_port_numbers(libusb_device *dev, 770ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint8_t* port_numbers, int port_numbers_len) 771ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch{ 772ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch int i = port_numbers_len; 773ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 774ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch while(dev) { 775ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch // HCDs can be listed as devices and would have port #0 776ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch // TODO: see how the other backends want to implement HCDs as parents 777ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (dev->port_number == 0) 778ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch break; 779ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch i--; 780ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (i < 0) { 781ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_warn(DEVICE_CTX(dev), 782ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch "port numbers array too small"); 783ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return LIBUSB_ERROR_OVERFLOW; 784ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch } 785ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch port_numbers[i] = dev->port_number; 786ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch dev = dev->parent_dev; 787ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch } 788ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch memmove(port_numbers, &port_numbers[i], port_numbers_len - i); 789ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return port_numbers_len - i; 790ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch} 791ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 792ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/** \ingroup dev 793ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Deprecated please use libusb_get_port_numbers instead. 794ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch */ 795ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochint API_EXPORTED libusb_get_port_path(libusb_context *ctx, libusb_device *dev, 796ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint8_t* port_numbers, uint8_t port_numbers_len) 797ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch{ 798ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch UNUSED(ctx); 799ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 800ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return libusb_get_port_numbers(dev, port_numbers, port_numbers_len); 801ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch} 802ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 803ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/** \ingroup dev 804ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Get the the parent from the specified device. 805ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \param dev a device 806ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \returns the device parent or NULL if not available 807ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * You should issue a \ref libusb_get_device_list() before calling this 808ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * function and make sure that you only access the parent before issuing 809ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \ref libusb_free_device_list(). The reason is that libusbx currently does 810ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * not maintain a permanent list of device instances, and therefore can 811ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * only guarantee that parents are fully instantiated within a 812ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * libusb_get_device_list() - libusb_free_device_list() block. 813ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch */ 814ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben MurdochDEFAULT_VISIBILITY 815ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochlibusb_device * LIBUSB_CALL libusb_get_parent(libusb_device *dev) 816ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch{ 817ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return dev->parent_dev; 818ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch} 819ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 820ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/** \ingroup dev 8215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Get the address of the device on the bus it is connected to. 8225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param dev a device 8235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns the device address 8245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 8255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)uint8_t API_EXPORTED libusb_get_device_address(libusb_device *dev) 8265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 8275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return dev->device_address; 8285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 8295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup dev 8315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Get the negotiated connection speed for a device. 8325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param dev a device 8335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns a \ref libusb_speed code, where LIBUSB_SPEED_UNKNOWN means that 8345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * the OS doesn't know or doesn't support returning the negotiated speed. 8355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 8365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int API_EXPORTED libusb_get_device_speed(libusb_device *dev) 8375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 8385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return dev->speed; 8395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 8405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)static const struct libusb_endpoint_descriptor *find_endpoint( 8425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_config_descriptor *config, unsigned char endpoint) 8435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 8445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int iface_idx; 8455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for (iface_idx = 0; iface_idx < config->bNumInterfaces; iface_idx++) { 8465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const struct libusb_interface *iface = &config->interface[iface_idx]; 8475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int altsetting_idx; 8485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for (altsetting_idx = 0; altsetting_idx < iface->num_altsetting; 8505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) altsetting_idx++) { 8515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const struct libusb_interface_descriptor *altsetting 8525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) = &iface->altsetting[altsetting_idx]; 8535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int ep_idx; 8545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for (ep_idx = 0; ep_idx < altsetting->bNumEndpoints; ep_idx++) { 8565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const struct libusb_endpoint_descriptor *ep = 8575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) &altsetting->endpoint[ep_idx]; 8585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (ep->bEndpointAddress == endpoint) 8595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return ep; 8605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 8615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 8625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 8635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return NULL; 8645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 8655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup dev 8675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Convenience function to retrieve the wMaxPacketSize value for a particular 8685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * endpoint in the active device configuration. 8695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 8705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This function was originally intended to be of assistance when setting up 8715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * isochronous transfers, but a design mistake resulted in this function 8725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * instead. It simply returns the wMaxPacketSize value without considering 8735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * its contents. If you're dealing with isochronous transfers, you probably 8745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * want libusb_get_max_iso_packet_size() instead. 8755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 8765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param dev a device 8775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param endpoint address of the endpoint in question 8785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns the wMaxPacketSize value 8795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_NOT_FOUND if the endpoint does not exist 8805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_OTHER on other failure 8815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 8825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int API_EXPORTED libusb_get_max_packet_size(libusb_device *dev, 8835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned char endpoint) 8845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 8855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_config_descriptor *config; 8865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const struct libusb_endpoint_descriptor *ep; 8875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int r; 8885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) r = libusb_get_active_config_descriptor(dev, &config); 8905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (r < 0) { 8915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_err(DEVICE_CTX(dev), 8925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) "could not retrieve active config descriptor"); 8935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return LIBUSB_ERROR_OTHER; 8945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 8955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ep = find_endpoint(config, endpoint); 8975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!ep) 8985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return LIBUSB_ERROR_NOT_FOUND; 8995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) r = ep->wMaxPacketSize; 9015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) libusb_free_config_descriptor(config); 9025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return r; 9035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 9045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup dev 9065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Calculate the maximum packet size which a specific endpoint is capable is 9075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * sending or receiving in the duration of 1 microframe 9085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 909ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Only the active configuration is examined. The calculation is based on the 9105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * wMaxPacketSize field in the endpoint descriptor as described in section 9115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 9.6.6 in the USB 2.0 specifications. 9125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 9135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * If acting on an isochronous or interrupt endpoint, this function will 9145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * multiply the value found in bits 0:10 by the number of transactions per 9155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * microframe (determined by bits 11:12). Otherwise, this function just 9165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * returns the numeric value found in bits 0:10. 9175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 9185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This function is useful for setting up isochronous transfers, for example 9195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * you might pass the return value from this function to 9205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * libusb_set_iso_packet_lengths() in order to set the length field of every 9215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * isochronous packet in a transfer. 9225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 9235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Since v1.0.3. 9245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 9255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param dev a device 9265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param endpoint address of the endpoint in question 9275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns the maximum packet size which can be sent/received on this endpoint 9285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_NOT_FOUND if the endpoint does not exist 9295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_OTHER on other failure 9305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 9315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int API_EXPORTED libusb_get_max_iso_packet_size(libusb_device *dev, 9325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned char endpoint) 9335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 9345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_config_descriptor *config; 9355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const struct libusb_endpoint_descriptor *ep; 9365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum libusb_transfer_type ep_type; 9375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint16_t val; 9385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int r; 9395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) r = libusb_get_active_config_descriptor(dev, &config); 9415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (r < 0) { 9425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_err(DEVICE_CTX(dev), 9435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) "could not retrieve active config descriptor"); 9445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return LIBUSB_ERROR_OTHER; 9455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 9465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ep = find_endpoint(config, endpoint); 9485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!ep) 9495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return LIBUSB_ERROR_NOT_FOUND; 9505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) val = ep->wMaxPacketSize; 952ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch ep_type = (enum libusb_transfer_type) (ep->bmAttributes & 0x3); 9535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) libusb_free_config_descriptor(config); 9545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) r = val & 0x07ff; 9565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (ep_type == LIBUSB_TRANSFER_TYPE_ISOCHRONOUS 9575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) || ep_type == LIBUSB_TRANSFER_TYPE_INTERRUPT) 9585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) r *= (1 + ((val >> 11) & 3)); 9595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return r; 9605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 9615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup dev 9635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Increment the reference count of a device. 9645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param dev the device to reference 9655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns the same device 9665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 9675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)DEFAULT_VISIBILITY 9685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)libusb_device * LIBUSB_CALL libusb_ref_device(libusb_device *dev) 9695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 9705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_lock(&dev->lock); 9715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) dev->refcnt++; 9725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_unlock(&dev->lock); 9735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return dev; 9745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 9755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup dev 9775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Decrement the reference count of a device. If the decrement operation 9785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * causes the reference count to reach zero, the device shall be destroyed. 9795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param dev the device to unreference 9805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 9815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void API_EXPORTED libusb_unref_device(libusb_device *dev) 9825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 9835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int refcnt; 9845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!dev) 9865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return; 9875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_lock(&dev->lock); 9895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) refcnt = --dev->refcnt; 9905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_unlock(&dev->lock); 9915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (refcnt == 0) { 9935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_dbg("destroy device %d.%d", dev->bus_number, dev->device_address); 9945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 995ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch libusb_unref_device(dev->parent_dev); 996ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 9975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (usbi_backend->destroy_device) 9985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_backend->destroy_device(dev); 9995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1000ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (!libusb_has_capability(LIBUSB_CAP_HAS_HOTPLUG)) { 1001ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /* backend does not support hotplug */ 1002ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_disconnect_device(dev); 1003ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch } 10045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_destroy(&dev->lock); 10065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) free(dev); 10075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 10085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 10095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* 10115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Interrupt the iteration of the event handling thread, so that it picks 10125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * up the new fd. 10135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 10145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void usbi_fd_notification(struct libusb_context *ctx) 10155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 10165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned char dummy = 1; 10175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ssize_t r; 10185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (ctx == NULL) 10205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return; 10215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* record that we are messing with poll fds */ 10235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_lock(&ctx->pollfd_modify_lock); 10245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ctx->pollfd_modify++; 10255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_unlock(&ctx->pollfd_modify_lock); 10265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* write some data on control pipe to interrupt event handlers */ 10285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) r = usbi_write(ctx->ctrl_pipe[1], &dummy, sizeof(dummy)); 10295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (r <= 0) { 10305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_warn(ctx, "internal signalling write failed"); 10315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_lock(&ctx->pollfd_modify_lock); 10325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ctx->pollfd_modify--; 10335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_unlock(&ctx->pollfd_modify_lock); 10345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return; 10355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 10365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* take event handling lock */ 10385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) libusb_lock_events(ctx); 10395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* read the dummy data */ 10415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) r = usbi_read(ctx->ctrl_pipe[0], &dummy, sizeof(dummy)); 10425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (r <= 0) 10435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_warn(ctx, "internal signalling read failed"); 10445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* we're done with modifying poll fds */ 10465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_lock(&ctx->pollfd_modify_lock); 10475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ctx->pollfd_modify--; 10485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_unlock(&ctx->pollfd_modify_lock); 10495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* Release event handling lock and wake up event waiters */ 10515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) libusb_unlock_events(ctx); 10525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 10535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup dev 10555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Open a device and obtain a device handle. A handle allows you to perform 10565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * I/O on the device in question. 10575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 10585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Internally, this function adds a reference to the device and makes it 10595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * available to you through libusb_get_device(). This reference is removed 10605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * during libusb_close(). 10615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 10625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This is a non-blocking function; no requests are sent over the bus. 10635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 10645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param dev the device to open 10655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param handle output location for the returned device handle pointer. Only 10665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * populated when the return code is 0. 10675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns 0 on success 10685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_NO_MEM on memory allocation failure 10695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_ACCESS if the user has insufficient permissions 10705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_NO_DEVICE if the device has been disconnected 10715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns another LIBUSB_ERROR code on other failure 10725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 10735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int API_EXPORTED libusb_open(libusb_device *dev, 10745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) libusb_device_handle **handle) 10755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 10765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_context *ctx = DEVICE_CTX(dev); 10775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_device_handle *_handle; 10785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t priv_size = usbi_backend->device_handle_priv_size; 10795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int r; 10805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_dbg("open %d.%d", dev->bus_number, dev->device_address); 10815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1082ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (!dev->attached) { 1083ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return LIBUSB_ERROR_NO_DEVICE; 1084ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch } 1085ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 10865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) _handle = malloc(sizeof(*_handle) + priv_size); 10875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!_handle) 10885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return LIBUSB_ERROR_NO_MEM; 10895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) r = usbi_mutex_init(&_handle->lock, NULL); 10915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (r) { 10925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) free(_handle); 10935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return LIBUSB_ERROR_OTHER; 10945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 10955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) _handle->dev = libusb_ref_device(dev); 1097ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch _handle->auto_detach_kernel_driver = 0; 10985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) _handle->claimed_interfaces = 0; 10995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) memset(&_handle->os_priv, 0, priv_size); 11005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) r = usbi_backend->open(_handle); 11025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (r < 0) { 11035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_dbg("open %d.%d returns %d", dev->bus_number, dev->device_address, r); 11045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) libusb_unref_device(dev); 11055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_destroy(&_handle->lock); 11065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) free(_handle); 11075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return r; 11085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 11095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_lock(&ctx->open_devs_lock); 11115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) list_add(&_handle->list, &ctx->open_devs); 11125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_unlock(&ctx->open_devs_lock); 11135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) *handle = _handle; 11145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* At this point, we want to interrupt any existing event handlers so 11165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * that they realise the addition of the new device's poll fd. One 11175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * example when this is desirable is if the user is running a separate 1118ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * dedicated libusbx events handling thread, which is running with a long 11195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * or infinite timeout. We want to interrupt that iteration of the loop, 11205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * so that it picks up the new fd, and then continues. */ 11215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_fd_notification(ctx); 11225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return 0; 11245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 11255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup dev 11275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Convenience function for finding a device with a particular 11285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * <tt>idVendor</tt>/<tt>idProduct</tt> combination. This function is intended 1129ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * for those scenarios where you are using libusbx to knock up a quick test 11305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * application - it allows you to avoid calling libusb_get_device_list() and 11315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * worrying about traversing/freeing the list. 11325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 11335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This function has limitations and is hence not intended for use in real 11345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * applications: if multiple devices have the same IDs it will only 11355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * give you the first one, etc. 11365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 11375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param ctx the context to operate on, or NULL for the default context 11385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param vendor_id the idVendor value to search for 11395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param product_id the idProduct value to search for 11405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns a handle for the first found device, or NULL on error or if the 11415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * device could not be found. */ 11425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)DEFAULT_VISIBILITY 11435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)libusb_device_handle * LIBUSB_CALL libusb_open_device_with_vid_pid( 11445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) libusb_context *ctx, uint16_t vendor_id, uint16_t product_id) 11455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 11465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_device **devs; 11475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_device *found = NULL; 11485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_device *dev; 11495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_device_handle *handle = NULL; 11505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t i = 0; 11515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int r; 11525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (libusb_get_device_list(ctx, &devs) < 0) 11545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return NULL; 11555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) while ((dev = devs[i++]) != NULL) { 11575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_device_descriptor desc; 11585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) r = libusb_get_device_descriptor(dev, &desc); 11595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (r < 0) 11605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) goto out; 11615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (desc.idVendor == vendor_id && desc.idProduct == product_id) { 11625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) found = dev; 11635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) break; 11645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 11655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 11665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (found) { 11685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) r = libusb_open(found, &handle); 11695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (r < 0) 11705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) handle = NULL; 11715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 11725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)out: 11745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) libusb_free_device_list(devs, 1); 11755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return handle; 11765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 11775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)static void do_close(struct libusb_context *ctx, 11795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_device_handle *dev_handle) 11805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 11815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct usbi_transfer *itransfer; 11825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct usbi_transfer *tmp; 11835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) libusb_lock_events(ctx); 11855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* remove any transfers in flight that are for this device */ 11875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_lock(&ctx->flying_transfers_lock); 11885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* safe iteration because transfers may be being deleted */ 11905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) list_for_each_entry_safe(itransfer, tmp, &ctx->flying_transfers, list, struct usbi_transfer) { 11915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_transfer *transfer = 1192ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer); 11935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (transfer->dev_handle != dev_handle) 11955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) continue; 11965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!(itransfer->flags & USBI_TRANSFER_DEVICE_DISAPPEARED)) { 11985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_err(ctx, "Device handle closed while transfer was still being processed, but the device is still connected as far as we know"); 11995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (itransfer->flags & USBI_TRANSFER_CANCELLING) 12015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_warn(ctx, "A cancellation for an in-flight transfer hasn't completed but closing the device handle"); 12025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) else 12035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_err(ctx, "A cancellation hasn't even been scheduled on the transfer for which the device is closing"); 12045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 12055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* remove from the list of in-flight transfers and make sure 12075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * we don't accidentally use the device handle in the future 12085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * (or that such accesses will be easily caught and identified as a crash) 12095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 12105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_lock(&itransfer->lock); 12115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) list_del(&itransfer->list); 12125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->dev_handle = NULL; 12135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_unlock(&itransfer->lock); 12145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* it is up to the user to free up the actual transfer struct. this is 12165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * just making sure that we don't attempt to process the transfer after 12175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * the device handle is invalid 12185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 12195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_dbg("Removed transfer %p from the in-flight list because device handle %p closed", 12205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer, dev_handle); 12215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 12225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_unlock(&ctx->flying_transfers_lock); 12235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) libusb_unlock_events(ctx); 12255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_lock(&ctx->open_devs_lock); 12275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) list_del(&dev_handle->list); 12285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_unlock(&ctx->open_devs_lock); 12295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_backend->close(dev_handle); 12315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) libusb_unref_device(dev_handle->dev); 12325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_destroy(&dev_handle->lock); 12335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) free(dev_handle); 12345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 12355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup dev 12375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Close a device handle. Should be called on all open handles before your 12385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * application exits. 12395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 12405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Internally, this function destroys the reference that was added by 12415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * libusb_open() on the given device. 12425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 12435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This is a non-blocking function; no requests are sent over the bus. 12445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 12455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param dev_handle the handle to close 12465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 12475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void API_EXPORTED libusb_close(libusb_device_handle *dev_handle) 12485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 12495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_context *ctx; 12505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned char dummy = 1; 12515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ssize_t r; 12525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!dev_handle) 12545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return; 12555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_dbg(""); 12565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ctx = HANDLE_CTX(dev_handle); 12585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* Similarly to libusb_open(), we want to interrupt all event handlers 12605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * at this point. More importantly, we want to perform the actual close of 12615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * the device while holding the event handling lock (preventing any other 12625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * thread from doing event handling) because we will be removing a file 12635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * descriptor from the polling loop. */ 12645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* record that we are messing with poll fds */ 12665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_lock(&ctx->pollfd_modify_lock); 12675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ctx->pollfd_modify++; 12685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_unlock(&ctx->pollfd_modify_lock); 12695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* write some data on control pipe to interrupt event handlers */ 12715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) r = usbi_write(ctx->ctrl_pipe[1], &dummy, sizeof(dummy)); 12725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (r <= 0) { 12735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_warn(ctx, "internal signalling write failed, closing anyway"); 12745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) do_close(ctx, dev_handle); 12755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_lock(&ctx->pollfd_modify_lock); 12765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ctx->pollfd_modify--; 12775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_unlock(&ctx->pollfd_modify_lock); 12785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return; 12795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 12805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* take event handling lock */ 12825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) libusb_lock_events(ctx); 12835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* read the dummy data */ 12855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) r = usbi_read(ctx->ctrl_pipe[0], &dummy, sizeof(dummy)); 12865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (r <= 0) 12875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_warn(ctx, "internal signalling read failed, closing anyway"); 12885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* Close the device */ 12905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) do_close(ctx, dev_handle); 12915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* we're done with modifying poll fds */ 12935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_lock(&ctx->pollfd_modify_lock); 12945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ctx->pollfd_modify--; 12955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_unlock(&ctx->pollfd_modify_lock); 12965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* Release event handling lock and wake up event waiters */ 12985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) libusb_unlock_events(ctx); 12995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 13005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup dev 13025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Get the underlying device for a handle. This function does not modify 13035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * the reference count of the returned device, so do not feel compelled to 13045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * unreference it when you are done. 13055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param dev_handle a device handle 13065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns the underlying device 13075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 13085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)DEFAULT_VISIBILITY 13095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)libusb_device * LIBUSB_CALL libusb_get_device(libusb_device_handle *dev_handle) 13105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 13115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return dev_handle->dev; 13125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 13135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup dev 13155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Determine the bConfigurationValue of the currently active configuration. 13165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 13175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * You could formulate your own control request to obtain this information, 13185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * but this function has the advantage that it may be able to retrieve the 13195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * information from operating system caches (no I/O involved). 13205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 13215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * If the OS does not cache this information, then this function will block 13225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * while a control transfer is submitted to retrieve the information. 13235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 13245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This function will return a value of 0 in the <tt>config</tt> output 13255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * parameter if the device is in unconfigured state. 13265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 13275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param dev a device handle 13285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param config output location for the bConfigurationValue of the active 13295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * configuration (only valid for return code 0) 13305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns 0 on success 13315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_NO_DEVICE if the device has been disconnected 13325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns another LIBUSB_ERROR code on other failure 13335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 13345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int API_EXPORTED libusb_get_configuration(libusb_device_handle *dev, 13355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int *config) 13365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 13375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int r = LIBUSB_ERROR_NOT_SUPPORTED; 13385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_dbg(""); 13405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (usbi_backend->get_configuration) 13415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) r = usbi_backend->get_configuration(dev, config); 13425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (r == LIBUSB_ERROR_NOT_SUPPORTED) { 13445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t tmp = 0; 13455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_dbg("falling back to control message"); 13465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) r = libusb_control_transfer(dev, LIBUSB_ENDPOINT_IN, 13475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_REQUEST_GET_CONFIGURATION, 0, 0, &tmp, 1, 1000); 13485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (r == 0) { 13495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_err(HANDLE_CTX(dev), "zero bytes returned in ctrl transfer?"); 13505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) r = LIBUSB_ERROR_IO; 13515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } else if (r == 1) { 13525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) r = 0; 13535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) *config = tmp; 13545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } else { 13555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_dbg("control failed, error %d", r); 13565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 13575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 13585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (r == 0) 13605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_dbg("active config %d", *config); 13615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return r; 13635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 13645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup dev 13665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Set the active configuration for a device. 13675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 13685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * The operating system may or may not have already set an active 13695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * configuration on the device. It is up to your application to ensure the 13705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * correct configuration is selected before you attempt to claim interfaces 13715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * and perform other operations. 13725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 13735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * If you call this function on a device already configured with the selected 13745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * configuration, then this function will act as a lightweight device reset: 13755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * it will issue a SET_CONFIGURATION request using the current configuration, 13765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * causing most USB-related device state to be reset (altsetting reset to zero, 13775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * endpoint halts cleared, toggles reset). 13785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 13795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * You cannot change/reset configuration if your application has claimed 1380ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * interfaces. It is advised to set the desired configuration before claiming 1381ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * interfaces. 1382ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 1383ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Alternatively you can call libusb_release_interface() first. Note if you 1384ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * do things this way you must ensure that auto_detach_kernel_driver for 1385ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * <tt>dev</tt> is 0, otherwise the kernel driver will be re-attached when you 1386ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * release the interface(s). 1387ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 13885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * You cannot change/reset configuration if other applications or drivers have 13895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * claimed interfaces. 13905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 13915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * A configuration value of -1 will put the device in unconfigured state. 13925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * The USB specifications state that a configuration value of 0 does this, 13935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * however buggy devices exist which actually have a configuration 0. 13945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 13955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * You should always use this function rather than formulating your own 13965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * SET_CONFIGURATION control request. This is because the underlying operating 13975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * system needs to know when such changes happen. 13985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 13995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This is a blocking function. 14005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 14015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param dev a device handle 14025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param configuration the bConfigurationValue of the configuration you 14035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * wish to activate, or -1 if you wish to put the device in unconfigured state 14045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns 0 on success 14055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_NOT_FOUND if the requested configuration does not exist 14065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_BUSY if interfaces are currently claimed 14075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_NO_DEVICE if the device has been disconnected 14085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns another LIBUSB_ERROR code on other failure 1409ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \see libusb_set_auto_detach_kernel_driver() 14105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 14115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int API_EXPORTED libusb_set_configuration(libusb_device_handle *dev, 14125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int configuration) 14135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 14145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_dbg("configuration %d", configuration); 14155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return usbi_backend->set_configuration(dev, configuration); 14165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 14175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 14185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup dev 14195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Claim an interface on a given device handle. You must claim the interface 14205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * you wish to use before you can perform I/O on any of its endpoints. 14215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 14225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * It is legal to attempt to claim an already-claimed interface, in which 1423ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * case libusbx just returns 0 without doing anything. 1424ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 1425ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * If auto_detach_kernel_driver is set to 1 for <tt>dev</tt>, the kernel driver 1426ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * will be detached if necessary, on failure the detach error is returned. 14275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 14285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Claiming of interfaces is a purely logical operation; it does not cause 14295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * any requests to be sent over the bus. Interface claiming is used to 14305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * instruct the underlying operating system that your application wishes 14315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * to take ownership of the interface. 14325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 14335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This is a non-blocking function. 14345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 14355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param dev a device handle 14365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param interface_number the <tt>bInterfaceNumber</tt> of the interface you 14375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * wish to claim 14385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns 0 on success 14395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_NOT_FOUND if the requested interface does not exist 14405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_BUSY if another program or driver has claimed the 14415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * interface 14425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_NO_DEVICE if the device has been disconnected 14435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns a LIBUSB_ERROR code on other failure 1444ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \see libusb_set_auto_detach_kernel_driver() 14455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 14465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int API_EXPORTED libusb_claim_interface(libusb_device_handle *dev, 14475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int interface_number) 14485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 14495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int r = 0; 14505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 14515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_dbg("interface %d", interface_number); 14525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (interface_number >= USB_MAXINTERFACES) 14535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return LIBUSB_ERROR_INVALID_PARAM; 14545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1455ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (!dev->dev->attached) 1456ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return LIBUSB_ERROR_NO_DEVICE; 1457ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 14585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_lock(&dev->lock); 14595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (dev->claimed_interfaces & (1 << interface_number)) 14605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) goto out; 14615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 14625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) r = usbi_backend->claim_interface(dev, interface_number); 14635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (r == 0) 14645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) dev->claimed_interfaces |= 1 << interface_number; 14655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 14665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)out: 14675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_unlock(&dev->lock); 14685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return r; 14695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 14705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 14715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup dev 14725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Release an interface previously claimed with libusb_claim_interface(). You 14735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * should release all claimed interfaces before closing a device handle. 14745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 14755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This is a blocking function. A SET_INTERFACE control request will be sent 14765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * to the device, resetting interface state to the first alternate setting. 14775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 1478ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * If auto_detach_kernel_driver is set to 1 for <tt>dev</tt>, the kernel 1479ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * driver will be re-attached after releasing the interface. 1480ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 14815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param dev a device handle 14825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param interface_number the <tt>bInterfaceNumber</tt> of the 14835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * previously-claimed interface 14845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns 0 on success 14855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_NOT_FOUND if the interface was not claimed 14865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_NO_DEVICE if the device has been disconnected 14875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns another LIBUSB_ERROR code on other failure 1488ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \see libusb_set_auto_detach_kernel_driver() 14895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 14905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int API_EXPORTED libusb_release_interface(libusb_device_handle *dev, 14915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int interface_number) 14925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 14935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int r; 14945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 14955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_dbg("interface %d", interface_number); 14965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (interface_number >= USB_MAXINTERFACES) 14975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return LIBUSB_ERROR_INVALID_PARAM; 14985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 14995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_lock(&dev->lock); 15005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!(dev->claimed_interfaces & (1 << interface_number))) { 15015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) r = LIBUSB_ERROR_NOT_FOUND; 15025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) goto out; 15035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 15045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 15055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) r = usbi_backend->release_interface(dev, interface_number); 15065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (r == 0) 15075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) dev->claimed_interfaces &= ~(1 << interface_number); 15085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 15095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)out: 15105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_unlock(&dev->lock); 15115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return r; 15125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 15135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 15145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup dev 15155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Activate an alternate setting for an interface. The interface must have 15165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * been previously claimed with libusb_claim_interface(). 15175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 15185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * You should always use this function rather than formulating your own 15195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * SET_INTERFACE control request. This is because the underlying operating 15205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * system needs to know when such changes happen. 15215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 15225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This is a blocking function. 15235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 15245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param dev a device handle 15255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param interface_number the <tt>bInterfaceNumber</tt> of the 15265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * previously-claimed interface 15275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param alternate_setting the <tt>bAlternateSetting</tt> of the alternate 15285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * setting to activate 15295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns 0 on success 15305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_NOT_FOUND if the interface was not claimed, or the 15315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * requested alternate setting does not exist 15325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_NO_DEVICE if the device has been disconnected 15335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns another LIBUSB_ERROR code on other failure 15345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 15355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int API_EXPORTED libusb_set_interface_alt_setting(libusb_device_handle *dev, 15365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int interface_number, int alternate_setting) 15375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 15385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_dbg("interface %d altsetting %d", 15395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) interface_number, alternate_setting); 15405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (interface_number >= USB_MAXINTERFACES) 15415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return LIBUSB_ERROR_INVALID_PARAM; 15425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 15435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_lock(&dev->lock); 1544ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (!dev->dev->attached) { 1545ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_mutex_unlock(&dev->lock); 1546ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return LIBUSB_ERROR_NO_DEVICE; 1547ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch } 1548ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 15495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!(dev->claimed_interfaces & (1 << interface_number))) { 15505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_unlock(&dev->lock); 15515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return LIBUSB_ERROR_NOT_FOUND; 15525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 15535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_unlock(&dev->lock); 15545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 15555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return usbi_backend->set_interface_altsetting(dev, interface_number, 15565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) alternate_setting); 15575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 15585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 15595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup dev 15605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Clear the halt/stall condition for an endpoint. Endpoints with halt status 15615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * are unable to receive or transmit data until the halt condition is stalled. 15625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 15635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * You should cancel all pending transfers before attempting to clear the halt 15645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * condition. 15655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 15665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This is a blocking function. 15675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 15685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param dev a device handle 15695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param endpoint the endpoint to clear halt status 15705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns 0 on success 15715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_NOT_FOUND if the endpoint does not exist 15725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_NO_DEVICE if the device has been disconnected 15735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns another LIBUSB_ERROR code on other failure 15745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 15755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int API_EXPORTED libusb_clear_halt(libusb_device_handle *dev, 15765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned char endpoint) 15775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 15785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_dbg("endpoint %x", endpoint); 1579ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (!dev->dev->attached) 1580ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return LIBUSB_ERROR_NO_DEVICE; 1581ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 15825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return usbi_backend->clear_halt(dev, endpoint); 15835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 15845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 15855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup dev 15865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Perform a USB port reset to reinitialize a device. The system will attempt 15875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * to restore the previous configuration and alternate settings after the 15885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * reset has completed. 15895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 15905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * If the reset fails, the descriptors change, or the previous state cannot be 15915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * restored, the device will appear to be disconnected and reconnected. This 15925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * means that the device handle is no longer valid (you should close it) and 15935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * rediscover the device. A return code of LIBUSB_ERROR_NOT_FOUND indicates 15945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * when this is the case. 15955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 15965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This is a blocking function which usually incurs a noticeable delay. 15975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 15985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param dev a handle of the device to reset 15995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns 0 on success 16005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_NOT_FOUND if re-enumeration is required, or if the 16015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * device has been disconnected 16025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns another LIBUSB_ERROR code on other failure 16035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 16045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int API_EXPORTED libusb_reset_device(libusb_device_handle *dev) 16055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 16065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_dbg(""); 1607ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (!dev->dev->attached) 1608ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return LIBUSB_ERROR_NO_DEVICE; 1609ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 16105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return usbi_backend->reset_device(dev); 16115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 16125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 16135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup dev 16145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Determine if a kernel driver is active on an interface. If a kernel driver 1615ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * is active, you cannot claim the interface, and libusbx will be unable to 16165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * perform I/O. 16175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 16185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This functionality is not available on Windows. 16195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 16205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param dev a device handle 16215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param interface_number the interface to check 16225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns 0 if no kernel driver is active 16235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns 1 if a kernel driver is active 16245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_NO_DEVICE if the device has been disconnected 16255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_NOT_SUPPORTED on platforms where the functionality 16265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * is not available 16275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns another LIBUSB_ERROR code on other failure 16285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \see libusb_detach_kernel_driver() 16295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 16305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int API_EXPORTED libusb_kernel_driver_active(libusb_device_handle *dev, 16315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int interface_number) 16325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 16335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_dbg("interface %d", interface_number); 1634ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 1635ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (!dev->dev->attached) 1636ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return LIBUSB_ERROR_NO_DEVICE; 1637ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 16385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (usbi_backend->kernel_driver_active) 16395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return usbi_backend->kernel_driver_active(dev, interface_number); 16405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) else 16415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return LIBUSB_ERROR_NOT_SUPPORTED; 16425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 16435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 16445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup dev 16455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Detach a kernel driver from an interface. If successful, you will then be 16465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * able to claim the interface and perform I/O. 16475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 16485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This functionality is not available on Darwin or Windows. 16495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 1650ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Note that libusbx itself also talks to the device through a special kernel 1651ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * driver, if this driver is already attached to the device, this call will 1652ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * not detach it and return LIBUSB_ERROR_NOT_FOUND. 1653ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 16545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param dev a device handle 16555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param interface_number the interface to detach the driver from 16565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns 0 on success 16575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_NOT_FOUND if no kernel driver was active 16585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_INVALID_PARAM if the interface does not exist 16595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_NO_DEVICE if the device has been disconnected 16605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_NOT_SUPPORTED on platforms where the functionality 16615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * is not available 16625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns another LIBUSB_ERROR code on other failure 16635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \see libusb_kernel_driver_active() 16645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 16655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int API_EXPORTED libusb_detach_kernel_driver(libusb_device_handle *dev, 16665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int interface_number) 16675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 16685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_dbg("interface %d", interface_number); 1669ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 1670ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (!dev->dev->attached) 1671ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return LIBUSB_ERROR_NO_DEVICE; 1672ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 16735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (usbi_backend->detach_kernel_driver) 16745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return usbi_backend->detach_kernel_driver(dev, interface_number); 16755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) else 16765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return LIBUSB_ERROR_NOT_SUPPORTED; 16775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 16785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 16795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup dev 16805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Re-attach an interface's kernel driver, which was previously detached 16815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * using libusb_detach_kernel_driver(). This call is only effective on 16825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Linux and returns LIBUSB_ERROR_NOT_SUPPORTED on all other platforms. 16835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 16845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This functionality is not available on Darwin or Windows. 16855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 16865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param dev a device handle 16875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param interface_number the interface to attach the driver from 16885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns 0 on success 16895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_NOT_FOUND if no kernel driver was active 16905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_INVALID_PARAM if the interface does not exist 16915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_NO_DEVICE if the device has been disconnected 16925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_NOT_SUPPORTED on platforms where the functionality 16935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * is not available 16945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns LIBUSB_ERROR_BUSY if the driver cannot be attached because the 16955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * interface is claimed by a program or driver 16965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns another LIBUSB_ERROR code on other failure 16975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \see libusb_kernel_driver_active() 16985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 16995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int API_EXPORTED libusb_attach_kernel_driver(libusb_device_handle *dev, 17005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int interface_number) 17015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 17025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_dbg("interface %d", interface_number); 1703ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 1704ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (!dev->dev->attached) 1705ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return LIBUSB_ERROR_NO_DEVICE; 1706ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 17075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (usbi_backend->attach_kernel_driver) 17085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return usbi_backend->attach_kernel_driver(dev, interface_number); 17095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) else 17105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return LIBUSB_ERROR_NOT_SUPPORTED; 17115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 17125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1713ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/** \ingroup dev 1714ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Enable/disable libusbx's automatic kernel driver detachment. When this is 1715ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * enabled libusbx will automatically detach the kernel driver on an interface 1716ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * when claiming the interface, and attach it when releasing the interface. 1717ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 1718ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Automatic kernel driver detachment is disabled on newly opened device 1719ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * handles by default. 1720ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 1721ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * On platforms which do not have LIBUSB_CAP_SUPPORTS_DETACH_KERNEL_DRIVER 1722ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * this function will return LIBUSB_ERROR_NOT_SUPPORTED, and libusbx will 1723ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * continue as if this function was never called. 1724ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 1725ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \param dev a device handle 1726ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \param enable whether to enable or disable auto kernel driver detachment 1727ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 1728ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \returns LIBUSB_SUCCESS on success 1729ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \returns LIBUSB_ERROR_NOT_SUPPORTED on platforms where the functionality 1730ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * is not available 1731ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \see libusb_claim_interface() 1732ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \see libusb_release_interface() 1733ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \see libusb_set_configuration() 1734ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch */ 1735ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochint API_EXPORTED libusb_set_auto_detach_kernel_driver( 1736ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch libusb_device_handle *dev, int enable) 1737ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch{ 1738ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (!(usbi_backend->caps & USBI_CAP_SUPPORTS_DETACH_KERNEL_DRIVER)) 1739ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return LIBUSB_ERROR_NOT_SUPPORTED; 1740ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 1741ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch dev->auto_detach_kernel_driver = enable; 1742ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return LIBUSB_SUCCESS; 1743ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch} 1744ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 17455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup lib 1746ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Set log message verbosity. 1747ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 1748ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * The default level is LIBUSB_LOG_LEVEL_NONE, which means no messages are ever 1749ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * printed. If you choose to increase the message verbosity level, ensure 1750ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * that your application does not close the stdout/stderr file descriptors. 1751ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 1752ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * You are advised to use level LIBUSB_LOG_LEVEL_WARNING. libusbx is conservative 1753ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * with its message logging and most of the time, will only log messages that 1754ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * explain error conditions and other oddities. This will help you debug 1755ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * your software. 1756ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 1757ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * If the LIBUSB_DEBUG environment variable was set when libusbx was 17585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * initialized, this function does nothing: the message verbosity is fixed 17595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * to the value in the environment variable. 17605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 1761ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * If libusbx was compiled without any message logging, this function does 17625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * nothing: you'll never get any messages. 17635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 1764ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * If libusbx was compiled with verbose debug message logging, this function 17655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * does nothing: you'll always get messages from all levels. 17665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 17675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param ctx the context to operate on, or NULL for the default context 17685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param level debug level to set 17695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 17705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void API_EXPORTED libusb_set_debug(libusb_context *ctx, int level) 17715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 17725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) USBI_GET_CONTEXT(ctx); 17735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!ctx->debug_fixed) 17745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ctx->debug = level; 17755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 17765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 17775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup lib 17785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Initialize libusb. This function must be called before calling any other 1779ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * libusbx function. 17805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 17815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * If you do not provide an output location for a context pointer, a default 17825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * context will be created. If there was already a default context, it will 17835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * be reused (and nothing will be initialized/reinitialized). 17845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 17855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param context Optional output location for context pointer. 17865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Only valid on return code 0. 17875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns 0 on success, or a LIBUSB_ERROR code on failure 17885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \see contexts 17895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 17905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int API_EXPORTED libusb_init(libusb_context **context) 17915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 1792ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch struct libusb_device *dev, *next; 17935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) char *dbg = getenv("LIBUSB_DEBUG"); 17945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_context *ctx; 1795ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch static int first_init = 1; 1796eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch int r = 0; 17975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 17985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_static_lock(&default_context_lock); 1799ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 1800ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (!timestamp_origin.tv_sec) { 1801ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_gettimeofday(×tamp_origin, NULL); 1802ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch } 1803ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 18045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!context && usbi_default_context) { 18055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_dbg("reusing default context"); 18065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) default_context_refcnt++; 18075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_static_unlock(&default_context_lock); 18085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return 0; 18095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 18105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1811ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch ctx = calloc(1, sizeof(*ctx)); 18125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!ctx) { 18135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) r = LIBUSB_ERROR_NO_MEM; 18145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) goto err_unlock; 18155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1816ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 1817ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#ifdef ENABLE_DEBUG_LOGGING 1818ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch ctx->debug = LIBUSB_LOG_LEVEL_DEBUG; 1819ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#endif 18205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 18215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (dbg) { 18225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ctx->debug = atoi(dbg); 18235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (ctx->debug) 18245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ctx->debug_fixed = 1; 18255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 18265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1827ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /* default context should be initialized before calling usbi_dbg */ 1828ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (!usbi_default_context) { 1829ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_default_context = ctx; 1830ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch default_context_refcnt++; 1831ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_dbg("created default context"); 18325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 18335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1834ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_dbg("libusbx v%d.%d.%d.%d", libusb_version_internal.major, libusb_version_internal.minor, 1835ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch libusb_version_internal.micro, libusb_version_internal.nano); 1836ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 18375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_init(&ctx->usb_devs_lock, NULL); 18385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_init(&ctx->open_devs_lock, NULL); 1839ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_mutex_init(&ctx->hotplug_cbs_lock, NULL); 18405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) list_init(&ctx->usb_devs); 18415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) list_init(&ctx->open_devs); 1842ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch list_init(&ctx->hotplug_cbs); 18435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1844ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_mutex_static_lock(&active_contexts_lock); 1845ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (first_init) { 1846ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch first_init = 0; 1847ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch list_init (&active_contexts_list); 18485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1849ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch list_add (&ctx->list, &active_contexts_list); 1850ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_mutex_static_unlock(&active_contexts_lock); 18515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1852ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (usbi_backend->init) { 1853ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch r = usbi_backend->init(ctx); 1854ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (r) 1855ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch goto err_free_ctx; 18565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1857ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 1858ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch r = usbi_io_init(ctx); 1859ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (r < 0) 1860ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch goto err_backend_exit; 1861ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 18625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_static_unlock(&default_context_lock); 18635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1864ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (context) 1865ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch *context = ctx; 1866ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 18675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return 0; 18685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1869ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdocherr_backend_exit: 1870ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (usbi_backend->exit) 1871ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_backend->exit(); 1872ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdocherr_free_ctx: 1873ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (ctx == usbi_default_context) 1874ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_default_context = NULL; 1875ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 18765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_destroy(&ctx->open_devs_lock); 18775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_destroy(&ctx->usb_devs_lock); 1878ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_mutex_destroy(&ctx->hotplug_cbs_lock); 1879ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 1880ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_mutex_static_lock(&active_contexts_lock); 1881ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch list_del (&ctx->list); 1882ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_mutex_static_unlock(&active_contexts_lock); 1883ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 1884ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_mutex_lock(&ctx->usb_devs_lock); 1885ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch list_for_each_entry_safe(dev, next, &ctx->usb_devs, list, struct libusb_device) { 1886ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch list_del(&dev->list); 1887ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch libusb_unref_device(dev); 1888ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch } 1889ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_mutex_unlock(&ctx->usb_devs_lock); 1890ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 18915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) free(ctx); 18925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)err_unlock: 18935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_static_unlock(&default_context_lock); 18945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return r; 18955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 18965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 18975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup lib 18985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Deinitialize libusb. Should be called after closing all open devices and 18995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * before your application terminates. 19005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param ctx the context to deinitialize, or NULL for the default context 19015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 19025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void API_EXPORTED libusb_exit(struct libusb_context *ctx) 19035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 1904ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch struct libusb_device *dev, *next; 1905ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 19065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_dbg(""); 19075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) USBI_GET_CONTEXT(ctx); 19085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 19095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* if working with default context, only actually do the deinitialization 19105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * if we're the last user */ 1911ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_mutex_static_lock(&default_context_lock); 19125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (ctx == usbi_default_context) { 19135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (--default_context_refcnt > 0) { 19145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_dbg("not destroying default context"); 19155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_static_unlock(&default_context_lock); 19165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return; 19175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 19185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_dbg("destroying default context"); 19195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_default_context = NULL; 19205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1921ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_mutex_static_unlock(&default_context_lock); 19225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1923ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_mutex_static_lock(&active_contexts_lock); 1924ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch list_del (&ctx->list); 1925ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_mutex_static_unlock(&active_contexts_lock); 1926ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 1927ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (libusb_has_capability(LIBUSB_CAP_HAS_HOTPLUG)) { 1928ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_hotplug_deregister_all(ctx); 1929ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_mutex_lock(&ctx->usb_devs_lock); 1930ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch list_for_each_entry_safe(dev, next, &ctx->usb_devs, list, struct libusb_device) { 1931ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch list_del(&dev->list); 1932ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch libusb_unref_device(dev); 1933ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch } 1934ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_mutex_unlock(&ctx->usb_devs_lock); 1935ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch } 1936ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 1937ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /* a few sanity checks. don't bother with locking because unless 1938ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * there is an application bug, nobody will be accessing these. */ 1939ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (!list_empty(&ctx->usb_devs)) 1940ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_warn(ctx, "some libusb_devices were leaked"); 19415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!list_empty(&ctx->open_devs)) 19425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_warn(ctx, "application left some devices open"); 19435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 19445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_io_exit(ctx); 19455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (usbi_backend->exit) 19465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_backend->exit(); 19475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 19485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_destroy(&ctx->open_devs_lock); 19495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_mutex_destroy(&ctx->usb_devs_lock); 1950ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_mutex_destroy(&ctx->hotplug_cbs_lock); 19515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) free(ctx); 19525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 19535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 19545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup misc 1955eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * Check at runtime if the loaded library has a given capability. 1956ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * This call should be performed after \ref libusb_init(), to ensure the 1957ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * backend has updated its capability set. 19585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 19595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param capability the \ref libusb_capability to check for 1960ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \returns nonzero if the running library has the capability, 0 otherwise 19615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 19625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int API_EXPORTED libusb_has_capability(uint32_t capability) 19635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 1964ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch switch (capability) { 1965eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch case LIBUSB_CAP_HAS_CAPABILITY: 19665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return 1; 1967ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch case LIBUSB_CAP_HAS_HOTPLUG: 1968ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return !(usbi_backend->get_device_list); 1969ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch case LIBUSB_CAP_HAS_HID_ACCESS: 1970ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return (usbi_backend->caps & USBI_CAP_HAS_HID_ACCESS); 1971ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch case LIBUSB_CAP_SUPPORTS_DETACH_KERNEL_DRIVER: 1972ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return (usbi_backend->caps & USBI_CAP_SUPPORTS_DETACH_KERNEL_DRIVER); 19735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 19745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return 0; 19755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 19765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1977eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch/* this is defined in libusbi.h if needed */ 1978eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#ifdef LIBUSB_GETTIMEOFDAY_WIN32 1979eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch/* 1980eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * gettimeofday 1981eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * Implementation according to: 1982eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * The Open Group Base Specifications Issue 6 1983eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * IEEE Std 1003.1, 2004 Edition 1984eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch */ 1985eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 1986eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch/* 1987eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * THIS SOFTWARE IS NOT COPYRIGHTED 1988eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * 1989eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * This source code is offered for use in the public domain. You may 1990eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * use, modify or distribute it freely. 1991eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * 1992eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * This code is distributed in the hope that it will be useful but 1993eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * WITHOUT ANY WARRANTY. ALL WARRANTIES, EXPRESS OR IMPLIED ARE HEREBY 1994eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * DISCLAIMED. This includes but is not limited to warranties of 1995eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 1996eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * 1997eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * Contributed by: 1998eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * Danny Smith <dannysmith@users.sourceforge.net> 1999eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch */ 2000eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 2001eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch/* Offset between 1/1/1601 and 1/1/1970 in 100 nanosec units */ 2002eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#define _W32_FT_OFFSET (116444736000000000) 2003eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 2004eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdochint usbi_gettimeofday(struct timeval *tp, void *tzp) 2005ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch{ 2006ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch union { 2007ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch unsigned __int64 ns100; /* Time since 1 Jan 1601, in 100ns units */ 2008ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch FILETIME ft; 2009ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch } _now; 2010ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch UNUSED(tzp); 2011ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 2012ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if(tp) { 2013ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#if defined(OS_WINCE) 2014ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch SYSTEMTIME st; 2015ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch GetSystemTime(&st); 2016ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch SystemTimeToFileTime(&st, &_now.ft); 2017ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#else 2018ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch GetSystemTimeAsFileTime (&_now.ft); 2019ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#endif 2020ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch tp->tv_usec=(long)((_now.ns100 / 10) % 1000000 ); 2021ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch tp->tv_sec= (long)((_now.ns100 - _W32_FT_OFFSET) / 10000000); 2022ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch } 2023ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /* Always return 0 as per Open Group Base Specifications Issue 6. 2024ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch Do not set errno on error. */ 2025ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return 0; 2026eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch} 2027eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#endif 2028eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 2029ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochstatic void usbi_log_str(struct libusb_context *ctx, const char * str) 2030ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch{ 2031ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch UNUSED(ctx); 2032ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch fputs(str, stderr); 2033ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch} 2034ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 2035ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochvoid usbi_log_v(struct libusb_context *ctx, enum libusb_log_level level, 20365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char *function, const char *format, va_list args) 20375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 2038ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch const char *prefix = ""; 2039ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch char buf[USBI_MAX_LOG_LEN]; 2040eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch struct timeval now; 2041ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch int global_debug, header_len, text_len; 2042ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch static int has_debug_header_been_displayed = 0; 20435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2044ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#ifdef ENABLE_DEBUG_LOGGING 2045ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch global_debug = 1; 2046ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch UNUSED(ctx); 2047ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#else 20485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) USBI_GET_CONTEXT(ctx); 2049ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (ctx == NULL) 2050ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return; 2051ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch global_debug = (ctx->debug == LIBUSB_LOG_LEVEL_DEBUG); 20525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!ctx->debug) 20535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return; 2054ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (level == LIBUSB_LOG_LEVEL_WARNING && ctx->debug < LIBUSB_LOG_LEVEL_WARNING) 2055ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return; 2056ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (level == LIBUSB_LOG_LEVEL_INFO && ctx->debug < LIBUSB_LOG_LEVEL_INFO) 20575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return; 2058ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (level == LIBUSB_LOG_LEVEL_DEBUG && ctx->debug < LIBUSB_LOG_LEVEL_DEBUG) 20595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return; 20605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 20615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2062ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#ifdef __ANDROID__ 2063ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch int prio; 2064ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch switch (level) { 2065ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch case LOG_LEVEL_INFO: 2066ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch prio = ANDROID_LOG_INFO; 2067ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch break; 2068ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch case LOG_LEVEL_WARNING: 2069ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch prio = ANDROID_LOG_WARN; 2070ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch break; 2071ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch case LOG_LEVEL_ERROR: 2072ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch prio = ANDROID_LOG_ERROR; 2073ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch break; 2074ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch case LOG_LEVEL_DEBUG: 2075ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch prio = ANDROID_LOG_DEBUG; 2076ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch break; 2077ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch default: 2078ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch prio = ANDROID_LOG_UNKNOWN; 2079ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch break; 2080ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch } 2081ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 2082ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch __android_log_vprint(prio, "LibUsb", format, args); 2083ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#else 2084eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch usbi_gettimeofday(&now, NULL); 2085ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if ((global_debug) && (!has_debug_header_been_displayed)) { 2086ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch has_debug_header_been_displayed = 1; 2087ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_log_str(ctx, "[timestamp] [threadID] facility level [function call] <message>\n"); 2088ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_log_str(ctx, "--------------------------------------------------------------------------------\n"); 2089eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch } 2090ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (now.tv_usec < timestamp_origin.tv_usec) { 2091eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch now.tv_sec--; 2092eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch now.tv_usec += 1000000; 2093eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch } 2094ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch now.tv_sec -= timestamp_origin.tv_sec; 2095ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch now.tv_usec -= timestamp_origin.tv_usec; 2096eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 20975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) switch (level) { 2098ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch case LIBUSB_LOG_LEVEL_INFO: 20995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) prefix = "info"; 21005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) break; 2101ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch case LIBUSB_LOG_LEVEL_WARNING: 21025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) prefix = "warning"; 21035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) break; 2104ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch case LIBUSB_LOG_LEVEL_ERROR: 21055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) prefix = "error"; 21065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) break; 2107ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch case LIBUSB_LOG_LEVEL_DEBUG: 21085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) prefix = "debug"; 21095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) break; 2110ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch case LIBUSB_LOG_LEVEL_NONE: 2111ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch break; 21125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) default: 21135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) prefix = "unknown"; 21145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) break; 21155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 21165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2117ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (global_debug) { 2118ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch header_len = snprintf(buf, sizeof(buf), 2119ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch "[%2d.%06d] [%08x] libusbx: %s [%s] ", 2120ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch (int)now.tv_sec, (int)now.tv_usec, usbi_get_tid(), prefix, function); 2121ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch } else { 2122ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch header_len = snprintf(buf, sizeof(buf), 2123ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch "libusbx: %s [%s] ", prefix, function); 2124ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch } 21255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2126ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (header_len < 0 || header_len >= sizeof(buf)) { 2127ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /* Somehow snprintf failed to write to the buffer, 2128ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * remove the header so something useful is output. */ 2129ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch header_len = 0; 2130ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch } 2131ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /* Make sure buffer is NUL terminated */ 2132ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch buf[header_len] = '\0'; 2133ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch text_len = vsnprintf(buf + header_len, sizeof(buf) - header_len, 2134ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch format, args); 2135ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (text_len < 0 || text_len + header_len >= sizeof(buf)) { 2136ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /* Truncated log output. On some platforms a -1 return value means 2137ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * that the output was truncated. */ 2138ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch text_len = sizeof(buf) - header_len; 2139ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch } 2140ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch if (header_len + text_len + sizeof(USBI_LOG_LINE_END) >= sizeof(buf)) { 2141ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /* Need to truncate the text slightly to fit on the terminator. */ 2142ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch text_len -= (header_len + text_len + sizeof(USBI_LOG_LINE_END)) - sizeof(buf); 2143ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch } 2144ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch strcpy(buf + header_len + text_len, USBI_LOG_LINE_END); 21455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2146ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch usbi_log_str(ctx, buf); 2147ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#endif 21485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 21495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2150ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochvoid usbi_log(struct libusb_context *ctx, enum libusb_log_level level, 21515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char *function, const char *format, ...) 21525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 21535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) va_list args; 21545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 21555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) va_start (args, format); 21565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) usbi_log_v(ctx, level, function, format, args); 21575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) va_end (args); 21585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 21595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 21605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup misc 2161ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Returns a constant NULL-terminated string with the ASCII name of a libusbx 2162ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * error or transfer status code. The caller must not free() the returned 2163ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * string. 21645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 2165ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \param error_code The \ref libusb_error or libusb_transfer_status code to 2166ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * return the name of. 21675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns The error name, or the string **UNKNOWN** if the value of 2168ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * error_code is not a known error / status code. 21695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 21705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)DEFAULT_VISIBILITY const char * LIBUSB_CALL libusb_error_name(int error_code) 21715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 2172ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch switch (error_code) { 21735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) case LIBUSB_ERROR_IO: 21745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return "LIBUSB_ERROR_IO"; 21755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) case LIBUSB_ERROR_INVALID_PARAM: 21765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return "LIBUSB_ERROR_INVALID_PARAM"; 21775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) case LIBUSB_ERROR_ACCESS: 21785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return "LIBUSB_ERROR_ACCESS"; 21795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) case LIBUSB_ERROR_NO_DEVICE: 21805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return "LIBUSB_ERROR_NO_DEVICE"; 21815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) case LIBUSB_ERROR_NOT_FOUND: 21825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return "LIBUSB_ERROR_NOT_FOUND"; 21835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) case LIBUSB_ERROR_BUSY: 21845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return "LIBUSB_ERROR_BUSY"; 21855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) case LIBUSB_ERROR_TIMEOUT: 21865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return "LIBUSB_ERROR_TIMEOUT"; 21875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) case LIBUSB_ERROR_OVERFLOW: 21885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return "LIBUSB_ERROR_OVERFLOW"; 21895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) case LIBUSB_ERROR_PIPE: 21905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return "LIBUSB_ERROR_PIPE"; 21915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) case LIBUSB_ERROR_INTERRUPTED: 21925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return "LIBUSB_ERROR_INTERRUPTED"; 21935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) case LIBUSB_ERROR_NO_MEM: 21945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return "LIBUSB_ERROR_NO_MEM"; 21955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) case LIBUSB_ERROR_NOT_SUPPORTED: 21965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return "LIBUSB_ERROR_NOT_SUPPORTED"; 21975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) case LIBUSB_ERROR_OTHER: 21985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return "LIBUSB_ERROR_OTHER"; 2199ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 2200ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch case LIBUSB_TRANSFER_ERROR: 2201ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return "LIBUSB_TRANSFER_ERROR"; 2202ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch case LIBUSB_TRANSFER_TIMED_OUT: 2203ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return "LIBUSB_TRANSFER_TIMED_OUT"; 2204ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch case LIBUSB_TRANSFER_CANCELLED: 2205ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return "LIBUSB_TRANSFER_CANCELLED"; 2206ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch case LIBUSB_TRANSFER_STALL: 2207ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return "LIBUSB_TRANSFER_STALL"; 2208ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch case LIBUSB_TRANSFER_NO_DEVICE: 2209ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return "LIBUSB_TRANSFER_NO_DEVICE"; 2210ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch case LIBUSB_TRANSFER_OVERFLOW: 2211ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return "LIBUSB_TRANSFER_OVERFLOW"; 2212ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 2213ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch case 0: 2214ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return "LIBUSB_SUCCESS / LIBUSB_TRANSFER_COMPLETED"; 2215ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch default: 2216ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return "**UNKNOWN**"; 22175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 22185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 2219eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 2220eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch/** \ingroup misc 2221eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * Returns a pointer to const struct libusb_version with the version 2222ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * (major, minor, micro, nano and rc) of the running library. 2223eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch */ 2224eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen MurdochDEFAULT_VISIBILITY 2225eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdochconst struct libusb_version * LIBUSB_CALL libusb_get_version(void) 2226eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch{ 2227eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch return &libusb_version_internal; 2228eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch} 2229