diff options
Diffstat (limited to 'ucs2-lib/doc/html/_p__u_m__b_a_c_k_c_h_a_n_n_e_l__d_i_a_g.html')
| -rw-r--r-- | ucs2-lib/doc/html/_p__u_m__b_a_c_k_c_h_a_n_n_e_l__d_i_a_g.html | 137 |
1 files changed, 137 insertions, 0 deletions
diff --git a/ucs2-lib/doc/html/_p__u_m__b_a_c_k_c_h_a_n_n_e_l__d_i_a_g.html b/ucs2-lib/doc/html/_p__u_m__b_a_c_k_c_h_a_n_n_e_l__d_i_a_g.html new file mode 100644 index 0000000..7baefba --- /dev/null +++ b/ucs2-lib/doc/html/_p__u_m__b_a_c_k_c_h_a_n_n_e_l__d_i_a_g.html @@ -0,0 +1,137 @@ +<!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: BackChannel Diagnosis</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('_p__u_m__b_a_c_k_c_h_a_n_n_e_l__d_i_a_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="header"> + <div class="headertitle"> +<div class="title">BackChannel Diagnosis </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><h1>Introduction</h1> +<p>BackChannel Diagnosis is performed on the TimingMaster node. It inspects the ring segment by segment until it finds a ring break or detects a closed ring.</p> +<p>It cannot be performed during Node Discovery or Programming service.</p> +<h1>Operation</h1> +<p>Calling <a class="el" href="group___g___u_c_s___b_c___d_i_a_g_gaaefed31b3c57ef52a29237c3f84fb566.html#gaaefed31b3c57ef52a29237c3f84fb566">Ucs_Bcd_Start()</a> starts the BackChannel Diagnosis. The function has a parameter <b>report_fptr</b>. It points to the report callback function. <b>report_fptr</b> will deliver a result for each inspected segment as well as a result which indicates the end of the diagnosis session.</p> +<p>Segment number 0 denotes the segment following the TimingMaster.</p> +<table class="doxtable"> +<tr> +<th>Parameter <em>code</em> </th><th>Parameter <em>segment</em> </th><th>Description</th></tr> +<tr> +<td><a class="el" href="group___g___u_c_s___b_c___d_i_a_g___t_y_p_e_s_ga08b88fcd49483ac8d0ce004c104a4c12.html#gga08b88fcd49483ac8d0ce004c104a4c12a9efd7ed8009ce371525bd17ba8cd33bb">UCS_BCD_RES_SUCCESS</a> </td><td>segment number </td><td>current segment is not broken </td></tr> +<tr> +<td><a class="el" href="group___g___u_c_s___b_c___d_i_a_g___t_y_p_e_s_ga08b88fcd49483ac8d0ce004c104a4c12.html#gga08b88fcd49483ac8d0ce004c104a4c12aa33f4df6db0d7b979097f3ea10b680af">UCS_BCD_RES_NO_RING_BREAK</a> </td><td>segment number </td><td>No ring break detected. <em>segment</em> = number of nodes - 1. </td></tr> +<tr> +<td><a class="el" href="group___g___u_c_s___b_c___d_i_a_g___t_y_p_e_s_ga08b88fcd49483ac8d0ce004c104a4c12.html#gga08b88fcd49483ac8d0ce004c104a4c12a135f26c3f41683d98230208b952f238f">UCS_BCD_RES_RING_BREAK</a> </td><td>segment number </td><td>Ring break detected in current segment. </td></tr> +<tr> +<td><a class="el" href="group___g___u_c_s___b_c___d_i_a_g___t_y_p_e_s_ga08b88fcd49483ac8d0ce004c104a4c12.html#gga08b88fcd49483ac8d0ce004c104a4c12a249b89261ce8db86eca6d76f43b84e1b">UCS_BCD_RES_TIMEOUT1</a> </td><td>segment number </td><td>Error during diagnosis: no communication on back channel. </td></tr> +<tr> +<td><a class="el" href="group___g___u_c_s___b_c___d_i_a_g___t_y_p_e_s_ga08b88fcd49483ac8d0ce004c104a4c12.html#gga08b88fcd49483ac8d0ce004c104a4c12a5782a90257b123278c8ebb4a17b2f264">UCS_BCD_RES_TIMEOUT2</a> </td><td><a class="el" href="group___g___u_c_s___b_c___d_i_a_g___t_y_p_e_s_ga8ea444dafcef542cfafee9ee0e74a104.html#ga8ea444dafcef542cfafee9ee0e74a104">UCS_BCD_DUMMY_SEGMENT</a> </td><td>Error during diagnosis: no result received from local INIC. </td></tr> +<tr> +<td><a class="el" href="group___g___u_c_s___b_c___d_i_a_g___t_y_p_e_s_ga08b88fcd49483ac8d0ce004c104a4c12.html#gga08b88fcd49483ac8d0ce004c104a4c12a3a7748f1c2bab68f1c7969cfec95dabf">UCS_BCD_RES_ERROR</a> </td><td><a class="el" href="group___g___u_c_s___b_c___d_i_a_g___t_y_p_e_s_ga8ea444dafcef542cfafee9ee0e74a104.html#ga8ea444dafcef542cfafee9ee0e74a104">UCS_BCD_DUMMY_SEGMENT</a> </td><td>An unexcpected error occurred. BackChannel Diagnosis was stopped. </td></tr> +<tr> +<td><a class="el" href="group___g___u_c_s___b_c___d_i_a_g___t_y_p_e_s_ga08b88fcd49483ac8d0ce004c104a4c12.html#gga08b88fcd49483ac8d0ce004c104a4c12a9cde6e2034d4ab681bc6978edb671b1e">UCS_BCD_RES_END</a> </td><td><a class="el" href="group___g___u_c_s___b_c___d_i_a_g___t_y_p_e_s_ga8ea444dafcef542cfafee9ee0e74a104.html#ga8ea444dafcef542cfafee9ee0e74a104">UCS_BCD_DUMMY_SEGMENT</a> </td><td>BackChannel Diagnosis ended regularly. </td></tr> +</table> +</div></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> |