adc_pm.h File Reference

#include "adc_pm_types.h"
#include "types.h"
#include <stdbool.h>

Go to the source code of this file.

Functions
ADC_PMError	ADC_PMInit (u8 options, u8 clock_divider, u8 int_priority)
	Initializes the 12bit ADC peripheral, which on this board is wired to the Potentiometer (PM). More specifically, the ADC peripheral is wired to the channel 5 of the ADC. Hence, the library does not handle other channels.
void	ADC_PMDeinit (void)
bool	ADC_PMIsInitialized (void)
void	ADC_PMGetSample (void)
	Retrieves a single sample from the PM, and triggers the interrupt.
void	ADC_PMSetSampleReadyAction (ADC_PMInterruptHandler action)
	Sets the action to be executed when the conversion is done.
void	ADC_PMUnsetSampleReadyAction (void)

Function Documentation

ADC_PMDeinit()

void ADC_PMDeinit

(

void

)

Definition at line 44 of file adc_pm.c.

{
    POWER_TurnOffPeripheral(POW_PCADC);
    RIT_RemoveJob(ADC_PMGetSample); // Won't do nothing if absent
 
    NVIC_DisableIRQ(ADC_IRQn);
    LPC_ADC->ADCR = 0;
    LPC_ADC->ADINTEN = 0;
    initialized = false;
}

ADC_PMGetSample()

void ADC_PMGetSample

(

void

)

Retrieves a single sample from the PM, and triggers the interrupt.

Note

This function does NOT repetitively sample the PM. It only retrieves a single sample. This is because we are not handling the BURST mode of the ADC. In order to keep retrieving samples, the function must be called repeatedly.

As of now, only the basic conversion (001) is implemented.

Definition at line 55 of file adc_pm.c.

{
    SET_BIT(LPC_ADC->ADCR, 24); // Start conversion
}

ADC_PMInit()

ADC_PMError ADC_PMInit	(	u8	options,
		u8	clock_divider,
		u8	int_priority
	)

Initializes the 12bit ADC peripheral, which on this board is wired to the Potentiometer (PM). More specifically, the ADC peripheral is wired to the channel 5 of the ADC. Hence, the library does not handle other channels.

Parameters

options	ADC PM options from the ADC_PMConfig enum
clock_divider	The clock divider to be used by the ADC (division is performed by clock_divider+1)
int_priority	The priority of the ADC interrupt. If the priority is set to INT_PRIO_DEF, the default priority will be used.

Definition at line 13 of file adc_pm.c.

{
    POWER_TurnOnPeripheral(POW_PCADC);
 
    SET_BITS(LPC_PINCON->PINSEL3, 0x3, 30);                     // 11 -> ADC function for AD0.5
    LPC_ADC->ADCR = (1 << 21) | (clock_divider << 8) | ADC_CH5; // Enable ADC, set clock divider, and set channel 5
 
    LPC_ADC->ADINTEN = ADC_GLOBAL_INTEN;
    NVIC_EnableIRQ(ADC_IRQn);
 
    if (!IS_DEF_PRIORITY(int_priority) && IS_BETWEEN_EQ(int_priority, 0, 15))
        NVIC_SetPriority(ADC_IRQn, int_priority);
 
    if (options & ADC_PM_SAMPLE_WITH_RIT)
    {
        if (!RIT_IsEnabled())
            return ADC_PM_RIT_UNINIT;
 
        RIT_AddJob(ADC_PMGetSample, RIT_NO_DIVIDER);
        RIT_EnableJob(ADC_PMGetSample);
    }
 
    initialized = true;
    return ADC_PM_ERR_OK;
}

ADC_PMIsInitialized()

bool ADC_PMIsInitialized

(

void

)

Definition at line 39 of file adc_pm.c.

{
    return initialized;
}

ADC_PMSetSampleReadyAction()

void ADC_PMSetSampleReadyAction

(

ADC_PMInterruptHandler

action

)

Sets the action to be executed when the conversion is done.

Todo:

This function is not implemented void ADC_PMDisableSampling();

Parameters

action

The action to be executed when the conversion is done.

Definition at line 13 of file adc_pm_irq.c.

{
    done_action = action;
}

ADC_PMUnsetSampleReadyAction()

void ADC_PMUnsetSampleReadyAction

(

void

)

Definition at line 18 of file adc_pm_irq.c.

{
    done_action = NULL;
}