begriffs open source - cmsis/blob - dev/v6.0.0-dev53/Driver/html/group__eth__mac__time__control.html

   1 <!-- HTML header for doxygen 1.9.6-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>CMSIS-Driver: Ethernet MAC Timer Control Codes</title>
   9 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  12 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  13 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="jquery.js"></script>
  15 <script type="text/javascript" src="dynsections.js"></script>
  16 <script type="text/javascript" src="printComponentTabs.js"></script>
  17 <script type="text/javascript" src="footer.js"></script>
  18 <script type="text/javascript" src="navtree.js"></script>
  19 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  20 <script type="text/javascript" src="resize.js"></script>
  21 <script type="text/javascript" src="navtreedata.js"></script>
  22 <script type="text/javascript" src="navtree.js"></script>
  23 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  24 <script type="text/javascript" src="search/searchdata.js"></script>
  25 <script type="text/javascript" src="search/search.js"></script>
  26 <script type="text/javascript">
  27 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  28   $(document).ready(function() { init_search(); });
  29 /* @license-end */
  30 </script>
  31 <script type="text/javascript" src="darkmode_toggle.js"></script>
  32 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  33 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  34 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  35 <link href="version.css" rel="stylesheet" type="text/css" />
  36 <script type="text/javascript" src="../../../version.js"></script>
  37 </head>
  38 <body>
  39 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  40 <div id="titlearea">
  41 <table cellspacing="0" cellpadding="0">
  42  <tbody>
  43  <tr style="height: 55px;">
  44   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  45   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  46    <div id="projectname">CMSIS-Driver
  47    &#160;<span id="projectnumber"><script type="text/javascript">
  48      <!--
  49      writeHeader.call(this);
  50      writeVersionDropdown.call(this);
  51      //-->
  52     </script>
  53    </span>
  54    </div>
  55    <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
  56   </td>
  57    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  58         <span class="left">
  59           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  60           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  61                onfocus="searchBox.OnSearchFieldFocus(true)"
  62                onblur="searchBox.OnSearchFieldFocus(false)"
  63                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  64           </span><span class="right">
  65             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  66           </span>
  67         </div>
  68 </td>
  69   <!--END !PROJECT_NAME-->
  70  </tr>
  71  </tbody>
  72 </table>
  73 </div>
  74 <!-- end header part -->
  75 <div id="CMSISnav" class="tabs1">
  76   <ul class="tablist">
  77     <script type="text/javascript">
  78       writeComponentTabs.call(this);
  79     </script>
  80   </ul>
  81 </div>
  82 <script type="text/javascript">
  83   writeSubComponentTabs.call(this);
  84 </script>
  85 <!-- Generated by Doxygen 1.9.6 -->
  86 <script type="text/javascript">
  87 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  88 var searchBox = new SearchBox("searchBox", "search/",'.html');
  89 /* @license-end */
  90 </script>
  91 </div><!-- top -->
  92 <div id="side-nav" class="ui-resizable side-nav-resizable">
  93   <div id="nav-tree">
  94     <div id="nav-tree-contents">
  95       <div id="nav-sync" class="sync"></div>
  96     </div>
  97   </div>
  98   <div id="splitbar" style="-moz-user-select:none;"
  99        class="ui-resizable-handle">
 100   </div>
 101 </div>
 102 <script type="text/javascript">
 103 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 104 $(document).ready(function(){initNavTree('group__eth__mac__time__control.html',''); initResizable(); });
 105 /* @license-end */
 106 </script>
 107 <div id="doc-content">
 108 <!-- window showing the filter options -->
 109 <div id="MSearchSelectWindow"
 110      onmouseover="return searchBox.OnSearchSelectShow()"
 111      onmouseout="return searchBox.OnSearchSelectHide()"
 112      onkeydown="return searchBox.OnSearchSelectKey(event)">
 113 </div>
 114
 115 <!-- iframe showing the search results (closed by default) -->
 116 <div id="MSearchResultsWindow">
 117 <div id="MSearchResults">
 118 <div class="SRPage">
 119 <div id="SRIndex">
 120 <div id="SRResults"></div>
 121 <div class="SRStatus" id="Loading">Loading...</div>
 122 <div class="SRStatus" id="Searching">Searching...</div>
 123 <div class="SRStatus" id="NoMatches">No Matches</div>
 124 </div>
 125 </div>
 126 </div>
 127 </div>
 128
 129 <div class="header">
 130   <div class="summary">
 131 <a href="#define-members">Macros</a>  </div>
 132   <div class="headertitle"><div class="title">Ethernet MAC Timer Control Codes<div class="ingroups"><a class="el" href="group__eth__interface__gr.html">Ethernet Interface</a> &raquo; <a class="el" href="group__eth__mac__interface__gr.html">Ethernet MAC Interface</a></div></div></div>
 133 </div><!--header-->
 134 <div class="contents">
 135
 136 <p>Control codes for <a class="el" href="group__eth__mac__interface__gr.html#ga85d9dc865af3702b71a514b18a588643">ARM_ETH_MAC_ControlTimer</a> function.
 137 <a href="#details">More...</a></p>
 138 <table class="memberdecls">
 139 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 140 Macros</h2></td></tr>
 141 <tr class="memitem:gad9a439b9727c032a7d851df2a7a622c2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__time__control.html#gad9a439b9727c032a7d851df2a7a622c2">ARM_ETH_MAC_TIMER_GET_TIME</a>&#160;&#160;&#160;(0x01UL)</td></tr>
 142 <tr class="memdesc:gad9a439b9727c032a7d851df2a7a622c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get current time.  <br /></td></tr>
 143 <tr class="separator:gad9a439b9727c032a7d851df2a7a622c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:ga5e867a003c06046d7944bcb5723e6049"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__time__control.html#ga5e867a003c06046d7944bcb5723e6049">ARM_ETH_MAC_TIMER_SET_TIME</a>&#160;&#160;&#160;(0x02UL)</td></tr>
 145 <tr class="memdesc:ga5e867a003c06046d7944bcb5723e6049"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set new time.  <br /></td></tr>
 146 <tr class="separator:ga5e867a003c06046d7944bcb5723e6049"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:ga3c57b3150717fb1a8cbbbac6a9b7ff69"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__time__control.html#ga3c57b3150717fb1a8cbbbac6a9b7ff69">ARM_ETH_MAC_TIMER_INC_TIME</a>&#160;&#160;&#160;(0x03UL)</td></tr>
 148 <tr class="memdesc:ga3c57b3150717fb1a8cbbbac6a9b7ff69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Increment current time.  <br /></td></tr>
 149 <tr class="separator:ga3c57b3150717fb1a8cbbbac6a9b7ff69"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="memitem:gaca9f1c4259d0342e9717a362de1ccf41"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__time__control.html#gaca9f1c4259d0342e9717a362de1ccf41">ARM_ETH_MAC_TIMER_DEC_TIME</a>&#160;&#160;&#160;(0x04UL)</td></tr>
 151 <tr class="memdesc:gaca9f1c4259d0342e9717a362de1ccf41"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decrement current time.  <br /></td></tr>
 152 <tr class="separator:gaca9f1c4259d0342e9717a362de1ccf41"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <tr class="memitem:ga04c2469ba027b020bc6b5baf3b51cf74"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__time__control.html#ga04c2469ba027b020bc6b5baf3b51cf74">ARM_ETH_MAC_TIMER_SET_ALARM</a>&#160;&#160;&#160;(0x05UL)</td></tr>
 154 <tr class="memdesc:ga04c2469ba027b020bc6b5baf3b51cf74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set alarm time.  <br /></td></tr>
 155 <tr class="separator:ga04c2469ba027b020bc6b5baf3b51cf74"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 <tr class="memitem:ga85cb862eba0934e958a8552022588db7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__time__control.html#ga85cb862eba0934e958a8552022588db7">ARM_ETH_MAC_TIMER_ADJUST_CLOCK</a>&#160;&#160;&#160;(0x06UL)</td></tr>
 157 <tr class="memdesc:ga85cb862eba0934e958a8552022588db7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adjust clock frequency; time-&gt;ns: correction factor * 2^31.  <br /></td></tr>
 158 <tr class="separator:ga85cb862eba0934e958a8552022588db7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 159 </table>
 160 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 161 <p>Control codes for <a class="el" href="group__eth__mac__interface__gr.html#ga85d9dc865af3702b71a514b18a588643">ARM_ETH_MAC_ControlTimer</a> function. </p>
 162 <p>The following timer controls are used as parameter <em>control</em> for the <a class="el" href="group__eth__mac__interface__gr.html#ga85d9dc865af3702b71a514b18a588643">ARM_ETH_MAC_ControlTimer</a> function: </p>
 163 <h2 class="groupheader">Macro Definition Documentation</h2>
 164 <a id="gad9a439b9727c032a7d851df2a7a622c2" name="gad9a439b9727c032a7d851df2a7a622c2"></a>
 165 <h2 class="memtitle"><span class="permalink"><a href="#gad9a439b9727c032a7d851df2a7a622c2">&#9670;&#160;</a></span>ARM_ETH_MAC_TIMER_GET_TIME</h2>
 166
 167 <div class="memitem">
 168 <div class="memproto">
 169       <table class="memname">
 170         <tr>
 171           <td class="memname">#define ARM_ETH_MAC_TIMER_GET_TIME&#160;&#160;&#160;(0x01UL)</td>
 172         </tr>
 173       </table>
 174 </div><div class="memdoc">
 175
 176 <p>Get current time. </p>
 177 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__eth__mac__interface__gr.html#ga85d9dc865af3702b71a514b18a588643" title="Control Precision Timer.">ARM_ETH_MAC_ControlTimer</a> </dd></dl>
 178
 179 </div>
 180 </div>
 181 <a id="ga5e867a003c06046d7944bcb5723e6049" name="ga5e867a003c06046d7944bcb5723e6049"></a>
 182 <h2 class="memtitle"><span class="permalink"><a href="#ga5e867a003c06046d7944bcb5723e6049">&#9670;&#160;</a></span>ARM_ETH_MAC_TIMER_SET_TIME</h2>
 183
 184 <div class="memitem">
 185 <div class="memproto">
 186       <table class="memname">
 187         <tr>
 188           <td class="memname">#define ARM_ETH_MAC_TIMER_SET_TIME&#160;&#160;&#160;(0x02UL)</td>
 189         </tr>
 190       </table>
 191 </div><div class="memdoc">
 192
 193 <p>Set new time. </p>
 194 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__eth__mac__interface__gr.html#ga85d9dc865af3702b71a514b18a588643" title="Control Precision Timer.">ARM_ETH_MAC_ControlTimer</a> </dd></dl>
 195
 196 </div>
 197 </div>
 198 <a id="ga3c57b3150717fb1a8cbbbac6a9b7ff69" name="ga3c57b3150717fb1a8cbbbac6a9b7ff69"></a>
 199 <h2 class="memtitle"><span class="permalink"><a href="#ga3c57b3150717fb1a8cbbbac6a9b7ff69">&#9670;&#160;</a></span>ARM_ETH_MAC_TIMER_INC_TIME</h2>
 200
 201 <div class="memitem">
 202 <div class="memproto">
 203       <table class="memname">
 204         <tr>
 205           <td class="memname">#define ARM_ETH_MAC_TIMER_INC_TIME&#160;&#160;&#160;(0x03UL)</td>
 206         </tr>
 207       </table>
 208 </div><div class="memdoc">
 209
 210 <p>Increment current time. </p>
 211 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__eth__mac__interface__gr.html#ga85d9dc865af3702b71a514b18a588643" title="Control Precision Timer.">ARM_ETH_MAC_ControlTimer</a> </dd></dl>
 212
 213 </div>
 214 </div>
 215 <a id="gaca9f1c4259d0342e9717a362de1ccf41" name="gaca9f1c4259d0342e9717a362de1ccf41"></a>
 216 <h2 class="memtitle"><span class="permalink"><a href="#gaca9f1c4259d0342e9717a362de1ccf41">&#9670;&#160;</a></span>ARM_ETH_MAC_TIMER_DEC_TIME</h2>
 217
 218 <div class="memitem">
 219 <div class="memproto">
 220       <table class="memname">
 221         <tr>
 222           <td class="memname">#define ARM_ETH_MAC_TIMER_DEC_TIME&#160;&#160;&#160;(0x04UL)</td>
 223         </tr>
 224       </table>
 225 </div><div class="memdoc">
 226
 227 <p>Decrement current time. </p>
 228 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__eth__mac__interface__gr.html#ga85d9dc865af3702b71a514b18a588643" title="Control Precision Timer.">ARM_ETH_MAC_ControlTimer</a> </dd></dl>
 229
 230 </div>
 231 </div>
 232 <a id="ga04c2469ba027b020bc6b5baf3b51cf74" name="ga04c2469ba027b020bc6b5baf3b51cf74"></a>
 233 <h2 class="memtitle"><span class="permalink"><a href="#ga04c2469ba027b020bc6b5baf3b51cf74">&#9670;&#160;</a></span>ARM_ETH_MAC_TIMER_SET_ALARM</h2>
 234
 235 <div class="memitem">
 236 <div class="memproto">
 237       <table class="memname">
 238         <tr>
 239           <td class="memname">#define ARM_ETH_MAC_TIMER_SET_ALARM&#160;&#160;&#160;(0x05UL)</td>
 240         </tr>
 241       </table>
 242 </div><div class="memdoc">
 243
 244 <p>Set alarm time. </p>
 245 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__eth__mac__interface__gr.html#ga85d9dc865af3702b71a514b18a588643" title="Control Precision Timer.">ARM_ETH_MAC_ControlTimer</a> </dd></dl>
 246
 247 </div>
 248 </div>
 249 <a id="ga85cb862eba0934e958a8552022588db7" name="ga85cb862eba0934e958a8552022588db7"></a>
 250 <h2 class="memtitle"><span class="permalink"><a href="#ga85cb862eba0934e958a8552022588db7">&#9670;&#160;</a></span>ARM_ETH_MAC_TIMER_ADJUST_CLOCK</h2>
 251
 252 <div class="memitem">
 253 <div class="memproto">
 254       <table class="memname">
 255         <tr>
 256           <td class="memname">#define ARM_ETH_MAC_TIMER_ADJUST_CLOCK&#160;&#160;&#160;(0x06UL)</td>
 257         </tr>
 258       </table>
 259 </div><div class="memdoc">
 260
 261 <p>Adjust clock frequency; time-&gt;ns: correction factor * 2^31. </p>
 262 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__eth__mac__interface__gr.html#ga85d9dc865af3702b71a514b18a588643" title="Control Precision Timer.">ARM_ETH_MAC_ControlTimer</a> </dd></dl>
 263
 264 </div>
 265 </div>
 266 </div><!-- contents -->
 267 </div><!-- doc-content -->
 268 <!-- start footer part -->
 269 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 270   <ul>
 271     <li class="footer">
 272       <script type="text/javascript">
 273         <!--
 274         writeFooter.call(this);
 275         //-->
 276       </script>
 277     </li>
 278   </ul>
 279 </div>
 280 </body>
 281 </html>