begriffs open source - cmsis/blob - main/Driver/html/group__eth__mac__ctrls.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 Controls</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, "CMSIS-Driver");
  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__ctrls.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 Controls<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> &raquo; <a class="el" href="group__eth__mac__control.html">Ethernet MAC Control Codes</a></div></div></div>
 133 </div><!--header-->
 134 <div class="contents">
 135
 136 <p>Configure and control the Ethernet MAC interface.
 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:ga7819c7a1aa7bbc13dc42d0fd7e75a23c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__ctrls.html#ga7819c7a1aa7bbc13dc42d0fd7e75a23c">ARM_ETH_MAC_CONFIGURE</a>&#160;&#160;&#160;(0x01UL)</td></tr>
 142 <tr class="memdesc:ga7819c7a1aa7bbc13dc42d0fd7e75a23c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configure MAC; arg = configuration.  <br /></td></tr>
 143 <tr class="separator:ga7819c7a1aa7bbc13dc42d0fd7e75a23c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:ga3a98c8a7ee5ed4b1ffd250eecaeefe5c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__ctrls.html#ga3a98c8a7ee5ed4b1ffd250eecaeefe5c">ARM_ETH_MAC_CONTROL_TX</a>&#160;&#160;&#160;(0x02UL)</td></tr>
 145 <tr class="memdesc:ga3a98c8a7ee5ed4b1ffd250eecaeefe5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transmitter; arg: 0=disabled (default), 1=enabled.  <br /></td></tr>
 146 <tr class="separator:ga3a98c8a7ee5ed4b1ffd250eecaeefe5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:gae0964364b81b38b6e1fbf7196f3be869"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__ctrls.html#gae0964364b81b38b6e1fbf7196f3be869">ARM_ETH_MAC_CONTROL_RX</a>&#160;&#160;&#160;(0x03UL)</td></tr>
 148 <tr class="memdesc:gae0964364b81b38b6e1fbf7196f3be869"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receiver; arg: 0=disabled (default), 1=enabled.  <br /></td></tr>
 149 <tr class="separator:gae0964364b81b38b6e1fbf7196f3be869"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="memitem:ga530812ef349a2e297f23de72e660fe27"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__ctrls.html#ga530812ef349a2e297f23de72e660fe27">ARM_ETH_MAC_FLUSH</a>&#160;&#160;&#160;(0x04UL)</td></tr>
 151 <tr class="memdesc:ga530812ef349a2e297f23de72e660fe27"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flush buffer; arg = ARM_ETH_MAC_FLUSH_...  <br /></td></tr>
 152 <tr class="separator:ga530812ef349a2e297f23de72e660fe27"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <tr class="memitem:ga4afe66589216f566f529af52f9075fdf"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__ctrls.html#ga4afe66589216f566f529af52f9075fdf">ARM_ETH_MAC_SLEEP</a>&#160;&#160;&#160;(0x05UL)</td></tr>
 154 <tr class="memdesc:ga4afe66589216f566f529af52f9075fdf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sleep mode; arg: 1=enter and wait for Magic packet, 0=exit.  <br /></td></tr>
 155 <tr class="separator:ga4afe66589216f566f529af52f9075fdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 <tr class="memitem:gab332b58ba320e73864830dc42ad74181"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__ctrls.html#gab332b58ba320e73864830dc42ad74181">ARM_ETH_MAC_VLAN_FILTER</a>&#160;&#160;&#160;(0x06UL)</td></tr>
 157 <tr class="memdesc:gab332b58ba320e73864830dc42ad74181"><td class="mdescLeft">&#160;</td><td class="mdescRight">VLAN Filter for received frames; arg15..0: VLAN Tag; arg16: optional ARM_ETH_MAC_VLAN_FILTER_ID_ONLY; 0=disabled (default)  <br /></td></tr>
 158 <tr class="separator:gab332b58ba320e73864830dc42ad74181"><td class="memSeparator" colspan="2">&#160;</td></tr>
 159 </table>
 160 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 161 <p>Configure and control the Ethernet MAC interface. </p>
 162 <h2 class="groupheader">Macro Definition Documentation</h2>
 163 <a id="ga7819c7a1aa7bbc13dc42d0fd7e75a23c" name="ga7819c7a1aa7bbc13dc42d0fd7e75a23c"></a>
 164 <h2 class="memtitle"><span class="permalink"><a href="#ga7819c7a1aa7bbc13dc42d0fd7e75a23c">&#9670;&#160;</a></span>ARM_ETH_MAC_CONFIGURE</h2>
 165
 166 <div class="memitem">
 167 <div class="memproto">
 168       <table class="memname">
 169         <tr>
 170           <td class="memname">#define ARM_ETH_MAC_CONFIGURE&#160;&#160;&#160;(0x01UL)</td>
 171         </tr>
 172       </table>
 173 </div><div class="memdoc">
 174
 175 <p>Configure MAC; arg = configuration. </p>
 176 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536" title="Control Ethernet Interface.">ARM_ETH_MAC_Control</a> </dd></dl>
 177
 178 </div>
 179 </div>
 180 <a id="ga3a98c8a7ee5ed4b1ffd250eecaeefe5c" name="ga3a98c8a7ee5ed4b1ffd250eecaeefe5c"></a>
 181 <h2 class="memtitle"><span class="permalink"><a href="#ga3a98c8a7ee5ed4b1ffd250eecaeefe5c">&#9670;&#160;</a></span>ARM_ETH_MAC_CONTROL_TX</h2>
 182
 183 <div class="memitem">
 184 <div class="memproto">
 185       <table class="memname">
 186         <tr>
 187           <td class="memname">#define ARM_ETH_MAC_CONTROL_TX&#160;&#160;&#160;(0x02UL)</td>
 188         </tr>
 189       </table>
 190 </div><div class="memdoc">
 191
 192 <p>Transmitter; arg: 0=disabled (default), 1=enabled. </p>
 193 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536" title="Control Ethernet Interface.">ARM_ETH_MAC_Control</a> </dd></dl>
 194
 195 </div>
 196 </div>
 197 <a id="gae0964364b81b38b6e1fbf7196f3be869" name="gae0964364b81b38b6e1fbf7196f3be869"></a>
 198 <h2 class="memtitle"><span class="permalink"><a href="#gae0964364b81b38b6e1fbf7196f3be869">&#9670;&#160;</a></span>ARM_ETH_MAC_CONTROL_RX</h2>
 199
 200 <div class="memitem">
 201 <div class="memproto">
 202       <table class="memname">
 203         <tr>
 204           <td class="memname">#define ARM_ETH_MAC_CONTROL_RX&#160;&#160;&#160;(0x03UL)</td>
 205         </tr>
 206       </table>
 207 </div><div class="memdoc">
 208
 209 <p>Receiver; arg: 0=disabled (default), 1=enabled. </p>
 210 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536" title="Control Ethernet Interface.">ARM_ETH_MAC_Control</a> </dd></dl>
 211
 212 </div>
 213 </div>
 214 <a id="ga530812ef349a2e297f23de72e660fe27" name="ga530812ef349a2e297f23de72e660fe27"></a>
 215 <h2 class="memtitle"><span class="permalink"><a href="#ga530812ef349a2e297f23de72e660fe27">&#9670;&#160;</a></span>ARM_ETH_MAC_FLUSH</h2>
 216
 217 <div class="memitem">
 218 <div class="memproto">
 219       <table class="memname">
 220         <tr>
 221           <td class="memname">#define ARM_ETH_MAC_FLUSH&#160;&#160;&#160;(0x04UL)</td>
 222         </tr>
 223       </table>
 224 </div><div class="memdoc">
 225
 226 <p>Flush buffer; arg = ARM_ETH_MAC_FLUSH_... </p>
 227 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536" title="Control Ethernet Interface.">ARM_ETH_MAC_Control</a> </dd></dl>
 228
 229 </div>
 230 </div>
 231 <a id="ga4afe66589216f566f529af52f9075fdf" name="ga4afe66589216f566f529af52f9075fdf"></a>
 232 <h2 class="memtitle"><span class="permalink"><a href="#ga4afe66589216f566f529af52f9075fdf">&#9670;&#160;</a></span>ARM_ETH_MAC_SLEEP</h2>
 233
 234 <div class="memitem">
 235 <div class="memproto">
 236       <table class="memname">
 237         <tr>
 238           <td class="memname">#define ARM_ETH_MAC_SLEEP&#160;&#160;&#160;(0x05UL)</td>
 239         </tr>
 240       </table>
 241 </div><div class="memdoc">
 242
 243 <p>Sleep mode; arg: 1=enter and wait for Magic packet, 0=exit. </p>
 244 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536" title="Control Ethernet Interface.">ARM_ETH_MAC_Control</a> </dd></dl>
 245
 246 </div>
 247 </div>
 248 <a id="gab332b58ba320e73864830dc42ad74181" name="gab332b58ba320e73864830dc42ad74181"></a>
 249 <h2 class="memtitle"><span class="permalink"><a href="#gab332b58ba320e73864830dc42ad74181">&#9670;&#160;</a></span>ARM_ETH_MAC_VLAN_FILTER</h2>
 250
 251 <div class="memitem">
 252 <div class="memproto">
 253       <table class="memname">
 254         <tr>
 255           <td class="memname">#define ARM_ETH_MAC_VLAN_FILTER&#160;&#160;&#160;(0x06UL)</td>
 256         </tr>
 257       </table>
 258 </div><div class="memdoc">
 259
 260 <p>VLAN Filter for received frames; arg15..0: VLAN Tag; arg16: optional ARM_ETH_MAC_VLAN_FILTER_ID_ONLY; 0=disabled (default) </p>
 261 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536" title="Control Ethernet Interface.">ARM_ETH_MAC_Control</a> </dd></dl>
 262
 263 </div>
 264 </div>
 265 </div><!-- contents -->
 266 </div><!-- doc-content -->
 267 <!-- start footer part -->
 268 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 269   <ul>
 270     <li class="footer">
 271       <script type="text/javascript">
 272         <!--
 273         writeFooter.call(this);
 274         //-->
 275       </script>
 276     </li>
 277   </ul>
 278 </div>
 279 </body>
 280 </html>