begriffs open source - cmsis/blob - dev/v6.0.0-dev53/Driver/html/group__eth__phy__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 PHY 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);
  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__phy__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 PHY 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 PHY Peripheral (Driver_ETH_PHY.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__phy__mode__ctrls"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__mode__ctrls.html">Ethernet PHY Mode</a></td></tr>
 145 <tr class="memdesc:group__eth__phy__mode__ctrls"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specify operation modes of the Ethernet PHY interface. <br /></td></tr>
 146 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 </table><table class="memberdecls">
 148 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
 149 Data Structures</h2></td></tr>
 150 <tr class="memitem:structARM__DRIVER__ETH__PHY"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#structARM__DRIVER__ETH__PHY">ARM_DRIVER_ETH_PHY</a></td></tr>
 151 <tr class="memdesc:structARM__DRIVER__ETH__PHY"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access structure of the Ethernet PHY Driver.  <a href="group__eth__phy__interface__gr.html#structARM__DRIVER__ETH__PHY">More...</a><br /></td></tr>
 152 <tr class="separator:structARM__DRIVER__ETH__PHY"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 </table><table class="memberdecls">
 154 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
 155 Typedefs</h2></td></tr>
 156 <tr class="memitem:ga987d5dd36f179192721c03df37d93e87"><td class="memItemLeft" align="right" valign="top">typedef int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#ga987d5dd36f179192721c03df37d93e87">ARM_ETH_PHY_Read_t</a>) (uint8_t phy_addr, uint8_t reg_addr, uint16_t *data)</td></tr>
 157 <tr class="memdesc:ga987d5dd36f179192721c03df37d93e87"><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.  <br /></td></tr>
 158 <tr class="separator:ga987d5dd36f179192721c03df37d93e87"><td class="memSeparator" colspan="2">&#160;</td></tr>
 159 <tr class="memitem:gaf690fde16281b25f2ffa07f9c4e8e240"><td class="memItemLeft" align="right" valign="top">typedef int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#gaf690fde16281b25f2ffa07f9c4e8e240">ARM_ETH_PHY_Write_t</a>) (uint8_t phy_addr, uint8_t reg_addr, uint16_t data)</td></tr>
 160 <tr class="memdesc:gaf690fde16281b25f2ffa07f9c4e8e240"><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.  <br /></td></tr>
 161 <tr class="separator:gaf690fde16281b25f2ffa07f9c4e8e240"><td class="memSeparator" colspan="2">&#160;</td></tr>
 162 </table><table class="memberdecls">
 163 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 164 Functions</h2></td></tr>
 165 <tr class="memitem:ga6850d33d699d9deee4e983a2c99e9734"><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__phy__interface__gr.html#ga6850d33d699d9deee4e983a2c99e9734">ARM_ETH_PHY_GetVersion</a> (void)</td></tr>
 166 <tr class="memdesc:ga6850d33d699d9deee4e983a2c99e9734"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get driver version.  <br /></td></tr>
 167 <tr class="separator:ga6850d33d699d9deee4e983a2c99e9734"><td class="memSeparator" colspan="2">&#160;</td></tr>
 168 <tr class="memitem:gacf2332a7fa2d84694b8e5f0838135589"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#gacf2332a7fa2d84694b8e5f0838135589">ARM_ETH_PHY_Initialize</a> (<a class="el" href="group__eth__phy__interface__gr.html#ga987d5dd36f179192721c03df37d93e87">ARM_ETH_PHY_Read_t</a> fn_read, <a class="el" href="group__eth__phy__interface__gr.html#gaf690fde16281b25f2ffa07f9c4e8e240">ARM_ETH_PHY_Write_t</a> fn_write)</td></tr>
 169 <tr class="memdesc:gacf2332a7fa2d84694b8e5f0838135589"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize Ethernet PHY Device.  <br /></td></tr>
 170 <tr class="separator:gacf2332a7fa2d84694b8e5f0838135589"><td class="memSeparator" colspan="2">&#160;</td></tr>
 171 <tr class="memitem:ga26ea7e1e9825b959284241ebff6eea3f"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#ga26ea7e1e9825b959284241ebff6eea3f">ARM_ETH_PHY_Uninitialize</a> (void)</td></tr>
 172 <tr class="memdesc:ga26ea7e1e9825b959284241ebff6eea3f"><td class="mdescLeft">&#160;</td><td class="mdescRight">De-initialize Ethernet PHY Device.  <br /></td></tr>
 173 <tr class="separator:ga26ea7e1e9825b959284241ebff6eea3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 174 <tr class="memitem:gaba0f92561754dad8f8f03feb1cf2855e"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#gaba0f92561754dad8f8f03feb1cf2855e">ARM_ETH_PHY_PowerControl</a> (<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
 175 <tr class="memdesc:gaba0f92561754dad8f8f03feb1cf2855e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Control Ethernet PHY Device Power.  <br /></td></tr>
 176 <tr class="separator:gaba0f92561754dad8f8f03feb1cf2855e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 177 <tr class="memitem:gaedd8b5650a1259d572a1f303d3e2c01c"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#gaedd8b5650a1259d572a1f303d3e2c01c">ARM_ETH_PHY_SetInterface</a> (uint32_t interface)</td></tr>
 178 <tr class="memdesc:gaedd8b5650a1259d572a1f303d3e2c01c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set Ethernet Media Interface.  <br /></td></tr>
 179 <tr class="separator:gaedd8b5650a1259d572a1f303d3e2c01c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 180 <tr class="memitem:ga9aa688c951f01ed9ca7c88cf51be8a09"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#ga9aa688c951f01ed9ca7c88cf51be8a09">ARM_ETH_PHY_SetMode</a> (uint32_t mode)</td></tr>
 181 <tr class="memdesc:ga9aa688c951f01ed9ca7c88cf51be8a09"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set Ethernet PHY Device Operation mode.  <br /></td></tr>
 182 <tr class="separator:ga9aa688c951f01ed9ca7c88cf51be8a09"><td class="memSeparator" colspan="2">&#160;</td></tr>
 183 <tr class="memitem:ga4085cd24ebe33b78d51a3c003da4a5ba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__eth__interface__gr.html#gacf7db5320eb841b462a4af3c56cc9291">ARM_ETH_LINK_STATE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#ga4085cd24ebe33b78d51a3c003da4a5ba">ARM_ETH_PHY_GetLinkState</a> (void)</td></tr>
 184 <tr class="memdesc:ga4085cd24ebe33b78d51a3c003da4a5ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get Ethernet PHY Device Link state.  <br /></td></tr>
 185 <tr class="separator:ga4085cd24ebe33b78d51a3c003da4a5ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
 186 <tr class="memitem:ga8c79dcd7a12656403f3befab3c8605a2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__eth__interface__gr.html#structARM__ETH__LINK__INFO">ARM_ETH_LINK_INFO</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#ga8c79dcd7a12656403f3befab3c8605a2">ARM_ETH_PHY_GetLinkInfo</a> (void)</td></tr>
 187 <tr class="memdesc:ga8c79dcd7a12656403f3befab3c8605a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get Ethernet PHY Device Link information.  <br /></td></tr>
 188 <tr class="separator:ga8c79dcd7a12656403f3befab3c8605a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 189 </table>
 190 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 191 <p>Driver API for Ethernet PHY Peripheral (Driver_ETH_PHY.h) </p>
 192 <p>The following section describes the Ethernet PHY Interface as defined in the Driver_ETH_PHY.h header file.</p>
 193 <p>The Driver_ETH_PHY.h contains two #defines that are used to configure the connection between the PHY and the microcontroller device:</p><ul>
 194 <li><code>ETH_PHY_NUM</code> and</li>
 195 <li><code>ETH_PHY_ADDR</code> </li>
 196 </ul>
 197 <p>Usually, the Serial Management Interface (<b>SMI</b>) (using MDC and MDIO) is used to access the PHY’s internal registers to read the state of the link (up/down), duplex mode, speed, and to restart auto-negotiation etc. SMI is a serial bus, which allows to connect up to 32 devices. Devices on the bus are accessed using a 5-bit device address. A default device address is hardware configurable by pin-strapping on the device (some pins are sampled when a reset is asserted or at power-up).</p>
 198 <p>The device’s internal weak pull-up or pull-down resistors define a default device address. This address can be changed by connecting strong pull-up or pull-down resistors externally. In this case, the <code>ETH_PHY_ADDR</code> needs to be defined by the user.</p>
 199 <p>If a microcontroller device offers more than one Ethernet PHY driver, the user needs to set the correct <code>ETH_PHY_NUM</code> in his application. </p>
 200 <hr/><h2 class="groupheader">Data Structure Documentation</h2>
 201 <a name="structARM__DRIVER__ETH__PHY" id="structARM__DRIVER__ETH__PHY"></a>
 202 <h2 class="memtitle"><span class="permalink"><a href="#structARM__DRIVER__ETH__PHY">&#9670;&#160;</a></span>ARM_DRIVER_ETH_PHY</h2>
 203
 204 <div class="memitem">
 205 <div class="memproto">
 206       <table class="memname">
 207         <tr>
 208           <td class="memname">struct ARM_DRIVER_ETH_PHY</td>
 209         </tr>
 210       </table>
 211 </div><div class="memdoc">
 212 <div class="textblock"><p>Access structure of the Ethernet PHY Driver. </p>
 213 <p>The functions of the Ethernet PHY are accessed by function pointers exposed by this structure. Refer to <a class="el" href="theoryOperation.html#DriverFunctions">Common Driver Functions</a> for overview information.</p>
 214 <p>Each instance of an Ethernet PHY provides such an access struct. The instance is identified by a postfix number in the symbol name of the access struct, for example:</p><ul>
 215 <li><b>Driver_ETH_PHY0</b> is the name of the access struct of the first instance (no. 0).</li>
 216 <li><b>Driver_ETH_PHY1</b> is the name of the access struct of the second instance (no. 1).</li>
 217 </ul>
 218 <p>A configuration setting in the middleware allows connecting the middleware to a specific driver instance <b>Driver_ETH_PHY<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>
 219 </div><table class="memberdecls">
 220 <tr><td colspan="2"><h3>Data Fields</h3></td></tr>
 221 <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__phy__interface__gr.html#a30afd9cb3113c037b5f1926f5ef93b59">GetVersion</a> )(void)</td></tr>
 222 <tr class="memdesc:a30afd9cb3113c037b5f1926f5ef93b59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__eth__phy__interface__gr.html#ga6850d33d699d9deee4e983a2c99e9734">ARM_ETH_PHY_GetVersion</a> : Get driver version.  <br /></td></tr>
 223 <tr class="separator:a30afd9cb3113c037b5f1926f5ef93b59"><td class="memSeparator" colspan="2">&#160;</td></tr>
 224 <tr class="memitem:a075963ee0204bfe96ee500c90370d196"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#a075963ee0204bfe96ee500c90370d196">Initialize</a> )(<a class="el" href="group__eth__phy__interface__gr.html#ga987d5dd36f179192721c03df37d93e87">ARM_ETH_PHY_Read_t</a> fn_read, <a class="el" href="group__eth__phy__interface__gr.html#gaf690fde16281b25f2ffa07f9c4e8e240">ARM_ETH_PHY_Write_t</a> fn_write)</td></tr>
 225 <tr class="memdesc:a075963ee0204bfe96ee500c90370d196"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__eth__phy__interface__gr.html#gacf2332a7fa2d84694b8e5f0838135589">ARM_ETH_PHY_Initialize</a> : Initialize PHY Device.  <br /></td></tr>
 226 <tr class="separator:a075963ee0204bfe96ee500c90370d196"><td class="memSeparator" colspan="2">&#160;</td></tr>
 227 <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__phy__interface__gr.html#a5ce2b3d7a3a07099bf07d1eb253e92e3">Uninitialize</a> )(void)</td></tr>
 228 <tr class="memdesc:a5ce2b3d7a3a07099bf07d1eb253e92e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__eth__phy__interface__gr.html#ga26ea7e1e9825b959284241ebff6eea3f">ARM_ETH_PHY_Uninitialize</a> : De-initialize PHY Device.  <br /></td></tr>
 229 <tr class="separator:a5ce2b3d7a3a07099bf07d1eb253e92e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 230 <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__phy__interface__gr.html#a24ebae5c6011631f76027f9a16eaf5ce">PowerControl</a> )(<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
 231 <tr class="memdesc:a24ebae5c6011631f76027f9a16eaf5ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__eth__phy__interface__gr.html#gaba0f92561754dad8f8f03feb1cf2855e">ARM_ETH_PHY_PowerControl</a> : Control PHY Device Power.  <br /></td></tr>
 232 <tr class="separator:a24ebae5c6011631f76027f9a16eaf5ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
 233 <tr class="memitem:a9d26ef49db500c351debea73257d2dcf"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#a9d26ef49db500c351debea73257d2dcf">SetInterface</a> )(uint32_t interface)</td></tr>
 234 <tr class="memdesc:a9d26ef49db500c351debea73257d2dcf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__eth__phy__interface__gr.html#gaedd8b5650a1259d572a1f303d3e2c01c">ARM_ETH_PHY_SetInterface</a> : Set Ethernet Media Interface.  <br /></td></tr>
 235 <tr class="separator:a9d26ef49db500c351debea73257d2dcf"><td class="memSeparator" colspan="2">&#160;</td></tr>
 236 <tr class="memitem:a1ed7a1889ba8d4cd2ff02791a18b19db"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#a1ed7a1889ba8d4cd2ff02791a18b19db">SetMode</a> )(uint32_t mode)</td></tr>
 237 <tr class="memdesc:a1ed7a1889ba8d4cd2ff02791a18b19db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__eth__phy__interface__gr.html#ga9aa688c951f01ed9ca7c88cf51be8a09">ARM_ETH_PHY_SetMode</a> : Set Ethernet PHY Device Operation mode.  <br /></td></tr>
 238 <tr class="separator:a1ed7a1889ba8d4cd2ff02791a18b19db"><td class="memSeparator" colspan="2">&#160;</td></tr>
 239 <tr class="memitem:ad3ed7f0f95328d4a0224e44b04ad0163"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__eth__interface__gr.html#gacf7db5320eb841b462a4af3c56cc9291">ARM_ETH_LINK_STATE</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#ad3ed7f0f95328d4a0224e44b04ad0163">GetLinkState</a> )(void)</td></tr>
 240 <tr class="memdesc:ad3ed7f0f95328d4a0224e44b04ad0163"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__eth__phy__interface__gr.html#ga4085cd24ebe33b78d51a3c003da4a5ba">ARM_ETH_PHY_GetLinkState</a> : Get Ethernet PHY Device Link state.  <br /></td></tr>
 241 <tr class="separator:ad3ed7f0f95328d4a0224e44b04ad0163"><td class="memSeparator" colspan="2">&#160;</td></tr>
 242 <tr class="memitem:a8e20e8e50e3acaa52c8c9039b1e4d281"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__eth__interface__gr.html#structARM__ETH__LINK__INFO">ARM_ETH_LINK_INFO</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#a8e20e8e50e3acaa52c8c9039b1e4d281">GetLinkInfo</a> )(void)</td></tr>
 243 <tr class="memdesc:a8e20e8e50e3acaa52c8c9039b1e4d281"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__eth__phy__interface__gr.html#ga8c79dcd7a12656403f3befab3c8605a2">ARM_ETH_PHY_GetLinkInfo</a> : Get Ethernet PHY Device Link information.  <br /></td></tr>
 244 <tr class="separator:a8e20e8e50e3acaa52c8c9039b1e4d281"><td class="memSeparator" colspan="2">&#160;</td></tr>
 245 </table>
 246 <h4 class="groupheader">Field Documentation</h4>
 247 <a id="a30afd9cb3113c037b5f1926f5ef93b59" name="a30afd9cb3113c037b5f1926f5ef93b59"></a>
 248 <h2 class="memtitle"><span class="permalink"><a href="#a30afd9cb3113c037b5f1926f5ef93b59">&#9670;&#160;</a></span>GetVersion</h2>
 249
 250 <div class="memitem">
 251 <div class="memproto">
 252       <table class="memname">
 253         <tr>
 254           <td class="memname"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>(* GetVersion) (void)</td>
 255         </tr>
 256       </table>
 257 </div><div class="memdoc">
 258
 259 <p>Pointer to <a class="el" href="group__eth__phy__interface__gr.html#ga6850d33d699d9deee4e983a2c99e9734">ARM_ETH_PHY_GetVersion</a> : Get driver version. </p>
 260
 261 </div>
 262 </div>
 263 <a id="a075963ee0204bfe96ee500c90370d196" name="a075963ee0204bfe96ee500c90370d196"></a>
 264 <h2 class="memtitle"><span class="permalink"><a href="#a075963ee0204bfe96ee500c90370d196">&#9670;&#160;</a></span>Initialize</h2>
 265
 266 <div class="memitem">
 267 <div class="memproto">
 268       <table class="memname">
 269         <tr>
 270           <td class="memname">int32_t(* Initialize) (<a class="el" href="group__eth__phy__interface__gr.html#ga987d5dd36f179192721c03df37d93e87">ARM_ETH_PHY_Read_t</a> fn_read, <a class="el" href="group__eth__phy__interface__gr.html#gaf690fde16281b25f2ffa07f9c4e8e240">ARM_ETH_PHY_Write_t</a> fn_write)</td>
 271         </tr>
 272       </table>
 273 </div><div class="memdoc">
 274
 275 <p>Pointer to <a class="el" href="group__eth__phy__interface__gr.html#gacf2332a7fa2d84694b8e5f0838135589">ARM_ETH_PHY_Initialize</a> : Initialize PHY Device. </p>
 276
 277 </div>
 278 </div>
 279 <a id="a5ce2b3d7a3a07099bf07d1eb253e92e3" name="a5ce2b3d7a3a07099bf07d1eb253e92e3"></a>
 280 <h2 class="memtitle"><span class="permalink"><a href="#a5ce2b3d7a3a07099bf07d1eb253e92e3">&#9670;&#160;</a></span>Uninitialize</h2>
 281
 282 <div class="memitem">
 283 <div class="memproto">
 284       <table class="memname">
 285         <tr>
 286           <td class="memname">int32_t(* Uninitialize) (void)</td>
 287         </tr>
 288       </table>
 289 </div><div class="memdoc">
 290
 291 <p>Pointer to <a class="el" href="group__eth__phy__interface__gr.html#ga26ea7e1e9825b959284241ebff6eea3f">ARM_ETH_PHY_Uninitialize</a> : De-initialize PHY Device. </p>
 292
 293 </div>
 294 </div>
 295 <a id="a24ebae5c6011631f76027f9a16eaf5ce" name="a24ebae5c6011631f76027f9a16eaf5ce"></a>
 296 <h2 class="memtitle"><span class="permalink"><a href="#a24ebae5c6011631f76027f9a16eaf5ce">&#9670;&#160;</a></span>PowerControl</h2>
 297
 298 <div class="memitem">
 299 <div class="memproto">
 300       <table class="memname">
 301         <tr>
 302           <td class="memname">int32_t(* PowerControl) (<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td>
 303         </tr>
 304       </table>
 305 </div><div class="memdoc">
 306
 307 <p>Pointer to <a class="el" href="group__eth__phy__interface__gr.html#gaba0f92561754dad8f8f03feb1cf2855e">ARM_ETH_PHY_PowerControl</a> : Control PHY Device Power. </p>
 308
 309 </div>
 310 </div>
 311 <a id="a9d26ef49db500c351debea73257d2dcf" name="a9d26ef49db500c351debea73257d2dcf"></a>
 312 <h2 class="memtitle"><span class="permalink"><a href="#a9d26ef49db500c351debea73257d2dcf">&#9670;&#160;</a></span>SetInterface</h2>
 313
 314 <div class="memitem">
 315 <div class="memproto">
 316       <table class="memname">
 317         <tr>
 318           <td class="memname">int32_t(* SetInterface) (uint32_t interface)</td>
 319         </tr>
 320       </table>
 321 </div><div class="memdoc">
 322
 323 <p>Pointer to <a class="el" href="group__eth__phy__interface__gr.html#gaedd8b5650a1259d572a1f303d3e2c01c">ARM_ETH_PHY_SetInterface</a> : Set Ethernet Media Interface. </p>
 324
 325 </div>
 326 </div>
 327 <a id="a1ed7a1889ba8d4cd2ff02791a18b19db" name="a1ed7a1889ba8d4cd2ff02791a18b19db"></a>
 328 <h2 class="memtitle"><span class="permalink"><a href="#a1ed7a1889ba8d4cd2ff02791a18b19db">&#9670;&#160;</a></span>SetMode</h2>
 329
 330 <div class="memitem">
 331 <div class="memproto">
 332       <table class="memname">
 333         <tr>
 334           <td class="memname">int32_t(* SetMode) (uint32_t mode)</td>
 335         </tr>
 336       </table>
 337 </div><div class="memdoc">
 338
 339 <p>Pointer to <a class="el" href="group__eth__phy__interface__gr.html#ga9aa688c951f01ed9ca7c88cf51be8a09">ARM_ETH_PHY_SetMode</a> : Set Ethernet PHY Device Operation mode. </p>
 340
 341 </div>
 342 </div>
 343 <a id="ad3ed7f0f95328d4a0224e44b04ad0163" name="ad3ed7f0f95328d4a0224e44b04ad0163"></a>
 344 <h2 class="memtitle"><span class="permalink"><a href="#ad3ed7f0f95328d4a0224e44b04ad0163">&#9670;&#160;</a></span>GetLinkState</h2>
 345
 346 <div class="memitem">
 347 <div class="memproto">
 348       <table class="memname">
 349         <tr>
 350           <td class="memname"><a class="el" href="group__eth__interface__gr.html#gacf7db5320eb841b462a4af3c56cc9291">ARM_ETH_LINK_STATE</a>(* GetLinkState) (void)</td>
 351         </tr>
 352       </table>
 353 </div><div class="memdoc">
 354
 355 <p>Pointer to <a class="el" href="group__eth__phy__interface__gr.html#ga4085cd24ebe33b78d51a3c003da4a5ba">ARM_ETH_PHY_GetLinkState</a> : Get Ethernet PHY Device Link state. </p>
 356
 357 </div>
 358 </div>
 359 <a id="a8e20e8e50e3acaa52c8c9039b1e4d281" name="a8e20e8e50e3acaa52c8c9039b1e4d281"></a>
 360 <h2 class="memtitle"><span class="permalink"><a href="#a8e20e8e50e3acaa52c8c9039b1e4d281">&#9670;&#160;</a></span>GetLinkInfo</h2>
 361
 362 <div class="memitem">
 363 <div class="memproto">
 364       <table class="memname">
 365         <tr>
 366           <td class="memname"><a class="el" href="group__eth__interface__gr.html#structARM__ETH__LINK__INFO">ARM_ETH_LINK_INFO</a>(* GetLinkInfo) (void)</td>
 367         </tr>
 368       </table>
 369 </div><div class="memdoc">
 370
 371 <p>Pointer to <a class="el" href="group__eth__phy__interface__gr.html#ga8c79dcd7a12656403f3befab3c8605a2">ARM_ETH_PHY_GetLinkInfo</a> : Get Ethernet PHY Device Link information. </p>
 372
 373 </div>
 374 </div>
 375
 376 </div>
 377 </div>
 378 <h2 class="groupheader">Typedef Documentation</h2>
 379 <a id="ga987d5dd36f179192721c03df37d93e87" name="ga987d5dd36f179192721c03df37d93e87"></a>
 380 <h2 class="memtitle"><span class="permalink"><a href="#ga987d5dd36f179192721c03df37d93e87">&#9670;&#160;</a></span>ARM_ETH_PHY_Read_t</h2>
 381
 382 <div class="memitem">
 383 <div class="memproto">
 384       <table class="memname">
 385         <tr>
 386           <td class="memname">ARM_ETH_PHY_Read_t</td>
 387         </tr>
 388       </table>
 389 </div><div class="memdoc">
 390
 391 <p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gaded29ad58366e9222487db9944373c29">ARM_ETH_MAC_PHY_Read</a> : Read Ethernet PHY Register. </p>
 392 <p>Provides the typedef for the register read function <a class="el" href="group__eth__mac__interface__gr.html#gaded29ad58366e9222487db9944373c29">ARM_ETH_MAC_PHY_Read</a>.</p>
 393 <p><b>Parameter for:</b></p><ul>
 394 <li><a class="el" href="group__eth__phy__interface__gr.html#gacf2332a7fa2d84694b8e5f0838135589">ARM_ETH_PHY_Initialize</a> </li>
 395 </ul>
 396
 397 </div>
 398 </div>
 399 <a id="gaf690fde16281b25f2ffa07f9c4e8e240" name="gaf690fde16281b25f2ffa07f9c4e8e240"></a>
 400 <h2 class="memtitle"><span class="permalink"><a href="#gaf690fde16281b25f2ffa07f9c4e8e240">&#9670;&#160;</a></span>ARM_ETH_PHY_Write_t</h2>
 401
 402 <div class="memitem">
 403 <div class="memproto">
 404       <table class="memname">
 405         <tr>
 406           <td class="memname">ARM_ETH_PHY_Write_t</td>
 407         </tr>
 408       </table>
 409 </div><div class="memdoc">
 410
 411 <p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga79dd38672749aeebd28f39d9b4f813ce">ARM_ETH_MAC_PHY_Write</a> : Write Ethernet PHY Register. </p>
 412 <p>Provides the typedef for the register write function <a class="el" href="group__eth__mac__interface__gr.html#ga79dd38672749aeebd28f39d9b4f813ce">ARM_ETH_MAC_PHY_Write</a>.</p>
 413 <p><b>Parameter for:</b></p><ul>
 414 <li><a class="el" href="group__eth__phy__interface__gr.html#gacf2332a7fa2d84694b8e5f0838135589">ARM_ETH_PHY_Initialize</a> </li>
 415 </ul>
 416
 417 </div>
 418 </div>
 419 <h2 class="groupheader">Function Documentation</h2>
 420 <a id="ga6850d33d699d9deee4e983a2c99e9734" name="ga6850d33d699d9deee4e983a2c99e9734"></a>
 421 <h2 class="memtitle"><span class="permalink"><a href="#ga6850d33d699d9deee4e983a2c99e9734">&#9670;&#160;</a></span>ARM_ETH_PHY_GetVersion()</h2>
 422
 423 <div class="memitem">
 424 <div class="memproto">
 425       <table class="memname">
 426         <tr>
 427           <td class="memname"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> ARM_ETH_PHY_GetVersion </td>
 428           <td>(</td>
 429           <td class="paramtype">void&#160;</td>
 430           <td class="paramname"></td><td>)</td>
 431           <td></td>
 432         </tr>
 433       </table>
 434 </div><div class="memdoc">
 435
 436 <p>Get driver version. </p>
 437 <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>
 438 <p>The function <b>ARM_ETH_PHY_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>
 439 <li>API version is the version of the CMSIS-Driver specification used to implement this driver.</li>
 440 <li>Driver version is source code version of the actual driver implementation.</li>
 441 </ul>
 442 <p>Example: </p><div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code hl_struct" href="group__eth__phy__interface__gr.html#structARM__DRIVER__ETH__PHY">ARM_DRIVER_ETH_PHY</a> Driver_ETH_PHY0;</div>
 443 <div class="line"><a class="code hl_struct" href="group__eth__phy__interface__gr.html#structARM__DRIVER__ETH__PHY">ARM_DRIVER_ETH_PHY</a> *drv_info;</div>
 444 <div class="line"> </div>
 445 <div class="line"><span class="keywordtype">void</span> setup_ethernet_phy (<span class="keywordtype">void</span>)  {</div>
 446 <div class="line">  <a class="code hl_struct" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>  version;</div>
 447 <div class="line"> </div>
 448 <div class="line">  drv_info = &amp;Driver_ETH_PHY0;  </div>
 449 <div class="line">  version = drv_info-&gt;<a class="code hl_variable" href="group__eth__phy__interface__gr.html#a30afd9cb3113c037b5f1926f5ef93b59">GetVersion</a> ();</div>
 450 <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>
 451 <div class="line">    <span class="comment">// error handling</span></div>
 452 <div class="line">    <span class="keywordflow">return</span>;</div>
 453 <div class="line">  }</div>
 454 <div class="line">}</div>
 455 <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>
 456 <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>
 457 <div class="ttc" id="agroup__eth__phy__interface__gr_html_a30afd9cb3113c037b5f1926f5ef93b59"><div class="ttname"><a href="group__eth__phy__interface__gr.html#a30afd9cb3113c037b5f1926f5ef93b59">ARM_DRIVER_ETH_PHY::GetVersion</a></div><div class="ttdeci">ARM_DRIVER_VERSION(* GetVersion)(void)</div><div class="ttdoc">Pointer to ARM_ETH_PHY_GetVersion : Get driver version.</div><div class="ttdef"><b>Definition:</b> Driver_ETH_PHY.h:128</div></div>
 458 <div class="ttc" id="agroup__eth__phy__interface__gr_html_structARM__DRIVER__ETH__PHY"><div class="ttname"><a href="group__eth__phy__interface__gr.html#structARM__DRIVER__ETH__PHY">ARM_DRIVER_ETH_PHY</a></div><div class="ttdoc">Access structure of the Ethernet PHY Driver.</div><div class="ttdef"><b>Definition:</b> Driver_ETH_PHY.h:127</div></div>
 459 </div><!-- fragment -->
 460 </div>
 461 </div>
 462 <a id="gacf2332a7fa2d84694b8e5f0838135589" name="gacf2332a7fa2d84694b8e5f0838135589"></a>
 463 <h2 class="memtitle"><span class="permalink"><a href="#gacf2332a7fa2d84694b8e5f0838135589">&#9670;&#160;</a></span>ARM_ETH_PHY_Initialize()</h2>
 464
 465 <div class="memitem">
 466 <div class="memproto">
 467       <table class="memname">
 468         <tr>
 469           <td class="memname">int32_t ARM_ETH_PHY_Initialize </td>
 470           <td>(</td>
 471           <td class="paramtype"><a class="el" href="group__eth__phy__interface__gr.html#ga987d5dd36f179192721c03df37d93e87">ARM_ETH_PHY_Read_t</a>&#160;</td>
 472           <td class="paramname"><em>fn_read</em>, </td>
 473         </tr>
 474         <tr>
 475           <td class="paramkey"></td>
 476           <td></td>
 477           <td class="paramtype"><a class="el" href="group__eth__phy__interface__gr.html#gaf690fde16281b25f2ffa07f9c4e8e240">ARM_ETH_PHY_Write_t</a>&#160;</td>
 478           <td class="paramname"><em>fn_write</em>&#160;</td>
 479         </tr>
 480         <tr>
 481           <td></td>
 482           <td>)</td>
 483           <td></td><td></td>
 484         </tr>
 485       </table>
 486 </div><div class="memdoc">
 487
 488 <p>Initialize Ethernet PHY Device. </p>
 489 <dl class="params"><dt>Parameters</dt><dd>
 490   <table class="params">
 491     <tr><td class="paramdir">[in]</td><td class="paramname">fn_read</td><td>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gaded29ad58366e9222487db9944373c29">ARM_ETH_MAC_PHY_Read</a> </td></tr>
 492     <tr><td class="paramdir">[in]</td><td class="paramname">fn_write</td><td>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga79dd38672749aeebd28f39d9b4f813ce">ARM_ETH_MAC_PHY_Write</a> </td></tr>
 493   </table>
 494   </dd>
 495 </dl>
 496 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
 497 <p>The function <b>ARM_ETH_PHY_Initialize</b> initializes the Ethernet PHY interface. It is called when the middleware component starts operation.</p>
 498 <p>The <a class="el" href="group__eth__phy__interface__gr.html#gacf2332a7fa2d84694b8e5f0838135589">ARM_ETH_PHY_Initialize</a> function performs the following operations:</p><ul>
 499 <li>Initializes the resources needed for Ethernet PHY peripheral.</li>
 500 <li>Registers the <a class="el" href="group__eth__mac__interface__gr.html#gaded29ad58366e9222487db9944373c29">ARM_ETH_MAC_PHY_Read</a> register read access function.</li>
 501 <li>Registers the <a class="el" href="group__eth__mac__interface__gr.html#ga79dd38672749aeebd28f39d9b4f813ce">ARM_ETH_MAC_PHY_Write</a> register write access function.</li>
 502 </ul>
 503 <p><b>Example:</b> </p><ul>
 504 <li>see <a class="el" href="group__eth__interface__gr.html">Ethernet Interface</a> - Driver Functions </li>
 505 </ul>
 506
 507 </div>
 508 </div>
 509 <a id="ga26ea7e1e9825b959284241ebff6eea3f" name="ga26ea7e1e9825b959284241ebff6eea3f"></a>
 510 <h2 class="memtitle"><span class="permalink"><a href="#ga26ea7e1e9825b959284241ebff6eea3f">&#9670;&#160;</a></span>ARM_ETH_PHY_Uninitialize()</h2>
 511
 512 <div class="memitem">
 513 <div class="memproto">
 514       <table class="memname">
 515         <tr>
 516           <td class="memname">int32_t ARM_ETH_PHY_Uninitialize </td>
 517           <td>(</td>
 518           <td class="paramtype">void&#160;</td>
 519           <td class="paramname"></td><td>)</td>
 520           <td></td>
 521         </tr>
 522       </table>
 523 </div><div class="memdoc">
 524
 525 <p>De-initialize Ethernet PHY Device. </p>
 526 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
 527 <p>The function <b>ARM_ETH_PHY_Uninitialize</b> de-initializes the resources of Ethernet PHY interface.</p>
 528 <p>It is called when the middleware component stops operation and releases the software resources used by the interface. </p>
 529
 530 </div>
 531 </div>
 532 <a id="gaba0f92561754dad8f8f03feb1cf2855e" name="gaba0f92561754dad8f8f03feb1cf2855e"></a>
 533 <h2 class="memtitle"><span class="permalink"><a href="#gaba0f92561754dad8f8f03feb1cf2855e">&#9670;&#160;</a></span>ARM_ETH_PHY_PowerControl()</h2>
 534
 535 <div class="memitem">
 536 <div class="memproto">
 537       <table class="memname">
 538         <tr>
 539           <td class="memname">int32_t ARM_ETH_PHY_PowerControl </td>
 540           <td>(</td>
 541           <td class="paramtype"><a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a>&#160;</td>
 542           <td class="paramname"><em>state</em></td><td>)</td>
 543           <td></td>
 544         </tr>
 545       </table>
 546 </div><div class="memdoc">
 547
 548 <p>Control Ethernet PHY Device Power. </p>
 549 <dl class="params"><dt>Parameters</dt><dd>
 550   <table class="params">
 551     <tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>Power state </td></tr>
 552   </table>
 553   </dd>
 554 </dl>
 555 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
 556 <p><br  />
 557  The function <b>ARM_ETH_PHY_PowerControl</b> operates the power modes of the Ethernet PHY interface. <br  />
 558 </p>
 559 <p>The parameter <em>state</em> sets the operation and can have the following values:</p><ul>
 560 <li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a> : set-up peripheral for data transfers, enable interrupts (NVIC) and optionally DMA. Can be called multiple times. If the peripheral is already in this mode the function performs no operation and returns with <a class="el" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>.</li>
 561 <li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5a9ef9e57cbcc948d0e22314e73dc8c434">ARM_POWER_LOW</a> : may use power saving. Returns <a class="el" href="group__execution__status.html#ga2efa59e480d82697795439220e6884e4">ARM_DRIVER_ERROR_UNSUPPORTED</a> when not implemented.</li>
 562 <li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5ab6f5becc85ebd51c3dd2524a95d2ca35">ARM_POWER_OFF</a> : terminates any pending data transfers, disables peripheral, disables related interrupts and DMA.</li>
 563 </ul>
 564 <p>Refer to <a class="el" href="theoryOperation.html#CallSequence">Function Call Sequence</a> for more information.</p>
 565 <p><b>Example:</b> </p><ul>
 566 <li>see <a class="el" href="group__eth__interface__gr.html">Ethernet Interface</a> - Driver Functions </li>
 567 </ul>
 568
 569 </div>
 570 </div>
 571 <a id="gaedd8b5650a1259d572a1f303d3e2c01c" name="gaedd8b5650a1259d572a1f303d3e2c01c"></a>
 572 <h2 class="memtitle"><span class="permalink"><a href="#gaedd8b5650a1259d572a1f303d3e2c01c">&#9670;&#160;</a></span>ARM_ETH_PHY_SetInterface()</h2>
 573
 574 <div class="memitem">
 575 <div class="memproto">
 576       <table class="memname">
 577         <tr>
 578           <td class="memname">int32_t ARM_ETH_PHY_SetInterface </td>
 579           <td>(</td>
 580           <td class="paramtype">uint32_t&#160;</td>
 581           <td class="paramname"><em>interface</em></td><td>)</td>
 582           <td></td>
 583         </tr>
 584       </table>
 585 </div><div class="memdoc">
 586
 587 <p>Set Ethernet Media Interface. </p>
 588 <dl class="params"><dt>Parameters</dt><dd>
 589   <table class="params">
 590     <tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>Media Interface type </td></tr>
 591   </table>
 592   </dd>
 593 </dl>
 594 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
 595 <p>The function <b>ARM_ETH_PHY_SetInterface</b> specifies the <a class="el" href="group__eth__interface__types1.html">Media Interface Types</a> that links the Ethernet MAC and Ethernet PHY. After initialization of the PHY interface, you can set the media type. The function <a class="el" href="group__eth__mac__interface__gr.html#ga2b13b230502736d8c7679b359dff20d0">ARM_ETH_MAC_GetCapabilities</a> retrieves the media interface type encoded in the data field <b>media_interface</b> of the structure <a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES">ARM_ETH_MAC_CAPABILITIES</a>.</p>
 596 <p>The parameter <em>interface</em> can have the following values:</p>
 597 <table class="markdownTable">
 598 <tr class="markdownTableHead">
 599 <th class="markdownTableHeadLeft">Parameter <em>interface</em>   </th><th class="markdownTableHeadLeft">Media Type    </th></tr>
 600 <tr class="markdownTableRowOdd">
 601 <td class="markdownTableBodyLeft"><a class="el" href="group__eth__interface__types1.html#ga468c848ddf75d7925130171af1ec2ac7">ARM_ETH_INTERFACE_MII</a>   </td><td class="markdownTableBodyLeft">Media Independent Interface (MII)    </td></tr>
 602 <tr class="markdownTableRowEven">
 603 <td class="markdownTableBodyLeft"><a class="el" href="group__eth__interface__types1.html#gac0361b34fbec9c19840ad0349e4c388b">ARM_ETH_INTERFACE_RMII</a>   </td><td class="markdownTableBodyLeft">Reduced Media Independent Interface (RMII)    </td></tr>
 604 <tr class="markdownTableRowOdd">
 605 <td class="markdownTableBodyLeft"><a class="el" href="group__eth__interface__types1.html#ga24047d142be48bbc241e8d6eacb5cf7a">ARM_ETH_INTERFACE_SMII</a>   </td><td class="markdownTableBodyLeft">Serial Media Independent Interface (SMII);   </td></tr>
 606 </table>
 607 <dl class="section note"><dt>Note</dt><dd>Some <em>interface</em> values may be unsupported by a driver implementation. For example <a class="el" href="group__eth__interface__types1.html#ga24047d142be48bbc241e8d6eacb5cf7a">ARM_ETH_INTERFACE_SMII</a> may return <b>ARM_DRIVER_ERROR_UNSUPPORTED</b>.</dd></dl>
 608 <p><b>Example:</b> </p><div class="fragment"><div class="line"><span class="keyword">static</span> <a class="code hl_struct" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES">ARM_ETH_MAC_CAPABILITIES</a> capabilities;</div>
 609 <div class="line"><span class="keyword">static</span> <a class="code hl_struct" href="group__eth__mac__interface__gr.html#structARM__DRIVER__ETH__MAC">ARM_DRIVER_ETH_MAC</a> *mac;</div>
 610 <div class="line"><span class="keyword">static</span> <a class="code hl_struct" href="group__eth__phy__interface__gr.html#structARM__DRIVER__ETH__PHY">ARM_DRIVER_ETH_PHY</a> *phy;</div>
 611 <div class="line"> </div>
 612 <div class="line">mac = &amp;Driver_ETH_MAC0;</div>
 613 <div class="line">phy = &amp;Driver_ETH_PHY0;</div>
 614 <div class="line"> </div>
 615 <div class="line"><span class="comment">// Initialize Media Access Controller</span></div>
 616 <div class="line">capabilities = mac-&gt;<a class="code hl_variable" href="group__eth__mac__interface__gr.html#a738cc36f2a26e9737578feed6a2b6371">GetCapabilities</a> ();</div>
 617 <div class="line">...</div>
 618 <div class="line">status = phy-&gt;<a class="code hl_variable" href="group__eth__phy__interface__gr.html#a9d26ef49db500c351debea73257d2dcf">SetInterface</a> (capabilities.<a class="code hl_variable" href="group__eth__mac__interface__gr.html#a3c5cb74e086417a01d0079f847a3fc8d">media_interface</a>);</div>
 619 <div class="line"><span class="keywordflow">if</span> (status != <a class="code hl_define" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) ...  <span class="comment">// error handling</span></div>
 620 <div class="line">status = phy-&gt;<a class="code hl_variable" href="group__eth__phy__interface__gr.html#a1ed7a1889ba8d4cd2ff02791a18b19db">SetMode</a> (<a class="code hl_define" href="group__eth__phy__mode__ctrls.html#ga6a8c54f8fed3e5f68bd04eb715d10ab9">ARM_ETH_PHY_AUTO_NEGOTIATE</a>);</div>
 621 <div class="line"><span class="keywordflow">if</span> (status != <a class="code hl_define" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) ...  <span class="comment">// error handling</span></div>
 622 <div class="line">...</div>
 623 <div class="ttc" id="agroup__eth__mac__interface__gr_html_a3c5cb74e086417a01d0079f847a3fc8d"><div class="ttname"><a href="group__eth__mac__interface__gr.html#a3c5cb74e086417a01d0079f847a3fc8d">ARM_ETH_MAC_CAPABILITIES::media_interface</a></div><div class="ttdeci">uint32_t media_interface</div><div class="ttdoc">Ethernet Media Interface type.</div><div class="ttdef"><b>Definition:</b> Driver_ETH_MAC.h:273</div></div>
 624 <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>
 625 <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>
 626 <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>
 627 <div class="ttc" id="agroup__eth__phy__interface__gr_html_a1ed7a1889ba8d4cd2ff02791a18b19db"><div class="ttname"><a href="group__eth__phy__interface__gr.html#a1ed7a1889ba8d4cd2ff02791a18b19db">ARM_DRIVER_ETH_PHY::SetMode</a></div><div class="ttdeci">int32_t(* SetMode)(uint32_t mode)</div><div class="ttdoc">Pointer to ARM_ETH_PHY_SetMode : Set Ethernet PHY Device Operation mode.</div><div class="ttdef"><b>Definition:</b> Driver_ETH_PHY.h:134</div></div>
 628 <div class="ttc" id="agroup__eth__phy__interface__gr_html_a9d26ef49db500c351debea73257d2dcf"><div class="ttname"><a href="group__eth__phy__interface__gr.html#a9d26ef49db500c351debea73257d2dcf">ARM_DRIVER_ETH_PHY::SetInterface</a></div><div class="ttdeci">int32_t(* SetInterface)(uint32_t interface)</div><div class="ttdoc">Pointer to ARM_ETH_PHY_SetInterface : Set Ethernet Media Interface.</div><div class="ttdef"><b>Definition:</b> Driver_ETH_PHY.h:133</div></div>
 629 <div class="ttc" id="agroup__eth__phy__mode__ctrls_html_ga6a8c54f8fed3e5f68bd04eb715d10ab9"><div class="ttname"><a href="group__eth__phy__mode__ctrls.html#ga6a8c54f8fed3e5f68bd04eb715d10ab9">ARM_ETH_PHY_AUTO_NEGOTIATE</a></div><div class="ttdeci">#define ARM_ETH_PHY_AUTO_NEGOTIATE</div><div class="ttdoc">Auto Negotiation mode.</div></div>
 630 <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>
 631 </div><!-- fragment -->
 632 </div>
 633 </div>
 634 <a id="ga9aa688c951f01ed9ca7c88cf51be8a09" name="ga9aa688c951f01ed9ca7c88cf51be8a09"></a>
 635 <h2 class="memtitle"><span class="permalink"><a href="#ga9aa688c951f01ed9ca7c88cf51be8a09">&#9670;&#160;</a></span>ARM_ETH_PHY_SetMode()</h2>
 636
 637 <div class="memitem">
 638 <div class="memproto">
 639       <table class="memname">
 640         <tr>
 641           <td class="memname">int32_t ARM_ETH_PHY_SetMode </td>
 642           <td>(</td>
 643           <td class="paramtype">uint32_t&#160;</td>
 644           <td class="paramname"><em>mode</em></td><td>)</td>
 645           <td></td>
 646         </tr>
 647       </table>
 648 </div><div class="memdoc">
 649
 650 <p>Set Ethernet PHY Device Operation mode. </p>
 651 <dl class="params"><dt>Parameters</dt><dd>
 652   <table class="params">
 653     <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>Operation Mode </td></tr>
 654   </table>
 655   </dd>
 656 </dl>
 657 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
 658 <p>The function <b>ARM_ETH_PHY_SetMode</b> sets the operation mode parameters for the Ethernet PHY.</p>
 659 <p>The table below lists the possible values for the parameter <em>mode</em>. Values from different categories can be ORed as shown in this example code:</p>
 660 <div class="fragment"><div class="line">phy-&gt;SetMode (<a class="code hl_define" href="group__eth__phy__mode__ctrls.html#gad1e8b2c8c210fa36949db9a34a993657">ARM_ETH_PHY_SPEED_100M</a> | <a class="code hl_define" href="group__eth__phy__mode__ctrls.html#ga5f7e46cda8ab3c774fe7ce0a8a1ba3ec">ARM_ETH_PHY_LOOPBACK</a> | <a class="code hl_define" href="group__eth__phy__mode__ctrls.html#gace797b3cd143be22f47c3ef61b20e14d">ARM_ETH_PHY_DUPLEX_HALF</a> );</div>
 661 <div class="ttc" id="agroup__eth__phy__mode__ctrls_html_ga5f7e46cda8ab3c774fe7ce0a8a1ba3ec"><div class="ttname"><a href="group__eth__phy__mode__ctrls.html#ga5f7e46cda8ab3c774fe7ce0a8a1ba3ec">ARM_ETH_PHY_LOOPBACK</a></div><div class="ttdeci">#define ARM_ETH_PHY_LOOPBACK</div><div class="ttdoc">Loop-back test mode.</div></div>
 662 <div class="ttc" id="agroup__eth__phy__mode__ctrls_html_gace797b3cd143be22f47c3ef61b20e14d"><div class="ttname"><a href="group__eth__phy__mode__ctrls.html#gace797b3cd143be22f47c3ef61b20e14d">ARM_ETH_PHY_DUPLEX_HALF</a></div><div class="ttdeci">#define ARM_ETH_PHY_DUPLEX_HALF</div><div class="ttdoc">Half duplex link.</div></div>
 663 <div class="ttc" id="agroup__eth__phy__mode__ctrls_html_gad1e8b2c8c210fa36949db9a34a993657"><div class="ttname"><a href="group__eth__phy__mode__ctrls.html#gad1e8b2c8c210fa36949db9a34a993657">ARM_ETH_PHY_SPEED_100M</a></div><div class="ttdeci">#define ARM_ETH_PHY_SPEED_100M</div><div class="ttdoc">100 Mbps link speed</div></div>
 664 </div><!-- fragment --><p> <br  />
 665  </p><table class="cmtable">
 666 <tr>
 667 <th>Parameter <em>mode</em> </th><th>bit </th><th>Category  </th><th>Description </th></tr>
 668 <tr>
 669 <td><a class="el" href="group__eth__phy__mode__ctrls.html#gabc7acc4ebe828c3d0825400e14ad20f0">ARM_ETH_PHY_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>
 670 <tr>
 671 <td><a class="el" href="group__eth__phy__mode__ctrls.html#gad1e8b2c8c210fa36949db9a34a993657">ARM_ETH_PHY_SPEED_100M</a>  </td><td>Set the link speed to <span class="XML-Token">100 [Mbps]</span>  </td></tr>
 672 <tr>
 673 <td><a class="el" href="group__eth__phy__mode__ctrls.html#ga046605398ceae99a176e6f82432ae710">ARM_ETH_PHY_SPEED_1G</a>  </td><td>Set the link speed to <span class="XML-Token">1 [Gbps]</span>  </td></tr>
 674 <tr>
 675 <td><a class="el" href="group__eth__phy__mode__ctrls.html#gace797b3cd143be22f47c3ef61b20e14d">ARM_ETH_PHY_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>
 676 <tr>
 677 <td><a class="el" href="group__eth__phy__mode__ctrls.html#ga5d06a94867c89cd311b6e279669321e3">ARM_ETH_PHY_DUPLEX_FULL</a>  </td><td>Set the link mode to full duplex  </td></tr>
 678 <tr>
 679 <td><a class="el" href="group__eth__phy__mode__ctrls.html#ga6a8c54f8fed3e5f68bd04eb715d10ab9">ARM_ETH_PHY_AUTO_NEGOTIATE</a> </td><td>3 </td><td>Autonegotiation  </td><td>Set the interface to Auto Negotiation mode of transmission parameters </td></tr>
 680 <tr>
 681 <td><a class="el" href="group__eth__phy__mode__ctrls.html#ga5f7e46cda8ab3c774fe7ce0a8a1ba3ec">ARM_ETH_PHY_LOOPBACK</a> </td><td>4 </td><td>Loopback  </td><td>Set the interface into a Loop-back test mode  </td></tr>
 682 <tr>
 683 <td><a class="el" href="group__eth__phy__mode__ctrls.html#ga8d68719e07c7af449b57c5df802376c8">ARM_ETH_PHY_ISOLATE</a> </td><td>5 </td><td>Isolation  </td><td>Set to indicate electrical isolation of PHY interface from MII/RMII interface </td></tr>
 684 </table>
 685 <dl class="section note"><dt>Note</dt><dd>Some settings may be also taken from configuration pins (example <a class="el" href="group__eth__phy__mode__ctrls.html#ga8d68719e07c7af449b57c5df802376c8">ARM_ETH_PHY_ISOLATE</a>). Check the effect of mode settings in the actual driver implementation. </dd>
 686 <dd>
 687 Some <em>mode</em> values may be unsupported by a driver implementation. For example <a class="el" href="group__eth__phy__mode__ctrls.html#ga046605398ceae99a176e6f82432ae710">ARM_ETH_PHY_SPEED_1G</a> may return <b>ARM_DRIVER_ERROR_UNSUPPORTED</b>.</dd></dl>
 688 <p><b>Example:</b> </p><div class="fragment"><div class="line"><span class="keyword">static</span> <a class="code hl_struct" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES">ARM_ETH_MAC_CAPABILITIES</a> capabilities;</div>
 689 <div class="line"><span class="keyword">static</span> <a class="code hl_struct" href="group__eth__mac__interface__gr.html#structARM__DRIVER__ETH__MAC">ARM_DRIVER_ETH_MAC</a> *mac;</div>
 690 <div class="line"><span class="keyword">static</span> <a class="code hl_struct" href="group__eth__phy__interface__gr.html#structARM__DRIVER__ETH__PHY">ARM_DRIVER_ETH_PHY</a> *phy;</div>
 691 <div class="line"> </div>
 692 <div class="line">mac = &amp;Driver_ETH_MAC0;</div>
 693 <div class="line">phy = &amp;Driver_ETH_PHY0;</div>
 694 <div class="line"> </div>
 695 <div class="line"><span class="comment">// Initialize Media Access Controller</span></div>
 696 <div class="line">capabilities = mac-&gt;<a class="code hl_variable" href="group__eth__mac__interface__gr.html#a738cc36f2a26e9737578feed6a2b6371">GetCapabilities</a> ();</div>
 697 <div class="line">...</div>
 698 <div class="line">status = phy-&gt;<a class="code hl_variable" href="group__eth__phy__interface__gr.html#a9d26ef49db500c351debea73257d2dcf">SetInterface</a> (capabilities.<a class="code hl_variable" href="group__eth__mac__interface__gr.html#a3c5cb74e086417a01d0079f847a3fc8d">media_interface</a>);</div>
 699 <div class="line"><span class="keywordflow">if</span> (status != <a class="code hl_define" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) ...  <span class="comment">// error handling</span></div>
 700 <div class="line">status = phy-&gt;<a class="code hl_variable" href="group__eth__phy__interface__gr.html#a1ed7a1889ba8d4cd2ff02791a18b19db">SetMode</a> (<a class="code hl_define" href="group__eth__phy__mode__ctrls.html#gad1e8b2c8c210fa36949db9a34a993657">ARM_ETH_PHY_SPEED_100M</a> | <a class="code hl_define" href="group__eth__phy__mode__ctrls.html#ga5d06a94867c89cd311b6e279669321e3">ARM_ETH_PHY_DUPLEX_FULL</a> | <a class="code hl_define" href="group__eth__phy__mode__ctrls.html#ga8d68719e07c7af449b57c5df802376c8">ARM_ETH_PHY_ISOLATE</a>);</div>
 701 <div class="line"><span class="keywordflow">if</span> (status != <a class="code hl_define" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) ...  <span class="comment">// error handling</span></div>
 702 <div class="line">...</div>
 703 <div class="ttc" id="agroup__eth__phy__mode__ctrls_html_ga5d06a94867c89cd311b6e279669321e3"><div class="ttname"><a href="group__eth__phy__mode__ctrls.html#ga5d06a94867c89cd311b6e279669321e3">ARM_ETH_PHY_DUPLEX_FULL</a></div><div class="ttdeci">#define ARM_ETH_PHY_DUPLEX_FULL</div><div class="ttdoc">Full duplex link.</div></div>
 704 <div class="ttc" id="agroup__eth__phy__mode__ctrls_html_ga8d68719e07c7af449b57c5df802376c8"><div class="ttname"><a href="group__eth__phy__mode__ctrls.html#ga8d68719e07c7af449b57c5df802376c8">ARM_ETH_PHY_ISOLATE</a></div><div class="ttdeci">#define ARM_ETH_PHY_ISOLATE</div><div class="ttdoc">Isolate PHY from MII/RMII interface.</div></div>
 705 </div><!-- fragment -->
 706 </div>
 707 </div>
 708 <a id="ga4085cd24ebe33b78d51a3c003da4a5ba" name="ga4085cd24ebe33b78d51a3c003da4a5ba"></a>
 709 <h2 class="memtitle"><span class="permalink"><a href="#ga4085cd24ebe33b78d51a3c003da4a5ba">&#9670;&#160;</a></span>ARM_ETH_PHY_GetLinkState()</h2>
 710
 711 <div class="memitem">
 712 <div class="memproto">
 713       <table class="memname">
 714         <tr>
 715           <td class="memname"><a class="el" href="group__eth__interface__gr.html#gacf7db5320eb841b462a4af3c56cc9291">ARM_ETH_LINK_STATE</a> ARM_ETH_PHY_GetLinkState </td>
 716           <td>(</td>
 717           <td class="paramtype">void&#160;</td>
 718           <td class="paramname"></td><td>)</td>
 719           <td></td>
 720         </tr>
 721       </table>
 722 </div><div class="memdoc">
 723
 724 <p>Get Ethernet PHY Device Link state. </p>
 725 <dl class="section return"><dt>Returns</dt><dd>current link status <a class="el" href="group__eth__interface__gr.html#gacf7db5320eb841b462a4af3c56cc9291">ARM_ETH_LINK_STATE</a></dd></dl>
 726 <p>The function <b>ARM_ETH_PHY_GetLinkState</b> retrieves the connection status of the physical Ethernet link.</p>
 727 <p><b>Example:</b> </p><ul>
 728 <li>see <a class="el" href="group__eth__interface__gr.html">Ethernet Interface</a> - Driver Functions </li>
 729 </ul>
 730
 731 </div>
 732 </div>
 733 <a id="ga8c79dcd7a12656403f3befab3c8605a2" name="ga8c79dcd7a12656403f3befab3c8605a2"></a>
 734 <h2 class="memtitle"><span class="permalink"><a href="#ga8c79dcd7a12656403f3befab3c8605a2">&#9670;&#160;</a></span>ARM_ETH_PHY_GetLinkInfo()</h2>
 735
 736 <div class="memitem">
 737 <div class="memproto">
 738       <table class="memname">
 739         <tr>
 740           <td class="memname"><a class="el" href="group__eth__interface__gr.html#structARM__ETH__LINK__INFO">ARM_ETH_LINK_INFO</a> ARM_ETH_PHY_GetLinkInfo </td>
 741           <td>(</td>
 742           <td class="paramtype">void&#160;</td>
 743           <td class="paramname"></td><td>)</td>
 744           <td></td>
 745         </tr>
 746       </table>
 747 </div><div class="memdoc">
 748
 749 <p>Get Ethernet PHY Device Link information. </p>
 750 <dl class="section return"><dt>Returns</dt><dd>current link parameters <a class="el" href="group__eth__interface__gr.html#structARM__ETH__LINK__INFO">ARM_ETH_LINK_INFO</a></dd></dl>
 751 <p>The function <b>ARM_ETH_PHY_GetLinkInfo</b> retrieves information about the current established communication mode (half/full duplex) and communication speed. Information is only valid when link is up (see <a class="el" href="group__eth__phy__interface__gr.html#ga4085cd24ebe33b78d51a3c003da4a5ba">ARM_ETH_PHY_GetLinkState</a>).</p>
 752 <p><b>Example:</b> </p><ul>
 753 <li>see <a class="el" href="group__eth__interface__gr.html">Ethernet Interface</a> - Driver Functions </li>
 754 </ul>
 755
 756 </div>
 757 </div>
 758 </div><!-- contents -->
 759 </div><!-- doc-content -->
 760 <!-- start footer part -->
 761 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 762   <ul>
 763     <li class="footer">
 764       <script type="text/javascript">
 765         <!--
 766         writeFooter.call(this);
 767         //-->
 768       </script>
 769     </li>
 770   </ul>
 771 </div>
 772 </body>
 773 </html>