Symphony system

Symphony is a system for evaluating the usage of CHERIoT Ibex core as a microcontroller for embedded, IoT and Operational Technology applications that require the use of a root of trust The system is an integration of a Sonata system (containing a CHERIoT Ibex core) with OpenTitan Earl Grey. It is designed for use on FPGA and specifically targets the NewAE CW340.

The system is at its architectural definition and specification stage. RTL development has yet to begin. In the meantime, please read the architecture specfication.

Symphony is part of the Sunburst Project funded by UKRI / DSbD.

Contributing

Installing Nix

The Nix package manager is used to create reproducible builds and consistent development environments. Follow the instructions on the official download page to install the Nix package manager.

Building Documentation

The documentation uses mdBook see the installation guide for further details on installation.

Once mdBook is installed the documentation can be built and viewed with:

mdbook serve --open

Code Quality

To check the python code run:

nix run .#python_check

To automatically fix some lints and formats use:

nix run .#python_fix

To automatically format Nix files use:

nix fmt

License

Unless otherwise noted, everything in the repository is covered by the Apache License, Version 2.0. See the LICENSE file for more information on licensing.