diff options
| author |   Fulup Ar Foll <fulup@iot.bzh> | 2017-05-26 18:45:56 +0200 |
|---|---|---|
| committer | Fulup Ar Foll <fulup@iot.bzh> | 2017-05-26 18:45:56 +0200 |
| commit | d2e42029ec04c3f224580f8007cdfbbfe0fc47a6 (patch) | |
| tree | ad2ccf167cf7997c84191d41e6ba55cb2efd6bed /ucs2-lib/doc/html/group___g___u_c_s___g_p_i_o.html | |
| parent | 18e393e1443fd4c38b34979888fb55d30448cf31 (diff) | |
Initial Commit
Diffstat (limited to 'ucs2-lib/doc/html/group___g___u_c_s___g_p_i_o.html')
| -rw-r--r-- | ucs2-lib/doc/html/group___g___u_c_s___g_p_i_o.html | 153 |
1 files changed, 153 insertions, 0 deletions
diff --git a/ucs2-lib/doc/html/group___g___u_c_s___g_p_i_o.html b/ucs2-lib/doc/html/group___g___u_c_s___g_p_i_o.html new file mode 100644 index 0000000..02e2313 --- /dev/null +++ b/ucs2-lib/doc/html/group___g___u_c_s___g_p_i_o.html @@ -0,0 +1,153 @@ +<!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: GPIO</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="header"> + <div class="summary"> +<a href="#groups">Topics</a> | +<a href="#nested-classes">Data Structures</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">GPIO</div> </div> +<div class="ingroups"><a class="el" href="group___g___u_c_s___p_b_i.html">Peripheral Bus Interface</a></div></div><!--header--> +<div class="contents"> + +<p>Provides service functions to handle data communication over GPIO. +<a href="#details">More...</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a> +Topics</h2></td></tr> +<tr class="memitem:group___g___u_c_s___g_p_i_o___t_y_p_e_s"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___g_p_i_o___t_y_p_e_s.html">GPIO Referred Types</a></td></tr> +<tr class="memdesc:group___g___u_c_s___g_p_i_o___t_y_p_e_s"><td class="mdescLeft"> </td><td class="mdescRight">Referred types used by the Extended Resource Manager. <br/></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> +Data Structures</h2></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ucs___gpio___init_data__t.html">Ucs_Gpio_InitData_t</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The initialization structure of the GPIO Module. <a href="struct_ucs___gpio___init_data__t.html#details">More...</a><br/></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:ga76f4de37c98b0cdd7cc25a22a9dac8a9"><td class="memItemLeft" align="right" valign="top"><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> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___g_p_i_o_ga76f4de37c98b0cdd7cc25a22a9dac8a9.html#ga76f4de37c98b0cdd7cc25a22a9dac8a9">Ucs_Gpio_CreatePort</a> (<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> *self, uint16_t destination_address, uint8_t index, uint16_t debounce_time, <a class="el" href="group___g___u_c_s___g_p_i_o___t_y_p_e_s_ga14238b74c9e86db4e775461f2cf9b1cb.html#ga14238b74c9e86db4e775461f2cf9b1cb">Ucs_Gpio_CreatePortResCb_t</a> result_fptr)</td></tr> +<tr class="memdesc:ga76f4de37c98b0cdd7cc25a22a9dac8a9"><td class="mdescLeft"> </td><td class="mdescRight">Creates the GPIO port with its associated port instance identifier. <a href="#ga76f4de37c98b0cdd7cc25a22a9dac8a9"></a><br/></td></tr> +<tr class="separator:ga76f4de37c98b0cdd7cc25a22a9dac8a9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf9ecc1f20870bf49d40521db09854a68"><td class="memItemLeft" align="right" valign="top"><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> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___g_p_i_o_gaf9ecc1f20870bf49d40521db09854a68.html#gaf9ecc1f20870bf49d40521db09854a68">Ucs_Gpio_SetPinMode</a> (<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> *self, uint16_t destination_address, uint16_t gpio_port_handle, uint8_t pin, <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> mode, <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> result_fptr)</td></tr> +<tr class="memdesc:gaf9ecc1f20870bf49d40521db09854a68"><td class="mdescLeft"> </td><td class="mdescRight">Configures the pin mode of the given GPIO port. <a href="#gaf9ecc1f20870bf49d40521db09854a68"></a><br/></td></tr> +<tr class="separator:gaf9ecc1f20870bf49d40521db09854a68"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga10b73bad28ba7e0f24d3676f082a11a1"><td class="memItemLeft" align="right" valign="top"><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> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___g_p_i_o_ga10b73bad28ba7e0f24d3676f082a11a1.html#ga10b73bad28ba7e0f24d3676f082a11a1">Ucs_Gpio_GetPinMode</a> (<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> *self, uint16_t destination_address, uint16_t gpio_port_handle, <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> result_fptr)</td></tr> +<tr class="memdesc:ga10b73bad28ba7e0f24d3676f082a11a1"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the pin mode configuration of the given GPIO port. <a href="#ga10b73bad28ba7e0f24d3676f082a11a1"></a><br/></td></tr> +<tr class="separator:ga10b73bad28ba7e0f24d3676f082a11a1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaff68acc9fb26096cae9374694b43ae92"><td class="memItemLeft" align="right" valign="top"><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> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___g_p_i_o_gaff68acc9fb26096cae9374694b43ae92.html#gaff68acc9fb26096cae9374694b43ae92">Ucs_Gpio_WritePort</a> (<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> *self, uint16_t destination_address, uint16_t gpio_port_handle, uint16_t mask, uint16_t data, <a class="el" href="group___g___u_c_s___g_p_i_o___t_y_p_e_s_ga106c6afdd6f996c8bc5d632f08236912.html#ga106c6afdd6f996c8bc5d632f08236912">Ucs_Gpio_PinStateResCb_t</a> result_fptr)</td></tr> +<tr class="memdesc:gaff68acc9fb26096cae9374694b43ae92"><td class="mdescLeft"> </td><td class="mdescRight">Writes data to the given GPIO port. <a href="#gaff68acc9fb26096cae9374694b43ae92"></a><br/></td></tr> +<tr class="separator:gaff68acc9fb26096cae9374694b43ae92"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa2dc67622555e9e64e4bb524a8e18642"><td class="memItemLeft" align="right" valign="top"><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> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___g_p_i_o_gaa2dc67622555e9e64e4bb524a8e18642.html#gaa2dc67622555e9e64e4bb524a8e18642">Ucs_Gpio_ReadPort</a> (<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> *self, uint16_t destination_address, uint16_t gpio_port_handle, <a class="el" href="group___g___u_c_s___g_p_i_o___t_y_p_e_s_ga106c6afdd6f996c8bc5d632f08236912.html#ga106c6afdd6f996c8bc5d632f08236912">Ucs_Gpio_PinStateResCb_t</a> result_fptr)</td></tr> +<tr class="memdesc:gaa2dc67622555e9e64e4bb524a8e18642"><td class="mdescLeft"> </td><td class="mdescRight">Reads the pin state of the given GPIO port. <a href="#gaa2dc67622555e9e64e4bb524a8e18642"></a><br/></td></tr> +<tr class="separator:gaa2dc67622555e9e64e4bb524a8e18642"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<p>Provides service functions to handle data communication over GPIO. </p> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <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> |