beautypg.com

Digilent Port Communications User Manual

Page 7

background image

Digilent, Inc

TM

DPCUTIL Programmer’s Manual

www.digilentinc.com

© Digilent, Inc.

Page

7 of 14


BOOL DpcGetDpcVersion (char * szVersion,
ERC *perc)

Parameters
szVersion

-

string that will

store the current version of dpcutil.dll
perc

-

pointer to store

error code

Return Values
Returns true if the version string is
successfully retrieved. Returns false
otherwise.

Description
Stores the version string of dpcutil.dll
into the given szVersion pointer.

API JTAG manipulation calls


BOOL DpcOpenJtag(HANDLE * phif, char *
szdvc, ERC * perc, TRID * ptrid)

Parameters
phif

-

pointer to store

opened interface handle
szdvc

-

name of device

to open
perc

-

pointer to store

error code
ptrid

-

pointer to store

transaction ID. If ptrid is NULL, this
function will be

blocking.


Return Values
Returns true if successful. Returns
false otherwise.

Description
Opens the JTAG interface for access.
No other JTAG configuration
transactions can be used until a
communications device has been
opened and enabled (enabling a JTAG
interface is performed by calling the
DpcEnableJtag API function. The
communications device is specified by
the name assigned to it in the device
table and this name is placed in szdvc.

The handle to the JTAG interface is
returned by reference in phif.


BOOL DpcCloseJtag(HANDLE hif, ERC * perc)

Parameters
hif

-

handle to JTAG

interface
perc

-

pointer to store

error code

Return Values
Returns true if successful. Returns
false otherwise.


Description
Releases the JTAG interface specified
by hif and closes the communications
module.


BOOL DpcEnableJtag(HANDLE hif, ERC *
perc, TRID * ptrid)

Parameters
hif

-

handle to JTAG

interface
perc

-

pointer to store

error code
ptrid

-

pointer to store

transaction ID. If ptrid is NULL, this
function will be

blocking.


Return Values
Returns true if successful. Returns
false otherwise.

Description
Enables the driving of JTAG signals.
Must be called after FOpenJtag is
called. After the JTAG signals have
been enabled on the communications
module, the JTAG manipulation
functions in DPCUTIL can be used.


BOOL DpcDisableJtag(HANDLE hif, ERC *
perc, TRID * ptrid)

Parameters
hif

-

handle to JTAG

interface