simple_uart/simple_uart.h at master · AndreRenaud/simple_uart · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
#ifndef SIMPLE_UART_H
#define SIMPLE_UART_H

#ifdef __cplusplus
extern "C" {
#endif

#include <stdbool.h>
#include <stdint.h>

#ifdef _WIN32
#include <basetsd.h>
#include <windows.h>
typedef SSIZE_T ssize_t;
#endif

struct simple_uart;

enum {
    SIMPLE_UART_RTS,
    SIMPLE_UART_CTS,
    SIMPLE_UART_DSR,
    SIMPLE_UART_DCD,
    SIMPLE_UART_DTR,
    SIMPLE_UART_RI,
};

// Builds a list of device names that can be opened.
// ie: /dev/ttyS0 etc... (or COM1: on Win32)
// Returns the number of items in the list.
// Caller is responsible for free'ing each name/description and the overall list
ssize_t simple_uart_list(char ***namesp);

/**
 * Creates String with UART port properties
 * Return:
 *   != 0   error
 *   == 0   success
 */
int simple_uart_describe(const char *uart, char *description, size_t max_desc_len);

/**
 * Opens a uart, either by device name, or if that fails it will search
 * for a substring match of the descriptions, as returned by simple_uart_list
 */
struct simple_uart *simple_uart_open(const char *name, int speed, const char *mode_string);
int simple_uart_close(struct simple_uart *uart);

/* Raw read/write */
ssize_t simple_uart_read(struct simple_uart *uart, void *buffer, size_t max_len);
ssize_t simple_uart_read_timeout(struct simple_uart *uart, void *buffer, size_t max_len, uint64_t timeout_ms);
ssize_t simple_uart_write(struct simple_uart *uart, const void *buffer, size_t len);

/* Sets the delay between sending each character when using uart_write */
unsigned int simple_uart_set_character_delay(struct simple_uart *uart, unsigned int delay_us);

/**
 * Returns how many data bytes available on the uart
 */
int simple_uart_has_data(struct simple_uart *uart);

/**
 * Set the logfile to store all read/write data to
 */
int simple_uart_set_logfile(struct simple_uart *uart, const char *logfile, ...);

int simple_uart_get_fd(const struct simple_uart *uart);
#ifdef _WIN32
HANDLE simple_uart_get_handle(const struct simple_uart *uart);
#endif

/**
 *
 */
int simple_uart_get_pin(struct simple_uart *uart, int pin);

int simple_uart_set_pin(struct simple_uart *uart, int pin, bool high);

/**
 * Make sure all write data has been flushed out of the UART
 */
int simple_uart_flush(struct simple_uart *uart);

/**
 * Send the break symbol
 */
int simple_uart_send_break(struct simple_uart *uart);

/**
 * Read data until either a line ending (carriage return/line feed) is seen,
 * or a timeout occurs
 */
ssize_t simple_uart_read_line(struct simple_uart *uart, char *result, int max_len, uint64_t ms_timeout);

#ifdef __cplusplus
}
#endif

#endif /* SIMPLE_UART_H */