///
 // Copyright (c) 2003, Wolver Wang, MinShan Inc. R&D Center
 // wolver@minshan-inc.com
 // All rights reserved. 
 //
 // Redistribution and use in source and binary forms, with or without 
 // modification, are permitted provided that the following conditions 
 // are met: 
 // 1. Redistributions of source code must retain the above copyright 
 //    notice, this list of conditions and the following disclaimer. 
 // 2. Redistributions in binary form must reproduce the above copyright 
 //    notice, this list of conditions and the following disclaimer in the 
 //    documentation and/or other materials provided with the distribution. 
 // 3. All advertising materials mentioning features or use of this software
 //    must display the following acknowledgement:
 //      This product includes software developed by Wolver Wang.
 // 4. The name of the author may not be used to endorse or promote
 //    products derived from this software without specific prior
 //    written permission.  
 //
 // THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
 // OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 // ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 // DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 // DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 // GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.  
 ///
 

///
 // Copyright (c) 2003, Wolver Wang, MinShan Inc. R&D Center
 // wolver@minshan-inc.com
 // All rights reserved. 
 //
 // Redistribution and use in source and binary forms, with or without 
 // modification, are permitted provided that the following conditions 
 // are met: 
 // 1. Redistributions of source code must retain the above copyright 
 //    notice, this list of conditions and the following disclaimer. 
 // 2. Redistributions in binary form must reproduce the above copyright 
 //    notice, this list of conditions and the following disclaimer in the 
 //    documentation and/or other materials provided with the distribution. 
 // 3. All advertising materials mentioning features or use of this software
 //    must display the following acknowledgement:
 //      This product includes software developed by Wolver Wang.
 // 4. The name of the author may not be used to endorse or promote
 //    products derived from this software without specific prior
 //    written permission.  
 //
 // THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
 // OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 // ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 // DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 // DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 // GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.  
 ///
 

///
 // 版權 2003, 王衛無，四川綿陽岷山集團有限公司--研究開發中心
 // wolver@minshan-inc.com
 // 保留一切權利
 //
 // 如果符合以下條件，則無論是以原代碼或非原代碼代碼形式，且不論是否修改，
 // 再分發和使用本軟件都是被允許的。
 // 1. 原代碼的再分發必須保留上述的版權聲明、本條件說明和以下免責聲明。
 // 2. 非原代碼形式的再分發，必須在證明文件和(或)其它一同提供的材料中重新
 //    作上述的版權聲明、本條件說明和以下免責聲明。
 // 3. 一切提及本軟件和使用的廣告材料必須顯示以下致謝：
 //    本產品包含王衛無（四川綿陽岷山集團有限公司--研究開發中心）開發的軟件。
 // 4. 如果沒有預先得到特定的書面許可，不能用作者的名字來宣傳推廣基于本軟件得到
 //    的產品。
 //
 // 免責聲明：
 // 本軟件是由某某作者提供，如果出現以下情況，作者都不承擔任何責任。
 // 1. 因作者的說明以及任何明確的或暗示的保證(包括但不限于表達某種商業性和適合某一
 //    特定目的暗示性保證)而產生的損失。
 // 2. 無論在何種情況下，對使用本軟件造成的任何直接的、間接的、偶然的、特定的、可預
 //    見性的和連帶產生的損失(包括但不限于獲取產品和服務、作用喪失、數據遺失、利益損
 //    失或商業干預)，無論這些損失是怎樣造成的，并且是以何種方式闡釋責任。
 // 3. 任何因使用本軟件而相關的合同、嚴格賠償責任和侵權行為(包含：疏忽或其它)的損失，
 //    甚至即便是可能的此類已經明示或暗示的損失。
 ///



#ifndef	__DRIVERS_H__
#define	__DRIVERS_H__


#include "system.h"




// 定義全局變量和宏 ---------------------------------------------

//時基2Hz中斷統計次數統計，引用drivers.asm里的定義
extern volatile UINT16 guwTime2;

// 系統消息狀態（按bit定義），引用drivers.asm里的定義（包括宏）
extern volatile UINT16 guwMsg_Route;
#define cM_ARP_TIME			0x0001			// ARP表老化事件
#define cM_TCP_PERIODIC		0x0002			// TCP輪詢事件
#define cM_ADC_ENABLE		0x0004			// 允許ADC 轉換開始
#define cM_DAC1_ENABLE		0x0008			// 允許DAC1轉換開始
#define cM_DAC2_ENABLE		0x0010			// 允許DAC2轉換開始

// 分配系統應用臨時緩沖區（按 wrod 定義），guwAppBuf 引用main.c里的定義
#define cAppSizeMax		730    // 必須是偶數
extern UINT16 guwAppBuf[cAppSizeMax];

// 保存UART已接收到的Byte長度，引用drivers.asm里的定義
extern volatile UINT16 guwUartRxLen;
// UART接收緩沖區地址，按Word存放，guwAppBuf 引用main.c里的定義
#define guwUartRxBuf	((UINT16 *)&guwAppBuf[0])
// 定義UART允許使用的最大緩存，按Byte計算
#define cUART_RX_MAXLEN    1460    // 必須小于等于guwAppBuf的Byte容量

// 保存 MIC A/D 已接收到的Byte長度，引用drivers.asm里的定義
extern volatile UINT16 guwMicRxLen;
// MIC A/D 接收緩沖區地址，按Word存放，guwAppBuf 引用main.c里的定義
#define guwMicRxBuf  ((UINT16 *)&guwAppBuf[0])
// 定義 MIC A/D 允許使用的最大緩存，按Byte計算
#define cMIC_RX_MAXLEN   730    // 必須小于等于(guwAppBuf/2)的Byte容量

// 保存 DAC1 已轉換完成的Byte長度，引用drivers.asm里的定義
extern volatile UINT16 guwDAC1TxLen;
// DAC1 使用的緩沖區地址，按Word存放，guwAppBuf 引用main.c里的定義
#define guwDAC1TxBuf  ((UINT16 *)&guwAppBuf[cMIC_RX_MAXLEN])
// 定義 DAC1 允許使用的最大緩存，按Byte計算
#define cDAC1_MAXLEN   cMIC_RX_MAXLEN    // 必須等于guwMicRxBuf的Byte容量
// 定義當前DAC1需要轉換的總Byte長度(當存放值超過cDAC1_MAXLEN，會自動截為cDAC1_MAXLEN的長度)，引用drivers.asm里的定義
extern volatile UINT16 guwDAC1TotalLen;



//--------------------------------------------------------------------

//////////////////////////////////////////////////////////////////
// 定義‘開中斷’和‘關中斷’
//////////////////////////////////////////////////////////////////
#define SP_OPEN_IRQ()   __asm("irq on")
#define SP_OPEN_FIQ()   __asm("fiq on")
#define SP_CLOSE_IRQ()  __asm("irq off")
#define SP_CLOSE_FIQ()  __asm("fiq off")


//////////////////////////////////////////////////////////////////
// Function: void SP_OpenTime2();
// 開啟時基2Hz中斷
// 內有清除看門狗功能
//////////////////////////////////////////////////////////////////
extern void SP_OpenTime2(void);

//////////////////////////////////////////////////////////////////
// Function: void ClearWatchDog();
// 清看門狗，必須在程序運行0.75秒內執行
//////////////////////////////////////////////////////////////////
extern void ClearWatchDog(void);

//////////////////////////////////////////////////////////////////
// Function: void SP_CloseTime2();
// 關閉時基2Hz中斷
//////////////////////////////////////////////////////////////////
extern void SP_CloseTime2(void);

//////////////////////////////////////////////////////////////////
// Function: void SP_ADAC_INI(UINT16 Sample)
// A/D, D/A 初始化，TImeB 申請 FIQ 中斷
// TImeB 計時采用32768頻率
// Sample: 采樣率的定義，只能采用下面定義的宏。否則，產生不可預測錯誤！
//////////////////////////////////////////////////////////////////
extern void SP_ADAC_INIT(UINT16 Sample);
//////////////////////////////////////////////////////////////////
// 定義TimeB使用的計數初值，這些定義用于：void SP_ADAC_INI(UINT16 Sample)
// 使用32768Hz做基準
//////////////////////////////////////////////////////////////////
#define cSample_32768	0xffff		// 32768Hz 采樣：記 1 次
#define cSample_16384	0xfffe		// 16384Hz 采樣：記 2 次
#define cSample_8192	0xfffc		// 8192Hz  采樣：記 4 次
#define cSample_4096	0xfff8		// 4096Hz  采樣：記 8 次

//////////////////////////////////////////////////////////////////
// 功能函數: void SP_IO_INIT()
// (1) 初始化I/O工作狀態
// (2) IOA為輸入、高阻、喚醒模式
// (3) IOB[15-11]輸出'0'匹配8019as的SA[4-0]
// (4) IOB[6-4]輸出'1'匹配8019as的Reset, IORD , IOWR
// (5) IOB[3]下拉輸入模式，作為8019as的中斷輸入查詢
// (6) IOB[7]高阻輸入喚醒模式，作為Uart_RX
// (7) IOB[10]輸出'0'，作為Uart_TX
// (8) IOB[9-8,2-0]未使用，暫定為下拉輸入模式（抗干擾）。
// (9) 系統工作頻率 CPUCLK = 49.152MHz
// (10) 開放2Hz中斷，2Hz中斷內置清除看門狗功能！
// (11) 警告：所有程序過程不允許關閉2Hz中斷超過看門狗上限時間(0.75秒)
//////////////////////////////////////////////////////////////////
extern void SP_IO_INIT(void);

//////////////////////////////////////////////////////////////////
// Function: void SP_UART_INIT(UINT16 Baud)
// Rx/Tx interrupt mode, and setup Baud.
// DATA: 8bit
// STOP: 1bit
// PARITY Check: no
// IOB7/10  must be first set in SP_IO_INIT() as follows:
// (1) IOB[7]高阻輸入喚醒模式，作為Uart_RX
// (2) IOB[10]輸出'0'，作為Uart_TX
//////////////////////////////////////////////////////////////////
extern void SP_UART_INIT(UINT16 baud);
//////////////////////////////////////////////////////////////////
// Define for P_UART_BaudScalarLow and P_UART_BaudScalarHigh
// Fosc = 1500*32768 = 49.152MHz
//////////////////////////////////////////////////////////////////
#define C_UART_Baud_9600		0x0500	// ((1500*32768)/(4*9600))
#define C_UART_Baud_14400		0x0355 	// ((1500*32768)/(4*14400))
#define C_UART_Baud_19200		0x0280	// ((1500*32768)/(4*19200))
#define C_UART_Baud_38400		0x0140	// ((1500*32768)/(4*38400))
#define C_UART_Baud_57600		0x00d5	// ((1500*32768)/(4*57600))
#define C_UART_Baud_115200		0x006b	// ((1500*32768)/(4*115200))


//////////////////////////////////////////////////////////////////
// Function: void SP_UART_TX(UINT16 txlen, UINT16 *txbuf)
// txbuf: 指向發送首地址
// txlen: 待發送的Byte長度
// BIG_ENDIAN 模式對齊
//////////////////////////////////////////////////////////////////
extern void SP_UART_TX(UINT16 txlen, UINT16 *txbuf);



//--------------------------------------------------------------------

//////////////////////////////////////////////////////////////////
// Function: void MEMCPY(UINT16 ByteLen, UINT16 *in, UINT16 *out)
// Function: copy memory regions
// Description: This function copies <WordLen> Words from the memory
//              region pointed to by <in> to the memory region pointed
//              to by <out>
// Return: ignore
//////////////////////////////////////////////////////////////////
extern void MEMCPY(UINT16 ByteLen, UINT16 *in, UINT16 *out);

////////////////////////////////////////////////////////////////////////
// UINT16 checksum(UINT16 ByteLen, UINT16 *mbuf)
// TCP/IP 通用校驗和過程。由于用匯編，所以只適宜BIG_ENDIAN模式。
// ByteLen: 長度bytes，必須滿足條件：ByteLen >= 2 否則計算沒有意義
// mbuf: 存放Word緩沖區首指針
////////////////////////////////////////////////////////////////////////
extern UINT16 checksum(UINT16 ByteLen, UINT16 *mbuf);


//--------------------------------------------------------------------



//////////////////////////////////////////////////////////////////
// Function: void RTL8019AS_RESET(void)
// RTL8019AS硬件復位
//////////////////////////////////////////////////////////////////
extern void RTL8019AS_RESET(void);


//////////////////////////////////////////////////////////////////
// RTL8019AS初始化，包含軟復位。
// 返回0：表示MCU控制RTL8019AS通訊異常。
// 返回1：表示初始化成功。
//////////////////////////////////////////////////////////////////
extern UINT16 RTL8019AS_INIT(void);

//////////////////////////////////////////////////////////////////
// Function: void RTL8019AS_TX(UINT16 ByteLen, UINT16 *mbuf)
// ByteLen: 傳送以太包的字節數
// mbuf: 以太包緩沖區的首指針
//////////////////////////////////////////////////////////////////
extern void RTL8019AS_TX(UINT16 ByteLen, UINT16 *mbuf);

//////////////////////////////////////////////////////////////////
// Function: UINT16 RTL8019AS_RX(UINT16 *mbuf)
// mbuf: 以太包緩沖區的首指針
// 返回接收以太包的字節數。如果是0，則沒有包。
//////////////////////////////////////////////////////////////////
extern UINT16 RTL8019AS_RX(UINT16 *mbuf);
//--------------------------------------------------------------------

#endif