Extract FFI functions to another file

hazardflow-designs/src/gemmini/execute/mod.rs

@@ -1292,16 +1292,6 @@ fn acc_read_req<const EX_QUEUE_LENGTH: usize>(
     array_map!(reqs, filter_req)
 }
 
-/// TODO: Documentation
-#[magic(ffi::MeshWithDelaysWrapper())]
-#[allow(clippy::type_complexity)]
-pub fn mesh_with_delays_chisel<const LATENCY: usize>(
-    _input: (Vr<A>, Vr<B>, Vr<D>, I<VrH<MeshReq, TagsInProgress>, { Dep::Helpful }>),
-) -> Valid<MeshResp>
-where [(); 1 + LATENCY]: {
-    todo!("MeshWithDelaysWrapper.v")
-}
-
 #[allow(unused)]
 fn mesh_with_delays_wrapper<const LATENCY: usize>(
     a: Vr<A>,
@@ -1312,7 +1302,7 @@ fn mesh_with_delays_wrapper<const LATENCY: usize>(
 where
     [(); 1 + LATENCY]:,
 {
-    (a, b, d, req).comb(mesh_with_delays_chisel::<LATENCY>)
+    mesh_with_delays_ffi::<LATENCY>(a, b, d, req)
 }
 
 /// Execute the mesh computation.

hazardflow-designs/src/gemmini/execute/systolic_array/mesh.rs

@@ -22,11 +22,3 @@ where [(); 1 + LATENCY]: {
 pub fn mesh_4_4(in_left: MeshRowData, in_top: MeshColData) -> (MeshRowData, MeshColData) {
     mesh::<1>(in_left, in_top)
 }
-
-/// Chisel Mesh Wrapper.
-///
-/// This module allows students to proceed with future assignments even if they have not completed assignment 5.
-#[magic(ffi::MeshWrapper())]
-pub fn mesh_chisel(_in_left: MeshRowData, _in_top: MeshColData) -> (MeshRowData, MeshColData) {
-    todo!("MeshWrapper.v")
-}

hazardflow-designs/src/gemmini/execute/systolic_array/pe.rs

@@ -126,14 +126,3 @@ pub fn pe(
 ) -> (Valid<PeRowData>, (Valid<PeColData>, Valid<PeColControl>)) {
     todo!("assignment 4")
 }
-
-/// Chisel PE Wrapper.
-///
-/// This module allows students to proceed with future assignments even if they have not completed assignment 4.
-#[magic(ffi::PE256Wrapper())]
-pub fn pe_256_chisel(
-    _in_left: Valid<PeRowData>,
-    (_in_top_data, _in_top_control): (Valid<PeColData>, Valid<PeColControl>),
-) -> (Valid<PeRowData>, (Valid<PeColData>, Valid<PeColControl>)) {
-    todo!("PE256Wrapper.v")
-}

hazardflow-designs/src/gemmini/execute/systolic_array/tile.rs

@@ -12,7 +12,7 @@ pub type TileColData = [(Valid<PeColData>, Valid<PeColControl>); TILE_COLS];
 /// Tile.
 pub fn tile(in_left: TileRowData, in_top: TileColData) -> (TileRowData, TileColData) {
     // Constructs row of the tile, which has `1 x TILE_COLS` size.
-    let row = flip(seq(from_fn(flip(pe_256_chisel)))); // Using `pe_256_chisel` instead of `pe` for now.
+    let row = flip(seq(from_fn(flip(pe_ffi)))); // Using `pe_ffi` instead of `pe` for now.
 
     // Constructs tile, which has `TILE_ROWS x TILE_COLS` size.
     let tile = seq(from_fn(row));

hazardflow-designs/src/gemmini/execute/systolic_array/transposer.rs

@@ -50,11 +50,3 @@ where
 pub fn transposer_default(in_row: Valid<Array<U<INPUT_BITS>, 16>>) -> Valid<Array<U<INPUT_BITS>, 16>> {
     transposer::<16>(in_row)
 }
-
-/// Chisel Transposer Wrapper.
-///
-/// This module allows students to proceed with future assignments even if they have not completed assignment 5.
-#[magic(ffi::TransposerWrapper())]
-pub fn transposer_chisel(_in_row: Valid<Array<U<INPUT_BITS>, 16>>) -> Valid<Array<U<INPUT_BITS>, 16>> {
-    todo!("TransposerWrapper.v")
-}

hazardflow-designs/src/gemmini/ffis.rs

@@ -0,0 +1,49 @@
+//! Modules implemented as FFI.
+
+#![allow(unused_variables)]
+
+use super::execute::systolic_array::mesh::*;
+use super::execute::systolic_array::mesh_with_delays::*;
+use super::execute::systolic_array::pe::*;
+use super::*;
+
+/// Chisel MeshWithDelays Wrapper.
+#[magic(ffi::MeshWithDelaysWrapper())]
+pub fn mesh_with_delays_ffi<const LATENCY: usize>(
+    a: Vr<A>,
+    b: Vr<B>,
+    d: Vr<D>,
+    req: I<VrH<MeshReq, TagsInProgress>, { Dep::Helpful }>,
+) -> Valid<MeshResp>
+where
+    [(); 1 + LATENCY]:,
+{
+    ffi!("MeshWithDelaysWrapper.v")
+}
+
+/// Chisel Mesh Wrapper.
+///
+/// This module allows students to proceed with future assignments even if they have not completed assignment 5.
+#[magic(ffi::MeshWrapper())]
+pub fn mesh_ffi(in_left: MeshRowData, in_top: MeshColData) -> (MeshRowData, MeshColData) {
+    ffi!("MeshWrapper.v")
+}
+
+/// Chisel Transposer Wrapper.
+///
+/// This module allows students to proceed with future assignments even if they have not completed assignment 5.
+#[magic(ffi::TransposerWrapper())]
+pub fn transposer_ffi(in_row: Valid<Array<U<INPUT_BITS>, 16>>) -> Valid<Array<U<INPUT_BITS>, 16>> {
+    ffi!("TransposerWrapper.v")
+}
+
+/// Chisel PE Wrapper.
+///
+/// This module allows students to proceed with future assignments even if they have not completed assignment 4.
+#[magic(ffi::PE256Wrapper())]
+pub fn pe_ffi(
+    in_left: Valid<PeRowData>,
+    (in_top_data, in_top_control): (Valid<PeColData>, Valid<PeColControl>),
+) -> (Valid<PeRowData>, (Valid<PeColData>, Valid<PeColControl>)) {
+    ffi!("PE256Wrapper.v")
+}

hazardflow-designs/src/gemmini/mod.rs

@@ -6,6 +6,7 @@ use crate::std::*;
 pub mod arithmetic;
 pub mod configs;
 pub mod execute;
+pub mod ffis;
 pub mod isa;
 pub mod load;
 pub mod local_addr;
@@ -16,6 +17,7 @@ pub mod store;
 use arithmetic::*;
 use configs::*;
 use execute::*;
+use ffis::*;
 use isa::*;
 use load::*;
 use reservation_station::*;

hazardflow-designs/src/prelude.rs

@@ -3,4 +3,4 @@
 pub use hazardflow_macro::*;
 
 pub use crate::std::value::*;
-pub use crate::{compiler_magic, display, hassert, hpanic};
+pub use crate::{compiler_magic, display, ffi, hassert, hpanic};

hazardflow-designs/src/std/mod.rs

@@ -75,10 +75,15 @@ pub use value::*;
 /// Indicates that the function is implemented as a compiler magic.
 #[macro_export]
 macro_rules! compiler_magic {
-    () => {
-        todo!()
+    ($($msg:expr)?) => {
+        todo!($($msg)?)
     };
-    ($msg:expr) => {
-        todo!($msg)
+}
+
+/// Indicates that the function is implemented as a FFI.
+#[macro_export]
+macro_rules! ffi {
+    ($($msg:expr)?) => {
+        todo!($($msg)?)
     };
 }