flow.sh

#!/usr/bin/env bash

# -e: exit if one command fails
# -u: treat unset variable as an error
# -f: disable filename expansion upon seeing *, ?, ...
# -o pipefail: causes a pipeline to fail if any command fails
set -euf -o pipefail

# Current script path; doesn't support symlink
BSTERDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"

# Bash color codes
Red='\033[0;31m'
Green='\033[0;32m'
Yellow='\033[0;33m'
Blue='\033[0;34m'
# Reset
Color_Off='\033[0m'

function printerror {
    echo -e "${Red}ERROR: ${1}${Color_Off}"
}

function printwarning {
    echo -e "${Yellow}WARNING: ${1}${Color_Off}"
}

function printinfo {
    echo -e "${Blue}INFO: ${1}${Color_Off}"
}

function printsuccess {
    echo -e "${Green}INFO: ${1}${Color_Off}"
}

help() {
    echo -e "${Blue}"
    echo ""
    echo "NAME"
    echo ""
    echo "      Binary Search Tree IP"
    echo ""
    echo "SYNOPSIS"
    echo ""
    echo "      ./flow.sh -h"
    echo ""
    echo "      ./flow.sh help"
    echo ""
    echo "      ./flow.sh syn"
    echo ""
    echo "      ./flow.sh sim"
    echo ""
    echo "DESCRIPTION"
    echo ""
    echo "      This flow handles the different operations available"
    echo ""
    echo "      ./flow.sh help|-h"
    echo ""
    echo "      Print the help menu"
    echo ""
    echo "      ./flow.sh syn"
    echo ""
    echo "      Launch the synthesis script relying on Yosys"
    echo ""
    echo "      ./flow.sh sim"
    echo ""
    echo "      Launch all available testsuites"
    echo ""
    echo -e "${Color_Off}"
}

main() {

    echo ""
    printinfo "Start BSTer Flow"

    # If no argument provided, preint help and exit
    if [[ $# -eq 0 ]]; then
        help
        exit 1
    fi

    # Print help
    if [[ $1 == "-h" || $1 == "help" ]]; then

        help
        exit 0
    fi

    source scripts/setup.sh

    iverilog -V

    if [[ $1 == "lint" ]]; then
        printinfo "Start linting"
        verilator --lint-only \
            +1800-2017ext+sv \
            -Wall -cdc \
            -I./src\
            ./src/csr.sv\
            ./src/bst_engine.sv\
            ./src/bster.sv\
            ./src/bster_h.sv\
            ./src/interface_handler.sv\
            ./src/memory_driver.sv\
            ./src/tree_space_manager.sv\
            ./src/axi_ram.sv\
            ./deps/async_fifo/src/vlog/async_fifo.v\
            ./deps/async_fifo/src/vlog/fifo_2mem.v\
            ./deps/async_fifo/src/vlog/fifomem_dp.v\
            ./deps/async_fifo/src/vlog/rptr_empty.v\
            ./deps/async_fifo/src/vlog/sync_ptr.v\
            ./deps/async_fifo/src/vlog/sync_r2w.v\
            ./deps/async_fifo/src/vlog/sync_w2r.v\
            ./deps/async_fifo/src/vlog/wptr_full.v\
            --top-module bster
    fi
    if [[ $1 == "sim" ]]; then
        printinfo "Start simulation"
        cd "$BSTERDIR/sim"
        ./run.sh bster_testbench_operations.sv
        ./run.sh bster_testbench_apb.sv
        return $?
    fi

    if [[ $1 == "syn" ]]; then
        printinfo "Start synthesis"
        cd "$BSTERDIR/syn"
        ./run.sh
        return $?
    fi
}

main "$@"