UART2.h

Go to the documentation of this file.

#ifndef UART2_H_
#define UART2_H_


#include <string.h>             // due to: using predefinition of NULL
#include <stdlib.h>             // due to: calloc function

#include "msp430f2617.h"        
#include "Bitmanip.h"           // due to: the bit manipulations macros
#include "FIFO.h"               // due to: uart2 rx and tx buffer
#include "Interrupts.h"         // due to: rx and tx interrupts 


//*****************************************************************************
//
// Types and Definitions
//
//*****************************************************************************

#define UART2_RX_BUFFER_SIZE 16

#define UART2_TX_BUFFER_SIZE 16


#ifndef DEFINE_TBOOLEAN                 // define unsigned char as tBoolean in only that case when it hasn't been defined yet somewhere else in the scope

typedef unsigned char tBoolean;         // use as bool
#define DEFINE_TBOOLEAN

#endif                                  // DEFINE_TBOOLEAN


typedef void (*tpfUART2AppendResponseCallbackFunction) (const char*);

//*****************************************************************************
//
// Globale variables
//
//*****************************************************************************

extern tBoolean ge_tbUART2RXITFLAG;     

extern tBoolean ge_tbUART2TXITFLAG;     

//*****************************************************************************
//
// Macros to determine number of free and used bytes in the transmit buffer.
//
//*****************************************************************************

#define UART2_TX_BUFFER_USED                        (FIFO_getBufferCount(&g_uiUart2TxReadIndex,\
                                                    &g_uiUart2TxWriteIndex,\
                                                    UART2_TX_BUFFER_SIZE))
                            

#define UART2_TX_BUFFER_FREE                        (UART2_TX_BUFFER_SIZE - UART2_TX_BUFFER_USED)


#define UART2_TX_BUFFER_EMPTY                       (FIFO_isBufferEmpty(&g_uiUart2TxReadIndex,\
                                                    &g_uiUart2TxWriteIndex))                        

                                                    
#define UART2_TX_BUFFER_FULL                        (FIFO_isBufferFull(&g_uiUart2TxReadIndex,\
                                                    &g_uiUart2TxWriteIndex,\
                                                    UART2_TX_BUFFER_SIZE))
 
 
#define UART2_ADVANCE_TX_BUFFER_INDEX(Index)        ((Index) = ((Index) + 1) % UART2_TX_BUFFER_SIZE)


//*****************************************************************************
//
// Macros to determine number of free and used bytes in the receive buffer.
//
//*****************************************************************************


#define UART2_RX_BUFFER_USED                        (FIFO_getBufferCount(&g_uiUart2RxReadIndex,\
                                                    &g_uiUart2RxWriteIndex,\
                                                    UART2_RX_BUFFER_SIZE))
      

#define UART2_RX_BUFFER_FREE                        (UART2_RX_BUFFER_SIZE - UART2_RX_BUFFER_USED)


#define UART2_RX_BUFFER_EMPTY                       (FIFO_isBufferEmpty(&g_uiUart2RxReadIndex,\
                                                    &g_uiUart2RxWriteIndex))
                                                    
                                                    
#define UART2_RX_BUFFER_FULL                        (FIFO_isBufferFull(&g_uiUart2RxReadIndex,\
                                                    &g_uiUart2RxWriteIndex, \
                                                    UART2_RX_BUFFER_SIZE))

                                                    
#define UART2_ADVANCE_RX_BUFFER_INDEX(Index)        ((Index) = ((Index) + 1) % UART2_RX_BUFFER_SIZE)

//*****************************************************************************
//
// Function declarations
//
//*****************************************************************************

void UART2_rxHandler( void );


void UART2_txHandler( void );


void UART2_initUART2( void );


int UART2_read( void );


int UART2_write( char* pcBuffer, unsigned int uiLength );


void UART2_sendChar( void );


tBoolean UART2_isWritingDone( void );


void UART2_primeTransmit( void );


void UART2_flushRx( void );


void UART2_flushTx( void );


void UART2_setAppendResponseCallbackFunction( tpfUART2AppendResponseCallbackFunction pfCallbackAppendResponse );

#endif /*UART2_H_*/