nrf-softdevice

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

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

它们功能齐全，经过实战测试，并预先获得蓝牙认证，因此当绑定到Rust时，它们成为宝贵的蓝牙堆栈——至少直到我们获得商业发行认证的Rust蓝牙堆栈。不同的SoftDevices支持特定的芯片以及某些功能，如仅作为外围设备工作，或既是外围设备又是中心设备，甚至提供类似ant的替代无线配置。

除了闭源的限制之外，SoftDevices的代价是它们从您的应用程序中窃取资源，如RAM和闪存以及定时器外设和多个中断优先级。

高级绑定

nrf-softdevice 包包含用于Softdevice的高级易用Rust异步/等待绑定。

工作

• 安全的中断管理
• 异步闪存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 --binary-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-dk

示例还可以为针对S132软设备的nrf52832开发套件（功能标志nrf52832-dk）或针对BBC micro:bit v2上的S140软设备的目标nrf52833（功能标志microbit-v2）构建。在这些情况下，根据需要编辑.cargo/config.toml。

配置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
}

您现在可以为主内存选择几乎所有内容，因为如果您启用了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 Driver（例如 Softdevice::run()）不能从中断中调用。然而，usable-from-interrupts 功能启用了此功能。要使用此功能，需要一个 critical-section 实现。此crate的内部实现（critical-section-impl 功能）建议，但其他与Softdevice兼容的实现也应该可以工作。

关键部分

某些外围设备以及SWI/EGU的中断 被SoftDevice保留。这些中断的处理程序由软设备保留，您的应用程序中的处理程序不会被调用。

不要禁用SoftDevice的中断。您绝对不能在“禁用所有中断”关键部分中使用广泛使用的 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，并且代码中已包含软设备，例如 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 许可证 2.0（《LICENSE-APACHE》或 https://apache.ac.cn/licenses/LICENSE-2.0》）
• MIT 许可证（《LICENSE-MIT》或 http://opensource.org/licenses/MIT》）

由您选择。