Eric Ebert
CoOS Demonstrator adapted to mbed Hardware.
Diff: queue.c
- Revision:
- 0:57690853989a
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/queue.c Fri Dec 03 19:45:30 2010 +0000
@@ -0,0 +1,391 @@
+/**
+ *******************************************************************************
+ * @file queue.c
+ * @version V1.1.3
+ * @date 2010.04.26
+ * @brief Queue management implementation code of CooCox CoOS kernel.
+ *******************************************************************************
+ * @copy
+ *
+ * INTERNAL FILE,DON'T PUBLIC.
+ *
+ * <h2><center>© COPYRIGHT 2009 CooCox </center></h2>
+ *******************************************************************************
+ */
+
+/*---------------------------- Include ---------------------------------------*/
+#include <coocox.h>
+
+
+#if CFG_QUEUE_EN > 0
+/*---------------------------- Variable Define -------------------------------*/
+QCB QueueTbl[CFG_MAX_QUEUE] = {{0}}; /*!< Queue control block table */
+U32 QueueIDVessel = 0; /*!< Queue list mask */
+
+
+
+/**
+ *******************************************************************************
+ * @brief Create a queue
+ * @param[in] qStart Pointer to mail pointer buffer.
+ * @param[in] size The length of queue.
+ * @param[in] sortType Mail queue waiting list sort type.
+ * @param[out] None
+ * @retval E_CREATE_FAIL Create queue fail.
+ * @retval others Create queue successful.
+ *
+ * @par Description
+ * @details This function is called to create a queue.
+ * @note
+ *******************************************************************************
+ */
+OS_EventID CoCreateQueue(void **qStart, U16 size ,U8 sortType)
+{
+ U8 i;
+ P_ECB pecb;
+
+#if CFG_PAR_CHECKOUT_EN >0
+ if((qStart == 0) || (size == 0))
+ {
+ return E_CREATE_FAIL;
+ }
+#endif
+
+ OsSchedLock();
+ for(i = 0; i < CFG_MAX_QUEUE; i++)
+ {
+ /* Assign a free QUEUE control block */
+ if((QueueIDVessel & (1 << i)) == 0)
+ {
+ QueueIDVessel |= (1<<i);
+ OsSchedUnlock();
+
+ QueueTbl[i].qStart = qStart; /* Initialize the queue */
+ QueueTbl[i].id = i;
+ QueueTbl[i].head = 0;
+ QueueTbl[i].tail = 0;
+ QueueTbl[i].qMaxSize = size;
+ QueueTbl[i].qSize = 0;
+
+ /* Get a event control block and initial the event content */
+ pecb = CreatEvent(EVENT_TYPE_QUEUE,sortType,&QueueTbl[i]);
+
+ if(pecb == 0 ) /* If there is no free EVENT control block*/
+ {
+ return E_CREATE_FAIL;
+ }
+ return (pecb->id);
+ }
+ }
+
+ OsSchedUnlock();
+ return E_CREATE_FAIL; /* There is no free QUEUE control block */
+}
+
+
+/**
+ *******************************************************************************
+ * @brief Delete a queue
+ * @param[in] id Event ID.
+ * @param[in] opt Delete option.
+ * @param[out] None
+ * @retval E_INVALID_ID Invalid event ID.
+ * @retval E_INVALID_PARAMETER Invalid parameter.
+ * @retval E_TASK_WAITTING Tasks waitting for the event,delete fail.
+ * @retval E_OK Event deleted successful.
+ *
+ * @par Description
+ * @details This function is called to delete a queue.
+ * @note
+ *******************************************************************************
+ */
+StatusType CoDelQueue(OS_EventID id,U8 opt)
+{
+ P_ECB pecb;
+ P_QCB pqcb;
+ StatusType err;
+#if CFG_PAR_CHECKOUT_EN >0
+ if(id >= CFG_MAX_EVENT)
+ {
+ return E_INVALID_ID; /* Invalid id,return error */
+ }
+#endif
+
+ pecb = &EventTbl[id];
+#if CFG_PAR_CHECKOUT_EN >0
+ if( pecb->eventType != EVENT_TYPE_QUEUE)
+ {
+ return E_INVALID_ID; /* The event is not queue,return error*/
+ }
+#endif
+ pqcb = (P_QCB)pecb->eventPtr; /* Point at queue control block */
+ err = DeleteEvent(pecb,opt); /* Delete the event control block */
+ if(err == E_OK) /* If the event block have been deleted */
+ {
+ QueueIDVessel &= ~((U32)(1<<(pqcb->id))); /* Update free queue list */
+ pqcb->qStart = 0;
+ pqcb->id = 0;
+ pqcb->head = 0;
+ pqcb->tail = 0;
+ pqcb->qMaxSize = 0;
+ pqcb->qSize = 0;
+ }
+ return err;
+}
+
+
+
+/**
+ *******************************************************************************
+ * @brief Accept a mail from queue
+ * @param[in] id Event ID.
+ * @param[out] perr A pointer to error code.
+ * @retval 0
+ * @retval A pointer to mail accepted.
+ *
+ * @par Description
+ * @details This function is called to accept a mail from queue.
+ * @note
+ *******************************************************************************
+ */
+void* CoAcceptQueueMail(OS_EventID id,StatusType* perr)
+{
+ P_ECB pecb;
+ P_QCB pqcb;
+ void* pmail;
+#if CFG_PAR_CHECKOUT_EN >0
+ if(id >= CFG_MAX_EVENT)
+ {
+ *perr = E_INVALID_ID; /* Invalid id,return error */
+ return 0;
+ }
+#endif
+
+ pecb = &EventTbl[id];
+#if CFG_PAR_CHECKOUT_EN >0
+ if(pecb->eventType != EVENT_TYPE_QUEUE)/* Invalid event control block type*/
+ {
+ *perr = E_INVALID_ID;
+ return 0;
+ }
+#endif
+ pqcb = (P_QCB)pecb->eventPtr; /* Point at queue control block */
+ OsSchedLock();
+ if(pqcb->qSize != 0) /* If there are any messages in the queue */
+ {
+ /* Extract oldest message from the queue */
+ pmail = *(pqcb->qStart + pqcb->head);
+ pqcb->head++; /* Update the queue head */
+ pqcb->qSize--; /* Update the number of messages in the queue */
+ if(pqcb->head == pqcb->qMaxSize)
+ {
+ pqcb->head = 0;
+ }
+ OsSchedUnlock();
+ *perr = E_OK;
+ return pmail; /* Return message received */
+ }
+ else /* If there is no message in the queue*/
+ {
+ OsSchedUnlock();
+ *perr = E_QUEUE_EMPTY;
+ return 0; /* Return 0 */
+ }
+}
+
+
+
+/**
+ *******************************************************************************
+ * @brief Pend for a mail
+ * @param[in] id Event ID.
+ * @param[in] timeout The longest time for writting mail.
+ * @param[out] perr A pointer to error code.
+ * @retval 0
+ * @retval A pointer to mail accept.
+ *
+ * @par Description
+ * @details This function is called to wait for a mail.
+ * @note
+ *******************************************************************************
+ */
+void* CoPendQueueMail(OS_EventID id,U32 timeout,StatusType* perr)
+{
+ P_ECB pecb;
+ P_QCB pqcb;
+ P_OSTCB curTCB;
+ void* pmail;
+ if(OSIntNesting > 0) /* If the caller is ISR */
+ {
+ *perr = E_CALL;
+ return 0;
+ }
+#if CFG_PAR_CHECKOUT_EN >0
+ if(id >= CFG_MAX_EVENT)
+ {
+ *perr = E_INVALID_ID; /* Invalid event id,return error */
+ return 0;
+ }
+#endif
+
+ pecb = &EventTbl[id];
+#if CFG_PAR_CHECKOUT_EN >0
+ if(pecb->eventType != EVENT_TYPE_QUEUE) /* The event type is not queue */
+ {
+ *perr = E_INVALID_ID;
+ return 0;
+ }
+#endif
+ if(OSSchedLock != 0) /* Judge schedule is locked or not? */
+ {
+ *perr = E_OS_IN_LOCK; /* Schedule is locked,return error */
+ return 0;
+ }
+ pqcb = (P_QCB)pecb->eventPtr; /* Point at queue control block */
+
+ if(pqcb->qSize != 0) /* If there are any messages in the queue */
+ {
+ /* Extract oldest message from the queue */
+ pmail = *(pqcb->qStart + pqcb->head);
+ pqcb->head++; /* Update the queue head */
+ pqcb->qSize--; /* Update the number of messages in the queue */
+ if(pqcb->head == pqcb->qMaxSize)/* Check queue head */
+ {
+ pqcb->head = 0;
+ }
+ *perr = E_OK;
+ return pmail; /* Return message received */
+ }
+ else /* If there is no message in the queue*/
+ {
+ curTCB = TCBRunning;
+ if(timeout == 0) /* If time-out is not configured */
+ {
+ /* Block current task until the event occur */
+ EventTaskToWait(pecb,curTCB);
+
+ /* Have recived message or the queue have been deleted */
+ pmail = curTCB->pmail;
+ curTCB->pmail = 0;
+ *perr = E_OK;
+ return pmail; /* Return message received or 0 */
+ }
+ else /* If time-out is configured */
+ {
+ OsSchedLock();
+
+ /* Block current task until event or timeout occurs */
+ EventTaskToWait(pecb,curTCB);
+ InsertDelayList(curTCB,timeout);
+ OsSchedUnlock();
+ if(curTCB->pmail == 0) /* If time-out occurred */
+ {
+ *perr = E_TIMEOUT;
+ return 0;
+ }
+ else /* If event occured */
+ {
+ pmail = curTCB->pmail;
+ curTCB->pmail = 0;
+ *perr = E_OK;
+ return pmail; /* Return message received or 0 */
+ }
+ }
+ }
+}
+
+
+
+/**
+ *******************************************************************************
+ * @brief Post a mail to queue
+ * @param[in] id Event ID.
+ * @param[in] pmail Pointer to mail that want to send.
+ * @param[out] None
+ * @retval E_OK
+ * @retval E_INVALID_ID
+ * @retval E_QUEUE_FULL
+ *
+ * @par Description
+ * @details This function is called to post a mail to queue.
+ * @note
+ *******************************************************************************
+ */
+StatusType CoPostQueueMail(OS_EventID id,void* pmail)
+{
+ P_ECB pecb;
+ P_QCB pqcb;
+#if CFG_PAR_CHECKOUT_EN >0
+ if(id >= CFG_MAX_EVENT)
+ {
+ return E_INVALID_ID;
+ }
+#endif
+
+ pecb = &EventTbl[id];
+#if CFG_PAR_CHECKOUT_EN >0
+ if(pecb->eventType != EVENT_TYPE_QUEUE)
+ {
+ return E_INVALID_ID; /* The event type isn't queue,return */
+ }
+#endif
+ pqcb = (P_QCB)pecb->eventPtr;
+ if(pqcb->qSize == pqcb->qMaxSize) /* If queue is full */
+ {
+ return E_QUEUE_FULL;
+ }
+ else /* If queue is not full */
+ {
+ OsSchedLock();
+ *(pqcb->qStart + pqcb->tail) = pmail; /* Insert message into queue */
+ pqcb->tail++; /* Update queue tail */
+ pqcb->qSize++; /* Update the number of messages in the queue */
+ if(pqcb->tail == pqcb->qMaxSize) /* Check queue tail */
+ {
+ pqcb->tail = 0;
+ }
+ EventTaskToRdy(pecb); /* Check the event waiting list */
+ OsSchedUnlock();
+ return E_OK;
+ }
+}
+
+
+/**
+ *******************************************************************************
+ * @brief Post a mail to queue in ISR
+ * @param[in] id Event ID.
+ * @param[in] pmail Pointer to mail that want to send.
+ * @param[out] None
+ * @retval E_OK
+ * @retval E_INVALID_ID
+ * @retval E_QUEUE_FULL
+ *
+ * @par Description
+ * @details This function is called in ISR to post a mail to queue.
+ * @note
+ *******************************************************************************
+ */
+#if CFG_MAX_SERVICE_REQUEST > 0
+StatusType isr_PostQueueMail(OS_EventID id,void* pmail)
+{
+ if(OSSchedLock > 0) /* If scheduler is locked,(the caller is ISR) */
+ {
+ /* Insert the request into service request queue */
+ if(InsertInSRQ(QUEUE_REQ,id,pmail) == FALSE)
+ {
+ return E_SEV_REQ_FULL; /* If service request queue is full */
+ }
+ else /* If the request have been inserted into service request queue */
+ {
+ return E_OK;
+ }
+ }
+ else /* The scheduler is unlocked */
+ {
+ return(CoPostQueueMail(id,pmail)); /* Send the message to the queue*/
+ }
+}
+#endif
+
+#endif