2.1 ADC Multicore Driver

2.1.1 Introduction

Overview

The High Speed 12-bit Analog-to-Digital Converter (ADC) features low conversion latency, high resolution and oversampling capabilities to improve performance in AC/DC, DC/DC power converters.

Features

  • Multiple single channel dedicated ADC cores (depending on the specific device implementation) which allows for simultaneous sampling.
  • One shared (common) ADC core with sequential sampling.
  • Voltage reference of AVdd for positive reference and AVss for negative reference is supported.
  • Up to 3.5 Msps Conversion Rate per Channel at 12-Bit Resolution.
  • Low-Latency Conversion.
  • Up to 24 (Depending on the hardware capability) Analog Input Channels, with a Separate 16-Bit Conversion Result Register for each Input.
  • Conversion Result Formatted as UnsignedData on a per Channel basis.
  • Multiple Conversion Trigger Options for each Core.
  • Up to Four Integrated Digital Comparators with Dedicated Interrupts and multiple comparison options assignable to specific analog inputs.
  • The adc channels are configurable from the table in the GUI.
  • Users can configure the comparators selected in the channel table via the Comparator Table.
  • The Clock and Divider settings for ADC can be configured in the PLIB dependency of the driver module.

2.1.2 How to use the ADC Usecases

The ADC Module driver generates an API interface to support the features of the peripheral. Some use cases of are linked below. Click the links to view the code snippets associated with each.

Instructions common for all code snippets can be found here: 2.1.6.1.1 ADC Use Case Code Snippet Instructions

2.1.3 Module Documentation

2.1.3.1 ADC Multicore Driver

High-Speed, 12-Bit Multiple SARs Analog-to-Digital Converter driver using dsPIC MCUs.

2.1.3.1.1 Module description

High-Speed, 12-Bit Multiple SARs Analog-to-Digital Converter driver using dsPIC MCUs.

2.1.3.1.1.1 Data structures

  • struct ADC_INTERFACE

    Structure containing the function pointers of ADC driver.

  • struct ADC_MULTICORE

    Structure containing the function pointers of ADC driver.

2.1.3.1.1.2 Definitions
2.1.3.1.1.3 Enumerations
2.1.3.1.1.4 Functions
2.1.3.1.1.5 Variables

2.1.3.1.2 Definition Documentation

2.1.3.1.2.1 ADC1_RESOLUTION

#define ADC1_RESOLUTION 12

Defines the ADC Resolution.

2.1.3.1.2.2 ADC1_SCAN_MODE_SELECTED

#define ADC1_SCAN_MODE_SELECTED true

Defines the scan option selection done for the shared channels.

2.1.3.1.2.3 ADC_CALIBRATION_FEATURE_AVAILABLE

#define ADC_CALIBRATION_FEATURE_AVAILABLE 1

This macro defines the macro associated with ADC core calibration.

APIs Supported:  

void ADCx_CoreCalibration (enum ADC_CHANNEL channel);  

void ADC_SharedCoreCalibration (void);  

x denotes instance of ADC in ADCx, channel denotes dedicated Core. Refer to device specific datasheet to check number of cores and ADC module instance. Refer driver header file for detailed description of the APIs.

2.1.3.1.2.4 ADC_COMPARATOR_FEATURE_AVAILABLE

#define ADC_COMPARATOR_FEATURE_AVAILABLE 1

Defines the macro associated with ADC comparator feature.

APIs Supported:  

void ADCx_ComparatorEnable(void);  

void ADCx_ComparatorDisable(void);  

void ADCx_ComparatorLowThresholdSet(uint16_t threshold );  

void ADCx_ComparatorHighThresholdSet(uint16_t threshold );  

uint16_t ADCx_ComparatorEventStatusGet(void);  

uint16_t ADCx_ComparatorEventChannelGet(void);  

x denotes instance of ADC in ADCx. Refer to device specific datasheet to check number of comparators and ADC module instance. Refer driver header file for detailed description of the APIs.

2.1.3.1.2.5 ADC_INDIVIDUAL_CHANNEL_INTERRUPT_FEATURE_AVAILABLE

#define ADC_INDIVIDUAL_CHANNEL_INTERRUPT_FEATURE_AVAILABLE 1

Defines the macro associated with ADC indvidual channel interrupts.

APIs Supported:  

void ADCx_IndividualChannelInterruptEnable (enum ADC_CHANNEL channel);  

void ADCx_IndividualChannelInterruptDisable (enum ADC_CHANNEL channel);  

void ADCx_IndividualChannelInterruptFlagClear (enum ADC_CHANNEL channel);  

x denotes instance of ADC, channel denotes dedicated ADC channel. Refer to device specific datasheet to check number of cores and ADC module instance. Refer driver header file for detailed description of the APIs.

2.1.3.1.2.6 ADC_POWER_ENABLE_FEATURE_AVAILABLE

#define ADC_POWER_ENABLE_FEATURE_AVAILABLE 1

This macro defines the ADC core power enable functionality.

APIs Supported:  

void ADCx_CorePowerEnable (enum ADC_CHANNEL channel);  

void ADC_SharedCorePowerEnable (void);  

x denotes instance of ADC in ADCx, channel denotes dedicated Core. Refer to device specific datasheet to check number of cores and ADC module instance. Refer driver header file for detailed description of the APIs.

2.1.3.1.3 Function Documentation

2.1.3.1.3.1 ADC1_ChannelCallback()

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

Parameters:
in channel

- conversion completed channel

in adcVal

- conversion result of channel

Returns:

none

2.1.3.1.3.2 ADC1_ChannelCallbackRegister()

void ADC1_ChannelCallbackRegister (void(*)(enum ADC_CHANNEL channel, uint16_t adcVal) callback)

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.

Parameters:
in callback

- Address of the callback function.

Returns:

none

2.1.3.1.3.3 ADC1_ChannelSelect()

inline static void ADC1_ChannelSelect (enum ADC_CHANNEL channel)

This inline function allows selection of a channel for conversion.

Precondition:

ADC1_Initialize() function should have been called before calling this function.

Parameters:
in channel

- Channel for conversion

Returns:

none

2.1.3.1.3.4 ADC1_ChannelTasks()

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.

Precondition:

ADC1_Initialize() function should have been

called before calling this function.

Parameters:
in channel

- Selected channel.

Returns:

none

Note:

This function has to be polled to notify channel callbacks and clear the channel interrupt flags in non-interrupt mode of ADC

2.1.3.1.3.5 ADC1_CommonCallback()

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

Parameters:
none
Returns:

none

2.1.3.1.3.6 ADC1_CommonCallbackRegister()

void ADC1_CommonCallbackRegister (void(*)(void) callback)

This function can be used to override default callback and to define custom callback for ADC1 Common event.

Parameters:
in callback

- Address of the callback function.

Returns:

none

2.1.3.1.3.7 ADC1_ComparatorCallback()

void ADC1_ComparatorCallback (enum ADC_CMP comparator)

Comparator callback function.

Parameters:
in comparator

- comparator in which compare event occurred

Returns:

none

2.1.3.1.3.8 ADC1_ComparatorCallbackRegister()

void ADC1_ComparatorCallbackRegister (void(*)(enum ADC_CMP comparator) callback)

This function can be used to override default callback and to define custom callback for ADC1_Comparator event.

Parameters:
in callback

- Address of the callback function.

Returns:

none

2.1.3.1.3.9 ADC1_ConversionResultGet()

inline static uint16_t ADC1_ConversionResultGet (enum ADC_CHANNEL channel)

Returns the conversion value for the channel selected.

Precondition:

This inline function returns the conversion value only after the conversion is complete. Conversion completion status can be checked using ADC1_IsConversionComplete(channel) function.

Parameters:
in channel

- Selected channel

Returns:

Returns the analog to digital converted value

2.1.3.1.3.10 ADC1_Deinitialize()

void ADC1_Deinitialize (void )

Deinitializes the ADC1 to POR values.

Parameters:
none
Returns:

none

2.1.3.1.3.11 ADC1_Disable()

inline static void ADC1_Disable (void )

This inline function disables the ADC1 module.

Precondition:

ADC1_Initialize function should have been called before calling this function.

Parameters:
none
Returns:

none

2.1.3.1.3.12 ADC1_Enable()

inline static void ADC1_Enable (void )

This inline function enables the ADC1 module.

Precondition:

ADC1_Initialize function should have been called before calling this function.

Parameters:
none
Returns:

none

2.1.3.1.3.13 ADC1_IndividualChannelInterruptDisable()

inline static void ADC1_IndividualChannelInterruptDisable (enum ADC_CHANNEL channel)

This inline function disables individual channel interrupt.

Parameters:
in channel

- Selected channel

Returns:

none

2.1.3.1.3.14 ADC1_IndividualChannelInterruptEnable()

inline static void ADC1_IndividualChannelInterruptEnable (enum ADC_CHANNEL channel)

This inline function enables individual channel interrupt.

Parameters:
in channel

- Selected channel

Returns:

none

2.1.3.1.3.15 ADC1_IndividualChannelInterruptFlagClear()

inline static void ADC1_IndividualChannelInterruptFlagClear (enum ADC_CHANNEL channel)

This inline function clears individual channel interrupt flag.

Parameters:
in channel

- Selected channel

Returns:

none

2.1.3.1.3.16 ADC1_IndividualChannelInterruptPrioritySet()

inline static void ADC1_IndividualChannelInterruptPrioritySet (enum ADC_CHANNEL channel, enum INTERRUPT_PRIORITY priorityValue)

This inline function allows selection of priority for individual channel interrupt.

Parameters:
in channel

- Selected channel

in priorityValue

- The numerical value of interrupt priority

Returns:

none

2.1.3.1.3.17 ADC1_Initialize()

void ADC1_Initialize (void )

Initializes ADC1 module, using the given initialization data This function must be called before any other ADC1 function is called.

Parameters:
none
Returns:

none

2.1.3.1.3.18 ADC1_InterruptDisable()

inline static void ADC1_InterruptDisable (void )

This inline function disables the ADC1 interrupt.

Parameters:
none
Returns:

none

2.1.3.1.3.19 ADC1_InterruptEnable()

inline static void ADC1_InterruptEnable (void )

This inline function enables the ADC1 interrupt.

Parameters:
none
Returns:

none

2.1.3.1.3.20 ADC1_InterruptFlagClear()

inline static void ADC1_InterruptFlagClear (void )

Clears interrupt flag manually.

Parameters:
none
Returns:

none

2.1.3.1.3.21 ADC1_InterruptPrioritySet()

inline static void ADC1_InterruptPrioritySet (uint16_t priorityValue)

This inline function allows selection of priority for interrupt.

Parameters:
in priorityValue

- The numerical value of interrupt priority

Returns:

none

2.1.3.1.3.22 ADC1_IsConversionComplete()

inline 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.

Precondition:

ADC1_SoftwareTriggerEnable() function should have been called before calling this function.

Parameters:
in channel

- Selected channel

Returns:

true - Conversion is complete.

false - Conversion is not complete.

2.1.3.1.3.23 ADC1_PWMTriggerSourceSet()

void ADC1_PWMTriggerSourceSet (enum ADC_CHANNEL channel, enum ADC_PWM_INSTANCE pwmInstance, enum ADC_PWM_TRIGGERS triggerNumber)

Sets PWM trigger source for corresponding analog input.

Parameters:
in channel

- Selected channel

in pwmInstance

- PWM instance for the trigger source

in triggerNumber

- 1, for PWMx Trigger 1

in triggerNumber

- 2, for PWMx Trigger 2

Returns:

none

Note:

Configure PWM trigger value using PWM_TriggerACompareValueSet, PWM_TriggerBCompareValueSet or PWM_TriggerCCompareValueSet before calling this funcion and enable corresponding PWM trigger using PWM_Trigger1Enable or PWM_Trigger2Enable post calling it.

2.1.3.1.3.24 ADC1_ResolutionSet()

inline static void ADC1_ResolutionSet (enum ADC_RESOLUTION_TYPE resolution)

This inline function helps to configure all cores with same resolution.

Parameters:
in resolution

- Resolution type

Returns:

none

2.1.3.1.3.25 ADC1_SharedCorePowerEnable()

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.

Parameters:
none
Returns:

none

2.1.3.1.3.26 ADC1_SoftwareTriggerDisable()

inline static void ADC1_SoftwareTriggerDisable (void )

This inline function resets software common trigger.

Precondition:

ADC1_Initialize function should have been called before calling this function.

Parameters:
none
Returns:

none

2.1.3.1.3.27 ADC1_SoftwareTriggerEnable()

inline static void ADC1_SoftwareTriggerEnable (void )

This inline function sets software common trigger.

Precondition:

ADC1_Initialize function should have been called before calling this function.

Parameters:
none
Returns:

none

2.1.3.1.3.28 ADC1_Tasks()

void ADC1_Tasks (void )

This function is used to implement the tasks for polled implementations.

Precondition:

ADC1_Initialize() function should have been called before calling this function.

Parameters:
none
Returns:

none

Note:

This function has to be polled to notify callbacks and clear the interrupt flags in non-interrupt mode of ADC

2.1.3.1.4 Enumeration Type Documentation

2.1.3.1.4.1 ADC_CHANNEL

enum ADC_CHANNEL

Defines the ADC channles that are selected from the MCC Melody User Interface for the ADC conversions.

Note:

The enum list in the Help document might be just a reference to show the analog channel list. Generated enum list is based on the configuration done by user in the MCC Melody user interface.

Channel_AN2

Channel Name:AN2 Assigned to:Shared Channel

MAX_CHANNELS

MAX_CHANNELS will be removed in future MCC releases. Use ADC_MAX_CHANNELS instead

ADC_MAX_CHANNELS

Maximum number of channels configured by user in MCC Melody User Interface

2.1.3.1.4.2 ADC_CMP

enum ADC_CMP

Defines the ADC comparators that are available for the module to use.

MAX_CMPS

MAX_CMPS will be removed in future MCC releases. Use ADC_MAX_CMPS instead

ADC_MAX_CMPS

Maximum Comparators configured by user in MCC Melody User Interface

2.1.3.1.4.3 ADC_DEDICATED_CORE

enum ADC_DEDICATED_CORE

Defines the ADC cores that are available for the module to use.

Note:

The enum list in the Help document might be just a reference to to show the dedicated core list. Generated enum list is based on the configuration done by user in the MCC Melody user interface.

MAX_DEDICATED_CORES

MAX_DEDICATED_CORES will be removed in future MCC releases. Use ADC_MAX_DEDICATED_CORES instead

ADC_MAX_DEDICATED_CORES

Maximum cores configured by user in MCC Melody User Interface

2.1.3.1.4.4 ADC_PWM_INSTANCE

enum ADC_PWM_INSTANCE

Defines the ADC PWM trigger sources that are available for the module to use.

Note:

Refer PWM_GENERATOR enum for mapping between custom name and instance

ADC_PWM_GENERATOR_1

PWM name:PWM_GENERATOR_1

ADC_PWM_GENERATOR_2

PWM name:PWM_GENERATOR_2

ADC_PWM_GENERATOR_3

PWM name:PWM_GENERATOR_3

ADC_PWM_GENERATOR_4

PWM name:PWM_GENERATOR_4

ADC_PWM_GENERATOR_5

PWM name:PWM_GENERATOR_5

ADC_PWM_GENERATOR_6

PWM name:PWM_GENERATOR_6

ADC_PWM_GENERATOR_7

PWM name:PWM_GENERATOR_7

ADC_PWM_GENERATOR_8

PWM name:PWM_GENERATOR_8

2.1.3.1.4.5 ADC_PWM_TRIGGERS

enum ADC_PWM_TRIGGERS

Defines the PWM triggers that are available in each individual PWM.

ADC_PWM_TRIGGER_1

PWM TRIGGER 1

ADC_PWM_TRIGGER_2

PWM TRIGGER 2

2.1.3.1.4.6 ADC_RESOLUTION_TYPE

enum ADC_RESOLUTION_TYPE

Defines the supported ADC resolution types.

ADC_6_BIT_RESOLUTION

ADC Resolution of 6 bit

ADC_8_BIT_RESOLUTION

ADC Resolution of 8 bit

ADC_10_BIT_RESOLUTION

ADC Resolution of 10 bit

ADC_12_BIT_RESOLUTION

ADC Resolution of 12 bit

2.1.3.1.5 Variable Documentation

2.1.3.1.5.1 ADC1

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.

2.1.4 Class Documentation

2.1.4.1 ADC_INTERFACE Struct Reference

Structure containing the function pointers of ADC driver.

2.1.4.1.1 Detailed Description

Structure containing the function pointers of ADC driver.

#include <adc_interface.h>

2.1.4.1.1.1 Public Attributes

2.1.4.1.2 Member Data Documentation

The documentation for this struct was generated from the following file:

source/

adc_interface.h

2.1.4.1.2.1 adcMulticoreInterface

const struct ADC_MULTICORE* adcMulticoreInterface

Pointer to ADC_MULTICORE.

2.1.4.1.2.2 ChannelSelect

void(* ChannelSelect) (enum ADC_CHANNEL channel)

Pointer to ADCx_ChannelSelect e.g. ADC1_ChannelSelect.

2.1.4.1.2.3 CommonCallbackRegister

void(* CommonCallbackRegister) (void(*callback)(void))

Pointer to ADCx_CommonCallbackRegister e.g. ADC1_CommonCallbackRegister.

2.1.4.1.2.4 ConversionResultGet

uint16_t(* ConversionResultGet) (enum ADC_CHANNEL channel)

Pointer to ADCx_ConversionResultGet e.g. ADC1_ConversionResultGet.

2.1.4.1.2.5 Deinitialize

void(* Deinitialize) (void)

Pointer to ADCx_Deinitialize e.g. ADC1_Deinitialize.

2.1.4.1.2.6 Disable

void(* Disable) (void)

Pointer to ADCx_Disable e.g. ADC1_Disable.

2.1.4.1.2.7 Enable

void(* Enable) (void)

Pointer to ADCx_Enable e.g. ADC1_Enable.

2.1.4.1.2.8 Initialize

void(* Initialize) (void)

Pointer to ADCx_Initialize e.g. ADC1_Initialize.

2.1.4.1.2.9 InterruptDisable

void(* InterruptDisable) (void)

Pointer to ADCx_InterruptDisable e.g. ADC1_InterruptDisable.

2.1.4.1.2.10 InterruptEnable

void(* InterruptEnable) (void)

Pointer to ADCx_InterruptEnable e.g. ADC1_InterruptEnable.

2.1.4.1.2.11 InterruptFlagClear

void(* InterruptFlagClear) (void)

Pointer to ADCx_InterruptFlagClear e.g. ADC1_InterruptFlagClear.

2.1.4.1.2.12 InterruptPrioritySet

void(* InterruptPrioritySet) (uint16_t priorityValue)

Pointer to ADCx_InterruptPrioritySet e.g. ADC1_InterruptPrioritySet.

2.1.4.1.2.13 IsConversionComplete

bool(* IsConversionComplete) (enum ADC_CHANNEL channel)

Pointer to ADCx_IsConversionComplete e.g. ADC1_IsConversionComplete.

2.1.4.1.2.14 ResolutionSet

void(* ResolutionSet) (enum ADC_RESOLUTION_TYPE resolution)

Pointer to ADCx_ResolutionSet e.g. ADC1_ResolutionSet.

2.1.4.1.2.15 SoftwareTriggerDisable

void(* SoftwareTriggerDisable) (void)

Pointer to ADCx_SoftwareTriggerDisable e.g. ADC1_SoftwareTriggerDisable.

2.1.4.1.2.16 SoftwareTriggerEnable

void(* SoftwareTriggerEnable) (void)

Pointer to ADCx_SoftwareTriggerEnable e.g. ADC1_SoftwareTriggerEnable.

2.1.4.1.2.17 Tasks

void(* Tasks) (void)

Pointer to ADCx_Tasks e.g. ADC1_Tasks (Supported only in polling mode)

2.1.4.2 ADC_MULTICORE Struct Reference

Structure containing the function pointers of ADC driver.

2.1.4.2.1 Detailed Description

Structure containing the function pointers of ADC driver.

#include <adc_interface.h>

2.1.4.2.1.1 Public Attributes

2.1.4.2.2 Member Data Documentation

The documentation for this struct was generated from the following file:

source/

adc_interface.h

2.1.4.2.2.1 ChannelCallbackRegister

void(* ChannelCallbackRegister) (void(*callback)(enum ADC_CHANNEL channel, uint16_t adcVal))

Pointer to ADCx_ChannelCallbackRegister e.g. ADC1_ChannelCallbackRegister.

2.1.4.2.2.2 ChannelTasks

void(* ChannelTasks) (enum ADC_CHANNEL channel)

Pointer to ADCx_ChannelTasks e.g. ADC1_ChannelTasks.

2.1.4.2.2.3 ComparatorCallbackRegister

void(* ComparatorCallbackRegister) (void(*callback)(enum ADC_CMP comparator))

Pointer to ADCx_ComparatorCallbackRegister e.g. ADC1_ComparatorCallbackRegister.

2.1.4.2.2.4 ComparatorTasks

void(* ComparatorTasks) (enum ADC_CMP comparator)

Pointer to ADCx_ComparatorTasks e.g. ADC1_ComparatorTasks.

2.1.4.2.2.5 CorePowerEnable

void(* CorePowerEnable) (enum ADC_DEDICATED_CORE core)

Pointer to ADCx_CorePowerEnable e.g. ADC1_CorePowerEnable.

2.1.4.2.2.6 IndividualChannelInterruptDisable

void(* IndividualChannelInterruptDisable) (enum ADC_CHANNEL channel)

Pointer to ADCx_IndividualChannelInterruptDisable e.g. ADC1_IndividualChannelInterruptDisable.

2.1.4.2.2.7 IndividualChannelInterruptEnable

void(* IndividualChannelInterruptEnable) (enum ADC_CHANNEL channel)

Pointer to ADCx_IndividualChannelInterruptEnable e.g. ADC1_IndividualChannelInterruptEnable.

2.1.4.2.2.8 IndividualChannelInterruptFlagClear

void(* IndividualChannelInterruptFlagClear) (enum ADC_CHANNEL channel)

Pointer to ADCx_IndividualChannelInterruptFlagClear e.g. ADC1_IndividualChannelInterruptFlagClear.

2.1.4.2.2.9 IndividualChannelInterruptPrioritySet

void(* IndividualChannelInterruptPrioritySet) (enum ADC_CHANNEL channel, enum INTERRUPT_PRIORITY priorityValue)

Pointer to ADCx_IndividualChannelInterruptPrioritySet e.g. ADC1_IndividualChannelInterruptPrioritySet.

2.1.4.2.2.10 PWMTriggerSourceSet

void(* PWMTriggerSourceSet) (enum ADC_CHANNEL channel, enum ADC_PWM_INSTANCE pwmInstance, enum ADC_PWM_TRIGGERS triggerNumber)

Pointer to ADCx_PWMTriggerSourceSet e.g. ADC1_PWMTriggerSourceSet.

2.1.4.2.2.11 SharedCorePowerEnable

void(* SharedCorePowerEnable) (void)

Pointer to ADCx_SharedCorePowerEnable e.g. ADC1_SharedCorePowerEnable.

2.1.5 File Documentation

2.1.5.1 source/adc1.h File Reference

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

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

2.1.5.1.1 Functions

2.1.5.1.3 Variables

2.1.5.1.4 Detailed Description

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

ADC1 Generated Driver Header File

2.1.5.2 source/adc_features.h File Reference

This is the generated module feature header file for ADC driver.

2.1.5.2.2 Detailed Description

This is the generated module feature header file for ADC driver.

ADC Generated Feature Header File

This file provides module feature list available on the selected device. The macros defined in this file provides the flexibility to easily migrate the user application to other device which might have varied feature list. The content in this file is strictly "read only" and should not be altered.

2.1.5.3 source/adc_interface.h File Reference

#include <stdint.h>
#include <stdbool.h>
#include "adc_types.h"
#include "../system/interrupt_types.h"

2.1.5.3.1 Data structures

  • struct ADC_INTERFACE

    Structure containing the function pointers of ADC driver.

  • struct ADC_MULTICORE

    Structure containing the function pointers of ADC driver.

2.1.5.3.2 Detailed Description

ADC Generated Driver Interface Header File

2.1.5.4 source/adc_types.h File Reference

This is the generated driver types header file for the ADC driver.

2.1.5.4.1 Enumerations

2.1.5.4.2 Detailed Description

This is the generated driver types header file for the ADC driver.

ADC Generated Driver Types Header File

2.1.6 Module Documentation

2.1.6.1 ADC Use Cases

2.1.6.1.1 ADC Use Case Code Snippet Instructions

For new users it is recommended to start with the Timer0, UART and Data Streamer, since these components are used to support other use cases.

The use cases show example uses of the ADC PLIB Driver, within an MCC Melody project:

  • Add ADC to the project

  • Configure:

    1. The ADC as described in the example.

    2. Any other peripherals or pins needed for the use case.

  • Generate the code

  • Add the code snippet(s) to the application code

  • Program the board

2.1.6.1.2 ADC Use Case 1: ADC in Basic_mode with Printf of ADC Result

An ADC conversion is taken every 100 ms, on the selected analog channel. After each ADC conversion a LED is toggled and the ADC Result is sent to PC terminal using printf.

Note: Before each conversion is started, the sample capacitor is first discharged, by connecting it to the ground potential of the microcontroller.

Device Resources:

  1. Add ADC  

  2. Add UART

ADC Configuration:
  • Configuration Settings:

    1. Enable an ANx channel

    2. Select Trigger Source for the same channel as Common Software Trigger

  • Hardware Settings:

    1. Operating Mode: Basic Mode (Default)

UART:
  • Configuration Settings:

    1. Redirect Printf to UART: Yes.

  • Dependency Selector:  

    1. UART PLIB Selector: Select the UART that is connected to Serial/CDC port.

    2. Redirect STDIO to UART (for printf support): Yes

System:

  • Clock Configuration: Default (1 MHz)

  • Pins: (For all pins check board schematics)

    1. Pin Grid View: Select an ANx.

    2. Pin Grid View: Select pin for UART Transmit - Tx.

    3. Pin Grid View: Select LED pin as output.  

    4. Pins: Rename Custom Name to "LED".

After configuring the components as described above, click 'Generate' to generate the code. Then add the following code snippets to your application:

/* Required header files for ADC Example 1 */
#include "mcc_generated_files/system/system.h"
#include "mcc_generated_files/system/clock.h"

#define FCY CLOCK_PeripheralFrequencyGet()
#include <libpic30.h>

#include "mcc_generated_files/adc/adc1.h"
#include "mcc_generated_files/uart/uart1.h"
#include "mcc_generated_files/system/pins.h"

const struct ADC_INTERFACE *adc = &ADC1;
const struct UART_INTERFACE *UartSerial = &UART1_Drv;

int main(void)
{
    SYSTEM_Initialize();
    uint16_t volatile adcResult;
    
    while(1)
    {
        adc->SoftwareTriggerEnable();   //Trigger the ADC conversion via software
        __delay_ms(100);
        adcResult = adc->ConversionResultGet(Channel_AN0);  //Get ADC converted result for Channel_AN0
        printf("The ADC Result is: %d\r\n",adcResult);
        LED_Toggle(); 
    }    
}

2.1.6.1.3 ADC Use Case 2: ADC Samples Visualized with the Data Streamer

An ADC conversion is taken, on the selected analog channel, every 100 ms.

  • ADC converstions are triggerd by an timer overflow callback, where the Data Streamer variables adcResult and adcSampleCount are updated.

  • After each ADC conversion a LED is toggled and SEND_FRAME is set to true, so that a frame is sent to the Data Visualizer from the main while loop.

Device Resources:

  1. Add ADC  

  2. Add Timer (Use Case: 100 ms Timer)

  3. Add Data Streamer (Use Case: Send Frames at a Period Set by the Timer)

ADC:
  • Configuration Settings:

    1. Enable an ANx channel

    2. Select Trigger Source for the same channel as Common Software Trigger

  • Hardware Settings:

    1. Operating Mode: Basic Mode (Default)

Data Streamer:  

  • Software Settings:

    1. UART Dependency Selection: Select the UART that is connected to Serial/CDC port.

  • Data Streamer Table:

    1. uint16_t adcResult

    2. uint8_t adcSampleCount

System:

  • Clock Configuration: Default (1 MHz)

  • Pins: (For all pins check board schematics)

    1. Pin Grid View: Select an ANx.  

    2. Pin Grid View: Select pin for UART Transmit - Tx.  

    3. Pin Grid View: Select LED pin as output.  

    4. Pin Grid View: Select Debug GPIO pin.

    5. Pins: Rename Custom Names to "LED" and "DebugIO" respectively.

After configuring the components as described above, click 'Generate' to generate the code. Then add the following code snippets to your application:

D,1,1,adcResult
B,1,1,adcSampleCount

#include "mcc_generated_files/system/system.h"
#include "mcc_generated_files/system/clock.h"

#define FCY CLOCK_PeripheralFrequencyGet()
#include <libpic30.h>

#include "mcc_generated_files/timer/tmr1.h"
#include "mcc_generated_files/adc/adc1.h"
#include "mcc_generated_files/data_streamer/data_streamer.h"
#include "mcc_generated_files/system/pins.h"

/* Create a pointer of type TIMER_INTERFACE and assign it to the address of the Timer1 TIMER_INTERFACE struct.
This enables us to get access the portable API interface, which ensures that it's easy to change the peripheral instance the timer runs on. */
const struct TIMER_INTERFACE *timer = &Timer1;

const struct ADC_INTERFACE *adc = &ADC1;

volatile bool SEND_FRAME = false;

void Timer_Callback_100ms(void)
{
    DataStreamer.adcResult = adc->ConversionResultGet(Channel_AN0);
    DataStreamer.adcSampleCount++;
    LED_Toggle();
    SEND_FRAME = true;  
    adc->SoftwareTriggerEnable();   //Trigger the ADC conversion via software
}

int main(void)
{
    SYSTEM_Initialize();
    DataStreamer.adcResult = 0;
    DataStreamer.adcSampleCount = 0;
    
    timer->TimeoutCallbackRegister(Timer_Callback_100ms);  //Timer Callback Registry
  
    while(1)
    {
        if(SEND_FRAME)
        {
            WriteFrame();   //DataStreamer write
            SEND_FRAME = false;
        }
    }   
}