vpi_export 0.1.9

Export Rust function to be used on a verilog module through VPI
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169

use crate::{
    FromVpiHandle, RawHandle, Result, StoreIntoVpiHandle, VpiError, VpiTaskResult, __private,
};

macro_rules! impl_from_vpi_handle {
    ($t:ty) => {
        impl FromVpiHandle for $t {
            unsafe fn from_vpi_handle(handle: RawHandle) -> Result<Self> {
                let mut value = vpi_user::t_vpi_value {
                    format: vpi_user::vpiIntVal as i32,
                    ..Default::default()
                };
                vpi_user::vpi_get_value(handle.as_ptr(), &mut value as *mut vpi_user::t_vpi_value);
                Ok(unsafe { value.value.integer } as $t)
            }
        }
    };
}

macro_rules! impl_store_into_vpi_handle {
    ($t:ty) => {
        impl StoreIntoVpiHandle for $t {
            unsafe fn store_into_vpi_handle(&self, handle: RawHandle) -> Result<()> {
                let mut value = vpi_user::t_vpi_value {
                    format: vpi_user::vpiIntVal as i32,
                    ..Default::default()
                };
                value.value.integer = *self as i32;
                vpi_user::vpi_put_value(
                    handle.as_ptr(),
                    &mut value as *mut vpi_user::t_vpi_value,
                    core::ptr::null_mut(),
                    vpi_user::vpiNoDelay as i32,
                );
                Ok(())
            }
        }
    };
}

impl_from_vpi_handle!(i8);
impl_from_vpi_handle!(i16);
impl_from_vpi_handle!(i32);
impl_from_vpi_handle!(i64);
impl_from_vpi_handle!(i128);
impl_from_vpi_handle!(isize);

impl_from_vpi_handle!(u8);
impl_from_vpi_handle!(u16);
impl_from_vpi_handle!(u32);
impl_from_vpi_handle!(u64);
impl_from_vpi_handle!(u128);
impl_from_vpi_handle!(usize);

impl_store_into_vpi_handle!(i8);
impl_store_into_vpi_handle!(i16);
impl_store_into_vpi_handle!(i32);
impl_store_into_vpi_handle!(i64);
impl_store_into_vpi_handle!(i128);
impl_store_into_vpi_handle!(isize);

impl_store_into_vpi_handle!(u8);
impl_store_into_vpi_handle!(u16);
impl_store_into_vpi_handle!(u32);
impl_store_into_vpi_handle!(u64);
impl_store_into_vpi_handle!(u128);
impl_store_into_vpi_handle!(usize);

impl StoreIntoVpiHandle for () {
    unsafe fn store_into_vpi_handle(&self, _handle: RawHandle) -> Result<()> {
        Ok(())
    }
}

impl StoreIntoVpiHandle for f32 {
    unsafe fn store_into_vpi_handle(&self, handle: RawHandle) -> Result<()> {
        let mut value = vpi_user::t_vpi_value {
            format: vpi_user::vpiRealVal as i32,
            ..Default::default()
        };
        value.value.real = *self as f64;
        vpi_user::vpi_put_value(
            handle.as_ptr(),
            &mut value as *mut vpi_user::t_vpi_value,
            core::ptr::null_mut(),
            vpi_user::vpiNoDelay as i32,
        );
        Ok(())
    }
}

impl FromVpiHandle for &str {
    unsafe fn from_vpi_handle(handle: RawHandle) -> Result<Self> {
        let s: &core::ffi::CStr = FromVpiHandle::from_vpi_handle(handle)?;
        s.to_str().map_err(VpiError::Utf8Error)
    }
}

impl FromVpiHandle for &core::ffi::CStr {
    unsafe fn from_vpi_handle(handle: RawHandle) -> Result<Self> {
        let mut value = vpi_user::t_vpi_value {
            format: vpi_user::vpiStringVal as i32,
            ..Default::default()
        };
        vpi_user::vpi_get_value(handle.as_ptr(), &mut value as *mut vpi_user::t_vpi_value);
        Ok(core::ffi::CStr::from_ptr(value.value.str_))
    }
}

impl StoreIntoVpiHandle for &core::ffi::CStr {
    unsafe fn store_into_vpi_handle(&self, handle: RawHandle) -> Result<()> {
        let mut value = vpi_user::t_vpi_value {
            format: vpi_user::vpiStringVal as i32,
            ..Default::default()
        };
        value.value.str_ = self.as_ptr() as *mut i8;
        vpi_user::vpi_put_value(
            handle.as_ptr(),
            &mut value as *mut vpi_user::t_vpi_value,
            core::ptr::null_mut(),
            vpi_user::vpiNoDelay as i32,
        );
        Ok(())
    }
}

impl __private::Sealed for () {}

impl VpiTaskResult for () {
    fn into_vpi_result(self) -> Result<()> {
        Ok(())
    }
}

impl __private::Sealed for Result<()> {}

impl VpiTaskResult for Result<()> {
    fn into_vpi_result(self) -> Result<()> {
        self
    }
}

impl FromVpiHandle for bool {
    unsafe fn from_vpi_handle(handle: RawHandle) -> Result<Self> {
        let mut value = vpi_user::t_vpi_value {
            format: vpi_user::vpiIntVal as i32,
            ..Default::default()
        };
        vpi_user::vpi_get_value(handle.as_ptr(), &mut value as *mut vpi_user::t_vpi_value);
        Ok(unsafe { value.value.integer } > 0)
    }
}

impl StoreIntoVpiHandle for bool {
    unsafe fn store_into_vpi_handle(&self, handle: RawHandle) -> Result<()> {
        let mut value = vpi_user::t_vpi_value {
            format: vpi_user::vpiIntVal as i32,
            ..Default::default()
        };
        value.value.integer = if *self { 1 } else { 0 };
        vpi_user::vpi_put_value(
            handle.as_ptr(),
            &mut value as *mut vpi_user::t_vpi_value,
            core::ptr::null_mut(),
            vpi_user::vpiNoDelay as i32,
        );
        Ok(())
    }
}