board/esd/common/xilinx_jtag/micro.h

   1 /*
   2  * (C) Copyright 2003
   3  * Stefan Roese, esd gmbh germany, stefan.roese@esd-electronics.com
   4  *
   5  * SPDX-License-Identifier:     GPL-2.0+
   6  */
   7
   8 /*****************************************************************************
   9  * File:         micro.h
  10  * Description:  This header file contains the function prototype to the
  11  *               primary interface function for the XSVF player.
  12  * Usage:        FIRST - PORTS.C
  13  *               Customize the ports.c function implementations to establish
  14  *               the correct protocol for communicating with your JTAG ports
  15  *               (setPort() and readTDOBit()) and tune the waitTime() delay
  16  *               function.  Also, establish access to the XSVF data source
  17  *               in the readByte() function.
  18  *               FINALLY - Call xsvfExecute().
  19  *****************************************************************************/
  20 #ifndef XSVF_MICRO_H
  21 #define XSVF_MICRO_H
  22
  23 /* Legacy error codes for xsvfExecute from original XSVF player v2.0 */
  24 #define XSVF_LEGACY_SUCCESS 1
  25 #define XSVF_LEGACY_ERROR   0
  26
  27 /* 4.04 [NEW] Error codes for xsvfExecute. */
  28 /* Must #define XSVF_SUPPORT_ERRORCODES in micro.c to get these codes */
  29 #define XSVF_ERROR_NONE         0
  30 #define XSVF_ERROR_UNKNOWN      1
  31 #define XSVF_ERROR_TDOMISMATCH  2
  32 #define XSVF_ERROR_MAXRETRIES   3   /* TDO mismatch after max retries */
  33 #define XSVF_ERROR_ILLEGALCMD   4
  34 #define XSVF_ERROR_ILLEGALSTATE 5
  35 #define XSVF_ERROR_DATAOVERFLOW 6   /* Data > lenVal MAX_LEN buffer size*/
  36 /* Insert new errors here */
  37 #define XSVF_ERROR_LAST         7
  38
  39 /*****************************************************************************
  40  * Function:     xsvfExecute
  41  * Description:  Process, interpret, and apply the XSVF commands.
  42  *               See port.c:readByte for source of XSVF data.
  43  * Parameters:   none.
  44  * Returns:      int - For error codes see above.
  45  *****************************************************************************/
  46 int xsvfExecute(void);
  47
  48 #endif  /* XSVF_MICRO_H */