File serial.h
Headers > cais > serial.h
Go to the source code of this file
#include <stddef.h>
#include <cais/types.h>
Data Structures
Types
Functions
| Type |
Name |
| void |
cais_serial_close (cais_serial_t * port)
|
| cais_serial_status_t |
cais_serial_drain (cais_serial_t * port)
|
| cais_line_state_t |
cais_serial_get_cd (cais_serial_t * port)
|
| cais_line_state_t |
cais_serial_get_cts (cais_serial_t * port)
|
| cais_line_state_t |
cais_serial_get_dsr (cais_serial_t * port)
|
| cais_line_state_t |
cais_serial_get_ri (cais_serial_t * port)
|
| cais_serial_t * |
cais_serial_open (const char * path, const cais_serial_opts_t * opts, char * err_buf, size_t err_cap)
|
| cais_status_t |
cais_serial_read (cais_serial_t * port, char * buf, size_t max_len, size_t * read_bytes, int timeout_ms)
|
| cais_serial_status_t |
cais_serial_set_dtr (cais_serial_t * port, cais_serial_line_t state)
|
| cais_serial_status_t |
cais_serial_set_rts (cais_serial_t * port, cais_serial_line_t state)
|
| cais_serial_status_t |
cais_serial_set_timeout (cais_serial_t * port, int timeout_ms)
|
| cais_status_t |
cais_serial_write (cais_serial_t * port, const char * buf, size_t len, size_t * written_bytes)
|
Macros
Type Details
enum cais_serial_baud_t
enum cais_serial_baud_t {
CAIS_SERIAL_BAUD_300 = 300,
CAIS_SERIAL_BAUD_1200 = 1200,
CAIS_SERIAL_BAUD_2400 = 2400,
CAIS_SERIAL_BAUD_4800 = 4800,
CAIS_SERIAL_BAUD_9600 = 9600,
CAIS_SERIAL_BAUD_19200 = 19200,
CAIS_SERIAL_BAUD_38400 = 38400,
CAIS_SERIAL_BAUD_57600 = 57600,
CAIS_SERIAL_BAUD_115200 = 115200
};
enum cais_serial_data_bits_t
enum cais_serial_data_bits_t {
CAIS_SERIAL_DATA_5 = 5,
CAIS_SERIAL_DATA_6 = 6,
CAIS_SERIAL_DATA_7 = 7,
CAIS_SERIAL_DATA_8 = 8
};
enum cais_serial_flow_t
enum cais_serial_flow_t {
CAIS_SERIAL_FLOW_NONE = 0,
CAIS_SERIAL_FLOW_HARDWARE = 1,
CAIS_SERIAL_FLOW_SOFTWARE = 2
};
cais_serial_line_state_t
typedef cais_line_state_t cais_serial_line_state_t;
enum cais_serial_line_t
enum cais_serial_line_t {
CAIS_SERIAL_LINE_IGNORE = -1,
CAIS_SERIAL_LINE_OFF = 0,
CAIS_SERIAL_LINE_ON = 1
};
enum cais_serial_parity_t
enum cais_serial_parity_t {
CAIS_SERIAL_PARITY_NONE = 'n',
CAIS_SERIAL_PARITY_EVEN = 'e',
CAIS_SERIAL_PARITY_ODD = 'o',
CAIS_SERIAL_PARITY_MARK = 'm',
CAIS_SERIAL_PARITY_SPACE = 's'
};
enum cais_serial_stop_bits_t
enum cais_serial_stop_bits_t {
CAIS_SERIAL_STOP_1 = 1,
CAIS_SERIAL_STOP_2 = 2
};
cais_serial_t
typedef struct serial_port cais_serial_t;
Function Details
cais_serial_close
void cais_serial_close (
cais_serial_t * port
)
cais_serial_drain
cais_serial_status_t cais_serial_drain (
cais_serial_t * port
)
cais_serial_get_cd
cais_line_state_t cais_serial_get_cd (
cais_serial_t * port
)
cais_serial_get_cts
cais_line_state_t cais_serial_get_cts (
cais_serial_t * port
)
cais_serial_get_dsr
cais_line_state_t cais_serial_get_dsr (
cais_serial_t * port
)
cais_serial_get_ri
cais_line_state_t cais_serial_get_ri (
cais_serial_t * port
)
cais_serial_open
cais_serial_t * cais_serial_open (
const char * path,
const cais_serial_opts_t * opts,
char * err_buf,
size_t err_cap
)
cais_serial_read
cais_status_t cais_serial_read (
cais_serial_t * port,
char * buf,
size_t max_len,
size_t * read_bytes,
int timeout_ms
)
cais_serial_set_dtr
cais_serial_status_t cais_serial_set_dtr (
cais_serial_t * port,
cais_serial_line_t state
)
cais_serial_set_rts
cais_serial_status_t cais_serial_set_rts (
cais_serial_t * port,
cais_serial_line_t state
)
cais_serial_set_timeout
cais_serial_status_t cais_serial_set_timeout (
cais_serial_t * port,
int timeout_ms
)
cais_serial_write
cais_status_t cais_serial_write (
cais_serial_t * port,
const char * buf,
size_t len,
size_t * written_bytes
)
Macro Details
CAIS_SERIAL_LINE_ERROR
#define CAIS_SERIAL_LINE_ERROR `CAIS_LINE_ERROR`
CAIS_SERIAL_LINE_HIGH
#define CAIS_SERIAL_LINE_HIGH `CAIS_LINE_HIGH`
CAIS_SERIAL_LINE_LOW
#define CAIS_SERIAL_LINE_LOW `CAIS_LINE_LOW`
The documentation was generated from the following file: include/cais/serial.h