cmtc 0.1.2

The cmtc compiler providing cmtir-based passes to generate backends including FIRRTL, SystemVerilog and simulators.
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

//! The cmtc compiler
//!
//! `cmtc` provides passes for `cmtir` to generate  [FIRRTL](https://bar.eecs.berkeley.edu/projects/firrtl.html) (and use [firtool](https://github.com/llvm/circt/releases) to generate optimized SystemVerilog) and different simulation backends (notably [Verilator](https://www.veripool.org/verilator/) and [Khronos](https://github.com/pku-liang/ksim)).
//!
//! `cmtc` also provides driver functions (in `crate::ehdl`) for the eHDL
//! `cmtrs`, generate cmtir, and compile to
//! FIRRTL/SystemVerilog/Verilator/Khronos.
//!
//! ## Passes
//! > placed in `crate::passes`
//!
//! ## FIRRTL backend
//! > placed in `crate::to_fir`
//!
//! ## Simulation backends
//! > placed in `crate::sim`
//!
//! ## VERY IMPORTANT!!!
//!
//! `cmtrs` use nightly features for span support. You need add a file
//! `.cargo/config.toml` with the following content: 
//! 
//! ```toml
//! [build]
//! rustflags = "--cfg procmacro2_semver_exempt"
//! ```
//! 
//! as well as a `rust-toolchain.toml` file with the following content:
//! 
//! ```toml
//! [toolchain]
//! channel = "nightly-2024-12-25"
//! ```

pub use cmtir::utils;
use cmtir::*;

mod builtin;

pub mod passes;
pub use passes::*;

pub mod to_fir;
pub use to_fir::*;

pub mod sim;
pub use sim::*;

pub mod ehdl;
pub use ehdl::*;

#[cfg(test)]
mod unit_tests;