ucs2-lib/doc/html/_p__u_m__b_a_c_k_c_h_a_n_n_e_l__d_i_a_g.html

   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 <title>UNICENS: BackChannel Diagnosis</title>
   7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   8 <link rel="shortcut icon" type="image/x-icon" href="favicon.ico">
   9 <script type="text/javascript" src="jquery.js"></script>
  10 <script type="text/javascript" src="dynsections.js"></script>
  11 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  12 <script type="text/javascript" src="resize.js"></script>
  13 <script type="text/javascript" src="navtree.js"></script>
  14 <script type="text/javascript">
  15   $(document).ready(initResizable);
  16 </script>
  17 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  18 <script type="text/javascript" src="search/search.js"></script>
  19 <script type="text/javascript">
  20   $(document).ready(function() { searchBox.OnSelectItem(0); });
  21 </script>
  22 <link href="style_html.css" rel="stylesheet" type="text/css" />
  23 <link href="inic.css" rel="stylesheet" type="text/css"/>
  24 </head>
  25 <body>
  26 <div class="GlobalWrapper">
  27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  28 <div id="titlearea">
  29 <table cellspacing="0" cellpadding="0">
  30  <tbody>
  31  <tr>
  32   <td><a href="index.html"><img alt="Logo" src="logo.png"/></a></td>
  33   <td>
  34    <div id="projectname">UNICENS&#160;<span id="projectnumber">V2.1.0-3491</span></div>
  35    <div id="projectbrief">User Manual and API Reference</div>
  36     <div id="searchbox">        <div id="MSearchBox" class="MSearchBoxInactive">
  37         <span class="left">
  38           <img id="MSearchSelect" src="search/mag_sel.png"
  39                onmouseover="return searchBox.OnSearchSelectShow()"
  40                onmouseout="return searchBox.OnSearchSelectHide()"
  41                alt=""/>
  42           <input type="text" id="MSearchField" value="Search" accesskey="S"
  43                onfocus="searchBox.OnSearchFieldFocus(true)"
  44                onblur="searchBox.OnSearchFieldFocus(false)"
  45                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  46           </span><span class="right">
  47             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  48           </span>
  49         </div>
  50 </div>
  51   </td>
  52  </tr>
  53  </tbody>
  54 </table>
  55 </div>
  56 <!-- end header part -->
  57 <!-- Generated by Doxygen 1.8.2 -->
  58 <script type="text/javascript">
  59 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  60 </script>
  61 </div><!-- top -->
  62 <div id="side-nav" class="ui-resizable side-nav-resizable">
  63   <div id="nav-tree">
  64     <div id="nav-tree-contents">
  65       <div id="nav-sync" class="sync"></div>
  66     </div>
  67   </div>
  68   <div id="splitbar" style="-moz-user-select:none;"
  69        class="ui-resizable-handle">
  70   </div>
  71 </div>
  72 <script type="text/javascript">
  73 $(document).ready(function(){initNavTree('_p__u_m__b_a_c_k_c_h_a_n_n_e_l__d_i_a_g.html','');});
  74 </script>
  75 <div id="doc-content">
  76 <!-- window showing the filter options -->
  77 <div id="MSearchSelectWindow"
  78      onmouseover="return searchBox.OnSearchSelectShow()"
  79      onmouseout="return searchBox.OnSearchSelectHide()"
  80      onkeydown="return searchBox.OnSearchSelectKey(event)">
  81 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  82
  83 <!-- iframe showing the search results (closed by default) -->
  84 <div id="MSearchResultsWindow">
  85 <iframe src="javascript:void(0)" frameborder="0"
  86         name="MSearchResults" id="MSearchResults">
  87 </iframe>
  88 </div>
  89
  90 <div class="header">
  91   <div class="headertitle">
  92 <div class="title">BackChannel Diagnosis </div>  </div>
  93 </div><!--header-->
  94 <div class="contents">
  95 <div class="textblock"><h1>Introduction</h1>
  96 <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>
  97 <p>It cannot be performed during Node Discovery or Programming service.</p>
  98 <h1>Operation</h1>
  99 <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>
 100 <p>Segment number 0 denotes the segment following the TimingMaster.</p>
 101 <table class="doxtable">
 102 <tr>
 103 <th>Parameter <em>code</em> </th><th>Parameter <em>segment</em> </th><th>Description</th></tr>
 104 <tr>
 105 <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>
 106 <tr>
 107 <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>
 108 <tr>
 109 <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>
 110 <tr>
 111 <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>
 112 <tr>
 113 <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>
 114 <tr>
 115 <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>
 116 <tr>
 117 <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>
 118 </table>
 119 </div></div><!-- contents -->
 120 </div><!-- doc-content -->
 121 <!-- start footer part -->
 122 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 123   <ul>
 124     <li class="footer">&copy; 2017 Microchip Technology Inc. All rights reserved. <a href="http://www.microchip.com" target="_blank">www.microchip.com</a></li>
 125   </ul>
 126 </div>
 127 </body>
 128 <!--
 129 Generated on Mon Apr 3 2017 13:52:59 for UNICENS by
 130 Doxygen 1.8.2
 131 -->
 132 <script language="javascript">
 133 <!--
 134 $('#MSearchResults').wrap('<div style="position: absolute; margin-left: 444px;"></div>');
 135 -->
 136 </script>
 137 </html>