-
Notifications
You must be signed in to change notification settings - Fork 0
/
a00067.html
178 lines (162 loc) · 9.85 KB
/
a00067.html
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
<!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"/>
<title>Contiki 2.5: radio_driver Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>radio_driver Struct Reference<br/>
<small>
[<a class="el" href="a01554.html">Radio API</a>]</small>
</h1><!-- doxytag: class="radio_driver" -->
<p>The structure of a device driver for a radio in Contiki.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00167_source.html">core/dev/radio.h</a>></code></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00067.html#a38aa2cc1efc42aa695d3e10926c55eed">prepare</a> )(const void *payload, unsigned short payload_len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Prepare the radio with a packet to be sent. <a href="#a38aa2cc1efc42aa695d3e10926c55eed"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00067.html#aefbad725b4dd302fdf4bd62e28706378">transmit</a> )(unsigned short transmit_len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send the packet that has previously been prepared. <a href="#aefbad725b4dd302fdf4bd62e28706378"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00067.html#a8abbfdc45c060bcbfab97e7b336c7ac0">send</a> )(const void *payload, unsigned short payload_len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Prepare & transmit a packet. <a href="#a8abbfdc45c060bcbfab97e7b336c7ac0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00067.html#a622c2a8abe3336e9c53e1484c269f840">read</a> )(void *buf, unsigned short buf_len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a received packet into a buffer. <a href="#a622c2a8abe3336e9c53e1484c269f840"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00067.html#a8284614b7c7ee7b35a7cf732276ba62d">channel_clear</a> )(void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform a Clear-Channel Assessment (CCA) to find out if there is a packet in the air or not. <a href="#a8284614b7c7ee7b35a7cf732276ba62d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4b380ec8f632e6e435ca210b8072a438"></a><!-- doxytag: member="radio_driver::receiving_packet" ref="a4b380ec8f632e6e435ca210b8072a438" args=")(void)" -->
int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00067.html#a4b380ec8f632e6e435ca210b8072a438">receiving_packet</a> )(void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if the radio driver is currently receiving a packet. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab5fe62757c820d4bd690b8740d64e752"></a><!-- doxytag: member="radio_driver::pending_packet" ref="ab5fe62757c820d4bd690b8740d64e752" args=")(void)" -->
int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00067.html#ab5fe62757c820d4bd690b8740d64e752">pending_packet</a> )(void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if the radio driver has just received a packet. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00067.html#a6b7a262e6494e3233e5d5c45bdfc6881">on</a> )(void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Turn the radio on. <a href="#a6b7a262e6494e3233e5d5c45bdfc6881"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00067.html#aa6b6203cb6aef79945e689dde54a5008">off</a> )(void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Turn the radio off. <a href="#aa6b6203cb6aef79945e689dde54a5008"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The structure of a device driver for a radio in Contiki. </p>
<p>Definition at line <a class="el" href="a00167_source.html#l00061">61</a> of file <a class="el" href="a00167_source.html">radio.h</a>.</p>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="a8284614b7c7ee7b35a7cf732276ba62d"></a><!-- doxytag: member="radio_driver::channel_clear" ref="a8284614b7c7ee7b35a7cf732276ba62d" args=")(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* <a class="el" href="a00067.html#a8284614b7c7ee7b35a7cf732276ba62d">radio_driver::channel_clear</a>)(void)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Perform a Clear-Channel Assessment (CCA) to find out if there is a packet in the air or not. </p>
</div>
</div>
<a class="anchor" id="aa6b6203cb6aef79945e689dde54a5008"></a><!-- doxytag: member="radio_driver::off" ref="aa6b6203cb6aef79945e689dde54a5008" args=")(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* <a class="el" href="a00067.html#aa6b6203cb6aef79945e689dde54a5008">radio_driver::off</a>)(void)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Turn the radio off. </p>
</div>
</div>
<a class="anchor" id="a6b7a262e6494e3233e5d5c45bdfc6881"></a><!-- doxytag: member="radio_driver::on" ref="a6b7a262e6494e3233e5d5c45bdfc6881" args=")(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* <a class="el" href="a00067.html#a6b7a262e6494e3233e5d5c45bdfc6881">radio_driver::on</a>)(void)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Turn the radio on. </p>
</div>
</div>
<a class="anchor" id="a38aa2cc1efc42aa695d3e10926c55eed"></a><!-- doxytag: member="radio_driver::prepare" ref="a38aa2cc1efc42aa695d3e10926c55eed" args=")(const void *payload, unsigned short payload_len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* <a class="el" href="a00067.html#a38aa2cc1efc42aa695d3e10926c55eed">radio_driver::prepare</a>)(const void *payload, unsigned short payload_len)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Prepare the radio with a packet to be sent. </p>
</div>
</div>
<a class="anchor" id="a622c2a8abe3336e9c53e1484c269f840"></a><!-- doxytag: member="radio_driver::read" ref="a622c2a8abe3336e9c53e1484c269f840" args=")(void *buf, unsigned short buf_len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* <a class="el" href="a00067.html#a622c2a8abe3336e9c53e1484c269f840">radio_driver::read</a>)(void *buf, unsigned short buf_len)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read a received packet into a buffer. </p>
</div>
</div>
<a class="anchor" id="a8abbfdc45c060bcbfab97e7b336c7ac0"></a><!-- doxytag: member="radio_driver::send" ref="a8abbfdc45c060bcbfab97e7b336c7ac0" args=")(const void *payload, unsigned short payload_len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* <a class="el" href="a00067.html#a8abbfdc45c060bcbfab97e7b336c7ac0">radio_driver::send</a>)(const void *payload, unsigned short payload_len)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Prepare & transmit a packet. </p>
</div>
</div>
<a class="anchor" id="aefbad725b4dd302fdf4bd62e28706378"></a><!-- doxytag: member="radio_driver::transmit" ref="aefbad725b4dd302fdf4bd62e28706378" args=")(unsigned short transmit_len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* <a class="el" href="a00067.html#aefbad725b4dd302fdf4bd62e28706378">radio_driver::transmit</a>)(unsigned short transmit_len)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Send the packet that has previously been prepared. </p>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Mon Apr 11 14:23:58 2011 for Contiki 2.5 by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>