dpsk3_hwdescr.h

/* 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. 
 */
 
/* 
 * @file   dpsk3_hwdescr.h
 * Author: M91406
 * @brief  DPSK3 Hardware Descriptor header file
 * Revision history: 
 */
 
// This is a guard condition so that contents of this file are not included
// more than once.  
#ifndef DPSK3_HARDWARE_DESCRIPTOR_H
#define DPSK3_HARDWARE_DESCRIPTOR_H
 
#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 <math.h> // include standard math functions library
 
 
/* DPSK3 BOARD CIRCUIT SEGMENTS */
 
#define INCLUDE_BUCK    true    // Include buck converter declarations
#define INCLUDE_BOOST   false   // Include boost converter declarations
#define INCLUDE_LCD     true    // Include LCD declarations
 
 
#ifndef __DPSK3_R30__
  #define __DPSK3_R30__
#endif
 
 // end of group hardware-id-macro
 
 
/* CUSTOM RUNTIME OPTIONS */
#define PLANT_MEASUREMENT   false 
 
#define DBGPIN1_ENABLE      true 
#define DBGPIN2_ENABLE      true 
 
#define DBGDAC_ENABLE       true 
 
 // end of group special-options
 
 
#define CPU_FREQUENCY       (float)100000000.0  
 
// ADC/DAC Reference and Resolution Settings    
#define ADC_REFERENCE       (float)3.300 
#define ADC_RESOLUTION      (float)12.0  
 
// PWM/ADC Clock Settings   
#define PWM_CLOCK_HIGH_RESOLUTION   true 
 
#if (PWM_CLOCK_HIGH_RESOLUTION)
#define PWM_CLOCK_FREQUENCY (float)4.0e+9 
#else
#define PWM_CLOCK_FREQUENCY (float)500.0e+6 
#endif
 // end of group device-abstraction-settings
 
#define CPU_TCY             (float)(1.0/CPU_FREQUENCY) 
#define ADC_GRANULARITY     (float)(ADC_REFERENCE / pow(2.0, ADC_RESOLUTION)) 
#define ADC_VALUE_MAX       (uint16_t) (pow(2.0, ADC_RESOLUTION) - 1.0) // DO NOT CHANGE
#define PWM_CLOCK_PERIOD    (float)(1.0/PWM_CLOCK_FREQUENCY) 
 
 // end of group device-abstraction-macros
 
 
#define MAIN_EXECUTION_PERIOD   (float)100.0e-6 
 
 // end of group state-machine-settings ~~~~~~~~~~
 
#define MAIN_EXEC_PER           (uint16_t)((CPU_FREQUENCY * MAIN_EXECUTION_PERIOD)-1) // DO NOT CHANGE
 // end of group state-machine-macros ~~~~~~~~~~
 
#define _OsTimerInterrupt      _T1Interrupt 
#define _OSTIMER_IP            _T1IP 
#define _OSTIMER_IE            _T1IE 
#define _OSTIMER_IF            _T1IF 
#define _OSTIMER_PRIORITY       2    
 
 // end of group state-machine-mcal ~~~~~~~~~~
 
 
#if (DBGPIN1_ENABLE == true)    
#define DBGPIN1_PORT        1   
#define DBGPIN1_PIN         5   
#define DBGPIN1_Get()       _RB5 
#define DBGPIN1_Set()       { _LATB5 = 1; } 
#define DBGPIN1_Clear()     { _LATB5 = 0; } 
#define DBGPIN1_Toggle()    { _LATB5 ^= 1; } 
#define DBGPIN1_Init()      { _LATB5 = 0; _TRISB5 = 0; } 
#define DBGPIN1_Dispose()   { _LATB5 = 1; _TRISB5 = 1; } 
#endif
 
#if (DBGPIN2_ENABLE == true)    
#define DBGPIN2_PORT        1   
#define DBGPIN2_PIN         11  
#define DBGPIN2_Get()       _RB11 
#define DBGPIN2_Set()       { _LATB11 = 1; } 
#define DBGPIN2_Clear()     { _LATB11 = 0; } 
#define DBGPIN2_Toggle()    { _LATB11 ^= 1; } 
#define DBGPIN2_Init()      { _LATB11 = 0; _TRISB11 = 0; } 
#define DBGPIN2_Dispose()   { _LATB11 = 1; _TRISB11 = 1; } 
#endif
 
// Ref LED on DPSK3 (TP51)
#define DBGLED_PORT         1   
#define DBGLED_PIN          6   
#define DBGLED_Get()        _RB6 
#define DBGLED_Set()        { _LATB6 = 1; } 
#define DBGLED_Clear()      { _LATB6 = 0; } 
#define DBGLED_Toggle()     { _LATB6 ^= 1; } 
#define DBGLED_Init()       { _LATB6 = 0; _TRISB6 = 0; } 
#define DBGLED_Dispose()    { _LATB6 = 1; _TRISB6 = 1; } 
 
// Power Good Output
#define PWRGOOD_PORT        1   
#define PWRGOOD_PIN         12  
#define PWRGOOD_Get()       { _RB12; } 
#define PWRGOOD_Set()       { _LATB12 = 1; } 
#define PWRGOOD_Clear()     { _LATB12 = 0; } 
#define PWRGOOD_Toggle()    { _LATB12 ^= 1; } 
#define PWRGOOD_Init()      { _LATB12 = 0; _TRISB12 = 0; } 
#define PWRGOOD_Dispose()   { _LATB12 = 1; _TRISB12 = 1; } 
    
// User Switch Input
#define SW_USER_PORT        3   
#define SW_USER_PIN         1   
#define SW_USER_Get()       _RD1 
#define SW_USER_Set()       { _LATD1 = 1; } 
#define SW_USER_Clear()     { _LATD1 = 0; } 
#define SW_USER_Toggle()    { _LATD1 ^= 1; } 
#define SW_USER_Init()      { _LATD1 = 1; _TRISD1 = 1; } 
#define SW_USER_Dispose()   { _LATD1 = 1; _TRISD1 = 1; } 
 
 // end of group circuit-gpio-mcal
 
 
#define DAC_OUTPUT_INSTANCE     1U 
#define DAC_BUFFER_OPA_INSTANCE 3U 
#define DAC_OUTPUT_INIT_VALUE   0U 
 
 
#if (DAC_OUTPUT_INSTANCE == 1U)
  #define DACOUT_Set(x) { DAC1DATH=x; } 
  #define DACOUT_Get()    DAC1DATH      
#elif (DAC_OUTPUT_INSTANCE == 2U)
  #define DACOUT_Set(x) { DAC2DATH=x; } 
  #define DACOUT_Get()    DAC2DATH      
#elif (DAC_OUTPUT_INSTANCE == 3U)
  #define DACOUT_Set(x) { DAC3DATH=x; } 
  #define DACOUT_Get()    DAC3DATH      
#endif
 // end of group circuit-peripheral-mcal
 
 
#if (INCLUDE_BUCK == true)
 
 
#define BUCK_NO_OF_PHASES              1U 
 
#define BUCK_SWITCHING_FREQUENCY       (float)500.0e+3 
#define BUCK_PWM_DUTY_CYCLE_MIN        (float)  0.010  
#define BUCK_PWM_DUTY_CYCLE_MAX        (float)  0.900  
#define BUCK_LEADING_EDGE_BLANKING     (float)120.0e-9 
#define BUCK_DEAD_TIME_LEADING_EDGE    (float) 20.0e-9 
#define BUCK_DEAD_TIME_FALLING_EDGE    (float) 60.0e-9 
 
 // end of group pwm-settings-buck ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
#define BUCK_PWM_CHANNEL            1U 
#define BUCK_PWM_GPIO_INSTANCE      1U 
#define BUCK_PWM_GPIO_PORT_PINH     14U 
#define BUCK_PWM_GPIO_PORT_PINL     15U 
#define BUCK_PWM_OUTPUT_SWAP        false 
    
#define BUCK_PWM_PDC                PG1DC    
#define BUCK_PWMH_TRIS              _TRISB14 
#define BUCK_PWMH_WR                _LATB14  
#define BUCK_PWMH_RD                _RB14    
#define BUCK_PWMH_RPx               (uint8_t)46 
#define BUCK_PWML_TRIS              _TRISB15 
#define BUCK_PWML_WR                _LATB15  
#define BUCK_PWML_RD                _RB15    
#define BUCK_PWML_RPx               (uint8_t)47 
 
#define _BUCK_PWM_Interrupt         _PWM1Interrupt 
#define BUCK_PWM_IF                 _PWM1IF  
#define BUCK_PWM_IE                 _PWM1IE  
#define BUCK_PWM_IP                 _PWM1IP  
#define BUCK_PWM_TRGSRC_TRG1        0b00100  
#define BUCK_PWM_TRGSRC_TRG2        0b00101  
#define BUCK_PWM_PGxTRIGA           PG1TRIGA 
#define BUCK_PWM_PGxTRIGB           PG1TRIGB 
#define BUCK_PWM_PGxTRIGC           PG1TRIGC 
    
#define BUCK_PWM_ADTR1OFS           0U 
#define BUCK_PWM_ADTR1PS            0U 
 
#define BUCK_PWM_UPDREQ             PG1STATbits.UPDREQ
 // end of group pwm-mcal-buck ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Conversion Macros
#define BUCK_SWITCHING_PERIOD   (float)(1.0/BUCK_SWITCHING_FREQUENCY)   
#define BUCK_PWM_PERIOD         (uint16_t)(float)(BUCK_SWITCHING_PERIOD / PWM_CLOCK_PERIOD) 
#define BUCK_PWM_PHASE_SHIFT    (uint16_t)((float)BUCK_PWM_PERIOD / (float)BUCK_NO_OF_PHASES) 
#define BUCK_PWM_DC_MIN         (uint16_t)(BUCK_PWM_DUTY_CYCLE_MIN * (float)BUCK_PWM_PERIOD) 
#define BUCK_PWM_DC_MAX         (uint16_t)(BUCK_PWM_DUTY_CYCLE_MAX * (float)BUCK_PWM_PERIOD) 
#define BUCK_LEB_PERIOD         (uint16_t)(BUCK_LEADING_EDGE_BLANKING / (float)PWM_CLOCK_PERIOD) 
#define BUCK_PWM_DEAD_TIME_LE   (uint16_t)(BUCK_DEAD_TIME_LEADING_EDGE / (float)PWM_CLOCK_PERIOD) 
#define BUCK_PWM_DEAD_TIME_FE   (uint16_t)(BUCK_DEAD_TIME_FALLING_EDGE / (float)PWM_CLOCK_PERIOD) 
 
 // end of group pwm-macros-buck ~~~~~~~~~~~~~~~~~
 
    
 
// Feedback Declarations
#define BUCK_VIN_MINIMUM            (float) 6.500   
#define BUCK_VIN_NOMINAL            (float) 9.000   
#define BUCK_VIN_MAXIMUM            (float)13.800   
 
#define BUCK_VIN_UNDER_VOLTAGE      (float) 6.000   
#define BUCK_VIN_OVER_VOLTAGE       (float)14.300   
#define BUCK_VIN_HYSTERESIS         (float) 1.000   
    
#define BUCK_VIN_R1                 (float) 6.980   
#define BUCK_VIN_R2                 (float) 1.000   
    
#define BUCK_VIN_FEEDBACK_OFFSET    (float) 0.0000  
#define BUCK_VIN_ADC_TRG_DELAY      (float) 20.0e-9 
 
 // end of group input-voltage-feedback-settings-buck ~~~~~~~~~~~~~~~~
 
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Peripheral Assignments
#define _BUCK_VIN_ADCInterrupt  _ADCAN12Interrupt 
#define _BUCK_VIN_ADCISR_IF     _ADCAN12IF   
 
#define BUCK_VIN_ANSEL          _ANSELC0    
#define BUCK_VIN_ADCCORE        8           
#define BUCK_VIN_ADCIN          12          
#define BUCK_VIN_ADCBUF         ADCBUF12     
#define BUCK_VIN_ADCTRIG        PG1TRIGB    
#define BUCK_VIN_TRGSRC         BUCK_PWM_TRGSRC_TRG2 
 
 // end of group input-voltage-feedback-mcal-buck ~~~~~~~~~~~~~~~~~~~~
 
 
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#define BUCK_VIN_FEEDBACK_GAIN  (float)((BUCK_VIN_R2) / (BUCK_VIN_R1 + BUCK_VIN_R2)) // DO NOT CHANGE
#define BUCK_VIN_MIN            (uint16_t)(BUCK_VIN_MINIMUM * BUCK_VIN_FEEDBACK_GAIN / ADC_GRANULARITY)   
#define BUCK_VIN_NOM            (uint16_t)(BUCK_VIN_NOMINAL * BUCK_VIN_FEEDBACK_GAIN / ADC_GRANULARITY)   
#define BUCK_VIN_MAX            (uint16_t)(BUCK_VIN_MAXIMUM * BUCK_VIN_FEEDBACK_GAIN / ADC_GRANULARITY)   
#define BUCK_VIN_HYST           (uint16_t)(BUCK_VIN_HYSTERESIS * BUCK_VIN_FEEDBACK_GAIN / ADC_GRANULARITY)  
#define BUCK_VIN_UVLO_TRIP      (uint16_t)(BUCK_VIN_UNDER_VOLTAGE * BUCK_VIN_FEEDBACK_GAIN / ADC_GRANULARITY) 
#define BUCK_VIN_UVLO_RELEASE   (uint16_t)((BUCK_VIN_UNDER_VOLTAGE + BUCK_VIN_HYSTERESIS) * BUCK_VIN_FEEDBACK_GAIN / ADC_GRANULARITY) 
#define BUCK_VIN_OVLO_TRIP      (uint16_t)(BUCK_VIN_OVER_VOLTAGE * BUCK_VIN_FEEDBACK_GAIN / ADC_GRANULARITY)  
#define BUCK_VIN_OVLO_RELEASE   (uint16_t)((BUCK_VIN_OVER_VOLTAGE - BUCK_VIN_HYSTERESIS) * BUCK_VIN_FEEDBACK_GAIN / ADC_GRANULARITY)  
#define BUCK_VIN_ADC_TRGDLY     (uint16_t)(BUCK_VIN_ADC_TRG_DELAY / PWM_CLOCK_PERIOD) 
#define BUCK_VIN_OFFSET         (uint16_t)(BUCK_VIN_FEEDBACK_OFFSET / ADC_GRANULARITY) 
 
#define BUCK_VIN_NORM_INV_G     (float)(1.0/BUCK_VIN_FEEDBACK_GAIN) 
#define BUCK_VIN_NORM_SCALER    (int16_t)(ceil(log(BUCK_VIN_NORM_INV_G)/log(2))) 
#define BUCK_VIN_NORM_FACTOR    (int16_t)((BUCK_VIN_NORM_INV_G / pow(2.0, BUCK_VIN_NORM_SCALER)) * (pow(2.0, 15)-1)) 
 
#define BUCK_VIN_RANGE_MAX      (float)(ADC_REFERENCE * BUCK_VIN_NORM_INV_G)
 // end of group input-voltage-feedback-macros-buck ~~~~~~~~~~~~~~~~~~
 
 
// Feedback Declarations
#define BUCK_VOUT_MINIMUM           (float) 0.000   
#define BUCK_VOUT_NOMINAL           (float) 3.300   
#define BUCK_VOUT_MAXIMUM           (float) 4.000   
#define BUCK_VOUT_HYSTERESIS        (float) 0.500   
 
#define BUCK_VOUT_TOLERANCE_MAX     (float) 0.200   
#define BUCK_VOUT_TOLERANCE_MIN     (float) 0.100   
    
#define BUCK_VOUT_DIV_R1            (float) 1.000  
#define BUCK_VOUT_DIV_R2            (float) 1.000  
#define BUCK_VOUT_FEEDBACK_OFFSET   (float) 0.000  
#define BUCK_VOUT_ADC_TRG_DELAY     (float)20.0e-9 
 
 // end of group output-voltage-feedback-settings-buck ~~~~~~~~~~~~~~~
 
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Peripheral Assignments
#define BUCK_VOUT_ANSEL             _ANSELC1    
#define BUCK_VOUT_ADCCORE           8           
#define BUCK_VOUT_ADCIN             13          
#define BUCK_VOUT_ADCBUF            ADCBUF13     
#define BUCK_VOUT_ADCTRIG           PG1TRIGA    
#define BUCK_VOUT_TRGSRC            BUCK_PWM_TRGSRC_TRG1 
 
 // end of group output-voltage-feedback-mcal-buck ~~~~~~~~~~~~~~~~~~~
 
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#define BUCK_VOUT_FEEDBACK_GAIN (float)((BUCK_VOUT_DIV_R2) / (BUCK_VOUT_DIV_R1 + BUCK_VOUT_DIV_R2)) 
 
#define BUCK_VOUT_REF           (uint16_t)(BUCK_VOUT_NOMINAL * BUCK_VOUT_FEEDBACK_GAIN / ADC_GRANULARITY) 
#define BUCK_VOUT_NOM           (uint16_t) BUCK_VOUT_REF 
#define BUCK_VOUT_DEV_TRIP      (uint16_t)((BUCK_VOUT_TOLERANCE_MAX * BUCK_VOUT_FEEDBACK_GAIN) / ADC_GRANULARITY) 
#define BUCK_VOUT_DEV_RELEASE   (uint16_t)((BUCK_VOUT_TOLERANCE_MIN * BUCK_VOUT_FEEDBACK_GAIN) / ADC_GRANULARITY) 
#define BUCK_VOUT_OVP_TRIP      (uint16_t)((BUCK_VOUT_MAXIMUM * BUCK_VOUT_FEEDBACK_GAIN) / ADC_GRANULARITY)  
#define BUCK_VOUT_OVP_RELEASE   (uint16_t)((BUCK_VOUT_MAXIMUM - BUCK_VOUT_HYSTERESIS) * BUCK_VOUT_FEEDBACK_GAIN / ADC_GRANULARITY)  
#define BUCK_VOUT_OFFSET        (uint16_t)(BUCK_VOUT_FEEDBACK_OFFSET / ADC_GRANULARITY) 
#define BUCK_VOUT_ADC_TRGDLY    (uint16_t)(BUCK_VOUT_ADC_TRG_DELAY / PWM_CLOCK_PERIOD) 
 
#define BUCK_VOUT_NORM_INV_G    (float)(1.0/BUCK_VOUT_FEEDBACK_GAIN) 
#define BUCK_VOUT_NORM_SCALER   (int16_t)(ceil(log(BUCK_VOUT_NORM_INV_G)/log(2))) 
#define BUCK_VOUT_NORM_FACTOR   (int16_t)((BUCK_VOUT_NORM_INV_G / pow(2.0, BUCK_VOUT_NORM_SCALER)) * (pow(2.0, 15)-1)) 
 
#define BUCK_VOUT_RANGE_MAX     (float)(ADC_REFERENCE * BUCK_VOUT_NORM_INV_G) 
    
 // end of group output-voltage-feedback-macros-buck ~~~~~~~~~~~~~~~~~
 
 
// Feedback Declarations
#define BUCK_ISNS_CT    0                   
#define BUCK_ISNS_AMP   1                   
    
#define BUCK_ISNS_OPTION    BUCK_ISNS_CT    
 
// Settings based on the selection made above
#if (BUCK_ISNS_OPTION == BUCK_ISNS_CT)
 
    #define BUCK_ISNS_FEEDBACK_GAIN     (float) 1.000   
    #define BUCK_ISNS_MINIMUM           (float)-1.000   
    #define BUCK_ISNS_MAXIMUM           (float) 2.500   
    #define BUCK_ISNS_RELEASE           (float) 2.000   
    #define BUCK_ISNS_REFERENCE         (float) 2.000   
    #define BUCK_ISNS_ADC_TRG_DELAY     (float) 80.0e-9 
    #define BUCK_ISNS_FEEDBACK_OFFSET   (float) 0.000   
 
    #define BUCK_ISNS_OFFSET_CALIBRATION_ENABLE  false      
 
#elif (BUCK_ISNS_OPTION == BUCK_ISNS_AMP)
 
    #define BUCK_ISNS_FEEDBACK_GAIN     (float) 0.600       
    #define BUCK_ISNS_MINIMUM           (float) 0.000       
    #define BUCK_ISNS_MAXIMUM           (float) 2.500       
    #define BUCK_ISNS_RELEASE           (float) 2.500       
    #define BUCK_ISNS_REFERENCE         (float) 2.500       
    #define BUCK_ISNS_ADC_TRG_DELAY     (float) 240.0e-9    
    #define BUCK_ISNS_FEEDBACK_OFFSET   (float) 1.650       
 
    #define BUCK_ISNS_OFFSET_CALIBRATION_ENABLE true        
 
#endif
 // end of group phase-current-feedback-settings-buck ~~~~~~~~~~~~~~~~
 
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Phase Current Feedback Settings Conversion Macros
#define BUCK_ISNS_MIN           (uint16_t)(int16_t)(((BUCK_ISNS_MINIMUM-BUCK_ISNS_FEEDBACK_OFFSET) * BUCK_ISNS_FEEDBACK_GAIN) / ADC_GRANULARITY)  
#define BUCK_ISNS_OCL           (uint16_t)(((BUCK_ISNS_MAXIMUM-BUCK_ISNS_FEEDBACK_OFFSET) * BUCK_ISNS_FEEDBACK_GAIN) / ADC_GRANULARITY)  
#define BUCK_ISNS_OCL_RELEASE   (uint16_t)(((BUCK_ISNS_RELEASE-BUCK_ISNS_FEEDBACK_OFFSET) * BUCK_ISNS_FEEDBACK_GAIN) / ADC_GRANULARITY)  
#define BUCK_ISNS_REF           (uint16_t)((BUCK_ISNS_REFERENCE * BUCK_ISNS_FEEDBACK_GAIN) / ADC_GRANULARITY)  
#define BUCK_ISNS_FB_OFFSET     (uint16_t)(BUCK_ISNS_FEEDBACK_OFFSET / ADC_GRANULARITY)
#define BUCK_ISNS_ADC_TRGDLY    (uint16_t)(BUCK_ISNS_ADC_TRG_DELAY / PWM_CLOCK_PERIOD)
 
#define BUCK_ISNS_NORM_INV_G    (float)(1.0/BUCK_ISNS_FEEDBACK_GAIN) 
#define BUCK_ISNS_NORM_SCALER   (int16_t)(ceil(log(BUCK_ISNS_NORM_INV_G)/log(2))) 
#define BUCK_ISNS_NORM_FACTOR   (int16_t)((BUCK_ISNS_NORM_INV_G / pow(2.0, BUCK_ISNS_NORM_SCALER)) * (pow(2.0, 15)-1)) 
 
 // end of group phase-current-feedback-macros ~~~~~~~~~~~~~~~~~~~~~~~
 
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Peripheral Assignments
#if (BUCK_ISNS_OPTION == BUCK_ISNS_CT)
 
    #define _BUCK_ISNS_ADCInterrupt     _ADCAN0Interrupt 
    #define _BUCK_ISNS_ADCISR_IF        _ADCAN0IF   
 
    #define BUCK_ISNS_ANSEL             _ANSELA0    
    #define BUCK_ISNS_ADCCORE           0           
    #define BUCK_ISNS_ADCIN             0           
    #define BUCK_ISNS_ALT_IN_SELECT     0b00        
    #define BUCK_ISNS_ADCBUF            ADCBUF0     
    #define BUCK_ISNS_ADCTRIG           PG1TRIGB    
    #define BUCK_ISNS_TRGSRC            BUCK_PWM_TRGSRC_TRG2 
 
#elif (BUCK_ISNS_OPTION == BUCK_ISNS_AMP)
 
    #define _BUCK_ISNS_ADCInterrupt     _ADCAN1Interrupt 
    #define _BUCK_ISNS_ADCISR_IF        _ADCAN1IF   
 
    #define BUCK_ISNS_ANSEL             _ANSELA1    
    #define BUCK_ISNS_ADCCORE           1           
    #define BUCK_ISNS_ADCIN             1           
    #define BUCK_ISNS_ALT_IN_SELECT     0b01        
    #define BUCK_ISNS_ADCBUF            ADCBUF1     
    #define BUCK_ISNS_ADCTRIG           PG1TRIGB    
    #define BUCK_ISNS_TRGSRC            BUCK_PWM_TRGSRC_TRG2 
 
#else
    #pragma message "hardware abstraction layer warning: no current sense feedback selected."
#endif
 // end of group phase-current-feedback-mcal-buck ~~~~~~~~~~~~~~~~~~~~
 
 
#define BUCK_AGC_EXECUTION_DELAY    (float)(370.0e-9) 
 
 // end of group adaptive-gain-control-settings-buck ~~~~~~~~~~~~~~~~~
 
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#define BUCK_VL_MINIMUM         (float)(BUCK_VIN_UNDER_VOLTAGE - BUCK_VOUT_MAXIMUM) 
#define BUCK_VL_NOMINAL         (float)(BUCK_VIN_NOMINAL       - BUCK_VOUT_NOMINAL) 
#define BUCK_VL_MAXIMUM         (float)(BUCK_VIN_RANGE_MAX     - 0) 
 
// The AGC compare value is defined at nominal input voltage and output voltage 
// The maximum modulation factor is normalized to fractional '1' to prevent number overruns
#define BUCK_AGC_FACTOR_MAX     (float)(BUCK_VL_NOMINAL / BUCK_VL_MINIMUM) 
#define BUCK_AGC_NOM_SCALER     (uint16_t)(ceil(log(BUCK_AGC_FACTOR_MAX)/log(2))) 
#define BUCK_AGC_NOM_FACTOR     (uint16_t)(0x7FFF >> BUCK_AGC_NOM_SCALER) 
#define BUCK_AGC_MEDIAN         (int16_t)(((int16_t)(((float)BUCK_VIN_NOM * BUCK_VIN_NORM_FCT) - BUCK_VOUT_NOM))>>BUCK_AGC_NOM_SCALER) 
 
// To calculate the voltage across the inductor, input and output voltage ADC results need to be normalized. The normalization factor is determined here
// Each input voltage sample has to be multiplied with this scaling factor to allow the calculation of the instantaneous voltage across the inductor
#define BUCK_VIN_NORM_FCT       (float)(BUCK_VOUT_FEEDBACK_GAIN / BUCK_VIN_FEEDBACK_GAIN)   
#define BUCK_AGC_IO_NORM_SCALER (int16_t)(ceil(log(BUCK_VIN_NORM_FCT)/log(2))) 
#define BUCK_AGC_IO_NORM_FACTOR (int16_t)((BUCK_VIN_NORM_FCT / pow(2.0, BUCK_AGC_IO_NORM_SCALER)) * (pow(2.0, 15)-1)) 
 
// Additional execution time calculation to be considered in trigger delay and overall control timing
#define BUCK_AGC_EXEC_DLY       (uint16_t)(BUCK_AGC_EXECUTION_DELAY / PWM_CLOCK_PERIOD) 
 
 // end of group adaptive-gain-control-macros-buck ~~~~~~~~~~~~~~~~~~~
 
 
// Hardware-dependent defines
#define BUCK_VOUT_TRIG_PWM  0   
#define BUCK_VOUT_TRIG_ADC  1   
 
#define BUCK_VOUT_TRIGGER_MODE  BUCK_VOUT_TRIG_PWM 
#define BUCK_VOUT_ISR_PRIORITY  5 
 
#if (BUCK_VOUT_TRIGGER_MODE == BUCK_VOUT_TRIG_ADC)    
 
  #define _BUCK_VLOOP_Interrupt     _ADCAN13Interrupt 
  #define _BUCK_VLOOP_ISR_IP        _ADCAN13IP 
  #define _BUCK_VLOOP_ISR_IF        _ADCAN13IF 
  #define _BUCK_VLOOP_ISR_IE        _ADCAN13IE 
 
#elif (BUCK_VOUT_TRIGGER_MODE == BUCK_VOUT_TRIG_PWM)
 
  #define _BUCK_VLOOP_Interrupt     _PWM1Interrupt 
  #define _BUCK_VLOOP_ISR_IP        _PWM1IP 
  #define _BUCK_VLOOP_ISR_IF        _PWM1IF 
  #define _BUCK_VLOOP_ISR_IE        _PWM1IE 
 
#endif
 // end of group isr-settings-buck ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
#define BUCK_POWER_ON_DELAY          (float) 200e-3 
#define BUCK_VRAMP_PERIOD            (float) 100e-3 
#define BUCK_IRAMP_PERIOD            (float) 100e-3 
#define BUCK_POWER_GOOD_DELAY        (float) 200e-3 
 
 // end of group startup-timing-settings ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#define BUCK_POD       (uint16_t)(((float)BUCK_POWER_ON_DELAY / (float)MAIN_EXECUTION_PERIOD)-1.0)
#define BUCK_VRAMP_PER (uint16_t)(((float)BUCK_VRAMP_PERIOD / (float)MAIN_EXECUTION_PERIOD)-1.0)
#define BUCK_VREF_STEP (uint16_t)((float)BUCK_VOUT_REF / (float)(BUCK_VRAMP_PER + 1.0))
#define BUCK_IRAMP_PER (uint16_t)(((float)BUCK_IRAMP_PERIOD / (float)MAIN_EXECUTION_PERIOD)-1.0)
#define BUCK_IREF_STEP (uint16_t)((float)BUCK_ISNS_REF / (float)(BUCK_VRAMP_PER + 1.0))
#define BUCK_PGD       (uint16_t)(((float)BUCK_POWER_GOOD_DELAY / (float)MAIN_EXECUTION_PERIOD)-1.0)
 // end of group startup-timing-macros-buck ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
#define BUCK_UVLO_TRIP_DELAY        (float) 5e-3   
#define BUCK_UVLO_RECOVERY_DELAY    (float) 500e-3 
#define BUCK_OVLO_TRIP_DELAY        (float) 5e-3   
#define BUCK_OVLO_RECOVERY_DELAY    (float) 500e-3 
#define BUCK_REGERR_TRIP_DELAY      (float) 25e-3  
#define BUCK_REGERR_RECOVERY_DELAY  (float) 2000e-3 
#define BUCK_OCP_TRIP_DELAY         (float) 2e-3   
#define BUCK_OCP_RECOVERY_DELAY     (float) 2000e-3 
 
#define BUCK_FAULT_RESTART_CYCLES   10  
 
 // end of group fault-response-settings-buck ~~~~~~~~~~~~~~~~~~~~~~~~
 
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#define BUCK_UVLO_TDLY   (uint16_t)(((float)      BUCK_UVLO_TRIP_DELAY / (float)MAIN_EXECUTION_PERIOD)-1.0) 
#define BUCK_UVLO_RDLY   (uint16_t)(((float)  BUCK_UVLO_RECOVERY_DELAY / (float)MAIN_EXECUTION_PERIOD)-1.0) 
#define BUCK_OVLO_TDLY   (uint16_t)(((float)      BUCK_OVLO_TRIP_DELAY / (float)MAIN_EXECUTION_PERIOD)-1.0) 
#define BUCK_OVLO_RDLY   (uint16_t)(((float)  BUCK_OVLO_RECOVERY_DELAY / (float)MAIN_EXECUTION_PERIOD)-1.0) 
#define BUCK_REGERR_TDLY (uint16_t)(((float)    BUCK_REGERR_TRIP_DELAY / (float)MAIN_EXECUTION_PERIOD)-1.0) 
#define BUCK_REGERR_RDLY (uint16_t)(((float)BUCK_REGERR_RECOVERY_DELAY / (float)MAIN_EXECUTION_PERIOD)-1.0) 
#define BUCK_OCP_TDLY    (uint16_t)(((float)       BUCK_OCP_TRIP_DELAY / (float)MAIN_EXECUTION_PERIOD)-1.0) 
#define BUCK_OCP_RDLY    (uint16_t)(((float)   BUCK_OCP_RECOVERY_DELAY / (float)MAIN_EXECUTION_PERIOD)-1.0) 
 
 // end of group fault-response-macros-buck ~~~~~~~~~~~~~~~~~~~~~~~~~~
 // Doxygen section
#endif   /* INCLUDE_BUCK */
 
#if (INCLUDE_BOOST == true)
 
 
#define BOOST_NO_OF_PHASES              1U 
 
#define BOOST_SWITCHING_FREQUENCY       (float)500.0e+3 
#define BOOST_PWM_DUTY_CYCLE_MIN        (float)  0.030  
#define BOOST_PWM_DUTY_CYCLE_MAX        (float)  0.900  
#define BOOST_LEADING_EDGE_BLANKING     (float)120.0e-9 
#define BOOST_DEAD_TIME_LEADING_EDGE    (float)  0.0e-9 
#define BOOST_DEAD_TIME_FALLING_EDGE    (float)  0.0e-9 
 
 // end of group pwm-settings-boost ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
#define BOOST_PWM_CHANNEL            2U 
#define BOOST_PWM_GPIO_INSTANCE      1U 
#define BOOST_PWM_GPIO_PORT_PINH     13U 
#define BOOST_PWM_GPIO_PORT_PINL     12U 
#define BOOST_PWM_OUTPUT_SWAP        true 
 
#define BOOST_PWM_PDC                PG2DC    
#define BOOST_PWMH_TRIS              _TRISB12 
#define BOOST_PWMH_WR                _LATB12  
#define BOOST_PWMH_RD                _RB12    
#define BOOST_PWMH_RPx               (uint8_t)44 
#define BOOST_PWML_TRIS              _TRISB13 
#define BOOST_PWML_WR                _LATB13  
#define BOOST_PWML_RD                _RB13    
#define BOOST_PWML_RPx               (uint8_t)45 
 
#define _BOOST_PWM_Interrupt         _PWM2Interrupt 
#define BOOST_PWM_IF                 _PWM2IF  
#define BOOST_PWM_IE                 _PWM2IE  
#define BOOST_PWM_IP                 _PWM2IP  
#define BOOST_PWM_TRGSRC_TRG1        0b00110  
#define BOOST_PWM_TRGSRC_TRG2        0b00111  
#define BOOST_PWM_PGxTRIGA           PG2TRIGA 
#define BOOST_PWM_PGxTRIGB           PG2TRIGB 
#define BOOST_PWM_PGxTRIGC           PG2TRIGC 
    
#define BOOST_PWM_ADTR1OFS           0U 
#define BOOST_PWM_ADTR1PS            0U 
 
#define BOOST_PWM_UPDREQ             PG2STATbits.UPDREQ
 // end of group pwm-mcal-boost ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Conversion Macros
#define BOOST_SWITCHING_PERIOD   (float)(1.0/BOOST_SWITCHING_FREQUENCY)   
#define BOOST_PWM_PERIOD         (uint16_t)(float)(BOOST_SWITCHING_PERIOD / PWM_CLOCK_PERIOD) 
#define BOOST_PWM_PHASE_SHIFT    (uint16_t)((float)BOOST_PWM_PERIOD / (float)BOOST_NO_OF_PHASES) 
#define BOOST_PWM_DC_MIN         (uint16_t)(BOOST_PWM_DUTY_CYCLE_MIN * (float)BOOST_PWM_PERIOD) 
#define BOOST_PWM_DC_MAX         (uint16_t)(BOOST_PWM_DUTY_CYCLE_MAX * (float)BOOST_PWM_PERIOD) 
#define BOOST_LEB_PERIOD         (uint16_t)(BOOST_LEADING_EDGE_BLANKING / (float)PWM_CLOCK_PERIOD) 
#define BOOST_PWM_DEAD_TIME_LE   (uint16_t)(BOOST_DEAD_TIME_LEADING_EDGE / (float)PWM_CLOCK_PERIOD) 
#define BOOST_PWM_DEAD_TIME_FE   (uint16_t)(BOOST_DEAD_TIME_FALLING_EDGE / (float)PWM_CLOCK_PERIOD) 
 
 // end of group pwm-macros-boost ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
    
 
// Feedback Declarations
#define BOOST_VIN_MINIMUM            (float) 6.500   
#define BOOST_VIN_NOMINAL            (float) 9.000   
#define BOOST_VIN_MAXIMUM            (float)13.800   
 
#define BOOST_VIN_UNDER_VOLTAGE      (float) 6.000   
#define BOOST_VIN_OVER_VOLTAGE       (float)14.300   
#define BOOST_VIN_HYSTERESIS         (float) 1.000   
    
#define BOOST_VIN_R1                 (float) 6.980   
#define BOOST_VIN_R2                 (float) 1.000   
    
#define BOOST_VIN_FEEDBACK_OFFSET    (float) 0.0000  
#define BOOST_VIN_ADC_TRG_DELAY      (float)20.0e-9  
 
 // end of group input-voltage-feedback-settings-boost ~~~~~~~~~~~~~~~
 
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Peripheral Assignments
#define _BOOST_VIN_ADCInterrupt  _ADCAN12Interrupt 
#define _BOOST_VIN_ADCISR_IF     _ADCAN12IF   
 
#define BOOST_VIN_ANSEL          _ANSELC0    
#define BOOST_VIN_ADCCORE        8           
#define BOOST_VIN_ADCIN          12          
#define BOOST_VIN_ADCBUF         ADCBUF12     
#define BOOST_VIN_ADCTRIG        PG2TRIGB    
#define BOOST_VIN_TRGSRC         BOOST_PWM_TRGSRC_TRG2 
 
 // end of group input-voltage-feedback-mcal-boost ~~~~~~~~~~~~~~~~~~~
 
 
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#define BOOST_VIN_FEEDBACK_GAIN  (float)((BOOST_VIN_R2) / (BOOST_VIN_R1 + BOOST_VIN_R2)) // DO NOT CHANGE
#define BOOST_VIN_MIN            (uint16_t)(BOOST_VIN_MINIMUM * BOOST_VIN_FEEDBACK_GAIN / ADC_GRANULARITY)   
#define BOOST_VIN_NOM            (uint16_t)(BOOST_VIN_NOMINAL * BOOST_VIN_FEEDBACK_GAIN / ADC_GRANULARITY)   
#define BOOST_VIN_MAX            (uint16_t)(BOOST_VIN_MAXIMUM * BOOST_VIN_FEEDBACK_GAIN / ADC_GRANULARITY)   
#define BOOST_VIN_HYST           (uint16_t)(BOOST_VIN_HYSTERESIS * BOOST_VIN_FEEDBACK_GAIN / ADC_GRANULARITY)  
#define BOOST_VIN_UVLO_TRIP      (uint16_t)(BOOST_VIN_UNDER_VOLTAGE * BOOST_VIN_FEEDBACK_GAIN / ADC_GRANULARITY) 
#define BOOST_VIN_UVLO_RELEASE   (uint16_t)((BOOST_VIN_UNDER_VOLTAGE + BOOST_VIN_HYSTERESIS) * BOOST_VIN_FEEDBACK_GAIN / ADC_GRANULARITY) 
#define BOOST_VIN_OVLO_TRIP      (uint16_t)(BOOST_VIN_OVER_VOLTAGE * BOOST_VIN_FEEDBACK_GAIN / ADC_GRANULARITY)  
#define BOOST_VIN_OVLO_RELEASE   (uint16_t)((BOOST_VIN_OVER_VOLTAGE - BOOST_VIN_HYSTERESIS) * BOOST_VIN_FEEDBACK_GAIN / ADC_GRANULARITY)  
#define BOOST_VIN_ADC_TRGDLY     (uint16_t)(BOOST_VIN_ADC_TRG_DELAY / PWM_CLOCK_PERIOD) 
#define BOOST_VIN_OFFSET         (uint16_t)(BOOST_VIN_FEEDBACK_OFFSET / ADC_GRANULARITY) 
 
#define BOOST_VIN_NORM_INV_G     (float)(1.0/BOOST_VIN_FEEDBACK_GAIN) 
#define BOOST_VIN_NORM_SCALER    (int16_t)(ceil(log(BOOST_VIN_NORM_INV_G)/log(2))) 
#define BOOST_VIN_NORM_FACTOR    (int16_t)((BOOST_VIN_NORM_INV_G / pow(2.0, BOOST_VIN_NORM_SCALER)) * (pow(2.0, 15)-1)) 
 
#define BOOST_VIN_RANGE_MAX      (float)(ADC_REFERENCE * BOOST_VIN_NORM_INV_G)
 // end of group input-voltage-feedback-macros-boost ~~~~~~~~~~~~~~~~~
 
 
// Feedback Declarations
#define BOOST_VOUT_MINIMUM           (float)14.00   
#define BOOST_VOUT_NOMINAL           (float)15.00   
#define BOOST_VOUT_MAXIMUM           (float)16.00   
#define BOOST_VOUT_HYSTERESIS        (float)0.500   
 
#define BOOST_VOUT_TOLERANCE_MAX     (float)0.500   
#define BOOST_VOUT_TOLERANCE_MIN     (float)0.100   
#define BOOST_VOUT_VFWD_DROP_MAX     (float)0.400   
    
#define BOOST_VOUT_DIV_R1            (float) 6.980  
#define BOOST_VOUT_DIV_R2            (float) 1.000  
#define BOOST_VOUT_FEEDBACK_OFFSET   (float) 0.000  
#define BOOST_VOUT_ADC_TRG_DELAY     (float)20.0e-9 
 
 // end of group output-voltage-feedback-settings-boost ~~~~~~~~~~~~~~~
 
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Peripheral Assignments
#define BOOST_VOUT_ANSEL             _ANSELD10   
#define BOOST_VOUT_ADCCORE           8           
#define BOOST_VOUT_ADCIN             18          
#define BOOST_VOUT_ADCBUF            ADCBUF18    
#define BOOST_VOUT_ADCTRIG           PG2TRIGA    
#define BOOST_VOUT_TRGSRC            BOOST_PWM_TRGSRC_TRG1 
 
 // end of group output-voltage-feedback-mcal-boost ~~~~~~~~~~~~~~~~~~
 
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#define BOOST_VOUT_FEEDBACK_GAIN (float)((BOOST_VOUT_DIV_R2) / (BOOST_VOUT_DIV_R1 + BOOST_VOUT_DIV_R2))
 
#define BOOST_VOUT_REF          (uint16_t)(BOOST_VOUT_NOMINAL * BOOST_VOUT_FEEDBACK_GAIN / ADC_GRANULARITY) 
#define BOOST_VOUT_NOM          BOOST_VOUT_REF 
#define BOOST_VOUT_DEV_TRIP     (uint16_t)(BOOST_VOUT_TOLERANCE_MAX * BOOST_VOUT_FEEDBACK_GAIN / ADC_GRANULARITY) 
#define BOOST_VOUT_DEV_RELEASE  (uint16_t)(BOOST_VOUT_TOLERANCE_MIN * BOOST_VOUT_FEEDBACK_GAIN / ADC_GRANULARITY) 
#define BOOST_VOUT_OVP_TRIP     (uint16_t)((BOOST_VOUT_MAXIMUM * BOOST_VOUT_FEEDBACK_GAIN) / ADC_GRANULARITY)  
#define BOOST_VOUT_OVP_RELEASE  (uint16_t)((BOOST_VOUT_MAXIMUM - BOOST_VOUT_HYSTERESIS) * BOOST_VOUT_FEEDBACK_GAIN / ADC_GRANULARITY)  
#define BOOST_VOUT_OFFSET       (uint16_t)(BOOST_VOUT_FEEDBACK_OFFSET / ADC_GRANULARITY) 
#define BOOST_VOUT_ADC_TRGDLY   (uint16_t)(BOOST_VOUT_ADC_TRG_DELAY / PWM_CLOCK_PERIOD) 
#define BOOST_VOUT_VFWD_DROP    (uint16_t)(BOOST_VOUT_VFWD_DROP_MAX / ADC_GRANULARITY) 
 
#define BOOST_VOUT_NORM_INV_G   (float)(1.0/BOOST_VOUT_FEEDBACK_GAIN) 
#define BOOST_VOUT_NORM_SCALER  (int16_t)(ceil(log(BOOST_VOUT_NORM_INV_G)/log(2))) 
#define BOOST_VOUT_NORM_FACTOR  (int16_t)((BOOST_VOUT_NORM_INV_G / pow(2.0, BOOST_VOUT_NORM_SCALER)) * (pow(2.0, 15)-1)) 
 
#define BOOST_VOUT_RANGE_MAX    (float)(ADC_REFERENCE * BOOST_VOUT_NORM_INV_G) 
    
 // end of group output-voltage-feedback-macros-boost ~~~~~~~~~~~~~~~~
 
 
// Feedback Declarations
#define BOOST_ISNS_LSCS     0                   
#define BOOST_ISNS_AMP      1                   
    
#define BOOST_ISNS_OPTION    BOOST_ISNS_LSCS    
 
// Settings based on the selection made above
#if (BOOST_ISNS_OPTION == BOOST_ISNS_LSCS)
 
    #define BOOST_ISNS_FEEDBACK_GAIN     (float) 1.000      
    #define BOOST_ISNS_MINIMUM           (float)-1.000      
    #define BOOST_ISNS_MAXIMUM           (float) 2.500      
    #define BOOST_ISNS_RELEASE           (float) 1.500      
    #define BOOST_ISNS_REFERENCE         (float) 2.500      
    #define BOOST_ISNS_REFERENCE_STARTUP (float) 2.500      
    #define BOOST_ISNS_ADC_TRG_DELAY     (float)80.0e-9     
    #define BOOST_ISNS_FEEDBACK_OFFSET   (float) 1.125      
 
    #define BOOST_ISNS_OFFSET_CALIBRATION_ENABLE  true       
 
#elif (BOOST_ISNS_OPTION == BOOST_ISNS_AMP)
 
    #define BOOST_ISNS_FEEDBACK_GAIN     (float) 0.600      
    #define BOOST_ISNS_MINIMUM           (float) 0.000      
    #define BOOST_ISNS_MAXIMUM           (float) 2.500      
    #define BOOST_ISNS_RELEASE           (float) 2.500      
    #define BOOST_ISNS_REFERENCE         (float) 2.500      
    #define BOOST_ISNS_REFERENCE_STARTUP (float) 2.500      
    #define BOOST_ISNS_ADC_TRG_DELAY     (float) 240.0e-9   
    #define BOOST_ISNS_FEEDBACK_OFFSET   (float) 1.650      
 
    #define BOOST_ISNS_OFFSET_CALIBRATION_ENABLE true       
 
#endif
 // end of group phase-current-feedback-settings-boost ~~~~~~~~~~~~~~~
 
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Phase Current Feedback Settings Conversion Macros
#define BOOST_ISNS_MIN           (uint16_t)(int16_t)(((BOOST_ISNS_MINIMUM-BOOST_ISNS_FEEDBACK_OFFSET) * BOOST_ISNS_FEEDBACK_GAIN) / ADC_GRANULARITY)  
#define BOOST_ISNS_OCL           (uint16_t)(((BOOST_ISNS_MAXIMUM-BOOST_ISNS_FEEDBACK_OFFSET) * BOOST_ISNS_FEEDBACK_GAIN) / ADC_GRANULARITY)  
#define BOOST_ISNS_OCL_RELEASE   (uint16_t)(((BOOST_ISNS_RELEASE-BOOST_ISNS_FEEDBACK_OFFSET) * BOOST_ISNS_FEEDBACK_GAIN) / ADC_GRANULARITY)  
#define BOOST_ISNS_REF           (uint16_t)((BOOST_ISNS_REFERENCE * BOOST_ISNS_FEEDBACK_GAIN) / ADC_GRANULARITY)  
#define BOOST_ISNS_REF_STARTUP   (uint16_t)((BOOST_ISNS_REFERENCE_STARTUP * BOOST_ISNS_FEEDBACK_GAIN) / ADC_GRANULARITY)  
#define BOOST_ISNS_FB_OFFSET     (uint16_t)(BOOST_ISNS_FEEDBACK_OFFSET / ADC_GRANULARITY)
#define BOOST_ISNS_ADC_TRGDLY    (uint16_t)(BOOST_ISNS_ADC_TRG_DELAY / PWM_CLOCK_PERIOD)
 
#define BOOST_ISNS_NORM_INV_G    (float)(1.0/BOOST_ISNS_FEEDBACK_GAIN) 
#define BOOST_ISNS_NORM_SCALER   (int16_t)(ceil(log(BOOST_ISNS_NORM_INV_G)/log(2))) 
#define BOOST_ISNS_NORM_FACTOR   (int16_t)((BOOST_ISNS_NORM_INV_G / pow(2.0, BOOST_ISNS_NORM_SCALER)) * (pow(2.0, 15)-1)) 
 
 // end of group phase-current-feedback-macros-boost ~~~~~~~~~~~~~~~~~
 
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Peripheral Assignments
#if (BOOST_ISNS_OPTION == BOOST_ISNS_LSCS)
 
    #define _BOOST_ISNS_ADCInterrupt    _ADCAN1Interrupt 
    #define _BOOST_ISNS_ADCISR_IF       _ADCAN1IF   
 
    #define BOOST_ISNS_ANSEL            _ANSELA1    
    #define BOOST_ISNS_ADCCORE          1           
    #define BOOST_ISNS_ADCIN            1           
    #define BOOST_ISNS_ALT_IN_SELECT    0b00        
    #define BOOST_ISNS_ADCBUF           ADCBUF1     
    #define BOOST_ISNS_ADCTRIG          PG2TRIGB    
    #define BOOST_ISNS_TRGSRC           BOOST_PWM_TRGSRC_TRG2 
 
    #define BOOST_ISNS_OPA_INSTANCE     2U  
 
#elif (BOOST_ISNS_OPTION == BOOST_ISNS_AMP)
 
    #define _BOOST_ISNS_ADCInterrupt     _ADCAN1Interrupt 
    #define _BOOST_ISNS_ADCISR_IF        _ADCAN1IF   
 
    #define BOOST_ISNS_ANSEL             _ANSELA1    
    #define BOOST_ISNS_ADCCORE           1           
    #define BOOST_ISNS_ADCIN             1           
    #define BOOST_ISNS_ALT_IN_SELECT     0b00        
    #define BOOST_ISNS_ADCBUF            ADCBUF1     
    #define BOOST_ISNS_ADCTRIG           PG2TRIGB    
    #define BOOST_ISNS_TRGSRC            BOOST_PWM_TRGSRC_TRG2 
 
    #define BOOST_ISNS_OPA_INSTANCE     0U  
 
#else
    #pragma message "hardware abstraction layer warning: no current sense feedback selected."
#endif
 // end of group phase-current-feedback-mcal-boost ~~~~~~~~~~~~~~~~~~~
 
 
#define BOOST_AGC_EXECUTION_DELAY    (float)(400.0e-9) 
 
 // end of group adaptive-gain-control-settings-boost ~~~~~~~~~~~~~~~~
 
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/* ToDo: AGC is temporarily disabled for the boost converter and requires further verification 
 
#define BOOST_VL_MINIMUM         (float)(BOOST_VIN_UNDER_VOLTAGE)   ///< Minimum input voltage - maximum output voltage
#define BOOST_VL_NOMINAL         (float)(BOOST_VIN_NOMINAL)         ///< Nominal input voltage - nominal output voltage
#define BOOST_VL_MAXIMUM         (float)(BOOST_VIN_RANGE_MAX)       ///< Maximum input voltage - output voltage = 0V
 
// The AGC compare value is defined at nominal input voltage and output voltage 
// The maximum modulation factor is normalized to fractional '1' to prevent number overruns
#define BOOST_AGC_FACTOR_MAX     (float)(BOOST_VL_NOMINAL / BOOST_VL_MINIMUM) ///< Floating point number of the maximumm limit of the adaptive gain modulation factor (float)
#define BOOST_AGC_NOM_SCALER     (uint16_t)(ceil(log(BOOST_AGC_FACTOR_MAX)/log(2))) ///< Bit-shift scaler of the floating point number of the maimum limit of the adaptive gain modulation factor
#define BOOST_AGC_NOM_FACTOR     (uint16_t)(0x7FFF >> BOOST_AGC_NOM_SCALER) ///< Fractional of the floating point number of the maimum limit of the adaptive gain modulation factor
#define BOOST_AGC_MEDIAN         (int16_t)(((int16_t)(((float)BOOST_VIN_NOM * BOOST_VIN_NORM_FCT) - BOOST_VOUT_NOM))>>BOOST_AGC_NOM_SCALER) ///< Adaptive gain modulation factor at nominal operating point
 
// To calculate the voltage across the inductor, input and output voltage ADC results need to be normalized. The normalization factor is determined here
// Each input voltage sample has to be multiplied with this scaling factor to allow the calculation of the instantaneous voltage across the inductor
#define BOOST_VIN_NORM_FCT       (float)(BOOST_VOUT_FEEDBACK_GAIN / BOOST_VIN_FEEDBACK_GAIN)   ///< VIN-2-VOUT Normalization Factor
#define BOOST_AGC_IO_NORM_SCALER (int16_t)(ceil(log(BOOST_VIN_NORM_FCT)/log(2))) ///< Nominal VL Q15 scaler  
#define BOOST_AGC_IO_NORM_FACTOR (int16_t)((BOOST_VIN_NORM_FCT / pow(2.0, BOOST_AGC_IO_NORM_SCALER)) * (pow(2.0, 15)-1)) ///< Nominal VL Q15 factor 
 
// Additional execution time calculation to be considered in trigger delay and overall control timing
#define BOOST_AGC_EXEC_DLY       (uint16_t)(BOOST_AGC_EXECUTION_DELAY / PWM_CLOCK_PERIOD) ///< Macro calculating the integer number equivalent of the AGC algorithm computation time
 
*/ // end of group adaptive-gain-control-macros-boost ~~~~~~~~~~~~~~~~~~
 
 
// Hardware-dependent defines
#define BOOST_VOUT_TRIG_PWM  0   
#define BOOST_VOUT_TRIG_ADC  1   
 
#define BOOST_VOUT_TRIGGER_MODE  BOOST_VOUT_TRIG_PWM 
#define BOOST_VOUT_ISR_PRIORITY  5 
 
#if (BOOST_VOUT_TRIGGER_MODE == BOOST_VOUT_TRIG_ADC)    
 
  #define _BOOST_VLOOP_Interrupt     _ADCAN18Interrupt 
  #define _BOOST_VLOOP_ISR_IP        _ADCAN18IP 
  #define _BOOST_VLOOP_ISR_IF        _ADCAN18IF 
  #define _BOOST_VLOOP_ISR_IE        _ADCAN18IE 
 
#elif (BOOST_VOUT_TRIGGER_MODE == BOOST_VOUT_TRIG_PWM)
 
  #define _BOOST_VLOOP_Interrupt     _PWM2Interrupt 
  #define _BOOST_VLOOP_ISR_IP        _PWM2IP 
  #define _BOOST_VLOOP_ISR_IF        _PWM2IF 
  #define _BOOST_VLOOP_ISR_IE        _PWM2IE 
 
#endif
 // end of group isr-settings-boost ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
#define BOOST_POWER_ON_DELAY        (float) 200e-3 
#define BOOST_VRAMP_PERIOD          (float) 100e-3 
#define BOOST_IRAMP_PERIOD          (float) 100e-3 
#define BOOST_POWER_GOOD_DELAY      (float) 200e-3 
 
#define BOOST_CHARGEUP_PERIOD       (float)  50e-3 
#define BOOST_CHARGEUP_TIMEOUT      (float) 200e-3 
    
 // end of group startup-timing-settings-boost ~~~~~~~~~~~~~~~~~~~~~~~
 
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#define BOOST_POD       (uint16_t)(((float)BOOST_POWER_ON_DELAY / (float)MAIN_EXECUTION_PERIOD)-1.0)
#define BOOST_VRAMP_PER (uint16_t)(((float)BOOST_VRAMP_PERIOD / (float)MAIN_EXECUTION_PERIOD)-1.0)
#define BOOST_VREF_STEP (uint16_t)((float)BOOST_VOUT_REF / (float)(BOOST_VRAMP_PER + 1.0))
#define BOOST_IRAMP_PER (uint16_t)(((float)BOOST_IRAMP_PERIOD / (float)MAIN_EXECUTION_PERIOD)-1.0)
#define BOOST_IREF_STEP (uint16_t)((float)BOOST_ISNS_REF / (float)(BOOST_VRAMP_PER + 1.0))
#define BOOST_PGD       (uint16_t)(((float)BOOST_POWER_GOOD_DELAY / (float)MAIN_EXECUTION_PERIOD)-1.0)
#define BOOST_CHRG_PER  (uint16_t)(((float)BOOST_CHARGEUP_PERIOD / (float)MAIN_EXECUTION_PERIOD)-1.0)
#define BOOST_CHRG_TOUT (uint16_t)(((float)BOOST_CHARGEUP_TIMEOUT / (float)MAIN_EXECUTION_PERIOD)-1.0)
 // end of group startup-timing-macros-boost ~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
#define BOOST_UVLO_TRIP_DELAY       (float) 5e-3   
#define BOOST_UVLO_RECOVERY_DELAY   (float) 500e-3 
#define BOOST_OVLO_TRIP_DELAY       (float) 5e-3   
#define BOOST_OVLO_RECOVERY_DELAY   (float) 500e-3 
#define BOOST_REGERR_TRIP_DELAY     (float) 25e-3  
#define BOOST_REGERR_RECOVERY_DELAY (float)2000e-3 
#define BOOST_OCP_TRIP_DELAY        (float) 2e-3   
#define BOOST_OCP_RECOVERY_DELAY    (float)2000e-3 
 
#define BOOST_FAULT_RESTART_CYCLES  10  
 
 // end of group fault-response-settings-boost ~~~~~~~~~~~~~~~~~~~~~~~
 
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#define BOOST_UVLO_TDLY   (uint16_t)(((float)      BOOST_UVLO_TRIP_DELAY / (float)MAIN_EXECUTION_PERIOD)-1.0) 
#define BOOST_UVLO_RDLY   (uint16_t)(((float)  BOOST_UVLO_RECOVERY_DELAY / (float)MAIN_EXECUTION_PERIOD)-1.0) 
#define BOOST_OVLO_TDLY   (uint16_t)(((float)      BOOST_OVLO_TRIP_DELAY / (float)MAIN_EXECUTION_PERIOD)-1.0) 
#define BOOST_OVLO_RDLY   (uint16_t)(((float)  BOOST_OVLO_RECOVERY_DELAY / (float)MAIN_EXECUTION_PERIOD)-1.0) 
#define BOOST_REGERR_TDLY (uint16_t)(((float)    BOOST_REGERR_TRIP_DELAY / (float)MAIN_EXECUTION_PERIOD)-1.0) 
#define BOOST_REGERR_RDLY (uint16_t)(((float)BOOST_REGERR_RECOVERY_DELAY / (float)MAIN_EXECUTION_PERIOD)-1.0) 
#define BOOST_OCP_TDLY    (uint16_t)(((float)       BOOST_OCP_TRIP_DELAY / (float)MAIN_EXECUTION_PERIOD)-1.0) 
#define BOOST_OCP_RDLY    (uint16_t)(((float)   BOOST_OCP_RECOVERY_DELAY / (float)MAIN_EXECUTION_PERIOD)-1.0) 
 
 // end of group fault-response-macros-boost ~~~~~~~~~~~~~~~~~~~~~~~~~
    
 
#endif  /* INCLUDE_BOOST */
 
 
 
#define TEMP_CAL_ZERO       (float) 0.500   // Temperature sense signal zero point voltage in [V]
#define TEMP_CAL_SLOPE      (float) 0.010   // Temperature sense signal slope in [V/K]
 // end of group temperature-feedback-settings
 
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#define TEMP_FB_ZERO            (uint16_t)(TEMP_CAL_ZERO / ADC_GRANULARITY)
#define TEMP_FB_SLOPE           (float)(TEMP_CAL_SLOPE / ADC_GRANULARITY)
 // end of group temperature-feedback-macros
 
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#define _TEMP_ADCInterrupt          _ADCAN2Interrupt 
#define _TEMP_ADCISR_IF             _ADCAN2IF   
 
#define TEMP_ANSEL                  _ANSELB7    
#define TEMP_ADCCORE                8           // 0=Dedicated Core #0, 1=Dedicated Core #1, 8=Shared ADC Core
#define TEMP_ADCIN                  2           // Analog input number (e.g. '5' for 'AN5')
#define TEMP_ADCBUF                 ADCBUF2     
#define TEMP_ADCTRIG                BUCK_PWM_PGxTRIGB    
#define TEMP_TRGSRC                 BUCK_PWM_TRGSRC_TRG2    // PWM2 Trigger 2 via PG1TRIGB
     // end of group temperature-feedback-mcal
 
 
#if (INCLUDE_LCD == true)
 
 
#define LCD_SCL_SetHigh()           _LATC5 = 1
#define LCD_SCL_SetLow()            _LATC5 = 0
#define LCD_SCL_Toggle()            _LATC5 ^= 1
#define LCD_SCL_GetValue()          _RC5
#define LCD_SCL_SetDigitalInput()   _TRISC5 = 1
#define LCD_SCL_SetDigitalOutput()  _TRISC5 = 0
 
#define LCD_SDI_SetHigh()           _LATC4 = 1
#define LCD_SDI_SetLow()            _LATC4 = 0
#define LCD_SDI_Toggle()            _LATC4 ^= 1
#define LCD_SDI_GetValue()          _RC4
#define LCD_SDI_SetDigitalInput()   _TRISC4 = 1
#define LCD_SDI_SetDigitalOutput()  _TRISC4 = 0
 
#define LCD_CS_SetHigh()            _LATD8 = 1
#define LCD_CS_SetLow()             _LATD8 = 0
#define LCD_CS_Toggle()             _LATD8 ^= 1
#define LCD_CS_GetValue()           _RD8
#define LCD_CS_SetDigitalInput()    _TRISD8 = 1
#define LCD_CS_SetDigitalOutput()   _TRISD8 = 0
 
#define LCD_RST_SetHigh()           _LATC8 = 1
#define LCD_RST_SetLow()            _LATC8 = 0
#define LCD_RST_Toggle()            _LATC8 ^= 1
#define LCD_RST_GetValue()          _RC8
#define LCD_RST_SetDigitalInput()   _TRISC8 = 1
#define LCD_RST_SetDigitalOutput()  _TRISC8 = 0
 
#define LCD_RS_SetHigh()            _LATC9 = 1
#define LCD_RS_SetLow()             _LATC9 = 0
#define LCD_RS_Toggle()             _LATC9 ^= 1
#define LCD_RS_GetValue()           _RC9
#define LCD_RS_SetDigitalInput()    _TRISC9 = 1
#define LCD_RS_SetDigitalOutput()   _TRISC9 = 0
 // end of group lcd-interface-declarations
 // Doxygen section
#endif /* INCLUDE_LCD */
 
#endif  /* DPSK3_HARDWARE_DESCRIPTOR_H */
 
// end of file