nrf-softdevice

Rust对Nordic半导体nRF系列SoftDevices的绑定。

SoftDevices是由Nordic为他们的微控制器编写的闭源C二进制文件，位于闪存的底部，并在启动时首先调用。然后SoftDevice会调用您的应用程序或引导加载程序或闪存中直接位于其后的任何内容。

它们功能齐全，经过实战检验，并预先认证可用于蓝牙认证，因此在与Rust绑定时成为有价值的蓝牙堆栈——至少直到我们有认证可商业发货的Rust蓝牙堆栈。不同的SoftDevices支持特定的芯片以及某些功能，例如仅作为外围设备工作，或同时作为外围设备和中心设备，甚至提供类似ant的备用无线配置。

除了是闭源这一缺点外，SoftDevices的成本是它们会占用您应用程序的资源，如ram和闪存以及定时器外围设备和一些中断优先级。

高级绑定

nrf-softdevice crate包含了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的文档。

设置您的构建环境

该项目曾经需要nightly工具链功能，这些功能最近已经稳定。因此，请确保您的工具链是最新的，通过获取最新的稳定工具链来确保这一点。

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

要运行示例，只需在 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实现。此crate的内部实现（critical-section-impl功能）被推荐，但其他与Softdevice兼容的实现也应该有效。

关键部分

某些外设和SWI/EGU的中断被保留给SoftDevice。为它们保留的中断处理程序由软设备保留，您的应用程序中的处理程序不会被调用。

请勿禁用软设备的 interrupts。您绝对不能使用广泛使用的cortex_m::interrupt::free用于“禁用所有中断”关键部分。相反，使用critical-section crate，该crate允许自定义关键部分实现。

• 请确保为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);

如果您使用embassy-nrf，并启用了gpiote或time-driver-rtc1功能，您需要编辑您的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是在现有二进制文件上刷新的，则可能不是这样。

外设冲突

如果出现以下运行时错误

Softdevice memory access violation. Your program accessed registers for a peripheral reserved to the softdevice. PC=2a644 PREGION=8192

检查应用程序使用哪些外设。

当Softdevice启用（甚至禁用）时，它使用外设的数量来实现其功能，因此对外设的可用性强制执行某些限制，请参阅外设可用性。

1. 打开 - 外设不被SoftDevice使用，应用程序具有完全访问权限。
2. 阻塞 - 外设被SoftDevice使用，所有应用程序访问都被禁用。尽管如此，某些外设（RADIO、TIMER0、CCM和AAR）可以通过Softdevice Radio Timeslot API进行访问。
3. 受限 - 外设被SoftDevice使用，但可以通过SoftDevice API有限访问。例如，FLASH、RNG和TEMP外设。

链接问题

如果出现以下链接错误

rust-lld: error: undefined symbol: _critical_section_release

确保已启用功能critical-section-impl，并且SoftDevice已包含在代码中，例如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://www.apache.org/licenses/LICENSE-2.0）
• MIT许可证（LICENSE-MIT或http://opensource.org/licenses/MIT）

。