IPC@CHIP® RTOS-PPC – API Documentation

Header image

Main page


RTX constants and macros


Detailed Description

The following constants are used in the RTX API.

Defines

#define RTX_TB_TICKS_PER_us   ((DWORD)gSysPublicData.tbRateMHz)
 Timing constant.
#define RTX_TB_TICKS_PER_ms   ((DWORD)gSysPublicData.tbRateMHz * 1000 )
 Timing constant.
#define RTX_TB_TICKS_PER_SEC   ((DWORD)gSysPublicData.tbRateMHz * 1000000 )
 Timing constant.
#define NO_PHY_ADDRESS   ((DWORD)-1)
 RTX_PhysAddr() return value for non-existant effective addresses.
#define RTX_CB_SUPV_FLAG   (0x2)
 Bit OR'ed into callback vectors to indicate Supervisor mode execution.
#define RTX_CB_SUPV_MODE(cb_vector, cb_type)   ((cb_type)((DWORD)cb_vector | RTX_CB_SUPV_FLAG))
 Used to specify a callback to be made in Supervisor mode.
#define RTX_TA_GATE_WAIT   (0x0001)
 This bit is applied to RtxTaskDefS::tkdAttr member in a bitwise OR fashion.
#define RTX_TA_TIME_SLICED   (0x0002)
 This bit is applied to RtxTaskDefS::tkdAttr member in a bitwise OR fashion.
#define RTX_TA_TIME_LIMIT   (0x0004)
 This bit is applied to RtxTaskDefS::tkdAttr member in a bitwise OR fashion.
#define RTX_TA_SUPV_MODE   (0x0008)
 This bit is applied to RtxTaskDefS::tkdAttr member in a bitwise OR fashion.
#define RTX_TA_PERIODIC   (0x0010)
 This bit is applied to RtxTaskDefS::tkdAttr member in a bitwise OR fashion.
#define RTX_TA_CATCH_UP   (0x0020)
 This bit is applied to RtxTaskDefS::tkdAttr member in a bitwise OR fashion.
#define RTX_TA_PERIOD_RTI   (0x0040)
 This bit is applied to RtxTaskDefS::tkdAttr member in a bitwise OR fashion.
#define RTX_TA_SET_PHASE   (0x0080)
 This bit is applied to RtxTaskDefS::tkdAttr member in a bitwise OR fashion.
#define RTX_TASK_PRIORITY_TOP   (2)
 Highest task priority permitted for user tasks.
#define RTX_TASK_PRIORITY_BOTTOM   (127)
 Lowest task priority for user tasks.
#define RTX_EVENT_MATCH_OR   (0)
 This value is applied to RTX_Wait_Event::match member.
#define RTX_EVENT_MATCH_AND   (1)
 This value is applied to RTX_Wait_Event::match member.
#define RTX_MON_RUNNING   (0x1)
 This value can appear in the sTASK_INFO::tiTaskMonStatus member.
#define RTX_MON_READY   (0x2)
 This value is applied to sTASK_INFO::tiTaskMonStatus member.
#define RTX_TRIG_WAIT   (0x0001)
 Flag from task state bit fields.
#define RTX_PERIOD_WAIT   (0x0002)
 Flag from task state bit fields.
#define RTX_SC_RTN_FLAG   (0x1)
 Flag bit used in RTX_DETAIL_TASK::dtIp member.
#define RTX_SUSPENDED   (0x0004)
 Flag from task state bit fields.
#define RTX_WAITING   (0x0008)
 Flag from task state bit fields.
#define RTX_SEMA_WAIT   (0x0100)
 Flag from task state bit fields.
#define RTX_EVENT_WAIT   (0x0200)
 Flag from task state bit fields.
#define RTX_MSG_XCHG_WAIT   (0x0400)
 Flag from task state bit fields.
#define RTX_TIMER_WAIT   (0x0800)
 Flag from task state bit fields.
#define RTX_BRKPT_WAIT   (0x1000)
 Flag from task state bit fields.
#define RTX_MAX_TIME_PERIOD   (0x7FFFFFFF)
 Task timing constant.
#define RTX_MAX_TIME_MS   (RTX_MAX_TIME_PERIOD / RTX_TB_TICKS_PER_ms)
 Upper limit on time-slice or task watchdog time-out.
#define RTX_PERIODIC_TASK_TIMER   ((RTX_TIMER_CALLBACK) (0x1))
 Value assigned to drCallback member of the RTX_DETAIL_TMR structure for periodic task timers.
#define KRTX_SEM_TYPE   (0)
 Type enumerator for RTX_DETAIL_SEM::dtType.
#define KRTX_TIMER_TYPE   (1)
 Type enumerator for RTX_DETAIL_TMR::dtType.
#define KRTX_EVENT_GROUP_TYPE   (2)
 Type enumerator for RTX_DETAIL_EVENT::dtType.
#define KRTX_MSG_XCHG_TYPE   (3)
 Type enumerator for RTX_DETAIL_MSGXCHG::dtType.
#define KRTX_TASK_TYPE   (4)
 Type enumerator for RTX_DETAIL_TASK::dtType.
#define RTX_FILT_SEM   0x7FFE
 Constant bitwise AND'ed for filter argument to RTX_Count_Resources() or RTX_Wait_Queue() API.
#define RTX_FILT_TIMER   0x7FFD
 Constant bitwise AND'ed for filter argument to RTX_Count_Resources() or RTX_Wait_Queue() API.
#define RTX_FILT_EVENT_GROUP   0x7FFB
 Constant bitwise AND'ed for filter argument to RTX_Count_Resources() or RTX_Wait_Queue() API.
#define RTX_FILT_MSGXCHG   0x7FF7
 Constant bitwise AND'ed for filter argument to RTX_Count_Resources() or RTX_Wait_Queue() API.
#define RTX_FILT_TASK   0x7FEF
 Constant bitwise AND'ed for filter argument to RTX_Count_Resources() or RTX_Wait_Queue() API.
#define RTX_REPORT_ALL   (0x0)
 Constant for filter argument to RTX_Count_Resources() or RTX_Wait_Queue() API.
#define PRIORITY_READ_ONLY   (0x5ABC)
 Constant for priority parameter to RTX_Task_Priority().
#define PRIORITY_APPLICATION   50
 Default priority of main() task in application programs.
#define FIXED_WAIT_PRIORITY   (20)
 Constant for RTX_Wait_Sem_Priority() wait_priority argument.
#define RTX_RESOURCE_SEM_PI_TYPE   (-2)
 Constant for RTX_NewSem() initvalue argument.
#define RTX_RESOURCE_SEM_TYPE   (-1)
 Constant for RTX_NewSem() initvalue argument.





Top of page | Main page

Copyright © 2017 Beck IPC GmbH
Generated on Thu Jan 26 16:21:36 2017 by Doxygen 1.6.1