embassy/embassy-executor/Cargo.toml

[package]
name = "embassy-executor"
version = "0.1.1"
edition = "2021"
license = "MIT OR Apache-2.0"
description = "async/await executor designed for embedded usage"
repository = "https://github.com/embassy-rs/embassy"
categories = [
    "embedded",
    "no-std",
    "asynchronous",
]

[package.metadata.embassy_docs]
src_base = "https://github.com/embassy-rs/embassy/blob/embassy-executor-v$VERSION/embassy-executor/src/"
src_base_git = "https://github.com/embassy-rs/embassy/blob/$COMMIT/embassy-executor/src/"
features = ["nightly", "defmt"]
flavors = [
    { name = "std",                       target = "x86_64-unknown-linux-gnu",   features = ["std"] },
    { name = "wasm",                      target = "wasm32-unknown-unknown",     features = ["wasm"] },
    { name = "thumbv6m-none-eabi",        target = "thumbv6m-none-eabi",         features = [] },
    { name = "thumbv7m-none-eabi",        target = "thumbv7m-none-eabi",         features = [] },
    { name = "thumbv7em-none-eabi",       target = "thumbv7em-none-eabi",        features = [] },
    { name = "thumbv7em-none-eabihf",     target = "thumbv7em-none-eabihf",      features = [] },
    { name = "thumbv8m.base-none-eabi",   target = "thumbv8m.base-none-eabi",    features = [] },
    { name = "thumbv8m.main-none-eabi",   target = "thumbv8m.main-none-eabi",    features = [] },
    { name = "thumbv8m.main-none-eabihf", target = "thumbv8m.main-none-eabihf",  features = [] },
]

[package.metadata.docs.rs]
features = ["std", "nightly", "defmt"]

[features]

# Architecture
_arch = [] # some arch was picked
arch-std = ["_arch", "critical-section/std"]
arch-cortex-m = ["_arch", "dep:cortex-m"]
arch-xtensa = ["_arch"]
arch-riscv32 = ["_arch"]
arch-wasm = ["_arch", "dep:wasm-bindgen", "dep:js-sys"]

# Enable creating a `Pender` from an arbitrary function pointer callback.
pender-callback = []

# Enable the thread-mode executor (using WFE/SEV in Cortex-M, WFI in other embedded archs)
executor-thread = []
# Enable the interrupt-mode executor (available in Cortex-M only)
executor-interrupt = []

# Enable nightly-only features
nightly = []

turbowakers = []

integrated-timers = ["dep:embassy-time"]

# Trace interrupt invocations with rtos-trace.
rtos-trace-interrupt = ["rtos-trace", "embassy-macros/rtos-trace-interrupt"]

[dependencies]
defmt = { version = "0.3", optional = true }
log = { version = "0.4.14", optional = true }
rtos-trace = { version = "0.1.2", optional = true }

futures-util = { version = "0.3.17", default-features = false }
embassy-macros  = { version = "0.1.0", path = "../embassy-macros" }
embassy-time  = { version = "0.1.0", path = "../embassy-time", optional = true}
atomic-polyfill = "1.0.1"
critical-section = "1.1"
static_cell = "1.0"

# arch-cortex-m dependencies
cortex-m = { version = "0.7.6", optional = true }

# arch-wasm dependencies
wasm-bindgen = { version = "0.2.82", optional = true }
js-sys = { version = "0.3", optional = true }
First commit 2020-09-22 16:03:43 +00:00			`[package]`
Split embassy crate into embassy-executor, embassy-util. 2022-07-29 19:58:35 +00:00			`name = "embassy-executor"`
Release embassy-executor v0.1.1 2022-11-23 13:53:18 +00:00			`version = "0.1.1"`
Update to 2021 edition. (#820) 2022-06-18 00:15:48 +00:00			`edition = "2021"`
all Cargo.toml: Add license to all crate Cargo.toml files Closes: https://github.com/embassy-rs/embassy/issues/1002 2022-10-07 10:41:56 +00:00			`license = "MIT OR Apache-2.0"`
doc: update cargo manifests with keywords 2022-11-22 13:48:42 +00:00			`description = "async/await executor designed for embedded usage"`
			`repository = "https://github.com/embassy-rs/embassy"`
			`categories = [`
			`"embedded",`
			`"no-std",`
			`"asynchronous",`
			`]`
Split embassy crate into embassy-executor, embassy-util. 2022-07-29 19:58:35 +00:00
docs: add metadata.embassy_docs to cargo tomls. 2022-03-04 16:45:01 +00:00			`[package.metadata.embassy_docs]`
Split embassy crate into embassy-executor, embassy-util. 2022-07-29 19:58:35 +00:00			`src_base = "https://github.com/embassy-rs/embassy/blob/embassy-executor-v$VERSION/embassy-executor/src/"`
			`src_base_git = "https://github.com/embassy-rs/embassy/blob/$COMMIT/embassy-executor/src/"`
Build docs in CI 2022-10-02 20:24:59 +00:00			`features = ["nightly", "defmt"]`
docs: add metadata.embassy_docs to cargo tomls. 2022-03-04 16:45:01 +00:00			`flavors = [`
			`{ name = "std", target = "x86_64-unknown-linux-gnu", features = ["std"] },`
			`{ name = "wasm", target = "wasm32-unknown-unknown", features = ["wasm"] },`
			`{ name = "thumbv6m-none-eabi", target = "thumbv6m-none-eabi", features = [] },`
			`{ name = "thumbv7m-none-eabi", target = "thumbv7m-none-eabi", features = [] },`
			`{ name = "thumbv7em-none-eabi", target = "thumbv7em-none-eabi", features = [] },`
			`{ name = "thumbv7em-none-eabihf", target = "thumbv7em-none-eabihf", features = [] },`
			`{ name = "thumbv8m.base-none-eabi", target = "thumbv8m.base-none-eabi", features = [] },`
			`{ name = "thumbv8m.main-none-eabi", target = "thumbv8m.main-none-eabi", features = [] },`
			`{ name = "thumbv8m.main-none-eabihf", target = "thumbv8m.main-none-eabihf", features = [] },`
			`]`

executor: enable features for docs.rs Otherwise the non-raw executor and the macros don't show up. 2022-11-23 13:49:40 +00:00			`[package.metadata.docs.rs]`
			`features = ["std", "nightly", "defmt"]`

First commit 2020-09-22 16:03:43 +00:00			`[features]`
executor: add Pender, rework Cargo features. This introduces a `Pender` struct with enum cases for thread-mode, interrupt-mode and custom callback executors. This avoids calls through function pointers when using only the thread or interrupt executors. Faster, and friendlier to `cargo-call-stack`. `embassy-executor` now has `arch-xxx` Cargo features to select the arch and to enable the builtin executors (thread and interrupt). 2023-04-02 23:18:27 +00:00
			`# Architecture`
			`_arch = [] # some arch was picked`
			`arch-std = ["_arch", "critical-section/std"]`
			`arch-cortex-m = ["_arch", "dep:cortex-m"]`
			`arch-xtensa = ["_arch"]`
			`arch-riscv32 = ["_arch"]`
			`arch-wasm = ["_arch", "dep:wasm-bindgen", "dep:js-sys"]`

			# Enable creating a `Pender` from an arbitrary function pointer callback.
			`pender-callback = []`

			`# Enable the thread-mode executor (using WFE/SEV in Cortex-M, WFI in other embedded archs)`
			`executor-thread = []`
			`# Enable the interrupt-mode executor (available in Cortex-M only)`
			`executor-interrupt = []`
embassy/time: make optional via Cargo feature 2021-07-12 01:29:09 +00:00
embassy, embassy-nrf: add `nightly` Cargo feature to gate nightly-only features. 2022-02-11 23:24:04 +00:00			`# Enable nightly-only features`
Split embassy-time from embassy-executor. 2022-08-17 21:40:16 +00:00			`nightly = []`
embassy, embassy-nrf: add `nightly` Cargo feature to gate nightly-only features. 2022-02-11 23:24:04 +00:00
executor,sync: add support for turbo-wakers. This is a `core` patch to make wakers 1 word (the task pointer) instead of 2 (task pointer + vtable). It allows having the "waker optimization" we had a while back on `WakerRegistration/AtomicWaker`, but EVERYWHERE, without patching all crates. Advantages: - Less memory usage. - Faster. - `AtomicWaker` can actually use atomics to load/store the waker, No critical section needed. - No `dyn` call, which means `cargo-call-stack` can now see through wakes. Disadvantages: - You have to patch `core`... - Breaks all executors and other things that create wakers, unless they opt in to using the new `from_ptr` API. How to use: - Run this shell script to patch `core`. https://gist.github.com/Dirbaio/c67da7cf318515181539122c9d32b395 - Enable `build-std` - Enable `build-std-features = core/turbowakers` - Enable feature `turbowakers` in `embassy-executor`, `embassy-sync`. - Make sure you have no other crate creating wakers other than `embassy-executor`. These will panic at runtime. Note that the patched `core` is equivalent to the unpached one when the `turbowakers` feature is not enabled, so it should be fine to leave it there. 2023-03-30 15:55:55 +00:00			`turbowakers = []`

Split embassy-time from embassy-executor. 2022-08-17 21:40:16 +00:00			`integrated-timers = ["dep:embassy-time"]`
Remove cargo namespaced-features 2021-03-02 20:14:58 +00:00
Add separate feature flag to enable interrupt tracing 2022-08-16 04:42:08 +00:00			`# Trace interrupt invocations with rtos-trace.`
Ensure interrupt::take works without embassy-executor Add "rtos-trace-interrupt" feature flag on embassy-macros and enable it for embassy-executor, to ensure that the interrupt::take! macro can be used without depending on embassy-executor. 2022-08-23 12:57:45 +00:00			`rtos-trace-interrupt = ["rtos-trace", "embassy-macros/rtos-trace-interrupt"]`
Add separate feature flag to enable interrupt tracing 2022-08-16 04:42:08 +00:00
First commit 2020-09-22 16:03:43 +00:00			`[dependencies]`
Update to defmt 3.0ish. Lots of gitrevs deps. 2021-11-15 16:08:51 +00:00			`defmt = { version = "0.3", optional = true }`
Update lots of deps 2021-09-10 22:10:46 +00:00			`log = { version = "0.4.14", optional = true }`
Add support for rtos-trace behind a feature flag 2022-08-09 20:25:42 +00:00			`rtos-trace = { version = "0.1.2", optional = true }`
Make defmt optional with new `anyfmt` crate 2020-11-01 16:17:24 +00:00
Split embassy crate into embassy-executor, embassy-util. 2022-07-29 19:58:35 +00:00			`futures-util = { version = "0.3.17", default-features = false }`
Ensure interrupt::take works without embassy-executor Add "rtos-trace-interrupt" feature flag on embassy-macros and enable it for embassy-executor, to ensure that the interrupt::take! macro can be used without depending on embassy-executor. 2022-08-23 12:57:45 +00:00			`embassy-macros = { version = "0.1.0", path = "../embassy-macros" }`
Split embassy-time from embassy-executor. 2022-08-17 21:40:16 +00:00			`embassy-time = { version = "0.1.0", path = "../embassy-time", optional = true}`
Update to critical-section 1.0, atomic-polyfill 1.0 2022-08-14 21:16:06 +00:00			`atomic-polyfill = "1.0.1"`
			`critical-section = "1.1"`
Remove Forever, switch to static_cell. 2022-08-22 13:51:44 +00:00			`static_cell = "1.0"`
Make defmt optional with new `anyfmt` crate 2020-11-01 16:17:24 +00:00
executor: add Pender, rework Cargo features. This introduces a `Pender` struct with enum cases for thread-mode, interrupt-mode and custom callback executors. This avoids calls through function pointers when using only the thread or interrupt executors. Faster, and friendlier to `cargo-call-stack`. `embassy-executor` now has `arch-xxx` Cargo features to select the arch and to enable the builtin executors (thread and interrupt). 2023-04-02 23:18:27 +00:00			`# arch-cortex-m dependencies`
			`cortex-m = { version = "0.7.6", optional = true }`

			`# arch-wasm dependencies`
Enable 'std' feature on critical-section for WASM This fixes the WASM support which was failing due to missing critical-section implementation. This also upgrades the bindgen dependency and ensures that tooling works. 2022-08-23 17:55:49 +00:00			`wasm-bindgen = { version = "0.2.82", optional = true }`
			`js-sys = { version = "0.3", optional = true }`