MCUXpresso_MCXA153/docs/MCUXpresso SDK API Reference Manual_MCXA153/a00056.html
Yilin Sun 35e678394a
Initial commit v2.14.2
Signed-off-by: Yilin Sun <imi415@imi.moe>
2024-02-11 19:33:06 +08:00

368 lines
20 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: Debugconsole</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
&#160;<span id="projectnumber">Rev 2.14.2</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&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>API&#160;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('a00056.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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</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="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Debugconsole</div> </div>
</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="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga926f5c4b8929e99c9f977ad4c48928fd"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00056.html#ga926f5c4b8929e99c9f977ad4c48928fd">PRINTF_FLOAT_ENABLE</a>&#160;&#160;&#160;0U</td></tr>
<tr class="memdesc:ga926f5c4b8929e99c9f977ad4c48928fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Definition to printf the float number. <a href="#ga926f5c4b8929e99c9f977ad4c48928fd">More...</a><br/></td></tr>
<tr class="separator:ga926f5c4b8929e99c9f977ad4c48928fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacab0122ff00951d58b47d95d95c4d119"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00056.html#gacab0122ff00951d58b47d95d95c4d119">SCANF_FLOAT_ENABLE</a>&#160;&#160;&#160;0U</td></tr>
<tr class="memdesc:gacab0122ff00951d58b47d95d95c4d119"><td class="mdescLeft">&#160;</td><td class="mdescRight">Definition to scanf the float number. <a href="#gacab0122ff00951d58b47d95d95c4d119">More...</a><br/></td></tr>
<tr class="separator:gacab0122ff00951d58b47d95d95c4d119"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga299a157e550c253df33f18180f21605e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00056.html#ga299a157e550c253df33f18180f21605e">PRINTF_ADVANCED_ENABLE</a>&#160;&#160;&#160;0U</td></tr>
<tr class="memdesc:ga299a157e550c253df33f18180f21605e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Definition to support advanced format specifier for printf. <a href="#ga299a157e550c253df33f18180f21605e">More...</a><br/></td></tr>
<tr class="separator:ga299a157e550c253df33f18180f21605e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga58226e74553b7976713f08ab6cd1ead3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00056.html#ga58226e74553b7976713f08ab6cd1ead3">SCANF_ADVANCED_ENABLE</a>&#160;&#160;&#160;0U</td></tr>
<tr class="memdesc:ga58226e74553b7976713f08ab6cd1ead3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Definition to support advanced format specifier for scanf. <a href="#ga58226e74553b7976713f08ab6cd1ead3">More...</a><br/></td></tr>
<tr class="separator:ga58226e74553b7976713f08ab6cd1ead3"><td class="memSeparator" colspan="2">&#160;</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:gae9d851a9da87d7f21d8dd5a19f9eec7b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae9d851a9da87d7f21d8dd5a19f9eec7b"></a>
typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00056.html#gae9d851a9da87d7f21d8dd5a19f9eec7b">printfCb</a> )(char *buf, int32_t *indicator, char val, int len)</td></tr>
<tr class="memdesc:gae9d851a9da87d7f21d8dd5a19f9eec7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function pointer which is used when format printf log. <br/></td></tr>
<tr class="separator:gae9d851a9da87d7f21d8dd5a19f9eec7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga0a9ac5b6750ded808b8b67e4e1df4e46"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00056.html#ga0a9ac5b6750ded808b8b67e4e1df4e46">_debugconsole_scanf_flag</a> { <br/>
&#160;&#160;<a class="el" href="a00056.html#gga0a9ac5b6750ded808b8b67e4e1df4e46a75ac8346ad7d02f167897575f807e5b1">kSCANF_Suppress</a> = 0x2U,
<br/>
&#160;&#160;<a class="el" href="a00056.html#gga0a9ac5b6750ded808b8b67e4e1df4e46afc9a6ec005675d5d4898aca04742f1e0">kSCANF_DestMask</a> = 0x7cU,
<br/>
&#160;&#160;<a class="el" href="a00056.html#gga0a9ac5b6750ded808b8b67e4e1df4e46a66ffbd72244e6ab1cb222020754a330c">kSCANF_DestChar</a> = 0x4U,
<br/>
&#160;&#160;<a class="el" href="a00056.html#gga0a9ac5b6750ded808b8b67e4e1df4e46a46a9e520cb8860811b622fd77d72c0aa">kSCANF_DestString</a> = 0x8U,
<br/>
&#160;&#160;<a class="el" href="a00056.html#gga0a9ac5b6750ded808b8b67e4e1df4e46a51713422b1181276f1330eea548d8e86">kSCANF_DestSet</a> = 0x10U,
<br/>
&#160;&#160;<a class="el" href="a00056.html#gga0a9ac5b6750ded808b8b67e4e1df4e46a852cbac73c630739f357578af2cb8739">kSCANF_DestInt</a> = 0x20U,
<br/>
&#160;&#160;<a class="el" href="a00056.html#gga0a9ac5b6750ded808b8b67e4e1df4e46a5b8b58ac18a12152a6066b09914e586d">kSCANF_DestFloat</a> = 0x30U,
<br/>
&#160;&#160;<a class="el" href="a00056.html#gga0a9ac5b6750ded808b8b67e4e1df4e46a634bed81c8955b5e39a6eebc7dacf99c">kSCANF_LengthMask</a> = 0x1f00U,
<br/>
&#160;&#160;<a class="el" href="a00056.html#gga0a9ac5b6750ded808b8b67e4e1df4e46a99f1fedbad09783d28e4967869f54a0d">kSCANF_TypeSinged</a> = 0x2000U
<br/>
}</td></tr>
<tr class="memdesc:ga0a9ac5b6750ded808b8b67e4e1df4e46"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specification modifier flags for scanf. <a href="a00056.html#ga0a9ac5b6750ded808b8b67e4e1df4e46">More...</a><br/></td></tr>
<tr class="separator:ga0a9ac5b6750ded808b8b67e4e1df4e46"><td class="memSeparator" colspan="2">&#160;</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:ga50b9d66ac2ba38b23b99dac4e81f4b8c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00056.html#ga50b9d66ac2ba38b23b99dac4e81f4b8c">StrFormatPrintf</a> (const char *fmt, va_list ap, char *buf, <a class="el" href="a00056.html#gae9d851a9da87d7f21d8dd5a19f9eec7b">printfCb</a> cb)</td></tr>
<tr class="memdesc:ga50b9d66ac2ba38b23b99dac4e81f4b8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function outputs its parameters according to a formatted string. <a href="#ga50b9d66ac2ba38b23b99dac4e81f4b8c">More...</a><br/></td></tr>
<tr class="separator:ga50b9d66ac2ba38b23b99dac4e81f4b8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafe318e0fd8d0f6ebad0c8a871a7a196f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00056.html#gafe318e0fd8d0f6ebad0c8a871a7a196f">StrFormatScanf</a> (const char *line_ptr, char *format, va_list args_ptr)</td></tr>
<tr class="memdesc:gafe318e0fd8d0f6ebad0c8a871a7a196f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts an input line of ASCII characters based upon a provided string format. <a href="#gafe318e0fd8d0f6ebad0c8a871a7a196f">More...</a><br/></td></tr>
<tr class="separator:gafe318e0fd8d0f6ebad0c8a871a7a196f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga926f5c4b8929e99c9f977ad4c48928fd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PRINTF_FLOAT_ENABLE&#160;&#160;&#160;0U</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="gacab0122ff00951d58b47d95d95c4d119"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SCANF_FLOAT_ENABLE&#160;&#160;&#160;0U</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga299a157e550c253df33f18180f21605e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PRINTF_ADVANCED_ENABLE&#160;&#160;&#160;0U</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga58226e74553b7976713f08ab6cd1ead3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SCANF_ADVANCED_ENABLE&#160;&#160;&#160;0U</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga0a9ac5b6750ded808b8b67e4e1df4e46"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="a00056.html#ga0a9ac5b6750ded808b8b67e4e1df4e46">_debugconsole_scanf_flag</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga0a9ac5b6750ded808b8b67e4e1df4e46a75ac8346ad7d02f167897575f807e5b1"></a>kSCANF_Suppress</em>&nbsp;</td><td class="fielddoc">
<p>Suppress Flag. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga0a9ac5b6750ded808b8b67e4e1df4e46afc9a6ec005675d5d4898aca04742f1e0"></a>kSCANF_DestMask</em>&nbsp;</td><td class="fielddoc">
<p>Destination Mask. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga0a9ac5b6750ded808b8b67e4e1df4e46a66ffbd72244e6ab1cb222020754a330c"></a>kSCANF_DestChar</em>&nbsp;</td><td class="fielddoc">
<p>Destination Char Flag. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga0a9ac5b6750ded808b8b67e4e1df4e46a46a9e520cb8860811b622fd77d72c0aa"></a>kSCANF_DestString</em>&nbsp;</td><td class="fielddoc">
<p>Destination String FLag. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga0a9ac5b6750ded808b8b67e4e1df4e46a51713422b1181276f1330eea548d8e86"></a>kSCANF_DestSet</em>&nbsp;</td><td class="fielddoc">
<p>Destination Set Flag. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga0a9ac5b6750ded808b8b67e4e1df4e46a852cbac73c630739f357578af2cb8739"></a>kSCANF_DestInt</em>&nbsp;</td><td class="fielddoc">
<p>Destination Int Flag. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga0a9ac5b6750ded808b8b67e4e1df4e46a5b8b58ac18a12152a6066b09914e586d"></a>kSCANF_DestFloat</em>&nbsp;</td><td class="fielddoc">
<p>Destination Float Flag. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga0a9ac5b6750ded808b8b67e4e1df4e46a634bed81c8955b5e39a6eebc7dacf99c"></a>kSCANF_LengthMask</em>&nbsp;</td><td class="fielddoc">
<p>Length Mask Flag. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga0a9ac5b6750ded808b8b67e4e1df4e46a99f1fedbad09783d28e4967869f54a0d"></a>kSCANF_TypeSinged</em>&nbsp;</td><td class="fielddoc">
<p>TypeSinged Flag. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga50b9d66ac2ba38b23b99dac4e81f4b8c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int StrFormatPrintf </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>fmt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">va_list&#160;</td>
<td class="paramname"><em>ap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00056.html#gae9d851a9da87d7f21d8dd5a19f9eec7b">printfCb</a>&#160;</td>
<td class="paramname"><em>cb</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section note"><dt>Note</dt><dd>I/O is performed by calling given function pointer using following (*func_ptr)(c);</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">fmt</td><td>Format string for printf. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ap</td><td>Arguments to printf. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>pointer to the buffer </td></tr>
<tr><td class="paramdir"></td><td class="paramname">cb</td><td>print callbck function pointer</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of characters to be print </dd></dl>
</div>
</div>
<a class="anchor" id="gafe318e0fd8d0f6ebad0c8a871a7a196f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int StrFormatScanf </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>line_ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">va_list&#160;</td>
<td class="paramname"><em>args_ptr</em>&#160;</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">
<tr><td class="paramdir">[in]</td><td class="paramname">line_ptr</td><td>The input line of ASCII data. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>Format first points to the format string. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">args_ptr</td><td>The list of parameters.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of input items converted and assigned. </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">IO_EOF</td><td>When line_ptr is empty string "". </td></tr>
</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">&copy; 2016 NXP Semiconductors. All rights reserved.
</li>
</ul>
</div>
</body>
</html>