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">
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: Ucs_Network_AvailInfo_t</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);
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); });
22 <link href="style_html.css" rel="stylesheet" type="text/css" />
23 <link href="inic.css" rel="stylesheet" type="text/css"/>
26 <div class="GlobalWrapper">
27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
29 <table cellspacing="0" cellpadding="0">
32 <td><a href="index.html"><img alt="Logo" src="logo.png"/></a></td>
34 <div id="projectname">UNICENS <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">
38 <img id="MSearchSelect" src="search/mag_sel.png"
39 onmouseover="return searchBox.OnSearchSelectShow()"
40 onmouseout="return searchBox.OnSearchSelectHide()"
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>
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');
62 <div id="side-nav" class="ui-resizable side-nav-resizable">
64 <div id="nav-tree-contents">
65 <div id="nav-sync" class="sync"></div>
68 <div id="splitbar" style="-moz-user-select:none;"
69 class="ui-resizable-handle">
72 <script type="text/javascript">
73 $(document).ready(function(){initNavTree('group___g___u_c_s___n_e_t___t_y_p_e_s.html','');});
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"> </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>
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">
90 <div class="contents">
91 <a class="anchor" id="gad5ed0387c3c156602826d50ce94c9df7"></a>
93 <div class="memproto">
94 <table class="memname">
96 <td class="memname">enum <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></td>
99 </div><div class="memdoc">
101 <p>MOST Network Availability Information. </p>
102 <p>AvailabilityInfo is a sub state of Availability (<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>) Possible pairs of Availability and Availability Information </p>
103 <table class="doxtable">
105 <th>Availability </th><th>Availability Information</th></tr>
107 <td>UCS_NW_NOT_AVAILABLE </td><td>UCS_NW_AVAIL_INFO_REGULAR </td></tr>
109 <td>UCS_NW_NOT_AVAILABLE </td><td>UCS_NW_AVAIL_INFO_DIAGNOSIS </td></tr>
111 <td>UCS_NW_NOT_AVAILABLE </td><td>UCS_NW_AVAIL_INFO_FORCED_NA </td></tr>
113 <td>UCS_NW_AVAILABLE </td><td>UCS_NW_AVAIL_INFO_UNSTABLE </td></tr>
115 <td>UCS_NW_AVAILABLE </td><td>UCS_NW_AVAIL_INFO_STABLE </td></tr>
117 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
118 <tr><td valign="top"><em><a class="anchor" id="ggad5ed0387c3c156602826d50ce94c9df7ace556bfc10aa45dcd561a6c75680e99e"></a>UCS_NW_AVAIL_INFO_REGULAR</em> </td><td>
119 <p>The network is not available because it is in NetInterface Off or Init state. It is pending to get available again. </p>
121 <tr><td valign="top"><em><a class="anchor" id="ggad5ed0387c3c156602826d50ce94c9df7a754bb411728af7ee41315b2257c9f409"></a>UCS_NW_AVAIL_INFO_DIAGNOSIS</em> </td><td>
122 <p>The network is not available because it performs a ring break diagnosis or physical layer test. </p>
124 <tr><td valign="top"><em><a class="anchor" id="ggad5ed0387c3c156602826d50ce94c9df7a95e0a195f246b6c474781b42fda0e1cb"></a>UCS_NW_AVAIL_INFO_FORCED_NA</em> </td><td>
125 <p>The INIC forces the network to stay in "not available" state. The application may enter or leave this state by calling <a class="el" href="group___g___u_c_s___n_e_t_ga3a71b7772ce265a77eefa7ad069c4819.html#ga3a71b7772ce265a77eefa7ad069c4819" title="Triggers the INIC to force the NotAvailable state.">Ucs_Network_ForceNotAvailable()</a>. Also see <a class="el" href="group___g___u_c_s___n_e_t_ga83c2e74a4cc216aa10d7c6a1a517d459.html#ga83c2e74a4cc216aa10d7c6a1a517d459" title="Starts up the MOST Network.">Ucs_Network_Startup()</a>. </p>
127 <tr><td valign="top"><em><a class="anchor" id="ggad5ed0387c3c156602826d50ce94c9df7a1e35e06faaf9537517a3b77c172c9e6a"></a>UCS_NW_AVAIL_INFO_UNSTABLE</em> </td><td>
128 <p>Network is available. Unlocks have been detected. </p>
130 <tr><td valign="top"><em><a class="anchor" id="ggad5ed0387c3c156602826d50ce94c9df7aac87fccc7041c51b30c04dbd42c963ba"></a>UCS_NW_AVAIL_INFO_STABLE</em> </td><td>
131 <p>Network is available. Network is in Stable Lock. </p>
139 </div><!-- contents -->
140 </div><!-- doc-content -->
141 <!-- start footer part -->
142 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
144 <li class="navelem"><a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s.html">Referred Types</a></li>
145 <li class="footer">© 2017 Microchip Technology Inc. All rights reserved. <a href="http://www.microchip.com" target="_blank">www.microchip.com</a></li>
150 Generated on Mon Apr 3 2017 13:52:59 for UNICENS by
153 <script language="javascript">
155 $('#MSearchResults').wrap('<div style="position: absolute; margin-left: 444px;"></div>');