/*
*******************************************************************************
*                    Copyright (c) 2005, Comba Telecom System
*                             All Rights Reserved
*
* Purpose           : queue file
* File Name         : queue.c

* Chip type         : LPC22XX(ARM7TDMI)
* IDE               : ADS1.2

* Revision history  :
    01a,2005/08/16,Lu jiangmin  -- Creation(written),re. zlgmcu Chen mingji

* Description       :
    
  
*******************************************************************************
*/
#define IN_QUEUE
#include "config.h"

/*	
*******************************************************************************
* 函數(shù)功能: 初始化數(shù)據(jù)隊(duì)列
* 說 明: 
*       1.  輸入:
            Buf--為隊(duì)列分配的存儲(chǔ)空間地址;
            SizeOfBuf--為隊(duì)列分配的存儲(chǔ)空間大小;
            ReadEmpty--隊(duì)列讀空處理程序;
            WriteFull--隊(duì)列寫滿處理程序.
            輸出:
            QUEUE_OK:成功;
            NOT_OK:參數(shù)錯(cuò)誤.
            
*       2.  基本方法:
            
*       3.  注意:
*******************************************************************************
*/
INT8U QueueCreate(void *Buf, INT32U SizeOfBuf, INT8U (* ReadEmpty)(), INT8U (* WriteFull)())
{
    DataQueue *Queue;
    
    if (Buf != NULL && SizeOfBuf >= (sizeof(DataQueue)))        // 判斷參數(shù)是否有效
    {
        Queue = (DataQueue *)Buf;

        OS_ENTER_CRITICAL();
                                                                // 初始化結(jié)構(gòu)體數(shù)據(jù)
        Queue->MaxData = (SizeOfBuf - (INT32U)(((DataQueue *)0)->Buf)) / 
                         sizeof(QUEUE_DATA_TYPE);               // 計(jì)算隊(duì)列可以存儲(chǔ)的數(shù)據(jù)數(shù)目
        Queue->End = Queue->Buf + Queue->MaxData;               // 計(jì)算數(shù)據(jù)緩沖的結(jié)束地址
        Queue->Out = Queue->Buf;
        Queue->In = Queue->Buf;
        Queue->NData = 0;
        Queue->ReadEmpty = ReadEmpty;
        Queue->WriteFull = WriteFull;

        OS_EXIT_CRITICAL();

        return QUEUE_OK;
    }
    else
    {
        return NOT_OK;
    }
}

INT8U QueueRead(QUEUE_DATA_TYPE *Ret, void *Buf)
{
    INT8U err;
    DataQueue *Queue;

    err = NOT_OK;
    if (Buf != NULL)                                            /* 隊(duì)列是否有效 */
    {                                                           /* 有效 */
        Queue = (DataQueue *)Buf;
        
        OS_ENTER_CRITICAL();
        
        if (Queue->NData > 0)                                   /* 隊(duì)列是否為空 */
        {                                                       /* 不空         */
            *Ret = Queue->Out[0];                               /* 數(shù)據(jù)出隊(duì)     */
            Queue->Out++;                                       /* 調(diào)整出隊(duì)指針 */
            if (Queue->Out >= Queue->End)
            {
                Queue->Out = Queue->Buf;
            }
            Queue->NData--;                                     /* 數(shù)據(jù)減少      */
            err = QUEUE_OK;
        }
        else
        {                                                       /* 空              */
            err = QUEUE_EMPTY;
            if (Queue->ReadEmpty != NULL)                       /* 調(diào)用用戶處理函數(shù) */
            {
                err = Queue->ReadEmpty(Ret, Queue);
            }
        }
        OS_EXIT_CRITICAL();
    }
    return err;
}

#ifndef EN_QUEUE_WRITE
#define EN_QUEUE_WRITE      0
#endif

#if EN_QUEUE_WRITE > 0

INT8U QueueWrite(void *Buf, QUEUE_DATA_TYPE Data)
{
    INT8U err;
    DataQueue *Queue;

    err = NOT_OK;
    if (Buf != NULL)                                                    /* 隊(duì)列是否有效 */
    {
        Queue = (DataQueue *)Buf;
        
        OS_ENTER_CRITICAL();
        
        if (Queue->NData < Queue->MaxData)                              /* 隊(duì)列是否滿  */
        {                                                               /* 不滿        */
            Queue->In[0] = Data;                                        /* 數(shù)據(jù)入隊(duì)    */
            Queue->In++;                                                /* 調(diào)整入隊(duì)指針*/
            if (Queue->In >= Queue->End)
            {
                Queue->In = Queue->Buf;
            }
            Queue->NData++;                                             /* 數(shù)據(jù)增加    */
            err = QUEUE_OK;
        }
        else
        {                                                               /* 滿           */
            err = QUEUE_FULL;
            if (Queue->WriteFull != NULL)                               /* 調(diào)用用戶處理函數(shù) */
            {
                err = Queue->WriteFull(Queue, Data, Q_WRITE_MODE);
            }
        }
        OS_EXIT_CRITICAL();
    }
    return err;
}
#endif

#ifndef EN_QUEUE_WRITE_FRONT
#define EN_QUEUE_WRITE_FRONT    0
#endif

#if EN_QUEUE_WRITE_FRONT > 0

INT8U QueueWriteFront(void *Buf, QUEUE_DATA_TYPE Data)
{
    INT8U err;
    DataQueue *Queue;

    err = NOT_OK;
    if (Buf != NULL)                                                    /* 隊(duì)列是否有效 */
    {
        Queue = (DataQueue *)Buf;
        
        OS_ENTER_CRITICAL();
        
        if (Queue->NData < Queue->MaxData)                              /* 隊(duì)列是否滿  */
        {                                                               /* 不滿 */
            Queue->Out--;                                               /* 調(diào)整出隊(duì)指針 */
            if (Queue->Out < Queue->Buf)
            {
                Queue->Out = Queue->End - 1;
            }
            Queue->Out[0] = Data;                                       /* 數(shù)據(jù)入隊(duì)     */
            Queue->NData++;                                             /* 數(shù)據(jù)數(shù)目增加 */
            err = QUEUE_OK;
        }
        else
        {                                                               /* 滿           */
            err = QUEUE_FULL;
            if (Queue->WriteFull != NULL)                               /* 調(diào)用用戶處理函數(shù) */
            {
                err = Queue->WriteFull(Queue, Data, Q_WRITE_FRONT_MODE);
            }
        }
        OS_EXIT_CRITICAL();
    }
    return err;
}

#endif

#ifndef EN_QUEUE_NDATA
#define EN_QUEUE_NDATA    0
#endif

#if EN_QUEUE_NDATA > 0

INT16U QueueNData(void *Buf)
{
    INT16U temp;
    
    temp = 0;                                                   /* 隊(duì)列無效返回0 */
    if (Buf != NULL)
    {
        OS_ENTER_CRITICAL();
        temp = ((DataQueue *)Buf)->NData;
        OS_EXIT_CRITICAL();
    }
    return temp;
}

#endif

#ifndef EN_QUEUE_SIZE
#define EN_QUEUE_SIZE    0
#endif

#if EN_QUEUE_SIZE > 0

INT16U QueueSize(void *Buf)
{
    INT16U temp;
    
    temp = 0;                                                   /* 隊(duì)列無效返回0 */
    if (Buf != NULL)
    {
        OS_ENTER_CRITICAL();
        temp = ((DataQueue *)Buf)->MaxData;
        OS_EXIT_CRITICAL();
    }
    return temp;
}

#endif

#ifndef EN_QUEUE_FLUSH
#define EN_QUEUE_FLUSH    0
#endif

#if EN_QUEUE_FLUSH > 0

void QueueFlush(void *Buf)
{
    DataQueue *Queue;
    
    if (Buf != NULL)                                                /* 隊(duì)列是否有效 */
    {                                                               /* 有效         */
        Queue = (DataQueue *)Buf;
        OS_ENTER_CRITICAL();
        Queue->Out = Queue->Buf;
        Queue->In = Queue->Buf;
        Queue->NData = 0;                                           /* 數(shù)據(jù)數(shù)目為0 */
        OS_EXIT_CRITICAL();
    }
}

#endif