NEORV32 - Software Framework Documentation
neorv32_uart.h
Go to the documentation of this file.
1// #################################################################################################
2// # << NEORV32: neorv32_uart.h - Universal Asynchronous Receiver/Transmitter (UART) HW Driver >> #
3// # ********************************************************************************************* #
4// # BSD 3-Clause License #
5// # #
6// # Copyright (c) 2021, Stephan Nolting. All rights reserved. #
7// # #
8// # Redistribution and use in source and binary forms, with or without modification, are #
9// # permitted provided that the following conditions are met: #
10// # #
11// # 1. Redistributions of source code must retain the above copyright notice, this list of #
12// # conditions and the following disclaimer. #
13// # #
14// # 2. Redistributions in binary form must reproduce the above copyright notice, this list of #
15// # conditions and the following disclaimer in the documentation and/or other materials #
16// # provided with the distribution. #
17// # #
18// # 3. Neither the name of the copyright holder nor the names of its contributors may be used to #
19// # endorse or promote products derived from this software without specific prior written #
20// # permission. #
21// # #
22// # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS #
23// # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF #
24// # MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE #
25// # COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, #
26// # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE #
27// # GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED #
28// # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING #
29// # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED #
30// # OF THE POSSIBILITY OF SUCH DAMAGE. #
31// # ********************************************************************************************* #
32// # The NEORV32 Processor - https://github.com/stnolting/neorv32 (c) Stephan Nolting #
33// #################################################################################################
34
35
36/**********************************************************************/
45#ifndef neorv32_uart_h
46#define neorv32_uart_h
47
48// Libs required by functions
49#include <stdarg.h>
50
51// prototypes for UART0 (primary UART)
53void neorv32_uart0_setup(uint32_t baudrate, uint8_t parity, uint8_t flow_con);
54void neorv32_uart0_disable(void);
55void neorv32_uart0_enable(void);
56void neorv32_uart0_putc(char c);
57int neorv32_uart0_tx_busy(void);
58char neorv32_uart0_getc(void);
60int neorv32_uart0_getc_safe(char *data);
62void neorv32_uart0_print(const char *s);
63void neorv32_uart0_printf(const char *format, ...);
64int neorv32_uart0_scan(char *buffer, int max_size, int echo);
65
66// prototypes for UART1 (secondary UART)
68void neorv32_uart1_setup(uint32_t baudrate, uint8_t parity, uint8_t flow_con);
69void neorv32_uart1_disable(void);
70void neorv32_uart1_enable(void);
71void neorv32_uart1_putc(char c);
72int neorv32_uart1_tx_busy(void);
73char neorv32_uart1_getc(void);
75int neorv32_uart1_getc_safe(char *data);
77void neorv32_uart1_print(const char *s);
78void neorv32_uart1_printf(const char *format, ...);
79int neorv32_uart1_scan(char *buffer, int max_size, int echo);
80
81#endif // neorv32_uart_h
void neorv32_uart1_putc(char c)
Definition: neorv32_uart.c:579
char neorv32_uart1_getc(void)
Definition: neorv32_uart.c:613
int neorv32_uart0_scan(char *buffer, int max_size, int echo)
Definition: neorv32_uart.c:431
void neorv32_uart1_print(const char *s)
Definition: neorv32_uart.c:709
void neorv32_uart0_print(const char *s)
Definition: neorv32_uart.c:334
int neorv32_uart1_scan(char *buffer, int max_size, int echo)
Definition: neorv32_uart.c:806
void neorv32_uart0_setup(uint32_t baudrate, uint8_t parity, uint8_t flow_con)
Definition: neorv32_uart.c:118
void neorv32_uart0_printf(const char *format,...)
Definition: neorv32_uart.c:363
void neorv32_uart1_disable(void)
Definition: neorv32_uart.c:557
int neorv32_uart1_char_received(void)
Definition: neorv32_uart.c:677
int neorv32_uart1_available(void)
Definition: neorv32_uart.c:473
int neorv32_uart0_getc_safe(char *data)
Definition: neorv32_uart.c:263
char neorv32_uart0_char_received_get(void)
Definition: neorv32_uart.c:321
void neorv32_uart0_disable(void)
Definition: neorv32_uart.c:182
void neorv32_uart1_setup(uint32_t baudrate, uint8_t parity, uint8_t flow_con)
Definition: neorv32_uart.c:496
int neorv32_uart0_available(void)
Definition: neorv32_uart.c:95
int neorv32_uart0_char_received(void)
Definition: neorv32_uart.c:302
int neorv32_uart0_tx_busy(void)
Definition: neorv32_uart.c:219
char neorv32_uart1_char_received_get(void)
Definition: neorv32_uart.c:696
void neorv32_uart0_putc(char c)
Definition: neorv32_uart.c:204
void neorv32_uart1_enable(void)
Definition: neorv32_uart.c:566
char neorv32_uart0_getc(void)
Definition: neorv32_uart.c:238
void neorv32_uart1_printf(const char *format,...)
Definition: neorv32_uart.c:738
void neorv32_uart0_enable(void)
Definition: neorv32_uart.c:191
int neorv32_uart1_getc_safe(char *data)
Definition: neorv32_uart.c:638
int neorv32_uart1_tx_busy(void)
Definition: neorv32_uart.c:594