Merge pull request #5 from RusPiRo/fix/0.3.1

Fix severe exception handler issues

Author: 2ndTaleStudio

CHANGELOG.md

@@ -1,4 +1,25 @@
 # Changelog
+## :apple: v0.3.1
+  - ### :bulb: Features
+    - add some console log statements in the panic handler that gives a clue of the panic when at least
+    the console could be setup properly before panicing the first time :)
+    - use Raspberry Pi Mailbox to retrieve clock speed to initialize miniUart with
+  - ### :detective: Fixes
+    - Fix the path created by the build script pointing to the linker script file. It should not contain a '\\\\'.
+    In addition the examples for the build script to be implementend on consumer side was updated.
+    - Fix issues with the exception calls and returns as several registers where trashed that
+    should have been preserved
+    
+  - ### :wrench: Maintenance
+    - Use additional ``cfg`` and ``cfg_attr`` to enable running ``cargo test`` which requires some functions from ``std``.
+    - Update to latest ``ruspiro-register`` version
+    - Remove ``ruspiro-gpio`` dependency
+    - Remove the ``ruspiro_interrupt`` dependencie to let the using crate decide whether to incorporate
+    interrupt handling or not. This than also includes the crate introducing interrupt handling usage need to
+    proper initialize interrupt handling.
+
+  
+    
 ## :carrot: v0.3.0
   - ### :bulb: Features
     Refactor the boot strapping code to support `Aarch32` and `Aarch64` build target architectures.

Cargo.lock

@@ -1,15 +1,15 @@
 [package]
 name = "ruspiro-boot"
 authors = ["André Borrmann <[email protected]>"]
-version = "0.3.0" # remember to update html_root_url
+version = "0.3.1" # remember to update html_root_url
 description = """
 Baremetal boot strapper code for the Raspberry Pi 3 to conviniently start a custom kernel within the Rust environment
 without the need to deal with all the initial setup like stack pointers, getting MMU setup and get all cores kicked off 
 for processing. Supports Aarch32 and Aarch64 builds.
 """
 license = "Apache-2.0"
-repository = "https://github.com/RusPiRo/ruspiro-boot"
-documentation = "https://docs.rs/ruspiro-boot/0.3.0"
+repository = "https://github.com/RusPiRo/ruspiro-boot/tree/v0.3.1"
+documentation = "https://docs.rs/ruspiro-boot/0.3.1"
 readme = "README.md"
 keywords = ["RusPiRo", "raspberrypi", "boot", "baremetal", "multicore"]
 categories = ["no-std", "embedded"]
@@ -27,19 +27,20 @@ maintenance = { status = "actively-developed" }
 cc = "1.0.38"
 
 [dependencies]
-ruspiro-register = { path = "../register", version = "0.3" }
-ruspiro-gpio = { path = "../gpio", version = "0.3" }
-ruspiro-interrupt = { path = "../interrupt", version = "0.3" }
+ruspiro-register = { path = "../register", version = "0.4" }
+ruspiro-mailbox = { path = "../mailbox", version =" 0.3" }
 ruspiro-uart = { path = "../uart", version = "0.3" }
 ruspiro-console = { path = "../console", version = "0.3" }
-ruspiro-timer = { path = "../timer", version = "0.3" }
+ruspiro-timer = { path = "../timer", version = "0.4" }
 ruspiro-cache = { path = "../cache", version = "0.3" }
+ruspiro-interrupt = { path = "../interrupt", version = "0.3" }
 
 [features]
 ruspiro_pi3 = [
-    "ruspiro-gpio/ruspiro_pi3",
+    "ruspiro-mailbox/ruspiro_pi3",
     "ruspiro-uart/ruspiro_pi3",
-    "ruspiro-timer/ruspiro_pi3"
+    "ruspiro-timer/ruspiro_pi3",
+    "ruspiro-interrupt/ruspiro_pi3"
 ]
 singlecore = []
 with_panic = []

Cargo.toml

@@ -8,18 +8,24 @@ This crate provides basic boot code that - when build into a kernel crate - will
 [![License](https://img.shields.io/crates/l/ruspiro-boot.svg)](https://github.com/RusPiRo/ruspiro-boot#license)
 
 ## Hint
-
 The usage of this crate does only make sense when building a Raspberry Pi 3 bare metal kernel. The 
 baremetal bootstrapping provided by this crate can be build for either Aarch32 or Aarch64 target
 architectures. It has been verified to cross compile from a Windows host machine successfully for
 both architectures and the execution is tested on a Raspberry Pi 3 B+.
 
+## Features
+Feature            | Purpose
+-------------------|--------------------------
+``with_panic``     | Implement a default panic handler
+``singlecore``     | Keep all cores except one in a "parked" state so the runtime only uses a single core.
+``ruspiro_pi3``    | This is passed to the dependend crates to ensure they will be build properly for this target device.
+
 ## Usage
 To use this crate simply add the following lines to your ``Cargo.toml`` file:
 (hint: git dependency as long as the crate is not registered at crates.io)
 ```toml
 [dependencies]
-ruspiro-boot = { version = "0.3", features = ["with_panic"] }
+ruspiro-boot = { version = "0.3", features = ["ruspiro_pi3", "with_panic"] }
 ```
 In the main rust file refer to this crate with this:
 ```rust
@@ -29,13 +35,6 @@ extern crate ruspiro_boot;
 The usage of `extern crate` is mandatory to ensure the boot strapping is properly linked into the
 final binary.
 
-## Features
-Feature            | Purpose
--------------------|--------------------------
-``with_panic``     | Implement a default panic handler
-``singlecore``     | Keep all cores except one in a "parked" state so the runtime only uses a single core.
-``ruspiro_pi3``    | This is passed to the dependend crates to ensure they will be build properly for this target device.
-
 To successfully build a bare metal binary using this crate for the boot strapping part it is **highly recomended** to use the linker script provided by this crate. Based on the target architecture to be built it is either [link32.ld](link32.ld) or [link64.ld](link64.ld).
 To conviniently refer to the linker scripts contained in this crate it's recommended to use a specific build script in your project that copies the required file to your current project folder and could then be referred to with the ``RUSTFLAG`` ``-C link-arg=-T./link<aarch>.ld``.
 The build script is a simple ``build.rs`` rust file in your project root with the following contents:
@@ -46,7 +45,10 @@ fn main() {
     // copy the linker script from the boot crate to the current directory
     // so it will be invoked by the linker
     let ld_source = env::var_os("DEP_RUSPIRO_BOOT_LINKERSCRIPT")
-        .expect("error in ruspiro build, `ruspiro-boot` not a dependency?");
+        .expect("error in ruspiro build, `ruspiro-boot` not a dependency?")
+        .to_str()
+        .unwrap()
+        .replace("\\", "/");
     let src_file = Path::new(&ld_source);
     let trg_file = format!(
         "{}/{}",

README.md

@@ -25,10 +25,11 @@ fn main() {
                 .flag("-march=armv8-a")
                 .compile("excvector");
             // print the linker file location of the boot crate to the env-variables
-            println!(
-                "cargo:linkerscript={}\\link32.ld",
-                script_location.display()
-            );
+            println!("cargo:linkerscript={}/link32.ld", script_location.display());
+
+            println!("cargo:rerun-if-changed=link32.ld");
+            println!("cargo:rerun-if-changed=src/asm/aarch32/bootstrap.S");
+            println!("cargo:rerun-if-changed=src/asm/aarch32/exceptionvector.S");
         }
 
         if target_arch == "aarch64" {
@@ -41,10 +42,11 @@ fn main() {
                 .flag("-march=armv8-a")
                 .compile("excvector");
             // print the linker file location of the boot crate to the env-variables
-            println!(
-                "cargo:linkerscript={}\\link64.ld",
-                script_location.display()
-            );
+            println!("cargo:linkerscript={}/link64.ld", script_location.display());
+
+            println!("cargo:rerun-if-changed=link64.ld");
+            println!("cargo:rerun-if-changed=src/asm/aarch64/bootstrap.S");
+            println!("cargo:rerun-if-changed=src/asm/aarch64/exceptionvector.S");
         }
     }
 }

build.rs

@@ -1,36 +1,50 @@
 #!/bin/sh
-
+#*********************************************************************************
+# script to build the this crate
+#*********************************************************************************
 set +ev
 
 if [ $# -eq 0 ] 
     then 
-        echo "not enough parameter given"
+        echo "provide the target architecture to build for - 32 or 64"
         exit 1
 fi
 
-# check which aarch version to build
 if [ $1 = "64" ]
     then
         # aarch64
-        export CFLAGS='-march=armv8-a -Wall -O3 -nostdlib -nostartfiles -ffreestanding -mtune=cortex-a53'
-        export RUSTFLAGS='-C linker=aarch64-elf-gcc -C target-cpu=cortex-a53 -C target-feature=+strict-align,+a53,+fp-armv8,+neon -C link-arg=-nostartfiles -C opt-level=3 -C debuginfo=0'
-        if [ "$2" = "" ]
+        # use the right compiler toolchain prefix when building on travis
+        if [ -z "$2" ]
             then
-                export CC='aarch64-elf-gcc'
-                export AR='aarch64-elf-ar'
+                PREFIX=aarch64-elf-
+            else
+                PREFIX=aarch64-linux-gnu-
         fi
-        cargo xbuild --target aarch64-unknown-linux-gnu --release
+        CFLAGS="-march=armv8-a -Wall -O3 -nostdlib -nostartfiles -ffreestanding -mtune=cortex-a53"
+        RUSTFLAGS="-C linker=${PREFIX}gcc -C target-cpu=cortex-a53 -C target-feature=+strict-align,+a53,+fp-armv8,+neon -C link-arg=-nostartfiles -C opt-level=3 -C debuginfo=0"
+        TARGET="aarch64-unknown-linux-gnu"
 elif [ $1 = "32" ]
     then
         # aarch32
-        export CFLAGS='-mfpu=neon-fp-armv8 -mfloat-abi=hard -march=armv8-a -Wall -O3 -nostdlib -nostartfiles -ffreestanding -mtune=cortex-a53'
-        export RUSTFLAGS='-C linker=arm-eabi-gcc.exe -C target-cpu=cortex-a53 -C target-feature=+strict-align,+a53,+fp-armv8,+v8,+vfp3,+d16,+thumb2,+neon -C link-arg=-nostartfiles -C opt-level=3 -C debuginfo=0'
+        # use the right compiler toolchain prefix when building on travis
         if [ -z "$2" ]
             then
-                export CC='arm-eabi-gcc.exe'
-                export AR='arm-eabi-ar.exe'
+                PREFIX=arm-eabi-
+            else
+                PREFIX=arm-linux-gnueabihf-
         fi
-        cargo xbuild --target armv7-unknown-linux-gnueabihf --release
+        CFLAGS="-mfpu=neon-fp-armv8 -mfloat-abi=hard -march=armv8-a -Wall -O3 -nostdlib -nostartfiles -ffreestanding -mtune=cortex-a53"
+        RUSTFLAGS="-C linker=${PREFIX}gcc -C target-cpu=cortex-a53 -C target-feature=+strict-align,+a53,+fp-armv8,+v8,+vfp3,+d16,+thumb2,+neon -C link-arg=-nostartfiles -C opt-level=3 -C debuginfo=0"
+        TARGET="armv7-unknown-linux-gnueabihf"
 else
-    echo 'provide the archtitecture to be build. Use either "build.sh 32" or "build.sh 64"'
+    echo 'provide the archtitecture to be build. Use either "build.sh 32" or "build.sh 64".'
+    exit 1
 fi
+
+export CFLAGS="${CFLAGS}"
+export RUSTFLAGS="${RUSTFLAGS}"
+export CC="${PREFIX}gcc"
+export AR="${PREFIX}ar"
+export TARGET="${TARGET}"
+
+cargo xbuild --target ${TARGET} --release --features ruspiro_pi3

build.sh

@@ -14,23 +14,31 @@ all32: export RUSTFLAGS = -C linker=arm-eabi-gcc.exe -C target-cpu=cortex-a53 -C
 all32: export CC = arm-eabi-gcc.exe
 all32: export AR = arm-eabi-ar.exe
 all32: 
-	cargo xbuild --target armv7-unknown-linux-gnueabihf --release --lib --target-dir ./target/
+	cargo xbuild --target armv7-unknown-linux-gnueabihf --release --lib --features ruspiro_pi3
 
 
 all64: export CFLAGS = -march=armv8-a -Wall -O3 -nostdlib -nostartfiles -ffreestanding -mtune=cortex-a53
 all64: export RUSTFLAGS = -C linker=aarch64-elf-gcc.exe -C target-cpu=cortex-a53 -C target-feature=+strict-align,+a53,+fp-armv8,+neon -C link-arg=-nostartfiles -C opt-level=3 -C debuginfo=0 -C link-arg=-T./link64.ld
 all64: export CC = aarch64-elf-gcc.exe
 all64: export AR = aarch64-elf-ar.exe
 all64: 
-	cargo xbuild --target aarch64-unknown-linux-gnu --release --lib --target-dir ./target/
+	cargo xbuild --target aarch64-unknown-linux-gnu --release --lib --features ruspiro_pi3
 
 
 doc: export CFLAGS = -march=armv8-a -Wall -O3 -nostdlib -nostartfiles -ffreestanding -mtune=cortex-a53
 doc: export RUSTFLAGS = -C linker=aarch64-elf-gcc.exe -C target-cpu=cortex-a53 -C target-feature=+strict-align,+a53,+fp-armv8,+neon -C link-arg=-nostartfiles -C opt-level=3 -C debuginfo=0
 doc: export CC = aarch64-elf-gcc.exe
 doc: export AR = aarch64-elf-ar.exe
 doc: 
-	cargo doc --no-deps --target aarch64-unknown-linux-gnu --release --open
+	cargo doc --no-deps --target aarch64-unknown-linux-gnu --features ruspiro_pi3,with_panic --release --open
+
+clippy: export CFLAGS = -march=armv8-a -Wall -O3 -nostdlib -nostartfiles -ffreestanding -mtune=cortex-a53
+clippy: export RUSTFLAGS = -C linker=aarch64-elf-gcc.exe -C target-cpu=cortex-a53 -C target-feature=+strict-align,+a53,+fp-armv8,+neon -C link-arg=-nostartfiles -C opt-level=3 -C debuginfo=0
+clippy: export CC = aarch64-elf-gcc.exe
+clippy: export AR = aarch64-elf-ar.exe
+clippy:
+	# run clippy for this crate using custom target
+	cargo xclippy --target aarch64-unknown-linux-gnu --release --features ruspiro_pi3
 
 clean:
 	cargo clean

makefile

@@ -87,8 +87,9 @@ __boot:
 	orr 	r0, r0, #0x300000		/* enable single precision */
 	orr 	r0, r0, #0xC00000		/* enable double precision */
 	mcr 	p15, 0, r0, c1, c0, 2
+	
 	mov 	r0, #0x40000000
-	fmxr	fpexc, r0
+	vmsr	fpexc, r0
 
     // finally call into the rust code entry point
     mrc     p15, 0, r0, c0, c0, 5   // get core id

src/asm/aarch32/bootstrap.S

@@ -22,7 +22,7 @@
  * save current core state before running any IRQ handler
  **********************************************************************/
 .macro save_state
-    stmfd	sp!, {r0-r3, lr}  // store unbanked corruptile registers +  return address
+    stmfd	sp!, {r0-r11, lr}  // store corruptile registers +  return address
     //mrs     r0, spsr    // get the saved pstate register and store it as well
     //stmfd   sp!, {r0}
     
@@ -41,7 +41,7 @@
 
     //ldmfd   sp!, {r0}   // restore pstate
     //mcr     cpsr, r0
-    ldmfd	sp!, {r0-r3, pc}^ // restore unbanked corruptile registers
+    ldmfd	sp!, {r0-r11, pc}^ // restore corruptile registers
 .endm
 
 /***************************************************************************************************
@@ -168,4 +168,5 @@ __fast_interrupt_trampoline:
 
     bl      __exception_handler_default
 
-	restore_state_return    // return from this exception
+	restore_state_return    // return from this exception
+