212 lines
12 KiB
HTML
212 lines
12 KiB
HTML
<!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"/>
|
|
<title>MCUXpresso SDK API Reference Manual: Log backend ring buffer</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="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
|
|
 <span id="projectnumber">Rev 2.15.000</span>
|
|
</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('a00069.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="#typedef-members">Typedefs</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Log backend ring buffer<div class="ingroups"><a class="el" href="a00068.html">Log</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
|
|
<p>This chapter describes the log backend ring buffer. All APIs provided by the component should be called explicitly by up layer. For examples, if the ring buffer is used as backend of the log component, the function LOG_InitBackendRingbuffer should be called explicitly. </p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:a00451"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00069.html#a00451">log_backend_ring_buffer_config</a></td></tr>
|
|
<tr class="memdesc:a00451"><td class="mdescLeft"> </td><td class="mdescRight">ring buffer configuration structure <a href="a00069.html#a00451">More...</a><br/></td></tr>
|
|
<tr class="separator:a00451"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:ga9c8d8e957e751480d5e5cd134aa626d5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9c8d8e957e751480d5e5cd134aa626d5"></a>
|
|
typedef struct <br class="typebreak"/>
|
|
<a class="el" href="a00069.html#a00451">log_backend_ring_buffer_config</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00069.html#ga9c8d8e957e751480d5e5cd134aa626d5">log_backend_ring_buffer_config_t</a></td></tr>
|
|
<tr class="memdesc:ga9c8d8e957e751480d5e5cd134aa626d5"><td class="mdescLeft"> </td><td class="mdescRight">ring buffer configuration structure <br/></td></tr>
|
|
<tr class="separator:ga9c8d8e957e751480d5e5cd134aa626d5"><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>
|
|
<tr class="memitem:ga9e38e9ffd1e0af7e775f18a91a944e4d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00069.html#ga9e38e9ffd1e0af7e775f18a91a944e4d">LOG_InitBackendRingbuffer</a> (<a class="el" href="a00069.html#ga9c8d8e957e751480d5e5cd134aa626d5">log_backend_ring_buffer_config_t</a> *config)</td></tr>
|
|
<tr class="memdesc:ga9e38e9ffd1e0af7e775f18a91a944e4d"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the backend ringbuffer for log component. <a href="#ga9e38e9ffd1e0af7e775f18a91a944e4d">More...</a><br/></td></tr>
|
|
<tr class="separator:ga9e38e9ffd1e0af7e775f18a91a944e4d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga15aad082c1f30a5040b00fc2e3fdfdde"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00069.html#ga15aad082c1f30a5040b00fc2e3fdfdde">LOG_DeinitBackendRingbuffer</a> (void)</td></tr>
|
|
<tr class="memdesc:ga15aad082c1f30a5040b00fc2e3fdfdde"><td class="mdescLeft"> </td><td class="mdescRight">De-initializes the backend ringbuffer for log component. <a href="#ga15aad082c1f30a5040b00fc2e3fdfdde">More...</a><br/></td></tr>
|
|
<tr class="separator:ga15aad082c1f30a5040b00fc2e3fdfdde"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
|
|
<a name="a00451" id="a00451"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct log_backend_ring_buffer_config</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"></div><table class="memberdecls">
|
|
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
|
|
<tr class="memitem:a44d558a87a925233f77f84cbbd7bb17a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a44d558a87a925233f77f84cbbd7bb17a"></a>
|
|
uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00069.html#a44d558a87a925233f77f84cbbd7bb17a">ringBuffer</a></td></tr>
|
|
<tr class="memdesc:a44d558a87a925233f77f84cbbd7bb17a"><td class="mdescLeft"> </td><td class="mdescRight">ring buffer address <br/></td></tr>
|
|
<tr class="separator:a44d558a87a925233f77f84cbbd7bb17a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a96fc624dda680f717650d930fb7c5309"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a96fc624dda680f717650d930fb7c5309"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00069.html#a96fc624dda680f717650d930fb7c5309">ringBufferLength</a></td></tr>
|
|
<tr class="memdesc:a96fc624dda680f717650d930fb7c5309"><td class="mdescLeft"> </td><td class="mdescRight">ring buffer length <br/></td></tr>
|
|
<tr class="separator:a96fc624dda680f717650d930fb7c5309"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="ga9e38e9ffd1e0af7e775f18a91a944e4d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void LOG_InitBackendRingbuffer </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00069.html#ga9c8d8e957e751480d5e5cd134aa626d5">log_backend_ring_buffer_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function initializes the backend ringbuffer for log component. The function should be called in application layer. The function should be called after the log component has been initialized (the function LOG_Init has been called).</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Ring buffer configuration for backend ring buffer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga15aad082c1f30a5040b00fc2e3fdfdde"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void LOG_DeinitBackendRingbuffer </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function de-initializes the backend ringbuffer for log component. </p>
|
|
|
|
</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>
|