2 个不稳定版本
0.2.0 | 2023 年 12 月 20 日 |
---|---|
0.1.1 | 2020 年 7 月 21 日 |
#2070 in 嵌入式开发
25KB
553 行
nrf-softdevice
Rust 为 Nordic Semiconductor nRF 系列软设备提供的绑定。
软设备是 Nordic 为其微控制器编写的闭源 C 二进制文件,位于闪存的底部,并在启动时首先调用。然后软设备调用您的应用程序或引导加载程序或闪存中直接位于其后的任何内容。
它们功能齐全,经过实战检验,并预先通过蓝牙认证,因此在与 Rust 绑定时成为有价值的蓝牙堆栈 - 至少直到我们获得商业认证的 Rust 蓝牙堆栈。不同的软设备支持特定的芯片以及某些功能,例如仅作为外围设备工作,或同时作为外围设备和中心设备,甚至提供类似 ant 的替代无线配置。
除了闭源的限制外,软设备的成本是它们会从您的应用程序中窃取资源,如 RAM 和闪存以及定时器外设和多个中断优先级。
高级绑定
nrf-softdevice
包包含用于软设备的高级 Rust async/await 绑定,易于使用。
功能
- 安全中断管理
- 异步闪存 API
- 蓝牙中心(扫描和连接)
- 蓝牙外围设备(广告,目前仅为可连接的)
- GATT 客户端
- GATT 服务器
- L2CAP 连接导向通道
- 数据长度扩展
- ATT MTU 扩展
- 获取/设置自己的 BLE 地址
要使用它,您必须指定以下 Cargo 功能
- 恰好一个软设备型号,例如功能
s140
。 - 恰好一个支持的 nRF 芯片型号,例如功能
nrf52840
。
以下软设备受支持。
- S112(仅外围设备)
- S113(仅外围设备)
- S122(仅中心设备)
- S132(中心和外围设备)
- S140 v7.x.x(中心和外围设备)
以下 nRF 芯片受支持
- nRF52805
- nRF52810
- nRF52811
- nRF52820
- nRF52832
- nRF52833
- nRF52840
某些软设备只支持某些芯片,请参阅Nordic的文档以获取详细信息。
设置您的构建环境
此项目曾经需要夜间的工具链功能,但这些功能最近已得到稳定。因此,请确保您的工具链是最新的,通过获取最新的稳定工具链来实现。
rustup update
您还需要probe-rs
- 一个实用程序,可以启用在设备上运行嵌入式应用程序的cargo run
命令。按照probe-rs网站
上的说明进行安装。
运行示例
以下说明适用于S140和nRF52840-DK。您可能需要相应地进行调整,并且可以通过修改示例文件夹中的cargo.toml
来实现 - 请检查nrf-softdevice
和nrf-softdevice-s140
依赖声明。
需要闪存软设备。它不是构建的二进制文件的一部分。您只需要在开始时或执行完全芯片擦除后进行一次。
- 从Nordic的网站此处下载SoftDevice S140。支持的版本是7.x.x
- 解压缩
- 如果您使用的是
- probe-rs
- 使用
probe-rs erase --chip nrf52840_xxAA
擦除闪存(您可能需要提供额外的--allow-erase-all
参数)。 - 使用
probe-rs download --verify --format hex --chip nRF52840_xxAA s140_nrf52_7.X.X_softdevice.hex
- 使用
- nrfjprog
- 使用
nrfjprog --family NRF52 --chiperase --verify --program s140_nrf52_7.0.1_softdevice.hex
- 使用
- probe-rs
要运行示例,只需从examples
文件夹使用cargo run
即可
cdexamples && cargorun --binble_bas_peripheral --featuresnrf52840
示例也可以为针对S132软设备的nrf52832芯片构建。
配置SoftDevice
首先要做的是找出您选择的SoftDevice使用的闪存大小。查看发布说明,或者通过谷歌搜索您的SoftDevice版本和“内存映射”。对于s132 v7.3,其大小为0x26000,或者以人类可读的数字为152K(十六进制中的0x26000等于十进制中的155648 / 1024字节 = 152K)
将memory.x设置为将应用程序的闪存开始位置移动到SoftDevice大小之后,并从总可用大小中减去它
MEMORY
{
/* NOTE 1 K = 1 KiBi = 1024 bytes */
/* These values correspond to the NRF52832 with SoftDevices S132 7.3.0 */
FLASH : ORIGIN = 0x00000000 + 152K, LENGTH = 512K - 152K
RAM : ORIGIN = 0x20000000 + 44K, LENGTH = 64K - 44K
}
现在您可以为ram选择几乎所有内容,因为如果您启用了defmt日志记录,SoftDevice将在您调用enable时告诉您正确的数字
1 INFO softdevice RAM: 41600 bytes
└─ nrf_softdevice::softdevice::{impl#0}::enable @ /home/jacob/.cargo/git/checkouts/nrf-softdevice-03ef4aef10e777e4/fa369be/nrf-softdevice/src/fmt.rs:138
2 ERROR panicked at 'too little RAM for softdevice. Change your app's RAM start address to 2000a280'
您可以通过调整SoftDevice配置参数来控制该数字。特别是查看并发连接参数。如果您不需要支持多个连接,这些参数可以真正减少ram的大小
- conn_gap.conn_count 使用此配置可以创建的并发连接数量
- periph_role_count 作为外围设备并发执行的连接的最大数量
- central_role_count 作为中心设备并发执行的连接的最大数量
接下来,你需要确定你的板子上是否有外部振荡器(这可以提供更好的电池寿命)。但如果不确定,只需假设没有,并将SoftDevice设置为使用内部时钟。nRF52的一个常见的无外部晶振配置可能如下所示:
clock: Some(raw::nrf_clock_lf_cfg_t {
source: raw::NRF_CLOCK_LF_SRC_RC as u8,
rc_ctiv: 16,
rc_temp_ctiv: 2,
accuracy: raw::NRF_CLOCK_LF_ACCURACY_500_PPM as u8,
}),
中断
SoftDevice在高优先级执行时间敏感的无线处理。如果其定时被破坏,它将引发“断言失败”错误。有两个常见的错误需要避免:(暂时)禁用软设备的中断,以及运行中断的优先级过高。
这些错误将导致“断言失败”错误,100%保证。如果你只是“稍微”这样做,例如,仅在不长时间内禁用所有中断,事情可能看起来可以正常工作,但运行数小时后你会得到“断言失败”错误。务必严格遵守这些规则。
默认情况下,Softdevice驱动程序(例如 Softdevice::run()
)不能从中断中调用。然而,usable-from-interrupts
功能启用了此功能。要使用此功能,需要一个critical-section
实现。此存储库的内部实现(critical-section-impl
功能)建议,但其他与Softdevice兼容的实现也应该工作。
关键部分
某些外围设备和SWI/EGU的中断被保留给SoftDevice。这些中断的处理程序由软设备保留,你的应用程序中的处理程序不会被调用。
不要禁用SoftDevice的中断。你必须不要使用广泛使用的cortex_m::interrupt::free
来为“禁用所有中断”的关键部分。相反,使用critical-section
存储库,该存储库允许自定义关键部分实现。
- 确保为
nrf-softdevice
启用critical-section-impl
Cargo功能。这使nrf-softdevice
生成一个自定义关键部分实现,该实现只禁用非SoftDevice中断。 - 使用
critical_section::with
而不是cortex_m::interrupt::free
。这使用自定义关键部分实现。 - 使用
embassy_sync::blocking_mutex::CriticalSectionMutex
而不是cortex_m::interrupt::Mutex
。
确保你没有使用任何内部使用cortex_m::interrupt::free
的库。
中断优先级
中断优先级0、1和4被保留给SoftDevice。请确保不要使用它们。
中断的默认优先级为0,因此对于你启用的每个中断,请确保明确设置优先级。例如
use embassy_nrf::interrupt::{self, InterruptExt};
interrupt::SPIM3.set_priority(interrupt::Priority::P3);
let mut spim = spim::Spim::new(p.SPI3, Irqs, p.P0_13, p.P0_16, p.P0_15, config);
如果你使用带有gpiote
或time-driver-rtc1
功能的embassy-nrf,你将需要编辑你的embassy_config以移动这些优先级
// 0 is Highest. Lower prio number can preempt higher prio number
// Softdevice has reserved priorities 0, 1 and 4
let mut config = embassy_nrf::config::Config::default();
config.gpiote_interrupt_priority = Priority::P2;
config.time_interrupt_priority = Priority::P2;
let peripherals = embassy_nrf::init(config);
故障排除
中断优先级
如果你确定已正确设置中断,但仍然收到如下错误
[ERROR]Location<lib.rs:104>panicked at 'sd_softdevice_enable err SdmIncorrectInterruptConfiguration'
请确保在embassy_nrf
上启用了defmt
功能。
您可以使用此代码来打印中断是否启用及其优先级。
// NB! MAX_IRQ depends on chip used, for example: nRF52840 has 48 IRQs, nRF52832 has 38.
const MAX_IRQ: u16 = ...;
use embassy_nrf::interrupt::{Interrupt, InterruptExt};
for num in 0..=MAX_IRQ {
let interrupt = unsafe { core::mem::transmute::<u16, Interrupt>(num) };
let is_enabled = InterruptExt::is_enabled(interrupt);
let priority = InterruptExt::get_priority(interrupt);
defmt::println!("Interrupt {}: Enabled = {}, Priority = {}", num, is_enabled, priority);
}
中断号映射到Interrupt
枚举中的值。
如果您的SoftDevice在启用时出现硬错误,并且您认为一切正常,请确保返回并执行完全芯片擦除或恢复,并重新闪存SoftDevice。SoftDevice之后的一小段空空间需要设置为0xFF,但如果软设备在现有二进制文件上闪存,则可能不需要。
外围设备冲突
如果出现以下运行时错误
Softdevice memory access violation. Your program accessed registers for a peripheral reserved to the softdevice. PC=2a644 PREGION=8192
请检查应用程序使用的哪个外围设备。
当Softdevice启用时(即使禁用),它使用外围设备数量来执行其功能,因此对外围设备的可用性施加一定的限制。
- 打开 - 外围设备未由SoftDevice和应用程序使用,应用程序具有完全访问权限。
- 阻塞 - 外围设备由SoftDevice使用,并且禁用了所有应用程序访问。尽管如此,某些外围设备(RADIO、TIMER0、CCM和AAR)可以通过Softdevice Radio Timeslot API进行访问。
- 受限 - 外围设备由SoftDevice使用,但可以通过SoftDevice API有限访问。例如
FLASH
、RNG
和TEMP
外围设备。
链接问题
如果出现以下链接错误
rust-lld: error: undefined symbol: _critical_section_release
确保启用了critical-section-impl
功能,并且软设备已包含在代码中,例如use nrf_softdevice as _;
。
如果固件在闪存后运行超时,请确保链接脚本中RAM和FLASH区域的大小和位置正确。
低级原始绑定
nrf-softdevice-s1xx
包包含与软设备C头文件一一对应的低级绑定。
它们使用bindgen
生成,并经过额外的后处理,以正确生成基于svc
的软设备调用。
生成的代码由使用内联汇编的内联函数组成,确保最低的运行开销。大多数时候,您会在调用函数中看到它们作为单个svc
指令内联。以下是一个示例
#[inline(always)]
pub unsafe fn sd_ble_gap_connect(
p_peer_addr: *const ble_gap_addr_t,
p_scan_params: *const ble_gap_scan_params_t,
p_conn_params: *const ble_gap_conn_params_t,
conn_cfg_tag: u8,
) -> u32 {
let ret: u32;
core::arch::asm!("svc 140",
inout("r0") p_peer_addr => res,
inout("r1") p_scan_params => _,
inout("r2") p_conn_params => _,
inout("r3") conn_cfg_tag => _,
lateout("r12") _,
);
ret
}
生成
绑定是通过gen.sh
脚本来从头文件生成的。
许可
此存储库包含软设备头文件,这些头文件受Nordic专有许可的许可。生成的binding.rs
文件是头文件的衍生作品,因此也受Nordic许可的约束。
高级绑定(nrf-softdevice)和生成器代码(nrf-softdevice-gen)受以下之一许可:
- Apache License,版本2.0(LICENSE-APACHE或http://apache.ac.cn/licenses/LICENSE-2.0)
- MIT许可(LICENSE-MIT或http://opensource.org/licenses/MIT)
您可选。