ChangeLog

   1 For detailed information about the changes below, please see the git log or
   2 visit: http://log.libusb.info
   3
   4 2022-01-31: v1.0.25
   5 * Linux: Fix regression with some particular devices
   6 * Linux: Fix regression with libusb_handle_events_timeout_completed()
   7 * Linux: Fix regression with cpu usage in libusb_bulk_transfer
   8 * Darwin (macOS): Add support for detaching kernel drivers with authorization.
   9 * Darwin (macOS): Do not drop partial data on timeout.
  10 * Darwin (macOS): Silence pipe error in set_interface_alt_setting().
  11 * Windows: Fix HID backend missing byte
  12 * Windows: Fix segfault with libusbk driver
  13 * Windows: Fix regression when using libusb0 driver
  14 * Windows: Support LIBUSB_TRANSFER_ADD_ZERO_PACKET on winusb
  15 * New NO_DEVICE_DISCOVERY option replaces WEAK_AUTHORITY option
  16 * Various other bug fixes and improvements
  17
  18 2020-12-09: v1.0.24
  19 * Add new platform abstraction (#252)
  20 * Add Null POSIX backend
  21 * Add support for eventfd
  22 * Add support for thread IDs on Haiku, NetBSD and Solaris
  23 * New API libusb_hotplug_get_user_data()
  24 * Darwin (macOS): Fix race condition that results in segmentation fault (#701)
  25 * Darwin (macOS): Fix stale descriptor information post reset (#733)
  26 * Darwin (macOS): use IOUSBDevice as darwin_device_class explicitly (#693)
  27 * Linux: Drop support for kernel older than 2.6.32
  28 * Linux: Provide an event thread name (#689)
  29 * Linux: Wait until all URBs have been reaped before freeing them (#607)
  30 * NetBSD: Recognize device timeouts (#710)
  31 * OpenBSD: Allow opening ugen devices multiple times (#763)
  32 * OpenBSD: Support libusb_get_port_number() (#764)
  33 * SunOS: Fix a memory leak (#756)
  34 * SunOS: Various fixes (#627, #628, #629)
  35 * Windows: Add Visual Studio 2019 support
  36 * Windows: Drop support for WinCE and Visual Studio older than 2013
  37 * Windows: Drop support for Windows XP
  38 * Windows: Support building all examples using Visual Studio (#151)
  39 * Documentation fixes and improvements
  40 * Various other bug fixes and improvements
  41
  42 2019-08-28: v1.0.23
  43 * Add German translation (#446)
  44 * Add Hungarian translation (#493)
  45 * Android: Improved support for Android
  46 * BSD: Remove infinite recursion in OpenBSD backend
  47 * configure.ac: Fix detection of clock_gettime library (#439)
  48 * Core: abandon synchronous transfers when device closure is detected.
  49 * Core: fix error in handling the removal of file descriptors while handling
  50   events.
  51 * Darwin(macOS): Switch from using ResetDevice to USBDeviceReEnumerate (#455)
  52 * Darwin(macOS): Remove code that changed the device class used (#428)
  53 * Darwin(macOS): Reduce hotplug timeout to 1ms (from 5s)
  54 * New API libusb_set_log_cb() to redirect global and per context log
  55   messages to the provided log handling function
  56 * New API libusb_wrap_sys_device to allow the user to specify the
  57   usb device to use.
  58 * Solaris: Break infinite recursion in backend clock_gettime
  59 * Solaris: Enable timerfd on sunos when available
  60 * Windows: Add support for isochronous transfers with WinUSB
  61 * Various other bug fixes and improvements
  62
  63 2018-03-24: v1.0.22
  64 * New libusb_set_option() API
  65 * Fix transfer timeout not being cleared upon resubmission
  66 * Report super speed plus devices on modern Linux and macOS
  67 * Darwin: Improve support for macOS Sierra and High Sierra
  68 * Darwin: SDK fixes and improvements
  69 * Linux: Let initialization succeed when no devices are present
  70 * Linux: Mark internal file descriptors with CLOEXEC flag
  71 * Solaris: Add support for attach/detach kernel driver
  72 * Windows: Add dynamic UsbDk backend selection
  73 * Windows: Add isochronous transfer support via libusbK
  74 * Windows: Add Visual Studio 2017 support
  75 * Windows: Fix enumeration problems on Windows 8 and later
  76 * Windows: Major rework of poll() emulation
  77 * Windows: Numerous HID API fixes
  78 * Windows: Support cancellation of individual transfers (Vista and later)
  79 * Various other bug fixes and improvements
  80
  81 2016-10-01: v1.0.21
  82 * Core: Refactor code related to transfer flags and timeout handling
  83 * Darwin: Ignore root hub simulation devices
  84 * Darwin: Improved support for OS X El Capitan
  85 * Darwin: Work around devices with buggy endpoint descriptors
  86 * Darwin: Do not use objc_registerThreadWithCollector after its deprecation
  87 * Darwin: Use C11 atomics on 10.12+ as the OS atomics are now deprecated
  88 * Linux: Support preallocating kernel memory for zerocopy USB
  89 * Linux: Deal with receiving POLLERR before all transfers have completed
  90 * Solaris: Add solaris backend
  91 * Windows: Add Visual Studio 2015 support
  92 * Windows: Add usbdk backend
  93 * Prevent attempts to recursively handle events
  94 * Fix race condition in handle_timeout()
  95 * Allow transferred argument to be optional in bulk APIs
  96 * Various other bug fixes and improvements
  97
  98 2015-09-13: v1.0.20
  99 * Add Haiku support
 100 * Fix multiple memory and resource leaks (#16, #52, #76, #81)
 101 * Fix possible deadlock when executing transfer callback
 102 * New libusb_free_pollfds() API
 103 * Darwin: Fix devices not being detected on OS X 10.8 (#48)
 104 * Linux: Allow larger isochronous transfer submission (#23)
 105 * Windows: Fix broken builds Cygwin/MinGW builds and compiler warnings
 106 * Windows: Fix broken bus number lookup
 107 * Windows: Improve submission of control requests for composite devices
 108 * Examples: Add two-stage load support to fxload (#12)
 109 * Correctly report cancellations due to timeouts
 110 * Improve efficiency of event handling
 111 * Improve speed of transfer submission in multi-threaded environments
 112 * Various other bug fixes and improvements
 113 The (#xx) numbers are libusb issue numbers, see ie:
 114 https://github.com/libusb/libusb/issues/16
 115
 116 2014-05-30: v1.0.19
 117 * Add support for USB bulk streams on Linux and Mac OS X (#11)
 118 * Windows: Add AMD and Intel USB-3.0 root hub support
 119 * Windows: Fix USB 3.0 speed detection on Windows 8 or later (#10)
 120 * Added Russian translation for libusb_strerror strings
 121 * All: Various small fixes and cleanups
 122
 123 2014-01-25: v1.0.18
 124 * Fix multiple memory leaks
 125 * Fix a crash when HID transfers return no data on Windows
 126 * Ensure all pending events are consumed
 127 * Improve Android and ucLinux support
 128 * Multiple Windows improvements (error logging, VS2013, VIA xHCI support)
 129 * Multiple OS X improvements (broken compilation, SIGFPE, 64bit support)
 130
 131 2013-09-06: v1.0.17
 132 * Hotplug callbacks now always get passed a libusb_context, even if it is
 133   the default context. Previously NULL would be passed for the default context,
 134   but since the first context created is the default context, and most apps
 135   use only 1 context, this meant that apps explicitly creating a context would
 136   still get passed NULL
 137 * Android: Add .mk files to build with the Android NDK
 138 * Darwin: Add Xcode project
 139 * Darwin: Fix crash on unplug (#121)
 140 * Linux: Fix hang (deadlock) on libusb_exit
 141 * Linux: Fix libusb build failure with --disable-udev (#124)
 142 * Linux: Fix libusb_get_device_list() hang with --disable-udev (#130)
 143 * OpenBSD: Update OpenBSD backend with support for control transfers to
 144   non-ugen(4) devices and make get_configuration() no longer generate I/O.
 145   Note that using this libusb version on OpenBSD requires using
 146   OpenBSD 5.3-current or later. Users of older OpenBSD versions are advised
 147   to stay with the libusb shipped with OpenBSD (mpi)
 148 * Windows: fix libusb_dll_2010.vcxproj link errors (#129)
 149 * Various other bug fixes and improvements
 150
 151 2013-07-11: v1.0.16
 152 * Add hotplug support for Darwin and Linux (#9)
 153 * Add superspeed endpoint companion descriptor support (#15)
 154 * Add BOS descriptor support (#15)
 155 * Make descriptor parsing code more robust
 156 * New libusb_get_port_numbers API, this is libusb_get_port_path without
 157   the unnecessary context parameter, libusb_get_port_path is now deprecated
 158 * New libusb_strerror API (#14)
 159 * New libusb_set_auto_detach_kernel_driver API (#17)
 160 * Improve topology API docs (#95)
 161 * Logging now use a single write call per log-message, avoiding log-message
 162   "interlacing" when using multiple threads.
 163 * Android: use Android logging when building on Android (#101)
 164 * Darwin: make libusb_reset reenumerate device on descriptors change (#89)
 165 * Darwin: add support for the LIBUSB_TRANSFER_ADD_ZERO_PACKET flag (#91)
 166 * Darwin: add a device cache (#112, #114)
 167 * Examples: Add sam3u_benchmark isochronous example by Harald Welte (#109)
 168 * Many other bug fixes and improvements
 169 The (#xx) numbers are libusbx issue numbers, see ie:
 170 https://github.com/libusbx/libusbx/issues/9
 171
 172 2013-04-15: v1.0.15
 173 * Improve transfer cancellation and avoid short read failures on broken descriptors
 174 * Filter out 8-bit characters in libusb_get_string_descriptor_ascii()
 175 * Add WinCE support
 176 * Add library stress tests
 177 * Add Cypress FX3 firmware upload support for fxload sample
 178 * Add HID and kernel driver detach support capabilities detection
 179 * Add SuperSpeed detection on OS X
 180 * Fix bInterval value interpretation on OS X
 181 * Fix issues with autoclaim, composite HID devices, interface autoclaim and
 182   early abort in libusb_close() on Windows. Also add VS2012 solution files.
 183 * Improve fd event handling on Linux
 184 * Other bug fixes and improvements
 185
 186 2012-09-26: v1.0.14
 187 * Reverts the previous API change with regards to bMaxPower.
 188   If this doesn't matter to you, you are encouraged to keep using v1.0.13,
 189   as it will use the same attribute as v2.0, to be released soon.
 190 * Note that LIBUSB_API_VERSION is *decreased* to 0x010000FF and the previous
 191   guidelines with regards to concurrent use of MaxPower/bMaxPower still apply.
 192
 193 2012-09-20: v1.0.13
 194 * [MAJOR] Fix a typo in the API with struct libusb_config_descriptor where
 195   MaxPower was used instead of bMaxPower, as defined in the specs. If your
 196   application was accessing the MaxPower attribute, and you need to maintain
 197   compatibility with libusb or older versions, see APPENDIX A below.
 198 * Fix broken support for the 0.1 -> 1.0 libusb-compat layer
 199 * Fix unwanted cancellation of pending timeouts as well as major timeout related bugs
 200 * Fix handling of HID and composite devices on Windows
 201 * Introduce LIBUSB_API_VERSION macro
 202 * Add Cypress FX/FX2 firmware upload sample, based on fxload from
 203   http://linux-hotplug.sourceforge.net
 204 * Add libusb0 (libusb-win32) and libusbK driver support on Windows. Note that while
 205   the drivers allow it, isochronous transfers are not supported yet in libusb. Also
 206   not supported yet is the use of libusb-win32 filter drivers on composite interfaces
 207 * Add support for the new get_capabilities ioctl on Linux and avoid unnecessary
 208   splitting of bulk transfers
 209 * Improve support for newer Intel and Renesas USB 3.0 controllers on Windows
 210 * Harmonize the device number for root hubs across platforms
 211 * Other bug fixes and improvements
 212
 213 2012-06-15: v1.0.12
 214 * Fix a potential major regression with pthread on Linux
 215 * Fix missing thread ID from debug log output on cygwin
 216 * Fix possible crash when using longjmp and MinGW's gcc 4.6
 217 * Add topology calls: libusb_get_port_number(), libusb_get_parent() & libusb_get_port_path()
 218 * Add toggleable debug, using libusb_set_debug() or the LIBUSB_DEBUG environment variable
 219 * Define log levels in libusb.h and set timestamp origin to first libusb_init() call
 220 * All logging is now sent to to stderr (info was sent to stdout previously)
 221 * Update log messages severity and avoid polluting log output on OS-X
 222 * Add HID driver support on Windows
 223 * Enable interchangeability of MSVC and MinGW DLLs
 224 * Additional bug fixes and improvements
 225
 226 2012-05-08: v1.0.11
 227 * Revert removal of critical Windows event handling that was introduced in 1.0.10
 228 * Fix a possible deadlock in Windows when submitting transfers
 229 * Add timestamped logging
 230 * Add NetBSD support (experimental) and BSD libusb_get_device_speed() data
 231 * Add bootstrap.sh alongside autogen.sh (bootstrap.sh doesn't invoke configure)
 232 * Search for device nodes in /dev for Android support
 233 * Other bug fixes
 234
 235 2012-04-17: v1.0.10
 236 * Public release
 237 * Add libusb_get_version
 238 * Add Visual Studio 2010 project files
 239 * Some Windows code cleanup
 240 * Fix xusb sample warnings
 241
 242 2012-04-02: v1.0.9
 243 * First libusbx release
 244 * Add libusb_get_device_speed (all, except BSD) and libusb_error_name
 245 * Add Windows support (WinUSB driver only)
 246 * Add OpenBSD support
 247 * Add xusb sample
 248 * Tons of bug fixes
 249
 250 2010-05-07: v1.0.8
 251 * Bug fixes
 252
 253 2010-04-19: v1.0.7
 254 * Bug fixes and documentation tweaks
 255 * Add more interface class definitions
 256
 257 2009-11-22: v1.0.6
 258 * Bug fixes
 259 * Increase libusb_handle_events() timeout to 60s for powersaving
 260
 261 2009-11-15: v1.0.5
 262  * Use timerfd when available for timer management
 263  * Small fixes/updates
 264
 265 2009-11-06: v1.0.4 release
 266  * Bug fixes including transfer locking to fix some potential threading races
 267  * More flexibility with clock types on Linux
 268  * Use new bulk continuation tracking in Linux 2.6.32 for improved handling
 269    of short/failed transfers
 270
 271 2009-08-27: v1.0.3 release
 272  * Bug fixes
 273  * Add libusb_get_max_iso_packet_size()
 274
 275 2009-06-13: v1.0.2 release
 276  * Bug fixes
 277
 278 2009-05-12: v1.0.1 release
 279  * Bug fixes
 280  * Darwin backend
 281
 282 2008-12-13: v1.0.0 release
 283  * Bug fixes
 284
 285 2008-11-21: v0.9.4 release
 286  * Bug fixes
 287  * Add libusb_attach_kernel_driver()
 288
 289 2008-08-23: v0.9.3 release
 290  * Bug fixes
 291
 292 2008-07-19: v0.9.2 release
 293  * Bug fixes
 294
 295 2008-06-28: v0.9.1 release
 296  * Bug fixes
 297  * Introduce contexts to the API
 298  * Compatibility with new Linux kernel features
 299
 300 2008-05-25: v0.9.0 release
 301  * First libusb-1.0 beta release
 302
 303 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 304
 305 APPENDIX A - How to maintain code compatibility with versions of libusb and
 306 libusb that use MaxPower:
 307
 308 If you must to maintain compatibility with versions of the library that aren't
 309 using the bMaxPower attribute in struct libusb_config_descriptor, the
 310 recommended way is to use the new LIBUSB_API_VERSION macro with an #ifdef.
 311 For instance, if your code was written as follows:
 312
 313   if (dev->config[0].MaxPower < 250)
 314
 315 Then you should modify it to have:
 316
 317 #if defined(LIBUSB_API_VERSION) && (LIBUSB_API_VERSION >= 0x01000100)
 318   if (dev->config[0].bMaxPower < 250)
 319 #else
 320   if (dev->config[0].MaxPower < 250)
 321 #endif