tpm_test_firmware

Overview

This is the class which contains methods for monitoring and control of FPGA firmware for SKA-Low TPM. These methods are the basis for all TPM versions.

Note

Inheritance means TPM 1.6 and higher can have additional or different methods if overloaded.

Python Class & Methods Index

Hardware functions for the TPM 1.2 hardware.

This is a transcript of the corresponding class from the pyaavs library, with code style modified for SKA coding conventions. It depends heavily on the pyfabil low level software and specific hardware module plugins.

class pyaavs.plugins.tpm.tpm_test_firmware.TpmTestFirmware(board: Any, **kwargs: Any)

FirmwareBlock tests class.

check_ddr_initialisation() → bool

Check whether DDR has initialised.

check_ddr_user_reset_counter(show_result=True) → int

Return value of DDR user reset counter - increments each falling edge of the DDR generated user logic reset.

check_ddr_voltage() → None

Check if DDR voltage regulator is enabled, if not enable it. TPM 1.2 only

check_pps_status() → bool

Check PPS detected and error free

clean_up() → bool

Perform cleanup.

Returns:

Success

clear_ddr_user_reset_counter() → None

Reset value of DDR reset counter

clear_lmc_data_request() → None

Stop transmission of all LMC data.

clear_pps_status() → None

Clear PPS errors

download_beamforming_weights(weights: list[float], antenna: int) → None

Apply beamforming weights.

Parameters:

• weights – Weights array

• antenna – Antenna ID

initialise() → bool

Initialise TpmTestFirmware.

Returns:

success status

initialise_ddr() → None

Initialise DDR.

initialise_firmware() → None

Initialise firmware components.

Raises:

BoardError – cannot configure JESD core

load_plugin() → None

Load required plugin.

send_beam_data() → None

Send beam data from the TPM.

send_channelised_data(number_of_samples: int = 128, first_channel: int = 0, last_channel: int = 511) → None

Send channelized data from the TPM.

Parameters:

• number_of_samples – contiguous time samples sent per channel

• first_channel – First channel transmitted

• last_channel – Last channel transmitted + 1 (python range convention)

send_channelised_data_continuous(channel_id: int, number_of_samples: int = 128) → None

Continuously send channelised data from a single channel.

Parameters:

• channel_id – Channel ID

• number_of_samples – contiguous time samples sent per channel

send_channelised_data_narrowband(band_frequency: int, round_bits: int, number_of_samples: int = 128) → None

Continuously send channelised data from a single channel in narrowband mode.

Parameters:

• band_frequency – central frequency (in Hz) of narrowband

• round_bits – number of bits rounded after filter

• number_of_samples – samples per lmc packet

send_raw_data() → None

Send raw data from the TPM.

send_raw_data_synchronised() → None

Send raw data from the TPM.

start_ddr_initialisation() → None

Start DDR initialisation.

status_check() → Any

Perform status check.

Returns:

Status

stop_channelised_data() → None

Stop sending channelised data.

stop_channelised_data_continuous() → None

Stop transmission of continuous channel data.

stop_channelised_data_narrowband() → None

Stop transmission of narrowband channel data.

stop_integrated_beam_data() → None

Stop receiving integrated beam data from the board.

stop_integrated_channel_data() → None

Stop receiving integrated beam data from the board.

stop_integrated_data() → None

Stop transmission of integrated data.