Maui

Maui is device to streamline DUT debugging by combining ADB, CCD, and power delivery functionalities. This repo would be used for: MCU Firmware: - based on Zephyr RTOS - control of on-board ICs: PDC, signal muxing, etc. - host interface Host Software: - Linux-based tools - Integration with standard Google debugging tools (adb, fastboot, servod), - Provide maintenance tools: all system components firmware updates, managing in fleet - General host interface for additional features: remote DUT disconnection, etc.

Quick Start

Get the code and update your Maui device to the latest stable firmware:

# 1. Clone the repository
git clone https://chromium.googlesource.com/chromiumos/platform/hwtools/maui
cd maui

# 2. Update all firmware components (MCU & PDC) to the latest stable version

./tools/scripts/maui-flash all

# Note: You may need to provide your device serial number if multiple devices are connected.
./tools/scripts/maui-flash all --serial <SERIAL>

# 3. Verify device status / FW version
./tools/scripts/maui-ctl status

For detailed usage of the host tools, see tools/README.md.

Getting started

Create a directory to checkout the Maui source:

mkdir maui_source
cd maui_source

Get the source code:

git clone https://chromium.googlesource.com/chromiumos/platform/hwtools/maui
cd maui

This repository uses pre-commit hooks to enforce code style. Please make sure you have them installed by running:

pip install pre-commit --break-system-packages
pre-commit install

To upload your changes to gerrit you can use:

git push origin HEAD:refs/for/main

Build firmware using Docker

While being in maui directory (root of this repository), execute:

docker build -t maui-builder -f dockerfiles/Dockerfile.fw_builder .
docker run -it -v `pwd`:/repo maui-builder:latest

This will generate a txt firmware file in firmware/build_docker/zephyr/zephyr.txt This file can be used to flash Maui using BSL.

Unit Testing

The project uses the Zephyr Twister framework for unit testing application code. Tests are executed inside the maui-builder Docker container to ensure a consistent environment.

Running Tests

First, ensure the builder image is built (if not already):

docker build -t maui-builder -f dockerfiles/Dockerfile.fw_builder .

To run all unit tests:

docker run --rm -v $(pwd):/repo --entrypoint /firmware_test.sh maui-builder

To run a specific test suite (e.g., utils.basic):

docker run --rm -v $(pwd):/repo --entrypoint /firmware_test.sh maui-builder -s utils.basic -v

Writing New Tests

1. Create a new directory under firmware/tests/unit/<component_name>_test.
2. Add a testcase.yaml defining the test scenarios. Ensure platform_allow and integration_platforms are set to native_sim.
3. Add a prj.conf (usually CONFIG_ZTEST=y is sufficient).
4. Add a CMakeLists.txt to include the test source and the application source files you are testing.
5. Add your test code in <component_name>_test/src/main.c using the Ztest API (ZTEST, zassert_equal, etc.).

Host Tools & Firmware Update

The project includes host-side tools for managing the device and updating firmware. These tools are distributed via a Docker container (maui-utils) which is automatically fetched or built by the wrapper scripts.

See tools/README.md for full documentation.

Common Commands

• Update Everything (Stable): ./tools/scripts/maui-flash all
• Check Status: ./tools/scripts/maui-ctl status