-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathCO__driver__target_8h.html
More file actions
161 lines (158 loc) · 12.2 KB
/
CO__driver__target_8h.html
File metadata and controls
161 lines (158 loc) · 12.2 KB
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
151
152
153
154
155
156
157
158
159
160
161
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.11.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>CANopenLinux: CO_driver_target.h File Reference</title>
<link rel="icon" href="CANopenNode.png" type="image/x-icon" />
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="CANopenNode.png"/></td>
<td id="projectalign">
<div id="projectname">CANopenLinux
</div>
<div id="projectbrief">CANopenNode on Linux devices</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.11.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">CO_driver_target.h File Reference<div class="ingroups"><a class="el" href="group__CO__socketCAN.html">socketCAN</a> » <a class="el" href="group__CO__socketCAN__driver__target.html">CO_driver_target.h</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Linux socketCAN specific definitions for CANopenNode.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <stddef.h></code><br />
<code>#include <stdbool.h></code><br />
<code>#include <stdint.h></code><br />
<code>#include <stdio.h></code><br />
<code>#include <endian.h></code><br />
<code>#include <pthread.h></code><br />
<code>#include <linux/can.h></code><br />
<code>#include <net/if.h></code><br />
<code>#include <sys/epoll.h></code><br />
<code>#include "<a class="el" href="CO__error_8h_source.html">CO_error.h</a>"</code><br />
</div><div class="textblock"><div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Include dependency graph for CO_driver_target.h:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="CO__driver__target_8h__incl.svg" width="100%" height="437"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></div>
</div>
</div>
<p><a href="CO__driver__target_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga63d0056e7f18144c6eee7b66f196377c" id="r_ga63d0056e7f18144c6eee7b66f196377c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CO__socketCAN__driver__target.html#ga63d0056e7f18144c6eee7b66f196377c">CO_DRIVER_MULTI_INTERFACE</a>   0</td></tr>
<tr class="memdesc:ga63d0056e7f18144c6eee7b66f196377c"><td class="mdescLeft"> </td><td class="mdescRight">Multi interface support. <br /></td></tr>
<tr class="separator:ga63d0056e7f18144c6eee7b66f196377c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga88077a1ecc6ae53de0b40ae092d48452" id="r_ga88077a1ecc6ae53de0b40ae092d48452"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CO__socketCAN__driver__target.html#ga88077a1ecc6ae53de0b40ae092d48452">CO_DRIVER_ERROR_REPORTING</a>   1</td></tr>
<tr class="memdesc:ga88077a1ecc6ae53de0b40ae092d48452"><td class="mdescLeft"> </td><td class="mdescRight">CAN bus error reporting. <br /></td></tr>
<tr class="separator:ga88077a1ecc6ae53de0b40ae092d48452"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaaffa26125993a7a1f6cbfdb468b59333" id="r_gaaffa26125993a7a1f6cbfdb468b59333"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../CANopenLinux/CANopenNode/doc/html/group__CO__driver.html#ga1cb2d3466eb0c6d267f3b5ff1a0d9532">CO_ReturnError_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CO__socketCAN__driver__target.html#gaaffa26125993a7a1f6cbfdb468b59333">CO_CANmodule_addInterface</a> (<a class="elRef" href="../../CANopenLinux/CANopenNode/doc/html/structCO__CANmodule__t.html">CO_CANmodule_t</a> *CANmodule, int can_ifindex)</td></tr>
<tr class="memdesc:gaaffa26125993a7a1f6cbfdb468b59333"><td class="mdescLeft"> </td><td class="mdescRight">Add socketCAN interface to can driver. <br /></td></tr>
<tr class="separator:gaaffa26125993a7a1f6cbfdb468b59333"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf266a58e21acf104d9f19cd0da704afe" id="r_gaf266a58e21acf104d9f19cd0da704afe"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../CANopenLinux/CANopenNode/doc/html/group__CO__dataTypes.html#ga490ee355f57f2815cb1aa4626cf525f7">bool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CO__socketCAN__driver__target.html#gaf266a58e21acf104d9f19cd0da704afe">CO_CANrxBuffer_getInterface</a> (<a class="elRef" href="../../CANopenLinux/CANopenNode/doc/html/structCO__CANmodule__t.html">CO_CANmodule_t</a> *CANmodule, <a class="elRef" href="../../CANopenLinux/CANopenNode/doc/html/group__CO__dataTypes.html#ga1f1825b69244eb3ad2c7165ddc99c956">uint16_t</a> ident, const void **const CANptrRx, struct timespec *timestamp)</td></tr>
<tr class="memdesc:gaf266a58e21acf104d9f19cd0da704afe"><td class="mdescLeft"> </td><td class="mdescRight">Check on which interface the last message for one message buffer was received. <br /></td></tr>
<tr class="separator:gaf266a58e21acf104d9f19cd0da704afe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0d7a8fdf7a2fafd4c6d2f2dd1e1017b0" id="r_ga0d7a8fdf7a2fafd4c6d2f2dd1e1017b0"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../CANopenLinux/CANopenNode/doc/html/group__CO__driver.html#ga1cb2d3466eb0c6d267f3b5ff1a0d9532">CO_ReturnError_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CO__socketCAN__driver__target.html#ga0d7a8fdf7a2fafd4c6d2f2dd1e1017b0">CO_CANtxBuffer_setInterface</a> (<a class="elRef" href="../../CANopenLinux/CANopenNode/doc/html/structCO__CANmodule__t.html">CO_CANmodule_t</a> *CANmodule, <a class="elRef" href="../../CANopenLinux/CANopenNode/doc/html/group__CO__dataTypes.html#ga1f1825b69244eb3ad2c7165ddc99c956">uint16_t</a> ident, const void *CANptrTx)</td></tr>
<tr class="memdesc:ga0d7a8fdf7a2fafd4c6d2f2dd1e1017b0"><td class="mdescLeft"> </td><td class="mdescRight">Set which interface should be used for message buffer transmission. <br /></td></tr>
<tr class="separator:ga0d7a8fdf7a2fafd4c6d2f2dd1e1017b0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga072c53260a32d7cd30d9ad1b5bb2c359" id="r_ga072c53260a32d7cd30d9ad1b5bb2c359"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../CANopenLinux/CANopenNode/doc/html/group__CO__dataTypes.html#ga490ee355f57f2815cb1aa4626cf525f7">bool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CO__socketCAN__driver__target.html#ga072c53260a32d7cd30d9ad1b5bb2c359">CO_CANrxFromEpoll</a> (<a class="elRef" href="../../CANopenLinux/CANopenNode/doc/html/structCO__CANmodule__t.html">CO_CANmodule_t</a> *CANmodule, struct epoll_event *ev, CO_CANrxMsg_t *buffer, <a class="elRef" href="../../CANopenLinux/CANopenNode/doc/html/group__CO__dataTypes.html#gadb828ef50c2dbb783109824e94cf6c47">int32_t</a> *msgIndex)</td></tr>
<tr class="memdesc:ga072c53260a32d7cd30d9ad1b5bb2c359"><td class="mdescLeft"> </td><td class="mdescRight">Receives CAN messages from matching epoll event. <br /></td></tr>
<tr class="separator:ga072c53260a32d7cd30d9ad1b5bb2c359"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Linux socketCAN specific definitions for CANopenNode. </p>
<dl class="section author"><dt>Author</dt><dd>Janez Paternoster </dd>
<dd>
Martin Wagner </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>2004 - 2020 Janez Paternoster </dd>
<dd>
2018 - 2020 Neuberger Gebaeudeautomation GmbH</dd></dl>
<p>This file is part of <a href="https://github.com/CANopenNode/CANopenNode">https://github.com/CANopenNode/CANopenNode</a>, a CANopen Stack.</p>
<p>Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at </p><pre class="fragment">http://www.apache.org/licenses/LICENSE-2.0
</pre><p> Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.11.0
</small></address>
</div><!-- doc-content -->
</body>
</html>
