Low CBF CNIC Software

The CNIC Firmware Documentation may be useful to cross-reference (e.g. it contains information on SPS SPEAD packet structure).

Low CBF CNIC Software Documentation:

• CNIC Control Software
  • Purpose
  • Documentation
  • Project Avatar (Repository Icon)
• Installation
  • End User
  • Developer
• Usage
  • Debug Console & Register Viewer
  • Transmit a PCAP(NG) File
  • Receive a PCAP(NG) File
  • Duplex Mode
  • Monitor Status
  • change_port
  • eth_interface_rate
• Limitations / Warnings
• Road Map

CNIC API

• ska_low_cbf_sw_cnic
  • change_port module
    • change_port()
    • main()
  • cnic_fpga module
    • CnicFpga
      • CnicFpga.__init__()
      • CnicFpga.begin_transmit()
      • CnicFpga.configure_from_yaml()
      • CnicFpga.configure_next_delay_polynomials()
      • CnicFpga.configure_vd()
      • CnicFpga.enable_vd
      • CnicFpga.finished_receive
      • CnicFpga.finished_transmit
      • CnicFpga.prepare_transmit()
      • CnicFpga.ready_to_transmit
      • CnicFpga.receive_pcap()
      • CnicFpga.reset()
      • CnicFpga.stop_receive()
      • CnicFpga.transmit_pcap()
    • LOAD_SLEEP_TIME
    • RX_SLEEP_TIME
  • eth_interface_rate module
    • main()
    • screen_clear()
  • hbm_packet_controller module
    • HbmPacketController
      • HbmPacketController.__init__()
      • HbmPacketController.configure_rx()
      • HbmPacketController.configure_tx()
      • HbmPacketController.dump_pcap()
      • HbmPacketController.duplex
      • HbmPacketController.flush()
      • HbmPacketController.last_dumped_pcap
      • HbmPacketController.load_pcap()
      • HbmPacketController.loaded_pcap
      • HbmPacketController.loaded_pcap_packets
      • HbmPacketController.rx_packet_count
      • HbmPacketController.start_rx()
      • HbmPacketController.start_tx()
      • HbmPacketController.tx_packet_count
      • HbmPacketController.tx_packets_to_mac
    • METADATA_SIZE
  • monitor module
    • RX_STATUS_PARAMS
    • TX_STATUS_PARAMS
    • create_layout()
    • display_status_forever()
    • generate_100g_table()
    • generate_ptp_table()
    • generate_rx_table()
    • generate_tx_table()
    • update_layout()
    • update_static_info()
  • no_attributes module
    • NoAttributes
  • pcap module
    • count_packets_in_pcap()
    • eth_from_sll()
    • get_reader()
    • get_writer()
    • packet_size_from_pcap()
  • ptp module
    • Ptp
      • Ptp.command()
      • Ptp.mac_address
      • Ptp.startup()
      • Ptp.user_mac_address
    • PtpCommand
      • PtpCommand.DISABLE
      • PtpCommand.ENABLE
      • PtpCommand.PPS_MODE
      • PtpCommand.PTP_MODE
      • PtpCommand.RELOAD_PROFILE
      • PtpCommand.SERVO_RESUME
      • PtpCommand.SERVO_STOP
  • ptp_scheduler module
    • PtpScheduler
      • PtpScheduler.reset()
      • PtpScheduler.rx_start_time
      • PtpScheduler.rx_stop_time
      • PtpScheduler.time
      • PtpScheduler.tx_start_time
      • PtpScheduler.tx_stop_time
      • PtpScheduler.unix_timestamp
    • TIMESTAMP_BITS
    • combine_ptp_registers()
    • datetime_from_str()
    • ptp_ts_from_float()
    • split_datetime()
    • time_str_from_registers()
    • unix_ts_from_ptp()
  • virtual_digitiser module
    • CONFIG_ROW_WORDS
    • MAX_BURST_ENABLE_BIT
    • SPS_PACKET_PERIOD
    • SpeadVersion
      • SpeadVersion.v2
      • SpeadVersion.v3
    • VDChannelConfig
      • VDChannelConfig.__init__()
      • VDChannelConfig.as_registers()
      • VDChannelConfig.beam
      • VDChannelConfig.frequency
      • VDChannelConfig.from_registers()
      • VDChannelConfig.scan
      • VDChannelConfig.station
      • VDChannelConfig.subarray
      • VDChannelConfig.substation
    • VirtualDigitiser
      • VirtualDigitiser.configuration
      • VirtualDigitiser.configure_channels()
      • VirtualDigitiser.configure_pulsar_mode()
      • VirtualDigitiser.configure_time()
      • VirtualDigitiser.configure_time_v2()
      • VirtualDigitiser.configured_channels
      • VirtualDigitiser.epoch
      • VirtualDigitiser.get_channel_config()
      • VirtualDigitiser.last_used_datagen_buffer
      • VirtualDigitiser.max_bursts
      • VirtualDigitiser.max_bursts_enabled
      • VirtualDigitiser.packet_count
      • VirtualDigitiser.session_packets
      • VirtualDigitiser.set_max_bursts()
      • VirtualDigitiser.set_time_between_packets_and_bursts()
      • VirtualDigitiser.sps_packet_version
      • VirtualDigitiser.sps_packets
      • VirtualDigitiser.timestamp
  • vd_datagen module
    • CONFIG_BUF_WORDS
    • DELAY_POLY_COEFFS
    • DataGenerator
      • DataGenerator.__init__()
      • DataGenerator.buf0_valid
      • DataGenerator.buf1_valid
      • DataGenerator.configuration
      • DataGenerator.configuration0
      • DataGenerator.configuration1
      • DataGenerator.configure()
      • DataGenerator.configure_from_yaml()
      • DataGenerator.configure_next_delay_polynomials()
      • DataGenerator.read_time()
      • DataGenerator.set_delay_polynomial()
    • Source
      • Source.__init__()
      • Source.as_registers()
      • Source.channel_frequency
      • Source.delay_polynomial
      • Source.fine_frequency
      • Source.from_registers()
      • Source.scale
      • Source.seed
      • Source.tone
    • null_polynomial()
    • pad_source_list()

ITango notes

• Notes on ITango Usage
  • Device Setup
  • Calling Methods
  • A More Realistic Scenario

Indices and tables

• Index

• Module Index

• Search Page