Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 4 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ This repository contains software, build flows and examples for the [Sonata Syst
For a guide on how to get up and running on building software for the sonata board see the [getting started guide][].
After you are all set up, take a look at the [exercises][].

[sonata system]: https://github.com/lowRISC/sonata-system
[sonata pcb]: https://github.com/newaetech/sonata-pcb
[Sonata System]: https://github.com/lowRISC/sonata-system
[Sonata PCB]: https://github.com/newaetech/sonata-pcb
[getting started guide]: ./doc/getting-started.md
[exercises]: ./exercises/README.md

Expand All @@ -15,25 +15,12 @@ You are in the [`sonata-software`][] repository.
This repository wraps the [`cheriot-rtos`][], which is included in this repository as a submodule.
[`cheriot-rtos`][] contains the CHERIoT software stack as well as drivers for using the Sonata board; it is well documented by the [CHERIoT Programmer's Guide][].

Other repositories of note:
- [`sonata-system`][]: holds the Sonata system RTL and bootloader which come together to generate the bitstream.
- [`sonata-rp2040`][]: The firmware that is running on the Sonata's RP2040 microcontroller and emulates the 'SONATA' drive when you plug it into your computer.
- [`CHERIoT-Platform/llvm-project`][]: The CHERIoT LLVM compiler toolchain.
- [`cheriot-audit`][]: A tool to explore and verify the relationships between CHERIoT RTOS components.
- [`CHERIoT-Platform/book`][]: The source of the [CHERIoT Programmer's Guide][].

For hardware documentation, see the [Sonata system book][].
You do not need this to do the exercises but if you would like more detailed documentation about the hardware, see the [Sonata System book][].

[`sonata-software`]: https://github.com/lowRISC/sonata-software
[`cheriot-rtos`]: https://github.com/CHERIoT-Platform/cheriot-rtos
[`sonata-system`]: https://github.com/lowRISC/sonata-system
[`sonata-rp2040`]: https://github.com/newaetech/sonata-rp2040
[`CHERIoT-Platform/llvm-project`]: https://github.com/CHERIoT-Platform/llvm-project
[`cheriot-audit`]: https://github.com/CHERIoT-Platform/cheriot-audit
[`CHERIoT-Platform/book`]: https://github.com/CHERIoT-Platform/book
[CHERIoT Programmer's Guide]: https://cheriot.org/book/
[Sonata system book]: https://lowrisc.org/sonata-system/

[Sonata System book]: https://lowrisc.org/sonata-system/

## License

Expand Down
9 changes: 5 additions & 4 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,12 @@ SPDX-License-Identifier: Apache-2.0

- [Getting started](./doc/getting-started.md)
- [Running Sonata software](./doc/guide/running-software.md)
- [Using Sonata IO](./doc/guide/sonata-io.md)

- [Exploring the CHERIoT RTOS](./doc/exploring-cheriot-rtos.md)
- [Auditing firmware](./doc/auditing-firmware.md)

- [Exercises](./exercises/README.md)
- [Hardware access control exercise](./exercises/hardware_access_control/README.md)
- [Firmware auditing exercise](./exercises/firmware_auditing/README.md)

- [Reference](./doc/reference/README.md)
- [Using Sonata IO](./doc/guide/sonata-io.md)
- [Exploring the CHERIoT RTOS](./doc/exploring-cheriot-rtos.md)
- [Auditing firmware](./doc/auditing-firmware.md)
25 changes: 25 additions & 0 deletions doc/reference/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Reference

The rest of this book is reference and background information.
This information is not necessary to do the exercises, but is still useful for the broader context.

You may also want to look at the other documentation available for Sonata and CHERIoT in general:
- [`sonata-system`][]: holds the Sonata System RTL and bootloader which come together to generate the bitstream.
This repository also has a rendered [Sonata System book][].
- [`sonata-rp2040`][]: The firmware that is running on the Sonata's RP2040 microcontroller and emulates the 'SONATA' drive when you plug it into your computer.
- [`sonata-pcb`][]: The printed circuit board design for Sonata.
- [`cheriot-rtos`][]: The CHERIoT software stack as well as drivers for the Sonata board.
- [`CHERIoT-Platform/llvm-project`][]: The CHERIoT LLVM compiler toolchain.
- [`cheriot-audit`][]: A tool to explore and verify the relationships between CHERIoT RTOS components.
- [`CHERIoT-Platform/book`][]: The source of the [CHERIoT Programmer's Guide][].

[`sonata-software`]: https://github.com/lowRISC/sonata-software
[`cheriot-rtos`]: https://github.com/CHERIoT-Platform/cheriot-rtos
[`sonata-system`]: https://github.com/lowRISC/sonata-system
[`sonata-rp2040`]: https://github.com/newaetech/sonata-rp2040
[`CHERIoT-Platform/llvm-project`]: https://github.com/CHERIoT-Platform/llvm-project
[`cheriot-audit`]: https://github.com/CHERIoT-Platform/cheriot-audit
[`CHERIoT-Platform/book`]: https://github.com/CHERIoT-Platform/book
[CHERIoT Programmer's Guide]: https://cheriot.org/book/
[Sonata System book]: https://lowrisc.org/sonata-system/
[`sonata-pcb`]: https://github.com/newaetech/sonata-pcb
Loading