Files
tfhe-rs/setup_hpu.sh
Baptiste Roux 9ee8259002 feat(hpu): Add Hpu backend implementation
This backend abstract communication with Hpu Fpga hardware.
It define it's proper entities to prevent circular dependencies with
tfhe-rs.
Object lifetime is handle through Arc<Mutex<T>> wrapper, and enforce
that all objects currently alive in Hpu Hw are also kept valid on the
host side.

It contains the second version of HPU instruction set (HIS_V2.0):
* DOp have following properties:
  + Template as first class citizen
  + Support of Immediate template
  + Direct parser and conversion between Asm/Hex
  + Replace deku (and it's associated endianess limitation) by
  + bitfield_struct and manual parsing

* IOp have following properties:
  + Support various number of Destination
  + Support various number of Sources
  + Support various number of Immediat values
  + Support of multiple bitwidth (Not implemented yet in the Fpga
    firmware)

Details could be view in `backends/tfhe-hpu-backend/Readme.md`
2025-05-16 16:30:23 +02:00

147 lines
5.0 KiB
Bash

#! /usr/bin/env/ bash
# Find current script directory. This should be PROJECT_DIR
CUR_SCRIPT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" &> /dev/null && pwd)
HPU_BACKEND_DIR=$CUR_SCRIPT_DIR/backends/tfhe-hpu-backend
HPU_MOCKUP_DIR=$CUR_SCRIPT_DIR/mockups/tfhe-hpu-mockup
# Default default bitstream
# Available options are:
# * sim: use with the mockup (i.e simulation)
# * u55c: use with u55c (latest bitstream with gf64 config)
# * v80: use with v80 (i.e should specify pcie-dev flag [zamav80: 01, srvzama: 21]
HPU_CONFIG="sim"
# Default log verbosity
RUST_LOG="info"
# Setting PCI device variable: depends on the machine
mapfile -t DEVICE< <(lspci -d 10ee:50b5)
if [ ${#DEVICE[@]} -gt 1 ]; then
echo "[ERROR]: There is more than one device pcie, we only support one hpu for now"
return 1
else
V80_PCIE_DEV="${DEVICE[0]%%:*}"
fi
# Default Qdma init
V80_QDMA_INIT=false
# Parse user CLI ##############################################################
opt_short="hc:l:p:i"
opt_long="help,config:,rust-log:pcie-dev:init-qdma"
OPTS=$(getopt -o "$opt_short" -l "$opt_long" -- "$@")
while true
do
case "$1" in
-h|--help)
echo "Available options are:"
echo " * --config: target configuration [sim, u55c_gf64, v80]"
echo " * --rust-log: Specify rust verbosity [Cf. tracing]"
echo " * --pcie-dev: target pcie device [Warn: v80 only]"
echo " * --init-qdma: init the qdma driver [Warn: v80 only]"
return 0
;;
-c|--config)
if [ -n "${2}" ] && [[ ! ${2} =~ ^- ]]; then
HPU_CONFIG="${2}"
else
echo "Error: --config requires a value"
return 1
fi
shift 2
;;
-l|--rust_log)
if [ -n "${2}" ] && [[ ! ${2} =~ ^- ]]; then
RUST_LOG="${2}"
((i++))
else
echo "Error: --rust-log requires a value"
return 1
fi
shift 2
;;
-p|--pcie-dev)
if [ -n "${2}" ] && [[ ! ${2} =~ ^- ]]; then
V80_PCIE_DEV="${2}"
((i++))
else
echo "Error: --pcie-dev requires a value"
return 1
fi
shift 2
;;
-i|--init-qdma)
V80_QDMA_INIT=true
shift
;;
"") # End of input reading
break ;;
*)
echo "Unknown flag: $1"
echo " use -h|--help for available options"
return 1
;;
esac
done
echo "###############################################################################"
echo "### Setup Hpu Backend ###"
echo "###############################################################################"
echo "# * Config: ${HPU_CONFIG}"
echo "# * Backend directory: ${HPU_BACKEND_DIR}"
if [[ "$HPU_CONFIG" == sim* ]]; then
echo "# * Mockup directory: ${HPU_MOCKUP_DIR}"
elif [[ "$HPU_CONFIG" == v80* ]]; then
echo "# * PCIe id: ${V80_PCIE_DEV} [V80 only]"
echo "# * Init Qdma: ${V80_QDMA_INIT} [V80 only]"
fi
echo "# * Rust verbosity: ${RUST_LOG}"
echo "###############################################################################"
# Common init #################################################################
# -> Create config simlink and some exports
export HPU_BACKEND_DIR
export HPU_CONFIG
export RUST_LOG
# Sim specific init ###########################################################
if [[ "$HPU_CONFIG" == sim* ]]; then
export HPU_MOCKUP_DIR
fi
# U55c specific init ###########################################################
if [[ "$HPU_CONFIG" == u55c* ]]; then
# Setup Xrt for low-level xfer with u55c
XRT_SETUP=/opt/xilinx/xrt/setup.sh
if [[ -f $XRT_SETUP ]]; then
source $XRT_SETUP
fi
fi
# V80 specific init ###########################################################
if [[ "$HPU_CONFIG" == v80* ]]; then
export V80_PCIE_DEV
if [[ "$V80_QDMA_INIT" == true ]]; then
while true; do
read -p "QDMA_PF init requested by user. This required sudo right, Are you sure to process [Y/n]" user_input
if [[ "$user_input" == [Yy] ]]; then
echo "Continuing... You could be prompt for sudo password"
sudo modprobe -r qdma-pf && sudo modprobe qdma-pf
sudo bash -c "echo 100 > /sys/bus/pci/devices/0000\:${V80_PCIE_DEV}\:00.1/qdma/qmax"
sudo dma-ctl qdma${V80_PCIE_DEV}001 q add idx 1 mode mm dir h2c
sudo dma-ctl qdma${V80_PCIE_DEV}001 q add idx 2 mode mm dir c2h
sudo dma-ctl qdma${V80_PCIE_DEV}001 q start idx 1 dir h2c
sudo dma-ctl qdma${V80_PCIE_DEV}001 q start idx 2 dir c2h
break
elif [[ "$user_input" == [Nn] ]]; then
echo "Skipped QDMA_PF init"
break
else
echo "Invalid input. Please enter 'Y' or 'n'."
fi
done
fi
fi