neorv32_uart.h

Go to the documentation of this file.

// #################################################################################################
// # << NEORV32: neorv32_uart.h - Universal Asynchronous Receiver/Transmitter (UART) HW Driver >>  #
// # ********************************************************************************************* #
// # BSD 3-Clause License                                                                          #
// #                                                                                               #
// # Copyright (c) 2023, Stephan Nolting. All rights reserved.                                     #
// #                                                                                               #
// # Redistribution and use in source and binary forms, with or without modification, are          #
// # permitted provided that the following conditions are met:                                     #
// #                                                                                               #
// # 1. Redistributions of source code must retain the above copyright notice, this list of        #
// #    conditions and the following disclaimer.                                                   #
// #                                                                                               #
// # 2. Redistributions in binary form must reproduce the above copyright notice, this list of     #
// #    conditions and the following disclaimer in the documentation and/or other materials        #
// #    provided with the distribution.                                                            #
// #                                                                                               #
// # 3. Neither the name of the copyright holder nor the names of its contributors may be used to  #
// #    endorse or promote products derived from this software without specific prior written      #
// #    permission.                                                                                #
// #                                                                                               #
// # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS   #
// # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF               #
// # MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE    #
// # COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,     #
// # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE #
// # GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED    #
// # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING     #
// # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED  #
// # OF THE POSSIBILITY OF SUCH DAMAGE.                                                            #
// # ********************************************************************************************* #
// # The NEORV32 Processor - https://github.com/stnolting/neorv32              (c) Stephan Nolting #
// #################################################################################################
 
 
/**********************************************************************/
#ifndef neorv32_uart_h
#define neorv32_uart_h
 
// Libs required by functions
#include <stdarg.h>
 
/**********************************************************************/
typedef volatile struct __attribute__((packed,aligned(4))) {
  uint32_t CTRL;  
  uint32_t DATA;  
} neorv32_uart_t;
 
#define NEORV32_UART0 ((neorv32_uart_t*) (NEORV32_UART0_BASE))
 
#define NEORV32_UART1 ((neorv32_uart_t*) (NEORV32_UART1_BASE))
 
enum NEORV32_UART_CTRL_enum {
  UART_CTRL_EN            =  0, 
  UART_CTRL_SIM_MODE      =  1, 
  UART_CTRL_HWFC_EN       =  2, 
  UART_CTRL_PRSC0         =  3, 
  UART_CTRL_PRSC1         =  4, 
  UART_CTRL_PRSC2         =  5, 
  UART_CTRL_BAUD0         =  6, 
  UART_CTRL_BAUD1         =  7, 
  UART_CTRL_BAUD2         =  8, 
  UART_CTRL_BAUD3         =  9, 
  UART_CTRL_BAUD4         = 10, 
  UART_CTRL_BAUD5         = 11, 
  UART_CTRL_BAUD6         = 12, 
  UART_CTRL_BAUD7         = 13, 
  UART_CTRL_BAUD8         = 14, 
  UART_CTRL_BAUD9         = 15, 
  UART_CTRL_RX_NEMPTY     = 16, 
  UART_CTRL_RX_HALF       = 17, 
  UART_CTRL_RX_FULL       = 18, 
  UART_CTRL_TX_EMPTY      = 19, 
  UART_CTRL_TX_NHALF      = 20, 
  UART_CTRL_TX_FULL       = 21, 
  UART_CTRL_IRQ_RX_NEMPTY = 22, 
  UART_CTRL_IRQ_RX_HALF   = 23, 
  UART_CTRL_IRQ_RX_FULL   = 24, 
  UART_CTRL_IRQ_TX_EMPTY  = 25, 
  UART_CTRL_IRQ_TX_NHALF  = 26, 
  UART_CTRL_RX_OVER       = 30, 
  UART_CTRL_TX_BUSY       = 31  
};
 
enum NEORV32_UART_DATA_enum {
  UART_DATA_RTX_LSB          =  0, 
  UART_DATA_RTX_MSB          =  7, 
  UART_DATA_RX_FIFO_SIZE_LSB =  8, 
  UART_DATA_RX_FIFO_SIZE_MSB = 11, 
  UART_DATA_TX_FIFO_SIZE_LSB = 12, 
  UART_DATA_TX_FIFO_SIZE_MSB = 15, 
};
/**********************************************************************/
int  neorv32_uart_available(neorv32_uart_t *UARTx);
int  neorv32_uart_get_rx_fifo_depth(neorv32_uart_t *UARTx);
int  neorv32_uart_get_tx_fifo_depth(neorv32_uart_t *UARTx);
void neorv32_uart_setup(neorv32_uart_t *UARTx, uint32_t baudrate, uint32_t irq_mask);
void neorv32_uart_enable(neorv32_uart_t *UARTx);
void neorv32_uart_disable(neorv32_uart_t *UARTx);
void neorv32_uart_rtscts_enable(neorv32_uart_t *UARTx);
void neorv32_uart_rtscts_disable(neorv32_uart_t *UARTx);
void neorv32_uart_putc(neorv32_uart_t *UARTx, char c);
int  neorv32_uart_tx_busy(neorv32_uart_t *UARTx);
char neorv32_uart_getc(neorv32_uart_t *UARTx);
int  neorv32_uart_char_received(neorv32_uart_t *UARTx);
char neorv32_uart_char_received_get(neorv32_uart_t *UARTx);
void neorv32_uart_puts(neorv32_uart_t *UARTx, const char *s);
void neorv32_uart_vprintf(neorv32_uart_t *UARTx, const char *format, va_list args);
void neorv32_uart_printf(neorv32_uart_t *UARTx, const char *format, ...);
int  neorv32_uart_scan(neorv32_uart_t *UARTx, char *buffer, int max_size, int echo);
#endif // neorv32_uart_h