/* 2006.07.20 V1.0 for CH374, 2006.08.15 V1.1, 2006.09.21 V1.2, 2007.05.25 V1.3
****************************************
**  Copyright  (C)  W.ch  1999-2006   **
**  Web:  http://www.winchiphead.com  **
****************************************
**  USB Host File Interface for CH374 **
**  TC2.0@PC, IAR_C/EC++_3.20A@MSP430 **
****************************************
*/
/* CH374 主機文件系統接口 */
/* 支持: FAT12/FAT16/FAT32 */
/* MSP430單片機, 查詢方式或者中斷方式 */

#ifndef __CH374HF_H__
#define __CH374HF_H__

#define CH374_LIB_VER		0x13

#ifdef __cplusplus
extern "C" {
#endif

/* FILE: CH374INC.H */

/* ********************************************************************************************************************* */
/* USB協議層定義 */

/* USB的包標識PID, 主機方式可能用到 */
#ifndef	DEF_USB_PID_SETUP
#define	DEF_USB_PID_NULL	0x00			/* 保留PID, 未定義 */
#define	DEF_USB_PID_SOF		0x05
#define	DEF_USB_PID_SETUP	0x0D
#define	DEF_USB_PID_IN		0x09
#define	DEF_USB_PID_OUT		0x01
#define	DEF_USB_PID_ACK		0x02
#define	DEF_USB_PID_NAK		0x0A
#define	DEF_USB_PID_STALL	0x0E
#define	DEF_USB_PID_DATA0	0x03
#define	DEF_USB_PID_DATA1	0x0B
#define	DEF_USB_PID_PRE		0x0C
#endif

/* ********************************************************************************************************************* */
/* 芯片定義 */

/* 寄存器及緩沖區 */

#define	RAM_ENDP0_SIZE		0x08		/* 端點0的緩沖區長度 */
#define	RAM_ENDP0_TRAN		0x20		/* 端點0發送緩沖區的起始地址 */
#define	RAM_ENDP0_RECV		0x28		/* 端點0接收緩沖區的起始地址 */
#define	RAM_ENDP1_SIZE		0x08		/* 端點1的緩沖區長度 */
#define	RAM_ENDP1_TRAN		0x30		/* 端點1發送緩沖區的起始地址 */
#define	RAM_ENDP1_RECV		0x38		/* 端點1接收緩沖區的起始地址 */
#define	RAM_ENDP2_SIZE		0x40		/* 端點2的緩沖區長度 */
#define	RAM_ENDP2_TRAN		0x40		/* 端點2發送緩沖區的起始地址 */
#define	RAM_ENDP2_RECV		0xC0		/* 端點2接收緩沖區的起始地址 */
#define	RAM_ENDP2_EXCH		0x80		/* 端點2備用緩沖區的起始地址 */
#define	RAM_HOST_TRAN		0x40		/* 主機發送緩沖區的起始地址 */
#define	RAM_HOST_RECV		0xC0		/* 主機接收緩沖區的起始地址 */
#define	RAM_HOST_EXCH		0x80		/* 主機備用緩沖區的起始地址 */

#define	REG_SYS_INFO		0x04		/* 系統信息, 只讀 */
#define	REG_SYS_CTRL		0x05		/* 系統控制，不受軟件復位影響 */
#define	REG_USB_SETUP		0x06		/* USB配置 */
#define	REG_INTER_EN		0x07		/* 中斷使能 */
#define	REG_USB_ADDR		0x08		/* USB設備地址 */
#define	REG_INTER_FLAG		0x09		/* 中斷標志, 只讀, 位寫1清0 */
#define	REG_USB_STATUS		0x0A		/* USB狀態, 只讀 */
#define	REG_USB_LENGTH		0x0B		/* USB長度, 讀為當前USB接收長度, 設備方式下寫為USB端點2，主機方式下寫為USB主機發送長度 */
#define	REG_USB_ENDP0		0x0C		/* 僅USB設備方式: USB端點0控制 */
#define	REG_USB_ENDP1		0x0D		/* 僅USB設備方式: USB端點1控制 */
#define	REG_USB_H_PID		0x0D		/* 僅USB主機方式: USB主機令牌 */
#define	REG_USB_ENDP2		0x0E		/* 僅USB設備方式: USB端點2控制 */
#define	REG_USB_H_CTRL		0x0E		/* 僅USB主機方式: USB主機控制 */

/* 寄存器的位及常用宏定義 */

#define	BIT_INFO_HW_ID		0x03		/* 硬件識別位: 總是常量01，否則說明讀操作或硬件連接有誤 */
#define	BIT_INFO_USB_DM		0x04		/* USB總線UD-引腳的邏輯電平狀態: 0-低電平,1-高電平 */
#define	BIT_INFO_USB_DP		0x08		/* USB總線UD+引腳的邏輯電平狀態: 0-低電平,1-高電平 */
#define	BIT_INFO_SOF_PRES	0x20		/* 硬件1mS定時周期狀態,對于USB主機,1說明將要產生SOF */
#define	BIT_INFO_WAKE_UP	0x40		/* 芯片喚醒狀態: 0-正在睡眠或喚醒過程中,1-已喚醒 */
#define	BIT_INFO_POWER_RST	0x80		/* 硬件上電復位完成狀態: 0-正在復位,1-復位完成 */

#define	BIT_CTRL_OSCIL_OFF	0x01		/* 時鐘振蕩器控制: 0-允許振蕩,1-停止振蕩 */
#define	BIT_CTRL_USB_POWER	0x04		/* V3引腳的USB電源調節器控制: 0-開啟,1-禁用 */
#define	BIT_CTRL_RESET_NOW	0x08		/* 芯片軟件復位控制: 0-不復位,1-復位 */
#define	BIT_CTRL_WATCH_DOG	0x10		/* RST引腳和RST#引腳的看門狗復位使能: 0-禁用,1-啟用 */
#define	BIT_CTRL_INT_PULSE	0x20		/* INT#引腳的中斷輸出方式: 0-低電平中斷, 1-低電平脈沖中斷 */
#define	BIT_CTRL_OE_POLAR	0x40		/* UEN引腳的USB輸出使能極性: 0-高電平使能,1-低電平使能 */

#define	BIT_SETP_TRANS_EN	0x01		/* 僅USB設備方式: USB設備傳輸使能: 0-禁止,1-允許 */
#define	BIT_SETP_PULLUP_EN	0x02		/* 僅USB設備方式: USB上拉電阻控制: 0-禁用上拉電阻,1-啟用上拉電阻 */
#define	BIT_SETP_BUS_CTRL	0x03		/* 僅USB主機方式: USB總線狀態控制: 00-正常/空閑,01-D+低D-低(總線復位),10-禁用,11-D+低D-高(總線恢復) */
#define	M_SET_USB_BUS_FREE( old )		( (old) & ~ BIT_SETP_BUS_CTRL | 0x00 )		/* 僅USB主機方式: USB總線空閑 */
#define	M_SET_USB_BUS_RESET( old )		( (old) & ~ BIT_SETP_BUS_CTRL | 0x01 )		/* 僅USB主機方式: USB總線狀態控制/D+低D-低(總線復位) */
#define	M_SET_USB_BUS_RESUME( old )		( (old) & ~ BIT_SETP_BUS_CTRL | 0x03 )		/* 僅USB主機方式: USB總線狀態控制/D+低D-高(總線恢復) */
#define	BIT_SETP_RAM_MODE	0x0C		/* 備用緩沖區應用方式: 00-禁用備用緩沖區,01-連接接收緩沖區以連續接收128字節,10-用于發送第二緩沖區,11-用于接收第二緩沖區 */
#define	M_SET_RAM_MODE_OFF( old )		( (old) & ~ BIT_SETP_RAM_MODE | 0x00 )		/* 備用緩沖區方式/禁用備用緩沖區 */
#define	M_SET_RAM_MODE_128( old )		( (old) & ~ BIT_SETP_RAM_MODE | 0x04 )		/* 備用緩沖區方式/連接接收緩沖區以連續接收128字節 */
#define	M_SET_RAM_MODE_2TX( old )		( (old) & ~ BIT_SETP_RAM_MODE | 0x08 )		/* 備用緩沖區方式/用于接收和發送的第二緩沖區,支持連續發送 */
#define	M_SET_RAM_MODE_2RX( old )		( (old) & ~ BIT_SETP_RAM_MODE | 0x0C )		/* 備用緩沖區方式/用于接收和發送的第二緩沖區,支持連續接收 */
#define	BIT_SETP_USB_SPEED	0x30		/* USB總線速度: 00-全速12Mbps,11-低速1.5Mbps */
#define	BIT_SETP_LED_ACT	0x40		/* 僅USB設備方式: ACT#引腳低電平的激活事件: 0-收發傳輸過程,1-USB主機活動 */
#define	BIT_SETP_AUTO_SOF	0x40		/* 僅USB主機方式: 自動產生SOF使能: 0-禁止,1-允許 */
#define	BIT_SETP_HOST_MODE	0x80		/* USB主從方式選擇: 0-設備方式,1-主機方式 */

#define	BIT_IE_TRANSFER		0x01		/* USB傳輸完成中斷使能, 1有效 */
#define	BIT_IE_BUS_RESET	0x02		/* 僅USB設備方式: USB總線復位中斷使能, 1有效 */
#define	BIT_IE_DEV_DETECT	0x02		/* 僅USB主機方式: USB設備檢測中斷使能, 1有效 */
#define	BIT_IE_USB_SUSPEND	0x04		/* USB總線掛起中斷使能, 1有效 */
#define	BIT_IE_USB_RESUME	0x08		/* USB總線恢復/喚醒中斷使能, 1有效, 0-使能芯片喚醒完成中斷,1-使能USB總線恢復中斷 */
#define	BIT_IE_CLK_OUT_DIV	0xF0		/* 可編程時鐘的分頻除數: 輸出頻率為48MHz/(該值+1), 例如: 0000-48MHz, 0001-24MHz, 0010-16MHz, 1111-3MHz */
#define	M_SET_CLK_DIV( old, div )		( (old) & ~ BIT_IE_CLK_OUT_DIV | (div) << 4 )	/* 設置時鐘輸出分頻除數 */

#define	BIT_ADDR_USB_DEV	0x7F		/* 在設備方式下為自身作為USB設備的地址, 在主機方式下為當前被操作的USB設備地址 */

#define	BIT_IF_INTER_FLAG	0x0F		/* 所有的USB中斷標志 */
#define	BIT_IF_TRANSFER		0x01		/* USB傳輸完成中斷標志, 1有效, 向該位寫1清標志, 該位在每次USB傳輸完成后自動置1 */
#define	BIT_IF_BUS_RESET	0x02		/* 僅USB設備方式: USB總線復位中斷標志, 1有效, 向該位寫1清標志, 該位在檢測到USB總線復位時自動置1 */
#define	BIT_IF_DEV_DETECT	0x02		/* 僅USB主機方式: USB設備插拔檢測中斷標志, 1有效, 向該位寫1清標志, 該位在檢測到USB設備插拔后自動置1 */
#define	BIT_IF_USB_SUSPEND	0x04		/* USB總線掛起中斷標志, 1有效, 向該位寫1清標志, 該位在檢測到USB總線掛起時自動置1 */
#define	BIT_IF_WAKE_UP		0x08		/* 芯片喚醒完成中斷標志, 1有效, 向該位寫1清標志, 該位在芯片喚醒完成后自動置1 */
#define	BIT_IF_USB_RESUME	0x08		/* USB總線恢復/喚醒中斷標志, 1有效, 向該位寫1清標志, 該位在檢測到USB總線恢復時自動置1 */
#define	BIT_IF_USB_PAUSE	0x10		/* USB傳輸暫停標志, 1有效, 向該位寫1清標志, 該位在每次USB傳輸完成后自動置1 */
#define	BIT_IF_DEV_ATTACH	0x20		/* USB設備連接狀態: 0-尚未連接/斷開/拔出, 1-已經連接/插入 */
#define	BIT_IF_USB_OE		0x40		/* UEN引腳的USB輸出使能狀態: 0-UEN引腳為低電平,1-UEN引腳為高電平 */
#define	BIT_IF_USB_DX_IN	0x80		/* 全速時UD+引腳/低速時UD-引腳的采樣狀態: 0-低電平/速度失配,1-高電平/速度匹配 */

#define	BIT_STAT_THIS_ENDP	0x03		/* 僅USB設備方式: USB傳輸的目的端點號: 00-端點0,01-端點1,10-端點2,11-保留 */
#define	BIT_STAT_THIS_PID	0x0C		/* 僅USB設備方式: USB傳輸的事務/令牌PID: 00-OUT事務,01-保留,10-IN事務,11-SETUP事務 */
#define	BIT_STAT_PID_ENDP	0x0F		/* 僅USB設備方式: USB傳輸的事務和端點號,參考后面的USB_INT_EP*定義 */
#define	BIT_STAT_DEV_RESP	0x0F		/* 僅USB主機方式: USB設備的應答PID: XX00=錯誤或超時,其它值-同PID定義,參考后面的USB_INT_RET_*定義 */
#define	M_IS_HOST_TIMEOUT( status )		( ( (status) & 0x03 ) == 0 )		/* 檢查USB主機狀態是否為應答超時/出錯 */
#define	M_IS_HOST_IN_DATA( status )		( ( (status) & BIT_STAT_DEV_RESP & ~ ( DEF_USB_PID_DATA0 ^ DEF_USB_PID_DATA1 ) ) == ( DEF_USB_PID_DATA0 & DEF_USB_PID_DATA1 ) )	/* 檢查是否返回DATA0或者DATA1 */
#define	BIT_STAT_TOG_MATCH	0x10		/* 指示當前接收的數據包是否同步: 0-不同步,1-同步 */
#define	BIT_STAT_BUS_RESET	0x20		/* 當前USB總線復位狀態: 0-沒有復位,1-正在復位 */
#define	BIT_STAT_SUSPEND	0x40		/* 當前USB總線掛起狀態: 0-總線有活動,1-總線掛起 */
#define	BIT_STAT_SIE_FREE	0x80		/* 當前USB接口引擎SIE的狀態: 0=忙/正在傳輸,1=空閑/等待 */

#define	BIT_EP0_TRAN_RESP	0x0F		/* 僅USB設備方式: 端點0發送響應: 0000~1000-應答數據長度0~8,1110-應答NAK,1111-應答STALL,其它值-禁用 */
#define	M_SET_EP0_TRAN_ACK( old, len )	( (old) & ~ BIT_EP0_TRAN_RESP | (len) & 0x0F )	/* 僅USB設備方式: 端點0發送響應/應答ACK */
#define	M_SET_EP0_TRAN_NAK( old )		( (old) & ~ BIT_EP0_TRAN_RESP | 0x0E )		/* 僅USB設備方式: 端點0發送響應/應答NAK */
#define	M_SET_EP0_TRAN_STA( old )		( (old) & ~ BIT_EP0_TRAN_RESP | 0x0F )		/* 僅USB設備方式: 端點0發送響應/應答STALL */
#define	BIT_EP0_RECV_RESP	0x30		/* 僅USB設備方式: 端點0接收響應: 00-應答ACK,01-禁用,10-應答NAK,11-應答STALL */
#define	M_SET_EP0_RECV_ACK( old )		( (old) & ~ BIT_EP0_RECV_RESP | 0x00 )		/* 僅USB設備方式: 端點0接收響應/應答ACK */
#define	M_SET_EP0_RECV_NAK( old )		( (old) & ~ BIT_EP0_RECV_RESP | 0x20 )		/* 僅USB設備方式: 端點0接收響應/應答NAK */
#define	M_SET_EP0_RECV_STA( old )		( (old) & ~ BIT_EP0_RECV_RESP | 0x30 )		/* 僅USB設備方式: 端點0接收響應/應答STALL */
#define	BIT_EP0_TRAN_TOG	0x40		/* 僅USB設備方式: 端點0發送同步標志: 0-DATA0,1-DATA1 */
#define	BIT_EP0_RECV_TOG	0x80		/* 僅USB設備方式: 端點0接收同步標志: 0-DATA0,1-DATA1 */

#define	BIT_EP1_TRAN_RESP	0x0F		/* 僅USB設備方式: 端點1發送響應: 0000~1000-應答數據長度0~8,1110-應答NAK,1111-應答STALL,其它值-禁用 */
#define	M_SET_EP1_TRAN_ACK( old, len )	( (old) & ~ BIT_EP1_TRAN_RESP | (len) & 0x0F )	/* 僅USB設備方式: 端點1發送響應/應答ACK */
#define	M_SET_EP1_TRAN_NAK( old )		( (old) & ~ BIT_EP1_TRAN_RESP | 0x0E )		/* 僅USB設備方式: 端點1發送響應/應答NAK */
#define	M_SET_EP1_TRAN_STA( old )		( (old) & ~ BIT_EP1_TRAN_RESP | 0x0F )		/* 僅USB設備方式: 端點1發送響應/應答STALL */
#define	BIT_EP1_RECV_RESP	0x30		/* 僅USB設備方式: 端點1接收響應: 00-應答ACK,01-禁用,10-應答NAK,11-應答STALL */
#define	M_SET_EP1_RECV_ACK( old )		( (old) & ~ BIT_EP1_RECV_RESP | 0x00 )		/* 僅USB設備方式: 端點1接收響應/應答ACK */
#define	M_SET_EP1_RECV_NAK( old )		( (old) & ~ BIT_EP1_RECV_RESP | 0x20 )		/* 僅USB設備方式: 端點1接收響應/應答NAK */
#define	M_SET_EP1_RECV_STA( old )		( (old) & ~ BIT_EP1_RECV_RESP | 0x30 )		/* 僅USB設備方式: 端點1接收響應/應答STALL */
#define	BIT_EP1_TRAN_TOG	0x40		/* 僅USB設備方式: 端點1發送同步標志: 0-DATA0,1-DATA1 */
#define	BIT_EP1_RECV_TOG	0x80		/* 僅USB設備方式: 端點1接收同步標志: 0-DATA0,1-DATA1 */

#define	BIT_HOST_PID_ENDP	0x0F		/* 僅USB主機方式: 目的端點號: 0000~1111-端點號0~15 */
#define	BIT_HOST_PID_TOKEN	0xF0		/* 僅USB主機方式: 指定事務/令牌PID: 1101-SETUP事務,0001-OUT事務,1001-IN事務,0101-SOF包,其它值-禁用 */
#define	M_MK_HOST_PID_ENDP( pid, endp )	( (pid) << 4 | (endp) & BIT_HOST_PID_ENDP )		/* 用事務/令牌PID和目的端點號生成USB主機令牌數據 */

#define	BIT_EP2_TRAN_RESP	0x03		/* 僅USB設備方式: 端點2發送響應: 00-應答數據,01-同步/等時傳輸,10-應答NAK,11-應答STALL */
#define	M_SET_EP2_TRAN_ACK( old )		( (old) & ~ BIT_EP2_TRAN_RESP | 0x00 )		/* 僅USB設備方式: 端點2發送響應/應答ACK */
#define	M_SET_EP2_TRAN_ISO( old )		( (old) & ~ BIT_EP2_TRAN_RESP | 0x01 )		/* 僅USB設備方式: 端點2發送響應/同步/等時傳輸/無需應答 */
#define	M_SET_EP2_TRAN_NAK( old )		( (old) & ~ BIT_EP2_TRAN_RESP | 0x02 )		/* 僅USB設備方式: 端點2發送響應/應答NAK */
#define	M_SET_EP2_TRAN_STA( old )		( (old) & ~ BIT_EP2_TRAN_RESP | 0x03 )		/* 僅USB設備方式: 端點2發送響應/應答STALL */
#define	BIT_EP2_RECV_RESP	0x30		/* 僅USB設備方式: 端點2接收響應: 00-應答ACK,01-同步/等時傳輸,10-應答NAK,11-應答STALL */
#define	M_SET_EP2_RECV_ACK( old )		( (old) & ~ BIT_EP2_RECV_RESP | 0x00 )		/* 僅USB設備方式: 端點2接收響應/應答ACK */
#define	M_SET_EP2_RECV_ISO( old )		( (old) & ~ BIT_EP2_RECV_RESP | 0x10 )		/* 僅USB設備方式: 端點2接收響應/同步/等時傳輸/不作應答 */
#define	M_SET_EP2_RECV_NAK( old )		( (old) & ~ BIT_EP2_RECV_RESP | 0x20 )		/* 僅USB設備方式: 端點2接收響應/應答NAK */
#define	M_SET_EP2_RECV_STA( old )		( (old) & ~ BIT_EP2_RECV_RESP | 0x30 )		/* 僅USB設備方式: 端點2接收響應/應答STALL */
#define	BIT_EP2_TRAN_TOG	0x40		/* 僅USB設備方式: 端點2發送同步標志: 0-DATA0,1-DATA1 */
#define	BIT_EP2_RECV_TOG	0x80		/* 僅USB設備方式: 端點2接收同步標志: 0-DATA0,1-DATA1 */

#define	BIT_HOST_TRAN_ISO	0x01		/* 僅USB主機方式: 主機發送的傳輸類型: 0-控制/批量/中斷傳輸,1-同步/等時傳輸 */
#define	BIT_HOST_START		0x08		/* 僅USB主機方式: 主機傳輸啟動控制: 0-暫停,1-啟動傳輸,完成后自動清0 */
#define	BIT_HOST_RECV_ISO	0x10		/* 僅USB主機方式: 主機接收的傳輸類型: 0-控制/批量/中斷傳輸,1-同步/等時傳輸 */
#define	BIT_HOST_TRAN_TOG	0x40		/* 僅USB主機方式: 主機發送同步標志: 0-DATA0,1-DATA1 */
#define	BIT_HOST_RECV_TOG	0x80		/* 僅USB主機方式: 主機接收同步標志: 0-DATA0,1-DATA1 */

/* 狀態及命令等常量 */

#define	CMD_SPI_374READ		0xC0		/* SPI讀操作命令 */
#define	CMD_SPI_374WRITE	0x80		/* SPI寫操作命令 */

#define CH374_BLOCK_SIZE		64		/* CH374 maximum data block size, CH374_MAX_DATA_LEN */

/* ********************************************************************************************************************* */
/* USB狀態 */

/* 以下狀態代碼用于USB設備方式 */
/*   位4指示當前接收的數據包是否同步, 0=不同步, 1-同步 */
/*   位3-位2指示當前事務, 00=OUT, 10=IN, 11=SETUP */
/*   位1-位0指示當前端點, 00=端點0, 01=端點1, 10=端點2 */
#ifndef	USB_INT_EP0_SETUP
#define	USB_INT_EP0_SETUP	0x0C			/* USB端點0的SETUP */
#define	USB_INT_EP0_OUT		0x00			/* USB端點0的OUT */
#define	USB_INT_EP0_IN		0x08			/* USB端點0的IN */
#define	USB_INT_EP1_OUT		0x01			/* USB端點1的OUT */
#define	USB_INT_EP1_IN		0x09			/* USB端點1的IN */
#define	USB_INT_EP2_OUT		0x02			/* USB端點2的OUT */
#define	USB_INT_EP2_IN		0x0A			/* USB端點2的IN */
#endif

/* 以下狀態代碼用于USB主機方式 */
/*   位4指示當前接收的數據包是否同步, 0=不同步, 1-同步 */
/*   位3-位0指示USB設備的應答: 0010=ACK, 1010=NAK, 1110=STALL, 0011=DATA0, 1011=DATA1, XX00=應答錯誤或者超時無應答 */
#ifndef	USB_INT_RET_ACK
#define	USB_INT_RET_ACK		DEF_USB_PID_ACK		/* 錯誤:對于OUT/SETUP事務返回ACK */
#define	USB_INT_RET_NAK		DEF_USB_PID_NAK		/* 錯誤:返回NAK */
#define	USB_INT_RET_STALL	DEF_USB_PID_STALL	/* 錯誤:返回STALL */
#define	USB_INT_RET_DATA0	DEF_USB_PID_DATA0	/* 錯誤:對于IN事務返回DATA0 */
#define	USB_INT_RET_DATA1	DEF_USB_PID_DATA1	/* 錯誤:對于IN事務返回DATA1 */
#define	USB_INT_RET_TOUT	0x00			/* 錯誤:應答錯誤或者超時無應答 */
#define	USB_INT_RET_TOUT1	0x04			/* 錯誤:應答錯誤或者超時無應答 */
#define	USB_INT_RET_TOUT2	0x08			/* 錯誤:應答錯誤或者超時無應答 */
#define	USB_INT_RET_TOUT3	0x0C			/* 錯誤:應答錯誤或者超時無應答 */