diff --git a/zynq7000-rt/README.md b/zynq7000-rt/README.md index 77d189f..b1e31c7 100644 --- a/zynq7000-rt/README.md +++ b/zynq7000-rt/README.md @@ -5,8 +5,11 @@ Startup code and minimal runtime for the AMD Zynq7000 SoC to write bare metal Ru This run-time crate is strongly based on the [startup code provided by AMD](https://github.com/Xilinx/embeddedsw/blob/master/lib/bsp/standalone/src/arm/cortexa9/gcc/boot.S). -One major difference is that the MMU table is specified as Rust code. There are also modification -to the stack setup code, because a different linker script is used. +Some major differences: + +- No L2 cache initialization is performed. +- MMU table is specified as Rust code. +- Modification to the stack setup code, because a different linker script is used. This crate pulls in the [cortex-a-rt](https://github.com/us-irs/cortex-ar/tree/cortex-a-addition/cortex-a-rt) crate to provide ARM vectors and the linker script. diff --git a/zynq7000-rt/src/lib.rs b/zynq7000-rt/src/lib.rs index f348dc2..baec7fd 100644 --- a/zynq7000-rt/src/lib.rs +++ b/zynq7000-rt/src/lib.rs @@ -1,7 +1,12 @@ -//! Rust bare metal run-time support for the AMD Zynq 7000 SoCs +//! # Rust bare metal run-time support for the AMD Zynq 7000 SoCs //! //! This includes basic low-level startup code similar to the bare-metal boot routines //! [provided by Xilinx](https://github.com/Xilinx/embeddedsw/tree/master/lib/bsp/standalone/src/arm/cortexa9/gcc). +//! Some major differences: +//! +//! - No L2 cache initialization is performed. +//! - MMU table is specified as Rust code. +//! - Modification to the stack setup code, because a different linker script is used. #![no_std] #[cfg(feature = "rt")] pub use cortex_a_rt::*;