Diff: micro.h

Revision:

0:1be76329b246

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/micro.h	Sat Jun 30 13:17:05 2012 +0000
@@ -0,0 +1,42 @@
+/*****************************************************************************
+* File:         micro.h
+* Description:  This header file contains the function prototype to the
+*               primary interface function for the XSVF player.
+* Usage:        FIRST - PORTS.C
+*               Customize the ports.c function implementations to establish
+*               the correct protocol for communicating with your JTAG ports
+*               (setPort() and readTDOBit()) and tune the waitTime() delay
+*               function.  Also, establish access to the XSVF data source
+*               in the readByte() function.
+*               FINALLY - Call xsvfExecute().
+*****************************************************************************/
+#ifndef XSVF_MICRO_H
+#define XSVF_MICRO_H
+
+/* Legacy error codes for xsvfExecute from original XSVF player v2.0 */
+#define XSVF_LEGACY_SUCCESS 1
+#define XSVF_LEGACY_ERROR   0
+
+/* 4.04 [NEW] Error codes for xsvfExecute. */
+/* Must #define XSVF_SUPPORT_ERRORCODES in micro.c to get these codes */
+#define XSVF_ERROR_NONE         0
+#define XSVF_ERROR_UNKNOWN      1
+#define XSVF_ERROR_TDOMISMATCH  2
+#define XSVF_ERROR_MAXRETRIES   3   /* TDO mismatch after max retries */
+#define XSVF_ERROR_ILLEGALCMD   4
+#define XSVF_ERROR_ILLEGALSTATE 5
+#define XSVF_ERROR_DATAOVERFLOW 6   /* Data > lenVal MAX_LEN buffer size*/
+/* Insert new errors here */
+#define XSVF_ERROR_LAST         7
+
+/*****************************************************************************
+* Function:     xsvfExecute
+* Description:  Process, interpret, and apply the XSVF commands.
+*               See port.c:readByte for source of XSVF data.
+* Parameters:   none.
+* Returns:      int - For error codes see above.
+*****************************************************************************/
+extern int xsvfExecute();
+
+#endif  /* XSVF_MICRO_H */
+