/*
; 單片機內置USB調試固件程序 之 計算機接口程序  V1.0
; 用于連接CH372或者CH375的單片機進行簡單的調試功能
; 可以用include直接包含到應用系統的主程序中,或者添加到工程項目中
;
; Website:  http://winchiphead.com
; Email:    tech@winchiphead.com
; @2004.08
;****************************************************************************
*/

/* PC機C語言, VC5.0 */
/* 用于其它類型單片機或者硬件資源不同時, 該程序應該根據需要進行局部修改 */
#ifndef		_CH375_DBG_H
#define		_CH375_DBG_H


//#include "stdafx.h"
#include <windows.h>
#include	"stdlib.h"
#include	"stdio.h"
//#include	<conio.h>
#include "CH375DLL.H"

#ifdef __cplusplus
extern "C" {
#endif

/* **************************************************************************************************** */
// 提供給主程序調用的子程序


// 應用程序啟動后,在所有操作之前,必須首先調用一次下面的CH375DBG_GetFirmwareInfo子程序
BOOL	CH375DBG_GetFirmwareInfo( PUCHAR ver );  //獲取調試固件程序的版本,并取消未完成的上傳數據塊
// 輸入參數: ver 指向一個字節變量單元,用于存放獲取的版本號


// 應用程序退出前,在所有操作之后,應該調用一次下面的CH375DBG_CloseExit子程序
VOID	CH375DBG_CloseExit( VOID );  //關閉CH372/CH375設備


BOOL	CH375DBG_GetAppSysInfo( PUCHAR ver, PUCHAR StringBuffer );  //獲取當前應用系統的版本和說明字符串
// 輸入參數: ver 指向一個字節變量單元,用于存放獲取的版本號
//           StringBuffer 指向一個足夠大的字符串緩沖區,用于存放獲取的說明字符串


BOOL	CH375DBG_ReadSFR( ULONG addr, PUCHAR data );  //從SFR一個單元讀取數據
// 輸入參數: addr 指定SFR的地址
//           data 指向一個字節變量單元,用于存放讀出的數據


BOOL	CH375DBG_WriteSFR( ULONG addr, UCHAR data );  //向SFR一個單元寫入數據
// 輸入參數: addr 指定SFR的地址
//           data 指定準備寫入的數據


BOOL	CH375DBG_ReadIRAM( ULONG StartAddr, PUCHAR buffer, UCHAR count );  //從內部RAM讀取數據塊
// 輸入參數: StartAddr 指定內部RAM的起始地址
//           buffer 指向一個足夠大的數據緩沖區,用于存放讀出的數據塊
//           count 指定讀取的字節數


BOOL	CH375DBG_WriteIRAM( ULONG StartAddr, PUCHAR buffer, UCHAR count );  //向內部RAM寫入數據塊
// 輸入參數: StartAddr 指定內部RAM的起始地址
//           buffer 指向一個數據緩沖區,存放準備寫入的數據塊
//           count 指定寫入的字節數


BOOL	CH375DBG_ReadXRAM( ULONG StartAddr, PUCHAR buffer, UCHAR count );  //從外部RAM讀取數據塊
// 輸入參數: StartAddr 指定外部RAM的起始地址
//           buffer 指向一個足夠大的數據緩沖區,用于存放讀出的數據塊
//           count 指定讀取的字節數


BOOL	CH375DBG_WriteXRAM( ULONG StartAddr, PUCHAR buffer, UCHAR count );  //向外部RAM寫入數據塊
// 輸入參數: StartAddr 指定外部RAM的起始地址
//           buffer 指向一個數據緩沖區,存放準備寫入的數據塊
//           count 指定寫入的字節數


BOOL	CH375DBG_ReadROM( ULONG StartAddr, PUCHAR buffer, UCHAR count );  //從程序ROM讀取數據塊
// 輸入參數: StartAddr 指定程序ROM的起始地址
//           buffer 指向一個足夠大的數據緩沖區,用于存放讀出的數據塊
//           count 指定讀取的字節數


UCHAR	CH375DBG_GetPortP1( VOID );  //獲取MCS51單片機端口P1的狀態
// 輸出結果: 返回當前端口狀態值


VOID	CH375DBG_PutPortP1( UCHAR d );  //設置MCS51單片機端口P1的狀態
// 輸入參數: d 指定新的端口狀態值


/* **************************************************************************************************** */
// 計算機接口子程序源程序



typedef unsigned char           UINT8;
typedef unsigned short          UINT16;
typedef unsigned long           UINT32;

#ifndef MAX_DATA_SIZE
#define MAX_DATA_SIZE		16			/* 單次命令處理的最大數據長度,有效值是1到56 */
#endif

#pragma pack( push, old_pack, 1 )

typedef	struct	_USB_DOWN_PACKET {		/* 下傳的數據包結構,用于命令/寫數據 */
	UINT8	mCommand;					/* 命令碼,見下面的定義 */
	UINT8	mCommandNot;				/* 命令碼的反碼,用于校驗下傳數據包 */
	union {
		UINT8	mByte[4];				/* 通用參數 */
		UINT16	mWord[2];				/* 通用參數,低字節在前,Little-Endian */
		UINT32	mDword;					/* 通用參數,低字節在前,Little-Endian */
		void	*mAddress;				/* 讀寫操作的起始地址,低字節在前,Little-Endian */
	} u;
	UINT8	mLength;					/* 下面的緩沖區的長度,讀寫操作的字節數 */
	UINT8	mBuffer[ MAX_DATA_SIZE ];	/* 數據緩沖區 */
}	USB_DOWN_PKT;

typedef	struct	_USB_UP_PACKET {		/* 上傳的數據包結構,用于狀態/讀數據 */
	UINT8	mStatus;					/* 狀態碼,見下面的定義 */
	UINT8	mCommandNot;				/* 命令碼的反碼,用于校驗上傳數據包 */
	UINT8	mReserved[4];
	UINT8	mLength;					/* 下面的緩沖區的長度,讀操作的字節數 */
	UINT8	mBuffer[ MAX_DATA_SIZE ];	/* 數據緩沖區 */
}	USB_UP_PKT;

#pragma pack( pop, old_pack )

/* 命令碼定義,按位說明
   位7為命令類型:  0=實現特定功能, 1=存儲器和SFR讀寫
   對于"實現特定功能"命令類型:
       位6-位0為定義的具體命令碼, 命令碼為00H-7FH, 其中: 00H-3FH為通用標準命令, 40H-7FH為與應用系統有關的特定命令
       目前版本定義了以下通用標準命令:
           00H: 獲取調試固件程序的版本,并取消未完成的上傳數據塊
           10H: 獲取當前應用系統的版本和說明字符串
   對于"存儲器和SFR讀寫"命令類型:
       位6為數據傳輸方向:      0=讀操作/上傳, 1=寫操作/下傳
       位5-位4為數據讀寫寬度:  00=以字節為單位/8位, 01=以字為單位/16位, 10=以雙字為單位/32位, 11=以位為單位/1位
       位1-位0為存儲器空間:    00=存取SFR, 01=存取內部RAM, 10=存取外部RAM, 11=存取程序ROM
       例如: 命令碼80H為讀SFR, 命令碼83H為讀程序ROM, 命令碼C1H為寫內部RAM, 命令碼C2H為寫外部RAM
   狀態碼定義: 00H為操作成功, 080H為命令不支持, 0FFH為未定義的錯誤 */

#define USB_CMD_GET_FW_INFO		0x00
#define USB_CMD_GET_APP_INFO	0x10

#define USB_CMD_MEM_ACCESS		0x80
#define USB_CMD_MEM_DIR_WR		0x40
#define USB_CMD_MEM_WIDTH		0x0C
#define USB_CMD_MEM_W_BYTE		0x00
#define USB_CMD_MEM_W_WORD		0x04
#define USB_CMD_MEM_W_DWORD		0x08
#define USB_CMD_MEM_W_BIT		0x0C
#define USB_CMD_MEM_SPACE		0x03
#define USB_CMD_MEM_S_SFR		0x00
#define USB_CMD_MEM_S_IRAM		0x01
#define USB_CMD_MEM_S_XRAM		0x02
#define USB_CMD_MEM_S_ROM		0x03

#define ERR_SUCCESS				0x00
#define ERR_UNSUPPORT			0x80
#define ERR_UNDEFINED			0xFF


/* **************************************************************************************************** */

#ifdef __cplusplus
}
#endif
#endif	// _CH375_DBG_H