XOA Python API User Manual Logo

API User Guide

  • 1. Introduction
  • 2. Getting Started
  • 3. Script Example Library
  • 4. API Structure
  • 5. Test Resource Management
  • 6. Command Grouping
  • 7. Status Messages and Exceptions
  • 8. Glossary of Terms

API Reference Guide

  • 1. API Reference
    • 1.1. High-Level Functions
      • 1.1.1. Resource Management
      • 1.1.2. Auto-Negotiation and Link Training
        • HL ANLT Functions
        • HL Auto-Negotiation Functions
        • HL Link Training Functions
          • Modulation Control
            • lt_encoding()
          • Preset Control
            • lt_preset()
          • Coefficient Control
            • lt_coeff_inc()
            • lt_coeff_dec()
            • lt_coeff_no_eq()
          • Training Control and Status
            • lt_trained()
            • lt_status()
          • Host Tx Equalizer Control
            • txtap_get()
            • txtap_set()
            • txtap_autotune()
      • 1.1.3. CLI Integration
      • 1.1.4. Simple Header Value Editor
    • 1.2. High-Level API
    • 1.3. Low-Level API
XOA Python API User Manual
  • 1. API Reference
  • 1.1. High-Level Functions
  • 1.1.2. Auto-Negotiation and Link Training
  • HL Link Training Functions

HL Link Training Functions

The following high-level functions are for link training.

Modulation Control

async lt_encoding(port, serdes, encoding)[source]

Ask the remote port to use the encoding of the specified serdes.

Parameters:

  • port (GenericL23Port) – the port object

  • serdes (int) – the serdes index, starting from 0

  • encoding (enums.LinkTrainCoeffs) – link training encoding

Returns:

Return type:

None

Preset Control

async lt_preset(port, serdes, preset)[source]

Ask the remote port to use the preset of the specified serdes.

Parameters:

  • port (GenericL23Port) – the port object

  • serdes (int) – the serdes index, starting from 0

  • preset (enums.LinkTrainPresets) – preset index to select for the serdes, 0,1,2,3,4,

Returns:

Return type:

None

Coefficient Control

async lt_coeff_inc(port, serdes, emphasis)[source]

Ask the remote port to increase coeff of the specified serdes.

Parameters:

  • port (GenericL23Port) – the port object

  • serdes (int) – the serdes index, starting from 0

  • emphasis (enums.LinkTrainCoeffs) – the emphasis to increase

Returns:

Return type:

None

async lt_coeff_dec(port, serdes, emphasis)[source]

Ask the remote port to decrease coeff of the specified serdes.

Parameters:

  • port (GenericL23Port) – the port object

  • serdes (int) – the serdes index, starting from 0

  • emphasis (enums.LinkTrainCoeffs) – the emphasis to decrease

Returns:

Return type:

None

async lt_coeff_no_eq(port, serdes, emphasis)[source]

Ask the remote port to set the coeff to NO_EQ on the specified serdes.

Parameters:

  • port (GenericL23Port) – the port object

  • serdes (int) – the serdes index, starting from 0

  • emphasis (enums.LinkTrainCoeffs) – the emphasis to set to NO_EQ

Returns:

Return type:

None

Training Control and Status

async lt_trained(port, serdes)[source]

Tell the remote port that the current serdes is trained.

Parameters:

  • port (GenericL23Port) – the port object

  • serdes (int) – the serdes index, starting from 0

Returns:

Return type:

None

async lt_status(port, serdes)[source]

Changed in version 2.5.

Show the link training status.

Parameters:

  • port (GenericL23Port) – the port object

  • serdes (int) – the serdes index, starting from 0

Returns:

LT status of the serdes

Return type:

Dict[str, Any]

Host Tx Equalizer Control

async txtap_get(port, serdes)[source]

Get the tap value of the local TX tap.

Parameters:

  • port (GenericL23Port) – the port object

  • serdes (int) – the serdes index, starting from 0

Returns:

tap values of the serdes

Return type:

Dict[str, int]

async txtap_set(port, serdes, pre3, pre2, pre, main, post1)[source]

Set the tap value of the local TX tap.

Parameters:

  • port (GenericL23Port) – the port object

  • serdes (int) – the serdes index, starting from 0

  • pre3 (int) – pre3 value

  • pre2 (int) – pre2 value

  • pre (int) – pre value

  • main (int) – main value

  • post1 (int) – post1 value

Returns:

Return type:

None

async txtap_autotune(port, serdes)[source]

Auto tune the tap value of the local TX tap.

Parameters:

  • port (GenericL23Port) – the port object

  • serdes (int) – the serdes index, starting from 0

Returns:

Return type:

None

Previous Next

© Copyright 2025, Teledyne LeCroy Xena.