https://github.com/lowrisc/symphony-system

An integration of CHERIoT Ibex with OpenTitan Earl Grey, part of the Sunburst project funded by UKRI
https://github.com/lowrisc/symphony-system

Last synced: 1 day ago
JSON representation

An integration of CHERIoT Ibex with OpenTitan Earl Grey, part of the Sunburst project funded by UKRI

• Host: GitHub
• URL: https://github.com/lowrisc/symphony-system
• Owner: lowRISC
• License: apache-2.0
• Created: 2023-11-07T17:30:34.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-02T17:26:39.000Z (11 months ago)
• Last Synced: 2024-03-19T20:10:45.827Z (8 months ago)
• Language: Python
• Size: 59.6 KB
• Stars: 6
• Watchers: 11
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Symphony system

Symphony is a system for evaluating the usage of [CHERIoT Ibex core](https://github.com/microsoft/cheriot-ibex) 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](https://github.com/lowRISC/sonata-system) (containing a [CHERIoT Ibex core](https://github.com/microsoft/cheriot-ibex)) with [OpenTitan Earl Grey](https://opentitan.org/book/hw/top_earlgrey/doc/datasheet.html).

It is designed for use on FPGA and specifically targets the [NewAE CW340](https://media.newae.com/datasheets/NAE-CW340-OTKIT_datasheet.pdf).

The system is at its architectural definition and specification stage.

RTL development has yet to begin.

In the meantime, please read the [architecture specfication](./doc/architecture.md).

Symphony is part of the [Sunburst Project](https://www.sunburst-project.org) funded by [UKRI](https://www.ukri.org/) / [DSbD](https://www.dsbd.tech/).

## Contributing

### Installing Nix

The Nix package manager is used to create reproducible builds and consistent development environments.

Follow the instructions on [the zero to nix site](https://zero-to-nix.com/start/install) to install the Nix package manager.

*If you've downloaded nix through another method, make sure the experimental features ["flakes"](https://nixos.wiki/wiki/Flakes) and ["nix-command"](https://nixos.wiki/wiki/Nix_command) are enabled.*

### Building Documentation

The documentation uses [mdBook](https://rust-lang.github.io/mdBook/) see the [installation guide](https://rust-lang.github.io/mdBook/guide/installation.html) for further details on installation.

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

```sh

mdbook serve --open

```

### Code Quality

To check the python code run:

```sh

nix run .#lint_python

```

To automatically fix some lints and formats use:

```sh

nix run .#lint_python -- fix

```

To automatically format Nix files use:

```sh

nix fmt

```

## License

Unless otherwise noted, everything in the repository is covered by the [Apache License](https://www.apache.org/licenses/LICENSE-2.0.html), Version 2.0. See the [LICENSE](https://github.com/lowRISC/symphony-system/blob/main/LICENSE) file for more information on licensing.