axipmon
Vitis Drivers API Documentation
 All Data Structures Files Functions Variables Macros Groups Pages
xaxipmon.c File Reference

Overview

Implements the driver API for the AXI Performance Monitor device.

Provides functions to access and configure the AXI Performance Monitor.

Refer to the xaxipmon.h header file for more information about this driver.

MODIFICATION HISTORY:
Ver   Who    Date     Changes


1.00a bss 02/27/12 First release 2.00a bss 06/23/12 Updated to support v2_00a version of IP. 3.00a bss 09/03/12 Deleted XAxiPmon_SetAgent, XAxiPmon_GetAgent APIs and modified XAxiPmon_SetMetrics, XAxiPmon_GetMetrics APIs to support v2_01a version of IP. 3.01a bss 10/25/12 Added XAxiPmon_StartCounters and XAxiPmon_StopCounters APIs (CR #683799). Added XAxiPmon_StartEventLog and XAxiPmon_StopEventLog APIs (CR #683801). Added XAxiPmon_GetMetricName API (CR #683803). Modified XAxiPmon_SetMetrics and XAxiPmon_GetMetrics (CR #683746) Added XAxiPmon_EnableEventLog, XAxiPmon_DisableMetricsCounter, XAxiPmon_EnableMetricsCounter APIs to replace macros. Added XAxiPmon_SetMetricCounterCutOff, XAxiPmon_GetMetricCounterCutOff, XAxiPmon_EnableExternalTrigger and XAxiPmon_DisableExternalTrigger APIs to support new version of IP. 4.00a bss 01/17/13 To support new version of IP: Added XAxiPmon_SetLogEnableRanges, XAxiPmon_GetLogEnableRanges, XAxiPmon_EnableMetricCounterTrigger, XAxiPmon_DisableMetricCounterTrigger, XAxiPmon_EnableEventLogTrigger, XAxiPmon_DisableEventLogTrigger, XAxiPmon_SetWriteLatencyId, XAxiPmon_SetReadLatencyId, XAxiPmon_GetWriteLatencyId, XAxiPmon_GetReadLatencyId APIs and removed XAxiPmon_SetMetricCounterCutOff, XAxiPmon_GetMetricCounterCutOff, XAxiPmon_EnableExternalTrigger and XAxiPmon_DisableExternalTrigger APIs 5.00a bss 08/26/13 To support new version of IP: Modified XAxiPmon_CfgInitialize to add Mode of APM and ScaleFactor parameter. Modified Assert functions depending on Mode. Modified XAxiPmon_GetMetricCounter and XAxiPmon_GetSampledMetricCounter to include new Counters. Modified XAxiPmon_SetSampleInterval and XAxiPmon_GetSampleInterval to remove higher 32 bit value of SampleInterval since Sample Interval Register is only 32 bit. Added XAxiPmon_SetWrLatencyStart, XAxiPmon_SetWrLatencyEnd, XAxiPmon_SetRdLatencyStart XAxiPmon_SetRdLatencyEnd, XAxiPmon_GetWrLatencyStart, XAxiPmon_GetWrLatencyEnd, XAxiPmon_GetRdLatencyStart, XAxiPmon_GetRdLatencyEnd, XAxiPmon_SetWriteIdMask, XAxiPmon_SetReadIdMask, XAxiPmon_GetWriteIdMask and XAxiPmon_GetReadIdMask APIs. Renamed: XAxiPmon_SetWriteLatencyId to XAxiPmon_SetWriteId XAxiPmon_SetReadLatencyId to XAxiPmon_SetReadId XAxiPmon_GetWriteLatencyId to XAxiPmon_GetWriteId XAxiPmon_SetReadLatencyId to XAxiPmon_GetReadId. 6.2 bss 04/21/14 Updated XAxiPmon_CfgInitialize to Reset counters and FIFOs based on Modes(CR#782671). And if both profile and trace modes are present set mode as Advanced. 6.2 bss 03/02/15 Updated XAxiPmon_SetWriteId, XAxiPmon_SetReadId, XAxiPmon_GetWriteId, XAxiPmon_GetReadId XAxiPmon_SetWriteIdMask, XAxiPmon_SetReadIdMask, XAxiPmon_GetWriteIdMask, XAxiPmon_GetReadIdMask functions to support Zynq MP APM. 6.3 kvn 07/02/15 Modified code according to MISRA-C:2012 guidelines. 6.4 sk 11/10/15 Used UINTPTR instead of u32 for Baseaddress CR# 867425. Changed the prototype of XAxiPmon_CfgInitialize API. 6.7 sd 17/11/18 Fix Doxygen reported warnings 6.10 ht 06/23/23 Added support for system device-tree flow. 6.12 ht 12/01/24 Fix GCC warnings 6.15 vn 07/30/26 Fix Doxygen warnings 6.15 vn 09/08/26 Align Doxygen comments with AMD standards 6.15 vn 09/30/26 Update Doxygen comments to AMD standards

#include "xaxipmon.h"

Functions

s32 XAxiPmon_CfgInitialize (XAxiPmon *InstancePtr, XAxiPmon_Config *ConfigPtr, UINTPTR EffectiveAddr)
 Initializes a specific XAxiPmon device/instance. More...
 
s32 XAxiPmon_ResetMetricCounter (XAxiPmon *InstancePtr)
 Resets all Metric Counters and Sampled Metric Counters. More...
 
void XAxiPmon_ResetGlobalClkCounter (XAxiPmon *InstancePtr)
 Resets the Global Clock Counter of the AXI Performance Monitor. More...
 
s32 XAxiPmon_ResetFifo (XAxiPmon *InstancePtr)
 Resets the Streaming FIFO of the AXI Performance Monitor. More...
 
void XAxiPmon_SetIncrementerRange (XAxiPmon *InstancePtr, u8 IncrementerNum, u16 RangeUpper, u16 RangeLower)
 Sets ranges for the specified Incrementer. More...
 
void XAxiPmon_GetIncrementerRange (XAxiPmon *InstancePtr, u8 IncrementerNum, u16 *RangeUpper, u16 *RangeLower)
 Returns the ranges of the specified Incrementer Register. More...
 
void XAxiPmon_SetSampleInterval (XAxiPmon *InstancePtr, u32 SampleInterval)
 Sets the Sample Interval Register value. More...
 
void XAxiPmon_GetSampleInterval (XAxiPmon *InstancePtr, u32 *SampleInterval)
 Returns the contents of the Sample Interval Register. More...
 
s32 XAxiPmon_SetMetrics (XAxiPmon *InstancePtr, u8 Slot, u8 Metrics, u8 CounterNum)
 Sets metrics for the specified Counter in the Metric Selector Register. More...
 
s32 XAxiPmon_GetMetrics (XAxiPmon *InstancePtr, u8 CounterNum, u8 *Metrics, u8 *Slot)
 Returns metrics from the specified Counter in the Metric Selector Register. More...
 
void XAxiPmon_GetGlobalClkCounter (XAxiPmon *InstancePtr, u32 *CntHighValue, u32 *CntLowValue)
 Returns the contents of the Global Clock Counter Register. More...
 
u32 XAxiPmon_GetMetricCounter (XAxiPmon *InstancePtr, u32 CounterNum)
 Returns the contents of the specified Metric Counter Register. More...
 
u32 XAxiPmon_GetSampledMetricCounter (XAxiPmon *InstancePtr, u32 CounterNum)
 Returns the contents of the specified Sampled Metric Counter Register. More...
 
u32 XAxiPmon_GetIncrementer (XAxiPmon *InstancePtr, u32 IncrementerNum)
 Returns the contents of the specified Incrementer Register. More...
 
u32 XAxiPmon_GetSampledIncrementer (XAxiPmon *InstancePtr, u32 IncrementerNum)
 Returns the contents of the specified Sampled Incrementer Register. More...
 
void XAxiPmon_SetSwDataReg (XAxiPmon *InstancePtr, u32 SwData)
 Sets the Software-written Data Register value. More...
 
u32 XAxiPmon_GetSwDataReg (XAxiPmon *InstancePtr)
 Returns the contents of the Software-written Data Register. More...
 
s32 XAxiPmon_StartEventLog (XAxiPmon *InstancePtr, u32 FlagEnables)
 Starts event logging in the AXI Performance Monitor. More...
 
s32 XAxiPmon_StopEventLog (XAxiPmon *InstancePtr)
 Stops event logging in the AXI Performance Monitor. More...
 
s32 XAxiPmon_StartCounters (XAxiPmon *InstancePtr, u32 SampleInterval)
 Starts all counters in the AXI Performance Monitor. More...
 
s32 XAxiPmon_StopCounters (XAxiPmon *InstancePtr)
 Stops all counters in the AXI Performance Monitor. More...
 
void XAxiPmon_EnableMetricsCounter (XAxiPmon *InstancePtr)
 Enables Metric Counters. More...
 
void XAxiPmon_DisableMetricsCounter (XAxiPmon *InstancePtr)
 Disables the Metric Counters. More...
 
void XAxiPmon_SetLogEnableRanges (XAxiPmon *InstancePtr, u32 CounterNum, u16 RangeUpper, u16 RangeLower)
 Sets the ranges for the specified Metric Counter Log Enable Register. More...
 
void XAxiPmon_GetLogEnableRanges (XAxiPmon *InstancePtr, u32 CounterNum, u16 *RangeUpper, u16 *RangeLower)
 Returns the ranges of the specified Metric Counter Log Enable Register. More...
 
void XAxiPmon_EnableEventLog (XAxiPmon *InstancePtr)
 Enables Event Logging. More...
 
void XAxiPmon_EnableMetricCounterTrigger (XAxiPmon *InstancePtr)
 Enables external trigger for Metric Counters. More...
 
void XAxiPmon_DisableMetricCounterTrigger (XAxiPmon *InstancePtr)
 Disables external trigger for Metric Counters. More...
 
void XAxiPmon_EnableEventLogTrigger (XAxiPmon *InstancePtr)
 Enables external trigger for Event Log. More...
 
void XAxiPmon_DisableEventLogTrigger (XAxiPmon *InstancePtr)
 Disables external trigger for Event Log. More...
 
const char * XAxiPmon_GetMetricName (u8 Metrics)
 Returns the name string for a given Metric. More...
 
void XAxiPmon_SetWriteId (XAxiPmon *InstancePtr, u32 WriteId)
 Sets the Write ID in the ID register. More...
 
void XAxiPmon_SetReadId (XAxiPmon *InstancePtr, u32 ReadId)
 Sets the Read ID in the ID register. More...
 
u32 XAxiPmon_GetWriteId (XAxiPmon *InstancePtr)
 Returns the Write ID from the ID register. More...
 
u32 XAxiPmon_GetReadId (XAxiPmon *InstancePtr)
 Returns the Read ID from the ID register. More...
 
void XAxiPmon_SetWrLatencyStart (XAxiPmon *InstancePtr, u8 Param)
 Sets the write latency start point. More...
 
void XAxiPmon_SetWrLatencyEnd (XAxiPmon *InstancePtr, u8 Param)
 Sets the write latency end point. More...
 
void XAxiPmon_SetRdLatencyStart (XAxiPmon *InstancePtr, u8 Param)
 Sets the read latency start point. More...
 
void XAxiPmon_SetRdLatencyEnd (XAxiPmon *InstancePtr, u8 Param)
 Sets the read latency end point. More...
 
u8 XAxiPmon_GetWrLatencyStart (XAxiPmon *InstancePtr)
 Returns the write latency start point. More...
 
u8 XAxiPmon_GetWrLatencyEnd (XAxiPmon *InstancePtr)
 Returns the write latency end point. More...
 
u8 XAxiPmon_GetRdLatencyStart (XAxiPmon *InstancePtr)
 Returns the read latency start point. More...
 
u8 XAxiPmon_GetRdLatencyEnd (XAxiPmon *InstancePtr)
 Returns the read latency end point. More...
 
void XAxiPmon_SetWriteIdMask (XAxiPmon *InstancePtr, u32 WrMask)
 Sets the Write ID Mask in the ID Mask register. More...
 
void XAxiPmon_SetReadIdMask (XAxiPmon *InstancePtr, u32 RdMask)
 Sets the Read ID Mask in the ID Mask register. More...
 
u32 XAxiPmon_GetWriteIdMask (XAxiPmon *InstancePtr)
 Returns the Write ID Mask from the ID Mask register. More...
 
u32 XAxiPmon_GetReadIdMask (XAxiPmon *InstancePtr)
 Returns the Read ID Mask from the ID Mask register. More...