mtx_defs.h
来自「澳洲人写的Cortex,包括uC_IP协议栈」· C头文件 代码 · 共 218 行
H
218 行
<HTML><HEAD><TITLE>/home/asysweb/public_html/cortex/kernel/src/mtx_defs.h</TITLE></HEAD><BODY><pre><font color="#6920ac">/*************************************************************************/</font><font color="#6920ac">/* */</font><font color="#6920ac">/* Copyright (c) 1997-1999 Australian Real Time Embedded Systems */</font><font color="#6920ac">/* */</font><font color="#6920ac">/* PROPRIETARY RIGHTS of Australian Real Time Embedded Systems */</font><font color="#6920ac">/* are involved in the subject matter of this material. All reproduction,*/</font><font color="#6920ac">/* manufacturing, use, and sales rights pertaining to this subject matter*/</font><font color="#6920ac">/* are governed by the license agreement. The recipient of this software */</font><font color="#6920ac">/* implicitly accepts the terms of the license. */</font><font color="#6920ac">/* */</font><font color="#6920ac">/*************************************************************************/</font><font color="#6920ac">/************************************************************************* * * FILE NAME * * mtx_defs.h * * SYSTEM COMPONENT * * Mutex * * DESCRIPTION * * This file contains data and constant definitions for * Mutex Control Compenent. * * SCCS HISTORY * * @(#)mtx_defs.h 1.7, 01/25/99, 00:32:18 * * AUTHOR * * Vadim N. Azarovsky * * CREATED * * 04-Jun-1998 by Vadim N. Azarovsky * * REVISION HISTORY * * NAME DATE REMARKS * **************************************************************************/</font><b><font color='DarkGreen'>#ifndef</font></b><font color="maroon"> __MTX_DEFS__H</font><b><font color='DarkGreen'>#define</font></b> <font color="maroon"><a name="__MTX_DEFS__H">__MTX_DEFS__H</a></font><b><font color='DarkGreen'>#ifdef</font></b><font color="maroon"> __cplusplus</font><i>extern</i> <font color="DarkGreen">"C"</font> {<b><font color='DarkGreen'>#endif</font></b><font color="maroon"> <font color="#6920ac">/* __cplusplus */</font></font><b><font color='DarkGreen'>#include</font></b> <a href="crt_defs.h.FIND-INC"><font color="blue">"crt_defs.h"</font></a><b><font color='DarkGreen'>#include</font></b> <a href="rlq_defs.h.FIND-INC"><font color="blue">"rlq_defs.h"</font></a><b><font color='DarkGreen'>#include</font></b> <a href="tsk_defs.h.FIND-INC"><font color="blue">"tsk_defs.h"</font></a><font color="#6920ac">/*********************** * GLOBAL CONSTANSTS * ***********************/</font><b><font color='DarkGreen'>#define</font></b> <font color="maroon"><a name="MUTX_MUTEX_ID">MUTX_MUTEX_ID</a></font> 0x4D555458UL <font color="#6920ac">/* "MUTX" - mutex */</font><b><font color='DarkGreen'>#define</font></b> <font color="maroon"><a name="MUTX_CONDITION_ID">MUTX_CONDITION_ID</a></font> 0x4D545843UL <font color="#6920ac">/* "MTXC" - condition cntr block */</font><font color="#6920ac">/* * Return Codes */</font><b><font color='DarkGreen'>#define</font></b> <font color="maroon"><a name="MUTX_SUCCESS">MUTX_SUCCESS</a></font> CRTX_SUCCESS <font color="#6920ac">/* successful completion */</font><b><font color='DarkGreen'>#define</font></b> <font color="maroon"><a name="MUTX_ERR_INVALID_MUTEX">MUTX_ERR_INVALID_MUTEX</a></font> -1 <font color="#6920ac">/* invalid mutex */</font><b><font color='DarkGreen'>#define</font></b> <font color="maroon"><a name="MUTX_ERR_INVALID_CONDITION">MUTX_ERR_INVALID_CONDITION</a></font> -2 <font color="#6920ac">/* invalid condition */</font><font color="#6920ac">/* * MUTEX flags */</font><b><font color='DarkGreen'>#define</font></b> <font color="maroon"><a name="MUTX_FLAG_INIT">MUTX_FLAG_INIT</a></font> 0x00 <font color="#6920ac">/* initialisation flags */</font><b><font color='DarkGreen'>#define</font></b> <font color="maroon"><a name="MUTX_FLAG_MUTEX_ALLOC">MUTX_FLAG_MUTEX_ALLOC</a></font> 0x01 <font color="#6920ac">/* mutex control block is allocated */</font><b><font color='DarkGreen'>#define</font></b> <font color="maroon"><a name="MUTX_FLAG_COND_ALLOC">MUTX_FLAG_COND_ALLOC</a></font> 0x01 <font color="#6920ac">/* cond control block is allocated */</font><b><font color='DarkGreen'>#define</font></b> <font color="maroon"><a name="MUTX_FLAG_MUTEX_SUSP_POLICY">MUTX_FLAG_MUTEX_SUSP_POLICY</a></font> 0x02<b><font color='DarkGreen'>#define</font></b> <font color="maroon"><a name="MUTX_FLAG_COND_SUSP_POLICY">MUTX_FLAG_COND_SUSP_POLICY</a></font> 0x02<font color="#6920ac">/***************** * GLOBAL MACROS * *****************/</font><b><font color='DarkGreen'>#if</font></b><font color="maroon"> ENVI_CRTX_ERR_CHECK_LEVEL == 0</font><b><font color='DarkGreen'># define</font></b> <font color="maroon"><a name="MUTX_SET_MUTEX_ID">MUTX_SET_MUTEX_ID</a></font>(_mutex) <b><font color='DarkGreen'># define</font></b> <font color="maroon"><a name="MUTX_CHECK_MUTEX_ID">MUTX_CHECK_MUTEX_ID</a></font>(_mutex) (CRTX_TRUE)<b><font color='DarkGreen'># define</font></b> <font color="maroon"><a name="MUTX_SET_CONDITION_ID">MUTX_SET_CONDITION_ID</a></font>(_cond) <b><font color='DarkGreen'># define</font></b> <font color="maroon"><a name="MUTX_CHECK_CONDITION_ID">MUTX_CHECK_CONDITION_ID</a></font>(_cond) (CRTX_TRUE)<b><font color='DarkGreen'>#else</font></b><font color="maroon"></font><b><font color='DarkGreen'># define</font></b> <font color="maroon"><a name="MUTX_SET_MUTEX_ID">MUTX_SET_MUTEX_ID</a></font>(_mutex) ((_mutex)->CheckID=MUTX_MUTEX_ID)<b><font color='DarkGreen'># define</font></b> <font color="maroon"><a name="MUTX_CHECK_MUTEX_ID">MUTX_CHECK_MUTEX_ID</a></font>(_mutex) ((_mutex)->CheckID==MUTX_MUTEX_ID)<b><font color='DarkGreen'># define</font></b> <font color="maroon"><a name="MUTX_SET_CONDITION_ID">MUTX_SET_CONDITION_ID</a></font>(_cond) ((_cond)->CheckID=MUTX_CONDITION_ID)<b><font color='DarkGreen'># define</font></b> <font color="maroon"><a name="MUTX_CHECK_CONDITION_ID">MUTX_CHECK_CONDITION_ID</a></font>(_cond) ((_cond)->CheckID==MUTX_CONDITION_ID)<b><font color='DarkGreen'>#endif</font></b><font color="maroon"> <font color="#6920ac">/* ENVI_CRTX_ERR_CHECK_LEVEL == 0 */</font></font><font color="#6920ac">/*********************** * GLOBAL DATA TYPES * ***********************/</font><font color="#6920ac">/* condition key */</font><i><a name="mutx_Key_t">typedef</a></i> <i>crtx_Uint32_t</i> <i><font color='DarkBlue'>mutx_Key_t</font></i>;<font color="#6920ac">/* key compare function */</font><i><a name="mutx_KeyCompFunc_t">typedef</a></i> <i>crtx_Boolean_t</i> (*<i><font color='DarkBlue'>mutx_KeyCompFunc_t</font></i>)(<i>mutx_Key_t</i> WaitKey_a, <i>mutx_Key_t</i> ArgKey_a);<font color="#6920ac">/* * Mutex Attributes */</font><i><a name="mutx_Attr_t">typedef</a></i> <i>struct</i> { <i>crtx_SegNum_t</i> Segment; <font color="#6920ac">/* memory segment */</font> <i>task_SuspendPolicy_t</i> SuspendPolicy; <font color="#6920ac">/* suspend policy */</font>} <i><font color='DarkBlue'>mutx_Attr_t</font></i>;<font color="#6920ac">/* * Condition Attributes */</font><i><a name="mutx_CondAttr_t">typedef</a></i> <i>struct</i> { <i>crtx_SegNum_t</i> Segment; <font color="#6920ac">/* memory segment */</font> <i>task_SuspendPolicy_t</i> SuspendPolicy; <font color="#6920ac">/* suspend policy */</font>} <i><font color='DarkBlue'>mutx_CondAttr_t</font></i>;<font color="#6920ac">/* * Mutex control block */</font> <i><a name="mutx_Mutex_t">typedef</a></i> <i>struct</i> mutx_Mutex_s { <i>crtx_Int_t</i> MutexCounter; <font color="#6920ac">/* mutex counter */</font> <i>crtx_Int_t</i> Waiting; <font color="#6920ac">/* tasks on wating list */</font> <i>rque_Queue_t</i> WaitingList; <font color="#6920ac">/* entry waiting list */</font> <i>crtx_Int_t</i> Flags; <font color="#6920ac">/* flags */</font> <i>crtx_SegNum_t</i> Segment; <font color="#6920ac">/* memory segment */</font><b><font color='DarkGreen'>#if</font></b><font color="maroon"> ENVI_CRTX_ERR_CHECK_LEVEL > 0</font> <i>thrd_ID_t</i> Owner; <font color="#6920ac">/* owner of the mutex */</font> <i>crtx_Uint32_t</i> CheckID; <font color="#6920ac">/* object id (for error checking) */</font><b><font color='DarkGreen'>#endif</font></b><font color="maroon"> <font color="#6920ac">/* ENVI_CRTX_ERR_CHECK_LEVEL > 0 */</font></font>} <i><font color='DarkBlue'>mutx_Mutex_t</font></i>;<font color="#6920ac">/* * Condition control block */</font> <i><a name="mutx_Condition_t">typedef</a></i> <i>struct</i> mutx_Condition_s { <i>mutx_Mutex_t</i> *pMutex; <font color="#6920ac">/* mutex */</font> <i>rque_Queue_t</i> WaitingList; <font color="#6920ac">/* condition waiting list */</font> <i>crtx_Int_t</i> Flags; <font color="#6920ac">/* flags */</font> <i>crtx_SegNum_t</i> Segment; <font color="#6920ac">/* memory segment */</font><b><font color='DarkGreen'>#if</font></b><font color="maroon"> ENVI_CRTX_ERR_CHECK_LEVEL > 0</font> <i>crtx_Uint32_t</i> CheckID; <font color="#6920ac">/* object id (for error checking) */</font><b><font color='DarkGreen'>#endif</font></b><font color="maroon"> <font color="#6920ac">/* ENVI_CRTX_ERR_CHECK_LEVEL > 0 */</font></font>} <i><font color='DarkBlue'>mutx_Condition_t</font></i>;<font color="#6920ac">/***************** * GLOBAL DATA * *****************/</font><i>extern</i> <i>mutx_Attr_t</i> mutx_AttrDefault_g; <font color="#6920ac">/* default attribute */</font><i>extern</i> <i>mutx_CondAttr_t</i> mutx_CondAttrDefault_g; <font color="#6920ac">/* default attribute */</font><font color="#6920ac">/*************************** * PROCEDURES PROTOTYPES * ***************************/</font><font color="#6920ac">/* create/initialise mutex */</font><font size="+1"><i>mutx_Mutex_t</i> *<a href="mutx_Create.FIND-FUNC">mutx_Create</a>(<i>mutx_Mutex_t</i> *pMutex_a, <i>mutx_Attr_t</i> *pAttr_a);</font><font color="#6920ac">/* destroy mutex */</font><font size="+1"><i>crtx_Void_t</i> <a href="mutx_Delete.FIND-FUNC">mutx_Delete</a>(<i>mutx_Mutex_t</i> *pMutex_a);</font><font color="#6920ac">/* obtain mutex */</font><font size="+1"><i>crtx_Void_t</i> <a href="mutx_Lock.FIND-FUNC">mutx_Lock</a>(<i>mutx_Mutex_t</i> *pMutex_a);</font><font color="#6920ac">/* try to obtain Mutex */</font><font size="+1"><i>crtx_Boolean_t</i> <a href="mutx_Try.FIND-FUNC">mutx_Try</a>(<i>mutx_Mutex_t</i> *pMutex_a);</font><font color="#6920ac">/* relinquish Mutex */</font><font size="+1"><i>crtx_Void_t</i> <a href="mutx_Unlock.FIND-FUNC">mutx_Unlock</a>(<i>mutx_Mutex_t</i> *pMutex_a);</font><font color="#6920ac">/* create/initialise condition object assotiated with mutex */</font><font size="+1"><i>mutx_Condition_t</i> *<a href="mutx_CondCreate.FIND-FUNC">mutx_CondCreate</a>(<i>mutx_Condition_t</i> *pCondition_a, <i>mutx_Mutex_t</i> *pMutex_a, <i>mutx_CondAttr_t</i> *pAttr_a);</font><font color="#6920ac">/* destroy condition object */</font><font size="+1"><i>crtx_Status_t</i> <a href="mutx_CondDelete.FIND-FUNC">mutx_CondDelete</a>(<i>mutx_Condition_t</i> *pCondition_a);</font><font color="#6920ac">/* signal on condition (not more than one task is signaled) */</font><font size="+1"><i>crtx_Int_t</i> <a href="mutx_Signal.FIND-FUNC">mutx_Signal</a>(<i>mutx_Condition_t</i> *pCondition_a);</font><font color="#6920ac">/* signal on condition by key value (not more than one task is signaled) */</font><font size="+1"><i>crtx_Int_t</i> <a href="mutx_SignalByKey.FIND-FUNC">mutx_SignalByKey</a>(<i>mutx_Condition_t</i> *pCondition_a, <i>mutx_KeyCompFunc_t</i> CompFunc_a, <i>mutx_Key_t</i> Key_a);</font><font color="#6920ac">/* broadcast on condition by key value (returns number signalled tasks) */</font><font size="+1"><i>crtx_Int_t</i> <a href="mutx_BroadcastByKey.FIND-FUNC">mutx_BroadcastByKey</a>(<i>mutx_Condition_t</i> *pCondition_a, <i>mutx_KeyCompFunc_t</i> CompFunc_a, <i>mutx_Key_t</i> Key_a);</font><font color="#6920ac">/* broadcast signal (returns number signalled tasks) */</font><font size="+1"><i>crtx_Int_t</i> <a href="mutx_Broadcast.FIND-FUNC">mutx_Broadcast</a>(<i>mutx_Condition_t</i> *pCondition_a);</font><font color="#6920ac">/* wait for a signal */</font><font size="+1"><i>crtx_Boolean_t</i> <a href="mutx_Wait.FIND-FUNC">mutx_Wait</a>(<i>mutx_Condition_t</i> *pCondition_a, <i>tick_Timeout_t</i> *pTimeout_a, ... <font color="#6920ac">/* optional mutx_Key_t Key_a */</font>);</font><font color="#6920ac">/* ===== END OF THE DEFINITION FILE ===== */</font><b><font color='DarkGreen'>#ifdef</font></b><font color="maroon"> __cplusplus</font>}<b><font color='DarkGreen'>#endif</font></b><font color="maroon"> <font color="#6920ac">/* __cplusplus */</font></font><b><font color='DarkGreen'>#endif</font></b><font color="maroon"> <font color="#6920ac">/* __MTX_DEFS__H */</font></font></pre></BODY></HTML>⌨️ 快捷键说明
复制代码Ctrl + C
搜索代码Ctrl + F
全屏模式F11
增大字号Ctrl + =
减小字号Ctrl + -
显示快捷键?