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.
82 * #include <libserialport.h>
88 * All identifiers defined by the public libserialport headers use the prefix
89 * @c sp_ (for functions and data types) or @c SP_ (for macros and constants).
94 * The functions provided by the library are documented in detail in
95 * the following sections:
97 * - @ref Enumeration (obtaining a list of serial ports on the system)
98 * - @ref Ports (opening, closing and getting information about ports)
99 * - @ref Configuration (baud rate, parity, etc.)
100 * - @ref Signals (modem control lines, breaks, etc.)
101 * - @ref Data (reading and writing data, and buffer management)
102 * - @ref Waiting (waiting for ports to be ready, integrating with event loops)
103 * - @ref Errors (getting error and debugging information)
108 * The library defines three data structures:
110 * - @ref sp_port, which represents a serial port.
111 * See @ref Enumeration.
112 * - @ref sp_port_config, which represents a port configuration.
113 * See @ref Configuration.
114 * - @ref sp_event_set, which represents a set of events.
117 * All these structures are allocated and freed by library functions. It is
118 * the caller's responsibility to ensure that the correct calls are made to
119 * free allocated structures after use.
121 * Return codes and error handling
122 * -------------------------------
124 * Most functions have return type @ref sp_return and can return only four
125 * possible error values:
127 * - @ref SP_ERR_ARG means that a function was called with invalid
128 * arguments. This implies a bug in the caller. The arguments passed would
129 * be invalid regardless of the underlying OS or serial device involved.
131 * - @ref SP_ERR_FAIL means that the OS reported a failure. The error code or
132 * message provided by the OS can be obtained by calling sp_last_error_code()
133 * or sp_last_error_message().
135 * - @ref SP_ERR_SUPP indicates that there is no support for the requested
136 * operation in the current OS, driver or device. No error message is
137 * available from the OS in this case. There is either no way to request
138 * the operation in the first place, or libserialport does not know how to
139 * do so in the current version.
141 * - @ref SP_ERR_MEM indicates that a memory allocation failed.
143 * All of these error values are negative.
145 * Calls that succeed return @ref SP_OK, which is equal to zero. Some functions
146 * declared @ref sp_return can also return a positive value for a successful
147 * numeric result, e.g. sp_blocking_read() or sp_blocking_write().
149 * An error message is only available via sp_last_error_message() in the case
150 * where @ref SP_ERR_FAIL was returned by the previous function call. The error
151 * message returned is that provided by the OS, using the current language
152 * settings. It is an error to call sp_last_error_code() or
153 * sp_last_error_message() except after a previous function call returned
154 * @ref SP_ERR_FAIL. The library does not define its own error codes or
155 * messages to accompany other return codes.
160 * Certain combinations of calls can be made concurrently, as follows.
162 * - Calls using different ports may always be made concurrently, i.e.
163 * it is safe for separate threads to handle their own ports.
165 * - Calls using the same port may be made concurrently when one call
166 * is a read operation and one call is a write operation, i.e. it is safe
167 * to use separate "reader" and "writer" threads for the same port. See
168 * below for which operations meet these definitions.
172 * - sp_blocking_read()
173 * - sp_blocking_read_next()
174 * - sp_nonblocking_read()
175 * - sp_input_waiting()
176 * - sp_flush() with @ref SP_BUF_INPUT only.
177 * - sp_wait() with @ref SP_EVENT_RX_READY only.
181 * - sp_blocking_write()
182 * - sp_nonblocking_write()
183 * - sp_output_waiting()
185 * - sp_flush() with @ref SP_BUF_OUTPUT only.
186 * - sp_wait() with @ref SP_EVENT_TX_READY only.
188 * If two calls, on the same port, do not fit into one of these categories
189 * each, then they may not be made concurrently.
194 * The library can output extensive tracing and debugging information. The
195 * simplest way to use this is to set the environment variable
196 * @c LIBSERIALPORT_DEBUG to any value; messages will then be output to the
197 * standard error stream.
199 * This behaviour is implemented by a default debug message handling
200 * callback. An alternative callback can be set using sp_set_debug_handler(),
201 * in order to e.g. redirect the output elsewhere or filter it.
203 * No guarantees are made about the content of the debug output; it is chosen
204 * to suit the needs of the developers and may change between releases.
210 * The following guidelines may help when porting existing OS-specific code
211 * to use libserialport.
213 * ### Porting from Unix-like systems ###
215 * There are two main differences to note when porting code written for Unix.
217 * The first is that Unix traditionally provides a wide range of functionality
218 * for dealing with serial devices at the OS level; this is exposed through the
219 * termios API and dates to the days when serial terminals were common. If your
220 * code relies on many of these facilities you will need to adapt it, because
221 * libserialport provides only a raw binary channel with no special handling.
223 * The second relates to blocking versus non-blocking I/O behaviour. In
224 * Unix-like systems this is normally specified by setting the @c O_NONBLOCK
225 * flag on the file descriptor, affecting the semantics of subsequent @c read()
226 * and @c write() calls.
228 * In libserialport, blocking and nonblocking operations are both available at
229 * any time. If your existing code Ń•ets @c O_NONBLOCK, you should use
230 * sp_nonblocking_read() and sp_nonblocking_write() to get the same behaviour
231 * as your existing @c read() and @c write() calls. If it does not, you should
232 * use sp_blocking_read() and sp_blocking_write() instead. You may also find
233 * sp_blocking_read_next() useful, which reproduces the semantics of a blocking
234 * read() with @c VTIME=0 and @c VMIN=1 set in termios.
236 * Finally, you should take care if your program uses custom signal handlers.
237 * The blocking calls provided by libserialport will restart system calls that
238 * return with @c EINTR, so you will need to make your own arrangements if you
239 * need to interrupt blocking operations when your signal handlers are called.
240 * This is not an issue if you only use the default handlers.
242 * ### Porting from Windows ###
244 * The main consideration when porting from Windows is that there is no
245 * direct equivalent for overlapped I/O operations.
247 * If your program does not use overlapped I/O, you can simply use
248 * sp_blocking_read() and sp_blocking_write() as direct equivalents for
249 * @c ReadFile() and @c WriteFile(). You may also find sp_blocking_read_next()
250 * useful, which reproduces the special semantics of @c ReadFile() with
251 * @c ReadIntervalTimeout and @c ReadTotalTimeoutMultiplier set to @c MAXDWORD
252 * and @c ReadTotalTimeoutConstant set to between @c 1 and @c MAXDWORD-1 .
254 * If your program makes use of overlapped I/O to continue work while a serial
255 * operation is in progress, then you can achieve the same results using
256 * sp_nonblocking_read() and sp_nonblocking_write().
258 * Generally, overlapped I/O is combined with either waiting for completion
259 * once there is no more background work to do (using @c WaitForSingleObject()
260 * or @c WaitForMultipleObjects()), or periodically checking for completion
261 * with @c GetOverlappedResult(). If the aim is to start a new operation for
262 * further data once the previous one has completed, you can instead simply
263 * call the nonblocking functions again with the next data. If you need to
264 * wait for completion, use sp_wait() to determine when the port is ready to
265 * send or receive further data.
268 #ifndef LIBSERIALPORT_LIBSERIALPORT_H
269 #define LIBSERIALPORT_LIBSERIALPORT_H
279 /* Microsoft Visual C/C++ compiler in use */
280 #ifdef LIBSERIALPORT_MSBUILD
281 /* Building the library - need to export DLL symbols */
282 #define SP_API __declspec(dllexport)
284 /* Using the library - need to import DLL symbols */
285 #define SP_API __declspec(dllimport)
288 /* Some other compiler in use */
289 #ifndef LIBSERIALPORT_ATBUILD
290 /* Not building the library itself - don't need any special prefixes. */
296 /** Return values. */
298 /** Operation completed successfully. */
300 /** Invalid arguments were passed to the function. */
302 /** A system error occurred while executing the operation. */
304 /** A memory allocation failed while executing the operation. */
306 /** The requested operation is not supported by this system or device. */
310 /** Port access modes. */
312 /** Open port for read access. */
314 /** Open port for write access. */
316 /** Open port for read and write access. @since 0.1.1 */
317 SP_MODE_READ_WRITE = 3
322 /** Data received and ready to read. */
323 SP_EVENT_RX_READY = 1,
324 /** Ready to transmit new data. */
325 SP_EVENT_TX_READY = 2,
326 /** Error occurred. */
330 /** Buffer selection. */
334 /** Output buffer. */
340 /** Parity settings. */
342 /** Special value to indicate setting should be left alone. */
343 SP_PARITY_INVALID = -1,
356 /** RTS pin behaviour. */
358 /** Special value to indicate setting should be left alone. */
364 /** RTS used for flow control. */
365 SP_RTS_FLOW_CONTROL = 2
368 /** CTS pin behaviour. */
370 /** Special value to indicate setting should be left alone. */
374 /** CTS used for flow control. */
375 SP_CTS_FLOW_CONTROL = 1
378 /** DTR pin behaviour. */
380 /** Special value to indicate setting should be left alone. */
386 /** DTR used for flow control. */
387 SP_DTR_FLOW_CONTROL = 2
390 /** DSR pin behaviour. */
392 /** Special value to indicate setting should be left alone. */
396 /** DSR used for flow control. */
397 SP_DSR_FLOW_CONTROL = 1
400 /** XON/XOFF flow control behaviour. */
402 /** Special value to indicate setting should be left alone. */
403 SP_XONXOFF_INVALID = -1,
404 /** XON/XOFF disabled. */
405 SP_XONXOFF_DISABLED = 0,
406 /** XON/XOFF enabled for input only. */
408 /** XON/XOFF enabled for output only. */
410 /** XON/XOFF enabled for input and output. */
414 /** Standard flow control combinations. */
415 enum sp_flowcontrol {
416 /** No flow control. */
417 SP_FLOWCONTROL_NONE = 0,
418 /** Software flow control using XON/XOFF characters. */
419 SP_FLOWCONTROL_XONXOFF = 1,
420 /** Hardware flow control using RTS/CTS signals. */
421 SP_FLOWCONTROL_RTSCTS = 2,
422 /** Hardware flow control using DTR/DSR signals. */
423 SP_FLOWCONTROL_DTRDSR = 3
426 /** Input signals. */
428 /** Clear to send. */
430 /** Data set ready. */
432 /** Data carrier detect. */
434 /** Ring indicator. */
444 /** Native platform serial port. @since 0.1.1 */
446 /** USB serial port adapter. @since 0.1.1 */
448 /** Bluetooth serial port adapter. @since 0.1.1 */
449 SP_TRANSPORT_BLUETOOTH
454 * An opaque structure representing a serial port.
459 * @struct sp_port_config
460 * An opaque structure representing the configuration for a serial port.
462 struct sp_port_config;
465 * @struct sp_event_set
466 * A set of handles to wait on for events.
468 struct sp_event_set {
469 /** Array of OS-specific handles. */
471 /** Array of bitmasks indicating which events apply for each handle. */
472 enum sp_event *masks;
473 /** Number of handles. */
478 * @defgroup Enumeration Port enumeration
480 * Enumerating the serial ports of a system.
482 * See @ref list_ports.c for a working example of port enumeration.
488 * Obtain a pointer to a new sp_port structure representing the named port.
490 * The user should allocate a variable of type "struct sp_port *" and pass a
491 * pointer to this to receive the result.
493 * The result should be freed after use by calling sp_free_port().
495 * @param[in] portname The OS-specific name of a serial port. Must not be NULL.
496 * @param[out] port_ptr If any error is returned, the variable pointed to by
497 * port_ptr will be set to NULL. Otherwise, it will be set
498 * to point to the newly allocated port. Must not be NULL.
500 * @return SP_OK upon success, a negative error code otherwise.
504 SP_API enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_ptr);
507 * Free a port structure obtained from sp_get_port_by_name() or sp_copy_port().
509 * @param[in] port Pointer to a port structure. Must not be NULL.
513 SP_API void sp_free_port(struct sp_port *port);
516 * List the serial ports available on the system.
518 * The result obtained is an array of pointers to sp_port structures,
519 * terminated by a NULL. The user should allocate a variable of type
520 * "struct sp_port **" and pass a pointer to this to receive the result.
522 * The result should be freed after use by calling sp_free_port_list().
523 * If a port from the list is to be used after freeing the list, it must be
524 * copied first using sp_copy_port().
526 * @param[out] list_ptr If any error is returned, the variable pointed to by
527 * list_ptr will be set to NULL. Otherwise, it will be set
528 * to point to the newly allocated array. Must not be NULL.
530 * @return SP_OK upon success, a negative error code otherwise.
534 SP_API enum sp_return sp_list_ports(struct sp_port ***list_ptr);
537 * Make a new copy of an sp_port structure.
539 * The user should allocate a variable of type "struct sp_port *" and pass a
540 * pointer to this to receive the result.
542 * The copy should be freed after use by calling sp_free_port().
544 * @param[in] port Pointer to a port structure. Must not be NULL.
545 * @param[out] copy_ptr If any error is returned, the variable pointed to by
546 * copy_ptr will be set to NULL. Otherwise, it will be set
547 * to point to the newly allocated copy. Must not be NULL.
549 * @return SP_OK upon success, a negative error code otherwise.
553 SP_API enum sp_return sp_copy_port(const struct sp_port *port, struct sp_port **copy_ptr);
556 * Free a port list obtained from sp_list_ports().
558 * This will also free all the sp_port structures referred to from the list;
559 * any that are to be retained must be copied first using sp_copy_port().
561 * @param[in] ports Pointer to a list of port structures. Must not be NULL.
565 SP_API void sp_free_port_list(struct sp_port **ports);
569 * @defgroup Ports Port handling
571 * Opening, closing and querying ports.
573 * See @ref port_info.c for a working example of getting port information.
579 * Open the specified serial port.
581 * @param[in] port Pointer to a port structure. Must not be NULL.
582 * @param[in] flags Flags to use when opening the serial port.
584 * @return SP_OK upon success, a negative error code otherwise.
588 SP_API enum sp_return sp_open(struct sp_port *port, enum sp_mode flags);
591 * Close the specified serial port.
593 * @param[in] port Pointer to a port structure. Must not be NULL.
595 * @return SP_OK upon success, a negative error code otherwise.
599 SP_API enum sp_return sp_close(struct sp_port *port);
602 * Get the name of a port.
604 * The name returned is whatever is normally used to refer to a port on the
605 * current operating system; e.g. for Windows it will usually be a "COMn"
606 * device name, and for Unix it will be a device path beginning with "/dev/".
608 * @param[in] port Pointer to a port structure. Must not be NULL.
610 * @return The port name, or NULL if an invalid port is passed. The name
611 * string is part of the port structure and may not be used after
612 * the port structure has been freed.
616 SP_API char *sp_get_port_name(const struct sp_port *port);
619 * Get a description for a port, to present to end user.
621 * @param[in] port Pointer to a port structure. Must not be NULL.
623 * @return The port description, or NULL if an invalid port is passed.
624 * The description string is part of the port structure and may not
625 * be used after the port structure has been freed.
629 SP_API char *sp_get_port_description(const struct sp_port *port);
632 * Get the transport type used by a port.
634 * @param[in] port Pointer to a port structure. Must not be NULL.
636 * @return The port transport type.
640 SP_API enum sp_transport sp_get_port_transport(const struct sp_port *port);
643 * Get the USB bus number and address on bus of a USB serial adapter port.
645 * @param[in] port Pointer to a port structure. Must not be NULL.
646 * @param[out] usb_bus Pointer to a variable to store the USB bus.
647 * Can be NULL (in that case it will be ignored).
648 * @param[out] usb_address Pointer to a variable to store the USB address.
649 * Can be NULL (in that case it will be ignored).
651 * @return SP_OK upon success, a negative error code otherwise.
655 SP_API enum sp_return sp_get_port_usb_bus_address(const struct sp_port *port,
656 int *usb_bus, int *usb_address);
659 * Get the USB Vendor ID and Product ID of a USB serial adapter port.
661 * @param[in] port Pointer to a port structure. Must not be NULL.
662 * @param[out] usb_vid Pointer to a variable to store the USB VID.
663 * Can be NULL (in that case it will be ignored).
664 * @param[out] usb_pid Pointer to a variable to store the USB PID.
665 * Can be NULL (in that case it will be ignored).
667 * @return SP_OK upon success, a negative error code otherwise.
671 SP_API enum sp_return sp_get_port_usb_vid_pid(const struct sp_port *port, int *usb_vid, int *usb_pid);
674 * Get the USB manufacturer string of a USB serial adapter port.
676 * @param[in] port Pointer to a port structure. Must not be NULL.
678 * @return The port manufacturer string, or NULL if an invalid port is passed.
679 * The manufacturer string is part of the port structure and may not
680 * be used after the port structure has been freed.
684 SP_API char *sp_get_port_usb_manufacturer(const struct sp_port *port);
687 * Get the USB product string of a USB serial adapter port.
689 * @param[in] port Pointer to a port structure. Must not be NULL.
691 * @return The port product string, or NULL if an invalid port is passed.
692 * The product string is part of the port structure and may not be
693 * used after the port structure has been freed.
697 SP_API char *sp_get_port_usb_product(const struct sp_port *port);
700 * Get the USB serial number string of a USB serial adapter port.
702 * @param[in] port Pointer to a port structure. Must not be NULL.
704 * @return The port serial number, or NULL if an invalid port is passed.
705 * The serial number string is part of the port structure and may
706 * not be used after the port structure has been freed.
710 SP_API char *sp_get_port_usb_serial(const struct sp_port *port);
713 * Get the MAC address of a Bluetooth serial adapter port.
715 * @param[in] port Pointer to a port structure. Must not be NULL.
717 * @return The port MAC address, or NULL if an invalid port is passed.
718 * The MAC address string is part of the port structure and may not
719 * be used after the port structure has been freed.
723 SP_API char *sp_get_port_bluetooth_address(const struct sp_port *port);
726 * Get the operating system handle for a port.
728 * The type of the handle depends on the operating system. On Unix based
729 * systems, the handle is a file descriptor of type "int". On Windows, the
730 * handle is of type "HANDLE". The user should allocate a variable of the
731 * appropriate type and pass a pointer to this to receive the result.
733 * To obtain a valid handle, the port must first be opened by calling
734 * sp_open() using the same port structure.
736 * After the port is closed or the port structure freed, the handle may
737 * no longer be valid.
739 * @warning This feature is provided so that programs may make use of
740 * OS-specific functionality where desired. Doing so obviously
741 * comes at a cost in portability. It also cannot be guaranteed
742 * that direct usage of the OS handle will not conflict with the
743 * library's own usage of the port. Be careful.
745 * @param[in] port Pointer to a port structure. Must not be NULL.
746 * @param[out] result_ptr If any error is returned, the variable pointed to by
747 * result_ptr will have unknown contents and should not
748 * be used. Otherwise, it will be set to point to the
749 * OS handle. Must not be NULL.
751 * @return SP_OK upon success, a negative error code otherwise.
755 SP_API enum sp_return sp_get_port_handle(const struct sp_port *port, void *result_ptr);
760 * @defgroup Configuration Configuration
762 * Setting and querying serial port parameters.
767 * Allocate a port configuration structure.
769 * The user should allocate a variable of type "struct sp_port_config *" and
770 * pass a pointer to this to receive the result. The variable will be updated
771 * to point to the new configuration structure. The structure is opaque and
772 * must be accessed via the functions provided.
774 * All parameters in the structure will be initialised to special values which
775 * are ignored by sp_set_config().
777 * The structure should be freed after use by calling sp_free_config().
779 * @param[out] config_ptr If any error is returned, the variable pointed to by
780 * config_ptr will be set to NULL. Otherwise, it will
781 * be set to point to the allocated config structure.
784 * @return SP_OK upon success, a negative error code otherwise.
788 SP_API enum sp_return sp_new_config(struct sp_port_config **config_ptr);
791 * Free a port configuration structure.
793 * @param[in] config Pointer to a configuration structure. Must not be NULL.
797 SP_API void sp_free_config(struct sp_port_config *config);
800 * Get the current configuration of the specified serial port.
802 * The user should allocate a configuration structure using sp_new_config()
803 * and pass this as the config parameter. The configuration structure will
804 * be updated with the port configuration.
806 * Any parameters that are configured with settings not recognised or
807 * supported by libserialport, will be set to special values that are
808 * ignored by sp_set_config().
810 * @param[in] port Pointer to a port structure. Must not be NULL.
811 * @param[out] config Pointer to a configuration structure that will hold
812 * the result. Upon errors the contents of the config
813 * struct will not be changed. Must not be NULL.
815 * @return SP_OK upon success, a negative error code otherwise.
819 SP_API enum sp_return sp_get_config(struct sp_port *port, struct sp_port_config *config);
822 * Set the configuration for the specified serial port.
824 * For each parameter in the configuration, there is a special value (usually
825 * -1, but see the documentation for each field). These values will be ignored
826 * and the corresponding setting left unchanged on the port.
828 * Upon errors, the configuration of the serial port is unknown since
829 * partial/incomplete config updates may have happened.
831 * @param[in] port Pointer to a port structure. Must not be NULL.
832 * @param[in] config Pointer to a configuration structure. Must not be NULL.
834 * @return SP_OK upon success, a negative error code otherwise.
838 SP_API enum sp_return sp_set_config(struct sp_port *port, const struct sp_port_config *config);
841 * Set the baud rate for the specified serial port.
843 * @param[in] port Pointer to a port structure. Must not be NULL.
844 * @param[in] baudrate Baud rate in bits per second.
846 * @return SP_OK upon success, a negative error code otherwise.
850 SP_API enum sp_return sp_set_baudrate(struct sp_port *port, int baudrate);
853 * Get the baud rate from a port configuration.
855 * The user should allocate a variable of type int and
856 * pass a pointer to this to receive the result.
858 * @param[in] config Pointer to a configuration structure. Must not be NULL.
859 * @param[out] baudrate_ptr Pointer to a variable to store the result. Must not be NULL.
861 * @return SP_OK upon success, a negative error code otherwise.
865 SP_API enum sp_return sp_get_config_baudrate(const struct sp_port_config *config, int *baudrate_ptr);
868 * Set the baud rate in a port configuration.
870 * @param[in] config Pointer to a configuration structure. Must not be NULL.
871 * @param[in] baudrate Baud rate in bits per second, or -1 to retain the current setting.
873 * @return SP_OK upon success, a negative error code otherwise.
877 SP_API enum sp_return sp_set_config_baudrate(struct sp_port_config *config, int baudrate);
880 * Set the data bits for the specified serial port.
882 * @param[in] port Pointer to a port structure. Must not be NULL.
883 * @param[in] bits Number of data bits.
885 * @return SP_OK upon success, a negative error code otherwise.
889 SP_API enum sp_return sp_set_bits(struct sp_port *port, int bits);
892 * Get the data bits from a port configuration.
894 * The user should allocate a variable of type int and
895 * pass a pointer to this to receive the result.
897 * @param[in] config Pointer to a configuration structure. Must not be NULL.
898 * @param[out] bits_ptr Pointer to a variable to store the result. Must not be NULL.
900 * @return SP_OK upon success, a negative error code otherwise.
904 SP_API enum sp_return sp_get_config_bits(const struct sp_port_config *config, int *bits_ptr);
907 * Set the data bits in a port configuration.
909 * @param[in] config Pointer to a configuration structure. Must not be NULL.
910 * @param[in] bits Number of data bits, or -1 to retain the current setting.
912 * @return SP_OK upon success, a negative error code otherwise.
916 SP_API enum sp_return sp_set_config_bits(struct sp_port_config *config, int bits);
919 * Set the parity setting for the specified serial port.
921 * @param[in] port Pointer to a port structure. Must not be NULL.
922 * @param[in] parity Parity setting.
924 * @return SP_OK upon success, a negative error code otherwise.
928 SP_API enum sp_return sp_set_parity(struct sp_port *port, enum sp_parity parity);
931 * Get the parity setting from a port configuration.
933 * The user should allocate a variable of type enum sp_parity and
934 * pass a pointer to this to receive the result.
936 * @param[in] config Pointer to a configuration structure. Must not be NULL.
937 * @param[out] parity_ptr Pointer to a variable to store the result. Must not be NULL.
939 * @return SP_OK upon success, a negative error code otherwise.
943 SP_API enum sp_return sp_get_config_parity(const struct sp_port_config *config, enum sp_parity *parity_ptr);
946 * Set the parity setting in a port configuration.
948 * @param[in] config Pointer to a configuration structure. Must not be NULL.
949 * @param[in] parity Parity setting, or -1 to retain the current setting.
951 * @return SP_OK upon success, a negative error code otherwise.
955 SP_API enum sp_return sp_set_config_parity(struct sp_port_config *config, enum sp_parity parity);
958 * Set the stop bits for the specified serial port.
960 * @param[in] port Pointer to a port structure. Must not be NULL.
961 * @param[in] stopbits Number of stop bits.
963 * @return SP_OK upon success, a negative error code otherwise.
967 SP_API enum sp_return sp_set_stopbits(struct sp_port *port, int stopbits);
970 * Get the stop bits from a port configuration.
972 * The user should allocate a variable of type int and
973 * pass a pointer to this to receive the result.
975 * @param[in] config Pointer to a configuration structure. Must not be NULL.
976 * @param[out] stopbits_ptr Pointer to a variable to store the result. Must not be NULL.
978 * @return SP_OK upon success, a negative error code otherwise.
982 SP_API enum sp_return sp_get_config_stopbits(const struct sp_port_config *config, int *stopbits_ptr);
985 * Set the stop bits in a port configuration.
987 * @param[in] config Pointer to a configuration structure. Must not be NULL.
988 * @param[in] stopbits Number of stop bits, or -1 to retain the current setting.
990 * @return SP_OK upon success, a negative error code otherwise.
994 SP_API enum sp_return sp_set_config_stopbits(struct sp_port_config *config, int stopbits);
997 * Set the RTS pin behaviour for the specified serial port.
999 * @param[in] port Pointer to a port structure. Must not be NULL.
1000 * @param[in] rts RTS pin mode.
1002 * @return SP_OK upon success, a negative error code otherwise.
1006 SP_API enum sp_return sp_set_rts(struct sp_port *port, enum sp_rts rts);
1009 * Get the RTS pin behaviour from a port configuration.
1011 * The user should allocate a variable of type enum sp_rts and
1012 * pass a pointer to this to receive the result.
1014 * @param[in] config Pointer to a configuration structure. Must not be NULL.
1015 * @param[out] rts_ptr Pointer to a variable to store the result. Must not be NULL.
1017 * @return SP_OK upon success, a negative error code otherwise.
1021 SP_API enum sp_return sp_get_config_rts(const struct sp_port_config *config, enum sp_rts *rts_ptr);
1024 * Set the RTS pin behaviour in a port configuration.
1026 * @param[in] config Pointer to a configuration structure. Must not be NULL.
1027 * @param[in] rts RTS pin mode, or -1 to retain the current setting.
1029 * @return SP_OK upon success, a negative error code otherwise.
1033 SP_API enum sp_return sp_set_config_rts(struct sp_port_config *config, enum sp_rts rts);
1036 * Set the CTS pin behaviour for the specified serial port.
1038 * @param[in] port Pointer to a port structure. Must not be NULL.
1039 * @param[in] cts CTS pin mode.
1041 * @return SP_OK upon success, a negative error code otherwise.
1045 SP_API enum sp_return sp_set_cts(struct sp_port *port, enum sp_cts cts);
1048 * Get the CTS pin behaviour from a port configuration.
1050 * The user should allocate a variable of type enum sp_cts and
1051 * pass a pointer to this to receive the result.
1053 * @param[in] config Pointer to a configuration structure. Must not be NULL.
1054 * @param[out] cts_ptr Pointer to a variable to store the result. Must not be NULL.
1056 * @return SP_OK upon success, a negative error code otherwise.
1060 SP_API enum sp_return sp_get_config_cts(const struct sp_port_config *config, enum sp_cts *cts_ptr);
1063 * Set the CTS pin behaviour in a port configuration.
1065 * @param[in] config Pointer to a configuration structure. Must not be NULL.
1066 * @param[in] cts CTS pin mode, or -1 to retain the current setting.
1068 * @return SP_OK upon success, a negative error code otherwise.
1072 SP_API enum sp_return sp_set_config_cts(struct sp_port_config *config, enum sp_cts cts);
1075 * Set the DTR pin behaviour for the specified serial port.
1077 * @param[in] port Pointer to a port structure. Must not be NULL.
1078 * @param[in] dtr DTR pin mode.
1080 * @return SP_OK upon success, a negative error code otherwise.
1084 SP_API enum sp_return sp_set_dtr(struct sp_port *port, enum sp_dtr dtr);
1087 * Get the DTR pin behaviour from a port configuration.
1089 * The user should allocate a variable of type enum sp_dtr and
1090 * pass a pointer to this to receive the result.
1092 * @param[in] config Pointer to a configuration structure. Must not be NULL.
1093 * @param[out] dtr_ptr Pointer to a variable to store the result. Must not be NULL.
1095 * @return SP_OK upon success, a negative error code otherwise.
1099 SP_API enum sp_return sp_get_config_dtr(const struct sp_port_config *config, enum sp_dtr *dtr_ptr);
1102 * Set the DTR pin behaviour in a port configuration.
1104 * @param[in] config Pointer to a configuration structure. Must not be NULL.
1105 * @param[in] dtr DTR pin mode, or -1 to retain the current setting.
1107 * @return SP_OK upon success, a negative error code otherwise.
1111 SP_API enum sp_return sp_set_config_dtr(struct sp_port_config *config, enum sp_dtr dtr);
1114 * Set the DSR pin behaviour for the specified serial port.
1116 * @param[in] port Pointer to a port structure. Must not be NULL.
1117 * @param[in] dsr DSR pin mode.
1119 * @return SP_OK upon success, a negative error code otherwise.
1123 SP_API enum sp_return sp_set_dsr(struct sp_port *port, enum sp_dsr dsr);
1126 * Get the DSR pin behaviour from a port configuration.
1128 * The user should allocate a variable of type enum sp_dsr and
1129 * pass a pointer to this to receive the result.
1131 * @param[in] config Pointer to a configuration structure. Must not be NULL.
1132 * @param[out] dsr_ptr Pointer to a variable to store the result. Must not be NULL.
1134 * @return SP_OK upon success, a negative error code otherwise.
1138 SP_API enum sp_return sp_get_config_dsr(const struct sp_port_config *config, enum sp_dsr *dsr_ptr);
1141 * Set the DSR pin behaviour in a port configuration.
1143 * @param[in] config Pointer to a configuration structure. Must not be NULL.
1144 * @param[in] dsr DSR pin mode, or -1 to retain the current setting.
1146 * @return SP_OK upon success, a negative error code otherwise.
1150 SP_API enum sp_return sp_set_config_dsr(struct sp_port_config *config, enum sp_dsr dsr);
1153 * Set the XON/XOFF configuration for the specified serial port.
1155 * @param[in] port Pointer to a port structure. Must not be NULL.
1156 * @param[in] xon_xoff XON/XOFF mode.
1158 * @return SP_OK upon success, a negative error code otherwise.
1162 SP_API enum sp_return sp_set_xon_xoff(struct sp_port *port, enum sp_xonxoff xon_xoff);
1165 * Get the XON/XOFF configuration from a port configuration.
1167 * The user should allocate a variable of type enum sp_xonxoff and
1168 * pass a pointer to this to receive the result.
1170 * @param[in] config Pointer to a configuration structure. Must not be NULL.
1171 * @param[out] xon_xoff_ptr Pointer to a variable to store the result. Must not be NULL.
1173 * @return SP_OK upon success, a negative error code otherwise.
1177 SP_API enum sp_return sp_get_config_xon_xoff(const struct sp_port_config *config, enum sp_xonxoff *xon_xoff_ptr);
1180 * Set the XON/XOFF configuration in a port configuration.
1182 * @param[in] config Pointer to a configuration structure. Must not be NULL.
1183 * @param[in] xon_xoff XON/XOFF mode, or -1 to retain the current setting.
1185 * @return SP_OK upon success, a negative error code otherwise.
1189 SP_API enum sp_return sp_set_config_xon_xoff(struct sp_port_config *config, enum sp_xonxoff xon_xoff);
1192 * Set the flow control type in a port configuration.
1194 * This function is a wrapper that sets the RTS, CTS, DTR, DSR and
1195 * XON/XOFF settings as necessary for the specified flow control
1196 * type. For more fine-grained control of these settings, use their
1197 * individual configuration functions.
1199 * @param[in] config Pointer to a configuration structure. Must not be NULL.
1200 * @param[in] flowcontrol Flow control setting to use.
1202 * @return SP_OK upon success, a negative error code otherwise.
1206 SP_API enum sp_return sp_set_config_flowcontrol(struct sp_port_config *config, enum sp_flowcontrol flowcontrol);
1209 * Set the flow control type for the specified serial port.
1211 * This function is a wrapper that sets the RTS, CTS, DTR, DSR and
1212 * XON/XOFF settings as necessary for the specified flow control
1213 * type. For more fine-grained control of these settings, use their
1214 * individual configuration functions.
1216 * @param[in] port Pointer to a port structure. Must not be NULL.
1217 * @param[in] flowcontrol Flow control setting to use.
1219 * @return SP_OK upon success, a negative error code otherwise.
1223 SP_API enum sp_return sp_set_flowcontrol(struct sp_port *port, enum sp_flowcontrol flowcontrol);
1228 * @defgroup Data Data handling
1230 * Reading, writing, and flushing data.
1236 * Read bytes from the specified serial port, blocking until complete.
1238 * @warning If your program runs on Unix, defines its own signal handlers, and
1239 * needs to abort blocking reads when these are called, then you
1240 * should not use this function. It repeats system calls that return
1241 * with EINTR. To be able to abort a read from a signal handler, you
1242 * should implement your own blocking read using sp_nonblocking_read()
1243 * together with a blocking method that makes sense for your program.
1244 * E.g. you can obtain the file descriptor for an open port using
1245 * sp_get_port_handle() and use this to call select() or pselect(),
1246 * with appropriate arrangements to return if a signal is received.
1248 * @param[in] port Pointer to a port structure. Must not be NULL.
1249 * @param[out] buf Buffer in which to store the bytes read. Must not be NULL.
1250 * @param[in] count Requested number of bytes to read.
1251 * @param[in] timeout_ms Timeout in milliseconds, or zero to wait indefinitely.
1253 * @return The number of bytes read on success, or a negative error code. If
1254 * the number of bytes returned is less than that requested, the
1255 * timeout was reached before the requested number of bytes was
1256 * available. If timeout is zero, the function will always return
1257 * either the requested number of bytes or a negative error code.
1261 SP_API enum sp_return sp_blocking_read(struct sp_port *port, void *buf, size_t count, unsigned int timeout_ms);
1264 * Read bytes from the specified serial port, returning as soon as any data is
1267 * @warning If your program runs on Unix, defines its own signal handlers, and
1268 * needs to abort blocking reads when these are called, then you
1269 * should not use this function. It repeats system calls that return
1270 * with EINTR. To be able to abort a read from a signal handler, you
1271 * should implement your own blocking read using sp_nonblocking_read()
1272 * together with a blocking method that makes sense for your program.
1273 * E.g. you can obtain the file descriptor for an open port using
1274 * sp_get_port_handle() and use this to call select() or pselect(),
1275 * with appropriate arrangements to return if a signal is received.
1277 * @param[in] port Pointer to a port structure. Must not be NULL.
1278 * @param[out] buf Buffer in which to store the bytes read. Must not be NULL.
1279 * @param[in] count Maximum number of bytes to read. Must not be zero.
1280 * @param[in] timeout_ms Timeout in milliseconds, or zero to wait indefinitely.
1282 * @return The number of bytes read on success, or a negative error code. If
1283 * the result is zero, the timeout was reached before any bytes were
1284 * available. If timeout_ms is zero, the function will always return
1285 * either at least one byte, or a negative error code.
1289 SP_API enum sp_return sp_blocking_read_next(struct sp_port *port, void *buf, size_t count, unsigned int timeout_ms);
1292 * Read bytes from the specified serial port, without blocking.
1294 * @param[in] port Pointer to a port structure. Must not be NULL.
1295 * @param[out] buf Buffer in which to store the bytes read. Must not be NULL.
1296 * @param[in] count Maximum number of bytes to read.
1298 * @return The number of bytes read on success, or a negative error code. The
1299 * number of bytes returned may be any number from zero to the maximum
1300 * that was requested.
1304 SP_API enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf, size_t count);
1307 * Write bytes to the specified serial port, blocking until complete.
1309 * Note that this function only ensures that the accepted bytes have been
1310 * written to the OS; they may be held in driver or hardware buffers and not
1311 * yet physically transmitted. To check whether all written bytes have actually
1312 * been transmitted, use the sp_output_waiting() function. To wait until all
1313 * written bytes have actually been transmitted, use the sp_drain() function.
1315 * @warning If your program runs on Unix, defines its own signal handlers, and
1316 * needs to abort blocking writes when these are called, then you
1317 * should not use this function. It repeats system calls that return
1318 * with EINTR. To be able to abort a write from a signal handler, you
1319 * should implement your own blocking write using sp_nonblocking_write()
1320 * together with a blocking method that makes sense for your program.
1321 * E.g. you can obtain the file descriptor for an open port using
1322 * sp_get_port_handle() and use this to call select() or pselect(),
1323 * with appropriate arrangements to return if a signal is received.
1325 * @param[in] port Pointer to a port structure. Must not be NULL.
1326 * @param[in] buf Buffer containing the bytes to write. Must not be NULL.
1327 * @param[in] count Requested number of bytes to write.
1328 * @param[in] timeout_ms Timeout in milliseconds, or zero to wait indefinitely.
1330 * @return The number of bytes written on success, or a negative error code.
1331 * If the number of bytes returned is less than that requested, the
1332 * timeout was reached before the requested number of bytes was
1333 * written. If timeout is zero, the function will always return
1334 * either the requested number of bytes or a negative error code. In
1335 * the event of an error there is no way to determine how many bytes
1336 * were sent before the error occurred.
1340 SP_API enum sp_return sp_blocking_write(struct sp_port *port, const void *buf, size_t count, unsigned int timeout_ms);
1343 * Write bytes to the specified serial port, without blocking.
1345 * Note that this function only ensures that the accepted bytes have been
1346 * written to the OS; they may be held in driver or hardware buffers and not
1347 * yet physically transmitted. To check whether all written bytes have actually
1348 * been transmitted, use the sp_output_waiting() function. To wait until all
1349 * written bytes have actually been transmitted, use the sp_drain() function.
1351 * @param[in] port Pointer to a port structure. Must not be NULL.
1352 * @param[in] buf Buffer containing the bytes to write. Must not be NULL.
1353 * @param[in] count Maximum number of bytes to write.
1355 * @return The number of bytes written on success, or a negative error code.
1356 * The number of bytes returned may be any number from zero to the
1357 * maximum that was requested.
1361 SP_API enum sp_return sp_nonblocking_write(struct sp_port *port, const void *buf, size_t count);
1364 * Gets the number of bytes waiting in the input buffer.
1366 * @param[in] port Pointer to a port structure. Must not be NULL.
1368 * @return Number of bytes waiting on success, a negative error code otherwise.
1372 SP_API enum sp_return sp_input_waiting(struct sp_port *port);
1375 * Gets the number of bytes waiting in the output buffer.
1377 * @param[in] port Pointer to a port structure. Must not be NULL.
1379 * @return Number of bytes waiting on success, a negative error code otherwise.
1383 SP_API enum sp_return sp_output_waiting(struct sp_port *port);
1386 * Flush serial port buffers. Data in the selected buffer(s) is discarded.
1388 * @param[in] port Pointer to a port structure. Must not be NULL.
1389 * @param[in] buffers Which buffer(s) to flush.
1391 * @return SP_OK upon success, a negative error code otherwise.
1395 SP_API enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers);
1398 * Wait for buffered data to be transmitted.
1400 * @warning If your program runs on Unix, defines its own signal handlers, and
1401 * needs to abort draining the output buffer when when these are
1402 * called, then you should not use this function. It repeats system
1403 * calls that return with EINTR. To be able to abort a drain from a
1404 * signal handler, you would need to implement your own blocking
1405 * drain by polling the result of sp_output_waiting().
1407 * @param[in] port Pointer to a port structure. Must not be NULL.
1409 * @return SP_OK upon success, a negative error code otherwise.
1413 SP_API enum sp_return sp_drain(struct sp_port *port);
1418 * @defgroup Waiting Waiting
1420 * Waiting for events and timeout handling.
1426 * Allocate storage for a set of events.
1428 * The user should allocate a variable of type struct sp_event_set *,
1429 * then pass a pointer to this variable to receive the result.
1431 * The result should be freed after use by calling sp_free_event_set().
1433 * @param[out] result_ptr If any error is returned, the variable pointed to by
1434 * result_ptr will be set to NULL. Otherwise, it will
1435 * be set to point to the event set. Must not be NULL.
1437 * @return SP_OK upon success, a negative error code otherwise.
1441 SP_API enum sp_return sp_new_event_set(struct sp_event_set **result_ptr);
1444 * Add events to a struct sp_event_set for a given port.
1446 * The port must first be opened by calling sp_open() using the same port
1449 * After the port is closed or the port structure freed, the results may
1450 * no longer be valid.
1452 * @param[in,out] event_set Event set to update. Must not be NULL.
1453 * @param[in] port Pointer to a port structure. Must not be NULL.
1454 * @param[in] mask Bitmask of events to be waited for.
1456 * @return SP_OK upon success, a negative error code otherwise.
1460 SP_API enum sp_return sp_add_port_events(struct sp_event_set *event_set,
1461 const struct sp_port *port, enum sp_event mask);
1464 * Wait for any of a set of events to occur.
1466 * @param[in] event_set Event set to wait on. Must not be NULL.
1467 * @param[in] timeout_ms Timeout in milliseconds, or zero to wait indefinitely.
1469 * @return SP_OK upon success, a negative error code otherwise.
1473 SP_API enum sp_return sp_wait(struct sp_event_set *event_set, unsigned int timeout_ms);
1476 * Free a structure allocated by sp_new_event_set().
1478 * @param[in] event_set Event set to free. Must not be NULL.
1482 SP_API void sp_free_event_set(struct sp_event_set *event_set);
1487 * @defgroup Signals Signals
1489 * Port signalling operations.
1495 * Gets the status of the control signals for the specified port.
1497 * The user should allocate a variable of type "enum sp_signal" and pass a
1498 * pointer to this variable to receive the result. The result is a bitmask
1499 * in which individual signals can be checked by bitwise OR with values of
1500 * the sp_signal enum.
1502 * @param[in] port Pointer to a port structure. Must not be NULL.
1503 * @param[out] signal_mask Pointer to a variable to receive the result.
1506 * @return SP_OK upon success, a negative error code otherwise.
1510 SP_API enum sp_return sp_get_signals(struct sp_port *port, enum sp_signal *signal_mask);
1513 * Put the port transmit line into the break state.
1515 * @param[in] port Pointer to a port structure. Must not be NULL.
1517 * @return SP_OK upon success, a negative error code otherwise.
1521 SP_API enum sp_return sp_start_break(struct sp_port *port);
1524 * Take the port transmit line out of the break state.
1526 * @param[in] port Pointer to a port structure. Must not be NULL.
1528 * @return SP_OK upon success, a negative error code otherwise.
1532 SP_API enum sp_return sp_end_break(struct sp_port *port);
1537 * @defgroup Errors Errors
1539 * Obtaining error information.
1545 * Get the error code for a failed operation.
1547 * In order to obtain the correct result, this function should be called
1548 * straight after the failure, before executing any other system operations.
1549 * The result is thread-specific, and only valid when called immediately
1550 * after a previous call returning SP_ERR_FAIL.
1552 * @return The system's numeric code for the error that caused the last
1553 * operation to fail.
1557 SP_API int sp_last_error_code(void);
1560 * Get the error message for a failed operation.
1562 * In order to obtain the correct result, this function should be called
1563 * straight after the failure, before executing other system operations.
1564 * The result is thread-specific, and only valid when called immediately
1565 * after a previous call returning SP_ERR_FAIL.
1567 * @return The system's message for the error that caused the last
1568 * operation to fail. This string may be allocated by the function,
1569 * and should be freed after use by calling sp_free_error_message().
1573 SP_API char *sp_last_error_message(void);
1576 * Free an error message returned by sp_last_error_message().
1578 * @param[in] message The error message string to free. Must not be NULL.
1582 SP_API void sp_free_error_message(char *message);
1585 * Set the handler function for library debugging messages.
1587 * Debugging messages are generated by the library during each operation,
1588 * to help in diagnosing problems. The handler will be called for each
1589 * message. The handler can be set to NULL to ignore all debug messages.
1591 * The handler function should accept a format string and variable length
1592 * argument list, in the same manner as e.g. printf().
1594 * The default handler is sp_default_debug_handler().
1596 * @param[in] handler The handler function to use. Can be NULL (in that case
1597 * all debug messages will be ignored).
1601 SP_API void sp_set_debug_handler(void (*handler)(const char *format, ...));
1604 * Default handler function for library debugging messages.
1606 * This function prints debug messages to the standard error stream if the
1607 * environment variable LIBSERIALPORT_DEBUG is set. Otherwise, they are
1610 * @param[in] format The format string to use. Must not be NULL.
1611 * @param[in] ... The variable length argument list to use.
1615 SP_API void sp_default_debug_handler(const char *format, ...);
1620 * @defgroup Versions Versions
1622 * Version number querying functions, definitions, and macros.
1624 * This set of API calls returns two different version numbers related
1625 * to libserialport. The "package version" is the release version number of the
1626 * libserialport tarball in the usual "major.minor.micro" format, e.g. "0.1.0".
1628 * The "library version" is independent of that; it is the libtool version
1629 * number in the "current:revision:age" format, e.g. "2:0:0".
1630 * See http://www.gnu.org/software/libtool/manual/libtool.html#Libtool-versioning for details.
1632 * Both version numbers (and/or individual components of them) can be
1633 * retrieved via the API calls at runtime, and/or they can be checked at
1634 * compile/preprocessor time using the respective macros.
1640 * Package version macros (can be used for conditional compilation).
1643 /** The libserialport package 'major' version number. */
1644 #define SP_PACKAGE_VERSION_MAJOR 0
1646 /** The libserialport package 'minor' version number. */
1647 #define SP_PACKAGE_VERSION_MINOR 1
1649 /** The libserialport package 'micro' version number. */
1650 #define SP_PACKAGE_VERSION_MICRO 1
1652 /** The libserialport package version ("major.minor.micro") as string. */
1653 #define SP_PACKAGE_VERSION_STRING "0.1.1"
1656 * Library/libtool version macros (can be used for conditional compilation).
1659 /** The libserialport libtool 'current' version number. */
1660 #define SP_LIB_VERSION_CURRENT 1
1662 /** The libserialport libtool 'revision' version number. */
1663 #define SP_LIB_VERSION_REVISION 0
1665 /** The libserialport libtool 'age' version number. */
1666 #define SP_LIB_VERSION_AGE 1
1668 /** The libserialport libtool version ("current:revision:age") as string. */
1669 #define SP_LIB_VERSION_STRING "1:0:1"
1672 * Get the major libserialport package version number.
1674 * @return The major package version number.
1678 SP_API int sp_get_major_package_version(void);
1681 * Get the minor libserialport package version number.
1683 * @return The minor package version number.
1687 SP_API int sp_get_minor_package_version(void);
1690 * Get the micro libserialport package version number.
1692 * @return The micro package version number.
1696 SP_API int sp_get_micro_package_version(void);
1699 * Get the libserialport package version number as a string.
1701 * @return The package version number string. The returned string is
1702 * static and thus should NOT be free'd by the caller.
1706 SP_API const char *sp_get_package_version_string(void);
1709 * Get the "current" part of the libserialport library version number.
1711 * @return The "current" library version number.
1715 SP_API int sp_get_current_lib_version(void);
1718 * Get the "revision" part of the libserialport library version number.
1720 * @return The "revision" library version number.
1724 SP_API int sp_get_revision_lib_version(void);
1727 * Get the "age" part of the libserialport library version number.
1729 * @return The "age" library version number.
1733 SP_API int sp_get_age_lib_version(void);
1736 * Get the libserialport library version number as a string.
1738 * @return The library version number string. The returned string is
1739 * static and thus should NOT be free'd by the caller.
1743 SP_API const char *sp_get_lib_version_string(void);
1748 * @example list_ports.c Getting a list of ports present on the system.
1749 * @example port_info.c Getting information on a particular serial port.