ChangeLog 14 KB

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