2019-05-15 10:57:06 +01: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" / >
< title > Memory Pool< / title >
< title > CMSIS-RTOS: Memory Pool< / title >
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
< link href = "cmsis.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "jquery.js" > < / script >
< script type = "text/javascript" src = "dynsections.js" > < / script >
< script type = "text/javascript" src = "printComponentTabs.js" > < / script >
< link href = "navtree.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "resize.js" > < / script >
< script type = "text/javascript" src = "navtree.js" > < / script >
< script type = "text/javascript" >
$(document).ready(initResizable);
2019-10-18 15:30:02 +01:00
$(window).load(resizeHeight);
< / script >
< link href = "search/search.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "search/search.js" > < / script >
< script type = "text/javascript" >
$(document).ready(function() { searchBox.OnSelectItem(0); });
2019-05-15 10:57:06 +01:00
< / script >
< / 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: 46px;" >
< td id = "projectlogo" > < img alt = "Logo" src = "CMSIS_Logo_Final.png" / > < / td >
< td style = "padding-left: 0.5em;" >
< div id = "projectname" > CMSIS-RTOS
2019-10-18 15:30:02 +01:00
  < span id = "projectnumber" > Version 1.03< / span >
2019-05-15 10:57:06 +01:00
< / div >
2019-10-18 15:30:02 +01:00
< div id = "projectbrief" > Real-Time Operating System: API and RTX Reference Implementation.< / div >
2019-05-15 10:57:06 +01:00
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
< div id = "CMSISnav" class = "tabs1" >
< ul class = "tablist" >
< script type = "text/javascript" >
<!--
writeComponentTabs.call(this);
//-->
< / script >
< / ul >
< / div >
2019-10-18 15:30:02 +01:00
<!-- Generated by Doxygen 1.8.6 -->
< script type = "text/javascript" >
var searchBox = new SearchBox("searchBox", "search",false,'Search');
< / script >
2019-05-15 10:57:06 +01:00
< div id = "navrow1" class = "tabs" >
< ul class = "tablist" >
< li > < a href = "index.html" > < span > Main  Page< / span > < / a > < / li >
< li > < a href = "pages.html" > < span > Usage  and  Description< / span > < / a > < / li >
< li > < a href = "modules.html" > < span > Reference< / span > < / a > < / li >
2019-10-18 15:30:02 +01:00
< 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 >
2019-05-15 10:57:06 +01:00
< / ul >
< / div >
< / div > <!-- top -->
< div id = "side-nav" class = "ui-resizable side-nav-resizable" >
< div id = "nav-tree" >
< div id = "nav-tree-contents" >
< div id = "nav-sync" class = "sync" > < / div >
< / div >
< / div >
< div id = "splitbar" style = "-moz-user-select:none;"
class="ui-resizable-handle">
< / div >
< / div >
< script type = "text/javascript" >
2019-10-18 15:30:02 +01:00
$(document).ready(function(){initNavTree('group__CMSIS__RTOS__PoolMgmt.html','');});
2019-05-15 10:57:06 +01:00
< / script >
< div id = "doc-content" >
2019-10-18 15:30:02 +01:00
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
< a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(0)" > < span class = "SelectionMark" >   < / span > All< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(1)" > < span class = "SelectionMark" >   < / span > Data Structures< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(2)" > < span class = "SelectionMark" >   < / span > Files< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(3)" > < span class = "SelectionMark" >   < / span > Functions< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(4)" > < span class = "SelectionMark" >   < / span > Variables< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(5)" > < span class = "SelectionMark" >   < / span > Typedefs< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(6)" > < span class = "SelectionMark" >   < / span > Enumerations< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(7)" > < span class = "SelectionMark" >   < / span > Enumerator< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(8)" > < span class = "SelectionMark" >   < / span > Macros< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(9)" > < span class = "SelectionMark" >   < / span > Groups< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(10)" > < span class = "SelectionMark" >   < / span > Pages< / a > < / 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 >
2019-05-15 10:57:06 +01:00
< div class = "header" >
< div class = "summary" >
< a href = "#define-members" > Macros< / a > |
< a href = "#func-members" > Functions< / a > < / div >
< div class = "headertitle" >
2019-10-18 15:30:02 +01:00
< div class = "title" > Memory Pool< div class = "ingroups" > < a class = "el" href = "group__CMSIS__RTOS__InterThread.html" > Inter-Thread Communication and Resource Sharing< / a > < / div > < / div > < / div >
< / div > <!-- header -->
2019-05-15 10:57:06 +01:00
< div class = "contents" >
< p > Manage thread-safe fixed-size blocks of dynamic memory.
< a href = "#details" > More...< / a > < / p >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "define-members" > < / a >
Macros< / h2 > < / td > < / tr >
2019-10-18 15:30:02 +01:00
< tr class = "memitem:gadd84b683001de327894851b428587caa" > < td class = "memItemLeft" align = "right" valign = "top" > #define  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__CMSIS__RTOS__PoolMgmt.html#gadd84b683001de327894851b428587caa" > osFeature_Pool< / a >       1< / td > < / tr >
< tr class = "memdesc:gadd84b683001de327894851b428587caa" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Memory Pools: 1=available, 0=not available. < a href = "#gadd84b683001de327894851b428587caa" > More...< / a > < br / > < / td > < / tr >
2019-05-15 10:57:06 +01:00
< tr class = "separator:gadd84b683001de327894851b428587caa" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2019-10-18 15:30:02 +01:00
< tr class = "memitem:ga87b471d4fe2d5dbd0040708edd52771b" > < td class = "memItemLeft" align = "right" valign = "top" > #define  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__CMSIS__RTOS__PoolMgmt.html#ga87b471d4fe2d5dbd0040708edd52771b" > osPoolDef< / a > (name, no, type)< / td > < / tr >
< tr class = "memdesc:ga87b471d4fe2d5dbd0040708edd52771b" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Define a Memory Pool. < a href = "#ga87b471d4fe2d5dbd0040708edd52771b" > More...< / a > < br / > < / td > < / tr >
2019-05-15 10:57:06 +01:00
< tr class = "separator:ga87b471d4fe2d5dbd0040708edd52771b" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2019-10-18 15:30:02 +01:00
< tr class = "memitem:ga5f0b204a82327533d420210125c90697" > < td class = "memItemLeft" align = "right" valign = "top" > #define  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__CMSIS__RTOS__PoolMgmt.html#ga5f0b204a82327533d420210125c90697" > osPool< / a > (name)      & os_pool_def_##name< / td > < / tr >
< tr class = "memdesc:ga5f0b204a82327533d420210125c90697" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Access a Memory Pool definition. < a href = "#ga5f0b204a82327533d420210125c90697" > More...< / a > < br / > < / td > < / tr >
2019-05-15 10:57:06 +01:00
< tr class = "separator:ga5f0b204a82327533d420210125c90697" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "func-members" > < / a >
Functions< / h2 > < / td > < / tr >
2019-10-18 15:30:02 +01:00
< tr class = "memitem:ga34af5c4f4ab38f4138ea7f1f9ece3a1a" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "cmsis__os_8h.html#a08d2e20fd9bbd96220fe068d420f3686" > osPoolId< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__CMSIS__RTOS__PoolMgmt.html#ga34af5c4f4ab38f4138ea7f1f9ece3a1a" > osPoolCreate< / a > (const < a class = "el" href = "cmsis__os_8h.html#structosPoolDef__t" > osPoolDef_t< / a > *pool_def)< / td > < / tr >
< tr class = "memdesc:ga34af5c4f4ab38f4138ea7f1f9ece3a1a" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Create and Initialize a memory pool. < a href = "#ga34af5c4f4ab38f4138ea7f1f9ece3a1a" > More...< / a > < br / > < / td > < / tr >
2019-05-15 10:57:06 +01:00
< tr class = "separator:ga34af5c4f4ab38f4138ea7f1f9ece3a1a" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2019-10-18 15:30:02 +01:00
< tr class = "memitem:gaa0b2994f1a866c19e0d11e6e0d44f543" > < td class = "memItemLeft" align = "right" valign = "top" > void *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__CMSIS__RTOS__PoolMgmt.html#gaa0b2994f1a866c19e0d11e6e0d44f543" > osPoolAlloc< / a > (< a class = "el" href = "cmsis__os_8h.html#a08d2e20fd9bbd96220fe068d420f3686" > osPoolId< / a > pool_id)< / td > < / tr >
< tr class = "memdesc:gaa0b2994f1a866c19e0d11e6e0d44f543" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Allocate a memory block from a memory pool. < a href = "#gaa0b2994f1a866c19e0d11e6e0d44f543" > More...< / a > < br / > < / td > < / tr >
2019-05-15 10:57:06 +01:00
< tr class = "separator:gaa0b2994f1a866c19e0d11e6e0d44f543" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2019-10-18 15:30:02 +01:00
< tr class = "memitem:ga9f129fcad4730fbd1048ad4fa262f36a" > < td class = "memItemLeft" align = "right" valign = "top" > void *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__CMSIS__RTOS__PoolMgmt.html#ga9f129fcad4730fbd1048ad4fa262f36a" > osPoolCAlloc< / a > (< a class = "el" href = "cmsis__os_8h.html#a08d2e20fd9bbd96220fe068d420f3686" > osPoolId< / a > pool_id)< / td > < / tr >
< tr class = "memdesc:ga9f129fcad4730fbd1048ad4fa262f36a" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Allocate a memory block from a memory pool and set memory block to zero. < a href = "#ga9f129fcad4730fbd1048ad4fa262f36a" > More...< / a > < br / > < / td > < / tr >
2019-05-15 10:57:06 +01:00
< tr class = "separator:ga9f129fcad4730fbd1048ad4fa262f36a" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2019-10-18 15:30:02 +01:00
< tr class = "memitem:ga4a861e9c469c9d0daf5721bf174f8e54" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "group__CMSIS__RTOS__Status.html#gae2e091fefc4c767117727bd5aba4d99e" > osStatus< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__CMSIS__RTOS__PoolMgmt.html#ga4a861e9c469c9d0daf5721bf174f8e54" > osPoolFree< / a > (< a class = "el" href = "cmsis__os_8h.html#a08d2e20fd9bbd96220fe068d420f3686" > osPoolId< / a > pool_id, void *block)< / td > < / tr >
< tr class = "memdesc:ga4a861e9c469c9d0daf5721bf174f8e54" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Return an allocated memory block back to a specific memory pool. < a href = "#ga4a861e9c469c9d0daf5721bf174f8e54" > More...< / a > < br / > < / td > < / tr >
2019-05-15 10:57:06 +01:00
< tr class = "separator:ga4a861e9c469c9d0daf5721bf174f8e54" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Description< / h2 >
< p > < b > Memory< / b > < b > pools< / b > are fixed-size blocks of memory that are thread-safe. They operate much faster than the dynamically allocated heap and do not suffer from fragmentation. Being thread-safe, they can be accessed from threads and ISRs alike.< / p >
2019-10-18 15:30:02 +01:00
< p > < b > Shared< / b > < b > memory< / b > is one of the basic models to exchange information between threads. Using memory pools for exchanging data, you can share more complex objects between threads if compared to a < a class = "el" href = "group__CMSIS__RTOS__Message.html" > Message Queue< / a > . Memory pool management functions are used to define and manage such fixed-sized memory pools.< / p >
< h2 > Working with Memory Pools < / h2 >
2019-05-15 10:57:06 +01:00
< p > Follow these steps to create and use a memory pool:< / p >
< ol type = "1" >
< li > Declare a data structure that combines a number of elements: < div class = "fragment" > < div class = "line" > < span class = "keyword" > typedef< / span > < span class = "keyword" > struct < / span > {< / div >
< div class = "line" > uint32_t length;< / div >
< div class = "line" > uint32_t width;< / div >
< div class = "line" > uint32_t height;< / div >
< div class = "line" > uint32_t weight;< / div >
< div class = "line" > } properties_t;< / div >
< / div > <!-- fragment --> < / li >
2019-10-18 15:30:02 +01:00
< li > Declare a memory pool of these objects as a block of memory: < div class = "fragment" > < div class = "line" > < a class = "code" href = "group__CMSIS__RTOS__PoolMgmt.html#ga87b471d4fe2d5dbd0040708edd52771b" > osPoolDef< / a > (object_pool, 10, properties_t); < span class = "comment" > // Declare memory pool< / span > < / div >
< div class = "line" > < a class = "code" href = "cmsis__os_8h.html#a08d2e20fd9bbd96220fe068d420f3686" > osPoolId< / a > (object_pool_id); < span class = "comment" > // Memory pool ID< / span > < / div >
2019-05-15 10:57:06 +01:00
< / div > <!-- fragment --> < / li >
2019-10-18 15:30:02 +01:00
< li > Then, create the memory pool in a thread: < div class = "fragment" > < div class = "line" > object_pool_id = < a class = "code" href = "group__CMSIS__RTOS__PoolMgmt.html#ga34af5c4f4ab38f4138ea7f1f9ece3a1a" > osPoolCreate< / a > (< a class = "code" href = "group__CMSIS__RTOS__PoolMgmt.html#ga5f0b204a82327533d420210125c90697" > osPool< / a > (object_pool));< / div >
2019-05-15 10:57:06 +01:00
< / div > <!-- fragment --> < / li >
< li > Allocate the pool within a thread and fill it with data: < div class = "fragment" > < div class = "line" > properties_t *object_data;< / div >
2019-10-18 15:30:02 +01:00
< div class = "line" > object_data = (properties_t *) < a class = "code" href = "group__CMSIS__RTOS__PoolMgmt.html#gaa0b2994f1a866c19e0d11e6e0d44f543" > osPoolAlloc< / a > (object_pool_id);< / div >
2019-05-15 10:57:06 +01:00
< div class = "line" > < / div >
< div class = "line" > object_data-> length = 100;< / div >
< div class = "line" > object_data-> width = 10;< / div >
< div class = "line" > object_data-> height = 23;< / div >
< div class = "line" > object_data-> weight = 1000;< / div >
< / div > <!-- fragment --> < / li >
< / ol >
< h2 class = "groupheader" > Macro Definition Documentation< / h2 >
< a class = "anchor" id = "gadd84b683001de327894851b428587caa" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > #define osFeature_Pool      1< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > A CMSIS-RTOS implementation may support fixed-size memory pools.< / p >
< ul >
2019-10-18 15:30:02 +01:00
< li > When < a class = "el" href = "group__CMSIS__RTOS__PoolMgmt.html#gadd84b683001de327894851b428587caa" > osFeature_Pool< / a > is 1 memory pools are supported.< / li >
< li > When < a class = "el" href = "group__CMSIS__RTOS__PoolMgmt.html#gadd84b683001de327894851b428587caa" > osFeature_Pool< / a > is 0 no memory pools are supported.< / li >
2019-05-15 10:57:06 +01:00
< / ul >
2019-10-18 15:30:02 +01:00
< p > < a class = "el" href = "rtxImplementation.html" > CMSIS-RTOS RTX< / a > Setting: < b > osFeature_Pool< / b > is 1 < / p >
2019-05-15 10:57:06 +01:00
< / div >
< / div >
< a class = "anchor" id = "ga5f0b204a82327533d420210125c90697" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > #define osPool< / td >
< td > (< / td >
< td class = "paramtype" >   < / td >
< td class = "paramname" > name< / td > < td > )< / td >
< td >       & os_pool_def_##name< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2019-10-18 15:30:02 +01:00
< p > Access a memory pool for the functions < a class = "el" href = "group__CMSIS__RTOS__PoolMgmt.html#ga34af5c4f4ab38f4138ea7f1f9ece3a1a" > osPoolCreate< / a > .< / p >
2019-05-15 10:57:06 +01:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > name< / td > < td > name of the memory pool < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section note" > < dt > Note< / dt > < dd > CAN BE CHANGED: The parameter to < b > osPool< / b > shall be consistent but the macro body is implementation specific in every CMSIS-RTOS. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "ga87b471d4fe2d5dbd0040708edd52771b" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > #define osPoolDef< / td >
< td > (< / td >
< td class = "paramtype" >   < / td >
< td class = "paramname" > name, < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" >   < / td >
< td class = "paramname" > no, < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" >   < / td >
< td class = "paramname" > type  < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2019-10-18 15:30:02 +01:00
< p > Define a memory pool that is referenced by < a class = "el" href = "group__CMSIS__RTOS__PoolMgmt.html#ga5f0b204a82327533d420210125c90697" > osPool< / a > .< / p >
2019-05-15 10:57:06 +01:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > name< / td > < td > name of the memory pool. < / td > < / tr >
< tr > < td class = "paramname" > no< / td > < td > maximum number of blocks (objects) in the memory pool. < / td > < / tr >
< tr > < td class = "paramname" > type< / td > < td > data type of a single block (object). < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section note" > < dt > Note< / dt > < dd > CAN BE CHANGED: The parameter to < b > osPoolDef< / b > shall be consistent but the macro body is implementation specific in every CMSIS-RTOS. < / dd > < / dl >
< / div >
< / div >
< h2 class = "groupheader" > Function Documentation< / h2 >
< a class = "anchor" id = "gaa0b2994f1a866c19e0d11e6e0d44f543" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void * osPoolAlloc < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "cmsis__os_8h.html#a08d2e20fd9bbd96220fe068d420f3686" > osPoolId< / a >   < / td >
< td class = "paramname" > < em > pool_id< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2019-10-18 15:30:02 +01:00
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > pool_id< / td > < td > memory pool ID obtain referenced with < a class = "el" href = "group__CMSIS__RTOS__PoolMgmt.html#ga34af5c4f4ab38f4138ea7f1f9ece3a1a" > osPoolCreate< / a > . < / td > < / tr >
2019-05-15 10:57:06 +01:00
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > address of the allocated memory block or NULL in case of no memory available. < / dd > < / dl >
< dl class = "section note" > < dt > Note< / dt > < dd > MUST REMAIN UNCHANGED: < b > osPoolAlloc< / b > shall be consistent in every CMSIS-RTOS.< / dd > < / dl >
< p > Allocate a memory block from the memory pool.< / p >
2019-10-18 15:30:02 +01:00
< dl class = "section note" > < dt > Note< / dt > < dd > < a class = "el" href = "functionOverview.html#CMSIS_RTOS_ISR_Calls" > Interrupt Service Routines< / a > can call this function.< / dd > < / dl >
2019-05-15 10:57:06 +01:00
< p > < b > Code Example< / b > < / p >
< div class = "fragment" > < div class = "line" > < span class = "preprocessor" > #include " < a class = "code" href = "cmsis__os_8h.html" > cmsis_os.h< / a > " < / span > < / div >
< div class = "line" > < / div >
< div class = "line" > < span class = "keyword" > typedef< / span > < span class = "keyword" > struct < / span > {< / div >
< div class = "line" > uint8_t Buf[32];< / div >
< div class = "line" > uint8_t Idx;< / div >
< div class = "line" > } MEM_BLOCK;< / div >
< div class = "line" > < / div >
2019-10-18 15:30:02 +01:00
< div class = "line" > < a class = "code" href = "group__CMSIS__RTOS__PoolMgmt.html#ga87b471d4fe2d5dbd0040708edd52771b" > osPoolDef< / a > (MemPool, 8, MEM_BLOCK);< / div >
2019-05-15 10:57:06 +01:00
< div class = "line" > < / div >
< div class = "line" > < span class = "keywordtype" > void< / span > AlocMemoryPoolBlock (< span class = "keywordtype" > void< / span > ) {< / div >
2019-10-18 15:30:02 +01:00
< div class = "line" > < a class = "code" href = "cmsis__os_8h.html#a08d2e20fd9bbd96220fe068d420f3686" > osPoolId< / a > MemPool_Id;< / div >
2019-05-15 10:57:06 +01:00
< div class = "line" > MEM_BLOCK *addr;< / div >
< div class = "line" > < / div >
2019-10-18 15:30:02 +01:00
< div class = "line" > MemPool_Id = < a class = "code" href = "group__CMSIS__RTOS__PoolMgmt.html#ga34af5c4f4ab38f4138ea7f1f9ece3a1a" > osPoolCreate< / a > (< a class = "code" href = "group__CMSIS__RTOS__PoolMgmt.html#ga5f0b204a82327533d420210125c90697" > osPool< / a > (MemPool));< / div >
2019-05-15 10:57:06 +01:00
< div class = "line" > < span class = "keywordflow" > if< / span > (MemPool_Id != NULL) {< / div >
< div class = "line" > :< / div >
< div class = "line" > < span class = "comment" > // allocate a memory block< / span > < / div >
2019-10-18 15:30:02 +01:00
< div class = "line" > addr = (MEM_BLOCK *)< a class = "code" href = "group__CMSIS__RTOS__PoolMgmt.html#gaa0b2994f1a866c19e0d11e6e0d44f543" > osPoolAlloc< / a > (MemPool_Id);< / div >
2019-05-15 10:57:06 +01:00
< div class = "line" > < / div >
< div class = "line" > < span class = "keywordflow" > if< / span > (addr != NULL) {< / div >
< div class = "line" > < span class = "comment" > // memory block was allocated< / span > < / div >
< div class = "line" > :< / div >
< div class = "line" > }< / div >
< div class = "line" > }< / div >
< div class = "line" > }< / div >
< / div > <!-- fragment -->
< / div >
< / div >
< a class = "anchor" id = "ga9f129fcad4730fbd1048ad4fa262f36a" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void * osPoolCAlloc < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "cmsis__os_8h.html#a08d2e20fd9bbd96220fe068d420f3686" > osPoolId< / a >   < / td >
< td class = "paramname" > < em > pool_id< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2019-10-18 15:30:02 +01:00
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > pool_id< / td > < td > memory pool ID obtain referenced with < a class = "el" href = "group__CMSIS__RTOS__PoolMgmt.html#ga34af5c4f4ab38f4138ea7f1f9ece3a1a" > osPoolCreate< / a > . < / td > < / tr >
2019-05-15 10:57:06 +01:00
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > address of the allocated memory block or NULL in case of no memory available. < / dd > < / dl >
< dl class = "section note" > < dt > Note< / dt > < dd > MUST REMAIN UNCHANGED: < b > osPoolCAlloc< / b > shall be consistent in every CMSIS-RTOS.< / dd > < / dl >
< p > Allocate a memory block from the memory pool. The block is initialized to zero.< / p >
2019-10-18 15:30:02 +01:00
< dl class = "section note" > < dt > Note< / dt > < dd > < a class = "el" href = "functionOverview.html#CMSIS_RTOS_ISR_Calls" > Interrupt Service Routines< / a > can call this function.< / dd > < / dl >
2019-05-15 10:57:06 +01:00
< p > < b > Code Example< / b > < / p >
< div class = "fragment" > < div class = "line" > < span class = "preprocessor" > #include " < a class = "code" href = "cmsis__os_8h.html" > cmsis_os.h< / a > " < / span > < / div >
< div class = "line" > < / div >
< div class = "line" > < span class = "keyword" > typedef< / span > < span class = "keyword" > struct < / span > {< / div >
< div class = "line" > uint8_t Buf[32];< / div >
< div class = "line" > uint8_t Idx;< / div >
< div class = "line" > } MEM_BLOCK;< / div >
< div class = "line" > < / div >
2019-10-18 15:30:02 +01:00
< div class = "line" > < a class = "code" href = "group__CMSIS__RTOS__PoolMgmt.html#ga87b471d4fe2d5dbd0040708edd52771b" > osPoolDef< / a > (MemPool, 8, MEM_BLOCK);< / div >
2019-05-15 10:57:06 +01:00
< div class = "line" > < / div >
< div class = "line" > < span class = "keywordtype" > void< / span > CAlocMemoryPoolBlock (< span class = "keywordtype" > void< / span > ) {< / div >
2019-10-18 15:30:02 +01:00
< div class = "line" > < a class = "code" href = "cmsis__os_8h.html#a08d2e20fd9bbd96220fe068d420f3686" > osPoolId< / a > MemPool_Id;< / div >
2019-05-15 10:57:06 +01:00
< div class = "line" > MEM_BLOCK *addr;< / div >
< div class = "line" > < / div >
2019-10-18 15:30:02 +01:00
< div class = "line" > MemPool_Id = < a class = "code" href = "group__CMSIS__RTOS__PoolMgmt.html#ga34af5c4f4ab38f4138ea7f1f9ece3a1a" > osPoolCreate< / a > (< a class = "code" href = "group__CMSIS__RTOS__PoolMgmt.html#ga5f0b204a82327533d420210125c90697" > osPool< / a > (MemPool));< / div >
2019-05-15 10:57:06 +01:00
< div class = "line" > < span class = "keywordflow" > if< / span > (MemPool_Id != NULL) {< / div >
< div class = "line" > :< / div >
< div class = "line" > < span class = "comment" > // allocate a memory block< / span > < / div >
2019-10-18 15:30:02 +01:00
< div class = "line" > addr = (MEM_BLOCK *)< a class = "code" href = "group__CMSIS__RTOS__PoolMgmt.html#ga9f129fcad4730fbd1048ad4fa262f36a" > osPoolCAlloc< / a > (MemPool_Id);< / div >
2019-05-15 10:57:06 +01:00
< div class = "line" > < / div >
< div class = "line" > < span class = "keywordflow" > if< / span > (addr != NULL) {< / div >
< div class = "line" > < span class = "comment" > // memory block was allocated< / span > < / div >
< div class = "line" > :< / div >
< div class = "line" > }< / div >
< div class = "line" > }< / div >
< div class = "line" > }< / div >
< / div > <!-- fragment -->
< / div >
< / div >
< a class = "anchor" id = "ga34af5c4f4ab38f4138ea7f1f9ece3a1a" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > < a class = "el" href = "cmsis__os_8h.html#a08d2e20fd9bbd96220fe068d420f3686" > osPoolId< / a > osPoolCreate < / td >
< td > (< / td >
2019-10-18 15:30:02 +01:00
< td class = "paramtype" > const < a class = "el" href = "cmsis__os_8h.html#structosPoolDef__t" > osPoolDef_t< / a > *  < / td >
2019-05-15 10:57:06 +01:00
< td class = "paramname" > < em > pool_def< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2019-10-18 15:30:02 +01:00
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > pool_def< / td > < td > memory pool definition referenced with < a class = "el" href = "group__CMSIS__RTOS__PoolMgmt.html#ga5f0b204a82327533d420210125c90697" > osPool< / a > . < / td > < / tr >
2019-05-15 10:57:06 +01:00
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > memory pool ID for reference by other functions or NULL in case of error. < / dd > < / dl >
< dl class = "section note" > < dt > Note< / dt > < dd > MUST REMAIN UNCHANGED: < b > osPoolCreate< / b > shall be consistent in every CMSIS-RTOS.< / dd > < / dl >
< p > Create and initialize a memory pool.< / p >
2019-10-18 15:30:02 +01:00
< dl class = "section note" > < dt > Note< / dt > < dd > Cannot be called from < a class = "el" href = "functionOverview.html#CMSIS_RTOS_ISR_Calls" > Interrupt Service Routines< / a > .< / dd > < / dl >
2019-05-15 10:57:06 +01:00
< p > < b > Code Example< / b > < / p >
< div class = "fragment" > < div class = "line" > < span class = "preprocessor" > #include " < a class = "code" href = "cmsis__os_8h.html" > cmsis_os.h< / a > " < / span > < / div >
< div class = "line" > < / div >
< div class = "line" > < span class = "keyword" > typedef< / span > < span class = "keyword" > struct < / span > {< / div >
< div class = "line" > uint8_t Buf[32];< / div >
< div class = "line" > uint8_t Idx;< / div >
< div class = "line" > } MEM_BLOCK;< / div >
< div class = "line" > < / div >
2019-10-18 15:30:02 +01:00
< div class = "line" > < a class = "code" href = "group__CMSIS__RTOS__PoolMgmt.html#ga87b471d4fe2d5dbd0040708edd52771b" > osPoolDef< / a > (MemPool, 8, MEM_BLOCK);< / div >
2019-05-15 10:57:06 +01:00
< div class = "line" > < / div >
< div class = "line" > < span class = "keywordtype" > void< / span > CreateMemoryPool (< span class = "keywordtype" > void< / span > ) {< / div >
2019-10-18 15:30:02 +01:00
< div class = "line" > < a class = "code" href = "cmsis__os_8h.html#a08d2e20fd9bbd96220fe068d420f3686" > osPoolId< / a > MemPool_Id;< / div >
2019-05-15 10:57:06 +01:00
< div class = "line" > < / div >
2019-10-18 15:30:02 +01:00
< div class = "line" > MemPool_Id = < a class = "code" href = "group__CMSIS__RTOS__PoolMgmt.html#ga34af5c4f4ab38f4138ea7f1f9ece3a1a" > osPoolCreate< / a > (< a class = "code" href = "group__CMSIS__RTOS__PoolMgmt.html#ga5f0b204a82327533d420210125c90697" > osPool< / a > (MemPool));< / div >
2019-05-15 10:57:06 +01:00
< div class = "line" > < span class = "keywordflow" > if< / span > (MemPool_Id != NULL) {< / div >
< div class = "line" > < span class = "comment" > // memory pool created< / span > < / div >
< div class = "line" > }< / div >
< div class = "line" > }< / div >
< / div > <!-- fragment -->
< / div >
< / div >
< a class = "anchor" id = "ga4a861e9c469c9d0daf5721bf174f8e54" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2019-10-18 15:30:02 +01:00
< td class = "memname" > < a class = "el" href = "group__CMSIS__RTOS__Status.html#gae2e091fefc4c767117727bd5aba4d99e" > osStatus< / a > osPoolFree < / td >
2019-05-15 10:57:06 +01:00
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "cmsis__os_8h.html#a08d2e20fd9bbd96220fe068d420f3686" > osPoolId< / a >   < / td >
< td class = "paramname" > < em > pool_id< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > block< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2019-10-18 15:30:02 +01:00
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > pool_id< / td > < td > memory pool ID obtain referenced with < a class = "el" href = "group__CMSIS__RTOS__PoolMgmt.html#ga34af5c4f4ab38f4138ea7f1f9ece3a1a" > osPoolCreate< / a > . < / td > < / tr >
2019-05-15 10:57:06 +01:00
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > block< / td > < td > address of the allocated memory block that is returned to the memory pool. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > status code that indicates the execution status of the function. < / dd > < / dl >
< dl class = "section note" > < dt > Note< / dt > < dd > MUST REMAIN UNCHANGED: < b > osPoolFree< / b > shall be consistent in every CMSIS-RTOS.< / dd > < / dl >
< p > Return a memory block to a memory pool.< / p >
2019-10-18 15:30:02 +01:00
< p > < b > < a class = "el" href = "group__CMSIS__RTOS__Status.html" > Status and Error Codes< / a > < / b > < br / >
2019-05-15 10:57:06 +01:00
< / p >
< ul >
< li > < em > osOK:< / em > the memory block is released.< / li >
< li > < em > osErrorValue:< / em > < em > block< / em > does not belong to the memory pool.< / li >
< li > < em > osErrorParameter:< / em > a parameter is invalid or outside of a permitted range.< / li >
< / ul >
2019-10-18 15:30:02 +01:00
< dl class = "section note" > < dt > Note< / dt > < dd > < a class = "el" href = "functionOverview.html#CMSIS_RTOS_ISR_Calls" > Interrupt Service Routines< / a > can call this function.< / dd > < / dl >
2019-05-15 10:57:06 +01:00
< p > < b > Code Example< / b > < / p >
< div class = "fragment" > < div class = "line" > < span class = "preprocessor" > #include " < a class = "code" href = "cmsis__os_8h.html" > cmsis_os.h< / a > " < / span > < / div >
< div class = "line" > < / div >
< div class = "line" > < span class = "keyword" > typedef< / span > < span class = "keyword" > struct < / span > {< / div >
< div class = "line" > uint8_t Buf[32];< / div >
< div class = "line" > uint8_t Idx;< / div >
< div class = "line" > } MEM_BLOCK;< / div >
< div class = "line" > < / div >
2019-10-18 15:30:02 +01:00
< div class = "line" > < a class = "code" href = "group__CMSIS__RTOS__PoolMgmt.html#ga87b471d4fe2d5dbd0040708edd52771b" > osPoolDef< / a > (MemPool, 8, MEM_BLOCK);< / div >
2019-05-15 10:57:06 +01:00
< div class = "line" > < / div >
< div class = "line" > < span class = "keywordtype" > void< / span > CAlocMemoryPoolBlock (< span class = "keywordtype" > void< / span > ) {< / div >
2019-10-18 15:30:02 +01:00
< div class = "line" > < a class = "code" href = "cmsis__os_8h.html#a08d2e20fd9bbd96220fe068d420f3686" > osPoolId< / a > MemPool_Id;< / div >
2019-05-15 10:57:06 +01:00
< div class = "line" > MEM_BLOCK *addr;< / div >
2019-10-18 15:30:02 +01:00
< div class = "line" > < a class = "code" href = "group__CMSIS__RTOS__Status.html#gae2e091fefc4c767117727bd5aba4d99e" > osStatus< / a > status;< / div >
2019-05-15 10:57:06 +01:00
< div class = "line" > < / div >
2019-10-18 15:30:02 +01:00
< div class = "line" > MemPool_Id = < a class = "code" href = "group__CMSIS__RTOS__PoolMgmt.html#ga34af5c4f4ab38f4138ea7f1f9ece3a1a" > osPoolCreate< / a > (< a class = "code" href = "group__CMSIS__RTOS__PoolMgmt.html#ga5f0b204a82327533d420210125c90697" > osPool< / a > (MemPool));< / div >
2019-05-15 10:57:06 +01:00
< div class = "line" > < span class = "keywordflow" > if< / span > (MemPool_Id != NULL) {< / div >
2019-10-18 15:30:02 +01:00
< div class = "line" > addr = (MEM_BLOCK *)< a class = "code" href = "group__CMSIS__RTOS__PoolMgmt.html#ga9f129fcad4730fbd1048ad4fa262f36a" > osPoolCAlloc< / a > (MemPool_Id);< / div >
2019-05-15 10:57:06 +01:00
< div class = "line" > < span class = "keywordflow" > if< / span > (addr != NULL) {< / div >
< div class = "line" > :< / div >
< div class = "line" > < span class = "comment" > // return a memory block back to pool< / span > < / div >
2019-10-18 15:30:02 +01:00
< div class = "line" > status = < a class = "code" href = "group__CMSIS__RTOS__PoolMgmt.html#ga4a861e9c469c9d0daf5721bf174f8e54" > osPoolFree< / a > (MemPool_Id, addr);< / div >
< div class = "line" > < span class = "keywordflow" > if< / span > (status==< a class = "code" href = "group__CMSIS__RTOS__Status.html#gae2e091fefc4c767117727bd5aba4d99ea9e1c9e2550bb4de8969a935acffc968f" > osOK< / a > ) {< / div >
2019-05-15 10:57:06 +01:00
< div class = "line" > < span class = "comment" > // handle status code< / span > < / div >
< div class = "line" > }< / div >
< div class = "line" > }< / div >
< div class = "line" > }< / div >
< div class = "line" > }< / div >
< / div > <!-- fragment -->
< / div >
< / div >
< / div > <!-- contents -->
< / div > <!-- doc - content -->
<!-- start footer part -->
< div id = "nav-path" class = "navpath" > <!-- id is needed for treeview function! -->
< ul >
2019-10-18 15:30:02 +01:00
< li class = "footer" > Generated on Wed Aug 1 2018 17:12:43 for CMSIS-RTOS by Arm Ltd. All rights reserved.
2019-05-15 10:57:06 +01:00
<!--
< a href = "http://www.doxygen.org/index.html" >
2019-10-18 15:30:02 +01:00
< img class = "footer" src = "doxygen.png" alt = "doxygen" / > < / a > 1.8.6
2019-05-15 10:57:06 +01:00
-->
< / li >
< / ul >
< / div >
< / body >
< / html >
