Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ci/scripts: cleanup #352

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

ci/scripts: cleanup #352

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 14 additions & 32 deletions .github/scripts/build-examples.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,30 +18,12 @@

set -e

CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
source ${CURRENT_DIR}/common.sh

# -- validate input ----------------------------------------------------------

function help() {
echo
echo "Build examples from the repository"
echo
echo "Syntax: $0 fpga_family [examples]..."
echo "Arguments:"
echo " fpga_family - A supported FPGA family"
echo " examples - A name of an available example"
echo
}

if [[ ! $# -ge 1 ]]; then
echo "Invalid number of arguments!"
help
echo "ERROR: Invalid number of arguments!" >&2
echo "Please, provide: path/to/build-examples.sh <fpga_family> <example>..." >&2
exit 1
fi

# -- tuttest -----------------------------------------------------------------

fpga_family=$1
shift

Expand All @@ -54,29 +36,29 @@ esac
fi

# activate conda and enter example dir
activate_env="docs/building-examples.rst:export-install-dir,fpga-fam-$fpga_family,conda-prep-env,f4pga-env-bin,f4pga-env-share-$fpga_family,conda-act-env"
activate_env="docs/building-examples.rst:export-install-dir,fpga-fam-$fpga_family,conda-env"
snippets="${activate_env},enter-dir-$fpga_family"

case "$fpga_family" in
xc7) for example in $examples; do
case $example in
"counter") tuttest_exec ${snippets} xc7/counter_test/README.rst:example-counter-*-group ;;
"picosoc") tuttest_exec ${snippets} xc7/picosoc_demo/README.rst:example-picosoc-*-group ;;
"litex") tuttest_exec ${snippets} xc7/litex_demo/README.rst:example-litex-dir,example-litex-req,example-litex_picorv32-*-group,example-litex_vexriscv-*-group ;;
"litex_linux") tuttest_exec ${snippets} xc7/linux_litex_demo/README.rst:example-litex-*-group ;;
"litex_sata") tuttest_exec ${snippets} xc7/litex_sata_demo/README.rst:example-litex-sata-*-group ;;
"counter") tuttest ${snippets} xc7/counter_test/README.rst:example-counter-*-group ;;
"picosoc") tuttest ${snippets} xc7/picosoc_demo/README.rst:example-picosoc-*-group ;;
"litex") tuttest ${snippets} xc7/litex_demo/README.rst:example-litex-dir,example-litex-req,example-litex_picorv32-*-group,example-litex_vexriscv-*-group ;;
"litex_linux") tuttest ${snippets} xc7/linux_litex_demo/README.rst:example-litex-*-group ;;
"litex_sata") tuttest ${snippets} xc7/litex_sata_demo/README.rst:example-litex-sata-*-group ;;

#Additional examples:
"button_controller") tuttest_exec ${activate_env},enter-dir-$fpga_family xc7/additional_examples/button_controller/README.rst:additional-examples,example-debouncer-basys3 ;;
"pulse_width_led") tuttest_exec ${snippets} xc7/pulse_width_led/README.rst:example-pulse-arty-35t ;;
"timer") tuttest_exec ${snippets} xc7/timer/README.rst:example-watch-basys3 ;;
"button_controller") tuttest ${snippets} xc7/additional_examples/button_controller/README.rst:additional-examples,example-debouncer-basys3 ;;
"pulse_width_led") tuttest ${snippets} xc7/pulse_width_led/README.rst:example-pulse-arty-35t ;;
"timer") tuttest ${snippets} xc7/timer/README.rst:example-watch-basys3 ;;

# Project F examples
"hello") for helloexample in A B C D E F G H I J; do
tuttest_exec ${activate_env} projf-makefiles/hello/hello-arty/${helloexample}/README.rst:hello-arty-${helloexample,,}
tuttest ${activate_env} projf-makefiles/hello/hello-arty/${helloexample}/README.rst:hello-arty-${helloexample,,}
done ;;
"hello-k") for helloexample in K L; do
tuttest_exec ${activate_env} projf-makefiles/hello/hello-arty/${helloexample}/README.rst:hello-arty-${helloexample,,}
tuttest ${activate_env} projf-makefiles/hello/hello-arty/${helloexample}/README.rst:hello-arty-${helloexample,,}
done ;;
*) echo "ERROR: Unknown example name: $example" >&2
exit 1 ;;
Expand All @@ -85,7 +67,7 @@ case "$fpga_family" in
;;
eos-s3) for example in $examples; do
case $example in
"counter") tuttest_exec ${snippets} eos-s3/btn_counter/README.rst:eos-s3-counter ;;
"counter") tuttest ${snippets} eos-s3/btn_counter/README.rst:eos-s3-counter ;;
*) echo "ERROR: Unknown example name: $example" >&2
exit 1 ;;
esac
Expand Down
22 changes: 0 additions & 22 deletions .github/scripts/common.sh
View file
Open in desktop

This file was deleted.

27 changes: 6 additions & 21 deletions .github/scripts/install-toolchain.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,31 +18,16 @@

set -e

CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
source ${CURRENT_DIR}/common.sh

# -- validate input -----------------------------------------------------------

function help() {
echo
echo "Install the F4PGA toolchain as described in the sphinx documentation"
echo
echo "Syntax: $0 fpga_family os"
echo "Arguments:"
echo " fpga_family - A supported FPGA family"
echo " os - A supported operating system"
echo
}

if [[ ! $# -eq 2 ]]; then
echo "ERROR: Invalid number of arguments" >&2
help >&2
echo "ERROR: Two arguments are required!" >&2
echo "Please, provide: path/to/install-toolchain.sh <fpga_family> <os>" >&2
exit 1
fi

# -- tuttest ------------------------------------------------------------------

# A supported FPGA family
fpga_family=$1

# A supported operating system
os=$2

tuttest_exec docs/getting.rst:install-reqs-$os,wget-conda,conda-install-dir,fpga-fam-$fpga_family,env-setup
tuttest "docs/getting.rst:install-reqs-$os,wget-conda,conda-install-dir,fpga-fam-$fpga_family,env-setup"
9 changes: 2 additions & 7 deletions docs/building-examples.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,19 +29,14 @@ Select your FPGA family:

FPGA_FAM="eos-s3"

Next, prepare the environment:
Next, prepare and activate the environment:

.. code-block:: bash
:name: conda-prep-env
:name: conda-env

export PATH="$F4PGA_INSTALL_DIR/$FPGA_FAM/install/bin:$PATH";
source "$F4PGA_INSTALL_DIR/$FPGA_FAM/conda/etc/profile.d/conda.sh"

Finally, enter your working Conda environment:

.. code-block:: bash
:name: conda-act-env

conda activate $FPGA_FAM

.. tip::
Expand Down