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