diff options
Diffstat (limited to 'ucs2-lib/doc/html/group___g___u_c_s___r_o_u_t_i_n_g_gabb9185254132bb29ee0af137c36f50b8.html')
| -rw-r--r-- | ucs2-lib/doc/html/group___g___u_c_s___r_o_u_t_i_n_g_gabb9185254132bb29ee0af137c36f50b8.html | 220 |
1 files changed, 220 insertions, 0 deletions
diff --git a/ucs2-lib/doc/html/group___g___u_c_s___r_o_u_t_i_n_g_gabb9185254132bb29ee0af137c36f50b8.html b/ucs2-lib/doc/html/group___g___u_c_s___r_o_u_t_i_n_g_gabb9185254132bb29ee0af137c36f50b8.html new file mode 100644 index 0000000..45adf0d --- /dev/null +++ b/ucs2-lib/doc/html/group___g___u_c_s___r_o_u_t_i_n_g_gabb9185254132bb29ee0af137c36f50b8.html @@ -0,0 +1,220 @@ +<!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: Ucs_Rm_SetRouteActive</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___r_o_u_t_i_n_g.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="contents"> +<a class="anchor" id="gabb9185254132bb29ee0af137c36f50b8"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><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> Ucs_Rm_SetRouteActive </td> + <td>(</td> + <td class="paramtype"><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> * </td> + <td class="paramname"><em>self</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="struct_ucs___rm___route__t.html">Ucs_Rm_Route_t</a> * </td> + <td class="paramname"><em>route_ptr</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>active</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Sets the given route to <code>active</code> respectively <code>inactive</code> and triggers the routing process to handle the route. </p> +<p>When setting a route to <code>active</code> the routing process will start building the route and all related resources and return the result to the user callback function (Refer to Routing Management Init Structure). When setting a route to <code>inactive</code> the routing process will start destroying the route and all related resources and return the result to the user callback function. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">self</td><td>The UNICENS instance. </td></tr> + <tr><td class="paramname">route_ptr</td><td>Reference to the routes to be destroyed. </td></tr> + <tr><td class="paramname">active</td><td>Specifies whether the route should be activated or not. <code>true</code> is active and <code>false</code> inactive. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Possible return values are shown in the table below. <table class="doxtable"> +<tr> +<th>Value </th><th>Description</th></tr> +<tr> +<td>UCS_RET_SUCCESS </td><td>No error </td></tr> +<tr> +<td>UCS_RET_ERR_PARAM </td><td>At least one parameter is NULL. </td></tr> +<tr> +<td>UCS_RET_ERR_ALREADY_SET </td><td>The given route is already active or inactive </td></tr> +<tr> +<td>UCS_RET_ERR_NOT_INITIALIZED </td><td>UNICENS is not initialized </td></tr> +</table> +</dd></dl> +<dl class="section note"><dt>Note</dt><dd>The build up or the destruction of a route can take some times in case the routing process may need to perform retries when uncritical errors occur (e.g.: transmission error, processing error, etc.) or when certain conditions are not met yet (e.g. network not available, node not available, etc.). By the way, the maximum number of retries is 0xFF and the minimum time between the retries is 50ms. This results in a minimum time of ca. 13s to get a route built or suspended (if the maximum retries are reached).</dd></dl> +<dl class="section attention"><dt>Attention</dt><dd>To suit your specific system needs and setup, change the default values of the following Resources Management macros:<ul> +<li><a class="el" href="group___g___u_c_s___x_r_m___c_f_g_ga70720ac0fdcbbbc7f4742654c8f8abc1.html#ga70720ac0fdcbbbc7f4742654c8f8abc1">UCS_NUM_REMOTE_DEVICES</a> in <code>ucs_cfg.h</code> </li> +<li><a class="el" href="group___g___u_c_s___x_r_m___c_f_g_gaddc205bcdb37b435fddb292c416f605b.html#gaddc205bcdb37b435fddb292c416f605b">UCS_XRM_NUM_JOBS</a> in <code>ucs_xrm_cfg.h</code> </li> +<li><a class="el" href="group___g___u_c_s___x_r_m___c_f_g_ga9bbd7e20bff0c7ea54699df5969e933a.html#ga9bbd7e20bff0c7ea54699df5969e933a">UCS_XRM_NUM_RESOURCES</a> in <code>ucs_xrm_cfg.h</code> </li> +</ul> +</dd> +<dd> +Use the <code>UCS_ADDR_LOCAL_DEV</code> macro to address the local device when specifying connection routes to or from this device. <br/> + The following address ranges are supported:<ul> +<li>[0x10 ... 0x2FF]</li> +<li>[0x500 ... 0xFEF]</li> +<li>UCS_ADDR_LOCAL_DEV</li> +</ul> +</dd></dl> +<p><br/> +<br/> +<b>Example</b> </p> +<div class="fragment"><div class="line"><span class="comment">// The report callback function for all routes</span></div> +<div class="line"><span class="keyword">static</span> <span class="keywordtype">void</span> App_OnRoutingResult(uint16_t route_id, <a class="code" href="group___g___u_c_s___r_o_u_t_i_n_g___t_y_p_e_s_ga75ffbf28e4afc99a6abdbff0887baf9b.html#ga75ffbf28e4afc99a6abdbff0887baf9b" title="This enumerator specifies the possible route information returned via User callback function of Ucs_R...">Ucs_Rm_RouteInfos_t</a> route_infos, <span class="keywordtype">void</span> *user_ptr)</div> +<div class="line">{</div> +<div class="line"> <span class="comment">// Print whatever needs to be printed here</span></div> +<div class="line">}</div> +<div class="line"></div> +<div class="line"><span class="comment">// Activates or deactivates the route with Index 2 of the routes list.</span></div> +<div class="line"><span class="keyword">static</span> <span class="keywordtype">void</span> App_SetRouteId2_OnOff(<span class="keywordtype">bool</span> active)</div> +<div class="line">{</div> +<div class="line"> <a class="code" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_ga886138f5d13e84ffaa3df5769830e1cd.html#ga886138f5d13e84ffaa3df5769830e1cd" title="Standard return codes used for synchronous response.">Ucs_Return_t</a> ret_value;</div> +<div class="line"></div> +<div class="line"> ret_value = <a class="code" href="group___g___u_c_s___r_o_u_t_i_n_g_gabb9185254132bb29ee0af137c36f50b8.html#gabb9185254132bb29ee0af137c36f50b8" title="Sets the given route to active respectively inactive and triggers the routing process to handle the r...">Ucs_Rm_SetRouteActive</a>(ucs_inst_ptr, &routes_list[2], active);</div> +<div class="line"> <span class="keywordflow">if</span> (ret_value != <a class="code" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_ga886138f5d13e84ffaa3df5769830e1cd.html#gga886138f5d13e84ffaa3df5769830e1cda3fb51656e17ee4802f23706f35e349bc" title="Operation successfully completed.">UCS_RET_SUCCESS</a>)</div> +<div class="line"> {</div> +<div class="line"> <span class="comment">// Do whatever is necessary</span></div> +<div class="line"> }</div> +<div class="line">}</div> +<div class="line"></div> +<div class="line"><span class="comment">// Main function</span></div> +<div class="line"><span class="keywordtype">void</span> main(uint8_t argc, <span class="keywordtype">char</span> *argv[])</div> +<div class="line">{</div> +<div class="line"></div> +<div class="line"> <span class="comment">// Starts routes processing</span></div> +<div class="line"> <a class="code" href="group___g___u_c_s___r_o_u_t_i_n_g_gaaa23aca8279da197192210fe11889452.html#gaaa23aca8279da197192210fe11889452" title="Initializes the routing process with the given routes list information and starts the process to hand...">Ucs_Rm_Start</a>(ucs_inst_ptr, &routes_list[0], routes_list_size);</div> +<div class="line"></div> +<div class="line"> <span class="comment">// ...</span></div> +<div class="line"></div> +<div class="line"> <span class="keywordflow">if</span> (mic2_btn_pressed)</div> +<div class="line"> {</div> +<div class="line"> App_SetRouteId2_OnOff(<span class="keyword">true</span>);</div> +<div class="line"> }</div> +<div class="line"> <span class="keywordflow">else</span></div> +<div class="line"> {</div> +<div class="line"> App_SetRouteId2_OnOff(<span class="keyword">false</span>);</div> +<div class="line"> }</div> +<div class="line">}</div> +</div><!-- fragment --> +</div> +</div> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="group___g___u_c_s___r_o_u_t_i_n_g.html">Routing Management</a></li> + <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:53:00 for UNICENS by +Doxygen 1.8.2 +--> +<script language="javascript"> +<!-- +$('#MSearchResults').wrap('<div style="position: absolute; margin-left: 444px;"></div>'); +--> +</script> +</html> |