blob: 04e08ad7da4ae8dd8e358074cedc43a3b6f43da8 (
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
144
145
146
147
148
149
150
|
<!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: Low-Level Driver</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___l_l_d.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="#typedef-members">Callback Functions</a> </div>
<div class="headertitle">
<div class="title">Low-Level Driver</div> </div>
</div><!--header-->
<div class="contents">
<p>Provides an interface for Port Message Exchange with the INIC.
<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___l_l_d___a_p_i"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___l_l_d___a_p_i.html">Low-Level Driver API</a></td></tr>
<tr class="memdesc:group___g___u_c_s___l_l_d___a_p_i"><td class="mdescLeft"> </td><td class="mdescRight">Function pointers to be used by the low-level driver. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group___g___u_c_s___l_l_d___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___l_l_d___t_y_p_e_s.html">Referred Types</a></td></tr>
<tr class="memdesc:group___g___u_c_s___l_l_d___t_y_p_e_s"><td class="mdescLeft"> </td><td class="mdescRight">Referred types used by the low-level driver 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="typedef-members"></a>
Callback Functions</h2></td></tr>
<tr class="memitem:ga73f07fb097d3c1bb6c5bf048f088166e"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___l_l_d_ga73f07fb097d3c1bb6c5bf048f088166e.html#ga73f07fb097d3c1bb6c5bf048f088166e">Ucs_Lld_StartCb_t</a> )(<a class="el" href="struct_ucs___lld___api__t.html">Ucs_Lld_Api_t</a> *api_ptr, void *inst_ptr, void *lld_user_ptr)</td></tr>
<tr class="memdesc:ga73f07fb097d3c1bb6c5bf048f088166e"><td class="mdescLeft"> </td><td class="mdescRight">Notifies the LLD to start transmitting and receiving messages. <a href="#ga73f07fb097d3c1bb6c5bf048f088166e"></a><br/></td></tr>
<tr class="separator:ga73f07fb097d3c1bb6c5bf048f088166e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga917011a0aed9ca6d0aaf2201dc8c0e9f"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___l_l_d_ga917011a0aed9ca6d0aaf2201dc8c0e9f.html#ga917011a0aed9ca6d0aaf2201dc8c0e9f">Ucs_Lld_StopCb_t</a> )(void *lld_user_ptr)</td></tr>
<tr class="memdesc:ga917011a0aed9ca6d0aaf2201dc8c0e9f"><td class="mdescLeft"> </td><td class="mdescRight">Notifies the LLD to stop/abort transmitting and receiving messages. <a href="#ga917011a0aed9ca6d0aaf2201dc8c0e9f"></a><br/></td></tr>
<tr class="separator:ga917011a0aed9ca6d0aaf2201dc8c0e9f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabb4b73751b87fe9a63b3d15403a81965"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___l_l_d_gabb4b73751b87fe9a63b3d15403a81965.html#gabb4b73751b87fe9a63b3d15403a81965">Ucs_Lld_ResetInicCb_t</a> )(void *lld_user_ptr)</td></tr>
<tr class="memdesc:gabb4b73751b87fe9a63b3d15403a81965"><td class="mdescLeft"> </td><td class="mdescRight">Notifies the LLD to reset the INIC. <a href="#gabb4b73751b87fe9a63b3d15403a81965"></a><br/></td></tr>
<tr class="separator:gabb4b73751b87fe9a63b3d15403a81965"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae49a0953d88e8fbd4ebf2ce9c5f7b7f1"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___l_l_d_gae49a0953d88e8fbd4ebf2ce9c5f7b7f1.html#gae49a0953d88e8fbd4ebf2ce9c5f7b7f1">Ucs_Lld_RxMsgAvailableCb_t</a> )(void *lld_user_ptr)</td></tr>
<tr class="memdesc:gae49a0953d88e8fbd4ebf2ce9c5f7b7f1"><td class="mdescLeft"> </td><td class="mdescRight">Callback function which is invoked as soon as port message objects are available again. <a href="#gae49a0953d88e8fbd4ebf2ce9c5f7b7f1"></a><br/></td></tr>
<tr class="separator:gae49a0953d88e8fbd4ebf2ce9c5f7b7f1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa618347d194113c34f5b21d3c36ba7b6"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___l_l_d_gaa618347d194113c34f5b21d3c36ba7b6.html#gaa618347d194113c34f5b21d3c36ba7b6">Ucs_Lld_TxTransmitCb_t</a> )(<a class="el" href="struct_ucs___lld___tx_msg__t.html">Ucs_Lld_TxMsg_t</a> *msg_ptr, void *lld_user_ptr)</td></tr>
<tr class="memdesc:gaa618347d194113c34f5b21d3c36ba7b6"><td class="mdescLeft"> </td><td class="mdescRight">Callback function which is invoked to transmit a single message to the INIC. <a href="#gaa618347d194113c34f5b21d3c36ba7b6"></a><br/></td></tr>
<tr class="separator:gaa618347d194113c34f5b21d3c36ba7b6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Provides an interface for Port Message Exchange with the INIC. </p>
<p>UNICENS provides a certain set of functions which are only dedicated to the low-level driver. The low-level driver <em>API</em> is a set of functions which shall be used by the low-level driver. The low-level driver <em>callbacks</em> is a set of function that shall be implemented by the low-level driver. The low-level driver <em>callbacks</em> shall be assigned to the UNICENS initialization structure. During initialization UNICENS invokes the callback <a class="el" href="struct_ucs___lld___callbacks__t.html">start_fptr</a> and passes the low-level driver <em>API</em> as pointer to <a class="el" href="struct_ucs___lld___api__t.html">Ucs_Lld_Api_t</a>. </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>
|
