2022-04-08 14:42:47 +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.5" / >
2023-01-26 02:53:53 +00:00
< title > MCUXpresso SDK API Reference Manual: MemManager< / title >
2022-04-08 14:42:47 +00:00
< 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 = "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);
$(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); });
< / script >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< link href = "customdoxygen.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 = "projectlogo" > < img alt = "Logo" src = "fs_logo.gif" / > < / td >
< td style = "padding-left: 0.5em;" >
< div id = "projectname" > MCUXpresso SDK API Reference Manual
2023-05-25 07:53:34 +00:00
  < span id = "projectnumber" > Rev 2.13.1< / span >
2022-04-08 14:42:47 +00:00
< / div >
< div id = "projectbrief" > NXP Semiconductors< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
< 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  Page< / span > < / a > < / li >
< li > < a href = "pages.html" > < span > Related  Pages< / span > < / a > < / li >
< li > < a href = "modules.html" > < span > API  Reference< / 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 > <!-- 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" >
$(document).ready(function(){initNavTree('a00040.html','');});
< / script >
< div id = "doc-content" >
<!-- 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 > Functions< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(3)" > < span class = "SelectionMark" >   < / span > Variables< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(4)" > < span class = "SelectionMark" >   < / span > Typedefs< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(5)" > < span class = "SelectionMark" >   < / span > Enumerations< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(6)" > < span class = "SelectionMark" >   < / span > Enumerator< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(7)" > < span class = "SelectionMark" >   < / span > Groups< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(8)" > < 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 >
< div class = "header" >
< div class = "summary" >
< a href = "#nested-classes" > Data Structures< / a > |
< a href = "#define-members" > Macros< / a > |
2023-01-26 02:53:53 +00:00
< a href = "#enum-members" > Enumerations< / a > |
< a href = "#func-members" > Functions< / a > < / div >
2022-04-08 14:42:47 +00:00
< div class = "headertitle" >
2023-01-26 02:53:53 +00:00
< div class = "title" > MemManager< / div > < / div >
2022-04-08 14:42:47 +00:00
< / div > <!-- header -->
< div class = "contents" >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Overview< / h2 >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "nested-classes" > < / a >
Data Structures< / h2 > < / td > < / tr >
2023-01-26 02:53:53 +00:00
< tr class = "memitem:a00380" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00040.html#a00380" > mem_config_t< / a > < / td > < / tr >
< tr class = "memdesc:a00380" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Memory user config. < a href = "a00040.html#a00380" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a00380" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2022-04-08 14:42:47 +00:00
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "define-members" > < / a >
Macros< / h2 > < / td > < / tr >
2023-01-26 02:53:53 +00:00
< tr class = "memitem:ga16978454e4bca80c0f64f77d1bf6355c" > < td class = "memItemLeft" align = "right" valign = "top" > #define  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00040.html#ga16978454e4bca80c0f64f77d1bf6355c" > MinimalHeapSize_c< / a >       (uint32_t)4< / td > < / tr >
< tr class = "memdesc:ga16978454e4bca80c0f64f77d1bf6355c" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Provide Minimal heap size for application to execute correctly. < a href = "#ga16978454e4bca80c0f64f77d1bf6355c" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga16978454e4bca80c0f64f77d1bf6355c" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:gaf40e9002dfea2d45f2b96dbbb4a1a784" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "gaf40e9002dfea2d45f2b96dbbb4a1a784" > < / a >
#define  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00040.html#gaf40e9002dfea2d45f2b96dbbb4a1a784" > gMemManagerLight< / a >       (1)< / td > < / tr >
< tr class = "memdesc:gaf40e9002dfea2d45f2b96dbbb4a1a784" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Configures the memory manager light enable. < br / > < / td > < / tr >
< tr class = "separator:gaf40e9002dfea2d45f2b96dbbb4a1a784" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga06e252990b787b21620cab5be8710372" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ga06e252990b787b21620cab5be8710372" > < / a >
#define  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00040.html#ga06e252990b787b21620cab5be8710372" > MEM_MANAGER_ENABLE_TRACE< / a >       (0)< / td > < / tr >
< tr class = "memdesc:ga06e252990b787b21620cab5be8710372" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Configures the memory manager trace debug enable. < br / > < / td > < / tr >
< tr class = "separator:ga06e252990b787b21620cab5be8710372" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga58784c31750deb2f8d3cafa6e4cfa2f4" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ga58784c31750deb2f8d3cafa6e4cfa2f4" > < / a >
#define  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00040.html#ga58784c31750deb2f8d3cafa6e4cfa2f4" > MEM_MANAGER_PRE_CONFIGURE< / a >       (1)< / td > < / tr >
< tr class = "memdesc:ga58784c31750deb2f8d3cafa6e4cfa2f4" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Configures the memory manager pre configure. < br / > < / td > < / tr >
< tr class = "separator:ga58784c31750deb2f8d3cafa6e4cfa2f4" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga928348fb48efae642137bb8e3e25e2a3" > < td class = "memItemLeft" align = "right" valign = "top" > #define  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00040.html#ga928348fb48efae642137bb8e3e25e2a3" > MEM_BLOCK_DATA_BUFFER_DEFINE< / a > (name, numberOfBlocks, blockSize, id)< / td > < / tr >
< tr class = "memdesc:ga928348fb48efae642137bb8e3e25e2a3" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Defines the memory buffer. < a href = "#ga928348fb48efae642137bb8e3e25e2a3" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga928348fb48efae642137bb8e3e25e2a3" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga475f7fc6d9a6aed46df3de6132f6008b" > < td class = "memItemLeft" align = "right" valign = "top" > #define  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00040.html#ga475f7fc6d9a6aed46df3de6132f6008b" > MEM_BLOCK_BUFFER< / a > (name)      (uint8_t *)& g_poolHeadBuffer##name< / td > < / tr >
< tr class = "memdesc:ga475f7fc6d9a6aed46df3de6132f6008b" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > \ < a href = "#ga475f7fc6d9a6aed46df3de6132f6008b" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga475f7fc6d9a6aed46df3de6132f6008b" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2022-04-08 14:42:47 +00:00
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "enum-members" > < / a >
Enumerations< / h2 > < / td > < / tr >
2023-01-26 02:53:53 +00:00
< tr class = "memitem:ga3037cc98d5315eb561422a2270329f6f" > < td class = "memItemLeft" align = "right" valign = "top" > enum   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00040.html#ga3037cc98d5315eb561422a2270329f6f" > mem_status_t< / a > < / td > < / tr >
< tr class = "memdesc:ga3037cc98d5315eb561422a2270329f6f" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Memory status. < br / > < / td > < / tr >
< tr class = "separator:ga3037cc98d5315eb561422a2270329f6f" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2022-04-08 14:42:47 +00:00
< / table > < table class = "memberdecls" >
2023-01-26 02:53:53 +00:00
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "func-members" > < / a >
Functions< / h2 > < / td > < / tr >
< tr class = "memitem:ga774c0d300b19f83bf97a128a62b29a41" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ga774c0d300b19f83bf97a128a62b29a41" > < / a >
< a class = "el" href = "a00040.html#ga3037cc98d5315eb561422a2270329f6f" > mem_status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00040.html#ga774c0d300b19f83bf97a128a62b29a41" > MEM_Init< / a > (void)< / td > < / tr >
< tr class = "memdesc:ga774c0d300b19f83bf97a128a62b29a41" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Initialises the Memory Manager. < br / > < / td > < / tr >
< tr class = "separator:ga774c0d300b19f83bf97a128a62b29a41" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:gafcff3206627290b0aa07177b202499c7" > < td class = "memItemLeft" align = "right" valign = "top" > void *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00040.html#gafcff3206627290b0aa07177b202499c7" > MEM_BufferAllocWithId< / a > (uint32_t numBytes, uint8_t poolId)< / td > < / tr >
< tr class = "memdesc:gafcff3206627290b0aa07177b202499c7" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Allocate a block from the memory pools. < a href = "#gafcff3206627290b0aa07177b202499c7" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gafcff3206627290b0aa07177b202499c7" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:gab03704e4f06151ab3b74fb4724e42e61" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00040.html#ga3037cc98d5315eb561422a2270329f6f" > mem_status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00040.html#gab03704e4f06151ab3b74fb4724e42e61" > MEM_BufferFree< / a > (void *buffer)< / td > < / tr >
< tr class = "memdesc:gab03704e4f06151ab3b74fb4724e42e61" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Memory buffer free . < a href = "#gab03704e4f06151ab3b74fb4724e42e61" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gab03704e4f06151ab3b74fb4724e42e61" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:gaad158f3f85718f7bf0554f13abbb49f3" > < td class = "memItemLeft" align = "right" valign = "top" > uint16_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00040.html#gaad158f3f85718f7bf0554f13abbb49f3" > MEM_BufferGetSize< / a > (void *buffer)< / td > < / tr >
< tr class = "memdesc:gaad158f3f85718f7bf0554f13abbb49f3" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Returns the size of a given buffer. < a href = "#gaad158f3f85718f7bf0554f13abbb49f3" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gaad158f3f85718f7bf0554f13abbb49f3" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:gacefbb7014fb7ae473c71bf037363581a" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00040.html#ga3037cc98d5315eb561422a2270329f6f" > mem_status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00040.html#gacefbb7014fb7ae473c71bf037363581a" > MEM_BufferFreeAllWithId< / a > (uint8_t poolId)< / td > < / tr >
< tr class = "memdesc:gacefbb7014fb7ae473c71bf037363581a" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Frees all allocated blocks by selected source and in selected pool. < a href = "#gacefbb7014fb7ae473c71bf037363581a" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gacefbb7014fb7ae473c71bf037363581a" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga59178a6e9d993615b4fe1ce5f1800329" > < td class = "memItemLeft" align = "right" valign = "top" > void *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00040.html#ga59178a6e9d993615b4fe1ce5f1800329" > MEM_BufferRealloc< / a > (void *buffer, uint32_t new_size)< / td > < / tr >
< tr class = "memdesc:ga59178a6e9d993615b4fe1ce5f1800329" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Memory buffer realloc. < a href = "#ga59178a6e9d993615b4fe1ce5f1800329" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga59178a6e9d993615b4fe1ce5f1800329" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:gaf0b3c73ddc44a47578dbce6877a7afaa" > < td class = "memItemLeft" align = "right" valign = "top" > uint32_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00040.html#gaf0b3c73ddc44a47578dbce6877a7afaa" > MEM_GetHeapUpperLimit< / a > (void)< / td > < / tr >
< tr class = "memdesc:gaf0b3c73ddc44a47578dbce6877a7afaa" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Get the address after the last allocated block if MemManagerLight is used. < a href = "#gaf0b3c73ddc44a47578dbce6877a7afaa" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gaf0b3c73ddc44a47578dbce6877a7afaa" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:gac381264fd9c1aaec541808e579bb1e6e" > < td class = "memItemLeft" align = "right" valign = "top" > uint32_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00040.html#gac381264fd9c1aaec541808e579bb1e6e" > MEM_GetFreeHeapSize< / a > (void)< / td > < / tr >
< tr class = "memdesc:gac381264fd9c1aaec541808e579bb1e6e" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Get the free space in the heap. < a href = "#gac381264fd9c1aaec541808e579bb1e6e" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gac381264fd9c1aaec541808e579bb1e6e" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2022-04-08 14:42:47 +00:00
< / table >
< hr / > < h2 class = "groupheader" > Data Structure Documentation< / h2 >
2023-01-26 02:53:53 +00:00
< a name = "a00380" id = "a00380" > < / a >
2022-04-08 14:42:47 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-01-26 02:53:53 +00:00
< td class = "memname" > struct mem_config_t< / td >
2022-04-08 14:42:47 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
2023-01-26 02:53:53 +00:00
< div class = "textblock" > < / div >
2022-04-08 14:42:47 +00:00
< / div >
< / div >
< h2 class = "groupheader" > Macro Definition Documentation< / h2 >
2023-01-26 02:53:53 +00:00
< a class = "anchor" id = "ga16978454e4bca80c0f64f77d1bf6355c" > < / a >
2022-04-08 14:42:47 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-01-26 02:53:53 +00:00
< td class = "memname" > #define MinimalHeapSize_c      (uint32_t)4< / td >
2022-04-08 14:42:47 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
2023-01-26 02:53:53 +00:00
< p > The application can define a minimal heap size for proper code exection at run time, This will issue a link error if the minimal heap size requirement is not fullfilled (not enough space in RAM) By Default, Minimal heap size is set to 4 bytes (unlikely enough to have application work correctly) < / p >
2022-04-08 14:42:47 +00:00
< / div >
< / div >
2023-01-26 02:53:53 +00:00
< a class = "anchor" id = "ga928348fb48efae642137bb8e3e25e2a3" > < / a >
2022-04-08 14:42:47 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-01-26 02:53:53 +00:00
< td class = "memname" > #define MEM_BLOCK_DATA_BUFFER_DEFINE< / td >
2022-04-08 14:42:47 +00:00
< td > (< / td >
2023-01-26 02:53:53 +00:00
< td class = "paramtype" >   < / td >
< td class = "paramname" > name, < / td >
2022-04-08 14:42:47 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2023-01-26 02:53:53 +00:00
< td class = "paramtype" >   < / td >
< td class = "paramname" > numberOfBlocks, < / td >
2022-04-08 14:42:47 +00:00
< / tr >
< tr >
2023-01-26 02:53:53 +00:00
< td class = "paramkey" > < / td >
2022-04-08 14:42:47 +00:00
< td > < / td >
2023-01-26 02:53:53 +00:00
< td class = "paramtype" >   < / td >
< td class = "paramname" > blockSize, < / td >
2022-04-08 14:42:47 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2023-01-26 02:53:53 +00:00
< td class = "paramtype" >   < / td >
< td class = "paramname" > id  < / td >
2022-04-08 14:42:47 +00:00
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2023-01-26 02:53:53 +00:00
< b > Value:< / b > < div class = "fragment" > < div class = "line" > uint32_t \< / div >
< div class = "line" > g_poolBuffer##name[(MEM_POOL_SIZE + numberOfBlocks * MEM_BLOCK_SIZE + numberOfBlocks * blockSize + 3U) > > 2U];< / div >
< / div > <!-- fragment --> < p > This macro is used to define the shell memory buffer for memory manager. And then uses the macro MEM_BLOCK_BUFFER to get the memory buffer pointer. The macro should not be used in any function.< / p >
< p > This is a example, < / p >
< div class = "fragment" > < div class = "line" > * MEM_BLOCK_BUFFER_DEFINE(app64, 5, 64,0);< / div >
< div class = "line" > * MEM_BLOCK_BUFFER_DEFINE(app128, 6, 128,0);< / div >
< div class = "line" > * MEM_BLOCK_BUFFER_DEFINE(app256, 7, 256,0);< / div >
< div class = "line" > * < / div >
< / div > <!-- fragment --> < dl class = "params" > < dt > Parameters< / dt > < dd >
2022-04-08 14:42:47 +00:00
< table class = "params" >
2023-01-26 02:53:53 +00:00
< tr > < td class = "paramname" > name< / td > < td > The name string of the memory buffer. < / td > < / tr >
< tr > < td class = "paramname" > numberOfBlocks< / td > < td > The number Of Blocks. < / td > < / tr >
< tr > < td class = "paramname" > blockSize< / td > < td > The memory block size. < / td > < / tr >
< tr > < td class = "paramname" > id< / td > < td > The id Of memory buffer. < / td > < / tr >
2022-04-08 14:42:47 +00:00
< / table >
< / dd >
< / dl >
< / div >
< / div >
2023-01-26 02:53:53 +00:00
< a class = "anchor" id = "ga475f7fc6d9a6aed46df3de6132f6008b" > < / a >
2022-04-08 14:42:47 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-01-26 02:53:53 +00:00
< td class = "memname" > #define MEM_BLOCK_BUFFER< / td >
2022-04-08 14:42:47 +00:00
< td > (< / td >
2023-01-26 02:53:53 +00:00
< td class = "paramtype" >   < / td >
< td class = "paramname" > name< / td > < td > )< / td >
< td >       (uint8_t *)& g_poolHeadBuffer##name< / td >
2022-04-08 14:42:47 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
2023-01-26 02:53:53 +00:00
< p > Gets the memory buffer pointer \ \ This macro is used to get the memory buffer pointer. The macro should \ not be used before the macro MEM_BLOCK_BUFFER_DEFINE is used. \ \ < / p >
2022-04-08 14:42:47 +00:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2023-01-26 02:53:53 +00:00
< tr > < td class = "paramname" > name< / td > < td > The memory name string of the buffer. \ < / td > < / tr >
2022-04-08 14:42:47 +00:00
< / table >
< / dd >
< / dl >
< / div >
< / div >
2023-01-26 02:53:53 +00:00
< h2 class = "groupheader" > Function Documentation< / h2 >
< a class = "anchor" id = "gafcff3206627290b0aa07177b202499c7" > < / a >
2022-04-08 14:42:47 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-01-26 02:53:53 +00:00
< td class = "memname" > void* MEM_BufferAllocWithId < / td >
2022-04-08 14:42:47 +00:00
< td > (< / td >
2023-01-26 02:53:53 +00:00
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > numBytes< / em > , < / td >
2022-04-08 14:42:47 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2023-01-26 02:53:53 +00:00
< td class = "paramtype" > uint8_t  < / td >
< td class = "paramname" > < em > poolId< / em >   < / td >
2022-04-08 14:42:47 +00:00
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2023-01-26 02:53:53 +00:00
< p > The function uses the numBytes argument to look up a pool with adequate block sizes.< / p >
2022-04-08 14:42:47 +00:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2023-01-26 02:53:53 +00:00
< tr > < td class = "paramname" > numBytes< / td > < td > The number of bytes will be allocated. < / td > < / tr >
< tr > < td class = "paramname" > poolId< / td > < td > The ID of the pool where to search for a free buffer. < / td > < / tr >
2022-04-08 14:42:47 +00:00
< / table >
< / dd >
< / dl >
< dl class = "retval" > < dt > Return values< / dt > < dd >
< table class = "retval" >
2023-01-26 02:53:53 +00:00
< tr > < td class = "paramname" > Memory< / td > < td > buffer address when allocate success, NULL when allocate fail. < / td > < / tr >
2022-04-08 14:42:47 +00:00
< / table >
< / dd >
< / dl >
< / div >
< / div >
2023-01-26 02:53:53 +00:00
< a class = "anchor" id = "gab03704e4f06151ab3b74fb4724e42e61" > < / a >
2022-04-08 14:42:47 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-01-26 02:53:53 +00:00
< td class = "memname" > < a class = "el" href = "a00040.html#ga3037cc98d5315eb561422a2270329f6f" > mem_status_t< / a > MEM_BufferFree < / td >
2022-04-08 14:42:47 +00:00
< td > (< / td >
2023-01-26 02:53:53 +00:00
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > buffer< / em > < / td > < td > )< / td >
2022-04-08 14:42:47 +00:00
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2023-01-26 02:53:53 +00:00
< tr > < td class = "paramname" > buffer< / td > < td > The memory buffer address will be free. < / td > < / tr >
2022-04-08 14:42:47 +00:00
< / table >
< / dd >
< / dl >
< dl class = "retval" > < dt > Return values< / dt > < dd >
< table class = "retval" >
2023-01-26 02:53:53 +00:00
< tr > < td class = "paramname" > kStatus_MemSuccess< / td > < td > Memory free succeed. < / td > < / tr >
< tr > < td class = "paramname" > kStatus_MemFreeError< / td > < td > Memory free error occurred. < / td > < / tr >
2022-04-08 14:42:47 +00:00
< / table >
< / dd >
< / dl >
< / div >
< / div >
2023-01-26 02:53:53 +00:00
< a class = "anchor" id = "gaad158f3f85718f7bf0554f13abbb49f3" > < / a >
2022-04-08 14:42:47 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-01-26 02:53:53 +00:00
< td class = "memname" > uint16_t MEM_BufferGetSize < / td >
2022-04-08 14:42:47 +00:00
< td > (< / td >
2023-01-26 02:53:53 +00:00
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > buffer< / em > < / td > < td > )< / td >
2022-04-08 14:42:47 +00:00
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2023-01-26 02:53:53 +00:00
< tr > < td class = "paramname" > buffer< / td > < td > The memory buffer address will be get size. < / td > < / tr >
2022-04-08 14:42:47 +00:00
< / table >
< / dd >
< / dl >
< dl class = "retval" > < dt > Return values< / dt > < dd >
< table class = "retval" >
2023-01-26 02:53:53 +00:00
< tr > < td class = "paramname" > The< / td > < td > size of a given buffer. < / td > < / tr >
2022-04-08 14:42:47 +00:00
< / table >
< / dd >
< / dl >
< / div >
< / div >
2023-01-26 02:53:53 +00:00
< a class = "anchor" id = "gacefbb7014fb7ae473c71bf037363581a" > < / a >
2022-04-08 14:42:47 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-01-26 02:53:53 +00:00
< td class = "memname" > < a class = "el" href = "a00040.html#ga3037cc98d5315eb561422a2270329f6f" > mem_status_t< / a > MEM_BufferFreeAllWithId < / td >
2022-04-08 14:42:47 +00:00
< td > (< / td >
2023-01-26 02:53:53 +00:00
< td class = "paramtype" > uint8_t  < / td >
< td class = "paramname" > < em > poolId< / em > < / td > < td > )< / td >
2022-04-08 14:42:47 +00:00
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2023-01-26 02:53:53 +00:00
< tr > < td class = "paramname" > poolId< / td > < td > Selected pool Id (4 LSBs of poolId parameter) and selected source Id (4 MSBs of poolId parameter). < / td > < / tr >
2022-04-08 14:42:47 +00:00
< / table >
< / dd >
< / dl >
< dl class = "retval" > < dt > Return values< / dt > < dd >
< table class = "retval" >
2023-01-26 02:53:53 +00:00
< tr > < td class = "paramname" > kStatus_MemSuccess< / td > < td > Memory free succeed. < / td > < / tr >
< tr > < td class = "paramname" > kStatus_MemFreeError< / td > < td > Memory free error occurred. < / td > < / tr >
2022-04-08 14:42:47 +00:00
< / table >
< / dd >
< / dl >
< / div >
< / div >
2023-01-26 02:53:53 +00:00
< a class = "anchor" id = "ga59178a6e9d993615b4fe1ce5f1800329" > < / a >
2022-04-08 14:42:47 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-01-26 02:53:53 +00:00
< td class = "memname" > void* MEM_BufferRealloc < / td >
2022-04-08 14:42:47 +00:00
< td > (< / td >
2023-01-26 02:53:53 +00:00
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > buffer< / em > , < / td >
2022-04-08 14:42:47 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
2023-01-26 02:53:53 +00:00
< td class = "paramname" > < em > new_size< / em >   < / td >
2022-04-08 14:42:47 +00:00
< / 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" >
2023-01-26 02:53:53 +00:00
< tr > < td class = "paramname" > buffer< / td > < td > The memory buffer address will be reallocated. < / td > < / tr >
< tr > < td class = "paramname" > new_size< / td > < td > The number of bytes will be reallocated < / td > < / tr >
2022-04-08 14:42:47 +00:00
< / table >
< / dd >
< / dl >
< dl class = "retval" > < dt > Return values< / dt > < dd >
< table class = "retval" >
2023-01-26 02:53:53 +00:00
< tr > < td class = "paramname" > kStatus_MemSuccess< / td > < td > Memory free succeed. < / td > < / tr >
< tr > < td class = "paramname" > kStatus_MemFreeError< / td > < td > Memory free error occurred. < / td > < / tr >
2022-04-08 14:42:47 +00:00
< / table >
< / dd >
< / dl >
< / div >
< / div >
2023-01-26 02:53:53 +00:00
< a class = "anchor" id = "gaf0b3c73ddc44a47578dbce6877a7afaa" > < / a >
2022-04-08 14:42:47 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-01-26 02:53:53 +00:00
< td class = "memname" > uint32_t MEM_GetHeapUpperLimit < / td >
2022-04-08 14:42:47 +00:00
< td > (< / td >
2023-01-26 02:53:53 +00:00
< td class = "paramtype" > void  < / td >
< td class = "paramname" > < / td > < td > )< / td >
2022-04-08 14:42:47 +00:00
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2023-01-26 02:53:53 +00:00
< dl class = "retval" > < dt > Return values< / dt > < dd >
< table class = "retval" >
< tr > < td class = "paramname" > UpperLimit< / td > < td > Return the address after the last allocated block if MemManagerLight is used. < / td > < / tr >
< tr > < td class = "paramname" > 0< / td > < td > Return 0 in case of the legacy MemManager. < / td > < / tr >
2022-04-08 14:42:47 +00:00
< / table >
< / dd >
< / dl >
< / div >
< / div >
2023-01-26 02:53:53 +00:00
< a class = "anchor" id = "gac381264fd9c1aaec541808e579bb1e6e" > < / a >
2022-04-08 14:42:47 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-01-26 02:53:53 +00:00
< td class = "memname" > uint32_t MEM_GetFreeHeapSize < / td >
2022-04-08 14:42:47 +00:00
< td > (< / td >
2023-01-26 02:53:53 +00:00
< td class = "paramtype" > void  < / td >
< td class = "paramname" > < / td > < td > )< / td >
2022-04-08 14:42:47 +00:00
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "retval" > < dt > Return values< / dt > < dd >
< table class = "retval" >
2023-01-26 02:53:53 +00:00
< tr > < td class = "paramname" > FreeHeapSize< / td > < td > Return the free space in the heap if MemManagerLight is used. < / td > < / tr >
< tr > < td class = "paramname" > 0< / td > < td > Return 0 in case of the legacy MemManager. < / td > < / tr >
2022-04-08 14:42:47 +00:00
< / table >
< / dd >
< / dl >
< / div >
< / div >
< / div > <!-- contents -->
< / div > <!-- doc - content -->
<!-- HTML footer for doxygen 1.8.5 -->
<!-- start footer part -->
< div id = "nav-path" class = "navpath" > <!-- id is needed for treeview function! -->
< ul class = "foot" >
< li class = "footer" > © 2016 NXP Semiconductors. All rights reserved.
< / li >
< / ul >
< / div >
< / body >
< / html >
