chipscopy.NOC

class chipscopy.api.noc.noc.NocPerfmon(noc_tcf_node)

NocPerfMon is the top level API for accessing NocPerfmon. It wraps the old client noc_perfmon_core_client.NoCPerfMonCoreClient(CoreClient) class and simplifies the use model by hiding tcf and node lower level details.

configure_monitors(monitors, sampling_intervals, traffic_class, sample_count, done=None, extended_monitor_config=None)

This method configures and enables the performance monitoring on the parameter set of elements. Upon completion of the configuration, data will start to be emitted asynchronously from ChipScope Server back to the requesting client. The client must implement an Event Listener to properly receive the data.

Each element will be configured to monitor both read and write traffic independently. QOS classes of a particular direction of traffic will be applied to the monitor responsible for that type of traffic read|write.

Parameters

• monitors (List[str]) – List of NoC elements to enable to stream performance data. For Example - ['NOC_NMU128_X0Y0', 'DDRMC_X0Y0', ...]

• sampling_intervals (dict) – The requested period_ms for sampling. The client must ensure this is a supported period. NOTE: this structure needs to contain information for NPI, NoC and each DDRMC controller clk NPI, NoC are sampling periods (ms) (floats) and DDRMC controller clk domain is a tap (int) – for reference see the XSA class in the utilities to understand how the ctrl clk works.

• traffic_class (PerfMonTrafficQOSClass) – The traffic classes bitwise-or’d that shall be monitored.

• sample_count (int) – OPTIONAL The number of intervals or windows to capture. 1 - will configure supporting hardware for single shot. 2-int_max will configure all hardware for continuous mode and will stop streaming data when the requested number of samples have been sent to the client. -1 is the default and means the streaming will run indefinitely.

• filter_spec (dict[int]) –

  Will move! hold off on using this for now. OPTIONAL Dictionary defining the AXI filtering to use. If this parameter is not supplied then no filtering will occur and all transactions will be counted by the samplers. No validation is done on these fields, they will be masked and shifted, as they are received. For convenience any fields not specified will retain the default value of zero, except max fields (AxSIZE, AxQoS, AxLEN) which have the largest supported values). The supported fields include

  AxPROT[3], AxBURST[2], AxSIZE_MIN[3], AxLEN_MIN[8], AxID[16] TDEST[10] (AXIS only), DST_ID[12], AxLOCK[1], AxQoS_MIN[4], AxCACHE[4], AxSIZE_MAX[3], AxQoS_MAX[4], AxLEN_MAX[8]

• done (Optional[DoneHWCommand]) – Optional command callback that will be invoked when the response is received.

• extended_monitor_config (Optional[dict]) – Optional argument that is a dictionary of additional monitor configuration. The keys must correspond to the monitors. “tslide” is the only supported key at this time. Tslide will change the meaning of the latency counters for the specified monitor (read and write channel). The meaning of the counter values can be represented by 2^(tslide) clocks. Default tslide is 0, corresponding to 1 clock per count. In practice this is a tradeoff between precision and range. When the counters overflow error flags will be set in the associated metrics. If overflow is observed, the tslide should be increased to avoid that condition. Otherwise there will be a “clipping” in the data. Note, only NMU and NSU’s support the tslide extended configuraiton option. DDRMC does not, and will ignore the value, if supplied by the client.

Returns

No data is returned from this call.

discover_noc_elements(done=None)

WARNING - This function is deprecated and will be removed in the future

This method dynamically scans the NoC to determine the active nodes in the programmed design. If no nodes are programmed or the NPI domain is inaccessible this will return an empty list.

This list will serve as the set from which elements may be chosen for runtime performance analysis.

Unrouted, disabled NoC elements cannot be configured for measurement. It may be assumed their counters would always produce zero count values.

Parameters

done (Optional[DoneHWCommand]) – Optional command callback that will be invoked when the response is received.

Return type

List[str]

Returns

Returns a list of active NMU, NSU/DDRMC_NOC, and NPS elements. Unrouted, disabled elements are not returned and cannot be monitored.

get_clk_info(done=None)

DEPRECATED will remove in 2022.1

Reports NPI and NoC clock information from the running design. These are parameters set by the designer in Vivado.

Parameters

done (Optional[DoneHWCommand]) – Optional command callback that will be invoked when the response is received.

Return type

dict

Returns

A dictionary with two top level keys NoC and NPI whose values are dictionaries that detail the freq_mhz, frequency in MHz (float) and the period_ms, period in milliseconds (float).

get_supported_sampling_periods(ref_clk_feq_mhz=33.3333, pl_alt_ref_clk_freq_mhz=33.3333, ddrmc_freq_mhz={'ddrmc_main_0': 800.0}, done=None)

Get the supported sampling periods (ms) for various clock domains based on input clocks and design parameters. This function queries the PLLs of the device to determine actual clock speeds of locked PLLs.

Parameters

• done (Optional[DoneHWCommand]) – Optional command callback that will be invoked when the response is received.

• ddrmc_freq_mhz (dict[str,float]) – dictionary of DDRMC instance names as the keys and the value is the MC clock in MHz float.

• ref_clk_feq_mhz (float) – ref_clk input frequency in MHz, value can be attained from .csa or .hwh files. Default is 33.333MHz

• pl_alt_ref_clk_freq_mhz (float) – pl_alt_ref_clk input frequency in MHz, value can be attained from .csa or .hwh files. Default is 33.333MHz

Return type

Dict[str, List[float]]

Returns

Dictionary with two top level keys NoC, NPI, and memory subsystem components whose values are lists of supported sampling periods measured in milliseconds (float).

initialize(done=None)

This method collects the clocking information for client use later in the configuration of this service. It also refreshes the client’s view of specific properties for the root node ONLY.

This call must be invoked before clocking information is requested from the device

Parameters

done (Optional[DoneHWCommand]) – Optional command callback that will be invoked when the response is received.

Returns

No data is returned directly from this method.