138
ChipScope Pro Software and Cores User Guide
UG029 (v14.3) October 16, 2012
Chapter 5:
ChipScope Engine Tcl Interface
::chipscope::csejtag_session create
This is typically the first subcommand call made to the ChipScope Engine. The session
handle that is returned by this command allows you to open and control JTAG targets. This
command also initializes the session with data obtained from various data files located in
the default directory called
<LIBCSEJTAG_DLL_PATH>
/../../data/cse
, where
<LIBCSEJTAG_DLL_PATH>
denotes the absolute location of the
libCseJtag.dll
file.
Syntax
::chipscope::csejtag_session create messageRouterFn [opt_args...]
Note:
[opt_args...]
is an optional list of arguments in string or list of string form.
Arguments
Returns
A session handle. An exception is thrown if the command fails.
Example
1.
Create a new session with no optional arguments.
%set handle [::chipscope::csejtag_session create messageRouterFn]
2.
Create a new session using the client/server libraries to a server called
lab_machine
at port “50001”.
%set handle [::chipscope::csejtag_session create messageRouterFn
-server “lab_machine” -port “50001”]
Back to list of all CseJtag Tcl Commands
Table 5-10:
Arguments for Subcommand ::chipscope::csejtag_session create
Argument
Type
Description
messageRouterFn
Required
Message router function name. Use a value of
0
to route
all messages to
stdout
. Sample function declaration:
proc messageRouterFn {handle msgFlags
msg} { ... }
msgFlags return one of the following:
$CSE_MSG_ERROR
$CSE_MSG_WARNING
$CSE_MSG_STATUS
$CSE_MSG_INFO
$CSE_MSG_NOISE
$CSE_MSG_DEBUG
-server
<host>
Optional
Creates a session associated with the ChipScope server
host name denoted by
<cs_server_host_name>
.
-port
<portnum>
Optional
Creates a session associated with the ChipScope server
port number denoted by
<cs_server_port_number>
.