ucs2-lib/doc/html/struct_ucs___rm___init_data__t_ab3de88c423837727c463947f57895e49.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168

<!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_InitData_t::xrm</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&#160;<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('struct_ucs___rm___init_data__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">&#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>

<!-- 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="ab3de88c423837727c463947f57895e49"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_ucs___xrm___init_data__t.html">Ucs_Xrm_InitData_t</a> xrm</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initialization structure of the Extended Resource Manager. </p>
<p><br/>
 <b>Example</b> </p>
<div class="fragment"><div class="line"><a class="code" href="struct_ucs___init_data__t.html" title="UNICENS initialization structure used by function Ucs_Init().">Ucs_InitData_t</a> ucs_init_data;</div>
<div class="line">(void)<a class="code" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v_ga64b50780725a0dc8693b5b73f8345ad6.html#ga64b50780725a0dc8693b5b73f8345ad6" title="Assigns default values to a provided UNICENS init structure.">Ucs_SetDefaultConfig</a>(&amp;ucs_init_data);</div>
<div class="line"></div>
<div class="line"><span class="comment">// Routing Management init section.</span></div>
<div class="line">ucs_init_data.<a class="code" href="struct_ucs___init_data__t_a8619aaf795810b7508046fbfef6d6907.html#a8619aaf795810b7508046fbfef6d6907" title="The initialization data of the Routing Management.">rm</a>.<a class="code" href="struct_ucs___rm___init_data__t_ab3de88c423837727c463947f57895e49.html#ab3de88c423837727c463947f57895e49" title="Initialization structure of the Extended Resource Manager.">xrm</a>.<a class="code" href="struct_ucs___xrm___init_data__t_a9497e039c582e7d2804ee470d6812e91.html#a9497e039c582e7d2804ee470d6812e91" title="Callback function that reports streaming-related information for the MOST Network Port...">most_port_status_fptr</a>  = &amp;App_MostPortStatusCb;</div>
<div class="line">ucs_init_data.<a class="code" href="struct_ucs___init_data__t_a8619aaf795810b7508046fbfef6d6907.html#a8619aaf795810b7508046fbfef6d6907" title="The initialization data of the Routing Management.">rm</a>.<a class="code" href="struct_ucs___rm___init_data__t_ab3de88c423837727c463947f57895e49.html#ab3de88c423837727c463947f57895e49" title="Initialization structure of the Extended Resource Manager.">xrm</a>.<a class="code" href="struct_ucs___xrm___init_data__t_a7ad953f5414061df43df073ece15e25b.html#a7ad953f5414061df43df073ece15e25b" title="Callback function that signals the EHC to check the mute pin state of devices before attempting unmut...">check_unmute_fptr</a>      = &amp;App_CheckUnmuteStatusCb;</div>
<div class="line">ucs_init_data.<a class="code" href="struct_ucs___init_data__t_a8619aaf795810b7508046fbfef6d6907.html#a8619aaf795810b7508046fbfef6d6907" title="The initialization data of the Routing Management.">rm</a>.<a class="code" href="struct_ucs___rm___init_data__t_ab3de88c423837727c463947f57895e49.html#ab3de88c423837727c463947f57895e49" title="Initialization structure of the Extended Resource Manager.">xrm</a>.debug_resource_status_fptr = &amp;App_OnDebuggingXrmResources;</div>
<div class="line"></div>
<div class="line"><span class="comment">// Handle MOST Port Status event here</span></div>
<div class="line"><span class="keywordtype">void</span> App_MostPortStatusCb(uint16_t most_port_handle,</div>
<div class="line">                          <a class="code" href="group___g___u_c_s___x_r_m___e_n_u_m_ga902951b9083ff58a88e19e151b57106a.html#ga902951b9083ff58a88e19e151b57106a" title="Indicates if the MOST Network Port is available and ready for streaming data connections.">Ucs_Most_PortAvail_t</a> availability,</div>
<div class="line">                          <a class="code" href="group___g___u_c_s___x_r_m___e_n_u_m_ga24bf81b4e52fc1fb01deba9165d7c79e.html#ga24bf81b4e52fc1fb01deba9165d7c79e" title="Indicates the sub state to parameter Available.">Ucs_Most_PortAvailInfo_t</a> avail_info,</div>
<div class="line">                          uint16_t free_streaming_bw)</div>
<div class="line">{</div>
<div class="line">    <span class="comment">// Do what needs to be..</span></div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="comment">// Handle the Mute Pin check here</span></div>
<div class="line"><span class="keywordtype">void</span> App_CheckUnmuteStatusCb (uint16_t node_address)</div>
<div class="line">{</div>
<div class="line">    <span class="comment">// Check the state of the mute pin here before unmuting</span></div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="comment">// Debug interface for the XRM resources</span></div>
<div class="line"><span class="keywordtype">void</span> App_OnDebuggingXrmResources (<a class="code" href="group___g___u_c_s___x_r_m___t_y_p_e_s_gac238d98be8f9df6340eb4ee72de36ccc.html#gac238d98be8f9df6340eb4ee72de36ccc" title="INIC resource types used by the Extended Resource Manager.">Ucs_Xrm_ResourceType_t</a> resource_type, <a class="code" href="group___g___u_c_s___x_r_m___t_y_p_e_s_ga74e06fedcde6bc971088b2cb21405173.html#ga74e06fedcde6bc971088b2cb21405173" title="INIC Resource Object used for Extended Resource Manager jobs.">Ucs_Xrm_ResObject_t</a> *resource_ptr, <a class="code" href="group___g___u_c_s___x_r_m___t_y_p_e_s_ga5299ac232aaeba37eb6fceb53e32b2ea.html#ga5299ac232aaeba37eb6fceb53e32b2ea" title="This enumerator specifies the type of resources information.">Ucs_Xrm_ResourceInfos_t</a> resource_infos, <span class="keywordtype">void</span> *user_ptr)</div>
<div class="line">{</div>
<div class="line">   <span class="keywordflow">switch</span> (resource_infos)</div>
<div class="line">   {</div>
<div class="line">   <span class="keywordflow">case</span> <a class="code" href="group___g___u_c_s___x_r_m___t_y_p_e_s_ga5299ac232aaeba37eb6fceb53e32b2ea.html#gga5299ac232aaeba37eb6fceb53e32b2eaaf17abdbe8fab65a069b6a8af1079066a" title="Signals that the resource is built.">UCS_XRM_INFOS_BUILT</a>:</div>
<div class="line">     <span class="comment">// Resource has been built</span></div>
<div class="line">     <span class="keywordflow">break</span>;</div>
<div class="line">   <span class="keywordflow">case</span> <a class="code" href="group___g___u_c_s___x_r_m___t_y_p_e_s_ga5299ac232aaeba37eb6fceb53e32b2ea.html#gga5299ac232aaeba37eb6fceb53e32b2eaa6e7faa32a0cb82c3fdf4450d80188262" title="Signals that the resource is destroyed.">UCS_XRM_INFOS_DESTROYED</a>:</div>
<div class="line">     <span class="comment">// resource has been destroyed</span></div>
<div class="line">     <span class="keywordflow">break</span>;</div>
<div class="line">   <span class="keywordflow">case</span> <a class="code" href="group___g___u_c_s___x_r_m___t_y_p_e_s_ga5299ac232aaeba37eb6fceb53e32b2ea.html#gga5299ac232aaeba37eb6fceb53e32b2eaac57d4f29bbfd2f62eefddc4e31a7ad81" title="Signals that XRM fails to build the resource.">UCS_XRM_INFOS_ERR_BUILT</a>:</div>
<div class="line">     <span class="comment">//Resource cannot be built</span></div>
<div class="line">     <span class="keywordflow">break</span>;</div>
<div class="line">   <span class="keywordflow">default</span>:</div>
<div class="line">     <span class="comment">// Resource cannot be destroyed</span></div>
<div class="line">     <span class="keywordflow">break</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="struct_ucs___rm___init_data__t.html">Ucs_Rm_InitData_t</a></li>
    <li class="footer">&copy; 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:01 for UNICENS by
Doxygen 1.8.2
-->
<script language="javascript">
<!--
$('#MSearchResults').wrap('<div style="position: absolute; margin-left: 444px;"></div>');
-->
</script>
</html>