itsscb/esp-hal
1
0
Fork 0
mirror of https://github.com/esp-rs/esp-hal.git synced 2025-09-27 04:10:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add a note regarding running on the second core to esp-radio documentation (#4037)

Browse Source
This commit is contained in:
Jesse Braham 2025-09-05 04:59:13 -07:00 committed by GitHub
parent 9be325cf83
commit 67e0b65ee4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
esp-radio/src/lib.rs
View File

@ -61,7 +61,24 @@
//! - `ESP_RADIO_RX_QUEUE_SIZE`
//! - `ESP_RADIO_TX_QUEUE_SIZE`
//! - `ESP_RADIO_MAX_BURST_SIZE`
//!
#![cfg_attr(
multi_core,
doc = concat!(
"### Running on the Second Core",
"\n\n",
"BLE and Wi-Fi can also be run on the second core.",
"\n\n",
"`esp_preempt::init` and `esp_radio::init` _must_ be called on the core on",
"which you intend to run the wireless code. This will correctly initialize",
"the radio peripheral to run on that core, and ensure that interrupts are",
"serviced by the correct core.",
"\n\n",
"It's also important to allocate adequate stack for the second core; in many",
"cases 8kB is not enough, and 16kB or more may be required depending on your",
"use case. Failing to allocate adequate stack may result in strange behaviour,",
"such as your application silently failing at some point during execution."
)
)]
//! # Features flags
//!
//! Note that not all features are available on every MCU. For example, `ble`