Struct Ad9959

pub struct Ad9959<I> { /* private fields */ }

A device driver for the AD9959 direct digital synthesis (DDS) chip.

This chip provides four independently controllable digital-to-analog output sinusoids with configurable phase, amplitude, and frequency. All channels are inherently synchronized as they are derived off a common system clock.

The chip contains a configurable PLL and supports system clock frequencies up to 500 MHz.

The chip supports a number of serial interfaces to improve data throughput, including normal, dual, and quad SPI configurations.

Implementations

impl<I: Interface> Ad9959<I>

pub fn new( interface: I, reset: &mut impl OutputPin, io_update: &mut impl OutputPin, delay: &mut impl DelayUs<u8>, mode: Mode, reference_clock_frequency: f32, multiplier: u5, ) -> Result<Self, Error>

Construct and initialize the DDS.

Args:

• interface - An interface to the DDS.
• reset_pin - A pin connected to the DDS reset input.
• io_update - A pin connected to the DDS io_update input.
• delay - A delay implementation for blocking operation for specific amounts of time.
• desired_mode - The desired communication mode of the interface to the DDS.
• clock_frequency - The clock frequency of the reference clock input.
• multiplier - The desired clock multiplier for the system clock. This multiplies clock_frequency to generate the system clock.

pub fn csr(&mut self) -> Result<Csr, Error>

Get the current CSR register.

pub fn fr1(&mut self) -> Result<Fr1, Error>

Get the current FR1 register.

pub fn self_test(&mut self) -> Result<bool, Error>

Perform a self-test of the communication interface.

Note: This modifies the existing channel enables. They are restored upon exit.

Returns: True if the self test succeeded. False otherwise.

pub fn set_phase(&mut self, channel: Channel, phase: f32) -> Result<f32, Error>

Configure the phase of a specified channel.

Arguments:

• channel - The channel to configure the frequency of.
• phase_turns - The desired phase offset in turns.

Returns: The actual programmed phase offset of the channel in turns.

pub fn get_phase(&mut self, channel: Channel) -> Result<f32, Error>

Get the current phase of a specified channel.

Args:

• channel - The channel to get the phase of.

Returns: The phase of the channel in turns.

pub fn set_amplitude( &mut self, channel: Channel, amplitude: f32, ) -> Result<f32, Error>

Configure the amplitude of a specified channel.

Arguments:

• channel - The channel to configure the frequency of.
• amplitude - A normalized amplitude setting [0, 1].

Returns: The actual normalized amplitude of the channel relative to full-scale range.

pub fn get_amplitude(&mut self, channel: Channel) -> Result<f32, Error>

Get the configured amplitude of a channel.

Args:

• channel - The channel to get the amplitude of.

Returns: The normalized amplitude of the channel.

pub fn set_frequency( &mut self, channel: Channel, frequency: f32, ) -> Result<f32, Error>

Configure the frequency of a specified channel.

Arguments:

• channel - The channel to configure the frequency of.
• frequency - The desired output frequency in Hz.

Returns: The actual programmed frequency of the channel.

pub fn get_frequency(&mut self, channel: Channel) -> Result<f32, Error>

Get the frequency of a channel.

Arguments:

• channel - The channel to get the frequency of.

Returns: The frequency of the channel in Hz.

pub fn freeze(self) -> (I, Mode)

Finalize DDS configuration

Note

This is intended for when the DDS profiles will be written as a stream of data to the DDS.

Returns

(i, mode) where i is the interface to the DDS and mode is the frozen Mode.