XJTAG logo
Open search box button
Close search button

GET_BSDL_IDCODE

The GET_BSDL_IDCODE function returns the IDCODE_REGISTER value of a JTAG device from its BSDL file. This is a register that contains a value that identifies a particular JTAG device.

Syntax

GET_BSDL_IDCODE( STRING jtagDeviceRef ) ( INT mask, INT idcode, INT hasIdcode )

Parameters

jtagDeviceRef

A JTAG device reference in the form 'board.device' or 'board.device.core' for a multicore device. The GET_JTAG_DEVICE function can be used to get this device reference for any JTAG device in the project.

mask

Returns the bit mask for the ID code, as defined in the BSDL file. This mask contains ones for those bits in the idcode that are significant, and zeroes for those bits that are insignificant.

idcode

Returns the ID code of the device, as defined in its BSDL file. If the device does not have an ID code, a single zero bit is returned and hasIdcode returns FALSE. An ID code is 32 bits wide and is split up into the following parts:

BitsMeaning
31..28Version
27..12Part number
11..1Manufacturer ID
0Specified by the standard to always be zero
hasIdcode

A boolean value indicating whether the device has an ID code defined or not. If the device does have an ID code, then TRUE is returned and idcode returns the 32-bit value, otherwise FALSE is returned and idcode returns a single bit zero.

Errors

If the supplied JTAG device reference is invalid, then an error occurs. If the string is constant, then the verification can be done at compile-time and an error is emitted then, otherwise the error will occur at run-time, when the function is run.

Example

INT idcode, mask, hasIdcode;
GET_BSDL_IDCODE("XJDemo.IC2")(mask, idcode, hasIdcode);

See also