2806 lines
143 KiB
HTML
2806 lines
143 KiB
HTML
![]() |
<html>
|
||
|
<head>
|
||
|
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
||
|
<title>
|
||
|
Xilinx Driver xadcps v2_1: xadcps.h 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>xadcps.h File Reference</h1><code>#include "xil_types.h"</code><br/>
|
||
|
<code>#include "xil_assert.h"</code><br/>
|
||
|
<code>#include "xstatus.h"</code><br/>
|
||
|
<code>#include "<a class="el" href="xadcps__hw_8h.html">xadcps_hw.h</a>"</code><br/>
|
||
|
<table border="0" cellpadding="0" cellspacing="0">
|
||
|
<tr><td colspan="2"><h2>Classes</h2></td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_adc_ps___config.html">XAdcPs_Config</a></td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a></td></tr>
|
||
|
<tr><td colspan="2"><h2>Defines</h2></td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a9bbae9905d2c7eddad10d93e7283944d">XADCPS_H</a></td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a67e2c510d46a33e3c74e52421203f579">XAdcPs_IsEventSamplingModeSet</a>(InstancePtr)</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#af81492eb0831e7276ace6909b435f709">XAdcPs_IsExternalMuxModeSet</a>(InstancePtr)</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a5963e24ffc2977cbc40d089877e45639">XAdcPs_RawToTemperature</a>(AdcData) ((((float)(AdcData)/65536.0f)/0.00198421639f ) - 273.15f)</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a87a27bb34c70dadaa6be27c83058ad21">XAdcPs_RawToVoltage</a>(AdcData) ((((float)(AdcData))* (3.0f))/65536.0f)</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#aacca1d43ff3854002cf54e4b4989f3b8">XAdcPs_TemperatureToRaw</a>(Temperature) ((int)(((Temperature) + 273.15f)*65536.0f*0.00198421639f))</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a38cad68c817e99d6fd7359a3a3175062">XAdcPs_VoltageToRaw</a>(Voltage) ((int)((Voltage)*65536.0f/3.0f))</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a1ef487633f003d94a16459f6a5e7f7f5">XAdcPs_WriteFifo</a>(InstancePtr, Data)</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#aaf38a240a16e53a6afb6977113e3c3e1">XAdcPs_ReadFifo</a>(InstancePtr)</td></tr>
|
||
|
<tr><td colspan="2"><div class="groupHeader">Indexes for the different channels.</div></td></tr>
|
||
|
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp4fe13686cfb18348d6fa7c41f272d652"></a> </p>
|
||
|
<br/><br/></div></td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#adea5053b3abf2d83b93ed125ff5e2255">XADCPS_CH_TEMP</a> 0x0</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#acfc874d5131f02908cf772e8b24f628f">XADCPS_CH_VCCINT</a> 0x1</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a6816ddc0beab7c068edbff236ef16cfb">XADCPS_CH_VCCAUX</a> 0x2</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#acc0714183a348b546ea3e9887f3cb110">XADCPS_CH_VPVN</a> 0x3</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#afea65c41f14f7d9c961e2a71eef02c69">XADCPS_CH_VREFP</a> 0x4</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#ae59cbd3b94a13841048f3ac4f7ac4e5d">XADCPS_CH_VREFN</a> 0x5</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a660629e3cbd893d9d2bf12fa1c7767bd">XADCPS_CH_VBRAM</a> 0x6</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a70d562d928ce2dc7354be157ef39ffff">XADCPS_CH_SUPPLY_CALIB</a> 0x07</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a3a890ee18b909698d5b9847044ec5ac8">XADCPS_CH_ADC_CALIB</a> 0x08</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a76333242081e55e8db5b38d146717b75">XADCPS_CH_GAINERR_CALIB</a> 0x09</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a8cd67708bf7ca40c46d3690391ced7fa">XADCPS_CH_VCCPINT</a> 0x0D</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#af8512c31afc362730ef6efbded2015d3">XADCPS_CH_VCCPAUX</a> 0x0E</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a673ddf3fb75b0b7e17cf4081ee8c8b00">XADCPS_CH_VCCPDRO</a> 0x0F</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#ab9ea0454ee45e4f4482d553e10b961e3">XADCPS_CH_AUX_MIN</a> 16</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a908ab70d7b6ba30490aadc6a39609515">XADCPS_CH_AUX_MAX</a> 31</td></tr>
|
||
|
<tr><td colspan="2"><div class="groupHeader">Indexes for reading the Calibration Coefficient Data.</div></td></tr>
|
||
|
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp4f35e0373c425f6004e7715938783468"></a> </p>
|
||
|
<br/><br/></div></td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#aec2667004230932c5d5ebbed38ca4e96">XADCPS_CALIB_SUPPLY_COEFF</a> 0</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#ab7a9a0302aebadbc4488f3dd13d001f6">XADCPS_CALIB_ADC_COEFF</a> 1</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a018dd22f5fabb275d543ca2d8ce60e43">XADCPS_CALIB_GAIN_ERROR_COEFF</a> 2</td></tr>
|
||
|
<tr><td colspan="2"><div class="groupHeader">Indexes for reading the Minimum/Maximum Measurement Data.</div></td></tr>
|
||
|
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrpe958f5e9f4603bb7f6fd406d61a31e99"></a> </p>
|
||
|
<br/><br/></div></td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#ab1c8002139e905a700006150ea45fd08">XADCPS_MAX_TEMP</a> 0</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a5443382eef1629daa0f25033139571e9">XADCPS_MAX_VCCINT</a> 1</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a1d060e11b4682e9be7d7653db2dd9b19">XADCPS_MAX_VCCAUX</a> 2</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#ac40249d391ea45fea29af1dec67f63b8">XADCPS_MAX_VBRAM</a> 3</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#aadfe3a185c836f8b5eaef2e33cbcbcea">XADCPS_MIN_TEMP</a> 4</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#acbc8534b2da01747971ebd9b8561ba0e">XADCPS_MIN_VCCINT</a> 5</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#ab7c654ea90be1084090ffcc218b577bd">XADCPS_MIN_VCCAUX</a> 6</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#aeb9d6818a3af6e0300a2f5de5dca25f3">XADCPS_MIN_VBRAM</a> 7</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#ab1dc807e5fcaaca70ddad267413e48f0">XADCPS_MAX_VCCPINT</a> 8</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a026ef03a5ad93fd7573316e27c935a7e">XADCPS_MAX_VCCPAUX</a> 9</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a73ea1353b5dc0cb7db31b4fcce40a427">XADCPS_MAX_VCCPDRO</a> 0xA</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a1c0280513d645840fd3791046b5f3e9d">XADCPS_MIN_VCCPINT</a> 0xC</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#af60a6e1f1f63ea196e5c138cc3756e59">XADCPS_MIN_VCCPAUX</a> 0xD</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#afbd736b9054a9ab04dd13dff1b20b352">XADCPS_MIN_VCCPDRO</a> 0xE</td></tr>
|
||
|
<tr><td colspan="2"><div class="groupHeader">Alarm Threshold(Limit) Register (ATR) indexes.</div></td></tr>
|
||
|
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrpa7f26e5519862974972f1a4af214e46e"></a> </p>
|
||
|
<br/><br/></div></td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#abb9936055691b405167548fc61cab567">XADCPS_ATR_TEMP_UPPER</a> 0</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#af1b941e38e172b1ffc75ca3ccdf2c2d0">XADCPS_ATR_VCCINT_UPPER</a> 1</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#af7ec64bbf7c7cdb10c7d0b1bd21bdb59">XADCPS_ATR_VCCAUX_UPPER</a> 2</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a4d7a2dc7acf67238f8827b35ce22863c">XADCPS_ATR_OT_UPPER</a> 3</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a365097ee163084219b30593e3fc886dc">XADCPS_ATR_TEMP_LOWER</a> 4</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#ab650bf9549d9da74d7edc448433c7726">XADCPS_ATR_VCCINT_LOWER</a> 5</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a68f4d450364d4a6d47bfd3c859e501bf">XADCPS_ATR_VCCAUX_LOWER</a> 6</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a7ab80955616330e65f29283cc62fa5cb">XADCPS_ATR_OT_LOWER</a> 7</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a8fccf632c3ed72fe8dbe5e5a73cacbdd">XADCPS_ATR_VBRAM_UPPER_</a> 8</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a27f879296da31c2bcb6af21d3c377004">XADCPS_ATR_VCCPINT_UPPER</a> 9</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a16ba2a7160b86fb6bc5037e85edc52d0">XADCPS_ATR_VCCPAUX_UPPER</a> 0xA</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#ae718153dbcfa49692e362c3d581b58da">XADCPS_ATR_VCCPDRO_UPPER</a> 0xB</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a9f033674caa746489243cf47c0a3d34b">XADCPS_ATR_VBRAM_LOWER</a> 0xC</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#ae5236cec9a559096db14df95f06971e7">XADCPS_ATR_VCCPINT_LOWER</a> 0xD</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a7adfae31cec49001437bd7eaaa90ee20">XADCPS_ATR_VCCPAUX_LOWER</a> 0xE</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#ae7bfca4338f79433f1a9a585614a643c">XADCPS_ATR_VCCPDRO_LOWER</a> 0xF</td></tr>
|
||
|
<tr><td colspan="2"><div class="groupHeader">Averaging to be done for the channels.</div></td></tr>
|
||
|
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp2f5de4cba29b17ac80d9014b66f2a826"></a> </p>
|
||
|
<br/><br/></div></td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#adb1cdd371d22e01cecb9291b2932abc9">XADCPS_AVG_0_SAMPLES</a> 0</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#ad0bcaa25ff0eb1e061bd115ed25012f2">XADCPS_AVG_16_SAMPLES</a> 1</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a6ca78ac3b39e3f901f2dce5d083a2a78">XADCPS_AVG_64_SAMPLES</a> 2</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a7b0e47dffe8eb913e5c47ee5d436a6d8">XADCPS_AVG_256_SAMPLES</a> 3</td></tr>
|
||
|
<tr><td colspan="2"><div class="groupHeader">Channel Sequencer Modes of operation</div></td></tr>
|
||
|
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp7e211c381c87034fe6c2f1a824629145"></a> </p>
|
||
|
<br/><br/></div></td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a799c7fbcb2e7fd3f27b780f56d764844">XADCPS_SEQ_MODE_SAFE</a> 0</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#ae1fbdfce66254dfb53e62a7a389e24c3">XADCPS_SEQ_MODE_ONEPASS</a> 1</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a8f057289da345bfc62938fcd13d88512">XADCPS_SEQ_MODE_CONTINPASS</a> 2</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#af9ef5e521cabdd0a008c5617687fca84">XADCPS_SEQ_MODE_SINGCHAN</a> 3</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#acb64b12f9a6758ebb0adfbe9c4b08c53">XADCPS_SEQ_MODE_SIMUL_SAMPLING</a> 4</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#ac3a1e362d43ca6272a84b477205ef29a">XADCPS_SEQ_MODE_INDEPENDENT</a> 8</td></tr>
|
||
|
<tr><td colspan="2"><div class="groupHeader">Power Down Modes</div></td></tr>
|
||
|
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp48464e2fd2da3c35c22afb9f1b129b0c"></a> </p>
|
||
|
<br/><br/></div></td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#af1aed807494f2f8d5e63b1c270581dcb">XADCPS_PD_MODE_NONE</a> 0</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a0c71f14f278fbefe7e6a4d6f82a77865">XADCPS_PD_MODE_ADCB</a> 1</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a4fab650f2a8839ff3bc3b02473977fd6">XADCPS_PD_MODE_XADC</a> 2</td></tr>
|
||
|
<tr><td colspan="2"><h2>Functions</h2></td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_adc_ps___config.html">XAdcPs_Config</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#ae1c891154549887e7e99466fe0c90656">XAdcPs_LookupConfig</a> (u16 DeviceId)</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#ad108c115f48bd5f8f57cf92b70136557">XAdcPs_GetStatus</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr)</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a7663e26d050b8810fb79788d8a017f65">XAdcPs_GetAlarmOutputStatus</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr)</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#af493491f2c830a07319d54ff847d09f4">XAdcPs_StartAdcConversion</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr)</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#ade5ed9cc4af7327d8d8e9c90c967c7fe">XAdcPs_GetPowerdownMode</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr)</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a56acf22b23c7ff0ea8ba0c763209d0a6">XAdcPs_SelfTest</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr)</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a321d111c2a771286a7fc4b4bd8f3e744">XAdcPs_IntrEnable</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr, u32 Mask)</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a8340c0a6f59fb3ed560fbcf8fd43ac2c">XAdcPs_IntrDisable</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr, u32 Mask)</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#afc0371ab003ca92552165bfd3ced33ee">XAdcPs_IntrGetEnabled</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr)</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#a3b905da7fd36abc6ef2ea11dc6f6ec6d">XAdcPs_IntrGetStatus</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr)</td></tr>
|
||
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xadcps_8h.html#aa533b6151f09a4fa96ebfb8abd5fa519">XAdcPs_IntrClear</a> (<a class="el" href="struct_x_adc_ps.html">XAdcPs</a> *InstancePtr, u32 Mask)</td></tr>
|
||
|
</table>
|
||
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
||
|
<hr/><h2>Define Documentation</h2>
|
||
|
<a class="anchor" id="a7ab80955616330e65f29283cc62fa5cb"></a><!-- doxytag: member="xadcps.h::XADCPS_ATR_OT_LOWER" ref="a7ab80955616330e65f29283cc62fa5cb" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_ATR_OT_LOWER 7</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Lower Over Temperature limit </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a4d7a2dc7acf67238f8827b35ce22863c"></a><!-- doxytag: member="xadcps.h::XADCPS_ATR_OT_UPPER" ref="a4d7a2dc7acf67238f8827b35ce22863c" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_ATR_OT_UPPER 3</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>VCCAUX high voltage limit register </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a365097ee163084219b30593e3fc886dc"></a><!-- doxytag: member="xadcps.h::XADCPS_ATR_TEMP_LOWER" ref="a365097ee163084219b30593e3fc886dc" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_ATR_TEMP_LOWER 4</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Upper Over Temperature limit Reg </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="abb9936055691b405167548fc61cab567"></a><!-- doxytag: member="xadcps.h::XADCPS_ATR_TEMP_UPPER" ref="abb9936055691b405167548fc61cab567" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_ATR_TEMP_UPPER 0</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>High user Temperature </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a9f033674caa746489243cf47c0a3d34b"></a><!-- doxytag: member="xadcps.h::XADCPS_ATR_VBRAM_LOWER" ref="a9f033674caa746489243cf47c0a3d34b" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_ATR_VBRAM_LOWER 0xC</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>VRBAM Lower Alarm Reg, 7 Series </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a8fccf632c3ed72fe8dbe5e5a73cacbdd"></a><!-- doxytag: member="xadcps.h::XADCPS_ATR_VBRAM_UPPER_" ref="a8fccf632c3ed72fe8dbe5e5a73cacbdd" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_ATR_VBRAM_UPPER_ 8</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>VRBAM Upper Alarm Reg, 7 Series </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a68f4d450364d4a6d47bfd3c859e501bf"></a><!-- doxytag: member="xadcps.h::XADCPS_ATR_VCCAUX_LOWER" ref="a68f4d450364d4a6d47bfd3c859e501bf" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_ATR_VCCAUX_LOWER 6</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>VCCAUX low voltage limit register </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="af7ec64bbf7c7cdb10c7d0b1bd21bdb59"></a><!-- doxytag: member="xadcps.h::XADCPS_ATR_VCCAUX_UPPER" ref="af7ec64bbf7c7cdb10c7d0b1bd21bdb59" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_ATR_VCCAUX_UPPER 2</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>VCCAUX high voltage limit register </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="ab650bf9549d9da74d7edc448433c7726"></a><!-- doxytag: member="xadcps.h::XADCPS_ATR_VCCINT_LOWER" ref="ab650bf9549d9da74d7edc448433c7726" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_ATR_VCCINT_LOWER 5</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>VCCINT high voltage limit register </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="af1b941e38e172b1ffc75ca3ccdf2c2d0"></a><!-- doxytag: member="xadcps.h::XADCPS_ATR_VCCINT_UPPER" ref="af1b941e38e172b1ffc75ca3ccdf2c2d0" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_ATR_VCCINT_UPPER 1</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>VCCINT high voltage limit register </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a7adfae31cec49001437bd7eaaa90ee20"></a><!-- doxytag: member="xadcps.h::XADCPS_ATR_VCCPAUX_LOWER" ref="a7adfae31cec49001437bd7eaaa90ee20" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_ATR_VCCPAUX_LOWER 0xE</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>VCCPAUX Lower Alarm Reg , Zynq </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a16ba2a7160b86fb6bc5037e85edc52d0"></a><!-- doxytag: member="xadcps.h::XADCPS_ATR_VCCPAUX_UPPER" ref="a16ba2a7160b86fb6bc5037e85edc52d0" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_ATR_VCCPAUX_UPPER 0xA</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>VCCPAUX Upper Alarm Reg, Zynq </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="ae7bfca4338f79433f1a9a585614a643c"></a><!-- doxytag: member="xadcps.h::XADCPS_ATR_VCCPDRO_LOWER" ref="ae7bfca4338f79433f1a9a585614a643c" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_ATR_VCCPDRO_LOWER 0xF</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>VCCPDRO Lower Alarm Reg , Zynq </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="ae718153dbcfa49692e362c3d581b58da"></a><!-- doxytag: member="xadcps.h::XADCPS_ATR_VCCPDRO_UPPER" ref="ae718153dbcfa49692e362c3d581b58da" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_ATR_VCCPDRO_UPPER 0xB</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>VCCPDRO Upper Alarm Reg, Zynq </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="ae5236cec9a559096db14df95f06971e7"></a><!-- doxytag: member="xadcps.h::XADCPS_ATR_VCCPINT_LOWER" ref="ae5236cec9a559096db14df95f06971e7" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_ATR_VCCPINT_LOWER 0xD</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>VCCPINT Lower Alarm Reg , Zynq </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a27f879296da31c2bcb6af21d3c377004"></a><!-- doxytag: member="xadcps.h::XADCPS_ATR_VCCPINT_UPPER" ref="a27f879296da31c2bcb6af21d3c377004" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_ATR_VCCPINT_UPPER 9</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>VCCPINT Upper Alarm Reg, Zynq </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="adb1cdd371d22e01cecb9291b2932abc9"></a><!-- doxytag: member="xadcps.h::XADCPS_AVG_0_SAMPLES" ref="adb1cdd371d22e01cecb9291b2932abc9" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_AVG_0_SAMPLES 0</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>No Averaging </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="ad0bcaa25ff0eb1e061bd115ed25012f2"></a><!-- doxytag: member="xadcps.h::XADCPS_AVG_16_SAMPLES" ref="ad0bcaa25ff0eb1e061bd115ed25012f2" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_AVG_16_SAMPLES 1</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Average 16 samples </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a7b0e47dffe8eb913e5c47ee5d436a6d8"></a><!-- doxytag: member="xadcps.h::XADCPS_AVG_256_SAMPLES" ref="a7b0e47dffe8eb913e5c47ee5d436a6d8" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_AVG_256_SAMPLES 3</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Average 256 samples </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a6ca78ac3b39e3f901f2dce5d083a2a78"></a><!-- doxytag: member="xadcps.h::XADCPS_AVG_64_SAMPLES" ref="a6ca78ac3b39e3f901f2dce5d083a2a78" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_AVG_64_SAMPLES 2</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Average 64 samples </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="ab7a9a0302aebadbc4488f3dd13d001f6"></a><!-- doxytag: member="xadcps.h::XADCPS_CALIB_ADC_COEFF" ref="ab7a9a0302aebadbc4488f3dd13d001f6" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_CALIB_ADC_COEFF 1</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>ADC Offset Calib Coefficient </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a018dd22f5fabb275d543ca2d8ce60e43"></a><!-- doxytag: member="xadcps.h::XADCPS_CALIB_GAIN_ERROR_COEFF" ref="a018dd22f5fabb275d543ca2d8ce60e43" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_CALIB_GAIN_ERROR_COEFF 2</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Gain Error Calib Coefficient </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="aec2667004230932c5d5ebbed38ca4e96"></a><!-- doxytag: member="xadcps.h::XADCPS_CALIB_SUPPLY_COEFF" ref="aec2667004230932c5d5ebbed38ca4e96" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_CALIB_SUPPLY_COEFF 0</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Supply Offset Calib Coefficient </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a3a890ee18b909698d5b9847044ec5ac8"></a><!-- doxytag: member="xadcps.h::XADCPS_CH_ADC_CALIB" ref="a3a890ee18b909698d5b9847044ec5ac8" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_CH_ADC_CALIB 0x08</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>ADC Offset Channel Reg </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a908ab70d7b6ba30490aadc6a39609515"></a><!-- doxytag: member="xadcps.h::XADCPS_CH_AUX_MAX" ref="a908ab70d7b6ba30490aadc6a39609515" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_CH_AUX_MAX 31</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Channel number for Last Aux channel </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="ab9ea0454ee45e4f4482d553e10b961e3"></a><!-- doxytag: member="xadcps.h::XADCPS_CH_AUX_MIN" ref="ab9ea0454ee45e4f4482d553e10b961e3" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_CH_AUX_MIN 16</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Channel number for 1st Aux Channel </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a76333242081e55e8db5b38d146717b75"></a><!-- doxytag: member="xadcps.h::XADCPS_CH_GAINERR_CALIB" ref="a76333242081e55e8db5b38d146717b75" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_CH_GAINERR_CALIB 0x09</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Gain Error Channel Reg </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a70d562d928ce2dc7354be157ef39ffff"></a><!-- doxytag: member="xadcps.h::XADCPS_CH_SUPPLY_CALIB" ref="a70d562d928ce2dc7354be157ef39ffff" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_CH_SUPPLY_CALIB 0x07</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Supply Calib Data Reg </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="adea5053b3abf2d83b93ed125ff5e2255"></a><!-- doxytag: member="xadcps.h::XADCPS_CH_TEMP" ref="adea5053b3abf2d83b93ed125ff5e2255" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_CH_TEMP 0x0</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>On Chip Temperature </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a660629e3cbd893d9d2bf12fa1c7767bd"></a><!-- doxytag: member="xadcps.h::XADCPS_CH_VBRAM" ref="a660629e3cbd893d9d2bf12fa1c7767bd" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_CH_VBRAM 0x6</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>On-chip VBRAM Data Reg, 7 series </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a6816ddc0beab7c068edbff236ef16cfb"></a><!-- doxytag: member="xadcps.h::XADCPS_CH_VCCAUX" ref="a6816ddc0beab7c068edbff236ef16cfb" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_CH_VCCAUX 0x2</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>VCCAUX </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="acfc874d5131f02908cf772e8b24f628f"></a><!-- doxytag: member="xadcps.h::XADCPS_CH_VCCINT" ref="acfc874d5131f02908cf772e8b24f628f" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_CH_VCCINT 0x1</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>VCCINT </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="af8512c31afc362730ef6efbded2015d3"></a><!-- doxytag: member="xadcps.h::XADCPS_CH_VCCPAUX" ref="af8512c31afc362730ef6efbded2015d3" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_CH_VCCPAUX 0x0E</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>On-chip PS VCCPAUX Channel , Zynq </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a673ddf3fb75b0b7e17cf4081ee8c8b00"></a><!-- doxytag: member="xadcps.h::XADCPS_CH_VCCPDRO" ref="a673ddf3fb75b0b7e17cf4081ee8c8b00" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_CH_VCCPDRO 0x0F</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>On-chip PS VCCPDRO Channel , Zynq </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a8cd67708bf7ca40c46d3690391ced7fa"></a><!-- doxytag: member="xadcps.h::XADCPS_CH_VCCPINT" ref="a8cd67708bf7ca40c46d3690391ced7fa" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_CH_VCCPINT 0x0D</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>On-chip PS VCCPINT Channel , Zynq </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="acc0714183a348b546ea3e9887f3cb110"></a><!-- doxytag: member="xadcps.h::XADCPS_CH_VPVN" ref="acc0714183a348b546ea3e9887f3cb110" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_CH_VPVN 0x3</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>VP/VN Dedicated analog inputs </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="ae59cbd3b94a13841048f3ac4f7ac4e5d"></a><!-- doxytag: member="xadcps.h::XADCPS_CH_VREFN" ref="ae59cbd3b94a13841048f3ac4f7ac4e5d" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_CH_VREFN 0x5</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>VREFN </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="afea65c41f14f7d9c961e2a71eef02c69"></a><!-- doxytag: member="xadcps.h::XADCPS_CH_VREFP" ref="afea65c41f14f7d9c961e2a71eef02c69" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_CH_VREFP 0x4</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>VREFP </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a9bbae9905d2c7eddad10d93e7283944d"></a><!-- doxytag: member="xadcps.h::XADCPS_H" ref="a9bbae9905d2c7eddad10d93e7283944d" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_H</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a67e2c510d46a33e3c74e52421203f579"></a><!-- doxytag: member="xadcps.h::XAdcPs_IsEventSamplingModeSet" ref="a67e2c510d46a33e3c74e52421203f579" args="(InstancePtr)" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XAdcPs_IsEventSamplingModeSet</td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype">InstancePtr </td>
|
||
|
<td class="paramname"></td>
|
||
|
<td> ) </td>
|
||
|
<td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<b>Value:</b><div class="fragment"><pre class="fragment">(((<a class="code" href="xadcps_8c.html#a900ea66de82858d239a5936ead385ad6">XAdcPs_ReadInternalReg</a>(InstancePtr, \
|
||
|
<a class="code" href="xadcps__hw_8h.html#a0465989cda869dc6bbc0d69d1c5a53c0">XADCPS_CFR0_OFFSET</a>) & <a class="code" href="xadcps__hw_8h.html#aa13adc8f0ff2b34ec5aaa8fb9332c364">XADCPS_CFR0_EC_MASK</a>) ? \
|
||
|
TRUE : FALSE))
|
||
|
</pre></div><p>This macro checks if the XADC device is in Event 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> </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><ul>
|
||
|
<li>TRUE if the device is in Event Sampling Mode.</li>
|
||
|
<li>FALSE if the device is in Continuous Sampling Mode.</li>
|
||
|
</ul>
|
||
|
</dd></dl>
|
||
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-Style signature: int XAdcPs_IsEventSamplingMode(XAdcPs *InstancePtr); </dd></dl>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="af81492eb0831e7276ace6909b435f709"></a><!-- doxytag: member="xadcps.h::XAdcPs_IsExternalMuxModeSet" ref="af81492eb0831e7276ace6909b435f709" args="(InstancePtr)" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XAdcPs_IsExternalMuxModeSet</td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype">InstancePtr </td>
|
||
|
<td class="paramname"></td>
|
||
|
<td> ) </td>
|
||
|
<td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<b>Value:</b><div class="fragment"><pre class="fragment">(((<a class="code" href="xadcps_8c.html#a900ea66de82858d239a5936ead385ad6">XAdcPs_ReadInternalReg</a>(InstancePtr, \
|
||
|
<a class="code" href="xadcps__hw_8h.html#a0465989cda869dc6bbc0d69d1c5a53c0">XADCPS_CFR0_OFFSET</a>) & <a class="code" href="xadcps__hw_8h.html#a2eff6b4692be3abac3c6d75bb5b42cb6">XADCPS_CFR0_MUX_MASK</a>) ? \
|
||
|
TRUE : FALSE))
|
||
|
</pre></div><p>This macro checks if the XADC device is in 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> </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><ul>
|
||
|
<li>TRUE if the device is in External Mux Mode.</li>
|
||
|
<li>FALSE if the device is NOT in External Mux Mode.</li>
|
||
|
</ul>
|
||
|
</dd></dl>
|
||
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-Style signature: int XAdcPs_IsExternalMuxMode(XAdcPs *InstancePtr); </dd></dl>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="ab1c8002139e905a700006150ea45fd08"></a><!-- doxytag: member="xadcps.h::XADCPS_MAX_TEMP" ref="ab1c8002139e905a700006150ea45fd08" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_MAX_TEMP 0</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Maximum Temperature Data </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="ac40249d391ea45fea29af1dec67f63b8"></a><!-- doxytag: member="xadcps.h::XADCPS_MAX_VBRAM" ref="ac40249d391ea45fea29af1dec67f63b8" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_MAX_VBRAM 3</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Maximum VBRAM Data </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a1d060e11b4682e9be7d7653db2dd9b19"></a><!-- doxytag: member="xadcps.h::XADCPS_MAX_VCCAUX" ref="a1d060e11b4682e9be7d7653db2dd9b19" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_MAX_VCCAUX 2</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Maximum VCCAUX Data </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a5443382eef1629daa0f25033139571e9"></a><!-- doxytag: member="xadcps.h::XADCPS_MAX_VCCINT" ref="a5443382eef1629daa0f25033139571e9" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_MAX_VCCINT 1</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Maximum VCCINT Data </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a026ef03a5ad93fd7573316e27c935a7e"></a><!-- doxytag: member="xadcps.h::XADCPS_MAX_VCCPAUX" ref="a026ef03a5ad93fd7573316e27c935a7e" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_MAX_VCCPAUX 9</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Maximum VCCPAUX Register , Zynq </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a73ea1353b5dc0cb7db31b4fcce40a427"></a><!-- doxytag: member="xadcps.h::XADCPS_MAX_VCCPDRO" ref="a73ea1353b5dc0cb7db31b4fcce40a427" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_MAX_VCCPDRO 0xA</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Maximum VCCPDRO Register , Zynq </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="ab1dc807e5fcaaca70ddad267413e48f0"></a><!-- doxytag: member="xadcps.h::XADCPS_MAX_VCCPINT" ref="ab1dc807e5fcaaca70ddad267413e48f0" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_MAX_VCCPINT 8</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Maximum VCCPINT Register , Zynq </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="aadfe3a185c836f8b5eaef2e33cbcbcea"></a><!-- doxytag: member="xadcps.h::XADCPS_MIN_TEMP" ref="aadfe3a185c836f8b5eaef2e33cbcbcea" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_MIN_TEMP 4</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Minimum Temperature Data </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="aeb9d6818a3af6e0300a2f5de5dca25f3"></a><!-- doxytag: member="xadcps.h::XADCPS_MIN_VBRAM" ref="aeb9d6818a3af6e0300a2f5de5dca25f3" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_MIN_VBRAM 7</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Minimum VBRAM Data </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="ab7c654ea90be1084090ffcc218b577bd"></a><!-- doxytag: member="xadcps.h::XADCPS_MIN_VCCAUX" ref="ab7c654ea90be1084090ffcc218b577bd" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_MIN_VCCAUX 6</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Minimum VCCAUX Data </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="acbc8534b2da01747971ebd9b8561ba0e"></a><!-- doxytag: member="xadcps.h::XADCPS_MIN_VCCINT" ref="acbc8534b2da01747971ebd9b8561ba0e" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_MIN_VCCINT 5</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Minimum VCCINT Data </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="af60a6e1f1f63ea196e5c138cc3756e59"></a><!-- doxytag: member="xadcps.h::XADCPS_MIN_VCCPAUX" ref="af60a6e1f1f63ea196e5c138cc3756e59" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_MIN_VCCPAUX 0xD</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Minimum VCCPAUX Register , Zynq </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="afbd736b9054a9ab04dd13dff1b20b352"></a><!-- doxytag: member="xadcps.h::XADCPS_MIN_VCCPDRO" ref="afbd736b9054a9ab04dd13dff1b20b352" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_MIN_VCCPDRO 0xE</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Minimum VCCPDRO Register , Zynq </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a1c0280513d645840fd3791046b5f3e9d"></a><!-- doxytag: member="xadcps.h::XADCPS_MIN_VCCPINT" ref="a1c0280513d645840fd3791046b5f3e9d" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_MIN_VCCPINT 0xC</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Minimum VCCPINT Register , Zynq </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a0c71f14f278fbefe7e6a4d6f82a77865"></a><!-- doxytag: member="xadcps.h::XADCPS_PD_MODE_ADCB" ref="a0c71f14f278fbefe7e6a4d6f82a77865" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_PD_MODE_ADCB 1</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Power Down ADC B </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="af1aed807494f2f8d5e63b1c270581dcb"></a><!-- doxytag: member="xadcps.h::XADCPS_PD_MODE_NONE" ref="af1aed807494f2f8d5e63b1c270581dcb" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_PD_MODE_NONE 0</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>No Power Down </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a4fab650f2a8839ff3bc3b02473977fd6"></a><!-- doxytag: member="xadcps.h::XADCPS_PD_MODE_XADC" ref="a4fab650f2a8839ff3bc3b02473977fd6" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_PD_MODE_XADC 2</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Power Down ADC A and ADC B </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a5963e24ffc2977cbc40d089877e45639"></a><!-- doxytag: member="xadcps.h::XAdcPs_RawToTemperature" ref="a5963e24ffc2977cbc40d089877e45639" args="(AdcData)" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XAdcPs_RawToTemperature</td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype">AdcData </td>
|
||
|
<td class="paramname"></td>
|
||
|
<td> ) </td>
|
||
|
<td> ((((float)(AdcData)/65536.0f)/0.00198421639f ) - 273.15f)</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>This macro converts XADC Raw Data to Temperature(centigrades).</p>
|
||
|
<dl><dt><b>Parameters:</b></dt><dd>
|
||
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
<tr><td valign="top"></td><td valign="top"><em>AdcData</em> </td><td>is the Raw ADC Data from XADC.</td></tr>
|
||
|
</table>
|
||
|
</dd>
|
||
|
</dl>
|
||
|
<dl class="return"><dt><b>Returns:</b></dt><dd>The Temperature in centigrades.</dd></dl>
|
||
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-Style signature: float <a class="el" href="xadcps_8h.html#a5963e24ffc2977cbc40d089877e45639">XAdcPs_RawToTemperature(u32 AdcData)</a>; </dd></dl>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a87a27bb34c70dadaa6be27c83058ad21"></a><!-- doxytag: member="xadcps.h::XAdcPs_RawToVoltage" ref="a87a27bb34c70dadaa6be27c83058ad21" args="(AdcData)" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XAdcPs_RawToVoltage</td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype">AdcData </td>
|
||
|
<td class="paramname"></td>
|
||
|
<td> ) </td>
|
||
|
<td> ((((float)(AdcData))* (3.0f))/65536.0f)</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>This macro converts XADC/ADC Raw Data to Voltage(volts).</p>
|
||
|
<dl><dt><b>Parameters:</b></dt><dd>
|
||
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
<tr><td valign="top"></td><td valign="top"><em>AdcData</em> </td><td>is the XADC/ADC Raw Data.</td></tr>
|
||
|
</table>
|
||
|
</dd>
|
||
|
</dl>
|
||
|
<dl class="return"><dt><b>Returns:</b></dt><dd>The Voltage in volts.</dd></dl>
|
||
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-Style signature: float <a class="el" href="xadcps_8h.html#a87a27bb34c70dadaa6be27c83058ad21">XAdcPs_RawToVoltage(u32 AdcData)</a>; </dd></dl>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="aaf38a240a16e53a6afb6977113e3c3e1"></a><!-- doxytag: member="xadcps.h::XAdcPs_ReadFifo" ref="aaf38a240a16e53a6afb6977113e3c3e1" args="(InstancePtr)" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XAdcPs_ReadFifo</td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype">InstancePtr </td>
|
||
|
<td class="paramname"></td>
|
||
|
<td> ) </td>
|
||
|
<td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xadcps__hw_8h.html#a2bb7416cfd483de37442d6c4db638cf6">XAdcPs_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
||
|
<a class="code" href="xadcps__hw_8h.html#a55935eddc71fef7540acc37423456980">XADCPS_RDFIFO_OFFSET</a>);
|
||
|
</pre></div><p>This macro 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> </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>Data read from the FIFO</dd></dl>
|
||
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-Style signature: u32 <a class="el" href="xadcps_8h.html#aaf38a240a16e53a6afb6977113e3c3e1">XAdcPs_ReadFifo(XAdcPs *InstancePtr)</a>; </dd></dl>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a8f057289da345bfc62938fcd13d88512"></a><!-- doxytag: member="xadcps.h::XADCPS_SEQ_MODE_CONTINPASS" ref="a8f057289da345bfc62938fcd13d88512" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_SEQ_MODE_CONTINPASS 2</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Continuous Cycling Sequencer </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="ac3a1e362d43ca6272a84b477205ef29a"></a><!-- doxytag: member="xadcps.h::XADCPS_SEQ_MODE_INDEPENDENT" ref="ac3a1e362d43ca6272a84b477205ef29a" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_SEQ_MODE_INDEPENDENT 8</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Independent mode </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="ae1fbdfce66254dfb53e62a7a389e24c3"></a><!-- doxytag: member="xadcps.h::XADCPS_SEQ_MODE_ONEPASS" ref="ae1fbdfce66254dfb53e62a7a389e24c3" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_SEQ_MODE_ONEPASS 1</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Onepass through Sequencer </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a799c7fbcb2e7fd3f27b780f56d764844"></a><!-- doxytag: member="xadcps.h::XADCPS_SEQ_MODE_SAFE" ref="a799c7fbcb2e7fd3f27b780f56d764844" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_SEQ_MODE_SAFE 0</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Default Safe Mode </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="acb64b12f9a6758ebb0adfbe9c4b08c53"></a><!-- doxytag: member="xadcps.h::XADCPS_SEQ_MODE_SIMUL_SAMPLING" ref="acb64b12f9a6758ebb0adfbe9c4b08c53" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_SEQ_MODE_SIMUL_SAMPLING 4</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Simultaneous sampling </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="af9ef5e521cabdd0a008c5617687fca84"></a><!-- doxytag: member="xadcps.h::XADCPS_SEQ_MODE_SINGCHAN" ref="af9ef5e521cabdd0a008c5617687fca84" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XADCPS_SEQ_MODE_SINGCHAN 3</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Single channel -No Sequencing </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="aacca1d43ff3854002cf54e4b4989f3b8"></a><!-- doxytag: member="xadcps.h::XAdcPs_TemperatureToRaw" ref="aacca1d43ff3854002cf54e4b4989f3b8" args="(Temperature)" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XAdcPs_TemperatureToRaw</td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype">Temperature </td>
|
||
|
<td class="paramname"></td>
|
||
|
<td> ) </td>
|
||
|
<td> ((int)(((Temperature) + 273.15f)*65536.0f*0.00198421639f))</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>This macro converts Temperature in centigrades to XADC/ADC Raw Data.</p>
|
||
|
<dl><dt><b>Parameters:</b></dt><dd>
|
||
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
<tr><td valign="top"></td><td valign="top"><em>Temperature</em> </td><td>is the Temperature in centigrades to be converted to XADC/ADC Raw Data.</td></tr>
|
||
|
</table>
|
||
|
</dd>
|
||
|
</dl>
|
||
|
<dl class="return"><dt><b>Returns:</b></dt><dd>The XADC/ADC Raw Data.</dd></dl>
|
||
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-Style signature: int <a class="el" href="xadcps_8h.html#aacca1d43ff3854002cf54e4b4989f3b8">XAdcPs_TemperatureToRaw(float Temperature)</a>; </dd></dl>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a38cad68c817e99d6fd7359a3a3175062"></a><!-- doxytag: member="xadcps.h::XAdcPs_VoltageToRaw" ref="a38cad68c817e99d6fd7359a3a3175062" args="(Voltage)" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XAdcPs_VoltageToRaw</td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype">Voltage </td>
|
||
|
<td class="paramname"></td>
|
||
|
<td> ) </td>
|
||
|
<td> ((int)((Voltage)*65536.0f/3.0f))</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>This macro converts Voltage in Volts to XADC/ADC Raw Data.</p>
|
||
|
<dl><dt><b>Parameters:</b></dt><dd>
|
||
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
<tr><td valign="top"></td><td valign="top"><em>Voltage</em> </td><td>is the Voltage in volts to be converted to XADC/ADC Raw Data.</td></tr>
|
||
|
</table>
|
||
|
</dd>
|
||
|
</dl>
|
||
|
<dl class="return"><dt><b>Returns:</b></dt><dd>The XADC/ADC Raw Data.</dd></dl>
|
||
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-Style signature: int <a class="el" href="xadcps_8h.html#a38cad68c817e99d6fd7359a3a3175062">XAdcPs_VoltageToRaw(float Voltage)</a>; </dd></dl>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a1ef487633f003d94a16459f6a5e7f7f5"></a><!-- doxytag: member="xadcps.h::XAdcPs_WriteFifo" ref="a1ef487633f003d94a16459f6a5e7f7f5" args="(InstancePtr, Data)" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">#define XAdcPs_WriteFifo</td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype">InstancePtr, </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td class="paramkey"></td>
|
||
|
<td></td>
|
||
|
<td class="paramtype">Data </td>
|
||
|
<td class="paramname"></td>
|
||
|
<td> ) </td>
|
||
|
<td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xadcps__hw_8h.html#a48770272099dfc236414809f6ac0f911">XAdcPs_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
||
|
<a class="code" href="xadcps__hw_8h.html#a87a13d19d9821e32eae2fd813cf7d99d">XADCPS_CMDFIFO_OFFSET</a>, Data);
|
||
|
</pre></div><p>This macro is used for writing to the 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> </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>C-Style signature: void <a class="el" href="xadcps_8h.html#a1ef487633f003d94a16459f6a5e7f7f5">XAdcPs_WriteFifo(XAdcPs *InstancePtr, u32 Data)</a>; </dd></dl>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<hr/><h2>Function Documentation</h2>
|
||
|
<a class="anchor" id="a57807452402a6b52dd48083f676bd4ff"></a><!-- doxytag: member="xadcps.h::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> * </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> * </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>Functions in <a class="el" href="xadcps_8c.html">xadcps.c</a></p>
|
||
|
<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> </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> </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> </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.h::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> * </td>
|
||
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
<td> ) </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> </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.h::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> * </td>
|
||
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
<td> ) </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> </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.h::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> * </td>
|
||
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
<td> ) </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> </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.h::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> * </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>Channel</em></td><td> </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> </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> </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.h::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> * </td>
|
||
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
<td> ) </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> </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="a7663e26d050b8810fb79788d8a017f65"></a><!-- doxytag: member="xadcps.h::XAdcPs_GetAlarmOutputStatus" ref="a7663e26d050b8810fb79788d8a017f65" args="(XAdcPs *InstancePtr)" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">u32 XAdcPs_GetAlarmOutputStatus </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> * </td>
|
||
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
<td> ) </td>
|
||
|
<td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a486398d4b0619f38c1e9b0893f1f7bb3"></a><!-- doxytag: member="xadcps.h::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> * </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>AlarmThrReg</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 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> </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> </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.h::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> * </td>
|
||
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
<td> ) </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> </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.h::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> * </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>CoeffType</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 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> </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> </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.h::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> * </td>
|
||
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
<td> ) </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> </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="a4cecd7eded845124675357247a87bd2b"></a><!-- doxytag: member="xadcps.h::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> * </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>MeasurementType</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 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> </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> </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="ade5ed9cc4af7327d8d8e9c90c967c7fe"></a><!-- doxytag: member="xadcps.h::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> * </td>
|
||
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
<td> ) </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> </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.h::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> * </td>
|
||
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
<td> ) </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> </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.h::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> * </td>
|
||
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
<td> ) </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> </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.h::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> * </td>
|
||
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
<td> ) </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> </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.h::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> * </td>
|
||
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
<td> ) </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> </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.h::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> * </td>
|
||
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
<td> ) </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> </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.h::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> * </td>
|
||
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
<td> ) </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> </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="ad108c115f48bd5f8f57cf92b70136557"></a><!-- doxytag: member="xadcps.h::XAdcPs_GetStatus" ref="ad108c115f48bd5f8f57cf92b70136557" args="(XAdcPs *InstancePtr)" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">u32 XAdcPs_GetStatus </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> * </td>
|
||
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
<td> ) </td>
|
||
|
<td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="aa533b6151f09a4fa96ebfb8abd5fa519"></a><!-- doxytag: member="xadcps.h::XAdcPs_IntrClear" ref="aa533b6151f09a4fa96ebfb8abd5fa519" args="(XAdcPs *InstancePtr, u32 Mask)" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">void XAdcPs_IntrClear </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</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>Mask</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 clears the specified interrupts in the Interrupt Status Register (IPISR).</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_adc_ps.html">XAdcPs</a> instance. </td></tr>
|
||
|
<tr><td valign="top"></td><td valign="top"><em>Mask</em> </td><td>is the bit-mask of the interrupts to be cleared. Bit positions of 1 will be cleared. Bit positions of 0 will not change the previous interrupt status. This mask is formed by OR'ing XADCPS_IPIXR_* bits which are 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>None. </dd></dl>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a8340c0a6f59fb3ed560fbcf8fd43ac2c"></a><!-- doxytag: member="xadcps.h::XAdcPs_IntrDisable" ref="a8340c0a6f59fb3ed560fbcf8fd43ac2c" args="(XAdcPs *InstancePtr, u32 Mask)" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">void XAdcPs_IntrDisable </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</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>Mask</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 disables the specified interrupts 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> </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>Mask</em> </td><td>is the bit-mask of the interrupts to be disabled. Bit positions of 1 will be disabled. Bit positions of 0 will keep the previous setting. This mask is formed by OR'ing XADCPS_INTX_* bits 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>None </dd></dl>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a321d111c2a771286a7fc4b4bd8f3e744"></a><!-- doxytag: member="xadcps.h::XAdcPs_IntrEnable" ref="a321d111c2a771286a7fc4b4bd8f3e744" args="(XAdcPs *InstancePtr, u32 Mask)" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">void XAdcPs_IntrEnable </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</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>Mask</em></td><td> </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td></td>
|
||
|
<td>)</td>
|
||
|
<td></td><td></td><td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Functions in <a class="el" href="xadcps__intr_8c.html">xadcps_intr.c</a></p>
|
||
|
<p>This function enables the specified interrupts 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> </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>Mask</em> </td><td>is the bit-mask of the interrupts to be enabled. Bit positions of 1 will be enabled. Bit positions of 0 will keep the previous setting. This mask is formed by OR'ing XADCPS_INTX_* bits 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>None. </dd></dl>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="afc0371ab003ca92552165bfd3ced33ee"></a><!-- doxytag: member="xadcps.h::XAdcPs_IntrGetEnabled" ref="afc0371ab003ca92552165bfd3ced33ee" args="(XAdcPs *InstancePtr)" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">u32 XAdcPs_IntrGetEnabled </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> * </td>
|
||
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
<td> ) </td>
|
||
|
<td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>This function returns the enabled interrupts read from the Interrupt Mask Register (IPIER). Use the XADCPS_IPIXR_* constants defined in <a class="el" href="xadcps__hw_8h.html">xadcps_hw.h</a> to interpret the returned value.</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_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 I.</dd></dl>
|
||
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a3b905da7fd36abc6ef2ea11dc6f6ec6d"></a><!-- doxytag: member="xadcps.h::XAdcPs_IntrGetStatus" ref="a3b905da7fd36abc6ef2ea11dc6f6ec6d" args="(XAdcPs *InstancePtr)" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">u32 XAdcPs_IntrGetStatus </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> * </td>
|
||
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
<td> ) </td>
|
||
|
<td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>This function returns the interrupt status read from Interrupt Status Register(IPISR). Use the XADCPS_IPIXR_* constants defined in <a class="el" href="xadcps__hw_8h.html">xadcps_hw.h</a> to interpret the returned value.</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_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 IPISR.</dd></dl>
|
||
|
<dl class="note"><dt><b>Note:</b></dt><dd>The device must be configured at hardware build time to include interrupt component for this function to work. </dd></dl>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="ae1c891154549887e7e99466fe0c90656"></a><!-- doxytag: member="xadcps.h::XAdcPs_LookupConfig" ref="ae1c891154549887e7e99466fe0c90656" args="(u16 DeviceId)" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname"><a class="el" href="struct_x_adc_ps___config.html">XAdcPs_Config</a>* XAdcPs_LookupConfig </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype">u16 </td>
|
||
|
<td class="paramname"> <em>DeviceId</em></td>
|
||
|
<td> ) </td>
|
||
|
<td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Functions in <a class="el" href="xadcps__sinit_8c.html">xadcps_sinit.c</a></p>
|
||
|
<p>This function looks up the device configuration based on the unique device ID. The table XAdcPs_ConfigTable contains the configuration info for each device in the system.</p>
|
||
|
<dl><dt><b>Parameters:</b></dt><dd>
|
||
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
<tr><td valign="top"></td><td valign="top"><em>DeviceId</em> </td><td>contains the ID of the device for which the device configuration pointer is to be returned.</td></tr>
|
||
|
</table>
|
||
|
</dd>
|
||
|
</dl>
|
||
|
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
|
||
|
<li>A pointer to the configuration found.</li>
|
||
|
<li>NULL if the specified device ID was not found.</li>
|
||
|
</ul>
|
||
|
</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.h::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> * </td>
|
||
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
<td> ) </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> </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="a56acf22b23c7ff0ea8ba0c763209d0a6"></a><!-- doxytag: member="xadcps.h::XAdcPs_SelfTest" ref="a56acf22b23c7ff0ea8ba0c763209d0a6" args="(XAdcPs *InstancePtr)" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">int XAdcPs_SelfTest </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> * </td>
|
||
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
<td> ) </td>
|
||
|
<td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
<p>Functions in <a class="el" href="xadcps__selftest_8c.html">xadcps_selftest.c</a></p>
|
||
|
<p>Run a self-test on the driver/device. The test</p>
|
||
|
<ul>
|
||
|
<li>Resets the device,</li>
|
||
|
<li>Writes a value into the Alarm Threshold register and reads it back for comparison.</li>
|
||
|
<li>Resets the device again.</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_adc_ps.html">XAdcPs</a> instance.</td></tr>
|
||
|
</table>
|
||
|
</dd>
|
||
|
</dl>
|
||
|
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
|
||
|
<li>XST_SUCCESS if the value read from the Alarm Threshold register is the same as the value written.</li>
|
||
|
<li>XST_FAILURE Otherwise</li>
|
||
|
</ul>
|
||
|
</dd></dl>
|
||
|
<dl class="note"><dt><b>Note:</b></dt><dd>This is a destructive test in that resets of the device are performed. Refer to the device specification for the device status after the reset operation. </dd></dl>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a533b23d4d7b4e0bee4517b0ae0329576"></a><!-- doxytag: member="xadcps.h::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> * </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>Divisor</em></td><td> </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> </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> </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.h::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> * </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>AlmEnableMask</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 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> </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> </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.h::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> * </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>AlarmThrReg</em>, </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td class="paramkey"></td>
|
||
|
<td></td>
|
||
|
<td class="paramtype">u16 </td>
|
||
|
<td class="paramname"> <em>Value</em></td><td> </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> </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> </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> </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.h::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> * </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>Average</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 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> </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> </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.h::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> * </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>Calibration</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 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> </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> </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="a78ab54803a8e6e9993de88523fdc93ab"></a><!-- doxytag: member="xadcps.h::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> * </td>
|
||
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td class="paramkey"></td>
|
||
|
<td></td>
|
||
|
<td class="paramtype">int </td>
|
||
|
<td class="paramname"> <em>MuxMode</em>, </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td class="paramkey"></td>
|
||
|
<td></td>
|
||
|
<td class="paramtype">u8 </td>
|
||
|
<td class="paramname"> <em>Channel</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 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> </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> </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> </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.h::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> * </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>Mode</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 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> </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> </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.h::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> * </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>AcqCyclesChMask</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 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> </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> </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.h::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> * </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>AvgEnableChMask</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 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> </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> </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.h::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> * </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>ChEnableMask</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 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> </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> </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.h::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> * </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>InputModeChMask</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 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> </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> </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.h::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> * </td>
|
||
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td class="paramkey"></td>
|
||
|
<td></td>
|
||
|
<td class="paramtype">int </td>
|
||
|
<td class="paramname"> <em>IsEventMode</em></td><td> </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> </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> </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.h::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> * </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>SequencerMode</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 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> </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> </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.h::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> * </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>Channel</em>, </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td class="paramkey"></td>
|
||
|
<td></td>
|
||
|
<td class="paramtype">int </td>
|
||
|
<td class="paramname"> <em>IncreaseAcqCycles</em>, </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td class="paramkey"></td>
|
||
|
<td></td>
|
||
|
<td class="paramtype">int </td>
|
||
|
<td class="paramname"> <em>IsEventMode</em>, </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td class="paramkey"></td>
|
||
|
<td></td>
|
||
|
<td class="paramtype">int </td>
|
||
|
<td class="paramname"> <em>IsDifferentialMode</em></td><td> </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> </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> </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> </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> </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="af493491f2c830a07319d54ff847d09f4"></a><!-- doxytag: member="xadcps.h::XAdcPs_StartAdcConversion" ref="af493491f2c830a07319d54ff847d09f4" args="(XAdcPs *InstancePtr)" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">void XAdcPs_StartAdcConversion </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype"><a class="el" href="struct_x_adc_ps.html">XAdcPs</a> * </td>
|
||
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
<td> ) </td>
|
||
|
<td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
</div>
|
||
|
<p class="Copyright">
|
||
|
Copyright © 1995-2014 Xilinx, Inc. All rights reserved.
|
||
|
</p>
|
||
|
</body>
|
||
|
</html>
|