| /* |
| * (C) Copyright 2003 |
| * Stefan Roese, esd gmbh germany, stefan.roese@esd-electronics.com |
| * |
| * See file CREDITS for list of people who contributed to this |
| * project. |
| * |
| * This program is free software; you can redistribute it and/or |
| * modify it under the terms of the GNU General Public License as |
| * published by the Free Software Foundation; either version 2 of |
| * the License, or (at your option) any later version. |
| * |
| * This program is distributed in the hope that it will be useful, |
| * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| * GNU General Public License for more details. |
| * |
| * You should have received a copy of the GNU General Public License |
| * along with this program; if not, write to the Free Software |
| * Foundation, Inc., 59 Temple Place, Suite 330, Boston, |
| * MA 02111-1307 USA |
| */ |
| |
| /***************************************************************************** |
| * 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. |
| *****************************************************************************/ |
| int xsvfExecute(void); |
| |
| #endif /* XSVF_MICRO_H */ |
