stv0g/embeddedsw
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
embeddedsw/XilinxProcessorIPLib/drivers/xadcps/doc/html/api/xadcps_8c.html
Kedareswara rao Appana 6a08b60322 doxygen: Update doxygen for the drivers to include .h files in documentation. 
This patch updates the doxygen for the drivers
wdtps,wdttb,xadcps,usb,usbps to include .h files
in the listof files provided in the index.html file.

Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>
2014-09-02 11:21:46 +05:30

1554 lines
84 KiB
HTML
Executable file
Raw Blame History

<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver xadcps v2_1: xadcps.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&nbsp;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&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>xadcps.c File Reference</h1><code>#include &quot;<a class="el" href="xadcps_8h.html">xadcps.h</a>&quot;</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">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#acd9b3f5a63f29c6592fcecd9f97f5a2c">XAdcPs_WriteInternalReg</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr, u32 RegOffset, u32 Data)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#a900ea66de82858d239a5936ead385ad6">XAdcPs_ReadInternalReg</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr, u32 RegOffset)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#a57807452402a6b52dd48083f676bd4ff">XAdcPs_CfgInitialize</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr, <a class="el" href="struct_x_adc_ps___config.html">XAdcPs_Config</a> *ConfigPtr, u32 EffectiveAddr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#ae236a12120e287388f8d6818d281aefc">XAdcPs_SetConfigRegister</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr, u32 Data)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#a14382d04f08cd07a120af43f823b5e23">XAdcPs_GetConfigRegister</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#a3a0b53ba580c00c9e9212ee47f38ecee">XAdcPs_GetMiscStatus</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#a763e37d1e500182da4a7a7dd1f765ee1">XAdcPs_SetMiscCtrlRegister</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr, u32 Data)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#a6a44797b1370a4dc147d0249991893c9">XAdcPs_GetMiscCtrlRegister</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#a5d96b5dc7c813d1f1aa6238885fbc44b">XAdcPs_Reset</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u16&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#a249774f7bd8cf631b066db344e77807a">XAdcPs_GetAdcData</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr, u8 Channel)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u16&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#a8a7eeef3612853a2473de9e887329623">XAdcPs_GetCalibCoefficient</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr, u8 CoeffType)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u16&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#a4cecd7eded845124675357247a87bd2b">XAdcPs_GetMinMaxMeasurement</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr, u8 MeasurementType)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#ae1f591246d331a09c598f2b01590e1f8">XAdcPs_SetAvg</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr, u8 Average)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u8&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#a0397f1d96815a4a31f17e807965061bc">XAdcPs_GetAvg</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#ac586b30d9704eecc92119c437430d3ef">XAdcPs_SetSingleChParams</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr, u8 Channel, int IncreaseAcqCycles, int IsEventMode, int IsDifferentialMode)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#a62adf11abdc10aa3d1f064265337a3dd">XAdcPs_SetAlarmEnables</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr, u16 AlmEnableMask)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u16&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#a38e17d0dd36367a5aa24c5444e4382b7">XAdcPs_GetAlarmEnables</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#ac53ac264bb557251c7b3ea90ccb1c389">XAdcPs_SetCalibEnables</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr, u16 Calibration)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u16&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#afa9c172914ab5ce1d737ecf2d6d96707">XAdcPs_GetCalibEnables</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#af004d6f72df7692239604326bb2de23d">XAdcPs_SetSequencerMode</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr, u8 SequencerMode)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u8&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#adebc7c47c2bd2b8dbede2ba65224c395">XAdcPs_GetSequencerMode</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#a533b23d4d7b4e0bee4517b0ae0329576">XAdcPs_SetAdcClkDivisor</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr, u8 Divisor)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u8&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#aa4717a648a61251606e5278c696e6443">XAdcPs_GetAdcClkDivisor</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#a9ca50428b4ee0369cd2dcd5bbdb0f6f3">XAdcPs_SetSeqChEnables</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr, u32 ChEnableMask)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#ad57d70cea121cfe0e1bf04c9362b8024">XAdcPs_GetSeqChEnables</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#a326bb6bf25e4bb80e7622eb23f5021a2">XAdcPs_SetSeqAvgEnables</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr, u32 AvgEnableChMask)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#a1366299a4770116ed0153c9b5ce45aa5">XAdcPs_GetSeqAvgEnables</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#a9bb2c8daf81fcb50c214834e900c44ff">XAdcPs_SetSeqInputMode</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr, u32 InputModeChMask)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#a1735b8b15f8d2c11a7315d1cb361c81e">XAdcPs_GetSeqInputMode</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#aff3e133a519580ccdb9a415b26d0382c">XAdcPs_SetSeqAcqTime</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr, u32 AcqCyclesChMask)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#ab1c514d17f79cecc7e962b5ab449ba25">XAdcPs_GetSeqAcqTime</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#a222a97998083c80b4f0415a94aa4efc9">XAdcPs_SetAlarmThreshold</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr, u8 AlarmThrReg, u16 Value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u16&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#a486398d4b0619f38c1e9b0893f1f7bb3">XAdcPs_GetAlarmThreshold</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr, u8 AlarmThrReg)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#a7bd1df96dde38098c639a690484c063d">XAdcPs_EnableUserOverTemp</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#aac4aa7cafe46dc4ec867050db6bd8fd8">XAdcPs_DisableUserOverTemp</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#a25ad16579977f4b366c57c5b0bdd8b65">XAdcPs_SetSequencerEvent</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr, int IsEventMode)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#a3df99fa9e9735c4bff9505973d2ec7d2">XAdcPs_GetSamplingMode</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#a78ab54803a8e6e9993de88523fdc93ab">XAdcPs_SetMuxMode</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr, int MuxMode, u8 Channel)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#ad8e4a4799ac10ae15c068f660d3d5392">XAdcPs_SetPowerdownMode</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr, u32 Mode)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8c.html#ade5ed9cc4af7327d8d8e9c90c967c7fe">XAdcPs_GetPowerdownMode</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</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 XADC device.</p>
<p>Refer to the <a class="el" href="xadcps_8h.html">xadcps.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 ssb 12/22/11 First release based on the XPS/AXI xadc driver
1.01a bss 02/18/13 Modified XAdcPs_SetSeqChEnables,XAdcPs_SetSeqAvgEnables
XAdcPs_SetSeqInputMode and XAdcPs_SetSeqAcqTime APIs
to fix CR #693371
2.1 bss 08/05/14 Modified Assert for XAdcPs_SetSingleChParams to fix
CR #807563.
</pre> <hr/><h2>Function Documentation</h2>
<a class="anchor" id="a57807452402a6b52dd48083f676bd4ff"></a><!-- doxytag: member="xadcps.c::XAdcPs_CfgInitialize" ref="a57807452402a6b52dd48083f676bd4ff" args="(XAdcPs *InstancePtr, XAdcPs_Config *ConfigPtr, u32 EffectiveAddr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XAdcPs_CfgInitialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</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_adc_ps___config.html">XAdcPs_Config</a> *&nbsp;</td>
<td class="paramname"> <em>ConfigPtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>EffectiveAddr</em></td><td>&nbsp;</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_adc_ps.html">XAdcPs</a> device/instance. This function must be called prior to using the XADC 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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ConfigPtr</em>&nbsp;</td><td>points to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> device configuration structure. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>EffectiveAddr</em>&nbsp;</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="xadcps_8h.html#ae1c891154549887e7e99466fe0c90656">XAdcPs_LookupConfig()</a> API which returns the Configuration structure pointer which is passed as a parameter to the <a class="el" href="xadcps_8c.html#a57807452402a6b52dd48083f676bd4ff">XAdcPs_CfgInitialize()</a> API. </dd></dl>
</div>
</div>
<a class="anchor" id="aac4aa7cafe46dc4ec867050db6bd8fd8"></a><!-- doxytag: member="xadcps.c::XAdcPs_DisableUserOverTemp" ref="aac4aa7cafe46dc4ec867050db6bd8fd8" args="(XAdcPs *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XAdcPs_DisableUserOverTemp </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function disables programming of the powerdown temperature for the OverTemp signal in the OT Powerdown 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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</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="a7bd1df96dde38098c639a690484c063d"></a><!-- doxytag: member="xadcps.c::XAdcPs_EnableUserOverTemp" ref="a7bd1df96dde38098c639a690484c063d" args="(XAdcPs *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XAdcPs_EnableUserOverTemp </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function enables programming of the powerdown temperature for the OverTemp signal in the OT Powerdown 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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</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="aa4717a648a61251606e5278c696e6443"></a><!-- doxytag: member="xadcps.c::XAdcPs_GetAdcClkDivisor" ref="aa4717a648a61251606e5278c696e6443" args="(XAdcPs *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u8 XAdcPs_GetAdcClkDivisor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The function gets the ADCCLK divisor from the Configuration Register 2.</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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The divisor read from the Configuration Register 2.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>The ADCCLK is an internal clock used by the ADC and is synchronized to the DCLK clock. The ADCCLK is equal to DCLK divided by the user selection in the Configuration Register 2. </dd></dl>
</div>
</div>
<a class="anchor" id="a249774f7bd8cf631b066db344e77807a"></a><!-- doxytag: member="xadcps.c::XAdcPs_GetAdcData" ref="a249774f7bd8cf631b066db344e77807a" args="(XAdcPs *InstancePtr, u8 Channel)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u16 XAdcPs_GetAdcData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8&nbsp;</td>
<td class="paramname"> <em>Channel</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the ADC converted data for the specified channel.</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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Channel</em>&nbsp;</td><td>is the channel number. Use the XADCPS_CH_* defined in the file <a class="el" href="xadcps_8h.html">xadcps.h</a>. The valid channels are</p>
<ul>
<li>0 to 6</li>
<li>13 to 31</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A 16-bit value representing the ADC converted data for the specified channel. The XADC Monitor/ADC device guarantees a 10 bit resolution for the ADC converted data and data is the 10 MSB bits of the 16 data read from the device.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>The channels 7,8,9 are used for calibration of the device and hence there is no associated data with this channel. </dd></dl>
</div>
</div>
<a class="anchor" id="a38e17d0dd36367a5aa24c5444e4382b7"></a><!-- doxytag: member="xadcps.c::XAdcPs_GetAlarmEnables" ref="a38e17d0dd36367a5aa24c5444e4382b7" args="(XAdcPs *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u16 XAdcPs_GetAlarmEnables </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function gets the status of the alarm output enables in the Configuration Register 1.</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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>This is the bit-mask of the enabled alarm outputs in the Configuration Register 1. Use the masks XADCPS_CFR1_ALM*_* and XADCPS_CFR1_OT_MASK defined in <a class="el" href="xadcps__hw_8h.html">xadcps_hw.h</a> to interpret the returned value. Bit positions of 1 indicate that the alarm output is enabled. Bit positions of 0 indicate that the alarm output is disabled.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>The implementation of the alarm enables in the Configuration register 1 is such that alarms for the bit positions of 1 will be disabled and alarms for bit positions of 0 will be enabled. The enabled alarm outputs returned by this function is the negated value of the the data read from the Configuration Register 1. </dd></dl>
</div>
</div>
<a class="anchor" id="a486398d4b0619f38c1e9b0893f1f7bb3"></a><!-- doxytag: member="xadcps.c::XAdcPs_GetAlarmThreshold" ref="a486398d4b0619f38c1e9b0893f1f7bb3" args="(XAdcPs *InstancePtr, u8 AlarmThrReg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u16 XAdcPs_GetAlarmThreshold </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8&nbsp;</td>
<td class="paramname"> <em>AlarmThrReg</em></td><td>&nbsp;</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 specified Alarm Threshold 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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>AlarmThrReg</em>&nbsp;</td><td>is the index of an Alarm Threshold Register to be read. Use XADCPS_ATR_* constants defined in <a class="el" href="xadcps__hw_8h.html">xadcps_hw.h</a> to specify the index.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A 16-bit value representing the contents of the selected Alarm Threshold Register.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a0397f1d96815a4a31f17e807965061bc"></a><!-- doxytag: member="xadcps.c::XAdcPs_GetAvg" ref="a0397f1d96815a4a31f17e807965061bc" args="(XAdcPs *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u8 XAdcPs_GetAvg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function returns the number of samples of averaging configured for all the channels in the Configuration Register 0.</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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The averaging read from the Configuration Register 0 is returned. Use the XADCPS_AVG_* bit definitions defined in <a class="el" href="xadcps_8h.html">xadcps.h</a> file to interpret the returned value :<ul>
<li>XADCPS_AVG_0_SAMPLES means no averaging</li>
<li>XADCPS_AVG_16_SAMPLES means 16 samples of averaging</li>
<li>XADCPS_AVG_64_SAMPLES means 64 samples of averaging</li>
<li>XADCPS_AVG_256_SAMPLES means 256 samples of averaging</li>
</ul>
</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a8a7eeef3612853a2473de9e887329623"></a><!-- doxytag: member="xadcps.c::XAdcPs_GetCalibCoefficient" ref="a8a7eeef3612853a2473de9e887329623" args="(XAdcPs *InstancePtr, u8 CoeffType)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u16 XAdcPs_GetCalibCoefficient </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8&nbsp;</td>
<td class="paramname"> <em>CoeffType</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function gets the calibration coefficient data for the specified parameter.</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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>CoeffType</em>&nbsp;</td><td>specifies the calibration coefficient to be read. Use XADCPS_CALIB_* constants defined in <a class="el" href="xadcps_8h.html">xadcps.h</a> to specify the calibration coefficient to be read.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A 16-bit value representing the calibration coefficient. The XADC device guarantees a 10 bit resolution for the ADC converted data and data is the 10 MSB bits of the 16 data read from the device.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="afa9c172914ab5ce1d737ecf2d6d96707"></a><!-- doxytag: member="xadcps.c::XAdcPs_GetCalibEnables" ref="afa9c172914ab5ce1d737ecf2d6d96707" args="(XAdcPs *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u16 XAdcPs_GetCalibEnables </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function reads the value of the calibration enables from the Configuration Register 1.</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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The value of the calibration enables in the Configuration Register 1 :<ul>
<li>XADCPS_CFR1_CAL_ADC_OFFSET_MASK : ADC offset correction</li>
<li>XADCPS_CFR1_CAL_ADC_GAIN_OFFSET_MASK : ADC gain and offset correction</li>
<li>XADCPS_CFR1_CAL_PS_OFFSET_MASK : Power Supply sensor offset correction</li>
<li>XADCPS_CFR1_CAL_PS_GAIN_OFFSET_MASK : Power Supply sensor gain and offset correction</li>
<li>XADCPS_CFR1_CAL_DISABLE_MASK : No Calibration</li>
</ul>
</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a14382d04f08cd07a120af43f823b5e23"></a><!-- doxytag: member="xadcps.c::XAdcPs_GetConfigRegister" ref="a14382d04f08cd07a120af43f823b5e23" args="(XAdcPs *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XAdcPs_GetConfigRegister </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The functions reads the contents of the Config 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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A 32-bit value representing the contents of the Config Register. Use the XADCPS_SR_*_MASK constants defined in <a class="el" href="xadcps__hw_8h.html">xadcps_hw.h</a> to interpret the returned value.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a4cecd7eded845124675357247a87bd2b"></a><!-- doxytag: member="xadcps.c::XAdcPs_GetMinMaxMeasurement" ref="a4cecd7eded845124675357247a87bd2b" args="(XAdcPs *InstancePtr, u8 MeasurementType)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u16 XAdcPs_GetMinMaxMeasurement </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8&nbsp;</td>
<td class="paramname"> <em>MeasurementType</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function reads the Minimum/Maximum measurement for one of the specified parameters. Use XADCPS_MAX_* and XADCPS_MIN_* constants defined in <a class="el" href="xadcps_8h.html">xadcps.h</a> to specify the parameters (Temperature, VccInt, VccAux, VBram, VccPInt, VccPAux and VccPDro).</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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>MeasurementType</em>&nbsp;</td><td>specifies the parameter for which the Minimum/Maximum measurement has to be read. Use XADCPS_MAX_* and XADCPS_MIN_* constants defined in <a class="el" href="xadcps_8h.html">xadcps.h</a> to specify the data to be read.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A 16-bit value representing the maximum/minimum measurement for specified parameter. The XADC device guarantees a 10 bit resolution for the ADC converted data and data is the 10 MSB bits of the 16 data read from the device.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a6a44797b1370a4dc147d0249991893c9"></a><!-- doxytag: member="xadcps.c::XAdcPs_GetMiscCtrlRegister" ref="a6a44797b1370a4dc147d0249991893c9" args="(XAdcPs *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XAdcPs_GetMiscCtrlRegister </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The functions reads the contents of the Miscellaneous control 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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A 32-bit value representing the contents of the Config Register. Use the XADCPS_SR_*_MASK constants defined in <a class="el" href="xadcps__hw_8h.html">xadcps_hw.h</a> to interpret the returned value.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a3a0b53ba580c00c9e9212ee47f38ecee"></a><!-- doxytag: member="xadcps.c::XAdcPs_GetMiscStatus" ref="a3a0b53ba580c00c9e9212ee47f38ecee" args="(XAdcPs *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XAdcPs_GetMiscStatus </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The functions reads the contents of the Miscellaneous Status 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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A 32-bit value representing the contents of the Miscellaneous Status Register. Use the XADCPS_MSTS_*_MASK constants defined in <a class="el" href="xadcps__hw_8h.html">xadcps_hw.h</a> to interpret the returned value.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="ade5ed9cc4af7327d8d8e9c90c967c7fe"></a><!-- doxytag: member="xadcps.c::XAdcPs_GetPowerdownMode" ref="ade5ed9cc4af7327d8d8e9c90c967c7fe" args="(XAdcPs *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XAdcPs_GetPowerdownMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function gets the Power Down mode.</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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Mode specifies the Power Down Mode<ul>
<li>XADCPS_PD_MODE_NONE specifies NO Power Down (Both ADC A and ADC B are enabled)</li>
<li>XADCPS_PD_MODE_ADCB specfies the Power Down of ADC B</li>
<li>XADCPS_PD_MODE_XADC specifies the Power Down of both ADC A and ADC B.</li>
</ul>
</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a3df99fa9e9735c4bff9505973d2ec7d2"></a><!-- doxytag: member="xadcps.c::XAdcPs_GetSamplingMode" ref="a3df99fa9e9735c4bff9505973d2ec7d2" args="(XAdcPs *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XAdcPs_GetSamplingMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function returns the sampling mode.</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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The sampling mode<ul>
<li>0 specifies continuous sampling</li>
<li>1 specifies event driven sampling mode</li>
</ul>
</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="ab1c514d17f79cecc7e962b5ab449ba25"></a><!-- doxytag: member="xadcps.c::XAdcPs_GetSeqAcqTime" ref="ab1c514d17f79cecc7e962b5ab449ba25" args="(XAdcPs *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XAdcPs_GetSeqAcqTime </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function gets the status of acquisition from the ADC Channel Acquisition Time Sequencer 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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The acquisition time for all the channels. Use XADCPS_SEQ_CH__* defined in <a class="el" href="xadcps__hw_8h.html">xadcps_hw.h</a> to interpret the Channel numbers. Bit masks of 1 are the channels for which acquisition cycles are extended and bit mask of 0 are the channels for which acquisition cycles are not extended.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None </dd></dl>
</div>
</div>
<a class="anchor" id="a1366299a4770116ed0153c9b5ce45aa5"></a><!-- doxytag: member="xadcps.c::XAdcPs_GetSeqAvgEnables" ref="a1366299a4770116ed0153c9b5ce45aa5" args="(XAdcPs *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XAdcPs_GetSeqAvgEnables </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function returns the channels for which the averaging has been enabled in the ADC Channel Averaging Enables Sequencer 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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The status of averaging (enabled/disabled) for all the channels. Use XADCPS_SEQ_CH__* defined in <a class="el" href="xadcps__hw_8h.html">xadcps_hw.h</a> to interpret the Channel numbers. Bit masks of 1 are the channels for which averaging is enabled and bit mask of 0 are the channels for averaging is disabled</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None </dd></dl>
</div>
</div>
<a class="anchor" id="ad57d70cea121cfe0e1bf04c9362b8024"></a><!-- doxytag: member="xadcps.c::XAdcPs_GetSeqChEnables" ref="ad57d70cea121cfe0e1bf04c9362b8024" args="(XAdcPs *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XAdcPs_GetSeqChEnables </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function gets the channel enable bits status from the ADC Channel Selection Sequencer 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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Gets the channel enable bits. Use XADCPS_SEQ_CH__* defined in <a class="el" href="xadcps__hw_8h.html">xadcps_hw.h</a> to interpret the Channel numbers. Bit masks of 1 are the channels that are enabled and bit mask of 0 are the channels that are disabled.</dd>
<dd>
None</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None </dd></dl>
</div>
</div>
<a class="anchor" id="a1735b8b15f8d2c11a7315d1cb361c81e"></a><!-- doxytag: member="xadcps.c::XAdcPs_GetSeqInputMode" ref="a1735b8b15f8d2c11a7315d1cb361c81e" args="(XAdcPs *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XAdcPs_GetSeqInputMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function gets the Analog input mode for all the channels from the ADC Channel Analog-Input Mode Sequencer 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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The input mode for all the channels. Use XADCPS_SEQ_CH_* defined in <a class="el" href="xadcps__hw_8h.html">xadcps_hw.h</a> to interpret the Channel numbers. Bit masks of 1 are the channels for which input mode is differential and bit mask of 0 are the channels for which input mode is unipolar.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="adebc7c47c2bd2b8dbede2ba65224c395"></a><!-- doxytag: member="xadcps.c::XAdcPs_GetSequencerMode" ref="adebc7c47c2bd2b8dbede2ba65224c395" args="(XAdcPs *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u8 XAdcPs_GetSequencerMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function gets the channel sequencer mode from the Configuration Register 1.</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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The channel sequencer mode :<ul>
<li>XADCPS_SEQ_MODE_SAFE : Default safe mode</li>
<li>XADCPS_SEQ_MODE_ONEPASS : One pass through sequence</li>
<li>XADCPS_SEQ_MODE_CONTINPASS : Continuous channel sequencing</li>
<li>XADCPS_SEQ_MODE_SINGCHAN : Single channel/Sequencer off</li>
<li>XADCPS_SEQ_MODE_SIMUL_SAMPLING : Simulataneous sampling mode</li>
<li>XADCPS_SEQ_MODE_INDEPENDENT : Independent mode</li>
</ul>
</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a900ea66de82858d239a5936ead385ad6"></a><!-- doxytag: member="xadcps.c::XAdcPs_ReadInternalReg" ref="a900ea66de82858d239a5936ead385ad6" args="(XAdcPs *InstancePtr, u32 RegOffset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XAdcPs_ReadInternalReg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>RegOffset</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function is used for reading from the XADC Registers using the Data FIFO.</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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>RegOffset</em>&nbsp;</td><td>is the offset of the XADC register to be read.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Data read from the FIFO</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a5d96b5dc7c813d1f1aa6238885fbc44b"></a><!-- doxytag: member="xadcps.c::XAdcPs_Reset" ref="a5d96b5dc7c813d1f1aa6238885fbc44b" args="(XAdcPs *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XAdcPs_Reset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function resets the XADC Hard Macro in the 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>&nbsp;</td><td>is a pointer to the Xxadc 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="a533b23d4d7b4e0bee4517b0ae0329576"></a><!-- doxytag: member="xadcps.c::XAdcPs_SetAdcClkDivisor" ref="a533b23d4d7b4e0bee4517b0ae0329576" args="(XAdcPs *InstancePtr, u8 Divisor)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XAdcPs_SetAdcClkDivisor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8&nbsp;</td>
<td class="paramname"> <em>Divisor</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The function sets the frequency of the ADCCLK by configuring the DCLK to ADCCLK ratio in the Configuration Register #2</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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Divisor</em>&nbsp;</td><td>is clock divisor used to derive ADCCLK from DCLK. Valid values of the divisor are</p>
<ul>
<li>0 to 255. Values 0, 1, 2 are all mapped to 2. Refer to the device specification for more details</li>
</ul>
</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>- The ADCCLK is an internal clock used by the ADC and is synchronized to the DCLK clock. The ADCCLK is equal to DCLK divided by the user selection in the Configuration Register 2.<ul>
<li>There is no Assert on the minimum value of the Divisor. </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a62adf11abdc10aa3d1f064265337a3dd"></a><!-- doxytag: member="xadcps.c::XAdcPs_SetAlarmEnables" ref="a62adf11abdc10aa3d1f064265337a3dd" args="(XAdcPs *InstancePtr, u16 AlmEnableMask)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XAdcPs_SetAlarmEnables </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16&nbsp;</td>
<td class="paramname"> <em>AlmEnableMask</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function enables the alarm outputs for the specified alarms in the Configuration Register 1.</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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>AlmEnableMask</em>&nbsp;</td><td>is the bit-mask of the alarm outputs to be enabled in the Configuration Register 1. Bit positions of 1 will be enabled. Bit positions of 0 will be disabled. This mask is formed by OR'ing XADCPS_CFR1_ALM_*_MASK and XADCPS_CFR1_OT_MASK masks defined in <a class="el" href="xadcps__hw_8h.html">xadcps_hw.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>The implementation of the alarm enables in the Configuration register 1 is such that the alarms for bit positions of 1 will be disabled and alarms for bit positions of 0 will be enabled. The alarm outputs specified by the AlmEnableMask are negated before writing to the Configuration Register 1. </dd></dl>
</div>
</div>
<a class="anchor" id="a222a97998083c80b4f0415a94aa4efc9"></a><!-- doxytag: member="xadcps.c::XAdcPs_SetAlarmThreshold" ref="a222a97998083c80b4f0415a94aa4efc9" args="(XAdcPs *InstancePtr, u8 AlarmThrReg, u16 Value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XAdcPs_SetAlarmThreshold </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8&nbsp;</td>
<td class="paramname"> <em>AlarmThrReg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16&nbsp;</td>
<td class="paramname"> <em>Value</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This functions sets the contents of the given Alarm Threshold 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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>AlarmThrReg</em>&nbsp;</td><td>is the index of an Alarm Threshold Register to be set. Use XADCPS_ATR_* constants defined in <a class="el" href="xadcps_8h.html">xadcps.h</a> to specify the index. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Value</em>&nbsp;</td><td>is the 16-bit threshold value to write into the 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>Use XAdcPs_SetOverTemp() to set the Over Temperature upper threshold value. </dd></dl>
</div>
</div>
<a class="anchor" id="ae1f591246d331a09c598f2b01590e1f8"></a><!-- doxytag: member="xadcps.c::XAdcPs_SetAvg" ref="ae1f591246d331a09c598f2b01590e1f8" args="(XAdcPs *InstancePtr, u8 Average)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XAdcPs_SetAvg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8&nbsp;</td>
<td class="paramname"> <em>Average</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function sets the number of samples of averaging that is to be done for all the channels in both the single channel mode and sequence mode of operations.</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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Average</em>&nbsp;</td><td>is the number of samples of averaging programmed to the Configuration Register 0. Use the XADCPS_AVG_* definitions defined in <a class="el" href="xadcps_8h.html">xadcps.h</a> file :</p>
<ul>
<li>XADCPS_AVG_0_SAMPLES for no averaging</li>
<li>XADCPS_AVG_16_SAMPLES for 16 samples of averaging</li>
<li>XADCPS_AVG_64_SAMPLES for 64 samples of averaging</li>
<li>XADCPS_AVG_256_SAMPLES for 256 samples of averaging</li>
</ul>
</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="ac53ac264bb557251c7b3ea90ccb1c389"></a><!-- doxytag: member="xadcps.c::XAdcPs_SetCalibEnables" ref="ac53ac264bb557251c7b3ea90ccb1c389" args="(XAdcPs *InstancePtr, u16 Calibration)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XAdcPs_SetCalibEnables </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16&nbsp;</td>
<td class="paramname"> <em>Calibration</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function enables the specified calibration in the Configuration Register 1 :</p>
<ul>
<li>XADCPS_CFR1_CAL_ADC_OFFSET_MASK : Calibration 0 -ADC offset correction</li>
<li>XADCPS_CFR1_CAL_ADC_GAIN_OFFSET_MASK : Calibration 1 -ADC gain and offset correction</li>
<li>XADCPS_CFR1_CAL_PS_OFFSET_MASK : Calibration 2 -Power Supply sensor offset correction</li>
<li>XADCPS_CFR1_CAL_PS_GAIN_OFFSET_MASK : Calibration 3 -Power Supply sensor gain and offset correction</li>
<li>XADCPS_CFR1_CAL_DISABLE_MASK : No Calibration</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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Calibration</em>&nbsp;</td><td>is the Calibration to be applied. Use XADCPS_CFR1_CAL*_* bits defined in <a class="el" href="xadcps__hw_8h.html">xadcps_hw.h</a>. Multiple calibrations can be enabled at a time by oring the XADCPS_CFR1_CAL_ADC_* and XADCPS_CFR1_CAL_PS_* bits. Calibration can be disabled by specifying XADCPS_CFR1_CAL_DISABLE_MASK;</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="ae236a12120e287388f8d6818d281aefc"></a><!-- doxytag: member="xadcps.c::XAdcPs_SetConfigRegister" ref="ae236a12120e287388f8d6818d281aefc" args="(XAdcPs *InstancePtr, u32 Data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XAdcPs_SetConfigRegister </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>Data</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The functions sets the contents of the Config 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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Data</em>&nbsp;</td><td>is the 32 bit data to be written to the 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="a763e37d1e500182da4a7a7dd1f765ee1"></a><!-- doxytag: member="xadcps.c::XAdcPs_SetMiscCtrlRegister" ref="a763e37d1e500182da4a7a7dd1f765ee1" args="(XAdcPs *InstancePtr, u32 Data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XAdcPs_SetMiscCtrlRegister </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>Data</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The functions sets the contents of the Miscellaneous Control 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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Data</em>&nbsp;</td><td>is the 32 bit data to be written to the 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="a78ab54803a8e6e9993de88523fdc93ab"></a><!-- doxytag: member="xadcps.c::XAdcPs_SetMuxMode" ref="a78ab54803a8e6e9993de88523fdc93ab" args="(XAdcPs *InstancePtr, int MuxMode, u8 Channel)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XAdcPs_SetMuxMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>MuxMode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8&nbsp;</td>
<td class="paramname"> <em>Channel</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function sets the External Mux mode.</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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>MuxMode</em>&nbsp;</td><td>specifies whether External Mux is used</p>
<ul>
<li>FALSE specifies NO external MUX</li>
<li>TRUE specifies External Mux is used </li>
</ul>
</td></tr>
<tr><td valign="top"></td><td valign="top"><em>Channel</em>&nbsp;</td><td>specifies the channel to be used for the external Mux. Please read the Device Spec for which channels are valid for which mode.</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>There is no Assert in this function for checking the channel number if the external Mux is used. The user should provide a valid channel number. </dd></dl>
</div>
</div>
<a class="anchor" id="ad8e4a4799ac10ae15c068f660d3d5392"></a><!-- doxytag: member="xadcps.c::XAdcPs_SetPowerdownMode" ref="ad8e4a4799ac10ae15c068f660d3d5392" args="(XAdcPs *InstancePtr, u32 Mode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XAdcPs_SetPowerdownMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>Mode</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function sets the Power Down mode.</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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Mode</em>&nbsp;</td><td>specifies the Power Down Mode</p>
<ul>
<li>XADCPS_PD_MODE_NONE specifies NO Power Down (Both ADC A and ADC B are enabled)</li>
<li>XADCPS_PD_MODE_ADCB specfies the Power Down of ADC B</li>
<li>XADCPS_PD_MODE_XADC specifies the Power Down of both ADC A and ADC B.</li>
</ul>
</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="aff3e133a519580ccdb9a415b26d0382c"></a><!-- doxytag: member="xadcps.c::XAdcPs_SetSeqAcqTime" ref="aff3e133a519580ccdb9a415b26d0382c" args="(XAdcPs *InstancePtr, u32 AcqCyclesChMask)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XAdcPs_SetSeqAcqTime </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>AcqCyclesChMask</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function sets the number of Acquisition cycles in the ADC Channel Acquisition Time Sequencer Registers. The sequencer must be disabled before writing to these regsiters.</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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>AcqCyclesChMask</em>&nbsp;</td><td>is the bit mask of all the channels for which the number of acquisition cycles is to be extended. Use XADCPS_SEQ_CH__* defined in <a class="el" href="xadcps__hw_8h.html">xadcps_hw.h</a> to specify the Channel numbers. Acquisition cycles will be extended to 10 ADCCLK cycles for bit masks of 1 and will be the default 4 ADCCLK cycles for bit masks of 0. The AcqCyclesChMask is a 32 bit mask that is written to the two 16 bit ADC Channel Acquisition Time Sequencer Registers.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the given values were written successfully to the Channel Sequencer Registers.</li>
<li>XST_FAILURE if the channel sequencer is enabled.</li>
</ul>
</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a326bb6bf25e4bb80e7622eb23f5021a2"></a><!-- doxytag: member="xadcps.c::XAdcPs_SetSeqAvgEnables" ref="a326bb6bf25e4bb80e7622eb23f5021a2" args="(XAdcPs *InstancePtr, u32 AvgEnableChMask)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XAdcPs_SetSeqAvgEnables </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>AvgEnableChMask</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function enables the averaging for the specified channels in the ADC Channel Averaging Enable Sequencer Registers. The sequencer must be disabled before writing to these regsiters.</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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>AvgEnableChMask</em>&nbsp;</td><td>is the bit mask of all the channels for which averaging is to be enabled. Use XADCPS_SEQ_CH__* defined in <a class="el" href="xadcps__hw_8h.html">xadcps_hw.h</a> to specify the Channel numbers. Averaging will be enabled for bit masks of 1 and disabled for bit mask of 0. The AvgEnableChMask is a 32 bit mask that is written to the two 16 bit ADC Channel Averaging Enable Sequencer Registers.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the given values were written successfully to the ADC Channel Averaging Enables Sequencer Registers.</li>
<li>XST_FAILURE if the channel sequencer is enabled.</li>
</ul>
</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None </dd></dl>
</div>
</div>
<a class="anchor" id="a9ca50428b4ee0369cd2dcd5bbdb0f6f3"></a><!-- doxytag: member="xadcps.c::XAdcPs_SetSeqChEnables" ref="a9ca50428b4ee0369cd2dcd5bbdb0f6f3" args="(XAdcPs *InstancePtr, u32 ChEnableMask)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XAdcPs_SetSeqChEnables </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>ChEnableMask</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function enables the specified channels in the ADC Channel Selection Sequencer Registers. The sequencer must be disabled before writing to these regsiters.</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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ChEnableMask</em>&nbsp;</td><td>is the bit mask of all the channels to be enabled. Use XADCPS_SEQ_CH__* defined in <a class="el" href="xadcps__hw_8h.html">xadcps_hw.h</a> to specify the Channel numbers. Bit masks of 1 will be enabled and bit mask of 0 will be disabled. The ChEnableMask is a 32 bit mask that is written to the two 16 bit ADC Channel Selection Sequencer Registers.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the given values were written successfully to the ADC Channel Selection Sequencer Registers.</li>
<li>XST_FAILURE if the channel sequencer is enabled.</li>
</ul>
</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None </dd></dl>
</div>
</div>
<a class="anchor" id="a9bb2c8daf81fcb50c214834e900c44ff"></a><!-- doxytag: member="xadcps.c::XAdcPs_SetSeqInputMode" ref="a9bb2c8daf81fcb50c214834e900c44ff" args="(XAdcPs *InstancePtr, u32 InputModeChMask)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XAdcPs_SetSeqInputMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>InputModeChMask</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function sets the Analog input mode for the specified channels in the ADC Channel Analog-Input Mode Sequencer Registers. The sequencer must be disabled before writing to these regsiters.</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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>InputModeChMask</em>&nbsp;</td><td>is the bit mask of all the channels for which the input mode is differential mode. Use XADCPS_SEQ_CH__* defined in <a class="el" href="xadcps__hw_8h.html">xadcps_hw.h</a> to specify the channel numbers. Differential input mode will be set for bit masks of 1 and unipolar input mode for bit masks of 0. The InputModeChMask is a 32 bit mask that is written to the two 16 bit ADC Channel Analog-Input Mode Sequencer Registers.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the given values were written successfully to the ADC Channel Analog-Input Mode Sequencer Registers.</li>
<li>XST_FAILURE if the channel sequencer is enabled.</li>
</ul>
</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None </dd></dl>
</div>
</div>
<a class="anchor" id="a25ad16579977f4b366c57c5b0bdd8b65"></a><!-- doxytag: member="xadcps.c::XAdcPs_SetSequencerEvent" ref="a25ad16579977f4b366c57c5b0bdd8b65" args="(XAdcPs *InstancePtr, int IsEventMode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XAdcPs_SetSequencerEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>IsEventMode</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The function enables the Event mode or Continuous mode in the sequencer mode.</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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>IsEventMode</em>&nbsp;</td><td>is a boolean parameter that specifies continuous sampling (specify FALSE) or event driven sampling mode (specify TRUE) for the given channel.</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="af004d6f72df7692239604326bb2de23d"></a><!-- doxytag: member="xadcps.c::XAdcPs_SetSequencerMode" ref="af004d6f72df7692239604326bb2de23d" args="(XAdcPs *InstancePtr, u8 SequencerMode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XAdcPs_SetSequencerMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8&nbsp;</td>
<td class="paramname"> <em>SequencerMode</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function sets the specified Channel Sequencer Mode in the Configuration Register 1 :</p>
<ul>
<li>Default safe mode (XADCPS_SEQ_MODE_SAFE)</li>
<li>One pass through sequence (XADCPS_SEQ_MODE_ONEPASS)</li>
<li>Continuous channel sequencing (XADCPS_SEQ_MODE_CONTINPASS)</li>
<li>Single Channel/Sequencer off (XADCPS_SEQ_MODE_SINGCHAN)</li>
<li>Simulataneous sampling mode (XADCPS_SEQ_MODE_SIMUL_SAMPLING)</li>
<li>Independent mode (XADCPS_SEQ_MODE_INDEPENDENT)</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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>SequencerMode</em>&nbsp;</td><td>is the sequencer mode to be set. Use XADCPS_SEQ_MODE_* bits defined in <a class="el" href="xadcps_8h.html">xadcps.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>Only one of the modes can be enabled at a time. Please read the Spec of the XADC for further information about the sequencer modes. </dd></dl>
</div>
</div>
<a class="anchor" id="ac586b30d9704eecc92119c437430d3ef"></a><!-- doxytag: member="xadcps.c::XAdcPs_SetSingleChParams" ref="ac586b30d9704eecc92119c437430d3ef" args="(XAdcPs *InstancePtr, u8 Channel, int IncreaseAcqCycles, int IsEventMode, int IsDifferentialMode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XAdcPs_SetSingleChParams </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8&nbsp;</td>
<td class="paramname"> <em>Channel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>IncreaseAcqCycles</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>IsEventMode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>IsDifferentialMode</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The function sets the given parameters in the Configuration Register 0 in the single channel mode.</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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Channel</em>&nbsp;</td><td>is the channel number for the singel channel mode. The valid channels are 0 to 6, 8, and 13 to 31. If the external Mux is used then this specifies the channel oonnected to the external Mux. Please read the Device Spec to know which channels are valid. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>IncreaseAcqCycles</em>&nbsp;</td><td>is a boolean parameter which specifies whether the Acquisition time for the external channels has to be increased to 10 ADCCLK cycles (specify TRUE) or remain at the default 4 ADCCLK cycles (specify FALSE). This parameter is only valid for the external channels. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>IsDifferentialMode</em>&nbsp;</td><td>is a boolean parameter which specifies unipolar(specify FALSE) or differential mode (specify TRUE) for the analog inputs. The input mode is only valid for the external channels.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the given values were written successfully to the Configuration Register 0.</li>
<li>XST_FAILURE if the channel sequencer is enabled or the input parameters are not valid for the selected channel.</li>
</ul>
</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd><ul>
<li>The number of samples for the averaging for all the channels is set by using the function XAdcPs_SetAvg.</li>
<li>The calibration of the device is done by doing a ADC conversion on the calibration channel(channel 8). The input parameters IncreaseAcqCycles, IsDifferentialMode and IsEventMode are not valid for this channel </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="acd9b3f5a63f29c6592fcecd9f97f5a2c"></a><!-- doxytag: member="xadcps.c::XAdcPs_WriteInternalReg" ref="acd9b3f5a63f29c6592fcecd9f97f5a2c" args="(XAdcPs *InstancePtr, u32 RegOffset, u32 Data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XAdcPs_WriteInternalReg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>RegOffset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>Data</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function is used for writing to XADC Registers using the command FIFO.</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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_adc_ps.html">XAdcPs</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>RegOffset</em>&nbsp;</td><td>is the offset of the XADC register to be written. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Data</em>&nbsp;</td><td>is the data to be written.</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>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>
Reference in a new issue View git blame Copy permalink