From 3119aeec5cc05f78a6551ae845f2dbc659bb631a Mon Sep 17 00:00:00 2001 From: Ulf Lilleengen Date: Thu, 11 Jan 2024 19:19:16 +0100 Subject: [PATCH 1/8] add nrf9160 example (assumes SPM from zephyr) --- examples/nrf9160/.cargo/config.toml | 9 +++++++ examples/nrf9160/Cargo.toml | 40 +++++++++++++++++++++++++++++ examples/nrf9160/build.rs | 35 +++++++++++++++++++++++++ examples/nrf9160/memory.x | 7 +++++ examples/nrf9160/src/bin/blinky.rs | 20 +++++++++++++++ 5 files changed, 111 insertions(+) create mode 100644 examples/nrf9160/.cargo/config.toml create mode 100644 examples/nrf9160/Cargo.toml create mode 100644 examples/nrf9160/build.rs create mode 100644 examples/nrf9160/memory.x create mode 100644 examples/nrf9160/src/bin/blinky.rs diff --git a/examples/nrf9160/.cargo/config.toml b/examples/nrf9160/.cargo/config.toml new file mode 100644 index 000000000..1444b0cd1 --- /dev/null +++ b/examples/nrf9160/.cargo/config.toml @@ -0,0 +1,9 @@ +[target.'cfg(all(target_arch = "arm", target_os = "none"))'] +# replace nRF82840_xxAA with your chip as listed in `probe-rs chip list` +runner = "probe-rs run --chip nRF9160_xxAA" + +[build] +target = "thumbv8m.main-none-eabihf" + +[env] +DEFMT_LOG = "trace" diff --git a/examples/nrf9160/Cargo.toml b/examples/nrf9160/Cargo.toml new file mode 100644 index 000000000..b35b7778d --- /dev/null +++ b/examples/nrf9160/Cargo.toml @@ -0,0 +1,40 @@ +[package] +edition = "2021" +name = "embassy-nrf9160-examples" +version = "0.1.0" +license = "MIT OR Apache-2.0" + +[dependencies] +embassy-futures = { version = "0.1.0", path = "../../embassy-futures" } +embassy-sync = { version = "0.5.0", path = "../../embassy-sync", features = ["defmt"] } +embassy-executor = { version = "0.4.0", path = "../../embassy-executor", features = ["task-arena-size-32768", "arch-cortex-m", "executor-thread", "executor-interrupt", "defmt", "integrated-timers"] } +embassy-time = { version = "0.2", path = "../../embassy-time", features = ["defmt", "defmt-timestamp-uptime"] } +embassy-nrf = { version = "0.1.0", path = "../../embassy-nrf", features = ["defmt", "nrf9160-ns", "time-driver-rtc1", "gpiote", "unstable-pac", "time"] } +embassy-net = { version = "0.3", path = "../../embassy-net", features = ["defmt", "tcp", "dhcpv4", "medium-ethernet"] } +embassy-usb = { version = "0.1.0", path = "../../embassy-usb", features = ["defmt"] } +embedded-io = { version = "0.6.0", features = ["defmt-03"] } +embedded-io-async = { version = "0.6.1", features = ["defmt-03"] } +embassy-net-esp-hosted = { version = "0.1.0", path = "../../embassy-net-esp-hosted", features = ["defmt"] } +embassy-net-enc28j60 = { version = "0.1.0", path = "../../embassy-net-enc28j60", features = ["defmt"] } + +defmt = "0.3" +defmt-rtt = "0.4" + +fixed = "1.10.0" +static_cell = { version = "2" } +cortex-m = { version = "0.7.6", features = ["inline-asm", "critical-section-single-core"] } +cortex-m-rt = "0.7.0" +panic-probe = { version = "0.3", features = ["print-defmt"] } +futures = { version = "0.3.17", default-features = false, features = ["async-await"] } +rand = { version = "0.8.4", default-features = false } +embedded-storage = "0.3.1" +usbd-hid = "0.6.0" +serde = { version = "1.0.136", default-features = false } +embedded-hal = { version = "1.0" } +embedded-hal-async = { version = "1.0" } +embedded-hal-bus = { version = "0.1", features = ["async"] } +num-integer = { version = "0.1.45", default-features = false } +microfft = "0.5.0" + +[profile.release] +debug = 2 diff --git a/examples/nrf9160/build.rs b/examples/nrf9160/build.rs new file mode 100644 index 000000000..30691aa97 --- /dev/null +++ b/examples/nrf9160/build.rs @@ -0,0 +1,35 @@ +//! This build script copies the `memory.x` file from the crate root into +//! a directory where the linker can always find it at build time. +//! For many projects this is optional, as the linker always searches the +//! project root directory -- wherever `Cargo.toml` is. However, if you +//! are using a workspace or have a more complicated build setup, this +//! build script becomes required. Additionally, by requesting that +//! Cargo re-run the build script whenever `memory.x` is changed, +//! updating `memory.x` ensures a rebuild of the application with the +//! new memory settings. + +use std::env; +use std::fs::File; +use std::io::Write; +use std::path::PathBuf; + +fn main() { + // Put `memory.x` in our output directory and ensure it's + // on the linker search path. + let out = &PathBuf::from(env::var_os("OUT_DIR").unwrap()); + File::create(out.join("memory.x")) + .unwrap() + .write_all(include_bytes!("memory.x")) + .unwrap(); + println!("cargo:rustc-link-search={}", out.display()); + + // By default, Cargo will re-run a build script whenever + // any file in the project changes. By specifying `memory.x` + // here, we ensure the build script is only re-run when + // `memory.x` is changed. + println!("cargo:rerun-if-changed=memory.x"); + + println!("cargo:rustc-link-arg-bins=--nmagic"); + println!("cargo:rustc-link-arg-bins=-Tlink.x"); + println!("cargo:rustc-link-arg-bins=-Tdefmt.x"); +} diff --git a/examples/nrf9160/memory.x b/examples/nrf9160/memory.x new file mode 100644 index 000000000..4d1d77c00 --- /dev/null +++ b/examples/nrf9160/memory.x @@ -0,0 +1,7 @@ +MEMORY +{ + /* Assumes Secure Partition Manager (SPM) flashed at the start */ + SPM : ORIGIN = 0x00000000, LENGTH = 320K + FLASH : ORIGIN = 0x00050000, LENGTH = 704K + RAM : ORIGIN = 0x20018000, LENGTH = 160K +} diff --git a/examples/nrf9160/src/bin/blinky.rs b/examples/nrf9160/src/bin/blinky.rs new file mode 100644 index 000000000..7ac5c31e1 --- /dev/null +++ b/examples/nrf9160/src/bin/blinky.rs @@ -0,0 +1,20 @@ +#![no_std] +#![no_main] + +use embassy_executor::Spawner; +use embassy_nrf::gpio::{Level, Output, OutputDrive}; +use embassy_time::Timer; +use {defmt_rtt as _, panic_probe as _}; + +#[embassy_executor::main] +async fn main(_spawner: Spawner) { + let p = embassy_nrf::init(Default::default()); + let mut led = Output::new(p.P0_02, Level::Low, OutputDrive::Standard); + + loop { + led.set_high(); + Timer::after_millis(300).await; + led.set_low(); + Timer::after_millis(300).await; + } +} From f9e274e0574c58b0132612eb5aae81ea51a4b931 Mon Sep 17 00:00:00 2001 From: Ulf Lilleengen Date: Thu, 11 Jan 2024 19:21:33 +0100 Subject: [PATCH 2/8] docs: more docs on nrf --- embassy-nrf/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/embassy-nrf/README.md b/embassy-nrf/README.md index 39de3854b..18cb21f46 100644 --- a/embassy-nrf/README.md +++ b/embassy-nrf/README.md @@ -8,6 +8,20 @@ complete operations in low power mod and handling interrupts, so that applicatio NOTE: The Embassy HALs can be used both for non-async and async operations. For async, you can choose which runtime you want to use. +## Hardware support + +The `embassy-nrf` HAL supports most variants of the nRF family: + +* nRF52 ([examples](https://github.com/embassy-rs/embassy/tree/main/examples/nrf52840)) +* nRF53 ([examples](https://github.com/embassy-rs/embassy/tree/main/examples/nrf5340)) +* nRF91 ([examples](https://github.com/embassy-rs/embassy/tree/main/examples/nrf9160)) + +Most peripherals are supported. For a complete list of available peripherals and features, see the [documentation](https://docs.embassy.dev/embassy-nrf/git/nrf52805/index.html). + +## API + +The `embassy-nrf` HAL implements the traits from [embedded-hal](https://crates.io/crates/embedded-hal) (v0.2 and 1.0) and [embedded-hal-async](https://crates.io/crates/embedded-hal-async), as well as [embedded-io](https://crates.io/crates/embedded-io) and [embedded-io-async](https://crates.io/crates/embedded-io-async). + ## EasyDMA considerations On nRF chips, peripherals can use the so called EasyDMA feature to offload the task of interacting From 46602903f5defa77c1bdc07afe4a57dbb9d51904 Mon Sep 17 00:00:00 2001 From: Ulf Lilleengen Date: Thu, 11 Jan 2024 19:26:49 +0100 Subject: [PATCH 3/8] note on timer --- embassy-nrf/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/embassy-nrf/README.md b/embassy-nrf/README.md index 18cb21f46..ae5256a2a 100644 --- a/embassy-nrf/README.md +++ b/embassy-nrf/README.md @@ -16,7 +16,9 @@ The `embassy-nrf` HAL supports most variants of the nRF family: * nRF53 ([examples](https://github.com/embassy-rs/embassy/tree/main/examples/nrf5340)) * nRF91 ([examples](https://github.com/embassy-rs/embassy/tree/main/examples/nrf9160)) -Most peripherals are supported. For a complete list of available peripherals and features, see the [documentation](https://docs.embassy.dev/embassy-nrf/git/nrf52805/index.html). +Most peripherals are supported. If the `time` feature is enabled, the HAL uses the RTC peripheral as a global time driver for [embassy-time](https://crates.io/crates/embassy-time), with a tick rate of 32768 Hz. + +For a complete list of available peripherals and features, see the [documentation](https://docs.embassy.dev/embassy-nrf/git/nrf52805/index.html). ## API From 9a269803bdaa29c9b36fd70d6651b4f2ea10b220 Mon Sep 17 00:00:00 2001 From: Ulf Lilleengen Date: Thu, 11 Jan 2024 20:32:07 +0100 Subject: [PATCH 4/8] restructure --- embassy-nrf/README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/embassy-nrf/README.md b/embassy-nrf/README.md index ae5256a2a..59fb4f1bf 100644 --- a/embassy-nrf/README.md +++ b/embassy-nrf/README.md @@ -8,6 +8,8 @@ complete operations in low power mod and handling interrupts, so that applicatio NOTE: The Embassy HALs can be used both for non-async and async operations. For async, you can choose which runtime you want to use. +For a complete list of available peripherals and features, see the [embassy-nrf documentation](https://docs.embassy.dev/embassy-nrf). + ## Hardware support The `embassy-nrf` HAL supports most variants of the nRF family: @@ -16,9 +18,11 @@ The `embassy-nrf` HAL supports most variants of the nRF family: * nRF53 ([examples](https://github.com/embassy-rs/embassy/tree/main/examples/nrf5340)) * nRF91 ([examples](https://github.com/embassy-rs/embassy/tree/main/examples/nrf9160)) -Most peripherals are supported. If the `time` feature is enabled, the HAL uses the RTC peripheral as a global time driver for [embassy-time](https://crates.io/crates/embassy-time), with a tick rate of 32768 Hz. +Most peripherals are supported. -For a complete list of available peripherals and features, see the [documentation](https://docs.embassy.dev/embassy-nrf/git/nrf52805/index.html). +## Time driver + +If the `time` feature is enabled, the HAL uses the RTC peripheral as a global time driver for [embassy-time](https://crates.io/crates/embassy-time), with a tick rate of 32768 Hz. ## API From b161dd4b11d5aab145950e6ce41eae4d4378d25b Mon Sep 17 00:00:00 2001 From: Ulf Lilleengen Date: Thu, 11 Jan 2024 20:33:27 +0100 Subject: [PATCH 5/8] use secure mode --- examples/nrf9160/Cargo.toml | 2 +- examples/nrf9160/memory.x | 4 +--- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/examples/nrf9160/Cargo.toml b/examples/nrf9160/Cargo.toml index b35b7778d..b6ee40a37 100644 --- a/examples/nrf9160/Cargo.toml +++ b/examples/nrf9160/Cargo.toml @@ -9,7 +9,7 @@ embassy-futures = { version = "0.1.0", path = "../../embassy-futures" } embassy-sync = { version = "0.5.0", path = "../../embassy-sync", features = ["defmt"] } embassy-executor = { version = "0.4.0", path = "../../embassy-executor", features = ["task-arena-size-32768", "arch-cortex-m", "executor-thread", "executor-interrupt", "defmt", "integrated-timers"] } embassy-time = { version = "0.2", path = "../../embassy-time", features = ["defmt", "defmt-timestamp-uptime"] } -embassy-nrf = { version = "0.1.0", path = "../../embassy-nrf", features = ["defmt", "nrf9160-ns", "time-driver-rtc1", "gpiote", "unstable-pac", "time"] } +embassy-nrf = { version = "0.1.0", path = "../../embassy-nrf", features = ["defmt", "nrf9160-s", "time-driver-rtc1", "gpiote", "unstable-pac", "time"] } embassy-net = { version = "0.3", path = "../../embassy-net", features = ["defmt", "tcp", "dhcpv4", "medium-ethernet"] } embassy-usb = { version = "0.1.0", path = "../../embassy-usb", features = ["defmt"] } embedded-io = { version = "0.6.0", features = ["defmt-03"] } diff --git a/examples/nrf9160/memory.x b/examples/nrf9160/memory.x index 4d1d77c00..4c7d4ebf0 100644 --- a/examples/nrf9160/memory.x +++ b/examples/nrf9160/memory.x @@ -1,7 +1,5 @@ MEMORY { - /* Assumes Secure Partition Manager (SPM) flashed at the start */ - SPM : ORIGIN = 0x00000000, LENGTH = 320K - FLASH : ORIGIN = 0x00050000, LENGTH = 704K + FLASH : ORIGIN = 0x00000000, LENGTH = 1024K RAM : ORIGIN = 0x20018000, LENGTH = 160K } From 4cc2648547491b13d3705b3869274d0f274a0721 Mon Sep 17 00:00:00 2001 From: Ulf Lilleengen Date: Thu, 11 Jan 2024 20:34:30 +0100 Subject: [PATCH 6/8] change title --- embassy-nrf/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/embassy-nrf/README.md b/embassy-nrf/README.md index 59fb4f1bf..87147fab4 100644 --- a/embassy-nrf/README.md +++ b/embassy-nrf/README.md @@ -24,7 +24,7 @@ Most peripherals are supported. If the `time` feature is enabled, the HAL uses the RTC peripheral as a global time driver for [embassy-time](https://crates.io/crates/embassy-time), with a tick rate of 32768 Hz. -## API +## Embedded-hal The `embassy-nrf` HAL implements the traits from [embedded-hal](https://crates.io/crates/embedded-hal) (v0.2 and 1.0) and [embedded-hal-async](https://crates.io/crates/embedded-hal-async), as well as [embedded-io](https://crates.io/crates/embedded-io) and [embedded-io-async](https://crates.io/crates/embedded-io-async). From 510b1ce4811f4d620a63148f9fa0fa6f96791b7b Mon Sep 17 00:00:00 2001 From: Ulf Lilleengen Date: Thu, 11 Jan 2024 20:36:43 +0100 Subject: [PATCH 7/8] add nrf9160 example to CI --- ci.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/ci.sh b/ci.sh index ac0457679..6605d7fc4 100755 --- a/ci.sh +++ b/ci.sh @@ -147,6 +147,7 @@ cargo batch \ --- build --release --manifest-path docs/modules/ROOT/examples/layer-by-layer/blinky-async/Cargo.toml --target thumbv7em-none-eabi \ --- build --release --manifest-path examples/nrf52840/Cargo.toml --target thumbv7em-none-eabi --out-dir out/examples/nrf52840 \ --- build --release --manifest-path examples/nrf5340/Cargo.toml --target thumbv8m.main-none-eabihf --out-dir out/examples/nrf5340 \ + --- build --release --manifest-path examples/nrf9160/Cargo.toml --target thumbv8m.main-none-eabihf --out-dir out/examples/nrf9160 \ --- build --release --manifest-path examples/rp/Cargo.toml --target thumbv6m-none-eabi --out-dir out/examples/rp \ --- build --release --manifest-path examples/stm32f0/Cargo.toml --target thumbv6m-none-eabi --out-dir out/examples/stm32f0 \ --- build --release --manifest-path examples/stm32f1/Cargo.toml --target thumbv7m-none-eabi --out-dir out/examples/stm32f1 \ From 10b857250c6de54ccab568d1f139e856773ef113 Mon Sep 17 00:00:00 2001 From: Ulf Lilleengen Date: Thu, 11 Jan 2024 20:45:45 +0100 Subject: [PATCH 8/8] trim nrf9160 example deps --- examples/nrf9160/Cargo.toml | 20 -------------------- 1 file changed, 20 deletions(-) diff --git a/examples/nrf9160/Cargo.toml b/examples/nrf9160/Cargo.toml index b6ee40a37..107b294d5 100644 --- a/examples/nrf9160/Cargo.toml +++ b/examples/nrf9160/Cargo.toml @@ -5,36 +5,16 @@ version = "0.1.0" license = "MIT OR Apache-2.0" [dependencies] -embassy-futures = { version = "0.1.0", path = "../../embassy-futures" } -embassy-sync = { version = "0.5.0", path = "../../embassy-sync", features = ["defmt"] } embassy-executor = { version = "0.4.0", path = "../../embassy-executor", features = ["task-arena-size-32768", "arch-cortex-m", "executor-thread", "executor-interrupt", "defmt", "integrated-timers"] } embassy-time = { version = "0.2", path = "../../embassy-time", features = ["defmt", "defmt-timestamp-uptime"] } embassy-nrf = { version = "0.1.0", path = "../../embassy-nrf", features = ["defmt", "nrf9160-s", "time-driver-rtc1", "gpiote", "unstable-pac", "time"] } -embassy-net = { version = "0.3", path = "../../embassy-net", features = ["defmt", "tcp", "dhcpv4", "medium-ethernet"] } -embassy-usb = { version = "0.1.0", path = "../../embassy-usb", features = ["defmt"] } -embedded-io = { version = "0.6.0", features = ["defmt-03"] } -embedded-io-async = { version = "0.6.1", features = ["defmt-03"] } -embassy-net-esp-hosted = { version = "0.1.0", path = "../../embassy-net-esp-hosted", features = ["defmt"] } -embassy-net-enc28j60 = { version = "0.1.0", path = "../../embassy-net-enc28j60", features = ["defmt"] } defmt = "0.3" defmt-rtt = "0.4" -fixed = "1.10.0" -static_cell = { version = "2" } cortex-m = { version = "0.7.6", features = ["inline-asm", "critical-section-single-core"] } cortex-m-rt = "0.7.0" panic-probe = { version = "0.3", features = ["print-defmt"] } -futures = { version = "0.3.17", default-features = false, features = ["async-await"] } -rand = { version = "0.8.4", default-features = false } -embedded-storage = "0.3.1" -usbd-hid = "0.6.0" -serde = { version = "1.0.136", default-features = false } -embedded-hal = { version = "1.0" } -embedded-hal-async = { version = "1.0" } -embedded-hal-bus = { version = "0.1", features = ["async"] } -num-integer = { version = "0.1.45", default-features = false } -microfft = "0.5.0" [profile.release] debug = 2