diff options
Diffstat (limited to 'ucs2-lib/doc/html/group___g___u_c_s___i2_c___t_y_p_e_s.html')
| -rw-r--r-- | ucs2-lib/doc/html/group___g___u_c_s___i2_c___t_y_p_e_s.html | 186 |
1 files changed, 186 insertions, 0 deletions
diff --git a/ucs2-lib/doc/html/group___g___u_c_s___i2_c___t_y_p_e_s.html b/ucs2-lib/doc/html/group___g___u_c_s___i2_c___t_y_p_e_s.html new file mode 100644 index 0000000..a7e9347 --- /dev/null +++ b/ucs2-lib/doc/html/group___g___u_c_s___i2_c___t_y_p_e_s.html @@ -0,0 +1,186 @@ +<!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 Referred Types</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___t_y_p_e_s.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="#nested-classes">Data Structures</a> | +<a href="#typedef-members">Callback Functions</a> | +<a href="#enum-members">Enumerations</a> </div> + <div class="headertitle"> +<div class="title">I2C Referred Types</div> </div> +<div class="ingroups"><a class="el" href="group___g___u_c_s___i2_c.html">I2C</a></div></div><!--header--> +<div class="contents"> + +<p>Referred types used by the Extended Resource Manager. +<a href="#details">More...</a></p> +<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___result_details__t.html">Ucs_I2c_ResultDetails_t</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Detailed information used for I2C results. <a href="struct_ucs___i2c___result_details__t.html#details">More...</a><br/></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </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___result__t.html">Ucs_I2c_Result_t</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Result structure of the I2C Module. <a href="struct_ucs___i2c___result__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="typedef-members"></a> +Callback Functions</h2></td></tr> +<tr class="memitem:gae1f1b25aca1c240022464571187ea98f"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___i2_c___t_y_p_e_s_gae1f1b25aca1c240022464571187ea98f.html#gae1f1b25aca1c240022464571187ea98f">Ucs_I2c_CreatePortResCb_t</a> )(uint16_t node_address, uint16_t i2c_port_handle, <a class="el" href="struct_ucs___i2c___result__t.html">Ucs_I2c_Result_t</a> result, void *user_ptr)</td></tr> +<tr class="memdesc:gae1f1b25aca1c240022464571187ea98f"><td class="mdescLeft"> </td><td class="mdescRight">Callback function type to retrieve the result of the I2c_CreatePort function. <a href="#gae1f1b25aca1c240022464571187ea98f"></a><br/></td></tr> +<tr class="separator:gae1f1b25aca1c240022464571187ea98f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga50029da1794f34d3ddac9df8d537c234"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___i2_c___t_y_p_e_s_ga50029da1794f34d3ddac9df8d537c234.html#ga50029da1794f34d3ddac9df8d537c234">Ucs_I2c_WritePortResCb_t</a> )(uint16_t node_address, uint16_t i2c_port_handle, uint8_t i2c_slave_address, uint8_t data_len, <a class="el" href="struct_ucs___i2c___result__t.html">Ucs_I2c_Result_t</a> result, void *user_ptr)</td></tr> +<tr class="memdesc:ga50029da1794f34d3ddac9df8d537c234"><td class="mdescLeft"> </td><td class="mdescRight">Callback function type to retrieve the result of the Gpio_ConfigPinMode function. <a href="#ga50029da1794f34d3ddac9df8d537c234"></a><br/></td></tr> +<tr class="separator:ga50029da1794f34d3ddac9df8d537c234"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga8dd5d3515acabc6a95e9bf32629eb644"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___i2_c___t_y_p_e_s_ga8dd5d3515acabc6a95e9bf32629eb644.html#ga8dd5d3515acabc6a95e9bf32629eb644">Ucs_I2c_ReadPortResCb_t</a> )(uint16_t node_address, uint16_t i2c_port_handle, uint8_t i2c_slave_address, uint8_t data_len, uint8_t data_ptr[], <a class="el" href="struct_ucs___i2c___result__t.html">Ucs_I2c_Result_t</a> result, void *user_ptr)</td></tr> +<tr class="memdesc:ga8dd5d3515acabc6a95e9bf32629eb644"><td class="mdescLeft"> </td><td class="mdescRight">Callback function type to retrieve the result of the Gpio_ConfigPinMode function. <a href="#ga8dd5d3515acabc6a95e9bf32629eb644"></a><br/></td></tr> +<tr class="separator:ga8dd5d3515acabc6a95e9bf32629eb644"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3bdd3013545f8249a73c73e0d28713f7"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___i2_c___t_y_p_e_s_ga3bdd3013545f8249a73c73e0d28713f7.html#ga3bdd3013545f8249a73c73e0d28713f7">Ucs_I2c_IntEventReportCb_t</a> )(uint16_t node_address, void *user_ptr)</td></tr> +<tr class="memdesc:ga3bdd3013545f8249a73c73e0d28713f7"><td class="mdescLeft"> </td><td class="mdescRight">Callback function type to report the I2C interrupt event. <a href="#ga3bdd3013545f8249a73c73e0d28713f7"></a><br/></td></tr> +<tr class="separator:ga3bdd3013545f8249a73c73e0d28713f7"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> +Enumerations</h2></td></tr> +<tr class="memitem:ga8492cc027b5b9e2f436a172e526e1d5e"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___i2_c___t_y_p_e_s_ga8492cc027b5b9e2f436a172e526e1d5e.html#ga8492cc027b5b9e2f436a172e526e1d5e">Ucs_I2c_Speed_t</a> { <br/> +  <a class="el" href="group___g___u_c_s___i2_c___t_y_p_e_s_ga8492cc027b5b9e2f436a172e526e1d5e.html#gga8492cc027b5b9e2f436a172e526e1d5ea91d8d37db8f69a15ca3d6d19b3f5d981">UCS_I2C_SLOW_MODE</a> = 0x00U, +<br/> +  <a class="el" href="group___g___u_c_s___i2_c___t_y_p_e_s_ga8492cc027b5b9e2f436a172e526e1d5e.html#gga8492cc027b5b9e2f436a172e526e1d5ea577d5efdff88c202f2e2f43aed2b0391">UCS_I2C_FAST_MODE</a> = 0x01U +<br/> + }</td></tr> +<tr class="memdesc:ga8492cc027b5b9e2f436a172e526e1d5e"><td class="mdescLeft"> </td><td class="mdescRight">The speed grade of the I2C Port. <a href="group___g___u_c_s___i2_c___t_y_p_e_s_ga8492cc027b5b9e2f436a172e526e1d5e.html#ga8492cc027b5b9e2f436a172e526e1d5e">More...</a><br/></td></tr> +<tr class="separator:ga8492cc027b5b9e2f436a172e526e1d5e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga631c2b70299a4c07ac77b6741b5b5e44"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___i2_c___t_y_p_e_s_ga631c2b70299a4c07ac77b6741b5b5e44.html#ga631c2b70299a4c07ac77b6741b5b5e44">Ucs_I2c_TrMode_t</a> { <br/> +  <a class="el" href="group___g___u_c_s___i2_c___t_y_p_e_s_ga631c2b70299a4c07ac77b6741b5b5e44.html#gga631c2b70299a4c07ac77b6741b5b5e44ad6f21f4e04e8f755a59c8e7cef9cb7ad">UCS_I2C_DEFAULT_MODE</a> = 0x00U, +<br/> +  <a class="el" href="group___g___u_c_s___i2_c___t_y_p_e_s_ga631c2b70299a4c07ac77b6741b5b5e44.html#gga631c2b70299a4c07ac77b6741b5b5e44ad5c54c3051eef15fbb36f003dc1633d4">UCS_I2C_REPEATED_MODE</a> = 0x01U, +<br/> +  <a class="el" href="group___g___u_c_s___i2_c___t_y_p_e_s_ga631c2b70299a4c07ac77b6741b5b5e44.html#gga631c2b70299a4c07ac77b6741b5b5e44a3380b0b2a253a389aec424ef348a34b7">UCS_I2C_BURST_MODE</a> = 0x02U +<br/> + }</td></tr> +<tr class="memdesc:ga631c2b70299a4c07ac77b6741b5b5e44"><td class="mdescLeft"> </td><td class="mdescRight">The write transfer mode. <a href="group___g___u_c_s___i2_c___t_y_p_e_s_ga631c2b70299a4c07ac77b6741b5b5e44.html#ga631c2b70299a4c07ac77b6741b5b5e44">More...</a><br/></td></tr> +<tr class="separator:ga631c2b70299a4c07ac77b6741b5b5e44"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga930e829c3c689b8ead8f9fbf7f2ca237"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___i2_c___t_y_p_e_s_ga930e829c3c689b8ead8f9fbf7f2ca237.html#ga930e829c3c689b8ead8f9fbf7f2ca237">Ucs_I2c_ResultCode_t</a> { <br/> +  <a class="el" href="group___g___u_c_s___i2_c___t_y_p_e_s_ga930e829c3c689b8ead8f9fbf7f2ca237.html#gga930e829c3c689b8ead8f9fbf7f2ca237a1f0bb0636d1fbe3a3c94541d3725b864">UCS_I2C_RES_SUCCESS</a> = 0x00U, +<br/> +  <a class="el" href="group___g___u_c_s___i2_c___t_y_p_e_s_ga930e829c3c689b8ead8f9fbf7f2ca237.html#gga930e829c3c689b8ead8f9fbf7f2ca237a7f9bec3206cf8dea98f72710bd6219e8">UCS_I2C_RES_ERR_CMD</a> = 0x01U, +<br/> +  <a class="el" href="group___g___u_c_s___i2_c___t_y_p_e_s_ga930e829c3c689b8ead8f9fbf7f2ca237.html#gga930e829c3c689b8ead8f9fbf7f2ca237a3f4942e0d97505a6f343621b6a5d03a8">UCS_I2C_RES_ERR_SYNC</a> = 0x02U +<br/> + }</td></tr> +<tr class="memdesc:ga930e829c3c689b8ead8f9fbf7f2ca237"><td class="mdescLeft"> </td><td class="mdescRight">Result codes of the I2C Module. <a href="group___g___u_c_s___i2_c___t_y_p_e_s_ga930e829c3c689b8ead8f9fbf7f2ca237.html#ga930e829c3c689b8ead8f9fbf7f2ca237">More...</a><br/></td></tr> +<tr class="separator:ga930e829c3c689b8ead8f9fbf7f2ca237"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga7c7b4521cb5391bd20c02104876a811d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___i2_c___t_y_p_e_s_ga7c7b4521cb5391bd20c02104876a811d.html#ga7c7b4521cb5391bd20c02104876a811d">Ucs_I2c_ResultType_t</a> { <br/> +  <a class="el" href="group___g___u_c_s___i2_c___t_y_p_e_s_ga7c7b4521cb5391bd20c02104876a811d.html#gga7c7b4521cb5391bd20c02104876a811da5f9dc425604e39a96af53cc4fb940cd6">UCS_I2C_RESULT_TYPE_TGT</a> = 0x00U, +<br/> +  <a class="el" href="group___g___u_c_s___i2_c___t_y_p_e_s_ga7c7b4521cb5391bd20c02104876a811d.html#gga7c7b4521cb5391bd20c02104876a811da1e9f8a38a7bf67986bb52aae45326f0e">UCS_I2C_RESULT_TYPE_TX</a> = 0x01U +<br/> + }</td></tr> +<tr class="memdesc:ga7c7b4521cb5391bd20c02104876a811d"><td class="mdescLeft"> </td><td class="mdescRight">This enumerator specifies the kind of result - Target or Transmission. <a href="group___g___u_c_s___i2_c___t_y_p_e_s_ga7c7b4521cb5391bd20c02104876a811d.html#ga7c7b4521cb5391bd20c02104876a811d">More...</a><br/></td></tr> +<tr class="separator:ga7c7b4521cb5391bd20c02104876a811d"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<p>Referred types used by the Extended Resource Manager. </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:52:59 for UNICENS by +Doxygen 1.8.2 +--> +<script language="javascript"> +<!-- +$('#MSearchResults').wrap('<div style="position: absolute; margin-left: 444px;"></div>'); +--> +</script> +</html> |