top of page

What's the difference between XSCT and XSDB?


AMD logo

What's the difference between XSCT and XSDB? Dive into the essentials of XSDB and XSCT with this post. We cover key differences, commands, installation guides, and usage tips, including help commands. It's crafted as a quick reference and a repository for crucial documentation, ensuring you have the right tools at your fingertips for efficient workflow.


This information is accurate as of Vivado and Vitis release 22.04.1


What's the difference between XSCT and XSDB?


XSDB, short for Xilinx System Debugger, offers a command line interface that is both interactive and scriptable, making it user-friendly for developers. Its primary function is to facilitate debugging processes.


Similarly, the Xilinx Software Command-line Tool (XSCT) provides interactive, scriptable command-line access to the suite of Xilinx development tools. It enables users to execute all the operations available in the Eclipse-based Vitis interface but from the convenience of a shell environment.


xsct Commands

xsdb Commands


Note: The documentation lists these under xsct

backtrace

bpadd

bpdisable

bpenable

bplist

bpremove

bpstatus

breakpoints

bt

categories

closebsp

closehw

commands

con

configbsp

configparams

connect

connections

device

device authjtag

device program

device status

dis

disconnect

dow

download

fpga

gdbremote connect

gdbremote disconnect

getaddrmap

getdrivers

getlibs

getos

getperipherals

hsi

init_ps

ipi

jtag

jtag claim

jtag device_properties

jtag disclaim

jtag frequency

jtag lock

jtag sequence

jtag servers

jtag skew

jtag targets

jtag unlock

jtagterminal

loadhw

loadipxact

locals

mask_poll

mask_write

mb_drrd

mb_drwr

mbprofile

mbtrace

mdm_drrd

mdm_drwr

memmap

memory

miscellaneous

mrd

mwr

nxt

nxti

openbsp

openhw

osa

petalinux

plm

plm copy-debug-log

plm log

plm set-debug-log

plm set-log-level

pmc

print

profile

projects

readjtaguart

regenbsp

registers

removelib

repo

reset

rrd

rst

running

rwr

sdk

setdriver

setlib

setosversion

stapl

stapl config

stapl start

stapl stop

state

stop

stp

stpi

stpout

streams

svf

svf con

svf config

svf delay

svf dow

svf generate

svf mwr

svf rst

svf stop

targets

tfile

tfile close

tfile copy

tfile fsetstat

tfile fstat

tfile ls

tfile lstat

tfile mkdir

tfile open

tfile opendir

tfile read

tfile readdir

tfile readlink

tfile realpath

tfile remove

tfile rename

tfile rmdir

tfile roots

tfile setstat

tfile stat

tfile symlink

tfile user

tfile write

unloadhw

updatemss

verify

version

xsdbserver disconnect

xsdbserver start

xsdbserver stop

xsdbserver version


This list was generated with this command and then transposed with Google Sheets:

xsdb% help xsct allcommands                                                                                                   unknown command or category "xsct allcommands": must be ...

Documentation

XSCT

Xilinx Software Command-Line Tool Reference Guide UG1208 (v2019.1) May 22, 2019




Vitis Unified Software Platform Documentation: Embedded Software Development (UG1400) - 636 pages - snapshot on 2024-01-28




XSDB

Debugging Guest Applications with QEMU, XSDB, and XSCT




Example Install location

XSCT

/home/demouser/tools/amd//Vitis/2023.1/bin/xsct


XSDB

/home/demouser/tools/amd//Vitis/2023.1/bin/xsdb


Start

XSCT

source ~/tools/amd/Vitis/2022.1/settings64.sh
xsct

Output:

rlwrap: warning: your $TERM is 'xterm-256color' but rlwrap couldn't find it in the terminfo database. Expect some problems.                                                                                ****** Xilinx Software Commandline Tool (XSCT) v2022.1.0
  **** SW Build 3524075 on 2022-04-13-17:42:45
    ** Copyright 1986-2022 Xilinx, Inc. All Rights Reserved.
xsct%    

XSDB

source ~/tools/amd/Vitis/2022.1/settings64.sh
xsdb

Output:

rlwrap: warning: your $TERM is 'xterm-256color' but rlwrap couldn't find it in the terminfo database. Expect some problems.                                                                                
****** Xilinx System Debugger (XSDB) v2022.1
  **** Build date : Apr 18 2022-16:10:31
    ** Copyright 1986-2022 Xilinx, Inc. All Rights Reserved.
xsdb%   

Exit

XSCT

exit

XSDB

exit

Help

XSCT

xsct -help
demouser@fpgadev:~/Desktop$ xsct -help
rlwrap: warning: your $TERM is 'xterm-256color' but rlwrap couldn't find it in the terminfo database. Expect some problems.
Usage: xsct [options] [tclscript] [tclargs]                                     Options:
  -interactive
	Enter interactive mode after -eval or running script.
  -help
	Display this help message.
  -no-ini
	Do not load xsct.ini
  -quiet
	Start XSCT in silent mode
  -eval tclcommand
	Execute <tclcommand> then exit
  -eclipseargs <eclipse arguments>
	Any other arguments that should be passed to Eclipse.
	This should follow all other XSCT arguments.
  -vmargs <java vm arguments>
	Any other arguments that should be passed to Java VM.
	This should follow all other XSCT arguments.

XSDB

xsdb -help
demouser@fpgadev:~/Desktop$ xsdb -help
rlwrap: warning: your $TERM is 'xterm-256color' but rlwrap couldn't find it in the terminfo database. Expect some problems.
Usage: xsdb [options] [tclscript] [tclargs]                                     
Options:
  -interactive
	Enter interactive mode after -eval or running script.
  -help
	Display this help message.
  -no-ini
	Do not load xsdb.ini
  -quiet
	Start XSDB in silent mode
  -eval tclcommand
	Execute <tclcommand> then exit

Comments


bottom of page