第11章 API 參考手冊(cè).doc
《第11章 API 參考手冊(cè).doc》由會(huì)員分享,可在線閱讀,更多相關(guān)《第11章 API 參考手冊(cè).doc(59頁(yè)珍藏版)》請(qǐng)?jiān)谘b配圖網(wǎng)上搜索。
參考手冊(cè)-321 OSInit( ) 第11章 參考手冊(cè) 本章提供了μC/OS-Ⅱ的用戶指南。每一個(gè)用戶可以調(diào)用的內(nèi)核函數(shù)都按字母順序加以說明,包括: l 函數(shù)的功能描述 l 函數(shù)原型 l 函數(shù)名稱及源代碼 l 函數(shù)使用到的常量 l 函數(shù)參數(shù) l 函數(shù)返回值 l 特殊說明和注意點(diǎn) Void OSInit(void); 所屬文件 調(diào)用者 開關(guān)量 OS_CORE.C 啟動(dòng)代碼 無 OSinit()初始化μC/OS-Ⅱ,對(duì)這個(gè)函數(shù)的調(diào)用必須在調(diào)用OSStart()函數(shù)之前,而OSStart()函數(shù)真正開始運(yùn)行多任務(wù)。 參數(shù) 無 返回值 無 注意/警告 必須先于OSStart()函數(shù)的調(diào)用 范例: void main (void) { . OSInit(); /* 初始化 uC/OS-II */ . OSStart(); /*啟動(dòng)多任務(wù)內(nèi)核 */ } OSIntEnter( ) Void OSIntEnter(void); 所屬文件 調(diào)用者 開關(guān)量 OS_CORE.C 中斷 無 OSIntEnter()通知μC/OS-Ⅱ一個(gè)中斷處理函數(shù)正在執(zhí)行,這有助于μC/OS-Ⅱ掌握中斷嵌套的情況。OSIntEnter()函數(shù)通常和OSIntExit()函數(shù)聯(lián)合使用。 參數(shù) 無 返回值 無 注意/警告 在任務(wù)級(jí)不能調(diào)用該函數(shù)。 如果系統(tǒng)使用的處理器能夠執(zhí)行自動(dòng)的獨(dú)立執(zhí)行讀取-修改-寫入的操作,那么就可以直接遞增中斷嵌套層數(shù)(OSIntNesting),這樣可以避免調(diào)用函數(shù)所帶來的額外的開銷。 范例一: (Intel 80x86的實(shí)模式, 在大模式下編譯,,real mode,large model) ISRx PROC FAR PUSHA ; 保存中斷現(xiàn)場(chǎng) PUSH ES PUSH DS ; MOV AX, DGROUP ; 讀入數(shù)據(jù)段 MOV DS, AX ; CALL FAR PTR _OSIntEnter ; 通知內(nèi)核進(jìn)入中斷 . . POP DS ; 恢復(fù)中斷現(xiàn)場(chǎng) POP ES POPA IRET ; 中斷返回 ISRx ENDP 范例二: (Intel 80x86的實(shí)模式, 在大模式下編譯,, real mode , large model) ISRx PROC FAR PUSHA ; 保存中斷現(xiàn)場(chǎng) PUSH ES PUSH DS ; MOV AX, DGROUP ; 讀入數(shù)據(jù)段 MOV DS, AX ; INC BYTE PTR _OSIntNesting ; 通知內(nèi)核進(jìn)入中斷 . . . POP DS ; 恢復(fù)中斷現(xiàn)場(chǎng) POP ES POPA IRET ; 中斷返回 ISRx ENDP OSIntExit( ) Void OSIntExit(void); 所屬文件 調(diào)用者 開關(guān)量 OS_CORE.C 中斷 無 OSIntExit()通知μC/OS-Ⅱ一個(gè)中斷服務(wù)已執(zhí)行完畢,這有助于μC/OS-Ⅱ掌握中斷嵌套的情況。通常OSIntExit()和OSIntEnter()聯(lián)合使用。當(dāng)最后一層嵌套的中斷執(zhí)行完畢后,如果有更高優(yōu)先級(jí)的任務(wù)準(zhǔn)備就緒,μC/OS-Ⅱ會(huì)調(diào)用任務(wù)調(diào)度函數(shù),在這種情況下,中斷返回到更高優(yōu)先級(jí)的任務(wù)而不是被中斷了的任務(wù)。 參數(shù) 無 返回值 無 注意/警告 在任務(wù)級(jí)不能調(diào)用該函數(shù)。并且即使沒有調(diào)用OSIntEnter()而是使用直接遞增OSIntNesting的方法,也必須調(diào)用OSIntExit()函數(shù)。 范例: (Intel 80x86 的實(shí)模式, 在大模式下編譯, real mode , large model) ISRx PROC FAR PUSHA ; 保存中斷現(xiàn)場(chǎng) PUSH ES PUSH DS . . CALL FAR PTR _OSIntExit ; 通知內(nèi)核進(jìn)入中斷 POP DS ; 恢復(fù)中斷現(xiàn)場(chǎng) POP ES POPA IRET ; 中斷返回 ISRx ENDP OSMboxAccept( ) Void *OSMboxAccept(OS_EVENT *pevent); 所屬文件 調(diào)用者 開關(guān)量 OS_MBOX.C 任務(wù)或中斷 OS_MBOX_EN OSMboxAccept()函數(shù)查看指定的消息郵箱是否有需要的消息。不同于OSMboxPend()函數(shù),如果沒有需要的消息,OSMboxAccept()函數(shù)并不掛起任務(wù)。如果消息已經(jīng)到達(dá),該消息被傳遞到用戶任務(wù)并且從消息郵箱中清除。通常中斷調(diào)用該函數(shù),因?yàn)橹袛嗖辉试S掛起等待消息。 參數(shù) pevent 是指向需要查看的消息郵箱的指針。當(dāng)建立消息郵箱時(shí),該指針返回到用戶程序。(參考OSMboxCreate()函數(shù))。 返回值 如果消息已經(jīng)到達(dá),返回指向該消息的指針;如果消息郵箱沒有消息,返回空指針。 注意/警告 必須先建立消息郵箱,然后使用。 范例: OS_EVENT *CommMbox; void Task (void *pdata) { void *msg; pdata = pdata; for (;;) { msg = OSMboxAccept(CommMbox); /* 檢查消息郵箱是否有消息 */ if (msg != (void *)0) { . /* 處理消息 */ . } else { . /*沒有消息 */ . } . . } } OSMboxCreate( ) OS_EVENT *OSMboxCreate(void *msg); 所屬文件 調(diào)用者 開關(guān)量 OS_MBOX.C 任務(wù)或啟動(dòng)代碼 OS_MBOX_EN OSMboxCreate()建立并初始化一個(gè)消息郵箱。消息郵箱允許任務(wù)或中斷向其他一個(gè)或幾個(gè)任務(wù)發(fā)送消息。 參數(shù) msg 參數(shù)用來初始化建立的消息郵箱。如果該指針不為空,建立的消息郵箱將含有消息。 返回值 指向分配給所建立的消息郵箱的事件控制塊的指針。如果沒有可用的事件控制塊,返回空指針。 注意/警告 必須先建立消息郵箱,然后使用。 范例: OS_EVENT *CommMbox; void main(void) { . . OSInit(); /* 初始化μC/OS-Ⅱ */ . . CommMbox = OSMboxCreate((void *)0); /* 建立消息郵箱 */ OSStart(); /* 啟動(dòng)多任務(wù)內(nèi)核 */ } OSMboxPend( ) Void *OSMboxPend ( OS_EVNNT *pevent, INT16U timeout, int8u *err ); 所屬文件 調(diào)用者 開關(guān)量 OS_MBOX.C 任務(wù) OS_MBOX_EN OSMboxPend()用于任務(wù)等待消息。消息通過中斷或另外的任務(wù)發(fā)送給需要的任務(wù)。消息是一個(gè)以指針定義的變量,在不同的程序中消息的使用也可能不同。如果調(diào)用OSMboxPend()函數(shù)時(shí)消息郵箱已經(jīng)存在需要的消息,那么該消息被返回給OSMboxPend()的調(diào)用者,消息郵箱中清除該消息。如果調(diào)用OSMboxPend()函數(shù)時(shí)消息郵箱中沒有需要的消息,OSMboxPend()函數(shù)掛起當(dāng)前任務(wù)直到得到需要的消息或超出定義等待超時(shí)的時(shí)間。如果同時(shí)有多個(gè)任務(wù)等待同一個(gè)消息,μC/OS-Ⅱ默認(rèn)最高優(yōu)先級(jí)的任務(wù)取得消息并且任務(wù)恢復(fù)執(zhí)行。一個(gè)由OSTaskSuspend()函數(shù)掛起的任務(wù)也可以接受消息,但這個(gè)任務(wù)將一直保持掛起狀態(tài)直到通過調(diào)用OSTaskResume()函數(shù)恢復(fù)任務(wù)的運(yùn)行。 參數(shù) pevent 是指向即將接受消息的消息郵箱的指針。該指針的值在建立該消息郵箱時(shí)可以得到。(參考OSMboxCreate()函數(shù))。 Timeout 允許一個(gè)任務(wù)在經(jīng)過了指定數(shù)目的時(shí)鐘節(jié)拍后還沒有得到需要的消息時(shí)恢復(fù)運(yùn)行。如果該值為零表示任務(wù)將持續(xù)的等待消息。最大的等待時(shí)間為65,535個(gè)時(shí)鐘節(jié)拍。這個(gè)時(shí)間長(zhǎng)度并不是非常嚴(yán)格的,可能存在一個(gè)時(shí)鐘節(jié)拍的誤差,因?yàn)橹挥性谝粋€(gè)時(shí)鐘節(jié)拍結(jié)束后才會(huì)減少定義的等待超時(shí)時(shí)鐘節(jié)拍。 Err 是指向包含錯(cuò)誤碼的變量的指針。OSMboxPend()函數(shù)返回的錯(cuò)誤碼可能為下述幾種: l OS_NO_ERR :消息被正確的接受。 l OS_TIMEOUT :消息沒有在指定的周期數(shù)內(nèi)送到。 l OS_ERR_PEND_ISR :從中斷調(diào)用該函數(shù)。雖然規(guī)定了不允許從中斷調(diào)用該函數(shù),但μC/OS-Ⅱ仍然包含了檢測(cè)這種情況的功能。 l OS_ERR_EVENT_TYPE :pevent 不是指向消息郵箱的指針。 返回值 OSMboxPend()函數(shù)返回接受的消息并將 *err置為OS_NO_ERR。如果沒有在指定數(shù)目的時(shí)鐘節(jié)拍內(nèi)接受到需要的消息,OSMboxPend()函數(shù)返回空指針并且將 *err設(shè)置為OS_TIMEOUT。 注意/警告 必須先建立消息郵箱,然后使用。 不允許從中斷調(diào)用該函數(shù)。 范例: OS_EVENT *CommMbox; void CommTask(void *pdata) { INT8U err; void *msg; pdata = pdata; for (;;) { . . msg = OSMboxPend(CommMbox, 10, &err); if (err == OS_NO_ERR) { . . /* 消息正確的接受 */ . } else { . . /* 在指定時(shí)間內(nèi)沒有接受到消息*/ . } . . } } OSMboxPost( ) INT8U OSMboxPost(OS_EVENT *pevent, void *msg); 所屬文件 調(diào)用者 開關(guān)量 OS_MBOX.C 任務(wù)或中斷 OS_MBOX_EN OSMboxPost()函數(shù)通過消息郵箱向任務(wù)發(fā)送消息。消息是一個(gè)指針長(zhǎng)度的變量,在不同的程序中消息的使用也可能不同。如果消息郵箱中已經(jīng)存在消息,返回錯(cuò)誤碼說明消息郵箱已滿。OSMboxPost()函數(shù)立即返回調(diào)用者,消息也沒有能夠發(fā)到消息郵箱。如果有任何任務(wù)在等待消息郵箱的消息,最高優(yōu)先級(jí)的任務(wù)將得到這個(gè)消息。如果等待消息的任務(wù)優(yōu)先級(jí)比發(fā)送消息的任務(wù)優(yōu)先級(jí)高,那么高優(yōu)先級(jí)的任務(wù)將得到消息而恢復(fù)執(zhí)行,也就是說,發(fā)生了一次任務(wù)切換。 參數(shù) pevent 是指向即將接受消息的消息郵箱的指針。該指針的值在建立該消息郵箱時(shí)可以得到。(參考OSMboxCreate()函數(shù))。 Msg 是即將實(shí)際發(fā)送給任務(wù)的消息。消息是一個(gè)指針長(zhǎng)度的變量,在不同的程序中消息的使用也可能不同。不允許傳遞一個(gè)空指針,因?yàn)檫@意味著消息郵箱為空。 返回值 OSMboxPost()函數(shù)的返回值為下述之一: l OS_NO_ERR :消息成功的放到消息郵箱中。 l OS_MBOX_FULL :消息郵箱已經(jīng)包含了其他消息,不空。 l OS_ERR_EVENT_TYPE :pevent 不是指向消息郵箱的指針。 注意/警告 必須先建立消息郵箱,然后使用。 不允許傳遞一個(gè)空指針,因?yàn)檫@意味著消息郵箱為空。 范例: OS_EVENT *CommMbox; INT8U CommRxBuf[100]; void CommTaskRx(void *pdata) { INT8U err; pdata = pdata; for (;;) { . err = OSMboxPost(CommMbox, (void *)&CommRxBuf[0]); . } } OSMboxQuery( ) INT8U OSMboxQuery(OS_EVENT *pevent, OS_MBOX_DATA *pdata); 所屬文件 調(diào)用者 開關(guān)量 OS_MBOX.C 任務(wù)或中斷 OS_MBOX_EN OSMboxQuery()函數(shù)用來取得消息郵箱的信息。用戶程序必須分配一個(gè)OS_MBOX_DATA的數(shù)據(jù)結(jié)構(gòu),該結(jié)構(gòu)用來從消息郵箱的事件控制塊接受數(shù)據(jù)。通過調(diào)用OSMboxQuery()函數(shù)可以知道任務(wù)是否在等待消息以及有多少個(gè)任務(wù)在等待消息,還可以檢查消息郵箱現(xiàn)在的消息。 參數(shù) pevent 是指向即將接受消息的消息郵箱的指針。該指針的值在建立該消息郵箱時(shí)可以得到。(參考OSMboxCreate()函數(shù))。 Pdata 是指向OS_MBOX_DATA數(shù)據(jù)結(jié)構(gòu)的指針,該數(shù)據(jù)結(jié)構(gòu)包含下述成員: Void *OSMsg; /* 消息郵箱中消息的復(fù)制 */ INT8U OSEventTbl[OS_EVENT_TBL_SIZE]; /*消息郵箱等待隊(duì)列的復(fù)制*/ INT8U OSEventGrp; 返回值 OSMboxQuery()函數(shù)的返回值為下述之一: l OS_NO_ERR :調(diào)用成功 l OS_ERR_EVENT_TYPE :pevent 不是指向消息郵箱的指針。 注意/警告 必須先建立消息郵箱,然后使用。 范例: OS_EVENT *CommMbox; void Task (void *pdata) { OS_MBOXDATA mbox_data; INT8U err; pdata = pdata; for (;;) { . err = OSMboxQuery(CommMbox, &mbox_data); if (err == OS_NO_ERR) { . /* 如果mbox_data.OSMsg為非空指針,說明消息郵箱非空*/ } . } } OSMemCreate( ) OS_MEM *OSMemCreate( void *addr, INT32U nblks ,INT32U blksize, INT8U *err); 所屬文件 調(diào)用者 開關(guān)量 OS_MEM.C 任務(wù)或初始代碼 OS_/MEM_EN OSMemCreate()函數(shù)建立并初始化一塊內(nèi)存區(qū)。一塊內(nèi)存區(qū)包含指定數(shù)目的大小確定的內(nèi)存塊。程序可以包含這些內(nèi)存塊并在用完后釋放回內(nèi)存區(qū)。 參數(shù) addr 建立的內(nèi)存區(qū)的起始地址。內(nèi)存區(qū)可以使用靜態(tài)數(shù)組或在初始化時(shí)使用malloc()函數(shù)建立。 Nblks 需要的內(nèi)存塊的數(shù)目。每一個(gè)內(nèi)存區(qū)最少需要定義兩個(gè)內(nèi)存塊。 Blksize 每個(gè)內(nèi)存塊的大小,最少應(yīng)該能夠容納一個(gè)指針。 Err 是指向包含錯(cuò)誤碼的變量的指針。OSMemCreate()函數(shù)返回的錯(cuò)誤碼可能為下述幾種: OS_NO_ERR :成功建立內(nèi)存區(qū)。 OS_MEM_INVALID_PART :沒有空閑的內(nèi)存區(qū)。 OS_MEM_INVALID_BLKS :沒有為每一個(gè)內(nèi)存區(qū)建立至少兩個(gè)內(nèi)存塊。 OS_MEM_INVALID_SIZE :內(nèi)存塊大小不足以容納一個(gè)指針變量。 返回值 OSMemCreate()函數(shù)返回指向內(nèi)存區(qū)控制塊的指針。如果沒有剩余內(nèi)存區(qū),OSMemCreate()函數(shù)返回空指針。 注意/警告 必須首先建立內(nèi)存區(qū),然后使用。 范例: OS_MEM *CommMem; INT8U CommBuf[16][128]; void main(void) { INT8U err; OSInit(); /* 初始化μC/OS-Ⅱ */ . CommMem = OSMemCreate(&CommBuf[0][0], 16, 128, &err); . OSStart(); /* 啟動(dòng)多任務(wù)內(nèi)核 */ } OSMemGet( ) Void *OSMemGet(OS_MEM *pmem, INT8U *err); 所屬文件 調(diào)用者 開關(guān)量 OS_MEM.C 任務(wù)或中斷 OS_MEM_EN OSMemGet()函數(shù)用于從內(nèi)存區(qū)分配一個(gè)內(nèi)存塊。用戶程序必須知道所建立的內(nèi)存塊的大小,同時(shí)用戶程序必須在使用完內(nèi)存塊后釋放內(nèi)存塊。可以多次調(diào)用OSMemGet()函數(shù)。 參數(shù) pmem 是指向內(nèi)存區(qū)控制塊的指針,可以從OSMemCreate()函數(shù)返回得到。 Err 是指向包含錯(cuò)誤碼的變量的指針。OSMemGet(函數(shù)返回的錯(cuò)誤碼可能為下述幾種: l OS_NO_ERR :成功得到一個(gè)內(nèi)存塊。 l OS_MEM_NO_FREE_BLKS :內(nèi)存區(qū)已經(jīng)沒有空間分配給內(nèi)存塊。 返回值 OSMemGet()函數(shù)返回指向內(nèi)存區(qū)塊的指針。如果沒有空間分配給內(nèi)存塊,OSMemGet()函數(shù)返回空指針。 注意/警告 必須首先建立內(nèi)存區(qū),然后使用。 范例: OS_MEM *CommMem; void Task (void *pdata) { INT8U *msg; pdata = pdata; for (;;) { msg = OSMemGet(CommMem, &err); if (msg != (INT8U *)0) { . /* 內(nèi)存塊已經(jīng)分配 */ . } . } } OSMemPut( ) INT8U OSMemPut( OS_MEM *pmem, void *pblk); 所屬文件 調(diào)用者 開關(guān)量 OS_MEM.C 任務(wù)或中斷 OS_MEM_EN OSMemPut()函數(shù)釋放一個(gè)內(nèi)存塊,內(nèi)存塊必須釋放回原先申請(qǐng)的內(nèi)存區(qū)。 參數(shù) pmem 是指向內(nèi)存區(qū)控制塊的指針,可以從OSMemCreate()函數(shù) 返回得到。 Pblk 是指向?qū)⒈会尫诺膬?nèi)存塊的指針。 返回值 OSMemPut()函數(shù)的返回值為下述之一: OS_NO_ERR :成功釋放內(nèi)存塊 OS_MEM_FULL :內(nèi)存區(qū)已經(jīng)不能再接受更多釋放的內(nèi)存塊。這種情況說明用戶程序出現(xiàn)了錯(cuò)誤,釋放了多于用OSMemGet()函數(shù)得到的內(nèi)存塊。 注意/警告 必須首先建立內(nèi)存區(qū),然后使用。 內(nèi)存塊必須釋放回原先申請(qǐng)的內(nèi)存區(qū)。 范例: OS_MEM *CommMem; INT8U *CommMsg; void Task (void *pdata) { INT8U err; pdata = pdata; for (;;) { err = OSMemPut(CommMem, (void *)CommMsg); if (err == OS_NO_ERR) { . /* 釋放內(nèi)存塊 */ } . } } OSMemQuery( ) INT8U OSMemQuery(OS_MEM *pmem, OS_MEM_DATA *pdata); 所屬文件 調(diào)用者 開關(guān)量 OS_MEM.C 任務(wù)或中斷 OS_MEM_EN OSMemQuery()函數(shù)得到內(nèi)存區(qū)的信息。該函數(shù)返回OS_MEM結(jié)構(gòu)包含的信息,但使用了一個(gè)新的OS_MEM_DATA的數(shù)據(jù)結(jié)構(gòu)。OS_MEM_DATA數(shù)據(jù)結(jié)構(gòu)還包含了正被使用的內(nèi)存塊數(shù)目的域。 參數(shù) pmem 是指向內(nèi)存區(qū)控制塊的指針,可以從OSMemCreate()函數(shù) 返回得到。 Pdata 是指向OS_MEM_DATA數(shù)據(jù)結(jié)構(gòu)的指針,該數(shù)據(jù)結(jié)構(gòu)包含了以下的域: Void OSAddr; /*指向內(nèi)存區(qū)起始地址的指針 */ Void OSFreeList; /*指向空閑內(nèi)存塊列表起始地址的指針 */ INT32U OSBlkSize; /*每個(gè)內(nèi)存塊的大小 */ INT32U OSNBlks; /*該內(nèi)存區(qū)的內(nèi)存塊總數(shù) */ INT32U OSNFree; /*空閑的內(nèi)存塊數(shù)目 */ INT32U OSNUsed; /*使用的內(nèi)存塊數(shù)目 */ 返回值 OSMemQuery()函數(shù)返回值總是OS_NO_ERR。 注意/警告 必須首先建立內(nèi)存區(qū),然后使用。 范例: OS_MEM *CommMem; void Task (void *pdata) { INT8U err; OS_MEM_DATA mem_data; pdata = pdata; for (;;) { . err = OSMemQuery(CommMem, &mem_data); . } } OSQAccept( ) Void *OSQAccept(OS_EVENT *pevent); 所屬文件 調(diào)用者 開關(guān)量 OS_Q.C 任務(wù)或中斷 OS_Q_EN OSQAccept()函數(shù)檢查消息隊(duì)列中是否已經(jīng)有需要的消息。不同于OSQPend()函數(shù),如果沒有需要的消息,OSQAccept()函數(shù)并不掛起任務(wù)。如果消息已經(jīng)到達(dá),該消息被傳遞到用戶任務(wù)。通常中斷調(diào)用該函數(shù),因?yàn)橹袛嗖辉试S掛起等待消息。 參數(shù) pevent 是指向需要查看的消息隊(duì)列的指針。當(dāng)建立消息隊(duì)列時(shí),該指針返回到用戶程序。(參考OSMboxCreate()函數(shù))。 返回值 如果消息已經(jīng)到達(dá),返回指向該消息的指針;如果消息隊(duì)列沒有消息,返回空指針。 注意/警告 必須先建立消息隊(duì)列,然后使用。 范例: OS_EVENT *CommQ; void Task (void *pdata) { void *msg; pdata = pdata; for (;;) { msg = OSQAccept(CommQ); /* 檢查消息隊(duì)列 */ if (msg != (void *)0) { . /* 處理接受的消息 */ . } else { . /* 沒有消息 */ } . } } OSQCreate( ) OS_EVENT *OSQCreate( void **start, INT8U size); 所屬文件 調(diào)用者 開關(guān)量 OS_Q.C 任務(wù)或啟動(dòng)代碼 OS_Q_EN OSQCreate()函數(shù)建立一個(gè)消息隊(duì)列。任務(wù)或中斷可以通過消息隊(duì)列向其他一個(gè)或多個(gè)任務(wù)發(fā)送消息。消息的含義是和具體的應(yīng)用密切相關(guān)的。 參數(shù) start 是消息內(nèi)存區(qū)的基地址,消息內(nèi)存區(qū)是一個(gè)指針數(shù)組。 Size 是消息內(nèi)存區(qū)的大小。 返回值 OSQCreate()函數(shù)返回一個(gè)指向消息隊(duì)列事件控制塊的指針。如果沒有空余的事件空閑塊,OSQCreate()函數(shù)返回空指針。 注意/警告 必須先建立消息隊(duì)列,然后使用。 范例: OS_EVENT *CommQ; void *CommMsg[10]; void main(void) { OSInit(); /* 初始化μC/OS-Ⅱ */ . . CommQ = OSQCreate(&CommMsg[0], 10); /*建立消息隊(duì)列 */ . OSStart(); /* 啟動(dòng)多任務(wù)內(nèi)核 */ } OSQFlush( ) INT8U *SOQFlush(OS_EVENT *pevent); 所屬文件 調(diào)用者 開關(guān)量 OS_Q.C 任務(wù)或中斷 OS_Q_EN OSQFlush()函數(shù)清空消息隊(duì)列并且忽略發(fā)送往隊(duì)列的所有消息。不管隊(duì)列中是否有消息,這個(gè)函數(shù)的執(zhí)行時(shí)間都是相同的。 參數(shù) pevent 是指向消息隊(duì)列的指針。該指針的值在建立該隊(duì)列時(shí)可以得到。(參考OSQCreate()函數(shù))。 返回值 OSQFlush()函數(shù)的返回值為下述之一: l OS_NO_ERR :消息隊(duì)列被成功清空 l OS_ERR_EVENT_TYPE :試圖清除不是消息隊(duì)列的對(duì)象 注意/警告 必須先建立消息隊(duì)列,然后使用。 范例: OS_EVENT *CommQ; void main(void) { INT8U err; OSInit(); /* 初始化μC/OS-Ⅱ */ . err = OSQFlush(CommQ); . OSStart(); /* 啟動(dòng)多任務(wù)內(nèi)核 */ } OSQPend( ) Void *OSQPend( OS_EVENT *pevent, INT16U timeout, INT8U *err); 所屬文件 調(diào)用者 開關(guān)量 OS_Q.C 任務(wù) OS_Q_EN OSQPend()函數(shù)用于任務(wù)等待消息。消息通過中斷或另外的任務(wù)發(fā)送給需要的任務(wù)。消息是一個(gè)以指針定義的變量,在不同的程序中消息的使用也可能不同。如果調(diào)用OSQPend()函數(shù)時(shí)隊(duì)列中已經(jīng)存在需要的消息,那么該消息被返回給OSQPend()函數(shù)的調(diào)用者,隊(duì)列中清除該消息。如果調(diào)用OSQPend()函數(shù)時(shí)隊(duì)列中沒有需要的消息,OSQPend()函數(shù)掛起當(dāng)前任務(wù)直到得到需要的消息或超出定義的超時(shí)時(shí)間。如果同時(shí)有多個(gè)任務(wù)等待同一個(gè)消息,μC/OS-Ⅱ默認(rèn)最高優(yōu)先級(jí)的任務(wù)取得消息并且任務(wù)恢復(fù)執(zhí)行。一個(gè)由OSTaskSuspend()函數(shù)掛起的任務(wù)也可以接受消息,但這個(gè)任務(wù)將一直保持掛起狀態(tài)直到通過調(diào)用OSTaskResume()函數(shù)恢復(fù)任務(wù)的運(yùn)行。 參數(shù) pevent 是指向即將接受消息的隊(duì)列的指針。該指針的值在建立該隊(duì)列時(shí)可以得到。(參考OSMboxCreate()函數(shù))。 Timeout 允許一個(gè)任務(wù)在經(jīng)過了指定數(shù)目的時(shí)鐘節(jié)拍后還沒有得到需要的消息時(shí)恢復(fù)運(yùn)行狀態(tài)。如果該值為零表示任務(wù)將持續(xù)的等待消息。最大的等待時(shí)間為65535個(gè)時(shí)鐘節(jié)拍。這個(gè)時(shí)間長(zhǎng)度并不是非常嚴(yán)格的,可能存在一個(gè)時(shí)鐘節(jié)拍的誤差,因?yàn)橹挥性谝粋€(gè)時(shí)鐘節(jié)拍結(jié)束后才會(huì)減少定義的等待超時(shí)時(shí)鐘節(jié)拍。 Err 是指向包含錯(cuò)誤碼的變量的指針。OSQPend()函數(shù)返回的錯(cuò)誤碼可能為下述幾種: l OS_NO_ERR :消息被正確的接受。 l OS_TIMEOUT :消息沒有在指定的周期數(shù)內(nèi)送到。 l OS_ERR_PEND_ISR :從中斷調(diào)用該函數(shù)。雖然規(guī)定了不允許從中斷調(diào)用該函數(shù),但μC/OS-Ⅱ仍然包含了檢測(cè)這種情況的功能。 l OS_ERR_EVENT_TYPE :pevent 不是指向消息隊(duì)列的指針。 返回值 OSQPend()函數(shù)返回接受的消息并將 *err置為OS_NO_ERR。如果沒有在指定數(shù)目的時(shí)鐘節(jié)拍內(nèi)接受到需要的消息,OSQPend()函數(shù)返回空指針并且將 *err設(shè)置為OS_TIMEOUT。 注意/警告 必須先建立消息郵箱,然后使用。 不允許從中斷調(diào)用該函數(shù)。 范例: OS_EVENT *CommQ; void CommTask(void *data) { INT8U err; void *msg; pdata = pdata; for (;;) { . . msg = OSQPend(CommQ, 100, &err); if (err == OS_NO_ERR) { . . /* 在指定時(shí)間內(nèi)接受到消息 */ . } else { . . /* 在指定的時(shí)間內(nèi)沒有接受到指定的消息 */ } . } } OSQPost( ) INT8U OSQPost(OS_EVENT *pevent, void *msg); 所屬文件 調(diào)用者 開關(guān)量 OS_Q.C 任務(wù)或中斷 OS_Q_EN OSQPost()函數(shù)通過消息隊(duì)列向任務(wù)發(fā)送消息。消息是一個(gè)指針長(zhǎng)度的變量,在不同的程序中消息的使用也可能不同。如果隊(duì)列中已經(jīng)存滿消息,返回錯(cuò)誤碼。OSQPost()函數(shù)立即返回調(diào)用者,消息也沒有能夠發(fā)到隊(duì)列。如果有任何任務(wù)在等待隊(duì)列中的消息,最高優(yōu)先級(jí)的任務(wù)將得到這個(gè)消息。如果等待消息的任務(wù)優(yōu)先級(jí)比發(fā)送消息的任務(wù)優(yōu)先級(jí)高,那么高優(yōu)先級(jí)的任務(wù)將得到消息而恢復(fù)執(zhí)行,也就是說,發(fā)生了一次任務(wù)切換。消息隊(duì)列是先入先出(FIFO)機(jī)制的,先進(jìn)入隊(duì)列的消息先被傳遞給任務(wù)。 參數(shù) pevent 是指向即將接受消息的消息隊(duì)列的指針。該指針的值在建立該隊(duì)列時(shí)可以得到。(參考OSQCreate()函數(shù))。 Msg 是即將實(shí)際發(fā)送給任務(wù)的消息。消息是一個(gè)指針長(zhǎng)度的變量,在不同的程序中消息的使用也可能不同。不允許傳遞一個(gè)空指針。 返回值 OSQPost()函數(shù)的返回值為下述之一: l OS_NO_ERR :消息成功的放到消息隊(duì)列中。 l OS_MBOX_FULL :消息隊(duì)列已滿。 l OS_ERR_EVENT_TYPE :pevent 不是指向消息隊(duì)列的指針。 注意/警告 必須先建立消息隊(duì)列,然后使用。 不允許傳遞一個(gè)空指針。 范例: OS_EVENT *CommQ; INT8U CommRxBuf[100]; void CommTaskRx(void *pdata) { INT8U err; pdata = pdata; for (;;) { . . err = OSQPost(CommQ, (void *)&CommRxBuf[0]); if (err == OS_NO_ERR) { . /* 將消息放入消息隊(duì)列 */ . } else { . /* 消息隊(duì)列已滿 */ . } . . } } OSQPostFront( ) INT8U OSQPostFront(OS_EVENT *pevent, void *msg); 所屬文件 調(diào)用者 開關(guān)量 OS_Q.C 任務(wù)或中斷 OS_Q_EN OSQPostFront()函數(shù)通過消息隊(duì)列向任務(wù)發(fā)送消息。OSQPostFront()函數(shù)和OSQPost()函數(shù)非常相似,不同之處在于OSQPostFront()函數(shù)將發(fā)送的消息插到消息隊(duì)列的最前端。也就是說,OSQPostFront()函數(shù)使得消息隊(duì)列按照后入先出(LIFO)的方式工作,而不是先入先出(FIFO)。消息是一個(gè)指針長(zhǎng)度的變量,在不同的程序中消息的使用也可能不同。如果隊(duì)列中已經(jīng)存滿消息,返回錯(cuò)誤碼。OSQPost()函數(shù)立即返回調(diào)用者,消息也沒能發(fā)到隊(duì)列。如果有任何任務(wù)在等待隊(duì)列中的消息,最高優(yōu)先級(jí)的任務(wù)將得到這個(gè)消息。如果等待消息的任務(wù)優(yōu)先級(jí)比發(fā)送消息的任務(wù)優(yōu)先級(jí)高,那么高優(yōu)先級(jí)的任務(wù)將得到消息而恢復(fù)執(zhí)行,也就是說,發(fā)生了一次任務(wù)切換 參數(shù) pevent 是指向即將接受消息的消息隊(duì)列的指針。該指針的值在建立該隊(duì)列時(shí)可以得到。(參考OSQCreate()函數(shù))。 Msg 是即將實(shí)際發(fā)送給任務(wù)的消息。消息是一個(gè)指針長(zhǎng)度的變量,在不同的程序中消息的使用也可能不同。不允許傳遞一個(gè)空指針。 返回值 OSQPost()函數(shù)的返回值為下述之一: l OS_NO_ERR :消息成功的放到消息隊(duì)列中。 l OS_MBOX_FULL :消息隊(duì)列已滿。 l OS_ERR_EVENT_TYPE :pevent 不是指向消息隊(duì)列的指針。 注意/警告 必須先建立消息隊(duì)列,然后使用。 不允許傳遞一個(gè)空指針。 范例: OS_EVENT *CommQ; INT8U CommRxBuf[100]; void CommTaskRx(void *pdata) { INT8U err; pdata = pdata; for (;;) { . err = OSQPostFront(CommQ, (void *)&CommRxBuf[0]); if (err == OS_NO_ERR) { . /* 將消息放入消息隊(duì)列 */ } else { . /* 消息隊(duì)列已滿 */ } . . } } OSQQuery( ) INT8U OSQQuery(OS_EVENT *pevent, OS_Q_DATA *pdata); 所屬文件 調(diào)用者 開關(guān)量 OS_Q.C 任務(wù)或中斷 OS_Q_EN OSQQuery()函數(shù)用來取得消息隊(duì)列的信息。用戶程序必須建立一個(gè)OS_Q_DATA的數(shù)據(jù)結(jié)構(gòu),該結(jié)構(gòu)用來保存從消息隊(duì)列的事件控制塊得到的數(shù)據(jù)。通過調(diào)用OSQQuery()函數(shù)可以知道任務(wù)是否在等待消息、有多少個(gè)任務(wù)在等待消息、隊(duì)列中有多少消息以及消息隊(duì)列可以容納的消息數(shù)。OSQQuery()函數(shù)還可以得到即將被傳遞給任務(wù)的消息的信息。 參數(shù) pevent 是指向即將接受消息的消息郵箱的指針。該指針的值在建立該消息郵箱時(shí)可以得到。(參考OSQCreate()函數(shù))。 Pdata 是指向OS_Q_DATA數(shù)據(jù)結(jié)構(gòu)的指針,該數(shù)據(jù)結(jié)構(gòu)包含下述成員: Void *OSMsg; /* 下一個(gè)可用的消息*/ INT16U OSNMsgs; /* 隊(duì)列中的消息數(shù)目*/ INT16U OSQSize; /* 消息隊(duì)列的大小 */ INT8U OSEventTbl[OS_EVENT_TBL_SIZE]; /* 消息隊(duì)列的等待隊(duì)列*/ INT8U OSEventGrp; 返回值 OSQQuery()函數(shù)的返回值為下述之一: l OS_NO_ERR :調(diào)用成功 l OS_ERR_EVENT_TYPE :pevent 不是指向消息隊(duì)列的指針。 注意/警告 必須先建立消息隊(duì)列,然后使用。 范例: OS_EVENT *CommQ; void Task (void *pdata) { OS_Q_DATA qdata; INT8U err; pdata = pdata; for (;;) { . . err = OSQQuery(CommQ, &qdata); if (err == OS_NO_ERR) { . /* 取得消息隊(duì)列的信息 */ } . . } } OSSchedLock( ) Void OSSchedLock(void); 所屬文件 調(diào)用者 開關(guān)量 OS_CORE.C 任務(wù)或中斷 N/A OSSchedLock()函數(shù)停止任務(wù)調(diào)度,只有使用配對(duì)的函數(shù)OSSchedUnlock()才能重新開始內(nèi)核的任務(wù)調(diào)度。調(diào)用OSSchedLock()函數(shù)的任務(wù)獨(dú)占CPU,不管有沒有其他高優(yōu)先級(jí)的就緒任務(wù)。在這種情況下,中斷仍然可以被接受和執(zhí)行(中斷必須允許)。OSSchedLock()函數(shù)和OSSchedUnlock()函數(shù)必須配對(duì)使用。μC/OS-Ⅱ可以支持多達(dá)254層的OSSchedLock()函數(shù)嵌套,必須調(diào)用同樣次數(shù)的OSSchedUnlock()函數(shù)才能恢復(fù)任務(wù)調(diào)度。 參數(shù) 無 返回值 無 注意/警告 任務(wù)調(diào)用了OSSchedLock()函數(shù)后,決不能再調(diào)用可能導(dǎo)致當(dāng)前任務(wù)掛起的系統(tǒng)函數(shù):OSTimeDly(),OSTimeDlyHMSM(),OSSemPend(),OSMboxPend(),OSQPend()。因?yàn)槿蝿?wù)調(diào)度已經(jīng)被禁止,其他任務(wù)不能運(yùn)行,這會(huì)導(dǎo)致系統(tǒng)死鎖。 范例: void TaskX(void *pdata) { pdata = pdata; for (;;) { . OSSchedLock(); /* 停止任務(wù)調(diào)度 */ . . /* 不允許被打斷的執(zhí)行代碼 */ . OSSchedUnlock(); /* 恢復(fù)任務(wù)調(diào)度 */ . } } OSSchedUnlock( ) Void OSSchedUnlock(void); 所屬文件 調(diào)用者 開關(guān)量 OS_CORE.C 任務(wù)或中斷 N/A 在調(diào)用了OSSchedLock()函數(shù)后,OSSchedUnlock()函數(shù)恢復(fù)任務(wù)調(diào)度。 參數(shù) 無 返回值 無 注意/警告 任務(wù)調(diào)用了OSSchedLock()函數(shù)后,決不能再調(diào)用可能導(dǎo)致當(dāng)前任務(wù)掛起的系統(tǒng)函數(shù):OSTimeDly(),OSTimeDlyHMSM(),OSSemPend(),OSMboxPend(),OSQPend()。因?yàn)槿蝿?wù)調(diào)度已經(jīng)被禁止,其他任務(wù)不能運(yùn)行,這會(huì)導(dǎo)致系統(tǒng)死鎖。 范例: void TaskX(void *pdata) { pdata = pdata; for (;;) { . OSSchedLock(); /* 停止任務(wù)調(diào)度 */ . . /* 不允許被打斷的執(zhí)行代碼 */ . OSSchedUnlock(); /* 恢復(fù)任務(wù)調(diào)度 */ . } } OSSemAccept( ) INT16U *OSSemAccept(OS_EVENT *pevent); 所屬文件 調(diào)用者 開關(guān)量 OS_SEM.C 任務(wù)或中斷 OS_SEM_EN OSSemAccept()函數(shù)查看設(shè)備是否就緒或事件是否發(fā)生。不同于OSSemPend()函數(shù),如果設(shè)備沒有就緒,OSSemAccept()函數(shù)并不掛起任務(wù)。中斷調(diào)用該函數(shù)來查詢信號(hào)量。 參數(shù) pevent 是指向需要查詢的設(shè)備的信號(hào)量。當(dāng)建立信號(hào)量時(shí),該指針返回到用戶程序。(參考OSSemCreate()函數(shù))。 返回值 當(dāng)調(diào)用OSSemAccept()函數(shù)時(shí),設(shè)備信號(hào)量的值大于零,說明設(shè)備就緒,這個(gè)值被返回調(diào)用者,設(shè)備信號(hào)量的值減一。如果調(diào)用OSSemAccept()函數(shù)時(shí),設(shè)備信號(hào)量的值等于零,說明設(shè)備沒有就緒,返回零。 注意/警告 必須先建立信號(hào)量,然后使用。 范例: OS_EVENT *DispSem; void Task (void *pdata) { INT16U value; pdata = pdata; for (;;) { value = OSSemAccept(DispSem); /*查看設(shè)備是否就緒或事件是否發(fā)生 */ if (value > 0) { . /* 就緒,執(zhí)行處理代碼 */ . } . . } } OSSemCreate( ) OS_EVENT *OSSemCreate(WORD value); 所屬文件 調(diào)用者 開關(guān)量 OS_SEM.C 任務(wù)或啟動(dòng)代碼 OS_SEM_EN OSSemCreate()函數(shù)建立并初始化一個(gè)信號(hào)量。信號(hào)量的作用如下: l 允許一個(gè)任務(wù)和其他任務(wù)或者中斷同步。 l 取得設(shè)備的使用權(quán) l 標(biāo)志事件的發(fā)生 參數(shù) value 參數(shù)是建立的信號(hào)量的初始值,可以取0到65535之間的任何值。 返回值 OSSemCreate()函數(shù)返回指向分配給所建立的消息郵箱的事件控制塊的指針。如果沒有可用的事件控制塊,OSSemCreate()函數(shù)返回空指針。 注意/警告 必須先建立信號(hào)量,然后使用。 范例: OS_EVENT *DispSem; void main(void) { . . OSInit(); /* 初始化μC/OS-Ⅱ */ . . DispSem = OSSemCreate(1); /* 建立顯示設(shè)備的信號(hào)量 */ . . OSStart();- 1.請(qǐng)仔細(xì)閱讀文檔,確保文檔完整性,對(duì)于不預(yù)覽、不比對(duì)內(nèi)容而直接下載帶來的問題本站不予受理。
- 2.下載的文檔,不會(huì)出現(xiàn)我們的網(wǎng)址水印。
- 3、該文檔所得收入(下載+內(nèi)容+預(yù)覽)歸上傳者、原創(chuàng)作者;如果您是本文檔原作者,請(qǐng)點(diǎn)此認(rèn)領(lǐng)!既往收益都?xì)w您。
下載文檔到電腦,查找使用更方便
5 積分
下載 |
- 配套講稿:
如PPT文件的首頁(yè)顯示word圖標(biāo),表示該P(yáng)PT已包含配套word講稿。雙擊word圖標(biāo)可打開word文檔。
- 特殊限制:
部分文檔作品中含有的國(guó)旗、國(guó)徽等圖片,僅作為作品整體效果示例展示,禁止商用。設(shè)計(jì)者僅對(duì)作品中獨(dú)創(chuàng)性部分享有著作權(quán)。
- 關(guān) 鍵 詞:
- 第11章 API 參考手冊(cè) 11
鏈接地址:http://m.jqnhouse.com/p-1574651.html