mirror of
git://sigrok.org/libserialport
synced 2023-08-10 21:13:24 +03:00
libserialport (sometimes abbreviated as "sp") is a minimal, cross-platform shared library written in C that is intended to take care of the OS-specific details when writing software that uses serial ports.
http://sigrok.org/wiki/Libserialport
2149db9e93
These cases are all in the sp_[non]blocking_{read,write} functions.
On MSVC, these conversions would generate warnings such as:
warning C4267: '=': conversion from 'size_t' to 'DWORD', possible loss of data
The warnings are genuine. There are some places where overflow is technically
possible, due to our use of size_t for sizes in function parameters (unsigned
64-bit on Windows x64), but an enum for return values (typically signed int
and 32-bit, but not guaranteed to be so by the standards), plus the Win32 API
usage of DWORD (unsigned 32-bit) for sizes in ReadFile/WriteFile.
However, overflow in practice would require reading/writing more than 2GB
over a serial port in a single call and is therefore unlikely to be a
real-world concern. I have therefore not tried to catch those cases - but the
places it is possible do now have explicit casts to the smaller types so that
they are more obvious.
We could document and test for a maximum read/write size of INT_MAX, but that
would still depend on the storage of 'enum sp_return' being at least a signed
int, which as I understand it the C standard does not require.
To be absolutely correct we would need a different API where sp_return
was only used for result codes, and the read/write functions took a
pointer to size_t for result sizes.
|
||
|---|---|---|
| examples | ||
| .gitignore | ||
| AUTHORS | ||
| autogen.sh | ||
| common.props | ||
| config-fields | ||
| config-header.py | ||
| config-pattern | ||
| configure.ac | ||
| COPYING | ||
| debug.props | ||
| Doxyfile | ||
| freebsd.c | ||
| libserialport_internal.h | ||
| libserialport.h | ||
| libserialport.pc.in | ||
| libserialport.sln | ||
| libserialport.vcxproj | ||
| libserialport.vcxproj.filters | ||
| linux_termios.c | ||
| linux_termios.h | ||
| linux.c | ||
| macosx.c | ||
| Makefile.am | ||
| NEWS | ||
| README | ||
| release.props | ||
| serialport.c | ||
| test_timing.c | ||
| timing.c | ||
| windows.c | ||
------------------------------------------------------------------------------- libserialport: cross-platform library for accessing serial ports ------------------------------------------------------------------------------- libserialport is a minimal library written in C that is intended to take care of the OS-specific details when writing software that uses serial ports. By writing your serial code to use libserialport, you enable it to work transparently on any platform supported by the library. The operations that are supported are: - Port enumeration (obtaining a list of serial ports on the system). - Obtaining port metadata (USB device information, Bluetooth address, etc). - Opening and closing ports. - Setting port parameters (baud rate, parity, etc). - Reading, writing and flushing data. - Obtaining error information. libserialport is an open source project released under the LGPL3+ license. Status ====== The library should build and work on any Windows or Unix-based system. If it does not, please submit a bug. Enumeration is currently implemented on Windows, Mac OS X, FreeBSD and Linux. On other systems enumeration is not supported, but ports can still be opened by name and then used. If you know how to enumerate available ports on another OS, please submit a bug with this information, or better still a patch implementing it. Dependencies ============ No other libraries are required. Building ======== The package uses a GNU style build system and requires a Unix style shell. Windows builds can be created natively with the MinGW-w64 toolchain and MSYS2 environment, or cross-compiled using a MinGW-w64 toolchain: http://mingw-w64.sourceforge.net/ The "old" MinGW from http://mingw.org/ is not supported. Run "./autogen.sh" to generate the build system, "./configure" to setup, then "make" to build the library and "make install" to install it. API === Doxygen API documentation is included. It can also be viewed online at: http://sigrok.org/api/libserialport/unstable/ Bug reports =========== You can report bugs for libserialport at https://sigrok.org/bugzilla. Mailing list ============ https://lists.sourceforge.net/lists/listinfo/sigrok-devel IRC === You can find the developers in the #sigrok IRC channel on Freenode. Website ======= http://sigrok.org/wiki/Libserialport