blob: 2b076b34aca85f498335c741b7fedd189d76400b [file] [log] [blame]
Pete Batardf17d1902012-09-25 00:35:32 +01001For detailed information about the changes below, please see the git log or
hjelmn@cs.unm.edu1eff2202014-01-08 23:50:34 +00002visit: http://log.libusb.info
Pete Batardf17d1902012-09-25 00:35:32 +01003
Nathan Hjelm4eca4182016-10-01 06:49:09 -060042016-10-01: v1.0.21:
Nathan Hjelme5b09f32016-08-21 20:32:39 -06005* Core: Refactor code related to transfer flags and timeout handling
Nathan Hjelm7ce85c42016-07-21 23:12:56 -06006* Darwin: Ignore root hub simulation devices
7* Darwin: Improved support for OS X El Capitan
Nathan Hjelm7f5f86f2016-09-12 21:42:23 -06008* 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
Nathan Hjelm69767332016-07-22 06:38:09 -060011* Linux: Support preallocating kernel memory for zerocopy USB
Nathan Hjelme5b09f32016-08-21 20:32:39 -060012* Linux: Deal with receiving POLLERR before all transfers have completed
Nathan Hjelmbb014d82016-07-24 20:01:15 -060013* Solaris: Add solaris backend
Nathan Hjelm7ce85c42016-07-21 23:12:56 -060014* Windows: Add Visual Studio 2015 support
Nathan Hjelm73d15d12016-09-14 12:32:54 -060015* Windows: Add usbdk backend
Nathan Hjelme5b09f32016-08-21 20:32:39 -060016* Prevent attempts to recursively handle events
Nathan Hjelm7ce85c42016-07-21 23:12:56 -060017* Fix race condition in handle_timeout()
18* Allow transferred argument to be optional in bulk APIs
19* Various other bug fixes and improvements
20
Chris Dickensb5991a92015-09-13 17:37:12 -0700212015-09-13: v1.0.20
Chris Dickensd73bc722015-07-29 01:06:37 -070022* 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
Chris Dickens8f2d5bb2015-09-02 19:54:44 -070031* Examples: Add two-stage load support to fxload (#12)
32* Correctly report cancellations due to timeouts
Chris Dickensd73bc722015-07-29 01:06:37 -070033* Improve efficiency of event handling
34* Improve speed of transfer submission in multi-threaded environments
35* Various other bug fixes and improvements
36The (#xx) numbers are libusb issue numbers, see ie:
37https://github.com/libusb/libusb/issues/16
38
Hans de Goedef3587bb2014-05-30 14:48:28 +0200392014-05-30: v1.0.19
Hans de Goedeedaa1af2014-05-02 15:25:26 +020040* 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)
Hans de Goede5e77b882014-05-19 11:33:03 +020043* Added Russian translation for libusb_strerror strings
Hans de Goedeedaa1af2014-05-02 15:25:26 +020044* All: Various small fixes and cleanups
Hans de Goedeedaa1af2014-05-02 15:25:26 +020045
Pete Batarda2f2c312014-01-25 22:43:39 +0000462014-01-25: v1.0.18
Pete Batard9a34bb72014-01-08 23:51:38 +000047* 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
Hans de Goede0c3d17c2013-09-06 11:20:53 +0200542013-09-06: v1.0.17
Hans de Goede65129432013-08-28 10:17:53 +020055* 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
hjelmn@cs.unm.edu1eff2202014-01-08 23:50:34 +000064* Linux: Fix libusb build failure with --disable-udev (#124)
Hans de Goede65129432013-08-28 10:17:53 +020065* 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.
hjelmn@cs.unm.edu1eff2202014-01-08 23:50:34 +000068 Note that using this libusb version on OpenBSD requires using
Hans de Goede65129432013-08-28 10:17:53 +020069 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
Hans de Goede65129432013-08-28 10:17:53 +020073
Hans de Goeded1ed6c42013-07-11 11:04:02 +0200742013-07-11: v1.0.16
Hans de Goedee2fe75e2013-06-20 15:18:10 +020075* 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)
Hans de Goedefaa62412013-07-06 09:09:25 +020083* Improve topology API docs (#95)
Hans de Goedeea39a142013-07-01 13:00:43 +020084* Logging now use a single write call per log-message, avoiding log-message
85 "interlacing" when using multiple threads.
Hans de Goedee2fe75e2013-06-20 15:18:10 +020086* 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
92The (#xx) numbers are libusbx issue numbers, see ie:
93https://github.com/libusbx/libusbx/issues/9
94
Pete Batard85f1bed2013-04-15 23:15:10 +0100952013-04-15: v1.0.15
Pete Batardad3e3d42013-04-04 19:03:15 +010096* Improve transfer cancellation and avoid short read failures on broken descriptors
Pete Batard196acee2013-04-02 19:52:16 +010097* Filter out 8-bit characters in libusb_get_string_descriptor_ascii()
98* Add WinCE support
99* Add library stress tests
Pete Batardad3e3d42013-04-04 19:03:15 +0100100* Add Cypress FX3 firmware upload support for fxload sample
Pete Batard196acee2013-04-02 19:52:16 +0100101* Add HID and kernel driver detach support capabilities detection
102* Add SuperSpeed detection on OS X
Pete Batard85f1bed2013-04-15 23:15:10 +0100103* Fix bInterval value interpretation on OS X
Pete Batard196acee2013-04-02 19:52:16 +0100104* Fix issues with autoclaim, composite HID devices, interface autoclaim and
Pete Batardad3e3d42013-04-04 19:03:15 +0100105 early abort in libusb_close() on Windows. Also add VS2012 solution files.
Pete Batard196acee2013-04-02 19:52:16 +0100106* Improve fd event handling on Linux
107* Other bug fixes and improvements
108
Pete Batardf17d1902012-09-25 00:35:32 +01001092012-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.
hjelmn@cs.unm.edu1eff2202014-01-08 23:50:34 +0000113* Note that LIBUSB_API_VERSION is *decreased* to 0x010000FF and the previous
Pete Batard85f1bed2013-04-15 23:15:10 +0100114 guidelines with regards to concurrent use of MaxPower/bMaxPower still apply.
Pete Batardf17d1902012-09-25 00:35:32 +0100115
1162012-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
hjelmn@cs.unm.edu1eff2202014-01-08 23:50:34 +0000124* Introduce LIBUSB_API_VERSION macro
Pete Batardf17d1902012-09-25 00:35:32 +0100125* 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
hjelmn@cs.unm.edu1eff2202014-01-08 23:50:34 +0000128 the drivers allow it, isochronous transfers are not supported yet in libusb. Also
Pete Batardf17d1902012-09-25 00:35:32 +0100129 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
1362012-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
1492012-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
1582012-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
1652012-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
1732010-05-07: v1.0.8
174* Bug fixes
175
1762010-04-19: v1.0.7
177* Bug fixes and documentation tweaks
178* Add more interface class definitions
179
1802009-11-22: v1.0.6
181* Bug fixes
182* Increase libusb_handle_events() timeout to 60s for powersaving
183
1842009-11-15: v1.0.5
185 * Use timerfd when available for timer management
186 * Small fixes/updates
187
1882009-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
1942009-08-27: v1.0.3 release
195 * Bug fixes
196 * Add libusb_get_max_iso_packet_size()
197
1982009-06-13: v1.0.2 release
199 * Bug fixes
200
2012009-05-12: v1.0.1 release
202 * Bug fixes
203 * Darwin backend
204
2052008-12-13: v1.0.0 release
206 * Bug fixes
207
2082008-11-21: v0.9.4 release
209 * Bug fixes
210 * Add libusb_attach_kernel_driver()
211
2122008-08-23: v0.9.3 release
213 * Bug fixes
214
2152008-07-19: v0.9.2 release
216 * Bug fixes
217
2182008-06-28: v0.9.1 release
219 * Bug fixes
220 * Introduce contexts to the API
221 * Compatibility with new Linux kernel features
222
2232008-05-25: v0.9.0 release
224 * First libusb-1.0 beta release
225
226~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
227
228APPENDIX A - How to maintain code compatibility with versions of libusb and
hjelmn@cs.unm.edu1eff2202014-01-08 23:50:34 +0000229libusb that use MaxPower:
Pete Batardf17d1902012-09-25 00:35:32 +0100230
231If you must to maintain compatibility with versions of the library that aren't
232using the bMaxPower attribute in struct libusb_config_descriptor, the
hjelmn@cs.unm.edu1eff2202014-01-08 23:50:34 +0000233recommended way is to use the new LIBUSB_API_VERSION macro with an #ifdef.
Pete Batardf17d1902012-09-25 00:35:32 +0100234For instance, if your code was written as follows:
235
236 if (dev->config[0].MaxPower < 250)
237
238Then you should modify it to have:
239
hjelmn@cs.unm.edu1eff2202014-01-08 23:50:34 +0000240#if defined(LIBUSB_API_VERSION) && (LIBUSB_API_VERSION >= 0x01000100)
Pete Batardf17d1902012-09-25 00:35:32 +0100241 if (dev->config[0].bMaxPower < 250)
242#else
243 if (dev->config[0].MaxPower < 250)
244#endif