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