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