X-Git-Url: http://sigrok.org/gitweb/?p=libserialport.git;a=blobdiff_plain;f=libserialport.h.in;h=51d9afe6c1449c5a57d69f33da1daffd329b7cd6;hp=2dab6a9ff65bfbce5f25b8af3330ebd261c6346e;hb=da8730199a215c9ccd938202fb55ac9e3f58a0b2;hpb=0151b15710ae685314c5f123e6796da606643f0c diff --git a/libserialport.h.in b/libserialport.h.in index 2dab6a9..51d9afe 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 @@ -88,18 +89,6 @@ extern "C" { #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 { /** Operation completed successfully. */ @@ -111,7 +100,7 @@ enum sp_return { /** 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. */ @@ -119,9 +108,17 @@ enum sp_mode { /** Open port for read access. */ SP_MODE_READ = 1, /** Open port for write access. */ - SP_MODE_WRITE = 2, - /** Open port in non-blocking mode. */ - SP_MODE_NONBLOCK = 4, + 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. */ @@ -131,7 +128,7 @@ enum sp_buffer { /** Output buffer. */ SP_BUF_OUTPUT = 2, /** Both buffers. */ - SP_BUF_BOTH = 3, + SP_BUF_BOTH = 3 }; /** Parity settings. */ @@ -144,6 +141,10 @@ enum sp_parity { SP_PARITY_ODD = 1, /** Even parity. */ SP_PARITY_EVEN = 2, + /** Mark parity. */ + SP_PARITY_MARK = 3, + /** Space parity. */ + SP_PARITY_SPACE = 4 }; /** RTS pin behaviour. */ @@ -155,7 +156,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. */ @@ -165,7 +166,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. */ @@ -177,7 +178,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. */ @@ -187,7 +188,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. */ @@ -201,7 +202,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. */ @@ -213,7 +214,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. */ @@ -225,32 +226,42 @@ enum sp_signal { /** 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 }; -/** A serial port. */ +/** + * @struct sp_port + * An opaque structure representing a serial port. + */ struct sp_port; -/** Configuration for a serial port. */ -struct sp_port_config { - /** Baud rate in bits per second. */ - int baudrate; - /** Number of data bits to use. Valid values are 5 to 8. */ - int bits; - /** Parity setting to use. */ - enum sp_parity parity; - /** Number of stop bits to use (1 or 2). */ - int stopbits; - /** RTS pin mode. */ - enum sp_rts rts; - /** CTS pin mode. */ - enum sp_cts cts; - /** DTR pin mode. */ - enum sp_dtr dtr; - /** DSR pin mode. */ - enum sp_dsr dsr; - /** XON/XOFF flow control mode. */ - enum sp_xonxoff xon_xoff; +/** + * @struct sp_port_config + * An opaque structure representing the configuration for a serial 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; }; /** @@ -270,11 +281,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); @@ -293,6 +308,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); @@ -308,6 +325,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); @@ -316,6 +335,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); @@ -332,6 +353,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); @@ -339,6 +362,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); @@ -354,9 +379,114 @@ 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. * @@ -378,6 +508,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); @@ -387,29 +519,63 @@ enum sp_return sp_get_port_handle(const struct sp_port *port, void *result_ptr); * @{ */ +/** + * Allocate a port configuration structure. + * + * The user should allocate a variable of type "struct sp_config *" and pass a + * pointer to this to receive the result. The variable will be updated to + * point to the new configuration structure. The structure is opaque and must + * be accessed via the functions provided. + * + * All parameters in the structure will be initialised to special values which + * are ignored by sp_set_config(). + * + * The structure should be freed after use by calling sp_free_config(). + * + * @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); + /** * Get the current configuration of the specified serial port. * - * The user should allocate a struct sp_port_config, then pass a pointer to it - * as the config parameter. The struct will be populated with the port - * configuration. + * The user should allocate a configuration structure using sp_new_config() + * and pass this as the config parameter. The configuration structure will + * be updated with the port configuration. * - * Any setting that is in a state not recognised or supported by - * libserialport will have its value set to -1 in the struct. + * Any parameters that are configured with settings not recognised or + * supported by libserialport, will be set to special values that are + * 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); /** * Set the configuration for the specified serial port. * - * The user should populate a struct sp_port_config, then pass a pointer to it - * as the config parameter. - * - * To retain the current value of any setting, set that field to -1. + * For each parameter in the configuration, there is a special value (usually + * -1, but see the documentation for each field). These values will be ignored + * 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); @@ -420,104 +586,384 @@ 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); /** - * Set the number of data bits for the specified serial port. + * 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. + * + * @param config Pointer to configuration structure. + * @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); + +/** + * 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. + * + * @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 to use. Valid values are 5 to 8. + * @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); /** - * Set the parity for the specified serial port. + * 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. + * + * @param config Pointer to configuration structure. + * @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); + +/** + * 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. + * + * @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 to use. + * @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); /** - * Set the number of stop bits for the specified port. + * 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. + * + * @param config Pointer to configuration structure. + * @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); + +/** + * Set the parity setting in a port configuration. + * + * @param config Pointer to configuration structure. + * @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); + +/** + * Set the stop bits for the specified serial port. * * @param port Pointer to port structure. - * @param stopbits Number of stop bits to use (1 or 2). + * @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); /** - * Set the flow control type for the specified serial port. + * Get the stop bits from a port configuration. * - * This function is a wrapper that sets the RTS, CTS, DTR, DSR and - * XON/XOFF settings as necessary for the specified flow control - * type. For more fine-grained control of these settings, use their - * individual configuration functions or the sp_set_config() function. + * The user should allocate a variable of type int and pass a pointer to this + * to receive the result. * - * @param port Pointer to port structure. - * @param flowcontrol Flow control setting to use. + * @param config Pointer to configuration structure. + * @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_set_flowcontrol(struct sp_port *port, enum sp_flowcontrol flowcontrol); +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. + * + * @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 port. + * Set the RTS pin behaviour for the specified serial port. * * @param port Pointer to port structure. * @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); /** - * Set the CTS pin behaviour for the specified port. + * 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. + * + * @param config Pointer to configuration structure. + * @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); + +/** + * 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. + * + * @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. * * @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); /** - * Set the DTR pin behaviour for the specified port. + * 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. + * + * @param config Pointer to configuration structure. + * @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); + +/** + * 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. + * + * @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. * * @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); /** - * Set the RTS pin behaviour for the specified port. + * 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. + * + * @param config Pointer to configuration structure. + * @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); + +/** + * 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. + * + * @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. * * @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); /** - * Configure XON/XOFF flow control for the specified port. + * 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. + * + * @param config Pointer to configuration structure. + * @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); + +/** + * 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. + * + * @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 flow control mode. + * @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); +/** + * 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. + * + * @param config Pointer to configuration structure. + * @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); + +/** + * 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. + * + * @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); + +/** + * Set the flow control type in a port configuration. + * + * This function is a wrapper that sets the RTS, CTS, DTR, DSR and + * XON/XOFF settings as necessary for the specified flow control + * 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. + * + * @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); + +/** + * Set the flow control type for the specified serial port. + * + * This function is a wrapper that sets the RTS, CTS, DTR, DSR and + * XON/XOFF settings as necessary for the specified flow control + * 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. + * + * @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 @@ -525,34 +971,126 @@ enum sp_return sp_set_xon_xoff(struct sp_port *port, enum sp_xonxoff xon_xoff); */ /** - * Read bytes from the specified serial port. + * 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. * - * Note that this function may return after reading less than the specified - * number of bytes; it is the user's responsibility to iterate as necessary - * in this case. + * @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. + * + * @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); + +/** + * 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. * - * @return The number of bytes read on success, or a negative error code. + * @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_read(struct sp_port *port, void *buf, size_t count); +enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf, size_t count); /** - * Write bytes to the specified serial port. + * Write bytes to the specified serial port, blocking until complete. + * + * Note that this function only ensures that the accepted bytes have been + * written to the OS; they may be held in driver or hardware buffers and not + * yet physically transmitted. To check whether all written bytes have actually + * been transmitted, use the sp_output_waiting() function. To wait until all + * written bytes have actually been transmitted, use the sp_drain() function. + * + * @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. * - * Note that this function may return after writing less than the specified - * number of bytes; it is the user's responsibility to iterate as necessary - * in this case. + * @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. + * + * @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 + * 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. + * + * @since 0.1.0 + */ +enum sp_return sp_blocking_write(struct sp_port *port, const void *buf, size_t count, unsigned int timeout); + +/** + * Write bytes to the specified serial port, without blocking. + * + * Note that this function only ensures that the accepted bytes have been + * written to the OS; they may be held in driver or hardware buffers and not + * yet physically transmitted. To check whether all written bytes have actually + * 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. * * @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_write(struct sp_port *port, const void *buf, size_t count); +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 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); + +/** + * Gets the number of bytes waiting in the output buffer. + * + * @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); /** * Flush serial port buffers. Data in the selected buffer(s) is discarded. @@ -561,18 +1099,88 @@ enum sp_return sp_write(struct sp_port *port, const void *buf, size_t count); * @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); /** * Wait for buffered data to be transmitted. * + * @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 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 @@ -588,11 +1196,13 @@ enum sp_return sp_drain(struct sp_port *port); * 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. @@ -600,6 +1210,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); @@ -609,6 +1221,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); @@ -626,6 +1240,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); @@ -638,11 +1254,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); @@ -657,6 +1277,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, ...)); @@ -666,11 +1288,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