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
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
|
<!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: Utility 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.5 -->
<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>Utility Services<br>
<small>
[<a class="el" href="group__driverapi.html">Driver Development API</a>]</small>
</h1>
<p>
<div class="dynheader">
Collaboration diagram for Utility Services:</div>
<div class="dynsection">
<center><table><tr><td><img src="group__util.png" border="0" alt="" usemap="#group____util_map">
<map name="group____util_map">
<area shape="rect" href="group__driverapi.html" title="Driver Development API" alt="" coords="7,6,167,30"></map></td></tr></table></center>
</div>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></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__util.html#gdf5ddcdee106f1eaf4b93b2d633da441">rtdm_mmap_to_user</a> (rtdm_user_info_t *user_info, void *src_addr, size_t len, int prot, void **pptr, struct vm_operations_struct *vm_ops, void *vm_private_data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Map a kernel memory range into the address space of the user. <a href="#gdf5ddcdee106f1eaf4b93b2d633da441"></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__util.html#gd3cd99bd0049763a4bf4c41edb249785">rtdm_iomap_to_user</a> (rtdm_user_info_t *user_info, unsigned long src_addr, size_t len, int prot, void **pptr, struct vm_operations_struct *vm_ops, void *vm_private_data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Map an I/O memory range into the address space of the user. <a href="#gd3cd99bd0049763a4bf4c41edb249785"></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__util.html#ga6a363aa6e2e017d3493a9c175755fa5">rtdm_munmap</a> (rtdm_user_info_t *user_info, void *ptr, size_t len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unmap a user memory range. <a href="#ga6a363aa6e2e017d3493a9c175755fa5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__util.html#g7fe4c8a85d03bec31852634a681791e3">rtdm_printk</a> (const char *format,...)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Real-time safe message printing on kernel console. <a href="#g7fe4c8a85d03bec31852634a681791e3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__util.html#g34dfd5c060c67acc684eb4b4256cd4ba">rtdm_malloc</a> (size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocate memory block in real-time context. <a href="#g34dfd5c060c67acc684eb4b4256cd4ba"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__util.html#g8d15b2cbb2fbf35b88362491af4e6a36">rtdm_free</a> (void *ptr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release real-time memory block. <a href="#g8d15b2cbb2fbf35b88362491af4e6a36"></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__util.html#g341dedfbeeb511848ba5f5a9535cc0a7">rtdm_read_user_ok</a> (rtdm_user_info_t *user_info, const void __user *ptr, size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if read access to user-space memory block is safe. <a href="#g341dedfbeeb511848ba5f5a9535cc0a7"></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__util.html#g6cecee5411773e81c83d04824864a62d">rtdm_rw_user_ok</a> (rtdm_user_info_t *user_info, const void __user *ptr, size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if read/write access to user-space memory block is safe. <a href="#g6cecee5411773e81c83d04824864a62d"></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__util.html#g99abc944640745604b4a77204d2d0777">rtdm_copy_from_user</a> (rtdm_user_info_t *user_info, void *dst, const void __user *src, size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy user-space memory block to specified buffer. <a href="#g99abc944640745604b4a77204d2d0777"></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__util.html#g8e2ada3a5665c1366cd2c91f304bfa34">rtdm_safe_copy_from_user</a> (rtdm_user_info_t *user_info, void *dst, const void __user *src, size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if read access to user-space memory block and copy it to specified buffer. <a href="#g8e2ada3a5665c1366cd2c91f304bfa34"></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__util.html#gb19ad9751ca1c56a53aafeb7ce8a6faf">rtdm_copy_to_user</a> (rtdm_user_info_t *user_info, void __user *dst, const void *src, size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy specified buffer to user-space memory block. <a href="#gb19ad9751ca1c56a53aafeb7ce8a6faf"></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__util.html#g53f7bacd08774bfd26e13798cbfb21b8">rtdm_safe_copy_to_user</a> (rtdm_user_info_t *user_info, void __user *dst, const void *src, size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if read/write access to user-space memory block is safe and copy specified buffer to it. <a href="#g53f7bacd08774bfd26e13798cbfb21b8"></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__util.html#g9512ab3a85bea45a47bd033bad8b4828">rtdm_strncpy_from_user</a> (rtdm_user_info_t *user_info, char *dst, const char __user *src, size_t count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy user-space string to specified buffer. <a href="#g9512ab3a85bea45a47bd033bad8b4828"></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__util.html#g8f9fcd0e274324096628dfede6fb10f2">rtdm_in_rt_context</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if running in a real-time task. <a href="#g8f9fcd0e274324096628dfede6fb10f2"></a><br></td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g99abc944640745604b4a77204d2d0777"></a><!-- doxytag: member="drvlib.c::rtdm_copy_from_user" ref="g99abc944640745604b4a77204d2d0777" args="(rtdm_user_info_t *user_info, void *dst, const void __user *src, size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtdm_copy_from_user </td>
<td>(</td>
<td class="paramtype">rtdm_user_info_t * </td>
<td class="paramname"> <em>user_info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void __user * </td>
<td class="paramname"> <em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copy user-space memory block to specified buffer.
<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>user_info</em> </td><td>User information pointer as passed to the invoked device operation handler </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>dst</em> </td><td>Destination buffer address </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>src</em> </td><td>Address of the user-space memory block </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>size</em> </td><td>Size of the memory block</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, otherwise:</dd></dl>
<ul>
<li>-EFAULT is returned if an invalid memory area was accessed.</li></ul>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Before invoking this service, verify via <a class="el" href="group__util.html#g341dedfbeeb511848ba5f5a9535cc0a7" title="Check if read access to user-space memory block is safe.">rtdm_read_user_ok()</a> that the provided user-space address can securely be accessed.</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="gb19ad9751ca1c56a53aafeb7ce8a6faf"></a><!-- doxytag: member="drvlib.c::rtdm_copy_to_user" ref="gb19ad9751ca1c56a53aafeb7ce8a6faf" args="(rtdm_user_info_t *user_info, void __user *dst, const void *src, size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtdm_copy_to_user </td>
<td>(</td>
<td class="paramtype">rtdm_user_info_t * </td>
<td class="paramname"> <em>user_info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void __user * </td>
<td class="paramname"> <em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copy specified buffer to user-space memory block.
<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>user_info</em> </td><td>User information pointer as passed to the invoked device operation handler </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>dst</em> </td><td>Address of the user-space memory block </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>src</em> </td><td>Source buffer address </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>size</em> </td><td>Size of the memory block</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, otherwise:</dd></dl>
<ul>
<li>-EFAULT is returned if an invalid memory area was accessed.</li></ul>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Before invoking this service, verify via <a class="el" href="group__util.html#g6cecee5411773e81c83d04824864a62d" title="Check if read/write access to user-space memory block is safe.">rtdm_rw_user_ok()</a> that the provided user-space address can securely be accessed.</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="g8d15b2cbb2fbf35b88362491af4e6a36"></a><!-- doxytag: member="drvlib.c::rtdm_free" ref="g8d15b2cbb2fbf35b88362491af4e6a36" args="(void *ptr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void rtdm_free </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>ptr</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Release real-time memory block.
<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>ptr</em> </td><td>Pointer to memory block as returned by <a class="el" href="group__util.html#g34dfd5c060c67acc684eb4b4256cd4ba" title="Allocate memory block in real-time context.">rtdm_malloc()</a></td></tr>
</table>
</dl>
Environments:<p>
This service can be called from:<p>
<ul>
<li>Kernel module initialization/cleanup code</li><li>Interrupt service routine (consider the overhead!)</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="g8f9fcd0e274324096628dfede6fb10f2"></a><!-- doxytag: member="drvlib.c::rtdm_in_rt_context" ref="g8f9fcd0e274324096628dfede6fb10f2" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtdm_in_rt_context </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Test if running in a real-time task.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Non-zero is returned if the caller resides in real-time context, 0 otherwise.</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="gd3cd99bd0049763a4bf4c41edb249785"></a><!-- doxytag: member="drvlib.c::rtdm_iomap_to_user" ref="gd3cd99bd0049763a4bf4c41edb249785" args="(rtdm_user_info_t *user_info, unsigned long src_addr, size_t len, int prot, void **pptr, struct vm_operations_struct *vm_ops, void *vm_private_data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtdm_iomap_to_user </td>
<td>(</td>
<td class="paramtype">rtdm_user_info_t * </td>
<td class="paramname"> <em>user_info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"> <em>src_addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>prot</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void ** </td>
<td class="paramname"> <em>pptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct vm_operations_struct * </td>
<td class="paramname"> <em>vm_ops</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>vm_private_data</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Map an I/O memory range into the address space of the user.
<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>user_info</em> </td><td>User information pointer as passed to the invoked device operation handler </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>src_addr</em> </td><td>physical I/O address to be mapped </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>len</em> </td><td>Length of the memory range </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>prot</em> </td><td>Protection flags for the user's memory range, typically either PROT_READ or PROT_READ|PROT_WRITE </td></tr>
<tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>pptr</em> </td><td>Address of a pointer containing the desired user address or NULL on entry and the finally assigned address on return </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>vm_ops</em> </td><td>vm_operations to be executed on the vma_area of the user memory range or NULL </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>vm_private_data</em> </td><td>Private data to be stored in the vma_area, primarily useful for vm_operation handlers</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, otherwise (most common values):</dd></dl>
<ul>
<li>-EINVAL is returned if an invalid start address, size, or destination address was passed.</li></ul>
<p>
<ul>
<li>-ENOMEM is returned if there is insufficient free memory or the limit of memory mapping for the user process was reached.</li></ul>
<p>
<ul>
<li>-EAGAIN is returned if too much memory has been already locked by the user process.</li></ul>
<p>
<ul>
<li>-EPERM <em>may</em> be returned if an illegal invocation environment is detected.</li></ul>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>RTDM supports two models for unmapping the user memory range again. One is explicit unmapping via <a class="el" href="group__util.html#ga6a363aa6e2e017d3493a9c175755fa5" title="Unmap a user memory range.">rtdm_munmap()</a>, either performed when the user requests it via an IOCTL etc. or when the related device is closed. The other is automatic unmapping, triggered by the user invoking standard <a class="el" href="group__posix__shm.html#g01ff21bc70401bee9b80c350763087f7" title="Unmap pages of memory.">munmap()</a> or by the termination of the related process. To track release of the mapping and therefore relinquishment of the referenced physical memory, the caller of <a class="el" href="group__util.html#gd3cd99bd0049763a4bf4c41edb249785" title="Map an I/O memory range into the address space of the user.">rtdm_iomap_to_user()</a> can pass a vm_operations_struct on invocation, defining a close handler for the vm_area. See Linux documentaion (e.g. Linux Device Drivers book) on virtual memory management for details.</dd></dl>
Environments:<p>
This service can be called from:<p>
<ul>
<li>Kernel module initialization/cleanup code</li><li>User-space task (non-RT)</li></ul>
<p>
Rescheduling: possible.
</div>
</div><p>
<a class="anchor" name="g34dfd5c060c67acc684eb4b4256cd4ba"></a><!-- doxytag: member="drvlib.c::rtdm_malloc" ref="g34dfd5c060c67acc684eb4b4256cd4ba" args="(size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* rtdm_malloc </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allocate memory block in real-time context.
<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>size</em> </td><td>Requested size of the memory block</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The pointer to the allocated block is returned on success, NULL otherwise.</dd></dl>
Environments:<p>
This service can be called from:<p>
<ul>
<li>Kernel module initialization/cleanup code</li><li>Interrupt service routine (consider the overhead!)</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="gdf5ddcdee106f1eaf4b93b2d633da441"></a><!-- doxytag: member="drvlib.c::rtdm_mmap_to_user" ref="gdf5ddcdee106f1eaf4b93b2d633da441" args="(rtdm_user_info_t *user_info, void *src_addr, size_t len, int prot, void **pptr, struct vm_operations_struct *vm_ops, void *vm_private_data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtdm_mmap_to_user </td>
<td>(</td>
<td class="paramtype">rtdm_user_info_t * </td>
<td class="paramname"> <em>user_info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>src_addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>prot</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void ** </td>
<td class="paramname"> <em>pptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct vm_operations_struct * </td>
<td class="paramname"> <em>vm_ops</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>vm_private_data</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Map a kernel memory range into the address space of the user.
<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>user_info</em> </td><td>User information pointer as passed to the invoked device operation handler </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>src_addr</em> </td><td>Kernel virtual address to be mapped </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>len</em> </td><td>Length of the memory range </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>prot</em> </td><td>Protection flags for the user's memory range, typically either PROT_READ or PROT_READ|PROT_WRITE </td></tr>
<tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>pptr</em> </td><td>Address of a pointer containing the desired user address or NULL on entry and the finally assigned address on return </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>vm_ops</em> </td><td>vm_operations to be executed on the vma_area of the user memory range or NULL </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>vm_private_data</em> </td><td>Private data to be stored in the vma_area, primarily useful for vm_operation handlers</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, otherwise (most common values):</dd></dl>
<ul>
<li>-EINVAL is returned if an invalid start address, size, or destination address was passed.</li></ul>
<p>
<ul>
<li>-ENOMEM is returned if there is insufficient free memory or the limit of memory mapping for the user process was reached.</li></ul>
<p>
<ul>
<li>-EAGAIN is returned if too much memory has been already locked by the user process.</li></ul>
<p>
<ul>
<li>-EPERM <em>may</em> be returned if an illegal invocation environment is detected.</li></ul>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>This service only works on memory regions allocated via kmalloc() or vmalloc(). To map physical I/O memory to user-space use <a class="el" href="group__util.html#gd3cd99bd0049763a4bf4c41edb249785" title="Map an I/O memory range into the address space of the user.">rtdm_iomap_to_user()</a> instead.<p>
RTDM supports two models for unmapping the user memory range again. One is explicit unmapping via <a class="el" href="group__util.html#ga6a363aa6e2e017d3493a9c175755fa5" title="Unmap a user memory range.">rtdm_munmap()</a>, either performed when the user requests it via an IOCTL etc. or when the related device is closed. The other is automatic unmapping, triggered by the user invoking standard <a class="el" href="group__posix__shm.html#g01ff21bc70401bee9b80c350763087f7" title="Unmap pages of memory.">munmap()</a> or by the termination of the related process. To track release of the mapping and therefore relinquishment of the referenced physical memory, the caller of <a class="el" href="group__util.html#gdf5ddcdee106f1eaf4b93b2d633da441" title="Map a kernel memory range into the address space of the user.">rtdm_mmap_to_user()</a> can pass a vm_operations_struct on invocation, defining a close handler for the vm_area. See Linux documentaion (e.g. Linux Device Drivers book) on virtual memory management for details.</dd></dl>
Environments:<p>
This service can be called from:<p>
<ul>
<li>Kernel module initialization/cleanup code</li><li>User-space task (non-RT)</li></ul>
<p>
Rescheduling: possible.
</div>
</div><p>
<a class="anchor" name="ga6a363aa6e2e017d3493a9c175755fa5"></a><!-- doxytag: member="drvlib.c::rtdm_munmap" ref="ga6a363aa6e2e017d3493a9c175755fa5" args="(rtdm_user_info_t *user_info, void *ptr, size_t len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtdm_munmap </td>
<td>(</td>
<td class="paramtype">rtdm_user_info_t * </td>
<td class="paramname"> <em>user_info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>len</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Unmap a user memory range.
<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>user_info</em> </td><td>User information pointer as passed to <a class="el" href="group__util.html#gdf5ddcdee106f1eaf4b93b2d633da441" title="Map a kernel memory range into the address space of the user.">rtdm_mmap_to_user()</a> when requesting to map the memory range </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>ptr</em> </td><td>User address or the memory range </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>len</em> </td><td>Length of the memory range</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 address or size was passed.</li></ul>
<p>
<ul>
<li>-EPERM <em>may</em> be returned if an illegal invocation environment is detected.</li></ul>
<p>
Environments:<p>
This service can be called from:<p>
<ul>
<li>Kernel module initialization/cleanup code</li><li>User-space task (non-RT)</li></ul>
<p>
Rescheduling: possible.
</div>
</div><p>
<a class="anchor" name="g7fe4c8a85d03bec31852634a681791e3"></a><!-- doxytag: member="drvlib.c::rtdm_printk" ref="g7fe4c8a85d03bec31852634a681791e3" args="(const char *format,...)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void rtdm_printk </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"> <em>...</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Real-time safe message printing on kernel console.
<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>format</em> </td><td>Format string (conforming standard <code>printf()</code>) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>...</em> </td><td>Arguments referred by <em>format</em> </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>On success, this service returns the number of characters printed. Otherwise, a negative error code is returned.</dd></dl>
Environments:<p>
This service can be called from:<p>
<ul>
<li>Kernel module initialization/cleanup code</li><li>Interrupt service routine (consider the overhead!)</li><li>Kernel-based task</li><li>User-space task (RT, non-RT)</li></ul>
<p>
Rescheduling: never in real-time context, possible in non-real-time environments.
</div>
</div><p>
<a class="anchor" name="g341dedfbeeb511848ba5f5a9535cc0a7"></a><!-- doxytag: member="drvlib.c::rtdm_read_user_ok" ref="g341dedfbeeb511848ba5f5a9535cc0a7" args="(rtdm_user_info_t *user_info, const void __user *ptr, size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtdm_read_user_ok </td>
<td>(</td>
<td class="paramtype">rtdm_user_info_t * </td>
<td class="paramname"> <em>user_info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void __user * </td>
<td class="paramname"> <em>ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if read access to user-space memory block is safe.
<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>user_info</em> </td><td>User information pointer as passed to the invoked device operation handler </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>ptr</em> </td><td>Address of the user-provided memory block </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>size</em> </td><td>Size of the memory block</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Non-zero is return when it is safe to read from the specified memory block, 0 otherwise.</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="g6cecee5411773e81c83d04824864a62d"></a><!-- doxytag: member="drvlib.c::rtdm_rw_user_ok" ref="g6cecee5411773e81c83d04824864a62d" args="(rtdm_user_info_t *user_info, const void __user *ptr, size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtdm_rw_user_ok </td>
<td>(</td>
<td class="paramtype">rtdm_user_info_t * </td>
<td class="paramname"> <em>user_info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void __user * </td>
<td class="paramname"> <em>ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if read/write access to user-space memory block is safe.
<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>user_info</em> </td><td>User information pointer as passed to the invoked device operation handler </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>ptr</em> </td><td>Address of the user-provided memory block </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>size</em> </td><td>Size of the memory block</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Non-zero is return when it is safe to read from or write to the specified memory block, 0 otherwise.</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="g8e2ada3a5665c1366cd2c91f304bfa34"></a><!-- doxytag: member="drvlib.c::rtdm_safe_copy_from_user" ref="g8e2ada3a5665c1366cd2c91f304bfa34" args="(rtdm_user_info_t *user_info, void *dst, const void __user *src, size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtdm_safe_copy_from_user </td>
<td>(</td>
<td class="paramtype">rtdm_user_info_t * </td>
<td class="paramname"> <em>user_info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void __user * </td>
<td class="paramname"> <em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if read access to user-space memory block and copy it to specified buffer.
<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>user_info</em> </td><td>User information pointer as passed to the invoked device operation handler </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>dst</em> </td><td>Destination buffer address </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>src</em> </td><td>Address of the user-space memory block </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>size</em> </td><td>Size of the memory block</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, otherwise:</dd></dl>
<ul>
<li>-EFAULT is returned if an invalid memory area was accessed.</li></ul>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>This service is a combination of rtdm_read_user_ok and rtdm_copy_from_user.</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="g53f7bacd08774bfd26e13798cbfb21b8"></a><!-- doxytag: member="drvlib.c::rtdm_safe_copy_to_user" ref="g53f7bacd08774bfd26e13798cbfb21b8" args="(rtdm_user_info_t *user_info, void __user *dst, const void *src, size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtdm_safe_copy_to_user </td>
<td>(</td>
<td class="paramtype">rtdm_user_info_t * </td>
<td class="paramname"> <em>user_info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void __user * </td>
<td class="paramname"> <em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if read/write access to user-space memory block is safe and copy specified buffer to it.
<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>user_info</em> </td><td>User information pointer as passed to the invoked device operation handler </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>dst</em> </td><td>Address of the user-space memory block </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>src</em> </td><td>Source buffer address </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>size</em> </td><td>Size of the memory block</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, otherwise:</dd></dl>
<ul>
<li>-EFAULT is returned if an invalid memory area was accessed.</li></ul>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>This service is a combination of rtdm_rw_user_ok and rtdm_copy_to_user.</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="g9512ab3a85bea45a47bd033bad8b4828"></a><!-- doxytag: member="drvlib.c::rtdm_strncpy_from_user" ref="g9512ab3a85bea45a47bd033bad8b4828" args="(rtdm_user_info_t *user_info, char *dst, const char __user *src, size_t count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtdm_strncpy_from_user </td>
<td>(</td>
<td class="paramtype">rtdm_user_info_t * </td>
<td class="paramname"> <em>user_info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char __user * </td>
<td class="paramname"> <em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>count</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copy user-space string to specified buffer.
<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>user_info</em> </td><td>User information pointer as passed to the invoked device operation handler </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>dst</em> </td><td>Destination buffer address </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>src</em> </td><td>Address of the user-space string </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>count</em> </td><td>Maximum number of bytes to copy, including the trailing '0'</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Length of the string on success (not including the trailing '0'), otherwise:</dd></dl>
<ul>
<li>-EFAULT is returned if an invalid memory area was accessed.</li></ul>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>This services already includes a check of the source address, calling <a class="el" href="group__util.html#g341dedfbeeb511848ba5f5a9535cc0a7" title="Check if read access to user-space memory block is safe.">rtdm_read_user_ok()</a> for <em>src</em> explicitly is not required.</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>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Jun 8 18:08:52 2008 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.5 </small></address>
</body>
</html>
|
