sif32xusb.h

USB device的PC机测试程序

// The following ifdef block is the standard way of creating macros which make exporting 
// from a DLL simpler. All files within this DLL are compiled with the SIF32XUSB_EXPORTS
// symbol defined on the command line. this symbol should not be defined on any project
// that uses this DLL. This way any other project whose source files include this file see 
// SIF32XUSB_API functions as being imported from a DLL, wheras this DLL sees symbols
// defined with this macro as being exported.
#ifdef SIF32XUSB_EXPORTS
#define SIF32XUSB_API __declspec(dllexport)
#else
#define SIF32XUSB_API __declspec(dllimport)
#endif

// GetProductString() function flags
#define		F32x_RETURN_SERIAL_NUMBER	0x00
#define		F32x_RETURN_DESCRIPTION		0x01

// Return codes
#define		F32x_SUCCESS				0x00
#define		F32x_DEVICE_NOT_FOUND		0xFF
#define		F32x_INVALID_HANDLE			0x01
#define		F32x_READ_ERROR				0x02
#define		F32x_RX_QUEUE_NOT_READY		0x03
#define		F32x_WRITE_ERROR			0x04
#define		F32x_RESET_ERROR			0x05
#define		F32x_INVALID_PARAMETER		0x06
#define		F32x_INVALID_REQUEST_LENGTH	0x07
#define		F32x_DEVICE_IO_FAILED		0x08

// RX Queue status flags
#define		F32x_RX_NO_OVERRUN			0x00
#define		F32x_RX_OVERRUN				0x01
#define		F32x_RX_READY				0x02

// Buffer size limits
#define		F32x_MAX_DEVICE_STRLEN		256
#define		F32x_MAX_READ_SIZE			4096
#define		F32x_MAX_WRITE_SIZE			4096

// Type definitions
typedef		int		F32x_STATUS;
typedef		char	F32x_DEVICE_STRING[F32x_MAX_DEVICE_STRLEN];

#ifdef __cplusplus
extern "C" {
#endif

SIF32XUSB_API
F32x_STATUS WINAPI F32x_GetNumDevices(
	LPDWORD lpdwNumDevices
	);

SIF32XUSB_API
F32x_STATUS WINAPI F32x_GetProductString(
	DWORD dwDeviceNum,
	LPVOID lpvDeviceString,
	DWORD dwFlags
	);

SIF32XUSB_API
F32x_STATUS WINAPI F32x_Open(
	DWORD dwDevice,
	HANDLE* cyHandle
	); 

SIF32XUSB_API
F32x_STATUS WINAPI F32x_Close(
	HANDLE cyHandle
	);

SIF32XUSB_API
F32x_STATUS WINAPI F32x_Read(
	HANDLE cyHandle,
	LPVOID lpBuffer,
	DWORD dwBytesToRead,
	LPDWORD lpdwBytesReturned
	);

SIF32XUSB_API 
F32x_STATUS WINAPI F32x_Write(
	HANDLE cyHandle,
	LPVOID lpBuffer,
	DWORD dwBytesToWrite,
	LPDWORD lpdwBytesWritten
	);

SIF32XUSB_API 
F32x_STATUS WINAPI F32x_ResetDevice(
	HANDLE cyHandle
	);

SIF32XUSB_API 
F32x_STATUS WINAPI F32x_DeviceIOControl(
	HANDLE cyHandle,
	DWORD dwIoControlCode,
	LPVOID lpInBuffer,
	DWORD dwBytesToRead,
	LPVOID lpOutBuffer,
	DWORD dwBytesToWrite,
	LPDWORD lpdwBytesSucceeded
	);

SIF32XUSB_API 
F32x_STATUS WINAPI F32x_FlushBuffers(
	HANDLE cyHandle
	);

SIF32XUSB_API 
F32x_STATUS WINAPI F32x_SetTimeouts(
	DWORD dwReadTimeout,
	DWORD dwWriteTimeout
	);

SIF32XUSB_API 
F32x_STATUS WINAPI F32x_GetTimeouts(
	LPDWORD lpdwReadTimeout,
	LPDWORD lpdwWriteTimeout
	);

SIF32XUSB_API 
F32x_STATUS WINAPI F32x_CheckRXQueue(
	HANDLE cyHandle,
	LPDWORD lpdwNumBytesInQueue,
	LPDWORD lpdwQueueStatus
	);


#ifdef __cplusplus
}
#endif