/****************************************Copyright (c)**************************************************
**                               Guangzhou ZHIYUAN electronics Co.,LTD.
**                                     
**                                 http://www.embedtools.com
**
**--------------File Info-------------------------------------------------------------------------------
** File Name:          Queue.c
** Last modified Date: 2006-11-18
** Last Version:       v1.1
** Description:        數據隊列的中間件
** 
**------------------------------------------------------------------------------------------------------
** Created By:         Chen Mingji
** Created date:       2003-7-2
** Version:            v1.0
** Descriptions:
**
**------------------------------------------------------------------------------------------------------
** Modified by:        Zhou Shaogang
** Modified date:      2006-11-18 
** Version:            v1.1
** Description:        增加QueueWriteN發送多個字節函數
**
********************************************************************************************************/

#define IN_QUEUE
#include "../config.h"

/*********************************************************************************************************
** 函數名稱: QueueCreate
** 功能描述: 初始化數據隊列
** 輸　入: Buf      ：為隊列分配的存儲空間地址
**         SizeOfBuf：為隊列分配的存儲空間大小（字節）
**         ReadEmpty：為隊列讀空時處理程序
**         WriteFull：為隊列寫滿時處理程序
** 輸　出: NOT_OK:參數錯誤
**         QUEUE_OK:成功
** 全局變量: 無
** 調用模塊: OS_ENTER_CRITICAL,OS_EXIT_CRITICAL
**
** 作　者: 陳明計
** 日　期: 2003年7月2日
**-------------------------------------------------------------------------------------------------------
** 修改人:
** 日　期:
**------------------------------------------------------------------------------------------------------
********************************************************************************************************/
        uint8 QueueCreate(void *Buf,
                          uint32 SizeOfBuf,
                          uint8 (* ReadEmpty)(),
                          uint8 (* WriteFull)()
                          )
{
    DataQueue *Queue;
    
    if (Buf != NULL && SizeOfBuf >= (sizeof(DataQueue)))        /* 判斷參數是否有效 */
    {
        Queue = (DataQueue *)Buf;

        OS_ENTER_CRITICAL();
                                                                /* 初始化結構體數據 */
        Queue->MaxData = (SizeOfBuf - (uint32)(((DataQueue *)0)->Buf)) / 
                         sizeof(QUEUE_DATA_TYPE);               /* 計算隊列可以存儲的數據數目 */
        Queue->End = Queue->Buf + Queue->MaxData;               /* 計算數據緩沖的結束地址 */
        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;
    }
}


/*********************************************************************************************************
** 函數名稱: QueueRead
** 功能描述: 獲取隊列中的數據
** 輸　入: Ret:存儲返回的消息的地址
**         Buf:指向隊列的指針
** 輸　出: NOT_OK     ：參數錯誤
**         QUEUE_OK   ：收到消息
**         QUEUE_EMPTY：無消息
** 全局變量: 無
** 調用模塊: OS_ENTER_CRITICAL,OS_EXIT_CRITICAL
**
** 作　者: 陳明計
** 日　期: 2003年7月2日
**-------------------------------------------------------------------------------------------------------
** 修改人:
** 日　期:
**------------------------------------------------------------------------------------------------------
********************************************************************************************************/
        uint8 QueueRead(QUEUE_DATA_TYPE *Ret, void *Buf)
{
    uint8 err;
    DataQueue *Queue;

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

/*********************************************************************************************************
** 函數名稱: QueueWrite
** 功能描述: FIFO方式發送數據
** 輸　入: Buf :指向隊列的指針
**         Data:消息數據
** 輸　出: NOT_OK   :參數錯誤
**         QUEUE_FULL:隊列滿
**         QUEUE_OK  :發送成功
** 全局變量: 無
** 調用模塊: OS_ENTER_CRITICAL,OS_EXIT_CRITICAL
**
** 作　者: 陳明計
** 日　期: 2003年7月2日
**-------------------------------------------------------------------------------------------------------
** 修改人:
** 日　期:
**------------------------------------------------------------------------------------------------------
********************************************************************************************************/
#ifndef EN_QUEUE_WRITE
#define EN_QUEUE_WRITE      0
#endif

#if EN_QUEUE_WRITE > 0

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

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

/*********************************************************************************************************
** 函數名稱: QueueWriteFront
** 功能描述: LIFO方式發送數據
** 輸　入: Buf:指向隊列的指針
**         Data:消息數據
** 輸　出: QUEUE_FULL:隊列滿
**         QUEUE_OK:發送成功
** 全局變量: 無
** 調用模塊: OS_ENTER_CRITICAL,OS_EXIT_CRITICAL
**
** 作　者: 陳明計
** 日　期: 2003年7月2日
**-------------------------------------------------------------------------------------------------------
** 修改人: