2 * This file is part of the libserialport project.
4 * Copyright (C) 2013, 2015 Martin Ling <martin-libserialport@earth.li>
5 * Copyright (C) 2014 Uwe Hermann <uwe@hermann-uwe.de>
6 * Copyright (C) 2014 Aurelien Jacobs <aurel@gnuage.org>
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU Lesser General Public License as
10 * published by the Free Software Foundation, either version 3 of the
11 * License, or (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 * @mainpage libserialport API
28 * libserialport is a minimal library written in C that is intended to take
29 * care of the OS-specific details when writing software that uses serial ports.
31 * By writing your serial code to use libserialport, you enable it to work
32 * transparently on any platform supported by the library.
34 * libserialport is an open source project released under the LGPL3+ license.
36 * The library is maintained by the [sigrok](http://sigrok.org/) project. See
37 * the [libserialport homepage](http://sigrok.org/wiki/Libserialport) for the
40 * Source code is maintained in git at
41 * [git://sigrok.org/libserialport](http://sigrok.org/gitweb/?p=libserialport.git).
43 * Bugs are tracked at http://sigrok.org/bugzilla/.
45 * The library was conceived and designed by Martin Ling, is maintained by
46 * Uwe Hermann, and has received contributions from several other developers.
47 * See the git history for full credits.
52 * The API has been designed from scratch. It does not exactly resemble the
53 * serial API of any particular operating system. Instead it aims to provide
54 * a set of functions that can reliably be implemented across all operating
55 * systems. These form a sufficient basis for higher level behaviour to
56 * be implemented in a platform independent manner.
58 * If you are porting code written for a particular OS, you may find you need
59 * to restructure things somewhat, or do without some specialised features.
60 * For particular notes on porting existing code, see @ref Porting.
65 * Some simple example programs using libserialport are included in the
66 * @c examples directory in the source package:
68 * - @ref list_ports.c - Getting a list of ports present on the system.
69 * - @ref port_info.c - Getting information on a particular serial port.
71 * These examples are linked with the API documentation. Each function
72 * in the API reference includes links to where it is used in an example
73 * program, and each appearance of a function in the examples links
74 * to that function's entry in the API reference.
79 * To use libserialport functions in your code, you should include the
80 * libserialport.h header, i.e. {@code #include <libserialport.h>}
85 * All identifiers defined by the public libserialport headers use the prefix
86 * @c sp_ (for functions and data types) or @c SP_ (for macros and constants).
91 * The functions provided by the library are documented in detail in
92 * the following sections:
94 * - @ref Enumeration (obtaining a list of serial ports on the system)
95 * - @ref Ports (opening, closing and getting information about ports)
96 * - @ref Configuration (baud rate, parity, etc.)
97 * - @ref Signals (modem control lines, breaks, etc.)
98 * - @ref Data (reading and writing data, and buffer management)
99 * - @ref Waiting (waiting for ports to be ready, integrating with event loops)
100 * - @ref Errors (getting error and debugging information)
105 * The library defines three data structures:
107 * - @ref sp_port, which represents a serial port.
108 * See @ref Enumeration.
109 * - @ref sp_port_config, which represents a port configuration.
110 * See @ref Configuration.
111 * - @ref sp_event_set, which represents a set of events.
114 * All these structures are allocated and freed by library functions. It is
115 * the caller's responsibility to ensure that the correct calls are made to
116 * free allocated structures after use.
118 * Return codes and error handling
119 * -------------------------------
121 * Most functions have return type @ref sp_return and can return only four
122 * possible error values:
124 * - @ref SP_ERR_ARG means that a function was called with invalid
125 * arguments. This implies a bug in the caller. The arguments passed would
126 * be invalid regardless of the underlying OS or serial device involved.
128 * - @ref SP_ERR_FAIL means that the OS reported a failure. The error code or
129 * message provided by the OS can be obtained by calling sp_last_error_code()
130 * or sp_last_error_message().
132 * - @ref SP_ERR_SUPP indicates that there is no support for the requested
133 * operation in the current OS, driver or device. No error message is
134 * available from the OS in this case. There is either no way to request
135 * the operation in the first place, or libserialport does not know how to
136 * do so in the current version.
138 * - @ref SP_ERR_MEM indicates that a memory allocation failed.
140 * All of these error values are negative.
142 * Calls that succeed return @ref SP_OK, which is equal to zero. Some functions
143 * declared @ref sp_return can also return a positive value for a successful
144 * numeric result, e.g. sp_blocking_read() or sp_blocking_write().
146 * An error message is only available via sp_last_error_message() in the case
147 * where @ref SP_ERR_FAIL was returned by the previous function call. The error
148 * message returned is that provided by the OS, using the current language
149 * settings. It is an error to call sp_last_error_code() or
150 * sp_last_error_message() except after a previous function call returned
151 * @ref SP_ERR_FAIL. The library does not define its own error codes or
152 * messages to accompany other return codes.
157 * Certain combinations of calls can be made concurrently, as follows.
159 * - Calls using different ports may always be made concurrently, i.e.
160 * it is safe for separate threads to handle their own ports.
162 * - Calls using the same port may be made concurrently when one call
163 * is a read operation and one call is a write operation, i.e. it is safe
164 * to use separate "reader" and "writer" threads for the same port. See
165 * below for which operations meet these definitions.
169 * - sp_blocking_read()
170 * - sp_blocking_read_next()
171 * - sp_nonblocking_read()
172 * - sp_input_waiting()
173 * - sp_flush() with @ref SP_BUF_INPUT only.
174 * - sp_wait() with @ref SP_EVENT_RX_READY only.
178 * - sp_blocking_write()
179 * - sp_nonblocking_write()
180 * - sp_output_waiting()
182 * - sp_flush() with @ref SP_BUF_OUTPUT only.
183 * - sp_wait() with @ref SP_EVENT_TX_READY only.
185 * If two calls, on the same port, do not fit into one of these categories
186 * each, then they may not be made concurrently.
191 * The library can output extensive tracing and debugging information. The
192 * simplest way to use this is to set the environment variable
193 * @c LIBSERIALPORT_DEBUG to any value; messages will then be output to the
194 * standard error stream.
196 * This behaviour is implemented by a default debug message handling
197 * callback. An alternative callback can be set using sp_set_debug_handler(),
198 * in order to e.g. redirect the output elsewhere or filter it.
200 * No guarantees are made about the content of the debug output; it is chosen
201 * to suit the needs of the developers and may change between releases.
207 * The following guidelines may help when porting existing OS-specific code
208 * to use libserialport.
210 * ### Porting from Unix-like systems ###
212 * There are two main differences to note when porting code written for Unix.
214 * The first is that Unix traditionally provides a wide range of functionality
215 * for dealing with serial devices at the OS level; this is exposed through the
216 * termios API and dates to the days when serial terminals were common. If your
217 * code relies on many of these facilities you will need to adapt it, because
218 * libserialport provides only a raw binary channel with no special handling.
220 * The second relates to blocking versus non-blocking I/O behaviour. In
221 * Unix-like systems this is normally specified by setting the @c O_NONBLOCK
222 * flag on the file descriptor, affecting the semantics of subsequent @c read()
223 * and @c write() calls.
225 * In libserialport, blocking and nonblocking operations are both available at
226 * any time. If your existing code Ń•ets @c O_NONBLOCK, you should use
227 * sp_nonblocking_read() and sp_nonblocking_write() to get the same behaviour
228 * as your existing @c read() and @c write() calls. If it does not, you should
229 * use sp_blocking_read() and sp_blocking_write() instead. You may also find
230 * sp_blocking_read_next() useful, which reproduces the semantics of a blocking
231 * read() with @c VTIME=0 and @c VMIN=1 set in termios.
233 * Finally, you should take care if your program uses custom signal handlers.
234 * The blocking calls provided by libserialport will restart system calls that
235 * return with @c EINTR, so you will need to make your own arrangements if you
236 * need to interrupt blocking operations when your signal handlers are called.
237 * This is not an issue if you only use the default handlers.
239 * ### Porting from Windows ###
241 * The main consideration when porting from Windows is that there is no
242 * direct equivalent for overlapped I/O operations.
244 * If your program does not use overlapped I/O, you can simply use
245 * sp_blocking_read() and sp_blocking_write() as direct equivalents for
246 * @c ReadFile() and @c WriteFile(). You may also find sp_blocking_read_next()
247 * useful, which reproduces the special semantics of @c ReadFile() with
248 * @c ReadIntervalTimeout and @c ReadTotalTimeoutMultiplier set to @c MAXDWORD
249 * and @c ReadTotalTimeoutConstant set to between @c 1 and @c MAXDWORD-1 .
251 * If your program makes use of overlapped I/O to continue work while a serial
252 * operation is in progress, then you can achieve the same results using
253 * sp_nonblocking_read() and sp_nonblocking_write().
255 * Generally, overlapped I/O is combined with either waiting for completion
256 * once there is no more background work to do (using @c WaitForSingleObject()
257 * or @c WaitForMultipleObjects()), or periodically checking for completion
258 * with @c GetOverlappedResult(). If the aim is to start a new operation for
259 * further data once the previous one has completed, you can instead simply
260 * call the nonblocking functions again with the next data. If you need to
261 * wait for completion, use sp_wait() to determine when the port is ready to
262 * send or receive further data.
265 #ifndef LIBSERIALPORT_LIBSERIALPORT_H
266 #define LIBSERIALPORT_LIBSERIALPORT_H
274 /** Return values. */
276 /** Operation completed successfully. */
278 /** Invalid arguments were passed to the function. */
280 /** A system error occurred while executing the operation. */
282 /** A memory allocation failed while executing the operation. */
284 /** The requested operation is not supported by this system or device. */
288 /** Port access modes. */
290 /** Open port for read access. */
292 /** Open port for write access. */
294 /** Open port for read and write access. @since 0.1.1 */
295 SP_MODE_READ_WRITE = 3
300 /** Data received and ready to read. */
301 SP_EVENT_RX_READY = 1,
302 /** Ready to transmit new data. */
303 SP_EVENT_TX_READY = 2,
304 /** Error occurred. */
308 /** Buffer selection. */
312 /** Output buffer. */
318 /** Parity settings. */
320 /** Special value to indicate setting should be left alone. */
321 SP_PARITY_INVALID = -1,
334 /** RTS pin behaviour. */
336 /** Special value to indicate setting should be left alone. */
342 /** RTS used for flow control. */
343 SP_RTS_FLOW_CONTROL = 2
346 /** CTS pin behaviour. */
348 /** Special value to indicate setting should be left alone. */
352 /** CTS used for flow control. */
353 SP_CTS_FLOW_CONTROL = 1
356 /** DTR pin behaviour. */
358 /** Special value to indicate setting should be left alone. */
364 /** DTR used for flow control. */
365 SP_DTR_FLOW_CONTROL = 2
368 /** DSR pin behaviour. */
370 /** Special value to indicate setting should be left alone. */
374 /** DSR used for flow control. */
375 SP_DSR_FLOW_CONTROL = 1
378 /** XON/XOFF flow control behaviour. */
380 /** Special value to indicate setting should be left alone. */
381 SP_XONXOFF_INVALID = -1,
382 /** XON/XOFF disabled. */
383 SP_XONXOFF_DISABLED = 0,
384 /** XON/XOFF enabled for input only. */
386 /** XON/XOFF enabled for output only. */
388 /** XON/XOFF enabled for input and output. */
392 /** Standard flow control combinations. */
393 enum sp_flowcontrol {
394 /** No flow control. */
395 SP_FLOWCONTROL_NONE = 0,
396 /** Software flow control using XON/XOFF characters. */
397 SP_FLOWCONTROL_XONXOFF = 1,
398 /** Hardware flow control using RTS/CTS signals. */
399 SP_FLOWCONTROL_RTSCTS = 2,
400 /** Hardware flow control using DTR/DSR signals. */
401 SP_FLOWCONTROL_DTRDSR = 3
404 /** Input signals. */
406 /** Clear to send. */
408 /** Data set ready. */
410 /** Data carrier detect. */
412 /** Ring indicator. */
422 /** Native platform serial port. @since 0.1.1 */
424 /** USB serial port adapter. @since 0.1.1 */
426 /** Bluetooth serial port adapter. @since 0.1.1 */
427 SP_TRANSPORT_BLUETOOTH
432 * An opaque structure representing a serial port.
437 * @struct sp_port_config
438 * An opaque structure representing the configuration for a serial port.
440 struct sp_port_config;
443 * @struct sp_event_set
444 * A set of handles to wait on for events.
446 struct sp_event_set {
447 /** Array of OS-specific handles. */
449 /** Array of bitmasks indicating which events apply for each handle. */
450 enum sp_event *masks;
451 /** Number of handles. */
456 * @defgroup Enumeration Port enumeration
458 * Enumerating the serial ports of a system.
460 * See @ref list_ports.c for a working example of port enumeration.
466 * Obtain a pointer to a new sp_port structure representing the named port.
468 * The user should allocate a variable of type "struct sp_port *" and pass a
469 * pointer to this to receive the result.
471 * The result should be freed after use by calling sp_free_port().
473 * @param[in] portname The OS-specific name of a serial port. Must not be NULL.
474 * @param[out] port_ptr If any error is returned, the variable pointed to by
475 * port_ptr will be set to NULL. Otherwise, it will be set
476 * to point to the newly allocated port. Must not be NULL.
478 * @return SP_OK upon success, a negative error code otherwise.
482 enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_ptr);
485 * Free a port structure obtained from sp_get_port_by_name() or sp_copy_port().
487 * @param[in] port Pointer to a port structure. Must not be NULL.
491 void sp_free_port(struct sp_port *port);
494 * List the serial ports available on the system.
496 * The result obtained is an array of pointers to sp_port structures,
497 * terminated by a NULL. The user should allocate a variable of type
498 * "struct sp_port **" and pass a pointer to this to receive the result.
500 * The result should be freed after use by calling sp_free_port_list().
501 * If a port from the list is to be used after freeing the list, it must be
502 * copied first using sp_copy_port().
504 * @param[out] list_ptr If any error is returned, the variable pointed to by
505 * list_ptr will be set to NULL. Otherwise, it will be set
506 * to point to the newly allocated array. Must not be NULL.
508 * @return SP_OK upon success, a negative error code otherwise.
512 enum sp_return sp_list_ports(struct sp_port ***list_ptr);
515 * Make a new copy of an sp_port structure.
517 * The user should allocate a variable of type "struct sp_port *" and pass a
518 * pointer to this to receive the result.
520 * The copy should be freed after use by calling sp_free_port().
522 * @param[in] port Pointer to a port structure. Must not be NULL.
523 * @param[out] copy_ptr If any error is returned, the variable pointed to by
524 * copy_ptr will be set to NULL. Otherwise, it will be set
525 * to point to the newly allocated copy. Must not be NULL.
527 * @return SP_OK upon success, a negative error code otherwise.
531 enum sp_return sp_copy_port(const struct sp_port *port, struct sp_port **copy_ptr);
534 * Free a port list obtained from sp_list_ports().
536 * This will also free all the sp_port structures referred to from the list;
537 * any that are to be retained must be copied first using sp_copy_port().
539 * @param[in] ports Pointer to a list of port structures. Must not be NULL.
543 void sp_free_port_list(struct sp_port **ports);
547 * @defgroup Ports Port handling
549 * Opening, closing and querying ports.
551 * See @ref port_info.c for a working example of getting port information.
557 * Open the specified serial port.
559 * @param[in] port Pointer to a port structure. Must not be NULL.
560 * @param[in] flags Flags to use when opening the serial port.
562 * @return SP_OK upon success, a negative error code otherwise.
566 enum sp_return sp_open(struct sp_port *port, enum sp_mode flags);
569 * Close the specified serial port.
571 * @param[in] port Pointer to a port structure. Must not be NULL.
573 * @return SP_OK upon success, a negative error code otherwise.
577 enum sp_return sp_close(struct sp_port *port);
580 * Get the name of a port.
582 * The name returned is whatever is normally used to refer to a port on the
583 * current operating system; e.g. for Windows it will usually be a "COMn"
584 * device name, and for Unix it will be a device path beginning with "/dev/".
586 * @param[in] port Pointer to a port structure. Must not be NULL.
588 * @return The port name, or NULL if an invalid port is passed. The name
589 * string is part of the port structure and may not be used after
590 * the port structure has been freed.
594 char *sp_get_port_name(const struct sp_port *port);
597 * Get a description for a port, to present to end user.
599 * @param[in] port Pointer to a port structure. Must not be NULL.
601 * @return The port description, or NULL if an invalid port is passed.
602 * The description string is part of the port structure and may not
603 * be used after the port structure has been freed.
607 char *sp_get_port_description(const struct sp_port *port);
610 * Get the transport type used by a port.
612 * @param[in] port Pointer to a port structure. Must not be NULL.
614 * @return The port transport type.
618 enum sp_transport sp_get_port_transport(const struct sp_port *port);
621 * Get the USB bus number and address on bus of a USB serial adapter port.
623 * @param[in] port Pointer to a port structure. Must not be NULL.
624 * @param[out] usb_bus Pointer to a variable to store the USB bus.
625 * Can be NULL (in that case it will be ignored).
626 * @param[out] usb_address Pointer to a variable to store the USB address.
627 * Can be NULL (in that case it will be ignored).
629 * @return SP_OK upon success, a negative error code otherwise.
633 enum sp_return sp_get_port_usb_bus_address(const struct sp_port *port,
634 int *usb_bus, int *usb_address);
637 * Get the USB Vendor ID and Product ID of a USB serial adapter port.
639 * @param[in] port Pointer to a port structure. Must not be NULL.
640 * @param[out] usb_vid Pointer to a variable to store the USB VID.
641 * Can be NULL (in that case it will be ignored).
642 * @param[out] usb_pid Pointer to a variable to store the USB PID.
643 * Can be NULL (in that case it will be ignored).
645 * @return SP_OK upon success, a negative error code otherwise.
649 enum sp_return sp_get_port_usb_vid_pid(const struct sp_port *port, int *usb_vid, int *usb_pid);
652 * Get the USB manufacturer string of a USB serial adapter port.
654 * @param[in] port Pointer to a port structure. Must not be NULL.
656 * @return The port manufacturer string, or NULL if an invalid port is passed.
657 * The manufacturer string is part of the port structure and may not
658 * be used after the port structure has been freed.
662 char *sp_get_port_usb_manufacturer(const struct sp_port *port);
665 * Get the USB product string of a USB serial adapter port.
667 * @param[in] port Pointer to a port structure. Must not be NULL.
669 * @return The port product string, or NULL if an invalid port is passed.
670 * The product string is part of the port structure and may not be
671 * used after the port structure has been freed.
675 char *sp_get_port_usb_product(const struct sp_port *port);
678 * Get the USB serial number string of a USB serial adapter port.
680 * @param[in] port Pointer to a port structure. Must not be NULL.
682 * @return The port serial number, or NULL if an invalid port is passed.
683 * The serial number string is part of the port structure and may
684 * not be used after the port structure has been freed.
688 char *sp_get_port_usb_serial(const struct sp_port *port);
691 * Get the MAC address of a Bluetooth serial adapter port.
693 * @param[in] port Pointer to a port structure. Must not be NULL.
695 * @return The port MAC address, or NULL if an invalid port is passed.
696 * The MAC address string is part of the port structure and may not
697 * be used after the port structure has been freed.
701 char *sp_get_port_bluetooth_address(const struct sp_port *port);
704 * Get the operating system handle for a port.
706 * The type of the handle depends on the operating system. On Unix based
707 * systems, the handle is a file descriptor of type "int". On Windows, the
708 * handle is of type "HANDLE". The user should allocate a variable of the
709 * appropriate type and pass a pointer to this to receive the result.
711 * To obtain a valid handle, the port must first be opened by calling
712 * sp_open() using the same port structure.
714 * After the port is closed or the port structure freed, the handle may
715 * no longer be valid.
717 * @warning This feature is provided so that programs may make use of
718 * OS-specific functionality where desired. Doing so obviously
719 * comes at a cost in portability. It also cannot be guaranteed
720 * that direct usage of the OS handle will not conflict with the
721 * library's own usage of the port. Be careful.
723 * @param[in] port Pointer to a port structure. Must not be NULL.
724 * @param[out] result_ptr If any error is returned, the variable pointed to by
725 * result_ptr will have unknown contents and should not
726 * be used. Otherwise, it will be set to point to the
727 * OS handle. Must not be NULL.
729 * @return SP_OK upon success, a negative error code otherwise.
733 enum sp_return sp_get_port_handle(const struct sp_port *port, void *result_ptr);
738 * @defgroup Configuration Configuration
740 * Setting and querying serial port parameters.
745 * Allocate a port configuration structure.
747 * The user should allocate a variable of type "struct sp_port_config *" and
748 * pass a pointer to this to receive the result. The variable will be updated
749 * to point to the new configuration structure. The structure is opaque and
750 * must be accessed via the functions provided.
752 * All parameters in the structure will be initialised to special values which
753 * are ignored by sp_set_config().
755 * The structure should be freed after use by calling sp_free_config().
757 * @param[out] config_ptr If any error is returned, the variable pointed to by
758 * config_ptr will be set to NULL. Otherwise, it will
759 * be set to point to the allocated config structure.
762 * @return SP_OK upon success, a negative error code otherwise.
766 enum sp_return sp_new_config(struct sp_port_config **config_ptr);
769 * Free a port configuration structure.
771 * @param[in] config Pointer to a configuration structure. Must not be NULL.
775 void sp_free_config(struct sp_port_config *config);
778 * Get the current configuration of the specified serial port.
780 * The user should allocate a configuration structure using sp_new_config()
781 * and pass this as the config parameter. The configuration structure will
782 * be updated with the port configuration.
784 * Any parameters that are configured with settings not recognised or
785 * supported by libserialport, will be set to special values that are
786 * ignored by sp_set_config().
788 * @param[in] port Pointer to a port structure. Must not be NULL.
789 * @param[out] config Pointer to a configuration structure that will hold
790 * the result. Upon errors the contents of the config
791 * struct will not be changed. Must not be NULL.
793 * @return SP_OK upon success, a negative error code otherwise.
797 enum sp_return sp_get_config(struct sp_port *port, struct sp_port_config *config);
800 * Set the configuration for the specified serial port.
802 * For each parameter in the configuration, there is a special value (usually
803 * -1, but see the documentation for each field). These values will be ignored
804 * and the corresponding setting left unchanged on the port.
806 * Upon errors, the configuration of the serial port is unknown since
807 * partial/incomplete config updates may have happened.
809 * @param[in] port Pointer to a port structure. Must not be NULL.
810 * @param[in] config Pointer to a configuration structure. Must not be NULL.
812 * @return SP_OK upon success, a negative error code otherwise.
816 enum sp_return sp_set_config(struct sp_port *port, const struct sp_port_config *config);
819 * Set the baud rate for the specified serial port.
821 * @param[in] port Pointer to a port structure. Must not be NULL.
822 * @param[in] baudrate Baud rate in bits per second.
824 * @return SP_OK upon success, a negative error code otherwise.
828 enum sp_return sp_set_baudrate(struct sp_port *port, int baudrate);
831 * Get the baud rate from a port configuration.
833 * The user should allocate a variable of type int and
834 * pass a pointer to this to receive the result.
836 * @param[in] config Pointer to a configuration structure. Must not be NULL.
837 * @param[out] baudrate_ptr Pointer to a variable to store the result. Must not be NULL.
839 * @return SP_OK upon success, a negative error code otherwise.
843 enum sp_return sp_get_config_baudrate(const struct sp_port_config *config, int *baudrate_ptr);
846 * Set the baud rate in a port configuration.
848 * @param[in] config Pointer to a configuration structure. Must not be NULL.
849 * @param[in] baudrate Baud rate in bits per second, or -1 to retain the current setting.
851 * @return SP_OK upon success, a negative error code otherwise.
855 enum sp_return sp_set_config_baudrate(struct sp_port_config *config, int baudrate);
858 * Set the data bits for the specified serial port.
860 * @param[in] port Pointer to a port structure. Must not be NULL.
861 * @param[in] bits Number of data bits.
863 * @return SP_OK upon success, a negative error code otherwise.
867 enum sp_return sp_set_bits(struct sp_port *port, int bits);
870 * Get the data bits from a port configuration.
872 * The user should allocate a variable of type int and
873 * pass a pointer to this to receive the result.
875 * @param[in] config Pointer to a configuration structure. Must not be NULL.
876 * @param[out] bits_ptr Pointer to a variable to store the result. Must not be NULL.
878 * @return SP_OK upon success, a negative error code otherwise.
882 enum sp_return sp_get_config_bits(const struct sp_port_config *config, int *bits_ptr);
885 * Set the data bits in a port configuration.
887 * @param[in] config Pointer to a configuration structure. Must not be NULL.
888 * @param[in] bits Number of data bits, or -1 to retain the current setting.
890 * @return SP_OK upon success, a negative error code otherwise.
894 enum sp_return sp_set_config_bits(struct sp_port_config *config, int bits);
897 * Set the parity setting for the specified serial port.
899 * @param[in] port Pointer to a port structure. Must not be NULL.
900 * @param[in] parity Parity setting.
902 * @return SP_OK upon success, a negative error code otherwise.
906 enum sp_return sp_set_parity(struct sp_port *port, enum sp_parity parity);
909 * Get the parity setting from a port configuration.
911 * The user should allocate a variable of type enum sp_parity and
912 * pass a pointer to this to receive the result.
914 * @param[in] config Pointer to a configuration structure. Must not be NULL.
915 * @param[out] parity_ptr Pointer to a variable to store the result. Must not be NULL.
917 * @return SP_OK upon success, a negative error code otherwise.
921 enum sp_return sp_get_config_parity(const struct sp_port_config *config, enum sp_parity *parity_ptr);
924 * Set the parity setting in a port configuration.
926 * @param[in] config Pointer to a configuration structure. Must not be NULL.
927 * @param[in] parity Parity setting, or -1 to retain the current setting.
929 * @return SP_OK upon success, a negative error code otherwise.
933 enum sp_return sp_set_config_parity(struct sp_port_config *config, enum sp_parity parity);
936 * Set the stop bits for the specified serial port.
938 * @param[in] port Pointer to a port structure. Must not be NULL.
939 * @param[in] stopbits Number of stop bits.
941 * @return SP_OK upon success, a negative error code otherwise.
945 enum sp_return sp_set_stopbits(struct sp_port *port, int stopbits);
948 * Get the stop bits from a port configuration.
950 * The user should allocate a variable of type int and
951 * pass a pointer to this to receive the result.
953 * @param[in] config Pointer to a configuration structure. Must not be NULL.
954 * @param[out] stopbits_ptr Pointer to a variable to store the result. Must not be NULL.
956 * @return SP_OK upon success, a negative error code otherwise.
960 enum sp_return sp_get_config_stopbits(const struct sp_port_config *config, int *stopbits_ptr);
963 * Set the stop bits in a port configuration.
965 * @param[in] config Pointer to a configuration structure. Must not be NULL.
966 * @param[in] stopbits Number of stop bits, or -1 to retain the current setting.
968 * @return SP_OK upon success, a negative error code otherwise.
972 enum sp_return sp_set_config_stopbits(struct sp_port_config *config, int stopbits);
975 * Set the RTS pin behaviour for the specified serial port.
977 * @param[in] port Pointer to a port structure. Must not be NULL.
978 * @param[in] rts RTS pin mode.
980 * @return SP_OK upon success, a negative error code otherwise.
984 enum sp_return sp_set_rts(struct sp_port *port, enum sp_rts rts);
987 * Get the RTS pin behaviour from a port configuration.
989 * The user should allocate a variable of type enum sp_rts and
990 * pass a pointer to this to receive the result.
992 * @param[in] config Pointer to a configuration structure. Must not be NULL.
993 * @param[out] rts_ptr Pointer to a variable to store the result. Must not be NULL.
995 * @return SP_OK upon success, a negative error code otherwise.
999 enum sp_return sp_get_config_rts(const struct sp_port_config *config, enum sp_rts *rts_ptr);
1002 * Set the RTS pin behaviour in a port configuration.
1004 * @param[in] config Pointer to a configuration structure. Must not be NULL.
1005 * @param[in] rts RTS pin mode, or -1 to retain the current setting.
1007 * @return SP_OK upon success, a negative error code otherwise.
1011 enum sp_return sp_set_config_rts(struct sp_port_config *config, enum sp_rts rts);
1014 * Set the CTS pin behaviour for the specified serial port.
1016 * @param[in] port Pointer to a port structure. Must not be NULL.
1017 * @param[in] cts CTS pin mode.
1019 * @return SP_OK upon success, a negative error code otherwise.
1023 enum sp_return sp_set_cts(struct sp_port *port, enum sp_cts cts);
1026 * Get the CTS pin behaviour from a port configuration.
1028 * The user should allocate a variable of type enum sp_cts and
1029 * pass a pointer to this to receive the result.
1031 * @param[in] config Pointer to a configuration structure. Must not be NULL.
1032 * @param[out] cts_ptr Pointer to a variable to store the result. Must not be NULL.
1034 * @return SP_OK upon success, a negative error code otherwise.
1038 enum sp_return sp_get_config_cts(const struct sp_port_config *config, enum sp_cts *cts_ptr);
1041 * Set the CTS pin behaviour in a port configuration.
1043 * @param[in] config Pointer to a configuration structure. Must not be NULL.
1044 * @param[in] cts CTS pin mode, or -1 to retain the current setting.
1046 * @return SP_OK upon success, a negative error code otherwise.
1050 enum sp_return sp_set_config_cts(struct sp_port_config *config, enum sp_cts cts);
1053 * Set the DTR pin behaviour for the specified serial port.
1055 * @param[in] port Pointer to a port structure. Must not be NULL.
1056 * @param[in] dtr DTR pin mode.
1058 * @return SP_OK upon success, a negative error code otherwise.
1062 enum sp_return sp_set_dtr(struct sp_port *port, enum sp_dtr dtr);
1065 * Get the DTR pin behaviour from a port configuration.
1067 * The user should allocate a variable of type enum sp_dtr and
1068 * pass a pointer to this to receive the result.
1070 * @param[in] config Pointer to a configuration structure. Must not be NULL.
1071 * @param[out] dtr_ptr Pointer to a variable to store the result. Must not be NULL.
1073 * @return SP_OK upon success, a negative error code otherwise.
1077 enum sp_return sp_get_config_dtr(const struct sp_port_config *config, enum sp_dtr *dtr_ptr);
1080 * Set the DTR pin behaviour in a port configuration.
1082 * @param[in] config Pointer to a configuration structure. Must not be NULL.
1083 * @param[in] dtr DTR pin mode, or -1 to retain the current setting.
1085 * @return SP_OK upon success, a negative error code otherwise.
1089 enum sp_return sp_set_config_dtr(struct sp_port_config *config, enum sp_dtr dtr);
1092 * Set the DSR pin behaviour for the specified serial port.
1094 * @param[in] port Pointer to a port structure. Must not be NULL.
1095 * @param[in] dsr DSR pin mode.
1097 * @return SP_OK upon success, a negative error code otherwise.
1101 enum sp_return sp_set_dsr(struct sp_port *port, enum sp_dsr dsr);
1104 * Get the DSR pin behaviour from a port configuration.
1106 * The user should allocate a variable of type enum sp_dsr and
1107 * pass a pointer to this to receive the result.
1109 * @param[in] config Pointer to a configuration structure. Must not be NULL.
1110 * @param[out] dsr_ptr Pointer to a variable to store the result. Must not be NULL.
1112 * @return SP_OK upon success, a negative error code otherwise.
1116 enum sp_return sp_get_config_dsr(const struct sp_port_config *config, enum sp_dsr *dsr_ptr);
1119 * Set the DSR pin behaviour in a port configuration.
1121 * @param[in] config Pointer to a configuration structure. Must not be NULL.
1122 * @param[in] dsr DSR pin mode, or -1 to retain the current setting.
1124 * @return SP_OK upon success, a negative error code otherwise.
1128 enum sp_return sp_set_config_dsr(struct sp_port_config *config, enum sp_dsr dsr);
1131 * Set the XON/XOFF configuration for the specified serial port.
1133 * @param[in] port Pointer to a port structure. Must not be NULL.
1134 * @param[in] xon_xoff XON/XOFF mode.
1136 * @return SP_OK upon success, a negative error code otherwise.
1140 enum sp_return sp_set_xon_xoff(struct sp_port *port, enum sp_xonxoff xon_xoff);
1143 * Get the XON/XOFF configuration from a port configuration.
1145 * The user should allocate a variable of type enum sp_xonxoff and
1146 * pass a pointer to this to receive the result.
1148 * @param[in] config Pointer to a configuration structure. Must not be NULL.
1149 * @param[out] xon_xoff_ptr Pointer to a variable to store the result. Must not be NULL.
1151 * @return SP_OK upon success, a negative error code otherwise.
1155 enum sp_return sp_get_config_xon_xoff(const struct sp_port_config *config, enum sp_xonxoff *xon_xoff_ptr);
1158 * Set the XON/XOFF configuration in a port configuration.
1160 * @param[in] config Pointer to a configuration structure. Must not be NULL.
1161 * @param[in] xon_xoff XON/XOFF mode, or -1 to retain the current setting.
1163 * @return SP_OK upon success, a negative error code otherwise.
1167 enum sp_return sp_set_config_xon_xoff(struct sp_port_config *config, enum sp_xonxoff xon_xoff);
1170 * Set the flow control type in a port configuration.
1172 * This function is a wrapper that sets the RTS, CTS, DTR, DSR and
1173 * XON/XOFF settings as necessary for the specified flow control
1174 * type. For more fine-grained control of these settings, use their
1175 * individual configuration functions.
1177 * @param[in] config Pointer to a configuration structure. Must not be NULL.
1178 * @param[in] flowcontrol Flow control setting to use.
1180 * @return SP_OK upon success, a negative error code otherwise.
1184 enum sp_return sp_set_config_flowcontrol(struct sp_port_config *config, enum sp_flowcontrol flowcontrol);
1187 * Set the flow control type for the specified serial port.
1189 * This function is a wrapper that sets the RTS, CTS, DTR, DSR and
1190 * XON/XOFF settings as necessary for the specified flow control
1191 * type. For more fine-grained control of these settings, use their
1192 * individual configuration functions.
1194 * @param[in] port Pointer to a port structure. Must not be NULL.
1195 * @param[in] flowcontrol Flow control setting to use.
1197 * @return SP_OK upon success, a negative error code otherwise.
1201 enum sp_return sp_set_flowcontrol(struct sp_port *port, enum sp_flowcontrol flowcontrol);
1206 * @defgroup Data Data handling
1208 * Reading, writing, and flushing data.
1214 * Read bytes from the specified serial port, blocking until complete.
1216 * @warning If your program runs on Unix, defines its own signal handlers, and
1217 * needs to abort blocking reads when these are called, then you
1218 * should not use this function. It repeats system calls that return
1219 * with EINTR. To be able to abort a read from a signal handler, you
1220 * should implement your own blocking read using sp_nonblocking_read()
1221 * together with a blocking method that makes sense for your program.
1222 * E.g. you can obtain the file descriptor for an open port using
1223 * sp_get_port_handle() and use this to call select() or pselect(),
1224 * with appropriate arrangements to return if a signal is received.
1226 * @param[in] port Pointer to a port structure. Must not be NULL.
1227 * @param[out] buf Buffer in which to store the bytes read. Must not be NULL.
1228 * @param[in] count Requested number of bytes to read.
1229 * @param[in] timeout_ms Timeout in milliseconds, or zero to wait indefinitely.
1231 * @return The number of bytes read on success, or a negative error code. If
1232 * the number of bytes returned is less than that requested, the
1233 * timeout was reached before the requested number of bytes was
1234 * available. If timeout is zero, the function will always return
1235 * either the requested number of bytes or a negative error code.
1239 enum sp_return sp_blocking_read(struct sp_port *port, void *buf, size_t count, unsigned int timeout_ms);
1242 * Read bytes from the specified serial port, returning as soon as any data is
1245 * @warning If your program runs on Unix, defines its own signal handlers, and
1246 * needs to abort blocking reads when these are called, then you
1247 * should not use this function. It repeats system calls that return
1248 * with EINTR. To be able to abort a read from a signal handler, you
1249 * should implement your own blocking read using sp_nonblocking_read()
1250 * together with a blocking method that makes sense for your program.
1251 * E.g. you can obtain the file descriptor for an open port using
1252 * sp_get_port_handle() and use this to call select() or pselect(),
1253 * with appropriate arrangements to return if a signal is received.
1255 * @param[in] port Pointer to a port structure. Must not be NULL.
1256 * @param[out] buf Buffer in which to store the bytes read. Must not be NULL.
1257 * @param[in] count Maximum number of bytes to read. Must not be zero.
1258 * @param[in] timeout_ms Timeout in milliseconds, or zero to wait indefinitely.
1260 * @return The number of bytes read on success, or a negative error code. If
1261 * the result is zero, the timeout was reached before any bytes were
1262 * available. If timeout_ms is zero, the function will always return
1263 * either at least one byte, or a negative error code.
1267 enum sp_return sp_blocking_read_next(struct sp_port *port, void *buf, size_t count, unsigned int timeout_ms);
1270 * Read bytes from the specified serial port, without blocking.
1272 * @param[in] port Pointer to a port structure. Must not be NULL.
1273 * @param[out] buf Buffer in which to store the bytes read. Must not be NULL.
1274 * @param[in] count Maximum number of bytes to read.
1276 * @return The number of bytes read on success, or a negative error code. The
1277 * number of bytes returned may be any number from zero to the maximum
1278 * that was requested.
1282 enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf, size_t count);
1285 * Write bytes to the specified serial port, blocking until complete.
1287 * Note that this function only ensures that the accepted bytes have been
1288 * written to the OS; they may be held in driver or hardware buffers and not
1289 * yet physically transmitted. To check whether all written bytes have actually
1290 * been transmitted, use the sp_output_waiting() function. To wait until all
1291 * written bytes have actually been transmitted, use the sp_drain() function.
1293 * @warning If your program runs on Unix, defines its own signal handlers, and
1294 * needs to abort blocking writes when these are called, then you
1295 * should not use this function. It repeats system calls that return
1296 * with EINTR. To be able to abort a write from a signal handler, you
1297 * should implement your own blocking write using sp_nonblocking_write()
1298 * together with a blocking method that makes sense for your program.
1299 * E.g. you can obtain the file descriptor for an open port using
1300 * sp_get_port_handle() and use this to call select() or pselect(),
1301 * with appropriate arrangements to return if a signal is received.
1303 * @param[in] port Pointer to a port structure. Must not be NULL.
1304 * @param[in] buf Buffer containing the bytes to write. Must not be NULL.
1305 * @param[in] count Requested number of bytes to write.
1306 * @param[in] timeout_ms Timeout in milliseconds, or zero to wait indefinitely.
1308 * @return The number of bytes written on success, or a negative error code.
1309 * If the number of bytes returned is less than that requested, the
1310 * timeout was reached before the requested number of bytes was
1311 * written. If timeout is zero, the function will always return
1312 * either the requested number of bytes or a negative error code. In
1313 * the event of an error there is no way to determine how many bytes
1314 * were sent before the error occurred.
1318 enum sp_return sp_blocking_write(struct sp_port *port, const void *buf, size_t count, unsigned int timeout_ms);
1321 * Write bytes to the specified serial port, without blocking.
1323 * Note that this function only ensures that the accepted bytes have been
1324 * written to the OS; they may be held in driver or hardware buffers and not
1325 * yet physically transmitted. To check whether all written bytes have actually
1326 * been transmitted, use the sp_output_waiting() function. To wait until all
1327 * written bytes have actually been transmitted, use the sp_drain() function.
1329 * @param[in] port Pointer to a port structure. Must not be NULL.
1330 * @param[in] buf Buffer containing the bytes to write. Must not be NULL.
1331 * @param[in] count Maximum number of bytes to write.
1333 * @return The number of bytes written on success, or a negative error code.
1334 * The number of bytes returned may be any number from zero to the
1335 * maximum that was requested.
1339 enum sp_return sp_nonblocking_write(struct sp_port *port, const void *buf, size_t count);
1342 * Gets the number of bytes waiting in the input buffer.
1344 * @param[in] port Pointer to a port structure. Must not be NULL.
1346 * @return Number of bytes waiting on success, a negative error code otherwise.
1350 enum sp_return sp_input_waiting(struct sp_port *port);
1353 * Gets the number of bytes waiting in the output buffer.
1355 * @param[in] port Pointer to a port structure. Must not be NULL.
1357 * @return Number of bytes waiting on success, a negative error code otherwise.
1361 enum sp_return sp_output_waiting(struct sp_port *port);
1364 * Flush serial port buffers. Data in the selected buffer(s) is discarded.
1366 * @param[in] port Pointer to a port structure. Must not be NULL.
1367 * @param[in] buffers Which buffer(s) to flush.
1369 * @return SP_OK upon success, a negative error code otherwise.
1373 enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers);
1376 * Wait for buffered data to be transmitted.
1378 * @warning If your program runs on Unix, defines its own signal handlers, and
1379 * needs to abort draining the output buffer when when these are
1380 * called, then you should not use this function. It repeats system
1381 * calls that return with EINTR. To be able to abort a drain from a
1382 * signal handler, you would need to implement your own blocking
1383 * drain by polling the result of sp_output_waiting().
1385 * @param[in] port Pointer to a port structure. Must not be NULL.
1387 * @return SP_OK upon success, a negative error code otherwise.
1391 enum sp_return sp_drain(struct sp_port *port);
1396 * @defgroup Waiting Waiting
1398 * Waiting for events and timeout handling.
1404 * Allocate storage for a set of events.
1406 * The user should allocate a variable of type struct sp_event_set *,
1407 * then pass a pointer to this variable to receive the result.
1409 * The result should be freed after use by calling sp_free_event_set().
1411 * @param[out] result_ptr If any error is returned, the variable pointed to by
1412 * result_ptr will be set to NULL. Otherwise, it will
1413 * be set to point to the event set. Must not be NULL.
1415 * @return SP_OK upon success, a negative error code otherwise.
1419 enum sp_return sp_new_event_set(struct sp_event_set **result_ptr);
1422 * Add events to a struct sp_event_set for a given port.
1424 * The port must first be opened by calling sp_open() using the same port
1427 * After the port is closed or the port structure freed, the results may
1428 * no longer be valid.
1430 * @param[in,out] event_set Event set to update. Must not be NULL.
1431 * @param[in] port Pointer to a port structure. Must not be NULL.
1432 * @param[in] mask Bitmask of events to be waited for.
1434 * @return SP_OK upon success, a negative error code otherwise.
1438 enum sp_return sp_add_port_events(struct sp_event_set *event_set,
1439 const struct sp_port *port, enum sp_event mask);
1442 * Wait for any of a set of events to occur.
1444 * @param[in] event_set Event set to wait on. Must not be NULL.
1445 * @param[in] timeout_ms Timeout in milliseconds, or zero to wait indefinitely.
1447 * @return SP_OK upon success, a negative error code otherwise.
1451 enum sp_return sp_wait(struct sp_event_set *event_set, unsigned int timeout_ms);
1454 * Free a structure allocated by sp_new_event_set().
1456 * @param[in] event_set Event set to free. Must not be NULL.
1460 void sp_free_event_set(struct sp_event_set *event_set);
1465 * @defgroup Signals Signals
1467 * Port signalling operations.
1473 * Gets the status of the control signals for the specified port.
1475 * The user should allocate a variable of type "enum sp_signal" and pass a
1476 * pointer to this variable to receive the result. The result is a bitmask
1477 * in which individual signals can be checked by bitwise OR with values of
1478 * the sp_signal enum.
1480 * @param[in] port Pointer to a port structure. Must not be NULL.
1481 * @param[out] signal_mask Pointer to a variable to receive the result.
1484 * @return SP_OK upon success, a negative error code otherwise.
1488 enum sp_return sp_get_signals(struct sp_port *port, enum sp_signal *signal_mask);
1491 * Put the port transmit line into the break state.
1493 * @param[in] port Pointer to a port structure. Must not be NULL.
1495 * @return SP_OK upon success, a negative error code otherwise.
1499 enum sp_return sp_start_break(struct sp_port *port);
1502 * Take the port transmit line out of the break state.
1504 * @param[in] port Pointer to a port structure. Must not be NULL.
1506 * @return SP_OK upon success, a negative error code otherwise.
1510 enum sp_return sp_end_break(struct sp_port *port);
1515 * @defgroup Errors Errors
1517 * Obtaining error information.
1523 * Get the error code for a failed operation.
1525 * In order to obtain the correct result, this function should be called
1526 * straight after the failure, before executing any other system operations.
1527 * The result is thread-specific, and only valid when called immediately
1528 * after a previous call returning SP_ERR_FAIL.
1530 * @return The system's numeric code for the error that caused the last
1531 * operation to fail.
1535 int sp_last_error_code(void);
1538 * Get the error message for a failed operation.
1540 * In order to obtain the correct result, this function should be called
1541 * straight after the failure, before executing other system operations.
1542 * The result is thread-specific, and only valid when called immediately
1543 * after a previous call returning SP_ERR_FAIL.
1545 * @return The system's message for the error that caused the last
1546 * operation to fail. This string may be allocated by the function,
1547 * and should be freed after use by calling sp_free_error_message().
1551 char *sp_last_error_message(void);
1554 * Free an error message returned by sp_last_error_message().
1556 * @param[in] message The error message string to free. Must not be NULL.
1560 void sp_free_error_message(char *message);
1563 * Set the handler function for library debugging messages.
1565 * Debugging messages are generated by the library during each operation,
1566 * to help in diagnosing problems. The handler will be called for each
1567 * message. The handler can be set to NULL to ignore all debug messages.
1569 * The handler function should accept a format string and variable length
1570 * argument list, in the same manner as e.g. printf().
1572 * The default handler is sp_default_debug_handler().
1574 * @param[in] handler The handler function to use. Can be NULL (in that case
1575 * all debug messages will be ignored).
1579 void sp_set_debug_handler(void (*handler)(const char *format, ...));
1582 * Default handler function for library debugging messages.
1584 * This function prints debug messages to the standard error stream if the
1585 * environment variable LIBSERIALPORT_DEBUG is set. Otherwise, they are
1588 * @param[in] format The format string to use. Must not be NULL.
1589 * @param[in] ... The variable length argument list to use.
1593 void sp_default_debug_handler(const char *format, ...);
1598 * @defgroup Versions Versions
1600 * Version number querying functions, definitions, and macros.
1602 * This set of API calls returns two different version numbers related
1603 * to libserialport. The "package version" is the release version number of the
1604 * libserialport tarball in the usual "major.minor.micro" format, e.g. "0.1.0".
1606 * The "library version" is independent of that; it is the libtool version
1607 * number in the "current:revision:age" format, e.g. "2:0:0".
1608 * See http://www.gnu.org/software/libtool/manual/libtool.html#Libtool-versioning for details.
1610 * Both version numbers (and/or individual components of them) can be
1611 * retrieved via the API calls at runtime, and/or they can be checked at
1612 * compile/preprocessor time using the respective macros.
1618 * Package version macros (can be used for conditional compilation).
1621 /** The libserialport package 'major' version number. */
1622 #undef SP_PACKAGE_VERSION_MAJOR
1624 /** The libserialport package 'minor' version number. */
1625 #undef SP_PACKAGE_VERSION_MINOR
1627 /** The libserialport package 'micro' version number. */
1628 #undef SP_PACKAGE_VERSION_MICRO
1630 /** The libserialport package version ("major.minor.micro") as string. */
1631 #undef SP_PACKAGE_VERSION_STRING
1634 * Library/libtool version macros (can be used for conditional compilation).
1637 /** The libserialport libtool 'current' version number. */
1638 #undef SP_LIB_VERSION_CURRENT
1640 /** The libserialport libtool 'revision' version number. */
1641 #undef SP_LIB_VERSION_REVISION
1643 /** The libserialport libtool 'age' version number. */
1644 #undef SP_LIB_VERSION_AGE
1646 /** The libserialport libtool version ("current:revision:age") as string. */
1647 #undef SP_LIB_VERSION_STRING
1650 * Get the major libserialport package version number.
1652 * @return The major package version number.
1656 int sp_get_major_package_version(void);
1659 * Get the minor libserialport package version number.
1661 * @return The minor package version number.
1665 int sp_get_minor_package_version(void);
1668 * Get the micro libserialport package version number.
1670 * @return The micro package version number.
1674 int sp_get_micro_package_version(void);
1677 * Get the libserialport package version number as a string.
1679 * @return The package version number string. The returned string is
1680 * static and thus should NOT be free'd by the caller.
1684 const char *sp_get_package_version_string(void);
1687 * Get the "current" part of the libserialport library version number.
1689 * @return The "current" library version number.
1693 int sp_get_current_lib_version(void);
1696 * Get the "revision" part of the libserialport library version number.
1698 * @return The "revision" library version number.
1702 int sp_get_revision_lib_version(void);
1705 * Get the "age" part of the libserialport library version number.
1707 * @return The "age" library version number.
1711 int sp_get_age_lib_version(void);
1714 * Get the libserialport library version number as a string.
1716 * @return The library version number string. The returned string is
1717 * static and thus should NOT be free'd by the caller.
1721 const char *sp_get_lib_version_string(void);
1726 * @example list_ports.c Getting a list of ports present on the system.
1727 * @example port_info.c Getting information on a particular serial port.