@CHIP-RTOS C Library - RTOS API

Header File:         #include <RTOS.H>
                    which includes <RTXAPI.H>

This API provides access to the RTOS of the IPC@CHIP®.
For a general introduction about multitasking with the @CHIP-RTOS see Multitasking introduction. Please note that we cannot explain in detail all principles of a multitasking system in this document.
A good book for understanding the architecture of Real-Time-Kernels is "MicroC/OS" from Jean.J.Labrosse.

For some useful comments see also Programming notes.

Topics

RTOS API Overview
RTOS API Error Codes
RTOS API Developer Notes
RTOS API Examples Available
RTOS API Data Structures
IPC@CHIP® System Tasks

Task Control Functions

RTX_Create_Task	Create and start a task
RTX_Param_Task	Create and start a task with parameters
RTX_Create_Task_Without_Run	Create a task
RTX_Param_Task_Without_Run	Create a task with parameters
RTX_Delete_Task	Delete a task
RTX_Kill_Task	Stop and kill a task
RTX_Restart_Task	Start execution of task
RTX_End_Execution	End execution of current task
RTX_Sleep_Time	Sleep for a defined time
RTX_Sleep_Fine	Sleep for a number of RTI
RTX_Sleep_Long	Sleep for a long number of RTI
RTX_Sleep_Request	Sleep until wakeup request
RTX_Wakeup	Wakeup a sleeping task
RTX_Suspend_Task	Suspend execution of a task
RTX_Resume_Task	Resume execution of a suspended task
RTX_Get_TaskID	Get the ID of the current task
RTX_Change_TaskPrio	Deprecated! Change specified task's priority
RTX_Task_Priority	Read/write specified task's priority
RTX_Disable_Task_Scheduling	Disable task switching
RTX_Enable_Task_Scheduling	Re-enable task switching
RTX_Access_Filesystem	Reserve file system access by task
-- Task Monitoring -- RTX_Get_Task_List	Get list of current tasks
RTX_Get_Task_State	Get state of a task
RTX_Get_Task_State_Ext	Get state of a task
RTX_Start_Task_Monitor	Install task monitor.
RTX_Stop_Task_Monitor	Disable task monitoring
RTX_Count_Resources	Count available/used resources
RTX_Wait_Queue	Diagnostic routine

Semaphore Functions

RTX_Create_Sem	Create a semaphore
RTX_Delete_Sem	Delete a semaphore
RTX_Find_Sem	Find semaphore by name
-- For either type Semaphore -- RTX_Wait_Sem_Priority	Wait with specified priority
-- For Counting Semaphores -- RTX_Get_Sem	Get a counting semaphore, no wait
RTX_Wait_Sem	Wait on a counting semaphore
RTX_Signal_Sem	Signal a counting semaphore
-- For Resource Semaphores -- RTX_Reserve_Sem	Reserve a resource semaphore
RTX_Free_Sem	Set use count to zero
RTX_Release_Sem	Decrement use count by 1

Timing Functions

-- Time/Date -- RTX_Get_TimeDate	Get system time and date
RTX_Get_TimeDate_us	Get system time and date with high resolution
RTX_Set_TimeDate	Set system time and date
RTX_Set_TimeDate_us	Set system time and date with high resolution
-- System Time -- RTX_Get_System_Ticks	Get tick count of system clock
RTX_GetTickCount	Return tick count of system clock
RTX_GetTick_us	Return system clock microseconds
RTX_GetFineTick	Read system clock with high resolution
RTX_FineTickInit	Initialize for RTX_GetTickCount() use
RTX_Get_RTI_Ticks	Get Real-Time Interrupt count
RTX_Get_RTI_Rate	Get Real-Time Interrupt rate
-- RTX Timer Callbacks -- RTX_Install_Timer	Install timer procedure
RTX_Install_TimerP	Install timer procedure (alternate method)
RTX_Fine_Timer	Install high resolution timer
RTX_Fine_TimerP	Install high resolution timer (alternate method)
RTX_Remove_Timer	Remove timer procedure
RTX_Start_Timer	Start periodic execution of timer procedure
RTX_Stop_Timer	Stop periodic execution of timer procedure
RTX_Timer_Delay	Set timer delay milliseconds
RTX_Timer_Delay_RTI	Set timer delay RTI ticks
RTX_Install_RTI_Hook	Install callback to execute in real-time interrupt

Event Functions

RTX_Create_EventGroup	Create event group
RTX_Delete_EventGroup	Delete an event group
RTX_Signal_Events	Signal events group
RTX_Wait_For_Event	Wait for events
RTX_Wait_For_EventP	Wait for events (alternate method)
RTX_Get_EventGroup_State	Read current events on a group
RTX_Get_Saved_Events	Get the saved event flags/bits
RTX_Find_EventGroup	Find an event group

Message Functions

RTX_Create_Msg	Create message exchange
RTX_Delete_Msg	Delete a message exchange
RTX_Send_Msg	Send a message to a message exchange
RTX_Get_Msg	Get a message from a message exchange, no wait
RTX_Wait_For_Msg	Wait for a message, optional timeout
RTX_Wait_For_MsgP	Wait for a message, optional timeout (alternate method)
RTX_Find_Msg	Find a message exchange by name
-- Global Data Registry -- RTX_Publish	Post global publication
RTX_GetPublication	Find a global publication by name

List of C Libraries
@CHIP-RTOS Main Index