ADC Driver Library Interface

Detailed descriptions for this library can be found in the MPLAB® Harmony Documentation.
(found in the <harmony install directory>/doc folder)

System Interaction Functions

Function Name Description
DRV_ADC_Deinitialize Deinitializes the specified instance of the ADC driver module.
Implementation: Static/Dynamic
DRV_ADC_Initialize Initializes the ADC driver.
Implementation: Static/Dynamic
DRV_ADC_Status Provides the current status of the ADC driver module.
Implementation: Dynamic
DRV_ADC_Tasks Maintains the driver's state machine and implements its ISR.
Implementation: Dynamic

Client Core Configuration Functions

Function Name Description
DRV_ADC_ClientStatus Gets the current client-specific status the ADC driver.
Implementation: Dynamic
DRV_ADC_Close Closes an opened-instance of the ADC driver.
Implementation: Static/Dynamic
DRV_ADC_InputsRegister Registers an input set with the driver for sampling.
Implementation: Dynamic
DRV_ADC_Open Opens the specified ADC driver instance and returns a handle to it.
Implementation: Static/Dynamic
DRV_ADC_SamplesAvailable Identifies if any the ADC driver has any samples available to read.
Implementation: Static/Dynamic
DRV_ADC_Start Starts the ADC driver sampling and converting analog to digital values.
Implementation: Static/Dynamic
DRV_ADC_Stop Stops the ADC driver from sampling and converting analog to digital values.
Implementation: Static/Dynamic
DRV_ADC_ChannelExtendedScanInputsAdd Adds extended scan input on the supported devices.
Implementation: Static
DRV_ADC_ChannelExtendedScanInputsRemove Removes extended scan input on the supported devices.
Implementation: Static
DRV_ADC_ChannelScanInputsAdd Adds scan input.
Implementation: Static
DRV_ADC_ChannelScanInputsRemove Removes scan input.
Implementation: Static
DRV_ADC_NegativeInputSelect Selects the negative input.
Implementation: Static
DRV_ADC_PositiveInputSelect Selects the positive input.
Implementation: Static

Other Functions

Function Name Description
DRV_ADC_SamplesRead Reads the converted sample data from the ADC driver.
Implementation: Static/Dynamic
DRV_ADC_SamplesReadLatest Reads the most recently converted sample data from the ADC driver.
Implementation: Dynamic
DRV_ADC_VersionGet Gets the ADC driver version in numerical format.
Implementation: Dynamic
DRV_ADC_VersionStrGet Gets the ADC driver version in string format.
Implementation: Dynamic

Data Types and Constants

Name Description
DRV_ADC_CLIENT_STATUS Defines the client-specific status of the ADC driver.
DRV_ADC_INIT Defines the data required to initialize or reinitialize the ADC driver.
DRV_ADC_INIT_FLAGS Identifies the initialization flags of the ADC module.
DRV_ADC_INDEX_0 ADC driver index definitions.
DRV_ADC_INDEX_1 This is macro DRV_ADC_INDEX_1.
DRV_ADC_INDEX_2 This is macro DRV_ADC_INDEX_2.
DRV_ADC_BUFFER_HANDLE This type defines the ADC Driver Buffer handle.
DRV_ADC_BUFFER_STATUS Specifies the status of the buffer for the read, write and erase operations.
DRV_ADC_EVENT Identifies the possible events that can result from a request.
DRV_ADC_EVENT_HANDLER Pointer to a ADC Driver Event handler function
© 2016 Microchip Technology, Inc.
Information contained on this site regarding device applications and the like is provided only for your convenience and may be superseded by updates. It is your responsibility to ensure that your application meets with your specifications. MICROCHIP MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WHETHER EXPRESS OR IMPLIED, WRITTEN OR ORAL, STATUTORY OR OTHERWISE, RELATED TO THE INFORMATION, INCLUDING BUT NOT LIMITED TO ITS CONDITION, QUALITY, PERFORMANCE, MERCHANTABILITY OR FITNESS FOR PURPOSE. Microchip disclaims all liability arising from this information and its use. Use of Microchip devices in life support and/or safety applications is entirely at the buyer's risk, and the buyer agrees to defend, indemnify and hold harmless Microchip from any and all damages, claims, suits, or expenses resulting from such use. No licenses are conveyed, implicitly or otherwise, under any Microchip intellectual property rights.