7e9c762d45
This patch updates the doxygen for the drivers axicdma,axidma, axipcie,axietherent,axipmon to include .h files in the listof files provided in the index.html file. Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>
1790 lines
90 KiB
HTML
1790 lines
90 KiB
HTML
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>
|
|
Xilinx Driver axipmon v6_1: xaxipmon.c File Reference
|
|
</title>
|
|
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
|
|
</head>
|
|
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
|
|
<hl>Software Drivers</hl>
|
|
<hr class="whs1">
|
|
|
|
<!-- Generated by Doxygen 1.6.1 -->
|
|
<div class="navigation" id="top">
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>File Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>xaxipmon.c File Reference</h1><code>#include "<a class="el" href="xaxipmon_8h.html">xaxipmon.h</a>"</code><br/>
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td colspan="2"><h2>Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#abf0216ba0f677f910916e2d796fe40e9">XAxiPmon_CfgInitialize</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr, <a class="el" href="struct_x_axi_pmon___config.html">XAxiPmon_Config</a> *ConfigPtr, u32 EffectiveAddr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#a039bdb9c223cf5b3421317284ed8ade7">XAxiPmon_ResetMetricCounter</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#a25191e9280ab4a1dcffae7afd08ae599">XAxiPmon_ResetGlobalClkCounter</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#a60d4e9d7a369ae79adc3ec28fe666693">XAxiPmon_ResetFifo</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#ad07bb2139c9b16d6f46f49b02b0200ae">XAxiPmon_SetIncrementerRange</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr, u8 IncrementerNum, u16 RangeUpper, u16 RangeLower)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#a9dbb1046b25b47bc8e59e68f0f5039d8">XAxiPmon_GetIncrementerRange</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr, u8 IncrementerNum, u16 *RangeUpper, u16 *RangeLower)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#af3c20b8c69cc5ba64b78f8bae9eb34d8">XAxiPmon_SetSampleInterval</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr, u32 SampleInterval)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#aaa5f655100b693586e08eed5aa01ecf9">XAxiPmon_GetSampleInterval</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr, u32 *SampleInterval)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#aa98d4d9d91e035e48dd9365a8367ee85">XAxiPmon_SetMetrics</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr, u8 Slot, u8 Metrics, u8 CounterNum)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#a43f1db274cae6a030eca83c2cb738c4c">XAxiPmon_GetMetrics</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr, u8 CounterNum, u8 *Metrics, u8 *Slot)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#a833edad9f6bdc75777eca3247940931f">XAxiPmon_GetGlobalClkCounter</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr, u32 *CntHighValue, u32 *CntLowValue)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#a5450238f0ff52df5a447c26199e9dd4d">XAxiPmon_GetMetricCounter</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr, u32 CounterNum)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#a0e28b087aa82e6744dbfc7c5a6da6303">XAxiPmon_GetSampledMetricCounter</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr, u32 CounterNum)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#ae2541fcba5770808bfce1bf006e62a11">XAxiPmon_GetIncrementer</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr, u32 IncrementerNum)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#a1dfca23c8c1305ce240bf3ca6f69d8e4">XAxiPmon_GetSampledIncrementer</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr, u32 IncrementerNum)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#a0de2a5e1665cf6c5e58e12d5e337058b">XAxiPmon_SetSwDataReg</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr, u32 SwData)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#abc734c192a6eb5cf8ae1d76322a84d2e">XAxiPmon_GetSwDataReg</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#acaad86173961979553f8e28836b6e200">XAxiPmon_StartEventLog</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr, u32 FlagEnables)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#a63fddaba107d3d5575528cdc4d1ab897">XAxiPmon_StopEventLog</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#ad3905c1fa83ac4dd128eaba075d48bfa">XAxiPmon_StartCounters</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr, u32 SampleInterval)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#a265251978a8ad69d28d8c9f91ef85a7f">XAxiPmon_StopCounters</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#a12595840082105ce722b8b36d910443a">XAxiPmon_EnableMetricsCounter</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#a339b500e3f165daf5b7b8f943eee0437">XAxiPmon_DisableMetricsCounter</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#a25951731ad41378f658e67a9f13c8f65">XAxiPmon_SetLogEnableRanges</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr, u32 CounterNum, u16 RangeUpper, u16 RangeLower)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#a4dea38a6a1a6f00e9a62e92b9fafc3c2">XAxiPmon_GetLogEnableRanges</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr, u32 CounterNum, u16 *RangeUpper, u16 *RangeLower)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#a66a4533d4fa95ed53bd99c6112f27537">XAxiPmon_EnableEventLog</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#abb60d4a3d4bb6085fe90717879ebba8c">XAxiPmon_EnableMetricCounterTrigger</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#aa9254b523e9bd235a399b25bd357884e">XAxiPmon_DisableMetricCounterTrigger</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#af2e621c00a8df721ca64ae370648d07a">XAxiPmon_EnableEventLogTrigger</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#a2baaab02251ef05f8702a5cf208a1a31">XAxiPmon_DisableEventLogTrigger</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#a7ce289f787f90052dd0fbdd7532f94d6">XAxiPmon_GetMetricName</a> (u8 Metrics)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#a0711d038045449d98561e5ad99cddda9">XAxiPmon_SetWriteId</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr, u16 WriteId)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#a1bf405f18f2c0eebd9df80d1dcd0cdc9">XAxiPmon_SetReadId</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr, u16 ReadId)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">u16 </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#aff74b9c26f16d9ad001a00284d83c4f2">XAxiPmon_GetWriteId</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">u16 </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#aed2905916cf1e2aba59d1d7a764a678d">XAxiPmon_GetReadId</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#ada26dab07f2fece5d9f2bbaa2b663f06">XAxiPmon_SetWrLatencyStart</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr, u8 Param)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#a1f146b7a32bcb5b00ffeae5b66fd49bd">XAxiPmon_SetWrLatencyEnd</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr, u8 Param)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#a89b245a99d7e28e5f580ea5598e9b9ee">XAxiPmon_SetRdLatencyStart</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr, u8 Param)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#a46ab2d475ae5c53bfefa0988de38c768">XAxiPmon_SetRdLatencyEnd</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr, u8 Param)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">u8 </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#a5d7d29017bfc83bfe141657c924788cd">XAxiPmon_GetWrLatencyStart</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">u8 </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#a81175e1827d1ae0b95742638f19f0347">XAxiPmon_GetWrLatencyEnd</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">u8 </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#ad3fc8333fb0a3e594a77da7483d7261b">XAxiPmon_GetRdLatencyStart</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">u8 </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#ab07171f0bdc3e88155dd354889d269e4">XAxiPmon_GetRdLatencyEnd</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#a845d79723559fb4e369970087fe2b4ed">XAxiPmon_SetWriteIdMask</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr, u16 WrMask)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#a9517533e152162cee61a2d26dc3ebcaa">XAxiPmon_SetReadIdMask</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr, u16 RdMask)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">u16 </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#a24aaaf528546bad6f72b1e6efcff83c4">XAxiPmon_GetWriteIdMask</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">u16 </td><td class="memItemRight" valign="bottom"><a class="el" href="xaxipmon_8c.html#aa70513262d47c8f2f9d2477345a7b990">XAxiPmon_GetReadIdMask</a> (<a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> *InstancePtr)</td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>This file contains the driver API functions that can be used to access the AXI Performance Monitor device.</p>
|
|
<p>Refer to the <a class="el" href="xaxipmon_8h.html">xaxipmon.h</a> header file for more information about this driver.</p>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None.</dd></dl>
|
|
<pre></pre><pre> MODIFICATION HISTORY:</pre><pre> 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.
|
|
</pre> <hr/><h2>Function Documentation</h2>
|
|
<a class="anchor" id="abf0216ba0f677f910916e2d796fe40e9"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_CfgInitialize" ref="abf0216ba0f677f910916e2d796fe40e9" args="(XAxiPmon *InstancePtr, XAxiPmon_Config *ConfigPtr, u32 EffectiveAddr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XAxiPmon_CfgInitialize </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon___config.html">XAxiPmon_Config</a> * </td>
|
|
<td class="paramname"> <em>ConfigPtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u32 </td>
|
|
<td class="paramname"> <em>EffectiveAddr</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function initializes a specific <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> device/instance. This function must be called prior to using the AXI Performance Monitor device.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>ConfigPtr</em> </td><td>points to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> device configuration structure. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>EffectiveAddr</em> </td><td>is the device base address in the virtual memory address space. If the address translation is not used then the physical address is passed. Unexpected errors may occur if the address mapping is changed after this function is invoked.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
|
|
<li>XST_SUCCESS if successful.</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>The user needs to first call the <a class="el" href="xaxipmon_8h.html#ae10f5ff0f5441c99d7c54a1a3e5f6c0e">XAxiPmon_LookupConfig()</a> API which returns the Configuration structure pointer which is passed as a parameter to the <a class="el" href="xaxipmon_8c.html#abf0216ba0f677f910916e2d796fe40e9">XAxiPmon_CfgInitialize()</a> API. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2baaab02251ef05f8702a5cf208a1a31"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_DisableEventLogTrigger" ref="a2baaab02251ef05f8702a5cf208a1a31" args="(XAxiPmon *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XAxiPmon_DisableEventLogTrigger </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function disables the External trigger pulse used to start Event Log on external trigger pulse for a Slot.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa9254b523e9bd235a399b25bd357884e"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_DisableMetricCounterTrigger" ref="aa9254b523e9bd235a399b25bd357884e" args="(XAxiPmon *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XAxiPmon_DisableMetricCounterTrigger </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function disables the External trigger pulse used to start Metric Counters on external trigger pulse for a Slot.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a339b500e3f165daf5b7b8f943eee0437"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_DisableMetricsCounter" ref="a339b500e3f165daf5b7b8f943eee0437" args="(XAxiPmon *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XAxiPmon_DisableMetricsCounter </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function disables the Metric Counters.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a66a4533d4fa95ed53bd99c6112f27537"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_EnableEventLog" ref="a66a4533d4fa95ed53bd99c6112f27537" args="(XAxiPmon *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XAxiPmon_EnableEventLog </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function enables Event Logging.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af2e621c00a8df721ca64ae370648d07a"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_EnableEventLogTrigger" ref="af2e621c00a8df721ca64ae370648d07a" args="(XAxiPmon *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XAxiPmon_EnableEventLogTrigger </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function enables External trigger pulse for Event Log so that Event Logging can be started on external trigger pulse for a Slot.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="abb60d4a3d4bb6085fe90717879ebba8c"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_EnableMetricCounterTrigger" ref="abb60d4a3d4bb6085fe90717879ebba8c" args="(XAxiPmon *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XAxiPmon_EnableMetricCounterTrigger </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function enables External trigger pulse so that Metric Counters can be started on external trigger pulse for a Slot.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a12595840082105ce722b8b36d910443a"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_EnableMetricsCounter" ref="a12595840082105ce722b8b36d910443a" args="(XAxiPmon *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XAxiPmon_EnableMetricsCounter </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function enables Metric Counters.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a833edad9f6bdc75777eca3247940931f"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_GetGlobalClkCounter" ref="a833edad9f6bdc75777eca3247940931f" args="(XAxiPmon *InstancePtr, u32 *CntHighValue, u32 *CntLowValue)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XAxiPmon_GetGlobalClkCounter </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u32 * </td>
|
|
<td class="paramname"> <em>CntHighValue</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u32 * </td>
|
|
<td class="paramname"> <em>CntLowValue</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function returns the contents of the Global Clock Counter Register.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>CntHighValue</em> </td><td>is the user space pointer with which upper 32 bits of Global Clock Counter has to be filled </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>CntLowValue</em> </td><td>is the user space pointer with which lower 32 bits of Global Clock Counter has to be filled</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae2541fcba5770808bfce1bf006e62a11"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_GetIncrementer" ref="ae2541fcba5770808bfce1bf006e62a11" args="(XAxiPmon *InstancePtr, u32 IncrementerNum)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">u32 XAxiPmon_GetIncrementer </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u32 </td>
|
|
<td class="paramname"> <em>IncrementerNum</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function returns the contents of the Incrementer Register.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>IncrementerNum</em> </td><td>is the number of the Incrementer register to read.Use the XAPM_INCREMENTER_* defines for the Incrementer number.The valid values are 0 (XAPM_INCREMENTER_0) to 9 (XAPM_INCREMENTER_9). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>IncrementerNum</em> </td><td>is the number of the specified Incrementer register </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>RegValue is content of specified Metric Incrementer register.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9dbb1046b25b47bc8e59e68f0f5039d8"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_GetIncrementerRange" ref="a9dbb1046b25b47bc8e59e68f0f5039d8" args="(XAxiPmon *InstancePtr, u8 IncrementerNum, u16 *RangeUpper, u16 *RangeLower)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XAxiPmon_GetIncrementerRange </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u8 </td>
|
|
<td class="paramname"> <em>IncrementerNum</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u16 * </td>
|
|
<td class="paramname"> <em>RangeUpper</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u16 * </td>
|
|
<td class="paramname"> <em>RangeLower</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function returns the Ranges of Incrementers Registers.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>IncrementerNum</em> </td><td>specifies the Incrementer for which Ranges need to be returned. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>RangeUpper</em> </td><td>specifies the user reference variable which returns the Upper Range Value of the specified Incrementer. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>RangeLower</em> </td><td>specifies the user reference variable which returns the Lower Range Value of the specified Incrementer.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4dea38a6a1a6f00e9a62e92b9fafc3c2"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_GetLogEnableRanges" ref="a4dea38a6a1a6f00e9a62e92b9fafc3c2" args="(XAxiPmon *InstancePtr, u32 CounterNum, u16 *RangeUpper, u16 *RangeLower)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XAxiPmon_GetLogEnableRanges </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u32 </td>
|
|
<td class="paramname"> <em>CounterNum</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u16 * </td>
|
|
<td class="paramname"> <em>RangeUpper</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u16 * </td>
|
|
<td class="paramname"> <em>RangeLower</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function returns the Ranges of specified Metric Counter Log Enable Register.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>CounterNum</em> </td><td>is the Metric Counter number for which Ranges are to be returned.Use the XAPM_METRIC_COUNTER* defines for the counter number in <a class="el" href="xaxipmon_8h.html">xaxipmon.h</a>. The valid values are 0 (XAPM_METRIC_COUNTER_0) to 9 (XAPM_METRIC_COUNTER_9).</td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>RangeUpper</em> </td><td>specifies the user reference variable which returns the Upper Range Value of the specified Metric Counter Log Enable Register. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>RangeLower</em> </td><td>specifies the user reference variable which returns the Lower Range Value of the specified Metric Counter Log Enable Register.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5450238f0ff52df5a447c26199e9dd4d"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_GetMetricCounter" ref="a5450238f0ff52df5a447c26199e9dd4d" args="(XAxiPmon *InstancePtr, u32 CounterNum)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">u32 XAxiPmon_GetMetricCounter </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u32 </td>
|
|
<td class="paramname"> <em>CounterNum</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function returns the contents of the Metric Counter Register.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>CounterNum</em> </td><td>is the number of the Metric Counter to be read. Use the XAPM_METRIC_COUNTER* defines for the counter number in <a class="el" href="xaxipmon_8h.html">xaxipmon.h</a>. The valid values are 0 (XAPM_METRIC_COUNTER_0) to 47(XAPM_METRIC_COUNTER_47). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>RegValue is the content of specified Metric Counter.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7ce289f787f90052dd0fbdd7532f94d6"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_GetMetricName" ref="a7ce289f787f90052dd0fbdd7532f94d6" args="(u8 Metrics)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const char* XAxiPmon_GetMetricName </td>
|
|
<td>(</td>
|
|
<td class="paramtype">u8 </td>
|
|
<td class="paramname"> <em>Metrics</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function returns a name for a given Metric.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>Metrics</em> </td><td>is one of the Metric Sets. User has to use XAPM_METRIC_SET_* macros in <a class="el" href="xaxipmon_8h.html">xaxipmon.h</a> for this parameter</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>const char *</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a43f1db274cae6a030eca83c2cb738c4c"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_GetMetrics" ref="a43f1db274cae6a030eca83c2cb738c4c" args="(XAxiPmon *InstancePtr, u8 CounterNum, u8 *Metrics, u8 *Slot)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XAxiPmon_GetMetrics </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u8 </td>
|
|
<td class="paramname"> <em>CounterNum</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u8 * </td>
|
|
<td class="paramname"> <em>Metrics</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u8 * </td>
|
|
<td class="paramname"> <em>Slot</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function returns Metrics in the specified Counter from the corresponding Metric Selector Register.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>CounterNum</em> </td><td>is the Counter Number. The valid values are 0 to 9. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Metrics</em> </td><td>is a reference parameter from application where metrics of specified counter is filled. Slot is a reference parameter in which slot Id of specified counter is filled </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>XST_SUCCESS if Success XST_FAILURE if Failure</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab07171f0bdc3e88155dd354889d269e4"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_GetRdLatencyEnd" ref="ab07171f0bdc3e88155dd354889d269e4" args="(XAxiPmon *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">u8 XAxiPmon_GetRdLatencyEnd </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function returns Read Latency End point.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns 0 - XAPM_LATENCY_LASTRD or 1 - XAPM_LATENCY_FIRSTRD.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad3fc8333fb0a3e594a77da7483d7261b"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_GetRdLatencyStart" ref="ad3fc8333fb0a3e594a77da7483d7261b" args="(XAxiPmon *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">u8 XAxiPmon_GetRdLatencyStart </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function returns read Latency Start point.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns 0 - XAPM_LATENCY_ADDR_ISSUE or 1 - XAPM_LATENCY_ADDR_ACCEPT</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aed2905916cf1e2aba59d1d7a764a678d"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_GetReadId" ref="aed2905916cf1e2aba59d1d7a764a678d" args="(XAxiPmon *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">u16 XAxiPmon_GetReadId </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function returns Read ID in ID register.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>ReadId is the required Read ID in ID register.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa70513262d47c8f2f9d2477345a7b990"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_GetReadIdMask" ref="aa70513262d47c8f2f9d2477345a7b990" args="(XAxiPmon *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">u16 XAxiPmon_GetReadIdMask </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function returns Read ID Mask in ID Mask register.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>RdMask is the required Read ID Mask in ID Mask register.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1dfca23c8c1305ce240bf3ca6f69d8e4"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_GetSampledIncrementer" ref="a1dfca23c8c1305ce240bf3ca6f69d8e4" args="(XAxiPmon *InstancePtr, u32 IncrementerNum)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">u32 XAxiPmon_GetSampledIncrementer </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u32 </td>
|
|
<td class="paramname"> <em>IncrementerNum</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function returns the contents of the Sampled Incrementer Register.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>IncrementerNum</em> </td><td>is the number of the Sampled Incrementer register to read.Use the XAPM_INCREMENTER_* defines for the Incrementer number.The valid values are 0 (XAPM_INCREMENTER_0) to 9 (XAPM_INCREMENTER_9). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>IncrementerNum</em> </td><td>is the number of the specified Sampled Incrementer register </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>RegValue is content of specified Sampled Incrementer register.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0e28b087aa82e6744dbfc7c5a6da6303"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_GetSampledMetricCounter" ref="a0e28b087aa82e6744dbfc7c5a6da6303" args="(XAxiPmon *InstancePtr, u32 CounterNum)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">u32 XAxiPmon_GetSampledMetricCounter </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u32 </td>
|
|
<td class="paramname"> <em>CounterNum</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function returns the contents of the Sampled Metric Counter Register.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>CounterNum</em> </td><td>is the number of the Sampled Metric Counter to read. Use the XAPM_METRIC_COUNTER* defines for the counter number in <a class="el" href="xaxipmon_8h.html">xaxipmon.h</a>. The valid values are 0 (XAPM_METRIC_COUNTER_0) to 47(XAPM_METRIC_COUNTER_47).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>RegValue is the content of specified Sampled Metric Counter.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aaa5f655100b693586e08eed5aa01ecf9"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_GetSampleInterval" ref="aaa5f655100b693586e08eed5aa01ecf9" args="(XAxiPmon *InstancePtr, u32 *SampleInterval)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XAxiPmon_GetSampleInterval </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u32 * </td>
|
|
<td class="paramname"> <em>SampleInterval</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function returns the contents of Sample Interval Register</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>SampleInterval</em> </td><td>is a pointer where the Sample Interval Counter value is returned.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="abc734c192a6eb5cf8ae1d76322a84d2e"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_GetSwDataReg" ref="abc734c192a6eb5cf8ae1d76322a84d2e" args="(XAxiPmon *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">u32 XAxiPmon_GetSwDataReg </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function returns contents of Software-written Data Register.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>SwData.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aff74b9c26f16d9ad001a00284d83c4f2"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_GetWriteId" ref="aff74b9c26f16d9ad001a00284d83c4f2" args="(XAxiPmon *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">u16 XAxiPmon_GetWriteId </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function returns Write ID in ID register.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>WriteId is the required Write ID in ID register.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a24aaaf528546bad6f72b1e6efcff83c4"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_GetWriteIdMask" ref="a24aaaf528546bad6f72b1e6efcff83c4" args="(XAxiPmon *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">u16 XAxiPmon_GetWriteIdMask </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function returns Write ID Mask in ID Mask register.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>WrMask is the required Write ID Mask in ID Mask register.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a81175e1827d1ae0b95742638f19f0347"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_GetWrLatencyEnd" ref="a81175e1827d1ae0b95742638f19f0347" args="(XAxiPmon *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">u8 XAxiPmon_GetWrLatencyEnd </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function returns Write Latency End point.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns 0 - XAPM_LATENCY_LASTWR or 1 - XAPM_LATENCY_FIRSTWR.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5d7d29017bfc83bfe141657c924788cd"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_GetWrLatencyStart" ref="a5d7d29017bfc83bfe141657c924788cd" args="(XAxiPmon *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">u8 XAxiPmon_GetWrLatencyStart </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function returns Write Latency Start point.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns 0 - XAPM_LATENCY_ADDR_ISSUE or 1 - XAPM_LATENCY_ADDR_ACCEPT</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a60d4e9d7a369ae79adc3ec28fe666693"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_ResetFifo" ref="a60d4e9d7a369ae79adc3ec28fe666693" args="(XAxiPmon *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XAxiPmon_ResetFifo </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function resets Streaming FIFO of AXI Performance Monitor</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>XST_SUCCESS</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a25191e9280ab4a1dcffae7afd08ae599"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_ResetGlobalClkCounter" ref="a25191e9280ab4a1dcffae7afd08ae599" args="(XAxiPmon *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XAxiPmon_ResetGlobalClkCounter </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function resets Global Clock Counter of AXI Performance Monitor</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a039bdb9c223cf5b3421317284ed8ade7"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_ResetMetricCounter" ref="a039bdb9c223cf5b3421317284ed8ade7" args="(XAxiPmon *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XAxiPmon_ResetMetricCounter </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function resets all Metric Counters and Sampled Metric Counters of AXI Performance Monitor.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>XST_SUCCESS</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad07bb2139c9b16d6f46f49b02b0200ae"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_SetIncrementerRange" ref="ad07bb2139c9b16d6f46f49b02b0200ae" args="(XAxiPmon *InstancePtr, u8 IncrementerNum, u16 RangeUpper, u16 RangeLower)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XAxiPmon_SetIncrementerRange </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u8 </td>
|
|
<td class="paramname"> <em>IncrementerNum</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u16 </td>
|
|
<td class="paramname"> <em>RangeUpper</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u16 </td>
|
|
<td class="paramname"> <em>RangeLower</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function sets Ranges for Incrementers depending on parameters passed.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>IncrementerNum</em> </td><td>specifies the Incrementer for which Ranges need to be set </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>RangeUpper</em> </td><td>specifies the Upper limit in 32 bit Register </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>RangeLower</em> </td><td>specifies the Lower limit in 32 bit Register</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a25951731ad41378f658e67a9f13c8f65"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_SetLogEnableRanges" ref="a25951731ad41378f658e67a9f13c8f65" args="(XAxiPmon *InstancePtr, u32 CounterNum, u16 RangeUpper, u16 RangeLower)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XAxiPmon_SetLogEnableRanges </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u32 </td>
|
|
<td class="paramname"> <em>CounterNum</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u16 </td>
|
|
<td class="paramname"> <em>RangeUpper</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u16 </td>
|
|
<td class="paramname"> <em>RangeLower</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function sets the Upper and Lower Ranges for specified Metric Counter Log Enable Register.Event Logging starts when corresponding Metric Counter value falls in between these ranges</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>CounterNum</em> </td><td>is the Metric Counter number for which Ranges are to be assigned.Use the XAPM_METRIC_COUNTER* defines for the counter number in <a class="el" href="xaxipmon_8h.html">xaxipmon.h</a>. The valid values are 0 (XAPM_METRIC_COUNTER_0) to 9 (XAPM_METRIC_COUNTER_9). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>RangeUpper</em> </td><td>specifies the Upper limit in 32 bit Register </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>RangeLower</em> </td><td>specifies the Lower limit in 32 bit Register </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa98d4d9d91e035e48dd9365a8367ee85"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_SetMetrics" ref="aa98d4d9d91e035e48dd9365a8367ee85" args="(XAxiPmon *InstancePtr, u8 Slot, u8 Metrics, u8 CounterNum)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XAxiPmon_SetMetrics </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u8 </td>
|
|
<td class="paramname"> <em>Slot</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u8 </td>
|
|
<td class="paramname"> <em>Metrics</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u8 </td>
|
|
<td class="paramname"> <em>CounterNum</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function sets Metrics for specified Counter in the corresponding Metric Selector Register.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Slot</em> </td><td>is the slot ID for which specified counter has to be connected. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Metrics</em> </td><td>is one of the Metric Sets. User has to use XAPM_METRIC_SET_* macros in <a class="el" href="xaxipmon_8h.html">xaxipmon.h</a> for this parameter </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>CounterNum</em> </td><td>is the Counter Number. The valid values are 0 to 9.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>XST_SUCCESS if Success XST_FAILURE if Failure</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a46ab2d475ae5c53bfefa0988de38c768"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_SetRdLatencyEnd" ref="a46ab2d475ae5c53bfefa0988de38c768" args="(XAxiPmon *InstancePtr, u8 Param)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XAxiPmon_SetRdLatencyEnd </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u8 </td>
|
|
<td class="paramname"> <em>Param</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function sets Latency End point to calculate read latency.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Param</em> </td><td>is XAPM_LATENCY_LASTRD or XAPM_LATENCY_FIRSTRD in <a class="el" href="xaxipmon_8h.html">xaxipmon.h</a>.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>Param can be 0 - XAPM_LATENCY_LASTRD or 1 - XAPM_LATENCY_FIRSTRD </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a89b245a99d7e28e5f580ea5598e9b9ee"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_SetRdLatencyStart" ref="a89b245a99d7e28e5f580ea5598e9b9ee" args="(XAxiPmon *InstancePtr, u8 Param)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XAxiPmon_SetRdLatencyStart </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u8 </td>
|
|
<td class="paramname"> <em>Param</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function sets Latency Start point to calculate read latency.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Param</em> </td><td>is XAPM_LATENCY_ADDR_ISSUE or XAPM_LATENCY_ADDR_ACCEPT in <a class="el" href="xaxipmon_8h.html">xaxipmon.h</a>.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>Param can be 0 - XAPM_LATENCY_ADDR_ISSUE or 1 - XAPM_LATENCY_ADDR_ACCEPT </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1bf405f18f2c0eebd9df80d1dcd0cdc9"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_SetReadId" ref="a1bf405f18f2c0eebd9df80d1dcd0cdc9" args="(XAxiPmon *InstancePtr, u16 ReadId)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XAxiPmon_SetReadId </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u16 </td>
|
|
<td class="paramname"> <em>ReadId</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function sets Read ID in ID register.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>ReadId</em> </td><td>is the Read ID to be written in ID register.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9517533e152162cee61a2d26dc3ebcaa"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_SetReadIdMask" ref="a9517533e152162cee61a2d26dc3ebcaa" args="(XAxiPmon *InstancePtr, u16 RdMask)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XAxiPmon_SetReadIdMask </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u16 </td>
|
|
<td class="paramname"> <em>RdMask</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function sets Read ID Mask in ID Mask register.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>RdMask</em> </td><td>is the Read ID mask to be written in ID Mask register.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af3c20b8c69cc5ba64b78f8bae9eb34d8"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_SetSampleInterval" ref="af3c20b8c69cc5ba64b78f8bae9eb34d8" args="(XAxiPmon *InstancePtr, u32 SampleInterval)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XAxiPmon_SetSampleInterval </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u32 </td>
|
|
<td class="paramname"> <em>SampleInterval</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function sets the Sample Interval Register</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>SampleInterval</em> </td><td>is the Sample Interval value to be set</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0de2a5e1665cf6c5e58e12d5e337058b"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_SetSwDataReg" ref="a0de2a5e1665cf6c5e58e12d5e337058b" args="(XAxiPmon *InstancePtr, u32 SwData)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XAxiPmon_SetSwDataReg </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u32 </td>
|
|
<td class="paramname"> <em>SwData</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function sets Software-written Data Register.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>SwData</em> </td><td>is the Software written Data.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0711d038045449d98561e5ad99cddda9"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_SetWriteId" ref="a0711d038045449d98561e5ad99cddda9" args="(XAxiPmon *InstancePtr, u16 WriteId)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XAxiPmon_SetWriteId </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u16 </td>
|
|
<td class="paramname"> <em>WriteId</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function sets Write ID in ID register.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>WriteId</em> </td><td>is the Write ID to be written in ID register.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a845d79723559fb4e369970087fe2b4ed"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_SetWriteIdMask" ref="a845d79723559fb4e369970087fe2b4ed" args="(XAxiPmon *InstancePtr, u16 WrMask)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XAxiPmon_SetWriteIdMask </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u16 </td>
|
|
<td class="paramname"> <em>WrMask</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function sets Write ID Mask in ID Mask register.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>WrMask</em> </td><td>is the Write ID mask to be written in ID register.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1f146b7a32bcb5b00ffeae5b66fd49bd"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_SetWrLatencyEnd" ref="a1f146b7a32bcb5b00ffeae5b66fd49bd" args="(XAxiPmon *InstancePtr, u8 Param)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XAxiPmon_SetWrLatencyEnd </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u8 </td>
|
|
<td class="paramname"> <em>Param</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function sets Latency End point to calculate write latency.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Param</em> </td><td>is XAPM_LATENCY_LASTWR or XAPM_LATENCY_FIRSTWR in <a class="el" href="xaxipmon_8h.html">xaxipmon.h</a>.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>Param can be 0 - XAPM_LATENCY_LASTWR or 1 - XAPM_LATENCY_FIRSTWR </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ada26dab07f2fece5d9f2bbaa2b663f06"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_SetWrLatencyStart" ref="ada26dab07f2fece5d9f2bbaa2b663f06" args="(XAxiPmon *InstancePtr, u8 Param)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XAxiPmon_SetWrLatencyStart </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u8 </td>
|
|
<td class="paramname"> <em>Param</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function sets Latency Start point to calculate write latency.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Param</em> </td><td>is XAPM_LATENCY_ADDR_ISSUE or XAPM_LATENCY_ADDR_ACCEPT in <a class="el" href="xaxipmon_8h.html">xaxipmon.h</a>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>Param can be 0 - XAPM_LATENCY_ADDR_ISSUE or 1 - XAPM_LATENCY_ADDR_ACCEPT </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad3905c1fa83ac4dd128eaba075d48bfa"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_StartCounters" ref="ad3905c1fa83ac4dd128eaba075d48bfa" args="(XAxiPmon *InstancePtr, u32 SampleInterval)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XAxiPmon_StartCounters </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u32 </td>
|
|
<td class="paramname"> <em>SampleInterval</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function enables the following in the AXI Performance Monitor:</p>
|
|
<ul>
|
|
<li>Global clock counter</li>
|
|
<li>All metric counters</li>
|
|
<li>All sampled metric counters</li>
|
|
</ul>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance. SampleInterval is the sample interval for the sampled metric counters</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>XST_SUCCESS</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="acaad86173961979553f8e28836b6e200"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_StartEventLog" ref="acaad86173961979553f8e28836b6e200" args="(XAxiPmon *InstancePtr, u32 FlagEnables)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XAxiPmon_StartEventLog </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u32 </td>
|
|
<td class="paramname"> <em>FlagEnables</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function enables the following in the AXI Performance Monitor:</p>
|
|
<ul>
|
|
<li>Event logging</li>
|
|
</ul>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>FlagEnables</em> </td><td>is a value to write to the flag enables register defined by XAPM_FEC_OFFSET. It is recommended to use the XAPM_FEC_*_MASK mask bits to generate. A value of 0x0 will disable all events to the event log streaming FIFO.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>XST_SUCCESS</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a265251978a8ad69d28d8c9f91ef85a7f"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_StopCounters" ref="a265251978a8ad69d28d8c9f91ef85a7f" args="(XAxiPmon *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XAxiPmon_StopCounters </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function disables the following in the AXI Performance Monitor:</p>
|
|
<ul>
|
|
<li>Global clock counter</li>
|
|
<li>All metric counters</li>
|
|
</ul>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>XST_SUCCESS</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a63fddaba107d3d5575528cdc4d1ab897"></a><!-- doxytag: member="xaxipmon.c::XAxiPmon_StopEventLog" ref="a63fddaba107d3d5575528cdc4d1ab897" args="(XAxiPmon *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XAxiPmon_StopEventLog </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This function disables the following in the AXI Performance Monitor:</p>
|
|
<ul>
|
|
<li>Event logging</li>
|
|
</ul>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_axi_pmon.html">XAxiPmon</a> instance.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>XST_SUCCESS</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<p class="Copyright">
|
|
Copyright © 1995-2014 Xilinx, Inc. All rights reserved.
|
|
</p>
|
|
</body>
|
|
</html>
|