Build system

Overview

${FIAT_PATH_REPO}/Makefile can be used to drive the build process, e.g., via

Command	Description
make   venv/clean	clean the Python virtual environment
make   venv/build	build the Python virtual environment
make docker/clean	clean Docker-based container
make docker/build	build Docker-based container
make    doc/clean	clean Sphinx-based documentation
make    doc/build	build Sphinx-based documentation
make target/clean	clean the target implementation
make target/build	build the target implementation
make target/fetch-dep	fetch (i.e., download) the target implementation dependencies
make target/patch-dep	patch the target implementation dependencies
make target/build-dep	build the target implementation dependencies
make target/clean-dep	clean the target implementation dependencies
make clean	selectively remove artefacts produced by the build system
make spotless	aggressively remove artefacts produced by the build system

with configuration options for it outlined in the following.

The FIAT_CONTEXT environment variable

The FIAT_CONTEXT environment variable specifies the build context within which the build process is executed. The options are

1. native is a native build context,

2. docker is a containerised build context,

noting that:

• using the native build context implies the tool-chain, and any software dependencies (e.g., libraries) need to be installed manually,

• using the docker build context implies the tool-chain, and any software dependencies (e.g., libraries) are installed within the associated container.

The Docker image which supports the docker build context for a given board type is built using

• board-agnostic content in ${FIAT_PATH_REPO}/src/docker, plus

• board-specific content in ${FIAT_PATH_REPO}/src/target/board/imp/${FIAT_BOARD}/Dockerfile.in.

However, there is no need to do this manually: a pre-built image can (and will) be pulled from Docker Hub by the build process as needed. If you do want to build such an image, note that

FIAT_CONTEXT="native" make docker/clean
FIAT_CONTEXT="native" make docker/build

will clean (or remove) and build the image for one board type (specified using ${FIAT_BOARD})

${FIAT_PATH_REPO}/bin/docker.sh clean
${FIAT_PATH_REPO}/bin/docker.sh build

will clean (or remove) and build the images for all board types (identified by searching for instances of Dockerfile.in in ${FIAT_PATH_REPO}/src/fiat/target/board/imp).

The FIAT_DRIVER environment variable

The FIAT_DRIVER environment variable specifies the driver type. The options are

1. binary uses a binary protocol,

2. text uses a text protocol.

The FIAT_BOARD environment variable

The FIAT_BOARD environment variable specifies the board type. The options are

FIAT_BOARD	Class	Vendor	Core	Model	ISA	Host
native	Simulation
cw308/atmega328p	ASIC	Microchip	ATmega	ATMEGA328P	AVR	ChipWhisperer CW308
cw308/atxmega128d4	ASIC	Microchip	ATxmega	ATXMEGA128D4	AVR	ChipWhisperer CW308
cw308/stm32f071rbt6	ASIC	STMicroelectronics	Cortex-M0	STM32F071RBT6	ARMv6-M	ChipWhisperer CW308
cw308/stm32f100rbt6b	ASIC	STMicroelectronics	Cortex-M3	STM32F100RBT6B	ARMv7-M	ChipWhisperer CW308
cw308/stm32f215ret6	ASIC	STMicroelectronics	Cortex-M3	STM32F215RET6	ARMv7-M	ChipWhisperer CW308
cw308/stm32f303rct7	ASIC	STMicroelectronics	Cortex-M4	STM32F303RCT7	ARMv7-M	ChipWhisperer CW308
cw308/stm32f405rgt6	ASIC	STMicroelectronics	Cortex-M4	STM32F405RGT5	ARMv7E-M	ChipWhisperer CW308
cw308/fe310-g002	ASIC	SiFive	E31	FE310-G002	RV32IMAC	ChipWhisperer CW308
cw305/ibex	FPGA	lowRISC	Ibex		RV32IMC	ChipWhisperer CW305

The FIAT_PATH_BUILD and FIAT_PATH_IMP environment variables

• By default, the workflow assumes you first clone the FIAT repository then develop a target implementation within that clone, i.e., “in-tree”. However, it can be useful to do so “out-of-tree”: example scenarios include when the target implementation is part of another project, with resources in the repository simply used to build it.

• The FIAT_PATH_BUILD environment variable specifies where artefacts produced by the build system will be located: by default it is set “in-tree” to equal ${FIAT_PATH_REPO}/build, but this can be overridden.

• The FIAT_PATH_IMP environment variable specifies where the target implementation is located: by default it is set “in-tree” to equal ${FIAT_PATH_REPO}/src/fiat/target/kernel/imp, but this can be overridden.