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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Xenomai API: Interrupt Management Services</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<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><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label> <u>S</u>earch for </label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul>
</div>
</div>
<div class="contents">
<h1>Interrupt Management Services<br>
<small>
[<a class="el" href="group__driverapi.html">Driver Development API</a>]</small>
</h1>
<p>
<div class="dynheader">
Collaboration diagram for Interrupt Management Services:</div>
<div class="dynsection">
<center><table><tr><td><img src="group__rtdmirq.png" border="0" alt="" usemap="#group____rtdmirq_map">
<map name="group____rtdmirq_map">
<area shape="rect" href="group__driverapi.html" title="Driver Development API" alt="" coords="5,5,179,32"></map></td></tr></table></center>
</div>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>RTDM_IRQTYPE_xxx</h2></td></tr>
<tr><td colspan="2"><a class="anchor" name="RTDM_IRQTYPE_xxx"></a> Interrupt registrations flags <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gb26458b2383dd59b4977cd77c948cdfc"></a><!-- doxytag: member="rtdmirq::RTDM_IRQTYPE_SHARED" ref="gb26458b2383dd59b4977cd77c948cdfc" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtdmirq.html#gb26458b2383dd59b4977cd77c948cdfc">RTDM_IRQTYPE_SHARED</a> XN_ISR_SHARED</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable IRQ-sharing with other real-time drivers. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gf4e76db13d7f7aac4be2cae59e0097bc"></a><!-- doxytag: member="rtdmirq::RTDM_IRQTYPE_EDGE" ref="gf4e76db13d7f7aac4be2cae59e0097bc" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtdmirq.html#gf4e76db13d7f7aac4be2cae59e0097bc">RTDM_IRQTYPE_EDGE</a> XN_ISR_EDGE</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Mark IRQ as edge-triggered, relevant for correct handling of shared edge-triggered IRQs. <br></td></tr>
<tr><td colspan="2"><br><h2>RTDM_IRQ_xxx</h2></td></tr>
<tr><td colspan="2"><a class="anchor" name="RTDM_IRQ_xxx"></a> Return flags of interrupt handlers <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd7b7593bdac7e1595635f2b372110d22"></a><!-- doxytag: member="rtdmirq::RTDM_IRQ_NONE" ref="gd7b7593bdac7e1595635f2b372110d22" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtdmirq.html#gd7b7593bdac7e1595635f2b372110d22">RTDM_IRQ_NONE</a> XN_ISR_NONE</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unhandled interrupt. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g56a2e243364bc9ff0e38c031c4c8ad57"></a><!-- doxytag: member="rtdmirq::RTDM_IRQ_HANDLED" ref="g56a2e243364bc9ff0e38c031c4c8ad57" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtdmirq.html#g56a2e243364bc9ff0e38c031c4c8ad57">RTDM_IRQ_HANDLED</a> XN_ISR_HANDLED</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Denote handled interrupt. <br></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtdmirq.html#gc99789fe8b6b48e032ee6c22544968e4">rtdm_irq_get_arg</a>(irq_handle, type) ((type *)irq_handle->cookie)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve IRQ handler argument. <a href="#gc99789fe8b6b48e032ee6c22544968e4"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtdmirq.html#gdabd8f3473098ae9128ef449a83fe3c2">rtdm_irq_handler_t</a> )(rtdm_irq_t *irq_handle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Interrupt handler. <a href="#gdabd8f3473098ae9128ef449a83fe3c2"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtdmirq.html#g9bb3d95218ac5261e4033fb0bf695073">rtdm_irq_request</a> (rtdm_irq_t *irq_handle, unsigned int irq_no, <a class="el" href="group__rtdmirq.html#gdabd8f3473098ae9128ef449a83fe3c2">rtdm_irq_handler_t</a> handler, unsigned long flags, const char *device_name, void *arg)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register an interrupt handler. <a href="#g9bb3d95218ac5261e4033fb0bf695073"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtdmirq.html#gf246c0d9fa42a18afbeabd3e3c087c8e">rtdm_irq_free</a> (rtdm_irq_t *irq_handle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release an interrupt handler. <a href="#gf246c0d9fa42a18afbeabd3e3c087c8e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtdmirq.html#g231362e861125cfdcbe5b4137fc70680">rtdm_irq_enable</a> (rtdm_irq_t *irq_handle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable interrupt line. <a href="#g231362e861125cfdcbe5b4137fc70680"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtdmirq.html#gb34c102e3e8af1f27786b2996247913d">rtdm_irq_disable</a> (rtdm_irq_t *irq_handle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disable interrupt line. <a href="#gb34c102e3e8af1f27786b2996247913d"></a><br></td></tr>
</table>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="gc99789fe8b6b48e032ee6c22544968e4"></a><!-- doxytag: member="rtdm_driver.h::rtdm_irq_get_arg" ref="gc99789fe8b6b48e032ee6c22544968e4" args="(irq_handle, type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define rtdm_irq_get_arg </td>
<td>(</td>
<td class="paramtype">irq_handle, <tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">type </td>
<td class="paramname"> </td>
<td> ) </td>
<td> ((type *)irq_handle->cookie)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve IRQ handler argument.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>irq_handle</em> </td><td>IRQ handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>Type of the pointer to return</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The argument pointer registered on <a class="el" href="group__rtdmirq.html#g9bb3d95218ac5261e4033fb0bf695073" title="Register an interrupt handler.">rtdm_irq_request()</a> is returned, type-casted to the specified <em>type</em>.</dd></dl>
Environments:<p>
This service can be called from:<p>
<ul>
<li>Interrupt service routine</li></ul>
<p>
Rescheduling: never.
</div>
</div><p>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="gdabd8f3473098ae9128ef449a83fe3c2"></a><!-- doxytag: member="rtdm_driver.h::rtdm_irq_handler_t" ref="gdabd8f3473098ae9128ef449a83fe3c2" args=")(rtdm_irq_t *irq_handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int(* <a class="el" href="group__rtdmirq.html#gdabd8f3473098ae9128ef449a83fe3c2">rtdm_irq_handler_t</a>)(rtdm_irq_t *irq_handle) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Interrupt handler.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>irq_handle</em> </td><td>IRQ handle as returned by <a class="el" href="group__rtdmirq.html#g9bb3d95218ac5261e4033fb0bf695073" title="Register an interrupt handler.">rtdm_irq_request()</a></td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 or a combination of <a class="el" href="group__rtdmirq.html#RTDM_IRQ_xxx">RTDM_IRQ_xxx</a> flags </dd></dl>
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="gb34c102e3e8af1f27786b2996247913d"></a><!-- doxytag: member="drvlib.c::rtdm_irq_disable" ref="gb34c102e3e8af1f27786b2996247913d" args="(rtdm_irq_t *irq_handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtdm_irq_disable </td>
<td>(</td>
<td class="paramtype">rtdm_irq_t * </td>
<td class="paramname"> <em>irq_handle</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Disable interrupt line.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>irq_handle</em> </td><td>IRQ handle as returned by <a class="el" href="group__rtdmirq.html#g9bb3d95218ac5261e4033fb0bf695073" title="Register an interrupt handler.">rtdm_irq_request()</a></td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, otherwise negative error code</dd></dl>
Environments:<p>
This service can be called from:<p>
<ul>
<li>Kernel module initialization/cleanup code</li><li>Interrupt service routine</li><li>Kernel-based task</li><li>User-space task (RT, non-RT)</li></ul>
<p>
Rescheduling: never.
</div>
</div><p>
<a class="anchor" name="g231362e861125cfdcbe5b4137fc70680"></a><!-- doxytag: member="drvlib.c::rtdm_irq_enable" ref="g231362e861125cfdcbe5b4137fc70680" args="(rtdm_irq_t *irq_handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtdm_irq_enable </td>
<td>(</td>
<td class="paramtype">rtdm_irq_t * </td>
<td class="paramname"> <em>irq_handle</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Enable interrupt line.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>irq_handle</em> </td><td>IRQ handle as returned by <a class="el" href="group__rtdmirq.html#g9bb3d95218ac5261e4033fb0bf695073" title="Register an interrupt handler.">rtdm_irq_request()</a></td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, otherwise negative error code</dd></dl>
Environments:<p>
This service can be called from:<p>
<ul>
<li>Kernel module initialization/cleanup code</li><li>Interrupt service routine</li><li>Kernel-based task</li><li>User-space task (RT, non-RT)</li></ul>
<p>
Rescheduling: possible.
</div>
</div><p>
<a class="anchor" name="gf246c0d9fa42a18afbeabd3e3c087c8e"></a><!-- doxytag: member="drvlib.c::rtdm_irq_free" ref="gf246c0d9fa42a18afbeabd3e3c087c8e" args="(rtdm_irq_t *irq_handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtdm_irq_free </td>
<td>(</td>
<td class="paramtype">rtdm_irq_t * </td>
<td class="paramname"> <em>irq_handle</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Release an interrupt handler.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>irq_handle</em> </td><td>IRQ handle as returned by <a class="el" href="group__rtdmirq.html#g9bb3d95218ac5261e4033fb0bf695073" title="Register an interrupt handler.">rtdm_irq_request()</a></td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, otherwise negative error code</dd></dl>
Environments:<p>
This service can be called from:<p>
<ul>
<li>Kernel module initialization/cleanup code</li><li>Kernel-based task</li><li>User-space task (RT, non-RT)</li></ul>
<p>
Rescheduling: never.
</div>
</div><p>
<a class="anchor" name="g9bb3d95218ac5261e4033fb0bf695073"></a><!-- doxytag: member="drvlib.c::rtdm_irq_request" ref="g9bb3d95218ac5261e4033fb0bf695073" args="(rtdm_irq_t *irq_handle, unsigned int irq_no, rtdm_irq_handler_t handler, unsigned long flags, const char *device_name, void *arg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtdm_irq_request </td>
<td>(</td>
<td class="paramtype">rtdm_irq_t * </td>
<td class="paramname"> <em>irq_handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>irq_no</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__rtdmirq.html#gdabd8f3473098ae9128ef449a83fe3c2">rtdm_irq_handler_t</a> </td>
<td class="paramname"> <em>handler</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"> <em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>device_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>arg</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Register an interrupt handler.
<p>
This function registers the provided handler with an IRQ line and enables the line.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>irq_handle</em> </td><td>IRQ handle </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>irq_no</em> </td><td>Line number of the addressed IRQ </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>handler</em> </td><td>Interrupt handler </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>flags</em> </td><td>Registration flags, see <a class="el" href="group__rtdmirq.html#RTDM_IRQTYPE_xxx">RTDM_IRQTYPE_xxx</a> for details </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>device_name</em> </td><td>Device name to show up in real-time IRQ lists </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>arg</em> </td><td>Pointer to be passed to the interrupt handler on invocation</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, otherwise:</dd></dl>
<ul>
<li>-EINVAL is returned if an invalid parameter was passed.</li></ul>
<p>
<ul>
<li>-EBUSY is returned if the specified IRQ line is already in use.</li></ul>
<p>
Environments:<p>
This service can be called from:<p>
<ul>
<li>Kernel module initialization/cleanup code</li><li>Kernel-based task</li><li>User-space task (RT, non-RT)</li></ul>
<p>
Rescheduling: never.
<p>References <a class="el" href="ksrc_2nucleus_2intr_8c-source.html#l00705">xnintr_attach()</a>, <a class="el" href="ksrc_2nucleus_2intr_8c-source.html#l00776">xnintr_detach()</a>, <a class="el" href="ksrc_2nucleus_2intr_8c-source.html#l00834">xnintr_enable()</a>, and <a class="el" href="ksrc_2nucleus_2intr_8c-source.html#l00614">xnintr_init()</a>.</p>
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Aug 2 12:48:39 2010 for Xenomai API by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
|
