Skip to content

Improve carfield documentation #299

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

Improve carfield documentation #299

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
763f4ae
Adding carfields's and cl_dma's regfile documentation md files
Mar 12, 2025
0b1b2cb
Adding .hjson files of cl_dma and carfield's regfile
Mar 12, 2025
dc3f7d6
Add new Carfield registers documentation in directory /docs/um/ip
May 22, 2025
28e0ea2
Add updated Carfield IP documentation and PDF generation script
May 28, 2025
fa81cb6
new update of carfield documentation
Jun 5, 2025
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
268 changes: 268 additions & 0 deletions docs/CL_DMA.md
View file
Open in desktop

Large diffs are not rendered by default.

1,126 changes: 1,126 additions & 0 deletions docs/carfield.md
View file
Open in desktop

Large diffs are not rendered by default.

1,126 changes: 1,126 additions & 0 deletions docs/carfield_regs.md
View file
Open in desktop

Large diffs are not rendered by default.

Binary file added docs/integrated_ips_md_files.pdf
View file
Open in desktop
Binary file not shown.
25,684 changes: 25,684 additions & 0 deletions docs/merged_md_files.md
View file
Open in desktop

Large diffs are not rendered by default.

18 changes: 9 additions & 9 deletions docs/um/arch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,20 +69,20 @@ clarity.
|--------------------------|-------------------------|------------------|----------|-----------------|---------------|-------------|--------------|----------------------------------------------------------------------|
| **Internal to Cheshire** | | | | | | | | |
| `0x0000_0000` | `0x0004_0000` | `0x04_0000` | 256 KiB | (debug) | | | Debug | Debug CVA6 |
| `0x0004_0000` | `0x0100_0000` | | | | | | *Reserved* | |
| `0x0100_0000` | `0x0100_1000` | `0x00_1000` | 4 KiB | rw | | | Config | AXI DMA Config |
| `0x0004_0000` | `0x0100_0000` | | | | | | *Reserved* | |
| `0x0100_0000` | `0x0100_1000` | `0x00_1000` | 4 KiB | rw | | | Config | carfield/docs/um/ip/axi_dma_config/doc/idma_desc64_frontend_doc Config |
| `0x0100_1000` | `0x0200_0000` | | | | | | *Reserved* | |
| `0x0200_0000` | `0x0204_0000` | `0x04_0000` | 256 KiB | rx | | | Memory | Boot ROM |
| `0x0204_0000` | `0x0208_0000` | `0x04_0000` | 256 KiB | rw | | | Irq | CLINT |
| `0x0208_0000` | `0x020c_0000` | `0x04_0000` | 256 KiB | rw | | | Irq | IRQ Routing |
| `0x020c_0000` | `0x0210_0000` | `0x04_0000` | 256 KiB | rw | | | Irq | AXI-REALM unit |
| `0x0208_0000` | `0x020c_0000` | `0x04_0000` | 256 KiB | rw | | | Irq | carfield/docs/um/ip/irq_router/doc/registers.md |
| `0x020c_0000` | `0x0210_0000` | `0x04_0000` | 256 KiB | rw | | | Irq | carfield/docs/um/ip/axi_realm/doc/registers.md |
| `0x020c_0000` | `0x0300_0000` | | | | | | *Reserved* | |
| `0x0300_0000` | `0x0300_1000` | `0x00_1000` | 4 KiB | rw | | | Config | Cheshire PCRs |
| `0x0300_0000` | `0x0300_1000` | `0x00_1000` | 4 KiB | rw | | | Config | carfield/docs/um/ip/cheshire/doc/registers.md |
| `0x0300_1000` | `0x0300_2000` | `0x00_1000` | 4 KiB | rw | | | Config | LLC |
| `0x0300_2000` | `0x0300_3000` | `0x00_1000` | 4 KiB | rw | | | I/O | [UART](https://opentitan.org/book/hw/ip/uart/doc/registers.html) |
| `0x0300_3000` | `0x0300_4000` | `0x00_1000` | 4 KiB | rw | | | I/O | [I2C](https://opentitan.org/book/hw/ip/i2c/doc/registers.html) |
| `0x0300_4000` | `0x0300_5000` | `0x00_1000` | 4 KiB | rw | | | I/O | [SPIM](https://opentitan.org/book/hw/ip/spi_host/doc/registers.html) |
| `0x0300_5000` | `0x0300_6000` | `0x00_1000` | 4 KiB | rw | | | I/O | [GPIO](https://opentitan.org/book/hw/ip/gpio/doc/registers.html) |
| `0x0300_2000` | `0x0300_3000` | `0x00_1000` | 4 KiB | rw | | | I/O | carfield/docs/um/ip/uart/doc/registers.md |
| `0x0300_3000` | `0x0300_4000` | `0x00_1000` | 4 KiB | rw | | | I/O | carfield/docs/um/ip/i2c/doc/registers.md |
| `0x0300_4000` | `0x0300_5000` | `0x00_1000` | 4 KiB | rw | | | I/O | carfield/docs/um/ip/spim/doc/registers.md |
| `0x0300_5000` | `0x0300_6000` | `0x00_1000` | 4 KiB | rw | | | I/O | carfield/docs/um/ip/gpio/doc/registers.md |
| `0x0300_6000` | `0x0300_7000` | `0x00_1000` | 4 KiB | rw | | | Config | Serial Link |
| `0x0300_7000` | `0x0300_8000` | `0x00_1000` | 4 KiB | rw | | | Config | VGA |
| `0x0300_8000` | `0x0300_A000` | `0x00_1000` | 8 KiB | rw | | | Config | UNBENT (bus error unit) |
Expand Down
Binary file added docs/um/carfield_full_doc-online.pdf
View file
Open in desktop
Binary file not shown.
Loading
Loading