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 烧录SoftDevice
  • nrfjprog
    • 使用 nrfjprog --family NRF52 --chiperase --verify --program s140_nrf52_7.0.1_softdevice.hex 烧录SoftDevice

要运行示例，只需从 examples 文件夹使用 cargo run

• cdexamples && cargorun --binble_bas_peripheral --featuresnrf52840

示例也可以为针对S132软设备的nrf52832芯片构建。

配置SoftDevice

首先要做的是找出您选择的SoftDevice使用的多少闪存。查看发行说明，或通过Google搜索您的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或http://www.apache.org/licenses/LICENSE-2.0）
• MIT许可（LICENSE-MIT或http://opensource.org/licenses/MIT）

任选其一。