diff options
Diffstat (limited to 'ucs2-lib/doc/html/group___g___u_c_s___i2_c_gac06f58d8a7775703373f12c3c677d687.html')
| -rw-r--r-- | ucs2-lib/doc/html/group___g___u_c_s___i2_c_gac06f58d8a7775703373f12c3c677d687.html | 237 |
1 files changed, 0 insertions, 237 deletions
diff --git a/ucs2-lib/doc/html/group___g___u_c_s___i2_c_gac06f58d8a7775703373f12c3c677d687.html b/ucs2-lib/doc/html/group___g___u_c_s___i2_c_gac06f58d8a7775703373f12c3c677d687.html deleted file mode 100644 index 36dbd93..0000000 --- a/ucs2-lib/doc/html/group___g___u_c_s___i2_c_gac06f58d8a7775703373f12c3c677d687.html +++ /dev/null @@ -1,237 +0,0 @@ -<!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_I2c_CreatePort</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="contents"> -<a class="anchor" id="gac06f58d8a7775703373f12c3c677d687"></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_I2c_CreatePort </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">uint8_t </td> - <td class="paramname"><em>index</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="group___g___u_c_s___i2_c___t_y_p_e_s_ga8492cc027b5b9e2f436a172e526e1d5e.html#ga8492cc027b5b9e2f436a172e526e1d5e">Ucs_I2c_Speed_t</a> </td> - <td class="paramname"><em>speed</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">uint8_t </td> - <td class="paramname"><em>i2c_int_mask</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="group___g___u_c_s___i2_c___t_y_p_e_s_gae1f1b25aca1c240022464571187ea98f.html#gae1f1b25aca1c240022464571187ea98f">Ucs_I2c_CreatePortResCb_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>Creates an I2C Port with its associated parameter. </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-I2CPortCreate6C1">INIC.I2CPortCreate</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">index</td><td>I2C Port instance. <table class="mns_param_table"> -<tr> -<td id="mns_param_small"> </td><td><code>Index</code></td></tr> -</table> -</td></tr> - <tr><td class="paramname">speed</td><td>The speed grade of the I2C Port. <table class="mns_param_table"> -<tr> -<td id="mns_param_small"> </td><td><code>Speed</code></td></tr> -</table> -</td></tr> - <tr><td class="paramname">i2c_int_mask</td><td>The bit mask corresponding to the I2C-interrupt on the GPIO Port. </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 NULL </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> -<dl class="section attention"><dt>Attention</dt><dd>The below points should be considered in order to receive the notification of the I2C interrupt:<ul> -<li>The <a class="el" href="group___g___u_c_s___i2_c___t_y_p_e_s_ga3bdd3013545f8249a73c73e0d28713f7.html#ga3bdd3013545f8249a73c73e0d28713f7">Ucs_I2c_IntEventReportCb_t</a> callback function should be registered in the <a class="el" href="struct_ucs___init_data__t.html" title="UNICENS initialization structure used by function Ucs_Init().">Ucs_InitData_t</a> init structure.</li> -<li>The GPIO port has to be be opened and the I2C interrupt pin associated with that port configured correctly.</li> -</ul> -</dd></dl> -<p><br/> - <b>Example</b> </p> -<div class="fragment"><div class="line"><span class="preprocessor">#define I2C_INT_PIN_MASK ((uint8_t)0x01)</span></div> -<div class="line"><span class="preprocessor"></span></div> -<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"> <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___i2_c_gac06f58d8a7775703373f12c3c677d687.html#gac06f58d8a7775703373f12c3c677d687" title="Creates an I2C Port with its associated parameter.">Ucs_I2c_CreatePort</a>(0x556U, 0x00U, <a class="code" href="group___g___u_c_s___i2_c___t_y_p_e_s_ga8492cc027b5b9e2f436a172e526e1d5e.html#gga8492cc027b5b9e2f436a172e526e1d5ea577d5efdff88c202f2e2f43aed2b0391" title="Speed grade of the port is 400 kHz.">UCS_I2C_FAST_MODE</a>, I2C_INT_PIN_MASK, &App_I2cCreatePortResCb);</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">// Handle I2cCreatePort event</span></div> -<div class="line"><span class="keyword">static</span> <span class="keywordtype">void</span> App_I2cCreatePortResCb(uint16_t device_id, uint16_t port_handle, <a class="code" href="struct_ucs___i2c___result__t.html" title="Result structure of the I2C Module.">Ucs_I2c_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___i2c___result__t_aacd0e1eabaa18a3fe226a2b4f849832b.html#aacd0e1eabaa18a3fe226a2b4f849832b" title="Result code.">code</a> == <a class="code" href="group___g___u_c_s___i2_c___t_y_p_e_s_ga930e829c3c689b8ead8f9fbf7f2ca237.html#gga930e829c3c689b8ead8f9fbf7f2ca237a1f0bb0636d1fbe3a3c94541d3725b864" title="I2C command succeeded.">UCS_I2C_RES_SUCCESS</a>)</div> -<div class="line"> {</div> -<div class="line"> <span class="comment">// Store received port handle</span></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___i2_c.html">I2C</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> |