Merge pull request #18 from RusPiRo/development

Prepare Release and crates.io publishing

.github/workflows/ci.yml

@@ -21,7 +21,7 @@ jobs:
         uses: actions-rs/toolchain@v1
         with:
           profile: minimal
-          toolchain: nightly
+          toolchain: nightly-2021-04-24
           override: true
           components: rust-src, llvm-tools-preview
           target: aarch64-unknown-linux-gnu
@@ -54,7 +54,7 @@ jobs:
         uses: actions-rs/toolchain@v1
         with:
           profile: minimal
-          toolchain: nightly
+          toolchain: nightly-2021-04-24
           override: true
           components: rust-src, llvm-tools-preview
           target: aarch64-unknown-linux-gnu
@@ -155,7 +155,7 @@ jobs:
         uses: actions-rs/toolchain@v1
         with:
           profile: minimal
-          toolchain: nightly
+          toolchain: nightly-2021-04-24
           override: true
           components: rust-src, llvm-tools-preview
           target: aarch64-unknown-linux-gnu
@@ -195,7 +195,7 @@ jobs:
         uses: actions-rs/toolchain@v1
         with:
           profile: minimal
-          toolchain: nightly
+          toolchain: nightly-2021-04-24
           override: true
           components: rust-src, llvm-tools-preview
           target: aarch64-unknown-linux-gnu

.gitignore

@@ -2,5 +2,4 @@
 **/*/target
 **/*.rs.bk
 **/release
-.vscode
-*.lock
+.vscode

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## :dog: v0.4.2
+
+- ### :wrench: Maintenance
+
+  Some minor cleanup has been done. The major addition is to provide a minimal example of how the crate is intended to be used to implement an interrupt handler based on the ARM system timer.
+
 ## :cat: v0.4.1
 
 - ### :bulb: Features

Cargo.toml

@@ -4,8 +4,12 @@ members = [
   "./interrupt"
 ]
 
+exclude = [
+ "./interrupt/examples/minimal"
+]
+
 [patch.crates-io]
 ruspiro-interrupt-macros = { path = "./macros" }
-ruspiro-mmio-register = { git = "https://github.com/RusPiRo/ruspiro-mmio-register.git" }
-ruspiro-singleton = { git ="https://github.com/RusPiRo/ruspiro-singleton.git" }
+ruspiro-mmio-register = { git = "https://github.com/RusPiRo/ruspiro-mmio-register.git", branch = "development" }
+ruspiro-singleton = { git ="https://github.com/RusPiRo/ruspiro-singleton.git", branch = "development" }
 ruspiro-channel = { git = "https://github.com/RusPiRo/ruspiro-channel.git", branch = "development" }

README.md

@@ -45,6 +45,12 @@ unsafe fn my_handler_for_source(tx: Option<IsrSender<Box<dyn Any>>>) {
 The currently only implemented shared source interrupt line is the ``AUX`` interrupt. There the source could be one of:
 ``Uart1``, ``Spi1`` or ``Spi2``.
 
+## Features
+
+Feature   | Description
+----------|-------------
+**async** | Enables the `async` version of the interrupt handling implementation.
+
 ## License
 
 Licensed under Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) or MIT ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)) at your choice.

interrupt/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "ruspiro-interrupt"
 authors = ["Andre Borrmann <[email protected]>"]
-version = "0.4.2" # remember to update html_root_url
+version = "0.4.3" # remember to update html_root_url
 description = """
 Providing a simple and convinient way to implement interrupt handler for Raspberry Pi interrupts.
 """
@@ -12,7 +12,7 @@ readme = "../README.md"
 keywords = ["RusPiRo", "baremetal", "raspberrypi", "interrupt"]
 categories = ["no-std", "embedded"]
 edition = "2018"
-exclude = [".travis.yml", "Makefile.toml"]
+exclude = ["Makefile.toml"]
 links = "ruspiro_interrupt"
 
 [badges]
@@ -21,13 +21,12 @@ maintenance = { status = "actively-developed" }
 [lib]
 
 [dependencies]
-# get functions like memset, memcpy into the binary
 paste = "~1.0"
-futures-util = { version = "~0.3", default-features = false, optional = true }
-ruspiro-mmio-register = "~0.1"
+futures-util = { version = "~0.3.14", default-features = false, optional = true }
+ruspiro-mmio-register = "~0.1.2"
 ruspiro-interrupt-macros = { path = "../macros", version = "~0.3" }
-ruspiro-singleton = "~0.4"
-ruspiro-channel = "~0.1"
+ruspiro-singleton = "~0.4.2"
+ruspiro-channel = "~0.1.1"
 
 [features]
 ruspiro_pi3 = []

interrupt/Makefile.toml

@@ -30,10 +30,17 @@ env = { FEATURES = "ruspiro_pi3, async" }
 command = "cargo"
 args = ["doc", "--features", "${FEATURES}", "--open"]
 
-[tasks.pi3]
+[tasks.pi3_blocking]
+env = { FEATURES = "ruspiro_pi3" }
+run_task = "build"
+
+[tasks.pi3_async]
 env = { FEATURES = "ruspiro_pi3, async" }
 run_task = "build"
 
+[tasks.pi3]
+dependencies = ["pi3_blocking", "pi3_async"]
+
 [tasks.clean]
 command = "cargo"
 args = ["clean"]

interrupt/build.rs

@@ -5,5 +5,6 @@
  * License: Apache License 2.0
  **********************************************************************************************************************/
 
-// build script only required to be able to provide a linking name for this crate
+// build script only required to be able to provide a linking name for this crate which prevents from different versions
+// of the same crate to be allowed as dependency as this would break how this crate is linked into the final binary.
 fn main() {}

interrupt/examples/minimal/.cargo/aarch64-ruspiro.json

@@ -0,0 +1,34 @@
+{
+    "arch": "aarch64",
+    "data-layout": "e-m:e-i8:8:32-i16:16:32-i64:64-i128:128-n32:64-S128",
+    "executables": true,
+    "is-builtin": false,
+    "linker-flavor": "ld.lld",
+    "linker": "rust-lld",
+    "llvm-target": "aarch64-unknown-none",
+    "max-atomic-width": 128,
+    "os": "none",
+    "pre-link-args": {
+      "gcc": [
+        "-Wl,--as-needed",
+        "-Wl,-z,noexecstack"
+      ]
+    },
+    "target-c-int-width": "32",
+    "target-endian": "little",
+    "target-family": "unix",
+    "target-mcount": "\u0001_mcount",
+    "target-pointer-width": "64",
+    "unsupported-abis": [
+      "stdcall",
+      "fastcall",
+      "vectorcall",
+      "thiscall",
+      "win64",
+      "sysv64"
+    ],
+    "vendor": "unknown",
+    "panic-strategy": "abort",
+    "disable-redzone": true,
+    "features": ""
+  }

interrupt/examples/minimal/.cargo/config.toml

@@ -0,0 +1,5 @@
+[build]
+target = "aarch64-ruspiro.json"
+
+[unstable]
+build-std = ["core", "compiler_builtins", "alloc"]