com.xilinx.rapidwright.debug

Class DesignInstrumentor

Object

com.xilinx.rapidwright.debug.DesignInstrumentor

public class DesignInstrumentor
extends Object

This class serves as the main entry point for the BYU/Xilinx debug instrumentation flow within RapidWright. Created on: Nov 30, 2015

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEBUG_CORE_PATH
static String	SAMPLE_DEPTH_KEYWORD

Constructor Summary

Constructors

Constructor and Description
DesignInstrumentor()

Method Summary

Modifier and Type	Method and Description
void	createLTX(String name) Uses list of signals marked for debug to produce debug netlist (.ltx) file for debugging.
void	instrumentDesign() Meat of the instrumentation process.
void	loadInstrumentationDetailsFile(String fileName) This should load the instrumentation file details into class members.
static void	main(String[] args) This is the main entry point for Vivado design debug instrumentation.
void	stitchDebugHubToILA(ModuleInst ilaCorePhysical, EDIFCellInst ilaCoreLogical, ModuleInst dhCorePhysical, EDIFCellInst dhCoreLogical)
void	stitchProbesOnILA(ModuleInst mi, EDIFCellInst debugCore) Stitches in the debug unit probes and clock into the user design.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SAMPLE_DEPTH_KEYWORD

public static final String SAMPLE_DEPTH_KEYWORD

See Also:

Constant Field Values

DEBUG_CORE_PATH

public static final String DEBUG_CORE_PATH

Constructor Detail

DesignInstrumentor

public DesignInstrumentor()

Method Detail

loadInstrumentationDetailsFile

public void loadInstrumentationDetailsFile(String fileName)

This should load the instrumentation file details into class members. The file will likely be small, so the function is written for ease of implementation, not speed.

Parameters:

fileName - Name of the instrumentation details file.

stitchProbesOnILA

public void stitchProbesOnILA(ModuleInst mi,
                              EDIFCellInst debugCore)

Stitches in the debug unit probes and clock into the user design. Specifically, it add the input pin ports of the debug block onto the user design nets of interest.

stitchDebugHubToILA

public void stitchDebugHubToILA(ModuleInst ilaCorePhysical,
                                EDIFCellInst ilaCoreLogical,
                                ModuleInst dhCorePhysical,
                                EDIFCellInst dhCoreLogical)

instrumentDesign

public void instrumentDesign()

Meat of the instrumentation process. This function will: (1) Choose which pre-compiled block to load based on requested parameters (2) Load the blocks(2) (3) Stitch blocks into user design (4) Place blocks in empty locations within user design (5) Route updated nets

createLTX

public void createLTX(String name)

Uses list of signals marked for debug to produce debug netlist (.ltx) file for debugging.

main

public static void main(String[] args)

This is the main entry point for Vivado design debug instrumentation.

Parameters:

args - There are 3 arguments to this function: (0) Name of the file containing instrumentation details (1) Name of the XPN file for the design (2) Name of the EDIF file for the design The program, under normal operation will output two file names separated by a space These are the instrumented XPN and EDIF files respectively.