UART.h

Go to the documentation of this file.

//*****************************************************************************
// UART.h
//
//
//
//
//*****************************************************************************
//*****************************************************************************
//*****************************************************************************

#ifndef UARTDRIVER_H_
#define UARTDRIVER_H_

#include "UART_Definitions.h"

#if (UART__ENABLE==true)

//*****************************************************************************
//
//
//
//*****************************************************************************
#if (UART__EUSCI_A_PERIPHERAL == EUSCI_A0_BASE)
#define UART__EUSCI_VECTOR      (USCI_A0_VECTOR)
#define UART__EUSCI_IV                  (UCA0IV)
#elif (UART__EUSCI_A_PERIPHERAL == EUSCI_A1_BASE)
#define UART__EUSCI_VECTOR      (USCI_A1_VECTOR)
#define UART__EUSCI_IV                  (UCA1IV)
#else
#error INVALID_EUSCI_A_SELECTION
#endif

//*****************************************************************************
//
//
//*****************************************************************************
#define UART__ERROR_MASK                (0x60)

//*****************************************************************************
//
//
//*****************************************************************************
typedef struct
{
        //
        //
        bool (*pbReceiveCallback)(uint8_t);

        //
        //
        bool (*pbErrorCallback)(uint8_t);

        //
        //
        EUSCI_A_UART_initParam peripheralParameters;

} tUARTPort;

//*****************************************************************************
//
//
//*****************************************************************************
enum tUARTStates {
        eUARTIsClosed,
        eUARTIsIdle,
        eUARTIsTransmitting
};

//*****************************************************************************
//
//
//*****************************************************************************
enum tUARTErrors {
        eUARTFramingError = 0x40,
        eUARTOverrunError = 0x20
};

//*****************************************************************************
//
//
//
//*****************************************************************************
extern void UART_openPort(const tUARTPort *pPort);

//*****************************************************************************
//
//
//
//*****************************************************************************
extern void UART_closePort(void);

//*****************************************************************************
//
//
//
//*****************************************************************************
extern uint8_t UART_getPortStatus(void);

//*****************************************************************************
//
//
//
//*****************************************************************************
extern void UART_transmitBuffer(const uint8_t *pBuffer, uint16_t ui16Length);

//*****************************************************************************
//
//
//
//*****************************************************************************
extern void UART_transmitByteImmediately(uint8_t ui8Data);

#endif /* UART__ENABLE==true */

#endif /* UARTDRIVER_H_ */
//*****************************************************************************
//*****************************************************************************