Building XLAT firmware - teamfinalmouse/xlat GitHub Wiki

Building and Flashing the XLAT firmware

Welcome to the guide for building and flashing the XLAT firmware! Follow the steps below:

Prerequisites

  • Git installed on your system.
  • CMake for the build system.
  • arm-none-eabi-gcc cross compiler for ARM embedded systems.
  • JLink software and drivers for flashing the firmware.

1. Cloning the XLAT Repository

First, navigate to your desired directory and clone the XLAT project repository:

git clone https://github.com/teamfinalmouse/xlat.git
cd xlat

2. Ensuring arm-none-eabi-gcc is in PATH

Before proceeding, ensure that the arm-none-eabi-gcc compiler is installed and accessible from the command line:

arm-none-eabi-gcc --version

If it's not recognized, ensure you've installed it and added it to your PATH. You can find the official ARM compiler here: https://developer.arm.com/Tools%20and%20Software/GNU%20Toolchain

3. Building the XLAT Project

To build the project using CMake:

mkdir build
cd build
cmake .. -DCMAKE_TOOLCHAIN_FILE=arm-none-eabi.cmake -DCMAKE_BUILD_TYPE=Release
make -j

This will compile the project, and the firmware binary (xlat.elf) should be in the build directory.

4. Flashing the Firmware using JLink

Ensure your board is connected to your computer and recognized by JLink. Then:

JLinkExe -device "STM32F746NG" -if SWD -speed 4000
loadfile ./build/xlat.elf
r
g
q

Conclusion

You should now have the XLAT project built and flashed onto your board.