Skip to content

Latest commit

 

History

History
88 lines (61 loc) · 3.36 KB

DEVELOPER.md

File metadata and controls

88 lines (61 loc) · 3.36 KB
Raw

This directory contains the source code for the FOME firmware.

The ideal is that typical end users should be able to use pre-built firmware. They should not need to modify or even rebuild from the source code for basic use, but building from the source code provides the opportunity for optimization, supporting unexpected engine configurations, and specialized enhancements.

TL;DR

cd config/boards/proteus
./compile_proteus_f7.sh

Environment

Building from source code requires this firmware, and a platform that supports 'make' based builds. The correct compiler is now included for both 64-bit Linux (Intel/AMD) and macOS (64-bit Intel and ARM) platforms.

Linux and MacOS systems should have the software development tools, primarily 'make', pre-installed or readily installed. MS-Windows requires selecting and installing a Unix-compatible environment.

Setup Instructions

Editor/IDE

The supported IDE is Visual Studio Code. Others will work, but if you need help from the maintainers, you might not get much if you're using something else.

Linux

  1. Make sure you have the latest version of git installed: sudo apt install git
  2. Clone the repo. git clone https://github.com/<github username>/fome-fw.git
  3. Install additional dependencies: cd fome-fw/firmware && ./setup_linux_environment.sh
  4. Open vscode: code fome-fw/

macOS

macOS setup is largely the same as Linux, except the setup script will not work. On recent versions of macOS, simply attempting to run make from the terminal will prompt installation of Xcode command line developer tools, which is the only prerequisite. Then, do steps 2 and 4 from the Linux setup instructions above.

Windows

While technically possible to build on Windows, the preferred method is to first install the Windows Subsystem for Linux (WSL), then follow the instructions for Linux above.

Note

Note that the developers are volunteers, with varied motivations. These motivations often include using leading-edge language and build system concepts, requiring recent versions of tools. Should you encounter build problems, review the latest version of this document. If you're still having trouble, reach out on Discord in the #firmware channel.

Building

Each ECU+MCU combination has its own compilation scripts. In general, these scripts are located in firmware/config/boards/<board>/compile_<board>_<chip>.sh. For example, firmware/config/boards/proteus/compile_proteus_f7.sh compiles a firmware image for a Proteus (or Polygonus) ECU fitted with an STM32F7 microcontroller.

Outputs

When a compile script is run, it will generate any generated files (TunerStudio ini, generated structs, etc), compile the firmware, compile the bootloader if configured for that board, then assemble any firmware images. These outputs are placed in firmware/deliver/.

For example, running compile_proteus_f7.sh will yield:

$ ls -lh deliver
657K	fome.bin
 18K	fome_bl.bin
1.9M	fome_update.srec
File Purpose
fome.bin Combined firmware image, both bootloader and main image pre-assembled. Flash this one if you have a blank ECU (or one you want to wipe fully).
fome_bl.bin Just the bootloader.
fome_update.srec Update image that only contains the firmware, to be flashed via the bootloader.

Unit Tests

See unit tests readme.