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

Clarify usage of -1 in configuration API.

Browse Source
This commit is contained in:
Martin Ling 2013-11-19 03:14:09 +00:00
parent 091e75fedc
commit c200f5c144
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
libserialport.h.in
View File

@ -112,6 +112,7 @@ enum sp_mode {
/** Parity settings. */ /** Parity settings. */
enum sp_parity { enum sp_parity {
/** Special value to indicate setting should be left alone. */
SP_PARITY_INVALID = -1, SP_PARITY_INVALID = -1,
/** No parity. */ /** No parity. */
SP_PARITY_NONE = 0, SP_PARITY_NONE = 0,
@ -123,6 +124,7 @@ enum sp_parity {
/** RTS pin behaviour. */ /** RTS pin behaviour. */
enum sp_rts { enum sp_rts {
/** Special value to indicate setting should be left alone. */
SP_RTS_INVALID = -1, SP_RTS_INVALID = -1,
/** RTS off. */ /** RTS off. */
SP_RTS_OFF = 0, SP_RTS_OFF = 0,
@ -134,6 +136,7 @@ enum sp_rts {
/** CTS pin behaviour. */ /** CTS pin behaviour. */
enum sp_cts { enum sp_cts {
/** Special value to indicate setting should be left alone. */
SP_CTS_INVALID = -1, SP_CTS_INVALID = -1,
/** CTS ignored. */ /** CTS ignored. */
SP_CTS_IGNORE = 0, SP_CTS_IGNORE = 0,
@ -143,6 +146,7 @@ enum sp_cts {
/** DTR pin behaviour. */ /** DTR pin behaviour. */
enum sp_dtr { enum sp_dtr {
/** Special value to indicate setting should be left alone. */
SP_DTR_INVALID = -1, SP_DTR_INVALID = -1,
/** DTR off. */ /** DTR off. */
SP_DTR_OFF = 0, SP_DTR_OFF = 0,
@ -154,6 +158,7 @@ enum sp_dtr {
/** DSR pin behaviour. */ /** DSR pin behaviour. */
enum sp_dsr { enum sp_dsr {
/** Special value to indicate setting should be left alone. */
SP_DSR_INVALID = -1, SP_DSR_INVALID = -1,
/** DSR ignored. */ /** DSR ignored. */
SP_DSR_IGNORE = 0, SP_DSR_IGNORE = 0,
@ -163,6 +168,7 @@ enum sp_dsr {
/** XON/XOFF flow control behaviour. */ /** XON/XOFF flow control behaviour. */
enum sp_xonxoff { enum sp_xonxoff {
/** Special value to indicate setting should be left alone. */
SP_XONXOFF_INVALID = -1, SP_XONXOFF_INVALID = -1,
/** XON/XOFF disabled. */ /** XON/XOFF disabled. */
SP_XONXOFF_DISABLED = 0, SP_XONXOFF_DISABLED = 0,
@ -321,19 +327,21 @@ enum sp_return sp_close(struct sp_port *port);
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
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 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 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 the field to to a To retain the current value of any setting, set that field to -1.
negative value.
@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.