diff options
Diffstat (limited to 'ucs2-lib/doc/html/group___g___u_c_s___n_e_t.html')
| -rw-r--r-- | ucs2-lib/doc/html/group___g___u_c_s___n_e_t.html | 163 |
1 files changed, 163 insertions, 0 deletions
diff --git a/ucs2-lib/doc/html/group___g___u_c_s___n_e_t.html b/ucs2-lib/doc/html/group___g___u_c_s___n_e_t.html new file mode 100644 index 0000000..f50e5ff --- /dev/null +++ b/ucs2-lib/doc/html/group___g___u_c_s___n_e_t.html @@ -0,0 +1,163 @@ +<!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: Network</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___n_e_t.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="#typedef-members">Callback Functions</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">Network</div> </div> +</div><!--header--> +<div class="contents"> + +<p>Provides network management functions. +<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___n_e_t___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___n_e_t___t_y_p_e_s.html">Referred Types</a></td></tr> +<tr class="memdesc:group___g___u_c_s___n_e_t___t_y_p_e_s"><td class="mdescLeft"> </td><td class="mdescRight">Provides network management functions. <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___network___init_data__t.html">Ucs_Network_InitData_t</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The network section of the UNICENS initialization data. <a href="struct_ucs___network___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="typedef-members"></a> +Callback Functions</h2></td></tr> +<tr class="memitem:gaf195e8ae396bc1fc358666fe50bf3f51"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___n_e_t_gaf195e8ae396bc1fc358666fe50bf3f51.html#gaf195e8ae396bc1fc358666fe50bf3f51">Ucs_Network_StatusCb_t</a> )(uint16_t change_mask, uint16_t events, <a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_ga6b0bec2ae9e4d0fb93eefd65752f0c74.html#ga6b0bec2ae9e4d0fb93eefd65752f0c74">Ucs_Network_Availability_t</a> availability, <a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_gad5ed0387c3c156602826d50ce94c9df7.html#gad5ed0387c3c156602826d50ce94c9df7">Ucs_Network_AvailInfo_t</a> avail_info, <a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_gab4ec40bf01de998abc4f2ae34c26ac46.html#gab4ec40bf01de998abc4f2ae34c26ac46">Ucs_Network_AvailTransCause_t</a> avail_trans_cause, uint16_t node_address, uint8_t node_position, uint8_t max_position, uint16_t packet_bw, void *user_ptr)</td></tr> +<tr class="memdesc:gaf195e8ae396bc1fc358666fe50bf3f51"><td class="mdescLeft"> </td><td class="mdescRight">Function signature used for the Network Status callback function. <a href="#gaf195e8ae396bc1fc358666fe50bf3f51"></a><br/></td></tr> +<tr class="separator:gaf195e8ae396bc1fc358666fe50bf3f51"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga43fb9c04d5ad142f6abbf9566af82f8c"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___n_e_t_ga43fb9c04d5ad142f6abbf9566af82f8c.html#ga43fb9c04d5ad142f6abbf9566af82f8c">Ucs_Network_FrameCounterCb_t</a> )(uint32_t reference, uint32_t frame_counter, bool frame_lock, <a class="el" href="struct_ucs___std_result__t.html">Ucs_StdResult_t</a> result, void *user_pointer)</td></tr> +<tr class="memdesc:ga43fb9c04d5ad142f6abbf9566af82f8c"><td class="mdescLeft"> </td><td class="mdescRight">Function signature of result callback used by <a class="el" href="group___g___u_c_s___n_e_t_ga3360b1585b5a9b54d24a934c22a44281.html#ga3360b1585b5a9b54d24a934c22a44281" title="Retrieves the Network Frame Counter, which is the number of frames since reset.">Ucs_Network_GetFrameCounter()</a>. <a href="#ga43fb9c04d5ad142f6abbf9566af82f8c"></a><br/></td></tr> +<tr class="separator:ga43fb9c04d5ad142f6abbf9566af82f8c"><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:ga83c2e74a4cc216aa10d7c6a1a517d459"><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___n_e_t_ga83c2e74a4cc216aa10d7c6a1a517d459.html#ga83c2e74a4cc216aa10d7c6a1a517d459">Ucs_Network_Startup</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 packet_bw, uint16_t forced_na_timeout, <a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_gaa573fbe79f76f263a17e51d6de99036d.html#gaa573fbe79f76f263a17e51d6de99036d">Ucs_StdResultCb_t</a> result_fptr)</td></tr> +<tr class="memdesc:ga83c2e74a4cc216aa10d7c6a1a517d459"><td class="mdescLeft"> </td><td class="mdescRight">Starts up the MOST Network. <a href="#ga83c2e74a4cc216aa10d7c6a1a517d459"></a><br/></td></tr> +<tr class="separator:ga83c2e74a4cc216aa10d7c6a1a517d459"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga1e49ce81a42f09bcecc2202edc2b93fc"><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___n_e_t_ga1e49ce81a42f09bcecc2202edc2b93fc.html#ga1e49ce81a42f09bcecc2202edc2b93fc">Ucs_Network_Shutdown</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="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_gaa573fbe79f76f263a17e51d6de99036d.html#gaa573fbe79f76f263a17e51d6de99036d">Ucs_StdResultCb_t</a> result_fptr)</td></tr> +<tr class="memdesc:ga1e49ce81a42f09bcecc2202edc2b93fc"><td class="mdescLeft"> </td><td class="mdescRight">Switches of the MOST Network. <a href="#ga1e49ce81a42f09bcecc2202edc2b93fc"></a><br/></td></tr> +<tr class="separator:ga1e49ce81a42f09bcecc2202edc2b93fc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3a71b7772ce265a77eefa7ad069c4819"><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___n_e_t_ga3a71b7772ce265a77eefa7ad069c4819.html#ga3a71b7772ce265a77eefa7ad069c4819">Ucs_Network_ForceNotAvailable</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, bool force, <a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_gaa573fbe79f76f263a17e51d6de99036d.html#gaa573fbe79f76f263a17e51d6de99036d">Ucs_StdResultCb_t</a> result_fptr)</td></tr> +<tr class="memdesc:ga3a71b7772ce265a77eefa7ad069c4819"><td class="mdescLeft"> </td><td class="mdescRight">Triggers the INIC to force the NotAvailable state. <a href="#ga3a71b7772ce265a77eefa7ad069c4819"></a><br/></td></tr> +<tr class="separator:ga3a71b7772ce265a77eefa7ad069c4819"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3360b1585b5a9b54d24a934c22a44281"><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___n_e_t_ga3360b1585b5a9b54d24a934c22a44281.html#ga3360b1585b5a9b54d24a934c22a44281">Ucs_Network_GetFrameCounter</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, uint32_t reference, <a class="el" href="group___g___u_c_s___n_e_t_ga43fb9c04d5ad142f6abbf9566af82f8c.html#ga43fb9c04d5ad142f6abbf9566af82f8c">Ucs_Network_FrameCounterCb_t</a> result_fptr)</td></tr> +<tr class="memdesc:ga3360b1585b5a9b54d24a934c22a44281"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the Network Frame Counter, which is the number of frames since reset. <a href="#ga3360b1585b5a9b54d24a934c22a44281"></a><br/></td></tr> +<tr class="separator:ga3360b1585b5a9b54d24a934c22a44281"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf08bc0be54565e30143166d675866f87"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___n_e_t_gaf08bc0be54565e30143166d675866f87.html#gaf08bc0be54565e30143166d675866f87">Ucs_Network_GetNodesCount</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:gaf08bc0be54565e30143166d675866f87"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the number of nodes within the MOST network. <a href="#gaf08bc0be54565e30143166d675866f87"></a><br/></td></tr> +<tr class="separator:gaf08bc0be54565e30143166d675866f87"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<p>Provides network management functions. </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> |