Functions
static uint32_t	AUXTDCStatusGet (uint32_t ui32Base)
	Get the status of the AUX TDC internal state machine. More...

void	AUXTDCConfigSet (uint32_t ui32Base, uint32_t ui32StartCondition, uint32_t ui32StopCondition)
	Configure the operation of the AUX TDC. More...

static bool	AUXTDCIdle (uint32_t ui32Base)
	Check if the AUX TDC is in idle mode. More...

static void	AUXTDCEnable (uint32_t ui32Base, uint32_t ui32RunMode)
	Enable the AUX TDC for a measurement. More...

static void	AUXTDCIdleForce (uint32_t ui32Base)
	Force the AUX TDC back to Idle mode. More...

uint32_t	AUXTDCMeasurementDone (uint32_t ui32Base)
	Check if the AUX TDC is done measuring. More...

static uint32_t	AUXTDCMeasurementGet (uint32_t ui32Base)
	Get the value of the latest measurement. More...

static void	AUXTDCLimitSet (uint32_t ui32Base, uint32_t ui32Limit)
	Set the saturation limit of the measurement. More...

static uint32_t	AUXTDCLimitGet (uint32_t ui32Base)
	Get the saturation limit of the measurement. More...

static bool	AUXTDCCounterEnable (uint32_t ui32Base)
	Enables the counter if possible. More...

static bool	AUXTDCCounterDisable (uint32_t ui32Base)
	Disables the counter if possible. More...

static bool	AUXTDCCounterSet (uint32_t ui32Base, uint32_t ui32Events)
	Set the reset number of counter compare/stop event to ignore before taking a measurement. More...

static uint32_t	AUXTDCCounterGet (uint32_t ui32Base)
	Get the current number of counter compare/stop event to ignore before taking a measurement. More...

Detailed Description

Function Documentation

void AUXTDCConfigSet	(	uint32_t	ui32Base,
		uint32_t	ui32StartCondition,
		uint32_t	ui32StopCondition
	)

Configure the operation of the AUX TDC.

Use this function to configure the start and stop event for the AUX TDC.

The ui32StartCondition must be a bitwise OR of the start event and the polarity of the start event. The start events are:

The polarity of the start event is either rising AUXTDC_STARTPOL_RIS or falling AUXTDC_STARTPOL_FALL.

The ui32StopCondition must be a bitwise OR of the stop event and the polarity of the stop event. The stop events are:

The polarity of the stop event is either rising AUXTDC_STOPPOL_RIS or falling AUXTDC_STOPPOL_FALL.

Note: The AUX TDC should only be configured when the AUX TDC is in the Idle state. To ensure that software does not lock up, it is recommended to ensure that the AUX TDC is actually in idle when calling AUXTDCConfigSet(). This can be tested using AUXTDCIdle().

Parameters

ui32Base	is base address of the AUX TDC.
ui32StartCondition	is AUX TDC a bitwise OR of a start event and polarity.
ui32StopCondition	is AUX TDC a bitwise OR of a stop event and polarity.

Returns: None

See also: AUXTDCConfigSet(), AUXTDCIdle()

 {
     // Check the arguments.
     ASSERT(AUXTDCBaseValid(ui32Base));
 
     // Make sure the AUX TDC is in the idle state before changing the
     // configuration.
     while(!((HWREG(ui32Base + AUX_TDC_O_STAT) & AUX_TDC_STAT_STATE_M) ==
             AUX_TDC_STAT_STATE_IDLE))
     {
     }
 
     // Clear previous results.
     HWREG(ui32Base + AUX_TDC_O_CTL) = 0x0;
 
     // Change the configuration.
     HWREG(ui32Base + AUX_TDC_O_TRIGSRC) = ui32StartCondition | ui32StopCondition;
 }

static bool AUXTDCCounterDisable ( uint32_t ui32Base )

inlinestatic

Disables the counter if possible.

This function can be used to disable the AUX TDC stop/compare event counter.

Parameters

ui32Base is base address of the AUX TDC.

Returns: Returns true if the counter was successfully disabled. If the AUX TDC is not in Idle mode, the counter can not be disabled, and the return value will be false.

See also: AUXTDCCounterEnable() for more information on how to use the counter.

 {
     // Check the arguments.
     ASSERT(AUXTDCBaseValid(ui32Base));
 
     // Check if the AUX TDC is in Idle mode. If not in Idle mode, the counter
     // will not be disabled.
     if(!((HWREG(ui32Base + AUX_TDC_O_STAT) & AUX_TDC_STAT_STATE_M) ==
             AUX_TDC_STAT_STATE_IDLE))
     {
         return false;
     }
 
     // Disable the counter.
     HWREG(ui32Base + AUX_TDC_O_TRIGCNTCFG) = 0;
 
     // Counter successfully disabled.
     return true;
 }

static bool AUXTDCCounterEnable ( uint32_t ui32Base )

inlinestatic

Enables the counter if possible.

This function can be used to enable the AUX TDC stop/compare event counter. The counter can be used to measure multiple periods of a clock signal. For each stop/compare event the counter will be decremented by one and the measurement will continue running until the value of the counter reaches 0. The current value of the counter can be read using AUXTDCCounterGet(). The reset value of the counter can be set using AUXTDCCounterSet().

Parameters

ui32Base is base address of the AUX TDC.

Returns: Returns true if the counter was successfully enabled. If the AUX TDC is not in Idle mode, the counter can not be enabled, and the return value will be false.

See also: AUXTDCCounterGet(), AUXTDCCounterSet()

 {
     // Check the arguments.
     ASSERT(AUXTDCBaseValid(ui32Base));
 
     // Check if the AUX TDC is in idle mode. If not in Idle mode, the counter
     // will not be enabled.
     if(!((HWREG(ui32Base + AUX_TDC_O_STAT) & AUX_TDC_STAT_STATE_M) ==
             AUX_TDC_STAT_STATE_IDLE))
     {
         return false;
     }
 
     // Enable the counter.
     HWREG(ui32Base + AUX_TDC_O_TRIGCNTCFG) = AUX_TDC_TRIGCNTCFG_EN;
 
     // Counter successfully enabled.
     return true;
 }

static uint32_t AUXTDCCounterGet ( uint32_t ui32Base )

inlinestatic

Get the current number of counter compare/stop event to ignore before taking a measurement.

This function returns the current value of compare/stop events before a measurement is registered. This value is decremented by one for each registered compare/stop event and will always be less than or equal the reset value of the counter set using AUXTDCCounterSet().

Parameters

ui32Base is base address of the AUX TDC.

Returns: Returns the current value of compare/stop events ignored before a measurement is performed.

See also: AUXTDCCounterEnable().

 {
     // Check the arguments.
     ASSERT(AUXTDCBaseValid(ui32Base));
 
     // Return the current counter value.
     return (HWREG(ui32Base + AUX_TDC_O_TRIGCNT));
 }

static bool AUXTDCCounterSet	(	uint32_t	ui32Base,
		uint32_t	ui32Events
	)

inlinestatic

Set the reset number of counter compare/stop event to ignore before taking a measurement.

This function loads the reset value of the counter with the specified number of events to ignore. A reset in this context means the counter has been disabled and then enabled.

Parameters

ui32Base	is base address of the AUX TDC.
ui32Events	is the number of compare/stop events to load into the counter.

Returns: Returns true if the counter was successfully updated. If the AUX TDC is not in Idle mode, the counter can not be updated, and the return value will be false.

See also: AUXTDCCounterEnable()

 {
     // Check the arguments.
     ASSERT(AUXTDCBaseValid(ui32Base));
 
     // Check if the AUX TDC is in idle mode. If not in idle mode, the counter
     // will not be disabled.
     if(!((HWREG(ui32Base + AUX_TDC_O_STAT) & AUX_TDC_STAT_STATE_M) ==
             AUX_TDC_STAT_STATE_IDLE))
     {
         return false;
     }
 
     // Update the reset counter value.
     HWREG(ui32Base + AUX_TDC_O_TRIGCNTLOAD) = ui32Events;
 
     // Counter successfully updated.
     return true;
 }

static void AUXTDCEnable	(	uint32_t	ui32Base,
		uint32_t	ui32RunMode
	)

inlinestatic

Enable the AUX TDC for a measurement.

This function is used for arming the AUX TDC to begin a measurement as soon as the start condition is met. There are two run modes:

AUX_TDC_RUNSYNC will wait for a falling event of the start pulse before starting measurement on next rising edge of start. This guarantees an edge triggered start and is recommended for frequency measurements. If the first falling edge is close to the start command it may be missed, but the TDC shall catch later falling edges and in any case guarantee a measurement start synchronous to the rising edge of the start event.
The AUX_TDC_RUN is asynchronous start and asynchronous stop mode. Using this a TDC measurement may start immediately if start is high and hence it may not give precise edge to edge measurements. This mode is only recommended when start pulse is guaranteed to arrive at least 7 clock periods after command.

Note: The AUX TDC should be configured and in Idle mode before calling this function.

Parameters

ui32Base	is the base address of the AUX TDC.
ui32RunMode	is the run mode for the AUX TDC. AUX_TDC_RUNSYNC : Synchronous run mode. AUX_TDC_RUN : Asynchronous run mode.

Returns: None

 {
     // Check the arguments.
     ASSERT(AUXTDCBaseValid(ui32Base));
     ASSERT((ui32RunMode == AUX_TDC_RUN) ||
            (ui32RunMode == AUX_TDC_RUNSYNC));
 
     // Enable the AUX TDC.
     HWREG(ui32Base + AUX_TDC_O_CTL) = ui32RunMode;
 }

static bool AUXTDCIdle ( uint32_t ui32Base )

inlinestatic

Check if the AUX TDC is in idle mode.

This function can be used to check whether the AUX TDC internal state machine is in idle mode. This is required before setting the polarity of the start and stop event.

Parameters

ui32Base is the base address of the AUX TDC.

Returns: Returns true if state machine is in idle and returns false if the state machine is in any other state.

 {
     // Check the arguments.
     ASSERT(AUXTDCBaseValid(ui32Base));
 
     // Check if the AUX TDC is in the Idle state.
     return (((HWREG(ui32Base + AUX_TDC_O_STAT) & AUX_TDC_STAT_STATE_M) ==
              AUX_TDC_STAT_STATE_IDLE) ? true : false);
 }

static void AUXTDCIdleForce ( uint32_t ui32Base )

inlinestatic

Force the AUX TDC back to Idle mode.

This function will force the AUX TDC in Idle mode. The internal state machine will not go directly to Idle mode, so it is left to the programmer to ensure that the state machine is in Idle mode before doing any new configuration. This can be checked using AUXTDCIdle().

Parameters

ui32Base is the base address of the AUX TDC.

Returns: None

See also: AUXTDCIdle()

 {
     // Check the arguments
     ASSERT(AUXTDCBaseValid(ui32Base));
 
     // Abort operation of AUX TDC and force into Idle mode.
     HWREG(ui32Base + AUX_TDC_O_CTL) = AUX_TDC_CTL_CMD_ABORT;
 }

static uint32_t AUXTDCLimitGet ( uint32_t ui32Base )

inlinestatic

Get the saturation limit of the measurement.

This function is used to retrieve the current saturation for the accumulator register.

Parameters

ui32Base is base address of the AUX TDC.

Returns

Returns the saturation limit.

See also: AUXTDCLimitSet()

 {
     // Check the arguments.
     ASSERT(AUXTDCBaseValid(ui32Base));
 
     // Return the saturation limit.
     return (HWREG(ui32Base + AUX_TDC_O_SATCFG));
 }

static void AUXTDCLimitSet	(	uint32_t	ui32Base,
		uint32_t	ui32Limit
	)

inlinestatic

Set the saturation limit of the measurement.

This function is used to set a saturation limit for the event accumulation register. The saturation limit is defined as a bit width of the accumulation register and therefore increases in power of 2.

Parameters

ui32Base	is base address of the AUX TDC.
ui32Limit	is the saturation limit. AUXTDC_SAT_4096 AUXTDC_SAT_8192 AUXTDC_SAT_16384 AUXTDC_SAT_32768 AUXTDC_SAT_65536 AUXTDC_SAT_131072 AUXTDC_SAT_262144 AUXTDC_SAT_524288 AUXTDC_SAT_1048576 AUXTDC_SAT_2097152 AUXTDC_SAT_4194304 AUXTDC_SAT_8388608 AUXTDC_SAT_16777216 (default)

Returns: None

Note: The actual value of the accumulation register might increase slightly beyond the saturation value before the saturation takes effect.

See also: AUXTDCLimitGet()

 {
     // Check the arguments.
     ASSERT(AUXTDCBaseValid(ui32Base));
     ASSERT(ui32Limit < AUXTDC_NUM_SAT_VALS);
 
     // Set the saturation limit.
     HWREG(ui32Base + AUX_TDC_O_SATCFG) = ui32Limit;
 }

uint32_t AUXTDCMeasurementDone ( uint32_t ui32Base )

Check if the AUX TDC is done measuring.

This function can be used to check whether the AUX TDC has finished a measurement. The AUX TDC may have completed a measurement for two reasons. Either it finish successfully AUX_TDC_DONE or it failed due to a timeout AUX_TDC_TIMEOUT. If the AUX TDC is still measuring it this function will return AUX_TDC_BUSY.

Parameters

ui32Base is the base address of the AUX TDC.

Returns

Returns the current status of a measurement:

AUX_TDC_DONE : An AUX TDC measurement finished successfully.
AUX_TDC_TIMEOUT : An AUX TDC measurement failed due to timeout.
AUX_TDC_BUSY : An AUX TDC measurement is being performed.

 {
     uint32_t ui32Reg;
     uint32_t ui32Status;
 
     // Check the arguments.
     ASSERT(AUXTDCBaseValid(ui32Base));
 
     // Check if the AUX TDC is done measuring.
     ui32Reg = HWREG(ui32Base + AUX_TDC_O_STAT);
     if(ui32Reg & AUX_TDC_STAT_DONE)
     {
         ui32Status = AUX_TDC_DONE;
     }
     else if(ui32Reg & AUX_TDC_STAT_SAT)
     {
         ui32Status = AUX_TDC_TIMEOUT;
     }
     else
     {
         ui32Status = AUX_TDC_BUSY;
     }
 
     // Return the status.
     return (ui32Status);
 }

static uint32_t AUXTDCMeasurementGet ( uint32_t ui32Base )

inlinestatic

Get the value of the latest measurement.

This function is used for retrieving the value of the latest measurement performed by the AUX TDC.

Parameters

ui32Base is the base address of the AUX TDC.

Returns: Returns the result of the latest measurement.

 {
     // Check the arguments.
     ASSERT(AUXTDCBaseValid(ui32Base));
 
     // Return the measurement.
     return (HWREG(ui32Base + AUX_TDC_O_RESULT));
 }

static uint32_t AUXTDCStatusGet ( uint32_t ui32Base )

inlinestatic

Get the status of the AUX TDC internal state machine.

This function will return the current state of the AUX TDC internal state machine.

Parameters

ui32Base is base address of the AUX TDC

Returns

Returns the current state of the state machine. Possible states for the state machine are:

 {
     // Check the arguments.
     ASSERT(AUXTDCBaseValid(ui32Base));
 
     // Return the status value for the correct ADI Slave.
     return((HWREG(ui32Base + AUX_TDC_O_STAT) & AUX_TDC_STAT_STATE_M) >>
            AUX_TDC_STAT_STATE_S);
 }