no-OS
no_os_uart.h
Go to the documentation of this file.
1 /***************************************************************************/
39 #ifndef _NO_OS_UART_H_
40 #define _NO_OS_UART_H_
41 
42 /******************************************************************************/
43 /***************************** Include Files **********************************/
44 /******************************************************************************/
45 
46 #include <stdint.h>
47 #include <stdbool.h>
48 #include "no_os_lf256fifo.h"
49 
50 /******************************************************************************/
51 /*************************** Types Declarations *******************************/
52 /******************************************************************************/
53 
69 };
70 
86 };
87 
97 };
98 
105 
112  uint8_t device_id;
114  uint32_t irq_id;
118  uint32_t baud_rate;
127  void *extra;
128 };
129 
136  uint8_t device_id;
138  uint32_t irq_id;
140  struct lf256fifo *rx_fifo;
142  uint32_t baud_rate;
145  void *extra;
146 };
147 
155  int32_t (*init)(struct no_os_uart_desc **, struct no_os_uart_init_param *);
157  int32_t (*read)(struct no_os_uart_desc *, uint8_t *, uint32_t);
159  int32_t (*write)(struct no_os_uart_desc *, const uint8_t *, uint32_t);
161  int32_t (*read_nonblocking)(struct no_os_uart_desc *, uint8_t *, uint32_t);
163  int32_t (*write_nonblocking)(struct no_os_uart_desc *, const uint8_t *,
164  uint32_t);
166  int32_t (*remove)(struct no_os_uart_desc *);
168  uint32_t (*get_errors)(struct no_os_uart_desc *);
169 };
170 
171 /******************************************************************************/
172 /************************ Functions Declarations ******************************/
173 /******************************************************************************/
174 
175 /* Read data from UART. Blocking function */
176 int32_t no_os_uart_read(struct no_os_uart_desc *desc, uint8_t *data,
177  uint32_t bytes_number);
178 
179 /* Write data to UART. Blocking function */
180 int32_t no_os_uart_write(struct no_os_uart_desc *desc, const uint8_t *data,
181  uint32_t bytes_number);
182 
183 /* Read data from UART. Non blocking function */
184 int32_t no_os_uart_read_nonblocking(struct no_os_uart_desc *desc, uint8_t *data,
185  uint32_t bytes_number);
186 
187 /* Write data to UART. Non blocking function*/
188 int32_t no_os_uart_write_nonblocking(struct no_os_uart_desc *desc,
189  const uint8_t *data,
190  uint32_t bytes_number);
191 
192 /* Initialize the UART communication peripheral. */
193 int32_t no_os_uart_init(struct no_os_uart_desc **desc,
194  struct no_os_uart_init_param *param);
195 
196 /* Free the resources allocated by no_os_uart_init(). */
197 int32_t no_os_uart_remove(struct no_os_uart_desc *desc);
198 
199 /* Check if UART errors occurred. */
200 uint32_t no_os_uart_get_errors(struct no_os_uart_desc *desc);
201 
202 /* Make stdio to use this UART. */
203 void no_os_uart_stdio(struct no_os_uart_desc *desc);
204 
205 #endif // _NO_OS_UART_H_
no_os_uart_desc::platform_ops
const struct no_os_uart_platform_ops * platform_ops
Definition: no_os_uart.h:143
no_os_uart_init_param::parity
enum no_os_uart_parity parity
Definition: no_os_uart.h:122
no_os_uart_platform_ops
Structure holding UART function pointers that point to the platform specific function.
Definition: no_os_uart.h:153
no_os_uart_write
int32_t no_os_uart_write(struct no_os_uart_desc *desc, const uint8_t *data, uint32_t bytes_number)
Write to UART.
Definition: no_os_uart.c:130
no_os_uart_init_param::extra
void * extra
Definition: no_os_uart.h:127
no_os_uart_stdio
void no_os_uart_stdio(struct no_os_uart_desc *desc)
Definition: no_os_uart.c:184
NO_OS_UART_STOP_1_BIT
@ NO_OS_UART_STOP_1_BIT
Definition: no_os_uart.h:94
no_os_uart_init_param::size
enum no_os_uart_size size
Definition: no_os_uart.h:120
no_os_uart_platform_ops::remove
int32_t(* remove)(struct no_os_uart_desc *)
Definition: no_os_uart.h:166
no_os_uart_read
int32_t no_os_uart_read(struct no_os_uart_desc *desc, uint8_t *data, uint32_t bytes_number)
Read data from UART.
Definition: no_os_uart.c:110
no_os_uart_platform_ops::init
int32_t(* init)(struct no_os_uart_desc **, struct no_os_uart_init_param *)
Definition: no_os_uart.h:155
no_os_uart_desc::baud_rate
uint32_t baud_rate
Definition: no_os_uart.h:142
NO_OS_UART_CS_5
@ NO_OS_UART_CS_5
Definition: no_os_uart.h:60
no_os_uart_size
no_os_uart_size
UART character size (number of data bits) options.
Definition: no_os_uart.h:58
no_os_uart_init_param::irq_id
uint32_t irq_id
Definition: no_os_uart.h:114
no_os_uart_platform_ops::get_errors
uint32_t(* get_errors)(struct no_os_uart_desc *)
Definition: no_os_uart.h:168
no_os_uart_desc::device_id
uint8_t device_id
Definition: no_os_uart.h:136
no_os_uart_parity
no_os_uart_parity
UART parity options.
Definition: no_os_uart.h:75
no_os_uart_remove
int32_t no_os_uart_remove(struct no_os_uart_desc *desc)
Free the resources allocated by no_os_uart_init().
Definition: no_os_uart.c:76
no_os_uart_get_errors
uint32_t no_os_uart_get_errors(struct no_os_uart_desc *desc)
Check if errors occurred on UART.
Definition: no_os_uart.c:92
no_os_uart_desc
Stucture holding the UART descriptor.
Definition: no_os_uart.h:134
no_os_uart_init_param::asynchronous_rx
bool asynchronous_rx
Definition: no_os_uart.h:116
no_os_uart_platform_ops::write
int32_t(* write)(struct no_os_uart_desc *, const uint8_t *, uint32_t)
Definition: no_os_uart.h:159
no_os_uart_desc::extra
void * extra
Definition: no_os_uart.h:145
NO_OS_UART_STOP_2_BIT
@ NO_OS_UART_STOP_2_BIT
Definition: no_os_uart.h:96
no_os_uart_desc::rx_fifo
struct lf256fifo * rx_fifo
Definition: no_os_uart.h:140
NO_OS_UART_PAR_SPACE
@ NO_OS_UART_PAR_SPACE
Definition: no_os_uart.h:81
no_os_uart_init_param::baud_rate
uint32_t baud_rate
Definition: no_os_uart.h:118
no_os_uart_init_param::stop
enum no_os_uart_stop stop
Definition: no_os_uart.h:124
NO_OS_UART_CS_9
@ NO_OS_UART_CS_9
Definition: no_os_uart.h:68
NO_OS_UART_PAR_EVEN
@ NO_OS_UART_PAR_EVEN
Definition: no_os_uart.h:85
no_os_lf256fifo.h
SPSC lock-free fifo of fixed size (256), specialized for UART.
no_os_uart_platform_ops::read_nonblocking
int32_t(* read_nonblocking)(struct no_os_uart_desc *, uint8_t *, uint32_t)
Definition: no_os_uart.h:161
no_os_uart_read_nonblocking
int32_t no_os_uart_read_nonblocking(struct no_os_uart_desc *desc, uint8_t *data, uint32_t bytes_number)
Read data from UART non-blocking.
Definition: no_os_uart.c:150
no_os_uart_desc::irq_id
uint32_t irq_id
Definition: no_os_uart.h:138
NO_OS_UART_CS_7
@ NO_OS_UART_CS_7
Definition: no_os_uart.h:64
no_os_uart_init_param::platform_ops
const struct no_os_uart_platform_ops * platform_ops
Definition: no_os_uart.h:125
NO_OS_UART_CS_6
@ NO_OS_UART_CS_6
Definition: no_os_uart.h:62
no_os_uart_init
int32_t no_os_uart_init(struct no_os_uart_desc **desc, struct no_os_uart_init_param *param)
Initialize the UART communication peripheral.
Definition: no_os_uart.c:51
no_os_uart_init_param
Structure holding the parameters for UART initialization.
Definition: no_os_uart.h:110
NO_OS_UART_PAR_NO
@ NO_OS_UART_PAR_NO
Definition: no_os_uart.h:77
no_os_uart_stop
no_os_uart_stop
UART number of stop bits options.
Definition: no_os_uart.h:92
no_os_uart_init_param::device_id
uint8_t device_id
Definition: no_os_uart.h:112
no_os_uart_platform_ops::write_nonblocking
int32_t(* write_nonblocking)(struct no_os_uart_desc *, const uint8_t *, uint32_t)
Definition: no_os_uart.h:163
NO_OS_UART_PAR_MARK
@ NO_OS_UART_PAR_MARK
Definition: no_os_uart.h:79
NO_OS_UART_PAR_ODD
@ NO_OS_UART_PAR_ODD
Definition: no_os_uart.h:83
no_os_uart_write_nonblocking
int32_t no_os_uart_write_nonblocking(struct no_os_uart_desc *desc, const uint8_t *data, uint32_t bytes_number)
Write to UART non-blocking.
Definition: no_os_uart.c:170
NO_OS_UART_CS_8
@ NO_OS_UART_CS_8
Definition: no_os_uart.h:66
no_os_uart_platform_ops::read
int32_t(* read)(struct no_os_uart_desc *, uint8_t *, uint32_t)
Definition: no_os_uart.h:157