board/esd/common/xilinx_jtag/micro.h

   1 /*\r
   2  * (C) Copyright 2003\r
   3  * Stefan Roese, esd gmbh germany, stefan.roese@esd-electronics.com\r
   4  *\r
   5  * See file CREDITS for list of people who contributed to this\r
   6  * project.\r
   7  *\r
   8  * This program is free software; you can redistribute it and/or\r
   9  * modify it under the terms of the GNU General Public License as\r
  10  * published by the Free Software Foundation; either version 2 of\r
  11  * the License, or (at your option) any later version.\r
  12  *\r
  13  * This program is distributed in the hope that it will be useful,\r
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  16  * GNU General Public License for more details.\r
  17  *\r
  18  * You should have received a copy of the GNU General Public License\r
  19  * along with this program; if not, write to the Free Software\r
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,\r
  21  * MA 02111-1307 USA\r
  22  */\r
  23 \r
  24 /*****************************************************************************\r
  25  * File:         micro.h\r
  26  * Description:  This header file contains the function prototype to the\r
  27  *               primary interface function for the XSVF player.\r
  28  * Usage:        FIRST - PORTS.C\r
  29  *               Customize the ports.c function implementations to establish\r
  30  *               the correct protocol for communicating with your JTAG ports\r
  31  *               (setPort() and readTDOBit()) and tune the waitTime() delay\r
  32  *               function.  Also, establish access to the XSVF data source\r
  33  *               in the readByte() function.\r
  34  *               FINALLY - Call xsvfExecute().\r
  35  *****************************************************************************/\r
  36 #ifndef XSVF_MICRO_H\r
  37 #define XSVF_MICRO_H\r
  38 \r
  39 /* Legacy error codes for xsvfExecute from original XSVF player v2.0 */\r
  40 #define XSVF_LEGACY_SUCCESS 1\r
  41 #define XSVF_LEGACY_ERROR   0\r
  42 \r
  43 /* 4.04 [NEW] Error codes for xsvfExecute. */\r
  44 /* Must #define XSVF_SUPPORT_ERRORCODES in micro.c to get these codes */\r
  45 #define XSVF_ERROR_NONE         0\r
  46 #define XSVF_ERROR_UNKNOWN      1\r
  47 #define XSVF_ERROR_TDOMISMATCH  2\r
  48 #define XSVF_ERROR_MAXRETRIES   3   /* TDO mismatch after max retries */\r
  49 #define XSVF_ERROR_ILLEGALCMD   4\r
  50 #define XSVF_ERROR_ILLEGALSTATE 5\r
  51 #define XSVF_ERROR_DATAOVERFLOW 6   /* Data > lenVal MAX_LEN buffer size*/\r
  52 /* Insert new errors here */\r
  53 #define XSVF_ERROR_LAST         7\r
  54 \r
  55 /*****************************************************************************\r
  56  * Function:     xsvfExecute\r
  57  * Description:  Process, interpret, and apply the XSVF commands.\r
  58  *               See port.c:readByte for source of XSVF data.\r
  59  * Parameters:   none.\r
  60  * Returns:      int - For error codes see above.\r
  61  *****************************************************************************/\r
  62 int xsvfExecute(void);\r
  63 \r
  64 #endif  /* XSVF_MICRO_H */\r