dev_iso_voltage_sense.h

/* Microchip Technology Inc. and its subsidiaries.  You may use this software 
 * and any derivatives exclusively with Microchip products. 
 * 
 * THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS".  NO WARRANTIES, WHETHER 
 * EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED 
 * WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A 
 * PARTICULAR PURPOSE, OR ITS INTERACTION WITH MICROCHIP PRODUCTS, COMBINATION 
 * WITH ANY OTHER PRODUCTS, OR USE IN ANY APPLICATION. 
 *
 * IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE, 
 * INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND 
 * WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS 
 * BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE.  TO THE 
 * FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS 
 * IN ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF 
 * ANY, THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.
 *
 * MICROCHIP PROVIDES THIS SOFTWARE CONDITIONALLY UPON YOUR ACCEPTANCE OF THESE 
 * TERMS. 
 */
 
// This is a guard condition so that contents of this file are not included
// more than once.  
#ifndef DEV_ISO_VOLTAGE_SENSE_H
#define DEV_ISO_VOLTAGE_SENSE_H
 
#include <xc.h> // include processor files - each processor file is guarded.  
#include <stdint.h>
#include <stdlib.h>
 
 
#include "input_capture/sccp2.h"
 
#define InputCapture_CallbackRegister   SCCP2_InputCapture_CallbackRegister     
#define InputCapture_bufferoverflow     SCCP2_InputCapture_HasBufferOverflowed  
#define InputCapture_BufferEmpty        SCCP2_InputCapture_IsBufferEmpty        
#define CCP_TIMER_HIGH_REG              CCP2TMRH                                
#define CCP_TIMER_LOW_REG               CCP2TMRL                                
#define CCP_INTERRUPT_FLAG              IFS1bits.CCP2IF                         
#define CCP_BUF_L                       CCP2BUFL                                
#define CCP_INPUT_CAPTURE_BUFFER        4                                       
 
 
//#define MAX_AVG_SHIFTING 6
//#define MAX_NUM_SAMPLES (1<<(MAX_AVG_SHIFTING))
 
#define MAX_NUM_SAMPLES_ISO_BUFFER                 128          
#define MAX_NUM_SAMPLES_ISO_BUFFER_AS_EXP_OF_TWO   7            
 
 
#define OV_THRESHOLD_VOLT       900                                               
#define OV_THRESHOLD_SCALING    0.282                                              
#define OV_THRESHOLD_RAW        (OV_THRESHOLD_VOLT / OV_THRESHOLD_SCALING )             
 
#define OV_THRESHOLD_HYST 140               
#define OV_THRESHOLD_HYST_HALF (OV_THRESHOLD_HYST/2) 
 
#define OV_UPPER_THRESHOLD_WITH_HYST  OV_THRESHOLD_RAW + OV_THRESHOLD_HYST_HALF
//#define OV_THRESHOLD_HYST 140    
#define OV_LOWER_THRESHOLD_WITH_HYST  OV_THRESHOLD_RAW - OV_THRESHOLD_HYST_HALF
 
#define UV_THRESHOLD_VOLT 500               
#define UV_THRESHOLD_SCALING 0.282                
#define UV_THRESHOLD_RAW  (UV_THRESHOLD_VOLT / UV_THRESHOLD_SCALING)              
 
#define UV_THRESHOLD_HYST 140               
#define UV_THRESHOLD_HYST_HALF (OV_THRESHOLD_HYST/2)
 
#define UV_UPPER_THRESHOLD_WITH_HYST  UV_THRESHOLD_RAW + UV_THRESHOLD_HYST_HALF
//#define UV_THRESHOLD_HYST 140    
#define UV_LOWER_THRESHOLD_WITH_HYST  UV_THRESHOLD_RAW - UV_THRESHOLD_HYST_HALF
        
 
 
#define INTERRUPT_COUNTS_MIN    6           
#define INTERRUPT_COUNTS_MAX    9           
#define FAULT_PERSISTENCE_COUNT  8          
 
 
typedef struct iso_voltage {
    uint8_t     error_flag;                 
    uint8_t     over_voltage_flag;          
    uint8_t     under_voltage_flag;         
    uint8_t     no_signal_flag;             
    uint16_t    voltage_raw;                
    uint16_t    voltage_averaged;           
    uint16_t    voltage_buffer[MAX_NUM_SAMPLES_ISO_BUFFER]; 
    uint16_t    voltage_buffer_idx;         
    uint8_t     buffer_full;                
    uint8_t     reset_buffer;               
} dev_iso_voltage_data_t;
 
 
extern dev_iso_voltage_data_t* dev_iso_voltage_data_ptr;
 
 
void Dev_Iso_Voltage_Sens_Init(void);
void Dev_Iso_Voltage_Task_1ms(void);
uint16_t Dev_Get_Iso_Voltage(void);     
uint16_t Dev_Get_Iso_Voltage_avg(void); 
uint8_t Dev_Iso_Voltage_Is_OV (void);   
uint8_t Dev_Iso_Voltage_Is_UV (void);   
void Dev_Reset_Average_Buffer(void);        
 
#endif  /* DEV_ISO_VOLTAGE_SENSE_H */
 
 
//inline uint16_t Dev_Get_Iso_Voltage_avg_inline (void) {
//    //if (dev_iso_voltage_data_ptr->buffer_full)
//    //{
//        uint16_t index = 0;
//        uint32_t sum = 0;
//        for (index = 0; index <MAX_NUM_SAMPLES; index++)
//            sum +=dev_iso_voltage_data_ptr->voltage_buffer[index];
//        return (sum >> MAX_NUM_SAMPLES_AS_EXP_OF_TWO);
//    //}
//    //else 
//    //    return 0;
//}
 
//inline uint16_t Dev_Get_Iso_Voltage_avg_inline (void){
//     if (dev_iso_voltage_data_ptr->buffer_full)
//        return Iso_Calculate_Average(dev_iso_voltage_data_ptr->voltage_buffer, MAX_NUM_SAMPLES);
//    else 
//        return 0;
//}