Skip to content

Commit ab86233

Browse files
committed
[doc] Minor I2C/UART doc updates to point to the locked OT revision
Make sure that the linked documentation actually reflects the state of the registers, even if it isn't on the rendered OpenTitan site. Also make a couple of grammatical fixes and correct a typo. Signed-off-by: Alex Jones <alex.jones@lowrisc.org>
1 parent 6064566 commit ab86233

2 files changed

Lines changed: 9 additions & 6 deletions

File tree

doc/ip/i2c.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
# Inter-integrated circuit (I2C) host
22

3-
For the I2C block in Sonata, we use the [OpenTitan IP](https://opentitan.org/book/hw/ip/i2c/index.html).
4-
We hardcode this block to be in host mode, so you can ignore the target functionality, including register `ovrd`, `val`, `target_id`, `acqdata` and `txdata`.
5-
Other than those you can find the [register definitions here](https://opentitan.org/book/hw/ip/i2c/doc/registers.html).
3+
For the I2C block in Sonata, we use the OpenTitan IP.
4+
The version of the IP that is vendored in has documentation that you can find [here](https://github.com/lowRISC/opentitan/tree/a78922f14a8cc20c7ee569f322a04626f2ac6127/hw/ip/i2c/doc).
5+
Another useful reference is the [existing driver](https://github.com/microsoft/cheriot-rtos/blob/main/sdk/include/platform/sunburst/platform-i2c.hh) for this block in the CHERIoT RTOS repository.
6+
We hardcode this block to be in host mode, so you can ignore the target functionality, including the following registers: `ovrd`, `val`, `target_id`, `acqdata` and `txdata`.
7+
Other than those, you can find the [register definitions here](https://github.com/lowRISC/opentitan/blob/a78922f14a8cc20c7ee569f322a04626f2ac6127/hw/ip/i2c/doc/registers.md).
68
The registers `0x00` - `0x10` are also not accessible.
79
The control register is just hardwired to be in host mode.
810

911
For Sonata, we include two I2C blocks.
10-
The registers of the second I2C block can be accessed with and additional `0x1000` offset.
12+
The registers of the second I2C block can be accessed with an additional `0x1000` offset.
1113
These can be connected to any of these I2C targets:
1214
- Two for the QWIIC connectors.
1315
- One for the mikroBUS.

doc/ip/uart.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# Universal asynchronous receiver/transmitter (UART)
22

3-
The Sonata system uses [the OpenTitan UART](https://opentitan.org/book/hw/ip/uart/index.html).
4-
You can find [the register definitions here](https://opentitan.org/book/hw/ip/uart/doc/registers.html).
3+
The Sonata system uses the OpenTitan UART.
4+
The version of the IP that is vendored in has documentation that you can find [here](https://github.com/lowRISC/opentitan/tree/a78922f14a8cc20c7ee569f322a04626f2ac6127/hw/ip/uart/doc).
5+
You can find [the register definitions here](https://github.com/lowRISC/opentitan/blob/a78922f14a8cc20c7ee569f322a04626f2ac6127/hw/ip/uart/doc/registers.md).
56

67
There are multiple UART instances in Sonata to connect to any of the following targets:
78
- USB

0 commit comments

Comments
 (0)