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