1
0
mirror of git://sigrok.org/libserialport synced 2023-08-10 21:13:24 +03:00

Use named enums instead of ints for clearer documentation.

This commit is contained in:
Martin Ling 2013-11-19 02:36:22 +00:00
parent cd5f52812d
commit eb6ed20f51
2 changed files with 156 additions and 161 deletions

View File

@ -87,6 +87,104 @@ extern "C" {
#define SP_LIB_VERSION_AGE @SP_LIB_VERSION_AGE@ #define SP_LIB_VERSION_AGE @SP_LIB_VERSION_AGE@
#define SP_LIB_VERSION_STRING "@SP_LIB_VERSION@" #define SP_LIB_VERSION_STRING "@SP_LIB_VERSION@"
/** Return values. */
enum sp_return {
/** Operation completed successfully. */
SP_OK = 0,
/** Invalid arguments were passed to the function. */
SP_ERR_ARG = -1,
/** A system error occured while executing the operation. */
SP_ERR_FAIL = -2,
/** A memory allocation failed while executing the operation. */
SP_ERR_MEM = -3,
};
/** Port access modes. */
enum sp_mode {
/** Open port for read/write access. */
SP_MODE_RDWR = 1,
/** Open port for read access only. */
SP_MODE_RDONLY = 2,
/** Open port in non-blocking mode. */
SP_MODE_NONBLOCK = 4,
};
/** Parity settings. */
enum sp_parity {
SP_PARITY_INVALID = -1,
/** No parity. */
SP_PARITY_NONE = 0,
/** Even parity. */
SP_PARITY_EVEN = 1,
/** Odd parity. */
SP_PARITY_ODD = 2,
};
/** RTS pin behaviour. */
enum sp_rts {
SP_RTS_INVALID = -1,
/** RTS off. */
SP_RTS_OFF = 0,
/** RTS on. */
SP_RTS_ON = 1,
/** RTS used for flow control. */
SP_RTS_FLOW_CONTROL = 2
};
/** CTS pin behaviour. */
enum sp_cts {
SP_CTS_INVALID = -1,
/** CTS ignored. */
SP_CTS_IGNORE = 0,
/** CTS used for flow control. */
SP_CTS_FLOW_CONTROL = 1
};
/** DTR pin behaviour. */
enum sp_dtr {
SP_DTR_INVALID = -1,
/** DTR off. */
SP_DTR_OFF = 0,
/** DTR on. */
SP_DTR_ON = 1,
/** DTR used for flow control. */
SP_DTR_FLOW_CONTROL = 2
};
/** DSR pin behaviour. */
enum sp_dsr {
SP_DSR_INVALID = -1,
/** DSR ignored. */
SP_DSR_IGNORE = 0,
/** DSR used for flow control. */
SP_DSR_FLOW_CONTROL = 1
};
/** XON/XOFF flow control behaviour. */
enum sp_xonxoff {
SP_XONXOFF_INVALID = -1,
/** XON/XOFF disabled. */
SP_XONXOFF_DISABLED = 0,
/** XON/XOFF enabled for input only. */
SP_XONXOFF_IN = 1,
/** XON/XOFF enabled for output only. */
SP_XONXOFF_OUT = 2,
/** XON/XOFF enabled for input and output. */
SP_XONXOFF_INOUT = 3
};
/** Standard flow control combinations. */
enum sp_flowcontrol {
/** No flow control. */
SP_FLOWCONTROL_NONE = 0,
/** Software flow control using XON/XOFF characters. */
SP_FLOWCONTROL_XONXOFF = 1,
/** Hardware flow control using RTS/CTS signals. */
SP_FLOWCONTROL_RTSCTS = 2,
/** Hardware flow control using DTR/DSR signals. */
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 */
@ -108,112 +206,19 @@ struct sp_port_config {
/** Number of data bits to use. Valid values are 5 to 8. */ /** Number of data bits to use. Valid values are 5 to 8. */
int bits; int bits;
/** Parity setting to use. */ /** Parity setting to use. */
int parity; enum sp_parity parity;
/** Number of stop bits to use (1 or 2). */ /** Number of stop bits to use (1 or 2). */
int stopbits; int stopbits;
/** RTS pin mode. */ /** RTS pin mode. */
int rts; enum sp_rts rts;
/** CTS pin mode. */ /** CTS pin mode. */
int cts; enum sp_cts cts;
/** DTR pin mode. */ /** DTR pin mode. */
int dtr; enum sp_dtr dtr;
/** DSR pin mode. */ /** DSR pin mode. */
int dsr; enum sp_dsr dsr;
/** XON/XOFF flow control mode. */ /** XON/XOFF flow control mode. */
int xon_xoff; enum sp_xonxoff xon_xoff;
};
/** Return values. */
enum {
/** Operation completed successfully. */
SP_OK = 0,
/** Invalid arguments were passed to the function. */
SP_ERR_ARG = -1,
/** A system error occured while executing the operation. */
SP_ERR_FAIL = -2,
/** A memory allocation failed while executing the operation. */
SP_ERR_MEM = -3,
};
/** Port access modes. */
enum {
/** Open port for read/write access. */
SP_MODE_RDWR = 1,
/** Open port for read access only. */
SP_MODE_RDONLY = 2,
/** Open port in non-blocking mode. */
SP_MODE_NONBLOCK = 4,
};
/** Parity settings. */
enum {
/** No parity. */
SP_PARITY_NONE = 0,
/** Even parity. */
SP_PARITY_EVEN = 1,
/** Odd parity. */
SP_PARITY_ODD = 2,
};
/** RTS pin behaviour. */
enum {
/** RTS off. */
SP_RTS_OFF = 0,
/** RTS on. */
SP_RTS_ON = 1,
/** RTS used for flow control. */
SP_RTS_FLOW_CONTROL = 2
};
/** CTS pin behaviour. */
enum {
/** CTS ignored. */
SP_CTS_IGNORE = 0,
/** CTS used for flow control. */
SP_CTS_FLOW_CONTROL = 1
};
/** DTR pin behaviour. */
enum {
/** DTR off. */
SP_DTR_OFF = 0,
/** DTR on. */
SP_DTR_ON = 1,
/** DTR used for flow control. */
SP_DTR_FLOW_CONTROL = 2
};
/** DSR pin behaviour. */
enum {
/** DSR ignored. */
SP_DSR_IGNORE = 0,
/** DSR used for flow control. */
SP_DSR_FLOW_CONTROL = 1
};
/** XON/XOFF flow control behaviour. */
enum {
/** XON/XOFF disabled. */
SP_XONXOFF_DISABLED = 0,
/** XON/XOFF enabled for input only. */
SP_XONXOFF_IN = 1,
/** XON/XOFF enabled for output only. */
SP_XONXOFF_OUT = 2,
/** XON/XOFF enabled for input and output. */
SP_XONXOFF_INOUT = 3
};
/** Standard flow control combinations. */
enum {
/** No flow control. */
SP_FLOWCONTROL_NONE = 0,
/** Software flow control using XON/XOFF characters. */
SP_FLOWCONTROL_XONXOFF = 1,
/** Hardware flow control using RTS/CTS signals. */
SP_FLOWCONTROL_RTSCTS = 2,
/** Hardware flow control using DTR/DSR signals. */
SP_FLOWCONTROL_DTRDSR = 3
}; };
/** /**
@ -228,7 +233,7 @@ enum {
is returned, the variable pointed to by port_ptr will be set to NULL. 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. 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(). Frees a port structure obtained from sp_get_port_by_name() or sp_copy_port().
@ -250,7 +255,7 @@ void sp_free_port(struct sp_port *port);
is returned, the variable pointed to by list_ptr will be set to NULL. 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. 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 Makes a new copy of a sp_port structure. The user should allocate a variable
@ -263,7 +268,7 @@ int sp_list_ports(struct sp_port ***list_ptr);
the variable pointed to by copy_ptr will be set to NULL. Otherwise, the variable pointed to by copy_ptr will be set to NULL. Otherwise,
it will be set to point to the newly allocated copy. 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 Frees a port list obtained from sp_list_ports(). This will also free all
@ -276,14 +281,12 @@ void sp_free_port_list(struct sp_port **ports);
Opens the specified serial port. Opens 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. Possible @param flags Flags to use when opening the serial port.
flags are: SP_MODE_RDWR, SP_MODE_RDONLY, and
SP_MODE_NONBLOCK.
@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.
*/ */
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. Closes the specified serial port.
@ -291,7 +294,7 @@ int sp_open(struct sp_port *port, int flags);
@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.
*/ */
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 Reads bytes from the specified serial port. Note that this function may
@ -305,7 +308,7 @@ int sp_close(struct sp_port *port);
@return The number of bytes read, SP_ERR_FAIL on failure, @return The number of bytes read, SP_ERR_FAIL on failure,
or SP_ERR_ARG for invalid arguments. or SP_ERR_ARG for invalid arguments.
*/ */
int 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. Note that this function may
@ -319,7 +322,7 @@ int sp_read(struct sp_port *port, void *buf, size_t count);
@return The number of bytes written, SP_ERR_FAIL on failure, @return The number of bytes written, SP_ERR_FAIL on failure,
or SP_ERR_ARG for invalid arguments. or SP_ERR_ARG for invalid arguments.
*/ */
int 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. Flushes serial port buffers.
@ -327,7 +330,7 @@ int sp_write(struct sp_port *port, const void *buf, size_t count);
@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.
*/ */
int sp_flush(struct sp_port *port); enum sp_return sp_flush(struct sp_port *port);
/** /**
Gets current configuration of the specified serial port. Gets current configuration of the specified serial port.
@ -339,7 +342,7 @@ int sp_flush(struct sp_port *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
for invalid arguments. 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 all parameters for the specified serial port.
@ -353,7 +356,7 @@ int sp_get_config(struct sp_port *port, struct sp_port_config *config);
@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.
*/ */
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. Sets the baud rate for the specified serial port.
@ -364,7 +367,7 @@ int sp_set_config(struct sp_port *port, const struct sp_port_config *config);
@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.
*/ */
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. Sets the number of data bits for the specified serial port.
@ -375,19 +378,18 @@ int sp_set_baudrate(struct sp_port *port, int baudrate);
@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.
*/ */
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. Sets 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.
(SP_PARITY_NONE, SP_PARITY_EVEN or SP_PARITY_ODD)
@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.
*/ */
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. Sets the number of stop bits for the specified port.
@ -398,7 +400,7 @@ int sp_set_parity(struct sp_port *port, int parity);
@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.
*/ */
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. Sets the flow control type for the specified serial port.
@ -409,78 +411,67 @@ int sp_set_stopbits(struct sp_port *port, int stopbits);
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. Valid settings are: @param flowcontrol Flow control setting to use.
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.
@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.
*/ */
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. Sets 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.
(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 @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
for invalid arguments. 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. Sets 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.
(SP_CTS_IGNORE or SP_CTS_FLOW_CONTROL)
@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.
*/ */
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. Sets 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.
(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 @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
for invalid arguments. 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. Sets 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.
(SP_DSR_IGNORE or SP_DSR_FLOW_CONTROL)
@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.
*/ */
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. Configures 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.
(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 @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
for invalid arguments. 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);
/** /**
Gets the error code for a failed operation. Gets the error code for a failed operation.

View File

@ -92,12 +92,14 @@ const struct std_baudrate std_baudrates[] = {
#define NUM_STD_BAUDRATES ARRAY_SIZE(std_baudrates) #define NUM_STD_BAUDRATES ARRAY_SIZE(std_baudrates)
/* Helper functions. */ /* Helper functions. */
static int validate_port(struct sp_port *port); static enum sp_return validate_port(struct sp_port *port);
static struct sp_port **list_append(struct sp_port **list, const char *portname); static struct sp_port **list_append(struct sp_port **list, const char *portname);
static int get_config(struct sp_port *port, struct port_data *data, struct sp_port_config *config); static enum sp_return get_config(struct sp_port *port, struct port_data *data,
static int set_config(struct sp_port *port, struct port_data *data, const struct sp_port_config *config); struct sp_port_config *config);
static enum sp_return set_config(struct sp_port *port, struct port_data *data,
const struct sp_port_config *config);
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)
{ {
struct sp_port *port; struct sp_port *port;
int len; int len;
@ -134,7 +136,7 @@ int sp_get_port_by_name(const char *portname, struct sp_port **port_ptr)
return SP_OK; return SP_OK;
} }
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)
{ {
if (!copy_ptr) if (!copy_ptr)
return SP_ERR_ARG; return SP_ERR_ARG;
@ -177,7 +179,7 @@ fail:
return NULL; return NULL;
} }
int sp_list_ports(struct sp_port ***list_ptr) enum sp_return sp_list_ports(struct sp_port ***list_ptr)
{ {
struct sp_port **list; struct sp_port **list;
int ret = SP_OK; int ret = SP_OK;
@ -397,7 +399,7 @@ void sp_free_port_list(struct sp_port **list)
free(list); free(list);
} }
static int validate_port(struct sp_port *port) static enum sp_return validate_port(struct sp_port *port)
{ {
if (port == NULL) if (port == NULL)
return 0; return 0;
@ -413,7 +415,7 @@ static int validate_port(struct sp_port *port)
#define CHECK_PORT() do { if (!validate_port(port)) return SP_ERR_ARG; } while (0) #define CHECK_PORT() do { if (!validate_port(port)) return SP_ERR_ARG; } while (0)
int sp_open(struct sp_port *port, int flags) enum sp_return sp_open(struct sp_port *port, enum sp_mode flags)
{ {
if (!port) if (!port)
return SP_ERR_ARG; return SP_ERR_ARG;
@ -491,7 +493,7 @@ int sp_open(struct sp_port *port, int flags)
return SP_OK; return SP_OK;
} }
int sp_close(struct sp_port *port) enum sp_return sp_close(struct sp_port *port)
{ {
CHECK_PORT(); CHECK_PORT();
@ -510,7 +512,7 @@ int sp_close(struct sp_port *port)
return SP_OK; return SP_OK;
} }
int sp_flush(struct sp_port *port) enum sp_return sp_flush(struct sp_port *port)
{ {
CHECK_PORT(); CHECK_PORT();
@ -526,7 +528,7 @@ int sp_flush(struct sp_port *port)
return SP_OK; return SP_OK;
} }
int 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)
{ {
CHECK_PORT(); CHECK_PORT();
@ -551,7 +553,7 @@ int sp_write(struct sp_port *port, const void *buf, size_t count)
#endif #endif
} }
int 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)
{ {
CHECK_PORT(); CHECK_PORT();
@ -575,7 +577,8 @@ int sp_read(struct sp_port *port, void *buf, size_t count)
#endif #endif
} }
static int get_config(struct sp_port *port, struct port_data *data, struct sp_port_config *config) static enum sp_return get_config(struct sp_port *port, struct port_data *data,
struct sp_port_config *config)
{ {
unsigned int i; unsigned int i;
@ -726,7 +729,8 @@ static int get_config(struct sp_port *port, struct port_data *data, struct sp_po
return SP_OK; return SP_OK;
} }
static int set_config(struct sp_port *port, struct port_data *data, const struct sp_port_config *config) static enum sp_return set_config(struct sp_port *port, struct port_data *data,
const struct sp_port_config *config)
{ {
unsigned int i; unsigned int i;
@ -1005,7 +1009,7 @@ static int set_config(struct sp_port *port, struct port_data *data, const struct
#define TRY(x) do { int ret = x; if (ret != SP_OK) return ret; } while (0) #define TRY(x) do { int ret = x; if (ret != SP_OK) return ret; } while (0)
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)
{ {
struct port_data data; struct port_data data;
struct sp_port_config prev_config; struct sp_port_config prev_config;
@ -1021,7 +1025,7 @@ int sp_set_config(struct sp_port *port, const struct sp_port_config *config)
return SP_OK; return SP_OK;
} }
#define CREATE_SETTER(x) int sp_set_##x(struct sp_port *port, int x) { \ #define CREATE_SETTER(x, type) int sp_set_##x(struct sp_port *port, type x) { \
struct port_data data; \ struct port_data data; \
struct sp_port_config config; \ struct sp_port_config config; \
CHECK_PORT(); \ CHECK_PORT(); \
@ -1031,17 +1035,17 @@ int sp_set_config(struct sp_port *port, const struct sp_port_config *config)
return SP_OK; \ return SP_OK; \
} }
CREATE_SETTER(baudrate) CREATE_SETTER(baudrate, int)
CREATE_SETTER(bits) CREATE_SETTER(bits, int)
CREATE_SETTER(parity) CREATE_SETTER(parity, enum sp_parity)
CREATE_SETTER(stopbits) CREATE_SETTER(stopbits, int)
CREATE_SETTER(rts) CREATE_SETTER(rts, enum sp_rts)
CREATE_SETTER(cts) CREATE_SETTER(cts, enum sp_cts)
CREATE_SETTER(dtr) CREATE_SETTER(dtr, enum sp_dtr)
CREATE_SETTER(dsr) CREATE_SETTER(dsr, enum sp_dsr)
CREATE_SETTER(xon_xoff) CREATE_SETTER(xon_xoff, enum sp_xonxoff)
int sp_set_flowcontrol(struct sp_port *port, int flowcontrol) enum sp_return sp_set_flowcontrol(struct sp_port *port, enum sp_flowcontrol flowcontrol)
{ {
struct port_data data; struct port_data data;
struct sp_port_config config; struct sp_port_config config;