AVR Z-LINK®

serialPortHAL.h

Go to the documentation of this file.

/* This file has been prepared for Doxygen automatic documentation generation.*/
#ifndef SERIAL_PORT_HAL_H
#define SERIAL_PORT_HAL_H

#define UART
//#define FTDI

#if defined( UART ) && defined( FTDI )
        #error Only able to support UART or FTDI USB phy interface.
#endif

/* === Includes ============================================================ */
#include<stdbool.h>
#include<stdint.h>

#include "compiler.h"

#include"chat.h"

#ifdef UART
#include"usart.h"
#else
#include"ftdi.h"
#endif
/* ==== Macros ============================================================= */
#define RECEIVE_BUFFER_SIZE 64

#ifdef UART

#define RECEIVER_ON                     ENABLE_RECEIVE_COMPLETE_INTERRUPT
#define RECEIVER_OFF            DISABLE_RECEIVE_COMPLETE_INTERRUPT
#else

#define RECEIVER_ON                     FTDI_ENABLE_RECEIVER( )
#define RECEIVER_OFF            FTDI_DISABLE_RECEIVER( )
#endif

#define PARAMETER_DELIMITER ','
#define PARAMETER_PREAMBLE_A ':'
#define PARAMETER_PREAMBLE_B ' '
#define EOC_DELIMITER '\r'

#define NULL_PARAMETER ((unsigned char *)0)
/* === Typedefs ============================================================ */

typedef enum{
        
        SOC = 0x00,     //StartOfCommand.
        PARAM_PREAMBLE,         //": "
        COLLECT_PARAMETERS,
        EOC     //EndOfCommand.
}rxState_t;

typedef enum{
        
        NO_ERROR = 0x00,
        BUFFER_OVERFLOW,
        UNKNOWN_RX_STATE,
        UNKNOWN_SEQUENCE,
        UNKNOWN_EOC_SEQUENCE
}rxError_t;

typedef struct{

        #define LENGTH_OF_COMMAND 4
        unsigned char ATCommand[ LENGTH_OF_COMMAND + 1 ]; //+1 to store '\0' sequence.
        uint8_t rx_i;
        
        #define LENGTH_OF_PARAMETER_BUFFER 64
        #define NUMBER_OF_PARAMETERS 4
        unsigned char parameters[ LENGTH_OF_PARAMETER_BUFFER ];
        unsigned char *parameter[ NUMBER_OF_PARAMETERS ];
        uint8_t numberOfReceivedParameters;
        
        bool receptionComplete;
        rxError_t error;
}rxDataBlock_t;

typedef enum{
        PARAMETER_1     = 0x00,
        PARAMETER_2     = 0x01,
        PARAMETER_3     = 0x02
}paramter_t;
/* === Static Variables ==================================================== */
/* === Prototypes ========================================================== */
void sendString( const unsigned char *string );
void sendFlashString( const unsigned char __flash *string );
void sendOK( void );
void sendERROR( const chatError_t err );
void sendAssociationNotification( void );
void sendDisAssociationNotification( void );
void sendDataNotification( uint8_t length, unsigned char *data );
void serialInterfaceInitialization( void );
void rxReset( void );
unsigned char * getATCommand( void );
unsigned char * getParameterNumber( paramter_t parameterNumber );
rxError_t getError( void );
bool dataAvailable( void );

#ifdef UART
        ISR( USART0_RX_vect );
#else
        ISR( INT7_vect );
#endif
#endif