X-Git-Url: http://sigrok.org/gitweb/?p=libserialport.git;a=blobdiff_plain;f=libserialport.h.in;h=c37c1cacc24d8e8f9735367b12c7da7665cf7f8e;hp=ff2aaac75bb7b4a01d51f3d86c97bf3646a4e218;hb=5f64c28551d7ee7dbecf5215cb75d63c3cf8303b;hpb=e3dcf9068e8b0e5d6b21a0203bfa963a8e0711d2 diff --git a/libserialport.h.in b/libserialport.h.in index ff2aaac..c37c1ca 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. @@ -73,7 +74,7 @@ * * Calls that succeed return @ref SP_OK, which is equal to zero. Some functions * declared @ref sp_return can also return a positive value for a successful - * numeric result, e.g. sp_read() and sp_write(). + * numeric result, e.g. sp_blocking_read() or sp_blocking_write(). */ #ifndef LIBSERIALPORT_LIBSERIALPORT_H @@ -84,21 +85,6 @@ extern "C" { #endif #include -#ifdef _WIN32 -#include -#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 { @@ -106,12 +92,12 @@ enum sp_return { SP_OK = 0, /** Invalid arguments were passed to the function. */ SP_ERR_ARG = -1, - /** A system error occured while executing the operation. */ + /** A system error occurred while executing the operation. */ SP_ERR_FAIL = -2, /** 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. */ @@ -120,6 +106,18 @@ enum sp_mode { SP_MODE_READ = 1, /** Open port for write access. */ SP_MODE_WRITE = 2, + /** Open port for read and write access. @since 0.1.1 */ + SP_MODE_READ_WRITE = 3 +}; + +/** 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 occurred. */ + SP_EVENT_ERROR = 4 }; /** Buffer selection. */ @@ -129,7 +127,7 @@ enum sp_buffer { /** Output buffer. */ SP_BUF_OUTPUT = 2, /** Both buffers. */ - SP_BUF_BOTH = 3, + SP_BUF_BOTH = 3 }; /** Parity settings. */ @@ -145,7 +143,7 @@ enum sp_parity { /** Mark parity. */ SP_PARITY_MARK = 3, /** Space parity. */ - SP_PARITY_SPACE = 4, + SP_PARITY_SPACE = 4 }; /** RTS pin behaviour. */ @@ -157,7 +155,7 @@ enum sp_rts { /** RTS on. */ SP_RTS_ON = 1, /** RTS used for flow control. */ - SP_RTS_FLOW_CONTROL = 2, + SP_RTS_FLOW_CONTROL = 2 }; /** CTS pin behaviour. */ @@ -167,7 +165,7 @@ enum sp_cts { /** CTS ignored. */ SP_CTS_IGNORE = 0, /** CTS used for flow control. */ - SP_CTS_FLOW_CONTROL = 1, + SP_CTS_FLOW_CONTROL = 1 }; /** DTR pin behaviour. */ @@ -179,7 +177,7 @@ enum sp_dtr { /** DTR on. */ SP_DTR_ON = 1, /** DTR used for flow control. */ - SP_DTR_FLOW_CONTROL = 2, + SP_DTR_FLOW_CONTROL = 2 }; /** DSR pin behaviour. */ @@ -189,7 +187,7 @@ enum sp_dsr { /** 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. */ @@ -203,7 +201,7 @@ enum sp_xonxoff { /** 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. */ @@ -215,7 +213,7 @@ enum sp_flowcontrol { /** 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. */ @@ -227,19 +225,55 @@ enum sp_signal { /** Data carrier detect. */ SP_SIG_DCD = 4, /** Ring indicator. */ - SP_SIG_RI = 8, + SP_SIG_RI = 8 }; -/** A serial port. */ +/** + * Transport types. + * + * @since 0.1.1 + */ +enum sp_transport { + /** Native platform serial port. @since 0.1.1 */ + SP_TRANSPORT_NATIVE, + /** USB serial port adapter. @since 0.1.1 */ + SP_TRANSPORT_USB, + /** Bluetooth serial port adapter. @since 0.1.1 */ + SP_TRANSPORT_BLUETOOTH +}; + +/** + * @struct sp_port + * An opaque structure representing a serial port. + */ struct sp_port; -/** Configuration for a serial port. */ +/** + * @struct sp_port_config + * An opaque structure representing the configuration for a serial port. + */ struct sp_port_config; /** -@defgroup Enumeration Port enumeration -@{ -*/ + * @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 + * + * Enumerating the serial ports of a system. + * + * @{ + */ /** * Obtain a pointer to a new sp_port structure representing the named port. @@ -249,15 +283,23 @@ struct sp_port_config; * * The result should be freed after use by calling sp_free_port(). * - * If any error is returned, the variable pointed to by port_ptr will be set - * to NULL. Otherwise, it will be set to point to the newly allocated port. + * @param[in] portname The OS-specific name of a serial port. Must not be NULL. + * @param[out] port_ptr If any error is returned, the variable pointed to by + * port_ptr will be set to NULL. Otherwise, it will be set + * to point to the newly allocated port. Must not be NULL. * * @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(). + * + * @param[in] port Pointer to a port structure. Must not be NULL. + * + * @since 0.1.0 */ void sp_free_port(struct sp_port *port); @@ -272,25 +314,32 @@ void sp_free_port(struct sp_port *port); * If a port from the list is to be used after freeing the list, it must be * copied first using sp_copy_port(). * - * If any error is returned, the variable pointed to by list_ptr will be set - * to NULL. Otherwise, it will be set to point to the newly allocated array. + * @param[out] list_ptr If any error is returned, the variable pointed to by + * list_ptr will be set to NULL. Otherwise, it will be set + * to point to the newly allocated array. Must not be NULL. * * @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); /** - * Make a new copy of a sp_port structure. + * Make a new copy of an sp_port structure. * * The user should allocate a variable of type "struct sp_port *" and pass a * pointer to this to receive the result. * * The copy should be freed after use by calling sp_free_port(). * - * If any error is returned, the variable pointed to by copy_ptr will be set - * to NULL. Otherwise, it will be set to point to the newly allocated copy. + * @param[in] port Pointer to a port structure. Must not be NULL. + * @param[out] copy_ptr If any error is returned, the variable pointed to by + * copy_ptr will be set to NULL. Otherwise, it will be set + * to point to the newly allocated copy. Must not be NULL. * * @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); @@ -299,29 +348,42 @@ 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(). + * + * @param[in] ports Pointer to a list of port structures. Must not be NULL. + * + * @since 0.1.0 */ void sp_free_port_list(struct sp_port **ports); /** * @} - * @defgroup Ports Opening, closing and querying ports + * @defgroup Ports Port handling + * + * Opening, closing and querying ports. + * * @{ */ /** * Open the specified serial port. * - * @param port Pointer to port structure. - * @param flags Flags to use when opening the serial port. + * @param[in] port Pointer to a port structure. Must not be NULL. + * @param[in] 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. * + * @param[in] port Pointer to a port structure. Must not be NULL. + * * @return SP_OK upon success, a negative error code otherwise. + * + * @since 0.1.0 */ enum sp_return sp_close(struct sp_port *port); @@ -332,14 +394,121 @@ enum sp_return sp_close(struct sp_port *port); * current operating system; e.g. for Windows it will usually be a "COMn" * device name, and for Unix it will be a device path beginning with "/dev/". * - * @param port Pointer to port structure. + * @param[in] port Pointer to a port structure. Must not be NULL. * * @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. + * 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[in] port Pointer to a port structure. Must not be NULL. + * + * @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.1.1 + */ +char *sp_get_port_description(const struct sp_port *port); + +/** + * Get the transport type used by a port. + * + * @param[in] port Pointer to a port structure. Must not be NULL. + * + * @return The port transport type. + * + * @since 0.1.1 + */ +enum sp_transport sp_get_port_transport(const struct sp_port *port); + +/** + * Get the USB bus number and address on bus of a USB serial adapter port. + * + * @param[in] port Pointer to a port structure. Must not be NULL. + * @param[out] usb_bus Pointer to a variable to store the USB bus. Must not be NULL. + * @param[out] usb_address Pointer to a variable to store the USB address. Must not be NULL. + * + * @return SP_OK upon success, a negative error code otherwise. + * + * @since 0.1.1 + */ +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[in] port Pointer to a port structure. Must not be NULL. + * @param[out] usb_vid Pointer to a variable to store the USB VID. + * Can be NULL (in that case it will be ignored). + * @param[out] usb_pid Pointer to a variable to store the USB PID. + * Can be NULL (in that case it will be ignored). + * + * @return SP_OK upon success, a negative error code otherwise. + * + * @since 0.1.1 + */ +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[in] port Pointer to a port structure. Must not be NULL. + * + * @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.1.1 + */ +char *sp_get_port_usb_manufacturer(const struct sp_port *port); + +/** + * Get the USB product string of a USB serial adapter port. + * + * @param[in] port Pointer to a port structure. Must not be NULL. + * + * @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.1.1 + */ +char *sp_get_port_usb_product(const struct sp_port *port); + +/** + * Get the USB serial number string of a USB serial adapter port. + * + * @param[in] port Pointer to a port structure. Must not be NULL. + * + * @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.1.1 + */ +char *sp_get_port_usb_serial(const struct sp_port *port); + +/** + * Get the MAC address of a Bluetooth serial adapter port. + * + * @param[in] port Pointer to a port structure. Must not be NULL. + * + * @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.1.1 + */ +char *sp_get_port_bluetooth_address(const struct sp_port *port); + /** * Get the operating system handle for a port. * @@ -360,13 +529,23 @@ char *sp_get_port_name(const struct sp_port *port); * that direct usage of the OS handle will not conflict with the * library's own usage of the port. Be careful. * + * @param[in] port Pointer to a port structure. Must not be NULL. + * @param[out] result_ptr If any error is returned, the variable pointed to by + * result_ptr will be set to NULL. Otherwise, it will + * be set to point to the OS handle. Must not be NULL. + * * @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); /** * @} - * @defgroup Configuration Setting port parameters + * + * @defgroup Configuration Configuration + * + * Setting and querying serial port parameters. * @{ */ @@ -383,16 +562,21 @@ enum sp_return sp_get_port_handle(const struct sp_port *port, void *result_ptr); * * The structure should be freed after use by calling sp_free_config(). * - * @param config_ptr Pointer to variable to receive result. + * @param[out] config_ptr Pointer to a variable to receive the result. + * Must not be NULL. * * @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. + * @param[in] config Pointer to a configuration structure. Must not be NULL. + * + * @since 0.1.0 */ void sp_free_config(struct sp_port_config *config); @@ -407,7 +591,13 @@ void sp_free_config(struct sp_port_config *config); * supported by libserialport, will be set to special values that are * ignored by sp_set_config(). * + * @param[in] port Pointer to a port structure. Must not be NULL. + * @param[out] config Pointer to a configuration structure that will hold + * the result. Must not be NULL. + * * @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); @@ -418,304 +608,363 @@ enum sp_return sp_get_config(struct sp_port *port, struct sp_port_config *config * -1, but see the documentation for each field). These values will be ignored * and the corresponding setting left unchanged on the port. * + * @param[in] port Pointer to a port structure. Must not be NULL. + * @param[in] config Pointer to a configuration structure. Must not be NULL. + * * @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); /** * Set the baud rate for the specified serial port. * - * @param port Pointer to port structure. - * @param baudrate Baud rate in bits per second. + * @param[in] port Pointer to a port structure. Must not be NULL. + * @param[in] 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); /** * Get the baud rate from a port configuration. * - * The user should allocate a variable of type int and pass a pointer to this - * to receive the result. + * The user should allocate a variable of type int and + * pass a pointer to this to receive the result. * - * @param config Pointer to configuration structure. - * @param baudrate_ptr Pointer to variable to store result. + * @param[in] config Pointer to a configuration structure. Must not be NULL. + * @param[out] baudrate_ptr Pointer to a variable to store the result. Must not be NULL. * * @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); /** * Set the baud rate in a port configuration. * - * @param config Pointer to configuration structure. - * @param baudrate Baud rate in bits per second, or -1 to retain current setting. + * @param[in] config Pointer to a configuration structure. Must not be NULL. + * @param[in] baudrate Baud rate in bits per second, or -1 to retain the 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); /** * Set the data bits for the specified serial port. * - * @param port Pointer to port structure. - * @param bits Number of data bits. + * @param[in] port Pointer to a port structure. Must not be NULL. + * @param[in] 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); /** * Get the data bits from a port configuration. * - * The user should allocate a variable of type int and pass a pointer to this - * to receive the result. + * The user should allocate a variable of type int and + * pass a pointer to this to receive the result. * - * @param config Pointer to configuration structure. - * @param bits_ptr Pointer to variable to store result. + * @param[in] config Pointer to a configuration structure. Must not be NULL. + * @param[out] bits_ptr Pointer to a variable to store the result. Must not be NULL. * * @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); /** * Set the data bits in a port configuration. * - * @param config Pointer to configuration structure. - * @param bits Number of data bits, or -1 to retain current setting. + * @param[in] config Pointer to a configuration structure. Must not be NULL. + * @param[in] bits Number of data bits, or -1 to retain the 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); /** * Set the parity setting for the specified serial port. * - * @param port Pointer to port structure. - * @param parity Parity setting. + * @param[in] port Pointer to a port structure. Must not be NULL. + * @param[in] 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); /** * Get the parity setting from a port configuration. * - * The user should allocate a variable of type enum sp_parity and pass a pointer to this - * to receive the result. + * The user should allocate a variable of type enum sp_parity and + * pass a pointer to this to receive the result. * - * @param config Pointer to configuration structure. - * @param parity_ptr Pointer to variable to store result. + * @param[in] config Pointer to a configuration structure. Must not be NULL. + * @param[out] parity_ptr Pointer to a variable to store the result. Must not be NULL. * * @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); /** * Set the parity setting in a port configuration. * - * @param config Pointer to configuration structure. - * @param parity Parity setting, or -1 to retain current setting. + * @param[in] config Pointer to a configuration structure. Must not be NULL. + * @param[in] parity Parity setting, or -1 to retain the 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); /** * Set the stop bits for the specified serial port. * - * @param port Pointer to port structure. - * @param stopbits Number of stop bits. + * @param[in] port Pointer to a port structure. Must not be NULL. + * @param[in] 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); /** * Get the stop bits from a port configuration. * - * The user should allocate a variable of type int and pass a pointer to this - * to receive the result. + * The user should allocate a variable of type int and + * pass a pointer to this to receive the result. * - * @param config Pointer to configuration structure. - * @param stopbits_ptr Pointer to variable to store result. + * @param[in] config Pointer to a configuration structure. Must not be NULL. + * @param[out] stopbits_ptr Pointer to a variable to store the result. Must not be NULL. * * @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); /** * Set the stop bits in a port configuration. * - * @param config Pointer to configuration structure. - * @param stopbits Number of stop bits, or -1 to retain current setting. + * @param[in] config Pointer to a configuration structure. Must not be NULL. + * @param[in] stopbits Number of stop bits, or -1 to retain the 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); /** * Set the RTS pin behaviour for the specified serial port. * - * @param port Pointer to port structure. - * @param rts RTS pin mode. + * @param[in] port Pointer to a port structure. Must not be NULL. + * @param[in] 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); /** * Get the RTS pin behaviour from a port configuration. * - * The user should allocate a variable of type enum sp_rts and pass a pointer to this - * to receive the result. + * The user should allocate a variable of type enum sp_rts and + * pass a pointer to this to receive the result. * - * @param config Pointer to configuration structure. - * @param rts_ptr Pointer to variable to store result. + * @param[in] config Pointer to a configuration structure. Must not be NULL. + * @param[out] rts_ptr Pointer to a variable to store the result. Must not be NULL. * * @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); /** * Set the RTS pin behaviour in a port configuration. * - * @param config Pointer to configuration structure. - * @param rts RTS pin mode, or -1 to retain current setting. + * @param[in] config Pointer to a configuration structure. Must not be NULL. + * @param[in] rts RTS pin mode, or -1 to retain the 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); /** * Set the CTS pin behaviour for the specified serial port. * - * @param port Pointer to port structure. - * @param cts CTS pin mode. + * @param[in] port Pointer to a port structure. Must not be NULL. + * @param[in] 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); /** * Get the CTS pin behaviour from a port configuration. * - * The user should allocate a variable of type enum sp_cts and pass a pointer to this - * to receive the result. + * The user should allocate a variable of type enum sp_cts and + * pass a pointer to this to receive the result. * - * @param config Pointer to configuration structure. - * @param cts_ptr Pointer to variable to store result. + * @param[in] config Pointer to a configuration structure. Must not be NULL. + * @param[out] cts_ptr Pointer to a variable to store the result. Must not be NULL. * * @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); /** * Set the CTS pin behaviour in a port configuration. * - * @param config Pointer to configuration structure. - * @param cts CTS pin mode, or -1 to retain current setting. + * @param[in] config Pointer to a configuration structure. Must not be NULL. + * @param[in] cts CTS pin mode, or -1 to retain the 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); /** * Set the DTR pin behaviour for the specified serial port. * - * @param port Pointer to port structure. - * @param dtr DTR pin mode. + * @param[in] port Pointer to a port structure. Must not be NULL. + * @param[in] 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); /** * Get the DTR pin behaviour from a port configuration. * - * The user should allocate a variable of type enum sp_dtr and pass a pointer to this - * to receive the result. + * The user should allocate a variable of type enum sp_dtr and + * pass a pointer to this to receive the result. * - * @param config Pointer to configuration structure. - * @param dtr_ptr Pointer to variable to store result. + * @param[in] config Pointer to a configuration structure. Must not be NULL. + * @param[out] dtr_ptr Pointer to a variable to store the result. Must not be NULL. * * @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); /** * Set the DTR pin behaviour in a port configuration. * - * @param config Pointer to configuration structure. - * @param dtr DTR pin mode, or -1 to retain current setting. + * @param[in] config Pointer to a configuration structure. Must not be NULL. + * @param[in] dtr DTR pin mode, or -1 to retain the 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); /** * Set the DSR pin behaviour for the specified serial port. * - * @param port Pointer to port structure. - * @param dsr DSR pin mode. + * @param[in] port Pointer to a port structure. Must not be NULL. + * @param[in] 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); /** * Get the DSR pin behaviour from a port configuration. * - * The user should allocate a variable of type enum sp_dsr and pass a pointer to this - * to receive the result. + * The user should allocate a variable of type enum sp_dsr and + * pass a pointer to this to receive the result. * - * @param config Pointer to configuration structure. - * @param dsr_ptr Pointer to variable to store result. + * @param[in] config Pointer to a configuration structure. Must not be NULL. + * @param[out] dsr_ptr Pointer to a variable to store the result. Must not be NULL. * * @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); /** * Set the DSR pin behaviour in a port configuration. * - * @param config Pointer to configuration structure. - * @param dsr DSR pin mode, or -1 to retain current setting. + * @param[in] config Pointer to a configuration structure. Must not be NULL. + * @param[in] dsr DSR pin mode, or -1 to retain the 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); /** * Set the XON/XOFF configuration for the specified serial port. * - * @param port Pointer to port structure. - * @param xon_xoff XON/XOFF mode. + * @param[in] port Pointer to a port structure. Must not be NULL. + * @param[in] 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); /** * Get the XON/XOFF configuration from a port configuration. * - * The user should allocate a variable of type enum sp_xonxoff and pass a pointer to this - * to receive the result. + * The user should allocate a variable of type enum sp_xonxoff and + * pass a pointer to this to receive the result. * - * @param config Pointer to configuration structure. - * @param xon_xoff_ptr Pointer to variable to store result. + * @param[in] config Pointer to a configuration structure. Must not be NULL. + * @param[out] xon_xoff_ptr Pointer to a variable to store the result. Must not be NULL. * * @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); /** * Set the XON/XOFF configuration in a port configuration. * - * @param config Pointer to configuration structure. - * @param xon_xoff XON/XOFF mode, or -1 to retain current setting. + * @param[in] config Pointer to a configuration structure. Must not be NULL. + * @param[in] xon_xoff XON/XOFF mode, or -1 to retain the 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); @@ -727,10 +976,12 @@ enum sp_return sp_set_config_xon_xoff(struct sp_port_config *config, enum sp_xon * type. For more fine-grained control of these settings, use their * individual configuration functions. * - * @param config Pointer to configuration structure. - * @param flowcontrol Flow control setting to use. + * @param[in] config Pointer to a configuration structure. Must not be NULL. + * @param[in] 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); @@ -742,45 +993,65 @@ enum sp_return sp_set_config_flowcontrol(struct sp_port_config *config, enum sp_ * type. For more fine-grained control of these settings, use their * individual configuration functions. * - * @param port Pointer to port structure. - * @param flowcontrol Flow control setting to use. + * @param[in] port Pointer to a port structure. Must not be NULL. + * @param[in] 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); /** * @} - * @defgroup Data Reading, writing, and flushing data + * + * @defgroup Data Data handling + * + * Reading, writing, and flushing data. + * * @{ -*/ + */ /** - * Read bytes from the specified serial port, blocking until available. - * - * @param port Pointer to port structure. - * @param buf Buffer in which to store the bytes read. - * @param count Requested number of bytes to read. - * @param timeout Timeout in milliseconds, or zero to wait indefinitely. + * Read bytes from the specified serial port, blocking until complete. + * + * @warning If your program runs on Unix, defines its own signal handlers, and + * needs to abort blocking reads when these are called, then you + * should not use this function. It repeats system calls that return + * with EINTR. To be able to abort a read from a signal handler, you + * should implement your own blocking read using sp_nonblocking_read() + * together with a blocking method that makes sense for your program. + * E.g. you can obtain the file descriptor for an open port using + * sp_get_port_handle() and use this to call select() or pselect(), + * with appropriate arrangements to return if a signal is received. + * + * @param[in] port Pointer to a port structure. Must not be NULL. + * @param[out] buf Buffer in which to store the bytes read. Must not be NULL. + * @param[in] count Requested number of bytes to read. + * @param[in] timeout_ms Timeout in milliseconds, or zero to wait indefinitely. * * @return The number of bytes read on success, or a negative error code. If * the number of bytes returned is less than that requested, the * 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); +enum sp_return sp_blocking_read(struct sp_port *port, void *buf, size_t count, unsigned int timeout_ms); /** * Read bytes from the specified serial port, without blocking. * - * @param port Pointer to port structure. - * @param buf Buffer in which to store the bytes read. - * @param count Maximum number of bytes to read. + * @param[in] port Pointer to a port structure. Must not be NULL. + * @param[out] buf Buffer in which to store the bytes read. Must not be NULL. + * @param[in] count Maximum number of bytes to read. * * @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); @@ -793,20 +1064,32 @@ enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf, size_t count * been transmitted, use the sp_output_waiting() function. To wait until all * written bytes have actually been transmitted, use the sp_drain() function. * - * @param port Pointer to port structure. - * @param buf Buffer containing the bytes to write. - * @param count Requested number of bytes to write. - * @param timeout Timeout in milliseconds, or zero to wait indefinitely. + * @warning If your program runs on Unix, defines its own signal handlers, and + * needs to abort blocking writes when these are called, then you + * should not use this function. It repeats system calls that return + * with EINTR. To be able to abort a write from a signal handler, you + * should implement your own blocking write using sp_nonblocking_write() + * together with a blocking method that makes sense for your program. + * E.g. you can obtain the file descriptor for an open port using + * sp_get_port_handle() and use this to call select() or pselect(), + * with appropriate arrangements to return if a signal is received. + * + * @param[in] port Pointer to a port structure. Must not be NULL. + * @param[in] buf Buffer containing the bytes to write. Must not be NULL. + * @param[in] count Requested number of bytes to write. + * @param[in] timeout_ms Timeout in milliseconds, or zero to wait indefinitely. * - * @return The number of bytes read on success, or a negative error code. If - * the number of bytes returned is less than that requested, the + * @return The number of bytes written on success, or a negative error code. + * If the number of bytes returned is less than that requested, the * timeout was reached before the requested number of bytes was - * sent. If timeout is zero, the function will always return + * written. If timeout is zero, the function will always return * 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. + * were sent before the error occurred. + * + * @since 0.1.0 */ -enum sp_return sp_blocking_write(struct sp_port *port, const void *buf, size_t count, unsigned int timeout); +enum sp_return sp_blocking_write(struct sp_port *port, const void *buf, size_t count, unsigned int timeout_ms); /** * Write bytes to the specified serial port, without blocking. @@ -817,38 +1100,146 @@ enum sp_return sp_blocking_write(struct sp_port *port, const void *buf, size_t c * been transmitted, use the sp_output_waiting() function. To wait until all * written bytes have actually been transmitted, use the sp_drain() function. * - * @param port Pointer to port structure. - * @param buf Buffer containing the bytes to write. - * @param count Maximum number of bytes to write. + * @param[in] port Pointer to a port structure. Must not be NULL. + * @param[in] buf Buffer containing the bytes to write. Must not be NULL. + * @param[in] count Maximum number of bytes to write. * * @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); +/** + * Gets the number of bytes waiting in the input buffer. + * + * @param[in] port Pointer to a port structure. Must not be NULL. + * + * @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); + +/** + * Gets the number of bytes waiting in the output buffer. + * + * @param[in] port Pointer to a port structure. Must not be NULL. + * + * @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); + /** * Flush serial port buffers. Data in the selected buffer(s) is discarded. * - * @param port Pointer to port structure. - * @param buffers Which buffer(s) to flush. + * @param[in] port Pointer to a port structure. Must not be NULL. + * @param[in] 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); /** * Wait for buffered data to be transmitted. * - * @param port Pointer to port structure. + * @warning If your program runs on Unix, defines its own signal handlers, and + * needs to abort draining the output buffer when when these are + * called, then you should not use this function. It repeats system + * calls that return with EINTR. To be able to abort a drain from a + * signal handler, you would need to implement your own blocking + * drain by polling the result of sp_output_waiting(). + * + * @param[in] port Pointer to a port structure. Must not be NULL. * * @return SP_OK upon success, a negative error code otherwise. + * + * @since 0.1.0 */ enum sp_return sp_drain(struct sp_port *port); /** * @} - * @defgroup Signals Port signalling operations + * + * @defgroup Waiting Waiting + * + * Waiting for events and timeout handling. + * + * @{ + */ + +/** + * 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(). + * + * @param[out] result_ptr If any error is returned, the variable pointed to by + * result_ptr will be set to NULL. Otherwise, it will + * be set to point to the event set. Must not be NULL. + * + * @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[in,out] event_set Event set to update. Must not be NULL. + * @param[in] port Pointer to a port structure. Must not be NULL. + * @param[in] 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[in] event_set Event set to wait on. Must not be NULL. + * @param[in] timeout_ms 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_ms); + +/** + * Free a structure allocated by sp_new_event_set(). + * + * @param[in] event_set Event set to free. Must not be NULL. + * + * @since 0.1.0 + */ +void sp_free_event_set(struct sp_event_set *event_set); + +/** + * @} + * + * @defgroup Signals Signals + * + * Port signalling operations. + * * @{ */ @@ -860,36 +1251,47 @@ enum sp_return sp_drain(struct sp_port *port); * in which individual signals can be checked by bitwise OR with values of * the sp_signal enum. * - * @param port Pointer to port structure. - * @param signals Pointer to variable to receive result. + * @param[in] port Pointer to a port structure. Must not be NULL. + * @param[out] signal_mask Pointer to a variable to receive the result. + * Must not be NULL. * * @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. + * @param[in] port Pointer to a port structure. Must not be NULL. * * @return SP_OK upon success, a negative error code otherwise. + * + * @since 0.1.0 */ enum sp_return sp_start_break(struct sp_port *port); /** * Take the port transmit line out of the break state. * - * @param port Pointer to port structure. + * @param[in] port Pointer to a port structure. Must not be NULL. * * @return SP_OK upon success, a negative error code otherwise. + * + * @since 0.1.0 */ enum sp_return sp_end_break(struct sp_port *port); /** * @} - * @defgroup Errors Obtaining error information + * + * @defgroup Errors Errors + * + * Obtaining error information. + * * @{ -*/ + */ /** * Get the error code for a failed operation. @@ -899,6 +1301,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); @@ -911,11 +1315,17 @@ 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(). + * + * @param[in] message The error message string to free. Must not be NULL. + * + * @since 0.1.0 */ void sp_free_error_message(char *message); @@ -930,6 +1340,11 @@ 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(). + * + * @param[in] handler The handler function to use. Can be NULL (in that case + * all debug messages will be ignored). + * + * @since 0.1.0 */ void sp_set_debug_handler(void (*handler)(const char *format, ...)); @@ -939,11 +1354,144 @@ 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. + * + * @param[in] format The format string to use. Must not be NULL. + * @param[in] ... The variable length argument list to use. + * + * @since 0.1.0 */ void sp_default_debug_handler(const char *format, ...); /** @} */ +/** + * @defgroup Versions 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