Build and test the server

Dependencies¶

The following must be available before building the server.

Zynq cross-compiler toolchain: Available as part of the Xilinx Vivado build environment, or any ARMv7-A cross-compiler. Required for all applications running on PandA.
PandABlocks-FPGA: Must be available before building the server; it contains the configuration file defining the low-level register interface to the PandA firmware.

Copy CONFIG.example to CONFIG in the base directory and edit as needed, commenting out lines that are not required.

The following symbols must point to the appropriate dependencies:

BINUTILS_DIR: Path to the Zynq cross-compiler toolchain if it is not on PATH. Not required for the simulation server or documentation builds.

The following symbols can be left at their defaults:

BUILD_DIR: Path for built files.
PYTHON: Path for python interpreter used during the build
MYSTMD_VERSION: mystmd version No. Version of MyST required to build docs. defaults to 1.10.1.
DEFAULT_TARGETS: Makefile targets built by make or make default. Default list: driver, server, sim_server, docs.

Target	Description
`default`	Builds all targets listed in `$(DEFAULT_TARGETS)`
`driver`	Kernel driver module
`server`	Server binary to run on PandA
`sim_server`	Simulation server to run on the local PC
`docs`	HTML documentation
`clean`	Removes the entire `$(BUILD_DIR)` directory

After a successful build, $(BUILD_DIR) contains:

driver/: Kernel module for hardware access.
server/ and sim_server/: The on-PandA server and the local simulation server respectively.
html/: HTML documentation.