v_loop.h

/* *********************************************************************************
 * PowerSmart™ Digital Control Library Designer, Version 0.9.14.678
 * *********************************************************************************
 * 2p2z controller function declarations and compensation filter coefficients
 * derived for following operating conditions:
 * *********************************************************************************
 *
 *  Controller Type:    2P2Z - Basic Current Mode Compensator
 *  Sampling Frequency: 500000 Hz
 *  Fixed Point Format: Q15
 *  Scaling Mode:       4 - Fast Floating Point Coefficient Scaling
 *  Input Gain:         0.5
 *
 * *********************************************************************************
 * CGS Version:         3.0.8
 * CGS Date:            03/12/2021
 * *********************************************************************************
 * User:                M91406
 * Date/Time:           04/25/2021 13:39:05
 * ********************************************************************************/
 
// This is a guard condition so that contents of this file are not included
// more than once.
#ifndef __SPECIAL_FUNCTION_LAYER_V_LOOP_H__
#define __SPECIAL_FUNCTION_LAYER_V_LOOP_H__
 
#include <xc.h>                                   // include processor files - each processor file is guarded
#include <dsp.h>                                  // include DSP data types (e.g. fractional)
#include <stdint.h>                               // include standard integer number data types
#include <stdbool.h>                              // include standard boolean data types (true/false)
 
#include "npnz16b.h"                              // include NPNZ library header file
 
/* *******************************************************************************
 * Data Arrays:
 * The NPNZ16b_s data structure contains pointers to coefficient, control and error
 * history arrays. The pointer target objects (variables and arrays) are defined
 * in controller source file v_loop.c
 *
 * Type definitions for A- and B- coefficient arrays as well as error- and control
 * history arrays are aligned in memory using the 'packed' attribute for optimized
 * addressing during DSP computations. These aligned data structures need to be
 * placed in specific memory locations to allow direct X/Y-access from the DSP.
 * This X/Y-memory placement is covered by the declarations used in controller
 * source file v_loop.c
 * ******************************************************************************/
 
 
struct V_LOOP_CONTROL_LOOP_COEFFICIENTS_s
{
    volatile int32_t ACoefficients[2];            // A-Coefficients
    volatile int32_t BCoefficients[3];            // B-Coefficients
} __attribute__((packed));                        // Data structure packing A- and B- coefficient arrays in a linear memory space for optimized DSP code execution
typedef struct V_LOOP_CONTROL_LOOP_COEFFICIENTS_s V_LOOP_CONTROL_LOOP_COEFFICIENTS_t;
 
 
struct V_LOOP_CONTROL_LOOP_HISTORIES_s
{
    volatile fractional ControlHistory[2];        // Control History Array
    volatile fractional ErrorHistory[3];          // Error History Array
} __attribute__((packed));                        // Data structure packing control and error histories arrays in a linear memory space for optimized DSP code execution
typedef struct V_LOOP_CONTROL_LOOP_HISTORIES_s V_LOOP_CONTROL_LOOP_HISTORIES_t; // Data type of data structure packing control and error histories arrays
 
 
extern volatile int16_t v_loop_pterm_factor;      // Q15 fractional of the P-Term factor
 
 
extern volatile int16_t v_loop_pterm_scaler;      // Bit-shift scaler of the P-Term factor
 
 
 
extern volatile struct NPNZ16b_s v_loop;          // user-controller data object
 
 
/* *******************************************************************************
 * Function call prototypes for initialization routines and control loop handling
 * ******************************************************************************/
 
 
extern volatile uint16_t v_loop_Initialize(       // v_loop initialization function call
        volatile struct NPNZ16b_s* controller     // Pointer to NPNZ16b data object
    );
 
 
extern void v_loop_Reset(                         // v_loop reset function call (Assembly)
        volatile struct NPNZ16b_s* controller     // Pointer to NPNZ16b data object
    );
 
 
extern void v_loop_Precharge(                     // v_loop history pre-charge function call (Assembly)
        volatile struct NPNZ16b_s* controller,    // Pointer to NPNZ16b data object
        volatile fractional ctrl_input,           // user-defined, constant error history value
        volatile fractional ctrl_output           // user-defined, constant control output history value
    );
 
 
extern void v_loop_Update(                        // Calls the 2P2Z controller (Assembly)
        volatile struct NPNZ16b_s* controller     // Pointer to NPNZ16b data object
    );
 
 
extern void v_loop_PTermUpdate(                   // Calls the P-Term controller (Assembly)
        volatile struct NPNZ16b_s* controller     // Pointer to NPNZ16b data object
    );
 
#endif                                            // end of __SPECIAL_FUNCTION_LAYER_V_LOOP_H__
 
 
//**********************************************************************************
// Download latest version of this tool here: https://microchip-pic-avr-tools.github.io/powersmart-dcld/
//**********************************************************************************