Merge pull request #78 from thejpster/merge-rename

Create aarch32-cpu and aarch32-rt crates.

Author: jonathanpallant

.cargo/config.toml

@@ -16,5 +16,11 @@ runner = "qemu-system-arm -machine versatileab -cpu cortex-a8 -semihosting -nogr
 [target.armv7a-none-eabi]
 runner = "qemu-system-arm -machine versatileab -cpu cortex-a8 -semihosting -nographic -audio none -kernel"
 
+[target.armv5te-none-eabi]
+runner = "qemu-system-arm -machine versatileab -cpu arm926 -semihosting -nographic -audio none -kernel"
+
+[target.armv4t-none-eabi]
+runner = "qemu-system-arm -machine versatileab -cpu pxa250 -semihosting -nographic -audio none -kernel"
+
 [unstable]
 build-std = ["core", "alloc"]

.github/workflows/build.yml

@@ -294,7 +294,7 @@ jobs:
           rustup default stable
       - name: Run cargo test
         run: |
-          cargo test --manifest-path cortex-ar/Cargo.toml
+          cargo test --manifest-path aarch32-cpu/Cargo.toml
 
   # Run some programs in QEMU 9
   qemu-test:

Cargo.toml

@@ -5,9 +5,8 @@ exclude = [
   "examples/mps3-an536",
 ]
 members = [
-  "cortex-ar",
-  "cortex-r-rt",
-  "cortex-a-rt",
-  "cortex-ar-rt-macros",
+  "aarch32-cpu",
+  "aarch32-rt",
+  "aarch32-rt-macros",
 ]
 resolver = "2"

README.md

@@ -1,12 +1,19 @@
-# Rust on Arm Cortex-R and Cortex-A
+# Rust on Arm AArch32
 
 This repository provides support for:
 
+* Legacy Arm Processors, like the ARM7TDMI and ARM926
 * Armv7-R Processors, like the Arm Cortex-R5
 * Armv8-R AArch32 Processors, like the Arm Cortex-R52
 * Armv7-A Processors, like the Arm Cortex-A5
 * Armv8-A AArch32 Processors, like the Arm Cortex-A53 running in 32-bit mode
 
+It does not support any M-Profile Processors (like the Arm Cortex-M3) as they
+have a fundamentally different interrupt vector table.
+
+It also does not support processors running in AArch64 mode - A64 machine code
+uses different instructions for reading/writing system registers.
+
 These libraries were originally written by Ferrous Systems, and are based on the
 [`cortex-m` libraries] from the [Rust Embedded Devices Working Group].
 
@@ -15,11 +22,10 @@ These libraries were originally written by Ferrous Systems, and are based on the
 
 There are currently five libraries here:
 
-* [cortex-ar](./cortex-ar/) - support library for Cortex-R and Cortex-A CPUs (like [cortex-m])
-* [cortex-r-rt](./cortex-r-rt/) - run-time library for Cortex-R CPUs (like [cortex-m-rt])
-* [cortex-a-rt](./cortex-a-rt/) - run-time library for Cortex-A CPUs (like [cortex-m-rt])
+* [aarch32](./aarch32/) - support library for AArch32 CPUs (like the [cortex-m] crate)
+* [aarch32-rt](./aarch32-rt/) - run-time library for AArch32 CPUs (like the [cortex-m-rt] crate)
 * [arm-targets](./arm-targets/) - a helper library for your build.rs that sets various `--cfg` flags according to the current target
-* [cortex-ar-rt-macros](./cortex-ar-rt-macros/) - macros for `cortex-a-rt` and `cortex-r-rt` (this is an implementation detail - do not use this crate directly)
+* [aarch32-rt-macros](./aarch32-rt-macros/) - macros for `aarch32-rt` (this is an implementation detail - do not use this crate directly)
 
 There are also example programs for QEMU in the [examples](./examples/) folder.
 

cortex-ar/CHANGELOG.md renamed to aarch32-cpu/CHANGELOG.md

@@ -7,9 +7,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
-## [v0.3.0]
+### Changed
+
+- Renamed from `cortex-ar` to `aarch32-cpu`
+- Added ARMv4T and ARMv5TE support
+
+## [cortex-ar v0.3.0]
 
-- Bumped MSRV for `cortex-ar` to v1.83 to allow compatibility with `arbitrary-int` v2.
+- Bumped MSRV to v1.83 to allow compatibility with `arbitrary-int` v2.
 
 ### Added
 
@@ -30,7 +35,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Bumped `defmt` to v1
 - Bumped `arbitrary-int` to v2
 
-## [v0.2.0]
+## [cortex-ar v0.2.0]
 
 ### Added
 
@@ -45,11 +50,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - The `dsb` and `isb` functions now include compiler fences
 - Added `nomem`, `nostack` and `preserves_flags` options for ASM where applicable.
 
-## [v0.1.0]
+## [cortex-ar v0.1.0]
 
 Initial release
 
 [Unreleased]: https://github.com/rust-embedded/cortex-ar/compare/cortex-ar-v0.3.0...HEAD
-[v0.3.0]: https://github.com/rust-embedded/cortex-ar/compare/cortex-ar-v0.2.0...cortex-ar-v0.3.0
-[v0.2.0]: https://github.com/rust-embedded/cortex-ar/compare/cortex-ar-v0.1.0...cortex-ar-v0.2.0
-[v0.1.0]: https://github.com/rust-embedded/cortex-ar/releases/tag/cortex-ar-v0.1.0
+[cortex-ar v0.3.0]: https://github.com/rust-embedded/cortex-ar/compare/cortex-ar-v0.2.0...cortex-ar-v0.3.0
+[cortex-ar v0.2.0]: https://github.com/rust-embedded/cortex-ar/compare/cortex-ar-v0.1.0...cortex-ar-v0.2.0
+[cortex-ar v0.1.0]: https://github.com/rust-embedded/cortex-ar/releases/tag/cortex-ar-v0.1.0

cortex-ar/Cargo.toml renamed to aarch32-cpu/Cargo.toml

@@ -7,7 +7,7 @@ categories = [
     "embedded",
     "no-std",
 ]
-description = "CPU support for AArch32 Arm Cortex-R and Arm Cortex-A"
+description = "CPU support for AArch32 Arm Processors"
 edition = "2021"
 keywords = [
     "arm",
@@ -17,12 +17,12 @@ keywords = [
     "no-std",
 ]
 license = "MIT OR Apache-2.0"
-name = "cortex-ar"
+name = "aarch32-cpu"
 readme = "README.md"
 repository = "https://github.com/rust-embedded/cortex-ar.git"
 homepage = "https://github.com/rust-embedded/cortex-ar.git"
 rust-version = "1.83"
-version = "0.3.0"
+version = "0.1.0"
 
 [dependencies]
 arbitrary-int = "2"
@@ -46,6 +46,9 @@ critical-section-multi-core = ["critical-section"]
 # Adds defmt::Format implementation for the register types
 defmt = ["dep:defmt", "arbitrary-int/defmt"]
 serde = ["dep:serde", "arbitrary-int/serde"]
+# Stops assembly routines being inlined, so they can be checked when this
+# library is compiled (as opposed to when the function is used)
+check-asm = []
 
 [package.metadata.docs.rs]
 targets = ["armv7r-none-eabihf", "armv7r-none-eabi", "armv7a-none-eabihf"]

cortex-ar/README.md renamed to aarch32-cpu/README.md

@@ -1,27 +1,31 @@
-[![crates.io](https://img.shields.io/crates/v/cortex-ar)](https://crates.io/crates/cortex-ar)
-[![docs.rs](https://img.shields.io/docsrs/cortex-ar)](https://docs.rs/cortex-ar)
+[![crates.io](https://img.shields.io/crates/v/aarch32-cpu)](https://crates.io/crates/aarch32-cpu)
+[![docs.rs](https://img.shields.io/docsrs/aarch32-cpu)](https://docs.rs/aarch32-cpu)
 
-# Support for Arm Cortex-R (AArch32) and Arm Cortex-A (AArch32)
+# Support for AArch32 Arm Processors
 
 This crate provides access to CPU registers and common peripherals for:
 
+* Legacy Arm Processors, like the ARM7TDMI and ARM926
 * Armv7-R Processors, like the Arm Cortex-R5
 * Armv8-R AArch32 Processors, like the Arm Cortex-R52
 * Armv7-A Processors, like the Arm Cortex-A5
 * Armv8-A AArch32 Processors, like the Arm Cortex-A53 running in 32-bit mode
 
-It does not support processors running in AArch64 mode - A64 machine code uses
-different instructions for reading/writing system registers.
+It does not support any M-Profile Processors (like the Arm Cortex-M3) as they
+have a fundamentally different interrupt vector table.
+
+It also does not support processors running in AArch64 mode - A64 machine code
+uses different instructions for reading/writing system registers.
 
 This crate contains:
 
-* Raw register access to many Armv7-R and Armv8-R AArch32 system registers
+* Raw register access to many AArch32 system registers
 * A driver for the PMSAv7 Memory Protection Unit (MPU)
 * A driver for the PMSAv8-R Memory Protection Unit (MPU)
 * A driver for the Arm Generic Timer
 
 If you need a driver for the Arm Generic Interrupt Controller, see
-<https://github.com/google/arm-gic>.
+<https://github.com/ArmFirmwareCrates/arm-gic>.
 
 ## Minimum Supported Rust Version (MSRV)
 

cortex-ar/build.rs renamed to aarch32-cpu/build.rs

@@ -1,14 +1,18 @@
 //! Simple assembly routines
 
-use core::sync::atomic::{compiler_fence, Ordering};
-
 /// Data Memory Barrier
 ///
 /// Ensures that all explicit memory accesses that appear in program order before the `DMB`
 /// instruction are observed before any explicit memory accesses that appear in program order
 /// after the `DMB` instruction.
-#[inline]
+#[cfg_attr(not(feature = "check-asm"), inline)]
+#[cfg(any(
+    arm_architecture = "v7-r",
+    arm_architecture = "v7-a",
+    arm_architecture = "v8-r"
+))]
 pub fn dmb() {
+    use core::sync::atomic::{compiler_fence, Ordering};
     compiler_fence(Ordering::SeqCst);
     unsafe {
         core::arch::asm!("dmb", options(nostack, preserves_flags));
@@ -23,8 +27,14 @@ pub fn dmb() {
 ///
 ///  * any explicit memory access made before this instruction is complete
 ///  * all cache and branch predictor maintenance operations before this instruction complete
-#[inline]
+#[cfg_attr(not(feature = "check-asm"), inline)]
+#[cfg(any(
+    arm_architecture = "v7-r",
+    arm_architecture = "v7-a",
+    arm_architecture = "v8-r"
+))]
 pub fn dsb() {
+    use core::sync::atomic::{compiler_fence, Ordering};
     compiler_fence(Ordering::SeqCst);
     unsafe {
         core::arch::asm!("dsb", options(nostack, preserves_flags));
@@ -36,8 +46,14 @@ pub fn dsb() {
 ///
 /// Flushes the pipeline in the processor, so that all instructions following the `ISB` are fetched
 /// from cache or memory, after the instruction has been completed.
-#[inline]
+#[cfg_attr(not(feature = "check-asm"), inline)]
+#[cfg(any(
+    arm_architecture = "v7-r",
+    arm_architecture = "v7-a",
+    arm_architecture = "v8-r"
+))]
 pub fn isb() {
+    use core::sync::atomic::{compiler_fence, Ordering};
     compiler_fence(Ordering::SeqCst);
     unsafe {
         core::arch::asm!("isb", options(nostack, preserves_flags));
@@ -46,25 +62,40 @@ pub fn isb() {
 }
 
 /// Emit an NOP instruction
-#[inline]
+#[cfg_attr(not(feature = "check-asm"), inline)]
 pub fn nop() {
     unsafe { core::arch::asm!("nop", options(nomem, nostack, preserves_flags)) }
 }
 
 /// Emit an WFI instruction
-#[inline]
+#[cfg_attr(not(feature = "check-asm"), inline)]
+#[cfg(any(
+    arm_architecture = "v7-r",
+    arm_architecture = "v7-a",
+    arm_architecture = "v8-r"
+))]
 pub fn wfi() {
     unsafe { core::arch::asm!("wfi", options(nomem, nostack, preserves_flags)) }
 }
 
 /// Emit an WFE instruction
-#[inline]
+#[cfg_attr(not(feature = "check-asm"), inline)]
+#[cfg(any(
+    arm_architecture = "v7-r",
+    arm_architecture = "v7-a",
+    arm_architecture = "v8-r"
+))]
 pub fn wfe() {
     unsafe { core::arch::asm!("wfe", options(nomem, nostack, preserves_flags)) }
 }
 
 /// Emit an SEV instruction
-#[inline]
+#[cfg_attr(not(feature = "check-asm"), inline)]
+#[cfg(any(
+    arm_architecture = "v7-r",
+    arm_architecture = "v7-a",
+    arm_architecture = "v8-r"
+))]
 pub fn sev() {
     unsafe {
         core::arch::asm!("sev");
@@ -74,11 +105,20 @@ pub fn sev() {
 /// Which core are we?
 ///
 /// Return the bottom 24-bits of the MPIDR
-#[inline]
+#[cfg_attr(not(feature = "check-asm"), inline)]
 pub fn core_id() -> u32 {
     let r: u32;
     unsafe {
         core::arch::asm!("MRC p15, 0, {}, c0, c0, 5", out(reg) r, options(nomem, nostack, preserves_flags));
     }
     r & 0x00FF_FFFF
 }
+
+#[cfg(any(arm_architecture = "v4t", arm_architecture = "v5te"))]
+#[no_mangle]
+pub extern "C" fn __sync_synchronize() {
+    // we don't have a barrier instruction - the linux kernel just uses an empty inline asm block
+    unsafe {
+        core::arch::asm!("");
+    }
+}