diff options
Diffstat (limited to 'ucs2-lib/doc/html/group___g___u_c_s___i2_c.html')
| -rw-r--r-- | ucs2-lib/doc/html/group___g___u_c_s___i2_c.html | 147 |
1 files changed, 147 insertions, 0 deletions
diff --git a/ucs2-lib/doc/html/group___g___u_c_s___i2_c.html b/ucs2-lib/doc/html/group___g___u_c_s___i2_c.html new file mode 100644 index 0000000..0dc4349 --- /dev/null +++ b/ucs2-lib/doc/html/group___g___u_c_s___i2_c.html @@ -0,0 +1,147 @@ +<!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: I2C</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___i2_c.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">I2C</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 I2C. +<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___i2_c___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___i2_c___t_y_p_e_s.html">I2C Referred Types</a></td></tr> +<tr class="memdesc:group___g___u_c_s___i2_c___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___i2c___init_data__t.html">Ucs_I2c_InitData_t</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The initialization structure of the I2C Module. <a href="struct_ucs___i2c___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:gac06f58d8a7775703373f12c3c677d687"><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___i2_c_gac06f58d8a7775703373f12c3c677d687.html#gac06f58d8a7775703373f12c3c677d687">Ucs_I2c_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, <a class="el" href="group___g___u_c_s___i2_c___t_y_p_e_s_ga8492cc027b5b9e2f436a172e526e1d5e.html#ga8492cc027b5b9e2f436a172e526e1d5e">Ucs_I2c_Speed_t</a> speed, uint8_t i2c_int_mask, <a class="el" href="group___g___u_c_s___i2_c___t_y_p_e_s_gae1f1b25aca1c240022464571187ea98f.html#gae1f1b25aca1c240022464571187ea98f">Ucs_I2c_CreatePortResCb_t</a> result_fptr)</td></tr> +<tr class="memdesc:gac06f58d8a7775703373f12c3c677d687"><td class="mdescLeft"> </td><td class="mdescRight">Creates an I2C Port with its associated parameter. <a href="#gac06f58d8a7775703373f12c3c677d687"></a><br/></td></tr> +<tr class="separator:gac06f58d8a7775703373f12c3c677d687"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gade4a94669fe4f29f18fe5bfd4e102474"><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___i2_c_gade4a94669fe4f29f18fe5bfd4e102474.html#gade4a94669fe4f29f18fe5bfd4e102474">Ucs_I2c_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 port_handle, <a class="el" href="group___g___u_c_s___i2_c___t_y_p_e_s_ga631c2b70299a4c07ac77b6741b5b5e44.html#ga631c2b70299a4c07ac77b6741b5b5e44">Ucs_I2c_TrMode_t</a> mode, uint8_t block_count, uint8_t slave_address, uint16_t timeout, uint8_t data_len, uint8_t *data_ptr, <a class="el" href="group___g___u_c_s___i2_c___t_y_p_e_s_ga50029da1794f34d3ddac9df8d537c234.html#ga50029da1794f34d3ddac9df8d537c234">Ucs_I2c_WritePortResCb_t</a> result_fptr)</td></tr> +<tr class="memdesc:gade4a94669fe4f29f18fe5bfd4e102474"><td class="mdescLeft"> </td><td class="mdescRight">Writes a block of bytes to an I2C device at a specified I2C address. <a href="#gade4a94669fe4f29f18fe5bfd4e102474"></a><br/></td></tr> +<tr class="separator:gade4a94669fe4f29f18fe5bfd4e102474"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga153f7ce3ea500b2f39544e0ccfc86503"><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___i2_c_ga153f7ce3ea500b2f39544e0ccfc86503.html#ga153f7ce3ea500b2f39544e0ccfc86503">Ucs_I2c_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 port_handle, uint8_t slave_address, uint8_t data_len, uint16_t timeout, <a class="el" href="group___g___u_c_s___i2_c___t_y_p_e_s_ga8dd5d3515acabc6a95e9bf32629eb644.html#ga8dd5d3515acabc6a95e9bf32629eb644">Ucs_I2c_ReadPortResCb_t</a> result_fptr)</td></tr> +<tr class="memdesc:ga153f7ce3ea500b2f39544e0ccfc86503"><td class="mdescLeft"> </td><td class="mdescRight">Reads a block of bytes from an I2C device at a specified I2C address. <a href="#ga153f7ce3ea500b2f39544e0ccfc86503"></a><br/></td></tr> +<tr class="separator:ga153f7ce3ea500b2f39544e0ccfc86503"><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 I2C. </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> |