/****************************************Copyright (c)**************************************************
**                               廣州周立功單片機發展有限公司
**                                     研    究    所
**                                        產品一部 
**
**                                 http://www.zlgmcu.com
**
**--------------文件信息--------------------------------------------------------------------------------
** 文 件 名: queue.h
** 創 建 人: 陳明計
** 修改日期: 2003年7月2日
** 描    述: 數據隊列的中間件
** 聲    明: 廣州周立功單片機發展有限公司不提供任何類型的擔保。不論是明確的，還是隱含的。
**           包括但不限于合適特定用途的保證。全部的風險，由使用者來承擔。如果程序出現缺陷，
**           使用者承擔所有必要的服務、修改和改正的費用。
**              
**--------------歷史版本信息----------------------------------------------------------------------------
** 創建人: 陳明計
** 版  本: v1.0
** 日　期: 2003年7月2日
** 描　述: 原始版本
**
**--------------當前版本修訂------------------------------------------------------------------------------
** 修改人: 陳明計
** 日　期: 2004年5月19日
** 描　述: 改正注釋錯誤
**
**------------------------------------------------------------------------------------------------------
********************************************************************************************************/
#define QUEUE_DATA_TYPE           uint8

#define EN_QUEUE_WRITE            1     // 禁止(0)或允許(1)FIFO發送數據      
#define EN_QUEUE_WRITE_FRONT      0     // 禁止(0)或允許(1)LIFO發送數據      
#define EN_QUEUE_NDATA            1     // 禁止(0)或允許(1)取得隊列數據數目  
#define EN_QUEUE_SIZE             1     // 禁止(0)或允許(1)取得隊列數據總容量 
#define EN_QUEUE_FLUSH            1     // 禁止(0)或允許(1)清空隊列     

#ifndef NOT_OK
#define NOT_OK              0xff                        /* 參數錯誤                                     */
#endif

#define QUEUE_FULL          8                           /* 隊列滿                                       */
#define QUEUE_EMPTY         4                           /* 無數據                                       */
#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;                   /* 指向數據輸出位置         */
    QUEUE_DATA_TYPE     *In;                    /* 指向數據輸入位置         */
    QUEUE_DATA_TYPE     *End;                   /* 指向Buf的結束位置        */
    uint16             NData;                   /* 隊列中數據個數           */
    uint16             MaxData;                 /* 隊列中允許存儲的數據個數 */
    
    uint8               (* ReadEmpty)();        /* 讀空處理函數             */
    uint8               (* WriteFull)();        /* 寫滿處理函數             */
    QUEUE_DATA_TYPE     Buf[1];                 /* 存儲數據的空間           */
} DataQueue;


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

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

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

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

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

extern uint16 QueueSize(void *Buf);
/*********************************************************************************************************
** 函數名稱: QueueSize
** 功能描述: 取得隊列總容量
** 輸　入: Buf:指向隊列的指針
** 輸　出: 隊列總容量
** 全局變量: 無
** 調用模塊: OS_ENTER_CRITICAL,OS_EXIT_CRITICAL
********************************************************************************************************/

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

//#define EN_QUEUE_WRITE            0     /* 禁止(0)或允許(1)FIFO發送數據       */
//#define EN_QUEUE_WRITE_FRONT      0     /* 禁止(0)或允許(1)LIFO發送數據       */
//#define EN_QUEUE_NDATA            0     /* 禁止(0)或允許(1)取得隊列數據數目   */
//#define EN_QUEUE_SIZE             0     /* 禁止(0)或允許(1)取得隊列數據總容量 */
//#define EN_QUEUE_FLUSH            0     /* 禁止(0)或允許(1)清空隊列           */

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