Imported Upstream version 2.1.8.20121218upstream

1 files changed, 137 insertions, 143 deletions

diff --git a/cphidgetrfid.h b/cphidgetrfid.h
index 1dcdafd..a9b5761 100644
--- a/cphidgetrfid.h
+++ b/cphidgetrfid.h
@@ -11,6 +11,23 @@
 DPHANDLE(RFID)
 CHDRSTANDARD(RFID)
 
+#ifdef DEBUG
+#define RFID_HITAGS_SUPPORT
+#define RFID_RAWDATA_API_SUPPORT
+#endif
+
+/**
+ * RFID encoding protocols supported by the PhidgetRFID Read-Write
+ */
+typedef enum {
+	PHIDGET_RFID_PROTOCOL_EM4100 = 1,		/**< EM4100 (EM4102) 40-bit */
+	PHIDGET_RFID_PROTOCOL_ISO11785_FDX_B,	/**< ISO11785 FDX-B encoding (Animal ID) */
+	PHIDGET_RFID_PROTOCOL_PHIDGETS,			/**< PhidgetsTAG Protocol 24 character ASCII */
+#ifdef RFID_HITAGS_SUPPORT
+	PHIDGET_RFID_PROTOCOL_HITAGS_UID		/**< HiTag S UID */
+#endif
+} CPhidgetRFID_Protocol;
+
 /**
  * Gets the number of outputs supported by this board.
  * @param phid An attached phidget rfid handle.
@@ -67,78 +84,65 @@ CHDRSET(RFID,LEDOn,int LEDState)
 /**
  * Gets the last tag read by the reader. This tag may or may not still be on the reader.
  * @param phid An attached phidget rfid handle.
- * @param tag The tag. This must be an unsigned char array of size 5.
+ * @param tagString A pointer which will be set to point to a char array containing the tag string.
+ * @param protocol The tag protocol.
  */
-CHDRGET(RFID,LastTag,unsigned char *tag)
+CHDRGET(RFID,LastTag2,char **tagString, CPhidgetRFID_Protocol *protocol)
 /**
  * Gets the tag present status. This is whether or not a tag is being read by the reader.
  * @param phid An attached phidget rfid handle.
  * @param status The tag status. Possible values are \ref PTRUE and \ref PFALSE.
  */
 CHDRGET(RFID,TagStatus,int *status)
+
+/**
+ * Program a tag. This requires a T5577 tag.
+ * @param phid An attached phidget rfid handle.
+ * @param tagString The tag data to write. 
+ *		EM4100 (40-bit hex): "90fd32987b"
+ *		FDX-B (15 digit decimal): "999000000003471"
+ *		Phidgets (7-bit ASCII, up to 24 characters): "I'm a PHIDGET tag"
+ * @param protocol The tag protocol to write
+ * @param lock Lock the tag so that it cannot be written again.
+ */
+PHIDGET21_API int CCONV CPhidgetRFID_write(CPhidgetRFIDHandle phid, char *tagString, CPhidgetRFID_Protocol protocol, int lock);
+
 /**
  * Set a tag handler. This is called when a tag is first detected by the reader.
  * @param phid An attached phidget rfid handle.
  * @param fptr Callback function pointer.
  * @param userPtr A pointer for use by the user - this value is passed back into the callback function.
  */
-CHDREVENT(RFID,Tag,unsigned char *tag)
+CHDREVENT(RFID, Tag2, char *tagString, CPhidgetRFID_Protocol protocol)
 /**
  * Set a tag lost handler. This is called when a tag is no longer detected by the reader.
  * @param phid An attached phidget rfid handle.
  * @param fptr Callback function pointer.
  * @param userPtr A pointer for use by the user - this value is passed back into the callback function.
  */
-CHDREVENT(RFID,TagLost,unsigned char *tag)
+CHDREVENT(RFID, TagLost2, char *tagString, CPhidgetRFID_Protocol protocol)
 
 #ifndef REMOVE_DEPRECATED
 DEP_CHDRGET("Deprecated - use CPhidgetRFID_getOutputCount",RFID,NumOutputs,int *)
+DEP_CHDRGET("Deprecated - use CPhidgetRFID_getLastTag2",RFID,LastTag,unsigned char *tag)
+DEP_CHDREVENT("Deprecated - use CPhidgetRFID_set_OnTag2_Handler",RFID,Tag,unsigned char *tag)
+DEP_CHDREVENT("Deprecated - use CPhidgetRFID_set_OnTagLost2_Handler",RFID,TagLost,unsigned char *tag)
 #endif
 
-//These are for a prototype device - hide until it's released
-#if !defined(EXTERNALPROTO) || defined(DEBUG)
-
-typedef enum {
-	PHIDGET_RFID_ENCODING_MANCHESTER = 1,
-	PHIDGET_RFID_ENCODING_BIPHASE,
-	PHIDGET_RFID_ENCODING_AC
-} CPhidgetRFID_Encoding;
-
-typedef enum {
-	PHIDGET_RFID_TAG_ISO11784 = 1,
-	PHIDGET_RFID_TAG_EM4102,
-	PHIDGET_RFID_TAG_HITAGS
-} CPhidgetRFID_TagType;
-
-typedef struct _CPhidgetRFID_TagInfo
-{
-	int bitRate;
-	CPhidgetRFID_TagType tagType;
-	CPhidgetRFID_Encoding encoding;
-} CPhidgetRFID_TagInfo, *CPhidgetRFID_TagInfoHandle;
-
-typedef struct _CPhidgetRFID_TagOptions
-{
-	unsigned char writable;
-	unsigned char encrypted;
-	int memSize;
-} CPhidgetRFID_TagOptions, *CPhidgetRFID_TagOptionsHandle;
-
-
+/* Keep these hidden - unofficial API, not supported. */
+#if !defined(EXTERNALPROTO) || defined(RFID_HITAGS_SUPPORT)
+/* poll for HiTag S tags */
 CHDRSET(RFID,PollingOn,int pollingState)
-
-PHIDGET21_API int CCONV CPhidgetRFID_writeRaw(CPhidgetRFIDHandle phid, unsigned char *data, int bitlength, int pregap, int space, int postgap, int zero, int one);
+#endif
+#if !defined(EXTERNALPROTO) || defined(RFID_RAWDATA_API_SUPPORT)
+/* Write raw data to a tag */
+PHIDGET21_API int CCONV CPhidgetRFID_writeRaw(CPhidgetRFIDHandle phid, unsigned char *data, int bitlength, int pregap, int space, int postgap, int zero, int one, int prepulse, int eof, int listenDuringEOF);
+/* Read in raw data from tags */
 PHIDGET21_API int CCONV CPhidgetRFID_getRawData(CPhidgetRFIDHandle phid, int *data, int *dataLength);
-
-PHIDGET21_API int CCONV CPhidgetRFID_getTagOptions(CPhidgetRFIDHandle phid, char *tagString, CPhidgetRFID_TagOptionsHandle options);
-PHIDGET21_API int CCONV CPhidgetRFID_read(CPhidgetRFIDHandle phid, char *tagString, unsigned char *data, int *dataLength, char *password);
-PHIDGET21_API int CCONV CPhidgetRFID_write(CPhidgetRFIDHandle phid, char *tagString, unsigned char *data, int dataLength, int offset, char *password);
-
+/* Raw data event */
 CHDREVENT(RFID, RawData, int *data, int dataLength)
+/* Manchester data event */
 CHDREVENT(RFID, ManchesterData, unsigned char *data, int dataLength)
-CHDREVENT(RFID, TagAdvanced, char *tagString, CPhidgetRFID_TagInfoHandle tagInfo)
-CHDREVENT(RFID, TagLostAdvanced, char *tagString, CPhidgetRFID_TagInfoHandle tagInfo)
-
 #endif
 
 #ifndef EXTERNALPROTO
@@ -148,15 +152,23 @@ CHDREVENT(RFID, TagLostAdvanced, char *tagString, CPhidgetRFID_TagInfoHandle tag
 
 #define RFID_LED_FLAG 0x04
 #define RFID_ANTENNA_FLAG 0x08
+#define RFID_LISTEN_DURING_EOF_FLAG 0x10
 
-//RFID Advanced Constants
 #define RFID_WRITE_DATA_OUT_PACKET	0x00
 #define RFID_CONTROL_OUT_PACKET		0x40
 
 #define RFID_READ_DATA_IN_PACKET	0x00
 #define RFID_ECHO_IN_PACKET			0x40
 
-//4097 constants
+#define RFID_MAX_DATA_PER_PACKET	63
+
+#define RFID_DATA_ARRAY_SIZE		1024
+#define RFID_DATA_ARRAY_MASK		0x3ff
+
+#define RFID_MAXOUTPUTS 2
+
+
+/* 4097 constants */
 #define RFID_4097_AmpDemod		0x00	//Amplitude demodulation
 #define RFID_4097_PhaseDemod	0x01	//Phase demodulation
 
@@ -178,151 +190,133 @@ CHDREVENT(RFID, TagLostAdvanced, char *tagString, CPhidgetRFID_TagInfoHandle tag
 
 #define RFID_4097_TestMode		0x80
 
-#define RFID_MAX_DATA_PER_PACKET	62
+#define RFID_4097_DefaultON		(RFID_4097_AmpDemod | RFID_4097_Active | RFID_4097_DataOut | RFID_4097_IntPLL | RFID_4097_FastStart | RFID_4097_Gain960)
 
-#define RFID_DATA_ARRAY_SIZE		2048
-#define RFID_DATA_ARRAY_MASK		0x7ff
 
-#define RFID_MAXOUTPUTS 2
+/* T5577 Write Timing Constants */
+#define RFID_T5577_StartGap 30
+#define RFID_T5577_WriteGap 15
+#define RFID_T5577_EndGap 15
+#define RFID_T5577_Zero 24
+#define RFID_T5577_One 56
+#define RFID_T5577_EOF 100
+#define RFID_T5577_PrePulse (136 + RFID_T5577_Zero)
 
-typedef enum _CPhidgetRFID_Hitag_State
-{
-	RFID_HITAG_STATE_NONE = 0,
-	RFID_HITAG_STATE_UID_REQUEST,
-	RFID_HITAG_STATE_AC_SEQUENCE,
-	RFID_HITAG_STATE_SELECT,
-	RFID_HITAG_STATE_READ,
-	RFID_HITAG_STATE_WRITE
+#ifdef RFID_HITAGS_SUPPORT
+typedef enum {
+	PHIDGET_RFID_TAG_READONLY = 1,
+	PHIDGET_RFID_TAG_HITAGS
+} CPhidgetRFID_TagType;
+#endif
 
-} CPhidgetRFID_Hitag_State;
+typedef enum {
+	PHIDGET_RFID_ENCODING_MANCHESTER = 1,
+	PHIDGET_RFID_ENCODING_BIPHASE,
+#ifdef RFID_HITAGS_SUPPORT
+	PHIDGET_RFID_ENCODING_AC
+#endif
+} CPhidgetRFID_Encoding;
 
+#define RFID_MAX_TAG_STRING_LEN 25
 typedef struct _CPhidgetRFID_Tag
 {
-	char tagString[256];
-	CPhidgetRFID_TagInfo tagInfo;
-	TIME	lastTagTime;
-	unsigned char tagEventPending;
-	unsigned char tagOptionsValid;
-	CPhidgetRFID_TagOptions tagOptions;
-	unsigned char tagDataValid;
-	unsigned char tagData[256];
+	CPhidgetRFID_Protocol protocol;
+	char tagString[RFID_MAX_TAG_STRING_LEN];
+	unsigned char tagData[10]; //used for old EM4100 events
+#ifdef RFID_HITAGS_SUPPORT
+	CPhidgetRFID_TagType tagType;
+#endif
 } CPhidgetRFID_Tag, *CPhidgetRFID_TagHandle;
 
-typedef struct _CPhidgetRFID_TagList
-{
-	struct _CPhidgetRFID_TagList *next;
-	CPhidgetRFID_TagHandle tag;
-} CPhidgetRFID_TagList, *CPhidgetRFID_TagListHandle;
-
-typedef struct _CPhidgetRFID_HitagAC
-{
-	unsigned char uid[4];
-	int colPos;
-} CPhidgetRFID_HitagAC, *CPhidgetRFID_HitagACHandle;
-
-typedef struct _CPhidgetRFID_HitagACList
-{
-	struct _CPhidgetRFID_HitagACList *next;
-	CPhidgetRFID_HitagACHandle hitagAC;
-} CPhidgetRFID_HitagACList, *CPhidgetRFID_HitagACListHandle;
-
 struct _CPhidgetRFID {
 	CPhidget phid;
 
 	int (CCONV *fptrOutputChange)(CPhidgetRFIDHandle, void *, int, int);
 	int (CCONV *fptrTag)(CPhidgetRFIDHandle, void *, unsigned char *);
 	int (CCONV *fptrTagLost)(CPhidgetRFIDHandle, void *, unsigned char *);
-	int (CCONV *fptrRawData)(CPhidgetRFIDHandle, void *, int *, int);
-	int (CCONV *fptrManchesterData)(CPhidgetRFIDHandle, void *, unsigned char *, int);
-	int (CCONV *fptrTagAdvanced)(CPhidgetRFIDHandle, void *, char *, CPhidgetRFID_TagInfoHandle);
-	int (CCONV *fptrTagLostAdvanced)(CPhidgetRFIDHandle, void *, char *, CPhidgetRFID_TagInfoHandle);
+	int (CCONV *fptrTag2)(CPhidgetRFIDHandle, void *, char *, CPhidgetRFID_Protocol);
+	int (CCONV *fptrTagLost2)(CPhidgetRFIDHandle, void *, char *, CPhidgetRFID_Protocol);
 
 	void *fptrOutputChangeptr;
 	void *fptrTagptr;
 	void *fptrTagLostptr;
+	void *fptrTag2ptr;
+	void *fptrTagLost2ptr;
+	
+#ifdef RFID_RAWDATA_API_SUPPORT
+	int (CCONV *fptrRawData)(CPhidgetRFIDHandle, void *, int *, int);
+	int (CCONV *fptrManchesterData)(CPhidgetRFIDHandle, void *, unsigned char *, int);
 	void *fptrRawDataptr;
 	void *fptrManchesterDataptr;
-	void *fptrTagAdvancedptr;
-	void *fptrTagLostAdvancedptr;
+#endif
 
-	// Values returned from the device
+	/* State */
 	unsigned char outputEchoState[RFID_MAXOUTPUTS];
 	unsigned char antennaEchoState;
 	unsigned char ledEchoState;
-	
+	int spaceClocks, pregapClocks, postgapClocks, oneClocks, zeroClocks, prepulseClocks, eofpulseClocks;
+	unsigned char listenDuringEOF;
+	int _4097Conf;
+
+	/* State Echo */
 	unsigned char outputState[RFID_MAXOUTPUTS];
 	unsigned char antennaState;
 	unsigned char ledState;
-
-	unsigned char lastTag[5];
-	unsigned char lastTagValid;
-	TIME	lastTagTime;
-	unsigned char tagPresent;
-	//unsigned char tagEvent;
-	unsigned char pendingTag[5];
-	unsigned char tagEventPending;
-
-	EVENT tagAvailableEvent;
-
-	void *respData;
-	int respStatus;
-	EVENT respEvent;
-	EVENT respEvent2;
-
-	//Advanced Tag Events
-	int tagAdvancedCount;
-	CThread_mutex_t tagthreadlock; /* protects tag thread access to things */
-	CPhidgetRFID_TagListHandle tagAdvancedList;
-	CPhidgetRFID_Tag lastTagAdvanced;
-	TIME	lastDataTime;
-	TIME	hitagReqTime;
-
-	unsigned char ACCodingOK;
+	int spaceClocksEcho, pregapClocksEcho, postgapClocksEcho, oneClocksEcho, zeroClocksEcho, prepulseClocksEcho, eofpulseClocksEcho;
+	unsigned char listenDuringEOFEcho;
+	int _4097ConfEcho;
 
 	unsigned char fullStateEcho;
-	
+
 	CThread tagTimerThread;
+	CThread_mutex_t tagthreadlock; /* protects tag thread access to things */
+	EVENT tagAvailableEvent;
 
-	//RFID Advanced stuff
-	int spaceClocks, pregapClocks, postgapClocks, oneClocks, zeroClocks;
-	int spaceClocksEcho, pregapClocksEcho, postgapClocksEcho, oneClocksEcho, zeroClocksEcho;
-	int _4097Conf, _4097ConfEcho;
-	int frequencyEcho;
+	/* Tag event */
+	CPhidgetRFID_Tag lastTag;
+	unsigned char lastTagValid;
+	TIME lastTagTime;
+	unsigned char tagPresent;
+	CPhidgetRFID_Tag pendingTag;
+	unsigned char tagEventPending;
 
+	/* Raw data buffer */
 	int dataBuffer[RFID_DATA_ARRAY_SIZE];
-	int dataBufferNormalized[RFID_DATA_ARRAY_SIZE];
-	unsigned int dataReadPtr, dataWritePtr, dataReadACPtr;
-	unsigned int userReadPtr; //for the getRawData function
+	unsigned int dataReadPtr, dataWritePtr;
 	
+	int shortClocks, longClocks;
+
+	/* Manchester decoder */
 	unsigned char manBuffer[RFID_DATA_ARRAY_SIZE];
 	int manReadPtr, manWritePtr;
-
-	unsigned char biphaseBuffer[RFID_DATA_ARRAY_SIZE];
-	int biphaseReadPtr, biphaseWritePtr;
-
 	unsigned char manLockedIn;
 	unsigned char manShortChange;
 
+	/* BiPhase Decoder */
+	unsigned char biphaseBuffer[RFID_DATA_ARRAY_SIZE];
+	int biphaseReadPtr, biphaseWritePtr;
 	unsigned char biphaseLockedIn;
 	unsigned char biphaseShortChange;
 
-	int one, two;
-	int oneCount, twoCount;
-
-	CPhidgetRFID_Hitag_State hitagState;
-	int hitagOffset;
-
-	//Hitag AC queue
-	CPhidgetRFID_HitagACListHandle hitagACList;
-	CPhidgetRFID_HitagAC lastHitagAC;
+#ifdef RFID_HITAGS_SUPPORT
+	TIME lastDataTime;
+	unsigned int dataReadACPtr;
+	TIME hitagReqTime;
+	unsigned char polling;
+	unsigned char ACCodingOK;
+#endif
+#ifdef RFID_RAWDATA_API_SUPPORT
+	unsigned int userReadPtr;
+	int manEventReadPtr;
+	unsigned char lastManEventLong;
+#endif
 
-	unsigned char atGap, polling;
+	//for remote write
+	char *remoteWrite;
 
 	unsigned char outputPacket[MAX_OUT_PACKET_SIZE];
 	unsigned int outputPacketLen;
 
-	int manEventReadPtr;
-
 } typedef CPhidgetRFIDInfo;
 #endif