coder137 · coder137 · Apr 9, 2023 · Apr 5, 2023 · Apr 6, 2023 · Apr 6, 2023
diff --git a/.github/workflows/rust_all.yml b/.github/workflows/rust_all.yml
@@ -75,3 +75,10 @@ jobs:
           cargo make ci_debug
           cargo make ci_release
           cargo doc
+
+      - name: Minimal Async Basic
+        working-directory: ${{github.workspace}}/minimal_async_basic
+        run: |
+          cargo make ci_debug
+          cargo make ci_release
+          cargo doc
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 Rust on microcontrollers
 
-# Projects
+# Base Projects
 
 - Minimal blinky
   - Barebones blinky example i.e linker script to main
@@ -25,15 +25,104 @@ Rust on microcontrollers
   - Added **heapless** library to `l2`
   - Added USART buffered traits to `l3`
 
+# Async Rust
+
+- Minimal Async Basic
+  - Forked from `Minimal Interrupt`
+  - Configure Interrupts and main loop with rust cooperative async/await
+  - No executor/waker implementation. Just basic polling functionality
+
 # Roadmap
 
-## Libraries
+## Supported Architecture
+
+- [x] ARM Cortex M4
+
+> TODO, Add more eventually
+
+## Supported Chips
+
+- [x] STM32L475xx
+- [ ] LPC4078xx
+
+## Supported Development platforms
 
-- [Bitflags](https://crates.io/crates/bitflags): Rust macros to generate bitflags
-- [Heapless](https://crates.io/crates/heapless): Stack allocated data structures
+**See CI/CD**
+
+- [x] Windows
+- [x] Linux
+- [x] Mac  
+
+## Async Rust
+
+- [x] Basic Async Rust 
+  - Polling support
+- [ ] Efficient Async Rust
+  - Waker support
+  - Interrupt support
 
 ## RTOS
 
+### C based
+
+- [ ] FreeRTOS
+- [ ] Zephyr RTOS
+
+### Rust based
+
+- [ ] RTIC
+
 ## Debugging
 
-## Tooling
+- [x] OpenOCD
+- [ ] Semihosting
+
+## Mocking 
+
+- [ ] Mockall
+
+## Buildsystem
+
+- [x] Cargo
+- [x] Cargo Make
+- [ ] Cargo features
+  - Conditional compiling for additional platforms 
+
+## Code coverage
+
+- [ ] Grcov
+  - Rust based code coverage 
+- [ ] Lcov
+  - Stable code coverage tool
+- [ ] Codecov
+  - Web based code coverage
+- [ ] Coveralls
+  - Web based code coverage
+
+## FFI compat with C
+
+- [x] Bindgen
+  - Use C in Rust 
+- [ ] CBindgen
+  - Use Rust in C 
+
+## Crates.io Libraries
+
+- [x] [Bitflags](https://crates.io/crates/bitflags)
+  - Rust macros to generate bitflags
+- [x] [Heapless](https://crates.io/crates/heapless)
+  - Stack allocated data structures
+
+## Rust integrated tooling
+
+- [x] Unit testing
+- [ ] Clippy
+  - Linting 
+- [x] Cargofmt
+  - Integrated in VSCode
+- [ ] Documentation 
+
+## External tooling
+
+- [x] Continuous Integration
+  - [x] Github Actions
diff --git a/minimal_async_basic/.cargo/config.toml b/minimal_async_basic/.cargo/config.toml
@@ -0,0 +1,43 @@
+[target.thumbv7em-none-eabihf]
+# uncomment this to make `cargo run` execute programs on QEMU
+# runner = "qemu-system-arm -cpu cortex-m3 -machine lm3s6965evb -nographic -semihosting-config enable=on,target=native -kernel"
+
+[target.'cfg(all(target_arch = "arm", target_os = "none"))']
+# uncomment ONE of these three option to make `cargo run` start a GDB session
+# which option to pick depends on your system
+# runner = "arm-none-eabi-gdb -q -x openocd.gdb"
+# runner = "gdb-multiarch -q -x openocd.gdb"
+# runner = "gdb -q -x openocd.gdb"
+rustflags = [
+  # This is needed if your flash or ram addresses are not aligned to 0x10000 in memory.x
+  # See https://github.com/rust-embedded/cortex-m-quickstart/pull/95
+  # "-C", "link-arg=--nmagic",
+
+  # LLD (shipped with the Rust toolchain) is used as the default linker
+  # "-C", "link-arg=-Tgcc_arm.ld",
+
+  # Generate a .map file
+  # "-C", "link-args=-Map=application.map",
+
+  # if you run into problems with LLD switch to the GNU linker by commenting out
+  # this line
+  "-C", "linker=arm-none-eabi-ld",
+
+  # if you need to link to pre-compiled C libraries provided by a C toolchain
+  # use GCC as the linker by commenting out both lines above and then
+  # uncommenting the three lines below
+  "-C", "linker=arm-none-eabi-gcc",
+  "-C", "link-arg=-Wl,-Tgcc_arm.ld",
+  "-C", "link-arg=-Wl,-Map,application.map",
+  "-C", "link-arg=-nostartfiles",
+]
+
+[build]
+# Pick ONE of these compilation targets
+# target = "thumbv6m-none-eabi"        # Cortex-M0 and Cortex-M0+
+# target = "thumbv7m-none-eabi"        # Cortex-M3
+# target = "thumbv7em-none-eabi"       # Cortex-M4 and Cortex-M7 (no FPU)
+target = "thumbv7em-none-eabihf"     # Cortex-M4F and Cortex-M7F (with FPU)
+# target = "thumbv8m.base-none-eabi"   # Cortex-M23
+# target = "thumbv8m.main-none-eabi"   # Cortex-M33 (no FPU)
+# target = "thumbv8m.main-none-eabihf" # Cortex-M33 (with FPU)
diff --git a/minimal_async_basic/.gitignore b/minimal_async_basic/.gitignore
@@ -0,0 +1,6 @@
+# Files
+*.map
+.vscode/.cortex-debug.*
+
+# Folders
+target
diff --git a/minimal_async_basic/.vscode/launch.json b/minimal_async_basic/.vscode/launch.json
@@ -0,0 +1,36 @@
+{
+  "configurations": [
+    {
+      "cwd": "${workspaceFolder}",
+      "executable": "target/thumbv7em-none-eabihf/debug/application",
+      "configFiles": [
+        "stm32l4discovery.cfg"
+      ],
+      "postLaunchCommands": [
+        "load",
+        "monitor arm semihosting enable",
+      ],
+      "name": "Rust Debug",
+      "request": "launch",
+      "type": "cortex-debug",
+      "servertype": "openocd",
+      "svdFile": "l0/svd/STM32L4x5.svd",
+      "svdPath": "l0/svd/STM32L4x5.svd"
+    },
+    {
+      "cwd": "${workspaceFolder}",
+      "executable": "target/thumbv7em-none-eabihf/release/application",
+      "configFiles": [
+        "stm32l4discovery.cfg"
+      ],
+      "postLaunchCommands": [
+        "load",
+        "monitor arm semihosting enable",
+      ],
+      "name": "Rust Release",
+      "request": "launch",
+      "type": "cortex-debug",
+      "servertype": "openocd"
+    }
+  ]
+}
diff --git a/minimal_async_basic/.vscode/settings.json b/minimal_async_basic/.vscode/settings.json
@@ -0,0 +1,12 @@
+{
+    "rust-analyzer.cargo.target": "thumbv7em-none-eabihf",
+    "rust-analyzer.check.allTargets": false,
+    "rust-analyzer.imports.prefer.no.std": true,
+    "rust-analyzer.cargo.unsetTest": [
+        "core",
+        "l0",
+        "l3",
+        "l5",
+        "application",
+    ],
+}
diff --git a/minimal_async_basic/Cargo.toml b/minimal_async_basic/Cargo.toml
@@ -0,0 +1,7 @@
+[workspace]
+members = [
+    "l0",
+    "l3",
+    "l4",
+    "l5"
+]
diff --git a/minimal_async_basic/Makefile.toml b/minimal_async_basic/Makefile.toml
@@ -0,0 +1,94 @@
+[config]
+default_to_workspace = false
+
+# Duckscript is used here to convert \ to / for binary output path
+[tasks.build_debug]
+script_runner = "@duckscript"
+script = '''
+output = set ${CARGO_MAKE_CRATE_CUSTOM_TRIPLE_TARGET_DIRECTORY}/debug/application
+echo OUTPUT: ${output}
+output = replace ${output} \\ /
+set_env OUTPUT ${output}
+exec cargo build
+'''
+
+# Duckscript is used here to convert \ to / for binary output path
+[tasks.build_release]
+script_runner = "@duckscript"
+script = '''
+output = set ${CARGO_MAKE_CRATE_CUSTOM_TRIPLE_TARGET_DIRECTORY}/release/application
+output = replace ${output} \\ /
+set_env OUTPUT ${output}
+exec cargo build --release
+'''
+
+[tasks.test]
+command = "cargo"
+args = ["test", "--target", "${CARGO_MAKE_RUST_TARGET_TRIPLE}"]
+
+[tasks.flash_debug]
+script_runner = "@shell"
+script = '''
+openocd -f board/stm32l4discovery.cfg -c "program ${OUTPUT} verify reset exit"
+'''
+dependencies = ["build_debug"]
+
+[tasks.flash_release]
+script_runner = "@shell"
+script = '''
+openocd -f board/stm32l4discovery.cfg -c "program ${OUTPUT} verify reset exit"
+'''
+dependencies = ["build_release"]
+
+[tasks.ci_debug]
+dependencies = [
+    "build_debug",
+    "test",
+    "objcopy_to_binary",
+    "objcopy_to_hex",
+    "objdump",
+    "size",
+]
+
+[tasks.ci_release]
+dependencies = [
+    "build_release",
+    "test",
+    "objcopy_to_binary",
+    "objcopy_to_hex",
+    "objdump",
+    "size",
+]
+
+# Private Tasks
+
+# Requires 
+# arm-none-eabi-size executable (ARM GCC toolchain)
+# OUTPUT env variable (Set by build_*)
+[tasks.size]
+private = true
+command = "arm-none-eabi-size"
+args = ["${OUTPUT}"]
+
+# arm-none-eabi-objcopy executable (ARM GCC toolchain)
+# OUTPUT env variable (Set by build_*)
+[tasks.objcopy_to_binary]
+private = true
+command = "arm-none-eabi-objcopy"
+args = ["-O", "binary", "${OUTPUT}", "${OUTPUT}.bin"]
+
+# arm-none-eabi-objcopy executable (ARM GCC toolchain)
+# OUTPUT env variable (Set by build_*)
+[tasks.objcopy_to_hex]
+private = true
+command = "arm-none-eabi-objcopy"
+args = ["-O", "ihex", "${OUTPUT}", "${OUTPUT}.hex"]
+
+# arm-none-eabi-objdump executable (ARM GCC toolchain)
+# OUTPUT env variable (Set by build_*)
+[tasks.objdump]
+private = true
+script_runner = "@shell"
+script = '''
+arm-none-eabi-objdump --source --all-headers --demangle --line-numbers --wide ${OUTPUT} > ${OUTPUT}.lst
+'''