diff options
Diffstat (limited to 'ucs2-lib/doc/html/group___g___u_c_s___i_n_i_t___a_n_d___s_r_v.html')
| -rw-r--r-- | ucs2-lib/doc/html/group___g___u_c_s___i_n_i_t___a_n_d___s_r_v.html | 185 |
1 files changed, 0 insertions, 185 deletions
diff --git a/ucs2-lib/doc/html/group___g___u_c_s___i_n_i_t___a_n_d___s_r_v.html b/ucs2-lib/doc/html/group___g___u_c_s___i_n_i_t___a_n_d___s_r_v.html deleted file mode 100644 index 99b023d..0000000 --- a/ucs2-lib/doc/html/group___g___u_c_s___i_n_i_t___a_n_d___s_r_v.html +++ /dev/null @@ -1,185 +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: Initialization and Service</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___i_n_i_t___a_n_d___s_r_v.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="#define-members">Macros</a> | -<a href="#typedef-members">Callback Functions</a> | -<a href="#func-members">Functions</a> </div> - <div class="headertitle"> -<div class="title">Initialization and Service</div> </div> -</div><!--header--> -<div class="contents"> - -<p>Provides initialization and service functions. -<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___i_n_i_t___a_n_d___s_r_v___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___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s.html">Initialization and Service Types</a></td></tr> -<tr class="memdesc:group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s"><td class="mdescLeft"> </td><td class="mdescRight">Referred types used by basic functions. <br/></td></tr> -<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:group___g___u_c_s___t_r_a_c_e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___t_r_a_c_e.html">Tracing/Debugging</a></td></tr> -<tr class="memdesc:group___g___u_c_s___t_r_a_c_e"><td class="mdescLeft"> </td><td class="mdescRight">Tracing/Debugging Interface. <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___init_data__t.html">Ucs_InitData_t</a></td></tr> -<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">UNICENS initialization structure used by function <a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v_gaea8d7735d41853167a2befdc06febe43.html#gaea8d7735d41853167a2befdc06febe43" title="UNICENS initialization function.">Ucs_Init()</a>. <a href="struct_ucs___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="define-members"></a> -Macros</h2></td></tr> -<tr class="memitem:ga750688e4ce10e995d802e288540d19c4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v_ga750688e4ce10e995d802e288540d19c4.html#ga750688e4ce10e995d802e288540d19c4">UCS_NUM_INSTANCES</a>   1</td></tr> -<tr class="memdesc:ga750688e4ce10e995d802e288540d19c4"><td class="mdescLeft"> </td><td class="mdescRight">Number of API instances which can be created by function <a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v_ga85a99b5d236b29e2d598bef51edad638.html#ga85a99b5d236b29e2d598bef51edad638" title="Retrieves a UNICENS API instance.">Ucs_CreateInstance()</a>. <a href="#ga750688e4ce10e995d802e288540d19c4"></a><br/></td></tr> -<tr class="separator:ga750688e4ce10e995d802e288540d19c4"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaff7821fdddebc32a8a3f61a5eebc405a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v_gaff7821fdddebc32a8a3f61a5eebc405a.html#gaff7821fdddebc32a8a3f61a5eebc405a">UCS_FOOTPRINT_TINY</a></td></tr> -<tr class="memdesc:gaff7821fdddebc32a8a3f61a5eebc405a"><td class="mdescLeft"> </td><td class="mdescRight">Define this macro to reduce the RAM and ROM size of the UNICENS software by disabling certain features. <a href="#gaff7821fdddebc32a8a3f61a5eebc405a"></a><br/></td></tr> -<tr class="separator:gaff7821fdddebc32a8a3f61a5eebc405a"><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:ga61a038694eeb972f6d298478f16a2de2"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v_ga61a038694eeb972f6d298478f16a2de2.html#ga61a038694eeb972f6d298478f16a2de2">Ucs_RequestServiceCb_t</a> )(void *user_ptr)</td></tr> -<tr class="memdesc:ga61a038694eeb972f6d298478f16a2de2"><td class="mdescLeft"> </td><td class="mdescRight">Function signature used for service request callback. <a href="#ga61a038694eeb972f6d298478f16a2de2"></a><br/></td></tr> -<tr class="separator:ga61a038694eeb972f6d298478f16a2de2"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga64926a6a194cfb06703835e3d06475c6"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v_ga64926a6a194cfb06703835e3d06475c6.html#ga64926a6a194cfb06703835e3d06475c6">Ucs_ErrorCb_t</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_ga9551cd80ce8a13fa6cce717cbc13e499.html#ga9551cd80ce8a13fa6cce717cbc13e499">Ucs_Error_t</a> error_code, void *user_ptr)</td></tr> -<tr class="memdesc:ga64926a6a194cfb06703835e3d06475c6"><td class="mdescLeft"> </td><td class="mdescRight">Function signature used for the general error callback function. <a href="#ga64926a6a194cfb06703835e3d06475c6"></a><br/></td></tr> -<tr class="separator:ga64926a6a194cfb06703835e3d06475c6"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga981854177aa9ebd554ab522199193bd3"><td class="memItemLeft" align="right" valign="top">typedef uint16_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v_ga981854177aa9ebd554ab522199193bd3.html#ga981854177aa9ebd554ab522199193bd3">Ucs_GetTickCountCb_t</a> )(void *user_ptr)</td></tr> -<tr class="memdesc:ga981854177aa9ebd554ab522199193bd3"><td class="mdescLeft"> </td><td class="mdescRight">Function signature used for callback function to get system tick count. <a href="#ga981854177aa9ebd554ab522199193bd3"></a><br/></td></tr> -<tr class="separator:ga981854177aa9ebd554ab522199193bd3"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga0238420959cc58ee52c0b385741fccc9"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v_ga0238420959cc58ee52c0b385741fccc9.html#ga0238420959cc58ee52c0b385741fccc9">Ucs_SetAppTimerCb_t</a> )(uint16_t timeout, void *user_ptr)</td></tr> -<tr class="memdesc:ga0238420959cc58ee52c0b385741fccc9"><td class="mdescLeft"> </td><td class="mdescRight">Function signature used for timer callback function. <a href="#ga0238420959cc58ee52c0b385741fccc9"></a><br/></td></tr> -<tr class="separator:ga0238420959cc58ee52c0b385741fccc9"><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:ga85a99b5d236b29e2d598bef51edad638"><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_ga074c04d40d00986e0c869adaec8fadda.html#ga074c04d40d00986e0c869adaec8fadda">Ucs_Inst_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v_ga85a99b5d236b29e2d598bef51edad638.html#ga85a99b5d236b29e2d598bef51edad638">Ucs_CreateInstance</a> (void)</td></tr> -<tr class="memdesc:ga85a99b5d236b29e2d598bef51edad638"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a UNICENS API instance. <a href="#ga85a99b5d236b29e2d598bef51edad638"></a><br/></td></tr> -<tr class="separator:ga85a99b5d236b29e2d598bef51edad638"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga64b50780725a0dc8693b5b73f8345ad6"><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___i_n_i_t___a_n_d___s_r_v_ga64b50780725a0dc8693b5b73f8345ad6.html#ga64b50780725a0dc8693b5b73f8345ad6">Ucs_SetDefaultConfig</a> (<a class="el" href="struct_ucs___init_data__t.html">Ucs_InitData_t</a> *init_ptr)</td></tr> -<tr class="memdesc:ga64b50780725a0dc8693b5b73f8345ad6"><td class="mdescLeft"> </td><td class="mdescRight">Assigns default values to a provided UNICENS init structure. <a href="#ga64b50780725a0dc8693b5b73f8345ad6"></a><br/></td></tr> -<tr class="separator:ga64b50780725a0dc8693b5b73f8345ad6"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaea8d7735d41853167a2befdc06febe43"><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___i_n_i_t___a_n_d___s_r_v_gaea8d7735d41853167a2befdc06febe43.html#gaea8d7735d41853167a2befdc06febe43">Ucs_Init</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, const <a class="el" href="struct_ucs___init_data__t.html">Ucs_InitData_t</a> *init_ptr, <a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_gaba3a47e6c1d360c77e560cefe8c541e3.html#gaba3a47e6c1d360c77e560cefe8c541e3">Ucs_InitResultCb_t</a> init_result_fptr)</td></tr> -<tr class="memdesc:gaea8d7735d41853167a2befdc06febe43"><td class="mdescLeft"> </td><td class="mdescRight">UNICENS initialization function. <a href="#gaea8d7735d41853167a2befdc06febe43"></a><br/></td></tr> -<tr class="separator:gaea8d7735d41853167a2befdc06febe43"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga61381bd30fb6630b6c5d6ecc8968e983"><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___i_n_i_t___a_n_d___s_r_v_ga61381bd30fb6630b6c5d6ecc8968e983.html#ga61381bd30fb6630b6c5d6ecc8968e983">Ucs_Stop</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, <a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_gaa573fbe79f76f263a17e51d6de99036d.html#gaa573fbe79f76f263a17e51d6de99036d">Ucs_StdResultCb_t</a> stopped_fptr)</td></tr> -<tr class="memdesc:ga61381bd30fb6630b6c5d6ecc8968e983"><td class="mdescLeft"> </td><td class="mdescRight">Terminates the execution of UNICENS. <a href="#ga61381bd30fb6630b6c5d6ecc8968e983"></a><br/></td></tr> -<tr class="separator:ga61381bd30fb6630b6c5d6ecc8968e983"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga649fb9128df6f634fc86aa03b374d822"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v_ga649fb9128df6f634fc86aa03b374d822.html#ga649fb9128df6f634fc86aa03b374d822">Ucs_Service</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)</td></tr> -<tr class="memdesc:ga649fb9128df6f634fc86aa03b374d822"><td class="mdescLeft"> </td><td class="mdescRight">The application must call this function cyclically to drive UNICENS. <a href="#ga649fb9128df6f634fc86aa03b374d822"></a><br/></td></tr> -<tr class="separator:ga649fb9128df6f634fc86aa03b374d822"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga369c86a27ffee30a3af3423f6b3f3e59"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v_ga369c86a27ffee30a3af3423f6b3f3e59.html#ga369c86a27ffee30a3af3423f6b3f3e59">Ucs_ReportTimeout</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)</td></tr> -<tr class="memdesc:ga369c86a27ffee30a3af3423f6b3f3e59"><td class="mdescLeft"> </td><td class="mdescRight">The application must call this function if the application timer expires. <a href="#ga369c86a27ffee30a3af3423f6b3f3e59"></a><br/></td></tr> -<tr class="separator:ga369c86a27ffee30a3af3423f6b3f3e59"><td class="memSeparator" colspan="2"> </td></tr> -</table> -<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<p>Provides initialization and service functions. </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> |