mirror/libserialport
mirror/libserialport
1
0
Fork 0
mirror of git://sigrok.org/libserialport synced 2023-08-10 21:13:24 +03:00
Code Issues Projects Releases Wiki Activity

Doxygen cosmetics.

Browse Source
This commit is contained in:
Uwe Hermann 2013-11-19 19:55:02 +01:00
parent 626d280fd3
commit cf9d365ce0
1 changed files with 284 additions and 279 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

563
libserialport.h.in
View File

@ -18,52 +18,51 @@
*/ */
/** /**
*
@mainpage libserialport API * @mainpage libserialport API
*
Introduction * Introduction
============ * ============
*
libserialport is a minimal library written in C that is intended to take care * libserialport is a minimal library written in C that is intended to take
of the OS-specific details when writing software that uses serial ports. * care of the OS-specific details when writing software that uses serial ports.
*
By writing your serial code to use libserialport, you enable it to work * By writing your serial code to use libserialport, you enable it to work
transparently on any platform supported by the library. * transparently on any platform supported by the library.
*
The operations that are supported are: * The operations that are supported are:
*
- @ref Enumeration (obtaining a list of serial ports on the system). * - @ref Enumeration (obtaining a list of serial ports on the system)
- @ref Ports * - @ref Ports
- @ref Configuration (baud rate, parity, etc) * - @ref Configuration (baud rate, parity, etc.)
- @ref Data * - @ref Data
- @ref Errors * - @ref Errors
*
libserialport is an open source project released under the LGPL3+ license. * libserialport is an open source project released under the LGPL3+ license.
*
API principles * API principles
============== * ==============
*
The API is simple, and designed to be a minimal wrapper around the serial port * The API is simple, and designed to be a minimal wrapper around the serial
support in each OS. * port support in each OS.
*
Most functions take a pointer to a struct sp_port, which represents a serial * 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, using * port. These structures are always allocated and freed by the library, using
the functions in the @ref Enumeration "Enumeration" section. * the functions in the @ref Enumeration "Enumeration" section.
*
All functions can return only three possible error values. SP_ERR_ARG indicates * All functions can return only three possible error values. @ref SP_ERR_ARG
the function was called with invalid arguments. SP_ERR_FAIL indicates that the * indicates the function was called with invalid arguments. @ref SP_ERR_FAIL
OS reported a failure. SP_ERR_MEM indicates that a memory allocation failed. * indicates that the OS reported a failure. @ref SP_ERR_MEM indicates that a
All of these error values are negative. * memory allocation failed. All of these error values are negative.
*
When SP_ERR_FAIL is returned, an error code or string description of the error * When @ref SP_ERR_FAIL is returned, an error code or string description of
can be obtained by calling sp_last_error_code() or sp_last_error_message(). The * the error can be obtained by calling sp_last_error_code() or
error code or message is that provided by the OS; libserialport does not define * sp_last_error_message(). The error code or message is that provided by the
any error codes or messages of its own. * OS; libserialport does not define any error codes or messages of its own.
*
Function calls that succeed return SP_OK, which is equal to zero, or where * Function calls that succeed return @ref SP_OK, which is equal to zero,
otherwise documented a positive value. * or where otherwise documented a positive value.
*/
*/
#ifndef LIBSERIALPORT_H #ifndef LIBSERIALPORT_H
#define LIBSERIALPORT_H #define LIBSERIALPORT_H
@ -131,7 +130,7 @@ enum sp_rts {
/** RTS on. */ /** RTS on. */
SP_RTS_ON = 1, SP_RTS_ON = 1,
/** RTS used for flow control. */ /** RTS used for flow control. */
SP_RTS_FLOW_CONTROL = 2 SP_RTS_FLOW_CONTROL = 2,
}; };
/** CTS pin behaviour. */ /** CTS pin behaviour. */
@ -141,7 +140,7 @@ enum sp_cts {
/** CTS ignored. */ /** CTS ignored. */
SP_CTS_IGNORE = 0, SP_CTS_IGNORE = 0,
/** CTS used for flow control. */ /** CTS used for flow control. */
SP_CTS_FLOW_CONTROL = 1 SP_CTS_FLOW_CONTROL = 1,
}; };
/** DTR pin behaviour. */ /** DTR pin behaviour. */
@ -153,7 +152,7 @@ enum sp_dtr {
/** DTR on. */ /** DTR on. */
SP_DTR_ON = 1, SP_DTR_ON = 1,
/** DTR used for flow control. */ /** DTR used for flow control. */
SP_DTR_FLOW_CONTROL = 2 SP_DTR_FLOW_CONTROL = 2,
}; };
/** DSR pin behaviour. */ /** DSR pin behaviour. */
@ -163,7 +162,7 @@ enum sp_dsr {
/** DSR ignored. */ /** DSR ignored. */
SP_DSR_IGNORE = 0, SP_DSR_IGNORE = 0,
/** DSR used for flow control. */ /** DSR used for flow control. */
SP_DSR_FLOW_CONTROL = 1 SP_DSR_FLOW_CONTROL = 1,
}; };
/** XON/XOFF flow control behaviour. */ /** XON/XOFF flow control behaviour. */
@ -177,7 +176,7 @@ enum sp_xonxoff {
/** XON/XOFF enabled for output only. */ /** XON/XOFF enabled for output only. */
SP_XONXOFF_OUT = 2, SP_XONXOFF_OUT = 2,
/** XON/XOFF enabled for input and output. */ /** XON/XOFF enabled for input and output. */
SP_XONXOFF_INOUT = 3 SP_XONXOFF_INOUT = 3,
}; };
/** Standard flow control combinations. */ /** Standard flow control combinations. */
@ -189,15 +188,15 @@ enum sp_flowcontrol {
/** Hardware flow control using RTS/CTS signals. */ /** Hardware flow control using RTS/CTS signals. */
SP_FLOWCONTROL_RTSCTS = 2, SP_FLOWCONTROL_RTSCTS = 2,
/** Hardware flow control using DTR/DSR signals. */ /** Hardware flow control using DTR/DSR signals. */
SP_FLOWCONTROL_DTRDSR = 3 SP_FLOWCONTROL_DTRDSR = 3,
}; };
/** A serial port. */ /** A serial port. */
struct sp_port { struct sp_port {
/** Name used to open the port */ /** Name used to open the port. */
char *name; char *name;
/** @cond 0 */ /** @cond 0 */
/* OS-specific port handle */ /** OS-specific port handle. */
#ifdef _WIN32 #ifdef _WIN32
HANDLE hdl; HANDLE hdl;
#else #else
@ -234,318 +233,324 @@ struct sp_port_config {
*/ */
/** /**
Obtains a pointer to a new sp_port structure representing the named port. The * Obtain a pointer to a new sp_port structure representing the named port.
user should allocate a variable of type "struct sp_port *" and pass a pointer *
to this to receive the result. * The user should allocate a variable of type "struct sp_port *" and pass a
* pointer to this to receive the result.
The result should be freed after use by calling sp_free_port(). *
* The result should be freed after use by calling sp_free_port().
@return SP_OK on success, SP_ERR_FAIL on failure, SP_ERR_MEM on allocation *
failure, or SP_ERR_ARG if an invalid pointer is passed. If any error * @return SP_OK on success, SP_ERR_FAIL on failure, SP_ERR_MEM on allocation
is returned, the variable pointed to by port_ptr will be set to NULL. * failure, or SP_ERR_ARG if an invalid pointer is passed. If any error
Otherwise, it will be set to point to the newly allocated port. * 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.
*/
enum sp_return 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(). * Free a port structure obtained from sp_get_port_by_name() or sp_copy_port().
*/ */
void sp_free_port(struct sp_port *port); void sp_free_port(struct sp_port *port);
/** /**
Lists the serial ports available on the system. The result obtained is an * List the serial ports available on the system.
array of pointers to sp_port structures, terminated by a NULL. The user should *
allocate a variable of type "struct sp_port **" and pass a pointer to this to * The result obtained is an array of pointers to sp_port structures,
receive the result. * terminated by a NULL. The user should allocate a variable of type
* "struct sp_port **" and pass a pointer to this to receive the result.
The result should be freed after use by calling sp_free_port_list(). If a port *
from the list is to be used after freeing the list, it must be copied first * The result should be freed after use by calling sp_free_port_list().
using sp_copy_port(). * If a port from the list is to be used after freeing the list, it must be
* copied first using sp_copy_port().
@return SP_OK on success, SP_ERR_FAIL on failure, SP_ERR_MEM on allocation *
failure, or SP_ERR_ARG if an invalid pointer is passed. If any error * @return SP_OK on success, SP_ERR_FAIL on failure, SP_ERR_MEM on allocation
is returned, the variable pointed to by list_ptr will be set to NULL. * failure, or SP_ERR_ARG if an invalid pointer is passed. If any error
Otherwise, it will be set to point to the newly allocated array. * 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.
*/
enum sp_return 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 * Make a new copy of a sp_port structure.
of type "struct sp_port *" and pass a pointer to this to receive the result. *
* The user should allocate a variable of type "struct sp_port *" and pass a
The copy should be freed after use by calling sp_free_port(). * pointer to this to receive the result.
*
@return SP_OK on success, SP_ERR_MEM on allocation failure, or SP_ERR_ARG * The copy should be freed after use by calling sp_free_port().
if an invalid port or pointer is passed. If any error is returned, *
the variable pointed to by copy_ptr will be set to NULL. Otherwise, * @return SP_OK on success, SP_ERR_MEM on allocation failure, or SP_ERR_ARG
it will be set to point to the newly allocated copy. * if an invalid port or pointer is passed. 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.
*/
enum sp_return 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 * Free a port list obtained from sp_list_ports().
the sp_port structures referred to from the list; any that are to be retained *
must be copied first using sp_copy_port(). * 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().
*/
void sp_free_port_list(struct sp_port **ports); void sp_free_port_list(struct sp_port **ports);
/** /**
@} * @}
@defgroup Ports Opening & closing ports * @defgroup Ports Opening and closing ports
@{ * @{
*/ */
/** /**
Opens the specified serial port. * Open the specified serial port.
*
@param port Pointer to port structure. * @param port Pointer to port structure.
@param flags Flags to use when opening the serial port. * @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 * @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. * failure, or SP_ERR_ARG if an invalid port is passed.
*/ */
enum sp_return sp_open(struct sp_port *port, enum sp_mode flags); enum sp_return sp_open(struct sp_port *port, enum sp_mode flags);
/** /**
Closes the specified serial port. * Close the specified serial port.
*
@return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
if an invalid port is passed. * if an invalid port is passed.
*/ */
enum sp_return sp_close(struct sp_port *port); enum sp_return sp_close(struct sp_port *port);
/** /**
@} * @}
@defgroup Configuration Setting port parameters * @defgroup Configuration Setting port parameters
@{ * @{
*/ */
/** /**
Gets current configuration of the specified serial port. * Get the current configuration of the specified serial port.
*
The user should allocate a struct sp_port_config, then pass a pointer to it * 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 * as the config parameter. The struct will be populated with the port
configuration. * configuration.
*
Any setting that is in a state not recognised or supported by * Any setting that is in a state not recognised or supported by
libserialport will have its value set to -1 in the struct. * 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 * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
for invalid arguments. * for invalid arguments.
*/ */
enum sp_return 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 configuration for the specified serial port. * Set the configuration for the specified serial port.
*
The user should populate a struct sp_port_config, then pass a pointer to it * The user should populate a struct sp_port_config, then pass a pointer to it
as the config parameter. * as the config parameter.
*
To retain the current value of any setting, set that field to -1. * 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 * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
for invalid arguments. * for invalid arguments.
*/ */
enum sp_return 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. * Set the baud rate for the specified serial port.
*
@param port Pointer to port structure. * @param port Pointer to port structure.
@param baudrate Baud rate in bits per second. * @param baudrate Baud rate in bits per second.
*
@return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
for invalid arguments. * for invalid arguments.
*/ */
enum sp_return 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. * Set the number of data bits for the specified serial port.
*
@param port Pointer to port structure. * @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 to use. Valid values are 5 to 8.
*
@return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
for invalid arguments. * for invalid arguments.
*/ */
enum sp_return 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. * Set the parity for the specified serial port.
*
@param port Pointer to port structure. * @param port Pointer to port structure.
@param parity Parity setting to use. * @param parity Parity setting to use.
*
@return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
for invalid arguments. * for invalid arguments.
*/ */
enum sp_return sp_set_parity(struct sp_port *port, enum sp_parity 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. * Set the number of stop bits for the specified port.
*
@param port Pointer to port structure. * @param port Pointer to port structure.
@param stopbits Number of stop bits to use (1 or 2). * @param stopbits Number of stop bits to use (1 or 2).
*
@return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
for invalid arguments. * for invalid arguments.
*/ */
enum sp_return 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. * Set the flow control type for the specified serial port.
*
This function is a wrapper that sets the RTS, CTS, DTR, DSR and * This function is a wrapper that sets the RTS, CTS, DTR, DSR and
XON/XOFF settings as necessary for the specified flow control * XON/XOFF settings as necessary for the specified flow control
type. For more fine-grained control of these settings, use their * type. For more fine-grained control of these settings, use their
individual configuration functions or the sp_set_config() function. * individual configuration functions or the sp_set_config() function.
*
@param port Pointer to port structure. * @param port Pointer to port structure.
@param flowcontrol Flow control setting to use. * @param flowcontrol Flow control setting to use.
*
@return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
for invalid arguments. * for invalid arguments.
*/ */
enum sp_return sp_set_flowcontrol(struct sp_port *port, enum sp_flowcontrol flowcontrol); enum sp_return sp_set_flowcontrol(struct sp_port *port, enum sp_flowcontrol flowcontrol);
/** /**
Sets the RTS pin behaviour for the specified port. * Set the RTS pin behaviour for the specified port.
*
@param port Pointer to port structure. * @param port Pointer to port structure.
@param rts RTS pin mode. * @param rts RTS pin mode.
*
@return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
for invalid arguments. * for invalid arguments.
*/ */
enum sp_return sp_set_rts(struct sp_port *port, enum sp_rts rts); enum sp_return sp_set_rts(struct sp_port *port, enum sp_rts rts);
/** /**
Sets the CTS pin behaviour for the specified port. * Set the CTS pin behaviour for the specified port.
*
@param port Pointer to port structure. * @param port Pointer to port structure.
@param cts CTS pin mode. * @param cts CTS pin mode.
*
@return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
for invalid arguments. * for invalid arguments.
*/ */
enum sp_return sp_set_cts(struct sp_port *port, enum sp_cts cts); enum sp_return sp_set_cts(struct sp_port *port, enum sp_cts cts);
/** /**
Sets the DTR pin behaviour for the specified port. * Set the DTR pin behaviour for the specified port.
*
@param port Pointer to port structure. * @param port Pointer to port structure.
@param dtr DTR pin mode. * @param dtr DTR pin mode.
*
@return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
for invalid arguments. * for invalid arguments.
*/ */
enum sp_return sp_set_dtr(struct sp_port *port, enum sp_dtr dtr); enum sp_return sp_set_dtr(struct sp_port *port, enum sp_dtr dtr);
/** /**
Sets the RTS pin behaviour for the specified port. * Set the RTS pin behaviour for the specified port.
*
@param port Pointer to port structure. * @param port Pointer to port structure.
@param dsr DSR pin mode. * @param dsr DSR pin mode.
*
@return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
for invalid arguments. * for invalid arguments.
*/ */
enum sp_return sp_set_dsr(struct sp_port *port, enum sp_dsr dsr); enum sp_return sp_set_dsr(struct sp_port *port, enum sp_dsr dsr);
/** /**
Configures XON/XOFF flow control for the specified port. * Configure XON/XOFF flow control for the specified port.
*
@param port Pointer to port structure. * @param port Pointer to port structure.
@param xon_xoff XON/XOFF flow control mode. * @param xon_xoff XON/XOFF flow control mode.
*
@return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
for invalid arguments. * for invalid arguments.
*/ */
enum sp_return sp_set_xon_xoff(struct sp_port *port, enum sp_xonxoff xon_xoff); enum sp_return sp_set_xon_xoff(struct sp_port *port, enum sp_xonxoff xon_xoff);
/** /**
@} * @}
@defgroup Data Reading, writing & flushing data * @defgroup Data Reading, writing, and flushing data
@{ * @{
*/ */
/** /**
Reads bytes from the specified serial port. Note that this function may * Read bytes from the specified serial port.
return after reading less than the specified number of bytes; it is the *
user's responsibility to iterate as necessary in this case. * 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
@param port Pointer to port structure. * in this case.
@param buf Buffer in which to store the bytes read. *
@param count Maximum number of bytes to read. * @param port Pointer to port structure.
* @param buf Buffer in which to store the bytes read.
@return The number of bytes read, SP_ERR_FAIL on failure, * @param count Maximum number of bytes to read.
or SP_ERR_ARG for invalid arguments. *
*/ * @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); 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 * Write bytes to the specified serial port.
return after writing less than the specified number of bytes; it is the *
user's responsibility to iterate as necessary in this case. * 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
@param port Pointer to port structure. * in this case.
@param buf Buffer containing the bytes to write. *
@param count Maximum number of bytes to write. * @param port Pointer to port structure.
* @param buf Buffer containing the bytes to write.
@return The number of bytes written, SP_ERR_FAIL on failure, * @param count Maximum number of bytes to write.
or SP_ERR_ARG for invalid arguments. *
*/ * @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); enum sp_return sp_write(struct sp_port *port, const void *buf, size_t count);
/** /**
Flushes serial port buffers. * Flush serial port buffers.
*
@return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
if an invalid port is passed. * if an invalid port is passed.
*/ */
enum sp_return sp_flush(struct sp_port *port); enum sp_return sp_flush(struct sp_port *port);
/** /**
@} * @}
@defgroup Errors Obtaining error information * @defgroup Errors Obtaining error information
@{ * @{
*/ */
/** /**
Gets the error code for a failed operation. * Get the error code for a failed operation.
*
In order to obtain the correct result, this function should be called * In order to obtain the correct result, this function should be called
straight after the failure, before executing any other system operations. * straight after the failure, before executing any other system operations.
*
@return The system's numeric code for the error that caused the last * @return The system's numeric code for the error that caused the last
operation to fail. * operation to fail.
*/ */
int sp_last_error_code(void); int sp_last_error_code(void);
/** /**
Gets the error message for a failed operation. * Get the error message for a failed operation.
*
In order to obtain the correct result, this function should be called * In order to obtain the correct result, this function should be called
straight after the failure, before executing other system operations. * straight after the failure, before executing other system operations.
*
@return The system's message for the error that caused the last * @return The system's message for the error that caused the last
operation to fail. This string may be allocated by the function, * operation to fail. This string may be allocated by the function,
and should be freed after use by calling sp_free_error_message. * and should be freed after use by calling sp_free_error_message().
*/ */
char *sp_last_error_message(void); char *sp_last_error_message(void);
/** /**
Frees an error message returned by sp_last_error_message(). * Free an error message returned by sp_last_error_message().
*/ */
void sp_free_error_message(char *message); void sp_free_error_message(char *message);
/** /** @} */
@}
*/
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
#endif /* LIBSERIALPORT_H */ #endif /* LIBSERIALPORT_H */