Sound Open Firmware

Status

Community

Additional community support is available via the #sof channel in the Zephyr Project Discord server. See the Resources section of the @zephyrproject-rtos GitHub organization README for Discord access information.

Documentation

See docs

Quickstart

You can easily set up the complete SOF development environment, including Zephyr SDK and QEMU, by running our interactive installer script. To run the installer locally:

curl -fsSLo sdk-install.sh https://raw.githubusercontent.com/thesofproject/vscode-workspace/main/sdk-install.sh
bash sdk-install.sh

The script will guide you through the process of installing system dependencies, cloning the repositories, configuring Python virtual environments, and setting up the Zephyr SDK and QEMU.

Running the tests

See unit testing documentation

Deployment

TODO: Add additional notes about how to deploy this on a live system

Contributing

See Contributing to the Project

AI-assisted contributions

When using AI agents or coding assistants to contribute code, the human submitter is responsible for:

• Reviewing all AI-generated code
• Ensuring compliance with licensing requirements
• Adding their own Signed-off-by tag to certify the DCO
• Taking full responsibility for the contribution

See AGENTS.md for rules that govern AI agent behaviour in this repository.

License

This project is licensed under the BSD Clause 3 - see the LICENCE file for details