Download

Download Manuals, Datasheets, Software and more:

DOWNLOAD TYPE
MODEL or KEYWORD

Feedback

TMT4 Margin Tester User Manual

TMT4 Margin Tester

This manual provides operating information for the TMT4 Margin Tester. This includes how to run Custom Scans, run Quick Scans, and use API for remote control.


This manual applies to:

TMT4

Related Product Information

  • Manual Type: Primary User
  • Part Number: 077173100
  • Release Date:

By downloading, you agree to the terms and conditions of the Manuals Download Agreement.

Manuals Download Agreement

ATTENTION: please read the following terms and conditions carefully before downloading any documents from this website. By downloading manuals from Tektronix' website, you agree to the following terms and conditions:

Manuals for Products That Are Currently Supported:

Tektronix hereby grants permission and license to owners of Tektronix instruments to download and reproduce the manuals on this website for their own internal or personal use. Manuals for currently supported products may not be reproduced for distribution to others unless specifically authorized in writing by Tektronix, Inc.

A Tektronix manual may have been revised to reflect changes made to the product during its manufacturing life. Thus, different versions of a manual may exist for any given product. Care should be taken to ensure that one obtains the proper manual version for a specific product serial number.

Manuals for Products That Are No Longer Supported:

Tektronix cannot provide manuals for measurement products that are no longer eligible for long term support. Tektronix hereby grants permission and license for others to reproduce and distribute copies of any Tektronix measurement product manual, including user manuals, operator's manuals, service manuals, and the like, that (a) have a Tektronix Part Number and (b) are for a measurement product that is no longer supported by Tektronix.

A Tektronix manual may be revised to reflect changes made to the product during its manufacturing life. Thus, different versions of a manual may exist for any given product. Care should be taken to ensure that one obtains the proper manual version for a specific product serial number.

This permission and license does not apply to any manual or other publication that is still available from Tektronix, or to any manual or other publication for a video production product or a color printer product.

Disclaimer:

Tektronix does not warrant the accuracy or completeness of the information, text, graphics, schematics, parts lists, or other material contained within any measurement product manual or other publication that is not supplied by Tektronix or that is produced or distributed in accordance with the permission and license set forth above.

Tektronix may make changes to the content of this website or to its products at any time without notice.

Limitation of Liability:

TEKTRONIX SHALL NOT BE LIABLE FOR ANY DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION, ANY CONSEQUENTIAL OR INCIDENTAL DAMAGES, DAMAGES FOR LOSS OF PROFITS, BUSINESS INTERRUPTION, OR FOR INFRINGEMENT OF INTELLECTUAL PROPERTY) ARISING OUT OF THE USE OF ANY MEASUREMENT PRODUCT MANUAL OR OTHER PUBLICATION PRODUCED OR DISTRIBUTED IN ACCORDANCE WITH THE PERMISSION AND LICENSE SET FORTH ABOVE.

 

Read Online

Important safety information

This manual contains information and warnings that must be followed by the user for safe operation and to keep the product in a safe condition.

To safely perform service on this product, see the Service safety summary that follows the General safety summary.

General safety summary

Use the product only as specified. Review the following safety precautions to avoid injury and prevent damage to this product or any products connected to it. Carefully read all instructions. Retain these instructions for future reference.

This product shall be used in accordance with local and national codes.

For correct and safe operation of the product, it is essential that you follow generally accepted safety procedures in addition to the safety precautions specified in this manual.

The product is designed to be used by trained personnel only.

Only qualified personnel who are aware of the hazards involved should remove the cover for repair, maintenance, or adjustment.

Before use, always check the product with a known source to be sure it is operating correctly.

This product is not intended for detection of hazardous voltages.

Use personal protective equipment to prevent shock and arc blast injury where hazardous live conductors are exposed.

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.

When incorporating this equipment into a system, the safety of that system is the responsibility of the assembler of the system.

To avoid fire or personal injury

Use proper power cord.

Use only the power cord specified for this product and certified for the country of use. Do not use the provided power cord for other products.

Ground the product.

This product is indirectly grounded through the grounding conductor of the mainframe power cord. To avoid electric shock, the grounding conductor must be connected to earth ground. Before making connections to the input or output terminals of the product,ensure that the product is properly grounded. Do not disable the power cord grounding connection.

Power disconnect.

The power cord disconnects the product from the power source. See instructions for the location. Do not position the equipment so that it is difficult to operate the power cord; it must remain accessible to the user at all times to allow for quick disconnection if needed.

Observe all terminal ratings.

To avoid fire or shock hazard, observe all rating and markings on the product. Consult the product manual for further ratings information before making connections to the product.

Do not operate without covers

Do not operate this product with covers or panels removed, or with the case open. Hazardous voltage exposure is possible.

Avoid exposed circuitry

Do not touch exposed connections and components when power is present.

Do not operate with suspected failures.

If you suspect that there is damage to this product, have it inspected by qualified service personnel.

Disable the product if it is damaged. Do not use the product if it is damaged or operates incorrectly. If in doubt about safety of the product, turn it off and disconnect the power cord. Clearly mark the product to prevent its further operation.

Examine the exterior of the product before you use it. Look for cracks or missing pieces.

Use only specified replacement parts.

Do not operate in wet/damp conditions

Be aware that condensation may occur if a unit is moved from a cold to a warm environment.

Do not operate in an explosive atmosphere

Keep product surfaces clean and dry

Remove the input signals before you clean the product.

Provide proper ventilation.

Refer to the installation instructions in the manual for details on installing the product so it has proper ventilation.

Slots and openings are provided for ventilation and should never be covered or otherwise obstructed. Do not push objects into any of the openings.

Provide a safe working environment

Always place the product in a location convenient for viewing the display and indicators.

Be sure your work area meets applicable ergonomic standards. Consult with an ergonomics professional to avoid stress injuries.

Use care when lifting and carrying the product. This product is provided with a handle or handles for lifting and carrying.

Terms in this manual

These terms may appear in this manual:

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 property.

Terms on the product

These terms may appear on the product:

  • DANGER indicates an injury hazard immediately accessible as you read the marking.
  • WARNING indicates an injury hazard not immediately accessible as you read the marking.
  • CAUTION indicates a hazard to property including the product.

Symbols on the product



When this symbol is marked on the product, be sure to consult the manual to find out the nature of the potential hazards and any actions which have to be taken to avoid them. (This symbol may also be used to refer the user to ratings in the manual.)

The following symbols(s) may appear on the product.

Service safety summary

The Service safety summary section contains additional information required to safely perform service on the product. Only qualified personnel should perform service procedures. Read this Service safety summary and the General safety summary before performing any service procedures.

To avoid electric shock

Do not touch exposed connections.

Do not service alone

Do not perform internal service or adjustments of this product unless another person capable of rendering first aid and resuscitation is present.

Disconnect power

To avoid electric shock, switch off the product power and disconnect the power cord from the mains power before removing any covers or panels, or opening the case for servicing.

Use care when servicing with power on

Dangerous voltages or currents may exist in this product. Disconnect power, remove battery (if applicable), and disconnect test leads before removing protective panels, soldering, or replacing components.

Verify safety after repair

Always recheck ground continuity and mains dielectric strength after performing a repair.

Compliance information

This section lists the safety and environmental standards with which the instrument complies. This product is intended for use by professionals and trained personnel only; it is not designed for use in households or by children.

Compliance questions may be directed to the following address:

Tektronix, Inc.

PO Box 500, MS 19-045

Beaverton, OR 97077, USA

tek.com

Safety compliance

This section lists the safety standards with which the product complies and other safety compliance information.

EU declaration of conformity – low voltage

Compliance was demonstrated to the following specification as listed in the Official Journal of the European Union:

Low Voltage Directive 2014/35/EU.

  • EN 61010-1. Safety Requirements for Electrical Equipment for Measurement, Control, and Laboratory Use – Part 1: General Requirements

U.S. nationally recognized testing laboratory listing

  • UL 61010-1. Safety Requirements for Electrical Equipment for Measurement, Control, and Laboratory Use – Part 1: General Requirements

Canadian certification

  • CAN/CSA-C22.2 No. 61010-1. Safety Requirements for Electrical Equipment for Measurement, Control, and Laboratory Use – Part 1: General Requirements

Additional compliances

  • IEC 61010-1. Safety Requirements for Electrical Equipment for Measurement, Control, and Laboratory Use – Part 1: General Requirements

Equipment type

Test and measuring equipment.

Safety class

Class 1 – grounded product.

Pollution degree description

A measure of the contaminants that could occur in the environment around and within a product. Typically the internal environment inside a product is considered to be the same as the external. Products should be used only in the environment for which they are rated.

  • Pollution Degree 1. No pollution or only dry, nonconductive pollution occurs. Products in this category are generally encapsulated, hermetically sealed, or located in clean rooms.
  • Pollution Degree 2. Normally only dry, nonconductive pollution occurs. Occasionally a temporary conductivity that is caused by condensation must be expected. This location is a typical office/home environment. Temporary condensation occurs only when the product is out of service.
  • Pollution Degree 3. Conductive pollution, or dry, nonconductive pollution that becomes conductive due to condensation. These are sheltered locations where neither temperature nor humidity is controlled. The area is protected from direct sunshine, rain, or direct wind.
  • Pollution Degree 4. Pollution that generates persistent conductivity through conductive dust, rain, or snow. Typical outdoor locations.

Pollution degree rating

Pollution Degree 2 (as defined in IEC 61010-1). Rated for indoor, dry location use only.

IP rating

IP20 (as defined in IEC 60529).

Measurement and overvoltage category descriptions

Measurement terminals on this product may be rated for measuring mains voltages from one or more of the following categories (see specific ratings marked on the product and in the manual).

  • Measurement Category II. For measurements performed on circuits directly connected to the low-voltage installation.
  • Measurement Category III. For measurements performed in the building installation.
  • Measurement Category IV. For measurements performed at the source of low-voltage installation.
Note:Only mains power supply circuits have an overvoltage category rating. Only measurement circuits have a measurement category rating. Other circuits within the product do not have either rating.

Mains overvoltage category rating

Overvoltage Category II (as defined in IEC 61010-1).

Environmental compliance

This section provides information about the environmental impact of the product.

Product end-of-life handling

Observe the following guidelines when recycling an instrument or component:

Equipment recycling
Production of this equipment required the extraction and use of natural resources. The equipment may contain substances that could be harmful to the environment or human health if improperly handled at the product’s end of life. To avoid release of such substances into the environment and to reduce the use of natural resources, we encourage you to recycle this product in an appropriate system that will ensure that most of the materials are reused or recycled appropriately.

This symbol indicates that this product complies with the applicable European Union requirements according to Directives 2012/19/EU and 2006/66/EC on waste electrical and electronic equipment (WEEE) and batteries. For information about recycling options, check the Tektronix Web site (http://www.tek.com/productrecycling).

Battery recycling
This product contains a small installed lithium metal button cell. Please properly dispose of or recycle the cell at its end of life according to local government regulations.
Perchlorate materials
This product contains one or more type CR lithium batteries. According to the state of California, CR lithium batteries are classified as perchlorate materials and require special handling. See www.dtsc.ca.gov/hazardouswaste/perchlorate for additional information.

Transporting batteries

The small lithium primary cell contained in this equipment does not exceed 1 gram of lithium metal content per cell.

The cell type has been shown by the manufacturer to comply with the applicable requirements of the UN Manual of Tests and Criteria Part III, Sub-section 38.3. Consult your carrier to determine which lithium battery transportation requirements are applicable to your configuration, including to its re-packaging and re-labeling, prior to reshipment of the product by any mode of transport.

Key features

  • PCIe Gen 3 (8 GT/s) and Gen 4 (16 GT/s) speeds supported
  • Link widths up to 16 lanes supported
  • Support for CEM, M.2, U.2, and U.3 devices
  • Two scan options: Quick Scan and Custom Scan
  • DUT transmitter (Tx) eye diagrams and link training parameters for each lane tested
  • DUT functional receiver (Rx) evaluation for each lane tested

Documentation

Product documentation

The following table lists the primary product specific documentation available for your product. These and other user documents are available for download from tek.com. Other information, such as demonstration guides, technical briefs, and application notes, can also be found at tek.com.

DocumentContent
Installation and Safety InstructionsSafety, compliance, and basic introductory information for hardware products.
UserOperating information, including API usage, for the product.
Specifications and Performance Verification Technical ReferenceInstrument specifications and performance verification instructions for testing instrument performance.
API commandsAPI commands for remotely controlling the instrument are available from the instrument IP address in the Web browser.
Declassification and Security InstructionsInformation about the location of memory in the instrument. Instructions for declassifying and sanitizing the instrument.

How to find your product documentation

  1. Go to tek.com.
  2. Click Download in the green sidebar on the right side of the screen.
  3. Select Manuals as the Download Type, enter your product model, and click Search.
  4. View and download your product manuals. You can also click the Product Support Center and Learning Center links on the page for more documentation.

Power, environmental, and physical specifications

Power

Input voltage100-240 V
Frequency50-60 Hz
Power200 W maximum
WARNING:To reduce the risk of fire and shock, ensure that the mains power supply voltage fluctuations do not exceed 10% of the operating voltage range.

Environmental

Temperature
Operating0°C to +50°C, with 15°C/hour maximum gradient, non-condensing
Non-operating-40°C to +71°C, with 30°C/hour maximum gradient
Required instrument clearance
RearNone
BottomFeet provide sufficient clearance. Do not operate instrument without feet.
Sides50.8 mm (2 in)
TopNone
Humidity
Operating

5% to 95% relative humidity (% RH) at up to +30°C

5% to 75% RH above +30°C up to +40°C

45% RH above +40°C up to 50°C, non-condensing

Non-operating

5% to 95% RH (Relative Humidity) at up to +30°C

5% to 45% RH above +40°C up to +71°C, non-condensing

Altitude
OperatingUp to 3,000 meters
Non-operatingUp to 12,000 meters

Physical

MeasureInstrument only
Weight3.13 kg (6.89 lbs) stand-alone instrument
DimensionWith protective cover, handle, and feetNo protective cover,with 50 Ω terminators
Height150 mm147 mm
Width206 mm200 mm
Depth286 mm277 mm

Setup and installation

Connect and turn on

CAUTION:Do not disconnect a device under test when the instrument is powered on. If a disconnection occurs when power is on, the instrument must be powered off, and then powered back on after DUT connectivity is restored.

Follow these steps after you unpack the instrument to turn it on, connect, and get started. This requires an Ethernet connection.

  1. Plug in an Ethernet cable to the LAN connector on the rear panel of the instrument and then directly to the host PC or to an Ethernet network.
  2. Plug in the supplied power cord to the power connector on the rear of the instrument and to an appropriate power source.
  3. Push the Power button on the front panel to turn on the instrument. The Power button LED color indicates the power mode of the instrument. Amber is Standby. Blue is On. No light means the instrument is unplugged and Off.
  4. When you are turning on the instrument for the first time, the following screen should appear. Write down the IP address shown on the screen of your instrument.



  5. Open a browser window on a PC and enter the IP address from your instrument.
  6. Enter the serial number of your instrument into the Factory Password field. Then enter a new password in the New Password field. Re-enter the password. Be sure to remember the new password or record and place it in a secure location. It will be needed each time the instrument is remotely accessed.



  7. A Welcome screen with the instrument menus will appear after you click the Change Password button.

Remote control through the API

You can program and control your instrument using API commands. Do the following to access the Swagger interface for the API:

  1. Enter the IP address of the instrument into a PC browser window.
  2. Then add :5000/api/docs to the IP address. Example: 123.00.1.1:5000/api/docs
  3. The API Swagger page will appear.

Front panel controls and connectors

The front panel provides access to power button, trigger and signal inputs and outputs, and touchscreen display.



Description
1

Power button. LED color indicates power mode.

Off: Unplugged (unplug the power cord to remove power completely)

Amber: Standby

Blue: On

2PCIe high density connector
3USB 2.0 type A port.
4

Banana type ground connection. Discharge the static voltage from your body by wearing a grounded antistatic wrist strap while connecting and disconnecting cables and adapters.

5(Not yet available) Trigger Out +1.25 V, 50 Ω
6(Not yet available) Trigger In +3.3 V, 50 Ω
75" LCD touch screen provides access to basic controls and test results.

Rear panel connectors

The rear panel connectors provide access to power and LAN.



Description
1LAN. 10/100/1000 Base-T Ethernet port for remote connection to a PC.
2SD memory card slot. This slot will be used for core storage needs. Removable for sensitive purposes related to declassification as needed. Remove screws to access card.
3Power connector. 100-240V, 50-60Hz, 200 W maximum
4Fan vents.

Cleaning

Use a dry, soft cotton cloth to clean the outside of the unit. If any dirt remains, use a cloth or swab dipped in a 75% isopropyl alcohol solution. Use a swab to clean narrow spaces around controls and connectors. Do not use any liquid cleaning agents or chemicals that could damage the touchscreen, case, controls, markings or labels, or possibly infiltrate the case.

Menus

The web interface menus allow you to access the full range of the TMT4 Margin Tester features. The front panel provides access to run a Quick Scan, see Quick Scan results, and view the instrument IP address.

The navigation panel is on the left side of the Web interface Welcome screen. It allows you to access the various menus, check link status, instrument serial number, and adapter information.



Check Link

Click the Check Link button before running a scan to ensure you have a link. This will report the current configuration of the DUT for its given speed and link width.

  • No link detected: Red text will appear showing “No link”.
  • Link detected: Green text will appear.
  • If there is no adapter connected, the button will return nothing.

TMT4 serial number and adapter status

The TMT4 serial number and the connected adapter type, if any, is displayed at the bottom of the navigation panel.

Home

The Welcome screen tells you how to get started with a scan. At the bottom of the screen are buttons to access the Tektronix End User License Agreement (EULA) and Legal Notices.



You can access the Home and Logout icons from the upper right of the window from any screen. Click the Home icon to return to the Welcome page. Click the Logout icon to log out of the TMT4.



Setup

The Setup menu allows you to select Quick Scan or Custom Scan test types. Which you select determines the menu options. The following images show Quick Scan and Custom Scan examples.





Results

The Results screen shows test results. The available data depend on the test type and other parameters. See the Quick Scan and Custom Scan topics in this document for details.



Save/Recall

Enter the file name for the results you want to save. You can also add any notes. Results are saved to your PC's Downloads folder by default. You can change where files are saved by modifying your browser settings.

Recalling a results file restores the Results panel as it was when the test was run. To recall results, click the Recall button and select the .zip file in which the results were previously saved.



Utility

The Utility menu provides access to the TMT4 software (firmware) version, self test run and results, a way to export log files, and a way to set the instrument date and time.



Upgrade the instrument firmware

You can upgrade the instrument firmware as follows.

  1. Insert a USB stick with the firmware into the intrument USB port.
  2. Cycle the power.
  3. Verify that the instrument firmware was updated by checking the displayed software version in the Instrument Health panel.

Operation

Adapters

The following adapters are available for use with the TMT4 Margin Tester and your device under test. You can purchase adapters individually or together in the PRO BUNDLE set. See the TMT4 datasheet on tek.com for ordering details.



An image of each adapter is shown, followed by a setup example for each adapter type.

Figure 1. PCIe 4.0 x1 CEM Edge adapter


Figure 2. PCIe 4.0 x4 CEM Edge adapter


Figure 3. PCIe 4.0 x8 CEM Edge adapter


Figure 4. PCIe 4.0 x16 CEM Edge adapter


Figure 5. PCIe 4.0 x16 CEM Slot adapter


Figure 6. PCIe 4.0 M.2 22mm Edge adapter and integrated cable


Figure 7. PCIe 4.0 M.2 22mm Edge length extender for M.2 Edge adapter and cable (2230, 2242, 2260, 2280, 22110). This is an extender that allows you to secure your M.2 adapter to a motherboard DUT.


Figure 8. PCIe 4.0 M.2 22mm Slot adapter


Figure 9. PCIe 4.0 U.2 Edge adapter


Figure 10. PCIe 4.0 U.2 Slot adapter


Figure 11. PCIe 4.0 U.3 Edge adapter


Figure 12. PCIe 4.0 U.3 Slot adapter


Example setups

Figure 13. Quick scan setup example using a x16 CEM Edge adapter for motherboard testing. Quick scans can be run and results seen from the front panel and the web UI.


Figure 14. Custom scan setup example using a x16 CEM Slot adapter for graphics card testing. Custom scan can only be run and results seen from the web UI.


Figure 15. Setup using M.2 Edge adapter and integrated cable for motherboard testing.


Figure 16. Setup using M.2 Slot adapter for SSD testing.


DUT Tx tests

The Device Under Test (DUT) Transmitter (Tx) tests are optimized to deliver insight into the transmitter path performance of the DUT in minutes. This section provides the benefits of the test, and an introduction to eye diagrams and link training using the TMT4 Margin Tester.

The DUT Tx test provides a fast look at the eye diagrams of the link formed between the Margin Tester and the DUT. The test also displays the associated link training parameters used to open the eye. This information enables you to conduct more regular performance checks of the link and allows you to quickly identify gross errors for any lane and preset combination.

For example, if you want to quickly see the effects of a BIOS change on the health of the link, you can scan the DUT, update the BIOS, scan the DUT again, and in minutes be able to evaluate the effect those changes had on the link performance.

Eye diagrams

As part of the DUT Tx tests, eye diagrams are shown for each lane and preset combination that represent the error-free region of the link formed between the DUT and the Margin Tester.



The eyes are shown in real-time, which means it only takes seconds before results begin to display.

Link training parameters

The Margin Tester shows not only the performance of the link by displaying eye diagrams, but also displays how the Margin Tester’s receivers were adjusted to maximize the generated eye. Some eyes may need especially high levels of equalization in order to form the link, so having both pieces of information is critical to understanding performance. The Margin Tester displays a table showing the Attenuation, VGA (Gain), CTLE, and 5 DFE taps values used to maximize the eye opening. This allows you to quickly see how much equalization is needed for each displayed eye diagram. The possible range of values for each of these equalization settings is shown in the following table.

EqualizationNumber of possible settingsRange
ATT8-10.0 dB to -2.0 dB
VGA150.0 dB to +8.0 dB
CTLE32+2.0 dB to +15.0 dB
DFE Tap 1256-55.0 mV to +55.0 mV (typ1)
DFE Tap 2128-44.0 mV to +43.3 mV
DFE Tap 3128-22.0 mV to +21.7 mV
DFE Tap 4128-16.0 mV to +15.8 mV
DFE Tap 5128-11.0 mV to +10.8 mV


If an eye is wide open, but the equalization settings are pushed to their maximum, it may indicate there are some performance considerations for that given lane and preset combination.

1 DFE Tap 1 has a wide range of possible values, but will typically be within the stated range.

DUT Rx tests

The DUT receiver (Rx) test is a functional evaluation of the DUT’s receiver path.

This test determines how far the transmitted signal from the Margin Tester can be decreased, within a range of operation, before errors are returned. It allows you to evaluate functional Rx link health performance in as little as 30 seconds.

This quick test consists of a link train between the Margin Tester and DUT, where the DUT selects the presets for communication. The Margin Tester then steps down the transmitted amplitude by dropping the main cursor value by lane/preset, within an expected range of operation.



This provides a high-level evaluation of Rx performance quickly, which can help you determine if there are any problem lanes that may be worth investigating further with other equipment. If no errors are indicated, this is considered a functional pass. If errors are indicated, the main cursor value where the error occurred is displayed, and the test is considered a functional fail.

Quick Scan

The Quick Scan is the fastest scan option and can be done from the TMT4 front panel or from the Web interface.

Set up and run a Quick Scan

You can run a Quick Scan from the Web interface as follows.

  1. Click the Setup button and then set the Test Type to Quick Scan.
  2. Set the Generation (PCIe 3 or PCIe 4).
  3. Click the Run Scan button.

You can run a Quick Scan from the front panel as follows.

  1. Set the Generation (PCIe 3 or PCIe 4).
  2. Click the Run Quick Scan button on the display screen.


Results

The approximate test time for Gen 4 x16 links is 2-4 minutes. Once the test begins, the Results Test Status screen will automatically be displayed.

There are three results pages on the front panel. Each page contains a Home button, a Save button, and a Help button. The Save button will save results to a USB stick connected to the TMT4.

  • Page 1: All scanned lanes along with the Tx preset, Tx eye width, Tx eye height, Rx preset, and Rx C0
  • Page 2: Tx link training parameters
  • Page 3: Eye diagrams

The three results areas on the Results panel in the Web interface are shown in the following image.



  • For a DUT Tx test, the results show the resulting eye diagrams at the receiver of the TMT4 instrument, and the associated link training parameter values that show the equalization used at the TMT4 receivers to open the eyes.
  • For a DUT Rx test, the results table shows the preset each lane is trained to, the expected test range based on the negotiated preset, and if any errors were found.

Custom Scan

The Custom Scan allows you to force specific test parameters to do more thorough evaluations of Tx signal paths.

Use Custom Scan for deeper investigation into specific lane-preset combinations and for a more comprehensive test of all lanes and presets. The Margin Tester will flag any results that fall outside the pass-fail limits you specify.

Set up and run a Custom Scan

You must use the Web interface to set up Custom Scan parameters. Set the following as desired for your testing needs.

SettingsRange / Options
GenerationPCIe Gen 3 or Gen 4
LanesWithin the specified link width
PresetsPreset 0 - Preset 9
Clock SettingsSSC and SRIS
Pass / Fail LimitsUser specified
DUT Tx TestToggle on or off
DUT Rx TestToggle on or off. The Rx test is the same for Quick Scan and Custom Scan.

Select Run Scan to run the scan after the parameters have been set.



Custom Scan results

The approximate test time for Gen 4 x16 all lanes/presets is 25-30 minutes.

The Custom Scan results page provides a tiered results structure where data can be expanded and collapsed based on the generation tested or by the type of test in a specified generation. Both the Tx eye diagram and the link training parameter table results can be configured to view the results by lanes tested or by presets tested. This allows you to quickly view results across all charts and draw conclusions as to the performance of any given lane or preset grouping for up to 160 lane-preset combinations.





REST API Programming

You can program and control the instrument using REST API commands.

You can access the API interface and documentation through the Swagger interface. The interface provides the calls, parameters, a way to download a *.json file of all of the commands, and an interface for sending calls to the TMT4.

Access the API through the Swagger interface

  1. Enter the IP address of the instrument into a PC browser window.
  2. Add :5000/api/docs to the IP address. Example: 123.00.1.1:5000/api/docs
  3. The Swagger interface will appear in the browser.


Use API commands

You can send API commands from the Swagger interface or your terminal. You can print requests from your terminal. Send commands from the Swagger interface as follows.

  1. Select the command you need and expand the view.
  2. Click the Try It Out button.

  3. Click the blue Execute button.

  4. View the response information that appears in the Response body field.

  5. You can download the response or copy it to the clipboard, as needed, using the icons in the Response body field.

An unlocked padlock icon next to a command means you must be signed in to the instrument to use that command. Use the Login command and the Authorize button to sign in as follows.

  1. Select the Login command from the Password section and expand the view.
  2. Click the Try It Out button.
  3. Enter the instrument user name and password in the Response body field.

  4. Click the Execute button.



  5. In the Response Body section, copy the long token string (without the quotation mark).

  6. Go to the top of the screen and click the Authorize button.
  7. Paste the token string copied from the previous step into the token authentication Value field.

  8. Click the Authorize button.
  9. Check that all of the padlock icons have changed to a black locked image. This indicates that the commands are now available to use.

Example 1: Start a Custom Scan and download results

This example uses Python and shows how to use the TMT4 API to do the following.

  1. Format and send a login request.
  2. Format and send a Custom Scan request.
  3. Monitor the progress of a scan.
  4. Download and extract scan results.

Format and send a login request

First you send a login request and then you send an authentification token. An authentification token is required to use any endpoint that changes the state or accesses certain information about the Margin Tester.





Format and send a Custom Scan request

Custom scans can be configured to specify which lanes, presets, and PCIE generations to scan. You can also set the Pass/Fail limits for TX eye height and eye width.

  • A scan can be divided into multiple tests. A test is a Tx or Rx test with a given Generation (Speed) and Clock settings.
  • This example is a scan with two tests. This first test is running on Generation 3 and the second test is running on Generation 4.
  • In this example, both Tx and Rx tests will run for Generation 3 with all lanes and presets enabled for both tests, with SSC disabled. In the Generation 4, only a Tx scan is specified to run for lanes 0-3 for preset 5.




Monitor the progress of a scan

  1. Ping the Status endpoint to get the current status of the Margin Tester.
  2. View the 'teststatus' key in the return object to view the current test status.
  3. When 'teststatus' is either Aborted or Finished, scan is complete.


Download and extract Scan results

Results are returned in the form of a .zip file containing CSVs, charts, and more. You can either open the zip file and view the results as-is, or recall the zip file to the Web interface through the Save / Recall page.



Example 2: Start a Quick Scan and download results

This example uses Python and shows how to use the TMT4 API to do the following.

  1. Format and send a login request.
  2. Format and send a Quick Scan request.
  3. Monitor the progress of a scan.
  4. View and download the scan results.

Format and send a login request

First you send a login request and then you send an authentification token. An authentification token is required to use any endpoint that changes the state or accesses certain information about the Margin Tester.





Initialize Quick Scan

  • Quick Scan performs both a Tx and Rx test on all available lanes.
  • Only PCIe Generation (Speed) is user-configurable. All other test configurations (lanes, presets, pass/fail limits, etc) are selected automatically.
  • Quick Tx test lets all available lanes train to their preferred preset and reports Eye Widths, Eye Heights and Receiver Settings.
  • One and only one preset is selected per lane. Maximum eye count is 16.


Monitor Scan Progress

  1. Ping the Status endpoint to get the current status of the Margin Tester.
  2. View the 'teststatus' key in the return object to view the current test status.
  3. When 'teststatus' is either Aborted or Finished, scan is complete.


Download and Extract Scan Results

Results are returned in the form of a Zip file containing CSVs, charts, and more. You can either open the zip file and view the results as-is, or recall the zip file to the Web UI via the Save / Recall page.