stv0g/embeddedsw
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
embeddedsw/lib/bsp/standalone/doc/html/api/xil__assert_8h.html
Jagannadha Sutradharudu Teki 2c8f92039d embeddesw: Add initial code support 
Added initial support Xilinx Embedded Software.

Signed-off-by: Jagannadha Sutradharudu Teki <jaganna@xilinx.com>
2014-06-24 16:45:01 +05:30

388 lines
19 KiB
HTML
Executable file
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>2014.1_doc: xil_assert.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="dir_U_3A_2Fdoxygen_5Fpublish_2Fsources_2Fbsp_2Fstandalone_5Fv4_5F0_2Fsrc_2Fcommon_2F.html">common</a></div>
<h1>xil_assert.h File Reference</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xil__assert_8h.html#b79b5d4edfac7329eaa10eca008dd10e">Xil_AssertVoid</a>(Expression)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xil__assert_8h.html#b249eb365b88ec749541c7556fd5558c">Xil_AssertNonvoid</a>(Expression)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xil__assert_8h.html#77e317af6d95e5bcb6a6139a70e43e06">Xil_AssertVoidAlways</a>()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xil__assert_8h.html#452f2df1bdb4094ce0a13330853521b3">Xil_AssertNonvoidAlways</a>()</td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xil__assert_8h.html#3a9ba7952fcdc8a3feea8ef171e743bb">Xil_AssertCallback</a> )(const char *File, int Line)</td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xil__assert_8h.html#eac679f31c9929c85ada076781356c87">Xil_Assert</a> (const char *, int)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xil__assert_8h.html#c65d9a4f8c34bd079be1482f8e48fa4f">XNullHandler</a> (void *NullParameter)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xil__assert_8h.html#032a9f5e305da92f31810d6321f57855">Xil_AssertSetCallback</a> (<a class="el" href="xil__assert_8h.html#3a9ba7952fcdc8a3feea8ef171e743bb">Xil_AssertCallback</a> Routine)</td></tr>
<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xil__assert_8h.html#ca44cbe190b81591846845bbff386d45">Xil_AssertStatus</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This file contains assert related functions.<p>
<pre>
MODIFICATION HISTORY:</pre><p>
<pre> Ver Who Date Changes
----- ---- -------- -------------------------------------------------------
1.00a hbm 07/14/09 First release
</pre> <hr><h2>Define Documentation</h2>
<a class="anchor" name="b249eb365b88ec749541c7556fd5558c"></a><!-- doxytag: member="xil_assert.h::Xil_AssertNonvoid" ref="b249eb365b88ec749541c7556fd5558c" args="(Expression)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define Xil_AssertNonvoid </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">Expression&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre class="fragment">{ \
<span class="keywordflow">if</span> (Expression) { \
<a class="code" href="xil__assert_8c.html#ca44cbe190b81591846845bbff386d45">Xil_AssertStatus</a> = XIL_ASSERT_NONE; \
} <span class="keywordflow">else</span> { \
<a class="code" href="xil__assert_8c.html#3bc8989a14448c09ee8b43d1ace72ff3">Xil_Assert</a>(__FILE__, __LINE__); \
<a class="code" href="xil__assert_8c.html#ca44cbe190b81591846845bbff386d45">Xil_AssertStatus</a> = XIL_ASSERT_OCCURRED; \
<span class="keywordflow">return</span> 0; \
} \
}
</pre></div>This assert macro is to be used for functions that do return a value. This in conjunction with the Xil_AssertWait boolean can be used to accomodate tests so that asserts which fail allow execution to continue.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>expression</em>&nbsp;</td><td>is the expression to evaluate. If it evaluates to false, the assert occurs.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Returns 0 unless the Xil_AssertWait variable is true, in which case no return is made and an infinite loop is entered.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="452f2df1bdb4094ce0a13330853521b3"></a><!-- doxytag: member="xil_assert.h::Xil_AssertNonvoidAlways" ref="452f2df1bdb4094ce0a13330853521b3" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define Xil_AssertNonvoidAlways </td>
<td class="md" valign="top">(&nbsp;</td>
&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre class="fragment">{ \
<a class="code" href="xil__assert_8c.html#3bc8989a14448c09ee8b43d1ace72ff3">Xil_Assert</a>(__FILE__, __LINE__); \
<a class="code" href="xil__assert_8c.html#ca44cbe190b81591846845bbff386d45">Xil_AssertStatus</a> = XIL_ASSERT_OCCURRED; \
<span class="keywordflow">return</span> 0; \
}
</pre></div>Always assert. This assert macro is to be used for functions that do return a value. Use for instances where an assert should always occur.<p>
<dl compact><dt><b>Returns:</b></dt><dd>Returns void unless the Xil_AssertWait variable is true, in which case no return is made and an infinite loop is entered.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="b79b5d4edfac7329eaa10eca008dd10e"></a><!-- doxytag: member="xil_assert.h::Xil_AssertVoid" ref="b79b5d4edfac7329eaa10eca008dd10e" args="(Expression)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define Xil_AssertVoid </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">Expression&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre class="fragment">{ \
<span class="keywordflow">if</span> (Expression) { \
<a class="code" href="xil__assert_8c.html#ca44cbe190b81591846845bbff386d45">Xil_AssertStatus</a> = XIL_ASSERT_NONE; \
} <span class="keywordflow">else</span> { \
<a class="code" href="xil__assert_8c.html#3bc8989a14448c09ee8b43d1ace72ff3">Xil_Assert</a>(__FILE__, __LINE__); \
<a class="code" href="xil__assert_8c.html#ca44cbe190b81591846845bbff386d45">Xil_AssertStatus</a> = XIL_ASSERT_OCCURRED; \
<span class="keywordflow">return</span>; \
} \
}
</pre></div>This assert macro is to be used for functions that do not return anything (void). This in conjunction with the Xil_AssertWait boolean can be used to accomodate tests so that asserts which fail allow execution to continue.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>expression</em>&nbsp;</td><td>is the expression to evaluate. If it evaluates to false, the assert occurs.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Returns void unless the Xil_AssertWait variable is true, in which case no return is made and an infinite loop is entered.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="77e317af6d95e5bcb6a6139a70e43e06"></a><!-- doxytag: member="xil_assert.h::Xil_AssertVoidAlways" ref="77e317af6d95e5bcb6a6139a70e43e06" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define Xil_AssertVoidAlways </td>
<td class="md" valign="top">(&nbsp;</td>
&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre class="fragment">{ \
<a class="code" href="xil__assert_8c.html#3bc8989a14448c09ee8b43d1ace72ff3">Xil_Assert</a>(__FILE__, __LINE__); \
<a class="code" href="xil__assert_8c.html#ca44cbe190b81591846845bbff386d45">Xil_AssertStatus</a> = XIL_ASSERT_OCCURRED; \
<span class="keywordflow">return</span>; \
}
</pre></div>Always assert. This assert macro is to be used for functions that do not return anything (void). Use for instances where an assert should always occur.<p>
<dl compact><dt><b>Returns:</b></dt><dd>Returns void unless the Xil_AssertWait variable is true, in which case no return is made and an infinite loop is entered.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</td>
</tr>
</table>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="3a9ba7952fcdc8a3feea8ef171e743bb"></a><!-- doxytag: member="xil_assert.h::Xil_AssertCallback" ref="3a9ba7952fcdc8a3feea8ef171e743bb" args=")(const char *File, int Line)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">typedef void(* <a class="el" href="xil__assert_8h.html#3a9ba7952fcdc8a3feea8ef171e743bb">Xil_AssertCallback</a>)(const char *File, int Line) </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This data type defines a callback to be invoked when an assert occurs. The callback is invoked only when asserts are enabled </td>
</tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="eac679f31c9929c85ada076781356c87"></a><!-- doxytag: member="xil_assert.h::Xil_Assert" ref="eac679f31c9929c85ada076781356c87" args="(const char *, int)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void Xil_Assert </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const char *&nbsp;</td>
<td class="mdname" nowrap> <em>File</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int&nbsp;</td>
<td class="mdname" nowrap> <em>Line</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Implement assert. Currently, it calls a user-defined callback function if one has been set. Then, it potentially enters an infinite loop depending on the value of the Xil_AssertWait variable.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>file</em>&nbsp;</td><td>is the name of the filename of the source </td></tr>
<tr><td valign="top"></td><td valign="top"><em>line</em>&nbsp;</td><td>is the linenumber within File</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="032a9f5e305da92f31810d6321f57855"></a><!-- doxytag: member="xil_assert.h::Xil_AssertSetCallback" ref="032a9f5e305da92f31810d6321f57855" args="(Xil_AssertCallback Routine)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void Xil_AssertSetCallback </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="xil__assert_8h.html#3a9ba7952fcdc8a3feea8ef171e743bb">Xil_AssertCallback</a>&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>Routine</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set up a callback function to be invoked when an assert occurs. If there was already a callback installed, then it is replaced.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>routine</em>&nbsp;</td><td>is the callback to be invoked when an assert is taken</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>This function has no effect if NDEBUG is set </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="c65d9a4f8c34bd079be1482f8e48fa4f"></a><!-- doxytag: member="xil_assert.h::XNullHandler" ref="c65d9a4f8c34bd079be1482f8e48fa4f" args="(void *NullParameter)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void XNullHandler </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">void *&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>NullParameter</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Null handler function. This follows the XInterruptHandler signature for interrupt handlers. It can be used to assign a null handler (a stub) to an interrupt controller vector table.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>NullParameter</em>&nbsp;</td><td>is an arbitrary void pointer and not used.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</td>
</tr>
</table>
<hr><h2>Variable Documentation</h2>
<a class="anchor" name="ca44cbe190b81591846845bbff386d45"></a><!-- doxytag: member="xil_assert.h::Xil_AssertStatus" ref="ca44cbe190b81591846845bbff386d45" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">unsigned int <a class="el" href="xil__assert_8h.html#ca44cbe190b81591846845bbff386d45">Xil_AssertStatus</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This variable allows testing to be done easier with asserts. An assert sets this variable such that a driver can evaluate this variable to determine if an assert occurred. </td>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Thu Feb 13 14:48:12 2014 for 2014.1_doc by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.5 </small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink