]> begriffs open source - cmsis/blob - main/Driver/html/Driver__ETH_8h.html
Update documentation for branch main
[cmsis] / main / Driver / html / Driver__ETH_8h.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: Driver_ETH.h File Reference</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('Driver__ETH_8h.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="#nested-classes">Data Structures</a> &#124;
132 <a href="#define-members">Macros</a> &#124;
133 <a href="#enum-members">Enumerations</a>  </div>
134   <div class="headertitle"><div class="title">Driver_ETH.h File Reference</div></div>
135 </div><!--header-->
136 <div class="contents">
137 <table class="memberdecls">
138 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
139 Data Structures</h2></td></tr>
140 <tr class="memitem:structARM__ETH__LINK__INFO"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__interface__gr.html#structARM__ETH__LINK__INFO">ARM_ETH_LINK_INFO</a></td></tr>
141 <tr class="memdesc:structARM__ETH__LINK__INFO"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ethernet link information.  <a href="group__eth__interface__gr.html#structARM__ETH__LINK__INFO">More...</a><br /></td></tr>
142 <tr class="separator:structARM__ETH__LINK__INFO"><td class="memSeparator" colspan="2">&#160;</td></tr>
143 <tr class="memitem:structARM__ETH__MAC__ADDR"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">ARM_ETH_MAC_ADDR</a></td></tr>
144 <tr class="memdesc:structARM__ETH__MAC__ADDR"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ethernet MAC Address.  <a href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">More...</a><br /></td></tr>
145 <tr class="separator:structARM__ETH__MAC__ADDR"><td class="memSeparator" colspan="2">&#160;</td></tr>
146 </table><table class="memberdecls">
147 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
148 Macros</h2></td></tr>
149 <tr class="memitem:ga468c848ddf75d7925130171af1ec2ac7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__interface__types1.html#ga468c848ddf75d7925130171af1ec2ac7">ARM_ETH_INTERFACE_MII</a>&#160;&#160;&#160;(0U)</td></tr>
150 <tr class="memdesc:ga468c848ddf75d7925130171af1ec2ac7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ethernet Media Interface type.  <br /></td></tr>
151 <tr class="separator:ga468c848ddf75d7925130171af1ec2ac7"><td class="memSeparator" colspan="2">&#160;</td></tr>
152 <tr class="memitem:gac0361b34fbec9c19840ad0349e4c388b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__interface__types1.html#gac0361b34fbec9c19840ad0349e4c388b">ARM_ETH_INTERFACE_RMII</a>&#160;&#160;&#160;(1U)</td></tr>
153 <tr class="memdesc:gac0361b34fbec9c19840ad0349e4c388b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reduced Media Independent Interface (RMII)  <br /></td></tr>
154 <tr class="separator:gac0361b34fbec9c19840ad0349e4c388b"><td class="memSeparator" colspan="2">&#160;</td></tr>
155 <tr class="memitem:ga24047d142be48bbc241e8d6eacb5cf7a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__interface__types1.html#ga24047d142be48bbc241e8d6eacb5cf7a">ARM_ETH_INTERFACE_SMII</a>&#160;&#160;&#160;(2U)</td></tr>
156 <tr class="memdesc:ga24047d142be48bbc241e8d6eacb5cf7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serial Media Independent Interface (SMII)  <br /></td></tr>
157 <tr class="separator:ga24047d142be48bbc241e8d6eacb5cf7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
158 <tr class="memitem:a1f834c4c785d7f69b1eaca011ee298ec"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__ETH_8h.html#a1f834c4c785d7f69b1eaca011ee298ec">ARM_ETH_SPEED_10M</a>&#160;&#160;&#160;(0U)</td></tr>
159 <tr class="memdesc:a1f834c4c785d7f69b1eaca011ee298ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ethernet link speed.  <br /></td></tr>
160 <tr class="separator:a1f834c4c785d7f69b1eaca011ee298ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
161 <tr class="memitem:a3bddfc4cf5645f8568d9cb6621fd606a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__ETH_8h.html#a3bddfc4cf5645f8568d9cb6621fd606a">ARM_ETH_SPEED_100M</a>&#160;&#160;&#160;(1U)</td></tr>
162 <tr class="memdesc:a3bddfc4cf5645f8568d9cb6621fd606a"><td class="mdescLeft">&#160;</td><td class="mdescRight">100 Mbps link speed  <br /></td></tr>
163 <tr class="separator:a3bddfc4cf5645f8568d9cb6621fd606a"><td class="memSeparator" colspan="2">&#160;</td></tr>
164 <tr class="memitem:a218f470079b7c04de6776d467a53772a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__ETH_8h.html#a218f470079b7c04de6776d467a53772a">ARM_ETH_SPEED_1G</a>&#160;&#160;&#160;(2U)</td></tr>
165 <tr class="memdesc:a218f470079b7c04de6776d467a53772a"><td class="mdescLeft">&#160;</td><td class="mdescRight">1 Gpbs link speed  <br /></td></tr>
166 <tr class="separator:a218f470079b7c04de6776d467a53772a"><td class="memSeparator" colspan="2">&#160;</td></tr>
167 <tr class="memitem:acb15afc2bfe61c56049b7279d6eae8fe"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__ETH_8h.html#acb15afc2bfe61c56049b7279d6eae8fe">ARM_ETH_DUPLEX_HALF</a>&#160;&#160;&#160;(0U)</td></tr>
168 <tr class="memdesc:acb15afc2bfe61c56049b7279d6eae8fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ethernet duplex mode.  <br /></td></tr>
169 <tr class="separator:acb15afc2bfe61c56049b7279d6eae8fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
170 <tr class="memitem:a7848c83cd1fd6b2645c17919c2990354"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__ETH_8h.html#a7848c83cd1fd6b2645c17919c2990354">ARM_ETH_DUPLEX_FULL</a>&#160;&#160;&#160;(1U)</td></tr>
171 <tr class="memdesc:a7848c83cd1fd6b2645c17919c2990354"><td class="mdescLeft">&#160;</td><td class="mdescRight">Full duplex link.  <br /></td></tr>
172 <tr class="separator:a7848c83cd1fd6b2645c17919c2990354"><td class="memSeparator" colspan="2">&#160;</td></tr>
173 </table><table class="memberdecls">
174 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
175 Enumerations</h2></td></tr>
176 <tr class="memitem:gacf7db5320eb841b462a4af3c56cc9291"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__interface__gr.html#gacf7db5320eb841b462a4af3c56cc9291">ARM_ETH_LINK_STATE</a> { <br />
177 &#160;&#160;<a class="el" href="group__eth__interface__gr.html#gacf7db5320eb841b462a4af3c56cc9291a5f635c9352db6cb6fa9ad95660850487">ARM_ETH_LINK_DOWN</a>
178 , <br />
179 &#160;&#160;<a class="el" href="group__eth__interface__gr.html#gacf7db5320eb841b462a4af3c56cc9291ab5e5b02c3c8a5a0fefcf69f3be7e31c1">ARM_ETH_LINK_UP</a>
180 <br />
181  }</td></tr>
182 <tr class="memdesc:gacf7db5320eb841b462a4af3c56cc9291"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ethernet link state.  <a href="group__eth__interface__gr.html#gacf7db5320eb841b462a4af3c56cc9291">More...</a><br /></td></tr>
183 <tr class="separator:gacf7db5320eb841b462a4af3c56cc9291"><td class="memSeparator" colspan="2">&#160;</td></tr>
184 </table>
185 <h2 class="groupheader">Macro Definition Documentation</h2>
186 <a id="a1f834c4c785d7f69b1eaca011ee298ec" name="a1f834c4c785d7f69b1eaca011ee298ec"></a>
187 <h2 class="memtitle"><span class="permalink"><a href="#a1f834c4c785d7f69b1eaca011ee298ec">&#9670;&#160;</a></span>ARM_ETH_SPEED_10M</h2>
188
189 <div class="memitem">
190 <div class="memproto">
191       <table class="memname">
192         <tr>
193           <td class="memname">#define ARM_ETH_SPEED_10M&#160;&#160;&#160;(0U)</td>
194         </tr>
195       </table>
196 </div><div class="memdoc">
197
198 <p>Ethernet link speed. </p>
199 <p>10 Mbps link speed </p>
200
201 </div>
202 </div>
203 <a id="a3bddfc4cf5645f8568d9cb6621fd606a" name="a3bddfc4cf5645f8568d9cb6621fd606a"></a>
204 <h2 class="memtitle"><span class="permalink"><a href="#a3bddfc4cf5645f8568d9cb6621fd606a">&#9670;&#160;</a></span>ARM_ETH_SPEED_100M</h2>
205
206 <div class="memitem">
207 <div class="memproto">
208       <table class="memname">
209         <tr>
210           <td class="memname">#define ARM_ETH_SPEED_100M&#160;&#160;&#160;(1U)</td>
211         </tr>
212       </table>
213 </div><div class="memdoc">
214
215 <p>100 Mbps link speed </p>
216
217 </div>
218 </div>
219 <a id="a218f470079b7c04de6776d467a53772a" name="a218f470079b7c04de6776d467a53772a"></a>
220 <h2 class="memtitle"><span class="permalink"><a href="#a218f470079b7c04de6776d467a53772a">&#9670;&#160;</a></span>ARM_ETH_SPEED_1G</h2>
221
222 <div class="memitem">
223 <div class="memproto">
224       <table class="memname">
225         <tr>
226           <td class="memname">#define ARM_ETH_SPEED_1G&#160;&#160;&#160;(2U)</td>
227         </tr>
228       </table>
229 </div><div class="memdoc">
230
231 <p>1 Gpbs link speed </p>
232
233 </div>
234 </div>
235 <a id="acb15afc2bfe61c56049b7279d6eae8fe" name="acb15afc2bfe61c56049b7279d6eae8fe"></a>
236 <h2 class="memtitle"><span class="permalink"><a href="#acb15afc2bfe61c56049b7279d6eae8fe">&#9670;&#160;</a></span>ARM_ETH_DUPLEX_HALF</h2>
237
238 <div class="memitem">
239 <div class="memproto">
240       <table class="memname">
241         <tr>
242           <td class="memname">#define ARM_ETH_DUPLEX_HALF&#160;&#160;&#160;(0U)</td>
243         </tr>
244       </table>
245 </div><div class="memdoc">
246
247 <p>Ethernet duplex mode. </p>
248 <p>Half duplex link </p>
249
250 </div>
251 </div>
252 <a id="a7848c83cd1fd6b2645c17919c2990354" name="a7848c83cd1fd6b2645c17919c2990354"></a>
253 <h2 class="memtitle"><span class="permalink"><a href="#a7848c83cd1fd6b2645c17919c2990354">&#9670;&#160;</a></span>ARM_ETH_DUPLEX_FULL</h2>
254
255 <div class="memitem">
256 <div class="memproto">
257       <table class="memname">
258         <tr>
259           <td class="memname">#define ARM_ETH_DUPLEX_FULL&#160;&#160;&#160;(1U)</td>
260         </tr>
261       </table>
262 </div><div class="memdoc">
263
264 <p>Full duplex link. </p>
265
266 </div>
267 </div>
268 </div><!-- contents -->
269 </div><!-- doc-content -->
270 <!-- start footer part -->
271 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
272   <ul>
273     <li class="navelem"><a class="el" href="dir_7151b3cc910409bb744bd274374c738d.html">Driver</a></li><li class="navelem"><a class="el" href="dir_9c39448ea46a8e15f1aabc7dec307fcf.html">Include</a></li><li class="navelem"><a class="el" href="Driver__ETH_8h.html">Driver_ETH.h</a></li>
274     <li class="footer">
275       <script type="text/javascript">
276         <!--
277         writeFooter.call(this);
278         //-->
279       </script> 
280     </li>
281   </ul>
282 </div>
283 </body>
284 </html>