windows: Use correct variant of FormatMessage.
[libserialport/gsi.git] / NEWS
blob7afa688cb343b6351aaccdd42394b866efdcd8e6
1 0.1.1 (2016-01-27)
2 ------------------
4 Note: This release does NOT change the libserialport API or ABI in
5       backwards-incompatible ways. Programs using libserialport should
6       continue to work fine without recompiling or relinking.
8  * New API calls:
9    - sp_get_port_description(): Obtain a user friendly port description.
10    - sp_get_port_transport(): Obtain the underlying transport type.
11    - sp_get_port_usb_bus_address(): Obtain the USB bus number & device address.
12    - sp_get_port_usb_vid_pid(): Obtain the USB VID and PID.
13    - sp_get_port_usb_manufacturer(): Obtain the USB manufacturer string.
14    - sp_get_port_usb_product(): Obtain the USB product string.
15    - sp_get_port_usb_serial(): Obtain the USB serial number string.
16    - sp_get_port_bluetooth_address(): Obtain the Bluetooth MAC address.
17    - sp_blocking_read_next(): Read bytes from the specified serial port,
18      returning as soon as any data is available.
19  * API related additions:
20    - enum sp_mode: Add SP_MODE_READ_WRITE.
21    - Add enum sp_transport with the following enum entries:
22      SP_TRANSPORT_NATIVE, SP_TRANSPORT_USB, SP_TRANSPORT_BLUETOOTH.
23  * Fix the build on platforms where port enumeration and/or port
24    metadata is not available or implemented.
25  * Build system:
26    - Don't set/override "user variables" such as CFLAGS or LDFLAGS, since
27      those are meant to be controlled by the "user" (bug #577).
28    - Modernize and cleanup autotools setup.
29  * Remove trailing commas in libserialport.h enum definitions to allow
30    the code to build with the -pedantic compiler option.
31  * Fix various issues to allow successful builds with -std=c99.
32  * Fix various (non-fatal) compiler warnings.
33  * Fix various memory leaks (bug #419, among others).
34  * Fix a potential overflow of the timeout parameter of poll().
35  * Fix ReadFile() ERROR_IO_PENDING in sp_nonblocking_read() (bug #707).
36  * Fix a glibc >= 2.20 compiler warning for deprecated _BSD_SOURCE (bug #716).
37  * Rename a 'signals' parameter to 'signal_mask' to avoid a conflict with Qt.
38  * Fix two potential segfaults in sp_get_port_handle() and sp_get_config_*()
39    (which only occurred if the user incorrectly passed in a NULL argument).
40  * sp_list_ports(): Actually set list_ptr NULL as documented.
41  * Use "Port not open" debug message when a closed port is used (bug #710).
42  * Linux:
43    - The libudev requirement has been dropped (/sys is now used directly).
44    - Fix a build issue in the get_termios_get_ioctl() call (bug #396).
45    - Fix sp_flush() so that it only flushes the requested buffers.
46    - Fix a build error if BOTHER is not available (bug #363).
47    - If present, add the USB "description" for better port identification.
48    - Handle the case when /sys/class/tty/ entries are not symlinks.
49  * Windows:
50    - MinGW-w64 (mingw-w64.sf.net) is now required for building, and MinGW
51      (mingw.org) is no longer supported (bug #393).
52    - Fix a build issue due to a missing <initguid.h> #include.
53    - Fix a build issue due to the missing -lsetupapi linker argument.
54    - Use libtool's -no-undefined option to allow shared (DLL) builds.
55    - Fix a compile error due to multiply or not defined GUIDs (bug #416).
56    - Fix a build issue related to the SP_PRIV/SP_API macros (bug #553).
57    - Fix a bug where an uninitialized pointer was free()'d (bug #512).
58    - Fix a bug wrt the SetupDiOpenDevRegKey() return code (bug #499).
59    - Fix a bug wrt restart of RX/error wait operations after read (bug #421).
60    - Fix a bug wrt WaitCommEvents() and/or fAbortOnError handling (bug #341).
61    - Fix USB iSerial queries on USB composite devices.
62    - Strip CR/LF from end of system error messages (bug #585).
63    - Avoid unnecessary calls to the SetCommTimeouts() function (bug #586).
64    - Fix a bug in the Windows implementation of sp_blocking_read_next().
65    - Fix an ERROR_SEM_TIMEOUT related issue in sp_blocking_write().
66  * FreeBSD:
67    - Implement serial port enumeration for FreeBSD systems.
68  * Android:
69    - Fix a portability issue wrt the unavailable 'serial_struct' (bug #376).
70    - Fix a portability issue wrt a readlinkat() call (bug #377).
71  * Mac OS X:
72    - Fix port listing on Mac OS X 10.11 (El Capitan).
73  * README: Various documentation updates and fixes.
74  * AUTHORS: Add/update list of contributors.
75  * Doxygen API docs: Various documentation updates and fixes.
77 0.1.0 (2014-05-06)
78 ------------------
80  * Initial release.