Struct rust_hdl::widgets::strobe::Strobe

pub struct Strobe<const N: usize> {
    pub enable: Signal<In, Bit>,
    pub strobe: Signal<Out, Bit>,
    pub clock: Signal<In, Clock>,
    /* private fields */
}

A Strobe generates a periodic pulse train, with a single clock-cycle wide pulse at the prescribed frequency. The argument [N] of the generic Strobe is used to size the counter that stores the internal delay value. Unfortunately, Rust const generics are currently not good enough to compute [N] on the fly. However, a compile time assert ensures that the number of clock cycles between pulses does not overflow the [N]-bit wide register inside the Strobe.

Fields

enable: Signal<In, Bit>

Set this to true to enable the pulse train.

strobe: Signal<Out, Bit>

This is the strobing signal - it will fire for 1 clock cycle such that the strobe frequency is generated.

clock: Signal<In, Clock>

The clock that drives the Strobe. All signals are synchronous to this clock.

Implementations

impl<const N: usize> Strobe<N>

pub fn new(frequency: u64, strobe_freq_hz: f64) -> Self

Generate a Strobe widget that can be used in a RustHDL circuit.

Arguments

• frequency: The frequency (in Hz) of the clock signal driving the circuit.
• strobe_freq_hz: The desired frequency in Hz of the output strobe. Note that the strobe frequency will be rounded to something that can be obtained by dividing the input clock by an integer. As such, it may not produce exactly the desired frequency, unless frequency/strobe_freq_hz is an integer.

returns: Strobe<{ N }>

Examples

See [BlinkExample] for an example.

Trait Implementations

impl<const N: usize> Block for Strobe<N>

fn connect_all(&mut self)

Connects the internal signals of the circuit - used to initialize the circuit

fn update_all(&mut self)

Propogate changes from inputs to outputs within the circuit

fn has_changed(&self) -> bool

Returns true if anything in the circuit has changed (outputs or internal state)

fn accept(&self, name: &str, probe: &mut dyn Probe)

The visitor pattern - allows a circuit to be probed by a Probe struct.

impl<const N: usize> Clone for Strobe<N>

fn clone(&self) -> Strobe<N>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<const N: usize> Debug for Strobe<N>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<const N: usize> Logic for Strobe<N>

fn update(&mut self)

fn connect(&mut self)

fn hdl(&self) -> Verilog

fn timing(&self) -> Vec<TimingInfo>