/************************************************************************/
/*
author: Anders.Pan
create date: 2006.9.8                                                                     
*/
/************************************************************************/
#ifndef _PROTOCOL_H
#define _PROTOCOL_H

#ifndef NULL
#define NULL ((void *)0) 
#endif

#define SIMPLE_PROTOCOL_MASK 0x00FF
#define SIMPLE_PROTOCOL_BEGIN 0X0001

#define FPGA_PROTOCOL_MASK 0x0FFF
#define FPGA_PROTOCOL_BEGIN 0x0100

/*status*/
#define OK 1

#ifdef FAILED
#undef FAILED
#endif
#define FAILED 0

/*
 *	this package is used to transform all kinds of data between device and host
 */
typedef struct  {	
	unsigned int type;
	unsigned int dataLength;
	unsigned int seq;
}Package;

/*
 usage: pack data.
 package: in parameter
 data: out parameter, point to the data buffer that will be sent soon
 return: data length, 0 means failed
 */
extern int packData(const Package* package, char** data);

/*
 usage: extract package from received data
 data: in parameter, received data
 package: out parameter
 return: 0 means failed
 */
extern int extractPackage(char* data, Package *package);

#endif