ADC_Analog_to_Digital_Converter_api

Functions
void	ADCEnable (unsigned long ulBase)
void	ADCDisable (unsigned long ulBase)
void	ADCChannelEnable (unsigned long ulBase, unsigned long ulChannel)
void	ADCChannelDisable (unsigned long ulBase, unsigned long ulChannel)
void	ADCIntRegister (unsigned long ulBase, unsigned long ulChannel, void(*pfnHandler)(void))
void	ADCIntUnregister (unsigned long ulBase, unsigned long ulChannel)
void	ADCIntEnable (unsigned long ulBase, unsigned long ulChannel, unsigned long ulIntFlags)
void	ADCIntDisable (unsigned long ulBase, unsigned long ulChannel, unsigned long ulIntFlags)
unsigned long	ADCIntStatus (unsigned long ulBase, unsigned long ulChannel)
void	ADCIntClear (unsigned long ulBase, unsigned long ulChannel, unsigned long ulIntFlags)
void	ADCDMAEnable (unsigned long ulBase, unsigned long ulChannel)
void	ADCDMADisable (unsigned long ulBase, unsigned long ulChannel)
void	ADCTimerConfig (unsigned long ulBase, unsigned long ulValue)
void	ADCTimerReset (unsigned long ulBase)
void	ADCTimerEnable (unsigned long ulBase)
void	ADCTimerDisable (unsigned long ulBase)
unsigned long	ADCTimerValueGet (unsigned long ulBase)
unsigned char	ADCFIFOLvlGet (unsigned long ulBase, unsigned long ulChannel)
unsigned long	ADCFIFORead (unsigned long ulBase, unsigned long ulChannel)

Detailed Description

Function Documentation

void ADCChannelDisable	(	unsigned long	ulBase,
		unsigned long	ulChannel
	)

Disables specified ADC channel

Parameters

ulBase	is the base address of the ADC
ulChannel	is one of the valid ADC channelsber

This function disables specified ADC channel.

Returns

None.

void ADCChannelEnable	(	unsigned long	ulBase,
		unsigned long	ulChannel
	)

Enables specified ADC channel

Parameters

ulBase	is the base address of the ADC
ulChannel	is one of the valid ADC channels

This function enables specified ADC channel and configures the pin as analog pin.

Returns

None.

void ADCDisable

(

unsigned long

ulBase

)

Disable the ADC

Parameters

ulBase

is the base address of the ADC

This function clears the ADC global enable

Returns

None.

void ADCDMADisable	(	unsigned long	ulBase,
		unsigned long	ulChannel
	)

Disables the ADC DMA operation for specified channel

Parameters

ulBase	is the base address of the ADC
ulChannel	is one of the valid ADC channels

This function disables the DMA operation for specified ADC channel

The parameter ulChannel should be one of the following

• ADC_CH_0 for channel 0
• ADC_CH_1 for channel 1
• ADC_CH_2 for channel 2
• ADC_CH_3 for channel 3

Returns

None.

void ADCDMAEnable	(	unsigned long	ulBase,
		unsigned long	ulChannel
	)

Enables the ADC DMA operation for specified channel

Parameters

ulBase	is the base address of the ADC
ulChannel	is one of the valid ADC channels

This function enables the DMA operation for specified ADC channel

The parameter ulChannel should be one of the following

• ADC_CH_0 for channel 0
• ADC_CH_1 for channel 1
• ADC_CH_2 for channel 2
• ADC_CH_3 for channel 3

Returns

None.

void ADCEnable

(

unsigned long

ulBase

)

Enables the ADC

Parameters

ulBase

is the base address of the ADC

This function sets the ADC global enable

Returns

None.

unsigned char ADCFIFOLvlGet	(	unsigned long	ulBase,
		unsigned long	ulChannel
	)

Gets the current FIFO level for specified ADC channel

Parameters

ulBase	is the base address of the ADC
ulChannel	is one of the valid ADC channels.

This function returns the current FIFO level for specified ADC channel.

The parameter ulChannel should be one of the following

• ADC_CH_0 for channel 0
• ADC_CH_1 for channel 1
• ADC_CH_2 for channel 2
• ADC_CH_3 for channel 3

Returns

Return the current FIFO level for specified channel

unsigned long ADCFIFORead	(	unsigned long	ulBase,
		unsigned long	ulChannel
	)

Reads FIFO for specified ADC channel

Parameters

ulBase	is the base address of the ADC
ulChannel	is one of the valid ADC channels.

This function returns one data sample from the channel fifo as specified by ulChannel parameter.

The parameter ulChannel should be one of the following

• ADC_CH_0 for channel 0
• ADC_CH_1 for channel 1
• ADC_CH_2 for channel 2
• ADC_CH_3 for channel 3

Returns

Return one data sample from the channel fifo.

void ADCIntClear	(	unsigned long	ulBase,
		unsigned long	ulChannel,
		unsigned long	ulIntFlags
	)

Clears the current channel interrupt sources

Parameters

ulBase	is the base address of the ADC
ulChannel	is one of the valid ADC channels
ulIntFlags	is the bit mask of the interrupt sources to be cleared.

This function clears individual interrupt source for the specified ADC channel.

The parameter ulChannel should be as explained in

See also

ADCIntEnable().

Returns

None.

void ADCIntDisable	(	unsigned long	ulBase,
		unsigned long	ulChannel,
		unsigned long	ulIntFlags
	)

Disables individual interrupt sources for specified channel

Parameters

ulBase	is the base address of the ADC.
ulChannel	is one of the valid ADC channels
ulIntFlags	is the bit mask of the interrupt sources to be enabled.

This function disables the indicated ADC interrupt sources. Only the sources that are enabled can be reflected to the processor interrupt; disabled sources have no effect on the processor.

The parametersulIntFlags and ulChannel should be as explained in ADCIntEnable().

Returns

None.

void ADCIntEnable	(	unsigned long	ulBase,
		unsigned long	ulChannel,
		unsigned long	ulIntFlags
	)

Enables individual interrupt sources for specified channel

Parameters

ulBase	is the base address of the ADC
ulChannel	is one of the valid ADC channels
ulIntFlags	is the bit mask of the interrupt sources to be enabled.

This function enables the indicated ADC interrupt sources. Only the sources that are enabled can be reflected to the processor interrupt; disabled sources have no effect on the processor.

The parameter ulChannel should be one of the following

• ADC_CH_0 for channel 0
• ADC_CH_1 for channel 1
• ADC_CH_2 for channel 2
• ADC_CH_3 for channel 3

The ulIntFlags parameter is the logical OR of any of the following:

• ADC_DMA_DONE for DMA done
• ADC_FIFO_OVERFLOW for FIFO over flow
• ADC_FIFO_UNDERFLOW for FIFO under flow
• ADC_FIFO_EMPTY for FIFO empty
• ADC_FIFO_FULL for FIFO full

Returns

None.

void ADCIntRegister	(	unsigned long	ulBase,
		unsigned long	ulChannel,
		void(*)(void)	pfnHandler
	)

Enables and registers ADC interrupt handler for specified channel

Parameters

ulBase	is the base address of the ADC
ulChannel	is one of the valid ADC channels
pfnHandler	is a pointer to the function to be called when the ADC channel interrupt occurs.

This function enables and registers ADC interrupt handler for specified channel. Individual interrupt for each channel should be enabled using

See also

ADCIntEnable(). It is the interrupt handler's responsibility to clear the interrupt source.

The parameter ulChannel should be one of the following

• ADC_CH_0 for channel 0
• ADC_CH_1 for channel 1
• ADC_CH_2 for channel 2
• ADC_CH_3 for channel 3

Returns

None.

unsigned long ADCIntStatus	(	unsigned long	ulBase,
		unsigned long	ulChannel
	)

Gets the current channel interrupt status

Parameters

ulBase	is the base address of the ADC
ulChannel	is one of the valid ADC channels

This function returns the interrupt status of the specified ADC channel.

The parameter ulChannel should be as explained in

See also

ADCIntEnable().

Returns

Return the ADC channel interrupt status, enumerated as a bit field of values described in ADCIntEnable()

void ADCIntUnregister	(	unsigned long	ulBase,
		unsigned long	ulChannel
	)

Disables and unregisters ADC interrupt handler for specified channel

Parameters

ulBase	is the base address of the ADC
ulChannel	is one of the valid ADC channels

This function disables and unregisters ADC interrupt handler for specified channel. This function also masks off the interrupt in the interrupt controller so that the interrupt handler no longer is called.

The parameter ulChannel should be one of the following

• ADC_CH_0 for channel 0
• ADC_CH_1 for channel 1
• ADC_CH_2 for channel 2
• ADC_CH_3 for channel 3

Returns

None.

void ADCTimerConfig	(	unsigned long	ulBase,
		unsigned long	ulValue
	)

Configures the ADC internal timer

Parameters

ulBase	is the base address of the ADC
ulValue	is wrap arround value of the timer

This function Configures the ADC internal timer. The ADC timer is a 17 bit used to timestamp the ADC data samples internally. User can read the timestamp along with the sample from the FIFO register(s). Each sample in the FIFO contains 14 bit actual data and 18 bit timestamp

The parameter ulValue can take any value between 0 - 2^17

Returns

None.

void ADCTimerDisable

(

unsigned long

ulBase

)

Disables ADC internal timer

Parameters

ulBase

is the base address of the ADC

This function disables 17-bit ADC internal timer

Returns

None.

void ADCTimerEnable

(

unsigned long

ulBase

)

Enables ADC internal timer

Parameters

ulBase

is the base address of the ADC

This function enables 17-bit ADC internal timer

Returns

None.

void ADCTimerReset

(

unsigned long

ulBase

)

Resets ADC internal timer

Parameters

ulBase

is the base address of the ADC

This function resets 17-bit ADC internal timer

Returns

None.

unsigned long ADCTimerValueGet

(

unsigned long

ulBase

)

Gets the current value of ADC internal timer

Parameters

ulBase

is the base address of the ADC

This function the current value of 17-bit ADC internal timer

Returns

Return the current value of ADC internal timer.