nrf-softdevice

Rust对Nordic Semiconductor 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功能

• 确切的一个SoftDevice型号，例如功能 s140。
• 确切的一个受支持的nRF芯片型号，例如功能 nrf52840。

以下SoftDevice受支持。

• 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参数）。
    • 使用以下命令烧录SoftDevice：probe-rs download --verify --binary-format hex --chip nRF52840_xxAA s140_nrf52_7.X.X_softdevice.hex
  • nrfjprog
    • 使用以下命令烧录SoftDevice：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
}

现在您可以为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保留，您的应用程序中的处理程序不会被调用。

请勿禁用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);

如果您使用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 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 License，版本2.0（LICENSE-APACHE 或 https://apache.ac.cn/licenses/LICENSE-2.0）
• MIT 许可证（LICENSE-MIT 或 https://open-source.org.cn/licenses/MIT）

由您选择。