layer1_adv module

The layer1_adv module offers high-level functions for advanced Layer 1 configurations and operations.

PCSL Skew

get_rx_pcsl_skew(port, lane_indices)

Get per-physical lane Rx relative skew measured in bits and the corresponding PCSL of the specified physical PCS lanes.

Rx PCS Status and Flags

get_cdr_lol_status(port, serdes_indices)	Get the per-SerDes current and latched CDR LOL status.
get_port_loa_status(port)	Get the per-port current and latched Loss of Alignment (LOA) status.
get_pcsl_loa_status(port, pcsl_indices)	Get the per-PCSL current and latched Loss of Alignment (LOA) status.
get_hi_ber_status(port)	Get the per-port current and latched HI-BER status.
set_hi_ser_alarm(port, on)	Set the HI-SER alarm on or off on the port.
get_hi_ser_status(port)	Get the per-port current and latched HI-SER status.
get_deg_ser_status(port)	Get the per-port current and latched Degraded SER status.
set_deg_ser_thresholds(port, ...)	Configure signaling Degraded SER thresholds of the port.
get_deg_ser_thresholds(port)	Get signaling Degraded SER thresholds of the port.
get_lf_status(port)	Get the per-port current and latched Local Fault status.
get_rf_status(port)	Get the per-port current and latched Remote Fault status.
get_lf_rf_status(port)	Get the per-port current and latched Local Fault and Remote Fault status.
get_link_down_status(port)	Get the per-port current and latched Link Down status.

Rx PCS Error Events

get_rx_errors_since_clear(port)	Get the per-port number of Rx error events since the last counter clear, including LOA, 256b/257 ITBs, 64b/66b erroneous codewords, link down, local fault, and remote fault events.
clear_rx_err_cnt(port)	Clear Rx Layer 1 advanced statistics error counters on the port.

Tx PCS Error Injection

inject_errcwd_once(port)	Inject a 64b/66b codeword error from the port immediately when called.
inject_itb_once(port)	Inject an invalid 256b/257b transcode block (ITB) from the port immediately when called.
inject_hi_ser_once(port)	Inject a High SER (HI-SER) event from the port immediately when called.
inject_am_error_once(port, pcsl, cm_nibbles, ...)	Inject an Alignment Marker (AM) error with the AM corruption parameters on the specified PCS lane immediately when called.
inject_loa_once(port, pcsl)	Inject a Loss of Alignment (LOA) error on the specified PCS lane immediately when called.

Tx PCS Error Events

get_tx_errors_since_clear(port)	Get the per-port number of Tx error events since the last counter clear, including HI-SER, 256b/257 ITBs, and 64b/66b erroneous codewords.
get_tx_pcsl_errors_since_clear(port, ...)	Get the per-PCSL number of injected (Tx) AM errors since the last counter clear.
clear_tx_err_cnt(port)	Clear Tx Layer 1 advanced statistics error counters on the port.

PMA Tx/Rx Frequency and PPM

get_tx_freq(port)	Get the current, minimum, and maximum Tx frequency (Hz) and frequency offset (ppm) of the specified port.
get_rx_freq(port[, serdes_indices])	Get the current, minimum, and maximum Rx frequency (Hz) and frequency offset (ppm) of the specified Serdes.

PMA Tx/Rx Frequency (Hz)

If you only want to get frequency parameters, you can use the following functions.

get_tx_freq_all(port)	Get the current, minimum, and maximum Tx frequency in Hz of the specified port.
get_tx_freq_curr(port)	Get the current Tx frequency in Hz of the specified port.
get_tx_freq_min(port)	Get the minimum Tx frequency in Hz of the specified port.
get_tx_freq_max(port)	Get the maximum Tx frequency in Hz of the specified port.
get_rx_freq_all(port[, serdes_indices])	Get the current, minimum, and maximum Rx frequencies in Hz of the specified Serdes.
get_rx_freq_curr(port[, serdes_indices])	Get the current Rx frequency in Hz of the specified port.
get_rx_freq_min(port[, serdes_indices])	Get the minimum Rx frequency in Hz since last query of the specified Serdes.
get_rx_freq_max(port[, serdes_indices])	Get the maximum Rx frequency in Hz since last query of the specified Serdes.

PMA Tx/Rx Frequency Offset (PPM)

If you only want to get frequency offset parameters, you can use the following functions.

get_tx_ppm_all(port)	Get the current, minimum, and maximum Tx PPM of the specified port.
get_tx_ppm_curr(port)	Get the current Tx PPM of the specified port.
get_tx_ppm_min(port)	Get the minimum Tx PPM of the specified port.
get_tx_ppm_max(port)	Get the maximum Tx PPM of the specified port.
get_rx_ppm_all(port[, serdes_indices])	Get the current, minimum, and maximum Rx PPM of the specified Serdes.
get_rx_ppm_curr(port[, serdes_indices])	Get the current Rx PPM of the specified Serdes.
get_rx_ppm_min(port[, serdes_indices])	Get the minimum Rx PPM since last query of the specified Serdes.
get_rx_ppm_max(port[, serdes_indices])	Get the maximum Rx PPM since last query of the specified Serdes.

PMA Tx/Rx Data Rate (bps)

get_tx_datarate_all(port)	Get the current, minimum, and maximum Tx datarate in bps of the specified port.
get_tx_datarate_curr(port)	Get the current Tx datarate in bps of the specified port.
get_tx_datarate_min(port)	Get the minimum Tx datarate in bps since last query.
get_tx_datarate_max(port)	Get the maximum Tx datarate in bps since last query.
get_rx_datarate_all(port[, serdes_indices])	Get the current, minimum, and maximum Rx datarates in bps of the specified Serdes.
get_rx_datarate_curr(port[, serdes_indices])	Get the current Rx datarate in bps of the specified port.
get_rx_datarate_min(port[, serdes_indices])	Get the minimum Rx datarate in bps since last query.
get_rx_datarate_max(port[, serdes_indices])	Get the maximum Rx datarate in bps since last query.

Deprecated Functions

get_cdr_lol(port, serdes_indices)	get_cdr_lol() is deprecated and will be removed in a future release.
get_rx_lane_skew(port, lane_indices)	get_rx_lane_skew() is deprecated and will be removed in a future release.
get_hi_ber(port)	get_hi_ber() is deprecated and will be removed in a future release.
get_hi_ser(port)	get_hi_ser() is deprecated and will be removed in a future release.
get_deg_ser(port)	get_deg_ser() is deprecated and will be removed in a future release.
set_cw_err(port)	set_cw_err() is deprecated and will be removed in a future release.
set_itb(port)	set_itb() is deprecated and will be removed in a future release.
get_cw_err_since_last(port)	get_cw_err_since_last() is deprecated and will be removed in a future release.
get_itb_since_last(port)	get_itb_since_last() is deprecated and will be removed in a future release.
get_total_loa_since_last(port)	get_total_loa_since_last() is deprecated and will be removed in a future release.
get_link_down_since_last(port)	get_link_down_since_last() is deprecated and will be removed in a future release.
get_local_fault_since_last(port)	get_local_fault_since_last() is deprecated and will be removed in a future release.
get_remote_fault_since_last(port)	get_remote_fault_since_last() is deprecated and will be removed in a future release.

Module Contents

The Advanced Layer 1 functions

async get_tx_freq_curr(port)

Get the current Tx frequency in Hz of the specified port.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

The current Tx frequency in Hz.

Return type:

int

async get_tx_freq_min(port)

Get the minimum Tx frequency in Hz of the specified port.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

The minimum Tx frequency in Hz.

Return type:

int

async get_tx_freq_max(port)

Get the maximum Tx frequency in Hz of the specified port.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

The maximum Tx frequency in Hz.

Return type:

int

async get_tx_freq_all(port)

Get the current, minimum, and maximum Tx frequency in Hz of the specified port.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

The current, minimum, and maximum Tx frequency in Hz.

Return type:

TxFreq

async get_tx_ppm_curr(port)

Get the current Tx PPM of the specified port.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

The current Tx PPM.

Return type:

int

async get_tx_ppm_min(port)

Get the minimum Tx PPM of the specified port.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

The minimum Tx PPM.

Return type:

int

async get_tx_ppm_max(port)

Get the maximum Tx PPM of the specified port.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

The maximum Tx PPM.

Return type:

int

async get_tx_ppm_all(port)

Get the current, minimum, and maximum Tx PPM of the specified port.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

The current, minimum, and maximum Tx PPM.

Return type:

TxPpm

async get_tx_freq(port)

Get the current, minimum, and maximum Tx frequency (Hz) and frequency offset (ppm) of the specified port.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

Tx frequency current, minimum, and maximum, and frequency offset (ppm) current, minimum, and maximum.

Return type:

TxFreqPpm

async get_rx_freq_curr(port, serdes_indices=[0])

Get the current Rx frequency in Hz of the specified port.

Parameters:

• port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

• serdes_indices (List[int]) – The indices of the Serdes.

Returns:

The current Rx frequency in Hz of the specified Serdes.

Return type:

List[int]

async get_rx_freq_min(port, serdes_indices=[0])

Get the minimum Rx frequency in Hz since last query of the specified Serdes.

Parameters:

• port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

• serdes_indices (List[int]) – The indices of the Serdes.

Returns:

The minimum Rx frequency in Hz since last query of the specified Serdes.

Return type:

List[int]

async get_rx_freq_max(port, serdes_indices=[0])

Get the maximum Rx frequency in Hz since last query of the specified Serdes.

Parameters:

• port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

• serdes_indices (List[int]) – The indices of the Serdes.

Returns:

The maximum Rx frequency in Hz since last query of the specified Serdes.

Return type:

List[int]

async get_rx_freq_all(port, serdes_indices=[0])

Get the current, minimum, and maximum Rx frequencies in Hz of the specified Serdes.

The minimum and maximum values are since last query.

Parameters:

• port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

• serdes_indices (List[int]) – The indices of the Serdes.

Returns:

The current, minimum, and maximum Rx frequencies in Hz of the specified Serdes.

Return type:

List[RxFreq]

async get_rx_ppm_curr(port, serdes_indices=[0])

Get the current Rx PPM of the specified Serdes.

Parameters:

• port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

• serdes_indices (List[int]) – The indices of the Serdes.

Returns:

The current Rx PPM of the specified Serdes.

Return type:

List[int]

async get_rx_ppm_min(port, serdes_indices=[0])

Get the minimum Rx PPM since last query of the specified Serdes.

Parameters:

• port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

• serdes_indices (List[int]) – The indices of the Serdes.

Returns:

The minimum Rx PPM since last query of the specified Serdes.

Return type:

List[int]

async get_rx_ppm_max(port, serdes_indices=[0])

Get the maximum Rx PPM since last query of the specified Serdes.

Parameters:

• port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

• serdes_indices (List[int]) – The indices of the Serdes.

Returns:

The maximum Rx PPM since last query of the specified Serdes.

Return type:

List[int]

async get_rx_ppm_all(port, serdes_indices=[0])

Get the current, minimum, and maximum Rx PPM of the specified Serdes.

The minimum and maximum values are since last query.

Parameters:

• port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

• serdes_indices (List[int]) – The indices of the Serdes.

Returns:

The current, minimum, and maximum Rx PPM of the specified Serdes.

Return type:

List[RxPpm]

async get_rx_freq(port, serdes_indices=[0])

Get the current, minimum, and maximum Rx frequency (Hz) and frequency offset (ppm) of the specified Serdes.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

Rx frequency current, minimum, and maximum, and frequency offset (ppm) current, minimum, and maximum of the specified Serdes.

Return type:

List[RxFreqPpm]

async get_tx_datarate_curr(port)

Get the current Tx datarate in bps of the specified port.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

The current Tx datarate in bps.

Return type:

int

async get_tx_datarate_min(port)

Get the minimum Tx datarate in bps since last query.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

The minimum Tx datarate in bps since last query.

Return type:

int

async get_tx_datarate_max(port)

Get the maximum Tx datarate in bps since last query.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

The maximum Tx datarate in bps since last query.

Return type:

int

async get_tx_datarate_all(port)

Get the current, minimum, and maximum Tx datarate in bps of the specified port.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

The current, minimum, and maximum Tx datarate in bps.

Return type:

TxDatarate

async get_rx_datarate_curr(port, serdes_indices=[0])

Get the current Rx datarate in bps of the specified port.

Parameters:

• port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

• serdes_indices (List[int]) – The indices of the Serdes.

Returns:

The current Rx datarate in bps. If multiple Serdes indices are provided, a list of datarates is returned.

Return type:

int or List[int]

async get_rx_datarate_min(port, serdes_indices=[0])

Get the minimum Rx datarate in bps since last query.

Parameters:

• port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

• serdes_indices (List[int]) – The indices of the Serdes.

Returns:

The minimum Rx datarate in bps since last query. If multiple Serdes indices are provided, a list of minimum datarates is returned.

Return type:

int or List[int]

async get_rx_datarate_max(port, serdes_indices=[0])

Get the maximum Rx datarate in bps since last query.

Parameters:

• port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

• serdes_indices (List[int]) – The indices of the Serdes.

Returns:

The maximum Rx datarate in bps since last query. If multiple Serdes indices are provided, a list of maximum datarates is returned.

Return type:

int or List[int]

async get_rx_datarate_all(port, serdes_indices=[0])

Get the current, minimum, and maximum Rx datarates in bps of the specified Serdes.

The minimum and maximum values are since last query.

Parameters:

• port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

• serdes_indices (List[int]) – The indices of the Serdes.

Returns:

The current, minimum, and maximum Rx datarates in bps of the specified Serdes.

Return type:

List[RxDatarate]

async set_hi_ser_alarm(port, on)

Set the HI-SER alarm on or off on the port.

Parameters:

• port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

• on – Set to True to enable the HI-SER alarm, or False to disable the HI-SER alarm.

async set_deg_ser_thresholds(port, activate_threshold, deactivate_threshold, interval)

Configure signaling Degraded SER thresholds of the port.

If more than activate_threshold number of RS-FEC symbol errors are detected in a contiguous block of interval RS-FEC codewords, Degraded SER is signalled on the port.

If less than deactivate_threshold number of RS-FEC symbol errors are detected in a contiguous block of interval RS-FEC codewords, Degraded SER is no longer signalled on the port.

interval must be an even number and a multiple of the number of PCS flows:

• 100G: 2 (one flow, but must be even)

• 200G/400G: 2 (two flows)

• 800G/1.6T: 4 (four flows)

An uncorrectable codeword is counted as 16 erroneous RS-FEC symbols.

Parameters:

• port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

• activate_threshold (int) – The activate threshold.

• deactivate_threshold (int) – The deactivate threshold.

• interval (int) – The interval.

async get_deg_ser_thresholds(port)

Get signaling Degraded SER thresholds of the port.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

A DegSerThresholds namedtuple containing activate threshold, deactivate threshold, and interval.

Return type:

DegSerThresholds

async get_cdr_lol_status(port, serdes_indices)

Get the per-SerDes current and latched CDR LOL status.

True means error condition is present, while False means error condition is not present.

Parameters:

• port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

• serdes_indices (List[int]) – The indices of the Serdes.

Returns:

A list of CdrLolStatus namedtuples containing current and latched CDR LOL status for each Serdes.

Return type:

List[CdrLolStatus]

async get_rx_pcsl_skew(port, lane_indices)

Get per-physical lane Rx relative skew measured in bits and the corresponding PCSL of the specified physical PCS lanes.

Parameters:

• port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

• lane_indices (List[int]) – The indices of the PCS lanes.

Returns:

PCSL and relative skew of the specified physical PCS lanes measured in bits

Return type:

List[PcslSkew]

async get_hi_ber_status(port)

Get the per-port current and latched HI-BER status.

True means error condition is present, while False means error condition is not present.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

A HiBerStatus namedtuple containing current and latched HI-BER status.

Return type:

HiBerStatus

async get_hi_ser_status(port)

Get the per-port current and latched HI-SER status.

True means error condition is present, while False means error condition is not present.

HI-SER is signalled if 5560 RS-FEC symbol errors are detected in contiguous block of 8192 non-overlapping RS-FEC codewords.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

A HiSerStatus namedtuple containing alarm state, current and latched HI-SER status.

Return type:

HiSerStatus

async get_deg_ser_status(port)

Get the per-port current and latched Degraded SER status.

True means error condition is present, while False means error condition is not present.

The thresholds for signaling Degraded SER is programmable using set_deg_ser_thresholds().

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

A DegSerStatus namedtuple containing current and latched Degraded SER status.

Return type:

DegSerStatus

async get_lf_status(port)

Get the per-port current and latched Local Fault status.

True means error condition is present, while False means error condition is not present.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

A LocalFaultStatus namedtuple containing current and latched Local Fault status.

Return type:

LocalFaultStatus

async get_rf_status(port)

Get the per-port current and latched Remote Fault status.

True means error condition is present, while False means error condition is not present.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

A RemoteFaultStatus namedtuple containing current and latched Remote Fault status.

Return type:

RemoteFaultStatus

async get_lf_rf_status(port)

Get the per-port current and latched Local Fault and Remote Fault status.

True means error condition is present, while False means error condition is not present.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

A tuple containing current and latched Local Fault and Remote Fault status.

Return type:

Tuple[LocalFaultStatus, RemoteFaultStatus]

async get_link_down_status(port)

Get the per-port current and latched Link Down status.

True means error condition is present, while False means error condition is not present.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

A LinkDownStatus namedtuple containing current and latched Link Down status.

Return type:

LinkDownStatus

async get_port_loa_status(port)

Get the per-port current and latched Loss of Alignment (LOA) status.

True means error condition is present, while False means error condition is not present.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

A tuple containing the current and latched LOA status of the port.

Return type:

LoaStatus

Added in version 1.9.0: Requires Xena Release 106.1 or later.

async get_pcsl_loa_status(port, pcsl_indices)

Get the per-PCSL current and latched Loss of Alignment (LOA) status.

True means error condition is present, while False means error condition is not present.

Parameters:

• port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

• pcsl_indices (List[int]) – The indices of the PCS lanes.

Returns:

A list of tuples containing the current and latched LOA status of the specified PCSLs.

Return type:

List[LoaStatus]

Added in version 1.9.0: Requires Xena Release 106.1 or later.

async get_rx_errors_since_clear(port)

Get the per-port number of Rx error events since the last counter clear, including LOA, 256b/257 ITBs, 64b/66b erroneous codewords, link down, local fault, and remote fault events.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

A RxPcsErrors namedtuple containing the received number of LOA, 256b/257 ITBs, 64b/66b erroneous codewords, link down, local fault, and remote fault events, since the last counter clear per port.

Return type:

RxPcsErrors

async get_tx_errors_since_clear(port)

Get the per-port number of Tx error events since the last counter clear, including HI-SER, 256b/257 ITBs, and 64b/66b erroneous codewords.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

A TxPcsErrors namedtuple containing the injected number of HI-SER, 256b/257 ITBs, 64b/66b erroneous codewords, since the last counter clear per port.

Return type:

TxPcsErrors

async get_tx_pcsl_errors_since_clear(port, pcsl_indices)

Get the per-PCSL number of injected (Tx) AM errors since the last counter clear.

Parameters:

• port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

• pcsl_indices (List[int]) – The indices of the PCS lanes.

Returns:

A list of TxPcslErrors namedtuples containing the injected number of AM errors since the last counter clear per PCSL.

Return type:

List[TxPcslErrors]

Added in version 1.9.0: Requires Xena Release 106.1 or later.

async inject_errcwd_once(port)

Inject a 64b/66b codeword error from the port immediately when called.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

async inject_itb_once(port)

Inject an invalid 256b/257b transcode block (ITB) from the port immediately when called.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

async inject_am_error_once(port, pcsl, cm_nibbles, bad_count)

Inject an Alignment Marker (AM) error with the AM corruption parameters on the specified PCS lane immediately when called.

This function first sets the AM corruption parameters on the specified PCS lane. It selects which CM nibbles in the AM to be corrupted and how many successive corrupted AMs should be sent on a specified PCSL.

To successfully inject an LOA error on a PCSL, the following conditions must be met:

• When RS-FEC is enabled, at least 4 CM nibbles should be errored.

• When RS-FEC is disabled, a single CM nibble corruption is enough to trigger an LOA.

(Only one bit in a CM nibble will be corrupted.)

To trigger an LOA error on the PCSL, bad_count should be:

• At least 4, for 40G (no FEC or FC-FEC), 50G ETC (no FEC or FC-FEC), 50GAUI-2 (RS-FEC KP), 100G (no FEC)

• At least 5, for 50G ETC (RS-FEC KR), 50G IEEE (RS-FEC KP), 100G (RS-FEC KR, RS-FEC KP, RS-FEC KP-Int), 200G (RS-FEC KP-Int), 400G (RS-FEC KP-Int), 800G (RS-FEC KP-Int), 1.6T (RS-FEC KP-Int)

Parameters:

• port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

• pcsl (int) – The index of the PCS lane.

• cm_nibbles (List[int]) – The indices of the CM nibbles in the AM to be corrupted.

• bad_count (int) – The number of successive corrupted AMs to be sent.

Added in version 1.9.0: Requires Xena Release 106.1 or later.

async inject_loa_once(port, pcsl)

Inject a Loss of Alignment (LOA) error on the specified PCS lane immediately when called.

This function uses the inject_am_error_once() function to inject an AM error with predefined AM corruption parameters that can trigger an LOA on the specified PCSL.

• Number of CM nibbles to be corrupted: 4, randomly selected from the 6 CM nibbles in the AM.

• Number of successive corrupted AMs to be sent: 5, which is sufficient to trigger LOA for all supported speeds and FEC configurations.

Parameters:

• port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

• pcsl (int) – The index of the PCS lane.

Added in version 1.9.0: Requires Xena Release 106.1 or later.

async inject_hi_ser_once(port)

Inject a High SER (HI-SER) event from the port immediately when called.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

async clear_rx_err_cnt(port)

Clear Rx Layer 1 advanced statistics error counters on the port.

async clear_tx_err_cnt(port)

Clear Tx Layer 1 advanced statistics error counters on the port.

async get_cw_err_since_last(port)

get_cw_err_since_last() is deprecated and will be removed in a future release. Please use get_rx_errors_since_clear() instead.

Deprecated since version 1.8.

Get the number of 64b/66b erroneous codewords received since last counter clear.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

The number of 64b/66b erroneous codewords received since last counter clear.

Return type:

int

async get_itb_since_last(port)

get_itb_since_last() is deprecated and will be removed in a future release. Please use get_rx_errors_since_clear() instead.

Deprecated since version 1.8.

Get the number of 256b/257 ITBs received since last counter clear.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

The number of 256b/257 ITBs received since last counter clear.

Return type:

int

async get_total_loa_since_last(port)

get_total_loa_since_last() is deprecated and will be removed in a future release. Please use get_rx_errors_since_clear() instead.

Deprecated since version 1.8.

Get the number of LOA events received since last counter clear.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

The number of LOA events received since last counter clear.

Return type:

int

async get_link_down_since_last(port)

get_link_down_since_last() is deprecated and will be removed in a future release. Please use get_rx_errors_since_clear() instead.

Deprecated since version 1.8.

Get the number of link down events received since last counter clear.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

The number of link down events received since last counter clear.

Return type:

int

async get_local_fault_since_last(port)

get_local_fault_since_last() is deprecated and will be removed in a future release. Please use get_rx_errors_since_clear() instead.

Deprecated since version 1.8.

Get the number of local fault events received since last counter clear.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

The number of local fault events received since last counter clear.

Return type:

int

async get_remote_fault_since_last(port)

get_remote_fault_since_last() is deprecated and will be removed in a future release. Please use get_rx_errors_since_clear() instead.

Deprecated since version 1.8.

Get the number of remote fault events received since last counter clear.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

The number of remote fault events received since last counter clear.

Return type:

int

async get_cdr_lol(port, serdes_indices)

get_cdr_lol() is deprecated and will be removed in a future release. Please use get_cdr_lol_status() instead.

Deprecated since version 1.8.

Get the current and latched CDR LOL status of the specified Serdes.

True means error condition is present, while False means error condition is not present.

Parameters:

• port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

• serdes_indices (List[int]) – The indices of the Serdes.

Returns:

A list of CdrLolStatus namedtuples containing the current and latched CDR LOL status for each specified Serdes.

Return type:

List[CdrLolStatus]

async get_rx_lane_skew(port, lane_indices)

get_rx_lane_skew() is deprecated and will be removed in a future release. Please use get_rx_pcsl_skew() instead.

Deprecated since version 1.8.

Get Rx relative skew measured in bits of the specified PCS lanes.

Parameters:

• port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

• lane_indices (List[int]) – The indices of the PCS lanes.

Returns:

A list of PcslSkew namedtuples containing the current and latched RX lane skew for each specified PCS lane.

Return type:

List[PcslSkew]

async get_hi_ber(port)

get_hi_ber() is deprecated and will be removed in a future release. Please use get_hi_ber_status() instead.

Deprecated since version 1.8.

Get the current and latched HI-BER status of the specified port.

True means error condition is present, while False means error condition is not present.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

A tuple containing the current and latched HI-BER status of the port.

Return type:

Tuple[bool, bool]

async get_hi_ser(port)

get_hi_ser() is deprecated and will be removed in a future release. Please use get_hi_ser_status() instead.

Deprecated since version 1.8.

Get the current and latched HI-SER status of the specified port. True means error condition is present, while False means error condition is not present. HI-SER is signalled if 5560 RS-FEC symbol errors are detected in contiguous block of 8192 non-overlapping RS-FEC codewords.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

A tuple containing the current and latched HI-SER status of the port.

Return type:

Tuple[bool, bool, bool]

async get_deg_ser(port)

get_deg_ser() is deprecated and will be removed in a future release. Please use get_deg_ser_status() instead.

Deprecated since version 1.8.

Get the current and latched DEG-SER status of the specified port. True means error condition is present, while False means error condition is not present.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.

Returns:

A tuple containing the current and latched DEG-SER status of the port.

Return type:

Tuple[bool, bool]

async set_cw_err(port)

set_cw_err() is deprecated and will be removed in a future release. Please use inject_errcwd_once() instead.

Deprecated since version 1.8.

Inject a 64b/66b codeword error from the port immediately when called.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort) – The port instance.

async set_itb(port)

set_itb() is deprecated and will be removed in a future release. Please use inject_itb_once() instead.

Deprecated since version 1.8.

Inject an invalid 256b/257b transcode block (ITB) from the port immediately when called.

Parameters:

port (Union[Z800FreyaPort, Z1600EdunPort]) – The port instance.