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