Reference Documentation¶

This reference section provides comprehensive documentation for all aspects of the EmbSec Kit, including build system targets, project structure, and configuration options.

Contents¶

Build System¶

CMake Targets - All available CMake targets and their usage
Makefile Targets - Complete list of Make commands and options

Project Organization¶

Project Structure - Detailed directory layout and file organization
Configuration - Build configuration options and environment variables

Support¶

Troubleshooting - Common issues and solutions

Quick Command Reference¶

Most Common Commands¶

# Initial setup
make setup

# Build for hardware
make configure
make build

# Build and run in QEMU
make qemu-build
make qemu-01-buffer-overflow

# Run tests
make test
make unittest-lab LAB=01-buffer-overflow

# Package labs
make package-labs
make package-lab LAB=01-buffer-overflow

Build Types¶

The kit supports multiple build configurations:

Hardware Build - For TM4C123GH6PM microcontroller
QEMU Build - For LM3S6965 emulation
Host Build - For native testing (SDK only)

Environment Variables¶

Key environment variables that affect the build:

BUILD_DIR - Build directory (default: build)
BUILD_QEMU_DIR - QEMU build directory (default: build-qemu)
BUILD_TYPE - CMake build type: Debug or Release (default: Debug)