XJTAG logo
Open search box button
Close search button

XJAPI_HardwareSetup

Initialises the XJLink hardware.

XJAPI_ERROR XJAPI_HardwareSetup(
    unsigned int serialNumber,
    unsigned int frequency,
    XJAPI_PINMAP pinMap,
    BOOL         powerOn
);

Version

This function was modified in XJTAG version 2.3.0 and so requires that XJAPI_VERSION be defined to be greater than or equal to 0x020300.

Previous versions

Arguments

serialNumber
The serial number of the XJLink to open (or 0 to open an arbitrary XJLink)
frequency
The TCK frequency in Hz
pinMap
The pinmap to use
powerOn
Whether to power the target board from the XJLink

Return value

An XJAPI_ERROR value indicating whether the function call was successful or not.

Notes

The range of valid TCK frequencies is from 10 kHz to 166 MHz in steps of 10 kHz.

If a value is outside the valid range then an error is returned. If the value is not one of these exact values, then it is rounded to the nearest valid value.

If a user-defined pinmap is to be used then XJAPI_USERDEFINED must be specified, then XJAPI_SetPinMap called before the chain is used.

XJAPI_Startup must have been called before this function is called, otherwise XJAPI_ERROR_NOT_INITIALISED is returned.