Skip to content

README_GAP9.md

Latest commit

 

History

History
113 lines (82 loc) · 3.98 KB

README_GAP9.md

File metadata and controls

113 lines (82 loc) · 3.98 KB

Using Deeploy with GAP9

⚠️ IMPORTANT NOTE This is a work in progress. The GAP9 support in Deeploy is experimental and may not be fully functional.

To use Deeploy with GAP9, a custom Docker container is required because the official Deeploy Docker image does not yet include the necessary SDKs and dependencies for GAP9 development, because they are not publicly available.

Build The Docker Container

To use SSH keys for accessing private repositories during the Docker build process, make sure you have an SSH key pair set up on your local machine. By default, the Makefile uses the key located at ~/.ssh/id_ed25519. If your key is located elsewhere, you can specify its path using the SSH_PRIVATE_KEY variable when invoking the make command.

To build a local version of the Deeploy Docker image with GAP9 support using the upstream toolchain image, run:

cd Container

# Build the Deeploy image with the upstream toolchain image
make deeploy-gap9 DEEPLOY_GAP9_IMAGE=deeploy-gap9:latest

# If you want to specify a custom SSH key path, use:
make deeploy-gap9 DEEPLOY_GAP9_IMAGE=deeploy-gap9:latest SSH_PRIVATE_KEY=/path/to/your/private/key

Or, to build the toolchain, Deeploy and GAP9 images locally, use:

cd Container

# To build the Deeploy container with the local toolchain image
make deeploy TOOLCHAIN_IMAGE=deeploy-toolchain:gap9 DEEPLOY_IMAGE=deeploy:gap9

# To build the Deeploy GAP9 container with the local toolchain image
make deeploy-gap9 TOOLCHAIN_IMAGE=deeploy-toolchain:gap9 DEEPLOY_IMAGE=deeploy:gap9 DEEPLOY_GAP9_IMAGE=deeploy-gap9:latest

Use The Docker Container

Once the image is built, you can create and start the container in interactive mode with:

docker run -it --name deeploy_gap9 -v $(pwd):/app/Deeploy deeploy-gap9:latest

Before running tests, you need to set up the GAP9 environment inside the container:

source /app/install/gap9-sdk/.gap9-venv/bin/activate
source /app/install/gap9-sdk/configs/gap9_evk_audio.sh
export GVSOC_INSTALL_DIR=/app/install/gap9-sdk/install/workstation

Install Deeploy inside the container in editable mode:

cd /app/Deeploy
pip install -e .
cd /app/Deeploy/DeeployTest

# Run on GVSoC (default simulator)
python deeployRunner_gap9.py        -t ./Tests/Kernels/FP32/MatMul
python deeployRunner_tiled_gap9.py  -t ./Tests/Kernels/FP32/MatMul

Run on the GAP9 board

Pass -s board to flash the binary to the connected board via gapy and run it (board_<test> CMake target). USB passthrough must already be set up — see Use A Real GAP9 Board below.

python deeployRunner_gap9.py        -t ./Tests/Kernels/FP32/Add/Regular -s board
python deeployRunner_tiled_gap9.py  -t ./Tests/Kernels/FP32/Add/Regular -s board

External power measurement (PPK2)

--powerMeasurement toggles a GPIO around the inference window so an external probe (e.g. Nordic PPK2) can gate its measurement to the compute region. Only meaningful with -s board.

python deeployRunner_gap9.py -t ./Tests/Kernels/FP32/Add/Regular -s board --powerMeasurement

Use A Real GAP9 Board (USB/IP via gap9-run.sh)

For board access, use the orchestration script in scripts/gap9-run.sh. It manages:

  • host-side USB/IP server (pyusbip)
  • usbip device manager container
  • GAP9 SDK container with the correct mounts

Prerequisites

  • Docker installed and running
  • A working SSH key for BuildKit (if you are building the image locally)
  • USB/IP host support (the script can set up pyusbip on the host)

Start the board workflow (recommended)

This launches a tmux session with three panes: one for the host USB/IP server, one for the GAP9 container and one terminal on the host to manage the USB/IP devices.

./scripts/gap9-run.sh start-tmux

Start manually (two terminals)

Terminal 1 (host USB/IP server):

./scripts/gap9-run.sh start-usbip-host

Terminal 2 (containers + attach device):

./scripts/gap9-run.sh start