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_Xrm_Stream_GetPortConfig</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___x_r_m___s_t_r_e_a_m.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="ga05e65cb477a3ff894de32425eb41294f"></a>
93 <div class="memproto">
94 <table class="memname">
96 <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_Xrm_Stream_GetPortConfig </td>
98 <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>
99 <td class="paramname"><em>self</em>, </td>
102 <td class="paramkey"></td>
104 <td class="paramtype">uint16_t </td>
105 <td class="paramname"><em>destination_address</em>, </td>
108 <td class="paramkey"></td>
110 <td class="paramtype">uint8_t </td>
111 <td class="paramname"><em>index</em>, </td>
114 <td class="paramkey"></td>
116 <td class="paramtype"><a class="el" href="group___g___u_c_s___x_r_m___t_y_p_e_s_gab2f4b821b24db0cec150d1b30fe18783.html#gab2f4b821b24db0cec150d1b30fe18783">Ucs_Xrm_Stream_PortCfgResCb_t</a> </td>
117 <td class="paramname"><em>result_fptr</em> </td>
125 </div><div class="memdoc">
127 <p>This function requests the configurations of a Streaming Port. </p>
128 <table class="mns_ic_table">
130 <td id="mns_ic_inic"> </td><td>This function corresponds with the INIC function <a href="_p__u_m__o_s81118.html#MNSH3-StreamPortConfiguration680">INIC.StreamPortConfiguration</a>.</td></tr>
132 <dl class="params"><dt>Parameters</dt><dd>
133 <table class="params">
134 <tr><td class="paramname">self</td><td>The UNICENS instance pointer </td></tr>
135 <tr><td class="paramname">destination_address</td><td>Device address of the target. Use the <code>UCS_ADDR_LOCAL_DEV</code> macro to target the local device. <br/>
136 The following address ranges are supported:<ul>
137 <li>[0x10 ... 0x2FF]</li>
138 <li>[0x500 ... 0xFEF]</li>
139 <li>UCS_ADDR_LOCAL_DEV </li>
142 <tr><td class="paramname">index</td><td>Streaming Port instance. <table class="mns_param_table">
144 <td id="mns_param_small"> </td><td><code>Index</code></td></tr>
147 <tr><td class="paramname">result_fptr</td><td>Required result callback </td></tr>
151 <dl class="section return"><dt>Returns</dt><dd>Possible return values are shown in the table below. <table class="doxtable">
153 <th>Value </th><th>Description</th></tr>
155 <td>UCS_RET_SUCCESS </td><td>No error </td></tr>
157 <td>UCS_RET_ERR_PARAM </td><td>At least one parameter is wrong </td></tr>
159 <td>UCS_RET_ERR_BUFFER_OVERFLOW </td><td>No message buffer available </td></tr>
161 <td>UCS_RET_ERR_API_LOCKED </td><td>API is currently locked </td></tr>
163 <td>UCS_RET_ERR_NOT_INITIALIZED </td><td>UNICENS is not initialized </td></tr>
168 <div class="fragment"><div class="line"><span class="comment">// Main function</span></div>
169 <div class="line"><span class="keywordtype">void</span> main()</div>
170 <div class="line">{</div>
171 <div class="line"> (void)<a class="code" href="group___g___u_c_s___x_r_m___s_t_r_e_a_m_ga05e65cb477a3ff894de32425eb41294f.html#ga05e65cb477a3ff894de32425eb41294f" title="This function requests the configurations of a Streaming Port.">Ucs_Xrm_Stream_GetPortConfig</a>(ucs_inst_ptr, 0x555U, 0x0U, &App_XrmStreamPortCfgResCb);</div>
172 <div class="line">} </div>
173 <div class="line"></div>
174 <div class="line"><span class="comment">// The streaming port result callback function</span></div>
175 <div class="line"><span class="keyword">static</span> <span class="keywordtype">void</span> App_XrmStreamPortCfgResCb(uint16_t node_address,</div>
176 <div class="line"> uint8_t index,</div>
177 <div class="line"> <a class="code" href="group___g___u_c_s___x_r_m___e_n_u_m_ga6ea92012ace1c507dab36b727698a08e.html#ga6ea92012ace1c507dab36b727698a08e" title="Operation mode of the Streaming Port.">Ucs_Stream_PortOpMode_t</a> op_mode,</div>
178 <div class="line"> <a class="code" href="group___g___u_c_s___x_r_m___e_n_u_m_ga83e210aa76632ea2191bd59ef7894432.html#ga83e210aa76632ea2191bd59ef7894432" title="Direction of the physical pins of the indexed Streaming Port.">Ucs_Stream_PortOption_t</a> port_option,</div>
179 <div class="line"> <a class="code" href="group___g___u_c_s___x_r_m___e_n_u_m_ga3139c2b4d435622104235bd9fd9f478c.html#ga3139c2b4d435622104235bd9fd9f478c" title="Indicates if FSY/SCK signals are configured as outputs or inputs.">Ucs_Stream_PortClockMode_t</a> clock_mode,</div>
180 <div class="line"> <a class="code" href="group___g___u_c_s___x_r_m___e_n_u_m_ga16d6cd08e925676dfade13e980f460b0.html#ga16d6cd08e925676dfade13e980f460b0" title="This setting is only applicable to data pins used for Generic Streaming including any linked pins to ...">Ucs_Stream_PortClockDataDelay_t</a> clock_data_delay,</div>
181 <div class="line"> <a class="code" href="struct_ucs___std_result__t.html" title="Standard result structure which provides fields for detailed status and error information.">Ucs_StdResult_t</a> result,</div>
182 <div class="line"> <span class="keywordtype">void</span> *user_ptr)</div>
183 <div class="line">{</div>
184 <div class="line"> <span class="keywordflow">if</span> (result.<a class="code" href="struct_ucs___std_result__t_a02d8eefc721a797ac87f5030774972ef.html#a02d8eefc721a797ac87f5030774972ef" title="Result/Error code.">code</a> == <a class="code" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_gac844b77cf41aef663782bc0b43d3540c.html#ggac844b77cf41aef663782bc0b43d3540cae19d5a51de78bbf903a108a4e36a0fdf" title="Operation successfully completed.">UCS_RES_SUCCESS</a>)</div>
185 <div class="line"> {</div>
186 <div class="line"> <span class="comment">// Read Streaming ports configuration here...</span></div>
187 <div class="line"> }</div>
188 <div class="line">}</div>
189 </div><!-- fragment -->
192 </div><!-- contents -->
193 </div><!-- doc-content -->
194 <!-- start footer part -->
195 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
197 <li class="navelem"><a class="el" href="group___g___u_c_s___x_r_m___s_t_r_e_a_m.html">Additional Streaming Port Functions</a></li>
198 <li class="footer">© 2017 Microchip Technology Inc. All rights reserved. <a href="http://www.microchip.com" target="_blank">www.microchip.com</a></li>
203 Generated on Mon Apr 3 2017 13:52:59 for UNICENS by
206 <script language="javascript">
208 $('#MSearchResults').wrap('<div style="position: absolute; margin-left: 444px;"></div>');