PBV_interface.h

 
/* 
 * @file    PBV_interface.h   
 * @author  M70027
 * @ingroup   APP_PBV_INTERFACE
 * @brief   Power Board Visualizer application interface 
 */
 
#ifndef APP_PBV_INTERFACE_H
#define APP_PBV_INTERFACE_H
 
#include <xc.h> // include processor files - each processor file is guarded.  
#include "config/comms_config.h"
 
 
enum PBV_SIGNAL_ASCII_MODE 
{   
    PBV_SIGNAL_MODE    = 0,    
    PBV_ASCII_MODE     = 1     
} ;
 
 
enum PBV_MESSAGE_TX_STATE
{    
    PBV_MESSAGE_TRANSMITTED     = 0,    
    PBV_MESSAGE_INIT            = 1,    
    PBV_MESSAGE_TRANSMIT_START  = 2,    
    PBV_MESSAGE_TRANSMITTING    = 3,    
    PBV_MESSAGE_TX_ERROR        = 4    
};
typedef enum PBV_MESSAGE_TX_STATE PBV_MESSAGE_TX_STATE_t;
 
 
enum PBV_MESSAGE_RX_STATE
{
    PBV_MESSAGE_RECEIVED = 0,           
    PBV_MESSAGE_READY_TO_RECEIVE = 1,   
    PBV_STATE_RECEIVING = 2,            
    PBV_MESSAGE_RX_ERROR = 3           
};
typedef enum PBV_MESSAGE_RX_STATE PBV_MESSAGE_RX_STATE_t;
 
 
typedef void (*func_p)(uint16_t, uint8_t *);    
 
 
typedef struct { 
    uint16_t Length;                                
    uint32_t PBV_Protcol_ID;                        
    enum PBV_SIGNAL_ASCII_MODE  PBV_Signal_Ascii;   
    PBV_MESSAGE_TX_STATE_t  PBV_Message_State;      
    uint8_t * Data_Buffer;                          
}PBV_Datatype_TX_t;
 
 
typedef struct { 
    uint16_t Length;                                
    uint32_t PBV_Protcol_ID;                        
    func_p Callback_Function ;                      
    PBV_MESSAGE_RX_STATE_t  PBV_Message_State;      
    uint8_t * Data_Buffer;                          
}PBV_Datatype_RX_t;
 
void App_PBV_Init(PBV_Datatype_TX_t * system_to_PBV, PBV_Datatype_TX_t * system_To_PBV_Ascii, PBV_Datatype_RX_t *App_PBV_To_System_Ptr);
void App_Send_To_PBV (PBV_Datatype_TX_t * ptr);
void App_Receive_From_PBV(PBV_Datatype_RX_t * ptr);
int App_Read_Received_From_PBV(PBV_Datatype_RX_t * ptr);
 
void PBV_Change_from_Sixteen_to_Eight(uint16_t * sixteen_ptr, uint8_t * eight_ptr, uint16_t length);
void PBV_Change_from_Eight_to_Sixteen(uint8_t * eight_ptr, uint16_t * sixteen_ptr, uint16_t length);
 
void App_PBV_Task_10ms(void);
void App_PBV_Task_100us(void);
 
void App_PBV_Re_Init(PBV_Datatype_TX_t * ptr);
 
#endif  /*  APP_PBV_INTERFACE_H */