]> Git Repo - pico-vscode.git/blob - web/docs/cc_8h_source.html
Merge pull request #41 from paulober/sdk-docs
[pico-vscode.git] / web / docs / cc_8h_source.html
1 <!-- HTML header for doxygen 1.8.20-->
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">
4 <head>
5         <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6         <meta http-equiv="X-UA-Compatible" content="IE=9"/>
7         <meta name="generator" content="Doxygen 1.9.4"/>
8         <meta name="viewport" content="width=device-width, initial-scale=1"/>
9         <title>Raspberry Pi Pico SDK: pico_lwip/include/arch/cc.h Source File</title>
10         <!-- <link href="tabs.css" rel="stylesheet" type="text/css"/> -->
11         <script type="text/javascript" src="jquery.js"></script>
12         <script type="text/javascript" src="dynsections.js"></script>
13         <link href="navtree.css" rel="stylesheet" type="text/css"/>
14 <script type="text/javascript" src="resize.js"></script>
15 <script type="text/javascript" src="navtreedata.js"></script>
16 <script type="text/javascript" src="navtree.js"></script>
17         <link href="search/search.css" rel="stylesheet" type="text/css"/>
18 <script type="text/javascript" src="search/searchdata.js"></script>
19 <script type="text/javascript" src="search/search.js"></script>
20     <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet">
21         <link href="doxygen.css" rel="stylesheet" type="text/css" />
22         <link href="normalise.css" rel="stylesheet" type="text/css"/>
23 <link href="main.css" rel="stylesheet" type="text/css"/>
24 <link href="styles.css" rel="stylesheet" type="text/css"/>
25 </head>
26 <body>
27         <div class="navigation-mobile">
28                 <div class="logo--mobile">
29                         <a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a>
30                 </div>
31                 <div class="navigation-toggle">
32                         <span class="line-1"></span>
33                         <span class="line-2">
34                                 <p>Menu Toggle</p>
35                         </span>
36                         <span class="line-3"></span>
37                 </div>
38         </div>
39         <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
40                 <div class="logo">
41                         <a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
42                         <span style="display: inline-block; margin-top: 10px;">
43                                 v1.5.1
44                         </span>
45                 </div>
46                 <div class="navigation-footer">
47                         <img src="logo-mobile.svg" alt="Raspberry Pi">
48                         <a href="https://www.raspberrypi.com/" target="_blank">By Raspberry Pi Ltd</a>
49                 </div>
50 <!--            <div class="search">
51                         <form>
52                                 <input type="search" name="search" id="search" placeholder="Search">
53                                 <input type="submit" value="Search">
54                         </form>
55                 </div> -->
56 <!-- Generated by Doxygen 1.9.4 -->
57 <script type="text/javascript">
58 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
59 var searchBox = new SearchBox("searchBox", "search",'Search','.html');
60 /* @license-end */
61 </script>
62 <script type="text/javascript" src="menudata.js"></script>
63 <script type="text/javascript" src="menu.js"></script>
64 <script type="text/javascript">
65 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
66 $(function() {
67   initMenu('',true,false,'search.php','Search');
68   $(document).ready(function() { init_search(); });
69 });
70 /* @license-end */
71 </script>
72 <div id="main-nav"></div>
73 </div><!-- top -->
74 <div id="side-nav" class="ui-resizable side-nav-resizable">
75   <div id="nav-tree">
76     <div id="nav-tree-contents">
77       <div id="nav-sync" class="sync"></div>
78     </div>
79   </div>
80   <div id="splitbar" style="-moz-user-select:none;" 
81        class="ui-resizable-handle">
82   </div>
83 </div>
84 <script type="text/javascript">
85 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
86 $(document).ready(function(){initNavTree('cc_8h_source.html',''); initResizable(); });
87 /* @license-end */
88 </script>
89 <div id="doc-content">
90 <!-- window showing the filter options -->
91 <div id="MSearchSelectWindow"
92      onmouseover="return searchBox.OnSearchSelectShow()"
93      onmouseout="return searchBox.OnSearchSelectHide()"
94      onkeydown="return searchBox.OnSearchSelectKey(event)">
95 </div>
96
97 <!-- iframe showing the search results (closed by default) -->
98 <div id="MSearchResultsWindow">
99 <iframe src="javascript:void(0)" frameborder="0" 
100         name="MSearchResults" id="MSearchResults">
101 </iframe>
102 </div>
103
104 <div class="header">
105   <div class="headertitle"><div class="title">cc.h</div></div>
106 </div><!--header-->
107 <div class="contents">
108 <div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/*</span></div>
109 <div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright (c) 2001-2003 Swedish Institute of Computer Science.</span></div>
110 <div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> * All rights reserved.</span></div>
111 <div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> *</span></div>
112 <div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * Redistribution and use in source and binary forms, with or without modification,</span></div>
113 <div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * are permitted provided that the following conditions are met:</span></div>
114 <div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> *</span></div>
115 <div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> * 1. Redistributions of source code must retain the above copyright notice,</span></div>
116 <div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *    this list of conditions and the following disclaimer.</span></div>
117 <div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright notice,</span></div>
118 <div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> *    this list of conditions and the following disclaimer in the documentation</span></div>
119 <div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> *    and/or other materials provided with the distribution.</span></div>
120 <div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * 3. The name of the author may not be used to endorse or promote products</span></div>
121 <div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> *    derived from this software without specific prior written permission.</span></div>
122 <div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> *</span></div>
123 <div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS&#39;&#39; AND ANY EXPRESS OR IMPLIED</span></div>
124 <div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"> * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF</span></div>
125 <div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment"> * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT</span></div>
126 <div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"> * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</span></div>
127 <div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="comment"> * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT</span></div>
128 <div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="comment"> * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span></div>
129 <div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</span></div>
130 <div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING</span></div>
131 <div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="comment"> * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY</span></div>
132 <div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="comment"> * OF SUCH DAMAGE.</span></div>
133 <div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="comment"> *</span></div>
134 <div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="comment"> * This file is part of the lwIP TCP/IP stack.</span></div>
135 <div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="comment"> *</span></div>
136 <div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="comment"> * Author: Adam Dunkels &lt;[email protected]&gt;</span></div>
137 <div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment"> *</span></div>
138 <div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment"> */</span></div>
139 <div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="preprocessor">#ifndef __CC_H__</span></div>
140 <div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="preprocessor">#define __CC_H__</span></div>
141 <div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span> </div>
142 <div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="preprocessor">#include &lt;sys/time.h&gt;</span></div>
143 <div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span> </div>
144 <div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="preprocessor">#ifndef PICO_LWIP_CUSTOM_LOCK_TCPIP_CORE</span></div>
145 <div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="preprocessor">#define PICO_LWIP_CUSTOM_LOCK_TCPIP_CORE 1</span></div>
146 <div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="preprocessor">#endif</span></div>
147 <div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span> </div>
148 <div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="preprocessor">#if NO_SYS</span></div>
149 <div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment">// todo really we should just not allow SYS_LIGHTWEIGHT_PROT for nosys mode (it doesn&#39;t do anything anyway)</span></div>
150 <div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="keyword">typedef</span> <span class="keywordtype">int</span> sys_prot_t;</div>
151 <div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="preprocessor">#elif PICO_LWIP_CUSTOM_LOCK_TCPIP_CORE</span></div>
152 <div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="keywordtype">void</span> pico_lwip_custom_lock_tcpip_core(<span class="keywordtype">void</span>);</div>
153 <div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="keywordtype">void</span> pico_lwip_custom_unlock_tcpip_core(<span class="keywordtype">void</span>);</div>
154 <div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="preprocessor">#define LOCK_TCPIP_CORE() pico_lwip_custom_lock_tcpip_core()</span></div>
155 <div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="preprocessor">#define UNLOCK_TCPIP_CORE() pico_lwip_custom_unlock_tcpip_core()</span></div>
156 <div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="preprocessor">#endif</span></div>
157 <div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span> </div>
158 <div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment">/* define compiler specific symbols */</span></div>
159 <div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="preprocessor">#if defined (__ICCARM__)</span></div>
160 <div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span> </div>
161 <div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="preprocessor">#define PACK_STRUCT_BEGIN</span></div>
162 <div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="preprocessor">#define PACK_STRUCT_STRUCT</span></div>
163 <div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="preprocessor">#define PACK_STRUCT_END</span></div>
164 <div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="preprocessor">#define PACK_STRUCT_FIELD(x) x</span></div>
165 <div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="preprocessor">#define PACK_STRUCT_USE_INCLUDES</span></div>
166 <div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span> </div>
167 <div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="preprocessor">#elif defined (__CC_ARM)</span></div>
168 <div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span> </div>
169 <div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="preprocessor">#define PACK_STRUCT_BEGIN __packed</span></div>
170 <div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="preprocessor">#define PACK_STRUCT_STRUCT</span></div>
171 <div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="preprocessor">#define PACK_STRUCT_END</span></div>
172 <div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="preprocessor">#define PACK_STRUCT_FIELD(x) x</span></div>
173 <div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span> </div>
174 <div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="preprocessor">#elif defined (__GNUC__)</span></div>
175 <div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span> </div>
176 <div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="preprocessor">#define PACK_STRUCT_BEGIN</span></div>
177 <div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="preprocessor">#define PACK_STRUCT_STRUCT __attribute__ ((__packed__))</span></div>
178 <div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="preprocessor">#define PACK_STRUCT_END</span></div>
179 <div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="preprocessor">#define PACK_STRUCT_FIELD(x) x</span></div>
180 <div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span> </div>
181 <div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="preprocessor">#elif defined (__TASKING__)</span></div>
182 <div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span> </div>
183 <div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="preprocessor">#define PACK_STRUCT_BEGIN</span></div>
184 <div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="preprocessor">#define PACK_STRUCT_STRUCT</span></div>
185 <div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="preprocessor">#define PACK_STRUCT_END</span></div>
186 <div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="preprocessor">#define PACK_STRUCT_FIELD(x) x</span></div>
187 <div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span> </div>
188 <div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="preprocessor">#endif</span></div>
189 <div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span> </div>
190 <div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="preprocessor">#ifndef LWIP_PLATFORM_ASSERT</span></div>
191 <div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="preprocessor">#include &quot;<a class="code" href="pico_8h.html">pico.h</a>&quot;</span></div>
192 <div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="preprocessor">#define LWIP_PLATFORM_ASSERT(x) panic(x)</span></div>
193 <div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="preprocessor">#endif</span></div>
194 <div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span> </div>
195 <div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="preprocessor">#ifndef LWIP_RAND</span></div>
196 <div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="preprocessor">#include &quot;<a class="code" href="rand_8h.html">pico/rand.h</a>&quot;</span></div>
197 <div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment">// Use the pico_rand library which goes to reasonable lengths to try to provide good entropy</span></div>
198 <div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="preprocessor">#define LWIP_RAND() get_rand_32()</span></div>
199 <div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="preprocessor">#endif</span></div>
200 <div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="preprocessor">#endif </span><span class="comment">/* __CC_H__ */</span><span class="preprocessor"></span></div>
201 <div class="ttc" id="apico_8h_html"><div class="ttname"><a href="pico_8h.html">pico.h</a></div></div>
202 <div class="ttc" id="arand_8h_html"><div class="ttname"><a href="rand_8h.html">rand.h</a></div></div>
203 </div><!-- fragment --></div><!-- contents -->
204 </div><!-- doc-content -->
205
206         <script src="main.js"></script>
207 </body>
208 </html>
This page took 0.044292 seconds and 4 git commands to generate.