PIC24 en:osa:ref:allservices

OSA : OS_Bsem_Check

2010-10-07T13:56:05+03:00

OSA : OS_Bsem_Reset

2010-10-07T13:56:06+03:00

OSA : OS_Bsem_Set

2009-06-30T19:22:32+03:00

OSA : OS_Bsem_Set

OS_Bsem_Set (bsem)

(Same as OS_Bsem_Signal)

Signal binary semaphore.

Parametrs:

bsem Binary semaphore's ID. Number of binary semaphores is set by OS_BSEMS constant in OSAcfg.h

Example:

void Task (void)
{
    for (;;) {
        /*...*/
        OS_Bsem_Set(3);  // Set binari semaphore #3
        /*...*/
    }
}

OSA : OS_Bsem_Signal

2010-10-07T13:56:08+03:00

OSA : OS_Bsem_Switch

2010-10-07T13:56:09+03:00

OSA : OS_Bsem_Wait

2010-10-07T13:56:09+03:00

OSA : OS_Bsem_Wait_TO

2010-10-07T13:56:10+03:00

OSA : OS_Cond_Wait

2009-06-28T23:28:57+03:00

OSA : OS_Cond_Wait

OSA : OS_Cond_Wait_TO

2009-06-28T23:27:42+03:00

OSA : OS_Cond_Wait_TO

OS_Cond_Wait_TO (condition, timeout)

See OS_Wait_TO

OSA : OS_Csem_Accept

2010-10-07T13:56:13+03:00

OSA : OS_Csem_Check

2010-10-07T13:56:14+03:00

OSA : OS_Csem_Create

2010-10-07T13:56:15+03:00

OSA : OS_Csem_Reset

2010-10-07T13:56:16+03:00

OSA : OS_Csem_Set

2010-10-07T13:56:16+03:00

OSA : OS_Csem_SetValue

2010-10-07T13:56:17+03:00

OSA : OS_Csem_Signal

2009-12-12T02:24:32+03:00

OSA : OS_Csem_Signal

OS_Csem_Signal (csem)

Increase counting semaphore's value by 1. If semaphore can not be increased (already at maximum) then task switches to waiting state until some another task will decrease semaphore's value

OS_ENABLE_CSEM constant must be defined in OSAcfg.h. Size of counting semaphores defined by OS_CSEM_SIZE constant

For PIC16 counting semaphores can be allocated only in bank0 or bank1

Parametrs:

csem Counting semaphore. Variable of OST_CSEM type

Example:

OST_CSEM csem;
 
void Task (void)
{
    for (;;) {
        /*...*/
        OS_Csem_Signal(csem);
        /*...*/
    }
}

OSA : OS_Csem_Signal_Now

2009-12-12T02:41:59+03:00

OSA : OS_Csem_Signal_Now

OS_Csem_Signal_Now (csem)
OS_Csem_Signal_Now_I (csem)

Increase counting semaohore's value by 1. If counting semaphore already has maximum value, then after service execution service OS_IsEventError will return true.

OS_ENABLE_CSEM constant must be defined in OSAcfg.h. Size of counting semaphores defined by OS_CSEM_SIZE constant

For PIC16 counting semaphores can be allocated only in bank0 or bank1

Parametrs:

csem Counting semaphore. Variable of OST_CSEM type

Returns:

OS_IsEventError() returns true if counting semaphore already has maximum value

Example:

OST_CSEM csem;
 
void Task (void)
{
    for (;;) {
        /*...*/
        OS_Csem_Signal(csem);
        /*...*/
    }
}

OSA : OS_Csem_Wait

2010-10-07T13:56:20+03:00

OSA : OS_Csem_Wait_TO

2010-10-07T13:56:21+03:00

OSA : OS_Delay

2010-10-07T13:56:21+03:00

OSA : OS_DI

2010-10-07T13:56:22+03:00

OSA : OS_Dtimer_Add

2010-02-04T19:56:10+03:00

OSA : OS_Dtimer_Add

OS_Dtimer_Add (dtimer, addtime)

Increase time of dinamic timer counter. Timeout flag will remain unchanged.

OS_ENABLE_DTIMERS constant must be defined in OSAcfh.h. Size of dynamic timers set by OS_DTIMER_SIZE constant

Parametrs:

`dtimer`	Descriptor of dynamic timer. Variable of OST_DTIMER type. Contains timer counter, timer's state frags and pointer to next timer in linst. For PIC16 can be allocated only in bank0 or bank1
`addtime`	Value to be added to timer's counter. Sets in system ticks - call OS_Timer periods. Size of time value must be less than size of timer

Example:

OST_DTIMER dtimer;
 
void Task (void)
{
    for (;;) {
        OS_Dtimer_Run(dtimer, 100);   // Run 100 ticks timer
        /*...*/
        OS_Dtimer_Add(dtimer, 50);    // Add 50 ticks
        /*...*/
    }
}

OSA : OS_Dtimer_Break

2010-02-04T20:03:55+03:00

OSA : OS_Dtimer_Break

OS_Dtimer_Break (dtimer)

Stop dinamic timer. Timer will stay active but will not incremented in OS_Timer(). Timeout flag became set (service OS_Dtimer_Pausep remains timeout flag unchanged).

OS_ENABLE_DTIMERS constant must be defined in OSAcfh.h. Size of dynamic timers set by OS_DTIMER_SIZE constant

dtimer Descriptor of dynamic timer. Variable of OST_DTIMER type. Contains timer counter, timer's state frags and pointer to next timer in linst. For PIC16 can be allocated only in bank0 or bank1

Returns:

nothing

Example:

OST_DTIMER dtimer;
 
void Task (void)
{
    for (;;) {
        /*...*/
        OS_Dtimer_Break(dtimer);
        /*...*/
    }
}

Old style name

OSA : OS_Dtimer_Check

2010-10-07T13:56:25+03:00

OSA : OS_Dtimer_Continue

2010-02-04T19:55:55+03:00

OSA : OS_Dtimer_Continue

OS_Dtimer_Continue (dtimer)

Continue dinamic timer's counting after pause.

OS_ENABLE_DTIMERS constant must be defined in OSAcfh.h. Size of dynamic timers set by OS_DTIMER_SIZE constant

Call allowed:

Everywere

Parametrs:

Returns:

nothing

Example:

OST_DTIMER dtimer;
 
void Task (void)
{
    for (;;) {
        /*...*/
        OS_Dtimer_Pause(dtimer);      // Pause
        /*...*/
        OS_Dtimer_Continue(dtimer);   // Continue
        /*...*/
    }
}

Old style name

OS_ContinueDTimer

OSA : OS_Dtimer_Create

2010-02-04T19:54:34+03:00

OSA : OS_Dtimer_Create

OS_Dtimer_Create (dtimer)

Adds dinamic timer dtimer in active timers list. After creation timer is zeroed, timeout flag is cleared.

OS_ENABLE_DTIMERS constant must be defined in OSAcfh.h. Size of dynamic timers set by OS_DTIMER_SIZE constant

Call allowed:

Not in interrupt

Parametrs:

Returns:

nothing

Example:

OST_DTIMER dtimer;
 
void Task (void)
{
    OS_Dtimer_Create (dtimer);
    for (;;) {
        /*...*/
        /*...*/
    }
}

Old style name

OS_CreateDTimer

OSA : OS_Dtimer_Delay

2010-02-04T19:55:14+03:00

OSA : OS_Dtimer_Delay

OS_Dtimer_Delay (dtimer, delay)

Delay current task using dinamic timer.

OS_ENABLE_DTIMERS constant must be defined in OSAcfh.h. Size of dynamic timers set by OS_DTIMER_SIZE constant

Call allowed:

Only in task

Parametrs:

`dtimer`	Descriptor of dynamic timer. Variable of OST_DTIMER type. Contains timer counter, timer's state frags and pointer to next timer in linst. For PIC16 can be allocated only in bank0 or bank1
`delay`	Time of delay. Set in system ticks - call OS_Timer periods

Returns:

nothing

Example:

OST_DTIMER dtimer;
 
void Task (void)
{
    OS_Dtimer_Create(dtimer);
    for (;;) {
        /*...*/
        OS_Dtimer_Delay (dtimer, 100);  // Delay task for 100 system ticks
        /*...*/
    }
}

Old style name

OS_DelayDTimer

OSA : OS_Dtimer_Delete

2010-02-04T19:54:44+03:00

OSA : OS_Dtimer_Delete

OS_Dtimer_Delete (dtimer)

Delete dinamic timer from list of timers.

OS_ENABLE_DTIMERS constant must be defined in OSAcfh.h. Size of dynamic timers set by OS_DTIMER_SIZE constant

Call allowed:

Not in interrupt

Parametrs:

Returns:

nothing

Example:

OST_DTIMER dtimer;
 
void Task (void)
{
    OS_Dtimer_Create(dtimer);       // Add timer in list
    for (;;) {
        /*...*/
        OS_Dtimer_Delete (dtimer);  // Delete timer from list before destroying task
        OS_Task_Stop();             // Destroy task
        /*...*/
    }
}

Old style name

OS_DeleteDTimer

OSA : OS_Dtimer_Get

2010-10-07T13:56:29+03:00

OSA : OS_Dtimer_IsActive

2010-02-04T19:56:18+03:00

OSA : OS_Dtimer_IsActive

bool OS_Dtimer_IsActive (dtimer)

Check for dinamic timer is present in list of timers.

OS_ENABLE_DTIMERS constant must be defined in OSAcfh.h. Size of dynamic timers set by OS_DTIMER_SIZE constant

Call allowed:

Everywere

Parametrs:

Returns:

`false`	there is no specified dtimer is list of timers
`true`	dtimer is in list

Example:

OST_DTIMER dtimer;
 
void Task (void)
{
    for (;;) {
        /*...*/
        if (!OS_Dtimer_IsActive (dtimer)) // If timer not in list
            OS_Dtimer_Create(dtimer);     // then add it
        /*...*/
    }
}

Old style name

OS_IsDTimerActive

OSA : OS_Dtimer_IsRun

2010-10-07T13:56:30+03:00

OSA : OS_Dtimer_IsStopped

2010-02-04T19:56:25+03:00

OSA : OS_Dtimer_IsStopped

bool OS_Dtimer_IsStopped (dtimer)

Check for dinamic timer is stopped.

OS_ENABLE_DTIMERS constant must be defined in OSAcfh.h. Size of dynamic timers set by OS_DTIMER_SIZE constant

Call allowed:

Everywere

Parametrs:

Returns:

`false`	timer is run and counting
`true`	timer is stopped or paused

Example:

OST_DTIMER dtimer;
 
void Task (void)
{
    for (;;) {
        /*...*/
        if (OS_Dtimer_IsStopped(dtimer))	// if timer is stopped
            OS_RunTimer(dtimer, 100);     // then run it
        /*...*/
    }
}

Old style name

OS_IsDTimerStopped

OSA : OS_Dtimer_Pause

2010-02-04T19:55:47+03:00

OSA : OS_Dtimer_Pause

OS_Dtimer_Pause (dtimer)

Same as OS_Dtimer_Stop()

OS_ENABLE_DTIMERS constant must be defined in OSAcfh.h. Size of dynamic timers set by OS_DTIMER_SIZE constant

Call allowed:

Everywere

Parametrs:

Returns:

nothing

Example:

OST_DTIMER dtimer;
 
void Task (void)
{
    for (;;) {
        /*...*/
        OS_Dtimer_Pause (dtimer);
        /*...*/
    }
}

Old style name

OS_PauseDTimer

OSA : OS_Dtimer_Run

2010-02-04T19:54:52+03:00

OSA : OS_Dtimer_Run

OS_Dtimer_Run (dtimer, newtime)

Start counting dinamic timer for timenewtime. Timeout flag is cleared.

OS_ENABLE_DTIMERS constant must be defined in OSAcfh.h. Size of dynamic timers set by OS_DTIMER_SIZE constant

Call allowed:

Everywere

Parametrs:

`dtimer`	Descriptor of dynamic timer. Variable of OST_DTIMER type. Contains timer counter, timer's state frags and pointer to next timer in linst. For PIC16 can be allocated only in bank0 or bank1
`newtime`	Value to set timer's counter. Sets in system ticks - call OS_Timer periods. Size of time value must be less than size of timer

Returns:

nothing

Example:

OST_DTIMER dtimer;
 
void Task (void)
{
    OS_Dtimer_Create(dtimer);
    for (;;) {
        /*...*/
        OS_Dtimer_Run (dtimer, 100); // Run dtimer for 100 ticks
        /*...*/
    }
}

Old style name

OS_RunDTimer

OSA : OS_Dtimer_Stop

2009-06-30T19:27:06+03:00

OSA : OS_Dtimer_Stop

OS_Dtimer_Stop (dtimer)

Stop dinamic timer. Timer will stay active but will not incremented in OS_Timer(). Timeout flag stay unchanged (to set timeout flag see OS_Dtimer_Break).

OS_ENABLE_DTIMERS constant must be defined in OSAcfh.h. Size of dynamic timers set by OS_DTIMER_SIZE constant

Call allowed:

Everywere

Parametrs:

Returns:

nothing

Example:

OST_DTIMER dtimer;
 
void Task (void)
{
    for (;;) {
        /*...*/
        OS_Dtimer_Stop(dtimer);
        /*...*/
    }
}

Old style name

OS_StopDTimer

OSA : OS_Dtimer_Update

2010-02-04T19:56:02+03:00

OSA : OS_Dtimer_Update

OS_Dtimer_Update (dtimer, time)

Re-run static timer for time time since last overflow. Timeout flag is cleared.

OS_ENABLE_DTIMERS constant must be defined in OSAcfh.h. Size of dynamic timers set by OS_DTIMER_SIZE constant

Call allowed:

Everywere

Parametrs:

`dtimer`	Descriptor of dynamic timer. Variable of OST_DTIMER type. Contains timer counter, timer's state frags and pointer to next timer in linst. For PIC16 can be allocated only in bank0 or bank1
`time`	Value to set timer's counter. Sets in system ticks - call OS_Timer periods. Size of time value must be less than size of timer

Returns:

nothing

Example:

OST_DTIMER dtimer;
 
void Task (void)
{
    OS_Dtimer_Create(dtimer);
    for (;;) {
        /*...*/
        OS_Dtimer_Wait(dtimer);
        OS_Dtimer_Update (dtimer, 100);
        /*...*/
    }
}

Old style name

OS_UpdateDTimer

OSA : OS_Dtimer_Wait

2010-02-04T19:55:07+03:00

OSA : OS_Dtimer_Wait

OS_Dtimer_Wait (dtimer)

Wait for dinamic timer will overflow.

OS_ENABLE_DTIMERS constant must be defined in OSAcfh.h. Size of dynamic timers set by OS_DTIMER_SIZE constant

Call allowed:

Only in task

Parametrs:

Returns:

nothing

Example:

OST_DTIMER dtimer;
 
void Task (void)
{
    for (;;) {
        /*...*/
        OS_Dtimer_Run(dtimer, 100);
        OS_Dtimer_Wait(dtimer);     // Wait 100 ticks
        /*...*/
    }
}

Old style name

OS_WaitDTimer

OSA : OS_EI

2010-10-07T13:56:36+03:00

OSA : OS_EnterCriticalSection

2010-10-07T13:56:37+03:00

OSA : OS_EnterInt

2010-10-07T13:56:37+03:00

OSA : OS_Flag_Check_AllOff

2010-10-07T13:56:38+03:00

OSA : OS_Flag_Check_AllOn

2010-10-07T13:56:39+03:00

OSA : OS_Flag_Check_Off

2010-10-07T13:56:40+03:00

OSA : OS_Flag_Check_On

2010-10-07T13:56:41+03:00

OSA : OS_Flag_Clear

2010-10-07T13:56:41+03:00

OSA : OS_Flag_Create

2010-10-07T13:56:42+03:00

OSA : OS_Flag_Init

2010-10-07T13:56:43+03:00

OSA : OS_Flag_Set

2010-10-07T13:56:44+03:00

OSA : OS_Flag_Wait_AllOff

2010-10-07T13:56:45+03:00

OSA : OS_Flag_Wait_AllOff_TO

2010-10-07T13:56:46+03:00

OSA : OS_Flag_Wait_AllOn

2010-10-07T13:56:46+03:00

OSA : OS_Flag_Wait_AllOn_TO

2010-10-07T13:56:47+03:00

OSA : OS_Flag_Wait_Off

2010-10-07T13:56:48+03:00

OSA : OS_Flag_Wait_Off_TO

2010-10-07T13:56:49+03:00

OSA : OS_Flag_Wait_On

2010-10-07T13:56:50+03:00

OSA : OS_Flag_Wait_On_TO

2010-10-07T13:56:50+03:00

OSA : OS_GetCurTask

2008-12-27T16:45:27+03:00

OSA : OS_GetCurTask

OST_TCB_POINTER * OS_GetCurTask ()

Get pointer to task control block (OST_TCB_POINTER) of current task. This pointer can be used in services that controls task indirrectly (OS_PauseTask, OS_ContinueTask, ect). Usualy this service called in the begin of task-function.

Call allowed:

Only in task

Parametrs:

Non

Returns:

OST_TCB_POINTER Pointer to current task descriptor

Example:

OST_TCB_POINTER tp_Task;
void Task (void)
{
    tp_Task = OS_GetCurTask();
    for (;;) {
        /*...*/
    }
}

OSA : OS_Init

2010-10-07T13:56:52+03:00

OSA : OS_IsError

2010-10-07T13:56:53+03:00

OSA : OS_IsEventError

2010-10-07T13:56:54+03:00

OSA : OS_IsInCriticalSection

2010-10-07T13:56:54+03:00

OSA : OS_IsTimeout

2009-08-18T13:21:43+03:00

OSA : OS_IsTimeout

bool OS_IsTimeout ()

Return true if previos service exit with timeout.

Call allowed:

Everywere

Parametrs:

Non

Returns:

`false`	event occured before timeout expired
`true`	timeout expired before event occured

Example:

void Task (void)
{
    for (;;) {
        /*...*/
        OS_Wait_TO(RB0 == 1, 100);
        if (!OS_IsTimeout()) {
            //
            /*...*/
        }
        /*...*/
    }
}

OSA : OS_LeaveCriticalSection

2010-10-07T13:56:56+03:00

OSA : OS_LeaveInt

2009-01-14T04:59:06+03:00

OSA : OS_LeaveInt

OS_LeaveInt ()

For PICC and PICC18 this service must be called in the end of interrupt routine. This service restores FSR (FSR0 for PIC18) value (stored by OS_EnterInt).

Call allowed:

Only in interrupt

Parametrs:

Non

Returns:

nothing

Example:

void interrupt isr (void)
{
    static char a, b;  // some variables
 
    // After definiting all variables wee need to call service:
    OS_EnterInt();
    /*...*/
 
    // Before exit form interrupt we need to call service
    OS_LeaveInt();
}

OSA : OS_Msg_Accept

2010-10-07T13:56:58+03:00

OSA : OS_Msg_Check

2010-10-07T13:56:58+03:00

OSA : OS_Msg_Create

2010-10-07T13:56:59+03:00

OSA : OS_Msg_Send

2009-12-04T19:58:59+03:00

OSA : OS_Msg_Send

OS_Msg_Send (msg_cb, message)

Send message message through msg_cb. If msg_cb is busy then wait when it became free.

Call allowed:

Only in task

Parametrs:

`msg_cb`	Pointer to message descriptor. Variable of OST_MSG_CB type
`message`	pointer to message body (OST_MSG)

Returns:

nothing

Example:

OST_MSG_CB msg_cb;
 
void Task (void)
{
    OST_MSG msg;
    static char buf[10];
    for (;;) {
        /*...*/
        OS_Msg_Send(msg_cb, buf);
        /*...*/
    }
}

Old style name

OS_SendMsg

OSA : OS_Msg_Send_I

2010-10-07T13:57:01+03:00

OSA : OS_Msg_Send_Now

2009-12-04T20:01:42+03:00

OSA : OS_Msg_Send_Now

OS_Msg_Send_Now (msg_cb, message)

Send message througth msg_cb. If msg_cb already exists then it will be overwritten.

Call allowed:

Not in interrupt

Parametrs:

`msg_cb`	Pointer to message descriptor. Variable of OST_MSG_CB type
`message`	pointer to message body (OST_MSG)

Returns:

bEventError If msg_cb is not free then OS_IsEventError will return true

Example:

OST_MSG_CB msg_cb;
 
void Task (void)
{
    OST_MSG msg;
    static char buf[5];
    for (;;) {
        /*...*/
        OS_Msg_Send_Now (msg_cb, buf);
        /*...*/
    }
}

Old style name

OS_SendMsgNoWait

OSA : OS_Msg_Send_TO

2009-12-04T20:00:32+03:00

OSA : OS_Msg_Send_TO

OS_Msg_Send_TO (msg_cb, message, timeout)

Same as OS_Msg_Send with exit if timeout will expired. If timeout expires before message is free then new message will not be sent.

Call allowed:

Only in task

Parametrs:

`msg_cb`	Pointer to message descriptor. Variable of OST_MSG_CB type
`message`	pointer to message body (OST_MSG)
`timeout`	Time of waiting in system ticks - calling OS_Timer periods

Returns:

timeout If timeout expired then system service OS_IsTimeout will return true

Example:

OST_MSG_CB msg_cb;
 
void Task (void)
{
    OST_MSG msg;
    static char buf[10];
    for (;;) {
        /*...*/
        OS_Msg_Send_TO (msg_cb, buf, 100);
        if (OS_IsTimeout()) {
            // Message is not sent!
            /*...*/
        }
        /*...*/
    }
}

Old style name

OS_SendMsgTimeout

OSA : OS_Msg_Wait

2010-10-07T13:57:03+03:00

OSA : OS_Msg_Wait_TO

2010-10-07T13:57:04+03:00

OSA : OS_Oldtimer_Check

2010-10-07T13:57:05+03:00

OSA : OS_Oldtimer_Run16

2010-10-07T13:57:06+03:00

OSA : OS_Oldtimer_Run24

2010-10-07T13:57:07+03:00

OSA : OS_Oldtimer_Run32

2010-10-07T13:57:07+03:00

OSA : OS_Oldtimer_Run8

2010-10-07T13:57:08+03:00

OSA : OS_Oldtimer_Stop

2010-10-07T13:57:09+03:00

OSA : OS_Oldtimer_Wait

2010-10-07T13:57:10+03:00

OSA : OS_Qtimer_Break

2010-10-07T13:57:11+03:00

OSA : OS_Qtimer_Check

2010-02-22T14:05:07+03:00

OSA : OS_Qtimer_Get

_bool OS_Qtimer_Check (qtimer)

Check for timer overflowed.

OS_ENABLE_QTIMERS constant must be defined in OSAcfh.h. Size of timers set by OS_QTIMER_SIZE constant

Call allowed:

Everywhere

Parametrs:

qtimer Descriptor of timer. Variable of OST_QTIMER type. Contains timer counter, timer's state frags and pointer to next timer in linst. For PIC16 can be allocated only in bank0 or bank1

Returns:

`false`	no timeout
`true`	timeout expired, timer is overflowed

Example:

OST_QTIMER qtimer;
 
void Task (void)
{
    for (;;) {
        /*...*/
        if (OS_Qtimer_Check(qtimer))
        {
            /* ... */
        }
        /*...*/
    }
}

OSA : OS_Qtimer_Create

2010-10-07T13:57:12+03:00

OSA : OS_Qtimer_Delay

2010-10-07T13:57:13+03:00

OSA : OS_Qtimer_Delete

2010-10-07T13:57:14+03:00

OSA : OS_Qtimer_Get

2010-02-22T14:05:59+03:00

OSA : OS_Qtimer_Get

_OST_QTIMER OS_Qtimer_Get (qtimer)

Get timer's remaining time. Before call this service you should to do one of these things:

to disable interrupts
to enter critical section

Elsewere timer's value can be changed in interrupt while reading.

OS_ENABLE_QTIMERS constant must be defined in OSAcfh.h. Size of timers set by OS_QTIMER_SIZE constant

Call allowed:

Not in interrupt

Parametrs:

qtimer Descriptor of timer. Variable of OST_QTIMER type. Contains timer counter, timer's state frags and pointer to next timer in linst. For PIC16 can be allocated only in bank0 or bank1

Returns:

`_OST_QTIMER`	integer value of remaining time (in system ticks)

Example:

OST_QTIMER qtimer;
 
void Task (void)
{
    char itemp;
    for (;;) {
        /*...*/
        itemp = OS_DI();
        if (OS_Qtimer_Get(qtimer) < 10)   // Flash green led if remains
            GREEN_LED = 1;                // less than ten ticks
        OS_RI(itemp);
        /*...*/
    }
}

OSA : OS_Qtimer_IsRun

2010-10-07T13:57:16+03:00

OSA : OS_Qtimer_Run

2010-10-07T13:57:16+03:00

OSA : OS_Qtimer_Wait

2010-10-07T13:57:17+03:00

OSA : OS_Queue_Check

2010-10-07T13:57:18+03:00

OSA : OS_Queue_Create

2010-10-07T13:57:19+03:00

OSA : OS_Queue_IsEmpty

2010-10-07T13:57:20+03:00

OSA : OS_Queue_IsFull

2009-06-30T19:07:55+03:00

OSA : OS_Queue_IsFull

bool OS_Queue_IsFull (queue)

Check for queue of messages is full.

OS_ENABLE_QUEUE constant must be defined in OSAcfg.h..

For PIC16 message queues can be allocated only in bank0 or bank1

Call allowed:

Everywere

Parametrs:

queue Queue of messages descriptor. Variable of OST_QUEUE type.

Returns:

`false`	there is free room to add new message
`true`	queue is full

Example:

OST_QUEUE queue;
 
void Task (void)
{
    char buf[10];
    for (;;) {
        /*...*/
        if (!OS_Queue_IsFull (queue)) {                   // If there is place
            OS_Queue_Send_Now(queue, (OST_MSG)&buf);    // then send message
        };
        /*...*/
    }
}

Old style name

OS_IsQMsgFull

OSA : OS_Queue_Send

2009-12-04T20:03:54+03:00

OSA : OS_Queue_Send

OS_Queue_Send (queue, message)

Send message in queue of messages. If queue is full then wait for free room.

OS_ENABLE_QUEUE constant must be defined in OSAcfg.h..

For PIC16 message queues can be allocated only in bank0 or bank1

Call allowed:

Only in task

Parametrs:

`queue`	Queue of messages descriptor. Variable of OST_QUEUE type.
`message`	pointer to message body (OST_MSG)

Returns:

nothing

Example:

OST_QUEUE queue;
 
void Task (void)
{
    static char Data[20];
    for (;;) {
        /*...*/
        OS_Queue_Send (queue, Data);
        /*...*/
    }
}

Old style name

OS_SendQMsg

OSA : OS_Queue_Send_I

2010-10-07T13:57:22+03:00

OSA : OS_Queue_Send_Now

2009-12-04T20:04:31+03:00

OSA : OS_Queue_Send_Now

OS_Queue_Send_Now (queue, message)

Send message in queue of messages. If queue is full then most rearly message will be pushed out.

OS_ENABLE_QUEUE constant must be defined in OSAcfg.h..

For PIC16 message queues can be allocated only in bank0 or bank1

Call allowed:

Not in interrupt

Parametrs:

`queue`	Queue of messages descriptor. Variable of OST_QUEUE type.
`message`	pointer to message body (OST_MSG)

Returns:

bEventError If … is not free then OS_IsEventError will return true

Example:

OST_QUEUE queue;
 
void Task (void)
{
    static char Data[10];
    for (;;) {
        /*...*/
        OS_Queue_Send_Now (queue, Data);
        /*...*/
    }
}

Old style name

OS_SendQMsgNoWait

OSA : OS_Queue_Send_TO

2009-12-04T20:04:49+03:00

OSA : OS_Queue_Send_TO

OS_Queue_Send_TO (queue, message, timeout)

Same as OS_Queue_Send with exit if timeout will expired.

OS_ENABLE_QUEUE constant must be defined in OSAcfg.h..

For PIC16 message queues can be allocated only in bank0 or bank1

Call allowed:

Only in task

Parametrs:

`queue`	Queue of messages descriptor. Variable of OST_QUEUE type.
`message`	pointer to message body (OST_MSG)
`timeout`	Time of waiting in system ticks - calling OS_Timer periods

Returns:

timeout If timeout expired then system service OS_IsTimeout will return true

Example:

OST_QUEUE queue;
 
void Task (void)
{
    static char Buf[20];
    for (;;) {
        /*...*/
        OS_Queue_Send_TO (queue, buf, 100); // Wait 100 ticks
        if (OS_IsTimeout()) {
            // Message is not sent!
            /*...*/
        }
        /*...*/
    }
}

Old style name

OS_SendQMsgTimeout

OSA : OS_Queue_Wait

2010-10-07T13:57:25+03:00

OSA : OS_Queue_Wait_TO

2010-10-07T13:57:25+03:00

OSA : OS_RI

2010-10-07T13:57:26+03:00

OSA : OS_Run

2010-10-07T13:57:27+03:00

OSA : OS_Sched

2010-10-07T13:57:28+03:00

OSA : OS_Smsg_Accept

2010-10-07T13:57:29+03:00

OSA : OS_Smsg_Check

2010-10-07T13:57:29+03:00

OSA : OS_Smsg_Create

2010-10-07T13:57:30+03:00

OSA : OS_Smsg_Send

2010-10-07T13:57:31+03:00

OSA : OS_Smsg_Send_I

2010-10-07T13:57:32+03:00

OSA : OS_Smsg_Send_Now

2010-10-07T13:57:33+03:00

OSA : OS_Smsg_Send_TO

2010-10-07T13:57:34+03:00

OSA : OS_Smsg_Wait

2010-10-07T13:57:35+03:00

OSA : OS_Smsg_Wait_TO

2010-10-07T13:57:35+03:00

OSA : OS_Squeue_Check

2010-10-07T13:57:36+03:00

OSA : OS_Squeue_Create

2010-10-07T13:57:37+03:00

OSA : OS_Squeue_IsEmpty

2010-10-07T13:57:38+03:00

OSA : OS_Squeue_IsFull

2009-06-30T19:17:16+03:00

OSA : OS_Squeue_IsFull

bool OS_Squeue_IsFull (squeue)

Check for queue of sinple messages is full.

OS_ENABLE_SQUEUE constant must be defined in OSAcfg.h..

For PIC16 message queues can be allocated only in bank0 or bank1

Call allowed:

Everywere

Parametrs:

squeue Queue of simple messages descriptor. Variable of OST_SQUEUE type.

Returns:

`false`	there is free room to add new message
`true`	queue is full

Example:

OST_SQUEUE squeue;
 
void Task (void)
{
    for (;;) {
        /*...*/
        if (!OS_Squeue_IsFull (squeue)) {         // If there is place
            OS_Squeue_Send_Now(squeue, 'A');    // then send message 'A'
        };
        /*...*/
    }
}

Old style name

OS_IsQSMsgFull

OSA : OS_Squeue_Send

2010-10-07T13:57:40+03:00

OSA : OS_Squeue_Send_I

2010-10-07T13:57:40+03:00

OSA : OS_Squeue_Send_Now

2010-10-07T13:57:41+03:00

OSA : OS_Squeue_Send_TO

2010-10-07T13:57:42+03:00

OSA : OS_Squeue_Wait

2010-10-07T13:57:43+03:00

OSA : OS_Squeue_Wait_TO

2010-10-07T13:57:44+03:00

OSA : OS_Stimer_Alloc

2010-02-05T01:58:28+03:00

OSA : OS_Stimer_Alloc

OS_Stimer_Alloc (var_stimer_id)

Allocate static timer for work. There should be at list one free static timer (check it with OS_Stimer_Found service)

Number of static timers OS_STIMERS (1..32) must be specified in OSAcfh.h. Size of static timers set by OS_STIMER_SIZE constant

Constant OS_ENABLE_STIMERS_ALLOCATION should be defined in OSAcfg.h

Call allowed:

Not in interrupt

Parametrs:

var_stimer_id Variable of type unsigned char to store ID of allocated timer. When 0xFF - timer is not allocated

Returns:

OS_IsError() return true when no free timer to allocate

Example:

void Task (void)
{
    static unsigned char stimer_id;
    for (;;) {
        /*...*/
        OS_Wait(OS_Stimer_Found());    // Wait for free timer
        OS_Stimer_Alloc(stimer_id);    // Allocate it for work
        OS_Stimer_Run(stimer_id, 100); // Now we work with static timer through variable
 
        do {
           // ...
        } while (!OS_Stimer_Check(stimer_id));
 
        OS_Stimer_Free(stimer_id);    // Make timer free
        /*...*/
    }
}

OSA : OS_Stimer_Break

2010-10-07T13:57:45+03:00

OSA : OS_Stimer_Check

2010-02-04T19:29:14+03:00

OSA : OS_Stimer_Check

bool OS_Stimer_Check (stimer_id)

Check for static timer overflowed.

Number of static timers OS_STIMERS (1..32) must be specified in OSAcfh.h. Size of static timers set by OS_STIMER_SIZE constant

Call allowed:

Everywere

Parametrs:

stimer_id Static timer identifier. Number and size of static timers are set in OSAcfg.h with OS_STIMERS and OS_STIMER_SIZE constants

Returns:

`false`	static timer is counting
`true`	static timer overflowed or was stopped/paused

Example:

void Task (void)
{
    for (;;) {
        /*...*/
        if (OS_Stimer_Check(2)) {    // If timer 2 overflowed
            OS_Stimer_Run(2, 100);   // then re-run static timer
        }
        /*...*/
    }
}

Old style name

OS_CheckSTimer

OSA : OS_Stimer_Continue

2010-02-04T19:29:52+03:00

OSA : OS_Stimer_Continue

OS_Stimer_Continue (stimer_id)

Continue static timer's counting after pause.

Number of static timers OS_STIMERS (1..32) must be specified in OSAcfh.h. Size of static timers set by OS_STIMER_SIZE constant

Call allowed:

Everywere

Parametrs:

stimer_id Static timer identifier. Number and size of static timers are set in OSAcfg.h with OS_STIMERS and OS_STIMER_SIZE constants

Returns:

nothing

Example:

void Task (void)
{
    for (;;) {
        /*...*/
        OS_Stimer_Pause(4);
        /*...*/
        OS_Stimer_Continue(4);
        /*...*/
    }
}

Old style name

OS_ContinueSTimer

OSA : OS_Stimer_Delay

2010-02-04T19:28:47+03:00

OSA : OS_Stimer_Delay

OS_Stimer_Delay (stimer_id, delay)

Delay current task using static timer.

Number of static timers OS_STIMERS (1..32) must be specified in OSAcfh.h. Size of static timers set by OS_STIMER_SIZE constant

Call allowed:

Only in task

Parametrs:

`stimer_id`	Static timer identifier. Number and size of static timers are set in OSAcfg.h with OS_STIMERS and OS_STIMER_SIZE constants
`delay`	Time of delay. Set in system ticks - call OS_Timer periods

Returns:

nothing

Example:

void Task (void)
{
    for (;;) {
        /*...*/
        OS_Stimer_Delay (3, 20);    // Delay current task for 20 system ticks.
        /*...*/
    }
}

Old style name

OS_DelaySTimer

OSA : OS_Stimer_Found

2010-02-05T01:58:04+03:00

OSA : OS_Stimer_Found

bool OS_Stimer_Found ()

Check for there is at list on unused static timer.

Number of static timers OS_STIMERS (1..32) must be specified in OSAcfh.h. Size of static timers set by OS_STIMER_SIZE constant

Constant OS_ENABLE_STIMERS_ALLOCATION should be defined in OSAcfg.h

Call allowed:

Not in interrupt

Parametrs:

Returns:

`false`	there is no any free timer
`true`	there is at list one free static timer

Example:

void Task (void)
{
    static unsigned char stimer_id;
    for (;;) {
        /*...*/
        OS_Wait(OS_Stimer_Found());    // Wait for free timer
        OS_Stimer_Alloc(stimer_id);    // Allocate it for work
        OS_Stimer_Run(stimer_id, 100); // Now we work with static timer through variable
 
        do {
           // ...
        } while (!OS_Stimer_Check(stimer_id));
 
        OS_Stimer_Free(stimer_id);    // Make timer free
        /*...*/
    }
}

OSA : OS_Stimer_Free

2010-02-05T01:58:13+03:00

OSA : OS_Stimer_Free

OS_Stimer_Free (stimer_id)

Free static timer by it's ID.

Number of static timers OS_STIMERS (1..32) must be specified in OSAcfh.h. Size of static timers set by OS_STIMER_SIZE constant

Constant OS_ENABLE_STIMERS_ALLOCATION should be defined in OSAcfg.h

Call allowed:

Not in interrupt

Parametrs:

stimer_id Static timer identifier. Number and size of static timers are set in OSAcfg.h with OS_STIMERS and OS_STIMER_SIZE constants

Returns:

nothing

Example:

void Task (void)
{
    static unsigned char stimer_id;
    for (;;) {
        /*...*/
        OS_Wait(OS_Stimer_Found());    // Wait for free timer
        OS_Stimer_Alloc(stimer_id);    // Allocate it for work
        OS_Stimer_Run(stimer_id, 100); // Now we work with static timer through variable
 
        do {
           // ...
        } while (!OS_Stimer_Check(stimer_id));
 
        OS_Stimer_Free(stimer_id);    // Make timer free
        /*...*/
    }
}

OSA : OS_Stimer_Get

2010-02-04T19:29:04+03:00

OSA : OS_Stimer_Get

_OST_STIMER OS_Stimer_Get (stimer_id)

Get dinamic timer's remaining time. Before call this service you should to do one of these things:

to disable interrupts
to enter critical section

Elsewere timer's value can be changed in interrupt while reading.

Number of static timers OS_STIMERS (1..32) must be specified in OSAcfh.h. Size of static timers set by OS_STIMER_SIZE constant

Call allowed:

Everywere

Parametrs:

stimer_id Static timer identifier. Number and size of static timers are set in OSAcfg.h with OS_STIMERS and OS_STIMER_SIZE constants

Returns:

_OST_STIMER integer value of remaining time (in system ticks)

Example:

void Task (void)
{
    for (;;) {
        /*...*/
        OS_DI();
        if (OS_Stimer_Get (3) < 10)   // Flash red led if remains
            RED_LED = 1;             // less than 10 ticks
        OS_EI();
        /*...*/
    }
}

Old style name

OS_GetSTimer

OSA : OS_Stimer_IsRun

2010-02-04T19:29:26+03:00

OSA : OS_Stimer_IsRun

bool OS_Stimer_IsRun (stimer_id)

Check for static timer is run.

Number of static timers OS_STIMERS (1..32) must be specified in OSAcfh.h. Size of static timers set by OS_STIMER_SIZE constant

Call allowed:

Everywere

Parametrs:

stimer_id Static timer identifier. Number and size of static timers are set in OSAcfg.h with OS_STIMERS and OS_STIMER_SIZE constants

Returns:

`false`	timer is stopped or paused
`true`	timer is run

Example:

void Task (void)
{
    for (;;) {
        /*...*/
        if (!OS_Stimer_IsRun(2))     // if timer 2 is not run
            OS_Stimer_Run(2, 100);   // then run it
        /*...*/
    }
}

Old style name

OS_IsSTimerRun

OSA : OS_Stimer_Pause

2010-02-04T19:29:38+03:00

OSA : OS_Stimer_Pause

OS_Stimer_Pause (stimer_id)

Stop static timer. Timeout flag will be set.

Number of static timers OS_STIMERS (1..32) must be specified in OSAcfh.h. Size of static timers set by OS_STIMER_SIZE constant

Call allowed:

Everywere

Parametrs:

stimer_id Static timer identifier. Number and size of static timers are set in OSAcfg.h with OS_STIMERS and OS_STIMER_SIZE constants

Returns:

nothing

Example:

void Task (void)
{
    for (;;) {
        /*...*/
        OS_Stimer_Pause (2);
        /*...*/
    }
}

Old style name

OS_PauseSTimer

OSA : OS_Stimer_Run

2010-02-22T18:28:11+03:00

OSA : OS_Stimer_Run

OS_Stimer_Run (stimer_id, time)

Start counting static timer for time time. Timeut flag is cleared.

Number of static timers OS_STIMERS (1..32) must be specified in OSAcfh.h. Size of static timers set by OS_STIMER_SIZE constant

Call allowed:

Everywere

Parametrs:

`stimer_id`	Static timer identifier. Number and size of static timers are set in OSAcfg.h with OS_STIMERS and OS_STIMER_SIZE constants
`time`	Value to set timer's counter. Sets in system ticks - call OS_Timer periods. Size of time value must be less than size of timer

Returns:

nothing

Example:

void Task (void)
{
    for (;;) {
        /*...*/
        OS_Stimer_Run (1, 20); // Run static timer #1 for 20 ticks
        /*...*/
    }
}

Old style name

OS_RunSTimer

OSA : OS_Stimer_Stop

2010-02-04T19:27:46+03:00

OSA : OS_Stimer_Break

OS_Stimer_Break (stimer_id)

Stop and reset static timer. Timeout flag will be set.

Number of static timers OS_STIMERS (1..32) must be specified in OSAcfh.h. Size of static timers set by OS_STIMER_SIZE constant

Call allowed:

Everywere

Parametrs:

stimer_id Static timer identifier. Number and size of static timers are set in OSAcfg.h with OS_STIMERS and OS_STIMER_SIZE constants

Returns:

nothing

Example:

void Task (void)
{
    for (;;) {
        /*...*/
        OS_Stimer_Stop(5);    // Stop static timer #5
        /*...*/
    }
}

Old style name

OS_StopSTimer

OSA : OS_Stimer_Wait

2010-02-04T19:28:37+03:00

OSA : OS_Stimer_Wait

OS_Stimer_Wait (stimer_id)

Wait for static timer will be overflowed.

Number of static timers OS_STIMERS (1..32) must be specified in OSAcfh.h. Size of static timers set by OS_STIMER_SIZE constant

Call allowed:

Only in task

Parametrs:

stimer_id Static timer identifier. Number and size of static timers are set in OSAcfg.h with OS_STIMERS and OS_STIMER_SIZE constants

Returns:

nothing

Example:

void Task (void)
{
    for (;;) {
        /*...*/
        OS_Stimer_Run(4, 200);
        OS_Stimer_Wait(4);  // Wait 200 ticks
        /*...*/
    }
}

Old style name

OS_WaitSTimer

OSA : OS_Task_Continue

2010-10-07T13:57:56+03:00

OSA : OS_Task_Create

2009-07-22T15:12:00+03:00

OSA : OS_Task_Create

OS_Task_Create (priority, TaskName)

Create task. After creation task will be added in list of active tasks

For CCS users: Compiler should be informed that TaskName will be called indirrectly by service OS_Task_Define in main()

For mikroC users: All functions-tasks should be defined with #pragma fncall directive, e.g.:

#pragma fncall main MyTask
void MyTask (void)
{
…

Call allowed:

Not in interrupt

Parametrs:

`priority`	Task priority. Allowed values from 0 (highest) to 7 (lowest).
`TaskName`	Name of C-function to be used as task

Returns:

bError If there is no free descripto to create taskthen OS_IsError will return true

Example:

void Task1 (void)
{
    for (;;) OS_Yield();
}
 
void Task2 (void)
{
    for (;;) OS_Yield();
}
 
void main (void)
{
    OS_Init();
 
    OS_Task_Create(1, Task1);    // Create task Task1 with priority 1
    OS_Task_Create(5, Task2);    // Create task Task1 with priority 5
    /*...*/
}

Old style name

OS_CreateTask

OSA : OS_Task_Define

2010-10-07T13:57:58+03:00

OSA : OS_Task_Delete

2010-10-07T13:57:59+03:00

OSA : OS_Task_GetCreated

2010-10-07T13:57:59+03:00

OSA : OS_Task_GetCur

2010-10-07T13:58:00+03:00

OSA : OS_Task_GetPriority

2010-10-07T13:58:01+03:00

OSA : OS_Task_IsEnable

2010-10-07T13:58:02+03:00

OSA : OS_Task_IsPaused

2010-10-07T13:58:03+03:00

OSA : OS_Task_Pause

2010-10-07T13:58:04+03:00

OSA : OS_Task_Replace

2010-10-07T13:58:05+03:00

OSA : OS_Task_SetPriority

2010-10-07T13:58:05+03:00

OSA : OS_Task_Stop

2010-10-07T13:58:06+03:00

OSA : OS_Timer

2010-10-07T13:58:07+03:00

OSA : OS_Ttimer_Break

2010-02-04T19:48:04+03:00

OSA : OS_Ttimer_Break

void Task (void)
{
    for (;;) {
        /*...*/
        OS_Ttimer_Break();    // Stop current task's timer
        /*...*/
    }
}

OSA : OS_Ttimer_Check

2010-02-04T19:47:36+03:00

OSA : OS_Ttimer_Check

`false`	current task's timer is counting
`true`	current task's timer overflowed or was stopped/paused

Example:

void Task (void)
{
    for (;;) {
        /*...*/
        if (OS_Ttimer_Check()) {    // If timer overflowed (or not counting)
            OS_Ttimer_Run(100);     // then re-run current task's timer
        }
        /*...*/
    }
}

OSA : OS_Ttimer_Continue

2010-02-04T19:49:17+03:00

OSA : OS_Ttimer_Continue

void Task (void)
{
    for (;;) {
        /*...*/
        OS_Ttimer_Pause();
        /*...*/
        OS_Ttimer_Continue();
        /*...*/
    }
}

OSA : OS_Ttimer_Delay

2010-02-04T19:48:25+03:00

OSA : OS_Ttimer_Delay

void Task (void)
{
    for (;;) {
        /*...*/
        OS_Ttimer_Delay (20);    // Delay current task for 20 system ticks.
        /*...*/
    }
}

OSA : OS_Ttimer_Get

2010-02-04T19:48:49+03:00

OSA : OS_Ttimer_Get

_OST_TTIMER OS_Ttimer_Get ()

Get dinamic timer's remaining time. Before call this service you should to do one of these things:

to disable interrupts
to enter critical section

Elsewere timer's value can be changed in interrupt while reading.

To use task timers you need to define OS_ENABLE_TTIMERS in osacfg.h. Size of current task's timers set by OS_TTIMER_SIZE constant

void Task (void)
{
    for (;;) {
        /*...*/
        OS_DI();
        if (OS_Ttimer_Get () < 10)   // Flash red led if remains
            RED_LED = 1;             // less than 10 ticks
        OS_EI();
        /*...*/
    }
}

OSA : OS_Ttimer_IsRun

2010-02-04T19:49:02+03:00

OSA : OS_Ttimer_IsRun

`false`	timer is stopped or paused
`true`	timer is run

Example:

void Task (void)
{
    for (;;) {
        /*...*/
        if (!OS_Ttimer_IsRun())     // if timer is not run
            OS_Ttimer_Run(100);     // then run it
        /*...*/
    }
}

OSA : OS_Ttimer_Pause

2010-02-04T19:49:10+03:00

OSA : OS_Ttimer_Pause

void Task (void)
{
    for (;;) {
        /*...*/
        OS_Ttimer_Pause ();
        /*...*/
    }
}

OSA : OS_Ttimer_Run

2010-02-04T19:47:53+03:00

OSA : OS_Ttimer_Run

void Task (void)
{
    for (;;) {
        /*...*/
        OS_Ttimer_Run (20); // Run current task's timer for 20 ticks
        /*...*/
    }
}

OSA : OS_Ttimer_Wait

2010-02-04T19:48:14+03:00

OSA : OS_Ttimer_Wait

void Task (void)
{
    for (;;) {
        /*...*/
        OS_Ttimer_Run(200);
        OS_Ttimer_Wait();  // Wait 200 ticks
        /*...*/
    }
}

OSA : OS_Wait

2010-10-07T13:58:16+03:00

OSA : OS_Wait_TO

2010-10-07T13:58:17+03:00

OSA : OS_Yield

2010-10-07T13:58:17+03:00