Skip to content

Building and flashing

xawen edited this page Mar 25, 2024 · 2 revisions

Building

Compiler

arm-none-eabi GCC version 10.3.1 is recommended, which is the current version on Ubuntu 22.04.03 LTS. Other versions may generate a flash file that is too big. You can get an appropriate version from: https://developer.arm.com/downloads/-/gnu-rm

To build the firmware, you need to fetch the submodules and then run make:

git submodule update --init --recursive --depth=1
make

Compiling on Windows

Setup

  1. Download and install "gcc-arm-none-eabi-10.3-2021.10-win32.exe" from https://developer.arm.com/downloads/-/gnu-rm
  2. Download and install "gnu_make-3.81.exe" from https://gnuwin32.sourceforge.net/packages/make.htm
  3. Download and install Git for Windows from https://git-scm.com/downloads
  4. You may need to add the gcc path to your OS environment PATH (add C:\Program Files (x86)\GNU Arm Embedded Toolchain\10 2021.10\bin)
  5. You may need to reboot your PC after installing the above

Cloning the repo

  1. Create a folder for the local clone of the repo
  2. Navigate to the folder in a command prompt and run git clone https://github.com/OEFW-community/RT-890-custom-firmware.git

Compiling

  1. Navigate to the RT-890-custom-firmware folder created by the git clone command
  2. Run make clean
  3. Run make

Alternatively, you can download this batch file from 1of11 to compile the firmware in a single command.

Updating

  1. Navigate to the RT-890-custom-firmware folder created by the git clone command
  2. Run git pull

Compiling in a browser using GitHub Codespace

To build the firmware without installing any software you can run a full featured IDE and compiler in your browser using GitHub Codespace. The preconfigured environment runs Linux Ubuntu 22.04 with gcc-arm-none-eabi 15:10.3-2021.07-4.

Starting a new Codespace

On the main page of the firmware repository click on the green button <> Code -> Codespace -> Create Codespace on ... After the Codespace is initialized, you can open and edit any file, for example, modify the options in the makefile and build the firmware typing make in the terminal panel.

Starting an existing Codespace

If you started a Codespace less than 7 days ago and have not manually deleted it, then you will be offered to restart it instead of creating a new one. The start-up will be much faster but you will need to update the code before compiling as it will contain the version of the code from the time of its creation. To do this, simply type the following commands in the console: make clean, then git pull, and finally make.

A word about the free offer

The most observant users will have noticed this message: Codespace usage for this repository is paid for by... Github will never charge you without consent. If you reach the limit of the free offer, which is very unlikely, you will not be able to start your codespaces until the monthly limits reset, that's all. More informations

Flashing

Use the firmware.bin file with either RT-890-Flasher or RT-890-Flasher-CLI

For detailed instructions on how to flash, follow https://github.com/OEFW-community/radtel-rt-890-flasher?tab=readme-ov-file#flashing-the-firmware