1  .\" Copyright (c) 2014 Jeff Epler
 2  .\"
 3  .\" This is free documentation; you can redistribute it and/or
 4  .\" modify it under the terms of the GNU General Public License as
 5  .\" published by the Free Software Foundation; either version 2 of
 6  .\" the License, or (at your option) any later version.
 7  .\"
 8  .\" The GNU General Public License's references to "object code"
 9  .\" and "executables" are to be interpreted as the output of any
10  .\" document formatting or typesetting system, including
11  .\" intermediate and printed output.
12  .\"
13  .\" This manual is distributed in the hope that it will be useful,
14  .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
15  .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  .\" GNU General Public License for more details.
17  .\"
18  .\" You should have received a copy of the GNU General Public
19  .\" License along with this manual; if not, write to the Free
20  .\" Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
21  .\" USA.
22  .TH funct "3rtapi" "2014-06-28" "LinuxCNC Documentation" "RTAPI"
23  .SH NAME
24  
25  rtapi_list.h \- RTAPI wrappers for linux kernel functionality
26  
27  .SH SYNTAX
28  .HP
29  #include <rtapi_list.h>
30  .HP
31  struct rtapi_list_head;
32  .HP
33  void rtapi_list_add(struct rtapi_list_head *new_, struct rtapi_list_head *head);
34  .HP
35  void rtapi_list_add_tail(struct rtapi_list_head *new_, struct rtapi_list_head *head);
36  .HP
37  void rtapi_list_del(struct rtapi_list_head *entry);
38  .HP
39  void RTAPI_INIT_LIST_HEAD(struct rtapi_list_head *entry);
40  .HP
41  rtapi_list_for_each(pos, head) { ... }
42  .HP
43  rtapi_list_entry(ptr, type, member)
44  
45  .SH DESCRIPTION
46  In kernel space, each rtapi_xxx or RTAPI_XXX identifier is mapped to the
47  underlying kernel functionality, if available.
48  
49  In userspace, or in kernels where the underlying functionality is not provided
50  by a kernel, generally another implementation--possibly with reduced
51  functionality--is provided.  (For example, the userspace implementation for
52  rtapi_device_register always succeeds)
53  .SH REALTIME CONSIDERATIONS
54  Call from init/cleanup code and from realtime tasks.  These functions will
55  cause illegal instruction exceptions in userspace components, as well as in
56  uspace rtapi_app when it is not setuid root.
57  .SH RETURN VALUE
58  As in Linux.
59  .SH SEE ALSO