netease
/
esp8266-std
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
esp8266-std/ESP8266_RTOS_SDK/documents/html/esp__misc_8h_source.html

186 lines
20 KiB
HTML
Raw Normal View History

Init Projects
2018-11-23 01:43:17 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>ESP8266_RTOS_SDK: include/espressif/esp_misc.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ESP8266_RTOS_SDK
&#160;<span id="projectnumber">v1.4.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_cf4dbf1328d2cf10d3f3933741525dc7.html">espressif</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">esp_misc.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * ESPRSSIF MIT License</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Copyright (c) 2015 &lt;ESPRESSIF SYSTEMS (SHANGHAI) PTE LTD&gt;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * Permission is hereby granted for use on ESPRESSIF SYSTEMS ESP8266 only, in which case,</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * it is free of charge, to any person obtaining a copy of this software and associated</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * documentation files (the &quot;Software&quot;), to deal in the Software without restriction, including</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * and/or sell copies of the Software, and to permit persons to whom the Software is furnished</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * to do so, subject to the following conditions:</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * The above copyright notice and this permission notice shall be included in all copies or</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * substantial portions of the Software.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"> * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"> * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#ifndef __ESP_MISC_H__</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#define __ESP_MISC_H__</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &quot;lwip/ip_addr.h&quot;</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#define MAC2STR(a) (a)[0], (a)[1], (a)[2], (a)[3], (a)[4], (a)[5]</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor">#define MACSTR &quot;%02x:%02x:%02x:%02x:%02x:%02x&quot;</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="preprocessor">#define IP2STR(ipaddr) ip4_addr1_16(ipaddr), \</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor"> ip4_addr2_16(ipaddr), \</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor"> ip4_addr3_16(ipaddr), \</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="preprocessor"> ip4_addr4_16(ipaddr)</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="preprocessor">#define IPSTR &quot;%d.%d.%d.%d&quot;</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__Misc__APIs.html#ga34cbc249ab7d5737df5cbff540535f9f">os_delay_us</a>(uint16 us);</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__Misc__APIs.html#ga1e58a0af820fa16197c614872b2d4eaa">os_install_putc1</a>(<span class="keywordtype">void</span> (*p)(<span class="keywordtype">char</span> c));</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__Misc__APIs.html#ga279c08566a8fb3910dff740c106cd26a">os_putc</a>(<span class="keywordtype">char</span> c);</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;</div>
<div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="group__Misc__APIs.html#ga9e40444d24f71f875b15136edec8fc47"> 83</a></span>&#160;<span class="keyword">enum</span> <a class="code" href="group__Misc__APIs.html#ga9e40444d24f71f875b15136edec8fc47">dhcp_status</a> {</div>
<div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="group__Misc__APIs.html#gga9e40444d24f71f875b15136edec8fc47a7c9cbdc204a9ed4b2a46cec8daeacfb8"> 84</a></span>&#160; <a class="code" href="group__Misc__APIs.html#gga9e40444d24f71f875b15136edec8fc47a7c9cbdc204a9ed4b2a46cec8daeacfb8">DHCP_STOPPED</a>, </div>
<div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="group__Misc__APIs.html#gga9e40444d24f71f875b15136edec8fc47af861d0338581584e3be0abd10af2d0ff"> 85</a></span>&#160; <a class="code" href="group__Misc__APIs.html#gga9e40444d24f71f875b15136edec8fc47af861d0338581584e3be0abd10af2d0ff">DHCP_STARTED</a> </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;};</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;</div>
<div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="structdhcps__lease.html"> 88</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structdhcps__lease.html">dhcps_lease</a> {</div>
<div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="structdhcps__lease.html#ac842b6c1dcb3b1f11b611620199dc55c"> 89</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="structdhcps__lease.html#ac842b6c1dcb3b1f11b611620199dc55c">enable</a>; </div>
<div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="structdhcps__lease.html#ad1290ecd3f8204d196999369712a586e"> 90</a></span>&#160; <span class="keyword">struct </span>ip_addr <a class="code" href="structdhcps__lease.html#ad1290ecd3f8204d196999369712a586e">start_ip</a>; </div>
<div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="structdhcps__lease.html#a2ecbf3162350cb32b51fcf7e0562dc84"> 91</a></span>&#160; <span class="keyword">struct </span>ip_addr <a class="code" href="structdhcps__lease.html#a2ecbf3162350cb32b51fcf7e0562dc84">end_ip</a>; </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;};</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;</div>
<div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="group__Misc__APIs.html#ga47797d528afd74db93dd37a2c9207333"> 94</a></span>&#160;<span class="keyword">enum</span> <a class="code" href="group__Misc__APIs.html#ga47797d528afd74db93dd37a2c9207333">dhcps_offer_option</a> {</div>
<div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="group__Misc__APIs.html#gga47797d528afd74db93dd37a2c9207333a8d64153b2be4f126695bb7f6d36cff2c"> 95</a></span>&#160; <a class="code" href="group__Misc__APIs.html#gga47797d528afd74db93dd37a2c9207333a8d64153b2be4f126695bb7f6d36cff2c">OFFER_START</a> = 0x00, </div>
<div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="group__Misc__APIs.html#gga47797d528afd74db93dd37a2c9207333ad88e6ec93eb09e1cccb8d4d039681f42"> 96</a></span>&#160; <a class="code" href="group__Misc__APIs.html#gga47797d528afd74db93dd37a2c9207333ad88e6ec93eb09e1cccb8d4d039681f42">OFFER_ROUTER</a> = 0x01, </div>
<div class="line"><a name="l00097"></a><span class="lineno"><a class="line" href="group__Misc__APIs.html#gga47797d528afd74db93dd37a2c9207333ab67ba95f9dcf33d1cd600d798c76ab88"> 97</a></span>&#160; <a class="code" href="group__Misc__APIs.html#gga47797d528afd74db93dd37a2c9207333ab67ba95f9dcf33d1cd600d798c76ab88">OFFER_END</a> </div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;};</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;}</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="group__Misc__APIs_html_ga279c08566a8fb3910dff740c106cd26a"><div class="ttname"><a href="group__Misc__APIs.html#ga279c08566a8fb3910dff740c106cd26a">os_putc</a></div><div class="ttdeci">void os_putc(char c)</div><div class="ttdoc">Print a character. Start from from UART0 by default. </div></div>
<div class="ttc" id="structdhcps__lease_html"><div class="ttname"><a href="structdhcps__lease.html">dhcps_lease</a></div><div class="ttdef"><b>Definition:</b> esp_misc.h:88</div></div>
<div class="ttc" id="group__Misc__APIs_html_gga47797d528afd74db93dd37a2c9207333ad88e6ec93eb09e1cccb8d4d039681f42"><div class="ttname"><a href="group__Misc__APIs.html#gga47797d528afd74db93dd37a2c9207333ad88e6ec93eb09e1cccb8d4d039681f42">OFFER_ROUTER</a></div><div class="ttdef"><b>Definition:</b> esp_misc.h:96</div></div>
<div class="ttc" id="structdhcps__lease_html_ac842b6c1dcb3b1f11b611620199dc55c"><div class="ttname"><a href="structdhcps__lease.html#ac842b6c1dcb3b1f11b611620199dc55c">dhcps_lease::enable</a></div><div class="ttdeci">bool enable</div><div class="ttdef"><b>Definition:</b> esp_misc.h:89</div></div>
<div class="ttc" id="group__Misc__APIs_html_gga47797d528afd74db93dd37a2c9207333ab67ba95f9dcf33d1cd600d798c76ab88"><div class="ttname"><a href="group__Misc__APIs.html#gga47797d528afd74db93dd37a2c9207333ab67ba95f9dcf33d1cd600d798c76ab88">OFFER_END</a></div><div class="ttdef"><b>Definition:</b> esp_misc.h:97</div></div>
<div class="ttc" id="group__Misc__APIs_html_gga9e40444d24f71f875b15136edec8fc47a7c9cbdc204a9ed4b2a46cec8daeacfb8"><div class="ttname"><a href="group__Misc__APIs.html#gga9e40444d24f71f875b15136edec8fc47a7c9cbdc204a9ed4b2a46cec8daeacfb8">DHCP_STOPPED</a></div><div class="ttdef"><b>Definition:</b> esp_misc.h:84</div></div>
<div class="ttc" id="structdhcps__lease_html_a2ecbf3162350cb32b51fcf7e0562dc84"><div class="ttname"><a href="structdhcps__lease.html#a2ecbf3162350cb32b51fcf7e0562dc84">dhcps_lease::end_ip</a></div><div class="ttdeci">struct ip_addr end_ip</div><div class="ttdef"><b>Definition:</b> esp_misc.h:91</div></div>
<div class="ttc" id="structdhcps__lease_html_ad1290ecd3f8204d196999369712a586e"><div class="ttname"><a href="structdhcps__lease.html#ad1290ecd3f8204d196999369712a586e">dhcps_lease::start_ip</a></div><div class="ttdeci">struct ip_addr start_ip</div><div class="ttdef"><b>Definition:</b> esp_misc.h:90</div></div>
<div class="ttc" id="group__Misc__APIs_html_ga9e40444d24f71f875b15136edec8fc47"><div class="ttname"><a href="group__Misc__APIs.html#ga9e40444d24f71f875b15136edec8fc47">dhcp_status</a></div><div class="ttdeci">dhcp_status</div><div class="ttdef"><b>Definition:</b> esp_misc.h:83</div></div>
<div class="ttc" id="group__Misc__APIs_html_gga9e40444d24f71f875b15136edec8fc47af861d0338581584e3be0abd10af2d0ff"><div class="ttname"><a href="group__Misc__APIs.html#gga9e40444d24f71f875b15136edec8fc47af861d0338581584e3be0abd10af2d0ff">DHCP_STARTED</a></div><div class="ttdef"><b>Definition:</b> esp_misc.h:85</div></div>
<div class="ttc" id="group__Misc__APIs_html_gga47797d528afd74db93dd37a2c9207333a8d64153b2be4f126695bb7f6d36cff2c"><div class="ttname"><a href="group__Misc__APIs.html#gga47797d528afd74db93dd37a2c9207333a8d64153b2be4f126695bb7f6d36cff2c">OFFER_START</a></div><div class="ttdef"><b>Definition:</b> esp_misc.h:95</div></div>
<div class="ttc" id="group__Misc__APIs_html_ga34cbc249ab7d5737df5cbff540535f9f"><div class="ttname"><a href="group__Misc__APIs.html#ga34cbc249ab7d5737df5cbff540535f9f">os_delay_us</a></div><div class="ttdeci">void os_delay_us(uint16 us)</div><div class="ttdoc">Delay function, maximum value: 65535 us. </div></div>
<div class="ttc" id="group__Misc__APIs_html_ga47797d528afd74db93dd37a2c9207333"><div class="ttname"><a href="group__Misc__APIs.html#ga47797d528afd74db93dd37a2c9207333">dhcps_offer_option</a></div><div class="ttdeci">dhcps_offer_option</div><div class="ttdef"><b>Definition:</b> esp_misc.h:94</div></div>
<div class="ttc" id="group__Misc__APIs_html_ga1e58a0af820fa16197c614872b2d4eaa"><div class="ttname"><a href="group__Misc__APIs.html#ga1e58a0af820fa16197c614872b2d4eaa">os_install_putc1</a></div><div class="ttdeci">void os_install_putc1(void(*p)(char c))</div><div class="ttdoc">Register the print output function. </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Mar 1 2016 10:19:26 for ESP8266_RTOS_SDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address>
</body>
</html>