smps_control.h

Go to the documentation of this file.

 
// DOM-IGNORE-BEGIN
// © 2015 Microchip Technology Inc.
//
// MICROCHIP SOFTWARE NOTICE AND DISCLAIMER:  You may use this software, and any
// derivatives created by any person or entity by or on your behalf, exclusively
// with Microchip?s products.  Microchip and its licensors retain all ownership
// and intellectual property rights in the accompanying software and in all
// derivatives here to.
//
// This software and any accompanying information is for suggestion only.  It
// does not modify Microchip?s standard warranty for its products.  You agree
// that you are solely responsible for testing the software and determining its
// suitability.  Microchip has no obligation to modify, test, certify, or
// support the software.
//
// THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS".  NO WARRANTIES, WHETHER
// EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED
// WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR
// PURPOSE APPLY TO THIS SOFTWARE, ITS INTERACTION WITH MICROCHIP?S PRODUCTS,
// COMBINATION WITH ANY OTHER PRODUCTS, OR USE IN ANY APPLICATION.
//
// IN NO EVENT, WILL MICROCHIP BE LIABLE, WHETHER IN CONTRACT, WARRANTY, TORT
// (INCLUDING NEGLIGENCE OR BREACH OF STATUTORY DUTY), STRICT LIABILITY,
// INDEMNITY, CONTRIBUTION, OR OTHERWISE, FOR ANY INDIRECT, SPECIAL, PUNITIVE,
// EXEMPLARY, INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, FOR COST OR EXPENSE OF
// ANY KIND WHATSOEVER RELATED TO THE SOFTWARE, HOWSOEVER CAUSED, EVEN IF
// MICROCHIP HAS BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE.
// TO THE FULLEST EXTENT ALLOWABLE 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.
// DOM-IGNORE-END
 
#ifndef _SMPS_CONTROL_H     // Guards against multiple inclusion
#define _SMPS_CONTROL_H
 
// *****************************************************************************
// *****************************************************************************
// Section: Included Files
// *****************************************************************************
// *****************************************************************************
 
#include <xc.h>
#include <stdint.h>
 
#ifdef __cplusplus  // Provide C++ Compatibility
    extern "C" {
#endif
 
// *****************************************************************************
// *****************************************************************************
// Section: Data Types
// *****************************************************************************
// *****************************************************************************
 
//**************************************************************************
/* Data type for the 3-pole 3-zero (3P3Z) controller
 
  Summary:
    Data type for the 3-pole 3-zero (3P3Z) controller
 
  Description:
    The 3P3Z controller is the digital implementation of the analog type III
    controller. This is a filter which generates a compensator characteristic
    considering three poles and three zeros. This controller requires four
    feedback errors multiplied by their associated coefficients plus the three
    latest controller output values multiplied by their associated coefficients
    along the delay line to provide proper compensation of the power converter.
    The coefficients are determined externally using simulation tools.
 
    The SMPS_3P3Z_T data structure contains a pointer to derived
    coefficients in X-space and pointer to error/control history samples in
    Y-space. User must declare variables for the derived coefficients and
    the error history samples.
 
    The abCoefficients referenced by the SMPS_3P3Z_T data structure are
    derived from the coefficients B0-B3 plus A1-A3. These will be declared
    in external arrays. The SMPS_3P3Z_T data structure just holds pointers
    to these arrays.
 
    The coefficients will be determined by simulation tools, their outputs are
    given as floating point numbers. These numbers will be copied into the
    declared arrays after they have been converted into 16-bit integer numbers.
 
*/
 
typedef struct
{
    int16_t*    aCoefficients ;         // Pointer to A coefficients located in X-space
    int16_t*    bCoefficients ;         // Pointer to B coefficients located in X-space
    int16_t*    controlHistory ;    // Pointer to 3 delay-line samples located in Y-space
                                        // with the first sample being the most recent
    int16_t*    errorHistory ;          // Pointer to 4 delay-line samples located in Y-space
                                        // with the first sample being the most recent
    uint16_t    preShift ;      // Normalization from ADC-resolution to Q15 (R/W)
    int16_t     postShift ;     // Normalization bit-shift from Q15 to PWM register resolution (R/W)
    int16_t     postScaler ;        // Controller output post-scaler  (R/W)
    uint16_t    minOutput ;     // Minimum output value used for clamping (R/W)
    uint16_t    maxOutput ;     // Maximum output value used for clamping (R/W)
} SMPS_3P3Z_T;
 
// *****************************************************************************
/* Data type for the 2-pole 2-zero (2P2Z) controller
 
  Summary:
    Data type for the 2-pole 2-zero (2P2Z) controller
 
  Description:
    The 2P2Z controller is the digital implementation of the analog type II
    controller. This is a filter which generates a compensator characteristic
    considering two poles and two zeros. This controller requires three feedback
    error multiplied by their associated coefficients plus the two latest
    controller output values multiplied by their associated coefficients along
    the delay line to provide proper compensation of the power converter.
    The coefficients are determined externally using simulation tools.
 
    The SMPS_2P2Z_T data structure contains a pointer to derived
    coefficients in X-space and pointer to error/control history samples in
    Y-space. User must declare variables for the derived coefficients and
    the error history samples.
 
    The abCoefficients referenced by the SMPS_2P2Z_T data structure are
    derived from the coefficients B0-B2 plus A1-A2. These will be declared
    in external arrays. The SMPS_2P2Z_T data structure and just holds
    pointers to these arrays.
 
    The coefficients will be determined by simulation tools, which output
    is given as floating point numbers. These numbers will be copied into
    the declared arrays after they have been converted into 16-bit integer
    numbers.
*/
typedef struct
{
    int16_t*    aCoefficients ;         // Pointer to A coefficients located in X-space
    int16_t*    bCoefficients ;         // Pointer to B coefficients located in X-space
    int16_t*    controlHistory ;    // Pointer to 2 delay-line samples located in Y-space
                                        // with the first sample being the most recent
    int16_t*    errorHistory ;          // Pointer to 3 delay-line samples located in Y-space
                                        // with the first sample being the most recent
    uint16_t    preShift ;      // Normalization from ADC-resolution to Q15 (R/W)
    int16_t     postShift ;     // Normalization bit-shift from Q15 to PWM register resolution (R/W)
    int16_t     postScaler ;        // Controller output post-scaler  (R/W)
    uint16_t    minOutput ;     // Minimum output value used for clamping (R/W)
    uint16_t    maxOutput ;     // Maximum output value used for clamping (R/W)
    
    uint16_t    KfactorCoeffsB; //############FTX
} SMPS_2P2Z_T ;
 
//***********************************************************************
/* Data type for the PID controller
 
  Summary:
    Data type for the PID controller
 
  Description:
    Data type for the Proportional Integral Derivative (PID) controller
 
    This digital implementation of a PID controller is a filter which
    generates a compensator characteristic considering the values of the
    coefficients KA, KB, KC these coefficients will determine the
    converter's frequency response. These coefficients are determined
    externally using simulation tools.
 
    This function call includes the pointer to the controller data
    structure, pointer of the input source register, control reference
    value, and to the pointer to the output register.
 */
typedef struct {
 
    int16_t*  abcCoefficients;  // Pointer to A, B & C coefficients located in X-space
                                // These coefficients are derived from
                                // the PID gain values - Kp, Ki and Kd
    int16_t*  errorHistory; // Pointer to 3 delay-line samples located in Y-space
                            // with the first sample being the most recent
    int16_t  controlHistory;    // Stores the most recent controller output (n-1)
    int16_t  postScaler;    // PID basic Coefficient scaling Factor
    int16_t  preShift ;     // Normalization from ADC-resolution to Q15 (R/W)
    int16_t  postShift;     // Normalization from DSP to PWM register
    uint16_t minOutput;     // Minimum output value used for clamping
    uint16_t maxOutput;     // Maximum output value used for clamping
    
} SMPS_PID_T;
 
 
 
 
// *****************************************************************************
// *****************************************************************************
// Section: Interface Routines
// *****************************************************************************
// *****************************************************************************
 
 
void SMPS_Controller3P3ZInitialize(SMPS_3P3Z_T *controllerData );
 
 
void SMPS_Controller3P3ZUpdate(SMPS_3P3Z_T* controllerData,
                               volatile uint16_t* controllerInputRegister,
                   int16_t reference,
                   volatile uint16_t* controllerOutputRegister);
 
 
 
void SMPS_Controller2P2ZUpdate_HW_Accel(void); // Function prototype for 2P2Z library
 
 
 
void SMPS_Controller3P3ZUpdate_HW_Accel(void); // Function prototype for 3P3Z library
 
 
 
void SMPS_Controller4P4ZUpdate_HW_Accel(void); // Function prototype for 3P3Z library
 
 
 
void SMPS_ControllerPIDUpdate_HW_Accel(void); // Function prototype for PID library
 
 
typedef struct {
 
     uint16_t  triggerSelectFlag; // 00 = No Trigger Enabled
                              // 01 = Trigger On-Time Enabled
                      // 10 = Trigger Off-Time Enabled
 
     uint16_t                delayValue;      //
     volatile unsigned int*  trigger;         // Pointer to trigger source
     volatile unsigned int*  period;          // Pointer to time base (i.e., PTPER) register
 
     // User to add additional structure elements as needed
     //             .
     //             .
     //             .
 
} SMPS_Controller_Options_T; // Converter User Enabled Options
 
 
 
//void SMPS_Controller3P3Z(CONVERTER* controllerData);
 
 
 
 
void SMPS_Controller2P2ZInitialize(SMPS_2P2Z_T *controllerData);
 
 
 
void SMPS_Controller2P2ZUpdate(SMPS_2P2Z_T* controllerData,
                               volatile uint16_t* controllerInputRegister,
                               int16_t reference,
                               volatile uint16_t* controllerOutputRegister);
 
 
 
void SMPS_ControllerPIDInitialize(SMPS_PID_T *controllerData );
 
 
void SMPS_ControllerPIDUpdate(SMPS_PID_T* controllerData,
                              volatile uint16_t* controllerInputRegister,
                              int16_t reference,
                              volatile uint16_t* controllerOutputRegister);
 
 
//XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 
typedef struct
{
    int16_t*    aCoefficients ;         // Pointer to A coefficients located in X-space
    int16_t*    bCoefficients ;         // Pointer to B coefficients located in X-space
    int16_t*    controlHistory ;    // Pointer to 2 delay-line samples located in Y-space
                                        // with the first sample being the most recent
    int16_t*    errorHistory ;          // Pointer to 3 delay-line samples located in Y-space
                                        // with the first sample being the most recent
    uint16_t    preShift ;      // Normalization from ADC-resolution to Q15 (R/W)
    int16_t     postShift ;     // Normalization bit-shift from Q15 to PWM register resolution (R/W)
    int16_t     postScaler ;        // Controller output post-scaler  (R/W)
    uint16_t    minOutput ;     // Minimum output value used for clamping (R/W)
    uint16_t    maxOutput ;     // Maximum output value used for clamping (R/W)
} XFT_SMPS_2P2Z_T ;
 
void XFT_SMPS_Controller2P2ZUpdate(SMPS_2P2Z_T* controllerData,
                               volatile uint16_t* controllerInputRegister,
                               int16_t reference,
                               volatile uint16_t* controllerOutputRegister);
//XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 
 
 
#ifdef __cplusplus  // Provide C++ Compatibility
    }
#endif
 
#endif // _SMPS_CONTROL_H
 
/* EOF */