begriffs open source - cmsis/blob - main/Driver/html/group__eth__mac__interface__gr.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 Interface</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__interface__gr.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="#groups">Content</a> &#124;
 132 <a href="#nested-classes">Data Structures</a> &#124;
 133 <a href="#typedef-members">Typedefs</a> &#124;
 134 <a href="#func-members">Functions</a>  </div>
 135   <div class="headertitle"><div class="title">Ethernet MAC Interface<div class="ingroups"><a class="el" href="group__eth__interface__gr.html">Ethernet Interface</a></div></div></div>
 136 </div><!--header-->
 137 <div class="contents">
 138
 139 <p>Driver API for Ethernet MAC Peripheral (Driver_ETH_MAC.h)
 140 <a href="#details">More...</a></p>
 141 <table class="memberdecls">
 142 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a>
 143 Content</h2></td></tr>
 144 <tr class="memitem:group__ETH__MAC__events"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ETH__MAC__events.html">Ethernet MAC Events</a></td></tr>
 145 <tr class="memdesc:group__ETH__MAC__events"><td class="mdescLeft">&#160;</td><td class="mdescRight">The Ethernet MAC driver generates call back events that are notified via the function <a class="el" href="group__eth__mac__interface__gr.html#gae0697be4c4229601f3bfc17e2978ada6">ARM_ETH_MAC_SignalEvent</a>. <br /></td></tr>
 146 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:group__eth__mac__control"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__control.html">Ethernet MAC Control Codes</a></td></tr>
 148 <tr class="memdesc:group__eth__mac__control"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configure and control the Ethernet MAC using the <a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536">ARM_ETH_MAC_Control</a>. <br /></td></tr>
 149 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="memitem:group__eth__mac__time__control"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__time__control.html">Ethernet MAC Timer Control Codes</a></td></tr>
 151 <tr class="memdesc:group__eth__mac__time__control"><td class="mdescLeft">&#160;</td><td class="mdescRight">Control codes for <a class="el" href="group__eth__mac__interface__gr.html#ga85d9dc865af3702b71a514b18a588643">ARM_ETH_MAC_ControlTimer</a> function. <br /></td></tr>
 152 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <tr class="memitem:group__eth__mac__frame__transmit__ctrls"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__frame__transmit__ctrls.html">Ethernet MAC Frame Transmit Flags</a></td></tr>
 154 <tr class="memdesc:group__eth__mac__frame__transmit__ctrls"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specify frame transmit flags. <br /></td></tr>
 155 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 </table><table class="memberdecls">
 157 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
 158 Data Structures</h2></td></tr>
 159 <tr class="memitem:structARM__ETH__MAC__CAPABILITIES"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES">ARM_ETH_MAC_CAPABILITIES</a></td></tr>
 160 <tr class="memdesc:structARM__ETH__MAC__CAPABILITIES"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ethernet MAC Capabilities.  <a href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES">More...</a><br /></td></tr>
 161 <tr class="separator:structARM__ETH__MAC__CAPABILITIES"><td class="memSeparator" colspan="2">&#160;</td></tr>
 162 <tr class="memitem:structARM__DRIVER__ETH__MAC"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#structARM__DRIVER__ETH__MAC">ARM_DRIVER_ETH_MAC</a></td></tr>
 163 <tr class="memdesc:structARM__DRIVER__ETH__MAC"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access structure of the Ethernet MAC Driver.  <a href="group__eth__mac__interface__gr.html#structARM__DRIVER__ETH__MAC">More...</a><br /></td></tr>
 164 <tr class="separator:structARM__DRIVER__ETH__MAC"><td class="memSeparator" colspan="2">&#160;</td></tr>
 165 <tr class="memitem:structARM__ETH__MAC__TIME"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a></td></tr>
 166 <tr class="memdesc:structARM__ETH__MAC__TIME"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ethernet MAC Time.  <a href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">More...</a><br /></td></tr>
 167 <tr class="separator:structARM__ETH__MAC__TIME"><td class="memSeparator" colspan="2">&#160;</td></tr>
 168 </table><table class="memberdecls">
 169 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
 170 Typedefs</h2></td></tr>
 171 <tr class="memitem:gadfc95cb09c541a29a72da86963668726"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#gadfc95cb09c541a29a72da86963668726">ARM_ETH_MAC_SignalEvent_t</a>) (uint32_t event)</td></tr>
 172 <tr class="memdesc:gadfc95cb09c541a29a72da86963668726"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gae0697be4c4229601f3bfc17e2978ada6">ARM_ETH_MAC_SignalEvent</a> : Signal Ethernet Event.  <br /></td></tr>
 173 <tr class="separator:gadfc95cb09c541a29a72da86963668726"><td class="memSeparator" colspan="2">&#160;</td></tr>
 174 </table><table class="memberdecls">
 175 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 176 Functions</h2></td></tr>
 177 <tr class="memitem:ga86b15062c297384ad5842dd57b9d6b1d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ga86b15062c297384ad5842dd57b9d6b1d">ARM_ETH_MAC_GetVersion</a> (void)</td></tr>
 178 <tr class="memdesc:ga86b15062c297384ad5842dd57b9d6b1d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get driver version.  <br /></td></tr>
 179 <tr class="separator:ga86b15062c297384ad5842dd57b9d6b1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 180 <tr class="memitem:ga2b13b230502736d8c7679b359dff20d0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES">ARM_ETH_MAC_CAPABILITIES</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ga2b13b230502736d8c7679b359dff20d0">ARM_ETH_MAC_GetCapabilities</a> (void)</td></tr>
 181 <tr class="memdesc:ga2b13b230502736d8c7679b359dff20d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get driver capabilities.  <br /></td></tr>
 182 <tr class="separator:ga2b13b230502736d8c7679b359dff20d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 183 <tr class="memitem:gacf42d11b171cd032f0ec1de6db2b6832"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#gacf42d11b171cd032f0ec1de6db2b6832">ARM_ETH_MAC_Initialize</a> (<a class="el" href="group__eth__mac__interface__gr.html#gadfc95cb09c541a29a72da86963668726">ARM_ETH_MAC_SignalEvent_t</a> cb_event)</td></tr>
 184 <tr class="memdesc:gacf42d11b171cd032f0ec1de6db2b6832"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize Ethernet MAC Device.  <br /></td></tr>
 185 <tr class="separator:gacf42d11b171cd032f0ec1de6db2b6832"><td class="memSeparator" colspan="2">&#160;</td></tr>
 186 <tr class="memitem:gacb2c2ae06f32328775bffbdeaaabfb5d"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#gacb2c2ae06f32328775bffbdeaaabfb5d">ARM_ETH_MAC_Uninitialize</a> (void)</td></tr>
 187 <tr class="memdesc:gacb2c2ae06f32328775bffbdeaaabfb5d"><td class="mdescLeft">&#160;</td><td class="mdescRight">De-initialize Ethernet MAC Device.  <br /></td></tr>
 188 <tr class="separator:gacb2c2ae06f32328775bffbdeaaabfb5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 189 <tr class="memitem:ga346fef040a0e9bac5762a04a306b1be7"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ga346fef040a0e9bac5762a04a306b1be7">ARM_ETH_MAC_PowerControl</a> (<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
 190 <tr class="memdesc:ga346fef040a0e9bac5762a04a306b1be7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Control Ethernet MAC Device Power.  <br /></td></tr>
 191 <tr class="separator:ga346fef040a0e9bac5762a04a306b1be7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 192 <tr class="memitem:ga66308c1e791952047e974bd653037fae"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ga66308c1e791952047e974bd653037fae">ARM_ETH_MAC_GetMacAddress</a> (<a class="el" href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">ARM_ETH_MAC_ADDR</a> *ptr_addr)</td></tr>
 193 <tr class="memdesc:ga66308c1e791952047e974bd653037fae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get Ethernet MAC Address.  <br /></td></tr>
 194 <tr class="separator:ga66308c1e791952047e974bd653037fae"><td class="memSeparator" colspan="2">&#160;</td></tr>
 195 <tr class="memitem:ga7cc3d17c7312c5032202dfd9a915f24a"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ga7cc3d17c7312c5032202dfd9a915f24a">ARM_ETH_MAC_SetMacAddress</a> (const <a class="el" href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">ARM_ETH_MAC_ADDR</a> *ptr_addr)</td></tr>
 196 <tr class="memdesc:ga7cc3d17c7312c5032202dfd9a915f24a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set Ethernet MAC Address.  <br /></td></tr>
 197 <tr class="separator:ga7cc3d17c7312c5032202dfd9a915f24a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 198 <tr class="memitem:ga150fe30290275a4b32756f94208124e8"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ga150fe30290275a4b32756f94208124e8">ARM_ETH_MAC_SetAddressFilter</a> (const <a class="el" href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">ARM_ETH_MAC_ADDR</a> *ptr_addr, uint32_t num_addr)</td></tr>
 199 <tr class="memdesc:ga150fe30290275a4b32756f94208124e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configure Address Filter.  <br /></td></tr>
 200 <tr class="separator:ga150fe30290275a4b32756f94208124e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 201 <tr class="memitem:ga5bf58defdb239ed7dc948f1da147a1c3"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ga5bf58defdb239ed7dc948f1da147a1c3">ARM_ETH_MAC_SendFrame</a> (const uint8_t *frame, uint32_t len, uint32_t flags)</td></tr>
 202 <tr class="memdesc:ga5bf58defdb239ed7dc948f1da147a1c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send Ethernet frame.  <br /></td></tr>
 203 <tr class="separator:ga5bf58defdb239ed7dc948f1da147a1c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 204 <tr class="memitem:ga4b79f57d8624bb4410ee12c73a483993"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ga4b79f57d8624bb4410ee12c73a483993">ARM_ETH_MAC_ReadFrame</a> (uint8_t *frame, uint32_t len)</td></tr>
 205 <tr class="memdesc:ga4b79f57d8624bb4410ee12c73a483993"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read data of received Ethernet frame.  <br /></td></tr>
 206 <tr class="separator:ga4b79f57d8624bb4410ee12c73a483993"><td class="memSeparator" colspan="2">&#160;</td></tr>
 207 <tr class="memitem:ga5ee86d6b0efab5329b9bc191c23a466d"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ga5ee86d6b0efab5329b9bc191c23a466d">ARM_ETH_MAC_GetRxFrameSize</a> (void)</td></tr>
 208 <tr class="memdesc:ga5ee86d6b0efab5329b9bc191c23a466d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get size of received Ethernet frame.  <br /></td></tr>
 209 <tr class="separator:ga5ee86d6b0efab5329b9bc191c23a466d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 210 <tr class="memitem:gaa7c6865fb09754be869778142466c5e4"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#gaa7c6865fb09754be869778142466c5e4">ARM_ETH_MAC_GetRxFrameTime</a> (<a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *time)</td></tr>
 211 <tr class="memdesc:gaa7c6865fb09754be869778142466c5e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get time of received Ethernet frame.  <br /></td></tr>
 212 <tr class="separator:gaa7c6865fb09754be869778142466c5e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 213 <tr class="memitem:ga115b5c7e149aec2b181de760f5d83f60"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ga115b5c7e149aec2b181de760f5d83f60">ARM_ETH_MAC_GetTxFrameTime</a> (<a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *time)</td></tr>
 214 <tr class="memdesc:ga115b5c7e149aec2b181de760f5d83f60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get time of transmitted Ethernet frame.  <br /></td></tr>
 215 <tr class="separator:ga115b5c7e149aec2b181de760f5d83f60"><td class="memSeparator" colspan="2">&#160;</td></tr>
 216 <tr class="memitem:gac3e90c66058d20077f04ac8e8b8d0536"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536">ARM_ETH_MAC_Control</a> (uint32_t control, uint32_t arg)</td></tr>
 217 <tr class="memdesc:gac3e90c66058d20077f04ac8e8b8d0536"><td class="mdescLeft">&#160;</td><td class="mdescRight">Control Ethernet Interface.  <br /></td></tr>
 218 <tr class="separator:gac3e90c66058d20077f04ac8e8b8d0536"><td class="memSeparator" colspan="2">&#160;</td></tr>
 219 <tr class="memitem:ga85d9dc865af3702b71a514b18a588643"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ga85d9dc865af3702b71a514b18a588643">ARM_ETH_MAC_ControlTimer</a> (uint32_t control, <a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *time)</td></tr>
 220 <tr class="memdesc:ga85d9dc865af3702b71a514b18a588643"><td class="mdescLeft">&#160;</td><td class="mdescRight">Control Precision Timer.  <br /></td></tr>
 221 <tr class="separator:ga85d9dc865af3702b71a514b18a588643"><td class="memSeparator" colspan="2">&#160;</td></tr>
 222 <tr class="memitem:gaded29ad58366e9222487db9944373c29"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#gaded29ad58366e9222487db9944373c29">ARM_ETH_MAC_PHY_Read</a> (uint8_t phy_addr, uint8_t reg_addr, uint16_t *data)</td></tr>
 223 <tr class="memdesc:gaded29ad58366e9222487db9944373c29"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read Ethernet PHY Register through Management Interface.  <br /></td></tr>
 224 <tr class="separator:gaded29ad58366e9222487db9944373c29"><td class="memSeparator" colspan="2">&#160;</td></tr>
 225 <tr class="memitem:ga79dd38672749aeebd28f39d9b4f813ce"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ga79dd38672749aeebd28f39d9b4f813ce">ARM_ETH_MAC_PHY_Write</a> (uint8_t phy_addr, uint8_t reg_addr, uint16_t data)</td></tr>
 226 <tr class="memdesc:ga79dd38672749aeebd28f39d9b4f813ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write Ethernet PHY Register through Management Interface.  <br /></td></tr>
 227 <tr class="separator:ga79dd38672749aeebd28f39d9b4f813ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
 228 <tr class="memitem:gae0697be4c4229601f3bfc17e2978ada6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#gae0697be4c4229601f3bfc17e2978ada6">ARM_ETH_MAC_SignalEvent</a> (uint32_t event)</td></tr>
 229 <tr class="memdesc:gae0697be4c4229601f3bfc17e2978ada6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback function that signals a Ethernet Event.  <br /></td></tr>
 230 <tr class="separator:gae0697be4c4229601f3bfc17e2978ada6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 231 </table>
 232 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 233 <p>Driver API for Ethernet MAC Peripheral (Driver_ETH_MAC.h) </p>
 234 <p>The following section describes the Ethernet MAC Interface as defined in the Driver_ETH_MAC.h header file. </p>
 235 <hr/><h2 class="groupheader">Data Structure Documentation</h2>
 236 <a name="structARM__ETH__MAC__CAPABILITIES" id="structARM__ETH__MAC__CAPABILITIES"></a>
 237 <h2 class="memtitle"><span class="permalink"><a href="#structARM__ETH__MAC__CAPABILITIES">&#9670;&#160;</a></span>ARM_ETH_MAC_CAPABILITIES</h2>
 238
 239 <div class="memitem">
 240 <div class="memproto">
 241       <table class="memname">
 242         <tr>
 243           <td class="memname">struct ARM_ETH_MAC_CAPABILITIES</td>
 244         </tr>
 245       </table>
 246 </div><div class="memdoc">
 247 <div class="textblock"><p>Ethernet MAC Capabilities. </p>
 248 <p>An Ethernet MAC driver can be implemented with different capabilities. <br  />
 249  The data fields of this struct encode the capabilities implemented by this driver.</p>
 250 <p><b>Returned by:</b></p><ul>
 251 <li><a class="el" href="group__eth__mac__interface__gr.html#ga2b13b230502736d8c7679b359dff20d0">ARM_ETH_MAC_GetCapabilities</a> </li>
 252 </ul>
 253 </div><table class="fieldtable">
 254 <tr><th colspan="3">Data Fields</th></tr>
 255 <tr><td class="fieldtype">
 256 <a id="a0051111be2e389c3161da1c444746216" name="a0051111be2e389c3161da1c444746216"></a>uint32_t</td>
 257 <td class="fieldname">
 258 checksum_offload_rx_ip4: 1</td>
 259 <td class="fielddoc">
 260 1 = IPv4 header checksum verified on receive </td></tr>
 261 <tr><td class="fieldtype">
 262 <a id="a674b2306c64901e924b3cb7bb882f32f" name="a674b2306c64901e924b3cb7bb882f32f"></a>uint32_t</td>
 263 <td class="fieldname">
 264 checksum_offload_rx_ip6: 1</td>
 265 <td class="fielddoc">
 266 1 = IPv6 checksum verification supported on receive </td></tr>
 267 <tr><td class="fieldtype">
 268 <a id="a5a447f05a5fbfd35896aad9cd769511c" name="a5a447f05a5fbfd35896aad9cd769511c"></a>uint32_t</td>
 269 <td class="fieldname">
 270 checksum_offload_rx_udp: 1</td>
 271 <td class="fielddoc">
 272 1 = UDP payload checksum verified on receive </td></tr>
 273 <tr><td class="fieldtype">
 274 <a id="a730d6be6a7b868e0690d9548e77b7aae" name="a730d6be6a7b868e0690d9548e77b7aae"></a>uint32_t</td>
 275 <td class="fieldname">
 276 checksum_offload_rx_tcp: 1</td>
 277 <td class="fielddoc">
 278 1 = TCP payload checksum verified on receive </td></tr>
 279 <tr><td class="fieldtype">
 280 <a id="a142179445bfdbaaaf0d451f277fb0e96" name="a142179445bfdbaaaf0d451f277fb0e96"></a>uint32_t</td>
 281 <td class="fieldname">
 282 checksum_offload_rx_icmp: 1</td>
 283 <td class="fielddoc">
 284 1 = ICMP payload checksum verified on receive </td></tr>
 285 <tr><td class="fieldtype">
 286 <a id="ac787d70407ce70e28724932fb32ef0ba" name="ac787d70407ce70e28724932fb32ef0ba"></a>uint32_t</td>
 287 <td class="fieldname">
 288 checksum_offload_tx_ip4: 1</td>
 289 <td class="fielddoc">
 290 1 = IPv4 header checksum generated on transmit </td></tr>
 291 <tr><td class="fieldtype">
 292 <a id="a8f7a154565e652d976b9e65bf3516504" name="a8f7a154565e652d976b9e65bf3516504"></a>uint32_t</td>
 293 <td class="fieldname">
 294 checksum_offload_tx_ip6: 1</td>
 295 <td class="fielddoc">
 296 1 = IPv6 checksum generation supported on transmit </td></tr>
 297 <tr><td class="fieldtype">
 298 <a id="ab3f9560668a087606c40cd81b935396b" name="ab3f9560668a087606c40cd81b935396b"></a>uint32_t</td>
 299 <td class="fieldname">
 300 checksum_offload_tx_udp: 1</td>
 301 <td class="fielddoc">
 302 1 = UDP payload checksum generated on transmit </td></tr>
 303 <tr><td class="fieldtype">
 304 <a id="a6c2b80bbfe520f3e7808cf3d4aaedb45" name="a6c2b80bbfe520f3e7808cf3d4aaedb45"></a>uint32_t</td>
 305 <td class="fieldname">
 306 checksum_offload_tx_tcp: 1</td>
 307 <td class="fielddoc">
 308 1 = TCP payload checksum generated on transmit </td></tr>
 309 <tr><td class="fieldtype">
 310 <a id="a7b701bac9d66886b5c6964b20c6ca55a" name="a7b701bac9d66886b5c6964b20c6ca55a"></a>uint32_t</td>
 311 <td class="fieldname">
 312 checksum_offload_tx_icmp: 1</td>
 313 <td class="fielddoc">
 314 1 = ICMP payload checksum generated on transmit </td></tr>
 315 <tr><td class="fieldtype">
 316 <a id="a3c5cb74e086417a01d0079f847a3fc8d" name="a3c5cb74e086417a01d0079f847a3fc8d"></a>uint32_t</td>
 317 <td class="fieldname">
 318 media_interface: 2</td>
 319 <td class="fielddoc">
 320 Ethernet Media Interface type. </td></tr>
 321 <tr><td class="fieldtype">
 322 <a id="a7fdea04bacd9c0e12792751055ef6238" name="a7fdea04bacd9c0e12792751055ef6238"></a>uint32_t</td>
 323 <td class="fieldname">
 324 mac_address: 1</td>
 325 <td class="fielddoc">
 326 1 = driver provides initial valid MAC address </td></tr>
 327 <tr><td class="fieldtype">
 328 <a id="a8c8f1ac2bf053a9bac98c476646a6018" name="a8c8f1ac2bf053a9bac98c476646a6018"></a>uint32_t</td>
 329 <td class="fieldname">
 330 event_rx_frame: 1</td>
 331 <td class="fielddoc">
 332 1 = callback event <a class="el" href="group__ETH__MAC__events.html#ga76943471a4a3e9e8c1ff9fe83e43bd47">ARM_ETH_MAC_EVENT_RX_FRAME</a> generated </td></tr>
 333 <tr><td class="fieldtype">
 334 <a id="a1b4af3590d59ea4f8e845b4239a4e445" name="a1b4af3590d59ea4f8e845b4239a4e445"></a>uint32_t</td>
 335 <td class="fieldname">
 336 event_tx_frame: 1</td>
 337 <td class="fielddoc">
 338 1 = callback event <a class="el" href="group__ETH__MAC__events.html#ga0c0328ff7cf886d5fdb53bb84ec03c1b">ARM_ETH_MAC_EVENT_TX_FRAME</a> generated </td></tr>
 339 <tr><td class="fieldtype">
 340 <a id="a7536d9b9818b20b6974a712e0449439b" name="a7536d9b9818b20b6974a712e0449439b"></a>uint32_t</td>
 341 <td class="fieldname">
 342 event_wakeup: 1</td>
 343 <td class="fielddoc">
 344 1 = wakeup event <a class="el" href="group__ETH__MAC__events.html#ga1f3bdb219afa8f2a121b58cc84f5761c">ARM_ETH_MAC_EVENT_WAKEUP</a> generated </td></tr>
 345 <tr><td class="fieldtype">
 346 <a id="a881a863974d32f95d7829f768ac47aa2" name="a881a863974d32f95d7829f768ac47aa2"></a>uint32_t</td>
 347 <td class="fieldname">
 348 precision_timer: 1</td>
 349 <td class="fielddoc">
 350 1 = Precision Timer supported </td></tr>
 351 <tr><td class="fieldtype">
 352 <a id="aa43c4c21b173ada1b6b7568956f0d650" name="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
 353 <td class="fieldname">
 354 reserved: 15</td>
 355 <td class="fielddoc">
 356 Reserved (must be zero) </td></tr>
 357 </table>
 358
 359 </div>
 360 </div>
 361 <a name="structARM__DRIVER__ETH__MAC" id="structARM__DRIVER__ETH__MAC"></a>
 362 <h2 class="memtitle"><span class="permalink"><a href="#structARM__DRIVER__ETH__MAC">&#9670;&#160;</a></span>ARM_DRIVER_ETH_MAC</h2>
 363
 364 <div class="memitem">
 365 <div class="memproto">
 366       <table class="memname">
 367         <tr>
 368           <td class="memname">struct ARM_DRIVER_ETH_MAC</td>
 369         </tr>
 370       </table>
 371 </div><div class="memdoc">
 372 <div class="textblock"><p>Access structure of the Ethernet MAC Driver. </p>
 373 <p>The functions of the Ethernet MAC are accessed by function pointers. Refer to <a class="el" href="theoryOperation.html#DriverFunctions">Common Driver Functions</a> for overview information.</p>
 374 <p>Each instance of an Ethernet MAC provides such an access struct. The instance is indicated by a postfix in the symbol name of the access struct, for example:</p><ul>
 375 <li><b>Driver_ETH_MAC0</b> is the name of the access struct of the first instance (no. 0).</li>
 376 <li><b>Driver_ETH_MAC1</b> is the name of the access struct of the second instance (no. 1).</li>
 377 </ul>
 378 <p>A configuration setting in the middleware allows connecting the middleware to a specific driver instance <b>Driver_ETH_MAC<em>n</em></b>. The default is <span class="XML-Token">0</span>, which connects a middleware to the first instance of a driver. </p>
 379 </div><table class="memberdecls">
 380 <tr><td colspan="2"><h3>Data Fields</h3></td></tr>
 381 <tr class="memitem:a30afd9cb3113c037b5f1926f5ef93b59"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#a30afd9cb3113c037b5f1926f5ef93b59">GetVersion</a> )(void)</td></tr>
 382 <tr class="memdesc:a30afd9cb3113c037b5f1926f5ef93b59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga86b15062c297384ad5842dd57b9d6b1d">ARM_ETH_MAC_GetVersion</a> : Get driver version.  <br /></td></tr>
 383 <tr class="separator:a30afd9cb3113c037b5f1926f5ef93b59"><td class="memSeparator" colspan="2">&#160;</td></tr>
 384 <tr class="memitem:a738cc36f2a26e9737578feed6a2b6371"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES">ARM_ETH_MAC_CAPABILITIES</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#a738cc36f2a26e9737578feed6a2b6371">GetCapabilities</a> )(void)</td></tr>
 385 <tr class="memdesc:a738cc36f2a26e9737578feed6a2b6371"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga2b13b230502736d8c7679b359dff20d0">ARM_ETH_MAC_GetCapabilities</a> : Get driver capabilities.  <br /></td></tr>
 386 <tr class="separator:a738cc36f2a26e9737578feed6a2b6371"><td class="memSeparator" colspan="2">&#160;</td></tr>
 387 <tr class="memitem:ac9d6637a5cf6af0428dbf9a0bd70c26c"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ac9d6637a5cf6af0428dbf9a0bd70c26c">Initialize</a> )(<a class="el" href="group__eth__mac__interface__gr.html#gadfc95cb09c541a29a72da86963668726">ARM_ETH_MAC_SignalEvent_t</a> cb_event)</td></tr>
 388 <tr class="memdesc:ac9d6637a5cf6af0428dbf9a0bd70c26c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gacf42d11b171cd032f0ec1de6db2b6832">ARM_ETH_MAC_Initialize</a> : Initialize Ethernet MAC Device.  <br /></td></tr>
 389 <tr class="separator:ac9d6637a5cf6af0428dbf9a0bd70c26c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 390 <tr class="memitem:a5ce2b3d7a3a07099bf07d1eb253e92e3"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#a5ce2b3d7a3a07099bf07d1eb253e92e3">Uninitialize</a> )(void)</td></tr>
 391 <tr class="memdesc:a5ce2b3d7a3a07099bf07d1eb253e92e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gacb2c2ae06f32328775bffbdeaaabfb5d">ARM_ETH_MAC_Uninitialize</a> : De-initialize Ethernet MAC Device.  <br /></td></tr>
 392 <tr class="separator:a5ce2b3d7a3a07099bf07d1eb253e92e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 393 <tr class="memitem:a24ebae5c6011631f76027f9a16eaf5ce"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#a24ebae5c6011631f76027f9a16eaf5ce">PowerControl</a> )(<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
 394 <tr class="memdesc:a24ebae5c6011631f76027f9a16eaf5ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga346fef040a0e9bac5762a04a306b1be7">ARM_ETH_MAC_PowerControl</a> : Control Ethernet MAC Device Power.  <br /></td></tr>
 395 <tr class="separator:a24ebae5c6011631f76027f9a16eaf5ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
 396 <tr class="memitem:a3b9d1aa56399eb826f04b9afe37a9052"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#a3b9d1aa56399eb826f04b9afe37a9052">GetMacAddress</a> )(<a class="el" href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">ARM_ETH_MAC_ADDR</a> *ptr_addr)</td></tr>
 397 <tr class="memdesc:a3b9d1aa56399eb826f04b9afe37a9052"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga66308c1e791952047e974bd653037fae">ARM_ETH_MAC_GetMacAddress</a> : Get Ethernet MAC Address.  <br /></td></tr>
 398 <tr class="separator:a3b9d1aa56399eb826f04b9afe37a9052"><td class="memSeparator" colspan="2">&#160;</td></tr>
 399 <tr class="memitem:abcdd3fdadfe2677b657e0a09f779788a"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#abcdd3fdadfe2677b657e0a09f779788a">SetMacAddress</a> )(const <a class="el" href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">ARM_ETH_MAC_ADDR</a> *ptr_addr)</td></tr>
 400 <tr class="memdesc:abcdd3fdadfe2677b657e0a09f779788a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga7cc3d17c7312c5032202dfd9a915f24a">ARM_ETH_MAC_SetMacAddress</a> : Set Ethernet MAC Address.  <br /></td></tr>
 401 <tr class="separator:abcdd3fdadfe2677b657e0a09f779788a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 402 <tr class="memitem:ad945467372442b772bfb17b1d206afc3"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ad945467372442b772bfb17b1d206afc3">SetAddressFilter</a> )(const <a class="el" href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">ARM_ETH_MAC_ADDR</a> *ptr_addr, uint32_t num_addr)</td></tr>
 403 <tr class="memdesc:ad945467372442b772bfb17b1d206afc3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga150fe30290275a4b32756f94208124e8">ARM_ETH_MAC_SetAddressFilter</a> : Configure Address Filter.  <br /></td></tr>
 404 <tr class="separator:ad945467372442b772bfb17b1d206afc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 405 <tr class="memitem:a9e32983e5fd08def8550604ec66a2f23"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#a9e32983e5fd08def8550604ec66a2f23">SendFrame</a> )(const uint8_t *frame, uint32_t len, uint32_t flags)</td></tr>
 406 <tr class="memdesc:a9e32983e5fd08def8550604ec66a2f23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga5bf58defdb239ed7dc948f1da147a1c3">ARM_ETH_MAC_SendFrame</a> : Send Ethernet frame.  <br /></td></tr>
 407 <tr class="separator:a9e32983e5fd08def8550604ec66a2f23"><td class="memSeparator" colspan="2">&#160;</td></tr>
 408 <tr class="memitem:ad41179807445481e8844e80063e6f300"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ad41179807445481e8844e80063e6f300">ReadFrame</a> )(uint8_t *frame, uint32_t len)</td></tr>
 409 <tr class="memdesc:ad41179807445481e8844e80063e6f300"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga4b79f57d8624bb4410ee12c73a483993">ARM_ETH_MAC_ReadFrame</a> : Read data of received Ethernet frame.  <br /></td></tr>
 410 <tr class="separator:ad41179807445481e8844e80063e6f300"><td class="memSeparator" colspan="2">&#160;</td></tr>
 411 <tr class="memitem:ac2729a971dc00ba71201b7642fe95f9b"><td class="memItemLeft" align="right" valign="top">uint32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ac2729a971dc00ba71201b7642fe95f9b">GetRxFrameSize</a> )(void)</td></tr>
 412 <tr class="memdesc:ac2729a971dc00ba71201b7642fe95f9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga5ee86d6b0efab5329b9bc191c23a466d">ARM_ETH_MAC_GetRxFrameSize</a> : Get size of received Ethernet frame.  <br /></td></tr>
 413 <tr class="separator:ac2729a971dc00ba71201b7642fe95f9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 414 <tr class="memitem:a9de7a51bd800bc5c1479159d92bf21ed"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#a9de7a51bd800bc5c1479159d92bf21ed">GetRxFrameTime</a> )(<a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *time)</td></tr>
 415 <tr class="memdesc:a9de7a51bd800bc5c1479159d92bf21ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gaa7c6865fb09754be869778142466c5e4">ARM_ETH_MAC_GetRxFrameTime</a> : Get time of received Ethernet frame.  <br /></td></tr>
 416 <tr class="separator:a9de7a51bd800bc5c1479159d92bf21ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
 417 <tr class="memitem:a701e258968c0fb9d62ca40c390ebb74d"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#a701e258968c0fb9d62ca40c390ebb74d">GetTxFrameTime</a> )(<a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *time)</td></tr>
 418 <tr class="memdesc:a701e258968c0fb9d62ca40c390ebb74d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga115b5c7e149aec2b181de760f5d83f60">ARM_ETH_MAC_GetTxFrameTime</a> : Get time of transmitted Ethernet frame.  <br /></td></tr>
 419 <tr class="separator:a701e258968c0fb9d62ca40c390ebb74d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 420 <tr class="memitem:a1a56d0408cfc42cd4188df4f10c7d97f"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#a1a56d0408cfc42cd4188df4f10c7d97f">ControlTimer</a> )(uint32_t control, <a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *time)</td></tr>
 421 <tr class="memdesc:a1a56d0408cfc42cd4188df4f10c7d97f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga85d9dc865af3702b71a514b18a588643">ARM_ETH_MAC_ControlTimer</a> : Control Precision Timer.  <br /></td></tr>
 422 <tr class="separator:a1a56d0408cfc42cd4188df4f10c7d97f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 423 <tr class="memitem:a5e96d73d3a3c366aba50bf5304edb029"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#a5e96d73d3a3c366aba50bf5304edb029">Control</a> )(uint32_t control, uint32_t arg)</td></tr>
 424 <tr class="memdesc:a5e96d73d3a3c366aba50bf5304edb029"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536">ARM_ETH_MAC_Control</a> : Control Ethernet Interface.  <br /></td></tr>
 425 <tr class="separator:a5e96d73d3a3c366aba50bf5304edb029"><td class="memSeparator" colspan="2">&#160;</td></tr>
 426 <tr class="memitem:ac3b9790428e186ea7809c7bdf32d2c66"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ac3b9790428e186ea7809c7bdf32d2c66">PHY_Read</a> )(uint8_t phy_addr, uint8_t reg_addr, uint16_t *data)</td></tr>
 427 <tr class="memdesc:ac3b9790428e186ea7809c7bdf32d2c66"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gaded29ad58366e9222487db9944373c29">ARM_ETH_MAC_PHY_Read</a> : Read Ethernet PHY Register through Management Interface.  <br /></td></tr>
 428 <tr class="separator:ac3b9790428e186ea7809c7bdf32d2c66"><td class="memSeparator" colspan="2">&#160;</td></tr>
 429 <tr class="memitem:a5e5913d9ea17b5c3baea8580ec5fa3d9"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#a5e5913d9ea17b5c3baea8580ec5fa3d9">PHY_Write</a> )(uint8_t phy_addr, uint8_t reg_addr, uint16_t data)</td></tr>
 430 <tr class="memdesc:a5e5913d9ea17b5c3baea8580ec5fa3d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga79dd38672749aeebd28f39d9b4f813ce">ARM_ETH_MAC_PHY_Write</a> : Write Ethernet PHY Register through Management Interface.  <br /></td></tr>
 431 <tr class="separator:a5e5913d9ea17b5c3baea8580ec5fa3d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 432 </table>
 433 <h4 class="groupheader">Field Documentation</h4>
 434 <a id="a30afd9cb3113c037b5f1926f5ef93b59" name="a30afd9cb3113c037b5f1926f5ef93b59"></a>
 435 <h2 class="memtitle"><span class="permalink"><a href="#a30afd9cb3113c037b5f1926f5ef93b59">&#9670;&#160;</a></span>GetVersion</h2>
 436
 437 <div class="memitem">
 438 <div class="memproto">
 439       <table class="memname">
 440         <tr>
 441           <td class="memname"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>(* GetVersion) (void)</td>
 442         </tr>
 443       </table>
 444 </div><div class="memdoc">
 445
 446 <p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga86b15062c297384ad5842dd57b9d6b1d">ARM_ETH_MAC_GetVersion</a> : Get driver version. </p>
 447
 448 </div>
 449 </div>
 450 <a id="a738cc36f2a26e9737578feed6a2b6371" name="a738cc36f2a26e9737578feed6a2b6371"></a>
 451 <h2 class="memtitle"><span class="permalink"><a href="#a738cc36f2a26e9737578feed6a2b6371">&#9670;&#160;</a></span>GetCapabilities</h2>
 452
 453 <div class="memitem">
 454 <div class="memproto">
 455       <table class="memname">
 456         <tr>
 457           <td class="memname"><a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES">ARM_ETH_MAC_CAPABILITIES</a>(* GetCapabilities) (void)</td>
 458         </tr>
 459       </table>
 460 </div><div class="memdoc">
 461
 462 <p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga2b13b230502736d8c7679b359dff20d0">ARM_ETH_MAC_GetCapabilities</a> : Get driver capabilities. </p>
 463
 464 </div>
 465 </div>
 466 <a id="ac9d6637a5cf6af0428dbf9a0bd70c26c" name="ac9d6637a5cf6af0428dbf9a0bd70c26c"></a>
 467 <h2 class="memtitle"><span class="permalink"><a href="#ac9d6637a5cf6af0428dbf9a0bd70c26c">&#9670;&#160;</a></span>Initialize</h2>
 468
 469 <div class="memitem">
 470 <div class="memproto">
 471       <table class="memname">
 472         <tr>
 473           <td class="memname">int32_t(* Initialize) (<a class="el" href="group__eth__mac__interface__gr.html#gadfc95cb09c541a29a72da86963668726">ARM_ETH_MAC_SignalEvent_t</a> cb_event)</td>
 474         </tr>
 475       </table>
 476 </div><div class="memdoc">
 477
 478 <p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gacf42d11b171cd032f0ec1de6db2b6832">ARM_ETH_MAC_Initialize</a> : Initialize Ethernet MAC Device. </p>
 479
 480 </div>
 481 </div>
 482 <a id="a5ce2b3d7a3a07099bf07d1eb253e92e3" name="a5ce2b3d7a3a07099bf07d1eb253e92e3"></a>
 483 <h2 class="memtitle"><span class="permalink"><a href="#a5ce2b3d7a3a07099bf07d1eb253e92e3">&#9670;&#160;</a></span>Uninitialize</h2>
 484
 485 <div class="memitem">
 486 <div class="memproto">
 487       <table class="memname">
 488         <tr>
 489           <td class="memname">int32_t(* Uninitialize) (void)</td>
 490         </tr>
 491       </table>
 492 </div><div class="memdoc">
 493
 494 <p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gacb2c2ae06f32328775bffbdeaaabfb5d">ARM_ETH_MAC_Uninitialize</a> : De-initialize Ethernet MAC Device. </p>
 495
 496 </div>
 497 </div>
 498 <a id="a24ebae5c6011631f76027f9a16eaf5ce" name="a24ebae5c6011631f76027f9a16eaf5ce"></a>
 499 <h2 class="memtitle"><span class="permalink"><a href="#a24ebae5c6011631f76027f9a16eaf5ce">&#9670;&#160;</a></span>PowerControl</h2>
 500
 501 <div class="memitem">
 502 <div class="memproto">
 503       <table class="memname">
 504         <tr>
 505           <td class="memname">int32_t(* PowerControl) (<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td>
 506         </tr>
 507       </table>
 508 </div><div class="memdoc">
 509
 510 <p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga346fef040a0e9bac5762a04a306b1be7">ARM_ETH_MAC_PowerControl</a> : Control Ethernet MAC Device Power. </p>
 511
 512 </div>
 513 </div>
 514 <a id="a3b9d1aa56399eb826f04b9afe37a9052" name="a3b9d1aa56399eb826f04b9afe37a9052"></a>
 515 <h2 class="memtitle"><span class="permalink"><a href="#a3b9d1aa56399eb826f04b9afe37a9052">&#9670;&#160;</a></span>GetMacAddress</h2>
 516
 517 <div class="memitem">
 518 <div class="memproto">
 519       <table class="memname">
 520         <tr>
 521           <td class="memname">int32_t(* GetMacAddress) (<a class="el" href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">ARM_ETH_MAC_ADDR</a> *ptr_addr)</td>
 522         </tr>
 523       </table>
 524 </div><div class="memdoc">
 525
 526 <p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga66308c1e791952047e974bd653037fae">ARM_ETH_MAC_GetMacAddress</a> : Get Ethernet MAC Address. </p>
 527
 528 </div>
 529 </div>
 530 <a id="abcdd3fdadfe2677b657e0a09f779788a" name="abcdd3fdadfe2677b657e0a09f779788a"></a>
 531 <h2 class="memtitle"><span class="permalink"><a href="#abcdd3fdadfe2677b657e0a09f779788a">&#9670;&#160;</a></span>SetMacAddress</h2>
 532
 533 <div class="memitem">
 534 <div class="memproto">
 535       <table class="memname">
 536         <tr>
 537           <td class="memname">int32_t(* SetMacAddress) (const <a class="el" href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">ARM_ETH_MAC_ADDR</a> *ptr_addr)</td>
 538         </tr>
 539       </table>
 540 </div><div class="memdoc">
 541
 542 <p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga7cc3d17c7312c5032202dfd9a915f24a">ARM_ETH_MAC_SetMacAddress</a> : Set Ethernet MAC Address. </p>
 543
 544 </div>
 545 </div>
 546 <a id="ad945467372442b772bfb17b1d206afc3" name="ad945467372442b772bfb17b1d206afc3"></a>
 547 <h2 class="memtitle"><span class="permalink"><a href="#ad945467372442b772bfb17b1d206afc3">&#9670;&#160;</a></span>SetAddressFilter</h2>
 548
 549 <div class="memitem">
 550 <div class="memproto">
 551       <table class="memname">
 552         <tr>
 553           <td class="memname">int32_t(* SetAddressFilter) (const <a class="el" href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">ARM_ETH_MAC_ADDR</a> *ptr_addr, uint32_t num_addr)</td>
 554         </tr>
 555       </table>
 556 </div><div class="memdoc">
 557
 558 <p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga150fe30290275a4b32756f94208124e8">ARM_ETH_MAC_SetAddressFilter</a> : Configure Address Filter. </p>
 559
 560 </div>
 561 </div>
 562 <a id="a9e32983e5fd08def8550604ec66a2f23" name="a9e32983e5fd08def8550604ec66a2f23"></a>
 563 <h2 class="memtitle"><span class="permalink"><a href="#a9e32983e5fd08def8550604ec66a2f23">&#9670;&#160;</a></span>SendFrame</h2>
 564
 565 <div class="memitem">
 566 <div class="memproto">
 567       <table class="memname">
 568         <tr>
 569           <td class="memname">int32_t(* SendFrame) (const uint8_t *frame, uint32_t len, uint32_t flags)</td>
 570         </tr>
 571       </table>
 572 </div><div class="memdoc">
 573
 574 <p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga5bf58defdb239ed7dc948f1da147a1c3">ARM_ETH_MAC_SendFrame</a> : Send Ethernet frame. </p>
 575
 576 </div>
 577 </div>
 578 <a id="ad41179807445481e8844e80063e6f300" name="ad41179807445481e8844e80063e6f300"></a>
 579 <h2 class="memtitle"><span class="permalink"><a href="#ad41179807445481e8844e80063e6f300">&#9670;&#160;</a></span>ReadFrame</h2>
 580
 581 <div class="memitem">
 582 <div class="memproto">
 583       <table class="memname">
 584         <tr>
 585           <td class="memname">int32_t(* ReadFrame) (uint8_t *frame, uint32_t len)</td>
 586         </tr>
 587       </table>
 588 </div><div class="memdoc">
 589
 590 <p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga4b79f57d8624bb4410ee12c73a483993">ARM_ETH_MAC_ReadFrame</a> : Read data of received Ethernet frame. </p>
 591
 592 </div>
 593 </div>
 594 <a id="ac2729a971dc00ba71201b7642fe95f9b" name="ac2729a971dc00ba71201b7642fe95f9b"></a>
 595 <h2 class="memtitle"><span class="permalink"><a href="#ac2729a971dc00ba71201b7642fe95f9b">&#9670;&#160;</a></span>GetRxFrameSize</h2>
 596
 597 <div class="memitem">
 598 <div class="memproto">
 599       <table class="memname">
 600         <tr>
 601           <td class="memname">uint32_t(* GetRxFrameSize) (void)</td>
 602         </tr>
 603       </table>
 604 </div><div class="memdoc">
 605
 606 <p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga5ee86d6b0efab5329b9bc191c23a466d">ARM_ETH_MAC_GetRxFrameSize</a> : Get size of received Ethernet frame. </p>
 607
 608 </div>
 609 </div>
 610 <a id="a9de7a51bd800bc5c1479159d92bf21ed" name="a9de7a51bd800bc5c1479159d92bf21ed"></a>
 611 <h2 class="memtitle"><span class="permalink"><a href="#a9de7a51bd800bc5c1479159d92bf21ed">&#9670;&#160;</a></span>GetRxFrameTime</h2>
 612
 613 <div class="memitem">
 614 <div class="memproto">
 615       <table class="memname">
 616         <tr>
 617           <td class="memname">int32_t(* GetRxFrameTime) (<a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *time)</td>
 618         </tr>
 619       </table>
 620 </div><div class="memdoc">
 621
 622 <p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gaa7c6865fb09754be869778142466c5e4">ARM_ETH_MAC_GetRxFrameTime</a> : Get time of received Ethernet frame. </p>
 623
 624 </div>
 625 </div>
 626 <a id="a701e258968c0fb9d62ca40c390ebb74d" name="a701e258968c0fb9d62ca40c390ebb74d"></a>
 627 <h2 class="memtitle"><span class="permalink"><a href="#a701e258968c0fb9d62ca40c390ebb74d">&#9670;&#160;</a></span>GetTxFrameTime</h2>
 628
 629 <div class="memitem">
 630 <div class="memproto">
 631       <table class="memname">
 632         <tr>
 633           <td class="memname">int32_t(* GetTxFrameTime) (<a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *time)</td>
 634         </tr>
 635       </table>
 636 </div><div class="memdoc">
 637
 638 <p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga115b5c7e149aec2b181de760f5d83f60">ARM_ETH_MAC_GetTxFrameTime</a> : Get time of transmitted Ethernet frame. </p>
 639
 640 </div>
 641 </div>
 642 <a id="a1a56d0408cfc42cd4188df4f10c7d97f" name="a1a56d0408cfc42cd4188df4f10c7d97f"></a>
 643 <h2 class="memtitle"><span class="permalink"><a href="#a1a56d0408cfc42cd4188df4f10c7d97f">&#9670;&#160;</a></span>ControlTimer</h2>
 644
 645 <div class="memitem">
 646 <div class="memproto">
 647       <table class="memname">
 648         <tr>
 649           <td class="memname">int32_t(* ControlTimer) (uint32_t control, <a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *time)</td>
 650         </tr>
 651       </table>
 652 </div><div class="memdoc">
 653
 654 <p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga85d9dc865af3702b71a514b18a588643">ARM_ETH_MAC_ControlTimer</a> : Control Precision Timer. </p>
 655
 656 </div>
 657 </div>
 658 <a id="a5e96d73d3a3c366aba50bf5304edb029" name="a5e96d73d3a3c366aba50bf5304edb029"></a>
 659 <h2 class="memtitle"><span class="permalink"><a href="#a5e96d73d3a3c366aba50bf5304edb029">&#9670;&#160;</a></span>Control</h2>
 660
 661 <div class="memitem">
 662 <div class="memproto">
 663       <table class="memname">
 664         <tr>
 665           <td class="memname">int32_t(* Control) (uint32_t control, uint32_t arg)</td>
 666         </tr>
 667       </table>
 668 </div><div class="memdoc">
 669
 670 <p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536">ARM_ETH_MAC_Control</a> : Control Ethernet Interface. </p>
 671
 672 </div>
 673 </div>
 674 <a id="ac3b9790428e186ea7809c7bdf32d2c66" name="ac3b9790428e186ea7809c7bdf32d2c66"></a>
 675 <h2 class="memtitle"><span class="permalink"><a href="#ac3b9790428e186ea7809c7bdf32d2c66">&#9670;&#160;</a></span>PHY_Read</h2>
 676
 677 <div class="memitem">
 678 <div class="memproto">
 679       <table class="memname">
 680         <tr>
 681           <td class="memname">int32_t(* PHY_Read) (uint8_t phy_addr, uint8_t reg_addr, uint16_t *data)</td>
 682         </tr>
 683       </table>
 684 </div><div class="memdoc">
 685
 686 <p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gaded29ad58366e9222487db9944373c29">ARM_ETH_MAC_PHY_Read</a> : Read Ethernet PHY Register through Management Interface. </p>
 687
 688 </div>
 689 </div>
 690 <a id="a5e5913d9ea17b5c3baea8580ec5fa3d9" name="a5e5913d9ea17b5c3baea8580ec5fa3d9"></a>
 691 <h2 class="memtitle"><span class="permalink"><a href="#a5e5913d9ea17b5c3baea8580ec5fa3d9">&#9670;&#160;</a></span>PHY_Write</h2>
 692
 693 <div class="memitem">
 694 <div class="memproto">
 695       <table class="memname">
 696         <tr>
 697           <td class="memname">int32_t(* PHY_Write) (uint8_t phy_addr, uint8_t reg_addr, uint16_t data)</td>
 698         </tr>
 699       </table>
 700 </div><div class="memdoc">
 701
 702 <p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga79dd38672749aeebd28f39d9b4f813ce">ARM_ETH_MAC_PHY_Write</a> : Write Ethernet PHY Register through Management Interface. </p>
 703
 704 </div>
 705 </div>
 706
 707 </div>
 708 </div>
 709 <a name="structARM__ETH__MAC__TIME" id="structARM__ETH__MAC__TIME"></a>
 710 <h2 class="memtitle"><span class="permalink"><a href="#structARM__ETH__MAC__TIME">&#9670;&#160;</a></span>ARM_ETH_MAC_TIME</h2>
 711
 712 <div class="memitem">
 713 <div class="memproto">
 714       <table class="memname">
 715         <tr>
 716           <td class="memname">struct ARM_ETH_MAC_TIME</td>
 717         </tr>
 718       </table>
 719 </div><div class="memdoc">
 720 <div class="textblock"><p>Ethernet MAC Time. </p>
 721 <p>The two members of this struct provide fields to encode time values in the order <span class="XML-Token">Nano seconds</span> and <span class="XML-Token">seconds</span>.</p>
 722 <p>The member <em>ns</em> is also used as a correction factor for <a class="el" href="group__eth__mac__time__control.html#ga85cb862eba0934e958a8552022588db7">ARM_ETH_MAC_TIMER_ADJUST_CLOCK</a>.</p>
 723 <p><b>Used in:</b></p><ul>
 724 <li><a class="el" href="group__eth__mac__interface__gr.html#gaa7c6865fb09754be869778142466c5e4">ARM_ETH_MAC_GetRxFrameTime</a></li>
 725 <li><a class="el" href="group__eth__mac__interface__gr.html#ga115b5c7e149aec2b181de760f5d83f60">ARM_ETH_MAC_GetTxFrameTime</a></li>
 726 <li><a class="el" href="group__eth__mac__interface__gr.html#ga85d9dc865af3702b71a514b18a588643">ARM_ETH_MAC_ControlTimer</a> </li>
 727 </ul>
 728 </div><table class="fieldtable">
 729 <tr><th colspan="3">Data Fields</th></tr>
 730 <tr><td class="fieldtype">
 731 <a id="a048317f84621fb38ed0bf8c8255e26f0" name="a048317f84621fb38ed0bf8c8255e26f0"></a>uint32_t</td>
 732 <td class="fieldname">
 733 ns</td>
 734 <td class="fielddoc">
 735 Nano seconds. </td></tr>
 736 <tr><td class="fieldtype">
 737 <a id="aaf5f5a3fa5d596a9136b4331f2b54bfc" name="aaf5f5a3fa5d596a9136b4331f2b54bfc"></a>uint32_t</td>
 738 <td class="fieldname">
 739 sec</td>
 740 <td class="fielddoc">
 741 Seconds. </td></tr>
 742 </table>
 743
 744 </div>
 745 </div>
 746 <h2 class="groupheader">Typedef Documentation</h2>
 747 <a id="gadfc95cb09c541a29a72da86963668726" name="gadfc95cb09c541a29a72da86963668726"></a>
 748 <h2 class="memtitle"><span class="permalink"><a href="#gadfc95cb09c541a29a72da86963668726">&#9670;&#160;</a></span>ARM_ETH_MAC_SignalEvent_t</h2>
 749
 750 <div class="memitem">
 751 <div class="memproto">
 752       <table class="memname">
 753         <tr>
 754           <td class="memname">ARM_ETH_MAC_SignalEvent_t</td>
 755         </tr>
 756       </table>
 757 </div><div class="memdoc">
 758
 759 <p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gae0697be4c4229601f3bfc17e2978ada6">ARM_ETH_MAC_SignalEvent</a> : Signal Ethernet Event. </p>
 760 <p>Provides the typedef for the callback function <a class="el" href="group__eth__mac__interface__gr.html#gae0697be4c4229601f3bfc17e2978ada6">ARM_ETH_MAC_SignalEvent</a>.</p>
 761 <p><b>Parameter for:</b></p><ul>
 762 <li><a class="el" href="group__eth__mac__interface__gr.html#gacf42d11b171cd032f0ec1de6db2b6832">ARM_ETH_MAC_Initialize</a> </li>
 763 </ul>
 764
 765 </div>
 766 </div>
 767 <h2 class="groupheader">Function Documentation</h2>
 768 <a id="ga86b15062c297384ad5842dd57b9d6b1d" name="ga86b15062c297384ad5842dd57b9d6b1d"></a>
 769 <h2 class="memtitle"><span class="permalink"><a href="#ga86b15062c297384ad5842dd57b9d6b1d">&#9670;&#160;</a></span>ARM_ETH_MAC_GetVersion()</h2>
 770
 771 <div class="memitem">
 772 <div class="memproto">
 773       <table class="memname">
 774         <tr>
 775           <td class="memname"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> ARM_ETH_MAC_GetVersion </td>
 776           <td>(</td>
 777           <td class="paramtype">void&#160;</td>
 778           <td class="paramname"></td><td>)</td>
 779           <td></td>
 780         </tr>
 781       </table>
 782 </div><div class="memdoc">
 783
 784 <p>Get driver version. </p>
 785 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a></dd></dl>
 786 <p>The function <b>ARM_ETH_MAC_GetVersion</b> returns version information of the driver implementation in <a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a></p><ul>
 787 <li>API version is the version of the CMSIS-Driver specification used to implement this driver.</li>
 788 <li>Driver version is source code version of the actual driver implementation.</li>
 789 </ul>
 790 <p>Example: </p><div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code hl_struct" href="group__eth__mac__interface__gr.html#structARM__DRIVER__ETH__MAC">ARM_DRIVER_ETH_MAC</a> Driver_ETH_MAC0;</div>
 791 <div class="line"><a class="code hl_struct" href="group__eth__mac__interface__gr.html#structARM__DRIVER__ETH__MAC">ARM_DRIVER_ETH_MAC</a> *mac;</div>
 792 <div class="line"> </div>
 793 <div class="line"><span class="keywordtype">void</span> setup_ethernet (<span class="keywordtype">void</span>)  {</div>
 794 <div class="line">  <a class="code hl_struct" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>  version;</div>
 795 <div class="line"> </div>
 796 <div class="line">  mac = &amp;Driver_ETH_MAC0;  </div>
 797 <div class="line">  version = mac-&gt;<a class="code hl_variable" href="group__eth__mac__interface__gr.html#a30afd9cb3113c037b5f1926f5ef93b59">GetVersion</a> ();</div>
 798 <div class="line">  <span class="keywordflow">if</span> (version.<a class="code hl_variable" href="group__common__drv__gr.html#ad180da20fbde1d3dafc074af87c19540">api</a> &lt; 0x10A)   {      <span class="comment">// requires at minimum API version 1.10 or higher</span></div>
 799 <div class="line">    <span class="comment">// error handling</span></div>
 800 <div class="line">    <span class="keywordflow">return</span>;</div>
 801 <div class="line">  }</div>
 802 <div class="line">}</div>
 803 <div class="ttc" id="agroup__common__drv__gr_html_ad180da20fbde1d3dafc074af87c19540"><div class="ttname"><a href="group__common__drv__gr.html#ad180da20fbde1d3dafc074af87c19540">ARM_DRIVER_VERSION::api</a></div><div class="ttdeci">uint16_t api</div><div class="ttdoc">API version.</div><div class="ttdef"><b>Definition:</b> Driver_Common.h:47</div></div>
 804 <div class="ttc" id="agroup__common__drv__gr_html_structARM__DRIVER__VERSION"><div class="ttname"><a href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a></div><div class="ttdoc">Driver Version.</div><div class="ttdef"><b>Definition:</b> Driver_Common.h:46</div></div>
 805 <div class="ttc" id="agroup__eth__mac__interface__gr_html_a30afd9cb3113c037b5f1926f5ef93b59"><div class="ttname"><a href="group__eth__mac__interface__gr.html#a30afd9cb3113c037b5f1926f5ef93b59">ARM_DRIVER_ETH_MAC::GetVersion</a></div><div class="ttdeci">ARM_DRIVER_VERSION(* GetVersion)(void)</div><div class="ttdoc">Pointer to ARM_ETH_MAC_GetVersion : Get driver version.</div><div class="ttdef"><b>Definition:</b> Driver_ETH_MAC.h:287</div></div>
 806 <div class="ttc" id="agroup__eth__mac__interface__gr_html_structARM__DRIVER__ETH__MAC"><div class="ttname"><a href="group__eth__mac__interface__gr.html#structARM__DRIVER__ETH__MAC">ARM_DRIVER_ETH_MAC</a></div><div class="ttdoc">Access structure of the Ethernet MAC Driver.</div><div class="ttdef"><b>Definition:</b> Driver_ETH_MAC.h:286</div></div>
 807 </div><!-- fragment -->
 808 </div>
 809 </div>
 810 <a id="ga2b13b230502736d8c7679b359dff20d0" name="ga2b13b230502736d8c7679b359dff20d0"></a>
 811 <h2 class="memtitle"><span class="permalink"><a href="#ga2b13b230502736d8c7679b359dff20d0">&#9670;&#160;</a></span>ARM_ETH_MAC_GetCapabilities()</h2>
 812
 813 <div class="memitem">
 814 <div class="memproto">
 815       <table class="memname">
 816         <tr>
 817           <td class="memname"><a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES">ARM_ETH_MAC_CAPABILITIES</a> ARM_ETH_MAC_GetCapabilities </td>
 818           <td>(</td>
 819           <td class="paramtype">void&#160;</td>
 820           <td class="paramname"></td><td>)</td>
 821           <td></td>
 822         </tr>
 823       </table>
 824 </div><div class="memdoc">
 825
 826 <p>Get driver capabilities. </p>
 827 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES">ARM_ETH_MAC_CAPABILITIES</a></dd></dl>
 828 <p>The function <b>ARM_ETH_MAC_GetCapabilities</b> retrieves information about capabilities in this driver implementation. The data fields of the struct <a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES">ARM_ETH_MAC_CAPABILITIES</a> encode various capabilities, for example if a hardware is capable to create checksums in hardware or signal events using the <a class="el" href="group__eth__mac__interface__gr.html#gae0697be4c4229601f3bfc17e2978ada6">ARM_ETH_MAC_SignalEvent</a> callback function.</p>
 829 <p>Example: </p><div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code hl_struct" href="group__eth__mac__interface__gr.html#structARM__DRIVER__ETH__MAC">ARM_DRIVER_ETH_MAC</a> Driver_ETH_MAC0;</div>
 830 <div class="line"><a class="code hl_struct" href="group__eth__mac__interface__gr.html#structARM__DRIVER__ETH__MAC">ARM_DRIVER_ETH_MAC</a> *mac;</div>
 831 <div class="line">  </div>
 832 <div class="line"><span class="keywordtype">void</span> read_capabilities (<span class="keywordtype">void</span>)  {</div>
 833 <div class="line">  <a class="code hl_struct" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES">ARM_ETH_MAC_CAPABILITIES</a> mac_capabilities;</div>
 834 <div class="line"> </div>
 835 <div class="line">  mac = &amp;Driver_ETH_MAC0;  </div>
 836 <div class="line">  mac_capabilities = mac-&gt;<a class="code hl_variable" href="group__eth__mac__interface__gr.html#a738cc36f2a26e9737578feed6a2b6371">GetCapabilities</a> ();</div>
 837 <div class="line">  <span class="comment">// interrogate capabilities</span></div>
 838 <div class="line"> </div>
 839 <div class="line">}</div>
 840 <div class="ttc" id="agroup__eth__mac__interface__gr_html_a738cc36f2a26e9737578feed6a2b6371"><div class="ttname"><a href="group__eth__mac__interface__gr.html#a738cc36f2a26e9737578feed6a2b6371">ARM_DRIVER_ETH_MAC::GetCapabilities</a></div><div class="ttdeci">ARM_ETH_MAC_CAPABILITIES(* GetCapabilities)(void)</div><div class="ttdoc">Pointer to ARM_ETH_MAC_GetCapabilities : Get driver capabilities.</div><div class="ttdef"><b>Definition:</b> Driver_ETH_MAC.h:288</div></div>
 841 <div class="ttc" id="agroup__eth__mac__interface__gr_html_structARM__ETH__MAC__CAPABILITIES"><div class="ttname"><a href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES">ARM_ETH_MAC_CAPABILITIES</a></div><div class="ttdoc">Ethernet MAC Capabilities.</div><div class="ttdef"><b>Definition:</b> Driver_ETH_MAC.h:262</div></div>
 842 </div><!-- fragment -->
 843 </div>
 844 </div>
 845 <a id="gacf42d11b171cd032f0ec1de6db2b6832" name="gacf42d11b171cd032f0ec1de6db2b6832"></a>
 846 <h2 class="memtitle"><span class="permalink"><a href="#gacf42d11b171cd032f0ec1de6db2b6832">&#9670;&#160;</a></span>ARM_ETH_MAC_Initialize()</h2>
 847
 848 <div class="memitem">
 849 <div class="memproto">
 850       <table class="memname">
 851         <tr>
 852           <td class="memname">int32_t ARM_ETH_MAC_Initialize </td>
 853           <td>(</td>
 854           <td class="paramtype"><a class="el" href="group__eth__mac__interface__gr.html#gadfc95cb09c541a29a72da86963668726">ARM_ETH_MAC_SignalEvent_t</a>&#160;</td>
 855           <td class="paramname"><em>cb_event</em></td><td>)</td>
 856           <td></td>
 857         </tr>
 858       </table>
 859 </div><div class="memdoc">
 860
 861 <p>Initialize Ethernet MAC Device. </p>
 862 <dl class="params"><dt>Parameters</dt><dd>
 863   <table class="params">
 864     <tr><td class="paramdir">[in]</td><td class="paramname">cb_event</td><td>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gae0697be4c4229601f3bfc17e2978ada6">ARM_ETH_MAC_SignalEvent</a> </td></tr>
 865   </table>
 866   </dd>
 867 </dl>
 868 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
 869 <p>The function <b>ARM_ETH_MAC_Initialize</b> initializes the Ethernet MAC interface. It is called when the middleware component starts operation.</p>
 870 <p>The <a class="el" href="group__eth__mac__interface__gr.html#gacf42d11b171cd032f0ec1de6db2b6832">ARM_ETH_MAC_Initialize</a> function performs the following operations:</p><ul>
 871 <li>Initializes the resources needed for the Ethernet MAC peripheral.</li>
 872 <li>Registers the <a class="el" href="group__eth__mac__interface__gr.html#gae0697be4c4229601f3bfc17e2978ada6">ARM_ETH_MAC_SignalEvent</a> callback function.</li>
 873 </ul>
 874 <p>The parameter <em>cb_event</em> is a pointer to the <a class="el" href="group__eth__mac__interface__gr.html#gae0697be4c4229601f3bfc17e2978ada6">ARM_ETH_MAC_SignalEvent</a> callback function; use a NULL pointer when no callback signals are required.</p>
 875 <p><b>Example:</b> </p><ul>
 876 <li>see <a class="el" href="group__eth__interface__gr.html">Ethernet Interface</a> - Driver Functions </li>
 877 </ul>
 878
 879 </div>
 880 </div>
 881 <a id="gacb2c2ae06f32328775bffbdeaaabfb5d" name="gacb2c2ae06f32328775bffbdeaaabfb5d"></a>
 882 <h2 class="memtitle"><span class="permalink"><a href="#gacb2c2ae06f32328775bffbdeaaabfb5d">&#9670;&#160;</a></span>ARM_ETH_MAC_Uninitialize()</h2>
 883
 884 <div class="memitem">
 885 <div class="memproto">
 886       <table class="memname">
 887         <tr>
 888           <td class="memname">int32_t ARM_ETH_MAC_Uninitialize </td>
 889           <td>(</td>
 890           <td class="paramtype">void&#160;</td>
 891           <td class="paramname"></td><td>)</td>
 892           <td></td>
 893         </tr>
 894       </table>
 895 </div><div class="memdoc">
 896
 897 <p>De-initialize Ethernet MAC Device. </p>
 898 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
 899 <p>The function <b>ARM_ETH_MAC_Uninitialize</b> de-initializes the resources of Ethernet MAC interface.</p>
 900 <p>It is called when the middleware component stops operation and releases the software resources used by the interface. </p>
 901
 902 </div>
 903 </div>
 904 <a id="ga346fef040a0e9bac5762a04a306b1be7" name="ga346fef040a0e9bac5762a04a306b1be7"></a>
 905 <h2 class="memtitle"><span class="permalink"><a href="#ga346fef040a0e9bac5762a04a306b1be7">&#9670;&#160;</a></span>ARM_ETH_MAC_PowerControl()</h2>
 906
 907 <div class="memitem">
 908 <div class="memproto">
 909       <table class="memname">
 910         <tr>
 911           <td class="memname">int32_t ARM_ETH_MAC_PowerControl </td>
 912           <td>(</td>
 913           <td class="paramtype"><a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a>&#160;</td>
 914           <td class="paramname"><em>state</em></td><td>)</td>
 915           <td></td>
 916         </tr>
 917       </table>
 918 </div><div class="memdoc">
 919
 920 <p>Control Ethernet MAC Device Power. </p>
 921 <dl class="params"><dt>Parameters</dt><dd>
 922   <table class="params">
 923     <tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>Power state </td></tr>
 924   </table>
 925   </dd>
 926 </dl>
 927 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
 928 <p><br  />
 929  The function <b>ARM_ETH_MAC_PowerControl</b> allows you to configure the power modes of the Ethernet MAC interface. <br  />
 930 </p>
 931 <p>The parameter <em>state</em> can be:</p><ul>
 932 <li>ARM_POWER_OFF: Ethernet MAC peripheral is turned off.</li>
 933 <li>ARM_POWER_FULL: Ethernet MAC peripheral is turned on and fully operational.</li>
 934 </ul>
 935 <p>If power <em>state</em> specifies an unsupported mode, the function returns <a class="el" href="group__execution__status.html#ga2efa59e480d82697795439220e6884e4">ARM_DRIVER_ERROR_UNSUPPORTED</a> as status information and the previous power state of the peripheral is unchanged. Multiple calls with the same <em>state</em> generate no error.</p>
 936 <p><b>Example:</b> </p><ul>
 937 <li>see <a class="el" href="group__eth__interface__gr.html">Ethernet Interface</a> - Driver Functions </li>
 938 </ul>
 939
 940 </div>
 941 </div>
 942 <a id="ga66308c1e791952047e974bd653037fae" name="ga66308c1e791952047e974bd653037fae"></a>
 943 <h2 class="memtitle"><span class="permalink"><a href="#ga66308c1e791952047e974bd653037fae">&#9670;&#160;</a></span>ARM_ETH_MAC_GetMacAddress()</h2>
 944
 945 <div class="memitem">
 946 <div class="memproto">
 947       <table class="memname">
 948         <tr>
 949           <td class="memname">int32_t ARM_ETH_MAC_GetMacAddress </td>
 950           <td>(</td>
 951           <td class="paramtype"><a class="el" href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">ARM_ETH_MAC_ADDR</a> *&#160;</td>
 952           <td class="paramname"><em>ptr_addr</em></td><td>)</td>
 953           <td></td>
 954         </tr>
 955       </table>
 956 </div><div class="memdoc">
 957
 958 <p>Get Ethernet MAC Address. </p>
 959 <dl class="params"><dt>Parameters</dt><dd>
 960   <table class="params">
 961     <tr><td class="paramdir">[in]</td><td class="paramname">ptr_addr</td><td>Pointer to address </td></tr>
 962   </table>
 963   </dd>
 964 </dl>
 965 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
 966 <p>The function <b>ARM_ETH_MAC_GetMacAddress</b> retrieves the Ethernet MAC own address from the driver. </p>
 967
 968 </div>
 969 </div>
 970 <a id="ga7cc3d17c7312c5032202dfd9a915f24a" name="ga7cc3d17c7312c5032202dfd9a915f24a"></a>
 971 <h2 class="memtitle"><span class="permalink"><a href="#ga7cc3d17c7312c5032202dfd9a915f24a">&#9670;&#160;</a></span>ARM_ETH_MAC_SetMacAddress()</h2>
 972
 973 <div class="memitem">
 974 <div class="memproto">
 975       <table class="memname">
 976         <tr>
 977           <td class="memname">int32_t ARM_ETH_MAC_SetMacAddress </td>
 978           <td>(</td>
 979           <td class="paramtype">const <a class="el" href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">ARM_ETH_MAC_ADDR</a> *&#160;</td>
 980           <td class="paramname"><em>ptr_addr</em></td><td>)</td>
 981           <td></td>
 982         </tr>
 983       </table>
 984 </div><div class="memdoc">
 985
 986 <p>Set Ethernet MAC Address. </p>
 987 <dl class="params"><dt>Parameters</dt><dd>
 988   <table class="params">
 989     <tr><td class="paramdir">[in]</td><td class="paramname">ptr_addr</td><td>Pointer to address </td></tr>
 990   </table>
 991   </dd>
 992 </dl>
 993 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
 994 <p>The function <b>ARM_ETH_MAC_SetMacAddress</b> configures Ethernet MAC own address. The Ethernet MAC accepts packets <a href="http://en.wikipedia.org/wiki/Ethernet_frame" target="_blank"><b>Ethernet frames</b></a> which contains a MAC destination address that matches the address specified with <em>ptr_addr</em>.</p>
 995 <p>The Ethernet MAC receiver will accept also packets with addresses configured by <a class="el" href="group__eth__mac__interface__gr.html#ga150fe30290275a4b32756f94208124e8">ARM_ETH_MAC_SetAddressFilter</a> function.</p>
 996 <p>MAC receiver can be configured to accept also packets with broadcast address, any multicast address or even all packets regardless of address (Promiscuity Mode). This is configured by function <a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536">ARM_ETH_MAC_Control</a> with <a class="el" href="group__eth__mac__ctrls.html#ga7819c7a1aa7bbc13dc42d0fd7e75a23c">ARM_ETH_MAC_CONFIGURE</a> as control parameter. </p>
 997
 998 </div>
 999 </div>
1000 <a id="ga150fe30290275a4b32756f94208124e8" name="ga150fe30290275a4b32756f94208124e8"></a>
1001 <h2 class="memtitle"><span class="permalink"><a href="#ga150fe30290275a4b32756f94208124e8">&#9670;&#160;</a></span>ARM_ETH_MAC_SetAddressFilter()</h2>
1002
1003 <div class="memitem">
1004 <div class="memproto">
1005       <table class="memname">
1006         <tr>
1007           <td class="memname">int32_t ARM_ETH_MAC_SetAddressFilter </td>
1008           <td>(</td>
1009           <td class="paramtype">const <a class="el" href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">ARM_ETH_MAC_ADDR</a> *&#160;</td>
1010           <td class="paramname"><em>ptr_addr</em>, </td>
1011         </tr>
1012         <tr>
1013           <td class="paramkey"></td>
1014           <td></td>
1015           <td class="paramtype">uint32_t&#160;</td>
1016           <td class="paramname"><em>num_addr</em>&#160;</td>
1017         </tr>
1018         <tr>
1019           <td></td>
1020           <td>)</td>
1021           <td></td><td></td>
1022         </tr>
1023       </table>
1024 </div><div class="memdoc">
1025
1026 <p>Configure Address Filter. </p>
1027 <dl class="params"><dt>Parameters</dt><dd>
1028   <table class="params">
1029     <tr><td class="paramdir">[in]</td><td class="paramname">ptr_addr</td><td>Pointer to addresses </td></tr>
1030     <tr><td class="paramdir">[in]</td><td class="paramname">num_addr</td><td>Number of addresses to configure </td></tr>
1031   </table>
1032   </dd>
1033 </dl>
1034 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1035 <p>The function <b>ARM_ETH_MAC_SetAddressFilter</b> configures Ethernet MAC receiver address filtering. The Ethernet MAC accepts packets <a href="http://en.wikipedia.org/wiki/Ethernet_frame" target="_blank"><b>Ethernet frames</b></a> which contains a MAC destination address of the list supplied with <em>ptr_addr</em>. The parameter <em>ptr_addr</em> provides and array of Ethernet MAC addresses. The number of addresses is supplied by <em>num_addr</em>. Specifying <em>num_adr</em> = 0 disables address filtering previously set with this function.</p>
1036 <p>The Ethernet MAC receiver will accept packets addressed to its own address and packets with addresses configured by this function.</p>
1037 <p>MAC receiver can be configured to accept also packets with broadcast address, any multicast address or even all packets regardless of address (Promiscuity Mode). This is configured by function <a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536">ARM_ETH_MAC_Control</a> with <a class="el" href="group__eth__mac__ctrls.html#ga7819c7a1aa7bbc13dc42d0fd7e75a23c">ARM_ETH_MAC_CONFIGURE</a> as control parameter. </p>
1038
1039 </div>
1040 </div>
1041 <a id="ga5bf58defdb239ed7dc948f1da147a1c3" name="ga5bf58defdb239ed7dc948f1da147a1c3"></a>
1042 <h2 class="memtitle"><span class="permalink"><a href="#ga5bf58defdb239ed7dc948f1da147a1c3">&#9670;&#160;</a></span>ARM_ETH_MAC_SendFrame()</h2>
1043
1044 <div class="memitem">
1045 <div class="memproto">
1046       <table class="memname">
1047         <tr>
1048           <td class="memname">int32_t ARM_ETH_MAC_SendFrame </td>
1049           <td>(</td>
1050           <td class="paramtype">const uint8_t *&#160;</td>
1051           <td class="paramname"><em>frame</em>, </td>
1052         </tr>
1053         <tr>
1054           <td class="paramkey"></td>
1055           <td></td>
1056           <td class="paramtype">uint32_t&#160;</td>
1057           <td class="paramname"><em>len</em>, </td>
1058         </tr>
1059         <tr>
1060           <td class="paramkey"></td>
1061           <td></td>
1062           <td class="paramtype">uint32_t&#160;</td>
1063           <td class="paramname"><em>flags</em>&#160;</td>
1064         </tr>
1065         <tr>
1066           <td></td>
1067           <td>)</td>
1068           <td></td><td></td>
1069         </tr>
1070       </table>
1071 </div><div class="memdoc">
1072
1073 <p>Send Ethernet frame. </p>
1074 <dl class="params"><dt>Parameters</dt><dd>
1075   <table class="params">
1076     <tr><td class="paramdir">[in]</td><td class="paramname">frame</td><td>Pointer to frame buffer with data to send </td></tr>
1077     <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>Frame buffer length in bytes </td></tr>
1078     <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>Frame transmit flags (see ARM_ETH_MAC_TX_FRAME_...) </td></tr>
1079   </table>
1080   </dd>
1081 </dl>
1082 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1083 <p>The function <b>ARM_ETH_MAC_SendFrame</b> writes an <a href="http://en.wikipedia.org/wiki/Ethernet_frame" target="_blank"><b>Ethernet frame</b></a> to the Ethernet MAC transmit buffer.</p>
1084 <p>The Ethernet MAC transmit engine must be enabled by using the function <a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536">ARM_ETH_MAC_Control</a> (ARM_ETH_MAC_CONTROL_TX, 1) before a call to this function.</p>
1085 <p>The frame data addressed by <em>buf</em> starts with MAC destination and ends with the last Payload data byte. The frame data is copied into the transmit buffer of the Ethernet MAC interface. The function does not wait until the transmission over the Ethernet is complete, however the memory addressed by <em>buf</em> is available for the next Ethernet frame after return.</p>
1086 <p>The maximum value for <em>len</em> is implied by the size restrictions of the Ethernet frame but is not verified. Using an invalid value for <em>len</em> may generate unpredicted results.</p>
1087 <p>The parameter <em>flags</em> specifies additional attributes for the function as shown in the following table. Multiple flags can be combined, for example: ARM_ETH_MAC_TX_FRAME_EVENT | ARM_ETH_MAC_TX_FRAME_TIMESTAMP.</p>
1088 <table class="markdownTable">
1089 <tr class="markdownTableHead">
1090 <th class="markdownTableHeadLeft">Flag bit   </th><th class="markdownTableHeadLeft">Description    </th></tr>
1091 <tr class="markdownTableRowOdd">
1092 <td class="markdownTableBodyLeft"><a class="el" href="group__eth__mac__frame__transmit__ctrls.html#gab7bd6dea5bb57240291db71e95c99d9c">ARM_ETH_MAC_TX_FRAME_FRAGMENT</a>   </td><td class="markdownTableBodyLeft">Indicates that it is a fragment of the frame. allows you to collect multiple fragments before the frame is sent.    </td></tr>
1093 <tr class="markdownTableRowEven">
1094 <td class="markdownTableBodyLeft"><a class="el" href="group__eth__mac__frame__transmit__ctrls.html#ga91a923680ea0dad758b8950a3fbd237e">ARM_ETH_MAC_TX_FRAME_EVENT</a>   </td><td class="markdownTableBodyLeft"><a class="el" href="group__eth__mac__interface__gr.html#gae0697be4c4229601f3bfc17e2978ada6">ARM_ETH_MAC_SignalEvent</a> with <em>event</em> bit <a class="el" href="group__ETH__MAC__events.html#ga0c0328ff7cf886d5fdb53bb84ec03c1b">ARM_ETH_MAC_EVENT_TX_FRAME</a> set will be called when frame send is complete.    </td></tr>
1095 <tr class="markdownTableRowOdd">
1096 <td class="markdownTableBodyLeft"><a class="el" href="group__eth__mac__frame__transmit__ctrls.html#gade137f65dd345ae40e93c77d495f9b54">ARM_ETH_MAC_TX_FRAME_TIMESTAMP</a>   </td><td class="markdownTableBodyLeft">Capture the time stamp of the frame. The time stamp can be obtained using the function <a class="el" href="group__eth__mac__interface__gr.html#ga115b5c7e149aec2b181de760f5d83f60">ARM_ETH_MAC_GetTxFrameTime</a>.   </td></tr>
1097 </table>
1098 <p><b>Example:</b> </p><div class="fragment"><div class="line">status = mac-&gt;SendFrame (&amp;frame-&gt;data[0], frame-&gt;length, 0);</div>
1099 <div class="line"><span class="keywordflow">if</span> (status != <a class="code hl_define" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>)  {</div>
1100 <div class="line">  <span class="comment">// error handling</span></div>
1101 <div class="line">}</div>
1102 <div class="ttc" id="agroup__execution__status_html_ga85752c5de59e8adeb001e35ff5be6be7"><div class="ttname"><a href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a></div><div class="ttdeci">#define ARM_DRIVER_OK</div><div class="ttdoc">Operation succeeded.</div></div>
1103 </div><!-- fragment -->
1104 </div>
1105 </div>
1106 <a id="ga4b79f57d8624bb4410ee12c73a483993" name="ga4b79f57d8624bb4410ee12c73a483993"></a>
1107 <h2 class="memtitle"><span class="permalink"><a href="#ga4b79f57d8624bb4410ee12c73a483993">&#9670;&#160;</a></span>ARM_ETH_MAC_ReadFrame()</h2>
1108
1109 <div class="memitem">
1110 <div class="memproto">
1111       <table class="memname">
1112         <tr>
1113           <td class="memname">int32_t ARM_ETH_MAC_ReadFrame </td>
1114           <td>(</td>
1115           <td class="paramtype">uint8_t *&#160;</td>
1116           <td class="paramname"><em>frame</em>, </td>
1117         </tr>
1118         <tr>
1119           <td class="paramkey"></td>
1120           <td></td>
1121           <td class="paramtype">uint32_t&#160;</td>
1122           <td class="paramname"><em>len</em>&#160;</td>
1123         </tr>
1124         <tr>
1125           <td></td>
1126           <td>)</td>
1127           <td></td><td></td>
1128         </tr>
1129       </table>
1130 </div><div class="memdoc">
1131
1132 <p>Read data of received Ethernet frame. </p>
1133 <dl class="params"><dt>Parameters</dt><dd>
1134   <table class="params">
1135     <tr><td class="paramdir">[in]</td><td class="paramname">frame</td><td>Pointer to frame buffer for data to read into </td></tr>
1136     <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>Frame buffer length in bytes </td></tr>
1137   </table>
1138   </dd>
1139 </dl>
1140 <dl class="section return"><dt>Returns</dt><dd>number of data bytes read or execution status<ul>
1141 <li>value &gt;= 0: number of data bytes read</li>
1142 <li>value &lt; 0: error occurred, value is execution status as defined with <a class="el" href="group__execution__status.html">Status Error Codes</a></li>
1143 </ul>
1144 </dd></dl>
1145 <p>The function <b>ARM_ETH_MAC_ReadFrame</b> reads an <a href="http://en.wikipedia.org/wiki/Ethernet_frame" target="_blank"><b>Ethernet frame</b></a> from the Ethernet MAC receive buffer.</p>
1146 <p>The Ethernet MAC receive engine must be enabled using the function <a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536">ARM_ETH_MAC_Control</a> (ARM_ETH_MAC_CONTROL_RX , 1) before a call to this function. The <em>len</em> of the Ethernet frame can be checked using the function <a class="el" href="group__eth__mac__interface__gr.html#ga5ee86d6b0efab5329b9bc191c23a466d">ARM_ETH_MAC_GetRxFrameSize</a>.</p>
1147 <p>The frame data addressed by <em>buf</em> starts with MAC destination and ends with the last Payload data byte. The frame data is read from the receive buffer of the Ethernet MAC interface and the number of bytes written into the memory addressed by <em>buf</em> is returned. A negative return value indicates an error whereby the status code is defined with driver common return codes.</p>
1148 <p>The function <a class="el" href="group__eth__mac__interface__gr.html#ga4b79f57d8624bb4410ee12c73a483993">ARM_ETH_MAC_ReadFrame</a> may be called with <em>buf</em> = NULL and <em>len</em> = 0 to discard or release an frame. This is useful when an incorrect frame has been received or no memory is available to hold the Ethernet frame.</p>
1149 <p><b>Example:</b> </p><div class="fragment"><div class="line">size = mac-&gt;GetRxFrameSize ();</div>
1150 <div class="line"><span class="keywordflow">if</span> ((size &lt; 14) || (size &gt; 1514)) {    <span class="comment">// frame excludes CRC</span></div>
1151 <div class="line">  mac-&gt;ReadFrame (NULL, 0);            <span class="comment">// Frame error, release it</span></div>
1152 <div class="line">}</div>
1153 <div class="line">len = mac-&gt;ReadFrame (&amp;frame-&gt;data[0], size);</div>
1154 <div class="line"><span class="keywordflow">if</span> (len &lt; 0)  {</div>
1155 <div class="line">  <span class="comment">// error handling</span></div>
1156 <div class="line">}</div>
1157 </div><!-- fragment -->
1158 </div>
1159 </div>
1160 <a id="ga5ee86d6b0efab5329b9bc191c23a466d" name="ga5ee86d6b0efab5329b9bc191c23a466d"></a>
1161 <h2 class="memtitle"><span class="permalink"><a href="#ga5ee86d6b0efab5329b9bc191c23a466d">&#9670;&#160;</a></span>ARM_ETH_MAC_GetRxFrameSize()</h2>
1162
1163 <div class="memitem">
1164 <div class="memproto">
1165       <table class="memname">
1166         <tr>
1167           <td class="memname">uint32_t ARM_ETH_MAC_GetRxFrameSize </td>
1168           <td>(</td>
1169           <td class="paramtype">void&#160;</td>
1170           <td class="paramname"></td><td>)</td>
1171           <td></td>
1172         </tr>
1173       </table>
1174 </div><div class="memdoc">
1175
1176 <p>Get size of received Ethernet frame. </p>
1177 <dl class="section return"><dt>Returns</dt><dd>number of bytes in received frame</dd></dl>
1178 <p>The function <b>ARM_ETH_MAC_GetRxFrameSize</b> returns the size of a received <a href="http://en.wikipedia.org/wiki/Ethernet_frame" target="_blank"><b>Ethernet frame</b></a>. This function is called before <a class="el" href="group__eth__mac__interface__gr.html#ga4b79f57d8624bb4410ee12c73a483993">ARM_ETH_MAC_ReadFrame</a> and supplies the value <em>len</em>.</p>
1179 <p>The frame size includes MAC destination and ends with the last Payload data byte. Value <em>0</em> indicates that no Ethernet frame is available in the receive buffer. Values smaller than minimum size of Ethernet frame or larger than maximum size of Ethernet frame indicate an invalid frame which needs to be discarded by calling <a class="el" href="group__eth__mac__interface__gr.html#ga4b79f57d8624bb4410ee12c73a483993">ARM_ETH_MAC_ReadFrame</a>.</p>
1180 <p><b>Example:</b> </p><ul>
1181 <li>see <a class="el" href="group__eth__mac__interface__gr.html#ga4b79f57d8624bb4410ee12c73a483993">ARM_ETH_MAC_ReadFrame</a> </li>
1182 </ul>
1183
1184 </div>
1185 </div>
1186 <a id="gaa7c6865fb09754be869778142466c5e4" name="gaa7c6865fb09754be869778142466c5e4"></a>
1187 <h2 class="memtitle"><span class="permalink"><a href="#gaa7c6865fb09754be869778142466c5e4">&#9670;&#160;</a></span>ARM_ETH_MAC_GetRxFrameTime()</h2>
1188
1189 <div class="memitem">
1190 <div class="memproto">
1191       <table class="memname">
1192         <tr>
1193           <td class="memname">int32_t ARM_ETH_MAC_GetRxFrameTime </td>
1194           <td>(</td>
1195           <td class="paramtype"><a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *&#160;</td>
1196           <td class="paramname"><em>time</em></td><td>)</td>
1197           <td></td>
1198         </tr>
1199       </table>
1200 </div><div class="memdoc">
1201
1202 <p>Get time of received Ethernet frame. </p>
1203 <dl class="params"><dt>Parameters</dt><dd>
1204   <table class="params">
1205     <tr><td class="paramdir">[in]</td><td class="paramname">time</td><td>Pointer to time structure for data to read into </td></tr>
1206   </table>
1207   </dd>
1208 </dl>
1209 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1210 <p>Retrieve time stamp of a received <a href="http://en.wikipedia.org/wiki/Ethernet_frame" target="_blank"><b>Ethernet frame</b></a>. This function must be called before the frame is read using <a class="el" href="group__eth__mac__interface__gr.html#ga4b79f57d8624bb4410ee12c73a483993">ARM_ETH_MAC_ReadFrame</a>. </p>
1211
1212 </div>
1213 </div>
1214 <a id="ga115b5c7e149aec2b181de760f5d83f60" name="ga115b5c7e149aec2b181de760f5d83f60"></a>
1215 <h2 class="memtitle"><span class="permalink"><a href="#ga115b5c7e149aec2b181de760f5d83f60">&#9670;&#160;</a></span>ARM_ETH_MAC_GetTxFrameTime()</h2>
1216
1217 <div class="memitem">
1218 <div class="memproto">
1219       <table class="memname">
1220         <tr>
1221           <td class="memname">int32_t ARM_ETH_MAC_GetTxFrameTime </td>
1222           <td>(</td>
1223           <td class="paramtype"><a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *&#160;</td>
1224           <td class="paramname"><em>time</em></td><td>)</td>
1225           <td></td>
1226         </tr>
1227       </table>
1228 </div><div class="memdoc">
1229
1230 <p>Get time of transmitted Ethernet frame. </p>
1231 <dl class="params"><dt>Parameters</dt><dd>
1232   <table class="params">
1233     <tr><td class="paramdir">[in]</td><td class="paramname">time</td><td>Pointer to time structure for data to read into </td></tr>
1234   </table>
1235   </dd>
1236 </dl>
1237 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1238 <p>The function <b>returns</b> the time stamp of a transmitted <a href="http://en.wikipedia.org/wiki/Ethernet_frame" target="_blank"><b>Ethernet frame</b></a>. </p>
1239
1240 </div>
1241 </div>
1242 <a id="gac3e90c66058d20077f04ac8e8b8d0536" name="gac3e90c66058d20077f04ac8e8b8d0536"></a>
1243 <h2 class="memtitle"><span class="permalink"><a href="#gac3e90c66058d20077f04ac8e8b8d0536">&#9670;&#160;</a></span>ARM_ETH_MAC_Control()</h2>
1244
1245 <div class="memitem">
1246 <div class="memproto">
1247       <table class="memname">
1248         <tr>
1249           <td class="memname">int32_t ARM_ETH_MAC_Control </td>
1250           <td>(</td>
1251           <td class="paramtype">uint32_t&#160;</td>
1252           <td class="paramname"><em>control</em>, </td>
1253         </tr>
1254         <tr>
1255           <td class="paramkey"></td>
1256           <td></td>
1257           <td class="paramtype">uint32_t&#160;</td>
1258           <td class="paramname"><em>arg</em>&#160;</td>
1259         </tr>
1260         <tr>
1261           <td></td>
1262           <td>)</td>
1263           <td></td><td></td>
1264         </tr>
1265       </table>
1266 </div><div class="memdoc">
1267
1268 <p>Control Ethernet Interface. </p>
1269 <dl class="params"><dt>Parameters</dt><dd>
1270   <table class="params">
1271     <tr><td class="paramdir">[in]</td><td class="paramname">control</td><td>Operation </td></tr>
1272     <tr><td class="paramdir">[in]</td><td class="paramname">arg</td><td>Argument of operation (optional) </td></tr>
1273   </table>
1274   </dd>
1275 </dl>
1276 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1277 <p>The function <b>ARM_ETH_MAC_Control</b> controls the Ethernet MAC interface and executes various operations. After initialization, the Ethernet transceiver and receiver are disabled.</p>
1278 <p>The parameter <em>control</em> specifies an operation as defined in the table <b>Parameter <em>control</b></em>. <br  />
1279 The parameter <em>arg</em> provides, depending on the operation, additional information or values.</p>
1280 <p>The table lists values for the parameter <em>control</em>.</p>
1281 <table class="markdownTable">
1282 <tr class="markdownTableHead">
1283 <th class="markdownTableHeadLeft">Parameter <em>control</em>   </th><th class="markdownTableHeadLeft">Operation    </th></tr>
1284 <tr class="markdownTableRowOdd">
1285 <td class="markdownTableBodyLeft"><a class="el" href="group__eth__mac__ctrls.html#ga7819c7a1aa7bbc13dc42d0fd7e75a23c">ARM_ETH_MAC_CONFIGURE</a>   </td><td class="markdownTableBodyLeft">Configure the Ethernet MAC interface; For <em>arg</em> values, see table <b>Parameter <em>arg</em> for CONFIGURE</b>    </td></tr>
1286 <tr class="markdownTableRowEven">
1287 <td class="markdownTableBodyLeft"><a class="el" href="group__eth__mac__ctrls.html#ga3a98c8a7ee5ed4b1ffd250eecaeefe5c">ARM_ETH_MAC_CONTROL_TX</a>   </td><td class="markdownTableBodyLeft">Enable or disable the transmitter; <em>arg</em> : <span class="XML-Token">0=disable; 1=enable</span>    </td></tr>
1288 <tr class="markdownTableRowOdd">
1289 <td class="markdownTableBodyLeft"><a class="el" href="group__eth__mac__ctrls.html#gae0964364b81b38b6e1fbf7196f3be869">ARM_ETH_MAC_CONTROL_RX</a>   </td><td class="markdownTableBodyLeft">Enable or disable the receiver; <em>arg</em> : <span class="XML-Token">0=disable; 1=enable</span>    </td></tr>
1290 <tr class="markdownTableRowEven">
1291 <td class="markdownTableBodyLeft"><a class="el" href="group__eth__mac__ctrls.html#ga530812ef349a2e297f23de72e660fe27">ARM_ETH_MAC_FLUSH</a>   </td><td class="markdownTableBodyLeft">Flush a buffer; <em>arg</em> : see table <b>Parameter <em>arg</em> for FLUSH</b>    </td></tr>
1292 <tr class="markdownTableRowOdd">
1293 <td class="markdownTableBodyLeft"><a class="el" href="group__eth__mac__ctrls.html#ga4afe66589216f566f529af52f9075fdf">ARM_ETH_MAC_SLEEP</a>   </td><td class="markdownTableBodyLeft">Exit/Enter Sleep mode; <em>arg</em> : <span class="XML-Token">0=exit; 1=enter and wait for Magic packet</span>    </td></tr>
1294 <tr class="markdownTableRowEven">
1295 <td class="markdownTableBodyLeft"><a class="el" href="group__eth__mac__ctrls.html#gab332b58ba320e73864830dc42ad74181">ARM_ETH_MAC_VLAN_FILTER</a>   </td><td class="markdownTableBodyLeft">Configure VLAN Filter for received frames; <em>arg</em> : See table <b>Parameter <em>arg</em> for VLAN Filter</b>   </td></tr>
1296 </table>
1297 <p>The table <b>Parameter <em>arg</em> for CONFIGURE</b> lists the <em>arg</em> values for the <em>control</em> <b>ARM_ETH_MAC_CONFIGURE</b>. The values can be ORed in the following way: </p><div class="fragment"><div class="line">mac-&gt;Control(<a class="code hl_define" href="group__eth__mac__ctrls.html#ga7819c7a1aa7bbc13dc42d0fd7e75a23c">ARM_ETH_MAC_CONFIGURE</a>, <a class="code hl_define" href="group__eth__mac__configuration__ctrls.html#ga29160c83a7b0952c64053d86789c6490">ARM_ETH_MAC_SPEED_100M</a> | <a class="code hl_define" href="group__eth__mac__configuration__ctrls.html#gad5a7d4b5b8a31825eff1504e3828d8f6">ARM_ETH_MAC_DUPLEX_FULL</a> | <a class="code hl_define" href="group__eth__mac__configuration__ctrls.html#gab32765f35c35b672ee476278fe24a24e">ARM_ETH_MAC_LOOPBACK</a>);</div>
1298 <div class="ttc" id="agroup__eth__mac__configuration__ctrls_html_ga29160c83a7b0952c64053d86789c6490"><div class="ttname"><a href="group__eth__mac__configuration__ctrls.html#ga29160c83a7b0952c64053d86789c6490">ARM_ETH_MAC_SPEED_100M</a></div><div class="ttdeci">#define ARM_ETH_MAC_SPEED_100M</div><div class="ttdoc">100 Mbps link speed</div></div>
1299 <div class="ttc" id="agroup__eth__mac__configuration__ctrls_html_gab32765f35c35b672ee476278fe24a24e"><div class="ttname"><a href="group__eth__mac__configuration__ctrls.html#gab32765f35c35b672ee476278fe24a24e">ARM_ETH_MAC_LOOPBACK</a></div><div class="ttdeci">#define ARM_ETH_MAC_LOOPBACK</div><div class="ttdoc">Loop-back test mode.</div></div>
1300 <div class="ttc" id="agroup__eth__mac__configuration__ctrls_html_gad5a7d4b5b8a31825eff1504e3828d8f6"><div class="ttname"><a href="group__eth__mac__configuration__ctrls.html#gad5a7d4b5b8a31825eff1504e3828d8f6">ARM_ETH_MAC_DUPLEX_FULL</a></div><div class="ttdeci">#define ARM_ETH_MAC_DUPLEX_FULL</div><div class="ttdoc">Full duplex link.</div></div>
1301 <div class="ttc" id="agroup__eth__mac__ctrls_html_ga7819c7a1aa7bbc13dc42d0fd7e75a23c"><div class="ttname"><a href="group__eth__mac__ctrls.html#ga7819c7a1aa7bbc13dc42d0fd7e75a23c">ARM_ETH_MAC_CONFIGURE</a></div><div class="ttdeci">#define ARM_ETH_MAC_CONFIGURE</div><div class="ttdoc">Configure MAC; arg = configuration.</div></div>
1302 </div><!-- fragment --><table class="cmtable">
1303 <tr>
1304 <th colspan="4">Parameter <em>arg</em> CONFIGURE  </th></tr>
1305 <tr>
1306 <th>Parameter <em>arg</em> </th><th>Bit </th><th>Category </th><th>Description  </th></tr>
1307 <tr>
1308 <td><a class="el" href="group__eth__mac__configuration__ctrls.html#ga8c5b40d018ecfad05fe2546ba717c1d4">ARM_ETH_MAC_SPEED_10M</a> </td><td rowspan="3">0..1 </td><td rowspan="3">Link Speed </td><td>Set the link speed to <span class="XML-Token">10 [Mbps]</span>  </td></tr>
1309 <tr>
1310 <td><a class="el" href="group__eth__mac__configuration__ctrls.html#ga29160c83a7b0952c64053d86789c6490">ARM_ETH_MAC_SPEED_100M</a>  </td><td>Set the link speed to <span class="XML-Token">100 [Mbps]</span> </td></tr>
1311 <tr>
1312 <td><a class="el" href="group__eth__mac__configuration__ctrls.html#ga8acefed744d8397a1777b9fd0e6230d2">ARM_ETH_MAC_SPEED_1G</a>  </td><td>Set the link speed to <span class="XML-Token">1 [Gbps]</span>  </td></tr>
1313 <tr>
1314 <td><a class="el" href="group__eth__mac__configuration__ctrls.html#gadb0fe2c5a1e21b0656d39c788ae22f36">ARM_ETH_MAC_DUPLEX_HALF</a> </td><td rowspan="2">2 </td><td rowspan="2">Link Mode </td><td>Set the link mode to half duplex  </td></tr>
1315 <tr>
1316 <td><a class="el" href="group__eth__mac__configuration__ctrls.html#gad5a7d4b5b8a31825eff1504e3828d8f6">ARM_ETH_MAC_DUPLEX_FULL</a>  </td><td>Set the link mode to full duplex  </td></tr>
1317 <tr>
1318 <td>n.a. </td><td>3 </td><td>n.a. </td><td><em>reserved</em>  <br  />
1319  </td></tr>
1320 <tr>
1321 <td><a class="el" href="group__eth__mac__configuration__ctrls.html#gab32765f35c35b672ee476278fe24a24e">ARM_ETH_MAC_LOOPBACK</a> </td><td>4 </td><td>Loopback Test Mode </td><td>Set the interface into a Loop-back test mode </td></tr>
1322 <tr>
1323 <td><a class="el" href="group__eth__mac__configuration__ctrls.html#ga281dfed993b5666ed999709b9f28578f">ARM_ETH_MAC_CHECKSUM_OFFLOAD_RX</a></td><td>5 </td><td>Receiver Checksum offload</td><td>Enable Receiver Checksum offload  </td></tr>
1324 <tr>
1325 <td><a class="el" href="group__eth__mac__configuration__ctrls.html#ga7272d2c55aeeeadbb95c591cbf6c1a2e">ARM_ETH_MAC_CHECKSUM_OFFLOAD_TX</a></td><td>6 </td><td>Transmitter Checksum offload</td><td>Enable Transmitter Checksum offload  </td></tr>
1326 <tr>
1327 <td><a class="el" href="group__eth__mac__configuration__ctrls.html#ga43792feab641c3c87eafb943351ab0f4">ARM_ETH_MAC_ADDRESS_BROADCAST</a> </td><td>7 </td><td>Broadcast Frame address </td><td>Accept frames with Broadcast address  </td></tr>
1328 <tr>
1329 <td><a class="el" href="group__eth__mac__configuration__ctrls.html#ga1d3ff8c63362b385548fe91730f20588">ARM_ETH_MAC_ADDRESS_MULTICAST</a> </td><td>8 </td><td>Multicast Frame address </td><td>Accept frames with any Multicast address </td></tr>
1330 <tr>
1331 <td><a class="el" href="group__eth__mac__configuration__ctrls.html#gab29ab9e295807f4c59ddd1c4642086d1">ARM_ETH_MAC_ADDRESS_ALL</a> </td><td>9 </td><td>Any Frame address </td><td>Accept frames with any address (Promiscuous Mode) </td></tr>
1332 </table>
1333 <p>The table <b>Parameter <em>arg</em> for FLUSH</b> lists the <em>arg</em> values for the <em>control</em> <b>ARM_ETH_MAC_FLUSH</b>. The <em>arg</em> values can be ORed.</p>
1334 <table class="cmtable">
1335 <tr>
1336 <th colspan="4">Parameter <em>arg</em> for FLUSH  </th></tr>
1337 <tr>
1338 <th>Parameter <em>arg</em> </th><th>Bit </th><th>Category </th><th>Description  </th></tr>
1339 <tr>
1340 <td><a class="el" href="group__eth__mac__flush__flag__ctrls.html#gac18950811038319960756f063e1ef6d4">ARM_ETH_MAC_FLUSH_RX</a> </td><td>1 </td><td>Receive buffer </td><td>Flush the Receive buffer  </td></tr>
1341 <tr>
1342 <td><a class="el" href="group__eth__mac__flush__flag__ctrls.html#ga2d10ff33f4f4927820c6a17a2262b120">ARM_ETH_MAC_FLUSH_TX</a> </td><td>2 </td><td>Transmit buffer </td><td>Flush the Transmit buffer  </td></tr>
1343 </table>
1344 <p>The table <b>Parameter <em>arg</em> for VLAN Filter</b> lists the <em>arg</em> values for the <em>control</em> <b>ARM_ETH_MAC_VLAN_FILTER</b>. The <em>arg</em> values can be ORed.</p>
1345 <table class="cmtable">
1346 <tr>
1347 <th colspan="4">Parameter <em>arg</em> for VLAN Filter </th></tr>
1348 <tr>
1349 <th>Parameter <em>arg</em> </th><th>Bit </th><th>Category </th><th>Description  </th></tr>
1350 <tr>
1351 <td><em>value</em> </td><td>0..15 </td><td>VLAN Tag </td><td>Set VLAN Tag value  </td></tr>
1352 <tr>
1353 <td><span class="XML-Token">0</span> </td><td rowspan="2">16 </td><td rowspan="2">Use of VLAN </td><td>Compare the complete 16-bit VLAN Tag value  </td></tr>
1354 <tr>
1355 <td><a class="el" href="group__eth__mac__vlan__filter__ctrls.html#ga2511c9e4c22a2b351ce2e454be1c9427">ARM_ETH_MAC_VLAN_FILTER_ID_ONLY</a>  </td><td>Compare only the 12-bit VLAN Identifier  </td></tr>
1356 <tr>
1357 <td><span class="XML-Token">0</span> </td><td>0..16 </td><td>Disable </td><td>Disable the VLAN Filter  </td></tr>
1358 </table>
1359 <p><b>Example:</b> </p>
1360 <div class="fragment"><div class="line">...</div>
1361 <div class="line">                                         <span class="comment">// start transfer</span></div>
1362 <div class="line">    mac-&gt;Control(<a class="code hl_define" href="group__eth__mac__ctrls.html#ga7819c7a1aa7bbc13dc42d0fd7e75a23c">ARM_ETH_MAC_CONFIGURE</a>, <a class="code hl_define" href="group__eth__mac__configuration__ctrls.html#ga29160c83a7b0952c64053d86789c6490">ARM_ETH_MAC_SPEED_100M</a> | <a class="code hl_define" href="group__eth__mac__configuration__ctrls.html#gad5a7d4b5b8a31825eff1504e3828d8f6">ARM_ETH_MAC_DUPLEX_FULL</a> | <a class="code hl_define" href="group__eth__mac__configuration__ctrls.html#ga43792feab641c3c87eafb943351ab0f4">ARM_ETH_MAC_ADDRESS_BROADCAST</a>);</div>
1363 <div class="line">    mac-&gt;Control(<a class="code hl_define" href="group__eth__mac__ctrls.html#ga3a98c8a7ee5ed4b1ffd250eecaeefe5c">ARM_ETH_MAC_CONTROL_TX</a>, 1);</div>
1364 <div class="line">    mac-&gt;Control(<a class="code hl_define" href="group__eth__mac__ctrls.html#gae0964364b81b38b6e1fbf7196f3be869">ARM_ETH_MAC_CONTROL_RX</a>, 1);</div>
1365 <div class="line">   </div>
1366 <div class="line">...                                      <span class="comment">// stop transfer</span></div>
1367 <div class="line">    mac-&gt;Control(<a class="code hl_define" href="group__eth__mac__ctrls.html#ga530812ef349a2e297f23de72e660fe27">ARM_ETH_MAC_FLUSH</a>, <a class="code hl_define" href="group__eth__mac__flush__flag__ctrls.html#ga2d10ff33f4f4927820c6a17a2262b120">ARM_ETH_MAC_FLUSH_TX</a> | <a class="code hl_define" href="group__eth__mac__flush__flag__ctrls.html#gac18950811038319960756f063e1ef6d4">ARM_ETH_MAC_FLUSH_RX</a>);</div>
1368 <div class="line">    mac-&gt;Control(<a class="code hl_define" href="group__eth__mac__ctrls.html#ga3a98c8a7ee5ed4b1ffd250eecaeefe5c">ARM_ETH_MAC_CONTROL_TX</a>, 0);</div>
1369 <div class="line">    mac-&gt;Control(<a class="code hl_define" href="group__eth__mac__ctrls.html#gae0964364b81b38b6e1fbf7196f3be869">ARM_ETH_MAC_CONTROL_RX</a>, 0);</div>
1370 <div class="line">  }</div>
1371 <div class="line">}</div>
1372 <div class="ttc" id="agroup__eth__mac__configuration__ctrls_html_ga43792feab641c3c87eafb943351ab0f4"><div class="ttname"><a href="group__eth__mac__configuration__ctrls.html#ga43792feab641c3c87eafb943351ab0f4">ARM_ETH_MAC_ADDRESS_BROADCAST</a></div><div class="ttdeci">#define ARM_ETH_MAC_ADDRESS_BROADCAST</div><div class="ttdoc">Accept frames with Broadcast address.</div></div>
1373 <div class="ttc" id="agroup__eth__mac__ctrls_html_ga3a98c8a7ee5ed4b1ffd250eecaeefe5c"><div class="ttname"><a href="group__eth__mac__ctrls.html#ga3a98c8a7ee5ed4b1ffd250eecaeefe5c">ARM_ETH_MAC_CONTROL_TX</a></div><div class="ttdeci">#define ARM_ETH_MAC_CONTROL_TX</div><div class="ttdoc">Transmitter; arg: 0=disabled (default), 1=enabled.</div></div>
1374 <div class="ttc" id="agroup__eth__mac__ctrls_html_ga530812ef349a2e297f23de72e660fe27"><div class="ttname"><a href="group__eth__mac__ctrls.html#ga530812ef349a2e297f23de72e660fe27">ARM_ETH_MAC_FLUSH</a></div><div class="ttdeci">#define ARM_ETH_MAC_FLUSH</div><div class="ttdoc">Flush buffer; arg = ARM_ETH_MAC_FLUSH_...</div></div>
1375 <div class="ttc" id="agroup__eth__mac__ctrls_html_gae0964364b81b38b6e1fbf7196f3be869"><div class="ttname"><a href="group__eth__mac__ctrls.html#gae0964364b81b38b6e1fbf7196f3be869">ARM_ETH_MAC_CONTROL_RX</a></div><div class="ttdeci">#define ARM_ETH_MAC_CONTROL_RX</div><div class="ttdoc">Receiver; arg: 0=disabled (default), 1=enabled.</div></div>
1376 <div class="ttc" id="agroup__eth__mac__flush__flag__ctrls_html_ga2d10ff33f4f4927820c6a17a2262b120"><div class="ttname"><a href="group__eth__mac__flush__flag__ctrls.html#ga2d10ff33f4f4927820c6a17a2262b120">ARM_ETH_MAC_FLUSH_TX</a></div><div class="ttdeci">#define ARM_ETH_MAC_FLUSH_TX</div><div class="ttdoc">Flush Transmit buffer.</div></div>
1377 <div class="ttc" id="agroup__eth__mac__flush__flag__ctrls_html_gac18950811038319960756f063e1ef6d4"><div class="ttname"><a href="group__eth__mac__flush__flag__ctrls.html#gac18950811038319960756f063e1ef6d4">ARM_ETH_MAC_FLUSH_RX</a></div><div class="ttdeci">#define ARM_ETH_MAC_FLUSH_RX</div><div class="ttdoc">Flush Receive buffer.</div></div>
1378 </div><!-- fragment --><p>For a complete example, refer to <a class="el" href="group__eth__interface__gr.html">Ethernet Interface</a> - Driver Functions. </p>
1379
1380 </div>
1381 </div>
1382 <a id="ga85d9dc865af3702b71a514b18a588643" name="ga85d9dc865af3702b71a514b18a588643"></a>
1383 <h2 class="memtitle"><span class="permalink"><a href="#ga85d9dc865af3702b71a514b18a588643">&#9670;&#160;</a></span>ARM_ETH_MAC_ControlTimer()</h2>
1384
1385 <div class="memitem">
1386 <div class="memproto">
1387       <table class="memname">
1388         <tr>
1389           <td class="memname">int32_t ARM_ETH_MAC_ControlTimer </td>
1390           <td>(</td>
1391           <td class="paramtype">uint32_t&#160;</td>
1392           <td class="paramname"><em>control</em>, </td>
1393         </tr>
1394         <tr>
1395           <td class="paramkey"></td>
1396           <td></td>
1397           <td class="paramtype"><a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *&#160;</td>
1398           <td class="paramname"><em>time</em>&#160;</td>
1399         </tr>
1400         <tr>
1401           <td></td>
1402           <td>)</td>
1403           <td></td><td></td>
1404         </tr>
1405       </table>
1406 </div><div class="memdoc">
1407
1408 <p>Control Precision Timer. </p>
1409 <dl class="params"><dt>Parameters</dt><dd>
1410   <table class="params">
1411     <tr><td class="paramdir">[in]</td><td class="paramname">control</td><td>Operation </td></tr>
1412     <tr><td class="paramdir">[in]</td><td class="paramname">time</td><td>Pointer to time structure </td></tr>
1413   </table>
1414   </dd>
1415 </dl>
1416 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1417 <p>The function <b>ARM_ETH_MAC_ControlTimer</b> controls the timer required for PTP (Precision Time Protocol).</p>
1418 <p>The parameter <em>control</em> receives <b>ARM_ETH_MAC_TIMER_xxx</b> codes to manage the timer for a PTP enabled Ethernet MAC interface. <br  />
1419 The parameter <em>time</em> is pointer to a structure that holds time information.</p>
1420 <table class="markdownTable">
1421 <tr class="markdownTableHead">
1422 <th class="markdownTableHeadLeft">Mode Parameters: Timer Controls   </th><th class="markdownTableHeadLeft">Description    </th></tr>
1423 <tr class="markdownTableRowOdd">
1424 <td class="markdownTableBodyLeft"><a class="el" href="group__eth__mac__time__control.html#gad9a439b9727c032a7d851df2a7a622c2">ARM_ETH_MAC_TIMER_GET_TIME</a>   </td><td class="markdownTableBodyLeft">Retrieve the current time and update the content <a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *time.    </td></tr>
1425 <tr class="markdownTableRowEven">
1426 <td class="markdownTableBodyLeft"><a class="el" href="group__eth__mac__time__control.html#ga5e867a003c06046d7944bcb5723e6049">ARM_ETH_MAC_TIMER_SET_TIME</a>   </td><td class="markdownTableBodyLeft">Set the new time using the values provided with <a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *time.    </td></tr>
1427 <tr class="markdownTableRowOdd">
1428 <td class="markdownTableBodyLeft"><a class="el" href="group__eth__mac__time__control.html#ga3c57b3150717fb1a8cbbbac6a9b7ff69">ARM_ETH_MAC_TIMER_INC_TIME</a>   </td><td class="markdownTableBodyLeft">Increment the current time by using the values provided with <a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *time.    </td></tr>
1429 <tr class="markdownTableRowEven">
1430 <td class="markdownTableBodyLeft"><a class="el" href="group__eth__mac__time__control.html#gaca9f1c4259d0342e9717a362de1ccf41">ARM_ETH_MAC_TIMER_DEC_TIME</a>   </td><td class="markdownTableBodyLeft">Decrement the current time by using the values provided with <a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *time.    </td></tr>
1431 <tr class="markdownTableRowOdd">
1432 <td class="markdownTableBodyLeft"><a class="el" href="group__eth__mac__time__control.html#ga04c2469ba027b020bc6b5baf3b51cf74">ARM_ETH_MAC_TIMER_SET_ALARM</a>   </td><td class="markdownTableBodyLeft">Set the alarm time to the values provided with <a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *time.    </td></tr>
1433 <tr class="markdownTableRowEven">
1434 <td class="markdownTableBodyLeft"><a class="el" href="group__eth__mac__time__control.html#ga85cb862eba0934e958a8552022588db7">ARM_ETH_MAC_TIMER_ADJUST_CLOCK</a>   </td><td class="markdownTableBodyLeft">Set the clock frequency; the value in time-&gt;ns is the <b>correction factor</b> in fractional format q31.   </td></tr>
1435 </table>
1436
1437 </div>
1438 </div>
1439 <a id="gaded29ad58366e9222487db9944373c29" name="gaded29ad58366e9222487db9944373c29"></a>
1440 <h2 class="memtitle"><span class="permalink"><a href="#gaded29ad58366e9222487db9944373c29">&#9670;&#160;</a></span>ARM_ETH_MAC_PHY_Read()</h2>
1441
1442 <div class="memitem">
1443 <div class="memproto">
1444       <table class="memname">
1445         <tr>
1446           <td class="memname">int32_t ARM_ETH_MAC_PHY_Read </td>
1447           <td>(</td>
1448           <td class="paramtype">uint8_t&#160;</td>
1449           <td class="paramname"><em>phy_addr</em>, </td>
1450         </tr>
1451         <tr>
1452           <td class="paramkey"></td>
1453           <td></td>
1454           <td class="paramtype">uint8_t&#160;</td>
1455           <td class="paramname"><em>reg_addr</em>, </td>
1456         </tr>
1457         <tr>
1458           <td class="paramkey"></td>
1459           <td></td>
1460           <td class="paramtype">uint16_t *&#160;</td>
1461           <td class="paramname"><em>data</em>&#160;</td>
1462         </tr>
1463         <tr>
1464           <td></td>
1465           <td>)</td>
1466           <td></td><td></td>
1467         </tr>
1468       </table>
1469 </div><div class="memdoc">
1470
1471 <p>Read Ethernet PHY Register through Management Interface. </p>
1472 <dl class="params"><dt>Parameters</dt><dd>
1473   <table class="params">
1474     <tr><td class="paramdir">[in]</td><td class="paramname">phy_addr</td><td>5-bit device address </td></tr>
1475     <tr><td class="paramdir">[in]</td><td class="paramname">reg_addr</td><td>5-bit register address </td></tr>
1476     <tr><td class="paramdir">[out]</td><td class="paramname">data</td><td>Pointer where the result is written to </td></tr>
1477   </table>
1478   </dd>
1479 </dl>
1480 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1481 <p>Read Ethernet PHY Register through the Management Interface. The function is passed to <a class="el" href="group__eth__phy__interface__gr.html#gacf2332a7fa2d84694b8e5f0838135589">ARM_ETH_PHY_Initialize</a>. The Ethernet PHY driver uses this function to read the value of PHY registers.</p>
1482 <p><b>Example:</b> </p><ul>
1483 <li>see <a class="el" href="group__eth__interface__gr.html">Ethernet Interface</a> - Driver Functions </li>
1484 </ul>
1485
1486 </div>
1487 </div>
1488 <a id="ga79dd38672749aeebd28f39d9b4f813ce" name="ga79dd38672749aeebd28f39d9b4f813ce"></a>
1489 <h2 class="memtitle"><span class="permalink"><a href="#ga79dd38672749aeebd28f39d9b4f813ce">&#9670;&#160;</a></span>ARM_ETH_MAC_PHY_Write()</h2>
1490
1491 <div class="memitem">
1492 <div class="memproto">
1493       <table class="memname">
1494         <tr>
1495           <td class="memname">int32_t ARM_ETH_MAC_PHY_Write </td>
1496           <td>(</td>
1497           <td class="paramtype">uint8_t&#160;</td>
1498           <td class="paramname"><em>phy_addr</em>, </td>
1499         </tr>
1500         <tr>
1501           <td class="paramkey"></td>
1502           <td></td>
1503           <td class="paramtype">uint8_t&#160;</td>
1504           <td class="paramname"><em>reg_addr</em>, </td>
1505         </tr>
1506         <tr>
1507           <td class="paramkey"></td>
1508           <td></td>
1509           <td class="paramtype">uint16_t&#160;</td>
1510           <td class="paramname"><em>data</em>&#160;</td>
1511         </tr>
1512         <tr>
1513           <td></td>
1514           <td>)</td>
1515           <td></td><td></td>
1516         </tr>
1517       </table>
1518 </div><div class="memdoc">
1519
1520 <p>Write Ethernet PHY Register through Management Interface. </p>
1521 <dl class="params"><dt>Parameters</dt><dd>
1522   <table class="params">
1523     <tr><td class="paramdir">[in]</td><td class="paramname">phy_addr</td><td>5-bit device address </td></tr>
1524     <tr><td class="paramdir">[in]</td><td class="paramname">reg_addr</td><td>5-bit register address </td></tr>
1525     <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>16-bit data to write </td></tr>
1526   </table>
1527   </dd>
1528 </dl>
1529 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1530 <p>The function <b>ARM_ETH_MAC_PHY_Write</b> writes to a Ethernet PHY register through the Management Interface. The function is passed to <a class="el" href="group__eth__phy__interface__gr.html#gacf2332a7fa2d84694b8e5f0838135589">ARM_ETH_PHY_Initialize</a>. The Ethernet PHY driver uses this function to write data to PHY registers.</p>
1531 <p><b>Example:</b> </p><ul>
1532 <li>see <a class="el" href="group__eth__interface__gr.html">Ethernet Interface</a> - Driver Functions </li>
1533 </ul>
1534
1535 </div>
1536 </div>
1537 <a id="gae0697be4c4229601f3bfc17e2978ada6" name="gae0697be4c4229601f3bfc17e2978ada6"></a>
1538 <h2 class="memtitle"><span class="permalink"><a href="#gae0697be4c4229601f3bfc17e2978ada6">&#9670;&#160;</a></span>ARM_ETH_MAC_SignalEvent()</h2>
1539
1540 <div class="memitem">
1541 <div class="memproto">
1542       <table class="memname">
1543         <tr>
1544           <td class="memname">void ARM_ETH_MAC_SignalEvent </td>
1545           <td>(</td>
1546           <td class="paramtype">uint32_t&#160;</td>
1547           <td class="paramname"><em>event</em></td><td>)</td>
1548           <td></td>
1549         </tr>
1550       </table>
1551 </div><div class="memdoc">
1552
1553 <p>Callback function that signals a Ethernet Event. </p>
1554 <dl class="params"><dt>Parameters</dt><dd>
1555   <table class="params">
1556     <tr><td class="paramdir">[in]</td><td class="paramname">event</td><td>event notification mask </td></tr>
1557   </table>
1558   </dd>
1559 </dl>
1560 <dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
1561 <p>The function <b>ARM_ETH_MAC_SignalEvent</b> is a callback function registered by the function <a class="el" href="group__eth__mac__interface__gr.html#gacf42d11b171cd032f0ec1de6db2b6832">ARM_ETH_MAC_Initialize</a>. This function is typically called from interrupt service routines (ISR) to indicate that a frame is processed or a special event occurred.</p>
1562 <p>The parameter <em>event</em> indicates one or more events that occurred during driver operation. Each event is encoded in a separate bit and therefore it is possible to signal multiple events within the same call.</p>
1563 <p>Not every event is necessarily generated by the driver. This depends on the implemented capabilities stored in the data fields of the structure <a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES">ARM_ETH_MAC_CAPABILITIES</a>, which can be retrieved with the function <a class="el" href="group__eth__mac__interface__gr.html#ga2b13b230502736d8c7679b359dff20d0">ARM_ETH_MAC_GetCapabilities</a>.</p>
1564 <p>The following events can be generated:</p>
1565 <table class="markdownTable">
1566 <tr class="markdownTableHead">
1567 <th class="markdownTableHeadLeft">Parameter <em>event</em>   </th><th class="markdownTableHeadCenter">Bit   </th><th class="markdownTableHeadLeft">Description    </th></tr>
1568 <tr class="markdownTableRowOdd">
1569 <td class="markdownTableBodyLeft"><a class="el" href="group__ETH__MAC__events.html#ga76943471a4a3e9e8c1ff9fe83e43bd47">ARM_ETH_MAC_EVENT_RX_FRAME</a>   </td><td class="markdownTableBodyCenter">0   </td><td class="markdownTableBodyLeft">Occurs after a frame is received. Frame can be read by calling <a class="el" href="group__eth__mac__interface__gr.html#ga4b79f57d8624bb4410ee12c73a483993">ARM_ETH_MAC_ReadFrame</a>.    </td></tr>
1570 <tr class="markdownTableRowEven">
1571 <td class="markdownTableBodyLeft"><a class="el" href="group__ETH__MAC__events.html#ga0c0328ff7cf886d5fdb53bb84ec03c1b">ARM_ETH_MAC_EVENT_TX_FRAME</a>   </td><td class="markdownTableBodyCenter">1   </td><td class="markdownTableBodyLeft">Occurs after call to <a class="el" href="group__eth__mac__interface__gr.html#ga5bf58defdb239ed7dc948f1da147a1c3">ARM_ETH_MAC_SendFrame</a> to indicate that the frame is transmitted.    </td></tr>
1572 <tr class="markdownTableRowOdd">
1573 <td class="markdownTableBodyLeft"><a class="el" href="group__ETH__MAC__events.html#ga1f3bdb219afa8f2a121b58cc84f5761c">ARM_ETH_MAC_EVENT_WAKEUP</a>   </td><td class="markdownTableBodyCenter">2   </td><td class="markdownTableBodyLeft">Indicates that a Magic Packet is received while the driver is in Sleep mode (set by <a class="el" href="group__eth__mac__ctrls.html#ga4afe66589216f566f529af52f9075fdf">ARM_ETH_MAC_SLEEP</a> using <a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536">ARM_ETH_MAC_Control</a>).    </td></tr>
1574 <tr class="markdownTableRowEven">
1575 <td class="markdownTableBodyLeft"><a class="el" href="group__ETH__MAC__events.html#ga4afc71ecac964f195e27be4acdbe7c61">ARM_ETH_MAC_EVENT_TIMER_ALARM</a>   </td><td class="markdownTableBodyCenter">3   </td><td class="markdownTableBodyLeft">Indicates that a Timer Alarm occurred that was set with <a class="el" href="group__eth__mac__time__control.html#ga04c2469ba027b020bc6b5baf3b51cf74">ARM_ETH_MAC_TIMER_SET_ALARM</a> using ARM_ETH_MAC_ControlTimer.   </td></tr>
1576 </table>
1577
1578 </div>
1579 </div>
1580 </div><!-- contents -->
1581 </div><!-- doc-content -->
1582 <!-- start footer part -->
1583 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
1584   <ul>
1585     <li class="footer">
1586       <script type="text/javascript">
1587         <!--
1588         writeFooter.call(this);
1589         //-->
1590       </script>
1591     </li>
1592   </ul>
1593 </div>
1594 </body>
1595 </html>