Skip to content

GitLab

xenomai
xenomai
Commit dad7c4c6 authored by Gilles Chanteperdrix's avatar Gilles Chanteperdrix
Browse files
Options

doc: regenerate

parent 1c55bd9d
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 22839 additions and 22765 deletions
README.INSTALL
View file @ dad7c4c6
Installing Xenomai 2.6.2
Installing Xenomai 2.6.2.1
-------------------------------------------------------------------------------
......@@ -182,24 +182,42 @@ with CONFIG_X86_TSC set, since the x86-tsc option’s binding is strong.
2.3.2. Generic configure options
--------------------------------
NAME DESCRIPTION [BINDING,] DEFAULT ^[a]
NAME DESCRIPTION [BINDING,]
DEFAULT ^[a]
--prefix Installation directory /usr/xenomai
--prefix Installation directory /usr/xenomai
--enable-debug Enable debug symbols (-g) disabled
--enable-debug Enable debug symbols (-g) disabled
--enable-smp Enable SMP support ^[a] weak
--enable-smp Enable SMP support ^[a] weak, enabled
--with-atomic-ops Selects which implementation of atomic arch-dependent
= access operations shall be used within
Xenomai libraries:
--with-atomic-ops=builtins selects the GCC
builtins, i.e. _sync*() services.
--with-atomic-ops=ad-hoc selects the ad hoc
Xenomai implementation.
When this switch is not specified, a
conservative choice is made depending on
the target architecture.
Unless the GCC toolchain is outdated (i.e.
does not provide these operations) or
broken, --with-atomic-ops=builtins should
be used.
^[a] The SMP switch is used to tell the build system whether CPU
synchronization instructions should be emitted in atomic constructs appearing
in some Xenomai libraries, enabling them for SMP execution. This feature is
turned on by default on all SMP-enabled architecture Xenomai supports, i.e.
x86_32/64, powerpc_32/64 and ARM. One may override this default setting by
passing --disable-smp explicitely for those architectures.
SMP-enabled userland code may run over SMP or UP kernels. However, Xenomai will
deny running UP-only userland code (i.e. when --disable-smp is in effect) over
an SMP kernel.
passing --disable-smp explicitely for those architectures. SMP-enabled userland
code may run over SMP or UP kernels. However, Xenomai will deny running UP-only
userland code (i.e. when --disable-smp is in effect) over an SMP kernel.
2.3.3. Arch-specific configure options
......@@ -209,7 +227,7 @@ an SMP kernel.
DEFAULT ^[a]
--enable-x86-sep Enable x86 SEP instructions for issuing strong,
syscalls. You will also need NPTL. disabled
syscalls. You will also need NPTL. enabled
--enable-x86-tsc Enable x86 TSC for timings You must have TSC strong,
for this. enabled
......@@ -654,12 +672,12 @@ guide.
In order to test Xenomai user-space support, launch the latency test:
$ /usr/xenomai/bin/latency
$ xeno latency
The latency test should display a message every second with minimal, maximal
and average latency values, such as:
# latency -T 25
# xeno latency -T 25
== Sampling period: 100 us
== Test mode: periodic user-mode task
== All results in microseconds
......
TROUBLESHOOTING
View file @ dad7c4c6
......@@ -18,8 +18,9 @@ Table of Contents
2.9. Xenomai: system init failed, code -19
2.9.1. On x86
2.9.2. On other supported platforms
2.9.3. On a new I-pipe port
2.9.2. On AMD x86_64
2.9.3. On other supported platforms
2.9.4. On a new I-pipe port
2.10. Xenomai: system init failed, code -22
......@@ -256,7 +257,24 @@ support is available. There are two options for fixing this issue:
the Linux source tree, for more information about this parameter.
2.9.2. On other supported platforms
2.9.2. On AMD x86_64
--------------------
You will most likely also see the following message:
I-pipe: cannot use LAPIC as a tick device
I-pipe: disable C1E power state in your BIOS
Xenomai sends this message if C1E option is enabled in a BIOS. To fix this
issue please disable C1E support in the BIOS. In some Award BIOS this option is
located in the Advanced BIOS Features→ menu (AMD C1E Support).
[Important] Important
Disabling AMD K8 Cool&Quiet option in a BIOS does not solve the
problem.
2.9.3. On other supported platforms
-----------------------------------
As on x86, on other platforms where Xenomai shares the timer with Linux, the
......@@ -272,7 +290,7 @@ post a message to the xenomai mailing list: "xenomai@xenomai.org", sending:
* the complete kernel boot log.
2.9.3. On a new I-pipe port
2.9.4. On a new I-pipe port
---------------------------
You will most likely also see the following message:
......
doc/generated/html/README.INSTALL/index.html
View file @ dad7c4c6
......@@ -4,7 +4,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.5.2" />
<title>Installing Xenomai 2.6.2</title>
<title>Installing Xenomai 2.6.2.1</title>
<link rel="stylesheet" href="../asciidoc-css/xhtml11.css" type="text/css" />
<link rel="stylesheet" href="../asciidoc-css/xhtml11-quirks.css" type="text/css" />
<script type="text/javascript">
......@@ -16,7 +16,7 @@ window.onload = function(){asciidoc.footnotes(); asciidoc.toc(3);}
</head>
<body style="max-width:55em">
<div id="header">
<h1>Installing Xenomai 2.6.2</h1>
<h1>Installing Xenomai 2.6.2.1</h1>
<div id="toc">
<div id="toctitle">Table of Contents</div>
<noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
......@@ -214,13 +214,32 @@ cellspacing="0" cellpadding="4">
powerpc_32/64 and ARM. One may
override this default setting
by passing <tt>--disable-smp</tt> explicitely
for those architectures.</p>
<p class="table"> SMP-enabled userland code may run
for those architectures.<br />
<br />
SMP-enabled userland code may run
over SMP or UP kernels. However,
Xenomai will deny running UP-only
userland code (i.e. when <tt>--disable-smp</tt>
is in effect) over an SMP kernel.]<br /></span></p></td>
<td align="left" valign="top"><p class="table">weak</p></td>
<td align="left" valign="top"><p class="table">weak, enabled</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table"><tt>--with-atomic-ops=</tt></p></td>
<td align="left" valign="top"><p class="table">Selects which implementation of atomic
access operations shall be used within
Xenomai libraries:</p>
<p class="table"> <tt>--with-atomic-ops=builtins</tt> selects the
GCC builtins, i.e. <em>_sync</em>*()
services.</p>
<p class="table"> <tt>--with-atomic-ops=ad-hoc</tt> selects the
ad hoc Xenomai implementation.</p>
<p class="table"> When this switch is not specified, a
conservative choice is made depending
on the target architecture.</p>
<p class="table"> Unless the GCC toolchain is outdated (i.e.
does not provide these operations) or broken,
<tt>--with-atomic-ops=builtins</tt> should be used.</p></td>
<td align="left" valign="top"><p class="table">arch-dependent</p></td>
</tr>
</tbody>
</table>
......@@ -248,7 +267,7 @@ cellspacing="0" cellpadding="4">
<td align="left" valign="top"><p class="table">Enable x86 SEP instructions
for issuing syscalls.
You will also need NPTL.</p></td>
<td align="left" valign="top"><p class="table">strong, disabled</p></td>
<td align="left" valign="top"><p class="table">strong, enabled</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table"><tt>--enable-x86-tsc</tt></p></td>
......@@ -818,13 +837,13 @@ to boot, or the log messages indicates an error status instead, see the
<div class="paragraph"><p>In order to test Xenomai user-space support, launch the latency test:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt>$ /usr/xenomai/bin/latency</tt></pre>
<pre><tt>$ xeno latency</tt></pre>
</div></div>
<div class="paragraph"><p>The latency test should display a message every second with minimal,
maximal and average latency values, such as:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt># latency -T 25
<pre><tt># xeno latency -T 25
== Sampling period: 100 us
== Test mode: periodic user-mode task
== All results in microseconds
......@@ -876,7 +895,7 @@ test under load to evaluate the latency test of your system, the
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2012-12-16 17:35:00 CEST
Last updated 2013-01-15 06:25:25 CEST
</div>
</div>
</body>
......
doc/generated/html/TROUBLESHOOTING/index.html
View file @ dad7c4c6
......@@ -220,7 +220,27 @@ more information about this parameter.
</p>
</li>
</ul></div>
<h4 id="_on_other_supported_platforms">2.9.2. On other supported platforms</h4>
<h4 id="_on_amd_x86_64">2.9.2. On AMD x86_64</h4>
<div class="paragraph"><p>You will most likely also see the following message:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt>I-pipe: cannot use LAPIC as a tick device
I-pipe: disable C1E power state in your BIOS</tt></pre>
</div></div>
<div class="paragraph"><p>Xenomai sends this message if C1E option is enabled in a BIOS. To fix
this issue please disable C1E support in the BIOS. In some Award BIOS
this option is located in the <tt>Advanced BIOS Features&#8594;</tt> menu (<tt>AMD
C1E Support</tt>).</p></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="../asciidoc-icons/important.png" alt="Important" />
</td>
<td class="content">Disabling <tt>AMD K8 Cool&amp;Quiet</tt> option in a BIOS does not
solve the problem.</td>
</tr></table>
</div>
<h4 id="_on_other_supported_platforms">2.9.3. On other supported platforms</h4>
<div class="paragraph"><p>As on x86, on other platforms where Xenomai shares the timer with
Linux, the timer is only used if it was not shut down by Linux. So you
should check the log for messages about disabled timers. You can also
......@@ -245,7 +265,7 @@ the complete kernel boot log.
</p>
</li>
</ul></div>
<h4 id="_on_a_new_i_pipe_port">2.9.3. On a new I-pipe port</h4>
<h4 id="_on_a_new_i_pipe_port">2.9.4. On a new I-pipe port</h4>
<div class="paragraph"><p>You will most likely also see the following message:</p></div>
<div class="listingblock">
<div class="content">
......@@ -713,7 +733,7 @@ like calling:</p></div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2012-12-26 18:11:12 CEST
Last updated 2013-01-03 23:19:06 CEST
</div>
</div>
</body>
......
doc/generated/html/api/8255_8c.html
View file @ dad7c4c6
......@@ -50,7 +50,7 @@ Include dependency graph for 8255.c:</div>
<p>This code 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>
<p>You should have received a copy of the GNU General Public License along with Xenomai; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. </p>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Dec 26 2012 18:15:30 for Xenomai API by&nbsp;
<hr class="footer"/><address class="footer"><small>Generated on Wed Jan 23 2013 13:24:03 for Xenomai API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
......
doc/generated/html/api/8255_8h.html
View file @ dad7c4c6
......@@ -59,7 +59,7 @@ This graph shows which files directly or indirectly include this file:</div>
<p>This library 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 Lesser General Public License for more details.</p>
<p>You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. </p>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Dec 26 2012 18:15:30 for Xenomai API by&nbsp;
<hr class="footer"/><address class="footer"><small>Generated on Wed Jan 23 2013 13:24:03 for Xenomai API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
......
doc/generated/html/api/8255_8h_source.html
View file @ dad7c4c6
......@@ -75,7 +75,7 @@
<a name="l00062"></a>00062 <span class="preprocessor">#endif </span><span class="comment">/* !__ANALOGY_8255_H__ */</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Dec 26 2012 18:15:27 for Xenomai API by&nbsp;
<hr class="footer"/><address class="footer"><small>Generated on Wed Jan 23 2013 13:24:01 for Xenomai API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
......
doc/generated/html/api/alarm_8h.html
View file @ dad7c4c6
......@@ -73,7 +73,7 @@ Functions</h2></td></tr>
<p>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>
<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>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Dec 26 2012 18:15:29 for Xenomai API by&nbsp;
<hr class="footer"/><address class="footer"><small>Generated on Wed Jan 23 2013 13:24:03 for Xenomai API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
......
doc/generated/html/api/alarm_8h_source.html
View file @ dad7c4c6
......@@ -172,7 +172,7 @@
<a name="l00160"></a>00160 <span class="preprocessor">#endif </span><span class="comment">/* !_XENO_ALARM_H */</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Dec 26 2012 18:15:27 for Xenomai API by&nbsp;
<hr class="footer"/><address class="footer"><small>Generated on Wed Jan 23 2013 13:24:01 for Xenomai API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
......
doc/generated/html/api/analogy_2buffer_8h.html
View file @ dad7c4c6
......@@ -45,7 +45,7 @@
<p>Xenomai 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>
<p>You should have received a copy of the GNU General Public License along with Xenomai; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. </p>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Dec 26 2012 18:15:29 for Xenomai API by&nbsp;
<hr class="footer"/><address class="footer"><small>Generated on Wed Jan 23 2013 13:24:03 for Xenomai API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
......
doc/generated/html/api/analogy_2buffer_8h_source.html
View file @ dad7c4c6
......@@ -526,7 +526,7 @@
<a name="l00515"></a>00515 <span class="preprocessor">#endif </span><span class="comment">/* __ANALOGY_BUFFER_H__ */</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Dec 26 2012 18:15:27 for Xenomai API by&nbsp;
<hr class="footer"/><address class="footer"><small>Generated on Wed Jan 23 2013 13:24:01 for Xenomai API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
......
doc/generated/html/api/analogy_2ioctl_8h.html
View file @ dad7c4c6
......@@ -52,7 +52,7 @@ This graph shows which files directly or indirectly include this file:</div>
<p>Xenomai 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>
<p>You should have received a copy of the GNU General Public License along with Xenomai; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. </p>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Dec 26 2012 18:15:29 for Xenomai API by&nbsp;
<hr class="footer"/><address class="footer"><small>Generated on Wed Jan 23 2013 13:24:03 for Xenomai API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
......
doc/generated/html/api/analogy_2ioctl_8h_source.html
View file @ dad7c4c6
......@@ -73,7 +73,7 @@
<a name="l00062"></a>00062 <span class="preprocessor">#endif </span><span class="comment">/* __ANALOGY_IOCTL__ */</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Dec 26 2012 18:15:27 for Xenomai API by&nbsp;
<hr class="footer"/><address class="footer"><small>Generated on Wed Jan 23 2013 13:24:01 for Xenomai API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
......
doc/generated/html/api/analogy_2types_8h.html
View file @ dad7c4c6
......@@ -52,7 +52,7 @@ This graph shows which files directly or indirectly include this file:</div>
<p>Xenomai 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>
<p>You should have received a copy of the GNU General Public License along with Xenomai; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. </p>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Dec 26 2012 18:15:30 for Xenomai API by&nbsp;
<hr class="footer"/><address class="footer"><small>Generated on Wed Jan 23 2013 13:24:03 for Xenomai API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
......
doc/generated/html/api/analogy_2types_8h_source.html
View file @ dad7c4c6
......@@ -49,7 +49,7 @@
<a name="l00038"></a>00038 <span class="preprocessor">#endif </span><span class="comment">/* __ANALOGY_TYPES__ */</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Dec 26 2012 18:15:27 for Xenomai API by&nbsp;
<hr class="footer"/><address class="footer"><small>Generated on Wed Jan 23 2013 13:24:01 for Xenomai API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
......
doc/generated/html/api/analogy_8h.html
View file @ dad7c4c6
......@@ -61,7 +61,7 @@ Copyright (C) 2008 Alexis Berlemont &lt;<a href="mailto:alexis.berlemont@free.fr
<p>This library 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 Lesser General Public License for more details.</p>
<p>You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. </p>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Dec 26 2012 18:15:29 for Xenomai API by&nbsp;
<hr class="footer"/><address class="footer"><small>Generated on Wed Jan 23 2013 13:24:03 for Xenomai API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
......
doc/generated/html/api/analogy_8h_source.html
View file @ dad7c4c6
......@@ -194,7 +194,7 @@
<a name="l00182"></a>00182 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* __ANALOGY_ANALOGY__ */</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Dec 26 2012 18:15:27 for Xenomai API by&nbsp;
<hr class="footer"/><address class="footer"><small>Generated on Wed Jan 23 2013 13:24:01 for Xenomai API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
......
doc/generated/html/api/analogy__driver_8h.html
View file @ dad7c4c6
......@@ -59,7 +59,7 @@ This graph shows which files directly or indirectly include this file:</div>
<p>Xenomai 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>
<p>You should have received a copy of the GNU General Public License along with Xenomai; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. </p>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Dec 26 2012 18:15:29 for Xenomai API by&nbsp;
<hr class="footer"/><address class="footer"><small>Generated on Wed Jan 23 2013 13:24:03 for Xenomai API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
......
doc/generated/html/api/analogy__driver_8h_source.html
View file @ dad7c4c6
......@@ -46,7 +46,7 @@
<a name="l00035"></a>00035 <span class="preprocessor">#endif </span><span class="comment">/* __ANALOGY_ANALOGY_DRIVER__ */</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Dec 26 2012 18:15:27 for Xenomai API by&nbsp;
<hr class="footer"/><address class="footer"><small>Generated on Wed Jan 23 2013 13:24:01 for Xenomai API by&nbsp;