rustdv-sim 0.3.0

The cocotb-analog core: simulator-driven async executor, tasks, triggers, typed handles, clock, sim-aware queues (design-doc §4).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

//! Clock generator (port of cocotb `Clock`, mapping row 24).

use crate::executor::{TaskHandle, spawn_named};
use crate::handle::{HandleBase, LogicHandle};
use crate::time::SimDuration;
use crate::triggers::Timer;

/// `Clock::new(&dut_clk, SimDuration::ns(10)).start()`.
pub struct Clock {
    sig: LogicHandle,
    period: SimDuration,
}

impl Clock {
    pub fn new(sig: &LogicHandle, period: SimDuration) -> Clock {
        assert!(
            period.steps >= 2,
            "clock period must be at least 2 precision steps"
        );
        Clock { sig: *sig, period }
    }

    /// Spawn the free-running clock task (starts high, like cocotb's
    /// default). Cancel the returned handle to stop the clock.
    pub fn start(&self) -> TaskHandle<()> {
        let sig = self.sig;
        let high = self.period.steps / 2;
        let low = self.period.steps - high;
        spawn_named(
            async move {
                loop {
                    sig.set_u64_now(1);
                    Timer::steps(high).await;
                    sig.set_u64_now(0);
                    Timer::steps(low).await;
                }
            },
            &format!("clock({})", sig.name()),
        )
    }
}