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