adc_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 ADC_INTERFACE_H
#define ADC_INTERFACE_H
 
// Section: Included Files
#include <stdint.h>
#include <stdbool.h>
#include "adc_types.h"
#include "../system/interrupt_types.h"
 
#ifdef __cplusplus  //Provide C++ Compatibility
 
    extern "C" {
 
#endif
 
// Section: Data Type Definitions
  
struct ADC_INTERFACE
{   
    void (*Initialize)(void);              
    
    void (*Deinitialize)(void);            
    
    void (*Enable)(void);                  
    
    void (*Disable)(void);                 
    
    void (*SoftwareTriggerEnable)(void);   
    
    void (*SoftwareTriggerDisable)(void);  
    
    void (*ChannelSelect)(enum ADC_CHANNEL channel);  
    
    uint16_t (*ConversionResultGet)(enum ADC_CHANNEL channel);  
    
    bool (*IsConversionComplete)(enum ADC_CHANNEL channel);     
 
    void (*ResolutionSet)(enum ADC_RESOLUTION_TYPE resolution);
 
    void (*InterruptEnable)(void);        
    
    void (*InterruptDisable)(void);       
    
    void (*InterruptFlagClear)(void);     
    
    void (*InterruptPrioritySet)(uint16_t priorityValue);
    
    void (*CommonCallbackRegister)(void (*callback)(void));  
    
    void (*Tasks)(void);                                       
    
    const struct ADC_MULTICORE *adcMulticoreInterface; 
    
};
 
struct ADC_MULTICORE
{
    void (*ChannelCallbackRegister)(void(*callback)(enum ADC_CHANNEL channel, uint16_t adcVal));       
    
    void (*ComparatorCallbackRegister)(void(*callback)(enum ADC_CMP comparator));    
    
    void (*ChannelTasks)(enum ADC_CHANNEL channel);  
    
    void (*ComparatorTasks)(enum ADC_CMP comparator);  
    
    void (*IndividualChannelInterruptEnable)(enum ADC_CHANNEL channel);  
    
    void (*IndividualChannelInterruptDisable)(enum ADC_CHANNEL channel);  
    
    void (*IndividualChannelInterruptFlagClear)(enum ADC_CHANNEL channel);  
    
    void (*IndividualChannelInterruptPrioritySet)(enum ADC_CHANNEL channel,enum INTERRUPT_PRIORITY priorityValue);  
    
    void (*CorePowerEnable)(enum ADC_DEDICATED_CORE core);  
    
    void (*SharedCorePowerEnable) (void);  
    
    
    void (*PWMTriggerSourceSet)(enum ADC_CHANNEL channel, enum ADC_PWM_INSTANCE pwmInstance,  enum ADC_PWM_TRIGGERS triggerNumber);
};
 
#ifdef __cplusplus  // Provide C++ Compatibility
 
    }
 
#endif
 
#endif //ADC_INTERFACE_H