Directory
-
- Message mailbox creation
- Message mailbox deletion
- Waiting for a message in your mailbox
- Send a message to email
Message mailbox creation
OS_EVENT *OSMboxCreate (void *pmsg)
{<!-- -->
OS_EVENT *pevent;
#if OS_CRITICAL_METHOD == 3u /* Allocate storage for CPU status register */
OS_CPU_SR cpu_sr = 0u;
#endif
#ifdef OS_SAFETY_CRITICAL_IEC61508
\t
if (OSSafetyCriticalStartFlag == OS_TRUE)
{<!-- -->
OS_SAFETY_CRITICAL_EXCEPTION();
return ((OS_EVENT *)0);
}
\t
#endif
\t
if (OSIntNesting > 0u) /* See if called from ISR ... */
{<!-- -->
return ((OS_EVENT *)0); /* ... can't CREATE from an ISR */
}
\t
OS_ENTER_CRITICAL();
pevent = OSEventFreeList; /* Get next free event control block */
\t
if (OSEventFreeList != (OS_EVENT *)0) /* See if pool of free ECB pool was empty */
{<!-- -->
OSEventFreeList = (OS_EVENT *)OSEventFreeList->OSEventPtr;
}
\t
OS_EXIT_CRITICAL();
\t
if (pevent != (OS_EVENT *)0)
{<!-- -->
pevent->OSEventType = OS_EVENT_TYPE_MBOX;
pevent->OSEventCnt = 0u;
pevent->OSEventPtr = pmsg; /* Deposit message in event control block */
#if OS_EVENT_NAME_EN > 0u
pevent->OSEventName = (INT8U *) (void *)"?";
#endif
OS_EventWaitListInit (pevent);
}
\t
return (pevent); /* Return pointer to event control block */
}
Message mailbox deletion
#if OS_MBOX_DEL_EN > 0u
OS_EVENT *OSMboxDel (OS_EVENT *pevent,
INT8U opt,
INT8U *perr)
{<!-- -->
BOOLEAN tasks_waiting;
OS_EVENT *pevent_return;
#if OS_CRITICAL_METHOD == 3u /* Allocate storage for CPU status register */
OS_CPU_SR cpu_sr = 0u;
#endif
#ifdef OS_SAFETY_CRITICAL
\t
if (perr == (INT8U *)0)
{<!-- -->
OS_SAFETY_CRITICAL_EXCEPTION();
return ((OS_EVENT *)0);
}
\t
#endif
#if OS_ARG_CHK_EN > 0u
\t
if (pevent == (OS_EVENT *)0) /* Validate 'pevent' */
{<!-- -->
*perr = OS_ERR_PEVENT_NULL;
return (pevent);
}
\t
#endif
\t
if (pevent->OSEventType != OS_EVENT_TYPE_MBOX) /* Validate event block type */
{<!-- -->
*perr = OS_ERR_EVENT_TYPE;
return (pevent);
}
\t
if (OSIntNesting > 0u) /* See if called from ISR ... */
{<!-- -->
*perr = OS_ERR_DEL_ISR; /* ... can't DELETE from an ISR */
return (pevent);
}
\t
OS_ENTER_CRITICAL();
\t
if (pevent->OSEventGrp != 0u) /* See if any tasks waiting on mailbox */
{<!-- -->
tasks_waiting = OS_TRUE; /* Yes */
}
\t
else
{<!-- -->
tasks_waiting = OS_FALSE; /* No */
}
\t
switch (opt)
{<!-- -->
case OS_DEL_NO_PEND: /* Delete mailbox only if no task waiting */
if (tasks_waiting == OS_FALSE)
{<!-- -->
#if OS_EVENT_NAME_EN > 0u
pevent->OSEventName = (INT8U *) (void *)"?";
#endif
pevent->OSEventType = OS_EVENT_TYPE_UNUSED;
pevent->OSEventPtr = OSEventFreeList; /* Return Event Control Block to free list */
pevent->OSEventCnt = 0u;
OSEventFreeList = pevent; /* Get next free event control block */
OS_EXIT_CRITICAL();
*perr = OS_ERR_NONE;
pevent_return = (OS_EVENT *)0; /* Mailbox has been deleted */
}
\t\t\t
else
{<!-- -->
OS_EXIT_CRITICAL();
*perr = OS_ERR_TASK_WAITING;
pevent_return = pevent;
}
\t\t\t
break;
\t\t\t
case OS_DEL_ALWAYS: /* Always delete the mailbox */
while (pevent->OSEventGrp != 0u) /* Ready ALL tasks waiting for mailbox */
{<!-- -->
(void)OS_EventTaskRdy (pevent, (void *)0, OS_STAT_MBOX, OS_STAT_PEND_ABORT);
}
\t\t\t
#if OS_EVENT_NAME_EN > 0u
pevent->OSEventName = (INT8U *) (void *)"?";
#endif
pevent->OSEventType = OS_EVENT_TYPE_UNUSED;
pevent->OSEventPtr = OSEventFreeList; /* Return Event Control Block to free list */
pevent->OSEventCnt = 0u;
OSEventFreeList = pevent; /* Get next free event control block */
OS_EXIT_CRITICAL();
\t\t\t
if (tasks_waiting == OS_TRUE) /* Reschedule only if task(s) were waiting */
{<!-- -->
OS_Sched(); /* Find highest priority task ready to run */
}
\t\t\t
*perr = OS_ERR_NONE;
pevent_return = (OS_EVENT *)0; /* Mailbox has been deleted */
break;
\t\t\t
default:
OS_EXIT_CRITICAL();
*perr = OS_ERR_INVALID_OPT;
pevent_return = pevent;
break;
}
\t
return (pevent_return);
}
#endif
Waiting for messages in your mailbox
void *OSMboxPend (OS_EVENT *pevent,
INT32U timeout,
INT8U *perr)
{<!-- -->
void *pmsg;
#if OS_CRITICAL_METHOD == 3u /* Allocate storage for CPU status register */
OS_CPU_SR cpu_sr = 0u;
#endif
#ifdef OS_SAFETY_CRITICAL
\t
if (perr == (INT8U *)0)
{<!-- -->
OS_SAFETY_CRITICAL_EXCEPTION();
return ((void *)0);
}
\t
#endif
#if OS_ARG_CHK_EN > 0u
\t
if (pevent == (OS_EVENT *)0) /* Validate 'pevent' */
{<!-- -->
*perr = OS_ERR_PEVENT_NULL;
return ((void *)0);
}
\t
#endif
\t
if (pevent->OSEventType != OS_EVENT_TYPE_MBOX) /* Validate event block type */
{<!-- -->
*perr = OS_ERR_EVENT_TYPE;
return ((void *)0);
}
\t
if (OSIntNesting > 0u) /* See if called from ISR ... */
{<!-- -->
*perr = OS_ERR_PEND_ISR; /* ... can't PEND from an ISR */
return ((void *)0);
}
\t
if (OSLockNesting > 0u) /* See if called with scheduler locked ... */
{<!-- -->
*perr = OS_ERR_PEND_LOCKED; /* ... can't PEND when locked */
return ((void *)0);
}
\t
OS_ENTER_CRITICAL();
pmsg = pevent->OSEventPtr;
\t
if (pmsg != (void *)0) /* See if there is already a message */
{<!-- -->
pevent->OSEventPtr = (void *)0; /* Clear the mailbox */
OS_EXIT_CRITICAL();
*perr = OS_ERR_NONE;
return (pmsg); /* Return the message received (or NULL) */
}
\t
OSTCBCur->OSTCBStat |= OS_STAT_MBOX; /* Message not available, task will pend */
OSTCBCur->OSTCBStatPend = OS_STAT_PEND_OK;
OSTCBCur->OSTCBDly = timeout; /* Load timeout in TCB */
OS_EventTaskWait (pevent); /* Suspend task until event or timeout occurs */
OS_EXIT_CRITICAL();
OS_Sched(); /* Find next highest priority task ready to run */
OS_ENTER_CRITICAL();
\t
switch (OSTCBCur->OSTCBStatPend) /* See if we timed-out or aborted */
{<!-- -->
case OS_STAT_PEND_OK:
pmsg = OSTCBCur->OSTCBMsg;
*perr = OS_ERR_NONE;
break;
\t\t\t
case OS_STAT_PEND_ABORT:
pmsg = (void *)0;
*perr = OS_ERR_PEND_ABORT; /* Indicate that we aborted */
break;
\t\t\t
case OS_STAT_PEND_TO:
default:
OS_EventTaskRemove (OSTCBCur, pevent);
pmsg = (void *)0;
*perr = OS_ERR_TIMEOUT; /* Indicate that we didn't get event within TO */
break;
}
\t
OSTCBCur->OSTCBStat = OS_STAT_RDY; /* Set task status to ready */
OSTCBCur->OSTCBStatPend = OS_STAT_PEND_OK; /* Clear pend status */
OSTCBCur->OSTCBEventPtr = (OS_EVENT *)0; /* Clear event pointers */
#if (OS_EVENT_MULTI_EN > 0u)
OSTCBCur->OSTCBEventMultiPtr = (OS_EVENT **)0;
#endif
OSTCBCur->OSTCBMsg = (void *)0; /* Clear received message */
OS_EXIT_CRITICAL();
return (pmsg); /* Return received message */
}
Send a message to email
#if OS_MBOX_POST_EN > 0u
INT8U OSMboxPost (OS_EVENT *pevent,
void *pmsg)
{<!-- -->
#if OS_CRITICAL_METHOD == 3u /* Allocate storage for CPU status register */
OS_CPU_SR cpu_sr = 0u;
#endif
#if OS_ARG_CHK_EN > 0u
\t
if (pevent == (OS_EVENT *)0) /* Validate 'pevent' */
{<!-- -->
return (OS_ERR_PEVENT_NULL);
}
\t
if (pmsg == (void *)0) /* Make sure we are not posting a NULL pointer */
{<!-- -->
return (OS_ERR_POST_NULL_PTR);
}
\t
#endif
\t
if (pevent->OSEventType != OS_EVENT_TYPE_MBOX) /* Validate event block type */
{<!-- -->
return (OS_ERR_EVENT_TYPE);
}
\t
OS_ENTER_CRITICAL();
\t
if (pevent->OSEventGrp != 0u) /* See if any task pending on mailbox */
{<!-- -->
/* Ready HPT waiting on event */
(void)OS_EventTaskRdy (pevent, pmsg, OS_STAT_MBOX, OS_STAT_PEND_OK);
OS_EXIT_CRITICAL();
OS_Sched(); /* Find highest priority task ready to run */
return (OS_ERR_NONE);
}
\t
if (pevent->OSEventPtr != (void *)0) /* Make sure mailbox doesn't already have a msg */
{<!-- -->
OS_EXIT_CRITICAL();
return (OS_ERR_MBOX_FULL);
}
\t
pevent->OSEventPtr = pmsg; /* Place message in mailbox */
OS_EXIT_CRITICAL();
return (OS_ERR_NONE);
}
#endif
