X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=libserialport.h.in;h=036db4c425b77525d047163f05a80141910318c8;hb=073c86bd070a4a5d55c9971ad779a0da32835b17;hp=d71ba7f4a86db8343971967b5925c5795857cabf;hpb=0a1ab8bf8f4c76c809c63ff26d0aa4a5af418728;p=libserialport.git

diff --git a/libserialport.h.in b/libserialport.h.in
index d71ba7f..036db4c 100644
--- a/libserialport.h.in
+++ b/libserialport.h.in
@@ -36,6 +36,7 @@
  * - @ref Configuration (baud rate, parity, etc.)
  * - @ref Signals (modem control lines, breaks, etc.)
  * - @ref Data
+ * - @ref Waiting
  * - @ref Errors
  *
  * libserialport is an open source project released under the LGPL3+ license.
@@ -88,18 +89,6 @@ extern "C" {
 #include <windows.h>
 #endif
 
-/* Package version macros (e.g. for conditional compilation). */
-#define SP_PACKAGE_VERSION_MAJOR @SP_PACKAGE_VERSION_MAJOR@
-#define SP_PACKAGE_VERSION_MINOR @SP_PACKAGE_VERSION_MINOR@
-#define SP_PACKAGE_VERSION_MICRO @SP_PACKAGE_VERSION_MICRO@
-#define SP_PACKAGE_VERSION_STRING "@SP_PACKAGE_VERSION@"
-
-/* Library/libtool version macros (e.g. for conditional compilation). */
-#define SP_LIB_VERSION_CURRENT @SP_LIB_VERSION_CURRENT@
-#define SP_LIB_VERSION_REVISION @SP_LIB_VERSION_REVISION@
-#define SP_LIB_VERSION_AGE @SP_LIB_VERSION_AGE@
-#define SP_LIB_VERSION_STRING "@SP_LIB_VERSION@"
-
 /** Return values. */
 enum sp_return {
 	/** Operation completed successfully. */
@@ -122,6 +111,16 @@ enum sp_mode {
 	SP_MODE_WRITE = 2,
 };
 
+/** Port events. */
+enum sp_event {
+	/* Data received and ready to read. */
+	SP_EVENT_RX_READY = 1,
+	/* Ready to transmit new data. */
+	SP_EVENT_TX_READY = 2,
+	/* Error occured. */
+	SP_EVENT_ERROR = 4,
+};
+
 /** Buffer selection. */
 enum sp_buffer {
 	/** Input buffer. */
@@ -242,6 +241,19 @@ struct sp_port;
  */
 struct sp_port_config;
 
+/**
+ * @struct sp_event_set
+ * A set of handles to wait on for events.
+ */
+struct sp_event_set {
+	/** Array of OS-specific handles. */
+	void *handles;
+	/** Array of bitmasks indicating which events apply for each handle. */
+	enum sp_event *masks;
+	/** Number of handles. */
+	unsigned int count;
+};
+
 /**
 @defgroup Enumeration Port enumeration
 @{
@@ -259,11 +271,15 @@ struct sp_port_config;
  * to NULL. Otherwise, it will be set to point to the newly allocated port.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_ptr);
 
 /**
  * Free a port structure obtained from sp_get_port_by_name() or sp_copy_port().
+ *
+ * @since 0.1.0
  */
 void sp_free_port(struct sp_port *port);
 
@@ -282,6 +298,8 @@ void sp_free_port(struct sp_port *port);
  * to NULL. Otherwise, it will be set to point to the newly allocated array.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_list_ports(struct sp_port ***list_ptr);
 
@@ -297,6 +315,8 @@ enum sp_return sp_list_ports(struct sp_port ***list_ptr);
  * to NULL. Otherwise, it will be set to point to the newly allocated copy.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_copy_port(const struct sp_port *port, struct sp_port **copy_ptr);
 
@@ -305,6 +325,8 @@ enum sp_return sp_copy_port(const struct sp_port *port, struct sp_port **copy_pt
  *
  * This will also free all the sp_port structures referred to from the list;
  * any that are to be retained must be copied first using sp_copy_port().
+ *
+ * @since 0.1.0
  */
 void sp_free_port_list(struct sp_port **ports);
 
@@ -321,6 +343,8 @@ void sp_free_port_list(struct sp_port **ports);
  * @param flags Flags to use when opening the serial port.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_open(struct sp_port *port, enum sp_mode flags);
 
@@ -328,6 +352,8 @@ enum sp_return sp_open(struct sp_port *port, enum sp_mode flags);
  * Close the specified serial port.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_close(struct sp_port *port);
 
@@ -343,6 +369,8 @@ enum sp_return sp_close(struct sp_port *port);
  * @return The port name, or NULL if an invalid port is passed. The name
  * string is part of the port structure and may not be used after the
  * port structure has been freed.
+ *
+ * @since 0.1.0
  */
 char *sp_get_port_name(const struct sp_port *port);
 
@@ -367,6 +395,8 @@ char *sp_get_port_name(const struct sp_port *port);
  *          library's own usage of the port. Be careful.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_get_port_handle(const struct sp_port *port, void *result_ptr);
 
@@ -392,6 +422,8 @@ enum sp_return sp_get_port_handle(const struct sp_port *port, void *result_ptr);
  * @param config_ptr Pointer to variable to receive result.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_new_config(struct sp_port_config **config_ptr);
 
@@ -399,6 +431,8 @@ enum sp_return sp_new_config(struct sp_port_config **config_ptr);
  * Free a port configuration structure.
  *
  * @param config Pointer to configuration structure.
+ *
+ * @since 0.1.0
  */
 void sp_free_config(struct sp_port_config *config);
 
@@ -414,6 +448,8 @@ void sp_free_config(struct sp_port_config *config);
  * ignored by sp_set_config().
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_get_config(struct sp_port *port, struct sp_port_config *config);
 
@@ -425,6 +461,8 @@ enum sp_return sp_get_config(struct sp_port *port, struct sp_port_config *config
  * and the corresponding setting left unchanged on the port.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_set_config(struct sp_port *port, const struct sp_port_config *config);
 
@@ -435,6 +473,8 @@ enum sp_return sp_set_config(struct sp_port *port, const struct sp_port_config *
  * @param baudrate Baud rate in bits per second.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_set_baudrate(struct sp_port *port, int baudrate);
 
@@ -448,6 +488,8 @@ enum sp_return sp_set_baudrate(struct sp_port *port, int baudrate);
  * @param baudrate_ptr Pointer to variable to store result.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_get_config_baudrate(const struct sp_port_config *config, int *baudrate_ptr);
 
@@ -458,6 +500,8 @@ enum sp_return sp_get_config_baudrate(const struct sp_port_config *config, int *
  * @param baudrate Baud rate in bits per second, or -1 to retain current setting.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_set_config_baudrate(struct sp_port_config *config, int baudrate);
 
@@ -468,6 +512,8 @@ enum sp_return sp_set_config_baudrate(struct sp_port_config *config, int baudrat
  * @param bits Number of data bits.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_set_bits(struct sp_port *port, int bits);
 
@@ -481,6 +527,8 @@ enum sp_return sp_set_bits(struct sp_port *port, int bits);
  * @param bits_ptr Pointer to variable to store result.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_get_config_bits(const struct sp_port_config *config, int *bits_ptr);
 
@@ -491,6 +539,8 @@ enum sp_return sp_get_config_bits(const struct sp_port_config *config, int *bits
  * @param bits Number of data bits, or -1 to retain current setting.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_set_config_bits(struct sp_port_config *config, int bits);
 
@@ -501,6 +551,8 @@ enum sp_return sp_set_config_bits(struct sp_port_config *config, int bits);
  * @param parity Parity setting.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_set_parity(struct sp_port *port, enum sp_parity parity);
 
@@ -514,6 +566,8 @@ enum sp_return sp_set_parity(struct sp_port *port, enum sp_parity parity);
  * @param parity_ptr Pointer to variable to store result.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_get_config_parity(const struct sp_port_config *config, enum sp_parity *parity_ptr);
 
@@ -524,6 +578,8 @@ enum sp_return sp_get_config_parity(const struct sp_port_config *config, enum sp
  * @param parity Parity setting, or -1 to retain current setting.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_set_config_parity(struct sp_port_config *config, enum sp_parity parity);
 
@@ -534,6 +590,8 @@ enum sp_return sp_set_config_parity(struct sp_port_config *config, enum sp_parit
  * @param stopbits Number of stop bits.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_set_stopbits(struct sp_port *port, int stopbits);
 
@@ -547,6 +605,8 @@ enum sp_return sp_set_stopbits(struct sp_port *port, int stopbits);
  * @param stopbits_ptr Pointer to variable to store result.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_get_config_stopbits(const struct sp_port_config *config, int *stopbits_ptr);
 
@@ -557,6 +617,8 @@ enum sp_return sp_get_config_stopbits(const struct sp_port_config *config, int *
  * @param stopbits Number of stop bits, or -1 to retain current setting.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_set_config_stopbits(struct sp_port_config *config, int stopbits);
 
@@ -567,6 +629,8 @@ enum sp_return sp_set_config_stopbits(struct sp_port_config *config, int stopbit
  * @param rts RTS pin mode.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_set_rts(struct sp_port *port, enum sp_rts rts);
 
@@ -580,6 +644,8 @@ enum sp_return sp_set_rts(struct sp_port *port, enum sp_rts rts);
  * @param rts_ptr Pointer to variable to store result.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_get_config_rts(const struct sp_port_config *config, enum sp_rts *rts_ptr);
 
@@ -590,6 +656,8 @@ enum sp_return sp_get_config_rts(const struct sp_port_config *config, enum sp_rt
  * @param rts RTS pin mode, or -1 to retain current setting.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_set_config_rts(struct sp_port_config *config, enum sp_rts rts);
 
@@ -600,6 +668,8 @@ enum sp_return sp_set_config_rts(struct sp_port_config *config, enum sp_rts rts)
  * @param cts CTS pin mode.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_set_cts(struct sp_port *port, enum sp_cts cts);
 
@@ -613,6 +683,8 @@ enum sp_return sp_set_cts(struct sp_port *port, enum sp_cts cts);
  * @param cts_ptr Pointer to variable to store result.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_get_config_cts(const struct sp_port_config *config, enum sp_cts *cts_ptr);
 
@@ -623,6 +695,8 @@ enum sp_return sp_get_config_cts(const struct sp_port_config *config, enum sp_ct
  * @param cts CTS pin mode, or -1 to retain current setting.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_set_config_cts(struct sp_port_config *config, enum sp_cts cts);
 
@@ -633,6 +707,8 @@ enum sp_return sp_set_config_cts(struct sp_port_config *config, enum sp_cts cts)
  * @param dtr DTR pin mode.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_set_dtr(struct sp_port *port, enum sp_dtr dtr);
 
@@ -646,6 +722,8 @@ enum sp_return sp_set_dtr(struct sp_port *port, enum sp_dtr dtr);
  * @param dtr_ptr Pointer to variable to store result.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_get_config_dtr(const struct sp_port_config *config, enum sp_dtr *dtr_ptr);
 
@@ -656,6 +734,8 @@ enum sp_return sp_get_config_dtr(const struct sp_port_config *config, enum sp_dt
  * @param dtr DTR pin mode, or -1 to retain current setting.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_set_config_dtr(struct sp_port_config *config, enum sp_dtr dtr);
 
@@ -666,6 +746,8 @@ enum sp_return sp_set_config_dtr(struct sp_port_config *config, enum sp_dtr dtr)
  * @param dsr DSR pin mode.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_set_dsr(struct sp_port *port, enum sp_dsr dsr);
 
@@ -679,6 +761,8 @@ enum sp_return sp_set_dsr(struct sp_port *port, enum sp_dsr dsr);
  * @param dsr_ptr Pointer to variable to store result.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_get_config_dsr(const struct sp_port_config *config, enum sp_dsr *dsr_ptr);
 
@@ -689,6 +773,8 @@ enum sp_return sp_get_config_dsr(const struct sp_port_config *config, enum sp_ds
  * @param dsr DSR pin mode, or -1 to retain current setting.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_set_config_dsr(struct sp_port_config *config, enum sp_dsr dsr);
 
@@ -699,6 +785,8 @@ enum sp_return sp_set_config_dsr(struct sp_port_config *config, enum sp_dsr dsr)
  * @param xon_xoff XON/XOFF mode.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_set_xon_xoff(struct sp_port *port, enum sp_xonxoff xon_xoff);
 
@@ -712,6 +800,8 @@ enum sp_return sp_set_xon_xoff(struct sp_port *port, enum sp_xonxoff xon_xoff);
  * @param xon_xoff_ptr Pointer to variable to store result.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_get_config_xon_xoff(const struct sp_port_config *config, enum sp_xonxoff *xon_xoff_ptr);
 
@@ -722,6 +812,8 @@ enum sp_return sp_get_config_xon_xoff(const struct sp_port_config *config, enum
  * @param xon_xoff XON/XOFF mode, or -1 to retain current setting.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_set_config_xon_xoff(struct sp_port_config *config, enum sp_xonxoff xon_xoff);
 
@@ -737,6 +829,8 @@ enum sp_return sp_set_config_xon_xoff(struct sp_port_config *config, enum sp_xon
  * @param flowcontrol Flow control setting to use.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_set_config_flowcontrol(struct sp_port_config *config, enum sp_flowcontrol flowcontrol);
 
@@ -752,6 +846,8 @@ enum sp_return sp_set_config_flowcontrol(struct sp_port_config *config, enum sp_
  * @param flowcontrol Flow control setting to use.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_set_flowcontrol(struct sp_port *port, enum sp_flowcontrol flowcontrol);
 
@@ -784,6 +880,8 @@ enum sp_return sp_set_flowcontrol(struct sp_port *port, enum sp_flowcontrol flow
  *         timeout was reached before the requested number of bytes was
  *         available. If timeout is zero, the function will always return
  *         either the requested number of bytes or a negative error code.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_blocking_read(struct sp_port *port, void *buf, size_t count, unsigned int timeout);
 
@@ -797,6 +895,8 @@ enum sp_return sp_blocking_read(struct sp_port *port, void *buf, size_t count, u
  * @return The number of bytes read on success, or a negative error code. The
  *         number of bytes returned may be any number from zero to the maximum
  *         that was requested.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf, size_t count);
 
@@ -831,6 +931,8 @@ enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf, size_t count
  *         either the requested number of bytes or a negative error code. In
  *         the event of an error there is no way to determine how many bytes
  *         were sent before the error occured.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_blocking_write(struct sp_port *port, const void *buf, size_t count, unsigned int timeout);
 
@@ -850,6 +952,8 @@ enum sp_return sp_blocking_write(struct sp_port *port, const void *buf, size_t c
  * @return The number of bytes written on success, or a negative error code.
  *         The number of bytes returned may be any number from zero to the
  *         maximum that was requested.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_nonblocking_write(struct sp_port *port, const void *buf, size_t count);
 
@@ -859,6 +963,8 @@ enum sp_return sp_nonblocking_write(struct sp_port *port, const void *buf, size_
  * @param port Pointer to port structure.
  *
  * @return Number of bytes waiting on success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_input_waiting(struct sp_port *port);
 
@@ -868,6 +974,8 @@ enum sp_return sp_input_waiting(struct sp_port *port);
  * @param port Pointer to port structure.
  *
  * @return Number of bytes waiting on success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_output_waiting(struct sp_port *port);
 
@@ -878,6 +986,8 @@ enum sp_return sp_output_waiting(struct sp_port *port);
  * @param buffers Which buffer(s) to flush.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers);
 
@@ -894,9 +1004,70 @@ enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers);
  * @param port Pointer to port structure.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_drain(struct sp_port *port);
 
+/**
+ * @}
+ * @defgroup Waiting Waiting for events
+ * @{
+ */
+
+/**
+ * Allocate storage for a set of events.
+ *
+ * The user should allocate a variable of type struct sp_event_set *,
+ * then pass a pointer to this variable to receive the result.
+ *
+ * The result should be freed after use by calling sp_free_event_set().
+ *
+ * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
+ */
+enum sp_return sp_new_event_set(struct sp_event_set **result_ptr);
+
+/**
+ * Add events to a struct sp_event_set for a given port.
+ *
+ * The port must first be opened by calling sp_open() using the same port
+ * structure.
+ *
+ * After the port is closed or the port structure freed, the results may
+ * no longer be valid.
+ *
+ * @param event_set Event set to update.
+ * @param port Pointer to port structure.
+ * @param mask Bitmask of events to be waited for.
+ *
+ * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
+ */
+enum sp_return sp_add_port_events(struct sp_event_set *event_set,
+	const struct sp_port *port, enum sp_event mask);
+
+/**
+ * Wait for any of a set of events to occur.
+ *
+ * @param event_set Event set to wait on.
+ * @param timeout Timeout in milliseconds, or zero to wait indefinitely.
+ *
+ * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
+ */
+enum sp_return sp_wait(struct sp_event_set *event_set, unsigned int timeout);
+
+/**
+ * Free a structure allocated by sp_new_event_set().
+ *
+ * @since 0.1.0
+ */
+void sp_free_event_set(struct sp_event_set *event_set);
+
 /**
  * @}
  * @defgroup Signals Port signalling operations
@@ -915,6 +1086,8 @@ enum sp_return sp_drain(struct sp_port *port);
  * @param signals Pointer to variable to receive result.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_get_signals(struct sp_port *port, enum sp_signal *signals);
 
@@ -924,6 +1097,8 @@ enum sp_return sp_get_signals(struct sp_port *port, enum sp_signal *signals);
  * @param port Pointer to port structure.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_start_break(struct sp_port *port);
 
@@ -933,6 +1108,8 @@ enum sp_return sp_start_break(struct sp_port *port);
  * @param port Pointer to port structure.
  *
  * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.1.0
  */
 enum sp_return sp_end_break(struct sp_port *port);
 
@@ -950,6 +1127,8 @@ enum sp_return sp_end_break(struct sp_port *port);
  *
  * @return The system's numeric code for the error that caused the last
  *         operation to fail.
+ *
+ * @since 0.1.0
  */
 int sp_last_error_code(void);
 
@@ -962,11 +1141,15 @@ int sp_last_error_code(void);
  * @return The system's message for the error that caused the last
  *         operation to fail. This string may be allocated by the function,
  *         and should be freed after use by calling sp_free_error_message().
+ *
+ * @since 0.1.0
  */
 char *sp_last_error_message(void);
 
 /**
  * Free an error message returned by sp_last_error_message().
+ *
+ * @since 0.1.0
  */
 void sp_free_error_message(char *message);
 
@@ -981,6 +1164,8 @@ void sp_free_error_message(char *message);
  * argument list, in the same manner as e.g. printf().
  *
  * The default handler is sp_default_debug_handler().
+ *
+ * @since 0.1.0
  */
 void sp_set_debug_handler(void (*handler)(const char *format, ...));
 
@@ -990,11 +1175,139 @@ void sp_set_debug_handler(void (*handler)(const char *format, ...));
  * This function prints debug messages to the standard error stream if the
  * environment variable LIBSERIALPORT_DEBUG is set. Otherwise, they are
  * ignored.
+ *
+ * @since 0.1.0
  */
 void sp_default_debug_handler(const char *format, ...);
 
 /** @} */
 
+/**
+ * @defgroup Versions Version number querying functions, definitions, and macros
+ *
+ * This set of API calls returns two different version numbers related
+ * to libserialport. The "package version" is the release version number of the
+ * libserialport tarball in the usual "major.minor.micro" format, e.g. "0.1.0".
+ *
+ * The "library version" is independent of that; it is the libtool version
+ * number in the "current:revision:age" format, e.g. "2:0:0".
+ * See http://www.gnu.org/software/libtool/manual/libtool.html#Libtool-versioning for details.
+ *
+ * Both version numbers (and/or individual components of them) can be
+ * retrieved via the API calls at runtime, and/or they can be checked at
+ * compile/preprocessor time using the respective macros.
+ *
+ * @{
+ */
+
+/*
+ * Package version macros (can be used for conditional compilation).
+ */
+
+/** The libserialport package 'major' version number. */
+#define SP_PACKAGE_VERSION_MAJOR @SP_PACKAGE_VERSION_MAJOR@
+
+/** The libserialport package 'minor' version number. */
+#define SP_PACKAGE_VERSION_MINOR @SP_PACKAGE_VERSION_MINOR@
+
+/** The libserialport package 'micro' version number. */
+#define SP_PACKAGE_VERSION_MICRO @SP_PACKAGE_VERSION_MICRO@
+
+/** The libserialport package version ("major.minor.micro") as string. */
+#define SP_PACKAGE_VERSION_STRING "@SP_PACKAGE_VERSION@"
+
+/*
+ * Library/libtool version macros (can be used for conditional compilation).
+ */
+
+/** The libserialport libtool 'current' version number. */
+#define SP_LIB_VERSION_CURRENT @SP_LIB_VERSION_CURRENT@
+
+/** The libserialport libtool 'revision' version number. */
+#define SP_LIB_VERSION_REVISION @SP_LIB_VERSION_REVISION@
+
+/** The libserialport libtool 'age' version number. */
+#define SP_LIB_VERSION_AGE @SP_LIB_VERSION_AGE@
+
+/** The libserialport libtool version ("current:revision:age") as string. */
+#define SP_LIB_VERSION_STRING "@SP_LIB_VERSION@"
+
+/**
+ * Get the major libserialport package version number.
+ *
+ * @return The major package version number.
+ *
+ * @since 0.1.0
+ */
+int sp_get_major_package_version(void);
+
+/**
+ * Get the minor libserialport package version number.
+ *
+ * @return The minor package version number.
+ *
+ * @since 0.1.0
+ */
+int sp_get_minor_package_version(void);
+
+/**
+ * Get the micro libserialport package version number.
+ *
+ * @return The micro package version number.
+ *
+ * @since 0.1.0
+ */
+int sp_get_micro_package_version(void);
+
+/**
+ * Get the libserialport package version number as a string.
+ *
+ * @return The package version number string. The returned string is
+ *         static and thus should NOT be free'd by the caller.
+ *
+ * @since 0.1.0
+ */
+const char *sp_get_package_version_string(void);
+
+/**
+ * Get the "current" part of the libserialport library version number.
+ *
+ * @return The "current" library version number.
+ *
+ * @since 0.1.0
+ */
+int sp_get_current_lib_version(void);
+
+/**
+ * Get the "revision" part of the libserialport library version number.
+ *
+ * @return The "revision" library version number.
+ *
+ * @since 0.1.0
+ */
+int sp_get_revision_lib_version(void);
+
+/**
+ * Get the "age" part of the libserialport library version number.
+ *
+ * @return The "age" library version number.
+ *
+ * @since 0.1.0
+ */
+int sp_get_age_lib_version(void);
+
+/**
+ * Get the libserialport library version number as a string.
+ *
+ * @return The library version number string. The returned string is
+ *         static and thus should NOT be free'd by the caller.
+ *
+ * @since 0.1.0
+ */
+const char *sp_get_lib_version_string(void);
+
+/** @} */
+
 #ifdef __cplusplus
 }
 #endif