vpi 0.5.1

Safe and ergonomic Rust bindings to the Verilog and SystemVerilog VPI C API for writing VPI applications in Rust.
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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

use vpi_sys::PLI_INT32;

/// Simulator control operations for `vpi_control`.
#[repr(u32)]
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Control {
    /// Pause simulation execution.
    Stop = vpi_sys::vpiStop,
    /// Terminate simulation.
    Finish = vpi_sys::vpiFinish,
    /// Reset simulator state.
    Reset = vpi_sys::vpiReset,
    /// Set the interactive scope used by the simulator.
    SetInteractiveScope = vpi_sys::vpiSetInteractiveScope,
}

/// SystemVerilog coverage control operations for `vpi_control`.
#[cfg(feature = "sv")]
#[repr(u32)]
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum CoverageControl {
    /// Start coverage collection.
    Start = vpi_sys::vpiCoverageStart,
    /// Stop coverage collection.
    Stop = vpi_sys::vpiCoverageStOp,
    /// Reset collected coverage data.
    Reset = vpi_sys::vpiCoverageReset,
    /// Perform a coverage consistency/check operation.
    Check = vpi_sys::vpiCoverageCheck,
    /// Merge coverage data.
    Merge = vpi_sys::vpiCoverageMerge,
    /// Save coverage data.
    Save = vpi_sys::vpiCoverageSave,
}

/// SystemVerilog assertion control operations for `vpi_control`.
#[cfg(feature = "sv")]
#[repr(u32)]
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum AssertionControl {
    /// Lock assertion control state.
    Lock = vpi_sys::vpiAssertionLock,
    /// Unlock assertion control state.
    Unlock = vpi_sys::vpiAssertionUnlock,
    /// Disable assertion checking.
    Disable = vpi_sys::vpiAssertionDisable,
    /// Enable assertion checking.
    Enable = vpi_sys::vpiAssertionEnable,
    /// Reset assertion state.
    Reset = vpi_sys::vpiAssertionReset,
    /// Kill active assertion attempts.
    Kill = vpi_sys::vpiAssertionKill,
    /// Enable step mode for assertions.
    EnableStep = vpi_sys::vpiAssertionEnableStep,
    /// Disable step mode for assertions.
    DisableStep = vpi_sys::vpiAssertionDisableStep,
    /// Advance assertion clock steps.
    ClockSteps = vpi_sys::vpiAssertionClockSteps,
    /// Enable assertion system globally.
    SysOn = vpi_sys::vpiAssertionSysOn,
    /// Disable assertion system globally.
    SysOff = vpi_sys::vpiAssertionSysOff,
    /// Kill assertion system activity.
    SysKill = vpi_sys::vpiAssertionSysKill,
    /// End assertion system run.
    SysEnd = vpi_sys::vpiAssertionSysEnd,
    /// Reset assertion system.
    SysReset = vpi_sys::vpiAssertionSysReset,
    /// Disable pass actions.
    DisablePassAction = vpi_sys::vpiAssertionDisablePassAction,
    /// Enable pass actions.
    EnablePassAction = vpi_sys::vpiAssertionEnablePassAction,
    /// Disable fail actions.
    DisableFailAction = vpi_sys::vpiAssertionDisableFailAction,
    /// Enable fail actions.
    EnableFailAction = vpi_sys::vpiAssertionEnableFailAction,
    /// Disable vacuous actions.
    DisableVacuousAction = vpi_sys::vpiAssertionDisableVacuousAction,
    /// Enable non-vacuous actions.
    EnableNonvacuousAction = vpi_sys::vpiAssertionEnableNonvacuousAction,
    /// Enable system pass actions.
    SysEnablePassAction = vpi_sys::vpiAssertionSysEnablePassAction,
    /// Enable system fail actions.
    SysEnableFailAction = vpi_sys::vpiAssertionSysEnableFailAction,
    /// Disable system pass actions.
    SysDisablePassAction = vpi_sys::vpiAssertionSysDisablePassAction,
    /// Disable system fail actions.
    SysDisableFailAction = vpi_sys::vpiAssertionSysDisableFailAction,
    /// Enable system non-vacuous actions.
    SysEnableNonvacuousAction = vpi_sys::vpiAssertionSysEnableNonvacuousAction,
    /// Disable system vacuous actions.
    SysDisableVacuousAction = vpi_sys::vpiAssertionSysDisableVacuousAction,
}

/// Invokes `vpi_control` with the selected operation.
pub fn control(control: Control) {
    unsafe {
        vpi_sys::vpi_control(control as PLI_INT32);
    }
}

#[cfg(feature = "sv")]
fn control_sv(code: PLI_INT32) {
    unsafe {
        vpi_sys::vpi_control(code);
    }
}

/// Invokes `vpi_control` with a SystemVerilog coverage control operation.
#[cfg(feature = "sv")]
pub fn coverage_control(control: CoverageControl) {
    control_sv(control as PLI_INT32);
}

/// Invokes `vpi_control` with a SystemVerilog assertion control operation.
#[cfg(feature = "sv")]
pub fn assertion_control(control: AssertionControl) {
    control_sv(control as PLI_INT32);
}