firmware Directory Reference

Detailed Description

Australis Firmware

Project sources and build tooling for the Australis Firmware system

---

Table of Contents

• 1. Source Structure
  • Key Components
  • Modules
  • Hardware Targets
• 2. Building the Firmware
  • Prerequisites
  • Build Steps
  • For Developers
• 3. Contributing

Source Structure

The sources are organized as follows:

• australis/: Contains the Australis Firmware components and test code, including:
  • source/
    • core/: Core firmware component linked to all sources that implement Australis
    • extra/: Extra firmware component providing additional functionality with modules
    • system/: System startup and platform dependant sources; Currently only supports STM32F439
  • test/
• target/: Hardware target sources. Each subdirectory within target/ represents a specific platform officially supported by Australis.

Key Components

• Australis Core:
  • The core set of API definitions and tasks required for an Australis application. Any source code implementing Australis Firmware must link against this component.
• Australis Extra:
  • Additional modules that optionally provide extra functionality to the firmware core. Each module is dependant only on Australis Core and can be individually built and linked as necessary.
• System Sources:

Modules

Important

TODO: complete this section

Hardware Targets

The target/ directory contains specific configurations for different hardware platforms. Each target defines:

Configuration Options

Target specific #defines in AustralisConfig.h.

Peripheral Initialisation

All hardware peripherals (CAN, SPI, etc.) are initialised by the target and passed to any devices that require them during initialisation.

Device Initialisation

Each device required by the target must be appropriately initialised and registered in the core device list.

Firmware Entry Point

It is the responsibility of the target to initialise and run Australis Core. A target's source code must define the main() entry function and execute any code required by the above.

Note

See the target/README.md for more information about currently available targets (TODO: remember to fill this file out).

Building the Firmware

The build process uses CMake to generate Makefiles, which are then used to compile and link the firmware.

Prerequisites

• CMake (version 3.15 or higher): Used to generate the build system.
• ARM GCC Toolchain: Required for compiling the ARM Cortex-M4 based firmware. Ensure the toolchain is installed and accessible in your system's PATH. Example of toolchain path: /usr/bin/arm-none-eabi-gcc.
• Make: Used to execute the generated Makefiles.

Build Steps

1. Set HARDWARE_TARGET: Define the HARDWARE_TARGET variable when invoking CMake. This specifies which hardware target in the target/ directory will be built. For example:

   ```bash
   cmake -DHARDWARE_TARGET=minimal -S . -B build
   ```
   This command, when invoked from within the firmware source root `firmware/`, tells CMake to build against the `minimal` target.
   

1. Build the Firmware: Navigate to the build directory and invoke cmake, or pass cmake the appropriate path to your build tree.

   bash cd build cmake --build or bash cmake --build path/to/build

For Developers

Important

TODO: complete this section

Contributing

Important

TODO: complete this section