dev_buck_special_functions.c

/*
 * File:   dev_buck_special_functions.c
 * Author: M91406
 *
 * Created on December 3, 2020, 10:14 AM
 */
 
#include <xc.h> // include processor files - each processor file is guarded.  
#include <stdint.h> // include standard integer data types
#include <stdbool.h> // include standard boolean data types
#include <stddef.h> // include standard definition data types
 
#include "xc16_pral.h" // include peripheral register abstraction layer drivers
#include "dev_buck_typedef.h" // include buck converter type definitions
#include "dev_buck_special_functions.h" // include buck converter special function defiition
 
 
struct CS_CALIBRATION_s 
{
    bool start;
    bool stop;
    volatile uint16_t counter;
    volatile uint32_t buffer;
};
typedef struct CS_CALIBRATION_s CS_CALIBRATION_t;
 
 
volatile struct CS_CALIBRATION_s calib_cs[BUCK_MPHASE_COUNT];
 
 
// Current Sense
#define CS_CALIB_STEPS  8
 
 
// Private function prototypes of sub-state function calls
 
volatile uint16_t CurrentSenseOffsetCalibration(volatile struct BUCK_CONVERTER_s *buckInstance);
 
 
volatile uint16_t (*BuckConverterSpecialFunctions[])
                        (volatile struct BUCK_CONVERTER_s *buckInstance) = 
{
    CurrentSenseOffsetCalibration 
};
 
 
 
volatile uint16_t drv_BuckConverter_SpecialFunctionExecute(
        volatile struct BUCK_CONVERTER_s * buckInstance, 
        volatile enum BUCK_SPECIAL_FUNCTIONS_e specialFunction
        ) 
{
    volatile uint16_t retval=0;
    
    /*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
    /* NULL POINTER PROTECTION                                                            */
    /*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
    // If no buck instance has been declared, leave here
    if(buckInstance == NULL)
        return(0);
 
    /*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
    /* CALL SPECIAL FUNCTION                                                              */
    /*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
    retval = BuckConverterSpecialFunctions[specialFunction](buckInstance);
    
    return(retval);
 
} 
 
/* *****************************************************************************
 * PRIVATE FUNCTIONS
 * ****************************************************************************/
 
 
volatile uint16_t CurrentSenseOffsetCalibration(volatile struct BUCK_CONVERTER_s *buckInstance) 
{
    volatile uint16_t _i=0;
    volatile bool _complete=true;
    volatile enum BUCK_OPSTATE_RETURNS_e retval = BUCK_OPSRET_ERROR;
 
    // if current sense calibration is disabled, return COMPLETE and leave
    if(!buckInstance->status.bits.cs_calib_enable)
    {
        return((uint16_t)BUCK_OPSRET_COMPLETE); // Set return value to COMPLETE and leave function
    }
 
    // Protect against floored Current Calibration Procedure
    if ((!buckInstance->status.bits.adc_active) ||
        (!buckInstance->status.bits.pwm_active)
       )
    { return((uint16_t)BUCK_OPSRET_REPEAT); } // Return REPEAT
        
    
    // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    // Perform Calibration Step
    
    for(_i = 0; _i<buckInstance->set_values.no_of_phases; _i++)
    {
        // Reset Calibration Data Buffers if Calibration is rerun
        if ((calib_cs[_i].start && calib_cs[_i].stop))
        {
            // Clear calibration data buffer
            calib_cs[_i].buffer = 0; // Clear buffer
            calib_cs[_i].counter = 0; // Clear counter
            calib_cs[_i].start = false; // Clear START flag bit
            calib_cs[_i].stop = false; // Clear STOP flag bit
        }
 
        // Collect data samples
        if (calib_cs[_i].counter++ < CS_CALIB_STEPS)
        {
            calib_cs[_i].start = true; // Clear START flag bit
            calib_cs[_i].stop = false; // Clear STOP flag bit
            calib_cs[_i].buffer += buckInstance->data.i_sns[_i]; // Read ADC offset value
        }
        // Collection of data samples is complete
        else
        {
            calib_cs[_i].buffer >>= 3; // Divide accumulated ADC samples (calculate average)
            calib_cs[_i].stop = true;  // Set STOP flag bit
 
            // Write calibration data to buck converter data structure
            buckInstance->i_loop[_i].feedback_offset = calib_cs[_i].buffer;
 
        }
        
        _complete &= calib_cs[_i].stop; // track STOP flag bits
    }
 
    // Return REPEAT until calibration is complete
    if (_complete)
        retval = (uint16_t)BUCK_OPSRET_COMPLETE; // Return COMPLETE
    else
        retval = (uint16_t)BUCK_OPSRET_REPEAT; // Return REPEAT
    
    return(retval);
    
}  
 
// end of file