summaryrefslogtreecommitdiffstats
path: root/ucs2-lib/doc/html/struct_ucs___general___init_data__t.html
blob: 5b2af8c7529c2e19204c9c2874e06e4b72cf2ea5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
<!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_General_InitData_t Struct Reference</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&#160;<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('struct_ucs___general___init_data__t.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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</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="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">Ucs_General_InitData_t Struct Reference<div class="ingroups"><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></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>The general section of initialization data.  
 <a href="struct_ucs___general___init_data__t.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:aa197d5a04c7eee7b95eb9e1de232d161"><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_ga64926a6a194cfb06703835e3d06475c6.html#ga64926a6a194cfb06703835e3d06475c6">Ucs_ErrorCb_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ucs___general___init_data__t_aa197d5a04c7eee7b95eb9e1de232d161.html#aa197d5a04c7eee7b95eb9e1de232d161">error_fptr</a></td></tr>
<tr class="memdesc:aa197d5a04c7eee7b95eb9e1de232d161"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mandatory callback function notifying an error that terminates the API.  <a href="#aa197d5a04c7eee7b95eb9e1de232d161"></a><br/></td></tr>
<tr class="separator:aa197d5a04c7eee7b95eb9e1de232d161"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e1140be3951f0e14d4071840f4ebc8e"><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_ga981854177aa9ebd554ab522199193bd3.html#ga981854177aa9ebd554ab522199193bd3">Ucs_GetTickCountCb_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ucs___general___init_data__t_a4e1140be3951f0e14d4071840f4ebc8e.html#a4e1140be3951f0e14d4071840f4ebc8e">get_tick_count_fptr</a></td></tr>
<tr class="memdesc:a4e1140be3951f0e14d4071840f4ebc8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mandatory callback function querying the actual system tick count.  <a href="#a4e1140be3951f0e14d4071840f4ebc8e"></a><br/></td></tr>
<tr class="separator:a4e1140be3951f0e14d4071840f4ebc8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9de73ec82699e45173702e9b0ccc917a"><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_ga0238420959cc58ee52c0b385741fccc9.html#ga0238420959cc58ee52c0b385741fccc9">Ucs_SetAppTimerCb_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ucs___general___init_data__t_a9de73ec82699e45173702e9b0ccc917a.html#a9de73ec82699e45173702e9b0ccc917a">set_application_timer_fptr</a></td></tr>
<tr class="memdesc:a9de73ec82699e45173702e9b0ccc917a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback function requesting the application to call <a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v_ga369c86a27ffee30a3af3423f6b3f3e59.html#ga369c86a27ffee30a3af3423f6b3f3e59" title="The application must call this function if the application timer expires.">Ucs_ReportTimeout()</a> after a certain time. Mandatory callback function in event driven mode.  <a href="#a9de73ec82699e45173702e9b0ccc917a"></a><br/></td></tr>
<tr class="separator:a9de73ec82699e45173702e9b0ccc917a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d2541cf63dfcea750c0d0ec2ef563c0"><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_ga61a038694eeb972f6d298478f16a2de2.html#ga61a038694eeb972f6d298478f16a2de2">Ucs_RequestServiceCb_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ucs___general___init_data__t_a7d2541cf63dfcea750c0d0ec2ef563c0.html#a7d2541cf63dfcea750c0d0ec2ef563c0">request_service_fptr</a></td></tr>
<tr class="memdesc:a7d2541cf63dfcea750c0d0ec2ef563c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback function requesting the application to call <a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v_ga649fb9128df6f634fc86aa03b374d822.html#ga649fb9128df6f634fc86aa03b374d822" title="The application must call this function cyclically to drive UNICENS.">Ucs_Service()</a>. Mandatory callback function in event driven mode.  <a href="#a7d2541cf63dfcea750c0d0ec2ef563c0"></a><br/></td></tr>
<tr class="separator:a7d2541cf63dfcea750c0d0ec2ef563c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1694b517ad074d3b14b76b400f86c9db"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ucs___general___init_data__t_a1694b517ad074d3b14b76b400f86c9db.html#a1694b517ad074d3b14b76b400f86c9db">inic_watchdog_enabled</a></td></tr>
<tr class="memdesc:a1694b517ad074d3b14b76b400f86c9db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Optional setting for debugging. Set to <code>false</code> to disable the watchdog, set to <code>true</code> (default value) to enable the watchdog.  <a href="#a1694b517ad074d3b14b76b400f86c9db"></a><br/></td></tr>
<tr class="separator:a1694b517ad074d3b14b76b400f86c9db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad21ca235fca8aa5dbc81e6a82ca0f867"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___g___u_c_s___t_r_a_c_e_gaf18b6867951fd06359788f6595b78195.html#gaf18b6867951fd06359788f6595b78195">Ucs_DebugErrorMsgCb_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ucs___general___init_data__t_ad21ca235fca8aa5dbc81e6a82ca0f867.html#ad21ca235fca8aa5dbc81e6a82ca0f867">debug_error_msg_fptr</a></td></tr>
<tr class="memdesc:ad21ca235fca8aa5dbc81e6a82ca0f867"><td class="mdescLeft">&#160;</td><td class="mdescRight">Optional callback function to debug incoming raw messages of operation type UCS_OP_ERROR and UCS_OP_ERRORACK.  <a href="#ad21ca235fca8aa5dbc81e6a82ca0f867"></a><br/></td></tr>
<tr class="separator:ad21ca235fca8aa5dbc81e6a82ca0f867"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The general section of initialization data. </p>
</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="struct_ucs___general___init_data__t.html">Ucs_General_InitData_t</a></li>
    <li class="footer">&copy; 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>