gnuk/ChibiOS_2.0.8/docs/html/chheap_8h_source.html

142 lines
14 KiB
HTML
Raw Normal View History

2010-08-10 03:11:02 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>ChibiOS/RT: chheap.h Source File</title>
<link href="custom.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<table style="text-align: center; width: 100%;" border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="width: 80px;"><img alt="ChibiOS/RT Logo" src="logo_small.png"></td>
<td><big><big>ChibiOS/RT</big></big><br><br>Architecture - Reference Manual - Guides</td>
<td style="width: 80px;"></td>
</tr>
</tbody>
</table>
<hr size="1">
2010-11-22 05:53:37 +00:00
<!-- Generated by Doxygen 1.7.1 -->
2010-08-10 03:11:02 +00:00
<div class="navigation" id="top">
<div class="tabs">
2010-11-22 05:53:37 +00:00
<ul class="tablist">
2010-08-10 03:11:02 +00:00
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
2010-11-22 05:53:37 +00:00
<div class="tabs2">
<ul class="tablist">
2010-08-10 03:11:02 +00:00
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
2010-11-22 05:53:37 +00:00
<div class="header">
<div class="headertitle">
<h1>chheap.h</h1> </div>
</div>
<div class="contents">
<a href="chheap_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
2010-08-10 03:11:02 +00:00
<a name="l00002"></a>00002 <span class="comment"> ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010 Giovanni Di Sirio.</span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment"> This file is part of ChibiOS/RT.</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment"> ChibiOS/RT is free software; you can redistribute it and/or modify</span>
<a name="l00007"></a>00007 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
<a name="l00008"></a>00008 <span class="comment"> the Free Software Foundation; either version 3 of the License, or</span>
<a name="l00009"></a>00009 <span class="comment"> (at your option) any later version.</span>
<a name="l00010"></a>00010 <span class="comment"></span>
<a name="l00011"></a>00011 <span class="comment"> ChibiOS/RT is distributed in the hope that it will be useful,</span>
<a name="l00012"></a>00012 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00013"></a>00013 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00014"></a>00014 <span class="comment"> GNU General Public License for more details.</span>
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment"> You should have received a copy of the GNU General Public License</span>
<a name="l00017"></a>00017 <span class="comment"> along with this program. If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
<a name="l00018"></a>00018 <span class="comment"></span>
<a name="l00019"></a>00019 <span class="comment"> ---</span>
<a name="l00020"></a>00020 <span class="comment"></span>
<a name="l00021"></a>00021 <span class="comment"> A special exception to the GPL can be applied should you wish to distribute</span>
<a name="l00022"></a>00022 <span class="comment"> a combined work that includes ChibiOS/RT, without being obliged to provide</span>
<a name="l00023"></a>00023 <span class="comment"> the source code for any proprietary components. See the file exception.txt</span>
<a name="l00024"></a>00024 <span class="comment"> for full details of how and when the exception can be applied.</span>
<a name="l00025"></a>00025 <span class="comment">*/</span>
<a name="l00026"></a>00026 <span class="comment"></span>
<a name="l00027"></a>00027 <span class="comment">/**</span>
<a name="l00028"></a>00028 <span class="comment"> * @file chheap.h</span>
<a name="l00029"></a>00029 <span class="comment"> * @brief Heaps macros and structures.</span>
<a name="l00030"></a>00030 <span class="comment"> *</span>
<a name="l00031"></a>00031 <span class="comment"> * @addtogroup heaps</span>
<a name="l00032"></a>00032 <span class="comment"> * @{</span>
<a name="l00033"></a>00033 <span class="comment"> */</span>
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="preprocessor">#ifndef _CHHEAP_H_</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#define _CHHEAP_H_</span>
<a name="l00037"></a>00037 <span class="preprocessor"></span>
<a name="l00038"></a>00038 <span class="preprocessor">#if CH_USE_HEAP</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span>
<a name="l00040"></a>00040 <span class="comment">/*</span>
<a name="l00041"></a>00041 <span class="comment"> * Module dependencies check.</span>
<a name="l00042"></a>00042 <span class="comment"> */</span>
<a name="l00043"></a>00043 <span class="preprocessor">#if !CH_USE_MEMCORE &amp;&amp; !CH_USE_MALLOC_HEAP</span>
<a name="l00044"></a>00044 <span class="preprocessor"></span><span class="preprocessor">#error &quot;CH_USE_HEAP requires CH_USE_MEMCORE or CH_USE_MALLOC_HEAP&quot;</span>
<a name="l00045"></a>00045 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00046"></a>00046 <span class="preprocessor"></span>
<a name="l00047"></a>00047 <span class="preprocessor">#if !CH_USE_MUTEXES &amp;&amp; !CH_USE_SEMAPHORES</span>
<a name="l00048"></a>00048 <span class="preprocessor"></span><span class="preprocessor">#error &quot;CH_USE_HEAP requires CH_USE_MUTEXES and/or CH_USE_SEMAPHORES&quot;</span>
<a name="l00049"></a>00049 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00050"></a>00050 <span class="preprocessor"></span>
<a name="l00051"></a>00051 <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structmemory__heap.html" title="Structure describing a memory heap.">memory_heap</a> <a class="code" href="structmemory__heap.html" title="Structure describing a memory heap.">MemoryHeap</a>;
<a name="l00052"></a>00052 <span class="comment"></span>
<a name="l00053"></a>00053 <span class="comment">/**</span>
<a name="l00054"></a>00054 <span class="comment"> * @brief Memory heap block header.</span>
<a name="l00055"></a>00055 <span class="comment"> */</span>
<a name="l00056"></a><a class="code" href="unionheap__header.html">00056</a> <span class="keyword">union </span><a class="code" href="unionheap__header.html" title="Memory heap block header.">heap_header</a> {
<a name="l00057"></a>00057 <a class="code" href="structstkalign__t.html" title="Base type for stack and memory alignment.">stkalign_t</a> align;
<a name="l00058"></a>00058 <span class="keyword">struct </span>{
<a name="l00059"></a>00059 <span class="keyword">union </span>{
<a name="l00060"></a><a class="code" href="unionheap__header.html#adaecac5f216c607350511acb9d744480">00060</a> <span class="keyword">union </span><a class="code" href="unionheap__header.html" title="Memory heap block header.">heap_header</a> *<a class="code" href="unionheap__header.html#adaecac5f216c607350511acb9d744480" title="Next block in free list.">next</a>; <span class="comment">/**&lt; @brief Next block in free list. */</span>
<a name="l00061"></a><a class="code" href="unionheap__header.html#a1c8c4a01bd295afb31481275b1f67031">00061</a> <a class="code" href="structmemory__heap.html" title="Structure describing a memory heap.">MemoryHeap</a> *<a class="code" href="unionheap__header.html#a1c8c4a01bd295afb31481275b1f67031" title="Block owner heap.">heap</a>; <span class="comment">/**&lt; @brief Block owner heap. */</span>
<a name="l00062"></a>00062 } <a class="code" href="unionheap__header.html#a5bf3372839178fcc710e37d64f561e06" title="Overlapped fields.">u</a>; <span class="comment">/**&lt; @brief Overlapped fields. */</span>
<a name="l00063"></a><a class="code" href="unionheap__header.html#a591d8bde47aea2ab624cdde2cf2587ac">00063</a> <span class="keywordtype">size_t</span> <a class="code" href="unionheap__header.html#a591d8bde47aea2ab624cdde2cf2587ac" title="Size of the memory block.">size</a>; <span class="comment">/**&lt; @brief Size of the memory block. */</span>
<a name="l00064"></a>00064 } h;
<a name="l00065"></a>00065 };
<a name="l00066"></a>00066 <span class="comment"></span>
<a name="l00067"></a>00067 <span class="comment">/**</span>
<a name="l00068"></a>00068 <span class="comment"> * @brief Structure describing a memory heap.</span>
<a name="l00069"></a>00069 <span class="comment"> */</span>
<a name="l00070"></a><a class="code" href="structmemory__heap.html">00070</a> <span class="keyword">struct </span><a class="code" href="structmemory__heap.html" title="Structure describing a memory heap.">memory_heap</a> {
<a name="l00071"></a><a class="code" href="structmemory__heap.html#a4cad69cd924f2de313510634d2f6de1e">00071</a> <a class="code" href="group__memcore.html#ga4fb77ad6b1053341257948231799b4ad" title="Memory get function.">memgetfunc_t</a> <a class="code" href="structmemory__heap.html#a4cad69cd924f2de313510634d2f6de1e" title="Memory blocks provider for this heap.">h_provider</a>; <span class="comment">/**&lt; @brief Memory blocks provider for</span>
<a name="l00072"></a>00072 <span class="comment"> this heap. */</span>
<a name="l00073"></a><a class="code" href="structmemory__heap.html#a77ba7416411ebd49578c71bca15d19ae">00073</a> <span class="keyword">union </span><a class="code" href="unionheap__header.html" title="Memory heap block header.">heap_header</a> <a class="code" href="structmemory__heap.html#a77ba7416411ebd49578c71bca15d19ae" title="Free blocks list header.">h_free</a>; <span class="comment">/**&lt; @brief Free blocks list header. */</span>
<a name="l00074"></a>00074 <span class="preprocessor">#if CH_USE_MUTEXES</span>
<a name="l00075"></a><a class="code" href="structmemory__heap.html#aa7eafd71c17c8175c2c7662685777fb5">00075</a> <span class="preprocessor"></span> <a class="code" href="struct_mutex.html" title="Mutex structure.">Mutex</a> <a class="code" href="structmemory__heap.html#aa7eafd71c17c8175c2c7662685777fb5" title="Heap access mutex.">h_mtx</a>; <span class="comment">/**&lt; @brief Heap access mutex. */</span>
<a name="l00076"></a>00076 <span class="preprocessor">#else</span>
<a name="l00077"></a>00077 <span class="preprocessor"></span> <a class="code" href="struct_semaphore.html" title="Semaphore structure.">Semaphore</a> h_sem; <span class="comment">/**&lt; @brief Heap access semaphore. */</span>
<a name="l00078"></a>00078 <span class="preprocessor">#endif</span>
<a name="l00079"></a>00079 <span class="preprocessor"></span>};
<a name="l00080"></a>00080
<a name="l00081"></a>00081 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00082"></a>00082 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {
<a name="l00083"></a>00083 <span class="preprocessor">#endif</span>
<a name="l00084"></a>00084 <span class="preprocessor"></span> <span class="keywordtype">void</span> <a class="code" href="group__heaps.html#ga7e7a6625a49b6a560a47ae7575575264" title="Initializes the default heap.">heap_init</a>(<span class="keywordtype">void</span>);
<a name="l00085"></a>00085 <span class="keywordtype">void</span> <a class="code" href="group__heaps.html#ga7135c9ddbd1402a4a36ce44df948f4e4" title="Initializes a memory heap from a static memory area.">chHeapInit</a>(<a class="code" href="structmemory__heap.html" title="Structure describing a memory heap.">MemoryHeap</a> *heapp, <span class="keywordtype">void</span> *buf, <span class="keywordtype">size_t</span> <a class="code" href="unionheap__header.html#a591d8bde47aea2ab624cdde2cf2587ac" title="Size of the memory block.">size</a>);
<a name="l00086"></a>00086 <span class="keywordtype">void</span> *<a class="code" href="group__heaps.html#ga3d364eec0bef8b1986f63b3288ebbd5f" title="Allocates a block of memory from the heap by using the first-fit algorithm.">chHeapAlloc</a>(<a class="code" href="structmemory__heap.html" title="Structure describing a memory heap.">MemoryHeap</a> *heapp, <span class="keywordtype">size_t</span> size);
<a name="l00087"></a>00087 <span class="keywordtype">void</span> <a class="code" href="group__heaps.html#ga0fc553df0138f02e0b233be91e413c79" title="Frees a previously allocated memory block.">chHeapFree</a>(<span class="keywordtype">void</span> *p);
<a name="l00088"></a>00088 <span class="keywordtype">size_t</span> <a class="code" href="group__heaps.html#ga944ffb8c5b83c26b984e6a072d871a8b" title="Reports the heap status.">chHeapStatus</a>(<a class="code" href="structmemory__heap.html" title="Structure describing a memory heap.">MemoryHeap</a> *heapp, <span class="keywordtype">size_t</span> *sizep);
<a name="l00089"></a>00089 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00090"></a>00090 <span class="preprocessor"></span>}
<a name="l00091"></a>00091 <span class="preprocessor">#endif</span>
<a name="l00092"></a>00092 <span class="preprocessor"></span>
<a name="l00093"></a>00093 <span class="preprocessor">#endif </span><span class="comment">/* CH_USE_HEAP */</span>
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="preprocessor">#endif </span><span class="comment">/* _CHHEAP_H_ */</span>
<a name="l00096"></a>00096 <span class="comment"></span>
<a name="l00097"></a>00097 <span class="comment">/** @} */</span>
</pre></div></div>
2010-11-22 05:53:37 +00:00
</div>
2010-08-10 03:11:02 +00:00
<hr size="1"><address style="text-align: right;"><small>
2010-11-30 04:54:43 +00:00
Generated on Sun Nov 28 2010 14:09:48 for ChibiOS/RT by&nbsp;<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.7.1</small></address>
2010-08-10 03:11:02 +00:00
</body>
</html>