Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brilliantlabsAR/frame-codebase
The complete codebase for Frame
https://github.com/brilliantlabsAR/frame-codebase
ai ar crosslink-nx fpga lattice-fpga lua nordic-semiconductor nrf52 nrf52840
Last synced: 2 days ago
JSON representation
The complete codebase for Frame
- Host: GitHub
- URL: https://github.com/brilliantlabsAR/frame-codebase
- Owner: brilliantlabsAR
- License: other
- Created: 2023-08-17T11:54:10.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-05T08:12:05.000Z (9 days ago)
- Last Synced: 2024-11-05T09:17:38.762Z (9 days ago)
- Topics: ai, ar, crosslink-nx, fpga, lattice-fpga, lua, nordic-semiconductor, nrf52, nrf52840
- Language: C
- Homepage: https://www.brilliant.xyz
- Size: 47.5 MB
- Stars: 231
- Watchers: 10
- Forks: 45
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Frame Firmware & RTL Codebase
Welcome to the complete codebase of the Frame hardware. For regular usage, check out the docs [here](https://docs.brilliant.xyz).
## System architecture
The codebase is split into three sections. The **nRF52 Application**, the **nRF52 Bootloader**, and the **FPGA RTL**.
The nRF52 is designed to handle the overall system operation. It runs Lua, as well as handle Bluetooth networking, AI tasks and power management. The FPGA meanwhile, simply handles acceleration of the graphics and camera.
## Getting started with nRF52 firmware development
1. Ensure you have the [ARM GCC Toolchain](https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads) installed.
1. Ensure you have the [nRF Command Line Tools](https://www.nordicsemi.com/Products/Development-tools/nRF-Command-Line-Tools) installed.
1. Ensure you have [nRF Util](https://www.nordicsemi.com/Products/Development-tools/nRF-Util) installed, along with the `device` and `nrf5sdk-tools` subcommands.
```sh
./nrfutil install device
./nrfutil install nrf5sdk-tools
```
1. Clone this repository and initialize any submodules:
```sh
git clone https://github.com/brilliantlabsAR/frame-codebase.git
cd frame-codebase
git submodule update --init
```
1. You should now be able to build and flash the project to an [nRF52840 DK](https://www.nordicsemi.com/Products/Development-hardware/nRF52840-DK) by calling the following commands from the `frame-codebase` folder.
```sh
make release
make erase-jlink # Unlocks the flash protection if needed
make flash-jlink
```
### Debugging
1. Open the project in [VSCode](https://code.visualstudio.com).
There are some build tasks already configured within `.vscode/tasks.json`. Access them by pressing `Ctrl-Shift-P` (`Cmd-Shift-P` on MacOS) → `Tasks: Run Task`.
Try running the `Build` task. The project should build normally.
You many need to unlock the device by using the `Erase` task before programming or debugging.
1. To enable IntelliSense, be sure to select the correct compiler from within VSCode. `Ctrl-Shift-P` (`Cmd-Shift-P` on MacOS) → `C/C++: Select IntelliSense Configuration` → `Use arm-none-eabi-gcc`.
1. Install the [Cortex-Debug](https://marketplace.visualstudio.com/items?itemName=marus25.cortex-debug) extension for VSCode in order to enable debugging.
1. A debugging launch is already configured within `.vscode/launch.json`. Run the `Application (J-Link)` launch configuration from the `Run and Debug` panel, or press `F5`. The project will automatically build and flash before launching.
1. To monitor the logs, run the task `RTT Console (J-Link)` and ensure the `Application (J-Link)` launch configuration is running.
1. To debug using [Black Magic Probes](https://black-magic.org/index.html), follow the instructions [here](/production/blackmagic/README.md).
## Getting started with FPGA development
For quickly getting up and running, the accelerators which run on the FPGA are already pre-built and bundled within this repo. If you wish to modify the FPGA RTL, you will need to rebuild the `fpga_application.h` file which contains the entire FPGA application.
1. Ensure you have the [Yosys](https://github.com/YosysHQ/yosys) installed.
1. Ensure you have the [Project Oxide](https://github.com/gatecat/prjoxide) installed.
1. Ensure you have the [nextpnr](https://github.com/YosysHQ/nextpnr) installed.
1. **MacOS users** can do the above three steps in one using [Homebrew](https://brew.sh).
```sh
brew install --HEAD siliconwitchery/oss-fpga/nextpnr-nexus
```
1. You should now be able to rebuild the project by calling `make`:
```sh
make fpga/fpga_application.h
```
To understand more around how the FPGA RTL works. Check the documentation [here](docs/fpga-architecture.md).