From 29fef1b37cbd2f7317726de173ae875dac56b0ee Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Tue, 7 Oct 2025 15:58:57 +0200 Subject: [PATCH] README --- README.md | 28 +++++++++++++++++++++------- 1 file changed, 21 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 373294b..4b6e89e 100644 --- a/README.md +++ b/README.md @@ -6,17 +6,23 @@ family of SoCs. # List of crates -This workspace contains the following crates: +This project contains the following crates: + +## Zynq Workspace + +This workspace contains libraries and application which can only be run on the target system. - The [`zynq7000-rt`](https://egit.irs.uni-stuttgart.de/rust/zynq7000-rs/src/branch/main/zynq7000-rt) run-time crate containing basic low-level startup code necessary to boot a Rust app on the Zynq7000. - The [`zynq7000`](https://egit.irs.uni-stuttgart.de/rust/zynq7000-rs/src/branch/main/zynq7000) PAC - crate containing basic low-level register definition. + crate containing basic low-level register definitions. +- The [`zynq7000-mmu`](https://egit.irs.uni-stuttgart.de/rust/zynq7000-rs/src/branch/main/zynq7000-hal) + crate containing common MMU abstractions used by both the HAL and the run-time crate. - The [`zynq7000-hal`](https://egit.irs.uni-stuttgart.de/rust/zynq7000-rs/src/branch/main/zynq7000-hal) HAL crate containing higher-level abstractions on top of the PAC register crate. - The [`zynq7000-embassy`](https://egit.irs.uni-stuttgart.de/rust/zynq7000-rs/src/branch/main/zynq7000-embassy) - crate containing support for running the embassy-rs RTOS. + crate containing support for running the embassy-rs asynchronous run-time. It also contains the following helper crates: @@ -25,13 +31,21 @@ It also contains the following helper crates: This folder also contains dedicated example applications using the [`embassy`](https://github.com/embassy-rs/embassy) native Rust RTOS. -The [`zedboard-fpga-design`](https://egit.irs.uni-stuttgart.de/rust/zynq7000-rs/src/branch/main/zedboard-fpga-design) -folder contains a sample FPGA design and block design which was used in -some of the provided software examples. The project was created with Vivado version 2024.1. -The folder contains a README with all the steps required to load this project from a TCL script. +## Other libraries and tools + +- The [`zedboard-fpga-design`](https://egit.irs.uni-stuttgart.de/rust/zynq7000-rs/src/branch/main/zedboard-fpga-design) + folder contains a sample FPGA design and block design which was used in some of the provided software examples. The project was created with Vivado version 2024.1. + The folder contains a README with all the steps required to load this project from a TCL script. +- The [`zynq7000-boot-image`](https://egit.irs.uni-stuttgart.de/rust/zynq7000-rs/src/branch/main/zynq7000-boot-image) + library contains generic helpers to interface with the AMD + [boot binary](https://docs.amd.com/r/en-US/ug1283-bootgen-user-guide). +- The [`tools/zynq7000-ps7init-extract`](https://egit.irs.uni-stuttgart.de/rust/zynq7000-rs/src/branch/main/tools/zynq7000-ps7init-extract) + tool allows extracting configuration from the AMD generated `ps7init.tcl` file which contains + static configuration parameters for DDR initialization. # Using the `.cargo/config.toml` file +This is mostly relevant for development directly inside this repostiory. Use the following command to have a starting `config.toml` file ```sh