xlsynth-driver 0.55.0

Binary that integrates XLS capabilities into a driver program
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

// SPDX-License-Identifier: Apache-2.0

use std::path::Path;

use clap::ArgMatches;
use xlsynth_g8r::aig::{ClockPort, SequentialPipelineOptions, stitch_gate_fns_into_pipeline};
use xlsynth_g8r::aig_serdes::g8r::{
    emit_g8r, encode_g8r_binary, load_sequential_gate_fn_from_path,
};

use crate::common::{parse_bool_flag_or, write_stdout};

/// Handles the `g8r-stitch-pipeline` subcommand.
pub fn handle_g8r_stitch_pipeline(matches: &ArgMatches) -> Result<(), String> {
    let stage_gate_fns = matches
        .get_many::<String>("g8r_input_files")
        .expect("clap requires at least one g8r input file")
        .map(|input_file| {
            let input_path = Path::new(input_file);
            load_sequential_gate_fn_from_path(input_path)?
                .try_into_gate_fn()
                .map_err(|error| {
                    format!(
                        "pipeline stage '{}' must be clockless and register-free: {}",
                        input_path.display(),
                        error
                    )
                })
        })
        .collect::<Result<Vec<_>, String>>()?;
    let output_design_name = matches.get_one::<String>("output_design_name").unwrap();
    let options = SequentialPipelineOptions {
        name: output_design_name.clone(),
        clock: ClockPort {
            name: matches
                .get_one::<String>("clock_name")
                .cloned()
                .unwrap_or_else(|| "clk".to_string()),
        },
        flop_inputs: parse_bool_flag_or(
            matches,
            "flop_inputs",
            crate::flag_defaults::CODEGEN_FLOP_INPUTS,
        ),
        flop_outputs: parse_bool_flag_or(
            matches,
            "flop_outputs",
            crate::flag_defaults::CODEGEN_FLOP_OUTPUTS,
        ),
        input_valid_signal: matches.get_one::<String>("input_valid_signal").cloned(),
        output_valid_signal: matches.get_one::<String>("output_valid_signal").cloned(),
        reset_signal: matches.get_one::<String>("reset").cloned(),
        reset_active_low: parse_bool_flag_or(matches, "reset_active_low", false),
    };
    let design = stitch_gate_fns_into_pipeline(&stage_gate_fns, &options)
        .map_err(|error| format!("could not stitch g8r pipeline: {error}"))?;

    write_stdout(&emit_g8r(&design));
    if let Some(bin_path) = matches.get_one::<String>("bin_out") {
        let binary = encode_g8r_binary(&design)
            .map_err(|error| format!("could not serialize g8r binary: {error}"))?;
        std::fs::write(bin_path, binary)
            .map_err(|error| format!("could not write g8r binary '{}': {error}", bin_path))?;
    }
    Ok(())
}