pwm_hs_interface.h

 
/*
© [2024] Microchip Technology Inc. and its subsidiaries.
 
    Subject to your compliance with these terms, you may use Microchip 
    software and any derivatives exclusively with Microchip products. 
    You are responsible for complying with 3rd party license terms  
    applicable to your use of 3rd party software (including open source  
    software) that may accompany Microchip software. SOFTWARE IS ?AS IS.? 
    NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS 
    SOFTWARE, INCLUDING ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT,  
    MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. 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 RELATED TO THE SOFTWARE WILL NOT 
    EXCEED AMOUNT OF FEES, IF ANY, YOU PAID DIRECTLY TO MICROCHIP FOR 
    THIS SOFTWARE.
*/
 
#ifndef PWM_HS_INTERFACE_H
#define PWM_HS_INTERFACE_H
 
// Section: Included Files
 
#include <stdbool.h>
#include <stdint.h>
#include "pwm_hs_types.h"
 
// Section: Data Type Definitions
        
struct PWM_HS_INTERFACE{
    void (*Initialize)(void);
    
    void (*Deinitialize)(void);
    
    void (*Disable)(void);
    
    void (*Enable)(void);
    
    void (*MasterPeriodSet)(uint16_t period);
    
    void (*MasterDutyCycleSet)(uint16_t masterDutyCycle);
 
    void (*MasterPhaseSet)(uint16_t masterPhase);
    
    void (*PeriodSet)(enum PWM_GENERATOR genNum, uint16_t period);
    
    void (*ModeSet)(enum PWM_GENERATOR genNum, enum PWM_MODES mode);
    
    void (*DutyCycleSet)(enum PWM_GENERATOR genNum, uint16_t dutyCycle);
    
    void (*PhaseSelect)(enum PWM_GENERATOR genNum, enum PWM_SOURCE_SELECT source);
    
    void (*PhaseSet)(enum PWM_GENERATOR genNum, uint16_t phase);
    
    void (*OverrideDataSet)(enum PWM_GENERATOR genNum, uint16_t overrideData);
    
    void (*OverrideDataHighSet)(enum PWM_GENERATOR genNum, bool overrideDataHigh);
    
    void (*OverrideDataLowSet)(enum PWM_GENERATOR genNum, bool overrideDataLow);
    
    uint16_t (*OverrideDataGet)(enum PWM_GENERATOR genNum);
    
    void (*OverrideHighEnable)(enum PWM_GENERATOR genNum);
    
    void (*OverrideLowEnable)(enum PWM_GENERATOR genNum);
    
    void (*OverrideHighDisable)(enum PWM_GENERATOR genNum);
    
    void (*OverrideLowDisable)(enum PWM_GENERATOR genNum);
    
    void (*DeadTimeLowSet)(enum PWM_GENERATOR genNum,uint16_t deadtimeLow);
    
    void (*DeadTimeHighSet)(enum PWM_GENERATOR genNum,uint16_t deadtimeHigh);
    
    void (*DeadTimeSet)(enum PWM_GENERATOR genNum,uint16_t deadtime);
    
    void (*TriggerCompareValueSet)(enum PWM_GENERATOR genNum, uint16_t trigCompValue);
    
    void (*GeneratorInterruptEnable)(enum PWM_GENERATOR genNum, enum PWM_GENERATOR_INTERRUPT interrupt);
    
    void (*GeneratorInterruptDisable)(enum PWM_GENERATOR genNum, enum PWM_GENERATOR_INTERRUPT interrupt);
    
    bool (*GeneratorEventStatusGet)(enum PWM_GENERATOR genNum, enum PWM_GENERATOR_INTERRUPT interrupt);
    
    void (*GeneratorEventStatusClear)(enum PWM_GENERATOR genNum, enum PWM_GENERATOR_INTERRUPT interrupt);
        
    void (*SpecialEventPrimaryCompareValueSet)(uint16_t compareValue);
    
    void (*SpecialEventTriggerInterruptFlagClear)(void);
 
    void (*SpecialEventPrimaryInterruptEnable)(void);
 
    void (*SpecialEventPrimaryInterruptDisable)(void);
 
    void (*FaultModeLatchDisable)(enum PWM_GENERATOR genNum);
    
    void (*FaultModeLatchEnable)(enum PWM_GENERATOR genNum);
 
    void (*GeneratorDisable)(enum PWM_GENERATOR genNum);
 
    void (*GeneratorEnable)(enum PWM_GENERATOR genNum);
    
    void (*TriggerACompareValueSet)(enum PWM_GENERATOR genNum, uint16_t trigCompValue);
 
    void (*TriggerBCompareValueSet)(enum PWM_GENERATOR genNum, uint16_t trigCompValue);
 
    void (*TriggerCCompareValueSet)(enum PWM_GENERATOR genNum, uint16_t trigCompValue);
    
    void (*SoftwareUpdateRequest)(enum PWM_GENERATOR genNum);
 
    bool (*SoftwareUpdatePending)(enum PWM_GENERATOR genNum);
    
    void (*FaultModeLatchClear)(enum PWM_GENERATOR genNum);
    
    void (*Trigger1Enable)(enum PWM_GENERATOR genNum, enum PWM_TRIGGER_COMPARE compareRegister);
 
    void (*Trigger1Disable)(enum PWM_GENERATOR genNum, enum PWM_TRIGGER_COMPARE compareRegister);
 
    void (*Trigger2Enable)(enum PWM_GENERATOR genNum, enum PWM_TRIGGER_COMPARE compareRegister);
    
    void (*Trigger2Disable)(enum PWM_GENERATOR genNum, enum PWM_TRIGGER_COMPARE compareRegister);
    
    void (*GeneratorEOCEventCallbackRegister)(void (*callback)(enum PWM_GENERATOR genNum));
 
    void (*CommonEventCallbackRegister)(void (*callback)(enum PWM_COMMON_EVENT event));
 
    void (*GeneratorTasks)(enum PWM_GENERATOR intGen);
    
    void (*CommonEventTasks)(enum PWM_COMMON_EVENT event);
};
 
#endif  //PWM_HS_INTERFACE_H