dpsk3-power-buck-voltage-mode-control/a00299_source.html

/* *********************************************************************************

 * PowerSmart™ Digital Control Library Designer, Version 0.9.12.672

 * *********************************************************************************

 * Generic library header for z-domain compensation filter assembly functions

 * CGS Version: 3.0.7

 * CGS Date:    03/07/2021

 * ********************************************************************************/

// This is a guard condition so that contents of this file are not included

// more than once.

#ifndef __SPECIAL_FUNCTION_LAYER_LIB_NPNZ16B_H__

#define __SPECIAL_FUNCTION_LAYER_LIB_NPNZ16B_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 <stddef.h>                               // include standard definition data types

#include <stdbool.h>                              // include standard boolean data types (true/false)


#ifndef __PSDCLD_VERSION

    #define __PSDCLD_VERSION    912

#endif


enum NPNZ_STATUS_FLAGS_e

{

    NPNZ_STATUS_CLEAR            = 0b0000000000000000,

    NPNZ_STATUS_SATUATION_MSK    = 0b0000000000000011,

    NPNZ_STATUS_LSAT_ACTIVE      = 0b0000000000000001,

    NPNZ_STATUS_LSAT_CLEAR       = 0b0000000000000000,

    NPNZ_STATUS_USAT_ACTIVE      = 0b0000000000000010,

    NPNZ_STATUS_USAT_CLEAR       = 0b0000000000000000,

    NPNZ_STATUS_AGC_DISABLE      = 0b0000000000000000,

    NPNZ_STATUS_AGC_ENABLED      = 0b0000100000000000,

    NPNZ_STATUS_TARGET_DEFAULT   = 0b0000000000000000,

    NPNZ_STATUS_TARGET_SWAPED    = 0b0001000000000000,

    NPNZ_STATUS_SOURCE_DEFAULT   = 0b0000000000000000,

    NPNZ_STATUS_SOURCE_SWAPED    = 0b0010000000000000,

    NPNZ_STATUS_INV_INPUT_OFF    = 0b0000000000000000,

    NPNZ_STATUS_INV_INPUT_ON     = 0b0100000000000000,

    NPNZ_STATUS_ENABLE_OFF       = 0b0000000000000000,

    NPNZ_STATUS_ENABLE_ON        = 0b1000000000000000

};

typedef enum NPNZ_STATUS_FLAGS_e NPNZ_STATUS_FLAGS_t;


enum NPNZ_STATUS_SATURATION_e{

    NPNZ_SAT_CLEAR  = 0b0,

    NPNZ_SAT_ACTIVE = 0b1

};

typedef enum NPNZ_STATUS_SATURATION_e NPNZ_STATUS_SATURATION_t;

extern volatile enum NPNZ_STATUS_SATURATION_e npnzEnumControlStatusSaturation;


/* Control flags (bit-field) */


enum NPNZ_STATUS_AGC_ENABLE_e{

    NPNZ_AGC_DISABLED = 0b0,

    NPNZ_AGC_ENABLED  = 0b1

};

typedef enum NPNZ_STATUS_AGC_ENABLE_e NPNZ_STATUS_AGC_ENABLE_t;

extern volatile enum NPNZ_STATUS_AGC_ENABLE_e npnzEnumControlAgcEnable;


enum NPNZ_STATUS_SOURCE_SWAP_e{

    NPNZ_SOURCE_DEFAULT = 0b0,

    NPNZ_SOURCE_SWAPED  = 0b1

};

typedef enum NPNZ_STATUS_SOURCE_SWAP_e NPNZ_STATUS_SOURCE_SWAP_t;

extern volatile enum NPNZ_STATUS_SOURCE_SWAP_e npnzEnumControlSourceSwap;


enum NPNZ_STATUS_TARGET_SWAP_e{

    NPNZ_TARGET_DEFAULT = 0b0,

    NPNZ_TARGET_SWAPED  = 0b1

};

typedef enum NPNZ_STATUS_TARGET_SWAP_e NPNZ_STATUS_TARGET_SWAP_t;

extern volatile enum NPNZ_STATUS_TARGET_SWAP_e npnzEnumControlTargetSwap;


enum NPNZ_STATUS_INPUT_INV_e{

    NPNZ_INPUT_DEFAULT  = 0b0,

    NPNZ_INPUT_INVERTED = 0b1

};

typedef enum NPNZ_STATUS_INPUT_INV_e NPNZ_STATUS_INPUT_INV_t;

extern volatile enum NPNZ_STATUS_INPUT_INV_e npnzEnumControlInputInversion;


enum NPNZ_STATUS_ENABLE_e{

    NPNZ_DISABLED = 0b0,

    NPNZ_ENABLED  = 0b1

};

typedef enum NPNZ_STATUS_ENABLE_e NPNZ_STATUS_ENABLE_t;

extern volatile enum NPNZ_STATUS_ENABLE_e npnzEnumControlEnable;


struct NPNZ_FLAGS_s

{

    volatile enum NPNZ_STATUS_FLAGS_e       StatusWordFlags;

    volatile enum NPNZ_STATUS_SATURATION_e  flagSaturation;

    volatile enum NPNZ_STATUS_AGC_ENABLE_e  flagAgcControl;

    volatile enum NPNZ_STATUS_SOURCE_SWAP_e flagSourceSwap;

    volatile enum NPNZ_STATUS_TARGET_SWAP_e flagTargetSwap;

    volatile enum NPNZ_STATUS_INPUT_INV_e   flagCtrlInputInversion;

    volatile enum NPNZ_STATUS_ENABLE_e      flagControlEnable;

};

typedef struct NPNZ_FLAGS_s NPNZ_FLAGS_t;

extern volatile struct NPNZ_FLAGS_s npnzFlagList;


/* Controller status data structure */

struct NPNZ_STATUS_s {

    union {

    struct {

        volatile bool lower_saturation_event : 1;

        volatile bool upper_saturation_event : 1;

        volatile unsigned : 1;

        volatile unsigned : 1;

        volatile unsigned : 1;

        volatile unsigned : 1;

        volatile unsigned : 1;

        volatile unsigned : 1;


        volatile unsigned : 1;

        volatile unsigned : 1;

        volatile unsigned : 1;

        volatile bool agc_enabled: 1;

        volatile bool swap_target: 1;

        volatile bool swap_source: 1;

        volatile bool invert_input: 1;

        volatile bool enabled : 1;

    } __attribute__((packed))bits;

    volatile uint16_t value;

    };

} __attribute__((packed));

typedef struct NPNZ_STATUS_s NPNZ_STATUS_t;


/* Controller Input/Output Port */

struct NPNZ_PORT_s{


    volatile uint16_t* ptrAddress;

    volatile int16_t   NormScaler;

    volatile fractional NormFactor;

    volatile int16_t   Offset;


} __attribute__((packed));

typedef struct NPNZ_PORT_s NPNZ_PORT_t;


/* List of Controller Input/Output Ports */

struct NPNZ_PORTS_s{


    volatile struct NPNZ_PORT_s Source;

    volatile struct NPNZ_PORT_s AltSource;

    volatile struct NPNZ_PORT_s Target;

    volatile struct NPNZ_PORT_s AltTarget;

    volatile uint16_t* ptrControlReference;


} __attribute__((packed));

typedef struct NPNZ_PORTS_s NPNZ_PORTS_t;


struct NPNZ_FILTER_PARAMS_s{


    volatile int32_t* ptrACoefficients;

    volatile int32_t* ptrBCoefficients;

    volatile fractional* ptrControlHistory;

    volatile fractional* ptrErrorHistory;


    // Array size information

    volatile uint16_t ACoefficientsArraySize;

    volatile uint16_t BCoefficientsArraySize;

    volatile uint16_t ControlHistoryArraySize;

    volatile uint16_t ErrorHistoryArraySize;


    // Feedback scaling Input/Output Normalization

    volatile int16_t normPreShift;

    volatile int16_t normPostShiftA;

    volatile int16_t normPostShiftB;

    volatile int16_t normPostScaler;


    // P-Term Coefficients (for plant measurements only)

    volatile int16_t PTermScaler;

    volatile int16_t PTermFactor;


} __attribute__((packed));

typedef struct NPNZ_FILTER_PARAMS_s NPNZ_FILTER_PARAMS_t;


struct NPNZ_LIMITS_s{


    volatile int16_t MinOutput;

    volatile int16_t MaxOutput;

    volatile int16_t AltMinOutput;

    volatile int16_t AltMaxOutput;


} __attribute__((packed));

typedef struct NPNZ_LIMITS_s  NPNZ_LIMITS_t;


struct NPNZ_ADC_TRGCTRL_s{


    volatile uint16_t* ptrADCTriggerARegister;

    volatile uint16_t ADCTriggerAOffset;

    volatile uint16_t* ptrADCTriggerBRegister;

    volatile uint16_t ADCTriggerBOffset;


} __attribute__((packed));

typedef struct NPNZ_ADC_TRGCTRL_s NPNZ_ADC_TRGCTRL_t;


struct NPNZ_DATA_PROVIDERS_s{


    volatile uint16_t* ptrDProvControlInput;

    volatile uint16_t* ptrDProvControlInputCompensated;

    volatile uint16_t* ptrDProvControlError;

    volatile uint16_t* ptrDProvControlOutput;


} __attribute__((packed));

typedef struct NPNZ_DATA_PROVIDERS_s NPNZ_DATA_PROVIDERS_t;


struct NPNZ_EXTENSION_HOOKS_s{


    volatile uint16_t ptrExtHookStartFunction;

    volatile uint16_t ExtHookStartFunctionParam;


    volatile uint16_t ptrExtHookSourceFunction;

    volatile uint16_t ExtHookSourceFunctionParam;


    volatile uint16_t ptrExtHookPreAntiWindupFunction;

    volatile uint16_t ExtHookPreAntiWindupFunctionParam;


    volatile uint16_t ptrExtHookTargetFunction;

    volatile uint16_t ExtHookTargetFunctionParam;


    volatile uint16_t ptrExtHookStopFunction;

    volatile uint16_t ExtHookStopFunctionParam;


    volatile uint16_t ptrExtHookEndFunction;

    volatile uint16_t ExtHookEndFunctionParam;


} __attribute__((packed));

typedef struct NPNZ_EXTENSION_HOOKS_s NPNZ_EXTENSION_HOOKS_t;


struct NPNZ_GAIN_CONTROL_s{


    volatile uint16_t AgcScaler;

    volatile fractional AgcFactor;

    volatile fractional AgcMedian;

    volatile uint16_t ptrAgcObserverFunction;


} __attribute__((packed));

typedef struct NPNZ_GAIN_CONTROL_s NPNZ_GAIN_CONTROL_t;


struct NPNZ_USER_DATA_BUFFER_s{


    volatile uint16_t usrParam0;

    volatile uint16_t usrParam1;

    volatile uint16_t usrParam2;

    volatile uint16_t usrParam3;

    volatile uint16_t usrParam4;

    volatile uint16_t usrParam5;

    volatile uint16_t usrParam6;

    volatile uint16_t usrParam7;


} __attribute__((packed));

typedef struct NPNZ_USER_DATA_BUFFER_s NPNZ_USER_DATA_BUFFER_t;


struct NPNZ16b_s {


    volatile struct NPNZ_STATUS_s status;

    volatile struct NPNZ_PORTS_s Ports;

    volatile struct NPNZ_FILTER_PARAMS_s Filter;

    volatile struct NPNZ_GAIN_CONTROL_s GainControl;

    volatile struct NPNZ_LIMITS_s Limits;

    volatile struct NPNZ_ADC_TRGCTRL_s ADCTriggerControl;

    volatile struct NPNZ_DATA_PROVIDERS_s DataProviders;

    volatile struct NPNZ_EXTENSION_HOOKS_s ExtensionHooks;

    volatile struct NPNZ_USER_DATA_BUFFER_s Advanced;


} __attribute__((packed)) ;

typedef struct NPNZ16b_s NPNZ16b_t;


/* ********************************************************************************/


#endif                                            // end of __SPECIAL_FUNCTION_LAYER_LIB_NPNZ16B_H__ header file section


//**********************************************************************************

// Download latest version of this tool here: https://areiter128.github.io/DCLD

//**********************************************************************************