nRF5 SDK從版本14開(kāi)始，對(duì)事件回調(diào)機(jī)制做了更新，引入了觀察者模式，以解耦不同BLE Layer對(duì)BLE事件的回調(diào)函數(shù)。

實(shí)現(xiàn)這套機(jī)制用到了Flash的段（Section），將RAM中的函數(shù)調(diào)用與Flash中的段操作結(jié)合到一起，這個(gè)想法很新穎。

本文嘗試?yán)斫夂妥粉櫿麄€(gè)回調(diào)過(guò)程，并寫(xiě)一段代碼驗(yàn)證我們的思路。

一、觀察者模式簡(jiǎn)介

面向?qū)ο?a href="http://www.www27dydycom.cn/v/tag/1315/" target="_blank">編程世界里有許多著名的設(shè)計(jì)模式，其中一種叫觀察者模式，它解決的問(wèn)題是：在某場(chǎng)景下對(duì)象之間存在一對(duì)多的依賴關(guān)系，當(dāng)中心對(duì)象的狀態(tài)發(fā)生改變，其他所有依賴于它的對(duì)象都能得到通知并自動(dòng)更新。

觀察者模式中有幾種角色：觀察者（Observer），主題（Subject）和發(fā)布者（Publisher）。

多個(gè)觀察者可以獨(dú)立的訂閱（Subscribe）一個(gè)主題，當(dāng)該主題收到發(fā)布者推送的數(shù)據(jù)，將數(shù)據(jù)通知（Notify）給各個(gè)觀察者進(jìn)行后續(xù)處理。

實(shí)現(xiàn)觀察者模式，觀察者端需要實(shí)現(xiàn)一個(gè)訂閱功能，將自己的句柄和回調(diào)函數(shù)傳遞給主題。主機(jī)端應(yīng)該有一個(gè)列表，所有訂閱它的觀察者句柄和回調(diào)函數(shù)都保存在該列表中，當(dāng)需要通知時(shí)，則遍歷列表中的各個(gè)句柄，分別執(zhí)行各自的回調(diào)函數(shù)。發(fā)布者給主題發(fā)數(shù)據(jù)，則簡(jiǎn)單的暴露一個(gè)接口即可。

更進(jìn)一步的，在代碼中要將句柄和回調(diào)函數(shù)封裝成一個(gè)結(jié)構(gòu)體，這樣就可以方便傳參。觀察者準(zhǔn)備一個(gè)函數(shù)，將該結(jié)構(gòu)體保存到一個(gè)列表中，這個(gè)函數(shù)稱為訂閱。主題準(zhǔn)備一個(gè)函數(shù)，讀取該列表，遍歷獲得各個(gè)結(jié)構(gòu)體，并執(zhí)行回調(diào)，這個(gè)函數(shù)稱為通知。

設(shè)計(jì)這個(gè)列表是關(guān)鍵。

最簡(jiǎn)單的辦法是準(zhǔn)備一個(gè)內(nèi)存數(shù)組，訂閱函數(shù)即寫(xiě)數(shù)組，通知函數(shù)即讀數(shù)組。

nRF5 SDK選擇了另一種方式，使用Flash的段。

二、Flash段簡(jiǎn)介

本文使用SEGGER Embedded Studio開(kāi)發(fā)工具進(jìn)行介紹，它后端使用arm gcc編譯器，需要用到它的鏈接文件（.ld）和map文件（.map）。

Flash的段是指在Flash中指定一塊空間，包含首地址和空間長(zhǎng)度，并設(shè)定一個(gè)段名。段名以點(diǎn)（.）開(kāi)頭。

C語(yǔ)言開(kāi)發(fā)中經(jīng)常提及的段有代碼段.text，常量段.rodata等。

利用__attribute__關(guān)鍵字，可以為變量指定段名，以下代碼將變量my_var存放在段.my_section中：

static my_type_t my_var __attribute__ ((section(".my_section"))) __attribute__((used)) = 
{
    .handler    = handler,
    .p_context  = NULL
};

還需要在內(nèi)存布局文件中，設(shè)定好該段的起始地址和長(zhǎng)度。編譯SES工程，將生成鏈接文件（.ld），可以看到諸如以下代碼：

.sdh_ble_observers ALIGN(__pwr_mgmt_data_end__ , 4) : AT(ALIGN(__pwr_mgmt_data_end__ , 4))
{
__sdh_ble_observers_start__ = .;
__start_sdh_ble_observers =   __sdh_ble_observers_start__;
KEEP(*(SORT(.sdh_ble_observers*)))
}
__sdh_ble_observers_end__ = __sdh_ble_observers_start__ + SIZEOF(.sdh_ble_observers);
__sdh_ble_observers_size__ = SIZEOF(.sdh_ble_observers);

其中xx_start__表示起始地址， xx_size__表示長(zhǎng)度，xx_end__表示結(jié)束地址。

注意到一個(gè)關(guān)鍵行：KEEP(*(SORT(.sdh_ble_observers*)))。

該行使用了通配符，.sdh_ble_observers*末尾的星號(hào)表示任意字符，所以我們可能在代碼中看到形如.sdh_ble_observers1這種段名。SORT表示將這些通配符所匹配的段按名稱增序排列。

查看map文件，可以看到如下記錄：

.sdh_ble_observers
                0x0000000000030ae4       0x30
                0x0000000000030ae4                __sdh_ble_observers_start__ = .
                0x0000000000030ae4                __start_sdh_ble_observers = __sdh_ble_observers_start__
 *(SORT_BY_NAME(.sdh_ble_observers*))
 .sdh_ble_observers0
                0x0000000000030ae4        0x8 Output/ble_app_blinky_pca10040_s132 Debug/Obj/ble_conn_state.o
 .sdh_ble_observers1
                0x0000000000030aec        0x8 Output/ble_app_blinky_pca10040_s132 Debug/Obj/main.o
 .sdh_ble_observers1
                0x0000000000030af4        0x8 Output/ble_app_blinky_pca10040_s132 Debug/Obj/ble_conn_params.o
 .sdh_ble_observers2
                0x0000000000030afc       0x10 Output/ble_app_blinky_pca10040_s132 Debug/Obj/main.o

在map文件中，我們看到了多個(gè)名字相似的段.sdh_ble_observers[0, 1, 2]，它們擺列在一起，F(xiàn)lash地址前后相接，并且它們長(zhǎng)度之和等于.sdh_ble_observers段長(zhǎng)度。

可以認(rèn)為.sdh_ble_observers*是 .sdh_ble_observers的子段。

如何獲取段內(nèi)的數(shù)據(jù)呢？

一個(gè)是直接調(diào)用變量名，比如上面的my_var，另一種是通過(guò)段名，索引出其中的子段內(nèi)容。SDK中提供了段操作的函數(shù)庫(kù)nrf_section_iter， 如果已知一個(gè)段名，可以利用以下代碼獲取其中的子段內(nèi)容：

nrf_section_iter_t  iter;
for (nrf_section_iter_init(&iter, &my_section);
        nrf_section_iter_get(&iter) != NULL;
        nrf_section_iter_next(&iter))
{
    my_type_t     * p_section;
    p_section = (my_type_t*)nrf_section_iter_get(&iter);
}

三、BLE事件回調(diào)

以SDK15.1/ble_app_blinky工程為例， 追蹤它的BLE回調(diào)事件的調(diào)用邏輯。

在main.c –> ble_stack_init()中，調(diào)用了：

NRF_SDH_BLE_OBSERVER(m_ble_observer, APP_BLE_OBSERVER_PRIO, ble_evt_handler, NULL);

其中ble_evt_handler是我們?cè)O(shè)定的BLE事件回調(diào)函數(shù)。

NRF_SDH_BLE_OBSERVER是一個(gè)異常復(fù)雜嵌套宏，經(jīng)過(guò)層層解剖，該代碼變成如下形式：

static nrf_sdh_ble_evt_observer_t m_ble_observer __attribute__ ((section(".sdh_ble_observers3"))) __attribute__((used)) =
{
    .handler    =ble_evt_handler,
    .p_context  = NULL
};

這個(gè)代碼在 .sdh_ble_observers3 段中定義一個(gè)結(jié)構(gòu)體變量，并且將回調(diào)函數(shù)設(shè)定為參數(shù)。

那ble_evt_handler()是在什么地方調(diào)用的呢？

找到nrf_sdh_ble.c -> nrf_sdh_ble_evts_poll()，看見(jiàn)關(guān)鍵代碼：

nrf_section_iter_t  iter;
for (nrf_section_iter_init(&iter, &sdh_ble_observers);
        nrf_section_iter_get(&iter) != NULL;
        nrf_section_iter_next(&iter))
{
    nrf_sdh_ble_evt_observer_t * p_observer;
    nrf_sdh_ble_evt_handler_t    handler;


    p_observer = (nrf_sdh_ble_evt_observer_t *)nrf_section_iter_get(&iter);
    handler    = p_observer->handler;


    handler(p_ble_evt, p_observer->p_context);
}

這正是我們上面分析的，通過(guò)段名來(lái)獲取所有的子段內(nèi)容，然后執(zhí)行其回調(diào)函數(shù)。

仍然在該文件中，進(jìn)一步找到關(guān)鍵代碼：

NRF_SDH_STACK_OBSERVER(m_nrf_sdh_ble_evts_poll, NRF_SDH_BLE_STACK_OBSERVER_PRIO) =
{
    .handler   = nrf_sdh_ble_evts_poll,
    .p_context = NULL,
};

與上面類似，這是個(gè)嵌套宏，經(jīng)過(guò)層層解剖，得到如下代碼：

static nrf_sdh_stack_observer_t m_nrf_sdh_ble_evts_poll __attribute__ ((section(".sdh_stack_observers2"))) __attribute__((used)) =
{
    .handler    =nrf_sdh_ble_evts_poll,
    .p_context  = NULL
};

那 nrf_sdh_ble_evts_poll()是在什么地方調(diào)用的呢？

找到nrf_sdh.c -> nrf_sdh_evts_poll()，看見(jiàn)關(guān)鍵代碼：

for (nrf_section_iter_init(&iter, &sdh_stack_observers);
        nrf_section_iter_get(&iter) != NULL;
        nrf_section_iter_next(&iter))
{
    nrf_sdh_stack_observer_t    * p_observer;
    nrf_sdh_stack_evt_handler_t   handler;


    p_observer = (nrf_sdh_stack_observer_t *) nrf_section_iter_get(&iter);
    handler    = p_observer->handler;


    handler(p_observer->p_context);
}

進(jìn)一步，看到該函數(shù)的調(diào)用地點(diǎn)：

void SD_EVT_IRQHandler(void)
{
    nrf_sdh_evts_poll();
}

SD_EVT_IRQHandler是BLE事件的中斷處理函數(shù)，一旦芯片產(chǎn)生BLE事件，都會(huì)進(jìn)入到這個(gè)中斷處理函數(shù)中。按照上面的追蹤思路反向推導(dǎo)，就能夠調(diào)用到最初的ble_evt_handler回調(diào)函數(shù)。

至此我們搞清楚了BLE事件回調(diào)的跳轉(zhuǎn)邏輯。

四、幾處細(xì)節(jié)

（1）SD_EVT_IRQHandler 是什么

它是BLE事件中斷。

經(jīng)過(guò)多次重定義跳轉(zhuǎn)，我們找到它最初的名字：SWI2_EGU2_IRQHandler。

在ses_startup_nrf52.s文件中，看出它是一個(gè)中斷向量：

/* External Interrupts */
  .word   POWER_CLOCK_IRQHandler
  .word   RADIO_IRQHandler
  .word   UARTE0_UART0_IRQHandler
// ....
  .word   COMP_LPCOMP_IRQHandler
  .word   SWI0_EGU0_IRQHandler
  .word   SWI1_EGU1_IRQHandler
  .word   SWI2_EGU2_IRQHandler
  .word   SWI3_EGU3_IRQHandler

為什么它就代表了BLE的事件中斷呢？

在芯片手冊(cè)的Memory章節(jié)，找到Instantiation小節(jié)，列出了全部的中斷向量地址：

比較這個(gè)列表與上面的中斷向量定義，發(fā)現(xiàn)它們是一一對(duì)應(yīng)，嚴(yán)格按順序排列的。所以排到SWI2_EGU2_IRQHandler所在的位置，就代表了SWI2和EGU2的中斷向量，無(wú)論它取什么名字。

注意，SWI2和EGU2使用了同樣的向量地址，所以它們共享一個(gè)中斷向量，于是向量名稱寫(xiě)成SWI2_EGU2_IRQHandler。

（2）為什么要索引兩次

在nrf_sdh_evts_poll函數(shù)中，調(diào)用了 nrf_sdh_ble_evts_poll()，然后再調(diào)用我們的ble_evt_handler，為什么要索引兩次呢？

仔細(xì)看代碼發(fā)現(xiàn)，nrf_sdh_evts_poll處理了BLE和SOC兩種事件。而ble_evt_handler只是BLE事件。

這是因?yàn)镾WI2和EGU2這二者共享一個(gè)中斷向量，它們出了給出BLE事件中斷，還會(huì)給出SOC相關(guān)的中斷，比如時(shí)鐘Clock等。

（3）APP_BLE_OBSERVER_PRIO是什么

它代表了優(yōu)先級(jí)。

前面提到.ld文件中使用了SORT對(duì)所有子段進(jìn)行增序排列，優(yōu)先級(jí)數(shù)值小的排前面，大的排后面，在索引子段內(nèi)容時(shí)候，總是先執(zhí)行高優(yōu)先級(jí)（數(shù)值?。┑幕卣{(diào)函數(shù)，后執(zhí)行低優(yōu)先級(jí)（數(shù)值大）的回調(diào)函數(shù)，相同優(yōu)先級(jí)的回調(diào)則不能確定執(zhí)行順序。

（4）觀察者角色

在上面的分析中，NRF_SDH_BLE_OBSERVER意味著訂閱函數(shù)，main.c中的BLE處理相當(dāng)于一個(gè)觀察者。

SDK中將訂閱函數(shù)進(jìn)一步封裝成BLE_XXX_DEF()的宏形式，比如GATT的訂閱函數(shù)宏：

NRF_BLE_GATT_DEF(_name)

許多BLE庫(kù)都提供了訂閱函數(shù)宏，使用時(shí)候只需在main.c中聲明它們。

BLE通用訂閱函數(shù)宏：
#define BLE_ADVERTISING_DEF(_name)
#define BLE_DB_DISCOVERY_DEF(_name)
#define BLE_LINK_CTX_MANAGER_DEF()
#define NRF_BLE_SCAN_DEF(_name)
#define NRF_BLE_GATT_DEF(_name)
#define NRF_BLE_QWR_DEF(_name)


BLE Profile訂閱函數(shù)宏：
#define BLE_BAS_DEF(_name)
#define BLE_BPS_DEF(_name)
#define BLE_CSCS_DEF(_name)
#define BLE_GLS_DEF(_name)
#define BLE_HIDS_DEF()
#define BLE_HRS_DEF(_name)
#define BLE_HTS_DEF(_name)
#define BLE_LBS_DEF(_name)
...

如果我們創(chuàng)建一個(gè)自定義的Profile，也應(yīng)該提供一個(gè)這樣的訂閱函數(shù)宏。

nrf_sdh_ble_evts_poll和nrf_sdh_evts_poll相當(dāng)于通知函數(shù)，nrf_sdh.c和nrf_sdh_ble.c充當(dāng)主題角色。

發(fā)布者是芯片， SD_EVT_IRQHandler中斷就是發(fā)布者向主題推送數(shù)據(jù)接口。

五、驗(yàn)證

嘗試寫(xiě)一段代碼，驗(yàn)證這種段操作的觀察者模式。

先定義一個(gè)段：syq_sections

typedef void (*syq_handler_t)(uint8_t const evt_code, void * p_context);


typedef struct
{
    syq_handler_t         handler;      //!< BLE event handler.
    void *                p_context;    //!< A parameter to the event handler.
} const syq_type_t;


NRF_SECTION_SET_DEF(syq_sections, syq_type_t, NRF_SDH_BLE_OBSERVER_PRIO_LEVELS);

設(shè)定三個(gè)不同優(yōu)先級(jí)的段變量：

void syq_handler1(uint8_t const evt_code, void * p_context)
{
    NRF_LOG_INFO("handler1 is triggered");
}


static syq_type_t m_syq_1 __attribute__ ((section(".syq_sections1"))) __attribute__((used)) = 
{
    .handler    = syq_handler1,
    .p_context  = NULL
};


void syq_handler2(uint8_t const evt_code, void * p_context)
{
    NRF_LOG_INFO("handler2 is triggered");
}


static syq_type_t m_syq_2 __attribute__ ((section(".syq_sections2"))) __attribute__((used)) = 
{
    .handler    = syq_handler2,
    .p_context  = NULL
};


void syq_handler3(uint8_t const evt_code, void * p_context)
{
    NRF_LOG_INFO("handler3 is triggered");
}


static syq_type_t m_syq_3 __attribute__ ((section(".syq_sections3"))) __attribute__((used)) = 
{
    .handler    = syq_handler3,
    .p_context  = NULL
};

在主函數(shù)中執(zhí)行索引：

nrf_section_iter_t  iter;
for (nrf_section_iter_init(&iter, &syq_sections);
        nrf_section_iter_get(&iter) != NULL;
        nrf_section_iter_next(&iter)) {
    syq_type_t * p_observer;
    syq_handler_t    handler;


    p_observer = (syq_type_t *)nrf_section_iter_get(&iter);
    handler    = p_observer->handler;


    handler(1, p_observer->p_context);
}

這樣就可以依次執(zhí)行三個(gè)不同優(yōu)先級(jí)的回調(diào)函數(shù)，打印結(jié)果如下：

利用這套做法，實(shí)現(xiàn)了一個(gè)簡(jiǎn)單的觀察者模式。

審核編輯：劉清