Commit 02a663f2 authored by Philippe Gerum's avatar Philippe Gerum

Regenerate documentation

parent f0e15ba6
......@@ -2,133 +2,152 @@
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Xenomai API: include/native/alarm.h Source File</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.2 -->
<div class="qindex"> <form class="search" action="search.php" method="get">
<a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <span class="search"><u>S</u>earch&nbsp;for&nbsp;<input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div>
<div class="nav">
<a class="el" href="dir_000000.html">include</a>&nbsp;/&nbsp;<a class="el" href="dir_000001.html">native</a></div>
<h1>alarm.h</h1><a href="alarm_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001
00022 <span class="preprocessor">#ifndef _XENO_ALARM_H</span>
00023 <span class="preprocessor"></span><span class="preprocessor">#define _XENO_ALARM_H</span>
00024 <span class="preprocessor"></span>
00025 <span class="preprocessor">#include &lt;nucleus/timer.h&gt;</span>
00026 <span class="preprocessor">#include &lt;nucleus/synch.h&gt;</span>
00027 <span class="preprocessor">#include &lt;<a class="code" href="native_2types_8h.html">native/types.h</a>&gt;</span>
00028
00029 <span class="keyword">typedef</span> <span class="keyword">struct </span>rt_alarm_info {
00030
00031 RTIME expiration; <span class="comment">/* !&lt; Expiration date. */</span>
00032
00033 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> expiries; <span class="comment">/* !&lt; Number of expiries. */</span>
00034
00035 <span class="keywordtype">char</span> name[XNOBJECT_NAME_LEN]; <span class="comment">/* !&lt; Symbolic name. */</span>
00036
00037 } RT_ALARM_INFO;
00038
00039 <span class="keyword">typedef</span> <span class="keyword">struct </span>rt_alarm_placeholder {
00040 xnhandle_t opaque;
00041 } RT_ALARM_PLACEHOLDER;
00042
00043 <span class="preprocessor">#if defined(__KERNEL__) || defined(__XENO_SIM__)</span>
00044 <span class="preprocessor"></span>
00045 <span class="preprocessor">#define XENO_ALARM_MAGIC 0x55550909</span>
00046 <span class="preprocessor"></span>
00047 <span class="keyword">typedef</span> <span class="keyword">struct </span>rt_alarm {
00048
00049 <span class="keywordtype">unsigned</span> magic; <span class="comment">/* !&lt; Magic code - must be first */</span>
00050
00051 xntimer_t timer_base; <span class="comment">/* !&lt; Base timer object. */</span>
00052
00053 xnhandle_t handle; <span class="comment">/* !&lt; Handle in registry -- zero if unregistered. */</span>
00054
00055 rt_alarm_t handler; <span class="comment">/* !&lt; Alarm handler. */</span>
00056
00057 <span class="keywordtype">void</span> *cookie; <span class="comment">/* !&lt; Opaque cookie. */</span>
00058
00059 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> expiries; <span class="comment">/* !&lt; Number of expiries. */</span>
00060
00061 <span class="preprocessor">#if defined(__KERNEL__) &amp;&amp; defined(CONFIG_XENO_OPT_PERVASIVE)</span>
00062 <span class="preprocessor"></span>
00063 pid_t cpid; <span class="comment">/* !&lt; Creator's pid. */</span>
00064
00065 xnsynch_t synch_base; <span class="comment">/* !&lt; Synch. base for user-space tasks. */</span>
00066
00067 <span class="preprocessor">#endif </span><span class="comment">/* __KERNEL__ &amp;&amp; CONFIG_XENO_OPT_PERVASIVE */</span>
00068
00069 <span class="keywordtype">char</span> name[XNOBJECT_NAME_LEN]; <span class="comment">/* !&lt; Symbolic name. */</span>
00070
00071 } RT_ALARM;
00072
00073 <span class="preprocessor">#ifdef __cplusplus</span>
00074 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
00075 <span class="preprocessor">#endif</span>
00076 <span class="preprocessor"></span>
00077 <span class="keywordtype">int</span> __native_alarm_pkg_init(<span class="keywordtype">void</span>);
00078
00079 <span class="keywordtype">void</span> __native_alarm_pkg_cleanup(<span class="keywordtype">void</span>);
00080
00081 <span class="keywordtype">int</span> <a class="code" href="group__alarm.html#ga8">rt_alarm_create</a>(RT_ALARM *alarm,
00082 <span class="keyword">const</span> <span class="keywordtype">char</span> *name,
00083 rt_alarm_t handler,
00084 <span class="keywordtype">void</span> *cookie);
00085
00086 <span class="preprocessor">#ifdef CONFIG_XENO_OPT_PERVASIVE</span>
00087 <span class="preprocessor"></span>
00088 <span class="keywordtype">void</span> rt_alarm_handler(RT_ALARM *alarm,
00089 <span class="keywordtype">void</span> *cookie);
00090
00091 <span class="preprocessor">#endif </span><span class="comment">/* CONFIG_XENO_OPT_PERVASIVE */</span>
00092
00093 <span class="preprocessor">#ifdef __cplusplus</span>
00094 <span class="preprocessor"></span>}
00095 <span class="preprocessor">#endif</span>
00096 <span class="preprocessor"></span>
00097 <span class="preprocessor">#else </span><span class="comment">/* !(__KERNEL__ || __XENO_SIM__) */</span>
00098
00099 <span class="keyword">typedef</span> RT_ALARM_PLACEHOLDER RT_ALARM;
00100
00101 <span class="preprocessor">#ifdef __cplusplus</span>
00102 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
00103 <span class="preprocessor">#endif</span>
00104 <span class="preprocessor"></span>
00105 <span class="keywordtype">int</span> <a class="code" href="group__alarm.html#ga8">rt_alarm_create</a>(RT_ALARM *alarm,
00106 <span class="keyword">const</span> <span class="keywordtype">char</span> *name);
00107
00108 <span class="keywordtype">int</span> <a class="code" href="group__alarm.html#ga9">rt_alarm_wait</a>(RT_ALARM *alarm);
00109
00110 <span class="preprocessor">#ifdef __cplusplus</span>
00111 <span class="preprocessor"></span>}
00112 <span class="preprocessor">#endif</span>
00113 <span class="preprocessor"></span>
00114 <span class="comment">/* No binding for alarms. */</span>
00115
00116 <span class="preprocessor">#endif </span><span class="comment">/* __KERNEL__ || __XENO_SIM__ */</span>
00117
00118 <span class="preprocessor">#ifdef __cplusplus</span>
00119 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
00120 <span class="preprocessor">#endif</span>
00121 <span class="preprocessor"></span>
00122 <span class="comment">/* Public interface. */</span>
00123
00124 <span class="keywordtype">int</span> <a class="code" href="group__alarm.html#ga4">rt_alarm_delete</a>(RT_ALARM *alarm);
00125
00126 <span class="keywordtype">int</span> <a class="code" href="group__alarm.html#ga5">rt_alarm_start</a>(RT_ALARM *alarm,
00127 RTIME value,
00128 RTIME interval);
00129
00130 <span class="keywordtype">int</span> <a class="code" href="group__alarm.html#ga6">rt_alarm_stop</a>(RT_ALARM *alarm);
00131
00132 <span class="keywordtype">int</span> <a class="code" href="group__alarm.html#ga7">rt_alarm_inquire</a>(RT_ALARM *alarm,
00133 RT_ALARM_INFO *info);
00134
00135 <span class="preprocessor">#ifdef __cplusplus</span>
00136 <span class="preprocessor"></span>}
00137 <span class="preprocessor">#endif</span>
00138 <span class="preprocessor"></span>
00139 <span class="preprocessor">#endif </span><span class="comment">/* !_XENO_ALARM_H */</span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Tue Oct 10 22:49:58 2006 for Xenomai API by&nbsp;
<!-- Generated by Doxygen 1.4.6 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="modules.html"><span>Modules</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>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label>&nbsp;<u>S</u>earch&nbsp;for&nbsp;</label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</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>
<h1>include/native/alarm.h</h1><a href="alarm_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef _XENO_ALARM_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define _XENO_ALARM_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;nucleus/timer.h&gt;</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;nucleus/synch.h&gt;</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;<a class="code" href="native_2types_8h.html">native/types.h</a>&gt;</span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="keyword">typedef</span> <span class="keyword">struct </span>rt_alarm_info {
<a name="l00030"></a>00030
<a name="l00031"></a>00031 RTIME expiration; <span class="comment">/* !&lt; Expiration date. */</span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> expiries; <span class="comment">/* !&lt; Number of expiries. */</span>
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="keywordtype">char</span> name[XNOBJECT_NAME_LEN]; <span class="comment">/* !&lt; Symbolic name. */</span>
<a name="l00036"></a>00036
<a name="l00037"></a>00037 } RT_ALARM_INFO;
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="keyword">typedef</span> <span class="keyword">struct </span>rt_alarm_placeholder {
<a name="l00040"></a>00040 xnhandle_t opaque;
<a name="l00041"></a>00041 } RT_ALARM_PLACEHOLDER;
<a name="l00042"></a>00042
<a name="l00043"></a>00043 <span class="preprocessor">#if defined(__KERNEL__) || defined(__XENO_SIM__)</span>
<a name="l00044"></a>00044 <span class="preprocessor"></span>
<a name="l00045"></a>00045 <span class="preprocessor">#define XENO_ALARM_MAGIC 0x55550909</span>
<a name="l00046"></a>00046 <span class="preprocessor"></span>
<a name="l00047"></a>00047 <span class="keyword">typedef</span> <span class="keyword">struct </span>rt_alarm {
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="keywordtype">unsigned</span> magic; <span class="comment">/* !&lt; Magic code - must be first */</span>
<a name="l00050"></a>00050
<a name="l00051"></a>00051 xntimer_t timer_base; <span class="comment">/* !&lt; Base timer object. */</span>
<a name="l00052"></a>00052
<a name="l00053"></a>00053 xnhandle_t handle; <span class="comment">/* !&lt; Handle in registry -- zero if unregistered. */</span>
<a name="l00054"></a>00054
<a name="l00055"></a>00055 rt_alarm_t handler; <span class="comment">/* !&lt; Alarm handler. */</span>
<a name="l00056"></a>00056
<a name="l00057"></a>00057 <span class="keywordtype">void</span> *cookie; <span class="comment">/* !&lt; Opaque cookie. */</span>
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> expiries; <span class="comment">/* !&lt; Number of expiries. */</span>
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <span class="preprocessor">#if defined(__KERNEL__) &amp;&amp; defined(CONFIG_XENO_OPT_PERVASIVE)</span>
<a name="l00062"></a>00062 <span class="preprocessor"></span>
<a name="l00063"></a>00063 pid_t cpid; <span class="comment">/* !&lt; Creator's pid. */</span>
<a name="l00064"></a>00064
<a name="l00065"></a>00065 xnsynch_t synch_base; <span class="comment">/* !&lt; Synch. base for user-space tasks. */</span>
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <span class="preprocessor">#endif </span><span class="comment">/* __KERNEL__ &amp;&amp; CONFIG_XENO_OPT_PERVASIVE */</span>
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="keywordtype">char</span> name[XNOBJECT_NAME_LEN]; <span class="comment">/* !&lt; Symbolic name. */</span>
<a name="l00070"></a>00070
<a name="l00071"></a>00071 } RT_ALARM;
<a name="l00072"></a>00072
<a name="l00073"></a>00073 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00074"></a>00074 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00075"></a>00075 <span class="preprocessor">#endif</span>
<a name="l00076"></a>00076 <span class="preprocessor"></span>
<a name="l00077"></a>00077 <span class="keywordtype">int</span> __native_alarm_pkg_init(<span class="keywordtype">void</span>);
<a name="l00078"></a>00078
<a name="l00079"></a>00079 <span class="keywordtype">void</span> __native_alarm_pkg_cleanup(<span class="keywordtype">void</span>);
<a name="l00080"></a>00080
<a name="l00081"></a>00081 <span class="keywordtype">int</span> <a class="code" href="group__alarm.html#g53e7f8400068253d2df58e6b4a7978ae">rt_alarm_create</a>(RT_ALARM *alarm,
<a name="l00082"></a>00082 <span class="keyword">const</span> <span class="keywordtype">char</span> *name,
<a name="l00083"></a>00083 rt_alarm_t handler,
<a name="l00084"></a>00084 <span class="keywordtype">void</span> *cookie);
<a name="l00085"></a>00085
<a name="l00086"></a>00086 <span class="preprocessor">#ifdef CONFIG_XENO_OPT_PERVASIVE</span>
<a name="l00087"></a>00087 <span class="preprocessor"></span>
<a name="l00088"></a>00088 <span class="keywordtype">void</span> rt_alarm_handler(RT_ALARM *alarm,
<a name="l00089"></a>00089 <span class="keywordtype">void</span> *cookie);
<a name="l00090"></a>00090
<a name="l00091"></a>00091 <span class="preprocessor">#endif </span><span class="comment">/* CONFIG_XENO_OPT_PERVASIVE */</span>
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00094"></a>00094 <span class="preprocessor"></span>}
<a name="l00095"></a>00095 <span class="preprocessor">#endif</span>
<a name="l00096"></a>00096 <span class="preprocessor"></span>
<a name="l00097"></a>00097 <span class="preprocessor">#else </span><span class="comment">/* !(__KERNEL__ || __XENO_SIM__) */</span>
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <span class="keyword">typedef</span> RT_ALARM_PLACEHOLDER RT_ALARM;
<a name="l00100"></a>00100
<a name="l00101"></a>00101 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00102"></a>00102 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00103"></a>00103 <span class="preprocessor">#endif</span>
<a name="l00104"></a>00104 <span class="preprocessor"></span>
<a name="l00105"></a>00105 <span class="keywordtype">int</span> <a class="code" href="group__alarm.html#g53e7f8400068253d2df58e6b4a7978ae">rt_alarm_create</a>(RT_ALARM *alarm,
<a name="l00106"></a>00106 <span class="keyword">const</span> <span class="keywordtype">char</span> *name);
<a name="l00107"></a>00107
<a name="l00108"></a>00108 <span class="keywordtype">int</span> <a class="code" href="group__alarm.html#g6c0caadae03541db8a46751d290c0d76">rt_alarm_wait</a>(RT_ALARM *alarm);
<a name="l00109"></a>00109
<a name="l00110"></a>00110 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00111"></a>00111 <span class="preprocessor"></span>}
<a name="l00112"></a>00112 <span class="preprocessor">#endif</span>
<a name="l00113"></a>00113 <span class="preprocessor"></span>
<a name="l00114"></a>00114 <span class="comment">/* No binding for alarms. */</span>
<a name="l00115"></a>00115
<a name="l00116"></a>00116 <span class="preprocessor">#endif </span><span class="comment">/* __KERNEL__ || __XENO_SIM__ */</span>
<a name="l00117"></a>00117
<a name="l00118"></a>00118 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00119"></a>00119 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00120"></a>00120 <span class="preprocessor">#endif</span>
<a name="l00121"></a>00121 <span class="preprocessor"></span>
<a name="l00122"></a>00122 <span class="comment">/* Public interface. */</span>
<a name="l00123"></a>00123
<a name="l00124"></a>00124 <span class="keywordtype">int</span> <a class="code" href="group__alarm.html#gf00e05b47b1183816480e270d326f9ac">rt_alarm_delete</a>(RT_ALARM *alarm);
<a name="l00125"></a>00125
<a name="l00126"></a>00126 <span class="keywordtype">int</span> <a class="code" href="group__alarm.html#g0d9cb8ae623be0f7224ac47b10a0b542">rt_alarm_start</a>(RT_ALARM *alarm,
<a name="l00127"></a>00127 RTIME value,
<a name="l00128"></a>00128 RTIME interval);
<a name="l00129"></a>00129
<a name="l00130"></a>00130 <span class="keywordtype">int</span> <a class="code" href="group__alarm.html#g71f2ffec98e3e23fe5d7f87c2cb24d77">rt_alarm_stop</a>(RT_ALARM *alarm);
<a name="l00131"></a>00131
<a name="l00132"></a>00132 <span class="keywordtype">int</span> <a class="code" href="group__alarm.html#g25c4556b6e2f6fa220a734bf83c4c374">rt_alarm_inquire</a>(RT_ALARM *alarm,
<a name="l00133"></a>00133 RT_ALARM_INFO *info);
<a name="l00134"></a>00134
<a name="l00135"></a>00135 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00136"></a>00136 <span class="preprocessor"></span>}
<a name="l00137"></a>00137 <span class="preprocessor">#endif</span>
<a name="l00138"></a>00138 <span class="preprocessor"></span>
<a name="l00139"></a>00139 <span class="preprocessor">#endif </span><span class="comment">/* !_XENO_ALARM_H */</span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Sun Nov 5 18:53:20 2006 for Xenomai API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address>
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>
......@@ -2,13 +2,32 @@
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Xenomai API: include/native/alarm.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.2 -->
<div class="qindex"> <form class="search" action="search.php" method="get">
<a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <span class="search"><u>S</u>earch&nbsp;for&nbsp;<input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div>
<div class="nav">
<a class="el" href="dir_000000.html">include</a>&nbsp;/&nbsp;<a class="el" href="dir_000001.html">native</a></div>
<h1>alarm.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<!-- Generated by Doxygen 1.4.6 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="modules.html"><span>Modules</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>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label>&nbsp;<u>S</u>earch&nbsp;for&nbsp;</label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</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>
<h1>include/native/alarm.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
This file is part of the Xenomai project.
<p>
<dl compact><dt><b>Note:</b></dt><dd>Copyright (C) 2004 Philippe Gerum &lt;<a href="mailto:rpm@xenomai.org">rpm@xenomai.org</a>&gt;</dd></dl>
......@@ -16,52 +35,35 @@ This program is free software; you can redistribute it and/or modify it under th
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.<p>
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
<p>