1、介紹

本篇博文分享一個很實用的嵌入式代碼庫。
它可靈活應用到有無RTOS的程序中，采用C語言面向?qū)ο蟮乃悸穼崿F(xiàn)各個功能，盡可能最大化的復用代碼，目前為止工具包包含：循環(huán)隊列、軟件定時器、事件集。
網(wǎng)址：https://download.csdn.net/download/m0_38106923/87765476?spm=1001.2014.3001.5503

• Queue 循環(huán)隊列
  1. 支持動態(tài)、靜態(tài)方式進行隊列的創(chuàng)建與刪除。
  2. 可獨立配置緩沖區(qū)大小。
  3. 支持數(shù)據(jù)最新保持功能，當配置此模式并且緩沖區(qū)已滿，若有新的數(shù)據(jù)存入，將會移除最早數(shù)據(jù)，并保持緩沖區(qū)已滿。
• Timer 軟件定時器
  1. 支持動態(tài)、靜態(tài)方式進行定時器的創(chuàng)建與刪除。
  2. 支持循環(huán)、單次模式。
  3. 可配置有無超時回調(diào)函數(shù)。
  4. 可配置定時器工作在周期或間隔模式。
  5. 使用雙向鏈表，超時統(tǒng)一管理，不會因為增加定時器而增加超時判斷代碼。
• Event 事件集
  1. 支持動態(tài)、靜態(tài)方式進行事件集的創(chuàng)建與刪除。
  2. 每個事件最大支持32個標志位。
  3. 事件的觸發(fā)可配置為**“標志與”和“標志或”**。

2 、文件目錄

toolkit
├── include                         // 包含文件目錄
|   ├── toolkit.h                   // toolkit頭文件
|   └── toolkit_cfg.h               // toolkit配置文件
├── src                             // toolkit源碼目錄
|   ├── tk_queue.c                  // 循環(huán)隊列源碼
|   ├── tk_timer.c                  // 軟件定時器源碼
|   └── tk_event.c                  // 事件集源碼
├── samples                         // 例子
|   ├── tk_queue_samples.c          // 循環(huán)隊列使用例程源碼
|   ├── tk_timer_samples.c          // 軟件定時器使用例程源碼
|   └── tk_event_samples.c          // 事件集使用例程源碼
└── README.md                       // 說明文檔

3 、函數(shù)定義

3.1 配置文件

• ToolKit配置項

  宏定義	描述
  TOOLKIT_USING_ASSERT	ToolKit使用斷言功能
  TOOLKIT_USING_QUEUE	ToolKit使用循環(huán)隊列功能
  TOOLKIT_USING_TIMER	ToolKit使用軟件定時器功能
  TOOLKIT_USING_EVENT	ToolKit使用事件集功能

• Queue 循環(huán)隊列配置項

  宏定義	描述
  TK_QUEUE_USING_CREATE	Queue 循環(huán)隊列使用動態(tài)創(chuàng)建和刪除

• Timer 軟件定時器配置項

  宏定義	描述
  TK_TIMER_USING_CREATE	Timer 軟件定時器使用動態(tài)創(chuàng)建和刪除
  TK_TIMER_USING_INTERVAL	Timer 軟件定時器使用間隔模式
  TK_TIMER_USING_TIMEOUT_CALLBACK	Timer 軟件定時器使用超時回調(diào)函數(shù)

• Event 事件集配置項

  宏定義	描述
  TK_EVENT_USING_CREATE	Event 事件集使用動態(tài)創(chuàng)建和刪除

說明：當配置TOOLKIT_USING_ASSERT后，所有功能都將會啟動參數(shù)檢查。

3.2 Queue 循環(huán)隊列API函數(shù)

以下為詳細API說明及簡要示例程序，綜合demo可查看tk_queue_samples.c示例。

3.2.1 動態(tài)創(chuàng)建隊列

注意：當配置TOOLKIT_USING_QUEUE后，才能使用此函數(shù)。此函數(shù)需要用到malloc。

struct tk_queue *tk_queue_create(uint16_t queue_size, uint16_t max_queues, bool keep_fresh);

隊列創(chuàng)建示例：

int main(int argc, char *argv[])
{
    /* 動態(tài)方式創(chuàng)建一個循環(huán)隊"queue",緩沖區(qū)大小50字節(jié)，不保持最新 */
    struct tk_queue *queue = tk_queue_create(50, 1, false);
    if( queue == NULL){
        printf("隊列創(chuàng)建失敗!\n");
    }
    /* ... */
    /* You can add your code under here. */
    return 0;
}

3.2.2 動態(tài)刪除隊列

注意：當配置TOOLKIT_USING_QUEUE后，才能使用此函數(shù)。此函數(shù)需要用到free。必須為動態(tài)方式創(chuàng)建的隊列對象。

bool tk_queue_delete(struct tk_queue *queue);

3.2.3 靜態(tài)初始化隊列

bool tk_queue_init(struct tk_queue *queue, void *queuepool, uint16_t pool_size, uint16_t queue_size, bool keep_fresh);

隊列創(chuàng)建示例：

int main(int argc, char *argv[])
{
    /* 定義一個循環(huán)隊列 */
    struct tk_queue queue;
    /* 定義循環(huán)隊列緩沖區(qū) */
    uint8_t queue_pool[100];
    /* 靜態(tài)方式創(chuàng)建一個循環(huán)隊列"queue",緩存區(qū)為queue_pool，大小為queue_pool的大小,模式為保持最新 */
    if( tk_queue_init(&queue, queue_pool, sizeof(queue_pool), 
                      sizeof(queue_pool[0]), true) == false){
        printf("隊列創(chuàng)建失敗!\n");
    }
    /* ... */
    /* You can add your code under here. */
}

3.2.4 靜態(tài)脫離隊列

注意: 會使緩存區(qū)脫離與隊列的關聯(lián)。必須為靜態(tài)方式創(chuàng)建的隊列對象。

bool tk_queue_detach(struct tk_queue *queue);

3.2.5 清空隊列

bool tk_queue_clean(struct tk_queue *queue);

3.2.6 判斷隊列是否為空

bool tk_queue_empty(struct tk_queue *queue);

3.2.7 判斷隊列是否已滿

bool tk_queue_full(struct tk_queue *queue);

3.2.8 從隊列中讀取一個元素(不從隊列中刪除)

bool tk_queue_peep(struct tk_queue *queue, void *pval);

3.2.9 移除一個元素

bool tk_queue_remove(struct tk_queue *queue);

3.2.10 向隊列壓入(入隊)1個元素數(shù)據(jù)

bool tk_queue_push(struct tk_queue *queue, void *val);

3.2.11 從隊列彈出(出隊)1個元素數(shù)據(jù)

bool tk_queue_pop(struct tk_queue *queue, void *pval);

3.2.12 查詢隊列當前數(shù)據(jù)長度

uint16_t tk_queue_curr_len(struct tk_queue *queue);

3.2.13 向隊列壓入(入隊)多個元素數(shù)據(jù)

uint16_t tk_queue_push_multi(struct tk_queue *queue, void *pval, uint16_t len);

3.2.14 從隊列彈出(出隊)多個元素數(shù)據(jù)

uint16_t tk_queue_pop_multi(struct tk_queue *queue, void *pval, uint16_t len);

3.3 Timer 軟件定時器API函數(shù)

以下為詳細API說明及簡要示例程序，綜合demo可查看tk_timer_samples.c示例。

3.3.1 軟件定時器功能初始化

注意：此函數(shù)在使用定時器功能最初調(diào)用，目的是創(chuàng)建定時器列表頭結點，和配置tick獲取回調(diào)函數(shù)。

bool tk_timer_func_init(uint32_t (*get_tick_func)(void));

3.3.2 動態(tài)創(chuàng)建定時器

注意：當配置TOOLKIT_USING_TIMER后，才能使用此函數(shù)。此函數(shù)需要用到malloc。

struct tk_timer *tk_timer_create(void(*timeout_callback)(struct tk_timer *timer));

定時器創(chuàng)建示例：

/* 定義獲取系統(tǒng)tick回調(diào)函數(shù) */
uint32_t get_sys_tick(void)
{
    return tick;
}

/* 定時器超時回調(diào)函數(shù) */
void timer_timeout_callback(struct tk_timer *timer)
{
    printf("timeout_callback: timer timeout:%ld\n", get_sys_tick());
}

int main(int argc, char *argv[])
{
    /* 初始化軟件定時器功能，并配置tick獲取回調(diào)函數(shù)*/
    tk_timer_func_init(get_sys_tick);
    
    /* 定義定時器指針 */
    tk_timer_t timer = NULL;
    /* 動態(tài)方式創(chuàng)建timer,并配置定時器超時回調(diào)函數(shù) */
    timer = tk_timer_create((tk_timer_timeout_callback *)timer_timeout_callback);
    if (timer == NULL)
    {
        printf("定時器創(chuàng)建失敗!\n");
        return 0;
    }
    /* ... */
    /* You can add your code under here. */
    return 0;
}

3.3.3 動態(tài)刪除定時器

當配置TOOLKIT_USING_TIMER后，才能使用此函數(shù)。此函數(shù)需要用到free。必須為動態(tài)方式創(chuàng)建的定時器對象。

bool tk_timer_delete(struct tk_timer *timer);

3.3.4 靜態(tài)初始化定時器

bool tk_timer_init(struct tk_timer *timer, void (*timeout_callback)(struct tk_timer *timer));

隊列創(chuàng)建示例：

/* 定義獲取系統(tǒng)tick回調(diào)函數(shù) */
uint32_t get_sys_tick(void)
{
    return tick;
}

/* 定時器超時回調(diào)函數(shù) */
void timer_timeout_callback(struct tk_timer *timer)
{
    printf("timeout_callback: timer timeout:%ld\n", get_sys_tick());
}

int main(int argc, char *argv[])
{
    /* 定義定時器timer */
    struct tk_timer timer;
    bool result = tk_timer_init( &timer,(tk_timer_timeout_callback *)timer_timeout_callback);
    if (result == NULL)
    {
        printf("定時器創(chuàng)建失敗!\n");
        return 0;
    }
    /* ... */
    /* You can add your code under here. */
    return 0;
}

3.3.5 靜態(tài)脫離定時器

注意: 會將timer從定時器鏈表中移除。必須為靜態(tài)方式創(chuàng)建的定時器對象。

bool tk_timer_detach(struct tk_timer *timer);

3.3.6 定時器啟動

bool tk_timer_start(struct tk_timer *timer, tk_timer_mode mode, uint32_t delay_tick);

3.3.7 定時器停止

bool tk_timer_stop(struct tk_timer *timer);

3.3.8 定時器繼續(xù)

bool tk_timer_continue(struct tk_timer *timer);

3.3.9 定時器重啟

注意：重啟時長為最后一次啟動定時器時配置的時長。

bool tk_timer_restart(struct tk_timer *timer);

3.3.10 獲取定時器模式

tk_timer_mode tk_timer_get_mode(struct tk_timer *timer);

3.3.11 獲取定時器狀態(tài)

tk_timer_state tk_timer_get_state(struct tk_timer *timer);

3.3.12 定時器處理

bool tk_timer_loop_handler(void);

注意：tk_timer_loop_handler函數(shù)要不斷的循環(huán)調(diào)用。

3.3.13 超時回調(diào)函數(shù)

函數(shù)原型：

typedef void (*timeout_callback)(struct tk_timer *timer);

說明：超時回調(diào)函數(shù)可定義多個，即一個定時器對應一個回調(diào)函數(shù)，也可多個定時器對應一個回調(diào)函數(shù)。

• 一對一

  /* 定義兩個回調(diào)函數(shù)，對應定時器timer1和timer2 */
  void timer1_timeout_callback(struct tk_timer *timer){
  	printf("定時器1超時!\n");
  }
  void timer2_timeout_callback(struct tk_timer *timer){
  	printf("定時器2超時!\n");
  }
  /* 創(chuàng)建兩個定時器,配置單獨超時回調(diào)函數(shù) */
  timer1 = tk_timer_create((timeout_callback *)timer1_timeout_callback);
  timer2 = tk_timer_create((timeout_callback *)timer2_timeout_callback);
  

• 多對一

  /* 定時器timer1和timer2共用一個回調(diào)函數(shù)，在回調(diào)函數(shù)做區(qū)分 */
  void timer_timeout_callback(struct tk_timer *timer){
  	if (timer == timer1)
  		printf("定時器1超時!\n");
      else if (timer == timer2)
          printf("定時器2超時!\n");
  }
  /* 創(chuàng)建兩個定時器,使用相同的超時回調(diào)函數(shù) */
  timer1 = tk_timer_create((timeout_callback *)timer_timeout_callback);
  timer2 = tk_timer_create((timeout_callback *)timer_timeout_callback);
  

3.4 Event 事件集API函數(shù)

以下為詳細API說明及簡要示例程序，綜合demo可查看tk_event_samples.c示例。

3.4.1 動態(tài)創(chuàng)建一個事件

注意：當配置TOOLKIT_USING_EVENT后，才能使用此函數(shù)。此函數(shù)需要用到malloc。

struct tk_event *tk_event_create(void);

3.4.2 動態(tài)刪除一個事件

當配置TOOLKIT_USING_TIMER后，才能使用此函數(shù)。此函數(shù)需要用到free。必須為動態(tài)方式創(chuàng)建的事件對象。文章來源地址http://www.zghlxwxcb.cn/news/detail-437636.html

bool tk_event_delete(struct tk_event *event);

3.4.3 靜態(tài)初始化一個事件

bool tk_event_init(struct tk_event *event);

3.4.4 發(fā)送事件標志

bool tk_event_send(struct tk_event *event, uint32_t event_set);

3.4.5 接收事件

bool tk_event_recv(struct tk_event *event, uint32_t event_set, uint8_t option, uint32_t *recved);

到了這里，關于自定義循環(huán)隊列、軟件定時器、事件集，實用嵌入式代碼庫的文章就介紹完了。如果您還想了解更多內(nèi)容，請在右上角搜索TOY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關文章，希望大家以后多多支持TOY模板網(wǎng)！