1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xmlns="http://www.w3.org/1999/xhtml"> 3<head> 4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 5<meta http-equiv="X-UA-Compatible" content="IE=9"/> 6<meta name="generator" content="Doxygen 1.8.13"/> 7<meta name="viewport" content="width=device-width, initial-scale=1"/> 8<title>ISSDK: drivers/host/data_format_hdlc.h File Reference</title> 9<link href="tabs.css" rel="stylesheet" type="text/css"/> 10<script type="text/javascript" src="jquery.js"></script> 11<script type="text/javascript" src="dynsections.js"></script> 12<link href="issdk_stylesheet.css" rel="stylesheet" type="text/css" /> 13</head> 14<body> 15<div id="top"><!-- do not remove this div, it is closed by doxygen! --> 16<div id="titlearea"> 17<table cellspacing="0" cellpadding="0"> 18 <tbody> 19 <tr style="height: 56px;"> 20 <td id="projectlogo"><img alt="Logo" src="nxp_logo_small.png"/></td> 21 <td id="projectalign" style="padding-left: 0.5em;"> 22 <div id="projectname">ISSDK 23  <span id="projectnumber">1.8</span> 24 </div> 25 <div id="projectbrief">IoT Sensing Software Development Kit</div> 26 </td> 27 </tr> 28 </tbody> 29</table> 30</div> 31<!-- end header part --> 32<!-- Generated by Doxygen 1.8.13 --> 33<script type="text/javascript" src="menudata.js"></script> 34<script type="text/javascript" src="menu.js"></script> 35<script type="text/javascript"> 36$(function() { 37 initMenu('',false,false,'search.php','Search'); 38}); 39</script> 40<div id="main-nav"></div> 41<div id="nav-path" class="navpath"> 42 <ul> 43<li class="navelem"><a class="el" href="dir_14bc92f4b96c8519b376567118ac28b3.html">drivers</a></li><li class="navelem"><a class="el" href="dir_32464e4af507982e116bd625f186503f.html">host</a></li> </ul> 44</div> 45</div><!-- top --> 46<div class="header"> 47 <div class="summary"> 48<a href="#enum-members">Enumerations</a> | 49<a href="#func-members">Functions</a> </div> 50 <div class="headertitle"> 51<div class="title">data_format_hdlc.h File Reference</div> </div> 52</div><!--header--> 53<div class="contents"> 54 55<p>The <a class="el" href="a00512.html" title="The data_format_hdlc.h file contains the Host interface definitions and configuration. ">data_format_hdlc.h</a> file contains the Host interface definitions and configuration. 56<a href="#details">More...</a></p> 57<div class="textblock"><code>#include <stdint.h></code><br /> 58<code>#include "<a class="el" href="a00101_source.html">host_io_uart.h</a>"</code><br /> 59</div><div class="textblock"><div class="dynheader"> 60Include dependency graph for data_format_hdlc.h:</div> 61<div class="dyncontent"> 62<div class="center"><img src="a00513.png" border="0" usemap="#drivers_2host_2data__format__hdlc_8h" alt=""/></div> 63<map name="drivers_2host_2data__format__hdlc_8h" id="drivers_2host_2data__format__hdlc_8h"> 64<area shape="rect" id="node3" href="a00101.html" title="The host_io_uart.h file contains the Host Protocol interface definitions and configuration. " alt="" coords="95,95,199,121"/> 65</map> 66</div> 67</div><div class="textblock"><div class="dynheader"> 68This graph shows which files directly or indirectly include this file:</div> 69<div class="dyncontent"> 70<div class="center"><img src="a00514.png" border="0" usemap="#drivers_2host_2data__format__hdlc_8hdep" alt=""/></div> 71<map name="drivers_2host_2data__format__hdlc_8hdep" id="drivers_2host_2data__format__hdlc_8hdep"> 72<area shape="rect" id="node2" href="a00098.html" title="The host_io_uart.c file contains definitions for UART based streaming interface for sending and resei..." alt="" coords="5,102,160,129"/> 73<area shape="rect" id="node3" href="a00509.html" title="The data_format_hdlc.c file contains definitions for encoding and decoding HDLC messages to and from ..." alt="" coords="184,95,344,136"/> 74</map> 75</div> 76</div> 77<p><a href="a00512_source.html">Go to the source code of this file.</a></p> 78<table class="memberdecls"> 79<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> 80Enumerations</h2></td></tr> 81<tr class="memitem:ad559b3ed307be626eacea8b56942de61"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <a class="el" href="a00512.html#ad559b3ed307be626eacea8b56942de61a899cfe3ad46b26410f19b819dc9d38ae">HOST_RX_STATE_WAITFORPACKETMARKER</a>, 82<a class="el" href="a00512.html#ad559b3ed307be626eacea8b56942de61a2f92b30f9cb47689d11946c7a84e6d16">HOST_RX_STATE_GETTINGPACKETDATA</a> 83 }<tr class="memdesc:ad559b3ed307be626eacea8b56942de61"><td class="mdescLeft"> </td><td class="mdescRight">States for receiving a packet. <a href="a00512.html#ad559b3ed307be626eacea8b56942de61">More...</a><br /></td></tr> 84</td></tr> 85<tr class="separator:ad559b3ed307be626eacea8b56942de61"><td class="memSeparator" colspan="2"> </td></tr> 86</table><table class="memberdecls"> 87<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> 88Functions</h2></td></tr> 89<tr class="memitem:af69cf775e44516f29d6ba5a93eacfbd8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00512.html#af69cf775e44516f29d6ba5a93eacfbd8">HDLC_Process_Rx_Byte</a> (uint8_t c, <a class="el" href="a02927.html">host_rx_packet_t</a> *pHostRxPkt)</td></tr> 90<tr class="separator:af69cf775e44516f29d6ba5a93eacfbd8"><td class="memSeparator" colspan="2"> </td></tr> 91<tr class="memitem:a1b0cdde224e0adf381d431058d2de34a"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00512.html#a1b0cdde224e0adf381d431058d2de34a">HDLC_Process_Tx_Msg</a> (const uint8_t *pBuffer, uint8_t *pMsg, size_t <a class="el" href="a00521.html#a18e09d6eabccd6dfc2d5066542020e59">size</a>)</td></tr> 92<tr class="separator:a1b0cdde224e0adf381d431058d2de34a"><td class="memSeparator" colspan="2"> </td></tr> 93</table> 94<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 95<div class="textblock"><p>The <a class="el" href="a00512.html" title="The data_format_hdlc.h file contains the Host interface definitions and configuration. ">data_format_hdlc.h</a> file contains the Host interface definitions and configuration. </p> 96 97<p class="definition">Definition in file <a class="el" href="a00512_source.html">data_format_hdlc.h</a>.</p> 98</div><h2 class="groupheader">Enumeration Type Documentation</h2> 99<a id="ad559b3ed307be626eacea8b56942de61"></a> 100<h2 class="memtitle"><span class="permalink"><a href="#ad559b3ed307be626eacea8b56942de61">◆ </a></span>anonymous enum</h2> 101 102<div class="memitem"> 103<div class="memproto"> 104 <table class="memname"> 105 <tr> 106 <td class="memname">anonymous enum</td> 107 </tr> 108 </table> 109</div><div class="memdoc"> 110 111<p>States for receiving a packet. </p> 112<table class="fieldtable"> 113<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ad559b3ed307be626eacea8b56942de61a899cfe3ad46b26410f19b819dc9d38ae"></a>HOST_RX_STATE_WAITFORPACKETMARKER </td><td class="fielddoc"></td></tr> 114<tr><td class="fieldname"><a id="ad559b3ed307be626eacea8b56942de61a2f92b30f9cb47689d11946c7a84e6d16"></a>HOST_RX_STATE_GETTINGPACKETDATA </td><td class="fielddoc"></td></tr> 115</table> 116 117<p class="definition">Definition at line <a class="el" href="a00512_source.html#l00031">31</a> of file <a class="el" href="a00512_source.html">data_format_hdlc.h</a>.</p> 118 119</div> 120</div> 121<h2 class="groupheader">Function Documentation</h2> 122<a id="af69cf775e44516f29d6ba5a93eacfbd8"></a> 123<h2 class="memtitle"><span class="permalink"><a href="#af69cf775e44516f29d6ba5a93eacfbd8">◆ </a></span>HDLC_Process_Rx_Byte()</h2> 124 125<div class="memitem"> 126<div class="memproto"> 127 <table class="memname"> 128 <tr> 129 <td class="memname">bool HDLC_Process_Rx_Byte </td> 130 <td>(</td> 131 <td class="paramtype">uint8_t </td> 132 <td class="paramname"><em>c</em>, </td> 133 </tr> 134 <tr> 135 <td class="paramkey"></td> 136 <td></td> 137 <td class="paramtype"><a class="el" href="a02927.html">host_rx_packet_t</a> * </td> 138 <td class="paramname"><em>pHostRxPkt</em> </td> 139 </tr> 140 <tr> 141 <td></td> 142 <td>)</td> 143 <td></td><td></td> 144 </tr> 145 </table> 146</div><div class="memdoc"> 147 148<p class="definition">Definition at line <a class="el" href="a00509_source.html#l00024">24</a> of file <a class="el" href="a00509_source.html">data_format_hdlc.c</a>.</p> 149 150<p class="reference">References <a class="el" href="a00512_source.html#l00035">HOST_RX_STATE_GETTINGPACKETDATA</a>, <a class="el" href="a00512_source.html#l00033">HOST_RX_STATE_WAITFORPACKETMARKER</a>, <a class="el" href="a00101_source.html#l00052">host_rx_packet_t::mIndex</a>, <a class="el" href="a00101_source.html#l00053">host_rx_packet_t::pRxbuf</a>, and <a class="el" href="a00101_source.html#l00051">host_rx_packet_t::rxState</a>.</p> 151 152<p class="reference">Referenced by <a class="el" href="a00098_source.html#l00207">Host_IO_Receive()</a>.</p> 153<div class="dynheader"> 154Here is the caller graph for this function:</div> 155<div class="dyncontent"> 156<div class="center"><img src="a00512_af69cf775e44516f29d6ba5a93eacfbd8_icgraph.png" border="0" usemap="#a00512_af69cf775e44516f29d6ba5a93eacfbd8_icgraph" alt=""/></div> 157<map name="a00512_af69cf775e44516f29d6ba5a93eacfbd8_icgraph" id="a00512_af69cf775e44516f29d6ba5a93eacfbd8_icgraph"> 158<area shape="rect" id="node2" href="a00101.html#a3924d21a0703878695ebdb68f720fff9" title="Host_IO_Receive" alt="" coords="221,5,343,32"/> 159</map> 160</div> 161 162</div> 163</div> 164<a id="a1b0cdde224e0adf381d431058d2de34a"></a> 165<h2 class="memtitle"><span class="permalink"><a href="#a1b0cdde224e0adf381d431058d2de34a">◆ </a></span>HDLC_Process_Tx_Msg()</h2> 166 167<div class="memitem"> 168<div class="memproto"> 169 <table class="memname"> 170 <tr> 171 <td class="memname">size_t HDLC_Process_Tx_Msg </td> 172 <td>(</td> 173 <td class="paramtype">const uint8_t * </td> 174 <td class="paramname"><em>pBuffer</em>, </td> 175 </tr> 176 <tr> 177 <td class="paramkey"></td> 178 <td></td> 179 <td class="paramtype">uint8_t * </td> 180 <td class="paramname"><em>pMsg</em>, </td> 181 </tr> 182 <tr> 183 <td class="paramkey"></td> 184 <td></td> 185 <td class="paramtype">size_t </td> 186 <td class="paramname"><em>size</em> </td> 187 </tr> 188 <tr> 189 <td></td> 190 <td>)</td> 191 <td></td><td></td> 192 </tr> 193 </table> 194</div><div class="memdoc"> 195 196<p class="definition">Definition at line <a class="el" href="a00509_source.html#l00103">103</a> of file <a class="el" href="a00509_source.html">data_format_hdlc.c</a>.</p> 197 198<p class="reference">Referenced by <a class="el" href="a00098_source.html#l00136">Host_IO_Send()</a>.</p> 199<div class="dynheader"> 200Here is the caller graph for this function:</div> 201<div class="dyncontent"> 202<div class="center"><img src="a00512_a1b0cdde224e0adf381d431058d2de34a_icgraph.png" border="0" usemap="#a00512_a1b0cdde224e0adf381d431058d2de34a_icgraph" alt=""/></div> 203<map name="a00512_a1b0cdde224e0adf381d431058d2de34a_icgraph" id="a00512_a1b0cdde224e0adf381d431058d2de34a_icgraph"> 204<area shape="rect" id="node2" href="a00101.html#a719ad6da4502e713f1573b5353af9617" title="Host_IO_Send" alt="" coords="217,5,324,32"/> 205</map> 206</div> 207 208</div> 209</div> 210</div><!-- contents --> 211 212<hr class="footer"/><address class="footer"><small> 213© Copyright 2016-2022 NXP. All Rights Reserved. SPDX-License-Identifier: BSD-3-Clause 214</small></address> 215</body> 216</html> 217
