1、介紹

ToolKit是一套應(yīng)用于嵌入式系統(tǒng)的通用工具包，可靈活應(yīng)用到有無(wú)RTOS的程序中，采用C語(yǔ)言面向?qū)ο蟮乃悸穼?shí)現(xiàn)各個(gè)功能，盡可能最大化的復(fù)用代碼，目前為止工具包包含：循環(huán)隊(duì)列、軟件定時(shí)器、事件集。

??Queue?循環(huán)隊(duì)列

1. 支持動(dòng)態(tài)、靜態(tài)方式進(jìn)行隊(duì)列的創(chuàng)建與刪除。

2. 可獨(dú)立配置緩沖區(qū)大小。

3.?支持?jǐn)?shù)據(jù)最新保持功能，當(dāng)配置此模式并且緩沖區(qū)已滿(mǎn)，若有新的數(shù)據(jù)存入，將會(huì)移除最早數(shù)據(jù)，并保持緩沖區(qū)已滿(mǎn)。

??Timer?軟件定時(shí)器

1. 支持動(dòng)態(tài)、靜態(tài)方式進(jìn)行定時(shí)器的創(chuàng)建與刪除。

2.?支持循環(huán)、單次模式。

3. 可配置有無(wú)超時(shí)回調(diào)函數(shù)。

4.?可配置定時(shí)器工作在周期或間隔模式。

5. 使用雙向鏈表，超時(shí)統(tǒng)一管理，不會(huì)因?yàn)樵黾佣〞r(shí)器而增加超時(shí)判斷代碼。

??Event?事件集

1. 支持動(dòng)態(tài)、靜態(tài)方式進(jìn)行事件集的創(chuàng)建與刪除。

2.?每個(gè)事件最大支持32個(gè)標(biāo)志位。

3.?事件的觸發(fā)可配置為“標(biāo)志與”和“標(biāo)志或”。

2 、文件目錄

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

3 、函數(shù)定義

3.1 配置文件

??ToolKit配置項(xiàng)

??Queue 循環(huán)隊(duì)列配置項(xiàng)

??Timer 軟件定時(shí)器配置項(xiàng)

??Event 事件集配置項(xiàng)

說(shuō)明：當(dāng)配置TOOLKIT_USING_ASSERT后，所有功能都將會(huì)啟動(dòng)參數(shù)檢查。

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

以下為詳細(xì)API說(shuō)明及簡(jiǎn)要示例程序，綜合demo可查看tk_queue_samples.c示例。

3.2.1 動(dòng)態(tài)創(chuàng)建隊(duì)列

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

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

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

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

3.2.2?動(dòng)態(tài)刪除隊(duì)列

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

bool?tk_queue_delete(struct?tk_queue?*queue);

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

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

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

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

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

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

bool?tk_queue_detach(struct?tk_queue?*queue);

3.2.5 清空隊(duì)列

bool?tk_queue_clean(struct?tk_queue?*queue);

3.2.6 判斷隊(duì)列是否為空

bool?tk_queue_empty(struct?tk_queue?*queue);

3.2.7 判斷隊(duì)列是否已滿(mǎn)

bool?tk_queue_full(struct?tk_queue?*queue);

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

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

3.2.9 移除一個(gè)元素

bool?tk_queue_remove(struct?tk_queue?*queue);

3.2.10 向隊(duì)列壓入(入隊(duì))1個(gè)元素?cái)?shù)據(jù)

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

3.2.11 從隊(duì)列彈出(出隊(duì))1個(gè)元素?cái)?shù)據(jù)

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

3.2.12 查詢(xún)隊(duì)列當(dāng)前數(shù)據(jù)長(zhǎng)度

uint16_t?tk_queue_curr_len(struct?tk_queue?*queue);

3.2.13 向隊(duì)列壓入(入隊(duì))多個(gè)元素?cái)?shù)據(jù)

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

3.2.14 從隊(duì)列彈出(出隊(duì))多個(gè)元素?cái)?shù)據(jù)

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

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

以下為詳細(xì)API說(shuō)明及簡(jiǎn)要示例程序，綜合demo可查看tk_timer_samples.c示例。

3.3.1 軟件定時(shí)器功能初始化

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

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

3.3.2 動(dòng)態(tài)創(chuàng)建定時(shí)器

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

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

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

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

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

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

3.3.3 動(dòng)態(tài)刪除定時(shí)器

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

bool?tk_timer_delete(struct?tk_timer?*timer);

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

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

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

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

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

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

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

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

bool?tk_timer_detach(struct?tk_timer?*timer);

3.3.6 定時(shí)器啟動(dòng)

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

3.3.7 定時(shí)器停止

bool?tk_timer_stop(struct?tk_timer?*timer);

3.3.8 定時(shí)器繼續(xù)

bool?tk_timer_continue(struct?tk_timer?*timer);

3.3.9 定時(shí)器重啟

注意：重啟時(shí)長(zhǎng)為最后一次啟動(dòng)定時(shí)器時(shí)配置的時(shí)長(zhǎng)。

bool?tk_timer_restart(struct?tk_timer?*timer);

3.3.10 獲取定時(shí)器模式

tk_timer_mode?tk_timer_get_mode(struct?tk_timer?*timer);

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

tk_timer_state?tk_timer_get_state(struct?tk_timer?*timer);

3.3.12 定時(shí)器處理

bool?tk_timer_loop_handler(void);

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

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

函數(shù)原型：

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

說(shuō)明：超時(shí)回調(diào)函數(shù)可定義多個(gè)，即一個(gè)定時(shí)器對(duì)應(yīng)一個(gè)回調(diào)函數(shù)，也可多個(gè)定時(shí)器對(duì)應(yīng)一個(gè)回調(diào)函數(shù)。

一對(duì)一

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

多對(duì)一

/*?定時(shí)器timer1和timer2共用一個(gè)回調(diào)函數(shù)，在回調(diào)函數(shù)做區(qū)分?*/
void?timer_timeout_callback(struct?tk_timer?*timer){
????if?(timer?==?timer1)
????????printf("定時(shí)器1超時(shí)!
");
????else?if?(timer?==?timer2)
????????printf("定時(shí)器2超時(shí)!
");
}
/*?創(chuàng)建兩個(gè)定時(shí)器,使用相同的超時(shí)回調(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ù)

以下為詳細(xì)API說(shuō)明及簡(jiǎn)要示例程序，綜合demo可查看tk_event_samples.c示例。

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

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

struct?tk_event?*tk_event_create(void);

3.4.2 動(dòng)態(tài)刪除一個(gè)事件

當(dāng)配置TOOLKIT_USING_TIMER后，才能使用此函數(shù)。此函數(shù)需要用到free。必須為動(dòng)態(tài)方式創(chuàng)建的事件對(duì)象。

bool?tk_event_delete(struct?tk_event?*event);

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

bool?tk_event_init(struct?tk_event?*event);

3.4.4 發(fā)送事件標(biāo)志

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

編輯：黃飛

?