diff options
Diffstat (limited to 'ucs2-lib/doc/html/group___g___u_c_s___g_p_i_o_gaf9ecc1f20870bf49d40521db09854a68.html')
| -rw-r--r-- | ucs2-lib/doc/html/group___g___u_c_s___g_p_i_o_gaf9ecc1f20870bf49d40521db09854a68.html | 245 |
1 files changed, 245 insertions, 0 deletions
diff --git a/ucs2-lib/doc/html/group___g___u_c_s___g_p_i_o_gaf9ecc1f20870bf49d40521db09854a68.html b/ucs2-lib/doc/html/group___g___u_c_s___g_p_i_o_gaf9ecc1f20870bf49d40521db09854a68.html new file mode 100644 index 0000000..effbcfe --- /dev/null +++ b/ucs2-lib/doc/html/group___g___u_c_s___g_p_i_o_gaf9ecc1f20870bf49d40521db09854a68.html @@ -0,0 +1,245 @@ +<!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_Gpio_SetPinMode</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('group___g___u_c_s___g_p_i_o.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="contents"> +<a class="anchor" id="gaf9ecc1f20870bf49d40521db09854a68"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <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_Gpio_SetPinMode </td> + <td>(</td> + <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> + <td class="paramname"><em>self</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint16_t </td> + <td class="paramname"><em>destination_address</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint16_t </td> + <td class="paramname"><em>gpio_port_handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint8_t </td> + <td class="paramname"><em>pin</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group___g___u_c_s___g_p_i_o___t_y_p_e_s_gacfcf034325bd7eff2f6fc78e8696ed49.html#gacfcf034325bd7eff2f6fc78e8696ed49">Ucs_Gpio_PinMode_t</a> </td> + <td class="paramname"><em>mode</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group___g___u_c_s___g_p_i_o___t_y_p_e_s_ga69f4d52dfc38232662abd4568e18e3c2.html#ga69f4d52dfc38232662abd4568e18e3c2">Ucs_Gpio_ConfigPinModeResCb_t</a> </td> + <td class="paramname"><em>result_fptr</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Configures the pin mode of the given GPIO port. </p> +<table class="mns_ic_table"> +<tr> +<td id="mns_ic_inic"> </td><td>This function corresponds with the INIC function <a href="_p__u_m__o_s81118.html#MNSH3-GPIOPortPinMode703">INIC.GPIOPortPinMode</a>.</td></tr> +</table> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">self</td><td>The UNICENS instance pointer </td></tr> + <tr><td class="paramname">destination_address</td><td>Address of the target device. Use the <code>UCS_ADDR_LOCAL_DEV</code> macro to target the local device. <br/> + The following address ranges are supported:<ul> +<li>[0x10 ... 0x2FF]</li> +<li>[0x500 ... 0xFEF]</li> +<li>UCS_ADDR_LOCAL_DEV </li> +</ul> +</td></tr> + <tr><td class="paramname">gpio_port_handle</td><td>The GPIO Port resource handle. <table class="mns_param_table"> +<tr> +<td id="mns_param_small"> </td><td><code>GPIOPortHandle</code></td></tr> +</table> +</td></tr> + <tr><td class="paramname">pin</td><td>The GPIO pin that is to be configured. <table class="mns_param_table"> +<tr> +<td id="mns_param_small"> </td><td><code>Pin</code></td></tr> +</table> +</td></tr> + <tr><td class="paramname">mode</td><td>The mode of the GPIO pin. <table class="mns_param_table"> +<tr> +<td id="mns_param_small"> </td><td><code>Mode</code></td></tr> +</table> +</td></tr> + <tr><td class="paramname">result_fptr</td><td>Required result callback function pointer. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Possible return values are shown in the table below. <table class="doxtable"> +<tr> +<th>Value </th><th>Description</th></tr> +<tr> +<td>UCS_RET_SUCCESS </td><td>No error </td></tr> +<tr> +<td>UCS_RET_ERR_PARAM </td><td>At least one parameter is wrong </td></tr> +<tr> +<td>UCS_RET_ERR_BUFFER_OVERFLOW </td><td>No message buffer available </td></tr> +<tr> +<td>UCS_RET_ERR_API_LOCKED </td><td>API is currently locked </td></tr> +<tr> +<td>UCS_RET_ERR_NOT_INITIALIZED </td><td>UNICENS is not initialized </td></tr> +</table> +</dd></dl> +<p><br/> + <b>Example</b> </p> +<div class="fragment"><div class="line"><span class="comment">// Main function</span></div> +<div class="line"><span class="keywordtype">void</span> main()</div> +<div class="line">{</div> +<div class="line"> <span class="comment">// Set configuration of GPIO pin no. 3</span></div> +<div class="line"> <a class="code" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_ga886138f5d13e84ffaa3df5769830e1cd.html#ga886138f5d13e84ffaa3df5769830e1cd" title="Standard return codes used for synchronous response.">Ucs_Return_t</a> result = <a class="code" href="group___g___u_c_s___g_p_i_o_gaf9ecc1f20870bf49d40521db09854a68.html#gaf9ecc1f20870bf49d40521db09854a68" title="Configures the pin mode of the given GPIO port.">Ucs_Gpio_SetPinMode</a>(0x221U, 0x1D00, 0x03U, <a class="code" href="group___g___u_c_s___g_p_i_o___t_y_p_e_s_gacfcf034325bd7eff2f6fc78e8696ed49.html#ggacfcf034325bd7eff2f6fc78e8696ed49a97eb6c69f81b2438926688ef447bf7ee" title="OutputDefaultLow Mode.">UCS_GPIO_OUT_DEFAULT_LOW</a>, &App_GpioConfigPinModeResCb);</div> +<div class="line"> <span class="keywordflow">if</span> (result != <a class="code" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_ga886138f5d13e84ffaa3df5769830e1cd.html#gga886138f5d13e84ffaa3df5769830e1cda3fb51656e17ee4802f23706f35e349bc" title="Operation successfully completed.">UCS_RET_SUCCESS</a>)</div> +<div class="line"> {</div> +<div class="line"> <span class="comment">// Error handling here </span></div> +<div class="line"> }</div> +<div class="line">}</div> +<div class="line"></div> +<div class="line"><span class="comment">// The event handler function</span></div> +<div class="line"><span class="comment">// Handle GpioConfigPinMode event</span></div> +<div class="line"><span class="keyword">static</span> <span class="keywordtype">void</span> App_GpioConfigPinModeResCb(uint16_t device_id, uint16_t port_handle, <a class="code" href="struct_ucs___gpio___pin_configuration__t.html" title="This structure contains information on the GPIO pin configuration.">Ucs_Gpio_PinConfiguration_t</a> pin_cfg_list[], uint8_t list_sz, <a class="code" href="struct_ucs___gpio___result__t.html" title="Result structure of the GPIO Module.">Ucs_Gpio_Result_t</a> result, <span class="keywordtype">void</span> * user_ptr)</div> +<div class="line">{</div> +<div class="line"> <span class="keywordflow">if</span> (result.<a class="code" href="struct_ucs___gpio___result__t_a5a25ac28b5135e04a465fdead03df796.html#a5a25ac28b5135e04a465fdead03df796" title="Result code.">code</a> == <a class="code" href="group___g___u_c_s___g_p_i_o___t_y_p_e_s_ga7432b6d95eb2af7bce5fe5809b08d88b.html#gga7432b6d95eb2af7bce5fe5809b08d88ba00b6d2bbc409c15ce1f4bbdd53dab993" title="GPIO command succeeded.">UCS_GPIO_RES_SUCCESS</a>)</div> +<div class="line"> {</div> +<div class="line"> uint8_t i;</div> +<div class="line"> <span class="keywordflow">for</span> (i = 0U; i < list_sz; i++)</div> +<div class="line"> { </div> +<div class="line"> <span class="comment">// Configuration list of all GPIO pins</span></div> +<div class="line"> <span class="comment">// Check configuration of GPIO pin no. 3 here</span></div> +<div class="line"> <span class="keywordflow">if</span> (pin_cfg_list[i].pin == 3 && pin_cfg_list[i].mode != <a class="code" href="group___g___u_c_s___g_p_i_o___t_y_p_e_s_gacfcf034325bd7eff2f6fc78e8696ed49.html#ggacfcf034325bd7eff2f6fc78e8696ed49a97eb6c69f81b2438926688ef447bf7ee" title="OutputDefaultLow Mode.">UCS_GPIO_OUT_DEFAULT_LOW</a>)</div> +<div class="line"> {</div> +<div class="line"> <span class="comment">// Error handling</span></div> +<div class="line"> }</div> +<div class="line"> }</div> +<div class="line"> }</div> +<div class="line"> <span class="keywordflow">else</span></div> +<div class="line"> {</div> +<div class="line"> <span class="comment">// Error handling here</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="group___g___u_c_s___g_p_i_o.html">GPIO</a></li> + <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:53:00 for UNICENS by +Doxygen 1.8.2 +--> +<script language="javascript"> +<!-- +$('#MSearchResults').wrap('<div style="position: absolute; margin-left: 444px;"></div>'); +--> +</script> +</html> |