adc1.h File Reference

This is the generated driver header file for the ADC1 driver. More...

#include <xc.h>
#include <stdbool.h>
#include <stdint.h>
#include "adc_types.h"
#include "adc_interface.h"

Include dependency graph for adc1.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	ADC1_SCAN_MODE_SELECTED   true
	Defines the scan option selection done for the shared channels.
#define	ADC1_RESOLUTION   12
	Defines the ADC Resolution.

Functions
void	ADC1_Initialize (void)
	Initializes ADC1 module, using the given initialization data This function must be called before any other ADC1 function is called.
void	ADC1_Deinitialize (void)
	Deinitializes the ADC1 to POR values.
static void	ADC1_Enable (void)
	This inline function enables the ADC1 module.
static void	ADC1_Disable (void)
	This inline function disables the ADC1 module.
static void	ADC1_SoftwareTriggerEnable (void)
	This inline function sets software common trigger.
static void	ADC1_SoftwareTriggerDisable (void)
	This inline function resets software common trigger.
static void	ADC1_ChannelSelect (enum ADC_CHANNEL channel)
	This inline function allows selection of a channel for conversion.
static uint16_t	ADC1_ConversionResultGet (enum ADC_CHANNEL channel)
	Returns the conversion value for the channel selected.
static bool	ADC1_IsConversionComplete (enum ADC_CHANNEL channel)
	This inline function returns the status of conversion.This function is used to determine if conversion is completed. When conversion is complete the function returns true otherwise false.
static void	ADC1_ResolutionSet (enum ADC_RESOLUTION_TYPE resolution)
	This inline function helps to configure all cores with same resolution.
static void	ADC1_InterruptEnable (void)
	This inline function enables the ADC1 interrupt.
static void	ADC1_InterruptDisable (void)
	This inline function disables the ADC1 interrupt.
static void	ADC1_InterruptFlagClear (void)
	Clears interrupt flag manually.
static void	ADC1_InterruptPrioritySet (uint16_t priorityValue)
	This inline function allows selection of priority for interrupt.
void	ADC1_CommonCallbackRegister (void(*callback)(void))
	This function can be used to override default callback and to define custom callback for ADC1 Common event.
void	ADC1_CommonCallback (void)
	This is the default callback with weak attribute. The user can override and implement the default callback without weak attribute or can register a custom callback function using ADC1_CommonCallbackRegister.
void	ADC1_Tasks (void)
	This function is used to implement the tasks for polled implementations.
static void	ADC1_IndividualChannelInterruptEnable (enum ADC_CHANNEL channel)
	This inline function enables individual channel interrupt.
static void	ADC1_IndividualChannelInterruptDisable (enum ADC_CHANNEL channel)
	This inline function disables individual channel interrupt.
static void	ADC1_IndividualChannelInterruptFlagClear (enum ADC_CHANNEL channel)
	This inline function clears individual channel interrupt flag.
static void	ADC1_IndividualChannelInterruptPrioritySet (enum ADC_CHANNEL channel, enum INTERRUPT_PRIORITY priorityValue)
	This inline function allows selection of priority for individual channel interrupt.
void	ADC1_ChannelCallbackRegister (void(*callback)(enum ADC_CHANNEL channel, uint16_t adcVal))
	This function can be used to override default callback ADC1_ChannelCallback and to define custom callback for ADC1 Channel event. Read the conversion result of the corresponding channel in the custom callback.
void	ADC1_ChannelCallback (enum ADC_CHANNEL channel, uint16_t adcVal)
	This is the default callback function for all the analog channels. This callback is triggered once the channel conversion is done for a channel and to read the conversion result of the corresponding channel.
void	ADC1_ComparatorCallbackRegister (void(*callback)(enum ADC_CMP comparator))
	This function can be used to override default callback and to define custom callback for ADC1_Comparator event.
void	ADC1_ComparatorCallback (enum ADC_CMP comparator)
	Comparator callback function.
void	ADC1_ChannelTasks (enum ADC_CHANNEL channel)
	This function call used only in polling mode, if channel conversion is done for requested channel, the calls the respective callback function.
void	ADC1_CorePowerEnable (enum ADC_DEDICATED_CORE core)
	Enables analog and digital power for ADC1 dedicated core.
void	ADC1_SharedCorePowerEnable (void)
	Enables power for ADC1 shared Core This function is used to set the analog and digital power for ADC1 shared Core.

Variables
const struct ADC_INTERFACE	ADC1
	Structure object of type ADC_INTERFACE with the custom name given by the user in the Melody Driver User interface. The default name e.g. ADC1 can be changed by the user in the ADC user interface. This allows defining a structure with application specific name using the 'Custom Name' field. Application specific name allows the API Portability.

Detailed Description

ADC1 Generated Driver Header File

Definition in file adc1.h.