To integrate the eye-scan module used in XAPP1198 into an existing GT wizard design you must instantiate the Eye Scan module into the code.
For the default example design this would mean pasting the instantiation into the <design_name>_exedes.v file.
This instantiation is provided in the instantiation.v file.
It needs to be connected to a DRP clock, a reset, and the DRP ports for the design.
The names are set to the default names for the GT wizard, such as gt0_drpen, and might need to be adjusted if they have changed.
An example GT wizard example design for the KC705 board has been attached for reference.
After the instantiation is done you need to download the source files from xapp1198 and place them in the proper place or adjust the path to the '1198 source directory in the TCL file on lines 9, 27, and 31 so that it can pick up the design.
To run the design without any changes to the script you will need the main directories of xapp1198 in the directory above the project file.
This will include scan_time and source.
The project directory must be the active directory to run the project from.
Copy the files from the run_here directory into your project directory.
Important files here are the AddEyeScan.tcl and/or AddEyeScanBatch.tcl.
The differences between these files are explained below.
Change the project name on line 5 of the AddEyeScan.tcl file to match the name of your project.
Line 5> open_project custom_eyescanTest
If you do not use the Vivado Gui and operate solely in batch mode then you will need to build a new project.
In that case line 5 will change to:
Line5> create_project custom_eyescanTest . -part xc7k325tffg900-2 -forceChange the part to match the part for your design.
Also if you work in batch mode you will have to use the add_files command for all of the files you use in your design or add all of the files in the appropriate directory.
The way to do this for the example design is shown on lines 12 to 16.
The file AddEyeScanBatch.tcl has these two changes already made but the part number will still likely need to be modified.
You can now run the .tcl file and it will install the Eye Scan into the design, implement it and load the code into the GT.
Once this is done, To run the Eye Scan, type run_eyescan on the tcl command line.
As shown in the XAPP the program is run from the Vivado TCL console.
Change directories until you are in the root directory of the example design. (The directory where the project file, <design_name>.xpr resides)
The example here is for an 8 lane design. There are instructions in XAPP1198 for changing the number of lanes.