oc_uart.h

Go to the documentation of this file.

#ifndef INC_DRIVERS_UART_OC_UART_H_
#define INC_DRIVERS_UART_OC_UART_H_

#define DRIVER_HEADER
#define DRIVER_NAME                 UART

#include <oc_driver.h>
#include <oc_gpio.h>
#include <oc_stdlib.h>
#include <oc_ioctl.h>
#include <oc_uart_lld.h>

#define _________________________________________TYPES_SECTION______________________________________________________________________________

typedef enum
{
    oC_UART_WordLength_5Bits = oC_UART_LLD_WordLength_5Bits ,  
    oC_UART_WordLength_6Bits = oC_UART_LLD_WordLength_6Bits ,  
    oC_UART_WordLength_7Bits = oC_UART_LLD_WordLength_7Bits ,  
    oC_UART_WordLength_8Bits = oC_UART_LLD_WordLength_8Bits    
} oC_UART_WordLength_t;

typedef enum
{
    oC_UART_Parity_None  = oC_UART_LLD_Parity_None ,    
    oC_UART_Parity_Odd   = oC_UART_LLD_Parity_Odd ,     
    oC_UART_Parity_Even  = oC_UART_LLD_Parity_Even      
} oC_UART_Parity_t;

typedef enum
{
    oC_UART_StopBit_1Bit    = oC_UART_LLD_StopBit_1Bit    ,       
    oC_UART_StopBit_1p5Bits = oC_UART_LLD_StopBit_1p5Bits ,       
    oC_UART_StopBit_2Bits   = oC_UART_LLD_StopBit_2Bits           
} oC_UART_StopBit_t;

typedef enum
{
    oC_UART_BitOrder_LSBFirst = oC_UART_LLD_BitOrder_LSBFirst ,
    oC_UART_BitOrder_MSBFirst = oC_UART_LLD_BitOrder_MSBFirst  
} oC_UART_BitOrder_t;

typedef enum
{
    oC_UART_Invert_NotInverted = oC_UART_LLD_Invert_NotInverted ,
    oC_UART_Invert_Inverted    = oC_UART_LLD_Invert_Inverted     
} oC_UART_Invert_t;

typedef enum
{
    oC_UART_Dma_UseIfPossible ,
    oC_UART_Dma_AlwaysUse ,
    oC_UART_Dma_DontUse
} oC_UART_Dma_t;

typedef enum
{
    oC_UART_Mode_Both ,
    oC_UART_Mode_Output ,
    oC_UART_Mode_Input
} oC_UART_Mode_t;

typedef struct
{
    oC_Pins_t               Rx;
    oC_Pins_t               Tx;
    oC_UART_WordLength_t    WordLength;
    uint32_t                BitRate;
    oC_UART_Parity_t        Parity;
    oC_UART_StopBit_t       StopBit;
    oC_UART_BitOrder_t      BitOrder;
    oC_UART_Invert_t        Invert;
    oC_UART_Dma_t           Dma;
    bool                    Loopback;
} oC_UART_Config_t;

typedef struct Context_t * oC_UART_Context_t;

#undef  _________________________________________TYPES_SECTION______________________________________________________________________________

#define _________________________________________INTERFACE_FUNCTIONS_SECTION________________________________________________________________

extern oC_ErrorCode_t oC_UART_TurnOn                 ( void );
extern oC_ErrorCode_t oC_UART_TurnOff                ( void );
extern bool           oC_UART_IsTurnedOn             ( void );
extern oC_ErrorCode_t oC_UART_Configure              ( const oC_UART_Config_t * Config , oC_UART_Context_t * outContext );
extern oC_ErrorCode_t oC_UART_Unconfigure            ( const oC_UART_Config_t * Config , oC_UART_Context_t * outContext );
extern oC_ErrorCode_t oC_UART_Read                   ( oC_UART_Context_t Context , char * outBuffer , uint32_t * Size , oC_Time_t Timeout );
extern oC_ErrorCode_t oC_UART_Write                  ( oC_UART_Context_t Context , const char * Buffer , uint32_t * Size , oC_Time_t Timeout );
extern oC_ErrorCode_t oC_UART_Ioctl                  ( oC_UART_Context_t Context , oC_Ioctl_Command_t Command , void * Data );
extern oC_ErrorCode_t oC_UART_Disable                ( oC_UART_Context_t Context );
extern oC_ErrorCode_t oC_UART_Enable                 ( oC_UART_Context_t Context );

#undef  _________________________________________INTERFACE_FUNCTIONS_SECTION________________________________________________________________



#endif /* INC_DRIVERS_UART_OC_UART_H_ */