From aec64d2d9a5b5fd7e4000a871ceee2a5708257a6 Mon Sep 17 00:00:00 2001 From: Marno van der Maas Date: Wed, 25 Feb 2026 14:14:15 +0000 Subject: [PATCH 1/2] [doc] Debug module link added to table --- doc/dev/ref-manual.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/dev/ref-manual.md b/doc/dev/ref-manual.md index 323b0df3d..441430367 100644 --- a/doc/dev/ref-manual.md +++ b/doc/dev/ref-manual.md @@ -59,7 +59,7 @@ For all registers in this section, the functionality is mapped onto the least si | 0x8030_0000 | 1 MiB | [SPI host][] | | 0x8040_0000 | 1 MiB | [USB device][] | | 0x8800_0000 | 64 MiB | [PLIC][] | -| 0xB000_0000 | 4 KiB | Reserved for debug module | +| 0xB000_0000 | 4 KiB | [Debug module][] | [GPIO]: ../ip/gpio.md [PWM]: ../ip/pwm.md From 900d0f35dd043068f4a83d697bd89a4cd2e4dfff Mon Sep 17 00:00:00 2001 From: Marno van der Maas Date: Wed, 25 Feb 2026 14:17:02 +0000 Subject: [PATCH 2/2] [doc] Point directly to Github page We don't need to rely on the lowrisc.org re-direct because we can simply point to the Github page itself. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d5e5b2ced..196abd2e3 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # Sonata system -Sonata 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. +Sonata is a system for evaluating the usage of the [CHERIoT Ibex core](https://github.com/microsoft/cheriot-ibex) as a microcontroller for embedded, IoT and Operational Technology applications. The system contains a number of peripherals (I2C, SPI, GPIO, USB, and UART) and the CHERIoT Ibex core itself. It is designed for use on FPGA and specifically targets the [Sonata FPGA board](https://github.com/newaetech/sonata-pcb), but as the entire design is open-source (from PCB to software), it can be run on any similar system. This project is designed to look like a normal microcontroller in terms of usability, including SDK, examples, and normal capabilities such as debuggers. But underneath that the [CHERIoT](https://www.microsoft.com/en-us/research/publication/cheriot-rethinking-security-for-low-cost-embedded-systems/) capabilities provides a high level of "default security" that simplifies designing embedded systems in a secure manner. -You can see the [complete documentation](https://lowrisc.org/sonata-system/) for the project. +You can see the [complete documentation](https://lowrisc.github.io/sonata-system/) for the project. Sonata is part of the [Sunburst Project](https://www.sunburst-project.org) funded by [UKRI](https://www.ukri.org/) / [DSbD](https://www.dsbd.tech/) under grant number 107540. ![The sonata development system](doc/img/sonata-development-system.svg) @@ -43,7 +43,7 @@ You can also work with a simulated environment, and there is a nice guide on thi ## Documentation introduction -This documentation is built using [mdBook](https://rust-lang.github.io/mdBook/). If you are reading this file in GitHub, you should instead see the pre-built documentation on the [lowRISC Website](https://lowrisc.org/sonata-system/) which includes the full documentation. +This documentation is built using [mdBook](https://rust-lang.github.io/mdBook/). If you are reading this file in GitHub, you should instead see the pre-built documentation on the [lowRISC Website](https://lowrisc.github.io/sonata-system/) which includes the full documentation. If you'd like to build a copy of the documentation locally, see the [Building Documentation](doc/dev/building-doc.md) page.