mirror of
https://github.com/QuantumLeaps/qpc.git
synced 2025-02-04 07:13:16 +08:00
1287 lines
56 KiB
C
1287 lines
56 KiB
C
/*
|
|
*********************************************************************************************************
|
|
* uC/OS-II
|
|
* The Real-Time Kernel
|
|
*
|
|
* Copyright 1992-2020 Silicon Laboratories Inc. www.silabs.com
|
|
*
|
|
* SPDX-License-Identifier: APACHE-2.0
|
|
*
|
|
* This software is subject to an open source license and is distributed by
|
|
* Silicon Laboratories Inc. pursuant to the terms of the Apache License,
|
|
* Version 2.0 available at www.apache.org/licenses/LICENSE-2.0.
|
|
*
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
*
|
|
* EVENT FLAG MANAGEMENT
|
|
*
|
|
* Filename : os_flag.c
|
|
* Version : V2.93.00
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
#ifndef OS_FLAG_C
|
|
#define OS_FLAG_C
|
|
|
|
#define MICRIUM_SOURCE
|
|
|
|
#ifndef OS_MASTER_FILE
|
|
#include <ucos_ii.h>
|
|
#endif
|
|
|
|
#if (OS_FLAG_EN > 0u) && (OS_MAX_FLAGS > 0u)
|
|
/*
|
|
*********************************************************************************************************
|
|
* LOCAL PROTOTYPES
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
static void OS_FlagBlock(OS_FLAG_GRP *pgrp, OS_FLAG_NODE *pnode, OS_FLAGS flags, INT8U wait_type, INT32U timeout);
|
|
static BOOLEAN OS_FlagTaskRdy(OS_FLAG_NODE *pnode, OS_FLAGS flags_rdy, INT8U pend_stat);
|
|
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
* CHECK THE STATUS OF FLAGS IN AN EVENT FLAG GROUP
|
|
*
|
|
* Description: This function is called to check the status of a combination of bits to be set or cleared
|
|
* in an event flag group. Your application can check for ANY bit to be set/cleared or ALL
|
|
* bits to be set/cleared.
|
|
*
|
|
* This call does not block if the desired flags are not present.
|
|
*
|
|
* Arguments : pgrp is a pointer to the desired event flag group.
|
|
*
|
|
* flags Is a bit pattern indicating which bit(s) (i.e. flags) you wish to check.
|
|
* The bits you want are specified by setting the corresponding bits in
|
|
* 'flags'. e.g. if your application wants to wait for bits 0 and 1 then
|
|
* 'flags' would contain 0x03.
|
|
*
|
|
* wait_type specifies whether you want ALL bits to be set/cleared or ANY of the bits
|
|
* to be set/cleared.
|
|
* You can specify the following argument:
|
|
*
|
|
* OS_FLAG_WAIT_CLR_ALL You will check ALL bits in 'flags' to be clear (0)
|
|
* OS_FLAG_WAIT_CLR_ANY You will check ANY bit in 'flags' to be clear (0)
|
|
* OS_FLAG_WAIT_SET_ALL You will check ALL bits in 'flags' to be set (1)
|
|
* OS_FLAG_WAIT_SET_ANY You will check ANY bit in 'flags' to be set (1)
|
|
*
|
|
* NOTE: Add OS_FLAG_CONSUME if you want the event flag to be 'consumed' by
|
|
* the call. Example, to wait for any flag in a group AND then clear
|
|
* the flags that are present, set 'wait_type' to:
|
|
*
|
|
* OS_FLAG_WAIT_SET_ANY + OS_FLAG_CONSUME
|
|
*
|
|
* perr is a pointer to an error code and can be:
|
|
* OS_ERR_NONE No error
|
|
* OS_ERR_EVENT_TYPE You are not pointing to an event flag group
|
|
* OS_ERR_FLAG_WAIT_TYPE You didn't specify a proper 'wait_type' argument.
|
|
* OS_ERR_FLAG_INVALID_PGRP You passed a NULL pointer instead of the event flag
|
|
* group handle.
|
|
* OS_ERR_FLAG_NOT_RDY The desired flags you are waiting for are not
|
|
* available.
|
|
*
|
|
* Returns : The flags in the event flag group that made the task ready or, 0 if a timeout or an error
|
|
* occurred.
|
|
*
|
|
* Called from: Task or ISR
|
|
*
|
|
* Note(s) : 1) IMPORTANT, the behavior of this function has changed from PREVIOUS versions. The
|
|
* function NOW returns the flags that were ready INSTEAD of the current state of the
|
|
* event flags.
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
#if OS_FLAG_ACCEPT_EN > 0u
|
|
OS_FLAGS OSFlagAccept (OS_FLAG_GRP *pgrp,
|
|
OS_FLAGS flags,
|
|
INT8U wait_type,
|
|
INT8U *perr)
|
|
{
|
|
OS_FLAGS flags_rdy;
|
|
INT8U result;
|
|
BOOLEAN consume;
|
|
#if OS_CRITICAL_METHOD == 3u /* Allocate storage for CPU status register */
|
|
OS_CPU_SR cpu_sr = 0u;
|
|
#endif
|
|
|
|
|
|
|
|
#ifdef OS_SAFETY_CRITICAL
|
|
if (perr == (INT8U *)0) {
|
|
OS_SAFETY_CRITICAL_EXCEPTION();
|
|
return ((OS_FLAGS)0);
|
|
}
|
|
#endif
|
|
|
|
#if OS_ARG_CHK_EN > 0u
|
|
if (pgrp == (OS_FLAG_GRP *)0) { /* Validate 'pgrp' */
|
|
*perr = OS_ERR_FLAG_INVALID_PGRP;
|
|
return ((OS_FLAGS)0);
|
|
}
|
|
#endif
|
|
if (pgrp->OSFlagType != OS_EVENT_TYPE_FLAG) { /* Validate event block type */
|
|
*perr = OS_ERR_EVENT_TYPE;
|
|
return ((OS_FLAGS)0);
|
|
}
|
|
result = (INT8U)(wait_type & OS_FLAG_CONSUME);
|
|
if (result != (INT8U)0) { /* See if we need to consume the flags */
|
|
wait_type &= ~OS_FLAG_CONSUME;
|
|
consume = OS_TRUE;
|
|
} else {
|
|
consume = OS_FALSE;
|
|
}
|
|
|
|
*perr = OS_ERR_NONE; /* Assume NO error until proven otherwise. */
|
|
OS_ENTER_CRITICAL();
|
|
switch (wait_type) {
|
|
case OS_FLAG_WAIT_SET_ALL: /* See if all required flags are set */
|
|
flags_rdy = (OS_FLAGS)(pgrp->OSFlagFlags & flags); /* Extract only the bits we want */
|
|
if (flags_rdy == flags) { /* Must match ALL the bits that we want */
|
|
if (consume == OS_TRUE) { /* See if we need to consume the flags */
|
|
pgrp->OSFlagFlags &= (OS_FLAGS)~flags_rdy; /* Clear ONLY the flags we wanted */
|
|
}
|
|
} else {
|
|
*perr = OS_ERR_FLAG_NOT_RDY;
|
|
}
|
|
OS_EXIT_CRITICAL();
|
|
break;
|
|
|
|
case OS_FLAG_WAIT_SET_ANY:
|
|
flags_rdy = (OS_FLAGS)(pgrp->OSFlagFlags & flags); /* Extract only the bits we want */
|
|
if (flags_rdy != (OS_FLAGS)0) { /* See if any flag set */
|
|
if (consume == OS_TRUE) { /* See if we need to consume the flags */
|
|
pgrp->OSFlagFlags &= (OS_FLAGS)~flags_rdy; /* Clear ONLY the flags we got */
|
|
}
|
|
} else {
|
|
*perr = OS_ERR_FLAG_NOT_RDY;
|
|
}
|
|
OS_EXIT_CRITICAL();
|
|
break;
|
|
|
|
#if OS_FLAG_WAIT_CLR_EN > 0u
|
|
case OS_FLAG_WAIT_CLR_ALL: /* See if all required flags are cleared */
|
|
flags_rdy = (OS_FLAGS)~pgrp->OSFlagFlags & flags; /* Extract only the bits we want */
|
|
if (flags_rdy == flags) { /* Must match ALL the bits that we want */
|
|
if (consume == OS_TRUE) { /* See if we need to consume the flags */
|
|
pgrp->OSFlagFlags |= flags_rdy; /* Set ONLY the flags that we wanted */
|
|
}
|
|
} else {
|
|
*perr = OS_ERR_FLAG_NOT_RDY;
|
|
}
|
|
OS_EXIT_CRITICAL();
|
|
break;
|
|
|
|
case OS_FLAG_WAIT_CLR_ANY:
|
|
flags_rdy = (OS_FLAGS)~pgrp->OSFlagFlags & flags; /* Extract only the bits we want */
|
|
if (flags_rdy != (OS_FLAGS)0) { /* See if any flag cleared */
|
|
if (consume == OS_TRUE) { /* See if we need to consume the flags */
|
|
pgrp->OSFlagFlags |= flags_rdy; /* Set ONLY the flags that we got */
|
|
}
|
|
} else {
|
|
*perr = OS_ERR_FLAG_NOT_RDY;
|
|
}
|
|
OS_EXIT_CRITICAL();
|
|
break;
|
|
#endif
|
|
|
|
default:
|
|
OS_EXIT_CRITICAL();
|
|
flags_rdy = (OS_FLAGS)0;
|
|
*perr = OS_ERR_FLAG_WAIT_TYPE;
|
|
break;
|
|
}
|
|
return (flags_rdy);
|
|
}
|
|
#endif
|
|
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
* CREATE AN EVENT FLAG
|
|
*
|
|
* Description: This function is called to create an event flag group.
|
|
*
|
|
* Arguments : flags Contains the initial value to store in the event flag group.
|
|
*
|
|
* perr is a pointer to an error code which will be returned to your application:
|
|
* OS_ERR_NONE if the call was successful.
|
|
* OS_ERR_CREATE_ISR if you attempted to create an Event Flag from an
|
|
* ISR.
|
|
* OS_ERR_FLAG_GRP_DEPLETED if there are no more event flag groups
|
|
* OS_ERR_ILLEGAL_CREATE_RUN_TIME if you tried to create an event flag after
|
|
* safety critical operation started.
|
|
*
|
|
* Returns : A pointer to an event flag group or a NULL pointer if no more groups are available.
|
|
*
|
|
* Called from: Task ONLY
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
OS_FLAG_GRP *OSFlagCreate (OS_FLAGS flags,
|
|
INT8U *perr)
|
|
{
|
|
OS_FLAG_GRP *pgrp;
|
|
#if OS_CRITICAL_METHOD == 3u /* Allocate storage for CPU status register */
|
|
OS_CPU_SR cpu_sr = 0u;
|
|
#endif
|
|
|
|
|
|
|
|
#ifdef OS_SAFETY_CRITICAL
|
|
if (perr == (INT8U *)0) {
|
|
OS_SAFETY_CRITICAL_EXCEPTION();
|
|
return ((OS_FLAG_GRP *)0);
|
|
}
|
|
#endif
|
|
|
|
#ifdef OS_SAFETY_CRITICAL_IEC61508
|
|
if (OSSafetyCriticalStartFlag == OS_TRUE) {
|
|
OS_SAFETY_CRITICAL_EXCEPTION();
|
|
*perr = OS_ERR_ILLEGAL_CREATE_RUN_TIME;
|
|
return ((OS_FLAG_GRP *)0);
|
|
}
|
|
#endif
|
|
|
|
if (OSIntNesting > 0u) { /* See if called from ISR ... */
|
|
*perr = OS_ERR_CREATE_ISR; /* ... can't CREATE from an ISR */
|
|
return ((OS_FLAG_GRP *)0);
|
|
}
|
|
OS_ENTER_CRITICAL();
|
|
pgrp = OSFlagFreeList; /* Get next free event flag */
|
|
if (pgrp != (OS_FLAG_GRP *)0) { /* See if we have event flag groups available */
|
|
/* Adjust free list */
|
|
OSFlagFreeList = (OS_FLAG_GRP *)OSFlagFreeList->OSFlagWaitList;
|
|
pgrp->OSFlagType = OS_EVENT_TYPE_FLAG; /* Set to event flag group type */
|
|
pgrp->OSFlagFlags = flags; /* Set to desired initial value */
|
|
pgrp->OSFlagWaitList = (void *)0; /* Clear list of tasks waiting on flags */
|
|
#if OS_FLAG_NAME_EN > 0u
|
|
pgrp->OSFlagName = (INT8U *)(void *)"?";
|
|
#endif
|
|
OS_TRACE_FLAG_CREATE(pgrp, pgrp->OSFlagName);
|
|
OS_EXIT_CRITICAL();
|
|
*perr = OS_ERR_NONE;
|
|
} else {
|
|
OS_EXIT_CRITICAL();
|
|
*perr = OS_ERR_FLAG_GRP_DEPLETED;
|
|
}
|
|
return (pgrp); /* Return pointer to event flag group */
|
|
}
|
|
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
* DELETE AN EVENT FLAG GROUP
|
|
*
|
|
* Description: This function deletes an event flag group and readies all tasks pending on the event flag
|
|
* group.
|
|
*
|
|
* Arguments : pgrp is a pointer to the desired event flag group.
|
|
*
|
|
* opt determines delete options as follows:
|
|
* opt == OS_DEL_NO_PEND Deletes the event flag group ONLY if no task pending
|
|
* opt == OS_DEL_ALWAYS Deletes the event flag group even if tasks are
|
|
* waiting. In this case, all the tasks pending will be
|
|
* readied.
|
|
*
|
|
* perr is a pointer to an error code that can contain one of the following values:
|
|
* OS_ERR_NONE The call was successful and the event flag group was
|
|
* deleted
|
|
* OS_ERR_DEL_ISR If you attempted to delete the event flag group from
|
|
* an ISR
|
|
* OS_ERR_FLAG_INVALID_PGRP If 'pgrp' is a NULL pointer.
|
|
* OS_ERR_EVENT_TYPE If you didn't pass a pointer to an event flag group
|
|
* OS_ERR_ILLEGAL_DEL_RUN_TIME If you tried to delete an event flag after
|
|
* safety critical operation started.
|
|
* OS_ERR_INVALID_OPT An invalid option was specified
|
|
* OS_ERR_TASK_WAITING One or more tasks were waiting on the event flag
|
|
* group.
|
|
*
|
|
* Returns : pgrp upon error
|
|
* (OS_EVENT *)0 if the event flag group was successfully deleted.
|
|
*
|
|
* Note(s) : 1) This function must be used with care. Tasks that would normally expect the presence of
|
|
* the event flag group MUST check the return code of OSFlagAccept() and OSFlagPend().
|
|
* 2) This call can potentially disable interrupts for a long time. The interrupt disable
|
|
* time is directly proportional to the number of tasks waiting on the event flag group.
|
|
* 3) All tasks that were waiting for the event flag will be readied and returned an
|
|
* OS_ERR_PEND_ABORT if OSFlagDel() was called with OS_DEL_ALWAYS
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
#if OS_FLAG_DEL_EN > 0u
|
|
OS_FLAG_GRP *OSFlagDel (OS_FLAG_GRP *pgrp,
|
|
INT8U opt,
|
|
INT8U *perr)
|
|
{
|
|
BOOLEAN tasks_waiting;
|
|
OS_FLAG_NODE *pnode;
|
|
OS_FLAG_GRP *pgrp_return;
|
|
#if OS_CRITICAL_METHOD == 3u /* Allocate storage for CPU status register */
|
|
OS_CPU_SR cpu_sr = 0u;
|
|
#endif
|
|
|
|
|
|
#ifdef OS_SAFETY_CRITICAL
|
|
if (perr == (INT8U *)0) {
|
|
OS_SAFETY_CRITICAL_EXCEPTION();
|
|
return ((OS_FLAG_GRP *)0);
|
|
}
|
|
#endif
|
|
|
|
#ifdef OS_SAFETY_CRITICAL_IEC61508
|
|
if (OSSafetyCriticalStartFlag == OS_TRUE) {
|
|
OS_SAFETY_CRITICAL_EXCEPTION();
|
|
*perr = OS_ERR_ILLEGAL_DEL_RUN_TIME;
|
|
return ((OS_FLAG_GRP *)0);
|
|
}
|
|
#endif
|
|
|
|
#if OS_ARG_CHK_EN > 0u
|
|
if (pgrp == (OS_FLAG_GRP *)0) { /* Validate 'pgrp' */
|
|
*perr = OS_ERR_FLAG_INVALID_PGRP;
|
|
return (pgrp);
|
|
}
|
|
#endif
|
|
|
|
OS_TRACE_FLAG_DEL_ENTER(pgrp, opt);
|
|
|
|
if (OSIntNesting > 0u) { /* See if called from ISR ... */
|
|
*perr = OS_ERR_DEL_ISR; /* ... can't DELETE from an ISR */
|
|
OS_TRACE_FLAG_DEL_EXIT(*perr);
|
|
return (pgrp);
|
|
}
|
|
if (pgrp->OSFlagType != OS_EVENT_TYPE_FLAG) { /* Validate event group type */
|
|
*perr = OS_ERR_EVENT_TYPE;
|
|
OS_TRACE_FLAG_DEL_EXIT(*perr);
|
|
return (pgrp);
|
|
}
|
|
OS_ENTER_CRITICAL();
|
|
if (pgrp->OSFlagWaitList != (void *)0) { /* See if any tasks waiting on event flags */
|
|
tasks_waiting = OS_TRUE; /* Yes */
|
|
} else {
|
|
tasks_waiting = OS_FALSE; /* No */
|
|
}
|
|
switch (opt) {
|
|
case OS_DEL_NO_PEND: /* Delete group if no task waiting */
|
|
if (tasks_waiting == OS_FALSE) {
|
|
#if OS_FLAG_NAME_EN > 0u
|
|
pgrp->OSFlagName = (INT8U *)(void *)"?";
|
|
#endif
|
|
pgrp->OSFlagType = OS_EVENT_TYPE_UNUSED;
|
|
pgrp->OSFlagWaitList = (void *)OSFlagFreeList; /* Return group to free list */
|
|
pgrp->OSFlagFlags = (OS_FLAGS)0;
|
|
OSFlagFreeList = pgrp;
|
|
OS_EXIT_CRITICAL();
|
|
*perr = OS_ERR_NONE;
|
|
pgrp_return = (OS_FLAG_GRP *)0; /* Event Flag Group has been deleted */
|
|
} else {
|
|
OS_EXIT_CRITICAL();
|
|
*perr = OS_ERR_TASK_WAITING;
|
|
pgrp_return = pgrp;
|
|
}
|
|
break;
|
|
|
|
case OS_DEL_ALWAYS: /* Always delete the event flag group */
|
|
pnode = (OS_FLAG_NODE *)pgrp->OSFlagWaitList;
|
|
while (pnode != (OS_FLAG_NODE *)0) { /* Ready ALL tasks waiting for flags */
|
|
(void)OS_FlagTaskRdy(pnode, (OS_FLAGS)0, OS_STAT_PEND_ABORT);
|
|
pnode = (OS_FLAG_NODE *)pnode->OSFlagNodeNext;
|
|
}
|
|
#if OS_FLAG_NAME_EN > 0u
|
|
pgrp->OSFlagName = (INT8U *)(void *)"?";
|
|
#endif
|
|
pgrp->OSFlagType = OS_EVENT_TYPE_UNUSED;
|
|
pgrp->OSFlagWaitList = (void *)OSFlagFreeList;/* Return group to free list */
|
|
pgrp->OSFlagFlags = (OS_FLAGS)0;
|
|
OSFlagFreeList = pgrp;
|
|
OS_EXIT_CRITICAL();
|
|
if (tasks_waiting == OS_TRUE) { /* Reschedule only if task(s) were waiting */
|
|
OS_Sched(); /* Find highest priority task ready to run */
|
|
}
|
|
*perr = OS_ERR_NONE;
|
|
pgrp_return = (OS_FLAG_GRP *)0; /* Event Flag Group has been deleted */
|
|
break;
|
|
|
|
default:
|
|
OS_EXIT_CRITICAL();
|
|
*perr = OS_ERR_INVALID_OPT;
|
|
pgrp_return = pgrp;
|
|
break;
|
|
}
|
|
|
|
OS_TRACE_FLAG_DEL_EXIT(*perr);
|
|
|
|
return (pgrp_return);
|
|
}
|
|
#endif
|
|
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
* GET THE NAME OF AN EVENT FLAG GROUP
|
|
*
|
|
* Description: This function is used to obtain the name assigned to an event flag group
|
|
*
|
|
* Arguments : pgrp is a pointer to the event flag group.
|
|
*
|
|
* pname is pointer to a pointer to an ASCII string that will receive the name of the event flag
|
|
* group.
|
|
*
|
|
* perr is a pointer to an error code that can contain one of the following values:
|
|
*
|
|
* OS_ERR_NONE if the requested task is resumed
|
|
* OS_ERR_EVENT_TYPE if 'pevent' is not pointing to an event flag group
|
|
* OS_ERR_PNAME_NULL You passed a NULL pointer for 'pname'
|
|
* OS_ERR_FLAG_INVALID_PGRP if you passed a NULL pointer for 'pgrp'
|
|
* OS_ERR_NAME_GET_ISR if you called this function from an ISR
|
|
*
|
|
* Returns : The length of the string or 0 if the 'pgrp' is a NULL pointer.
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
#if OS_FLAG_NAME_EN > 0u
|
|
INT8U OSFlagNameGet (OS_FLAG_GRP *pgrp,
|
|
INT8U **pname,
|
|
INT8U *perr)
|
|
{
|
|
INT8U len;
|
|
#if OS_CRITICAL_METHOD == 3u /* Allocate storage for CPU status register */
|
|
OS_CPU_SR cpu_sr = 0u;
|
|
#endif
|
|
|
|
|
|
|
|
#ifdef OS_SAFETY_CRITICAL
|
|
if (perr == (INT8U *)0) {
|
|
OS_SAFETY_CRITICAL_EXCEPTION();
|
|
return (0u);
|
|
}
|
|
#endif
|
|
|
|
#if OS_ARG_CHK_EN > 0u
|
|
if (pgrp == (OS_FLAG_GRP *)0) { /* Is 'pgrp' a NULL pointer? */
|
|
*perr = OS_ERR_FLAG_INVALID_PGRP;
|
|
return (0u);
|
|
}
|
|
if (pname == (INT8U **)0) { /* Is 'pname' a NULL pointer? */
|
|
*perr = OS_ERR_PNAME_NULL;
|
|
return (0u);
|
|
}
|
|
#endif
|
|
if (OSIntNesting > 0u) { /* See if trying to call from an ISR */
|
|
*perr = OS_ERR_NAME_GET_ISR;
|
|
return (0u);
|
|
}
|
|
OS_ENTER_CRITICAL();
|
|
if (pgrp->OSFlagType != OS_EVENT_TYPE_FLAG) {
|
|
OS_EXIT_CRITICAL();
|
|
*perr = OS_ERR_EVENT_TYPE;
|
|
return (0u);
|
|
}
|
|
*pname = pgrp->OSFlagName;
|
|
len = OS_StrLen(*pname);
|
|
OS_EXIT_CRITICAL();
|
|
*perr = OS_ERR_NONE;
|
|
return (len);
|
|
}
|
|
#endif
|
|
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
* ASSIGN A NAME TO AN EVENT FLAG GROUP
|
|
*
|
|
* Description: This function assigns a name to an event flag group.
|
|
*
|
|
* Arguments : pgrp is a pointer to the event flag group.
|
|
*
|
|
* pname is a pointer to an ASCII string that will be used as the name of the event flag
|
|
* group.
|
|
*
|
|
* perr is a pointer to an error code that can contain one of the following values:
|
|
*
|
|
* OS_ERR_NONE if the requested task is resumed
|
|
* OS_ERR_EVENT_TYPE if 'pevent' is not pointing to an event flag group
|
|
* OS_ERR_PNAME_NULL You passed a NULL pointer for 'pname'
|
|
* OS_ERR_FLAG_INVALID_PGRP if you passed a NULL pointer for 'pgrp'
|
|
* OS_ERR_NAME_SET_ISR if you called this function from an ISR
|
|
*
|
|
* Returns : None
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
#if OS_FLAG_NAME_EN > 0u
|
|
void OSFlagNameSet (OS_FLAG_GRP *pgrp,
|
|
INT8U *pname,
|
|
INT8U *perr)
|
|
{
|
|
#if OS_CRITICAL_METHOD == 3u /* Allocate storage for CPU status register */
|
|
OS_CPU_SR cpu_sr = 0u;
|
|
#endif
|
|
|
|
|
|
|
|
#ifdef OS_SAFETY_CRITICAL
|
|
if (perr == (INT8U *)0) {
|
|
OS_SAFETY_CRITICAL_EXCEPTION();
|
|
return;
|
|
}
|
|
#endif
|
|
|
|
#if OS_ARG_CHK_EN > 0u
|
|
if (pgrp == (OS_FLAG_GRP *)0) { /* Is 'pgrp' a NULL pointer? */
|
|
*perr = OS_ERR_FLAG_INVALID_PGRP;
|
|
return;
|
|
}
|
|
if (pname == (INT8U *)0) { /* Is 'pname' a NULL pointer? */
|
|
*perr = OS_ERR_PNAME_NULL;
|
|
return;
|
|
}
|
|
#endif
|
|
if (OSIntNesting > 0u) { /* See if trying to call from an ISR */
|
|
*perr = OS_ERR_NAME_SET_ISR;
|
|
return;
|
|
}
|
|
OS_ENTER_CRITICAL();
|
|
if (pgrp->OSFlagType != OS_EVENT_TYPE_FLAG) {
|
|
OS_EXIT_CRITICAL();
|
|
*perr = OS_ERR_EVENT_TYPE;
|
|
return;
|
|
}
|
|
pgrp->OSFlagName = pname;
|
|
OS_EXIT_CRITICAL();
|
|
OS_TRACE_EVENT_NAME_SET(pgrp, pname);
|
|
*perr = OS_ERR_NONE;
|
|
return;
|
|
}
|
|
#endif
|
|
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
* WAIT ON AN EVENT FLAG GROUP
|
|
*
|
|
* Description: This function is called to wait for a combination of bits to be set in an event flag
|
|
* group. Your application can wait for ANY bit to be set or ALL bits to be set.
|
|
*
|
|
* Arguments : pgrp is a pointer to the desired event flag group.
|
|
*
|
|
* flags Is a bit pattern indicating which bit(s) (i.e. flags) you wish to wait for.
|
|
* The bits you want are specified by setting the corresponding bits in
|
|
* 'flags'. e.g. if your application wants to wait for bits 0 and 1 then
|
|
* 'flags' would contain 0x03.
|
|
*
|
|
* wait_type specifies whether you want ALL bits to be set or ANY of the bits to be set.
|
|
* You can specify the following argument:
|
|
*
|
|
* OS_FLAG_WAIT_CLR_ALL You will wait for ALL bits in 'mask' to be clear (0)
|
|
* OS_FLAG_WAIT_SET_ALL You will wait for ALL bits in 'mask' to be set (1)
|
|
* OS_FLAG_WAIT_CLR_ANY You will wait for ANY bit in 'mask' to be clear (0)
|
|
* OS_FLAG_WAIT_SET_ANY You will wait for ANY bit in 'mask' to be set (1)
|
|
*
|
|
* NOTE: Add OS_FLAG_CONSUME if you want the event flag to be 'consumed' by
|
|
* the call. Example, to wait for any flag in a group AND then clear
|
|
* the flags that are present, set 'wait_type' to:
|
|
*
|
|
* OS_FLAG_WAIT_SET_ANY + OS_FLAG_CONSUME
|
|
*
|
|
* timeout is an optional timeout (in clock ticks) that your task will wait for the
|
|
* desired bit combination. If you specify 0, however, your task will wait
|
|
* forever at the specified event flag group or, until a message arrives.
|
|
*
|
|
* perr is a pointer to an error code and can be:
|
|
* OS_ERR_NONE The desired bits have been set within the specified
|
|
* 'timeout'.
|
|
* OS_ERR_PEND_ISR If you tried to PEND from an ISR
|
|
* OS_ERR_FLAG_INVALID_PGRP If 'pgrp' is a NULL pointer.
|
|
* OS_ERR_EVENT_TYPE You are not pointing to an event flag group
|
|
* OS_ERR_TIMEOUT The bit(s) have not been set in the specified
|
|
* 'timeout'.
|
|
* OS_ERR_PEND_ABORT The wait on the flag was aborted.
|
|
* OS_ERR_FLAG_WAIT_TYPE You didn't specify a proper 'wait_type' argument.
|
|
*
|
|
* Returns : The flags in the event flag group that made the task ready or, 0 if a timeout or an error
|
|
* occurred.
|
|
*
|
|
* Called from: Task ONLY
|
|
*
|
|
* Note(s) : 1) IMPORTANT, the behavior of this function has changed from PREVIOUS versions. The
|
|
* function NOW returns the flags that were ready INSTEAD of the current state of the
|
|
* event flags.
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
OS_FLAGS OSFlagPend (OS_FLAG_GRP *pgrp,
|
|
OS_FLAGS flags,
|
|
INT8U wait_type,
|
|
INT32U timeout,
|
|
INT8U *perr)
|
|
{
|
|
OS_FLAG_NODE node;
|
|
OS_FLAGS flags_rdy;
|
|
INT8U result;
|
|
INT8U pend_stat;
|
|
BOOLEAN consume;
|
|
#if OS_CRITICAL_METHOD == 3u /* Allocate storage for CPU status register */
|
|
OS_CPU_SR cpu_sr = 0u;
|
|
#endif
|
|
|
|
|
|
#ifdef OS_SAFETY_CRITICAL
|
|
if (perr == (INT8U *)0) {
|
|
OS_SAFETY_CRITICAL_EXCEPTION();
|
|
return ((OS_FLAGS)0);
|
|
}
|
|
#endif
|
|
|
|
#if OS_ARG_CHK_EN > 0u
|
|
if (pgrp == (OS_FLAG_GRP *)0) { /* Validate 'pgrp' */
|
|
*perr = OS_ERR_FLAG_INVALID_PGRP;
|
|
return ((OS_FLAGS)0);
|
|
}
|
|
#endif
|
|
|
|
OS_TRACE_FLAG_PEND_ENTER(pgrp, flags, timeout, wait_type);
|
|
|
|
if (OSIntNesting > 0u) { /* See if called from ISR ... */
|
|
*perr = OS_ERR_PEND_ISR; /* ... can't PEND from an ISR */
|
|
OS_TRACE_FLAG_PEND_EXIT(*perr);
|
|
return ((OS_FLAGS)0);
|
|
}
|
|
if (OSLockNesting > 0u) { /* See if called with scheduler locked ... */
|
|
*perr = OS_ERR_PEND_LOCKED; /* ... can't PEND when locked */
|
|
OS_TRACE_FLAG_PEND_EXIT(*perr);
|
|
return ((OS_FLAGS)0);
|
|
}
|
|
if (pgrp->OSFlagType != OS_EVENT_TYPE_FLAG) { /* Validate event block type */
|
|
*perr = OS_ERR_EVENT_TYPE;
|
|
OS_TRACE_FLAG_PEND_EXIT(*perr);
|
|
return ((OS_FLAGS)0);
|
|
}
|
|
result = (INT8U)(wait_type & OS_FLAG_CONSUME);
|
|
if (result != (INT8U)0) { /* See if we need to consume the flags */
|
|
wait_type &= (INT8U)~(INT8U)OS_FLAG_CONSUME;
|
|
consume = OS_TRUE;
|
|
} else {
|
|
consume = OS_FALSE;
|
|
}
|
|
|
|
OS_ENTER_CRITICAL();
|
|
switch (wait_type) {
|
|
case OS_FLAG_WAIT_SET_ALL: /* See if all required flags are set */
|
|
flags_rdy = (OS_FLAGS)(pgrp->OSFlagFlags & flags); /* Extract only the bits we want */
|
|
if (flags_rdy == flags) { /* Must match ALL the bits that we want */
|
|
if (consume == OS_TRUE) { /* See if we need to consume the flags */
|
|
pgrp->OSFlagFlags &= (OS_FLAGS)~flags_rdy; /* Clear ONLY the flags we wanted */
|
|
}
|
|
OSTCBCur->OSTCBFlagsRdy = flags_rdy; /* Save flags that were ready */
|
|
OS_EXIT_CRITICAL(); /* Yes, condition met, return to caller */
|
|
*perr = OS_ERR_NONE;
|
|
OS_TRACE_FLAG_PEND_EXIT(*perr);
|
|
return (flags_rdy);
|
|
} else { /* Block task until events occur or timeout */
|
|
OS_FlagBlock(pgrp, &node, flags, wait_type, timeout);
|
|
OS_EXIT_CRITICAL();
|
|
}
|
|
break;
|
|
|
|
case OS_FLAG_WAIT_SET_ANY:
|
|
flags_rdy = (OS_FLAGS)(pgrp->OSFlagFlags & flags); /* Extract only the bits we want */
|
|
if (flags_rdy != (OS_FLAGS)0) { /* See if any flag set */
|
|
if (consume == OS_TRUE) { /* See if we need to consume the flags */
|
|
pgrp->OSFlagFlags &= (OS_FLAGS)~flags_rdy; /* Clear ONLY the flags that we got */
|
|
}
|
|
OSTCBCur->OSTCBFlagsRdy = flags_rdy; /* Save flags that were ready */
|
|
OS_EXIT_CRITICAL(); /* Yes, condition met, return to caller */
|
|
*perr = OS_ERR_NONE;
|
|
OS_TRACE_FLAG_PEND_EXIT(*perr);
|
|
return (flags_rdy);
|
|
} else { /* Block task until events occur or timeout */
|
|
OS_FlagBlock(pgrp, &node, flags, wait_type, timeout);
|
|
OS_EXIT_CRITICAL();
|
|
}
|
|
break;
|
|
|
|
#if OS_FLAG_WAIT_CLR_EN > 0u
|
|
case OS_FLAG_WAIT_CLR_ALL: /* See if all required flags are cleared */
|
|
flags_rdy = (OS_FLAGS)~pgrp->OSFlagFlags & flags; /* Extract only the bits we want */
|
|
if (flags_rdy == flags) { /* Must match ALL the bits that we want */
|
|
if (consume == OS_TRUE) { /* See if we need to consume the flags */
|
|
pgrp->OSFlagFlags |= flags_rdy; /* Set ONLY the flags that we wanted */
|
|
}
|
|
OSTCBCur->OSTCBFlagsRdy = flags_rdy; /* Save flags that were ready */
|
|
OS_EXIT_CRITICAL(); /* Yes, condition met, return to caller */
|
|
*perr = OS_ERR_NONE;
|
|
OS_TRACE_FLAG_PEND_EXIT(*perr);
|
|
return (flags_rdy);
|
|
} else { /* Block task until events occur or timeout */
|
|
OS_FlagBlock(pgrp, &node, flags, wait_type, timeout);
|
|
OS_EXIT_CRITICAL();
|
|
}
|
|
break;
|
|
|
|
case OS_FLAG_WAIT_CLR_ANY:
|
|
flags_rdy = (OS_FLAGS)~pgrp->OSFlagFlags & flags; /* Extract only the bits we want */
|
|
if (flags_rdy != (OS_FLAGS)0) { /* See if any flag cleared */
|
|
if (consume == OS_TRUE) { /* See if we need to consume the flags */
|
|
pgrp->OSFlagFlags |= flags_rdy; /* Set ONLY the flags that we got */
|
|
}
|
|
OSTCBCur->OSTCBFlagsRdy = flags_rdy; /* Save flags that were ready */
|
|
OS_EXIT_CRITICAL(); /* Yes, condition met, return to caller */
|
|
*perr = OS_ERR_NONE;
|
|
OS_TRACE_FLAG_PEND_EXIT(*perr);
|
|
return (flags_rdy);
|
|
} else { /* Block task until events occur or timeout */
|
|
OS_FlagBlock(pgrp, &node, flags, wait_type, timeout);
|
|
OS_EXIT_CRITICAL();
|
|
}
|
|
break;
|
|
#endif
|
|
|
|
default:
|
|
OS_EXIT_CRITICAL();
|
|
flags_rdy = (OS_FLAGS)0;
|
|
*perr = OS_ERR_FLAG_WAIT_TYPE;
|
|
OS_TRACE_FLAG_PEND_EXIT(*perr);
|
|
return (flags_rdy);
|
|
}
|
|
|
|
OS_Sched(); /* Find next HPT ready to run */
|
|
OS_ENTER_CRITICAL();
|
|
if (OSTCBCur->OSTCBStatPend != OS_STAT_PEND_OK) { /* Have we timed-out or aborted? */
|
|
pend_stat = OSTCBCur->OSTCBStatPend;
|
|
OSTCBCur->OSTCBStatPend = OS_STAT_PEND_OK;
|
|
OS_FlagUnlink(&node);
|
|
OSTCBCur->OSTCBStat = OS_STAT_RDY; /* Yes, make task ready-to-run */
|
|
OS_EXIT_CRITICAL();
|
|
flags_rdy = (OS_FLAGS)0;
|
|
switch (pend_stat) {
|
|
case OS_STAT_PEND_ABORT:
|
|
*perr = OS_ERR_PEND_ABORT; /* Indicate that we aborted waiting */
|
|
break;
|
|
|
|
case OS_STAT_PEND_TO:
|
|
default:
|
|
*perr = OS_ERR_TIMEOUT; /* Indicate that we timed-out waiting */
|
|
break;
|
|
}
|
|
OS_TRACE_FLAG_PEND_EXIT(*perr);
|
|
return (flags_rdy);
|
|
}
|
|
flags_rdy = OSTCBCur->OSTCBFlagsRdy;
|
|
if (consume == OS_TRUE) { /* See if we need to consume the flags */
|
|
switch (wait_type) {
|
|
case OS_FLAG_WAIT_SET_ALL:
|
|
case OS_FLAG_WAIT_SET_ANY: /* Clear ONLY the flags we got */
|
|
pgrp->OSFlagFlags &= (OS_FLAGS)~flags_rdy;
|
|
break;
|
|
|
|
#if OS_FLAG_WAIT_CLR_EN > 0u
|
|
case OS_FLAG_WAIT_CLR_ALL:
|
|
case OS_FLAG_WAIT_CLR_ANY: /* Set ONLY the flags we got */
|
|
pgrp->OSFlagFlags |= flags_rdy;
|
|
break;
|
|
#endif
|
|
default:
|
|
OS_EXIT_CRITICAL();
|
|
*perr = OS_ERR_FLAG_WAIT_TYPE;
|
|
OS_TRACE_FLAG_PEND_EXIT(*perr);
|
|
return ((OS_FLAGS)0);
|
|
}
|
|
}
|
|
OS_EXIT_CRITICAL();
|
|
*perr = OS_ERR_NONE; /* Event(s) must have occurred */
|
|
OS_TRACE_FLAG_PEND_EXIT(*perr);
|
|
return (flags_rdy);
|
|
}
|
|
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
* GET FLAGS WHO CAUSED TASK TO BECOME READY
|
|
*
|
|
* Description: This function is called to obtain the flags that caused the task to become ready to run.
|
|
* In other words, this function allows you to tell "Who done it!".
|
|
*
|
|
* Arguments : None
|
|
*
|
|
* Returns : The flags that caused the task to be ready.
|
|
*
|
|
* Called from: Task ONLY
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
OS_FLAGS OSFlagPendGetFlagsRdy (void)
|
|
{
|
|
OS_FLAGS flags;
|
|
#if OS_CRITICAL_METHOD == 3u /* Allocate storage for CPU status register */
|
|
OS_CPU_SR cpu_sr = 0u;
|
|
#endif
|
|
|
|
|
|
|
|
OS_ENTER_CRITICAL();
|
|
flags = OSTCBCur->OSTCBFlagsRdy;
|
|
OS_EXIT_CRITICAL();
|
|
return (flags);
|
|
}
|
|
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
* POST EVENT FLAG BIT(S)
|
|
*
|
|
* Description: This function is called to set or clear some bits in an event flag group. The bits to
|
|
* set or clear are specified by a 'bit mask'.
|
|
*
|
|
* Arguments : pgrp is a pointer to the desired event flag group.
|
|
*
|
|
* flags If 'opt' (see below) is OS_FLAG_SET, each bit that is set in 'flags' will
|
|
* set the corresponding bit in the event flag group. e.g. to set bits 0, 4
|
|
* and 5 you would set 'flags' to:
|
|
*
|
|
* 0x31 (note, bit 0 is least significant bit)
|
|
*
|
|
* If 'opt' (see below) is OS_FLAG_CLR, each bit that is set in 'flags' will
|
|
* CLEAR the corresponding bit in the event flag group. e.g. to clear bits 0,
|
|
* 4 and 5 you would specify 'flags' as:
|
|
*
|
|
* 0x31 (note, bit 0 is least significant bit)
|
|
*
|
|
* opt indicates whether the flags will be:
|
|
* set (OS_FLAG_SET) or
|
|
* cleared (OS_FLAG_CLR)
|
|
*
|
|
* perr is a pointer to an error code and can be:
|
|
* OS_ERR_NONE The call was successfull
|
|
* OS_ERR_FLAG_INVALID_PGRP You passed a NULL pointer
|
|
* OS_ERR_EVENT_TYPE You are not pointing to an event flag group
|
|
* OS_ERR_FLAG_INVALID_OPT You specified an invalid option
|
|
*
|
|
* Returns : the new value of the event flags bits that are still set.
|
|
*
|
|
* Called From: Task or ISR
|
|
*
|
|
* WARNING(s) : 1) The execution time of this function depends on the number of tasks waiting on the event
|
|
* flag group.
|
|
* 2) The amount of time interrupts are DISABLED depends on the number of tasks waiting on
|
|
* the event flag group.
|
|
*********************************************************************************************************
|
|
*/
|
|
OS_FLAGS OSFlagPost (OS_FLAG_GRP *pgrp,
|
|
OS_FLAGS flags,
|
|
INT8U opt,
|
|
INT8U *perr)
|
|
{
|
|
OS_FLAG_NODE *pnode;
|
|
BOOLEAN sched;
|
|
OS_FLAGS flags_cur;
|
|
OS_FLAGS flags_rdy;
|
|
BOOLEAN rdy;
|
|
#if OS_CRITICAL_METHOD == 3u /* Allocate storage for CPU status register */
|
|
OS_CPU_SR cpu_sr = 0u;
|
|
#endif
|
|
|
|
|
|
#ifdef OS_SAFETY_CRITICAL
|
|
if (perr == (INT8U *)0) {
|
|
OS_SAFETY_CRITICAL_EXCEPTION();
|
|
return ((OS_FLAGS)0);
|
|
}
|
|
#endif
|
|
|
|
#if OS_ARG_CHK_EN > 0u
|
|
if (pgrp == (OS_FLAG_GRP *)0) { /* Validate 'pgrp' */
|
|
*perr = OS_ERR_FLAG_INVALID_PGRP;
|
|
return ((OS_FLAGS)0);
|
|
}
|
|
#endif
|
|
|
|
OS_TRACE_FLAG_POST_ENTER(pgrp, flags, opt);
|
|
|
|
if (pgrp->OSFlagType != OS_EVENT_TYPE_FLAG) { /* Make sure we are pointing to an event flag grp */
|
|
*perr = OS_ERR_EVENT_TYPE;
|
|
OS_TRACE_FLAG_POST_EXIT(*perr);
|
|
return ((OS_FLAGS)0);
|
|
}
|
|
|
|
OS_ENTER_CRITICAL();
|
|
switch (opt) {
|
|
case OS_FLAG_CLR:
|
|
pgrp->OSFlagFlags &= (OS_FLAGS)~flags; /* Clear the flags specified in the group */
|
|
break;
|
|
|
|
case OS_FLAG_SET:
|
|
pgrp->OSFlagFlags |= flags; /* Set the flags specified in the group */
|
|
break;
|
|
|
|
default:
|
|
OS_EXIT_CRITICAL(); /* INVALID option */
|
|
*perr = OS_ERR_FLAG_INVALID_OPT;
|
|
OS_TRACE_FLAG_POST_EXIT(*perr);
|
|
return ((OS_FLAGS)0);
|
|
}
|
|
sched = OS_FALSE; /* Indicate that we don't need rescheduling */
|
|
pnode = (OS_FLAG_NODE *)pgrp->OSFlagWaitList;
|
|
while (pnode != (OS_FLAG_NODE *)0) { /* Go through all tasks waiting on event flag(s) */
|
|
switch (pnode->OSFlagNodeWaitType) {
|
|
case OS_FLAG_WAIT_SET_ALL: /* See if all req. flags are set for current node */
|
|
flags_rdy = (OS_FLAGS)(pgrp->OSFlagFlags & pnode->OSFlagNodeFlags);
|
|
if (flags_rdy == pnode->OSFlagNodeFlags) { /* Make task RTR, event(s) Rx'd */
|
|
rdy = OS_FlagTaskRdy(pnode, flags_rdy, OS_STAT_PEND_OK);
|
|
if (rdy == OS_TRUE) {
|
|
sched = OS_TRUE; /* When done we will reschedule */
|
|
}
|
|
}
|
|
break;
|
|
|
|
case OS_FLAG_WAIT_SET_ANY: /* See if any flag set */
|
|
flags_rdy = (OS_FLAGS)(pgrp->OSFlagFlags & pnode->OSFlagNodeFlags);
|
|
if (flags_rdy != (OS_FLAGS)0) { /* Make task RTR, event(s) Rx'd */
|
|
rdy = OS_FlagTaskRdy(pnode, flags_rdy, OS_STAT_PEND_OK);
|
|
if (rdy == OS_TRUE) {
|
|
sched = OS_TRUE; /* When done we will reschedule */
|
|
}
|
|
}
|
|
break;
|
|
|
|
#if OS_FLAG_WAIT_CLR_EN > 0u
|
|
case OS_FLAG_WAIT_CLR_ALL: /* See if all req. flags are set for current node */
|
|
flags_rdy = (OS_FLAGS)~pgrp->OSFlagFlags & pnode->OSFlagNodeFlags;
|
|
if (flags_rdy == pnode->OSFlagNodeFlags) { /* Make task RTR, event(s) Rx'd */
|
|
rdy = OS_FlagTaskRdy(pnode, flags_rdy, OS_STAT_PEND_OK);
|
|
if (rdy == OS_TRUE) {
|
|
sched = OS_TRUE; /* When done we will reschedule */
|
|
}
|
|
}
|
|
break;
|
|
|
|
case OS_FLAG_WAIT_CLR_ANY: /* See if any flag set */
|
|
flags_rdy = (OS_FLAGS)~pgrp->OSFlagFlags & pnode->OSFlagNodeFlags;
|
|
if (flags_rdy != (OS_FLAGS)0) { /* Make task RTR, event(s) Rx'd */
|
|
rdy = OS_FlagTaskRdy(pnode, flags_rdy, OS_STAT_PEND_OK);
|
|
if (rdy == OS_TRUE) {
|
|
sched = OS_TRUE; /* When done we will reschedule */
|
|
}
|
|
}
|
|
break;
|
|
#endif
|
|
default:
|
|
OS_EXIT_CRITICAL();
|
|
*perr = OS_ERR_FLAG_WAIT_TYPE;
|
|
OS_TRACE_FLAG_POST_EXIT(*perr);
|
|
return ((OS_FLAGS)0);
|
|
}
|
|
pnode = (OS_FLAG_NODE *)pnode->OSFlagNodeNext; /* Point to next task waiting for event flag(s) */
|
|
}
|
|
OS_EXIT_CRITICAL();
|
|
if (sched == OS_TRUE) {
|
|
OS_Sched();
|
|
}
|
|
OS_ENTER_CRITICAL();
|
|
flags_cur = pgrp->OSFlagFlags;
|
|
OS_EXIT_CRITICAL();
|
|
*perr = OS_ERR_NONE;
|
|
OS_TRACE_FLAG_POST_EXIT(*perr);
|
|
|
|
return (flags_cur);
|
|
}
|
|
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
* QUERY EVENT FLAG
|
|
*
|
|
* Description: This function is used to check the value of the event flag group.
|
|
*
|
|
* Arguments : pgrp is a pointer to the desired event flag group.
|
|
*
|
|
* perr is a pointer to an error code returned to the called:
|
|
* OS_ERR_NONE The call was successfull
|
|
* OS_ERR_FLAG_INVALID_PGRP You passed a NULL pointer
|
|
* OS_ERR_EVENT_TYPE You are not pointing to an event flag group
|
|
*
|
|
* Returns : The current value of the event flag group.
|
|
*
|
|
* Called From: Task or ISR
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
#if OS_FLAG_QUERY_EN > 0u
|
|
OS_FLAGS OSFlagQuery (OS_FLAG_GRP *pgrp,
|
|
INT8U *perr)
|
|
{
|
|
OS_FLAGS flags;
|
|
#if OS_CRITICAL_METHOD == 3u /* Allocate storage for CPU status register */
|
|
OS_CPU_SR cpu_sr = 0u;
|
|
#endif
|
|
|
|
|
|
|
|
#ifdef OS_SAFETY_CRITICAL
|
|
if (perr == (INT8U *)0) {
|
|
OS_SAFETY_CRITICAL_EXCEPTION();
|
|
return ((OS_FLAGS)0);
|
|
}
|
|
#endif
|
|
|
|
#if OS_ARG_CHK_EN > 0u
|
|
if (pgrp == (OS_FLAG_GRP *)0) { /* Validate 'pgrp' */
|
|
*perr = OS_ERR_FLAG_INVALID_PGRP;
|
|
return ((OS_FLAGS)0);
|
|
}
|
|
#endif
|
|
if (pgrp->OSFlagType != OS_EVENT_TYPE_FLAG) { /* Validate event block type */
|
|
*perr = OS_ERR_EVENT_TYPE;
|
|
return ((OS_FLAGS)0);
|
|
}
|
|
OS_ENTER_CRITICAL();
|
|
flags = pgrp->OSFlagFlags;
|
|
OS_EXIT_CRITICAL();
|
|
*perr = OS_ERR_NONE;
|
|
return (flags); /* Return the current value of the event flags */
|
|
}
|
|
#endif
|
|
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
* SUSPEND TASK UNTIL EVENT FLAG(s) RECEIVED OR TIMEOUT OCCURS
|
|
*
|
|
* Description: This function is internal to uC/OS-II and is used to put a task to sleep until the desired
|
|
* event flag bit(s) are set.
|
|
*
|
|
* Arguments : pgrp is a pointer to the desired event flag group.
|
|
*
|
|
* pnode is a pointer to a structure which contains data about the task waiting for
|
|
* event flag bit(s) to be set.
|
|
*
|
|
* flags Is a bit pattern indicating which bit(s) (i.e. flags) you wish to check.
|
|
* The bits you want are specified by setting the corresponding bits in
|
|
* 'flags'. e.g. if your application wants to wait for bits 0 and 1 then
|
|
* 'flags' would contain 0x03.
|
|
*
|
|
* wait_type specifies whether you want ALL bits to be set/cleared or ANY of the bits
|
|
* to be set/cleared.
|
|
* You can specify the following argument:
|
|
*
|
|
* OS_FLAG_WAIT_CLR_ALL You will check ALL bits in 'mask' to be clear (0)
|
|
* OS_FLAG_WAIT_CLR_ANY You will check ANY bit in 'mask' to be clear (0)
|
|
* OS_FLAG_WAIT_SET_ALL You will check ALL bits in 'mask' to be set (1)
|
|
* OS_FLAG_WAIT_SET_ANY You will check ANY bit in 'mask' to be set (1)
|
|
*
|
|
* timeout is the desired amount of time that the task will wait for the event flag
|
|
* bit(s) to be set.
|
|
*
|
|
* Returns : none
|
|
*
|
|
* Called by : OSFlagPend() OS_FLAG.C
|
|
*
|
|
* Note(s) : This function is INTERNAL to uC/OS-II and your application should not call it.
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
static void OS_FlagBlock (OS_FLAG_GRP *pgrp,
|
|
OS_FLAG_NODE *pnode,
|
|
OS_FLAGS flags,
|
|
INT8U wait_type,
|
|
INT32U timeout)
|
|
{
|
|
OS_FLAG_NODE *pnode_next;
|
|
INT8U y;
|
|
|
|
|
|
OSTCBCur->OSTCBStat |= OS_STAT_FLAG;
|
|
OSTCBCur->OSTCBStatPend = OS_STAT_PEND_OK;
|
|
OSTCBCur->OSTCBDly = timeout; /* Store timeout in task's TCB */
|
|
#if OS_TASK_DEL_EN > 0u
|
|
OSTCBCur->OSTCBFlagNode = pnode; /* TCB to link to node */
|
|
#endif
|
|
pnode->OSFlagNodeFlags = flags; /* Save the flags that we need to wait for */
|
|
pnode->OSFlagNodeWaitType = wait_type; /* Save the type of wait we are doing */
|
|
pnode->OSFlagNodeTCB = (void *)OSTCBCur; /* Link to task's TCB */
|
|
pnode->OSFlagNodeNext = pgrp->OSFlagWaitList; /* Add node at beginning of event flag wait list */
|
|
pnode->OSFlagNodePrev = (void *)0;
|
|
pnode->OSFlagNodeFlagGrp = (void *)pgrp; /* Link to Event Flag Group */
|
|
pnode_next = (OS_FLAG_NODE *)pgrp->OSFlagWaitList;
|
|
if (pnode_next != (void *)0) { /* Is this the first NODE to insert? */
|
|
pnode_next->OSFlagNodePrev = pnode; /* No, link in doubly linked list */
|
|
}
|
|
pgrp->OSFlagWaitList = (void *)pnode;
|
|
|
|
y = OSTCBCur->OSTCBY; /* Suspend current task until flag(s) received */
|
|
OSRdyTbl[y] &= (OS_PRIO)~OSTCBCur->OSTCBBitX;
|
|
OS_TRACE_TASK_SUSPENDED(OSTCBCur);
|
|
if (OSRdyTbl[y] == 0x00u) {
|
|
OSRdyGrp &= (OS_PRIO)~OSTCBCur->OSTCBBitY;
|
|
}
|
|
}
|
|
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
* INITIALIZE THE EVENT FLAG MODULE
|
|
*
|
|
* Description: This function is called by uC/OS-II to initialize the event flag module. Your application
|
|
* MUST NOT call this function. In other words, this function is internal to uC/OS-II.
|
|
*
|
|
* Arguments : none
|
|
*
|
|
* Returns : none
|
|
*
|
|
* WARNING : You MUST NOT call this function from your code. This is an INTERNAL function to uC/OS-II.
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
void OS_FlagInit (void)
|
|
{
|
|
#if OS_MAX_FLAGS == 1u
|
|
OSFlagFreeList = (OS_FLAG_GRP *)&OSFlagTbl[0]; /* Only ONE event flag group! */
|
|
OSFlagFreeList->OSFlagType = OS_EVENT_TYPE_UNUSED;
|
|
OSFlagFreeList->OSFlagWaitList = (void *)0;
|
|
OSFlagFreeList->OSFlagFlags = (OS_FLAGS)0;
|
|
#if OS_FLAG_NAME_EN > 0u
|
|
OSFlagFreeList->OSFlagName = (INT8U *)"?";
|
|
#endif
|
|
#endif
|
|
|
|
#if OS_MAX_FLAGS >= 2u
|
|
INT16U ix;
|
|
INT16U ix_next;
|
|
OS_FLAG_GRP *pgrp1;
|
|
OS_FLAG_GRP *pgrp2;
|
|
|
|
|
|
OS_MemClr((INT8U *)&OSFlagTbl[0], sizeof(OSFlagTbl)); /* Clear the flag group table */
|
|
for (ix = 0u; ix < (OS_MAX_FLAGS - 1u); ix++) { /* Init. list of free EVENT FLAGS */
|
|
ix_next = ix + 1u;
|
|
pgrp1 = &OSFlagTbl[ix];
|
|
pgrp2 = &OSFlagTbl[ix_next];
|
|
pgrp1->OSFlagType = OS_EVENT_TYPE_UNUSED;
|
|
pgrp1->OSFlagWaitList = (void *)pgrp2;
|
|
#if OS_FLAG_NAME_EN > 0u
|
|
pgrp1->OSFlagName = (INT8U *)(void *)"?"; /* Unknown name */
|
|
#endif
|
|
}
|
|
pgrp1 = &OSFlagTbl[ix];
|
|
pgrp1->OSFlagType = OS_EVENT_TYPE_UNUSED;
|
|
pgrp1->OSFlagWaitList = (void *)0;
|
|
#if OS_FLAG_NAME_EN > 0u
|
|
pgrp1->OSFlagName = (INT8U *)(void *)"?"; /* Unknown name */
|
|
#endif
|
|
OSFlagFreeList = &OSFlagTbl[0];
|
|
#endif
|
|
}
|
|
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
* MAKE TASK READY-TO-RUN, EVENT(s) OCCURRED
|
|
*
|
|
* Description: This function is internal to uC/OS-II and is used to make a task ready-to-run because the
|
|
* desired event flag bits have been set.
|
|
*
|
|
* Arguments : pnode is a pointer to a structure which contains data about the task waiting for
|
|
* event flag bit(s) to be set.
|
|
*
|
|
* flags_rdy contains the bit pattern of the event flags that cause the task to become
|
|
* ready-to-run.
|
|
*
|
|
* pend_stat is used to indicate the readied task's pending status:
|
|
*
|
|
*
|
|
* Returns : OS_TRUE If the task has been placed in the ready list and thus needs scheduling
|
|
* OS_FALSE The task is still not ready to run and thus scheduling is not necessary
|
|
*
|
|
* Called by : OSFlagsPost() OS_FLAG.C
|
|
*
|
|
* Note(s) : 1) This function assumes that interrupts are disabled.
|
|
* 2) This function is INTERNAL to uC/OS-II and your application should not call it.
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
static BOOLEAN OS_FlagTaskRdy (OS_FLAG_NODE *pnode,
|
|
OS_FLAGS flags_rdy,
|
|
INT8U pend_stat)
|
|
{
|
|
OS_TCB *ptcb;
|
|
BOOLEAN sched;
|
|
|
|
|
|
ptcb = (OS_TCB *)pnode->OSFlagNodeTCB; /* Point to TCB of waiting task */
|
|
ptcb->OSTCBDly = 0u;
|
|
ptcb->OSTCBFlagsRdy = flags_rdy;
|
|
ptcb->OSTCBStat &= (INT8U)~(INT8U)OS_STAT_FLAG;
|
|
ptcb->OSTCBStatPend = pend_stat;
|
|
if (ptcb->OSTCBStat == OS_STAT_RDY) { /* Task now ready? */
|
|
OSRdyGrp |= ptcb->OSTCBBitY; /* Put task into ready list */
|
|
OSRdyTbl[ptcb->OSTCBY] |= ptcb->OSTCBBitX;
|
|
OS_TRACE_TASK_READY(ptcb);
|
|
sched = OS_TRUE;
|
|
} else {
|
|
sched = OS_FALSE;
|
|
}
|
|
OS_FlagUnlink(pnode);
|
|
return (sched);
|
|
}
|
|
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
* UNLINK EVENT FLAG NODE FROM WAITING LIST
|
|
*
|
|
* Description: This function is internal to uC/OS-II and is used to unlink an event flag node from a
|
|
* list of tasks waiting for the event flag.
|
|
*
|
|
* Arguments : pnode is a pointer to a structure which contains data about the task waiting for
|
|
* event flag bit(s) to be set.
|
|
*
|
|
* Returns : none
|
|
*
|
|
* Called by : OS_FlagTaskRdy() OS_FLAG.C
|
|
* OSFlagPend() OS_FLAG.C
|
|
* OSTaskDel() OS_TASK.C
|
|
*
|
|
* Note(s) : 1) This function assumes that interrupts are disabled.
|
|
* 2) This function is INTERNAL to uC/OS-II and your application should not call it.
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
void OS_FlagUnlink (OS_FLAG_NODE *pnode)
|
|
{
|
|
#if OS_TASK_DEL_EN > 0u
|
|
OS_TCB *ptcb;
|
|
#endif
|
|
OS_FLAG_GRP *pgrp;
|
|
OS_FLAG_NODE *pnode_prev;
|
|
OS_FLAG_NODE *pnode_next;
|
|
|
|
|
|
pnode_prev = (OS_FLAG_NODE *)pnode->OSFlagNodePrev;
|
|
pnode_next = (OS_FLAG_NODE *)pnode->OSFlagNodeNext;
|
|
if (pnode_prev == (OS_FLAG_NODE *)0) { /* Is it first node in wait list? */
|
|
pgrp = (OS_FLAG_GRP *)pnode->OSFlagNodeFlagGrp;
|
|
pgrp->OSFlagWaitList = (void *)pnode_next; /* Update list for new 1st node */
|
|
if (pnode_next != (OS_FLAG_NODE *)0) {
|
|
pnode_next->OSFlagNodePrev = (OS_FLAG_NODE *)0; /* Link new 1st node PREV to NULL */
|
|
}
|
|
} else { /* No, A node somewhere in the list */
|
|
pnode_prev->OSFlagNodeNext = pnode_next; /* Link around the node to unlink */
|
|
if (pnode_next != (OS_FLAG_NODE *)0) { /* Was this the LAST node? */
|
|
pnode_next->OSFlagNodePrev = pnode_prev; /* No, Link around current node */
|
|
}
|
|
}
|
|
#if OS_TASK_DEL_EN > 0u
|
|
ptcb = (OS_TCB *)pnode->OSFlagNodeTCB;
|
|
ptcb->OSTCBFlagNode = (OS_FLAG_NODE *)0;
|
|
#endif
|
|
}
|
|
#endif
|
|
#endif /* OS_FLAG_C */
|