UART1.h

Go to the documentation of this file.

#ifndef UART1_H_
#define UART1_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: uart1 rx and tx buffer
#include "Interrupts.h"         // due to: Interrupts_setUSCI1RX_ISRCallbackFunction and Interrupts_setUSCI1TX_ISRCallbackFunction

/********************************************************************************************************
 *  UART calculations:
 * 
 *  UART speed is 9600 baud =  1/9600 =9.6*10^-6 = 10us  (The elapsed time between two received bit)
 *  Byte contains 10 bit with the stop and start bit so ~100 us the elapsed time between 2 received byte)
 *  MCU clk = 16 MHz = 16 * 10^6 intsuction in one sec
 *  -> 1 instruction time is = 0.0625 * 10^-6 = 62.5 * 10^-9 -> 62.5 ns
 * 
 * Consecvencies
 *  
 *  100*10^3 / 62.5 = 1600 instructions can be done bye the MCU between two character has been received.
 * 
 * 
 * ******************************************************************************************************/

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

// Size definitions of the used uart receive and transfer buffer
#define UART1_RX_BUFFER_SIZE 16
#define UART1_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 (*tpfUART1AppendResponseCallbackFunction) (const char*);

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

extern tBoolean ge_tbUART1RXITFLAG;     

extern tBoolean ge_tbUART1TXITFLAG;     

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

#define UART1_TX_BUFFER_USED                        (FIFO_getBufferCount(&g_uiUart1TxReadIndex,\
                                                    &g_uiUart1TxWriteIndex,\
                                                    UART1_TX_BUFFER_SIZE))
                            
#define UART1_TX_BUFFER_FREE                        (UART1_TX_BUFFER_SIZE - UART1_TX_BUFFER_USED)


#define UART1_TX_BUFFER_EMPTY                       (FIFO_isBufferEmpty(&g_uiUart1TxReadIndex,\
                                                    &g_uiUart1TxWriteIndex))                        

#define UART1_TX_BUFFER_FULL                        (FIFO_isBufferFull(&g_uiUart1TxReadIndex,\
                                                    &g_uiUart1TxWriteIndex,\
                                                    UART1_TX_BUFFER_SIZE))

#define UART1_ADVANCE_TX_BUFFER_INDEX(Index)        ((Index) = ((Index) + 1) % UART1_TX_BUFFER_SIZE)


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

#define UART1_RX_BUFFER_USED                        (FIFO_getBufferCount(&g_uiUart1RxReadIndex,\
                                                    &g_uiUart1RxWriteIndex,\
                                                    UART1_RX_BUFFER_SIZE))
   
#define UART1_RX_BUFFER_FREE                        (UART1_RX_BUFFER_SIZE - UART1_RX_BUFFER_USED)


#define UART1_RX_BUFFER_EMPTY                       (FIFO_isBufferEmpty(&g_uiUart1RxReadIndex,\
                                                    &g_uiUart1RxWriteIndex))
    
#define UART1_RX_BUFFER_FULL                        (FIFO_isBufferFull(&g_uiUart1RxReadIndex,\
                                                    &g_uiUart1RxWriteIndex, \
                                                    UART1_RX_BUFFER_SIZE))

#define UART1_ADVANCE_RX_BUFFER_INDEX(Index)        ((Index) = ((Index) + 1) % UART1_RX_BUFFER_SIZE)

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

void UART1_rxHandler( void );


void UART1_txHandler( void );


void UART1_initUART1( void );


int UART1_read( void );


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


void UART1_sendChar( void );


tBoolean UART1_isWritingDone( void );


void UART1_primeTransmit( void );


void UART1_flushRx( void );


void UART1_flushTx( void );


void UART1_setAppendResponseCallbackFunction( tpfUART1AppendResponseCallbackFunction pfCallbackAppendResponse );


#endif /*UART1_H_*/