uart.h

Go to the documentation of this file.

// Copyright (C) 2013-2026 Efinix Inc. All rights reserved.
// Full license header bsp/efinix/EfxSapphireSocRV64/include/LICENSE.MD
 
#ifndef UART_H
#define UART_H

 
#include "type.h"
#include "io.h"
 
#ifdef __cplusplus
extern "C" {
#endif

 
 
/* ========================================================================== */
/* SUB-GROUP : Data Types                                                    */
/* ========================================================================== */
  
        typedef enum  { 
            BITS_6 = 6, 
            BITS_7 = 7, 
            BITS_8 = 8  
        } cfg_dataLength_t;
  
        typedef enum  { 
            NONE = 0,   
            EVEN = 1,   
            ODD = 2     
        } cfg_dataParity_t;

        typedef  enum { 
            ONE = 0,    
            TWO = 1     
        } cfg_stopBits_t;

 
/* ========================================================================== */
/* SUB-GROUP : DATA STRUCTS                                                     */
/* ========================================================================== */

    typedef volatile struct
    {
        u32 DATA;               
        u32 STATUS;             
        u32 CLOCK_DIVIDER;      
        u32 FRAME_CONFIG;       
    } uart_hwreg_t;

    typedef struct  
    {
        uart_hwreg_t            *hwreg;         
        cfg_dataLength_t        dataLength;     
        cfg_dataParity_t        parity;         
        cfg_stopBits_t          stop;           
        u32                     clockDivider;   
        u8                      irqn;           
    }uart_instance_t;
 // End of UART_Types group
 
 
/* ========================================================================== */
/* SUB-GROUP: FUNCTIONS                                                     */
/* ========================================================================== */


    u32 uart_read(uart_instance_t *inst);

    u32 uart_readStatus(uart_instance_t *inst);

    u32 uart_getReadOccupancy(uart_instance_t *inst);

    u32 uart_getWriteAvailability(uart_instance_t *inst);

    void uart_applyConfig (uart_instance_t *inst);
 

    void uart_write(uart_instance_t *inst, char data);

    void uart_writeStr(uart_instance_t *inst, const char* str);

    void uart_writeHex(uart_instance_t *inst, int value);
    void uart_writeStatus(uart_instance_t *inst, u32 data);

    void uart_setTxInterruptEnable(uart_instance_t *inst, char Ena);

    void uart_setRxInterruptEnable(uart_instance_t *inst, char Ena);
 // End of UART_Funcs group
#ifdef __cplusplus
}
#endif
 // End of MAIN UART Group
 
#endif // UART_H