Limited Warranty Unigraf warrants its hardware products to be free from defects in workmanship and materials, under normal use and service, for twelve (12) months from the date of purchase from Unigraf or its authorized dealer. If the product proves defective within the warranty period, Unigraf will provide repair or replacement of the product.
UCD Console for UCD-340 User Manual | Unigraf Oy Table of Contents Copyright ....................2 Notice ......................2 Edition ....................... 2 Company Information ................2 Trademarks ....................3 Limited Warranty ..................3 CE Mark ....................3 About This Manual ................... 6 Purpose .....................
Page 5
UCD Console for UCD-340 User Manual | Unigraf Oy USBC Electrical Test Set – DP Rx and DP TxVirhe. Kirjanmerkkiä ei ole määritetty. Up Face Port CC and Vconn TestVirhe. Kirjanmerkkiä ei ole määritetty. AUX (SBU) Lines Test ..Virhe. Kirjanmerkkiä ei ole määritetty.
ABOUT THIS MANUAL Purpose This guide is the User Manual for UCD-240, USB-connected interface test units for testing the features of USB Type-C interface. UCD Console can be used in a PC with Windows® 10 Windows® 8 or Windows® 7 operating system.
UCD Console for UCD-340 User Manual | Unigraf Oy INTRODUCTION Product Description UCD-240 is a Test Automation tool for testing USB-C DisplayPort Alt Mode products. UCD-240 Product Features Test unit for testing power delivery and DP Alt Mode functions of USB-C interface ...
Page 8
Warning In order to avoid possible damage to UCD-240 unit and the PC, please always attach the power cord (Power In) to UCD-240 unit first, and after that connect the USB cable to your PC.
Unigraf External USB-C Power Test Unit enables testing extended USB power options. Please find below a matrix describing Power Source and Power Sink options of UCD-340 internally and with attached Unigraf External Power Test Unit. Please find description of controlling the power options with UCD Console later in this manual.
Page 10
Unigraf Electrical test cable with units including Electrical Test USB 3.0 Memory Stick Unigraf USB Flash Drive The USB Flash drive delivered with UCD-240 device includes the following items: Test Sequences and macros UCD-240 Software installation package Tutorial Videos...
UCD Console for UCD-340 User Manual | Unigraf Oy HARDWARE INSTALLATION UCD-240 is delivered with scripts that enable installing the device without using the UCD Console GUI. Please, follow the steps introduced in the following chapters for installing Unigraf Electrical Test Cable and DUTs.
Page 12
You can check the status of the DUT by running the USBCRoleStatuses text file. The file can be found from the USB Flash Drive delivered with UCD-240. The script shows power role, data role, VCONN, DP Alt Mode and power contract status of the DUT. By running this script you can ensure that the DUT has been successfully set to the correct DP Alt Mode.
SOFTWARE INSTALLATION Installation Package The UCD-240 software installation package is stored in the USB flash drive delivered with the device. The UCD-240 software installation package can also be obtained from Unigraf download page at www.unigraf.fi/support/download-links. For updating the software for UCD-240, please refer to the aforementioned page for downloading the latest software version.
UCD Console for UCD-340 User Manual | Unigraf Oy Software Installation Start the installation by running Unigraf Software Bundle Setup.exe Once the installer has started, a welcome page is displayed. The welcome page shows the software package release version.
UCD Configuration Utility enables the user to select the operation roles present in the UCD-240 unit. The utility configures a firmware set for the selected operation roles and programs the firmware set to the device. Please contact Unigraf for details.
UCD Console for UCD-340 User Manual | Unigraf Oy Updated Modules The tool prompts you for selection of the firmware modules to be updated. It compares the modules in the selected device and omits the ones that are the same.
System administrator's privileges are required for accessing the licenses. License Manager GUI Once the application starts up, it will look for any licensing enabled Unigraf device. If no suitable device families are detected, License Manager will exit. Please first select one of the available device families by clicking one of the device family selector buttons.
UCD Console for UCD-340 User Manual | Unigraf Oy Managing Licenses Seed Number Each license is tied to a hardware unit with the help of the Seed Number. Each unit has a unique Seed Number. You can find the Seed Number of the selected unit in the top of the dialog.
UCD Console for UCD-340 User Manual | Unigraf Oy UCD CONSOLE GUI UCD Console is the graphical user interface (GUI) of UCD-240. It provides the user access to set and save all necessary test parameters used in automated tests. Device Selection You can find the shortcut of UCD Console by default under Start Menu path: All programs/Unigraf/UCD Console.
UCD Console for UCD-340 User Manual | Unigraf Oy SOURCE DUT TESTING TAB In UCD Console GUI Source DUT Testing tab you can configure and save tests for running automated tests for USB-C Source DUTs. Please refer the TSI Reference in the chapter 12 of this document to get a full definition of the TSI Test Cases, the parameters and the reporting.
Page 21
UCD Console for UCD-340 User Manual | Unigraf Oy Capturing a Reference frame for the CRC tests Before running the CRC based video test set a Reference CRC must be captured. Set the number of frames to capture and press ‘Capture now’ button. Please note that the DUT needs to be set to DP Alt Mode before the capturing can be done.
Page 22
UCD Console for UCD-340 User Manual | Unigraf Oy Note: Please note that any change in the captured frame (e.g. clock) will result as a failed test. Test sets available in the CRC based video test set are • CRC Based Single Reference Frame Video Test •...
Page 23
UCD Console for UCD-340 User Manual | Unigraf Oy Frame rate tolerance (mHz) Reference CRCs (R, G, B) CRC Based Single Frame Video Stability Test The test verifies that the captured video is stable. TE captures a frame and sets the CRC of its color components as reference. After that TE captures frames and compares their CRC (check sum) to the reference until the number of bad frame limit provided is detected or the provided total number of frames is reached.
Page 24
UCD Console for UCD-340 User Manual | Unigraf Oy TE compares the video mode (frame Width, Height, BPP and optionally Frame rate and Color format) to provided parameters. After that captures frames to find a frame with matching CRC (check sum) of their three color components to the first provided reference.
Page 25
UCD Console for UCD-340 User Manual | Unigraf Oy Link Test Set To save your test configuration click the Export button. You can load previously saved test configuration by clicking the Import button. Link Training at All Supported Lane Counts and Link Rates Test requests link training on all supported lane counts and link rates.
Page 26
UCD Console for UCD-340 User Manual | Unigraf Oy USB-C Electrical Test Set To save your test configuration click the Export button. You can load previously saved test configuration by clicking the Import button. You can modify the test parameters by clicking the Configure… button. Click the value you would like to change and type in the desired value.
Page 27
Configuration items for this test should be programmed with averaged values from several “golden sample” DUT’s. Important In order to run this test with UCD-340, Unigraf Electrical Test Cable must be used and Electrical Testing feature enabled with a corresponding license. Parameters in use ...
Page 28
Parameters for this test should be programmed with averaged values from several “golden sample” DUT’s. Important In order to run this test with UCD-340, Unigraf Electrical Test Cable must be used and Electrical Testing feature enabled with a corresponding license. Parameters in use ...
Page 29
UCD Console for UCD-340 User Manual | Unigraf Oy Bits Description DUT Support for DisplayPort Alt Mode (1 Yes, 0 No) DUT can act as power source (1 Yes, 0 No) DUT can receive power from TE (1 Yes, 0 No)
Page 30
For PASS result, the measured Vbus voltage, Vbus current and GND line current must be within the ranges defined by provided parameters. Important In order to run this test with UCD-340, Unigraf Electrical Test Cable must be used and Electrical Testing feature enabled with a corresponding license. Parameters in use Parameters in use ...
UCD Console for UCD-340 User Manual | Unigraf Oy SINK DUT TESTING TAB In UCD Console GUI Sink DUT Testing tab you can configure and save tests for running automated tests for USB-C Sink devices. Please refer the TSI Reference in the chapter 7 of this document to get a full definition of the TSI Test Cases, the parameters and the reporting.
Configuration items for this test should be programmed with averaged values from several “golden sample” DUT’s. Important In order to run this test with UCD-340, Unigraf Electrical Test Cable must be used and Electrical Testing feature enabled with a corresponding license. Parameters in use ...
UCD Console for UCD-340 User Manual | Unigraf Oy Important In order to run this test with UCD-340, Unigraf Electrical Test Cable must be used and Electrical Testing feature enabled with a corresponding license. Parameters in use Test timeout (default 5 000 ms) ...
Page 34
UCD Console for UCD-340 User Manual | Unigraf Oy DUT can receive power from TE (1 Yes, 0 No) 31:0 Reserved R-plug duration (default 1 500 ms) DUT attach timeout (default 10 000 ms) Power Contract timeout (default 10 000 ms) ...
For PASS result, the measured Vbus voltage, Vbus current and GND line current must be within the ranges defined by provided parameters. Important In order to run this test with UCD-340, Unigraf Electrical Test Cable must be used and Electrical Testing feature enabled with a corresponding license. Parameters in use Parameters in use ...
Page 36
Source DUT testing tab. Electrical Test • Up Face Port CC and VCONN Before running the automated tests with UCD-240 it needs to be ensured that the Unigraf Test Cable and DUT are connected. Detailed instructions for ensuring the connection can...
Page 37
UCD Console for UCD-340 User Manual | Unigraf Oy Test Parameters You can use UCD Console GUI to set the test parameters for the automated tests. Please note that test parameters should always be set according to the characteristics of the DUT and test parameters used in this test set-up might not be suitable for other DUTs.
Page 38
UCD Console for UCD-340 User Manual | Unigraf Oy Run Tests Automated tests are run from the command-line by calling the test scripts. Alternatively, you can run automated tests by opening the batch files that will automatically perform the automated tests. When test is run from the command-line the set test parameters set earlier...
Page 39
UCD Console for UCD-340 User Manual | Unigraf Oy Test Steps Measuring voltages on CC and Vconn lines on straight cable orientation The actual measured voltages in straight cable orientation for each pin are shown in the test log. The testing icon below will appear on the command-line as an external window to demonstrate which pins...
Page 40
UCD Console for UCD-340 User Manual | Unigraf Oy Performing a SW based cable flip After finishing the first set of measurements, Unigraf’s unique SW based cable flip feature will change the cable orientation from straight to flipped. The SW based cable flip enables...
Page 41
UCD Console for UCD-340 User Manual | Unigraf Oy Measuring voltages on CC and Vconn lines on flipped cable Same measurements as in the first step of the test are now performed in the flipped cable orientation.
Page 42
UCD Console for UCD-340 User Manual | Unigraf Oy Test Results Finally, the test results are shown for both cable orientations. Measured voltages and ranges defined in the USB-C specification are shown for each measurement. In the final row of the test-run it’s shown if the test passed or failed.
Page 43
UCD Console for UCD-340 User Manual | Unigraf Oy CRC Based Video Test • Single Frame Video Stability Test Test Parameters and Reference Frame Similar to Electrical Test, test parameters for CRC based video tests are set in UCD Console GUI. You can use UCD Console GUI to set the test parameters for the automated tests.
Page 44
UCD Console for UCD-340 User Manual | Unigraf Oy Run Tests Automated tests are run from the command-line by calling the test scripts. Alternatively, you can run automated tests by opening the batch files that will perform the automated tests. When test is run from the command-line the set test parameters set earlier in the UCD Console GUI are shown in the test log.
Page 45
UCD Console for UCD-340 User Manual | Unigraf Oy Measuring that resolution and BPP match the reference frame Testing the CRC of the incoming video against the reference frame’s CRC values captured and defined earlier. The number of mismatches found during the are shown.
UCD Console for UCD-340 User Manual | Unigraf Oy TSI PROGRAMMING This section defines mechanisms used in TSI that might not be otherwise clear from the otherparts of the reference manual. The intent is to clarify the operation of the more complex partsby providing additional descriptions and details on intended uses.
UCD Console for UCD-340 User Manual | Unigraf Oy External application requirements When TSI calls an external application, it passes information about the request as a command-line parameter containing a number of key-value pairs, or as a reference to a file containing a number of key-value pairs.
UCD Console for UCD-340 User Manual | Unigraf Oy (...Continued) The external application is expected to parse the key-value pairs and result in the DUT carrying out the requested operation. It is up to the designer of this application to decide how to implement it.
Page 49
UCD Console for UCD-340 User Manual | Unigraf Oy (...Continued) Value / Description Refere The value is a request ID that identifies what is being requested for the operator to do and/or evaluate. Currently valid ID’s are listed below. 1 Request for DUT to start link training with given 1.1.5.1...
Page 50
UCD Console for UCD-340 User Manual | Unigraf Oy 15 Request for DUT to send ENABLE_FEC sequence 1.1.5.1 16 Request for DUT to send DISABLE_FEC sequence 1.1.5.1 The value indicates the width of the active area of the “res_x” requested video mode in terms of number of pixels The value indicates the height of the active area of the “res_y”...
Page 51
UCD Console for UCD-340 User Manual | Unigraf Oy (...Continued) Value / Description Refere Indicates number of DP lanes to be used in the next link “dp_lanes” training performed by the DUT Indicates link-rate of DP lanes to be used in the next “dp_linkrat...
UCD Console for UCD-340 User Manual | Unigraf Oy “exit_proce Defines expected exit code for “proceed” response ed” “exit_pass” Defines expected exit code for “pass” response. “exti_fail” Defiens expected exit code for “fail” response. Request parameter details Request ID 1 Request for DUT to start link training with given lane count and link speed.
Page 53
UCD Console for UCD-340 User Manual | Unigraf Oy “res_frate” – Number of frames per second, as milli-hertz (60 fps = 60000) • • “res_bpp” – Number of bits per pixel, as number of bits • “col_format” – Indicates the wanted pixel color formatting “col_range”...
UCD Console for UCD-340 User Manual | Unigraf Oy Request ID 12 Request for operator to check video pattern and respond with “pass” if video playback is correct, and with “fail” if video playback is not correct. The following parameters are included: “op”...
Page 55
UCD Console for UCD-340 User Manual | Unigraf Oy TSI_TS_OF_REQ_ID TSI_TS_OF_REQ_ID 0x216 int of_request_id 4 bytes Synopsis Selects which request’s configuration is accessed through TSI_TS_OF_EXT_APP. Please see table below for request ID values currently defined: Reques Description Refere t ID Select All requests.
Page 56
UCD Console for UCD-340 User Manual | Unigraf Oy Select request for operator to check audio test pattern 1.1.5.1 playback and respond with “pass” if audio playback is correct, and with “fail” if audio playback is not correct. Select request for operator to check video pattern and 1.1.5.1...
UCD Console for UCD-340 User Manual | Unigraf Oy Extended scripting engine The Extended TSI Scripting Engine is an executable scripting language program, tsi.exe, built on top of the Extended TSI API. The program can be run from the Windows command line or from scripting languages such as python.
Page 58
UCD Console for UCD-340 User Manual | Unigraf Oy Key is usually a configuration item write command from this manual (such as TSI_W_USBC_CABLE_CONTROL) or ".read" or ".loadtd" and Value is the value you want to set or get (also from this manual).
UCD Console for UCD-340 User Manual | Unigraf Oy The above command reads the error count for DP lane 1. Example: -c .read=TSI_VERSION_TEXT.bytes.1024; The above command reads the version information (a maximum of 1024 bytes) and prints it out. Defining command macros The macros.tsi text file is automatically read if found.
UCD Console for UCD-340 User Manual | Unigraf Oy Macros example to set source device to two lane DP Alt Mode and check that it succeeded: -d SourceDevice #source device from init.tsi -o 1 #output level 1 -timeout 20000 #time to wait for -waiton below # Set DP Alt Mode for UCD-340.
Page 61
UCD Console for UCD-340 User Manual | Unigraf Oy "text" Print text on new line. -prapp "text" Print text. Append to previous line. "text" Print text and CI from last .read=Value prlastrea expression. -prvar Name Print value of variable (loop or global variable) appended to the previous line.
Page 62
UCD Console for UCD-340 User Manual | Unigraf Oy Name=N0,N1,. Name[1] with values N0, N1,... and the variable Name is the list SIZE. Values within braces can be variables and can be nested: -var Name+=Numb Test=Skip[bool[1]],Skip[bool[0]]. Name- =Number Name*=Numb Name/=Numbe...
Page 63
UCD Console for UCD-340 User Manual | Unigraf Oy file name Write device source PDO data to file (a device wpdoso must be open). urce file name Read source PDO data from file to device(must rpdosour be open). List help for each command.
Page 64
UCD Console for UCD-340 User Manual | Unigraf Oy currently available). Variables defined are global except -loops variables which are nested (they vanish when -endloops is reached). If there is a nested and global variable of the same name, the nested variable is evaluated in expressions. Variables created using an initializer list such as -var Name=N0,N1 will be named Name[0] and Name[1] with values N0 and N1.
Page 65
UCD Console for UCD-340 User Manual | Unigraf Oy -var dhz=2; #delta value for frequency -var bool=0,1 #defines bool[0]=0 and bool[1]=1 -var CsSkip=bool[0],bool[1],bool[1] # CsSkip[0]=0 CsSkip[1]=1 CsSkip[2]=1 -loops cs=3 #three color spaces -loops p=SzP #p starts at 0 for patterns -loops t=SzT #t starts at 0 for timings -if CsSkip[cs].eq.1.and.p.ne.10...
UCD Console for UCD-340 User Manual | Unigraf Oy Running Tests Tests are of the form: -c .loadtd = filename.td; filename.td is a test that has been saved (from the UCD Console program for example). Some tests require operator feedback: the DUT (device under testing) needs to be set into a defined state.
UCD Console for UCD-340 User Manual | Unigraf Oy -c TSI_W_PG_PREDEF_PATTERN_SELECT=9; -c TSI_W_PG_COMMAND=4; #Set_PG_Output_On -c WAIT_3s When -r OperatorFeedBackRequest_ID_2.txt is run it will output a regular log file of the form: OperatorFeedBackRequest_ID_2_20181102131212_log.txt which can be used for checking and debugging.
Page 70
UCD Console for UCD-340 User Manual | Unigraf Oy TESTSTAND INTEGRATION This version of TSI introduces integration functions for National Instrument’s TestStand. This section describes how to use these functions to configure the TE device, set TSI test parameters and run TSI tests.
Page 71
UCD Console for UCD-340 User Manual | Unigraf Oy (...Continued) oErrorCode Reference to a variable that receives an error code. Error codes are non- zero negative values. Zero (and positive values) indicate no error result. oErrorMsg Pointer to the first byte of a 1024 byte character array which receives a human readable error message if the function failed.
Page 72
UCD Console for UCD-340 User Manual | Unigraf Oy (...Continued) TestID Indicates which test to run. Please refer to chapter 6 for information about tests and their ID values. Passed Reference (pointer) to a boolean variable that will be set to “true” if the test was completed with pass status.
Page 73
UCD Console for UCD-340 User Manual | Unigraf Oy iScript Pointer to a string containing the script to be processed. The script can be directly passed as string, or it can be a file-name from which the script is loaded.
Page 74
UCD Console for UCD-340 User Manual | Unigraf Oy A statement consists of a key and an associated value. • • The key and value must be on the same line of text. • There must be an equal sign (‘=’) between key and value.
Page 75
UCD Console for UCD-340 User Manual | Unigraf Oy Source = ‘UCD-323 [1234C567]: HDMI Reference Source’; .output = ‘HDMI-1’; Sink = ‘UCD-323 [4321C876]: HDMI Reference Sink’; .input = ‘HDMI-1’; This will create two device aliases “Source” and “Sink”, with “Source” using the HDMI-1 output port, and “Sink”...
Page 76
UCD Console for UCD-340 User Manual | Unigraf Oy...
UCD Console for UCD-340 User Manual | Unigraf Oy APPENDIX A. PRODUCT SPECIFICATION UCD-240 Test Connections USB Type-C (Dual Role Port) USB Type-A (test signal Device) pass-thru USB Type-B (Host) pass-thru External Power Source / Sink connector DP Alt Mode Resolution up to 4096×2160p60...
UCD Console for UCD-340 User Manual | Unigraf Oy Version History Rev. Date Author Description 12.12.2018 - Created first version 29.4.2019 - First published version...
Need help?
Do you have a question about the UCD-240 and is the answer not in the manual?
Questions and answers