begriffs open source - cmsis/blob - main/Driver/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 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <script type="text/javascript" src="tabs.js"></script>
  13 <script type="text/javascript" src="footer.js"></script>
  14 <script type="text/javascript" src="navtree.js"></script>
  15 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  16 <script type="text/javascript" src="resize.js"></script>
  17 <script type="text/javascript" src="navtreedata.js"></script>
  18 <script type="text/javascript" src="navtree.js"></script>
  19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  20 <script type="text/javascript" src="search/searchdata.js"></script>
  21 <script type="text/javascript" src="search/search.js"></script>
  22 <script type="text/javascript">
  23 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  24   $(document).ready(function() { init_search(); });
  25 /* @license-end */
  26 </script>
  27 <script type="text/javascript" src="darkmode_toggle.js"></script>
  28 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  29 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  30 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  31 <link href="extra_tabs.css" rel="stylesheet" type="text/css"/>
  32 <link href="version.css" rel="stylesheet" type="text/css"/>
  33 <script type="text/javascript" src="../../version.js"></script>
  34 </head>
  35 <body>
  36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  37 <div id="titlearea">
  38 <table cellspacing="0" cellpadding="0">
  39  <tbody>
  40  <tr style="height: 55px;">
  41   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  42   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  43    <div id="projectname">CMSIS-Driver
  44    &#160;<span id="projectnumber"><script type="text/javascript">
  45      <!--
  46      writeHeader.call(this);
  47      writeVersionDropdown.call(this, "CMSIS-Driver");
  48      //-->
  49     </script>
  50    </span>
  51    </div>
  52    <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
  53   </td>
  54    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  55         <span class="left">
  56           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  57           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  58                onfocus="searchBox.OnSearchFieldFocus(true)"
  59                onblur="searchBox.OnSearchFieldFocus(false)"
  60                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  61           </span><span class="right">
  62             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  63           </span>
  64         </div>
  65 </td>
  66   <!--END !PROJECT_NAME-->
  67  </tr>
  68  </tbody>
  69 </table>
  70 </div>
  71 <!-- end header part -->
  72 <div id="CMSISnav" class="tabs1">
  73   <ul class="tablist">
  74     <script type="text/javascript">
  75       writeComponentTabs.call(this);
  76     </script>
  77   </ul>
  78 </div>
  79 <script type="text/javascript">
  80   writeSubComponentTabs.call(this);
  81 </script>
  82 <!-- Generated by Doxygen 1.9.6 -->
  83 <script type="text/javascript">
  84 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  85 var searchBox = new SearchBox("searchBox", "search/",'.html');
  86 /* @license-end */
  87 </script>
  88 </div><!-- top -->
  89 <div id="side-nav" class="ui-resizable side-nav-resizable">
  90   <div id="nav-tree">
  91     <div id="nav-tree-contents">
  92       <div id="nav-sync" class="sync"></div>
  93     </div>
  94   </div>
  95   <div id="splitbar" style="-moz-user-select:none;"
  96        class="ui-resizable-handle">
  97   </div>
  98 </div>
  99 <script type="text/javascript">
 100 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 101 $(document).ready(function(){initNavTree('group__eth__mac__ctrls.html',''); initResizable(); });
 102 /* @license-end */
 103 </script>
 104 <div id="doc-content">
 105 <!-- window showing the filter options -->
 106 <div id="MSearchSelectWindow"
 107      onmouseover="return searchBox.OnSearchSelectShow()"
 108      onmouseout="return searchBox.OnSearchSelectHide()"
 109      onkeydown="return searchBox.OnSearchSelectKey(event)">
 110 </div>
 111
 112 <!-- iframe showing the search results (closed by default) -->
 113 <div id="MSearchResultsWindow">
 114 <div id="MSearchResults">
 115 <div class="SRPage">
 116 <div id="SRIndex">
 117 <div id="SRResults"></div>
 118 <div class="SRStatus" id="Loading">Loading...</div>
 119 <div class="SRStatus" id="Searching">Searching...</div>
 120 <div class="SRStatus" id="NoMatches">No Matches</div>
 121 </div>
 122 </div>
 123 </div>
 124 </div>
 125
 126 <div class="header">
 127   <div class="summary">
 128 <a href="#define-members">Macros</a>  </div>
 129   <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>
 130 </div><!--header-->
 131 <div class="contents">
 132
 133 <p>Configure and control the Ethernet MAC interface.
 134 <a href="#details">More...</a></p>
 135 <table class="memberdecls">
 136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 137 Macros</h2></td></tr>
 138 <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>
 139 <tr class="memdesc:ga7819c7a1aa7bbc13dc42d0fd7e75a23c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configure MAC; arg = configuration.  <br /></td></tr>
 140 <tr class="separator:ga7819c7a1aa7bbc13dc42d0fd7e75a23c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <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>
 142 <tr class="memdesc:ga3a98c8a7ee5ed4b1ffd250eecaeefe5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transmitter; arg: 0=disabled (default), 1=enabled.  <br /></td></tr>
 143 <tr class="separator:ga3a98c8a7ee5ed4b1ffd250eecaeefe5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <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>
 145 <tr class="memdesc:gae0964364b81b38b6e1fbf7196f3be869"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receiver; arg: 0=disabled (default), 1=enabled.  <br /></td></tr>
 146 <tr class="separator:gae0964364b81b38b6e1fbf7196f3be869"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <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>
 148 <tr class="memdesc:ga530812ef349a2e297f23de72e660fe27"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flush buffer; arg = ARM_ETH_MAC_FLUSH_...  <br /></td></tr>
 149 <tr class="separator:ga530812ef349a2e297f23de72e660fe27"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <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>
 151 <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>
 152 <tr class="separator:ga4afe66589216f566f529af52f9075fdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <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>
 154 <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>
 155 <tr class="separator:gab332b58ba320e73864830dc42ad74181"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 </table>
 157 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 158 <p>Configure and control the Ethernet MAC interface. </p>
 159 <h2 class="groupheader">Macro Definition Documentation</h2>
 160 <a id="ga7819c7a1aa7bbc13dc42d0fd7e75a23c" name="ga7819c7a1aa7bbc13dc42d0fd7e75a23c"></a>
 161 <h2 class="memtitle"><span class="permalink"><a href="#ga7819c7a1aa7bbc13dc42d0fd7e75a23c">&#9670;&#160;</a></span>ARM_ETH_MAC_CONFIGURE</h2>
 162
 163 <div class="memitem">
 164 <div class="memproto">
 165       <table class="memname">
 166         <tr>
 167           <td class="memname">#define ARM_ETH_MAC_CONFIGURE&#160;&#160;&#160;(0x01UL)</td>
 168         </tr>
 169       </table>
 170 </div><div class="memdoc">
 171
 172 <p>Configure MAC; arg = configuration. </p>
 173 <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>
 174
 175 </div>
 176 </div>
 177 <a id="ga3a98c8a7ee5ed4b1ffd250eecaeefe5c" name="ga3a98c8a7ee5ed4b1ffd250eecaeefe5c"></a>
 178 <h2 class="memtitle"><span class="permalink"><a href="#ga3a98c8a7ee5ed4b1ffd250eecaeefe5c">&#9670;&#160;</a></span>ARM_ETH_MAC_CONTROL_TX</h2>
 179
 180 <div class="memitem">
 181 <div class="memproto">
 182       <table class="memname">
 183         <tr>
 184           <td class="memname">#define ARM_ETH_MAC_CONTROL_TX&#160;&#160;&#160;(0x02UL)</td>
 185         </tr>
 186       </table>
 187 </div><div class="memdoc">
 188
 189 <p>Transmitter; arg: 0=disabled (default), 1=enabled. </p>
 190 <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>
 191
 192 </div>
 193 </div>
 194 <a id="gae0964364b81b38b6e1fbf7196f3be869" name="gae0964364b81b38b6e1fbf7196f3be869"></a>
 195 <h2 class="memtitle"><span class="permalink"><a href="#gae0964364b81b38b6e1fbf7196f3be869">&#9670;&#160;</a></span>ARM_ETH_MAC_CONTROL_RX</h2>
 196
 197 <div class="memitem">
 198 <div class="memproto">
 199       <table class="memname">
 200         <tr>
 201           <td class="memname">#define ARM_ETH_MAC_CONTROL_RX&#160;&#160;&#160;(0x03UL)</td>
 202         </tr>
 203       </table>
 204 </div><div class="memdoc">
 205
 206 <p>Receiver; arg: 0=disabled (default), 1=enabled. </p>
 207 <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>
 208
 209 </div>
 210 </div>
 211 <a id="ga530812ef349a2e297f23de72e660fe27" name="ga530812ef349a2e297f23de72e660fe27"></a>
 212 <h2 class="memtitle"><span class="permalink"><a href="#ga530812ef349a2e297f23de72e660fe27">&#9670;&#160;</a></span>ARM_ETH_MAC_FLUSH</h2>
 213
 214 <div class="memitem">
 215 <div class="memproto">
 216       <table class="memname">
 217         <tr>
 218           <td class="memname">#define ARM_ETH_MAC_FLUSH&#160;&#160;&#160;(0x04UL)</td>
 219         </tr>
 220       </table>
 221 </div><div class="memdoc">
 222
 223 <p>Flush buffer; arg = ARM_ETH_MAC_FLUSH_... </p>
 224 <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>
 225
 226 </div>
 227 </div>
 228 <a id="ga4afe66589216f566f529af52f9075fdf" name="ga4afe66589216f566f529af52f9075fdf"></a>
 229 <h2 class="memtitle"><span class="permalink"><a href="#ga4afe66589216f566f529af52f9075fdf">&#9670;&#160;</a></span>ARM_ETH_MAC_SLEEP</h2>
 230
 231 <div class="memitem">
 232 <div class="memproto">
 233       <table class="memname">
 234         <tr>
 235           <td class="memname">#define ARM_ETH_MAC_SLEEP&#160;&#160;&#160;(0x05UL)</td>
 236         </tr>
 237       </table>
 238 </div><div class="memdoc">
 239
 240 <p>Sleep mode; arg: 1=enter and wait for Magic packet, 0=exit. </p>
 241 <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>
 242
 243 </div>
 244 </div>
 245 <a id="gab332b58ba320e73864830dc42ad74181" name="gab332b58ba320e73864830dc42ad74181"></a>
 246 <h2 class="memtitle"><span class="permalink"><a href="#gab332b58ba320e73864830dc42ad74181">&#9670;&#160;</a></span>ARM_ETH_MAC_VLAN_FILTER</h2>
 247
 248 <div class="memitem">
 249 <div class="memproto">
 250       <table class="memname">
 251         <tr>
 252           <td class="memname">#define ARM_ETH_MAC_VLAN_FILTER&#160;&#160;&#160;(0x06UL)</td>
 253         </tr>
 254       </table>
 255 </div><div class="memdoc">
 256
 257 <p>VLAN Filter for received frames; arg15..0: VLAN Tag; arg16: optional ARM_ETH_MAC_VLAN_FILTER_ID_ONLY; 0=disabled (default) </p>
 258 <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>
 259
 260 </div>
 261 </div>
 262 </div><!-- contents -->
 263 </div><!-- doc-content -->
 264 <!-- start footer part -->
 265 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 266   <ul>
 267     <li class="footer">
 268       <script type="text/javascript">
 269         <!--
 270         writeFooter.call(this);
 271         //-->
 272       </script>
 273     </li>
 274   </ul>
 275 </div>
 276 </body>
 277 </html>