vac_monitor_typedef.h

Go to the documentation of this file.

 
/*
    (c) 2022 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 VAC_MONITOR_DEVICE_DRIVER_TYPEDEF_H
#define VAC_MONITOR_DEVICE_DRIVER_TYPEDEF_H
 
#include <xc.h> // include processor files - each processor file is guarded. 
#include <stdint.h> // include standard intger data type header file
#include <stdbool.h> // include standard boolean data type header file
#include <dsp.h> // include standard DSP data type declarations header files
 
 
struct VACM_STATUS_s
{
    union {
        struct{                      
            bool ac_drop          : 1; 
            bool dc_mode          : 1; 
            bool ac_ok            : 1; 
            bool zero_cross       : 1; 
            bool polarity_pos     : 1; 
            bool end_of_cycle     : 1; 
            bool slope_pos        : 1; 
                       
            unsigned              : 1; 
            unsigned              : 1; 
            unsigned              : 1; 
            unsigned              : 1; 
            unsigned              : 1; 
            unsigned              : 1; 
            unsigned              : 1; 
            unsigned              : 1; 
            unsigned              : 1; 
        } __attribute__((packed)) bits; // data structure for single bit addressing operations
 
        volatile uint16_t value; // buffer for 16-bit word read/write operations
    };
};   
typedef struct VACM_STATUS_s VACM_STATUS_t; 
 
 
struct VACM_FAULT_s
{
    union {
        struct{
            bool ov         : 1; 
            bool uv         : 1; 
            bool fmin       : 1; 
            bool fmax       : 1; 
            bool zc_timeout : 1; 
          
            unsigned        : 1; 
            unsigned        : 1; 
            unsigned        : 1; 
            unsigned        : 1; 
            unsigned        : 1; 
            unsigned        : 1; 
            unsigned        : 1; 
            unsigned        : 1; 
            unsigned        : 1; 
            unsigned        : 1; 
            unsigned        : 1; 
        } __attribute__((packed)) bits; // data structure for single bit addressing operations
 
        uint16_t value; // buffer for 16-bit word read/write operations
    };
};   
typedef struct VACM_FAULT_s VACM_FAULT_t; 
 
 
struct VACM_VIN_s
{
    uint16_t* ptr_adcbuf;    
    uint16_t raw;            
    uint16_t raw_prev;       
    uint16_t rectified;      
    int16_t*  ptr_offset;    
    uint16_t avg;            
    uint16_t avg_prev;       
    uint16_t avg_sqrd;       
    uint16_t vloop_ff;       
};
typedef struct VACM_VIN_s VACM_VIN_t;
 
 
struct VACM_AVGCALC_BUFFER_s
{
    uint16_t counter;       
    uint16_t counter_reset; 
    uint32_t acc;           
};
typedef struct VACM_AVGCALC_BUFFER_s VACM_AVGCALC_BUFFER_t;
 
 
struct VACM_TIMEBASE_s
{
    uint16_t half_cycle;  
    uint16_t half_cycle_timer;  
    uint16_t startup_counter; 
    uint16_t zero_cross_timer; 
    uint16_t ac_drop_timer;   
    uint16_t vin_present_counter; 
    uint16_t dc_present_counter;  
    uint16_t dc_loss_counter;  
};
typedef struct VACM_TIMEBASE_s VACM_TIMEBASE_t;
 
 
 
enum VACM_STATES_e 
{       
    VACM_STATE_STANDBY        = 0x00, 
    VACM_STATE_DCDETECT       = 0x01, 
    VACM_STATE_DCMODE         = 0x02, 
    VACM_STATE_WAIT_ZC        = 0x03, 
    VACM_STATE_ACSYNC         = 0x04, 
    VACM_STATE_ONLINE         = 0x05, 
    VACM_STATE_ACDROP         = 0x06  
    
}; 
typedef enum VACM_STATES_e VACM_STATES_t; 
 
 
struct VACM_s
{
    VACM_STATES_t state;             
    VACM_STATUS_t status;            
    VACM_FAULT_t fault;              
    VACM_TIMEBASE_t timebase;        
    VACM_VIN_t vin;                  
    VACM_AVGCALC_BUFFER_t avgcalc_buffer; 
};
typedef struct VACM_s VACM_t;
 
 
#endif  /* VAC_MONITOR_DEVICE_DRIVER_TYPEDEF_H */