diff options
Diffstat (limited to 'ucs2-lib/doc/html/group___g___u_c_s___a_m_s.html')
| -rw-r--r-- | ucs2-lib/doc/html/group___g___u_c_s___a_m_s.html | 182 |
1 files changed, 182 insertions, 0 deletions
diff --git a/ucs2-lib/doc/html/group___g___u_c_s___a_m_s.html b/ucs2-lib/doc/html/group___g___u_c_s___a_m_s.html new file mode 100644 index 0000000..a96baa8 --- /dev/null +++ b/ucs2-lib/doc/html/group___g___u_c_s___a_m_s.html @@ -0,0 +1,182 @@ +<!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"/> +<title>UNICENS: Application Message Service</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link rel="shortcut icon" type="image/x-icon" href="favicon.ico"> +<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); +</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="style_html.css" rel="stylesheet" type="text/css" /> +<link href="inic.css" rel="stylesheet" type="text/css"/> +</head> +<body> +<div class="GlobalWrapper"> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr> + <td><a href="index.html"><img alt="Logo" src="logo.png"/></a></td> + <td> + <div id="projectname">UNICENS <span id="projectnumber">V2.1.0-3491</span></div> + <div id="projectbrief">User Manual and API Reference</div> + <div id="searchbox"> <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> +</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.2 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +</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('group___g___u_c_s___a_m_s.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="#groups">Topics</a> | +<a href="#nested-classes">Data Structures</a> | +<a href="#define-members">Macros</a> | +<a href="#typedef-members">Callback Functions</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">Application Message Service</div> </div> +</div><!--header--> +<div class="contents"> + +<p>Application Message Service. +<a href="#details">More...</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a> +Topics</h2></td></tr> +<tr class="memitem:group___g___u_c_s___a_m_s___t_y_p_e_s"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___a_m_s___t_y_p_e_s.html">Referred Types</a></td></tr> +<tr class="memdesc:group___g___u_c_s___a_m_s___t_y_p_e_s"><td class="mdescLeft"> </td><td class="mdescRight">Referred types used by Application Message Service. <br/></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><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:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ucs___ams___init_data__t.html">Ucs_Ams_InitData_t</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The initialization data of the Application Message Service. <a href="struct_ucs___ams___init_data__t.html#details">More...</a><br/></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> +Macros</h2></td></tr> +<tr class="memitem:gae2eb8a7435144add2627537c6372ce69"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___a_m_s_gae2eb8a7435144add2627537c6372ce69.html#gae2eb8a7435144add2627537c6372ce69">UCS_AMS_NUM_RX_MSGS</a>   20</td></tr> +<tr class="memdesc:gae2eb8a7435144add2627537c6372ce69"><td class="mdescLeft"> </td><td class="mdescRight">Defines the number of reserved Rx message objects. Valid values: 5..255. Default value: 20. <a href="#gae2eb8a7435144add2627537c6372ce69"></a><br/></td></tr> +<tr class="separator:gae2eb8a7435144add2627537c6372ce69"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gade9da5d6f847265fc4a8613d5ba6da60"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___a_m_s_gade9da5d6f847265fc4a8613d5ba6da60.html#gade9da5d6f847265fc4a8613d5ba6da60">UCS_AMS_SIZE_RX_MSG</a>   45</td></tr> +<tr class="memdesc:gade9da5d6f847265fc4a8613d5ba6da60"><td class="mdescLeft"> </td><td class="mdescRight">Defines the payload size in bytes which is available for every Rx message object. Valid values: 45..65535. Default value: 45. <a href="#gade9da5d6f847265fc4a8613d5ba6da60"></a><br/></td></tr> +<tr class="separator:gade9da5d6f847265fc4a8613d5ba6da60"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga1305a1c706ece4772010c17734ab2f66"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___a_m_s_ga1305a1c706ece4772010c17734ab2f66.html#ga1305a1c706ece4772010c17734ab2f66">UCS_AMS_NUM_TX_MSGS</a>   20</td></tr> +<tr class="memdesc:ga1305a1c706ece4772010c17734ab2f66"><td class="mdescLeft"> </td><td class="mdescRight">Defines the number of reserved Tx message objects. Valid values: 5..255. Default value: 20. <a href="#ga1305a1c706ece4772010c17734ab2f66"></a><br/></td></tr> +<tr class="separator:ga1305a1c706ece4772010c17734ab2f66"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae813e5093ce0bd11dd5ba9bd4fe77b77"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___a_m_s_gae813e5093ce0bd11dd5ba9bd4fe77b77.html#gae813e5093ce0bd11dd5ba9bd4fe77b77">UCS_AMS_SIZE_TX_MSG</a>   45</td></tr> +<tr class="memdesc:gae813e5093ce0bd11dd5ba9bd4fe77b77"><td class="mdescLeft"> </td><td class="mdescRight">Defines the payload size in bytes which is available for every Tx message object. Valid values: 45..65535. Default value: 45. <a href="#gae813e5093ce0bd11dd5ba9bd4fe77b77"></a><br/></td></tr> +<tr class="separator:gae813e5093ce0bd11dd5ba9bd4fe77b77"><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> +Callback Functions</h2></td></tr> +<tr class="memitem:ga79608ce8c26f58a6875e72c30ac60bda"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___a_m_s_ga79608ce8c26f58a6875e72c30ac60bda.html#ga79608ce8c26f58a6875e72c30ac60bda">Ucs_AmsTx_MsgFreedCb_t</a> )(void *user_ptr)</td></tr> +<tr class="memdesc:ga79608ce8c26f58a6875e72c30ac60bda"><td class="mdescLeft"> </td><td class="mdescRight">Type of a callback function that is invoked to notify that a Tx application message object is available again while a previous allocation using <a class="el" href="group___g___u_c_s___a_m_s_gafbcfeaaa6ff3d255609e404b16dbdf0f.html#gafbcfeaaa6ff3d255609e404b16dbdf0f" title="Allocates an application message object for transmission.">Ucs_AmsTx_AllocMsg()</a> has failed. <a href="#ga79608ce8c26f58a6875e72c30ac60bda"></a><br/></td></tr> +<tr class="separator:ga79608ce8c26f58a6875e72c30ac60bda"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga80fa395bc924dca9ae92c185656db089"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___a_m_s_ga80fa395bc924dca9ae92c185656db089.html#ga80fa395bc924dca9ae92c185656db089">Ucs_AmsRx_MsgReceivedCb_t</a> )(void *user_ptr)</td></tr> +<tr class="memdesc:ga80fa395bc924dca9ae92c185656db089"><td class="mdescLeft"> </td><td class="mdescRight">Callback function type that is invoked if UNICENS has received a message completely and appended to the Rx message queue. <a href="#ga80fa395bc924dca9ae92c185656db089"></a><br/></td></tr> +<tr class="separator:ga80fa395bc924dca9ae92c185656db089"><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:gafbcfeaaa6ff3d255609e404b16dbdf0f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_ucs___ams_tx___msg__t.html">Ucs_AmsTx_Msg_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___a_m_s_gafbcfeaaa6ff3d255609e404b16dbdf0f.html#gafbcfeaaa6ff3d255609e404b16dbdf0f">Ucs_AmsTx_AllocMsg</a> (<a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_ga074c04d40d00986e0c869adaec8fadda.html#ga074c04d40d00986e0c869adaec8fadda">Ucs_Inst_t</a> *self, uint16_t data_size)</td></tr> +<tr class="memdesc:gafbcfeaaa6ff3d255609e404b16dbdf0f"><td class="mdescLeft"> </td><td class="mdescRight">Allocates an application message object for transmission. <a href="#gafbcfeaaa6ff3d255609e404b16dbdf0f"></a><br/></td></tr> +<tr class="separator:gafbcfeaaa6ff3d255609e404b16dbdf0f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga6486fc060d0aa8b1bb34851d2e63b755"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_ga886138f5d13e84ffaa3df5769830e1cd.html#ga886138f5d13e84ffaa3df5769830e1cd">Ucs_Return_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___a_m_s_ga6486fc060d0aa8b1bb34851d2e63b755.html#ga6486fc060d0aa8b1bb34851d2e63b755">Ucs_AmsTx_SendMsg</a> (<a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_ga074c04d40d00986e0c869adaec8fadda.html#ga074c04d40d00986e0c869adaec8fadda">Ucs_Inst_t</a> *self, <a class="el" href="struct_ucs___ams_tx___msg__t.html">Ucs_AmsTx_Msg_t</a> *msg_ptr, <a class="el" href="group___g___u_c_s___a_m_s___t_y_p_e_s_ga60acfdd5b93a99906d751ac2f14623a9.html#ga60acfdd5b93a99906d751ac2f14623a9">Ucs_AmsTx_CompleteCb_t</a> tx_complete_fptr)</td></tr> +<tr class="memdesc:ga6486fc060d0aa8b1bb34851d2e63b755"><td class="mdescLeft"> </td><td class="mdescRight">Transmits an application message. <a href="#ga6486fc060d0aa8b1bb34851d2e63b755"></a><br/></td></tr> +<tr class="separator:ga6486fc060d0aa8b1bb34851d2e63b755"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga9e03946330dcc4ed4111b1d43714308d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___a_m_s_ga9e03946330dcc4ed4111b1d43714308d.html#ga9e03946330dcc4ed4111b1d43714308d">Ucs_AmsTx_FreeUnusedMsg</a> (<a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_ga074c04d40d00986e0c869adaec8fadda.html#ga074c04d40d00986e0c869adaec8fadda">Ucs_Inst_t</a> *self, <a class="el" href="struct_ucs___ams_tx___msg__t.html">Ucs_AmsTx_Msg_t</a> *msg_ptr)</td></tr> +<tr class="memdesc:ga9e03946330dcc4ed4111b1d43714308d"><td class="mdescLeft"> </td><td class="mdescRight">Frees an unused Tx message object. <a href="#ga9e03946330dcc4ed4111b1d43714308d"></a><br/></td></tr> +<tr class="separator:ga9e03946330dcc4ed4111b1d43714308d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab096e481474195cc57d4d801f1d295f2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_ucs___ams_rx___msg__t.html">Ucs_AmsRx_Msg_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___a_m_s_gab096e481474195cc57d4d801f1d295f2.html#gab096e481474195cc57d4d801f1d295f2">Ucs_AmsRx_PeekMsg</a> (<a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_ga074c04d40d00986e0c869adaec8fadda.html#ga074c04d40d00986e0c869adaec8fadda">Ucs_Inst_t</a> *self)</td></tr> +<tr class="memdesc:gab096e481474195cc57d4d801f1d295f2"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a reference to the front-most message in the Rx queue. <a href="#gab096e481474195cc57d4d801f1d295f2"></a><br/></td></tr> +<tr class="separator:gab096e481474195cc57d4d801f1d295f2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga6f571e2e15fac1e4be068cdf0ccac44d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___a_m_s_ga6f571e2e15fac1e4be068cdf0ccac44d.html#ga6f571e2e15fac1e4be068cdf0ccac44d">Ucs_AmsRx_ReleaseMsg</a> (<a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_ga074c04d40d00986e0c869adaec8fadda.html#ga074c04d40d00986e0c869adaec8fadda">Ucs_Inst_t</a> *self)</td></tr> +<tr class="memdesc:ga6f571e2e15fac1e4be068cdf0ccac44d"><td class="mdescLeft"> </td><td class="mdescRight">Removes and frees the front-most message from the Rx queue. <a href="#ga6f571e2e15fac1e4be068cdf0ccac44d"></a><br/></td></tr> +<tr class="separator:ga6f571e2e15fac1e4be068cdf0ccac44d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga9fe2ca761b3856b5e7c3446cc49e90ad"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___a_m_s_ga9fe2ca761b3856b5e7c3446cc49e90ad.html#ga9fe2ca761b3856b5e7c3446cc49e90ad">Ucs_AmsRx_GetMsgCnt</a> (<a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_ga074c04d40d00986e0c869adaec8fadda.html#ga074c04d40d00986e0c869adaec8fadda">Ucs_Inst_t</a> *self)</td></tr> +<tr class="memdesc:ga9fe2ca761b3856b5e7c3446cc49e90ad"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the number of messages that are located in the Rx queue. <a href="#ga9fe2ca761b3856b5e7c3446cc49e90ad"></a><br/></td></tr> +<tr class="separator:ga9fe2ca761b3856b5e7c3446cc49e90ad"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<p>Application Message Service. </p> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="footer">© 2017 Microchip Technology Inc. All rights reserved. <a href="http://www.microchip.com" target="_blank">www.microchip.com</a></li> + </ul> +</div> +</body> +<!-- +Generated on Mon Apr 3 2017 13:52:59 for UNICENS by +Doxygen 1.8.2 +--> +<script language="javascript"> +<!-- +$('#MSearchResults').wrap('<div style="position: absolute; margin-left: 444px;"></div>'); +--> +</script> +</html> |