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/comm_interface.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="#nested-classes">Data Structures</a> | 49<a href="#define-members">Macros</a> | 50<a href="#typedef-members">Typedefs</a> | 51<a href="#enum-members">Enumerations</a> </div> 52 <div class="headertitle"> 53<div class="title">comm_interface.h File Reference</div> </div> 54</div><!--header--> 55<div class="contents"> 56 57<p>The <a class="el" href="a00506.html" title="The comm_interface.h file describes the interface definition for the communication interface...">comm_interface.h</a> file describes the interface definition for the communication interface. Each commaunication instance needs to implement comm interface. 58<a href="#details">More...</a></p> 59<div class="textblock"><code>#include <stddef.h></code><br /> 60<code>#include <stdint.h></code><br /> 61<code>#include <stdbool.h></code><br /> 62</div><div class="textblock"><div class="dynheader"> 63Include dependency graph for comm_interface.h:</div> 64<div class="dyncontent"> 65<div class="center"><img src="a00507.png" border="0" usemap="#drivers_2host_2comm__interface_8h" alt=""/></div> 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="a00508.png" border="0" usemap="#drivers_2host_2comm__interface_8hdep" alt=""/></div> 71<map name="drivers_2host_2comm__interface_8hdep" id="drivers_2host_2comm__interface_8hdep"> 72<area shape="rect" id="node2" href="a00503.html" title="The comm_if_uart.c file implements comm interface for the UART. " alt="" coords="5,80,147,121"/> 73<area shape="rect" id="node3" href="a00527.html" title="The host_interface_service.h file describes the structures and definitions for the host..." alt="" coords="171,80,344,121"/> 74</map> 75</div> 76</div> 77<p><a href="a00506_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="nested-classes"></a> 80Data Structures</h2></td></tr> 81<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a03927.html">_comm_handle_</a></td></tr> 82<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> 83<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a03931.html">_comm_control_</a></td></tr> 84<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> 85<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a03935.html">_comm_interface_</a></td></tr> 86<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> 87</table><table class="memberdecls"> 88<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> 89Macros</h2></td></tr> 90<tr class="memitem:a69273eefbfc1414980ef5d91fe2bffb0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00506.html#a69273eefbfc1414980ef5d91fe2bffb0">COMM_INTERFACE_OK</a>   0</td></tr> 91<tr class="memdesc:a69273eefbfc1414980ef5d91fe2bffb0"><td class="mdescLeft"> </td><td class="mdescRight">Operation succeeded. <a href="#a69273eefbfc1414980ef5d91fe2bffb0">More...</a><br /></td></tr> 92<tr class="separator:a69273eefbfc1414980ef5d91fe2bffb0"><td class="memSeparator" colspan="2"> </td></tr> 93</table><table class="memberdecls"> 94<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> 95Typedefs</h2></td></tr> 96<tr class="memitem:afbbf1787ef85cb21680ffa4d0c0b49b3"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="a03927.html">_comm_handle_</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00506.html#afbbf1787ef85cb21680ffa4d0c0b49b3">comm_handle_t</a></td></tr> 97<tr class="separator:afbbf1787ef85cb21680ffa4d0c0b49b3"><td class="memSeparator" colspan="2"> </td></tr> 98<tr class="memitem:a8c00600887472527a9ab23071f50db68"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="a03931.html">_comm_control_</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00506.html#a8c00600887472527a9ab23071f50db68">comm_control_t</a></td></tr> 99<tr class="separator:a8c00600887472527a9ab23071f50db68"><td class="memSeparator" colspan="2"> </td></tr> 100<tr class="memitem:ac2f0e85d53496802058859ee0df43064"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="a00506.html#a3ec76cbd0350991085b430f1a9e2f6ac">_comm_type_</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00506.html#ac2f0e85d53496802058859ee0df43064">comm_type_t</a></td></tr> 101<tr class="separator:ac2f0e85d53496802058859ee0df43064"><td class="memSeparator" colspan="2"> </td></tr> 102<tr class="memitem:af25308bb61f1815e22013b1b963033f9"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="a00506.html#a6e3bbe66379f732578e50af28a7f3981">_comm_instance_type_</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00506.html#af25308bb61f1815e22013b1b963033f9">comm_instance_type_t</a></td></tr> 103<tr class="separator:af25308bb61f1815e22013b1b963033f9"><td class="memSeparator" colspan="2"> </td></tr> 104<tr class="memitem:a873b3ba27ffd576e2711dbbeca59f748"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00506.html#a873b3ba27ffd576e2711dbbeca59f748">COMM_Event_t</a>) (uint32_t event)</td></tr> 105<tr class="separator:a873b3ba27ffd576e2711dbbeca59f748"><td class="memSeparator" colspan="2"> </td></tr> 106<tr class="memitem:a3fba587ed51c22223c2cea823c64cee5"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t</a>() </td><td class="memItemRight" valign="bottom"><a class="el" href="a00506.html#a3fba587ed51c22223c2cea823c64cee5">COMM_GetCapabilities_t</a>(<a class="el" href="a00506.html#afbbf1787ef85cb21680ffa4d0c0b49b3">comm_handle_t</a> *pHandle)</td></tr> 107<tr class="memdesc:a3fba587ed51c22223c2cea823c64cee5"><td class="mdescLeft"> </td><td class="mdescRight">The interface function to get the capability of the communication interface. <a href="#a3fba587ed51c22223c2cea823c64cee5">More...</a><br /></td></tr> 108<tr class="separator:a3fba587ed51c22223c2cea823c64cee5"><td class="memSeparator" colspan="2"> </td></tr> 109<tr class="memitem:ab49edfb97ad1018b14e153fa651a3be0"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t</a>() </td><td class="memItemRight" valign="bottom"><a class="el" href="a00506.html#ab49edfb97ad1018b14e153fa651a3be0">COMM_Init_t</a>(<a class="el" href="a00506.html#afbbf1787ef85cb21680ffa4d0c0b49b3">comm_handle_t</a> *pHandle, void *pCommInstance, <a class="el" href="a00506.html#a873b3ba27ffd576e2711dbbeca59f748">COMM_Event_t</a> event, void *pInitializeData)</td></tr> 110<tr class="memdesc:ab49edfb97ad1018b14e153fa651a3be0"><td class="mdescLeft"> </td><td class="mdescRight">The interface function to initialize the communication interface. <a href="#ab49edfb97ad1018b14e153fa651a3be0">More...</a><br /></td></tr> 111<tr class="separator:ab49edfb97ad1018b14e153fa651a3be0"><td class="memSeparator" colspan="2"> </td></tr> 112<tr class="memitem:aca5ad329409587dbe6957142922c2d3e"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t</a>() </td><td class="memItemRight" valign="bottom"><a class="el" href="a00506.html#aca5ad329409587dbe6957142922c2d3e">COMM_Config_t</a>(<a class="el" href="a00506.html#afbbf1787ef85cb21680ffa4d0c0b49b3">comm_handle_t</a> *pHandle, void *pConfigData)</td></tr> 113<tr class="memdesc:aca5ad329409587dbe6957142922c2d3e"><td class="mdescLeft"> </td><td class="mdescRight">The interface function to configure the communication interface. <a href="#aca5ad329409587dbe6957142922c2d3e">More...</a><br /></td></tr> 114<tr class="separator:aca5ad329409587dbe6957142922c2d3e"><td class="memSeparator" colspan="2"> </td></tr> 115<tr class="memitem:a23794fbffe0846ed80fda79bee1dad90"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t</a>() </td><td class="memItemRight" valign="bottom"><a class="el" href="a00506.html#a23794fbffe0846ed80fda79bee1dad90">COMM_Send_t</a>(<a class="el" href="a00506.html#afbbf1787ef85cb21680ffa4d0c0b49b3">comm_handle_t</a> *pHandle, void *pData, uint32_t <a class="el" href="a00521.html#a18e09d6eabccd6dfc2d5066542020e59">size</a>)</td></tr> 116<tr class="memdesc:a23794fbffe0846ed80fda79bee1dad90"><td class="mdescLeft"> </td><td class="mdescRight">The interface function to send data through the communication interface. <a href="#a23794fbffe0846ed80fda79bee1dad90">More...</a><br /></td></tr> 117<tr class="separator:a23794fbffe0846ed80fda79bee1dad90"><td class="memSeparator" colspan="2"> </td></tr> 118<tr class="memitem:a440eaf4b26f89b38f189620e682243ea"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t</a>() </td><td class="memItemRight" valign="bottom"><a class="el" href="a00506.html#a440eaf4b26f89b38f189620e682243ea">COMM_Receive_t</a>(<a class="el" href="a00506.html#afbbf1787ef85cb21680ffa4d0c0b49b3">comm_handle_t</a> *pHandle, void *pData, uint32_t <a class="el" href="a00521.html#a18e09d6eabccd6dfc2d5066542020e59">size</a>)</td></tr> 119<tr class="memdesc:a440eaf4b26f89b38f189620e682243ea"><td class="mdescLeft"> </td><td class="mdescRight">The interface function to receive data through the communication interface. <a href="#a440eaf4b26f89b38f189620e682243ea">More...</a><br /></td></tr> 120<tr class="separator:a440eaf4b26f89b38f189620e682243ea"><td class="memSeparator" colspan="2"> </td></tr> 121<tr class="memitem:a6ed1b6fc139ec3b9c762ef262e8d7d4d"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t</a>() </td><td class="memItemRight" valign="bottom"><a class="el" href="a00506.html#a6ed1b6fc139ec3b9c762ef262e8d7d4d">COMM_GetStatus_t</a>(<a class="el" href="a00506.html#afbbf1787ef85cb21680ffa4d0c0b49b3">comm_handle_t</a> *pHandle)</td></tr> 122<tr class="memdesc:a6ed1b6fc139ec3b9c762ef262e8d7d4d"><td class="mdescLeft"> </td><td class="mdescRight">The interface function to get the status of the comm. <a href="#a6ed1b6fc139ec3b9c762ef262e8d7d4d">More...</a><br /></td></tr> 123<tr class="separator:a6ed1b6fc139ec3b9c762ef262e8d7d4d"><td class="memSeparator" colspan="2"> </td></tr> 124<tr class="memitem:a76b4055e42a8c47c9d26d52dcf64aaee"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="a03935.html">_comm_interface_</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00506.html#a76b4055e42a8c47c9d26d52dcf64aaee">comm_interface_t</a></td></tr> 125<tr class="separator:a76b4055e42a8c47c9d26d52dcf64aaee"><td class="memSeparator" colspan="2"> </td></tr> 126</table><table class="memberdecls"> 127<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> 128Enumerations</h2></td></tr> 129<tr class="memitem:a3ec76cbd0350991085b430f1a9e2f6ac"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00506.html#a3ec76cbd0350991085b430f1a9e2f6ac">_comm_type_</a> { <br /> 130  <a class="el" href="a00506.html#a3ec76cbd0350991085b430f1a9e2f6acaaf4b9442ca66d2f23c46a10dec1f5f11">COMM_UART</a>, 131<a class="el" href="a00506.html#a3ec76cbd0350991085b430f1a9e2f6acae75be38d4fc7283bd54f8b2a4d423217">COMM_BLUETOOTH</a>, 132<a class="el" href="a00506.html#a3ec76cbd0350991085b430f1a9e2f6acadcc45e4fc275ae22b50b7080d51b983a">COMM_I2C</a>, 133<a class="el" href="a00506.html#a3ec76cbd0350991085b430f1a9e2f6acac42e41f8a04227ac400ae98ac268b2cb">COMM_SOCKET</a>, 134<br /> 135  <a class="el" href="a00506.html#a3ec76cbd0350991085b430f1a9e2f6aca290eacab1a7b322bb723974781c92e4d">COMM_NFC</a> 136<br /> 137 }</td></tr> 138<tr class="separator:a3ec76cbd0350991085b430f1a9e2f6ac"><td class="memSeparator" colspan="2"> </td></tr> 139<tr class="memitem:a6e3bbe66379f732578e50af28a7f3981"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00506.html#a6e3bbe66379f732578e50af28a7f3981">_comm_instance_type_</a> { <a class="el" href="a00506.html#a6e3bbe66379f732578e50af28a7f3981a129753c64978bc72a544a6f3f3491e13">COMM_BLOCKING</a>, 140<a class="el" href="a00506.html#a6e3bbe66379f732578e50af28a7f3981a733e810a23aa669c73a88d1bb4938f86">COMM_NONBLOCKING</a> 141 }</td></tr> 142<tr class="separator:a6e3bbe66379f732578e50af28a7f3981"><td class="memSeparator" colspan="2"> </td></tr> 143</table> 144<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 145<div class="textblock"><p>The <a class="el" href="a00506.html" title="The comm_interface.h file describes the interface definition for the communication interface...">comm_interface.h</a> file describes the interface definition for the communication interface. Each commaunication instance needs to implement comm interface. </p> 146 147<p class="definition">Definition in file <a class="el" href="a00506_source.html">comm_interface.h</a>.</p> 148</div><h2 class="groupheader">Macro Definition Documentation</h2> 149<a id="a69273eefbfc1414980ef5d91fe2bffb0"></a> 150<h2 class="memtitle"><span class="permalink"><a href="#a69273eefbfc1414980ef5d91fe2bffb0">◆ </a></span>COMM_INTERFACE_OK</h2> 151 152<div class="memitem"> 153<div class="memproto"> 154 <table class="memname"> 155 <tr> 156 <td class="memname">#define COMM_INTERFACE_OK   0</td> 157 </tr> 158 </table> 159</div><div class="memdoc"> 160 161<p>Operation succeeded. </p> 162 163<p class="definition">Definition at line <a class="el" href="a00506_source.html#l00020">20</a> of file <a class="el" href="a00506_source.html">comm_interface.h</a>.</p> 164 165<p class="reference">Referenced by <a class="el" href="a00503_source.html#l00028">COMM_UART_GetCapabilities()</a>, and <a class="el" href="a00503_source.html#l00034">COMM_UART_Init()</a>.</p> 166 167</div> 168</div> 169<h2 class="groupheader">Typedef Documentation</h2> 170<a id="aca5ad329409587dbe6957142922c2d3e"></a> 171<h2 class="memtitle"><span class="permalink"><a href="#aca5ad329409587dbe6957142922c2d3e">◆ </a></span>COMM_Config_t</h2> 172 173<div class="memitem"> 174<div class="memproto"> 175 <table class="memname"> 176 <tr> 177 <td class="memname">typedef <a class="el" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t</a>() COMM_Config_t(<a class="el" href="a00506.html#afbbf1787ef85cb21680ffa4d0c0b49b3">comm_handle_t</a> *pHandle, void *pConfigData)</td> 178 </tr> 179 </table> 180</div><div class="memdoc"> 181 182<p>The interface function to configure the communication interface. </p> 183 184<p class="definition">Definition at line <a class="el" href="a00506_source.html#l00068">68</a> of file <a class="el" href="a00506_source.html">comm_interface.h</a>.</p> 185 186</div> 187</div> 188<a id="a8c00600887472527a9ab23071f50db68"></a> 189<h2 class="memtitle"><span class="permalink"><a href="#a8c00600887472527a9ab23071f50db68">◆ </a></span>comm_control_t</h2> 190 191<div class="memitem"> 192<div class="memproto"> 193 <table class="memname"> 194 <tr> 195 <td class="memname">typedef struct <a class="el" href="a03931.html">_comm_control_</a> <a class="el" href="a00506.html#a8c00600887472527a9ab23071f50db68">comm_control_t</a></td> 196 </tr> 197 </table> 198</div><div class="memdoc"> 199 200</div> 201</div> 202<a id="a873b3ba27ffd576e2711dbbeca59f748"></a> 203<h2 class="memtitle"><span class="permalink"><a href="#a873b3ba27ffd576e2711dbbeca59f748">◆ </a></span>COMM_Event_t</h2> 204 205<div class="memitem"> 206<div class="memproto"> 207 <table class="memname"> 208 <tr> 209 <td class="memname">typedef void(* COMM_Event_t) (uint32_t event)</td> 210 </tr> 211 </table> 212</div><div class="memdoc"> 213 214<p class="definition">Definition at line <a class="el" href="a00506_source.html#l00062">62</a> of file <a class="el" href="a00506_source.html">comm_interface.h</a>.</p> 215 216</div> 217</div> 218<a id="a3fba587ed51c22223c2cea823c64cee5"></a> 219<h2 class="memtitle"><span class="permalink"><a href="#a3fba587ed51c22223c2cea823c64cee5">◆ </a></span>COMM_GetCapabilities_t</h2> 220 221<div class="memitem"> 222<div class="memproto"> 223 <table class="memname"> 224 <tr> 225 <td class="memname">typedef <a class="el" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t</a>() COMM_GetCapabilities_t(<a class="el" href="a00506.html#afbbf1787ef85cb21680ffa4d0c0b49b3">comm_handle_t</a> *pHandle)</td> 226 </tr> 227 </table> 228</div><div class="memdoc"> 229 230<p>The interface function to get the capability of the communication interface. </p> 231 232<p class="definition">Definition at line <a class="el" href="a00506_source.html#l00064">64</a> of file <a class="el" href="a00506_source.html">comm_interface.h</a>.</p> 233 234</div> 235</div> 236<a id="a6ed1b6fc139ec3b9c762ef262e8d7d4d"></a> 237<h2 class="memtitle"><span class="permalink"><a href="#a6ed1b6fc139ec3b9c762ef262e8d7d4d">◆ </a></span>COMM_GetStatus_t</h2> 238 239<div class="memitem"> 240<div class="memproto"> 241 <table class="memname"> 242 <tr> 243 <td class="memname">typedef <a class="el" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t</a>() COMM_GetStatus_t(<a class="el" href="a00506.html#afbbf1787ef85cb21680ffa4d0c0b49b3">comm_handle_t</a> *pHandle)</td> 244 </tr> 245 </table> 246</div><div class="memdoc"> 247 248<p>The interface function to get the status of the comm. </p> 249 250<p class="definition">Definition at line <a class="el" href="a00506_source.html#l00074">74</a> of file <a class="el" href="a00506_source.html">comm_interface.h</a>.</p> 251 252</div> 253</div> 254<a id="afbbf1787ef85cb21680ffa4d0c0b49b3"></a> 255<h2 class="memtitle"><span class="permalink"><a href="#afbbf1787ef85cb21680ffa4d0c0b49b3">◆ </a></span>comm_handle_t</h2> 256 257<div class="memitem"> 258<div class="memproto"> 259 <table class="memname"> 260 <tr> 261 <td class="memname">typedef struct <a class="el" href="a03927.html">_comm_handle_</a> <a class="el" href="a00506.html#afbbf1787ef85cb21680ffa4d0c0b49b3">comm_handle_t</a></td> 262 </tr> 263 </table> 264</div><div class="memdoc"> 265 266</div> 267</div> 268<a id="ab49edfb97ad1018b14e153fa651a3be0"></a> 269<h2 class="memtitle"><span class="permalink"><a href="#ab49edfb97ad1018b14e153fa651a3be0">◆ </a></span>COMM_Init_t</h2> 270 271<div class="memitem"> 272<div class="memproto"> 273 <table class="memname"> 274 <tr> 275 <td class="memname">typedef <a class="el" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t</a>() COMM_Init_t(<a class="el" href="a00506.html#afbbf1787ef85cb21680ffa4d0c0b49b3">comm_handle_t</a> *pHandle, void *pCommInstance, <a class="el" href="a00506.html#a873b3ba27ffd576e2711dbbeca59f748">COMM_Event_t</a> event, void *pInitializeData)</td> 276 </tr> 277 </table> 278</div><div class="memdoc"> 279 280<p>The interface function to initialize the communication interface. </p> 281 282<p class="definition">Definition at line <a class="el" href="a00506_source.html#l00066">66</a> of file <a class="el" href="a00506_source.html">comm_interface.h</a>.</p> 283 284</div> 285</div> 286<a id="af25308bb61f1815e22013b1b963033f9"></a> 287<h2 class="memtitle"><span class="permalink"><a href="#af25308bb61f1815e22013b1b963033f9">◆ </a></span>comm_instance_type_t</h2> 288 289<div class="memitem"> 290<div class="memproto"> 291 <table class="memname"> 292 <tr> 293 <td class="memname">typedef enum <a class="el" href="a00506.html#a6e3bbe66379f732578e50af28a7f3981">_comm_instance_type_</a> <a class="el" href="a00506.html#af25308bb61f1815e22013b1b963033f9">comm_instance_type_t</a></td> 294 </tr> 295 </table> 296</div><div class="memdoc"> 297 298</div> 299</div> 300<a id="a76b4055e42a8c47c9d26d52dcf64aaee"></a> 301<h2 class="memtitle"><span class="permalink"><a href="#a76b4055e42a8c47c9d26d52dcf64aaee">◆ </a></span>comm_interface_t</h2> 302 303<div class="memitem"> 304<div class="memproto"> 305 <table class="memname"> 306 <tr> 307 <td class="memname">typedef struct <a class="el" href="a03935.html">_comm_interface_</a> <a class="el" href="a00506.html#a76b4055e42a8c47c9d26d52dcf64aaee">comm_interface_t</a></td> 308 </tr> 309 </table> 310</div><div class="memdoc"> 311 312</div> 313</div> 314<a id="a440eaf4b26f89b38f189620e682243ea"></a> 315<h2 class="memtitle"><span class="permalink"><a href="#a440eaf4b26f89b38f189620e682243ea">◆ </a></span>COMM_Receive_t</h2> 316 317<div class="memitem"> 318<div class="memproto"> 319 <table class="memname"> 320 <tr> 321 <td class="memname">typedef <a class="el" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t</a>() COMM_Receive_t(<a class="el" href="a00506.html#afbbf1787ef85cb21680ffa4d0c0b49b3">comm_handle_t</a> *pHandle, void *pData, uint32_t <a class="el" href="a00521.html#a18e09d6eabccd6dfc2d5066542020e59">size</a>)</td> 322 </tr> 323 </table> 324</div><div class="memdoc"> 325 326<p>The interface function to receive data through the communication interface. </p> 327 328<p class="definition">Definition at line <a class="el" href="a00506_source.html#l00072">72</a> of file <a class="el" href="a00506_source.html">comm_interface.h</a>.</p> 329 330</div> 331</div> 332<a id="a23794fbffe0846ed80fda79bee1dad90"></a> 333<h2 class="memtitle"><span class="permalink"><a href="#a23794fbffe0846ed80fda79bee1dad90">◆ </a></span>COMM_Send_t</h2> 334 335<div class="memitem"> 336<div class="memproto"> 337 <table class="memname"> 338 <tr> 339 <td class="memname">typedef <a class="el" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t</a>() COMM_Send_t(<a class="el" href="a00506.html#afbbf1787ef85cb21680ffa4d0c0b49b3">comm_handle_t</a> *pHandle, void *pData, uint32_t <a class="el" href="a00521.html#a18e09d6eabccd6dfc2d5066542020e59">size</a>)</td> 340 </tr> 341 </table> 342</div><div class="memdoc"> 343 344<p>The interface function to send data through the communication interface. </p> 345 346<p class="definition">Definition at line <a class="el" href="a00506_source.html#l00070">70</a> of file <a class="el" href="a00506_source.html">comm_interface.h</a>.</p> 347 348</div> 349</div> 350<a id="ac2f0e85d53496802058859ee0df43064"></a> 351<h2 class="memtitle"><span class="permalink"><a href="#ac2f0e85d53496802058859ee0df43064">◆ </a></span>comm_type_t</h2> 352 353<div class="memitem"> 354<div class="memproto"> 355 <table class="memname"> 356 <tr> 357 <td class="memname">typedef enum <a class="el" href="a00506.html#a3ec76cbd0350991085b430f1a9e2f6ac">_comm_type_</a> <a class="el" href="a00506.html#ac2f0e85d53496802058859ee0df43064">comm_type_t</a></td> 358 </tr> 359 </table> 360</div><div class="memdoc"> 361 362</div> 363</div> 364<h2 class="groupheader">Enumeration Type Documentation</h2> 365<a id="a6e3bbe66379f732578e50af28a7f3981"></a> 366<h2 class="memtitle"><span class="permalink"><a href="#a6e3bbe66379f732578e50af28a7f3981">◆ </a></span>_comm_instance_type_</h2> 367 368<div class="memitem"> 369<div class="memproto"> 370 <table class="memname"> 371 <tr> 372 <td class="memname">enum <a class="el" href="a00506.html#a6e3bbe66379f732578e50af28a7f3981">_comm_instance_type_</a></td> 373 </tr> 374 </table> 375</div><div class="memdoc"> 376<table class="fieldtable"> 377<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a6e3bbe66379f732578e50af28a7f3981a129753c64978bc72a544a6f3f3491e13"></a>COMM_BLOCKING </td><td class="fielddoc"></td></tr> 378<tr><td class="fieldname"><a id="a6e3bbe66379f732578e50af28a7f3981a733e810a23aa669c73a88d1bb4938f86"></a>COMM_NONBLOCKING </td><td class="fielddoc"></td></tr> 379</table> 380 381<p class="definition">Definition at line <a class="el" href="a00506_source.html#l00055">55</a> of file <a class="el" href="a00506_source.html">comm_interface.h</a>.</p> 382 383</div> 384</div> 385<a id="a3ec76cbd0350991085b430f1a9e2f6ac"></a> 386<h2 class="memtitle"><span class="permalink"><a href="#a3ec76cbd0350991085b430f1a9e2f6ac">◆ </a></span>_comm_type_</h2> 387 388<div class="memitem"> 389<div class="memproto"> 390 <table class="memname"> 391 <tr> 392 <td class="memname">enum <a class="el" href="a00506.html#a3ec76cbd0350991085b430f1a9e2f6ac">_comm_type_</a></td> 393 </tr> 394 </table> 395</div><div class="memdoc"> 396<table class="fieldtable"> 397<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a3ec76cbd0350991085b430f1a9e2f6acaaf4b9442ca66d2f23c46a10dec1f5f11"></a>COMM_UART </td><td class="fielddoc"></td></tr> 398<tr><td class="fieldname"><a id="a3ec76cbd0350991085b430f1a9e2f6acae75be38d4fc7283bd54f8b2a4d423217"></a>COMM_BLUETOOTH </td><td class="fielddoc"></td></tr> 399<tr><td class="fieldname"><a id="a3ec76cbd0350991085b430f1a9e2f6acadcc45e4fc275ae22b50b7080d51b983a"></a>COMM_I2C </td><td class="fielddoc"></td></tr> 400<tr><td class="fieldname"><a id="a3ec76cbd0350991085b430f1a9e2f6acac42e41f8a04227ac400ae98ac268b2cb"></a>COMM_SOCKET </td><td class="fielddoc"></td></tr> 401<tr><td class="fieldname"><a id="a3ec76cbd0350991085b430f1a9e2f6aca290eacab1a7b322bb723974781c92e4d"></a>COMM_NFC </td><td class="fielddoc"></td></tr> 402</table> 403 404<p class="definition">Definition at line <a class="el" href="a00506_source.html#l00044">44</a> of file <a class="el" href="a00506_source.html">comm_interface.h</a>.</p> 405 406</div> 407</div> 408</div><!-- contents --> 409 410<hr class="footer"/><address class="footer"><small> 411© Copyright 2016-2022 NXP. All Rights Reserved. SPDX-License-Identifier: BSD-3-Clause 412</small></address> 413</body> 414</html> 415
