#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. */
/** A memory allocation failed while executing the operation. */
SP_ERR_MEM = -3,
/** The requested operation is not supported by this system or device. */
- SP_ERR_SUPP = -4,
+ SP_ERR_SUPP = -4
};
/** Port access modes. */
/** Open port for read access. */
SP_MODE_READ = 1,
/** Open port for write access. */
- SP_MODE_WRITE = 2,
+ SP_MODE_WRITE = 2
};
/** Port events. */
/* Ready to transmit new data. */
SP_EVENT_TX_READY = 2,
/* Error occured. */
- SP_EVENT_ERROR = 4,
+ SP_EVENT_ERROR = 4
};
/** Buffer selection. */
/** Output buffer. */
SP_BUF_OUTPUT = 2,
/** Both buffers. */
- SP_BUF_BOTH = 3,
+ SP_BUF_BOTH = 3
};
/** Parity settings. */
/** Mark parity. */
SP_PARITY_MARK = 3,
/** Space parity. */
- SP_PARITY_SPACE = 4,
+ SP_PARITY_SPACE = 4
};
/** RTS pin behaviour. */
/** RTS on. */
SP_RTS_ON = 1,
/** RTS used for flow control. */
- SP_RTS_FLOW_CONTROL = 2,
+ SP_RTS_FLOW_CONTROL = 2
};
/** CTS pin behaviour. */
/** CTS ignored. */
SP_CTS_IGNORE = 0,
/** CTS used for flow control. */
- SP_CTS_FLOW_CONTROL = 1,
+ SP_CTS_FLOW_CONTROL = 1
};
/** DTR pin behaviour. */
/** DTR on. */
SP_DTR_ON = 1,
/** DTR used for flow control. */
- SP_DTR_FLOW_CONTROL = 2,
+ SP_DTR_FLOW_CONTROL = 2
};
/** DSR pin behaviour. */
/** DSR ignored. */
SP_DSR_IGNORE = 0,
/** DSR used for flow control. */
- SP_DSR_FLOW_CONTROL = 1,
+ SP_DSR_FLOW_CONTROL = 1
};
/** XON/XOFF flow control behaviour. */
/** XON/XOFF enabled for output only. */
SP_XONXOFF_OUT = 2,
/** XON/XOFF enabled for input and output. */
- SP_XONXOFF_INOUT = 3,
+ SP_XONXOFF_INOUT = 3
};
/** Standard flow control combinations. */
/** Hardware flow control using RTS/CTS signals. */
SP_FLOWCONTROL_RTSCTS = 2,
/** Hardware flow control using DTR/DSR signals. */
- SP_FLOWCONTROL_DTRDSR = 3,
+ SP_FLOWCONTROL_DTRDSR = 3
};
/** Input signals. */
/** Data carrier detect. */
SP_SIG_DCD = 4,
/** Ring indicator. */
- SP_SIG_RI = 8,
+ SP_SIG_RI = 8
+};
+
+/** Transport types. */
+enum sp_transport {
+ /** Native platform serial port. */
+ SP_TRANSPORT_NATIVE,
+ /** USB serial port adapter. */
+ SP_TRANSPORT_USB,
+ /** Bluetooh serial port adapter. */
+ SP_TRANSPORT_BLUETOOTH
};
/**
* 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);
* 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);
* 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);
*
* 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);
* @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);
* 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);
* @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);
+/**
+ * Get a description for a port, to present to end user.
+ *
+ * @param port Pointer to port structure.
+ *
+ * @return The port description, or NULL if an invalid port is passed.
+ * The description string is part of the port structure and may not be used
+ * after the port structure has been freed.
+ *
+ * @since 0.2.0
+ */
+char *sp_get_port_description(struct sp_port *port);
+
+/**
+ * Get the transport type used by a port.
+ *
+ * @param port Pointer to port structure.
+ *
+ * @return The port transport type.
+ *
+ * @since 0.2.0
+ */
+enum sp_transport sp_get_port_transport(struct sp_port *port);
+
+/**
+ * Get the USB bus number and address on bus of a USB serial adapter port.
+ *
+ * @param port Pointer to port structure.
+ * @param usb_bus Pointer to variable to store USB bus.
+ * @param usb_address Pointer to variable to store USB address
+ *
+ * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.2.0
+ */
+enum sp_return sp_get_port_usb_bus_address(const struct sp_port *port,
+ int *usb_bus, int *usb_address);
+
+/**
+ * Get the USB Vendor ID and Product ID of a USB serial adapter port.
+ *
+ * @param port Pointer to port structure.
+ * @param usb_vid Pointer to variable to store USB VID.
+ * @param usb_pid Pointer to variable to store USB PID
+ *
+ * @return SP_OK upon success, a negative error code otherwise.
+ *
+ * @since 0.2.0
+ */
+enum sp_return sp_get_port_usb_vid_pid(const struct sp_port *port, int *usb_vid, int *usb_pid);
+
+/**
+ * Get the USB manufacturer string of a USB serial adapter port.
+ *
+ * @param port Pointer to port structure.
+ *
+ * @return The port manufacturer string, or NULL if an invalid port is passed.
+ * The manufacturer string is part of the port structure and may not be used
+ * after the port structure has been freed.
+ *
+ * @since 0.2.0
+ */
+char *sp_get_port_usb_manufacturer(const struct sp_port *port);
+
+/**
+ * Get the USB product string of a USB serial adapter port.
+ *
+ * @param port Pointer to port structure.
+ *
+ * @return The port product string, or NULL if an invalid port is passed.
+ * The product string is part of the port structure and may not be used
+ * after the port structure has been freed.
+ *
+ * @since 0.2.0
+ */
+char *sp_get_port_usb_product(const struct sp_port *port);
+
+/**
+ * Get the USB serial number string of a USB serial adapter port.
+ *
+ * @param port Pointer to port structure.
+ *
+ * @return The port serial number, or NULL if an invalid port is passed.
+ * The serial number string is part of the port structure and may not be used
+ * after the port structure has been freed.
+ *
+ * @since 0.2.0
+ */
+char *sp_get_port_usb_serial(const struct sp_port *port);
+
+/**
+ * Get the MAC address of a Bluetooth serial adapter port.
+ *
+ * @param port Pointer to port structure.
+ *
+ * @return The port MAC address, or NULL if an invalid port is passed.
+ * The MAC address string is part of the port structure and may not be used
+ * after the port structure has been freed.
+ *
+ * @since 0.2.0
+ */
+char *sp_get_port_bluetooth_address(const struct sp_port *port);
+
/**
* Get the operating system handle for a 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);
* @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);
* Free a port configuration structure.
*
* @param config Pointer to configuration structure.
+ *
+ * @since 0.1.0
*/
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);
* 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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* 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);
* @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);
* 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);
* @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);
* @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);
* @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);
* @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);
* @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);
* 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);
* @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 handles Event set to wait on.
+ * @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);
* the sp_signal enum.
*
* @param port Pointer to port structure.
- * @param signals Pointer to variable to receive result.
+ * @param signal_mask 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);
+enum sp_return sp_get_signals(struct sp_port *port, enum sp_signal *signal_mask);
/**
* Put the port transmit line into the break state.
* @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);
* @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);
*
* @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);
* @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);
* 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, ...));
* 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
projects / libserialport.git / blobdiff