feat: add task message queue check API

Add a new API to check if the task message queue is full or not.

Signed-off-by: Don Dominic <[email protected]>

Author: Don Dominic

Source/os.h

@@ -1672,6 +1672,7 @@ void          OSTaskQPost               (OS_TCB                *p_tcb,
                                          OS_OPT                 opt,
                                          OS_ERR                *p_err);
 
+CPU_BOOLEAN   OSTaskQIsFull             (OS_TCB                *p_tcb);
 #endif
 
 #if (OS_CFG_TASK_REG_TBL_SIZE > 0u)
@@ -2010,6 +2011,8 @@ void          OS_MsgQPut                (OS_MSG_Q              *p_msg_q,
                                          CPU_TS                 ts,
                                          OS_ERR                *p_err);
 
+CPU_BOOLEAN   OS_MsgQIsFull             (OS_MSG_Q              *p_msg_q);
+
 /* ---------------------------------------------- PEND/POST MANAGEMENT ---------------------------------------------- */
 
 void          OS_Pend                   (OS_PEND_OBJ           *p_obj,

Source/os_msg.c

@@ -346,4 +346,30 @@ void  OS_MsgQPut (OS_MSG_Q     *p_msg_q,
 #endif
    *p_err          = OS_ERR_NONE;
 }
+
+
+/*
+************************************************************************************************************************
+*                                                   CHECK MESSAGE QUEUE
+*
+* Description: This function checks if the message queue is full or not
+*
+* Arguments  : p_msg_q     is a pointer to the message queue
+*              -------
+*
+* Returns    : == OS_FALSE   if message queue is not full.
+*              == OS_TRUE    if message queue is full.
+*
+* Note(s)    : 1) This function is INTERNAL to uC/OS-III and your application MUST NOT call it.
+************************************************************************************************************************
+*/
+
+CPU_BOOLEAN  OS_MsgQIsFull (OS_MSG_Q   *p_msg_q)
+{
+    if (p_msg_q->NbrEntries >= p_msg_q->NbrEntriesSize) {
+        return(OS_TRUE);
+    } else {
+        return(OS_FALSE);
+    }
+}
 #endif

Source/os_task.c

@@ -1170,6 +1170,34 @@ void  OSTaskQPost (OS_TCB       *p_tcb,
 #endif
 
 
+/*
+************************************************************************************************************************
+*                                               TASK MESSAGE Q CHECK
+*
+* Description: This function checks if the task message queue is full or not.
+*
+* Arguments  : p_tcb      is a pointer to the TCB of the task.  If you specify a NULL pointer then the check is 
+*                         performed for the queue of the calling task.  
+*
+* Returns    : == OS_FALSE   if task message queue is not full.
+*              == OS_TRUE    if task message queue is full.
+*
+* Note(s)    : none
+************************************************************************************************************************
+*/
+
+#if (OS_CFG_TASK_Q_EN > 0u)
+CPU_BOOLEAN  OSTaskQIsFull (OS_TCB  *p_tcb)
+{
+    if (p_tcb == (OS_TCB *)0) {                                 /* Check for 'self'?                                    */
+        p_tcb = OSTCBCurPtr;
+    }
+
+    return (OS_MsgQIsFull(&p_tcb->MsgQ));
+}
+#endif
+
+
 /*
 ************************************************************************************************************************
 *                                       GET THE CURRENT VALUE OF A TASK REGISTER