The operations that are supported are:
-- Port enumeration (obtaining a list of serial ports on the system).
-- Opening and closing ports.
-- Setting port parameters (baud rate, parity, etc).
-- Reading, writing and flushing data.
-- Obtaining error information.
+- \ref Enumeration (obtaining a list of serial ports on the system).
+- \ref Ports
+- \ref Configuration (baud rate, parity, etc)
+- \ref Data
+- \ref Errors
libserialport is an open source project released under the LGPL3+ license.
-API
-===
+API principles
+==============
The API is simple, and designed to be a minimal wrapper around the serial port
support in each OS.
Most functions take a pointer to a struct sp_port, which represents a serial
-port. These structures are always allocated and freed by the library.
+port. These structures are always allocated and freed by the library, using
+the functions in the \ref Enumeration "Enumeration" section.
All functions can return only three possible error values. SP_ERR_ARG indicates
the function was called with invalid arguments. SP_ERR_FAIL indicates that the
#define SP_LIB_VERSION_AGE @SP_LIB_VERSION_AGE@
#define SP_LIB_VERSION_STRING "@SP_LIB_VERSION@"
-/** A serial port. */
-struct sp_port {
- /** Name used to open the port */
- char *name;
-/** \cond 0 */
- /* OS-specific port handle */
-#ifdef _WIN32
- HANDLE hdl;
-#else
- int fd;
-#endif
-/** \endcond */
-};
-
-/** 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. */
- int parity;
- /** Number of stop bits to use (1 or 2). */
- int stopbits;
- /** RTS pin mode. */
- int rts;
- /** CTS pin mode. */
- int cts;
- /** DTR pin mode. */
- int dtr;
- /** DSR pin mode. */
- int dsr;
- /** XON/XOFF flow control mode. */
- int xon_xoff;
-};
-
-
/** Return values. */
-enum {
+enum sp_return {
/** Operation completed successfully. */
SP_OK = 0,
/** Invalid arguments were passed to the function. */
};
/** Port access modes. */
-enum {
+enum sp_mode {
/** Open port for read/write access. */
SP_MODE_RDWR = 1,
/** Open port for read access only. */
};
/** Parity settings. */
-enum {
+enum sp_parity {
+ /** Special value to indicate setting should be left alone. */
+ SP_PARITY_INVALID = -1,
/** No parity. */
SP_PARITY_NONE = 0,
/** Even parity. */
};
/** RTS pin behaviour. */
-enum {
+enum sp_rts {
+ /** Special value to indicate setting should be left alone. */
+ SP_RTS_INVALID = -1,
/** RTS off. */
SP_RTS_OFF = 0,
/** RTS on. */
};
/** CTS pin behaviour. */
-enum {
+enum sp_cts {
+ /** Special value to indicate setting should be left alone. */
+ SP_CTS_INVALID = -1,
/** CTS ignored. */
SP_CTS_IGNORE = 0,
/** CTS used for flow control. */
};
/** DTR pin behaviour. */
-enum {
+enum sp_dtr {
+ /** Special value to indicate setting should be left alone. */
+ SP_DTR_INVALID = -1,
/** DTR off. */
SP_DTR_OFF = 0,
/** DTR on. */
};
/** DSR pin behaviour. */
-enum {
+enum sp_dsr {
+ /** Special value to indicate setting should be left alone. */
+ SP_DSR_INVALID = -1,
/** DSR ignored. */
SP_DSR_IGNORE = 0,
/** DSR used for flow control. */
};
/** XON/XOFF flow control behaviour. */
-enum {
+enum sp_xonxoff {
+ /** Special value to indicate setting should be left alone. */
+ SP_XONXOFF_INVALID = -1,
/** XON/XOFF disabled. */
SP_XONXOFF_DISABLED = 0,
/** XON/XOFF enabled for input only. */
};
/** Standard flow control combinations. */
-enum {
+enum sp_flowcontrol {
/** No flow control. */
SP_FLOWCONTROL_NONE = 0,
/** Software flow control using XON/XOFF characters. */
SP_FLOWCONTROL_DTRDSR = 3
};
+/** A serial port. */
+struct sp_port {
+ /** Name used to open the port */
+ char *name;
+/** \cond 0 */
+ /* OS-specific port handle */
+#ifdef _WIN32
+ HANDLE hdl;
+#else
+ int fd;
+#endif
+/** \endcond */
+};
+
+/** 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;
+};
+
+/**
+\defgroup Enumeration Port enumeration
+@{
+*/
+
/**
Obtains a pointer to a new sp_port structure representing the named port. The
user should allocate a variable of type "struct sp_port *" and pass a pointer
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.
*/
-int sp_get_port_by_name(const char *portname, struct sp_port **port_ptr);
+enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_ptr);
/**
Frees a port structure obtained from sp_get_port_by_name() or sp_copy_port().
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.
*/
-int sp_list_ports(struct sp_port ***list_ptr);
+enum sp_return sp_list_ports(struct sp_port ***list_ptr);
/**
Makes a new copy of a sp_port structure. The user should allocate a variable
the variable pointed to by copy_ptr will be set to NULL. Otherwise,
it will be set to point to the newly allocated copy.
*/
-int sp_copy_port(const struct sp_port *port, struct sp_port **copy_ptr);
+enum sp_return sp_copy_port(const struct sp_port *port, struct sp_port **copy_ptr);
/**
Frees a port list obtained from sp_list_ports(). This will also free all
*/
void sp_free_port_list(struct sp_port **ports);
+/**
+ @}
+\defgroup Ports Opening & closing ports
+@{
+*/
+
/**
Opens the specified serial port.
@param port Pointer to port structure.
- @param flags Flags to use when opening the serial port. Possible
- flags are: SP_MODE_RDWR, SP_MODE_RDONLY, and
- SP_MODE_NONBLOCK.
+ @param flags Flags to use when opening the serial port.
@return SP_OK on success, SP_ERR_FAIL on failure, SP_ERR_MEM on allocation
failure, or SP_ERR_ARG if an invalid port is passed.
*/
-int sp_open(struct sp_port *port, int flags);
+enum sp_return sp_open(struct sp_port *port, enum sp_mode flags);
/**
Closes the specified serial port.
@return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
if an invalid port is passed.
*/
-int sp_close(struct sp_port *port);
+enum sp_return sp_close(struct sp_port *port);
/**
- Reads bytes from the specified serial port. 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 Maximum number of bytes to read.
-
- @return The number of bytes read, SP_ERR_FAIL on failure,
- or SP_ERR_ARG for invalid arguments.
+ @}
+\defgroup Configuration Setting port parameters
+@{
*/
-int sp_read(struct sp_port *port, void *buf, size_t count);
-
-/**
- Write bytes to the specified serial port. 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 Maximum number of bytes to write.
-
- @return The number of bytes written, SP_ERR_FAIL on failure,
- or SP_ERR_ARG for invalid arguments.
-*/
-int sp_write(struct sp_port *port, const void *buf, size_t count);
-
-/**
- Flushes serial port buffers.
-
- @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
- if an invalid port is passed.
-*/
-int sp_flush(struct sp_port *port);
/**
Gets current configuration of the specified serial port.
as the config parameter. The struct will be populated 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.
+
@return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
for invalid arguments.
*/
-int sp_get_config(struct sp_port *port, struct sp_port_config *config);
+enum sp_return sp_get_config(struct sp_port *port, struct sp_port_config *config);
/**
- Sets all parameters for the specified serial port.
+ Sets 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 the field to to a
- negative value.
+ To retain the current value of any setting, set that field to -1.
@return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
for invalid arguments.
*/
-int sp_set_config(struct sp_port *port, const struct sp_port_config *config);
+enum sp_return sp_set_config(struct sp_port *port, const struct sp_port_config *config);
/**
Sets the baud rate for the specified serial port.
@return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
for invalid arguments.
*/
-int sp_set_baudrate(struct sp_port *port, int baudrate);
+enum sp_return sp_set_baudrate(struct sp_port *port, int baudrate);
/**
Sets the number of data bits for the specified serial port.
@return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
for invalid arguments.
*/
-int sp_set_bits(struct sp_port *port, int bits);
+enum sp_return sp_set_bits(struct sp_port *port, int bits);
/**
Sets the parity for the specified serial port.
@param port Pointer to port structure.
@param parity Parity setting to use.
- (SP_PARITY_NONE, SP_PARITY_EVEN or SP_PARITY_ODD)
@return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
for invalid arguments.
*/
-int sp_set_parity(struct sp_port *port, int parity);
+enum sp_return sp_set_parity(struct sp_port *port, enum sp_parity parity);
/**
Sets the number of stop bits for the specified port.
@return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
for invalid arguments.
*/
-int sp_set_stopbits(struct sp_port *port, int stopbits);
+enum sp_return sp_set_stopbits(struct sp_port *port, int stopbits);
/**
Sets the flow control type for the specified serial port.
individual configuration functions or the sp_set_config() function.
@param port Pointer to port structure.
- @param flowcontrol Flow control setting to use. Valid settings are:
-
- SP_FLOWCONTROL_NONE: No flow control.
- SP_FLOWCONTROL_XONXOFF: Software flow control using XON/XOFF characters.
- SP_FLOWCONTROL_RTSCTS: Hardware flow control using RTS/CTS signals.
- SP_FLOWCONTROL_DTRDSR: Hardware flow control using DTR/DSR signals.
+ @param flowcontrol Flow control setting to use.
@return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
for invalid arguments.
*/
-int sp_set_flowcontrol(struct sp_port *port, int flowcontrol);
+enum sp_return sp_set_flowcontrol(struct sp_port *port, enum sp_flowcontrol flowcontrol);
/**
Sets the RTS pin behaviour for the specified port.
@param port Pointer to port structure.
@param rts RTS pin mode.
- (SP_RTS_ON, SP_RTS_OFF or SP_RTS_FLOW_CONTROL)
@return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
for invalid arguments.
*/
-int sp_set_rts(struct sp_port *port, int rts);
+enum sp_return sp_set_rts(struct sp_port *port, enum sp_rts rts);
/**
Sets the CTS pin behaviour for the specified port.
@param port Pointer to port structure.
@param cts CTS pin mode.
- (SP_CTS_IGNORE or SP_CTS_FLOW_CONTROL)
@return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
for invalid arguments.
*/
-int sp_set_cts(struct sp_port *port, int cts);
+enum sp_return sp_set_cts(struct sp_port *port, enum sp_cts cts);
/**
Sets the DTR pin behaviour for the specified port.
@param port Pointer to port structure.
@param dtr DTR pin mode.
- (SP_DTR_ON, SP_DTR_OFF or SP_DTR_FLOW_CONTROL)
@return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
for invalid arguments.
*/
-int sp_set_dtr(struct sp_port *port, int dtr);
+enum sp_return sp_set_dtr(struct sp_port *port, enum sp_dtr dtr);
/**
Sets the RTS pin behaviour for the specified port.
@param port Pointer to port structure.
@param dsr DSR pin mode.
- (SP_DSR_IGNORE or SP_DSR_FLOW_CONTROL)
@return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
for invalid arguments.
*/
-int sp_set_dsr(struct sp_port *port, int dsr);
+enum sp_return sp_set_dsr(struct sp_port *port, enum sp_dsr dsr);
/**
Configures XON/XOFF flow control for the specified port.
@param port Pointer to port structure.
@param xon_xoff XON/XOFF flow control mode.
- (SP_XONXOFF_DISABLED, SP_XONXOFF_IN,
- SP_XONXOFF_OUT or SP_XONXOFF_INOUT)
@return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
for invalid arguments.
*/
-int sp_set_xon_xoff(struct sp_port *port, int xon_xoff);
+enum sp_return sp_set_xon_xoff(struct sp_port *port, enum sp_xonxoff xon_xoff);
+
+/**
+ @}
+\defgroup Data Reading, writing & flushing data
+@{
+*/
+
+/**
+ Reads bytes from the specified serial port. 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 Maximum number of bytes to read.
+
+ @return The number of bytes read, SP_ERR_FAIL on failure,
+ or SP_ERR_ARG for invalid arguments.
+*/
+enum sp_return sp_read(struct sp_port *port, void *buf, size_t count);
+
+/**
+ Write bytes to the specified serial port. 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 Maximum number of bytes to write.
+
+ @return The number of bytes written, SP_ERR_FAIL on failure,
+ or SP_ERR_ARG for invalid arguments.
+*/
+enum sp_return sp_write(struct sp_port *port, const void *buf, size_t count);
+
+/**
+ Flushes serial port buffers.
+
+ @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
+ if an invalid port is passed.
+*/
+enum sp_return sp_flush(struct sp_port *port);
+
+/**
+ @}
+\defgroup Errors Obtaining error information
+@{
+*/
/**
Gets the error code for a failed operation.
*/
void sp_free_error_message(char *message);
+/**
+ @}
+*/
+
#ifdef __cplusplus
}
#endif
projects / libserialport.git / blobdiff