/****************************************Copyright (c)**************************************************
**                               廣州周立功單片機(jī)發(fā)展有限公司
**                                     研    究    所
**                                        產(chǎn)品一部 
**
**                                 http://www.zlgmcu.com
**
**--------------文件信息--------------------------------------------------------------------------------
**文   件   名: queue.h
**創(chuàng)   建   人: 陳明計(jì)
**最后修改日期: 2003年7月2日
**描        述: 數(shù)據(jù)隊(duì)列的中間件
**              
**--------------歷史版本信息----------------------------------------------------------------------------
** 創(chuàng)建人: 陳明計(jì)
** 版  本: v1.0
** 日　期: 2003年7月2日
** 描　述: 原始版本
**
**--------------當(dāng)前版本修訂------------------------------------------------------------------------------
** 修改人: 陳明計(jì)
** 日　期: 2004年5月19日
** 描　述: 改正注釋錯(cuò)誤
**
**------------------------------------------------------------------------------------------------------
********************************************************************************************************/


#ifndef NOT_OK
#define NOT_OK              0xff                        /* 參數(shù)錯(cuò)誤                                     */
#endif

#define QUEUE_FULL          8                           /* 隊(duì)列滿                                       */
#define QUEUE_EMPTY         4                           /* 無(wú)數(shù)據(jù)                                       */
#define QUEUE_OK            1                           /* 操作成功                                     */

#define Q_WRITE_MODE        1                           /* 操作成功                                     */
#define Q_WRITE_FRONT_MODE  2                           /* 操作成功                                     */

#ifndef QUEUE_DATA_TYPE
#define QUEUE_DATA_TYPE     uint8
#endif

typedef struct {
    QUEUE_DATA_TYPE     *Out;                   /* 指向數(shù)據(jù)輸出位置         */
    QUEUE_DATA_TYPE     *In;                    /* 指向數(shù)據(jù)輸入位置         */
    QUEUE_DATA_TYPE     *End;                   /* 指向Buf的結(jié)束位置        */
    uint16              NData;                  /* 隊(duì)列中數(shù)據(jù)個(gè)數(shù)           */
    uint16              MaxData;                /* 隊(duì)列中允許存儲(chǔ)的數(shù)據(jù)個(gè)數(shù) */
    
    uint8               (* ReadEmpty)();        /* 讀空處理函數(shù)             */
    uint8               (* WriteFull)();        /* 寫滿處理函數(shù)             */
    QUEUE_DATA_TYPE     Buf[1];                 /* 存儲(chǔ)數(shù)據(jù)的空間           */
} DataQueue;


#ifndef IN_QUEUE
        uint8 QueueCreate(void *Buf,
                          uint32 SizeOfBuf,
                          uint8 (* ReadEmpty)(),
                          uint8 (* WriteFull)()
                          );
/*********************************************************************************************************
** 函數(shù)名稱: QueueCreate
** 功能描述: 初始化數(shù)據(jù)隊(duì)列
** 輸　入: Buf      ：為隊(duì)列分配的存儲(chǔ)空間地址
**         SizeOfBuf：為隊(duì)列分配的存儲(chǔ)空間大小（字節(jié)）
**         ReadEmpty：為隊(duì)列讀空時(shí)處理程序
**         WriteFull：為隊(duì)列寫滿時(shí)處理程序
** 輸　出: NOT_OK  :參數(shù)錯(cuò)誤
**         QUEUE_OK:成功
** 全局變量: 無(wú)
** 調(diào)用模塊: OS_ENTER_CRITICAL,OS_EXIT_CRITICAL
********************************************************************************************************/

extern uint8 QueueRead(QUEUE_DATA_TYPE *Ret, void *Buf);
/*********************************************************************************************************
** 函數(shù)名稱: QueueRead
** 功能描述: 獲取隊(duì)列中的數(shù)據(jù)
** 輸　入: Ret:存儲(chǔ)返回的消息的地址
**         Buf:指向隊(duì)列的指針
** 輸　出: NOT_OK     ：參數(shù)錯(cuò)誤
**         QUEUE_OK   ：收到消息
**         QUEUE_EMPTY：隊(duì)列空
** 全局變量: 無(wú)
** 調(diào)用模塊: OS_ENTER_CRITICAL,OS_EXIT_CRITICAL
********************************************************************************************************/

extern uint8 QueueWrite(void *Buf, QUEUE_DATA_TYPE Data);
/*********************************************************************************************************
** 函數(shù)名稱: QueueWrite
** 功能描述: FIFO方式發(fā)送數(shù)據(jù)
** 輸　入: Buf :指向隊(duì)列的指針
**         Data:發(fā)送的數(shù)據(jù)
** 輸　出: NOT_OK   ：參數(shù)錯(cuò)誤
**         QUEUE_FULL:隊(duì)列滿
**         QUEUE_OK  :發(fā)送成功
** 全局變量: 無(wú)
** 調(diào)用模塊: OS_ENTER_CRITICAL,OS_EXIT_CRITICAL
********************************************************************************************************/

extern uint8 QueueWriteFront(void *Buf, QUEUE_DATA_TYPE Data);
/*********************************************************************************************************
** 函數(shù)名稱: QueueWrite
** 功能描述: LIFO方式發(fā)送數(shù)據(jù)
** 輸　入: Buf:指向隊(duì)列的指針
**         Data:消息數(shù)據(jù)
** 輸　出: QUEUE_FULL:隊(duì)列滿
**         QUEUE_OK:發(fā)送成功
** 全局變量: 無(wú)
** 調(diào)用模塊: OS_ENTER_CRITICAL,OS_EXIT_CRITICAL
********************************************************************************************************/

extern uint16 QueueNData(void *Buf);
/*********************************************************************************************************
** 函數(shù)名稱: QueueNData
** 功能描述: 取得隊(duì)列中數(shù)據(jù)數(shù)
** 輸　入: Buf:指向隊(duì)列的指針
** 輸　出: 消息數(shù)
** 全局變量: 無(wú)
** 調(diào)用模塊: OS_ENTER_CRITICAL,OS_EXIT_CRITICAL
********************************************************************************************************/

extern uint16 QueueSize(void *Buf);
/*********************************************************************************************************
** 函數(shù)名稱: QueueSize
** 功能描述: 取得隊(duì)列總?cè)萘?** 輸　入: Buf:指向隊(duì)列的指針
** 輸　出: 隊(duì)列總?cè)萘?** 全局變量: 無(wú)
** 調(diào)用模塊: OS_ENTER_CRITICAL,OS_EXIT_CRITICAL
********************************************************************************************************/

extern void QueueFlush(void *Buf);
/*********************************************************************************************************
** 函數(shù)名稱: OSQFlush
** 功能描述: 清空隊(duì)列
** 輸　入: Buf:指向隊(duì)列的指針
** 輸　出: 無(wú)
** 全局變量: 無(wú)
** 調(diào)用模塊: OS_ENTER_CRITICAL,OS_EXIT_CRITICAL
********************************************************************************************************/
#endif

//#define EN_QUEUE_WRITE            0     /* 禁止(0)或允許(1)FIFO發(fā)送數(shù)據(jù)       */
//#define EN_QUEUE_WRITE_FRONT      0     /* 禁止(0)或允許(1)LIFO發(fā)送數(shù)據(jù)       */
//#define EN_QUEUE_NDATA            0     /* 禁止(0)或允許(1)取得隊(duì)列數(shù)據(jù)數(shù)目   */
//#define EN_QUEUE_SIZE             0     /* 禁止(0)或允許(1)取得隊(duì)列數(shù)據(jù)總?cè)萘?*/
//#define EN_QUEUE_FLUSH            0     /* 禁止(0)或允許(1)清空隊(duì)列           */

/*********************************************************************************************************
**                            End Of File
********************************************************************************************************/