XJAPI Introduction

The XJTAG API is a simple interface that gives low-level access to the JTAG chain via the XJLink. It is intended to allow the easy integration of the XJTAG hardware into other test systems.

The interface is designed to be used in C and C++ applications. The following files are supplied:

Note that XJAPI is only compatible with XJLink2 and derived JTAG controllers such as XJQuad, PXI-XJLink2 and the variants of XJLink2 for ICT machines.
XJAPI is not compatible with XJLink-PF series controllers.

xjapi.h

The header file describing the XJAPI functions and datatypes.
This file is installed in \Include\XJAPI.h.

jtag.h

The header file defining the states defined in IEEE 1149.1 JTAG specification.
This file is installed in \Include\XJAPI.h.

xjapi.dll, common.dll, CommonCS.dll, hwif.dll, HwifBase.dll, HwifCs.dll, Microsoft.Bcl.HashCode.dll, Pinmap.dll, XJTAG.Polyfill.dll

The DLLs required to use XJAPI.
These files are installed in the directory.

xjapi.lib

The XJAPI import library in COFF format (the format used by Microsoft Visual Studio).
This file is installed in \Lib\xjapi.lib.

A program that uses functions defined in xjapi.h must link with xjapi.lib.

32-bit vs. 64-bit Builds

XJTAG is available as either a 32-bit or 64-bit version. The 32-bit version can be installed on either a 32-bit or a 64-bit version of Windows, whereas the 64-bit version of XJTAG can only be installed on a 64-bit version of Windows.

.NET applications are compiled into an intermediate form, which by default is platform agnostic. However, to work correctly with XJAPI, x86 (32-bit) or x64 (64-bit) must be selected as the Platform Target in the project settings in Visual Studio depending on whether you are targeting the 32-bit or 64-bit version of XJTAG.

Example Projects

The XJTAG installation includes example projects in C/C++ and C# demonstrating the use of the API. The C# example is easily adapted for use in VB.net if the C# interop wrapper class is compiled into a class library. The examples are installed in the XJTAG Shared Files folder in \XJAPI Examples. XJTAG installs a shortcut to the XJTAG Shared Files folder in its Start Menu group.

This example C code demonstrates how to use most of the functionality of the API.