WPILibC++: frc::DMA Class Reference

WPILibC++ 2025.3.2

Loading...

Searching...

No Matches

Class for configuring Direct Memory Access (DMA) of FPGA inputs. More...

#include <frc/DMA.h>

Public Member Functions
	DMA ()

DMA &	operator= (DMA &&other)=default

	DMA (DMA &&other)=default

void	SetPause (bool pause)
	Sets whether DMA is paused.

void	SetTimedTrigger (units::second_t period)
	Sets DMA to trigger at an interval.

void	SetTimedTriggerCycles (int cycles)
	Sets number of DMA cycles to trigger.

void	AddEncoder (const Encoder *encoder)
	Adds position data for an encoder to be collected by DMA.

void	AddEncoderPeriod (const Encoder *encoder)
	Adds timer data for an encoder to be collected by DMA.

void	AddCounter (const Counter *counter)
	Adds position data for an counter to be collected by DMA.

void	AddCounterPeriod (const Counter *counter)
	Adds timer data for an counter to be collected by DMA.

void	AddDigitalSource (const DigitalSource *digitalSource)
	Adds a digital source to be collected by DMA.

void	AddDutyCycle (const DutyCycle *digitalSource)
	Adds a digital source to be collected by DMA.

void	AddAnalogInput (const AnalogInput *analogInput)
	Adds an analog input to be collected by DMA.

void	AddAveragedAnalogInput (const AnalogInput *analogInput)
	Adds averaged data of an analog input to be collected by DMA.

void	AddAnalogAccumulator (const AnalogInput *analogInput)
	Adds accumulator data of an analog input to be collected by DMA.

int	SetExternalTrigger (DigitalSource *source, bool rising, bool falling)
	Sets an external DMA trigger.

int	SetPwmEdgeTrigger (PWM *pwm, bool rising, bool falling)
	Sets a DMA PWM edge trigger.

int	SetPwmEdgeTrigger (PWMMotorController *pwm, bool rising, bool falling)
	Sets a DMA PWMMotorController edge trigger.

void	ClearSensors ()
	Clear all sensors from the DMA collection list.

void	ClearExternalTriggers ()
	Clear all external triggers from the DMA trigger list.

void	Start (int queueDepth)
	Starts DMA Collection.

void	Stop ()
	Stops DMA Collection.

Friends
class	DMASample

Detailed Description

Class for configuring Direct Memory Access (DMA) of FPGA inputs.

Constructor & Destructor Documentation

◆ DMA() [1/2]

frc::DMA::DMA ( )

◆ DMA() [2/2]

frc::DMA::DMA ( DMA && other )

default

Member Function Documentation

◆ AddAnalogAccumulator()

void frc::DMA::AddAnalogAccumulator ( const AnalogInput * analogInput )

Adds accumulator data of an analog input to be collected by DMA.

This can only be called if DMA is not started.

Parameters

analogInput AnalogInput to add to DMA.

◆ AddAnalogInput()

void frc::DMA::AddAnalogInput ( const AnalogInput * analogInput )

Adds an analog input to be collected by DMA.

This can only be called if DMA is not started.

Parameters

analogInput AnalogInput to add to DMA.

◆ AddAveragedAnalogInput()

void frc::DMA::AddAveragedAnalogInput ( const AnalogInput * analogInput )

Adds averaged data of an analog input to be collected by DMA.

This can only be called if DMA is not started.

Parameters

analogInput AnalogInput to add to DMA.

◆ AddCounter()

void frc::DMA::AddCounter ( const Counter * counter )

Adds position data for an counter to be collected by DMA.

This can only be called if DMA is not started.

Parameters

counter Counter to add to DMA.

◆ AddCounterPeriod()

void frc::DMA::AddCounterPeriod ( const Counter * counter )

Adds timer data for an counter to be collected by DMA.

This can only be called if DMA is not started.

Parameters

counter Counter to add to DMA.

◆ AddDigitalSource()

void frc::DMA::AddDigitalSource ( const DigitalSource * digitalSource )

Adds a digital source to be collected by DMA.

This can only be called if DMA is not started.

Parameters

digitalSource DigitalSource to add to DMA.

◆ AddDutyCycle()

void frc::DMA::AddDutyCycle ( const DutyCycle * digitalSource )

Adds a digital source to be collected by DMA.

This can only be called if DMA is not started.

Parameters

digitalSource DigitalSource to add to DMA.

◆ AddEncoder()

void frc::DMA::AddEncoder ( const Encoder * encoder )

Adds position data for an encoder to be collected by DMA.

This can only be called if DMA is not started.

Parameters

encoder Encoder to add to DMA.

◆ AddEncoderPeriod()

void frc::DMA::AddEncoderPeriod ( const Encoder * encoder )

Adds timer data for an encoder to be collected by DMA.

This can only be called if DMA is not started.

Parameters

encoder Encoder to add to DMA.

◆ ClearExternalTriggers()

void frc::DMA::ClearExternalTriggers ( )

Clear all external triggers from the DMA trigger list.

This can only be called if DMA is not started.

◆ ClearSensors()

void frc::DMA::ClearSensors ( )

Clear all sensors from the DMA collection list.

This can only be called if DMA is not started.

◆ operator=()

DMA & frc::DMA::operator= ( DMA && other )

default

◆ SetExternalTrigger()

int frc::DMA::SetExternalTrigger	(	DigitalSource *	source,
		bool	rising,
		bool	falling )

Sets an external DMA trigger.

Parameters

source	the source to trigger from.
rising	trigger on rising edge.
falling	trigger on falling edge.

Returns: the index of the trigger

◆ SetPause()

void frc::DMA::SetPause ( bool pause )

Sets whether DMA is paused.

Parameters

pause True pauses DMA.

◆ SetPwmEdgeTrigger() [1/2]

int frc::DMA::SetPwmEdgeTrigger	(	PWM *	pwm,
		bool	rising,
		bool	falling )

Sets a DMA PWM edge trigger.

Parameters

pwm	the PWM to trigger from.
rising	trigger on rising edge.
falling	trigger on falling edge.

Returns: the index of the trigger

◆ SetPwmEdgeTrigger() [2/2]

int frc::DMA::SetPwmEdgeTrigger	(	PWMMotorController *	pwm,
		bool	rising,
		bool	falling )

Sets a DMA PWMMotorController edge trigger.

Parameters

pwm	the PWMMotorController to trigger from.
rising	trigger on rising edge.
falling	trigger on falling edge.

Returns: the index of the trigger

◆ SetTimedTrigger()

void frc::DMA::SetTimedTrigger ( units::second_t period )

Sets DMA to trigger at an interval.

Parameters

period Period at which to trigger DMA.

◆ SetTimedTriggerCycles()

void frc::DMA::SetTimedTriggerCycles ( int cycles )

Sets number of DMA cycles to trigger.

Parameters

cycles Number of cycles.

◆ Start()

void frc::DMA::Start ( int queueDepth )

Starts DMA Collection.

Parameters

queueDepth The number of objects to be able to queue.

◆ Stop()

void frc::DMA::Stop ( )

Stops DMA Collection.

Friends And Related Symbol Documentation

◆ DMASample

friend class DMASample

friend

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

frc/DMA.h

frc
DMA
Generated on Mon Mar 17 2025 23:50:38 for WPILibC++ by 1.12.0