Tektronix TekExpress DisplayPort Help, TekExpress DisplayPort Online Help
TekExpress® DisplayPort
Automated Compliance, Characterization, and Debug Solutions
Online Help
www.tektronix.com
077-0233-00
Copyright © Tektronix. All rights reserved. Licensed software products are owned by Tektronix or its
subsidiaries or suppliers, and are protected by national copyright laws and international treaty provisions.
Tektronix products are covered by U.S. and foreign patents, issued and pending. Information in this
publication supersedes that in all previously published material. Specifications and price change privileges
reserved.
TEKTRONIX and TEK are registered trademarks of Tektronix, Inc.
TekExpress DisplayPort Online help, 076-0179-00.
Contactin
Tektronix, Inc.
14200 SW Karl Braun Drive
P. O . Box 500
Beaverton, OR 97077
USA
For product information, sales, service, and technical support:
g Tektronix
In North America, call 1-800-833-9200.
Worldwide, visit www.tektronix.com to find contacts in your area.
Table of Contents
General Safety Summary .......................................................................................... v
Introduction
Using Online Help....................................... ................................ ........................... 1
Related Documentation ............... ................................ ................................ ............. 2
Conventions ................................ ................................ ................................ ......... 2
Technical Support ............. .................................. ................................ ................... 3
Getting Started
Accessories..................... ................................ .................................. ................... 5
Minimum System Requirements....................... .................................. ......................... 6
Application Directories and Usage .... .................................. ................................ ......... 7
File Name Extensions .............................................................................................. 8
How To Activate the License................... .................................. ................................ . 9
Before You Click Run............................................................................................. 11
Table of Contents
Operating Basics
TekExpress Application Overview .............................................................................. 15
Starting the Application............................. .................................. ............................ 16
Resizing the Application Window....... ................................ .................................. ...... 17
Exiting the Application .... ... . . .... . .... ... . . .... . .... ..... .... . .... . .... .... . .... . .... ... . . .... . .... ..... .... . .. 17
Global Controls .............................. ................................ ................................ ...... 18
Menus
File Menu............ .................................. ................................ ........................ 19
View Menu .......... ................................ .................................. ........................ 20
Tools Menu .................................................................................................... 21
Help Menu..................................................................................................... 23
How To
Select the Test(s)............... ................................ .................................. .................. 25
Configure and Run the Test(s).............. .................................. ................................ .... 27
View and Select Connected Instruments ........................ ................................ ................ 30
View the Progress of Analysis ................................... .................................. .............. 32
View the Report.................................................................................................... 34
iew Test Related Files... .................................. ................................ ...................... 35
V
Generate Patterns .................................................................................................. 36
Application E xamples
Sink Receiver Compliance Test
TekExpress DisplayPort Automated Compliance Solutions i
Table of Contents
Jitter Tolerance Test for Lane 0: Equipment Setup .. . .... ... . . .... . .... . .... ..... .... . .... . .... ... . . .... . 37
Jitter Tolerance Test for RBR in Semi-Automated mode. . .... ... . . .... . .... ..... .... . .... . .... .... . .... . 38
Jitter Tolerance Test for RBR in Automated Mode .. . .... .... . .... . .... . .... ..... .... . .... . .... ... . . .... . 42
TekExpress Pattern Sequence
Pattern Sequence................... ................................ .................................. .............. 45
TekExpress Programmatic Interface
About Programmatic Interface................................................................................... 53
Server and Client Proxy Objects ................................................................................. 55
Remote Proxy Object........... .................................. ................................ ............ 55
Client Proxy Object................. .................................. ................................ ........ 56
Programmatic Interface APIs
Connect() ...................................................................................................... 58
Disconnect()................................................................................................... 59
LockSe
UnlockSession() .............................................................................................. 61
SetTimeOut()................................ .................................. ................................ 62
GetTimeOut() ................................................................................................. 63
GetDutId() ..................................................................................................... 64
ChangeDutId() ................................................................................................ 65
SaveSession() ................................................................................................. 66
SaveSessionAs() .... ................................ ................................ .......................... 67
RecallSession()................................................................................................ 68
Run() . ................................ ................................ .................................. ........ 69
Stop()........................................................................................................... 70
QueryStatus().................................................................................................. 71
TransferReport() .............................................................................................. 72
CheckSessionSaved() .... .................................. ................................ .................. 73
ErrorCodes ......................................................................................................... 74
Example ............................................................................................................ 75
ssion(). .................................. ................................ .............................. 60
Troubleshooting
Instrument Connectivity .......................................................................................... 77
User Interface .. ................................ ................................ .................................. .. 77
TestStand Run time Engine Installation......... .................................. .............................. 78
Test Limit is Single Sided .............................. ................................ .......................... 79
Report shows as NAN............................. .................................. .............................. 80
Reference
Shortcut Keys .......... ................................ ................................ ............................ 81
Error Codes for TekExpress ...................................................................................... 82
ii TekExpress DisplayPort Automated Compliance Solutions
Index
Table of Contents
TekExpress DisplayPort Automated Compliance Solutions iii
Table of Contents
iv TekExpress DisplayPort Automated Compliance Solutions
General Safety Summary
Review the following safety precautions to avoid injury and prevent damage to this product or any
products connected to it.
To avoid potential hazards, use this product only as specified.
Only qualified personnel should perform service procedures.
While using this product, you may need to access other parts of a larger system. Read the safety sections
of the other component manuals for warnings and cautions related to operating the system.
To Avoid Fire or Personal Injury
Connect and Disconnect Properly. Connect the probe output to the measurement instrument before
connecting the probe to the circuit under test. Connect the probe reference lead to the circuit under test
before c
under test before disconnecting the probe from the measurement instrument.
onnecting the probe input. Disconnect the probe input and the probe reference lead from the circuit
General Safety Summary
Observ
Consult the product manual for further ratings information before making connections to the product.
Do Not
Do Not Operate With Suspected Failures. If you suspect that there is damage to this product, have it
insp
Avoid Exposed Circuitry. Do not touch exposed connections and components when power is present.
e All Terminal Ratings. To a void fire or shock hazard, observe all ratings and markings on the product.
Operate Without Covers. Do not operate this product with covers or panels removed.
ectedbyqualified service personnel.
Terms in this Manual
ese terms may appear in this manual:
Th
WARNING. Warning statements identify conditions or practices that could result in injury or loss of life.
CAUTION. Caution statements identify conditions or practices that could result in damage to this product or other
y.
propert
TekExpress DisplayPort Automated Compliance Solutions v
General Safety Summary
vi TekExpress DisplayPort Automated Compliance Solutions
Introduction Using Online Help
Introduction
Using Online Help
Select Help from the menu to open the help file. You can also find an electronic copy of the help file in the
Documents directory on the 063-4068-XX DVD.
Tables of Contents (TOC) tab — Organizes the help into book-like sections. Select a book icon to open a
section; select any o f the topics listed under the book.
Index tab — Enables you to scroll a list of alphabetical keywords. Select the topic of interest to bring
up the appropriate help page.
Search tab — Allows a text-based search.
Follow these steps:
1. Type the word or phrase you want to find in the search box. If the word or phrase is not found, try the
Index tab.
2. Choose a topic in the lower box, and then select the Display button.
General Help Functions:
Select the Print button from the Help topics menu bar to print a topic.
To return to the previous window, select the Back button.
Use hyperlinks to jump from one topic to another.
e back button is grayed out or a jump is not available, choose the Help Topics button to return to
If th
the originating help folder.
TekExpress DisplayPort Automated Compliance Solutions 1
Introduction Related Documentation
Related Documentation
In addition to this TekExpress DisplayPort Online Help, the following documentation is included with
the software:
DisplayPort Standard Tektronix MOI for Sink Tests method of implementation document.
TekExpress DisplayPort Online Help (PDF version), Tektronix part number 077-0233-00.
Conventions
Online Help uses the following conventions:
The term “DUT” is an abbreviation for Device Under Test.
The term
using a mouse or using the touch screen.
Table 1: Icon descriptions
Icon Meaning
“select” is a generic term that applies to the two mechanical methods of choosing an option:
This icon identifies important information.
This icon identifies conditions or practices that could result in loss of data.
This icon identi fies additional information that will help you use the
application more efficiently.
2 TekExpress DisplayPort Automated Compliance Solutions
Introduction Technical Support
Technical Support
Tektronix values your feedback on our products. To help us serve you better, please send us your
suggestions, ideas, or comments on your application or oscilloscope.
When you contact Tektronix Technical Support, please include the following information (be as specificas
possible):
General Information
All instru
Hardware options, if any.
Probes used.
Your name, company, mailing address, phone number, FAX number.
Please indicate if you would like to be contacted by Tektronix about your suggestion or comments.
ment model numbers.
Application Specific Information
Software version number.
Description of the problem such that technical support can duplicate the problem.
If possible, save the setup files for all the instruments used and the application.
ssible, save the TekExpress setup files, log.xml and status messages text file.
If po
If possible, save the waveform on which you are performing the measurement as a .wfm file.
Forward the information to technical support using one of these methods:
E-mail – techsupport@tektronix.com
FAX – (503) 627-5695
TekExpress DisplayPort Automated Compliance Solutions 3
Introduction Technical Support
4 TekExpress DisplayPort Automated Compliance Solutions
Getting Started Accessories
GettingStarted
Accessories
About the Effic
ere Test Fix ture
The Efficere text fixtures ET-DP-TPA-S that facilitate Sink Compliance testing are manufactured
and distribu
tedbyEfficere Technologies. Efficere ET-DP-TPA-S can also be ordered directly from
Tektronix. Efficere specializes in the design of high-speed products with superior signal integrity. For
more information, visit the Efficere Technologies Web site w
ww.Efficere.com.
TekExpress DisplayPort Automated Compliance Solutions 5
Getting Started Minimum System Requirements
Minimum System Requirements
The minimum system requirements for a PC to run TekExpress are as follows:
Table 2: System requirements
Processor
Pentium 4/M or equivalent processor.
Operating System Windows XP Service Pack 2.
Memory
Hard Disk
512 MB of memory.
Approximately 2 GB of available hard-disk space for the recommended
installation, which includes full TekExpress installation and distributed
components.
Drive DVD drive
Display
Super VGA resolution or higher video adapter (800x600 minimum video
resolution for small fonts or 1024x768 minimum video resolution for large fonts).
The application is best viewed at 96 dpi display settings
1
.
Software IConnect S-parameter software (80SSPAR) for Cable testing.
DPOJET and SerialXpress for Sink testing.
Microsoft Excel 2002 or above.
Microsoft Internet Explorer 6.0 SP1 or later.
Microsoft Photo Editor 3.0 or equivalent software for image files viewing.
Adobe Reader 6.0 or equivalent software for viewing portable document
format (PDF) files.
Other Devices Microsoft compatible mouse or compatible pointing device.
Four USB ports (2 USB ports minimum).
PCI-GPIB or equivalent interface for instrument connectivity2.
1
If TekExpress is running on an instrument having a video resolution lower than 800x600 (for example, sampling oscilloscope), it is recommended
to connect a secondary monitor and this has to be enabled before launching the application.
2
If TekExpress is installed on a Tektronix oscilloscope, the virtual GPIB port cannot be used by TekExpress for communicating with oscilloscope
applications.
xternal devices like USB-GPIB or equivalent are used for instrument connectivity, ensure that the Talker Listener utility is enabled in the
If e
DPO/DSA oscilloscope’s GPIB menu.
6 TekExpress DisplayPort Automated Compliance Solutions
Getting Started Application Directories and Usage
Related Topics
Application Directories and Usage
File Name Extensions
How To Activate the License
View Test Related Files
The application directory and associated files are organized as follows:
The following table lists the default directory names and their usage:
Table 3: Default directory names and their usage
Directory names Usage
InstallDir\TekExpress Contains the application and associated files.
\TekExpress\Compliance Suites Has compliance specific sequence files. The folders
under this directory represent the devices to be
tested.
\TekExpress\Compliance Suites\DisplayPort\ Includes “Sink” folder.
\TekExpress\Compliance Suites\DisplayPort\Sink
\TekExpress\ACP
\TekExpress\SCP
\TekExpress\ICP
\TekExpress\Data Manager
\TekExpress\Data Storage
\TekExpress\Report Generator
\TekExpress\Documents Includes the Method of Implementation documents
Includes the AUX controller “Available” and “Not
Available” folders.
Includes instrument and application specific
interface libraries of TekExpress.
Includes the result management specific libraries of
TekExpress are present in these folders.
and technical documentation for the application.
TekExpress DisplayPort Automated Compliance Solutions 7
Getting Started File Name Extensions
Table 3: Default directory names and their usage (cont.)
Directory names Usage
\TekExpress\Bin
\TekExpress\Lib
\TekExpress\Tools
File Name Extensions
Includes the Miscellaneous libraries of TekExpress.
Related Topics
Application Directories and Usage
How To Activate the License
Thesoftwareuses
File name extension Description
.TekX
.seq
.xml
.PDF
the following file name extensions:
The session file will be saved in this format.
The test sequence file.
The encrypted XML file that contains the test specificconfiguration
information.
The PDF file tha
The log file extension is also xml.
t details the method of implementation for the test.
8 TekExpress DisplayPort Automated Compliance Solutions
Getting Started How To Activate the License
Related Topics
How To Activate the License
Application Directories and Usage
File Name Extensions
Follow the steps below to activate the license:
1. Click Help > About to view the license information.
2. Click the View Version Details link to check the version numbers of the installed test suites.
3. Click the View End-User License Agreement link to open the following Tektronix Software License
Agreement window. Click Print to print the License Agreement.
TekExpress DisplayPort Automated Compliance Solutions 9
Getting Started How To Activate the License
4. Click License Info to view the available software options. This window shows the license key and the
various options with their status (active or inactive) with the current license key.
5. If you are activating the license for the first time, the license key field will be empty. To activate
the license, connect the USB dongle to your computer, enter the license key provided in the license
key certificate, and click Activate. If the activation is successful, a
the license key field.
6. If you are reactivating the license, click Reactivate, enter the new license key and click Activate.
sign is displayed next to
10 TekExpress DisplayPort Automated Compliance Solutions
Getting Started Before You Click Run
Before You Click Run
After you first launch TekExpress, it creates the following folders on your computer:
\My Documents\My TekExpress
NOTE. Ensure that the “My TekExpress” folder has read and write access.
NOTE. If a user with a different Windows login ID launches TekExpress, a new
under that user’s
\My Documents\My TekExpress\DisplayPort.
\My Documents\My TekExpress\DisplayPort\Untitled Session. Every time the
DisplayPort.exe is launched a Untitled Session folder is created under DisplayPort folder.
The
Untitled Session folder is deleted when you exit TekExpress.
My Documents
folder
My TekExpress
folder is created
CAUTION. Each session has multiple files associated with it. Do not modify any of the session files and/or folders as
this may result in loss of data or corrupted session files.
The My TekExpress folder is created as a shared folder with share name as <domain> <user
ID> My TekExpress
name><user ID> My TekExpress
(or if the PC is not connected to domain then share name is <Computer
).
The above shared folder is mapped as X: (X drive) on to the PC where TekExpress is running.
NOTE. If X drive is mapped to any other shared folder, TekExpress will pop-up a Warning message window asking to
disconnect the X: drive manually.
Do the following before you click Run:
NOTE. Ensure that the network connectivity is enabled on the PC running the TekExpress.
1. Map the shared My TekExpress folder as X: (X drive) on all the instrume nts used in test setup
running Microsoft Windows Operating System. This share folder is used to save the waveform files
or any other file transfer operations.
2. Rightclickonthe
My TekExpress folderandopentheProperties dialog box. Select General tab
and then Advanced.IntheAdvanced Attributes window, ensure that the option Encrypt contents
to secure data is NOT selected. Click h
ere to view the picture.
TekExpress DisplayPort Automated Compliance Solutions 11
Getting Started Before You Click Run
3. Ensure that the DisplayPort pattern file provided with TekExpress DVD are available on the respective
instruments. For more details, refer to the
Files
folder o
n the TekExpress DVD.
ReadmeFirst.txt located in the DisplayPort Setup
Mapping My TekExpress folder
To map the My TekExpress folder on the instruments, follow the steps below:
1. Open Window
s Explorer.
2. From the Windows Explorer menu, select Tools > Map Network drive.
3. Select the Drive letter as X: (if there is any previous connection on X:, disconnect it first through
Tools > Disconnect Network drive menu of Windows Explorer).
4. In the Folder field, enter remote
My TekExpress folder path (for example, \\192.158.97.65\
John’s My TekExpress)
5. You can determine the IP address of the PC where “My TekExpress” folder exists by doing the
following:
Select Start > Run menu on the PC where My TekExpress folder exists.
Enter cmd and click Enter.
At command prompt, type ipconfig.
12 TekExpress DisplayPort Automated Compliance Solutions
Getting Started Before You Click Run
TekExpress DisplayPort Automated Compliance Solutions 13
Getting Started Before You Click Run
14 TekExpress DisplayPort Automated Compliance Solutions
Operating Basics TekExpress Application Overview
OperatingBasics
TekExpress Application Overview
TekExpress is the Tektronix Compliance Characterization, and Debug Test Automation Framework,
developed to support current and future test automation needs of customers. Developed using National
Instruments
highly modular architecture that enables deploying automated test solutions for various serial standards
in a relatively short time. TekExpress provides a test automation solution for the DisplayPort CTS 1.1
standards.
’ TestStand, TekExpress leverages on the capabilities of Microsoft .NET framework. It is a
TekExpress DisplayPort Automated Compliance Solutions 15
Operating Basics Starting the Application
Related Topics
Starting the Application
Resizing the Application Window
Exiting the Application
The application uses a USB dongle that contains the license key. This dongle must be present on the PC or
the instrument hosting the TekExpress application.
The application also checks for a file, called
is not found, instrument discovery is performed before launching TekExpress. The
Resources.xml, located in My TekExpress folder. If this file
Resources.xml file
contains information regarding instruments available on network.
When the application starts, it checks for the appropriate license key. If the valid license key is not present,
the application switches to the “Demo” mode. If the application fails to detect the dongle, it continues
toruninDemomode.
To start the application, you can do one of the following:
Click Start > Programs > Tektronix > TekExpress > TekExpress DisplayPort.
Double click the icon on the desktop.
If you have previously saved a session, you can double-click the session file stored under My
TekExpress\DisplayPort
.
When the application is launched it displays the splash screen providing launch information. The
application also checks for the presence and validity of the USB dongle.
NOTE. If the application was not terminated properly during the last use, a dialog box asks to recall the previously
unsaved session.
16 TekExpress DisplayPort Automated Compliance Solutions
Operating Basics Resizing the Application Window
Related Topics
Resizing the Application Window
Starting the Application
Exiting the Application
To minimize the application, click on the application title bar. To restore the application to its
previous size, select
To maximize the application, click . To restore it to previous size, click on the application
title bar.
Exiting the Application
To exit the application, do one o f the following:
Click File > Exit.
Click on the application title bar.
in the Windows task bar.
Related Topics
Starting the Application
Resizing the Application Window
TekExpress DisplayPort Automated Compliance Solutions 17
Operating Basics Global Controls
Global Controls
The menus and controls that appear outside the individual tabs are called “Global Controls”. These are
used to specify the devices to be tested.
Table 4: Controls and Functions
Control name Function
DUT
Menus
The device ID is specified at the global level and the
ion is stored in the default location for all data
informat
files. This field cannot be empty and does not allow these
special characters (.,..,...,\,/:?”<>|*). The maximum length
of charac
You will
ters allowed is 32.
be able to run/stop the tests.
18 TekExpress DisplayPort Automated Compliance Solutions
Operating Basics File Menu
Related Topics
File Menu
View Menu
Tools Menu
Help Menu
Click File on the application menu bar.
The File menu has the following selections:
Menu Function
New Session Starts a default session of TekExpress.
Open Session Opens a saved session.
Save Session Saves the session.
Save Session As Saves a session in a different name.
Save Report As Saves the report in user specified location.
Print Preview Report
Print Report
Recent Sessions
Exit
Previews the report before printing.
Opens the Windows “Print” dialog box.
Lists recent sessions.
Closes the application.
TekExpress DisplayPort Automated Compliance Solutions 19
Operating Basics View Menu
Related Topics
View Menu
File Menu
Tools Menu
Help Menu
Click View on the appl
The View menu has t
Menu Function
Log File
ication menu bar.
he following selections:
Opens the log (log.xml) file in the default viewer.
20 TekExpress DisplayPort Automated Compliance Solutions
Loading...