nRF5 SDK從版本14開始，對事件回調機制做了更新，引入了觀察者模式，以解耦不同BLE Layer對BLE事件的回調函數。

實現這套機制用到了Flash的段（Section），將RAM中的函數調用與Flash中的段操作結合到一起，這個想法很新穎。

本文嘗試理解和追蹤整個回調過程，并寫一段代碼驗證我們的思路。

一、觀察者模式簡介

面向對象編程世界里有許多著名的設計模式，其中一種叫觀察者模式，它解決的問題是：在某場景下對象之間存在一對多的依賴關系，當中心對象的狀態發生改變，其他所有依賴于它的對象都能得到通知并自動更新。

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

多個觀察者可以獨立的訂閱（Subscribe）一個主題，當該主題收到發布者推送的數據，將數據通知（Notify）給各個觀察者進行后續處理。

實現觀察者模式，觀察者端需要實現一個訂閱功能，將自己的句柄和回調函數傳遞給主題。主機端應該有一個列表，所有訂閱它的觀察者句柄和回調函數都保存在該列表中，當需要通知時，則遍歷列表中的各個句柄，分別執行各自的回調函數。發布者給主題發數據，則簡單的暴露一個接口即可。

更進一步的，在代碼中要將句柄和回調函數封裝成一個結構體，這樣就可以方便傳參。觀察者準備一個函數，將該結構體保存到一個列表中，這個函數稱為訂閱。主題準備一個函數，讀取該列表，遍歷獲得各個結構體，并執行回調，這個函數稱為通知。

設計這個列表是關鍵。

最簡單的辦法是準備一個內存數組，訂閱函數即寫數組，通知函數即讀數組。

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

二、Flash段簡介

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

Flash的段是指在Flash中指定一塊空間，包含首地址和空間長度，并設定一個段名。段名以點（.）開頭。

C語言開發中經常提及的段有代碼段.text，常量段.rodata等。

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

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

還需要在內存布局文件中，設定好該段的起始地址和長度。編譯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__表示長度，xx_end__表示結束地址。

注意到一個關鍵行：KEEP(*(SORT(.sdh_ble_observers*)))。

該行使用了通配符，.sdh_ble_observers*末尾的星號表示任意字符，所以我們可能在代碼中看到形如.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文件中，我們看到了多個名字相似的段.sdh_ble_observers[0, 1, 2]，它們擺列在一起，Flash地址前后相接，并且它們長度之和等于.sdh_ble_observers段長度。

可以認為.sdh_ble_observers*是 .sdh_ble_observers的子段。

如何獲取段內的數據呢？

一個是直接調用變量名，比如上面的my_var，另一種是通過段名，索引出其中的子段內容。SDK中提供了段操作的函數庫nrf_section_iter， 如果已知一個段名，可以利用以下代碼獲取其中的子段內容：

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事件回調

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

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

NRF_SDH_BLE_OBSERVER(m_ble_observer, APP_BLE_OBSERVER_PRIO, ble_evt_handler, NULL);

其中ble_evt_handler是我們設定的BLE事件回調函數。

NRF_SDH_BLE_OBSERVER是一個異常復雜嵌套宏，經過層層解剖，該代碼變成如下形式：

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

這個代碼在 .sdh_ble_observers3 段中定義一個結構體變量，并且將回調函數設定為參數。

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

找到nrf_sdh_ble.c -> nrf_sdh_ble_evts_poll()，看見關鍵代碼：

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);
}

這正是我們上面分析的，通過段名來獲取所有的子段內容，然后執行其回調函數。

仍然在該文件中，進一步找到關鍵代碼：

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,
};

與上面類似，這是個嵌套宏，經過層層解剖，得到如下代碼：

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()是在什么地方調用的呢？

找到nrf_sdh.c -> nrf_sdh_evts_poll()，看見關鍵代碼：

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);
}

進一步，看到該函數的調用地點：

void SD_EVT_IRQHandler(void)
{
    nrf_sdh_evts_poll();
}

SD_EVT_IRQHandler是BLE事件的中斷處理函數，一旦芯片產生BLE事件，都會進入到這個中斷處理函數中。按照上面的追蹤思路反向推導，就能夠調用到最初的ble_evt_handler回調函數。

至此我們搞清楚了BLE事件回調的跳轉邏輯。

四、幾處細節

（1）SD_EVT_IRQHandler 是什么

它是BLE事件中斷。

經過多次重定義跳轉，我們找到它最初的名字：SWI2_EGU2_IRQHandler。

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

/* 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的事件中斷呢？

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

比較這個列表與上面的中斷向量定義，發現它們是一一對應，嚴格按順序排列的。所以排到SWI2_EGU2_IRQHandler所在的位置，就代表了SWI2和EGU2的中斷向量，無論它取什么名字。

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

（2）為什么要索引兩次

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

仔細看代碼發現，nrf_sdh_evts_poll處理了BLE和SOC兩種事件。而ble_evt_handler只是BLE事件。

這是因為SWI2和EGU2這二者共享一個中斷向量，它們出了給出BLE事件中斷，還會給出SOC相關的中斷，比如時鐘Clock等。

（3）APP_BLE_OBSERVER_PRIO是什么

它代表了優先級。

前面提到.ld文件中使用了SORT對所有子段進行增序排列，優先級數值小的排前面，大的排后面，在索引子段內容時候，總是先執行高優先級（數值小）的回調函數，后執行低優先級（數值大）的回調函數，相同優先級的回調則不能確定執行順序。

（4）觀察者角色

在上面的分析中，NRF_SDH_BLE_OBSERVER意味著訂閱函數，main.c中的BLE處理相當于一個觀察者。

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

NRF_BLE_GATT_DEF(_name)

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

BLE通用訂閱函數宏：
#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訂閱函數宏：
#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)
...

如果我們創建一個自定義的Profile，也應該提供一個這樣的訂閱函數宏。

nrf_sdh_ble_evts_poll和nrf_sdh_evts_poll相當于通知函數，nrf_sdh.c和nrf_sdh_ble.c充當主題角色。

發布者是芯片， SD_EVT_IRQHandler中斷就是發布者向主題推送數據接口。

五、驗證

嘗試寫一段代碼，驗證這種段操作的觀察者模式。

先定義一個段：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);

設定三個不同優先級的段變量：

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
};

在主函數中執行索引：

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);
}

這樣就可以依次執行三個不同優先級的回調函數，打印結果如下：

利用這套做法，實現了一個簡單的觀察者模式。

審核編輯：劉清