doc/generated/html/api/timebase_8h.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <title>Xenomai API: include/nucleus/timebase.h File Reference</title>
   7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   8 <script type="text/javascript" src="jquery.js"></script>
   9 <script type="text/javascript" src="dynsections.js"></script>
  10 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  11 <script type="text/javascript" src="resize.js"></script>
  12 <script type="text/javascript" src="navtree.js"></script>
  13 <script type="text/javascript">
  14   $(document).ready(initResizable);
  15 </script>
  16 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  17 <script type="text/javascript" src="search/search.js"></script>
  18 <script type="text/javascript">
  19   $(document).ready(function() {
  20     if ($('.searchresults').length > 0) { searchBox.DOMSearchField().focus(); }
  21   });
  22 </script>
  23 <link rel="search" href="search-opensearch.php?v=opensearch.xml" type="application/opensearchdescription+xml" title="Xenomai API"/>
  24 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  25 </head>
  26 <body>
  27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  28 <div id="titlearea">
  29 <table cellspacing="0" cellpadding="0">
  30  <tbody>
  31  <tr style="height: 56px;">
  32   <td style="padding-left: 0.5em;">
  33    <div id="projectname">Xenomai API
  34    &#160;<span id="projectnumber">2.6.3</span>
  35    </div>
  36   </td>
  37  </tr>
  38  </tbody>
  39 </table>
  40 </div>
  41 <!-- end header part -->
  42 <!-- Generated by Doxygen 1.8.1.2 -->
  43 <script type="text/javascript">
  44 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  45 </script>
  46   <div id="navrow1" class="tabs">
  47     <ul class="tablist">
  48       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  49       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  50       <li><a href="modules.html"><span>Modules</span></a></li>
  51       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  52       <li class="current"><a href="files.html"><span>Files</span></a></li>
  53       <li><a href="examples.html"><span>Examples</span></a></li>
  54       <li>
  55         <div id="MSearchBox" class="MSearchBoxInactive">
  56           <div class="left">
  57             <form id="FSearchBox" action="search.php" method="get">
  58               <img id="MSearchSelect" src="search/mag.png" alt=""/>
  59               <input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S"
  60                      onfocus="searchBox.OnSearchFieldFocus(true)"
  61                      onblur="searchBox.OnSearchFieldFocus(false)"/>
  62             </form>
  63           </div><div class="right"></div>
  64         </div>
  65       </li>
  66     </ul>
  67   </div>
  68   <div id="navrow2" class="tabs2">
  69     <ul class="tablist">
  70       <li><a href="files.html"><span>File&#160;List</span></a></li>
  71       <li><a href="globals.html"><span>Globals</span></a></li>
  72     </ul>
  73   </div>
  74 </div><!-- top -->
  75 <div id="side-nav" class="ui-resizable side-nav-resizable">
  76   <div id="nav-tree">
  77     <div id="nav-tree-contents">
  78       <div id="nav-sync" class="sync"></div>
  79     </div>
  80   </div>
  81   <div id="splitbar" style="-moz-user-select:none;"
  82        class="ui-resizable-handle">
  83   </div>
  84 </div>
  85 <script type="text/javascript">
  86 $(document).ready(function(){initNavTree('timebase_8h.html','');});
  87 </script>
  88 <div id="doc-content">
  89 <div class="header">
  90   <div class="summary">
  91 <a href="#func-members">Functions</a>  </div>
  92   <div class="headertitle">
  93 <div class="title">timebase.h File Reference<div class="ingroups"><a class="el" href="group__timebase.html">Time base services.</a></div></div>  </div>
  94 </div><!--header-->
  95 <div class="contents">
  96 <div class="textblock"><div class="dynheader">
  97 Include dependency graph for timebase.h:</div>
  98 <div class="dyncontent">
  99 <div class="center"><img src="timebase_8h__incl.png" border="0" usemap="#include_2nucleus_2timebase_8h" alt=""/></div>
 100 <map name="include_2nucleus_2timebase_8h" id="include_2nucleus_2timebase_8h">
 101 <area shape="rect" id="node3" href="nucleus_2queue_8h_source.html" title="nucleus/queue.h" alt="" coords="148,83,265,112"/><area shape="rect" id="node17" href="vfile_8h.html" title="This file is part of the Xenomai project." alt="" coords="289,83,396,112"/><area shape="rect" id="node5" href="nucleus_2types_8h_source.html" title="nucleus/types.h" alt="" coords="151,160,265,189"/><area shape="rect" id="node13" href="assert_8h_source.html" title="nucleus/assert.h" alt="" coords="5,237,123,267"/><area shape="rect" id="node11" href="compiler_8h_source.html" title="nucleus/compiler.h" alt="" coords="328,237,459,267"/></map>
 102 </div>
 103 </div><div class="textblock"><div class="dynheader">
 104 This graph shows which files directly or indirectly include this file:</div>
 105 <div class="dyncontent">
 106 <div class="center"><img src="timebase_8h__dep__incl.png" border="0" usemap="#include_2nucleus_2timebase_8hdep" alt=""/></div>
 107 <map name="include_2nucleus_2timebase_8hdep" id="include_2nucleus_2timebase_8hdep">
 108 <area shape="rect" id="node3" href="module_8h_source.html" title="include/nucleus/module.h" alt="" coords="1657,83,1825,112"/><area shape="rect" id="node83" href="include_2nucleus_2timer_8h.html" title="include/nucleus/timer.h" alt="" coords="2345,83,2500,112"/><area shape="rect" id="node5" href="xenomai_8h_source.html" title="include/nucleus/xenomai.h" alt="" coords="729,160,905,189"/><area shape="rect" id="node75" href="pod_8c.html" title="Real&#45;time pod services." alt="" coords="2085,315,2216,344"/><area shape="rect" id="node77" href="shadow_8c.html" title="Real&#45;time shadow services." alt="" coords="1607,160,1761,189"/><area shape="rect" id="node79" href="synch_8c.html" title="Thread synchronization services." alt="" coords="1899,237,2045,267"/><area shape="rect" id="node81" href="timebase_8c.html" title="ksrc/nucleus/timebase.c" alt="" coords="1836,160,1999,189"/><area shape="rect" id="node7" href="pthread_8h_source.html" title="include/posix/pthread.h" alt="" coords="901,315,1056,344"/><area shape="rect" id="node17" href="posix_2internal_8h_source.html" title="ksrc/skins/posix/internal.h" alt="" coords="972,488,1145,517"/><area shape="rect" id="node25" href="posix_2sched_8h_source.html" title="include/posix/sched.h" alt="" coords="744,237,891,267"/><area shape="rect" id="node29" href="mman_8h_source.html" title="include/posix/sys/mman.h" alt="" coords="440,315,613,344"/><area shape="rect" id="node32" href="fcntl_8h_source.html" title="include/posix/fcntl.h" alt="" coords="637,315,776,344"/><area shape="rect" id="node35" href="unistd_8h_source.html" title="include/posix/unistd.h" alt="" coords="965,237,1112,267"/><area shape="rect" id="node49" href="signal_8h_source.html" title="include/posix/signal.h" alt="" coords="5,315,152,344"/><area shape="rect" id="node52" href="time_8h_source.html" title="include/posix/time.h" alt="" coords="176,315,315,344"/><area shape="rect" id="node55" href="rtdm__driver_8h.html" title="Real&#45;Time Driver Model for Xenomai, driver API header." alt="" coords="1888,315,2061,344"/><area shape="rect" id="node61" href="errno_8h_source.html" title="include/posix/errno.h" alt="" coords="1184,315,1325,344"/><area shape="rect" id="node68" href="mqueue_8h_source.html" title="include/posix/mqueue.h" alt="" coords="261,237,419,267"/><area shape="rect" id="node71" href="semaphore_8h_source.html" title="include/posix/semaphore.h" alt="" coords="443,237,619,267"/><area shape="rect" id="node9" href="wrappers_8h_source.html" title="src/skins/native/wrappers.h" alt="" coords="765,401,947,431"/><area shape="rect" id="node11" href="current_8h_source.html" title="include/asm&#45;generic\l/current.h" alt="" coords="1624,393,1763,439"/><area shape="rect" id="node13" href="stack_8h_source.html" title="include/asm&#45;generic\l/stack.h" alt="" coords="971,393,1109,439"/><area shape="rect" id="node15" href="posix_8h_source.html" title="include/posix/posix.h" alt="" coords="547,401,691,431"/><area shape="rect" id="node21" href="ksrc_2skins_2posix_2mutex_8h_source.html" title="ksrc/skins/posix/mutex.h" alt="" coords="853,643,1021,672"/><area shape="rect" id="node19" href="ksrc_2skins_2posix_2thread_8h_source.html" title="ksrc/skins/posix/thread.h" alt="" coords="853,565,1021,595"/><area shape="rect" id="node38" href="analogy_8h.html" title="Analogy for Linux, library facilities." alt="" coords="1349,315,1520,344"/><area shape="rect" id="node40" href="async_8c.html" title="Analogy for Linux, command, transfer, etc." alt="" coords="1787,393,1909,439"/><area shape="rect" id="node42" href="info_8c.html" title="Analogy for Linux, device, subdevice, etc." alt="" coords="1184,393,1307,439"/><area shape="rect" id="node44" href="range_8c.html" title="Analogy for Linux, range related features." alt="" coords="1331,393,1453,439"/><area shape="rect" id="node46" href="sync_8c.html" title="Analogy for Linux, instruction related features." alt="" coords="1477,393,1600,439"/><area shape="rect" id="node57" href="rtdm_2internal_8h_source.html" title="ksrc/skins/rtdm/internal.h" alt="" coords="2115,401,2283,431"/><area shape="rect" id="node59" href="drvlib_8c.html" title="Real&#45;Time Driver Model for Xenomai, driver library." alt="" coords="1933,401,2091,431"/><area shape="rect" id="node85" href="include_2nucleus_2thread_8h_source.html" title="include/nucleus/thread.h" alt="" coords="2444,160,2607,189"/><area shape="rect" id="node106" href="nucleus_2sched_8c.html" title="ksrc/nucleus/sched.c" alt="" coords="3059,237,3205,267"/><area shape="rect" id="node109" href="ksrc_2nucleus_2timer_8c.html" title="ksrc/nucleus/timer.c" alt="" coords="3229,237,3368,267"/><area shape="rect" id="node116" href="alarm_8h.html" title="This file is part of the Xenomai project." alt="" coords="3129,315,3279,344"/><area shape="rect" id="node122" href="include_2native_2timer_8h.html" title="This file is part of the Xenomai project." alt="" coords="2743,315,2889,344"/><area shape="rect" id="node87" href="nucleus_2pipe_8h_source.html" title="include/nucleus/pipe.h" alt="" coords="2885,237,3035,267"/><area shape="rect" id="node95" href="nucleus_2sched_8h.html" title="Scheduler interface header." alt="" coords="2357,237,2520,267"/><area shape="rect" id="node97" href="nucleus_2select_8h.html" title="file descriptors events multiplexing header." alt="" coords="2069,237,2232,267"/><area shape="rect" id="node102" href="ksrc_2nucleus_2heap_8c.html" title="Dynamic memory allocation services." alt="" coords="2544,237,2683,267"/><area shape="rect" id="node104" href="nucleus_2registry_8c.html" title="This file is part of the Xenomai project." alt="" coords="2707,237,2861,267"/><area shape="rect" id="node89" href="native_2pipe_8h.html" title="This file is part of the Xenomai project." alt="" coords="3303,315,3444,344"/><area shape="rect" id="node91" href="skins_2native_2module_8c.html" title="This file is part of the Xenomai project." alt="" coords="3115,401,3293,431"/><area shape="rect" id="node93" href="native_2syscall_8c.html" title="This file is part of the Xenomai project." alt="" coords="3317,401,3493,431"/><area shape="rect" id="node118" href="ksrc_2skins_2native_2alarm_8c.html" title="This file is part of the Xenomai project." alt="" coords="2923,401,3091,431"/><area shape="rect" id="node125" href="ksrc_2skins_2native_2buffer_8c.html" title="This file is part of the Xenomai project." alt="" coords="2357,401,2525,431"/><area shape="rect" id="node129" href="ksrc_2skins_2native_2task_8c.html" title="This file is part of the Xenomai project." alt="" coords="2549,401,2709,431"/><area shape="rect" id="node131" href="ksrc_2skins_2native_2timer_8c.html" title="This file is part of the Xenomai project." alt="" coords="2733,401,2899,431"/></map>
 109 </div>
 110 </div>
 111 <p><a href="timebase_8h_source.html">Go to the source code of this file.</a></p>
 112 <table class="memberdecls">
 113 <tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
 114 Functions</h2></td></tr>
 115 <tr class="memitem:gafcb0a76ac26eaaa768db89cb54e3f24a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__timebase.html#gafcb0a76ac26eaaa768db89cb54e3f24a">xntbase_alloc</a> (const char *name, u_long period, u_long flags, xntbase_t **basep)</td></tr>
 116 <tr class="memdesc:gafcb0a76ac26eaaa768db89cb54e3f24a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate a time base.  <a href="group__timebase.html#gafcb0a76ac26eaaa768db89cb54e3f24a"></a><br/></td></tr>
 117 <tr class="memitem:gaf94b8dda1e4cc484c13cb004689a795e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__timebase.html#gaf94b8dda1e4cc484c13cb004689a795e">xntbase_free</a> (xntbase_t *base)</td></tr>
 118 <tr class="memdesc:gaf94b8dda1e4cc484c13cb004689a795e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free a time base.  <a href="group__timebase.html#gaf94b8dda1e4cc484c13cb004689a795e"></a><br/></td></tr>
 119 <tr class="memitem:ga71112e6b362918b602e01d86d4c07654"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__timebase.html#ga71112e6b362918b602e01d86d4c07654">xntbase_update</a> (xntbase_t *base, u_long period)</td></tr>
 120 <tr class="memdesc:ga71112e6b362918b602e01d86d4c07654"><td class="mdescLeft">&#160;</td><td class="mdescRight">Change the period of a time base.  <a href="group__timebase.html#ga71112e6b362918b602e01d86d4c07654"></a><br/></td></tr>
 121 <tr class="memitem:gadf44dc347a2b8cb921cbc9f4e2768320"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__timebase.html#gadf44dc347a2b8cb921cbc9f4e2768320">xntbase_switch</a> (const char *name, u_long period, xntbase_t **basep)</td></tr>
 122 <tr class="memdesc:gadf44dc347a2b8cb921cbc9f4e2768320"><td class="mdescLeft">&#160;</td><td class="mdescRight">Replace a time base.  <a href="group__timebase.html#gadf44dc347a2b8cb921cbc9f4e2768320"></a><br/></td></tr>
 123 <tr class="memitem:gae596e43dbf89abb299aa29ae841ec8e0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__timebase.html#gae596e43dbf89abb299aa29ae841ec8e0">xntbase_start</a> (xntbase_t *base)</td></tr>
 124 <tr class="memdesc:gae596e43dbf89abb299aa29ae841ec8e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start a time base.  <a href="group__timebase.html#gae596e43dbf89abb299aa29ae841ec8e0"></a><br/></td></tr>
 125 <tr class="memitem:ga23ae261bf7e2eaa09f05c4c6069a41e1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__timebase.html#ga23ae261bf7e2eaa09f05c4c6069a41e1">xntbase_stop</a> (xntbase_t *base)</td></tr>
 126 <tr class="memdesc:ga23ae261bf7e2eaa09f05c4c6069a41e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop a time base.  <a href="group__timebase.html#ga23ae261bf7e2eaa09f05c4c6069a41e1"></a><br/></td></tr>
 127 <tr class="memitem:ga15896b6c498acdc5e2516ad0cc9df5ac"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__timebase.html#ga15896b6c498acdc5e2516ad0cc9df5ac">xntbase_tick</a> (xntbase_t *base)</td></tr>
 128 <tr class="memdesc:ga15896b6c498acdc5e2516ad0cc9df5ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Announce a clock tick to a time base.  <a href="group__timebase.html#ga15896b6c498acdc5e2516ad0cc9df5ac"></a><br/></td></tr>
 129 <tr class="memitem:ga61ff1abcbe816dd7ce6be2e2c7f2e44b"><td class="memItemLeft" align="right" valign="top">xnticks_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__timebase.html#ga61ff1abcbe816dd7ce6be2e2c7f2e44b">xntbase_convert</a> (xntbase_t *srcbase, xnticks_t ticks, xntbase_t *dstbase)</td></tr>
 130 <tr class="memdesc:ga61ff1abcbe816dd7ce6be2e2c7f2e44b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a clock value into another time base.  <a href="group__timebase.html#ga61ff1abcbe816dd7ce6be2e2c7f2e44b"></a><br/></td></tr>
 131 <tr class="memitem:ga5246b53b5b2d1b11d4fab4312fd16fda"><td class="memItemLeft" align="right" valign="top">static xnticks_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__timebase.html#ga5246b53b5b2d1b11d4fab4312fd16fda">xntbase_get_time</a> (xntbase_t *base)</td></tr>
 132 <tr class="memdesc:ga5246b53b5b2d1b11d4fab4312fd16fda"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the clock time for a given time base.  <a href="group__timebase.html#ga5246b53b5b2d1b11d4fab4312fd16fda"></a><br/></td></tr>
 133 <tr class="memitem:gad5b8cfb5270e9f8b73c167d1c7f7d1b2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__timebase.html#gad5b8cfb5270e9f8b73c167d1c7f7d1b2">xntbase_adjust_time</a> (xntbase_t *base, xnsticks_t delta)</td></tr>
 134 <tr class="memdesc:gad5b8cfb5270e9f8b73c167d1c7f7d1b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adjust the clock time for the system.  <a href="group__timebase.html#gad5b8cfb5270e9f8b73c167d1c7f7d1b2"></a><br/></td></tr>
 135 </table>
 136 <a name="details" id="details"></a><h2>Detailed Description</h2>
 137 <div class="textblock"><dl class="section note"><dt>Note</dt><dd>Copyright (C) 2006,2007 Philippe Gerum <a href="#" onclick="location.href='mai'+'lto:'+'rpm'+'@x'+'eno'+'ma'+'i.o'+'rg'; return false;">rpm@x<span style="display: none;">.nosp@m.</span>enom<span style="display: none;">.nosp@m.</span>ai.or<span style="display: none;">.nosp@m.</span>g</a>.</dd></dl>
 138 <p>Xenomai is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.</p>
 139 <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>
 140 <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>
 141 </div></div><!-- contents -->
 142 </div><!-- doc-content -->
 143 <!-- start footer part -->
 144 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 145   <ul>
 146     <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_b681fac26223caaf15e149e8e802bec7.html">nucleus</a></li><li class="navelem"><a class="el" href="timebase_8h.html">timebase.h</a></li>
 147     <li class="footer">Generated on Fri Oct 4 2013 22:39:08 for Xenomai API by
 148     <a href="http://www.doxygen.org/index.html">
 149     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.2 </li>
 150   </ul>
 151 </div>
 152 </body>
 153 </html>