低功耗蓝牙协议栈入门（二）NimBLE 源码分析

2021-11-24

NimBLE 源码分析

NimBLE 是一个开源的蓝牙 5.1 协议栈，包含主机与控制器。采用 Apache-2.0 License 开源协议，这意味着你可以免费学习并使用它。源码地址：https://github.com/apache/mynewt-nimble

（一）NimBLE 源码目录结构

├─apps
├─docs
├─ext
├─nimble
│  ├─controller
│  ├─drivers
│  ├─host
│  └─transport
├─porting

目录	作用
apps	nimble 的应用参考实现
docs	文档
ext	扩展库，比如 nimble 使用了 tinycrypt 加密库
nimble/controller	蓝牙协议栈中的 controller 源码。（主要为链路层）
nimble/drivers	驱动不同芯片的底层 API 。（PHY 层）
nimble/host	蓝牙协议栈中的 host 层源码。
nimble/transport	蓝牙协议栈中的 hci 层源码
porting	nimble 移植到不同 OS 的移植文件

NimBLE 的移植有两种情况，一种是移植到其他软件操作系统上；另一种是移植到其他硬件芯片平台上。

操作系统移植

如果你是关注如何将 NimBLE 移植到其他软件操作系统平台上的话，可以看 nimble_npl.h 这个头文件，这个头文件声明了 NimBLE 需要操作系统提供的移植 API ，如：事件；互斥量；信号量；系统时间；临界区访问；等需要操作系统提供的机制。 nimble_npl.h 头文件里的函数实现，一般是放在 ./porting 目录下。以下是需要实现的移植 api 注释说明：

/* 通用 */
bool ble_npl_os_started(void); /* 启动操作系统 */
void *ble_npl_get_current_task_id(void); /* 获取当前线程任务的 ID 号 */
/* 时间队列（消息队列） */
void ble_npl_eventq_init(struct ble_npl_eventq *evq); /* 消息队列初始化 */
struct ble_npl_event *ble_npl_eventq_get(struct ble_npl_eventq *evq,ble_npl_time_t tmo); /* 获取消息 */
void ble_npl_eventq_put(struct ble_npl_eventq *evq, struct ble_npl_event *ev); /* 发送消息 */
void ble_npl_eventq_remove(struct ble_npl_eventq *evq, struct ble_npl_event *ev); /* 移除整个消息队列 */
void ble_npl_event_init(struct ble_npl_event *ev, ble_npl_event_fn *fn, void *arg); /* 事件初始化 */
bool ble_npl_event_is_queued(struct ble_npl_event *ev); /* 是否存在事件发送，已经挂在队列中。 */
void *ble_npl_event_get_arg(struct ble_npl_event *ev); /* 获取事件参数 */
void ble_npl_event_set_arg(struct ble_npl_event *ev, void *arg); /* 设置事件参数 */
bool ble_npl_eventq_is_empty(struct ble_npl_eventq *evq); /* 消息队列中是否存在事件 */
void ble_npl_event_run(struct ble_npl_event *ev); /* 执行事件初始化时注册的函数 */
/* 互斥量 */
ble_npl_error_t ble_npl_mutex_init(struct ble_npl_mutex *mu); /* 初始化互斥量 */
ble_npl_error_t ble_npl_mutex_pend(struct ble_npl_mutex *mu, ble_npl_time_t timeout); /* 尝试获取互斥量 */
ble_npl_error_t ble_npl_mutex_release(struct ble_npl_mutex *mu); /* 释放一个互斥量 */
/* 信号量 */
ble_npl_error_t ble_npl_sem_init(struct ble_npl_sem *sem, uint16_t tokens); /* 初始化信号量 */
ble_npl_error_t ble_npl_sem_pend(struct ble_npl_sem *sem, ble_npl_time_t timeout); /* 尝试获取信号量资源 */
ble_npl_error_t ble_npl_sem_release(struct ble_npl_sem *sem); /* 释放一个信号量资源 */
uint16_t ble_npl_sem_get_count(struct ble_npl_sem *sem); /* 查看当前有多少个信号量资源 */
/* 定时事件发生机制 */
void ble_npl_callout_init(struct ble_npl_callout *co, struct ble_npl_eventq *evq, ble_npl_event_fn *ev_cb, void *ev_arg);/* 创建一个定时器以及初始化一个事件 */
ble_npl_error_t ble_npl_callout_reset(struct ble_npl_callout *co, ble_npl_time_t ticks); /* 重置定时器并启动 */
void ble_npl_callout_stop(struct ble_npl_callout *co); /* 关闭定时器 */
bool ble_npl_callout_is_active(struct ble_npl_callout *co); /* 查看定时器是否处于激活状态 */
ble_npl_time_t ble_npl_callout_get_ticks(struct ble_npl_callout *co); /* 查看定时器何时产生动作 */
ble_npl_time_t ble_npl_callout_remaining_ticks(struct ble_npl_callout *co, ble_npl_time_t time); /* 查看定时器还剩多少时间产生动作 */
void ble_npl_callout_set_arg(struct ble_npl_callout *co, void *arg); /* 设置定时事件参数 */
/* 系统时间 */
ble_npl_time_t ble_npl_time_get(void); /* 获取当前时间戳 */
ble_npl_error_t ble_npl_time_ms_to_ticks(uint32_t ms, ble_npl_time_t *out_ticks); /* 将 ms 换算成 systick */
ble_npl_error_t ble_npl_time_ticks_to_ms(ble_npl_time_t ticks, uint32_t *out_ms); /* 将 systick 换算成 ms */
ble_npl_time_t ble_npl_time_ms_to_ticks32(uint32_t ms); /* 将 ms 换算成 systick ，并返回。*/
uint32_t ble_npl_time_ticks_to_ms32(ble_npl_time_t ticks); /* 将 systick 换算成 ms */
void ble_npl_time_delay(ble_npl_time_t ticks); /* 系统延时函数 */
/* 临界区 */
uint32_t ble_npl_hw_enter_critical(void); /* 进入临界区保护函数 */
void ble_npl_hw_exit_critical(uint32_t ctx); /* 退出临界区保护函数 */
bool ble_npl_hw_is_in_critical(void); /* 判断当前执行环境是否处在临界区保护 */

芯片平台移植

如果你是关注如何将 NimBle 移植到不同硬件芯片平台的话，那么需要关注的内容有如下两点：

控制器部分：需要将 ble_phy.h 与 ble_hw.h 这两个头文件声明的函数实现，这部分的代码应该对应的是低功耗蓝牙协议栈的 PHY 层。
主机控制器接口：需要将 ble_hci_trans.h 中声明的函数实现，这部分的代码对应的是低功耗蓝牙协议栈的 HCI 层。

蓝牙协议栈是分层的，根据不同芯片厂家对蓝牙 ip 的开放程度，nimble 也可以做到不同层次的适配，比如不开放控制器层的代码，只适配 hci 层的代码。

芯片平台的移植，需要有芯片原厂的蓝牙基带底层一手资料，这里我无法了解每个移植 api 的准确意义，为免误人子弟，就不再对这些 api 进行注释描述了。。。

（二）NimBLE 启动流程

NimBLE 的启动流程以 rt-thread 的 nimble 软件包为例，分为两部分，下面是我画的流程图：

NimBLE

第一部分是系统一上电就会完成的启动流程，最终会将整个蓝牙硬件初始化完成，并启动一个专门负责链路层的任务。链路层的任务会接收链路层的事件队列，并执行每个事件对应的回调函数。

/**
 * Link Layer task.
 *
 * This is the task that runs the Link Layer.
 *
 * @param arg
 */
void
ble_ll_task(void *arg)
{
    struct ble_npl_event *ev;

    /*
     * XXX RIOT ties event queue to a thread which initialized it so we need to
     * create event queue in LL task, not in general init function. This can
     * lead to some races between host and LL so for now let us have it as a
     * hack for RIOT where races can be avoided by proper initialization inside
     * package.
     */
#ifdef RIOT_VERSION
    ble_npl_eventq_init(&g_ble_ll_data.ll_evq);
#endif

    /* Init ble phy */
    ble_phy_init();

    /* Set output power to 1mW (0 dBm) */
    ble_phy_txpwr_set(MYNEWT_VAL(BLE_LL_TX_PWR_DBM));

    /* Tell the host that we are ready to receive packets */
    ble_ll_hci_send_noop();

    ble_ll_rand_start();

    while (1) {
        ev = ble_npl_eventq_get(&g_ble_ll_data.ll_evq, BLE_NPL_TIME_FOREVER);
        assert(ev);
        ble_npl_event_run(ev);
    }
}

第二部分是 NimBLE 应用启动的标准流程，最终会完成这个蓝牙协议栈的属性配置，并启动一个专门负责 host 层的任务。host 层的任务同样也是接收事件队列，并执行每个事件对应的回调函数。

void
nimble_port_run(void)
{
    struct ble_npl_event *ev;

    while (1) {
        ev = ble_npl_eventq_get(&g_eventq_dflt, BLE_NPL_TIME_FOREVER);
        ble_npl_event_run(ev);
    }
}