From 739e5861c2e47db251725163fcd91cd822cf97b7 Mon Sep 17 00:00:00 2001 From: Ulf Lilleengen Date: Sat, 18 May 2024 10:17:03 +0200 Subject: convert from antora to asciidoctor --- .../modules/ROOT/examples/basic/.cargo/config.toml | 9 --- docs/modules/ROOT/examples/basic/Cargo.toml | 18 ----- docs/modules/ROOT/examples/basic/build.rs | 35 -------- docs/modules/ROOT/examples/basic/memory.x | 7 -- docs/modules/ROOT/examples/basic/src/main.rs | 26 ------ docs/modules/ROOT/examples/examples | 1 - .../examples/layer-by-layer/.cargo/config.toml | 14 ---- .../ROOT/examples/layer-by-layer/Cargo.toml | 21 ----- .../layer-by-layer/blinky-async/Cargo.toml | 15 ---- .../layer-by-layer/blinky-async/src/main.rs | 23 ------ .../examples/layer-by-layer/blinky-hal/Cargo.toml | 14 ---- .../examples/layer-by-layer/blinky-hal/src/main.rs | 21 ----- .../examples/layer-by-layer/blinky-irq/Cargo.toml | 14 ---- .../examples/layer-by-layer/blinky-irq/src/main.rs | 93 ---------------------- .../examples/layer-by-layer/blinky-pac/Cargo.toml | 14 ---- .../examples/layer-by-layer/blinky-pac/src/main.rs | 53 ------------ 16 files changed, 378 deletions(-) delete mode 100644 docs/modules/ROOT/examples/basic/.cargo/config.toml delete mode 100644 docs/modules/ROOT/examples/basic/Cargo.toml delete mode 100644 docs/modules/ROOT/examples/basic/build.rs delete mode 100644 docs/modules/ROOT/examples/basic/memory.x delete mode 100644 docs/modules/ROOT/examples/basic/src/main.rs delete mode 120000 docs/modules/ROOT/examples/examples delete mode 100644 docs/modules/ROOT/examples/layer-by-layer/.cargo/config.toml delete mode 100644 docs/modules/ROOT/examples/layer-by-layer/Cargo.toml delete mode 100644 docs/modules/ROOT/examples/layer-by-layer/blinky-async/Cargo.toml delete mode 100644 docs/modules/ROOT/examples/layer-by-layer/blinky-async/src/main.rs delete mode 100644 docs/modules/ROOT/examples/layer-by-layer/blinky-hal/Cargo.toml delete mode 100644 docs/modules/ROOT/examples/layer-by-layer/blinky-hal/src/main.rs delete mode 100644 docs/modules/ROOT/examples/layer-by-layer/blinky-irq/Cargo.toml delete mode 100644 docs/modules/ROOT/examples/layer-by-layer/blinky-irq/src/main.rs delete mode 100644 docs/modules/ROOT/examples/layer-by-layer/blinky-pac/Cargo.toml delete mode 100644 docs/modules/ROOT/examples/layer-by-layer/blinky-pac/src/main.rs (limited to 'docs/modules/ROOT/examples') diff --git a/docs/modules/ROOT/examples/basic/.cargo/config.toml b/docs/modules/ROOT/examples/basic/.cargo/config.toml deleted file mode 100644 index 8ca28df39..000000000 --- a/docs/modules/ROOT/examples/basic/.cargo/config.toml +++ /dev/null @@ -1,9 +0,0 @@ -[target.'cfg(all(target_arch = "arm", target_os = "none"))'] -# replace nRF82840_xxAA with your chip as listed in `probe-run --list-chips` -runner = "probe-run --chip nRF52840_xxAA" - -[build] -target = "thumbv7em-none-eabi" - -[env] -DEFMT_LOG = "trace" diff --git a/docs/modules/ROOT/examples/basic/Cargo.toml b/docs/modules/ROOT/examples/basic/Cargo.toml deleted file mode 100644 index 2c282145d..000000000 --- a/docs/modules/ROOT/examples/basic/Cargo.toml +++ /dev/null @@ -1,18 +0,0 @@ -[package] -authors = ["Dario Nieuwenhuis "] -edition = "2018" -name = "embassy-basic-example" -version = "0.1.0" -license = "MIT OR Apache-2.0" - -[dependencies] -embassy-executor = { version = "0.5.0", path = "../../../../../embassy-executor", features = ["defmt", "integrated-timers", "arch-cortex-m", "executor-thread"] } -embassy-time = { version = "0.3.0", path = "../../../../../embassy-time", features = ["defmt"] } -embassy-nrf = { version = "0.1.0", path = "../../../../../embassy-nrf", features = ["defmt", "nrf52840", "time-driver-rtc1", "gpiote"] } - -defmt = "0.3" -defmt-rtt = "0.3" - -cortex-m = { version = "0.7.6", features = ["critical-section-single-core"] } -cortex-m-rt = "0.7.0" -panic-probe = { version = "0.3", features = ["print-defmt"] } diff --git a/docs/modules/ROOT/examples/basic/build.rs b/docs/modules/ROOT/examples/basic/build.rs deleted file mode 100644 index 30691aa97..000000000 --- a/docs/modules/ROOT/examples/basic/build.rs +++ /dev/null @@ -1,35 +0,0 @@ -//! 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/docs/modules/ROOT/examples/basic/memory.x b/docs/modules/ROOT/examples/basic/memory.x deleted file mode 100644 index 9b04edec0..000000000 --- a/docs/modules/ROOT/examples/basic/memory.x +++ /dev/null @@ -1,7 +0,0 @@ -MEMORY -{ - /* NOTE 1 K = 1 KiBi = 1024 bytes */ - /* These values correspond to the NRF52840 with Softdevices S140 7.0.1 */ - FLASH : ORIGIN = 0x00000000, LENGTH = 1024K - RAM : ORIGIN = 0x20000000, LENGTH = 256K -} diff --git a/docs/modules/ROOT/examples/basic/src/main.rs b/docs/modules/ROOT/examples/basic/src/main.rs deleted file mode 100644 index 4412712c8..000000000 --- a/docs/modules/ROOT/examples/basic/src/main.rs +++ /dev/null @@ -1,26 +0,0 @@ -#![no_std] -#![no_main] - -use defmt::*; -use embassy_executor::Spawner; -use embassy_nrf::gpio::{Level, Output, OutputDrive}; -use embassy_time::{Duration, Timer}; -use {defmt_rtt as _, panic_probe as _}; // global logger - -#[embassy_executor::task] -async fn blinker(mut led: Output<'static>, interval: Duration) { - loop { - led.set_high(); - Timer::after(interval).await; - led.set_low(); - Timer::after(interval).await; - } -} - -#[embassy_executor::main] -async fn main(spawner: Spawner) { - let p = embassy_nrf::init(Default::default()); - - let led = Output::new(p.P0_13, Level::Low, OutputDrive::Standard); - unwrap!(spawner.spawn(blinker(led, Duration::from_millis(300)))); -} diff --git a/docs/modules/ROOT/examples/examples b/docs/modules/ROOT/examples/examples deleted file mode 120000 index 1929330b0..000000000 --- a/docs/modules/ROOT/examples/examples +++ /dev/null @@ -1 +0,0 @@ -../../../../examples \ No newline at end of file diff --git a/docs/modules/ROOT/examples/layer-by-layer/.cargo/config.toml b/docs/modules/ROOT/examples/layer-by-layer/.cargo/config.toml deleted file mode 100644 index 3012f05dc..000000000 --- a/docs/modules/ROOT/examples/layer-by-layer/.cargo/config.toml +++ /dev/null @@ -1,14 +0,0 @@ -[target.'cfg(all(target_arch = "arm", target_os = "none"))'] -runner = "probe-run --chip STM32L475VG" - -rustflags = [ - "-C", "link-arg=--nmagic", - "-C", "link-arg=-Tlink.x", - "-C", "link-arg=-Tdefmt.x", -] - -[build] -target = "thumbv7em-none-eabihf" - -[env] -DEFMT_LOG = "trace" diff --git a/docs/modules/ROOT/examples/layer-by-layer/Cargo.toml b/docs/modules/ROOT/examples/layer-by-layer/Cargo.toml deleted file mode 100644 index 943249a17..000000000 --- a/docs/modules/ROOT/examples/layer-by-layer/Cargo.toml +++ /dev/null @@ -1,21 +0,0 @@ -[workspace] -resolver = "2" -members = [ - "blinky-pac", - "blinky-hal", - "blinky-irq", - "blinky-async", -] - -[patch.crates-io] -embassy-executor = { path = "../../../../../embassy-executor" } -embassy-stm32 = { path = "../../../../../embassy-stm32" } - -[profile.release] -codegen-units = 1 -debug = 2 -debug-assertions = false -incremental = false -lto = "fat" -opt-level = 's' -overflow-checks = false diff --git a/docs/modules/ROOT/examples/layer-by-layer/blinky-async/Cargo.toml b/docs/modules/ROOT/examples/layer-by-layer/blinky-async/Cargo.toml deleted file mode 100644 index 64f7e8403..000000000 --- a/docs/modules/ROOT/examples/layer-by-layer/blinky-async/Cargo.toml +++ /dev/null @@ -1,15 +0,0 @@ -[package] -name = "blinky-async" -version = "0.1.0" -edition = "2021" -license = "MIT OR Apache-2.0" - -[dependencies] -cortex-m = "0.7" -cortex-m-rt = "0.7" -embassy-stm32 = { version = "0.1.0", features = ["stm32l475vg", "memory-x", "exti"] } -embassy-executor = { version = "0.5.0", features = ["arch-cortex-m", "executor-thread"] } - -defmt = "0.3.0" -defmt-rtt = "0.3.0" -panic-probe = { version = "0.3.0", features = ["print-defmt"] } diff --git a/docs/modules/ROOT/examples/layer-by-layer/blinky-async/src/main.rs b/docs/modules/ROOT/examples/layer-by-layer/blinky-async/src/main.rs deleted file mode 100644 index 004602816..000000000 --- a/docs/modules/ROOT/examples/layer-by-layer/blinky-async/src/main.rs +++ /dev/null @@ -1,23 +0,0 @@ -#![no_std] -#![no_main] - -use embassy_executor::Spawner; -use embassy_stm32::exti::ExtiInput; -use embassy_stm32::gpio::{Level, Output, Pull, Speed}; -use {defmt_rtt as _, panic_probe as _}; - -#[embassy_executor::main] -async fn main(_spawner: Spawner) { - let p = embassy_stm32::init(Default::default()); - let mut led = Output::new(p.PB14, Level::Low, Speed::VeryHigh); - let mut button = ExtiInput::new(p.PC13, p.EXTI13, Pull::Up); - - loop { - button.wait_for_any_edge().await; - if button.is_low() { - led.set_high(); - } else { - led.set_low(); - } - } -} diff --git a/docs/modules/ROOT/examples/layer-by-layer/blinky-hal/Cargo.toml b/docs/modules/ROOT/examples/layer-by-layer/blinky-hal/Cargo.toml deleted file mode 100644 index c15de2db2..000000000 --- a/docs/modules/ROOT/examples/layer-by-layer/blinky-hal/Cargo.toml +++ /dev/null @@ -1,14 +0,0 @@ -[package] -name = "blinky-hal" -version = "0.1.0" -edition = "2021" -license = "MIT OR Apache-2.0" - -[dependencies] -cortex-m = "0.7" -cortex-m-rt = "0.7" -embassy-stm32 = { version = "0.1.0", features = ["stm32l475vg", "memory-x"] } - -defmt = "0.3.0" -defmt-rtt = "0.3.0" -panic-probe = { version = "0.3.0", features = ["print-defmt"] } diff --git a/docs/modules/ROOT/examples/layer-by-layer/blinky-hal/src/main.rs b/docs/modules/ROOT/examples/layer-by-layer/blinky-hal/src/main.rs deleted file mode 100644 index d0c9f4907..000000000 --- a/docs/modules/ROOT/examples/layer-by-layer/blinky-hal/src/main.rs +++ /dev/null @@ -1,21 +0,0 @@ -#![no_std] -#![no_main] - -use cortex_m_rt::entry; -use embassy_stm32::gpio::{Input, Level, Output, Pull, Speed}; -use {defmt_rtt as _, panic_probe as _}; - -#[entry] -fn main() -> ! { - let p = embassy_stm32::init(Default::default()); - let mut led = Output::new(p.PB14, Level::High, Speed::VeryHigh); - let button = Input::new(p.PC13, Pull::Up); - - loop { - if button.is_low() { - led.set_high(); - } else { - led.set_low(); - } - } -} diff --git a/docs/modules/ROOT/examples/layer-by-layer/blinky-irq/Cargo.toml b/docs/modules/ROOT/examples/layer-by-layer/blinky-irq/Cargo.toml deleted file mode 100644 index 9733658b6..000000000 --- a/docs/modules/ROOT/examples/layer-by-layer/blinky-irq/Cargo.toml +++ /dev/null @@ -1,14 +0,0 @@ -[package] -name = "blinky-irq" -version = "0.1.0" -edition = "2021" -license = "MIT OR Apache-2.0" - -[dependencies] -cortex-m = "0.7" -cortex-m-rt = { version = "0.7" } -embassy-stm32 = { version = "0.1.0", features = ["stm32l475vg", "memory-x", "unstable-pac"] } - -defmt = "0.3.0" -defmt-rtt = "0.3.0" -panic-probe = { version = "0.3.0", features = ["print-defmt"] } diff --git a/docs/modules/ROOT/examples/layer-by-layer/blinky-irq/src/main.rs b/docs/modules/ROOT/examples/layer-by-layer/blinky-irq/src/main.rs deleted file mode 100644 index 743c9d99b..000000000 --- a/docs/modules/ROOT/examples/layer-by-layer/blinky-irq/src/main.rs +++ /dev/null @@ -1,93 +0,0 @@ -#![no_std] -#![no_main] - -use core::cell::RefCell; - -use cortex_m::interrupt::Mutex; -use cortex_m::peripheral::NVIC; -use cortex_m_rt::entry; -use embassy_stm32::gpio::{Input, Level, Output, Pull, Speed}; -use embassy_stm32::{interrupt, pac}; -use {defmt_rtt as _, panic_probe as _}; - -static BUTTON: Mutex>>> = Mutex::new(RefCell::new(None)); -static LED: Mutex>>> = Mutex::new(RefCell::new(None)); - -#[entry] -fn main() -> ! { - let p = embassy_stm32::init(Default::default()); - let led = Output::new(p.PB14, Level::Low, Speed::Low); - let mut button = Input::new(p.PC13, Pull::Up); - - cortex_m::interrupt::free(|cs| { - enable_interrupt(&mut button); - - LED.borrow(cs).borrow_mut().replace(led); - BUTTON.borrow(cs).borrow_mut().replace(button); - - unsafe { NVIC::unmask(pac::Interrupt::EXTI15_10) }; - }); - - loop { - cortex_m::asm::wfe(); - } -} - -#[interrupt] -fn EXTI15_10() { - cortex_m::interrupt::free(|cs| { - let mut button = BUTTON.borrow(cs).borrow_mut(); - let button = button.as_mut().unwrap(); - - let mut led = LED.borrow(cs).borrow_mut(); - let led = led.as_mut().unwrap(); - if check_interrupt(button) { - if button.is_low() { - led.set_high(); - } else { - led.set_low(); - } - } - clear_interrupt(button); - }); -} -// -// -// -// -// -// -// "Hidden" HAL-like methods for doing interrupts with embassy. Hardcode pin just to give audience an idea of what it looks like - -const PORT: u8 = 2; -const PIN: usize = 13; -fn check_interrupt(_pin: &mut Input<'static>) -> bool { - let exti = pac::EXTI; - let pin = PIN; - let lines = exti.pr(0).read(); - lines.line(pin) -} - -fn clear_interrupt(_pin: &mut Input<'static>) { - let exti = pac::EXTI; - let pin = PIN; - let mut lines = exti.pr(0).read(); - lines.set_line(pin, true); - exti.pr(0).write_value(lines); -} - -fn enable_interrupt(_pin: &mut Input<'static>) { - cortex_m::interrupt::free(|_| { - let rcc = pac::RCC; - rcc.apb2enr().modify(|w| w.set_syscfgen(true)); - - let port = PORT; - let pin = PIN; - let syscfg = pac::SYSCFG; - let exti = pac::EXTI; - syscfg.exticr(pin / 4).modify(|w| w.set_exti(pin % 4, port)); - exti.imr(0).modify(|w| w.set_line(pin, true)); - exti.rtsr(0).modify(|w| w.set_line(pin, true)); - exti.ftsr(0).modify(|w| w.set_line(pin, true)); - }); -} diff --git a/docs/modules/ROOT/examples/layer-by-layer/blinky-pac/Cargo.toml b/docs/modules/ROOT/examples/layer-by-layer/blinky-pac/Cargo.toml deleted file mode 100644 index f872b94cb..000000000 --- a/docs/modules/ROOT/examples/layer-by-layer/blinky-pac/Cargo.toml +++ /dev/null @@ -1,14 +0,0 @@ -[package] -name = "blinky-pac" -version = "0.1.0" -edition = "2021" -license = "MIT OR Apache-2.0" - -[dependencies] -cortex-m = "0.7" -cortex-m-rt = "0.7" -stm32-metapac = { version = "1", features = ["stm32l475vg", "memory-x"] } - -defmt = "0.3.0" -defmt-rtt = "0.3.0" -panic-probe = { version = "0.3.0", features = ["print-defmt"] } diff --git a/docs/modules/ROOT/examples/layer-by-layer/blinky-pac/src/main.rs b/docs/modules/ROOT/examples/layer-by-layer/blinky-pac/src/main.rs deleted file mode 100644 index 990d46cb6..000000000 --- a/docs/modules/ROOT/examples/layer-by-layer/blinky-pac/src/main.rs +++ /dev/null @@ -1,53 +0,0 @@ -#![no_std] -#![no_main] - -use pac::gpio::vals; -use {defmt_rtt as _, panic_probe as _, stm32_metapac as pac}; - -#[cortex_m_rt::entry] -fn main() -> ! { - // Enable GPIO clock - let rcc = pac::RCC; - unsafe { - rcc.ahb2enr().modify(|w| { - w.set_gpioben(true); - w.set_gpiocen(true); - }); - - rcc.ahb2rstr().modify(|w| { - w.set_gpiobrst(true); - w.set_gpiocrst(true); - w.set_gpiobrst(false); - w.set_gpiocrst(false); - }); - } - - // Setup button - let gpioc = pac::GPIOC; - const BUTTON_PIN: usize = 13; - unsafe { - gpioc.pupdr().modify(|w| w.set_pupdr(BUTTON_PIN, vals::Pupdr::PULLUP)); - gpioc.otyper().modify(|w| w.set_ot(BUTTON_PIN, vals::Ot::PUSHPULL)); - gpioc.moder().modify(|w| w.set_moder(BUTTON_PIN, vals::Moder::INPUT)); - } - - // Setup LED - let gpiob = pac::GPIOB; - const LED_PIN: usize = 14; - unsafe { - gpiob.pupdr().modify(|w| w.set_pupdr(LED_PIN, vals::Pupdr::FLOATING)); - gpiob.otyper().modify(|w| w.set_ot(LED_PIN, vals::Ot::PUSHPULL)); - gpiob.moder().modify(|w| w.set_moder(LED_PIN, vals::Moder::OUTPUT)); - } - - // Main loop - loop { - unsafe { - if gpioc.idr().read().idr(BUTTON_PIN) == vals::Idr::LOW { - gpiob.bsrr().write(|w| w.set_bs(LED_PIN, true)); - } else { - gpiob.bsrr().write(|w| w.set_br(LED_PIN, true)); - } - } - } -} -- cgit