PicoADK NG Firmware

This is a work-in-progress rework of the Datanoise PicoADK V2 firmware with a focus on modularity.

Note

This is work-in-progress and most likely things are still not implemented or broken.

Prerequisites

MacOS

To build this project, you need to install the following tools: On macOS (using Homebrew)

Install Homebrew (if not installed):

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Install the required tools:

brew install cmake gcc-arm-embedded git cpplint

Debian/Ubuntu

Update and install the required packages:

sudo apt update
sudo apt install cmake gcc-arm-none-eabi build-essential git cpplint

Windows

Follow the instructions for Debian/Ubuntu inside your WSL instance.

Building

Clone the PicoADK NG Firmware repository:

git clone --recursive --recurse-submodules https://github.com/DatanoiseOrg/picoadk-firmware-ng.git
cd picoadk-firmware-ng

Create a build directory:

mkdir build
cd build

Run CMake to generate the build system:

cmake ..

Build the project:

make ( Add -j to build in parallel using all your CPU cores )

This will create the firmware binaries in the build directory.

Flashing

You can use any standard method to flash the generated .uf2 file onto your PicoADK V2 board, such as dragging and dropping the file onto the mounted drive after entering bootloader mode.

Project Structure

Here is an overview of the directory structure and the key files in this repository:

  ├── README.md            # This file, describing the project structure
  ├── .githooks            # Custom hooks for Git to lint code etc.
  ├── .github              # GitHub CI/CD configuration
  ├── CMakeLists.txt       # Main CMake configuration file
  ├── project_config.cmake # Additional project-specific configuration
  ├── build/               # Directory where build artifacts are stored
  ├── cmake/               # CMake scripts for handling SDK and dependencies
  ├── include/             # Global header files for user includes
  ├── src/                 # Application source files (main application logic)
  └── core/                # Core library and drivers for the project
   |___ lib/               # Additional libraries for the core
   |___ src/               # Core system source files
   |___ include/           # Core system includes such as FreeRTOS configuration etc.

License

The code in this repository is licensed under the MIT License. This means you are free to use, modify, and distribute the code, provided you include the original license.

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Third-Party Libraries

Please note that libraries located in the core/lib folder may be licensed under different terms. Be sure to review the license information provided in the respective library files.

Hardware options

While it can be used with other Raspberry RP235x based boards, it is stongly recommended to be used with the PicoADK V2.